DayZ Enforce
Script API
Classes | Typedefs | Functions | Variables
Tools

Classes

class   Param
  Base Param Class with no parameters. Used as general purpose parameter overloaded with Param1 to Param4 templates. More...
 
class   Param1< class T1 >
  Param Class Template with one parameter.
usage: More...
 
class   Param2< class T1, class T2 >
  Param Class Template with two parameters.
usage: More...
 
class   Param3< class T1, class T2, class T3 >
  Param Class Template with three parameters.
usage: More...
 
class   Param4< class T1, class T2, class T3, class T4 >
  Param Class Template with four parameters.
usage: More...
 
class   Param5< class T1, class T2, class T3, class T4, class T5 >
  Param Class Template with five parameters. More...
 
class   Param6< class T1, class T2, class T3, class T4, class T5, class T6 >
  Param Class Template with six parameters. More...
 
class   CallQueueContext
 
class   CallQueue
  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   DragQueue
  DragQueue Class provide callbacks while mouse is dragging. Callback function must have exact arguments: More...
 
class   TimerQueue
  TimerQueue Class using for system purpose only. More...
 
class   WidgetFadeTimer
  Simple class for fading Widgets. More...
 
class   Timer
  Timer class. Use when you want call function after some time, or repeatedly in time intervals. Call is not executed after the Timer object is deleted.
usage: More...
 
class   TimerUpdate
  Simple class for fading Widgets. More...
 
class   AnimatorTimer
  AnimatorTimer class. This timer is for animate float value.
usage: More...
 
class   multiMap< class K, class V >
  Associative array template, with multiple values per key
usage: More...
 

Typedefs

typedef map< string, string >  TStringMap
 
typedef multiMap< string, string >  TStringMultiMap
 

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 ()
 
protected void  OnInit (int category)
 
protected void  OnStart (float duration, bool loop)
 
protected void  OnUpdate ()
 
protected void  OnTimer ()
 
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...
 

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
 
DragQueue  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
 

Detailed Description

Helpful functions & classes

Typedef Documentation

typedef map<string, string> TStringMap
typedef multiMap<string, string> TStringMultiMap

Function Documentation

void TimerBase::~TimerBase ( )

References m_timerQueue, and SetRunning().

void Pause ( )

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

void Continue ( )

Timer continue when it was paused.

void Stop ( )

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

bool IsRunning ( )
Returns
True when Timer is running (not stopped, not paused)

Referenced by TimerUpdate::Tick(), and AnimatorTimer::Tick().

void Tick ( float  timeslice )

System function, don't call.

void TimerBase::OnTimerQueueDestoryed ( )

System function, don't call.

References m_timerQueue.

float GetTime ( )
protected void OnInit ( int  category )
protected void OnStart ( float  duration,
bool  loop 
)
protected void OnUpdate ( )
protected void OnTimer ( )
void TimerBase::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.

References GetGame().

Referenced by MissionGameplay::OnEvent(), and OptionsMenu::UpdateChatMessages().

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!

References GetGame(), and CGame::SetProfileString().

Referenced by OptionsMenu::ApplyFn().

Variable Documentation

const int CALL_CATEGORY_SYSTEM = 0
const int CALL_CATEGORY_GUI = 1
const int CALL_CATEGORY_GAMEPLAY = 2
const int CALL_CATEGORY_COUNT = 3
DragQueue m_running

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

Referenced by SetRunning().

protected bool m_loop
protected float m_duration
protected float m_time
protected array<TimerBase> m_timerQueue
Converted from CHM to HTML with chm2web Pro 2.85 (unicode)