TriggerRepeat Class Reference

Trigger that can be executed multiple times. More...

#include <TriggerRepeat.hpp>

Inheritance diagram for TriggerRepeat:

Public Member Functions
	TriggerRepeat ()
	Constructor. More...
	~TriggerRepeat ()
	Destructor. More...
void	OnEnter ()
void	OnRetain ()
void	OnLeave ()
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...
std::vector< std::string > *	GetTargetFunction ()
	Vector containing name of target functions. More...
bool	GetStartActive () const
	Get if the trigger starts active or not. More...
void	SetStartActive (bool value)
	Set if the trigger starts 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...
float	GetCooldown () const
	Get the cooldown before the trigger can get activated again. More...
void	SetCooldown (float value)
	Set the cooldown before the trigger can get activated again. More...
int	GetTriggerCharges () const
	Get the amount of times a trigger can be activated before it is no longer active. More...
void	SetTriggerCharges (int value)
	Set the amount of times a trigger can be activated before it is no longer active. More...
std::vector< Entity * > *	GetTargetEntity ()
	Vector containing target entities. More...
std::vector< Entity * > *	GetCollidedEntity ()
	Vector containing collided entities. More...
std::vector< triggerEvent::EventStruct > *	GetEventVector ()
	Vector containing the event data. More...
const Entity *	GetOwningEntity () const
	Get the entity this component belongs to. More...
void	SetOwningEntity (Entity *value)
	Set the entity this component belongs to. More...
void	Process () override
	Process the trigger in case of collision. More...
void	Update () override
	Update position for trigger volume. More...
Json::Value	Save () override
	Save the trigger. More...
void	InitTriggerUID () override
	Initialize entity references for triggers via entity UIDs. More...
void	InitiateVolumes () override
	Initialize volumes for triggers. More...
void	SetCollidedEntityUID (int value)
	Set UID for this triggers collided entity. More...
int	GetCollidedEntityUID ()
	Get UID for this triggers collided entity. More...
Public Member Functions inherited from SuperTrigger
	SuperTrigger ()
	Create new SuperTrigger. More...
virtual	~SuperTrigger ()
	Destructor. More...

Friends
class	::TriggerManager
class	::Component::Trigger

Detailed Description

Trigger that can be executed multiple times.

Constructor & Destructor Documentation

TriggerRepeat()

TriggerRepeat::TriggerRepeat

(

)

Constructor.

~TriggerRepeat()

TriggerRepeat::~TriggerRepeat

(

)

Destructor.

Todo:

: Vector support

Member Function Documentation

GetCollidedEntity()

std::vector< Entity * > * TriggerRepeat::GetCollidedEntity

(

)

Vector containing collided entities.

Returns

Pointer to the vector containing collided entities.

GetCollidedEntityUID()

int TriggerRepeat::GetCollidedEntityUID

(

)

Get UID for this triggers collided entity.

Returns

int unique identifier for collided entity.

GetCooldown()

float TriggerRepeat::GetCooldown

(

)

const

Get the cooldown before the trigger can get activated again.

Returns

The cooldown before the trigger can get activated again.

GetDelay()

float TriggerRepeat::GetDelay

(

)

const

Get the delay before the trigger gets active.

Returns

The delay before the trigger gets active.

GetEventVector()

std::vector< triggerEvent::EventStruct > * TriggerRepeat::GetEventVector

(

)

Vector containing the event data.

Returns

Pointer to the vector containing event data.

GetName()

const std::string & TriggerRepeat::GetName

(

)

const

Get the name of the trigger.

Returns

The name of the trigger.

GetOwningEntity()

const Entity * TriggerRepeat::GetOwningEntity

(

)

const

Get the entity this component belongs to.

Returns

The entity this component belongs to.

GetStartActive()

bool TriggerRepeat::GetStartActive

(

)

const

Get if the trigger starts active or not.

Returns

If the trigger starts active or not.

GetTargetEntity()

std::vector< Entity * > * TriggerRepeat::GetTargetEntity

(

)

Vector containing target entities.

Returns

Pointer to the vector containing target entities.

GetTargetFunction()

std::vector< std::string > * TriggerRepeat::GetTargetFunction

(

)

Vector containing name of target functions.

Returns

Pointer to the vector containing name of target functions.

GetTriggerCharges()

int TriggerRepeat::GetTriggerCharges

(

)

const

Get the amount of times a trigger can be activated before it is no longer active.

Returns

The amount of times a trigger can be activated before it is no longer active.

InitiateVolumes()

void TriggerRepeat::InitiateVolumes ( )

overridevirtual

Initialize volumes for triggers.

Implements SuperTrigger.

InitTriggerUID()

void TriggerRepeat::InitTriggerUID ( )

overridevirtual

Initialize entity references for triggers via entity UIDs.

Implements SuperTrigger.

OnEnter()

void TriggerRepeat::OnEnter

(

)

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

OnLeave()

void TriggerRepeat::OnLeave

(

)

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

OnRetain()

void TriggerRepeat::OnRetain

(

)

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

Process()

void TriggerRepeat::Process ( )

overridevirtual

Process the trigger in case of collision.

Implements SuperTrigger.

Save()

Json::Value TriggerRepeat::Save ( )

overridevirtual

Save the trigger.

Returns

JSON value to be stored on disk.

Implements SuperTrigger.

SetCollidedEntityUID()

void TriggerRepeat::SetCollidedEntityUID

(

int

value

)

Set UID for this triggers collided entity.

Parameters

value

Set UID for collided entity.

SetCooldown()

void TriggerRepeat::SetCooldown

(

float

value

)

Set the cooldown before the trigger can get activated again.

Parameters

value

The cooldown before the trigger can get activated again.

SetDelay()

void TriggerRepeat::SetDelay

(

float

value

)

Set the delay before the trigger gets active.

Parameters

value

The delay before the trigger gets active.

SetName()

void TriggerRepeat::SetName

(

const std::string &

value

)

Set the name of the trigger.

Parameters

value

The name of the trigger.

SetOwningEntity()

void TriggerRepeat::SetOwningEntity

(

Entity *

value

)

Set the entity this component belongs to.

Parameters

value

The entity this component belongs to.

SetStartActive()

void TriggerRepeat::SetStartActive

(

bool

value

)

Set if the trigger starts active or not.

Parameters

value

If the trigger starts active or not.

SetTriggerCharges()

void TriggerRepeat::SetTriggerCharges

(

int

value

)

Set the amount of times a trigger can be activated before it is no longer active.

Parameters

value

The amount of times a trigger can be activated before it is no longer active.

Update()

void TriggerRepeat::Update ( )

overridevirtual

Update position for trigger volume.

Implements SuperTrigger.

Friends And Related Function Documentation

::Component::Trigger

friend class ::Component::Trigger

friend

::TriggerManager

friend class ::TriggerManager

friend

---

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

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