DOL.GS.GameHouseVault Class Reference

A house vault. More...

Inheritance diagram for DOL.GS.GameHouseVault:

List of all members.

Public Member Functions
	GameHouseVault (ItemTemplate itemTemplate, int vaultIndex)
	Create a new house vault.
bool	Attach (House house, uint hookpointID, ushort heading)
	Attach this vault to a hookpoint in a house.
bool	Attach (House house, DBHouseHookpointItem hookedItem)
	Attach this vault to a hookpoint in a house.
bool	Detach (GamePlayer player)
	Remove this vault from a hookpoint in the house.
override string	GetOwner (GamePlayer player)
override bool	Interact (GamePlayer player)
	Player interacting with this vault.
override bool	CanView (GamePlayer player)
	Whether or not this player can view the contents of this vault.
override bool	CanAddItems (GamePlayer player)
	Whether or not this player can move items inside the vault.
override bool	CanRemoveItems (GamePlayer player)
	Whether or not this player can move items inside the vault.
Protected Member Functions
override void	NotifyObservers (GamePlayer player, IDictionary< int, InventoryItem > updateItems)
	Send inventory updates to all players actively viewing this vault; players that are too far away will be considered inactive.
Properties
override int	VaultSize [get]
	Gets the number of items that can be held in the vault.
string	TemplateID [get]
	Template ID for this vault.

---

Detailed Description

A house vault.

<author>Aredhel</author>

---

Constructor & Destructor Documentation

DOL.GS.GameHouseVault.GameHouseVault	(	ItemTemplate	itemTemplate,
		int	vaultIndex
	)

Create a new house vault.

Parameters:

vaultIndex

---

Member Function Documentation

bool DOL.GS.GameHouseVault.Attach	(	House	house,
		uint	hookpointID,
		ushort	heading
	)

Attach this vault to a hookpoint in a house.

Parameters:

house
hookpointID

Returns:

Implements DOL.GS.Housing.IHouseHookpointItem.

bool DOL.GS.GameHouseVault.Attach	(	House	house,
		DBHouseHookpointItem	hookedItem
	)

Attach this vault to a hookpoint in a house.

Parameters:

house
hookedItem

Returns:

Implements DOL.GS.Housing.IHouseHookpointItem.

override bool DOL.GS.GameHouseVault.CanAddItems

(

GamePlayer

player

)

[virtual]

Whether or not this player can move items inside the vault.

Parameters:

player

Returns:

Reimplemented from DOL.GS.GameVault.

override bool DOL.GS.GameHouseVault.CanRemoveItems

(

GamePlayer

player

)

[virtual]

Whether or not this player can move items inside the vault.

Parameters:

player

Returns:

Reimplemented from DOL.GS.GameVault.

override bool DOL.GS.GameHouseVault.CanView

(

GamePlayer

player

)

[virtual]

Whether or not this player can view the contents of this vault.

Parameters:

player

Returns:

Reimplemented from DOL.GS.GameVault.

bool DOL.GS.GameHouseVault.Detach

(

GamePlayer

player

)

Remove this vault from a hookpoint in the house.

Returns:

Implements DOL.GS.Housing.IHouseHookpointItem.

override bool DOL.GS.GameHouseVault.Interact

(

GamePlayer

player

)

[virtual]

Player interacting with this vault.

Parameters:

player

Returns:

Reimplemented from DOL.GS.GameVault.

override void DOL.GS.GameHouseVault.NotifyObservers	(	GamePlayer	player,
		IDictionary< int, InventoryItem >	updateItems
	)		[protected, virtual]

Send inventory updates to all players actively viewing this vault; players that are too far away will be considered inactive.

Parameters:

updateItems

Reimplemented from DOL.GS.GameVault.

---

Property Documentation

string DOL.GS.GameHouseVault.TemplateID [get]

Template ID for this vault.

Implements DOL.GS.Housing.IHouseHookpointItem.

override int DOL.GS.GameHouseVault.VaultSize [get]

Gets the number of items that can be held in the vault.

Reimplemented from DOL.GS.GameVault.

---

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

• C:/Users/Graveen/Documents/Dawn of Light/Svn DoL/GameServer/gameobjects/GameHouseVault.cs