Loading...
Searching...
No Matches
Public Types | Public Member Functions | Properties | List of all members
PixelCrushers.QuestMachine.QuestCounterMessageEvent Class Reference

Specifies how to modify a counter when it receives a message from the MessageSystem. More...

Public Types

enum  Operation { ModifyByMessageValue , SetToMessageValue , ModifyByLiteralValue , SetToLiteralValue }
 

Public Member Functions

 QuestCounterMessageEvent ()
 
 QuestCounterMessageEvent (StringField targetID, StringField message, StringField parameter, Operation operation, int literalValue)
 
 QuestCounterMessageEvent (QuestMessageParticipant senderSpecifier, StringField senderID, QuestMessageParticipant targetSpecifier, StringField targetID, StringField message, StringField parameter, Operation operation, int literalValue)
 

Properties

QuestMessageParticipant senderSpecifier [get, set]
 Required message sender.
 
StringField senderID [get, set]
 Required message sender ID, or any sender if blank.
 
QuestMessageParticipant targetSpecifier [get, set]
 Required message target.
 
StringField targetID [get, set]
 ID of message target.
 
StringField message [get, set]
 Message that counter should listen for.
 
StringField parameter [get, set]
 Parameter that must be paired with the message, or blank for any.
 
Operation operation [get, set]
 What to do when the message is received.
 
int literalValue [get, set]
 Value to use when operation is ModifyByLiteralValue or SetToLiteralValue.
 

Detailed Description

Specifies how to modify a counter when it receives a message from the MessageSystem.

Member Enumeration Documentation

◆ Operation

enum PixelCrushers.QuestMachine.QuestCounterMessageEvent.Operation
Enumerator
ModifyByMessageValue 
SetToMessageValue 
ModifyByLiteralValue 
SetToLiteralValue 

Constructor & Destructor Documentation

◆ QuestCounterMessageEvent() [1/3]

PixelCrushers.QuestMachine.QuestCounterMessageEvent.QuestCounterMessageEvent ( )
inline

◆ QuestCounterMessageEvent() [2/3]

PixelCrushers.QuestMachine.QuestCounterMessageEvent.QuestCounterMessageEvent ( StringField  targetID,
StringField  message,
StringField  parameter,
Operation  operation,
int  literalValue 
)
inline

◆ QuestCounterMessageEvent() [3/3]

PixelCrushers.QuestMachine.QuestCounterMessageEvent.QuestCounterMessageEvent ( QuestMessageParticipant  senderSpecifier,
StringField  senderID,
QuestMessageParticipant  targetSpecifier,
StringField  targetID,
StringField  message,
StringField  parameter,
Operation  operation,
int  literalValue 
)
inline

Property Documentation

◆ literalValue

int PixelCrushers.QuestMachine.QuestCounterMessageEvent.literalValue
getset

Value to use when operation is ModifyByLiteralValue or SetToLiteralValue.

◆ message

StringField PixelCrushers.QuestMachine.QuestCounterMessageEvent.message
getset

Message that counter should listen for.

◆ operation

Operation PixelCrushers.QuestMachine.QuestCounterMessageEvent.operation
getset

What to do when the message is received.

◆ parameter

StringField PixelCrushers.QuestMachine.QuestCounterMessageEvent.parameter
getset

Parameter that must be paired with the message, or blank for any.

◆ senderID

StringField PixelCrushers.QuestMachine.QuestCounterMessageEvent.senderID
getset

Required message sender ID, or any sender if blank.

Can also be {QUESTERID} or {QUESTGIVERID}. Sender must have a Quest Giver or Entity component.

◆ senderSpecifier

QuestMessageParticipant PixelCrushers.QuestMachine.QuestCounterMessageEvent.senderSpecifier
getset

Required message sender.

◆ targetID

StringField PixelCrushers.QuestMachine.QuestCounterMessageEvent.targetID
getset

ID of message target.

Can also be {QUESTERID} or {QUESTGIVERID}. Leave blank to listen for any target.

◆ targetSpecifier

QuestMessageParticipant PixelCrushers.QuestMachine.QuestCounterMessageEvent.targetSpecifier
getset

Required message target.

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