House Class Reference

Inheritance diagram for House:

Collaboration diagram for House:

Private Member Functions
override void	EEOnCECreate ()
void	RequestSoundEvent ()
string	GetSoundSet ()
override void	EEInit ()
override void	EEDelete (EntityAI parent)
void	House ()
void	ChristmasTree ()
override void	EEInit ()
override void	EEDelete (EntityAI parent)

Static Private Member Functions
static bool	Init ()

Private Attributes
Particle	m_ParticleEfx
XmasTreeLight	m_TreeLight
EffectSound	m_AmbientSoundLoop
const string	LOOP_SOUND = "ChristmasMusic_SoundSet"

Static Private Attributes
static bool	m_Init = Init()

Detailed Description

Definition at line 1 of file CrashBase.c.

Constructor & Destructor Documentation

House()

void House::House ( )

inlineprivate

Definition at line 3 of file Building.c.

  {
  }

Member Function Documentation

ChristmasTree()

void House::ChristmasTree ( )

inlineprivate

Definition at line 7 of file ChristmasTree.c.

  {
    if (!GetGame().IsDedicatedServer())
    {
      m_TreeLight = XmasTreeLight.Cast(ScriptedLightBase.CreateLight(XmasTreeLight, "0 0 0"));
      m_TreeLight.AttachOnMemoryPoint(this, "action");
    }
  }

References GetGame().

EEDelete() [1/2]

override void House::EEDelete ( EntityAI parent )

inlineprivate

Definition at line 44 of file CrashBase.c.

  {
    if (!GetGame().IsDedicatedServer())
    {
      if (m_ParticleEfx)
        m_ParticleEfx.Stop();
    }
  }

References GetGame(), and Particle::Stop().

EEDelete() [2/2]

override void House::EEDelete ( EntityAI parent )

inlineprivate

Definition at line 22 of file ChristmasTree.c.

  {
    if (!GetGame().IsDedicatedServer())
    {
      if (m_TreeLight)
        m_TreeLight.Destroy();
      if (m_AmbientSoundLoop)
        SEffectManager.DestroyEffect(m_AmbientSoundLoop);
    }
  }

References SEffectManager::DestroyEffect(), and GetGame().

EEInit() [1/2]

override void House::EEInit ( )

inlineprivate

Definition at line 31 of file CrashBase.c.

  {
    super.EEInit();
    //Setup for local sound tests
#ifdef DEVELOPER
    if (!GetGame().IsMultiplayer())
    {
      EffectSound eff = SEffectManager.PlaySound(GetSoundSet(), GetPosition(), 0.1, 0.1);
      eff.SetAutodestroy(true);
    }
#endif
  }

References GetGame(), GetPosition, CrashBase::GetSoundSet(), and SEffectManager::PlaySound().

EEInit() [2/2]

override void House::EEInit ( )

inlineprivate

Definition at line 16 of file ChristmasTree.c.

  {
    if (!GetGame().IsDedicatedServer())
      PlaySoundSetLoop(m_AmbientSoundLoop, LOOP_SOUND, 0, 0);
  }

References GetGame().

EEOnCECreate()

override void House::EEOnCECreate ( )

inlineprivate

Definition at line 13 of file CrashBase.c.

  {
    super.EEOnCECreate();
    RequestSoundEvent();
  }

GetSoundSet()

string House::GetSoundSet ( )

inlineprivate

Definition at line 26 of file CrashBase.c.

  {
    return "HeliCrash_Distant_SoundSet";
  }

Init()

static bool House::Init ( )

inlinestaticprivate

Definition at line 6 of file CrashBase.c.

  {
    CrashSoundSets.RegisterSoundSet("HeliCrash_Distant_SoundSet");
    CrashSoundSets.RegisterSoundSet("SledgeCrash_Distant_SoundSet");
    return true;
  }

References CrashSoundSets::RegisterSoundSet().

RequestSoundEvent()

void House::RequestSoundEvent ( )

inlineprivate

Definition at line 19 of file CrashBase.c.

  {
    Param3<bool, vector, int> playSound = new Param3<bool, vector, int>(true, GetPosition(), GetSoundSet().Hash());
    GetGame().RPCSingleParam(null, ERPCs.RPC_SOUND_HELICRASH, playSound, true);
  }

References GetGame(), GetPosition, and CrashBase::GetSoundSet().

Member Data Documentation

LOOP_SOUND

const string House::LOOP_SOUND = "ChristmasMusic_SoundSet"

private

Definition at line 5 of file ChristmasTree.c.

m_AmbientSoundLoop

EffectSound House::m_AmbientSoundLoop

private

Definition at line 4 of file ChristmasTree.c.

m_Init

bool House::m_Init = Init()

staticprivate

Definition at line 4 of file CrashBase.c.

m_ParticleEfx

Particle House::m_ParticleEfx

private

Definition at line 3 of file CrashBase.c.

m_TreeLight

XmasTreeLight House::m_TreeLight

private

Definition at line 3 of file ChristmasTree.c.

---

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

• scripts/4_World/Entities/Building/CrashBase.c
• scripts/4_World/Entities/WoodBase/ChristmasTree.c
• scripts/4_World/Entities/Game/Super/Building.c