v3.6.1 Documentation
Fungus.Menu Class Reference

Displays a button in a multiple choice menu. More...

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

Public Member Functions

override void OnEnter ()
 Called when this command starts execution. More...
 
override void GetConnectedBlocks (ref List< Block > connectedBlocks)
 Populates a list with the Blocks that this command references. 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...
 
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 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 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 text = "Option Text"
 
string description = ""
 
Block targetBlock
 
bool hideIfVisited
 
BooleanData interactable = new BooleanData(true)
 
MenuDialog setMenuDialog
 
- Protected Attributes inherited from Fungus.Command
int itemId = -1
 
int indentLevel
 
string errorMessage = ""
 

Properties

MenuDialog SetMenuDialog [get, set]
 
- 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

Displays a button in a multiple choice menu.

Definition at line 17 of file Menu.cs.

Member Function Documentation

◆ GetButtonColor()

override Color Fungus.Menu.GetButtonColor ( )
virtual

Return the color for the command background in inspector.

Returns
The button color.

Reimplemented from Fungus.Command.

Definition at line 92 of file Menu.cs.

◆ GetConnectedBlocks()

override void Fungus.Menu.GetConnectedBlocks ( ref List< Block connectedBlocks)
virtual

Populates a list with the Blocks that this command references.

Reimplemented from Fungus.Command.

Definition at line 69 of file Menu.cs.

◆ GetDescription()

virtual string Fungus.Menu.GetDescription ( )
virtual

Gets the description used to help localizers.

Returns
The description.

Implements Fungus.ILocalizable.

Definition at line 111 of file Menu.cs.

◆ GetStandardText()

virtual string Fungus.Menu.GetStandardText ( )
virtual

Gets the standard (non-localized) text.

Implements Fungus.ILocalizable.

Definition at line 101 of file Menu.cs.

◆ GetStringId()

virtual string Fungus.Menu.GetStringId ( )
virtual

Gets the unique string identifier.

Implements Fungus.ILocalizable.

Definition at line 116 of file Menu.cs.

◆ GetSummary()

override string Fungus.Menu.GetSummary ( )
virtual

Returns the summary text to display in the command inspector.

Reimplemented from Fungus.Command.

Definition at line 77 of file Menu.cs.

◆ OnEnter()

override void Fungus.Menu.OnEnter ( )
virtual

Called when this command starts execution.

Reimplemented from Fungus.Command.

Definition at line 42 of file Menu.cs.

◆ SetStandardText()

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

Sets the standard (non-localized) text.

Parameters
standardTextStandard text.

Implements Fungus.ILocalizable.

Definition at line 106 of file Menu.cs.

Member Data Documentation

◆ description

string Fungus.Menu.description = ""
protected

Definition at line 23 of file Menu.cs.

◆ hideIfVisited

bool Fungus.Menu.hideIfVisited
protected

Definition at line 30 of file Menu.cs.

◆ interactable

BooleanData Fungus.Menu.interactable = new BooleanData(true)
protected

Definition at line 33 of file Menu.cs.

◆ setMenuDialog

MenuDialog Fungus.Menu.setMenuDialog
protected

Definition at line 36 of file Menu.cs.

◆ targetBlock

Block Fungus.Menu.targetBlock
protected

Definition at line 27 of file Menu.cs.

◆ text

string Fungus.Menu.text = "Option Text"
protected

Definition at line 20 of file Menu.cs.

Property Documentation

◆ SetMenuDialog

MenuDialog Fungus.Menu.SetMenuDialog
getset

Definition at line 40 of file Menu.cs.


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