Drag[en]gine Script Module DragonScript  1.23
Dragengine.ConversationSystem.ConversationCoordSystem Class Reference

Coordinate system for use in conversation. More...

Inheritance diagram for Dragengine.ConversationSystem.ConversationCoordSystem:
Dragengine.Scenery.ElementConvoCoordSystem

Public Member Functions

void dispose ()
 Dispose of the coordinate system breaking cyclic references. More...
 
StringID getAliasID ()
 Optional unique alias identifier of the coordinate system in the conversation. More...
 
StringID getID ()
 Unique identifier of the actor in the conversation. More...
 
DMatrix getLocalMatrix ()
 Local matrix to use. More...
 
DMatrix getMatrix ()
 Coordinate system matrix. More...
 
ConversationCoordSystem new (ConversationCoordSystem coordSystem)
 Create copy of conversation coordinate system. More...
 
ConversationCoordSystem new (StringID id)
 Create conversation coordinate system. More...
 
ConversationCoordSystem new (StringID id, DMatrix localMatrix)
 Create conversation coordinate system. More...
 
void readFromFile (PersistencyEnvironment env, FileReader reader)
 Read from file. More...
 
void setAliasID (StringID id)
 Set optional unique alias identifier of the coordinate system in the conversation. More...
 
void setLocalMatrix (DMatrix matrix)
 Set local matrix to use. More...
 
void writeToFile (PersistencyEnvironment env, FileWriter writer)
 Write to file. More...
 

Detailed Description

Coordinate system for use in conversation.

Returns a coordinate system matrix for conversation targets. In contrary to conversation actors coordinate system objects can be added to multiple conversation playback objects at the same time. Conversation coordinate systems can be static or dynamic. The game scripts are responsible to update the coordinate system if it changes position or orientation dynamically.

Member Function Documentation

◆ dispose()

void Dragengine.ConversationSystem.ConversationCoordSystem.dispose ( )

Dispose of the coordinate system breaking cyclic references.

Reimplemented in Dragengine.Scenery.ElementConvoCoordSystem.

◆ getAliasID()

StringID Dragengine.ConversationSystem.ConversationCoordSystem.getAliasID ( )

Optional unique alias identifier of the coordinate system in the conversation.

◆ getID()

StringID Dragengine.ConversationSystem.ConversationCoordSystem.getID ( )

Unique identifier of the actor in the conversation.

◆ getLocalMatrix()

DMatrix Dragengine.ConversationSystem.ConversationCoordSystem.getLocalMatrix ( )

Local matrix to use.

◆ getMatrix()

DMatrix Dragengine.ConversationSystem.ConversationCoordSystem.getMatrix ( )

Coordinate system matrix.

Reimplemented in Dragengine.Scenery.ElementConvoCoordSystem.

◆ new() [1/3]

ConversationCoordSystem Dragengine.ConversationSystem.ConversationCoordSystem.new ( ConversationCoordSystem  coordSystem)

Create copy of conversation coordinate system.

◆ new() [2/3]

ConversationCoordSystem Dragengine.ConversationSystem.ConversationCoordSystem.new ( StringID  id)

Create conversation coordinate system.

◆ new() [3/3]

ConversationCoordSystem Dragengine.ConversationSystem.ConversationCoordSystem.new ( StringID  id,
DMatrix  localMatrix 
)

Create conversation coordinate system.

◆ readFromFile()

void Dragengine.ConversationSystem.ConversationCoordSystem.readFromFile ( PersistencyEnvironment  env,
FileReader  reader 
)

Read from file.

Used if ConversationPlayback.createConversationCoordSystem() is used.

◆ setAliasID()

void Dragengine.ConversationSystem.ConversationCoordSystem.setAliasID ( StringID  id)

Set optional unique alias identifier of the coordinate system in the conversation.

◆ setLocalMatrix()

void Dragengine.ConversationSystem.ConversationCoordSystem.setLocalMatrix ( DMatrix  matrix)

Set local matrix to use.

◆ writeToFile()

void Dragengine.ConversationSystem.ConversationCoordSystem.writeToFile ( PersistencyEnvironment  env,
FileWriter  writer 
)

Write to file.

Used if ConversationPlayback.createConversationCoordSystem() is used.


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