Component:LegacySessionOrbsController: Difference between revisions

From Resonite Wiki
add info
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=SessionOrbsControllerComponent.png
|Image=SessionOrbsControllerComponent.png
|Name=Session Orbs Controller
|Name=Legacy Session Orbs Controller
}}
}}
The '''LegacySessionOrbsController''' component comes from Legacy content migrated from old platforms. This component was used in what players called the "Session plate" which would have many world orbs of active sessions. This component is however used in new content, as its currently the only way to display orbs of current sessions into a slot.


<!--T:2-->
<!--T:2-->
== Fields ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|SpawnRadius|Float|
|SpawnRadius|Float| The radius of spawning orbs in a cylinder shape.
|SpawnHeight|Float|
|SpawnHeight|Float| The height of spawning orbs in a cylinder shape.
|SpawnOffset|Float3|
|SpawnOffset|Float3| The offset of the spawn cylinder shape in local space vs the center on <code>_root</code>
|_root|Slot|
|_root|Slot| Where to place and spawn session orbs.
|MaxOrbs|Int|
|MaxOrbs|Int| How many orbs can be under <code>_root</code> at any one time.
|ShowHeadless|Bool|
|ShowHeadless|Bool| Whether to show headless sessions
}}
}}


<!--T:3-->
<!--T:3-->
== Usage ==
== Usage ==
Used in items that display current sessions in Resonite.


<!--T:4-->
<!--T:4-->
== Examples ==
== Examples ==
{{stub}}


<!--T:5-->
<!--T:5-->
== Related Components ==
== See Also ==
</translate>
</translate>
[[Category:ComponentStubs]]
[[Category:Components{{#translation:}}|Session Orbs Controller]]
[[Category:Components{{#translation:}}|Session Orbs Controller]]
[[Category:Components:Cloud{{#translation:}}|Session Orbs Controller]]
[[Category:Components:Cloud{{#translation:}}|Session Orbs Controller]]

Revision as of 20:21, 21 January 2025

Component image 
Legacy Session Orbs Controller component as seen in the Scene Inspector

The LegacySessionOrbsController component comes from Legacy content migrated from old platforms. This component was used in what players called the "Session plate" which would have many world orbs of active sessions. This component is however used in new content, as its currently the only way to display orbs of current sessions into a slot.

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.
SpawnRadius Float The radius of spawning orbs in a cylinder shape.
SpawnHeight Float The height of spawning orbs in a cylinder shape.
SpawnOffset Float3 The offset of the spawn cylinder shape in local space vs the center on _root
_root Slot Where to place and spawn session orbs.
MaxOrbs Int How many orbs can be under _root at any one time.
ShowHeadless Bool Whether to show headless sessions

Usage

Used in items that display current sessions in Resonite.

Examples

This article or section is a Stub. You can help the Resonite Wiki by expanding it.

See Also