DOL.GS.AbstractArea Class Reference

AbstractArea extend this if you wish to implement e new custom area. For examples see Area.Cricle, Area.Square. More...

Inheritance diagram for DOL.GS.AbstractArea:

List of all members.

Public Member Functions
	AbstractArea (string desc)
	Constructs a new AbstractArea.
void	UnRegisterPlayerEnter (DOLEventHandler callback)
void	UnRegisterPlayerLeave (DOLEventHandler callback)
void	RegisterPlayerEnter (DOLEventHandler callback)
void	RegisterPlayerLeave (DOLEventHandler callback)
abstract bool	IsIntersectingZone (Zone zone)
	Checks wether area intersects with given zone.
abstract bool	IsContaining (IPoint3D spot)
	Checks wether given spot is within areas boundaries or not.
abstract bool	IsContaining (IPoint3D spot, bool checkZ)
abstract bool	IsContaining (int x, int y, int z)
abstract bool	IsContaining (int x, int y, int z, bool checkZ)
virtual void	OnPlayerLeave (GamePlayer player)
	Called whenever a player leaves the given area.
virtual void	OnPlayerEnter (GamePlayer player)
	Called whenever a player enters the given area.
abstract void	LoadFromDatabase (DBArea area)
Public Attributes
const ushort	MAX_AREAS_PER_ZONE = 50
	Constant holding max number of areas per zone, increase if more ares are needed, this will slightly increase memory usage on server.
Protected Attributes
DBArea	m_dbArea = null
bool	m_canBroadcast = false
bool	m_checkLOS = false
bool	m_displayMessage = true
bool	m_safeArea = false
ushort	m_ID
	The ID of the Area eg. 15 ( == index in Region.m_areas array)
string	m_Description
	The description of the Area eg. "Camelot Hills".
byte	m_sound
	The area sound to play on enter/leave events.
Properties
bool	CanBroadcast [get, set]
	Variable holding whether or not players can broadcast in this area.
bool	CheckLOS [get, set]
	Variable holding whether or not to check for LOS for spells in this area.
virtual bool	DisplayMessage [get, set]
	Display entered message.
bool	IsSafeArea [get, set]
	Can players be attacked by other players in this area.
ushort	ID [get, set]
	Returns the ID of this Area.
string	Description [get]
	Return the description of this Area.
byte	Sound [get, set]
	Gets or sets the area sound.

---

Detailed Description

AbstractArea extend this if you wish to implement e new custom area. For examples see Area.Cricle, Area.Square.

---

Constructor & Destructor Documentation

DOL.GS.AbstractArea.AbstractArea

(

string

desc

)

Constructs a new AbstractArea.

Parameters:

desc

---

Member Function Documentation

abstract bool DOL.GS.AbstractArea.IsContaining

(

IPoint3D

spot

)

[pure virtual]

Checks wether given spot is within areas boundaries or not.

Parameters:

spot

Returns:

Implements DOL.GS.IArea.

Implemented in DOL.GS.Area.Square, DOL.GS.Area.Circle, and DOL.GS.Area.Polygon.

abstract bool DOL.GS.AbstractArea.IsIntersectingZone

(

Zone

zone

)

[pure virtual]

Checks wether area intersects with given zone.

Parameters:

zone

Returns:

Implements DOL.GS.IArea.

Implemented in DOL.GS.Area.Square, DOL.GS.Area.Circle, and DOL.GS.Area.Polygon.

virtual void DOL.GS.AbstractArea.OnPlayerEnter

(

GamePlayer

player

)

[virtual]

Called whenever a player enters the given area.

Parameters:

player

Implements DOL.GS.IArea.

Reimplemented in DOL.GS.Keeps.KeepArea, DOL.GS.GameRelicPad.PadArea, DOL.GS.Quests.QuestSearchArea, and DOL.GS.Relics.RelicPad.Surface.

virtual void DOL.GS.AbstractArea.OnPlayerLeave

(

GamePlayer

player

)

[virtual]

Called whenever a player leaves the given area.

Parameters:

player

Implements DOL.GS.IArea.

Reimplemented in DOL.GS.Relics.RelicPad.Surface.

---

Member Data Documentation

string DOL.GS.AbstractArea.m_Description [protected]

The description of the Area eg. "Camelot Hills".

ushort DOL.GS.AbstractArea.m_ID [protected]

The ID of the Area eg. 15 ( == index in Region.m_areas array)

byte DOL.GS.AbstractArea.m_sound [protected]

The area sound to play on enter/leave events.

const ushort DOL.GS.AbstractArea.MAX_AREAS_PER_ZONE = 50

Constant holding max number of areas per zone, increase if more ares are needed, this will slightly increase memory usage on server.

---

Property Documentation

bool DOL.GS.AbstractArea.CanBroadcast [get, set]

Variable holding whether or not players can broadcast in this area.

bool DOL.GS.AbstractArea.CheckLOS [get, set]

Variable holding whether or not to check for LOS for spells in this area.

string DOL.GS.AbstractArea.Description [get]

Return the description of this Area.

virtual bool DOL.GS.AbstractArea.DisplayMessage [get, set]

Display entered message.

ushort DOL.GS.AbstractArea.ID [get, set]

Returns the ID of this Area.

Implements DOL.GS.IArea.

bool DOL.GS.AbstractArea.IsSafeArea [get, set]

Can players be attacked by other players in this area.

byte DOL.GS.AbstractArea.Sound [get, set]

Gets or sets the area sound.

---

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

• C:/Users/Graveen/Documents/Dawn of Light/Svn DoL/GameServer/world/AbstractArea.cs