Component image 
World Orb component as seen in the Scene Inspector
For full usage see World Orb.
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. |
SessionStartingUser
|
User | The user that started the session if this is a session orb. |
URL
|
Uri | The session or world this goes to. |
ActiveSessionURLs
|
direct SyncFieldList`1<Uri> | A list of currently active sessions for the worldmm. |
CreateIfNotExists
|
delegate of identity WorldCreator | A sync delegate to call when a session does not exist for the world for this world orb. Passes this component as an argument. |
OpenActionOverride
|
delegate of identity Action`1<WorldOrb> | The Sync delegate to call as an override for this world orb's open Action. Passes this component as an argument. |
Visit
|
WorldOrb.VisitState | Whether the local user has visted the target world. |
ActiveUsers
|
Int | How many active users are in the target world. |
RecordStateUpdated
|
Bool | Whether the world orb has up to date info after spawn. |
IsPublic
|
Bool | Whether the world is public. |
CanModify
|
Bool | Whether the world can be modified and saved. |
LongPressIndicatorColor
|
ColorX | The color to use when the world orb is long pressed. |
LongPressTime
|
Float | How long the user has to click to trigger a long press. |
_longPressIndicator
|
RingMesh | The mesh that fills a ring indicator when doing a long press. |
_longPressIndicatorMaterial
|
UnlitMaterial | The material used to indicate a long press. |
Touched
|
delegate of identity Action`2<WorldOrb, TouchEventInfo> | The Sync delegate to trigger when this world orb is touched. Sends this component and the touch info as arguments to the Sync Delegate. |
LongPressTriggered
|
delegate of identity Action`1<WorldOrb> | The Sync delegate to trigger when long pressing. Passes this component as an argument to the Sync delegate. |
_lastFetchedUrl
|
Uri | The last URL fetched for this world. |
_isReadOnly
|
Bool | |
_orbRoot
|
Slot | The slot storing the world orb visual. |
_infoRoot
|
Slot | The slot storing the text visual for information about the world. |
_thumbTex
|
StaticTexture2D | The texture being used to store the picture of the 360 session preview |
_thumbMaterial
|
Projection360Material | The material making the inner world preview/session 360 picture. |
_shellMaterial
|
reference drive of PBS_RimMetallic | The material making a rim lighting around the world orb. |
_nameText
|
TextRenderer | The text renderer showing the name of the world. |
_creatorText
|
TextRenderer | The text renderer showing the name of the creator of the world. |
_visitsText
|
TextRenderer | The text renderer showing the current world visits number. |
_usersText
|
TextRenderer | The text renderer showing the current users number. |
_namePosition
|
field drive of Float3 | The field to drive with the position of the world name text. |
_creatorPosition
|
field drive of Float3 | The field to drive with the position of the creator name text. |
_visitsPosition
|
field drive of Float3 | The field to drive with the position of the visits amount. |
_usersPosition
|
field drive of Float3 | The field to drive with the position of the user count text. |
_userCountText
|
field drive of String | The field to drive with the world orb's world user count. |
_sizeDrive
|
field drive of Float3 | The field to drive with the world orb's scale. |
_iconSlot
|
Slot | The root slot of the icon visual. |
_iconTexture
|
StaticTexture2D | The icon texture for this world orb's icon. |
_iconMaterial
|
UnlitMaterial | The Unlit Material for showing the icon. |
_iconPosition
|
field drive of Float3 | The field to drive with the position of the world icon. |
_sessionStartDialog
|
direct SlotCleanupRef`1<NewWorldDialog> | The current dialogue for starting a new session |
_lastTouch
|
Double | The last time in world time that a user touched the orb. |
_lastFlash
|
Double | The last time in world time that a user double clicked the orb. |
Sync Delegates
| Method Name | Method type and Arguments. | Is the method hidden? | Description |
|---|---|---|---|
CustomWorldStart:Action`1<NewWorldDialog>
|
Action`1<NewWorldDialog> | ✓ | |
OnStartNewSession:ButtonEventHandler
|
ButtonEventHandler | ✓ | |
OnStartCustomSession:ButtonEventHandler
|
ButtonEventHandler | ✓ | |
OnJoinSession:ButtonEventHandler
|
ButtonEventHandler | ✓ | |
OnEditMetadata:ButtonEventHandler
|
ButtonEventHandler | ✓ | |
OnCancelMenu:ButtonEventHandler
|
ButtonEventHandler | ✓ | |
OnCloneWorld:ButtonEventHandler
|
ButtonEventHandler | ✓ | |
OnDeleteWorld:ButtonEventHandler
|
ButtonEventHandler | ✓ | |
OnReallyDeleteWorld:ButtonEventHandler
|
ButtonEventHandler | ✓ | |
OnOverwrite:ButtonEventHandler`1<WorldOrb>
|
ButtonEventHandler`1<WorldOrb> | ✓ |
VisitState
| Name | Value | Description |
|---|---|---|
Visited
|
0 | The user has visited the world before, and there are no new updates. |
Updated
|
1 | The user has visited the world before, but it has been updated since then. |
New
|
2 | The user has never visited the target world. |
Usage
See World Orb.
Examples
See World Orb page for a picture of one.