Detailed Description

Dialog Option: Functions for manipulating a single dialog option

    option.On();
    option.Description = "Are you sure you don't want some beef?";
    option.OffForever();

Properties
string	ScriptName `[get]`
	The name used to uniquely identify this option.

string	Description `[get, set]`
	The description text shown in the dialog tree to players. You can use this to have the character read out the option's text. Eg `Dave: {option.Description}`

bool	Visible `[get]`
	Whether the option is On (ie. True when option is On, false when option is Off)

bool	Disabled `[get]`
	Whether the option is OffForever. (ie. True when OffForever, False when On, or Off)

bool	Used `[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	TimesUsed `[get]`

Public Member Functions
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.

Property Documentation

◆ ScriptName

string ScriptName

get

The name used to uniquely identify this option.

◆ Description

string Description

getset

The description text shown in the dialog tree to players. You can use this to have the character read out the option's text. Eg Dave: {option.Description}

◆ Visible

bool Visible

get

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

◆ Disabled

bool Disabled

get

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

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

◆ 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.

◆ TimesUsed

int TimesUsed

get

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!!

Member Function Documentation

◆ On()

void On ( )

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

◆ Off()

void Off ( )

Turns option off in it's dialog.

◆ OffForever()

void OffForever ( )

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