Skip to main content

Udon Product Toggle

tip

Submit an application if you want to join the Creator Economy!

The page below is only relevant to sellers with access to VRChat's Creator Economy.

Udon Product Toggle is a prefab that enables/disables a GameObject when a user owns the Udon Product assigned. This can be used for both local and instance-based objects. Use this in unique ways, like setting up doors that let product owners into private areas, or creating fun, purchasable pop-ups for the entire instance.

How to Import​

  1. Open the Example Central Window from the window from the Unity Editor Menu under "VRChat SDK > 🏠 Example Central"
  2. If you haven't enabled Creator Economy examples yet:
    1. Press the ⚙️ gear icon in the Example Central window to open the Example Central settings.
    2. Enable "Show Creator Economy Examples".
  3. Select this prefab in Example Central.
  4. Press the "Import" button to import the example assets into your project.
Prefabs Included​

  • UdonProductToggleObjectOffLocalPrefab: Sets the target object to be disabled when the local player owns the product.

  • UdonProductToggleObjectOffAnyonePrefab: Sets the target object to be disabled when anyone in the instance owns the product.

    • Use these prefabs when a player must be a product owner to remove something for either themself or the entire instance, like a door to an exclusive part of your world.

  • UdonProductToggleObjectOnLocalPrefab: Sets the target object to be enabled when the local player owns the product.

  • UdonProductToggleObjectOnAnyonePrefab: Sets the target object to be enabled when anyone in the instance owns the product.

    • Use these prefabs when a player must be a product owner to enable something for either themself or the entire instance, like spawning cool effects or new objects.
caution

If viewing the example scene, you'll also need the Open Group Page prefab. Otherwise, your project will be missing what it needs for a complete scene.

How to Use​

For this (and most!) prefabs, you'll first need an UdonProduct to check for and a way for players to buy this product.

Once you've created a purchasable product:

  1. Drag the chosen prefab into your scene. Which prefab you use depends on what logic you would like to have in your world. Each prefab has its own behavior, which you can view in the Prefabs Included section.

DraggingPrefab

  1. In the Inspector, add which Udon Product you would like to check for.

AddProduct

  1. In the Inspector, replace the Target object with whatever object you would like to be enabled/disabled when a player owns the Udon Product. Here's an example of ToggleObjectOff in action:
  1. Run Build & Test!

Inspector Parameters​

  • Udon Product - The Udon Product that determines ownership.
  • Targets - The objects that will be activated/deactivated when the product is bought/expired.
  • Default State - The default state the target's active state will be set to when the product is not bought.
  • Local Only - If true, will only activate/deactivate when it's bought/expired by the local player. If false, will activate/deactivate when it's owned by any player.