com.electrotank.electroserver4.extensions
Class BaseLoginEventHandler

java.lang.Object
  com.electrotank.electroserver4.extensions.BaseEvent
      com.electrotank.electroserver4.extensions.BaseLoginEventHandler

All Implemented Interfaces:

EventHandler, EventHandlerLifeCycle, ExtensionLifeCycle, LoginEventHandler

public abstract class BaseLoginEventHandler
extends BaseEvent
implements LoginEventHandler

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

See Also:

Login Event Handler

Constructor Summary

BaseLoginEventHandler()

Method Summary

ChainAction

executeLogin(LoginContext context) Custom login event handler.

Methods inherited from class com.electrotank.electroserver4.extensions.BaseEvent

destroy, getApi, init, setApi

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getApi, setApi

Constructor Detail

BaseLoginEventHandler

public BaseLoginEventHandler()

Method Detail

executeLogin

public 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.

Specified by:

executeLogin in interface LoginEventHandler

Parameters:

context - LoginContext from user attempting to login

Returns:

ChainAction indicating successful login (OkAndContinue) or not

See Also:

Login Event Handler, LoginContext