Skip to main content

Owned Props Device

The owned_props_device is a creative device that manages the purchase and display of multiple items defined by individual owned_prop entries. It integrates with an ownership system and uses persistent data to track currency and item acquisition. The following sections document the editable properties for both the owned_props_device and the individual owned_prop.

Properties​

Props​

Type: []owned_prop
A list of purchasable items. Each item defines its unique key, name, purchase button, and associated visual assets.

CounterKey​

Type: string
The key used to access persistent data for tracking the currency balance.
Default: "coin"

CurrencyName​

Type: string
The display name of the currency used for purchases.
Default: "Squatch Bucks"

OwnershipDevice​

Type: ownership_device
An external device responsible for managing ownership, linking this device to the overall ownership system.

PurchaseFailedTrigger​

Type: trigger_device
A trigger activated when a purchase attempt fails (e.g., insufficient funds or a transaction error).

PurchaseSucceedTrigger​

Type: trigger_device
A trigger activated when a purchase is successful.

owned_prop Editable Properties​

An owned_prop represents a single item that can be purchased. It defines the visual and interactive elements associated with the item.

Key​

Type: string
A unique key stored in persistent data for this item.
ToolTip: "Unique key stored in the persistent data for this item"
Default: "REPLACE_ME_WITH_UNIQUE_KEY"

ItemName​

Type: string
The name displayed to the user on the purchase button.
ToolTip: "Displayed to the user on the button to purchase the item"
Default: "ITEM"

PurchaseButton​

Type: button_device
The button device that initiates the purchase process when interacted with.

AcquiredSwitch​

Type: ?switch_device
An optional switch device that can indicate the item has been acquired.

HiddenSwitch​

Type: ?switch_device
An optional switch device that can be used to hide the item under certain conditions.

AcquiredChairDevices​

Type: []chair_device
An array of chair devices that become enabled when the item is acquired.

AcquiredAssets​

Type: []creative_prop
An array of creative props displayed when the item has been acquired.

NotAcquiredAssets​

Type: []creative_prop
An array of creative props displayed when the item has not yet been acquired.

HiddenAssets​

Type: []creative_prop
An array of creative props that remain hidden unless the item is in a specific state.

Cost​

Type: int
The cost of the item in the persistent currency.
Default: 9999999