Loot

_{Version: 1.0.0.0 Updated: 2023-11-29 16:56:05}

Summary

Documentation for the Loot Page

Loot Schema

Name	Type	Required	Description
custom_data	object	No	Custom data associated with the resource
name	string	No	Name of the resource
description	string	No	Description of the resource
item_id	string	No	The Item ID. Optional Item that will be granted to the player if Sub Vendor ID is not specified.
sub_vendor_id	string	No	The Sub Vendor ID. Optional Vendor ID that will be used to fulfill the Loot instead of granting the Item.
quantity	integer	No	The quantity of the Item or Sub Vendor to fulfill. This will be multiplied by the quantity of fulfilled Loot and the parent Loot if quantity_type is relative.
inventory_selector_type	object	Yes	See schema
inventory_operation	object	Yes	See schema
active	boolean	No	Determines if the Loot is active. Inactive Loot will not be fulfilled.
sort_order	integer	No	The sort order of the Loot. Lower sort order will be fulfilled first. Inventory Operation is used as a tie breaker when sort_order is the same.
drop_weight	integer	No	The drop weight of the Loot. Higher drop weight will be more likely to be fulfilled.
fill_in_new_order	boolean	No	When dropped in a randomly sampled vendor, will this create a new order or fill inline?. The primary use case for this is when you want the same loot to be dropped multiple times in a randomly sampled vendor.
allow_partial_bundles	boolean	No	When dropped in a randomly sampled vendor, will the sub vendor allow dropping part of the the bundle? False means it will only drop if the entire sub vendor can be given to the player
required_item_id	string	No	Item required to be owned/rented to drop this Loot in a randomly sampled vendor
required_item_count	integer	No	Amount of the required_item_id to be owned/rented to drop this Loot in a randomly sampled vendor
stack_limit	integer	No	Amount of owned/rented of this Loot’s item that will prevent this Loot from dropping in a randomly sampled vendor
quantity_type	object	No	See schema
quantity_multi_inventory_item_id	string	No	When fulfilling Loot if this is set the quantity will be multiplied by the quantity of this Item in the Player’s Inventory.
is_claimable_by_client	boolean	No	Determines if the Loot can be claimed by the client. This is dangerous without the correct loot confiuration as a client could claim Loot multiple times.
time_frame_id	string	No	The Time Frame ID. Optional Time Frame ID that will be used the expiration of Loot when it is fulfilled.
use_inventory_bucket	object	No	See schema
xp_quantity_transform_type	object	No	See schema
current_price_point_id	string	No	The current price point id. Optional Price Point ID that will be used to determine the price of the Loot when it is fulfilled.
pre_sale_price_point_id	string	No	The pre sale price point id. Optional Price Point ID that will be used to show the previous price of the Loot.
hard_quantity_maximum	integer	No	Hard cap on quantity of an item this Loot can give. Disabled with 0
sandbox_id	string	No	ID of the Sandbox
last_modified_account_id	string	No	Account ID of the user who last modified the resource
last_modified_timestamp	string	No	Timestamp of when the resource was last modified
created_timestamp	string	No	Timestamp of when the resource was created
loot_id	string	Yes	The Loot ID
vendor_id	string	Yes	The Vendor ID
legacy_loot_id	integer	No	The legacy ID of the Loot.
vendor_name	string	No	Name corresponding Vendor ID
sub_vendor_name	string	No	Name corresponding Sub-Vendor ID
item_name	string	No	Name corresponding Item ID
required_item_name	string	No	Name corresponding Required Item ID
quantity_multi_inventory_item_name	string	No	Name corresponding Quantity Multi Inventory Item ID
current_price_point_name	string	No	Name corresponding Current Price Point ID
pre_sale_price_point_name	string	No	Name corresponding Pre-sale Price Point ID

Inventory_selector_type Enum Values

Value	Description
own	The Inventory will be stored across Inventory Sessions.
rent	The Inventory will be stored across Inventory Sessions but will expire after a period of time. Quantity modification will modify the Inventory’s expiration time.
rent_timeframe_locked	The Inventory will be stored across Inventory Sessions by will expire after a period of time. Quantity modification will not modify the Inventory’s expiration time but instead the quantity of the Inventory.
own_transient	The Inventory will by fulfilled as transient Inventory and will not persist across Inventory Sessions.
inherit_entitlement_inventory	Loot fulfilled will look for a parent Entitlement and then grant the Loot as transient Inventory with the rental expiration matching the parent;s expiration.

Inventory_operation Enum Values

Value	Description
add	Add the quantity or expiration of the Inventory.
subtract	Subtract the quantity or expiration of the Inventory.
set	Set the quantity or expiration of the Inventory.
check_greater_than_or_equal	Check if the quantity or expiration of the Inventory is greater than or equal to the value.
check_less_than	Check if the quantity or expiration of the Inventory is less than the value.
check_greater_than_or_equal_and_subtract	Check if the quantity or expiration of the Inventory is greater than or equal to the value and subtract the value from the quantity or expiration.

Quantity_type Enum Values

Value	Description
relative	The quantity will be modified relative to the context in which it is fulfilled.
absolute	The quantity will be modified regardless of the context in which it is fulfilled.

Use_inventory_bucket Enum Values

Value	Description
free	Inventory given away for free.
sweat	Inventory earned by players through in game activities.
none	Inventory that doesn’t belong to any known platform.
anon	Inventory assigned to the anonymous platform.
amazon	Inventory assigned to the amazon platform.
steam	Inventory assigned to the steam platform.
psn	Inventory assigned to the playstation platform.
xbox_live	Inventory assigned to the Xbox platform.
google	Inventory assigned to the Google platform.
twitch	Inventory assigned to the Twitch platform.
nintendo_switch	Inventory assigned to the Nintendo Switch platform.
apple	Inventory assigned to the Apple platform.
nintendo	Inventory assigned to the Nintendo platform.
epic	Inventory assigned to the Epic platform.
google_play	Inventory assigned to the Google Play platform.
nintendo_ppid	Inventory assigned to the Nintendo PPID platform.

Xp_quantity_transform_type Enum Values

Value	Description
none	Quantity will be treated as XP and will not be transformed.
from_current_xp_to_target_additional_level_min_xp	Quantity will be treated as level to fulfill and will be transformed to the amount of XP required to reach the min xp of the fulfilled levels.
from_current_level_min_xp_to_target_additional_level_min_xp	Quantity will be treated as levels to fulfill and will be transformed to the amount of XP required to reach the min xp of the fulfilled levels from the min xp of the current level.
from_zero_to_target_exact_level_min_xp	Quantity will be treated as levels to fulfill and will be transformed to the amount of XP required to reach the min xp of the fulfilled levels from zero xp.