core::map::Event Struct Reference

Represents an event in a Map. A script that is run on a trigger within a given region. More...

#include <Event.hpp>

Public Types
enum class	Trigger : std::uint8_t {   OnEnter = 1 , OnExit = 2 , onEnterOrExit = 3 , WhileIn = 4 ,   OnInteract = 5 }
	What action triggers the event. More...

Public Member Functions
	Event ()
	Creates an empty event. More...
	Event (const std::string &script, const sf::Vector2i &pos, const sf::Vector2i &size, Trigger trigger)
	Creates an event from the given parameters. More...

Public Attributes
Trigger	trigger
sf::Vector2i	position
sf::Vector2i	areaSize
std::string	script

Detailed Description

Represents an event in a Map. A script that is run on a trigger within a given region.

Definition at line 19 of file Event.hpp.

Member Enumeration Documentation

Trigger

enum core::map::Event::Trigger : std::uint8_t

strong

What action triggers the event.

Enumerator
OnEnter	The event triggers when the player steps into the zone.
OnExit	The event triggers when the player steps out of the zone.
onEnterOrExit	The event triggers when the player either enters or exits the zone.
WhileIn	The event triggers repeatedly while the player is in the zone.
OnInteract	The event triggers when the player interacts with the zone.

Definition at line 21 of file Event.hpp.

Constructor & Destructor Documentation

Event() [1/2]

core::map::Event::Event

(

)

Creates an empty event.

Definition at line 7 of file Event.cpp.

Event() [2/2]

core::map::Event::Event	(	const std::string &	script,
		const sf::Vector2i &	pos,
		const sf::Vector2i &	size,
		Trigger	trigger
	)

Creates an event from the given parameters.

Parameters

script	The script to run when triggered
pos	The position of the event trigger zone, in tiles
size	The size of the event trigger zone, in tiles
trigger	The trigger that starts the event

Definition at line 10 of file Event.cpp.

Member Data Documentation

areaSize

sf::Vector2i core::map::Event::areaSize

Definition at line 40 of file Event.hpp.

position

sf::Vector2i core::map::Event::position

Definition at line 39 of file Event.hpp.

script

std::string core::map::Event::script

Definition at line 41 of file Event.hpp.

trigger

Trigger core::map::Event::trigger

Definition at line 38 of file Event.hpp.

---

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

• include/Core/Maps/Event.hpp
• src/Core/Maps/Event.cpp