playfab_ex v0.2.0 PlayfabEx.Server.PlayerItemManagement
Link to this section Summary
Functions
Increments the character’s balance of the specified virtual currency by the stated amount
Increments the user’s balance of the specified virtual currency by the stated amount
Consume uses of a consumable item. When all uses are consumed, it will be removed from the player’s inventory
Returns the result of an evaluation of a Random Result Table - the ItemId from the game Catalog which would have been added to the player inventory, if the Random Result Table were added via a Bundle or a call to UnlockContainer
Retrieves the specified character’s current inventory of virtual goods
Retrieves the configuration information for the specified random results tables for the title, including all ItemId values and weights
Retrieves the specified user’s current inventory of virtual goods
Adds the specified items to the specified character’s inventory
Adds the specified items to the specified user’s inventory
Adds the specified items to the specified user inventories
Modifies the number of remaining uses of a player’s inventory item
Moves an item from a character’s inventory into another of the users’s character’s inventory
Moves an item from a user’s inventory into their character’s inventory
Moves an item from a character’s inventory into the owning user’s inventory
Adds the virtual goods associated with the coupon to the user’s inventory. Coupons can be generated via the Economy->Catalogs tab in the PlayFab Game Manager
Submit a report about a player (due to bad bahavior, etc.) on behalf of another player, so that customer service representatives for the title can take action concerning potentially toxic players
Revokes access to an item in a user’s inventory
Decrements the character’s balance of the specified virtual currency by the stated amount. It is possible to make a VC balance negative with this API
Decrements the user’s balance of the specified virtual currency by the stated amount. It is possible to make a VC balance negative with this API
Opens a specific container (ContainerItemInstanceId), with a specific key (KeyItemInstanceId, when required), and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem
Searches Player or Character inventory for any ItemInstance matching the given CatalogItemId, if necessary unlocks it using any appropriate key, and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem
Updates the key-value pair data tagged to the specified item, which is read-only from the client
Link to this section Functions
add_character_virtual_currency(map()) :: {:ok, map()} | {:error, String.t()}
Increments the character’s balance of the specified virtual currency by the stated amount
add_user_virtual_currency(map()) :: {:ok, map()} | {:error, String.t()}
Increments the user’s balance of the specified virtual currency by the stated amount
consume_item(map()) :: {:ok, map()} | {:error, String.t()}
Consume uses of a consumable item. When all uses are consumed, it will be removed from the player’s inventory.
evaluate_random_result_table(map()) :: {:ok, map()} | {:error, String.t()}
Returns the result of an evaluation of a Random Result Table - the ItemId from the game Catalog which would have been added to the player inventory, if the Random Result Table were added via a Bundle or a call to UnlockContainer.
get_character_inventory(map()) :: {:ok, map()} | {:error, String.t()}
Retrieves the specified character’s current inventory of virtual goods
get_random_result_tables(map()) :: {:ok, map()} | {:error, String.t()}
Retrieves the configuration information for the specified random results tables for the title, including all ItemId values and weights
get_user_inventory(map()) :: {:ok, map()} | {:error, String.t()}
Retrieves the specified user’s current inventory of virtual goods
grant_items_to_character(map()) :: {:ok, map()} | {:error, String.t()}
Adds the specified items to the specified character’s inventory
grant_items_to_user(map()) :: {:ok, map()} | {:error, String.t()}
Adds the specified items to the specified user’s inventory
grant_items_to_users(map()) :: {:ok, map()} | {:error, String.t()}
Adds the specified items to the specified user inventories
modify_item_uses(map()) :: {:ok, map()} | {:error, String.t()}
Modifies the number of remaining uses of a player’s inventory item
move_item_to_character_from_character(map()) :: {:ok, map()} | {:error, String.t()}
Moves an item from a character’s inventory into another of the users’s character’s inventory.
move_item_to_character_from_user(map()) :: {:ok, map()} | {:error, String.t()}
Moves an item from a user’s inventory into their character’s inventory.
move_item_to_user_from_character(map()) :: {:ok, map()} | {:error, String.t()}
Moves an item from a character’s inventory into the owning user’s inventory.
redeem_coupon(map()) :: {:ok, map()} | {:error, String.t()}
Adds the virtual goods associated with the coupon to the user’s inventory. Coupons can be generated via the Economy->Catalogs tab in the PlayFab Game Manager.
report_player(map()) :: {:ok, map()} | {:error, String.t()}
Submit a report about a player (due to bad bahavior, etc.) on behalf of another player, so that customer service representatives for the title can take action concerning potentially toxic players.
revoke_inventory_item(map()) :: {:ok, map()} | {:error, String.t()}
Revokes access to an item in a user’s inventory
subtract_character_virtual_currency(map()) :: {:ok, map()} | {:error, String.t()}
Decrements the character’s balance of the specified virtual currency by the stated amount. It is possible to make a VC balance negative with this API.
subtract_user_virtual_currency(map()) :: {:ok, map()} | {:error, String.t()}
Decrements the user’s balance of the specified virtual currency by the stated amount. It is possible to make a VC balance negative with this API.
unlock_container_instance(map()) :: {:ok, map()} | {:error, String.t()}
Opens a specific container (ContainerItemInstanceId), with a specific key (KeyItemInstanceId, when required), and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem.
unlock_container_item(map()) :: {:ok, map()} | {:error, String.t()}
Searches Player or Character inventory for any ItemInstance matching the given CatalogItemId, if necessary unlocks it using any appropriate key, and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem.
update_user_inventory_item_custom_data(map()) :: {:ok, map()} | {:error, String.t()}
Updates the key-value pair data tagged to the specified item, which is read-only from the client.