Component:SessionUserController

This is a Userspace Only component — It cannot be attached anywhere but inside the userspace. Changing components in userspace is not recommended and may break functionality of your dashboard. Proceed with caution even if you 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.