com.electrotank.electroserver5.extensions
Interface LoginEventHandler

All Superinterfaces:

EventHandler

All Known Implementing Classes:

BaseLoginEventHandler

public interface LoginEventHandler
extends EventHandler

Custom login event handler. Implement this class, implementing the executeLogin method, and use as a server extension to customize logins. See the LoginEventHandler example plug-in.

See Also:

Login Event Handler

Method Summary

ChainAction	executeLogin(LoginContext context) Custom login event handler.
void	userDidLogin(String userName) Custom event handler that is triggered after a user logs in successfully.

Methods inherited from interface com.electrotank.electroserver5.extensions.EventHandler

getApi, setApi

Method Detail

executeLogin

ChainAction executeLogin(LoginContext context)

Custom login event handler. See the LoginEventHandler example plug-in.

Note: UserVariables, ExtensionBoundUserServerVariables and UserServerVariables cannot be set using getApi() during executeLogin, because the user has not finished logging in. If you need to set one or more of these, use the LoginContext instead, or set them in the userDidLogin method.

Parameters:

context - LoginContext from user attempting to login

Returns:

ChainAction indicating successful login (OkAndContinue) or not

See Also:

Login Event Handler

userDidLogin

void userDidLogin(String userName)

Custom event handler that is triggered after a user logs in successfully.