Dragengine.Scenery.ECBehaviorConversation.Instance Class Reference

Behavior instance. More...

Inheritance diagram for Dragengine.Scenery.ECBehaviorConversation.Instance:

Classes
class	StartConversationListener
	Trigger listener to start conversation. More...

Public Member Functions
bool	canStartConversation ()
	Conversation can be started. More...
void	dispose ()
	Dispose of behavior instance. More...
StringID	getAddPlayer ()
	Add player as first actor if identifier is not null. More...
Conversation	getConversation ()
	Conversation. More...
ECBehaviorConversationActor.Instance	getConversationActor ()
	Conversation actor behavior instance or null if not present. More...
ConversationPlayback	getConversationPlayback ()
	Conversation playback if running or null if not running. More...
bool	getDirectCamera ()
	Conversation directs camera. More...
ECBehaviorConversation	getECBehavior ()
	Behavior. More...
ConversationActor	getPlayerConversationActor ()
	Player conversation actor or null if not supported. More...
StringID	getTopic ()
	Topic to use for conversation. More...
StringID	getTopicGroup ()
	Topic group to use for conversation. More...
ECBehaviorTriggered.Instance	getTrigger ()
	Trigger or null. More...
void	init (StubElement stub)
	Initialize element from stub. More...
Instance	new (ECBehaviorConversation ecbehavior, BehaviorElement element)
	Create element. More...
void	readFromFile (PersistencyEnvironment env, FileReader reader)
	Read element from file. More...
void	setDirectCamera (bool directCamera)
	Set if conversation directs camera. More...
void	setTopic (StringID id)
	Set topic to use for conversation. More...
void	startConversation ()
	Start conversation. More...
void	stopConversation ()
	Stop conversation immediately if running. More...
void	think (float elapsed)
	Think about what the element is going to do in this frame. More...
void	writeToFile (PersistencyEnvironment env, FileWriter writer)
	Write element to file. More...
Public Member Functions inherited from Dragengine.Scenery.DefaultECBehaviorInstance
void	addToGameWorld ()
	Add element to game world. More...
void	attachToParent (Element parent)
	Attach element to object set by the mapper in the IGDE World Editor. More...
void	enterFrame ()
	Frame update started. More...
void	geometryChanged ()
	Position or orientation changed. More...
BehaviorElement	getElement ()
	Behavior element to apply behavior to. More...
int	getInstanceIndex ()
	Behavior instance index. More...
DefaultECBehaviorInstance	new (BehaviorElement element)
	Create default composeable instance. More...
void	postThink (float elapsed)
	Post thinking after physics processing is finished. More...
void	removeFromGameWorld ()
	Remove element from game world. More...
bool	requiresEnterFrame ()
	Behavior instance requires enterFrame() to be called. More...
bool	requiresThink ()
	Behavior instance requires think() to be called. More...
void	stateChanged ()
	State changed (visble, touchable). More...

Public Attributes
StringID	pAddPlayer
Conversation	pConversation
ECBehaviorConversationActor.Instance	pConversationActor
ConversationPlayback	pConversationPlayback
bool	pDirectCamera
ECBehaviorConversation	pECBehavior
StringID	pTopic
StringID	pTopicGroup
ECBehaviorTriggered.Instance	pTrigger

Protected Member Functions
ConversationPlayback	createPlayback ()
	Create conversation playback. More...
Conversation	loadConversation (StubElement stub)
	Load conversation. More...
void	setAddPlayer (StringID id)
	Set if player is added as first actor if identifier is not null. More...
void	setConversation (Conversation conversation)
	Set conversation. More...
void	setConversationPlayback (ConversationPlayback playback)
	Set conversation playback if running or null if not running. More...
void	setTopicGroup (StringID id)
	Set topic group to use for conversation. More...
Protected Member Functions inherited from Dragengine.Scenery.DefaultECBehaviorInstance
void	setRequiresEnterFrame (bool required)
	Set if behavior instance requires enterFrame() to be called. More...
void	setRequiresThink (bool required)
	Set if behavior instance requires think() to be called. More...

Detailed Description

Behavior instance.

Member Function Documentation

canStartConversation()

bool Dragengine.Scenery.ECBehaviorConversation.Instance.canStartConversation

(

)

Conversation can be started.

Returns true if all of these conditions are true:

• ConversationPlayback is null
• AddPlayer is null or player is not in a conversation
• ECBehaviorConversationActor is not present or actor is not in a conversation

createPlayback()

ConversationPlayback Dragengine.Scenery.ECBehaviorConversation.Instance.createPlayback ( )

protected

Create conversation playback.

Default implementation calls BaseGameApp.createConversationPlayback(). If direct camera is false sets the camera director to null. If player is not in the conversation sets input processor to null.

Caller is responsible to set topic and add actors.

dispose()

void Dragengine.Scenery.ECBehaviorConversation.Instance.dispose

(

)

Dispose of behavior instance.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

getAddPlayer()

StringID Dragengine.Scenery.ECBehaviorConversation.Instance.getAddPlayer

(

)

Add player as first actor if identifier is not null.

getConversation()

Conversation Dragengine.Scenery.ECBehaviorConversation.Instance.getConversation

(

)

Conversation.

getConversationActor()

ECBehaviorConversationActor.Instance Dragengine.Scenery.ECBehaviorConversation.Instance.getConversationActor

(

)

Conversation actor behavior instance or null if not present.

getConversationPlayback()

ConversationPlayback Dragengine.Scenery.ECBehaviorConversation.Instance.getConversationPlayback

(

)

Conversation playback if running or null if not running.

getDirectCamera()

bool Dragengine.Scenery.ECBehaviorConversation.Instance.getDirectCamera

(

)

Conversation directs camera.

getECBehavior()

ECBehaviorConversation Dragengine.Scenery.ECBehaviorConversation.Instance.getECBehavior

(

)

Behavior.

getPlayerConversationActor()

ConversationActor Dragengine.Scenery.ECBehaviorConversation.Instance.getPlayerConversationActor

(

)

Player conversation actor or null if not supported.

getTopic()

StringID Dragengine.Scenery.ECBehaviorConversation.Instance.getTopic

(

)

Topic to use for conversation.

getTopicGroup()

StringID Dragengine.Scenery.ECBehaviorConversation.Instance.getTopicGroup

(

)

Topic group to use for conversation.

getTrigger()

ECBehaviorTriggered.Instance Dragengine.Scenery.ECBehaviorConversation.Instance.getTrigger

(

)

Trigger or null.

init()

void Dragengine.Scenery.ECBehaviorConversation.Instance.init

(

StubElement

stub

)

Initialize element from stub.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

loadConversation()

Conversation Dragengine.Scenery.ECBehaviorConversation.Instance.loadConversation ( StubElement  stub )

protected

Load conversation.

new()

Instance Dragengine.Scenery.ECBehaviorConversation.Instance.new	(	ECBehaviorConversation	ecbehavior,
		BehaviorElement	element
	)

Create element.

readFromFile()

void Dragengine.Scenery.ECBehaviorConversation.Instance.readFromFile	(	PersistencyEnvironment	env,
		FileReader	reader
	)

Read element from file.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

setAddPlayer()

void Dragengine.Scenery.ECBehaviorConversation.Instance.setAddPlayer ( StringID  id )

protected

Set if player is added as first actor if identifier is not null.

setConversation()

void Dragengine.Scenery.ECBehaviorConversation.Instance.setConversation ( Conversation  conversation )

protected

Set conversation.

setConversationPlayback()

void Dragengine.Scenery.ECBehaviorConversation.Instance.setConversationPlayback ( ConversationPlayback  playback )

protected

Set conversation playback if running or null if not running.

setDirectCamera()

void Dragengine.Scenery.ECBehaviorConversation.Instance.setDirectCamera

(

bool

directCamera

)

Set if conversation directs camera.

setTopic()

void Dragengine.Scenery.ECBehaviorConversation.Instance.setTopic

(

StringID

id

)

Set topic to use for conversation.

setTopicGroup()

void Dragengine.Scenery.ECBehaviorConversation.Instance.setTopicGroup ( StringID  id )

protected

Set topic group to use for conversation.

startConversation()

void Dragengine.Scenery.ECBehaviorConversation.Instance.startConversation

(

)

Start conversation.

Throws exception if canStartConversation() returns false.

stopConversation()

void Dragengine.Scenery.ECBehaviorConversation.Instance.stopConversation

(

)

Stop conversation immediately if running.

think()

void Dragengine.Scenery.ECBehaviorConversation.Instance.think

(

float

elapsed

)

Think about what the element is going to do in this frame.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

writeToFile()

void Dragengine.Scenery.ECBehaviorConversation.Instance.writeToFile	(	PersistencyEnvironment	env,
		FileWriter	writer
	)

Write element to file.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

Member Data Documentation

pAddPlayer

StringID Dragengine.Scenery.ECBehaviorConversation.Instance.pAddPlayer

pConversation

Conversation Dragengine.Scenery.ECBehaviorConversation.Instance.pConversation

pConversationActor

ECBehaviorConversationActor.Instance Dragengine.Scenery.ECBehaviorConversation.Instance.pConversationActor

pConversationPlayback

ConversationPlayback Dragengine.Scenery.ECBehaviorConversation.Instance.pConversationPlayback

pDirectCamera

bool Dragengine.Scenery.ECBehaviorConversation.Instance.pDirectCamera

pECBehavior

ECBehaviorConversation Dragengine.Scenery.ECBehaviorConversation.Instance.pECBehavior

pTopic

StringID Dragengine.Scenery.ECBehaviorConversation.Instance.pTopic

pTopicGroup

StringID Dragengine.Scenery.ECBehaviorConversation.Instance.pTopicGroup

pTrigger

ECBehaviorTriggered.Instance Dragengine.Scenery.ECBehaviorConversation.Instance.pTrigger

---

The documentation for this class was generated from the following file:

• ECBehaviorConversation.ds