BarbedWireTrigger Class Reference

DEPRECATED UNUSED prototype for damage by BarbedWire, do not use as example. More...

Inheritance diagram for BarbedWireTrigger:

Collaboration diagram for BarbedWireTrigger:

Private Member Functions
override void	OnEnter (Object obj)
void	SetParentObject (ItemBase wire)
void	SoundElectricShock ()
void	SoundCollision ()
Private Member Functions inherited from Trigger
override void	OnEnter (Object obj)
override void	OnLeave (Object obj)
void	UpdateInsiders (int timeout)
void	SetParentObject (Hologram projection)
void	SetParentOwner (PlayerBase player)
void	OnEnterBeginEvent (TriggerInsider insider)
void	OnLeaveBeginEvent (TriggerInsider insider)
void	OnEnter (Object obj)
void	OnLeave (Object obj)
bool	CanAddObjectAsInsider (Object object)
	Condition whether an Object can be added as TriggerInsider (checked before calling AddInsider)
bool	ShouldRemoveInsider (TriggerInsider insider)
	Condition whether a TriggerInsider should still be updated or not (checked in update loop and before adding)
bool	ShouldRemoveInsiderNoLeave (TriggerInsider insider)
	Condition whether a TriggerInsider should still be updated or not, skips OnLeaveEvent (checked in update loop and before adding)
TriggerInsider	CreateInsider (Object obj)
	Used for easily overriding TriggerInsider creation without rewriting AddInsider.
void	AddInsider (Object obj)
	Adding of new TriggerInsider.
void	RemoveInsider (TriggerInsider insider, int index=-1)
	Removing of TriggerInsider.
void	RemoveInsiderByObject (Object object)
	Removing of TriggerInsider through Object.
void	UpdateInsiders (int timeout)
	Update the current TriggerInsider inside the Trigger, timeout paramter is deprecated.
override void	OnRPC (PlayerIdentity sender, int rpc_type, ParamsReadContext ctx)

Private Attributes
ItemBase	m_ParentBarbedWire
Private Attributes inherited from Trigger
int	m_TriggerUpdateMs
Hologram	m_ParentObj
PlayerBase	m_Player

Static Private Attributes
static const int	SOUNDS_COLLISION_COUNT = 4
static const int	SOUNDS_SHOCK_COUNT = 4
static const string	m_SoundsCollision [SOUNDS_COLLISION_COUNT] = {"barbedFenceCollision1", "barbedFenceCollision2", "barbedFenceCollision3", "barbedFenceCollision4"}
static const string	m_SoundsShock [SOUNDS_SHOCK_COUNT] = {"electricFenceShock1", "electricFenceShock2", "electricFenceShock3", "electricFenceShock4"}

Detailed Description

DEPRECATED UNUSED prototype for damage by BarbedWire, do not use as example.

Definition at line 2 of file BarbedWireTrigger.c.

Member Function Documentation

OnEnter()

override void BarbedWireTrigger::OnEnter ( Object obj )

inlineprivate

Definition at line 11 of file BarbedWireTrigger.c.

  {
    if (g_Game.IsServer())
    {
      if (m_ParentBarbedWire)
      {
        if (obj.IsInherited(PlayerBase))
        {
          // When a player touches the barbed wire
          string cfg = "CfgVehicles BarbedWire barbedWireShockEnergyConsumption";
          float needed_energy = GetGame().ConfigGetFloat(cfg);
          bool energy_consumed = m_ParentBarbedWire.GetCompEM().ConsumeEnergy(needed_energy);
          PlayerBase player = PlayerBase.Cast(obj);
 
          if (energy_consumed)
          {
            // TO DO:
            // -Do electrical damage.
            // -Cause bleeding?
            // -Do some damage!
 
            player.MessageImportant("*SCRATCH and ELECTROCUTION*");
 
            // Play sound
            SoundCollision();
            SoundElectricShock();
          }
          else
          {
            // TO DO:
            // -Cause bleeding?
            // -Do some damage!
 
            player.MessageImportant("*SCRATCH*");
 
            // Play sound
            SoundCollision();
          }
        }
        else
        {
          // When an AI Agent touches the barbed wire
          if (obj.IsInherited(ManBase))
          {
            ManBase AI_unit = ManBase.Cast(obj);
            AI_unit.SetHealth("", "", 0);
          }
        }
      }
    }
  }

References g_Game, GetGame(), m_ParentBarbedWire, SoundCollision(), and SoundElectricShock().

SetParentObject()

void BarbedWireTrigger::SetParentObject ( ItemBase wire )

inlineprivate

Definition at line 64 of file BarbedWireTrigger.c.

  {
    if (g_Game.IsServer())
      m_ParentBarbedWire = wire;
  }

References g_Game, and m_ParentBarbedWire.

SoundCollision()

void BarbedWireTrigger::SoundCollision ( )

inlineprivate

Definition at line 79 of file BarbedWireTrigger.c.

  {
    int random_index = Math.RandomInt(0, SOUNDS_COLLISION_COUNT);
    string sound_type = m_SoundsCollision[random_index];
    PlaySound(sound_type, 50);
  }

References m_SoundsCollision, PlaySound(), Math::RandomInt(), and SOUNDS_COLLISION_COUNT.

Referenced by OnEnter().

SoundElectricShock()

void BarbedWireTrigger::SoundElectricShock ( )

inlineprivate

Definition at line 71 of file BarbedWireTrigger.c.

  {
    int random_index = Math.RandomInt(0, SOUNDS_SHOCK_COUNT);
    string sound_type = m_SoundsShock[random_index];
    PlaySound(sound_type, 50);
  }

References m_SoundsShock, PlaySound(), Math::RandomInt(), and SOUNDS_SHOCK_COUNT.

Referenced by OnEnter().

Member Data Documentation

m_ParentBarbedWire

ItemBase BarbedWireTrigger::m_ParentBarbedWire

private

Definition at line 4 of file BarbedWireTrigger.c.

Referenced by OnEnter(), and SetParentObject().

m_SoundsCollision

const string BarbedWireTrigger::m_SoundsCollision[SOUNDS_COLLISION_COUNT] = {"barbedFenceCollision1", "barbedFenceCollision2", "barbedFenceCollision3", "barbedFenceCollision4"}

staticprivate

Definition at line 7 of file BarbedWireTrigger.c.

{"barbedFenceCollision1", "barbedFenceCollision2", "barbedFenceCollision3", "barbedFenceCollision4"};

Referenced by SoundCollision().

m_SoundsShock

const string BarbedWireTrigger::m_SoundsShock[SOUNDS_SHOCK_COUNT] = {"electricFenceShock1", "electricFenceShock2", "electricFenceShock3", "electricFenceShock4"}

staticprivate

Definition at line 8 of file BarbedWireTrigger.c.

{"electricFenceShock1", "electricFenceShock2", "electricFenceShock3", "electricFenceShock4"};

Referenced by SoundElectricShock().

SOUNDS_COLLISION_COUNT

const int BarbedWireTrigger::SOUNDS_COLLISION_COUNT = 4

staticprivate

Definition at line 5 of file BarbedWireTrigger.c.

Referenced by SoundCollision().

SOUNDS_SHOCK_COUNT

const int BarbedWireTrigger::SOUNDS_SHOCK_COUNT = 4

staticprivate

Definition at line 6 of file BarbedWireTrigger.c.

Referenced by SoundElectricShock().

---

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

• scripts/4_World/Entities/ScriptedEntities/Triggers/BarbedWireTrigger.c