Conversation Class Reference

Class to control the logical flow of a conversation. More...

List of all members.

High Level Methods
void	Run ()
	Start executing ConvOrder as specified in the Pawn entity.
void	Call (string order)
	Start executing the Script Order called order. The current order is abandoned.
void	Speak (string section, string sound, float scrollSpeed, float displayTime)
	Display the specified text in the subtitles window and play back the given sound file.

Low Level Methods
void	SetTextScrollSpeed (float scrollSpeed)
	Set the speed of the text output to speed characters per second.
void	SetTextDisplayTime (float displayTime)
	Set the the minimum time, in seconds, the text will be displayed.
void	SetTextWindow (string window)
	Define the window receiving subtitles.
void	SetIconWindow (string window)
	Define the window receiving the speaker's icon.
void	SetEventState (string event, bool state)
	Set the state of the named trigger to state.
bool	GetEventState (string event)
	Return the state of the named event trigger.
void	SetFlag (int flagID, bool state)
	Set the state of the pawn flag flagID to state.
bool	GetFlag (int flagID)
	Get the state of the pawn flag flagID.
Pawn	GetOwner ()
	Returns the Pawn object owning this conversation.
string	GetText (string section)
	Returns the specified text as defined in the conversation text file of the current language.

---

Detailed Description

Class to control the logical flow of a conversation.

---

Member Function Documentation

void Conversation::Call

(

string

order

)

Start executing the Script Order called order. The current order is abandoned.

Parameters:

order

String holding the name of the new order to execute.

void Conversation::Speak	(	string	section,
		string	sound,
		float	scrollSpeed,
		float	displayTime
	)

Display the specified text in the subtitles window and play back the given sound file.

Parameters:

section	String holding the name of the text section in the conversation text file to be displayed.
sound	String holding the name of the sound file to play.
scrollSpeed	float value specifying the speed to display the text (characters per second).
displayTime	float value specifying the minimum time, in seconds, the text will be displayed.

void Conversation::SetTextScrollSpeed

(

float

scrollSpeed

)

Set the speed of the text output to speed characters per second.

If 0 then display entire text instantly.

Parameters:

scrollSpeed

float value specifying the characters per second to display.

void Conversation::SetTextDisplayTime

(

float

displayTime

)

Set the the minimum time, in seconds, the text will be displayed.

Display time starts as soon as the entire text is shown on screen. If a sound file is played that lasts longer, the text will be displayed till the sound reaches its end.

Parameters:

displayTime

float value specifying the minimum time, in seconds, the text will be displayed.

void Conversation::SetTextWindow

(

string

window

)

Define the window receiving subtitles.

Parameters:

window

String holding the name of a GEGUI window.

void Conversation::SetIconWindow

(

string

window

)

Define the window receiving the speaker's icon.

Parameters:

window

String holding the name of a GEGUI window.

void Conversation::SetEventState	(	string	event,
		bool	state
	)

Set the state of the named trigger to state.

If the trigger does not exist it will be created.

Note:

Event triggers are shared among all pawns; not to be confused with a Trigger entity!

Parameters:

event	String holding the name of an event trigger.
state	boolean value specifying the new state of the event trigger.

bool Conversation::GetEventState

(

string

event

)

Return the state of the named event trigger.

Note:

Event triggers are shared among all pawns; not to be confused with a Trigger entity!

Parameters:

event

String holding the name of the event trigger.

Returns:

boolean value reflecting the state of the specified event trigger.

void Conversation::SetFlag	(	int	flagID,
		bool	state
	)

Set the state of the pawn flag flagID to state.

Pawn flags are shared among all pawns.

Parameters:

flagID	integer value (0 - 499) identifying the pawn flag to be set.
state	boolean value specifying the new state of the pawn flag.

bool Conversation::GetFlag

(

int

flagID

)

Get the state of the pawn flag flagID.

Pawn flags are shared among all pawns.

Parameters:

flagID

integer value (0 - 499) identifying the pawn flag to be set.

Returns:

boolean value reflecting the state of the specified pawn flag.

string Conversation::GetText

(

string

section

)

Returns the specified text as defined in the conversation text file of the current language.

Parameters:

section

String holding the name of a section declaration in the conversation text file.