com.threerings.crowd.util
Interface CrowdContext

All Superinterfaces:
PresentsContext
All Known Implementing Classes:
TestClient.CrowdContextImpl

public interface CrowdContext
extends PresentsContext

The crowd context provides access to the various managers, etc. that are needed by the crowd client code.


Method Summary
 void clearPlaceView(PlaceView view)
          When the client leaves a place, the place controller will remove any place view it set previously via setPlaceView(com.threerings.crowd.client.PlaceView) with a call to this method.
 ChatDirector getChatDirector()
          Provides access to the chat director.
 LocationDirector getLocationDirector()
          Returns a reference to the location director.
 MessageManager getMessageManager()
          Returns a reference to the message manager used by the client to generate localized messages.
 OccupantDirector getOccupantDirector()
          Returns a reference to the occupant director.
 void setPlaceView(PlaceView view)
          When the client enters a new place, the location director creates a place controller which then creates a place view to visualize the place for the user.
 
Methods inherited from interface com.threerings.presents.util.PresentsContext
getClient, getConfig, getDObjectManager
 

Method Detail

getLocationDirector

LocationDirector getLocationDirector()
Returns a reference to the location director.


getOccupantDirector

OccupantDirector getOccupantDirector()
Returns a reference to the occupant director.


getChatDirector

ChatDirector getChatDirector()
Provides access to the chat director.


getMessageManager

MessageManager getMessageManager()
Returns a reference to the message manager used by the client to generate localized messages.


setPlaceView

void setPlaceView(PlaceView view)
When the client enters a new place, the location director creates a place controller which then creates a place view to visualize the place for the user. The place view created by the place controller will be passed to this function to actually display it in whatever user interface is provided for the user. We don't require any particular user interface toolkit, so it is expected that the place view implementation will coordinate with the client implementation so that the client can display the view provided by the place controller.

Though the place view is created before we enter the place, it won't be displayed (via a call to this function) until we have fully entered the place and are ready for user interaction.


clearPlaceView

void clearPlaceView(PlaceView view)
When the client leaves a place, the place controller will remove any place view it set previously via setPlaceView(com.threerings.crowd.client.PlaceView) with a call to this method.