BaseTriggerComponent Interface Reference

Inheritance diagram for BaseTriggerComponent:

Public Member Functions
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
void	EOnInit (IEntity owner)
	Event after entity is allocated and initialized.
void	EOnContact (IEntity owner, IEntity other, Contact contact)
	Event when physics engine registered contact with other RigidBody.

Member Function Documentation

EOnContact()

void BaseTriggerComponent.EOnContact ( IEntity owner, IEntity other, Contact contact )

protected

Event when physics engine registered contact with other RigidBody.

Parameters

owner	The owner entity
other	Other Entity who contacted us
contact	Structure describing the contact

Implemented in SCR_PressureTriggerComponent.

EOnInit()

void BaseTriggerComponent.EOnInit ( IEntity owner )

protected

Event after entity is allocated and initialized.

Parameters

owner

The owner entity

Implemented in SCR_BaseTriggerComponent, SCR_ExplosiveTriggerComponent, and SCR_PressureTriggerComponent.

GetArmingTime()

proto external float BaseTriggerComponent.GetArmingTime

(

)

Time to arm the fuse once the trigger is set live.

GetOwner()

proto external IEntity BaseTriggerComponent.GetOwner

(

)

GetProjectileEffects()

proto external void BaseTriggerComponent.GetProjectileEffects	(	TypeName	projectileType,
		out notnull array< BaseProjectileEffect >	outProjectileEffects )

Get projectile effects that are inherited from projectileType parameter.

OnUserTrigger()

proto external void BaseTriggerComponent.OnUserTrigger

(

notnull IEntity

owner

)

OnUserTriggerOverrideInstigator()

proto external void BaseTriggerComponent.OnUserTriggerOverrideInstigator	(	notnull IEntity	owner,
		Instigator	instigator )

SetLive()

proto external void BaseTriggerComponent.SetLive

(

)

TriggeredInSafetyDistance()

void BaseTriggerComponent.TriggeredInSafetyDistance	(	IEntity	pHitEntity,
		inout vector	outMat[3],
		IEntity	damageSource,
		notnull Instigator	instigator,
		string	colliderName,
		float	speed )

Called when trigger is triggered within safety distance.

Parameters

pHitEntity	Damaged entity
outMat	Hit position/direction/normal
damageSource	Projectile
Instigator	Instigator of the damage
colliderName	Collider name if exist otherwise empty
speed	Projectile velocity in m/s

WasTriggered()

proto external bool BaseTriggerComponent.WasTriggered

(

)

---

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

• Game/generated/Projectile/Trigger/BaseTriggerComponent.c