Dragengine.ConversationSystem.SimpleConversationCameraShot Class Reference

Simple conversation camera shot. More...

Inheritance diagram for Dragengine.ConversationSystem.SimpleConversationCameraShot:

Classes
enum	Type
	Camera shot type. More...

Public Member Functions
StringID	getCameraTarget ()
	Target the camera is attached to or null if not set.
String	getCommand ()
	Command or null.
float	getDuration ()
	Shot duration in seconds.
StringID	getLookAtTarget ()
	Target the camera is looking at or null if not set.
StringID	getSubTarget ()
	Sub target identifier.
StringID	getTarget ()
	Target identifier.
Type	getType ()
	Type.
SimpleConversationCameraShot	new (SimpleConversationCameraShot shot)
	Create copy of simple conversation camera definition.
SimpleConversationCameraShot	new (Type type)
	Create simple conversation camera definition.
void	setCameraTarget (StringID target)
	Set target the camera is attached to or null if not set.
void	setCommand (String command)
	Set command or null.
void	setDuration (float duration)
	Set shot duration in seconds.
void	setLookAtTarget (StringID target)
	Set target the camera is looking at or null if not set.
void	setSubTarget (StringID subTarget)
	Set sub target identifier.
void	setTarget (StringID target)
	Set target identifier.

Public Attributes
String	pCommand
float	pDuration
StringID	pTarget
Type	pType

Detailed Description

Simple conversation camera shot.

Version

1.25

Camera shots can be either static conversation camera shots or dynamic shots. Dynamic shots are selected using either a conversation snippet, a conversation game command or a conversation actor command.

Member Function Documentation

getCameraTarget()

StringID Dragengine.ConversationSystem.SimpleConversationCameraShot.getCameraTarget

(

)

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

Used only for Type::cameraShot.

getCommand()

String Dragengine.ConversationSystem.SimpleConversationCameraShot.getCommand

(

)

Command or null.

Used for Type::command only otherwise null.

getDuration()

float Dragengine.ConversationSystem.SimpleConversationCameraShot.getDuration

(

)

Shot duration in seconds.

Used for Type::cameraShot only otherwise null.

getLookAtTarget()

StringID Dragengine.ConversationSystem.SimpleConversationCameraShot.getLookAtTarget

(

)

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

Used only for Type::cameraShot.

getSubTarget()

StringID Dragengine.ConversationSystem.SimpleConversationCameraShot.getSubTarget

(

)

Sub target identifier.

• Type::snippet: Name of conversation topic group.
• all others: Not used and is null.

getTarget()

StringID Dragengine.ConversationSystem.SimpleConversationCameraShot.getTarget

(

)

Target identifier.

• Type::cameraShot: Name of conversation camera.
• Type::snippet: Name of conversation topic from group with name #getGroup().
• Type::command: Id or alias of conversation actor or null for game command.

getType()

Type Dragengine.ConversationSystem.SimpleConversationCameraShot.getType

(

)

Type.

new() [1/2]

SimpleConversationCameraShot Dragengine.ConversationSystem.SimpleConversationCameraShot.new

(

SimpleConversationCameraShot

shot

)

Create copy of simple conversation camera definition.

new() [2/2]

SimpleConversationCameraShot Dragengine.ConversationSystem.SimpleConversationCameraShot.new

(

Type

type

)

Create simple conversation camera definition.

setCameraTarget()

void Dragengine.ConversationSystem.SimpleConversationCameraShot.setCameraTarget

(

StringID

target

)

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

Used only for Type::cameraShot.

setCommand()

void Dragengine.ConversationSystem.SimpleConversationCameraShot.setCommand

(

String

command

)

Set command or null.

Used for Type::command only otherwise null.

setDuration()

void Dragengine.ConversationSystem.SimpleConversationCameraShot.setDuration

(

float

duration

)

Set shot duration in seconds.

Used for Type::cameraShot only otherwise null.

setLookAtTarget()

void Dragengine.ConversationSystem.SimpleConversationCameraShot.setLookAtTarget

(

StringID

target

)

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

Used only for Type::cameraShot.

setSubTarget()

void Dragengine.ConversationSystem.SimpleConversationCameraShot.setSubTarget

(

StringID

subTarget

)

Set sub target identifier.

See also

#getSubTarget()

setTarget()

void Dragengine.ConversationSystem.SimpleConversationCameraShot.setTarget

(

StringID

target

)

Set target identifier.

See also

#getTarget()

Member Data Documentation

pCommand

String Dragengine.ConversationSystem.SimpleConversationCameraShot.pCommand

pDuration

float Dragengine.ConversationSystem.SimpleConversationCameraShot.pDuration

pTarget

StringID Dragengine.ConversationSystem.SimpleConversationCameraShot.pTarget

pType

Type Dragengine.ConversationSystem.SimpleConversationCameraShot.pType

---

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

• SimpleConversationCameraShot.ds