Component:WorldOrb: Difference between revisions

From Resonite Wiki
← Older edit
Visual
Automated: update Fields, Categories
add sync delegate desc
 
(6 intermediate revisions by 3 users not shown)
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=WorldOrbComponent.png
|Image=WorldOrbComponent.png
|Name=WorldOrb
|Name=World Orb
}}
}}
 
For full usage see [[World Orb]].
<!--T:2-->
== Intoduction ==


<!--T:3-->
<!--T:3-->
== Usage ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|SessionStartingUser|User|
|SessionStartingUser|User| The user that started the session if this is a session orb.
|URL|Uri|
|URL|Uri| The session or world this goes to.
|ActiveSessionURLs|{{RootFieldType|SyncFieldList`1|[[Type:Uri|Uri]]}}|TypeAdv2=true|
|ActiveSessionURLs|{{RootFieldType|SyncFieldList`1|[[Type:Uri|Uri]]}}|TypeAdv2=true| A list of currently active sessions for the worldmm.
|CreateIfNotExists|{{RootFieldType|SyncDelegate`1|[[Type:WorldCreator|WorldCreator]]}}|TypeAdv3=true|
|CreateIfNotExists|{{RootFieldType|SyncDelegate`1|[[Type:WorldCreator|WorldCreator]]}}|TypeAdv3=true| 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|{{RootFieldType|SyncDelegate`1|[[Type:Action`1|Action`1]]&lt;[[Component:WorldOrb|WorldOrb]]&gt;}}|TypeAdv4=true|
|OpenActionOverride|{{RootFieldType|SyncDelegate`1|[[Type:Action`1|Action`1]]&lt;[[Component:WorldOrb|WorldOrb]]&gt;}}|TypeAdv4=true| The Sync delegate to call as an override for this world orb's open Action. Passes this component as an argument.
|Visit|'''[[#VisitState|VisitState]]'''|TypeAdv5=true|
|Visit|'''[[#VisitState|WorldOrb.VisitState]]'''|TypeAdv5=true| Whether the local user has visted the target world.
|ActiveUsers|Int|
|ActiveUsers|Int| How many active users are in the target world.
|RecordStateUpdated|Bool|
|RecordStateUpdated|Bool| Whether the world orb has up to date info after spawn.
|IsPublic|Bool|
|IsPublic|Bool| Whether the world is public.
|CanModify|Bool|
|CanModify|Bool| Whether the world can be modified and saved.
|LongPressIndicatorColor|ColorX|
|LongPressIndicatorColor|ColorX| The color to use when the world orb is long pressed.
|LongPressTime|Float|
|LongPressTime|Float| How long the user has to click to trigger a long press.
|_longPressIndicator|'''[[Component:RingMesh|RingMesh]]'''|TypeAdv12=true|
|_longPressIndicator|'''[[Component:RingMesh|RingMesh]]'''|TypeAdv12=true| The mesh that fills a ring indicator when doing a long press.
|_longPressIndicatorMaterial|'''[[UnlitMaterial|UnlitMaterial]]'''|TypeAdv13=true|
|_longPressIndicatorMaterial|'''[[Component:UnlitMaterial|UnlitMaterial]]'''|TypeAdv13=true| The material used to indicate a long press.
|Touched|{{RootFieldType|SyncDelegate`1|[[Type:Action`2|Action`2]]&lt;[[Component:WorldOrb|WorldOrb]], [[Type:TouchEventInfo|TouchEventInfo]]&gt;}}|TypeAdv14=true|
|Touched|{{RootFieldType|SyncDelegate`1|[[Type:Action`2|Action`2]]&lt;[[Component:WorldOrb|WorldOrb]], [[Type:TouchEventInfo|TouchEventInfo]]&gt;}}|TypeAdv14=true| 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|{{RootFieldType|SyncDelegate`1|[[Type:Action`1|Action`1]]&lt;[[Component:WorldOrb|WorldOrb]]&gt;}}|TypeAdv15=true|
|LongPressTriggered|{{RootFieldType|SyncDelegate`1|[[Type:Action`1|Action`1]]&lt;[[Component:WorldOrb|WorldOrb]]&gt;}}|TypeAdv15=true| The Sync delegate to trigger when long pressing. Passes this component as an argument to the Sync delegate.
|_lastFetchedUrl|Uri|
|_lastFetchedUrl|Uri| The last URL fetched for this world.
|_orbRoot|Slot|
|_isReadOnly|Bool| The target world is a read only world, no saving.
|_infoRoot|Slot|
|_orbRoot|Slot| The slot storing the world orb visual.
|_thumbTex|'''[[Component:StaticTexture2D|StaticTexture2D]]'''|TypeAdv19=true|
|_infoRoot|Slot| The slot storing the text visual for information about the world.
|_thumbMaterial|'''[[Projection360Material|Projection360Material]]'''|TypeAdv20=true|
|_thumbTex|'''[[Component:StaticTexture2D|StaticTexture2D]]'''|TypeAdv20=true| The texture being used to store the picture of the 360 session preview
|_shellMaterial|{{RootFieldType|DriveRef`1|[[PBS_RimMetallic|PBS_RimMetallic]]}}|TypeAdv21=true|
|_thumbMaterial|'''[[Component:Projection360Material|Projection360Material]]'''|TypeAdv21=true| The material making the inner world preview/session 360 picture.
|_nameText|'''[[Component:TextRenderer|TextRenderer]]'''|TypeAdv22=true|
|_shellMaterial|{{RootFieldType|DriveRef`1|[[PBS_RimMetallic|PBS_RimMetallic]]}}|TypeAdv22=true| The material making a rim lighting around the world orb.
|_creatorText|'''[[Component:TextRenderer|TextRenderer]]'''|TypeAdv23=true|
|_nameText|'''[[Component:TextRenderer|TextRenderer]]'''|TypeAdv23=true| The text renderer showing the name of the world.
|_visitsText|'''[[Component:TextRenderer|TextRenderer]]'''|TypeAdv24=true|
|_creatorText|'''[[Component:TextRenderer|TextRenderer]]'''|TypeAdv24=true| The text renderer showing the name of the creator of the world.
|_usersText|'''[[Component:TextRenderer|TextRenderer]]'''|TypeAdv25=true|
|_visitsText|'''[[Component:TextRenderer|TextRenderer]]'''|TypeAdv25=true| The text renderer showing the current world visits number.
|_namePosition|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv26=true|
|_usersText|'''[[Component:TextRenderer|TextRenderer]]'''|TypeAdv26=true| The text renderer showing the current users number.
|_creatorPosition|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv27=true|
|_namePosition|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv27=true| The field to drive with the position of the world name text.
|_visitsPosition|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv28=true|
|_creatorPosition|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv28=true| The field to drive with the position of the creator name text.
|_usersPosition|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv29=true|
|_visitsPosition|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv29=true| The field to drive with the position of the visits amount.
|_userCountText|{{RootFieldType|FieldDrive`1|[[Type:String|String]]}}|TypeAdv30=true|
|_usersPosition|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv30=true| The field to drive with the position of the user count text.
|_sizeDrive|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv31=true|
|_userCountText|{{RootFieldType|FieldDrive`1|[[Type:String|String]]}}|TypeAdv31=true| The field to drive with the world orb's world user count.
|_iconSlot|Slot|
|_sizeDrive|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv32=true| The field to drive with the world orb's scale.
|_iconTexture|'''[[Component:StaticTexture2D|StaticTexture2D]]'''|TypeAdv33=true|
|_iconSlot|Slot| The root slot of the icon visual.
|_iconMaterial|'''[[UnlitMaterial|UnlitMaterial]]'''|TypeAdv34=true|
|_iconTexture|'''[[Component:StaticTexture2D|StaticTexture2D]]'''|TypeAdv34=true| The icon texture for this world orb's icon.
|_iconPosition|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv35=true|
|_iconMaterial|'''[[Component:UnlitMaterial|UnlitMaterial]]'''|TypeAdv35=true| The Unlit Material for showing the icon.
|_sessionStartDialog|{{RootFieldType|SlotCleanupRef`1|[[Component:NewWorldDialog|NewWorldDialog]]}}|TypeAdv36=true|
|_iconPosition|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv36=true| The field to drive with the position of the world icon.
|_lastTouch|Double|
|_sessionStartDialog|{{RootFieldType|SlotCleanupRef`1|[[Component:NewWorldDialog|NewWorldDialog]]}}|TypeAdv37=true| The current dialogue for starting a new session
|_lastFlash|Double|
|_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 ==
{{Table ComponentTriggers
|CustomWorldStart:[[Type:Action`1|Action`1]]&lt;[[Component:NewWorldDialog|NewWorldDialog]]&gt;|[[Type:Action`1|Action`1]]&lt;[[Component:NewWorldDialog|NewWorldDialog]]&gt;|true| Handles when the user asks to open a custom world.
|OnStartNewSession:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Handles when the user starts a new session with default settings.
|OnStartCustomSession:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Handles when the user asks to open a custom session.
|OnJoinSession:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Handles when a user joins the target session.
|OnEditMetadata:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Handles when a user asks to edit the metadata.
|OnCancelMenu:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Handles when the user cancels an action in a menu.
|OnCloneWorld:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Handles when the user asks to make a clone of the world.
|OnDeleteWorld:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Handles when the user asks to delete a world.
|OnReallyDeleteWorld:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Handles when the user asks to truely delete a world.
|OnOverwrite:[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Component:WorldOrb|WorldOrb]]&gt;|[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Component:WorldOrb|WorldOrb]]&gt;|true| Handles when the user does a save overwrite.
}}
 
== VisitState ==
{{Table EnumValues
|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.
}}
}}


<!--T:4-->
<!--T:4-->
== Behavior ==
== Usage ==
See [[World Orb]].


<!--T:5-->
<!--T:5-->
== Examples ==
== Examples ==
See [[World Orb]] page for a picture of one.


<!--T:6-->
<!--T:6-->
== Related Components ==
== See Also ==
* [[World Orb]]
</translate>
</translate>
[[Category:Components{{#translation:}}|World Orb]]
[[Category:Components{{#translation:}}|World Orb]]
[[Category:ComponentStubs]]
[[Category:Components With Nested Enums{{#translation:}}|World Orb]]
[[Category:Components With Nested Enums{{#translation:}}|World Orb]]
[[Category:Components:World{{#translation:}}|World Orb]]
[[Category:Components:World{{#translation:}}|World Orb]]

Latest revision as of 00:09, 4 May 2025

Component image 
World Orb component as seen in the Scene Inspector

For full usage see World Orb.

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.
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 The target world is a read only world, no saving.
_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

Triggers
Method Name Method type and Arguments. Is the method hidden? Description
CustomWorldStart:Action`1<NewWorldDialog> Action`1<NewWorldDialog> ✓ Handles when the user asks to open a custom world.
OnStartNewSession:ButtonEventHandler ButtonEventHandler ✓ Handles when the user starts a new session with default settings.
OnStartCustomSession:ButtonEventHandler ButtonEventHandler ✓ Handles when the user asks to open a custom session.
OnJoinSession:ButtonEventHandler ButtonEventHandler ✓ Handles when a user joins the target session.
OnEditMetadata:ButtonEventHandler ButtonEventHandler ✓ Handles when a user asks to edit the metadata.
OnCancelMenu:ButtonEventHandler ButtonEventHandler ✓ Handles when the user cancels an action in a menu.
OnCloneWorld:ButtonEventHandler ButtonEventHandler ✓ Handles when the user asks to make a clone of the world.
OnDeleteWorld:ButtonEventHandler ButtonEventHandler ✓ Handles when the user asks to delete a world.
OnReallyDeleteWorld:ButtonEventHandler ButtonEventHandler ✓ Handles when the user asks to truely delete a world.
OnOverwrite:ButtonEventHandler`1<WorldOrb> ButtonEventHandler`1<WorldOrb> ✓ Handles when the user does a save overwrite.

VisitState

Values
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.

See Also

Retrieved from "https://wiki.resonite.com/index.php?title=Component:WorldOrb&oldid=100815"