Inheritance diagram for stmg::SpeedEvent:

Classes
struct	Init

struct	LocalInit

struct	SpeedChange

Public Types
enum	SPEED_EVENT_CHANGE_TYPE { SPEED_EVENT_CHANGE_TYPE_NONE = 0, SPEED_EVENT_CHANGE_TYPE_SET = 1, SPEED_EVENT_CHANGE_TYPE_INC = 2, SPEED_EVENT_CHANGE_TYPE_MULT_PERC = 3 }

enum	{ LISTENER_GROUP_CHANGED = 10, LISTENER_GROUP_NOT_CHANGED = 11, LISTENER_GROUP_CHANGED_INTERVAL = 15, LISTENER_GROUP_CHANGED_FALL_EACH_TICKS = 16 }

Public Types inherited from stmg::Event
enum	MSG_FILTER_VALUE_OP { MSG_FILTER_VALUE_OP_FIRST = 0, MSG_FILTER_VALUE_OP_UNCHANGED = 0, MSG_FILTER_VALUE_OP_SET = 1, MSG_FILTER_VALUE_OP_MULT_ADD = 2, MSG_FILTER_VALUE_OP_DIV_ADD = 3, MSG_FILTER_VALUE_OP_PERCENT_ADD = 4, MSG_FILTER_VALUE_OP_PERMILL_ADD = 5, MSG_FILTER_VALUE_OP_MOD_ADD = 6, MSG_FILTER_VALUE_OP_MIN_ADD = 7, MSG_FILTER_VALUE_OP_MAX_ADD = 8, MSG_FILTER_VALUE_OP_LAST = 8 }
	Value filter. More...

enum	{ LISTENER_GROUP_FINISHED = 0 }

Public Member Functions
	SpeedEvent (Init &&oInit) noexcept
	Constructor. More...

void	trigger (int32_t nMsg, int32_t nValue, Event *p0TriggeringEvent) noexcept override
	The trigger function. More...

Public Member Functions inherited from stmg::Event
virtual	~Event () noexcept=default

virtual void	addMsgFilter (int32_t nInFromMsg, int32_t nInToMsg, int32_t nInFromValue, int32_t nInToValue, bool bOutMsgDefined, int32_t nOutMsg, MSG_FILTER_VALUE_OP eOutValueOperator, int32_t nOutValueOperand, int32_t nOutValueAdd) noexcept
	Add a message filter. More...

virtual void	addListener (int32_t nGroupId, Event *p0ListenerEvent, int32_t nMsg) noexcept
	Adds a listener to the event. More...

bool	isActive () const noexcept
	Tells whether the event is active. More...

int32_t	getTriggerTime () const noexcept
	The triggering time. More...

int32_t	getPriority () const noexcept
	The priority. More...

int32_t	getDebugTag () const noexcept
	The debug tag. More...

Protected Member Functions
void	reInit (Init &&oInit) noexcept

Protected Member Functions inherited from stmg::Event
	Event (Init &&oInit) noexcept
	Constructor. More...

void	reInit (Init &&oInit) noexcept
	Reinitialization. More...

virtual void	informListeners (int32_t nGroupId, int32_t nValue) noexcept
	Calls the trigger function of a group of listeners. More...

const Level &	level () const noexcept
	The level this event belongs to. More...

Level &	level () noexcept
	The level this event belongs to. More...

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
LISTENER_GROUP_CHANGED	Sent when either interval or fall ticks have changed. nValue contains the change count.
LISTENER_GROUP_NOT_CHANGED	Sent when interval or fall ticks have not changed. nValue contains the change count.
LISTENER_GROUP_CHANGED_INTERVAL	Sent when interval has changed. nValue contains new minus old interval.
LISTENER_GROUP_CHANGED_FALL_EACH_TICKS	Sent when fall ticks has changed. nValue contains new minus old fall ticks.

◆ SPEED_EVENT_CHANGE_TYPE

enum stmg::SpeedEvent::SPEED_EVENT_CHANGE_TYPE

Enumerator
SPEED_EVENT_CHANGE_TYPE_NONE	No change.
SPEED_EVENT_CHANGE_TYPE_SET	Set value.
SPEED_EVENT_CHANGE_TYPE_INC	Increment current value.
SPEED_EVENT_CHANGE_TYPE_MULT_PERC	Multiply current value by a percentage. Example: -30 means `-30%` or `-0.3`.

Constructor & Destructor Documentation

◆ SpeedEvent()

stmg::SpeedEvent::SpeedEvent ( Init && oInit )

explicitnoexcept

Constructor.

Note that the game tick interval change is a request for this event's level. The game will decide what the real game tick interval is taking into account the requests of all levels.

A change is forced by triggering the event.

Parameters

oInit The parameters.

Member Function Documentation

◆ reInit()

void stmg::SpeedEvent::reInit ( Init && oInit )

protectednoexcept

◆ trigger()

void stmg::SpeedEvent::trigger	(	int32_t	nMsg,
		int32_t	nValue,
		Event *	p0TriggeringEvent
	)

overridevirtualnoexcept

The trigger function.

This function provides the functionality of the event and can be called in two ways.

It can be called by an event through informListeners() this event was listening to. Note: events can listen to themselves.

It can also be called by the timer if the event was active.

When this function is called the event has already been deactivated by the level (if it was active in the first place).

When this function is called the filters of this event have already been applied.

Parameters

nMsg	The message received.
nValue	The value received.
p0TriggeringEvent	The triggering event or null if triggered by timer.

Implements stmg::Event.

Classes

Public Types

Public Member Functions

Protected Member Functions