Detailed Description

Each Dialog Tree you create will have its own Dialog Tree class and script file. These are created automatically with the name appended, eg: DialogChatWithBarney.cs.

There are some extra helpful functions you can use in these dialog scripts included here:

OptionOn( params string[] optionName ) - Enables the specified option in the active dialog tree, you can specify multiple options to turn on at once. Eg:
OptionOff( params string[] optionName ) - Disables the specified option in the active dialog tree
OptionOffForever( params string[] optionName ) - Disables the option, it won't be turned on again even if OptionOn is called for it again
Goto( IDialogTree dialog ) - Switches to a different dialog tree
GotoPrevious() - Returns to previous dialog
Stop() - Stops the dialog
FirstTimeShown property - True the first time the player's seen the dialog tree

Public Member Functions
IEnumerator	OnStart ()
	Blocking script called when the dialog first starts.

IEnumerator	OnStop ()
	Blocking script called when the dialog is stopped.

IEnumerator	Option (IDialogOption option)
	Blocking script called when a dialog option is clicked. Options are named with their id. eg: `OptionSayHi()` or `Option4`

IDialogOption	Option (int id)
	Access to option with specified id. Eg: `Option(3).On();`. This example in the QuestScript editor is simplified to `O.3.On();`

IDialogOption	Option (string id)
	Access to option with specified id. Eg: `Option("NiceHat").On();` This example in the QuestScript editor is simplified to `O.NiceHat.On();`

void	OptionOn (params int[] id)
	Turns on one or more options. Eg: `D.ChatWithBarney.OptionOn(1,2,3);`

void	OptionOff (params int[] id)
	Turns off one or more options. Eg: `D.ChatWithBarney.OptionOff(1,2,3);`

void	OptionOffForever (params int[] id)
	Turns one or more options off permanantly. Future OptionOn calls will be ignored. Eg: `D.ChatWithBarney.OptionOffForever(1,2,3);`

void	OptionOn (params string[] id)
	Turns on one or more options. Eg: `D.ChatWithBarney.OptionOn("Yes","No","Maybe");`

void	OptionOff (params string[] id)
	Turns off one or more options. Eg: `D.ChatWithBarney.OptionOff("Yes","No","Maybe");`

void	OptionOffForever (params string[] id)
	Turns one or more options off permanantly. Future OptionOn calls will be ignored. Eg: `D.ChatWithBarney.OptionOffForever("Yes","No","Maybe");`

void	Goto (IDialogTree dialog)
	Changes the active dialog tree to the new one specified. Useful for switching to a sub-tree. Eg: `Goto(D.AskAboutQuests);`.

void	GotoPrevious ()
	Changes the active dialog tree back to the previous one. Useful for returning from a sub-tree.

void	Stop ()
	Stops the active dialog tree and returns the player to the game.

Public Attributes
bool	FirstTimeShown
	True the first time the dialog tree is shown (or if its never been shown).

int	TimesShown
	The number of times the dialog tree has been shown.

Member Data Documentation

◆ FirstTimeShown

bool FirstTimeShown

True the first time the dialog tree is shown (or if its never been shown).

◆ TimesShown

int TimesShown

The number of times the dialog tree has been shown.

Member Function Documentation

◆ OnStart()

IEnumerator OnStart ( )

Blocking script called when the dialog first starts.

◆ OnStop()

IEnumerator OnStop ( )

Blocking script called when the dialog is stopped.

◆ Option() [1/3]

IEnumerator Option ( IDialogOption option )

Blocking script called when a dialog option is clicked. Options are named with their id. eg: OptionSayHi() or Option4

◆ Option() [2/3]

IDialogOption Option ( int id )

Access to option with specified id. Eg: Option(3).On();. This example in the QuestScript editor is simplified to O.3.On();

◆ Option() [3/3]

IDialogOption Option ( string id )

Access to option with specified id. Eg: Option("NiceHat").On(); This example in the QuestScript editor is simplified to O.NiceHat.On();

◆ OptionOn() [1/2]

void OptionOn ( params int[] id )

Turns on one or more options. Eg: D.ChatWithBarney.OptionOn(1,2,3);

See also: OptionOff(); OptionOffForever

◆ OptionOff() [1/2]

void OptionOff ( params int[] id )

Turns off one or more options. Eg: D.ChatWithBarney.OptionOff(1,2,3);

See also: OptionOn(); OptionOffForever

◆ OptionOffForever() [1/2]

void OptionOffForever ( params int[] id )

Turns one or more options off permanantly. Future OptionOn calls will be ignored. Eg: D.ChatWithBarney.OptionOffForever(1,2,3);

See also: OptionOn(); OptionOff

◆ OptionOn() [2/2]

void OptionOn ( params string[] id )

Turns on one or more options. Eg: D.ChatWithBarney.OptionOn("Yes","No","Maybe");

See also: OptionOff(); OptionOffForever()

◆ OptionOff() [2/2]

void OptionOff ( params string[] id )

Turns off one or more options. Eg: D.ChatWithBarney.OptionOff("Yes","No","Maybe");

See also: OptionOn(); OptionOffForever()

◆ OptionOffForever() [2/2]

void OptionOffForever ( params string[] id )

Turns one or more options off permanantly. Future OptionOn calls will be ignored. Eg: D.ChatWithBarney.OptionOffForever("Yes","No","Maybe");

See also: OptionOn(); OptionOff()

◆ Goto()

void Goto ( IDialogTree dialog )

Changes the active dialog tree to the new one specified. Useful for switching to a sub-tree. Eg: Goto(D.AskAboutQuests);.

See also: GotoPrevious()

◆ GotoPrevious()

void GotoPrevious ( )

Changes the active dialog tree back to the previous one. Useful for returning from a sub-tree.

See also: Goto(); Stop()

◆ Stop()

void Stop ( )

Stops the active dialog tree and returns the player to the game.