v3.6.1 Documentation
Fungus.iTweenCommand Class Reference

Abstract base class for iTween commands. More...

Inheritance diagram for Fungus.iTweenCommand:
Fungus.Command Fungus.LookFrom Fungus.LookTo Fungus.MoveAdd Fungus.MoveFrom Fungus.MoveTo Fungus.PunchPosition Fungus.PunchRotation Fungus.PunchScale Fungus.RotateAdd Fungus.RotateFrom Fungus.RotateTo Fungus.ScaleAdd Fungus.ScaleFrom Fungus.ScaleTo Fungus.ShakePosition Fungus.ShakeRotation Fungus.ShakeScale

Public Member Functions

override void OnEnter ()
 Called when this command starts execution. More...
 
virtual void DoTween ()
 
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...
 

Public Attributes

GameObject targetObjectOLD
 
string tweenNameOLD = ""
 
float durationOLD
 

Protected Member Functions

virtual void OniTweenComplete (object param)
 
virtual void OnEnable ()
 

Protected Attributes

GameObjectData _targetObject
 
StringData _tweenName
 
FloatData _duration = new FloatData(1f)
 
iTween.EaseType easeType = iTween.EaseType.easeInOutQuad
 
iTween.LoopType loopType = iTween.LoopType.none
 
bool stopPreviousTweens = false
 
bool waitUntilFinished = true
 
- 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

Abstract base class for iTween commands.

Definition at line 28 of file iTweenCommand.cs.

Member Function Documentation

◆ DoTween()

◆ GetButtonColor()

override Color Fungus.iTweenCommand.GetButtonColor ( )
virtual

Return the color for the command background in inspector.

Returns
The button color.

Reimplemented from Fungus.Command.

Definition at line 106 of file iTweenCommand.cs.

◆ GetSummary()

override string Fungus.iTweenCommand.GetSummary ( )
virtual

Returns the summary text to display in the command inspector.

Reimplemented from Fungus.Command.

Definition at line 96 of file iTweenCommand.cs.

◆ OnEnable()

◆ OnEnter()

override void Fungus.iTweenCommand.OnEnter ( )
virtual

Called when this command starts execution.

Reimplemented from Fungus.Command.

Definition at line 65 of file iTweenCommand.cs.

◆ OniTweenComplete()

virtual void Fungus.iTweenCommand.OniTweenComplete ( object  param)
protectedvirtual

Definition at line 51 of file iTweenCommand.cs.

Member Data Documentation

◆ _duration

FloatData Fungus.iTweenCommand._duration = new FloatData(1f)
protected

Definition at line 37 of file iTweenCommand.cs.

◆ _targetObject

GameObjectData Fungus.iTweenCommand._targetObject
protected

Definition at line 31 of file iTweenCommand.cs.

◆ _tweenName

StringData Fungus.iTweenCommand._tweenName
protected

Definition at line 34 of file iTweenCommand.cs.

◆ durationOLD

float Fungus.iTweenCommand.durationOLD

Definition at line 117 of file iTweenCommand.cs.

◆ easeType

iTween.EaseType Fungus.iTweenCommand.easeType = iTween.EaseType.easeInOutQuad
protected

Definition at line 40 of file iTweenCommand.cs.

◆ loopType

iTween.LoopType Fungus.iTweenCommand.loopType = iTween.LoopType.none
protected

Definition at line 43 of file iTweenCommand.cs.

◆ stopPreviousTweens

bool Fungus.iTweenCommand.stopPreviousTweens = false
protected

Definition at line 46 of file iTweenCommand.cs.

◆ targetObjectOLD

GameObject Fungus.iTweenCommand.targetObjectOLD

Definition at line 115 of file iTweenCommand.cs.

◆ tweenNameOLD

string Fungus.iTweenCommand.tweenNameOLD = ""

Definition at line 116 of file iTweenCommand.cs.

◆ waitUntilFinished

bool Fungus.iTweenCommand.waitUntilFinished = true
protected

Definition at line 49 of file iTweenCommand.cs.


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