Tools

Classes
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.
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 ()
void	Tick (float timeslice)
	System function, don't call.
void	OnTimerQueueDestoryed ()
	System function, don't call.
float	GetTime ()
float	GetDuration ()
float	GetRemaining ()
float	GetRunTime ()
void	OnInit (int category)
void	OnStart (float duration, bool loop)
void	OnUpdate ()
void	OnTimer ()
	DEPRECATED.
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.
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!
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 DragQueue extends CallQueue	m_running
	TimerBase Class provide just interface for all Timer classes. Don't instance this class, use Timer class instead.
bool	m_loop
float	m_duration
float	m_time
array< TimerBase >	m_timerQueue
float	m_RunTime

Detailed Description

\desc Helpful functions & classes

\desc Helpful functions & classes

Typedef Documentation

TStringMap

typedef map<string, string> TStringMap

protected

Definition at line 927 of file tools.c.

Function Documentation

Continue()

void Continue ( )

protected

Timer continue when it was paused.

Definition at line 235 of file tools.c.

  {
    SetRunning(true);
  }

References SetRunning().

Referenced by UIScriptedMenu::OnClick(), and UIScriptedMenu::OnClick_Continue().

GetDuration()

float GetDuration ( )

protected

Definition at line 297 of file tools.c.

  {
    return m_duration;
  }

References m_duration.

Referenced by SymptomBase::OnGetActivatedServer().

GetNumberOfSetBits()

int GetNumberOfSetBits ( int i )

protected

Definition at line 982 of file tools.c.

{
  return Math.GetNumberOfSetBits(i);
}

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 958 of file tools.c.

{
  string value;
  if (GetGame().GetProfileString(name, value))
  {
    if (value == "true" || value == "1")
      return true;
    else
      return false;
  }
  else
    return def;
}

References GetGame(), and name.

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

GetRemaining()

float GetRemaining ( )

protected

Definition at line 302 of file tools.c.

  {
    return m_duration - m_time;
  }

References m_duration, and m_time.

GetRunTime()

float GetRunTime ( )

protected

Definition at line 307 of file tools.c.

  {
    return m_RunTime;
  }

References m_RunTime.

GetTemperatureColor()

int GetTemperatureColor ( int temperature )

protected

Definition at line 929 of file tools.c.

{
  int alpha = 255;
  int red = 153;
  int green = 153;
  int blue = 153;
  if (temperature < 20)
  {
    temperature = temperature - 20;
    temperature = Math.Clamp(temperature, -50, 50);
    temperature = Math.AbsInt(temperature);
 
    red = Math.Clamp(red - ((red / 50) * temperature), 0, 255);
    green = Math.Clamp(green - ((green / 50) * temperature), 0, 255);
    blue = Math.Clamp(blue + ((blue / 50) * temperature), 0, 255);
  }
  else if (temperature > 20)
  {
    temperature = Math.Clamp(temperature, -100, 100);
    blue = Math.Clamp(blue - ((blue / 100) * temperature), 0, 255);
    green = Math.Clamp(green - ((green / 100) * temperature), 0, 255);
    red = Math.Clamp(red + ((red / 100) * temperature), 0, 255);
  }
 
  int color = ARGB(alpha, red, green, blue);
  return color;
}

References Math::AbsInt(), ARGB(), and Math::Clamp().

Referenced by ColorManager::GetItemColor(), UIScriptedMenu::UpdateItemInfoQuantity(), and UIScriptedMenu::UpdateItemInfoTemperature().

GetTime()

float GetTime ( )

protected

Definition at line 292 of file tools.c.

  {
    return m_time;
  }

References m_time.

IsRunning()

bool IsRunning ( )

protected

Returns

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

Definition at line 252 of file tools.c.

  {
    return m_running;
  }

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(), OFSMBase< Class FSMStateBase, Class FSMEventBase, Class FSMActionBase, Class FSMGuardBase >::Terminate(), FSMBase< Class FSMStateBase, Class FSMEventBase, Class FSMActionBase, Class FSMGuardBase >::Terminate(), HFSMBase< 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(), OFSMBase< Class FSMStateBase, Class FSMEventBase, Class FSMActionBase, Class FSMGuardBase >::Update(), and Managed::Update().

OnInit()

void OnInit ( int category )

protected

Definition at line 312 of file tools.c.

  {
    m_duration = 1;
    m_loop = false;
    m_time = 0;
    m_running = false;
    if (GetGame())
      m_timerQueue = GetGame().GetTimerQueue(category);
    else
      ErrorEx("Attempting to Init a timer when the game does not exist (GetGame() == null)");
  }

References ErrorEx, GetGame(), m_duration, m_loop, m_running, m_time, and m_timerQueue.

OnStart()

void OnStart ( float duration, bool loop )

protected

Definition at line 324 of file tools.c.

  {
    m_RunTime = 0;
    m_duration = duration;
    m_loop = loop;
    m_time = 0;
    SetRunning(true);
  }

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 334 of file tools.c.

{}

OnTimerQueueDestoryed()

void OnTimerQueueDestoryed ( )

protected

System function, don't call.

Definition at line 287 of file tools.c.

  {
    m_timerQueue = NULL;
  }

References m_timerQueue.

OnUpdate()

void OnUpdate ( )

protected

Definition at line 333 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 227 of file tools.c.

  {
    SetRunning(false);
  }

References SetRunning().

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 973 of file tools.c.

{
  if (value)
    GetGame().SetProfileString(name, "1");
  else
    GetGame().SetProfileString(name, "0");
}

References GetGame(), and name.

SetRunning()

void SetRunning ( bool running )

protected

Definition at line 335 of file tools.c.

  {
    int index = -1;
 
    if (m_running == running) return;
 
    m_running = running;
    if (m_timerQueue == NULL) return;
 
    if (running)
    {
      if (m_timerQueue.Find(this) == -1)
        m_timerQueue.Insert(this);
    }
    else
    {
      index = m_timerQueue.Find(this);
      if (index != -1)
        m_timerQueue.Remove(index);
    }
  }

References m_running, and m_timerQueue.

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

Stop()

void Stop ( )

protected

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

Definition at line 243 of file tools.c.

  {
    SetRunning(false);
    m_time = 0;
  }

References m_time, and SetRunning().

Tick()

void Tick ( float timeslice )

protected

System function, don't call.

Definition at line 260 of file tools.c.

  {
    if (IsRunning())
    {
      m_RunTime += timeslice;
      m_time = m_time + timeslice;
 
      if (m_time >= m_duration)
      {
        if (m_loop)
          m_time = m_time - m_duration;
        else
        {
          SetRunning(false);
          m_time = 0;
        }
 
        OnTimer();
      }
      else
        OnUpdate();
    }
  }

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

~TimerBase()

void ~TimerBase ( )

protected

Definition at line 216 of file tools.c.

  {
    if (!m_timerQueue) return;
 
    SetRunning(false);
  }

References m_timerQueue, 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 Grenade_Base::ActivateRandomTime(), BaseBuildingBase::CheckFenceClosed(), BaseBuildingBase::CheckFenceOpened(), BaseBuildingBase::CloseFence(), CommitSuicide(), DayZIntroSceneXbox::CreateRandomCharacter(), CGame::DayZGame(), Destroy(), EEHitBy(), Weapon::EEInit(), ItemBase::EEInit(), EEInit(), ItemBase::EEOnAfterLoad(), ContaminatedArea_Dynamic::EEOnCECreate(), HandleEngineSound(), PluginManager::Init(), Hud::Init(), LogSuicide(), MissionBase::MissionServer(), MissionBase::OnClientDisconnectedEvent(), ActionDestroyCombinationLock::OnFinishProgressServer(), FireplaceBase::OnIgnitedThis(), PluginBase::OnInit(), OnItemLocationChanged(), InventoryItem::OnOverheatingDecay(), ItemBase::OnPartBuiltServer(), ItemBase::OnPartDestroyedServer(), ItemBase::OnPartDismantledServer(), OnPlacementComplete(), CGame::OnPostUpdate(), ManBase::OnRPC(), CGame::OnRPC(), CGame::OnUpdate(), ItemBase::OnVariablesSynchronized(), ItemBase::OnWorkStart(), BaseBuildingBase::OpenFence(), Play(), ItemBase::Refresh(), RefreshFireplaceVisuals(), ItemBase::SetActive(), UniversalTemperatureSourceDebug::SetDefferedActive(), Particle::SetWiggle(), ItemBase::SpawnCatch(), CrashBase::SpawnRandomDeerLater(), StartCooling(), StartHeating(), PoweredOptic_Base::StartPeriodicMeasurement(), Stop(), Synchronize(), UpdateVisuals(), MissionBase::~MissionServer(), and PluginManager::~PluginManager().

CALL_CATEGORY_GUI

const int CALL_CATEGORY_GUI = 1

Definition at line 9 of file tools.c.

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

CALL_CATEGORY_SYSTEM

const int CALL_CATEGORY_SYSTEM = 0

Definition at line 8 of file tools.c.

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

m_duration

float m_duration

protected

Definition at line 211 of file tools.c.

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

m_loop

bool m_loop

protected

Definition at line 210 of file tools.c.

Referenced by OnInit(), OnStart(), AnimationTimer::Run(), Tick(), and AnimationTimer::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 214 of file tools.c.

Referenced by HumanCommandActionCallback::CancelCondition(), GetRunTime(), HumanCommandActionCallback::Init(), OnStart(), and Tick().

m_time

float m_time

protected

Definition at line 212 of file tools.c.

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

m_timerQueue

array<TimerBase> m_timerQueue

protected

Definition at line 213 of file tools.c.

Referenced by CGame::DayZGame(), CGame::GetTimerQueue(), OnInit(), OnTimerQueueDestoryed(), SetRunning(), and ~TimerBase().