Класс Trigger

Scripted Trigger. Подробнее...

Граф наследования:Trigger:

Защищенные члены
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)

Защищенные данные
int	m_TriggerUpdateMs
Hologram	m_ParentObj
PlayerBase	m_Player

Закрытые члены
void	Trigger ()
	ctor
void	~Trigger ()
	dtor
IEntity events
Usage of IEntity events
override void	EOnInit (IEntity other, int extra)
	Set the default extents of the Trigger only once it is properly initialized.
override void	EOnFrame (IEntity other, float timeSlice)
	When an Object touches the Trigger, we want to register it being inside the Trigger -> Replaced by EOnEnter.
override void	EOnEnter (IEntity other, int extra)
	When an Object enters the trigger add it to Insiders.
override void	EOnLeave (IEntity other, int extra)
	When an Object exits the trigger remove it from Insiders.
Trigger configuration
Basic configuration and data API
void	SetExtents (vector mins, vector maxs)
	Set the size of the Trigger, avoid using SetCollisionBox directly.
float	GetRadius (vector min, vector max)
	Get the radius of the CollisionBox, simply left for backwards compatibility.
array< ref TriggerInsider >	GetInsiders ()
	Get the current TriggerInsider array, left for backwards compatibility, moved down from ManTrigger.
TriggerInsider	GetInsiderForObject (Object object)
	Gets the TriggerInsider for the Object if it exists.
int	GetInsiderIndexForObject (Object object)
	Gets the index in m_insiders for the Object.
Закрытые члены унаследованные от TriggerEvents
ScriptInvoker	GetOnEnterInvoker ()
ScriptInvoker	GetOnLeaveInvoker ()
void	Enter (TriggerInsider insider)
void	OnEnterBeginEvent (TriggerInsider insider)
void	OnEnterServerEvent (TriggerInsider insider)
void	OnEnterClientEvent (TriggerInsider insider)
void	OnEnterEndEvent (TriggerInsider insider)
void	StayStart (int nrOfInsiders)
void	OnStayStartBeginEvent (int nrOfInsiders)
void	OnStayStartServerEvent (int nrOfInsiders)
void	OnStayStartClientEvent (int nrOfInsiders)
void	OnStayStartEndEvent (int nrOfInsiders)
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)
void	StayFinish ()
void	OnStayFinishBeginEvent ()
void	OnStayFinishServerEvent ()
void	OnStayFinishClientEvent ()
void	OnStayFinishEndEvent ()
void	Leave (TriggerInsider insider)
void	OnLeaveBeginEvent (TriggerInsider insider)
void	OnLeaveServerEvent (TriggerInsider insider)
void	OnLeaveClientEvent (TriggerInsider insider)
void	OnLeaveEndEvent (TriggerInsider insider)

Закрытые данные
const int	TIMEOUT = 1000
	DEPRECATED.
ref array< ref TriggerInsider >	m_insiders
	The objects and their metadata which are currently inside the Trigger.
Закрытые данные унаследованные от TriggerEvents
ref ScriptInvoker	m_OnEnterInvoker
ref ScriptInvoker	m_OnLeaveInvoker

Подробное описание

Scripted Trigger.

Конструктор(ы)

Trigger()

void Trigger ( )

inlineprivate

ctor

    {
        SetEventMask(EntityEvent.INIT /*| EntityEvent.TOUCH*/ | EntityEvent.FRAME | EntityEvent.ENTER | EntityEvent.LEAVE );
        SetFlags(EntityFlags.TRIGGER, false);
        
        m_insiders = new array<ref TriggerInsider>;     
    }

Перекрестные ссылки m_insiders и SetFlags().

~Trigger()

void ~Trigger ( )

inlineprivate

dtor

    {
        #ifdef DIAG_DEVELOPER
        CleanupDebugShapes(dbgTargets);
        #endif
    }

Методы

AddInsider()

void AddInsider ( Object obj )

inlineprotected

Adding of new TriggerInsider.

    {
        if ( !obj )
            return; 
 
        // Already in?
        if ( GetInsiderForObject( obj ) )
        {
            Error(string.Format("[WARNING] :: [Trigger] :: [%1] :: Insider (%2) is already inside.", GetDebugName(this), GetDebugName(obj)));
            return;
        }
            
        // New Object entered! Fill the data.
        TriggerInsider insider = CreateInsider(obj);
        insider.timeStamp = g_Game.GetTime();
        insider.timeEntered = g_Game.GetTickTime();
        insider.lastUpdated = insider.timeEntered;
        
        // Don't add if it is going to be removed anyways..
        if ( ShouldRemoveInsider(insider) || ShouldRemoveInsiderNoLeave(insider) )
            return;
        
        // Keep track of the Object as long as it is inside the Trigger
        int index = m_insiders.Insert(insider);
        
        // Call the enter event to signal this Object entered
        Enter(insider);
        obj.OnEnterTrigger(this);
        
        #ifdef TRIGGER_DEBUG_NORMAL
        Debug.TriggerLog(string.Format("%1: inserted at index %2", GetDebugName(obj), index), "Trigger", "", "AddInsider", GetDebugName(this));
        #endif
    }

Перекрестные ссылки CreateInsider(), TriggerEvents::Enter(), Error(), g_Game, GetDebugName(), GetInsiderForObject(), TriggerInsider::lastUpdated, m_insiders, ShouldRemoveInsider(), ShouldRemoveInsiderNoLeave(), TriggerInsider::timeEntered, TriggerInsider::timeStamp и Debug::TriggerLog().

Используется в EOnEnter().

CanAddObjectAsInsider()

bool CanAddObjectAsInsider ( Object object )

inlineprotected

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

    {
        return true;
    }

Используется в EOnEnter().

CreateInsider()

TriggerInsider CreateInsider ( Object obj )

inlineprotected

Used for easily overriding TriggerInsider creation without rewriting AddInsider.

    {
        return new TriggerInsider(obj);
    }

Используется в AddInsider().

EOnEnter()

override void EOnEnter ( IEntity other, int extra )

inlineprivate

When an Object enters the trigger add it to Insiders.

    {
        Object obj;
        if (Class.CastTo(obj, other) && CanAddObjectAsInsider(obj))
            AddInsider(obj);
    }

Перекрестные ссылки AddInsider(), CanAddObjectAsInsider() и Class::CastTo().

EOnFrame()

override void EOnFrame ( IEntity other, float timeSlice )

inlineprivate

When an Object touches the Trigger, we want to register it being inside the Trigger -> Replaced by EOnEnter.

We want to update the insiders every frame (or do we?)

    {
        UpdateInsiders(TIMEOUT);
    }

Перекрестные ссылки TIMEOUT и UpdateInsiders().

EOnInit()

override void EOnInit ( IEntity other, int extra )

inlineprivate

Set the default extents of the Trigger only once it is properly initialized.

    {
        SetExtents("-2 -4 -2", "2 4 2");
    }

Перекрестные ссылки SetExtents().

EOnLeave()

override void EOnLeave ( IEntity other, int extra )

inlineprivate

When an Object exits the trigger remove it from Insiders.

    {
        Object obj;
        if (Class.CastTo(obj, other))
            RemoveInsiderByObject(obj);
    }

Перекрестные ссылки Class::CastTo() и RemoveInsiderByObject().

GetInsiderForObject()

TriggerInsider GetInsiderForObject ( Object object )

inlineprivate

Gets the TriggerInsider for the Object if it exists.

    {
        TriggerInsider ins;
        
        for ( int n = 0; n < m_insiders.Count(); ++n )
        {
            ins = m_insiders[n];
            if (ins.GetObject() == object)
                return ins;
        }
        
        return null;
    }

Перекрестные ссылки m_insiders.

Используется в AddInsider().

GetInsiderIndexForObject()

int GetInsiderIndexForObject ( Object object )

inlineprivate

Gets the index in m_insiders for the Object.

    {
        TriggerInsider ins;
        
        for ( int n = 0; n < m_insiders.Count(); ++n )
        {
            ins = m_insiders[n];
            if (ins.GetObject() == object)
                return n;
        }
        
        return -1;
    }

Перекрестные ссылки m_insiders.

GetInsiders()

array< ref TriggerInsider > GetInsiders ( )

inlineprivate

Get the current TriggerInsider array, left for backwards compatibility, moved down from ManTrigger.

    {
        return m_insiders;
    }

Перекрестные ссылки m_insiders.

Используется в ConstructionBoxTrigger::IsColliding().

GetRadius()

float GetRadius ( vector min, vector max )

inlineprivate

Get the radius of the CollisionBox, simply left for backwards compatibility.

    {
        return GetCollisionRadius();            
    }

OnEnter() [1/2]

override void OnEnter ( Object obj )

inlineprotected

    {
        //Print("OnEnter");
        if ( m_ParentObj )
        {
            m_ParentObj.SetIsCollidingPlayer( true );
            m_TriggerUpdateMs = 50;
        }
    }

Перекрестные ссылки m_ParentObj.

Используется в OnEnterBeginEvent().

OnEnter() [2/2]

void OnEnter ( Object obj )

inlineprotected

{}

OnEnterBeginEvent()

void OnEnterBeginEvent ( TriggerInsider insider )

inlineprotected

    {
        // Call the old event for backwards compatibility
        OnEnter(insider.GetObject());
    }

Перекрестные ссылки TriggerInsider::GetObject() и OnEnter().

OnLeave() [1/2]

override void OnLeave ( Object obj )

inlineprotected

    {
        //Print("OnLeave");
        if ( m_ParentObj )
        {
            m_ParentObj.SetIsCollidingPlayer( false );
        }
    }

Перекрестные ссылки m_ParentObj.

Используется в OnLeaveBeginEvent().

OnLeave() [2/2]

void OnLeave ( Object obj )

inlineprotected

{}

OnLeaveBeginEvent()

void OnLeaveBeginEvent ( TriggerInsider insider )

inlineprotected

    {
        // Call the old event for backwards compatibility
        OnLeave(insider.GetObject());
    }   

Перекрестные ссылки TriggerInsider::GetObject() и OnLeave().

OnRPC()

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

inlineprotected

    {   
        super.OnRPC(sender, rpc_type, ctx);
 
        #ifdef DIAG_DEVELOPER
        switch (rpc_type)
        {
            case ERPCs.DIAG_TRIGGER_DEBUG:
                DebugTriggerInfo data = new DebugTriggerInfo(vector.Zero, vector.Zero, vector.Zero, vector.Zero, 0, "", null);
            
                if (ctx.Read(data))
                    DebugDmgTrigger(data.param1, data.param2, data.param3, data.param4, data.param5, data.param6, data.param7);
            break;
        }
        #endif
    }

Перекрестные ссылки vector::Zero.

RemoveInsider()

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

inlineprotected

Removing of TriggerInsider.

    {
        Leave(insider);
        insider.GetObject().OnLeaveTrigger(this);
        
        #ifdef TRIGGER_DEBUG_NORMAL
        Debug.TriggerLog(string.Format("%1: removing at index %2", GetDebugName(insider.GetObject()), index), "Trigger", "", "RemoveInsider", GetDebugName(this));
        #endif  
        
        if (index >= 0)
            m_insiders.Remove(index);
        else
            m_insiders.RemoveItemUnOrdered(insider);
    }

Перекрестные ссылки GetDebugName(), TriggerInsider::GetObject(), TriggerEvents::Leave(), m_insiders и Debug::TriggerLog().

Используется в RemoveInsiderByObject() и UpdateInsiders().

RemoveInsiderByObject()

void RemoveInsiderByObject ( Object object )

inlineprotected

Removing of TriggerInsider through Object.

    {
        TriggerInsider ins;
        for ( int n = 0; n < m_insiders.Count(); ++n )
        {
            ins = m_insiders[n];
            if (ins.GetObject() == object)
            {
                RemoveInsider(ins, n);
                return;
            }
        }
        
        // As EOnLeave can call this, it is perfectly valid that this Object is not found on Script side
        // because of "ShouldRemoveInsider" and "ShouldRemoveInsiderNoLeave"
    }

Перекрестные ссылки m_insiders и RemoveInsider().

Используется в EOnLeave().

SetExtents()

void SetExtents ( vector mins, vector maxs )

inlineprivate

Set the size of the Trigger, avoid using SetCollisionBox directly.

    {
        SetCollisionBox(mins, maxs);
    }

Перекрестные ссылки SetCollisionBox().

Используется в CreateCollisionTrigger(), CreateTrigger(), TrapBase::CreateTrigger(), ManTrigger::EOnInit() и EOnInit().

SetParentObject()

void SetParentObject ( Hologram projection )

inlineprotected

    {
        m_ParentObj = projection;
    }

Перекрестные ссылки m_ParentObj.

SetParentOwner()

void SetParentOwner ( PlayerBase player )

inlineprotected

    {
        m_Player = player;
    }

Перекрестные ссылки m_Player.

ShouldRemoveInsider()

bool ShouldRemoveInsider ( TriggerInsider insider )

inlineprotected

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

    {
        return false;
    }

Используется в AddInsider() и UpdateInsiders().

ShouldRemoveInsiderNoLeave()

bool ShouldRemoveInsiderNoLeave ( TriggerInsider insider )

inlineprotected

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

    {
        return false;
    }

Используется в AddInsider() и UpdateInsiders().

UpdateInsiders() [1/2]

void UpdateInsiders ( int timeout )

inlineprotected

    {
        super.UpdateInsiders(m_TriggerUpdateMs);
    }

Используется в EOnFrame().

UpdateInsiders() [2/2]

void UpdateInsiders ( int timeout )

inlineprotected

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

    {
        #ifdef DIAG_DEVELOPER
        DebugSendDmgTrigger();
        #endif
 
        // Don't do anything if there aren't any insiders
        if ( m_insiders.Count() == 0 )
            return;
        
        // Mark the beginning of the update loop
        StayStart(m_insiders.Count());
        
        // Iterate over the current insiders, backwards because we are deleting
        for ( int n = m_insiders.Count() - 1; n >= 0 ; --n)
        {
            TriggerInsider insider = m_insiders.Get(n);
            Object obj = insider.GetObject();
            
            // Check if the Object still exists or should be removed without calling OnLeaveEvent
            if ( !obj || ShouldRemoveInsiderNoLeave(insider) )
            {
                #ifdef TRIGGER_DEBUG_BASIC
                Debug.TriggerLog(string.Format("%1: removed with no Leave.", GetDebugName(obj)), "Trigger", "", "UpdateInsiders", GetDebugName(this));
                #endif
                
                m_insiders.Remove(n);
                continue;
            }
            
            // Check if Object left the Trigger or should be removed regardless
            if ( ShouldRemoveInsider(insider) )
            {
                RemoveInsider(insider, n);
                continue;
            }
            
            // Call the OnStayEvent, Object is still inside the Trigger and can be updated
            // Pass in the time since the Object was last updated (or entered)
            float currentTime = g_Game.GetTickTime();
            Stay(insider, currentTime - insider.lastUpdated);
            insider.lastUpdated = currentTime;
        }
        
        // Mark the end of the update loop
        StayFinish();
    }

Перекрестные ссылки g_Game, GetDebugName(), TriggerInsider::GetObject(), TriggerInsider::lastUpdated, m_insiders, RemoveInsider(), ShouldRemoveInsider(), ShouldRemoveInsiderNoLeave(), TriggerEvents::Stay(), TriggerEvents::StayFinish(), TriggerEvents::StayStart() и Debug::TriggerLog().

Поля

m_insiders

ref array<ref TriggerInsider> m_insiders

private

The objects and their metadata which are currently inside the Trigger.

Используется в AddInsider(), GetInsiderForObject(), GetInsiderIndexForObject(), GetInsiders(), RemoveInsider(), RemoveInsiderByObject(), Trigger() и UpdateInsiders().

m_ParentObj

Hologram m_ParentObj

protected

m_Player

PlayerBase m_Player

protected

m_TriggerUpdateMs

int m_TriggerUpdateMs

protected

TIMEOUT

const int TIMEOUT = 1000

private

DEPRECATED.

Используется в EOnFrame().

---

Объявления и описания членов классов находятся в файлах:

• D:/Ishodniki/scripts/4_World/Classes/Hologram.c
• D:/Ishodniki/scripts/4_World/Entities/ScriptedEntities/Triggers/Trigger.c