Component:SessionUserController: Difference between revisions

From Resonite Wiki
Automated: update SyncDelegates
add info
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{UserspaceComponent}}
{{Infobox Component
{{Infobox Component
|Image=SessionUserControllerComponent.png
|Image=SessionUserControllerComponent.png
|Name=Session User Controller
|Name=Session User Controller
}}
}}
{{stub}}
The '''SessionUserController''' component is used to control a user in a session granted the local user has the proper permissions.


== Usage ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|_name|'''[[Component:Text|Text]]'''|TypeAdv0=true|
|_name|'''[[Component:Text|Text]]'''|TypeAdv0=true| The name of the target user.
|_slider|'''[[Component:Slider`1|Slider`1]]<[[Type:Float|Float]]>'''|TypeAdv1=true|
|_slider|'''[[Component:Slider`1|Slider`1]]<[[Type:Float|Float]]>'''|TypeAdv1=true| The slider used to change the volume of the target user.
|_mute|'''[[Component:Button|Button]]'''|TypeAdv2=true|
|_mute|'''[[Component:Button|Button]]'''|TypeAdv2=true| The button used to mute the target user.
|_jump|'''[[Component:Button|Button]]'''|TypeAdv3=true|
|_jump|'''[[Component:Button|Button]]'''|TypeAdv3=true| The button used to jump to the target user.
|_respawn|'''[[Component:Button|Button]]'''|TypeAdv4=true|
|_respawn|'''[[Component:Button|Button]]'''|TypeAdv4=true| The button used to respawn the target  user.
|_silence|'''[[Component:Button|Button]]'''|TypeAdv5=true|
|_silence|'''[[Component:Button|Button]]'''|TypeAdv5=true| The button used to silence the target user.
|_kick|'''[[Component:Button|Button]]'''|TypeAdv6=true|
|_kick|'''[[Component:Button|Button]]'''|TypeAdv6=true| The button used to kick the target user.
|_ban|'''[[Component:Button|Button]]'''|TypeAdv7=true|
|_ban|'''[[Component:Button|Button]]'''|TypeAdv7=true| The button used to ban the target user.
}}
}}


== Sync Delegates ==
== Sync Delegates ==
{{Table ComponentTriggers
{{Table ComponentTriggers
|OnMute[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true|
|OnMute:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Called when the mute target user button is touched.
|OnJump[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true|
|OnJump:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Called when the jump to target user button is touched.
|OnRespawn[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true|
|OnRespawn:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Called when the respawn target user button is touched.
|OnSilence[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true|
|OnSilence:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Called when the silence target user button is touched.
|OnKick[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true|
|OnKick:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Called when the kick target user button is touched.
|OnBan[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true|
|OnBan:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Called when the ban target user button is touched.
}}
}}


== Behavior ==
== Usage ==
Not to be used directly by the user.


== Examples ==
== Examples ==
Is used in the session tab in the dash.


== See Also ==
== See Also ==
Line 35: Line 38:
[[Category:Components:Uncategorized{{#translation:}}|Session User Controller]]
[[Category:Components:Uncategorized{{#translation:}}|Session User Controller]]
[[Category:Components{{#translation:}}|Session User Controller]]
[[Category:Components{{#translation:}}|Session User Controller]]
[[Category:ComponentStubs]]

Latest revision as of 17:28, 8 April 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.
Component image 
File:SessionUserControllerComponent.png
Session User Controller component as seen in the Scene Inspector

The SessionUserController component is used to control a user in a session granted the local user has the proper permissions.

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.
_name Text The name of the target user.
_slider Slider`1<Float> The slider used to change the volume of the target user.
_mute Button The button used to mute the target user.
_jump Button The button used to jump to the target user.
_respawn Button The button used to respawn the target user.
_silence Button The button used to silence the target user.
_kick Button The button used to kick the target user.
_ban Button The button used to ban the target user.

Sync Delegates

Triggers
Method Name Method type and Arguments. Is the method hidden? Description
OnMute:ButtonEventHandler ButtonEventHandler Called when the mute target user button is touched.
OnJump:ButtonEventHandler ButtonEventHandler Called when the jump to target user button is touched.
OnRespawn:ButtonEventHandler ButtonEventHandler Called when the respawn target user button is touched.
OnSilence:ButtonEventHandler ButtonEventHandler Called when the silence target user button is touched.
OnKick:ButtonEventHandler ButtonEventHandler Called when the kick target user button is touched.
OnBan:ButtonEventHandler ButtonEventHandler Called when the ban target user button is touched.

Usage

Not to be used directly by the user.

Examples

Is used in the session tab in the dash.

See Also