com.threerings.presents.client

Class BasicDirector

java.lang.Object

com.threerings.presents.client.BasicDirector

All Implemented Interfaces:

SessionObserver

Direct Known Subclasses:

BureauDirector, ChatDirector, LocationDirector, MuteDirector, OccupantDirector

public class BasicDirector
extends Object
implements SessionObserver

Handles functionality common to nearly all client directors. They generally need to be session observers so that they can set themselves up when the client logs on (by overriding clientDidLogon(com.threerings.presents.client.Client)) and clean up after themselves when the client logs off (by overriding clientDidLogoff(com.threerings.presents.client.Client)).

Method Summary

Modifier and Type	Method and Description
void	clientDidLogoff(Client client) Called after the client has been logged off of the server and has disconnected.
void	clientDidLogon(Client client) Called after the client successfully connected to and authenticated with the server.
void	clientObjectDidChange(Client client) For systems that allow switching screen names after logon, this method is called whenever a screen name change takes place to report that the client object has been replaced to potential client-side subscribers.
void	clientWillLogon(Client client) Called immediately before a logon is attempted.
boolean	isAvailableInStandalone() Checks whether or not this director is available in standalone mode (defaults to false).
void	setAvailableInStandalone(boolean available) Sets whether or not this director is available in standalone mode.

Methods inherited from class java.lang.Object

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

Method Detail

clientWillLogon

public void clientWillLogon(Client client)

Description copied from interface: SessionObserver

Called immediately before a logon is attempted.

Specified by:

clientWillLogon in interface SessionObserver

clientDidLogon

public void clientDidLogon(Client client)

Description copied from interface: SessionObserver

Called after the client successfully connected to and authenticated with the server. The entire object system is up and running by the time this method is called.

Specified by:

clientDidLogon in interface SessionObserver

clientObjectDidChange

public void clientObjectDidChange(Client client)

Description copied from interface: SessionObserver

For systems that allow switching screen names after logon, this method is called whenever a screen name change takes place to report that the client object has been replaced to potential client-side subscribers.

Specified by:

clientObjectDidChange in interface SessionObserver

clientDidLogoff

public void clientDidLogoff(Client client)

Description copied from interface: SessionObserver

Called after the client has been logged off of the server and has disconnected.

Specified by:

clientDidLogoff in interface SessionObserver

setAvailableInStandalone

public void setAvailableInStandalone(boolean available)

Sets whether or not this director is available in standalone mode.

isAvailableInStandalone

public boolean isAvailableInStandalone()

Checks whether or not this director is available in standalone mode (defaults to false).