v3.6.1 Documentation
Fungus.Say Class Reference

Writes text in a dialog box. More...

Inheritance diagram for Fungus.Say:
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 OnReset ()
 Called when this command is reset. 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 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 Attributes

string storyText = ""
 
string description = ""
 
Character character
 
Sprite portrait
 
AudioClip voiceOverClip
 
bool showAlways = true
 
int showCount = 1
 
bool extendPrevious = false
 
bool fadeWhenDone = true
 
bool waitForClick = true
 
bool stopVoiceover = true
 
SayDialog setSayDialog
 
int executionCount
 
- Protected Attributes inherited from Fungus.Command
int itemId = -1
 
int indentLevel
 
string errorMessage = ""
 

Properties

virtual Character _Character [get]
 Character that is speaking. More...
 
virtual Sprite Portrait [get, set]
 Portrait that represents speaking character. More...
 
virtual bool ExtendPrevious [get]
 Type this text in the previous dialog box. More...
 
- 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 text in a dialog box.

Definition at line 15 of file Say.cs.

Member Function Documentation

◆ GetButtonColor()

override Color Fungus.Say.GetButtonColor ( )
virtual

Return the color for the command background in inspector.

Returns
The button color.

Reimplemented from Fungus.Command.

Definition at line 142 of file Say.cs.

◆ GetDescription()

virtual string Fungus.Say.GetDescription ( )
virtual

Gets the description used to help localizers.

Returns
The description.

Implements Fungus.ILocalizable.

Definition at line 177 of file Say.cs.

◆ GetStandardText()

virtual string Fungus.Say.GetStandardText ( )
virtual

Gets the standard (non-localized) text.

Implements Fungus.ILocalizable.

Definition at line 167 of file Say.cs.

◆ GetStringId()

virtual string Fungus.Say.GetStringId ( )
virtual

Gets the unique string identifier.

Implements Fungus.ILocalizable.

Definition at line 182 of file Say.cs.

◆ GetSummary()

override string Fungus.Say.GetSummary ( )
virtual

Returns the summary text to display in the command inspector.

Reimplemented from Fungus.Command.

Definition at line 128 of file Say.cs.

◆ OnEnter()

override void Fungus.Say.OnEnter ( )
virtual

Called when this command starts execution.

Reimplemented from Fungus.Command.

Definition at line 73 of file Say.cs.

◆ OnReset()

override void Fungus.Say.OnReset ( )
virtual

Called when this command is reset.

This happens when the Reset command is used.

Reimplemented from Fungus.Command.

Definition at line 147 of file Say.cs.

◆ OnStopExecuting()

override void Fungus.Say.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 152 of file Say.cs.

◆ SetStandardText()

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

Sets the standard (non-localized) text.

Parameters
standardTextStandard text.

Implements Fungus.ILocalizable.

Definition at line 172 of file Say.cs.

Member Data Documentation

◆ character

Character Fungus.Say.character
protected

Definition at line 25 of file Say.cs.

◆ description

string Fungus.Say.description = ""
protected

Definition at line 22 of file Say.cs.

◆ executionCount

int Fungus.Say.executionCount
protected

Definition at line 54 of file Say.cs.

◆ extendPrevious

bool Fungus.Say.extendPrevious = false
protected

Definition at line 40 of file Say.cs.

◆ fadeWhenDone

bool Fungus.Say.fadeWhenDone = true
protected

Definition at line 43 of file Say.cs.

◆ portrait

Sprite Fungus.Say.portrait
protected

Definition at line 28 of file Say.cs.

◆ setSayDialog

SayDialog Fungus.Say.setSayDialog
protected

Definition at line 52 of file Say.cs.

◆ showAlways

bool Fungus.Say.showAlways = true
protected

Definition at line 34 of file Say.cs.

◆ showCount

int Fungus.Say.showCount = 1
protected

Definition at line 37 of file Say.cs.

◆ stopVoiceover

bool Fungus.Say.stopVoiceover = true
protected

Definition at line 49 of file Say.cs.

◆ storyText

string Fungus.Say.storyText = ""
protected

Definition at line 19 of file Say.cs.

◆ voiceOverClip

AudioClip Fungus.Say.voiceOverClip
protected

Definition at line 31 of file Say.cs.

◆ waitForClick

bool Fungus.Say.waitForClick = true
protected

Definition at line 46 of file Say.cs.

Property Documentation

◆ _Character

virtual Character Fungus.Say._Character
get

Character that is speaking.

Definition at line 61 of file Say.cs.

◆ ExtendPrevious

virtual bool Fungus.Say.ExtendPrevious
get

Type this text in the previous dialog box.

Definition at line 71 of file Say.cs.

◆ Portrait

virtual Sprite Fungus.Say.Portrait
getset

Portrait that represents speaking character.

Definition at line 66 of file Say.cs.


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