Dragengine.ConversationSystem.CActionCameraShot Class Reference

Conversation action changing the camera shot. More...

Inheritance diagram for Dragengine.ConversationSystem.CActionCameraShot:

Classes
class	Factory
	Factory for loading actor actions. More...

Public Member Functions
void	execute (ConversationPlayback playback)
	Execute action.
StringID	getCameraTarget ()
	Target the camera is attached to or null if not set.
float	getDuration ()
	Duration.
StringID	getLookAtTarget ()
	Target the camera is looking at or null if not set.
StringID	getName ()
	Name of the camera shot to use.
CActionCameraShot	new ()
	Create conversation action.
CActionCameraShot	new (PersistencyEnvironment env, FileReader reader)
	Read from file.
String	persistencyFactoryName ()
	Name of PersistencyFactory required to load object from file.
void	setCameraTarget (StringID target)
	Set target the camera is attached to or null if not set.
void	setDuration (float duration)
	Set duration.
void	setLookAtTarget (StringID target)
	Set target the camera is looking at or null if not set.
void	setName (StringID name)
	Set name of the camera shot to use.
void	writeObjectToFile (PersistencyEnvironment env, FileWriter writer)
	Write object to file writer.
Public Member Functions inherited from Dragengine.ConversationSystem.ConversationAction
float	getDelay ()
	Delay in seconds before processing this action.
bool	getWaitForActor ()
	Wait for actor.
String	getWaitForActorID ()
	ID of actor to wait for or null to wait for all actors.
bool	getWaitSpeakOnly ()
	Waiting considers only actor speaking not actor waiting.
void	setDelay (float delay)
	Set delay in seconds before processing this action.
void	setWaitForActor (bool wait)
	Set wait for actor.
void	setWaitForActorID (String id)
	Set ID of actor to wait for or null to wait for all actors.
void	setWaitSpeakOnly (bool speakOnly)
	Set waiting considers only actor speaking not actor waiting.

Public Attributes
StringID	pCameraTarget
float	pDuration
StringID	pLookAtTarget
StringID	pName
Public Attributes inherited from Dragengine.ConversationSystem.ConversationAction
float	pDelay
bool	pWaitForActor
String	pWaitForActorID

Detailed Description

Conversation action changing the camera shot.

Member Function Documentation

execute()

void Dragengine.ConversationSystem.CActionCameraShot.execute

(

ConversationPlayback

playback

)

Execute action.

Reimplemented from Dragengine.ConversationSystem.ConversationAction.

getCameraTarget()

StringID Dragengine.ConversationSystem.CActionCameraShot.getCameraTarget

(

)

Target the camera is attached to or null if not set.

getDuration()

float Dragengine.ConversationSystem.CActionCameraShot.getDuration

(

)

Duration.

getLookAtTarget()

StringID Dragengine.ConversationSystem.CActionCameraShot.getLookAtTarget

(

)

Target the camera is looking at or null if not set.

getName()

StringID Dragengine.ConversationSystem.CActionCameraShot.getName

(

)

Name of the camera shot to use.

new() [1/2]

CActionCameraShot Dragengine.ConversationSystem.CActionCameraShot.new

(

)

Create conversation action.

Reimplemented from Dragengine.ConversationSystem.ConversationAction.

new() [2/2]

CActionCameraShot Dragengine.ConversationSystem.CActionCameraShot.new	(	PersistencyEnvironment	env,
		FileReader	reader
	)

Read from file.

Reimplemented from Dragengine.ConversationSystem.ConversationAction.

persistencyFactoryName()

String Dragengine.ConversationSystem.CActionCameraShot.persistencyFactoryName

(

)

Name of PersistencyFactory required to load object from file.

Name of PersistencyFactory is first written to the file as string with 8-bit length. Then writeToFile() is called to write the object itself. Empty name is not allowed as is names longer than 255 characters. Name has to match a PersistencyFactory present in the Persistency instance used for loading objects. Object is read using PersistencyFactory.readObjectFromFile() of the matching PersistencyFactory.

setCameraTarget()

void Dragengine.ConversationSystem.CActionCameraShot.setCameraTarget

(

StringID

target

)

Set target the camera is attached to or null if not set.

setDuration()

void Dragengine.ConversationSystem.CActionCameraShot.setDuration

(

float

duration

)

Set duration.

setLookAtTarget()

void Dragengine.ConversationSystem.CActionCameraShot.setLookAtTarget

(

StringID

target

)

Set target the camera is looking at or null if not set.

setName()

void Dragengine.ConversationSystem.CActionCameraShot.setName

(

StringID

name

)

Set name of the camera shot to use.

writeObjectToFile()

void Dragengine.ConversationSystem.CActionCameraShot.writeObjectToFile	(	PersistencyEnvironment	env,
		FileWriter	writer
	)

Write object to file writer.

Member Data Documentation

pCameraTarget

StringID Dragengine.ConversationSystem.CActionCameraShot.pCameraTarget

pDuration

float Dragengine.ConversationSystem.CActionCameraShot.pDuration

pLookAtTarget

StringID Dragengine.ConversationSystem.CActionCameraShot.pLookAtTarget

pName

StringID Dragengine.ConversationSystem.CActionCameraShot.pName

---

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

• CActionCameraShot.ds