AlarmClock_ColorBase Class Reference

Inheritance diagram for AlarmClock_ColorBase:

Collaboration diagram for AlarmClock_ColorBase:

Protected Member Functions
void	AnimateAlarmHand (float value)
override bool	OnStoreLoad (ParamsReadContext ctx, int version)
override void	OnStoreSave (ParamsWriteContext ctx)
override void	OnDebugSpawn ()

Private Member Functions
override void	Init ()
void	~AlarmClock_ColorBase ()
override void	SetActions ()
override string	GetToggleSound ()
override string	GetRingingSound ()
override string	GetDestroyedSound ()
override string	GetHitSound ()
override string	GetExplosiveTriggerSlotName ()
override void	GetDebugActions (out TSelectableActionInfoArrayEx outputList)
override bool	OnAction (int action_id, Man player, ParamsReadContext ctx)
override string	GetDebugText ()
void	OnUpdate ()

Private Attributes
const string	RINGING_SOUND = "AlarmClock_Ring_Loop_SoundSet"
const string	TURN_TOGGLE_SOUND = "AlarmClock_Turn_Off_SoundSet"
const string	DESTROYED_SOUND = "AlarmClock_Destroyed_SoundSet"
const string	HIT_SOUND = "AlarmClock_Hit_SoundSet"

Static Private Attributes
static ref NoiseParams	m_NoisePar
static NoiseSystem	m_NoiseSystem

Detailed Description

Definition at line 1 of file AlarmClock.c.

Constructor & Destructor Documentation

~AlarmClock_ColorBase()

void AlarmClock_ColorBase::~AlarmClock_ColorBase ( )

inlineprivate

Definition at line 27 of file AlarmClock.c.

  {
#ifndef SERVER
    OnRingingStopClient();
#endif
  }

References OnRingingStopClient().

Member Function Documentation

AnimateAlarmHand()

void AlarmClock_ColorBase::AnimateAlarmHand ( float value )

inlineprotected

Definition at line 135 of file AlarmClock.c.

  {
    SetAnimationPhaseNow("ClockAlarm", value);
  }

GetDebugActions()

override void AlarmClock_ColorBase::GetDebugActions ( out TSelectableActionInfoArrayEx outputList )

inlineprivate

Definition at line 69 of file AlarmClock.c.

  {
    outputList.Insert(new TSelectableActionInfoWithColor(SAT_DEBUG_ACTION, EActions.ACTIVATE_ENTITY, "SetAlarmAhead1Min", FadeColors.LIGHT_GREY));
    outputList.Insert(new TSelectableActionInfoWithColor(SAT_DEBUG_ACTION, EActions.SEPARATOR, "___________________________", FadeColors.LIGHT_GREY));
 
    super.GetDebugActions(outputList);
  }

References SAT_DEBUG_ACTION.

GetDebugText()

override string AlarmClock_ColorBase::GetDebugText ( )

inlineprivate

Definition at line 90 of file AlarmClock.c.

  {
    string debug_output;
 
    if (GetGame().IsDedicatedServer())
    {
      debug_output = "alarm in: " + GetAlarmInMin().ToString() + " mins" + "\n";
      debug_output += "current state: " + typename.EnumToString(EAlarmClockState, m_State) + "\n";;
      debug_output += "ringing for " + m_RingingDuration.ToString() + " secs" + "\n";
      debug_output += "ringing max " + GetRingingDurationMax().ToString() + " secs" + "\n";
    }
    else
      debug_output = "this is client";
    return debug_output;
  }

References GetAlarmInMin(), GetGame(), GetRingingDurationMax(), m_RingingDuration, m_State, and float::ToString().

GetDestroyedSound()

override string AlarmClock_ColorBase::GetDestroyedSound ( )

inlineprivate

Definition at line 54 of file AlarmClock.c.

  {
    return DESTROYED_SOUND;
  }

References DESTROYED_SOUND.

GetExplosiveTriggerSlotName()

override string AlarmClock_ColorBase::GetExplosiveTriggerSlotName ( )

inlineprivate

Definition at line 64 of file AlarmClock.c.

  {
    return "TriggerAlarmClock";
  }

GetHitSound()

override string AlarmClock_ColorBase::GetHitSound ( )

inlineprivate

Definition at line 59 of file AlarmClock.c.

  {
    return HIT_SOUND;
  }

References HIT_SOUND.

GetRingingSound()

override string AlarmClock_ColorBase::GetRingingSound ( )

inlineprivate

Definition at line 49 of file AlarmClock.c.

  {
    return RINGING_SOUND;
  }

References RINGING_SOUND.

GetToggleSound()

override string AlarmClock_ColorBase::GetToggleSound ( )

inlineprivate

Definition at line 44 of file AlarmClock.c.

  {
    return TURN_TOGGLE_SOUND;
  }

References TURN_TOGGLE_SOUND.

Init()

override void AlarmClock_ColorBase::Init ( )

inlineprivate

Definition at line 12 of file AlarmClock.c.

  {
    super.Init();
    if (GetGame().IsServer())
    {
      m_NoiseSystem = GetGame().GetNoiseSystem();
      if (m_NoiseSystem && !m_NoisePar)
      {
        // Create and load noise parameters
        m_NoisePar = new NoiseParams;
        m_NoisePar.LoadFromPath("cfgVehicles " + GetType() + " NoiseAlarmClock");
      }
    }
  }

References GetGame(), GetType(), m_NoisePar, m_NoiseSystem, and NoiseParams().

OnAction()

override bool AlarmClock_ColorBase::OnAction ( int action_id, Man player, ParamsReadContext ctx )

inlineprivate

Definition at line 77 of file AlarmClock.c.

  {
    if (super.OnAction(action_id, player, ctx))
      return true;
    if (GetGame().IsServer() || !GetGame().IsMultiplayer())
    {
      if (action_id == EActions.ACTIVATE_ENTITY)
        SetAlarmInXMins(1);
 
    }
    return false;
  }

References GetGame(), and SetAlarmInXMins().

OnDebugSpawn()

override void AlarmClock_ColorBase::OnDebugSpawn ( )

inlineprotected

Definition at line 177 of file AlarmClock.c.

  {
    TurnOn();
    MakeRingingStart();
  }

References MakeRingingStart(), and TurnOn().

OnStoreLoad()

override bool AlarmClock_ColorBase::OnStoreLoad ( ParamsReadContext ctx, int version )

inlineprotected

Definition at line 141 of file AlarmClock.c.

  {
    if (!super.OnStoreLoad(ctx, version))
      return false;
 
    if (version < 126)
      return true;
 
    EAlarmClockState state;
 
    if (!ctx.Read(state))
      return false;
 
    float time;
 
    if (!ctx.Read(time))
      return false;
 
    SetAlarmTimeServer(time);
    SetState(state);
    if (state == EAlarmClockState.SET)
      TurnOn();
    else if (state == EAlarmClockState.RINGING)
      MakeRingingStart();
 
    return true;
  }

References MakeRingingStart(), SetAlarmTimeServer(), SetState(), and TurnOn().

OnStoreSave()

override void AlarmClock_ColorBase::OnStoreSave ( ParamsWriteContext ctx )

inlineprotected

Definition at line 169 of file AlarmClock.c.

  {
    super.OnStoreSave(ctx);
 
    ctx.Write(m_State);
    ctx.Write(m_AlarmTime01);
  }

References m_AlarmTime01, and m_State.

OnUpdate()

void AlarmClock_ColorBase::OnUpdate ( )

inlineprivate

Definition at line 106 of file AlarmClock.c.

  {
    if (IsAlarmOn())
    {
      //due to variable server time flow(day-night time accel), it's not possible to simply set a timer for X secs without some convoluted math/code, so we need to check at regular intervals
      int alarm_hand_in_minutes = ConvertAlarmHand01ToMins12h(m_AlarmTime01);
 
      int pass, hour, minute;
      GetGame().GetWorld().GetDate(pass, pass, pass, hour, minute);
 
      int curr_time_in_minutes = ConvertTimeToMins12h(hour, minute);
 
      //Print(GetAlarmInMin());
 
      if (alarm_hand_in_minutes == curr_time_in_minutes)
        MakeRingingStart();
    }
 
    if (IsRinging())
    {
      m_RingingDuration += UPDATE_TICK_RATE;
 
      if (m_RingingDuration >= GetRingingDurationMax())
        TurnOff();
      else if (m_NoiseSystem)
        m_NoiseSystem.AddNoiseTarget(GetPosition(), UPDATE_TICK_RATE, m_NoisePar);
    }
  }

References ConvertAlarmHand01ToMins12h(), ConvertTimeToMins12h(), GetGame(), GetPosition, GetRingingDurationMax(), IsAlarmOn(), IsRinging(), m_AlarmTime01, m_NoisePar, m_NoiseSystem, m_RingingDuration, MakeRingingStart(), TurnOff(), and UPDATE_TICK_RATE.

SetActions()

override void AlarmClock_ColorBase::SetActions ( )

inlineprivate

Definition at line 35 of file AlarmClock.c.

  {
    super.SetActions();
 
    AddAction(ActionSetAlarmClock);
    AddAction(ActionTurnOnAlarmClock);
    AddAction(ActionTurnOffAlarmClock);
  }

References ActionTurnOffAlarmClock(), ActionTurnOnAlarmClock(), and AddAction().

Member Data Documentation

DESTROYED_SOUND

const string AlarmClock_ColorBase::DESTROYED_SOUND = "AlarmClock_Destroyed_SoundSet"

private

Definition at line 5 of file AlarmClock.c.

Referenced by GetDestroyedSound().

HIT_SOUND

const string AlarmClock_ColorBase::HIT_SOUND = "AlarmClock_Hit_SoundSet"

private

Definition at line 6 of file AlarmClock.c.

Referenced by GetHitSound().

m_NoisePar

ref NoiseParams AlarmClock_ColorBase::m_NoisePar

staticprivate

Definition at line 9 of file AlarmClock.c.

Referenced by Init(), and OnUpdate().

m_NoiseSystem

NoiseSystem AlarmClock_ColorBase::m_NoiseSystem

staticprivate

Definition at line 10 of file AlarmClock.c.

Referenced by Init(), and OnUpdate().

RINGING_SOUND

const string AlarmClock_ColorBase::RINGING_SOUND = "AlarmClock_Ring_Loop_SoundSet"

private

Definition at line 3 of file AlarmClock.c.

Referenced by GetRingingSound().

TURN_TOGGLE_SOUND

const string AlarmClock_ColorBase::TURN_TOGGLE_SOUND = "AlarmClock_Turn_Off_SoundSet"

private

Definition at line 4 of file AlarmClock.c.

Referenced by GetToggleSound().

---

The documentation for this class was generated from the following file:

• scripts/4_World/Entities/ItemBase/Gear/Tools/AlarmClock.c