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

Conversation action operating a trigger. More...

Inheritance diagram for Dragengine.ConversationSystem.CActionTrigger:
Dragengine.ConversationSystem.ConversationAction Dragengine.LoadSave.Persistable

Classes

enum  Action
 Actions. More...
 
class  Factory
 Factory for loading actor actions. More...
 

Public Member Functions

void execute (ConversationPlayback playback)
 Execute action. More...
 
Action getAction ()
 Action. More...
 
StringID getName ()
 Name of the trigger to set. More...
 
CActionTrigger new ()
 Create conversation action. More...
 
CActionTrigger new (PersistencyEnvironment env, FileReader reader)
 Read from file. More...
 
String persistencyFactoryName ()
 Name of PersistencyFactory required to load object from file. More...
 
void setAction (Action action)
 Set action. More...
 
void setName (StringID name)
 Set name of the trigger to set. More...
 
void writeObjectToFile (PersistencyEnvironment env, FileWriter writer)
 Write object to file writer. More...
 
- Public Member Functions inherited from Dragengine.ConversationSystem.ConversationAction
float getDelay ()
 Delay in seconds before processing this action. More...
 
bool getWaitForActor ()
 Wait for actor. More...
 
String getWaitForActorID ()
 ID of actor to wait for or null to wait for all actors. More...
 
void setDelay (float delay)
 Set delay in seconds before processing this action. More...
 
void setWaitForActor (bool wait)
 Set wait for actor. More...
 
void setWaitForActorID (String id)
 Set ID of actor to wait for or null to wait for all actors. More...
 

Additional Inherited Members

- Public Attributes inherited from Dragengine.ConversationSystem.ConversationAction
float pDelay
 Delay before processing the action. More...
 
bool pWaitForActor
 Wait for actor. More...
 
String pWaitForActorID
 ID of actor to wait for or null to wait for all actors. More...
 

Detailed Description

Conversation action operating a trigger.

Member Function Documentation

◆ execute()

void Dragengine.ConversationSystem.CActionTrigger.execute ( ConversationPlayback  playback)

Execute action.

Reimplemented from Dragengine.ConversationSystem.ConversationAction.

◆ getAction()

Action Dragengine.ConversationSystem.CActionTrigger.getAction ( )

◆ getName()

StringID Dragengine.ConversationSystem.CActionTrigger.getName ( )

Name of the trigger to set.

◆ new() [1/2]

CActionTrigger Dragengine.ConversationSystem.CActionTrigger.new ( )

Create conversation action.

Reimplemented from Dragengine.ConversationSystem.ConversationAction.

◆ new() [2/2]

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

Read from file.

Reimplemented from Dragengine.ConversationSystem.ConversationAction.

◆ persistencyFactoryName()

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

◆ setAction()

void Dragengine.ConversationSystem.CActionTrigger.setAction ( Action  action)

Set action.

◆ setName()

void Dragengine.ConversationSystem.CActionTrigger.setName ( StringID  name)

Set name of the trigger to set.

◆ writeObjectToFile()

void Dragengine.ConversationSystem.CActionTrigger.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: