v3.9.1 Documentation
Fungus.Write Class Reference

Writes content to a UI Text or Text Mesh object. More...

Inheritance diagram for Fungus.Write:
Fungus.Command Fungus.ILocalizable

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...
 
override void OnStopExecuting ()
 Called when the parent block has been requested to stop executing, and this command is the currently executing command. More...
 
virtual string GetStandardText ()
 Gets the standard (non-localized) text. More...
 
virtual void SetStandardText (string standardText)
 Sets the standard (non-localized) text. More...
 
virtual string GetDescription ()
 Gets the description used to help localizers. More...
 
virtual string GetStringId ()
 Gets the unique string identifier. 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 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

Writer GetWriter ()
 

Protected Attributes

GameObject textObject
 
StringDataMulti text
 
string description
 
bool clearText = true
 
bool waitUntilFinished = true
 
TextColor textColor = TextColor.Default
 
FloatData setAlpha = new FloatData(1f)
 
ColorData setColor = new ColorData(Color.white)
 
- 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

Writes content to a UI Text or Text Mesh object.

Definition at line 30 of file Write.cs.

Member Function Documentation

◆ GetButtonColor()

override Color Fungus.Write.GetButtonColor ( )
virtual

Return the color for the command background in inspector.

Returns
The button color.

Reimplemented from Fungus.Command.

Definition at line 123 of file Write.cs.

◆ GetDescription()

virtual string Fungus.Write.GetDescription ( )
virtual

Gets the description used to help localizers.

Returns
The description.

Implements Fungus.ILocalizable.

Definition at line 147 of file Write.cs.

◆ GetStandardText()

virtual string Fungus.Write.GetStandardText ( )
virtual

Gets the standard (non-localized) text.

Implements Fungus.ILocalizable.

Definition at line 137 of file Write.cs.

◆ GetStringId()

virtual string Fungus.Write.GetStringId ( )
virtual

Gets the unique string identifier.

Implements Fungus.ILocalizable.

Definition at line 152 of file Write.cs.

◆ GetSummary()

override string Fungus.Write.GetSummary ( )
virtual

Returns the summary text to display in the command inspector.

Reimplemented from Fungus.Command.

Definition at line 113 of file Write.cs.

◆ GetWriter()

Writer Fungus.Write.GetWriter ( )
protected

Definition at line 56 of file Write.cs.

◆ OnEnter()

override void Fungus.Write.OnEnter ( )
virtual

Called when this command starts execution.

Reimplemented from Fungus.Command.

Definition at line 69 of file Write.cs.

◆ OnStopExecuting()

override void Fungus.Write.OnStopExecuting ( )
virtual

Called when the parent block has been requested to stop executing, and this command is the currently executing command.

Use this callback to terminate any asynchronous operations and cleanup state so that the command is ready to execute again later on.

Reimplemented from Fungus.Command.

Definition at line 128 of file Write.cs.

◆ SetStandardText()

virtual void Fungus.Write.SetStandardText ( string  standardText)
virtual

Sets the standard (non-localized) text.

Parameters
standardTextStandard text.

Implements Fungus.ILocalizable.

Definition at line 142 of file Write.cs.

Member Data Documentation

◆ clearText

bool Fungus.Write.clearText = true
protected

Definition at line 42 of file Write.cs.

◆ description

string Fungus.Write.description
protected

Definition at line 39 of file Write.cs.

◆ setAlpha

FloatData Fungus.Write.setAlpha = new FloatData(1f)
protected

Definition at line 51 of file Write.cs.

◆ setColor

ColorData Fungus.Write.setColor = new ColorData(Color.white)
protected

Definition at line 54 of file Write.cs.

◆ text

StringDataMulti Fungus.Write.text
protected

Definition at line 36 of file Write.cs.

◆ textColor

TextColor Fungus.Write.textColor = TextColor.Default
protected

Definition at line 48 of file Write.cs.

◆ textObject

GameObject Fungus.Write.textObject
protected

Definition at line 33 of file Write.cs.

◆ waitUntilFinished

bool Fungus.Write.waitUntilFinished = true
protected

Definition at line 45 of file Write.cs.


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