Tools

\desc Helpful functions & classes More...

Data Structures
class	AnimationTimer
	AnimationTimer class. More...
class	AnimatorTimer
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	array< TimerBase >
	TimerQueue Class using for system purpose only. More...
class	CallQueue
	DragQueue Class provide callbacks while mouse is dragging. More...
class	CallQueueContext
class	multiMap< Class K, Class V >
	Associative array template, with multiple values per key usage: More...
class	Param
	Base Param Class with no 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	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	TimerBase
	Simple class for fading Widgets. More...

Typedefs
typedef map< string, string >	TStringMap

Functions
void	~TimerBase ()
void	Continue ()
	Timer continue when it was paused.
float	GetDuration ()
int	GetNumberOfSetBits (int i)
bool	GetProfileValueBool (string name, bool def=false)
	Return value from profile variable, if variable with given name is not present, default value is returned.
float	GetRemaining ()
float	GetRunTime ()
int	GetTemperatureColor (int temperature)
float	GetTime ()
bool	IsRunning ()
void	OnInit (int category)
void	OnStart (float duration, bool loop)
void	OnTimer ()
	DEPRECATED.
void	OnTimerQueueDestoryed ()
	System function, don't call.
void	OnUpdate ()
void	Pause ()
	Pause Timer, internal counter is not restarted, so timer can continue later.
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!
void	SetRunning (bool running)
void	Stop ()
	Stop Timer and restart internal counter.
void	Tick (float timeslice)
	System function, don't call.

Variables
const int	CALL_CATEGORY_COUNT = 3
const int	CALL_CATEGORY_GAMEPLAY = 2
const int	CALL_CATEGORY_GUI = 1
const int	CALL_CATEGORY_SYSTEM = 0
float	m_duration
bool	m_loop
class DragQueue extends CallQueue	m_running
	TimerBase Class provide just interface for all Timer classes.
float	m_RunTime
float	m_time
array< TimerBase >	m_timerQueue

Detailed Description

\desc Helpful functions & classes

Typedef Documentation

TStringMap

typedef map<string, string> TStringMap

protected

Definition at line 988 of file tools.c.

Function Documentation

~TimerBase()

void ~TimerBase ( )

protected

Definition at line 228 of file tools.c.

References m_timerQueue, and SetRunning().

Continue()

void Continue ( )

protected

Timer continue when it was paused.

Definition at line 247 of file tools.c.

References SetRunning().

Referenced by MissionBase::~MissionGameplay(), and MissionBase::OnUpdate().

GetDuration()

float GetDuration ( )

protected

Definition at line 313 of file tools.c.

References m_duration.

GetNumberOfSetBits()

int GetNumberOfSetBits ( int i )

protected

Definition at line 1053 of file tools.c.

References Math::GetNumberOfSetBits().

GetProfileValueBool()

bool GetProfileValueBool ( string name, bool def = false )

protected

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

Definition at line 1019 of file tools.c.

References g_Game, and name.

Referenced by DayZProfilesOptions::RegisterProfileOption(), and DayZProfilesOptions::ResetOptionsBool().

GetRemaining()

float GetRemaining ( )

protected

Definition at line 318 of file tools.c.

References m_duration, and m_time.

GetRunTime()

float GetRunTime ( )

protected

Definition at line 323 of file tools.c.

References m_RunTime.

GetTemperatureColor()

int GetTemperatureColor ( int temperature )

protected

Definition at line 990 of file tools.c.

References Math::AbsInt(), ARGB(), Math::Clamp(), GameConstants::ITEM_TEMPERATURE_NEUTRAL_ZONE_LOWER_LIMIT, and GameConstants::ITEM_TEMPERATURE_NEUTRAL_ZONE_UPPER_LIMIT.

Referenced by UIScriptedMenu::UpdateItemInfoQuantity().

GetTime()

float GetTime ( )

protected

Definition at line 308 of file tools.c.

References m_time.

IsRunning()

bool IsRunning ( )

protected

Returns

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

Definition at line 264 of file tools.c.

References m_running.

Referenced by HFSMBase< Class FSMStateBase, Class FSMEventBase, Class FSMActionBase, Class FSMGuardBase >::Abort(), ManBase::CanBeRestrained(), HFSMBase< Class FSMStateBase, Class FSMEventBase, Class FSMActionBase, Class FSMGuardBase >::FindFirstCompletionTransition(), ManBase::OnQuickBarSingleUse(), FSMBase< Class FSMStateBase, Class FSMEventBase, Class FSMActionBase, Class FSMGuardBase >::Terminate(), HFSMBase< Class FSMStateBase, Class FSMEventBase, Class FSMActionBase, Class FSMGuardBase >::Terminate(), OFSMBase< Class FSMStateBase, Class FSMEventBase, Class FSMActionBase, Class FSMGuardBase >::Terminate(), Tick(), FSMBase< Class FSMStateBase, Class FSMEventBase, Class FSMActionBase, Class FSMGuardBase >::Update(), HFSMBase< Class FSMStateBase, Class FSMEventBase, Class FSMActionBase, Class FSMGuardBase >::Update(), Managed::Update(), and OFSMBase< Class FSMStateBase, Class FSMEventBase, Class FSMActionBase, Class FSMGuardBase >::Update().

OnInit()

void OnInit ( int category )

protected

Definition at line 328 of file tools.c.

References ErrorEx, g_Game, m_duration, m_loop, m_running, m_time, and m_timerQueue.

OnStart()

void OnStart ( float duration, bool loop )

protected

Definition at line 340 of file tools.c.

References m_duration, m_loop, m_RunTime, m_time, and SetRunning().

Referenced by TimerBase::FadeIn(), and TimerBase::FadeOut().

OnTimer()

void OnTimer ( )

protected

DEPRECATED.

Definition at line 350 of file tools.c.

OnTimerQueueDestoryed()

void OnTimerQueueDestoryed ( )

protected

System function, don't call.

Definition at line 303 of file tools.c.

References m_timerQueue.

OnUpdate()

void OnUpdate ( )

protected

Definition at line 349 of file tools.c.

Pause()

void Pause ( )

protected

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.

References SetRunning().

Referenced by MissionBase::OnUpdate().

SetProfileValueBool()

void SetProfileValueBool ( string name, bool value )

protected

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

Definition at line 1040 of file tools.c.

References g_Game, and name.

SetRunning()

void SetRunning ( bool running )

protected

Definition at line 351 of file tools.c.

References m_running, and m_timerQueue.

Referenced by AnimationTimer::~AnimationTimer(), ~TimerBase(), Continue(), OnStart(), Pause(), AnimationTimer::Run(), Stop(), UniversalTemperatureSource::Stop(), and Tick().

Stop()

void Stop ( )

protected

Stop Timer and restart internal counter.

Stops all elements this effect consists of.

Cannot be unpaused, must be started again.

Note

Alternatively use SEffectManager.Stop( effect_id )

Definition at line 255 of file tools.c.

References m_time, and SetRunning().

Tick()

void Tick ( float timeslice )

protected

System function, don't call.

Definition at line 272 of file tools.c.

References IsRunning(), m_duration, m_loop, m_RunTime, m_time, TimerBase::OnTimer(), TimerBase::OnUpdate(), and SetRunning().

Variable Documentation

CALL_CATEGORY_COUNT

const int CALL_CATEGORY_COUNT = 3

Definition at line 12 of file tools.c.

Referenced by CGame::DayZGame().

CALL_CATEGORY_GAMEPLAY

const int CALL_CATEGORY_GAMEPLAY = 2

Definition at line 10 of file tools.c.

Referenced by MissionBase::~MissionServer(), PluginManager::~PluginManager(), Grenade_Base::ActivateRandomTime(), BaseBuildingBase::CheckFenceClosed(), BaseBuildingBase::CheckFenceOpened(), BaseBuildingBase::CloseFence(), CommitSuicide(), DayZIntroSceneXbox::CreateRandomCharacter(), CGame::DayZGame(), Destroy(), Car::EEHitBy(), EEInit(), ItemBase::EEInit(), Weapon::EEInit(), ItemBase::EEOnAfterLoad(), EEOnCECreate(), TerritoryFlag::FullyBuild(), Car::HandleEngineSound(), Hud::Init(), PluginManager::Init(), MissionBase::InputBufferCheck(), MissionBase::MissionServer(), MissionBase::OnClientDisconnectedEvent(), OnEndServer(), ActionDestroyCombinationLock::OnFinishProgressServer(), FireplaceBase::OnIgnitedThis(), PluginBase::OnInit(), MissionBase::OnInputBufferEvent(), OnItemLocationChanged(), InventoryItem::OnOverheatingDecay(), ItemBase::OnPartBuiltServer(), ItemBase::OnPartDestroyedServer(), ItemBase::OnPartDismantledServer(), OnPlacementComplete(), CGame::OnPostUpdate(), CGame::OnRPC(), ManBase::OnRPC(), OnStartServer(), CGame::OnUpdate(), ItemBase::OnVariablesSynchronized(), ItemBase::OnWorkStart(), BaseBuildingBase::OpenFence(), Play(), ItemBase::Refresh(), RefreshFireplaceVisuals(), UniversalTemperatureSourceDebug::SetDefferedActive(), Particle::SetWiggle(), CrashBase::SpawnRandomDeerLater(), StartCooling(), StartHeating(), PoweredOptic_Base::StartPeriodicMeasurement(), Stop(), Synchronize(), and UpdateVisuals().

CALL_CATEGORY_GUI

const int CALL_CATEGORY_GUI = 1

Definition at line 9 of file tools.c.

Referenced by ActionMenu::ActionMenu(), ChatLine::ChatLine(), DayZIntroScene::DayZIntroScene(), DayZIntroSceneXbox::DayZIntroSceneXbox(), MainMenuButtonEffect::MainMenuButtonEffect(), RadialProgressBar::RadialProgressBar(), ScriptedWidgetEventHandler::~ContinuousActionProgress(), ~CrossHairSelector(), ScriptedWidgetEventHandler::~ItemActionsWidget(), MainMenuButtonEffect::~MainMenuButtonEffect(), ScriptedWidgetEventHandler::~ProjectedCrosshair(), RadialProgressBar::~RadialProgressBar(), MissionBase::AbortMission(), ScriptedWidgetEventHandler::ContinuousActionProgress(), CrossHairSelector(), CGame::DayZGame(), Component::DebugBBoxDelete(), Component::DebugBBoxDraw(), Component::DebugDirectionDelete(), Component::DebugDirectionDraw(), VicinitySlotsContainer::DoubleClick(), Clothing_Base::EEHealthLevelChanged(), ManBase::EEHealthLevelChanged(), ManBase::EEItemAttached(), ManBase::EEItemDetached(), UIScriptedMenu::GameRespawn(), UIScriptedMenu::GameRetry(), Init(), ScriptedWidgetEventHandler::ItemActionsWidget(), ServerBrowserTab::LoadingServersStop(), MissionBase::MissionGameplay(), OnActivate(), UIScriptedMenu::OnClick(), UIScriptedMenu::OnClick_Continue(), UIScriptedMenu::OnClick_Exit(), UIScriptedMenu::OnClick_Respawn(), UIScriptedMenu::OnClick_Restart(), CGame::OnEvent(), ServerBrowserTabConsolePages::OnLoadServersAsyncFinished(), UIScriptedMenu::OnModalResult(), ScriptedWidgetEventHandler::OnMouseButtonDown(), ManBase::OnPlayerLoaded(), MissionBase::OnPlayerRespawned(), CGame::OnPostUpdate(), ManBase::OnSelectPlayer(), CGame::OnUpdate(), ScriptedWidgetEventHandler::OptionsMenuControls(), UIScriptedMenu::PerformSetToDefaultsExt(), UIScriptedMenu::Play(), ScriptedWidgetEventHandler::PrepareTooltip(), ScriptedWidgetEventHandler::ProjectedCrosshair(), ManBase::RefreshHandAnimationState(), DayZPlayer::ShowDeadScreen(), ScriptedWidgetEventHandler::StartSlideshow(), ScriptedWidgetEventHandler::StopSlideShow(), ToggleDebugWindowEvent(), VicinitySlotsContainer::TransferItem(), UpdateCarouselInfo(), CGame::UpdateInputDeviceDisconnectWarning(), and TimerBase::WidgetFadeTimer().

CALL_CATEGORY_SYSTEM

const int CALL_CATEGORY_SYSTEM = 0

Definition at line 8 of file tools.c.

Referenced by AnimationTimer::AnimationTimer(), AreaDamageBase::AreaDamageBase(), BoatScript::BoatScript(), DynamicArea_Flare::DynamicArea_Flare(), Land_Underground_EntranceBase::Land_Underground_EntranceBase(), PresenceNotifierNoiseEvents::PresenceNotifierNoiseEvents(), ~SoftSkillManagerDebug(), UIPopupScript::~UIPopupScriptSceneManager(), UIPopupScript::~UIPopupScriptSceneSettings(), Ammo_40mm_Smoke_ColorBase::Activate(), ItemBase::BarbedWire(), ItemBase::BatteryCharger(), UIScriptedMenu::Cancel(), CGame::CancelLoginTimeCountdown(), Entity::CheckForDestroy(), ItemBase::CheckRainStart(), BoatScript::ClearWaterEffects(), UIScriptedMenu::CloseDialog(), UIManager::CloseWindow(), ScriptConsoleEnfScriptTab::ColorRunButton(), CreateTrigger(), IEntity::DecreaseHealth(), IEntity::Delete(), EntityLightSource::DeleteLightWithDelay(), Entity::DeleteOnClient(), DeleteThis(), DetermineTrackByCategory(), DynamicMusicPlayer(), FlammableBase::EEItemDetached(), ManBase::EEItemOutOfHands(), Ammo_40mm_Explosive::EEKilled(), Entity::EEKilled(), ItemBase::EEOnAfterLoad(), EndLoading(), Entity::EntityAI(), EOnFrame(), ComponentEnergyManager::Event_OnAwake(), UIScriptedMenu::Exit(), InventoryItem::ExplodeAmmo(), HandleSoundEffectsPipeCreaking(), Clothing::Headtorch_ColorBase(), InventoryItem::IncreaseOverheating(), Init(), ManBase::Init(), UIScriptedMenu::Init(), InitZoneServer(), Interact(), UIScriptedMenu::Leave(), ScriptedWidgetEventHandler::LoadVideo(), DrowningMdfr::OnActivate(), ImprovisedExplosive::OnActivatedByItem(), ClaymoreMine::OnArmed(), ScriptConsoleGeneralTab::OnClick(), UIPopupScript::OnClose(), Grenade_ChemGas::OnDamageDestroyed(), ZombieMaleBase::OnDamageDestroyed(), PluginBase::OnDestroy(), ManBase::OnDrowningEnd(), BoatScript::OnEngineStop(), CGame::OnEvent(), FireworksLauncherClientEvent::OnExplode(), OnExplode(), OnFinishProgressServer(), FireworksLauncher::OnFuseIgnitedServer(), BiosSessionService::OnGetSessionError(), DestructionEffectBase::OnHealthLevelChanged(), PluginBase::OnInit(), ComponentEnergyManager::OnIsPlugged(), CGame::OnLoginTimeEvent(), ConnectErrorScriptModuleUI::OnModalResult(), OnNextTrackSelected(), UIPopupScript::OnOpen(), Land_Underground_Panel_Lever::OnPanelUsedSynchronized(), ItemBase::OnPlacementComplete(), ScriptedWidgetEventHandler::OnPlaybackStart(), ScriptedWidgetEventHandler::OnPlaybackStop(), CGame::OnPostUpdate(), CGame::OnRespawnEvent(), PluginBase::OnRPCSyncSceneObject(), OnShow(), PluginBase::OnUIEditorOpened(), CGame::OnUpdate(), HeadGear_Base::OnWasAttached(), ItemBase::OnWorkStart(), Torch_Video::OnWorkStart(), Roadflare::OnWorkStop(), Torch_Video::OnWorkStop(), OutdoorThermometer(), PlantBase(), ItemBase::PlantSeed(), MissionBase::PlayerDisconnected(), ComponentEnergyManager::RefreshDebug(), ItemBase::RegenerateNavmesh(), RegisterCooldowns(), UndergroundTriggerCarrier::RequestDelayedTriggerSpawn(), Land_Underground_EntranceBase::RequestLatentTransition(), FireworksLauncherClientEvent::RequestSecondaryExplosion(), ResetWaitingQueue(), AnimationTimer::Run(), ItemBase::RunTrappingTimer(), BiosUserManager::SelectUserEx(), SoftSkillManagerDebug(), ManBase::SpawnDrowningBubbles(), PluginBase::SpawnEntityInPlayerInventory(), StartActivate(), StartFire(), InventoryItem::StartItemSoundServer(), MissionBase::StartLogoutMenu(), ComponentEnergyManager::StartUpdates(), StopFire(), InventoryItem::StopItemSoundServer(), Synchronize(), TimerBase::Timer(), Entity::TryDelete(), UIScriptedMenu::Update(), ItemBase::UpdateNavmesh(), ItemBase::UpdatePhysics(), and ScriptedWidgetEventHandler::UpdateTotalTime().

m_duration

float m_duration

protected

Definition at line 223 of file tools.c.

Referenced by GetDuration(), GetRemaining(), OnInit(), OnStart(), TimerBase::OnUpdate(), and Tick().

m_loop

bool m_loop

protected

Definition at line 222 of file tools.c.

Referenced by OnInit(), OnStart(), AnimationTimer::Run(), AnimationTimer::Tick(), and Tick().

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.

Referenced by IsRunning(), OnInit(), and SetRunning().

m_RunTime

float m_RunTime

protected

Definition at line 226 of file tools.c.

Referenced by GetRunTime(), OnStart(), and Tick().

m_time

float m_time

protected

Definition at line 224 of file tools.c.

Referenced by TimerBase::FadeIn(), TimerBase::FadeOut(), GetRemaining(), GetTime(), OnInit(), OnStart(), TimerBase::OnUpdate(), AnimationTimer::Run(), Stop(), UniversalTemperatureSource::Stop(), AnimationTimer::Tick(), and Tick().

m_timerQueue

array<TimerBase> m_timerQueue

protected

Definition at line 225 of file tools.c.

Referenced by ~TimerBase(), OnInit(), OnTimerQueueDestoryed(), and SetRunning().