Drag[en]gine Script Module DragonScript  1.21
Dragengine.ConversationSystem.CConditionGameCommand Class Reference

Conversation condition using value returned by command send to game. More...

Inheritance diagram for Dragengine.ConversationSystem.CConditionGameCommand:
Dragengine.ConversationSystem.ConversationCondition Dragengine.LoadSave.Persistable

Classes

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

Public Member Functions

bool evaluate (ConversationPlayback playback)
 Condition is true. More...
 
String getCommand ()
 Command to send. More...
 
bool getNegate ()
 Result of the condition is negated. More...
 
CConditionGameCommand new ()
 Create conversation action. More...
 
CConditionGameCommand new (PersistencyEnvironment env, FileReader reader)
 Read from file. More...
 
String persistencyFactoryName ()
 Name of PersistencyFactory required to load object from file. More...
 
void setCommand (String command)
 Set command to send. More...
 
void setNegate (bool negate)
 Set result of the condition is negated. More...
 
void writeObjectToFile (PersistencyEnvironment env, FileWriter writer)
 Write object to file writer. More...
 

Public Attributes

String pCommand
 
bool pNegate
 

Detailed Description

Conversation condition using value returned by command send to game.

The command is a single text string parsed by the conversation script into an array of arguments and then send to the conversation playback. The format of the command depends on the game. The command returns a boolean value use directly as condition result.

Member Function Documentation

◆ evaluate()

bool Dragengine.ConversationSystem.CConditionGameCommand.evaluate ( ConversationPlayback  playback)

Condition is true.

Reimplemented from Dragengine.ConversationSystem.ConversationCondition.

◆ getCommand()

String Dragengine.ConversationSystem.CConditionGameCommand.getCommand ( )

Command to send.

◆ getNegate()

bool Dragengine.ConversationSystem.CConditionGameCommand.getNegate ( )

Result of the condition is negated.

◆ new() [1/2]

CConditionGameCommand Dragengine.ConversationSystem.CConditionGameCommand.new ( )

Create conversation action.

Reimplemented from Dragengine.ConversationSystem.ConversationCondition.

◆ new() [2/2]

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

Read from file.

◆ persistencyFactoryName()

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

◆ setCommand()

void Dragengine.ConversationSystem.CConditionGameCommand.setCommand ( String  command)

Set command to send.

◆ setNegate()

void Dragengine.ConversationSystem.CConditionGameCommand.setNegate ( bool  negate)

Set result of the condition is negated.

◆ writeObjectToFile()

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

Write object to file writer.

Implements Dragengine.LoadSave.Persistable.

Member Data Documentation

◆ pCommand

String Dragengine.ConversationSystem.CConditionGameCommand.pCommand

◆ pNegate

bool Dragengine.ConversationSystem.CConditionGameCommand.pNegate

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