DOL.GS.Instance Class Reference

The Instance is an implementation of BaseInstance that contains additional functionality to load a template from InstanceXElement. More...

Inheritance diagram for DOL.GS.Instance:

List of all members.

Public Member Functions
	Instance (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.
override void	Start ()
	Start the instance, executing any required startup tasks.
override void	OnCollapse ()
	What to do when the region collapses. Examples of use: Expire task on task dungeons.
virtual void	LoadFromDatabase (string instanceName)
	Loads elements relating to the given instance keyname from the database and populates the instance.
override IList	GetAreasOfZone (Zone zone, IPoint3D p, bool checkZ)
	Gets the areas for a certain spot.
override IList	GetAreasOfZone (Zone zone, int x, int y, int z)
int	GetInstanceLevel ()
	This method returns an int representative of an average level for the instance. Instances do not scale with level by default, but specific instances like TaskDungeonMission can use this for an accurate representation of level.
Protected Attributes
GameLocation	m_entranceLocation = null
Dictionary< int, Zone >	m_zoneSkinMap = new Dictionary<int, Zone>()
Properties
GameLocation	InstanceEntranceLocation [get]
	Returns the entrance location into this instance.

---

Detailed Description

The Instance is an implementation of BaseInstance that contains additional functionality to load a template from InstanceXElement.

---

Constructor & Destructor Documentation

DOL.GS.Instance.Instance	(	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

override IList DOL.GS.Instance.GetAreasOfZone	(	Zone	zone,
		IPoint3D	p,
		bool	checkZ
	)		[virtual]

Gets the areas for a certain spot.

Parameters:

zone
p
checkZ

Returns:

Reimplemented from DOL.GS.Region.

int DOL.GS.Instance.GetInstanceLevel

(

)

This method returns an int representative of an average level for the instance. Instances do not scale with level by default, but specific instances like TaskDungeonMission can use this for an accurate representation of level.

Returns:

virtual void DOL.GS.Instance.LoadFromDatabase

(

string

instanceName

)

[virtual]

Loads elements relating to the given instance keyname from the database and populates the instance.

Parameters:

instanceName

override void DOL.GS.Instance.OnCollapse

(

)

[virtual]

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

Reimplemented from DOL.GS.BaseInstance.

Reimplemented in DOL.GS.Quests.TaskDungeonInstance.

override void DOL.GS.Instance.Start

(

)

[virtual]

Start the instance, executing any required startup tasks.

Reimplemented from DOL.GS.BaseInstance.

---

Property Documentation

GameLocation DOL.GS.Instance.InstanceEntranceLocation [get]

Returns the entrance location into this instance.

---

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

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