Conversation action sending a command to an actor. More...
Classes | |
| class | Factory |
| Factory for loading actor actions. More... | |
Public Member Functions | |
| void | execute (ConversationPlayback playback) |
| Execute action. More... | |
| StringID | getActorID () |
| Actor ID or null if not set. More... | |
| String | getCommand () |
| Command to send. More... | |
| CActionActorCommand | new () |
| Create conversation action. More... | |
| CActionActorCommand | new (PersistencyEnvironment env, FileReader reader) |
| Read from file. More... | |
| String | persistencyFactoryName () |
| Name of PersistencyFactory required to load object from file. More... | |
| void | setActorID (StringID id) |
| Set actor ID or null if not set. More... | |
| void | setCommand (String command) |
| Set command to send. 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... | |
Public Attributes | |
| StringID | pActorID |
| String | pCommand |
| 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 sending a command to an actor.
The command is a single text string parsed by the conversation script into an array of arguments and then send to the player action. The format of the command depends on the type of the player action the actor is using at the time of the command being send. If the command is not understood or improperly formatted the player action does nothing. Thus it is important to ensure make sure this action is used in the proper situation.
Member Function Documentation
◆ execute()
| void Dragengine.ConversationSystem.CActionActorCommand.execute | ( | ConversationPlayback | playback | ) |
Execute action.
Reimplemented from Dragengine.ConversationSystem.ConversationAction.
◆ getActorID()
| StringID Dragengine.ConversationSystem.CActionActorCommand.getActorID | ( | ) |
Actor ID or null if not set.
◆ getCommand()
| String Dragengine.ConversationSystem.CActionActorCommand.getCommand | ( | ) |
Command to send.
◆ new() [1/2]
| CActionActorCommand Dragengine.ConversationSystem.CActionActorCommand.new | ( | ) |
Create conversation action.
Reimplemented from Dragengine.ConversationSystem.ConversationAction.
◆ new() [2/2]
| CActionActorCommand Dragengine.ConversationSystem.CActionActorCommand.new | ( | PersistencyEnvironment | env, |
| FileReader | reader | ||
| ) |
Read from file.
Reimplemented from Dragengine.ConversationSystem.ConversationAction.
◆ persistencyFactoryName()
| String Dragengine.ConversationSystem.CActionActorCommand.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.
◆ setActorID()
| void Dragengine.ConversationSystem.CActionActorCommand.setActorID | ( | StringID | id | ) |
Set actor ID or null if not set.
◆ setCommand()
| void Dragengine.ConversationSystem.CActionActorCommand.setCommand | ( | String | command | ) |
Set command to send.
◆ writeObjectToFile()
| void Dragengine.ConversationSystem.CActionActorCommand.writeObjectToFile | ( | PersistencyEnvironment | env, |
| FileWriter | writer | ||
| ) |
Write object to file writer.
Implements Dragengine.LoadSave.Persistable.
Member Data Documentation
◆ pActorID
| StringID Dragengine.ConversationSystem.CActionActorCommand.pActorID |
◆ pCommand
| String Dragengine.ConversationSystem.CActionActorCommand.pCommand |
The documentation for this class was generated from the following file:
