C# Class Aura.Channel.World.Inventory.BankInventory

Afficher le fichier Open project: aura-project/aura Class Usage Examples

Private Properties

Свойство	Type	Description

Méthodes publiques

Méthode	Description
AddGold ( Creature creature, int amount ) : int	Adds gold to bank, sends update, and returns the new amount.
AddTab ( string name, long creatureId, BankTabRace race, int width, int height ) : void	Adds bank tab pocket.
BankInventory ( ) : Aura.Channel.Network.Sending	Creates new account bank.
DepositItem ( Creature creature, long itemEntityId, string bankId, string tabName, int x, int y ) : bool	Moves item from creature's inventory into bank.
GetAllItems ( ) : IList	Returns all items in the bank.
GetItem ( long itemEntityId ) : Item	Returns item with the given entity id, or null if the item doesn't exist.
GetName ( string bankId ) : string	Returns name for the bank with the given id, or null if the bank doesn't exist.
GetTabItems ( string tabName ) : IList	Returns all items in specified tab. Returns an empty list if tab doesn't exist.
GetTabList ( ) : IList	Returns thread-safe list of tabs.
GetTabList ( BankTabRace race ) : IList	Returns thread-safe list of tabs.
GetTransferFee ( Item item, string fromBankId, string toBankId ) : int	Returns the gold fee to transfer an item from one bank to the other. The parameters are the ids. Unofficial, but works well.
GetTransferTime ( string fromBankId, string toBankId ) : int	Returns the time it takes to transfer an item from one bank to the other in milliseconds. Unofficial, but works well.
InitAdd ( string tabName, Item item ) : bool	Adds item to tab without any checks (only use for initialization).
RemoveGold ( Creature creature, int amount ) : int	Removes gold to bank, sends update, and returns the new amount.
Transfer ( Creature creature, long itemEntityId, bool instantTransfer ) : bool	Attempts to start a transfer of the given item to the bank the creature is currently using.
WithdrawItem ( Creature creature, string tabName, long itemEntityId ) : bool	Moves item with given id from bank to creature's cursor pocket. Returns whether it was successful or not.

Method Details

AddGold() public méthode

Adds gold to bank, sends update, and returns the new amount.

public AddGold ( Creature creature, int amount ) : int
creature	Aura.Channel.World.Entities.Creature	Creature removing gold (needed for updating)
amount	int	Amount of gold
Résultat	int

AddTab() public méthode

Adds bank tab pocket.

public AddTab ( string name, long creatureId, BankTabRace race, int width, int height ) : void
name	string	Name of the tab (character)
creatureId	long
race	BankTabRace	Race filter id (1\|2\|3)
width	int	Width of the tab pocket
height	int	Height of the tab pocket
Résultat	void

BankInventory() public méthode

Creates new account bank.

public BankInventory ( ) : Aura.Channel.Network.Sending
Résultat	Aura.Channel.Network.Sending

DepositItem() public méthode

Moves item from creature's inventory into bank.

public DepositItem ( Creature creature, long itemEntityId, string bankId, string tabName, int x, int y ) : bool
creature	Aura.Channel.World.Entities.Creature
itemEntityId	long
bankId	string
tabName	string
x	int
y	int
Résultat	bool

GetAllItems() public méthode

Returns all items in the bank.

public GetAllItems ( ) : IList
Résultat	IList

GetItem() public méthode

Returns item with the given entity id, or null if the item doesn't exist.

public GetItem ( long itemEntityId ) : Item
itemEntityId	long
Résultat	Item

GetName() public static méthode

Returns name for the bank with the given id, or null if the bank doesn't exist.

public static GetName ( string bankId ) : string
bankId	string
Résultat	string

GetTabItems() public méthode

Returns all items in specified tab. Returns an empty list if tab doesn't exist.

public GetTabItems ( string tabName ) : IList
tabName	string
Résultat	IList

GetTabList() public méthode

Returns thread-safe list of tabs.

public GetTabList ( ) : IList
Résultat	IList

GetTabList() public méthode

Returns thread-safe list of tabs.

public GetTabList ( BankTabRace race ) : IList
race	BankTabRace
Résultat	IList

GetTransferFee() public static méthode

Returns the gold fee to transfer an item from one bank to the other. The parameters are the ids.

Unofficial, but works well.

public static GetTransferFee ( Item item, string fromBankId, string toBankId ) : int
item	Item	Item that is to be transferred.
fromBankId	string	The id of the bank the item is at.
toBankId	string	The id of the bank the item is transferred to.
Résultat	int

GetTransferTime() public static méthode

Returns the time it takes to transfer an item from one bank to the other in milliseconds.

Unofficial, but works well.

public static GetTransferTime ( string fromBankId, string toBankId ) : int
fromBankId	string	The id of the bank the item is at.
toBankId	string	The id of the bank the item is transferred to.
Résultat	int

InitAdd() public méthode

Adds item to tab without any checks (only use for initialization).

public InitAdd ( string tabName, Item item ) : bool
tabName	string
item	Item
Résultat	bool

RemoveGold() public méthode

Removes gold to bank, sends update, and returns the new amount.

public RemoveGold ( Creature creature, int amount ) : int
creature	Aura.Channel.World.Entities.Creature	Creature adding gold (needed for updating)
amount	int	Amount of gold
Résultat	int

Transfer() public méthode

Attempts to start a transfer of the given item to the bank the creature is currently using.

public Transfer ( Creature creature, long itemEntityId, bool instantTransfer ) : bool
creature	Aura.Channel.World.Entities.Creature
itemEntityId	long
instantTransfer	bool
Résultat	bool

WithdrawItem() public méthode

Moves item with given id from bank to creature's cursor pocket. Returns whether it was successful or not.

public WithdrawItem ( Creature creature, string tabName, long itemEntityId ) : bool
creature	Aura.Channel.World.Entities.Creature
tabName	string
itemEntityId	long
Résultat	bool