PowerQuest  0.15.3
DialogTreeScript< T > Class Template Reference

Inherits QuestScript.

Inherited by DialogScript.

Properties

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...
 
static T Script [get]
 Used internally to access one script from another. More...
 
- 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. More...
 

Public Member Functions

DialogOption 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(); More...
 
DialogOption 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(); 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...
 
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);. More...
 
void GotoPrevious ()
 Changes the active dialog tree back to the previous one. Useful for returning from a sub-tree. More...
 
void Stop ()
 Stops the active dialog tree and returns the player to the game. More...
 

Additional Inherited Members

- 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(...) More...
 
static IProp Prop (string name)
 Get a prop in the current room. Shortcut to as R.Current.GetProp(...) More...
 
static IRegion Region (string name)
 Get a region in the current room. Shortcut to as R.Current.GetRegion(...) More...
 
static Vector2 Point (string name)
 Get a point in the current room. Shortcut to as R.Current.GetPoint(...) More...
 

Property Documentation

◆ FirstTimeShown

bool FirstTimeShown
get

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

◆ TimesShown

int TimesShown
get

The number of times the dialog tree has been shown.

◆ Script

T Script
staticget

Used internally to access one script from another.

Member Function Documentation

◆ Option() [1/2]

DialogOption Option ( int  id)
inline

Access to option with specified id. Eg: Option(3).On();. This example in the QuestScript editor is simplified to O.3.On();

◆ Option() [2/2]

DialogOption Option ( string  id)
inline

Access to option with specified id. Eg: Option("NiceHat").On(); This example in the QuestScript editor is simplified to O.NiceHat.On();

◆ OptionOn() [1/2]

void OptionOn ( params int []  id)
inline

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

See also
OptionOff()
OptionOffForever

◆ OptionOff() [1/2]

void OptionOff ( params int []  id)
inline

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

See also
OptionOn()
OptionOffForever

◆ OptionOffForever() [1/2]

void OptionOffForever ( params int []  id)
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

◆ OptionOn() [2/2]

void OptionOn ( params string []  id)
inline

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

See also
OptionOff()
OptionOffForever()

◆ OptionOff() [2/2]

void OptionOff ( params string []  id)
inline

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

See also
OptionOn()
OptionOffForever()

◆ OptionOffForever() [2/2]

void OptionOffForever ( params string []  id)
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()

◆ Goto()

void Goto ( IDialogTree  dialog)
inline

Changes the active dialog tree to the new one specified. Useful for switching to a sub-tree. Eg: Goto(D.AskAboutQuests);.

See also
GotoPrevious()

◆ GotoPrevious()

void GotoPrevious ( )
inline

Changes the active dialog tree back to the previous one. Useful for returning from a sub-tree.

See also
Goto()
Stop()

◆ Stop()

void Stop ( )
inline

Stops the active dialog tree and returns the player to the game.