Class StaticCondition
Represents a condition that is based on a data model value
Namespace: Artemis.Core
Assembly: Artemis.Core.dll
Syntax
public class StaticCondition : CorePropertyChanged, INodeScriptCondition, ICondition, IDisposable, IStorageModel
Constructors
StaticCondition(RenderProfileElement)
Creates a new instance of the StaticCondition class
Declaration
public StaticCondition(RenderProfileElement profileElement)
Parameters
Type | Name | Description |
---|---|---|
RenderProfileElement | profileElement |
Properties
Entity
Gets the entity used to store this condition
Declaration
public IConditionEntity Entity { get; }
Property Value
Type | Description |
---|---|
IConditionEntity |
IsMet
Gets a boolean indicating whether the condition is currently met
Declaration
public bool IsMet { get; }
Property Value
Type | Description |
---|---|
bool |
NodeScript
Gets the node script of this node script condition
Declaration
public INodeScript? NodeScript { get; }
Property Value
Type | Description |
---|---|
INodeScript |
PlayMode
Gets or sets the mode in which the render element starts its timeline when display conditions are met
Declaration
public StaticPlayMode PlayMode { get; set; }
Property Value
Type | Description |
---|---|
StaticPlayMode |
ProfileElement
Gets the profile element this condition applies to
Declaration
public RenderProfileElement ProfileElement { get; }
Property Value
Type | Description |
---|---|
RenderProfileElement |
Script
Gets the script that drives the static condition
Declaration
public NodeScript<bool> Script { get; }
Property Value
Type | Description |
---|---|
NodeScript<bool> |
StopMode
Gets or sets the mode in which the render element stops its timeline when display conditions are no longer met
Declaration
public StaticStopMode StopMode { get; set; }
Property Value
Type | Description |
---|---|
StaticStopMode |
Methods
Dispose()
Declaration
public void Dispose()
Load()
Loads the model from its associated entity
Declaration
public void Load()
LoadNodeScript()
Loads the node script this node script condition uses
Declaration
public void LoadNodeScript()
OverrideTimeline(TimeSpan)
Overrides the timeline to the provided position
as the display condition sees fit.
Declaration
public void OverrideTimeline(TimeSpan position)
Parameters
Type | Name | Description |
---|---|---|
TimeSpan | position |
Save()
Saves the model to its associated entity
Declaration
public void Save()
Update()
Updates the condition
Declaration
public void Update()
UpdateTimeline(double)
Updates the timeline according to the provided deltaTime
as the display condition sees fit.
Declaration
public void UpdateTimeline(double deltaTime)
Parameters
Type | Name | Description |
---|---|---|
double | deltaTime |