Loading...
Searching...
No Matches
PixelCrushers.QuestMachine.InventoryProUtility Class Reference

Utility functions for Inventory Pro support. More...

Static Public Member Functions

static InventoryPlayer GetInventoryPlayer (StringField playerName)
 Finds an InventoryPlayer.
 
static IStat GetStat (StringField playerName, StringField statCategory, StringField statName)
 Finds a stat.
 
static InventoryItemBase GetItemFromID (string itemName)
 Looks up an item by name.
 
static void AddItem (string itemID, float amount)
 Adds an item to the current player.
 
static void RemoveItem (string itemID, float amount)
 Removes an item from the current player.
 
static float GetItemCount (string itemID)
 Gets the amount of an item held by the current player.
 
static CurrencyDefinition GetCurrencyFromID (string currencyName)
 Looks up a CurrencyDefinition by name.
 
static void AddCurrency (string currencyID, float amount)
 Adds currency to the current player.
 
static void RemoveCurrency (string currencyID, float amount)
 Removes currency from the current player.
 
static float GetCurrencyCount (string currencyID)
 Returns the amount of currency held by the current player.
 

Detailed Description

Utility functions for Inventory Pro support.

Member Function Documentation

◆ AddCurrency()

static void PixelCrushers.QuestMachine.InventoryProUtility.AddCurrency ( string  currencyID,
float  amount 
)
inlinestatic

Adds currency to the current player.

◆ AddItem()

static void PixelCrushers.QuestMachine.InventoryProUtility.AddItem ( string  itemID,
float  amount 
)
inlinestatic

Adds an item to the current player.

◆ GetCurrencyCount()

static float PixelCrushers.QuestMachine.InventoryProUtility.GetCurrencyCount ( string  currencyID)
inlinestatic

Returns the amount of currency held by the current player.

◆ GetCurrencyFromID()

static CurrencyDefinition PixelCrushers.QuestMachine.InventoryProUtility.GetCurrencyFromID ( string  currencyName)
inlinestatic

Looks up a CurrencyDefinition by name.

◆ GetInventoryPlayer()

static InventoryPlayer PixelCrushers.QuestMachine.InventoryProUtility.GetInventoryPlayer ( StringField  playerName)
inlinestatic

Finds an InventoryPlayer.

Parameters
playerNamePlayer name, or blank for the current player.

◆ GetItemCount()

static float PixelCrushers.QuestMachine.InventoryProUtility.GetItemCount ( string  itemID)
inlinestatic

Gets the amount of an item held by the current player.

◆ GetItemFromID()

static InventoryItemBase PixelCrushers.QuestMachine.InventoryProUtility.GetItemFromID ( string  itemName)
inlinestatic

Looks up an item by name.

◆ GetStat()

static IStat PixelCrushers.QuestMachine.InventoryProUtility.GetStat ( StringField  playerName,
StringField  statCategory,
StringField  statName 
)
inlinestatic

Finds a stat.

Parameters
playerNamePlayer name, or blank for the current player.
statCategoryStat category.
statNameStat name.
Returns

◆ RemoveCurrency()

static void PixelCrushers.QuestMachine.InventoryProUtility.RemoveCurrency ( string  currencyID,
float  amount 
)
inlinestatic

Removes currency from the current player.

◆ RemoveItem()

static void PixelCrushers.QuestMachine.InventoryProUtility.RemoveItem ( string  itemID,
float  amount 
)
inlinestatic

Removes an item from the current player.


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