Tools

Структуры данных
class	Param
	Base Param Class with no parameters. Used as general purpose parameter overloaded with Param1 to Param4 templates. Подробнее...
class	Param7< Class T1, Class T2, Class T3, Class T4, Class T5, Class T6, Class T7 >
	Param Class Template with seven parameters. Подробнее...
class	Param8< Class T1, Class T2, Class T3, Class T4, Class T5, Class T6, Class T7, Class T8 >
	Param Class Template with eight parameters. Подробнее...
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. Подробнее...
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. Подробнее...
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: Подробнее...
class	CallQueue
	DragQueue Class provide callbacks while mouse is dragging. Callback function must have exact arguments: Подробнее...
class	array< TimerBase >
	TimerQueue Class using for system purpose only. Подробнее...
class	TimerBase
	Simple class for fading Widgets. Подробнее...
class	AnimationTimer
	AnimationTimer class. This timer is for animating float value. usage: Подробнее...
class	AnimatorTimer
class	multiMap< Class K, Class V >
	Associative array template, with multiple values per key usage: Подробнее...

Определения типов
typedef map< string, string >	TStringMap

Функции
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)

Переменные
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

Подробное описание

\desc Helpful functions & classes

\desc Helpful functions & classes

Типы

TStringMap

typedef map<string, string> TStringMap

protected

Функции

Continue()

void Continue ( )

protected

Timer continue when it was paused.

    {
        SetRunning(true);
    }

Перекрестные ссылки SetRunning().

Используется в UIScriptedMenu::OnClick() и UIScriptedMenu::OnClick_Continue().

GetDuration()

float GetDuration ( )

protected

    {
        return m_duration;
    }

Перекрестные ссылки m_duration.

GetNumberOfSetBits()

int GetNumberOfSetBits ( int i )

protected

{
    return Math.GetNumberOfSetBits(i);
}

Перекрестные ссылки 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.

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

Перекрестные ссылки GetGame() и name.

Используется в DayZProfilesOptions::RegisterProfileOption() и DayZProfilesOptions::ResetOptionsBool().

GetRemaining()

float GetRemaining ( )

protected

    {
        return m_duration - m_time;
    }

Перекрестные ссылки m_duration и m_time.

GetRunTime()

float GetRunTime ( )

protected

    {
        return m_RunTime;
    }

Перекрестные ссылки m_RunTime.

GetTemperatureColor()

int GetTemperatureColor ( int temperature )

protected

{
    int alpha   = 255;
    int red     = 153;
    int green   = 153;
    int blue    = 153;
    
    if (temperature < GameConstants.ITEM_TEMPERATURE_NEUTRAL_ZONE_LOWER_LIMIT)
    {
        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 > GameConstants.ITEM_TEMPERATURE_NEUTRAL_ZONE_UPPER_LIMIT)
    {
        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);
    }
 
    return ARGB(alpha, red, green, blue);
}

Перекрестные ссылки Math::AbsInt(), ARGB(), Math::Clamp(), GameConstants::ITEM_TEMPERATURE_NEUTRAL_ZONE_LOWER_LIMIT и GameConstants::ITEM_TEMPERATURE_NEUTRAL_ZONE_UPPER_LIMIT.

Используется в UIScriptedMenu::UpdateItemInfoQuantity().

GetTime()

float GetTime ( )

protected

    {
        return m_time;
    }

Перекрестные ссылки m_time.

IsRunning()

bool IsRunning ( )

protected

Возвращает

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

    {
        return m_running;
    }

Перекрестные ссылки m_running.

Используется в 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() и Managed::Update().

OnInit()

void OnInit ( int category )

protected

    {
        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)");
    }

Перекрестные ссылки ErrorEx, GetGame(), m_duration, m_loop, m_running, m_time и m_timerQueue.

OnStart()

void OnStart ( float duration, bool loop )

protected

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

Перекрестные ссылки m_duration, m_loop, m_RunTime, m_time и SetRunning().

Используется в TimerBase::FadeIn() и TimerBase::FadeOut().

OnTimer()

void OnTimer ( )

protected

DEPRECATED.

{}

OnTimerQueueDestoryed()

void OnTimerQueueDestoryed ( )

protected

System function, don't call.

    {
        m_timerQueue = NULL;
    }

Перекрестные ссылки m_timerQueue.

OnUpdate()

void OnUpdate ( )

protected

{}

Pause()

void Pause ( )

protected

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

    {
        SetRunning(false);
    }

Перекрестные ссылки 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!

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

Перекрестные ссылки GetGame() и name.

SetRunning()

void SetRunning ( bool running )

protected

    {
        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);
            }
        }
    }

Перекрестные ссылки m_running и m_timerQueue.

Используется в Continue(), OnStart(), Pause(), AnimationTimer::Run(), UniversalTemperatureSource::Stop(), Stop(), Tick(), AnimationTimer::~AnimationTimer() и ~TimerBase().

Stop()

void Stop ( )

protected

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

    {
        SetRunning(false);
        m_time = 0;
    }

Перекрестные ссылки m_time и SetRunning().

Tick()

void Tick ( float timeslice )

protected

System function, don't call.

    {
        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();
            }
        }
    }

Перекрестные ссылки IsRunning(), m_duration, m_loop, m_RunTime, m_time, TimerBase::OnTimer(), TimerBase::OnUpdate() и SetRunning().

~TimerBase()

void ~TimerBase ( )

protected

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

Перекрестные ссылки m_timerQueue и SetRunning().

Переменные

CALL_CATEGORY_COUNT

const int CALL_CATEGORY_COUNT = 3

Используется в CGame::DayZGame().

CALL_CATEGORY_GAMEPLAY

const int CALL_CATEGORY_GAMEPLAY = 2

Используется в 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(), MissionBase::MissionServer(), MissionBase::OnClientDisconnectedEvent(), OnEndServer(), ActionDestroyCombinationLock::OnFinishProgressServer(), FireplaceBase::OnIgnitedThis(), PluginBase::OnInit(), OnItemLocationChanged(), InventoryItem::OnOverheatingDecay(), ItemBase::OnPartBuiltServer(), ItemBase::OnPartDestroyedServer(), ItemBase::OnPartDismantledServer(), OnPlacementComplete(), CGame::OnPostUpdate(), ManBase::OnRPC(), CGame::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(), UpdateVisuals(), MissionBase::~MissionServer() и PluginManager::~PluginManager().

CALL_CATEGORY_GUI

const int CALL_CATEGORY_GUI = 1

Используется в 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() и RadialProgressBar::~RadialProgressBar().

CALL_CATEGORY_SYSTEM

const int CALL_CATEGORY_SYSTEM = 0

Используется в Ammo_40mm_Smoke_ColorBase::Activate(), AreaDamageBase::AreaDamageBase(), ItemBase::BarbedWire(), ItemBase::BatteryCharger(), UIScriptedMenu::Cancel(), CGame::CancelLoginTimeCountdown(), Entity::CheckForDestroy(), ItemBase::CheckRainStart(), ItemBase::CheckWater(), BoatScript::ClearWaterEffects(), UIManager::CloseWindow(), ScriptConsoleEnfScriptTab::ColorRunButton(), CreateTrigger(), IEntity::DecreaseHealth(), IEntity::Delete(), EntityLightSource::DeleteLightWithDelay(), Entity::DeleteOnClient(), DeleteThis(), DetermineTrackByCategory(), DynamicArea_Flare::DynamicArea_Flare(), DynamicMusicPlayer(), 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(), InitZoneServer(), 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(), 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(), 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(), ResetWaitingQueue(), ItemBase::RunTrappingTimer(), 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() и UIPopupScript::~UIPopupScriptSceneSettings().

m_duration

float m_duration

protected

Используется в GetDuration(), GetRemaining(), OnInit(), OnStart(), TimerBase::OnUpdate() и Tick().

m_loop

bool m_loop

protected

Используется в OnInit(), OnStart(), AnimationTimer::Run(), Tick() и 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.

Используется в IsRunning(), OnInit() и SetRunning().

m_RunTime

float m_RunTime

protected

Используется в HumanCommandActionCallback::CancelCondition(), GetRunTime(), HumanCommandActionCallback::Init(), OnStart() и Tick().

m_time

float m_time

protected

Используется в TimerBase::FadeIn(), TimerBase::FadeOut(), GetRemaining(), GetTime(), OnInit(), OnStart(), TimerBase::OnUpdate(), AnimationTimer::Run(), UniversalTemperatureSource::Stop(), Stop(), Tick() и AnimationTimer::Tick().

m_timerQueue

array<TimerBase> m_timerQueue

protected

Используется в CGame::DayZGame(), CGame::GetTimerQueue(), OnInit(), OnTimerQueueDestoryed(), SetRunning() и ~TimerBase().