DialogScript Class Reference

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 View the full list is 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

Inherits DialogTreeScript< T >.

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
Public Member Functions inherited from DialogTreeScript< T >
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.

Additional Inherited Members
Properties inherited from DialogTreeScript< T >
bool	FirstTimeShown [get]
	Get the DialogTree associated with this script. eg. Data.Hide()
int	TimesShown [get]
	The number of times the dialog tree has been shown.
static T	Script [get]
	Used internally to access one script from another.
Properties inherited from QuestScript
static IPowerQuest	E [get]
static ICursor	Cursor [get]
static ICamera	Camera [get]
static QuestSettings	Settings [get]
static GlobalScript	Globals [get]
	Access to the global script.
Static Protected Member Functions inherited from QuestScript
static IHotspot	Hotspot (string name)
	Get a hotspot in the current room. Shortcut to as R.Current.GetHotspot(...)
static IProp	Prop (string name)
	Get a prop in the current room. Shortcut to as R.Current.GetProp(...)
static IRegion	Region (string name)
	Get a region in the current room. Shortcut to as R.Current.GetRegion(...)
static Vector2	Point (string name)
	Get a point in the current room. Shortcut to as R.Current.GetPoint(...)
Protected Attributes inherited from DialogTreeScript< T >
IDialogTree	m_data = null

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()

IEnumerator Option

(

IDialogOption

option

)

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