v3.6.1 Documentation
Fungus.InvokeEvent Class Reference

Calls a list of component methods via the Unity Event System (as used in the Unity UI) This command is more efficient than the Invoke Method command but can only pass a single parameter and doesn't support return values. More...

Inheritance diagram for Fungus.InvokeEvent:
Fungus.Command

Classes

class  BooleanEvent
 
class  FloatEvent
 
class  IntegerEvent
 
class  StringEvent
 

Public Member Functions

override void OnEnter ()
 Called when this command starts execution. More...
 
override string GetSummary ()
 Returns the summary text to display in the command inspector. More...
 
override Color GetButtonColor ()
 Return the color for the command background in inspector. 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 bool HasReference (Variable variable)
 Returns true if this command references the variable. More...
 
virtual string GetHelpText ()
 Returns the help text to display for this command. More...
 
virtual bool OpenBlock ()
 Return true if this command opens a block of commands. 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...
 

Protected Member Functions

virtual void DoInvoke ()
 

Protected Attributes

string description = ""
 
float delay
 
InvokeType invokeType
 
UnityEvent staticEvent = new UnityEvent()
 
BooleanData booleanParameter
 
BooleanEvent booleanEvent = new BooleanEvent()
 
IntegerData integerParameter
 
IntegerEvent integerEvent = new IntegerEvent()
 
FloatData floatParameter
 
FloatEvent floatEvent = new FloatEvent()
 
StringDataMulti stringParameter
 
StringEvent stringEvent = new StringEvent()
 
- Protected Attributes inherited from Fungus.Command
int itemId = -1
 
int indentLevel
 
string errorMessage = ""
 

Additional Inherited Members

- 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...
 

Detailed Description

Calls a list of component methods via the Unity Event System (as used in the Unity UI) This command is more efficient than the Invoke Method command but can only pass a single parameter and doesn't support return values.

This command uses the UnityEvent system to call methods in script. http://docs.unity3d.com/Manual/UnityEvents.html

Definition at line 37 of file InvokeEvent.cs.

Member Function Documentation

◆ DoInvoke()

virtual void Fungus.InvokeEvent.DoInvoke ( )
protectedvirtual

Definition at line 75 of file InvokeEvent.cs.

◆ GetButtonColor()

override Color Fungus.InvokeEvent.GetButtonColor ( )
virtual

Return the color for the command background in inspector.

Returns
The button color.

Reimplemented from Fungus.Command.

Definition at line 151 of file InvokeEvent.cs.

◆ GetSummary()

override string Fungus.InvokeEvent.GetSummary ( )
virtual

Returns the summary text to display in the command inspector.

Reimplemented from Fungus.Command.

Definition at line 119 of file InvokeEvent.cs.

◆ OnEnter()

override void Fungus.InvokeEvent.OnEnter ( )
virtual

Called when this command starts execution.

Reimplemented from Fungus.Command.

Definition at line 105 of file InvokeEvent.cs.

Member Data Documentation

◆ booleanEvent

BooleanEvent Fungus.InvokeEvent.booleanEvent = new BooleanEvent()
protected

Definition at line 55 of file InvokeEvent.cs.

◆ booleanParameter

BooleanData Fungus.InvokeEvent.booleanParameter
protected

Definition at line 52 of file InvokeEvent.cs.

◆ delay

float Fungus.InvokeEvent.delay
protected

Definition at line 43 of file InvokeEvent.cs.

◆ description

string Fungus.InvokeEvent.description = ""
protected

Definition at line 40 of file InvokeEvent.cs.

◆ floatEvent

FloatEvent Fungus.InvokeEvent.floatEvent = new FloatEvent()
protected

Definition at line 67 of file InvokeEvent.cs.

◆ floatParameter

FloatData Fungus.InvokeEvent.floatParameter
protected

Definition at line 64 of file InvokeEvent.cs.

◆ integerEvent

IntegerEvent Fungus.InvokeEvent.integerEvent = new IntegerEvent()
protected

Definition at line 61 of file InvokeEvent.cs.

◆ integerParameter

IntegerData Fungus.InvokeEvent.integerParameter
protected

Definition at line 58 of file InvokeEvent.cs.

◆ invokeType

InvokeType Fungus.InvokeEvent.invokeType
protected

Definition at line 46 of file InvokeEvent.cs.

◆ staticEvent

UnityEvent Fungus.InvokeEvent.staticEvent = new UnityEvent()
protected

Definition at line 49 of file InvokeEvent.cs.

◆ stringEvent

StringEvent Fungus.InvokeEvent.stringEvent = new StringEvent()
protected

Definition at line 73 of file InvokeEvent.cs.

◆ stringParameter

StringDataMulti Fungus.InvokeEvent.stringParameter
protected

Definition at line 70 of file InvokeEvent.cs.


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