Fungus.SetLanguage Class Reference

Set the active language for the scene. More...

Inheritance diagram for Fungus.SetLanguage:

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 bool	HasReference (Variable variable)
	Returns true if this command references the variable. 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 void	GetConnectedBlocks (ref List< Block > connectedBlocks)
	Populates a list with the Blocks that this command references. More...
virtual void	OnValidate ()
	Called by unity when script is loaded or its data changed by editor 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...

Public Attributes
string	languageCodeOLD = ""

Static Public Attributes
static string	mostRecentLanguage = ""

Protected Member Functions
virtual void	OnEnable ()

Protected Attributes
StringData	_languageCode = new StringData()
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

Set the active language for the scene.

A Localization object with a localization file must be present in the scene.

Definition at line 17 of file SetLanguage.cs.

Member Function Documentation

GetButtonColor()

override Color Fungus.SetLanguage.GetButtonColor ( )

virtual

Return the color for the command background in inspector.

Returns

The button color.

Reimplemented from Fungus.Command.

Definition at line 46 of file SetLanguage.cs.

GetSummary()

override string Fungus.SetLanguage.GetSummary ( )

virtual

Returns the summary text to display in the command inspector.

Reimplemented from Fungus.Command.

Definition at line 41 of file SetLanguage.cs.

HasReference()

override bool Fungus.SetLanguage.HasReference ( Variable  variable )

virtual

Returns true if this command references the variable.

Used to highlight variables in the variable list when a command is selected.

Reimplemented from Fungus.Command.

Definition at line 51 of file SetLanguage.cs.

OnEnable()

virtual void Fungus.SetLanguage.OnEnable ( )

protectedvirtual

Definition at line 62 of file SetLanguage.cs.

OnEnter()

override void Fungus.SetLanguage.OnEnter ( )

virtual

Called when this command starts execution.

Reimplemented from Fungus.Command.

Definition at line 26 of file SetLanguage.cs.

Member Data Documentation

_languageCode

StringData Fungus.SetLanguage._languageCode = new StringData()

protected

Definition at line 20 of file SetLanguage.cs.

languageCodeOLD

string Fungus.SetLanguage.languageCodeOLD = ""

Definition at line 60 of file SetLanguage.cs.

mostRecentLanguage

string Fungus.SetLanguage.mostRecentLanguage = ""

static

Definition at line 24 of file SetLanguage.cs.

---

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

• SetLanguage.cs