ItemTransmitter Class Reference

Collaboration diagram for ItemTransmitter:

Protected Member Functions
override void	OnStoreSave (ParamsWriteContext ctx)
override bool	OnStoreLoad (ParamsReadContext ctx, int version)
override bool	IsTransmitter ()
void	SetNextFrequency (PlayerBase player=NULL)
override void	OnSwitchOn ()
override void	OnWorkStart ()
override void	OnWorkStop ()
void	SoundTurnedOnNoiseStart ()
void	SoundTurnedOnNoiseStop ()
override void	SetActions ()

Protected Attributes
EffectSound	m_SoundLoop

Private Attributes
string	SOUND_RADIO_TURNED_ON = ""

Detailed Description

Definition at line 2 of file TransmitterBase.c.

Member Function Documentation

IsTransmitter()

override bool ItemTransmitter::IsTransmitter ( )

inlineprotected

Definition at line 37 of file TransmitterBase.c.

  {
    return true;
  }

OnStoreLoad()

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

inlineprotected

Definition at line 18 of file TransmitterBase.c.

  {
    if (!super.OnStoreLoad(ctx, version))
      return false;
 
    //--- Transmitter data ---
    //load and set tuned frequency
    int tuned_frequency_idx;
    if (!ctx.Read(tuned_frequency_idx))
    {
      SetFrequencyByIndex(0); //set default
      return false;
    }
    SetFrequencyByIndex(tuned_frequency_idx);
    //---
 
    return true;
  }

OnStoreSave()

override void ItemTransmitter::OnStoreSave ( ParamsWriteContext ctx )

inlineprotected

Definition at line 10 of file TransmitterBase.c.

  {
    super.OnStoreSave(ctx);
 
    //store tuned frequency
    ctx.Write(GetTunedFrequencyIndex());
  }

OnSwitchOn()

override void ItemTransmitter::OnSwitchOn ( )

inlineprotected

Definition at line 84 of file TransmitterBase.c.

  {
    if (!GetCompEM().CanWork())
      GetCompEM().SwitchOff();
  }

OnWorkStart()

override void ItemTransmitter::OnWorkStart ( )

inlineprotected

Definition at line 90 of file TransmitterBase.c.

  {
    //turn on broadcasting/receiving
    EnableBroadcast(true);
    EnableReceive(true);
    SwitchOn(true);
 
    //play sound
    SoundTurnedOnNoiseStart();
  }

OnWorkStop()

override void ItemTransmitter::OnWorkStop ( )

inlineprotected

Definition at line 101 of file TransmitterBase.c.

  {
    //auto switch off (EM)
    GetCompEM().SwitchOff();
 
    //turn off broadcasting/receiving
    EnableBroadcast(false);
    EnableReceive(false);
    SwitchOn(false);
 
    //stop sound
    SoundTurnedOnNoiseStop();
  }

SetActions()

override void ItemTransmitter::SetActions ( )

inlineprotected

Definition at line 129 of file TransmitterBase.c.

  {
    super.SetActions();
 
    AddAction(ActionTurnOnTransmitter);
    AddAction(ActionTurnOffTransmitter);
    AddAction(ActionTuneFrequency);
  }

References ActionTuneFrequency(), ActionTurnOffTransmitter(), ActionTurnOnTransmitter(), and AddAction().

SetNextFrequency()

void ItemTransmitter::SetNextFrequency ( PlayerBase player = NULL )

inlineprotected

Definition at line 43 of file TransmitterBase.c.

  {
    SetNextChannel();
 
    /*
      if ( player )
      {
      DisplayRadioInfo( GetTunedFrequency().ToString(), player );
      }
    */
  }

SoundTurnedOnNoiseStart()

void ItemTransmitter::SoundTurnedOnNoiseStart ( )

inlineprotected

Definition at line 119 of file TransmitterBase.c.

  {
    PlaySoundSetLoop(m_SoundLoop, SOUND_RADIO_TURNED_ON, 1.0, 1.0);
  }

SoundTurnedOnNoiseStop()

void ItemTransmitter::SoundTurnedOnNoiseStop ( )

inlineprotected

Definition at line 124 of file TransmitterBase.c.

  {
    StopSoundSet(m_SoundLoop);
  }

Member Data Documentation

m_SoundLoop

EffectSound ItemTransmitter::m_SoundLoop

protected

Definition at line 7 of file TransmitterBase.c.

SOUND_RADIO_TURNED_ON

string ItemTransmitter::SOUND_RADIO_TURNED_ON = ""

private

Definition at line 5 of file TransmitterBase.c.

---

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

• scripts/4_World/Entities/ItemBase/TransmitterBase.c