KS.Unity.Editor.ksBaseLoginMenu< T > Class Template Reference

Kinematicsoup Service Login GUI More...

Inheritance diagram for KS.Unity.Editor.ksBaseLoginMenu< T >:

Public Member Functions
void	OnOpen (ksWindow window)
	Called when the menu is opened. More...
void	OnClose (ksWindow window)
	Clear the password when the menu is closed if the password is not saved. More...
void	Draw (ksWindow window)
	Creates the GUI. More...

Protected Member Functions
virtual void	DrawPasswordField (Rect rect)
	Draw the password field. More...
void	OnLogin (ksJSON response, string error)
	Handle a login response More...
abstract void	Login ()
	Send a login request More...
abstract ksAuthenticatedMenu	GetNextMenu (ksWindow window)
	Get the menu to show when the user is logged in. More...

Protected Attributes
ksWindow	m_window = null
string	m_consoleUrl = null
string	m_email = ""
string	m_password = ""

Properties
static T	Instance [get]
	Singleton Instance More...
bool	DestroyOnClose [get]
	Destroy this menu on close. More...
abstract string	ConsoleURL [get]
	Get the console url More...

Detailed Description

Kinematicsoup Service Login GUI

Type Constraints

T	:	ScriptableObject
T	:	ksIMenu

Member Function Documentation

Draw()

void KS.Unity.Editor.ksBaseLoginMenu< T >.Draw

(

ksWindow

window

)

Creates the GUI.

Parameters

window

window the GUI is for.

DrawPasswordField()

virtual void KS.Unity.Editor.ksBaseLoginMenu< T >.DrawPasswordField ( Rect  rect )

protectedvirtual

Draw the password field.

Parameters

rect	password field bounds

GetNextMenu()

abstract ksAuthenticatedMenu KS.Unity.Editor.ksBaseLoginMenu< T >.GetNextMenu ( ksWindow  window )

protectedpure virtual

Get the menu to show when the user is logged in.

Parameters

window

Returns

Menu to show when the user is logged in.

Implemented in KS.Reactor.Client.Unity.Editor.ksLoginMenu.

Login()

abstract void KS.Unity.Editor.ksBaseLoginMenu< T >.Login ( )

protectedpure virtual

Send a login request

Implemented in KS.Reactor.Client.Unity.Editor.ksLoginMenu.

OnClose()

void KS.Unity.Editor.ksBaseLoginMenu< T >.OnClose

(

ksWindow

window

)

Clear the password when the menu is closed if the password is not saved.

Parameters

window

window that closed the menu.

OnLogin()

void KS.Unity.Editor.ksBaseLoginMenu< T >.OnLogin ( ksJSON  response, string  error  )

protected

Handle a login response

Parameters

response	response data
error	error message

OnOpen()

void KS.Unity.Editor.ksBaseLoginMenu< T >.OnOpen

(

ksWindow

window

)

Called when the menu is opened.

Parameters

window

window that opened the menu.

Property Documentation

ConsoleURL

abstract string KS.Unity.Editor.ksBaseLoginMenu< T >.ConsoleURL

getprotected

Get the console url

DestroyOnClose

bool KS.Unity.Editor.ksBaseLoginMenu< T >.DestroyOnClose

get

Destroy this menu on close.

Instance

T KS.Unity.Editor.ksBaseLoginMenu< T >.Instance

staticget

Singleton Instance