Component:WorldOrbSaver

This is a Userspace Only component — It cannot be attached anywhere but inside the userspace. Changing components in userspace is not recommended and may break functionality of your dashboard. Proceed with caution even if you know what you're doing.

Component image 

File:WorldOrbSaverComponent.png

World Orb Saver component as seen in the Scene Inspector

The WorldOrbSaver Component handles when a user is saving a world to their inventory when saving a world in general.

See World for more info about worlds.

Fields

Fields

Name	Type	Description
persistent	Bool	Determines whether or not this item will be saved to the server.
UpdateOrder	Int	Controls the order in which this component is updated.
Enabled	Bool	Controls whether or not this component is enabled. Some components stop their functionality when this field is disabled, but some don't.
Orb	WorldOrb	The orb to save to the user's inventory.
saveHereItem	ContextMenuItem	The context menu item used to trigger "Save Here".
saveToInventoryItem	ContextMenuItem	The context menu item used to trigger "Save to Inventory".
cancelItem	ContextMenuItem	The context menu item used to trigger "Cancel"
menu	ContextMenu	The context menu that was opened to handle this item's menu.
interactive	Bool	Whether this item is interactive or not.
saving	Bool	Whether this item is currently saving to the user's inventory.

Sync Delegates

Triggers

Method Name	Method type and Arguments.	Is the method hidden?	Description
OnSaveHere:ButtonEventHandler	ButtonEventHandler	✓	Handles when the item is being "saved here".
OnSaveToInventory:ButtonEventHandler	ButtonEventHandler	✓	Handles when the item is being saved to inventory.
OnCancel:ButtonEventHandler	ButtonEventHandler	✓	Handles when the saving of this item is being canceled.

Usage

See World for more info about worlds.

Examples

See World for more info about worlds.

See Also

• World