Interface for areas within game, extend this or AbstractArea if you need to define a new area shape that isn't already defined. Defined ones: More...

Inheritance diagram for DOL.GS.IArea:

Public Member Functions
void	UnRegisterPlayerEnter (DOLEventHandler callback)
void	UnRegisterPlayerLeave (DOLEventHandler callback)
void	RegisterPlayerEnter (DOLEventHandler callback)
void	RegisterPlayerLeave (DOLEventHandler callback)
bool	IsIntersectingZone (Zone zone)
	Checks wether is intersects with given zone. This is needed to build an area.zone mapping cache for performance.
bool	IsContaining (IPoint3D spot)
	Checks wether given spot is within areas range or not.
bool	IsContaining (IPoint3D spot, bool checkZ)
bool	IsContaining (int x, int y, int z)
bool	IsContaining (int x, int y, int z, bool checkZ)
void	OnPlayerLeave (GamePlayer player)
	Called whenever a player leaves the given area.
void	OnPlayerEnter (GamePlayer player)
	Called whenever a player enters the given area.
Properties
ushort	ID `[get, set]`
	Returns the ID of this zone.

Detailed Description

Interface for areas within game, extend this or AbstractArea if you need to define a new area shape that isn't already defined. Defined ones:

Member Function Documentation

bool DOL.GS.IArea.IsContaining ( IPoint3D spot )

Checks wether given spot is within areas range or not.

Parameters:

spot

bool DOL.GS.IArea.IsIntersectingZone ( Zone zone )

Checks wether is intersects with given zone. This is needed to build an area.zone mapping cache for performance.

Parameters:

zone

void DOL.GS.IArea.OnPlayerEnter ( GamePlayer player )

Called whenever a player enters the given area.

Parameters:

player

void DOL.GS.IArea.OnPlayerLeave ( GamePlayer player )

Called whenever a player leaves the given area.

Parameters:

player

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

Returns the ID of this zone.

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