PowerQuest 0.19.4
Loading...
Searching...
No Matches
Properties | Public Member Functions | List of all members
IDialogTree Interface Reference

Detailed Description

Dialog Tree: Contains functions and data for manipluating Dialog trees- Eg. 

    D.SayHi.Start();
    D.TalkToFred.OptionOn("AskAboutPies");

Inherited by DialogTree.

Properties

string ScriptName [get]
 The name used in scripts.
 
List< DialogOption > Options [get]
 A list of the dialog options of the dialog tree.
 
int NumOptionsEnabled [get]
 Returns the number of enabled dialog options currently available to the player.
 
int NumOptionsUnused [get]
 
bool FirstTimeShown [get]
 True the first time the dialog tree is shown (or if its never been shown).
 
int TimesShown [get]
 The number of times the dialog tree has been shown.
 
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.
 
DialogTree Data [get]
 PowerQuest internal function: Access to the base class with extra functionality used by the PowerQuest.
 

Public Member Functions

void Start ()
 Starts the dialog.
 
void Stop ()
 Stops/ends the dialog.
 
IDialogOption GetOption (string option)
 Finds a dialog option with the specified name.
 
IDialogOption GetOption (int option)
 Finds a dialog option with the specified id.
 
void OptionOn (params int[] option)
 Turns on one or more options. Eg: D.ChatWithBarney.OptionOn(1,2,3);
 
void OptionOff (params int[] option)
 Turns off one or more options. Eg: D.ChatWithBarney.OptionOff(1,2,3);
 
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);
 
void OptionOn (params string[] option)
 Turns on one or more options. Eg: D.ChatWithBarney.OptionOn("Yes","No","Maybe");
 
void OptionOff (params string[] option)
 Turns off one or more options. Eg: D.ChatWithBarney.OptionOff("Yes","No","Maybe");
 
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");
 
bool GetOptionOn (int option)
 Check if the specified option is on.
 
bool GetOptionOffForever (int option)
 Check if the specified option is off forever.
 
bool GetOptionUsed (int option)
 Check if the specified option has been used.
 
bool GetOptionOn (string option)
 Check if the specified option is on.
 
bool GetOptionOffForever (string option)
 Check if the specified option is off forever.
 
bool GetOptionUsed (string option)
 Check if the specified option has been used.
 
T 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;.
 

Property Documentation

◆ ScriptName

string ScriptName
get

The name used in scripts.

Implemented in DialogTree.

◆ Options

List<DialogOption> Options
get

A list of the dialog options of the dialog tree.

Implemented in DialogTree.

◆ NumOptionsEnabled

int NumOptionsEnabled
get

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

Implemented in DialogTree.

◆ FirstTimeShown

bool FirstTimeShown
get

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

Implemented in DialogTree.

◆ TimesShown

int TimesShown
get

The number of times the dialog tree has been shown.

Implemented in DialogTree.

◆ this[string option]

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.

◆ Data

DialogTree Data
get

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

Implemented in DialogTree.

Member Function Documentation

◆ Start()

void Start ( )

Starts the dialog.

Implemented in DialogTree.

◆ Stop()

void Stop ( )

Stops/ends the dialog.

Implemented in DialogTree.

◆ GetOption() [1/2]

IDialogOption GetOption ( string option)

Finds a dialog option with the specified name.

Implemented in DialogTree.

◆ GetOption() [2/2]

IDialogOption GetOption ( int option)

Finds a dialog option with the specified id.

Implemented in DialogTree.

◆ OptionOn() [1/2]

void OptionOn ( params int[] option)

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

See also
OptionOff
OptionOffForever

Implemented in DialogTree.

◆ OptionOff() [1/2]

void OptionOff ( params int[] option)

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

See also
OptionOn
OptionOffForever

Implemented in DialogTree.

◆ OptionOffForever() [1/2]

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

See also
OptionOn
OptionOff

Implemented in DialogTree.

◆ OptionOn() [2/2]

void OptionOn ( params string[] option)

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

See also
OptionOff
OptionOffForever

Implemented in DialogTree.

◆ OptionOff() [2/2]

void OptionOff ( params string[] option)

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

See also
OptionOn
OptionOffForever

Implemented in DialogTree.

◆ OptionOffForever() [2/2]

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");

See also
OptionOn
OptionOff

Implemented in DialogTree.

◆ GetOptionOn() [1/2]

bool GetOptionOn ( int option)

Check if the specified option is on.

Implemented in DialogTree.

◆ GetOptionOffForever() [1/2]

bool GetOptionOffForever ( int option)

Check if the specified option is off forever.

Implemented in DialogTree.

◆ GetOptionUsed() [1/2]

bool GetOptionUsed ( int option)

Check if the specified option has been used.

Implemented in DialogTree.

◆ GetOptionOn() [2/2]

bool GetOptionOn ( string option)

Check if the specified option is on.

Implemented in DialogTree.

◆ GetOptionOffForever() [2/2]

bool GetOptionOffForever ( string option)

Check if the specified option is off forever.

Implemented in DialogTree.

◆ GetOptionUsed() [2/2]

bool GetOptionUsed ( string option)

Check if the specified option has been used.

Implemented in DialogTree.

◆ GetScript< T >()

T 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;.

Implemented in DialogTree.

Type Constraints
T :DialogTreeScript<T>