Class StaticCondition
Represents a condition that is based on a data model value
public class StaticCondition : CorePropertyChanged, INodeScriptCondition, ICondition, IDisposable, IStorageModel, IPluginFeatureDependent
- Inheritance
-
objectCorePropertyChangedStaticCondition
- Implements
Constructors
StaticCondition(RenderProfileElement)
Creates a new instance of the StaticCondition class
public StaticCondition(RenderProfileElement profileElement)
Parameters
profileElementRenderProfileElement
Properties
Entity
Gets the entity used to store this condition
public IConditionEntity Entity { get; }
Property Value
- IConditionEntity
IsMet
Gets a boolean indicating whether the condition is currently met
public bool IsMet { get; }
Property Value
NodeScript
Gets the node script of this node script condition
public INodeScript? NodeScript { get; }
Property Value
PlayMode
Gets or sets the mode in which the render element starts its timeline when display conditions are met
public StaticPlayMode PlayMode { get; set; }
Property Value
ProfileElement
Gets the profile element this condition applies to
public RenderProfileElement ProfileElement { get; }
Property Value
Script
Gets the script that drives the static condition
public NodeScript<bool> Script { get; }
Property Value
StopMode
Gets or sets the mode in which the render element stops its timeline when display conditions are no longer met
public StaticStopMode StopMode { get; set; }
Property Value
Methods
Dispose()
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
public void Dispose()
GetFeatureDependencies()
Gets the plugin features this class depends on, may contain the same plugin feature twice if depending on it in multiple ways.
public IEnumerable<PluginFeature> GetFeatureDependencies()
Returns
- IEnumerable<PluginFeature>
A List<T> of PluginFeature this class depends on.
Load()
Loads the model from its associated entity
public void Load()
LoadNodeScript()
Loads the node script this node script condition uses
public void LoadNodeScript()
OverrideTimeline(TimeSpan)
Overrides the timeline to the provided position as the display condition sees fit.
public void OverrideTimeline(TimeSpan position)
Parameters
positionTimeSpan
Save()
Saves the model to its associated entity
public void Save()
Update()
Updates the condition
public void Update()
UpdateTimeline(double)
Updates the timeline according to the provided deltaTime as the display condition sees fit.
public void UpdateTimeline(double deltaTime)
Parameters
deltaTimedouble