TrapBase.c File Reference

Enumerations
enum	SoundTypeTrap { ACTIVATING = 5 }

Functions
void	TrapBase ()
void	OnUpdate (EntityAI victim)
TrapTrigger	GetTrapTrigger ()
override void	OnVariablesSynchronized ()
	this event is called all variables are synchronized on client
override void	EEDelete (EntityAI parent)
override void	OnStoreSave (ParamsWriteContext ctx)
override bool	OnStoreLoad (ParamsReadContext ctx, int version)
bool	IsActive ()
bool	IsInactive ()
override bool	IsTakeable ()
bool	IsActivable ()
bool	IsPlaceable ()
bool	IsPlaceableAtPosition (vector position)
void	Disarm ()
void	OnDisarm ()
	also called from RPC on client
void	SnapOnObject (EntityAI victim)
void	RemoveFromObject (EntityAI victim)
void	OnSteppedOn (EntityAI victim)
void	OnSteppedOut (EntityAI victim)
protected void	Synch (EntityAI victim)
	keeping "step" here for consistency only
override void	OnRPC (PlayerIdentity sender, int rpc_type, ParamsReadContext ctx)
void	RefreshState ()
void	SetupTrap ()
void	SetupTrapPlayer (PlayerBase player, bool set_position=true)
void	AddDefect ()
void	SetActive ()
void	OnActivate ()
void	StartActivate (PlayerBase player)
void	StartDeactivate (PlayerBase player)
void	SetInactive (bool stop_timer=true)
void	CreateTrigger ()
void	DeleteTrigger ()
void	DeferredEnableTrigger ()
override void	OnItemLocationChanged (EntityAI old_owner, EntityAI new_owner)
override void	EEItemAttached (EntityAI item, string slot_name)
override void	EEItemDetached (EntityAI item, string slot_name)
override void	OnPlacementComplete (Man player, vector position="0 0 0", vector orientation="0 0 0")
override bool	CanPutInCargo (EntityAI parent)
override bool	CanPutIntoHands (EntityAI parent)
override bool	CanRemoveFromHands (EntityAI parent)
override bool	CanBePlaced (Man player, vector position)
bool	CanBeClapped ()
	DEPRECATED Set if trap can be disarmed using ActionClapBearTrapWithThisItem.
bool	CanBeDisarmed ()
void	SetDisarmed (bool disarmed)
	DEPRECATED.
bool	GetDisarmed ()
	DEPRECATED.
override void	SetActions ()
protected EntityAI	GetClosestCarWheel (EntityAI victim)
protected void	DamageClothing (PlayerBase player)
void	PlayDeployLoopSound ()
void	StopDeployLoopSound ()
	DEPRECATED.

Variables
enum SoundTypeTrap	SPAWN_FLAGS = ECE_LOCAL
protected const int	DAMAGE_TRIGGER_MINE = 75
protected const float	UPDATE_TIMER_INTERVAL = 0.05
float	m_InitWaitTime
bool	m_NeedActivation
float	m_DefectRate
float	m_DamagePlayers
float	m_DamageOthers
bool	m_AddActivationDefect
bool	m_AddDeactivationDefect
protected bool	m_IsActive
protected bool	m_IsInProgress
protected bool	m_Disarmed = false
bool	m_WasActivatedOrDeactivated
	DEPRECATED Used for explosive traps to prevent detonation after destroying through disarm action.
string	m_AnimationPhaseGrounded
string	m_AnimationPhaseSet
string	m_AnimationPhaseTriggered
string	m_InfoSetup
string	m_InfoDeactivated
string	m_InfoDamageManipulation
string	m_InfoDamage
string	m_InfoActivationTime
protected ref Timer	m_Timer
protected ref Timer	m_UpdateTimer
protected TrapTrigger	m_TrapTrigger
protected ref array< int >	m_ClothingDmg
protected ref EffectSound	m_DeployLoopSound
	DEPRECATED.

Enumeration Type Documentation

SoundTypeTrap

enum SoundTypeTrap

Enumerator
ACTIVATING

Function Documentation

AddDefect()

void AddDefect

(

)

References GetGame(), and m_DefectRate.

Referenced by SetActive(), SetInactive(), and ItemBase::SetUsed().

CanBeClapped()

bool CanBeClapped

(

)

DEPRECATED Set if trap can be disarmed using ActionClapBearTrapWithThisItem.

CanBeDisarmed()

bool CanBeDisarmed

(

)

CanBePlaced()

override bool CanBePlaced	(	Man	player,
		vector	position
	)

References IsPlaceableAtPosition().

CanPutInCargo()

override bool CanPutInCargo

(

EntityAI

parent

)

References IsTakeable().

CanPutIntoHands()

override bool CanPutIntoHands

(

EntityAI

parent

)

References IsTakeable().

CanRemoveFromHands()

override bool CanRemoveFromHands

(

EntityAI

parent

)

References IsTakeable().

CreateTrigger()

void CreateTrigger

(

)

References ScriptCallQueue::Call(), CALL_CATEGORY_SYSTEM, Class::CastTo(), DeferredEnableTrigger(), CGame::GetCallQueue(), GetGame(), GetOrientation(), GetPosition, m_TrapTrigger, Trigger::SetExtents(), TrapTrigger::SetParentObject(), and SPAWN_FLAGS.

Referenced by InitZoneServer(), HotSpringArea::InitZoneServer(), SpookyArea::InitZoneServer(), and VolcanicArea::InitZoneServer().

DamageClothing()

protected void DamageClothing

(

PlayerBase

player

)

References m_ClothingDmg.

Referenced by OnSteppedOn().

DeferredEnableTrigger()

void DeferredEnableTrigger

(

)

References m_TrapTrigger, and TrapTrigger::SetEnabled().

Referenced by CreateTrigger().

DeleteTrigger()

void DeleteTrigger

(

)

References m_TrapTrigger, and TrapTrigger::SetParentObject().

Referenced by EEItemLocationChanged(), SetInactive(), and StartDeactivate().

Disarm()

void Disarm

(

)

References GetGame(), TrapBase::OnDisarm(), RefreshState(), CGame::RPCSingleParam(), and SetInactive().

EEDelete()

override void EEDelete

(

EntityAI

parent

)

References GetGame(), m_TrapTrigger, and CGame::ObjectDelete().

EEItemAttached()

override void EEItemAttached	(	EntityAI	item,
		string	slot_name
	)

References GetGame(), and RefreshState().

EEItemDetached()

override void EEItemDetached	(	EntityAI	item,
		string	slot_name
	)

References GetGame(), and RefreshState().

GetClosestCarWheel()

protected EntityAI GetClosestCarWheel

(

EntityAI

victim

)

carscript specific handling (not all traps are uses this)

ruined wheel, bail out

ignore all spare wheel

actual, healthy wheel, let it pass

References GameInventory::AttachmentCount(), vector::Distance(), GameInventory::GetAttachmentFromIndex(), GetPosition, and slotName.

Referenced by OnUpdate(), and TrapBase::OnUpdate().

GetDisarmed()

bool GetDisarmed

(

)

DEPRECATED.

References m_Disarmed.

GetTrapTrigger()

TrapTrigger GetTrapTrigger

(

)

References m_TrapTrigger.

IsActivable()

bool IsActivable

(

)

References IsActive(), m_IsInProgress, and m_NeedActivation.

IsActive()

bool IsActive

(

)

References m_IsActive, and m_IsInProgress.

IsInactive()

bool IsInactive

(

)

References IsActive(), and m_IsInProgress.

Referenced by RefreshState().

IsPlaceable()

bool IsPlaceable

(

)

References vector::DistanceSq(), IsPlaceableAtPosition(), and Math::SqrFloat().

IsPlaceableAtPosition()

bool IsPlaceableAtPosition

(

vector

position

)

References g_Game, and GetGame().

Referenced by CanBePlaced(), and IsPlaceable().

IsTakeable()

override bool IsTakeable

(

)

References IsActive(), and m_IsInProgress.

OnActivate()

void OnActivate

(

)

References GetGame(), GetPlayer(), m_TimerLoopSound, and PlaySoundActivate().

Referenced by Activate(), AntibioticsMdfr::OnReconnect(), CharcoalMdfr::OnReconnect(), ChelationMdfr::OnReconnect(), FatigueMdfr::OnReconnect(), FeverMdfr::OnReconnect(), HemolyticReactionMdfr::OnReconnect(), PoisoningMdfr::OnReconnect(), WetMdfr::OnReconnect(), DisinfectionMdfr::OnReconnect(), DrowningMdfr::OnReconnect(), EpinephrineMdfr::OnReconnect(), FliesMdfr::OnReconnect(), ImmunityBoost::OnReconnect(), MaskMdfr::OnReconnect(), MorphineMdfr::OnReconnect(), PainKillersMdfr::OnReconnect(), and SalineMdfr::OnReconnect().

OnDisarm()

void OnDisarm

(

)

also called from RPC on client

OnItemLocationChanged()

override void OnItemLocationChanged	(	EntityAI	old_owner,
		EntityAI	new_owner
	)

References GetGame(), IsActive(), RefreshState(), and SnapOnObject().

OnPlacementComplete()

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

References GetGame(), and SetPosition().

OnRPC()

override void OnRPC	(	PlayerIdentity	sender,
		int	rpc_type,
		ParamsReadContext	ctx
	)

References GetGame(), TrapBase::OnDisarm(), Serializer::Read(), and SnapOnObject().

OnSteppedOn()

void OnSteppedOn

(

EntityAI

victim

)

References SetInactive().

OnSteppedOut()

void OnSteppedOut

(

EntityAI

victim

)

References m_UpdateTimer, and Timer::Stop().

OnStoreLoad()

override bool OnStoreLoad	(	ParamsReadContext	ctx,
		int	version
	)

References Serializer::Read(), SetActive(), and StartActivate().

OnStoreSave()

override void OnStoreSave

(

ParamsWriteContext

ctx

)

References m_IsActive, m_IsInProgress, and Serializer::Write().

OnUpdate()

void OnUpdate

(

EntityAI

victim

)

References GetClosestCarWheel(), and TrapBase::OnServerSteppedOn().

OnVariablesSynchronized()

override void OnVariablesSynchronized

(

)

this event is called all variables are synchronized on client

References GetGame(), m_IsActive, m_IsInProgress, SetActive(), and StartActivate().

PlayDeployLoopSound()

void PlayDeployLoopSound

(

)

RefreshState()

void RefreshState

(

)

References GetGame(), IsActive(), IsInactive(), m_AnimationPhaseGrounded, m_AnimationPhaseSet, m_AnimationPhaseTriggered, and m_WasActivatedOrDeactivated.

Referenced by Disarm(), EEHealthLevelChanged(), EEItemAttached(), EEItemDetached(), EEItemLocationChanged(), OnItemLocationChanged(), OnStoreLoad(), SetActive(), SetInactive(), and SnapOnObject().

RemoveFromObject()

void RemoveFromObject

(

EntityAI

victim

)

References TrapBase::OnSteppedOut().

SetActions()

override void SetActions

(

)

References ActionActivateTrap(), and AddAction().

SetActive()

void SetActive

(

)

References AddDefect(), TrapBase::CreateTrigger(), GetGame(), m_AddActivationDefect, m_IsActive, m_IsInProgress, m_WasActivatedOrDeactivated, TrapBase::OnActivate(), and RefreshState().

Referenced by EEItemLocationChanged(), Icon::Icon(), UniversalTemperatureSourceDebug::Init(), ItemBase::OnItemLocationChanged(), ItemBase::OnPlacementComplete(), OnStoreLoad(), ItemBase::OnStoreLoad(), OnVariablesSynchronized(), HandsContainer::Refresh(), Container::Select(), LayoutHolder::SetFirstActive(), Container::SetNextActive(), AttachmentsGroupContainer::SetNextActive(), LayoutHolder::SetNextActive(), Container::SetPreviousActive(), AttachmentsGroupContainer::SetPreviousActive(), LayoutHolder::SetPreviousActive(), LayoutHolder::SetSameLevelNextActive(), LayoutHolder::SetSameLevelPreviousActive(), TrapSpawnBase::SetupTrap(), SetupTrapPlayer(), SlotsIcon::SlotsIcon(), StartActivate(), RainProcurementComponentBase::StartRainProcurement(), RainProcurementComponentBase::StopRainProcurement(), and UniversalTemperatureSourceDebug::Update().

SetDisarmed()

void SetDisarmed

(

bool

disarmed

)

DEPRECATED.

References m_Disarmed.

SetInactive()

void SetInactive

(

bool

stop_timer = true

)

References AddDefect(), DeleteTrigger(), m_AddDeactivationDefect, m_IsActive, m_Timer, m_WasActivatedOrDeactivated, RefreshState(), and Timer::Stop().

Referenced by Disarm(), TrapBase::EEHealthLevelChanged(), EEItemLocationChanged(), ItemBase::Fold(), ItemBase::OnItemLocationChanged(), TrapBase::OnServerSteppedOn(), OnServerSteppedOn(), and OnSteppedOn().

SetupTrap()

void SetupTrap

(

)

References GetGame(), and SetupTrapPlayer().

SetupTrapPlayer()

void SetupTrapPlayer	(	PlayerBase	player,
		bool	set_position = true
	)

References GetGame(), m_NeedActivation, SetActive(), and SetPosition().

Referenced by ItemBase::OnPlacementComplete(), SetupTrap(), and ItemBase::SetupTrap().

SnapOnObject()

void SnapOnObject

(

EntityAI

victim

)

References Math::Clamp(), GetGame(), CGame::GetInventoryItemSize(), m_DamageOthers, m_DamagePlayers, m_Timer, MAX, TrapBase::OnSteppedOn(), RefreshState(), Timer::Stop(), and Synch().

Referenced by OnItemLocationChanged(), and OnRPC().

StartActivate()

void StartActivate

(

PlayerBase

player

)

References CALL_CATEGORY_SYSTEM, GetGame(), m_InitWaitTime, m_IsInProgress, m_Timer, and SetActive().

Referenced by TrapBase::OnPlacementComplete(), OnPlacementComplete(), OnStoreLoad(), and OnVariablesSynchronized().

StartDeactivate()

void StartDeactivate

(

PlayerBase

player

)

References DeleteTrigger(), FOLDED, and SetState().

Referenced by EEKilled(), and OnItemLocationChanged().

StopDeployLoopSound()

void StopDeployLoopSound

(

)

DEPRECATED.

Synch()

protected void Synch

(

EntityAI

victim

)

keeping "step" here for consistency only

References GetGame(), and CGame::RPCSingleParam().

Referenced by TrapBase::OnServerSteppedOn(), OnServerSteppedOn(), and SnapOnObject().

TrapBase()

void TrapBase

(

)

timer calling OnUpdate in configured interval

References m_AddActivationDefect, m_AddDeactivationDefect, m_AnimationPhaseGrounded, m_AnimationPhaseSet, m_AnimationPhaseTriggered, m_DamageOthers, m_DamagePlayers, m_DefectRate, m_InfoActivationTime, m_InfoDamage, m_InfoDamageManipulation, m_InfoDeactivated, m_InfoSetup, m_InitWaitTime, m_IsInProgress, m_NeedActivation, m_UpdateTimer, m_WasActivatedOrDeactivated, and float::ToString().

Variable Documentation

DAMAGE_TRIGGER_MINE

protected const int DAMAGE_TRIGGER_MINE = 75

Referenced by OnSteppedOn().

m_AddActivationDefect

bool m_AddActivationDefect

Referenced by SetActive(), and TrapBase().

m_AddDeactivationDefect

bool m_AddDeactivationDefect

Referenced by LandMineTrap(), SetInactive(), and TrapBase().

m_AnimationPhaseGrounded

string m_AnimationPhaseGrounded

Referenced by TrapBase::BearTrap(), FoldTripWire(), RefreshState(), TrapBase(), and TripwireTrap().

m_AnimationPhaseSet

string m_AnimationPhaseSet

Referenced by TrapBase::BearTrap(), FoldTripWire(), ItemBase::InitTrapValues(), TrapSpawnBase::InitTrapValues(), RefreshState(), ItemBase::SetActive(), ItemBase::SetDeployed(), ItemBase::SetUsed(), TrapBase(), and TripwireTrap().

m_AnimationPhaseTriggered

string m_AnimationPhaseTriggered

Referenced by TrapBase::BearTrap(), FoldTripWire(), ItemBase::InitTrapValues(), TrapSpawnBase::InitTrapValues(), RefreshState(), ItemBase::SetActive(), ItemBase::SetDeployed(), ItemBase::SetUsed(), TrapBase(), and TripwireTrap().

m_ClothingDmg

protected ref array<int> m_ClothingDmg

Referenced by DamageClothing(), and LandMineTrap().

m_DamageOthers

float m_DamageOthers

Referenced by TrapBase::BearTrap(), SnapOnObject(), and TrapBase().

m_DamagePlayers

float m_DamagePlayers

Referenced by TrapBase::BearTrap(), LandMineTrap(), SnapOnObject(), TrapBase(), and TripwireTrap().

m_DefectRate

float m_DefectRate

Referenced by AddDefect(), ItemBase::AddDefect(), TrapBase::BearTrap(), ItemBase::InitTrapValues(), TrapSpawnBase::InitTrapValues(), LandMineTrap(), TrapBase(), and TripwireTrap().

m_DeployLoopSound

protected ref EffectSound m_DeployLoopSound

DEPRECATED.

m_Disarmed

protected bool m_Disarmed = false

Referenced by GetDisarmed(), and SetDisarmed().

m_InfoActivationTime

string m_InfoActivationTime

Referenced by LandMineTrap(), TrapBase(), and TripwireTrap().

m_InfoDamage

string m_InfoDamage

Referenced by TrapBase().

m_InfoDamageManipulation

string m_InfoDamageManipulation

Referenced by TrapBase().

m_InfoDeactivated

string m_InfoDeactivated

Referenced by TrapBase().

m_InfoSetup

string m_InfoSetup

Referenced by TrapBase().

m_InitWaitTime

float m_InitWaitTime

Referenced by TrapBase::BearTrap(), LandMineTrap(), ItemBase::ResetRunningTimerProgress(), ItemBase::SetActive(), StartActivate(), TrapBase(), and TripwireTrap().

m_IsActive

protected bool m_IsActive

m_IsInProgress

protected bool m_IsInProgress

Referenced by IsActivable(), IsActive(), IsInactive(), IsTakeable(), OnStoreSave(), OnVariablesSynchronized(), SetActive(), StartActivate(), and TrapBase().

m_NeedActivation

bool m_NeedActivation

Referenced by IsActivable(), SetupTrapPlayer(), TrapBase(), and TripwireTrap().

m_Timer

protected ref Timer m_Timer

m_TrapTrigger

protected TrapTrigger m_TrapTrigger

Referenced by CreateTrigger(), TrapBase::CreateTrigger(), DeferredEnableTrigger(), DeleteTrigger(), EEDelete(), EEItemLocationChanged(), EEKilled(), and GetTrapTrigger().

m_UpdateTimer

protected ref Timer m_UpdateTimer

m_WasActivatedOrDeactivated

bool m_WasActivatedOrDeactivated

DEPRECATED Used for explosive traps to prevent detonation after destroying through disarm action.

Referenced by RefreshState(), SetActive(), SetInactive(), and TrapBase().

SPAWN_FLAGS

enum SoundTypeTrap SPAWN_FLAGS = ECE_LOCAL

Referenced by CreateTrigger().

UPDATE_TIMER_INTERVAL

protected const float UPDATE_TIMER_INTERVAL = 0.05

Referenced by TrapBase::OnSteppedOn(), and OnSteppedOn().