Component:SessionControlDialog: Difference between revisions

From Resonite Wiki
← Older editNewer edit →
Visual
mNo edit summary
add info
Line 4: Line 4:
|Name=Session Control Dialog
|Name=Session Control Dialog
}}
}}
{{stub}}
The '''SessionControlDialog''' component is used to edit and view session settings like permissions, roles, and name to list a few.


== Usage ==
See [[Session]].
 
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|ActiveTab|'''[[#Tab|SessionControlDialog.Tab]]'''|TypeAdv0=true|
|ActiveTab|'''[[#Tab|SessionControlDialog.Tab]]'''|TypeAdv0=true| The tab this view is currently on.
|_contentRoot|Slot|
|_contentRoot|Slot| Where to place visuals for session options.
|_worldName|'''[[Component:TextField|TextField]]'''|TypeAdv2=true|
|_worldName|'''[[Component:TextField|TextField]]'''|TypeAdv2=true| The field containing the session name.
|_maxUsers|'''[[Component:IntTextEditorParser|IntTextEditorParser]]'''|TypeAdv3=true|
|_maxUsers|'''[[Component:IntTextEditorParser|IntTextEditorParser]]'''|TypeAdv3=true| The field containing the session max users.
|_awayKickEnabled|'''[[Component:Checkbox|Checkbox]]'''|TypeAdv4=true|
|_awayKickEnabled|'''[[Component:Checkbox|Checkbox]]'''|TypeAdv4=true| The field containing the session away kick enabler.
|_awayKickMinutes|'''[[Component:FloatTextEditorParser|FloatTextEditorParser]]'''|TypeAdv5=true|
|_awayKickMinutes|'''[[Component:FloatTextEditorParser|FloatTextEditorParser]]'''|TypeAdv5=true| The field containing the session away kick minutes.
|_autosaveEnabled|'''[[Component:Checkbox|Checkbox]]'''|TypeAdv6=true|
|_autosaveEnabled|'''[[Component:Checkbox|Checkbox]]'''|TypeAdv6=true| The field containing the session auto save enabler.
|_autosaveMinutes|'''[[Component:FloatTextEditorParser|FloatTextEditorParser]]'''|TypeAdv7=true|
|_autosaveMinutes|'''[[Component:FloatTextEditorParser|FloatTextEditorParser]]'''|TypeAdv7=true| The field containing the session auto save minutes.
|_autocleanEnabled|'''[[Component:Checkbox|Checkbox]]'''|TypeAdv8=true|
|_autocleanEnabled|'''[[Component:Checkbox|Checkbox]]'''|TypeAdv8=true| The field containing the session auto clean enabler.
|_autocleanMinutes|'''[[Component:FloatTextEditorParser|FloatTextEditorParser]]'''|TypeAdv9=true|
|_autocleanMinutes|'''[[Component:FloatTextEditorParser|FloatTextEditorParser]]'''|TypeAdv9=true| The field containing the session auto clean minutes.
|_mobileFriendly|'''[[Component:Checkbox|Checkbox]]'''|TypeAdv10=true|
|_mobileFriendly|'''[[Component:Checkbox|Checkbox]]'''|TypeAdv10=true| The field containing the session mobile friendly enabler.
|_hideFromListing|'''[[Component:Checkbox|Checkbox]]'''|TypeAdv11=true|
|_hideFromListing|'''[[Component:Checkbox|Checkbox]]'''|TypeAdv11=true| The field containing the session hide from listing enabler.
|_description|'''[[Component:TextField|TextField]]'''|TypeAdv12=true|
|_description|'''[[Component:TextField|TextField]]'''|TypeAdv12=true| The field containing the session description.
|_worldNameButton|'''[[Component:Button|Button]]'''|TypeAdv13=true|
|_worldNameButton|'''[[Component:Button|Button]]'''|TypeAdv13=true| The button to edit the session name.
|_descriptionButton|'''[[Component:Button|Button]]'''|TypeAdv14=true|
|_descriptionButton|'''[[Component:Button|Button]]'''|TypeAdv14=true| The button to edit the session description.
|_maxUsersButton|'''[[Component:Button|Button]]'''|TypeAdv15=true|
|_maxUsersButton|'''[[Component:Button|Button]]'''|TypeAdv15=true| The button to edit the session max users.
|_awayKickEnabledButton|'''[[Component:Button|Button]]'''|TypeAdv16=true|
|_awayKickEnabledButton|'''[[Component:Button|Button]]'''|TypeAdv16=true| The button to edit the session away kick enabled status.
|_awayKickMinutesButton|'''[[Component:Button|Button]]'''|TypeAdv17=true|
|_awayKickMinutesButton|'''[[Component:Button|Button]]'''|TypeAdv17=true| The button to edit the session away kick minutes.
|_autosaveEnabledButton|'''[[Component:Button|Button]]'''|TypeAdv18=true|
|_autosaveEnabledButton|'''[[Component:Button|Button]]'''|TypeAdv18=true| The button to edit the session auto save enabled status.
|_autosaveMinutesButton|'''[[Component:Button|Button]]'''|TypeAdv19=true|
|_autosaveMinutesButton|'''[[Component:Button|Button]]'''|TypeAdv19=true| The button to edit the session auto save minutes.
|_autocleanEnabledButton|'''[[Component:Button|Button]]'''|TypeAdv20=true|
|_autocleanEnabledButton|'''[[Component:Button|Button]]'''|TypeAdv20=true| The button to edit the session auto clean enabled button.
|_autocleanMinutesButton|'''[[Component:Button|Button]]'''|TypeAdv21=true|
|_autocleanMinutesButton|'''[[Component:Button|Button]]'''|TypeAdv21=true| The button to edit the session auto clean minutes.
|_mobileFriendlyButton|'''[[Component:Button|Button]]'''|TypeAdv22=true|
|_mobileFriendlyButton|'''[[Component:Button|Button]]'''|TypeAdv22=true| The button to edit the session mobile friendly enabled status.
|_hideFromListingButton|'''[[Component:Button|Button]]'''|TypeAdv23=true|
|_hideFromListingButton|'''[[Component:Button|Button]]'''|TypeAdv23=true| The button to edit the session hide from listing enabled status.
|_permissionOverridesIndicator|'''[[Component:Text|Text]]'''|TypeAdv24=true|
|_permissionOverridesIndicator|'''[[Component:Text|Text]]'''|TypeAdv24=true| The element that shows how many user overrides are currently active for permissions
|_permissionOverridesButton|'''[[Component:Button|Button]]'''|TypeAdv25=true|
|_permissionOverridesButton|'''[[Component:Button|Button]]'''|TypeAdv25=true| The button that resets all user overrides for permissions.
|_getSessionOrb|'''[[Component:Button|Button]]'''|TypeAdv26=true|
|_getSessionOrb|'''[[Component:Button|Button]]'''|TypeAdv26=true| The button that gets the session orb.
|_getWorldOrb|'''[[Component:Button|Button]]'''|TypeAdv27=true|
|_getWorldOrb|'''[[Component:Button|Button]]'''|TypeAdv27=true| The button that gets the world orb.
|_editMode|'''[[Component:Button|Button]]'''|TypeAdv28=true|
|_editMode|'''[[Component:Button|Button]]'''|TypeAdv28=true| The button that enables edit mode for the local user.
|_copySessionURL|'''[[Component:Button|Button]]'''|TypeAdv29=true|
|_copySessionURL|'''[[Component:Button|Button]]'''|TypeAdv29=true| The button that copies the session URL.
|_copyWorldURL|'''[[Component:Button|Button]]'''|TypeAdv30=true|
|_copyWorldURL|'''[[Component:Button|Button]]'''|TypeAdv30=true| The button that copies the world URL.
|_copyRecordURL|'''[[Component:Button|Button]]'''|TypeAdv31=true|
|_copyRecordURL|'''[[Component:Button|Button]]'''|TypeAdv31=true| The button that copies the record URL.
|_accessLevelRadios|{{RootFieldType|SyncRefList`1|[[Type:Radio|Radio]]}}|TypeAdv32=true|
|_accessLevelRadios|{{RootFieldType|SyncRefList`1|[[Type:Radio|Radio]]}}|TypeAdv32=true| The set of radios to set session access level.
|_accessLevelRadiosButtons|{{RootFieldType|SyncRefList`1|[[Component:Button|Button]]}}|TypeAdv33=true|
|_accessLevelRadiosButtons|{{RootFieldType|SyncRefList`1|[[Component:Button|Button]]}}|TypeAdv33=true| The set of radio buttons to set session access level.
|_worldNameSync|'''[[Component:WorldValueSync`1|WorldValueSync`1]]<[[Type:String|String]]>'''|TypeAdv34=true|
|_worldNameSync|'''[[Component:WorldValueSync`1|WorldValueSync`1]]<[[Type:String|String]]>'''|TypeAdv34=true| The field that is used to edit the world Name.
|_descriptionSync|'''[[Component:WorldValueSync`1|WorldValueSync`1]]<[[Type:String|String]]>'''|TypeAdv35=true|
|_descriptionSync|'''[[Component:WorldValueSync`1|WorldValueSync`1]]<[[Type:String|String]]>'''|TypeAdv35=true| The field that is used to edit the world description.
|_maxUsersSync|'''[[Component:WorldValueSync`1|WorldValueSync`1]]<[[Type:Int|Int]]>'''|TypeAdv36=true|
|_maxUsersSync|'''[[Component:WorldValueSync`1|WorldValueSync`1]]<[[Type:Int|Int]]>'''|TypeAdv36=true| The field that is used to edit the world max Users.
|_awayKickEnabledSync|'''[[Component:WorldValueSync`1|WorldValueSync`1]]<[[Type:Bool|Bool]]>'''|TypeAdv37=true|
|_awayKickEnabledSync|'''[[Component:WorldValueSync`1|WorldValueSync`1]]<[[Type:Bool|Bool]]>'''|TypeAdv37=true| The field that is used to edit the world away Kick Enabled.
|_awayKickMinutesSync|'''[[Component:WorldValueSync`1|WorldValueSync`1]]<[[Type:Float|Float]]>'''|TypeAdv38=true|
|_awayKickMinutesSync|'''[[Component:WorldValueSync`1|WorldValueSync`1]]<[[Type:Float|Float]]>'''|TypeAdv38=true| The field that is used to edit the world away Kick Minutes.
|_autosaveEnabledSync|'''[[Component:WorldValueSync`1|WorldValueSync`1]]<[[Type:Bool|Bool]]>'''|TypeAdv39=true|
|_autosaveEnabledSync|'''[[Component:WorldValueSync`1|WorldValueSync`1]]<[[Type:Bool|Bool]]>'''|TypeAdv39=true| The field that is used to edit the world auto save Enabled.
|_autosaveMinutesSync|'''[[Component:WorldValueSync`1|WorldValueSync`1]]<[[Type:Float|Float]]>'''|TypeAdv40=true|
|_autosaveMinutesSync|'''[[Component:WorldValueSync`1|WorldValueSync`1]]<[[Type:Float|Float]]>'''|TypeAdv40=true| The field that is used to edit the world auto save Minutes.
|_autocleanEnabledSync|'''[[Component:WorldValueSync`1|WorldValueSync`1]]<[[Type:Bool|Bool]]>'''|TypeAdv41=true|
|_autocleanEnabledSync|'''[[Component:WorldValueSync`1|WorldValueSync`1]]<[[Type:Bool|Bool]]>'''|TypeAdv41=true| The field that is used to edit the world auto clean Enabled.
|_autocleanSecondsSync|'''[[Component:WorldValueSync`1|WorldValueSync`1]]<[[Type:Float|Float]]>'''|TypeAdv42=true|
|_autocleanSecondsSync|'''[[Component:WorldValueSync`1|WorldValueSync`1]]<[[Type:Float|Float]]>'''|TypeAdv42=true| The field that is used to edit the world auto clean Seconds.
|_mobileFriendlySync|'''[[Component:WorldValueSync`1|WorldValueSync`1]]<[[Type:Bool|Bool]]>'''|TypeAdv43=true|
|_mobileFriendlySync|'''[[Component:WorldValueSync`1|WorldValueSync`1]]<[[Type:Bool|Bool]]>'''|TypeAdv43=true| The field that is used to edit the world mobile Friendly.
|_hideFromListingSync|'''[[Component:WorldValueSync`1|WorldValueSync`1]]<[[Type:Bool|Bool]]>'''|TypeAdv44=true|
|_hideFromListingSync|'''[[Component:WorldValueSync`1|WorldValueSync`1]]<[[Type:Bool|Bool]]>'''|TypeAdv44=true| The field that is used to edit the world hide From Listing.
|_editModeSync|'''[[Component:WorldValueSync`1|WorldValueSync`1]]<[[Type:Bool|Bool]]>'''|TypeAdv45=true|
|_editModeSync|'''[[Component:WorldValueSync`1|WorldValueSync`1]]<[[Type:Bool|Bool]]>'''|TypeAdv45=true| The field that is used to edit the world edit Mode status for the local user.
|_accessLevelSync|'''[[Component:WorldValueSync`1|WorldValueSync`1]]<[[Type:SessionAccessLevel|SessionAccessLevel]]>'''|TypeAdv46=true|
|_accessLevelSync|'''[[Component:WorldValueSync`1|WorldValueSync`1]]<[[Type:SessionAccessLevel|SessionAccessLevel]]>'''|TypeAdv46=true| The field that is used to edit the world access Level.
|_customVerifierLabel|'''[[Component:Text|Text]]'''|TypeAdv47=true|
|_customVerifierLabel|'''[[Component:Text|Text]]'''|TypeAdv47=true| The label used to indicate the world's custom verifier.
|_customVerifierCheckbox|'''[[Component:Checkbox|Checkbox]]'''|TypeAdv48=true|
|_customVerifierCheckbox|'''[[Component:Checkbox|Checkbox]]'''|TypeAdv48=true| The checkbox for enabling/disabling a custom world verifier.
|_customVerifierButton|'''[[Component:Button|Button]]'''|TypeAdv49=true|
|_customVerifierButton|'''[[Component:Button|Button]]'''|TypeAdv49=true| The button for enabling/disabling a custom world verifier.
|_customVerifierSync|'''[[Component:WorldValueSync`1|WorldValueSync`1]]<[[Type:Bool|Bool]]>'''|TypeAdv50=true|
|_customVerifierSync|'''[[Component:WorldValueSync`1|WorldValueSync`1]]<[[Type:Bool|Bool]]>'''|TypeAdv50=true| The field that is used to edit the world custom Verifier.
|_uiContentRoot|Slot|
|_uiContentRoot|Slot| The slot that contains all the ui content of the world.
|_slideSwap|'''[[Component:SlideSwapRegion|SlideSwapRegion]]'''|TypeAdv52=true|
|_slideSwap|'''[[Component:SlideSwapRegion|SlideSwapRegion]]'''|TypeAdv52=true| The swap region used to make the animation for going between session menu views.
|_saveWorld|'''[[Component:Button|Button]]'''|TypeAdv53=true|
|_saveWorld|'''[[Component:Button|Button]]'''|TypeAdv53=true| The button to save world changes.
|_saveWorldAs|'''[[Component:Button|Button]]'''|TypeAdv54=true|
|_saveWorldAs|'''[[Component:Button|Button]]'''|TypeAdv54=true| The button to save the world as a certain name.
|_saveWorldCopy|'''[[Component:Button|Button]]'''|TypeAdv55=true|
|_saveWorldCopy|'''[[Component:Button|Button]]'''|TypeAdv55=true| The button to save a copy of the world.
|_tabButtons|{{RootFieldType|SyncRefList`1|[[Component:Button|Button]]}}|TypeAdv56=true|
|_tabButtons|{{RootFieldType|SyncRefList`1|[[Component:Button|Button]]}}|TypeAdv56=true| A list of the buttons used to change between session menu views.
}}
}}


Line 83: Line 85:
}}
}}


== Behavior ==
== Tab ==
{{Table EnumValues
|Settings|0| The tab is currently on Session Settings.
|Users|1| The tab is currently on Users.
|Permissions|2| The tab is currently on Permissions.
}}
 
== Usage ==
See [[Session]].


== Examples ==
== Examples ==
See [[Session]].


== See Also ==
== See Also ==
* [[Session]]


[[Category:Components:Uncategorized{{#translation:}}|Session Control Dialog]]
[[Category:Components:Uncategorized{{#translation:}}|Session Control Dialog]]
[[Category:Components{{#translation:}}|Session Control Dialog]]
[[Category:Components{{#translation:}}|Session Control Dialog]]
[[Category:Components With Nested Enums{{#translation:}}|Session Control Dialog]]
[[Category:Components With Nested Enums{{#translation:}}|Session Control Dialog]]
[[Category:ComponentStubs]]

Revision as of 22:55, 7 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:SessionControlDialogComponent.png
Session Control Dialog component as seen in the Scene Inspector

The SessionControlDialog component is used to edit and view session settings like permissions, roles, and name to list a few.

See 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.
ActiveTab SessionControlDialog.Tab The tab this view is currently on.
_contentRoot Slot Where to place visuals for session options.
_worldName TextField The field containing the session name.
_maxUsers IntTextEditorParser The field containing the session max users.
_awayKickEnabled Checkbox The field containing the session away kick enabler.
_awayKickMinutes FloatTextEditorParser The field containing the session away kick minutes.
_autosaveEnabled Checkbox The field containing the session auto save enabler.
_autosaveMinutes FloatTextEditorParser The field containing the session auto save minutes.
_autocleanEnabled Checkbox The field containing the session auto clean enabler.
_autocleanMinutes FloatTextEditorParser The field containing the session auto clean minutes.
_mobileFriendly Checkbox The field containing the session mobile friendly enabler.
_hideFromListing Checkbox The field containing the session hide from listing enabler.
_description TextField The field containing the session description.
_worldNameButton Button The button to edit the session name.
_descriptionButton Button The button to edit the session description.
_maxUsersButton Button The button to edit the session max users.
_awayKickEnabledButton Button The button to edit the session away kick enabled status.
_awayKickMinutesButton Button The button to edit the session away kick minutes.
_autosaveEnabledButton Button The button to edit the session auto save enabled status.
_autosaveMinutesButton Button The button to edit the session auto save minutes.
_autocleanEnabledButton Button The button to edit the session auto clean enabled button.
_autocleanMinutesButton Button The button to edit the session auto clean minutes.
_mobileFriendlyButton Button The button to edit the session mobile friendly enabled status.
_hideFromListingButton Button The button to edit the session hide from listing enabled status.
_permissionOverridesIndicator Text The element that shows how many user overrides are currently active for permissions
_permissionOverridesButton Button The button that resets all user overrides for permissions.
_getSessionOrb Button The button that gets the session orb.
_getWorldOrb Button The button that gets the world orb.
_editMode Button The button that enables edit mode for the local user.
_copySessionURL Button The button that copies the session URL.
_copyWorldURL Button The button that copies the world URL.
_copyRecordURL Button The button that copies the record URL.
_accessLevelRadios list of Radio The set of radios to set session access level.
_accessLevelRadiosButtons list of Button The set of radio buttons to set session access level.
_worldNameSync WorldValueSync`1<String> The field that is used to edit the world Name.
_descriptionSync WorldValueSync`1<String> The field that is used to edit the world description.
_maxUsersSync WorldValueSync`1<Int> The field that is used to edit the world max Users.
_awayKickEnabledSync WorldValueSync`1<Bool> The field that is used to edit the world away Kick Enabled.
_awayKickMinutesSync WorldValueSync`1<Float> The field that is used to edit the world away Kick Minutes.
_autosaveEnabledSync WorldValueSync`1<Bool> The field that is used to edit the world auto save Enabled.
_autosaveMinutesSync WorldValueSync`1<Float> The field that is used to edit the world auto save Minutes.
_autocleanEnabledSync WorldValueSync`1<Bool> The field that is used to edit the world auto clean Enabled.
_autocleanSecondsSync WorldValueSync`1<Float> The field that is used to edit the world auto clean Seconds.
_mobileFriendlySync WorldValueSync`1<Bool> The field that is used to edit the world mobile Friendly.
_hideFromListingSync WorldValueSync`1<Bool> The field that is used to edit the world hide From Listing.
_editModeSync WorldValueSync`1<Bool> The field that is used to edit the world edit Mode status for the local user.
_accessLevelSync WorldValueSync`1<SessionAccessLevel> The field that is used to edit the world access Level.
_customVerifierLabel Text The label used to indicate the world's custom verifier.
_customVerifierCheckbox Checkbox The checkbox for enabling/disabling a custom world verifier.
_customVerifierButton Button The button for enabling/disabling a custom world verifier.
_customVerifierSync WorldValueSync`1<Bool> The field that is used to edit the world custom Verifier.
_uiContentRoot Slot The slot that contains all the ui content of the world.
_slideSwap SlideSwapRegion The swap region used to make the animation for going between session menu views.
_saveWorld Button The button to save world changes.
_saveWorldAs Button The button to save the world as a certain name.
_saveWorldCopy Button The button to save a copy of the world.
_tabButtons list of Button A list of the buttons used to change between session menu views.

Sync Delegates

Triggers
Method Name Method type and Arguments. Is the method hidden? Description
SwitchTab:ButtonEventHandler`1<SessionControlDialog.Tab> ButtonEventHandler`1<SessionControlDialog.Tab> ✓
GetSessionOrb:ButtonEventHandler ButtonEventHandler ✓
GetWorldOrb:ButtonEventHandler ButtonEventHandler ✓
CopySessionURL:ButtonEventHandler ButtonEventHandler ✓
CopyWorldURL:ButtonEventHandler ButtonEventHandler ✓
CopyRecordURL:ButtonEventHandler ButtonEventHandler ✓
CustomVerifierPressed:ButtonEventHandler ButtonEventHandler ✓
OnEnableCustomJoinVerifier:ButtonEventHandler ButtonEventHandler ✓
OnClearUserPermissionOverrides:ButtonEventHandler ButtonEventHandler ✓
OnSave:ButtonEventHandler ButtonEventHandler ✓
OnSaveAs:ButtonEventHandler ButtonEventHandler ✓
OnSaveCopy:ButtonEventHandler ButtonEventHandler ✓

Tab

Values
Name Value Description
Settings 0 The tab is currently on Session Settings.
Users 1 The tab is currently on Users.
Permissions 2 The tab is currently on Permissions.

Usage

See Session.

Examples

See Session.

See Also

Retrieved from "https://wiki.resonite.com/index.php?title=Component:SessionControlDialog&oldid=99167"