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

Central manager for all timers that implement the IQuestTimer interface. More...

Inheritance diagram for PixelCrushers.QuestMachine.QuestTimerManager:
Collaboration diagram for PixelCrushers.QuestMachine.QuestTimerManager:

Public Member Functions

void Register (IQuestTimer timer)
 Registers a timer with this instance of QuestTimerManager.
 
void Unregister (IQuestTimer timer)
 Unregisters a timer from this instance of QuestTimerManager.
 
void Tick ()
 Invokes the Tick method on all registered timers.
 

Static Public Member Functions

static void RegisterTimer (IQuestTimer timer)
 Register a timer to receive ticks.
 
static void UnregisterTimer (IQuestTimer timer)
 Unregister a timer so it no longer receives ticks.
 

Detailed Description

Central manager for all timers that implement the IQuestTimer interface.

Typically one instance of this script exists on the QuestMachineConfiguration instance. Every second, it invokes the timers' Tick() method.

Member Function Documentation

◆ Register()

void PixelCrushers.QuestMachine.QuestTimerManager.Register ( IQuestTimer  timer)
inline

Registers a timer with this instance of QuestTimerManager.

This method is usually called implicitly by the static method QuestTimerManager.RegisterTimer.

◆ RegisterTimer()

static void PixelCrushers.QuestMachine.QuestTimerManager.RegisterTimer ( IQuestTimer  timer)
inlinestatic

Register a timer to receive ticks.

Parameters
timer

◆ Tick()

void PixelCrushers.QuestMachine.QuestTimerManager.Tick ( )
inline

Invokes the Tick method on all registered timers.

◆ Unregister()

void PixelCrushers.QuestMachine.QuestTimerManager.Unregister ( IQuestTimer  timer)
inline

Unregisters a timer from this instance of QuestTimerManager.

This method is usually called implicitly by the static method QuestTimerManager.UnregisterTimer.

◆ UnregisterTimer()

static void PixelCrushers.QuestMachine.QuestTimerManager.UnregisterTimer ( IQuestTimer  timer)
inlinestatic

Unregister a timer so it no longer receives ticks.

Parameters
timer

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