v3.6.1 Documentation
Fungus.FadeUI Class Reference

Fades a UI object. More...

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

Public Member Functions

override bool IsPropertyVisible (string propertyName)
 Returns true if the specified property should be displayed in the inspector. More...
 
- Public Member Functions inherited from Fungus.TweenUI
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 string GetFlowchartLocalizationId ()
 Returns the localization id for the Flowchart that contains this command. More...
 

Protected Member Functions

override void ApplyTween (GameObject go)
 
override string GetSummaryValue ()
 
- Protected Member Functions inherited from Fungus.TweenUI
virtual void ApplyTween ()
 
virtual void OnComplete ()
 

Protected Attributes

FadeMode fadeMode = FadeMode.Alpha
 
ColorData targetColor = new ColorData(Color.white)
 
FloatData targetAlpha = new FloatData(1f)
 
- Protected Attributes inherited from Fungus.TweenUI
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

Fades a UI object.

Definition at line 26 of file FadeUI.cs.

Member Function Documentation

◆ ApplyTween()

override void Fungus.FadeUI.ApplyTween ( GameObject  go)
protectedvirtual

Implements Fungus.TweenUI.

Definition at line 34 of file FadeUI.cs.

◆ GetSummaryValue()

override string Fungus.FadeUI.GetSummaryValue ( )
protectedvirtual

Reimplemented from Fungus.TweenUI.

Definition at line 133 of file FadeUI.cs.

◆ IsPropertyVisible()

override bool Fungus.FadeUI.IsPropertyVisible ( string  propertyName)
virtual

Returns true if the specified property should be displayed in the inspector.

This is useful for hiding certain properties based on the value of another property.

Reimplemented from Fungus.Command.

Definition at line 149 of file FadeUI.cs.

Member Data Documentation

◆ fadeMode

FadeMode Fungus.FadeUI.fadeMode = FadeMode.Alpha
protected

Definition at line 28 of file FadeUI.cs.

◆ targetAlpha

FloatData Fungus.FadeUI.targetAlpha = new FloatData(1f)
protected

Definition at line 32 of file FadeUI.cs.

◆ targetColor

ColorData Fungus.FadeUI.targetColor = new ColorData(Color.white)
protected

Definition at line 30 of file FadeUI.cs.


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