Loading...
Searching...
No Matches
Static Public Member Functions | Static Public Attributes | List of all members
PixelCrushers.QuestMachine.QuestMachineMessages Class Reference

Quest Machine-specific messages used with the MessageSystem. More...

Static Public Member Functions

static void QuestStateChanged (object sender, StringField questID, QuestState state)
 
static void QuestNodeStateChanged (object sender, StringField questID, StringField questNodeID, QuestNodeState state)
 
static void QuestTrackToggleChanged (object sender, StringField questID, bool state)
 
static void QuestAbandoned (object sender, StringField questID)
 
static void QuestCounterChanged (object sender, StringField questID, StringField counterName, int counterValue)
 
static void SetQuestCounter (object sender, StringField questID, StringField counterName, int counterValue)
 
static void IncrementQuestCounter (object sender, StringField questID, StringField counterName, int amount)
 
static void SetIndicatorState (object sender, StringField entityID, StringField questID, QuestIndicatorState state)
 
static void RefreshIndicator (object sender, StringField entityID)
 
static void RefreshIndicators (object sender)
 
static void RefreshUIs (object sender)
 
static void QuestAlert (object sender, StringField questID, List< QuestContent > contents)
 
static void Greet (object sender, object target, StringField targetID)
 
static void Greeted (object sender, object target, StringField targetID)
 
static void DiscussQuest (object sender, object target, StringField targetID, StringField questID)
 
static void DiscussedQuest (object sender, object target, StringField targetID, StringField questID)
 
static void StartSpawner (StringField spawnerName)
 
static void StopSpawner (StringField spawnerName)
 
static void DespawnSpawner (StringField spawnerName)
 
static void SendCompositeMessage (object sender, string message)
 
static string ArgToString (object arg)
 Gets the string value of a message argument.
 
static int ArgToInt (object arg)
 Gets the int value of a message argument.
 
static bool IsRequiredID (object obj, string id)
 
static StringField GetID (object obj, StringField defaultID=null)
 Gets the ID of an object.
 
static StringField GetDisplayName (object obj, StringField defaultDisplayName=null)
 Gets the display name of an object.
 
static GameObject FindGameObjectWithID (StringField id)
 Returns the GameObject with the specified ID, giving preference to quest list containers, then quest entities, and finally by GameObject name.
 
static GameObject FindGameObjectWithID (string id)
 Returns the GameObject with the specified ID, giving preference to quest list containers, then quest entities, and finally by GameObject name.
 

Static Public Attributes

const string QuestStateChangedMessage = "Quest State Changed"
 Sent when a quest state or quest node state changes.
 
const string QuestTrackToggleChangedMessage = "Quest Track Toggle Changed"
 Sent when a quest's track toggle changes (i.e., turn progress tracking on or off).
 
const string QuestAbandonedMessage = "Quest Abandoned"
 Sent when a quest state is abandoned.
 
const string CheckOfferConditionsMessage = "Check Offer Conditions"
 Sent to tell a quest to re-check its offer conditions in case the quest is no longer offerable.
 
const string QuestCounterChangedMessage = "Quest Counter Changed"
 Sent when a quest's counter changes value.
 
const string SetQuestCounterMessage = "Set Quest Counter"
 Sent to tell a counter to set its value.
 
const string TimerTickMessage = "Timer Tick"
 Sent every second if a timer condition is active.
 
const string IncrementQuestCounterMessage = "Increment Quest Counter"
 Sent to tell a counter to increment its value.
 
const string SetIndicatorStateMessage = "Set Indicator State"
 Sent to set an entity's quest indicator state.
 
const string RefreshIndicatorMessage = "Refresh Indicator"
 Sent to tell an entity to refresh its indicator by checking all quests.
 
const string RefreshUIsMessage = "Refresh UIs"
 Send to tell all UIs to refresh, typically after loading a saved game.
 
const string QuestAlertMessage = "Quest Alert"
 Sent when an alert message is raised.
 
const string GreetMessage = "Greet"
 Sent just prior to starting dialogue with a QuestGiver.
 
const string GreetedMessage = "Greeted"
 Sent just after starting dialogue with a QuestGiver.
 
const string DiscussQuestMessage = "Discuss Quest"
 Sent just prior to starting a dialogue about a specific quest.
 
const string DiscussedQuestMessage = "Discussed Quest"
 Sent just after starting a dialogue about a specific quest.
 
const string StartSpawnerMessage = "Start Spawner"
 Send to start a spawner.
 
const string StopSpawnerMessage = "Stop Spawner"
 Send to stop a spawner.
 
const string DespawnSpawnerMessage = "Despawn Spawner"
 Send to stop a spawner and tell it to despawn all spawned objects.
 
const string GroupButtonClickedMessage = "Group Button Clicked"
 Argument 0: [int] Group number.
 

Detailed Description

Quest Machine-specific messages used with the MessageSystem.

Member Function Documentation

◆ ArgToInt()

static int PixelCrushers.QuestMachine.QuestMachineMessages.ArgToInt ( object  arg)
inlinestatic

Gets the int value of a message argument.

◆ ArgToString()

static string PixelCrushers.QuestMachine.QuestMachineMessages.ArgToString ( object  arg)
inlinestatic

Gets the string value of a message argument.

Some arguments such as quest node IDs can be passed as StringField or string. This utility method simplifies retrieval of the value.

◆ DespawnSpawner()

static void PixelCrushers.QuestMachine.QuestMachineMessages.DespawnSpawner ( StringField  spawnerName)
inlinestatic

◆ DiscussedQuest()

static void PixelCrushers.QuestMachine.QuestMachineMessages.DiscussedQuest ( object  sender,
object  target,
StringField  targetID,
StringField  questID 
)
inlinestatic

◆ DiscussQuest()

static void PixelCrushers.QuestMachine.QuestMachineMessages.DiscussQuest ( object  sender,
object  target,
StringField  targetID,
StringField  questID 
)
inlinestatic

◆ FindGameObjectWithID() [1/2]

static GameObject PixelCrushers.QuestMachine.QuestMachineMessages.FindGameObjectWithID ( string  id)
inlinestatic

Returns the GameObject with the specified ID, giving preference to quest list containers, then quest entities, and finally by GameObject name.

Parameters
idID to search for.

◆ FindGameObjectWithID() [2/2]

static GameObject PixelCrushers.QuestMachine.QuestMachineMessages.FindGameObjectWithID ( StringField  id)
inlinestatic

Returns the GameObject with the specified ID, giving preference to quest list containers, then quest entities, and finally by GameObject name.

Parameters
idID to search for.

◆ GetDisplayName()

static StringField PixelCrushers.QuestMachine.QuestMachineMessages.GetDisplayName ( object  obj,
StringField  defaultDisplayName = null 
)
inlinestatic

Gets the display name of an object.

This is either a QuestEntity ID, a string, or the default value.

◆ GetID()

static StringField PixelCrushers.QuestMachine.QuestMachineMessages.GetID ( object  obj,
StringField  defaultID = null 
)
inlinestatic

Gets the ID of an object.

This is either a QuestGiver ID, QuestEntity ID, a string, or the default value.

◆ Greet()

static void PixelCrushers.QuestMachine.QuestMachineMessages.Greet ( object  sender,
object  target,
StringField  targetID 
)
inlinestatic

◆ Greeted()

static void PixelCrushers.QuestMachine.QuestMachineMessages.Greeted ( object  sender,
object  target,
StringField  targetID 
)
inlinestatic

◆ IncrementQuestCounter()

static void PixelCrushers.QuestMachine.QuestMachineMessages.IncrementQuestCounter ( object  sender,
StringField  questID,
StringField  counterName,
int  amount 
)
inlinestatic

◆ IsRequiredID()

static bool PixelCrushers.QuestMachine.QuestMachineMessages.IsRequiredID ( object  obj,
string  id 
)
inlinestatic

◆ QuestAbandoned()

static void PixelCrushers.QuestMachine.QuestMachineMessages.QuestAbandoned ( object  sender,
StringField  questID 
)
inlinestatic

◆ QuestAlert()

static void PixelCrushers.QuestMachine.QuestMachineMessages.QuestAlert ( object  sender,
StringField  questID,
List< QuestContent >  contents 
)
inlinestatic

◆ QuestCounterChanged()

static void PixelCrushers.QuestMachine.QuestMachineMessages.QuestCounterChanged ( object  sender,
StringField  questID,
StringField  counterName,
int  counterValue 
)
inlinestatic

◆ QuestNodeStateChanged()

static void PixelCrushers.QuestMachine.QuestMachineMessages.QuestNodeStateChanged ( object  sender,
StringField  questID,
StringField  questNodeID,
QuestNodeState  state 
)
inlinestatic

◆ QuestStateChanged()

static void PixelCrushers.QuestMachine.QuestMachineMessages.QuestStateChanged ( object  sender,
StringField  questID,
QuestState  state 
)
inlinestatic

◆ QuestTrackToggleChanged()

static void PixelCrushers.QuestMachine.QuestMachineMessages.QuestTrackToggleChanged ( object  sender,
StringField  questID,
bool  state 
)
inlinestatic

◆ RefreshIndicator()

static void PixelCrushers.QuestMachine.QuestMachineMessages.RefreshIndicator ( object  sender,
StringField  entityID 
)
inlinestatic

◆ RefreshIndicators()

static void PixelCrushers.QuestMachine.QuestMachineMessages.RefreshIndicators ( object  sender)
inlinestatic

◆ RefreshUIs()

static void PixelCrushers.QuestMachine.QuestMachineMessages.RefreshUIs ( object  sender)
inlinestatic

◆ SendCompositeMessage()

static void PixelCrushers.QuestMachine.QuestMachineMessages.SendCompositeMessage ( object  sender,
string  message 
)
inlinestatic

◆ SetIndicatorState()

static void PixelCrushers.QuestMachine.QuestMachineMessages.SetIndicatorState ( object  sender,
StringField  entityID,
StringField  questID,
QuestIndicatorState  state 
)
inlinestatic

◆ SetQuestCounter()

static void PixelCrushers.QuestMachine.QuestMachineMessages.SetQuestCounter ( object  sender,
StringField  questID,
StringField  counterName,
int  counterValue 
)
inlinestatic

◆ StartSpawner()

static void PixelCrushers.QuestMachine.QuestMachineMessages.StartSpawner ( StringField  spawnerName)
inlinestatic

◆ StopSpawner()

static void PixelCrushers.QuestMachine.QuestMachineMessages.StopSpawner ( StringField  spawnerName)
inlinestatic

Member Data Documentation

◆ CheckOfferConditionsMessage

const string PixelCrushers.QuestMachine.QuestMachineMessages.CheckOfferConditionsMessage = "Check Offer Conditions"
static

Sent to tell a quest to re-check its offer conditions in case the quest is no longer offerable.

  • Parameter: Quest ID.

◆ DespawnSpawnerMessage

const string PixelCrushers.QuestMachine.QuestMachineMessages.DespawnSpawnerMessage = "Despawn Spawner"
static

Send to stop a spawner and tell it to despawn all spawned objects.

  • Parameter: [StringField/string] Spawner name.

◆ DiscussedQuestMessage

const string PixelCrushers.QuestMachine.QuestMachineMessages.DiscussedQuestMessage = "Discussed Quest"
static

Sent just after starting a dialogue about a specific quest.

  • Target: QuestGiver being talked to.
  • Parameter: [StringField] Quest ID.
  • Argument 0: [string] QuestGiver's ID.

◆ DiscussQuestMessage

const string PixelCrushers.QuestMachine.QuestMachineMessages.DiscussQuestMessage = "Discuss Quest"
static

Sent just prior to starting a dialogue about a specific quest.

  • Target: QuestGiver being talked to.
  • Parameter: [StringField] Quest ID.
  • Argument 0: [string] QuestGiver's ID.

◆ GreetedMessage

const string PixelCrushers.QuestMachine.QuestMachineMessages.GreetedMessage = "Greeted"
static

Sent just after starting dialogue with a QuestGiver.

  • Target: QuestGiver being greeted.
  • Parameter: [StringField] QuestGiver's ID.

◆ GreetMessage

const string PixelCrushers.QuestMachine.QuestMachineMessages.GreetMessage = "Greet"
static

Sent just prior to starting dialogue with a QuestGiver.

  • Target: QuestGiver being greeted.
  • Parameter: [StringField] QuestGiver's ID.

◆ GroupButtonClickedMessage

const string PixelCrushers.QuestMachine.QuestMachineMessages.GroupButtonClickedMessage = "Group Button Clicked"
static

Argument 0: [int] Group number.

◆ IncrementQuestCounterMessage

const string PixelCrushers.QuestMachine.QuestMachineMessages.IncrementQuestCounterMessage = "Increment Quest Counter"
static

Sent to tell a counter to increment its value.

  • Parameter: Quest ID.
  • Argument 1: [StringField] Counter name.
  • Argument 0: [int] Amount to increment (or decrement if negative).

◆ QuestAbandonedMessage

const string PixelCrushers.QuestMachine.QuestMachineMessages.QuestAbandonedMessage = "Quest Abandoned"
static

Sent when a quest state is abandoned.

  • Parameter: Quest ID.

◆ QuestAlertMessage

const string PixelCrushers.QuestMachine.QuestMachineMessages.QuestAlertMessage = "Quest Alert"
static

Sent when an alert message is raised.

  • Parameter: Quest ID.
  • Argument 0: List of QuestUIContent items.

◆ QuestCounterChangedMessage

const string PixelCrushers.QuestMachine.QuestMachineMessages.QuestCounterChangedMessage = "Quest Counter Changed"
static

Sent when a quest's counter changes value.

  • Parameter: Quest ID.
  • Argument 0: [StringField] Counter name.
  • Argument 1: [int] New value.

◆ QuestStateChangedMessage

const string PixelCrushers.QuestMachine.QuestMachineMessages.QuestStateChangedMessage = "Quest State Changed"
static

Sent when a quest state or quest node state changes.

  • Parameter: Quest ID.
  • Argument 0: [StringField] Quest node ID, or null for main quest state.
  • Argument 1: [QuestState] / [QuestNodeState] New state.

◆ QuestTrackToggleChangedMessage

const string PixelCrushers.QuestMachine.QuestMachineMessages.QuestTrackToggleChangedMessage = "Quest Track Toggle Changed"
static

Sent when a quest's track toggle changes (i.e., turn progress tracking on or off).

  • Parameter: Quest ID.
  • Argument 0: [bool] New track state.

◆ RefreshIndicatorMessage

const string PixelCrushers.QuestMachine.QuestMachineMessages.RefreshIndicatorMessage = "Refresh Indicator"
static

Sent to tell an entity to refresh its indicator by checking all quests.

  • Target: Entity ID, or blank for all entities with QuestIndicatorManagers.
  • Parameter: Entity ID, or blank for all.

◆ RefreshUIsMessage

const string PixelCrushers.QuestMachine.QuestMachineMessages.RefreshUIsMessage = "Refresh UIs"
static

Send to tell all UIs to refresh, typically after loading a saved game.

◆ SetIndicatorStateMessage

const string PixelCrushers.QuestMachine.QuestMachineMessages.SetIndicatorStateMessage = "Set Indicator State"
static

Sent to set an entity's quest indicator state.

  • Target: Entity ID.
  • Parameter: Quest ID.
  • Argument 0: [QuestIndicatorState] State.

◆ SetQuestCounterMessage

const string PixelCrushers.QuestMachine.QuestMachineMessages.SetQuestCounterMessage = "Set Quest Counter"
static

Sent to tell a counter to set its value.

  • Parameter: Quest ID.
  • Argument 0: Counter name.
  • Argument 1: [int] New value.

◆ StartSpawnerMessage

const string PixelCrushers.QuestMachine.QuestMachineMessages.StartSpawnerMessage = "Start Spawner"
static

Send to start a spawner.

  • Parameter: [StringField/string] Spawner name.

◆ StopSpawnerMessage

const string PixelCrushers.QuestMachine.QuestMachineMessages.StopSpawnerMessage = "Stop Spawner"
static

Send to stop a spawner.

  • Parameter: [StringField/string] Spawner name.

◆ TimerTickMessage

const string PixelCrushers.QuestMachine.QuestMachineMessages.TimerTickMessage = "Timer Tick"
static

Sent every second if a timer condition is active.

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