SCR_BaseTriggerComponent Interface Reference

Inheritance diagram for SCR_BaseTriggerComponent:

Public Member Functions
bool	IsActivated ()
bool	IsActivatedByDefault ()
void	SetUser (notnull IEntity user)
void	ActivateTrigger ()
void	DisarmTrigger ()
void	ShowFuse ()
void	OnActivatedChanged ()
	Method called on the clients, the item should be outside inventory already.
void	RPC_DoTrigger ()
void	SCR_BaseTriggerComponent (IEntityComponentSource src, IEntity ent, IEntity parent)
Public Member Functions inherited from BaseTriggerComponent
proto external IEntity	GetOwner ()
proto external void	OnUserTrigger (notnull IEntity owner)
proto external void	OnUserTriggerOverrideInstigator (notnull IEntity owner, Instigator instigator)
proto external bool	WasTriggered ()
proto external void	SetLive ()
proto external void	GetProjectileEffects (TypeName projectileType, out notnull array< BaseProjectileEffect > outProjectileEffects)
	Get projectile effects that are inherited from projectileType parameter.
proto external float	GetArmingTime ()
	Time to arm the fuse once the trigger is set live.
void	TriggeredInSafetyDistance (IEntity pHitEntity, inout vector outMat[3], IEntity damageSource, notnull Instigator instigator, string colliderName, float speed)
	Called when trigger is triggered within safety distance.
Public Member Functions inherited from BaseProjectileComponent
proto external Instigator	GetInstigator ()
proto external void	SetInstigator (notnull Instigator instigator)
proto external IEntity	GetParentProjectile ()
Public Member Functions inherited from GameComponent
bool	OnTicksOnRemoteProxy ()

Protected Member Functions
override void	EOnInit (IEntity owner)
	Event after entity is allocated and initialized.
Protected Member Functions inherited from BaseTriggerComponent
void	EOnContact (IEntity owner, IEntity other, Contact contact)
	Event when physics engine registered contact with other RigidBody.

Protected Attributes
bool	m_bLive
bool	m_bActivated = false
string	m_sFuzeMeshName

Constructor & Destructor Documentation

SCR_BaseTriggerComponent()

void SCR_BaseTriggerComponent.SCR_BaseTriggerComponent	(	IEntityComponentSource	src,
		IEntity	ent,
		IEntity	parent )

Parameters

[in]	src
[in]	ent
[in]	parent

Member Function Documentation

ActivateTrigger()

void SCR_BaseTriggerComponent.ActivateTrigger

(

)

Implemented in SCR_PressureTriggerComponent.

DisarmTrigger()

void SCR_BaseTriggerComponent.DisarmTrigger

(

)

Implemented in SCR_PressureTriggerComponent.

EOnInit()

override void SCR_BaseTriggerComponent.EOnInit ( IEntity owner )

protected

Event after entity is allocated and initialized.

Parameters

owner

The owner entity

Implements BaseTriggerComponent.

Implemented in SCR_ExplosiveTriggerComponent, and SCR_PressureTriggerComponent.

IsActivated()

bool SCR_BaseTriggerComponent.IsActivated

(

)

Returns

IsActivatedByDefault()

bool SCR_BaseTriggerComponent.IsActivatedByDefault

(

)

Returns

OnActivatedChanged()

void SCR_BaseTriggerComponent.OnActivatedChanged

(

)

Method called on the clients, the item should be outside inventory already.

Implemented in SCR_PressureTriggerComponent.

RPC_DoTrigger()

void SCR_BaseTriggerComponent.RPC_DoTrigger

(

)

SetUser()

void SCR_BaseTriggerComponent.SetUser

(

notnull IEntity

user

)

Parameters

[in]

user

ShowFuse()

void SCR_BaseTriggerComponent.ShowFuse

(

)

Member Data Documentation

m_bActivated

bool SCR_BaseTriggerComponent.m_bActivated = false

protected

m_bLive

bool SCR_BaseTriggerComponent.m_bLive

protected

m_sFuzeMeshName

string SCR_BaseTriggerComponent.m_sFuzeMeshName

protected

---

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

• Game/Weapon/Explosives/SCR_BaseTriggerComponent.c