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

The class holding all salvage functions. More...

List of all members.

Static Public Member Functions

static int BeginWork (GamePlayer player, InventoryItem item)
 Begin salvaging an inventory item.
static int BeginWork (GamePlayer player, GameSiegeWeapon siegeWeapon)
 Begin salvaging a siege weapon.
static bool IsAllowedToBeginWork (GamePlayer player, InventoryItem item)
 Check if the player can begin to salvage an item.
static int GetCountForSalvage (InventoryItem item, SalvageYield salvage, ItemTemplate rawMaterial)
 Calculate the count per Object_Type.
static int GetMaterialYield (GamePlayer player, InventoryItem item, SalvageYield salvageYield, ItemTemplate rawMaterial)
 Return the material yield for this salvage.

Static Protected Member Functions

static int Proceed (RegionTimer timer)
 Called when craft time is finished.

Protected Attributes

const string SALVAGE_YIELD = "SALVAGE_YIELD"
 The SalvageYield entry for the item being salvaged.
const string SALVAGED_ITEM = "SALVAGED_ITEM"
 The item being salvaged.

Static Protected Attributes

static readonly ILog log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType)
 Defines a logger for this class.

Detailed Description

The class holding all salvage functions.


Member Function Documentation

static int DOL.GS.Salvage.BeginWork ( GamePlayer  player,
InventoryItem  item 
) [static]

Begin salvaging an inventory item.

Parameters:
item
player
Returns:
static int DOL.GS.Salvage.BeginWork ( GamePlayer  player,
GameSiegeWeapon  siegeWeapon 
) [static]

Begin salvaging a siege weapon.

Parameters:
player
siegeWeapon
Returns:
static int DOL.GS.Salvage.GetCountForSalvage ( InventoryItem  item,
SalvageYield  salvage,
ItemTemplate  rawMaterial 
) [static]

Calculate the count per Object_Type.

static int DOL.GS.Salvage.GetMaterialYield ( GamePlayer  player,
InventoryItem  item,
SalvageYield  salvageYield,
ItemTemplate  rawMaterial 
) [static]

Return the material yield for this salvage.

static bool DOL.GS.Salvage.IsAllowedToBeginWork ( GamePlayer  player,
InventoryItem  item 
) [static]

Check if the player can begin to salvage an item.

Parameters:
player
item
Returns:
static int DOL.GS.Salvage.Proceed ( RegionTimer  timer) [static, protected]

Called when craft time is finished.

Parameters:
timer
Returns:

Member Data Documentation

readonly ILog DOL.GS.Salvage.log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType) [static, protected]

Defines a logger for this class.

const string DOL.GS.Salvage.SALVAGE_YIELD = "SALVAGE_YIELD" [protected]

The SalvageYield entry for the item being salvaged.

const string DOL.GS.Salvage.SALVAGED_ITEM = "SALVAGED_ITEM" [protected]

The item being salvaged.


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