Component:WorldSwitcher: Difference between revisions

From Resonite Wiki
Automated: update SyncDelegates
add info
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{UserspaceComponent}}
{{Legacy}}
{{Infobox Component
{{Infobox Component
|Image=WorldSwitcherComponent.png
|Image=WorldSwitcherComponent.png
|Name=World Switcher
|Name=World Switcher
}}
}}
{{stub}}
The '''WorldSwitcher''' component is legacy content for switching worlds via rotating the wrist.


== Usage ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|Show|Bool|
|Show|Bool| Whether the switcher should be shown.
|IgnoreTouchesFrom|Slot|
|IgnoreTouchesFrom|Slot| A slot to ignore touch events from. like the hand it is on.
|_repulsionTree|'''[[Component:RepulsionTreeSimulator|RepulsionTreeSimulator]]'''|TypeAdv2=true|
|_repulsionTree|'''[[Component:RepulsionTreeSimulator|RepulsionTreeSimulator]]'''|TypeAdv2=true| The repulsion tree used to arrange the orbs in the menu.
|_linesMesh|{{RootFieldType|DriveRef`1|[[Component:MultiSegmentMesh|MultiSegmentMesh]]}}|TypeAdv3=true|
|_linesMesh|{{RootFieldType|DriveRef`1|[[Component:MultiSegmentMesh|MultiSegmentMesh]]}}|TypeAdv3=true| A multi segment mesh used to create the selection and indication visuals.
|_slider|'''[[Component:Slider|Slider]]'''|TypeAdv4=true|
|_slider|'''[[Component:Slider|Slider]]'''|TypeAdv4=true| The slider used as part of the selection menu.
|_centerOrb|Slot|
|_centerOrb|Slot| The center orb that moves the rest of the orbs to places around it.
|_visualRoot|Slot|
|_visualRoot|Slot| The root slot for all the visuals of the switcher.
}}
}}


== Sync Delegates ==
== Sync Delegates ==
{{Table ComponentTriggers
{{Table ComponentTriggers
|WorldOrbTouched[[Type:Action`2|Action`2]]<[[Component:WorldOrb|WorldOrb]], [[Type:TouchEventInfo|TouchEventInfo]]>|[[Type:Action`2|Action`2]]<[[Component:WorldOrb|WorldOrb]], [[Type:TouchEventInfo|TouchEventInfo]]>|true|
|WorldOrbTouched:[[Type:Action`2|Action`2]]<[[Component:WorldOrb|WorldOrb]], [[Type:TouchEventInfo|TouchEventInfo]]>|[[Type:Action`2|Action`2]]<[[Component:WorldOrb|WorldOrb]], [[Type:TouchEventInfo|TouchEventInfo]]>|true| Handles when a world orb is touched for switching to it.
|WorldOrbLongPressed[[Type:Action`1|Action`1]]<[[Component:WorldOrb|WorldOrb]]>|[[Type:Action`1|Action`1]]<[[Component:WorldOrb|WorldOrb]]>|true|
|WorldOrbLongPressed:[[Type:Action`1|Action`1]]<[[Component:WorldOrb|WorldOrb]]>|[[Type:Action`1|Action`1]]<[[Component:WorldOrb|WorldOrb]]>|true| Handles when a world orb is long touched to bring up options.
}}
}}


== Behavior ==
== Usage ==
Can be brought up through the legacy world switcher option in the legacy settings options.


== Examples ==
== Examples ==
Used as part of the old systems older platforms had.


== See Also ==
== See Also ==
* [[World]]


[[Category:Components:Uncategorized{{#translation:}}|World Switcher]]
[[Category:Components:Uncategorized{{#translation:}}|World Switcher]]
[[Category:Components{{#translation:}}|World Switcher]]
[[Category:Components{{#translation:}}|World Switcher]]
[[Category:ComponentStubs]]

Latest revision as of 00:21, 4 May 2025

This is a userspace component — you cannot attach it anywhere but the userspace. Messing with the userspace can be fun, but it is not recommended as you risk messing your dash up if you don't know what you're doing.
This article describes a feature marked as legacy—this usually means there's a newer, better alternative. Legacy features might not be removed but they will not be updated, and the team will not provide any support for them.
Component image 
File:WorldSwitcherComponent.png
World Switcher component as seen in the Scene Inspector

The WorldSwitcher component is legacy content for switching worlds via rotating the wrist.

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.
Show Bool Whether the switcher should be shown.
IgnoreTouchesFrom Slot A slot to ignore touch events from. like the hand it is on.
_repulsionTree RepulsionTreeSimulator The repulsion tree used to arrange the orbs in the menu.
_linesMesh reference drive of MultiSegmentMesh A multi segment mesh used to create the selection and indication visuals.
_slider Slider The slider used as part of the selection menu.
_centerOrb Slot The center orb that moves the rest of the orbs to places around it.
_visualRoot Slot The root slot for all the visuals of the switcher.

Sync Delegates

Triggers
Method Name Method type and Arguments. Is the method hidden? Description
WorldOrbTouched:Action`2<WorldOrb, TouchEventInfo> Action`2<WorldOrb, TouchEventInfo> Handles when a world orb is touched for switching to it.
WorldOrbLongPressed:Action`1<WorldOrb> Action`1<WorldOrb> Handles when a world orb is long touched to bring up options.

Usage

Can be brought up through the legacy world switcher option in the legacy settings options.

Examples

Used as part of the old systems older platforms had.

See Also