TriggerEvents Class Reference

Private Member Functions
ScriptInvoker	GetOnEnterInvoker ()
ScriptInvoker	GetOnLeaveInvoker ()
OnEnter
Called when an object enters the trigger
protected void	Enter (TriggerInsider insider)
protected void	OnEnterBeginEvent (TriggerInsider insider)
protected void	OnEnterServerEvent (TriggerInsider insider)
protected void	OnEnterClientEvent (TriggerInsider insider)
protected void	OnEnterEndEvent (TriggerInsider insider)
OnStayStart
Called at the beginning of an update loop
protected void	StayStart (int nrOfInsiders)
protected void	OnStayStartBeginEvent (int nrOfInsiders)
protected void	OnStayStartServerEvent (int nrOfInsiders)
protected void	OnStayStartClientEvent (int nrOfInsiders)
protected void	OnStayStartEndEvent (int nrOfInsiders)
OnStay
Called in the update loop
protected void	Stay (TriggerInsider insider, float deltaTime)
protected void	OnStayBeginEvent (TriggerInsider insider, float deltaTime)
protected void	OnStayServerEvent (TriggerInsider insider, float deltaTime)
protected void	OnStayClientEvent (TriggerInsider insider, float deltaTime)
protected void	OnStayEndEvent (TriggerInsider insider, float deltaTime)
OnStayFinish
Called at the end of an update loop
protected void	StayFinish ()
protected void	OnStayFinishBeginEvent ()
protected void	OnStayFinishServerEvent ()
protected void	OnStayFinishClientEvent ()
protected void	OnStayFinishEndEvent ()
OnLeave
Called when an object leaves the trigger
protected void	Leave (TriggerInsider insider)
protected void	OnLeaveBeginEvent (TriggerInsider insider)
protected void	OnLeaveServerEvent (TriggerInsider insider)
protected void	OnLeaveClientEvent (TriggerInsider insider)
protected void	OnLeaveEndEvent (TriggerInsider insider)

Private Attributes
protected ref ScriptInvoker	m_OnEnterInvoker
protected ref ScriptInvoker	m_OnLeaveInvoker

Detailed Description

Events API for triggers, keep in sync with AreaDamageEvents for consistency NOTE: The deltaTime passed in is the one for the Insider specifically.

Member Function Documentation

Enter()

protected void Enter ( TriggerInsider  insider )

inlineprivate

References GetDebugName(), GetGame(), TriggerInsider::GetObject(), ScriptInvoker::Invoke(), m_OnEnterInvoker, OnEnterBeginEvent(), OnEnterClientEvent(), OnEnterEndEvent(), OnEnterServerEvent(), and Debug::TriggerLog().

Referenced by Trigger::AddInsider().

GetOnEnterInvoker()

ScriptInvoker GetOnEnterInvoker ( )

inlineprivate

References m_OnEnterInvoker.

GetOnLeaveInvoker()

ScriptInvoker GetOnLeaveInvoker ( )

inlineprivate

References m_OnLeaveInvoker.

Leave()

protected void Leave ( TriggerInsider  insider )

inlineprivate

References GetDebugName(), GetGame(), TriggerInsider::GetObject(), ScriptInvoker::Invoke(), m_OnLeaveInvoker, OnLeaveBeginEvent(), OnLeaveClientEvent(), OnLeaveEndEvent(), OnLeaveServerEvent(), and Debug::TriggerLog().

Referenced by Trigger::RemoveInsider().

OnEnterBeginEvent()

protected void OnEnterBeginEvent ( TriggerInsider  insider )

inlineprivate

Referenced by Enter().

OnEnterClientEvent()

protected void OnEnterClientEvent ( TriggerInsider  insider )

inlineprivate

Referenced by Enter().

OnEnterEndEvent()

protected void OnEnterEndEvent ( TriggerInsider  insider )

inlineprivate

Referenced by Enter().

OnEnterServerEvent()

protected void OnEnterServerEvent ( TriggerInsider  insider )

inlineprivate

Referenced by Enter().

OnLeaveBeginEvent()

protected void OnLeaveBeginEvent ( TriggerInsider  insider )

inlineprivate

Referenced by Leave().

OnLeaveClientEvent()

protected void OnLeaveClientEvent ( TriggerInsider  insider )

inlineprivate

Referenced by Leave().

OnLeaveEndEvent()

protected void OnLeaveEndEvent ( TriggerInsider  insider )

inlineprivate

Referenced by Leave().

OnLeaveServerEvent()

protected void OnLeaveServerEvent ( TriggerInsider  insider )

inlineprivate

Referenced by Leave().

OnStayBeginEvent()

protected void OnStayBeginEvent ( TriggerInsider  insider, float  deltaTime  )

inlineprivate

Referenced by Stay().

OnStayClientEvent()

protected void OnStayClientEvent ( TriggerInsider  insider, float  deltaTime  )

inlineprivate

Referenced by Stay().

OnStayEndEvent()

protected void OnStayEndEvent ( TriggerInsider  insider, float  deltaTime  )

inlineprivate

Referenced by Stay().

OnStayFinishBeginEvent()

protected void OnStayFinishBeginEvent ( )

inlineprivate

Referenced by StayFinish().

OnStayFinishClientEvent()

protected void OnStayFinishClientEvent ( )

inlineprivate

Referenced by StayFinish().

OnStayFinishEndEvent()

protected void OnStayFinishEndEvent ( )

inlineprivate

Referenced by StayFinish().

OnStayFinishServerEvent()

protected void OnStayFinishServerEvent ( )

inlineprivate

Referenced by StayFinish().

OnStayServerEvent()

protected void OnStayServerEvent ( TriggerInsider  insider, float  deltaTime  )

inlineprivate

Referenced by Stay().

OnStayStartBeginEvent()

protected void OnStayStartBeginEvent ( int  nrOfInsiders )

inlineprivate

Referenced by StayStart().

OnStayStartClientEvent()

protected void OnStayStartClientEvent ( int  nrOfInsiders )

inlineprivate

Referenced by StayStart().

OnStayStartEndEvent()

protected void OnStayStartEndEvent ( int  nrOfInsiders )

inlineprivate

Referenced by StayStart().

OnStayStartServerEvent()

protected void OnStayStartServerEvent ( int  nrOfInsiders )

inlineprivate

Referenced by StayStart().

Stay()

protected void Stay ( TriggerInsider  insider, float  deltaTime  )

inlineprivate

References GetDebugName(), GetGame(), TriggerInsider::GetObject(), OnStayBeginEvent(), OnStayClientEvent(), OnStayEndEvent(), OnStayServerEvent(), and Debug::TriggerLog().

Referenced by Trigger::UpdateInsiders().

StayFinish()

protected void StayFinish ( )

inlineprivate

References GetDebugName(), GetGame(), OnStayFinishBeginEvent(), OnStayFinishClientEvent(), OnStayFinishEndEvent(), OnStayFinishServerEvent(), and Debug::TriggerLog().

Referenced by Trigger::UpdateInsiders().

StayStart()

protected void StayStart ( int  nrOfInsiders )

inlineprivate

References GetDebugName(), GetGame(), OnStayStartBeginEvent(), OnStayStartClientEvent(), OnStayStartEndEvent(), OnStayStartServerEvent(), and Debug::TriggerLog().

Referenced by Trigger::UpdateInsiders().

Field Documentation

m_OnEnterInvoker

protected ref ScriptInvoker m_OnEnterInvoker

private

Referenced by Enter(), and GetOnEnterInvoker().

m_OnLeaveInvoker

protected ref ScriptInvoker m_OnLeaveInvoker

private

Referenced by GetOnLeaveInvoker(), and Leave().

---

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

• P:/scripts/4_World/Entities/ScriptedEntities/Triggers/TriggerEvents.c