v3.9.1 Documentation
Fungus.VariableCondition Class Reference
Inheritance diagram for Fungus.VariableCondition:
Fungus.Condition Fungus.Command Fungus.ElseIf Fungus.If Fungus.While

Public Member Functions

override string GetSummary ()
 Returns the summary text to display in the command inspector. More...
 
override bool HasReference (Variable variable)
 Returns true if this command references the variable. More...
 
override Color GetButtonColor ()
 Return the color for the command background in inspector. More...
 
- Public Member Functions inherited from Fungus.Condition
override void OnEnter ()
 Called when this command starts execution. More...
 
override bool OpenBlock ()
 Return true if this command opens a block of commands. More...
 
- Public Member Functions inherited from Fungus.Command
virtual Flowchart GetFlowchart ()
 Returns the Flowchart that this command belongs to. More...
 
virtual void Execute ()
 Execute the command. More...
 
virtual void Continue ()
 End execution of this command and continue execution at the next command. More...
 
virtual void Continue (int nextCommandIndex)
 End execution of this command and continue execution at a specific command index. More...
 
virtual void StopParentBlock ()
 Stops the parent Block executing. More...
 
virtual void OnStopExecuting ()
 Called when the parent block has been requested to stop executing, and this command is the currently executing command. More...
 
virtual void OnCommandAdded (Block parentBlock)
 Called when the new command is added to a block in the editor. More...
 
virtual void OnCommandRemoved (Block parentBlock)
 Called when the command is deleted from a block in the editor. More...
 
virtual void OnExit ()
 Called when this command ends execution. More...
 
virtual void OnReset ()
 Called when this command is reset. More...
 
virtual void GetConnectedBlocks (ref List< Block > connectedBlocks)
 Populates a list with the Blocks that this command references. More...
 
virtual string GetHelpText ()
 Returns the help text to display for this command. More...
 
virtual bool CloseBlock ()
 Return true if this command closes a block of commands. More...
 
virtual bool IsPropertyVisible (string propertyName)
 Returns true if the specified property should be displayed in the inspector. More...
 
virtual bool IsReorderableArray (string propertyName)
 Returns true if the specified property should be displayed as a reorderable list in the inspector. More...
 
virtual string GetFlowchartLocalizationId ()
 Returns the localization id for the Flowchart that contains this command. More...
 

Static Public Attributes

static readonly Dictionary< System.Type, CompareOperator[]> operatorsByVariableType
 

Protected Member Functions

override bool EvaluateCondition ()
 
override bool HasNeededProperties ()
 
- Protected Member Functions inherited from Fungus.Condition
virtual void EvaluateAndContinue ()
 
virtual void OnTrue ()
 
virtual void OnFalse ()
 

Protected Attributes

CompareOperator compareOperator
 
Variable variable
 
BooleanData booleanData
 
IntegerData integerData
 
FloatData floatData
 
StringDataMulti stringData
 
AnimatorData animatorData
 
AudioSourceData audioSourceData
 
ColorData colorData
 
GameObjectData gameObjectData
 
MaterialData materialData
 
ObjectData objectData
 
Rigidbody2DData rigidbody2DData
 
SpriteData spriteData
 
TextureData textureData
 
TransformData transformData
 
Vector2Data vector2Data
 
Vector3Data vector3Data
 
- Protected Attributes inherited from Fungus.Command
int itemId = -1
 
int indentLevel
 
string errorMessage = ""
 

Properties

virtual CompareOperator _CompareOperator [get]
 The type of comparison operation to be performed. More...
 
- Properties inherited from Fungus.Condition
virtual bool IsElseIf [get]
 
- Properties inherited from Fungus.Command
virtual int ItemId [get, set]
 Unique identifier for this command. More...
 
virtual string ErrorMessage [get]
 Error message to display in the command inspector. More...
 
virtual int IndentLevel [get, set]
 Indent depth of the current commands. More...
 
virtual int CommandIndex [get, set]
 Index of the command in the parent block's command list. More...
 
virtual bool IsExecuting [get, set]
 Set to true by the parent block while the command is executing. More...
 
virtual float ExecutingIconTimer [get, set]
 Timer used to control appearance of executing icon in inspector. More...
 
virtual Block ParentBlock [get, set]
 Reference to the Block object that this command belongs to. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Fungus.Condition
static string GetOperatorDescription (CompareOperator compareOperator)
 

Detailed Description

Definition at line 9 of file VariableCondition.cs.

Member Function Documentation

◆ EvaluateCondition()

override bool Fungus.VariableCondition.EvaluateCondition ( )
protectedvirtual

Implements Fungus.Condition.

Definition at line 81 of file VariableCondition.cs.

◆ GetButtonColor()

override Color Fungus.VariableCondition.GetButtonColor ( )
virtual

Return the color for the command background in inspector.

Returns
The button color.

Reimplemented from Fungus.Command.

Reimplemented in Fungus.While.

Definition at line 288 of file VariableCondition.cs.

◆ GetSummary()

override string Fungus.VariableCondition.GetSummary ( )
virtual

Returns the summary text to display in the command inspector.

Reimplemented from Fungus.Command.

Definition at line 205 of file VariableCondition.cs.

◆ HasNeededProperties()

override bool Fungus.VariableCondition.HasNeededProperties ( )
protectedvirtual

Implements Fungus.Condition.

Definition at line 174 of file VariableCondition.cs.

◆ HasReference()

override bool Fungus.VariableCondition.HasReference ( Variable  variable)
virtual

Returns true if this command references the variable.

Used to highlight variables in the variable list when a command is selected.

Reimplemented from Fungus.Command.

Definition at line 283 of file VariableCondition.cs.

Member Data Documentation

◆ animatorData

AnimatorData Fungus.VariableCondition.animatorData
protected

Definition at line 46 of file VariableCondition.cs.

◆ audioSourceData

AudioSourceData Fungus.VariableCondition.audioSourceData
protected

Definition at line 49 of file VariableCondition.cs.

◆ booleanData

BooleanData Fungus.VariableCondition.booleanData
protected

Definition at line 34 of file VariableCondition.cs.

◆ colorData

ColorData Fungus.VariableCondition.colorData
protected

Definition at line 52 of file VariableCondition.cs.

◆ compareOperator

CompareOperator Fungus.VariableCondition.compareOperator
protected

Definition at line 12 of file VariableCondition.cs.

◆ floatData

FloatData Fungus.VariableCondition.floatData
protected

Definition at line 40 of file VariableCondition.cs.

◆ gameObjectData

GameObjectData Fungus.VariableCondition.gameObjectData
protected

Definition at line 55 of file VariableCondition.cs.

◆ integerData

IntegerData Fungus.VariableCondition.integerData
protected

Definition at line 37 of file VariableCondition.cs.

◆ materialData

MaterialData Fungus.VariableCondition.materialData
protected

Definition at line 58 of file VariableCondition.cs.

◆ objectData

ObjectData Fungus.VariableCondition.objectData
protected

Definition at line 61 of file VariableCondition.cs.

◆ operatorsByVariableType

readonly Dictionary<System.Type, CompareOperator[]> Fungus.VariableCondition.operatorsByVariableType
static
Initial value:
= new Dictionary<System.Type, CompareOperator[]>() {
{ typeof(BooleanVariable), BooleanVariable.compareOperators },
{ typeof(IntegerVariable), IntegerVariable.compareOperators },
{ typeof(FloatVariable), FloatVariable.compareOperators },
{ typeof(StringVariable), StringVariable.compareOperators },
{ typeof(AnimatorVariable), AnimatorVariable.compareOperators },
{ typeof(AudioSourceVariable), AudioSourceVariable.compareOperators },
{ typeof(ColorVariable), ColorVariable.compareOperators },
{ typeof(GameObjectVariable), GameObjectVariable.compareOperators },
{ typeof(MaterialVariable), MaterialVariable.compareOperators },
{ typeof(ObjectVariable), ObjectVariable.compareOperators },
{ typeof(Rigidbody2DVariable), Rigidbody2DVariable.compareOperators },
{ typeof(SpriteVariable), SpriteVariable.compareOperators },
{ typeof(TextureVariable), TextureVariable.compareOperators },
{ typeof(TransformVariable), TransformVariable.compareOperators },
{ typeof(Vector2Variable), Vector2Variable.compareOperators },
{ typeof(Vector3Variable), Vector3Variable.compareOperators }
}

Definition at line 181 of file VariableCondition.cs.

◆ rigidbody2DData

Rigidbody2DData Fungus.VariableCondition.rigidbody2DData
protected

Definition at line 64 of file VariableCondition.cs.

◆ spriteData

SpriteData Fungus.VariableCondition.spriteData
protected

Definition at line 67 of file VariableCondition.cs.

◆ stringData

StringDataMulti Fungus.VariableCondition.stringData
protected

Definition at line 43 of file VariableCondition.cs.

◆ textureData

TextureData Fungus.VariableCondition.textureData
protected

Definition at line 70 of file VariableCondition.cs.

◆ transformData

TransformData Fungus.VariableCondition.transformData
protected

Definition at line 73 of file VariableCondition.cs.

◆ variable

Variable Fungus.VariableCondition.variable
protected

Definition at line 31 of file VariableCondition.cs.

◆ vector2Data

Vector2Data Fungus.VariableCondition.vector2Data
protected

Definition at line 76 of file VariableCondition.cs.

◆ vector3Data

Vector3Data Fungus.VariableCondition.vector3Data
protected

Definition at line 79 of file VariableCondition.cs.

Property Documentation

◆ _CompareOperator

virtual CompareOperator Fungus.VariableCondition._CompareOperator
get

The type of comparison operation to be performed.

Definition at line 203 of file VariableCondition.cs.


The documentation for this class was generated from the following file: