PowerQuest 0.18.1
DialogTree Class Reference

Inherits IQuestScriptable, IDialogTree, and IQuestSaveCachable.

Properties

string ScriptName [get]
 The name used in scripts. More...
 
DialogTree Data [get]
 PowerQuest internal function: Access to the base class with extra functionality used by the PowerQuest. More...
 
List< DialogOptionOptions [get]
 A list of the dialog options of the dialog tree. More...
 
int NumOptionsEnabled [get]
 Returns the number of enabled dialog options currently available to the player. More...
 
int NumOptionsUnused [get]
 
bool FirstTimeShown [get]
 True the first time the dialog tree is shown (or if its never been shown). More...
 
int TimesShown [get]
 The number of times the dialog tree has been shown. More...
 
IDialogOption this[int index] [get]
 
IDialogOption this[string name] [get]
 
bool SaveDirty [get, set]
 
- Properties inherited from IDialogTree
string ScriptName [get]
 The name used in scripts. More...
 
List< DialogOptionOptions [get]
 A list of the dialog options of the dialog tree. More...
 
int NumOptionsEnabled [get]
 Returns the number of enabled dialog options currently available to the player. More...
 
int NumOptionsUnused [get]
 
bool FirstTimeShown [get]
 True the first time the dialog tree is shown (or if its never been shown). More...
 
int TimesShown [get]
 The number of times the dialog tree has been shown. More...
 
IDialogOption this[string option] [get]
 Shortcut access to options eg: D.MeetSarah["hello"].Off();. Note that from dialog tree scripts you can access their options with O.hello instead. More...
 
DialogTree Data [get]
 PowerQuest internal function: Access to the base class with extra functionality used by the PowerQuest. More...
 

Public Member Functions

QuestScript GetScript ()
 
IQuestScriptable GetScriptable ()
 
GetScript< T > ()
 PowerQuest internal function: Access to the specific quest script for the object. Use the specific dialog class as the templated parameter so you can access specific members of the script. Eg: GetScript<DialogSister>().m_saidHi = true;. More...
 
string GetScriptName ()
 
string GetScriptClassName ()
 
void HotLoadScript (Assembly assembly)
 
GameObject GetPrefab ()
 
DialogTreeComponent GetInstance ()
 
void SetInstance (DialogTreeComponent instance)
 
void OnStart ()
 
void Start ()
 Starts the dialog. More...
 
void Stop ()
 Stops/ends the dialog. More...
 
IDialogOption GetOption (string name)
 Finds a dialog option with the specified name. More...
 
IDialogOption GetOption (int index)
 Finds a dialog option with the specified id. More...
 
void OptionOn (params int[] id)
 Turns on one or more options. Eg: D.ChatWithBarney.OptionOn(1,2,3); More...
 
void OptionOff (params int[] id)
 Turns off one or more options. Eg: D.ChatWithBarney.OptionOff(1,2,3); More...
 
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); More...
 
void OptionOn (params string[] id)
 Turns on one or more options. Eg: D.ChatWithBarney.OptionOn("Yes","No","Maybe"); More...
 
void OptionOff (params string[] id)
 Turns off one or more options. Eg: D.ChatWithBarney.OptionOff("Yes","No","Maybe"); More...
 
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"); More...
 
bool GetOptionOn (int option)
 Check if the specified option is on. More...
 
bool GetOptionOffForever (int option)
 Check if the specified option is off forever. More...
 
bool GetOptionUsed (int option)
 Check if the specified option has been used. More...
 
bool GetOptionOn (string option)
 Check if the specified option is on. More...
 
bool GetOptionOffForever (string option)
 Check if the specified option is off forever. More...
 
bool GetOptionUsed (string option)
 Check if the specified option has been used. More...
 
void EditorInitialise (string name)
 
void EditorRename (string name)
 
void OnPostRestore (int version, GameObject prefab)
 
void Initialise (GameObject prefab)
 
void Start ()
 Starts the dialog. More...
 
void Stop ()
 Stops/ends the dialog. More...
 
IDialogOption GetOption (string option)
 Finds a dialog option with the specified name. More...
 
IDialogOption GetOption (int option)
 Finds a dialog option with the specified id. More...
 
void OptionOn (params int[] option)
 Turns on one or more options. Eg: D.ChatWithBarney.OptionOn(1,2,3); More...
 
void OptionOff (params int[] option)
 Turns off one or more options. Eg: D.ChatWithBarney.OptionOff(1,2,3); More...
 
void OptionOffForever (params int[] option)
 Turns one or more options off permanantly. Future OptionOn calls will be ignored. Eg: D.ChatWithBarney.OptionOffForever(1,2,3); More...
 
void OptionOn (params string[] option)
 Turns on one or more options. Eg: D.ChatWithBarney.OptionOn("Yes","No","Maybe"); More...
 
void OptionOff (params string[] option)
 Turns off one or more options. Eg: D.ChatWithBarney.OptionOff("Yes","No","Maybe"); More...
 
void OptionOffForever (params string[] option)
 Turns one or more options off permanantly. Future OptionOn calls will be ignored. Eg: D.ChatWithBarney.OptionOffForever("Yes","No","Maybe"); More...
 
bool GetOptionOn (int option)
 Check if the specified option is on. More...
 
bool GetOptionOffForever (int option)
 Check if the specified option is off forever. More...
 
bool GetOptionUsed (int option)
 Check if the specified option has been used. More...
 
bool GetOptionOn (string option)
 Check if the specified option is on. More...
 
bool GetOptionOffForever (string option)
 Check if the specified option is off forever. More...
 
bool GetOptionUsed (string option)
 Check if the specified option has been used. More...
 
GetScript< T > ()
 PowerQuest internal function: Access to the specific quest script for the object. Use the specific dialog class as the templated parameter so you can access specific members of the script. Eg: GetScript<DialogSister>().m_saidHi = true;. More...
 

Property Documentation

◆ ScriptName

string ScriptName
get

The name used in scripts.

Implements IDialogTree.

◆ Data

DialogTree Data
get

PowerQuest internal function: Access to the base class with extra functionality used by the PowerQuest.

Implements IDialogTree.

◆ Options

List<DialogOption> Options
get

A list of the dialog options of the dialog tree.

Implements IDialogTree.

◆ NumOptionsEnabled

int NumOptionsEnabled
get

Returns the number of enabled dialog options currently available to the player.

Implements IDialogTree.

◆ NumOptionsUnused

int NumOptionsUnused
get

Implements IDialogTree.

◆ FirstTimeShown

bool FirstTimeShown
get

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

Implements IDialogTree.

◆ TimesShown

int TimesShown
get

The number of times the dialog tree has been shown.

Implements IDialogTree.

Member Function Documentation

◆ GetScript< T >()

T GetScript< T > ( )
inline

PowerQuest internal function: Access to the specific quest script for the object. Use the specific dialog class as the templated parameter so you can access specific members of the script. Eg: GetScript<DialogSister>().m_saidHi = true;.

Implements IDialogTree.

Type Constraints
T :DialogTreeScript<T> 

◆ Start()

void Start ( )
inline

Starts the dialog.

Implements IDialogTree.

◆ Stop()

void Stop ( )
inline

Stops/ends the dialog.

Implements IDialogTree.

◆ GetOption() [1/2]

IDialogOption GetOption ( string  option)
inline

Finds a dialog option with the specified name.

Implements IDialogTree.

◆ GetOption() [2/2]

IDialogOption GetOption ( int  option)
inline

Finds a dialog option with the specified id.

Implements IDialogTree.

◆ OptionOn() [1/2]

void OptionOn ( params int[]  option)
inline

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

See also
OptionOff
OptionOffForever

Implements IDialogTree.

◆ OptionOff() [1/2]

void OptionOff ( params int[]  option)
inline

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

See also
OptionOn
OptionOffForever

Implements IDialogTree.

◆ OptionOffForever() [1/2]

void OptionOffForever ( params int[]  option)
inline

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

See also
OptionOn
OptionOff

Implements IDialogTree.

◆ OptionOn() [2/2]

void OptionOn ( params string[]  option)
inline

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

See also
OptionOff
OptionOffForever

Implements IDialogTree.

◆ OptionOff() [2/2]

void OptionOff ( params string[]  option)
inline

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

See also
OptionOn
OptionOffForever

Implements IDialogTree.

◆ OptionOffForever() [2/2]

void OptionOffForever ( params string[]  option)
inline

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

See also
OptionOn
OptionOff

Implements IDialogTree.

◆ GetOptionOn() [1/2]

bool GetOptionOn ( int  option)
inline

Check if the specified option is on.

Implements IDialogTree.

◆ GetOptionOffForever() [1/2]

bool GetOptionOffForever ( int  option)
inline

Check if the specified option is off forever.

Implements IDialogTree.

◆ GetOptionUsed() [1/2]

bool GetOptionUsed ( int  option)
inline

Check if the specified option has been used.

Implements IDialogTree.

◆ GetOptionOn() [2/2]

bool GetOptionOn ( string  option)
inline

Check if the specified option is on.

Implements IDialogTree.

◆ GetOptionOffForever() [2/2]

bool GetOptionOffForever ( string  option)
inline

Check if the specified option is off forever.

Implements IDialogTree.

◆ GetOptionUsed() [2/2]

bool GetOptionUsed ( string  option)
inline

Check if the specified option has been used.

Implements IDialogTree.