SCR_RespawnTimer Interface Reference

Public Member Functions
void	Start (WorldTimestamp timeNow)
	Start the timer by providing new start time.
WorldTimestamp	GetStartTime ()
	Returns current start time of this timer as seconds of synchronized time.
bool	IsFinished (WorldTimestamp timeNow, float additionalTime=0)
float	GetRemainingTime (WorldTimestamp timeNow, float additionalTime=0)
float	GetDuration ()
	Returns duration in seconds of this timer.
void	SetDuration (float duration)
bool	RplSave (ScriptBitWriter writer)
	Serialize this class using provided ScriptBitWriter.
bool	RplLoad (ScriptBitReader reader)
	Deserialize this class using provided ScriptBitWriter.

Static Public 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.

Member Function Documentation

Decode()

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

static

Encode()

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

static

Codec methods.

Extract()

static bool SCR_RespawnTimer.Extract ( SCR_RespawnTimer  prop, ScriptCtx  ctx, SSnapSerializerBase  snapshot  )

static

GetDuration()

float SCR_RespawnTimer.GetDuration

(

)

Returns duration in seconds of this timer.

GetRemainingTime()

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

Parameters

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

Returns

Returns remaining time in seconds or 0 if finished.

GetStartTime()

WorldTimestamp SCR_RespawnTimer.GetStartTime

(

)

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

Inject()

static bool SCR_RespawnTimer.Inject ( SSnapSerializerBase  snapshot, ScriptCtx  ctx, SCR_RespawnTimer  prop  )

static

IsFinished()

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

Parameters

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

Returns

Returns true in case timer is finished, false otherwise.

PropCompare()

static bool SCR_RespawnTimer.PropCompare ( SCR_RespawnTimer  prop, SSnapSerializerBase  snapshot, ScriptCtx  ctx  )

static

RplLoad()

bool SCR_RespawnTimer.RplLoad

(

ScriptBitReader

reader

)

Deserialize this class using provided ScriptBitWriter.

RplSave()

bool SCR_RespawnTimer.RplSave

(

ScriptBitWriter

writer

)

Serialize this class using provided ScriptBitWriter.

SetDuration()

void SCR_RespawnTimer.SetDuration

(

float

duration

)

Parameters

duration

New duration in seconds to set.

SnapCompare()

static bool SCR_RespawnTimer.SnapCompare ( SSnapSerializerBase  lhs, SSnapSerializerBase  rhs, ScriptCtx  ctx  )

static

Start()

void SCR_RespawnTimer.Start

(

WorldTimestamp

timeNow

)

Start the timer by providing new start time.

Parameters

timeNow

Current (synchronized) time to ask at.

Member Data Documentation

m_fDuration

float SCR_RespawnTimer.m_fDuration

protected

The duration of this timer in seconds.

m_fStartTime

WorldTimestamp SCR_RespawnTimer.m_fStartTime

protected

Time at which respawn timer was engaged.

---

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

• Game/GameMode/Respawn/SCR_RespawnTimer.c