PowerQuest  0.15.3
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". More...
 
bool Visible [get, set]
 
bool Disabled [get, set]
 
bool Used [get, set]
 
int TimesUsed [get, set]
 
int InlineId [get, set]
 
eQuestClickableType ClickableType [get]
 
MonoBehaviour Instance [get]
 
string ScriptName [get]
 
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
string ScriptName [get]
 The name used to uniquely identify this option. More...
 
string Description [get, set]
 The description shown in the dialog tree. More...
 
bool Visible [get]
 Whether the option is On (ie. True when option is On, false when option is Off) More...
 
bool Disabled [get]
 Whether the option is OffForever. (ie. True when OffForever, False when On, or Off) More...
 
bool Used [get, set]
 
int TimesUsed [get]
 

Public Member Functions

void Show ()
 
void Hide ()
 
void HideForever ()
 
void On ()
 Turns option on in it's dialog (unless Disabled/HideForever() has been used) More...
 
void Off ()
 Turns option off in it's dialog. More...
 
void OffForever ()
 Disables this option so it'll never come back on, even if Show() is called. More...
 
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".

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.