WarpArea Class Reference

Defines a warp area that links to another Map. More...

#include <WarpArea.h>

List of all members.

Public Member Functions
	WarpArea (const Recti &rect, const string &id, const string &dstMap, int dstX, int dstY, int lvl, int dstlvl)
const string &	getId () const
const string &	getLink () const
const Recti &	getRect () const
int	getDestinationX () const
int	getDestinationY () const
int	getDestinationLevel () const
int	getLevel () const
bool	isActive () const
void	isActive (bool active)
bool	isValid () const
void	isValid (bool valid)
Private Attributes
Recti	mRect
string	mId
string	mLink
int	mLevel
int	mDestLevel
int	mDestX
int	mDestY
bool	mActive
bool	mValid

---

Detailed Description

Defines a warp area that links to another Map.

---

Constructor & Destructor Documentation

WarpArea::WarpArea	(	const Recti &	rect,
		const string &	id,
		const string &	dstMap,
		int	dstX,
		int	dstY,
		int	lvl,
		int	dstlvl
	)			[inline]

Initializes a new WarpArea.

Parameters:

	rect	A Recti containing the rectangular area this WarpArea covers.
	dstMap	A string specifying a destination map.
	dstX	X-Coordinate to start the player at the destination map.
	dstY	X-Coordinate to start the player at the destination map.
	lvl	The level this WarpArea resides on.
	dstlvl	The destination level this WarpArea puts players on.

---

Member Function Documentation

int WarpArea::getDestinationLevel

(

)

const [inline]

Gets the destination level.

int WarpArea::getDestinationX

(

)

const [inline]

Gets the destination X-Coordinate.

int WarpArea::getDestinationY

(

)

const [inline]

Gets the destination Y-Coordinate.

const string& WarpArea::getId

(

)

const [inline]

Gets the ID of the WarpArea.

int WarpArea::getLevel

(

)

const [inline]

Gets the level that this WarpArea resides on.

const string& WarpArea::getLink

(

)

const [inline]

Gets the map the WarpArea links to.

const Recti& WarpArea::getRect

(

)

const [inline]

Gets the rectangular area the WarpArea covers.

void WarpArea::isActive

(

bool

active

)

[inline]

Sets whether the WarpArea is active or not.

bool WarpArea::isActive

(

)

const [inline]

Gets whether the WarpArea is active or not.

void WarpArea::isValid

(

bool

valid

)

[inline]

Sets whether the WarpArea is valid or not.

bool WarpArea::isValid

(

)

const [inline]

Indicates if the warp area's link to a map file is valid.

---

Member Data Documentation

bool WarpArea::mActive [private]

int WarpArea::mDestLevel [private]

int WarpArea::mDestX [private]

int WarpArea::mDestY [private]

string WarpArea::mId [private]

int WarpArea::mLevel [private]

string WarpArea::mLink [private]

Recti WarpArea::mRect [private]

bool WarpArea::mValid [private]

---

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

• C:/Development/LoM/client/src/Core/Map/Components/WarpArea.h