Component:LoginDialog

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:LoginDialogComponent.png

Login Dialog component as seen in the Scene Inspector

The LoginDialog component is used in internal systems and may be replaced at any time. It is used to handle the logging in for users and the UI for such interactions.

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.
RegisterOnly	Bool	Whether user should just be registered and not log in afterwards.
_interactionEnabled	Bool	Whether interacting with this component is enabled.
_swapRegion	SlideSwapRegion	Handles the slide animation as this dialogue changes pages.
_username	TextField	The field for entering the user's username.
_email	TextField	The field for entering the user's email address.
_emailRepeat	TextField	The field to confirm the user's email address.
_password	TextField	The field for entering the user's password.
_passwordRepeat	TextField	The field for entering the user's password again for confirmation.
_recoveryCode	TextField	The field to get a recovery code from in case of account loss.
_birthMonth	IntTextEditorParser	The field to enter the user's legal birth month MM.
_birthDay	IntTextEditorParser	The field to enter the user's legal birth day DD.
_birthYear	IntTextEditorParser	The field to enter the user's legal birth year YYYY.
_rememberLogin	Checkbox	Whether to keep an encrypted token on disk using modern security protocols so the user can stay remembered for 30 days since last login, token refreshing every login.
_resetUserId	Checkbox	Whether to reset the user ID if they are migrating an account from older platforms.
_policies	Checkbox	Whether the player accepts the EULA.
_registerButton	Button	The button for registering.
_loginEmail	String	The email used to log in.

Sync Delegates

Triggers

Method Name	Method type and Arguments.	Is the method hidden?	Description
OnPolicesClick:ButtonEventHandler	ButtonEventHandler	✓	Called when the polices button is touched.
DoLogin:ButtonEventHandler	ButtonEventHandler	✓	Called when the login button is touched.
DoLoginSaml2:ButtonEventHandler	ButtonEventHandler	✓	Called when the login via saml2 button is touched.
DoLoginSaml2:ButtonEventHandler`1<String>	ButtonEventHandler`1<String>	✓	Called when the login via saml2 button is touched.
DoRegister:ButtonEventHandler	ButtonEventHandler	✓	Called when the register button is touched.
DoRegisterReserved:ButtonEventHandler	ButtonEventHandler	✓	Called when the register reserve claim button is touched.
RequestRecoveryCode:ButtonEventHandler	ButtonEventHandler	✓	Called when the request recovery code button is touched.
DoResetPassword:ButtonEventHandler	ButtonEventHandler	✓	Called when the reset password button is touched.
OnCancelRegister:ButtonEventHandler	ButtonEventHandler	✓	Called when the cancel register button is touched.
OpenLogin:ButtonEventHandler	ButtonEventHandler	✓	Called when the open login button is touched.
OpenRegister:ButtonEventHandler	ButtonEventHandler	✓	Called when the open register button is touched.
OpenLostPassword:ButtonEventHandler	ButtonEventHandler	✓	Called when the open lost password button is touched.
OnOpenMigration:ButtonEventHandler	ButtonEventHandler	✓	Called when the open migration button is touched.
OnDeclineMigration:ButtonEventHandler	ButtonEventHandler	✓	Called when the decline migration button is touched.

Usage

Not used directly by the user. Used in the dash.

Examples

used in dash login.