DOL.GS.InventoryArtifact Class Reference

An artifact inside an inventory. More...

Inheritance diagram for DOL.GS.InventoryArtifact:

List of all members.

Public Member Functions
	InventoryArtifact (ItemTemplate template)
	Create a new inventory artifact from an item template.
	InventoryArtifact (InventoryItem item)
	Create a new inventory artifact from an existing inventory item.
void	OnLevelGained (GamePlayer player, int artifactLevel)
	Called from ArtifactMgr when this artifact has gained a level.
void	UpdateAbilities (ItemTemplate template)
	Verify that this artifact has all the correct abilities.
override void	Delve (List< String > delve, GamePlayer player)
	Artifact delve information.
virtual void	DelveMagicalAbility (List< String > delve, ArtifactBonus.ID bonusID, int levelRequirement)
	Artifact Magical Ability delve information (spells, procs).
override void	WriteTechnicalInfo (List< String > delve)
	Write item technical info.
Protected Member Functions
virtual void	DelveMagicalBonus (List< String > delve, int bonusAmount, int bonusType, int levelRequirement)
	Artifact classic magical bonus delve information.
virtual void	DelveFocusBonus (List< String > delve, int bonusAmount, int bonusType, int levelRequirement)
virtual void	DelveBonus (List< String > delve, int bonusAmount, int bonusType, int levelRequirement)
	Artifact ToA magical bonus delve information.
override void	DelveWeaponStats (List< String > delve, GamePlayer player)
	Artifact weapon stats delve info.
override void	DelveArmorStats (List< String > delve, GamePlayer player)
	Artifact armor stats delve info.
virtual bool	IsCapIncreaseBonus (int bonusType)
	Check whether this type is a cap increase bonus.
virtual bool	IsFocusBonus (int bonusType)
	Check whether this type is focus.
virtual bool	IsResistBonus (int bonusType)
	Check whether this type is resist.
virtual bool	IsSkillBonus (int bonusType)
	Check whether this type is a skill.
virtual bool	IsStatBonus (int bonusType)
	Check whether this type is a stat bonus.
virtual bool	IsToABonus (int bonusType)
	Check whether this type is a ToA bonus (it's all mixed up in GlobalConstants.cs, but let's try anyway).
Properties
String	ArtifactID [get, set]
	The ID of this artifact.
int	ArtifactLevel [get, set]
	The level of this artifact.
override long	RepairCost [get]
	Repair cost for this artifact in the current state.

---

Detailed Description

An artifact inside an inventory.

<author>Aredhel</author>

---

Constructor & Destructor Documentation

DOL.GS.InventoryArtifact.InventoryArtifact

(

ItemTemplate

template

)

Create a new inventory artifact from an item template.

Parameters:

template

DOL.GS.InventoryArtifact.InventoryArtifact

(

InventoryItem

item

)

Create a new inventory artifact from an existing inventory item.

Parameters:

item

---

Member Function Documentation

override void DOL.GS.InventoryArtifact.Delve	(	List< String >	delve,
		GamePlayer	player
	)		[virtual]

Artifact delve information.

Reimplemented from DOL.GS.GameInventoryItem.

override void DOL.GS.InventoryArtifact.DelveArmorStats	(	List< String >	delve,
		GamePlayer	player
	)		[protected, virtual]

Artifact armor stats delve info.

Parameters:

delve
player

Reimplemented from DOL.GS.GameInventoryItem.

virtual void DOL.GS.InventoryArtifact.DelveBonus	(	List< String >	delve,
		int	bonusAmount,
		int	bonusType,
		int	levelRequirement
	)		[protected, virtual]

Artifact ToA magical bonus delve information.

Parameters:

delve
bonusAmount
bonusType
levelRequirement

virtual void DOL.GS.InventoryArtifact.DelveMagicalAbility	(	List< String >	delve,
		ArtifactBonus.ID	bonusID,
		int	levelRequirement
	)		[virtual]

Artifact Magical Ability delve information (spells, procs).

Parameters:

delve
bonusID
levelRequirement

virtual void DOL.GS.InventoryArtifact.DelveMagicalBonus	(	List< String >	delve,
		int	bonusAmount,
		int	bonusType,
		int	levelRequirement
	)		[protected, virtual]

Artifact classic magical bonus delve information.

Parameters:

delve
bonusAmount
bonusType
levelRequirement

override void DOL.GS.InventoryArtifact.DelveWeaponStats	(	List< String >	delve,
		GamePlayer	player
	)		[protected, virtual]

Artifact weapon stats delve info.

Parameters:

delve
player

Reimplemented from DOL.GS.GameInventoryItem.

virtual bool DOL.GS.InventoryArtifact.IsCapIncreaseBonus

(

int

bonusType

)

[protected, virtual]

Check whether this type is a cap increase bonus.

Parameters:

bonusType

Returns:

virtual bool DOL.GS.InventoryArtifact.IsFocusBonus

(

int

bonusType

)

[protected, virtual]

Check whether this type is focus.

Parameters:

bonusType

Returns:

virtual bool DOL.GS.InventoryArtifact.IsResistBonus

(

int

bonusType

)

[protected, virtual]

Check whether this type is resist.

Parameters:

bonusType

Returns:

virtual bool DOL.GS.InventoryArtifact.IsSkillBonus

(

int

bonusType

)

[protected, virtual]

Check whether this type is a skill.

Parameters:

bonusType

Returns:

virtual bool DOL.GS.InventoryArtifact.IsStatBonus

(

int

bonusType

)

[protected, virtual]

Check whether this type is a stat bonus.

Parameters:

bonusType

Returns:

virtual bool DOL.GS.InventoryArtifact.IsToABonus

(

int

bonusType

)

[protected, virtual]

Check whether this type is a ToA bonus (it's all mixed up in GlobalConstants.cs, but let's try anyway).

Parameters:

bonusType

Returns:

void DOL.GS.InventoryArtifact.OnLevelGained	(	GamePlayer	player,
		int	artifactLevel
	)

Called from ArtifactMgr when this artifact has gained a level.

Parameters:

player
artifactLevel

void DOL.GS.InventoryArtifact.UpdateAbilities

(

ItemTemplate

template

)

Verify that this artifact has all the correct abilities.

override void DOL.GS.InventoryArtifact.WriteTechnicalInfo

(

List< String >

delve

)

[virtual]

Write item technical info.

Parameters:

output
item

Reimplemented from DOL.GS.GameInventoryItem.

---

Property Documentation

String DOL.GS.InventoryArtifact.ArtifactID [get, set]

The ID of this artifact.

int DOL.GS.InventoryArtifact.ArtifactLevel [get, set]

The level of this artifact.

override long DOL.GS.InventoryArtifact.RepairCost [get]

Repair cost for this artifact in the current state.

---

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

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