# Uses of Class com.threerings.whirled.spot.data.Portal (vilya 1.3 API)
Date: 2011-04-06

## Uses of Class
com.threerings.whirled.spot.data.Portal

Packages that use Portal
com.threerings.stage.client
com.threerings.stage.data
com.threerings.stage.tools.editor
com.threerings.whirled.spot.data
com.threerings.whirled.spot.server
com.threerings.whirled.spot.tools

Uses of Portal in com.threerings.stage.client

Methods in com.threerings.stage.client that return Portal
`Portal` `StageScenePanel.getPortal(int fullX, int fullY)` Returns the portal at the specified full coordinates or null if no portal exists at said coordinates.

Uses of Portal in com.threerings.stage.data

Methods in com.threerings.stage.data that return Portal
`Portal` `StageScene.getDefaultEntrance()`
`Portal` `StageScene.getPortal(int portalId)`

Methods in com.threerings.stage.data that return types with arguments of type Portal
`Iterator<Portal>` `StageScene.getPortals()`

Methods in com.threerings.stage.data with parameters of type Portal
`void` `StageScene.addPortal(Portal portal)`
`void` `StageScene.removePortal(Portal portal)`
`void` `StageScene.setDefaultEntrance(Portal portal)`

Uses of Portal in com.threerings.stage.tools.editor

Methods in com.threerings.stage.tools.editor that return Portal
`Portal` `EditorScenePanel.getEntrance()` Returns the portal that serves as the default entrance to this scene or null if no default is set.

Methods in com.threerings.stage.tools.editor with parameters of type Portal
`void` `EditorScenePanel.setEntrance(Portal port)` Makes the specified portal the default entrance to this scene.

Uses of Portal in com.threerings.whirled.spot.data

Fields in com.threerings.whirled.spot.data declared as Portal
`Portal[]` `SpotSceneModel.portals` An array containing all portals in this scene.
`Portal[]` `ModifyPortalsUpdate.portalsAdded` The portals to be added to the scene.
`Portal[]` `ModifyPortalsUpdate.portalsRemoved` The portals to be removed from the room.

Methods in com.threerings.whirled.spot.data that return Portal
`Portal` `Portal.clone()`
`Portal` `SpotSceneImpl.getDefaultEntrance()`
`Portal` `SpotScene.getDefaultEntrance()` Returns the portal that represents the default entrance to this scene.
`Portal` `SpotSceneImpl.getPortal(int portalId)`
`Portal` `SpotScene.getPortal(int portalId)` Returns a `Portal` object for the portal with the specified id or null if no portal exists with that id.

Methods in com.threerings.whirled.spot.data that return types with arguments of type Portal
`Iterator<Portal>` `SpotSceneImpl.getPortals()`
`Iterator<Portal>` `SpotScene.getPortals()` Returns an iterator over the portals in this scene.

Methods in com.threerings.whirled.spot.data with parameters of type Portal
`void` `SpotSceneModel.addPortal(Portal portal)` Adds a portal to this scene model.
`void` `SpotSceneImpl.addPortal(Portal portal)`
`void` `SpotScene.addPortal(Portal portal)` Adds a portal to this scene, immediately making the requisite modifications to the underlying scene model.
`void` `ModifyPortalsUpdate.initialize(int targetId, int targetVersion, Portal[] removed, Portal[] added)` Initialize the update with all necessary data.
`void` `ModifyPortalsUpdate.initialize(int targetId, int targetVersion, Portal[] removed, Portal[] added)` Initialize the update with all necessary data.
`void` `SpotSceneModel.removePortal(Portal portal)` Removes a portal from this model.
`void` `SpotSceneImpl.removePortal(Portal portal)`
`void` `SpotScene.removePortal(Portal portal)` Removes the specified portal from the scene.
`void` `SpotSceneImpl.setDefaultEntrance(Portal portal)`
`void` `SpotScene.setDefaultEntrance(Portal portal)` Sets the default entrance in this scene, immediately making the requisite modifications to the underlying scene model.

Uses of Portal in com.threerings.whirled.spot.server

Methods in com.threerings.whirled.spot.server with parameters of type Portal
`void` `SpotSceneManager.mapEnteringBody(com.threerings.crowd.data.BodyObject body, Portal from)` Assigns a starting location for an entering body.
`String` `SpotSceneManager.mayTraversePortal(com.threerings.crowd.data.BodyObject body, Portal portal)` This is called when a user requests to traverse a portal from this scene to another scene.
`void` `SpotSceneManager.willTraversePortal(com.threerings.crowd.data.BodyObject body, Portal portal)` This is called to let this scene manager know that the user is about to traverse the specified portal.

Constructors in com.threerings.whirled.spot.server with parameters of type Portal
`SpotSceneMoveHandler(com.threerings.crowd.server.LocationManager locman, SpotSceneManager srcmgr, com.threerings.crowd.data.BodyObject body, int sceneVer, Portal dest, SceneService.SceneMoveListener listener)`

Uses of Portal in com.threerings.whirled.spot.tools

Subclasses of Portal in com.threerings.whirled.spot.tools
`class` `EditablePortal` An editable portal extends the standard portal with information needed by the loader and editor.

Copyright © 2011. All Rights Reserved.