ClaymoreMine Class Reference

Inheritance diagram for ClaymoreMine:

Collaboration diagram for ClaymoreMine:

Protected Member Functions
void	ClaymoreMine ()
override void	EOnInit (IEntity other, int extra)
override void	EEKilled (Object killer)
override void	EEDelete (EntityAI parent)
void	InitiateExplosion ()
override void	AfterStoreLoad ()
override void	OnVariablesSynchronized ()
override void	EEItemLocationChanged (notnull InventoryLocation oldLoc, notnull InventoryLocation newLoc)
override RemotelyActivatedItemBehaviour	GetRemotelyActivatedItemBehaviour ()
override void	PairRemote (notnull EntityAI trigger)
override EntityAI	GetPairDevice ()
override bool	CanBeDisarmed ()
override void	OnActivatedByItem (notnull ItemBase item)
override void	OnArmed ()
override void	OnDisarmed (bool pWithTool)
override void	OnPlacementComplete (Man player, vector position="0 0 0", vector orientation="0 0 0")
void	UpdateVisuals ()
void	UpdateLED (ERemoteDetonatorLEDState pState, bool pForced=false)
override bool	IsTakeable ()
override bool	IsDeployable ()
override void	SetActions ()
override int	GetViewIndex ()
bool	UsesGlobalDeploy ()
override string	GetDeploySoundset ()
override string	GetLoopDeploySoundset ()
override void	OnDebugSpawn ()

Protected Attributes
const string	ANIM_PHASE_PACKED = "Bag"
const string	ANIM_PHASE_DEPLOYED = "Mine"
const string	SELECTION_NAME_LED = "LED"
ref RemotelyActivatedItemBehaviour	m_RAIB
ERemoteDetonatorLEDState	m_LastLEDState

Detailed Description

Definition at line 1 of file ClaymoreMine.c.

Constructor & Destructor Documentation

ClaymoreMine()

void ClaymoreMine::ClaymoreMine ( )

inlineprotected

Definition at line 10 of file ClaymoreMine.c.

  {
    m_RAIB = new RemotelyActivatedItemBehaviour(this);
 
    SetAmmoTypes({"ClaymoreMine_Ammo", "ClaymoreMine_Secondary_Ammo"});
    SetParticleExplosion(ParticleList.CLAYMORE_EXPLOSION);
    SetParticleOrientation("90 0 0");
 
    RegisterNetSyncVariableInt("m_RAIB.m_PairDeviceNetIdLow");
    RegisterNetSyncVariableInt("m_RAIB.m_PairDeviceNetIdHigh");
    UpdateLED(ERemoteDetonatorLEDState.OFF, true);
  }

References ParticleList::CLAYMORE_EXPLOSION, m_RAIB, SetAmmoTypes(), SetParticleExplosion(), SetParticleOrientation(), and UpdateLED().

Member Function Documentation

AfterStoreLoad()

override void ClaymoreMine::AfterStoreLoad ( )

inlineprotected

Definition at line 57 of file ClaymoreMine.c.

  {
    super.AfterStoreLoad();
 
    UpdateVisuals();
    if (GetArmed())
      UpdateLED(ERemoteDetonatorLEDState.LIT, true);
  }

References GetArmed(), UpdateLED(), and UpdateVisuals().

CanBeDisarmed()

override bool ClaymoreMine::CanBeDisarmed ( )

inlineprotected

Definition at line 100 of file ClaymoreMine.c.

  {
    return GetArmed();
  }

References GetArmed().

EEDelete()

override void ClaymoreMine::EEDelete ( EntityAI parent )

inlineprotected

Definition at line 38 of file ClaymoreMine.c.

  {
    super.EEDelete(parent);
 
#ifdef DIAG_DEVELOPER
#ifndef SERVER
    RemoveDebugVisuals();
#endif
#endif
  }

EEItemLocationChanged()

override void ClaymoreMine::EEItemLocationChanged ( notnull InventoryLocation oldLoc, notnull InventoryLocation newLoc )

inlineprotected

Definition at line 76 of file ClaymoreMine.c.

  {
    super.EEItemLocationChanged(oldLoc, newLoc);
 
    if (m_RAIB)
      m_RAIB.Pair();
  }

References m_RAIB.

EEKilled()

override void ClaymoreMine::EEKilled ( Object killer )

inlineprotected

Definition at line 28 of file ClaymoreMine.c.

  {
    super.EEKilled(killer);
#ifdef DIAG_DEVELOPER
#ifndef SERVER
    RemoveDebugVisuals();
#endif
#endif
  }

EOnInit()

override void ClaymoreMine::EOnInit ( IEntity other, int extra )

inlineprotected

Definition at line 23 of file ClaymoreMine.c.

  {
    UpdateVisuals();
  }

References UpdateVisuals().

GetDeploySoundset()

override string ClaymoreMine::GetDeploySoundset ( )

inlineprotected

Definition at line 238 of file ClaymoreMine.c.

  {
    return "placeClaymore_SoundSet";
  }

GetLoopDeploySoundset()

override string ClaymoreMine::GetLoopDeploySoundset ( )

inlineprotected

Definition at line 243 of file ClaymoreMine.c.

  {
    return "claymore_deploy_Soundset";
  }

GetPairDevice()

override EntityAI ClaymoreMine::GetPairDevice ( )

inlineprotected

Definition at line 95 of file ClaymoreMine.c.

  {
    return m_RAIB.GetPairDevice();
  }

References m_RAIB.

Referenced by OnActivatedByItem().

GetRemotelyActivatedItemBehaviour()

override RemotelyActivatedItemBehaviour ClaymoreMine::GetRemotelyActivatedItemBehaviour ( )

inlineprotected

Definition at line 85 of file ClaymoreMine.c.

  {
    return m_RAIB;
  }

References m_RAIB.

GetViewIndex()

override int ClaymoreMine::GetViewIndex ( )

inlineprotected

Definition at line 222 of file ClaymoreMine.c.

  {
    if (MemoryPointExists("invView2"))
    {
      if (GetArmed())
        return 1;
    }
 
    return 0;
  }

References GetArmed().

InitiateExplosion()

void ClaymoreMine::InitiateExplosion ( )

inlineprotected

Definition at line 49 of file ClaymoreMine.c.

  {
    if (GetDefused())
      return;
 
    super.InitiateExplosion();
  }

References GetDefused().

IsDeployable()

override bool ClaymoreMine::IsDeployable ( )

inlineprotected

Definition at line 208 of file ClaymoreMine.c.

  {
    return true;
  }

IsTakeable()

override bool ClaymoreMine::IsTakeable ( )

inlineprotected

Definition at line 203 of file ClaymoreMine.c.

  {
    return !GetArmed() && super.IsTakeable();
  }

References GetArmed().

OnActivatedByItem()

override void ClaymoreMine::OnActivatedByItem ( notnull ItemBase item )

inlineprotected

Definition at line 105 of file ClaymoreMine.c.

  {
    if (GetGame().IsServer())
    {
      if (m_RAIB.IsPaired() && GetArmed())
      {
        if (GetPairDevice() == item)
          SetHealth("", "", 0.0);
      }
    }
  }

References GetArmed(), GetGame(), GetPairDevice(), and m_RAIB.

OnArmed()

override void ClaymoreMine::OnArmed ( )

inlineprotected

Definition at line 117 of file ClaymoreMine.c.

  {
    super.OnArmed();
 
    UpdateVisuals();
    UpdateLED(ERemoteDetonatorLEDState.LIT, true);
 
#ifdef DIAG_DEVELOPER
#ifndef SERVER
    // have to call this function a little later, after claymore transform has been finalized
    GetGame().GetCallQueue(CALL_CATEGORY_SYSTEM).CallLater(DrawDamageZone, 500);
#endif
#endif
  }

References CALL_CATEGORY_SYSTEM, GetGame(), UpdateLED(), and UpdateVisuals().

OnDebugSpawn()

override void ClaymoreMine::OnDebugSpawn ( )

inlineprotected

Definition at line 248 of file ClaymoreMine.c.

  {
    RemoteDetonatorTrigger rdt = RemoteDetonatorTrigger.Cast(SpawnEntityOnGroundPos("RemoteDetonatorTrigger", GetPosition() + GetDirection() * 0.5));
    PairWithDevice(rdt);
    Arm();
  }

References Arm(), GetPosition, and PairWithDevice().

OnDisarmed()

override void ClaymoreMine::OnDisarmed ( bool pWithTool )

inlineprotected

Definition at line 132 of file ClaymoreMine.c.

  {
    super.OnDisarmed(pWithTool);
 
#ifdef DIAG_DEVELOPER
    RemoveDebugVisuals();
#endif
 
    SetDefused(pWithTool);
    UnpairRemote();
 
    if (pWithTool)
      SetHealth("", "", 0.0);
 
    UpdateVisuals();
    UpdateLED(ERemoteDetonatorLEDState.OFF, true);
  }

References SetDefused(), UnpairRemote(), UpdateLED(), and UpdateVisuals().

OnPlacementComplete()

override void ClaymoreMine::OnPlacementComplete ( Man player, vector position = "0 0 0", vector orientation = "0 0 0" )

inlineprotected

Definition at line 150 of file ClaymoreMine.c.

  {
    super.OnPlacementComplete(player, position, orientation);
 
    if (GetGame().IsServer())
    {
      RemoteDetonatorTrigger rdt = RemoteDetonatorTrigger.SpawnInPlayerHands(player);
      if (rdt)
      {
        PairWithDevice(rdt);
        Arm();
      }
    }
  }

References Arm(), GetGame(), PairWithDevice(), and RemoteDetonatorTrigger::SpawnInPlayerHands().

OnVariablesSynchronized()

override void ClaymoreMine::OnVariablesSynchronized ( )

inlineprotected

Definition at line 66 of file ClaymoreMine.c.

  {
    super.OnVariablesSynchronized();
 
    if (m_RAIB)
      m_RAIB.OnVariableSynchronized();
 
    UpdateVisuals();
  }

References m_RAIB, and UpdateVisuals().

PairRemote()

override void ClaymoreMine::PairRemote ( notnull EntityAI trigger )

inlineprotected

Definition at line 90 of file ClaymoreMine.c.

  {
    m_RAIB.Pair(trigger);
  }

References m_RAIB.

SetActions()

override void ClaymoreMine::SetActions ( )

inlineprotected

Definition at line 213 of file ClaymoreMine.c.

  {
    super.SetActions();
 
    AddAction(ActionTogglePlaceObject);
    AddAction(ActionDeployObject);
    AddAction(ActionArmExplosive);
  }

References ActionArmExplosive(), and AddAction().

UpdateLED()

void ClaymoreMine::UpdateLED ( ERemoteDetonatorLEDState pState, bool pForced = false )

inlineprotected

Definition at line 183 of file ClaymoreMine.c.

  {
    if (pState != m_LastLEDState || pForced)
    {
      int selectionIdx = GetHiddenSelectionIndex(SELECTION_NAME_LED);
 
      switch (pState)
      {
      case ERemoteDetonatorLEDState.LIT:
        SetObjectTexture(selectionIdx, RemoteDetonator.COLOR_LED_LIT);
        break;
      default:
        SetObjectTexture(selectionIdx, RemoteDetonator.COLOR_LED_OFF);
        break;
      }
 
      m_LastLEDState = pState;
    }
  }

References m_LastLEDState, and SELECTION_NAME_LED.

Referenced by AfterStoreLoad(), ClaymoreMine(), OnArmed(), and OnDisarmed().

UpdateVisuals()

void ClaymoreMine::UpdateVisuals ( )

inlineprotected

Definition at line 165 of file ClaymoreMine.c.

  {
    if (GetArmed() || GetDefused())
    {
      ShowSelection(ANIM_PHASE_DEPLOYED);
      HideSelection(ANIM_PHASE_PACKED);
      if (GetOnViewIndexChanged())
        GetOnViewIndexChanged().Invoke();
    }
    else
    {
      HideSelection(ANIM_PHASE_DEPLOYED);
      ShowSelection(ANIM_PHASE_PACKED);
      if (GetOnViewIndexChanged())
        GetOnViewIndexChanged().Invoke();
    }
  }

References ANIM_PHASE_DEPLOYED, ANIM_PHASE_PACKED, GetArmed(), and GetDefused().

Referenced by AfterStoreLoad(), EOnInit(), OnArmed(), OnDisarmed(), and OnVariablesSynchronized().

UsesGlobalDeploy()

bool ClaymoreMine::UsesGlobalDeploy ( )

inlineprotected

Definition at line 233 of file ClaymoreMine.c.

  {
    return true;
  }

Member Data Documentation

ANIM_PHASE_DEPLOYED

const string ClaymoreMine::ANIM_PHASE_DEPLOYED = "Mine"

protected

Definition at line 4 of file ClaymoreMine.c.

Referenced by UpdateVisuals().

ANIM_PHASE_PACKED

const string ClaymoreMine::ANIM_PHASE_PACKED = "Bag"

protected

Definition at line 3 of file ClaymoreMine.c.

Referenced by UpdateVisuals().

m_LastLEDState

ERemoteDetonatorLEDState ClaymoreMine::m_LastLEDState

protected

Definition at line 8 of file ClaymoreMine.c.

Referenced by UpdateLED().

m_RAIB

ref RemotelyActivatedItemBehaviour ClaymoreMine::m_RAIB

protected

Definition at line 7 of file ClaymoreMine.c.

Referenced by ClaymoreMine(), EEItemLocationChanged(), GetPairDevice(), GetRemotelyActivatedItemBehaviour(), OnActivatedByItem(), OnVariablesSynchronized(), and PairRemote().

SELECTION_NAME_LED

const string ClaymoreMine::SELECTION_NAME_LED = "LED"

protected

Definition at line 5 of file ClaymoreMine.c.

Referenced by UpdateLED().

---

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

• scripts/4_World/Entities/ExplosivesBase/ClaymoreMine.c