Conversation condition using value returned by command send to actor. More...
Classes | |
| class | Factory |
| Factory for loading actor actions. More... | |
Public Member Functions | |
| bool | evaluate (ConversationPlayback playback) |
| Condition is true. More... | |
| StringID | getActorID () |
| Actor ID or null if not set. More... | |
| String | getCommand () |
| Command to send. More... | |
| bool | getNegate () |
| Result of the condition is negated. More... | |
| CConditionActorCommand | new () |
| Create conversation action. More... | |
| CConditionActorCommand | 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 | setNegate (bool negate) |
| Set if result of the condition is negated. More... | |
| void | writeObjectToFile (PersistencyEnvironment env, FileWriter writer) |
| Write object to file writer. More... | |
Public Attributes | |
| StringID | pActorID |
| String | pCommand |
| bool | pNegate |
Detailed Description
Conversation condition using value returned by command send to 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. The command returns a boolean value use directly as condition result.
Member Function Documentation
◆ evaluate()
| bool Dragengine.ConversationSystem.CConditionActorCommand.evaluate | ( | ConversationPlayback | playback | ) |
Condition is true.
Reimplemented from Dragengine.ConversationSystem.ConversationCondition.
◆ getActorID()
| StringID Dragengine.ConversationSystem.CConditionActorCommand.getActorID | ( | ) |
Actor ID or null if not set.
◆ getCommand()
| String Dragengine.ConversationSystem.CConditionActorCommand.getCommand | ( | ) |
Command to send.
◆ getNegate()
| bool Dragengine.ConversationSystem.CConditionActorCommand.getNegate | ( | ) |
Result of the condition is negated.
◆ new() [1/2]
| CConditionActorCommand Dragengine.ConversationSystem.CConditionActorCommand.new | ( | ) |
Create conversation action.
Reimplemented from Dragengine.ConversationSystem.ConversationCondition.
◆ new() [2/2]
| CConditionActorCommand Dragengine.ConversationSystem.CConditionActorCommand.new | ( | PersistencyEnvironment | env, |
| FileReader | reader | ||
| ) |
Read from file.
◆ persistencyFactoryName()
| String Dragengine.ConversationSystem.CConditionActorCommand.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.CConditionActorCommand.setActorID | ( | StringID | id | ) |
Set actor ID or null if not set.
◆ setCommand()
| void Dragengine.ConversationSystem.CConditionActorCommand.setCommand | ( | String | command | ) |
Set command to send.
◆ setNegate()
| void Dragengine.ConversationSystem.CConditionActorCommand.setNegate | ( | bool | negate | ) |
Set if result of the condition is negated.
◆ writeObjectToFile()
| void Dragengine.ConversationSystem.CConditionActorCommand.writeObjectToFile | ( | PersistencyEnvironment | env, |
| FileWriter | writer | ||
| ) |
Write object to file writer.
Implements Dragengine.LoadSave.Persistable.
Member Data Documentation
◆ pActorID
| StringID Dragengine.ConversationSystem.CConditionActorCommand.pActorID |
◆ pCommand
| String Dragengine.ConversationSystem.CConditionActorCommand.pCommand |
◆ pNegate
| bool Dragengine.ConversationSystem.CConditionActorCommand.pNegate |
The documentation for this class was generated from the following file:
