The base class for Quantum events. Events are a fire-and-forget mechanism to transfer information from the simulation to the view. More...

Inheritance diagram for Quantum.EventBase:

Public Member Functions
	EventBase (int id, EventFlags flags)
	Event event constructor. More...

virtual void	OnReleased ()
	Is called when the event is released and returned to the pool. More...

Public Attributes
readonly int	Id
	The event id. More...

Int32	Tick
	The tick that the event was invoked on. More...

Properties
bool	CanBeInvokedOnClient `[get]`
	Returns `true` if the event can be invoked on the client. More...

bool	CanBeInvokedOnServer `[get]`
	Returns `true` if the event can be invoked on the server. More...

IDeterministicGame	Game `[get, set]`
	The reference to the game that the event is dispatched to. More...

bool	Synced `[get]`
	Returns `true` if the event is a synced event. More...

Properties inherited from Quantum.IDispatchable
IDeterministicGame	Game `[get]`
	The game that the callback or event is dispatched to. More...

Detailed Description

The base class for Quantum events. Events are a fire-and-forget mechanism to transfer information from the simulation to the view.

Constructor & Destructor Documentation

◆ EventBase()

Quantum.EventBase.EventBase	(	int	id,
		EventFlags	flags
	)

inline

Event event constructor.

Parameters

id	Event id
flags	Event flags

Member Function Documentation

◆ OnReleased()

virtual void Quantum.EventBase.OnReleased ( )

inlinevirtual

Is called when the event is released and returned to the pool.

Member Data Documentation

◆ Tick

Int32 Quantum.EventBase.Tick

The tick that the event was invoked on.

◆ Id

readonly int Quantum.EventBase.Id

The event id.

Property Documentation

◆ Game

IDeterministicGame Quantum.EventBase.Game

getset

The reference to the game that the event is dispatched to.

◆ Synced

bool Quantum.EventBase.Synced

get

Returns true if the event is a synced event.

◆ CanBeInvokedOnServer

bool Quantum.EventBase.CanBeInvokedOnServer

get

Returns true if the event can be invoked on the server.

◆ CanBeInvokedOnClient

bool Quantum.EventBase.CanBeInvokedOnClient

get

Returns true if the event can be invoked on the client.

Quantum 3 3.0.9

Public Member Functions

Public Attributes

Properties