Trigger Class Reference

Scripted Trigger. More...

Inheritance diagram for Trigger:

Protected Member Functions
override void	OnEnter (Object obj)
override void	OnLeave (Object obj)
void	UpdateInsiders (int timeout)
void	SetParentObject (Hologram projection)
void	SetParentOwner (PlayerBase player)
TriggerEvents, backwards compatibility calling
Implementation for backwards compatibility with old Trigger system
void	OnEnterBeginEvent (TriggerInsider insider)
void	OnLeaveBeginEvent (TriggerInsider insider)
DEPRECATED Events
left for backwards compatibility
void	OnEnter (Object obj)
void	OnLeave (Object obj)
TriggerInsider conditions
Conditions applied to TriggerInsider for if it can be added or should be removed
bool	CanAddObjectAsInsider (Object object)
	Condition whether an Object can be added as TriggerInsider (checked before calling AddInsider)
bool	ShouldRemoveInsider (TriggerInsider insider)
	Condition whether a TriggerInsider should still be updated or not (checked in update loop and before adding)
bool	ShouldRemoveInsiderNoLeave (TriggerInsider insider)
	Condition whether a TriggerInsider should still be updated or not, skips OnLeaveEvent (checked in update loop and before adding)
TriggerInsider processing
Logic and processing of adding, removing and updating a TriggerInsider
TriggerInsider	CreateInsider (Object obj)
	Used for easily overriding TriggerInsider creation without rewriting AddInsider.
void	AddInsider (Object obj)
	Adding of new TriggerInsider.
void	RemoveInsider (TriggerInsider insider, int index=-1)
	Removing of TriggerInsider.
void	RemoveInsiderByObject (Object object)
	Removing of TriggerInsider through Object.
void	UpdateInsiders (int timeout)
	Update the current TriggerInsider inside the Trigger, timeout paramter is deprecated.
DEBUGGING
General internal debugging functionality
override void	OnRPC (PlayerIdentity sender, int rpc_type, ParamsReadContext ctx)

Protected Attributes
int	m_TriggerUpdateMs
Hologram	m_ParentObj
PlayerBase	m_Player

Detailed Description

Scripted Trigger.

Definition at line 1 of file damagetrigger.c.

Member Function Documentation

AddInsider()

void Trigger::AddInsider ( Object obj )

protected

Adding of new TriggerInsider.

Definition at line 228 of file trigger.c.

CanAddObjectAsInsider()

bool Trigger::CanAddObjectAsInsider ( Object object )

protected

Condition whether an Object can be added as TriggerInsider (checked before calling AddInsider)

Definition at line 198 of file trigger.c.

CreateInsider()

TriggerInsider Trigger::CreateInsider ( Object obj )

protected

Used for easily overriding TriggerInsider creation without rewriting AddInsider.

Definition at line 222 of file trigger.c.

OnEnter() [1/2]

override void Trigger::OnEnter ( Object obj )

protected

Definition at line 1576 of file hologram.c.

OnEnter() [2/2]

void Trigger::OnEnter ( Object obj )

protected

Definition at line 187 of file trigger.c.

OnEnterBeginEvent()

void Trigger::OnEnterBeginEvent ( TriggerInsider insider )

protected

Definition at line 169 of file trigger.c.

OnLeave() [1/2]

override void Trigger::OnLeave ( Object obj )

protected

Definition at line 1586 of file hologram.c.

OnLeave() [2/2]

void Trigger::OnLeave ( Object obj )

protected

Definition at line 189 of file trigger.c.

OnLeaveBeginEvent()

void Trigger::OnLeaveBeginEvent ( TriggerInsider insider )

protected

Definition at line 175 of file trigger.c.

OnRPC()

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

protected

Definition at line 350 of file trigger.c.

RemoveInsider()

void Trigger::RemoveInsider ( TriggerInsider insider, int index = -1 )

protected

Removing of TriggerInsider.

Definition at line 263 of file trigger.c.

RemoveInsiderByObject()

void Trigger::RemoveInsiderByObject ( Object object )

protected

Removing of TriggerInsider through Object.

Definition at line 279 of file trigger.c.

SetParentObject()

void Trigger::SetParentObject ( Hologram projection )

protected

Definition at line 1600 of file hologram.c.

SetParentOwner()

void Trigger::SetParentOwner ( PlayerBase player )

protected

Definition at line 1605 of file hologram.c.

ShouldRemoveInsider()

bool Trigger::ShouldRemoveInsider ( TriggerInsider insider )

protected

Condition whether a TriggerInsider should still be updated or not (checked in update loop and before adding)

Definition at line 204 of file trigger.c.

ShouldRemoveInsiderNoLeave()

bool Trigger::ShouldRemoveInsiderNoLeave ( TriggerInsider insider )

protected

Condition whether a TriggerInsider should still be updated or not, skips OnLeaveEvent (checked in update loop and before adding)

Definition at line 210 of file trigger.c.

UpdateInsiders() [1/2]

void Trigger::UpdateInsiders ( int timeout )

protected

Definition at line 1595 of file hologram.c.

UpdateInsiders() [2/2]

void Trigger::UpdateInsiders ( int timeout )

protected

Update the current TriggerInsider inside the Trigger, timeout paramter is deprecated.

Definition at line 297 of file trigger.c.

Member Data Documentation

m_ParentObj

Hologram Trigger::m_ParentObj

protected

Definition at line 1573 of file hologram.c.

m_Player

PlayerBase Trigger::m_Player

protected

Definition at line 1574 of file hologram.c.

m_TriggerUpdateMs

int Trigger::m_TriggerUpdateMs

protected

Definition at line 1572 of file hologram.c.

---

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

• Daten/4_world/classes/basebuilding/damagetrigger.c
• Daten/4_world/classes/hologram.c
• Daten/4_world/classes/traptrigger.c
• Daten/4_world/entities/scriptedentities/triggers/trigger.c
• Daten/4_world/entities/scriptedentities.c