Component image File:SessionControlDialogComponent.pngSession 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
| 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
| Method Name | Method type and Arguments. | Is the method hidden? | Description |
|---|---|---|---|
SwitchTab:ButtonEventHandler`1<SessionControlDialog.Tab>
|
ButtonEventHandler`1<SessionControlDialog.Tab> | ✓ | Called when a session menu tab button is touched. |
GetSessionOrb:ButtonEventHandler
|
ButtonEventHandler | ✓ | Called when the get session orb button is touched. |
GetWorldOrb:ButtonEventHandler
|
ButtonEventHandler | ✓ | Called when the get world orb button is touched. |
CopySessionURL:ButtonEventHandler
|
ButtonEventHandler | ✓ | Called when the copy session url button is touched. |
CopyWorldURL:ButtonEventHandler
|
ButtonEventHandler | ✓ | Called when the copy world url button is touched. |
CopyRecordURL:ButtonEventHandler
|
ButtonEventHandler | ✓ | Called when the copy record url button is touched. |
CustomVerifierPressed:ButtonEventHandler
|
ButtonEventHandler | ✓ | Called when the custom verifier button is touched. |
OnEnableCustomJoinVerifier:ButtonEventHandler
|
ButtonEventHandler | ✓ | Called when the enable custom verifier button is touched. |
OnClearUserPermissionOverrides:ButtonEventHandler
|
ButtonEventHandler | ✓ | Called when the clear custom permission overrides button is touched. |
OnSave:ButtonEventHandler
|
ButtonEventHandler | ✓ | Called when the save world button is touched. |
OnSaveAs:ButtonEventHandler
|
ButtonEventHandler | ✓ | Called when the save world as button is touched. |
OnSaveCopy:ButtonEventHandler
|
ButtonEventHandler | ✓ | Called when the save world copy button is touched. |
Tab
| 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.