The artifact manager. More...

Public Types
enum	Book { NoPage = 0x0, Page1 = 0x1, Page2 = 0x2, Page3 = 0x4, AllPages = 0x7 }
Static Public Member Functions
static bool	Init ()
static int	LoadArtifacts ()
	Load artifacts from the DB.
static String	GetArtifactIDFromItemID (String itemID)
	Find the matching artifact for the item.
static List< Artifact >	GetArtifacts ()
	Get all artifacts.
static List< Artifact >	GetArtifacts (String zone)
	Find all artifacts from a particular zone.
static int	GetReuseTimer (InventoryArtifact item)
	Get the cooldown for this artifact.
static String[]	GetScholars (String artifactID)
	Get a list of all scholars studying this artifact.
static bool	IsArtifact (InventoryItem item)
	Checks whether or not the item is an artifact.
static int	GetCurrentLevel (InventoryArtifact item)
	Determine artifact level from total XP.
static int	GetXPGainedForLevel (InventoryArtifact item)
	Calculate the XP gained towards the next level (in percent).
static int[]	GetLevelRequirements (String artifactID)
	Get a list of all level requirements for this artifact.
static String	GetEarnsXP (InventoryArtifact item)
	What this artifact gains XP from.
static void	PlayerGainedExperience (DOLEvent e, object sender, EventArgs args)
	Called from GameEventMgr when player has gained experience.
static Dictionary< String, ItemTemplate >	GetArtifactVersions (String artifactID, eCharacterClass charClass, eRealm realm)
	Create a hashtable containing all item templates that are valid for this class.
static Type	GetQuestType (String questTypeString)
	Get the quest type from the quest type string.
static Type	GetEncounterType (String artifactID)
	Get the quest type for the encounter from the artifact ID.
static bool	GrantArtifactBountyCredit (GamePlayer player, String bountyCredit)
	Grant bounty point credit for an artifact.
static bool	GrantArtifactCredit (GamePlayer player, String artifactID)
	Grant credit for an artifact.
static String	GetArtifactID (String bookID)
	Find the matching artifact for this book.
static bool	CanCombine (InventoryItem item1, InventoryItem item2)
	Check whether these 2 items can be combined.
static Book	GetPageNumbers (InventoryItem item, ref String artifactID)
	Check which scroll pages are in this item.
static List< String >	GetArtifacts (GamePlayer player)
	Find all artifacts that this player carries.
static Artifact	GetArtifact (InventoryItem item)
	Get the artifact for this scroll/book item.
static bool	HasBook (GamePlayer player, String artifactID)
	Whether or not the player has the complete book for this artifact in his backpack.
static bool	IsArtifactScroll (InventoryItem item)
	Whether or not the item is an artifact scroll.
static WorldInventoryItem	CombineScrolls (InventoryItem scroll1, InventoryItem scroll2, ref bool combinesToBook)
	Combine 2 scrolls.
static WorldInventoryItem	CreateScroll (String artifactID, int pageNumber)
	Create a scroll from a particular book.

Detailed Description

The artifact manager.

<author>Aredhel</author>

Member Function Documentation

static bool DOL.GS.ArtifactMgr.CanCombine	(	InventoryItem	item1,
		InventoryItem	item2
	)		`[static]`

Check whether these 2 items can be combined.

Parameters:

item1
item2

Returns:

static WorldInventoryItem DOL.GS.ArtifactMgr.CombineScrolls	(	InventoryItem	scroll1,
		InventoryItem	scroll2,
		ref bool	combinesToBook
	)		`[static]`

Combine 2 scrolls.

Parameters:

scroll1
scroll2
combinesToBook

Returns:

static WorldInventoryItem DOL.GS.ArtifactMgr.CreateScroll	(	String	artifactID,
		int	pageNumber
	)		`[static]`

Create a scroll from a particular book.

Parameters:

artifactID	The artifact's ID.
pageNumber	Scroll page number (1-3).

Returns:: An item that can be picked up by a player (or null).

static Artifact DOL.GS.ArtifactMgr.GetArtifact ( InventoryItem item ) [static]

Get the artifact for this scroll/book item.

Parameters:

item

Returns:

static String DOL.GS.ArtifactMgr.GetArtifactID ( String bookID ) [static]

Find the matching artifact for this book.

Parameters:

bookID

Returns:

static String DOL.GS.ArtifactMgr.GetArtifactIDFromItemID ( String itemID ) [static]

Find the matching artifact for the item.

Parameters:

itemID

Returns:

static List<Artifact> DOL.GS.ArtifactMgr.GetArtifacts ( ) [static]

Get all artifacts.

Parameters:

zone

Returns:

static List<Artifact> DOL.GS.ArtifactMgr.GetArtifacts ( String zone ) [static]

Find all artifacts from a particular zone.

Parameters:

zone

Returns:

static List<String> DOL.GS.ArtifactMgr.GetArtifacts ( GamePlayer player ) [static]

Find all artifacts that this player carries.

Parameters:

player

Returns:

static Dictionary<String, ItemTemplate> DOL.GS.ArtifactMgr.GetArtifactVersions	(	String	artifactID,
		eCharacterClass	charClass,
		eRealm	realm
	)		`[static]`

Create a hashtable containing all item templates that are valid for this class.

Parameters:

artifactID
charClass
realm

Returns:

static int DOL.GS.ArtifactMgr.GetCurrentLevel ( InventoryArtifact item ) [static]

Determine artifact level from total XP.

Parameters:

item

Returns:

static String DOL.GS.ArtifactMgr.GetEarnsXP ( InventoryArtifact item ) [static]

What this artifact gains XP from.

Parameters:

item

Returns:

static Type DOL.GS.ArtifactMgr.GetEncounterType ( String artifactID ) [static]

Get the quest type for the encounter from the artifact ID.

Parameters:

artifactID

Returns:

static int [] DOL.GS.ArtifactMgr.GetLevelRequirements ( String artifactID ) [static]

Get a list of all level requirements for this artifact.

Parameters:

artifactID

Returns:

static Book DOL.GS.ArtifactMgr.GetPageNumbers	(	InventoryItem	item,
		ref String	artifactID
	)		`[static]`

Check which scroll pages are in this item.

Parameters:

item
artifactID

Returns:

static Type DOL.GS.ArtifactMgr.GetQuestType ( String questTypeString ) [static]

Get the quest type from the quest type string.

Parameters:

questTypeString

Returns:

static int DOL.GS.ArtifactMgr.GetReuseTimer ( InventoryArtifact item ) [static]

Get the cooldown for this artifact.

Parameters:

item

Returns:

static String [] DOL.GS.ArtifactMgr.GetScholars ( String artifactID ) [static]

Get a list of all scholars studying this artifact.

Parameters:

artifactID

Returns:

static int DOL.GS.ArtifactMgr.GetXPGainedForLevel ( InventoryArtifact item ) [static]

Calculate the XP gained towards the next level (in percent).

Parameters:

item

Returns:

static bool DOL.GS.ArtifactMgr.GrantArtifactBountyCredit	(	GamePlayer	player,
		String	bountyCredit
	)		`[static]`

Grant bounty point credit for an artifact.

Parameters:

player
artifactID

Returns:

static bool DOL.GS.ArtifactMgr.GrantArtifactCredit	(	GamePlayer	player,
		String	artifactID
	)		`[static]`

Grant credit for an artifact.

Parameters:

player
artifactID

Returns:

static bool DOL.GS.ArtifactMgr.HasBook	(	GamePlayer	player,
		String	artifactID
	)		`[static]`

Whether or not the player has the complete book for this artifact in his backpack.

Parameters:

player
artifactID

Returns:

static bool DOL.GS.ArtifactMgr.IsArtifact ( InventoryItem item ) [static]

Checks whether or not the item is an artifact.

Parameters:

item

Returns:

static bool DOL.GS.ArtifactMgr.IsArtifactScroll ( InventoryItem item ) [static]

Whether or not the item is an artifact scroll.

Parameters:

item

Returns:

static int DOL.GS.ArtifactMgr.LoadArtifacts ( ) [static]

Load artifacts from the DB.

static void DOL.GS.ArtifactMgr.PlayerGainedExperience	(	DOLEvent	e,
		object	sender,
		EventArgs	args
	)		`[static]`

Called from GameEventMgr when player has gained experience.

Parameters:

e
sender
args

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

C:/Users/Graveen/Documents/Dawn of Light/Svn DoL/GameServer/gameutils/Atlantis/ArtifactMgr.cs

Public Types

Static Public Member Functions

Detailed Description

Member Function Documentation