Loading...
Searching...
No Matches
PixelCrushers.QuestMachine.ActionCompletion Class Reference

Defines how to know when an action is completed. More...

Public Types

enum  Mode { Message , Counter }
 

Properties

Mode mode [get, set]
 Mode by which the action is completed.
 
QuestMessageParticipant senderSpecifier [get, set]
 Required message sender type.
 
StringField senderID [get, set]
 Required message sender ID, or any sender if blank.
 
QuestMessageParticipant targetSpecifier [get, set]
 Required message target type.
 
StringField targetID [get, set]
 Required message target ID, or any target if blank.
 
StringField message [get, set]
 Required message.
 
StringField parameter [get, set]
 Required message parameter (or blank).
 
StringField baseCounterName [get, set]
 Base counter name that will be prefixed by entity type name.
 
int initialValue [get, set]
 Initial value.
 
int minValue [get, set]
 Min value.
 
int maxValue [get, set]
 Max value.
 
int requiredValue [get, set]
 The required value for the counter.
 
CounterValueConditionMode counterValueMode [get, set]
 How the counter value applies to the condition.
 
QuestCounterUpdateMode updateMode [get, set]
 How the counter updates its value.
 
List< QuestCounterMessageEventmessageEventList [get, set]
 When updateMode is Messages, these message events affect the counter value.
 

Detailed Description

Defines how to know when an action is completed.

Member Enumeration Documentation

◆ Mode

Enumerator
Message 
Counter 

Property Documentation

◆ baseCounterName

StringField PixelCrushers.QuestMachine.ActionCompletion.baseCounterName
getset

Base counter name that will be prefixed by entity type name.

◆ counterValueMode

CounterValueConditionMode PixelCrushers.QuestMachine.ActionCompletion.counterValueMode
getset

How the counter value applies to the condition.

◆ initialValue

int PixelCrushers.QuestMachine.ActionCompletion.initialValue
getset

Initial value.

◆ maxValue

int PixelCrushers.QuestMachine.ActionCompletion.maxValue
getset

Max value.

◆ message

StringField PixelCrushers.QuestMachine.ActionCompletion.message
getset

Required message.

◆ messageEventList

List<QuestCounterMessageEvent> PixelCrushers.QuestMachine.ActionCompletion.messageEventList
getset

When updateMode is Messages, these message events affect the counter value.

◆ minValue

int PixelCrushers.QuestMachine.ActionCompletion.minValue
getset

Min value.

◆ mode

Mode PixelCrushers.QuestMachine.ActionCompletion.mode
getset

Mode by which the action is completed.

◆ parameter

StringField PixelCrushers.QuestMachine.ActionCompletion.parameter
getset

Required message parameter (or blank).

◆ requiredValue

int PixelCrushers.QuestMachine.ActionCompletion.requiredValue
getset

The required value for the counter.

◆ senderID

StringField PixelCrushers.QuestMachine.ActionCompletion.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.ActionCompletion.senderSpecifier
getset

Required message sender type.

◆ targetID

StringField PixelCrushers.QuestMachine.ActionCompletion.targetID
getset

Required message target ID, or any target if blank.

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

◆ targetSpecifier

QuestMessageParticipant PixelCrushers.QuestMachine.ActionCompletion.targetSpecifier
getset

Required message target type.

◆ updateMode

QuestCounterUpdateMode PixelCrushers.QuestMachine.ActionCompletion.updateMode
getset

How the counter updates its value.


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