DialogOption Class Reference

Inherits IDialogOption, and IQuestClickable.

Properties
string	Name [get, set]
string	Text [get, set]
string	Description [get, set]
	The description here is identical to Text, but the localization code will replace lines where x.Description = "blah" whereas it won't for x.Text = "blah".
bool	Visible [get, set]
	Whether the option is On (ie. True when option is On, false when option is Off)
bool	Disabled [get, set]
	Whether the option is OffForever. (ie. True when OffForever, False when On, or Off)
bool	Used [get, set]
int	TimesUsed [get, set]
bool	FirstUse [get]
	Tests if it's the first time this option is being used. Will be true until the 2nd time the option is used. NOT reset if you set Used = false. Same as TimesUsed <= 1.
int	InlineId [get, set]
eQuestClickableType	ClickableType [get]
MonoBehaviour	Instance [get]
string	ScriptName [get]
	The name used to uniquely identify this option.
Vector2	Position [get]
Vector2	WalkToPoint [get, set]
Vector2	LookAtPoint [get, set]
float	Baseline [get, set]
bool	Clickable [get, set]
string	Cursor [get, set]
Properties inherited from IDialogOption

Public Member Functions
void	Show ()
void	Hide ()
void	HideForever ()
void	On ()
	Turns option on in it's dialog (unless Disabled/HideForever() has been used)
void	Off ()
	Turns option off in it's dialog.
void	OffForever ()
	Disables this option so it'll never come back on, even if Show() is called.
void	OnInteraction (eQuestVerb verb)
void	OnCancelInteraction (eQuestVerb verb)
QuestScript	GetScript ()
IQuestScriptable	GetScriptable ()

Property Documentation

Description

string Description

getset

The description here is identical to Text, but the localization code will replace lines where x.Description = "blah" whereas it won't for x.Text = "blah".

Implements IDialogOption.

Visible

bool Visible

getset

Whether the option is On (ie. True when option is On, false when option is Off)

Implements IDialogOption.

Disabled

bool Disabled

getset

Whether the option is OffForever. (ie. True when OffForever, False when On, or Off)

Implements IDialogOption.

Used

bool Used

getset

Whether the option is shown as having been seleted by the player.

Setting this changes the color of the dialog option, to show players whether there's more to see. You can set this to let users know there's more to read, or not.

Note that UseCount will NOT reset to zero when you set Used = false. So option.Used == false is NOT the same as option.TimesUsed == 0. (This can be useful)

Implements IDialogOption.

TimesUsed

int TimesUsed

getset

The number of times this option has been selected. NB: Unlike UseCount in props/hotspots this will be 1 as SOON as its clicked (So the first time an option's script is called it'll already be 1) NBB: Note that UseCount will NOT reset to zero when you set Used = false. So option.Used == false is NOT the same as option.TimesUsed == 0. (This can be useful)

Eg: if ( TimesUsed == 3 ) Barney: This is the third time you've asked me this!!

Implements IDialogOption.

FirstUse

bool FirstUse

get

Tests if it's the first time this option is being used. Will be true until the 2nd time the option is used. NOT reset if you set Used = false. Same as TimesUsed <= 1.

Implements IDialogOption.

ScriptName

string ScriptName

get

The name used to uniquely identify this option.

Implements IDialogOption.

Member Function Documentation

On()

void On ( )

inline

Turns option on in it's dialog (unless Disabled/HideForever() has been used)

Implements IDialogOption.

Off()

void Off ( )

inline

Turns option off in it's dialog.

Implements IDialogOption.

OffForever()

void OffForever ( )

inline

Disables this option so it'll never come back on, even if Show() is called.

Implements IDialogOption.