v3.6.1 Documentation
Fungus.TweenUI Class Referenceabstract

Abstract base class for TweenUI commands. More...

Inheritance diagram for Fungus.TweenUI:
Fungus.Command Fungus.FadeUI

Public Member Functions

override void OnEnter ()
 Called when this command starts execution. More...
 
override void OnCommandAdded (Block parentBlock)
 Called when the new command is added to a block in the editor. 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...
 
override bool IsReorderableArray (string propertyName)
 Returns true if the specified property should be displayed as a reorderable list in the 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 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 string GetFlowchartLocalizationId ()
 Returns the localization id for the Flowchart that contains this command. More...
 

Protected Member Functions

virtual void ApplyTween ()
 
abstract void ApplyTween (GameObject go)
 
virtual void OnComplete ()
 
virtual string GetSummaryValue ()
 

Protected Attributes

List< GameObject > targetObjects = new List<GameObject>()
 
LeanTweenType tweenType = LeanTweenType.easeOutQuad
 
BooleanData waitUntilFinished = new BooleanData(true)
 
FloatData duration = new FloatData(1f)
 
- 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 TweenUI commands.

Definition at line 13 of file TweenUI.cs.

Member Function Documentation

◆ ApplyTween() [1/2]

virtual void Fungus.TweenUI.ApplyTween ( )
protectedvirtual

Definition at line 27 of file TweenUI.cs.

◆ ApplyTween() [2/2]

abstract void Fungus.TweenUI.ApplyTween ( GameObject  go)
protectedpure virtual

Implemented in Fungus.FadeUI.

◆ GetButtonColor()

override Color Fungus.TweenUI.GetButtonColor ( )
virtual

Return the color for the command background in inspector.

Returns
The button color.

Reimplemented from Fungus.Command.

Definition at line 120 of file TweenUI.cs.

◆ GetSummary()

override string Fungus.TweenUI.GetSummary ( )
virtual

Returns the summary text to display in the command inspector.

Reimplemented from Fungus.Command.

Definition at line 84 of file TweenUI.cs.

◆ GetSummaryValue()

virtual string Fungus.TweenUI.GetSummaryValue ( )
protectedvirtual

Reimplemented in Fungus.FadeUI.

Definition at line 52 of file TweenUI.cs.

◆ IsReorderableArray()

override bool Fungus.TweenUI.IsReorderableArray ( string  propertyName)
virtual

Returns true if the specified property should be displayed as a reorderable list in the inspector.

This only applies for array properties and has no effect for non-array properties.

Reimplemented from Fungus.Command.

Definition at line 125 of file TweenUI.cs.

◆ OnCommandAdded()

override void Fungus.TweenUI.OnCommandAdded ( Block  parentBlock)
virtual

Called when the new command is added to a block in the editor.

Reimplemented from Fungus.Command.

Definition at line 75 of file TweenUI.cs.

◆ OnComplete()

virtual void Fungus.TweenUI.OnComplete ( )
protectedvirtual

Definition at line 47 of file TweenUI.cs.

◆ OnEnter()

override void Fungus.TweenUI.OnEnter ( )
virtual

Called when this command starts execution.

Reimplemented from Fungus.Command.

Definition at line 59 of file TweenUI.cs.

Member Data Documentation

◆ duration

FloatData Fungus.TweenUI.duration = new FloatData(1f)
protected

Definition at line 25 of file TweenUI.cs.

◆ targetObjects

List<GameObject> Fungus.TweenUI.targetObjects = new List<GameObject>()
protected

Definition at line 16 of file TweenUI.cs.

◆ tweenType

LeanTweenType Fungus.TweenUI.tweenType = LeanTweenType.easeOutQuad
protected

Definition at line 19 of file TweenUI.cs.

◆ waitUntilFinished

BooleanData Fungus.TweenUI.waitUntilFinished = new BooleanData(true)
protected

Definition at line 22 of file TweenUI.cs.


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