TriggerOnce Class Reference

Trigger that can be executed once before going inactive. More...

#include <TriggerOnce.hpp>

Inheritance diagram for TriggerOnce:

Public Member Functions
	TriggerOnce ()
	~TriggerOnce ()
void	OnEnter ()
void	OnLeave ()
void	OnRemain ()
const std::string &	GetName () const
	Get the name of the trigger. More...
void	SetName (const std::string &value)
	Set the name of the trigger. More...
const std::string &	GetTargetFunction () const
	Get name of target function. More...
void	SetTargetFunction (const std::string &value)
	Set name of target function. More...
bool	GetStartActive () const
	If trigger is starting active or not. More...
void	SetStartActive (bool value)
	Set if trigger is starting active or not. More...
float	GetDelay () const
	Get the delay before the trigger gets active. More...
void	SetDelay (float value)
	Set the delay before the trigger gets active. More...
Entity *	GetTargetEntity ()
	Pointer to target entity. More...
void	SetTargetEntity (Entity *value)
	Set pointer to target entity. More...
Entity *	GetCollidedEntity ()
	Pointer to collided entity. More...
void	SetCollidedEntity (Entity *value)
	Set pointer to collided entity. More...
Public Member Functions inherited from SuperTrigger
	SuperTrigger ()
	Create new SuperTrigger. More...
virtual	~SuperTrigger ()
	Destructor. More...
virtual void	Process ()=0
	Process the trigger in case of collision. More...
virtual void	Update ()=0
	Update position for trigger volume. More...
virtual Json::Value	Save ()=0
	Save the trigger. More...
virtual void	InitTriggerUID ()=0
	Initialize entity references for triggers via entity UIDs. More...
virtual void	InitiateVolumes ()=0
	Initialize volumes for triggers. More...

Detailed Description

Trigger that can be executed once before going inactive.

Constructor & Destructor Documentation

TriggerOnce()

TriggerOnce::TriggerOnce

(

)

PLEASE DO NOT USE THIS. THIS CLASS IS STILL UNDER CONSTRUCTION. PLEASE DO NOT USE THIS.

~TriggerOnce()

TriggerOnce::~TriggerOnce

(

)

Member Function Documentation

GetCollidedEntity()

Entity * TriggerOnce::GetCollidedEntity

(

)

Pointer to collided entity.

Returns

Pointer to collided entity.

GetDelay()

float TriggerOnce::GetDelay

(

)

const

Get the delay before the trigger gets active.

Returns

The delay before the trigger gets active.

GetName()

const std::string & TriggerOnce::GetName

(

)

const

Get the name of the trigger.

Returns

The name of the trigger.

GetStartActive()

bool TriggerOnce::GetStartActive

(

)

const

If trigger is starting active or not.

Returns

If trigger is starting active or not.

GetTargetEntity()

Entity * TriggerOnce::GetTargetEntity

(

)

Pointer to target entity.

Returns

Pointer to target entity.

GetTargetFunction()

const std::string & TriggerOnce::GetTargetFunction

(

)

const

Get name of target function.

Returns

Name of target function.

OnEnter()

void TriggerOnce::OnEnter

(

)

Setup the trigger to listen for enter events on the trigger volume, forgetting any previously set listener

OnLeave()

void TriggerOnce::OnLeave

(

)

Setup the trigger to listen for retain events on the trigger volume, forgetting any previously set listener

OnRemain()

void TriggerOnce::OnRemain

(

)

Setup the trigger to listen for leave events on the trigger volume, forgetting any previously set listener

SetCollidedEntity()

void TriggerOnce::SetCollidedEntity

(

Entity *

value

)

Set pointer to collided entity.

Parameters

value

Pointer to collided entity.

SetDelay()

void TriggerOnce::SetDelay

(

float

value

)

Set the delay before the trigger gets active.

Parameters

value

The delay before the trigger gets active.

SetName()

void TriggerOnce::SetName

(

const std::string &

value

)

Set the name of the trigger.

Parameters

value

The name of the trigger.

SetStartActive()

void TriggerOnce::SetStartActive

(

bool

value

)

Set if trigger is starting active or not.

Parameters

value

If trigger is starting active or not.

SetTargetEntity()

void TriggerOnce::SetTargetEntity

(

Entity *

value

)

Set pointer to target entity.

Parameters

value

Pointer to target entity.

SetTargetFunction()

void TriggerOnce::SetTargetFunction

(

const std::string &

value

)

Set name of target function.

Parameters

value

Name of target function.

---

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

• src/Engine/Trigger/TriggerOnce.hpp
• src/Engine/Trigger/TriggerOnce.cpp