Tools

\desc Helpful functions & classes More...

Data Structures
class	Param
	Base Param Class with no parameters. Used as general purpose parameter overloaded with Param1 to Param4 templates. More...
class	Param7< Class T1, Class T2, Class T3, Class T4, Class T5, Class T6, Class T7 >
	Param Class Template with seven parameters. More...
class	Param8< Class T1, Class T2, Class T3, Class T4, Class T5, Class T6, Class T7, Class T8 >
	Param Class Template with eight parameters. More...
class	Param9< Class T1, Class T2, Class T3, Class T4, Class T5, Class T6, Class T7, Class T8, Class T9 >
	Param Class Template with nine parameters. More...
class	Param10< Class T1, Class T2, Class T3, Class T4, Class T5, Class T6, Class T7, Class T8, Class T9, Class T10 >
	Param Class Template with ten parameters. More...
class	CallQueueContext
class	array< ref CallQueueContext >
	CallQueue Class provide "lazy" calls - when we don't want to execute function immediately but later during frame update (used mainly in UI) usage: More...
class	CallQueue
	DragQueue Class provide callbacks while mouse is dragging. Callback function must have exact arguments: More...
class	array< TimerBase >
	TimerQueue Class using for system purpose only. More...
class	TimerBase
	Simple class for fading Widgets. More...
class	AnimationTimer
	AnimationTimer class. This timer is for animating float value. usage: More...
class	AnimatorTimer
class	multiMap< Class K, Class V >
	Associative array template, with multiple values per key usage: More...

Typedefs
typedef map< string, string >	TStringMap

Functions
void	~TimerBase ()
void	Pause ()
	Pause Timer, internal counter is not restarted, so timer can continue later. Can be unpaused via Continue. More...
void	Continue ()
	Timer continue when it was paused. More...
void	Stop ()
	Stop Timer and restart internal counter. Cannot be unpaused, must be started again. More...
bool	IsRunning ()
void	Tick (float timeslice)
	System function, don't call. More...
void	OnTimerQueueDestoryed ()
	System function, don't call. More...
float	GetTime ()
float	GetDuration ()
float	GetRemaining ()
float	GetRunTime ()
protected void	OnInit (int category)
protected void	OnStart (float duration, bool loop)
protected void	OnUpdate ()
protected void	OnTimer ()
	DEPRECATED. More...
protected void	SetRunning (bool running)
int	GetTemperatureColor (int temperature)
bool	GetProfileValueBool (string name, bool def=false)
	Return value from profile variable, if variable with given name is not present, default value is returned. More...
void	SetProfileValueBool (string name, bool value)
	Writes bool variable to profile, after write don't forget to call CGame::SaveProfile() to save profile to storage! More...
int	GetNumberOfSetBits (int i)

Variables
const int	CALL_CATEGORY_SYSTEM = 0
const int	CALL_CATEGORY_GUI = 1
const int	CALL_CATEGORY_GAMEPLAY = 2
const int	CALL_CATEGORY_COUNT = 3
class CallQueueContext	ConvertSecondsToFullTime
class DragQueue extends CallQueue	m_running
	TimerBase Class provide just interface for all Timer classes. Don't instance this class, use Timer class instead. More...
protected bool	m_loop
protected float	m_duration
protected float	m_time
protected array< TimerBase >	m_timerQueue
protected float	m_RunTime

Detailed Description

\desc Helpful functions & classes

Typedef Documentation

TStringMap

typedef map<string, string> TStringMap

Definition at line 990 of file tools.c.

Function Documentation

Continue()

void Continue

(

)

Timer continue when it was paused.

Definition at line 247 of file tools.c.

GetDuration()

float GetDuration

(

)

Definition at line 313 of file tools.c.

GetNumberOfSetBits()

int GetNumberOfSetBits

(

int

i

)

Definition at line 1055 of file tools.c.

GetProfileValueBool()

bool GetProfileValueBool	(	string	name,
		bool	def = false
	)

Return value from profile variable, if variable with given name is not present, default value is returned.

Definition at line 1021 of file tools.c.

GetRemaining()

float GetRemaining

(

)

Definition at line 318 of file tools.c.

GetRunTime()

float GetRunTime

(

)

Definition at line 323 of file tools.c.

GetTemperatureColor()

int GetTemperatureColor

(

int

temperature

)

Definition at line 992 of file tools.c.

GetTime()

float GetTime

(

)

Definition at line 308 of file tools.c.

IsRunning()

bool IsRunning

(

)

Returns

True when Timer is running (not stopped, not paused)

Definition at line 264 of file tools.c.

OnInit()

protected void OnInit

(

int

category

)

Definition at line 328 of file tools.c.

OnStart()

protected void OnStart	(	float	duration,
		bool	loop
	)

Definition at line 340 of file tools.c.

OnTimer()

protected void OnTimer

(

)

DEPRECATED.

Definition at line 350 of file tools.c.

OnTimerQueueDestoryed()

void OnTimerQueueDestoryed

(

)

System function, don't call.

Definition at line 303 of file tools.c.

OnUpdate()

protected void OnUpdate

(

)

Definition at line 349 of file tools.c.

Pause()

void Pause

(

)

Pause Timer, internal counter is not restarted, so timer can continue later. Can be unpaused via Continue.

Definition at line 239 of file tools.c.

SetProfileValueBool()

void SetProfileValueBool	(	string	name,
		bool	value
	)

Writes bool variable to profile, after write don't forget to call CGame::SaveProfile() to save profile to storage!

Definition at line 1042 of file tools.c.

SetRunning()

protected void SetRunning

(

bool

running

)

Definition at line 351 of file tools.c.

Stop()

void Stop

(

)

Stop Timer and restart internal counter. Cannot be unpaused, must be started again.

Definition at line 255 of file tools.c.

Tick()

void Tick

(

float

timeslice

)

System function, don't call.

Definition at line 272 of file tools.c.

~TimerBase()

void ~TimerBase

(

)

Definition at line 228 of file tools.c.

Variable Documentation

CALL_CATEGORY_COUNT

const int CALL_CATEGORY_COUNT = 3

Definition at line 12 of file tools.c.

CALL_CATEGORY_GAMEPLAY

const int CALL_CATEGORY_GAMEPLAY = 2

Definition at line 10 of file tools.c.

CALL_CATEGORY_GUI

const int CALL_CATEGORY_GUI = 1

Definition at line 9 of file tools.c.

CALL_CATEGORY_SYSTEM

const int CALL_CATEGORY_SYSTEM = 0

Definition at line 8 of file tools.c.

ConvertSecondsToFullTime

class CallQueueContext ConvertSecondsToFullTime

m_duration

protected float m_duration

Definition at line 223 of file tools.c.

m_loop

protected bool m_loop

Definition at line 222 of file tools.c.

m_running

class DragQueue extends CallQueue m_running

TimerBase Class provide just interface for all Timer classes. Don't instance this class, use Timer class instead.

m_RunTime

protected float m_RunTime

Definition at line 226 of file tools.c.

m_time

protected float m_time

Definition at line 224 of file tools.c.

m_timerQueue

protected array<TimerBase> m_timerQueue

Definition at line 225 of file tools.c.