Skip to main content

Class Backpack

Declaration
public class Backpack : Module<Backpack, BackpackConfig, BackpackDebugger>

Properties

Logger

Declaration
public override ILog Logger { get; }

Fields

DefaultStashID

Declaration
public const string DefaultStashID = "backpack"

InventoryKey

Declaration
public const string InventoryKey = "inventory"

SlotsKey

Declaration
public const string SlotsKey = "inventorySlots"

Methods

Initialize(IBackpackDataStore)

Declaration
public void Initialize(IBackpackDataStore backpackDataStore)
Parameters
TypeName
MatchinghamGames.BackpackModule.IBackpackDataStorebackpackDataStore

Initialize(Action<InitializationResult>)

Declaration
protected override void Initialize(Action<InitializationResult> setResult)
Parameters
TypeName
System.Action<InitializationResult>setResult

GetEntries()

Declaration
public static IEnumerable<ItemEntry> GetEntries()
Returns

System.Collections.Generic.IEnumerable<MatchinghamGames.BackpackModule.Models.ItemEntry>

HasItem(string)

Declaration
public static bool HasItem(string itemId)
Returns

System.Boolean

Parameters
TypeName
System.StringitemId

GetOwnedQuantity(string)

Declaration
public static int GetOwnedQuantity(string itemId)
Returns

System.Int32

Parameters
TypeName
System.StringitemId

IsMaxCapacity(string)

Declaration
public static bool IsMaxCapacity(string itemId)
Returns

System.Boolean

Parameters
TypeName
System.StringitemId

SetOwnedQuantity(string, int)

Declaration
public static void SetOwnedQuantity(string itemId, int quantity)
Parameters
TypeName
System.StringitemId
System.Int32quantity

AddItem(string, int)

Declaration
public static void AddItem(string itemId, int quantity = 1)
Parameters
TypeName
System.StringitemId
System.Int32quantity

RemoveItem(string, int)

Declaration
public static void RemoveItem(string itemId, int quantity = 1)
Parameters
TypeName
System.StringitemId
System.Int32quantity

Events

ItemAdded

Declaration
public static event InventoryEventDelegate ItemAdded
Event Type

MatchinghamGames.BackpackModule.InventoryEventDelegate

ItemRemoved

Declaration
public static event InventoryEventDelegate ItemRemoved
Event Type

MatchinghamGames.BackpackModule.InventoryEventDelegate