Tools

Helpful functions & classes

Classes

AnimationTimer AnimatorTimer CallQueue CallQueueContext DragQueue multiMap Param Param1 Param10 Param2 Param3 Param4 Param5 Param6 Param7 Param8 Param9 Timer TimerBase TimerQueue WidgetFadeTimer

Typedefs

TStringMap map<string, string>

Functions

`void ~AnimationTimer()`		more…
`void ~multiMap()`		more…
`void ~TimerBase()`		more…
`void ~TimerQueue()`		more…
`void Animate(float val, float speed = 1.0)`	Starts animate value until value reaches target value.	more…
`void AnimateLoop(float speed = 1.0)`	Starts infinite animation loop <-1,1>. Based on sinus transition.	more…
`void AnimationTimer(int category = CALL_CATEGORY_SYSTEM)`		more…
`void Call(Class obj, string fn_name, Param params = NULL)` [1/2]	Creates new call request, add it on queue and execute during frame update (depends on call category)	more…
`void Call()` [2/2]		more…
`void CallParams(Param params)`		more…
`void CallQueue()`
`void CallQueueContext(Class target, string fn, Param params)`
`void Clear()`		more…
`void Continue()`	Timer continue when it was paused.	more…
`int Count()`		more…
`bool Deserializer(Serializer ctx)` [1/11]
`override bool Deserializer(Serializer ctx)` [2/11]		more…
`override bool Deserializer(Serializer ctx)` [3/11]		more…
`override bool Deserializer(Serializer ctx)` [4/11]		more…
`override bool Deserializer(Serializer ctx)` [5/11]		more…
`override bool Deserializer(Serializer ctx)` [6/11]		more…
`override bool Deserializer(Serializer ctx)` [7/11]		more…
`override bool Deserializer(Serializer ctx)` [8/11]		more…
`override bool Deserializer(Serializer ctx)` [9/11]		more…
`override bool Deserializer(Serializer ctx)` [10/11]		more…
`override bool Deserializer(Serializer ctx)` [11/11]		more…
`void DragQueue()`
`void FadeIn(Widget w, float time, bool continue_ = false)`	Make "fade in" effect on Widget (transparency goes from 0.0 to 1.0)	more…
`void FadeOut(Widget w, float time, bool continue_ = false)`	Make "fade out" effect on Widget (transparency goes from 1.0 to 0.0)	more…
`array<V> Get(K key)`		more…
`array<V> GetByIndex(int index)`		more…
`float GetDuration()`
`K GetKeyByIndex(int index)`		more…
`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…
`float GetRemaining()`
`float GetRunTime()`
`float GetTargetValue()`	Returns target value. While AnimateLoop returns angle of cycle in radians.
`int GetTemperatureColor(int temperature)`		more…
`float GetTime()`
`float GetValue()` [1/2]	Returns actual animated value.
`float GetValue()` [2/2]	Returns actual animated value.
`bool HasKey(K key)`		more…
`void Insert(K key, V value)`		more…
`void Invalidate()`
`override bool IsRunning()` [1/3]
`bool IsRunning()` [2/3]
`bool IsRunning()` [3/3]		more…
`bool IsValid()`
`protected void OnInit(int category)`		more…
`protected void OnStart(float duration, bool loop)`		more…
`override protected void OnTimer()` [1/3]		more…
`protected void OnTimer()` [2/3]
`override private void OnTimer()` [3/3]		more…
`void OnTimerQueueDestoryed()`	System function, don't call.
`protected void OnUpdate()` [1/2]
`override private void OnUpdate()` [2/2]		more…
`void Param1(T1 p1)`
`void Param10(T1 p1, T2 p2, T3 p3, T4 p4, T5 p5, T6 p6, T7 p7, T8 p8, T9 p9, T10 p10)`
`void Param2(T1 p1, T2 p2)`
`void Param3(T1 p1, T2 p2, T3 p3)`
`void Param4(T1 p1, T2 p2, T3 p3, T4 p4)`
`void Param5(T1 p1, T2 p2, T3 p3, T4 p4, T5 p5)`
`void Param6(T1 p1, T2 p2, T3 p3, T4 p4, T5 p5, T6 p6)`
`void Param7(T1 p1, T2 p2, T3 p3, T4 p4, T5 p5, T6 p6, T7 p7)`
`void Param8(T1 p1, T2 p2, T3 p3, T4 p4, T5 p5, T6 p6, T7 p7, T8 p8)`
`void Param9(T1 p1, T2 p2, T3 p3, T4 p4, T5 p5, T6 p6, T7 p7, T8 p8, T9 p9)`
`void Pause()`	Pause Timer, internal counter is not restarted, so timer can continue later. Can be unpaused via Continue.	more…
`void Remove(K key)`		more…
`void RemoveByIndex(int index)`		more…
`void RemoveCalls(Class obj)`	Removes all queued calls for object (call this function when object is going to be deleted)	more…
`void Run(float targetVal, Managed obj, string updateFunc, string finishedFunc, float startingVal = 0, bool loop = false, float speed = 1.0, Param params = null, int category = CALL_CATEGORY_SYSTEM)` [1/2]		more…
`void Run(float duration, Managed obj, string fn_name, Param params = NULL, bool loop = false)` [2/2]	Starts timer.	more…
`bool Serialize(Serializer ctx)` [1/11]
`override bool Serialize(Serializer ctx)` [2/11]		more…
`override bool Serialize(Serializer ctx)` [3/11]		more…
`override bool Serialize(Serializer ctx)` [4/11]		more…
`override bool Serialize(Serializer ctx)` [5/11]		more…
`override bool Serialize(Serializer ctx)` [6/11]		more…
`override bool Serialize(Serializer ctx)` [7/11]		more…
`override bool Serialize(Serializer ctx)` [8/11]		more…
`override bool Serialize(Serializer ctx)` [9/11]		more…
`override bool Serialize(Serializer ctx)` [10/11]		more…
`override bool Serialize(Serializer ctx)` [11/11]		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…
`protected void SetRunning(bool running)`		more…
`void SetValue(float val)`	Sets both value and target value.
`override void Stop()` [1/2]		more…
`void Stop()` [2/2]	Stop Timer and restart internal counter. Cannot be unpaused, must be started again.	more…
`override void Tick(float timeslice)` [1/6]	Ticks the timer, is called by timer subsystem.	more…
`void Tick(float timeslice)` [2/6]	Ticks the timer, is called by timer subsystem.	more…
`void Tick()` [3/6]	System function, don't call it	more…
`override void Tick()` [4/6]	System function, don't call it	more…
`void Tick(float timeslice)` [5/6]	System function, don't call.	more…
`void Tick(float timeslice)` [6/6]		more…
`void Timer(int category = CALL_CATEGORY_SYSTEM)`		more…
`void TimerQueue()`
`void WidgetFadeTimer()`		more…

Variables

`const int CALL_CATEGORY_COUNT = 3`
`const int CALL_CATEGORY_GAMEPLAY = 2`	Runs unless ingame menu is opened
`const int CALL_CATEGORY_GUI = 1`	Runs always (on client)
`const int CALL_CATEGORY_SYSTEM = 0`	Runs always
`private bool m_active = false`
`private bool m_Active`
`float m_alpha`
`protected float m_duration`
`bool m_fadeIn`
`protected string m_FinishedFunction`
`string m_function` [1/2]
`protected string m_function` [2/2]
`private ref array<K> m_keys`
`private bool m_loop = false` [1/2]
`protected bool m_loop` [2/2]
`private ref Param3<int, int, bool> m_mouse_params`	x,y, is_holding_mb
`ref Param m_params` [1/2]
`protected ref Param m_params` [2/2]
`protected ref Param m_Params`
`private bool m_processing` [1/2]
`private bool m_processing` [2/2]
`protected bool m_running`
`protected float m_RunTime`
`Class m_target` [1/2]
`protected Managed m_target` [2/2]
`private float m_target_value = 0`
`protected Managed m_TargetObject`
`private float m_TargetValue`
`private float m_TargetValueOriginal`
`private float m_time = 0` [1/2]
`protected float m_time` [2/2]
`protected array<TimerBase> m_timerQueue`
`protected string m_UpdateFunction`
`bool m_valid`
`private float m_value = 0`
`private float m_Value`
`private ref array<ref array<V> > m_values`
`private Widget m_widget`
`T1 param1` [1/10]
`T1 param1` [2/10]
`T1 param1` [3/10]
`T1 param1` [4/10]
`T1 param1` [5/10]
`T1 param1` [6/10]
`T1 param1` [7/10]
`T1 param1` [8/10]
`T1 param1` [9/10]
`T1 param1` [10/10]
`T10 param10`
`T2 param2` [1/9]
`T2 param2` [2/9]
`T2 param2` [3/9]
`T2 param2` [4/9]
`T2 param2` [5/9]
`T2 param2` [6/9]
`T2 param2` [7/9]
`T2 param2` [8/9]
`T2 param2` [9/9]
`T3 param3` [1/8]
`T3 param3` [2/8]
`T3 param3` [3/8]
`T3 param3` [4/8]
`T3 param3` [5/8]
`T3 param3` [6/8]
`T3 param3` [7/8]
`T3 param3` [8/8]
`T4 param4` [1/7]
`T4 param4` [2/7]
`T4 param4` [3/7]
`T4 param4` [4/7]
`T4 param4` [5/7]
`T4 param4` [6/7]
`T4 param4` [7/7]
`T5 param5` [1/6]
`T5 param5` [2/6]
`T5 param5` [3/6]
`T5 param5` [4/6]
`T5 param5` [5/6]
`T5 param5` [6/6]
`T6 param6` [1/5]
`T6 param6` [2/5]
`T6 param6` [3/5]
`T6 param6` [4/5]
`T6 param6` [5/5]
`T7 param7` [1/4]
`T7 param7` [2/4]
`T7 param7` [3/4]
`T7 param7` [4/4]
`T8 param8` [1/3]
`T8 param8` [2/3]
`T8 param8` [3/3]
`T9 param9` [1/2]
`T9 param9` [2/2]

Function Documentation

~AnimationTimerAnimationTimer

void ~AnimationTimer()

References TimerBase.SetRunning()

~multiMapmultiMap

void ~multiMap()

References Clear()

~TimerBaseTimerBase

void ~TimerBase()

References SetRunning(), and m_timerQueue

~TimerQueueTimerQueue

void ~TimerQueue()

References array.Clear(), array.Count(), array.Get()

Show 1 more

, TimerBase.OnTimerQueueDestoryed()

AnimateAnimatorTimer

void Animate(float val, float speed = 1.0)

Starts animate value until value reaches target value.

val: float target value
speed: float speed of animating, units per second

References m_active, m_loop, m_target_value

Show 1 more

, m_time

Referenced by HoverEffect.OnMouseEnter(), HoverEffect.OnMouseLeave(), MainMenuButtonEffect.OnFocus()

Show 1 more

, MainMenuButtonEffect.OnFocusLost()

AnimateLoopAnimatorTimer

void AnimateLoop(float speed = 1.0)

Starts infinite animation loop <-1,1>. Based on sinus transition.

speed: float speed of animating , cycles per second (1.0 means one 360 degree sinus cycle per second: 0..1..0..-1..0)

References m_active, m_loop, m_target_value

Show 2 more

, m_time, and m_value

Referenced by Bouncer.OnWidgetScriptInit(), RadialProgressBar.OnWidgetScriptInit(), and Rotator.OnWidgetScriptInit()

AnimationTimerAnimationTimer

void AnimationTimer(int category = CALL_CATEGORY_SYSTEM)

References TimerBase.OnInit()

Referenced by Land_Underground_Entrance.OnDoorStateChangedServer(), Land_Underground_EntranceBase.OnAction(), Land_Underground_Stairs_Exit.OnDoorStateChangedServer()

Show 2 more

, UndergroundHandlerClient.CalculateLinePointFade(), and UndergroundHandlerClient.OnUndergroundPresenceUpdate()

Call [1/2]CallQueue

void Call(Class obj, string fn_name, Param params = NULL)

Creates new call request, add it on queue and execute during frame update (depends on call category)

obj: target object on which function will be executed
fn_name: name of function (on object "obj") which will be executed
params: function arguments see Param for usage, default NULL (no arguments)

WarningWhen object "obj" is deleted prior call execution, don't forget to remove calls for this object with RemoveCalls

References new CallQueueContext(), and array.Insert()

Referenced by InspectMenuNew.OnMouseButtonDown(), and ScrollBarContainer.OnMouseButtonDown()

Call [2/2]CallQueueContext

void Call()

References CallParams(), and m_params

Referenced by CallQueue.Tick(), and ContextMenu.OnMouseButtonDown()

CallParamsCallQueueContext

void CallParams(Param params)

References ScriptModule.CallFunction(), ScriptModule.CallFunctionParams(), CGame.GameScript

Show 2 more

, m_function, and m_target

Referenced by Call(), and DragQueue.Tick()

ClearmultiMap

void Clear()

References array.Clear(), array.Clear(), m_keys

Show 1 more

, m_values

Referenced by ~multiMap()

ContinueTimerBase

void Continue()

Timer continue when it was paused.

References SetRunning()

Referenced by UniversalTemperatureSource.SetActive()