GEJM  1.0.0.0
a 2D platformer made by students
Public Member Functions | List of all members
Trigger Class Reference

#include <Trigger.h>

Inheritance diagram for Trigger:
SolidObject Object

Public Member Functions

 Trigger (Game *const gameObject, void(Game::*onTrigger)(), void(Game::*onStartTouch)(), void(Game::*onEndTouch)(), double x=0.0, double y=0.0, double width=3.0, double height=3.0, bool triggerOnce=true)
 
 ~Trigger ()
 
void trigger ()
 
void untrigger ()
 
Triggeroperator= (Trigger const &)=delete
 
- Public Member Functions inherited from SolidObject
 SolidObject (double x=0.0, double y=0.0, double width=1.0, double height=1.0)
 
virtual ~SolidObject ()
 
- Public Member Functions inherited from Object
 Object (double x=0.0, double y=0.0, double width=1.0, double height=1.0)
 
virtual ~Object ()
 
virtual void savePrevious ()
 
void destroy ()
 
double getY () const
 
double getX () const
 
double getWidth () const
 
double getHeight () const
 
double getPrevX () const
 
double getPrevY () const
 
bool getDestroyed () const
 

Additional Inherited Members

- Protected Attributes inherited from Object
double x
 
double y
 
double width
 
double height
 
double prevX
 
double prevY
 
bool destroyed
 

Detailed Description

Trigger is an object that executes a function when colliding with PlayerCreature. It derives from SolidObject.

Constructor & Destructor Documentation

Trigger::Trigger ( Game *const  gameObject,
void(Game::*)()  onTrigger,
void(Game::*)()  onStartTouch,
void(Game::*)()  onEndTouch,
double  x = 0.0,
double  y = 0.0,
double  width = 3.0,
double  height = 3.0,
bool  triggerOnce = true 
)

Trigger constructor that sets position and size of a Trigger.

Parameters
gameObjectA constant pointer to Game object.
onTriggerA pointer to Game's member function that's called while triggered. If triggerOnce is set, onTrigger is basically the same as onStartTouch.
onStartTouchA pointer to Game's member function that's called whenever PlayerCreature enters trigger.
onEndTouchA pointer to Game's member function that's called whenever PlayerCreature leaves trigger.
xX position of Trigger. Defaults to 0.0.
yY position of Trigger. Defaults to 0.0.
widthWidth of Trigger. Defaults to 3.0.
heightHeight of Trigger. Defaults to 3.0.
triggerOnceIf you want to use trigger multiple times set to false. Otherwise trigger will fire only once.
See also
SolidObject
Game

Trigger implementation Trigger constructor that sets position and size of a Trigger.

Parameters
gameObjectA constant pointer to Game object.
onTriggerA pointer to Game's member function that's called while triggered. If triggerOnce is set, onTrigger is basically the same as onStartTouch.
onStartTouchA pointer to Game's member function that's called whenever PlayerCreature enters trigger.
onEndTouchA pointer to Game's member function that's called whenever PlayerCreature leaves trigger.
xX position of Trigger. Defaults to 0.0.
yY position of Trigger. Defaults to 0.0.
widthWidth of Trigger. Defaults to 3.0.
heightHeight of Trigger. Defaults to 3.0.
triggerOnceIf you want to use trigger multiple times set to false. Otherwise trigger will fire only once.
See also
SolidObject
Game
Trigger::~Trigger ( )

Trigger destructor.

Member Function Documentation

Trigger& Trigger::operator= ( Trigger const &  )
delete

Assignment operator is deleted because Trigger has constant variable.

void Trigger::trigger ( )

Fire when something collides with trigger.

void Trigger::untrigger ( )

Fire when something stops collision with trigger.


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