Dawn of Light - Class documentation 2900
This is the Dawn of Light project
DOL.GS.GameVault Class Reference

A vault. More...

Inheritance diagram for DOL.GS.GameVault:
DOL.GS.GameStaticItem DOL.GS.GameObject DOL.GS.Point3D DOL.GS.Point2D DOL.GS.IPoint3D DOL.GS.IPoint2D DOL.GS.IPoint2D DOL.GS.GameHouseVault

List of all members.

Public Member Functions

virtual string GetOwner (GamePlayer player)
override bool Interact (GamePlayer player)
 Player interacting with this vault.
virtual Dictionary< int,
InventoryItem > 
GetVaultInventory (GamePlayer player)
 Inventory for this vault.
IList< InventoryItem > GetItems (GamePlayer player)
 List of items in the vault.
virtual void MoveItem (GamePlayer player, eInventorySlot fromSlot, eInventorySlot toSlot)
 Move an item from, to or inside a house vault.
virtual bool CanView (GamePlayer player)
 Whether or not this player can view the contents of this vault.
virtual bool CanAddItems (GamePlayer player)
 Whether or not this player can move items inside the vault.
virtual bool CanRemoveItems (GamePlayer player)
 Whether or not this player can move items inside the vault.

Protected Member Functions

virtual IDictionary< int,
InventoryItem > 
MoveItemFromVault (GamePlayer player, eInventorySlot fromSlot, eInventorySlot toSlot)
 Move an item from the vault.
virtual IDictionary< int,
InventoryItem > 
MoveItemToVault (GamePlayer player, eInventorySlot fromSlot, eInventorySlot toSlot)
 Move an item to the vault.
virtual IDictionary< int,
InventoryItem > 
MoveItemInsideVault (GamePlayer player, eInventorySlot fromSlot, eInventorySlot toSlot)
 Move an item around inside the vault.
virtual 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.

Protected Attributes

int m_vaultIndex
object m_vaultSync = new object()
 This is used to synchronize actions on the vault.

Properties

int Index [get, set]
 Index of this vault.
virtual int VaultSize [get]
 Gets the number of items that can be held in the vault.
virtual int FirstSlot [get]
 First slot in the DB.
virtual int LastSlot [get]
 Last slot in the DB.

Detailed Description

A vault.

<author>Aredhel, Tolakram</author>


Member Function Documentation

virtual bool DOL.GS.GameVault.CanAddItems ( GamePlayer  player) [virtual]

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

Parameters:
player
Returns:

Reimplemented in DOL.GS.GameHouseVault.

virtual bool DOL.GS.GameVault.CanRemoveItems ( GamePlayer  player) [virtual]

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

Parameters:
player
Returns:

Reimplemented in DOL.GS.GameHouseVault.

virtual bool DOL.GS.GameVault.CanView ( GamePlayer  player) [virtual]

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

Parameters:
player
Returns:

Reimplemented in DOL.GS.GameHouseVault.

IList<InventoryItem> DOL.GS.GameVault.GetItems ( GamePlayer  player)

List of items in the vault.

virtual Dictionary<int, InventoryItem> DOL.GS.GameVault.GetVaultInventory ( GamePlayer  player) [virtual]

Inventory for this vault.

override bool DOL.GS.GameVault.Interact ( GamePlayer  player) [virtual]

Player interacting with this vault.

Parameters:
player
Returns:

Reimplemented from DOL.GS.GameObject.

Reimplemented in DOL.GS.GameHouseVault.

virtual void DOL.GS.GameVault.MoveItem ( GamePlayer  player,
eInventorySlot  fromSlot,
eInventorySlot  toSlot 
) [virtual]

Move an item from, to or inside a house vault.

virtual IDictionary<int, InventoryItem> DOL.GS.GameVault.MoveItemFromVault ( GamePlayer  player,
eInventorySlot  fromSlot,
eInventorySlot  toSlot 
) [protected, virtual]

Move an item from the vault.

virtual IDictionary<int, InventoryItem> DOL.GS.GameVault.MoveItemInsideVault ( GamePlayer  player,
eInventorySlot  fromSlot,
eInventorySlot  toSlot 
) [protected, virtual]

Move an item around inside the vault.

virtual IDictionary<int, InventoryItem> DOL.GS.GameVault.MoveItemToVault ( GamePlayer  player,
eInventorySlot  fromSlot,
eInventorySlot  toSlot 
) [protected, virtual]

Move an item to the vault.

virtual void DOL.GS.GameVault.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 in DOL.GS.GameHouseVault.


Member Data Documentation

object DOL.GS.GameVault.m_vaultSync = new object() [protected]

This is used to synchronize actions on the vault.


Property Documentation

virtual int DOL.GS.GameVault.FirstSlot [get]

First slot in the DB.

int DOL.GS.GameVault.Index [get, set]

Index of this vault.

virtual int DOL.GS.GameVault.LastSlot [get]

Last slot in the DB.

virtual int DOL.GS.GameVault.VaultSize [get]

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

Reimplemented in DOL.GS.GameHouseVault.


The documentation for this class was generated from the following file:
All Classes Namespaces Functions Variables Enumerations Properties Events