MxTickleClient Class Reference

[AI] Associates an MxCore object with tickle timing/interval information. More...

#include <mxticklemanager.h>

Public Member Functions
	MxTickleClient (MxCore *p_client, MxTime p_interval)
	[AI] Constructs a tickle client for the given object and interval. More...
MxCore *	GetClient () const
	[AI] Returns the managed MxCore object. More...
MxTime	GetTickleInterval () const
	[AI] Returns the tickle interval in milliseconds. More...
MxTime	GetLastUpdateTime () const
	[AI] Returns the timestamp of the last tickle. More...
MxU16	GetFlags () const
	[AI] Returns the internal flags for this tickle client. More...
void	SetTickleInterval (MxTime p_interval)
	[AI] Sets the tickle interval for this client. More...
void	SetLastUpdateTime (MxTime p_lastUpdateTime)
	[AI] Sets the last tickle time (updates the timestamp). More...
void	SetFlags (MxU16 p_flags)
	[AI] Sets the flags for this client (e.g., destruction flag). More...

Detailed Description

[AI] Associates an MxCore object with tickle timing/interval information.

This class acts as a record holding which MxCore-derived object should be tickled (i.e. have its Tickle() called), how often this should happen (interval), when it was last tickled, and additional flags. Used by MxTickleManager to trigger periodic updates in registered objects.

[AI] The tickle mechanism forms the basis of the engine's periodic update ("game loop") logic, allowing registered objects to update themselves at specified time intervals managed centrally.

Definition at line 19 of file mxticklemanager.h.

Constructor & Destructor Documentation

MxTickleClient()

MxTickleClient::MxTickleClient	(	MxCore *	p_client,
		MxTime	p_interval
	)

[AI] Constructs a tickle client for the given object and interval.

Parameters

p_client	MxCore-derived object to be tickled. [AI]
p_interval	Time in milliseconds between tickles for this object. [AI]

Definition at line 16 of file mxticklemanager.cpp.

Member Function Documentation

GetClient()

MxCore * MxTickleClient::GetClient ( ) const

inline

[AI] Returns the managed MxCore object.

Definition at line 31 of file mxticklemanager.h.

GetFlags()

MxU16 MxTickleClient::GetFlags ( ) const

inline

[AI] Returns the internal flags for this tickle client.

Definition at line 46 of file mxticklemanager.h.

GetLastUpdateTime()

MxTime MxTickleClient::GetLastUpdateTime ( ) const

inline

[AI] Returns the timestamp of the last tickle.

Definition at line 41 of file mxticklemanager.h.

GetTickleInterval()

MxTime MxTickleClient::GetTickleInterval ( ) const

inline

[AI] Returns the tickle interval in milliseconds.

Definition at line 36 of file mxticklemanager.h.

SetFlags()

void MxTickleClient::SetFlags ( MxU16  p_flags )

inline

[AI] Sets the flags for this client (e.g., destruction flag).

Parameters

p_flags

Bitmask flags. [AI]

Definition at line 64 of file mxticklemanager.h.

SetLastUpdateTime()

void MxTickleClient::SetLastUpdateTime ( MxTime  p_lastUpdateTime )

inline

[AI] Sets the last tickle time (updates the timestamp).

Parameters

p_lastUpdateTime

Time in milliseconds. [AI]

Definition at line 58 of file mxticklemanager.h.

SetTickleInterval()

void MxTickleClient::SetTickleInterval ( MxTime  p_interval )

inline

[AI] Sets the tickle interval for this client.

Parameters

p_interval

New interval in milliseconds. [AI]

Definition at line 52 of file mxticklemanager.h.

---

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

• mxticklemanager.h
• mxticklemanager.cpp