DOL.GS.BaseInstance Class Reference

The instance object is a dynamic region that is designed to be adventured by a select few. Instances can share the same skins as other regions, so they look the same, but in reality are an entirely unique region, often with different mobs. Two players, standing in the same spot, on top of the merchant's tent in Jordheim, if in two instances, will not be able to interact in any way. /summary> More...

Inheritance diagram for DOL.GS.BaseInstance:

List of all members.

Classes
class	AutoCloseRegionTimer
class	DelayCloseRegionTimer
Public Member Functions
	BaseInstance (ushort ID, GameTimer.TimeManager time, RegionData data)
virtual void	Start ()
	Called as last step in Instance creation.
virtual void	OnPlayerEnterInstance (GamePlayer player)
virtual void	OnPlayerLeaveInstance (GamePlayer player)
virtual bool	OnInstanceDoor (GamePlayer player, ZonePoint zonePoint)
	Invoked when the player attempts to use a door or zone point inside an instance.
override void	OnCollapse ()
	What to do when the region collapses. Examples of use: Expire task on task dungeons.
void	BeginAutoClosureCountdown (int minutes)
void	BeginDelayCloseCountdown (int minutes)
	Setting this will ensure the instance stays around x minutes. After that the region will be destroyed when empty.
Properties
override ushort	ID [get]
	The unique region ID of this region.
override string	Description [get]
	The Regi on Description eg. Cursed Forest.
override ushort	Skin [get]
override string	Name [get]
	Gets the name of the region this instance copies, + " (Instance)".
override bool	IsInstance [get]
	Is the Region a temporary instance.
bool	DestroyWhenEmpty [get, set]
	If this is true the instance will be destroyed as soon as the last player leaves.
bool	Persistent [get, set]
	Persistent instances never close.
int	PlayersInInstance [get]

---

Detailed Description

The instance object is a dynamic region that is designed to be adventured by a select few. Instances can share the same skins as other regions, so they look the same, but in reality are an entirely unique region, often with different mobs. Two players, standing in the same spot, on top of the merchant's tent in Jordheim, if in two instances, will not be able to interact in any way. /summary>

---

Constructor & Destructor Documentation

DOL.GS.BaseInstance.BaseInstance	(	ushort	ID,
		GameTimer.TimeManager	time,
		RegionData	data
	)

Creates an instance object. This shouldn't be used directly - Please use WorldMgr.CreateInstance to create an instance.

---

Member Function Documentation

void DOL.GS.BaseInstance.BeginDelayCloseCountdown

(

int

minutes

)

Setting this will ensure the instance stays around x minutes. After that the region will be destroyed when empty.

Parameters:

minutes

override void DOL.GS.BaseInstance.OnCollapse

(

)

[virtual]

What to do when the region collapses. Examples of use: Expire task on task dungeons.

Reimplemented from DOL.GS.Region.

Reimplemented in DOL.GS.Quests.TaskDungeonInstance, and DOL.GS.Instance.

virtual bool DOL.GS.BaseInstance.OnInstanceDoor	(	GamePlayer	player,
		ZonePoint	zonePoint
	)		[virtual]

Invoked when the player attempts to use a door or zone point inside an instance.

Returns:

True if the player should be moved to default locations.

virtual void DOL.GS.BaseInstance.Start

(

)

[virtual]

Called as last step in Instance creation.

Reimplemented in DOL.GS.Instance.

---

Property Documentation

override string DOL.GS.BaseInstance.Description [get]

The Regi on Description eg. Cursed Forest.

Reimplemented from DOL.GS.Region.

bool DOL.GS.BaseInstance.DestroyWhenEmpty [get, set]

If this is true the instance will be destroyed as soon as the last player leaves.

override ushort DOL.GS.BaseInstance.ID [get]

The unique region ID of this region.

Reimplemented from DOL.GS.Region.

override bool DOL.GS.BaseInstance.IsInstance [get]

Is the Region a temporary instance.

Reimplemented from DOL.GS.Region.

override string DOL.GS.BaseInstance.Name [get]

Gets the name of the region this instance copies, + " (Instance)".

Reimplemented from DOL.GS.Region.

bool DOL.GS.BaseInstance.Persistent [get, set]

Persistent instances never close.

override ushort DOL.GS.BaseInstance.Skin [get]

Gets the SkinID of the instance - the 'look' of the instance.

Reimplemented from DOL.GS.Region.

---

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

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