# Collectable {% hint style="success" %} **COPY/PASTE PARAMETERS** New in GM 0.11! Right click on a behaviour or component to copy. Then open an object, add the same behaviour or component, and right click it to paste identical parameter settings. {% endhint %}

Consumables (0.10) Let players decide when to consume Inventory items for an effect (press C) GM Consumables collectable component sm opt.gif

Message on Equip (0.9) Send a message each time a player equips collected equipment GM 0.9 Collectable message on equip.gif


Consumables (0.10)	Let players decide when to consume Inventory items for an effect (press `C`)	GM Consumables collectable component sm opt.gif
Message on Equip (0.9)	Send a message each time a player equips collected equipment	GM 0.9 Collectable message on equip.gif
Multiplayer Rework (0.10)	Global toggle merges Curio: True - One player collects False - Every player collects	component_CurioMerge_collectable-resize.gif

Multiplayer Rework (0.10)

Global toggle merges Curio:
True - One player collects

False - Every player collects

component_CurioMerge_collectable-resize.gif

{% hint style="info" %} [build-singleplayer-and-multiplayer-logic](https://docs.sandbox.game/en/creator/game-maker/docs/build-singleplayer-and-multiplayer-logic "mention") - about **\[SP]** or **\[MP]** behaviours or components {% endhint %} ## ![](https://331512196-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F83PS3g9zpWmq73xzlwFn%2Fuploads%2FeCD4SFNnAcAy85tdx0ai%2Fimage.png?alt=media\&token=c58f5cd8-3eb0-4289-bf49-20a07a78f2b5) Collectable \[SP] \[MP] * Collect an object by interaction (press **`E`**) or collision (enters the player Inventory) ## Communications


Inputs: Collect an object by: Interacting (press `E`) Collision The object enters the player Inventory	Outputs: One message may be sent when the object is: collected consumed from Inventory (press `C`) equipped (equipment assets) unequipped (equipment assets)

Inputs:
Collect an object by:

Interacting (press E)
Collision

The object enters the player Inventory

Outputs:

One message may be sent when the object is:

collected
consumed from Inventory (press C)
equipped (equipment assets)
unequipped (equipment assets)

## Common Uses * Trigger gameplay, Avatar buffs/debuffs, etc. based on player choice when collected objects are: * Equipped (if equipment) * :new: Consumed (if set as consumable with toggle) * Unequipped (if equipment) * Collecting objects as part of a story or quest (materials, special items, etc) * Rewarding players gradually for risk-taking by allowing them to access increasingly beneficial Equipment to use * Motivating players to explore by finding hidden items and/or collecting all items * Creating what feels like an economy to purchase items, though the player Inventory currently does not track items being consumed * Any game with a mechanic to make Objects disappear upon collision (which will add up in the player Inventory) * Combine Equip and Unequip messages to sense if a player is wearing the correct items for a certain location like a disguise. * Use Auto Equip to immediately award abilities when players are in a race so they don't waste time in the inventory menu. Or use it to switch players to non-ability equipment to knock them out of the sky mid-flight. ## Parameters | Options | Details | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |

Global (toggle in MP Collectable)

True - One instance per Experience to collect
False - One instance per player to collect

| | ![](https://331512196-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F83PS3g9zpWmq73xzlwFn%2Fuploads%2FwW5LdAPMOKWz0FZ6eAvi%2Fimage.png?alt=media\&token=8df49c16-415c-479e-9e40-90f20ca43c55) | **Collect Action** - Defines how the collection occurs (Avatar collision or interaction) | | ![](https://content.gitbook.com/content/83PS3g9zpWmq73xzlwFn/blobs/jj34h1XNntjJNyEnll80/2.png) |

Display Name - Name of the object displayed in the bottom right when collected
(Note: asset name appears in Inventory)

| |

| **Collect Amount** - How many objects are added to the Inventory when collected | | ![](https://content.gitbook.com/content/83PS3g9zpWmq73xzlwFn/blobs/rEwQQN8Do4WPuzblo8Db/3.png) | **Collect Sound** - Sound played when collected | |

| **Message on Collect** - Message sent when collected | |

Broadcast Type (dropdown) -

How the message will be sent

Options may include additional parameters

| | ![](https://331512196-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F83PS3g9zpWmq73xzlwFn%2Fuploads%2F7HL7lktRRuOneL7iVNOi%2Fimage.png?alt=media\&token=cc293941-11d1-486c-9763-d16c96453100) | **Shows in Inventory** (toggle) - default is on. Toggle to false to hide items from inventory view - good for items designed for rules or other interactions where the player doesn't need to see them. It will also disable Droppable, Consumable, and Equip options. | |

| **Is Droppable** (toggle) - can drop via Inventory | |

| **Is Consumable** (toggle) - players can consume and send a message to trigger logic (broadcast to all, self/player, or rules) | |

On Equip Broadcast (for equipment assets)
Message on Equip - message sent when the collected equipment is applied to the player's avatar (sent every time it is equipped)
Equip Broadcast Type - How the message is sent

All - send to all systems
Self - send to the player wearing the item (use for power-up messages such as Health, Speed, and Oxygen for buffs/debuffs)
Rules - send to Rules System

Message on Unequip - message sent when items are removed by the player.
Auto Equip (toggle) - item is immediately put on by the player when they collect it.

| ## On Equip - Effects & Enhancement --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.sandbox.game/en/creator/game-maker/docs/components/actions/collectable.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.