TriggerEvents Class Reference

Inheritance diagram for TriggerEvents:

Collaboration diagram for TriggerEvents:

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

Protected Attributes
ref ScriptInvoker	m_OnEnterInvoker
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.

Definition at line 3 of file TriggerEvents.c.

Member Function Documentation

Enter()

void TriggerEvents::Enter ( TriggerInsider insider )

inlineprotected

Definition at line 26 of file TriggerEvents.c.

  {
#ifdef TRIGGER_DEBUG_BASIC
    Debug.TriggerLog(GetDebugName(insider.GetObject()), "TriggerEvents", "", "Enter", GetDebugName(this));
#endif
 
    OnEnterBeginEvent(insider);
 
    if (m_OnEnterInvoker)
      m_OnEnterInvoker.Invoke(insider);
 
    if (GetGame().IsServer())
      OnEnterServerEvent(insider);
    else
      OnEnterClientEvent(insider);
 
    OnEnterEndEvent(insider);
  }

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

Referenced by Trigger::AddInsider().

GetOnEnterInvoker()

ScriptInvoker TriggerEvents::GetOnEnterInvoker ( )

inlineprotected

Definition at line 8 of file TriggerEvents.c.

  {
    if (!m_OnEnterInvoker)
      m_OnEnterInvoker = new ScriptInvoker;
    return m_OnEnterInvoker;
  }

References m_OnEnterInvoker.

GetOnLeaveInvoker()

ScriptInvoker TriggerEvents::GetOnLeaveInvoker ( )

inlineprotected

Definition at line 15 of file TriggerEvents.c.

  {
    if (!m_OnLeaveInvoker)
      m_OnLeaveInvoker = new ScriptInvoker;
    return m_OnLeaveInvoker;
  }

References m_OnLeaveInvoker.

Leave()

void TriggerEvents::Leave ( TriggerInsider insider )

inlineprotected

Definition at line 129 of file TriggerEvents.c.

  {
#ifdef TRIGGER_DEBUG_BASIC
    Debug.TriggerLog(GetDebugName(insider.GetObject()), "TriggerEvents", "", "Leave", GetDebugName(this));
#endif
 
    OnLeaveBeginEvent(insider);
 
    if (m_OnLeaveInvoker)
      m_OnLeaveInvoker.Invoke(insider);
 
    if (GetGame() && GetGame().IsServer())
      OnLeaveServerEvent(insider);
    else
      OnLeaveClientEvent(insider);
 
    OnLeaveEndEvent(insider);
  }

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

Referenced by Trigger::RemoveInsider().

OnEnterBeginEvent()

void TriggerEvents::OnEnterBeginEvent ( TriggerInsider insider )

inlineprotected

Definition at line 44 of file TriggerEvents.c.

{}

Referenced by Enter().

OnEnterClientEvent()

void TriggerEvents::OnEnterClientEvent ( TriggerInsider insider )

inlineprotected

Definition at line 46 of file TriggerEvents.c.

{}

Referenced by Enter().

OnEnterEndEvent()

void TriggerEvents::OnEnterEndEvent ( TriggerInsider insider )

inlineprotected

Definition at line 47 of file TriggerEvents.c.

{}

Referenced by Enter().

OnEnterServerEvent()

void TriggerEvents::OnEnterServerEvent ( TriggerInsider insider )

inlineprotected

Definition at line 45 of file TriggerEvents.c.

{}

Referenced by Enter().

OnLeaveBeginEvent()

void TriggerEvents::OnLeaveBeginEvent ( TriggerInsider insider )

inlineprotected

Definition at line 147 of file TriggerEvents.c.

{}

Referenced by Leave().

OnLeaveClientEvent()

void TriggerEvents::OnLeaveClientEvent ( TriggerInsider insider )

inlineprotected

Definition at line 149 of file TriggerEvents.c.

{}

Referenced by Leave().

OnLeaveEndEvent()

void TriggerEvents::OnLeaveEndEvent ( TriggerInsider insider )

inlineprotected

Definition at line 150 of file TriggerEvents.c.

{}

Referenced by Leave().

OnLeaveServerEvent()

void TriggerEvents::OnLeaveServerEvent ( TriggerInsider insider )

inlineprotected

Definition at line 148 of file TriggerEvents.c.

{}

Referenced by Leave().

OnStayBeginEvent()

void TriggerEvents::OnStayBeginEvent ( TriggerInsider insider, float deltaTime )

inlineprotected

Definition at line 94 of file TriggerEvents.c.

{}

Referenced by Stay().

OnStayClientEvent()

void TriggerEvents::OnStayClientEvent ( TriggerInsider insider, float deltaTime )

inlineprotected

Definition at line 96 of file TriggerEvents.c.

{}

Referenced by Stay().

OnStayEndEvent()

void TriggerEvents::OnStayEndEvent ( TriggerInsider insider, float deltaTime )

inlineprotected

Definition at line 97 of file TriggerEvents.c.

{}

Referenced by Stay().

OnStayFinishBeginEvent()

void TriggerEvents::OnStayFinishBeginEvent ( )

inlineprotected

Definition at line 119 of file TriggerEvents.c.

{}

Referenced by StayFinish().

OnStayFinishClientEvent()

void TriggerEvents::OnStayFinishClientEvent ( )

inlineprotected

Definition at line 121 of file TriggerEvents.c.

{}

Referenced by StayFinish().

OnStayFinishEndEvent()

void TriggerEvents::OnStayFinishEndEvent ( )

inlineprotected

Definition at line 122 of file TriggerEvents.c.

{}

Referenced by StayFinish().

OnStayFinishServerEvent()

void TriggerEvents::OnStayFinishServerEvent ( )

inlineprotected

Definition at line 120 of file TriggerEvents.c.

{}

Referenced by StayFinish().

OnStayServerEvent()

void TriggerEvents::OnStayServerEvent ( TriggerInsider insider, float deltaTime )

inlineprotected

Definition at line 95 of file TriggerEvents.c.

{}

Referenced by Stay().

OnStayStartBeginEvent()

void TriggerEvents::OnStayStartBeginEvent ( int nrOfInsiders )

inlineprotected

Definition at line 69 of file TriggerEvents.c.

{}

Referenced by StayStart().

OnStayStartClientEvent()

void TriggerEvents::OnStayStartClientEvent ( int nrOfInsiders )

inlineprotected

Definition at line 71 of file TriggerEvents.c.

{}

Referenced by StayStart().

OnStayStartEndEvent()

void TriggerEvents::OnStayStartEndEvent ( int nrOfInsiders )

inlineprotected

Definition at line 72 of file TriggerEvents.c.

{}

Referenced by StayStart().

OnStayStartServerEvent()

void TriggerEvents::OnStayStartServerEvent ( int nrOfInsiders )

inlineprotected

Definition at line 70 of file TriggerEvents.c.

{}

Referenced by StayStart().

Stay()

void TriggerEvents::Stay ( TriggerInsider insider, float deltaTime )

inlineprotected

Definition at line 79 of file TriggerEvents.c.

  {
#ifdef TRIGGER_DEBUG_SPAM
    Debug.TriggerLog(GetDebugName(insider.GetObject()), "TriggerEvents", "", "Stay", GetDebugName(this));
#endif
 
    OnStayBeginEvent(insider, deltaTime);
 
    if (GetGame().IsServer())
      OnStayServerEvent(insider, deltaTime);
    else
      OnStayClientEvent(insider, deltaTime);
 
    OnStayEndEvent(insider, deltaTime);
  }

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

Referenced by Trigger::UpdateInsiders().

StayFinish()

void TriggerEvents::StayFinish ( )

inlineprotected

Definition at line 104 of file TriggerEvents.c.

  {
#ifdef TRIGGER_DEBUG_SPAM
    Debug.TriggerLog("", "TriggerEvents", "", "StayFinish", GetDebugName(this));
#endif
 
    OnStayFinishBeginEvent();
 
    if (GetGame().IsServer())
      OnStayFinishServerEvent();
    else
      OnStayFinishClientEvent();
 
    OnStayFinishEndEvent();
  }

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

Referenced by Trigger::UpdateInsiders().

StayStart()

void TriggerEvents::StayStart ( int nrOfInsiders )

inlineprotected

Definition at line 54 of file TriggerEvents.c.

  {
#ifdef TRIGGER_DEBUG_SPAM
    Debug.TriggerLog(nrOfInsiders.ToString(), "TriggerEvents", "", "StayStart", GetDebugName(this));
#endif
 
    OnStayStartBeginEvent(nrOfInsiders);
 
    if (GetGame().IsServer())
      OnStayStartServerEvent(nrOfInsiders);
    else
      OnStayStartClientEvent(nrOfInsiders);
 
    OnStayStartEndEvent(nrOfInsiders);
  }

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

Referenced by Trigger::UpdateInsiders().

Member Data Documentation

m_OnEnterInvoker

ref ScriptInvoker TriggerEvents::m_OnEnterInvoker

protected

Definition at line 5 of file TriggerEvents.c.

Referenced by Enter(), and GetOnEnterInvoker().

m_OnLeaveInvoker

ref ScriptInvoker TriggerEvents::m_OnLeaveInvoker

protected

Definition at line 6 of file TriggerEvents.c.

Referenced by GetOnLeaveInvoker(), and Leave().

---

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

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