Game (functions)/Item Management

GAME:FindPlayerItem(System.String,System.Boolean,System.Boolean)

Finds an item in the player's team and returns its slot within the inventory or among its team's equips.

Arguments

• id: The item ID to search for.
• held: Check equipped items.
• inv: Check inventory items.

Returns

The InvSlot of the item. Invalid if the item could not be found.

GAME:GetPlayerEquippedCount

Get the number of items equipped by players. Does not include guests.

Returns

The number of items.

GAME:GetPlayerBagCount

Get the number of items in the bag.

Returns

The number of items.

GAME:GetPlayerBagLimit

Gets the maximum amount of item the player's team can carry.

Returns

The number of items.

GAME:GetPlayerEquippedItem(System.Int32)

Gets the equipped item for the character in the specified slot.

Arguments

• slot: The team slot of the character to check

Returns

The character's equipped item

GAME:GetGuestEquippedItem(System.Int32)

Gets the equipped item for the character in the specified guest slot.

Arguments

• slot: The guest slot of the character to check

Returns

The character's equipped item

GAME:GivePlayerItem(RogueEssence.Dungeon.InvItem)

Gives an item and adds it to the player team's bag.

Arguments

• item: The item to give

GAME:GivePlayerItem(System.String,System.Int32,System.Boolean,System.String)

Gives an item and adds it to the player team's bag.

Arguments

• id: The ID of the item
• count: The amount to give. Default 1
• cursed: Whether the item is cursed. Default false.
• hiddenval: The hidden value of the item. Default empty string.

GAME:GetPlayerBagItem(System.Int32)

Gets the item found at the specified slot of the player's bag.

Arguments

• slot: The slot to check

Returns

The item found in the slot

GAME:TakePlayerBagItem(System.Int32,System.Boolean)

Remove an item from player inventory

Arguments

• slot: The slot from which to remove the item
• takeAll: None

GAME:TakePlayerEquippedItem(System.Int32,System.Boolean)

Remove the equipped item from a chosen member of the team

Arguments

• slot: The slot of the character on the team from which to remove the item
• takeAll: None

GAME:TakeGuestEquippedItem(System.Int32,System.Boolean)

Remove the equipped item from a chosen guest of the team

Arguments

• slot: The slot of the character on the team's guest list from which to remove the item
• takeAll: None

GAME:GetPlayerStorageCount

Get the amount of items in the player's storage

GAME:GetPlayerStorageItemCount(System.String)

Get the amount of a specific item in the player's storage

Arguments

• id: ID of the item ot check

Returns

The amount of copies currently in storage

GAME:GivePlayerStorageItem(RogueEssence.Dungeon.InvItem)

Gives an item and adds it to the player team's storage.

Arguments

• item: The item to give

GAME:GivePlayerStorageItem(System.String,System.Int32,System.Boolean,System.String)

Gives an item and adds it to the player team's storage.

Arguments

• id: The ID of the item
• count: The amount to give. Default 1
• cursed: Whether the item is cursed. Default false.
• hiddenval: The hidden value of the item. Default empty string.

GAME:TakePlayerStorageItem(System.String)

Takes an item from the storage

Arguments

• id: The ID of the item to take

GAME:DepositAll

Takes all items in the player team's bag and equipped items, and deposits them in storage.