SCR_RespawnTimer Class Reference

Protected Member Functions
void	Start (WorldTimestamp timeNow)
WorldTimestamp	GetStartTime ()
bool	IsFinished (WorldTimestamp timeNow, float additionalTime=0)
float	GetRemainingTime (WorldTimestamp timeNow, float additionalTime=0)
float	GetDuration ()
void	SetDuration (float duration)
bool	RplSave (ScriptBitWriter writer)
bool	RplLoad (ScriptBitReader reader)

Static Protected Member Functions
static void	Encode (SSnapSerializerBase snapshot, ScriptCtx ctx, ScriptBitSerializer packet)
	Codec methods.
static bool	Decode (ScriptBitSerializer packet, ScriptCtx ctx, SSnapSerializerBase snapshot)
static bool	SnapCompare (SSnapSerializerBase lhs, SSnapSerializerBase rhs, ScriptCtx ctx)
static bool	PropCompare (SCR_RespawnTimer prop, SSnapSerializerBase snapshot, ScriptCtx ctx)
static bool	Extract (SCR_RespawnTimer prop, ScriptCtx ctx, SSnapSerializerBase snapshot)
static bool	Inject (SSnapSerializerBase snapshot, ScriptCtx ctx, SCR_RespawnTimer prop)

Protected Attributes
WorldTimestamp	m_fStartTime
	Time at which respawn timer was engaged.
float	m_fDuration
	The duration of this timer in seconds.

Detailed Description

Definition at line 1 of file SCR_RespawnTimer.c.

Member Function Documentation

Decode()

bool SCR_RespawnTimer::Decode ( ScriptBitSerializer packet, ScriptCtx ctx, SSnapSerializerBase snapshot )

inlinestaticprotected

Definition at line 97 of file SCR_RespawnTimer.c.

Encode()

void SCR_RespawnTimer::Encode ( SSnapSerializerBase snapshot, ScriptCtx ctx, ScriptBitSerializer packet )

inlinestaticprotected

Codec methods.

Definition at line 91 of file SCR_RespawnTimer.c.

Extract()

bool SCR_RespawnTimer::Extract ( SCR_RespawnTimer prop, ScriptCtx ctx, SSnapSerializerBase snapshot )

inlinestaticprotected

Definition at line 116 of file SCR_RespawnTimer.c.

GetDuration()

float SCR_RespawnTimer::GetDuration ( )

inlineprotected

Returns duration in seconds of this timer.

Definition at line 53 of file SCR_RespawnTimer.c.

GetRemainingTime()

float SCR_RespawnTimer::GetRemainingTime ( WorldTimestamp timeNow, float additionalTime = 0 )

inlineprotected

Parameters

timeNow	Current (synchronized) time to ask at.
additionalTime	Optional additional time to add.

Returns

Returns remaining time in seconds or 0 if finished.

Definition at line 40 of file SCR_RespawnTimer.c.

GetStartTime()

WorldTimestamp SCR_RespawnTimer::GetStartTime ( )

inlineprotected

Returns current start time of this timer as seconds of synchronized time.

Definition at line 20 of file SCR_RespawnTimer.c.

Inject()

bool SCR_RespawnTimer::Inject ( SSnapSerializerBase snapshot, ScriptCtx ctx, SCR_RespawnTimer prop )

inlinestaticprotected

Definition at line 124 of file SCR_RespawnTimer.c.

IsFinished()

bool SCR_RespawnTimer::IsFinished ( WorldTimestamp timeNow, float additionalTime = 0 )

inlineprotected

Parameters

timeNow	Current (synchronized) time to ask at.
additionalTime	Optional additional time to add.

Returns

Returns true in case timer is finished, false otherwise.

Definition at line 30 of file SCR_RespawnTimer.c.

PropCompare()

bool SCR_RespawnTimer::PropCompare ( SCR_RespawnTimer prop, SSnapSerializerBase snapshot, ScriptCtx ctx )

inlinestaticprotected

Definition at line 109 of file SCR_RespawnTimer.c.

RplLoad()

bool SCR_RespawnTimer::RplLoad ( ScriptBitReader reader )

inlineprotected

Deserialize this class using provided ScriptBitWriter.

Definition at line 80 of file SCR_RespawnTimer.c.

RplSave()

bool SCR_RespawnTimer::RplSave ( ScriptBitWriter writer )

inlineprotected

Serialize this class using provided ScriptBitWriter.

Definition at line 69 of file SCR_RespawnTimer.c.

SetDuration()

void SCR_RespawnTimer::SetDuration ( float duration )

inlineprotected

Parameters

duration

New duration in seconds to set.

Definition at line 61 of file SCR_RespawnTimer.c.

SnapCompare()

bool SCR_RespawnTimer::SnapCompare ( SSnapSerializerBase lhs, SSnapSerializerBase rhs, ScriptCtx ctx )

inlinestaticprotected

Definition at line 103 of file SCR_RespawnTimer.c.

Start()

void SCR_RespawnTimer::Start ( WorldTimestamp timeNow )

inlineprotected

Start the timer by providing new start time.

Parameters

timeNow

Current (synchronized) time to ask at.

Definition at line 12 of file SCR_RespawnTimer.c.

Member Data Documentation

m_fDuration

float SCR_RespawnTimer::m_fDuration

protected

The duration of this timer in seconds.

Definition at line 6 of file SCR_RespawnTimer.c.

m_fStartTime

WorldTimestamp SCR_RespawnTimer::m_fStartTime

protected

Time at which respawn timer was engaged.

Definition at line 4 of file SCR_RespawnTimer.c.

---

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

• scripts/Game/GameMode/Respawn/SCR_RespawnTimer.c