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

Custom conversation target. More...

Inheritance diagram for Dragengine.ConversationSystem.ConversationCustomTarget:
Dragengine.LoadSave.Persistable

Classes

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

Public Member Functions

void dispose ()
 Dispose of custom conversation target breaking cyclic references. More...
 
DMatrix getLocalMatrix ()
 Local matrix. More...
 
DMatrix getMatrix ()
 Calculate target matrix. More...
 
ConversationCustomTarget new (DMatrix localMatrix)
 Create custom conversation target. More...
 
ConversationCustomTarget new (PersistencyEnvironment env, FileReader reader)
 Read from file. More...
 
String persistencyFactoryName ()
 Name of PersistencyFactory required to load object from file. More...
 
void setLocalMatrix (DMatrix matrix)
 Set local matrix. More...
 
void writeObjectToFile (PersistencyEnvironment env, FileWriter writer)
 Write object to file writer. More...
 

Detailed Description

Custom conversation target.

Used for ConversationPlaybackLookAt. Provides a subclassable custom target for use by scripts outside conversation playback. ConversationTarget can only be used during a conversation. ConversationCustomTarget on the other hand can be added to ConversationLookAtPlayback any time. This allows to use the playback also for non-conversation use simplify game design. Subclass is responsible for registering its own PersistencyFactory.

Member Function Documentation

◆ dispose()

void Dragengine.ConversationSystem.ConversationCustomTarget.dispose ( )

Dispose of custom conversation target breaking cyclic references.

◆ getLocalMatrix()

DMatrix Dragengine.ConversationSystem.ConversationCustomTarget.getLocalMatrix ( )

Local matrix.

◆ getMatrix()

DMatrix Dragengine.ConversationSystem.ConversationCustomTarget.getMatrix ( )

Calculate target matrix.

Override in subclass to calculate the matrix to use for look-at calculation. The default implementation returns the local matrix.

◆ new() [1/2]

ConversationCustomTarget Dragengine.ConversationSystem.ConversationCustomTarget.new ( DMatrix  localMatrix)

Create custom conversation target.

◆ new() [2/2]

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

Read from file.

◆ persistencyFactoryName()

String Dragengine.ConversationSystem.ConversationCustomTarget.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.

Implements Dragengine.LoadSave.Persistable.

◆ setLocalMatrix()

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

Set local matrix.

◆ writeObjectToFile()

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

Write object to file writer.

Implements Dragengine.LoadSave.Persistable.


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