Cori::World::TriggerBehaviour Class Reference

An abstract class meant to be used with Trigger component. Derive from it to create a trigger behaviour/script. More...

#include <TriggerBehaviour.hpp>

Public Member Functions
virtual	~TriggerBehaviour ()=default
virtual const char *	GetDebugName () const

Protected Member Functions
virtual void	OnEnter (Entity &visitor, Entity &trigger)
	Will be fired when an entity enter the Trigger zone.
virtual void	OnTickUpdate (Entity &visitor, Entity &trigger, float timestep)
	Fired every tick when an Entity is inside the Trigger zone. Expect for the very first tick the Entity entered the zone.
virtual void	OnExit (Entity &visitor, Entity &trigger)
	Fired very last tick when an Entity leaves the Trigger zone.

Detailed Description

An abstract class meant to be used with Trigger component. Derive from it to create a trigger behaviour/script.

Definition at line 15 of file TriggerBehaviour.hpp.

Constructor & Destructor Documentation

~TriggerBehaviour()

virtual Cori::World::TriggerBehaviour::~TriggerBehaviour ( )

virtualdefault

Member Function Documentation

GetDebugName()

virtual const char * Cori::World::TriggerBehaviour::GetDebugName ( ) const

inlinenodiscardvirtual

Definition at line 18 of file TriggerBehaviour.hpp.

OnEnter()

virtual void Cori::World::TriggerBehaviour::OnEnter ( Entity & visitor, Entity & trigger )

inlineprotectedvirtual

Will be fired when an entity enter the Trigger zone.

Parameters

visitor	Visitor Entity.
trigger	Trigger Entity. Owner of the Trigger object the behavior is bound to.

Definition at line 26 of file TriggerBehaviour.hpp.

OnExit()

virtual void Cori::World::TriggerBehaviour::OnExit ( Entity & visitor, Entity & trigger )

inlineprotectedvirtual

Fired very last tick when an Entity leaves the Trigger zone.

Parameters

visitor	Visitor Entity.
trigger	Trigger Entity. Owner of the Trigger object the behavior is bound to.

Definition at line 41 of file TriggerBehaviour.hpp.

OnTickUpdate()

virtual void Cori::World::TriggerBehaviour::OnTickUpdate ( Entity & visitor, Entity & trigger, float timestep )

inlineprotectedvirtual

Fired every tick when an Entity is inside the Trigger zone. Expect for the very first tick the Entity entered the zone.

Parameters

visitor	Visitor Entity.
trigger	Trigger Entity. Owner of the Trigger object the behavior is bound to.
timestep	Do i need to explain this?

Definition at line 34 of file TriggerBehaviour.hpp.

---

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

• TriggerBehaviour.hpp