KitchenTimer Class Reference

Inheritance diagram for KitchenTimer:

Collaboration diagram for KitchenTimer:

Protected Member Functions
void	Disarm ()
void	OnRingingStopClient ()
override bool	OnStoreLoad (ParamsReadContext ctx, int version)
override void	OnStoreSave (ParamsWriteContext ctx)
override void	SetAlarmTimeServer (float time01)
void	SetAlarmTimeServerSecs (int inSecs)
override void	GetDebugActions (out TSelectableActionInfoArrayEx outputList)
override bool	OnAction (int action_id, Man player, ParamsReadContext ctx)
override string	GetDebugText ()

Private Member Functions
override void	Init ()
override void	SetActions ()
override string	GetExplosiveTriggerSlotName ()
override string	GetToggleSound ()
override string	GetRingingSound ()
string	GetRingingStopSound ()
override string	GetDestroyedSound ()
override string	GetHitSound ()
override string	GetWorkingSound ()
int	GetMinutesMax ()
int	Time01ToSeconds (float time01)
float	SecondsTo01 (int seconds)
override float	GetRingingDurationMax ()
override void	TurnOff ()
void	OnUpdate ()

Private Attributes
const string	RINGING_SOUND = "KitchenTimer_Ring_Loop_SoundSet"
const string	DESTROYED_SOUND = "AlarmClock_Destroyed_SoundSet"
const string	HIT_SOUND = "AlarmClock_Hit_SoundSet"
const string	WORKING_SOUND = "KitchenTimer_Ticking_Loop_SoundSet"
EffectSound	m_RingingStopSound
int	m_AlarmInSecs

Static Private Attributes
static ref NoiseParams	m_NoisePar
static NoiseSystem	m_NoiseSystem

Detailed Description

Definition at line 1 of file KitchenTimer.c.

Member Function Documentation

Disarm()

void KitchenTimer::Disarm ( )

inlineprotected

Definition at line 124 of file KitchenTimer.c.

  {
    super.Disarm();
    SetAlarmTimeServerSecs(0);
  }

References SetAlarmTimeServerSecs().

GetDebugActions()

override void KitchenTimer::GetDebugActions ( out TSelectableActionInfoArrayEx outputList )

inlineprotected

Definition at line 198 of file KitchenTimer.c.

  {
    outputList.Insert(new TSelectableActionInfoWithColor(SAT_DEBUG_ACTION, EActions.ALARM_SET_AHEAD, "Set Alarm Ahead", 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 KitchenTimer::GetDebugText ( )

inlineprotected

Definition at line 219 of file KitchenTimer.c.

  {
    string debug_output;
 
    if (GetGame().IsDedicatedServer())
    {
      debug_output = "alarm in: " + m_AlarmInSecs.ToString() + " secs" + "\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 GetGame(), GetRingingDurationMax(), m_AlarmInSecs, m_RingingDuration, m_State, and float::ToString().

GetDestroyedSound()

override string KitchenTimer::GetDestroyedSound ( )

inlineprivate

Definition at line 58 of file KitchenTimer.c.

  {
    return DESTROYED_SOUND;
  }

References DESTROYED_SOUND.

GetExplosiveTriggerSlotName()

override string KitchenTimer::GetExplosiveTriggerSlotName ( )

inlineprivate

Definition at line 38 of file KitchenTimer.c.

  {
    return "TriggerKitchenTimer";
  }

GetHitSound()

override string KitchenTimer::GetHitSound ( )

inlineprivate

Definition at line 63 of file KitchenTimer.c.

  {
    return HIT_SOUND;
  }

References HIT_SOUND.

GetMinutesMax()

int KitchenTimer::GetMinutesMax ( )

inlineprivate

Definition at line 73 of file KitchenTimer.c.

  {
    return 45;
  }

Referenced by SecondsTo01(), and Time01ToSeconds().

GetRingingDurationMax()

override float KitchenTimer::GetRingingDurationMax ( )

inlineprivate

Definition at line 89 of file KitchenTimer.c.

  {
    return 60;
  }

Referenced by GetDebugText(), and OnUpdate().

GetRingingSound()

override string KitchenTimer::GetRingingSound ( )

inlineprivate

Definition at line 48 of file KitchenTimer.c.

  {
    return RINGING_SOUND;
  }

References RINGING_SOUND.

GetRingingStopSound()

string KitchenTimer::GetRingingStopSound ( )

inlineprivate

Definition at line 53 of file KitchenTimer.c.

  {
    return "KitchenTimer_Ring_End_SoundSet";
  }

Referenced by OnRingingStopClient().

GetToggleSound()

override string KitchenTimer::GetToggleSound ( )

inlineprivate

Definition at line 43 of file KitchenTimer.c.

  {
    return "";
  }

GetWorkingSound()

override string KitchenTimer::GetWorkingSound ( )

inlineprivate

Definition at line 68 of file KitchenTimer.c.

  {
    return WORKING_SOUND;
  }

References WORKING_SOUND.

Init()

override void KitchenTimer::Init ( )

inlineprivate

Definition at line 14 of file KitchenTimer.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() + " NoiseKitchenTimer");
      }
    }
  }

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

OnAction()

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

inlineprotected

Definition at line 206 of file KitchenTimer.c.

  {
    if (super.OnAction(action_id, player, ctx))
      return true;
 
    if (GetGame().IsServer() || !GetGame().IsMultiplayer())
    {
      if (action_id == EActions.ALARM_SET_AHEAD)
        SetAlarmTimeServerSecs(20);
    }
    return false;
  }

References GetGame(), and SetAlarmTimeServerSecs().

OnRingingStopClient()

void KitchenTimer::OnRingingStopClient ( )

inlineprotected

Definition at line 130 of file KitchenTimer.c.

  {
    if (m_RingingSoundLoop)
      PlaySoundSet(m_RingingStopSound, GetRingingStopSound(), 0, 0);
 
    super.OnRingingStopClient();
 
  }

References GetRingingStopSound(), m_RingingSoundLoop, and m_RingingStopSound.

OnStoreLoad()

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

inlineprotected

Definition at line 139 of file KitchenTimer.c.

  {
    if (!super.OnStoreLoad(ctx, version))
      return false;
 
    if (version < 128)
      return true;
 
    EAlarmClockState state;
 
    if (!ctx.Read(state))
      return false;
 
    int time;
    if (!ctx.Read(time))
      return false;
 
    SetState(state);
 
    if (state == EAlarmClockState.SET)
      SetAlarmTimeServerSecs(time);
    else if (state == EAlarmClockState.RINGING)
      MakeRingingStart();
 
    return true;
  }

References MakeRingingStart(), SetAlarmTimeServerSecs(), and SetState().

OnStoreSave()

override void KitchenTimer::OnStoreSave ( ParamsWriteContext ctx )

inlineprotected

Definition at line 166 of file KitchenTimer.c.

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

References m_AlarmInSecs, and m_State.

OnUpdate()

void KitchenTimer::OnUpdate ( )

inlineprivate

Definition at line 100 of file KitchenTimer.c.

  {
    if (m_AlarmInSecs > 0)
    {
      m_AlarmInSecs -= UPDATE_TICK_RATE;
      float time01 = SecondsTo01(m_AlarmInSecs);
      SetAnimationPhaseNow("ClockAlarm", time01);
      if (IsRinging())
        MakeRingingStop();
    }
    else if (!IsRinging())
      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 GetPosition, GetRingingDurationMax(), IsRinging(), m_AlarmInSecs, m_NoisePar, m_NoiseSystem, m_RingingDuration, MakeRingingStart(), MakeRingingStop(), SecondsTo01(), TurnOff(), and UPDATE_TICK_RATE.

SecondsTo01()

float KitchenTimer::SecondsTo01 ( int seconds )

inlineprivate

Definition at line 84 of file KitchenTimer.c.

  {
    return Math.InverseLerp(0, GetMinutesMax() * 60, seconds);
  }

References GetMinutesMax(), and Math::InverseLerp().

Referenced by OnUpdate(), and SetAlarmTimeServerSecs().

SetActions()

override void KitchenTimer::SetActions ( )

inlineprivate

Definition at line 30 of file KitchenTimer.c.

  {
    super.SetActions();
 
    AddAction(ActionSetKitchenTimer);
    AddAction(ActionResetKitchenTimer);
  }

References ActionResetKitchenTimer(), and AddAction().

SetAlarmTimeServer()

override void KitchenTimer::SetAlarmTimeServer ( float time01 )

inlineprotected

Definition at line 179 of file KitchenTimer.c.

  {
    SetAnimationPhaseNow("ClockAlarm", time01);
    m_AlarmInSecs = Time01ToSeconds(time01);
 
    if (m_AlarmInSecs > 0)
      TurnOn();
  }

References m_AlarmInSecs, Time01ToSeconds(), and TurnOn().

Referenced by SetAlarmTimeServerSecs().

SetAlarmTimeServerSecs()

void KitchenTimer::SetAlarmTimeServerSecs ( int inSecs )

inlineprotected

Definition at line 188 of file KitchenTimer.c.

  {
    SetAlarmTimeServer(SecondsTo01(inSecs));
  }

References SecondsTo01(), and SetAlarmTimeServer().

Referenced by Disarm(), OnAction(), and OnStoreLoad().

Time01ToSeconds()

int KitchenTimer::Time01ToSeconds ( float time01 )

inlineprivate

Definition at line 78 of file KitchenTimer.c.

  {
    return Math.Lerp(0, GetMinutesMax() * 60, time01);
  }

References GetMinutesMax(), and Math::Lerp().

Referenced by SetAlarmTimeServer().

TurnOff()

override void KitchenTimer::TurnOff ( )

inlineprivate

Definition at line 94 of file KitchenTimer.c.

  {
    super.TurnOff();
    SEffectManager.DestroyEffect(m_WorkingSound);
  }

References SEffectManager::DestroyEffect(), and m_WorkingSound.

Referenced by OnUpdate().

Member Data Documentation

DESTROYED_SOUND

const string KitchenTimer::DESTROYED_SOUND = "AlarmClock_Destroyed_SoundSet"

private

Definition at line 4 of file KitchenTimer.c.

Referenced by GetDestroyedSound().

HIT_SOUND

const string KitchenTimer::HIT_SOUND = "AlarmClock_Hit_SoundSet"

private

Definition at line 5 of file KitchenTimer.c.

Referenced by GetHitSound().

m_AlarmInSecs

int KitchenTimer::m_AlarmInSecs

private

Definition at line 12 of file KitchenTimer.c.

Referenced by GetDebugText(), OnStoreSave(), OnUpdate(), and SetAlarmTimeServer().

m_NoisePar

ref NoiseParams KitchenTimer::m_NoisePar

staticprivate

Definition at line 9 of file KitchenTimer.c.

Referenced by Init(), and OnUpdate().

m_NoiseSystem

NoiseSystem KitchenTimer::m_NoiseSystem

staticprivate

Definition at line 10 of file KitchenTimer.c.

Referenced by Init(), and OnUpdate().

m_RingingStopSound

EffectSound KitchenTimer::m_RingingStopSound

private

Definition at line 8 of file KitchenTimer.c.

Referenced by OnRingingStopClient().

RINGING_SOUND

const string KitchenTimer::RINGING_SOUND = "KitchenTimer_Ring_Loop_SoundSet"

private

Definition at line 3 of file KitchenTimer.c.

Referenced by GetRingingSound().

WORKING_SOUND

const string KitchenTimer::WORKING_SOUND = "KitchenTimer_Ticking_Loop_SoundSet"

private

Definition at line 6 of file KitchenTimer.c.

Referenced by GetWorkingSound().

---

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

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