v3.6.1 Documentation
Fungus.BaseLeanTweenCommand Class Referenceabstract

Abstract base class for LeanTween commands. More...

Inheritance diagram for Fungus.BaseLeanTweenCommand:
Fungus.Command Fungus.MoveLean Fungus.RotateLean Fungus.ScaleLean

Public Types

enum  ToFrom { ToFrom.To, ToFrom.From }
 
enum  AbsAdd { AbsAdd.Absolute, AbsAdd.Additive }
 

Public Member Functions

override void OnEnter ()
 Called when this command starts execution. More...
 
abstract LTDescr ExecuteTween ()
 
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 OnTweenComplete ()
 

Protected Attributes

GameObjectData _targetObject
 
FloatData _duration = new FloatData(1f)
 
ToFrom _toFrom
 
AbsAdd _absAdd
 
LeanTweenType easeType = LeanTweenType.easeInOutQuad
 
LeanTweenType loopType = LeanTweenType.once
 
int repeats = 0
 
bool stopPreviousTweens = false
 
bool waitUntilFinished = true
 
LTDescr ourTween
 
- Protected Attributes inherited from Fungus.Command
int itemId = -1
 
int indentLevel
 
string errorMessage = ""
 

Properties

bool IsInFromMode [get]
 
bool IsInAddativeMode [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...
 

Detailed Description

Abstract base class for LeanTween commands.

Definition at line 10 of file BaseLeanTweenCommand.cs.

Member Enumeration Documentation

◆ AbsAdd

Enumerator
Absolute 
Additive 

Definition at line 26 of file BaseLeanTweenCommand.cs.

◆ ToFrom

Enumerator
To 
From 

Definition at line 20 of file BaseLeanTweenCommand.cs.

Member Function Documentation

◆ ExecuteTween()

abstract LTDescr Fungus.BaseLeanTweenCommand.ExecuteTween ( )
pure virtual

◆ GetButtonColor()

override Color Fungus.BaseLeanTweenCommand.GetButtonColor ( )
virtual

Return the color for the command background in inspector.

Returns
The button color.

Reimplemented from Fungus.Command.

Definition at line 108 of file BaseLeanTweenCommand.cs.

◆ GetSummary()

override string Fungus.BaseLeanTweenCommand.GetSummary ( )
virtual

Returns the summary text to display in the command inspector.

Reimplemented from Fungus.Command.

Definition at line 98 of file BaseLeanTweenCommand.cs.

◆ OnEnter()

override void Fungus.BaseLeanTweenCommand.OnEnter ( )
virtual

Called when this command starts execution.

Reimplemented from Fungus.Command.

Definition at line 64 of file BaseLeanTweenCommand.cs.

◆ OnTweenComplete()

virtual void Fungus.BaseLeanTweenCommand.OnTweenComplete ( )
protectedvirtual

Definition at line 57 of file BaseLeanTweenCommand.cs.

Member Data Documentation

◆ _absAdd

AbsAdd Fungus.BaseLeanTweenCommand._absAdd
protected

Definition at line 29 of file BaseLeanTweenCommand.cs.

◆ _duration

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

Definition at line 18 of file BaseLeanTweenCommand.cs.

◆ _targetObject

GameObjectData Fungus.BaseLeanTweenCommand._targetObject
protected

Definition at line 14 of file BaseLeanTweenCommand.cs.

◆ _toFrom

ToFrom Fungus.BaseLeanTweenCommand._toFrom
protected

Definition at line 23 of file BaseLeanTweenCommand.cs.

◆ easeType

LeanTweenType Fungus.BaseLeanTweenCommand.easeType = LeanTweenType.easeInOutQuad
protected

Definition at line 35 of file BaseLeanTweenCommand.cs.

◆ loopType

LeanTweenType Fungus.BaseLeanTweenCommand.loopType = LeanTweenType.once
protected

Definition at line 39 of file BaseLeanTweenCommand.cs.

◆ ourTween

LTDescr Fungus.BaseLeanTweenCommand.ourTween
protected

Definition at line 54 of file BaseLeanTweenCommand.cs.

◆ repeats

int Fungus.BaseLeanTweenCommand.repeats = 0
protected

Definition at line 43 of file BaseLeanTweenCommand.cs.

◆ stopPreviousTweens

bool Fungus.BaseLeanTweenCommand.stopPreviousTweens = false
protected

Definition at line 47 of file BaseLeanTweenCommand.cs.

◆ waitUntilFinished

bool Fungus.BaseLeanTweenCommand.waitUntilFinished = true
protected

Definition at line 51 of file BaseLeanTweenCommand.cs.

Property Documentation

◆ IsInAddativeMode

bool Fungus.BaseLeanTweenCommand.IsInAddativeMode
get

Definition at line 30 of file BaseLeanTweenCommand.cs.

◆ IsInFromMode

bool Fungus.BaseLeanTweenCommand.IsInFromMode
get

Definition at line 24 of file BaseLeanTweenCommand.cs.


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