Component:SessionPermissionController: Difference between revisions

Latest revision as of 17:23, 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:SessionPermissionControllerComponent.png

Session Permission Controller component as seen in the Scene Inspector

The SessionPermissionController component is used to change the roles or view the roles of a specific user in the current session.

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 text element showing the name of the user this belongs to.
`_rolesButtons`	list of Button	A list of button elements used to assign the user this belongs to to a role.

Sync Delegates

Triggers
Method Name	Method type and Arguments.	Is the method hidden?	Description
SetRole:ButtonEventHandler`1<Int>	ButtonEventHandler`1<Int>	✓	Called when one of the `_rolesButtons` are touched.

Usage

Not to be used directly by the user.

Examples

Is used in the session tab in the dash.

@@ Line 1: / Line 1: @@
+{{UserspaceComponent}}
 {{Infobox Component
 |Image=SessionPermissionControllerComponent.png
 |Name=Session Permission Controller
 }}
-{{stub}}
+The '''SessionPermissionController''' component is used to change the roles or view the roles of a specific user in the current session.
-== Usage ==
+== Fields ==
 {{Table ComponentFields
-|_name|'''[[Component:Text|Text]]'''|TypeAdv0=true|
+|_name|'''[[Component:Text|Text]]'''|TypeAdv0=true| The text element showing the name of the user this belongs to.
-|_rolesButtons|{{RootFieldType|SyncRefList`1|[[Component:Button|Button]]}}|TypeAdv1=true|
+|_rolesButtons|{{RootFieldType|SyncRefList`1|[[Component:Button|Button]]}}|TypeAdv1=true| A list of button elements used to assign the user this belongs to to a role.
 }}
 == Sync Delegates ==
 {{Table ComponentTriggers
-|SetRole:[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Type:Int|Int]]&gt;|[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Type:Int|Int]]&gt;|true|
+|SetRole:[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Type:Int|Int]]&gt;|[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Type:Int|Int]]&gt;|true| Called when one of the <code>_rolesButtons</code> are touched.
 }}
-== Behavior ==
+== Usage ==
+Not to be used directly by the user.
 == Examples ==
+Is used in the session tab in the dash.
 == See Also ==
@@ Line 24: / Line 27: @@
 [[Category:Components:Uncategorized{{#translation:}}|Session Permission Controller]]
 [[Category:Components{{#translation:}}|Session Permission Controller]]
-[[Category:ComponentStubs]]