PowerQuest  0.15.3
DialogScript Class Reference

Detailed Description

Each Dialog Tree you create will have its own Dialog Tree class and script file. These are created automatically with the name appended, eg: DialogChatWithBarney.cs.

There are some extra helpful functions you can use in these dialog scripts View the full list is here:

Inherits DialogTreeScript< T >.

Public Member Functions

IEnumerator OnStart ()
 Blocking script called when the dialog first starts. More...
 
IEnumerator OnStop ()
 Blocking script called when the dialog is stopped. More...
 
IEnumerator Option (IDialogOption option)
 Blocking script called when a dialog option is clicked. Options are named with their id. eg: OptionSayHi() or Option4 More...
 
- Public Member Functions inherited from DialogTreeScript< T >
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

- Properties inherited from DialogTreeScript< T >
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...
 
- 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...
 

Member Function Documentation

◆ OnStart()

IEnumerator OnStart ( )

Blocking script called when the dialog first starts.

◆ OnStop()

IEnumerator OnStop ( )

Blocking script called when the dialog is stopped.

◆ Option()

IEnumerator Option ( IDialogOption  option)

Blocking script called when a dialog option is clicked. Options are named with their id. eg: OptionSayHi() or Option4