From ccf127a3bbec367664de38da118dbb6f2fd1d465 Mon Sep 17 00:00:00 2001 From: Michael Bayne Date: Wed, 6 Apr 2011 17:01:15 -0700 Subject: [PATCH] API docs for 1.3 release. --- apidocs/allclasses-frame.html | 790 ++ apidocs/allclasses-noframe.html | 790 ++ apidocs/com/threerings/micasa/Log.html | 267 + .../com/threerings/micasa/class-use/Log.html | 145 + .../threerings/micasa/client/ChatPanel.html | 618 ++ .../micasa/client/ClientController.html | 384 + .../threerings/micasa/client/LogonPanel.html | 546 ++ .../threerings/micasa/client/MiCasaApp.html | 303 + .../micasa/client/MiCasaApplet.html | 402 + .../micasa/client/MiCasaClient.html | 289 + .../threerings/micasa/client/MiCasaFrame.html | 470 + .../micasa/client/OccupantList.html | 484 + .../micasa/client/class-use/ChatPanel.html | 145 + .../client/class-use/ClientController.html | 145 + .../micasa/client/class-use/LogonPanel.html | 145 + .../micasa/client/class-use/MiCasaApp.html | 145 + .../micasa/client/class-use/MiCasaApplet.html | 145 + .../micasa/client/class-use/MiCasaClient.html | 145 + .../micasa/client/class-use/MiCasaFrame.html | 255 + .../micasa/client/class-use/OccupantList.html | 145 + .../micasa/client/package-frame.html | 47 + .../micasa/client/package-summary.html | 190 + .../micasa/client/package-tree.html | 190 + .../threerings/micasa/client/package-use.html | 209 + .../micasa/data/MiCasaBootstrapData.html | 310 + .../data/class-use/MiCasaBootstrapData.html | 145 + .../threerings/micasa/data/package-frame.html | 33 + .../micasa/data/package-summary.html | 159 + .../threerings/micasa/data/package-tree.html | 159 + .../threerings/micasa/data/package-use.html | 145 + .../com/threerings/micasa/lobby/Lobby.html | 366 + .../threerings/micasa/lobby/LobbyConfig.html | 400 + .../micasa/lobby/LobbyController.html | 474 + .../threerings/micasa/lobby/LobbyManager.html | 299 + .../LobbyMarshaller.CategoriesMarshaller.html | 380 + .../LobbyMarshaller.LobbiesMarshaller.html | 380 + .../micasa/lobby/LobbyMarshaller.html | 434 + .../threerings/micasa/lobby/LobbyObject.html | 314 + .../threerings/micasa/lobby/LobbyPanel.html | 400 + .../micasa/lobby/LobbyProvider.html | 260 + .../micasa/lobby/LobbyRegistry.html | 447 + .../micasa/lobby/LobbySelector.html | 475 + .../LobbyService.CategoriesListener.html | 234 + .../lobby/LobbyService.LobbiesListener.html | 234 + .../threerings/micasa/lobby/LobbyService.html | 286 + .../micasa/lobby/class-use/Lobby.html | 207 + .../micasa/lobby/class-use/LobbyConfig.html | 227 + .../lobby/class-use/LobbyController.html | 145 + .../micasa/lobby/class-use/LobbyManager.html | 181 + .../LobbyMarshaller.CategoriesMarshaller.html | 145 + .../LobbyMarshaller.LobbiesMarshaller.html | 145 + .../lobby/class-use/LobbyMarshaller.html | 145 + .../micasa/lobby/class-use/LobbyObject.html | 181 + .../micasa/lobby/class-use/LobbyPanel.html | 145 + .../micasa/lobby/class-use/LobbyProvider.html | 181 + .../micasa/lobby/class-use/LobbyRegistry.html | 182 + .../micasa/lobby/class-use/LobbySelector.html | 145 + .../LobbyService.CategoriesListener.html | 235 + .../LobbyService.LobbiesListener.html | 238 + .../micasa/lobby/class-use/LobbyService.html | 183 + .../micasa/lobby/package-frame.html | 70 + .../micasa/lobby/package-summary.html | 232 + .../threerings/micasa/lobby/package-tree.html | 208 + .../threerings/micasa/lobby/package-use.html | 242 + .../micasa/lobby/table/TableItem.html | 485 + .../micasa/lobby/table/TableListView.html | 527 ++ .../micasa/lobby/table/TableLobbyConfig.html | 340 + .../micasa/lobby/table/TableLobbyManager.html | 271 + .../micasa/lobby/table/TableLobbyObject.html | 689 ++ .../lobby/table/class-use/TableItem.html | 145 + .../lobby/table/class-use/TableListView.html | 145 + .../table/class-use/TableLobbyConfig.html | 145 + .../table/class-use/TableLobbyManager.html | 145 + .../table/class-use/TableLobbyObject.html | 145 + .../micasa/lobby/table/package-frame.html | 41 + .../micasa/lobby/table/package-summary.html | 176 + .../micasa/lobby/table/package-tree.html | 188 + .../micasa/lobby/table/package-use.html | 145 + .../com/threerings/micasa/package-frame.html | 33 + .../threerings/micasa/package-summary.html | 158 + .../com/threerings/micasa/package-tree.html | 154 + .../com/threerings/micasa/package-use.html | 145 + .../micasa/server/MiCasaConfig.html | 267 + .../micasa/server/MiCasaServer.html | 343 + .../micasa/server/MiCasaSession.html | 262 + .../micasa/server/class-use/MiCasaConfig.html | 145 + .../micasa/server/class-use/MiCasaServer.html | 181 + .../server/class-use/MiCasaSession.html | 145 + .../micasa/server/package-frame.html | 37 + .../micasa/server/package-summary.html | 166 + .../micasa/server/package-tree.html | 163 + .../threerings/micasa/server/package-use.html | 171 + .../micasa/simulator/client/SimpleClient.html | 267 + .../micasa/simulator/client/SimpleFrame.html | 432 + .../micasa/simulator/client/SimulatorApp.html | 298 + .../simulator/client/SimulatorClient.html | 210 + .../simulator/client/SimulatorController.html | 437 + .../simulator/client/SimulatorFrame.html | 283 + .../simulator/client/SimulatorService.html | 245 + .../client/class-use/SimpleClient.html | 145 + .../client/class-use/SimpleFrame.html | 145 + .../client/class-use/SimulatorApp.html | 145 + .../client/class-use/SimulatorClient.html | 181 + .../client/class-use/SimulatorController.html | 145 + .../client/class-use/SimulatorFrame.html | 232 + .../client/class-use/SimulatorService.html | 183 + .../simulator/client/package-frame.html | 54 + .../simulator/client/package-summary.html | 192 + .../micasa/simulator/client/package-tree.html | 186 + .../micasa/simulator/client/package-use.html | 215 + .../micasa/simulator/data/SimulatorInfo.html | 334 + .../simulator/data/SimulatorMarshaller.html | 363 + .../data/class-use/SimulatorInfo.html | 211 + .../data/class-use/SimulatorMarshaller.html | 145 + .../micasa/simulator/data/package-frame.html | 35 + .../simulator/data/package-summary.html | 164 + .../micasa/simulator/data/package-tree.html | 158 + .../micasa/simulator/data/package-use.html | 190 + .../micasa/simulator/server/SimpleServer.html | 349 + .../micasa/simulator/server/Simulant.html | 291 + .../SimulatorManager.CreateGameTask.html | 234 + .../simulator/server/SimulatorManager.html | 285 + .../simulator/server/SimulatorProvider.html | 274 + .../simulator/server/SimulatorServer.html | 245 + .../server/class-use/SimpleServer.html | 145 + .../simulator/server/class-use/Simulant.html | 145 + .../SimulatorManager.CreateGameTask.html | 145 + .../server/class-use/SimulatorManager.html | 179 + .../server/class-use/SimulatorProvider.html | 145 + .../server/class-use/SimulatorServer.html | 207 + .../simulator/server/package-frame.html | 50 + .../simulator/server/package-summary.html | 186 + .../micasa/simulator/server/package-tree.html | 167 + .../micasa/simulator/server/package-use.html | 178 + .../simulator/util/SimulatorContext.html | 275 + .../util/class-use/SimulatorContext.html | 145 + .../micasa/simulator/util/package-frame.html | 33 + .../simulator/util/package-summary.html | 161 + .../micasa/simulator/util/package-tree.html | 158 + .../micasa/simulator/util/package-use.html | 145 + .../threerings/micasa/util/MiCasaContext.html | 276 + .../micasa/util/class-use/MiCasaContext.html | 308 + .../threerings/micasa/util/package-frame.html | 33 + .../micasa/util/package-summary.html | 161 + .../threerings/micasa/util/package-tree.html | 158 + .../threerings/micasa/util/package-use.html | 218 + apidocs/com/threerings/parlor/Log.html | 267 + apidocs/com/threerings/parlor/card/Log.html | 265 + .../threerings/parlor/card/class-use/Log.html | 145 + .../card/client/CardGameController.html | 551 ++ .../parlor/card/client/CardGameDecoder.html | 424 + .../parlor/card/client/CardGameReceiver.html | 330 + .../CardPanel.CardSelectionObserver.html | 237 + .../parlor/card/client/CardPanel.html | 1345 +++ .../parlor/card/client/CardSprite.html | 564 ++ .../card/client/CardSpriteObserver.html | 290 + .../parlor/card/client/MicroCardSprite.html | 362 + .../client/class-use/CardGameController.html | 179 + .../client/class-use/CardGameDecoder.html | 145 + .../client/class-use/CardGameReceiver.html | 196 + .../CardPanel.CardSelectionObserver.html | 190 + .../card/client/class-use/CardPanel.html | 203 + .../card/client/class-use/CardSprite.html | 356 + .../client/class-use/CardSpriteObserver.html | 145 + .../client/class-use/MicroCardSprite.html | 145 + .../parlor/card/client/package-frame.html | 56 + .../parlor/card/client/package-summary.html | 198 + .../parlor/card/client/package-tree.html | 200 + .../parlor/card/client/package-use.html | 210 + .../com/threerings/parlor/card/data/Card.html | 604 ++ .../parlor/card/data/CardCodes.html | 409 + .../parlor/card/data/CardGameObject.html | 328 + .../com/threerings/parlor/card/data/Deck.html | 486 + .../com/threerings/parlor/card/data/Hand.html | 419 + .../parlor/card/data/PlayerCard.html | 331 + .../parlor/card/data/class-use/Card.html | 702 ++ .../parlor/card/data/class-use/CardCodes.html | 314 + .../card/data/class-use/CardGameObject.html | 145 + .../parlor/card/data/class-use/Deck.html | 192 + .../parlor/card/data/class-use/Hand.html | 379 + .../card/data/class-use/PlayerCard.html | 308 + .../parlor/card/data/package-frame.html | 52 + .../parlor/card/data/package-summary.html | 188 + .../parlor/card/data/package-tree.html | 184 + .../parlor/card/data/package-use.html | 363 + .../threerings/parlor/card/package-frame.html | 33 + .../parlor/card/package-summary.html | 158 + .../threerings/parlor/card/package-tree.html | 154 + .../threerings/parlor/card/package-use.html | 145 + .../parlor/card/server/CardGameManager.html | 604 ++ .../parlor/card/server/CardGameSender.html | 351 + .../server/class-use/CardGameManager.html | 179 + .../card/server/class-use/CardGameSender.html | 145 + .../parlor/card/server/package-frame.html | 35 + .../parlor/card/server/package-summary.html | 163 + .../parlor/card/server/package-tree.html | 163 + .../parlor/card/server/package-use.html | 171 + .../TrickCardGameControllerDelegate.html | 266 + .../trick/client/TrickCardGameService.html | 294 + .../TrickCardGameControllerDelegate.html | 145 + .../class-use/TrickCardGameService.html | 183 + .../card/trick/client/package-frame.html | 44 + .../card/trick/client/package-summary.html | 172 + .../card/trick/client/package-tree.html | 168 + .../parlor/card/trick/client/package-use.html | 171 + .../card/trick/data/TrickCardCodes.html | 295 + .../trick/data/TrickCardGameMarshaller.html | 454 + .../card/trick/data/TrickCardGameObject.html | 908 ++ .../trick/data/class-use/TrickCardCodes.html | 181 + .../class-use/TrickCardGameMarshaller.html | 198 + .../data/class-use/TrickCardGameObject.html | 145 + .../parlor/card/trick/data/package-frame.html | 46 + .../card/trick/data/package-summary.html | 178 + .../parlor/card/trick/data/package-tree.html | 169 + .../parlor/card/trick/data/package-use.html | 192 + .../server/TrickCardGameManagerDelegate.html | 686 ++ .../trick/server/TrickCardGameProvider.html | 280 + .../TrickCardGameManagerDelegate.html | 145 + .../class-use/TrickCardGameProvider.html | 181 + .../card/trick/server/package-frame.html | 44 + .../card/trick/server/package-summary.html | 172 + .../card/trick/server/package-tree.html | 170 + .../parlor/card/trick/server/package-use.html | 171 + .../card/trick/util/TrickCardGameUtil.html | 640 ++ .../util/class-use/TrickCardGameUtil.html | 145 + .../parlor/card/trick/util/package-frame.html | 33 + .../card/trick/util/package-summary.html | 158 + .../parlor/card/trick/util/package-tree.html | 155 + .../parlor/card/trick/util/package-use.html | 145 + .../com/threerings/parlor/class-use/Log.html | 145 + .../client/DefaultSwingTableConfigurator.html | 330 + .../parlor/client/GameReadyObserver.html | 220 + .../threerings/parlor/client/Invitation.html | 523 ++ .../parlor/client/InvitationHandler.html | 240 + .../client/InvitationResponseObserver.html | 271 + .../parlor/client/ParlorDecoder.html | 424 + .../parlor/client/ParlorDirector.html | 588 ++ .../parlor/client/ParlorReceiver.html | 339 + .../client/ParlorService.InviteListener.html | 234 + .../parlor/client/ParlorService.html | 347 + .../parlor/client/SeatednessObserver.html | 219 + .../parlor/client/TableConfigurator.html | 344 + .../parlor/client/TableDirector.html | 689 ++ .../parlor/client/TableObserver.html | 262 + .../parlor/client/TableService.html | 355 + .../DefaultSwingTableConfigurator.html | 145 + .../client/class-use/GameReadyObserver.html | 191 + .../parlor/client/class-use/Invitation.html | 297 + .../client/class-use/InvitationHandler.html | 211 + .../class-use/InvitationResponseObserver.html | 240 + .../client/class-use/ParlorDecoder.html | 145 + .../client/class-use/ParlorDirector.html | 181 + .../client/class-use/ParlorReceiver.html | 197 + .../ParlorService.InviteListener.html | 291 + .../client/class-use/ParlorService.html | 214 + .../client/class-use/SeatednessObserver.html | 229 + .../client/class-use/TableConfigurator.html | 211 + .../client/class-use/TableDirector.html | 182 + .../client/class-use/TableObserver.html | 211 + .../parlor/client/class-use/TableService.html | 183 + .../parlor/client/package-frame.html | 70 + .../parlor/client/package-summary.html | 239 + .../parlor/client/package-tree.html | 175 + .../threerings/parlor/client/package-use.html | 398 + .../parlor/data/ChoiceParameter.html | 408 + .../com/threerings/parlor/data/Parameter.html | 414 + .../threerings/parlor/data/ParlorCodes.html | 496 ++ .../ParlorMarshaller.InviteMarshaller.html | 380 + .../parlor/data/ParlorMarshaller.html | 535 ++ .../parlor/data/RangeParameter.html | 407 + apidocs/com/threerings/parlor/data/Table.html | 986 +++ .../threerings/parlor/data/TableConfig.html | 365 + .../parlor/data/TableLobbyObject.html | 334 + .../parlor/data/TableMarshaller.html | 557 ++ .../parlor/data/ToggleParameter.html | 367 + .../data/class-use/ChoiceParameter.html | 145 + .../parlor/data/class-use/Parameter.html | 197 + .../parlor/data/class-use/ParlorCodes.html | 345 + .../ParlorMarshaller.InviteMarshaller.html | 145 + .../data/class-use/ParlorMarshaller.html | 145 + .../parlor/data/class-use/RangeParameter.html | 145 + .../parlor/data/class-use/Table.html | 504 ++ .../parlor/data/class-use/TableConfig.html | 328 + .../data/class-use/TableLobbyObject.html | 181 + .../data/class-use/TableMarshaller.html | 260 + .../data/class-use/ToggleParameter.html | 145 + .../threerings/parlor/data/package-frame.html | 62 + .../parlor/data/package-summary.html | 213 + .../threerings/parlor/data/package-tree.html | 177 + .../threerings/parlor/data/package-use.html | 336 + .../parlor/game/client/GameConfigurator.html | 312 + .../parlor/game/client/GameController.html | 587 ++ .../game/client/GameControllerDelegate.html | 350 + .../game/client/SwingGameConfigurator.html | 329 + .../client/class-use/GameConfigurator.html | 242 + .../game/client/class-use/GameController.html | 238 + .../class-use/GameControllerDelegate.html | 270 + .../class-use/SwingGameConfigurator.html | 145 + .../parlor/game/client/package-frame.html | 39 + .../parlor/game/client/package-summary.html | 173 + .../parlor/game/client/package-tree.html | 164 + .../parlor/game/client/package-use.html | 323 + .../threerings/parlor/game/data/GameAI.html | 343 + .../parlor/game/data/GameCodes.html | 290 + .../parlor/game/data/GameConfig.html | 685 ++ .../parlor/game/data/GameObject.html | 1263 +++ .../parlor/game/data/UserIdentifier.Ider.html | 214 + .../parlor/game/data/UserIdentifier.html | 293 + .../parlor/game/data/class-use/GameAI.html | 229 + .../parlor/game/data/class-use/GameCodes.html | 239 + .../game/data/class-use/GameConfig.html | 859 ++ .../game/data/class-use/GameObject.html | 297 + .../data/class-use/UserIdentifier.Ider.html | 181 + .../game/data/class-use/UserIdentifier.html | 145 + .../parlor/game/data/package-frame.html | 52 + .../parlor/game/data/package-summary.html | 188 + .../parlor/game/data/package-tree.html | 173 + .../parlor/game/data/package-use.html | 498 ++ .../parlor/game/server/GameManager.html | 1249 +++ .../game/server/GameManagerDelegate.html | 457 + .../parlor/game/server/GameWatcher.html | 310 + .../parlor/game/server/TeamGameManager.html | 216 + .../game/server/class-use/GameManager.html | 270 + .../server/class-use/GameManagerDelegate.html | 301 + .../game/server/class-use/GameWatcher.html | 145 + .../server/class-use/TeamGameManager.html | 145 + .../parlor/game/server/package-frame.html | 48 + .../parlor/game/server/package-summary.html | 182 + .../parlor/game/server/package-tree.html | 168 + .../parlor/game/server/package-use.html | 310 + .../parlor/media/ScoreAnimation.html | 399 + .../media/class-use/ScoreAnimation.html | 232 + .../parlor/media/package-frame.html | 33 + .../parlor/media/package-summary.html | 158 + .../threerings/parlor/media/package-tree.html | 161 + .../threerings/parlor/media/package-use.html | 190 + .../com/threerings/parlor/package-frame.html | 33 + .../threerings/parlor/package-summary.html | 158 + .../com/threerings/parlor/package-tree.html | 154 + .../com/threerings/parlor/package-use.html | 145 + .../parlor/rating/data/RatingCodes.html | 254 + .../rating/data/class-use/RatingCodes.html | 190 + .../parlor/rating/data/package-frame.html | 33 + .../parlor/rating/data/package-summary.html | 158 + .../parlor/rating/data/package-tree.html | 152 + .../parlor/rating/data/package-use.html | 171 + .../parlor/rating/server/Rating.html | 446 + .../parlor/rating/server/RatingDelegate.html | 418 + .../rating/server/class-use/Rating.html | 195 + .../server/class-use/RatingDelegate.html | 145 + .../parlor/rating/server/package-frame.html | 35 + .../parlor/rating/server/package-summary.html | 163 + .../parlor/rating/server/package-tree.html | 162 + .../parlor/rating/server/package-use.html | 172 + .../server/persist/PercentileRecord.html | 449 + .../rating/server/persist/RatingRecord.html | 565 ++ .../server/persist/RatingRepository.html | 617 ++ .../persist/class-use/PercentileRecord.html | 199 + .../persist/class-use/RatingRecord.html | 267 + .../persist/class-use/RatingRepository.html | 145 + .../rating/server/persist/package-frame.html | 37 + .../server/persist/package-summary.html | 166 + .../rating/server/persist/package-tree.html | 161 + .../rating/server/persist/package-use.html | 177 + .../parlor/rating/util/Percentiler.html | 623 ++ .../rating/util/class-use/Percentiler.html | 216 + .../parlor/rating/util/package-frame.html | 33 + .../parlor/rating/util/package-summary.html | 158 + .../parlor/rating/util/package-tree.html | 154 + .../parlor/rating/util/package-use.html | 171 + .../parlor/server/ParlorManager.html | 496 ++ .../parlor/server/ParlorProvider.html | 330 + .../parlor/server/ParlorSender.html | 349 + .../threerings/parlor/server/PlayManager.html | 265 + .../parlor/server/PlayManagerDelegate.html | 275 + .../parlor/server/TableManager.html | 596 ++ .../parlor/server/TableProvider.html | 361 + .../server/class-use/ParlorManager.html | 145 + .../server/class-use/ParlorProvider.html | 181 + .../parlor/server/class-use/ParlorSender.html | 145 + .../parlor/server/class-use/PlayManager.html | 239 + .../server/class-use/PlayManagerDelegate.html | 330 + .../parlor/server/class-use/TableManager.html | 145 + .../server/class-use/TableProvider.html | 182 + .../parlor/server/package-frame.html | 54 + .../parlor/server/package-summary.html | 197 + .../parlor/server/package-tree.html | 167 + .../threerings/parlor/server/package-use.html | 337 + .../parlor/tourney/client/TourneyService.html | 290 + .../tourney/client/TourniesService.html | 243 + .../client/class-use/TourneyService.html | 183 + .../client/class-use/TourniesService.html | 183 + .../parlor/tourney/client/package-frame.html | 35 + .../tourney/client/package-summary.html | 163 + .../parlor/tourney/client/package-tree.html | 154 + .../parlor/tourney/client/package-use.html | 178 + .../parlor/tourney/data/EntryFee.html | 356 + .../parlor/tourney/data/Participant.html | 409 + .../threerings/parlor/tourney/data/Prize.html | 291 + .../parlor/tourney/data/TourneyCodes.html | 366 + .../parlor/tourney/data/TourneyConfig.html | 419 + .../parlor/tourney/data/TourneyLogicData.html | 261 + .../tourney/data/TourneyMarshaller.html | 449 + .../parlor/tourney/data/TourneyObject.html | 810 ++ .../tourney/data/TourniesMarshaller.html | 361 + .../tourney/data/class-use/EntryFee.html | 181 + .../tourney/data/class-use/Participant.html | 232 + .../parlor/tourney/data/class-use/Prize.html | 181 + .../tourney/data/class-use/TourneyCodes.html | 181 + .../tourney/data/class-use/TourneyConfig.html | 370 + .../data/class-use/TourneyLogicData.html | 181 + .../data/class-use/TourneyMarshaller.html | 198 + .../tourney/data/class-use/TourneyObject.html | 145 + .../data/class-use/TourniesMarshaller.html | 145 + .../parlor/tourney/data/package-frame.html | 58 + .../parlor/tourney/data/package-summary.html | 204 + .../parlor/tourney/data/package-tree.html | 173 + .../parlor/tourney/data/package-use.html | 266 + .../parlor/tourney/server/TourneyManager.html | 551 ++ .../tourney/server/TourneyProvider.html | 287 + .../tourney/server/TourniesManager.html | 296 + .../tourney/server/TourniesProvider.html | 231 + .../server/class-use/TourneyManager.html | 145 + .../server/class-use/TourneyProvider.html | 181 + .../server/class-use/TourniesManager.html | 145 + .../server/class-use/TourniesProvider.html | 181 + .../parlor/tourney/server/package-frame.html | 48 + .../tourney/server/package-summary.html | 180 + .../parlor/tourney/server/package-tree.html | 163 + .../parlor/tourney/server/package-use.html | 177 + .../TourneyRepository.TourneyRecord.html | 346 + .../server/persist/TourneyRepository.html | 423 + .../TourneyRepository.TourneyRecord.html | 145 + .../persist/class-use/TourneyRepository.html | 145 + .../tourney/server/persist/package-frame.html | 35 + .../server/persist/package-summary.html | 162 + .../tourney/server/persist/package-tree.html | 160 + .../tourney/server/persist/package-use.html | 145 + .../parlor/turn/client/TurnDisplay.html | 555 ++ .../turn/client/TurnGameController.html | 219 + .../client/TurnGameControllerDelegate.html | 417 + .../turn/client/class-use/TurnDisplay.html | 145 + .../client/class-use/TurnGameController.html | 209 + .../class-use/TurnGameControllerDelegate.html | 181 + .../parlor/turn/client/package-frame.html | 46 + .../parlor/turn/client/package-summary.html | 178 + .../parlor/turn/client/package-tree.html | 176 + .../parlor/turn/client/package-use.html | 211 + .../parlor/turn/data/TurnGameObject.html | 354 + .../turn/data/class-use/TurnGameObject.html | 181 + .../parlor/turn/data/package-frame.html | 33 + .../parlor/turn/data/package-summary.html | 159 + .../parlor/turn/data/package-tree.html | 152 + .../parlor/turn/data/package-use.html | 172 + .../parlor/turn/server/TurnGameManager.html | 371 + .../turn/server/TurnGameManagerDelegate.html | 487 ++ .../server/class-use/TurnGameManager.html | 208 + .../class-use/TurnGameManagerDelegate.html | 181 + .../parlor/turn/server/package-frame.html | 44 + .../parlor/turn/server/package-summary.html | 175 + .../parlor/turn/server/package-tree.html | 165 + .../parlor/turn/server/package-use.html | 215 + .../threerings/parlor/util/ParlorContext.html | 241 + .../threerings/parlor/util/RobotPlayer.html | 365 + .../parlor/util/class-use/ParlorContext.html | 392 + .../parlor/util/class-use/RobotPlayer.html | 145 + .../threerings/parlor/util/package-frame.html | 44 + .../parlor/util/package-summary.html | 174 + .../threerings/parlor/util/package-tree.html | 165 + .../threerings/parlor/util/package-use.html | 266 + apidocs/com/threerings/puzzle/Log.html | 265 + .../com/threerings/puzzle/class-use/Log.html | 145 + .../puzzle/client/PlayerStatusView.html | 479 + .../puzzle/client/PuzzleAnimationWaiter.html | 276 + .../puzzle/client/PuzzleBoardView.html | 830 ++ .../client/PuzzleController.ClearPender.html | 296 + .../puzzle/client/PuzzleController.html | 759 ++ .../client/PuzzleControllerDelegate.html | 411 + .../puzzle/client/PuzzleGameService.html | 305 + .../threerings/puzzle/client/PuzzlePanel.html | 751 ++ .../threerings/puzzle/client/PuzzlePrefs.html | 269 + .../client/class-use/PlayerStatusView.html | 145 + .../class-use/PuzzleAnimationWaiter.html | 145 + .../client/class-use/PuzzleBoardView.html | 210 + .../PuzzleController.ClearPender.html | 145 + .../client/class-use/PuzzleController.html | 232 + .../class-use/PuzzleControllerDelegate.html | 183 + .../client/class-use/PuzzleGameService.html | 183 + .../puzzle/client/class-use/PuzzlePanel.html | 145 + .../puzzle/client/class-use/PuzzlePrefs.html | 145 + .../puzzle/client/package-frame.html | 58 + .../puzzle/client/package-summary.html | 203 + .../puzzle/client/package-tree.html | 201 + .../threerings/puzzle/client/package-use.html | 228 + apidocs/com/threerings/puzzle/data/Board.html | 439 + .../threerings/puzzle/data/BoardSummary.html | 346 + .../threerings/puzzle/data/PuzzleCodes.html | 272 + .../puzzle/data/PuzzleGameCodes.html | 181 + .../puzzle/data/PuzzleGameMarshaller.html | 434 + .../threerings/puzzle/data/PuzzleObject.html | 690 ++ .../puzzle/data/class-use/Board.html | 496 ++ .../puzzle/data/class-use/BoardSummary.html | 326 + .../puzzle/data/class-use/PuzzleCodes.html | 345 + .../data/class-use/PuzzleGameCodes.html | 281 + .../data/class-use/PuzzleGameMarshaller.html | 198 + .../puzzle/data/class-use/PuzzleObject.html | 179 + .../threerings/puzzle/data/package-frame.html | 52 + .../puzzle/data/package-summary.html | 190 + .../threerings/puzzle/data/package-tree.html | 178 + .../threerings/puzzle/data/package-use.html | 358 + .../puzzle/drop/client/DropBlockSprite.html | 628 ++ .../puzzle/drop/client/DropBoardView.html | 1165 +++ .../drop/client/DropControllerDelegate.html | 733 ++ .../puzzle/drop/client/DropPanel.html | 237 + .../puzzle/drop/client/DropSprite.html | 862 ++ .../drop/client/DropSpriteObserver.html | 219 + .../puzzle/drop/client/NextBlockView.html | 423 + .../drop/client/PieceGroupAnimation.html | 380 + .../client/class-use/DropBlockSprite.html | 183 + .../drop/client/class-use/DropBoardView.html | 232 + .../class-use/DropControllerDelegate.html | 145 + .../drop/client/class-use/DropPanel.html | 145 + .../drop/client/class-use/DropSprite.html | 220 + .../client/class-use/DropSpriteObserver.html | 145 + .../drop/client/class-use/NextBlockView.html | 145 + .../client/class-use/PieceGroupAnimation.html | 145 + .../puzzle/drop/client/package-frame.html | 56 + .../puzzle/drop/client/package-summary.html | 202 + .../puzzle/drop/client/package-tree.html | 195 + .../puzzle/drop/client/package-use.html | 185 + .../drop/data/DropBoard.PieceOperation.html | 223 + .../puzzle/drop/data/DropBoard.html | 1385 +++ .../puzzle/drop/data/DropBoardSummary.html | 408 + .../puzzle/drop/data/DropCodes.html | 257 + .../puzzle/drop/data/DropConfig.html | 234 + .../puzzle/drop/data/DropLogic.html | 236 + .../puzzle/drop/data/DropPieceCodes.html | 246 + .../puzzle/drop/data/SegmentInfo.html | 368 + .../class-use/DropBoard.PieceOperation.html | 256 + .../puzzle/drop/data/class-use/DropBoard.html | 298 + .../drop/data/class-use/DropBoardSummary.html | 145 + .../puzzle/drop/data/class-use/DropCodes.html | 215 + .../drop/data/class-use/DropConfig.html | 145 + .../puzzle/drop/data/class-use/DropLogic.html | 215 + .../drop/data/class-use/DropPieceCodes.html | 258 + .../drop/data/class-use/SegmentInfo.html | 183 + .../puzzle/drop/data/package-frame.html | 56 + .../puzzle/drop/data/package-summary.html | 198 + .../puzzle/drop/data/package-tree.html | 172 + .../puzzle/drop/data/package-use.html | 287 + .../drop/server/DropManagerDelegate.html | 407 + .../server/class-use/DropManagerDelegate.html | 145 + .../puzzle/drop/server/package-frame.html | 33 + .../puzzle/drop/server/package-summary.html | 161 + .../puzzle/drop/server/package-tree.html | 163 + .../puzzle/drop/server/package-use.html | 145 + .../puzzle/drop/util/DropBoardUtil.html | 313 + .../puzzle/drop/util/DropGameUtil.html | 259 + .../util/PieceDestroyer.DestroyLogic.html | 242 + .../puzzle/drop/util/PieceDestroyer.html | 321 + .../puzzle/drop/util/PieceDropLogic.html | 317 + .../drop/util/PieceDropper.DropObserver.html | 224 + .../drop/util/PieceDropper.PieceDropInfo.html | 367 + .../puzzle/drop/util/PieceDropper.html | 353 + .../drop/util/class-use/DropBoardUtil.html | 145 + .../drop/util/class-use/DropGameUtil.html | 145 + .../PieceDestroyer.DestroyLogic.html | 180 + .../drop/util/class-use/PieceDestroyer.html | 145 + .../drop/util/class-use/PieceDropLogic.html | 180 + .../class-use/PieceDropper.DropObserver.html | 192 + .../class-use/PieceDropper.PieceDropInfo.html | 145 + .../drop/util/class-use/PieceDropper.html | 145 + .../puzzle/drop/util/package-frame.html | 56 + .../puzzle/drop/util/package-summary.html | 198 + .../puzzle/drop/util/package-tree.html | 162 + .../puzzle/drop/util/package-use.html | 185 + .../com/threerings/puzzle/package-frame.html | 33 + .../threerings/puzzle/package-summary.html | 158 + .../com/threerings/puzzle/package-tree.html | 154 + .../com/threerings/puzzle/package-use.html | 145 + .../puzzle/server/PuzzleGameProvider.html | 258 + .../puzzle/server/PuzzleManager.html | 512 ++ .../puzzle/server/PuzzleManagerDelegate.html | 302 + .../server/class-use/PuzzleGameProvider.html | 181 + .../server/class-use/PuzzleManager.html | 207 + .../class-use/PuzzleManagerDelegate.html | 184 + .../puzzle/server/package-frame.html | 46 + .../puzzle/server/package-summary.html | 177 + .../puzzle/server/package-tree.html | 174 + .../threerings/puzzle/server/package-use.html | 203 + .../com/threerings/puzzle/util/PointSet.html | 451 + .../threerings/puzzle/util/PuzzleContext.html | 342 + .../puzzle/util/PuzzleGameUtil.html | 259 + .../puzzle/util/class-use/PointSet.html | 181 + .../puzzle/util/class-use/PuzzleContext.html | 215 + .../puzzle/util/class-use/PuzzleGameUtil.html | 145 + .../threerings/puzzle/util/package-frame.html | 46 + .../puzzle/util/package-summary.html | 177 + .../threerings/puzzle/util/package-tree.html | 165 + .../threerings/puzzle/util/package-use.html | 210 + apidocs/com/threerings/stage/Log.html | 265 + .../com/threerings/stage/class-use/Log.html | 145 + .../stage/client/SceneColorizer.html | 341 + .../stage/client/StageSceneController.html | 356 + .../stage/client/StageScenePanel.html | 811 ++ .../stage/client/StageSceneService.html | 269 + .../client/class-use/SceneColorizer.html | 181 + .../class-use/StageSceneController.html | 145 + .../client/class-use/StageScenePanel.html | 210 + .../client/class-use/StageSceneService.html | 183 + .../stage/client/package-frame.html | 48 + .../stage/client/package-summary.html | 181 + .../threerings/stage/client/package-tree.html | 188 + .../threerings/stage/client/package-use.html | 228 + .../stage/data/DefaultColorUpdate.html | 382 + .../stage/data/ModifyObjectsUpdate.html | 384 + .../com/threerings/stage/data/StageCodes.html | 326 + .../threerings/stage/data/StageLocation.html | 522 ++ .../stage/data/StageMisoSceneModel.html | 466 + .../stage/data/StageOccupantInfo.html | 350 + .../com/threerings/stage/data/StageScene.html | 717 ++ .../stage/data/StageSceneConfig.html | 324 + .../stage/data/StageSceneMarshaller.html | 408 + .../stage/data/StageSceneModel.html | 461 + .../stage/data/StageSceneObject.html | 555 ++ .../data/class-use/DefaultColorUpdate.html | 145 + .../data/class-use/ModifyObjectsUpdate.html | 145 + .../stage/data/class-use/StageCodes.html | 182 + .../stage/data/class-use/StageLocation.html | 322 + .../data/class-use/StageMisoSceneModel.html | 227 + .../data/class-use/StageOccupantInfo.html | 145 + .../stage/data/class-use/StageScene.html | 337 + .../data/class-use/StageSceneConfig.html | 145 + .../data/class-use/StageSceneMarshaller.html | 198 + .../stage/data/class-use/StageSceneModel.html | 229 + .../data/class-use/StageSceneObject.html | 145 + .../threerings/stage/data/package-frame.html | 62 + .../stage/data/package-summary.html | 215 + .../threerings/stage/data/package-tree.html | 200 + .../threerings/stage/data/package-use.html | 326 + .../com/threerings/stage/package-frame.html | 33 + .../com/threerings/stage/package-summary.html | 158 + .../com/threerings/stage/package-tree.html | 154 + apidocs/com/threerings/stage/package-use.html | 145 + .../stage/server/StageSceneManager.html | 558 ++ .../stage/server/StageSceneProvider.html | 262 + .../stage/server/StageServer.StageModule.html | 248 + .../threerings/stage/server/StageServer.html | 400 + .../server/class-use/StageSceneManager.html | 145 + .../server/class-use/StageSceneProvider.html | 182 + .../class-use/StageServer.StageModule.html | 145 + .../stage/server/class-use/StageServer.html | 145 + .../stage/server/package-frame.html | 48 + .../stage/server/package-summary.html | 181 + .../threerings/stage/server/package-tree.html | 185 + .../threerings/stage/server/package-use.html | 171 + .../stage/tools/editor/DirectionButton.html | 496 ++ .../stage/tools/editor/EditorApp.html | 345 + .../stage/tools/editor/EditorConfig.html | 318 + .../stage/tools/editor/EditorDialog.html | 475 + .../stage/tools/editor/EditorFrame.html | 779 ++ .../stage/tools/editor/EditorModel.html | 801 ++ .../tools/editor/EditorModelListener.html | 294 + .../EditorScenePanel.SceneModelListener.html | 213 + .../stage/tools/editor/EditorScenePanel.html | 1224 +++ .../stage/tools/editor/EditorScrollBox.html | 452 + .../stage/tools/editor/EditorTileManager.html | 330 + .../tools/editor/EditorToolBarPanel.html | 368 + .../tools/editor/ObjectEditorDialog.html | 482 + .../stage/tools/editor/PortalDialog.html | 487 ++ .../stage/tools/editor/PortalTool.html | 372 + .../stage/tools/editor/PreferencesDialog.html | 402 + .../stage/tools/editor/SceneInfoPanel.html | 401 + .../stage/tools/editor/TestTileLoader.html | 346 + .../stage/tools/editor/TileInfoPanel.html | 538 ++ .../editor/class-use/DirectionButton.html | 145 + .../tools/editor/class-use/EditorApp.html | 145 + .../tools/editor/class-use/EditorConfig.html | 145 + .../tools/editor/class-use/EditorDialog.html | 191 + .../tools/editor/class-use/EditorFrame.html | 145 + .../tools/editor/class-use/EditorModel.html | 204 + .../editor/class-use/EditorModelListener.html | 206 + .../EditorScenePanel.SceneModelListener.html | 198 + .../editor/class-use/EditorScenePanel.html | 227 + .../editor/class-use/EditorScrollBox.html | 181 + .../editor/class-use/EditorTileManager.html | 145 + .../editor/class-use/EditorToolBarPanel.html | 145 + .../editor/class-use/ObjectEditorDialog.html | 145 + .../tools/editor/class-use/PortalDialog.html | 145 + .../tools/editor/class-use/PortalTool.html | 145 + .../editor/class-use/PreferencesDialog.html | 145 + .../editor/class-use/SceneInfoPanel.html | 145 + .../editor/class-use/TestTileLoader.html | 145 + .../tools/editor/class-use/TileInfoPanel.html | 145 + .../stage/tools/editor/package-frame.html | 78 + .../stage/tools/editor/package-summary.html | 250 + .../stage/tools/editor/package-tree.html | 226 + .../stage/tools/editor/package-use.html | 205 + .../tools/editor/util/EditorContext.html | 284 + .../tools/editor/util/EditorDialogUtil.html | 377 + .../tools/editor/util/ExtrasPainter.html | 214 + .../stage/tools/editor/util/TileSetUtil.html | 262 + .../editor/util/class-use/EditorContext.html | 236 + .../util/class-use/EditorDialogUtil.html | 145 + .../editor/util/class-use/ExtrasPainter.html | 181 + .../editor/util/class-use/TileSetUtil.html | 145 + .../tools/editor/util/package-frame.html | 48 + .../tools/editor/util/package-summary.html | 181 + .../stage/tools/editor/util/package-tree.html | 163 + .../stage/tools/editor/util/package-use.html | 177 + .../stage/tools/viewer/ViewerApp.html | 288 + .../stage/tools/viewer/ViewerFrame.html | 499 ++ .../stage/tools/viewer/ViewerScenePanel.html | 590 ++ .../tools/viewer/class-use/ViewerApp.html | 145 + .../tools/viewer/class-use/ViewerFrame.html | 145 + .../viewer/class-use/ViewerScenePanel.html | 145 + .../stage/tools/viewer/package-frame.html | 37 + .../stage/tools/viewer/package-summary.html | 167 + .../stage/tools/viewer/package-tree.html | 186 + .../stage/tools/viewer/package-use.html | 145 + .../tools/xml/StageMisoSceneRuleSet.html | 242 + .../stage/tools/xml/StageSceneParser.html | 271 + .../stage/tools/xml/StageSceneRuleSet.html | 242 + .../stage/tools/xml/StageSceneWriter.html | 257 + .../xml/class-use/StageMisoSceneRuleSet.html | 145 + .../tools/xml/class-use/StageSceneParser.html | 145 + .../xml/class-use/StageSceneRuleSet.html | 145 + .../tools/xml/class-use/StageSceneWriter.html | 179 + .../stage/tools/xml/package-frame.html | 39 + .../stage/tools/xml/package-summary.html | 170 + .../stage/tools/xml/package-tree.html | 164 + .../stage/tools/xml/package-use.html | 171 + .../stage/util/PlacementConstraints.html | 422 + .../threerings/stage/util/StageContext.html | 425 + .../threerings/stage/util/StageSceneUtil.html | 645 ++ .../util/class-use/PlacementConstraints.html | 145 + .../stage/util/class-use/StageContext.html | 254 + .../stage/util/class-use/StageSceneUtil.html | 145 + .../threerings/stage/util/package-frame.html | 46 + .../stage/util/package-summary.html | 177 + .../threerings/stage/util/package-tree.html | 162 + .../threerings/stage/util/package-use.html | 209 + apidocs/com/threerings/stats/Log.html | 267 + .../com/threerings/stats/class-use/Log.html | 145 + .../stats/data/ByteByteStringMapStat.html | 354 + .../stats/data/ByteStringSetStat.html | 355 + .../threerings/stats/data/IntArrayStat.html | 434 + .../com/threerings/stats/data/IntSetStat.html | 465 + .../stats/data/IntSetStatAdder.html | 313 + .../com/threerings/stats/data/IntStat.html | 438 + .../stats/data/IntStatIncrementer.html | 313 + .../stats/data/IntStatMinimumer.html | 314 + .../stats/data/IntStringSetStat.html | 355 + .../com/threerings/stats/data/MaxIntStat.html | 429 + .../stats/data/MaxValueIntStat.html | 429 + .../com/threerings/stats/data/SetStat.html | 344 + .../stats/data/ShortStringSetStat.html | 355 + .../stats/data/Stat.AuxDataSource.html | 244 + .../com/threerings/stats/data/Stat.Type.html | 294 + apidocs/com/threerings/stats/data/Stat.html | 633 ++ .../threerings/stats/data/StatModifier.html | 371 + .../stats/data/StatSet.Container.html | 234 + .../com/threerings/stats/data/StatSet.html | 721 ++ .../threerings/stats/data/StringMapStat.html | 401 + .../threerings/stats/data/StringSetStat.html | 405 + .../data/class-use/ByteByteStringMapStat.html | 145 + .../data/class-use/ByteStringSetStat.html | 145 + .../stats/data/class-use/IntArrayStat.html | 145 + .../stats/data/class-use/IntSetStat.html | 181 + .../stats/data/class-use/IntSetStatAdder.html | 145 + .../stats/data/class-use/IntStat.html | 216 + .../data/class-use/IntStatIncrementer.html | 145 + .../data/class-use/IntStatMinimumer.html | 145 + .../data/class-use/IntStringSetStat.html | 145 + .../stats/data/class-use/MaxIntStat.html | 145 + .../stats/data/class-use/MaxValueIntStat.html | 145 + .../stats/data/class-use/SetStat.html | 213 + .../data/class-use/ShortStringSetStat.html | 145 + .../data/class-use/Stat.AuxDataSource.html | 382 + .../stats/data/class-use/Stat.Type.html | 437 + .../threerings/stats/data/class-use/Stat.html | 491 ++ .../stats/data/class-use/StatModifier.html | 261 + .../data/class-use/StatSet.Container.html | 181 + .../stats/data/class-use/StatSet.html | 145 + .../stats/data/class-use/StringMapStat.html | 181 + .../stats/data/class-use/StringSetStat.html | 197 + .../threerings/stats/data/package-frame.html | 82 + .../stats/data/package-summary.html | 254 + .../threerings/stats/data/package-tree.html | 178 + .../threerings/stats/data/package-use.html | 267 + .../com/threerings/stats/package-frame.html | 33 + .../com/threerings/stats/package-summary.html | 158 + .../com/threerings/stats/package-tree.html | 154 + apidocs/com/threerings/stats/package-use.html | 145 + .../server/persist/MaxStatCodeRecord.html | 313 + .../stats/server/persist/StatRecord.html | 548 ++ .../stats/server/persist/StatRepository.html | 519 ++ .../server/persist/StringCodeRecord.html | 503 ++ .../persist/class-use/MaxStatCodeRecord.html | 181 + .../server/persist/class-use/StatRecord.html | 199 + .../persist/class-use/StatRepository.html | 145 + .../persist/class-use/StringCodeRecord.html | 199 + .../stats/server/persist/package-frame.html | 39 + .../stats/server/persist/package-summary.html | 170 + .../stats/server/persist/package-tree.html | 162 + .../stats/server/persist/package-use.html | 183 + apidocs/com/threerings/whirled/Log.html | 265 + .../com/threerings/whirled/class-use/Log.html | 145 + .../whirled/client/SceneController.html | 371 + .../whirled/client/SceneDecoder.html | 358 + .../client/SceneDirector.MoveHandler.html | 221 + .../whirled/client/SceneDirector.html | 842 ++ .../whirled/client/SceneMoveAdapter.html | 382 + .../whirled/client/SceneReceiver.html | 244 + .../SceneService.SceneMoveListener.html | 328 + .../whirled/client/SceneService.html | 254 + .../client/class-use/SceneController.html | 211 + .../client/class-use/SceneDecoder.html | 145 + .../class-use/SceneDirector.MoveHandler.html | 210 + .../client/class-use/SceneDirector.html | 240 + .../client/class-use/SceneMoveAdapter.html | 145 + .../client/class-use/SceneReceiver.html | 196 + .../SceneService.SceneMoveListener.html | 404 + .../client/class-use/SceneService.html | 183 + .../whirled/client/package-frame.html | 56 + .../whirled/client/package-summary.html | 198 + .../whirled/client/package-tree.html | 177 + .../whirled/client/package-use.html | 361 + .../client/persist/SceneRepository.html | 273 + .../persist/class-use/SceneRepository.html | 198 + .../whirled/client/persist/package-frame.html | 33 + .../client/persist/package-summary.html | 159 + .../whirled/client/persist/package-tree.html | 152 + .../whirled/client/persist/package-use.html | 172 + .../com/threerings/whirled/data/AuxModel.html | 244 + .../whirled/data/DefaultSceneConfig.html | 309 + .../com/threerings/whirled/data/Scene.html | 395 + .../threerings/whirled/data/SceneCodes.html | 258 + .../threerings/whirled/data/SceneImpl.html | 522 ++ .../SceneMarshaller.SceneMoveMarshaller.html | 540 ++ .../whirled/data/SceneMarshaller.html | 381 + .../threerings/whirled/data/SceneModel.html | 453 + .../threerings/whirled/data/SceneObject.html | 308 + .../threerings/whirled/data/ScenePlace.html | 373 + .../threerings/whirled/data/SceneUpdate.html | 554 ++ .../whirled/data/class-use/AuxModel.html | 272 + .../data/class-use/DefaultSceneConfig.html | 145 + .../whirled/data/class-use/Scene.html | 301 + .../whirled/data/class-use/SceneCodes.html | 365 + .../whirled/data/class-use/SceneImpl.html | 181 + .../SceneMarshaller.SceneMoveMarshaller.html | 145 + .../data/class-use/SceneMarshaller.html | 145 + .../whirled/data/class-use/SceneModel.html | 762 ++ .../whirled/data/class-use/SceneObject.html | 211 + .../whirled/data/class-use/ScenePlace.html | 145 + .../whirled/data/class-use/SceneUpdate.html | 617 ++ .../whirled/data/package-frame.html | 62 + .../whirled/data/package-summary.html | 213 + .../threerings/whirled/data/package-tree.html | 193 + .../threerings/whirled/data/package-use.html | 602 ++ .../com/threerings/whirled/package-frame.html | 33 + .../threerings/whirled/package-summary.html | 158 + .../com/threerings/whirled/package-tree.html | 154 + .../com/threerings/whirled/package-use.html | 145 + .../server/AbstractSceneMoveHandler.html | 304 + .../whirled/server/SceneManager.html | 386 + .../whirled/server/SceneMoveHandler.html | 251 + .../whirled/server/SceneProvider.html | 233 + .../server/SceneRegistry.ConfigFactory.html | 216 + .../SceneRegistry.ResolutionListener.html | 247 + .../whirled/server/SceneRegistry.html | 511 ++ .../whirled/server/SceneSender.html | 272 + .../server/WhirledServer.WhirledModule.html | 250 + .../whirled/server/WhirledServer.html | 342 + .../whirled/server/WhirledSession.html | 265 + .../class-use/AbstractSceneMoveHandler.html | 268 + .../server/class-use/SceneManager.html | 265 + .../server/class-use/SceneMoveHandler.html | 181 + .../server/class-use/SceneProvider.html | 210 + .../SceneRegistry.ConfigFactory.html | 145 + .../SceneRegistry.ResolutionListener.html | 294 + .../server/class-use/SceneRegistry.html | 247 + .../whirled/server/class-use/SceneSender.html | 145 + .../WhirledServer.WhirledModule.html | 181 + .../server/class-use/WhirledServer.html | 181 + .../server/class-use/WhirledSession.html | 183 + .../whirled/server/package-frame.html | 62 + .../whirled/server/package-summary.html | 213 + .../whirled/server/package-tree.html | 186 + .../whirled/server/package-use.html | 350 + .../server/persist/DummySceneRepository.html | 367 + .../server/persist/SceneRepository.html | 306 + .../server/persist/SceneUpdateMarshaller.html | 361 + .../class-use/DummySceneRepository.html | 145 + .../persist/class-use/SceneRepository.html | 212 + .../class-use/SceneUpdateMarshaller.html | 145 + .../whirled/server/persist/package-frame.html | 46 + .../server/persist/package-summary.html | 178 + .../whirled/server/persist/package-tree.html | 160 + .../whirled/server/persist/package-use.html | 190 + apidocs/com/threerings/whirled/spot/Log.html | 265 + .../whirled/spot/class-use/Log.html | 145 + .../spot/client/SpotSceneController.html | 307 + .../spot/client/SpotSceneDirector.html | 674 ++ .../SpotService.SpotSceneMoveListener.html | 243 + .../whirled/spot/client/SpotService.html | 350 + .../client/class-use/SpotSceneController.html | 182 + .../client/class-use/SpotSceneDirector.html | 145 + .../SpotService.SpotSceneMoveListener.html | 277 + .../spot/client/class-use/SpotService.html | 183 + .../whirled/spot/client/package-frame.html | 48 + .../whirled/spot/client/package-summary.html | 182 + .../whirled/spot/client/package-tree.html | 176 + .../whirled/spot/client/package-use.html | 236 + .../threerings/whirled/spot/data/Cluster.html | 457 + .../whirled/spot/data/ClusterObject.html | 417 + .../spot/data/ClusteredBodyObject.html | 256 + .../whirled/spot/data/Location.html | 339 + .../spot/data/ModifyPortalsUpdate.html | 381 + .../threerings/whirled/spot/data/Portal.html | 537 ++ .../whirled/spot/data/SceneLocation.html | 415 + .../whirled/spot/data/SpotCodes.html | 362 + ...potMarshaller.SpotSceneMoveMarshaller.html | 587 ++ .../whirled/spot/data/SpotMarshaller.html | 538 ++ .../whirled/spot/data/SpotScene.html | 372 + .../whirled/spot/data/SpotSceneImpl.html | 518 ++ .../whirled/spot/data/SpotSceneModel.html | 434 + .../whirled/spot/data/SpotSceneObject.html | 625 ++ .../whirled/spot/data/class-use/Cluster.html | 300 + .../spot/data/class-use/ClusterObject.html | 145 + .../data/class-use/ClusteredBodyObject.html | 145 + .../whirled/spot/data/class-use/Location.html | 484 + .../data/class-use/ModifyPortalsUpdate.html | 145 + .../whirled/spot/data/class-use/Portal.html | 626 ++ .../spot/data/class-use/SceneLocation.html | 254 + .../spot/data/class-use/SpotCodes.html | 241 + ...potMarshaller.SpotSceneMoveMarshaller.html | 145 + .../spot/data/class-use/SpotMarshaller.html | 145 + .../spot/data/class-use/SpotScene.html | 210 + .../spot/data/class-use/SpotSceneImpl.html | 145 + .../spot/data/class-use/SpotSceneModel.html | 204 + .../spot/data/class-use/SpotSceneObject.html | 182 + .../whirled/spot/data/package-frame.html | 68 + .../whirled/spot/data/package-summary.html | 224 + .../whirled/spot/data/package-tree.html | 211 + .../whirled/spot/data/package-use.html | 422 + .../whirled/spot/package-frame.html | 33 + .../whirled/spot/package-summary.html | 271 + .../threerings/whirled/spot/package-tree.html | 154 + .../threerings/whirled/spot/package-use.html | 145 + .../whirled/spot/server/SpotClient.html | 265 + .../whirled/spot/server/SpotProvider.html | 327 + .../whirled/spot/server/SpotSceneManager.html | 475 + .../spot/server/SpotSceneMoveHandler.html | 253 + .../spot/server/SpotSceneRegistry.html | 517 ++ .../spot/server/class-use/SpotClient.html | 145 + .../spot/server/class-use/SpotProvider.html | 181 + .../server/class-use/SpotSceneManager.html | 214 + .../class-use/SpotSceneMoveHandler.html | 145 + .../server/class-use/SpotSceneRegistry.html | 145 + .../whirled/spot/server/package-frame.html | 50 + .../whirled/spot/server/package-summary.html | 187 + .../whirled/spot/server/package-tree.html | 183 + .../whirled/spot/server/package-use.html | 198 + .../whirled/spot/tools/EditablePortal.html | 363 + .../spot/tools/class-use/EditablePortal.html | 182 + .../whirled/spot/tools/package-frame.html | 33 + .../whirled/spot/tools/package-summary.html | 159 + .../whirled/spot/tools/package-tree.html | 160 + .../whirled/spot/tools/package-use.html | 172 + .../spot/tools/xml/SpotSceneRuleSet.html | 287 + .../spot/tools/xml/SpotSceneWriter.html | 306 + .../tools/xml/class-use/SpotSceneRuleSet.html | 145 + .../tools/xml/class-use/SpotSceneWriter.html | 145 + .../whirled/spot/tools/xml/package-frame.html | 35 + .../spot/tools/xml/package-summary.html | 162 + .../whirled/spot/tools/xml/package-tree.html | 156 + .../whirled/spot/tools/xml/package-use.html | 145 + .../whirled/tools/xml/SceneParser.html | 315 + .../whirled/tools/xml/SceneRuleSet.html | 290 + .../whirled/tools/xml/SceneWriter.html | 363 + .../tools/xml/class-use/SceneParser.html | 181 + .../tools/xml/class-use/SceneRuleSet.html | 181 + .../tools/xml/class-use/SceneWriter.html | 181 + .../whirled/tools/xml/package-frame.html | 37 + .../whirled/tools/xml/package-summary.html | 166 + .../whirled/tools/xml/package-tree.html | 155 + .../whirled/tools/xml/package-use.html | 183 + .../whirled/util/NoSuchSceneException.html | 274 + .../threerings/whirled/util/SceneFactory.html | 218 + .../threerings/whirled/util/UpdateList.html | 309 + .../whirled/util/WhirledContext.html | 238 + .../util/class-use/NoSuchSceneException.html | 218 + .../whirled/util/class-use/SceneFactory.html | 182 + .../whirled/util/class-use/UpdateList.html | 189 + .../util/class-use/WhirledContext.html | 241 + .../whirled/util/package-frame.html | 57 + .../whirled/util/package-summary.html | 192 + .../threerings/whirled/util/package-tree.html | 168 + .../threerings/whirled/util/package-use.html | 262 + apidocs/com/threerings/whirled/zone/Log.html | 265 + .../whirled/zone/class-use/Log.html | 145 + .../whirled/zone/client/ZoneAdapter.html | 329 + .../whirled/zone/client/ZoneDecoder.html | 358 + .../whirled/zone/client/ZoneDirector.html | 639 ++ .../whirled/zone/client/ZoneObserver.html | 266 + .../whirled/zone/client/ZoneReceiver.html | 247 + .../client/ZoneService.ZoneMoveListener.html | 330 + .../whirled/zone/client/ZoneService.html | 255 + .../zone/client/class-use/ZoneAdapter.html | 145 + .../zone/client/class-use/ZoneDecoder.html | 145 + .../zone/client/class-use/ZoneDirector.html | 145 + .../zone/client/class-use/ZoneObserver.html | 207 + .../zone/client/class-use/ZoneReceiver.html | 196 + .../ZoneService.ZoneMoveListener.html | 366 + .../zone/client/class-use/ZoneService.html | 183 + .../whirled/zone/client/package-frame.html | 54 + .../whirled/zone/client/package-summary.html | 196 + .../whirled/zone/client/package-tree.html | 172 + .../whirled/zone/client/package-use.html | 248 + .../whirled/zone/data/SceneSummary.html | 385 + .../whirled/zone/data/ZoneCodes.html | 244 + .../ZoneMarshaller.ZoneMoveMarshaller.html | 545 ++ .../whirled/zone/data/ZoneMarshaller.html | 383 + .../whirled/zone/data/ZoneSummary.html | 363 + .../whirled/zone/data/ZonedBodyObject.html | 235 + .../zone/data/class-use/SceneSummary.html | 181 + .../zone/data/class-use/ZoneCodes.html | 145 + .../ZoneMarshaller.ZoneMoveMarshaller.html | 145 + .../zone/data/class-use/ZoneMarshaller.html | 145 + .../zone/data/class-use/ZoneSummary.html | 362 + .../zone/data/class-use/ZonedBodyObject.html | 192 + .../whirled/zone/data/package-frame.html | 52 + .../whirled/zone/data/package-summary.html | 194 + .../whirled/zone/data/package-tree.html | 177 + .../whirled/zone/data/package-use.html | 229 + .../whirled/zone/package-frame.html | 33 + .../whirled/zone/package-summary.html | 158 + .../threerings/whirled/zone/package-tree.html | 154 + .../threerings/whirled/zone/package-use.html | 145 + .../whirled/zone/peer/data/HostedZone.html | 366 + .../zone/peer/data/class-use/HostedZone.html | 249 + .../whirled/zone/peer/data/package-frame.html | 33 + .../zone/peer/data/package-summary.html | 158 + .../whirled/zone/peer/data/package-tree.html | 158 + .../whirled/zone/peer/data/package-use.html | 171 + .../zone/peer/server/PeeredZoneManager.html | 245 + ...eeredZoneRegistry.PeerZoneMoveHandler.html | 285 + ...neRegistry.PeerZoneResolutionListener.html | 234 + ...ZoneRegistry.PeerZoneShutdownListener.html | 214 + .../zone/peer/server/PeeredZoneRegistry.html | 439 + .../zone/peer/server/ZoneNodeObject.html | 478 + .../peer/server/ZonePeerManager.NodeFunc.html | 297 + .../zone/peer/server/ZonePeerManager.html | 375 + .../server/class-use/PeeredZoneManager.html | 181 + ...eeredZoneRegistry.PeerZoneMoveHandler.html | 145 + ...neRegistry.PeerZoneResolutionListener.html | 198 + ...ZoneRegistry.PeerZoneShutdownListener.html | 182 + .../server/class-use/PeeredZoneRegistry.html | 145 + .../peer/server/class-use/ZoneNodeObject.html | 181 + .../class-use/ZonePeerManager.NodeFunc.html | 145 + .../server/class-use/ZonePeerManager.html | 180 + .../zone/peer/server/package-frame.html | 56 + .../zone/peer/server/package-summary.html | 196 + .../zone/peer/server/package-tree.html | 187 + .../whirled/zone/peer/server/package-use.html | 195 + .../ZoneManager.ResolutionListener.html | 246 + .../whirled/zone/server/ZoneManager.html | 327 + .../whirled/zone/server/ZoneMoveHandler.html | 318 + .../whirled/zone/server/ZoneProvider.html | 235 + .../whirled/zone/server/ZoneRegistry.html | 396 + .../whirled/zone/server/ZoneSender.html | 274 + .../ZoneManager.ResolutionListener.html | 261 + .../zone/server/class-use/ZoneManager.html | 284 + .../server/class-use/ZoneMoveHandler.html | 181 + .../zone/server/class-use/ZoneProvider.html | 210 + .../zone/server/class-use/ZoneRegistry.html | 181 + .../zone/server/class-use/ZoneSender.html | 145 + .../whirled/zone/server/package-frame.html | 52 + .../whirled/zone/server/package-summary.html | 190 + .../whirled/zone/server/package-tree.html | 168 + .../whirled/zone/server/package-use.html | 228 + .../whirled/zone/util/ZoneUtil.html | 328 + .../whirled/zone/util/class-use/ZoneUtil.html | 145 + .../whirled/zone/util/package-frame.html | 33 + .../whirled/zone/util/package-summary.html | 158 + .../whirled/zone/util/package-tree.html | 154 + .../whirled/zone/util/package-use.html | 145 + apidocs/constant-values.html | 2191 +++++ apidocs/deprecated-list.html | 197 + apidocs/help-doc.html | 224 + apidocs/index-all.html | 7783 +++++++++++++++++ apidocs/index.html | 40 + apidocs/overview-frame.html | 203 + apidocs/overview-summary.html | 478 + apidocs/overview-tree.html | 652 ++ apidocs/package-list | 81 + apidocs/resources/inherit.gif | Bin 0 -> 57 bytes apidocs/serialized-form.html | 3457 ++++++++ apidocs/stylesheet.css | 29 + 1100 files changed, 292958 insertions(+) create mode 100644 apidocs/allclasses-frame.html create mode 100644 apidocs/allclasses-noframe.html create mode 100644 apidocs/com/threerings/micasa/Log.html create mode 100644 apidocs/com/threerings/micasa/class-use/Log.html create mode 100644 apidocs/com/threerings/micasa/client/ChatPanel.html create mode 100644 apidocs/com/threerings/micasa/client/ClientController.html create mode 100644 apidocs/com/threerings/micasa/client/LogonPanel.html create mode 100644 apidocs/com/threerings/micasa/client/MiCasaApp.html create mode 100644 apidocs/com/threerings/micasa/client/MiCasaApplet.html create mode 100644 apidocs/com/threerings/micasa/client/MiCasaClient.html create mode 100644 apidocs/com/threerings/micasa/client/MiCasaFrame.html create mode 100644 apidocs/com/threerings/micasa/client/OccupantList.html create mode 100644 apidocs/com/threerings/micasa/client/class-use/ChatPanel.html create mode 100644 apidocs/com/threerings/micasa/client/class-use/ClientController.html create mode 100644 apidocs/com/threerings/micasa/client/class-use/LogonPanel.html create mode 100644 apidocs/com/threerings/micasa/client/class-use/MiCasaApp.html create mode 100644 apidocs/com/threerings/micasa/client/class-use/MiCasaApplet.html create mode 100644 apidocs/com/threerings/micasa/client/class-use/MiCasaClient.html create mode 100644 apidocs/com/threerings/micasa/client/class-use/MiCasaFrame.html create mode 100644 apidocs/com/threerings/micasa/client/class-use/OccupantList.html create mode 100644 apidocs/com/threerings/micasa/client/package-frame.html create mode 100644 apidocs/com/threerings/micasa/client/package-summary.html create mode 100644 apidocs/com/threerings/micasa/client/package-tree.html create mode 100644 apidocs/com/threerings/micasa/client/package-use.html create mode 100644 apidocs/com/threerings/micasa/data/MiCasaBootstrapData.html create mode 100644 apidocs/com/threerings/micasa/data/class-use/MiCasaBootstrapData.html create mode 100644 apidocs/com/threerings/micasa/data/package-frame.html create mode 100644 apidocs/com/threerings/micasa/data/package-summary.html create mode 100644 apidocs/com/threerings/micasa/data/package-tree.html create mode 100644 apidocs/com/threerings/micasa/data/package-use.html create mode 100644 apidocs/com/threerings/micasa/lobby/Lobby.html create mode 100644 apidocs/com/threerings/micasa/lobby/LobbyConfig.html create mode 100644 apidocs/com/threerings/micasa/lobby/LobbyController.html create mode 100644 apidocs/com/threerings/micasa/lobby/LobbyManager.html create mode 100644 apidocs/com/threerings/micasa/lobby/LobbyMarshaller.CategoriesMarshaller.html create mode 100644 apidocs/com/threerings/micasa/lobby/LobbyMarshaller.LobbiesMarshaller.html create mode 100644 apidocs/com/threerings/micasa/lobby/LobbyMarshaller.html create mode 100644 apidocs/com/threerings/micasa/lobby/LobbyObject.html create mode 100644 apidocs/com/threerings/micasa/lobby/LobbyPanel.html create mode 100644 apidocs/com/threerings/micasa/lobby/LobbyProvider.html create mode 100644 apidocs/com/threerings/micasa/lobby/LobbyRegistry.html create mode 100644 apidocs/com/threerings/micasa/lobby/LobbySelector.html create mode 100644 apidocs/com/threerings/micasa/lobby/LobbyService.CategoriesListener.html create mode 100644 apidocs/com/threerings/micasa/lobby/LobbyService.LobbiesListener.html create mode 100644 apidocs/com/threerings/micasa/lobby/LobbyService.html create mode 100644 apidocs/com/threerings/micasa/lobby/class-use/Lobby.html create mode 100644 apidocs/com/threerings/micasa/lobby/class-use/LobbyConfig.html create mode 100644 apidocs/com/threerings/micasa/lobby/class-use/LobbyController.html create mode 100644 apidocs/com/threerings/micasa/lobby/class-use/LobbyManager.html create mode 100644 apidocs/com/threerings/micasa/lobby/class-use/LobbyMarshaller.CategoriesMarshaller.html create mode 100644 apidocs/com/threerings/micasa/lobby/class-use/LobbyMarshaller.LobbiesMarshaller.html create mode 100644 apidocs/com/threerings/micasa/lobby/class-use/LobbyMarshaller.html create mode 100644 apidocs/com/threerings/micasa/lobby/class-use/LobbyObject.html create mode 100644 apidocs/com/threerings/micasa/lobby/class-use/LobbyPanel.html create mode 100644 apidocs/com/threerings/micasa/lobby/class-use/LobbyProvider.html create mode 100644 apidocs/com/threerings/micasa/lobby/class-use/LobbyRegistry.html create mode 100644 apidocs/com/threerings/micasa/lobby/class-use/LobbySelector.html create mode 100644 apidocs/com/threerings/micasa/lobby/class-use/LobbyService.CategoriesListener.html create mode 100644 apidocs/com/threerings/micasa/lobby/class-use/LobbyService.LobbiesListener.html create mode 100644 apidocs/com/threerings/micasa/lobby/class-use/LobbyService.html create mode 100644 apidocs/com/threerings/micasa/lobby/package-frame.html create mode 100644 apidocs/com/threerings/micasa/lobby/package-summary.html create mode 100644 apidocs/com/threerings/micasa/lobby/package-tree.html create mode 100644 apidocs/com/threerings/micasa/lobby/package-use.html create mode 100644 apidocs/com/threerings/micasa/lobby/table/TableItem.html create mode 100644 apidocs/com/threerings/micasa/lobby/table/TableListView.html create mode 100644 apidocs/com/threerings/micasa/lobby/table/TableLobbyConfig.html create mode 100644 apidocs/com/threerings/micasa/lobby/table/TableLobbyManager.html create mode 100644 apidocs/com/threerings/micasa/lobby/table/TableLobbyObject.html create mode 100644 apidocs/com/threerings/micasa/lobby/table/class-use/TableItem.html create mode 100644 apidocs/com/threerings/micasa/lobby/table/class-use/TableListView.html create mode 100644 apidocs/com/threerings/micasa/lobby/table/class-use/TableLobbyConfig.html create mode 100644 apidocs/com/threerings/micasa/lobby/table/class-use/TableLobbyManager.html create mode 100644 apidocs/com/threerings/micasa/lobby/table/class-use/TableLobbyObject.html create mode 100644 apidocs/com/threerings/micasa/lobby/table/package-frame.html create mode 100644 apidocs/com/threerings/micasa/lobby/table/package-summary.html create mode 100644 apidocs/com/threerings/micasa/lobby/table/package-tree.html create mode 100644 apidocs/com/threerings/micasa/lobby/table/package-use.html create mode 100644 apidocs/com/threerings/micasa/package-frame.html create mode 100644 apidocs/com/threerings/micasa/package-summary.html create mode 100644 apidocs/com/threerings/micasa/package-tree.html create mode 100644 apidocs/com/threerings/micasa/package-use.html create mode 100644 apidocs/com/threerings/micasa/server/MiCasaConfig.html create mode 100644 apidocs/com/threerings/micasa/server/MiCasaServer.html create mode 100644 apidocs/com/threerings/micasa/server/MiCasaSession.html create mode 100644 apidocs/com/threerings/micasa/server/class-use/MiCasaConfig.html create mode 100644 apidocs/com/threerings/micasa/server/class-use/MiCasaServer.html create mode 100644 apidocs/com/threerings/micasa/server/class-use/MiCasaSession.html create mode 100644 apidocs/com/threerings/micasa/server/package-frame.html create mode 100644 apidocs/com/threerings/micasa/server/package-summary.html create mode 100644 apidocs/com/threerings/micasa/server/package-tree.html create mode 100644 apidocs/com/threerings/micasa/server/package-use.html create mode 100644 apidocs/com/threerings/micasa/simulator/client/SimpleClient.html create mode 100644 apidocs/com/threerings/micasa/simulator/client/SimpleFrame.html create mode 100644 apidocs/com/threerings/micasa/simulator/client/SimulatorApp.html create mode 100644 apidocs/com/threerings/micasa/simulator/client/SimulatorClient.html create mode 100644 apidocs/com/threerings/micasa/simulator/client/SimulatorController.html create mode 100644 apidocs/com/threerings/micasa/simulator/client/SimulatorFrame.html create mode 100644 apidocs/com/threerings/micasa/simulator/client/SimulatorService.html create mode 100644 apidocs/com/threerings/micasa/simulator/client/class-use/SimpleClient.html create mode 100644 apidocs/com/threerings/micasa/simulator/client/class-use/SimpleFrame.html create mode 100644 apidocs/com/threerings/micasa/simulator/client/class-use/SimulatorApp.html create mode 100644 apidocs/com/threerings/micasa/simulator/client/class-use/SimulatorClient.html create mode 100644 apidocs/com/threerings/micasa/simulator/client/class-use/SimulatorController.html create mode 100644 apidocs/com/threerings/micasa/simulator/client/class-use/SimulatorFrame.html create mode 100644 apidocs/com/threerings/micasa/simulator/client/class-use/SimulatorService.html create mode 100644 apidocs/com/threerings/micasa/simulator/client/package-frame.html create mode 100644 apidocs/com/threerings/micasa/simulator/client/package-summary.html create mode 100644 apidocs/com/threerings/micasa/simulator/client/package-tree.html create mode 100644 apidocs/com/threerings/micasa/simulator/client/package-use.html create mode 100644 apidocs/com/threerings/micasa/simulator/data/SimulatorInfo.html create mode 100644 apidocs/com/threerings/micasa/simulator/data/SimulatorMarshaller.html create mode 100644 apidocs/com/threerings/micasa/simulator/data/class-use/SimulatorInfo.html create mode 100644 apidocs/com/threerings/micasa/simulator/data/class-use/SimulatorMarshaller.html create mode 100644 apidocs/com/threerings/micasa/simulator/data/package-frame.html create mode 100644 apidocs/com/threerings/micasa/simulator/data/package-summary.html create mode 100644 apidocs/com/threerings/micasa/simulator/data/package-tree.html create mode 100644 apidocs/com/threerings/micasa/simulator/data/package-use.html create mode 100644 apidocs/com/threerings/micasa/simulator/server/SimpleServer.html create mode 100644 apidocs/com/threerings/micasa/simulator/server/Simulant.html create mode 100644 apidocs/com/threerings/micasa/simulator/server/SimulatorManager.CreateGameTask.html create mode 100644 apidocs/com/threerings/micasa/simulator/server/SimulatorManager.html create mode 100644 apidocs/com/threerings/micasa/simulator/server/SimulatorProvider.html create mode 100644 apidocs/com/threerings/micasa/simulator/server/SimulatorServer.html create mode 100644 apidocs/com/threerings/micasa/simulator/server/class-use/SimpleServer.html create mode 100644 apidocs/com/threerings/micasa/simulator/server/class-use/Simulant.html create mode 100644 apidocs/com/threerings/micasa/simulator/server/class-use/SimulatorManager.CreateGameTask.html create mode 100644 apidocs/com/threerings/micasa/simulator/server/class-use/SimulatorManager.html create mode 100644 apidocs/com/threerings/micasa/simulator/server/class-use/SimulatorProvider.html create mode 100644 apidocs/com/threerings/micasa/simulator/server/class-use/SimulatorServer.html create mode 100644 apidocs/com/threerings/micasa/simulator/server/package-frame.html create mode 100644 apidocs/com/threerings/micasa/simulator/server/package-summary.html create mode 100644 apidocs/com/threerings/micasa/simulator/server/package-tree.html create mode 100644 apidocs/com/threerings/micasa/simulator/server/package-use.html create mode 100644 apidocs/com/threerings/micasa/simulator/util/SimulatorContext.html create mode 100644 apidocs/com/threerings/micasa/simulator/util/class-use/SimulatorContext.html create mode 100644 apidocs/com/threerings/micasa/simulator/util/package-frame.html create mode 100644 apidocs/com/threerings/micasa/simulator/util/package-summary.html create mode 100644 apidocs/com/threerings/micasa/simulator/util/package-tree.html create mode 100644 apidocs/com/threerings/micasa/simulator/util/package-use.html create mode 100644 apidocs/com/threerings/micasa/util/MiCasaContext.html create mode 100644 apidocs/com/threerings/micasa/util/class-use/MiCasaContext.html create mode 100644 apidocs/com/threerings/micasa/util/package-frame.html create mode 100644 apidocs/com/threerings/micasa/util/package-summary.html create mode 100644 apidocs/com/threerings/micasa/util/package-tree.html create mode 100644 apidocs/com/threerings/micasa/util/package-use.html create mode 100644 apidocs/com/threerings/parlor/Log.html create mode 100644 apidocs/com/threerings/parlor/card/Log.html create mode 100644 apidocs/com/threerings/parlor/card/class-use/Log.html create mode 100644 apidocs/com/threerings/parlor/card/client/CardGameController.html create mode 100644 apidocs/com/threerings/parlor/card/client/CardGameDecoder.html create mode 100644 apidocs/com/threerings/parlor/card/client/CardGameReceiver.html create mode 100644 apidocs/com/threerings/parlor/card/client/CardPanel.CardSelectionObserver.html create mode 100644 apidocs/com/threerings/parlor/card/client/CardPanel.html create mode 100644 apidocs/com/threerings/parlor/card/client/CardSprite.html create mode 100644 apidocs/com/threerings/parlor/card/client/CardSpriteObserver.html create mode 100644 apidocs/com/threerings/parlor/card/client/MicroCardSprite.html create mode 100644 apidocs/com/threerings/parlor/card/client/class-use/CardGameController.html create mode 100644 apidocs/com/threerings/parlor/card/client/class-use/CardGameDecoder.html create mode 100644 apidocs/com/threerings/parlor/card/client/class-use/CardGameReceiver.html create mode 100644 apidocs/com/threerings/parlor/card/client/class-use/CardPanel.CardSelectionObserver.html create mode 100644 apidocs/com/threerings/parlor/card/client/class-use/CardPanel.html create mode 100644 apidocs/com/threerings/parlor/card/client/class-use/CardSprite.html create mode 100644 apidocs/com/threerings/parlor/card/client/class-use/CardSpriteObserver.html create mode 100644 apidocs/com/threerings/parlor/card/client/class-use/MicroCardSprite.html create mode 100644 apidocs/com/threerings/parlor/card/client/package-frame.html create mode 100644 apidocs/com/threerings/parlor/card/client/package-summary.html create mode 100644 apidocs/com/threerings/parlor/card/client/package-tree.html create mode 100644 apidocs/com/threerings/parlor/card/client/package-use.html create mode 100644 apidocs/com/threerings/parlor/card/data/Card.html create mode 100644 apidocs/com/threerings/parlor/card/data/CardCodes.html create mode 100644 apidocs/com/threerings/parlor/card/data/CardGameObject.html create mode 100644 apidocs/com/threerings/parlor/card/data/Deck.html create mode 100644 apidocs/com/threerings/parlor/card/data/Hand.html create mode 100644 apidocs/com/threerings/parlor/card/data/PlayerCard.html create mode 100644 apidocs/com/threerings/parlor/card/data/class-use/Card.html create mode 100644 apidocs/com/threerings/parlor/card/data/class-use/CardCodes.html create mode 100644 apidocs/com/threerings/parlor/card/data/class-use/CardGameObject.html create mode 100644 apidocs/com/threerings/parlor/card/data/class-use/Deck.html create mode 100644 apidocs/com/threerings/parlor/card/data/class-use/Hand.html create mode 100644 apidocs/com/threerings/parlor/card/data/class-use/PlayerCard.html create mode 100644 apidocs/com/threerings/parlor/card/data/package-frame.html create mode 100644 apidocs/com/threerings/parlor/card/data/package-summary.html create mode 100644 apidocs/com/threerings/parlor/card/data/package-tree.html create mode 100644 apidocs/com/threerings/parlor/card/data/package-use.html create mode 100644 apidocs/com/threerings/parlor/card/package-frame.html create mode 100644 apidocs/com/threerings/parlor/card/package-summary.html create mode 100644 apidocs/com/threerings/parlor/card/package-tree.html create mode 100644 apidocs/com/threerings/parlor/card/package-use.html create mode 100644 apidocs/com/threerings/parlor/card/server/CardGameManager.html create mode 100644 apidocs/com/threerings/parlor/card/server/CardGameSender.html create mode 100644 apidocs/com/threerings/parlor/card/server/class-use/CardGameManager.html create mode 100644 apidocs/com/threerings/parlor/card/server/class-use/CardGameSender.html create mode 100644 apidocs/com/threerings/parlor/card/server/package-frame.html create mode 100644 apidocs/com/threerings/parlor/card/server/package-summary.html create mode 100644 apidocs/com/threerings/parlor/card/server/package-tree.html create mode 100644 apidocs/com/threerings/parlor/card/server/package-use.html create mode 100644 apidocs/com/threerings/parlor/card/trick/client/TrickCardGameControllerDelegate.html create mode 100644 apidocs/com/threerings/parlor/card/trick/client/TrickCardGameService.html create mode 100644 apidocs/com/threerings/parlor/card/trick/client/class-use/TrickCardGameControllerDelegate.html create mode 100644 apidocs/com/threerings/parlor/card/trick/client/class-use/TrickCardGameService.html create mode 100644 apidocs/com/threerings/parlor/card/trick/client/package-frame.html create mode 100644 apidocs/com/threerings/parlor/card/trick/client/package-summary.html create mode 100644 apidocs/com/threerings/parlor/card/trick/client/package-tree.html create mode 100644 apidocs/com/threerings/parlor/card/trick/client/package-use.html create mode 100644 apidocs/com/threerings/parlor/card/trick/data/TrickCardCodes.html create mode 100644 apidocs/com/threerings/parlor/card/trick/data/TrickCardGameMarshaller.html create mode 100644 apidocs/com/threerings/parlor/card/trick/data/TrickCardGameObject.html create mode 100644 apidocs/com/threerings/parlor/card/trick/data/class-use/TrickCardCodes.html create mode 100644 apidocs/com/threerings/parlor/card/trick/data/class-use/TrickCardGameMarshaller.html create mode 100644 apidocs/com/threerings/parlor/card/trick/data/class-use/TrickCardGameObject.html create mode 100644 apidocs/com/threerings/parlor/card/trick/data/package-frame.html create mode 100644 apidocs/com/threerings/parlor/card/trick/data/package-summary.html create mode 100644 apidocs/com/threerings/parlor/card/trick/data/package-tree.html create mode 100644 apidocs/com/threerings/parlor/card/trick/data/package-use.html create mode 100644 apidocs/com/threerings/parlor/card/trick/server/TrickCardGameManagerDelegate.html create mode 100644 apidocs/com/threerings/parlor/card/trick/server/TrickCardGameProvider.html create mode 100644 apidocs/com/threerings/parlor/card/trick/server/class-use/TrickCardGameManagerDelegate.html create mode 100644 apidocs/com/threerings/parlor/card/trick/server/class-use/TrickCardGameProvider.html create mode 100644 apidocs/com/threerings/parlor/card/trick/server/package-frame.html create mode 100644 apidocs/com/threerings/parlor/card/trick/server/package-summary.html create mode 100644 apidocs/com/threerings/parlor/card/trick/server/package-tree.html create mode 100644 apidocs/com/threerings/parlor/card/trick/server/package-use.html create mode 100644 apidocs/com/threerings/parlor/card/trick/util/TrickCardGameUtil.html create mode 100644 apidocs/com/threerings/parlor/card/trick/util/class-use/TrickCardGameUtil.html create mode 100644 apidocs/com/threerings/parlor/card/trick/util/package-frame.html create mode 100644 apidocs/com/threerings/parlor/card/trick/util/package-summary.html create mode 100644 apidocs/com/threerings/parlor/card/trick/util/package-tree.html create mode 100644 apidocs/com/threerings/parlor/card/trick/util/package-use.html create mode 100644 apidocs/com/threerings/parlor/class-use/Log.html create mode 100644 apidocs/com/threerings/parlor/client/DefaultSwingTableConfigurator.html create mode 100644 apidocs/com/threerings/parlor/client/GameReadyObserver.html create mode 100644 apidocs/com/threerings/parlor/client/Invitation.html create mode 100644 apidocs/com/threerings/parlor/client/InvitationHandler.html create mode 100644 apidocs/com/threerings/parlor/client/InvitationResponseObserver.html create mode 100644 apidocs/com/threerings/parlor/client/ParlorDecoder.html create mode 100644 apidocs/com/threerings/parlor/client/ParlorDirector.html create mode 100644 apidocs/com/threerings/parlor/client/ParlorReceiver.html create mode 100644 apidocs/com/threerings/parlor/client/ParlorService.InviteListener.html create mode 100644 apidocs/com/threerings/parlor/client/ParlorService.html create mode 100644 apidocs/com/threerings/parlor/client/SeatednessObserver.html create mode 100644 apidocs/com/threerings/parlor/client/TableConfigurator.html create mode 100644 apidocs/com/threerings/parlor/client/TableDirector.html create mode 100644 apidocs/com/threerings/parlor/client/TableObserver.html create mode 100644 apidocs/com/threerings/parlor/client/TableService.html create mode 100644 apidocs/com/threerings/parlor/client/class-use/DefaultSwingTableConfigurator.html create mode 100644 apidocs/com/threerings/parlor/client/class-use/GameReadyObserver.html create mode 100644 apidocs/com/threerings/parlor/client/class-use/Invitation.html create mode 100644 apidocs/com/threerings/parlor/client/class-use/InvitationHandler.html create mode 100644 apidocs/com/threerings/parlor/client/class-use/InvitationResponseObserver.html create mode 100644 apidocs/com/threerings/parlor/client/class-use/ParlorDecoder.html create mode 100644 apidocs/com/threerings/parlor/client/class-use/ParlorDirector.html create mode 100644 apidocs/com/threerings/parlor/client/class-use/ParlorReceiver.html create mode 100644 apidocs/com/threerings/parlor/client/class-use/ParlorService.InviteListener.html create mode 100644 apidocs/com/threerings/parlor/client/class-use/ParlorService.html create mode 100644 apidocs/com/threerings/parlor/client/class-use/SeatednessObserver.html create mode 100644 apidocs/com/threerings/parlor/client/class-use/TableConfigurator.html create mode 100644 apidocs/com/threerings/parlor/client/class-use/TableDirector.html create mode 100644 apidocs/com/threerings/parlor/client/class-use/TableObserver.html create mode 100644 apidocs/com/threerings/parlor/client/class-use/TableService.html create mode 100644 apidocs/com/threerings/parlor/client/package-frame.html create mode 100644 apidocs/com/threerings/parlor/client/package-summary.html create mode 100644 apidocs/com/threerings/parlor/client/package-tree.html create mode 100644 apidocs/com/threerings/parlor/client/package-use.html create mode 100644 apidocs/com/threerings/parlor/data/ChoiceParameter.html create mode 100644 apidocs/com/threerings/parlor/data/Parameter.html create mode 100644 apidocs/com/threerings/parlor/data/ParlorCodes.html create mode 100644 apidocs/com/threerings/parlor/data/ParlorMarshaller.InviteMarshaller.html create mode 100644 apidocs/com/threerings/parlor/data/ParlorMarshaller.html create mode 100644 apidocs/com/threerings/parlor/data/RangeParameter.html create mode 100644 apidocs/com/threerings/parlor/data/Table.html create mode 100644 apidocs/com/threerings/parlor/data/TableConfig.html create mode 100644 apidocs/com/threerings/parlor/data/TableLobbyObject.html create mode 100644 apidocs/com/threerings/parlor/data/TableMarshaller.html create mode 100644 apidocs/com/threerings/parlor/data/ToggleParameter.html create mode 100644 apidocs/com/threerings/parlor/data/class-use/ChoiceParameter.html create mode 100644 apidocs/com/threerings/parlor/data/class-use/Parameter.html create mode 100644 apidocs/com/threerings/parlor/data/class-use/ParlorCodes.html create mode 100644 apidocs/com/threerings/parlor/data/class-use/ParlorMarshaller.InviteMarshaller.html create mode 100644 apidocs/com/threerings/parlor/data/class-use/ParlorMarshaller.html create mode 100644 apidocs/com/threerings/parlor/data/class-use/RangeParameter.html create mode 100644 apidocs/com/threerings/parlor/data/class-use/Table.html create mode 100644 apidocs/com/threerings/parlor/data/class-use/TableConfig.html create mode 100644 apidocs/com/threerings/parlor/data/class-use/TableLobbyObject.html create mode 100644 apidocs/com/threerings/parlor/data/class-use/TableMarshaller.html create mode 100644 apidocs/com/threerings/parlor/data/class-use/ToggleParameter.html create mode 100644 apidocs/com/threerings/parlor/data/package-frame.html create mode 100644 apidocs/com/threerings/parlor/data/package-summary.html create mode 100644 apidocs/com/threerings/parlor/data/package-tree.html create mode 100644 apidocs/com/threerings/parlor/data/package-use.html create mode 100644 apidocs/com/threerings/parlor/game/client/GameConfigurator.html create mode 100644 apidocs/com/threerings/parlor/game/client/GameController.html create mode 100644 apidocs/com/threerings/parlor/game/client/GameControllerDelegate.html create mode 100644 apidocs/com/threerings/parlor/game/client/SwingGameConfigurator.html create mode 100644 apidocs/com/threerings/parlor/game/client/class-use/GameConfigurator.html create mode 100644 apidocs/com/threerings/parlor/game/client/class-use/GameController.html create mode 100644 apidocs/com/threerings/parlor/game/client/class-use/GameControllerDelegate.html create mode 100644 apidocs/com/threerings/parlor/game/client/class-use/SwingGameConfigurator.html create mode 100644 apidocs/com/threerings/parlor/game/client/package-frame.html create mode 100644 apidocs/com/threerings/parlor/game/client/package-summary.html create mode 100644 apidocs/com/threerings/parlor/game/client/package-tree.html create mode 100644 apidocs/com/threerings/parlor/game/client/package-use.html create mode 100644 apidocs/com/threerings/parlor/game/data/GameAI.html create mode 100644 apidocs/com/threerings/parlor/game/data/GameCodes.html create mode 100644 apidocs/com/threerings/parlor/game/data/GameConfig.html create mode 100644 apidocs/com/threerings/parlor/game/data/GameObject.html create mode 100644 apidocs/com/threerings/parlor/game/data/UserIdentifier.Ider.html create mode 100644 apidocs/com/threerings/parlor/game/data/UserIdentifier.html create mode 100644 apidocs/com/threerings/parlor/game/data/class-use/GameAI.html create mode 100644 apidocs/com/threerings/parlor/game/data/class-use/GameCodes.html create mode 100644 apidocs/com/threerings/parlor/game/data/class-use/GameConfig.html create mode 100644 apidocs/com/threerings/parlor/game/data/class-use/GameObject.html create mode 100644 apidocs/com/threerings/parlor/game/data/class-use/UserIdentifier.Ider.html create mode 100644 apidocs/com/threerings/parlor/game/data/class-use/UserIdentifier.html create mode 100644 apidocs/com/threerings/parlor/game/data/package-frame.html create mode 100644 apidocs/com/threerings/parlor/game/data/package-summary.html create mode 100644 apidocs/com/threerings/parlor/game/data/package-tree.html create mode 100644 apidocs/com/threerings/parlor/game/data/package-use.html create mode 100644 apidocs/com/threerings/parlor/game/server/GameManager.html create mode 100644 apidocs/com/threerings/parlor/game/server/GameManagerDelegate.html create mode 100644 apidocs/com/threerings/parlor/game/server/GameWatcher.html create mode 100644 apidocs/com/threerings/parlor/game/server/TeamGameManager.html create mode 100644 apidocs/com/threerings/parlor/game/server/class-use/GameManager.html create mode 100644 apidocs/com/threerings/parlor/game/server/class-use/GameManagerDelegate.html create mode 100644 apidocs/com/threerings/parlor/game/server/class-use/GameWatcher.html create mode 100644 apidocs/com/threerings/parlor/game/server/class-use/TeamGameManager.html create mode 100644 apidocs/com/threerings/parlor/game/server/package-frame.html create mode 100644 apidocs/com/threerings/parlor/game/server/package-summary.html create mode 100644 apidocs/com/threerings/parlor/game/server/package-tree.html create mode 100644 apidocs/com/threerings/parlor/game/server/package-use.html create mode 100644 apidocs/com/threerings/parlor/media/ScoreAnimation.html create mode 100644 apidocs/com/threerings/parlor/media/class-use/ScoreAnimation.html create mode 100644 apidocs/com/threerings/parlor/media/package-frame.html create mode 100644 apidocs/com/threerings/parlor/media/package-summary.html create mode 100644 apidocs/com/threerings/parlor/media/package-tree.html create mode 100644 apidocs/com/threerings/parlor/media/package-use.html create mode 100644 apidocs/com/threerings/parlor/package-frame.html create mode 100644 apidocs/com/threerings/parlor/package-summary.html create mode 100644 apidocs/com/threerings/parlor/package-tree.html create mode 100644 apidocs/com/threerings/parlor/package-use.html create mode 100644 apidocs/com/threerings/parlor/rating/data/RatingCodes.html create mode 100644 apidocs/com/threerings/parlor/rating/data/class-use/RatingCodes.html create mode 100644 apidocs/com/threerings/parlor/rating/data/package-frame.html create mode 100644 apidocs/com/threerings/parlor/rating/data/package-summary.html create mode 100644 apidocs/com/threerings/parlor/rating/data/package-tree.html create mode 100644 apidocs/com/threerings/parlor/rating/data/package-use.html create mode 100644 apidocs/com/threerings/parlor/rating/server/Rating.html create mode 100644 apidocs/com/threerings/parlor/rating/server/RatingDelegate.html create mode 100644 apidocs/com/threerings/parlor/rating/server/class-use/Rating.html create mode 100644 apidocs/com/threerings/parlor/rating/server/class-use/RatingDelegate.html create mode 100644 apidocs/com/threerings/parlor/rating/server/package-frame.html create mode 100644 apidocs/com/threerings/parlor/rating/server/package-summary.html create mode 100644 apidocs/com/threerings/parlor/rating/server/package-tree.html create mode 100644 apidocs/com/threerings/parlor/rating/server/package-use.html create mode 100644 apidocs/com/threerings/parlor/rating/server/persist/PercentileRecord.html create mode 100644 apidocs/com/threerings/parlor/rating/server/persist/RatingRecord.html create mode 100644 apidocs/com/threerings/parlor/rating/server/persist/RatingRepository.html create mode 100644 apidocs/com/threerings/parlor/rating/server/persist/class-use/PercentileRecord.html create mode 100644 apidocs/com/threerings/parlor/rating/server/persist/class-use/RatingRecord.html create mode 100644 apidocs/com/threerings/parlor/rating/server/persist/class-use/RatingRepository.html create mode 100644 apidocs/com/threerings/parlor/rating/server/persist/package-frame.html create mode 100644 apidocs/com/threerings/parlor/rating/server/persist/package-summary.html create mode 100644 apidocs/com/threerings/parlor/rating/server/persist/package-tree.html create mode 100644 apidocs/com/threerings/parlor/rating/server/persist/package-use.html create mode 100644 apidocs/com/threerings/parlor/rating/util/Percentiler.html create mode 100644 apidocs/com/threerings/parlor/rating/util/class-use/Percentiler.html create mode 100644 apidocs/com/threerings/parlor/rating/util/package-frame.html create mode 100644 apidocs/com/threerings/parlor/rating/util/package-summary.html create mode 100644 apidocs/com/threerings/parlor/rating/util/package-tree.html create mode 100644 apidocs/com/threerings/parlor/rating/util/package-use.html create mode 100644 apidocs/com/threerings/parlor/server/ParlorManager.html create mode 100644 apidocs/com/threerings/parlor/server/ParlorProvider.html create mode 100644 apidocs/com/threerings/parlor/server/ParlorSender.html create mode 100644 apidocs/com/threerings/parlor/server/PlayManager.html create mode 100644 apidocs/com/threerings/parlor/server/PlayManagerDelegate.html create mode 100644 apidocs/com/threerings/parlor/server/TableManager.html create mode 100644 apidocs/com/threerings/parlor/server/TableProvider.html create mode 100644 apidocs/com/threerings/parlor/server/class-use/ParlorManager.html create mode 100644 apidocs/com/threerings/parlor/server/class-use/ParlorProvider.html create mode 100644 apidocs/com/threerings/parlor/server/class-use/ParlorSender.html create mode 100644 apidocs/com/threerings/parlor/server/class-use/PlayManager.html create mode 100644 apidocs/com/threerings/parlor/server/class-use/PlayManagerDelegate.html create mode 100644 apidocs/com/threerings/parlor/server/class-use/TableManager.html create mode 100644 apidocs/com/threerings/parlor/server/class-use/TableProvider.html create mode 100644 apidocs/com/threerings/parlor/server/package-frame.html create mode 100644 apidocs/com/threerings/parlor/server/package-summary.html create mode 100644 apidocs/com/threerings/parlor/server/package-tree.html create mode 100644 apidocs/com/threerings/parlor/server/package-use.html create mode 100644 apidocs/com/threerings/parlor/tourney/client/TourneyService.html create mode 100644 apidocs/com/threerings/parlor/tourney/client/TourniesService.html create mode 100644 apidocs/com/threerings/parlor/tourney/client/class-use/TourneyService.html create mode 100644 apidocs/com/threerings/parlor/tourney/client/class-use/TourniesService.html create mode 100644 apidocs/com/threerings/parlor/tourney/client/package-frame.html create mode 100644 apidocs/com/threerings/parlor/tourney/client/package-summary.html create mode 100644 apidocs/com/threerings/parlor/tourney/client/package-tree.html create mode 100644 apidocs/com/threerings/parlor/tourney/client/package-use.html create mode 100644 apidocs/com/threerings/parlor/tourney/data/EntryFee.html create mode 100644 apidocs/com/threerings/parlor/tourney/data/Participant.html create mode 100644 apidocs/com/threerings/parlor/tourney/data/Prize.html create mode 100644 apidocs/com/threerings/parlor/tourney/data/TourneyCodes.html create mode 100644 apidocs/com/threerings/parlor/tourney/data/TourneyConfig.html create mode 100644 apidocs/com/threerings/parlor/tourney/data/TourneyLogicData.html create mode 100644 apidocs/com/threerings/parlor/tourney/data/TourneyMarshaller.html create mode 100644 apidocs/com/threerings/parlor/tourney/data/TourneyObject.html create mode 100644 apidocs/com/threerings/parlor/tourney/data/TourniesMarshaller.html create mode 100644 apidocs/com/threerings/parlor/tourney/data/class-use/EntryFee.html create mode 100644 apidocs/com/threerings/parlor/tourney/data/class-use/Participant.html create mode 100644 apidocs/com/threerings/parlor/tourney/data/class-use/Prize.html create mode 100644 apidocs/com/threerings/parlor/tourney/data/class-use/TourneyCodes.html create mode 100644 apidocs/com/threerings/parlor/tourney/data/class-use/TourneyConfig.html create mode 100644 apidocs/com/threerings/parlor/tourney/data/class-use/TourneyLogicData.html create mode 100644 apidocs/com/threerings/parlor/tourney/data/class-use/TourneyMarshaller.html create mode 100644 apidocs/com/threerings/parlor/tourney/data/class-use/TourneyObject.html create mode 100644 apidocs/com/threerings/parlor/tourney/data/class-use/TourniesMarshaller.html create mode 100644 apidocs/com/threerings/parlor/tourney/data/package-frame.html create mode 100644 apidocs/com/threerings/parlor/tourney/data/package-summary.html create mode 100644 apidocs/com/threerings/parlor/tourney/data/package-tree.html create mode 100644 apidocs/com/threerings/parlor/tourney/data/package-use.html create mode 100644 apidocs/com/threerings/parlor/tourney/server/TourneyManager.html create mode 100644 apidocs/com/threerings/parlor/tourney/server/TourneyProvider.html create mode 100644 apidocs/com/threerings/parlor/tourney/server/TourniesManager.html create mode 100644 apidocs/com/threerings/parlor/tourney/server/TourniesProvider.html create mode 100644 apidocs/com/threerings/parlor/tourney/server/class-use/TourneyManager.html create mode 100644 apidocs/com/threerings/parlor/tourney/server/class-use/TourneyProvider.html create mode 100644 apidocs/com/threerings/parlor/tourney/server/class-use/TourniesManager.html create mode 100644 apidocs/com/threerings/parlor/tourney/server/class-use/TourniesProvider.html create mode 100644 apidocs/com/threerings/parlor/tourney/server/package-frame.html create mode 100644 apidocs/com/threerings/parlor/tourney/server/package-summary.html create mode 100644 apidocs/com/threerings/parlor/tourney/server/package-tree.html create mode 100644 apidocs/com/threerings/parlor/tourney/server/package-use.html create mode 100644 apidocs/com/threerings/parlor/tourney/server/persist/TourneyRepository.TourneyRecord.html create mode 100644 apidocs/com/threerings/parlor/tourney/server/persist/TourneyRepository.html create mode 100644 apidocs/com/threerings/parlor/tourney/server/persist/class-use/TourneyRepository.TourneyRecord.html create mode 100644 apidocs/com/threerings/parlor/tourney/server/persist/class-use/TourneyRepository.html create mode 100644 apidocs/com/threerings/parlor/tourney/server/persist/package-frame.html create mode 100644 apidocs/com/threerings/parlor/tourney/server/persist/package-summary.html create mode 100644 apidocs/com/threerings/parlor/tourney/server/persist/package-tree.html create mode 100644 apidocs/com/threerings/parlor/tourney/server/persist/package-use.html create mode 100644 apidocs/com/threerings/parlor/turn/client/TurnDisplay.html create mode 100644 apidocs/com/threerings/parlor/turn/client/TurnGameController.html create mode 100644 apidocs/com/threerings/parlor/turn/client/TurnGameControllerDelegate.html create mode 100644 apidocs/com/threerings/parlor/turn/client/class-use/TurnDisplay.html create mode 100644 apidocs/com/threerings/parlor/turn/client/class-use/TurnGameController.html create mode 100644 apidocs/com/threerings/parlor/turn/client/class-use/TurnGameControllerDelegate.html create mode 100644 apidocs/com/threerings/parlor/turn/client/package-frame.html create mode 100644 apidocs/com/threerings/parlor/turn/client/package-summary.html create mode 100644 apidocs/com/threerings/parlor/turn/client/package-tree.html create mode 100644 apidocs/com/threerings/parlor/turn/client/package-use.html create mode 100644 apidocs/com/threerings/parlor/turn/data/TurnGameObject.html create mode 100644 apidocs/com/threerings/parlor/turn/data/class-use/TurnGameObject.html create mode 100644 apidocs/com/threerings/parlor/turn/data/package-frame.html create mode 100644 apidocs/com/threerings/parlor/turn/data/package-summary.html create mode 100644 apidocs/com/threerings/parlor/turn/data/package-tree.html create mode 100644 apidocs/com/threerings/parlor/turn/data/package-use.html create mode 100644 apidocs/com/threerings/parlor/turn/server/TurnGameManager.html create mode 100644 apidocs/com/threerings/parlor/turn/server/TurnGameManagerDelegate.html create mode 100644 apidocs/com/threerings/parlor/turn/server/class-use/TurnGameManager.html create mode 100644 apidocs/com/threerings/parlor/turn/server/class-use/TurnGameManagerDelegate.html create mode 100644 apidocs/com/threerings/parlor/turn/server/package-frame.html create mode 100644 apidocs/com/threerings/parlor/turn/server/package-summary.html create mode 100644 apidocs/com/threerings/parlor/turn/server/package-tree.html create mode 100644 apidocs/com/threerings/parlor/turn/server/package-use.html create mode 100644 apidocs/com/threerings/parlor/util/ParlorContext.html create mode 100644 apidocs/com/threerings/parlor/util/RobotPlayer.html create mode 100644 apidocs/com/threerings/parlor/util/class-use/ParlorContext.html create mode 100644 apidocs/com/threerings/parlor/util/class-use/RobotPlayer.html create mode 100644 apidocs/com/threerings/parlor/util/package-frame.html create mode 100644 apidocs/com/threerings/parlor/util/package-summary.html create mode 100644 apidocs/com/threerings/parlor/util/package-tree.html create mode 100644 apidocs/com/threerings/parlor/util/package-use.html create mode 100644 apidocs/com/threerings/puzzle/Log.html create mode 100644 apidocs/com/threerings/puzzle/class-use/Log.html create mode 100644 apidocs/com/threerings/puzzle/client/PlayerStatusView.html create mode 100644 apidocs/com/threerings/puzzle/client/PuzzleAnimationWaiter.html create mode 100644 apidocs/com/threerings/puzzle/client/PuzzleBoardView.html create mode 100644 apidocs/com/threerings/puzzle/client/PuzzleController.ClearPender.html create mode 100644 apidocs/com/threerings/puzzle/client/PuzzleController.html create mode 100644 apidocs/com/threerings/puzzle/client/PuzzleControllerDelegate.html create mode 100644 apidocs/com/threerings/puzzle/client/PuzzleGameService.html create mode 100644 apidocs/com/threerings/puzzle/client/PuzzlePanel.html create mode 100644 apidocs/com/threerings/puzzle/client/PuzzlePrefs.html create mode 100644 apidocs/com/threerings/puzzle/client/class-use/PlayerStatusView.html create mode 100644 apidocs/com/threerings/puzzle/client/class-use/PuzzleAnimationWaiter.html create mode 100644 apidocs/com/threerings/puzzle/client/class-use/PuzzleBoardView.html create mode 100644 apidocs/com/threerings/puzzle/client/class-use/PuzzleController.ClearPender.html create mode 100644 apidocs/com/threerings/puzzle/client/class-use/PuzzleController.html create mode 100644 apidocs/com/threerings/puzzle/client/class-use/PuzzleControllerDelegate.html create mode 100644 apidocs/com/threerings/puzzle/client/class-use/PuzzleGameService.html create mode 100644 apidocs/com/threerings/puzzle/client/class-use/PuzzlePanel.html create mode 100644 apidocs/com/threerings/puzzle/client/class-use/PuzzlePrefs.html create mode 100644 apidocs/com/threerings/puzzle/client/package-frame.html create mode 100644 apidocs/com/threerings/puzzle/client/package-summary.html create mode 100644 apidocs/com/threerings/puzzle/client/package-tree.html create mode 100644 apidocs/com/threerings/puzzle/client/package-use.html create mode 100644 apidocs/com/threerings/puzzle/data/Board.html create mode 100644 apidocs/com/threerings/puzzle/data/BoardSummary.html create mode 100644 apidocs/com/threerings/puzzle/data/PuzzleCodes.html create mode 100644 apidocs/com/threerings/puzzle/data/PuzzleGameCodes.html create mode 100644 apidocs/com/threerings/puzzle/data/PuzzleGameMarshaller.html create mode 100644 apidocs/com/threerings/puzzle/data/PuzzleObject.html create mode 100644 apidocs/com/threerings/puzzle/data/class-use/Board.html create mode 100644 apidocs/com/threerings/puzzle/data/class-use/BoardSummary.html create mode 100644 apidocs/com/threerings/puzzle/data/class-use/PuzzleCodes.html create mode 100644 apidocs/com/threerings/puzzle/data/class-use/PuzzleGameCodes.html create mode 100644 apidocs/com/threerings/puzzle/data/class-use/PuzzleGameMarshaller.html create mode 100644 apidocs/com/threerings/puzzle/data/class-use/PuzzleObject.html create mode 100644 apidocs/com/threerings/puzzle/data/package-frame.html create mode 100644 apidocs/com/threerings/puzzle/data/package-summary.html create mode 100644 apidocs/com/threerings/puzzle/data/package-tree.html create mode 100644 apidocs/com/threerings/puzzle/data/package-use.html create mode 100644 apidocs/com/threerings/puzzle/drop/client/DropBlockSprite.html create mode 100644 apidocs/com/threerings/puzzle/drop/client/DropBoardView.html create mode 100644 apidocs/com/threerings/puzzle/drop/client/DropControllerDelegate.html create mode 100644 apidocs/com/threerings/puzzle/drop/client/DropPanel.html create mode 100644 apidocs/com/threerings/puzzle/drop/client/DropSprite.html create mode 100644 apidocs/com/threerings/puzzle/drop/client/DropSpriteObserver.html create mode 100644 apidocs/com/threerings/puzzle/drop/client/NextBlockView.html create mode 100644 apidocs/com/threerings/puzzle/drop/client/PieceGroupAnimation.html create mode 100644 apidocs/com/threerings/puzzle/drop/client/class-use/DropBlockSprite.html create mode 100644 apidocs/com/threerings/puzzle/drop/client/class-use/DropBoardView.html create mode 100644 apidocs/com/threerings/puzzle/drop/client/class-use/DropControllerDelegate.html create mode 100644 apidocs/com/threerings/puzzle/drop/client/class-use/DropPanel.html create mode 100644 apidocs/com/threerings/puzzle/drop/client/class-use/DropSprite.html create mode 100644 apidocs/com/threerings/puzzle/drop/client/class-use/DropSpriteObserver.html create mode 100644 apidocs/com/threerings/puzzle/drop/client/class-use/NextBlockView.html create mode 100644 apidocs/com/threerings/puzzle/drop/client/class-use/PieceGroupAnimation.html create mode 100644 apidocs/com/threerings/puzzle/drop/client/package-frame.html create mode 100644 apidocs/com/threerings/puzzle/drop/client/package-summary.html create mode 100644 apidocs/com/threerings/puzzle/drop/client/package-tree.html create mode 100644 apidocs/com/threerings/puzzle/drop/client/package-use.html create mode 100644 apidocs/com/threerings/puzzle/drop/data/DropBoard.PieceOperation.html create mode 100644 apidocs/com/threerings/puzzle/drop/data/DropBoard.html create mode 100644 apidocs/com/threerings/puzzle/drop/data/DropBoardSummary.html create mode 100644 apidocs/com/threerings/puzzle/drop/data/DropCodes.html create mode 100644 apidocs/com/threerings/puzzle/drop/data/DropConfig.html create mode 100644 apidocs/com/threerings/puzzle/drop/data/DropLogic.html create mode 100644 apidocs/com/threerings/puzzle/drop/data/DropPieceCodes.html create mode 100644 apidocs/com/threerings/puzzle/drop/data/SegmentInfo.html create mode 100644 apidocs/com/threerings/puzzle/drop/data/class-use/DropBoard.PieceOperation.html create mode 100644 apidocs/com/threerings/puzzle/drop/data/class-use/DropBoard.html create mode 100644 apidocs/com/threerings/puzzle/drop/data/class-use/DropBoardSummary.html create mode 100644 apidocs/com/threerings/puzzle/drop/data/class-use/DropCodes.html create mode 100644 apidocs/com/threerings/puzzle/drop/data/class-use/DropConfig.html create mode 100644 apidocs/com/threerings/puzzle/drop/data/class-use/DropLogic.html create mode 100644 apidocs/com/threerings/puzzle/drop/data/class-use/DropPieceCodes.html create mode 100644 apidocs/com/threerings/puzzle/drop/data/class-use/SegmentInfo.html create mode 100644 apidocs/com/threerings/puzzle/drop/data/package-frame.html create mode 100644 apidocs/com/threerings/puzzle/drop/data/package-summary.html create mode 100644 apidocs/com/threerings/puzzle/drop/data/package-tree.html create mode 100644 apidocs/com/threerings/puzzle/drop/data/package-use.html create mode 100644 apidocs/com/threerings/puzzle/drop/server/DropManagerDelegate.html create mode 100644 apidocs/com/threerings/puzzle/drop/server/class-use/DropManagerDelegate.html create mode 100644 apidocs/com/threerings/puzzle/drop/server/package-frame.html create mode 100644 apidocs/com/threerings/puzzle/drop/server/package-summary.html create mode 100644 apidocs/com/threerings/puzzle/drop/server/package-tree.html create mode 100644 apidocs/com/threerings/puzzle/drop/server/package-use.html create mode 100644 apidocs/com/threerings/puzzle/drop/util/DropBoardUtil.html create mode 100644 apidocs/com/threerings/puzzle/drop/util/DropGameUtil.html create mode 100644 apidocs/com/threerings/puzzle/drop/util/PieceDestroyer.DestroyLogic.html create mode 100644 apidocs/com/threerings/puzzle/drop/util/PieceDestroyer.html create mode 100644 apidocs/com/threerings/puzzle/drop/util/PieceDropLogic.html create mode 100644 apidocs/com/threerings/puzzle/drop/util/PieceDropper.DropObserver.html create mode 100644 apidocs/com/threerings/puzzle/drop/util/PieceDropper.PieceDropInfo.html create mode 100644 apidocs/com/threerings/puzzle/drop/util/PieceDropper.html create mode 100644 apidocs/com/threerings/puzzle/drop/util/class-use/DropBoardUtil.html create mode 100644 apidocs/com/threerings/puzzle/drop/util/class-use/DropGameUtil.html create mode 100644 apidocs/com/threerings/puzzle/drop/util/class-use/PieceDestroyer.DestroyLogic.html create mode 100644 apidocs/com/threerings/puzzle/drop/util/class-use/PieceDestroyer.html create mode 100644 apidocs/com/threerings/puzzle/drop/util/class-use/PieceDropLogic.html create mode 100644 apidocs/com/threerings/puzzle/drop/util/class-use/PieceDropper.DropObserver.html create mode 100644 apidocs/com/threerings/puzzle/drop/util/class-use/PieceDropper.PieceDropInfo.html create mode 100644 apidocs/com/threerings/puzzle/drop/util/class-use/PieceDropper.html create mode 100644 apidocs/com/threerings/puzzle/drop/util/package-frame.html create mode 100644 apidocs/com/threerings/puzzle/drop/util/package-summary.html create mode 100644 apidocs/com/threerings/puzzle/drop/util/package-tree.html create mode 100644 apidocs/com/threerings/puzzle/drop/util/package-use.html create mode 100644 apidocs/com/threerings/puzzle/package-frame.html create mode 100644 apidocs/com/threerings/puzzle/package-summary.html create mode 100644 apidocs/com/threerings/puzzle/package-tree.html create mode 100644 apidocs/com/threerings/puzzle/package-use.html create mode 100644 apidocs/com/threerings/puzzle/server/PuzzleGameProvider.html create mode 100644 apidocs/com/threerings/puzzle/server/PuzzleManager.html create mode 100644 apidocs/com/threerings/puzzle/server/PuzzleManagerDelegate.html create mode 100644 apidocs/com/threerings/puzzle/server/class-use/PuzzleGameProvider.html create mode 100644 apidocs/com/threerings/puzzle/server/class-use/PuzzleManager.html create mode 100644 apidocs/com/threerings/puzzle/server/class-use/PuzzleManagerDelegate.html create mode 100644 apidocs/com/threerings/puzzle/server/package-frame.html create mode 100644 apidocs/com/threerings/puzzle/server/package-summary.html create mode 100644 apidocs/com/threerings/puzzle/server/package-tree.html create mode 100644 apidocs/com/threerings/puzzle/server/package-use.html create mode 100644 apidocs/com/threerings/puzzle/util/PointSet.html create mode 100644 apidocs/com/threerings/puzzle/util/PuzzleContext.html create mode 100644 apidocs/com/threerings/puzzle/util/PuzzleGameUtil.html create mode 100644 apidocs/com/threerings/puzzle/util/class-use/PointSet.html create mode 100644 apidocs/com/threerings/puzzle/util/class-use/PuzzleContext.html create mode 100644 apidocs/com/threerings/puzzle/util/class-use/PuzzleGameUtil.html create mode 100644 apidocs/com/threerings/puzzle/util/package-frame.html create mode 100644 apidocs/com/threerings/puzzle/util/package-summary.html create mode 100644 apidocs/com/threerings/puzzle/util/package-tree.html create mode 100644 apidocs/com/threerings/puzzle/util/package-use.html create mode 100644 apidocs/com/threerings/stage/Log.html create mode 100644 apidocs/com/threerings/stage/class-use/Log.html create mode 100644 apidocs/com/threerings/stage/client/SceneColorizer.html create mode 100644 apidocs/com/threerings/stage/client/StageSceneController.html create mode 100644 apidocs/com/threerings/stage/client/StageScenePanel.html create mode 100644 apidocs/com/threerings/stage/client/StageSceneService.html create mode 100644 apidocs/com/threerings/stage/client/class-use/SceneColorizer.html create mode 100644 apidocs/com/threerings/stage/client/class-use/StageSceneController.html create mode 100644 apidocs/com/threerings/stage/client/class-use/StageScenePanel.html create mode 100644 apidocs/com/threerings/stage/client/class-use/StageSceneService.html create mode 100644 apidocs/com/threerings/stage/client/package-frame.html create mode 100644 apidocs/com/threerings/stage/client/package-summary.html create mode 100644 apidocs/com/threerings/stage/client/package-tree.html create mode 100644 apidocs/com/threerings/stage/client/package-use.html create mode 100644 apidocs/com/threerings/stage/data/DefaultColorUpdate.html create mode 100644 apidocs/com/threerings/stage/data/ModifyObjectsUpdate.html create mode 100644 apidocs/com/threerings/stage/data/StageCodes.html create mode 100644 apidocs/com/threerings/stage/data/StageLocation.html create mode 100644 apidocs/com/threerings/stage/data/StageMisoSceneModel.html create mode 100644 apidocs/com/threerings/stage/data/StageOccupantInfo.html create mode 100644 apidocs/com/threerings/stage/data/StageScene.html create mode 100644 apidocs/com/threerings/stage/data/StageSceneConfig.html create mode 100644 apidocs/com/threerings/stage/data/StageSceneMarshaller.html create mode 100644 apidocs/com/threerings/stage/data/StageSceneModel.html create mode 100644 apidocs/com/threerings/stage/data/StageSceneObject.html create mode 100644 apidocs/com/threerings/stage/data/class-use/DefaultColorUpdate.html create mode 100644 apidocs/com/threerings/stage/data/class-use/ModifyObjectsUpdate.html create mode 100644 apidocs/com/threerings/stage/data/class-use/StageCodes.html create mode 100644 apidocs/com/threerings/stage/data/class-use/StageLocation.html create mode 100644 apidocs/com/threerings/stage/data/class-use/StageMisoSceneModel.html create mode 100644 apidocs/com/threerings/stage/data/class-use/StageOccupantInfo.html create mode 100644 apidocs/com/threerings/stage/data/class-use/StageScene.html create mode 100644 apidocs/com/threerings/stage/data/class-use/StageSceneConfig.html create mode 100644 apidocs/com/threerings/stage/data/class-use/StageSceneMarshaller.html create mode 100644 apidocs/com/threerings/stage/data/class-use/StageSceneModel.html create mode 100644 apidocs/com/threerings/stage/data/class-use/StageSceneObject.html create mode 100644 apidocs/com/threerings/stage/data/package-frame.html create mode 100644 apidocs/com/threerings/stage/data/package-summary.html create mode 100644 apidocs/com/threerings/stage/data/package-tree.html create mode 100644 apidocs/com/threerings/stage/data/package-use.html create mode 100644 apidocs/com/threerings/stage/package-frame.html create mode 100644 apidocs/com/threerings/stage/package-summary.html create mode 100644 apidocs/com/threerings/stage/package-tree.html create mode 100644 apidocs/com/threerings/stage/package-use.html create mode 100644 apidocs/com/threerings/stage/server/StageSceneManager.html create mode 100644 apidocs/com/threerings/stage/server/StageSceneProvider.html create mode 100644 apidocs/com/threerings/stage/server/StageServer.StageModule.html create mode 100644 apidocs/com/threerings/stage/server/StageServer.html create mode 100644 apidocs/com/threerings/stage/server/class-use/StageSceneManager.html create mode 100644 apidocs/com/threerings/stage/server/class-use/StageSceneProvider.html create mode 100644 apidocs/com/threerings/stage/server/class-use/StageServer.StageModule.html create mode 100644 apidocs/com/threerings/stage/server/class-use/StageServer.html create mode 100644 apidocs/com/threerings/stage/server/package-frame.html create mode 100644 apidocs/com/threerings/stage/server/package-summary.html create mode 100644 apidocs/com/threerings/stage/server/package-tree.html create mode 100644 apidocs/com/threerings/stage/server/package-use.html create mode 100644 apidocs/com/threerings/stage/tools/editor/DirectionButton.html create mode 100644 apidocs/com/threerings/stage/tools/editor/EditorApp.html create mode 100644 apidocs/com/threerings/stage/tools/editor/EditorConfig.html create mode 100644 apidocs/com/threerings/stage/tools/editor/EditorDialog.html create mode 100644 apidocs/com/threerings/stage/tools/editor/EditorFrame.html create mode 100644 apidocs/com/threerings/stage/tools/editor/EditorModel.html create mode 100644 apidocs/com/threerings/stage/tools/editor/EditorModelListener.html create mode 100644 apidocs/com/threerings/stage/tools/editor/EditorScenePanel.SceneModelListener.html create mode 100644 apidocs/com/threerings/stage/tools/editor/EditorScenePanel.html create mode 100644 apidocs/com/threerings/stage/tools/editor/EditorScrollBox.html create mode 100644 apidocs/com/threerings/stage/tools/editor/EditorTileManager.html create mode 100644 apidocs/com/threerings/stage/tools/editor/EditorToolBarPanel.html create mode 100644 apidocs/com/threerings/stage/tools/editor/ObjectEditorDialog.html create mode 100644 apidocs/com/threerings/stage/tools/editor/PortalDialog.html create mode 100644 apidocs/com/threerings/stage/tools/editor/PortalTool.html create mode 100644 apidocs/com/threerings/stage/tools/editor/PreferencesDialog.html create mode 100644 apidocs/com/threerings/stage/tools/editor/SceneInfoPanel.html create mode 100644 apidocs/com/threerings/stage/tools/editor/TestTileLoader.html create mode 100644 apidocs/com/threerings/stage/tools/editor/TileInfoPanel.html create mode 100644 apidocs/com/threerings/stage/tools/editor/class-use/DirectionButton.html create mode 100644 apidocs/com/threerings/stage/tools/editor/class-use/EditorApp.html create mode 100644 apidocs/com/threerings/stage/tools/editor/class-use/EditorConfig.html create mode 100644 apidocs/com/threerings/stage/tools/editor/class-use/EditorDialog.html create mode 100644 apidocs/com/threerings/stage/tools/editor/class-use/EditorFrame.html create mode 100644 apidocs/com/threerings/stage/tools/editor/class-use/EditorModel.html create mode 100644 apidocs/com/threerings/stage/tools/editor/class-use/EditorModelListener.html create mode 100644 apidocs/com/threerings/stage/tools/editor/class-use/EditorScenePanel.SceneModelListener.html create mode 100644 apidocs/com/threerings/stage/tools/editor/class-use/EditorScenePanel.html create mode 100644 apidocs/com/threerings/stage/tools/editor/class-use/EditorScrollBox.html create mode 100644 apidocs/com/threerings/stage/tools/editor/class-use/EditorTileManager.html create mode 100644 apidocs/com/threerings/stage/tools/editor/class-use/EditorToolBarPanel.html create mode 100644 apidocs/com/threerings/stage/tools/editor/class-use/ObjectEditorDialog.html create mode 100644 apidocs/com/threerings/stage/tools/editor/class-use/PortalDialog.html create mode 100644 apidocs/com/threerings/stage/tools/editor/class-use/PortalTool.html create mode 100644 apidocs/com/threerings/stage/tools/editor/class-use/PreferencesDialog.html create mode 100644 apidocs/com/threerings/stage/tools/editor/class-use/SceneInfoPanel.html create mode 100644 apidocs/com/threerings/stage/tools/editor/class-use/TestTileLoader.html create mode 100644 apidocs/com/threerings/stage/tools/editor/class-use/TileInfoPanel.html create mode 100644 apidocs/com/threerings/stage/tools/editor/package-frame.html create mode 100644 apidocs/com/threerings/stage/tools/editor/package-summary.html create mode 100644 apidocs/com/threerings/stage/tools/editor/package-tree.html create mode 100644 apidocs/com/threerings/stage/tools/editor/package-use.html create mode 100644 apidocs/com/threerings/stage/tools/editor/util/EditorContext.html create mode 100644 apidocs/com/threerings/stage/tools/editor/util/EditorDialogUtil.html create mode 100644 apidocs/com/threerings/stage/tools/editor/util/ExtrasPainter.html create mode 100644 apidocs/com/threerings/stage/tools/editor/util/TileSetUtil.html create mode 100644 apidocs/com/threerings/stage/tools/editor/util/class-use/EditorContext.html create mode 100644 apidocs/com/threerings/stage/tools/editor/util/class-use/EditorDialogUtil.html create mode 100644 apidocs/com/threerings/stage/tools/editor/util/class-use/ExtrasPainter.html create mode 100644 apidocs/com/threerings/stage/tools/editor/util/class-use/TileSetUtil.html create mode 100644 apidocs/com/threerings/stage/tools/editor/util/package-frame.html create mode 100644 apidocs/com/threerings/stage/tools/editor/util/package-summary.html create mode 100644 apidocs/com/threerings/stage/tools/editor/util/package-tree.html create mode 100644 apidocs/com/threerings/stage/tools/editor/util/package-use.html create mode 100644 apidocs/com/threerings/stage/tools/viewer/ViewerApp.html create mode 100644 apidocs/com/threerings/stage/tools/viewer/ViewerFrame.html create mode 100644 apidocs/com/threerings/stage/tools/viewer/ViewerScenePanel.html create mode 100644 apidocs/com/threerings/stage/tools/viewer/class-use/ViewerApp.html create mode 100644 apidocs/com/threerings/stage/tools/viewer/class-use/ViewerFrame.html create mode 100644 apidocs/com/threerings/stage/tools/viewer/class-use/ViewerScenePanel.html create mode 100644 apidocs/com/threerings/stage/tools/viewer/package-frame.html create mode 100644 apidocs/com/threerings/stage/tools/viewer/package-summary.html create mode 100644 apidocs/com/threerings/stage/tools/viewer/package-tree.html create mode 100644 apidocs/com/threerings/stage/tools/viewer/package-use.html create mode 100644 apidocs/com/threerings/stage/tools/xml/StageMisoSceneRuleSet.html create mode 100644 apidocs/com/threerings/stage/tools/xml/StageSceneParser.html create mode 100644 apidocs/com/threerings/stage/tools/xml/StageSceneRuleSet.html create mode 100644 apidocs/com/threerings/stage/tools/xml/StageSceneWriter.html create mode 100644 apidocs/com/threerings/stage/tools/xml/class-use/StageMisoSceneRuleSet.html create mode 100644 apidocs/com/threerings/stage/tools/xml/class-use/StageSceneParser.html create mode 100644 apidocs/com/threerings/stage/tools/xml/class-use/StageSceneRuleSet.html create mode 100644 apidocs/com/threerings/stage/tools/xml/class-use/StageSceneWriter.html create mode 100644 apidocs/com/threerings/stage/tools/xml/package-frame.html create mode 100644 apidocs/com/threerings/stage/tools/xml/package-summary.html create mode 100644 apidocs/com/threerings/stage/tools/xml/package-tree.html create mode 100644 apidocs/com/threerings/stage/tools/xml/package-use.html create mode 100644 apidocs/com/threerings/stage/util/PlacementConstraints.html create mode 100644 apidocs/com/threerings/stage/util/StageContext.html create mode 100644 apidocs/com/threerings/stage/util/StageSceneUtil.html create mode 100644 apidocs/com/threerings/stage/util/class-use/PlacementConstraints.html create mode 100644 apidocs/com/threerings/stage/util/class-use/StageContext.html create mode 100644 apidocs/com/threerings/stage/util/class-use/StageSceneUtil.html create mode 100644 apidocs/com/threerings/stage/util/package-frame.html create mode 100644 apidocs/com/threerings/stage/util/package-summary.html create mode 100644 apidocs/com/threerings/stage/util/package-tree.html create mode 100644 apidocs/com/threerings/stage/util/package-use.html create mode 100644 apidocs/com/threerings/stats/Log.html create mode 100644 apidocs/com/threerings/stats/class-use/Log.html create mode 100644 apidocs/com/threerings/stats/data/ByteByteStringMapStat.html create mode 100644 apidocs/com/threerings/stats/data/ByteStringSetStat.html create mode 100644 apidocs/com/threerings/stats/data/IntArrayStat.html create mode 100644 apidocs/com/threerings/stats/data/IntSetStat.html create mode 100644 apidocs/com/threerings/stats/data/IntSetStatAdder.html create mode 100644 apidocs/com/threerings/stats/data/IntStat.html create mode 100644 apidocs/com/threerings/stats/data/IntStatIncrementer.html create mode 100644 apidocs/com/threerings/stats/data/IntStatMinimumer.html create mode 100644 apidocs/com/threerings/stats/data/IntStringSetStat.html create mode 100644 apidocs/com/threerings/stats/data/MaxIntStat.html create mode 100644 apidocs/com/threerings/stats/data/MaxValueIntStat.html create mode 100644 apidocs/com/threerings/stats/data/SetStat.html create mode 100644 apidocs/com/threerings/stats/data/ShortStringSetStat.html create mode 100644 apidocs/com/threerings/stats/data/Stat.AuxDataSource.html create mode 100644 apidocs/com/threerings/stats/data/Stat.Type.html create mode 100644 apidocs/com/threerings/stats/data/Stat.html create mode 100644 apidocs/com/threerings/stats/data/StatModifier.html create mode 100644 apidocs/com/threerings/stats/data/StatSet.Container.html create mode 100644 apidocs/com/threerings/stats/data/StatSet.html create mode 100644 apidocs/com/threerings/stats/data/StringMapStat.html create mode 100644 apidocs/com/threerings/stats/data/StringSetStat.html create mode 100644 apidocs/com/threerings/stats/data/class-use/ByteByteStringMapStat.html create mode 100644 apidocs/com/threerings/stats/data/class-use/ByteStringSetStat.html create mode 100644 apidocs/com/threerings/stats/data/class-use/IntArrayStat.html create mode 100644 apidocs/com/threerings/stats/data/class-use/IntSetStat.html create mode 100644 apidocs/com/threerings/stats/data/class-use/IntSetStatAdder.html create mode 100644 apidocs/com/threerings/stats/data/class-use/IntStat.html create mode 100644 apidocs/com/threerings/stats/data/class-use/IntStatIncrementer.html create mode 100644 apidocs/com/threerings/stats/data/class-use/IntStatMinimumer.html create mode 100644 apidocs/com/threerings/stats/data/class-use/IntStringSetStat.html create mode 100644 apidocs/com/threerings/stats/data/class-use/MaxIntStat.html create mode 100644 apidocs/com/threerings/stats/data/class-use/MaxValueIntStat.html create mode 100644 apidocs/com/threerings/stats/data/class-use/SetStat.html create mode 100644 apidocs/com/threerings/stats/data/class-use/ShortStringSetStat.html create mode 100644 apidocs/com/threerings/stats/data/class-use/Stat.AuxDataSource.html create mode 100644 apidocs/com/threerings/stats/data/class-use/Stat.Type.html create mode 100644 apidocs/com/threerings/stats/data/class-use/Stat.html create mode 100644 apidocs/com/threerings/stats/data/class-use/StatModifier.html create mode 100644 apidocs/com/threerings/stats/data/class-use/StatSet.Container.html create mode 100644 apidocs/com/threerings/stats/data/class-use/StatSet.html create mode 100644 apidocs/com/threerings/stats/data/class-use/StringMapStat.html create mode 100644 apidocs/com/threerings/stats/data/class-use/StringSetStat.html create mode 100644 apidocs/com/threerings/stats/data/package-frame.html create mode 100644 apidocs/com/threerings/stats/data/package-summary.html create mode 100644 apidocs/com/threerings/stats/data/package-tree.html create mode 100644 apidocs/com/threerings/stats/data/package-use.html create mode 100644 apidocs/com/threerings/stats/package-frame.html create mode 100644 apidocs/com/threerings/stats/package-summary.html create mode 100644 apidocs/com/threerings/stats/package-tree.html create mode 100644 apidocs/com/threerings/stats/package-use.html create mode 100644 apidocs/com/threerings/stats/server/persist/MaxStatCodeRecord.html create mode 100644 apidocs/com/threerings/stats/server/persist/StatRecord.html create mode 100644 apidocs/com/threerings/stats/server/persist/StatRepository.html create mode 100644 apidocs/com/threerings/stats/server/persist/StringCodeRecord.html create mode 100644 apidocs/com/threerings/stats/server/persist/class-use/MaxStatCodeRecord.html create mode 100644 apidocs/com/threerings/stats/server/persist/class-use/StatRecord.html create mode 100644 apidocs/com/threerings/stats/server/persist/class-use/StatRepository.html create mode 100644 apidocs/com/threerings/stats/server/persist/class-use/StringCodeRecord.html create mode 100644 apidocs/com/threerings/stats/server/persist/package-frame.html create mode 100644 apidocs/com/threerings/stats/server/persist/package-summary.html create mode 100644 apidocs/com/threerings/stats/server/persist/package-tree.html create mode 100644 apidocs/com/threerings/stats/server/persist/package-use.html create mode 100644 apidocs/com/threerings/whirled/Log.html create mode 100644 apidocs/com/threerings/whirled/class-use/Log.html create mode 100644 apidocs/com/threerings/whirled/client/SceneController.html create mode 100644 apidocs/com/threerings/whirled/client/SceneDecoder.html create mode 100644 apidocs/com/threerings/whirled/client/SceneDirector.MoveHandler.html create mode 100644 apidocs/com/threerings/whirled/client/SceneDirector.html create mode 100644 apidocs/com/threerings/whirled/client/SceneMoveAdapter.html create mode 100644 apidocs/com/threerings/whirled/client/SceneReceiver.html create mode 100644 apidocs/com/threerings/whirled/client/SceneService.SceneMoveListener.html create mode 100644 apidocs/com/threerings/whirled/client/SceneService.html create mode 100644 apidocs/com/threerings/whirled/client/class-use/SceneController.html create mode 100644 apidocs/com/threerings/whirled/client/class-use/SceneDecoder.html create mode 100644 apidocs/com/threerings/whirled/client/class-use/SceneDirector.MoveHandler.html create mode 100644 apidocs/com/threerings/whirled/client/class-use/SceneDirector.html create mode 100644 apidocs/com/threerings/whirled/client/class-use/SceneMoveAdapter.html create mode 100644 apidocs/com/threerings/whirled/client/class-use/SceneReceiver.html create mode 100644 apidocs/com/threerings/whirled/client/class-use/SceneService.SceneMoveListener.html create mode 100644 apidocs/com/threerings/whirled/client/class-use/SceneService.html create mode 100644 apidocs/com/threerings/whirled/client/package-frame.html create mode 100644 apidocs/com/threerings/whirled/client/package-summary.html create mode 100644 apidocs/com/threerings/whirled/client/package-tree.html create mode 100644 apidocs/com/threerings/whirled/client/package-use.html create mode 100644 apidocs/com/threerings/whirled/client/persist/SceneRepository.html create mode 100644 apidocs/com/threerings/whirled/client/persist/class-use/SceneRepository.html create mode 100644 apidocs/com/threerings/whirled/client/persist/package-frame.html create mode 100644 apidocs/com/threerings/whirled/client/persist/package-summary.html create mode 100644 apidocs/com/threerings/whirled/client/persist/package-tree.html create mode 100644 apidocs/com/threerings/whirled/client/persist/package-use.html create mode 100644 apidocs/com/threerings/whirled/data/AuxModel.html create mode 100644 apidocs/com/threerings/whirled/data/DefaultSceneConfig.html create mode 100644 apidocs/com/threerings/whirled/data/Scene.html create mode 100644 apidocs/com/threerings/whirled/data/SceneCodes.html create mode 100644 apidocs/com/threerings/whirled/data/SceneImpl.html create mode 100644 apidocs/com/threerings/whirled/data/SceneMarshaller.SceneMoveMarshaller.html create mode 100644 apidocs/com/threerings/whirled/data/SceneMarshaller.html create mode 100644 apidocs/com/threerings/whirled/data/SceneModel.html create mode 100644 apidocs/com/threerings/whirled/data/SceneObject.html create mode 100644 apidocs/com/threerings/whirled/data/ScenePlace.html create mode 100644 apidocs/com/threerings/whirled/data/SceneUpdate.html create mode 100644 apidocs/com/threerings/whirled/data/class-use/AuxModel.html create mode 100644 apidocs/com/threerings/whirled/data/class-use/DefaultSceneConfig.html create mode 100644 apidocs/com/threerings/whirled/data/class-use/Scene.html create mode 100644 apidocs/com/threerings/whirled/data/class-use/SceneCodes.html create mode 100644 apidocs/com/threerings/whirled/data/class-use/SceneImpl.html create mode 100644 apidocs/com/threerings/whirled/data/class-use/SceneMarshaller.SceneMoveMarshaller.html create mode 100644 apidocs/com/threerings/whirled/data/class-use/SceneMarshaller.html create mode 100644 apidocs/com/threerings/whirled/data/class-use/SceneModel.html create mode 100644 apidocs/com/threerings/whirled/data/class-use/SceneObject.html create mode 100644 apidocs/com/threerings/whirled/data/class-use/ScenePlace.html create mode 100644 apidocs/com/threerings/whirled/data/class-use/SceneUpdate.html create mode 100644 apidocs/com/threerings/whirled/data/package-frame.html create mode 100644 apidocs/com/threerings/whirled/data/package-summary.html create mode 100644 apidocs/com/threerings/whirled/data/package-tree.html create mode 100644 apidocs/com/threerings/whirled/data/package-use.html create mode 100644 apidocs/com/threerings/whirled/package-frame.html create mode 100644 apidocs/com/threerings/whirled/package-summary.html create mode 100644 apidocs/com/threerings/whirled/package-tree.html create mode 100644 apidocs/com/threerings/whirled/package-use.html create mode 100644 apidocs/com/threerings/whirled/server/AbstractSceneMoveHandler.html create mode 100644 apidocs/com/threerings/whirled/server/SceneManager.html create mode 100644 apidocs/com/threerings/whirled/server/SceneMoveHandler.html create mode 100644 apidocs/com/threerings/whirled/server/SceneProvider.html create mode 100644 apidocs/com/threerings/whirled/server/SceneRegistry.ConfigFactory.html create mode 100644 apidocs/com/threerings/whirled/server/SceneRegistry.ResolutionListener.html create mode 100644 apidocs/com/threerings/whirled/server/SceneRegistry.html create mode 100644 apidocs/com/threerings/whirled/server/SceneSender.html create mode 100644 apidocs/com/threerings/whirled/server/WhirledServer.WhirledModule.html create mode 100644 apidocs/com/threerings/whirled/server/WhirledServer.html create mode 100644 apidocs/com/threerings/whirled/server/WhirledSession.html create mode 100644 apidocs/com/threerings/whirled/server/class-use/AbstractSceneMoveHandler.html create mode 100644 apidocs/com/threerings/whirled/server/class-use/SceneManager.html create mode 100644 apidocs/com/threerings/whirled/server/class-use/SceneMoveHandler.html create mode 100644 apidocs/com/threerings/whirled/server/class-use/SceneProvider.html create mode 100644 apidocs/com/threerings/whirled/server/class-use/SceneRegistry.ConfigFactory.html create mode 100644 apidocs/com/threerings/whirled/server/class-use/SceneRegistry.ResolutionListener.html create mode 100644 apidocs/com/threerings/whirled/server/class-use/SceneRegistry.html create mode 100644 apidocs/com/threerings/whirled/server/class-use/SceneSender.html create mode 100644 apidocs/com/threerings/whirled/server/class-use/WhirledServer.WhirledModule.html create mode 100644 apidocs/com/threerings/whirled/server/class-use/WhirledServer.html create mode 100644 apidocs/com/threerings/whirled/server/class-use/WhirledSession.html create mode 100644 apidocs/com/threerings/whirled/server/package-frame.html create mode 100644 apidocs/com/threerings/whirled/server/package-summary.html create mode 100644 apidocs/com/threerings/whirled/server/package-tree.html create mode 100644 apidocs/com/threerings/whirled/server/package-use.html create mode 100644 apidocs/com/threerings/whirled/server/persist/DummySceneRepository.html create mode 100644 apidocs/com/threerings/whirled/server/persist/SceneRepository.html create mode 100644 apidocs/com/threerings/whirled/server/persist/SceneUpdateMarshaller.html create mode 100644 apidocs/com/threerings/whirled/server/persist/class-use/DummySceneRepository.html create mode 100644 apidocs/com/threerings/whirled/server/persist/class-use/SceneRepository.html create mode 100644 apidocs/com/threerings/whirled/server/persist/class-use/SceneUpdateMarshaller.html create mode 100644 apidocs/com/threerings/whirled/server/persist/package-frame.html create mode 100644 apidocs/com/threerings/whirled/server/persist/package-summary.html create mode 100644 apidocs/com/threerings/whirled/server/persist/package-tree.html create mode 100644 apidocs/com/threerings/whirled/server/persist/package-use.html create mode 100644 apidocs/com/threerings/whirled/spot/Log.html create mode 100644 apidocs/com/threerings/whirled/spot/class-use/Log.html create mode 100644 apidocs/com/threerings/whirled/spot/client/SpotSceneController.html create mode 100644 apidocs/com/threerings/whirled/spot/client/SpotSceneDirector.html create mode 100644 apidocs/com/threerings/whirled/spot/client/SpotService.SpotSceneMoveListener.html create mode 100644 apidocs/com/threerings/whirled/spot/client/SpotService.html create mode 100644 apidocs/com/threerings/whirled/spot/client/class-use/SpotSceneController.html create mode 100644 apidocs/com/threerings/whirled/spot/client/class-use/SpotSceneDirector.html create mode 100644 apidocs/com/threerings/whirled/spot/client/class-use/SpotService.SpotSceneMoveListener.html create mode 100644 apidocs/com/threerings/whirled/spot/client/class-use/SpotService.html create mode 100644 apidocs/com/threerings/whirled/spot/client/package-frame.html create mode 100644 apidocs/com/threerings/whirled/spot/client/package-summary.html create mode 100644 apidocs/com/threerings/whirled/spot/client/package-tree.html create mode 100644 apidocs/com/threerings/whirled/spot/client/package-use.html create mode 100644 apidocs/com/threerings/whirled/spot/data/Cluster.html create mode 100644 apidocs/com/threerings/whirled/spot/data/ClusterObject.html create mode 100644 apidocs/com/threerings/whirled/spot/data/ClusteredBodyObject.html create mode 100644 apidocs/com/threerings/whirled/spot/data/Location.html create mode 100644 apidocs/com/threerings/whirled/spot/data/ModifyPortalsUpdate.html create mode 100644 apidocs/com/threerings/whirled/spot/data/Portal.html create mode 100644 apidocs/com/threerings/whirled/spot/data/SceneLocation.html create mode 100644 apidocs/com/threerings/whirled/spot/data/SpotCodes.html create mode 100644 apidocs/com/threerings/whirled/spot/data/SpotMarshaller.SpotSceneMoveMarshaller.html create mode 100644 apidocs/com/threerings/whirled/spot/data/SpotMarshaller.html create mode 100644 apidocs/com/threerings/whirled/spot/data/SpotScene.html create mode 100644 apidocs/com/threerings/whirled/spot/data/SpotSceneImpl.html create mode 100644 apidocs/com/threerings/whirled/spot/data/SpotSceneModel.html create mode 100644 apidocs/com/threerings/whirled/spot/data/SpotSceneObject.html create mode 100644 apidocs/com/threerings/whirled/spot/data/class-use/Cluster.html create mode 100644 apidocs/com/threerings/whirled/spot/data/class-use/ClusterObject.html create mode 100644 apidocs/com/threerings/whirled/spot/data/class-use/ClusteredBodyObject.html create mode 100644 apidocs/com/threerings/whirled/spot/data/class-use/Location.html create mode 100644 apidocs/com/threerings/whirled/spot/data/class-use/ModifyPortalsUpdate.html create mode 100644 apidocs/com/threerings/whirled/spot/data/class-use/Portal.html create mode 100644 apidocs/com/threerings/whirled/spot/data/class-use/SceneLocation.html create mode 100644 apidocs/com/threerings/whirled/spot/data/class-use/SpotCodes.html create mode 100644 apidocs/com/threerings/whirled/spot/data/class-use/SpotMarshaller.SpotSceneMoveMarshaller.html create mode 100644 apidocs/com/threerings/whirled/spot/data/class-use/SpotMarshaller.html create mode 100644 apidocs/com/threerings/whirled/spot/data/class-use/SpotScene.html create mode 100644 apidocs/com/threerings/whirled/spot/data/class-use/SpotSceneImpl.html create mode 100644 apidocs/com/threerings/whirled/spot/data/class-use/SpotSceneModel.html create mode 100644 apidocs/com/threerings/whirled/spot/data/class-use/SpotSceneObject.html create mode 100644 apidocs/com/threerings/whirled/spot/data/package-frame.html create mode 100644 apidocs/com/threerings/whirled/spot/data/package-summary.html create mode 100644 apidocs/com/threerings/whirled/spot/data/package-tree.html create mode 100644 apidocs/com/threerings/whirled/spot/data/package-use.html create mode 100644 apidocs/com/threerings/whirled/spot/package-frame.html create mode 100644 apidocs/com/threerings/whirled/spot/package-summary.html create mode 100644 apidocs/com/threerings/whirled/spot/package-tree.html create mode 100644 apidocs/com/threerings/whirled/spot/package-use.html create mode 100644 apidocs/com/threerings/whirled/spot/server/SpotClient.html create mode 100644 apidocs/com/threerings/whirled/spot/server/SpotProvider.html create mode 100644 apidocs/com/threerings/whirled/spot/server/SpotSceneManager.html create mode 100644 apidocs/com/threerings/whirled/spot/server/SpotSceneMoveHandler.html create mode 100644 apidocs/com/threerings/whirled/spot/server/SpotSceneRegistry.html create mode 100644 apidocs/com/threerings/whirled/spot/server/class-use/SpotClient.html create mode 100644 apidocs/com/threerings/whirled/spot/server/class-use/SpotProvider.html create mode 100644 apidocs/com/threerings/whirled/spot/server/class-use/SpotSceneManager.html create mode 100644 apidocs/com/threerings/whirled/spot/server/class-use/SpotSceneMoveHandler.html create mode 100644 apidocs/com/threerings/whirled/spot/server/class-use/SpotSceneRegistry.html create mode 100644 apidocs/com/threerings/whirled/spot/server/package-frame.html create mode 100644 apidocs/com/threerings/whirled/spot/server/package-summary.html create mode 100644 apidocs/com/threerings/whirled/spot/server/package-tree.html create mode 100644 apidocs/com/threerings/whirled/spot/server/package-use.html create mode 100644 apidocs/com/threerings/whirled/spot/tools/EditablePortal.html create mode 100644 apidocs/com/threerings/whirled/spot/tools/class-use/EditablePortal.html create mode 100644 apidocs/com/threerings/whirled/spot/tools/package-frame.html create mode 100644 apidocs/com/threerings/whirled/spot/tools/package-summary.html create mode 100644 apidocs/com/threerings/whirled/spot/tools/package-tree.html create mode 100644 apidocs/com/threerings/whirled/spot/tools/package-use.html create mode 100644 apidocs/com/threerings/whirled/spot/tools/xml/SpotSceneRuleSet.html create mode 100644 apidocs/com/threerings/whirled/spot/tools/xml/SpotSceneWriter.html create mode 100644 apidocs/com/threerings/whirled/spot/tools/xml/class-use/SpotSceneRuleSet.html create mode 100644 apidocs/com/threerings/whirled/spot/tools/xml/class-use/SpotSceneWriter.html create mode 100644 apidocs/com/threerings/whirled/spot/tools/xml/package-frame.html create mode 100644 apidocs/com/threerings/whirled/spot/tools/xml/package-summary.html create mode 100644 apidocs/com/threerings/whirled/spot/tools/xml/package-tree.html create mode 100644 apidocs/com/threerings/whirled/spot/tools/xml/package-use.html create mode 100644 apidocs/com/threerings/whirled/tools/xml/SceneParser.html create mode 100644 apidocs/com/threerings/whirled/tools/xml/SceneRuleSet.html create mode 100644 apidocs/com/threerings/whirled/tools/xml/SceneWriter.html create mode 100644 apidocs/com/threerings/whirled/tools/xml/class-use/SceneParser.html create mode 100644 apidocs/com/threerings/whirled/tools/xml/class-use/SceneRuleSet.html create mode 100644 apidocs/com/threerings/whirled/tools/xml/class-use/SceneWriter.html create mode 100644 apidocs/com/threerings/whirled/tools/xml/package-frame.html create mode 100644 apidocs/com/threerings/whirled/tools/xml/package-summary.html create mode 100644 apidocs/com/threerings/whirled/tools/xml/package-tree.html create mode 100644 apidocs/com/threerings/whirled/tools/xml/package-use.html create mode 100644 apidocs/com/threerings/whirled/util/NoSuchSceneException.html create mode 100644 apidocs/com/threerings/whirled/util/SceneFactory.html create mode 100644 apidocs/com/threerings/whirled/util/UpdateList.html create mode 100644 apidocs/com/threerings/whirled/util/WhirledContext.html create mode 100644 apidocs/com/threerings/whirled/util/class-use/NoSuchSceneException.html create mode 100644 apidocs/com/threerings/whirled/util/class-use/SceneFactory.html create mode 100644 apidocs/com/threerings/whirled/util/class-use/UpdateList.html create mode 100644 apidocs/com/threerings/whirled/util/class-use/WhirledContext.html create mode 100644 apidocs/com/threerings/whirled/util/package-frame.html create mode 100644 apidocs/com/threerings/whirled/util/package-summary.html create mode 100644 apidocs/com/threerings/whirled/util/package-tree.html create mode 100644 apidocs/com/threerings/whirled/util/package-use.html create mode 100644 apidocs/com/threerings/whirled/zone/Log.html create mode 100644 apidocs/com/threerings/whirled/zone/class-use/Log.html create mode 100644 apidocs/com/threerings/whirled/zone/client/ZoneAdapter.html create mode 100644 apidocs/com/threerings/whirled/zone/client/ZoneDecoder.html create mode 100644 apidocs/com/threerings/whirled/zone/client/ZoneDirector.html create mode 100644 apidocs/com/threerings/whirled/zone/client/ZoneObserver.html create mode 100644 apidocs/com/threerings/whirled/zone/client/ZoneReceiver.html create mode 100644 apidocs/com/threerings/whirled/zone/client/ZoneService.ZoneMoveListener.html create mode 100644 apidocs/com/threerings/whirled/zone/client/ZoneService.html create mode 100644 apidocs/com/threerings/whirled/zone/client/class-use/ZoneAdapter.html create mode 100644 apidocs/com/threerings/whirled/zone/client/class-use/ZoneDecoder.html create mode 100644 apidocs/com/threerings/whirled/zone/client/class-use/ZoneDirector.html create mode 100644 apidocs/com/threerings/whirled/zone/client/class-use/ZoneObserver.html create mode 100644 apidocs/com/threerings/whirled/zone/client/class-use/ZoneReceiver.html create mode 100644 apidocs/com/threerings/whirled/zone/client/class-use/ZoneService.ZoneMoveListener.html create mode 100644 apidocs/com/threerings/whirled/zone/client/class-use/ZoneService.html create mode 100644 apidocs/com/threerings/whirled/zone/client/package-frame.html create mode 100644 apidocs/com/threerings/whirled/zone/client/package-summary.html create mode 100644 apidocs/com/threerings/whirled/zone/client/package-tree.html create mode 100644 apidocs/com/threerings/whirled/zone/client/package-use.html create mode 100644 apidocs/com/threerings/whirled/zone/data/SceneSummary.html create mode 100644 apidocs/com/threerings/whirled/zone/data/ZoneCodes.html create mode 100644 apidocs/com/threerings/whirled/zone/data/ZoneMarshaller.ZoneMoveMarshaller.html create mode 100644 apidocs/com/threerings/whirled/zone/data/ZoneMarshaller.html create mode 100644 apidocs/com/threerings/whirled/zone/data/ZoneSummary.html create mode 100644 apidocs/com/threerings/whirled/zone/data/ZonedBodyObject.html create mode 100644 apidocs/com/threerings/whirled/zone/data/class-use/SceneSummary.html create mode 100644 apidocs/com/threerings/whirled/zone/data/class-use/ZoneCodes.html create mode 100644 apidocs/com/threerings/whirled/zone/data/class-use/ZoneMarshaller.ZoneMoveMarshaller.html create mode 100644 apidocs/com/threerings/whirled/zone/data/class-use/ZoneMarshaller.html create mode 100644 apidocs/com/threerings/whirled/zone/data/class-use/ZoneSummary.html create mode 100644 apidocs/com/threerings/whirled/zone/data/class-use/ZonedBodyObject.html create mode 100644 apidocs/com/threerings/whirled/zone/data/package-frame.html create mode 100644 apidocs/com/threerings/whirled/zone/data/package-summary.html create mode 100644 apidocs/com/threerings/whirled/zone/data/package-tree.html create mode 100644 apidocs/com/threerings/whirled/zone/data/package-use.html create mode 100644 apidocs/com/threerings/whirled/zone/package-frame.html create mode 100644 apidocs/com/threerings/whirled/zone/package-summary.html create mode 100644 apidocs/com/threerings/whirled/zone/package-tree.html create mode 100644 apidocs/com/threerings/whirled/zone/package-use.html create mode 100644 apidocs/com/threerings/whirled/zone/peer/data/HostedZone.html create mode 100644 apidocs/com/threerings/whirled/zone/peer/data/class-use/HostedZone.html create mode 100644 apidocs/com/threerings/whirled/zone/peer/data/package-frame.html create mode 100644 apidocs/com/threerings/whirled/zone/peer/data/package-summary.html create mode 100644 apidocs/com/threerings/whirled/zone/peer/data/package-tree.html create mode 100644 apidocs/com/threerings/whirled/zone/peer/data/package-use.html create mode 100644 apidocs/com/threerings/whirled/zone/peer/server/PeeredZoneManager.html create mode 100644 apidocs/com/threerings/whirled/zone/peer/server/PeeredZoneRegistry.PeerZoneMoveHandler.html create mode 100644 apidocs/com/threerings/whirled/zone/peer/server/PeeredZoneRegistry.PeerZoneResolutionListener.html create mode 100644 apidocs/com/threerings/whirled/zone/peer/server/PeeredZoneRegistry.PeerZoneShutdownListener.html create mode 100644 apidocs/com/threerings/whirled/zone/peer/server/PeeredZoneRegistry.html create mode 100644 apidocs/com/threerings/whirled/zone/peer/server/ZoneNodeObject.html create mode 100644 apidocs/com/threerings/whirled/zone/peer/server/ZonePeerManager.NodeFunc.html create mode 100644 apidocs/com/threerings/whirled/zone/peer/server/ZonePeerManager.html create mode 100644 apidocs/com/threerings/whirled/zone/peer/server/class-use/PeeredZoneManager.html create mode 100644 apidocs/com/threerings/whirled/zone/peer/server/class-use/PeeredZoneRegistry.PeerZoneMoveHandler.html create mode 100644 apidocs/com/threerings/whirled/zone/peer/server/class-use/PeeredZoneRegistry.PeerZoneResolutionListener.html create mode 100644 apidocs/com/threerings/whirled/zone/peer/server/class-use/PeeredZoneRegistry.PeerZoneShutdownListener.html create mode 100644 apidocs/com/threerings/whirled/zone/peer/server/class-use/PeeredZoneRegistry.html create mode 100644 apidocs/com/threerings/whirled/zone/peer/server/class-use/ZoneNodeObject.html create mode 100644 apidocs/com/threerings/whirled/zone/peer/server/class-use/ZonePeerManager.NodeFunc.html create mode 100644 apidocs/com/threerings/whirled/zone/peer/server/class-use/ZonePeerManager.html create mode 100644 apidocs/com/threerings/whirled/zone/peer/server/package-frame.html create mode 100644 apidocs/com/threerings/whirled/zone/peer/server/package-summary.html create mode 100644 apidocs/com/threerings/whirled/zone/peer/server/package-tree.html create mode 100644 apidocs/com/threerings/whirled/zone/peer/server/package-use.html create mode 100644 apidocs/com/threerings/whirled/zone/server/ZoneManager.ResolutionListener.html create mode 100644 apidocs/com/threerings/whirled/zone/server/ZoneManager.html create mode 100644 apidocs/com/threerings/whirled/zone/server/ZoneMoveHandler.html create mode 100644 apidocs/com/threerings/whirled/zone/server/ZoneProvider.html create mode 100644 apidocs/com/threerings/whirled/zone/server/ZoneRegistry.html create mode 100644 apidocs/com/threerings/whirled/zone/server/ZoneSender.html create mode 100644 apidocs/com/threerings/whirled/zone/server/class-use/ZoneManager.ResolutionListener.html create mode 100644 apidocs/com/threerings/whirled/zone/server/class-use/ZoneManager.html create mode 100644 apidocs/com/threerings/whirled/zone/server/class-use/ZoneMoveHandler.html create mode 100644 apidocs/com/threerings/whirled/zone/server/class-use/ZoneProvider.html create mode 100644 apidocs/com/threerings/whirled/zone/server/class-use/ZoneRegistry.html create mode 100644 apidocs/com/threerings/whirled/zone/server/class-use/ZoneSender.html create mode 100644 apidocs/com/threerings/whirled/zone/server/package-frame.html create mode 100644 apidocs/com/threerings/whirled/zone/server/package-summary.html create mode 100644 apidocs/com/threerings/whirled/zone/server/package-tree.html create mode 100644 apidocs/com/threerings/whirled/zone/server/package-use.html create mode 100644 apidocs/com/threerings/whirled/zone/util/ZoneUtil.html create mode 100644 apidocs/com/threerings/whirled/zone/util/class-use/ZoneUtil.html create mode 100644 apidocs/com/threerings/whirled/zone/util/package-frame.html create mode 100644 apidocs/com/threerings/whirled/zone/util/package-summary.html create mode 100644 apidocs/com/threerings/whirled/zone/util/package-tree.html create mode 100644 apidocs/com/threerings/whirled/zone/util/package-use.html create mode 100644 apidocs/constant-values.html create mode 100644 apidocs/deprecated-list.html create mode 100644 apidocs/help-doc.html create mode 100644 apidocs/index-all.html create mode 100644 apidocs/index.html create mode 100644 apidocs/overview-frame.html create mode 100644 apidocs/overview-summary.html create mode 100644 apidocs/overview-tree.html create mode 100644 apidocs/package-list create mode 100644 apidocs/resources/inherit.gif create mode 100644 apidocs/serialized-form.html create mode 100644 apidocs/stylesheet.css diff --git a/apidocs/allclasses-frame.html b/apidocs/allclasses-frame.html new file mode 100644 index 00000000..efb457f3 --- /dev/null +++ b/apidocs/allclasses-frame.html @@ -0,0 +1,790 @@ + + + + + + + +All Classes (vilya 1.3 API) + + + + + + + + + + + +All Classes +
+ + + + + +
AbstractSceneMoveHandler +
+AuxModel +
+Board +
+BoardSummary +
+ByteByteStringMapStat +
+ByteStringSetStat +
+Card +
+CardCodes +
+CardGameController +
+CardGameDecoder +
+CardGameManager +
+CardGameObject +
+CardGameReceiver +
+CardGameSender +
+CardPanel +
+CardPanel.CardSelectionObserver +
+CardSprite +
+CardSpriteObserver +
+ChatPanel +
+ChoiceParameter +
+ClientController +
+Cluster +
+ClusteredBodyObject +
+ClusterObject +
+Deck +
+DefaultColorUpdate +
+DefaultSceneConfig +
+DefaultSwingTableConfigurator +
+DirectionButton +
+DropBlockSprite +
+DropBoard +
+DropBoard.PieceOperation +
+DropBoardSummary +
+DropBoardUtil +
+DropBoardView +
+DropCodes +
+DropConfig +
+DropControllerDelegate +
+DropGameUtil +
+DropLogic +
+DropManagerDelegate +
+DropPanel +
+DropPieceCodes +
+DropSprite +
+DropSpriteObserver +
+DummySceneRepository +
+EditablePortal +
+EditorApp +
+EditorConfig +
+EditorContext +
+EditorDialog +
+EditorDialogUtil +
+EditorFrame +
+EditorModel +
+EditorModelListener +
+EditorScenePanel +
+EditorScenePanel.SceneModelListener +
+EditorScrollBox +
+EditorTileManager +
+EditorToolBarPanel +
+EntryFee +
+ExtrasPainter +
+GameAI +
+GameCodes +
+GameConfig +
+GameConfigurator +
+GameController +
+GameControllerDelegate +
+GameManager +
+GameManagerDelegate +
+GameObject +
+GameReadyObserver +
+GameWatcher +
+Hand +
+HostedZone +
+IntArrayStat +
+IntSetStat +
+IntSetStatAdder +
+IntStat +
+IntStatIncrementer +
+IntStatMinimumer +
+IntStringSetStat +
+Invitation +
+InvitationHandler +
+InvitationResponseObserver +
+Lobby +
+LobbyConfig +
+LobbyController +
+LobbyManager +
+LobbyMarshaller +
+LobbyMarshaller.CategoriesMarshaller +
+LobbyMarshaller.LobbiesMarshaller +
+LobbyObject +
+LobbyPanel +
+LobbyProvider +
+LobbyRegistry +
+LobbySelector +
+LobbyService +
+LobbyService.CategoriesListener +
+LobbyService.LobbiesListener +
+Location +
+Log +
+Log +
+Log +
+Log +
+Log +
+Log +
+Log +
+Log +
+Log +
+LogonPanel +
+MaxIntStat +
+MaxStatCodeRecord +
+MaxValueIntStat +
+MiCasaApp +
+MiCasaApplet +
+MiCasaBootstrapData +
+MiCasaClient +
+MiCasaConfig +
+MiCasaContext +
+MiCasaFrame +
+MiCasaServer +
+MiCasaSession +
+MicroCardSprite +
+ModifyObjectsUpdate +
+ModifyPortalsUpdate +
+NextBlockView +
+NoSuchSceneException +
+ObjectEditorDialog +
+OccupantList +
+Parameter +
+ParlorCodes +
+ParlorContext +
+ParlorDecoder +
+ParlorDirector +
+ParlorManager +
+ParlorMarshaller +
+ParlorMarshaller.InviteMarshaller +
+ParlorProvider +
+ParlorReceiver +
+ParlorSender +
+ParlorService +
+ParlorService.InviteListener +
+Participant +
+PeeredZoneManager +
+PeeredZoneRegistry +
+PeeredZoneRegistry.PeerZoneMoveHandler +
+PeeredZoneRegistry.PeerZoneResolutionListener +
+PeeredZoneRegistry.PeerZoneShutdownListener +
+Percentiler +
+PercentileRecord +
+PieceDestroyer +
+PieceDestroyer.DestroyLogic +
+PieceDropLogic +
+PieceDropper +
+PieceDropper.DropObserver +
+PieceDropper.PieceDropInfo +
+PieceGroupAnimation +
+PlacementConstraints +
+PlayerCard +
+PlayerStatusView +
+PlayManager +
+PlayManagerDelegate +
+PointSet +
+Portal +
+PortalDialog +
+PortalTool +
+PreferencesDialog +
+Prize +
+PuzzleAnimationWaiter +
+PuzzleBoardView +
+PuzzleCodes +
+PuzzleContext +
+PuzzleController +
+PuzzleController.ClearPender +
+PuzzleControllerDelegate +
+PuzzleGameCodes +
+PuzzleGameMarshaller +
+PuzzleGameProvider +
+PuzzleGameService +
+PuzzleGameUtil +
+PuzzleManager +
+PuzzleManagerDelegate +
+PuzzleObject +
+PuzzlePanel +
+PuzzlePrefs +
+RangeParameter +
+Rating +
+RatingCodes +
+RatingDelegate +
+RatingRecord +
+RatingRepository +
+RobotPlayer +
+Scene +
+SceneCodes +
+SceneColorizer +
+SceneController +
+SceneDecoder +
+SceneDirector +
+SceneDirector.MoveHandler +
+SceneFactory +
+SceneImpl +
+SceneInfoPanel +
+SceneLocation +
+SceneManager +
+SceneMarshaller +
+SceneMarshaller.SceneMoveMarshaller +
+SceneModel +
+SceneMoveAdapter +
+SceneMoveHandler +
+SceneObject +
+SceneParser +
+ScenePlace +
+SceneProvider +
+SceneReceiver +
+SceneRegistry +
+SceneRegistry.ConfigFactory +
+SceneRegistry.ResolutionListener +
+SceneRepository +
+SceneRepository +
+SceneRuleSet +
+SceneSender +
+SceneService +
+SceneService.SceneMoveListener +
+SceneSummary +
+SceneUpdate +
+SceneUpdateMarshaller +
+SceneWriter +
+ScoreAnimation +
+SeatednessObserver +
+SegmentInfo +
+SetStat +
+ShortStringSetStat +
+SimpleClient +
+SimpleFrame +
+SimpleServer +
+Simulant +
+SimulatorApp +
+SimulatorClient +
+SimulatorContext +
+SimulatorController +
+SimulatorFrame +
+SimulatorInfo +
+SimulatorManager +
+SimulatorMarshaller +
+SimulatorProvider +
+SimulatorServer +
+SimulatorService +
+SpotClient +
+SpotCodes +
+SpotMarshaller +
+SpotMarshaller.SpotSceneMoveMarshaller +
+SpotProvider +
+SpotScene +
+SpotSceneController +
+SpotSceneDirector +
+SpotSceneImpl +
+SpotSceneManager +
+SpotSceneModel +
+SpotSceneMoveHandler +
+SpotSceneObject +
+SpotSceneRegistry +
+SpotSceneRuleSet +
+SpotSceneWriter +
+SpotService +
+SpotService.SpotSceneMoveListener +
+StageCodes +
+StageContext +
+StageLocation +
+StageMisoSceneModel +
+StageMisoSceneRuleSet +
+StageOccupantInfo +
+StageScene +
+StageSceneConfig +
+StageSceneController +
+StageSceneManager +
+StageSceneMarshaller +
+StageSceneModel +
+StageSceneObject +
+StageScenePanel +
+StageSceneParser +
+StageSceneProvider +
+StageSceneRuleSet +
+StageSceneService +
+StageSceneUtil +
+StageSceneWriter +
+StageServer +
+StageServer.StageModule +
+Stat +
+Stat.AuxDataSource +
+Stat.Type +
+StatModifier +
+StatRecord +
+StatRepository +
+StatSet +
+StatSet.Container +
+StringCodeRecord +
+StringMapStat +
+StringSetStat +
+SwingGameConfigurator +
+Table +
+TableConfig +
+TableConfigurator +
+TableDirector +
+TableItem +
+TableListView +
+TableLobbyConfig +
+TableLobbyManager +
+TableLobbyObject +
+TableLobbyObject +
+TableManager +
+TableMarshaller +
+TableObserver +
+TableProvider +
+TableService +
+TeamGameManager +
+TestTileLoader +
+TileInfoPanel +
+TileSetUtil +
+ToggleParameter +
+TourneyCodes +
+TourneyConfig +
+TourneyLogicData +
+TourneyManager +
+TourneyMarshaller +
+TourneyObject +
+TourneyProvider +
+TourneyRepository +
+TourneyRepository.TourneyRecord +
+TourneyService +
+TourniesManager +
+TourniesMarshaller +
+TourniesProvider +
+TourniesService +
+TrickCardCodes +
+TrickCardGameControllerDelegate +
+TrickCardGameManagerDelegate +
+TrickCardGameMarshaller +
+TrickCardGameObject +
+TrickCardGameProvider +
+TrickCardGameService +
+TrickCardGameUtil +
+TurnDisplay +
+TurnGameController +
+TurnGameControllerDelegate +
+TurnGameManager +
+TurnGameManagerDelegate +
+TurnGameObject +
+UpdateList +
+UserIdentifier +
+UserIdentifier.Ider +
+ViewerApp +
+ViewerFrame +
+ViewerScenePanel +
+WhirledContext +
+WhirledServer +
+WhirledServer.WhirledModule +
+WhirledSession +
+ZoneAdapter +
+ZoneCodes +
+ZonedBodyObject +
+ZoneDecoder +
+ZoneDirector +
+ZoneManager +
+ZoneManager.ResolutionListener +
+ZoneMarshaller +
+ZoneMarshaller.ZoneMoveMarshaller +
+ZoneMoveHandler +
+ZoneNodeObject +
+ZoneObserver +
+ZonePeerManager +
+ZonePeerManager.NodeFunc +
+ZoneProvider +
+ZoneReceiver +
+ZoneRegistry +
+ZoneSender +
+ZoneService +
+ZoneService.ZoneMoveListener +
+ZoneSummary +
+ZoneUtil +
+
+ + + diff --git a/apidocs/allclasses-noframe.html b/apidocs/allclasses-noframe.html new file mode 100644 index 00000000..e12ba076 --- /dev/null +++ b/apidocs/allclasses-noframe.html @@ -0,0 +1,790 @@ + + + + + + + +All Classes (vilya 1.3 API) + + + + + + + + + + + +All Classes +
+ + + + + +
AbstractSceneMoveHandler +
+AuxModel +
+Board +
+BoardSummary +
+ByteByteStringMapStat +
+ByteStringSetStat +
+Card +
+CardCodes +
+CardGameController +
+CardGameDecoder +
+CardGameManager +
+CardGameObject +
+CardGameReceiver +
+CardGameSender +
+CardPanel +
+CardPanel.CardSelectionObserver +
+CardSprite +
+CardSpriteObserver +
+ChatPanel +
+ChoiceParameter +
+ClientController +
+Cluster +
+ClusteredBodyObject +
+ClusterObject +
+Deck +
+DefaultColorUpdate +
+DefaultSceneConfig +
+DefaultSwingTableConfigurator +
+DirectionButton +
+DropBlockSprite +
+DropBoard +
+DropBoard.PieceOperation +
+DropBoardSummary +
+DropBoardUtil +
+DropBoardView +
+DropCodes +
+DropConfig +
+DropControllerDelegate +
+DropGameUtil +
+DropLogic +
+DropManagerDelegate +
+DropPanel +
+DropPieceCodes +
+DropSprite +
+DropSpriteObserver +
+DummySceneRepository +
+EditablePortal +
+EditorApp +
+EditorConfig +
+EditorContext +
+EditorDialog +
+EditorDialogUtil +
+EditorFrame +
+EditorModel +
+EditorModelListener +
+EditorScenePanel +
+EditorScenePanel.SceneModelListener +
+EditorScrollBox +
+EditorTileManager +
+EditorToolBarPanel +
+EntryFee +
+ExtrasPainter +
+GameAI +
+GameCodes +
+GameConfig +
+GameConfigurator +
+GameController +
+GameControllerDelegate +
+GameManager +
+GameManagerDelegate +
+GameObject +
+GameReadyObserver +
+GameWatcher +
+Hand +
+HostedZone +
+IntArrayStat +
+IntSetStat +
+IntSetStatAdder +
+IntStat +
+IntStatIncrementer +
+IntStatMinimumer +
+IntStringSetStat +
+Invitation +
+InvitationHandler +
+InvitationResponseObserver +
+Lobby +
+LobbyConfig +
+LobbyController +
+LobbyManager +
+LobbyMarshaller +
+LobbyMarshaller.CategoriesMarshaller +
+LobbyMarshaller.LobbiesMarshaller +
+LobbyObject +
+LobbyPanel +
+LobbyProvider +
+LobbyRegistry +
+LobbySelector +
+LobbyService +
+LobbyService.CategoriesListener +
+LobbyService.LobbiesListener +
+Location +
+Log +
+Log +
+Log +
+Log +
+Log +
+Log +
+Log +
+Log +
+Log +
+LogonPanel +
+MaxIntStat +
+MaxStatCodeRecord +
+MaxValueIntStat +
+MiCasaApp +
+MiCasaApplet +
+MiCasaBootstrapData +
+MiCasaClient +
+MiCasaConfig +
+MiCasaContext +
+MiCasaFrame +
+MiCasaServer +
+MiCasaSession +
+MicroCardSprite +
+ModifyObjectsUpdate +
+ModifyPortalsUpdate +
+NextBlockView +
+NoSuchSceneException +
+ObjectEditorDialog +
+OccupantList +
+Parameter +
+ParlorCodes +
+ParlorContext +
+ParlorDecoder +
+ParlorDirector +
+ParlorManager +
+ParlorMarshaller +
+ParlorMarshaller.InviteMarshaller +
+ParlorProvider +
+ParlorReceiver +
+ParlorSender +
+ParlorService +
+ParlorService.InviteListener +
+Participant +
+PeeredZoneManager +
+PeeredZoneRegistry +
+PeeredZoneRegistry.PeerZoneMoveHandler +
+PeeredZoneRegistry.PeerZoneResolutionListener +
+PeeredZoneRegistry.PeerZoneShutdownListener +
+Percentiler +
+PercentileRecord +
+PieceDestroyer +
+PieceDestroyer.DestroyLogic +
+PieceDropLogic +
+PieceDropper +
+PieceDropper.DropObserver +
+PieceDropper.PieceDropInfo +
+PieceGroupAnimation +
+PlacementConstraints +
+PlayerCard +
+PlayerStatusView +
+PlayManager +
+PlayManagerDelegate +
+PointSet +
+Portal +
+PortalDialog +
+PortalTool +
+PreferencesDialog +
+Prize +
+PuzzleAnimationWaiter +
+PuzzleBoardView +
+PuzzleCodes +
+PuzzleContext +
+PuzzleController +
+PuzzleController.ClearPender +
+PuzzleControllerDelegate +
+PuzzleGameCodes +
+PuzzleGameMarshaller +
+PuzzleGameProvider +
+PuzzleGameService +
+PuzzleGameUtil +
+PuzzleManager +
+PuzzleManagerDelegate +
+PuzzleObject +
+PuzzlePanel +
+PuzzlePrefs +
+RangeParameter +
+Rating +
+RatingCodes +
+RatingDelegate +
+RatingRecord +
+RatingRepository +
+RobotPlayer +
+Scene +
+SceneCodes +
+SceneColorizer +
+SceneController +
+SceneDecoder +
+SceneDirector +
+SceneDirector.MoveHandler +
+SceneFactory +
+SceneImpl +
+SceneInfoPanel +
+SceneLocation +
+SceneManager +
+SceneMarshaller +
+SceneMarshaller.SceneMoveMarshaller +
+SceneModel +
+SceneMoveAdapter +
+SceneMoveHandler +
+SceneObject +
+SceneParser +
+ScenePlace +
+SceneProvider +
+SceneReceiver +
+SceneRegistry +
+SceneRegistry.ConfigFactory +
+SceneRegistry.ResolutionListener +
+SceneRepository +
+SceneRepository +
+SceneRuleSet +
+SceneSender +
+SceneService +
+SceneService.SceneMoveListener +
+SceneSummary +
+SceneUpdate +
+SceneUpdateMarshaller +
+SceneWriter +
+ScoreAnimation +
+SeatednessObserver +
+SegmentInfo +
+SetStat +
+ShortStringSetStat +
+SimpleClient +
+SimpleFrame +
+SimpleServer +
+Simulant +
+SimulatorApp +
+SimulatorClient +
+SimulatorContext +
+SimulatorController +
+SimulatorFrame +
+SimulatorInfo +
+SimulatorManager +
+SimulatorMarshaller +
+SimulatorProvider +
+SimulatorServer +
+SimulatorService +
+SpotClient +
+SpotCodes +
+SpotMarshaller +
+SpotMarshaller.SpotSceneMoveMarshaller +
+SpotProvider +
+SpotScene +
+SpotSceneController +
+SpotSceneDirector +
+SpotSceneImpl +
+SpotSceneManager +
+SpotSceneModel +
+SpotSceneMoveHandler +
+SpotSceneObject +
+SpotSceneRegistry +
+SpotSceneRuleSet +
+SpotSceneWriter +
+SpotService +
+SpotService.SpotSceneMoveListener +
+StageCodes +
+StageContext +
+StageLocation +
+StageMisoSceneModel +
+StageMisoSceneRuleSet +
+StageOccupantInfo +
+StageScene +
+StageSceneConfig +
+StageSceneController +
+StageSceneManager +
+StageSceneMarshaller +
+StageSceneModel +
+StageSceneObject +
+StageScenePanel +
+StageSceneParser +
+StageSceneProvider +
+StageSceneRuleSet +
+StageSceneService +
+StageSceneUtil +
+StageSceneWriter +
+StageServer +
+StageServer.StageModule +
+Stat +
+Stat.AuxDataSource +
+Stat.Type +
+StatModifier +
+StatRecord +
+StatRepository +
+StatSet +
+StatSet.Container +
+StringCodeRecord +
+StringMapStat +
+StringSetStat +
+SwingGameConfigurator +
+Table +
+TableConfig +
+TableConfigurator +
+TableDirector +
+TableItem +
+TableListView +
+TableLobbyConfig +
+TableLobbyManager +
+TableLobbyObject +
+TableLobbyObject +
+TableManager +
+TableMarshaller +
+TableObserver +
+TableProvider +
+TableService +
+TeamGameManager +
+TestTileLoader +
+TileInfoPanel +
+TileSetUtil +
+ToggleParameter +
+TourneyCodes +
+TourneyConfig +
+TourneyLogicData +
+TourneyManager +
+TourneyMarshaller +
+TourneyObject +
+TourneyProvider +
+TourneyRepository +
+TourneyRepository.TourneyRecord +
+TourneyService +
+TourniesManager +
+TourniesMarshaller +
+TourniesProvider +
+TourniesService +
+TrickCardCodes +
+TrickCardGameControllerDelegate +
+TrickCardGameManagerDelegate +
+TrickCardGameMarshaller +
+TrickCardGameObject +
+TrickCardGameProvider +
+TrickCardGameService +
+TrickCardGameUtil +
+TurnDisplay +
+TurnGameController +
+TurnGameControllerDelegate +
+TurnGameManager +
+TurnGameManagerDelegate +
+TurnGameObject +
+UpdateList +
+UserIdentifier +
+UserIdentifier.Ider +
+ViewerApp +
+ViewerFrame +
+ViewerScenePanel +
+WhirledContext +
+WhirledServer +
+WhirledServer.WhirledModule +
+WhirledSession +
+ZoneAdapter +
+ZoneCodes +
+ZonedBodyObject +
+ZoneDecoder +
+ZoneDirector +
+ZoneManager +
+ZoneManager.ResolutionListener +
+ZoneMarshaller +
+ZoneMarshaller.ZoneMoveMarshaller +
+ZoneMoveHandler +
+ZoneNodeObject +
+ZoneObserver +
+ZonePeerManager +
+ZonePeerManager.NodeFunc +
+ZoneProvider +
+ZoneReceiver +
+ZoneRegistry +
+ZoneSender +
+ZoneService +
+ZoneService.ZoneMoveListener +
+ZoneSummary +
+ZoneUtil +
+
+ + + diff --git a/apidocs/com/threerings/micasa/Log.html b/apidocs/com/threerings/micasa/Log.html new file mode 100644 index 00000000..4cb7466f --- /dev/null +++ b/apidocs/com/threerings/micasa/Log.html @@ -0,0 +1,267 @@ + + + + + + + +Log (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.micasa +
+Class Log

+
+java.lang.Object
+  extended by com.threerings.micasa.Log
+
+
+
+
public class Log
extends Object
+ + +

+Contains a reference to the log object used by the MiCasa package. +

+ +

+

+ +

+ + + + + + + + + + + +
+Field Summary
+static Loggerlog + +
+          The static log instance configured for use by this package.
+  + + + + + + + + + + +
+Constructor Summary
Log() + +
+           
+  + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+log

+
+public static Logger log
+
+
The static log instance configured for use by this package. +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+Log

+
+public Log()
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/class-use/Log.html b/apidocs/com/threerings/micasa/class-use/Log.html new file mode 100644 index 00000000..88a11056 --- /dev/null +++ b/apidocs/com/threerings/micasa/class-use/Log.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.micasa.Log (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.micasa.Log

+
+No usage of com.threerings.micasa.Log +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/client/ChatPanel.html b/apidocs/com/threerings/micasa/client/ChatPanel.html new file mode 100644 index 00000000..ef357a4e --- /dev/null +++ b/apidocs/com/threerings/micasa/client/ChatPanel.html @@ -0,0 +1,618 @@ + + + + + + + +ChatPanel (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.micasa.client +
+Class ChatPanel

+
+java.lang.Object
+  extended by java.awt.Component
+      extended by java.awt.Container
+          extended by javax.swing.JComponent
+              extended by javax.swing.JPanel
+                  extended by com.threerings.micasa.client.ChatPanel
+
+
+
All Implemented Interfaces:
com.threerings.crowd.chat.client.ChatDisplay, com.threerings.crowd.client.OccupantObserver, com.threerings.crowd.client.PlaceView, ActionListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible
+
+
+
+
public class ChatPanel
extends JPanel
implements ActionListener, com.threerings.crowd.chat.client.ChatDisplay, com.threerings.crowd.client.OccupantObserver, com.threerings.crowd.client.PlaceView
+ + +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent
+  + + + + + + + + +
Nested classes/interfaces inherited from class java.awt.Component
Component.BaselineResizeBehavior
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class javax.swing.JComponent
TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
+  + + + + + + + +
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
+  + + + + + + + +
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
+  + + + + + + + + + + + + + +
+Constructor Summary
ChatPanel(com.threerings.crowd.util.CrowdContext ctx) + +
+           
ChatPanel(com.threerings.crowd.util.CrowdContext ctx, + boolean showHintLabel) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidactionPerformed(ActionEvent e) + +
+           
+ voidclear() + +
+           
+ voiddidLeavePlace(com.threerings.crowd.data.PlaceObject place) + +
+           
+ booleandisplayMessage(com.threerings.crowd.chat.data.ChatMessage message, + boolean displayed) + +
+           
+ DimensiongetPreferredSize() + +
+           
+ voidoccupantEntered(com.threerings.crowd.data.OccupantInfo info) + +
+           
+ voidoccupantLeft(com.threerings.crowd.data.OccupantInfo info) + +
+           
+ voidoccupantUpdated(com.threerings.crowd.data.OccupantInfo oinfo, + com.threerings.crowd.data.OccupantInfo info) + +
+           
+ voidremoveSendButton() + +
+          For applications where the chat box has extremely limited space, + the send button can be removed to leave more space for the text + input box.
+ voidsetRequestFocus(boolean focus) + +
+          Sets whether the chat box text entry field requests the keyboard + focus when the panel receives AncestorListener.ancestorAdded(javax.swing.event.AncestorEvent) or PlaceView.willEnterPlace(com.threerings.crowd.data.PlaceObject) + events.
+ voidwillEnterPlace(com.threerings.crowd.data.PlaceObject place) + +
+           
+  + + + + + + + +
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, setUI, updateUI
+  + + + + + + + +
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
+  + + + + + + + +
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate
+  + + + + + + + +
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+ChatPanel

+
+public ChatPanel(com.threerings.crowd.util.CrowdContext ctx)
+
+
+
+ +

+ChatPanel

+
+public ChatPanel(com.threerings.crowd.util.CrowdContext ctx,
+                 boolean showHintLabel)
+
+
+ + + + + + + + +
+Method Detail
+ +

+removeSendButton

+
+public void removeSendButton()
+
+
For applications where the chat box has extremely limited space, + the send button can be removed to leave more space for the text + input box. +

+

+
+
+
+
+
+
+
+ +

+setRequestFocus

+
+public void setRequestFocus(boolean focus)
+
+
Sets whether the chat box text entry field requests the keyboard + focus when the panel receives AncestorListener.ancestorAdded(javax.swing.event.AncestorEvent) or PlaceView.willEnterPlace(com.threerings.crowd.data.PlaceObject) + events. +

+

+
+
+
+
+
+
+
+ +

+actionPerformed

+
+public void actionPerformed(ActionEvent e)
+
+
+
Specified by:
actionPerformed in interface ActionListener
+
+
+
+
+
+
+ +

+occupantEntered

+
+public void occupantEntered(com.threerings.crowd.data.OccupantInfo info)
+
+
+
Specified by:
occupantEntered in interface com.threerings.crowd.client.OccupantObserver
+
+
+
+
+
+
+ +

+occupantLeft

+
+public void occupantLeft(com.threerings.crowd.data.OccupantInfo info)
+
+
+
Specified by:
occupantLeft in interface com.threerings.crowd.client.OccupantObserver
+
+
+
+
+
+
+ +

+occupantUpdated

+
+public void occupantUpdated(com.threerings.crowd.data.OccupantInfo oinfo,
+                            com.threerings.crowd.data.OccupantInfo info)
+
+
+
Specified by:
occupantUpdated in interface com.threerings.crowd.client.OccupantObserver
+
+
+
+
+
+
+ +

+clear

+
+public void clear()
+
+
+
Specified by:
clear in interface com.threerings.crowd.chat.client.ChatDisplay
+
+
+
+
+
+
+ +

+displayMessage

+
+public boolean displayMessage(com.threerings.crowd.chat.data.ChatMessage message,
+                              boolean displayed)
+
+
+
Specified by:
displayMessage in interface com.threerings.crowd.chat.client.ChatDisplay
+
+
+
+
+
+
+ +

+willEnterPlace

+
+public void willEnterPlace(com.threerings.crowd.data.PlaceObject place)
+
+
+
Specified by:
willEnterPlace in interface com.threerings.crowd.client.PlaceView
+
+
+
+
+
+
+ +

+didLeavePlace

+
+public void didLeavePlace(com.threerings.crowd.data.PlaceObject place)
+
+
+
Specified by:
didLeavePlace in interface com.threerings.crowd.client.PlaceView
+
+
+
+
+
+
+ +

+getPreferredSize

+
+public Dimension getPreferredSize()
+
+
+
Overrides:
getPreferredSize in class JComponent
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/client/ClientController.html b/apidocs/com/threerings/micasa/client/ClientController.html new file mode 100644 index 00000000..c7f45299 --- /dev/null +++ b/apidocs/com/threerings/micasa/client/ClientController.html @@ -0,0 +1,384 @@ + + + + + + + +ClientController (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.micasa.client +
+Class ClientController

+
+java.lang.Object
+  extended by com.samskivert.swing.Controller
+      extended by com.threerings.micasa.client.ClientController
+
+
+
All Implemented Interfaces:
com.threerings.presents.client.SessionObserver, ActionListener, EventListener
+
+
+
+
public class ClientController
extends Controller
implements com.threerings.presents.client.SessionObserver
+ + +

+Responsible for top-level control of the client user interface. +

+ +

+

+ +

+ + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class com.samskivert.swing.Controller
DISPATCHER
+  + + + + + + + + + + +
+Constructor Summary
ClientController(MiCasaContext ctx, + MiCasaFrame frame) + +
+          Creates a new client controller.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidclientDidLogoff(com.threerings.presents.client.Client client) + +
+           
+ voidclientDidLogon(com.threerings.presents.client.Client client) + +
+           
+ voidclientObjectDidChange(com.threerings.presents.client.Client client) + +
+           
+ voidclientWillLogon(com.threerings.presents.client.Client client) + +
+           
+ booleanhandleAction(ActionEvent action) + +
+           
+  + + + + + + + +
Methods inherited from class com.samskivert.swing.Controller
actionPerformed, configureAction, createActionButton, handleAction, handleAction, handleAction, postAction, postAction, postAction, setControlledPanel, wasAdded, wasRemoved
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+ClientController

+
+public ClientController(MiCasaContext ctx,
+                        MiCasaFrame frame)
+
+
Creates a new client controller. The controller will set everything + up in preparation for logging on. +

+

+ + + + + + + + +
+Method Detail
+ +

+handleAction

+
+public boolean handleAction(ActionEvent action)
+
+
+
Overrides:
handleAction in class Controller
+
+
+
+
+
+
+ +

+clientWillLogon

+
+public void clientWillLogon(com.threerings.presents.client.Client client)
+
+
+
Specified by:
clientWillLogon in interface com.threerings.presents.client.SessionObserver
+
+
+
+
+
+
+ +

+clientDidLogon

+
+public void clientDidLogon(com.threerings.presents.client.Client client)
+
+
+
Specified by:
clientDidLogon in interface com.threerings.presents.client.SessionObserver
+
+
+
+
+
+
+ +

+clientObjectDidChange

+
+public void clientObjectDidChange(com.threerings.presents.client.Client client)
+
+
+
Specified by:
clientObjectDidChange in interface com.threerings.presents.client.SessionObserver
+
+
+
+
+
+
+ +

+clientDidLogoff

+
+public void clientDidLogoff(com.threerings.presents.client.Client client)
+
+
+
Specified by:
clientDidLogoff in interface com.threerings.presents.client.SessionObserver
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/client/LogonPanel.html b/apidocs/com/threerings/micasa/client/LogonPanel.html new file mode 100644 index 00000000..c73f4f19 --- /dev/null +++ b/apidocs/com/threerings/micasa/client/LogonPanel.html @@ -0,0 +1,546 @@ + + + + + + + +LogonPanel (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.micasa.client +
+Class LogonPanel

+
+java.lang.Object
+  extended by java.awt.Component
+      extended by java.awt.Container
+          extended by javax.swing.JComponent
+              extended by javax.swing.JPanel
+                  extended by com.threerings.micasa.client.LogonPanel
+
+
+
All Implemented Interfaces:
com.threerings.presents.client.ClientObserver, com.threerings.presents.client.SessionObserver, ActionListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible
+
+
+
+
public class LogonPanel
extends JPanel
implements ActionListener, com.threerings.presents.client.ClientObserver
+ + +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent
+  + + + + + + + + +
Nested classes/interfaces inherited from class java.awt.Component
Component.BaselineResizeBehavior
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class javax.swing.JComponent
TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
+  + + + + + + + +
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
+  + + + + + + + +
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
+  + + + + + + + + + + +
+Constructor Summary
LogonPanel(MiCasaContext ctx) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidactionPerformed(ActionEvent e) + +
+           
+ voidclientConnectionFailed(com.threerings.presents.client.Client client, + Exception cause) + +
+           
+ voidclientDidClear(com.threerings.presents.client.Client client) + +
+           
+ voidclientDidLogoff(com.threerings.presents.client.Client client) + +
+           
+ voidclientDidLogon(com.threerings.presents.client.Client client) + +
+           
+ voidclientFailedToLogon(com.threerings.presents.client.Client client, + Exception cause) + +
+           
+ voidclientObjectDidChange(com.threerings.presents.client.Client client) + +
+           
+ booleanclientWillLogoff(com.threerings.presents.client.Client client) + +
+           
+ voidclientWillLogon(com.threerings.presents.client.Client client) + +
+           
+  + + + + + + + +
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, setUI, updateUI
+  + + + + + + + +
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
+  + + + + + + + +
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate
+  + + + + + + + +
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+LogonPanel

+
+public LogonPanel(MiCasaContext ctx)
+
+
+ + + + + + + + +
+Method Detail
+ +

+actionPerformed

+
+public void actionPerformed(ActionEvent e)
+
+
+
Specified by:
actionPerformed in interface ActionListener
+
+
+
+
+
+
+ +

+clientWillLogon

+
+public void clientWillLogon(com.threerings.presents.client.Client client)
+
+
+
Specified by:
clientWillLogon in interface com.threerings.presents.client.SessionObserver
+
+
+
+
+
+
+ +

+clientDidLogon

+
+public void clientDidLogon(com.threerings.presents.client.Client client)
+
+
+
Specified by:
clientDidLogon in interface com.threerings.presents.client.SessionObserver
+
+
+
+
+
+
+ +

+clientDidLogoff

+
+public void clientDidLogoff(com.threerings.presents.client.Client client)
+
+
+
Specified by:
clientDidLogoff in interface com.threerings.presents.client.SessionObserver
+
+
+
+
+
+
+ +

+clientDidClear

+
+public void clientDidClear(com.threerings.presents.client.Client client)
+
+
+
Specified by:
clientDidClear in interface com.threerings.presents.client.ClientObserver
+
+
+
+
+
+
+ +

+clientFailedToLogon

+
+public void clientFailedToLogon(com.threerings.presents.client.Client client,
+                                Exception cause)
+
+
+
Specified by:
clientFailedToLogon in interface com.threerings.presents.client.ClientObserver
+
+
+
+
+
+
+ +

+clientObjectDidChange

+
+public void clientObjectDidChange(com.threerings.presents.client.Client client)
+
+
+
Specified by:
clientObjectDidChange in interface com.threerings.presents.client.SessionObserver
+
+
+
+
+
+
+ +

+clientConnectionFailed

+
+public void clientConnectionFailed(com.threerings.presents.client.Client client,
+                                   Exception cause)
+
+
+
Specified by:
clientConnectionFailed in interface com.threerings.presents.client.ClientObserver
+
+
+
+
+
+
+ +

+clientWillLogoff

+
+public boolean clientWillLogoff(com.threerings.presents.client.Client client)
+
+
+
Specified by:
clientWillLogoff in interface com.threerings.presents.client.ClientObserver
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/client/MiCasaApp.html b/apidocs/com/threerings/micasa/client/MiCasaApp.html new file mode 100644 index 00000000..1d3fa2d4 --- /dev/null +++ b/apidocs/com/threerings/micasa/client/MiCasaApp.html @@ -0,0 +1,303 @@ + + + + + + + +MiCasaApp (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.micasa.client +
+Class MiCasaApp

+
+java.lang.Object
+  extended by com.threerings.micasa.client.MiCasaApp
+
+
+
+
public class MiCasaApp
extends Object
+ + +

+The micasa app is the main point of entry for the MiCasa client application. It creates and + initializes the myriad components of the client and sets all the proper wheels in motion. +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
MiCasaApp() + +
+           
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidinit() + +
+           
+static voidmain(String[] args) + +
+           
+ voidrun(String server, + String username, + String password) + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+MiCasaApp

+
+public MiCasaApp()
+
+
+ + + + + + + + +
+Method Detail
+ +

+init

+
+public void init()
+          throws IOException
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+run

+
+public void run(String server,
+                String username,
+                String password)
+
+
+
+
+
+
+ +

+main

+
+public static void main(String[] args)
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/client/MiCasaApplet.html b/apidocs/com/threerings/micasa/client/MiCasaApplet.html new file mode 100644 index 00000000..646c9aa6 --- /dev/null +++ b/apidocs/com/threerings/micasa/client/MiCasaApplet.html @@ -0,0 +1,402 @@ + + + + + + + +MiCasaApplet (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.micasa.client +
+Class MiCasaApplet

+
+java.lang.Object
+  extended by java.awt.Component
+      extended by java.awt.Container
+          extended by java.awt.Panel
+              extended by java.applet.Applet
+                  extended by com.threerings.micasa.client.MiCasaApplet
+
+
+
All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, Accessible
+
+
+
+
public class MiCasaApplet
extends Applet
+ + +

+The MiCasa applet is used to make MiCasa games available via the web + browser. +

+ +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class java.awt.Component
Component.BaselineResizeBehavior
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
+  + + + + + + + +
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
+  + + + + + + + + + + +
+Constructor Summary
MiCasaApplet() + +
+           
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidinit() + +
+          Create the client instance and set things up.
+ voidstart() + +
+          Display the client frame and really get things going.
+ voidstop() + +
+          Log off and shut on down.
+  + + + + + + + +
Methods inherited from class java.applet.Applet
destroy, getAccessibleContext, getAppletContext, getAppletInfo, getAudioClip, getAudioClip, getCodeBase, getDocumentBase, getImage, getImage, getLocale, getParameter, getParameterInfo, isActive, newAudioClip, play, play, resize, resize, setStub, showStatus
+  + + + + + + + +
Methods inherited from class java.awt.Panel
addNotify
+  + + + + + + + +
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getInsets, getLayout, getListeners, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, remove, remove, removeAll, removeContainerListener, removeNotify, setComponentZOrder, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, setLayout, transferFocusBackward, transferFocusDownCycle, update, validate
+  + + + + + + + +
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, dispatchEvent, enable, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, printAll, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocusInWindow, reshape, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusUpCycle
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+MiCasaApplet

+
+public MiCasaApplet()
+
+
+ + + + + + + + +
+Method Detail
+ +

+init

+
+public void init()
+
+
Create the client instance and set things up. +

+

+
Overrides:
init in class Applet
+
+
+
+
+
+
+ +

+start

+
+public void start()
+
+
Display the client frame and really get things going. +

+

+
Overrides:
start in class Applet
+
+
+
+
+
+
+ +

+stop

+
+public void stop()
+
+
Log off and shut on down. +

+

+
Overrides:
stop in class Applet
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/client/MiCasaClient.html b/apidocs/com/threerings/micasa/client/MiCasaClient.html new file mode 100644 index 00000000..ba965781 --- /dev/null +++ b/apidocs/com/threerings/micasa/client/MiCasaClient.html @@ -0,0 +1,289 @@ + + + + + + + +MiCasaClient (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.micasa.client +
+Class MiCasaClient

+
+java.lang.Object
+  extended by com.threerings.micasa.client.MiCasaClient
+
+
+
+
public class MiCasaClient
extends Object
+ + +

+The MiCasa client takes care of instantiating all of the proper + managers and loading up all of the necessary configuration and getting + the client bootstrapped. It can be extended by games that require an + extended context implementation. +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
MiCasaClient() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ MiCasaContextgetContext() + +
+          Returns a reference to the context in effect for this client.
+ voidinit(MiCasaFrame frame) + +
+          Initializes a new client and provides it with a frame in which to + display everything.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+MiCasaClient

+
+public MiCasaClient()
+
+
+ + + + + + + + +
+Method Detail
+ +

+init

+
+public void init(MiCasaFrame frame)
+          throws IOException
+
+
Initializes a new client and provides it with a frame in which to + display everything. +

+

+ +
Throws: +
IOException
+
+
+
+ +

+getContext

+
+public MiCasaContext getContext()
+
+
Returns a reference to the context in effect for this client. This + reference is valid for the lifetime of the application. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/client/MiCasaFrame.html b/apidocs/com/threerings/micasa/client/MiCasaFrame.html new file mode 100644 index 00000000..e6605a46 --- /dev/null +++ b/apidocs/com/threerings/micasa/client/MiCasaFrame.html @@ -0,0 +1,470 @@ + + + + + + + +MiCasaFrame (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.micasa.client +
+Class MiCasaFrame

+
+java.lang.Object
+  extended by java.awt.Component
+      extended by java.awt.Container
+          extended by java.awt.Window
+              extended by java.awt.Frame
+                  extended by javax.swing.JFrame
+                      extended by com.threerings.micasa.client.MiCasaFrame
+
+
+
All Implemented Interfaces:
ControllerProvider, ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants
+
+
+
Direct Known Subclasses:
SimpleFrame
+
+
+
+
public class MiCasaFrame
extends JFrame
implements ControllerProvider
+ + +

+Contains the user interface for the MiCasa client application. +

+ +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class java.awt.Component
Component.BaselineResizeBehavior
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class javax.swing.JFrame
EXIT_ON_CLOSE
+  + + + + + + + +
Fields inherited from class java.awt.Frame
CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR
+  + + + + + + + +
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
+  + + + + + + + +
Fields inherited from interface javax.swing.WindowConstants
DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE
+  + + + + + + + +
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
+  + + + + + + + + + + + + + +
+Constructor Summary
MiCasaFrame() + +
+          Constructs the top-level MiCasa client frame.
MiCasaFrame(String title) + +
+          Constructs the top-level MiCasa client frame with the specified + window title.
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ ControllergetController() + +
+           
+ voidsetController(Controller controller) + +
+          Sets the controller for the outermost scope.
+ voidsetPanel(JPanel panel) + +
+          Sets the panel that makes up the entire client display.
+  + + + + + + + +
Methods inherited from class javax.swing.JFrame
getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setTransferHandler, update
+  + + + + + + + +
Methods inherited from class java.awt.Frame
addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setResizable, setState, setTitle, setUndecorated
+  + + + + + + + +
Methods inherited from class java.awt.Window
addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOwnedWindows, getOwner, getOwnerlessWindows, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, paint, postEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setVisible, show, toBack, toFront
+  + + + + + + + +
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusBackward, transferFocusDownCycle, validate
+  + + + + + + + +
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, dispatchEvent, enable, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocusInWindow, resize, resize, setBackground, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusUpCycle
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  + + + + + + + +
Methods inherited from interface java.awt.MenuContainer
getFont, postEvent
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+MiCasaFrame

+
+public MiCasaFrame()
+
+
Constructs the top-level MiCasa client frame. +

+

+
+ +

+MiCasaFrame

+
+public MiCasaFrame(String title)
+
+
Constructs the top-level MiCasa client frame with the specified + window title. +

+

+ + + + + + + + +
+Method Detail
+ +

+setPanel

+
+public void setPanel(JPanel panel)
+
+
Sets the panel that makes up the entire client display. +

+

+
+
+
+
+
+
+
+ +

+setController

+
+public void setController(Controller controller)
+
+
Sets the controller for the outermost scope. This controller will + handle all actions that aren't handled by controllers of tigher + scope. +

+

+
+
+
+
+
+
+
+ +

+getController

+
+public Controller getController()
+
+
+
Specified by:
getController in interface ControllerProvider
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/client/OccupantList.html b/apidocs/com/threerings/micasa/client/OccupantList.html new file mode 100644 index 00000000..270e0704 --- /dev/null +++ b/apidocs/com/threerings/micasa/client/OccupantList.html @@ -0,0 +1,484 @@ + + + + + + + +OccupantList (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.micasa.client +
+Class OccupantList

+
+java.lang.Object
+  extended by java.awt.Component
+      extended by java.awt.Container
+          extended by javax.swing.JComponent
+              extended by javax.swing.JList
+                  extended by com.threerings.micasa.client.OccupantList
+
+
+
All Implemented Interfaces:
com.threerings.crowd.client.OccupantObserver, com.threerings.crowd.client.PlaceView, ImageObserver, MenuContainer, Serializable, Accessible, Scrollable
+
+
+
+
public class OccupantList
extends JList
implements com.threerings.crowd.client.PlaceView, com.threerings.crowd.client.OccupantObserver
+ + +

+The occupant list displays the list of users that are in a particular + place. +

+ +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class javax.swing.JList
JList.DropLocation
+  + + + + + + + + +
Nested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent
+  + + + + + + + + +
Nested classes/interfaces inherited from class java.awt.Component
Component.BaselineResizeBehavior
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class javax.swing.JList
HORIZONTAL_WRAP, VERTICAL, VERTICAL_WRAP
+  + + + + + + + +
Fields inherited from class javax.swing.JComponent
TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
+  + + + + + + + +
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
+  + + + + + + + +
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
+  + + + + + + + + + + +
+Constructor Summary
OccupantList(com.threerings.crowd.util.CrowdContext ctx) + +
+          Constructs an occupant list with the supplied context which it will + use to register itself with the necessary managers.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voiddidLeavePlace(com.threerings.crowd.data.PlaceObject plobj) + +
+           
+ voidoccupantEntered(com.threerings.crowd.data.OccupantInfo info) + +
+           
+ voidoccupantLeft(com.threerings.crowd.data.OccupantInfo info) + +
+           
+ voidoccupantUpdated(com.threerings.crowd.data.OccupantInfo oinfo, + com.threerings.crowd.data.OccupantInfo info) + +
+           
+ voidwillEnterPlace(com.threerings.crowd.data.PlaceObject plobj) + +
+           
+  + + + + + + + +
Methods inherited from class javax.swing.JList
addListSelectionListener, addSelectionInterval, clearSelection, ensureIndexIsVisible, getAccessibleContext, getAnchorSelectionIndex, getCellBounds, getCellRenderer, getDragEnabled, getDropLocation, getDropMode, getFirstVisibleIndex, getFixedCellHeight, getFixedCellWidth, getLastVisibleIndex, getLayoutOrientation, getLeadSelectionIndex, getListSelectionListeners, getMaxSelectionIndex, getMinSelectionIndex, getModel, getNextMatch, getPreferredScrollableViewportSize, getPrototypeCellValue, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getSelectedIndex, getSelectedIndices, getSelectedValue, getSelectedValues, getSelectionBackground, getSelectionForeground, getSelectionMode, getSelectionModel, getToolTipText, getUI, getUIClassID, getValueIsAdjusting, getVisibleRowCount, indexToLocation, isSelectedIndex, isSelectionEmpty, locationToIndex, removeListSelectionListener, removeSelectionInterval, setCellRenderer, setDragEnabled, setDropMode, setFixedCellHeight, setFixedCellWidth, setLayoutOrientation, setListData, setListData, setModel, setPrototypeCellValue, setSelectedIndex, setSelectedIndices, setSelectedValue, setSelectionBackground, setSelectionForeground, setSelectionInterval, setSelectionMode, setSelectionModel, setUI, setValueIsAdjusting, setVisibleRowCount, updateUI
+  + + + + + + + +
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
+  + + + + + + + +
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate
+  + + + + + + + +
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+OccupantList

+
+public OccupantList(com.threerings.crowd.util.CrowdContext ctx)
+
+
Constructs an occupant list with the supplied context which it will + use to register itself with the necessary managers. +

+

+ + + + + + + + +
+Method Detail
+ +

+willEnterPlace

+
+public void willEnterPlace(com.threerings.crowd.data.PlaceObject plobj)
+
+
+
Specified by:
willEnterPlace in interface com.threerings.crowd.client.PlaceView
+
+
+
+
+
+
+ +

+didLeavePlace

+
+public void didLeavePlace(com.threerings.crowd.data.PlaceObject plobj)
+
+
+
Specified by:
didLeavePlace in interface com.threerings.crowd.client.PlaceView
+
+
+
+
+
+
+ +

+occupantEntered

+
+public void occupantEntered(com.threerings.crowd.data.OccupantInfo info)
+
+
+
Specified by:
occupantEntered in interface com.threerings.crowd.client.OccupantObserver
+
+
+
+
+
+
+ +

+occupantLeft

+
+public void occupantLeft(com.threerings.crowd.data.OccupantInfo info)
+
+
+
Specified by:
occupantLeft in interface com.threerings.crowd.client.OccupantObserver
+
+
+
+
+
+
+ +

+occupantUpdated

+
+public void occupantUpdated(com.threerings.crowd.data.OccupantInfo oinfo,
+                            com.threerings.crowd.data.OccupantInfo info)
+
+
+
Specified by:
occupantUpdated in interface com.threerings.crowd.client.OccupantObserver
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/client/class-use/ChatPanel.html b/apidocs/com/threerings/micasa/client/class-use/ChatPanel.html new file mode 100644 index 00000000..8a6c4479 --- /dev/null +++ b/apidocs/com/threerings/micasa/client/class-use/ChatPanel.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.micasa.client.ChatPanel (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.micasa.client.ChatPanel

+
+No usage of com.threerings.micasa.client.ChatPanel +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/client/class-use/ClientController.html b/apidocs/com/threerings/micasa/client/class-use/ClientController.html new file mode 100644 index 00000000..31a0088d --- /dev/null +++ b/apidocs/com/threerings/micasa/client/class-use/ClientController.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.micasa.client.ClientController (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.micasa.client.ClientController

+
+No usage of com.threerings.micasa.client.ClientController +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/client/class-use/LogonPanel.html b/apidocs/com/threerings/micasa/client/class-use/LogonPanel.html new file mode 100644 index 00000000..129620a6 --- /dev/null +++ b/apidocs/com/threerings/micasa/client/class-use/LogonPanel.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.micasa.client.LogonPanel (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.micasa.client.LogonPanel

+
+No usage of com.threerings.micasa.client.LogonPanel +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/client/class-use/MiCasaApp.html b/apidocs/com/threerings/micasa/client/class-use/MiCasaApp.html new file mode 100644 index 00000000..e409bbcb --- /dev/null +++ b/apidocs/com/threerings/micasa/client/class-use/MiCasaApp.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.micasa.client.MiCasaApp (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.micasa.client.MiCasaApp

+
+No usage of com.threerings.micasa.client.MiCasaApp +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/client/class-use/MiCasaApplet.html b/apidocs/com/threerings/micasa/client/class-use/MiCasaApplet.html new file mode 100644 index 00000000..10a3f4ac --- /dev/null +++ b/apidocs/com/threerings/micasa/client/class-use/MiCasaApplet.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.micasa.client.MiCasaApplet (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.micasa.client.MiCasaApplet

+
+No usage of com.threerings.micasa.client.MiCasaApplet +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/client/class-use/MiCasaClient.html b/apidocs/com/threerings/micasa/client/class-use/MiCasaClient.html new file mode 100644 index 00000000..5100997d --- /dev/null +++ b/apidocs/com/threerings/micasa/client/class-use/MiCasaClient.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.micasa.client.MiCasaClient (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.micasa.client.MiCasaClient

+
+No usage of com.threerings.micasa.client.MiCasaClient +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/client/class-use/MiCasaFrame.html b/apidocs/com/threerings/micasa/client/class-use/MiCasaFrame.html new file mode 100644 index 00000000..19a9e145 --- /dev/null +++ b/apidocs/com/threerings/micasa/client/class-use/MiCasaFrame.html @@ -0,0 +1,255 @@ + + + + + + + +Uses of Class com.threerings.micasa.client.MiCasaFrame (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.micasa.client.MiCasaFrame

+
+ + + + + + + + + + + + + + + + + +
+Packages that use MiCasaFrame
com.threerings.micasa.client  
com.threerings.micasa.simulator.client  
com.threerings.micasa.util  
+  +

+ + + + + +
+Uses of MiCasaFrame in com.threerings.micasa.client
+  +

+ + + + + + + + + +
Methods in com.threerings.micasa.client with parameters of type MiCasaFrame
+ voidMiCasaClient.init(MiCasaFrame frame) + +
+          Initializes a new client and provides it with a frame in which to + display everything.
+  +

+ + + + + + + + +
Constructors in com.threerings.micasa.client with parameters of type MiCasaFrame
ClientController(MiCasaContext ctx, + MiCasaFrame frame) + +
+          Creates a new client controller.
+  +

+ + + + + +
+Uses of MiCasaFrame in com.threerings.micasa.simulator.client
+  +

+ + + + + + + + + +
Subclasses of MiCasaFrame in com.threerings.micasa.simulator.client
+ classSimpleFrame + +
+          Contains the user interface for the Simulator client application.
+  +

+ + + + + +
+Uses of MiCasaFrame in com.threerings.micasa.util
+  +

+ + + + + + + + + +
Methods in com.threerings.micasa.util that return MiCasaFrame
+ MiCasaFrameMiCasaContext.getFrame() + +
+          Returns a reference to the primary user interface frame.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/client/class-use/OccupantList.html b/apidocs/com/threerings/micasa/client/class-use/OccupantList.html new file mode 100644 index 00000000..d918d0fb --- /dev/null +++ b/apidocs/com/threerings/micasa/client/class-use/OccupantList.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.micasa.client.OccupantList (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.micasa.client.OccupantList

+
+No usage of com.threerings.micasa.client.OccupantList +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/client/package-frame.html b/apidocs/com/threerings/micasa/client/package-frame.html new file mode 100644 index 00000000..6b596d7d --- /dev/null +++ b/apidocs/com/threerings/micasa/client/package-frame.html @@ -0,0 +1,47 @@ + + + + + + + +com.threerings.micasa.client (vilya 1.3 API) + + + + + + + + + + + +com.threerings.micasa.client + + + + +
+Classes  + +
+ChatPanel +
+ClientController +
+LogonPanel +
+MiCasaApp +
+MiCasaApplet +
+MiCasaClient +
+MiCasaFrame +
+OccupantList
+ + + + diff --git a/apidocs/com/threerings/micasa/client/package-summary.html b/apidocs/com/threerings/micasa/client/package-summary.html new file mode 100644 index 00000000..b997ecee --- /dev/null +++ b/apidocs/com/threerings/micasa/client/package-summary.html @@ -0,0 +1,190 @@ + + + + + + + +com.threerings.micasa.client (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.micasa.client +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Class Summary
ChatPanel 
ClientControllerResponsible for top-level control of the client user interface.
LogonPanel 
MiCasaAppThe micasa app is the main point of entry for the MiCasa client application.
MiCasaAppletThe MiCasa applet is used to make MiCasa games available via the web + browser.
MiCasaClientThe MiCasa client takes care of instantiating all of the proper + managers and loading up all of the necessary configuration and getting + the client bootstrapped.
MiCasaFrameContains the user interface for the MiCasa client application.
OccupantListThe occupant list displays the list of users that are in a particular + place.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/client/package-tree.html b/apidocs/com/threerings/micasa/client/package-tree.html new file mode 100644 index 00000000..516cd6ec --- /dev/null +++ b/apidocs/com/threerings/micasa/client/package-tree.html @@ -0,0 +1,190 @@ + + + + + + + +com.threerings.micasa.client Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.micasa.client +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/client/package-use.html b/apidocs/com/threerings/micasa/client/package-use.html new file mode 100644 index 00000000..4673c719 --- /dev/null +++ b/apidocs/com/threerings/micasa/client/package-use.html @@ -0,0 +1,209 @@ + + + + + + + +Uses of Package com.threerings.micasa.client (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.micasa.client

+
+ + + + + + + + + + + + + + + + + +
+Packages that use com.threerings.micasa.client
com.threerings.micasa.client  
com.threerings.micasa.simulator.client  
com.threerings.micasa.util  
+  +

+ + + + + + + + +
+Classes in com.threerings.micasa.client used by com.threerings.micasa.client
MiCasaFrame + +
+          Contains the user interface for the MiCasa client application.
+  +

+ + + + + + + + +
+Classes in com.threerings.micasa.client used by com.threerings.micasa.simulator.client
MiCasaFrame + +
+          Contains the user interface for the MiCasa client application.
+  +

+ + + + + + + + +
+Classes in com.threerings.micasa.client used by com.threerings.micasa.util
MiCasaFrame + +
+          Contains the user interface for the MiCasa client application.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/data/MiCasaBootstrapData.html b/apidocs/com/threerings/micasa/data/MiCasaBootstrapData.html new file mode 100644 index 00000000..09a7e64a --- /dev/null +++ b/apidocs/com/threerings/micasa/data/MiCasaBootstrapData.html @@ -0,0 +1,310 @@ + + + + + + + +MiCasaBootstrapData (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.micasa.data +
+Class MiCasaBootstrapData

+
+java.lang.Object
+  extended by com.threerings.io.SimpleStreamableObject
+      extended by com.threerings.presents.net.BootstrapData
+          extended by com.threerings.micasa.data.MiCasaBootstrapData
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable
+
+
+
+
public class MiCasaBootstrapData
extends com.threerings.presents.net.BootstrapData
+ + +

+Extends the basic Presents bootstrap data and provides some bootstrap + information specific to the MiCasa services. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + +
+Field Summary
+ intdefLobbyOid + +
+          The oid of the default lobby.
+  + + + + + + + +
Fields inherited from class com.threerings.presents.net.BootstrapData
clientOid, connectionId, services
+  + + + + + + + + + + +
+Constructor Summary
MiCasaBootstrapData() + +
+           
+  + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from class com.threerings.io.SimpleStreamableObject
toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+defLobbyOid

+
+public int defLobbyOid
+
+
The oid of the default lobby. +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+MiCasaBootstrapData

+
+public MiCasaBootstrapData()
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/data/class-use/MiCasaBootstrapData.html b/apidocs/com/threerings/micasa/data/class-use/MiCasaBootstrapData.html new file mode 100644 index 00000000..36e8cd90 --- /dev/null +++ b/apidocs/com/threerings/micasa/data/class-use/MiCasaBootstrapData.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.micasa.data.MiCasaBootstrapData (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.micasa.data.MiCasaBootstrapData

+
+No usage of com.threerings.micasa.data.MiCasaBootstrapData +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/data/package-frame.html b/apidocs/com/threerings/micasa/data/package-frame.html new file mode 100644 index 00000000..0fe916bf --- /dev/null +++ b/apidocs/com/threerings/micasa/data/package-frame.html @@ -0,0 +1,33 @@ + + + + + + + +com.threerings.micasa.data (vilya 1.3 API) + + + + + + + + + + + +com.threerings.micasa.data + + + + +
+Classes  + +
+MiCasaBootstrapData
+ + + + diff --git a/apidocs/com/threerings/micasa/data/package-summary.html b/apidocs/com/threerings/micasa/data/package-summary.html new file mode 100644 index 00000000..ea30a8ca --- /dev/null +++ b/apidocs/com/threerings/micasa/data/package-summary.html @@ -0,0 +1,159 @@ + + + + + + + +com.threerings.micasa.data (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.micasa.data +

+ + + + + + + + + +
+Class Summary
MiCasaBootstrapDataExtends the basic Presents bootstrap data and provides some bootstrap + information specific to the MiCasa services.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/data/package-tree.html b/apidocs/com/threerings/micasa/data/package-tree.html new file mode 100644 index 00000000..f763871d --- /dev/null +++ b/apidocs/com/threerings/micasa/data/package-tree.html @@ -0,0 +1,159 @@ + + + + + + + +com.threerings.micasa.data Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.micasa.data +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/data/package-use.html b/apidocs/com/threerings/micasa/data/package-use.html new file mode 100644 index 00000000..3505c4c4 --- /dev/null +++ b/apidocs/com/threerings/micasa/data/package-use.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Package com.threerings.micasa.data (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.micasa.data

+
+No usage of com.threerings.micasa.data +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/lobby/Lobby.html b/apidocs/com/threerings/micasa/lobby/Lobby.html new file mode 100644 index 00000000..12c9fc99 --- /dev/null +++ b/apidocs/com/threerings/micasa/lobby/Lobby.html @@ -0,0 +1,366 @@ + + + + + + + +Lobby (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.micasa.lobby +
+Class Lobby

+
+java.lang.Object
+  extended by com.threerings.io.SimpleStreamableObject
+      extended by com.threerings.micasa.lobby.Lobby
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable
+
+
+
+
public class Lobby
extends com.threerings.io.SimpleStreamableObject
+ + +

+A simple class for keeping track of information for each lobby in + operation on the server. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + + + + + + + + + +
+Field Summary
+ StringgameIdent + +
+          The universal game identifier string for the game matchmade by + this lobby.
+ Stringname + +
+          The human readable name of the lobby.
+ intplaceOid + +
+          The object id of the lobby place object.
+  + + + + + + + + + + + + + +
+Constructor Summary
Lobby() + +
+          Constructs a blank lobby record suitable for unserialization.
Lobby(int placeOid, + String gameIdent, + String name) + +
+          Constructs a lobby record and initializes it with the specified + values.
+  + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from class com.threerings.io.SimpleStreamableObject
toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+placeOid

+
+public int placeOid
+
+
The object id of the lobby place object. +

+

+
+
+
+ +

+gameIdent

+
+public String gameIdent
+
+
The universal game identifier string for the game matchmade by + this lobby. +

+

+
+
+
+ +

+name

+
+public String name
+
+
The human readable name of the lobby. +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+Lobby

+
+public Lobby(int placeOid,
+             String gameIdent,
+             String name)
+
+
Constructs a lobby record and initializes it with the specified + values. +

+

+
+ +

+Lobby

+
+public Lobby()
+
+
Constructs a blank lobby record suitable for unserialization. +

+

+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/lobby/LobbyConfig.html b/apidocs/com/threerings/micasa/lobby/LobbyConfig.html new file mode 100644 index 00000000..3646336e --- /dev/null +++ b/apidocs/com/threerings/micasa/lobby/LobbyConfig.html @@ -0,0 +1,400 @@ + + + + + + + +LobbyConfig (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.micasa.lobby +
+Class LobbyConfig

+
+java.lang.Object
+  extended by com.threerings.io.SimpleStreamableObject
+      extended by com.threerings.crowd.data.PlaceConfig
+          extended by com.threerings.micasa.lobby.LobbyConfig
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable
+
+
+
Direct Known Subclasses:
TableLobbyConfig
+
+
+
+
public class LobbyConfig
extends com.threerings.crowd.data.PlaceConfig
+ + +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + +
+Constructor Summary
LobbyConfig() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ com.threerings.crowd.client.PlaceControllercreateController() + +
+           
+ JComponentcreateMatchMakingView(MiCasaContext ctx) + +
+          Derived classes override this function and create the appropriate + matchmaking user interface component.
+ GameConfiggetGameConfig() + +
+          Instantiates and returns a game config instance using the game + config classname provided by the lobby configuration parameters.
+ StringgetManagerClassName() + +
+           
+ voidinit(Properties config) + +
+          Initializes this lobby config object with the properties that are + used to configure the lobby.
+  + + + + + + + +
Methods inherited from class com.threerings.crowd.data.PlaceConfig
getControllerClass
+  + + + + + + + +
Methods inherited from class com.threerings.io.SimpleStreamableObject
toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+LobbyConfig

+
+public LobbyConfig()
+
+
+ + + + + + + + +
+Method Detail
+ +

+createController

+
+public com.threerings.crowd.client.PlaceController createController()
+
+
+
Overrides:
createController in class com.threerings.crowd.data.PlaceConfig
+
+
+
+
+
+
+ +

+getManagerClassName

+
+public String getManagerClassName()
+
+
+
Specified by:
getManagerClassName in class com.threerings.crowd.data.PlaceConfig
+
+
+
+
+
+
+ +

+createMatchMakingView

+
+public JComponent createMatchMakingView(MiCasaContext ctx)
+
+
Derived classes override this function and create the appropriate + matchmaking user interface component. +

+

+
+
+
+
+ +

+getGameConfig

+
+public GameConfig getGameConfig()
+                         throws Exception
+
+
Instantiates and returns a game config instance using the game + config classname provided by the lobby configuration parameters. +

+

+ +
Throws: +
Exception - thrown if a problem occurs loading or + instantiating the class.
+
+
+
+ +

+init

+
+public void init(Properties config)
+          throws Exception
+
+
Initializes this lobby config object with the properties that are + used to configure the lobby. This is called on the server when the + lobby is loaded. +

+

+ +
Throws: +
Exception
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/lobby/LobbyController.html b/apidocs/com/threerings/micasa/lobby/LobbyController.html new file mode 100644 index 00000000..92784d7f --- /dev/null +++ b/apidocs/com/threerings/micasa/lobby/LobbyController.html @@ -0,0 +1,474 @@ + + + + + + + +LobbyController (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.micasa.lobby +
+Class LobbyController

+
+java.lang.Object
+  extended by com.samskivert.swing.Controller
+      extended by com.threerings.crowd.client.PlaceController
+          extended by com.threerings.micasa.lobby.LobbyController
+
+
+
All Implemented Interfaces:
InvitationHandler, InvitationResponseObserver, ActionListener, EventListener
+
+
+
+
public class LobbyController
extends com.threerings.crowd.client.PlaceController
implements InvitationHandler, InvitationResponseObserver
+ + +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.crowd.client.PlaceController
com.threerings.crowd.client.PlaceController.DelegateOp
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class com.samskivert.swing.Controller
DISPATCHER
+  + + + + + + + + + + +
+Constructor Summary
LobbyController() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidinit(com.threerings.crowd.util.CrowdContext ctx, + com.threerings.crowd.data.PlaceConfig config) + +
+           
+ voidinvitationAccepted(Invitation invite) + +
+          Called if the invitation was accepted.
+ voidinvitationCancelled(Invitation invite) + +
+          Called when an invitation is cancelled by the inviting player.
+ voidinvitationCountered(Invitation invite, + GameConfig config) + +
+          Called if the invitation was countered with an alternate game + configuration.
+ voidinvitationReceived(Invitation invite) + +
+          Called when an invitation is received from another player.
+ voidinvitationRefused(Invitation invite, + String message) + +
+          Called if the invitation was refused.
+ voidwillEnterPlace(com.threerings.crowd.data.PlaceObject plobj) + +
+           
+  + + + + + + + +
Methods inherited from class com.threerings.crowd.client.PlaceController
didLeavePlace, getPlaceConfig, getPlaceView, handleAction, mayLeavePlace
+  + + + + + + + +
Methods inherited from class com.samskivert.swing.Controller
actionPerformed, configureAction, createActionButton, handleAction, handleAction, handleAction, postAction, postAction, postAction, setControlledPanel, wasAdded, wasRemoved
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+LobbyController

+
+public LobbyController()
+
+
+ + + + + + + + +
+Method Detail
+ +

+init

+
+public void init(com.threerings.crowd.util.CrowdContext ctx,
+                 com.threerings.crowd.data.PlaceConfig config)
+
+
+
Overrides:
init in class com.threerings.crowd.client.PlaceController
+
+
+
+
+
+
+ +

+willEnterPlace

+
+public void willEnterPlace(com.threerings.crowd.data.PlaceObject plobj)
+
+
+
Overrides:
willEnterPlace in class com.threerings.crowd.client.PlaceController
+
+
+
+
+
+
+ +

+invitationReceived

+
+public void invitationReceived(Invitation invite)
+
+
Description copied from interface: InvitationHandler
+
Called when an invitation is received from another player. +

+

+
Specified by:
invitationReceived in interface InvitationHandler
+
+
+
Parameters:
invite - the received invitation.
+
+
+
+ +

+invitationCancelled

+
+public void invitationCancelled(Invitation invite)
+
+
Description copied from interface: InvitationHandler
+
Called when an invitation is cancelled by the inviting player. +

+

+
Specified by:
invitationCancelled in interface InvitationHandler
+
+
+
Parameters:
invite - the cancelled invitation.
+
+
+
+ +

+invitationAccepted

+
+public void invitationAccepted(Invitation invite)
+
+
Description copied from interface: InvitationResponseObserver
+
Called if the invitation was accepted. +

+

+
Specified by:
invitationAccepted in interface InvitationResponseObserver
+
+
+
Parameters:
invite - the invitation for which we received a response.
+
+
+
+ +

+invitationRefused

+
+public void invitationRefused(Invitation invite,
+                              String message)
+
+
Description copied from interface: InvitationResponseObserver
+
Called if the invitation was refused. +

+

+
Specified by:
invitationRefused in interface InvitationResponseObserver
+
+
+
Parameters:
invite - the invitation for which we received a response.
message - a message provided by the invited user explaining + the reason for their refusal, or the empty string if no message was + provided.
+
+
+
+ +

+invitationCountered

+
+public void invitationCountered(Invitation invite,
+                                GameConfig config)
+
+
Description copied from interface: InvitationResponseObserver
+
Called if the invitation was countered with an alternate game + configuration. +

+

+
Specified by:
invitationCountered in interface InvitationResponseObserver
+
+
+
Parameters:
invite - the invitation for which we received a response.
config - the game configuration proposed by the invited + player.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/lobby/LobbyManager.html b/apidocs/com/threerings/micasa/lobby/LobbyManager.html new file mode 100644 index 00000000..adee345d --- /dev/null +++ b/apidocs/com/threerings/micasa/lobby/LobbyManager.html @@ -0,0 +1,299 @@ + + + + + + + +LobbyManager (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.micasa.lobby +
+Class LobbyManager

+
+java.lang.Object
+  extended by com.threerings.crowd.server.PlaceManager
+      extended by com.threerings.micasa.lobby.LobbyManager
+
+
+
All Implemented Interfaces:
com.threerings.crowd.chat.server.SpeakHandler.SpeakerValidator, com.threerings.presents.dobj.ChangeListener, com.threerings.presents.dobj.MessageListener
+
+
+
Direct Known Subclasses:
TableLobbyManager
+
+
+
+
public class LobbyManager
extends com.threerings.crowd.server.PlaceManager
+ + +

+Takes care of the server side of a particular lobby. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.crowd.server.PlaceManager
com.threerings.crowd.server.PlaceManager.DelegateOp, com.threerings.crowd.server.PlaceManager.MessageHandler
+  + + + + + + + + + + + +
+Constructor Summary
LobbyManager() + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ voidinit(LobbyRegistry lobreg, + Properties config) + +
+          Initializes this lobby manager with its configuration properties.
+  + + + + + + + +
Methods inherited from class com.threerings.crowd.server.PlaceManager
addDelegate, applyToDelegates, applyToOccupants, bodyWillEnter, bodyWillLeave, checkPermissions, getConfig, getLocation, getPlaceObject, init, isValidSpeaker, messageReceived, ratifyBodyEntry, registerMessageHandler, shutdown, startup, toString, updateOccupantInfo, where
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+LobbyManager

+
+public LobbyManager()
+
+
+ + + + + + + + +
+Method Detail
+ +

+init

+
+public void init(LobbyRegistry lobreg,
+                 Properties config)
+          throws Exception
+
+
Initializes this lobby manager with its configuration properties. +

+

+ +
Throws: +
Exception - thrown if a configuration error is detected.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/lobby/LobbyMarshaller.CategoriesMarshaller.html b/apidocs/com/threerings/micasa/lobby/LobbyMarshaller.CategoriesMarshaller.html new file mode 100644 index 00000000..3186dc9c --- /dev/null +++ b/apidocs/com/threerings/micasa/lobby/LobbyMarshaller.CategoriesMarshaller.html @@ -0,0 +1,380 @@ + + + + + + + +LobbyMarshaller.CategoriesMarshaller (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.micasa.lobby +
+Class LobbyMarshaller.CategoriesMarshaller

+
+java.lang.Object
+  extended by com.threerings.presents.data.InvocationMarshaller.ListenerMarshaller
+      extended by com.threerings.micasa.lobby.LobbyMarshaller.CategoriesMarshaller
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable, LobbyService.CategoriesListener, com.threerings.presents.client.InvocationService.InvocationListener
+
+
+
Enclosing class:
LobbyMarshaller
+
+
+
+
public static class LobbyMarshaller.CategoriesMarshaller
extends com.threerings.presents.data.InvocationMarshaller.ListenerMarshaller
implements LobbyService.CategoriesListener
+ + +

+Marshalls results to implementations of LobbyService.CategoriesListener. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + +
+Field Summary
+static intGOT_CATEGORIES + +
+          The method id used to dispatch gotCategories(java.lang.String[]) + responses.
+  + + + + + + + +
Fields inherited from class com.threerings.presents.data.InvocationMarshaller.ListenerMarshaller
callerOid, listener, mapStamp, omgr, REQUEST_FAILED_RSPID, requestId, transport
+  + + + + + + + + + + +
+Constructor Summary
LobbyMarshaller.CategoriesMarshaller() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ voiddispatchResponse(int methodId, + Object[] args) + +
+           
+ voidgotCategories(String[] arg1) + +
+          Supplies the listener with the results of a LobbyService.getCategories(com.threerings.micasa.lobby.LobbyService.CategoriesListener) request.
+  + + + + + + + +
Methods inherited from class com.threerings.presents.data.InvocationMarshaller.ListenerMarshaller
requestFailed, setInvocationId, setNoResponse, toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  + + + + + + + +
Methods inherited from interface com.threerings.presents.client.InvocationService.InvocationListener
requestFailed
+  +

+ + + + + + + + +
+Field Detail
+ +

+GOT_CATEGORIES

+
+public static final int GOT_CATEGORIES
+
+
The method id used to dispatch gotCategories(java.lang.String[]) + responses. +

+

+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Constructor Detail
+ +

+LobbyMarshaller.CategoriesMarshaller

+
+public LobbyMarshaller.CategoriesMarshaller()
+
+
+ + + + + + + + +
+Method Detail
+ +

+gotCategories

+
+public void gotCategories(String[] arg1)
+
+
Description copied from interface: LobbyService.CategoriesListener
+
Supplies the listener with the results of a LobbyService.getCategories(com.threerings.micasa.lobby.LobbyService.CategoriesListener) request. +

+

+
Specified by:
gotCategories in interface LobbyService.CategoriesListener
+
+
+
+
+
+
+ +

+dispatchResponse

+
+public void dispatchResponse(int methodId,
+                             Object[] args)
+
+
+
Overrides:
dispatchResponse in class com.threerings.presents.data.InvocationMarshaller.ListenerMarshaller
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/lobby/LobbyMarshaller.LobbiesMarshaller.html b/apidocs/com/threerings/micasa/lobby/LobbyMarshaller.LobbiesMarshaller.html new file mode 100644 index 00000000..1a86a466 --- /dev/null +++ b/apidocs/com/threerings/micasa/lobby/LobbyMarshaller.LobbiesMarshaller.html @@ -0,0 +1,380 @@ + + + + + + + +LobbyMarshaller.LobbiesMarshaller (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.micasa.lobby +
+Class LobbyMarshaller.LobbiesMarshaller

+
+java.lang.Object
+  extended by com.threerings.presents.data.InvocationMarshaller.ListenerMarshaller
+      extended by com.threerings.micasa.lobby.LobbyMarshaller.LobbiesMarshaller
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable, LobbyService.LobbiesListener, com.threerings.presents.client.InvocationService.InvocationListener
+
+
+
Enclosing class:
LobbyMarshaller
+
+
+
+
public static class LobbyMarshaller.LobbiesMarshaller
extends com.threerings.presents.data.InvocationMarshaller.ListenerMarshaller
implements LobbyService.LobbiesListener
+ + +

+Marshalls results to implementations of LobbyService.LobbiesListener. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + +
+Field Summary
+static intGOT_LOBBIES + +
+          The method id used to dispatch gotLobbies(java.util.List) + responses.
+  + + + + + + + +
Fields inherited from class com.threerings.presents.data.InvocationMarshaller.ListenerMarshaller
callerOid, listener, mapStamp, omgr, REQUEST_FAILED_RSPID, requestId, transport
+  + + + + + + + + + + +
+Constructor Summary
LobbyMarshaller.LobbiesMarshaller() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ voiddispatchResponse(int methodId, + Object[] args) + +
+           
+ voidgotLobbies(List<Lobby> arg1) + +
+          Supplies the listener with the results of a LobbyService.getLobbies(java.lang.String, com.threerings.micasa.lobby.LobbyService.LobbiesListener) request.
+  + + + + + + + +
Methods inherited from class com.threerings.presents.data.InvocationMarshaller.ListenerMarshaller
requestFailed, setInvocationId, setNoResponse, toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  + + + + + + + +
Methods inherited from interface com.threerings.presents.client.InvocationService.InvocationListener
requestFailed
+  +

+ + + + + + + + +
+Field Detail
+ +

+GOT_LOBBIES

+
+public static final int GOT_LOBBIES
+
+
The method id used to dispatch gotLobbies(java.util.List) + responses. +

+

+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Constructor Detail
+ +

+LobbyMarshaller.LobbiesMarshaller

+
+public LobbyMarshaller.LobbiesMarshaller()
+
+
+ + + + + + + + +
+Method Detail
+ +

+gotLobbies

+
+public void gotLobbies(List<Lobby> arg1)
+
+
Description copied from interface: LobbyService.LobbiesListener
+
Supplies the listener with the results of a LobbyService.getLobbies(java.lang.String, com.threerings.micasa.lobby.LobbyService.LobbiesListener) request. +

+

+
Specified by:
gotLobbies in interface LobbyService.LobbiesListener
+
+
+
+
+
+
+ +

+dispatchResponse

+
+public void dispatchResponse(int methodId,
+                             Object[] args)
+
+
+
Overrides:
dispatchResponse in class com.threerings.presents.data.InvocationMarshaller.ListenerMarshaller
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/lobby/LobbyMarshaller.html b/apidocs/com/threerings/micasa/lobby/LobbyMarshaller.html new file mode 100644 index 00000000..36bd753f --- /dev/null +++ b/apidocs/com/threerings/micasa/lobby/LobbyMarshaller.html @@ -0,0 +1,434 @@ + + + + + + + +LobbyMarshaller (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.micasa.lobby +
+Class LobbyMarshaller

+
+java.lang.Object
+  extended by com.threerings.presents.data.InvocationMarshaller
+      extended by com.threerings.micasa.lobby.LobbyMarshaller
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable, LobbyService, com.threerings.presents.client.InvocationService
+
+
+
+
@Generated(value="com.threerings.presents.tools.GenServiceTask",
+           comments="Derived from LobbyService.java.")
+public class LobbyMarshaller
extends com.threerings.presents.data.InvocationMarshaller
implements LobbyService
+ + +

+Provides the implementation of the LobbyService interface + that marshalls the arguments and delivers the request to the provider + on the server. Also provides an implementation of the response listener + interfaces that marshall the response arguments and deliver them back + to the requesting client. +

+ +

+

+ +

+ + + + + + + + + + + + + + + +
+Nested Class Summary
+static classLobbyMarshaller.CategoriesMarshaller + +
+          Marshalls results to implementations of LobbyService.CategoriesListener.
+static classLobbyMarshaller.LobbiesMarshaller + +
+          Marshalls results to implementations of LobbyService.LobbiesListener.
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.presents.data.InvocationMarshaller
com.threerings.presents.data.InvocationMarshaller.ConfirmMarshaller, com.threerings.presents.data.InvocationMarshaller.ListenerMarshaller, com.threerings.presents.data.InvocationMarshaller.ResultMarshaller
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.micasa.lobby.LobbyService
LobbyService.CategoriesListener, LobbyService.LobbiesListener
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.presents.client.InvocationService
com.threerings.presents.client.InvocationService.ConfirmListener, com.threerings.presents.client.InvocationService.InvocationListener, com.threerings.presents.client.InvocationService.ResultListener
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + + + + + +
+Field Summary
+static intGET_CATEGORIES + +
+          The method id used to dispatch getCategories(com.threerings.micasa.lobby.LobbyService.CategoriesListener) requests.
+static intGET_LOBBIES + +
+          The method id used to dispatch getLobbies(java.lang.String, com.threerings.micasa.lobby.LobbyService.LobbiesListener) requests.
+  + + + + + + + + + + +
+Constructor Summary
LobbyMarshaller() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ voidgetCategories(LobbyService.CategoriesListener arg1) + +
+          Requests the list of lobby categories that are available on this + server.
+ voidgetLobbies(String arg1, + LobbyService.LobbiesListener arg2) + +
+          Requests information on all active lobbies that match the specified category.
+  + + + + + + + +
Methods inherited from class com.threerings.presents.data.InvocationMarshaller
getInvocationCode, init, readField__invCode, readField__invOid, readObject, setInvocationOid, setNoResponse, toString, writeField__invCode, writeField__invOid
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+GET_CATEGORIES

+
+public static final int GET_CATEGORIES
+
+
The method id used to dispatch getCategories(com.threerings.micasa.lobby.LobbyService.CategoriesListener) requests. +

+

+
See Also:
Constant Field Values
+
+
+ +

+GET_LOBBIES

+
+public static final int GET_LOBBIES
+
+
The method id used to dispatch getLobbies(java.lang.String, com.threerings.micasa.lobby.LobbyService.LobbiesListener) requests. +

+

+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Constructor Detail
+ +

+LobbyMarshaller

+
+public LobbyMarshaller()
+
+
+ + + + + + + + +
+Method Detail
+ +

+getCategories

+
+public void getCategories(LobbyService.CategoriesListener arg1)
+
+
Description copied from interface: LobbyService
+
Requests the list of lobby categories that are available on this + server. +

+

+
Specified by:
getCategories in interface LobbyService
+
+
+
Parameters:
arg1 - the listener that will receive and process the response.
+
+
+
+ +

+getLobbies

+
+public void getLobbies(String arg1,
+                       LobbyService.LobbiesListener arg2)
+
+
Description copied from interface: LobbyService
+
Requests information on all active lobbies that match the specified category. +

+

+
Specified by:
getLobbies in interface LobbyService
+
+
+
Parameters:
arg1 - the category of game for which a list of lobbies is desired.
arg2 - the listener that will receive and process the response.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/lobby/LobbyObject.html b/apidocs/com/threerings/micasa/lobby/LobbyObject.html new file mode 100644 index 00000000..a8f8547c --- /dev/null +++ b/apidocs/com/threerings/micasa/lobby/LobbyObject.html @@ -0,0 +1,314 @@ + + + + + + + +LobbyObject (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.micasa.lobby +
+Class LobbyObject

+
+java.lang.Object
+  extended by com.threerings.presents.dobj.DObject
+      extended by com.threerings.crowd.data.PlaceObject
+          extended by com.threerings.micasa.lobby.LobbyObject
+
+
+
All Implemented Interfaces:
com.threerings.crowd.chat.data.SpeakObject, com.threerings.io.Streamable
+
+
+
Direct Known Subclasses:
TableLobbyObject
+
+
+
+
public class LobbyObject
extends com.threerings.crowd.data.PlaceObject
+ + +

+Presently the lobby object contains nothing specific, but the class + acts as a placeholder in case lobby-wide fields are needed in the + future. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.crowd.data.PlaceObject
com.threerings.crowd.data.PlaceObject.ManagerCaller
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.crowd.chat.data.SpeakObject
com.threerings.crowd.chat.data.SpeakObject.ListenerOp
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class com.threerings.crowd.data.PlaceObject
manager, OCCUPANT_INFO, occupantInfo, occupants, OCCUPANTS, SPEAK_SERVICE, speakService
+  + + + + + + + + + + +
+Constructor Summary
LobbyObject() + +
+           
+  + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from class com.threerings.crowd.data.PlaceObject
addToOccupantInfo, addToOccupants, applyToListeners, getOccupantInfo, initManagerCaller, removeFromOccupantInfo, removeFromOccupants, setOccupantInfo, setSpeakService, shouldBroadcast, updateOccupantInfo
+  + + + + + + + +
Methods inherited from class com.threerings.presents.dobj.DObject
acquireLock, addListener, addListener, addSubscriber, addToSet, cancelTransaction, changeAttribute, checkPermissions, checkPermissions, commitTransaction, destroy, getAccessController, getAttribute, getLocal, getLocals, getManager, getOid, getSet, inTransaction, isActive, notifyListeners, notifyProxies, postEvent, postMessage, postMessage, readField__oid, releaseLock, removeFromSet, removeListener, removeSubscriber, setAccessController, setAttribute, setDestroyOnLastSubscriberRemoved, setLocal, setManager, setOid, startTransaction, toString, updateSet, which, writeField__oid
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+LobbyObject

+
+public LobbyObject()
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/lobby/LobbyPanel.html b/apidocs/com/threerings/micasa/lobby/LobbyPanel.html new file mode 100644 index 00000000..1539c678 --- /dev/null +++ b/apidocs/com/threerings/micasa/lobby/LobbyPanel.html @@ -0,0 +1,400 @@ + + + + + + + +LobbyPanel (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.micasa.lobby +
+Class LobbyPanel

+
+java.lang.Object
+  extended by java.awt.Component
+      extended by java.awt.Container
+          extended by javax.swing.JComponent
+              extended by javax.swing.JPanel
+                  extended by com.threerings.micasa.lobby.LobbyPanel
+
+
+
All Implemented Interfaces:
com.threerings.crowd.client.PlaceView, ImageObserver, MenuContainer, Serializable, Accessible
+
+
+
+
public class LobbyPanel
extends JPanel
implements com.threerings.crowd.client.PlaceView
+ + +

+Used to display the interface for the lobbies. It contains a lobby + selection mechanism, a chat interface and a user interface for whatever + match-making mechanism is appropriate for this particular lobby. +

+ +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent
+  + + + + + + + + +
Nested classes/interfaces inherited from class java.awt.Component
Component.BaselineResizeBehavior
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class javax.swing.JComponent
TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
+  + + + + + + + +
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
+  + + + + + + + +
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
+  + + + + + + + + + + +
+Constructor Summary
LobbyPanel(MiCasaContext ctx, + LobbyConfig config) + +
+          Constructs a new lobby panel and the associated user interface + elements.
+  + + + + + + + + + + + + + + + +
+Method Summary
+ voiddidLeavePlace(com.threerings.crowd.data.PlaceObject plobj) + +
+           
+ voidwillEnterPlace(com.threerings.crowd.data.PlaceObject plobj) + +
+           
+  + + + + + + + +
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, setUI, updateUI
+  + + + + + + + +
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
+  + + + + + + + +
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate
+  + + + + + + + +
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+LobbyPanel

+
+public LobbyPanel(MiCasaContext ctx,
+                  LobbyConfig config)
+
+
Constructs a new lobby panel and the associated user interface + elements. +

+

+ + + + + + + + +
+Method Detail
+ +

+willEnterPlace

+
+public void willEnterPlace(com.threerings.crowd.data.PlaceObject plobj)
+
+
+
Specified by:
willEnterPlace in interface com.threerings.crowd.client.PlaceView
+
+
+
+
+
+
+ +

+didLeavePlace

+
+public void didLeavePlace(com.threerings.crowd.data.PlaceObject plobj)
+
+
+
Specified by:
didLeavePlace in interface com.threerings.crowd.client.PlaceView
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/lobby/LobbyProvider.html b/apidocs/com/threerings/micasa/lobby/LobbyProvider.html new file mode 100644 index 00000000..ed77f2e0 --- /dev/null +++ b/apidocs/com/threerings/micasa/lobby/LobbyProvider.html @@ -0,0 +1,260 @@ + + + + + + + +LobbyProvider (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.micasa.lobby +
+Interface LobbyProvider

+
+
All Superinterfaces:
com.threerings.presents.server.InvocationProvider
+
+
+
All Known Implementing Classes:
LobbyRegistry
+
+
+
+
@Generated(value="com.threerings.presents.tools.GenServiceTask",
+           comments="Derived from LobbyService.java.")
+public interface LobbyProvider
extends com.threerings.presents.server.InvocationProvider
+ + +

+Defines the server-side of the LobbyService. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + +
+Method Summary
+ voidgetCategories(com.threerings.presents.data.ClientObject caller, + LobbyService.CategoriesListener arg1) + +
+          Handles a LobbyService.getCategories(com.threerings.micasa.lobby.LobbyService.CategoriesListener) request.
+ voidgetLobbies(com.threerings.presents.data.ClientObject caller, + String arg1, + LobbyService.LobbiesListener arg2) + +
+          Handles a LobbyService.getLobbies(java.lang.String, com.threerings.micasa.lobby.LobbyService.LobbiesListener) request.
+  +

+ + + + + + + + +
+Method Detail
+ +

+getCategories

+
+void getCategories(com.threerings.presents.data.ClientObject caller,
+                   LobbyService.CategoriesListener arg1)
+                   throws com.threerings.presents.server.InvocationException
+
+
Handles a LobbyService.getCategories(com.threerings.micasa.lobby.LobbyService.CategoriesListener) request. +

+

+
+
+
+ +
Throws: +
com.threerings.presents.server.InvocationException
+
+
+
+ +

+getLobbies

+
+void getLobbies(com.threerings.presents.data.ClientObject caller,
+                String arg1,
+                LobbyService.LobbiesListener arg2)
+                throws com.threerings.presents.server.InvocationException
+
+
Handles a LobbyService.getLobbies(java.lang.String, com.threerings.micasa.lobby.LobbyService.LobbiesListener) request. +

+

+
+
+
+ +
Throws: +
com.threerings.presents.server.InvocationException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/lobby/LobbyRegistry.html b/apidocs/com/threerings/micasa/lobby/LobbyRegistry.html new file mode 100644 index 00000000..0d580842 --- /dev/null +++ b/apidocs/com/threerings/micasa/lobby/LobbyRegistry.html @@ -0,0 +1,447 @@ + + + + + + + +LobbyRegistry (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.micasa.lobby +
+Class LobbyRegistry

+
+java.lang.Object
+  extended by com.threerings.micasa.lobby.LobbyRegistry
+
+
+
All Implemented Interfaces:
LobbyProvider, com.threerings.presents.server.InvocationProvider
+
+
+
+
public class LobbyRegistry
extends Object
implements LobbyProvider
+ + +

+The lobby registry is the primary class that coordinates the lobby services on the client. It + sets up the necessary invocation services and keeps track of the lobbies in operation on the + server. Only one lobby registry should be created on a server. + +

Presently, the lobby registry is configured with lobbies via the server configuration. An + example configuration follows: + + 

+ lobby_ids = foolobby, barlobby, bazlobby
+
+ foolobby.mgrclass = com.threerings.micasa.lobby.LobbyManager
+ foolobby.ugi = 
+ foolobby.name = 
+ foolobby.config1 = some config value
+ foolobby.config2 = some other config value
+
+ barlobby.mgrclass = com.threerings.micasa.lobby.LobbyManager
+ barlobby.ugi = 
+ barlobby.name = 
+ ...
+
+ + This information will be loaded from the MiCasa server configuration which means that it should + live in rsrc/config/micasa/server.properties somwhere in the classpath where it + will override the default MiCasa server properties file. + +

The UGI or universal game identifier is a string that is used to uniquely + identify every type of game and also to classify it according to meaningful keywords. It is best + described with a few examples: + + 

+ backgammon,board,strategy
+ spades,card,partner
+ yahtzee,dice
+
+ + As you can see, a UGI should start with an identifier uniquely identifying the type of game and + can be followed by a list of keywords that classify it as a member of a particular category of + games (eg. board, card, dice, partner game, strategy game). A game can belong to multiple + categories. + +

As long as the UGIs in use by a particular server make some kind of sense, the client will + be able to use them to search for lobbies containing games of similar types using the provided + facilities. +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
LobbyRegistry(com.threerings.presents.server.InvocationManager invmgr) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ String[]getCategories(com.threerings.crowd.data.BodyObject requester) + +
+          Returns an array containing the category identifiers of all the categories in which lobbies + have been registered with the registry.
+ voidgetCategories(com.threerings.presents.data.ClientObject caller, + LobbyService.CategoriesListener listener) + +
+          Processes a request by the client to obtain a list of the lobby categories available on this + server.
+ intgetDefaultLobbyOid() + +
+          Returns the oid of the default lobby.
+ voidgetLobbies(com.threerings.crowd.data.BodyObject requester, + String category, + List<Lobby> target) + +
+          Returns information about all lobbies hosting games in the specified category.
+ voidgetLobbies(com.threerings.presents.data.ClientObject caller, + String category, + LobbyService.LobbiesListener listener) + +
+          Processes a request by the client to obtain a list of lobbies matching the supplied category + string.
+ voidinit() + +
+          Initializes the registry, creating our default lobbies.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+LobbyRegistry

+
+@Inject
+public LobbyRegistry(com.threerings.presents.server.InvocationManager invmgr)
+
+
+ + + + + + + + +
+Method Detail
+ +

+init

+
+public void init()
+
+
Initializes the registry, creating our default lobbies. +

+

+
+
+
+
+
+
+
+ +

+getDefaultLobbyOid

+
+public int getDefaultLobbyOid()
+
+
Returns the oid of the default lobby. +

+

+
+
+
+
+
+
+
+ +

+getLobbies

+
+public void getLobbies(com.threerings.crowd.data.BodyObject requester,
+                       String category,
+                       List<Lobby> target)
+
+
Returns information about all lobbies hosting games in the specified category. +

+

+
+
+
+
Parameters:
requester - the body object of the client requesting the lobby list (which can be used + to filter the list based on their capabilities).
category - the category of game for which the lobbies are desired.
target - the list into which the matching lobbies will be deposited.
+
+
+
+ +

+getCategories

+
+public String[] getCategories(com.threerings.crowd.data.BodyObject requester)
+
+
Returns an array containing the category identifiers of all the categories in which lobbies + have been registered with the registry. +

+

+
+
+
+
Parameters:
requester - the body object of the client requesting the category list (which can be + used to filter the list based on their capabilities).
+
+
+
+ +

+getCategories

+
+public void getCategories(com.threerings.presents.data.ClientObject caller,
+                          LobbyService.CategoriesListener listener)
+
+
Processes a request by the client to obtain a list of the lobby categories available on this + server. +

+

+
Specified by:
getCategories in interface LobbyProvider
+
+
+
+
+
+
+ +

+getLobbies

+
+public void getLobbies(com.threerings.presents.data.ClientObject caller,
+                       String category,
+                       LobbyService.LobbiesListener listener)
+
+
Processes a request by the client to obtain a list of lobbies matching the supplied category + string. +

+

+
Specified by:
getLobbies in interface LobbyProvider
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/lobby/LobbySelector.html b/apidocs/com/threerings/micasa/lobby/LobbySelector.html new file mode 100644 index 00000000..cb1edced --- /dev/null +++ b/apidocs/com/threerings/micasa/lobby/LobbySelector.html @@ -0,0 +1,475 @@ + + + + + + + +LobbySelector (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.micasa.lobby +
+Class LobbySelector

+
+java.lang.Object
+  extended by java.awt.Component
+      extended by java.awt.Container
+          extended by javax.swing.JComponent
+              extended by javax.swing.JPanel
+                  extended by com.threerings.micasa.lobby.LobbySelector
+
+
+
All Implemented Interfaces:
LobbyService.CategoriesListener, LobbyService.LobbiesListener, com.threerings.presents.client.InvocationService.InvocationListener, ActionListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible
+
+
+
+
public class LobbySelector
extends JPanel
implements ActionListener, LobbyService.CategoriesListener, LobbyService.LobbiesListener
+ + +

+The lobby selector displays a drop-down box listing the categories of + lobbies available on this server and when a category is selected, it + displays a list of the lobbies that are available in that category. If + a lobby is double-clicked, it moves the client into that lobby room. +

+ +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent
+  + + + + + + + + +
Nested classes/interfaces inherited from class java.awt.Component
Component.BaselineResizeBehavior
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class javax.swing.JComponent
TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
+  + + + + + + + +
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
+  + + + + + + + +
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
+  + + + + + + + + + + +
+Constructor Summary
LobbySelector(MiCasaContext ctx) + +
+          Constructs a new lobby selector component.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidactionPerformed(ActionEvent evt) + +
+          Called when the user selects a category or double-clicks on a + lobby.
+ voidaddNotify() + +
+           
+ voidgotCategories(String[] categories) + +
+          Supplies the listener with the results of a LobbyService.getCategories(com.threerings.micasa.lobby.LobbyService.CategoriesListener) request.
+ voidgotLobbies(List<Lobby> lobbies) + +
+          Supplies the listener with the results of a LobbyService.getLobbies(java.lang.String, com.threerings.micasa.lobby.LobbyService.LobbiesListener) request.
+ voidrequestFailed(String reason) + +
+           
+  + + + + + + + +
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, setUI, updateUI
+  + + + + + + + +
Methods inherited from class javax.swing.JComponent
addAncestorListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
+  + + + + + + + +
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate
+  + + + + + + + +
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+LobbySelector

+
+public LobbySelector(MiCasaContext ctx)
+
+
Constructs a new lobby selector component. It will wait until it is + visible before issuing a get categories request to download a list + of categories. +

+

+ + + + + + + + +
+Method Detail
+ +

+addNotify

+
+public void addNotify()
+
+
+
Overrides:
addNotify in class JComponent
+
+
+
+
+
+
+ +

+actionPerformed

+
+public void actionPerformed(ActionEvent evt)
+
+
Called when the user selects a category or double-clicks on a + lobby. +

+

+
Specified by:
actionPerformed in interface ActionListener
+
+
+
+
+
+
+ +

+gotCategories

+
+public void gotCategories(String[] categories)
+
+
Description copied from interface: LobbyService.CategoriesListener
+
Supplies the listener with the results of a LobbyService.getCategories(com.threerings.micasa.lobby.LobbyService.CategoriesListener) request. +

+

+
Specified by:
gotCategories in interface LobbyService.CategoriesListener
+
+
+
+
+
+
+ +

+gotLobbies

+
+public void gotLobbies(List<Lobby> lobbies)
+
+
Description copied from interface: LobbyService.LobbiesListener
+
Supplies the listener with the results of a LobbyService.getLobbies(java.lang.String, com.threerings.micasa.lobby.LobbyService.LobbiesListener) request. +

+

+
Specified by:
gotLobbies in interface LobbyService.LobbiesListener
+
+
+
+
+
+
+ +

+requestFailed

+
+public void requestFailed(String reason)
+
+
+
Specified by:
requestFailed in interface com.threerings.presents.client.InvocationService.InvocationListener
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/lobby/LobbyService.CategoriesListener.html b/apidocs/com/threerings/micasa/lobby/LobbyService.CategoriesListener.html new file mode 100644 index 00000000..47bc5be4 --- /dev/null +++ b/apidocs/com/threerings/micasa/lobby/LobbyService.CategoriesListener.html @@ -0,0 +1,234 @@ + + + + + + + +LobbyService.CategoriesListener (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.micasa.lobby +
+Interface LobbyService.CategoriesListener

+
+
All Superinterfaces:
com.threerings.presents.client.InvocationService.InvocationListener
+
+
+
All Known Implementing Classes:
LobbyMarshaller.CategoriesMarshaller, LobbySelector
+
+
+
Enclosing interface:
LobbyService
+
+
+
+
public static interface LobbyService.CategoriesListener
extends com.threerings.presents.client.InvocationService.InvocationListener
+ + +

+Used to communicate the results of a LobbyService.getCategories(com.threerings.micasa.lobby.LobbyService.CategoriesListener) request. +

+ +

+

+ +

+ + + + + + + + + + + + +
+Method Summary
+ voidgotCategories(String[] categories) + +
+          Supplies the listener with the results of a LobbyService.getCategories(com.threerings.micasa.lobby.LobbyService.CategoriesListener) request.
+  + + + + + + + +
Methods inherited from interface com.threerings.presents.client.InvocationService.InvocationListener
requestFailed
+  +

+ + + + + + + + +
+Method Detail
+ +

+gotCategories

+
+void gotCategories(String[] categories)
+
+
Supplies the listener with the results of a LobbyService.getCategories(com.threerings.micasa.lobby.LobbyService.CategoriesListener) request. +

+

+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/lobby/LobbyService.LobbiesListener.html b/apidocs/com/threerings/micasa/lobby/LobbyService.LobbiesListener.html new file mode 100644 index 00000000..09e96618 --- /dev/null +++ b/apidocs/com/threerings/micasa/lobby/LobbyService.LobbiesListener.html @@ -0,0 +1,234 @@ + + + + + + + +LobbyService.LobbiesListener (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.micasa.lobby +
+Interface LobbyService.LobbiesListener

+
+
All Superinterfaces:
com.threerings.presents.client.InvocationService.InvocationListener
+
+
+
All Known Implementing Classes:
LobbyMarshaller.LobbiesMarshaller, LobbySelector
+
+
+
Enclosing interface:
LobbyService
+
+
+
+
public static interface LobbyService.LobbiesListener
extends com.threerings.presents.client.InvocationService.InvocationListener
+ + +

+Used to communicate the results of a LobbyService.getLobbies(java.lang.String, com.threerings.micasa.lobby.LobbyService.LobbiesListener) request. +

+ +

+

+ +

+ + + + + + + + + + + + +
+Method Summary
+ voidgotLobbies(List<Lobby> lobbies) + +
+          Supplies the listener with the results of a LobbyService.getLobbies(java.lang.String, com.threerings.micasa.lobby.LobbyService.LobbiesListener) request.
+  + + + + + + + +
Methods inherited from interface com.threerings.presents.client.InvocationService.InvocationListener
requestFailed
+  +

+ + + + + + + + +
+Method Detail
+ +

+gotLobbies

+
+void gotLobbies(List<Lobby> lobbies)
+
+
Supplies the listener with the results of a LobbyService.getLobbies(java.lang.String, com.threerings.micasa.lobby.LobbyService.LobbiesListener) request. +

+

+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/lobby/LobbyService.html b/apidocs/com/threerings/micasa/lobby/LobbyService.html new file mode 100644 index 00000000..f324d5cf --- /dev/null +++ b/apidocs/com/threerings/micasa/lobby/LobbyService.html @@ -0,0 +1,286 @@ + + + + + + + +LobbyService (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.micasa.lobby +
+Interface LobbyService

+
+
All Superinterfaces:
com.threerings.presents.client.InvocationService
+
+
+
All Known Implementing Classes:
LobbyMarshaller
+
+
+
+
public interface LobbyService
extends com.threerings.presents.client.InvocationService
+ + +

+Provides an interface to the various parlor services that are directly + invokable by the client (by means of the invocation services). +

+ +

+

+ +

+ + + + + + + + + + + + + + + +
+Nested Class Summary
+static interfaceLobbyService.CategoriesListener + +
+          Used to communicate the results of a getCategories(com.threerings.micasa.lobby.LobbyService.CategoriesListener) request.
+static interfaceLobbyService.LobbiesListener + +
+          Used to communicate the results of a getLobbies(java.lang.String, com.threerings.micasa.lobby.LobbyService.LobbiesListener) request.
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.presents.client.InvocationService
com.threerings.presents.client.InvocationService.ConfirmListener, com.threerings.presents.client.InvocationService.InvocationListener, com.threerings.presents.client.InvocationService.ResultListener
+  + + + + + + + + + + + + + + + + +
+Method Summary
+ voidgetCategories(LobbyService.CategoriesListener listener) + +
+          Requests the list of lobby categories that are available on this + server.
+ voidgetLobbies(String category, + LobbyService.LobbiesListener listener) + +
+          Requests information on all active lobbies that match the specified category.
+  +

+ + + + + + + + +
+Method Detail
+ +

+getCategories

+
+void getCategories(LobbyService.CategoriesListener listener)
+
+
Requests the list of lobby categories that are available on this + server. +

+

+
+
+
+
Parameters:
listener - the listener that will receive and process the response.
+
+
+
+ +

+getLobbies

+
+void getLobbies(String category,
+                LobbyService.LobbiesListener listener)
+
+
Requests information on all active lobbies that match the specified category. +

+

+
+
+
+
Parameters:
category - the category of game for which a list of lobbies is desired.
listener - the listener that will receive and process the response.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/lobby/class-use/Lobby.html b/apidocs/com/threerings/micasa/lobby/class-use/Lobby.html new file mode 100644 index 00000000..164dd6ba --- /dev/null +++ b/apidocs/com/threerings/micasa/lobby/class-use/Lobby.html @@ -0,0 +1,207 @@ + + + + + + + +Uses of Class com.threerings.micasa.lobby.Lobby (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.micasa.lobby.Lobby

+
+ + + + + + + + + +
+Packages that use Lobby
com.threerings.micasa.lobby  
+  +

+ + + + + +
+Uses of Lobby in com.threerings.micasa.lobby
+  +

+ + + + + + + + + + + + + + + + + + + + + +
Method parameters in com.threerings.micasa.lobby with type arguments of type Lobby
+ voidLobbyRegistry.getLobbies(com.threerings.crowd.data.BodyObject requester, + String category, + List<Lobby> target) + +
+          Returns information about all lobbies hosting games in the specified category.
+ voidLobbyService.LobbiesListener.gotLobbies(List<Lobby> lobbies) + +
+          Supplies the listener with the results of a LobbyService.getLobbies(java.lang.String, com.threerings.micasa.lobby.LobbyService.LobbiesListener) request.
+ voidLobbySelector.gotLobbies(List<Lobby> lobbies) + +
+           
+ voidLobbyMarshaller.LobbiesMarshaller.gotLobbies(List<Lobby> arg1) + +
+           
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/lobby/class-use/LobbyConfig.html b/apidocs/com/threerings/micasa/lobby/class-use/LobbyConfig.html new file mode 100644 index 00000000..40b3838f --- /dev/null +++ b/apidocs/com/threerings/micasa/lobby/class-use/LobbyConfig.html @@ -0,0 +1,227 @@ + + + + + + + +Uses of Class com.threerings.micasa.lobby.LobbyConfig (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.micasa.lobby.LobbyConfig

+
+ + + + + + + + + + + + + +
+Packages that use LobbyConfig
com.threerings.micasa.lobby  
com.threerings.micasa.lobby.table  
+  +

+ + + + + +
+Uses of LobbyConfig in com.threerings.micasa.lobby
+  +

+ + + + + + + + +
Constructors in com.threerings.micasa.lobby with parameters of type LobbyConfig
LobbyPanel(MiCasaContext ctx, + LobbyConfig config) + +
+          Constructs a new lobby panel and the associated user interface + elements.
+  +

+ + + + + +
+Uses of LobbyConfig in com.threerings.micasa.lobby.table
+  +

+ + + + + + + + + +
Subclasses of LobbyConfig in com.threerings.micasa.lobby.table
+ classTableLobbyConfig + +
+          Instructs the lobby services to use a TableListView as the + matchmaking component.
+  +

+ + + + + + + + +
Constructors in com.threerings.micasa.lobby.table with parameters of type LobbyConfig
TableListView(MiCasaContext ctx, + LobbyConfig config) + +
+          Creates a new table list view, suitable for providing the user + interface for table-style matchmaking in a table lobby.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/lobby/class-use/LobbyController.html b/apidocs/com/threerings/micasa/lobby/class-use/LobbyController.html new file mode 100644 index 00000000..a0714eb6 --- /dev/null +++ b/apidocs/com/threerings/micasa/lobby/class-use/LobbyController.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.micasa.lobby.LobbyController (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.micasa.lobby.LobbyController

+
+No usage of com.threerings.micasa.lobby.LobbyController +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/lobby/class-use/LobbyManager.html b/apidocs/com/threerings/micasa/lobby/class-use/LobbyManager.html new file mode 100644 index 00000000..958a2ac5 --- /dev/null +++ b/apidocs/com/threerings/micasa/lobby/class-use/LobbyManager.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class com.threerings.micasa.lobby.LobbyManager (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.micasa.lobby.LobbyManager

+
+ + + + + + + + + +
+Packages that use LobbyManager
com.threerings.micasa.lobby.table  
+  +

+ + + + + +
+Uses of LobbyManager in com.threerings.micasa.lobby.table
+  +

+ + + + + + + + + +
Subclasses of LobbyManager in com.threerings.micasa.lobby.table
+ classTableLobbyManager + +
+          Extends lobby manager only to ensure that a table lobby object is used for table lobbies.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/lobby/class-use/LobbyMarshaller.CategoriesMarshaller.html b/apidocs/com/threerings/micasa/lobby/class-use/LobbyMarshaller.CategoriesMarshaller.html new file mode 100644 index 00000000..5bb98b3a --- /dev/null +++ b/apidocs/com/threerings/micasa/lobby/class-use/LobbyMarshaller.CategoriesMarshaller.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.micasa.lobby.LobbyMarshaller.CategoriesMarshaller (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.micasa.lobby.LobbyMarshaller.CategoriesMarshaller

+
+No usage of com.threerings.micasa.lobby.LobbyMarshaller.CategoriesMarshaller +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/lobby/class-use/LobbyMarshaller.LobbiesMarshaller.html b/apidocs/com/threerings/micasa/lobby/class-use/LobbyMarshaller.LobbiesMarshaller.html new file mode 100644 index 00000000..7a4bf3c6 --- /dev/null +++ b/apidocs/com/threerings/micasa/lobby/class-use/LobbyMarshaller.LobbiesMarshaller.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.micasa.lobby.LobbyMarshaller.LobbiesMarshaller (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.micasa.lobby.LobbyMarshaller.LobbiesMarshaller

+
+No usage of com.threerings.micasa.lobby.LobbyMarshaller.LobbiesMarshaller +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/lobby/class-use/LobbyMarshaller.html b/apidocs/com/threerings/micasa/lobby/class-use/LobbyMarshaller.html new file mode 100644 index 00000000..22805473 --- /dev/null +++ b/apidocs/com/threerings/micasa/lobby/class-use/LobbyMarshaller.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.micasa.lobby.LobbyMarshaller (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.micasa.lobby.LobbyMarshaller

+
+No usage of com.threerings.micasa.lobby.LobbyMarshaller +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/lobby/class-use/LobbyObject.html b/apidocs/com/threerings/micasa/lobby/class-use/LobbyObject.html new file mode 100644 index 00000000..4a882509 --- /dev/null +++ b/apidocs/com/threerings/micasa/lobby/class-use/LobbyObject.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class com.threerings.micasa.lobby.LobbyObject (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.micasa.lobby.LobbyObject

+
+ + + + + + + + + +
+Packages that use LobbyObject
com.threerings.micasa.lobby.table  
+  +

+ + + + + +
+Uses of LobbyObject in com.threerings.micasa.lobby.table
+  +

+ + + + + + + + + +
Subclasses of LobbyObject in com.threerings.micasa.lobby.table
+ classTableLobbyObject + +
+           
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/lobby/class-use/LobbyPanel.html b/apidocs/com/threerings/micasa/lobby/class-use/LobbyPanel.html new file mode 100644 index 00000000..1eeb5632 --- /dev/null +++ b/apidocs/com/threerings/micasa/lobby/class-use/LobbyPanel.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.micasa.lobby.LobbyPanel (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.micasa.lobby.LobbyPanel

+
+No usage of com.threerings.micasa.lobby.LobbyPanel +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/lobby/class-use/LobbyProvider.html b/apidocs/com/threerings/micasa/lobby/class-use/LobbyProvider.html new file mode 100644 index 00000000..e9eb107a --- /dev/null +++ b/apidocs/com/threerings/micasa/lobby/class-use/LobbyProvider.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Interface com.threerings.micasa.lobby.LobbyProvider (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.micasa.lobby.LobbyProvider

+
+ + + + + + + + + +
+Packages that use LobbyProvider
com.threerings.micasa.lobby  
+  +

+ + + + + +
+Uses of LobbyProvider in com.threerings.micasa.lobby
+  +

+ + + + + + + + + +
Classes in com.threerings.micasa.lobby that implement LobbyProvider
+ classLobbyRegistry + +
+          The lobby registry is the primary class that coordinates the lobby services on the client.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/lobby/class-use/LobbyRegistry.html b/apidocs/com/threerings/micasa/lobby/class-use/LobbyRegistry.html new file mode 100644 index 00000000..b01374df --- /dev/null +++ b/apidocs/com/threerings/micasa/lobby/class-use/LobbyRegistry.html @@ -0,0 +1,182 @@ + + + + + + + +Uses of Class com.threerings.micasa.lobby.LobbyRegistry (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.micasa.lobby.LobbyRegistry

+
+ + + + + + + + + +
+Packages that use LobbyRegistry
com.threerings.micasa.lobby  
+  +

+ + + + + +
+Uses of LobbyRegistry in com.threerings.micasa.lobby
+  +

+ + + + + + + + + +
Methods in com.threerings.micasa.lobby with parameters of type LobbyRegistry
+ voidLobbyManager.init(LobbyRegistry lobreg, + Properties config) + +
+          Initializes this lobby manager with its configuration properties.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/lobby/class-use/LobbySelector.html b/apidocs/com/threerings/micasa/lobby/class-use/LobbySelector.html new file mode 100644 index 00000000..2ef04011 --- /dev/null +++ b/apidocs/com/threerings/micasa/lobby/class-use/LobbySelector.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.micasa.lobby.LobbySelector (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.micasa.lobby.LobbySelector

+
+No usage of com.threerings.micasa.lobby.LobbySelector +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/lobby/class-use/LobbyService.CategoriesListener.html b/apidocs/com/threerings/micasa/lobby/class-use/LobbyService.CategoriesListener.html new file mode 100644 index 00000000..2596fd81 --- /dev/null +++ b/apidocs/com/threerings/micasa/lobby/class-use/LobbyService.CategoriesListener.html @@ -0,0 +1,235 @@ + + + + + + + +Uses of Interface com.threerings.micasa.lobby.LobbyService.CategoriesListener (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.micasa.lobby.LobbyService.CategoriesListener

+
+ + + + + + + + + +
+Packages that use LobbyService.CategoriesListener
com.threerings.micasa.lobby  
+  +

+ + + + + +
+Uses of LobbyService.CategoriesListener in com.threerings.micasa.lobby
+  +

+ + + + + + + + + + + + + +
Classes in com.threerings.micasa.lobby that implement LobbyService.CategoriesListener
+static classLobbyMarshaller.CategoriesMarshaller + +
+          Marshalls results to implementations of LobbyService.CategoriesListener.
+ classLobbySelector + +
+          The lobby selector displays a drop-down box listing the categories of + lobbies available on this server and when a category is selected, it + displays a list of the lobbies that are available in that category.
+  +

+ + + + + + + + + + + + + + + + + + + + + +
Methods in com.threerings.micasa.lobby with parameters of type LobbyService.CategoriesListener
+ voidLobbyRegistry.getCategories(com.threerings.presents.data.ClientObject caller, + LobbyService.CategoriesListener listener) + +
+          Processes a request by the client to obtain a list of the lobby categories available on this + server.
+ voidLobbyProvider.getCategories(com.threerings.presents.data.ClientObject caller, + LobbyService.CategoriesListener arg1) + +
+          Handles a LobbyService.getCategories(com.threerings.micasa.lobby.LobbyService.CategoriesListener) request.
+ voidLobbyService.getCategories(LobbyService.CategoriesListener listener) + +
+          Requests the list of lobby categories that are available on this + server.
+ voidLobbyMarshaller.getCategories(LobbyService.CategoriesListener arg1) + +
+           
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/lobby/class-use/LobbyService.LobbiesListener.html b/apidocs/com/threerings/micasa/lobby/class-use/LobbyService.LobbiesListener.html new file mode 100644 index 00000000..845d84b5 --- /dev/null +++ b/apidocs/com/threerings/micasa/lobby/class-use/LobbyService.LobbiesListener.html @@ -0,0 +1,238 @@ + + + + + + + +Uses of Interface com.threerings.micasa.lobby.LobbyService.LobbiesListener (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.micasa.lobby.LobbyService.LobbiesListener

+
+ + + + + + + + + +
+Packages that use LobbyService.LobbiesListener
com.threerings.micasa.lobby  
+  +

+ + + + + +
+Uses of LobbyService.LobbiesListener in com.threerings.micasa.lobby
+  +

+ + + + + + + + + + + + + +
Classes in com.threerings.micasa.lobby that implement LobbyService.LobbiesListener
+static classLobbyMarshaller.LobbiesMarshaller + +
+          Marshalls results to implementations of LobbyService.LobbiesListener.
+ classLobbySelector + +
+          The lobby selector displays a drop-down box listing the categories of + lobbies available on this server and when a category is selected, it + displays a list of the lobbies that are available in that category.
+  +

+ + + + + + + + + + + + + + + + + + + + + +
Methods in com.threerings.micasa.lobby with parameters of type LobbyService.LobbiesListener
+ voidLobbyRegistry.getLobbies(com.threerings.presents.data.ClientObject caller, + String category, + LobbyService.LobbiesListener listener) + +
+          Processes a request by the client to obtain a list of lobbies matching the supplied category + string.
+ voidLobbyProvider.getLobbies(com.threerings.presents.data.ClientObject caller, + String arg1, + LobbyService.LobbiesListener arg2) + +
+          Handles a LobbyService.getLobbies(java.lang.String, com.threerings.micasa.lobby.LobbyService.LobbiesListener) request.
+ voidLobbyService.getLobbies(String category, + LobbyService.LobbiesListener listener) + +
+          Requests information on all active lobbies that match the specified category.
+ voidLobbyMarshaller.getLobbies(String arg1, + LobbyService.LobbiesListener arg2) + +
+           
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/lobby/class-use/LobbyService.html b/apidocs/com/threerings/micasa/lobby/class-use/LobbyService.html new file mode 100644 index 00000000..566c18ae --- /dev/null +++ b/apidocs/com/threerings/micasa/lobby/class-use/LobbyService.html @@ -0,0 +1,183 @@ + + + + + + + +Uses of Interface com.threerings.micasa.lobby.LobbyService (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.micasa.lobby.LobbyService

+
+ + + + + + + + + +
+Packages that use LobbyService
com.threerings.micasa.lobby  
+  +

+ + + + + +
+Uses of LobbyService in com.threerings.micasa.lobby
+  +

+ + + + + + + + + +
Classes in com.threerings.micasa.lobby that implement LobbyService
+ classLobbyMarshaller + +
+          Provides the implementation of the LobbyService interface + that marshalls the arguments and delivers the request to the provider + on the server.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/lobby/package-frame.html b/apidocs/com/threerings/micasa/lobby/package-frame.html new file mode 100644 index 00000000..1703a2fd --- /dev/null +++ b/apidocs/com/threerings/micasa/lobby/package-frame.html @@ -0,0 +1,70 @@ + + + + + + + +com.threerings.micasa.lobby (vilya 1.3 API) + + + + + + + + + + + +com.threerings.micasa.lobby + + + + +
+Interfaces  + +
+LobbyProvider +
+LobbyService +
+LobbyService.CategoriesListener +
+LobbyService.LobbiesListener
+ + + + + + +
+Classes  + +
+Lobby +
+LobbyConfig +
+LobbyController +
+LobbyManager +
+LobbyMarshaller +
+LobbyMarshaller.CategoriesMarshaller +
+LobbyMarshaller.LobbiesMarshaller +
+LobbyObject +
+LobbyPanel +
+LobbyRegistry +
+LobbySelector
+ + + + diff --git a/apidocs/com/threerings/micasa/lobby/package-summary.html b/apidocs/com/threerings/micasa/lobby/package-summary.html new file mode 100644 index 00000000..7653788a --- /dev/null +++ b/apidocs/com/threerings/micasa/lobby/package-summary.html @@ -0,0 +1,232 @@ + + + + + + + +com.threerings.micasa.lobby (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.micasa.lobby +

+ + + + + + + + + + + + + + + + + + + + + +
+Interface Summary
LobbyProviderDefines the server-side of the LobbyService.
LobbyServiceProvides an interface to the various parlor services that are directly + invokable by the client (by means of the invocation services).
LobbyService.CategoriesListenerUsed to communicate the results of a LobbyService.getCategories(com.threerings.micasa.lobby.LobbyService.CategoriesListener) request.
LobbyService.LobbiesListenerUsed to communicate the results of a LobbyService.getLobbies(java.lang.String, com.threerings.micasa.lobby.LobbyService.LobbiesListener) request.
+  + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Class Summary
LobbyA simple class for keeping track of information for each lobby in + operation on the server.
LobbyConfig 
LobbyController 
LobbyManagerTakes care of the server side of a particular lobby.
LobbyMarshallerProvides the implementation of the LobbyService interface + that marshalls the arguments and delivers the request to the provider + on the server.
LobbyMarshaller.CategoriesMarshallerMarshalls results to implementations of LobbyService.CategoriesListener.
LobbyMarshaller.LobbiesMarshallerMarshalls results to implementations of LobbyService.LobbiesListener.
LobbyObjectPresently the lobby object contains nothing specific, but the class + acts as a placeholder in case lobby-wide fields are needed in the + future.
LobbyPanelUsed to display the interface for the lobbies.
LobbyRegistryThe lobby registry is the primary class that coordinates the lobby services on the client.
LobbySelectorThe lobby selector displays a drop-down box listing the categories of + lobbies available on this server and when a category is selected, it + displays a list of the lobbies that are available in that category.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/lobby/package-tree.html b/apidocs/com/threerings/micasa/lobby/package-tree.html new file mode 100644 index 00000000..1bb353bc --- /dev/null +++ b/apidocs/com/threerings/micasa/lobby/package-tree.html @@ -0,0 +1,208 @@ + + + + + + + +com.threerings.micasa.lobby Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.micasa.lobby +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/lobby/package-use.html b/apidocs/com/threerings/micasa/lobby/package-use.html new file mode 100644 index 00000000..31c5afe5 --- /dev/null +++ b/apidocs/com/threerings/micasa/lobby/package-use.html @@ -0,0 +1,242 @@ + + + + + + + +Uses of Package com.threerings.micasa.lobby (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.micasa.lobby

+
+ + + + + + + + + + + + + +
+Packages that use com.threerings.micasa.lobby
com.threerings.micasa.lobby  
com.threerings.micasa.lobby.table  
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+Classes in com.threerings.micasa.lobby used by com.threerings.micasa.lobby
Lobby + +
+          A simple class for keeping track of information for each lobby in + operation on the server.
LobbyConfig + +
+           
LobbyProvider + +
+          Defines the server-side of the LobbyService.
LobbyRegistry + +
+          The lobby registry is the primary class that coordinates the lobby services on the client.
LobbyService + +
+          Provides an interface to the various parlor services that are directly + invokable by the client (by means of the invocation services).
LobbyService.CategoriesListener + +
+          Used to communicate the results of a LobbyService.getCategories(com.threerings.micasa.lobby.LobbyService.CategoriesListener) request.
LobbyService.LobbiesListener + +
+          Used to communicate the results of a LobbyService.getLobbies(java.lang.String, com.threerings.micasa.lobby.LobbyService.LobbiesListener) request.
+  +

+ + + + + + + + + + + + + + +
+Classes in com.threerings.micasa.lobby used by com.threerings.micasa.lobby.table
LobbyConfig + +
+           
LobbyManager + +
+          Takes care of the server side of a particular lobby.
LobbyObject + +
+          Presently the lobby object contains nothing specific, but the class + acts as a placeholder in case lobby-wide fields are needed in the + future.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/lobby/table/TableItem.html b/apidocs/com/threerings/micasa/lobby/table/TableItem.html new file mode 100644 index 00000000..cda57c19 --- /dev/null +++ b/apidocs/com/threerings/micasa/lobby/table/TableItem.html @@ -0,0 +1,485 @@ + + + + + + + +TableItem (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.micasa.lobby.table +
+Class TableItem

+
+java.lang.Object
+  extended by java.awt.Component
+      extended by java.awt.Container
+          extended by javax.swing.JComponent
+              extended by javax.swing.JPanel
+                  extended by com.threerings.micasa.lobby.table.TableItem
+
+
+
All Implemented Interfaces:
SeatednessObserver, ActionListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible
+
+
+
+
public class TableItem
extends JPanel
implements ActionListener, SeatednessObserver
+ + +

+A table item displays the user interface for a single table (whether it + be in-play or still being matchmade). +

+ +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent
+  + + + + + + + + +
Nested classes/interfaces inherited from class java.awt.Component
Component.BaselineResizeBehavior
+  + + + + + + + + + + + +
+Field Summary
+ Tabletable + +
+          A reference to the table we are displaying.
+  + + + + + + + +
Fields inherited from class javax.swing.JComponent
TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
+  + + + + + + + +
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
+  + + + + + + + +
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
+  + + + + + + + + + + +
+Constructor Summary
TableItem(MiCasaContext ctx, + TableDirector tdtr, + Table table) + +
+          Creates a new table item to display and interact with the supplied + table.
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidactionPerformed(ActionEvent event) + +
+           
+ voidseatednessDidChange(boolean isSeated) + +
+          Called when this client sits down at or stands up from a table.
+ voidtableRemoved() + +
+          Called by the table list view prior to removing us.
+ voidtableUpdated(Table table) + +
+          Called when our table has been updated and we need to update the UI + to reflect the new information.
+  + + + + + + + +
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, setUI, updateUI
+  + + + + + + + +
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
+  + + + + + + + +
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate
+  + + + + + + + +
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+table

+
+public Table table
+
+
A reference to the table we are displaying. +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+TableItem

+
+public TableItem(MiCasaContext ctx,
+                 TableDirector tdtr,
+                 Table table)
+
+
Creates a new table item to display and interact with the supplied + table. +

+

+ + + + + + + + +
+Method Detail
+ +

+tableUpdated

+
+public void tableUpdated(Table table)
+
+
Called when our table has been updated and we need to update the UI + to reflect the new information. +

+

+
+
+
+
+
+
+
+ +

+tableRemoved

+
+public void tableRemoved()
+
+
Called by the table list view prior to removing us. Here we clean + up. +

+

+
+
+
+
+
+
+
+ +

+actionPerformed

+
+public void actionPerformed(ActionEvent event)
+
+
+
Specified by:
actionPerformed in interface ActionListener
+
+
+
+
+
+
+ +

+seatednessDidChange

+
+public void seatednessDidChange(boolean isSeated)
+
+
Description copied from interface: SeatednessObserver
+
Called when this client sits down at or stands up from a table. +

+

+
Specified by:
seatednessDidChange in interface SeatednessObserver
+
+
+
Parameters:
isSeated - true if the client is now seated at a table, false + if they are now no longer seated at a table.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/lobby/table/TableListView.html b/apidocs/com/threerings/micasa/lobby/table/TableListView.html new file mode 100644 index 00000000..83d2dff0 --- /dev/null +++ b/apidocs/com/threerings/micasa/lobby/table/TableListView.html @@ -0,0 +1,527 @@ + + + + + + + +TableListView (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.micasa.lobby.table +
+Class TableListView

+
+java.lang.Object
+  extended by java.awt.Component
+      extended by java.awt.Container
+          extended by javax.swing.JComponent
+              extended by javax.swing.JPanel
+                  extended by com.threerings.micasa.lobby.table.TableListView
+
+
+
All Implemented Interfaces:
com.threerings.crowd.client.PlaceView, SeatednessObserver, TableObserver, ActionListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible
+
+
+
+
public class TableListView
extends JPanel
implements com.threerings.crowd.client.PlaceView, TableObserver, ActionListener, SeatednessObserver
+ + +

+A view that displays the tables in a table lobby. It displays two + separate lists, one of tables being matchmade and another of games in + progress. These tables are updated dynamically as they proceed through + the matchmaking process. UI mechanisms for creating and joining tables + are also provided. +

+ +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent
+  + + + + + + + + +
Nested classes/interfaces inherited from class java.awt.Component
Component.BaselineResizeBehavior
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class javax.swing.JComponent
TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
+  + + + + + + + +
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
+  + + + + + + + +
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
+  + + + + + + + + + + +
+Constructor Summary
TableListView(MiCasaContext ctx, + LobbyConfig config) + +
+          Creates a new table list view, suitable for providing the user + interface for table-style matchmaking in a table lobby.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidactionPerformed(ActionEvent event) + +
+           
+ voiddidLeavePlace(com.threerings.crowd.data.PlaceObject place) + +
+           
+ voidseatednessDidChange(boolean isSeated) + +
+          Called when this client sits down at or stands up from a table.
+ voidtableAdded(Table table) + +
+          Called when a new table is created.
+ voidtableRemoved(int tableId) + +
+          Called when a table goes away.
+ voidtableUpdated(Table table) + +
+          Called when something has changed about a table (occupant list + updated, state changed from matchmaking to in-play, etc.).
+ voidwillEnterPlace(com.threerings.crowd.data.PlaceObject place) + +
+           
+  + + + + + + + +
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, setUI, updateUI
+  + + + + + + + +
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
+  + + + + + + + +
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate
+  + + + + + + + +
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+TableListView

+
+public TableListView(MiCasaContext ctx,
+                     LobbyConfig config)
+
+
Creates a new table list view, suitable for providing the user + interface for table-style matchmaking in a table lobby. +

+

+ + + + + + + + +
+Method Detail
+ +

+willEnterPlace

+
+public void willEnterPlace(com.threerings.crowd.data.PlaceObject place)
+
+
+
Specified by:
willEnterPlace in interface com.threerings.crowd.client.PlaceView
+
+
+
+
+
+
+ +

+didLeavePlace

+
+public void didLeavePlace(com.threerings.crowd.data.PlaceObject place)
+
+
+
Specified by:
didLeavePlace in interface com.threerings.crowd.client.PlaceView
+
+
+
+
+
+
+ +

+tableAdded

+
+public void tableAdded(Table table)
+
+
Description copied from interface: TableObserver
+
Called when a new table is created. +

+

+
Specified by:
tableAdded in interface TableObserver
+
+
+
+
+
+
+ +

+tableUpdated

+
+public void tableUpdated(Table table)
+
+
Description copied from interface: TableObserver
+
Called when something has changed about a table (occupant list + updated, state changed from matchmaking to in-play, etc.). +

+

+
Specified by:
tableUpdated in interface TableObserver
+
+
+
+
+
+
+ +

+tableRemoved

+
+public void tableRemoved(int tableId)
+
+
Description copied from interface: TableObserver
+
Called when a table goes away. +

+

+
Specified by:
tableRemoved in interface TableObserver
+
+
+
+
+
+
+ +

+actionPerformed

+
+public void actionPerformed(ActionEvent event)
+
+
+
Specified by:
actionPerformed in interface ActionListener
+
+
+
+
+
+
+ +

+seatednessDidChange

+
+public void seatednessDidChange(boolean isSeated)
+
+
Description copied from interface: SeatednessObserver
+
Called when this client sits down at or stands up from a table. +

+

+
Specified by:
seatednessDidChange in interface SeatednessObserver
+
+
+
Parameters:
isSeated - true if the client is now seated at a table, false + if they are now no longer seated at a table.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/lobby/table/TableLobbyConfig.html b/apidocs/com/threerings/micasa/lobby/table/TableLobbyConfig.html new file mode 100644 index 00000000..43c8318b --- /dev/null +++ b/apidocs/com/threerings/micasa/lobby/table/TableLobbyConfig.html @@ -0,0 +1,340 @@ + + + + + + + +TableLobbyConfig (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.micasa.lobby.table +
+Class TableLobbyConfig

+
+java.lang.Object
+  extended by com.threerings.io.SimpleStreamableObject
+      extended by com.threerings.crowd.data.PlaceConfig
+          extended by com.threerings.micasa.lobby.LobbyConfig
+              extended by com.threerings.micasa.lobby.table.TableLobbyConfig
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable
+
+
+
+
public class TableLobbyConfig
extends LobbyConfig
+ + +

+Instructs the lobby services to use a TableListView as the + matchmaking component. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + +
+Constructor Summary
TableLobbyConfig() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ JComponentcreateMatchMakingView(MiCasaContext ctx) + +
+          Derived classes override this function and create the appropriate + matchmaking user interface component.
+ StringgetManagerClassName() + +
+           
+  + + + + + + + +
Methods inherited from class com.threerings.micasa.lobby.LobbyConfig
createController, getGameConfig, init
+  + + + + + + + +
Methods inherited from class com.threerings.crowd.data.PlaceConfig
getControllerClass
+  + + + + + + + +
Methods inherited from class com.threerings.io.SimpleStreamableObject
toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+TableLobbyConfig

+
+public TableLobbyConfig()
+
+
+ + + + + + + + +
+Method Detail
+ +

+getManagerClassName

+
+public String getManagerClassName()
+
+
+
Overrides:
getManagerClassName in class LobbyConfig
+
+
+
+
+
+
+ +

+createMatchMakingView

+
+public JComponent createMatchMakingView(MiCasaContext ctx)
+
+
Description copied from class: LobbyConfig
+
Derived classes override this function and create the appropriate + matchmaking user interface component. +

+

+
Overrides:
createMatchMakingView in class LobbyConfig
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/lobby/table/TableLobbyManager.html b/apidocs/com/threerings/micasa/lobby/table/TableLobbyManager.html new file mode 100644 index 00000000..b4091415 --- /dev/null +++ b/apidocs/com/threerings/micasa/lobby/table/TableLobbyManager.html @@ -0,0 +1,271 @@ + + + + + + + +TableLobbyManager (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.micasa.lobby.table +
+Class TableLobbyManager

+
+java.lang.Object
+  extended by com.threerings.crowd.server.PlaceManager
+      extended by com.threerings.micasa.lobby.LobbyManager
+          extended by com.threerings.micasa.lobby.table.TableLobbyManager
+
+
+
All Implemented Interfaces:
com.threerings.crowd.chat.server.SpeakHandler.SpeakerValidator, com.threerings.presents.dobj.ChangeListener, com.threerings.presents.dobj.MessageListener
+
+
+
+
public class TableLobbyManager
extends LobbyManager
+ + +

+Extends lobby manager only to ensure that a table lobby object is used for table lobbies. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.crowd.server.PlaceManager
com.threerings.crowd.server.PlaceManager.DelegateOp, com.threerings.crowd.server.PlaceManager.MessageHandler
+  + + + + + + + + + + + +
+Constructor Summary
TableLobbyManager() + +
+           
+  + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from class com.threerings.micasa.lobby.LobbyManager
init
+  + + + + + + + +
Methods inherited from class com.threerings.crowd.server.PlaceManager
addDelegate, applyToDelegates, applyToOccupants, bodyWillEnter, bodyWillLeave, checkPermissions, getConfig, getLocation, getPlaceObject, init, isValidSpeaker, messageReceived, ratifyBodyEntry, registerMessageHandler, shutdown, startup, toString, updateOccupantInfo, where
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+TableLobbyManager

+
+public TableLobbyManager()
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/lobby/table/TableLobbyObject.html b/apidocs/com/threerings/micasa/lobby/table/TableLobbyObject.html new file mode 100644 index 00000000..f43122dd --- /dev/null +++ b/apidocs/com/threerings/micasa/lobby/table/TableLobbyObject.html @@ -0,0 +1,689 @@ + + + + + + + +TableLobbyObject (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.micasa.lobby.table +
+Class TableLobbyObject

+
+java.lang.Object
+  extended by com.threerings.presents.dobj.DObject
+      extended by com.threerings.crowd.data.PlaceObject
+          extended by com.threerings.micasa.lobby.LobbyObject
+              extended by com.threerings.micasa.lobby.table.TableLobbyObject
+
+
+
All Implemented Interfaces:
com.threerings.crowd.chat.data.SpeakObject, com.threerings.io.Streamable, TableLobbyObject
+
+
+
+
public class TableLobbyObject
extends LobbyObject
implements TableLobbyObject
+ + +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.crowd.data.PlaceObject
com.threerings.crowd.data.PlaceObject.ManagerCaller
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.crowd.chat.data.SpeakObject
com.threerings.crowd.chat.data.SpeakObject.ListenerOp
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static StringTABLE_SERVICE + +
+          The field name of the tableService field.
+static StringTABLE_SET + +
+          The field name of the tableSet field.
+ TableMarshallertableService + +
+          Handles our table services.
+ com.threerings.presents.dobj.DSet<Table>tableSet + +
+          A set containing all of the tables being managed by this lobby.
+  + + + + + + + +
Fields inherited from class com.threerings.crowd.data.PlaceObject
manager, OCCUPANT_INFO, occupantInfo, occupants, OCCUPANTS, SPEAK_SERVICE, speakService
+  + + + + + + + + + + +
+Constructor Summary
TableLobbyObject() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidaddToTables(Table table) + +
+          Adds the supplied table instance to the tables set (using the + appropriate distributed object mechanisms).
+ voidaddToTableSet(Table elem) + +
+          Requests that the specified entry be added to the + tableSet set.
+ com.threerings.presents.dobj.DSet<Table>getTables() + +
+          Returns a reference to the distributed set instance that will be + holding the tables.
+ TableMarshallergetTableService() + +
+          Returns a reference to the table service configured in this object.
+ voidremoveFromTables(Comparable<?> key) + +
+          Removes the table instance that matches the specified key from the + tables set (using the appropriate distributed object mechanisms).
+ voidremoveFromTableSet(Comparable<?> key) + +
+          Requests that the entry matching the supplied key be removed from + the tableSet set.
+ voidsetTableService(TableMarshaller value) + +
+          Requests that the tableService field be set to the + specified value.
+ voidsetTableSet(com.threerings.presents.dobj.DSet<Table> value) + +
+          Requests that the tableSet field be set to the + specified value.
+ voidupdateTables(Table table) + +
+          Updates the value of the specified table instance in the tables + distributed set (using the appropriate distributed object + mechanisms).
+ voidupdateTableSet(Table elem) + +
+          Requests that the specified entry be updated in the + tableSet set.
+  + + + + + + + +
Methods inherited from class com.threerings.crowd.data.PlaceObject
addToOccupantInfo, addToOccupants, applyToListeners, getOccupantInfo, initManagerCaller, removeFromOccupantInfo, removeFromOccupants, setOccupantInfo, setSpeakService, shouldBroadcast, updateOccupantInfo
+  + + + + + + + +
Methods inherited from class com.threerings.presents.dobj.DObject
acquireLock, addListener, addListener, addSubscriber, addToSet, cancelTransaction, changeAttribute, checkPermissions, checkPermissions, commitTransaction, destroy, getAccessController, getAttribute, getLocal, getLocals, getManager, getOid, getSet, inTransaction, isActive, notifyListeners, notifyProxies, postEvent, postMessage, postMessage, readField__oid, releaseLock, removeFromSet, removeListener, removeSubscriber, setAccessController, setAttribute, setDestroyOnLastSubscriberRemoved, setLocal, setManager, setOid, startTransaction, toString, updateSet, which, writeField__oid
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+TABLE_SET

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public static final String TABLE_SET
+
+
The field name of the tableSet field. +

+

+
See Also:
Constant Field Values
+
+
+ +

+TABLE_SERVICE

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public static final String TABLE_SERVICE
+
+
The field name of the tableService field. +

+

+
See Also:
Constant Field Values
+
+
+ +

+tableSet

+
+public com.threerings.presents.dobj.DSet<Table> tableSet
+
+
A set containing all of the tables being managed by this lobby. +

+

+
+
+
+ +

+tableService

+
+public TableMarshaller tableService
+
+
Handles our table services. +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+TableLobbyObject

+
+public TableLobbyObject()
+
+
+ + + + + + + + +
+Method Detail
+ +

+getTables

+
+public com.threerings.presents.dobj.DSet<Table> getTables()
+
+
Description copied from interface: TableLobbyObject
+
Returns a reference to the distributed set instance that will be + holding the tables. +

+

+
Specified by:
getTables in interface TableLobbyObject
+
+
+
+
+
+
+ +

+addToTables

+
+public void addToTables(Table table)
+
+
Description copied from interface: TableLobbyObject
+
Adds the supplied table instance to the tables set (using the + appropriate distributed object mechanisms). +

+

+
Specified by:
addToTables in interface TableLobbyObject
+
+
+
+
+
+
+ +

+updateTables

+
+public void updateTables(Table table)
+
+
Description copied from interface: TableLobbyObject
+
Updates the value of the specified table instance in the tables + distributed set (using the appropriate distributed object + mechanisms). +

+

+
Specified by:
updateTables in interface TableLobbyObject
+
+
+
+
+
+
+ +

+removeFromTables

+
+public void removeFromTables(Comparable<?> key)
+
+
Description copied from interface: TableLobbyObject
+
Removes the table instance that matches the specified key from the + tables set (using the appropriate distributed object mechanisms). +

+

+
Specified by:
removeFromTables in interface TableLobbyObject
+
+
+
+
+
+
+ +

+getTableService

+
+public TableMarshaller getTableService()
+
+
Description copied from interface: TableLobbyObject
+
Returns a reference to the table service configured in this object. +

+

+
Specified by:
getTableService in interface TableLobbyObject
+
+
+
+
+
+
+ +

+addToTableSet

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public void addToTableSet(Table elem)
+
+
Requests that the specified entry be added to the + tableSet set. The set will not change until the event is + actually propagated through the system. +

+

+
+
+
+
+
+
+
+ +

+removeFromTableSet

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public void removeFromTableSet(Comparable<?> key)
+
+
Requests that the entry matching the supplied key be removed from + the tableSet set. The set will not change until the + event is actually propagated through the system. +

+

+
+
+
+
+
+
+
+ +

+updateTableSet

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public void updateTableSet(Table elem)
+
+
Requests that the specified entry be updated in the + tableSet set. The set will not change until the event is + actually propagated through the system. +

+

+
+
+
+
+
+
+
+ +

+setTableSet

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public void setTableSet(com.threerings.presents.dobj.DSet<Table> value)
+
+
Requests that the tableSet field be set to the + specified value. Generally one only adds, updates and removes + entries of a distributed set, but certain situations call for a + complete replacement of the set value. The local value will be + updated immediately and an event will be propagated through the + system to notify all listeners that the attribute did + change. Proxied copies of this object (on clients) will apply the + value change when they received the attribute changed notification. +

+

+
+
+
+
+
+
+
+ +

+setTableService

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public void setTableService(TableMarshaller value)
+
+
Requests that the tableService field be set to the + specified value. The local value will be updated immediately and an + event will be propagated through the system to notify all listeners + that the attribute did change. Proxied copies of this object (on + clients) will apply the value change when they received the + attribute changed notification. +

+

+
Specified by:
setTableService in interface TableLobbyObject
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/lobby/table/class-use/TableItem.html b/apidocs/com/threerings/micasa/lobby/table/class-use/TableItem.html new file mode 100644 index 00000000..c367cc2c --- /dev/null +++ b/apidocs/com/threerings/micasa/lobby/table/class-use/TableItem.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.micasa.lobby.table.TableItem (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.micasa.lobby.table.TableItem

+
+No usage of com.threerings.micasa.lobby.table.TableItem +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/lobby/table/class-use/TableListView.html b/apidocs/com/threerings/micasa/lobby/table/class-use/TableListView.html new file mode 100644 index 00000000..c8454154 --- /dev/null +++ b/apidocs/com/threerings/micasa/lobby/table/class-use/TableListView.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.micasa.lobby.table.TableListView (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.micasa.lobby.table.TableListView

+
+No usage of com.threerings.micasa.lobby.table.TableListView +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/lobby/table/class-use/TableLobbyConfig.html b/apidocs/com/threerings/micasa/lobby/table/class-use/TableLobbyConfig.html new file mode 100644 index 00000000..d45439d9 --- /dev/null +++ b/apidocs/com/threerings/micasa/lobby/table/class-use/TableLobbyConfig.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.micasa.lobby.table.TableLobbyConfig (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.micasa.lobby.table.TableLobbyConfig

+
+No usage of com.threerings.micasa.lobby.table.TableLobbyConfig +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/lobby/table/class-use/TableLobbyManager.html b/apidocs/com/threerings/micasa/lobby/table/class-use/TableLobbyManager.html new file mode 100644 index 00000000..f238b3d3 --- /dev/null +++ b/apidocs/com/threerings/micasa/lobby/table/class-use/TableLobbyManager.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.micasa.lobby.table.TableLobbyManager (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.micasa.lobby.table.TableLobbyManager

+
+No usage of com.threerings.micasa.lobby.table.TableLobbyManager +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/lobby/table/class-use/TableLobbyObject.html b/apidocs/com/threerings/micasa/lobby/table/class-use/TableLobbyObject.html new file mode 100644 index 00000000..612eec70 --- /dev/null +++ b/apidocs/com/threerings/micasa/lobby/table/class-use/TableLobbyObject.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.micasa.lobby.table.TableLobbyObject (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.micasa.lobby.table.TableLobbyObject

+
+No usage of com.threerings.micasa.lobby.table.TableLobbyObject +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/lobby/table/package-frame.html b/apidocs/com/threerings/micasa/lobby/table/package-frame.html new file mode 100644 index 00000000..b8b8ce90 --- /dev/null +++ b/apidocs/com/threerings/micasa/lobby/table/package-frame.html @@ -0,0 +1,41 @@ + + + + + + + +com.threerings.micasa.lobby.table (vilya 1.3 API) + + + + + + + + + + + +com.threerings.micasa.lobby.table + + + + +
+Classes  + +
+TableItem +
+TableListView +
+TableLobbyConfig +
+TableLobbyManager +
+TableLobbyObject
+ + + + diff --git a/apidocs/com/threerings/micasa/lobby/table/package-summary.html b/apidocs/com/threerings/micasa/lobby/table/package-summary.html new file mode 100644 index 00000000..5bc17f0d --- /dev/null +++ b/apidocs/com/threerings/micasa/lobby/table/package-summary.html @@ -0,0 +1,176 @@ + + + + + + + +com.threerings.micasa.lobby.table (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.micasa.lobby.table +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
+Class Summary
TableItemA table item displays the user interface for a single table (whether it + be in-play or still being matchmade).
TableListViewA view that displays the tables in a table lobby.
TableLobbyConfigInstructs the lobby services to use a TableListView as the + matchmaking component.
TableLobbyManagerExtends lobby manager only to ensure that a table lobby object is used for table lobbies.
TableLobbyObject 
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/lobby/table/package-tree.html b/apidocs/com/threerings/micasa/lobby/table/package-tree.html new file mode 100644 index 00000000..f909b8c5 --- /dev/null +++ b/apidocs/com/threerings/micasa/lobby/table/package-tree.html @@ -0,0 +1,188 @@ + + + + + + + +com.threerings.micasa.lobby.table Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.micasa.lobby.table +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/lobby/table/package-use.html b/apidocs/com/threerings/micasa/lobby/table/package-use.html new file mode 100644 index 00000000..8047ede5 --- /dev/null +++ b/apidocs/com/threerings/micasa/lobby/table/package-use.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Package com.threerings.micasa.lobby.table (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.micasa.lobby.table

+
+No usage of com.threerings.micasa.lobby.table +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/package-frame.html b/apidocs/com/threerings/micasa/package-frame.html new file mode 100644 index 00000000..e59b3c11 --- /dev/null +++ b/apidocs/com/threerings/micasa/package-frame.html @@ -0,0 +1,33 @@ + + + + + + + +com.threerings.micasa (vilya 1.3 API) + + + + + + + + + + + +com.threerings.micasa + + + + +
+Classes  + +
+Log
+ + + + diff --git a/apidocs/com/threerings/micasa/package-summary.html b/apidocs/com/threerings/micasa/package-summary.html new file mode 100644 index 00000000..00d6bcfc --- /dev/null +++ b/apidocs/com/threerings/micasa/package-summary.html @@ -0,0 +1,158 @@ + + + + + + + +com.threerings.micasa (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.micasa +

+ + + + + + + + + +
+Class Summary
LogContains a reference to the log object used by the MiCasa package.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/package-tree.html b/apidocs/com/threerings/micasa/package-tree.html new file mode 100644 index 00000000..105aac13 --- /dev/null +++ b/apidocs/com/threerings/micasa/package-tree.html @@ -0,0 +1,154 @@ + + + + + + + +com.threerings.micasa Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.micasa +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/package-use.html b/apidocs/com/threerings/micasa/package-use.html new file mode 100644 index 00000000..ae266e37 --- /dev/null +++ b/apidocs/com/threerings/micasa/package-use.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Package com.threerings.micasa (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.micasa

+
+No usage of com.threerings.micasa +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/server/MiCasaConfig.html b/apidocs/com/threerings/micasa/server/MiCasaConfig.html new file mode 100644 index 00000000..fcd2c423 --- /dev/null +++ b/apidocs/com/threerings/micasa/server/MiCasaConfig.html @@ -0,0 +1,267 @@ + + + + + + + +MiCasaConfig (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.micasa.server +
+Class MiCasaConfig

+
+java.lang.Object
+  extended by com.threerings.micasa.server.MiCasaConfig
+
+
+
+
public class MiCasaConfig
extends Object
+ + +

+Provides access to the MiCasa server configuration. +

+ +

+

+ +

+ + + + + + + + + + + +
+Field Summary
+static Configconfig + +
+          Provides access to configuration data for this package.
+  + + + + + + + + + + +
+Constructor Summary
MiCasaConfig() + +
+           
+  + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+config

+
+public static Config config
+
+
Provides access to configuration data for this package. +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+MiCasaConfig

+
+public MiCasaConfig()
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/server/MiCasaServer.html b/apidocs/com/threerings/micasa/server/MiCasaServer.html new file mode 100644 index 00000000..78feec96 --- /dev/null +++ b/apidocs/com/threerings/micasa/server/MiCasaServer.html @@ -0,0 +1,343 @@ + + + + + + + +MiCasaServer (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.micasa.server +
+Class MiCasaServer

+
+java.lang.Object
+  extended by com.threerings.presents.server.PresentsServer
+      extended by com.threerings.crowd.server.CrowdServer
+          extended by com.threerings.micasa.server.MiCasaServer
+
+
+
Direct Known Subclasses:
SimpleServer
+
+
+
+
public class MiCasaServer
extends com.threerings.crowd.server.CrowdServer
+ + +

+The main general organizer of everything that goes on in the MiCasa game server process. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.crowd.server.CrowdServer
com.threerings.crowd.server.CrowdServer.CrowdModule
+  + + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.presents.server.PresentsServer
com.threerings.presents.server.PresentsServer.PresentsModule, com.threerings.presents.server.PresentsServer.PresentsServerModule
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class com.threerings.presents.server.PresentsServer
invmgr, omgr
+  + + + + + + + + + + +
+Constructor Summary
MiCasaServer() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ voidinit(com.google.inject.Injector injector) + +
+           
+static voidmain(String[] args) + +
+           
+  + + + + + + + +
Methods inherited from class com.threerings.presents.server.PresentsServer
queueShutdown, run, runServer
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+MiCasaServer

+
+public MiCasaServer()
+
+
+ + + + + + + + +
+Method Detail
+ +

+main

+
+public static void main(String[] args)
+
+
+
+
+
+
+ +

+init

+
+public void init(com.google.inject.Injector injector)
+          throws Exception
+
+
+
Overrides:
init in class com.threerings.crowd.server.CrowdServer
+
+
+ +
Throws: +
Exception
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/server/MiCasaSession.html b/apidocs/com/threerings/micasa/server/MiCasaSession.html new file mode 100644 index 00000000..17cbe6dc --- /dev/null +++ b/apidocs/com/threerings/micasa/server/MiCasaSession.html @@ -0,0 +1,262 @@ + + + + + + + +MiCasaSession (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.micasa.server +
+Class MiCasaSession

+
+java.lang.Object
+  extended by com.threerings.presents.server.PresentsSession
+      extended by com.threerings.crowd.server.CrowdSession
+          extended by com.threerings.micasa.server.MiCasaSession
+
+
+
All Implemented Interfaces:
com.threerings.presents.server.ClientResolutionListener, com.threerings.presents.server.net.PresentsConnection.MessageHandler
+
+
+
+
public class MiCasaSession
extends com.threerings.crowd.server.CrowdSession
+ + +

+Extends the Crowd session and provides bootstrap data specific to the MiCasa services. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.presents.server.PresentsSession
com.threerings.presents.server.PresentsSession.UserChangeListener
+  + + + + + + + + + + + +
+Constructor Summary
MiCasaSession() + +
+           
+  + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from class com.threerings.presents.server.PresentsSession
checkExpired, clientResolved, endSession, getAuthName, getClientObject, getCredentials, getInetAddress, getNetworkStamp, getSecret, getSessionStamp, getTimeZone, getTransmitDatagrams, handleMessage, resolutionFailed, setClassLoader, setIncomingMessageThrottle, setUsername, shutdown, toString, updateUsername
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+MiCasaSession

+
+public MiCasaSession()
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/server/class-use/MiCasaConfig.html b/apidocs/com/threerings/micasa/server/class-use/MiCasaConfig.html new file mode 100644 index 00000000..a7f08068 --- /dev/null +++ b/apidocs/com/threerings/micasa/server/class-use/MiCasaConfig.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.micasa.server.MiCasaConfig (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.micasa.server.MiCasaConfig

+
+No usage of com.threerings.micasa.server.MiCasaConfig +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/server/class-use/MiCasaServer.html b/apidocs/com/threerings/micasa/server/class-use/MiCasaServer.html new file mode 100644 index 00000000..2a320011 --- /dev/null +++ b/apidocs/com/threerings/micasa/server/class-use/MiCasaServer.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class com.threerings.micasa.server.MiCasaServer (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.micasa.server.MiCasaServer

+
+ + + + + + + + + +
+Packages that use MiCasaServer
com.threerings.micasa.simulator.server  
+  +

+ + + + + +
+Uses of MiCasaServer in com.threerings.micasa.simulator.server
+  +

+ + + + + + + + + +
Subclasses of MiCasaServer in com.threerings.micasa.simulator.server
+ classSimpleServer + +
+          A simple simulator server implementation that extends the MiCasa server.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/server/class-use/MiCasaSession.html b/apidocs/com/threerings/micasa/server/class-use/MiCasaSession.html new file mode 100644 index 00000000..07160d7d --- /dev/null +++ b/apidocs/com/threerings/micasa/server/class-use/MiCasaSession.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.micasa.server.MiCasaSession (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.micasa.server.MiCasaSession

+
+No usage of com.threerings.micasa.server.MiCasaSession +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/server/package-frame.html b/apidocs/com/threerings/micasa/server/package-frame.html new file mode 100644 index 00000000..ba4a3580 --- /dev/null +++ b/apidocs/com/threerings/micasa/server/package-frame.html @@ -0,0 +1,37 @@ + + + + + + + +com.threerings.micasa.server (vilya 1.3 API) + + + + + + + + + + + +com.threerings.micasa.server + + + + +
+Classes  + +
+MiCasaConfig +
+MiCasaServer +
+MiCasaSession
+ + + + diff --git a/apidocs/com/threerings/micasa/server/package-summary.html b/apidocs/com/threerings/micasa/server/package-summary.html new file mode 100644 index 00000000..8590810f --- /dev/null +++ b/apidocs/com/threerings/micasa/server/package-summary.html @@ -0,0 +1,166 @@ + + + + + + + +com.threerings.micasa.server (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.micasa.server +

+ + + + + + + + + + + + + + + + + +
+Class Summary
MiCasaConfigProvides access to the MiCasa server configuration.
MiCasaServerThe main general organizer of everything that goes on in the MiCasa game server process.
MiCasaSessionExtends the Crowd session and provides bootstrap data specific to the MiCasa services.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/server/package-tree.html b/apidocs/com/threerings/micasa/server/package-tree.html new file mode 100644 index 00000000..1aebc901 --- /dev/null +++ b/apidocs/com/threerings/micasa/server/package-tree.html @@ -0,0 +1,163 @@ + + + + + + + +com.threerings.micasa.server Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.micasa.server +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/server/package-use.html b/apidocs/com/threerings/micasa/server/package-use.html new file mode 100644 index 00000000..85025b5a --- /dev/null +++ b/apidocs/com/threerings/micasa/server/package-use.html @@ -0,0 +1,171 @@ + + + + + + + +Uses of Package com.threerings.micasa.server (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.micasa.server

+
+ + + + + + + + + +
+Packages that use com.threerings.micasa.server
com.threerings.micasa.simulator.server  
+  +

+ + + + + + + + +
+Classes in com.threerings.micasa.server used by com.threerings.micasa.simulator.server
MiCasaServer + +
+          The main general organizer of everything that goes on in the MiCasa game server process.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/simulator/client/SimpleClient.html b/apidocs/com/threerings/micasa/simulator/client/SimpleClient.html new file mode 100644 index 00000000..fff9eac0 --- /dev/null +++ b/apidocs/com/threerings/micasa/simulator/client/SimpleClient.html @@ -0,0 +1,267 @@ + + + + + + + +SimpleClient (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.micasa.simulator.client +
+Class SimpleClient

+
+java.lang.Object
+  extended by com.threerings.micasa.simulator.client.SimpleClient
+
+
+
All Implemented Interfaces:
SimulatorClient
+
+
+
+
public class SimpleClient
extends Object
implements SimulatorClient
+ + +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
SimpleClient(SimulatorFrame frame) + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ ParlorContextgetParlorContext() + +
+          Returns a reference to the context in effect for this client.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+SimpleClient

+
+public SimpleClient(SimulatorFrame frame)
+             throws IOException
+
+
+ +
Throws: +
IOException
+
+ + + + + + + + +
+Method Detail
+ +

+getParlorContext

+
+public ParlorContext getParlorContext()
+
+
Returns a reference to the context in effect for this client. This + reference is valid for the lifetime of the application. +

+

+
Specified by:
getParlorContext in interface SimulatorClient
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/simulator/client/SimpleFrame.html b/apidocs/com/threerings/micasa/simulator/client/SimpleFrame.html new file mode 100644 index 00000000..ab7ce8ee --- /dev/null +++ b/apidocs/com/threerings/micasa/simulator/client/SimpleFrame.html @@ -0,0 +1,432 @@ + + + + + + + +SimpleFrame (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.micasa.simulator.client +
+Class SimpleFrame

+
+java.lang.Object
+  extended by java.awt.Component
+      extended by java.awt.Container
+          extended by java.awt.Window
+              extended by java.awt.Frame
+                  extended by javax.swing.JFrame
+                      extended by com.threerings.micasa.client.MiCasaFrame
+                          extended by com.threerings.micasa.simulator.client.SimpleFrame
+
+
+
All Implemented Interfaces:
ControllerProvider, SimulatorFrame, ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants
+
+
+
+
public class SimpleFrame
extends MiCasaFrame
implements SimulatorFrame
+ + +

+Contains the user interface for the Simulator client application. +

+ +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class java.awt.Component
Component.BaselineResizeBehavior
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class javax.swing.JFrame
EXIT_ON_CLOSE
+  + + + + + + + +
Fields inherited from class java.awt.Frame
CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR
+  + + + + + + + +
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
+  + + + + + + + +
Fields inherited from interface javax.swing.WindowConstants
DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE
+  + + + + + + + +
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
+  + + + + + + + + + + +
+Constructor Summary
SimpleFrame() + +
+          Constructs the top-level Simulator client frame.
+  + + + + + + + + + + + +
+Method Summary
+ JFramegetFrame() + +
+          Returns a reference to the top-level frame that the simulator will + use to display everything.
+  + + + + + + + +
Methods inherited from class com.threerings.micasa.client.MiCasaFrame
getController, setController, setPanel
+  + + + + + + + +
Methods inherited from class javax.swing.JFrame
getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setTransferHandler, update
+  + + + + + + + +
Methods inherited from class java.awt.Frame
addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setResizable, setState, setTitle, setUndecorated
+  + + + + + + + +
Methods inherited from class java.awt.Window
addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOwnedWindows, getOwner, getOwnerlessWindows, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, paint, postEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setVisible, show, toBack, toFront
+  + + + + + + + +
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusBackward, transferFocusDownCycle, validate
+  + + + + + + + +
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, dispatchEvent, enable, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocusInWindow, resize, resize, setBackground, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusUpCycle
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  + + + + + + + +
Methods inherited from interface com.threerings.micasa.simulator.client.SimulatorFrame
setController, setPanel
+  + + + + + + + +
Methods inherited from interface com.samskivert.swing.ControllerProvider
getController
+  + + + + + + + +
Methods inherited from interface java.awt.MenuContainer
getFont, postEvent
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+SimpleFrame

+
+public SimpleFrame()
+
+
Constructs the top-level Simulator client frame. +

+

+ + + + + + + + +
+Method Detail
+ +

+getFrame

+
+public JFrame getFrame()
+
+
Description copied from interface: SimulatorFrame
+
Returns a reference to the top-level frame that the simulator will + use to display everything. +

+

+
Specified by:
getFrame in interface SimulatorFrame
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/simulator/client/SimulatorApp.html b/apidocs/com/threerings/micasa/simulator/client/SimulatorApp.html new file mode 100644 index 00000000..d644efcb --- /dev/null +++ b/apidocs/com/threerings/micasa/simulator/client/SimulatorApp.html @@ -0,0 +1,298 @@ + + + + + + + +SimulatorApp (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.micasa.simulator.client +
+Class SimulatorApp

+
+java.lang.Object
+  extended by com.threerings.micasa.simulator.client.SimulatorApp
+
+
+
+
public class SimulatorApp
extends Object
+ + +

+The simulator application is a test harness to facilitate development and debugging of games. +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
SimulatorApp() + +
+           
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+static voidmain(String[] args) + +
+           
+ voidrun() + +
+           
+ voidstart(String[] args) + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+SimulatorApp

+
+public SimulatorApp()
+
+
+ + + + + + + + +
+Method Detail
+ +

+start

+
+public void start(String[] args)
+           throws Exception
+
+
+ +
Throws: +
Exception
+
+
+
+ +

+run

+
+public void run()
+
+
+
+
+
+
+ +

+main

+
+public static void main(String[] args)
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/simulator/client/SimulatorClient.html b/apidocs/com/threerings/micasa/simulator/client/SimulatorClient.html new file mode 100644 index 00000000..a2df7054 --- /dev/null +++ b/apidocs/com/threerings/micasa/simulator/client/SimulatorClient.html @@ -0,0 +1,210 @@ + + + + + + + +SimulatorClient (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.micasa.simulator.client +
+Interface SimulatorClient

+
+
All Known Implementing Classes:
SimpleClient
+
+
+
+
public interface SimulatorClient
+ + +

+

+ +

+ + + + + + + + + + + + +
+Method Summary
+ ParlorContextgetParlorContext() + +
+           
+  +

+ + + + + + + + +
+Method Detail
+ +

+getParlorContext

+
+ParlorContext getParlorContext()
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/simulator/client/SimulatorController.html b/apidocs/com/threerings/micasa/simulator/client/SimulatorController.html new file mode 100644 index 00000000..240d3ffc --- /dev/null +++ b/apidocs/com/threerings/micasa/simulator/client/SimulatorController.html @@ -0,0 +1,437 @@ + + + + + + + +SimulatorController (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.micasa.simulator.client +
+Class SimulatorController

+
+java.lang.Object
+  extended by com.samskivert.swing.Controller
+      extended by com.threerings.micasa.simulator.client.SimulatorController
+
+
+
All Implemented Interfaces:
com.threerings.presents.client.SessionObserver, ActionListener, EventListener
+
+
+
+
public class SimulatorController
extends Controller
implements com.threerings.presents.client.SessionObserver
+ + +

+Responsible for top-level control of the simulator client user interface. +

+ +

+

+ +

+ + + + + + + + + + + +
+Field Summary
+static StringLOGOFF + +
+          Command constant used to logoff the client.
+  + + + + + + + +
Fields inherited from class com.samskivert.swing.Controller
DISPATCHER
+  + + + + + + + + + + +
+Constructor Summary
SimulatorController(ParlorContext ctx, + SimulatorFrame frame, + SimulatorInfo info) + +
+          Creates a new simulator controller.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidclientDidLogoff(com.threerings.presents.client.Client client) + +
+           
+ voidclientDidLogon(com.threerings.presents.client.Client client) + +
+           
+ voidclientObjectDidChange(com.threerings.presents.client.Client client) + +
+           
+ voidclientWillLogon(com.threerings.presents.client.Client client) + +
+           
+ voidcreateGame(com.threerings.presents.client.Client client) + +
+           
+ booleanhandleAction(ActionEvent action) + +
+           
+  + + + + + + + +
Methods inherited from class com.samskivert.swing.Controller
actionPerformed, configureAction, createActionButton, handleAction, handleAction, handleAction, postAction, postAction, postAction, setControlledPanel, wasAdded, wasRemoved
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+LOGOFF

+
+public static final String LOGOFF
+
+
Command constant used to logoff the client. +

+

+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Constructor Detail
+ +

+SimulatorController

+
+public SimulatorController(ParlorContext ctx,
+                           SimulatorFrame frame,
+                           SimulatorInfo info)
+
+
Creates a new simulator controller. The controller will set + everything up in preparation for logging on. +

+

+ + + + + + + + +
+Method Detail
+ +

+handleAction

+
+public boolean handleAction(ActionEvent action)
+
+
+
Overrides:
handleAction in class Controller
+
+
+
+
+
+
+ +

+clientWillLogon

+
+public void clientWillLogon(com.threerings.presents.client.Client client)
+
+
+
Specified by:
clientWillLogon in interface com.threerings.presents.client.SessionObserver
+
+
+
+
+
+
+ +

+clientDidLogon

+
+public void clientDidLogon(com.threerings.presents.client.Client client)
+
+
+
Specified by:
clientDidLogon in interface com.threerings.presents.client.SessionObserver
+
+
+
+
+
+
+ +

+createGame

+
+public void createGame(com.threerings.presents.client.Client client)
+
+
+
+
+
+
+
+
+
+ +

+clientObjectDidChange

+
+public void clientObjectDidChange(com.threerings.presents.client.Client client)
+
+
+
Specified by:
clientObjectDidChange in interface com.threerings.presents.client.SessionObserver
+
+
+
+
+
+
+ +

+clientDidLogoff

+
+public void clientDidLogoff(com.threerings.presents.client.Client client)
+
+
+
Specified by:
clientDidLogoff in interface com.threerings.presents.client.SessionObserver
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/simulator/client/SimulatorFrame.html b/apidocs/com/threerings/micasa/simulator/client/SimulatorFrame.html new file mode 100644 index 00000000..748c1596 --- /dev/null +++ b/apidocs/com/threerings/micasa/simulator/client/SimulatorFrame.html @@ -0,0 +1,283 @@ + + + + + + + +SimulatorFrame (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.micasa.simulator.client +
+Interface SimulatorFrame

+
+
All Superinterfaces:
ControllerProvider
+
+
+
All Known Implementing Classes:
SimpleFrame
+
+
+
+
public interface SimulatorFrame
extends ControllerProvider
+ + +

+Contains the user interface for the Simulator client application. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ JFramegetFrame() + +
+          Returns a reference to the top-level frame that the simulator will + use to display everything.
+ voidsetController(Controller controller) + +
+          Sets the controller for the outermost scope.
+ voidsetPanel(JPanel panel) + +
+          Sets the panel that makes up the entire client display.
+  + + + + + + + +
Methods inherited from interface com.samskivert.swing.ControllerProvider
getController
+  +

+ + + + + + + + +
+Method Detail
+ +

+getFrame

+
+JFrame getFrame()
+
+
Returns a reference to the top-level frame that the simulator will + use to display everything. +

+

+
+
+
+
+
+
+
+ +

+setPanel

+
+void setPanel(JPanel panel)
+
+
Sets the panel that makes up the entire client display. +

+

+
+
+
+
+
+
+
+ +

+setController

+
+void setController(Controller controller)
+
+
Sets the controller for the outermost scope. This controller will + handle all actions that aren't handled by controllers of higher + scope. +

+

+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/simulator/client/SimulatorService.html b/apidocs/com/threerings/micasa/simulator/client/SimulatorService.html new file mode 100644 index 00000000..2e83845c --- /dev/null +++ b/apidocs/com/threerings/micasa/simulator/client/SimulatorService.html @@ -0,0 +1,245 @@ + + + + + + + +SimulatorService (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.micasa.simulator.client +
+Interface SimulatorService

+
+
All Superinterfaces:
com.threerings.presents.client.InvocationService
+
+
+
All Known Implementing Classes:
SimulatorMarshaller
+
+
+
+
public interface SimulatorService
extends com.threerings.presents.client.InvocationService
+ + +

+Provides access to simulator invocation services. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.presents.client.InvocationService
com.threerings.presents.client.InvocationService.ConfirmListener, com.threerings.presents.client.InvocationService.InvocationListener, com.threerings.presents.client.InvocationService.ResultListener
+  + + + + + + + + + + + + +
+Method Summary
+ voidcreateGame(GameConfig config, + String simClass, + int playerCount) + +
+          Requests that a new game be created.
+  +

+ + + + + + + + +
+Method Detail
+ +

+createGame

+
+void createGame(GameConfig config,
+                String simClass,
+                int playerCount)
+
+
Requests that a new game be created. +

+

+
+
+
+
Parameters:
config - the game config for the game to be created.
simClass - the class name of the simulant to create.
playerCount - the number of players in the game.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/simulator/client/class-use/SimpleClient.html b/apidocs/com/threerings/micasa/simulator/client/class-use/SimpleClient.html new file mode 100644 index 00000000..1fff9d61 --- /dev/null +++ b/apidocs/com/threerings/micasa/simulator/client/class-use/SimpleClient.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.micasa.simulator.client.SimpleClient (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.micasa.simulator.client.SimpleClient

+
+No usage of com.threerings.micasa.simulator.client.SimpleClient +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/simulator/client/class-use/SimpleFrame.html b/apidocs/com/threerings/micasa/simulator/client/class-use/SimpleFrame.html new file mode 100644 index 00000000..e908500e --- /dev/null +++ b/apidocs/com/threerings/micasa/simulator/client/class-use/SimpleFrame.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.micasa.simulator.client.SimpleFrame (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.micasa.simulator.client.SimpleFrame

+
+No usage of com.threerings.micasa.simulator.client.SimpleFrame +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/simulator/client/class-use/SimulatorApp.html b/apidocs/com/threerings/micasa/simulator/client/class-use/SimulatorApp.html new file mode 100644 index 00000000..cd815a65 --- /dev/null +++ b/apidocs/com/threerings/micasa/simulator/client/class-use/SimulatorApp.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.micasa.simulator.client.SimulatorApp (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.micasa.simulator.client.SimulatorApp

+
+No usage of com.threerings.micasa.simulator.client.SimulatorApp +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/simulator/client/class-use/SimulatorClient.html b/apidocs/com/threerings/micasa/simulator/client/class-use/SimulatorClient.html new file mode 100644 index 00000000..6f1b0e0f --- /dev/null +++ b/apidocs/com/threerings/micasa/simulator/client/class-use/SimulatorClient.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Interface com.threerings.micasa.simulator.client.SimulatorClient (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.micasa.simulator.client.SimulatorClient

+
+ + + + + + + + + +
+Packages that use SimulatorClient
com.threerings.micasa.simulator.client  
+  +

+ + + + + +
+Uses of SimulatorClient in com.threerings.micasa.simulator.client
+  +

+ + + + + + + + + +
Classes in com.threerings.micasa.simulator.client that implement SimulatorClient
+ classSimpleClient + +
+           
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/simulator/client/class-use/SimulatorController.html b/apidocs/com/threerings/micasa/simulator/client/class-use/SimulatorController.html new file mode 100644 index 00000000..6bbb4c50 --- /dev/null +++ b/apidocs/com/threerings/micasa/simulator/client/class-use/SimulatorController.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.micasa.simulator.client.SimulatorController (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.micasa.simulator.client.SimulatorController

+
+No usage of com.threerings.micasa.simulator.client.SimulatorController +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/simulator/client/class-use/SimulatorFrame.html b/apidocs/com/threerings/micasa/simulator/client/class-use/SimulatorFrame.html new file mode 100644 index 00000000..7385155f --- /dev/null +++ b/apidocs/com/threerings/micasa/simulator/client/class-use/SimulatorFrame.html @@ -0,0 +1,232 @@ + + + + + + + +Uses of Interface com.threerings.micasa.simulator.client.SimulatorFrame (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.micasa.simulator.client.SimulatorFrame

+
+ + + + + + + + + + + + + +
+Packages that use SimulatorFrame
com.threerings.micasa.simulator.client  
com.threerings.micasa.simulator.util  
+  +

+ + + + + +
+Uses of SimulatorFrame in com.threerings.micasa.simulator.client
+  +

+ + + + + + + + + +
Classes in com.threerings.micasa.simulator.client that implement SimulatorFrame
+ classSimpleFrame + +
+          Contains the user interface for the Simulator client application.
+  +

+ + + + + + + + + + + +
Constructors in com.threerings.micasa.simulator.client with parameters of type SimulatorFrame
SimpleClient(SimulatorFrame frame) + +
+           
SimulatorController(ParlorContext ctx, + SimulatorFrame frame, + SimulatorInfo info) + +
+          Creates a new simulator controller.
+  +

+ + + + + +
+Uses of SimulatorFrame in com.threerings.micasa.simulator.util
+  +

+ + + + + + + + + +
Methods in com.threerings.micasa.simulator.util that return SimulatorFrame
+ SimulatorFrameSimulatorContext.getFrame() + +
+          Returns a reference to the primary user interface frame.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/simulator/client/class-use/SimulatorService.html b/apidocs/com/threerings/micasa/simulator/client/class-use/SimulatorService.html new file mode 100644 index 00000000..a7df8682 --- /dev/null +++ b/apidocs/com/threerings/micasa/simulator/client/class-use/SimulatorService.html @@ -0,0 +1,183 @@ + + + + + + + +Uses of Interface com.threerings.micasa.simulator.client.SimulatorService (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.micasa.simulator.client.SimulatorService

+
+ + + + + + + + + +
+Packages that use SimulatorService
com.threerings.micasa.simulator.data  
+  +

+ + + + + +
+Uses of SimulatorService in com.threerings.micasa.simulator.data
+  +

+ + + + + + + + + +
Classes in com.threerings.micasa.simulator.data that implement SimulatorService
+ classSimulatorMarshaller + +
+          Provides the implementation of the SimulatorService interface + that marshalls the arguments and delivers the request to the provider + on the server.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/simulator/client/package-frame.html b/apidocs/com/threerings/micasa/simulator/client/package-frame.html new file mode 100644 index 00000000..95c285fb --- /dev/null +++ b/apidocs/com/threerings/micasa/simulator/client/package-frame.html @@ -0,0 +1,54 @@ + + + + + + + +com.threerings.micasa.simulator.client (vilya 1.3 API) + + + + + + + + + + + +com.threerings.micasa.simulator.client + + + + +
+Interfaces  + +
+SimulatorClient +
+SimulatorFrame +
+SimulatorService
+ + + + + + +
+Classes  + +
+SimpleClient +
+SimpleFrame +
+SimulatorApp +
+SimulatorController
+ + + + diff --git a/apidocs/com/threerings/micasa/simulator/client/package-summary.html b/apidocs/com/threerings/micasa/simulator/client/package-summary.html new file mode 100644 index 00000000..401e94c2 --- /dev/null +++ b/apidocs/com/threerings/micasa/simulator/client/package-summary.html @@ -0,0 +1,192 @@ + + + + + + + +com.threerings.micasa.simulator.client (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.micasa.simulator.client +

+ + + + + + + + + + + + + + + + + +
+Interface Summary
SimulatorClient 
SimulatorFrameContains the user interface for the Simulator client application.
SimulatorServiceProvides access to simulator invocation services.
+  + +

+ + + + + + + + + + + + + + + + + + + + + +
+Class Summary
SimpleClient 
SimpleFrameContains the user interface for the Simulator client application.
SimulatorAppThe simulator application is a test harness to facilitate development and debugging of games.
SimulatorControllerResponsible for top-level control of the simulator client user interface.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/simulator/client/package-tree.html b/apidocs/com/threerings/micasa/simulator/client/package-tree.html new file mode 100644 index 00000000..cb927f56 --- /dev/null +++ b/apidocs/com/threerings/micasa/simulator/client/package-tree.html @@ -0,0 +1,186 @@ + + + + + + + +com.threerings.micasa.simulator.client Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.micasa.simulator.client +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/simulator/client/package-use.html b/apidocs/com/threerings/micasa/simulator/client/package-use.html new file mode 100644 index 00000000..559f7200 --- /dev/null +++ b/apidocs/com/threerings/micasa/simulator/client/package-use.html @@ -0,0 +1,215 @@ + + + + + + + +Uses of Package com.threerings.micasa.simulator.client (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.micasa.simulator.client

+
+ + + + + + + + + + + + + + + + + +
+Packages that use com.threerings.micasa.simulator.client
com.threerings.micasa.simulator.client  
com.threerings.micasa.simulator.data  
com.threerings.micasa.simulator.util  
+  +

+ + + + + + + + + + + +
+Classes in com.threerings.micasa.simulator.client used by com.threerings.micasa.simulator.client
SimulatorClient + +
+           
SimulatorFrame + +
+          Contains the user interface for the Simulator client application.
+  +

+ + + + + + + + +
+Classes in com.threerings.micasa.simulator.client used by com.threerings.micasa.simulator.data
SimulatorService + +
+          Provides access to simulator invocation services.
+  +

+ + + + + + + + +
+Classes in com.threerings.micasa.simulator.client used by com.threerings.micasa.simulator.util
SimulatorFrame + +
+          Contains the user interface for the Simulator client application.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/simulator/data/SimulatorInfo.html b/apidocs/com/threerings/micasa/simulator/data/SimulatorInfo.html new file mode 100644 index 00000000..c914ef88 --- /dev/null +++ b/apidocs/com/threerings/micasa/simulator/data/SimulatorInfo.html @@ -0,0 +1,334 @@ + + + + + + + +SimulatorInfo (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.micasa.simulator.data +
+Class SimulatorInfo

+
+java.lang.Object
+  extended by com.threerings.micasa.simulator.data.SimulatorInfo
+
+
+
+
public class SimulatorInfo
extends Object
+ + +

+

+ +

+ + + + + + + + + + + + + + + + + + + +
+Field Summary
+ StringgameConfigClass + +
+          The game config classname.
+ intplayerCount + +
+          The number of players in the game.
+ StringsimClass + +
+          The simulant classname.
+  + + + + + + + + + + +
+Constructor Summary
SimulatorInfo() + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ StringtoString() + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+gameConfigClass

+
+public String gameConfigClass
+
+
The game config classname. +

+

+
+
+
+ +

+simClass

+
+public String simClass
+
+
The simulant classname. +

+

+
+
+
+ +

+playerCount

+
+public int playerCount
+
+
The number of players in the game. +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+SimulatorInfo

+
+public SimulatorInfo()
+
+
+ + + + + + + + +
+Method Detail
+ +

+toString

+
+public String toString()
+
+
+
Overrides:
toString in class Object
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/simulator/data/SimulatorMarshaller.html b/apidocs/com/threerings/micasa/simulator/data/SimulatorMarshaller.html new file mode 100644 index 00000000..a20f32cb --- /dev/null +++ b/apidocs/com/threerings/micasa/simulator/data/SimulatorMarshaller.html @@ -0,0 +1,363 @@ + + + + + + + +SimulatorMarshaller (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.micasa.simulator.data +
+Class SimulatorMarshaller

+
+java.lang.Object
+  extended by com.threerings.presents.data.InvocationMarshaller
+      extended by com.threerings.micasa.simulator.data.SimulatorMarshaller
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable, SimulatorService, com.threerings.presents.client.InvocationService
+
+
+
+
@Generated(value="com.threerings.presents.tools.GenServiceTask",
+           comments="Derived from SimulatorService.java.")
+public class SimulatorMarshaller
extends com.threerings.presents.data.InvocationMarshaller
implements SimulatorService
+ + +

+Provides the implementation of the SimulatorService interface + that marshalls the arguments and delivers the request to the provider + on the server. Also provides an implementation of the response listener + interfaces that marshall the response arguments and deliver them back + to the requesting client. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.presents.data.InvocationMarshaller
com.threerings.presents.data.InvocationMarshaller.ConfirmMarshaller, com.threerings.presents.data.InvocationMarshaller.ListenerMarshaller, com.threerings.presents.data.InvocationMarshaller.ResultMarshaller
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.presents.client.InvocationService
com.threerings.presents.client.InvocationService.ConfirmListener, com.threerings.presents.client.InvocationService.InvocationListener, com.threerings.presents.client.InvocationService.ResultListener
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + +
+Field Summary
+static intCREATE_GAME + +
+          The method id used to dispatch createGame(com.threerings.parlor.game.data.GameConfig, java.lang.String, int) requests.
+  + + + + + + + + + + +
+Constructor Summary
SimulatorMarshaller() + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ voidcreateGame(GameConfig arg1, + String arg2, + int arg3) + +
+          Requests that a new game be created.
+  + + + + + + + +
Methods inherited from class com.threerings.presents.data.InvocationMarshaller
getInvocationCode, init, readField__invCode, readField__invOid, readObject, setInvocationOid, setNoResponse, toString, writeField__invCode, writeField__invOid
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+CREATE_GAME

+
+public static final int CREATE_GAME
+
+
The method id used to dispatch createGame(com.threerings.parlor.game.data.GameConfig, java.lang.String, int) requests. +

+

+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Constructor Detail
+ +

+SimulatorMarshaller

+
+public SimulatorMarshaller()
+
+
+ + + + + + + + +
+Method Detail
+ +

+createGame

+
+public void createGame(GameConfig arg1,
+                       String arg2,
+                       int arg3)
+
+
Description copied from interface: SimulatorService
+
Requests that a new game be created. +

+

+
Specified by:
createGame in interface SimulatorService
+
+
+
Parameters:
arg1 - the game config for the game to be created.
arg2 - the class name of the simulant to create.
arg3 - the number of players in the game.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/simulator/data/class-use/SimulatorInfo.html b/apidocs/com/threerings/micasa/simulator/data/class-use/SimulatorInfo.html new file mode 100644 index 00000000..d26ba1ed --- /dev/null +++ b/apidocs/com/threerings/micasa/simulator/data/class-use/SimulatorInfo.html @@ -0,0 +1,211 @@ + + + + + + + +Uses of Class com.threerings.micasa.simulator.data.SimulatorInfo (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.micasa.simulator.data.SimulatorInfo

+
+ + + + + + + + + + + + + +
+Packages that use SimulatorInfo
com.threerings.micasa.simulator.client  
com.threerings.micasa.simulator.util  
+  +

+ + + + + +
+Uses of SimulatorInfo in com.threerings.micasa.simulator.client
+  +

+ + + + + + + + +
Constructors in com.threerings.micasa.simulator.client with parameters of type SimulatorInfo
SimulatorController(ParlorContext ctx, + SimulatorFrame frame, + SimulatorInfo info) + +
+          Creates a new simulator controller.
+  +

+ + + + + +
+Uses of SimulatorInfo in com.threerings.micasa.simulator.util
+  +

+ + + + + + + + + +
Methods in com.threerings.micasa.simulator.util that return SimulatorInfo
+ SimulatorInfoSimulatorContext.getSimulatorInfo() + +
+          Returns a reference to the simulator info describing the game and + other details of the simulation.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/simulator/data/class-use/SimulatorMarshaller.html b/apidocs/com/threerings/micasa/simulator/data/class-use/SimulatorMarshaller.html new file mode 100644 index 00000000..7c05cfd1 --- /dev/null +++ b/apidocs/com/threerings/micasa/simulator/data/class-use/SimulatorMarshaller.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.micasa.simulator.data.SimulatorMarshaller (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.micasa.simulator.data.SimulatorMarshaller

+
+No usage of com.threerings.micasa.simulator.data.SimulatorMarshaller +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/simulator/data/package-frame.html b/apidocs/com/threerings/micasa/simulator/data/package-frame.html new file mode 100644 index 00000000..add45faf --- /dev/null +++ b/apidocs/com/threerings/micasa/simulator/data/package-frame.html @@ -0,0 +1,35 @@ + + + + + + + +com.threerings.micasa.simulator.data (vilya 1.3 API) + + + + + + + + + + + +com.threerings.micasa.simulator.data + + + + +
+Classes  + +
+SimulatorInfo +
+SimulatorMarshaller
+ + + + diff --git a/apidocs/com/threerings/micasa/simulator/data/package-summary.html b/apidocs/com/threerings/micasa/simulator/data/package-summary.html new file mode 100644 index 00000000..d26cebe6 --- /dev/null +++ b/apidocs/com/threerings/micasa/simulator/data/package-summary.html @@ -0,0 +1,164 @@ + + + + + + + +com.threerings.micasa.simulator.data (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.micasa.simulator.data +

+ + + + + + + + + + + + + +
+Class Summary
SimulatorInfo 
SimulatorMarshallerProvides the implementation of the SimulatorService interface + that marshalls the arguments and delivers the request to the provider + on the server.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/simulator/data/package-tree.html b/apidocs/com/threerings/micasa/simulator/data/package-tree.html new file mode 100644 index 00000000..baaaac0f --- /dev/null +++ b/apidocs/com/threerings/micasa/simulator/data/package-tree.html @@ -0,0 +1,158 @@ + + + + + + + +com.threerings.micasa.simulator.data Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.micasa.simulator.data +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/simulator/data/package-use.html b/apidocs/com/threerings/micasa/simulator/data/package-use.html new file mode 100644 index 00000000..17e2aca7 --- /dev/null +++ b/apidocs/com/threerings/micasa/simulator/data/package-use.html @@ -0,0 +1,190 @@ + + + + + + + +Uses of Package com.threerings.micasa.simulator.data (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.micasa.simulator.data

+
+ + + + + + + + + + + + + +
+Packages that use com.threerings.micasa.simulator.data
com.threerings.micasa.simulator.client  
com.threerings.micasa.simulator.util  
+  +

+ + + + + + + + +
+Classes in com.threerings.micasa.simulator.data used by com.threerings.micasa.simulator.client
SimulatorInfo + +
+           
+  +

+ + + + + + + + +
+Classes in com.threerings.micasa.simulator.data used by com.threerings.micasa.simulator.util
SimulatorInfo + +
+           
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/simulator/server/SimpleServer.html b/apidocs/com/threerings/micasa/simulator/server/SimpleServer.html new file mode 100644 index 00000000..63524bcc --- /dev/null +++ b/apidocs/com/threerings/micasa/simulator/server/SimpleServer.html @@ -0,0 +1,349 @@ + + + + + + + +SimpleServer (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.micasa.simulator.server +
+Class SimpleServer

+
+java.lang.Object
+  extended by com.threerings.presents.server.PresentsServer
+      extended by com.threerings.crowd.server.CrowdServer
+          extended by com.threerings.micasa.server.MiCasaServer
+              extended by com.threerings.micasa.simulator.server.SimpleServer
+
+
+
All Implemented Interfaces:
SimulatorServer
+
+
+
+
public class SimpleServer
extends MiCasaServer
implements SimulatorServer
+ + +

+A simple simulator server implementation that extends the MiCasa server. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.crowd.server.CrowdServer
com.threerings.crowd.server.CrowdServer.CrowdModule
+  + + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.presents.server.PresentsServer
com.threerings.presents.server.PresentsServer.PresentsModule, com.threerings.presents.server.PresentsServer.PresentsServerModule
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class com.threerings.presents.server.PresentsServer
invmgr, omgr
+  + + + + + + + + + + +
+Constructor Summary
SimpleServer() + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ voidinit(com.google.inject.Injector injector, + ResultListener<SimulatorServer> obs) + +
+          Called to initialize this server instance.
+  + + + + + + + +
Methods inherited from class com.threerings.micasa.server.MiCasaServer
init, main
+  + + + + + + + +
Methods inherited from class com.threerings.presents.server.PresentsServer
queueShutdown, run, runServer
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  + + + + + + + +
Methods inherited from interface com.threerings.micasa.simulator.server.SimulatorServer
run
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+SimpleServer

+
+public SimpleServer()
+
+
+ + + + + + + + +
+Method Detail
+ +

+init

+
+public void init(com.google.inject.Injector injector,
+                 ResultListener<SimulatorServer> obs)
+          throws Exception
+
+
Description copied from interface: SimulatorServer
+
Called to initialize this server instance. +

+

+
Specified by:
init in interface SimulatorServer
+
+
+
obs - the observer to notify when the server has finished starting up, or + null if no notification is desired. +
Throws: +
Exception - thrown if anything goes wrong initializing the server.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/simulator/server/Simulant.html b/apidocs/com/threerings/micasa/simulator/server/Simulant.html new file mode 100644 index 00000000..17f66656 --- /dev/null +++ b/apidocs/com/threerings/micasa/simulator/server/Simulant.html @@ -0,0 +1,291 @@ + + + + + + + +Simulant (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.micasa.simulator.server +
+Class Simulant

+
+java.lang.Object
+  extended by com.threerings.micasa.simulator.server.Simulant
+
+
+
+
public abstract class Simulant
extends Object
+ + +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
Simulant() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ voidinit(com.threerings.crowd.data.BodyObject self, + GameConfig config, + GameManager gmgr, + com.threerings.presents.dobj.DObjectManager omgr) + +
+          Initializes the simulant with a body object and the game config for + the game they'll be engaged in.
+ voidwillEnterPlace(com.threerings.crowd.data.PlaceObject plobj) + +
+          Called when the simulant is about to enter the room in which it + will be doing all of its business.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+Simulant

+
+public Simulant()
+
+
+ + + + + + + + +
+Method Detail
+ +

+init

+
+public void init(com.threerings.crowd.data.BodyObject self,
+                 GameConfig config,
+                 GameManager gmgr,
+                 com.threerings.presents.dobj.DObjectManager omgr)
+
+
Initializes the simulant with a body object and the game config for + the game they'll be engaged in. +

+

+
+
+
+
+ +

+willEnterPlace

+
+public void willEnterPlace(com.threerings.crowd.data.PlaceObject plobj)
+
+
Called when the simulant is about to enter the room in which it + will be doing all of its business. Default implementation + immediately notifies the game manager that the simulant is ready to + play. Sub-classes may wish to override this to do things like + subscribe to the game object, but should be sure to call this + method when they're finished to give the game manager the go-ahead + to proceed. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/simulator/server/SimulatorManager.CreateGameTask.html b/apidocs/com/threerings/micasa/simulator/server/SimulatorManager.CreateGameTask.html new file mode 100644 index 00000000..cca91370 --- /dev/null +++ b/apidocs/com/threerings/micasa/simulator/server/SimulatorManager.CreateGameTask.html @@ -0,0 +1,234 @@ + + + + + + + +SimulatorManager.CreateGameTask (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.micasa.simulator.server +
+Class SimulatorManager.CreateGameTask

+
+java.lang.Object
+  extended by com.threerings.micasa.simulator.server.SimulatorManager.CreateGameTask
+
+
+
Enclosing class:
SimulatorManager
+
+
+
+
public class SimulatorManager.CreateGameTask
extends Object
+ + +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
SimulatorManager.CreateGameTask(com.threerings.crowd.data.BodyObject source, + GameConfig config, + String simClass, + int playerCount) + +
+           
+  + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+SimulatorManager.CreateGameTask

+
+public SimulatorManager.CreateGameTask(com.threerings.crowd.data.BodyObject source,
+                                       GameConfig config,
+                                       String simClass,
+                                       int playerCount)
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/simulator/server/SimulatorManager.html b/apidocs/com/threerings/micasa/simulator/server/SimulatorManager.html new file mode 100644 index 00000000..2dc1e62b --- /dev/null +++ b/apidocs/com/threerings/micasa/simulator/server/SimulatorManager.html @@ -0,0 +1,285 @@ + + + + + + + +SimulatorManager (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.micasa.simulator.server +
+Class SimulatorManager

+
+java.lang.Object
+  extended by com.threerings.micasa.simulator.server.SimulatorManager
+
+
+
+
public class SimulatorManager
extends Object
+ + +

+The simulator manager is responsible for handling the simulator services on the server side. +

+ +

+

+ +

+ + + + + + + + + + + +
+Nested Class Summary
+ classSimulatorManager.CreateGameTask + +
+           
+  + + + + + + + + + + +
+Constructor Summary
SimulatorManager(com.threerings.presents.server.InvocationManager invmgr) + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ voidcreateGame(com.threerings.crowd.data.BodyObject source, + GameConfig config, + String simClass, + int playerCount) + +
+          Creates a game along with the specified number of simulant players and forcibly moves all + players into the game room.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+SimulatorManager

+
+@Inject
+public SimulatorManager(com.threerings.presents.server.InvocationManager invmgr)
+
+
+ + + + + + + + +
+Method Detail
+ +

+createGame

+
+public void createGame(com.threerings.crowd.data.BodyObject source,
+                       GameConfig config,
+                       String simClass,
+                       int playerCount)
+
+
Creates a game along with the specified number of simulant players and forcibly moves all + players into the game room. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/simulator/server/SimulatorProvider.html b/apidocs/com/threerings/micasa/simulator/server/SimulatorProvider.html new file mode 100644 index 00000000..f74b2e96 --- /dev/null +++ b/apidocs/com/threerings/micasa/simulator/server/SimulatorProvider.html @@ -0,0 +1,274 @@ + + + + + + + +SimulatorProvider (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.micasa.simulator.server +
+Class SimulatorProvider

+
+java.lang.Object
+  extended by com.threerings.micasa.simulator.server.SimulatorProvider
+
+
+
All Implemented Interfaces:
com.threerings.presents.server.InvocationProvider
+
+
+
+
public class SimulatorProvider
extends Object
implements com.threerings.presents.server.InvocationProvider
+ + +

+The simulator provider handles game creation requests on the server + side, passing them off to the SimulatorManager. +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
SimulatorProvider(SimulatorManager simmgr) + +
+          Constructs a simulator provider.
+  + + + + + + + + + + + +
+Method Summary
+ voidcreateGame(com.threerings.presents.data.ClientObject caller, + GameConfig config, + String simClass, + int playerCount) + +
+          Processes a request from the client to create a new game.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+SimulatorProvider

+
+public SimulatorProvider(SimulatorManager simmgr)
+
+
Constructs a simulator provider. +

+

+ + + + + + + + +
+Method Detail
+ +

+createGame

+
+public void createGame(com.threerings.presents.data.ClientObject caller,
+                       GameConfig config,
+                       String simClass,
+                       int playerCount)
+
+
Processes a request from the client to create a new game. +

+

+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/simulator/server/SimulatorServer.html b/apidocs/com/threerings/micasa/simulator/server/SimulatorServer.html new file mode 100644 index 00000000..0ff0d255 --- /dev/null +++ b/apidocs/com/threerings/micasa/simulator/server/SimulatorServer.html @@ -0,0 +1,245 @@ + + + + + + + +SimulatorServer (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.micasa.simulator.server +
+Interface SimulatorServer

+
+
All Known Implementing Classes:
SimpleServer
+
+
+
+
public interface SimulatorServer
+ + +

+The simulator manager needs a mechanism for faking body object registrations, which is provided + by implementations of this interface. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + +
+Method Summary
+ voidinit(com.google.inject.Injector injector, + ResultListener<SimulatorServer> obs) + +
+          Called to initialize this server instance.
+ voidrun() + +
+          Called to perform the main body of server processing.
+  +

+ + + + + + + + +
+Method Detail
+ +

+init

+
+void init(com.google.inject.Injector injector,
+          ResultListener<SimulatorServer> obs)
+          throws Exception
+
+
Called to initialize this server instance. +

+

+
Parameters:
obs - the observer to notify when the server has finished starting up, or + null if no notification is desired. +
Throws: +
Exception - thrown if anything goes wrong initializing the server.
+
+
+
+ +

+run

+
+void run()
+
+
Called to perform the main body of server processing. This is called from the server thread + and should do the simulator server's primary business. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/simulator/server/class-use/SimpleServer.html b/apidocs/com/threerings/micasa/simulator/server/class-use/SimpleServer.html new file mode 100644 index 00000000..ff8417a5 --- /dev/null +++ b/apidocs/com/threerings/micasa/simulator/server/class-use/SimpleServer.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.micasa.simulator.server.SimpleServer (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.micasa.simulator.server.SimpleServer

+
+No usage of com.threerings.micasa.simulator.server.SimpleServer +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/simulator/server/class-use/Simulant.html b/apidocs/com/threerings/micasa/simulator/server/class-use/Simulant.html new file mode 100644 index 00000000..ae08128e --- /dev/null +++ b/apidocs/com/threerings/micasa/simulator/server/class-use/Simulant.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.micasa.simulator.server.Simulant (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.micasa.simulator.server.Simulant

+
+No usage of com.threerings.micasa.simulator.server.Simulant +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/simulator/server/class-use/SimulatorManager.CreateGameTask.html b/apidocs/com/threerings/micasa/simulator/server/class-use/SimulatorManager.CreateGameTask.html new file mode 100644 index 00000000..5c7cd485 --- /dev/null +++ b/apidocs/com/threerings/micasa/simulator/server/class-use/SimulatorManager.CreateGameTask.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.micasa.simulator.server.SimulatorManager.CreateGameTask (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.micasa.simulator.server.SimulatorManager.CreateGameTask

+
+No usage of com.threerings.micasa.simulator.server.SimulatorManager.CreateGameTask +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/simulator/server/class-use/SimulatorManager.html b/apidocs/com/threerings/micasa/simulator/server/class-use/SimulatorManager.html new file mode 100644 index 00000000..5d0a6b5d --- /dev/null +++ b/apidocs/com/threerings/micasa/simulator/server/class-use/SimulatorManager.html @@ -0,0 +1,179 @@ + + + + + + + +Uses of Class com.threerings.micasa.simulator.server.SimulatorManager (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.micasa.simulator.server.SimulatorManager

+
+ + + + + + + + + +
+Packages that use SimulatorManager
com.threerings.micasa.simulator.server  
+  +

+ + + + + +
+Uses of SimulatorManager in com.threerings.micasa.simulator.server
+  +

+ + + + + + + + +
Constructors in com.threerings.micasa.simulator.server with parameters of type SimulatorManager
SimulatorProvider(SimulatorManager simmgr) + +
+          Constructs a simulator provider.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/simulator/server/class-use/SimulatorProvider.html b/apidocs/com/threerings/micasa/simulator/server/class-use/SimulatorProvider.html new file mode 100644 index 00000000..e266a254 --- /dev/null +++ b/apidocs/com/threerings/micasa/simulator/server/class-use/SimulatorProvider.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.micasa.simulator.server.SimulatorProvider (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.micasa.simulator.server.SimulatorProvider

+
+No usage of com.threerings.micasa.simulator.server.SimulatorProvider +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/simulator/server/class-use/SimulatorServer.html b/apidocs/com/threerings/micasa/simulator/server/class-use/SimulatorServer.html new file mode 100644 index 00000000..37e1f93a --- /dev/null +++ b/apidocs/com/threerings/micasa/simulator/server/class-use/SimulatorServer.html @@ -0,0 +1,207 @@ + + + + + + + +Uses of Interface com.threerings.micasa.simulator.server.SimulatorServer (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.micasa.simulator.server.SimulatorServer

+
+ + + + + + + + + +
+Packages that use SimulatorServer
com.threerings.micasa.simulator.server  
+  +

+ + + + + +
+Uses of SimulatorServer in com.threerings.micasa.simulator.server
+  +

+ + + + + + + + + +
Classes in com.threerings.micasa.simulator.server that implement SimulatorServer
+ classSimpleServer + +
+          A simple simulator server implementation that extends the MiCasa server.
+  +

+ + + + + + + + + + + + + +
Method parameters in com.threerings.micasa.simulator.server with type arguments of type SimulatorServer
+ voidSimulatorServer.init(com.google.inject.Injector injector, + ResultListener<SimulatorServer> obs) + +
+          Called to initialize this server instance.
+ voidSimpleServer.init(com.google.inject.Injector injector, + ResultListener<SimulatorServer> obs) + +
+           
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/simulator/server/package-frame.html b/apidocs/com/threerings/micasa/simulator/server/package-frame.html new file mode 100644 index 00000000..ec28e233 --- /dev/null +++ b/apidocs/com/threerings/micasa/simulator/server/package-frame.html @@ -0,0 +1,50 @@ + + + + + + + +com.threerings.micasa.simulator.server (vilya 1.3 API) + + + + + + + + + + + +com.threerings.micasa.simulator.server + + + + +
+Interfaces  + +
+SimulatorServer
+ + + + + + +
+Classes  + +
+SimpleServer +
+Simulant +
+SimulatorManager +
+SimulatorProvider
+ + + + diff --git a/apidocs/com/threerings/micasa/simulator/server/package-summary.html b/apidocs/com/threerings/micasa/simulator/server/package-summary.html new file mode 100644 index 00000000..9487c68c --- /dev/null +++ b/apidocs/com/threerings/micasa/simulator/server/package-summary.html @@ -0,0 +1,186 @@ + + + + + + + +com.threerings.micasa.simulator.server (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.micasa.simulator.server +

+ + + + + + + + + +
+Interface Summary
SimulatorServerThe simulator manager needs a mechanism for faking body object registrations, which is provided + by implementations of this interface.
+  + +

+ + + + + + + + + + + + + + + + + + + + + +
+Class Summary
SimpleServerA simple simulator server implementation that extends the MiCasa server.
Simulant 
SimulatorManagerThe simulator manager is responsible for handling the simulator services on the server side.
SimulatorProviderThe simulator provider handles game creation requests on the server + side, passing them off to the SimulatorManager.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/simulator/server/package-tree.html b/apidocs/com/threerings/micasa/simulator/server/package-tree.html new file mode 100644 index 00000000..51788d5c --- /dev/null +++ b/apidocs/com/threerings/micasa/simulator/server/package-tree.html @@ -0,0 +1,167 @@ + + + + + + + +com.threerings.micasa.simulator.server Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.micasa.simulator.server +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/simulator/server/package-use.html b/apidocs/com/threerings/micasa/simulator/server/package-use.html new file mode 100644 index 00000000..7a65126a --- /dev/null +++ b/apidocs/com/threerings/micasa/simulator/server/package-use.html @@ -0,0 +1,178 @@ + + + + + + + +Uses of Package com.threerings.micasa.simulator.server (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.micasa.simulator.server

+
+ + + + + + + + + +
+Packages that use com.threerings.micasa.simulator.server
com.threerings.micasa.simulator.server  
+  +

+ + + + + + + + + + + +
+Classes in com.threerings.micasa.simulator.server used by com.threerings.micasa.simulator.server
SimulatorManager + +
+          The simulator manager is responsible for handling the simulator services on the server side.
SimulatorServer + +
+          The simulator manager needs a mechanism for faking body object registrations, which is provided + by implementations of this interface.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/simulator/util/SimulatorContext.html b/apidocs/com/threerings/micasa/simulator/util/SimulatorContext.html new file mode 100644 index 00000000..23602f16 --- /dev/null +++ b/apidocs/com/threerings/micasa/simulator/util/SimulatorContext.html @@ -0,0 +1,275 @@ + + + + + + + +SimulatorContext (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.micasa.simulator.util +
+Interface SimulatorContext

+
+
All Superinterfaces:
com.threerings.crowd.util.CrowdContext, ParlorContext, com.threerings.presents.util.PresentsContext
+
+
+
+
public interface SimulatorContext
extends ParlorContext
+ + +

+The simulator context encapsulates the contexts of all of the services + that are used by the simulator client so that we can pass around one + single context implementation that provides all of the necessary + components to all of the services in use. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + +
+Method Summary
+ SimulatorFramegetFrame() + +
+          Returns a reference to the primary user interface frame.
+ SimulatorInfogetSimulatorInfo() + +
+          Returns a reference to the simulator info describing the game and + other details of the simulation.
+  + + + + + + + +
Methods inherited from interface com.threerings.parlor.util.ParlorContext
getParlorDirector
+  + + + + + + + +
Methods inherited from interface com.threerings.crowd.util.CrowdContext
clearPlaceView, getChatDirector, getLocationDirector, getMessageManager, getOccupantDirector, setPlaceView
+  + + + + + + + +
Methods inherited from interface com.threerings.presents.util.PresentsContext
getClient, getConfig, getDObjectManager
+  +

+ + + + + + + + +
+Method Detail
+ +

+getFrame

+
+SimulatorFrame getFrame()
+
+
Returns a reference to the primary user interface frame. +

+

+
+
+
+
+
+
+
+ +

+getSimulatorInfo

+
+SimulatorInfo getSimulatorInfo()
+
+
Returns a reference to the simulator info describing the game and + other details of the simulation. +

+

+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/simulator/util/class-use/SimulatorContext.html b/apidocs/com/threerings/micasa/simulator/util/class-use/SimulatorContext.html new file mode 100644 index 00000000..15bc549f --- /dev/null +++ b/apidocs/com/threerings/micasa/simulator/util/class-use/SimulatorContext.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Interface com.threerings.micasa.simulator.util.SimulatorContext (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.micasa.simulator.util.SimulatorContext

+
+No usage of com.threerings.micasa.simulator.util.SimulatorContext +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/simulator/util/package-frame.html b/apidocs/com/threerings/micasa/simulator/util/package-frame.html new file mode 100644 index 00000000..6fcddaae --- /dev/null +++ b/apidocs/com/threerings/micasa/simulator/util/package-frame.html @@ -0,0 +1,33 @@ + + + + + + + +com.threerings.micasa.simulator.util (vilya 1.3 API) + + + + + + + + + + + +com.threerings.micasa.simulator.util + + + + +
+Interfaces  + +
+SimulatorContext
+ + + + diff --git a/apidocs/com/threerings/micasa/simulator/util/package-summary.html b/apidocs/com/threerings/micasa/simulator/util/package-summary.html new file mode 100644 index 00000000..c5fdc066 --- /dev/null +++ b/apidocs/com/threerings/micasa/simulator/util/package-summary.html @@ -0,0 +1,161 @@ + + + + + + + +com.threerings.micasa.simulator.util (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.micasa.simulator.util +

+ + + + + + + + + +
+Interface Summary
SimulatorContextThe simulator context encapsulates the contexts of all of the services + that are used by the simulator client so that we can pass around one + single context implementation that provides all of the necessary + components to all of the services in use.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/simulator/util/package-tree.html b/apidocs/com/threerings/micasa/simulator/util/package-tree.html new file mode 100644 index 00000000..91334e80 --- /dev/null +++ b/apidocs/com/threerings/micasa/simulator/util/package-tree.html @@ -0,0 +1,158 @@ + + + + + + + +com.threerings.micasa.simulator.util Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.micasa.simulator.util +

+
+
+
Package Hierarchies:
All Packages
+
+

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/simulator/util/package-use.html b/apidocs/com/threerings/micasa/simulator/util/package-use.html new file mode 100644 index 00000000..d4665056 --- /dev/null +++ b/apidocs/com/threerings/micasa/simulator/util/package-use.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Package com.threerings.micasa.simulator.util (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.micasa.simulator.util

+
+No usage of com.threerings.micasa.simulator.util +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/util/MiCasaContext.html b/apidocs/com/threerings/micasa/util/MiCasaContext.html new file mode 100644 index 00000000..7c67d442 --- /dev/null +++ b/apidocs/com/threerings/micasa/util/MiCasaContext.html @@ -0,0 +1,276 @@ + + + + + + + +MiCasaContext (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.micasa.util +
+Interface MiCasaContext

+
+
All Superinterfaces:
com.threerings.crowd.util.CrowdContext, ParlorContext, com.threerings.presents.util.PresentsContext
+
+
+
+
public interface MiCasaContext
extends ParlorContext
+ + +

+The micasa context encapsulates the contexts of all of the services + that are used by the micasa client so that we can pass around one + single context implementation that provides all of the necessary + components to all of the services in use. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + +
+Method Summary
+ MiCasaFramegetFrame() + +
+          Returns a reference to the primary user interface frame.
+ com.threerings.util.MessageManagergetMessageManager() + +
+          Returns a reference to the message manager used by the client to + generate localized messages.
+  + + + + + + + +
Methods inherited from interface com.threerings.parlor.util.ParlorContext
getParlorDirector
+  + + + + + + + +
Methods inherited from interface com.threerings.crowd.util.CrowdContext
clearPlaceView, getChatDirector, getLocationDirector, getOccupantDirector, setPlaceView
+  + + + + + + + +
Methods inherited from interface com.threerings.presents.util.PresentsContext
getClient, getConfig, getDObjectManager
+  +

+ + + + + + + + +
+Method Detail
+ +

+getFrame

+
+MiCasaFrame getFrame()
+
+
Returns a reference to the primary user interface frame. This can + be used to set the top-level panel when we enter a game, etc. +

+

+
+
+
+
+
+
+
+ +

+getMessageManager

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

+

+
Specified by:
getMessageManager in interface com.threerings.crowd.util.CrowdContext
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/util/class-use/MiCasaContext.html b/apidocs/com/threerings/micasa/util/class-use/MiCasaContext.html new file mode 100644 index 00000000..67063d17 --- /dev/null +++ b/apidocs/com/threerings/micasa/util/class-use/MiCasaContext.html @@ -0,0 +1,308 @@ + + + + + + + +Uses of Interface com.threerings.micasa.util.MiCasaContext (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.micasa.util.MiCasaContext

+
+ + + + + + + + + + + + + + + + + +
+Packages that use MiCasaContext
com.threerings.micasa.client  
com.threerings.micasa.lobby  
com.threerings.micasa.lobby.table  
+  +

+ + + + + +
+Uses of MiCasaContext in com.threerings.micasa.client
+  +

+ + + + + + + + + +
Methods in com.threerings.micasa.client that return MiCasaContext
+ MiCasaContextMiCasaClient.getContext() + +
+          Returns a reference to the context in effect for this client.
+  +

+ + + + + + + + + + + +
Constructors in com.threerings.micasa.client with parameters of type MiCasaContext
ClientController(MiCasaContext ctx, + MiCasaFrame frame) + +
+          Creates a new client controller.
LogonPanel(MiCasaContext ctx) + +
+           
+  +

+ + + + + +
+Uses of MiCasaContext in com.threerings.micasa.lobby
+  +

+ + + + + + + + + +
Methods in com.threerings.micasa.lobby with parameters of type MiCasaContext
+ JComponentLobbyConfig.createMatchMakingView(MiCasaContext ctx) + +
+          Derived classes override this function and create the appropriate + matchmaking user interface component.
+  +

+ + + + + + + + + + + +
Constructors in com.threerings.micasa.lobby with parameters of type MiCasaContext
LobbyPanel(MiCasaContext ctx, + LobbyConfig config) + +
+          Constructs a new lobby panel and the associated user interface + elements.
LobbySelector(MiCasaContext ctx) + +
+          Constructs a new lobby selector component.
+  +

+ + + + + +
+Uses of MiCasaContext in com.threerings.micasa.lobby.table
+  +

+ + + + + + + + + +
Methods in com.threerings.micasa.lobby.table with parameters of type MiCasaContext
+ JComponentTableLobbyConfig.createMatchMakingView(MiCasaContext ctx) + +
+           
+  +

+ + + + + + + + + + + +
Constructors in com.threerings.micasa.lobby.table with parameters of type MiCasaContext
TableItem(MiCasaContext ctx, + TableDirector tdtr, + Table table) + +
+          Creates a new table item to display and interact with the supplied + table.
TableListView(MiCasaContext ctx, + LobbyConfig config) + +
+          Creates a new table list view, suitable for providing the user + interface for table-style matchmaking in a table lobby.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/util/package-frame.html b/apidocs/com/threerings/micasa/util/package-frame.html new file mode 100644 index 00000000..b774039b --- /dev/null +++ b/apidocs/com/threerings/micasa/util/package-frame.html @@ -0,0 +1,33 @@ + + + + + + + +com.threerings.micasa.util (vilya 1.3 API) + + + + + + + + + + + +com.threerings.micasa.util + + + + +
+Interfaces  + +
+MiCasaContext
+ + + + diff --git a/apidocs/com/threerings/micasa/util/package-summary.html b/apidocs/com/threerings/micasa/util/package-summary.html new file mode 100644 index 00000000..310c0b3b --- /dev/null +++ b/apidocs/com/threerings/micasa/util/package-summary.html @@ -0,0 +1,161 @@ + + + + + + + +com.threerings.micasa.util (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.micasa.util +

+ + + + + + + + + +
+Interface Summary
MiCasaContextThe micasa context encapsulates the contexts of all of the services + that are used by the micasa client so that we can pass around one + single context implementation that provides all of the necessary + components to all of the services in use.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/util/package-tree.html b/apidocs/com/threerings/micasa/util/package-tree.html new file mode 100644 index 00000000..64c7f249 --- /dev/null +++ b/apidocs/com/threerings/micasa/util/package-tree.html @@ -0,0 +1,158 @@ + + + + + + + +com.threerings.micasa.util Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.micasa.util +

+
+
+
Package Hierarchies:
All Packages
+
+

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/micasa/util/package-use.html b/apidocs/com/threerings/micasa/util/package-use.html new file mode 100644 index 00000000..6938667c --- /dev/null +++ b/apidocs/com/threerings/micasa/util/package-use.html @@ -0,0 +1,218 @@ + + + + + + + +Uses of Package com.threerings.micasa.util (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.micasa.util

+
+ + + + + + + + + + + + + + + + + +
+Packages that use com.threerings.micasa.util
com.threerings.micasa.client  
com.threerings.micasa.lobby  
com.threerings.micasa.lobby.table  
+  +

+ + + + + + + + +
+Classes in com.threerings.micasa.util used by com.threerings.micasa.client
MiCasaContext + +
+          The micasa context encapsulates the contexts of all of the services + that are used by the micasa client so that we can pass around one + single context implementation that provides all of the necessary + components to all of the services in use.
+  +

+ + + + + + + + +
+Classes in com.threerings.micasa.util used by com.threerings.micasa.lobby
MiCasaContext + +
+          The micasa context encapsulates the contexts of all of the services + that are used by the micasa client so that we can pass around one + single context implementation that provides all of the necessary + components to all of the services in use.
+  +

+ + + + + + + + +
+Classes in com.threerings.micasa.util used by com.threerings.micasa.lobby.table
MiCasaContext + +
+          The micasa context encapsulates the contexts of all of the services + that are used by the micasa client so that we can pass around one + single context implementation that provides all of the necessary + components to all of the services in use.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/Log.html b/apidocs/com/threerings/parlor/Log.html new file mode 100644 index 00000000..84edfe94 --- /dev/null +++ b/apidocs/com/threerings/parlor/Log.html @@ -0,0 +1,267 @@ + + + + + + + +Log (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor +
+Class Log

+
+java.lang.Object
+  extended by com.threerings.parlor.Log
+
+
+
+
public class Log
extends Object
+ + +

+Contains a reference to the log object used by the Parlor services. +

+ +

+

+ +

+ + + + + + + + + + + +
+Field Summary
+static Loggerlog + +
+          We dispatch our log messages through this logger.
+  + + + + + + + + + + +
+Constructor Summary
Log() + +
+           
+  + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+log

+
+public static Logger log
+
+
We dispatch our log messages through this logger. +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+Log

+
+public Log()
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/Log.html b/apidocs/com/threerings/parlor/card/Log.html new file mode 100644 index 00000000..db1c1567 --- /dev/null +++ b/apidocs/com/threerings/parlor/card/Log.html @@ -0,0 +1,265 @@ + + + + + + + +Log (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.card +
+Class Log

+
+java.lang.Object
+  extended by com.threerings.parlor.card.Log
+
+
+
+
public class Log
extends Object
+ + +

+Contains a reference to the log object used by the Card services. +

+ +

+

+ +

+ + + + + + + + + + + +
+Field Summary
+static Loggerlog + +
+           
+  + + + + + + + + + + +
+Constructor Summary
Log() + +
+           
+  + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+log

+
+public static Logger log
+
+
+
+
+ + + + + + + + +
+Constructor Detail
+ +

+Log

+
+public Log()
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/class-use/Log.html b/apidocs/com/threerings/parlor/card/class-use/Log.html new file mode 100644 index 00000000..d9a47d37 --- /dev/null +++ b/apidocs/com/threerings/parlor/card/class-use/Log.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.parlor.card.Log (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.card.Log

+
+No usage of com.threerings.parlor.card.Log +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/client/CardGameController.html b/apidocs/com/threerings/parlor/card/client/CardGameController.html new file mode 100644 index 00000000..ffc46514 --- /dev/null +++ b/apidocs/com/threerings/parlor/card/client/CardGameController.html @@ -0,0 +1,551 @@ + + + + + + + +CardGameController (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.card.client +
+Class CardGameController

+
+java.lang.Object
+  extended by com.samskivert.swing.Controller
+      extended by com.threerings.crowd.client.PlaceController
+          extended by com.threerings.parlor.game.client.GameController
+              extended by com.threerings.parlor.card.client.CardGameController
+
+
+
All Implemented Interfaces:
CardGameReceiver, CardCodes, TurnGameController, com.threerings.presents.client.InvocationReceiver, com.threerings.presents.data.InvocationCodes, com.threerings.presents.dobj.AttributeChangeListener, com.threerings.presents.dobj.ChangeListener, ActionListener, EventListener
+
+
+
+
public abstract class CardGameController
extends GameController
implements TurnGameController, CardCodes, CardGameReceiver
+ + +

+A controller class for card games. Handles common functions like accepting dealt hands. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.crowd.client.PlaceController
com.threerings.crowd.client.PlaceController.DelegateOp
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.presents.client.InvocationReceiver
com.threerings.presents.client.InvocationReceiver.Registration
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class com.samskivert.swing.Controller
DISPATCHER
+  + + + + + + + +
Fields inherited from interface com.threerings.parlor.card.data.CardCodes
ACE, BLACK_JOKER, CLUBS, DIAMONDS, HEARTS, JACK, KING, QUEEN, RED_JOKER, SPADES
+  + + + + + + + +
Fields inherited from interface com.threerings.presents.data.InvocationCodes
ACCESS_DENIED, E_ACCESS_DENIED, E_INTERNAL_ERROR, GLOBAL_GROUP, INTERNAL_ERROR
+  + + + + + + + + + + +
+Constructor Summary
CardGameController() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidcardsTransferredBetweenPlayers(int fromidx, + int toidx, + int cards) + +
+          Dispatched to the client when a set of cards is transferred between two other players in + the game.
+ voiddidLeavePlace(com.threerings.crowd.data.PlaceObject plobj) + +
+          Removes our listener registration from the game object and cleans house.
+ voidreceivedCardsFromPlayer(int plidx, + Card[] cards) + +
+          Dispatched to the client when it has received a set of cards from another player.
+ voidreceivedHand(Hand hand) + +
+          Called when the server deals the client a new hand of cards.
+ voidreceivedHand(int oid, + Hand hand) + +
+          Called by our sender to notify us of a received hand.
+ voidsentCardsToPlayer(int plidx, + Card[] cards) + +
+          Dispatched to the client when the server has forced it to send a set of cards to another + player.
+ voidturnDidChange(com.threerings.util.Name turnHolder) + +
+          Called when the turn changed.
+ voidwillEnterPlace(com.threerings.crowd.data.PlaceObject plobj) + +
+          Adds this controller as a listener to the game object (thus derived classes need not do so) + and lets the game manager know that we are now ready to go.
+  + + + + + + + +
Methods inherited from class com.threerings.parlor.game.client.GameController
attributeChanged, getMatchType, getSessionId, handleAction, init, isGameOver, resetGame, setGameOver, systemMessage
+  + + + + + + + +
Methods inherited from class com.threerings.crowd.client.PlaceController
getPlaceConfig, getPlaceView, mayLeavePlace
+  + + + + + + + +
Methods inherited from class com.samskivert.swing.Controller
actionPerformed, configureAction, createActionButton, handleAction, handleAction, handleAction, postAction, postAction, postAction, setControlledPanel, wasAdded, wasRemoved
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+CardGameController

+
+public CardGameController()
+
+
+ + + + + + + + +
+Method Detail
+ +

+willEnterPlace

+
+public void willEnterPlace(com.threerings.crowd.data.PlaceObject plobj)
+
+
Description copied from class: GameController
+
Adds this controller as a listener to the game object (thus derived classes need not do so) + and lets the game manager know that we are now ready to go. +

+

+
Overrides:
willEnterPlace in class GameController
+
+
+
+
+
+
+ +

+didLeavePlace

+
+public void didLeavePlace(com.threerings.crowd.data.PlaceObject plobj)
+
+
Description copied from class: GameController
+
Removes our listener registration from the game object and cleans house. +

+

+
Overrides:
didLeavePlace in class GameController
+
+
+
+
+
+
+ +

+turnDidChange

+
+public void turnDidChange(com.threerings.util.Name turnHolder)
+
+
Description copied from interface: TurnGameController
+
Called when the turn changed. This indicates the start of a turn + and the user interface should adjust itself accordingly (activating + controls if it is our turn and deactivating them if it is not). +

+

+
Specified by:
turnDidChange in interface TurnGameController
+
+
+
Parameters:
turnHolder - the username of the new holder of the turn.
+
+
+
+ +

+receivedHand

+
+public final void receivedHand(int oid,
+                               Hand hand)
+
+
Called by our sender to notify us of a received hand. +

+

+
Specified by:
receivedHand in interface CardGameReceiver
+
+
+
Parameters:
oid - the oid of the game for which this hand applies
hand - the received hand
+
+
+
+ +

+receivedHand

+
+public void receivedHand(Hand hand)
+
+
Called when the server deals the client a new hand of cards. Default implementation does + nothing. +

+

+
+
+
+
Parameters:
hand - the hand dealt to the user
+
+
+
+ +

+receivedCardsFromPlayer

+
+public void receivedCardsFromPlayer(int plidx,
+                                    Card[] cards)
+
+
Dispatched to the client when it has received a set of cards from another player. Default + implementation does nothing. +

+

+
Specified by:
receivedCardsFromPlayer in interface CardGameReceiver
+
+
+
Parameters:
plidx - the index of the player providing the cards
cards - the cards received
+
+
+
+ +

+sentCardsToPlayer

+
+public void sentCardsToPlayer(int plidx,
+                              Card[] cards)
+
+
Dispatched to the client when the server has forced it to send a set of cards to another + player. Default implementation does nothing. +

+

+
Specified by:
sentCardsToPlayer in interface CardGameReceiver
+
+
+
Parameters:
plidx - the index of the player to which the cards were sent
cards - the cards sent
+
+
+
+ +

+cardsTransferredBetweenPlayers

+
+public void cardsTransferredBetweenPlayers(int fromidx,
+                                           int toidx,
+                                           int cards)
+
+
Dispatched to the client when a set of cards is transferred between two other players in + the game. Default implementation does nothing. +

+

+
Specified by:
cardsTransferredBetweenPlayers in interface CardGameReceiver
+
+
+
Parameters:
fromidx - the index of the player sending the cards
toidx - the index of the player receiving the cards
cards - the number of cards transferred
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/client/CardGameDecoder.html b/apidocs/com/threerings/parlor/card/client/CardGameDecoder.html new file mode 100644 index 00000000..7ac102db --- /dev/null +++ b/apidocs/com/threerings/parlor/card/client/CardGameDecoder.html @@ -0,0 +1,424 @@ + + + + + + + +CardGameDecoder (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.card.client +
+Class CardGameDecoder

+
+java.lang.Object
+  extended by com.threerings.presents.client.InvocationDecoder
+      extended by com.threerings.parlor.card.client.CardGameDecoder
+
+
+
+
public class CardGameDecoder
extends com.threerings.presents.client.InvocationDecoder
+ + +

+Dispatches calls to a CardGameReceiver instance. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static intCARDS_TRANSFERRED_BETWEEN_PLAYERS + +
+          The method id used to dispatch CardGameReceiver.cardsTransferredBetweenPlayers(int, int, int) + notifications.
+static intRECEIVED_CARDS_FROM_PLAYER + +
+          The method id used to dispatch CardGameReceiver.receivedCardsFromPlayer(int, com.threerings.parlor.card.data.Card[]) + notifications.
+static intRECEIVED_HAND + +
+          The method id used to dispatch CardGameReceiver.receivedHand(int, com.threerings.parlor.card.data.Hand) + notifications.
+static StringRECEIVER_CODE + +
+          The generated hash code used to identify this receiver class.
+static intSENT_CARDS_TO_PLAYER + +
+          The method id used to dispatch CardGameReceiver.sentCardsToPlayer(int, com.threerings.parlor.card.data.Card[]) + notifications.
+  + + + + + + + +
Fields inherited from class com.threerings.presents.client.InvocationDecoder
receiver
+  + + + + + + + + + + +
+Constructor Summary
CardGameDecoder(CardGameReceiver receiver) + +
+          Creates a decoder that may be registered to dispatch invocation + service notifications to the specified receiver.
+  + + + + + + + + + + + + + + + +
+Method Summary
+ voiddispatchNotification(int methodId, + Object[] args) + +
+           
+ StringgetReceiverCode() + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+RECEIVER_CODE

+
+public static final String RECEIVER_CODE
+
+
The generated hash code used to identify this receiver class. +

+

+
See Also:
Constant Field Values
+
+
+ +

+CARDS_TRANSFERRED_BETWEEN_PLAYERS

+
+public static final int CARDS_TRANSFERRED_BETWEEN_PLAYERS
+
+
The method id used to dispatch CardGameReceiver.cardsTransferredBetweenPlayers(int, int, int) + notifications. +

+

+
See Also:
Constant Field Values
+
+
+ +

+RECEIVED_CARDS_FROM_PLAYER

+
+public static final int RECEIVED_CARDS_FROM_PLAYER
+
+
The method id used to dispatch CardGameReceiver.receivedCardsFromPlayer(int, com.threerings.parlor.card.data.Card[]) + notifications. +

+

+
See Also:
Constant Field Values
+
+
+ +

+RECEIVED_HAND

+
+public static final int RECEIVED_HAND
+
+
The method id used to dispatch CardGameReceiver.receivedHand(int, com.threerings.parlor.card.data.Hand) + notifications. +

+

+
See Also:
Constant Field Values
+
+
+ +

+SENT_CARDS_TO_PLAYER

+
+public static final int SENT_CARDS_TO_PLAYER
+
+
The method id used to dispatch CardGameReceiver.sentCardsToPlayer(int, com.threerings.parlor.card.data.Card[]) + notifications. +

+

+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Constructor Detail
+ +

+CardGameDecoder

+
+public CardGameDecoder(CardGameReceiver receiver)
+
+
Creates a decoder that may be registered to dispatch invocation + service notifications to the specified receiver. +

+

+ + + + + + + + +
+Method Detail
+ +

+getReceiverCode

+
+public String getReceiverCode()
+
+
+
Specified by:
getReceiverCode in class com.threerings.presents.client.InvocationDecoder
+
+
+
+
+
+
+ +

+dispatchNotification

+
+public void dispatchNotification(int methodId,
+                                 Object[] args)
+
+
+
Overrides:
dispatchNotification in class com.threerings.presents.client.InvocationDecoder
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/client/CardGameReceiver.html b/apidocs/com/threerings/parlor/card/client/CardGameReceiver.html new file mode 100644 index 00000000..1789faf4 --- /dev/null +++ b/apidocs/com/threerings/parlor/card/client/CardGameReceiver.html @@ -0,0 +1,330 @@ + + + + + + + +CardGameReceiver (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.card.client +
+Interface CardGameReceiver

+
+
All Superinterfaces:
com.threerings.presents.client.InvocationReceiver
+
+
+
All Known Implementing Classes:
CardGameController
+
+
+
+
public interface CardGameReceiver
extends com.threerings.presents.client.InvocationReceiver
+ + +

+Defines, for the card game services, a set of notifications delivered + asynchronously by the server to the client. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.presents.client.InvocationReceiver
com.threerings.presents.client.InvocationReceiver.Registration
+  + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidcardsTransferredBetweenPlayers(int fromidx, + int toidx, + int cards) + +
+          Dispatched to the client when a set of cards is transferred between + two other players in the game.
+ voidreceivedCardsFromPlayer(int plidx, + Card[] cards) + +
+          Dispatched to the client when it has received a set of cards + from another player.
+ voidreceivedHand(int oid, + Hand hand) + +
+          Dispatched to the client when it has received a hand of cards.
+ voidsentCardsToPlayer(int plidx, + Card[] cards) + +
+          Dispatched to the client when the server has forced it to send + a set of cards to another player.
+  +

+ + + + + + + + +
+Method Detail
+ +

+receivedHand

+
+void receivedHand(int oid,
+                  Hand hand)
+
+
Dispatched to the client when it has received a hand of cards. +

+

+
+
+
+
Parameters:
oid - the oid of the game for which this hand applies
hand - the received hand
+
+
+
+ +

+receivedCardsFromPlayer

+
+void receivedCardsFromPlayer(int plidx,
+                             Card[] cards)
+
+
Dispatched to the client when it has received a set of cards + from another player. +

+

+
+
+
+
Parameters:
plidx - the index of the player providing the cards
cards - the cards received
+
+
+
+ +

+sentCardsToPlayer

+
+void sentCardsToPlayer(int plidx,
+                       Card[] cards)
+
+
Dispatched to the client when the server has forced it to send + a set of cards to another player. +

+

+
+
+
+
Parameters:
plidx - the index of the player to which the cards were sent
cards - the cards sent
+
+
+
+ +

+cardsTransferredBetweenPlayers

+
+void cardsTransferredBetweenPlayers(int fromidx,
+                                    int toidx,
+                                    int cards)
+
+
Dispatched to the client when a set of cards is transferred between + two other players in the game. +

+

+
+
+
+
Parameters:
fromidx - the index of the player sending the cards
toidx - the index of the player receiving the cards
cards - the number of cards transferred
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/client/CardPanel.CardSelectionObserver.html b/apidocs/com/threerings/parlor/card/client/CardPanel.CardSelectionObserver.html new file mode 100644 index 00000000..84e5d692 --- /dev/null +++ b/apidocs/com/threerings/parlor/card/client/CardPanel.CardSelectionObserver.html @@ -0,0 +1,237 @@ + + + + + + + +CardPanel.CardSelectionObserver (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.card.client +
+Interface CardPanel.CardSelectionObserver

+
+
Enclosing class:
CardPanel
+
+
+
+
public static interface CardPanel.CardSelectionObserver
+ + +

+A listener for card selection/deselection. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + +
+Method Summary
+ voidcardSpriteDeselected(CardSprite sprite) + +
+          Called when a card has been deselected.
+ voidcardSpriteSelected(CardSprite sprite) + +
+          Called when a card has been selected.
+  +

+ + + + + + + + +
+Method Detail
+ +

+cardSpriteSelected

+
+void cardSpriteSelected(CardSprite sprite)
+
+
Called when a card has been selected. +

+

+
+
+
+
+ +

+cardSpriteDeselected

+
+void cardSpriteDeselected(CardSprite sprite)
+
+
Called when a card has been deselected. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/client/CardPanel.html b/apidocs/com/threerings/parlor/card/client/CardPanel.html new file mode 100644 index 00000000..3d82c9d9 --- /dev/null +++ b/apidocs/com/threerings/parlor/card/client/CardPanel.html @@ -0,0 +1,1345 @@ + + + + + + + +CardPanel (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.card.client +
+Class CardPanel

+
+java.lang.Object
+  extended by java.awt.Component
+      extended by java.awt.Container
+          extended by javax.swing.JComponent
+              extended by com.threerings.media.MediaPanel
+                  extended by com.threerings.media.VirtualMediaPanel
+                      extended by com.threerings.parlor.card.client.CardPanel
+
+
+
All Implemented Interfaces:
com.threerings.media.FrameParticipant, com.threerings.media.MediaConstants, com.threerings.media.MediaHost, CardCodes, com.threerings.presents.data.InvocationCodes, ImageObserver, MenuContainer, Serializable
+
+
+
+
public abstract class CardPanel
extends com.threerings.media.VirtualMediaPanel
implements CardCodes
+ + +

+Extends VirtualMediaPanel to provide services specific to rendering and manipulating playing + cards. +

+ +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static interfaceCardPanel.CardSelectionObserver + +
+          A listener for card selection/deselection.
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.media.MediaPanel
com.threerings.media.MediaPanel.Obscurer
+  + + + + + + + + +
Nested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent
+  + + + + + + + + +
Nested classes/interfaces inherited from class java.awt.Component
Component.BaselineResizeBehavior
+  + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static intMULTIPLE + +
+          The selection mode in which the user can select multiple cards.
+static intNONE + +
+          The selection mode in which cards are not selectable.
+static intSINGLE + +
+          The selection mode in which the user can select a single card.
+  + + + + + + + +
Fields inherited from class com.threerings.media.VirtualMediaPanel
CENTER_ON_PATHABLE, ENCLOSE_PATHABLE, TRACK_PATHABLE
+  + + + + + + + +
Fields inherited from class javax.swing.JComponent
TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
+  + + + + + + + +
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
+  + + + + + + + +
Fields inherited from interface com.threerings.parlor.card.data.CardCodes
ACE, BLACK_JOKER, CLUBS, DIAMONDS, HEARTS, JACK, KING, QUEEN, RED_JOKER, SPADES
+  + + + + + + + +
Fields inherited from interface com.threerings.presents.data.InvocationCodes
ACCESS_DENIED, E_ACCESS_DENIED, E_INTERNAL_ERROR, GLOBAL_GROUP, INTERNAL_ERROR
+  + + + + + + + +
Fields inherited from interface com.threerings.media.MediaConstants
ALL, BACK, FRONT
+  + + + + + + + +
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
+  + + + + + + + + + + +
+Constructor Summary
CardPanel(com.threerings.media.FrameManager frameManager) + +
+          Constructor.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidaddHandSelectionObserver(CardPanel.CardSelectionObserver obs) + +
+          Adds an object to the list of observers to notify when cards in the hand are + selected/deselected.
+ voidaddToBoard(Card card, + Point dest) + +
+          Adds a card to the board immediately.
+ voidclearBoard() + +
+          Clears all cards from the board.
+ voidclearHand() + +
+          Clears all cards from the hand.
+ voidclearHandSelection() + +
+          Clears any existing hand sprite selection.
+ voiddeselectHandSprite(CardSprite sprite) + +
+          Programmatically deselects a sprite in the hand.
+ voidflyAcross(Card[] cards, + Point src, + Point dest, + long flightDuration, + long cardDelay, + float fadePortion) + +
+          Flies a set of cards from the ether into the ether.
+ voidflyAcross(int number, + Point src, + Point dest, + long flightDuration, + long cardDelay, + float fadePortion) + +
+          Flies a set of cards from the ether into the ether face-down.
+ voidflyFromBoard(CardSprite[] cards, + Point dest, + long flightDuration, + float fadePortion) + +
+          Flies a set of cards from the board into the ether.
+ voidflyFromBoard(CardSprite[] cards, + Point dest1, + Point dest2, + long flightDuration, + float fadePortion) + +
+          Flies a set of cards from the board into the ether through an intermediate point.
+ voidflyFromHand(CardSprite[] cards, + Point dest, + long flightDuration, + float fadePortion) + +
+          Flies a set of cards from the hand into the ether.
+ voidflyFromHandToBoard(CardSprite card, + Point dest, + long flightDuration) + +
+          Flies a card from the hand onto the board.
+ voidflyIntoHand(Card[] cards, + Point src, + long flightDuration, + long pauseDuration, + long dropDuration, + float fadePortion) + +
+          Flies a set of cards from the ether into the hand.
+ voidflyToBoard(Card card, + Point src, + Point dest, + long flightDuration, + float fadePortion) + +
+          Flies a card from the ether onto the board.
+abstract  com.threerings.media.image.MiragegetCardBackImage() + +
+          Returns the full-sized image for the back of a playing card.
+abstract  com.threerings.media.image.MiragegetCardImage(Card card) + +
+          Returns the full-sized image for the front of the specified card.
+ CardSpritegetHandSprite(Card card) + +
+          Returns the first sprite in the hand that corresponds to the specified card, or null if the + card is not in the hand.
+abstract  com.threerings.media.image.MiragegetMicroCardBackImage() + +
+          Returns the small-sized image for the back of a playing card.
+abstract  com.threerings.media.image.MiragegetMicroCardImage(Card card) + +
+          Returns the small-sized image for the front of the specified card.
+ CardSpritegetSelectedHandSprite() + +
+          Returns the currently selected hand sprite (null if no sprites are selected, the first + sprite if multiple sprites are selected).
+ CardSprite[]getSelectedHandSprites() + +
+          Returns an array containing the currently selected hand sprites (returns an empty array if + no sprites are selected).
+ voidremoveHandSelectionObserver(CardPanel.CardSelectionObserver obs) + +
+          Removes an object from the hand selection observer list.
+ voidselectHandSprite(CardSprite sprite) + +
+          Programmatically selects a sprite in the hand.
+ voidsetHand(Hand hand, + long fadeDuration) + +
+          Fades a hand of cards in.
+ voidsetHand(int size, + long fadeDuration) + +
+          Fades a hand of cards in face-down.
+ voidsetHandLocation(int x, + int y) + +
+          Sets the location of the hand (the location of the center of the hand's upper edge).
+ voidsetHandSelectionMode(int mode) + +
+          Sets the selection mode for the hand (NONE, PLAY_SINGLE, SINGLE, or MULTIPLE).
+ voidsetHandSelectionPredicate(Predicate<CardSprite> pred) + +
+          Sets the selection predicate that determines which cards from the hand may be selected (if + null, all cards may be selected).
+ voidsetHandSpacing(int spacing) + +
+          Sets the horizontal spacing between cards in the hand.
+ voidsetSelectableCardOffset(int offset) + +
+          Sets the vertical distance to offset cards that are selectable or playable.
+ voidsetSelectedCardOffset(int offset) + +
+          Sets the vertical distance to offset cards that are selected.
+ voidshowHand(Hand hand) + +
+          Shows a hand that was previous set face-down.
+  + + + + + + + +
Methods inherited from class com.threerings.media.VirtualMediaPanel
addViewTracker, clearPathable, doLayout, getViewBounds, removeViewTracker, setBackground, setBounds, setFollowsPathable, setViewLocation
+  + + + + + + + +
Methods inherited from class com.threerings.media.MediaPanel
abortAnimation, addAnimation, addObscurer, addSprite, clearAnimations, clearSprites, createGraphics, getAnimationManager, getComponent, getRegionManager, getSpriteManager, getTimeStamp, isManaged, isManaged, needsPaint, paint, removeObscurer, removeSprite, repaint, setOpaque, setPaused, tick
+  + + + + + + + +
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI
+  + + + + + + + +
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate
+  + + + + + + + +
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+NONE

+
+public static final int NONE
+
+
The selection mode in which cards are not selectable. +

+

+
See Also:
Constant Field Values
+
+
+ +

+SINGLE

+
+public static final int SINGLE
+
+
The selection mode in which the user can select a single card. +

+

+
See Also:
Constant Field Values
+
+
+ +

+MULTIPLE

+
+public static final int MULTIPLE
+
+
The selection mode in which the user can select multiple cards. +

+

+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Constructor Detail
+ +

+CardPanel

+
+public CardPanel(com.threerings.media.FrameManager frameManager)
+
+
Constructor. +

+

+
Parameters:
frameManager - the frame manager
+
+ + + + + + + + +
+Method Detail
+ +

+getCardBackImage

+
+public abstract com.threerings.media.image.Mirage getCardBackImage()
+
+
Returns the full-sized image for the back of a playing card. +

+

+
+
+
+
+
+
+
+ +

+getCardImage

+
+public abstract com.threerings.media.image.Mirage getCardImage(Card card)
+
+
Returns the full-sized image for the front of the specified card. +

+

+
+
+
+
+
+
+
+ +

+getMicroCardBackImage

+
+public abstract com.threerings.media.image.Mirage getMicroCardBackImage()
+
+
Returns the small-sized image for the back of a playing card. +

+

+
+
+
+
+
+
+
+ +

+getMicroCardImage

+
+public abstract com.threerings.media.image.Mirage getMicroCardImage(Card card)
+
+
Returns the small-sized image for the front of the specified card. +

+

+
+
+
+
+
+
+
+ +

+setHandLocation

+
+public void setHandLocation(int x,
+                            int y)
+
+
Sets the location of the hand (the location of the center of the hand's upper edge). +

+

+
+
+
+
+
+
+
+ +

+setHandSpacing

+
+public void setHandSpacing(int spacing)
+
+
Sets the horizontal spacing between cards in the hand. +

+

+
+
+
+
+
+
+
+ +

+setSelectableCardOffset

+
+public void setSelectableCardOffset(int offset)
+
+
Sets the vertical distance to offset cards that are selectable or playable. +

+

+
+
+
+
+
+
+
+ +

+setSelectedCardOffset

+
+public void setSelectedCardOffset(int offset)
+
+
Sets the vertical distance to offset cards that are selected. +

+

+
+
+
+
+
+
+
+ +

+setHandSelectionMode

+
+public void setHandSelectionMode(int mode)
+
+
Sets the selection mode for the hand (NONE, PLAY_SINGLE, SINGLE, or MULTIPLE). Changing the + selection mode does not change the current selection. +

+

+
+
+
+
+
+
+
+ +

+setHandSelectionPredicate

+
+public void setHandSelectionPredicate(Predicate<CardSprite> pred)
+
+
Sets the selection predicate that determines which cards from the hand may be selected (if + null, all cards may be selected). Changing the predicate does not change the current + selection. +

+

+
+
+
+
+
+
+
+ +

+getSelectedHandSprite

+
+public CardSprite getSelectedHandSprite()
+
+
Returns the currently selected hand sprite (null if no sprites are selected, the first + sprite if multiple sprites are selected). +

+

+
+
+
+
+
+
+
+ +

+getSelectedHandSprites

+
+public CardSprite[] getSelectedHandSprites()
+
+
Returns an array containing the currently selected hand sprites (returns an empty array if + no sprites are selected). +

+

+
+
+
+
+
+
+
+ +

+selectHandSprite

+
+public void selectHandSprite(CardSprite sprite)
+
+
Programmatically selects a sprite in the hand. +

+

+
+
+
+
+
+
+
+ +

+deselectHandSprite

+
+public void deselectHandSprite(CardSprite sprite)
+
+
Programmatically deselects a sprite in the hand. +

+

+
+
+
+
+
+
+
+ +

+clearHandSelection

+
+public void clearHandSelection()
+
+
Clears any existing hand sprite selection. +

+

+
+
+
+
+
+
+
+ +

+addHandSelectionObserver

+
+public void addHandSelectionObserver(CardPanel.CardSelectionObserver obs)
+
+
Adds an object to the list of observers to notify when cards in the hand are + selected/deselected. +

+

+
+
+
+
+
+
+
+ +

+removeHandSelectionObserver

+
+public void removeHandSelectionObserver(CardPanel.CardSelectionObserver obs)
+
+
Removes an object from the hand selection observer list. +

+

+
+
+
+
+
+
+
+ +

+setHand

+
+public void setHand(Hand hand,
+                    long fadeDuration)
+
+
Fades a hand of cards in. +

+

+
+
+
+
Parameters:
hand - the hand of cards
fadeDuration - the amount of time to spend fading in the entire hand
+
+
+
+ +

+setHand

+
+public void setHand(int size,
+                    long fadeDuration)
+
+
Fades a hand of cards in face-down. +

+

+
+
+
+
Parameters:
size - the size of the hand
fadeDuration - the amount of time to spend fading in each card
+
+
+
+ +

+showHand

+
+public void showHand(Hand hand)
+
+
Shows a hand that was previous set face-down. +

+

+
+
+
+
Parameters:
hand - the hand of cards
+
+
+
+ +

+getHandSprite

+
+public CardSprite getHandSprite(Card card)
+
+
Returns the first sprite in the hand that corresponds to the specified card, or null if the + card is not in the hand. +

+

+
+
+
+
+
+
+
+ +

+clearHand

+
+public void clearHand()
+
+
Clears all cards from the hand. +

+

+
+
+
+
+
+
+
+ +

+clearBoard

+
+public void clearBoard()
+
+
Clears all cards from the board. +

+

+
+
+
+
+
+
+
+ +

+flyFromHand

+
+public void flyFromHand(CardSprite[] cards,
+                        Point dest,
+                        long flightDuration,
+                        float fadePortion)
+
+
Flies a set of cards from the hand into the ether. Clears any selected cards. +

+

+
+
+
+
Parameters:
cards - the card sprites to remove from the hand
dest - the point to fly the cards to
flightDuration - the duration of the cards' flight
fadePortion - the amount of time to spend fading out as a proportion of the flight + duration
+
+
+
+ +

+flyIntoHand

+
+public void flyIntoHand(Card[] cards,
+                        Point src,
+                        long flightDuration,
+                        long pauseDuration,
+                        long dropDuration,
+                        float fadePortion)
+
+
Flies a set of cards from the ether into the hand. Clears any selected cards. The cards + will first fly to the selected card offset, pause for the specified duration, and then drop + into the hand. +

+

+
+
+
+
Parameters:
cards - the cards to add to the hand
src - the point to fly the cards from
flightDuration - the duration of the cards' flight
pauseDuration - the duration of the pause before dropping into the hand
dropDuration - the duration of the cards' drop into the hand
fadePortion - the amount of time to spend fading in as a proportion of the flight + duration
+
+
+
+ +

+flyAcross

+
+public void flyAcross(Card[] cards,
+                      Point src,
+                      Point dest,
+                      long flightDuration,
+                      long cardDelay,
+                      float fadePortion)
+
+
Flies a set of cards from the ether into the ether. +

+

+
+
+
+
Parameters:
cards - the cards to fly across
src - the point to fly the cards from
dest - the point to fly the cards to
flightDuration - the duration of the cards' flight
cardDelay - the amount of time to wait between cards
fadePortion - the amount of time to spend fading in and out as a proportion of the + flight duration
+
+
+
+ +

+flyAcross

+
+public void flyAcross(int number,
+                      Point src,
+                      Point dest,
+                      long flightDuration,
+                      long cardDelay,
+                      float fadePortion)
+
+
Flies a set of cards from the ether into the ether face-down. +

+

+
+
+
+
Parameters:
number - the number of cards to fly across
src - the point to fly the cards from
dest - the point to fly the cards to
flightDuration - the duration of the cards' flight
cardDelay - the amount of time to wait between cards
fadePortion - the amount of time to spend fading in and out as a proportion of the + flight duration
+
+
+
+ +

+flyFromHandToBoard

+
+public void flyFromHandToBoard(CardSprite card,
+                               Point dest,
+                               long flightDuration)
+
+
Flies a card from the hand onto the board. Clears any cards selected. +

+

+
+
+
+
Parameters:
card - the sprite to remove from the hand
dest - the point to fly the card to
flightDuration - the duration of the card's flight
+
+
+
+ +

+flyToBoard

+
+public void flyToBoard(Card card,
+                       Point src,
+                       Point dest,
+                       long flightDuration,
+                       float fadePortion)
+
+
Flies a card from the ether onto the board. +

+

+
+
+
+
Parameters:
card - the card to add to the board
src - the point to fly the card from
dest - the point to fly the card to
flightDuration - the duration of the card's flight
fadePortion - the amount of time to spend fading in as a proportion of the flight + duration
+
+
+
+ +

+addToBoard

+
+public void addToBoard(Card card,
+                       Point dest)
+
+
Adds a card to the board immediately. +

+

+
+
+
+
Parameters:
card - the card to add to the board
dest - the point at which to add the card
+
+
+
+ +

+flyFromBoard

+
+public void flyFromBoard(CardSprite[] cards,
+                         Point dest,
+                         long flightDuration,
+                         float fadePortion)
+
+
Flies a set of cards from the board into the ether. +

+

+
+
+
+
Parameters:
cards - the cards to remove from the board
dest - the point to fly the cards to
flightDuration - the duration of the cards' flight
fadePortion - the amount of time to spend fading out as a proportion of the flight + duration
+
+
+
+ +

+flyFromBoard

+
+public void flyFromBoard(CardSprite[] cards,
+                         Point dest1,
+                         Point dest2,
+                         long flightDuration,
+                         float fadePortion)
+
+
Flies a set of cards from the board into the ether through an intermediate point. +

+

+
+
+
+
Parameters:
cards - the cards to remove from the board
dest1 - the first point to fly the cards to
dest2 - the final destination of the cards
flightDuration - the duration of the cards' flight
fadePortion - the amount of time to spend fading out as a proportion of the flight + duration
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/client/CardSprite.html b/apidocs/com/threerings/parlor/card/client/CardSprite.html new file mode 100644 index 00000000..b702beb6 --- /dev/null +++ b/apidocs/com/threerings/parlor/card/client/CardSprite.html @@ -0,0 +1,564 @@ + + + + + + + +CardSprite (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.card.client +
+Class CardSprite

+
+java.lang.Object
+  extended by com.threerings.media.AbstractMedia
+      extended by com.threerings.media.sprite.Sprite
+          extended by com.threerings.media.sprite.ImageSprite
+              extended by com.threerings.media.sprite.OrientableImageSprite
+                  extended by com.threerings.media.sprite.FadableImageSprite
+                      extended by com.threerings.parlor.card.client.CardSprite
+
+
+
All Implemented Interfaces:
com.threerings.media.util.Pathable, com.threerings.util.DirectionCodes, Shape
+
+
+
Direct Known Subclasses:
MicroCardSprite
+
+
+
+
public class CardSprite
extends com.threerings.media.sprite.FadableImageSprite
+ + +

+A sprite representing a playing card. +

+ +

+

+ +

+ + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class com.threerings.media.sprite.ImageSprite
DEFAULT_FRAME_RATE, MOVEMENT_CUED, NO_ANIMATION, TIME_BASED, TIME_SEQUENTIAL
+  + + + + + + + +
Fields inherited from class com.threerings.media.AbstractMedia
HUD_LAYER
+  + + + + + + + +
Fields inherited from interface com.threerings.util.DirectionCodes
CARDINAL_DIRECTIONS, CCW, CW, DIRECTION_COUNT, DOWN, EAST, EASTNORTHEAST, EASTSOUTHEAST, FINE_DIRECTION_COUNT, HORIZONTAL, LEFT, NONE, NORTH, NORTHEAST, NORTHNORTHEAST, NORTHNORTHWEST, NORTHWEST, RIGHT, SOUTH, SOUTHEAST, SOUTHSOUTHEAST, SOUTHSOUTHWEST, SOUTHWEST, UP, VERTICAL, WEST, WESTNORTHWEST, WESTSOUTHWEST
+  + + + + + + + + + + + + + +
+Constructor Summary
CardSprite(CardPanel panel, + Card card) + +
+          Creates a new upward-facing card sprite.
CardSprite(CardPanel panel, + Card card, + boolean facingUp) + +
+          Creates a new card sprite.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidflip(Card newCard, + long duration) + +
+          Flip the card from its current displayed card to the specified card.
+ CardgetCard() + +
+          Returns the card being depicted.
+ booleanisDraggable() + +
+          Checks whether or not the user can drag this card.
+ booleanisFacingUp() + +
+          Checks whether this card is facing up or down.
+ voidpaint(Graphics2D gfx) + +
+           
+ voidsetCard(Card card) + +
+          Sets the card to depict.
+ voidsetDraggable(boolean draggable) + +
+          Sets whether or not the user can drag this card around the board.
+ voidsetFacingUp(boolean facingUp) + +
+          Turns this card up or down.
+ voidtick(long tickStamp) + +
+           
+  + + + + + + + +
Methods inherited from class com.threerings.media.sprite.FadableImageSprite
fadeIn, fadeOut, getAlpha, moveAndFadeIn, moveAndFadeInAndOut, moveAndFadeOut, pathCompleted, setAlpha
+  + + + + + + + +
Methods inherited from class com.threerings.media.sprite.OrientableImageSprite
setOrientation
+  + + + + + + + +
Methods inherited from class com.threerings.media.sprite.ImageSprite
hitTest, layout, setAnimationMode, setFrameRate, setFrames, setMirage
+  + + + + + + + +
Methods inherited from class com.threerings.media.sprite.Sprite
addSpriteObserver, cancelMove, contains, fastForward, getHeight, getOrientation, getPath, getWidth, getX, getXOffset, getY, getYOffset, inside, intersects, isMoving, move, paintPath, pathBeginning, removeSpriteObserver, setLocation, viewLocationDidChange
+  + + + + + + + +
Methods inherited from class com.threerings.media.AbstractMedia
contains, contains, contains, contains, getBounds, getBounds2D, getPathIterator, getPathIterator, getRenderOrder, init, intersects, intersects, invalidate, queueNotification, renderCompareTo, setRenderOrder, toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  + + + + + + + +
Methods inherited from interface com.threerings.media.util.Pathable
getBounds
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+CardSprite

+
+public CardSprite(CardPanel panel,
+                  Card card)
+
+
Creates a new upward-facing card sprite. +

+

+
Parameters:
panel - the panel responsible for the sprite
card - the card to depict (can be null, in which case the + card back will be shown)
+
+
+ +

+CardSprite

+
+public CardSprite(CardPanel panel,
+                  Card card,
+                  boolean facingUp)
+
+
Creates a new card sprite. +

+

+
Parameters:
panel - the panel responsible for the sprite
card - the card to depict
facingUp - whether or not the card should be facing up
+
+ + + + + + + + +
+Method Detail
+ +

+setCard

+
+public void setCard(Card card)
+
+
Sets the card to depict. +

+

+
Parameters:
card - the new card
+
+
+
+ +

+getCard

+
+public Card getCard()
+
+
Returns the card being depicted. +

+

+ +
Returns:
the current card
+
+
+
+ +

+setFacingUp

+
+public void setFacingUp(boolean facingUp)
+
+
Turns this card up or down. +

+

+
Parameters:
facingUp - whether or not the card should be facing up
+
+
+
+ +

+isFacingUp

+
+public boolean isFacingUp()
+
+
Checks whether this card is facing up or down. +

+

+ +
Returns:
true if the card is facing up, false if facing down
+
+
+
+ +

+setDraggable

+
+public void setDraggable(boolean draggable)
+
+
Sets whether or not the user can drag this card around the board. +

+

+
Parameters:
draggable - whether or not the user can drag the card
+
+
+
+ +

+isDraggable

+
+public boolean isDraggable()
+
+
Checks whether or not the user can drag this card. +

+

+ +
Returns:
true if the user can drag the card, false if not
+
+
+
+ +

+flip

+
+public void flip(Card newCard,
+                 long duration)
+
+
Flip the card from its current displayed card to the specified card. +

+

+
+
+
+
+ +

+tick

+
+public void tick(long tickStamp)
+
+
+
Overrides:
tick in class com.threerings.media.sprite.FadableImageSprite
+
+
+
+
+
+
+ +

+paint

+
+public void paint(Graphics2D gfx)
+
+
+
Overrides:
paint in class com.threerings.media.sprite.FadableImageSprite
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/client/CardSpriteObserver.html b/apidocs/com/threerings/parlor/card/client/CardSpriteObserver.html new file mode 100644 index 00000000..27acae79 --- /dev/null +++ b/apidocs/com/threerings/parlor/card/client/CardSpriteObserver.html @@ -0,0 +1,290 @@ + + + + + + + +CardSpriteObserver (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.card.client +
+Interface CardSpriteObserver

+
+
+
public interface CardSpriteObserver
+ + +

+Observer interface for (draggable) card sprites. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidcardSpriteClicked(CardSprite sprite, + MouseEvent me) + +
+          Notifies the observer that the user clicked a card sprite.
+ voidcardSpriteDragged(CardSprite sprite, + MouseEvent me) + +
+          Notifies the observer that the user dragged a card sprite to a new + location.
+ voidcardSpriteEntered(CardSprite sprite, + MouseEvent me) + +
+          Notifies the observer that the user moved the mouse pointer onto + a card sprite.
+ voidcardSpriteExited(CardSprite sprite, + MouseEvent me) + +
+          Notifies the observer that the user moved the mouse pointer off of + a card sprite.
+  +

+ + + + + + + + +
+Method Detail
+ +

+cardSpriteClicked

+
+void cardSpriteClicked(CardSprite sprite,
+                       MouseEvent me)
+
+
Notifies the observer that the user clicked a card sprite. +

+

+
Parameters:
sprite - the dragged sprite
me - the mouse event associated with the drag
+
+
+
+ +

+cardSpriteEntered

+
+void cardSpriteEntered(CardSprite sprite,
+                       MouseEvent me)
+
+
Notifies the observer that the user moved the mouse pointer onto + a card sprite. +

+

+
Parameters:
sprite - the entered sprite
me - the mouse event associated with the entrance
+
+
+
+ +

+cardSpriteExited

+
+void cardSpriteExited(CardSprite sprite,
+                      MouseEvent me)
+
+
Notifies the observer that the user moved the mouse pointer off of + a card sprite. +

+

+
Parameters:
sprite - the exited the sprite
me - the mouse event associated with the exit
+
+
+
+ +

+cardSpriteDragged

+
+void cardSpriteDragged(CardSprite sprite,
+                       MouseEvent me)
+
+
Notifies the observer that the user dragged a card sprite to a new + location. +

+

+
Parameters:
sprite - the dragged sprite
me - the mouse event associated with the drag
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/client/MicroCardSprite.html b/apidocs/com/threerings/parlor/card/client/MicroCardSprite.html new file mode 100644 index 00000000..a7b2d9c0 --- /dev/null +++ b/apidocs/com/threerings/parlor/card/client/MicroCardSprite.html @@ -0,0 +1,362 @@ + + + + + + + +MicroCardSprite (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.card.client +
+Class MicroCardSprite

+
+java.lang.Object
+  extended by com.threerings.media.AbstractMedia
+      extended by com.threerings.media.sprite.Sprite
+          extended by com.threerings.media.sprite.ImageSprite
+              extended by com.threerings.media.sprite.OrientableImageSprite
+                  extended by com.threerings.media.sprite.FadableImageSprite
+                      extended by com.threerings.parlor.card.client.CardSprite
+                          extended by com.threerings.parlor.card.client.MicroCardSprite
+
+
+
All Implemented Interfaces:
com.threerings.media.util.Pathable, com.threerings.util.DirectionCodes, Shape
+
+
+
+
public class MicroCardSprite
extends CardSprite
+ + +

+

+ +

+ + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class com.threerings.media.sprite.ImageSprite
DEFAULT_FRAME_RATE, MOVEMENT_CUED, NO_ANIMATION, TIME_BASED, TIME_SEQUENTIAL
+  + + + + + + + +
Fields inherited from class com.threerings.media.AbstractMedia
HUD_LAYER
+  + + + + + + + +
Fields inherited from interface com.threerings.util.DirectionCodes
CARDINAL_DIRECTIONS, CCW, CW, DIRECTION_COUNT, DOWN, EAST, EASTNORTHEAST, EASTSOUTHEAST, FINE_DIRECTION_COUNT, HORIZONTAL, LEFT, NONE, NORTH, NORTHEAST, NORTHNORTHEAST, NORTHNORTHWEST, NORTHWEST, RIGHT, SOUTH, SOUTHEAST, SOUTHSOUTHEAST, SOUTHSOUTHWEST, SOUTHWEST, UP, VERTICAL, WEST, WESTNORTHWEST, WESTSOUTHWEST
+  + + + + + + + + + + + + + +
+Constructor Summary
MicroCardSprite(CardPanel panel, + Card card) + +
+          Creates a new upward-facing micro-card sprite.
MicroCardSprite(CardPanel panel, + Card card, + boolean facingUp) + +
+          Creates a new micro-card sprite.
+  + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from class com.threerings.parlor.card.client.CardSprite
flip, getCard, isDraggable, isFacingUp, paint, setCard, setDraggable, setFacingUp, tick
+  + + + + + + + +
Methods inherited from class com.threerings.media.sprite.FadableImageSprite
fadeIn, fadeOut, getAlpha, moveAndFadeIn, moveAndFadeInAndOut, moveAndFadeOut, pathCompleted, setAlpha
+  + + + + + + + +
Methods inherited from class com.threerings.media.sprite.OrientableImageSprite
setOrientation
+  + + + + + + + +
Methods inherited from class com.threerings.media.sprite.ImageSprite
hitTest, layout, setAnimationMode, setFrameRate, setFrames, setMirage
+  + + + + + + + +
Methods inherited from class com.threerings.media.sprite.Sprite
addSpriteObserver, cancelMove, contains, fastForward, getHeight, getOrientation, getPath, getWidth, getX, getXOffset, getY, getYOffset, inside, intersects, isMoving, move, paintPath, pathBeginning, removeSpriteObserver, setLocation, viewLocationDidChange
+  + + + + + + + +
Methods inherited from class com.threerings.media.AbstractMedia
contains, contains, contains, contains, getBounds, getBounds2D, getPathIterator, getPathIterator, getRenderOrder, init, intersects, intersects, invalidate, queueNotification, renderCompareTo, setRenderOrder, toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  + + + + + + + +
Methods inherited from interface com.threerings.media.util.Pathable
getBounds
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+MicroCardSprite

+
+public MicroCardSprite(CardPanel panel,
+                       Card card)
+
+
Creates a new upward-facing micro-card sprite. +

+

+
Parameters:
panel - the panel responsible for the sprite
card - the card to depict (can be null, in which case the + card back will be shown)
+
+
+ +

+MicroCardSprite

+
+public MicroCardSprite(CardPanel panel,
+                       Card card,
+                       boolean facingUp)
+
+
Creates a new micro-card sprite. +

+

+
Parameters:
panel - the panel responsible for the sprite
card - the card to depict
facingUp - whether or not the card should be facing up
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/client/class-use/CardGameController.html b/apidocs/com/threerings/parlor/card/client/class-use/CardGameController.html new file mode 100644 index 00000000..36237372 --- /dev/null +++ b/apidocs/com/threerings/parlor/card/client/class-use/CardGameController.html @@ -0,0 +1,179 @@ + + + + + + + +Uses of Class com.threerings.parlor.card.client.CardGameController (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.card.client.CardGameController

+
+ + + + + + + + + +
+Packages that use CardGameController
com.threerings.parlor.card.trick.client  
+  +

+ + + + + +
+Uses of CardGameController in com.threerings.parlor.card.trick.client
+  +

+ + + + + + + + +
Constructors in com.threerings.parlor.card.trick.client with parameters of type CardGameController
TrickCardGameControllerDelegate(CardGameController controller) + +
+          Constructor.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/client/class-use/CardGameDecoder.html b/apidocs/com/threerings/parlor/card/client/class-use/CardGameDecoder.html new file mode 100644 index 00000000..994ee513 --- /dev/null +++ b/apidocs/com/threerings/parlor/card/client/class-use/CardGameDecoder.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.parlor.card.client.CardGameDecoder (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.card.client.CardGameDecoder

+
+No usage of com.threerings.parlor.card.client.CardGameDecoder +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/client/class-use/CardGameReceiver.html b/apidocs/com/threerings/parlor/card/client/class-use/CardGameReceiver.html new file mode 100644 index 00000000..4205035e --- /dev/null +++ b/apidocs/com/threerings/parlor/card/client/class-use/CardGameReceiver.html @@ -0,0 +1,196 @@ + + + + + + + +Uses of Interface com.threerings.parlor.card.client.CardGameReceiver (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.parlor.card.client.CardGameReceiver

+
+ + + + + + + + + +
+Packages that use CardGameReceiver
com.threerings.parlor.card.client  
+  +

+ + + + + +
+Uses of CardGameReceiver in com.threerings.parlor.card.client
+  +

+ + + + + + + + + +
Classes in com.threerings.parlor.card.client that implement CardGameReceiver
+ classCardGameController + +
+          A controller class for card games.
+  +

+ + + + + + + + +
Constructors in com.threerings.parlor.card.client with parameters of type CardGameReceiver
CardGameDecoder(CardGameReceiver receiver) + +
+          Creates a decoder that may be registered to dispatch invocation + service notifications to the specified receiver.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/client/class-use/CardPanel.CardSelectionObserver.html b/apidocs/com/threerings/parlor/card/client/class-use/CardPanel.CardSelectionObserver.html new file mode 100644 index 00000000..9fd25f38 --- /dev/null +++ b/apidocs/com/threerings/parlor/card/client/class-use/CardPanel.CardSelectionObserver.html @@ -0,0 +1,190 @@ + + + + + + + +Uses of Interface com.threerings.parlor.card.client.CardPanel.CardSelectionObserver (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.parlor.card.client.CardPanel.CardSelectionObserver

+
+ + + + + + + + + +
+Packages that use CardPanel.CardSelectionObserver
com.threerings.parlor.card.client  
+  +

+ + + + + +
+Uses of CardPanel.CardSelectionObserver in com.threerings.parlor.card.client
+  +

+ + + + + + + + + + + + + +
Methods in com.threerings.parlor.card.client with parameters of type CardPanel.CardSelectionObserver
+ voidCardPanel.addHandSelectionObserver(CardPanel.CardSelectionObserver obs) + +
+          Adds an object to the list of observers to notify when cards in the hand are + selected/deselected.
+ voidCardPanel.removeHandSelectionObserver(CardPanel.CardSelectionObserver obs) + +
+          Removes an object from the hand selection observer list.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/client/class-use/CardPanel.html b/apidocs/com/threerings/parlor/card/client/class-use/CardPanel.html new file mode 100644 index 00000000..60571441 --- /dev/null +++ b/apidocs/com/threerings/parlor/card/client/class-use/CardPanel.html @@ -0,0 +1,203 @@ + + + + + + + +Uses of Class com.threerings.parlor.card.client.CardPanel (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.card.client.CardPanel

+
+ + + + + + + + + +
+Packages that use CardPanel
com.threerings.parlor.card.client  
+  +

+ + + + + +
+Uses of CardPanel in com.threerings.parlor.card.client
+  +

+ + + + + + + + + + + + + + + + + +
Constructors in com.threerings.parlor.card.client with parameters of type CardPanel
CardSprite(CardPanel panel, + Card card) + +
+          Creates a new upward-facing card sprite.
CardSprite(CardPanel panel, + Card card, + boolean facingUp) + +
+          Creates a new card sprite.
MicroCardSprite(CardPanel panel, + Card card) + +
+          Creates a new upward-facing micro-card sprite.
MicroCardSprite(CardPanel panel, + Card card, + boolean facingUp) + +
+          Creates a new micro-card sprite.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/client/class-use/CardSprite.html b/apidocs/com/threerings/parlor/card/client/class-use/CardSprite.html new file mode 100644 index 00000000..c3d53e2f --- /dev/null +++ b/apidocs/com/threerings/parlor/card/client/class-use/CardSprite.html @@ -0,0 +1,356 @@ + + + + + + + +Uses of Class com.threerings.parlor.card.client.CardSprite (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.card.client.CardSprite

+
+ + + + + + + + + +
+Packages that use CardSprite
com.threerings.parlor.card.client  
+  +

+ + + + + +
+Uses of CardSprite in com.threerings.parlor.card.client
+  +

+ + + + + + + + + +
Subclasses of CardSprite in com.threerings.parlor.card.client
+ classMicroCardSprite + +
+           
+  +

+ + + + + + + + + + + + + + + + + +
Methods in com.threerings.parlor.card.client that return CardSprite
+ CardSpriteCardPanel.getHandSprite(Card card) + +
+          Returns the first sprite in the hand that corresponds to the specified card, or null if the + card is not in the hand.
+ CardSpriteCardPanel.getSelectedHandSprite() + +
+          Returns the currently selected hand sprite (null if no sprites are selected, the first + sprite if multiple sprites are selected).
+ CardSprite[]CardPanel.getSelectedHandSprites() + +
+          Returns an array containing the currently selected hand sprites (returns an empty array if + no sprites are selected).
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in com.threerings.parlor.card.client with parameters of type CardSprite
+ voidCardSpriteObserver.cardSpriteClicked(CardSprite sprite, + MouseEvent me) + +
+          Notifies the observer that the user clicked a card sprite.
+ voidCardPanel.CardSelectionObserver.cardSpriteDeselected(CardSprite sprite) + +
+          Called when a card has been deselected.
+ voidCardSpriteObserver.cardSpriteDragged(CardSprite sprite, + MouseEvent me) + +
+          Notifies the observer that the user dragged a card sprite to a new + location.
+ voidCardSpriteObserver.cardSpriteEntered(CardSprite sprite, + MouseEvent me) + +
+          Notifies the observer that the user moved the mouse pointer onto + a card sprite.
+ voidCardSpriteObserver.cardSpriteExited(CardSprite sprite, + MouseEvent me) + +
+          Notifies the observer that the user moved the mouse pointer off of + a card sprite.
+ voidCardPanel.CardSelectionObserver.cardSpriteSelected(CardSprite sprite) + +
+          Called when a card has been selected.
+ voidCardPanel.deselectHandSprite(CardSprite sprite) + +
+          Programmatically deselects a sprite in the hand.
+ voidCardPanel.flyFromBoard(CardSprite[] cards, + Point dest, + long flightDuration, + float fadePortion) + +
+          Flies a set of cards from the board into the ether.
+ voidCardPanel.flyFromBoard(CardSprite[] cards, + Point dest1, + Point dest2, + long flightDuration, + float fadePortion) + +
+          Flies a set of cards from the board into the ether through an intermediate point.
+ voidCardPanel.flyFromHand(CardSprite[] cards, + Point dest, + long flightDuration, + float fadePortion) + +
+          Flies a set of cards from the hand into the ether.
+ voidCardPanel.flyFromHandToBoard(CardSprite card, + Point dest, + long flightDuration) + +
+          Flies a card from the hand onto the board.
+ voidCardPanel.selectHandSprite(CardSprite sprite) + +
+          Programmatically selects a sprite in the hand.
+  +

+ + + + + + + + + +
Method parameters in com.threerings.parlor.card.client with type arguments of type CardSprite
+ voidCardPanel.setHandSelectionPredicate(Predicate<CardSprite> pred) + +
+          Sets the selection predicate that determines which cards from the hand may be selected (if + null, all cards may be selected).
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/client/class-use/CardSpriteObserver.html b/apidocs/com/threerings/parlor/card/client/class-use/CardSpriteObserver.html new file mode 100644 index 00000000..c0560626 --- /dev/null +++ b/apidocs/com/threerings/parlor/card/client/class-use/CardSpriteObserver.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Interface com.threerings.parlor.card.client.CardSpriteObserver (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.parlor.card.client.CardSpriteObserver

+
+No usage of com.threerings.parlor.card.client.CardSpriteObserver +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/client/class-use/MicroCardSprite.html b/apidocs/com/threerings/parlor/card/client/class-use/MicroCardSprite.html new file mode 100644 index 00000000..b1d9e985 --- /dev/null +++ b/apidocs/com/threerings/parlor/card/client/class-use/MicroCardSprite.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.parlor.card.client.MicroCardSprite (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.card.client.MicroCardSprite

+
+No usage of com.threerings.parlor.card.client.MicroCardSprite +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/client/package-frame.html b/apidocs/com/threerings/parlor/card/client/package-frame.html new file mode 100644 index 00000000..570e7a6d --- /dev/null +++ b/apidocs/com/threerings/parlor/card/client/package-frame.html @@ -0,0 +1,56 @@ + + + + + + + +com.threerings.parlor.card.client (vilya 1.3 API) + + + + + + + + + + + +com.threerings.parlor.card.client + + + + +
+Interfaces  + +
+CardGameReceiver +
+CardPanel.CardSelectionObserver +
+CardSpriteObserver
+ + + + + + +
+Classes  + +
+CardGameController +
+CardGameDecoder +
+CardPanel +
+CardSprite +
+MicroCardSprite
+ + + + diff --git a/apidocs/com/threerings/parlor/card/client/package-summary.html b/apidocs/com/threerings/parlor/card/client/package-summary.html new file mode 100644 index 00000000..eee117f0 --- /dev/null +++ b/apidocs/com/threerings/parlor/card/client/package-summary.html @@ -0,0 +1,198 @@ + + + + + + + +com.threerings.parlor.card.client (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.parlor.card.client +

+ + + + + + + + + + + + + + + + + +
+Interface Summary
CardGameReceiverDefines, for the card game services, a set of notifications delivered + asynchronously by the server to the client.
CardPanel.CardSelectionObserverA listener for card selection/deselection.
CardSpriteObserverObserver interface for (draggable) card sprites.
+  + +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
+Class Summary
CardGameControllerA controller class for card games.
CardGameDecoderDispatches calls to a CardGameReceiver instance.
CardPanelExtends VirtualMediaPanel to provide services specific to rendering and manipulating playing + cards.
CardSpriteA sprite representing a playing card.
MicroCardSprite 
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/client/package-tree.html b/apidocs/com/threerings/parlor/card/client/package-tree.html new file mode 100644 index 00000000..569ecf0f --- /dev/null +++ b/apidocs/com/threerings/parlor/card/client/package-tree.html @@ -0,0 +1,200 @@ + + + + + + + +com.threerings.parlor.card.client Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.parlor.card.client +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/client/package-use.html b/apidocs/com/threerings/parlor/card/client/package-use.html new file mode 100644 index 00000000..928415dd --- /dev/null +++ b/apidocs/com/threerings/parlor/card/client/package-use.html @@ -0,0 +1,210 @@ + + + + + + + +Uses of Package com.threerings.parlor.card.client (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.parlor.card.client

+
+ + + + + + + + + + + + + +
+Packages that use com.threerings.parlor.card.client
com.threerings.parlor.card.client  
com.threerings.parlor.card.trick.client  
+  +

+ + + + + + + + + + + + + + + + + +
+Classes in com.threerings.parlor.card.client used by com.threerings.parlor.card.client
CardGameReceiver + +
+          Defines, for the card game services, a set of notifications delivered + asynchronously by the server to the client.
CardPanel + +
+          Extends VirtualMediaPanel to provide services specific to rendering and manipulating playing + cards.
CardPanel.CardSelectionObserver + +
+          A listener for card selection/deselection.
CardSprite + +
+          A sprite representing a playing card.
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.card.client used by com.threerings.parlor.card.trick.client
CardGameController + +
+          A controller class for card games.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/data/Card.html b/apidocs/com/threerings/parlor/card/data/Card.html new file mode 100644 index 00000000..0b90135e --- /dev/null +++ b/apidocs/com/threerings/parlor/card/data/Card.html @@ -0,0 +1,604 @@ + + + + + + + +Card (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.card.data +
+Class Card

+
+java.lang.Object
+  extended by com.threerings.parlor.card.data.Card
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable, CardCodes, com.threerings.presents.data.InvocationCodes, com.threerings.presents.dobj.DSet.Entry, Comparable<Card>
+
+
+
+
public class Card
extends Object
implements com.threerings.presents.dobj.DSet.Entry, Comparable<Card>, CardCodes
+ + +

+Instances of this class represent individual playing cards. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from interface com.threerings.parlor.card.data.CardCodes
ACE, BLACK_JOKER, CLUBS, DIAMONDS, HEARTS, JACK, KING, QUEEN, RED_JOKER, SPADES
+  + + + + + + + +
Fields inherited from interface com.threerings.presents.data.InvocationCodes
ACCESS_DENIED, E_ACCESS_DENIED, E_INTERNAL_ERROR, GLOBAL_GROUP, INTERNAL_ERROR
+  + + + + + + + + + + + + + +
+Constructor Summary
Card() + +
+          No-arg constructor for deserialization.
Card(int number, + int suit) + +
+          Creates a new card.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ intcompareTo(Card other) + +
+          Compares this card to another.
+ booleanequals(Object other) + +
+           
+ Comparable<?>getKey() + +
+           
+ intgetNumber() + +
+          Returns the value of the card, either from 2 to 11 or KING, QUEEN, JACK, ACE, RED_JOKER, or + BLACK_JOKER.
+ intgetSuit() + +
+          Returns the suit of the card: SPADES, HEARTS, DIAMONDS, or CLUBS.
+ inthashCode() + +
+           
+ booleanisAce() + +
+          Checks whether the card is an ace.
+ booleanisFace() + +
+          Checks whether the card is a face card (KING, QUEEN, or JACK).
+ booleanisJoker() + +
+          Checks whether the card is a joker.
+ booleanisNumber() + +
+          Checks whether the card is a number card (2 to 10).
+ booleanisValid() + +
+          Checks whether or not this card is valid.
+ StringtoString() + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+Card

+
+public Card()
+
+
No-arg constructor for deserialization. +

+

+
+ +

+Card

+
+public Card(int number,
+            int suit)
+
+
Creates a new card. +

+

+
Parameters:
number - the number of the card
suit - the suit of the card
+
+ + + + + + + + +
+Method Detail
+ +

+getNumber

+
+public int getNumber()
+
+
Returns the value of the card, either from 2 to 11 or KING, QUEEN, JACK, ACE, RED_JOKER, or + BLACK_JOKER. +

+

+
+
+
+ +
Returns:
the value of the card
+
+
+
+ +

+getSuit

+
+public int getSuit()
+
+
Returns the suit of the card: SPADES, HEARTS, DIAMONDS, or CLUBS. If the card is the joker, + the suit is undefined. +

+

+
+
+
+ +
Returns:
the suit of the card
+
+
+
+ +

+isNumber

+
+public boolean isNumber()
+
+
Checks whether the card is a number card (2 to 10). +

+

+
+
+
+ +
Returns:
true if the card is a number card, false otherwise
+
+
+
+ +

+isFace

+
+public boolean isFace()
+
+
Checks whether the card is a face card (KING, QUEEN, or JACK). +

+

+
+
+
+ +
Returns:
true if the card is a face card, false otherwise
+
+
+
+ +

+isAce

+
+public boolean isAce()
+
+
Checks whether the card is an ace. +

+

+
+
+
+ +
Returns:
true if the card is an ace, false otherwise
+
+
+
+ +

+isJoker

+
+public boolean isJoker()
+
+
Checks whether the card is a joker. +

+

+
+
+
+ +
Returns:
true if the card is a joker, false otherwise
+
+
+
+ +

+isValid

+
+public boolean isValid()
+
+
Checks whether or not this card is valid. The no-arg public constructor for deserialization + creates an invalid card. +

+

+
+
+
+ +
Returns:
true if this card is valid, false if not
+
+
+
+ +

+getKey

+
+public Comparable<?> getKey()
+
+
+
Specified by:
getKey in interface com.threerings.presents.dobj.DSet.Entry
+
+
+
+
+
+
+ +

+hashCode

+
+public int hashCode()
+
+
+
Overrides:
hashCode in class Object
+
+
+
+
+
+
+ +

+equals

+
+public boolean equals(Object other)
+
+
+
Overrides:
equals in class Object
+
+
+
+
+
+
+ +

+compareTo

+
+public int compareTo(Card other)
+
+
Compares this card to another. The card order is the same as the initial deck ordering: two + through ten, jack, queen, king, ace for spades, hearts, clubs, and diamonds, then the red + joker and the black joker. +

+

+
Specified by:
compareTo in interface Comparable<Card>
+
+
+
Parameters:
other - the other card to compare this to +
Returns:
-1, 0, or +1, depending on whether this card is less than, equal to, or greater + than the other card
+
+
+
+ +

+toString

+
+public String toString()
+
+
+
Overrides:
toString in class Object
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/data/CardCodes.html b/apidocs/com/threerings/parlor/card/data/CardCodes.html new file mode 100644 index 00000000..f73a1291 --- /dev/null +++ b/apidocs/com/threerings/parlor/card/data/CardCodes.html @@ -0,0 +1,409 @@ + + + + + + + +CardCodes (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.card.data +
+Interface CardCodes

+
+
All Superinterfaces:
com.threerings.presents.data.InvocationCodes
+
+
+
All Known Subinterfaces:
TrickCardCodes
+
+
+
All Known Implementing Classes:
Card, CardGameController, CardGameManager, CardPanel, Deck, TrickCardGameUtil
+
+
+
+
public interface CardCodes
extends com.threerings.presents.data.InvocationCodes
+ + +

+Constants relating to the card services. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static intACE + +
+          The number of the ace.
+static intBLACK_JOKER + +
+          The number of the black joker.
+static intCLUBS + +
+          The suit of clubs.
+static intDIAMONDS + +
+          The suit of diamonds.
+static intHEARTS + +
+          The suit of hearts.
+static intJACK + +
+          The number of the jack.
+static intKING + +
+          The number of the king.
+static intQUEEN + +
+          The number of the queen.
+static intRED_JOKER + +
+          The number of the red joker.
+static intSPADES + +
+          The suit of spades.
+  + + + + + + + +
Fields inherited from interface com.threerings.presents.data.InvocationCodes
ACCESS_DENIED, E_ACCESS_DENIED, E_INTERNAL_ERROR, GLOBAL_GROUP, INTERNAL_ERROR
+  +

+ + + + + + + + +
+Field Detail
+ +

+SPADES

+
+static final int SPADES
+
+
The suit of spades. +

+

+
See Also:
Constant Field Values
+
+
+ +

+HEARTS

+
+static final int HEARTS
+
+
The suit of hearts. +

+

+
See Also:
Constant Field Values
+
+
+ +

+CLUBS

+
+static final int CLUBS
+
+
The suit of clubs. +

+

+
See Also:
Constant Field Values
+
+
+ +

+DIAMONDS

+
+static final int DIAMONDS
+
+
The suit of diamonds. +

+

+
See Also:
Constant Field Values
+
+
+ +

+JACK

+
+static final int JACK
+
+
The number of the jack. +

+

+
See Also:
Constant Field Values
+
+
+ +

+QUEEN

+
+static final int QUEEN
+
+
The number of the queen. +

+

+
See Also:
Constant Field Values
+
+
+ +

+KING

+
+static final int KING
+
+
The number of the king. +

+

+
See Also:
Constant Field Values
+
+
+ +

+ACE

+
+static final int ACE
+
+
The number of the ace. +

+

+
See Also:
Constant Field Values
+
+
+ +

+RED_JOKER

+
+static final int RED_JOKER
+
+
The number of the red joker. +

+

+
See Also:
Constant Field Values
+
+
+ +

+BLACK_JOKER

+
+static final int BLACK_JOKER
+
+
The number of the black joker. +

+

+
See Also:
Constant Field Values
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/data/CardGameObject.html b/apidocs/com/threerings/parlor/card/data/CardGameObject.html new file mode 100644 index 00000000..cc71c87a --- /dev/null +++ b/apidocs/com/threerings/parlor/card/data/CardGameObject.html @@ -0,0 +1,328 @@ + + + + + + + +CardGameObject (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.card.data +
+Class CardGameObject

+
+java.lang.Object
+  extended by com.threerings.presents.dobj.DObject
+      extended by com.threerings.crowd.data.PlaceObject
+          extended by com.threerings.parlor.game.data.GameObject
+              extended by com.threerings.parlor.card.data.CardGameObject
+
+
+
All Implemented Interfaces:
com.threerings.crowd.chat.data.SpeakObject, com.threerings.io.Streamable
+
+
+
+
public class CardGameObject
extends GameObject
+ + +

+Game object class for card games. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.crowd.data.PlaceObject
com.threerings.crowd.data.PlaceObject.ManagerCaller
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.crowd.chat.data.SpeakObject
com.threerings.crowd.chat.data.SpeakObject.ListenerOp
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class com.threerings.parlor.game.data.GameObject
CANCELLED, GAME_OVER, IN_PLAY, IS_PRIVATE, IS_RATED, isPrivate, isRated, PLAYER_IN_PLAY, PLAYER_LEFT_GAME, PLAYER_STATUS, players, PLAYERS, playerStatus, PRE_GAME, SESSION_ID, sessionId, state, STATE, winners, WINNERS
+  + + + + + + + +
Fields inherited from class com.threerings.crowd.data.PlaceObject
manager, OCCUPANT_INFO, occupantInfo, occupants, OCCUPANTS, SPEAK_SERVICE, speakService
+  + + + + + + + + + + +
+Constructor Summary
CardGameObject() + +
+           
+  + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from class com.threerings.parlor.game.data.GameObject
getActivePlayerCount, getPlayerCount, getPlayerIndex, getWinnerCount, getWinnerIndex, isActivePlayer, isDraw, isInPlay, isOccupiedPlayer, isWinner, setIsPrivate, setIsRated, setPlayers, setPlayersAt, setPlayerStatus, setPlayerStatusAt, setSessionId, setState, setWinners, setWinnersAt
+  + + + + + + + +
Methods inherited from class com.threerings.crowd.data.PlaceObject
addToOccupantInfo, addToOccupants, applyToListeners, getOccupantInfo, initManagerCaller, removeFromOccupantInfo, removeFromOccupants, setOccupantInfo, setSpeakService, shouldBroadcast, updateOccupantInfo
+  + + + + + + + +
Methods inherited from class com.threerings.presents.dobj.DObject
acquireLock, addListener, addListener, addSubscriber, addToSet, cancelTransaction, changeAttribute, checkPermissions, checkPermissions, commitTransaction, destroy, getAccessController, getAttribute, getLocal, getLocals, getManager, getOid, getSet, inTransaction, isActive, notifyListeners, notifyProxies, postEvent, postMessage, postMessage, readField__oid, releaseLock, removeFromSet, removeListener, removeSubscriber, setAccessController, setAttribute, setDestroyOnLastSubscriberRemoved, setLocal, setManager, setOid, startTransaction, toString, updateSet, which, writeField__oid
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+CardGameObject

+
+public CardGameObject()
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/data/Deck.html b/apidocs/com/threerings/parlor/card/data/Deck.html new file mode 100644 index 00000000..1d402876 --- /dev/null +++ b/apidocs/com/threerings/parlor/card/data/Deck.html @@ -0,0 +1,486 @@ + + + + + + + +Deck (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.card.data +
+Class Deck

+
+java.lang.Object
+  extended by java.util.AbstractCollection<E>
+      extended by java.util.AbstractList<E>
+          extended by java.util.ArrayList<E>
+              extended by com.threerings.util.StreamableArrayList<Card>
+                  extended by com.threerings.parlor.card.data.Deck
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable, CardCodes, com.threerings.presents.data.InvocationCodes, Serializable, Cloneable, Iterable<Card>, Collection<Card>, List<Card>, RandomAccess
+
+
+
+
public class Deck
extends com.threerings.util.StreamableArrayList<Card>
implements CardCodes
+ + +

+Instances of this class represent decks of cards. +

+ +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from interface com.threerings.parlor.card.data.CardCodes
ACE, BLACK_JOKER, CLUBS, DIAMONDS, HEARTS, JACK, KING, QUEEN, RED_JOKER, SPADES
+  + + + + + + + +
Fields inherited from interface com.threerings.presents.data.InvocationCodes
ACCESS_DENIED, E_ACCESS_DENIED, E_INTERNAL_ERROR, GLOBAL_GROUP, INTERNAL_ERROR
+  + + + + + + + + + + + + + +
+Constructor Summary
Deck() + +
+          Default constructor creates an unshuffled deck of cards without + jokers.
Deck(boolean includeJokers) + +
+          Constructor.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ HanddealHand(int size) + +
+          Deals a hand of cards from the deck.
+ voidreset(boolean includeJokers) + +
+          Resets the deck to its initial state: an unshuffled deck of + 52 or 54 cards, depending on whether the jokers are included.
+ voidreturnHand(Hand hand) + +
+          Returns a hand of cards to the deck.
+ voidshuffle() + +
+          Shuffles the deck.
+ voidshuffle(Random r) + +
+          Shuffles the deck.
+  + + + + + + + +
Methods inherited from class com.threerings.util.StreamableArrayList
newList, readObject, writeObject
+  + + + + + + + +
Methods inherited from class java.util.ArrayList
add, add, addAll, addAll, clear, clone, contains, ensureCapacity, get, indexOf, isEmpty, lastIndexOf, remove, remove, set, size, toArray, toArray, trimToSize
+  + + + + + + + +
Methods inherited from class java.util.AbstractList
equals, hashCode, iterator, listIterator, listIterator, subList
+  + + + + + + + +
Methods inherited from class java.util.AbstractCollection
containsAll, removeAll, retainAll, toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
+  + + + + + + + +
Methods inherited from interface java.util.List
containsAll, equals, hashCode, iterator, listIterator, listIterator, removeAll, retainAll, subList
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+Deck

+
+public Deck()
+
+
Default constructor creates an unshuffled deck of cards without + jokers. +

+

+
+ +

+Deck

+
+public Deck(boolean includeJokers)
+
+
Constructor. +

+

+
Parameters:
includeJokers - whether or not to include the two jokers + in the deck
+
+ + + + + + + + +
+Method Detail
+ +

+reset

+
+public void reset(boolean includeJokers)
+
+
Resets the deck to its initial state: an unshuffled deck of + 52 or 54 cards, depending on whether the jokers are included. +

+

+
+
+
+
Parameters:
includeJokers - whether or not to include the two jokers + in the deck
+
+
+
+ +

+shuffle

+
+public void shuffle()
+
+
Shuffles the deck. +

+

+
+
+
+
+
+
+
+ +

+shuffle

+
+public void shuffle(Random r)
+
+
Shuffles the deck. +

+

+
+
+
+
+
+
+
+ +

+dealHand

+
+public Hand dealHand(int size)
+
+
Deals a hand of cards from the deck. +

+

+
+
+
+
Parameters:
size - the size of the hand to deal +
Returns:
the newly created and populated hand, or null + if there are not enough cards in the deck to deal the hand
+
+
+
+ +

+returnHand

+
+public void returnHand(Hand hand)
+
+
Returns a hand of cards to the deck. +

+

+
+
+
+
Parameters:
hand - the hand of cards to return
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/data/Hand.html b/apidocs/com/threerings/parlor/card/data/Hand.html new file mode 100644 index 00000000..f1e18df4 --- /dev/null +++ b/apidocs/com/threerings/parlor/card/data/Hand.html @@ -0,0 +1,419 @@ + + + + + + + +Hand (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.card.data +
+Class Hand

+
+java.lang.Object
+  extended by java.util.AbstractCollection<E>
+      extended by java.util.AbstractList<E>
+          extended by java.util.ArrayList<E>
+              extended by com.threerings.util.StreamableArrayList<Card>
+                  extended by com.threerings.parlor.card.data.Hand
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable, Serializable, Cloneable, Iterable<Card>, Collection<Card>, List<Card>, RandomAccess
+
+
+
+
public class Hand
extends com.threerings.util.StreamableArrayList<Card>
+ + +

+Instances of this class represent hands of cards. +

+ +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + +
+Constructor Summary
Hand() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidaddAll(Card[] cards) + +
+          Adds all of the specified cards to this hand.
+ booleancontainsAll(Card[] cards) + +
+          Checks whether this hand contains all of the specified cards.
+ Card[]getCards() + +
+          Converts this list of cards into an array.
+ intgetSuitMemberCount(int suit) + +
+          Counts the members of a particular suit within this hand.
+ voidremoveAll(Card[] cards) + +
+          Removes all of the specified cards from this hand.
+  + + + + + + + +
Methods inherited from class com.threerings.util.StreamableArrayList
newList, readObject, writeObject
+  + + + + + + + +
Methods inherited from class java.util.ArrayList
add, add, addAll, addAll, clear, clone, contains, ensureCapacity, get, indexOf, isEmpty, lastIndexOf, remove, remove, set, size, toArray, toArray, trimToSize
+  + + + + + + + +
Methods inherited from class java.util.AbstractList
equals, hashCode, iterator, listIterator, listIterator, subList
+  + + + + + + + +
Methods inherited from class java.util.AbstractCollection
containsAll, removeAll, retainAll, toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
+  + + + + + + + +
Methods inherited from interface java.util.List
containsAll, equals, hashCode, iterator, listIterator, listIterator, removeAll, retainAll, subList
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+Hand

+
+public Hand()
+
+
+ + + + + + + + +
+Method Detail
+ +

+addAll

+
+public void addAll(Card[] cards)
+
+
Adds all of the specified cards to this hand. +

+

+
+
+
+
+ +

+removeAll

+
+public void removeAll(Card[] cards)
+
+
Removes all of the specified cards from this hand. +

+

+
+
+
+
+ +

+containsAll

+
+public boolean containsAll(Card[] cards)
+
+
Checks whether this hand contains all of the specified cards. +

+

+
+
+
+
+ +

+getSuitMemberCount

+
+public int getSuitMemberCount(int suit)
+
+
Counts the members of a particular suit within this hand. +

+

+
Parameters:
suit - the suit of interest +
Returns:
the number of cards in the specified suit
+
+
+
+ +

+getCards

+
+public Card[] getCards()
+
+
Converts this list of cards into an array. This only necessary if you + need the cards in array form, use ArrayList.get(int) if you simply need to get + a card from the hand. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/data/PlayerCard.html b/apidocs/com/threerings/parlor/card/data/PlayerCard.html new file mode 100644 index 00000000..ad1b45b5 --- /dev/null +++ b/apidocs/com/threerings/parlor/card/data/PlayerCard.html @@ -0,0 +1,331 @@ + + + + + + + +PlayerCard (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.card.data +
+Class PlayerCard

+
+java.lang.Object
+  extended by com.threerings.parlor.card.data.PlayerCard
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable
+
+
+
+
public class PlayerCard
extends Object
implements com.threerings.io.Streamable
+ + +

+Pairs a player index with the card that the player played in the trick. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + + + + + +
+Field Summary
+ Cardcard + +
+          The card that the player played.
+ intpidx + +
+          The index of the player.
+  + + + + + + + + + + + + + +
+Constructor Summary
PlayerCard() + +
+          No-argument constructor for deserialization.
PlayerCard(int pidx, + Card card) + +
+          Creates a new player card.
+  + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+pidx

+
+public int pidx
+
+
The index of the player. +

+

+
+
+
+ +

+card

+
+public Card card
+
+
The card that the player played. +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+PlayerCard

+
+public PlayerCard()
+
+
No-argument constructor for deserialization. +

+

+
+ +

+PlayerCard

+
+public PlayerCard(int pidx,
+                  Card card)
+
+
Creates a new player card. +

+

+
Parameters:
pidx - the index of the player
card - the card played
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/data/class-use/Card.html b/apidocs/com/threerings/parlor/card/data/class-use/Card.html new file mode 100644 index 00000000..92544c46 --- /dev/null +++ b/apidocs/com/threerings/parlor/card/data/class-use/Card.html @@ -0,0 +1,702 @@ + + + + + + + +Uses of Class com.threerings.parlor.card.data.Card (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.card.data.Card

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Packages that use Card
com.threerings.parlor.card.client  
com.threerings.parlor.card.data  
com.threerings.parlor.card.server  
com.threerings.parlor.card.trick.client  
com.threerings.parlor.card.trick.data  
com.threerings.parlor.card.trick.server  
com.threerings.parlor.card.trick.util  
+  +

+ + + + + +
+Uses of Card in com.threerings.parlor.card.client
+  +

+ + + + + + + + + +
Methods in com.threerings.parlor.card.client that return Card
+ CardCardSprite.getCard() + +
+          Returns the card being depicted.
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in com.threerings.parlor.card.client with parameters of type Card
+ voidCardPanel.addToBoard(Card card, + Point dest) + +
+          Adds a card to the board immediately.
+ voidCardSprite.flip(Card newCard, + long duration) + +
+          Flip the card from its current displayed card to the specified card.
+ voidCardPanel.flyAcross(Card[] cards, + Point src, + Point dest, + long flightDuration, + long cardDelay, + float fadePortion) + +
+          Flies a set of cards from the ether into the ether.
+ voidCardPanel.flyIntoHand(Card[] cards, + Point src, + long flightDuration, + long pauseDuration, + long dropDuration, + float fadePortion) + +
+          Flies a set of cards from the ether into the hand.
+ voidCardPanel.flyToBoard(Card card, + Point src, + Point dest, + long flightDuration, + float fadePortion) + +
+          Flies a card from the ether onto the board.
+abstract  com.threerings.media.image.MirageCardPanel.getCardImage(Card card) + +
+          Returns the full-sized image for the front of the specified card.
+ CardSpriteCardPanel.getHandSprite(Card card) + +
+          Returns the first sprite in the hand that corresponds to the specified card, or null if the + card is not in the hand.
+abstract  com.threerings.media.image.MirageCardPanel.getMicroCardImage(Card card) + +
+          Returns the small-sized image for the front of the specified card.
+ voidCardGameReceiver.receivedCardsFromPlayer(int plidx, + Card[] cards) + +
+          Dispatched to the client when it has received a set of cards + from another player.
+ voidCardGameController.receivedCardsFromPlayer(int plidx, + Card[] cards) + +
+          Dispatched to the client when it has received a set of cards from another player.
+ voidCardGameReceiver.sentCardsToPlayer(int plidx, + Card[] cards) + +
+          Dispatched to the client when the server has forced it to send + a set of cards to another player.
+ voidCardGameController.sentCardsToPlayer(int plidx, + Card[] cards) + +
+          Dispatched to the client when the server has forced it to send a set of cards to another + player.
+ voidCardSprite.setCard(Card card) + +
+          Sets the card to depict.
+  +

+ + + + + + + + + + + + + + + + + +
Constructors in com.threerings.parlor.card.client with parameters of type Card
CardSprite(CardPanel panel, + Card card) + +
+          Creates a new upward-facing card sprite.
CardSprite(CardPanel panel, + Card card, + boolean facingUp) + +
+          Creates a new card sprite.
MicroCardSprite(CardPanel panel, + Card card) + +
+          Creates a new upward-facing micro-card sprite.
MicroCardSprite(CardPanel panel, + Card card, + boolean facingUp) + +
+          Creates a new micro-card sprite.
+  +

+ + + + + +
+Uses of Card in com.threerings.parlor.card.data
+  +

+ + + + + + + + + +
Fields in com.threerings.parlor.card.data declared as Card
+ CardPlayerCard.card + +
+          The card that the player played.
+  +

+ + + + + + + + + +
Methods in com.threerings.parlor.card.data that return Card
+ Card[]Hand.getCards() + +
+          Converts this list of cards into an array.
+  +

+ + + + + + + + + + + + + + + + + + + + + +
Methods in com.threerings.parlor.card.data with parameters of type Card
+ voidHand.addAll(Card[] cards) + +
+          Adds all of the specified cards to this hand.
+ intCard.compareTo(Card other) + +
+          Compares this card to another.
+ booleanHand.containsAll(Card[] cards) + +
+          Checks whether this hand contains all of the specified cards.
+ voidHand.removeAll(Card[] cards) + +
+          Removes all of the specified cards from this hand.
+  +

+ + + + + + + + +
Constructors in com.threerings.parlor.card.data with parameters of type Card
PlayerCard(int pidx, + Card card) + +
+          Creates a new player card.
+  +

+ + + + + +
+Uses of Card in com.threerings.parlor.card.server
+  +

+ + + + + + + + + + + + + + + + + + + + + +
Methods in com.threerings.parlor.card.server with parameters of type Card
+static voidCardGameSender.sendCardsFromPlayer(com.threerings.presents.data.ClientObject target, + int arg1, + Card[] arg2) + +
+          Issues a notification that will result in a call to CardGameReceiver.receivedCardsFromPlayer(int, com.threerings.parlor.card.data.Card[]) on a client.
+static voidCardGameSender.sentCardsToPlayer(com.threerings.presents.data.ClientObject target, + int arg1, + Card[] arg2) + +
+          Issues a notification that will result in a call to CardGameReceiver.sentCardsToPlayer(int, com.threerings.parlor.card.data.Card[]) on a client.
+ voidCardGameManager.transferCardsBetweenPlayers(int[] toPlayerIndices, + Card[][] cards) + +
+          Sends sets of cards between players simultaneously.
+ voidCardGameManager.transferCardsBetweenPlayers(int fromPlayerIdx, + int toPlayerIdx, + Card[] cards) + +
+          Sends a set of cards from one player to another.
+  +

+ + + + + +
+Uses of Card in com.threerings.parlor.card.trick.client
+  +

+ + + + + + + + + + + + + +
Methods in com.threerings.parlor.card.trick.client with parameters of type Card
+ voidTrickCardGameService.playCard(Card card, + int handSize) + +
+          Plays a card in the trick.
+ voidTrickCardGameService.sendCardsToPlayer(int toidx, + Card[] cards) + +
+          Sends a group of cards to the player at the specified index.
+  +

+ + + + + +
+Uses of Card in com.threerings.parlor.card.trick.data
+  +

+ + + + + + + + + + + + + + + + + +
Methods in com.threerings.parlor.card.trick.data with parameters of type Card
+ booleanTrickCardGameObject.isCardPlayable(Hand hand, + Card card) + +
+          Checks whether a user can play the specified card at this time.
+ voidTrickCardGameMarshaller.playCard(Card arg1, + int arg2) + +
+           
+ voidTrickCardGameMarshaller.sendCardsToPlayer(int arg1, + Card[] arg2) + +
+           
+  +

+ + + + + +
+Uses of Card in com.threerings.parlor.card.trick.server
+  +

+ + + + + + + + + + + + + + + + + + + + + +
Methods in com.threerings.parlor.card.trick.server with parameters of type Card
+ voidTrickCardGameProvider.playCard(com.threerings.presents.data.ClientObject caller, + Card arg1, + int arg2) + +
+          Handles a TrickCardGameService.playCard(com.threerings.parlor.card.data.Card, int) request.
+ voidTrickCardGameManagerDelegate.playCard(com.threerings.presents.data.ClientObject client, + Card card, + int handSize) + +
+           
+ voidTrickCardGameProvider.sendCardsToPlayer(com.threerings.presents.data.ClientObject caller, + int arg1, + Card[] arg2) + +
+          Handles a TrickCardGameService.sendCardsToPlayer(int, com.threerings.parlor.card.data.Card[]) request.
+ voidTrickCardGameManagerDelegate.sendCardsToPlayer(com.threerings.presents.data.ClientObject client, + int toidx, + Card[] cards) + +
+           
+  +

+ + + + + +
+Uses of Card in com.threerings.parlor.card.trick.util
+  +

+ + + + + + + + + + + + + +
Methods in com.threerings.parlor.card.trick.util with parameters of type Card
+static booleanTrickCardGameUtil.containsCard(PlayerCard[] cards, + Card card) + +
+          Checks whether the specified array contains the given card.
+static booleanTrickCardGameUtil.followsSuit(PlayerCard[] cardsPlayed, + Card card) + +
+          Checks whether the proposed card follows the suit lead.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/data/class-use/CardCodes.html b/apidocs/com/threerings/parlor/card/data/class-use/CardCodes.html new file mode 100644 index 00000000..4a117ae8 --- /dev/null +++ b/apidocs/com/threerings/parlor/card/data/class-use/CardCodes.html @@ -0,0 +1,314 @@ + + + + + + + +Uses of Interface com.threerings.parlor.card.data.CardCodes (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.parlor.card.data.CardCodes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
+Packages that use CardCodes
com.threerings.parlor.card.client  
com.threerings.parlor.card.data  
com.threerings.parlor.card.server  
com.threerings.parlor.card.trick.data  
com.threerings.parlor.card.trick.util  
+  +

+ + + + + +
+Uses of CardCodes in com.threerings.parlor.card.client
+  +

+ + + + + + + + + + + + + +
Classes in com.threerings.parlor.card.client that implement CardCodes
+ classCardGameController + +
+          A controller class for card games.
+ classCardPanel + +
+          Extends VirtualMediaPanel to provide services specific to rendering and manipulating playing + cards.
+  +

+ + + + + +
+Uses of CardCodes in com.threerings.parlor.card.data
+  +

+ + + + + + + + + + + + + +
Classes in com.threerings.parlor.card.data that implement CardCodes
+ classCard + +
+          Instances of this class represent individual playing cards.
+ classDeck + +
+          Instances of this class represent decks of cards.
+  +

+ + + + + +
+Uses of CardCodes in com.threerings.parlor.card.server
+  +

+ + + + + + + + + +
Classes in com.threerings.parlor.card.server that implement CardCodes
+ classCardGameManager + +
+          A manager class for card games.
+  +

+ + + + + +
+Uses of CardCodes in com.threerings.parlor.card.trick.data
+  +

+ + + + + + + + + +
Subinterfaces of CardCodes in com.threerings.parlor.card.trick.data
+ interfaceTrickCardCodes + +
+          Constants relating to trick-based card games.
+  +

+ + + + + +
+Uses of CardCodes in com.threerings.parlor.card.trick.util
+  +

+ + + + + + + + + +
Classes in com.threerings.parlor.card.trick.util that implement CardCodes
+ classTrickCardGameUtil + +
+          Methods of general utility to trick-taking card games.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/data/class-use/CardGameObject.html b/apidocs/com/threerings/parlor/card/data/class-use/CardGameObject.html new file mode 100644 index 00000000..1559f1bb --- /dev/null +++ b/apidocs/com/threerings/parlor/card/data/class-use/CardGameObject.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.parlor.card.data.CardGameObject (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.card.data.CardGameObject

+
+No usage of com.threerings.parlor.card.data.CardGameObject +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/data/class-use/Deck.html b/apidocs/com/threerings/parlor/card/data/class-use/Deck.html new file mode 100644 index 00000000..3561efab --- /dev/null +++ b/apidocs/com/threerings/parlor/card/data/class-use/Deck.html @@ -0,0 +1,192 @@ + + + + + + + +Uses of Class com.threerings.parlor.card.data.Deck (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.card.data.Deck

+
+ + + + + + + + + +
+Packages that use Deck
com.threerings.parlor.card.server  
+  +

+ + + + + +
+Uses of Deck in com.threerings.parlor.card.server
+  +

+ + + + + + + + + + + + + +
Methods in com.threerings.parlor.card.server with parameters of type Deck
+ HandCardGameManager.dealHand(Deck deck, + int size, + int playerIndex) + +
+          Deals a hand of cards to the player at the specified index from the given Deck.
+ Hand[]CardGameManager.dealHands(Deck deck, + int size) + +
+          Deals a hand of cards to each player from the specified Deck.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/data/class-use/Hand.html b/apidocs/com/threerings/parlor/card/data/class-use/Hand.html new file mode 100644 index 00000000..a8396a06 --- /dev/null +++ b/apidocs/com/threerings/parlor/card/data/class-use/Hand.html @@ -0,0 +1,379 @@ + + + + + + + +Uses of Class com.threerings.parlor.card.data.Hand (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.card.data.Hand

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
+Packages that use Hand
com.threerings.parlor.card.client  
com.threerings.parlor.card.data  
com.threerings.parlor.card.server  
com.threerings.parlor.card.trick.data  
com.threerings.parlor.card.trick.util  
+  +

+ + + + + +
+Uses of Hand in com.threerings.parlor.card.client
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in com.threerings.parlor.card.client with parameters of type Hand
+ voidCardGameController.receivedHand(Hand hand) + +
+          Called when the server deals the client a new hand of cards.
+ voidCardGameReceiver.receivedHand(int oid, + Hand hand) + +
+          Dispatched to the client when it has received a hand of cards.
+ voidCardGameController.receivedHand(int oid, + Hand hand) + +
+          Called by our sender to notify us of a received hand.
+ voidCardPanel.setHand(Hand hand, + long fadeDuration) + +
+          Fades a hand of cards in.
+ voidCardPanel.showHand(Hand hand) + +
+          Shows a hand that was previous set face-down.
+  +

+ + + + + +
+Uses of Hand in com.threerings.parlor.card.data
+  +

+ + + + + + + + + +
Methods in com.threerings.parlor.card.data that return Hand
+ HandDeck.dealHand(int size) + +
+          Deals a hand of cards from the deck.
+  +

+ + + + + + + + + +
Methods in com.threerings.parlor.card.data with parameters of type Hand
+ voidDeck.returnHand(Hand hand) + +
+          Returns a hand of cards to the deck.
+  +

+ + + + + +
+Uses of Hand in com.threerings.parlor.card.server
+  +

+ + + + + + + + + + + + + +
Methods in com.threerings.parlor.card.server that return Hand
+ HandCardGameManager.dealHand(Deck deck, + int size, + int playerIndex) + +
+          Deals a hand of cards to the player at the specified index from the given Deck.
+ Hand[]CardGameManager.dealHands(Deck deck, + int size) + +
+          Deals a hand of cards to each player from the specified Deck.
+  +

+ + + + + + + + + +
Methods in com.threerings.parlor.card.server with parameters of type Hand
+static voidCardGameSender.sendHand(com.threerings.presents.data.ClientObject target, + int arg1, + Hand arg2) + +
+          Issues a notification that will result in a call to CardGameReceiver.receivedHand(int, com.threerings.parlor.card.data.Hand) on a client.
+  +

+ + + + + +
+Uses of Hand in com.threerings.parlor.card.trick.data
+  +

+ + + + + + + + + +
Methods in com.threerings.parlor.card.trick.data with parameters of type Hand
+ booleanTrickCardGameObject.isCardPlayable(Hand hand, + Card card) + +
+          Checks whether a user can play the specified card at this time.
+  +

+ + + + + +
+Uses of Hand in com.threerings.parlor.card.trick.util
+  +

+ + + + + + + + + +
Methods in com.threerings.parlor.card.trick.util with parameters of type Hand
+static booleanTrickCardGameUtil.canFollowSuit(PlayerCard[] cardsPlayed, + Hand hand) + +
+          Checks whether the player can follow the suit lead with the hand given.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/data/class-use/PlayerCard.html b/apidocs/com/threerings/parlor/card/data/class-use/PlayerCard.html new file mode 100644 index 00000000..792415b3 --- /dev/null +++ b/apidocs/com/threerings/parlor/card/data/class-use/PlayerCard.html @@ -0,0 +1,308 @@ + + + + + + + +Uses of Class com.threerings.parlor.card.data.PlayerCard (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.card.data.PlayerCard

+
+ + + + + + + + + + + + + +
+Packages that use PlayerCard
com.threerings.parlor.card.trick.data  
com.threerings.parlor.card.trick.util  
+  +

+ + + + + +
+Uses of PlayerCard in com.threerings.parlor.card.trick.data
+  +

+ + + + + + + + + + + + + + + + + +
Methods in com.threerings.parlor.card.trick.data that return PlayerCard
+ PlayerCard[]TrickCardGameObject.getCardsPlayed() + +
+          Returns an array containing the history of the trick in terms of the + cards played by each player.
+ PlayerCard[]TrickCardGameObject.getLastCardsPlayed() + +
+          Returns an array containing the history of the last trick in terms of + the cards played by each player.
+ PlayerCardTrickCardGameObject.getTrickTaker() + +
+          Returns the card of the player who took the current trick.
+  +

+ + + + + + + + + + + + + +
Methods in com.threerings.parlor.card.trick.data with parameters of type PlayerCard
+ voidTrickCardGameObject.setCardsPlayed(PlayerCard[] cardsPlayed) + +
+          Sets the array of cards played by each player.
+ voidTrickCardGameObject.setLastCardsPlayed(PlayerCard[] lastCardsPlayed) + +
+          Sets the last array of cards played by each player.
+  +

+ + + + + +
+Uses of PlayerCard in com.threerings.parlor.card.trick.util
+  +

+ + + + + + + + + +
Methods in com.threerings.parlor.card.trick.util that return PlayerCard
+static PlayerCardTrickCardGameUtil.getHighestInLeadSuit(PlayerCard[] cardsPlayed, + int trumpSuit) + +
+          Returns the highest card (according to the standard A,K,...,2 ordering) in the suit lead, + with an optional trump suit.
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in com.threerings.parlor.card.trick.util with parameters of type PlayerCard
+static booleanTrickCardGameUtil.canFollowSuit(PlayerCard[] cardsPlayed, + Hand hand) + +
+          Checks whether the player can follow the suit lead with the hand given.
+static booleanTrickCardGameUtil.containsCard(PlayerCard[] cards, + Card card) + +
+          Checks whether the specified array contains the given card.
+static intTrickCardGameUtil.countSuitMembers(PlayerCard[] cards, + int suit) + +
+          Determines the number of cards that belong to the specified suit within the array given.
+static booleanTrickCardGameUtil.followsSuit(PlayerCard[] cardsPlayed, + Card card) + +
+          Checks whether the proposed card follows the suit lead.
+static PlayerCardTrickCardGameUtil.getHighestInLeadSuit(PlayerCard[] cardsPlayed, + int trumpSuit) + +
+          Returns the highest card (according to the standard A,K,...,2 ordering) in the suit lead, + with an optional trump suit.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/data/package-frame.html b/apidocs/com/threerings/parlor/card/data/package-frame.html new file mode 100644 index 00000000..6544949c --- /dev/null +++ b/apidocs/com/threerings/parlor/card/data/package-frame.html @@ -0,0 +1,52 @@ + + + + + + + +com.threerings.parlor.card.data (vilya 1.3 API) + + + + + + + + + + + +com.threerings.parlor.card.data + + + + +
+Interfaces  + +
+CardCodes
+ + + + + + +
+Classes  + +
+Card +
+CardGameObject +
+Deck +
+Hand +
+PlayerCard
+ + + + diff --git a/apidocs/com/threerings/parlor/card/data/package-summary.html b/apidocs/com/threerings/parlor/card/data/package-summary.html new file mode 100644 index 00000000..72216704 --- /dev/null +++ b/apidocs/com/threerings/parlor/card/data/package-summary.html @@ -0,0 +1,188 @@ + + + + + + + +com.threerings.parlor.card.data (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.parlor.card.data +

+ + + + + + + + + +
+Interface Summary
CardCodesConstants relating to the card services.
+  + +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
+Class Summary
CardInstances of this class represent individual playing cards.
CardGameObjectGame object class for card games.
DeckInstances of this class represent decks of cards.
HandInstances of this class represent hands of cards.
PlayerCardPairs a player index with the card that the player played in the trick.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/data/package-tree.html b/apidocs/com/threerings/parlor/card/data/package-tree.html new file mode 100644 index 00000000..a59d66a9 --- /dev/null +++ b/apidocs/com/threerings/parlor/card/data/package-tree.html @@ -0,0 +1,184 @@ + + + + + + + +com.threerings.parlor.card.data Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.parlor.card.data +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/data/package-use.html b/apidocs/com/threerings/parlor/card/data/package-use.html new file mode 100644 index 00000000..435854e4 --- /dev/null +++ b/apidocs/com/threerings/parlor/card/data/package-use.html @@ -0,0 +1,363 @@ + + + + + + + +Uses of Package com.threerings.parlor.card.data (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.parlor.card.data

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Packages that use com.threerings.parlor.card.data
com.threerings.parlor.card.client  
com.threerings.parlor.card.data  
com.threerings.parlor.card.server  
com.threerings.parlor.card.trick.client  
com.threerings.parlor.card.trick.data  
com.threerings.parlor.card.trick.server  
com.threerings.parlor.card.trick.util  
+  +

+ + + + + + + + + + + + + + +
+Classes in com.threerings.parlor.card.data used by com.threerings.parlor.card.client
Card + +
+          Instances of this class represent individual playing cards.
CardCodes + +
+          Constants relating to the card services.
Hand + +
+          Instances of this class represent hands of cards.
+  +

+ + + + + + + + + + + + + + +
+Classes in com.threerings.parlor.card.data used by com.threerings.parlor.card.data
Card + +
+          Instances of this class represent individual playing cards.
CardCodes + +
+          Constants relating to the card services.
Hand + +
+          Instances of this class represent hands of cards.
+  +

+ + + + + + + + + + + + + + + + + +
+Classes in com.threerings.parlor.card.data used by com.threerings.parlor.card.server
Card + +
+          Instances of this class represent individual playing cards.
CardCodes + +
+          Constants relating to the card services.
Deck + +
+          Instances of this class represent decks of cards.
Hand + +
+          Instances of this class represent hands of cards.
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.card.data used by com.threerings.parlor.card.trick.client
Card + +
+          Instances of this class represent individual playing cards.
+  +

+ + + + + + + + + + + + + + + + + +
+Classes in com.threerings.parlor.card.data used by com.threerings.parlor.card.trick.data
Card + +
+          Instances of this class represent individual playing cards.
CardCodes + +
+          Constants relating to the card services.
Hand + +
+          Instances of this class represent hands of cards.
PlayerCard + +
+          Pairs a player index with the card that the player played in the trick.
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.card.data used by com.threerings.parlor.card.trick.server
Card + +
+          Instances of this class represent individual playing cards.
+  +

+ + + + + + + + + + + + + + + + + +
+Classes in com.threerings.parlor.card.data used by com.threerings.parlor.card.trick.util
Card + +
+          Instances of this class represent individual playing cards.
CardCodes + +
+          Constants relating to the card services.
Hand + +
+          Instances of this class represent hands of cards.
PlayerCard + +
+          Pairs a player index with the card that the player played in the trick.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/package-frame.html b/apidocs/com/threerings/parlor/card/package-frame.html new file mode 100644 index 00000000..9b0d02c1 --- /dev/null +++ b/apidocs/com/threerings/parlor/card/package-frame.html @@ -0,0 +1,33 @@ + + + + + + + +com.threerings.parlor.card (vilya 1.3 API) + + + + + + + + + + + +com.threerings.parlor.card + + + + +
+Classes  + +
+Log
+ + + + diff --git a/apidocs/com/threerings/parlor/card/package-summary.html b/apidocs/com/threerings/parlor/card/package-summary.html new file mode 100644 index 00000000..7ac658fb --- /dev/null +++ b/apidocs/com/threerings/parlor/card/package-summary.html @@ -0,0 +1,158 @@ + + + + + + + +com.threerings.parlor.card (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.parlor.card +

+ + + + + + + + + +
+Class Summary
LogContains a reference to the log object used by the Card services.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/package-tree.html b/apidocs/com/threerings/parlor/card/package-tree.html new file mode 100644 index 00000000..e650bfc4 --- /dev/null +++ b/apidocs/com/threerings/parlor/card/package-tree.html @@ -0,0 +1,154 @@ + + + + + + + +com.threerings.parlor.card Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.parlor.card +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/package-use.html b/apidocs/com/threerings/parlor/card/package-use.html new file mode 100644 index 00000000..f893743b --- /dev/null +++ b/apidocs/com/threerings/parlor/card/package-use.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Package com.threerings.parlor.card (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.parlor.card

+
+No usage of com.threerings.parlor.card +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/server/CardGameManager.html b/apidocs/com/threerings/parlor/card/server/CardGameManager.html new file mode 100644 index 00000000..cee8f190 --- /dev/null +++ b/apidocs/com/threerings/parlor/card/server/CardGameManager.html @@ -0,0 +1,604 @@ + + + + + + + +CardGameManager (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.card.server +
+Class CardGameManager

+
+java.lang.Object
+  extended by com.threerings.crowd.server.PlaceManager
+      extended by com.threerings.parlor.game.server.GameManager
+          extended by com.threerings.parlor.card.server.CardGameManager
+
+
+
All Implemented Interfaces:
com.threerings.crowd.chat.server.SpeakHandler.SpeakerValidator, CardCodes, ParlorCodes, GameCodes, PlayManager, TurnGameManager, com.threerings.presents.data.InvocationCodes, com.threerings.presents.dobj.ChangeListener, com.threerings.presents.dobj.MessageListener
+
+
+
+
public class CardGameManager
extends GameManager
implements TurnGameManager, CardCodes
+ + +

+A manager class for card games. Handles common functions like dealing hands of cards to all + players. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.crowd.server.PlaceManager
com.threerings.crowd.server.PlaceManager.DelegateOp, com.threerings.crowd.server.PlaceManager.MessageHandler
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from interface com.threerings.parlor.card.data.CardCodes
ACE, BLACK_JOKER, CLUBS, DIAMONDS, HEARTS, JACK, KING, QUEEN, RED_JOKER, SPADES
+  + + + + + + + +
Fields inherited from interface com.threerings.presents.data.InvocationCodes
ACCESS_DENIED, E_ACCESS_DENIED, E_INTERNAL_ERROR, GLOBAL_GROUP, INTERNAL_ERROR
+  + + + + + + + +
Fields inherited from interface com.threerings.parlor.data.ParlorCodes
ALREADY_AT_TABLE, BANNED_FROM_TABLE, GAME_ALREADY_STARTED, INVALID_TABLE_POSITION, INVITATION_ACCEPTED, INVITATION_COUNTERED, INVITATION_REFUSED, INVITEE_NOT_ONLINE, MUST_BE_CREATOR, NO_SELF_BOOT, NO_SUCH_TABLE, NOT_AT_TABLE, PARLOR_GROUP, TABLE_POSITION_OCCUPIED
+  + + + + + + + +
Fields inherited from interface com.threerings.parlor.game.data.GameCodes
GAME_CHAT_TYPE, GAME_MESSAGE_BUNDLE, PLAYER_KNOCKED_OUT, WINNERS_AND_LOSERS
+  + + + + + + + + + + +
+Constructor Summary
CardGameManager() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ HanddealHand(Deck deck, + int size, + int playerIndex) + +
+          Deals a hand of cards to the player at the specified index from the given Deck.
+ Hand[]dealHands(Deck deck, + int size) + +
+          Deals a hand of cards to each player from the specified Deck.
+ com.threerings.presents.data.ClientObjectgetClientObject(int pidx) + +
+          Returns the client object corresponding to the specified player index, or null if the + position is not occupied by a player.
+ intgetPlayerIndex(com.threerings.presents.data.ClientObject client) + +
+          Gets the player index of the specified client object, or -1 if the client object does not + represent a player.
+ voidrematchGame() + +
+          This should be called to start a rematched game.
+ voidtransferCardsBetweenPlayers(int[] toPlayerIndices, + Card[][] cards) + +
+          Sends sets of cards between players simultaneously.
+ voidtransferCardsBetweenPlayers(int fromPlayerIdx, + int toPlayerIdx, + Card[] cards) + +
+          Sends a set of cards from one player to another.
+ voidturnDidEnd() + +
+          Called when the turn was ended.
+ voidturnDidStart() + +
+          Called when we have started the next turn.
+ voidturnWillStart() + +
+          Called when we are about to start the next turn.
+  + + + + + + + +
Methods inherited from class com.threerings.parlor.game.server.GameManager
addPlayer, addPlayerAt, allPlayersReady, cancelGame, checkWritePermission, endGame, endPlayerGame, getGameConfig, getGameId, getMatchType, getPlayer, getPlayerCount, getPlayerDisplayName, getPlayerIndex, getPlayerName, getPlayerOid, getPlayerPersistentId, getPlayerPersistentId, getPlayerSlots, getPresentPlayerIndex, getSessionId, isActivePlayer, isAgent, isAI, isPlayer, occupantInRoom, playerIsReady, playerReady, removePlayer, replacePlayer, resetGame, setAI, shouldConcludeGame, startGame, systemMessage, systemMessage
+  + + + + + + + +
Methods inherited from class com.threerings.crowd.server.PlaceManager
addDelegate, applyToDelegates, applyToOccupants, bodyWillEnter, bodyWillLeave, checkPermissions, getConfig, getLocation, getPlaceObject, init, isValidSpeaker, messageReceived, ratifyBodyEntry, registerMessageHandler, shutdown, startup, toString, updateOccupantInfo, where
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  + + + + + + + +
Methods inherited from interface com.threerings.parlor.turn.server.TurnGameManager
getPlayerCount, getPlayerIndex, getPlayerName, isActivePlayer
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+CardGameManager

+
+public CardGameManager()
+
+
+ + + + + + + + +
+Method Detail
+ +

+turnWillStart

+
+public void turnWillStart()
+
+
Description copied from interface: TurnGameManager
+
Called when we are about to start the next turn. Implementations + can do whatever pre-start turn activities need to be done. +

+

+
Specified by:
turnWillStart in interface TurnGameManager
+
+
+
+
+
+
+ +

+turnDidStart

+
+public void turnDidStart()
+
+
Description copied from interface: TurnGameManager
+
Called when we have started the next turn. Implementations can do + whatever post-start turn activities need to be done. +

+

+
Specified by:
turnDidStart in interface TurnGameManager
+
+
+
+
+
+
+ +

+turnDidEnd

+
+public void turnDidEnd()
+
+
Description copied from interface: TurnGameManager
+
Called when the turn was ended. Implementations can perform any + post-turn processing (like updating scores, etc.). +

+

+
Specified by:
turnDidEnd in interface TurnGameManager
+
+
+
+
+
+
+ +

+rematchGame

+
+public void rematchGame()
+
+
This should be called to start a rematched game. It just starts the current game anew, but + provides a mechanism for derived classes to do special things when there is a rematch. +

+

+
+
+
+
+
+
+
+ +

+dealHand

+
+public Hand dealHand(Deck deck,
+                     int size,
+                     int playerIndex)
+
+
Deals a hand of cards to the player at the specified index from the given Deck. +

+

+
+
+
+
Parameters:
deck - the deck from which to deal
size - the size of the hand to deal
playerIndex - the index of the target player +
Returns:
the hand dealt to the player, or null if the deal was canceled because the deck did + not contain enough cards
+
+
+
+ +

+dealHands

+
+public Hand[] dealHands(Deck deck,
+                        int size)
+
+
Deals a hand of cards to each player from the specified Deck. +

+

+
+
+
+
Parameters:
deck - the deck from which to deal
size - the size of the hands to deal +
Returns:
the array of hands dealt to each player, or null if the deal was canceled because + the deck did not contain enough cards
+
+
+
+ +

+getPlayerIndex

+
+public int getPlayerIndex(com.threerings.presents.data.ClientObject client)
+
+
Gets the player index of the specified client object, or -1 if the client object does not + represent a player. If the game has ended, looks through the players of the now-ended game. +

+

+
+
+
+
+
+
+
+ +

+getClientObject

+
+public com.threerings.presents.data.ClientObject getClientObject(int pidx)
+
+
Returns the client object corresponding to the specified player index, or null if the + position is not occupied by a player. +

+

+
+
+
+
+
+
+
+ +

+transferCardsBetweenPlayers

+
+public void transferCardsBetweenPlayers(int fromPlayerIdx,
+                                        int toPlayerIdx,
+                                        Card[] cards)
+
+
Sends a set of cards from one player to another. +

+

+
+
+
+
Parameters:
fromPlayerIdx - the index of the player sending the cards
toPlayerIdx - the index of the player receiving the cards
cards - the cards to be exchanged
+
+
+
+ +

+transferCardsBetweenPlayers

+
+public void transferCardsBetweenPlayers(int[] toPlayerIndices,
+                                        Card[][] cards)
+
+
Sends sets of cards between players simultaneously. Each player is guaranteed to receive + the notification of cards received after the notification of cards sent. The length of the + arrays passed must be equal to the player count. +

+

+
+
+
+
Parameters:
toPlayerIndices - for each player, the index of the player to transfer cards to
cards - for each player, the cards to transfer
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/server/CardGameSender.html b/apidocs/com/threerings/parlor/card/server/CardGameSender.html new file mode 100644 index 00000000..b89eef52 --- /dev/null +++ b/apidocs/com/threerings/parlor/card/server/CardGameSender.html @@ -0,0 +1,351 @@ + + + + + + + +CardGameSender (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.card.server +
+Class CardGameSender

+
+java.lang.Object
+  extended by com.threerings.presents.server.InvocationSender
+      extended by com.threerings.parlor.card.server.CardGameSender
+
+
+
+
public class CardGameSender
extends com.threerings.presents.server.InvocationSender
+ + +

+Used to issue notifications to a CardGameReceiver instance on a + client. +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
CardGameSender() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+static voidcardsTransferredBetweenPlayers(com.threerings.presents.data.ClientObject target, + int arg1, + int arg2, + int arg3) + +
+          Issues a notification that will result in a call to CardGameReceiver.cardsTransferredBetweenPlayers(int, int, int) on a client.
+static voidsendCardsFromPlayer(com.threerings.presents.data.ClientObject target, + int arg1, + Card[] arg2) + +
+          Issues a notification that will result in a call to CardGameReceiver.receivedCardsFromPlayer(int, com.threerings.parlor.card.data.Card[]) on a client.
+static voidsendHand(com.threerings.presents.data.ClientObject target, + int arg1, + Hand arg2) + +
+          Issues a notification that will result in a call to CardGameReceiver.receivedHand(int, com.threerings.parlor.card.data.Hand) on a client.
+static voidsentCardsToPlayer(com.threerings.presents.data.ClientObject target, + int arg1, + Card[] arg2) + +
+          Issues a notification that will result in a call to CardGameReceiver.sentCardsToPlayer(int, com.threerings.parlor.card.data.Card[]) on a client.
+  + + + + + + + +
Methods inherited from class com.threerings.presents.server.InvocationSender
sendNotification, sendNotification
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+CardGameSender

+
+public CardGameSender()
+
+
+ + + + + + + + +
+Method Detail
+ +

+cardsTransferredBetweenPlayers

+
+public static void cardsTransferredBetweenPlayers(com.threerings.presents.data.ClientObject target,
+                                                  int arg1,
+                                                  int arg2,
+                                                  int arg3)
+
+
Issues a notification that will result in a call to CardGameReceiver.cardsTransferredBetweenPlayers(int, int, int) on a client. +

+

+
+
+
+
+ +

+sendCardsFromPlayer

+
+public static void sendCardsFromPlayer(com.threerings.presents.data.ClientObject target,
+                                       int arg1,
+                                       Card[] arg2)
+
+
Issues a notification that will result in a call to CardGameReceiver.receivedCardsFromPlayer(int, com.threerings.parlor.card.data.Card[]) on a client. +

+

+
+
+
+
+ +

+sendHand

+
+public static void sendHand(com.threerings.presents.data.ClientObject target,
+                            int arg1,
+                            Hand arg2)
+
+
Issues a notification that will result in a call to CardGameReceiver.receivedHand(int, com.threerings.parlor.card.data.Hand) on a client. +

+

+
+
+
+
+ +

+sentCardsToPlayer

+
+public static void sentCardsToPlayer(com.threerings.presents.data.ClientObject target,
+                                     int arg1,
+                                     Card[] arg2)
+
+
Issues a notification that will result in a call to CardGameReceiver.sentCardsToPlayer(int, com.threerings.parlor.card.data.Card[]) on a client. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/server/class-use/CardGameManager.html b/apidocs/com/threerings/parlor/card/server/class-use/CardGameManager.html new file mode 100644 index 00000000..9e4b978c --- /dev/null +++ b/apidocs/com/threerings/parlor/card/server/class-use/CardGameManager.html @@ -0,0 +1,179 @@ + + + + + + + +Uses of Class com.threerings.parlor.card.server.CardGameManager (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.card.server.CardGameManager

+
+ + + + + + + + + +
+Packages that use CardGameManager
com.threerings.parlor.card.trick.server  
+  +

+ + + + + +
+Uses of CardGameManager in com.threerings.parlor.card.trick.server
+  +

+ + + + + + + + +
Constructors in com.threerings.parlor.card.trick.server with parameters of type CardGameManager
TrickCardGameManagerDelegate(CardGameManager manager) + +
+          Deprecated. use the zero-argument constructor.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/server/class-use/CardGameSender.html b/apidocs/com/threerings/parlor/card/server/class-use/CardGameSender.html new file mode 100644 index 00000000..07d76f72 --- /dev/null +++ b/apidocs/com/threerings/parlor/card/server/class-use/CardGameSender.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.parlor.card.server.CardGameSender (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.card.server.CardGameSender

+
+No usage of com.threerings.parlor.card.server.CardGameSender +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/server/package-frame.html b/apidocs/com/threerings/parlor/card/server/package-frame.html new file mode 100644 index 00000000..71424169 --- /dev/null +++ b/apidocs/com/threerings/parlor/card/server/package-frame.html @@ -0,0 +1,35 @@ + + + + + + + +com.threerings.parlor.card.server (vilya 1.3 API) + + + + + + + + + + + +com.threerings.parlor.card.server + + + + +
+Classes  + +
+CardGameManager +
+CardGameSender
+ + + + diff --git a/apidocs/com/threerings/parlor/card/server/package-summary.html b/apidocs/com/threerings/parlor/card/server/package-summary.html new file mode 100644 index 00000000..7a15b64c --- /dev/null +++ b/apidocs/com/threerings/parlor/card/server/package-summary.html @@ -0,0 +1,163 @@ + + + + + + + +com.threerings.parlor.card.server (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.parlor.card.server +

+ + + + + + + + + + + + + +
+Class Summary
CardGameManagerA manager class for card games.
CardGameSenderUsed to issue notifications to a CardGameReceiver instance on a + client.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/server/package-tree.html b/apidocs/com/threerings/parlor/card/server/package-tree.html new file mode 100644 index 00000000..6f7402d5 --- /dev/null +++ b/apidocs/com/threerings/parlor/card/server/package-tree.html @@ -0,0 +1,163 @@ + + + + + + + +com.threerings.parlor.card.server Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.parlor.card.server +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/server/package-use.html b/apidocs/com/threerings/parlor/card/server/package-use.html new file mode 100644 index 00000000..21052235 --- /dev/null +++ b/apidocs/com/threerings/parlor/card/server/package-use.html @@ -0,0 +1,171 @@ + + + + + + + +Uses of Package com.threerings.parlor.card.server (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.parlor.card.server

+
+ + + + + + + + + +
+Packages that use com.threerings.parlor.card.server
com.threerings.parlor.card.trick.server  
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.card.server used by com.threerings.parlor.card.trick.server
CardGameManager + +
+          A manager class for card games.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/trick/client/TrickCardGameControllerDelegate.html b/apidocs/com/threerings/parlor/card/trick/client/TrickCardGameControllerDelegate.html new file mode 100644 index 00000000..e2bf5d69 --- /dev/null +++ b/apidocs/com/threerings/parlor/card/trick/client/TrickCardGameControllerDelegate.html @@ -0,0 +1,266 @@ + + + + + + + +TrickCardGameControllerDelegate (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.card.trick.client +
+Class TrickCardGameControllerDelegate

+
+java.lang.Object
+  extended by com.threerings.crowd.client.PlaceControllerDelegate
+      extended by com.threerings.parlor.game.client.GameControllerDelegate
+          extended by com.threerings.parlor.turn.client.TurnGameControllerDelegate
+              extended by com.threerings.parlor.card.trick.client.TrickCardGameControllerDelegate
+
+
+
All Implemented Interfaces:
com.threerings.presents.dobj.AttributeChangeListener, com.threerings.presents.dobj.ChangeListener
+
+
+
+
public class TrickCardGameControllerDelegate
extends TurnGameControllerDelegate
+ + +

+A card game controller delegate for trick-based card games, such as Spades and Hearts. +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
TrickCardGameControllerDelegate(CardGameController controller) + +
+          Constructor.
+  + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from class com.threerings.parlor.turn.client.TurnGameControllerDelegate
attributeChanged, didLeavePlace, getTurnHolderIndex, init, isOurTurn, willEnterPlace
+  + + + + + + + +
Methods inherited from class com.threerings.parlor.game.client.GameControllerDelegate
gameDidEnd, gameDidStart, gameWasCancelled, gameWillReset
+  + + + + + + + +
Methods inherited from class com.threerings.crowd.client.PlaceControllerDelegate
handleAction, mayLeavePlace
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+TrickCardGameControllerDelegate

+
+public TrickCardGameControllerDelegate(CardGameController controller)
+
+
Constructor. +

+

+
Parameters:
controller - the game controller
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/trick/client/TrickCardGameService.html b/apidocs/com/threerings/parlor/card/trick/client/TrickCardGameService.html new file mode 100644 index 00000000..9debedcf --- /dev/null +++ b/apidocs/com/threerings/parlor/card/trick/client/TrickCardGameService.html @@ -0,0 +1,294 @@ + + + + + + + +TrickCardGameService (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.card.trick.client +
+Interface TrickCardGameService

+
+
All Superinterfaces:
com.threerings.presents.client.InvocationService
+
+
+
All Known Implementing Classes:
TrickCardGameMarshaller
+
+
+
+
public interface TrickCardGameService
extends com.threerings.presents.client.InvocationService
+ + +

+Service calls related to trick card games. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.presents.client.InvocationService
com.threerings.presents.client.InvocationService.ConfirmListener, com.threerings.presents.client.InvocationService.InvocationListener, com.threerings.presents.client.InvocationService.ResultListener
+  + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidplayCard(Card card, + int handSize) + +
+          Plays a card in the trick.
+ voidrequestRematch() + +
+          A request for a rematch.
+ voidsendCardsToPlayer(int toidx, + Card[] cards) + +
+          Sends a group of cards to the player at the specified index.
+  +

+ + + + + + + + +
+Method Detail
+ +

+sendCardsToPlayer

+
+void sendCardsToPlayer(int toidx,
+                       Card[] cards)
+
+
Sends a group of cards to the player at the specified index. +

+

+
+
+
+
Parameters:
toidx - the index of the player to send the cards to
cards - the cards to send
+
+
+
+ +

+playCard

+
+void playCard(Card card,
+              int handSize)
+
+
Plays a card in the trick. +

+

+
+
+
+
Parameters:
card - the card to play
handSize - the size of the player's hand, which is used to verify + that the request is for the current trick
+
+
+
+ +

+requestRematch

+
+void requestRematch()
+
+
A request for a rematch. +

+

+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/trick/client/class-use/TrickCardGameControllerDelegate.html b/apidocs/com/threerings/parlor/card/trick/client/class-use/TrickCardGameControllerDelegate.html new file mode 100644 index 00000000..4e04b46f --- /dev/null +++ b/apidocs/com/threerings/parlor/card/trick/client/class-use/TrickCardGameControllerDelegate.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.parlor.card.trick.client.TrickCardGameControllerDelegate (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.card.trick.client.TrickCardGameControllerDelegate

+
+No usage of com.threerings.parlor.card.trick.client.TrickCardGameControllerDelegate +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/trick/client/class-use/TrickCardGameService.html b/apidocs/com/threerings/parlor/card/trick/client/class-use/TrickCardGameService.html new file mode 100644 index 00000000..cab7115f --- /dev/null +++ b/apidocs/com/threerings/parlor/card/trick/client/class-use/TrickCardGameService.html @@ -0,0 +1,183 @@ + + + + + + + +Uses of Interface com.threerings.parlor.card.trick.client.TrickCardGameService (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.parlor.card.trick.client.TrickCardGameService

+
+ + + + + + + + + +
+Packages that use TrickCardGameService
com.threerings.parlor.card.trick.data  
+  +

+ + + + + +
+Uses of TrickCardGameService in com.threerings.parlor.card.trick.data
+  +

+ + + + + + + + + +
Classes in com.threerings.parlor.card.trick.data that implement TrickCardGameService
+ classTrickCardGameMarshaller + +
+          Provides the implementation of the TrickCardGameService interface + that marshalls the arguments and delivers the request to the provider + on the server.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/trick/client/package-frame.html b/apidocs/com/threerings/parlor/card/trick/client/package-frame.html new file mode 100644 index 00000000..2a70bacf --- /dev/null +++ b/apidocs/com/threerings/parlor/card/trick/client/package-frame.html @@ -0,0 +1,44 @@ + + + + + + + +com.threerings.parlor.card.trick.client (vilya 1.3 API) + + + + + + + + + + + +com.threerings.parlor.card.trick.client + + + + +
+Interfaces  + +
+TrickCardGameService
+ + + + + + +
+Classes  + +
+TrickCardGameControllerDelegate
+ + + + diff --git a/apidocs/com/threerings/parlor/card/trick/client/package-summary.html b/apidocs/com/threerings/parlor/card/trick/client/package-summary.html new file mode 100644 index 00000000..81c69a78 --- /dev/null +++ b/apidocs/com/threerings/parlor/card/trick/client/package-summary.html @@ -0,0 +1,172 @@ + + + + + + + +com.threerings.parlor.card.trick.client (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.parlor.card.trick.client +

+ + + + + + + + + +
+Interface Summary
TrickCardGameServiceService calls related to trick card games.
+  + +

+ + + + + + + + + +
+Class Summary
TrickCardGameControllerDelegateA card game controller delegate for trick-based card games, such as Spades and Hearts.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/trick/client/package-tree.html b/apidocs/com/threerings/parlor/card/trick/client/package-tree.html new file mode 100644 index 00000000..eb2f55b5 --- /dev/null +++ b/apidocs/com/threerings/parlor/card/trick/client/package-tree.html @@ -0,0 +1,168 @@ + + + + + + + +com.threerings.parlor.card.trick.client Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.parlor.card.trick.client +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/trick/client/package-use.html b/apidocs/com/threerings/parlor/card/trick/client/package-use.html new file mode 100644 index 00000000..3cc83fa8 --- /dev/null +++ b/apidocs/com/threerings/parlor/card/trick/client/package-use.html @@ -0,0 +1,171 @@ + + + + + + + +Uses of Package com.threerings.parlor.card.trick.client (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.parlor.card.trick.client

+
+ + + + + + + + + +
+Packages that use com.threerings.parlor.card.trick.client
com.threerings.parlor.card.trick.data  
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.card.trick.client used by com.threerings.parlor.card.trick.data
TrickCardGameService + +
+          Service calls related to trick card games.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/trick/data/TrickCardCodes.html b/apidocs/com/threerings/parlor/card/trick/data/TrickCardCodes.html new file mode 100644 index 00000000..3947f049 --- /dev/null +++ b/apidocs/com/threerings/parlor/card/trick/data/TrickCardCodes.html @@ -0,0 +1,295 @@ + + + + + + + +TrickCardCodes (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.card.trick.data +
+Interface TrickCardCodes

+
+
All Superinterfaces:
CardCodes, com.threerings.presents.data.InvocationCodes
+
+
+
All Known Implementing Classes:
TrickCardGameUtil
+
+
+
+
public interface TrickCardCodes
extends CardCodes
+ + +

+Constants relating to trick-based card games. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static intBOTTOM + +
+          For four-player games, the bottom (own) player.
+static intLEFT + +
+          For four-player games, the player on the left.
+static intRIGHT + +
+          For four-player games, the player on the right.
+static intTOP + +
+          For four-player games, the top (opposite) player.
+  + + + + + + + +
Fields inherited from interface com.threerings.parlor.card.data.CardCodes
ACE, BLACK_JOKER, CLUBS, DIAMONDS, HEARTS, JACK, KING, QUEEN, RED_JOKER, SPADES
+  + + + + + + + +
Fields inherited from interface com.threerings.presents.data.InvocationCodes
ACCESS_DENIED, E_ACCESS_DENIED, E_INTERNAL_ERROR, GLOBAL_GROUP, INTERNAL_ERROR
+  +

+ + + + + + + + +
+Field Detail
+ +

+BOTTOM

+
+static final int BOTTOM
+
+
For four-player games, the bottom (own) player. +

+

+
See Also:
Constant Field Values
+
+
+ +

+LEFT

+
+static final int LEFT
+
+
For four-player games, the player on the left. +

+

+
See Also:
Constant Field Values
+
+
+ +

+TOP

+
+static final int TOP
+
+
For four-player games, the top (opposite) player. +

+

+
See Also:
Constant Field Values
+
+
+ +

+RIGHT

+
+static final int RIGHT
+
+
For four-player games, the player on the right. +

+

+
See Also:
Constant Field Values
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/trick/data/TrickCardGameMarshaller.html b/apidocs/com/threerings/parlor/card/trick/data/TrickCardGameMarshaller.html new file mode 100644 index 00000000..155f2326 --- /dev/null +++ b/apidocs/com/threerings/parlor/card/trick/data/TrickCardGameMarshaller.html @@ -0,0 +1,454 @@ + + + + + + + +TrickCardGameMarshaller (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.card.trick.data +
+Class TrickCardGameMarshaller

+
+java.lang.Object
+  extended by com.threerings.presents.data.InvocationMarshaller
+      extended by com.threerings.parlor.card.trick.data.TrickCardGameMarshaller
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable, TrickCardGameService, com.threerings.presents.client.InvocationService
+
+
+
+
@Generated(value="com.threerings.presents.tools.GenServiceTask",
+           comments="Derived from TrickCardGameService.java.")
+public class TrickCardGameMarshaller
extends com.threerings.presents.data.InvocationMarshaller
implements TrickCardGameService
+ + +

+Provides the implementation of the TrickCardGameService interface + that marshalls the arguments and delivers the request to the provider + on the server. Also provides an implementation of the response listener + interfaces that marshall the response arguments and deliver them back + to the requesting client. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.presents.data.InvocationMarshaller
com.threerings.presents.data.InvocationMarshaller.ConfirmMarshaller, com.threerings.presents.data.InvocationMarshaller.ListenerMarshaller, com.threerings.presents.data.InvocationMarshaller.ResultMarshaller
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.presents.client.InvocationService
com.threerings.presents.client.InvocationService.ConfirmListener, com.threerings.presents.client.InvocationService.InvocationListener, com.threerings.presents.client.InvocationService.ResultListener
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static intPLAY_CARD + +
+          The method id used to dispatch playCard(com.threerings.parlor.card.data.Card, int) requests.
+static intREQUEST_REMATCH + +
+          The method id used to dispatch requestRematch() requests.
+static intSEND_CARDS_TO_PLAYER + +
+          The method id used to dispatch sendCardsToPlayer(int, com.threerings.parlor.card.data.Card[]) requests.
+  + + + + + + + + + + +
+Constructor Summary
TrickCardGameMarshaller() + +
+           
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidplayCard(Card arg1, + int arg2) + +
+          Plays a card in the trick.
+ voidrequestRematch() + +
+          A request for a rematch.
+ voidsendCardsToPlayer(int arg1, + Card[] arg2) + +
+          Sends a group of cards to the player at the specified index.
+  + + + + + + + +
Methods inherited from class com.threerings.presents.data.InvocationMarshaller
getInvocationCode, init, readField__invCode, readField__invOid, readObject, setInvocationOid, setNoResponse, toString, writeField__invCode, writeField__invOid
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+PLAY_CARD

+
+public static final int PLAY_CARD
+
+
The method id used to dispatch playCard(com.threerings.parlor.card.data.Card, int) requests. +

+

+
See Also:
Constant Field Values
+
+
+ +

+REQUEST_REMATCH

+
+public static final int REQUEST_REMATCH
+
+
The method id used to dispatch requestRematch() requests. +

+

+
See Also:
Constant Field Values
+
+
+ +

+SEND_CARDS_TO_PLAYER

+
+public static final int SEND_CARDS_TO_PLAYER
+
+
The method id used to dispatch sendCardsToPlayer(int, com.threerings.parlor.card.data.Card[]) requests. +

+

+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Constructor Detail
+ +

+TrickCardGameMarshaller

+
+public TrickCardGameMarshaller()
+
+
+ + + + + + + + +
+Method Detail
+ +

+playCard

+
+public void playCard(Card arg1,
+                     int arg2)
+
+
Description copied from interface: TrickCardGameService
+
Plays a card in the trick. +

+

+
Specified by:
playCard in interface TrickCardGameService
+
+
+
Parameters:
arg1 - the card to play
arg2 - the size of the player's hand, which is used to verify + that the request is for the current trick
+
+
+
+ +

+requestRematch

+
+public void requestRematch()
+
+
Description copied from interface: TrickCardGameService
+
A request for a rematch. +

+

+
Specified by:
requestRematch in interface TrickCardGameService
+
+
+
+
+
+
+ +

+sendCardsToPlayer

+
+public void sendCardsToPlayer(int arg1,
+                              Card[] arg2)
+
+
Description copied from interface: TrickCardGameService
+
Sends a group of cards to the player at the specified index. +

+

+
Specified by:
sendCardsToPlayer in interface TrickCardGameService
+
+
+
Parameters:
arg1 - the index of the player to send the cards to
arg2 - the cards to send
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/trick/data/TrickCardGameObject.html b/apidocs/com/threerings/parlor/card/trick/data/TrickCardGameObject.html new file mode 100644 index 00000000..5c6df92e --- /dev/null +++ b/apidocs/com/threerings/parlor/card/trick/data/TrickCardGameObject.html @@ -0,0 +1,908 @@ + + + + + + + +TrickCardGameObject (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.card.trick.data +
+Interface TrickCardGameObject

+
+
All Superinterfaces:
TurnGameObject
+
+
+
+
public interface TrickCardGameObject
extends TurnGameObject
+ + +

+Game objects for trick-based card games must implement this interface. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static intACCEPTS_REMATCH + +
+          Indicates that the player has accepted the rematch request.
+static intBETWEEN_HANDS + +
+          The state that indicates the game is currently between hands.
+static intNO_REQUEST + +
+          Indicates that the player has not requested or accepted a rematch.
+static intPLAYING_HAND + +
+          The state that indicates the game is currently playing a hand.
+static intPLAYING_TRICK + +
+          The state that indicates the game is currently playing a trick.
+static intREQUESTS_REMATCH + +
+          Indicates that the player has requested a rematch.
+static intTRICK_STATE_COUNT + +
+          The number of states defined for the base trick card game object.
+  + + + + + + + +
Fields inherited from interface com.threerings.parlor.turn.data.TurnGameObject
TURN_HOLDER_REPLACED
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ PlayerCard[]getCardsPlayed() + +
+          Returns an array containing the history of the trick in terms of the + cards played by each player.
+ StringgetCardsPlayedFieldName() + +
+          Returns the name of the field that contains the history of the trick + in terms of the cards played by each player.
+ PlayerCard[]getLastCardsPlayed() + +
+          Returns an array containing the history of the last trick in terms of + the cards played by each player.
+ StringgetLastCardsPlayedFieldName() + +
+          Returns the name of the field that contains the history of the last + trick in terms of the cards played by each player.
+ int[]getRematchRequests() + +
+          Returns the array of rematch requests.
+ StringgetRematchRequestsFieldName() + +
+          Returns the name of the field that contains the rematch requests.
+ TrickCardGameMarshallergetTrickCardGameService() + +
+          Returns a reference to the trick card game service used to make + requests to the server.
+ intgetTrickState() + +
+          Returns the trick state: between hands, playing a hand, or playing a + trick.
+ StringgetTrickStateFieldName() + +
+          Returns the name of the field that contains the trick state: between + hands, playing a hand, or playing a trick.
+ PlayerCardgetTrickTaker() + +
+          Returns the card of the player who took the current trick.
+ longgetTurnDuration() + +
+          Returns the duration of the current turn, which may depend on the state + of the game as well as the duration scale of the active player.
+ float[]getTurnDurationScales() + +
+          Returns an array containing the turn duration scales for each player.
+ booleanisCardPlayable(Hand hand, + Card card) + +
+          Checks whether a user can play the specified card at this time.
+ voidsetCardsPlayed(PlayerCard[] cardsPlayed) + +
+          Sets the array of cards played by each player.
+ voidsetLastCardsPlayed(PlayerCard[] lastCardsPlayed) + +
+          Sets the last array of cards played by each player.
+ voidsetRematchRequests(int[] rematchRequests) + +
+          Sets the array of rematch requests.
+ voidsetRematchRequestsAt(int rematchRequest, + int index) + +
+          Sets an element of the rematch request array.
+ voidsetTrickCardGameService(TrickCardGameMarshaller trickCardGameService) + +
+          Sets the reference to the trick card game service.
+ voidsetTrickState(int trickState) + +
+          Sets the trick state.
+ voidsetTurnDurationScales(float[] turnDurationScales) + +
+          Sets the array of turn duration scales.
+ voidsetTurnDurationScalesAt(float turnDurationScale, + int index) + +
+          Sets an element of the array of turn duration scales.
+  + + + + + + + +
Methods inherited from interface com.threerings.parlor.turn.data.TurnGameObject
getPlayers, getTurnHolder, getTurnHolderFieldName, isInPlay, setTurnHolder
+  +

+ + + + + + + + +
+Field Detail
+ +

+BETWEEN_HANDS

+
+static final int BETWEEN_HANDS
+
+
The state that indicates the game is currently between hands. +

+

+
See Also:
Constant Field Values
+
+
+ +

+PLAYING_HAND

+
+static final int PLAYING_HAND
+
+
The state that indicates the game is currently playing a hand. +

+

+
See Also:
Constant Field Values
+
+
+ +

+PLAYING_TRICK

+
+static final int PLAYING_TRICK
+
+
The state that indicates the game is currently playing a trick. +

+

+
See Also:
Constant Field Values
+
+
+ +

+TRICK_STATE_COUNT

+
+static final int TRICK_STATE_COUNT
+
+
The number of states defined for the base trick card game object. +

+

+
See Also:
Constant Field Values
+
+
+ +

+NO_REQUEST

+
+static final int NO_REQUEST
+
+
Indicates that the player has not requested or accepted a rematch. +

+

+
See Also:
Constant Field Values
+
+
+ +

+REQUESTS_REMATCH

+
+static final int REQUESTS_REMATCH
+
+
Indicates that the player has requested a rematch. +

+

+
See Also:
Constant Field Values
+
+
+ +

+ACCEPTS_REMATCH

+
+static final int ACCEPTS_REMATCH
+
+
Indicates that the player has accepted the rematch request. +

+

+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Method Detail
+ +

+getTrickCardGameService

+
+TrickCardGameMarshaller getTrickCardGameService()
+
+
Returns a reference to the trick card game service used to make + requests to the server. +

+

+
+
+
+ +
Returns:
a reference to the trick card game service
+
+
+
+ +

+setTrickCardGameService

+
+void setTrickCardGameService(TrickCardGameMarshaller trickCardGameService)
+
+
Sets the reference to the trick card game service. +

+

+
+
+
+
Parameters:
trickCardGameService - the trick card game service
+
+
+
+ +

+getTrickStateFieldName

+
+String getTrickStateFieldName()
+
+
Returns the name of the field that contains the trick state: between + hands, playing a hand, or playing a trick. +

+

+
+
+
+ +
Returns:
the name of the trickState field
+
+
+
+ +

+getTrickState

+
+int getTrickState()
+
+
Returns the trick state: between hands, playing a hand, or playing a + trick. +

+

+
+
+
+ +
Returns:
the trick state
+
+
+
+ +

+setTrickState

+
+void setTrickState(int trickState)
+
+
Sets the trick state. +

+

+
+
+
+
Parameters:
trickState - the trick state
+
+
+
+ +

+getTurnDurationScales

+
+float[] getTurnDurationScales()
+
+
Returns an array containing the turn duration scales for each player. + Turn duration scales decrease each time players time out. +

+

+
+
+
+ +
Returns:
the array of turn duration scales
+
+
+
+ +

+setTurnDurationScales

+
+void setTurnDurationScales(float[] turnDurationScales)
+
+
Sets the array of turn duration scales. +

+

+
+
+
+
Parameters:
turnDurationScales - the array of turn duration scales
+
+
+
+ +

+setTurnDurationScalesAt

+
+void setTurnDurationScalesAt(float turnDurationScale,
+                             int index)
+
+
Sets an element of the array of turn duration scales. +

+

+
+
+
+
Parameters:
turnDurationScale - the turn duration scale
index - the index of the turn duration scale
+
+
+
+ +

+getTurnDuration

+
+long getTurnDuration()
+
+
Returns the duration of the current turn, which may depend on the state + of the game as well as the duration scale of the active player. +

+

+
+
+
+
+
+
+
+ +

+getCardsPlayedFieldName

+
+String getCardsPlayedFieldName()
+
+
Returns the name of the field that contains the history of the trick + in terms of the cards played by each player. +

+

+
+
+
+ +
Returns:
the name of the cardsPlayed field
+
+
+
+ +

+getCardsPlayed

+
+PlayerCard[] getCardsPlayed()
+
+
Returns an array containing the history of the trick in terms of the + cards played by each player. +

+

+
+
+
+ +
Returns:
the cards played so far in the trick
+
+
+
+ +

+setCardsPlayed

+
+void setCardsPlayed(PlayerCard[] cardsPlayed)
+
+
Sets the array of cards played by each player. +

+

+
+
+
+
Parameters:
cardsPlayed - the array of cards played
+
+
+
+ +

+getLastCardsPlayedFieldName

+
+String getLastCardsPlayedFieldName()
+
+
Returns the name of the field that contains the history of the last + trick in terms of the cards played by each player. +

+

+
+
+
+ +
Returns:
the name of the lastCardsPlayed field
+
+
+
+ +

+getLastCardsPlayed

+
+PlayerCard[] getLastCardsPlayed()
+
+
Returns an array containing the history of the last trick in terms of + the cards played by each player. +

+

+
+
+
+ +
Returns:
the cards played in the last trick
+
+
+
+ +

+setLastCardsPlayed

+
+void setLastCardsPlayed(PlayerCard[] lastCardsPlayed)
+
+
Sets the last array of cards played by each player. +

+

+
+
+
+
Parameters:
lastCardsPlayed - the last array of cards played
+
+
+
+ +

+getRematchRequestsFieldName

+
+String getRematchRequestsFieldName()
+
+
Returns the name of the field that contains the rematch requests. +

+

+
+
+
+ +
Returns:
the name of the rematchRequests field
+
+
+
+ +

+getRematchRequests

+
+int[] getRematchRequests()
+
+
Returns the array of rematch requests. +

+

+
+
+
+ +
Returns:
the array of rematch requests
+
+
+
+ +

+setRematchRequests

+
+void setRematchRequests(int[] rematchRequests)
+
+
Sets the array of rematch requests. +

+

+
+
+
+
Parameters:
rematchRequests - the array of rematch requests
+
+
+
+ +

+setRematchRequestsAt

+
+void setRematchRequestsAt(int rematchRequest,
+                          int index)
+
+
Sets an element of the rematch request array. +

+

+
+
+
+
Parameters:
rematchRequest - the rematch request value
index - the index at which to set the value
+
+
+
+ +

+isCardPlayable

+
+boolean isCardPlayable(Hand hand,
+                       Card card)
+
+
Checks whether a user can play the specified card at this time. +

+

+
+
+
+
Parameters:
hand - the player's hand
card - the card that the user would like to play
+
+
+
+ +

+getTrickTaker

+
+PlayerCard getTrickTaker()
+
+
Returns the card of the player who took the current trick. +

+

+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/trick/data/class-use/TrickCardCodes.html b/apidocs/com/threerings/parlor/card/trick/data/class-use/TrickCardCodes.html new file mode 100644 index 00000000..d04970bf --- /dev/null +++ b/apidocs/com/threerings/parlor/card/trick/data/class-use/TrickCardCodes.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Interface com.threerings.parlor.card.trick.data.TrickCardCodes (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.parlor.card.trick.data.TrickCardCodes

+
+ + + + + + + + + +
+Packages that use TrickCardCodes
com.threerings.parlor.card.trick.util  
+  +

+ + + + + +
+Uses of TrickCardCodes in com.threerings.parlor.card.trick.util
+  +

+ + + + + + + + + +
Classes in com.threerings.parlor.card.trick.util that implement TrickCardCodes
+ classTrickCardGameUtil + +
+          Methods of general utility to trick-taking card games.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/trick/data/class-use/TrickCardGameMarshaller.html b/apidocs/com/threerings/parlor/card/trick/data/class-use/TrickCardGameMarshaller.html new file mode 100644 index 00000000..f71baed8 --- /dev/null +++ b/apidocs/com/threerings/parlor/card/trick/data/class-use/TrickCardGameMarshaller.html @@ -0,0 +1,198 @@ + + + + + + + +Uses of Class com.threerings.parlor.card.trick.data.TrickCardGameMarshaller (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.card.trick.data.TrickCardGameMarshaller

+
+ + + + + + + + + +
+Packages that use TrickCardGameMarshaller
com.threerings.parlor.card.trick.data  
+  +

+ + + + + +
+Uses of TrickCardGameMarshaller in com.threerings.parlor.card.trick.data
+  +

+ + + + + + + + + +
Methods in com.threerings.parlor.card.trick.data that return TrickCardGameMarshaller
+ TrickCardGameMarshallerTrickCardGameObject.getTrickCardGameService() + +
+          Returns a reference to the trick card game service used to make + requests to the server.
+  +

+ + + + + + + + + +
Methods in com.threerings.parlor.card.trick.data with parameters of type TrickCardGameMarshaller
+ voidTrickCardGameObject.setTrickCardGameService(TrickCardGameMarshaller trickCardGameService) + +
+          Sets the reference to the trick card game service.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/trick/data/class-use/TrickCardGameObject.html b/apidocs/com/threerings/parlor/card/trick/data/class-use/TrickCardGameObject.html new file mode 100644 index 00000000..335d7088 --- /dev/null +++ b/apidocs/com/threerings/parlor/card/trick/data/class-use/TrickCardGameObject.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Interface com.threerings.parlor.card.trick.data.TrickCardGameObject (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.parlor.card.trick.data.TrickCardGameObject

+
+No usage of com.threerings.parlor.card.trick.data.TrickCardGameObject +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/trick/data/package-frame.html b/apidocs/com/threerings/parlor/card/trick/data/package-frame.html new file mode 100644 index 00000000..b26b81b2 --- /dev/null +++ b/apidocs/com/threerings/parlor/card/trick/data/package-frame.html @@ -0,0 +1,46 @@ + + + + + + + +com.threerings.parlor.card.trick.data (vilya 1.3 API) + + + + + + + + + + + +com.threerings.parlor.card.trick.data + + + + +
+Interfaces  + +
+TrickCardCodes +
+TrickCardGameObject
+ + + + + + +
+Classes  + +
+TrickCardGameMarshaller
+ + + + diff --git a/apidocs/com/threerings/parlor/card/trick/data/package-summary.html b/apidocs/com/threerings/parlor/card/trick/data/package-summary.html new file mode 100644 index 00000000..c8fed95f --- /dev/null +++ b/apidocs/com/threerings/parlor/card/trick/data/package-summary.html @@ -0,0 +1,178 @@ + + + + + + + +com.threerings.parlor.card.trick.data (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.parlor.card.trick.data +

+ + + + + + + + + + + + + +
+Interface Summary
TrickCardCodesConstants relating to trick-based card games.
TrickCardGameObjectGame objects for trick-based card games must implement this interface.
+  + +

+ + + + + + + + + +
+Class Summary
TrickCardGameMarshallerProvides the implementation of the TrickCardGameService interface + that marshalls the arguments and delivers the request to the provider + on the server.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/trick/data/package-tree.html b/apidocs/com/threerings/parlor/card/trick/data/package-tree.html new file mode 100644 index 00000000..1d3d12d2 --- /dev/null +++ b/apidocs/com/threerings/parlor/card/trick/data/package-tree.html @@ -0,0 +1,169 @@ + + + + + + + +com.threerings.parlor.card.trick.data Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.parlor.card.trick.data +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/trick/data/package-use.html b/apidocs/com/threerings/parlor/card/trick/data/package-use.html new file mode 100644 index 00000000..9dd99ed5 --- /dev/null +++ b/apidocs/com/threerings/parlor/card/trick/data/package-use.html @@ -0,0 +1,192 @@ + + + + + + + +Uses of Package com.threerings.parlor.card.trick.data (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.parlor.card.trick.data

+
+ + + + + + + + + + + + + +
+Packages that use com.threerings.parlor.card.trick.data
com.threerings.parlor.card.trick.data  
com.threerings.parlor.card.trick.util  
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.card.trick.data used by com.threerings.parlor.card.trick.data
TrickCardGameMarshaller + +
+          Provides the implementation of the TrickCardGameService interface + that marshalls the arguments and delivers the request to the provider + on the server.
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.card.trick.data used by com.threerings.parlor.card.trick.util
TrickCardCodes + +
+          Constants relating to trick-based card games.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/trick/server/TrickCardGameManagerDelegate.html b/apidocs/com/threerings/parlor/card/trick/server/TrickCardGameManagerDelegate.html new file mode 100644 index 00000000..629cbead --- /dev/null +++ b/apidocs/com/threerings/parlor/card/trick/server/TrickCardGameManagerDelegate.html @@ -0,0 +1,686 @@ + + + + + + + +TrickCardGameManagerDelegate (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.card.trick.server +
+Class TrickCardGameManagerDelegate

+
+java.lang.Object
+  extended by com.threerings.crowd.server.PlaceManagerDelegate
+      extended by com.threerings.parlor.server.PlayManagerDelegate
+          extended by com.threerings.parlor.game.server.GameManagerDelegate
+              extended by com.threerings.parlor.turn.server.TurnGameManagerDelegate
+                  extended by com.threerings.parlor.card.trick.server.TrickCardGameManagerDelegate
+
+
+
All Implemented Interfaces:
TrickCardGameProvider, com.threerings.presents.server.InvocationProvider
+
+
+
+
public class TrickCardGameManagerDelegate
extends TurnGameManagerDelegate
implements TrickCardGameProvider
+ + +

+A card game manager delegate for trick-based card games, such as Spades and Hearts. +

+ +

+

+ +

+ + + + + + + + + + + + + + +
+Constructor Summary
TrickCardGameManagerDelegate() + +
+           
TrickCardGameManagerDelegate(CardGameManager manager) + +
+          Deprecated. use the zero-argument constructor.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voiddidInit(com.threerings.crowd.data.PlaceConfig config) + +
+           
+ voiddidStartup(com.threerings.crowd.data.PlaceObject plobj) + +
+           
+ voidendHand() + +
+          Ends the hand of cards.
+ voidendTrick() + +
+          Ends the trick.
+ voidendTurn() + +
+          Called to end the turn.
+ voidgameDidEnd() + +
+          Called by the game manager after the game ended.
+ voidgameDidStart() + +
+          Called when the game has started.
+ voidgameWillStart() + +
+          Called by the game manager when the game is about to start.
+ voidinit(com.threerings.crowd.server.PlaceManager plmgr, + com.threerings.presents.dobj.RootDObjectManager omgr, + com.threerings.presents.server.InvocationManager invmgr) + +
+           
+ voidplayCard(com.threerings.presents.data.ClientObject client, + Card card, + int handSize) + +
+          Handles a TrickCardGameService.playCard(com.threerings.parlor.card.data.Card, int) request.
+ voidrequestRematch(com.threerings.presents.data.ClientObject client) + +
+          Handles a TrickCardGameService.requestRematch() request.
+ voidsendCardsToPlayer(com.threerings.presents.data.ClientObject client, + int toidx, + Card[] cards) + +
+          Handles a TrickCardGameService.sendCardsToPlayer(int, com.threerings.parlor.card.data.Card[]) request.
+ voidstartHand() + +
+          Starts a hand of cards.
+ voidstartTrick() + +
+          Starts a trick.
+ voidstartTurn() + +
+          Called to start the next turn.
+  + + + + + + + +
Methods inherited from class com.threerings.parlor.turn.server.TurnGameManagerDelegate
getTurnHolderIndex, isPlayersTurn, playerWasReplaced
+  + + + + + + + +
Methods inherited from class com.threerings.parlor.game.server.GameManagerDelegate
gameWillEnd, gameWillReset, setAI, tickAI
+  + + + + + + + +
Methods inherited from class com.threerings.crowd.server.PlaceManagerDelegate
bodyEntered, bodyLeft, bodyUpdated, didShutdown, placeBecameEmpty, where
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+TrickCardGameManagerDelegate

+
+public TrickCardGameManagerDelegate()
+
+
+
+ +

+TrickCardGameManagerDelegate

+
+@Deprecated
+public TrickCardGameManagerDelegate(CardGameManager manager)
+
+
Deprecated. use the zero-argument constructor. +

+

+ + + + + + + + +
+Method Detail
+ +

+init

+
+public void init(com.threerings.crowd.server.PlaceManager plmgr,
+                 com.threerings.presents.dobj.RootDObjectManager omgr,
+                 com.threerings.presents.server.InvocationManager invmgr)
+
+
+
Overrides:
init in class com.threerings.crowd.server.PlaceManagerDelegate
+
+
+
+
+
+
+ +

+didInit

+
+public void didInit(com.threerings.crowd.data.PlaceConfig config)
+
+
+
Overrides:
didInit in class TurnGameManagerDelegate
+
+
+
+
+
+
+ +

+didStartup

+
+public void didStartup(com.threerings.crowd.data.PlaceObject plobj)
+
+
+
Overrides:
didStartup in class TurnGameManagerDelegate
+
+
+
+
+
+
+ +

+gameWillStart

+
+public void gameWillStart()
+
+
Description copied from class: GameManagerDelegate
+
Called by the game manager when the game is about to start. +

+

+
Overrides:
gameWillStart in class GameManagerDelegate
+
+
+
+
+
+
+ +

+gameDidStart

+
+public void gameDidStart()
+
+
Called when the game has started. Default implementation starts the first hand. +

+

+
Overrides:
gameDidStart in class TurnGameManagerDelegate
+
+
+
+
+
+
+ +

+gameDidEnd

+
+public void gameDidEnd()
+
+
Description copied from class: GameManagerDelegate
+
Called by the game manager after the game ended. +

+

+
Overrides:
gameDidEnd in class GameManagerDelegate
+
+
+
+
+
+
+ +

+startTurn

+
+public void startTurn()
+
+
Description copied from class: TurnGameManagerDelegate
+
Called to start the next turn. It calls TurnGameManager.turnWillStart() to allow our + owning manager to perform any pre-start turn processing, sets the turn holder that was + configured either when the game started or when finishing up the last turn, and then calls + TurnGameManager.turnDidStart() to allow the manager to perform any post-start turn + processing. This assumes that a valid turn holder has been assigned. If some pre-game + preparation needs to take place in a non-turn-based manner, this function should not be + called until it is time to start the first turn. +

+

+
Overrides:
startTurn in class TurnGameManagerDelegate
+
+
+
+
+
+
+ +

+endTurn

+
+public void endTurn()
+
+
Description copied from class: TurnGameManagerDelegate
+
Called to end the turn. Whatever indication a game manager has that the turn has ended + (probably the submission of a valid move of some sort by the turn holding player), it + should call this function to cause this turn to end and the next to begin. + +

+ If the game is no longer in play (see TurnGameObject.isInPlay()) after having called + TurnGameManager.turnDidEnd() and TurnGameManagerDelegate.setNextTurnHolder(), then the next turn will + not automatically be started. + +

+ If the game is in play, but the next turn should not be started immediately, the game + manager should have TurnGameManagerDelegate.setNextTurnHolder() set the TurnGameManagerDelegate._turnIdx field to + -1 which will cause us to not start the next turn. To start things back up + again it would set TurnGameManagerDelegate._turnIdx to the next turn holder and call TurnGameManagerDelegate.startTurn() + itself. +

+

+
Overrides:
endTurn in class TurnGameManagerDelegate
+
+
+
+
+
+
+ +

+startHand

+
+public void startHand()
+
+
Starts a hand of cards. Calls handWillStart(), sets the trick + state to PLAYING_HAND, and calls handDidStart(). +

+

+
+
+
+
+
+
+
+ +

+endHand

+
+public void endHand()
+
+
Ends the hand of cards. Calls handWillEnd(), sets the trick + state to BETWEEN_HANDS, and calls handDidEnd(). +

+

+
+
+
+
+
+
+
+ +

+startTrick

+
+public void startTrick()
+
+
Starts a trick. Calls trickWillStart(), sets the trick + state to PLAYING_TRICK, and calls trickDidStart(). +

+

+
+
+
+
+
+
+
+ +

+endTrick

+
+public void endTrick()
+
+
Ends the trick. Calls trickWillEnd(), sets the trick + state to PLAYING_HAND, and calls trickDidEnd(). +

+

+
+
+
+
+
+
+
+ +

+sendCardsToPlayer

+
+public void sendCardsToPlayer(com.threerings.presents.data.ClientObject client,
+                              int toidx,
+                              Card[] cards)
+
+
Description copied from interface: TrickCardGameProvider
+
Handles a TrickCardGameService.sendCardsToPlayer(int, com.threerings.parlor.card.data.Card[]) request. +

+

+
Specified by:
sendCardsToPlayer in interface TrickCardGameProvider
+
+
+
+
+
+
+ +

+playCard

+
+public void playCard(com.threerings.presents.data.ClientObject client,
+                     Card card,
+                     int handSize)
+
+
Description copied from interface: TrickCardGameProvider
+
Handles a TrickCardGameService.playCard(com.threerings.parlor.card.data.Card, int) request. +

+

+
Specified by:
playCard in interface TrickCardGameProvider
+
+
+
+
+
+
+ +

+requestRematch

+
+public void requestRematch(com.threerings.presents.data.ClientObject client)
+
+
Description copied from interface: TrickCardGameProvider
+
Handles a TrickCardGameService.requestRematch() request. +

+

+
Specified by:
requestRematch in interface TrickCardGameProvider
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/trick/server/TrickCardGameProvider.html b/apidocs/com/threerings/parlor/card/trick/server/TrickCardGameProvider.html new file mode 100644 index 00000000..d324538d --- /dev/null +++ b/apidocs/com/threerings/parlor/card/trick/server/TrickCardGameProvider.html @@ -0,0 +1,280 @@ + + + + + + + +TrickCardGameProvider (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.card.trick.server +
+Interface TrickCardGameProvider

+
+
All Superinterfaces:
com.threerings.presents.server.InvocationProvider
+
+
+
All Known Implementing Classes:
TrickCardGameManagerDelegate
+
+
+
+
@Generated(value="com.threerings.presents.tools.GenServiceTask",
+           comments="Derived from TrickCardGameService.java.")
+public interface TrickCardGameProvider
extends com.threerings.presents.server.InvocationProvider
+ + +

+Defines the server-side of the TrickCardGameService. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidplayCard(com.threerings.presents.data.ClientObject caller, + Card arg1, + int arg2) + +
+          Handles a TrickCardGameService.playCard(com.threerings.parlor.card.data.Card, int) request.
+ voidrequestRematch(com.threerings.presents.data.ClientObject caller) + +
+          Handles a TrickCardGameService.requestRematch() request.
+ voidsendCardsToPlayer(com.threerings.presents.data.ClientObject caller, + int arg1, + Card[] arg2) + +
+          Handles a TrickCardGameService.sendCardsToPlayer(int, com.threerings.parlor.card.data.Card[]) request.
+  +

+ + + + + + + + +
+Method Detail
+ +

+playCard

+
+void playCard(com.threerings.presents.data.ClientObject caller,
+              Card arg1,
+              int arg2)
+
+
Handles a TrickCardGameService.playCard(com.threerings.parlor.card.data.Card, int) request. +

+

+
+
+
+
+
+
+
+ +

+requestRematch

+
+void requestRematch(com.threerings.presents.data.ClientObject caller)
+
+
Handles a TrickCardGameService.requestRematch() request. +

+

+
+
+
+
+
+
+
+ +

+sendCardsToPlayer

+
+void sendCardsToPlayer(com.threerings.presents.data.ClientObject caller,
+                       int arg1,
+                       Card[] arg2)
+
+
Handles a TrickCardGameService.sendCardsToPlayer(int, com.threerings.parlor.card.data.Card[]) request. +

+

+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/trick/server/class-use/TrickCardGameManagerDelegate.html b/apidocs/com/threerings/parlor/card/trick/server/class-use/TrickCardGameManagerDelegate.html new file mode 100644 index 00000000..88965cd2 --- /dev/null +++ b/apidocs/com/threerings/parlor/card/trick/server/class-use/TrickCardGameManagerDelegate.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.parlor.card.trick.server.TrickCardGameManagerDelegate (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.card.trick.server.TrickCardGameManagerDelegate

+
+No usage of com.threerings.parlor.card.trick.server.TrickCardGameManagerDelegate +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/trick/server/class-use/TrickCardGameProvider.html b/apidocs/com/threerings/parlor/card/trick/server/class-use/TrickCardGameProvider.html new file mode 100644 index 00000000..a58a3fa6 --- /dev/null +++ b/apidocs/com/threerings/parlor/card/trick/server/class-use/TrickCardGameProvider.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Interface com.threerings.parlor.card.trick.server.TrickCardGameProvider (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.parlor.card.trick.server.TrickCardGameProvider

+
+ + + + + + + + + +
+Packages that use TrickCardGameProvider
com.threerings.parlor.card.trick.server  
+  +

+ + + + + +
+Uses of TrickCardGameProvider in com.threerings.parlor.card.trick.server
+  +

+ + + + + + + + + +
Classes in com.threerings.parlor.card.trick.server that implement TrickCardGameProvider
+ classTrickCardGameManagerDelegate + +
+          A card game manager delegate for trick-based card games, such as Spades and Hearts.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/trick/server/package-frame.html b/apidocs/com/threerings/parlor/card/trick/server/package-frame.html new file mode 100644 index 00000000..85ff4efc --- /dev/null +++ b/apidocs/com/threerings/parlor/card/trick/server/package-frame.html @@ -0,0 +1,44 @@ + + + + + + + +com.threerings.parlor.card.trick.server (vilya 1.3 API) + + + + + + + + + + + +com.threerings.parlor.card.trick.server + + + + +
+Interfaces  + +
+TrickCardGameProvider
+ + + + + + +
+Classes  + +
+TrickCardGameManagerDelegate
+ + + + diff --git a/apidocs/com/threerings/parlor/card/trick/server/package-summary.html b/apidocs/com/threerings/parlor/card/trick/server/package-summary.html new file mode 100644 index 00000000..4b9a122d --- /dev/null +++ b/apidocs/com/threerings/parlor/card/trick/server/package-summary.html @@ -0,0 +1,172 @@ + + + + + + + +com.threerings.parlor.card.trick.server (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.parlor.card.trick.server +

+ + + + + + + + + +
+Interface Summary
TrickCardGameProviderDefines the server-side of the TrickCardGameService.
+  + +

+ + + + + + + + + +
+Class Summary
TrickCardGameManagerDelegateA card game manager delegate for trick-based card games, such as Spades and Hearts.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/trick/server/package-tree.html b/apidocs/com/threerings/parlor/card/trick/server/package-tree.html new file mode 100644 index 00000000..c4536747 --- /dev/null +++ b/apidocs/com/threerings/parlor/card/trick/server/package-tree.html @@ -0,0 +1,170 @@ + + + + + + + +com.threerings.parlor.card.trick.server Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.parlor.card.trick.server +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/trick/server/package-use.html b/apidocs/com/threerings/parlor/card/trick/server/package-use.html new file mode 100644 index 00000000..9ec4608b --- /dev/null +++ b/apidocs/com/threerings/parlor/card/trick/server/package-use.html @@ -0,0 +1,171 @@ + + + + + + + +Uses of Package com.threerings.parlor.card.trick.server (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.parlor.card.trick.server

+
+ + + + + + + + + +
+Packages that use com.threerings.parlor.card.trick.server
com.threerings.parlor.card.trick.server  
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.card.trick.server used by com.threerings.parlor.card.trick.server
TrickCardGameProvider + +
+          Defines the server-side of the TrickCardGameService.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/trick/util/TrickCardGameUtil.html b/apidocs/com/threerings/parlor/card/trick/util/TrickCardGameUtil.html new file mode 100644 index 00000000..c6ea3fa6 --- /dev/null +++ b/apidocs/com/threerings/parlor/card/trick/util/TrickCardGameUtil.html @@ -0,0 +1,640 @@ + + + + + + + +TrickCardGameUtil (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.card.trick.util +
+Class TrickCardGameUtil

+
+java.lang.Object
+  extended by com.threerings.parlor.card.trick.util.TrickCardGameUtil
+
+
+
All Implemented Interfaces:
CardCodes, TrickCardCodes, com.threerings.presents.data.InvocationCodes
+
+
+
+
public class TrickCardGameUtil
extends Object
implements TrickCardCodes
+ + +

+Methods of general utility to trick-taking card games. +

+ +

+

+ +

+ + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from interface com.threerings.parlor.card.trick.data.TrickCardCodes
BOTTOM, LEFT, RIGHT, TOP
+  + + + + + + + +
Fields inherited from interface com.threerings.parlor.card.data.CardCodes
ACE, BLACK_JOKER, CLUBS, DIAMONDS, HEARTS, JACK, KING, QUEEN, RED_JOKER, SPADES
+  + + + + + + + +
Fields inherited from interface com.threerings.presents.data.InvocationCodes
ACCESS_DENIED, E_ACCESS_DENIED, E_INTERNAL_ERROR, GLOBAL_GROUP, INTERNAL_ERROR
+  + + + + + + + + + + +
+Constructor Summary
TrickCardGameUtil() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+static booleancanFollowSuit(PlayerCard[] cardsPlayed, + Hand hand) + +
+          Checks whether the player can follow the suit lead with the hand given.
+static booleancontainsCard(PlayerCard[] cards, + Card card) + +
+          Checks whether the specified array contains the given card.
+static intcountSuitMembers(PlayerCard[] cards, + int suit) + +
+          Determines the number of cards that belong to the specified suit within the array given.
+static booleanfollowsSuit(PlayerCard[] cardsPlayed, + Card card) + +
+          Checks whether the proposed card follows the suit lead.
+static PlayerCardgetHighestInLeadSuit(PlayerCard[] cardsPlayed, + int trumpSuit) + +
+          Returns the highest card (according to the standard A,K,...,2 ordering) in the suit lead, + with an optional trump suit.
+static intgetLeftIndex(int pidx) + +
+          For four-player games, returns the index of the player to the left of the specified player.
+static intgetNextInClockwiseSequence(int pidx) + +
+          For four-player games, this returns the index of the player after the specified player + going clockwise around the table.
+static intgetOppositeIndex(int pidx) + +
+          For four-player games, returns the index of the player across from the specified player.
+static intgetOtherTeamIndex(int tidx) + +
+          For four-player games with fixed partnerships, this returns the index of the other team.
+static intgetPartnerIndex(int pidx) + +
+          For four-player games with fixed partnerships, this returns the index of the player's + partner.
+static intgetRelativeLocation(int pidx1, + int pidx2) + +
+          For four-player games with fixed partnerships, this returns the relative location of one + player from the point of view of another.
+static intgetRightIndex(int pidx) + +
+          For four-player games, returns the index of the player to the right of the specified + player.
+static intgetTeamIndex(int pidx) + +
+          For four-player games with fixed partnerships, this returns the index of the player's team.
+static intgetTeamMemberIndex(int tidx, + int midx) + +
+          For four-player games with fixed partnerships, this returns the index of one of the members + of a team.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+TrickCardGameUtil

+
+public TrickCardGameUtil()
+
+
+ + + + + + + + +
+Method Detail
+ +

+getTeamIndex

+
+public static int getTeamIndex(int pidx)
+
+
For four-player games with fixed partnerships, this returns the index of the player's team. +

+

+
+
+
+
Parameters:
pidx - the player index
+
+
+
+ +

+getOtherTeamIndex

+
+public static int getOtherTeamIndex(int tidx)
+
+
For four-player games with fixed partnerships, this returns the index of the other team. +

+

+
+
+
+
Parameters:
tidx - the index of the team
+
+
+
+ +

+getPartnerIndex

+
+public static int getPartnerIndex(int pidx)
+
+
For four-player games with fixed partnerships, this returns the index of the player's + partner. +

+

+
+
+
+
+
+
+
+ +

+getTeamMemberIndex

+
+public static int getTeamMemberIndex(int tidx,
+                                     int midx)
+
+
For four-player games with fixed partnerships, this returns the index of one of the members + of a team. +

+

+
+
+
+
Parameters:
tidx - the index of the team
midx - the index of the player within the team
+
+
+
+ +

+getNextInClockwiseSequence

+
+public static int getNextInClockwiseSequence(int pidx)
+
+
For four-player games, this returns the index of the player after the specified player + going clockwise around the table. +

+

+
+
+
+
+
+
+
+ +

+getRelativeLocation

+
+public static int getRelativeLocation(int pidx1,
+                                      int pidx2)
+
+
For four-player games with fixed partnerships, this returns the relative location of one + player from the point of view of another. +

+

+
+
+
+
Parameters:
pidx1 - the index of the player to whom the location is relative
pidx2 - the index of the player whose location is desired +
Returns:
the relative location (TOP, BOTTOM, LEFT, or RIGHT)
+
+
+
+ +

+getLeftIndex

+
+public static int getLeftIndex(int pidx)
+
+
For four-player games, returns the index of the player to the left of the specified player. +

+

+
+
+
+
+
+
+
+ +

+getRightIndex

+
+public static int getRightIndex(int pidx)
+
+
For four-player games, returns the index of the player to the right of the specified + player. +

+

+
+
+
+
+
+
+
+ +

+getOppositeIndex

+
+public static int getOppositeIndex(int pidx)
+
+
For four-player games, returns the index of the player across from the specified player. +

+

+
+
+
+
+
+
+
+ +

+canFollowSuit

+
+public static boolean canFollowSuit(PlayerCard[] cardsPlayed,
+                                    Hand hand)
+
+
Checks whether the player can follow the suit lead with the hand given. +

+

+
+
+
+
+
+
+
+ +

+containsCard

+
+public static boolean containsCard(PlayerCard[] cards,
+                                   Card card)
+
+
Checks whether the specified array contains the given card. +

+

+
+
+
+
+
+
+
+ +

+countSuitMembers

+
+public static int countSuitMembers(PlayerCard[] cards,
+                                   int suit)
+
+
Determines the number of cards that belong to the specified suit within the array given. +

+

+
+
+
+
+
+
+
+ +

+followsSuit

+
+public static boolean followsSuit(PlayerCard[] cardsPlayed,
+                                  Card card)
+
+
Checks whether the proposed card follows the suit lead. +

+

+
+
+
+
+
+
+
+ +

+getHighestInLeadSuit

+
+public static PlayerCard getHighestInLeadSuit(PlayerCard[] cardsPlayed,
+                                              int trumpSuit)
+
+
Returns the highest card (according to the standard A,K,...,2 ordering) in the suit lead, + with an optional trump suit. +

+

+
+
+
+
Parameters:
trumpSuit - the trump suit, or -1 for none
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/trick/util/class-use/TrickCardGameUtil.html b/apidocs/com/threerings/parlor/card/trick/util/class-use/TrickCardGameUtil.html new file mode 100644 index 00000000..f2b2470e --- /dev/null +++ b/apidocs/com/threerings/parlor/card/trick/util/class-use/TrickCardGameUtil.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.parlor.card.trick.util.TrickCardGameUtil (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.card.trick.util.TrickCardGameUtil

+
+No usage of com.threerings.parlor.card.trick.util.TrickCardGameUtil +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/trick/util/package-frame.html b/apidocs/com/threerings/parlor/card/trick/util/package-frame.html new file mode 100644 index 00000000..9b9234f3 --- /dev/null +++ b/apidocs/com/threerings/parlor/card/trick/util/package-frame.html @@ -0,0 +1,33 @@ + + + + + + + +com.threerings.parlor.card.trick.util (vilya 1.3 API) + + + + + + + + + + + +com.threerings.parlor.card.trick.util + + + + +
+Classes  + +
+TrickCardGameUtil
+ + + + diff --git a/apidocs/com/threerings/parlor/card/trick/util/package-summary.html b/apidocs/com/threerings/parlor/card/trick/util/package-summary.html new file mode 100644 index 00000000..92574225 --- /dev/null +++ b/apidocs/com/threerings/parlor/card/trick/util/package-summary.html @@ -0,0 +1,158 @@ + + + + + + + +com.threerings.parlor.card.trick.util (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.parlor.card.trick.util +

+ + + + + + + + + +
+Class Summary
TrickCardGameUtilMethods of general utility to trick-taking card games.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/trick/util/package-tree.html b/apidocs/com/threerings/parlor/card/trick/util/package-tree.html new file mode 100644 index 00000000..c1742bfc --- /dev/null +++ b/apidocs/com/threerings/parlor/card/trick/util/package-tree.html @@ -0,0 +1,155 @@ + + + + + + + +com.threerings.parlor.card.trick.util Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.parlor.card.trick.util +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/card/trick/util/package-use.html b/apidocs/com/threerings/parlor/card/trick/util/package-use.html new file mode 100644 index 00000000..f8b3d48e --- /dev/null +++ b/apidocs/com/threerings/parlor/card/trick/util/package-use.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Package com.threerings.parlor.card.trick.util (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.parlor.card.trick.util

+
+No usage of com.threerings.parlor.card.trick.util +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/class-use/Log.html b/apidocs/com/threerings/parlor/class-use/Log.html new file mode 100644 index 00000000..c1206f6b --- /dev/null +++ b/apidocs/com/threerings/parlor/class-use/Log.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.parlor.Log (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.Log

+
+No usage of com.threerings.parlor.Log +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/client/DefaultSwingTableConfigurator.html b/apidocs/com/threerings/parlor/client/DefaultSwingTableConfigurator.html new file mode 100644 index 00000000..5af6359f --- /dev/null +++ b/apidocs/com/threerings/parlor/client/DefaultSwingTableConfigurator.html @@ -0,0 +1,330 @@ + + + + + + + +DefaultSwingTableConfigurator (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.client +
+Class DefaultSwingTableConfigurator

+
+java.lang.Object
+  extended by com.threerings.parlor.client.TableConfigurator
+      extended by com.threerings.parlor.client.DefaultSwingTableConfigurator
+
+
+
+
public class DefaultSwingTableConfigurator
extends TableConfigurator
+ + +

+Provides a default implementation of a TableConfigurator for + a Swing interface. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + +
+Constructor Summary
DefaultSwingTableConfigurator(int players) + +
+          Create a TableConfigurator that allows only the specified number + of players and lets the configuring user enable private games + only if the number of players is greater than 2.
DefaultSwingTableConfigurator(int players, + boolean allowPrivate) + +
+          Create a TableConfigurator that allows only the specified number + of players and lets the user configure a private table, or not.
DefaultSwingTableConfigurator(int minPlayers, + int desiredPlayers, + int maxPlayers, + boolean allowPrivate) + +
+          Create a TableConfigurator that allows for the specified configuration + parameters.
+  + + + + + + + + + + + +
+Method Summary
+ booleanisEmpty() + +
+          If true, the TableConfigurator is empty, which doesn't mean that + it will not return a TableConfig object (for it must), but rather + that there are no user-editable options being presented in the + config interface.
+  + + + + + + + +
Methods inherited from class com.threerings.parlor.client.TableConfigurator
getTableConfig, init, setTableConfig
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+DefaultSwingTableConfigurator

+
+public DefaultSwingTableConfigurator(int players)
+
+
Create a TableConfigurator that allows only the specified number + of players and lets the configuring user enable private games + only if the number of players is greater than 2. +

+

+
+ +

+DefaultSwingTableConfigurator

+
+public DefaultSwingTableConfigurator(int players,
+                                     boolean allowPrivate)
+
+
Create a TableConfigurator that allows only the specified number + of players and lets the user configure a private table, or not. +

+

+
+ +

+DefaultSwingTableConfigurator

+
+public DefaultSwingTableConfigurator(int minPlayers,
+                                     int desiredPlayers,
+                                     int maxPlayers,
+                                     boolean allowPrivate)
+
+
Create a TableConfigurator that allows for the specified configuration + parameters. +

+

+ + + + + + + + +
+Method Detail
+ +

+isEmpty

+
+public boolean isEmpty()
+
+
Description copied from class: TableConfigurator
+
If true, the TableConfigurator is empty, which doesn't mean that + it will not return a TableConfig object (for it must), but rather + that there are no user-editable options being presented in the + config interface. +

+

+
Specified by:
isEmpty in class TableConfigurator
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/client/GameReadyObserver.html b/apidocs/com/threerings/parlor/client/GameReadyObserver.html new file mode 100644 index 00000000..97b930a7 --- /dev/null +++ b/apidocs/com/threerings/parlor/client/GameReadyObserver.html @@ -0,0 +1,220 @@ + + + + + + + +GameReadyObserver (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.client +
+Interface GameReadyObserver

+
+
+
public interface GameReadyObserver
+ + +

+Used to inform interested parties when the ParlorDirector + receives a game ready notification. The observers can ratify the + decision to head directly into the game or can take responsibility + themselves for doing so. +

+ +

+

+ +

+ + + + + + + + + + + + +
+Method Summary
+ booleanreceivedGameReady(int gameOid) + +
+          Called when a game ready notification is received.
+  +

+ + + + + + + + +
+Method Detail
+ +

+receivedGameReady

+
+boolean receivedGameReady(int gameOid)
+
+
Called when a game ready notification is received. +

+

+
Parameters:
gameOid - the place oid of the ready game. +
Returns:
if the observer returns true from this method, the parlor + director assumes they will take care of entering the game room + after performing processing of their own. If all observers return + false, the director will enter the game room automatically.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/client/Invitation.html b/apidocs/com/threerings/parlor/client/Invitation.html new file mode 100644 index 00000000..bc9d844f --- /dev/null +++ b/apidocs/com/threerings/parlor/client/Invitation.html @@ -0,0 +1,523 @@ + + + + + + + +Invitation (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.client +
+Class Invitation

+
+java.lang.Object
+  extended by com.threerings.parlor.client.Invitation
+
+
+
All Implemented Interfaces:
ParlorService.InviteListener, ParlorCodes, com.threerings.presents.client.InvocationService.InvocationListener, com.threerings.presents.data.InvocationCodes
+
+
+
+
public class Invitation
extends Object
implements ParlorCodes, ParlorService.InviteListener
+ + +

+The invitation class is used to track information related to + outstanding invitations generated by or targeted to this client. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + +
+Field Summary
+ GameConfigconfig + +
+          The configuration of the game to be created.
+ intinviteId + +
+          The unique id for this invitation (as assigned by the + server).
+ com.threerings.util.Nameopponent + +
+          The name of the other user involved in this invitation.
+  + + + + + + + +
Fields inherited from interface com.threerings.parlor.data.ParlorCodes
ALREADY_AT_TABLE, BANNED_FROM_TABLE, GAME_ALREADY_STARTED, INVALID_TABLE_POSITION, INVITATION_ACCEPTED, INVITATION_COUNTERED, INVITATION_REFUSED, INVITEE_NOT_ONLINE, MUST_BE_CREATOR, NO_SELF_BOOT, NO_SUCH_TABLE, NOT_AT_TABLE, PARLOR_GROUP, TABLE_POSITION_OCCUPIED
+  + + + + + + + +
Fields inherited from interface com.threerings.presents.data.InvocationCodes
ACCESS_DENIED, E_ACCESS_DENIED, E_INTERNAL_ERROR, GLOBAL_GROUP, INTERNAL_ERROR
+  + + + + + + + + + + +
+Constructor Summary
Invitation(ParlorContext ctx, + ParlorService pservice, + com.threerings.util.Name opponent, + GameConfig config, + InvitationResponseObserver observer) + +
+          Constructs a new invitation record.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidaccept() + +
+          Accepts this invitation.
+ voidcancel() + +
+          Cancels this invitation.
+ voidcounter(GameConfig config, + InvitationResponseObserver observer) + +
+          Counters this invitation with an invitation with different game + configuration parameters.
+ voidinviteReceived(int inviteId) + +
+          Called in response to a successful ParlorService.invite(com.threerings.util.Name, com.threerings.parlor.game.data.GameConfig, com.threerings.parlor.client.ParlorService.InviteListener) request.
+ voidrefuse(String message) + +
+          Refuses this invitation.
+ voidrequestFailed(String reason) + +
+           
+ StringtoString() + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+inviteId

+
+public int inviteId
+
+
The unique id for this invitation (as assigned by the + server). This is -1 until we receive an acknowledgement from + the server that our invitation was delivered. +

+

+
+
+
+ +

+opponent

+
+public com.threerings.util.Name opponent
+
+
The name of the other user involved in this invitation. +

+

+
+
+
+ +

+config

+
+public GameConfig config
+
+
The configuration of the game to be created. +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+Invitation

+
+public Invitation(ParlorContext ctx,
+                  ParlorService pservice,
+                  com.threerings.util.Name opponent,
+                  GameConfig config,
+                  InvitationResponseObserver observer)
+
+
Constructs a new invitation record. +

+

+ + + + + + + + +
+Method Detail
+ +

+accept

+
+public void accept()
+
+
Accepts this invitation. +

+

+
+
+
+
+
+
+
+ +

+refuse

+
+public void refuse(String message)
+
+
Refuses this invitation. +

+

+
+
+
+
Parameters:
message - the message to deliver to the inviting user + explaining the reason for the refusal or null if no message is to + be provided.
+
+
+
+ +

+cancel

+
+public void cancel()
+
+
Cancels this invitation. +

+

+
+
+
+
+
+
+
+ +

+counter

+
+public void counter(GameConfig config,
+                    InvitationResponseObserver observer)
+
+
Counters this invitation with an invitation with different game + configuration parameters. +

+

+
+
+
+
Parameters:
config - the updated game configuration.
observer - the entity that will be notified if this + counter-invitation is accepted, refused or countered.
+
+
+
+ +

+inviteReceived

+
+public void inviteReceived(int inviteId)
+
+
Description copied from interface: ParlorService.InviteListener
+
Called in response to a successful ParlorService.invite(com.threerings.util.Name, com.threerings.parlor.game.data.GameConfig, com.threerings.parlor.client.ParlorService.InviteListener) request. +

+

+
Specified by:
inviteReceived in interface ParlorService.InviteListener
+
+
+
+
+
+
+ +

+requestFailed

+
+public void requestFailed(String reason)
+
+
+
Specified by:
requestFailed in interface com.threerings.presents.client.InvocationService.InvocationListener
+
+
+
+
+
+
+ +

+toString

+
+public String toString()
+
+
+
Overrides:
toString in class Object
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/client/InvitationHandler.html b/apidocs/com/threerings/parlor/client/InvitationHandler.html new file mode 100644 index 00000000..cd289633 --- /dev/null +++ b/apidocs/com/threerings/parlor/client/InvitationHandler.html @@ -0,0 +1,240 @@ + + + + + + + +InvitationHandler (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.client +
+Interface InvitationHandler

+
+
All Known Implementing Classes:
LobbyController
+
+
+
+
public interface InvitationHandler
+ + +

+A client entity that wishes to handle invitations received by other + clients should implement this interface and register itself with the + parlor director. It will subsequently be notified of any incoming + invitations. It is also responsible for handling cancelled invitations. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + +
+Method Summary
+ voidinvitationCancelled(Invitation invite) + +
+          Called when an invitation is cancelled by the inviting player.
+ voidinvitationReceived(Invitation invite) + +
+          Called when an invitation is received from another player.
+  +

+ + + + + + + + +
+Method Detail
+ +

+invitationReceived

+
+void invitationReceived(Invitation invite)
+
+
Called when an invitation is received from another player. +

+

+
Parameters:
invite - the received invitation.
+
+
+
+ +

+invitationCancelled

+
+void invitationCancelled(Invitation invite)
+
+
Called when an invitation is cancelled by the inviting player. +

+

+
Parameters:
invite - the cancelled invitation.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/client/InvitationResponseObserver.html b/apidocs/com/threerings/parlor/client/InvitationResponseObserver.html new file mode 100644 index 00000000..c77cce6a --- /dev/null +++ b/apidocs/com/threerings/parlor/client/InvitationResponseObserver.html @@ -0,0 +1,271 @@ + + + + + + + +InvitationResponseObserver (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.client +
+Interface InvitationResponseObserver

+
+
All Known Implementing Classes:
LobbyController
+
+
+
+
public interface InvitationResponseObserver
+ + +

+A client entity that wishes to generate invitations for games must + implement this interface. An invitation can be accepted, refused or + countered. A countered invitation is one where the game configuration + is adjusted by the invited player and proposed back to the inviting + player. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidinvitationAccepted(Invitation invite) + +
+          Called if the invitation was accepted.
+ voidinvitationCountered(Invitation invite, + GameConfig config) + +
+          Called if the invitation was countered with an alternate game + configuration.
+ voidinvitationRefused(Invitation invite, + String message) + +
+          Called if the invitation was refused.
+  +

+ + + + + + + + +
+Method Detail
+ +

+invitationAccepted

+
+void invitationAccepted(Invitation invite)
+
+
Called if the invitation was accepted. +

+

+
Parameters:
invite - the invitation for which we received a response.
+
+
+
+ +

+invitationRefused

+
+void invitationRefused(Invitation invite,
+                       String message)
+
+
Called if the invitation was refused. +

+

+
Parameters:
invite - the invitation for which we received a response.
message - a message provided by the invited user explaining + the reason for their refusal, or the empty string if no message was + provided.
+
+
+
+ +

+invitationCountered

+
+void invitationCountered(Invitation invite,
+                         GameConfig config)
+
+
Called if the invitation was countered with an alternate game + configuration. +

+

+
Parameters:
invite - the invitation for which we received a response.
config - the game configuration proposed by the invited + player.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/client/ParlorDecoder.html b/apidocs/com/threerings/parlor/client/ParlorDecoder.html new file mode 100644 index 00000000..e64329d2 --- /dev/null +++ b/apidocs/com/threerings/parlor/client/ParlorDecoder.html @@ -0,0 +1,424 @@ + + + + + + + +ParlorDecoder (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.client +
+Class ParlorDecoder

+
+java.lang.Object
+  extended by com.threerings.presents.client.InvocationDecoder
+      extended by com.threerings.parlor.client.ParlorDecoder
+
+
+
+
public class ParlorDecoder
extends com.threerings.presents.client.InvocationDecoder
+ + +

+Dispatches calls to a ParlorReceiver instance. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static intGAME_IS_READY + +
+          The method id used to dispatch ParlorReceiver.gameIsReady(int) + notifications.
+static intRECEIVED_INVITE + +
+          The method id used to dispatch ParlorReceiver.receivedInvite(int, com.threerings.util.Name, com.threerings.parlor.game.data.GameConfig) + notifications.
+static intRECEIVED_INVITE_CANCELLATION + +
+          The method id used to dispatch ParlorReceiver.receivedInviteCancellation(int) + notifications.
+static intRECEIVED_INVITE_RESPONSE + +
+          The method id used to dispatch ParlorReceiver.receivedInviteResponse(int, int, java.lang.Object) + notifications.
+static StringRECEIVER_CODE + +
+          The generated hash code used to identify this receiver class.
+  + + + + + + + +
Fields inherited from class com.threerings.presents.client.InvocationDecoder
receiver
+  + + + + + + + + + + +
+Constructor Summary
ParlorDecoder(ParlorReceiver receiver) + +
+          Creates a decoder that may be registered to dispatch invocation + service notifications to the specified receiver.
+  + + + + + + + + + + + + + + + +
+Method Summary
+ voiddispatchNotification(int methodId, + Object[] args) + +
+           
+ StringgetReceiverCode() + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+RECEIVER_CODE

+
+public static final String RECEIVER_CODE
+
+
The generated hash code used to identify this receiver class. +

+

+
See Also:
Constant Field Values
+
+
+ +

+GAME_IS_READY

+
+public static final int GAME_IS_READY
+
+
The method id used to dispatch ParlorReceiver.gameIsReady(int) + notifications. +

+

+
See Also:
Constant Field Values
+
+
+ +

+RECEIVED_INVITE

+
+public static final int RECEIVED_INVITE
+
+
The method id used to dispatch ParlorReceiver.receivedInvite(int, com.threerings.util.Name, com.threerings.parlor.game.data.GameConfig) + notifications. +

+

+
See Also:
Constant Field Values
+
+
+ +

+RECEIVED_INVITE_CANCELLATION

+
+public static final int RECEIVED_INVITE_CANCELLATION
+
+
The method id used to dispatch ParlorReceiver.receivedInviteCancellation(int) + notifications. +

+

+
See Also:
Constant Field Values
+
+
+ +

+RECEIVED_INVITE_RESPONSE

+
+public static final int RECEIVED_INVITE_RESPONSE
+
+
The method id used to dispatch ParlorReceiver.receivedInviteResponse(int, int, java.lang.Object) + notifications. +

+

+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Constructor Detail
+ +

+ParlorDecoder

+
+public ParlorDecoder(ParlorReceiver receiver)
+
+
Creates a decoder that may be registered to dispatch invocation + service notifications to the specified receiver. +

+

+ + + + + + + + +
+Method Detail
+ +

+getReceiverCode

+
+public String getReceiverCode()
+
+
+
Specified by:
getReceiverCode in class com.threerings.presents.client.InvocationDecoder
+
+
+
+
+
+
+ +

+dispatchNotification

+
+public void dispatchNotification(int methodId,
+                                 Object[] args)
+
+
+
Overrides:
dispatchNotification in class com.threerings.presents.client.InvocationDecoder
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/client/ParlorDirector.html b/apidocs/com/threerings/parlor/client/ParlorDirector.html new file mode 100644 index 00000000..e3ac8c37 --- /dev/null +++ b/apidocs/com/threerings/parlor/client/ParlorDirector.html @@ -0,0 +1,588 @@ + + + + + + + +ParlorDirector (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.client +
+Class ParlorDirector

+
+java.lang.Object
+  extended by com.threerings.presents.client.BasicDirector
+      extended by com.threerings.parlor.client.ParlorDirector
+
+
+
All Implemented Interfaces:
ParlorReceiver, ParlorCodes, com.threerings.presents.client.InvocationReceiver, com.threerings.presents.client.SessionObserver, com.threerings.presents.data.InvocationCodes
+
+
+
+
public class ParlorDirector
extends com.threerings.presents.client.BasicDirector
implements ParlorCodes, ParlorReceiver
+ + +

+The parlor director manages the client side of the game configuration and matchmaking + processes. It is also the entity that is listening for game start notifications which it then + dispatches the client entity that will actually create and display the user interface for the + game that started. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.presents.client.InvocationReceiver
com.threerings.presents.client.InvocationReceiver.Registration
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from interface com.threerings.parlor.data.ParlorCodes
ALREADY_AT_TABLE, BANNED_FROM_TABLE, GAME_ALREADY_STARTED, INVALID_TABLE_POSITION, INVITATION_ACCEPTED, INVITATION_COUNTERED, INVITATION_REFUSED, INVITEE_NOT_ONLINE, MUST_BE_CREATOR, NO_SELF_BOOT, NO_SUCH_TABLE, NOT_AT_TABLE, PARLOR_GROUP, TABLE_POSITION_OCCUPIED
+  + + + + + + + +
Fields inherited from interface com.threerings.presents.data.InvocationCodes
ACCESS_DENIED, E_ACCESS_DENIED, E_INTERNAL_ERROR, GLOBAL_GROUP, INTERNAL_ERROR
+  + + + + + + + + + + +
+Constructor Summary
ParlorDirector(ParlorContext ctx) + +
+          Constructs a parlor director and provides it with the parlor context that it can use to + access the client services that it needs to provide its own services.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidaddGameReadyObserver(GameReadyObserver observer) + +
+          Adds the specified observer to the list of entities that are notified when we receive a game + ready notification.
+ voidclientDidLogoff(com.threerings.presents.client.Client client) + +
+           
+ voidgameIsReady(int gameOid) + +
+          Dispatched to the client when a game in which they are a + participant is ready for play.
+ Invitationinvite(com.threerings.util.Name invitee, + GameConfig config, + InvitationResponseObserver observer) + +
+          Requests that the named user be invited to a game described by the supplied game config.
+ voidreceivedInvite(int remoteId, + com.threerings.util.Name inviter, + GameConfig config) + +
+          Called by the invocation services when another user has invited us + to play a game.
+ voidreceivedInviteCancellation(int remoteId) + +
+          Called by the invocation services when an outstanding invitation + has been cancelled by the inviting user.
+ voidreceivedInviteResponse(int remoteId, + int code, + Object arg) + +
+          Called by the invocation services when another user has responded + to our invitation by either accepting, refusing or countering it.
+ voidremoveGameReadyObserver(GameReadyObserver observer) + +
+          Removes the specified observer from the list of entities that are notified when we receive a + game ready notification.
+ voidsetInvitationHandler(InvitationHandler handler) + +
+          Sets the invitation handler, which is the entity that will be notified when we receive + incoming invitation notifications and when invitations have been cancelled.
+ voidstartSolitaire(GameConfig config, + com.threerings.presents.client.InvocationService.ConfirmListener listener) + +
+          Requests that the specified single player game be started.
+  + + + + + + + +
Methods inherited from class com.threerings.presents.client.BasicDirector
clientDidLogon, clientObjectDidChange, clientWillLogon, isAvailableInStandalone, setAvailableInStandalone
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+ParlorDirector

+
+public ParlorDirector(ParlorContext ctx)
+
+
Constructs a parlor director and provides it with the parlor context that it can use to + access the client services that it needs to provide its own services. Only one parlor + director should be active in the client at one time and it should be made available via the + parlor context. +

+

+
Parameters:
ctx - the parlor context in use by the client.
+
+ + + + + + + + +
+Method Detail
+ +

+setInvitationHandler

+
+public void setInvitationHandler(InvitationHandler handler)
+
+
Sets the invitation handler, which is the entity that will be notified when we receive + incoming invitation notifications and when invitations have been cancelled. +

+

+
+
+
+
Parameters:
handler - our new invitation handler.
+
+
+
+ +

+addGameReadyObserver

+
+public void addGameReadyObserver(GameReadyObserver observer)
+
+
Adds the specified observer to the list of entities that are notified when we receive a game + ready notification. +

+

+
+
+
+
+
+
+
+ +

+removeGameReadyObserver

+
+public void removeGameReadyObserver(GameReadyObserver observer)
+
+
Removes the specified observer from the list of entities that are notified when we receive a + game ready notification. +

+

+
+
+
+
+
+
+
+ +

+invite

+
+public Invitation invite(com.threerings.util.Name invitee,
+                         GameConfig config,
+                         InvitationResponseObserver observer)
+
+
Requests that the named user be invited to a game described by the supplied game config. +

+

+
+
+
+
Parameters:
invitee - the user to invite.
config - the configuration of the game to which the user is being invited.
observer - the entity that will be notified if this invitation is accepted, refused or + countered. +
Returns:
an invitation object that can be used to manage the outstanding invitation.
+
+
+
+ +

+startSolitaire

+
+public void startSolitaire(GameConfig config,
+                           com.threerings.presents.client.InvocationService.ConfirmListener listener)
+
+
Requests that the specified single player game be started. +

+

+
+
+
+
Parameters:
config - the configuration of the single player game to be started.
listener - a listener to be informed of failure if the game cannot be started.
+
+
+
+ +

+clientDidLogoff

+
+public void clientDidLogoff(com.threerings.presents.client.Client client)
+
+
+
Specified by:
clientDidLogoff in interface com.threerings.presents.client.SessionObserver
Overrides:
clientDidLogoff in class com.threerings.presents.client.BasicDirector
+
+
+
+
+
+
+ +

+gameIsReady

+
+public void gameIsReady(int gameOid)
+
+
Description copied from interface: ParlorReceiver
+
Dispatched to the client when a game in which they are a + participant is ready for play. The client will then enter the game + room which will trigger the loading of the appropriate game UI code + and generally get things started. +

+

+
Specified by:
gameIsReady in interface ParlorReceiver
+
+
+
Parameters:
gameOid - the object id of the game object.
+
+
+
+ +

+receivedInvite

+
+public void receivedInvite(int remoteId,
+                           com.threerings.util.Name inviter,
+                           GameConfig config)
+
+
Description copied from interface: ParlorReceiver
+
Called by the invocation services when another user has invited us + to play a game. +

+

+
Specified by:
receivedInvite in interface ParlorReceiver
+
+
+
Parameters:
remoteId - the unique indentifier for this invitation (used + when countering or responding).
inviter - the username of the inviting user.
config - the configuration information for the game to which + we've been invited.
+
+
+
+ +

+receivedInviteResponse

+
+public void receivedInviteResponse(int remoteId,
+                                   int code,
+                                   Object arg)
+
+
Description copied from interface: ParlorReceiver
+
Called by the invocation services when another user has responded + to our invitation by either accepting, refusing or countering it. +

+

+
Specified by:
receivedInviteResponse in interface ParlorReceiver
+
+
+
Parameters:
remoteId - the indentifier for the invitation on question.
code - the response code, either ParlorCodes.INVITATION_ACCEPTED or ParlorCodes.INVITATION_REFUSED or ParlorCodes.INVITATION_COUNTERED.
arg - in the case of a refused invitation, a string + containing a message provided by the invited user explaining the + reason for refusal (the empty string if no explanation was + provided). In the case of a countered invitation, a new game config + object with the modified game configuration.
+
+
+
+ +

+receivedInviteCancellation

+
+public void receivedInviteCancellation(int remoteId)
+
+
Description copied from interface: ParlorReceiver
+
Called by the invocation services when an outstanding invitation + has been cancelled by the inviting user. +

+

+
Specified by:
receivedInviteCancellation in interface ParlorReceiver
+
+
+
Parameters:
remoteId - the indentifier of the cancelled invitation.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/client/ParlorReceiver.html b/apidocs/com/threerings/parlor/client/ParlorReceiver.html new file mode 100644 index 00000000..6ff61578 --- /dev/null +++ b/apidocs/com/threerings/parlor/client/ParlorReceiver.html @@ -0,0 +1,339 @@ + + + + + + + +ParlorReceiver (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.client +
+Interface ParlorReceiver

+
+
All Superinterfaces:
com.threerings.presents.client.InvocationReceiver
+
+
+
All Known Implementing Classes:
ParlorDirector
+
+
+
+
public interface ParlorReceiver
extends com.threerings.presents.client.InvocationReceiver
+ + +

+Defines, for the parlor services, a set of notifications delivered + asynchronously by the server to the client. These are handled by the + ParlorDirector. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.presents.client.InvocationReceiver
com.threerings.presents.client.InvocationReceiver.Registration
+  + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidgameIsReady(int gameOid) + +
+          Dispatched to the client when a game in which they are a + participant is ready for play.
+ voidreceivedInvite(int remoteId, + com.threerings.util.Name inviter, + GameConfig config) + +
+          Called by the invocation services when another user has invited us + to play a game.
+ voidreceivedInviteCancellation(int remoteId) + +
+          Called by the invocation services when an outstanding invitation + has been cancelled by the inviting user.
+ voidreceivedInviteResponse(int remoteId, + int code, + Object arg) + +
+          Called by the invocation services when another user has responded + to our invitation by either accepting, refusing or countering it.
+  +

+ + + + + + + + +
+Method Detail
+ +

+gameIsReady

+
+void gameIsReady(int gameOid)
+
+
Dispatched to the client when a game in which they are a + participant is ready for play. The client will then enter the game + room which will trigger the loading of the appropriate game UI code + and generally get things started. +

+

+
+
+
+
Parameters:
gameOid - the object id of the game object.
+
+
+
+ +

+receivedInvite

+
+void receivedInvite(int remoteId,
+                    com.threerings.util.Name inviter,
+                    GameConfig config)
+
+
Called by the invocation services when another user has invited us + to play a game. +

+

+
+
+
+
Parameters:
remoteId - the unique indentifier for this invitation (used + when countering or responding).
inviter - the username of the inviting user.
config - the configuration information for the game to which + we've been invited.
+
+
+
+ +

+receivedInviteResponse

+
+void receivedInviteResponse(int remoteId,
+                            int code,
+                            Object arg)
+
+
Called by the invocation services when another user has responded + to our invitation by either accepting, refusing or countering it. +

+

+
+
+
+
Parameters:
remoteId - the indentifier for the invitation on question.
code - the response code, either ParlorCodes.INVITATION_ACCEPTED or ParlorCodes.INVITATION_REFUSED or ParlorCodes.INVITATION_COUNTERED.
arg - in the case of a refused invitation, a string + containing a message provided by the invited user explaining the + reason for refusal (the empty string if no explanation was + provided). In the case of a countered invitation, a new game config + object with the modified game configuration.
+
+
+
+ +

+receivedInviteCancellation

+
+void receivedInviteCancellation(int remoteId)
+
+
Called by the invocation services when an outstanding invitation + has been cancelled by the inviting user. +

+

+
+
+
+
Parameters:
remoteId - the indentifier of the cancelled invitation.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/client/ParlorService.InviteListener.html b/apidocs/com/threerings/parlor/client/ParlorService.InviteListener.html new file mode 100644 index 00000000..d23dc78b --- /dev/null +++ b/apidocs/com/threerings/parlor/client/ParlorService.InviteListener.html @@ -0,0 +1,234 @@ + + + + + + + +ParlorService.InviteListener (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.client +
+Interface ParlorService.InviteListener

+
+
All Superinterfaces:
com.threerings.presents.client.InvocationService.InvocationListener
+
+
+
All Known Implementing Classes:
Invitation, ParlorMarshaller.InviteMarshaller
+
+
+
Enclosing interface:
ParlorService
+
+
+
+
public static interface ParlorService.InviteListener
extends com.threerings.presents.client.InvocationService.InvocationListener
+ + +

+Used to communicate responses to ParlorService.invite(com.threerings.util.Name, com.threerings.parlor.game.data.GameConfig, com.threerings.parlor.client.ParlorService.InviteListener) requests. +

+ +

+

+ +

+ + + + + + + + + + + + +
+Method Summary
+ voidinviteReceived(int inviteId) + +
+          Called in response to a successful ParlorService.invite(com.threerings.util.Name, com.threerings.parlor.game.data.GameConfig, com.threerings.parlor.client.ParlorService.InviteListener) request.
+  + + + + + + + +
Methods inherited from interface com.threerings.presents.client.InvocationService.InvocationListener
requestFailed
+  +

+ + + + + + + + +
+Method Detail
+ +

+inviteReceived

+
+void inviteReceived(int inviteId)
+
+
Called in response to a successful ParlorService.invite(com.threerings.util.Name, com.threerings.parlor.game.data.GameConfig, com.threerings.parlor.client.ParlorService.InviteListener) request. +

+

+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/client/ParlorService.html b/apidocs/com/threerings/parlor/client/ParlorService.html new file mode 100644 index 00000000..14b59045 --- /dev/null +++ b/apidocs/com/threerings/parlor/client/ParlorService.html @@ -0,0 +1,347 @@ + + + + + + + +ParlorService (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.client +
+Interface ParlorService

+
+
All Superinterfaces:
com.threerings.presents.client.InvocationService
+
+
+
All Known Implementing Classes:
ParlorMarshaller
+
+
+
+
public interface ParlorService
extends com.threerings.presents.client.InvocationService
+ + +

+Provides an interface to the various parlor invocation services. Presently these services are + limited to the various matchmaking mechanisms. It is unlikely that client code will want to make + direct use of this class, instead they would make use of the programmatic interface provided by + the ParlorDirector. +

+ +

+

+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static interfaceParlorService.InviteListener + +
+          Used to communicate responses to invite(com.threerings.util.Name, com.threerings.parlor.game.data.GameConfig, com.threerings.parlor.client.ParlorService.InviteListener) requests.
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.presents.client.InvocationService
com.threerings.presents.client.InvocationService.ConfirmListener, com.threerings.presents.client.InvocationService.InvocationListener, com.threerings.presents.client.InvocationService.ResultListener
+  + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidcancel(int inviteId, + com.threerings.presents.client.InvocationService.InvocationListener listener) + +
+          You probably don't want to call this directly, but want to call Invitation.cancel().
+ voidinvite(com.threerings.util.Name invitee, + GameConfig config, + ParlorService.InviteListener listener) + +
+          You probably don't want to call this directly, but want to generate your invitation request + via ParlorDirector.invite(com.threerings.util.Name, com.threerings.parlor.game.data.GameConfig, com.threerings.parlor.client.InvitationResponseObserver).
+ voidrespond(int inviteId, + int code, + Object arg, + com.threerings.presents.client.InvocationService.InvocationListener listener) + +
+          You probably don't want to call this directly, but want to call one of Invitation.accept(), Invitation.refuse(java.lang.String), or Invitation.counter(com.threerings.parlor.game.data.GameConfig, com.threerings.parlor.client.InvitationResponseObserver).
+ voidstartSolitaire(GameConfig config, + com.threerings.presents.client.InvocationService.ConfirmListener listener) + +
+          Requests to start a single player game with the specified game configuration.
+  +

+ + + + + + + + +
+Method Detail
+ +

+invite

+
+void invite(com.threerings.util.Name invitee,
+            GameConfig config,
+            ParlorService.InviteListener listener)
+
+
You probably don't want to call this directly, but want to generate your invitation request + via ParlorDirector.invite(com.threerings.util.Name, com.threerings.parlor.game.data.GameConfig, com.threerings.parlor.client.InvitationResponseObserver). Requests that an invitation be delivered to the named + user, requesting that they join the inviting user in a game, the details of which are + specified in the supplied game config object. +

+

+
+
+
+
Parameters:
invitee - the username of the user to be invited.
config - a game config object detailing the type and configuration of the game to be + created.
listener - will receive and process the response.
+
+
+
+ +

+respond

+
+void respond(int inviteId,
+             int code,
+             Object arg,
+             com.threerings.presents.client.InvocationService.InvocationListener listener)
+
+
You probably don't want to call this directly, but want to call one of Invitation.accept(), Invitation.refuse(java.lang.String), or Invitation.counter(com.threerings.parlor.game.data.GameConfig, com.threerings.parlor.client.InvitationResponseObserver). Requests that + an invitation response be delivered with the specified parameters. +

+

+
+
+
+
Parameters:
inviteId - the unique id previously assigned by the server to this invitation.
code - the response code to use in responding to the invitation.
arg - the argument associated with the response (a string message from the player + explaining why the response was refused in the case of an invitation refusal or an updated + game configuration object in the case of a counter-invitation, or null in the case of an + accepted invitation).
listener - will receive and process the response.
+
+
+
+ +

+cancel

+
+void cancel(int inviteId,
+            com.threerings.presents.client.InvocationService.InvocationListener listener)
+
+
You probably don't want to call this directly, but want to call Invitation.cancel(). Requests that an outstanding invitation be cancelled. +

+

+
+
+
+
Parameters:
inviteId - the unique id previously assigned by the server to this invitation.
listener - will receive and process the response.
+
+
+
+ +

+startSolitaire

+
+void startSolitaire(GameConfig config,
+                    com.threerings.presents.client.InvocationService.ConfirmListener listener)
+
+
Requests to start a single player game with the specified game configuration. +

+

+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/client/SeatednessObserver.html b/apidocs/com/threerings/parlor/client/SeatednessObserver.html new file mode 100644 index 00000000..bc9bd286 --- /dev/null +++ b/apidocs/com/threerings/parlor/client/SeatednessObserver.html @@ -0,0 +1,219 @@ + + + + + + + +SeatednessObserver (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.client +
+Interface SeatednessObserver

+
+
All Known Implementing Classes:
TableItem, TableListView
+
+
+
+
public interface SeatednessObserver
+ + +

+Entites that wish to hear about when we sit down at a table or stand up + from a table can implement this interface and register themselves with + the TableDirector. +

+ +

+

+ +

+ + + + + + + + + + + + +
+Method Summary
+ voidseatednessDidChange(boolean isSeated) + +
+          Called when this client sits down at or stands up from a table.
+  +

+ + + + + + + + +
+Method Detail
+ +

+seatednessDidChange

+
+void seatednessDidChange(boolean isSeated)
+
+
Called when this client sits down at or stands up from a table. +

+

+
Parameters:
isSeated - true if the client is now seated at a table, false + if they are now no longer seated at a table.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/client/TableConfigurator.html b/apidocs/com/threerings/parlor/client/TableConfigurator.html new file mode 100644 index 00000000..4e8ae821 --- /dev/null +++ b/apidocs/com/threerings/parlor/client/TableConfigurator.html @@ -0,0 +1,344 @@ + + + + + + + +TableConfigurator (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.client +
+Class TableConfigurator

+
+java.lang.Object
+  extended by com.threerings.parlor.client.TableConfigurator
+
+
+
Direct Known Subclasses:
DefaultSwingTableConfigurator
+
+
+
+
public abstract class TableConfigurator
extends Object
+ + +

+This should be implemented some user-interface element that allows + the user to configure whichever TableConfig options are relevant. +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
TableConfigurator() + +
+          Create a TableConfigurator.
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ TableConfiggetTableConfig() + +
+          Return the fully configured table config according to the currently + configured user interface elements.
+ voidinit(ParlorContext ctx, + GameConfigurator gameConfigurator) + +
+          Initialize the TableConfigurator.
+abstract  booleanisEmpty() + +
+          If true, the TableConfigurator is empty, which doesn't mean that + it will not return a TableConfig object (for it must), but rather + that there are no user-editable options being presented in the + config interface.
+ voidsetTableConfig(TableConfig config) + +
+          Optionally, you can set a pre-configured TableConfig + that will be used to initialize the display parameters (if possible).
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+TableConfigurator

+
+public TableConfigurator()
+
+
Create a TableConfigurator. +

+

+ + + + + + + + +
+Method Detail
+ +

+setTableConfig

+
+public void setTableConfig(TableConfig config)
+
+
Optionally, you can set a pre-configured TableConfig + that will be used to initialize the display parameters (if possible). + This should be called prior to init(). +

+

+
+
+
+
+ +

+init

+
+public void init(ParlorContext ctx,
+                 GameConfigurator gameConfigurator)
+
+
Initialize the TableConfigurator. + + At the time this is called, the GameConfigurator should have + already been initialized. +

+

+
+
+
+
+ +

+isEmpty

+
+public abstract boolean isEmpty()
+
+
If true, the TableConfigurator is empty, which doesn't mean that + it will not return a TableConfig object (for it must), but rather + that there are no user-editable options being presented in the + config interface. +

+

+
+
+
+
+ +

+getTableConfig

+
+public TableConfig getTableConfig()
+
+
Return the fully configured table config according to the currently + configured user interface elements. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/client/TableDirector.html b/apidocs/com/threerings/parlor/client/TableDirector.html new file mode 100644 index 00000000..9f1e1886 --- /dev/null +++ b/apidocs/com/threerings/parlor/client/TableDirector.html @@ -0,0 +1,689 @@ + + + + + + + +TableDirector (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.client +
+Class TableDirector

+
+java.lang.Object
+  extended by com.threerings.presents.client.BasicDirector
+      extended by com.threerings.parlor.client.TableDirector
+
+
+
All Implemented Interfaces:
com.threerings.presents.client.InvocationService.InvocationListener, com.threerings.presents.client.InvocationService.ResultListener, com.threerings.presents.client.SessionObserver, com.threerings.presents.dobj.ChangeListener, com.threerings.presents.dobj.SetListener<Table>
+
+
+
+
public class TableDirector
extends com.threerings.presents.client.BasicDirector
implements com.threerings.presents.dobj.SetListener<Table>, com.threerings.presents.client.InvocationService.ResultListener
+ + +

+As tables are created and managed within the scope of a place (a lobby), we want to fold the + table management functionality into the standard hierarchy of place controllers that deal with + place-related functionality on the client. Thus, instead of forcing places that expect to have + tables to extend a TableLobbyController or something similar, we instead provide + the table director which can be instantiated by the place controller (or specific table related + views) to handle the table matchmaking services. + +

Entites that do so, will need to implement the TableObserver interface so that the + table director can notify them when table related things happen. + +

The table services expect that the place object being used as a lobby in which the table + matchmaking takes place implements the TableLobbyObject interface. +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
TableDirector(ParlorContext ctx, + String tableField, + TableObserver observer) + +
+          Creates a new table director to manage tables with the specified observer which will receive + callbacks when interesting table related things happen.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidaddSeatednessObserver(SeatednessObserver observer) + +
+          Requests that the specified observer be added to the list of observers that are notified + when this client sits down at or stands up from a table.
+ voidbootPlayer(int tableId, + com.threerings.util.Name target) + +
+          Sends a request to boot a player from a table.
+ voidclearTableObject() + +
+          This must be called by the entity that uses the table director when the using entity has + left and is done dealing with tables.
+ voidclientDidLogoff(com.threerings.presents.client.Client client) + +
+           
+ voidcreateTable(TableConfig tableConfig, + GameConfig config) + +
+          Sends a request to create a table with the specified game configuration.
+ voidentryAdded(com.threerings.presents.dobj.EntryAddedEvent<Table> event) + +
+           
+ voidentryRemoved(com.threerings.presents.dobj.EntryRemovedEvent<Table> event) + +
+           
+ voidentryUpdated(com.threerings.presents.dobj.EntryUpdatedEvent<Table> event) + +
+           
+ TablegetSeatedTable() + +
+          Returns the current table this client is seated at, or null.
+ booleanisSeated() + +
+          Returns true if this client is currently seated at a table, false if they are not.
+ voidjoinTable(int tableId, + int position) + +
+          Sends a request to join the specified table at the specified position.
+ voidleaveTable(int tableId) + +
+          Sends a request to leave the specified table at which we are presumably seated.
+ voidremoveSeatednessObserver(SeatednessObserver observer) + +
+          Requests that the specified observer be removed from to the list of observers that are + notified when this client sits down at or stands up from a table.
+ voidrequestFailed(String reason) + +
+           
+ voidrequestProcessed(Object result) + +
+           
+ voidsetTableObject(com.threerings.presents.dobj.DObject tlobj) + +
+          This must be called by the entity that uses the table director when the using entity + prepares to enter and display a place.
+ voidstartTableNow(int tableId) + +
+          Sends a request to have the specified table start now, even if all the seats have not yet + been filled.
+  + + + + + + + +
Methods inherited from class com.threerings.presents.client.BasicDirector
clientDidLogon, clientObjectDidChange, clientWillLogon, isAvailableInStandalone, setAvailableInStandalone
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+TableDirector

+
+public TableDirector(ParlorContext ctx,
+                     String tableField,
+                     TableObserver observer)
+
+
Creates a new table director to manage tables with the specified observer which will receive + callbacks when interesting table related things happen. +

+

+
Parameters:
ctx - the parlor context in use by the client.
tableField - the field name of the distributed set that contains the tables we will be + managing.
observer - the entity that will receive callbacks when things happen to the tables.
+
+ + + + + + + + +
+Method Detail
+ +

+setTableObject

+
+public void setTableObject(com.threerings.presents.dobj.DObject tlobj)
+
+
This must be called by the entity that uses the table director when the using entity + prepares to enter and display a place. +

+

+
+
+
+
+
+
+
+ +

+clearTableObject

+
+public void clearTableObject()
+
+
This must be called by the entity that uses the table director when the using entity has + left and is done dealing with tables. +

+

+
+
+
+
+
+
+
+ +

+addSeatednessObserver

+
+public void addSeatednessObserver(SeatednessObserver observer)
+
+
Requests that the specified observer be added to the list of observers that are notified + when this client sits down at or stands up from a table. +

+

+
+
+
+
+
+
+
+ +

+removeSeatednessObserver

+
+public void removeSeatednessObserver(SeatednessObserver observer)
+
+
Requests that the specified observer be removed from to the list of observers that are + notified when this client sits down at or stands up from a table. +

+

+
+
+
+
+
+
+
+ +

+isSeated

+
+public boolean isSeated()
+
+
Returns true if this client is currently seated at a table, false if they are not. +

+

+
+
+
+
+
+
+
+ +

+getSeatedTable

+
+public Table getSeatedTable()
+
+
Returns the current table this client is seated at, or null. +

+

+
+
+
+
+
+
+
+ +

+createTable

+
+public void createTable(TableConfig tableConfig,
+                        GameConfig config)
+
+
Sends a request to create a table with the specified game configuration. This user will + become the owner of this table and will be added to the first position in the table. The + response will be communicated via the TableObserver interface. +

+

+
+
+
+
+
+
+
+ +

+joinTable

+
+public void joinTable(int tableId,
+                      int position)
+
+
Sends a request to join the specified table at the specified position. The response will be + communicated via the TableObserver interface. +

+

+
+
+
+
+
+
+
+ +

+leaveTable

+
+public void leaveTable(int tableId)
+
+
Sends a request to leave the specified table at which we are presumably seated. The response + will be communicated via the TableObserver interface. +

+

+
+
+
+
+
+
+
+ +

+startTableNow

+
+public void startTableNow(int tableId)
+
+
Sends a request to have the specified table start now, even if all the seats have not yet + been filled. +

+

+
+
+
+
+
+
+
+ +

+bootPlayer

+
+public void bootPlayer(int tableId,
+                       com.threerings.util.Name target)
+
+
Sends a request to boot a player from a table. +

+

+
+
+
+
+
+
+
+ +

+clientDidLogoff

+
+public void clientDidLogoff(com.threerings.presents.client.Client client)
+
+
+
Specified by:
clientDidLogoff in interface com.threerings.presents.client.SessionObserver
Overrides:
clientDidLogoff in class com.threerings.presents.client.BasicDirector
+
+
+
+
+
+
+ +

+entryAdded

+
+public void entryAdded(com.threerings.presents.dobj.EntryAddedEvent<Table> event)
+
+
+
Specified by:
entryAdded in interface com.threerings.presents.dobj.SetListener<Table>
+
+
+
+
+
+
+ +

+entryUpdated

+
+public void entryUpdated(com.threerings.presents.dobj.EntryUpdatedEvent<Table> event)
+
+
+
Specified by:
entryUpdated in interface com.threerings.presents.dobj.SetListener<Table>
+
+
+
+
+
+
+ +

+entryRemoved

+
+public void entryRemoved(com.threerings.presents.dobj.EntryRemovedEvent<Table> event)
+
+
+
Specified by:
entryRemoved in interface com.threerings.presents.dobj.SetListener<Table>
+
+
+
+
+
+
+ +

+requestProcessed

+
+public void requestProcessed(Object result)
+
+
+
Specified by:
requestProcessed in interface com.threerings.presents.client.InvocationService.ResultListener
+
+
+
+
+
+
+ +

+requestFailed

+
+public void requestFailed(String reason)
+
+
+
Specified by:
requestFailed in interface com.threerings.presents.client.InvocationService.InvocationListener
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/client/TableObserver.html b/apidocs/com/threerings/parlor/client/TableObserver.html new file mode 100644 index 00000000..bbbc88ce --- /dev/null +++ b/apidocs/com/threerings/parlor/client/TableObserver.html @@ -0,0 +1,262 @@ + + + + + + + +TableObserver (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.client +
+Interface TableObserver

+
+
All Known Implementing Classes:
TableListView
+
+
+
+
public interface TableObserver
+ + +

+The TableDirector converts distributed object events into + higher level callbacks to implementers of this interface, which are + expected to render these events sensically in a user interface. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidtableAdded(Table table) + +
+          Called when a new table is created.
+ voidtableRemoved(int tableId) + +
+          Called when a table goes away.
+ voidtableUpdated(Table table) + +
+          Called when something has changed about a table (occupant list + updated, state changed from matchmaking to in-play, etc.).
+  +

+ + + + + + + + +
+Method Detail
+ +

+tableAdded

+
+void tableAdded(Table table)
+
+
Called when a new table is created. +

+

+
+
+
+
+ +

+tableUpdated

+
+void tableUpdated(Table table)
+
+
Called when something has changed about a table (occupant list + updated, state changed from matchmaking to in-play, etc.). +

+

+
+
+
+
+ +

+tableRemoved

+
+void tableRemoved(int tableId)
+
+
Called when a table goes away. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/client/TableService.html b/apidocs/com/threerings/parlor/client/TableService.html new file mode 100644 index 00000000..2c1c1bf5 --- /dev/null +++ b/apidocs/com/threerings/parlor/client/TableService.html @@ -0,0 +1,355 @@ + + + + + + + +TableService (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.client +
+Interface TableService

+
+
All Superinterfaces:
com.threerings.presents.client.InvocationService
+
+
+
All Known Implementing Classes:
TableMarshaller
+
+
+
+
public interface TableService
extends com.threerings.presents.client.InvocationService
+ + +

+Provides table lobbying services. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.presents.client.InvocationService
com.threerings.presents.client.InvocationService.ConfirmListener, com.threerings.presents.client.InvocationService.InvocationListener, com.threerings.presents.client.InvocationService.ResultListener
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidbootPlayer(int tableId, + com.threerings.util.Name target, + com.threerings.presents.client.InvocationService.InvocationListener listener) + +
+          Requests that another user be booted from the specified table.
+ voidcreateTable(TableConfig tableConfig, + GameConfig config, + com.threerings.presents.client.InvocationService.ResultListener listener) + +
+          Requests that a new table be created.
+ voidjoinTable(int tableId, + int position, + com.threerings.presents.client.InvocationService.InvocationListener listener) + +
+          Requests that the current user be added to the specified table at the specified position.
+ voidleaveTable(int tableId, + com.threerings.presents.client.InvocationService.InvocationListener listener) + +
+          Requests that the current user be removed from the specified table.
+ voidstartTableNow(int tableId, + com.threerings.presents.client.InvocationService.InvocationListener listener) + +
+          Requests that the specified table be started now, even if all seats are not occupied.
+  +

+ + + + + + + + +
+Method Detail
+ +

+createTable

+
+void createTable(TableConfig tableConfig,
+                 GameConfig config,
+                 com.threerings.presents.client.InvocationService.ResultListener listener)
+
+
Requests that a new table be created. +

+

+
+
+
+
Parameters:
tableConfig - the table configuration parameters.
config - the game config for the game to be matchmade by the table.
listener - will receive and process the response.
+
+
+
+ +

+joinTable

+
+void joinTable(int tableId,
+               int position,
+               com.threerings.presents.client.InvocationService.InvocationListener listener)
+
+
Requests that the current user be added to the specified table at the specified position. +

+

+
+
+
+
Parameters:
tableId - the unique id of the table to which this user wishes to be added.
position - the position at the table to which this user desires to be added.
listener - will receive and process the response.
+
+
+
+ +

+leaveTable

+
+void leaveTable(int tableId,
+                com.threerings.presents.client.InvocationService.InvocationListener listener)
+
+
Requests that the current user be removed from the specified table. +

+

+
+
+
+
Parameters:
tableId - the unique id of the table from which this user wishes to be removed.
listener - will receive and process the response.
+
+
+
+ +

+startTableNow

+
+void startTableNow(int tableId,
+                   com.threerings.presents.client.InvocationService.InvocationListener listener)
+
+
Requests that the specified table be started now, even if all seats are not occupied. This + will always fail if called by any other player than that seated in position 0 (usually the + creator). +

+

+
+
+
+
+
+
+
+ +

+bootPlayer

+
+void bootPlayer(int tableId,
+                com.threerings.util.Name target,
+                com.threerings.presents.client.InvocationService.InvocationListener listener)
+
+
Requests that another user be booted from the specified table. +

+

+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/client/class-use/DefaultSwingTableConfigurator.html b/apidocs/com/threerings/parlor/client/class-use/DefaultSwingTableConfigurator.html new file mode 100644 index 00000000..25c06bc0 --- /dev/null +++ b/apidocs/com/threerings/parlor/client/class-use/DefaultSwingTableConfigurator.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.parlor.client.DefaultSwingTableConfigurator (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.client.DefaultSwingTableConfigurator

+
+No usage of com.threerings.parlor.client.DefaultSwingTableConfigurator +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/client/class-use/GameReadyObserver.html b/apidocs/com/threerings/parlor/client/class-use/GameReadyObserver.html new file mode 100644 index 00000000..1c7b1c64 --- /dev/null +++ b/apidocs/com/threerings/parlor/client/class-use/GameReadyObserver.html @@ -0,0 +1,191 @@ + + + + + + + +Uses of Interface com.threerings.parlor.client.GameReadyObserver (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.parlor.client.GameReadyObserver

+
+ + + + + + + + + +
+Packages that use GameReadyObserver
com.threerings.parlor.client  
+  +

+ + + + + +
+Uses of GameReadyObserver in com.threerings.parlor.client
+  +

+ + + + + + + + + + + + + +
Methods in com.threerings.parlor.client with parameters of type GameReadyObserver
+ voidParlorDirector.addGameReadyObserver(GameReadyObserver observer) + +
+          Adds the specified observer to the list of entities that are notified when we receive a game + ready notification.
+ voidParlorDirector.removeGameReadyObserver(GameReadyObserver observer) + +
+          Removes the specified observer from the list of entities that are notified when we receive a + game ready notification.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/client/class-use/Invitation.html b/apidocs/com/threerings/parlor/client/class-use/Invitation.html new file mode 100644 index 00000000..54cd3ae6 --- /dev/null +++ b/apidocs/com/threerings/parlor/client/class-use/Invitation.html @@ -0,0 +1,297 @@ + + + + + + + +Uses of Class com.threerings.parlor.client.Invitation (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.client.Invitation

+
+ + + + + + + + + + + + + +
+Packages that use Invitation
com.threerings.micasa.lobby  
com.threerings.parlor.client  
+  +

+ + + + + +
+Uses of Invitation in com.threerings.micasa.lobby
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in com.threerings.micasa.lobby with parameters of type Invitation
+ voidLobbyController.invitationAccepted(Invitation invite) + +
+           
+ voidLobbyController.invitationCancelled(Invitation invite) + +
+           
+ voidLobbyController.invitationCountered(Invitation invite, + GameConfig config) + +
+           
+ voidLobbyController.invitationReceived(Invitation invite) + +
+           
+ voidLobbyController.invitationRefused(Invitation invite, + String message) + +
+           
+  +

+ + + + + +
+Uses of Invitation in com.threerings.parlor.client
+  +

+ + + + + + + + + +
Methods in com.threerings.parlor.client that return Invitation
+ InvitationParlorDirector.invite(com.threerings.util.Name invitee, + GameConfig config, + InvitationResponseObserver observer) + +
+          Requests that the named user be invited to a game described by the supplied game config.
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in com.threerings.parlor.client with parameters of type Invitation
+ voidInvitationResponseObserver.invitationAccepted(Invitation invite) + +
+          Called if the invitation was accepted.
+ voidInvitationHandler.invitationCancelled(Invitation invite) + +
+          Called when an invitation is cancelled by the inviting player.
+ voidInvitationResponseObserver.invitationCountered(Invitation invite, + GameConfig config) + +
+          Called if the invitation was countered with an alternate game + configuration.
+ voidInvitationHandler.invitationReceived(Invitation invite) + +
+          Called when an invitation is received from another player.
+ voidInvitationResponseObserver.invitationRefused(Invitation invite, + String message) + +
+          Called if the invitation was refused.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/client/class-use/InvitationHandler.html b/apidocs/com/threerings/parlor/client/class-use/InvitationHandler.html new file mode 100644 index 00000000..d5e138e6 --- /dev/null +++ b/apidocs/com/threerings/parlor/client/class-use/InvitationHandler.html @@ -0,0 +1,211 @@ + + + + + + + +Uses of Interface com.threerings.parlor.client.InvitationHandler (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.parlor.client.InvitationHandler

+
+ + + + + + + + + + + + + +
+Packages that use InvitationHandler
com.threerings.micasa.lobby  
com.threerings.parlor.client  
+  +

+ + + + + +
+Uses of InvitationHandler in com.threerings.micasa.lobby
+  +

+ + + + + + + + + +
Classes in com.threerings.micasa.lobby that implement InvitationHandler
+ classLobbyController + +
+           
+  +

+ + + + + +
+Uses of InvitationHandler in com.threerings.parlor.client
+  +

+ + + + + + + + + +
Methods in com.threerings.parlor.client with parameters of type InvitationHandler
+ voidParlorDirector.setInvitationHandler(InvitationHandler handler) + +
+          Sets the invitation handler, which is the entity that will be notified when we receive + incoming invitation notifications and when invitations have been cancelled.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/client/class-use/InvitationResponseObserver.html b/apidocs/com/threerings/parlor/client/class-use/InvitationResponseObserver.html new file mode 100644 index 00000000..a6308a6d --- /dev/null +++ b/apidocs/com/threerings/parlor/client/class-use/InvitationResponseObserver.html @@ -0,0 +1,240 @@ + + + + + + + +Uses of Interface com.threerings.parlor.client.InvitationResponseObserver (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.parlor.client.InvitationResponseObserver

+
+ + + + + + + + + + + + + +
+Packages that use InvitationResponseObserver
com.threerings.micasa.lobby  
com.threerings.parlor.client  
+  +

+ + + + + +
+Uses of InvitationResponseObserver in com.threerings.micasa.lobby
+  +

+ + + + + + + + + +
Classes in com.threerings.micasa.lobby that implement InvitationResponseObserver
+ classLobbyController + +
+           
+  +

+ + + + + +
+Uses of InvitationResponseObserver in com.threerings.parlor.client
+  +

+ + + + + + + + + + + + + +
Methods in com.threerings.parlor.client with parameters of type InvitationResponseObserver
+ voidInvitation.counter(GameConfig config, + InvitationResponseObserver observer) + +
+          Counters this invitation with an invitation with different game + configuration parameters.
+ InvitationParlorDirector.invite(com.threerings.util.Name invitee, + GameConfig config, + InvitationResponseObserver observer) + +
+          Requests that the named user be invited to a game described by the supplied game config.
+  +

+ + + + + + + + +
Constructors in com.threerings.parlor.client with parameters of type InvitationResponseObserver
Invitation(ParlorContext ctx, + ParlorService pservice, + com.threerings.util.Name opponent, + GameConfig config, + InvitationResponseObserver observer) + +
+          Constructs a new invitation record.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/client/class-use/ParlorDecoder.html b/apidocs/com/threerings/parlor/client/class-use/ParlorDecoder.html new file mode 100644 index 00000000..1e121e39 --- /dev/null +++ b/apidocs/com/threerings/parlor/client/class-use/ParlorDecoder.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.parlor.client.ParlorDecoder (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.client.ParlorDecoder

+
+No usage of com.threerings.parlor.client.ParlorDecoder +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/client/class-use/ParlorDirector.html b/apidocs/com/threerings/parlor/client/class-use/ParlorDirector.html new file mode 100644 index 00000000..9850fbc6 --- /dev/null +++ b/apidocs/com/threerings/parlor/client/class-use/ParlorDirector.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class com.threerings.parlor.client.ParlorDirector (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.client.ParlorDirector

+
+ + + + + + + + + +
+Packages that use ParlorDirector
com.threerings.parlor.util  
+  +

+ + + + + +
+Uses of ParlorDirector in com.threerings.parlor.util
+  +

+ + + + + + + + + +
Methods in com.threerings.parlor.util that return ParlorDirector
+ ParlorDirectorParlorContext.getParlorDirector() + +
+          Returns a reference to the parlor director.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/client/class-use/ParlorReceiver.html b/apidocs/com/threerings/parlor/client/class-use/ParlorReceiver.html new file mode 100644 index 00000000..b86f3156 --- /dev/null +++ b/apidocs/com/threerings/parlor/client/class-use/ParlorReceiver.html @@ -0,0 +1,197 @@ + + + + + + + +Uses of Interface com.threerings.parlor.client.ParlorReceiver (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.parlor.client.ParlorReceiver

+
+ + + + + + + + + +
+Packages that use ParlorReceiver
com.threerings.parlor.client  
+  +

+ + + + + +
+Uses of ParlorReceiver in com.threerings.parlor.client
+  +

+ + + + + + + + + +
Classes in com.threerings.parlor.client that implement ParlorReceiver
+ classParlorDirector + +
+          The parlor director manages the client side of the game configuration and matchmaking + processes.
+  +

+ + + + + + + + +
Constructors in com.threerings.parlor.client with parameters of type ParlorReceiver
ParlorDecoder(ParlorReceiver receiver) + +
+          Creates a decoder that may be registered to dispatch invocation + service notifications to the specified receiver.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/client/class-use/ParlorService.InviteListener.html b/apidocs/com/threerings/parlor/client/class-use/ParlorService.InviteListener.html new file mode 100644 index 00000000..668279fa --- /dev/null +++ b/apidocs/com/threerings/parlor/client/class-use/ParlorService.InviteListener.html @@ -0,0 +1,291 @@ + + + + + + + +Uses of Interface com.threerings.parlor.client.ParlorService.InviteListener (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.parlor.client.ParlorService.InviteListener

+
+ + + + + + + + + + + + + + + + + +
+Packages that use ParlorService.InviteListener
com.threerings.parlor.client  
com.threerings.parlor.data  
com.threerings.parlor.server  
+  +

+ + + + + +
+Uses of ParlorService.InviteListener in com.threerings.parlor.client
+  +

+ + + + + + + + + +
Classes in com.threerings.parlor.client that implement ParlorService.InviteListener
+ classInvitation + +
+          The invitation class is used to track information related to + outstanding invitations generated by or targeted to this client.
+  +

+ + + + + + + + + +
Methods in com.threerings.parlor.client with parameters of type ParlorService.InviteListener
+ voidParlorService.invite(com.threerings.util.Name invitee, + GameConfig config, + ParlorService.InviteListener listener) + +
+          You probably don't want to call this directly, but want to generate your invitation request + via ParlorDirector.invite(com.threerings.util.Name, com.threerings.parlor.game.data.GameConfig, com.threerings.parlor.client.InvitationResponseObserver).
+  +

+ + + + + +
+Uses of ParlorService.InviteListener in com.threerings.parlor.data
+  +

+ + + + + + + + + +
Classes in com.threerings.parlor.data that implement ParlorService.InviteListener
+static classParlorMarshaller.InviteMarshaller + +
+          Marshalls results to implementations of ParlorService.InviteListener.
+  +

+ + + + + + + + + +
Methods in com.threerings.parlor.data with parameters of type ParlorService.InviteListener
+ voidParlorMarshaller.invite(com.threerings.util.Name arg1, + GameConfig arg2, + ParlorService.InviteListener arg3) + +
+           
+  +

+ + + + + +
+Uses of ParlorService.InviteListener in com.threerings.parlor.server
+  +

+ + + + + + + + + + + + + +
Methods in com.threerings.parlor.server with parameters of type ParlorService.InviteListener
+ voidParlorProvider.invite(com.threerings.presents.data.ClientObject caller, + com.threerings.util.Name arg1, + GameConfig arg2, + ParlorService.InviteListener arg3) + +
+          Handles a ParlorService.invite(com.threerings.util.Name, com.threerings.parlor.game.data.GameConfig, com.threerings.parlor.client.ParlorService.InviteListener) request.
+ voidParlorManager.invite(com.threerings.presents.data.ClientObject caller, + com.threerings.util.Name invitee, + GameConfig config, + ParlorService.InviteListener listener) + +
+           
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/client/class-use/ParlorService.html b/apidocs/com/threerings/parlor/client/class-use/ParlorService.html new file mode 100644 index 00000000..f1a57666 --- /dev/null +++ b/apidocs/com/threerings/parlor/client/class-use/ParlorService.html @@ -0,0 +1,214 @@ + + + + + + + +Uses of Interface com.threerings.parlor.client.ParlorService (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.parlor.client.ParlorService

+
+ + + + + + + + + + + + + +
+Packages that use ParlorService
com.threerings.parlor.client  
com.threerings.parlor.data  
+  +

+ + + + + +
+Uses of ParlorService in com.threerings.parlor.client
+  +

+ + + + + + + + +
Constructors in com.threerings.parlor.client with parameters of type ParlorService
Invitation(ParlorContext ctx, + ParlorService pservice, + com.threerings.util.Name opponent, + GameConfig config, + InvitationResponseObserver observer) + +
+          Constructs a new invitation record.
+  +

+ + + + + +
+Uses of ParlorService in com.threerings.parlor.data
+  +

+ + + + + + + + + +
Classes in com.threerings.parlor.data that implement ParlorService
+ classParlorMarshaller + +
+          Provides the implementation of the ParlorService interface + that marshalls the arguments and delivers the request to the provider + on the server.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/client/class-use/SeatednessObserver.html b/apidocs/com/threerings/parlor/client/class-use/SeatednessObserver.html new file mode 100644 index 00000000..dfb3c332 --- /dev/null +++ b/apidocs/com/threerings/parlor/client/class-use/SeatednessObserver.html @@ -0,0 +1,229 @@ + + + + + + + +Uses of Interface com.threerings.parlor.client.SeatednessObserver (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.parlor.client.SeatednessObserver

+
+ + + + + + + + + + + + + +
+Packages that use SeatednessObserver
com.threerings.micasa.lobby.table  
com.threerings.parlor.client  
+  +

+ + + + + +
+Uses of SeatednessObserver in com.threerings.micasa.lobby.table
+  +

+ + + + + + + + + + + + + +
Classes in com.threerings.micasa.lobby.table that implement SeatednessObserver
+ classTableItem + +
+          A table item displays the user interface for a single table (whether it + be in-play or still being matchmade).
+ classTableListView + +
+          A view that displays the tables in a table lobby.
+  +

+ + + + + +
+Uses of SeatednessObserver in com.threerings.parlor.client
+  +

+ + + + + + + + + + + + + +
Methods in com.threerings.parlor.client with parameters of type SeatednessObserver
+ voidTableDirector.addSeatednessObserver(SeatednessObserver observer) + +
+          Requests that the specified observer be added to the list of observers that are notified + when this client sits down at or stands up from a table.
+ voidTableDirector.removeSeatednessObserver(SeatednessObserver observer) + +
+          Requests that the specified observer be removed from to the list of observers that are + notified when this client sits down at or stands up from a table.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/client/class-use/TableConfigurator.html b/apidocs/com/threerings/parlor/client/class-use/TableConfigurator.html new file mode 100644 index 00000000..5e1c0dca --- /dev/null +++ b/apidocs/com/threerings/parlor/client/class-use/TableConfigurator.html @@ -0,0 +1,211 @@ + + + + + + + +Uses of Class com.threerings.parlor.client.TableConfigurator (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.client.TableConfigurator

+
+ + + + + + + + + + + + + +
+Packages that use TableConfigurator
com.threerings.parlor.client  
com.threerings.parlor.game.data  
+  +

+ + + + + +
+Uses of TableConfigurator in com.threerings.parlor.client
+  +

+ + + + + + + + + +
Subclasses of TableConfigurator in com.threerings.parlor.client
+ classDefaultSwingTableConfigurator + +
+          Provides a default implementation of a TableConfigurator for + a Swing interface.
+  +

+ + + + + +
+Uses of TableConfigurator in com.threerings.parlor.game.data
+  +

+ + + + + + + + + +
Methods in com.threerings.parlor.game.data that return TableConfigurator
+ TableConfiguratorGameConfig.createTableConfigurator() + +
+          Creates a table configurator for initializing 'table' properties of the game.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/client/class-use/TableDirector.html b/apidocs/com/threerings/parlor/client/class-use/TableDirector.html new file mode 100644 index 00000000..a3d0fdfc --- /dev/null +++ b/apidocs/com/threerings/parlor/client/class-use/TableDirector.html @@ -0,0 +1,182 @@ + + + + + + + +Uses of Class com.threerings.parlor.client.TableDirector (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.client.TableDirector

+
+ + + + + + + + + +
+Packages that use TableDirector
com.threerings.micasa.lobby.table  
+  +

+ + + + + +
+Uses of TableDirector in com.threerings.micasa.lobby.table
+  +

+ + + + + + + + +
Constructors in com.threerings.micasa.lobby.table with parameters of type TableDirector
TableItem(MiCasaContext ctx, + TableDirector tdtr, + Table table) + +
+          Creates a new table item to display and interact with the supplied + table.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/client/class-use/TableObserver.html b/apidocs/com/threerings/parlor/client/class-use/TableObserver.html new file mode 100644 index 00000000..5f86014c --- /dev/null +++ b/apidocs/com/threerings/parlor/client/class-use/TableObserver.html @@ -0,0 +1,211 @@ + + + + + + + +Uses of Interface com.threerings.parlor.client.TableObserver (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.parlor.client.TableObserver

+
+ + + + + + + + + + + + + +
+Packages that use TableObserver
com.threerings.micasa.lobby.table  
com.threerings.parlor.client  
+  +

+ + + + + +
+Uses of TableObserver in com.threerings.micasa.lobby.table
+  +

+ + + + + + + + + +
Classes in com.threerings.micasa.lobby.table that implement TableObserver
+ classTableListView + +
+          A view that displays the tables in a table lobby.
+  +

+ + + + + +
+Uses of TableObserver in com.threerings.parlor.client
+  +

+ + + + + + + + +
Constructors in com.threerings.parlor.client with parameters of type TableObserver
TableDirector(ParlorContext ctx, + String tableField, + TableObserver observer) + +
+          Creates a new table director to manage tables with the specified observer which will receive + callbacks when interesting table related things happen.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/client/class-use/TableService.html b/apidocs/com/threerings/parlor/client/class-use/TableService.html new file mode 100644 index 00000000..864857ea --- /dev/null +++ b/apidocs/com/threerings/parlor/client/class-use/TableService.html @@ -0,0 +1,183 @@ + + + + + + + +Uses of Interface com.threerings.parlor.client.TableService (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.parlor.client.TableService

+
+ + + + + + + + + +
+Packages that use TableService
com.threerings.parlor.data  
+  +

+ + + + + +
+Uses of TableService in com.threerings.parlor.data
+  +

+ + + + + + + + + +
Classes in com.threerings.parlor.data that implement TableService
+ classTableMarshaller + +
+          Provides the implementation of the TableService interface + that marshalls the arguments and delivers the request to the provider + on the server.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/client/package-frame.html b/apidocs/com/threerings/parlor/client/package-frame.html new file mode 100644 index 00000000..1ff5be84 --- /dev/null +++ b/apidocs/com/threerings/parlor/client/package-frame.html @@ -0,0 +1,70 @@ + + + + + + + +com.threerings.parlor.client (vilya 1.3 API) + + + + + + + + + + + +com.threerings.parlor.client + + + + +
+Interfaces  + +
+GameReadyObserver +
+InvitationHandler +
+InvitationResponseObserver +
+ParlorReceiver +
+ParlorService +
+ParlorService.InviteListener +
+SeatednessObserver +
+TableObserver +
+TableService
+ + + + + + +
+Classes  + +
+DefaultSwingTableConfigurator +
+Invitation +
+ParlorDecoder +
+ParlorDirector +
+TableConfigurator +
+TableDirector
+ + + + diff --git a/apidocs/com/threerings/parlor/client/package-summary.html b/apidocs/com/threerings/parlor/client/package-summary.html new file mode 100644 index 00000000..1f85da3c --- /dev/null +++ b/apidocs/com/threerings/parlor/client/package-summary.html @@ -0,0 +1,239 @@ + + + + + + + +com.threerings.parlor.client (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.parlor.client +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Interface Summary
GameReadyObserverUsed to inform interested parties when the ParlorDirector + receives a game ready notification.
InvitationHandlerA client entity that wishes to handle invitations received by other + clients should implement this interface and register itself with the + parlor director.
InvitationResponseObserverA client entity that wishes to generate invitations for games must + implement this interface.
ParlorReceiverDefines, for the parlor services, a set of notifications delivered + asynchronously by the server to the client.
ParlorServiceProvides an interface to the various parlor invocation services.
ParlorService.InviteListenerUsed to communicate responses to ParlorService.invite(com.threerings.util.Name, com.threerings.parlor.game.data.GameConfig, com.threerings.parlor.client.ParlorService.InviteListener) requests.
SeatednessObserverEntites that wish to hear about when we sit down at a table or stand up + from a table can implement this interface and register themselves with + the TableDirector.
TableObserverThe TableDirector converts distributed object events into + higher level callbacks to implementers of this interface, which are + expected to render these events sensically in a user interface.
TableServiceProvides table lobbying services.
+  + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Class Summary
DefaultSwingTableConfiguratorProvides a default implementation of a TableConfigurator for + a Swing interface.
InvitationThe invitation class is used to track information related to + outstanding invitations generated by or targeted to this client.
ParlorDecoderDispatches calls to a ParlorReceiver instance.
ParlorDirectorThe parlor director manages the client side of the game configuration and matchmaking + processes.
TableConfiguratorThis should be implemented some user-interface element that allows + the user to configure whichever TableConfig options are relevant.
TableDirectorAs tables are created and managed within the scope of a place (a lobby), we want to fold the + table management functionality into the standard hierarchy of place controllers that deal with + place-related functionality on the client.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/client/package-tree.html b/apidocs/com/threerings/parlor/client/package-tree.html new file mode 100644 index 00000000..f68acc06 --- /dev/null +++ b/apidocs/com/threerings/parlor/client/package-tree.html @@ -0,0 +1,175 @@ + + + + + + + +com.threerings.parlor.client Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.parlor.client +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/client/package-use.html b/apidocs/com/threerings/parlor/client/package-use.html new file mode 100644 index 00000000..e638c0fa --- /dev/null +++ b/apidocs/com/threerings/parlor/client/package-use.html @@ -0,0 +1,398 @@ + + + + + + + +Uses of Package com.threerings.parlor.client (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.parlor.client

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Packages that use com.threerings.parlor.client
com.threerings.micasa.lobby  
com.threerings.micasa.lobby.table  
com.threerings.parlor.client  
com.threerings.parlor.data  
com.threerings.parlor.game.data  
com.threerings.parlor.server  
com.threerings.parlor.util  
+  +

+ + + + + + + + + + + + + + +
+Classes in com.threerings.parlor.client used by com.threerings.micasa.lobby
Invitation + +
+          The invitation class is used to track information related to + outstanding invitations generated by or targeted to this client.
InvitationHandler + +
+          A client entity that wishes to handle invitations received by other + clients should implement this interface and register itself with the + parlor director.
InvitationResponseObserver + +
+          A client entity that wishes to generate invitations for games must + implement this interface.
+  +

+ + + + + + + + + + + + + + +
+Classes in com.threerings.parlor.client used by com.threerings.micasa.lobby.table
SeatednessObserver + +
+          Entites that wish to hear about when we sit down at a table or stand up + from a table can implement this interface and register themselves with + the TableDirector.
TableDirector + +
+          As tables are created and managed within the scope of a place (a lobby), we want to fold the + table management functionality into the standard hierarchy of place controllers that deal with + place-related functionality on the client.
TableObserver + +
+          The TableDirector converts distributed object events into + higher level callbacks to implementers of this interface, which are + expected to render these events sensically in a user interface.
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Classes in com.threerings.parlor.client used by com.threerings.parlor.client
GameReadyObserver + +
+          Used to inform interested parties when the ParlorDirector + receives a game ready notification.
Invitation + +
+          The invitation class is used to track information related to + outstanding invitations generated by or targeted to this client.
InvitationHandler + +
+          A client entity that wishes to handle invitations received by other + clients should implement this interface and register itself with the + parlor director.
InvitationResponseObserver + +
+          A client entity that wishes to generate invitations for games must + implement this interface.
ParlorReceiver + +
+          Defines, for the parlor services, a set of notifications delivered + asynchronously by the server to the client.
ParlorService + +
+          Provides an interface to the various parlor invocation services.
ParlorService.InviteListener + +
+          Used to communicate responses to ParlorService.invite(com.threerings.util.Name, com.threerings.parlor.game.data.GameConfig, com.threerings.parlor.client.ParlorService.InviteListener) requests.
SeatednessObserver + +
+          Entites that wish to hear about when we sit down at a table or stand up + from a table can implement this interface and register themselves with + the TableDirector.
TableConfigurator + +
+          This should be implemented some user-interface element that allows + the user to configure whichever TableConfig options are relevant.
TableObserver + +
+          The TableDirector converts distributed object events into + higher level callbacks to implementers of this interface, which are + expected to render these events sensically in a user interface.
+  +

+ + + + + + + + + + + + + + +
+Classes in com.threerings.parlor.client used by com.threerings.parlor.data
ParlorService + +
+          Provides an interface to the various parlor invocation services.
ParlorService.InviteListener + +
+          Used to communicate responses to ParlorService.invite(com.threerings.util.Name, com.threerings.parlor.game.data.GameConfig, com.threerings.parlor.client.ParlorService.InviteListener) requests.
TableService + +
+          Provides table lobbying services.
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.client used by com.threerings.parlor.game.data
TableConfigurator + +
+          This should be implemented some user-interface element that allows + the user to configure whichever TableConfig options are relevant.
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.client used by com.threerings.parlor.server
ParlorService.InviteListener + +
+          Used to communicate responses to ParlorService.invite(com.threerings.util.Name, com.threerings.parlor.game.data.GameConfig, com.threerings.parlor.client.ParlorService.InviteListener) requests.
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.client used by com.threerings.parlor.util
ParlorDirector + +
+          The parlor director manages the client side of the game configuration and matchmaking + processes.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/data/ChoiceParameter.html b/apidocs/com/threerings/parlor/data/ChoiceParameter.html new file mode 100644 index 00000000..5372515c --- /dev/null +++ b/apidocs/com/threerings/parlor/data/ChoiceParameter.html @@ -0,0 +1,408 @@ + + + + + + + +ChoiceParameter (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.data +
+Class ChoiceParameter

+
+java.lang.Object
+  extended by com.threerings.parlor.data.Parameter
+      extended by com.threerings.parlor.data.ChoiceParameter
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable
+
+
+
+
public class ChoiceParameter
extends Parameter
+ + +

+Models a parameter that allows the selection of one of a list of choices (specified as strings). +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + + + + + +
+Field Summary
+ String[]choices + +
+          The set of choices available for this parameter.
+ Stringstart + +
+          The starting selection.
+  + + + + + + + +
Fields inherited from class com.threerings.parlor.data.Parameter
ident, name, tip
+  + + + + + + + + + + +
+Constructor Summary
ChoiceParameter() + +
+           
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ StringgetChoiceLabel(int index) + +
+          Returns the translation key for the specified choice.
+ ObjectgetDefaultValue() + +
+          Returns the default value of this parameter.
+ StringgetLabel() + +
+          Returns the translation key for this parameter's label.
+  + + + + + + + +
Methods inherited from class com.threerings.parlor.data.Parameter
toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+choices

+
+public String[] choices
+
+
The set of choices available for this parameter. +

+

+
+
+
+ +

+start

+
+public String start
+
+
The starting selection. +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+ChoiceParameter

+
+public ChoiceParameter()
+
+
+ + + + + + + + +
+Method Detail
+ +

+getChoiceLabel

+
+public String getChoiceLabel(int index)
+
+
Returns the translation key for the specified choice. +

+

+
+
+
+
+ +

+getLabel

+
+public String getLabel()
+
+
Description copied from class: Parameter
+
Returns the translation key for this parameter's label. +

+

+
Specified by:
getLabel in class Parameter
+
+
+
+
+
+
+ +

+getDefaultValue

+
+public Object getDefaultValue()
+
+
Description copied from class: Parameter
+
Returns the default value of this parameter. +

+

+
Specified by:
getDefaultValue in class Parameter
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/data/Parameter.html b/apidocs/com/threerings/parlor/data/Parameter.html new file mode 100644 index 00000000..283de109 --- /dev/null +++ b/apidocs/com/threerings/parlor/data/Parameter.html @@ -0,0 +1,414 @@ + + + + + + + +Parameter (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.data +
+Class Parameter

+
+java.lang.Object
+  extended by com.threerings.parlor.data.Parameter
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable
+
+
+
Direct Known Subclasses:
ChoiceParameter, RangeParameter, ToggleParameter
+
+
+
+
public abstract class Parameter
extends Object
implements com.threerings.io.Streamable
+ + +

+Defines a configuration parameter for a game. Various derived classes exist that define + particular types of configuration parameters including choices, toggles, ranges, etc. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + + + + + + + + + +
+Field Summary
+ Stringident + +
+          A string identifier that names this parameter.
+ Stringname + +
+          A human readable name for this configuration parameter.
+ Stringtip + +
+          A human readable tooltip to display when the mouse is hovered over this configuration + parameter.
+  + + + + + + + + + + +
+Constructor Summary
Parameter() + +
+           
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+abstract  ObjectgetDefaultValue() + +
+          Returns the default value of this parameter.
+abstract  StringgetLabel() + +
+          Returns the translation key for this parameter's label.
+ StringtoString() + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+ident

+
+public String ident
+
+
A string identifier that names this parameter. +

+

+
+
+
+ +

+name

+
+public String name
+
+
A human readable name for this configuration parameter. +

+

+
+
+
+ +

+tip

+
+public String tip
+
+
A human readable tooltip to display when the mouse is hovered over this configuration + parameter. +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+Parameter

+
+public Parameter()
+
+
+ + + + + + + + +
+Method Detail
+ +

+getLabel

+
+public abstract String getLabel()
+
+
Returns the translation key for this parameter's label. +

+

+
+
+
+
+
+
+
+ +

+getDefaultValue

+
+public abstract Object getDefaultValue()
+
+
Returns the default value of this parameter. +

+

+
+
+
+
+
+
+
+ +

+toString

+
+public String toString()
+
+
+
Overrides:
toString in class Object
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/data/ParlorCodes.html b/apidocs/com/threerings/parlor/data/ParlorCodes.html new file mode 100644 index 00000000..f3f77b2a --- /dev/null +++ b/apidocs/com/threerings/parlor/data/ParlorCodes.html @@ -0,0 +1,496 @@ + + + + + + + +ParlorCodes (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.data +
+Interface ParlorCodes

+
+
All Superinterfaces:
com.threerings.presents.data.InvocationCodes
+
+
+
All Known Implementing Classes:
CardGameManager, GameManager, Invitation, ParlorDirector, ParlorManager, PuzzleManager, Table, TableManager
+
+
+
+
public interface ParlorCodes
extends com.threerings.presents.data.InvocationCodes
+ + +

+Contains codes used by the parlor invocation services. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static StringALREADY_AT_TABLE + +
+          An error code returned by the table services when a user requests to create or join a table + but they're already sitting at another table.
+static StringBANNED_FROM_TABLE + +
+          An error code returned by the table services for a request to join a table that the + requester been banned from.
+static StringGAME_ALREADY_STARTED + +
+          An error code returned by the table services when a user requests to leave a table for + which the game is already in progress.
+static StringINVALID_TABLE_POSITION + +
+          An error code returned by the table services.
+static intINVITATION_ACCEPTED + +
+          The response code for an accepted invitation.
+static intINVITATION_COUNTERED + +
+          The response code for a countered invitation.
+static intINVITATION_REFUSED + +
+          The response code for a refused invitation.
+static StringINVITEE_NOT_ONLINE + +
+          An error code explaining that an invitation was rejected because the invited user was not + online at the time the invitation was received.
+static StringMUST_BE_CREATOR + +
+          An error code returned by the table services.
+static StringNO_SELF_BOOT + +
+          An error code returned by the table services.
+static StringNO_SUCH_TABLE + +
+          An error code returned by the table services.
+static StringNOT_AT_TABLE + +
+          An error code returned by the table services when a user requests to leave a table that + they were not sitting at in the first place.
+static StringPARLOR_GROUP + +
+          Defines our invocation services group.
+static StringTABLE_POSITION_OCCUPIED + +
+          An error code returned by the table services.
+  + + + + + + + +
Fields inherited from interface com.threerings.presents.data.InvocationCodes
ACCESS_DENIED, E_ACCESS_DENIED, E_INTERNAL_ERROR, GLOBAL_GROUP, INTERNAL_ERROR
+  +

+ + + + + + + + +
+Field Detail
+ +

+PARLOR_GROUP

+
+static final String PARLOR_GROUP
+
+
Defines our invocation services group. +

+

+
See Also:
Constant Field Values
+
+
+ +

+INVITATION_ACCEPTED

+
+static final int INVITATION_ACCEPTED
+
+
The response code for an accepted invitation. +

+

+
See Also:
Constant Field Values
+
+
+ +

+INVITATION_REFUSED

+
+static final int INVITATION_REFUSED
+
+
The response code for a refused invitation. +

+

+
See Also:
Constant Field Values
+
+
+ +

+INVITATION_COUNTERED

+
+static final int INVITATION_COUNTERED
+
+
The response code for a countered invitation. +

+

+
See Also:
Constant Field Values
+
+
+ +

+INVITEE_NOT_ONLINE

+
+static final String INVITEE_NOT_ONLINE
+
+
An error code explaining that an invitation was rejected because the invited user was not + online at the time the invitation was received. +

+

+
See Also:
Constant Field Values
+
+
+ +

+NO_SUCH_TABLE

+
+static final String NO_SUCH_TABLE
+
+
An error code returned by the table services. +

+

+
See Also:
Constant Field Values
+
+
+ +

+INVALID_TABLE_POSITION

+
+static final String INVALID_TABLE_POSITION
+
+
An error code returned by the table services. +

+

+
See Also:
Constant Field Values
+
+
+ +

+MUST_BE_CREATOR

+
+static final String MUST_BE_CREATOR
+
+
An error code returned by the table services. +

+

+
See Also:
Constant Field Values
+
+
+ +

+NO_SELF_BOOT

+
+static final String NO_SELF_BOOT
+
+
An error code returned by the table services. +

+

+
See Also:
Constant Field Values
+
+
+ +

+TABLE_POSITION_OCCUPIED

+
+static final String TABLE_POSITION_OCCUPIED
+
+
An error code returned by the table services. +

+

+
See Also:
Constant Field Values
+
+
+ +

+ALREADY_AT_TABLE

+
+static final String ALREADY_AT_TABLE
+
+
An error code returned by the table services when a user requests to create or join a table + but they're already sitting at another table. +

+

+
See Also:
Constant Field Values
+
+
+ +

+NOT_AT_TABLE

+
+static final String NOT_AT_TABLE
+
+
An error code returned by the table services when a user requests to leave a table that + they were not sitting at in the first place. +

+

+
See Also:
Constant Field Values
+
+
+ +

+BANNED_FROM_TABLE

+
+static final String BANNED_FROM_TABLE
+
+
An error code returned by the table services for a request to join a table that the + requester been banned from. +

+

+
See Also:
Constant Field Values
+
+
+ +

+GAME_ALREADY_STARTED

+
+static final String GAME_ALREADY_STARTED
+
+
An error code returned by the table services when a user requests to leave a table for + which the game is already in progress. +

+

+
See Also:
Constant Field Values
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/data/ParlorMarshaller.InviteMarshaller.html b/apidocs/com/threerings/parlor/data/ParlorMarshaller.InviteMarshaller.html new file mode 100644 index 00000000..d80e5b42 --- /dev/null +++ b/apidocs/com/threerings/parlor/data/ParlorMarshaller.InviteMarshaller.html @@ -0,0 +1,380 @@ + + + + + + + +ParlorMarshaller.InviteMarshaller (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.data +
+Class ParlorMarshaller.InviteMarshaller

+
+java.lang.Object
+  extended by com.threerings.presents.data.InvocationMarshaller.ListenerMarshaller
+      extended by com.threerings.parlor.data.ParlorMarshaller.InviteMarshaller
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable, ParlorService.InviteListener, com.threerings.presents.client.InvocationService.InvocationListener
+
+
+
Enclosing class:
ParlorMarshaller
+
+
+
+
public static class ParlorMarshaller.InviteMarshaller
extends com.threerings.presents.data.InvocationMarshaller.ListenerMarshaller
implements ParlorService.InviteListener
+ + +

+Marshalls results to implementations of ParlorService.InviteListener. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + +
+Field Summary
+static intINVITE_RECEIVED + +
+          The method id used to dispatch inviteReceived(int) + responses.
+  + + + + + + + +
Fields inherited from class com.threerings.presents.data.InvocationMarshaller.ListenerMarshaller
callerOid, listener, mapStamp, omgr, REQUEST_FAILED_RSPID, requestId, transport
+  + + + + + + + + + + +
+Constructor Summary
ParlorMarshaller.InviteMarshaller() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ voiddispatchResponse(int methodId, + Object[] args) + +
+           
+ voidinviteReceived(int arg1) + +
+          Called in response to a successful ParlorService.invite(com.threerings.util.Name, com.threerings.parlor.game.data.GameConfig, com.threerings.parlor.client.ParlorService.InviteListener) request.
+  + + + + + + + +
Methods inherited from class com.threerings.presents.data.InvocationMarshaller.ListenerMarshaller
requestFailed, setInvocationId, setNoResponse, toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  + + + + + + + +
Methods inherited from interface com.threerings.presents.client.InvocationService.InvocationListener
requestFailed
+  +

+ + + + + + + + +
+Field Detail
+ +

+INVITE_RECEIVED

+
+public static final int INVITE_RECEIVED
+
+
The method id used to dispatch inviteReceived(int) + responses. +

+

+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Constructor Detail
+ +

+ParlorMarshaller.InviteMarshaller

+
+public ParlorMarshaller.InviteMarshaller()
+
+
+ + + + + + + + +
+Method Detail
+ +

+inviteReceived

+
+public void inviteReceived(int arg1)
+
+
Description copied from interface: ParlorService.InviteListener
+
Called in response to a successful ParlorService.invite(com.threerings.util.Name, com.threerings.parlor.game.data.GameConfig, com.threerings.parlor.client.ParlorService.InviteListener) request. +

+

+
Specified by:
inviteReceived in interface ParlorService.InviteListener
+
+
+
+
+
+
+ +

+dispatchResponse

+
+public void dispatchResponse(int methodId,
+                             Object[] args)
+
+
+
Overrides:
dispatchResponse in class com.threerings.presents.data.InvocationMarshaller.ListenerMarshaller
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/data/ParlorMarshaller.html b/apidocs/com/threerings/parlor/data/ParlorMarshaller.html new file mode 100644 index 00000000..beaf4b54 --- /dev/null +++ b/apidocs/com/threerings/parlor/data/ParlorMarshaller.html @@ -0,0 +1,535 @@ + + + + + + + +ParlorMarshaller (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.data +
+Class ParlorMarshaller

+
+java.lang.Object
+  extended by com.threerings.presents.data.InvocationMarshaller
+      extended by com.threerings.parlor.data.ParlorMarshaller
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable, ParlorService, com.threerings.presents.client.InvocationService
+
+
+
+
@Generated(value="com.threerings.presents.tools.GenServiceTask",
+           comments="Derived from ParlorService.java.")
+public class ParlorMarshaller
extends com.threerings.presents.data.InvocationMarshaller
implements ParlorService
+ + +

+Provides the implementation of the ParlorService interface + that marshalls the arguments and delivers the request to the provider + on the server. Also provides an implementation of the response listener + interfaces that marshall the response arguments and deliver them back + to the requesting client. +

+ +

+

+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static classParlorMarshaller.InviteMarshaller + +
+          Marshalls results to implementations of ParlorService.InviteListener.
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.presents.data.InvocationMarshaller
com.threerings.presents.data.InvocationMarshaller.ConfirmMarshaller, com.threerings.presents.data.InvocationMarshaller.ListenerMarshaller, com.threerings.presents.data.InvocationMarshaller.ResultMarshaller
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.parlor.client.ParlorService
ParlorService.InviteListener
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.presents.client.InvocationService
com.threerings.presents.client.InvocationService.ConfirmListener, com.threerings.presents.client.InvocationService.InvocationListener, com.threerings.presents.client.InvocationService.ResultListener
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static intCANCEL + +
+          The method id used to dispatch cancel(int, com.threerings.presents.client.InvocationService.InvocationListener) requests.
+static intINVITE + +
+          The method id used to dispatch invite(com.threerings.util.Name, com.threerings.parlor.game.data.GameConfig, com.threerings.parlor.client.ParlorService.InviteListener) requests.
+static intRESPOND + +
+          The method id used to dispatch respond(int, int, java.lang.Object, com.threerings.presents.client.InvocationService.InvocationListener) requests.
+static intSTART_SOLITAIRE + +
+          The method id used to dispatch startSolitaire(com.threerings.parlor.game.data.GameConfig, com.threerings.presents.client.InvocationService.ConfirmListener) requests.
+  + + + + + + + + + + +
+Constructor Summary
ParlorMarshaller() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidcancel(int arg1, + com.threerings.presents.client.InvocationService.InvocationListener arg2) + +
+          You probably don't want to call this directly, but want to call Invitation.cancel().
+ voidinvite(com.threerings.util.Name arg1, + GameConfig arg2, + ParlorService.InviteListener arg3) + +
+          You probably don't want to call this directly, but want to generate your invitation request + via ParlorDirector.invite(com.threerings.util.Name, com.threerings.parlor.game.data.GameConfig, com.threerings.parlor.client.InvitationResponseObserver).
+ voidrespond(int arg1, + int arg2, + Object arg3, + com.threerings.presents.client.InvocationService.InvocationListener arg4) + +
+          You probably don't want to call this directly, but want to call one of Invitation.accept(), Invitation.refuse(java.lang.String), or Invitation.counter(com.threerings.parlor.game.data.GameConfig, com.threerings.parlor.client.InvitationResponseObserver).
+ voidstartSolitaire(GameConfig arg1, + com.threerings.presents.client.InvocationService.ConfirmListener arg2) + +
+          Requests to start a single player game with the specified game configuration.
+  + + + + + + + +
Methods inherited from class com.threerings.presents.data.InvocationMarshaller
getInvocationCode, init, readField__invCode, readField__invOid, readObject, setInvocationOid, setNoResponse, toString, writeField__invCode, writeField__invOid
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+CANCEL

+
+public static final int CANCEL
+
+
The method id used to dispatch cancel(int, com.threerings.presents.client.InvocationService.InvocationListener) requests. +

+

+
See Also:
Constant Field Values
+
+
+ +

+INVITE

+
+public static final int INVITE
+
+
The method id used to dispatch invite(com.threerings.util.Name, com.threerings.parlor.game.data.GameConfig, com.threerings.parlor.client.ParlorService.InviteListener) requests. +

+

+
See Also:
Constant Field Values
+
+
+ +

+RESPOND

+
+public static final int RESPOND
+
+
The method id used to dispatch respond(int, int, java.lang.Object, com.threerings.presents.client.InvocationService.InvocationListener) requests. +

+

+
See Also:
Constant Field Values
+
+
+ +

+START_SOLITAIRE

+
+public static final int START_SOLITAIRE
+
+
The method id used to dispatch startSolitaire(com.threerings.parlor.game.data.GameConfig, com.threerings.presents.client.InvocationService.ConfirmListener) requests. +

+

+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Constructor Detail
+ +

+ParlorMarshaller

+
+public ParlorMarshaller()
+
+
+ + + + + + + + +
+Method Detail
+ +

+cancel

+
+public void cancel(int arg1,
+                   com.threerings.presents.client.InvocationService.InvocationListener arg2)
+
+
Description copied from interface: ParlorService
+
You probably don't want to call this directly, but want to call Invitation.cancel(). Requests that an outstanding invitation be cancelled. +

+

+
Specified by:
cancel in interface ParlorService
+
+
+
Parameters:
arg1 - the unique id previously assigned by the server to this invitation.
arg2 - will receive and process the response.
+
+
+
+ +

+invite

+
+public void invite(com.threerings.util.Name arg1,
+                   GameConfig arg2,
+                   ParlorService.InviteListener arg3)
+
+
Description copied from interface: ParlorService
+
You probably don't want to call this directly, but want to generate your invitation request + via ParlorDirector.invite(com.threerings.util.Name, com.threerings.parlor.game.data.GameConfig, com.threerings.parlor.client.InvitationResponseObserver). Requests that an invitation be delivered to the named + user, requesting that they join the inviting user in a game, the details of which are + specified in the supplied game config object. +

+

+
Specified by:
invite in interface ParlorService
+
+
+
Parameters:
arg1 - the username of the user to be invited.
arg2 - a game config object detailing the type and configuration of the game to be + created.
arg3 - will receive and process the response.
+
+
+
+ +

+respond

+
+public void respond(int arg1,
+                    int arg2,
+                    Object arg3,
+                    com.threerings.presents.client.InvocationService.InvocationListener arg4)
+
+
Description copied from interface: ParlorService
+
You probably don't want to call this directly, but want to call one of Invitation.accept(), Invitation.refuse(java.lang.String), or Invitation.counter(com.threerings.parlor.game.data.GameConfig, com.threerings.parlor.client.InvitationResponseObserver). Requests that + an invitation response be delivered with the specified parameters. +

+

+
Specified by:
respond in interface ParlorService
+
+
+
Parameters:
arg1 - the unique id previously assigned by the server to this invitation.
arg2 - the response code to use in responding to the invitation.
arg3 - the argument associated with the response (a string message from the player + explaining why the response was refused in the case of an invitation refusal or an updated + game configuration object in the case of a counter-invitation, or null in the case of an + accepted invitation).
arg4 - will receive and process the response.
+
+
+
+ +

+startSolitaire

+
+public void startSolitaire(GameConfig arg1,
+                           com.threerings.presents.client.InvocationService.ConfirmListener arg2)
+
+
Description copied from interface: ParlorService
+
Requests to start a single player game with the specified game configuration. +

+

+
Specified by:
startSolitaire in interface ParlorService
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/data/RangeParameter.html b/apidocs/com/threerings/parlor/data/RangeParameter.html new file mode 100644 index 00000000..356a383f --- /dev/null +++ b/apidocs/com/threerings/parlor/data/RangeParameter.html @@ -0,0 +1,407 @@ + + + + + + + +RangeParameter (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.data +
+Class RangeParameter

+
+java.lang.Object
+  extended by com.threerings.parlor.data.Parameter
+      extended by com.threerings.parlor.data.RangeParameter
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable
+
+
+
+
public class RangeParameter
extends Parameter
+ + +

+Models a parameter that can contain an integer value in a specified range. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + + + + + + + + + +
+Field Summary
+ intmaximum + +
+          The maximum value of this parameter.
+ intminimum + +
+          The minimum value of this parameter.
+ intstart + +
+          The starting value for this parameter.
+  + + + + + + + +
Fields inherited from class com.threerings.parlor.data.Parameter
ident, name, tip
+  + + + + + + + + + + +
+Constructor Summary
RangeParameter() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ ObjectgetDefaultValue() + +
+          Returns the default value of this parameter.
+ StringgetLabel() + +
+          Returns the translation key for this parameter's label.
+  + + + + + + + +
Methods inherited from class com.threerings.parlor.data.Parameter
toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+minimum

+
+public int minimum
+
+
The minimum value of this parameter. +

+

+
+
+
+ +

+maximum

+
+public int maximum
+
+
The maximum value of this parameter. +

+

+
+
+
+ +

+start

+
+public int start
+
+
The starting value for this parameter. +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+RangeParameter

+
+public RangeParameter()
+
+
+ + + + + + + + +
+Method Detail
+ +

+getLabel

+
+public String getLabel()
+
+
Description copied from class: Parameter
+
Returns the translation key for this parameter's label. +

+

+
Specified by:
getLabel in class Parameter
+
+
+
+
+
+
+ +

+getDefaultValue

+
+public Object getDefaultValue()
+
+
Description copied from class: Parameter
+
Returns the default value of this parameter. +

+

+
Specified by:
getDefaultValue in class Parameter
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/data/Table.html b/apidocs/com/threerings/parlor/data/Table.html new file mode 100644 index 00000000..e9bdd694 --- /dev/null +++ b/apidocs/com/threerings/parlor/data/Table.html @@ -0,0 +1,986 @@ + + + + + + + +Table (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.data +
+Class Table

+
+java.lang.Object
+  extended by com.threerings.parlor.data.Table
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable, ParlorCodes, com.threerings.presents.data.InvocationCodes, com.threerings.presents.dobj.DSet.Entry
+
+
+
+
public class Table
extends Object
implements com.threerings.presents.dobj.DSet.Entry, ParlorCodes
+ + +

+This class represents a table that is being used to matchmake a game by the Parlor services. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static intANY_POSITION + +
+          Used to request any position at a table.
+ int[]bodyOids + +
+          The body oids of the players of this table, or null if a party game.
+ GameConfigconfig + +
+          The game config for the game that is being matchmade.
+ intgameOid + +
+          The oid of the game that was created from this table or -1 if the table is still in + matchmaking mode.
+ intlobbyOid + +
+          The object id of the lobby object with which this table is associated.
+ com.threerings.util.Name[]players + +
+          An array of the usernames of the players of this table (some slots may not be filled), or + null if a party game.
+ inttableId + +
+          The unique identifier for this table.
+ TableConfigtconfig + +
+          The table configuration object.
+ com.threerings.util.Name[]watchers + +
+          An array of the usernames of the non-player occupants of this game.
+  + + + + + + + +
Fields inherited from interface com.threerings.parlor.data.ParlorCodes
ALREADY_AT_TABLE, BANNED_FROM_TABLE, GAME_ALREADY_STARTED, INVALID_TABLE_POSITION, INVITATION_ACCEPTED, INVITATION_COUNTERED, INVITATION_REFUSED, INVITEE_NOT_ONLINE, MUST_BE_CREATOR, NO_SELF_BOOT, NO_SUCH_TABLE, NOT_AT_TABLE, PARLOR_GROUP, TABLE_POSITION_OCCUPIED
+  + + + + + + + +
Fields inherited from interface com.threerings.presents.data.InvocationCodes
ACCESS_DENIED, E_ACCESS_DENIED, E_INTERNAL_ERROR, GLOBAL_GROUP, INTERNAL_ERROR
+  + + + + + + + + + + +
+Constructor Summary
Table() + +
+          Constructs a blank table instance, suitable for unserialization.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidaddBannedUser(com.threerings.util.Name player) + +
+          Indicate to this table that a user was booted and should + be prevented from rejoining.
+ booleanclearPlayer(com.threerings.util.Name username) + +
+          Requests that the specified user be removed from their seat at this table.
+ booleanclearPlayerByOid(int bodyOid) + +
+          Requests that the user identified by the specified body object id be removed from their seat + at this table.
+ voidclearPlayerPos(int position) + +
+          Called to clear a player at the specified position.
+ booleancontainsPlayer(com.threerings.util.Name player) + +
+          Returns true if this table contains the specified player.
+ booleanequals(Object other) + +
+           
+ Comparable<?>getKey() + +
+           
+ intgetOccupiedCount() + +
+          Count the number of players currently occupying this table.
+ com.threerings.util.Name[]getPlayers() + +
+          Once a table is ready to play (see mayBeStarted() and shouldBeStarted()), the + players array can be fetched using this method.
+ int[][]getTeamMemberIndices() + +
+          For a team game, get the team member indices of the compressed players array returned by + getPlayers().
+ inthashCode() + +
+           
+ voidinit(int lobbyOid, + TableConfig tconfig, + GameConfig config) + +
+          Initializes a new table instance, and assigns it the next monotonically increasing table id.
+ booleaninPlay() + +
+          Returns true if this table is in play, false if it is still being matchmade.
+ booleanisEmpty() + +
+          Returns true if there is no one sitting at this table.
+ booleanmayBeStarted() + +
+          Returns true if this table has a sufficient number of players that the game can be + started.
+ StringsetPlayer(int position, + com.threerings.crowd.data.BodyObject player) + +
+          Requests to seat the specified user at the specified position in this table.
+ voidsetPlayerPos(int position, + com.threerings.crowd.data.BodyObject player) + +
+          This method is used for party games, it does no bounds checking or verification of the + player's ability to join, if you are unsure you should call 'setPlayer'.
+ booleanshouldBeStarted() + +
+          Returns true if sufficient seats are occupied that the game should be automatically started.
+ StringtoString() + +
+           
+ voidupdateOccupants(GameObject gameobj) + +
+          Called by the table manager when the game object's players have changed.
+  + + + + + + + +
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+ANY_POSITION

+
+public static final int ANY_POSITION
+
+
Used to request any position at a table. +

+

+
See Also:
Constant Field Values
+
+
+ +

+tableId

+
+public int tableId
+
+
The unique identifier for this table. +

+

+
+
+
+ +

+lobbyOid

+
+public int lobbyOid
+
+
The object id of the lobby object with which this table is associated. +

+

+
+
+
+ +

+gameOid

+
+public int gameOid
+
+
The oid of the game that was created from this table or -1 if the table is still in + matchmaking mode. +

+

+
+
+
+ +

+players

+
+public com.threerings.util.Name[] players
+
+
An array of the usernames of the players of this table (some slots may not be filled), or + null if a party game. +

+

+
+
+
+ +

+watchers

+
+public com.threerings.util.Name[] watchers
+
+
An array of the usernames of the non-player occupants of this game. For FFA party games + this is all of a room's occupants and they are in fact players. +

+

+
+
+
+ +

+bodyOids

+
+public transient int[] bodyOids
+
+
The body oids of the players of this table, or null if a party game. (This is not + propagated to remote instances.) +

+

+
+
+
+ +

+config

+
+public GameConfig config
+
+
The game config for the game that is being matchmade. +

+

+
+
+
+ +

+tconfig

+
+public TableConfig tconfig
+
+
The table configuration object. +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+Table

+
+public Table()
+
+
Constructs a blank table instance, suitable for unserialization. +

+

+ + + + + + + + +
+Method Detail
+ +

+init

+
+public void init(int lobbyOid,
+                 TableConfig tconfig,
+                 GameConfig config)
+
+
Initializes a new table instance, and assigns it the next monotonically increasing table id. +

+

+
+
+
+
Parameters:
lobbyOid - the object id of the lobby in which this table is to live.
tconfig - the table configuration for this table.
config - the configuration of the game being matchmade by this table.
+
+
+
+ +

+isEmpty

+
+public boolean isEmpty()
+
+
Returns true if there is no one sitting at this table. +

+

+
+
+
+
+
+
+
+ +

+getOccupiedCount

+
+public int getOccupiedCount()
+
+
Count the number of players currently occupying this table. +

+

+
+
+
+
+
+
+
+ +

+getPlayers

+
+public com.threerings.util.Name[] getPlayers()
+
+
Once a table is ready to play (see mayBeStarted() and shouldBeStarted()), the + players array can be fetched using this method. It will return an array containing the + usernames of all of the players in the game, sized properly and with each player in the + appropriate position. +

+

+
+
+
+
+
+
+
+ +

+getTeamMemberIndices

+
+public int[][] getTeamMemberIndices()
+
+
For a team game, get the team member indices of the compressed players array returned by + getPlayers(). +

+

+
+
+
+
+
+
+
+ +

+setPlayer

+
+public String setPlayer(int position,
+                        com.threerings.crowd.data.BodyObject player)
+
+
Requests to seat the specified user at the specified position in this table. +

+

+
+
+
+
Parameters:
position - the position in which to seat the user.
player - the player to set. +
Returns:
null if the user was successfully seated, a string error code explaining the failure + if the user was not able to be seated at that position.
+
+
+
+ +

+setPlayerPos

+
+public void setPlayerPos(int position,
+                         com.threerings.crowd.data.BodyObject player)
+
+
This method is used for party games, it does no bounds checking or verification of the + player's ability to join, if you are unsure you should call 'setPlayer'. +

+

+
+
+
+
+
+
+
+ +

+addBannedUser

+
+public void addBannedUser(com.threerings.util.Name player)
+
+
Indicate to this table that a user was booted and should + be prevented from rejoining. +

+

+
+
+
+
+
+
+
+ +

+clearPlayer

+
+public boolean clearPlayer(com.threerings.util.Name username)
+
+
Requests that the specified user be removed from their seat at this table. +

+

+
+
+
+ +
Returns:
true if the user was seated at the table and has now been removed, false if the user + was never seated at the table in the first place.
+
+
+
+ +

+clearPlayerByOid

+
+public boolean clearPlayerByOid(int bodyOid)
+
+
Requests that the user identified by the specified body object id be removed from their seat + at this table. +

+

+
+
+
+ +
Returns:
true if the user was seated at the table and has now been removed, false if the user + was never seated at the table in the first place.
+
+
+
+ +

+clearPlayerPos

+
+public void clearPlayerPos(int position)
+
+
Called to clear a player at the specified position. Only call this method if you know what + you're doing. +

+

+
+
+
+
+
+
+
+ +

+containsPlayer

+
+public boolean containsPlayer(com.threerings.util.Name player)
+
+
Returns true if this table contains the specified player. +

+

+
+
+
+
+
+
+
+ +

+updateOccupants

+
+public void updateOccupants(GameObject gameobj)
+
+
Called by the table manager when the game object's players have changed. Regenerates the + watchers array. +

+

+
+
+
+
+
+
+
+ +

+mayBeStarted

+
+public boolean mayBeStarted()
+
+
Returns true if this table has a sufficient number of players that the game can be + started. +

+

+
+
+
+
+
+
+
+ +

+shouldBeStarted

+
+public boolean shouldBeStarted()
+
+
Returns true if sufficient seats are occupied that the game should be automatically started. +

+

+
+
+
+
+
+
+
+ +

+inPlay

+
+public boolean inPlay()
+
+
Returns true if this table is in play, false if it is still being matchmade. +

+

+
+
+
+
+
+
+
+ +

+getKey

+
+public Comparable<?> getKey()
+
+
+
Specified by:
getKey in interface com.threerings.presents.dobj.DSet.Entry
+
+
+
+
+
+
+ +

+equals

+
+public boolean equals(Object other)
+
+
+
Overrides:
equals in class Object
+
+
+
+
+
+
+ +

+hashCode

+
+public int hashCode()
+
+
+
Overrides:
hashCode in class Object
+
+
+
+
+
+
+ +

+toString

+
+public String toString()
+
+
+
Overrides:
toString in class Object
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/data/TableConfig.html b/apidocs/com/threerings/parlor/data/TableConfig.html new file mode 100644 index 00000000..2f803be8 --- /dev/null +++ b/apidocs/com/threerings/parlor/data/TableConfig.html @@ -0,0 +1,365 @@ + + + + + + + +TableConfig (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.data +
+Class TableConfig

+
+java.lang.Object
+  extended by com.threerings.io.SimpleStreamableObject
+      extended by com.threerings.parlor.data.TableConfig
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable
+
+
+
+
public class TableConfig
extends com.threerings.io.SimpleStreamableObject
+ + +

+Table configuration parameters for a game that is to be matchmade using the table services. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+ intdesiredPlayerCount + +
+          The total number of players that are desired for the table.
+ intminimumPlayerCount + +
+          The minimum number of players needed overall (or per-team if a team-based game) for the + game to start at the creator's discretion.
+ booleanprivateTable + +
+          Whether the table is "private".
+ int[][]teamMemberIndices + +
+          If non-null, indicates that this is a team-based game and contains the team assignments for + each player.
+  + + + + + + + + + + +
+Constructor Summary
TableConfig() + +
+           
+  + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from class com.threerings.io.SimpleStreamableObject
toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+desiredPlayerCount

+
+public int desiredPlayerCount
+
+
The total number of players that are desired for the table. For team games, this should be + set to the total number of players overall, as teams may be unequal. +

+

+
+
+
+ +

+minimumPlayerCount

+
+public int minimumPlayerCount
+
+
The minimum number of players needed overall (or per-team if a team-based game) for the + game to start at the creator's discretion. +

+

+
+
+
+ +

+teamMemberIndices

+
+public int[][] teamMemberIndices
+
+
If non-null, indicates that this is a team-based game and contains the team assignments for + each player. For example, a game with three players in two teams- players 0 and 2 versus + player 1- would have { {0, 2}, {1} }; +

+

+
+
+
+ +

+privateTable

+
+public boolean privateTable
+
+
Whether the table is "private". +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+TableConfig

+
+public TableConfig()
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/data/TableLobbyObject.html b/apidocs/com/threerings/parlor/data/TableLobbyObject.html new file mode 100644 index 00000000..c7932229 --- /dev/null +++ b/apidocs/com/threerings/parlor/data/TableLobbyObject.html @@ -0,0 +1,334 @@ + + + + + + + +TableLobbyObject (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.data +
+Interface TableLobbyObject

+
+
All Known Implementing Classes:
TableLobbyObject
+
+
+
+
public interface TableLobbyObject
+ + +

+This interface must be implemented by the place object used by a lobby + that wishes to make use of the table services. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidaddToTables(Table table) + +
+          Adds the supplied table instance to the tables set (using the + appropriate distributed object mechanisms).
+ com.threerings.presents.dobj.DSet<Table>getTables() + +
+          Returns a reference to the distributed set instance that will be + holding the tables.
+ TableMarshallergetTableService() + +
+          Returns a reference to the table service configured in this object.
+ voidremoveFromTables(Comparable<?> key) + +
+          Removes the table instance that matches the specified key from the + tables set (using the appropriate distributed object mechanisms).
+ voidsetTableService(TableMarshaller service) + +
+          Configures the table service that clients should use to communicate table requests back to + the table manager handling these tables.
+ voidupdateTables(Table table) + +
+          Updates the value of the specified table instance in the tables + distributed set (using the appropriate distributed object + mechanisms).
+  +

+ + + + + + + + +
+Method Detail
+ +

+getTables

+
+com.threerings.presents.dobj.DSet<Table> getTables()
+
+
Returns a reference to the distributed set instance that will be + holding the tables. +

+

+
+
+
+
+ +

+addToTables

+
+void addToTables(Table table)
+
+
Adds the supplied table instance to the tables set (using the + appropriate distributed object mechanisms). +

+

+
+
+
+
+ +

+updateTables

+
+void updateTables(Table table)
+
+
Updates the value of the specified table instance in the tables + distributed set (using the appropriate distributed object + mechanisms). +

+

+
+
+
+
+ +

+removeFromTables

+
+void removeFromTables(Comparable<?> key)
+
+
Removes the table instance that matches the specified key from the + tables set (using the appropriate distributed object mechanisms). +

+

+
+
+
+
+ +

+getTableService

+
+TableMarshaller getTableService()
+
+
Returns a reference to the table service configured in this object. +

+

+
+
+
+
+ +

+setTableService

+
+void setTableService(TableMarshaller service)
+
+
Configures the table service that clients should use to communicate table requests back to + the table manager handling these tables. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/data/TableMarshaller.html b/apidocs/com/threerings/parlor/data/TableMarshaller.html new file mode 100644 index 00000000..0f560ed6 --- /dev/null +++ b/apidocs/com/threerings/parlor/data/TableMarshaller.html @@ -0,0 +1,557 @@ + + + + + + + +TableMarshaller (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.data +
+Class TableMarshaller

+
+java.lang.Object
+  extended by com.threerings.presents.data.InvocationMarshaller
+      extended by com.threerings.parlor.data.TableMarshaller
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable, TableService, com.threerings.presents.client.InvocationService
+
+
+
+
@Generated(value="com.threerings.presents.tools.GenServiceTask",
+           comments="Derived from TableService.java.")
+public class TableMarshaller
extends com.threerings.presents.data.InvocationMarshaller
implements TableService
+ + +

+Provides the implementation of the TableService interface + that marshalls the arguments and delivers the request to the provider + on the server. Also provides an implementation of the response listener + interfaces that marshall the response arguments and deliver them back + to the requesting client. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.presents.data.InvocationMarshaller
com.threerings.presents.data.InvocationMarshaller.ConfirmMarshaller, com.threerings.presents.data.InvocationMarshaller.ListenerMarshaller, com.threerings.presents.data.InvocationMarshaller.ResultMarshaller
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.presents.client.InvocationService
com.threerings.presents.client.InvocationService.ConfirmListener, com.threerings.presents.client.InvocationService.InvocationListener, com.threerings.presents.client.InvocationService.ResultListener
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static intBOOT_PLAYER + +
+          The method id used to dispatch bootPlayer(int, com.threerings.util.Name, com.threerings.presents.client.InvocationService.InvocationListener) requests.
+static intCREATE_TABLE + +
+          The method id used to dispatch createTable(com.threerings.parlor.data.TableConfig, com.threerings.parlor.game.data.GameConfig, com.threerings.presents.client.InvocationService.ResultListener) requests.
+static intJOIN_TABLE + +
+          The method id used to dispatch joinTable(int, int, com.threerings.presents.client.InvocationService.InvocationListener) requests.
+static intLEAVE_TABLE + +
+          The method id used to dispatch leaveTable(int, com.threerings.presents.client.InvocationService.InvocationListener) requests.
+static intSTART_TABLE_NOW + +
+          The method id used to dispatch startTableNow(int, com.threerings.presents.client.InvocationService.InvocationListener) requests.
+  + + + + + + + + + + +
+Constructor Summary
TableMarshaller() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidbootPlayer(int arg1, + com.threerings.util.Name arg2, + com.threerings.presents.client.InvocationService.InvocationListener arg3) + +
+          Requests that another user be booted from the specified table.
+ voidcreateTable(TableConfig arg1, + GameConfig arg2, + com.threerings.presents.client.InvocationService.ResultListener arg3) + +
+          Requests that a new table be created.
+ voidjoinTable(int arg1, + int arg2, + com.threerings.presents.client.InvocationService.InvocationListener arg3) + +
+          Requests that the current user be added to the specified table at the specified position.
+ voidleaveTable(int arg1, + com.threerings.presents.client.InvocationService.InvocationListener arg2) + +
+          Requests that the current user be removed from the specified table.
+ voidstartTableNow(int arg1, + com.threerings.presents.client.InvocationService.InvocationListener arg2) + +
+          Requests that the specified table be started now, even if all seats are not occupied.
+  + + + + + + + +
Methods inherited from class com.threerings.presents.data.InvocationMarshaller
getInvocationCode, init, readField__invCode, readField__invOid, readObject, setInvocationOid, setNoResponse, toString, writeField__invCode, writeField__invOid
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+BOOT_PLAYER

+
+public static final int BOOT_PLAYER
+
+
The method id used to dispatch bootPlayer(int, com.threerings.util.Name, com.threerings.presents.client.InvocationService.InvocationListener) requests. +

+

+
See Also:
Constant Field Values
+
+
+ +

+CREATE_TABLE

+
+public static final int CREATE_TABLE
+
+
The method id used to dispatch createTable(com.threerings.parlor.data.TableConfig, com.threerings.parlor.game.data.GameConfig, com.threerings.presents.client.InvocationService.ResultListener) requests. +

+

+
See Also:
Constant Field Values
+
+
+ +

+JOIN_TABLE

+
+public static final int JOIN_TABLE
+
+
The method id used to dispatch joinTable(int, int, com.threerings.presents.client.InvocationService.InvocationListener) requests. +

+

+
See Also:
Constant Field Values
+
+
+ +

+LEAVE_TABLE

+
+public static final int LEAVE_TABLE
+
+
The method id used to dispatch leaveTable(int, com.threerings.presents.client.InvocationService.InvocationListener) requests. +

+

+
See Also:
Constant Field Values
+
+
+ +

+START_TABLE_NOW

+
+public static final int START_TABLE_NOW
+
+
The method id used to dispatch startTableNow(int, com.threerings.presents.client.InvocationService.InvocationListener) requests. +

+

+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Constructor Detail
+ +

+TableMarshaller

+
+public TableMarshaller()
+
+
+ + + + + + + + +
+Method Detail
+ +

+bootPlayer

+
+public void bootPlayer(int arg1,
+                       com.threerings.util.Name arg2,
+                       com.threerings.presents.client.InvocationService.InvocationListener arg3)
+
+
Description copied from interface: TableService
+
Requests that another user be booted from the specified table. +

+

+
Specified by:
bootPlayer in interface TableService
+
+
+
+
+
+
+ +

+createTable

+
+public void createTable(TableConfig arg1,
+                        GameConfig arg2,
+                        com.threerings.presents.client.InvocationService.ResultListener arg3)
+
+
Description copied from interface: TableService
+
Requests that a new table be created. +

+

+
Specified by:
createTable in interface TableService
+
+
+
Parameters:
arg1 - the table configuration parameters.
arg2 - the game config for the game to be matchmade by the table.
arg3 - will receive and process the response.
+
+
+
+ +

+joinTable

+
+public void joinTable(int arg1,
+                      int arg2,
+                      com.threerings.presents.client.InvocationService.InvocationListener arg3)
+
+
Description copied from interface: TableService
+
Requests that the current user be added to the specified table at the specified position. +

+

+
Specified by:
joinTable in interface TableService
+
+
+
Parameters:
arg1 - the unique id of the table to which this user wishes to be added.
arg2 - the position at the table to which this user desires to be added.
arg3 - will receive and process the response.
+
+
+
+ +

+leaveTable

+
+public void leaveTable(int arg1,
+                       com.threerings.presents.client.InvocationService.InvocationListener arg2)
+
+
Description copied from interface: TableService
+
Requests that the current user be removed from the specified table. +

+

+
Specified by:
leaveTable in interface TableService
+
+
+
Parameters:
arg1 - the unique id of the table from which this user wishes to be removed.
arg2 - will receive and process the response.
+
+
+
+ +

+startTableNow

+
+public void startTableNow(int arg1,
+                          com.threerings.presents.client.InvocationService.InvocationListener arg2)
+
+
Description copied from interface: TableService
+
Requests that the specified table be started now, even if all seats are not occupied. This + will always fail if called by any other player than that seated in position 0 (usually the + creator). +

+

+
Specified by:
startTableNow in interface TableService
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/data/ToggleParameter.html b/apidocs/com/threerings/parlor/data/ToggleParameter.html new file mode 100644 index 00000000..27960afa --- /dev/null +++ b/apidocs/com/threerings/parlor/data/ToggleParameter.html @@ -0,0 +1,367 @@ + + + + + + + +ToggleParameter (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.data +
+Class ToggleParameter

+
+java.lang.Object
+  extended by com.threerings.parlor.data.Parameter
+      extended by com.threerings.parlor.data.ToggleParameter
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable
+
+
+
+
public class ToggleParameter
extends Parameter
+ + +

+Models a parameter that allows the toggling of a single value. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + +
+Field Summary
+ booleanstart + +
+          The starting state for this parameter.
+  + + + + + + + +
Fields inherited from class com.threerings.parlor.data.Parameter
ident, name, tip
+  + + + + + + + + + + +
+Constructor Summary
ToggleParameter() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ ObjectgetDefaultValue() + +
+          Returns the default value of this parameter.
+ StringgetLabel() + +
+          Returns the translation key for this parameter's label.
+  + + + + + + + +
Methods inherited from class com.threerings.parlor.data.Parameter
toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+start

+
+public boolean start
+
+
The starting state for this parameter. +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+ToggleParameter

+
+public ToggleParameter()
+
+
+ + + + + + + + +
+Method Detail
+ +

+getLabel

+
+public String getLabel()
+
+
Description copied from class: Parameter
+
Returns the translation key for this parameter's label. +

+

+
Specified by:
getLabel in class Parameter
+
+
+
+
+
+
+ +

+getDefaultValue

+
+public Object getDefaultValue()
+
+
Description copied from class: Parameter
+
Returns the default value of this parameter. +

+

+
Specified by:
getDefaultValue in class Parameter
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/data/class-use/ChoiceParameter.html b/apidocs/com/threerings/parlor/data/class-use/ChoiceParameter.html new file mode 100644 index 00000000..513eb5ed --- /dev/null +++ b/apidocs/com/threerings/parlor/data/class-use/ChoiceParameter.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.parlor.data.ChoiceParameter (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.data.ChoiceParameter

+
+No usage of com.threerings.parlor.data.ChoiceParameter +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/data/class-use/Parameter.html b/apidocs/com/threerings/parlor/data/class-use/Parameter.html new file mode 100644 index 00000000..74fef4b9 --- /dev/null +++ b/apidocs/com/threerings/parlor/data/class-use/Parameter.html @@ -0,0 +1,197 @@ + + + + + + + +Uses of Class com.threerings.parlor.data.Parameter (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.data.Parameter

+
+ + + + + + + + + +
+Packages that use Parameter
com.threerings.parlor.data  
+  +

+ + + + + +
+Uses of Parameter in com.threerings.parlor.data
+  +

+ + + + + + + + + + + + + + + + + +
Subclasses of Parameter in com.threerings.parlor.data
+ classChoiceParameter + +
+          Models a parameter that allows the selection of one of a list of choices (specified as strings).
+ classRangeParameter + +
+          Models a parameter that can contain an integer value in a specified range.
+ classToggleParameter + +
+          Models a parameter that allows the toggling of a single value.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/data/class-use/ParlorCodes.html b/apidocs/com/threerings/parlor/data/class-use/ParlorCodes.html new file mode 100644 index 00000000..b44a3d94 --- /dev/null +++ b/apidocs/com/threerings/parlor/data/class-use/ParlorCodes.html @@ -0,0 +1,345 @@ + + + + + + + +Uses of Interface com.threerings.parlor.data.ParlorCodes (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.parlor.data.ParlorCodes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Packages that use ParlorCodes
com.threerings.parlor.card.server  
com.threerings.parlor.client  
com.threerings.parlor.data  
com.threerings.parlor.game.server  
com.threerings.parlor.server  
com.threerings.puzzle.server  
+  +

+ + + + + +
+Uses of ParlorCodes in com.threerings.parlor.card.server
+  +

+ + + + + + + + + +
Classes in com.threerings.parlor.card.server that implement ParlorCodes
+ classCardGameManager + +
+          A manager class for card games.
+  +

+ + + + + +
+Uses of ParlorCodes in com.threerings.parlor.client
+  +

+ + + + + + + + + + + + + +
Classes in com.threerings.parlor.client that implement ParlorCodes
+ classInvitation + +
+          The invitation class is used to track information related to + outstanding invitations generated by or targeted to this client.
+ classParlorDirector + +
+          The parlor director manages the client side of the game configuration and matchmaking + processes.
+  +

+ + + + + +
+Uses of ParlorCodes in com.threerings.parlor.data
+  +

+ + + + + + + + + +
Classes in com.threerings.parlor.data that implement ParlorCodes
+ classTable + +
+          This class represents a table that is being used to matchmake a game by the Parlor services.
+  +

+ + + + + +
+Uses of ParlorCodes in com.threerings.parlor.game.server
+  +

+ + + + + + + + + +
Classes in com.threerings.parlor.game.server that implement ParlorCodes
+ classGameManager + +
+          The game manager handles the server side management of a game.
+  +

+ + + + + +
+Uses of ParlorCodes in com.threerings.parlor.server
+  +

+ + + + + + + + + + + + + +
Classes in com.threerings.parlor.server that implement ParlorCodes
+ classParlorManager + +
+          The parlor manager is responsible for the parlor services in aggregate.
+ classTableManager + +
+          A table manager can be used by a place manager (or other entity) to take care of the management + of a table matchmaking service on a particular distributed object.
+  +

+ + + + + +
+Uses of ParlorCodes in com.threerings.puzzle.server
+  +

+ + + + + + + + + +
Classes in com.threerings.puzzle.server that implement ParlorCodes
+ classPuzzleManager + +
+          Extends the GameManager with facilities for puzzle games.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/data/class-use/ParlorMarshaller.InviteMarshaller.html b/apidocs/com/threerings/parlor/data/class-use/ParlorMarshaller.InviteMarshaller.html new file mode 100644 index 00000000..c12c5f07 --- /dev/null +++ b/apidocs/com/threerings/parlor/data/class-use/ParlorMarshaller.InviteMarshaller.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.parlor.data.ParlorMarshaller.InviteMarshaller (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.data.ParlorMarshaller.InviteMarshaller

+
+No usage of com.threerings.parlor.data.ParlorMarshaller.InviteMarshaller +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/data/class-use/ParlorMarshaller.html b/apidocs/com/threerings/parlor/data/class-use/ParlorMarshaller.html new file mode 100644 index 00000000..5e1dfbf9 --- /dev/null +++ b/apidocs/com/threerings/parlor/data/class-use/ParlorMarshaller.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.parlor.data.ParlorMarshaller (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.data.ParlorMarshaller

+
+No usage of com.threerings.parlor.data.ParlorMarshaller +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/data/class-use/RangeParameter.html b/apidocs/com/threerings/parlor/data/class-use/RangeParameter.html new file mode 100644 index 00000000..f4d1d821 --- /dev/null +++ b/apidocs/com/threerings/parlor/data/class-use/RangeParameter.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.parlor.data.RangeParameter (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.data.RangeParameter

+
+No usage of com.threerings.parlor.data.RangeParameter +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/data/class-use/Table.html b/apidocs/com/threerings/parlor/data/class-use/Table.html new file mode 100644 index 00000000..bd35a686 --- /dev/null +++ b/apidocs/com/threerings/parlor/data/class-use/Table.html @@ -0,0 +1,504 @@ + + + + + + + +Uses of Class com.threerings.parlor.data.Table (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.data.Table

+
+ + + + + + + + + + + + + + + + + + + + + +
+Packages that use Table
com.threerings.micasa.lobby.table  
com.threerings.parlor.client  
com.threerings.parlor.data  
com.threerings.parlor.server  
+  +

+ + + + + +
+Uses of Table in com.threerings.micasa.lobby.table
+  +

+ + + + + + + + + +
Fields in com.threerings.micasa.lobby.table declared as Table
+ TableTableItem.table + +
+          A reference to the table we are displaying.
+  +

+ + + + + + + + + +
Fields in com.threerings.micasa.lobby.table with type parameters of type Table
+ com.threerings.presents.dobj.DSet<Table>TableLobbyObject.tableSet + +
+          A set containing all of the tables being managed by this lobby.
+  +

+ + + + + + + + + +
Methods in com.threerings.micasa.lobby.table that return types with arguments of type Table
+ com.threerings.presents.dobj.DSet<Table>TableLobbyObject.getTables() + +
+           
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in com.threerings.micasa.lobby.table with parameters of type Table
+ voidTableLobbyObject.addToTables(Table table) + +
+           
+ voidTableLobbyObject.addToTableSet(Table elem) + +
+          Requests that the specified entry be added to the + tableSet set.
+ voidTableListView.tableAdded(Table table) + +
+           
+ voidTableListView.tableUpdated(Table table) + +
+           
+ voidTableItem.tableUpdated(Table table) + +
+          Called when our table has been updated and we need to update the UI + to reflect the new information.
+ voidTableLobbyObject.updateTables(Table table) + +
+           
+ voidTableLobbyObject.updateTableSet(Table elem) + +
+          Requests that the specified entry be updated in the + tableSet set.
+  +

+ + + + + + + + + +
Method parameters in com.threerings.micasa.lobby.table with type arguments of type Table
+ voidTableLobbyObject.setTableSet(com.threerings.presents.dobj.DSet<Table> value) + +
+          Requests that the tableSet field be set to the + specified value.
+  +

+ + + + + + + + +
Constructors in com.threerings.micasa.lobby.table with parameters of type Table
TableItem(MiCasaContext ctx, + TableDirector tdtr, + Table table) + +
+          Creates a new table item to display and interact with the supplied + table.
+  +

+ + + + + +
+Uses of Table in com.threerings.parlor.client
+  +

+ + + + + + + + + +
Methods in com.threerings.parlor.client that return Table
+ TableTableDirector.getSeatedTable() + +
+          Returns the current table this client is seated at, or null.
+  +

+ + + + + + + + + + + + + +
Methods in com.threerings.parlor.client with parameters of type Table
+ voidTableObserver.tableAdded(Table table) + +
+          Called when a new table is created.
+ voidTableObserver.tableUpdated(Table table) + +
+          Called when something has changed about a table (occupant list + updated, state changed from matchmaking to in-play, etc.).
+  +

+ + + + + + + + + + + + + + + + + +
Method parameters in com.threerings.parlor.client with type arguments of type Table
+ voidTableDirector.entryAdded(com.threerings.presents.dobj.EntryAddedEvent<Table> event) + +
+           
+ voidTableDirector.entryRemoved(com.threerings.presents.dobj.EntryRemovedEvent<Table> event) + +
+           
+ voidTableDirector.entryUpdated(com.threerings.presents.dobj.EntryUpdatedEvent<Table> event) + +
+           
+  +

+ + + + + +
+Uses of Table in com.threerings.parlor.data
+  +

+ + + + + + + + + +
Methods in com.threerings.parlor.data that return types with arguments of type Table
+ com.threerings.presents.dobj.DSet<Table>TableLobbyObject.getTables() + +
+          Returns a reference to the distributed set instance that will be + holding the tables.
+  +

+ + + + + + + + + + + + + +
Methods in com.threerings.parlor.data with parameters of type Table
+ voidTableLobbyObject.addToTables(Table table) + +
+          Adds the supplied table instance to the tables set (using the + appropriate distributed object mechanisms).
+ voidTableLobbyObject.updateTables(Table table) + +
+          Updates the value of the specified table instance in the tables + distributed set (using the appropriate distributed object + mechanisms).
+  +

+ + + + + +
+Uses of Table in com.threerings.parlor.server
+  +

+ + + + + + + + + +
Methods in com.threerings.parlor.server that return Table
+ TableTableManager.createTable(com.threerings.crowd.data.BodyObject creator, + TableConfig tableConfig, + GameConfig config) + +
+          Creates a table for the specified creator and returns said table.
+  +

+ + + + + + + + + +
Method parameters in com.threerings.parlor.server with type arguments of type Table
+ voidTableManager.setTableClass(Class<? extends Table> tableClass) + +
+          Set the subclass of Table that this instance should generate.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/data/class-use/TableConfig.html b/apidocs/com/threerings/parlor/data/class-use/TableConfig.html new file mode 100644 index 00000000..183f12b5 --- /dev/null +++ b/apidocs/com/threerings/parlor/data/class-use/TableConfig.html @@ -0,0 +1,328 @@ + + + + + + + +Uses of Class com.threerings.parlor.data.TableConfig (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.data.TableConfig

+
+ + + + + + + + + + + + + + + + + +
+Packages that use TableConfig
com.threerings.parlor.client  
com.threerings.parlor.data  
com.threerings.parlor.server  
+  +

+ + + + + +
+Uses of TableConfig in com.threerings.parlor.client
+  +

+ + + + + + + + + +
Methods in com.threerings.parlor.client that return TableConfig
+ TableConfigTableConfigurator.getTableConfig() + +
+          Return the fully configured table config according to the currently + configured user interface elements.
+  +

+ + + + + + + + + + + + + + + + + +
Methods in com.threerings.parlor.client with parameters of type TableConfig
+ voidTableDirector.createTable(TableConfig tableConfig, + GameConfig config) + +
+          Sends a request to create a table with the specified game configuration.
+ voidTableService.createTable(TableConfig tableConfig, + GameConfig config, + com.threerings.presents.client.InvocationService.ResultListener listener) + +
+          Requests that a new table be created.
+ voidTableConfigurator.setTableConfig(TableConfig config) + +
+          Optionally, you can set a pre-configured TableConfig + that will be used to initialize the display parameters (if possible).
+  +

+ + + + + +
+Uses of TableConfig in com.threerings.parlor.data
+  +

+ + + + + + + + + +
Fields in com.threerings.parlor.data declared as TableConfig
+ TableConfigTable.tconfig + +
+          The table configuration object.
+  +

+ + + + + + + + + + + + + +
Methods in com.threerings.parlor.data with parameters of type TableConfig
+ voidTableMarshaller.createTable(TableConfig arg1, + GameConfig arg2, + com.threerings.presents.client.InvocationService.ResultListener arg3) + +
+           
+ voidTable.init(int lobbyOid, + TableConfig tconfig, + GameConfig config) + +
+          Initializes a new table instance, and assigns it the next monotonically increasing table id.
+  +

+ + + + + +
+Uses of TableConfig in com.threerings.parlor.server
+  +

+ + + + + + + + + + + + + + + + + +
Methods in com.threerings.parlor.server with parameters of type TableConfig
+ TableTableManager.createTable(com.threerings.crowd.data.BodyObject creator, + TableConfig tableConfig, + GameConfig config) + +
+          Creates a table for the specified creator and returns said table.
+ voidTableProvider.createTable(com.threerings.presents.data.ClientObject caller, + TableConfig arg1, + GameConfig arg2, + com.threerings.presents.client.InvocationService.ResultListener arg3) + +
+          Handles a TableService.createTable(com.threerings.parlor.data.TableConfig, com.threerings.parlor.game.data.GameConfig, com.threerings.presents.client.InvocationService.ResultListener) request.
+ voidTableManager.createTable(com.threerings.presents.data.ClientObject caller, + TableConfig tableConfig, + GameConfig config, + com.threerings.presents.client.InvocationService.ResultListener listener) + +
+           
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/data/class-use/TableLobbyObject.html b/apidocs/com/threerings/parlor/data/class-use/TableLobbyObject.html new file mode 100644 index 00000000..defea0ec --- /dev/null +++ b/apidocs/com/threerings/parlor/data/class-use/TableLobbyObject.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Interface com.threerings.parlor.data.TableLobbyObject (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.parlor.data.TableLobbyObject

+
+ + + + + + + + + +
+Packages that use TableLobbyObject
com.threerings.micasa.lobby.table  
+  +

+ + + + + +
+Uses of TableLobbyObject in com.threerings.micasa.lobby.table
+  +

+ + + + + + + + + +
Classes in com.threerings.micasa.lobby.table that implement TableLobbyObject
+ classTableLobbyObject + +
+           
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/data/class-use/TableMarshaller.html b/apidocs/com/threerings/parlor/data/class-use/TableMarshaller.html new file mode 100644 index 00000000..8608fc46 --- /dev/null +++ b/apidocs/com/threerings/parlor/data/class-use/TableMarshaller.html @@ -0,0 +1,260 @@ + + + + + + + +Uses of Class com.threerings.parlor.data.TableMarshaller (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.data.TableMarshaller

+
+ + + + + + + + + + + + + +
+Packages that use TableMarshaller
com.threerings.micasa.lobby.table  
com.threerings.parlor.data  
+  +

+ + + + + +
+Uses of TableMarshaller in com.threerings.micasa.lobby.table
+  +

+ + + + + + + + + +
Fields in com.threerings.micasa.lobby.table declared as TableMarshaller
+ TableMarshallerTableLobbyObject.tableService + +
+          Handles our table services.
+  +

+ + + + + + + + + +
Methods in com.threerings.micasa.lobby.table that return TableMarshaller
+ TableMarshallerTableLobbyObject.getTableService() + +
+           
+  +

+ + + + + + + + + +
Methods in com.threerings.micasa.lobby.table with parameters of type TableMarshaller
+ voidTableLobbyObject.setTableService(TableMarshaller value) + +
+          Requests that the tableService field be set to the + specified value.
+  +

+ + + + + +
+Uses of TableMarshaller in com.threerings.parlor.data
+  +

+ + + + + + + + + +
Methods in com.threerings.parlor.data that return TableMarshaller
+ TableMarshallerTableLobbyObject.getTableService() + +
+          Returns a reference to the table service configured in this object.
+  +

+ + + + + + + + + +
Methods in com.threerings.parlor.data with parameters of type TableMarshaller
+ voidTableLobbyObject.setTableService(TableMarshaller service) + +
+          Configures the table service that clients should use to communicate table requests back to + the table manager handling these tables.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/data/class-use/ToggleParameter.html b/apidocs/com/threerings/parlor/data/class-use/ToggleParameter.html new file mode 100644 index 00000000..0d31c237 --- /dev/null +++ b/apidocs/com/threerings/parlor/data/class-use/ToggleParameter.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.parlor.data.ToggleParameter (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.data.ToggleParameter

+
+No usage of com.threerings.parlor.data.ToggleParameter +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/data/package-frame.html b/apidocs/com/threerings/parlor/data/package-frame.html new file mode 100644 index 00000000..6fd3c346 --- /dev/null +++ b/apidocs/com/threerings/parlor/data/package-frame.html @@ -0,0 +1,62 @@ + + + + + + + +com.threerings.parlor.data (vilya 1.3 API) + + + + + + + + + + + +com.threerings.parlor.data + + + + +
+Interfaces  + +
+ParlorCodes +
+TableLobbyObject
+ + + + + + +
+Classes  + +
+ChoiceParameter +
+Parameter +
+ParlorMarshaller +
+ParlorMarshaller.InviteMarshaller +
+RangeParameter +
+Table +
+TableConfig +
+TableMarshaller +
+ToggleParameter
+ + + + diff --git a/apidocs/com/threerings/parlor/data/package-summary.html b/apidocs/com/threerings/parlor/data/package-summary.html new file mode 100644 index 00000000..af6d5413 --- /dev/null +++ b/apidocs/com/threerings/parlor/data/package-summary.html @@ -0,0 +1,213 @@ + + + + + + + +com.threerings.parlor.data (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.parlor.data +

+ + + + + + + + + + + + + +
+Interface Summary
ParlorCodesContains codes used by the parlor invocation services.
TableLobbyObjectThis interface must be implemented by the place object used by a lobby + that wishes to make use of the table services.
+  + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Class Summary
ChoiceParameterModels a parameter that allows the selection of one of a list of choices (specified as strings).
ParameterDefines a configuration parameter for a game.
ParlorMarshallerProvides the implementation of the ParlorService interface + that marshalls the arguments and delivers the request to the provider + on the server.
ParlorMarshaller.InviteMarshallerMarshalls results to implementations of ParlorService.InviteListener.
RangeParameterModels a parameter that can contain an integer value in a specified range.
TableThis class represents a table that is being used to matchmake a game by the Parlor services.
TableConfigTable configuration parameters for a game that is to be matchmade using the table services.
TableMarshallerProvides the implementation of the TableService interface + that marshalls the arguments and delivers the request to the provider + on the server.
ToggleParameterModels a parameter that allows the toggling of a single value.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/data/package-tree.html b/apidocs/com/threerings/parlor/data/package-tree.html new file mode 100644 index 00000000..4b5c90fd --- /dev/null +++ b/apidocs/com/threerings/parlor/data/package-tree.html @@ -0,0 +1,177 @@ + + + + + + + +com.threerings.parlor.data Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.parlor.data +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/data/package-use.html b/apidocs/com/threerings/parlor/data/package-use.html new file mode 100644 index 00000000..e0c55b41 --- /dev/null +++ b/apidocs/com/threerings/parlor/data/package-use.html @@ -0,0 +1,336 @@ + + + + + + + +Uses of Package com.threerings.parlor.data (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.parlor.data

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Packages that use com.threerings.parlor.data
com.threerings.micasa.lobby.table  
com.threerings.parlor.card.server  
com.threerings.parlor.client  
com.threerings.parlor.data  
com.threerings.parlor.game.server  
com.threerings.parlor.server  
com.threerings.puzzle.server  
+  +

+ + + + + + + + + + + + + + +
+Classes in com.threerings.parlor.data used by com.threerings.micasa.lobby.table
Table + +
+          This class represents a table that is being used to matchmake a game by the Parlor services.
TableLobbyObject + +
+          This interface must be implemented by the place object used by a lobby + that wishes to make use of the table services.
TableMarshaller + +
+          Provides the implementation of the TableService interface + that marshalls the arguments and delivers the request to the provider + on the server.
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.data used by com.threerings.parlor.card.server
ParlorCodes + +
+          Contains codes used by the parlor invocation services.
+  +

+ + + + + + + + + + + + + + +
+Classes in com.threerings.parlor.data used by com.threerings.parlor.client
ParlorCodes + +
+          Contains codes used by the parlor invocation services.
Table + +
+          This class represents a table that is being used to matchmake a game by the Parlor services.
TableConfig + +
+          Table configuration parameters for a game that is to be matchmade using the table services.
+  +

+ + + + + + + + + + + + + + +
+Classes in com.threerings.parlor.data used by com.threerings.parlor.data
Parameter + +
+          Defines a configuration parameter for a game.
ParlorCodes + +
+          Contains codes used by the parlor invocation services.
TableConfig + +
+          Table configuration parameters for a game that is to be matchmade using the table services.
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.data used by com.threerings.parlor.game.server
ParlorCodes + +
+          Contains codes used by the parlor invocation services.
+  +

+ + + + + + + + + + + + + + +
+Classes in com.threerings.parlor.data used by com.threerings.parlor.server
ParlorCodes + +
+          Contains codes used by the parlor invocation services.
Table + +
+          This class represents a table that is being used to matchmake a game by the Parlor services.
TableConfig + +
+          Table configuration parameters for a game that is to be matchmade using the table services.
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.data used by com.threerings.puzzle.server
ParlorCodes + +
+          Contains codes used by the parlor invocation services.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/game/client/GameConfigurator.html b/apidocs/com/threerings/parlor/game/client/GameConfigurator.html new file mode 100644 index 00000000..ea5a6dcd --- /dev/null +++ b/apidocs/com/threerings/parlor/game/client/GameConfigurator.html @@ -0,0 +1,312 @@ + + + + + + + +GameConfigurator (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.game.client +
+Class GameConfigurator

+
+java.lang.Object
+  extended by com.threerings.parlor.game.client.GameConfigurator
+
+
+
Direct Known Subclasses:
SwingGameConfigurator
+
+
+
+
public abstract class GameConfigurator
extends Object
+ + +

+Provides the base from which interfaces can be built to configure games prior to starting + them. Derived classes would extend the base configurator adding interface elements and wiring + them up properly to allow the user to configure an instance of their game. + +

Clients that use the game configurator will want to instantiate one based on the class + returned from the GameConfig and then initialize it with a call to init(com.threerings.parlor.util.ParlorContext). +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
GameConfigurator() + +
+           
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ GameConfiggetGameConfig() + +
+          Obtains a configured game configuration.
+ voidinit(ParlorContext ctx) + +
+          Initializes this game configurator, creates its user interface elements and prepares it for + display.
+ voidsetGameConfig(GameConfig config) + +
+          Provides this configurator with its configuration.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+GameConfigurator

+
+public GameConfigurator()
+
+
+ + + + + + + + +
+Method Detail
+ +

+init

+
+public void init(ParlorContext ctx)
+
+
Initializes this game configurator, creates its user interface elements and prepares it for + display. +

+

+
+
+
+
+ +

+setGameConfig

+
+public void setGameConfig(GameConfig config)
+
+
Provides this configurator with its configuration. It should set up all of its user + interface elements to reflect the configuration. +

+

+
+
+
+
+ +

+getGameConfig

+
+public GameConfig getGameConfig()
+
+
Obtains a configured game configuration. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/game/client/GameController.html b/apidocs/com/threerings/parlor/game/client/GameController.html new file mode 100644 index 00000000..fd41e232 --- /dev/null +++ b/apidocs/com/threerings/parlor/game/client/GameController.html @@ -0,0 +1,587 @@ + + + + + + + +GameController (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.game.client +
+Class GameController

+
+java.lang.Object
+  extended by com.samskivert.swing.Controller
+      extended by com.threerings.crowd.client.PlaceController
+          extended by com.threerings.parlor.game.client.GameController
+
+
+
All Implemented Interfaces:
com.threerings.presents.dobj.AttributeChangeListener, com.threerings.presents.dobj.ChangeListener, ActionListener, EventListener
+
+
+
Direct Known Subclasses:
CardGameController, PuzzleController
+
+
+
+
public abstract class GameController
extends com.threerings.crowd.client.PlaceController
implements com.threerings.presents.dobj.AttributeChangeListener
+ + +

+The game controller manages the flow and control of a game on the client side. This class serves + as the root of a hierarchy of controller classes that aim to provide functionality shared + between various similar games. The base controller provides functionality for starting and + ending the game and for calculating ratings adjustements when a game ends normally. It also + handles the basic house keeping like subscription to the game object and dispatch of commands + and distributed object events. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.crowd.client.PlaceController
com.threerings.crowd.client.PlaceController.DelegateOp
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class com.samskivert.swing.Controller
DISPATCHER
+  + + + + + + + + + + +
+Constructor Summary
GameController() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidattributeChanged(com.threerings.presents.dobj.AttributeChangedEvent event) + +
+           
+ voiddidLeavePlace(com.threerings.crowd.data.PlaceObject plobj) + +
+          Removes our listener registration from the game object and cleans house.
+ intgetMatchType() + +
+          Convenience method to determine the type of game.
+ intgetSessionId() + +
+          Returns the unique session identifier for the current gameplay session.
+ booleanhandleAction(ActionEvent action) + +
+          Handles basic game controller action events.
+ voidinit(com.threerings.crowd.util.CrowdContext ctx, + com.threerings.crowd.data.PlaceConfig config) + +
+          Initializes this game controller with the game configuration that was established during the + match making process.
+ booleanisGameOver() + +
+          Returns whether the game is over.
+ voidresetGame() + +
+          Calls gameWillReset(), ends the current game (locally, it does not tell the server to + end the game), and waits to receive a reset notification (which is simply an event setting + the game state to IN_PLAY even though it's already set to IN_PLAY) + from the server which will start up a new game.
+ voidsetGameOver(boolean gameOver) + +
+          Sets the client game over override.
+ voidsystemMessage(String bundle, + String msg) + +
+          A way for controllers to display a game-related system message.
+ voidwillEnterPlace(com.threerings.crowd.data.PlaceObject plobj) + +
+          Adds this controller as a listener to the game object (thus derived classes need not do so) + and lets the game manager know that we are now ready to go.
+  + + + + + + + +
Methods inherited from class com.threerings.crowd.client.PlaceController
getPlaceConfig, getPlaceView, mayLeavePlace
+  + + + + + + + +
Methods inherited from class com.samskivert.swing.Controller
actionPerformed, configureAction, createActionButton, handleAction, handleAction, handleAction, postAction, postAction, postAction, setControlledPanel, wasAdded, wasRemoved
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+GameController

+
+public GameController()
+
+
+ + + + + + + + +
+Method Detail
+ +

+init

+
+public void init(com.threerings.crowd.util.CrowdContext ctx,
+                 com.threerings.crowd.data.PlaceConfig config)
+
+
Initializes this game controller with the game configuration that was established during the + match making process. Derived classes may want to override this method to initialize + themselves with game-specific configuration parameters but they should be sure to call + super.init in such cases. +

+

+
Overrides:
init in class com.threerings.crowd.client.PlaceController
+
+
+
Parameters:
ctx - the client context.
config - the configuration of the game we are intended to + control.
+
+
+
+ +

+willEnterPlace

+
+public void willEnterPlace(com.threerings.crowd.data.PlaceObject plobj)
+
+
Adds this controller as a listener to the game object (thus derived classes need not do so) + and lets the game manager know that we are now ready to go. +

+

+
Overrides:
willEnterPlace in class com.threerings.crowd.client.PlaceController
+
+
+
+
+
+
+ +

+didLeavePlace

+
+public void didLeavePlace(com.threerings.crowd.data.PlaceObject plobj)
+
+
Removes our listener registration from the game object and cleans house. +

+

+
Overrides:
didLeavePlace in class com.threerings.crowd.client.PlaceController
+
+
+
+
+
+
+ +

+getMatchType

+
+public int getMatchType()
+
+
Convenience method to determine the type of game. +

+

+
+
+
+
+
+
+
+ +

+isGameOver

+
+public boolean isGameOver()
+
+
Returns whether the game is over. +

+

+
+
+
+
+
+
+
+ +

+setGameOver

+
+public void setGameOver(boolean gameOver)
+
+
Sets the client game over override. This is used in situations where we determine that the + game is over before the server has informed us of such. +

+

+
+
+
+
+
+
+
+ +

+resetGame

+
+public void resetGame()
+
+
Calls gameWillReset(), ends the current game (locally, it does not tell the server to + end the game), and waits to receive a reset notification (which is simply an event setting + the game state to IN_PLAY even though it's already set to IN_PLAY) + from the server which will start up a new game. Derived classes should override gameWillReset() to perform any game-specific animations. +

+

+
+
+
+
+
+
+
+ +

+getSessionId

+
+public int getSessionId()
+
+
Returns the unique session identifier for the current gameplay session. +

+

+
+
+
+
+
+
+
+ +

+handleAction

+
+public boolean handleAction(ActionEvent action)
+
+
Handles basic game controller action events. Derived classes should be sure to call + super.handleAction for events they don't specifically handle. +

+

+
Overrides:
handleAction in class com.threerings.crowd.client.PlaceController
+
+
+
+
+
+
+ +

+systemMessage

+
+public void systemMessage(String bundle,
+                          String msg)
+
+
A way for controllers to display a game-related system message. +

+

+
+
+
+
+
+
+
+ +

+attributeChanged

+
+public void attributeChanged(com.threerings.presents.dobj.AttributeChangedEvent event)
+
+
+
Specified by:
attributeChanged in interface com.threerings.presents.dobj.AttributeChangeListener
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/game/client/GameControllerDelegate.html b/apidocs/com/threerings/parlor/game/client/GameControllerDelegate.html new file mode 100644 index 00000000..fa987ea9 --- /dev/null +++ b/apidocs/com/threerings/parlor/game/client/GameControllerDelegate.html @@ -0,0 +1,350 @@ + + + + + + + +GameControllerDelegate (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.game.client +
+Class GameControllerDelegate

+
+java.lang.Object
+  extended by com.threerings.crowd.client.PlaceControllerDelegate
+      extended by com.threerings.parlor.game.client.GameControllerDelegate
+
+
+
Direct Known Subclasses:
PuzzleControllerDelegate, TurnGameControllerDelegate
+
+
+
+
public class GameControllerDelegate
extends com.threerings.crowd.client.PlaceControllerDelegate
+ + +

+Extends the PlaceControllerDelegate mechanism with game + controller specific methods. +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
GameControllerDelegate(GameController ctrl) + +
+          Provides the delegate with a reference to the game controller for + which it is delegating.
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidgameDidEnd() + +
+          Called when the game transitions to the GAME_OVER + state.
+ voidgameDidStart() + +
+          Called when the game transitions to the IN_PLAY + state.
+ voidgameWasCancelled() + +
+          Called when the game was cancelled for some reason.
+ voidgameWillReset() + +
+          Called to give derived classes a chance to display animations, send + a final packet, or do any other business they care to do when the + game is about to reset.
+  + + + + + + + +
Methods inherited from class com.threerings.crowd.client.PlaceControllerDelegate
didLeavePlace, handleAction, init, mayLeavePlace, willEnterPlace
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+GameControllerDelegate

+
+public GameControllerDelegate(GameController ctrl)
+
+
Provides the delegate with a reference to the game controller for + which it is delegating. +

+

+ + + + + + + + +
+Method Detail
+ +

+gameDidStart

+
+public void gameDidStart()
+
+
Called when the game transitions to the IN_PLAY + state. This happens when all of the players have arrived and the + server starts the game. +

+

+
+
+
+
+ +

+gameDidEnd

+
+public void gameDidEnd()
+
+
Called when the game transitions to the GAME_OVER + state. This happens when the game reaches some end condition by + normal means (is not cancelled or aborted). +

+

+
+
+
+
+ +

+gameWasCancelled

+
+public void gameWasCancelled()
+
+
Called when the game was cancelled for some reason. +

+

+
+
+
+
+ +

+gameWillReset

+
+public void gameWillReset()
+
+
Called to give derived classes a chance to display animations, send + a final packet, or do any other business they care to do when the + game is about to reset. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/game/client/SwingGameConfigurator.html b/apidocs/com/threerings/parlor/game/client/SwingGameConfigurator.html new file mode 100644 index 00000000..a7becd33 --- /dev/null +++ b/apidocs/com/threerings/parlor/game/client/SwingGameConfigurator.html @@ -0,0 +1,329 @@ + + + + + + + +SwingGameConfigurator (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.game.client +
+Class SwingGameConfigurator

+
+java.lang.Object
+  extended by com.threerings.parlor.game.client.GameConfigurator
+      extended by com.threerings.parlor.game.client.SwingGameConfigurator
+
+
+
+
public abstract class SwingGameConfigurator
extends GameConfigurator
+ + +

+Provides the base from which interfaces can be built to configure games + prior to starting them. Derived classes would extend the base + configurator adding interface elements and wiring them up properly to + allow the user to configure an instance of their game. + +

Clients that use the game configurator will want to instantiate one + based on the class returned from the GameConfig and then + initialize it with a call to GameConfigurator.init(com.threerings.parlor.util.ParlorContext). +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
SwingGameConfigurator() + +
+           
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidaddControl(JComponent label, + JComponent control) + +
+          Add a control to the interface.
+ voidaddWideControl(JComponent control) + +
+          Add a control to the interface.
+ JPanelgetPanel() + +
+          Get the Swing JPanel that contains the UI elements for this configurator.
+  + + + + + + + +
Methods inherited from class com.threerings.parlor.game.client.GameConfigurator
getGameConfig, init, setGameConfig
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+SwingGameConfigurator

+
+public SwingGameConfigurator()
+
+
+ + + + + + + + +
+Method Detail
+ +

+getPanel

+
+public JPanel getPanel()
+
+
Get the Swing JPanel that contains the UI elements for this configurator. +

+

+
+
+
+
+ +

+addControl

+
+public void addControl(JComponent label,
+                       JComponent control)
+
+
Add a control to the interface. This should be the standard way + that configurator controls are added, but note also that external + entities may add their own controls that are related to the game, + but do not directly alter the game config, so that all the controls + are added in a uniform manner and are well aligned. +

+

+
+
+
+
+ +

+addWideControl

+
+public void addWideControl(JComponent control)
+
+
Add a control to the interface. This should be the standard way + that configurator controls are added, but note also that external + entities may add their own controls that are related to the game, + but do not directly alter the game config, so that all the controls + are added in a uniform manner and are well aligned. This version adds + a single component spanning the entire width. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/game/client/class-use/GameConfigurator.html b/apidocs/com/threerings/parlor/game/client/class-use/GameConfigurator.html new file mode 100644 index 00000000..e1b4dfe8 --- /dev/null +++ b/apidocs/com/threerings/parlor/game/client/class-use/GameConfigurator.html @@ -0,0 +1,242 @@ + + + + + + + +Uses of Class com.threerings.parlor.game.client.GameConfigurator (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.game.client.GameConfigurator

+
+ + + + + + + + + + + + + + + + + +
+Packages that use GameConfigurator
com.threerings.parlor.client  
com.threerings.parlor.game.client  
com.threerings.parlor.game.data  
+  +

+ + + + + +
+Uses of GameConfigurator in com.threerings.parlor.client
+  +

+ + + + + + + + + +
Methods in com.threerings.parlor.client with parameters of type GameConfigurator
+ voidTableConfigurator.init(ParlorContext ctx, + GameConfigurator gameConfigurator) + +
+          Initialize the TableConfigurator.
+  +

+ + + + + +
+Uses of GameConfigurator in com.threerings.parlor.game.client
+  +

+ + + + + + + + + +
Subclasses of GameConfigurator in com.threerings.parlor.game.client
+ classSwingGameConfigurator + +
+          Provides the base from which interfaces can be built to configure games + prior to starting them.
+  +

+ + + + + +
+Uses of GameConfigurator in com.threerings.parlor.game.data
+  +

+ + + + + + + + + +
Methods in com.threerings.parlor.game.data that return GameConfigurator
+ GameConfiguratorGameConfig.createConfigurator() + +
+          Creates a configurator that can be used to create a user interface for configuring this + instance prior to starting the game.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/game/client/class-use/GameController.html b/apidocs/com/threerings/parlor/game/client/class-use/GameController.html new file mode 100644 index 00000000..6e5dcb79 --- /dev/null +++ b/apidocs/com/threerings/parlor/game/client/class-use/GameController.html @@ -0,0 +1,238 @@ + + + + + + + +Uses of Class com.threerings.parlor.game.client.GameController (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.game.client.GameController

+
+ + + + + + + + + + + + + + + + + +
+Packages that use GameController
com.threerings.parlor.card.client  
com.threerings.parlor.game.client  
com.threerings.puzzle.client  
+  +

+ + + + + +
+Uses of GameController in com.threerings.parlor.card.client
+  +

+ + + + + + + + + +
Subclasses of GameController in com.threerings.parlor.card.client
+ classCardGameController + +
+          A controller class for card games.
+  +

+ + + + + +
+Uses of GameController in com.threerings.parlor.game.client
+  +

+ + + + + + + + +
Constructors in com.threerings.parlor.game.client with parameters of type GameController
GameControllerDelegate(GameController ctrl) + +
+          Provides the delegate with a reference to the game controller for + which it is delegating.
+  +

+ + + + + +
+Uses of GameController in com.threerings.puzzle.client
+  +

+ + + + + + + + + +
Subclasses of GameController in com.threerings.puzzle.client
+ classPuzzleController + +
+          The puzzle game controller handles logical actions for a puzzle game.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/game/client/class-use/GameControllerDelegate.html b/apidocs/com/threerings/parlor/game/client/class-use/GameControllerDelegate.html new file mode 100644 index 00000000..27a08868 --- /dev/null +++ b/apidocs/com/threerings/parlor/game/client/class-use/GameControllerDelegate.html @@ -0,0 +1,270 @@ + + + + + + + +Uses of Class com.threerings.parlor.game.client.GameControllerDelegate (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.game.client.GameControllerDelegate

+
+ + + + + + + + + + + + + + + + + + + + + +
+Packages that use GameControllerDelegate
com.threerings.parlor.card.trick.client  
com.threerings.parlor.turn.client  
com.threerings.puzzle.client  
com.threerings.puzzle.drop.client  
+  +

+ + + + + +
+Uses of GameControllerDelegate in com.threerings.parlor.card.trick.client
+  +

+ + + + + + + + + +
Subclasses of GameControllerDelegate in com.threerings.parlor.card.trick.client
+ classTrickCardGameControllerDelegate + +
+          A card game controller delegate for trick-based card games, such as Spades and Hearts.
+  +

+ + + + + +
+Uses of GameControllerDelegate in com.threerings.parlor.turn.client
+  +

+ + + + + + + + + +
Subclasses of GameControllerDelegate in com.threerings.parlor.turn.client
+ classTurnGameControllerDelegate + +
+          Performs the client-side processing for a turn-based game.
+  +

+ + + + + +
+Uses of GameControllerDelegate in com.threerings.puzzle.client
+  +

+ + + + + + + + + +
Subclasses of GameControllerDelegate in com.threerings.puzzle.client
+ classPuzzleControllerDelegate + +
+          A base class for puzzle controller delegates.
+  +

+ + + + + +
+Uses of GameControllerDelegate in com.threerings.puzzle.drop.client
+  +

+ + + + + + + + + +
Subclasses of GameControllerDelegate in com.threerings.puzzle.drop.client
+ classDropControllerDelegate + +
+          Games that wish to make use of the drop puzzle services will need to create an extension of + this delegate class, customizing it for their particular game and then adding it via + PlaceController.addDelegate(com.threerings.crowd.client.PlaceControllerDelegate).
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/game/client/class-use/SwingGameConfigurator.html b/apidocs/com/threerings/parlor/game/client/class-use/SwingGameConfigurator.html new file mode 100644 index 00000000..4fa1da5d --- /dev/null +++ b/apidocs/com/threerings/parlor/game/client/class-use/SwingGameConfigurator.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.parlor.game.client.SwingGameConfigurator (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.game.client.SwingGameConfigurator

+
+No usage of com.threerings.parlor.game.client.SwingGameConfigurator +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/game/client/package-frame.html b/apidocs/com/threerings/parlor/game/client/package-frame.html new file mode 100644 index 00000000..54789bc3 --- /dev/null +++ b/apidocs/com/threerings/parlor/game/client/package-frame.html @@ -0,0 +1,39 @@ + + + + + + + +com.threerings.parlor.game.client (vilya 1.3 API) + + + + + + + + + + + +com.threerings.parlor.game.client + + + + +
+Classes  + +
+GameConfigurator +
+GameController +
+GameControllerDelegate +
+SwingGameConfigurator
+ + + + diff --git a/apidocs/com/threerings/parlor/game/client/package-summary.html b/apidocs/com/threerings/parlor/game/client/package-summary.html new file mode 100644 index 00000000..df73b097 --- /dev/null +++ b/apidocs/com/threerings/parlor/game/client/package-summary.html @@ -0,0 +1,173 @@ + + + + + + + +com.threerings.parlor.game.client (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.parlor.game.client +

+ + + + + + + + + + + + + + + + + + + + + +
+Class Summary
GameConfiguratorProvides the base from which interfaces can be built to configure games prior to starting + them.
GameControllerThe game controller manages the flow and control of a game on the client side.
GameControllerDelegateExtends the PlaceControllerDelegate mechanism with game + controller specific methods.
SwingGameConfiguratorProvides the base from which interfaces can be built to configure games + prior to starting them.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/game/client/package-tree.html b/apidocs/com/threerings/parlor/game/client/package-tree.html new file mode 100644 index 00000000..1af5bcda --- /dev/null +++ b/apidocs/com/threerings/parlor/game/client/package-tree.html @@ -0,0 +1,164 @@ + + + + + + + +com.threerings.parlor.game.client Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.parlor.game.client +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/game/client/package-use.html b/apidocs/com/threerings/parlor/game/client/package-use.html new file mode 100644 index 00000000..eeb3f6d3 --- /dev/null +++ b/apidocs/com/threerings/parlor/game/client/package-use.html @@ -0,0 +1,323 @@ + + + + + + + +Uses of Package com.threerings.parlor.game.client (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.parlor.game.client

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Packages that use com.threerings.parlor.game.client
com.threerings.parlor.card.client  
com.threerings.parlor.card.trick.client  
com.threerings.parlor.client  
com.threerings.parlor.game.client  
com.threerings.parlor.game.data  
com.threerings.parlor.turn.client  
com.threerings.puzzle.client  
com.threerings.puzzle.drop.client  
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.game.client used by com.threerings.parlor.card.client
GameController + +
+          The game controller manages the flow and control of a game on the client side.
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.game.client used by com.threerings.parlor.card.trick.client
GameControllerDelegate + +
+          Extends the PlaceControllerDelegate mechanism with game + controller specific methods.
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.game.client used by com.threerings.parlor.client
GameConfigurator + +
+          Provides the base from which interfaces can be built to configure games prior to starting + them.
+  +

+ + + + + + + + + + + +
+Classes in com.threerings.parlor.game.client used by com.threerings.parlor.game.client
GameConfigurator + +
+          Provides the base from which interfaces can be built to configure games prior to starting + them.
GameController + +
+          The game controller manages the flow and control of a game on the client side.
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.game.client used by com.threerings.parlor.game.data
GameConfigurator + +
+          Provides the base from which interfaces can be built to configure games prior to starting + them.
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.game.client used by com.threerings.parlor.turn.client
GameControllerDelegate + +
+          Extends the PlaceControllerDelegate mechanism with game + controller specific methods.
+  +

+ + + + + + + + + + + +
+Classes in com.threerings.parlor.game.client used by com.threerings.puzzle.client
GameController + +
+          The game controller manages the flow and control of a game on the client side.
GameControllerDelegate + +
+          Extends the PlaceControllerDelegate mechanism with game + controller specific methods.
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.game.client used by com.threerings.puzzle.drop.client
GameControllerDelegate + +
+          Extends the PlaceControllerDelegate mechanism with game + controller specific methods.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/game/data/GameAI.html b/apidocs/com/threerings/parlor/game/data/GameAI.html new file mode 100644 index 00000000..d0b56711 --- /dev/null +++ b/apidocs/com/threerings/parlor/game/data/GameAI.html @@ -0,0 +1,343 @@ + + + + + + + +GameAI (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.game.data +
+Class GameAI

+
+java.lang.Object
+  extended by com.threerings.io.SimpleStreamableObject
+      extended by com.threerings.parlor.game.data.GameAI
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable
+
+
+
+
public class GameAI
extends com.threerings.io.SimpleStreamableObject
+ + +

+Represents attributes of an AI player. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + + + + + +
+Field Summary
+ intpersonality + +
+          The "personality" of the AI, which can be interpreted by + each puzzle.
+ intskill + +
+          The skill level of the AI.
+  + + + + + + + + + + + + + +
+Constructor Summary
GameAI() + +
+          A blank constructor for serialization.
GameAI(int personality, + int skill) + +
+          Constructs an AI with the specified (game-interpreted) skill and + personality.
+  + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from class com.threerings.io.SimpleStreamableObject
toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+personality

+
+public int personality
+
+
The "personality" of the AI, which can be interpreted by + each puzzle. +

+

+
+
+
+ +

+skill

+
+public int skill
+
+
The skill level of the AI. +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+GameAI

+
+public GameAI()
+
+
A blank constructor for serialization. +

+

+
+ +

+GameAI

+
+public GameAI(int personality,
+              int skill)
+
+
Constructs an AI with the specified (game-interpreted) skill and + personality. +

+

+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/game/data/GameCodes.html b/apidocs/com/threerings/parlor/game/data/GameCodes.html new file mode 100644 index 00000000..93978040 --- /dev/null +++ b/apidocs/com/threerings/parlor/game/data/GameCodes.html @@ -0,0 +1,290 @@ + + + + + + + +GameCodes (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.game.data +
+Interface GameCodes

+
+
All Superinterfaces:
com.threerings.presents.data.InvocationCodes
+
+
+
All Known Implementing Classes:
CardGameManager, GameManager, PuzzleManager
+
+
+
+
public interface GameCodes
extends com.threerings.presents.data.InvocationCodes
+ + +

+Constants relating to the game services. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static StringGAME_CHAT_TYPE + +
+          A chat type for chatting on the game object.
+static StringGAME_MESSAGE_BUNDLE + +
+          The message bundle identifier for general game messages.
+static StringPLAYER_KNOCKED_OUT + +
+          The name of the message event to a placeObject that a player + was knocked out of a puzzle.
+static StringWINNERS_AND_LOSERS + +
+          The name of the message event to a placeObject that reports + the winners and losers of a game.
+  + + + + + + + +
Fields inherited from interface com.threerings.presents.data.InvocationCodes
ACCESS_DENIED, E_ACCESS_DENIED, E_INTERNAL_ERROR, GLOBAL_GROUP, INTERNAL_ERROR
+  +

+ + + + + + + + +
+Field Detail
+ +

+GAME_MESSAGE_BUNDLE

+
+static final String GAME_MESSAGE_BUNDLE
+
+
The message bundle identifier for general game messages. +

+

+
See Also:
Constant Field Values
+
+
+ +

+PLAYER_KNOCKED_OUT

+
+static final String PLAYER_KNOCKED_OUT
+
+
The name of the message event to a placeObject that a player + was knocked out of a puzzle. +

+

+
See Also:
Constant Field Values
+
+
+ +

+WINNERS_AND_LOSERS

+
+static final String WINNERS_AND_LOSERS
+
+
The name of the message event to a placeObject that reports + the winners and losers of a game. +

+

+
See Also:
Constant Field Values
+
+
+ +

+GAME_CHAT_TYPE

+
+static final String GAME_CHAT_TYPE
+
+
A chat type for chatting on the game object. +

+

+
See Also:
Constant Field Values
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/game/data/GameConfig.html b/apidocs/com/threerings/parlor/game/data/GameConfig.html new file mode 100644 index 00000000..e279b485 --- /dev/null +++ b/apidocs/com/threerings/parlor/game/data/GameConfig.html @@ -0,0 +1,685 @@ + + + + + + + +GameConfig (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.game.data +
+Class GameConfig

+
+java.lang.Object
+  extended by com.threerings.io.SimpleStreamableObject
+      extended by com.threerings.crowd.data.PlaceConfig
+          extended by com.threerings.parlor.game.data.GameConfig
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable, Cloneable
+
+
+
+
public abstract class GameConfig
extends com.threerings.crowd.data.PlaceConfig
implements Cloneable
+ + +

+The game config class encapsulates the configuration information for a particular type of game. + The hierarchy of game config objects mimics the hierarchy of game managers and controllers. Both + the game manager and game controller are provided with the game config object when the game is + created. + +

The game config object is also the mechanism used to instantiate the appropriate game + manager and controller. Every game must have an associated game config derived class that + overrides PlaceConfig.createController() and PlaceConfig.getManagerClassName(), + returning the appropriate game controller and manager class for that game. Thus the entire chain + of events that causes a particular game to be created is the construction of the appropriate + game config instance which is provided to the server as part of an invitation or via some other + matchmaking mechanism. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+ GameAI[]ais + +
+          Configurations for AIs to be used in this game.
+static intPARTY + +
+          Matchmaking type constant: a game that starts immediately, and every user that enters is a + player.
+ com.threerings.util.Name[]players + +
+          The usernames of the players involved in this game, or an empty array if such information + is not needed by this particular game.
+ booleanrated + +
+          Indicates whether or not this game is rated.
+static intSEATED_CONTINUOUS + +
+          Matchmaking type constant: a game that starts immediately, but only has a certain number of + player slots.
+static intSEATED_GAME + +
+          Matchmaking type constant: a game that is started with a list of players, and those are the + only players that may play.
+static String[]TYPE_STRINGS + +
+          Maps the matchmaking type codes into strings used in our XML configuration.
+  + + + + + + + + + + +
+Constructor Summary
GameConfig() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ GameConfigclone() + +
+           
+ GameConfiguratorcreateConfigurator() + +
+          Creates a configurator that can be used to create a user interface for configuring this + instance prior to starting the game.
+ TableConfiguratorcreateTableConfigurator() + +
+          Creates a table configurator for initializing 'table' properties of the game.
+ booleanequals(Object other) + +
+          Returns true if this game config object is equal to the supplied object (meaning it is a + game config for the same game and its configuration settings are the same as ours).
+ List<String>getDescription() + +
+          Returns a List of strings that describe the configuration of this game.
+abstract  intgetGameId() + +
+          Returns a numeric identifier for this game class.
+abstract  StringgetGameIdent() + +
+          Returns a string identifier for this game class (e.g.
+ intgetMatchType() + +
+          Returns the matchmaking type of this game: SEATED_GAME, etc.
+ inthashCode() + +
+          Computes a hashcode for this game config object that supports our equals(java.lang.Object) + implementation.
+  + + + + + + + +
Methods inherited from class com.threerings.crowd.data.PlaceConfig
createController, getControllerClass, getManagerClassName
+  + + + + + + + +
Methods inherited from class com.threerings.io.SimpleStreamableObject
toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+SEATED_GAME

+
+public static final int SEATED_GAME
+
+
Matchmaking type constant: a game that is started with a list of players, and those are the + only players that may play. +

+

+
See Also:
Constant Field Values
+
+
+ +

+SEATED_CONTINUOUS

+
+public static final int SEATED_CONTINUOUS
+
+
Matchmaking type constant: a game that starts immediately, but only has a certain number of + player slots. Users enter the game room, and then choose where to sit. +

+

+
See Also:
Constant Field Values
+
+
+ +

+PARTY

+
+public static final int PARTY
+
+
Matchmaking type constant: a game that starts immediately, and every user that enters is a + player. +

+

+
See Also:
Constant Field Values
+
+
+ +

+TYPE_STRINGS

+
+public static final String[] TYPE_STRINGS
+
+
Maps the matchmaking type codes into strings used in our XML configuration. +

+

+
+
+
+ +

+players

+
+public com.threerings.util.Name[] players
+
+
The usernames of the players involved in this game, or an empty array if such information + is not needed by this particular game. +

+

+
+
+
+ +

+rated

+
+public boolean rated
+
+
Indicates whether or not this game is rated. +

+

+
+
+
+ +

+ais

+
+public GameAI[] ais
+
+
Configurations for AIs to be used in this game. Slots with real players should be null and + slots with AIs should contain configuration for those AIs. A null array indicates no use of + AIs at all. +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+GameConfig

+
+public GameConfig()
+
+
+ + + + + + + + +
+Method Detail
+ +

+getGameId

+
+public abstract int getGameId()
+
+
Returns a numeric identifier for this game class. This may be used to track persisent + information on a per-game basis. +

+

+
+
+
+
+
+
+
+ +

+getGameIdent

+
+public abstract String getGameIdent()
+
+
Returns a string identifier for this game class (e.g. "spades"). This may be used to + identify a message bundle for which to obtain translations for this game configuration and + to look up the name of the game in said bundle. +

+

+
+
+
+
+
+
+
+ +

+getMatchType

+
+public int getMatchType()
+
+
Returns the matchmaking type of this game: SEATED_GAME, etc. +

+

+
+
+
+
+
+
+
+ +

+createConfigurator

+
+public GameConfigurator createConfigurator()
+
+
Creates a configurator that can be used to create a user interface for configuring this + instance prior to starting the game. If no configuration is necessary, this method should + return null. +

+

+
+
+
+
+
+
+
+ +

+createTableConfigurator

+
+public TableConfigurator createTableConfigurator()
+
+
Creates a table configurator for initializing 'table' properties of the game. The default + implementation returns null. +

+

+
+
+
+
+
+
+
+ +

+getDescription

+
+public List<String> getDescription()
+
+
Returns a List of strings that describe the configuration of this game. Default + implementation returns an empty list. +

+

+
+
+
+
+
+
+
+ +

+equals

+
+public boolean equals(Object other)
+
+
Returns true if this game config object is equal to the supplied object (meaning it is a + game config for the same game and its configuration settings are the same as ours). +

+

+
Overrides:
equals in class Object
+
+
+
+
+
+
+ +

+hashCode

+
+public int hashCode()
+
+
Computes a hashcode for this game config object that supports our equals(java.lang.Object) + implementation. Objects that are equal should have the same hashcode. +

+

+
Overrides:
hashCode in class Object
+
+
+
+
+
+
+ +

+clone

+
+public GameConfig clone()
+
+
+
Overrides:
clone in class Object
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/game/data/GameObject.html b/apidocs/com/threerings/parlor/game/data/GameObject.html new file mode 100644 index 00000000..e4c03a73 --- /dev/null +++ b/apidocs/com/threerings/parlor/game/data/GameObject.html @@ -0,0 +1,1263 @@ + + + + + + + +GameObject (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.game.data +
+Class GameObject

+
+java.lang.Object
+  extended by com.threerings.presents.dobj.DObject
+      extended by com.threerings.crowd.data.PlaceObject
+          extended by com.threerings.parlor.game.data.GameObject
+
+
+
All Implemented Interfaces:
com.threerings.crowd.chat.data.SpeakObject, com.threerings.io.Streamable
+
+
+
Direct Known Subclasses:
CardGameObject, PuzzleObject
+
+
+
+
public class GameObject
extends com.threerings.crowd.data.PlaceObject
+ + +

+A game object hosts the shared data associated with a game played by one or more players. The + game object extends the place object so that the game can act as a place where players actually + go when playing the game. Only very basic information is maintained in the base game object. It + serves as the base for a hierarchy of game object derivatives that handle basic gameplay for a + suite of different game types (ie. turn based games, party games, board games, card games, + etc.). +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.crowd.data.PlaceObject
com.threerings.crowd.data.PlaceObject.ManagerCaller
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.crowd.chat.data.SpeakObject
com.threerings.crowd.chat.data.SpeakObject.ListenerOp
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static intCANCELLED + +
+          A game state constant indicating that the game was cancelled.
+static intGAME_OVER + +
+          A game state constant indicating that the game ended normally.
+static intIN_PLAY + +
+          A game state constant indicating that the game is in play.
+static StringIS_PRIVATE + +
+          The field name of the isPrivate field.
+static StringIS_RATED + +
+          The field name of the isRated field.
+ booleanisPrivate + +
+          Indicates whether the game is "private".
+ booleanisRated + +
+          Indicates whether or not this game is rated.
+static intPLAYER_IN_PLAY + +
+          The player status constant for a player whose game is in play.
+static intPLAYER_LEFT_GAME + +
+          The player status constant for a player whose has been knocked out of the game.
+static StringPLAYER_STATUS + +
+          The field name of the playerStatus field.
+ com.threerings.util.Name[]players + +
+          The usernames of the players involved in this game.
+static StringPLAYERS + +
+          The field name of the players field.
+ int[]playerStatus + +
+          If null, indicates that all present players are active, or for more complex games can be + non-null to indicate the current status of each player in the game.
+static intPRE_GAME + +
+          A game state constant indicating that the game has not yet started and is still awaiting + the arrival of all of the players.
+static StringSESSION_ID + +
+          The field name of the sessionId field.
+ intsessionId + +
+          A unique identifier for each game session.
+ intstate + +
+          The game state, one of PRE_GAME, IN_PLAY, GAME_OVER, or + CANCELLED.
+static StringSTATE + +
+          The field name of the state field.
+ boolean[]winners + +
+          Whether each player in the game is a winner, or null if the game is not yet over.
+static StringWINNERS + +
+          The field name of the winners field.
+  + + + + + + + +
Fields inherited from class com.threerings.crowd.data.PlaceObject
manager, OCCUPANT_INFO, occupantInfo, occupants, OCCUPANTS, SPEAK_SERVICE, speakService
+  + + + + + + + + + + +
+Constructor Summary
GameObject() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ intgetActivePlayerCount() + +
+          Returns the number of active players in the game.
+ intgetPlayerCount() + +
+          Returns the number of players in the game.
+ intgetPlayerIndex(com.threerings.util.Name username) + +
+          Returns the player index of the given user in the game, or -1 if the player is + not involved in the game.
+ intgetWinnerCount() + +
+          Returns the number of winners for this game, or 0 if the winners array is not + populated, e.g., the game is not yet over.
+ intgetWinnerIndex() + +
+          Returns the winner index of the first winning player for this game, or -1 if + there are no winners or the winners array is not yet assigned.
+ booleanisActivePlayer(int pidx) + +
+          Returns whether the given player is still an active player in the game.
+ booleanisDraw() + +
+          Returns true if the game is ended in a draw.
+ booleanisInPlay() + +
+          Returns whether the game is in play.
+ booleanisOccupiedPlayer(int pidx) + +
+          Returns whether the given player index in the game is occupied.
+ booleanisWinner(int pidx) + +
+          Returns whether the given player index is a winner, or false if the winners are not yet + assigned.
+ voidsetIsPrivate(boolean value) + +
+          Requests that the isPrivate field be set to the + specified value.
+ voidsetIsRated(boolean value) + +
+          Requests that the isRated field be set to the + specified value.
+ voidsetPlayers(com.threerings.util.Name[] value) + +
+          Requests that the players field be set to the + specified value.
+ voidsetPlayersAt(com.threerings.util.Name value, + int index) + +
+          Requests that the indexth element of + players field be set to the specified value.
+ voidsetPlayerStatus(int[] value) + +
+          Requests that the playerStatus field be set to the + specified value.
+ voidsetPlayerStatusAt(int value, + int index) + +
+          Requests that the indexth element of + playerStatus field be set to the specified value.
+ voidsetSessionId(int value) + +
+          Requests that the sessionId field be set to the + specified value.
+ voidsetState(int value) + +
+          Requests that the state field be set to the + specified value.
+ voidsetWinners(boolean[] value) + +
+          Requests that the winners field be set to the + specified value.
+ voidsetWinnersAt(boolean value, + int index) + +
+          Requests that the indexth element of + winners field be set to the specified value.
+  + + + + + + + +
Methods inherited from class com.threerings.crowd.data.PlaceObject
addToOccupantInfo, addToOccupants, applyToListeners, getOccupantInfo, initManagerCaller, removeFromOccupantInfo, removeFromOccupants, setOccupantInfo, setSpeakService, shouldBroadcast, updateOccupantInfo
+  + + + + + + + +
Methods inherited from class com.threerings.presents.dobj.DObject
acquireLock, addListener, addListener, addSubscriber, addToSet, cancelTransaction, changeAttribute, checkPermissions, checkPermissions, commitTransaction, destroy, getAccessController, getAttribute, getLocal, getLocals, getManager, getOid, getSet, inTransaction, isActive, notifyListeners, notifyProxies, postEvent, postMessage, postMessage, readField__oid, releaseLock, removeFromSet, removeListener, removeSubscriber, setAccessController, setAttribute, setDestroyOnLastSubscriberRemoved, setLocal, setManager, setOid, startTransaction, toString, updateSet, which, writeField__oid
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+STATE

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public static final String STATE
+
+
The field name of the state field. +

+

+
See Also:
Constant Field Values
+
+
+ +

+IS_RATED

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public static final String IS_RATED
+
+
The field name of the isRated field. +

+

+
See Also:
Constant Field Values
+
+
+ +

+IS_PRIVATE

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public static final String IS_PRIVATE
+
+
The field name of the isPrivate field. +

+

+
See Also:
Constant Field Values
+
+
+ +

+PLAYERS

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public static final String PLAYERS
+
+
The field name of the players field. +

+

+
See Also:
Constant Field Values
+
+
+ +

+WINNERS

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public static final String WINNERS
+
+
The field name of the winners field. +

+

+
See Also:
Constant Field Values
+
+
+ +

+SESSION_ID

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public static final String SESSION_ID
+
+
The field name of the sessionId field. +

+

+
See Also:
Constant Field Values
+
+
+ +

+PLAYER_STATUS

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public static final String PLAYER_STATUS
+
+
The field name of the playerStatus field. +

+

+
See Also:
Constant Field Values
+
+
+ +

+PRE_GAME

+
+public static final int PRE_GAME
+
+
A game state constant indicating that the game has not yet started and is still awaiting + the arrival of all of the players. +

+

+
See Also:
Constant Field Values
+
+
+ +

+IN_PLAY

+
+public static final int IN_PLAY
+
+
A game state constant indicating that the game is in play. +

+

+
See Also:
Constant Field Values
+
+
+ +

+GAME_OVER

+
+public static final int GAME_OVER
+
+
A game state constant indicating that the game ended normally. +

+

+
See Also:
Constant Field Values
+
+
+ +

+CANCELLED

+
+public static final int CANCELLED
+
+
A game state constant indicating that the game was cancelled. +

+

+
See Also:
Constant Field Values
+
+
+ +

+PLAYER_IN_PLAY

+
+public static final int PLAYER_IN_PLAY
+
+
The player status constant for a player whose game is in play. +

+

+
See Also:
Constant Field Values
+
+
+ +

+PLAYER_LEFT_GAME

+
+public static final int PLAYER_LEFT_GAME
+
+
The player status constant for a player whose has been knocked out of the game. NOTE: This + can include a player choosing to leave a game prematurely. +

+

+
See Also:
Constant Field Values
+
+
+ +

+state

+
+public int state
+
+
The game state, one of PRE_GAME, IN_PLAY, GAME_OVER, or + CANCELLED. +

+

+
+
+
+ +

+isRated

+
+public boolean isRated
+
+
Indicates whether or not this game is rated. +

+

+
+
+
+ +

+isPrivate

+
+public boolean isPrivate
+
+
Indicates whether the game is "private". +

+

+
+
+
+ +

+players

+
+public com.threerings.util.Name[] players
+
+
The usernames of the players involved in this game. +

+

+
+
+
+ +

+winners

+
+public boolean[] winners
+
+
Whether each player in the game is a winner, or null if the game is not yet over. +

+

+
+
+
+ +

+sessionId

+
+public int sessionId
+
+
A unique identifier for each game session. Every time the game is started, this value will + be incremented to provide a unique identifier for that particular session. +

+

+
+
+
+ +

+playerStatus

+
+public int[] playerStatus
+
+
If null, indicates that all present players are active, or for more complex games can be + non-null to indicate the current status of each player in the game. The status value is one + of PLAYER_LEFT_GAME or PLAYER_IN_PLAY.

Subclasses of GameObject may use + other means to determine a player's status in the game, so call isActivePlayer(int) + to see if a player is still participating in a game. +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+GameObject

+
+public GameObject()
+
+
+ + + + + + + + +
+Method Detail
+ +

+getPlayerCount

+
+public int getPlayerCount()
+
+
Returns the number of players in the game. +

+

+
+
+
+
+ +

+getActivePlayerCount

+
+public int getActivePlayerCount()
+
+
Returns the number of active players in the game. +

+

+
+
+
+
+ +

+isActivePlayer

+
+public boolean isActivePlayer(int pidx)
+
+
Returns whether the given player is still an active player in the game. (Ie. whether or not + they are still participating.) +

+

+
+
+
+
+ +

+getPlayerIndex

+
+public int getPlayerIndex(com.threerings.util.Name username)
+
+
Returns the player index of the given user in the game, or -1 if the player is + not involved in the game. +

+

+
+
+
+
+ +

+isInPlay

+
+public boolean isInPlay()
+
+
Returns whether the game is in play. A game that is not in play could either be awaiting + players, ended, or cancelled. +

+

+
+
+
+
+ +

+isOccupiedPlayer

+
+public boolean isOccupiedPlayer(int pidx)
+
+
Returns whether the given player index in the game is occupied. +

+

+
+
+
+
+ +

+isWinner

+
+public boolean isWinner(int pidx)
+
+
Returns whether the given player index is a winner, or false if the winners are not yet + assigned. +

+

+
+
+
+
+ +

+getWinnerCount

+
+public int getWinnerCount()
+
+
Returns the number of winners for this game, or 0 if the winners array is not + populated, e.g., the game is not yet over. +

+

+
+
+
+
+ +

+isDraw

+
+public boolean isDraw()
+
+
Returns true if the game is ended in a draw. +

+

+
+
+
+
+ +

+getWinnerIndex

+
+public int getWinnerIndex()
+
+
Returns the winner index of the first winning player for this game, or -1 if + there are no winners or the winners array is not yet assigned. This is only likely to be + useful for games that are known to have a single winner. +

+

+
+
+
+
+ +

+setState

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public void setState(int value)
+
+
Requests that the state field be set to the + specified value. The local value will be updated immediately and an + event will be propagated through the system to notify all listeners + that the attribute did change. Proxied copies of this object (on + clients) will apply the value change when they received the + attribute changed notification. +

+

+
+
+
+
+ +

+setIsRated

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public void setIsRated(boolean value)
+
+
Requests that the isRated field be set to the + specified value. The local value will be updated immediately and an + event will be propagated through the system to notify all listeners + that the attribute did change. Proxied copies of this object (on + clients) will apply the value change when they received the + attribute changed notification. +

+

+
+
+
+
+ +

+setIsPrivate

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public void setIsPrivate(boolean value)
+
+
Requests that the isPrivate field be set to the + specified value. The local value will be updated immediately and an + event will be propagated through the system to notify all listeners + that the attribute did change. Proxied copies of this object (on + clients) will apply the value change when they received the + attribute changed notification. +

+

+
+
+
+
+ +

+setPlayers

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public void setPlayers(com.threerings.util.Name[] value)
+
+
Requests that the players field be set to the + specified value. The local value will be updated immediately and an + event will be propagated through the system to notify all listeners + that the attribute did change. Proxied copies of this object (on + clients) will apply the value change when they received the + attribute changed notification. +

+

+
+
+
+
+ +

+setPlayersAt

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public void setPlayersAt(com.threerings.util.Name value,
+                                   int index)
+
+
Requests that the indexth element of + players field be set to the specified value. + The local value will be updated immediately and an event will be + propagated through the system to notify all listeners that the + attribute did change. Proxied copies of this object (on clients) + will apply the value change when they received the attribute + changed notification. +

+

+
+
+
+
+ +

+setWinners

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public void setWinners(boolean[] value)
+
+
Requests that the winners field be set to the + specified value. The local value will be updated immediately and an + event will be propagated through the system to notify all listeners + that the attribute did change. Proxied copies of this object (on + clients) will apply the value change when they received the + attribute changed notification. +

+

+
+
+
+
+ +

+setWinnersAt

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public void setWinnersAt(boolean value,
+                                   int index)
+
+
Requests that the indexth element of + winners field be set to the specified value. + The local value will be updated immediately and an event will be + propagated through the system to notify all listeners that the + attribute did change. Proxied copies of this object (on clients) + will apply the value change when they received the attribute + changed notification. +

+

+
+
+
+
+ +

+setSessionId

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public void setSessionId(int value)
+
+
Requests that the sessionId field be set to the + specified value. The local value will be updated immediately and an + event will be propagated through the system to notify all listeners + that the attribute did change. Proxied copies of this object (on + clients) will apply the value change when they received the + attribute changed notification. +

+

+
+
+
+
+ +

+setPlayerStatus

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public void setPlayerStatus(int[] value)
+
+
Requests that the playerStatus field be set to the + specified value. The local value will be updated immediately and an + event will be propagated through the system to notify all listeners + that the attribute did change. Proxied copies of this object (on + clients) will apply the value change when they received the + attribute changed notification. +

+

+
+
+
+
+ +

+setPlayerStatusAt

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public void setPlayerStatusAt(int value,
+                                        int index)
+
+
Requests that the indexth element of + playerStatus field be set to the specified value. + The local value will be updated immediately and an event will be + propagated through the system to notify all listeners that the + attribute did change. Proxied copies of this object (on clients) + will apply the value change when they received the attribute + changed notification. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/game/data/UserIdentifier.Ider.html b/apidocs/com/threerings/parlor/game/data/UserIdentifier.Ider.html new file mode 100644 index 00000000..77226c38 --- /dev/null +++ b/apidocs/com/threerings/parlor/game/data/UserIdentifier.Ider.html @@ -0,0 +1,214 @@ + + + + + + + +UserIdentifier.Ider (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.game.data +
+Interface UserIdentifier.Ider

+
+
Enclosing class:
UserIdentifier
+
+
+
+
public static interface UserIdentifier.Ider
+ + +

+Implement this and set the mutha up. +

+ +

+

+ +

+ + + + + + + + + + + + +
+Method Summary
+ intgetUserId(com.threerings.util.Name name) + +
+           
+  +

+ + + + + + + + +
+Method Detail
+ +

+getUserId

+
+int getUserId(com.threerings.util.Name name)
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/game/data/UserIdentifier.html b/apidocs/com/threerings/parlor/game/data/UserIdentifier.html new file mode 100644 index 00000000..6bbdb22d --- /dev/null +++ b/apidocs/com/threerings/parlor/game/data/UserIdentifier.html @@ -0,0 +1,293 @@ + + + + + + + +UserIdentifier (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.game.data +
+Class UserIdentifier

+
+java.lang.Object
+  extended by com.threerings.parlor.game.data.UserIdentifier
+
+
+
+
public class UserIdentifier
extends Object
+ + +

+

+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static interfaceUserIdentifier.Ider + +
+          Implement this and set the mutha up.
+  + + + + + + + + + + +
+Constructor Summary
UserIdentifier() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+static intgetUserId(com.threerings.util.Name name) + +
+          Returns the id of the specified user, or 0 if they're not valid.
+static voidsetIder(UserIdentifier.Ider userIder) + +
+          Set the global user identifier to use.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+UserIdentifier

+
+public UserIdentifier()
+
+
+ + + + + + + + +
+Method Detail
+ +

+getUserId

+
+public static int getUserId(com.threerings.util.Name name)
+
+
Returns the id of the specified user, or 0 if they're not valid. +

+

+
+
+
+
+ +

+setIder

+
+public static void setIder(UserIdentifier.Ider userIder)
+
+
Set the global user identifier to use. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/game/data/class-use/GameAI.html b/apidocs/com/threerings/parlor/game/data/class-use/GameAI.html new file mode 100644 index 00000000..b3866b9e --- /dev/null +++ b/apidocs/com/threerings/parlor/game/data/class-use/GameAI.html @@ -0,0 +1,229 @@ + + + + + + + +Uses of Class com.threerings.parlor.game.data.GameAI (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.game.data.GameAI

+
+ + + + + + + + + + + + + +
+Packages that use GameAI
com.threerings.parlor.game.data  
com.threerings.parlor.game.server  
+  +

+ + + + + +
+Uses of GameAI in com.threerings.parlor.game.data
+  +

+ + + + + + + + + +
Fields in com.threerings.parlor.game.data declared as GameAI
+ GameAI[]GameConfig.ais + +
+          Configurations for AIs to be used in this game.
+  +

+ + + + + +
+Uses of GameAI in com.threerings.parlor.game.server
+  +

+ + + + + + + + + + + + + + + + + +
Methods in com.threerings.parlor.game.server with parameters of type GameAI
+ voidGameManagerDelegate.setAI(int pidx, + GameAI ai) + +
+          Called when the specified player has been set as an AI with the supplied AI configuration.
+ voidGameManager.setAI(int pidx, + GameAI ai) + +
+          Sets the specified player as an AI with the specified configuration.
+ voidGameManagerDelegate.tickAI(int pidx, + GameAI ai) + +
+          Called by the manager when we should do some AI.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/game/data/class-use/GameCodes.html b/apidocs/com/threerings/parlor/game/data/class-use/GameCodes.html new file mode 100644 index 00000000..0fc8d8c4 --- /dev/null +++ b/apidocs/com/threerings/parlor/game/data/class-use/GameCodes.html @@ -0,0 +1,239 @@ + + + + + + + +Uses of Interface com.threerings.parlor.game.data.GameCodes (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.parlor.game.data.GameCodes

+
+ + + + + + + + + + + + + + + + + +
+Packages that use GameCodes
com.threerings.parlor.card.server  
com.threerings.parlor.game.server  
com.threerings.puzzle.server  
+  +

+ + + + + +
+Uses of GameCodes in com.threerings.parlor.card.server
+  +

+ + + + + + + + + +
Classes in com.threerings.parlor.card.server that implement GameCodes
+ classCardGameManager + +
+          A manager class for card games.
+  +

+ + + + + +
+Uses of GameCodes in com.threerings.parlor.game.server
+  +

+ + + + + + + + + +
Classes in com.threerings.parlor.game.server that implement GameCodes
+ classGameManager + +
+          The game manager handles the server side management of a game.
+  +

+ + + + + +
+Uses of GameCodes in com.threerings.puzzle.server
+  +

+ + + + + + + + + +
Classes in com.threerings.puzzle.server that implement GameCodes
+ classPuzzleManager + +
+          Extends the GameManager with facilities for puzzle games.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/game/data/class-use/GameConfig.html b/apidocs/com/threerings/parlor/game/data/class-use/GameConfig.html new file mode 100644 index 00000000..fe8b40f6 --- /dev/null +++ b/apidocs/com/threerings/parlor/game/data/class-use/GameConfig.html @@ -0,0 +1,859 @@ + + + + + + + +Uses of Class com.threerings.parlor.game.data.GameConfig (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.game.data.GameConfig

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Packages that use GameConfig
com.threerings.micasa.lobby  
com.threerings.micasa.simulator.client  
com.threerings.micasa.simulator.data  
com.threerings.micasa.simulator.server  
com.threerings.parlor.client  
com.threerings.parlor.data  
com.threerings.parlor.game.client  
com.threerings.parlor.game.data  
com.threerings.parlor.game.server  
com.threerings.parlor.server  
com.threerings.puzzle.client  
com.threerings.puzzle.drop.client  
+  +

+ + + + + +
+Uses of GameConfig in com.threerings.micasa.lobby
+  +

+ + + + + + + + + +
Methods in com.threerings.micasa.lobby that return GameConfig
+ GameConfigLobbyConfig.getGameConfig() + +
+          Instantiates and returns a game config instance using the game + config classname provided by the lobby configuration parameters.
+  +

+ + + + + + + + + +
Methods in com.threerings.micasa.lobby with parameters of type GameConfig
+ voidLobbyController.invitationCountered(Invitation invite, + GameConfig config) + +
+           
+  +

+ + + + + +
+Uses of GameConfig in com.threerings.micasa.simulator.client
+  +

+ + + + + + + + + +
Methods in com.threerings.micasa.simulator.client with parameters of type GameConfig
+ voidSimulatorService.createGame(GameConfig config, + String simClass, + int playerCount) + +
+          Requests that a new game be created.
+  +

+ + + + + +
+Uses of GameConfig in com.threerings.micasa.simulator.data
+  +

+ + + + + + + + + +
Methods in com.threerings.micasa.simulator.data with parameters of type GameConfig
+ voidSimulatorMarshaller.createGame(GameConfig arg1, + String arg2, + int arg3) + +
+           
+  +

+ + + + + +
+Uses of GameConfig in com.threerings.micasa.simulator.server
+  +

+ + + + + + + + + + + + + + + + + +
Methods in com.threerings.micasa.simulator.server with parameters of type GameConfig
+ voidSimulatorManager.createGame(com.threerings.crowd.data.BodyObject source, + GameConfig config, + String simClass, + int playerCount) + +
+          Creates a game along with the specified number of simulant players and forcibly moves all + players into the game room.
+ voidSimulatorProvider.createGame(com.threerings.presents.data.ClientObject caller, + GameConfig config, + String simClass, + int playerCount) + +
+          Processes a request from the client to create a new game.
+ voidSimulant.init(com.threerings.crowd.data.BodyObject self, + GameConfig config, + GameManager gmgr, + com.threerings.presents.dobj.DObjectManager omgr) + +
+          Initializes the simulant with a body object and the game config for + the game they'll be engaged in.
+  +

+ + + + + + + + +
Constructors in com.threerings.micasa.simulator.server with parameters of type GameConfig
SimulatorManager.CreateGameTask(com.threerings.crowd.data.BodyObject source, + GameConfig config, + String simClass, + int playerCount) + +
+           
+  +

+ + + + + +
+Uses of GameConfig in com.threerings.parlor.client
+  +

+ + + + + + + + + +
Fields in com.threerings.parlor.client declared as GameConfig
+ GameConfigInvitation.config + +
+          The configuration of the game to be created.
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in com.threerings.parlor.client with parameters of type GameConfig
+ voidInvitation.counter(GameConfig config, + InvitationResponseObserver observer) + +
+          Counters this invitation with an invitation with different game + configuration parameters.
+ voidTableDirector.createTable(TableConfig tableConfig, + GameConfig config) + +
+          Sends a request to create a table with the specified game configuration.
+ voidTableService.createTable(TableConfig tableConfig, + GameConfig config, + com.threerings.presents.client.InvocationService.ResultListener listener) + +
+          Requests that a new table be created.
+ voidInvitationResponseObserver.invitationCountered(Invitation invite, + GameConfig config) + +
+          Called if the invitation was countered with an alternate game + configuration.
+ InvitationParlorDirector.invite(com.threerings.util.Name invitee, + GameConfig config, + InvitationResponseObserver observer) + +
+          Requests that the named user be invited to a game described by the supplied game config.
+ voidParlorService.invite(com.threerings.util.Name invitee, + GameConfig config, + ParlorService.InviteListener listener) + +
+          You probably don't want to call this directly, but want to generate your invitation request + via ParlorDirector.invite(com.threerings.util.Name, com.threerings.parlor.game.data.GameConfig, com.threerings.parlor.client.InvitationResponseObserver).
+ voidParlorReceiver.receivedInvite(int remoteId, + com.threerings.util.Name inviter, + GameConfig config) + +
+          Called by the invocation services when another user has invited us + to play a game.
+ voidParlorDirector.receivedInvite(int remoteId, + com.threerings.util.Name inviter, + GameConfig config) + +
+           
+ voidParlorService.startSolitaire(GameConfig config, + com.threerings.presents.client.InvocationService.ConfirmListener listener) + +
+          Requests to start a single player game with the specified game configuration.
+ voidParlorDirector.startSolitaire(GameConfig config, + com.threerings.presents.client.InvocationService.ConfirmListener listener) + +
+          Requests that the specified single player game be started.
+  +

+ + + + + + + + +
Constructors in com.threerings.parlor.client with parameters of type GameConfig
Invitation(ParlorContext ctx, + ParlorService pservice, + com.threerings.util.Name opponent, + GameConfig config, + InvitationResponseObserver observer) + +
+          Constructs a new invitation record.
+  +

+ + + + + +
+Uses of GameConfig in com.threerings.parlor.data
+  +

+ + + + + + + + + +
Fields in com.threerings.parlor.data declared as GameConfig
+ GameConfigTable.config + +
+          The game config for the game that is being matchmade.
+  +

+ + + + + + + + + + + + + + + + + + + + + +
Methods in com.threerings.parlor.data with parameters of type GameConfig
+ voidTableMarshaller.createTable(TableConfig arg1, + GameConfig arg2, + com.threerings.presents.client.InvocationService.ResultListener arg3) + +
+           
+ voidTable.init(int lobbyOid, + TableConfig tconfig, + GameConfig config) + +
+          Initializes a new table instance, and assigns it the next monotonically increasing table id.
+ voidParlorMarshaller.invite(com.threerings.util.Name arg1, + GameConfig arg2, + ParlorService.InviteListener arg3) + +
+           
+ voidParlorMarshaller.startSolitaire(GameConfig arg1, + com.threerings.presents.client.InvocationService.ConfirmListener arg2) + +
+           
+  +

+ + + + + +
+Uses of GameConfig in com.threerings.parlor.game.client
+  +

+ + + + + + + + + +
Methods in com.threerings.parlor.game.client that return GameConfig
+ GameConfigGameConfigurator.getGameConfig() + +
+          Obtains a configured game configuration.
+  +

+ + + + + + + + + +
Methods in com.threerings.parlor.game.client with parameters of type GameConfig
+ voidGameConfigurator.setGameConfig(GameConfig config) + +
+          Provides this configurator with its configuration.
+  +

+ + + + + +
+Uses of GameConfig in com.threerings.parlor.game.data
+  +

+ + + + + + + + + +
Methods in com.threerings.parlor.game.data that return GameConfig
+ GameConfigGameConfig.clone() + +
+           
+  +

+ + + + + +
+Uses of GameConfig in com.threerings.parlor.game.server
+  +

+ + + + + + + + + +
Methods in com.threerings.parlor.game.server that return GameConfig
+ GameConfigGameManager.getGameConfig() + +
+          Returns the configuration object for the game being managed by this manager.
+  +

+ + + + + +
+Uses of GameConfig in com.threerings.parlor.server
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in com.threerings.parlor.server with parameters of type GameConfig
+ TableTableManager.createTable(com.threerings.crowd.data.BodyObject creator, + TableConfig tableConfig, + GameConfig config) + +
+          Creates a table for the specified creator and returns said table.
+ voidTableProvider.createTable(com.threerings.presents.data.ClientObject caller, + TableConfig arg1, + GameConfig arg2, + com.threerings.presents.client.InvocationService.ResultListener arg3) + +
+          Handles a TableService.createTable(com.threerings.parlor.data.TableConfig, com.threerings.parlor.game.data.GameConfig, com.threerings.presents.client.InvocationService.ResultListener) request.
+ voidTableManager.createTable(com.threerings.presents.data.ClientObject caller, + TableConfig tableConfig, + GameConfig config, + com.threerings.presents.client.InvocationService.ResultListener listener) + +
+           
+ intParlorManager.invite(com.threerings.crowd.data.BodyObject inviter, + com.threerings.crowd.data.BodyObject invitee, + GameConfig config) + +
+          Issues an invitation from the inviter to the invitee for a game as + described by the supplied config object.
+ voidParlorProvider.invite(com.threerings.presents.data.ClientObject caller, + com.threerings.util.Name arg1, + GameConfig arg2, + ParlorService.InviteListener arg3) + +
+          Handles a ParlorService.invite(com.threerings.util.Name, com.threerings.parlor.game.data.GameConfig, com.threerings.parlor.client.ParlorService.InviteListener) request.
+ voidParlorManager.invite(com.threerings.presents.data.ClientObject caller, + com.threerings.util.Name invitee, + GameConfig config, + ParlorService.InviteListener listener) + +
+           
+static voidParlorSender.sendInvite(com.threerings.presents.data.ClientObject target, + int arg1, + com.threerings.util.Name arg2, + GameConfig arg3) + +
+          Issues a notification that will result in a call to ParlorReceiver.receivedInvite(int, com.threerings.util.Name, com.threerings.parlor.game.data.GameConfig) on a client.
+ voidParlorProvider.startSolitaire(com.threerings.presents.data.ClientObject caller, + GameConfig arg1, + com.threerings.presents.client.InvocationService.ConfirmListener arg2) + +
+          Handles a ParlorService.startSolitaire(com.threerings.parlor.game.data.GameConfig, com.threerings.presents.client.InvocationService.ConfirmListener) request.
+ voidParlorManager.startSolitaire(com.threerings.presents.data.ClientObject caller, + GameConfig config, + com.threerings.presents.client.InvocationService.ConfirmListener listener) + +
+           
+  +

+ + + + + +
+Uses of GameConfig in com.threerings.puzzle.client
+  +

+ + + + + + + + + + + + + + + + + +
Methods in com.threerings.puzzle.client with parameters of type GameConfig
+ voidPuzzlePanel.init(GameConfig config) + +
+          Initializes the puzzle panel with the puzzle config of the puzzle whose user interface is + being displayed by the panel
+ voidPuzzleBoardView.init(GameConfig config) + +
+          Initializes the board with the board dimensions.
+ voidPlayerStatusView.init(GameConfig config) + +
+          Initializes the player status view with the puzzle config.
+  +

+ + + + + +
+Uses of GameConfig in com.threerings.puzzle.drop.client
+  +

+ + + + + + + + + +
Methods in com.threerings.puzzle.drop.client with parameters of type GameConfig
+ voidDropBoardView.init(GameConfig config) + +
+          Initializes the board with the board dimensions.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/game/data/class-use/GameObject.html b/apidocs/com/threerings/parlor/game/data/class-use/GameObject.html new file mode 100644 index 00000000..e1242932 --- /dev/null +++ b/apidocs/com/threerings/parlor/game/data/class-use/GameObject.html @@ -0,0 +1,297 @@ + + + + + + + +Uses of Class com.threerings.parlor.game.data.GameObject (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.game.data.GameObject

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
+Packages that use GameObject
com.threerings.parlor.card.data  
com.threerings.parlor.data  
com.threerings.parlor.game.server  
com.threerings.puzzle.client  
com.threerings.puzzle.data  
+  +

+ + + + + +
+Uses of GameObject in com.threerings.parlor.card.data
+  +

+ + + + + + + + + +
Subclasses of GameObject in com.threerings.parlor.card.data
+ classCardGameObject + +
+          Game object class for card games.
+  +

+ + + + + +
+Uses of GameObject in com.threerings.parlor.data
+  +

+ + + + + + + + + +
Methods in com.threerings.parlor.data with parameters of type GameObject
+ voidTable.updateOccupants(GameObject gameobj) + +
+          Called by the table manager when the game object's players have changed.
+  +

+ + + + + +
+Uses of GameObject in com.threerings.parlor.game.server
+  +

+ + + + + + + + + +
Classes in com.threerings.parlor.game.server with type parameters of type GameObject
+ classGameWatcher<T extends GameObject> + +
+          An abstract convenience class used server-side to keep an eye on a game and perform a one-time + game-over activity when the game ends.
+  +

+ + + + + +
+Uses of GameObject in com.threerings.puzzle.client
+  +

+ + + + + + + + +
Constructors in com.threerings.puzzle.client with parameters of type GameObject
PlayerStatusView(GameObject gameobj, + int pidx) + +
+          Constructs a player status view.
+  +

+ + + + + +
+Uses of GameObject in com.threerings.puzzle.data
+  +

+ + + + + + + + + +
Subclasses of GameObject in com.threerings.puzzle.data
+ classPuzzleObject + +
+          Extends the basic GameObject to add individual player status.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/game/data/class-use/UserIdentifier.Ider.html b/apidocs/com/threerings/parlor/game/data/class-use/UserIdentifier.Ider.html new file mode 100644 index 00000000..02668503 --- /dev/null +++ b/apidocs/com/threerings/parlor/game/data/class-use/UserIdentifier.Ider.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Interface com.threerings.parlor.game.data.UserIdentifier.Ider (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.parlor.game.data.UserIdentifier.Ider

+
+ + + + + + + + + +
+Packages that use UserIdentifier.Ider
com.threerings.parlor.game.data  
+  +

+ + + + + +
+Uses of UserIdentifier.Ider in com.threerings.parlor.game.data
+  +

+ + + + + + + + + +
Methods in com.threerings.parlor.game.data with parameters of type UserIdentifier.Ider
+static voidUserIdentifier.setIder(UserIdentifier.Ider userIder) + +
+          Set the global user identifier to use.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/game/data/class-use/UserIdentifier.html b/apidocs/com/threerings/parlor/game/data/class-use/UserIdentifier.html new file mode 100644 index 00000000..d78c9cdb --- /dev/null +++ b/apidocs/com/threerings/parlor/game/data/class-use/UserIdentifier.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.parlor.game.data.UserIdentifier (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.game.data.UserIdentifier

+
+No usage of com.threerings.parlor.game.data.UserIdentifier +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/game/data/package-frame.html b/apidocs/com/threerings/parlor/game/data/package-frame.html new file mode 100644 index 00000000..e117801b --- /dev/null +++ b/apidocs/com/threerings/parlor/game/data/package-frame.html @@ -0,0 +1,52 @@ + + + + + + + +com.threerings.parlor.game.data (vilya 1.3 API) + + + + + + + + + + + +com.threerings.parlor.game.data + + + + +
+Interfaces  + +
+GameCodes +
+UserIdentifier.Ider
+ + + + + + +
+Classes  + +
+GameAI +
+GameConfig +
+GameObject +
+UserIdentifier
+ + + + diff --git a/apidocs/com/threerings/parlor/game/data/package-summary.html b/apidocs/com/threerings/parlor/game/data/package-summary.html new file mode 100644 index 00000000..8a93a778 --- /dev/null +++ b/apidocs/com/threerings/parlor/game/data/package-summary.html @@ -0,0 +1,188 @@ + + + + + + + +com.threerings.parlor.game.data (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.parlor.game.data +

+ + + + + + + + + + + + + +
+Interface Summary
GameCodesConstants relating to the game services.
UserIdentifier.IderImplement this and set the mutha up.
+  + +

+ + + + + + + + + + + + + + + + + + + + + +
+Class Summary
GameAIRepresents attributes of an AI player.
GameConfigThe game config class encapsulates the configuration information for a particular type of game.
GameObjectA game object hosts the shared data associated with a game played by one or more players.
UserIdentifier 
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/game/data/package-tree.html b/apidocs/com/threerings/parlor/game/data/package-tree.html new file mode 100644 index 00000000..7106a336 --- /dev/null +++ b/apidocs/com/threerings/parlor/game/data/package-tree.html @@ -0,0 +1,173 @@ + + + + + + + +com.threerings.parlor.game.data Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.parlor.game.data +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/game/data/package-use.html b/apidocs/com/threerings/parlor/game/data/package-use.html new file mode 100644 index 00000000..6fe4b210 --- /dev/null +++ b/apidocs/com/threerings/parlor/game/data/package-use.html @@ -0,0 +1,498 @@ + + + + + + + +Uses of Package com.threerings.parlor.game.data (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.parlor.game.data

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Packages that use com.threerings.parlor.game.data
com.threerings.micasa.lobby  
com.threerings.micasa.simulator.client  
com.threerings.micasa.simulator.data  
com.threerings.micasa.simulator.server  
com.threerings.parlor.card.data  
com.threerings.parlor.card.server  
com.threerings.parlor.client  
com.threerings.parlor.data  
com.threerings.parlor.game.client  
com.threerings.parlor.game.data  
com.threerings.parlor.game.server  
com.threerings.parlor.server  
com.threerings.puzzle.client  
com.threerings.puzzle.data  
com.threerings.puzzle.drop.client  
com.threerings.puzzle.server  
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.game.data used by com.threerings.micasa.lobby
GameConfig + +
+          The game config class encapsulates the configuration information for a particular type of game.
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.game.data used by com.threerings.micasa.simulator.client
GameConfig + +
+          The game config class encapsulates the configuration information for a particular type of game.
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.game.data used by com.threerings.micasa.simulator.data
GameConfig + +
+          The game config class encapsulates the configuration information for a particular type of game.
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.game.data used by com.threerings.micasa.simulator.server
GameConfig + +
+          The game config class encapsulates the configuration information for a particular type of game.
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.game.data used by com.threerings.parlor.card.data
GameObject + +
+          A game object hosts the shared data associated with a game played by one or more players.
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.game.data used by com.threerings.parlor.card.server
GameCodes + +
+          Constants relating to the game services.
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.game.data used by com.threerings.parlor.client
GameConfig + +
+          The game config class encapsulates the configuration information for a particular type of game.
+  +

+ + + + + + + + + + + +
+Classes in com.threerings.parlor.game.data used by com.threerings.parlor.data
GameConfig + +
+          The game config class encapsulates the configuration information for a particular type of game.
GameObject + +
+          A game object hosts the shared data associated with a game played by one or more players.
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.game.data used by com.threerings.parlor.game.client
GameConfig + +
+          The game config class encapsulates the configuration information for a particular type of game.
+  +

+ + + + + + + + + + + + + + +
+Classes in com.threerings.parlor.game.data used by com.threerings.parlor.game.data
GameAI + +
+          Represents attributes of an AI player.
GameConfig + +
+          The game config class encapsulates the configuration information for a particular type of game.
UserIdentifier.Ider + +
+          Implement this and set the mutha up.
+  +

+ + + + + + + + + + + + + + + + + +
+Classes in com.threerings.parlor.game.data used by com.threerings.parlor.game.server
GameAI + +
+          Represents attributes of an AI player.
GameCodes + +
+          Constants relating to the game services.
GameConfig + +
+          The game config class encapsulates the configuration information for a particular type of game.
GameObject + +
+          A game object hosts the shared data associated with a game played by one or more players.
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.game.data used by com.threerings.parlor.server
GameConfig + +
+          The game config class encapsulates the configuration information for a particular type of game.
+  +

+ + + + + + + + + + + +
+Classes in com.threerings.parlor.game.data used by com.threerings.puzzle.client
GameConfig + +
+          The game config class encapsulates the configuration information for a particular type of game.
GameObject + +
+          A game object hosts the shared data associated with a game played by one or more players.
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.game.data used by com.threerings.puzzle.data
GameObject + +
+          A game object hosts the shared data associated with a game played by one or more players.
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.game.data used by com.threerings.puzzle.drop.client
GameConfig + +
+          The game config class encapsulates the configuration information for a particular type of game.
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.game.data used by com.threerings.puzzle.server
GameCodes + +
+          Constants relating to the game services.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/game/server/GameManager.html b/apidocs/com/threerings/parlor/game/server/GameManager.html new file mode 100644 index 00000000..ef2b750f --- /dev/null +++ b/apidocs/com/threerings/parlor/game/server/GameManager.html @@ -0,0 +1,1249 @@ + + + + + + + +GameManager (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.game.server +
+Class GameManager

+
+java.lang.Object
+  extended by com.threerings.crowd.server.PlaceManager
+      extended by com.threerings.parlor.game.server.GameManager
+
+
+
All Implemented Interfaces:
com.threerings.crowd.chat.server.SpeakHandler.SpeakerValidator, ParlorCodes, GameCodes, PlayManager, com.threerings.presents.data.InvocationCodes, com.threerings.presents.dobj.ChangeListener, com.threerings.presents.dobj.MessageListener
+
+
+
Direct Known Subclasses:
CardGameManager, PuzzleManager
+
+
+
+
public class GameManager
extends com.threerings.crowd.server.PlaceManager
implements ParlorCodes, GameCodes, PlayManager
+ + +

+The game manager handles the server side management of a game. It manipulates the game state in + accordance with the logic of the game flow and generally manages the whole game playing process. + +

The game manager extends the place manager because games are implicitly played in a + location, the players of the game implicitly bodies in that location. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.crowd.server.PlaceManager
com.threerings.crowd.server.PlaceManager.DelegateOp, com.threerings.crowd.server.PlaceManager.MessageHandler
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from interface com.threerings.parlor.data.ParlorCodes
ALREADY_AT_TABLE, BANNED_FROM_TABLE, GAME_ALREADY_STARTED, INVALID_TABLE_POSITION, INVITATION_ACCEPTED, INVITATION_COUNTERED, INVITATION_REFUSED, INVITEE_NOT_ONLINE, MUST_BE_CREATOR, NO_SELF_BOOT, NO_SUCH_TABLE, NOT_AT_TABLE, PARLOR_GROUP, TABLE_POSITION_OCCUPIED
+  + + + + + + + +
Fields inherited from interface com.threerings.parlor.game.data.GameCodes
GAME_CHAT_TYPE, GAME_MESSAGE_BUNDLE, PLAYER_KNOCKED_OUT, WINNERS_AND_LOSERS
+  + + + + + + + +
Fields inherited from interface com.threerings.presents.data.InvocationCodes
ACCESS_DENIED, E_ACCESS_DENIED, E_INTERNAL_ERROR, GLOBAL_GROUP, INTERNAL_ERROR
+  + + + + + + + + + + +
+Constructor Summary
GameManager() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ intaddPlayer(com.threerings.util.Name player) + +
+          Adds the given player to the game at the first available player index.
+ booleanaddPlayerAt(com.threerings.util.Name player, + int pidx) + +
+          Adds the given player to the game at the specified player index.
+ booleanallPlayersReady() + +
+          Returns true if all (non-AI) players have delivered their playerReady(com.threerings.crowd.data.BodyObject) + notifications, false if they have not.
+ booleancancelGame() + +
+          Sets the state of the game to GameObject.CANCELLED.
+ com.threerings.crowd.data.BodyObjectcheckWritePermission(com.threerings.presents.data.ClientObject client, + int playerId) + +
+          Make sure that the given caller is a player or an agent and can write to the data + of the given playerId.
+ voidendGame() + +
+          Called when the game is known to be over.
+ voidendPlayerGame(int pidx) + +
+          Ends the game for the given player.
+ GameConfiggetGameConfig() + +
+          Returns the configuration object for the game being managed by this manager.
+ intgetGameId() + +
+          Returns the unique numeric identifier for our managed game.
+ intgetMatchType() + +
+          A convenience method for getting the game type.
+ com.threerings.crowd.data.BodyObjectgetPlayer(int playerIdx) + +
+          Returns the user object for the player with the specified index or null if the player at + that index is not online.
+ intgetPlayerCount() + +
+          Returns the number of players in the game.
+ com.threerings.util.NamegetPlayerDisplayName(int index) + +
+          Returns the name that should be shown in the client for the player with the specified index + or null if no player exists at that index.
+ intgetPlayerIndex(com.threerings.util.Name username) + +
+          Returns the player index of the given user in the game, or -1 if the player is + not involved in the game.
+ com.threerings.util.NamegetPlayerName(int index) + +
+          Returns the name of the player with the specified index or null if no player exists at that + index.
+ intgetPlayerOid(int index) + +
+          Returns the user object oid of the player with the specified index.
+ intgetPlayerPersistentId(com.threerings.crowd.data.BodyObject body) + +
+          Convenience for getting the persistent id from a body.
+ intgetPlayerPersistentId(com.threerings.util.Name name) + +
+          Returns the persistent user id for the supplied player name.
+ intgetPlayerSlots() + +
+          Returns the number of players allowed in this game.
+ intgetPresentPlayerIndex(int bodyOid) + +
+          Get the player index of the specified oid, or -1 if the oid is not a player or is a player + that is not presently in the game.
+ intgetSessionId() + +
+          Returns the unique session identifier for this game session.
+ booleanisActivePlayer(int pidx) + +
+          Returns whether the player at the specified player index is actively playing the game
+ booleanisAgent(com.threerings.presents.data.ClientObject client) + +
+          Return true if the given client is a server-side agent in this place.
+ booleanisAI(int pidx) + +
+          Returns whether the player at the specified player index is an AI.
+ booleanisPlayer(com.threerings.presents.data.ClientObject client) + +
+          Return true if the given client is a player in this place.
+ voidoccupantInRoom(com.threerings.crowd.data.BodyObject caller) + +
+          Called by the client when an occupant has arrived in the game room and has loaded their + bits.
+ booleanplayerIsReady(int pidx) + +
+          Returns true if the player at the specified slot is ready (or if there is meant to be no + player in that slot), false if there is meant to be a player in the specified slot and they + have not yet reported that they are ready.
+ voidplayerReady(com.threerings.crowd.data.BodyObject caller) + +
+          Called by the client when the player is ready for the game to start.
+ booleanremovePlayer(com.threerings.util.Name player) + +
+          Removes the given player from the game.
+ voidreplacePlayer(int pidx, + com.threerings.util.Name player) + +
+          Replaces the player at the specified index and calls playerWasReplaced(int, com.threerings.util.Name, com.threerings.util.Name) to let + derived classes and delegates know what's going on.
+ voidresetGame() + +
+          Called when the game is to be reset to its starting state in preparation for a new game + without actually ending the current game.
+ voidsetAI(int pidx, + GameAI ai) + +
+          Sets the specified player as an AI with the specified configuration.
+ booleanshouldConcludeGame() + +
+          Returns whether game conclusion antics such as rating updates should be performed when an + in-play game is ended.
+ booleanstartGame() + +
+          This is called when the game is ready to start (all players involved have delivered their + "am ready" notifications).
+ voidsystemMessage(String msgbundle, + String msg) + +
+          Sends a system message to the players in the game room.
+ voidsystemMessage(String msgbundle, + String msg, + boolean waitForStart) + +
+          Sends a system message to the players in the game room.
+  + + + + + + + +
Methods inherited from class com.threerings.crowd.server.PlaceManager
addDelegate, applyToDelegates, applyToOccupants, bodyWillEnter, bodyWillLeave, checkPermissions, getConfig, getLocation, getPlaceObject, init, isValidSpeaker, messageReceived, ratifyBodyEntry, registerMessageHandler, shutdown, startup, toString, updateOccupantInfo, where
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+GameManager

+
+public GameManager()
+
+
+ + + + + + + + +
+Method Detail
+ +

+getGameConfig

+
+public GameConfig getGameConfig()
+
+
Returns the configuration object for the game being managed by this manager. +

+

+
+
+
+
+
+
+
+ +

+getGameId

+
+public int getGameId()
+
+
Returns the unique numeric identifier for our managed game. See GameConfig.getGameId(). +

+

+
+
+
+
+
+
+
+ +

+getMatchType

+
+public int getMatchType()
+
+
A convenience method for getting the game type. +

+

+
+
+
+
+
+
+
+ +

+addPlayer

+
+public int addPlayer(com.threerings.util.Name player)
+
+
Adds the given player to the game at the first available player index. This should only be + called before the game is started, and is most likely to be used to add players to party + games. +

+

+
+
+
+
Parameters:
player - the username of the player to add to this game. +
Returns:
the player index at which the player was added, or -1 if the player + could not be added to the game.
+
+
+
+ +

+addPlayerAt

+
+public boolean addPlayerAt(com.threerings.util.Name player,
+                           int pidx)
+
+
Adds the given player to the game at the specified player index. This should only be called + before the game is started, and is most likely to be used to add players to party games. +

+

+
+
+
+
Parameters:
player - the username of the player to add to this game.
pidx - the player index at which the player is to be added. +
Returns:
true if the player was added successfully, false if not.
+
+
+
+ +

+removePlayer

+
+public boolean removePlayer(com.threerings.util.Name player)
+
+
Removes the given player from the game. This is most likely to be used to allow players + involved in a party game to leave the game early-on if they realize they'd rather not play + for some reason. +

+

+
+
+
+
Parameters:
player - the username of the player to remove from this game. +
Returns:
true if the player was successfully removed, false if not.
+
+
+
+ +

+replacePlayer

+
+public void replacePlayer(int pidx,
+                          com.threerings.util.Name player)
+
+
Replaces the player at the specified index and calls playerWasReplaced(int, com.threerings.util.Name, com.threerings.util.Name) to let + derived classes and delegates know what's going on. +

+

+
+
+
+
+
+
+
+ +

+getPlayer

+
+public com.threerings.crowd.data.BodyObject getPlayer(int playerIdx)
+
+
Returns the user object for the player with the specified index or null if the player at + that index is not online. +

+

+
+
+
+
+
+
+
+ +

+setAI

+
+public void setAI(int pidx,
+                  GameAI ai)
+
+
Sets the specified player as an AI with the specified configuration. It is assumed that this + will be set soon after the player names for all AIs present in the game. (It should be done + before human players start trickling into the game.) +

+

+
+
+
+
Parameters:
pidx - the player index of the AI.
ai - the AI configuration.
+
+
+
+ +

+getPlayerName

+
+public com.threerings.util.Name getPlayerName(int index)
+
+
Returns the name of the player with the specified index or null if no player exists at that + index. +

+

+
+
+
+
+
+
+
+ +

+getPlayerDisplayName

+
+public com.threerings.util.Name getPlayerDisplayName(int index)
+
+
Returns the name that should be shown in the client for the player with the specified index + or null if no player exists at that index. This may be different than their username as + returned by getPlayerName(int), which is the player's unique name in the server. +

+

+
+
+
+
+
+
+
+ +

+getPlayerIndex

+
+public int getPlayerIndex(com.threerings.util.Name username)
+
+
Returns the player index of the given user in the game, or -1 if the player is + not involved in the game. +

+

+
+
+
+
+
+
+
+ +

+getPresentPlayerIndex

+
+public int getPresentPlayerIndex(int bodyOid)
+
+
Get the player index of the specified oid, or -1 if the oid is not a player or is a player + that is not presently in the game. +

+

+
+
+
+
+
+
+
+ +

+getPlayerOid

+
+public int getPlayerOid(int index)
+
+
Returns the user object oid of the player with the specified index. +

+

+
+
+
+
+
+
+
+ +

+getPlayerPersistentId

+
+public int getPlayerPersistentId(com.threerings.util.Name name)
+
+
Returns the persistent user id for the supplied player name. +

+

+
+
+
+
+
+
+
+ +

+getPlayerPersistentId

+
+public int getPlayerPersistentId(com.threerings.crowd.data.BodyObject body)
+
+
Convenience for getting the persistent id from a body. +

+

+
+
+
+
+
+
+
+ +

+getPlayerCount

+
+public int getPlayerCount()
+
+
Returns the number of players in the game. +

+

+
+
+
+
+
+
+
+ +

+getPlayerSlots

+
+public int getPlayerSlots()
+
+
Returns the number of players allowed in this game. +

+

+
+
+
+
+
+
+
+ +

+isAI

+
+public boolean isAI(int pidx)
+
+
Returns whether the player at the specified player index is an AI. +

+

+
+
+
+
+
+
+
+ +

+isActivePlayer

+
+public boolean isActivePlayer(int pidx)
+
+
Returns whether the player at the specified player index is actively playing the game +

+

+
+
+
+
+
+
+
+ +

+getSessionId

+
+public int getSessionId()
+
+
Returns the unique session identifier for this game session. +

+

+
+
+
+
+
+
+
+ +

+systemMessage

+
+public void systemMessage(String msgbundle,
+                          String msg)
+
+
Sends a system message to the players in the game room. +

+

+
+
+
+
+
+
+
+ +

+systemMessage

+
+public void systemMessage(String msgbundle,
+                          String msg,
+                          boolean waitForStart)
+
+
Sends a system message to the players in the game room. +

+

+
+
+
+
Parameters:
waitForStart - if true, the message will not be sent until the game has started.
+
+
+
+ +

+startGame

+
+public boolean startGame()
+
+
This is called when the game is ready to start (all players involved have delivered their + "am ready" notifications). It calls gameWillStart(), sets the necessary wheels in + motion and then calls gameDidStart(). Derived classes should override one or both of + the calldown functions (rather than this function) if they need to do things before or after + the game starts. +

+

+
+
+
+ +
Returns:
true if the game was started, false if it could not be started because it was + already in play or because all players have not yet reported in.
+
+
+
+ +

+endPlayerGame

+
+public void endPlayerGame(int pidx)
+
+
Ends the game for the given player. +

+

+
+
+
+
+
+
+
+ +

+endGame

+
+public void endGame()
+
+
Called when the game is known to be over. This will call some calldown functions to + determine the winner of the game and then transition the game to the GameObject.GAME_OVER state. +

+

+
+
+
+
+
+
+
+ +

+cancelGame

+
+public boolean cancelGame()
+
+
Sets the state of the game to GameObject.CANCELLED. +

+

+
+
+
+ +
Returns:
true if the game was cancelled, false if it was already over or cancelled.
+
+
+
+ +

+shouldConcludeGame

+
+public boolean shouldConcludeGame()
+
+
Returns whether game conclusion antics such as rating updates should be performed when an + in-play game is ended. Derived classes may wish to override this method to customize the + conditions under which the game is concluded. +

+

+
+
+
+
+
+
+
+ +

+resetGame

+
+public void resetGame()
+
+
Called when the game is to be reset to its starting state in preparation for a new game + without actually ending the current game. It calls gameWillReset() followed by the + standard game start processing (gameWillStart() and gameDidStart()). Derived + classes should override these calldown functions (rather than this function) if they need to + do things before or after the game resets. +

+

+
+
+
+
+
+
+
+ +

+occupantInRoom

+
+public void occupantInRoom(com.threerings.crowd.data.BodyObject caller)
+
+
Called by the client when an occupant has arrived in the game room and has loaded their + bits. Most games will simply call playerReady(com.threerings.crowd.data.BodyObject) but games that wish to delay their + actual start until players take some action must report ASAP with a call to occupantInRoom(com.threerings.crowd.data.BodyObject) to let the server know that they have arrived and will later be calling + playerReady(com.threerings.crowd.data.BodyObject) when they are ready for the game to actually start. +

+

+
+
+
+
+
+
+
+ +

+playerReady

+
+public void playerReady(com.threerings.crowd.data.BodyObject caller)
+
+
Called by the client when the player is ready for the game to start. This method is + dispatched dynamically by PlaceManager.messageReceived(com.threerings.presents.dobj.MessageEvent). +

+

+
+
+
+
+
+
+
+ +

+allPlayersReady

+
+public boolean allPlayersReady()
+
+
Returns true if all (non-AI) players have delivered their playerReady(com.threerings.crowd.data.BodyObject) + notifications, false if they have not. +

+

+
+
+
+
+
+
+
+ +

+playerIsReady

+
+public boolean playerIsReady(int pidx)
+
+
Returns true if the player at the specified slot is ready (or if there is meant to be no + player in that slot), false if there is meant to be a player in the specified slot and they + have not yet reported that they are ready. +

+

+
+
+
+
+
+
+
+ +

+isPlayer

+
+public boolean isPlayer(com.threerings.presents.data.ClientObject client)
+
+
Description copied from interface: PlayManager
+
Return true if the given client is a player in this place. +

+

+
Specified by:
isPlayer in interface PlayManager
+
+
+
+
+
+
+ +

+isAgent

+
+public boolean isAgent(com.threerings.presents.data.ClientObject client)
+
+
Description copied from interface: PlayManager
+
Return true if the given client is a server-side agent in this place. +

+

+
Specified by:
isAgent in interface PlayManager
+
+
+
+
+
+
+ +

+checkWritePermission

+
+public com.threerings.crowd.data.BodyObject checkWritePermission(com.threerings.presents.data.ClientObject client,
+                                                                 int playerId)
+
+
Description copied from interface: PlayManager
+
Make sure that the given caller is a player or an agent and can write to the data + of the given playerId. +

+

+
Specified by:
checkWritePermission in interface PlayManager
+
+
+ +
Returns:
the resolved player object to write to
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/game/server/GameManagerDelegate.html b/apidocs/com/threerings/parlor/game/server/GameManagerDelegate.html new file mode 100644 index 00000000..dc71a1e8 --- /dev/null +++ b/apidocs/com/threerings/parlor/game/server/GameManagerDelegate.html @@ -0,0 +1,457 @@ + + + + + + + +GameManagerDelegate (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.game.server +
+Class GameManagerDelegate

+
+java.lang.Object
+  extended by com.threerings.crowd.server.PlaceManagerDelegate
+      extended by com.threerings.parlor.server.PlayManagerDelegate
+          extended by com.threerings.parlor.game.server.GameManagerDelegate
+
+
+
Direct Known Subclasses:
PuzzleManagerDelegate, RatingDelegate, TurnGameManagerDelegate
+
+
+
+
public class GameManagerDelegate
extends PlayManagerDelegate
+ + +

+Extends the PlayManagerDelegate mechanism with game manager specific methods. +

+ +

+

+ +

+ + + + + + + + + + + + + + +
+Constructor Summary
GameManagerDelegate() + +
+           
GameManagerDelegate(GameManager gmgr) + +
+          Deprecated. use the zero-argument constructor.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidgameDidEnd() + +
+          Called by the game manager after the game ended.
+ voidgameDidStart() + +
+          Called by the game manager after the game was started.
+ voidgameWillEnd() + +
+          Called by the game manager when the game is about to end.
+ voidgameWillReset() + +
+          Called when the game is about to reset, but before any other clearing out of game data has + taken place.
+ voidgameWillStart() + +
+          Called by the game manager when the game is about to start.
+ voidplayerWasReplaced(int pidx, + com.threerings.util.Name oldPlayer, + com.threerings.util.Name newPlayer) + +
+          Called when a player in the game has been replaced by a call to GameManager.replacePlayer(int, com.threerings.util.Name).
+ voidsetAI(int pidx, + GameAI ai) + +
+          Called when the specified player has been set as an AI with the supplied AI configuration.
+ voidtickAI(int pidx, + GameAI ai) + +
+          Called by the manager when we should do some AI.
+  + + + + + + + +
Methods inherited from class com.threerings.parlor.server.PlayManagerDelegate
didInit
+  + + + + + + + +
Methods inherited from class com.threerings.crowd.server.PlaceManagerDelegate
bodyEntered, bodyLeft, bodyUpdated, didShutdown, didStartup, init, placeBecameEmpty, where
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+GameManagerDelegate

+
+public GameManagerDelegate()
+
+
+
+ +

+GameManagerDelegate

+
+@Deprecated
+public GameManagerDelegate(GameManager gmgr)
+
+
Deprecated. use the zero-argument constructor. +

+

+ + + + + + + + +
+Method Detail
+ +

+gameWillStart

+
+public void gameWillStart()
+
+
Called by the game manager when the game is about to start. +

+

+
+
+
+
+ +

+gameDidStart

+
+public void gameDidStart()
+
+
Called by the game manager after the game was started. +

+

+
+
+
+
+ +

+playerWasReplaced

+
+public void playerWasReplaced(int pidx,
+                              com.threerings.util.Name oldPlayer,
+                              com.threerings.util.Name newPlayer)
+
+
Called when a player in the game has been replaced by a call to GameManager.replacePlayer(int, com.threerings.util.Name). +

+

+
+
+
+
+ +

+tickAI

+
+public void tickAI(int pidx,
+                   GameAI ai)
+
+
Called by the manager when we should do some AI. Only called while the game is IN_PLAY. +

+

+
Parameters:
pidx - the player index to fake some gameplay for.
ai - a record indicating the AI's configuration.
+
+
+
+ +

+gameWillEnd

+
+public void gameWillEnd()
+
+
Called by the game manager when the game is about to end. +

+

+
+
+
+
+ +

+gameDidEnd

+
+public void gameDidEnd()
+
+
Called by the game manager after the game ended. +

+

+
+
+
+
+ +

+gameWillReset

+
+public void gameWillReset()
+
+
Called when the game is about to reset, but before any other clearing out of game data has + taken place. Derived classes should override this if they need to perform some pre-reset + activities. +

+

+
+
+
+
+ +

+setAI

+
+public void setAI(int pidx,
+                  GameAI ai)
+
+
Called when the specified player has been set as an AI with the supplied AI configuration. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/game/server/GameWatcher.html b/apidocs/com/threerings/parlor/game/server/GameWatcher.html new file mode 100644 index 00000000..0fa0d299 --- /dev/null +++ b/apidocs/com/threerings/parlor/game/server/GameWatcher.html @@ -0,0 +1,310 @@ + + + + + + + +GameWatcher (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.game.server +
+Class GameWatcher<T extends GameObject>

+
+java.lang.Object
+  extended by com.threerings.parlor.game.server.GameWatcher<T>
+
+
+
All Implemented Interfaces:
com.threerings.presents.dobj.AttributeChangeListener, com.threerings.presents.dobj.ChangeListener
+
+
+
+
public abstract class GameWatcher<T extends GameObject>
extends Object
implements com.threerings.presents.dobj.AttributeChangeListener
+ + +

+An abstract convenience class used server-side to keep an eye on a game and perform a one-time + game-over activity when the game ends. Classes that care to make use of the game watcher should + create an instance with their newly created GameObject and implement + gameDidEnd(T). +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
GameWatcher() + +
+           
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidattributeChanged(com.threerings.presents.dobj.AttributeChangedEvent event) + +
+           
+ voidinit(com.threerings.crowd.server.PlaceManager plmgr) + +
+           
+ voidinit(T gameobj) + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+GameWatcher

+
+public GameWatcher()
+
+
+ + + + + + + + +
+Method Detail
+ +

+init

+
+public void init(com.threerings.crowd.server.PlaceManager plmgr)
+
+
+
+
+
+
+
+
+
+ +

+init

+
+public void init(T gameobj)
+
+
+
+
+
+
+
+
+
+ +

+attributeChanged

+
+public void attributeChanged(com.threerings.presents.dobj.AttributeChangedEvent event)
+
+
+
Specified by:
attributeChanged in interface com.threerings.presents.dobj.AttributeChangeListener
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/game/server/TeamGameManager.html b/apidocs/com/threerings/parlor/game/server/TeamGameManager.html new file mode 100644 index 00000000..92536267 --- /dev/null +++ b/apidocs/com/threerings/parlor/game/server/TeamGameManager.html @@ -0,0 +1,216 @@ + + + + + + + +TeamGameManager (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.game.server +
+Interface TeamGameManager

+
+
+
public interface TeamGameManager
+ + +

+An interface to be implemented by a game if it wants to hear about + the team indices that were configured during matchmaking. +

+ +

+

+ +

+ + + + + + + + + + + + +
+Method Summary
+ voidsetTeamMemberIndices(int[][] teams) + +
+          Set the team member indices.
+  +

+ + + + + + + + +
+Method Detail
+ +

+setTeamMemberIndices

+
+void setTeamMemberIndices(int[][] teams)
+
+
Set the team member indices. For example, a game with + three players in two teams- players 0 and 2 versus player 1- would + have { {0, 2}, {1} } set. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/game/server/class-use/GameManager.html b/apidocs/com/threerings/parlor/game/server/class-use/GameManager.html new file mode 100644 index 00000000..f1ec0406 --- /dev/null +++ b/apidocs/com/threerings/parlor/game/server/class-use/GameManager.html @@ -0,0 +1,270 @@ + + + + + + + +Uses of Class com.threerings.parlor.game.server.GameManager (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.game.server.GameManager

+
+ + + + + + + + + + + + + + + + + + + + + +
+Packages that use GameManager
com.threerings.micasa.simulator.server  
com.threerings.parlor.card.server  
com.threerings.parlor.game.server  
com.threerings.puzzle.server  
+  +

+ + + + + +
+Uses of GameManager in com.threerings.micasa.simulator.server
+  +

+ + + + + + + + + +
Methods in com.threerings.micasa.simulator.server with parameters of type GameManager
+ voidSimulant.init(com.threerings.crowd.data.BodyObject self, + GameConfig config, + GameManager gmgr, + com.threerings.presents.dobj.DObjectManager omgr) + +
+          Initializes the simulant with a body object and the game config for + the game they'll be engaged in.
+  +

+ + + + + +
+Uses of GameManager in com.threerings.parlor.card.server
+  +

+ + + + + + + + + +
Subclasses of GameManager in com.threerings.parlor.card.server
+ classCardGameManager + +
+          A manager class for card games.
+  +

+ + + + + +
+Uses of GameManager in com.threerings.parlor.game.server
+  +

+ + + + + + + + +
Constructors in com.threerings.parlor.game.server with parameters of type GameManager
GameManagerDelegate(GameManager gmgr) + +
+          Deprecated. use the zero-argument constructor.
+  +

+ + + + + +
+Uses of GameManager in com.threerings.puzzle.server
+  +

+ + + + + + + + + +
Subclasses of GameManager in com.threerings.puzzle.server
+ classPuzzleManager + +
+          Extends the GameManager with facilities for puzzle games.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/game/server/class-use/GameManagerDelegate.html b/apidocs/com/threerings/parlor/game/server/class-use/GameManagerDelegate.html new file mode 100644 index 00000000..be0a484a --- /dev/null +++ b/apidocs/com/threerings/parlor/game/server/class-use/GameManagerDelegate.html @@ -0,0 +1,301 @@ + + + + + + + +Uses of Class com.threerings.parlor.game.server.GameManagerDelegate (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.game.server.GameManagerDelegate

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
+Packages that use GameManagerDelegate
com.threerings.parlor.card.trick.server  
com.threerings.parlor.rating.server  
com.threerings.parlor.turn.server  
com.threerings.puzzle.drop.server  
com.threerings.puzzle.server  
+  +

+ + + + + +
+Uses of GameManagerDelegate in com.threerings.parlor.card.trick.server
+  +

+ + + + + + + + + +
Subclasses of GameManagerDelegate in com.threerings.parlor.card.trick.server
+ classTrickCardGameManagerDelegate + +
+          A card game manager delegate for trick-based card games, such as Spades and Hearts.
+  +

+ + + + + +
+Uses of GameManagerDelegate in com.threerings.parlor.rating.server
+  +

+ + + + + + + + + +
Subclasses of GameManagerDelegate in com.threerings.parlor.rating.server
+ classRatingDelegate + +
+          Rates players after each game and handles persisting the results.
+  +

+ + + + + +
+Uses of GameManagerDelegate in com.threerings.parlor.turn.server
+  +

+ + + + + + + + + +
Subclasses of GameManagerDelegate in com.threerings.parlor.turn.server
+ classTurnGameManagerDelegate + +
+          Performs the server-side turn-based game processing for a turn based game.
+  +

+ + + + + +
+Uses of GameManagerDelegate in com.threerings.puzzle.drop.server
+  +

+ + + + + + + + + +
Subclasses of GameManagerDelegate in com.threerings.puzzle.drop.server
+ classDropManagerDelegate + +
+          Provides the necessary support for a puzzle game that involves a two-dimensional board + containing pieces, with new pieces either falling into the board as a "drop block", or rising + into the bottom of the board in new piece rows, groups of blocks can be "broken" and garbage + can be sent to other players' boards as a result.
+  +

+ + + + + +
+Uses of GameManagerDelegate in com.threerings.puzzle.server
+  +

+ + + + + + + + + +
Subclasses of GameManagerDelegate in com.threerings.puzzle.server
+ classPuzzleManagerDelegate + +
+          Extends the GameManagerDelegate mechanism with puzzle manager specific methods (of + which there are currently none).
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/game/server/class-use/GameWatcher.html b/apidocs/com/threerings/parlor/game/server/class-use/GameWatcher.html new file mode 100644 index 00000000..e2e90a91 --- /dev/null +++ b/apidocs/com/threerings/parlor/game/server/class-use/GameWatcher.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.parlor.game.server.GameWatcher (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.game.server.GameWatcher

+
+No usage of com.threerings.parlor.game.server.GameWatcher +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/game/server/class-use/TeamGameManager.html b/apidocs/com/threerings/parlor/game/server/class-use/TeamGameManager.html new file mode 100644 index 00000000..59aad05e --- /dev/null +++ b/apidocs/com/threerings/parlor/game/server/class-use/TeamGameManager.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Interface com.threerings.parlor.game.server.TeamGameManager (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.parlor.game.server.TeamGameManager

+
+No usage of com.threerings.parlor.game.server.TeamGameManager +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/game/server/package-frame.html b/apidocs/com/threerings/parlor/game/server/package-frame.html new file mode 100644 index 00000000..e0e84d77 --- /dev/null +++ b/apidocs/com/threerings/parlor/game/server/package-frame.html @@ -0,0 +1,48 @@ + + + + + + + +com.threerings.parlor.game.server (vilya 1.3 API) + + + + + + + + + + + +com.threerings.parlor.game.server + + + + +
+Interfaces  + +
+TeamGameManager
+ + + + + + +
+Classes  + +
+GameManager +
+GameManagerDelegate +
+GameWatcher
+ + + + diff --git a/apidocs/com/threerings/parlor/game/server/package-summary.html b/apidocs/com/threerings/parlor/game/server/package-summary.html new file mode 100644 index 00000000..027ec008 --- /dev/null +++ b/apidocs/com/threerings/parlor/game/server/package-summary.html @@ -0,0 +1,182 @@ + + + + + + + +com.threerings.parlor.game.server (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.parlor.game.server +

+ + + + + + + + + +
+Interface Summary
TeamGameManagerAn interface to be implemented by a game if it wants to hear about + the team indices that were configured during matchmaking.
+  + +

+ + + + + + + + + + + + + + + + + +
+Class Summary
GameManagerThe game manager handles the server side management of a game.
GameManagerDelegateExtends the PlayManagerDelegate mechanism with game manager specific methods.
GameWatcher<T extends GameObject>An abstract convenience class used server-side to keep an eye on a game and perform a one-time + game-over activity when the game ends.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/game/server/package-tree.html b/apidocs/com/threerings/parlor/game/server/package-tree.html new file mode 100644 index 00000000..4d379359 --- /dev/null +++ b/apidocs/com/threerings/parlor/game/server/package-tree.html @@ -0,0 +1,168 @@ + + + + + + + +com.threerings.parlor.game.server Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.parlor.game.server +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/game/server/package-use.html b/apidocs/com/threerings/parlor/game/server/package-use.html new file mode 100644 index 00000000..9ccf3dae --- /dev/null +++ b/apidocs/com/threerings/parlor/game/server/package-use.html @@ -0,0 +1,310 @@ + + + + + + + +Uses of Package com.threerings.parlor.game.server (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.parlor.game.server

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Packages that use com.threerings.parlor.game.server
com.threerings.micasa.simulator.server  
com.threerings.parlor.card.server  
com.threerings.parlor.card.trick.server  
com.threerings.parlor.game.server  
com.threerings.parlor.rating.server  
com.threerings.parlor.turn.server  
com.threerings.puzzle.drop.server  
com.threerings.puzzle.server  
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.game.server used by com.threerings.micasa.simulator.server
GameManager + +
+          The game manager handles the server side management of a game.
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.game.server used by com.threerings.parlor.card.server
GameManager + +
+          The game manager handles the server side management of a game.
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.game.server used by com.threerings.parlor.card.trick.server
GameManagerDelegate + +
+          Extends the PlayManagerDelegate mechanism with game manager specific methods.
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.game.server used by com.threerings.parlor.game.server
GameManager + +
+          The game manager handles the server side management of a game.
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.game.server used by com.threerings.parlor.rating.server
GameManagerDelegate + +
+          Extends the PlayManagerDelegate mechanism with game manager specific methods.
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.game.server used by com.threerings.parlor.turn.server
GameManagerDelegate + +
+          Extends the PlayManagerDelegate mechanism with game manager specific methods.
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.game.server used by com.threerings.puzzle.drop.server
GameManagerDelegate + +
+          Extends the PlayManagerDelegate mechanism with game manager specific methods.
+  +

+ + + + + + + + + + + +
+Classes in com.threerings.parlor.game.server used by com.threerings.puzzle.server
GameManager + +
+          The game manager handles the server side management of a game.
GameManagerDelegate + +
+          Extends the PlayManagerDelegate mechanism with game manager specific methods.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/media/ScoreAnimation.html b/apidocs/com/threerings/parlor/media/ScoreAnimation.html new file mode 100644 index 00000000..dab7eec5 --- /dev/null +++ b/apidocs/com/threerings/parlor/media/ScoreAnimation.html @@ -0,0 +1,399 @@ + + + + + + + +ScoreAnimation (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.media +
+Class ScoreAnimation

+
+java.lang.Object
+  extended by com.threerings.media.AbstractMedia
+      extended by com.threerings.media.animation.Animation
+          extended by com.threerings.media.animation.FloatingTextAnimation
+              extended by com.threerings.parlor.media.ScoreAnimation
+
+
+
All Implemented Interfaces:
Shape
+
+
+
+
public class ScoreAnimation
extends com.threerings.media.animation.FloatingTextAnimation
+ + +

+

+ +

+ + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class com.threerings.media.AbstractMedia
HUD_LAYER
+  + + + + + + + + + + + + + + + + +
+Constructor Summary
ScoreAnimation(Label label, + int x, + int y) + +
+          Constructs a score animation for the given score value centered at the given coordinates.
ScoreAnimation(Label label, + int sx, + int sy, + int destx, + int desty, + long floatPeriod) + +
+          Constructs a score animation for the given score value starting at the given coordinates and + floating toward the specified coordinates.
ScoreAnimation(Label label, + int x, + int y, + long floatPeriod) + +
+          Constructs a score animation for the given score value centered at the given coordinates.
+  + + + + + + + + + + + + + + + +
+Method Summary
+static LabelcreateLabel(String score, + Color c, + Font font, + Component host) + +
+          Create and configure a Label suitable for a ScoreAnimation with all the most common options.
+static LabelcreateLabel(String score, + Color c, + Font font, + com.threerings.media.MediaPanel host) + +
+          Deprecated. This signature is retained for backwards compatibility.
+  + + + + + + + +
Methods inherited from class com.threerings.media.animation.FloatingTextAnimation
fastForward, flipDirection, getLabel, paint, setFloatPeriod, setLocation, tick
+  + + + + + + + +
Methods inherited from class com.threerings.media.animation.Animation
addAnimationObserver, isFinished, removeAnimationObserver, reset
+  + + + + + + + +
Methods inherited from class com.threerings.media.AbstractMedia
contains, contains, contains, contains, getBounds, getBounds2D, getPathIterator, getPathIterator, getRenderOrder, init, intersects, intersects, invalidate, queueNotification, renderCompareTo, setRenderOrder, toString, viewLocationDidChange
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+ScoreAnimation

+
+public ScoreAnimation(Label label,
+                      int x,
+                      int y)
+
+
Constructs a score animation for the given score value centered at the given coordinates. +

+

+
+ +

+ScoreAnimation

+
+public ScoreAnimation(Label label,
+                      int x,
+                      int y,
+                      long floatPeriod)
+
+
Constructs a score animation for the given score value centered at the given coordinates. + The animation will float up the screen for 30 pixels. +

+

+
+ +

+ScoreAnimation

+
+public ScoreAnimation(Label label,
+                      int sx,
+                      int sy,
+                      int destx,
+                      int desty,
+                      long floatPeriod)
+
+
Constructs a score animation for the given score value starting at the given coordinates and + floating toward the specified coordinates. +

+

+ + + + + + + + +
+Method Detail
+ +

+createLabel

+
+@Deprecated
+public static Label createLabel(String score,
+                                           Color c,
+                                           Font font,
+                                           com.threerings.media.MediaPanel host)
+
+
Deprecated. This signature is retained for backwards compatibility. +

+

Create and configure a Label suitable for a ScoreAnimation with all the most common options. +

+

+
+
+
+
+ +

+createLabel

+
+public static Label createLabel(String score,
+                                Color c,
+                                Font font,
+                                Component host)
+
+
Create and configure a Label suitable for a ScoreAnimation with all the most common options. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/media/class-use/ScoreAnimation.html b/apidocs/com/threerings/parlor/media/class-use/ScoreAnimation.html new file mode 100644 index 00000000..97e2bf1a --- /dev/null +++ b/apidocs/com/threerings/parlor/media/class-use/ScoreAnimation.html @@ -0,0 +1,232 @@ + + + + + + + +Uses of Class com.threerings.parlor.media.ScoreAnimation (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.media.ScoreAnimation

+
+ + + + + + + + + + + + + +
+Packages that use ScoreAnimation
com.threerings.puzzle.client  
com.threerings.puzzle.drop.client  
+  +

+ + + + + +
+Uses of ScoreAnimation in com.threerings.puzzle.client
+  +

+ + + + + + + + + +
Methods in com.threerings.puzzle.client that return ScoreAnimation
+ ScoreAnimationPuzzleBoardView.createScoreAnimation(String score, + Color color, + Font font, + int x, + int y) + +
+          Creates and returns an animation displaying the given string with the specified parameters, + floating it a short distance up the view.
+  +

+ + + + + +
+Uses of ScoreAnimation in com.threerings.puzzle.drop.client
+  +

+ + + + + + + + + + + + + +
Methods in com.threerings.puzzle.drop.client that return ScoreAnimation
+ ScoreAnimationDropBoardView.createScoreAnimation(String score, + Color color, + Font font) + +
+          Creates and returns an animation showing the specified score floating up the view, with the + label initially centered within the view.
+ ScoreAnimationDropBoardView.createScoreAnimation(String score, + Color color, + Font font, + int x, + int y, + int width, + int height) + +
+          Creates and returns an animation showing the specified score floating up the view.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/media/package-frame.html b/apidocs/com/threerings/parlor/media/package-frame.html new file mode 100644 index 00000000..3f17f731 --- /dev/null +++ b/apidocs/com/threerings/parlor/media/package-frame.html @@ -0,0 +1,33 @@ + + + + + + + +com.threerings.parlor.media (vilya 1.3 API) + + + + + + + + + + + +com.threerings.parlor.media + + + + +
+Classes  + +
+ScoreAnimation
+ + + + diff --git a/apidocs/com/threerings/parlor/media/package-summary.html b/apidocs/com/threerings/parlor/media/package-summary.html new file mode 100644 index 00000000..3978ed8a --- /dev/null +++ b/apidocs/com/threerings/parlor/media/package-summary.html @@ -0,0 +1,158 @@ + + + + + + + +com.threerings.parlor.media (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.parlor.media +

+ + + + + + + + + +
+Class Summary
ScoreAnimation 
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/media/package-tree.html b/apidocs/com/threerings/parlor/media/package-tree.html new file mode 100644 index 00000000..102403e3 --- /dev/null +++ b/apidocs/com/threerings/parlor/media/package-tree.html @@ -0,0 +1,161 @@ + + + + + + + +com.threerings.parlor.media Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.parlor.media +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/media/package-use.html b/apidocs/com/threerings/parlor/media/package-use.html new file mode 100644 index 00000000..39457708 --- /dev/null +++ b/apidocs/com/threerings/parlor/media/package-use.html @@ -0,0 +1,190 @@ + + + + + + + +Uses of Package com.threerings.parlor.media (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.parlor.media

+
+ + + + + + + + + + + + + +
+Packages that use com.threerings.parlor.media
com.threerings.puzzle.client  
com.threerings.puzzle.drop.client  
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.media used by com.threerings.puzzle.client
ScoreAnimation + +
+           
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.media used by com.threerings.puzzle.drop.client
ScoreAnimation + +
+           
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/package-frame.html b/apidocs/com/threerings/parlor/package-frame.html new file mode 100644 index 00000000..1c5123e2 --- /dev/null +++ b/apidocs/com/threerings/parlor/package-frame.html @@ -0,0 +1,33 @@ + + + + + + + +com.threerings.parlor (vilya 1.3 API) + + + + + + + + + + + +com.threerings.parlor + + + + +
+Classes  + +
+Log
+ + + + diff --git a/apidocs/com/threerings/parlor/package-summary.html b/apidocs/com/threerings/parlor/package-summary.html new file mode 100644 index 00000000..de967a23 --- /dev/null +++ b/apidocs/com/threerings/parlor/package-summary.html @@ -0,0 +1,158 @@ + + + + + + + +com.threerings.parlor (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.parlor +

+ + + + + + + + + +
+Class Summary
LogContains a reference to the log object used by the Parlor services.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/package-tree.html b/apidocs/com/threerings/parlor/package-tree.html new file mode 100644 index 00000000..af9e37d8 --- /dev/null +++ b/apidocs/com/threerings/parlor/package-tree.html @@ -0,0 +1,154 @@ + + + + + + + +com.threerings.parlor Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.parlor +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/package-use.html b/apidocs/com/threerings/parlor/package-use.html new file mode 100644 index 00000000..a3f6f30a --- /dev/null +++ b/apidocs/com/threerings/parlor/package-use.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Package com.threerings.parlor (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.parlor

+
+No usage of com.threerings.parlor +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/rating/data/RatingCodes.html b/apidocs/com/threerings/parlor/rating/data/RatingCodes.html new file mode 100644 index 00000000..c1d55ccd --- /dev/null +++ b/apidocs/com/threerings/parlor/rating/data/RatingCodes.html @@ -0,0 +1,254 @@ + + + + + + + +RatingCodes (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.rating.data +
+Interface RatingCodes

+
+
All Known Implementing Classes:
Rating, RatingDelegate
+
+
+
+
public interface RatingCodes
+ + +

+Constants relating to the rating services. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + +
+Field Summary
+static intDEFAULT_RATING + +
+          The default rating value.
+static intMAXIMUM_RATING + +
+          The maximum rating value.
+static intMINIMUM_RATING + +
+          The minimum rating value.
+  +

+ + + + + + + + +
+Field Detail
+ +

+MINIMUM_RATING

+
+static final int MINIMUM_RATING
+
+
The minimum rating value. +

+

+
See Also:
Constant Field Values
+
+
+ +

+DEFAULT_RATING

+
+static final int DEFAULT_RATING
+
+
The default rating value. +

+

+
See Also:
Constant Field Values
+
+
+ +

+MAXIMUM_RATING

+
+static final int MAXIMUM_RATING
+
+
The maximum rating value. +

+

+
See Also:
Constant Field Values
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/rating/data/class-use/RatingCodes.html b/apidocs/com/threerings/parlor/rating/data/class-use/RatingCodes.html new file mode 100644 index 00000000..9d3e7351 --- /dev/null +++ b/apidocs/com/threerings/parlor/rating/data/class-use/RatingCodes.html @@ -0,0 +1,190 @@ + + + + + + + +Uses of Interface com.threerings.parlor.rating.data.RatingCodes (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.parlor.rating.data.RatingCodes

+
+ + + + + + + + + +
+Packages that use RatingCodes
com.threerings.parlor.rating.server  
+  +

+ + + + + +
+Uses of RatingCodes in com.threerings.parlor.rating.server
+  +

+ + + + + + + + + + + + + +
Classes in com.threerings.parlor.rating.server that implement RatingCodes
+ classRating + +
+          Encapsulates the rating/experience tuple representing a player's rating for a game, and logic + for calculating rating changes.
+ classRatingDelegate + +
+          Rates players after each game and handles persisting the results.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/rating/data/package-frame.html b/apidocs/com/threerings/parlor/rating/data/package-frame.html new file mode 100644 index 00000000..3e8e5afd --- /dev/null +++ b/apidocs/com/threerings/parlor/rating/data/package-frame.html @@ -0,0 +1,33 @@ + + + + + + + +com.threerings.parlor.rating.data (vilya 1.3 API) + + + + + + + + + + + +com.threerings.parlor.rating.data + + + + +
+Interfaces  + +
+RatingCodes
+ + + + diff --git a/apidocs/com/threerings/parlor/rating/data/package-summary.html b/apidocs/com/threerings/parlor/rating/data/package-summary.html new file mode 100644 index 00000000..82b05761 --- /dev/null +++ b/apidocs/com/threerings/parlor/rating/data/package-summary.html @@ -0,0 +1,158 @@ + + + + + + + +com.threerings.parlor.rating.data (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.parlor.rating.data +

+ + + + + + + + + +
+Interface Summary
RatingCodesConstants relating to the rating services.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/rating/data/package-tree.html b/apidocs/com/threerings/parlor/rating/data/package-tree.html new file mode 100644 index 00000000..4603d027 --- /dev/null +++ b/apidocs/com/threerings/parlor/rating/data/package-tree.html @@ -0,0 +1,152 @@ + + + + + + + +com.threerings.parlor.rating.data Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.parlor.rating.data +

+
+
+
Package Hierarchies:
All Packages
+
+

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/rating/data/package-use.html b/apidocs/com/threerings/parlor/rating/data/package-use.html new file mode 100644 index 00000000..6c1b7538 --- /dev/null +++ b/apidocs/com/threerings/parlor/rating/data/package-use.html @@ -0,0 +1,171 @@ + + + + + + + +Uses of Package com.threerings.parlor.rating.data (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.parlor.rating.data

+
+ + + + + + + + + +
+Packages that use com.threerings.parlor.rating.data
com.threerings.parlor.rating.server  
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.rating.data used by com.threerings.parlor.rating.server
RatingCodes + +
+          Constants relating to the rating services.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/rating/server/Rating.html b/apidocs/com/threerings/parlor/rating/server/Rating.html new file mode 100644 index 00000000..f38fe280 --- /dev/null +++ b/apidocs/com/threerings/parlor/rating/server/Rating.html @@ -0,0 +1,446 @@ + + + + + + + +Rating (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.rating.server +
+Class Rating

+
+java.lang.Object
+  extended by com.threerings.parlor.rating.server.Rating
+
+
+
All Implemented Interfaces:
RatingCodes
+
+
+
+
public class Rating
extends Object
implements RatingCodes
+ + +

+Encapsulates the rating/experience tuple representing a player's rating for a game, and logic + for calculating rating changes. +

+ +

+

+ +

+ + + + + + + + + + + + + + + +
+Field Summary
+ intexperience + +
+          The number of times the player's played our game.
+ intrating + +
+          The player's rating for our game.
+  + + + + + + + +
Fields inherited from interface com.threerings.parlor.rating.data.RatingCodes
DEFAULT_RATING, MAXIMUM_RATING, MINIMUM_RATING
+  + + + + + + + + + + +
+Constructor Summary
Rating() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+static floatcomputeAdjustment(float W, + int opprat, + Rating rating) + +
+          Computes a ratings adjustment for the given player, using a modified + version of the FIDE Chess rating system as:
+static intcomputeRating(Rating[] ratings, + int pidx, + float W) + +
+          Computes a player's updated rating using a modified version of the + FIDE/ELO system.
+ booleanisProvisional() + +
+          Returns true if this rating is provisional (experience < 20).
+ StringtoString() + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+rating

+
+public int rating
+
+
The player's rating for our game. +

+

+
+
+
+ +

+experience

+
+public int experience
+
+
The number of times the player's played our game. +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+Rating

+
+public Rating()
+
+
+ + + + + + + + +
+Method Detail
+ +

+computeRating

+
+public static int computeRating(Rating[] ratings,
+                                int pidx,
+                                float W)
+
+
Computes a player's updated rating using a modified version of the + FIDE/ELO system. The rating adjustment is computed for the player versus + each opponent individually and these adjustments are summed and scaled + by one over the number of opponents to create the final rating + adjustment, which is then added to the player's previous rating and + bounded to the rating range. Note: provisional players (those + with experience of less than 20) will be treated as having, at most, the + default rating when used as an opponent in calculatons for a + non-provisional player. +

+

+
+
+
+
Parameters:
ratings - the pre-match ratings of each of the opponents.
pidx - the index of the player whose rating is to be calculated.
W - the win value for the player whose rating is to be calculated, + (1.0 means the player won, 0.5 means they drew, 0 means they lost). +
Returns:
the player's updated rating or -1 if none of the opponents could + be applicably rated against this player due to provisional/ + non-provisional mismatch or lack of participation.
+
+
+
+ +

+computeAdjustment

+
+public static float computeAdjustment(float W,
+                                      int opprat,
+                                      Rating rating)
+
+
Computes a ratings adjustment for the given player, using a modified + version of the FIDE Chess rating system as: + + 
+ adjustment = K(W - We)
+
+ where:
+
+ K = if (experience < 20) then 64
+     else if (rating < 2100 and experience >= 20) then 32
+     else if (rating >= 2100 and rating < 2400 and experience >= 20)
+          then 24
+     else 16
+ W = score for the game just completed, as 1.0, 0.5, and 0.0 for a
+ win, draw, or loss, respectively.
+ dR = opponent's rating minus player's rating.
+ We = expected score (win expectancy) as determined by:
+
+     We = 1 / (10^(dR/400) + 1)
+
+

+

+
+
+
+
Parameters:
W - the win value the game in question (1.0 means the player won, + 0.5 means they drew, 0 means they lost).
opprat - the opponent's current rating.
rating - the player's current rating. +
Returns:
the adjustment to the player's rating.
+
+
+
+ +

+isProvisional

+
+public boolean isProvisional()
+
+
Returns true if this rating is provisional (experience < 20). +

+

+
+
+
+
+
+
+
+ +

+toString

+
+public String toString()
+
+
+
Overrides:
toString in class Object
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/rating/server/RatingDelegate.html b/apidocs/com/threerings/parlor/rating/server/RatingDelegate.html new file mode 100644 index 00000000..aae6d672 --- /dev/null +++ b/apidocs/com/threerings/parlor/rating/server/RatingDelegate.html @@ -0,0 +1,418 @@ + + + + + + + +RatingDelegate (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.rating.server +
+Class RatingDelegate

+
+java.lang.Object
+  extended by com.threerings.crowd.server.PlaceManagerDelegate
+      extended by com.threerings.parlor.server.PlayManagerDelegate
+          extended by com.threerings.parlor.game.server.GameManagerDelegate
+              extended by com.threerings.parlor.rating.server.RatingDelegate
+
+
+
All Implemented Interfaces:
RatingCodes
+
+
+
+
public abstract class RatingDelegate
extends GameManagerDelegate
implements RatingCodes
+ + +

+Rates players after each game and handles persisting the results. +

+ +

+

+ +

+ + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from interface com.threerings.parlor.rating.data.RatingCodes
DEFAULT_RATING, MAXIMUM_RATING, MINIMUM_RATING
+  + + + + + + + + + + +
+Constructor Summary
RatingDelegate() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidbodyEntered(int bodyOid) + +
+           
+ voidbodyLeft(int bodyOid) + +
+           
+ voiddidInit(com.threerings.crowd.data.PlaceConfig config) + +
+           
+ voiddidStartup(com.threerings.crowd.data.PlaceObject plobj) + +
+           
+ voidgameDidEnd() + +
+          Called by the game manager after the game ended.
+ voidgameWillStart() + +
+          Called by the game manager when the game is about to start.
+  + + + + + + + +
Methods inherited from class com.threerings.parlor.game.server.GameManagerDelegate
gameDidStart, gameWillEnd, gameWillReset, playerWasReplaced, setAI, tickAI
+  + + + + + + + +
Methods inherited from class com.threerings.crowd.server.PlaceManagerDelegate
bodyUpdated, didShutdown, init, placeBecameEmpty, where
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+RatingDelegate

+
+public RatingDelegate()
+
+
+ + + + + + + + +
+Method Detail
+ +

+didInit

+
+public void didInit(com.threerings.crowd.data.PlaceConfig config)
+
+
+
Overrides:
didInit in class PlayManagerDelegate
+
+
+
+
+
+
+ +

+didStartup

+
+public void didStartup(com.threerings.crowd.data.PlaceObject plobj)
+
+
+
Overrides:
didStartup in class com.threerings.crowd.server.PlaceManagerDelegate
+
+
+
+
+
+
+ +

+bodyEntered

+
+public void bodyEntered(int bodyOid)
+
+
+
Overrides:
bodyEntered in class com.threerings.crowd.server.PlaceManagerDelegate
+
+
+
+
+
+
+ +

+bodyLeft

+
+public void bodyLeft(int bodyOid)
+
+
+
Overrides:
bodyLeft in class com.threerings.crowd.server.PlaceManagerDelegate
+
+
+
+
+
+
+ +

+gameWillStart

+
+public void gameWillStart()
+
+
Description copied from class: GameManagerDelegate
+
Called by the game manager when the game is about to start. +

+

+
Overrides:
gameWillStart in class GameManagerDelegate
+
+
+
+
+
+
+ +

+gameDidEnd

+
+public void gameDidEnd()
+
+
Description copied from class: GameManagerDelegate
+
Called by the game manager after the game ended. +

+

+
Overrides:
gameDidEnd in class GameManagerDelegate
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/rating/server/class-use/Rating.html b/apidocs/com/threerings/parlor/rating/server/class-use/Rating.html new file mode 100644 index 00000000..cd91bdb8 --- /dev/null +++ b/apidocs/com/threerings/parlor/rating/server/class-use/Rating.html @@ -0,0 +1,195 @@ + + + + + + + +Uses of Class com.threerings.parlor.rating.server.Rating (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.rating.server.Rating

+
+ + + + + + + + + +
+Packages that use Rating
com.threerings.parlor.rating.server  
+  +

+ + + + + +
+Uses of Rating in com.threerings.parlor.rating.server
+  +

+ + + + + + + + + + + + + +
Methods in com.threerings.parlor.rating.server with parameters of type Rating
+static floatRating.computeAdjustment(float W, + int opprat, + Rating rating) + +
+          Computes a ratings adjustment for the given player, using a modified + version of the FIDE Chess rating system as:
+static intRating.computeRating(Rating[] ratings, + int pidx, + float W) + +
+          Computes a player's updated rating using a modified version of the + FIDE/ELO system.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/rating/server/class-use/RatingDelegate.html b/apidocs/com/threerings/parlor/rating/server/class-use/RatingDelegate.html new file mode 100644 index 00000000..92c73654 --- /dev/null +++ b/apidocs/com/threerings/parlor/rating/server/class-use/RatingDelegate.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.parlor.rating.server.RatingDelegate (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.rating.server.RatingDelegate

+
+No usage of com.threerings.parlor.rating.server.RatingDelegate +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/rating/server/package-frame.html b/apidocs/com/threerings/parlor/rating/server/package-frame.html new file mode 100644 index 00000000..1e843fed --- /dev/null +++ b/apidocs/com/threerings/parlor/rating/server/package-frame.html @@ -0,0 +1,35 @@ + + + + + + + +com.threerings.parlor.rating.server (vilya 1.3 API) + + + + + + + + + + + +com.threerings.parlor.rating.server + + + + +
+Classes  + +
+Rating +
+RatingDelegate
+ + + + diff --git a/apidocs/com/threerings/parlor/rating/server/package-summary.html b/apidocs/com/threerings/parlor/rating/server/package-summary.html new file mode 100644 index 00000000..3fdf33c1 --- /dev/null +++ b/apidocs/com/threerings/parlor/rating/server/package-summary.html @@ -0,0 +1,163 @@ + + + + + + + +com.threerings.parlor.rating.server (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.parlor.rating.server +

+ + + + + + + + + + + + + +
+Class Summary
RatingEncapsulates the rating/experience tuple representing a player's rating for a game, and logic + for calculating rating changes.
RatingDelegateRates players after each game and handles persisting the results.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/rating/server/package-tree.html b/apidocs/com/threerings/parlor/rating/server/package-tree.html new file mode 100644 index 00000000..65ecb086 --- /dev/null +++ b/apidocs/com/threerings/parlor/rating/server/package-tree.html @@ -0,0 +1,162 @@ + + + + + + + +com.threerings.parlor.rating.server Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.parlor.rating.server +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/rating/server/package-use.html b/apidocs/com/threerings/parlor/rating/server/package-use.html new file mode 100644 index 00000000..9076c87e --- /dev/null +++ b/apidocs/com/threerings/parlor/rating/server/package-use.html @@ -0,0 +1,172 @@ + + + + + + + +Uses of Package com.threerings.parlor.rating.server (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.parlor.rating.server

+
+ + + + + + + + + +
+Packages that use com.threerings.parlor.rating.server
com.threerings.parlor.rating.server  
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.rating.server used by com.threerings.parlor.rating.server
Rating + +
+          Encapsulates the rating/experience tuple representing a player's rating for a game, and logic + for calculating rating changes.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/rating/server/persist/PercentileRecord.html b/apidocs/com/threerings/parlor/rating/server/persist/PercentileRecord.html new file mode 100644 index 00000000..c4639701 --- /dev/null +++ b/apidocs/com/threerings/parlor/rating/server/persist/PercentileRecord.html @@ -0,0 +1,449 @@ + + + + + + + +PercentileRecord (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.rating.server.persist +
+Class PercentileRecord

+
+java.lang.Object
+  extended by com.samskivert.depot.impl.QueryResult
+      extended by com.samskivert.depot.PersistentRecord
+          extended by com.threerings.parlor.rating.server.persist.PercentileRecord
+
+
+
All Implemented Interfaces:
Serializable, Cloneable
+
+
+
+
public class PercentileRecord
extends PersistentRecord
+ + +

+Contains data for a Percentiler record. +

+ +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static Class<PercentileRecord>_R + +
+           
+ byte[]data + +
+          The raw percentiler data.
+static ColumnExp<byte[]>DATA + +
+           
+static ColumnExp<Integer>GAME_ID + +
+           
+static ColumnExp<Integer>GAME_MODE + +
+           
+ intgameId + +
+          The id of the game for which we're tracking a percentile distribution.
+ intgameMode + +
+          The mode of the game.
+static intSCHEMA_VERSION + +
+          Increment this value to reflect changes to this object's schema.
+  + + + + + + + + + + +
+Constructor Summary
PercentileRecord() + +
+           
+  + + + + + + + + + + + +
+Method Summary
+static Key<PercentileRecord>getKey(int gameId, + int gameMode) + +
+          Create and return a primary Key to identify a PercentileRecord + with the supplied key values.
+  + + + + + + + +
Methods inherited from class com.samskivert.depot.impl.QueryResult
clone
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+_R

+
+public static final Class<PercentileRecord> _R
+
+
+
+
+
+ +

+GAME_ID

+
+public static final ColumnExp<Integer> GAME_ID
+
+
+
+
+
+ +

+GAME_MODE

+
+public static final ColumnExp<Integer> GAME_MODE
+
+
+
+
+
+ +

+DATA

+
+public static final ColumnExp<byte[]> DATA
+
+
+
+
+
+ +

+SCHEMA_VERSION

+
+public static final int SCHEMA_VERSION
+
+
Increment this value to reflect changes to this object's schema. +

+

+
See Also:
Constant Field Values
+
+
+ +

+gameId

+
+public int gameId
+
+
The id of the game for which we're tracking a percentile distribution. +

+

+
+
+
+ +

+gameMode

+
+public int gameMode
+
+
The mode of the game. Games can maintain distributions for many different modes. +

+

+
+
+
+ +

+data

+
+public byte[] data
+
+
The raw percentiler data. +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+PercentileRecord

+
+public PercentileRecord()
+
+
+ + + + + + + + +
+Method Detail
+ +

+getKey

+
+public static Key<PercentileRecord> getKey(int gameId,
+                                           int gameMode)
+
+
Create and return a primary Key to identify a PercentileRecord + with the supplied key values. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/rating/server/persist/RatingRecord.html b/apidocs/com/threerings/parlor/rating/server/persist/RatingRecord.html new file mode 100644 index 00000000..427c5d7b --- /dev/null +++ b/apidocs/com/threerings/parlor/rating/server/persist/RatingRecord.html @@ -0,0 +1,565 @@ + + + + + + + +RatingRecord (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.rating.server.persist +
+Class RatingRecord

+
+java.lang.Object
+  extended by com.samskivert.depot.impl.QueryResult
+      extended by com.samskivert.depot.PersistentRecord
+          extended by com.threerings.parlor.rating.server.persist.RatingRecord
+
+
+
All Implemented Interfaces:
Serializable, Cloneable
+
+
+
+
public class RatingRecord
extends PersistentRecord
+ + +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static Class<RatingRecord>_R + +
+           
+ intexperience + +
+          The number of times the player has played this game.
+static ColumnExp<Integer>EXPERIENCE + +
+           
+static ColumnExp<Integer>GAME_ID + +
+           
+ intgameId + +
+          The identifier of the game we're rating for.
+static ColumnExp<Timestamp>LAST_UPDATED + +
+           
+ TimestamplastUpdated + +
+          The last time this rating was updated.
+static ColumnExp<Integer>PLAYER_ID + +
+           
+ intplayerId + +
+          The identifier of the player we're rating.
+ intrating + +
+          The player's current rating.
+static ColumnExp<Integer>RATING + +
+           
+static intSCHEMA_VERSION + +
+           
+  + + + + + + + + + + + + + +
+Constructor Summary
RatingRecord() + +
+          An empty constructor for unmarshalling.
RatingRecord(int gameId, + int playerId, + int rating, + int experience) + +
+          A constructor that populates all our fields.
+  + + + + + + + + + + + + + + + +
+Method Summary
+static Key<RatingRecord>getKey(int gameId, + int playerId) + +
+          Create and return a primary Key to identify a RatingRecord + with the supplied key values.
+ StringtoString() + +
+           
+  + + + + + + + +
Methods inherited from class com.samskivert.depot.impl.QueryResult
clone
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+_R

+
+public static final Class<RatingRecord> _R
+
+
+
+
+
+ +

+GAME_ID

+
+public static final ColumnExp<Integer> GAME_ID
+
+
+
+
+
+ +

+PLAYER_ID

+
+public static final ColumnExp<Integer> PLAYER_ID
+
+
+
+
+
+ +

+RATING

+
+public static final ColumnExp<Integer> RATING
+
+
+
+
+
+ +

+EXPERIENCE

+
+public static final ColumnExp<Integer> EXPERIENCE
+
+
+
+
+
+ +

+LAST_UPDATED

+
+public static final ColumnExp<Timestamp> LAST_UPDATED
+
+
+
+
+
+ +

+SCHEMA_VERSION

+
+public static final int SCHEMA_VERSION
+
+
+
See Also:
Constant Field Values
+
+
+ +

+gameId

+
+public int gameId
+
+
The identifier of the game we're rating for. +

+

+
+
+
+ +

+playerId

+
+public int playerId
+
+
The identifier of the player we're rating. +

+

+
+
+
+ +

+rating

+
+public int rating
+
+
The player's current rating. +

+

+
+
+
+ +

+experience

+
+public int experience
+
+
The number of times the player has played this game. +

+

+
+
+
+ +

+lastUpdated

+
+public Timestamp lastUpdated
+
+
The last time this rating was updated. +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+RatingRecord

+
+public RatingRecord()
+
+
An empty constructor for unmarshalling. +

+

+
+ +

+RatingRecord

+
+public RatingRecord(int gameId,
+                    int playerId,
+                    int rating,
+                    int experience)
+
+
A constructor that populates all our fields. +

+

+ + + + + + + + +
+Method Detail
+ +

+toString

+
+public String toString()
+
+
+
Overrides:
toString in class Object
+
+
+
+
+
+
+ +

+getKey

+
+public static Key<RatingRecord> getKey(int gameId,
+                                       int playerId)
+
+
Create and return a primary Key to identify a RatingRecord + with the supplied key values. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/rating/server/persist/RatingRepository.html b/apidocs/com/threerings/parlor/rating/server/persist/RatingRepository.html new file mode 100644 index 00000000..193c0025 --- /dev/null +++ b/apidocs/com/threerings/parlor/rating/server/persist/RatingRepository.html @@ -0,0 +1,617 @@ + + + + + + + +RatingRepository (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.rating.server.persist +
+Class RatingRepository

+
+java.lang.Object
+  extended by com.samskivert.depot.DepotRepository
+      extended by com.threerings.parlor.rating.server.persist.RatingRepository
+
+
+
+
public class RatingRepository
extends DepotRepository
+ + +

+Handles the persistent storage of per-user per-game ratings. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class com.samskivert.depot.DepotRepository
DepotRepository.CacheStrategy
+  + + + + + + + + + + + +
+Constructor Summary
RatingRepository(PersistenceContext ctx) + +
+          Initialize the RatingRepository.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voiddeletePercentile(int gameId, + int gameMode) + +
+          Deletes the percentile record for the specified game and game mode.
+ voiddeleteRating(int gameId, + int playerId) + +
+          Deletes the specified rating record.
+ Collection<RatingRecord>getMostRecentRatings(Collection<Integer> playerIds, + Collection<Integer> gameIds, + int gameIdSign) + +
+          Load the most recently entered rating for each of a collection of players.
+ Collection<RatingRecord>getMostRecentRatings(Collection<Integer> playerIds, + int gameIdSign) + +
+          Load the most recently entered rating for each of a collection of players.
+ RatingRecordgetRating(int gameId, + int playerId) + +
+          Loads the rating for the given player for the given game and returns it as a + RatingRecord object, or null if the player has no previous rating for the game.
+ List<RatingRecord>getRatings(int gameId, + Integer... players) + +
+          Fetch the ratings registered for any of the given players for the given game and return + them as a list of RatingRecord objects.
+ List<RatingRecord>getRatings(int playerId, + long since, + int count) + +
+          Fetch and return all the registered RatingRecord rows for the given player.
+ List<RatingRecord>getTopRatings(int gameId, + int limit, + long since, + Set<Integer> playerIds) + +
+          Returns the top-ratings for the specified game.
+ PercentilerloadPercentile(int gameId, + int gameMode) + +
+          Loads the percentile distribution associated with the specified game and mode.
+ Map<Integer,Percentiler>loadPercentiles(int gameId) + +
+          Loads all the percentile distributions associated with the specified game.
+ voidpurgeGame(int gameId) + +
+          Deletes all rating and percentile records for the specified game.
+ voidpurgePlayers(Collection<Integer> playerIds) + +
+          Deletes all rating records for the specified players.
+ voidsetRating(int gameId, + int playerId, + int rating, + int experience) + +
+          Set the rating and experience for a given player and game.
+ voidupdatePercentile(int gameId, + int gameMode, + Percentiler tiler) + +
+          Writes the supplied percentiler's data out to the database.
+  + + + + + + + +
Methods inherited from class com.samskivert.depot.DepotRepository
delete, delete, deleteAll, deleteAll, findAll, findAll, findAll, findAll, findAllKeys, findAllKeys, from, insert, load, load, load, load, loadAll, loadAll, store, update, update, updatePartial, updatePartial, updatePartial, updatePartial, updatePartial
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+RatingRepository

+
+@Inject
+public RatingRepository(PersistenceContext ctx)
+
+
Initialize the RatingRepository. +

+

+ + + + + + + + +
+Method Detail
+ +

+getRating

+
+public RatingRecord getRating(int gameId,
+                              int playerId)
+
+
Loads the rating for the given player for the given game and returns it as a + RatingRecord object, or null if the player has no previous rating for the game. +

+

+
+
+
+
+ +

+getRatings

+
+public List<RatingRecord> getRatings(int gameId,
+                                     Integer... players)
+
+
Fetch the ratings registered for any of the given players for the given game and return + them as a list of RatingRecord objects. The size of this list is no less than zero + and no greater than the number of given players. +

+

+
+
+
+
+ +

+getRatings

+
+public List<RatingRecord> getRatings(int playerId,
+                                     long since,
+                                     int count)
+
+
Fetch and return all the registered RatingRecord rows for the given player. Ratings + will be returned in order of most recently to least recently updated. +

+

+
Parameters:
since - ratings last updated more than this number of milliseconds in the past will be + ommitted from the result list. Supplying -1 will return all ratings regardless of age.
count - the maximum number of ratings to return or -1 for all ratings.
+
+
+
+ +

+getTopRatings

+
+public List<RatingRecord> getTopRatings(int gameId,
+                                        int limit,
+                                        long since,
+                                        Set<Integer> playerIds)
+
+
Returns the top-ratings for the specified game. Players with equal rating will be sorted + most recently played first. +

+

+
Parameters:
since - an absolute number of milliseconds (ie. 10*24*60*60*1000L). Players that have + not updated their rating within this many milliseconds in the past will be omitted from the + results. Supply zero to omit this filter.
playerIds - an optional list of player ids to which to limit the top-rankings search.
+
+
+
+ +

+setRating

+
+public void setRating(int gameId,
+                      int playerId,
+                      int rating,
+                      int experience)
+
+
Set the rating and experience for a given player and game. This method will either update + or create a row. +

+

+
+
+
+
+ +

+deleteRating

+
+public void deleteRating(int gameId,
+                         int playerId)
+
+
Deletes the specified rating record. +

+

+
+
+
+
+ +

+loadPercentile

+
+public Percentiler loadPercentile(int gameId,
+                                  int gameMode)
+
+
Loads the percentile distribution associated with the specified game and mode. null will + never be returned, rather a blank percentiler will be created and returned. +

+

+
+
+
+
+ +

+loadPercentiles

+
+public Map<Integer,Percentiler> loadPercentiles(int gameId)
+
+
Loads all the percentile distributions associated with the specified game. The percentilers + will be mapped by their game mode. The map may be zero size if the game has recorded no + distributions. +

+

+
+
+
+
+ +

+updatePercentile

+
+public void updatePercentile(int gameId,
+                             int gameMode,
+                             Percentiler tiler)
+
+
Writes the supplied percentiler's data out to the database. +

+

+
+
+
+
+ +

+deletePercentile

+
+public void deletePercentile(int gameId,
+                             int gameMode)
+
+
Deletes the percentile record for the specified game and game mode. +

+

+
+
+
+
+ +

+purgeGame

+
+public void purgeGame(int gameId)
+
+
Deletes all rating and percentile records for the specified game. +

+

+
+
+
+
+ +

+purgePlayers

+
+public void purgePlayers(Collection<Integer> playerIds)
+
+
Deletes all rating records for the specified players. +

+

+
+
+
+
+ +

+getMostRecentRatings

+
+public Collection<RatingRecord> getMostRecentRatings(Collection<Integer> playerIds,
+                                                     int gameIdSign)
+
+
Load the most recently entered rating for each of a collection of players. The search may + be limited to only negative or positive id's since applications may use the sign to indicate + game mode. +

+

+
Parameters:
gameIdSign - if non-zero, limits the search to game ids of matching sign
+
+
+
+ +

+getMostRecentRatings

+
+public Collection<RatingRecord> getMostRecentRatings(Collection<Integer> playerIds,
+                                                     Collection<Integer> gameIds,
+                                                     int gameIdSign)
+
+
Load the most recently entered rating for each of a collection of players. The search may + be limited to a specific collection of games. +

+

+
Parameters:
gameIds - if not null, limits the search to the specific game ids
gameIdSign - if non-zero, limits the search to game ids of matching sign
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/rating/server/persist/class-use/PercentileRecord.html b/apidocs/com/threerings/parlor/rating/server/persist/class-use/PercentileRecord.html new file mode 100644 index 00000000..e0138eae --- /dev/null +++ b/apidocs/com/threerings/parlor/rating/server/persist/class-use/PercentileRecord.html @@ -0,0 +1,199 @@ + + + + + + + +Uses of Class com.threerings.parlor.rating.server.persist.PercentileRecord (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.rating.server.persist.PercentileRecord

+
+ + + + + + + + + +
+Packages that use PercentileRecord
com.threerings.parlor.rating.server.persist  
+  +

+ + + + + +
+Uses of PercentileRecord in com.threerings.parlor.rating.server.persist
+  +

+ + + + + + + + + +
Fields in com.threerings.parlor.rating.server.persist with type parameters of type PercentileRecord
+static Class<PercentileRecord>PercentileRecord._R + +
+           
+  +

+ + + + + + + + + +
Methods in com.threerings.parlor.rating.server.persist that return types with arguments of type PercentileRecord
+static Key<PercentileRecord>PercentileRecord.getKey(int gameId, + int gameMode) + +
+          Create and return a primary Key to identify a PercentileRecord + with the supplied key values.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/rating/server/persist/class-use/RatingRecord.html b/apidocs/com/threerings/parlor/rating/server/persist/class-use/RatingRecord.html new file mode 100644 index 00000000..5073427f --- /dev/null +++ b/apidocs/com/threerings/parlor/rating/server/persist/class-use/RatingRecord.html @@ -0,0 +1,267 @@ + + + + + + + +Uses of Class com.threerings.parlor.rating.server.persist.RatingRecord (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.rating.server.persist.RatingRecord

+
+ + + + + + + + + +
+Packages that use RatingRecord
com.threerings.parlor.rating.server.persist  
+  +

+ + + + + +
+Uses of RatingRecord in com.threerings.parlor.rating.server.persist
+  +

+ + + + + + + + + +
Fields in com.threerings.parlor.rating.server.persist with type parameters of type RatingRecord
+static Class<RatingRecord>RatingRecord._R + +
+           
+  +

+ + + + + + + + + +
Methods in com.threerings.parlor.rating.server.persist that return RatingRecord
+ RatingRecordRatingRepository.getRating(int gameId, + int playerId) + +
+          Loads the rating for the given player for the given game and returns it as a + RatingRecord object, or null if the player has no previous rating for the game.
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in com.threerings.parlor.rating.server.persist that return types with arguments of type RatingRecord
+static Key<RatingRecord>RatingRecord.getKey(int gameId, + int playerId) + +
+          Create and return a primary Key to identify a RatingRecord + with the supplied key values.
+ Collection<RatingRecord>RatingRepository.getMostRecentRatings(Collection<Integer> playerIds, + Collection<Integer> gameIds, + int gameIdSign) + +
+          Load the most recently entered rating for each of a collection of players.
+ Collection<RatingRecord>RatingRepository.getMostRecentRatings(Collection<Integer> playerIds, + int gameIdSign) + +
+          Load the most recently entered rating for each of a collection of players.
+ List<RatingRecord>RatingRepository.getRatings(int gameId, + Integer... players) + +
+          Fetch the ratings registered for any of the given players for the given game and return + them as a list of RatingRecord objects.
+ List<RatingRecord>RatingRepository.getRatings(int playerId, + long since, + int count) + +
+          Fetch and return all the registered RatingRecord rows for the given player.
+ List<RatingRecord>RatingRepository.getTopRatings(int gameId, + int limit, + long since, + Set<Integer> playerIds) + +
+          Returns the top-ratings for the specified game.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/rating/server/persist/class-use/RatingRepository.html b/apidocs/com/threerings/parlor/rating/server/persist/class-use/RatingRepository.html new file mode 100644 index 00000000..14b76726 --- /dev/null +++ b/apidocs/com/threerings/parlor/rating/server/persist/class-use/RatingRepository.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.parlor.rating.server.persist.RatingRepository (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.rating.server.persist.RatingRepository

+
+No usage of com.threerings.parlor.rating.server.persist.RatingRepository +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/rating/server/persist/package-frame.html b/apidocs/com/threerings/parlor/rating/server/persist/package-frame.html new file mode 100644 index 00000000..ae9bf853 --- /dev/null +++ b/apidocs/com/threerings/parlor/rating/server/persist/package-frame.html @@ -0,0 +1,37 @@ + + + + + + + +com.threerings.parlor.rating.server.persist (vilya 1.3 API) + + + + + + + + + + + +com.threerings.parlor.rating.server.persist + + + + +
+Classes  + +
+PercentileRecord +
+RatingRecord +
+RatingRepository
+ + + + diff --git a/apidocs/com/threerings/parlor/rating/server/persist/package-summary.html b/apidocs/com/threerings/parlor/rating/server/persist/package-summary.html new file mode 100644 index 00000000..9f619d07 --- /dev/null +++ b/apidocs/com/threerings/parlor/rating/server/persist/package-summary.html @@ -0,0 +1,166 @@ + + + + + + + +com.threerings.parlor.rating.server.persist (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.parlor.rating.server.persist +

+ + + + + + + + + + + + + + + + + +
+Class Summary
PercentileRecordContains data for a Percentiler record.
RatingRecord 
RatingRepositoryHandles the persistent storage of per-user per-game ratings.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/rating/server/persist/package-tree.html b/apidocs/com/threerings/parlor/rating/server/persist/package-tree.html new file mode 100644 index 00000000..367980cd --- /dev/null +++ b/apidocs/com/threerings/parlor/rating/server/persist/package-tree.html @@ -0,0 +1,161 @@ + + + + + + + +com.threerings.parlor.rating.server.persist Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.parlor.rating.server.persist +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/rating/server/persist/package-use.html b/apidocs/com/threerings/parlor/rating/server/persist/package-use.html new file mode 100644 index 00000000..49179f08 --- /dev/null +++ b/apidocs/com/threerings/parlor/rating/server/persist/package-use.html @@ -0,0 +1,177 @@ + + + + + + + +Uses of Package com.threerings.parlor.rating.server.persist (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.parlor.rating.server.persist

+
+ + + + + + + + + +
+Packages that use com.threerings.parlor.rating.server.persist
com.threerings.parlor.rating.server.persist  
+  +

+ + + + + + + + + + + +
+Classes in com.threerings.parlor.rating.server.persist used by com.threerings.parlor.rating.server.persist
PercentileRecord + +
+          Contains data for a Percentiler record.
RatingRecord + +
+           
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/rating/util/Percentiler.html b/apidocs/com/threerings/parlor/rating/util/Percentiler.html new file mode 100644 index 00000000..cdd65995 --- /dev/null +++ b/apidocs/com/threerings/parlor/rating/util/Percentiler.html @@ -0,0 +1,623 @@ + + + + + + + +Percentiler (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.rating.util +
+Class Percentiler

+
+java.lang.Object
+  extended by com.threerings.parlor.rating.util.Percentiler
+
+
+
+
public class Percentiler
extends Object
+ + +

+Used to keep track of the percentile distribution of positive values (generally puzzle scores). +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + +
+Constructor Summary
Percentiler() + +
+          Creates an empty percentiler.
Percentiler(byte[] data) + +
+          Creates a percentiler from its serialized representation.
Percentiler(int min, + int max) + +
+          Creates a percentiler that expects values to fall within the given range.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidclearModified() + +
+          Clears this percentiler's "is modified" state.
+ voiddump(PrintWriter out) + +
+          Dumps a text representation of this percentiler to the supplied print stream.
+ voiddumpGnuPlot(PrintWriter out) + +
+          Dumps out our data in a format that can be used to generate a gnuplot.
+ int[]getCounts() + +
+          Returns the counts for each bucket.
+ intgetMaxScore() + +
+          Returns the largest score seen by this percentiler.
+ intgetMinScore() + +
+          Returns the smallest score seen by this percentiler.
+ intgetPercentile(float value) + +
+          Returns the percent of all numbers seen that are lower than the specified value.
+ longgetRecordedCount() + +
+          Returns the total number of values ever recorded to this percentiler.
+ floatgetRequiredScore(int percentile) + +
+          Returns the score necessary to attain the specified percentile.
+ float[]getRequiredScores() + +
+          Returns the scores required to obtain a percentile rating from 0 to 99.
+ booleanisModified() + +
+          Returns true if thsi percentiler has been modified since it was created or since the last + call to clearModified().
+ voidrecomputePercentiles() + +
+          Recomputes the percentile cutoffs based on the values recorded since the last percentile + computation.
+ voidrecordValue(float value) + +
+          Records a value, updating the histogram but not the percentiles (a call to recomputePercentiles() is required for that and is sufficiently expensive that it shouldn't + be done every time a value is added).
+ voidrecordValue(float value, + boolean logNewMax) + +
+          See recordValue(float).
+ byte[]toBytes() + +
+          Converts this percentiler to a byte array so that it may be stored into a database.
+ StringtoString() + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+Percentiler

+
+public Percentiler()
+
+
Creates an empty percentiler. +

+

+
+ +

+Percentiler

+
+public Percentiler(int min,
+                   int max)
+
+
Creates a percentiler that expects values to fall within the given range. +

+

+
+ +

+Percentiler

+
+public Percentiler(byte[] data)
+
+
Creates a percentiler from its serialized representation. +

+

+ + + + + + + + +
+Method Detail
+ +

+recordValue

+
+public void recordValue(float value)
+
+
Records a value, updating the histogram but not the percentiles (a call to recomputePercentiles() is required for that and is sufficiently expensive that it shouldn't + be done every time a value is added). +

+

+
+
+
+
+ +

+recordValue

+
+public void recordValue(float value,
+                        boolean logNewMax)
+
+
See recordValue(float). +

+

+
+
+
+
+ +

+getRecordedCount

+
+public long getRecordedCount()
+
+
Returns the total number of values ever recorded to this percentiler. +

+

+
+
+
+
+ +

+isModified

+
+public boolean isModified()
+
+
Returns true if thsi percentiler has been modified since it was created or since the last + call to clearModified(). +

+

+
+
+
+
+ +

+clearModified

+
+public void clearModified()
+
+
Clears this percentiler's "is modified" state. +

+

+
+
+
+
+ +

+getPercentile

+
+public int getPercentile(float value)
+
+
Returns the percent of all numbers seen that are lower than the specified value. This value + can range from zero to 100 (100 in the case where this is the highest value ever seen by + this percentiler). This value reflects the percentiles computed as of the most recent call + to recomputePercentiles(). +

+

+
+
+
+
+ +

+getRequiredScore

+
+public float getRequiredScore(int percentile)
+
+
Returns the score necessary to attain the specified percentile. This value reflects the + percentiles computed as of the most recent call to recomputePercentiles(). +

+

+
Parameters:
percentile - the desired percentile (from 0 to 99 inclusive).
+
+
+
+ +

+getMaxScore

+
+public int getMaxScore()
+
+
Returns the largest score seen by this percentiler. +

+

+
+
+
+
+ +

+getMinScore

+
+public int getMinScore()
+
+
Returns the smallest score seen by this percentiler. +

+

+
+
+
+
+ +

+getRequiredScores

+
+public float[] getRequiredScores()
+
+
Returns the scores required to obtain a percentile rating from 0 to 99. +

+

+
+
+
+
+ +

+getCounts

+
+public int[] getCounts()
+
+
Returns the counts for each bucket. +

+

+
+
+
+
+ +

+recomputePercentiles

+
+public void recomputePercentiles()
+
+
Recomputes the percentile cutoffs based on the values recorded since the last percentile + computation. +

+

+
+
+
+
+ +

+toBytes

+
+public byte[] toBytes()
+
+
Converts this percentiler to a byte array so that it may be stored into a database. +

+

+
+
+
+
+ +

+toString

+
+public String toString()
+
+
+
Overrides:
toString in class Object
+
+
+
+
+
+
+ +

+dumpGnuPlot

+
+public void dumpGnuPlot(PrintWriter out)
+
+
Dumps out our data in a format that can be used to generate a gnuplot. +

+

+
+
+
+
+ +

+dump

+
+public void dump(PrintWriter out)
+
+
Dumps a text representation of this percentiler to the supplied print stream. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/rating/util/class-use/Percentiler.html b/apidocs/com/threerings/parlor/rating/util/class-use/Percentiler.html new file mode 100644 index 00000000..affbd05b --- /dev/null +++ b/apidocs/com/threerings/parlor/rating/util/class-use/Percentiler.html @@ -0,0 +1,216 @@ + + + + + + + +Uses of Class com.threerings.parlor.rating.util.Percentiler (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.rating.util.Percentiler

+
+ + + + + + + + + +
+Packages that use Percentiler
com.threerings.parlor.rating.server.persist  
+  +

+ + + + + +
+Uses of Percentiler in com.threerings.parlor.rating.server.persist
+  +

+ + + + + + + + + +
Methods in com.threerings.parlor.rating.server.persist that return Percentiler
+ PercentilerRatingRepository.loadPercentile(int gameId, + int gameMode) + +
+          Loads the percentile distribution associated with the specified game and mode.
+  +

+ + + + + + + + + +
Methods in com.threerings.parlor.rating.server.persist that return types with arguments of type Percentiler
+ Map<Integer,Percentiler>RatingRepository.loadPercentiles(int gameId) + +
+          Loads all the percentile distributions associated with the specified game.
+  +

+ + + + + + + + + +
Methods in com.threerings.parlor.rating.server.persist with parameters of type Percentiler
+ voidRatingRepository.updatePercentile(int gameId, + int gameMode, + Percentiler tiler) + +
+          Writes the supplied percentiler's data out to the database.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/rating/util/package-frame.html b/apidocs/com/threerings/parlor/rating/util/package-frame.html new file mode 100644 index 00000000..9a300a63 --- /dev/null +++ b/apidocs/com/threerings/parlor/rating/util/package-frame.html @@ -0,0 +1,33 @@ + + + + + + + +com.threerings.parlor.rating.util (vilya 1.3 API) + + + + + + + + + + + +com.threerings.parlor.rating.util + + + + +
+Classes  + +
+Percentiler
+ + + + diff --git a/apidocs/com/threerings/parlor/rating/util/package-summary.html b/apidocs/com/threerings/parlor/rating/util/package-summary.html new file mode 100644 index 00000000..a56fa575 --- /dev/null +++ b/apidocs/com/threerings/parlor/rating/util/package-summary.html @@ -0,0 +1,158 @@ + + + + + + + +com.threerings.parlor.rating.util (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.parlor.rating.util +

+ + + + + + + + + +
+Class Summary
PercentilerUsed to keep track of the percentile distribution of positive values (generally puzzle scores).
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/rating/util/package-tree.html b/apidocs/com/threerings/parlor/rating/util/package-tree.html new file mode 100644 index 00000000..770edac6 --- /dev/null +++ b/apidocs/com/threerings/parlor/rating/util/package-tree.html @@ -0,0 +1,154 @@ + + + + + + + +com.threerings.parlor.rating.util Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.parlor.rating.util +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/rating/util/package-use.html b/apidocs/com/threerings/parlor/rating/util/package-use.html new file mode 100644 index 00000000..7f53abd5 --- /dev/null +++ b/apidocs/com/threerings/parlor/rating/util/package-use.html @@ -0,0 +1,171 @@ + + + + + + + +Uses of Package com.threerings.parlor.rating.util (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.parlor.rating.util

+
+ + + + + + + + + +
+Packages that use com.threerings.parlor.rating.util
com.threerings.parlor.rating.server.persist  
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.rating.util used by com.threerings.parlor.rating.server.persist
Percentiler + +
+          Used to keep track of the percentile distribution of positive values (generally puzzle scores).
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/server/ParlorManager.html b/apidocs/com/threerings/parlor/server/ParlorManager.html new file mode 100644 index 00000000..3694d70e --- /dev/null +++ b/apidocs/com/threerings/parlor/server/ParlorManager.html @@ -0,0 +1,496 @@ + + + + + + + +ParlorManager (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.server +
+Class ParlorManager

+
+java.lang.Object
+  extended by com.threerings.parlor.server.ParlorManager
+
+
+
All Implemented Interfaces:
ParlorCodes, ParlorProvider, com.threerings.presents.data.InvocationCodes, com.threerings.presents.server.InvocationProvider
+
+
+
+
public class ParlorManager
extends Object
implements ParlorCodes, ParlorProvider
+ + +

+The parlor manager is responsible for the parlor services in aggregate. This includes + maintaining the registry of active games, handling the necessary coordination for the + matchmaking services and anything else that falls outside the scope of an actual in-progress + game. +

+ +

+

+ +

+ + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from interface com.threerings.parlor.data.ParlorCodes
ALREADY_AT_TABLE, BANNED_FROM_TABLE, GAME_ALREADY_STARTED, INVALID_TABLE_POSITION, INVITATION_ACCEPTED, INVITATION_COUNTERED, INVITATION_REFUSED, INVITEE_NOT_ONLINE, MUST_BE_CREATOR, NO_SELF_BOOT, NO_SUCH_TABLE, NOT_AT_TABLE, PARLOR_GROUP, TABLE_POSITION_OCCUPIED
+  + + + + + + + +
Fields inherited from interface com.threerings.presents.data.InvocationCodes
ACCESS_DENIED, E_ACCESS_DENIED, E_INTERNAL_ERROR, GLOBAL_GROUP, INTERNAL_ERROR
+  + + + + + + + + + + +
+Constructor Summary
ParlorManager(com.threerings.presents.server.InvocationManager invmgr) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidcancel(com.threerings.presents.data.ClientObject caller, + int inviteId, + com.threerings.presents.client.InvocationService.InvocationListener listener) + +
+          Handles a ParlorService.cancel(int, com.threerings.presents.client.InvocationService.InvocationListener) request.
+ voidcancelInvite(com.threerings.crowd.data.BodyObject source, + int inviteId) + +
+          Requests that an outstanding invitation be cancelled.
+ intinvite(com.threerings.crowd.data.BodyObject inviter, + com.threerings.crowd.data.BodyObject invitee, + GameConfig config) + +
+          Issues an invitation from the inviter to the invitee for a game as + described by the supplied config object.
+ voidinvite(com.threerings.presents.data.ClientObject caller, + com.threerings.util.Name invitee, + GameConfig config, + ParlorService.InviteListener listener) + +
+          Handles a ParlorService.invite(com.threerings.util.Name, com.threerings.parlor.game.data.GameConfig, com.threerings.parlor.client.ParlorService.InviteListener) request.
+ voidrespond(com.threerings.presents.data.ClientObject caller, + int inviteId, + int code, + Object arg, + com.threerings.presents.client.InvocationService.InvocationListener listener) + +
+          Handles a ParlorService.respond(int, int, java.lang.Object, com.threerings.presents.client.InvocationService.InvocationListener) request.
+ voidrespondToInvite(com.threerings.crowd.data.BodyObject source, + int inviteId, + int code, + Object arg) + +
+          Effects a response to an invitation (accept, refuse or counter), made by the specified + source user with the specified arguments.
+ voidstartSolitaire(com.threerings.presents.data.ClientObject caller, + GameConfig config, + com.threerings.presents.client.InvocationService.ConfirmListener listener) + +
+          Handles a ParlorService.startSolitaire(com.threerings.parlor.game.data.GameConfig, com.threerings.presents.client.InvocationService.ConfirmListener) request.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+ParlorManager

+
+@Inject
+public ParlorManager(com.threerings.presents.server.InvocationManager invmgr)
+
+
+ + + + + + + + +
+Method Detail
+ +

+invite

+
+public void invite(com.threerings.presents.data.ClientObject caller,
+                   com.threerings.util.Name invitee,
+                   GameConfig config,
+                   ParlorService.InviteListener listener)
+            throws com.threerings.presents.server.InvocationException
+
+
Description copied from interface: ParlorProvider
+
Handles a ParlorService.invite(com.threerings.util.Name, com.threerings.parlor.game.data.GameConfig, com.threerings.parlor.client.ParlorService.InviteListener) request. +

+

+
Specified by:
invite in interface ParlorProvider
+
+
+ +
Throws: +
com.threerings.presents.server.InvocationException
+
+
+
+ +

+respond

+
+public void respond(com.threerings.presents.data.ClientObject caller,
+                    int inviteId,
+                    int code,
+                    Object arg,
+                    com.threerings.presents.client.InvocationService.InvocationListener listener)
+
+
Description copied from interface: ParlorProvider
+
Handles a ParlorService.respond(int, int, java.lang.Object, com.threerings.presents.client.InvocationService.InvocationListener) request. +

+

+
Specified by:
respond in interface ParlorProvider
+
+
+
+
+
+
+ +

+cancel

+
+public void cancel(com.threerings.presents.data.ClientObject caller,
+                   int inviteId,
+                   com.threerings.presents.client.InvocationService.InvocationListener listener)
+
+
Description copied from interface: ParlorProvider
+
Handles a ParlorService.cancel(int, com.threerings.presents.client.InvocationService.InvocationListener) request. +

+

+
Specified by:
cancel in interface ParlorProvider
+
+
+
+
+
+
+ +

+startSolitaire

+
+public void startSolitaire(com.threerings.presents.data.ClientObject caller,
+                           GameConfig config,
+                           com.threerings.presents.client.InvocationService.ConfirmListener listener)
+                    throws com.threerings.presents.server.InvocationException
+
+
Description copied from interface: ParlorProvider
+
Handles a ParlorService.startSolitaire(com.threerings.parlor.game.data.GameConfig, com.threerings.presents.client.InvocationService.ConfirmListener) request. +

+

+
Specified by:
startSolitaire in interface ParlorProvider
+
+
+ +
Throws: +
com.threerings.presents.server.InvocationException
+
+
+
+ +

+invite

+
+public int invite(com.threerings.crowd.data.BodyObject inviter,
+                  com.threerings.crowd.data.BodyObject invitee,
+                  GameConfig config)
+           throws com.threerings.presents.server.InvocationException
+
+
Issues an invitation from the inviter to the invitee for a game as + described by the supplied config object. +

+

+
+
+
+
Parameters:
inviter - the player initiating the invitation.
invitee - the player being invited.
config - the configuration of the game being proposed. +
Returns:
the invitation identifier for the newly created invitation record. +
Throws: +
com.threerings.presents.server.InvocationException - thrown if the invitation was not able to be processed for + some reason (like the invited player has requested not to be disturbed). The explanation + will be provided in the message data of the exception.
+
+
+
+ +

+respondToInvite

+
+public void respondToInvite(com.threerings.crowd.data.BodyObject source,
+                            int inviteId,
+                            int code,
+                            Object arg)
+
+
Effects a response to an invitation (accept, refuse or counter), made by the specified + source user with the specified arguments. +

+

+
+
+
+
Parameters:
source - the body object of the user that is issuing this response.
inviteId - the identifier of the invitation to which we are responding.
code - the response code (either ParlorCodes.INVITATION_ACCEPTED, ParlorCodes.INVITATION_REFUSED or ParlorCodes.INVITATION_COUNTERED).
arg - the argument that goes along with the response: an explanatory message in the + case of a refusal (the empty string, not null, if no message was provided) or the new game + configuration in the case of a counter-invitation.
+
+
+
+ +

+cancelInvite

+
+public void cancelInvite(com.threerings.crowd.data.BodyObject source,
+                         int inviteId)
+
+
Requests that an outstanding invitation be cancelled. +

+

+
+
+
+
Parameters:
source - the body object of the user that is making the request.
inviteId - the unique id of the invitation to be cancelled.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/server/ParlorProvider.html b/apidocs/com/threerings/parlor/server/ParlorProvider.html new file mode 100644 index 00000000..0c6e3495 --- /dev/null +++ b/apidocs/com/threerings/parlor/server/ParlorProvider.html @@ -0,0 +1,330 @@ + + + + + + + +ParlorProvider (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.server +
+Interface ParlorProvider

+
+
All Superinterfaces:
com.threerings.presents.server.InvocationProvider
+
+
+
All Known Implementing Classes:
ParlorManager
+
+
+
+
@Generated(value="com.threerings.presents.tools.GenServiceTask",
+           comments="Derived from ParlorService.java.")
+public interface ParlorProvider
extends com.threerings.presents.server.InvocationProvider
+ + +

+Defines the server-side of the ParlorService. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidcancel(com.threerings.presents.data.ClientObject caller, + int arg1, + com.threerings.presents.client.InvocationService.InvocationListener arg2) + +
+          Handles a ParlorService.cancel(int, com.threerings.presents.client.InvocationService.InvocationListener) request.
+ voidinvite(com.threerings.presents.data.ClientObject caller, + com.threerings.util.Name arg1, + GameConfig arg2, + ParlorService.InviteListener arg3) + +
+          Handles a ParlorService.invite(com.threerings.util.Name, com.threerings.parlor.game.data.GameConfig, com.threerings.parlor.client.ParlorService.InviteListener) request.
+ voidrespond(com.threerings.presents.data.ClientObject caller, + int arg1, + int arg2, + Object arg3, + com.threerings.presents.client.InvocationService.InvocationListener arg4) + +
+          Handles a ParlorService.respond(int, int, java.lang.Object, com.threerings.presents.client.InvocationService.InvocationListener) request.
+ voidstartSolitaire(com.threerings.presents.data.ClientObject caller, + GameConfig arg1, + com.threerings.presents.client.InvocationService.ConfirmListener arg2) + +
+          Handles a ParlorService.startSolitaire(com.threerings.parlor.game.data.GameConfig, com.threerings.presents.client.InvocationService.ConfirmListener) request.
+  +

+ + + + + + + + +
+Method Detail
+ +

+cancel

+
+void cancel(com.threerings.presents.data.ClientObject caller,
+            int arg1,
+            com.threerings.presents.client.InvocationService.InvocationListener arg2)
+            throws com.threerings.presents.server.InvocationException
+
+
Handles a ParlorService.cancel(int, com.threerings.presents.client.InvocationService.InvocationListener) request. +

+

+
+
+
+ +
Throws: +
com.threerings.presents.server.InvocationException
+
+
+
+ +

+invite

+
+void invite(com.threerings.presents.data.ClientObject caller,
+            com.threerings.util.Name arg1,
+            GameConfig arg2,
+            ParlorService.InviteListener arg3)
+            throws com.threerings.presents.server.InvocationException
+
+
Handles a ParlorService.invite(com.threerings.util.Name, com.threerings.parlor.game.data.GameConfig, com.threerings.parlor.client.ParlorService.InviteListener) request. +

+

+
+
+
+ +
Throws: +
com.threerings.presents.server.InvocationException
+
+
+
+ +

+respond

+
+void respond(com.threerings.presents.data.ClientObject caller,
+             int arg1,
+             int arg2,
+             Object arg3,
+             com.threerings.presents.client.InvocationService.InvocationListener arg4)
+             throws com.threerings.presents.server.InvocationException
+
+
Handles a ParlorService.respond(int, int, java.lang.Object, com.threerings.presents.client.InvocationService.InvocationListener) request. +

+

+
+
+
+ +
Throws: +
com.threerings.presents.server.InvocationException
+
+
+
+ +

+startSolitaire

+
+void startSolitaire(com.threerings.presents.data.ClientObject caller,
+                    GameConfig arg1,
+                    com.threerings.presents.client.InvocationService.ConfirmListener arg2)
+                    throws com.threerings.presents.server.InvocationException
+
+
Handles a ParlorService.startSolitaire(com.threerings.parlor.game.data.GameConfig, com.threerings.presents.client.InvocationService.ConfirmListener) request. +

+

+
+
+
+ +
Throws: +
com.threerings.presents.server.InvocationException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/server/ParlorSender.html b/apidocs/com/threerings/parlor/server/ParlorSender.html new file mode 100644 index 00000000..a2ed516e --- /dev/null +++ b/apidocs/com/threerings/parlor/server/ParlorSender.html @@ -0,0 +1,349 @@ + + + + + + + +ParlorSender (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.server +
+Class ParlorSender

+
+java.lang.Object
+  extended by com.threerings.presents.server.InvocationSender
+      extended by com.threerings.parlor.server.ParlorSender
+
+
+
+
public class ParlorSender
extends com.threerings.presents.server.InvocationSender
+ + +

+Used to issue notifications to a ParlorReceiver instance on a + client. +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
ParlorSender() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+static voidgameIsReady(com.threerings.presents.data.ClientObject target, + int arg1) + +
+          Issues a notification that will result in a call to ParlorReceiver.gameIsReady(int) on a client.
+static voidsendInvite(com.threerings.presents.data.ClientObject target, + int arg1, + com.threerings.util.Name arg2, + GameConfig arg3) + +
+          Issues a notification that will result in a call to ParlorReceiver.receivedInvite(int, com.threerings.util.Name, com.threerings.parlor.game.data.GameConfig) on a client.
+static voidsendInviteCancellation(com.threerings.presents.data.ClientObject target, + int arg1) + +
+          Issues a notification that will result in a call to ParlorReceiver.receivedInviteCancellation(int) on a client.
+static voidsendInviteResponse(com.threerings.presents.data.ClientObject target, + int arg1, + int arg2, + Object arg3) + +
+          Issues a notification that will result in a call to ParlorReceiver.receivedInviteResponse(int, int, java.lang.Object) on a client.
+  + + + + + + + +
Methods inherited from class com.threerings.presents.server.InvocationSender
sendNotification, sendNotification
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+ParlorSender

+
+public ParlorSender()
+
+
+ + + + + + + + +
+Method Detail
+ +

+gameIsReady

+
+public static void gameIsReady(com.threerings.presents.data.ClientObject target,
+                               int arg1)
+
+
Issues a notification that will result in a call to ParlorReceiver.gameIsReady(int) on a client. +

+

+
+
+
+
+ +

+sendInvite

+
+public static void sendInvite(com.threerings.presents.data.ClientObject target,
+                              int arg1,
+                              com.threerings.util.Name arg2,
+                              GameConfig arg3)
+
+
Issues a notification that will result in a call to ParlorReceiver.receivedInvite(int, com.threerings.util.Name, com.threerings.parlor.game.data.GameConfig) on a client. +

+

+
+
+
+
+ +

+sendInviteCancellation

+
+public static void sendInviteCancellation(com.threerings.presents.data.ClientObject target,
+                                          int arg1)
+
+
Issues a notification that will result in a call to ParlorReceiver.receivedInviteCancellation(int) on a client. +

+

+
+
+
+
+ +

+sendInviteResponse

+
+public static void sendInviteResponse(com.threerings.presents.data.ClientObject target,
+                                      int arg1,
+                                      int arg2,
+                                      Object arg3)
+
+
Issues a notification that will result in a call to ParlorReceiver.receivedInviteResponse(int, int, java.lang.Object) on a client. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/server/PlayManager.html b/apidocs/com/threerings/parlor/server/PlayManager.html new file mode 100644 index 00000000..422d587f --- /dev/null +++ b/apidocs/com/threerings/parlor/server/PlayManager.html @@ -0,0 +1,265 @@ + + + + + + + +PlayManager (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.server +
+Interface PlayManager

+
+
All Known Implementing Classes:
CardGameManager, GameManager, PuzzleManager
+
+
+
+
public interface PlayManager
+ + +

+An interface to be implemented by a PlaceManager that wishes to host + places that have players. This generalizes the idea of a game further than what + is afforded by GameManager, linking it up with AVRGameManager. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ com.threerings.crowd.data.BodyObjectcheckWritePermission(com.threerings.presents.data.ClientObject client, + int playerId) + +
+          Make sure that the given caller is a player or an agent and can write to the data + of the given playerId.
+ booleanisAgent(com.threerings.presents.data.ClientObject client) + +
+          Return true if the given client is a server-side agent in this place.
+ booleanisPlayer(com.threerings.presents.data.ClientObject client) + +
+          Return true if the given client is a player in this place.
+  +

+ + + + + + + + +
+Method Detail
+ +

+isPlayer

+
+boolean isPlayer(com.threerings.presents.data.ClientObject client)
+
+
Return true if the given client is a player in this place. +

+

+
+
+
+
+ +

+isAgent

+
+boolean isAgent(com.threerings.presents.data.ClientObject client)
+
+
Return true if the given client is a server-side agent in this place. +

+

+
+
+
+
+ +

+checkWritePermission

+
+com.threerings.crowd.data.BodyObject checkWritePermission(com.threerings.presents.data.ClientObject client,
+                                                          int playerId)
+
+
Make sure that the given caller is a player or an agent and can write to the data + of the given playerId. +

+

+ +
Returns:
the resolved player object to write to
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/server/PlayManagerDelegate.html b/apidocs/com/threerings/parlor/server/PlayManagerDelegate.html new file mode 100644 index 00000000..79920d3b --- /dev/null +++ b/apidocs/com/threerings/parlor/server/PlayManagerDelegate.html @@ -0,0 +1,275 @@ + + + + + + + +PlayManagerDelegate (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.server +
+Class PlayManagerDelegate

+
+java.lang.Object
+  extended by com.threerings.crowd.server.PlaceManagerDelegate
+      extended by com.threerings.parlor.server.PlayManagerDelegate
+
+
+
Direct Known Subclasses:
GameManagerDelegate
+
+
+
+
public class PlayManagerDelegate
extends com.threerings.crowd.server.PlaceManagerDelegate
+ + +

+The base class for any delegate that wishes to service both GameManager + games and AVRGameManager games -- or, in fact, any PlaceManager + that implements PlayManager. +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
PlayManagerDelegate() + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ voiddidInit(com.threerings.crowd.data.PlaceConfig config) + +
+           
+  + + + + + + + +
Methods inherited from class com.threerings.crowd.server.PlaceManagerDelegate
bodyEntered, bodyLeft, bodyUpdated, didShutdown, didStartup, init, placeBecameEmpty, where
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+PlayManagerDelegate

+
+public PlayManagerDelegate()
+
+
+ + + + + + + + +
+Method Detail
+ +

+didInit

+
+public void didInit(com.threerings.crowd.data.PlaceConfig config)
+
+
+
Overrides:
didInit in class com.threerings.crowd.server.PlaceManagerDelegate
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/server/TableManager.html b/apidocs/com/threerings/parlor/server/TableManager.html new file mode 100644 index 00000000..e569cc67 --- /dev/null +++ b/apidocs/com/threerings/parlor/server/TableManager.html @@ -0,0 +1,596 @@ + + + + + + + +TableManager (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.server +
+Class TableManager

+
+java.lang.Object
+  extended by com.threerings.parlor.server.TableManager
+
+
+
All Implemented Interfaces:
ParlorCodes, TableProvider, com.threerings.presents.data.InvocationCodes, com.threerings.presents.server.InvocationProvider
+
+
+
+
public class TableManager
extends Object
implements ParlorCodes, TableProvider
+ + +

+A table manager can be used by a place manager (or other entity) to take care of the management + of a table matchmaking service on a particular distributed object. +

+ +

+

+ +

+ + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from interface com.threerings.parlor.data.ParlorCodes
ALREADY_AT_TABLE, BANNED_FROM_TABLE, GAME_ALREADY_STARTED, INVALID_TABLE_POSITION, INVITATION_ACCEPTED, INVITATION_COUNTERED, INVITATION_REFUSED, INVITEE_NOT_ONLINE, MUST_BE_CREATOR, NO_SELF_BOOT, NO_SUCH_TABLE, NOT_AT_TABLE, PARLOR_GROUP, TABLE_POSITION_OCCUPIED
+  + + + + + + + +
Fields inherited from interface com.threerings.presents.data.InvocationCodes
ACCESS_DENIED, E_ACCESS_DENIED, E_INTERNAL_ERROR, GLOBAL_GROUP, INTERNAL_ERROR
+  + + + + + + + + + + +
+Constructor Summary
TableManager(com.threerings.presents.dobj.RootDObjectManager omgr, + com.threerings.presents.server.InvocationManager invmgr, + com.threerings.crowd.server.PlaceRegistry plreg, + com.threerings.presents.dobj.DObject tableObject) + +
+          Creates a table manager that will manage tables in the supplied distributed object (which + must implement TableLobbyObject.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidbootPlayer(com.threerings.presents.data.ClientObject caller, + int tableId, + com.threerings.util.Name target, + com.threerings.presents.client.InvocationService.InvocationListener listener) + +
+          Handles a TableService.bootPlayer(int, com.threerings.util.Name, com.threerings.presents.client.InvocationService.InvocationListener) request.
+ TablecreateTable(com.threerings.crowd.data.BodyObject creator, + TableConfig tableConfig, + GameConfig config) + +
+          Creates a table for the specified creator and returns said table.
+ voidcreateTable(com.threerings.presents.data.ClientObject caller, + TableConfig tableConfig, + GameConfig config, + com.threerings.presents.client.InvocationService.ResultListener listener) + +
+          Handles a TableService.createTable(com.threerings.parlor.data.TableConfig, com.threerings.parlor.game.data.GameConfig, com.threerings.presents.client.InvocationService.ResultListener) request.
+ intgetTableCount() + +
+          Returns the number of tables being managed currently.
+ voidjoinTable(com.threerings.presents.data.ClientObject caller, + int tableId, + int position, + com.threerings.presents.client.InvocationService.InvocationListener listener) + +
+          Handles a TableService.joinTable(int, int, com.threerings.presents.client.InvocationService.InvocationListener) request.
+ voidleaveTable(com.threerings.presents.data.ClientObject caller, + int tableId, + com.threerings.presents.client.InvocationService.InvocationListener listener) + +
+          Handles a TableService.leaveTable(int, com.threerings.presents.client.InvocationService.InvocationListener) request.
+ voidsetAllowBooting(boolean allowBooting) + +
+          Allow a player in the first position of a table to boot others.
+ voidsetTableClass(Class<? extends Table> tableClass) + +
+          Set the subclass of Table that this instance should generate.
+ voidsetTableObject(com.threerings.presents.dobj.DObject tableObject) + +
+          Initialize the TableLobbyObject.
+ voidshutdown() + +
+          This must be called when the table manager is no longer needed.
+ voidstartTableNow(com.threerings.presents.data.ClientObject caller, + int tableId, + com.threerings.presents.client.InvocationService.InvocationListener listener) + +
+          Handles a TableService.startTableNow(int, com.threerings.presents.client.InvocationService.InvocationListener) request.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+TableManager

+
+public TableManager(com.threerings.presents.dobj.RootDObjectManager omgr,
+                    com.threerings.presents.server.InvocationManager invmgr,
+                    com.threerings.crowd.server.PlaceRegistry plreg,
+                    com.threerings.presents.dobj.DObject tableObject)
+
+
Creates a table manager that will manage tables in the supplied distributed object (which + must implement TableLobbyObject. +

+

+ + + + + + + + +
+Method Detail
+ +

+setTableObject

+
+public void setTableObject(com.threerings.presents.dobj.DObject tableObject)
+
+
Initialize the TableLobbyObject. Do not call this more than once. +

+

+
+
+
+
+
+
+
+ +

+getTableCount

+
+public int getTableCount()
+
+
Returns the number of tables being managed currently. +

+

+
+
+
+
+
+
+
+ +

+shutdown

+
+public void shutdown()
+
+
This must be called when the table manager is no longer needed. +

+

+
+
+
+
+
+
+
+ +

+setTableClass

+
+public void setTableClass(Class<? extends Table> tableClass)
+
+
Set the subclass of Table that this instance should generate. +

+

+
+
+
+
+
+
+
+ +

+setAllowBooting

+
+public void setAllowBooting(boolean allowBooting)
+
+
Allow a player in the first position of a table to boot others. +

+

+
+
+
+
+
+
+
+ +

+createTable

+
+public Table createTable(com.threerings.crowd.data.BodyObject creator,
+                         TableConfig tableConfig,
+                         GameConfig config)
+                  throws com.threerings.presents.server.InvocationException
+
+
Creates a table for the specified creator and returns said table. +

+

+
+
+
+ +
Throws: +
com.threerings.presents.server.InvocationException - thrown if the table could not be created for any reason.
+
+
+
+ +

+createTable

+
+public void createTable(com.threerings.presents.data.ClientObject caller,
+                        TableConfig tableConfig,
+                        GameConfig config,
+                        com.threerings.presents.client.InvocationService.ResultListener listener)
+                 throws com.threerings.presents.server.InvocationException
+
+
Description copied from interface: TableProvider
+
Handles a TableService.createTable(com.threerings.parlor.data.TableConfig, com.threerings.parlor.game.data.GameConfig, com.threerings.presents.client.InvocationService.ResultListener) request. +

+

+
Specified by:
createTable in interface TableProvider
+
+
+ +
Throws: +
com.threerings.presents.server.InvocationException
+
+
+
+ +

+joinTable

+
+public void joinTable(com.threerings.presents.data.ClientObject caller,
+                      int tableId,
+                      int position,
+                      com.threerings.presents.client.InvocationService.InvocationListener listener)
+               throws com.threerings.presents.server.InvocationException
+
+
Description copied from interface: TableProvider
+
Handles a TableService.joinTable(int, int, com.threerings.presents.client.InvocationService.InvocationListener) request. +

+

+
Specified by:
joinTable in interface TableProvider
+
+
+ +
Throws: +
com.threerings.presents.server.InvocationException
+
+
+
+ +

+leaveTable

+
+public void leaveTable(com.threerings.presents.data.ClientObject caller,
+                       int tableId,
+                       com.threerings.presents.client.InvocationService.InvocationListener listener)
+                throws com.threerings.presents.server.InvocationException
+
+
Description copied from interface: TableProvider
+
Handles a TableService.leaveTable(int, com.threerings.presents.client.InvocationService.InvocationListener) request. +

+

+
Specified by:
leaveTable in interface TableProvider
+
+
+ +
Throws: +
com.threerings.presents.server.InvocationException
+
+
+
+ +

+startTableNow

+
+public void startTableNow(com.threerings.presents.data.ClientObject caller,
+                          int tableId,
+                          com.threerings.presents.client.InvocationService.InvocationListener listener)
+                   throws com.threerings.presents.server.InvocationException
+
+
Description copied from interface: TableProvider
+
Handles a TableService.startTableNow(int, com.threerings.presents.client.InvocationService.InvocationListener) request. +

+

+
Specified by:
startTableNow in interface TableProvider
+
+
+ +
Throws: +
com.threerings.presents.server.InvocationException
+
+
+
+ +

+bootPlayer

+
+public void bootPlayer(com.threerings.presents.data.ClientObject caller,
+                       int tableId,
+                       com.threerings.util.Name target,
+                       com.threerings.presents.client.InvocationService.InvocationListener listener)
+                throws com.threerings.presents.server.InvocationException
+
+
Description copied from interface: TableProvider
+
Handles a TableService.bootPlayer(int, com.threerings.util.Name, com.threerings.presents.client.InvocationService.InvocationListener) request. +

+

+
Specified by:
bootPlayer in interface TableProvider
+
+
+ +
Throws: +
com.threerings.presents.server.InvocationException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/server/TableProvider.html b/apidocs/com/threerings/parlor/server/TableProvider.html new file mode 100644 index 00000000..5dfab47b --- /dev/null +++ b/apidocs/com/threerings/parlor/server/TableProvider.html @@ -0,0 +1,361 @@ + + + + + + + +TableProvider (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.server +
+Interface TableProvider

+
+
All Superinterfaces:
com.threerings.presents.server.InvocationProvider
+
+
+
All Known Implementing Classes:
TableManager
+
+
+
+
@Generated(value="com.threerings.presents.tools.GenServiceTask",
+           comments="Derived from TableService.java.")
+public interface TableProvider
extends com.threerings.presents.server.InvocationProvider
+ + +

+Defines the server-side of the TableService. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidbootPlayer(com.threerings.presents.data.ClientObject caller, + int arg1, + com.threerings.util.Name arg2, + com.threerings.presents.client.InvocationService.InvocationListener arg3) + +
+          Handles a TableService.bootPlayer(int, com.threerings.util.Name, com.threerings.presents.client.InvocationService.InvocationListener) request.
+ voidcreateTable(com.threerings.presents.data.ClientObject caller, + TableConfig arg1, + GameConfig arg2, + com.threerings.presents.client.InvocationService.ResultListener arg3) + +
+          Handles a TableService.createTable(com.threerings.parlor.data.TableConfig, com.threerings.parlor.game.data.GameConfig, com.threerings.presents.client.InvocationService.ResultListener) request.
+ voidjoinTable(com.threerings.presents.data.ClientObject caller, + int arg1, + int arg2, + com.threerings.presents.client.InvocationService.InvocationListener arg3) + +
+          Handles a TableService.joinTable(int, int, com.threerings.presents.client.InvocationService.InvocationListener) request.
+ voidleaveTable(com.threerings.presents.data.ClientObject caller, + int arg1, + com.threerings.presents.client.InvocationService.InvocationListener arg2) + +
+          Handles a TableService.leaveTable(int, com.threerings.presents.client.InvocationService.InvocationListener) request.
+ voidstartTableNow(com.threerings.presents.data.ClientObject caller, + int arg1, + com.threerings.presents.client.InvocationService.InvocationListener arg2) + +
+          Handles a TableService.startTableNow(int, com.threerings.presents.client.InvocationService.InvocationListener) request.
+  +

+ + + + + + + + +
+Method Detail
+ +

+bootPlayer

+
+void bootPlayer(com.threerings.presents.data.ClientObject caller,
+                int arg1,
+                com.threerings.util.Name arg2,
+                com.threerings.presents.client.InvocationService.InvocationListener arg3)
+                throws com.threerings.presents.server.InvocationException
+
+
Handles a TableService.bootPlayer(int, com.threerings.util.Name, com.threerings.presents.client.InvocationService.InvocationListener) request. +

+

+
+
+
+ +
Throws: +
com.threerings.presents.server.InvocationException
+
+
+
+ +

+createTable

+
+void createTable(com.threerings.presents.data.ClientObject caller,
+                 TableConfig arg1,
+                 GameConfig arg2,
+                 com.threerings.presents.client.InvocationService.ResultListener arg3)
+                 throws com.threerings.presents.server.InvocationException
+
+
Handles a TableService.createTable(com.threerings.parlor.data.TableConfig, com.threerings.parlor.game.data.GameConfig, com.threerings.presents.client.InvocationService.ResultListener) request. +

+

+
+
+
+ +
Throws: +
com.threerings.presents.server.InvocationException
+
+
+
+ +

+joinTable

+
+void joinTable(com.threerings.presents.data.ClientObject caller,
+               int arg1,
+               int arg2,
+               com.threerings.presents.client.InvocationService.InvocationListener arg3)
+               throws com.threerings.presents.server.InvocationException
+
+
Handles a TableService.joinTable(int, int, com.threerings.presents.client.InvocationService.InvocationListener) request. +

+

+
+
+
+ +
Throws: +
com.threerings.presents.server.InvocationException
+
+
+
+ +

+leaveTable

+
+void leaveTable(com.threerings.presents.data.ClientObject caller,
+                int arg1,
+                com.threerings.presents.client.InvocationService.InvocationListener arg2)
+                throws com.threerings.presents.server.InvocationException
+
+
Handles a TableService.leaveTable(int, com.threerings.presents.client.InvocationService.InvocationListener) request. +

+

+
+
+
+ +
Throws: +
com.threerings.presents.server.InvocationException
+
+
+
+ +

+startTableNow

+
+void startTableNow(com.threerings.presents.data.ClientObject caller,
+                   int arg1,
+                   com.threerings.presents.client.InvocationService.InvocationListener arg2)
+                   throws com.threerings.presents.server.InvocationException
+
+
Handles a TableService.startTableNow(int, com.threerings.presents.client.InvocationService.InvocationListener) request. +

+

+
+
+
+ +
Throws: +
com.threerings.presents.server.InvocationException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/server/class-use/ParlorManager.html b/apidocs/com/threerings/parlor/server/class-use/ParlorManager.html new file mode 100644 index 00000000..e9524112 --- /dev/null +++ b/apidocs/com/threerings/parlor/server/class-use/ParlorManager.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.parlor.server.ParlorManager (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.server.ParlorManager

+
+No usage of com.threerings.parlor.server.ParlorManager +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/server/class-use/ParlorProvider.html b/apidocs/com/threerings/parlor/server/class-use/ParlorProvider.html new file mode 100644 index 00000000..3481f507 --- /dev/null +++ b/apidocs/com/threerings/parlor/server/class-use/ParlorProvider.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Interface com.threerings.parlor.server.ParlorProvider (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.parlor.server.ParlorProvider

+
+ + + + + + + + + +
+Packages that use ParlorProvider
com.threerings.parlor.server  
+  +

+ + + + + +
+Uses of ParlorProvider in com.threerings.parlor.server
+  +

+ + + + + + + + + +
Classes in com.threerings.parlor.server that implement ParlorProvider
+ classParlorManager + +
+          The parlor manager is responsible for the parlor services in aggregate.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/server/class-use/ParlorSender.html b/apidocs/com/threerings/parlor/server/class-use/ParlorSender.html new file mode 100644 index 00000000..00449db0 --- /dev/null +++ b/apidocs/com/threerings/parlor/server/class-use/ParlorSender.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.parlor.server.ParlorSender (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.server.ParlorSender

+
+No usage of com.threerings.parlor.server.ParlorSender +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/server/class-use/PlayManager.html b/apidocs/com/threerings/parlor/server/class-use/PlayManager.html new file mode 100644 index 00000000..f95dfcda --- /dev/null +++ b/apidocs/com/threerings/parlor/server/class-use/PlayManager.html @@ -0,0 +1,239 @@ + + + + + + + +Uses of Interface com.threerings.parlor.server.PlayManager (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.parlor.server.PlayManager

+
+ + + + + + + + + + + + + + + + + +
+Packages that use PlayManager
com.threerings.parlor.card.server  
com.threerings.parlor.game.server  
com.threerings.puzzle.server  
+  +

+ + + + + +
+Uses of PlayManager in com.threerings.parlor.card.server
+  +

+ + + + + + + + + +
Classes in com.threerings.parlor.card.server that implement PlayManager
+ classCardGameManager + +
+          A manager class for card games.
+  +

+ + + + + +
+Uses of PlayManager in com.threerings.parlor.game.server
+  +

+ + + + + + + + + +
Classes in com.threerings.parlor.game.server that implement PlayManager
+ classGameManager + +
+          The game manager handles the server side management of a game.
+  +

+ + + + + +
+Uses of PlayManager in com.threerings.puzzle.server
+  +

+ + + + + + + + + +
Classes in com.threerings.puzzle.server that implement PlayManager
+ classPuzzleManager + +
+          Extends the GameManager with facilities for puzzle games.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/server/class-use/PlayManagerDelegate.html b/apidocs/com/threerings/parlor/server/class-use/PlayManagerDelegate.html new file mode 100644 index 00000000..2b2f4fea --- /dev/null +++ b/apidocs/com/threerings/parlor/server/class-use/PlayManagerDelegate.html @@ -0,0 +1,330 @@ + + + + + + + +Uses of Class com.threerings.parlor.server.PlayManagerDelegate (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.server.PlayManagerDelegate

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Packages that use PlayManagerDelegate
com.threerings.parlor.card.trick.server  
com.threerings.parlor.game.server  
com.threerings.parlor.rating.server  
com.threerings.parlor.turn.server  
com.threerings.puzzle.drop.server  
com.threerings.puzzle.server  
+  +

+ + + + + +
+Uses of PlayManagerDelegate in com.threerings.parlor.card.trick.server
+  +

+ + + + + + + + + +
Subclasses of PlayManagerDelegate in com.threerings.parlor.card.trick.server
+ classTrickCardGameManagerDelegate + +
+          A card game manager delegate for trick-based card games, such as Spades and Hearts.
+  +

+ + + + + +
+Uses of PlayManagerDelegate in com.threerings.parlor.game.server
+  +

+ + + + + + + + + +
Subclasses of PlayManagerDelegate in com.threerings.parlor.game.server
+ classGameManagerDelegate + +
+          Extends the PlayManagerDelegate mechanism with game manager specific methods.
+  +

+ + + + + +
+Uses of PlayManagerDelegate in com.threerings.parlor.rating.server
+  +

+ + + + + + + + + +
Subclasses of PlayManagerDelegate in com.threerings.parlor.rating.server
+ classRatingDelegate + +
+          Rates players after each game and handles persisting the results.
+  +

+ + + + + +
+Uses of PlayManagerDelegate in com.threerings.parlor.turn.server
+  +

+ + + + + + + + + +
Subclasses of PlayManagerDelegate in com.threerings.parlor.turn.server
+ classTurnGameManagerDelegate + +
+          Performs the server-side turn-based game processing for a turn based game.
+  +

+ + + + + +
+Uses of PlayManagerDelegate in com.threerings.puzzle.drop.server
+  +

+ + + + + + + + + +
Subclasses of PlayManagerDelegate in com.threerings.puzzle.drop.server
+ classDropManagerDelegate + +
+          Provides the necessary support for a puzzle game that involves a two-dimensional board + containing pieces, with new pieces either falling into the board as a "drop block", or rising + into the bottom of the board in new piece rows, groups of blocks can be "broken" and garbage + can be sent to other players' boards as a result.
+  +

+ + + + + +
+Uses of PlayManagerDelegate in com.threerings.puzzle.server
+  +

+ + + + + + + + + +
Subclasses of PlayManagerDelegate in com.threerings.puzzle.server
+ classPuzzleManagerDelegate + +
+          Extends the GameManagerDelegate mechanism with puzzle manager specific methods (of + which there are currently none).
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/server/class-use/TableManager.html b/apidocs/com/threerings/parlor/server/class-use/TableManager.html new file mode 100644 index 00000000..76a7e031 --- /dev/null +++ b/apidocs/com/threerings/parlor/server/class-use/TableManager.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.parlor.server.TableManager (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.server.TableManager

+
+No usage of com.threerings.parlor.server.TableManager +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/server/class-use/TableProvider.html b/apidocs/com/threerings/parlor/server/class-use/TableProvider.html new file mode 100644 index 00000000..01e988c7 --- /dev/null +++ b/apidocs/com/threerings/parlor/server/class-use/TableProvider.html @@ -0,0 +1,182 @@ + + + + + + + +Uses of Interface com.threerings.parlor.server.TableProvider (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.parlor.server.TableProvider

+
+ + + + + + + + + +
+Packages that use TableProvider
com.threerings.parlor.server  
+  +

+ + + + + +
+Uses of TableProvider in com.threerings.parlor.server
+  +

+ + + + + + + + + +
Classes in com.threerings.parlor.server that implement TableProvider
+ classTableManager + +
+          A table manager can be used by a place manager (or other entity) to take care of the management + of a table matchmaking service on a particular distributed object.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/server/package-frame.html b/apidocs/com/threerings/parlor/server/package-frame.html new file mode 100644 index 00000000..3ed60cc4 --- /dev/null +++ b/apidocs/com/threerings/parlor/server/package-frame.html @@ -0,0 +1,54 @@ + + + + + + + +com.threerings.parlor.server (vilya 1.3 API) + + + + + + + + + + + +com.threerings.parlor.server + + + + +
+Interfaces  + +
+ParlorProvider +
+PlayManager +
+TableProvider
+ + + + + + +
+Classes  + +
+ParlorManager +
+ParlorSender +
+PlayManagerDelegate +
+TableManager
+ + + + diff --git a/apidocs/com/threerings/parlor/server/package-summary.html b/apidocs/com/threerings/parlor/server/package-summary.html new file mode 100644 index 00000000..48e7fd2f --- /dev/null +++ b/apidocs/com/threerings/parlor/server/package-summary.html @@ -0,0 +1,197 @@ + + + + + + + +com.threerings.parlor.server (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.parlor.server +

+ + + + + + + + + + + + + + + + + +
+Interface Summary
ParlorProviderDefines the server-side of the ParlorService.
PlayManagerAn interface to be implemented by a PlaceManager that wishes to host + places that have players.
TableProviderDefines the server-side of the TableService.
+  + +

+ + + + + + + + + + + + + + + + + + + + + +
+Class Summary
ParlorManagerThe parlor manager is responsible for the parlor services in aggregate.
ParlorSenderUsed to issue notifications to a ParlorReceiver instance on a + client.
PlayManagerDelegateThe base class for any delegate that wishes to service both GameManager + games and AVRGameManager games -- or, in fact, any PlaceManager + that implements PlayManager.
TableManagerA table manager can be used by a place manager (or other entity) to take care of the management + of a table matchmaking service on a particular distributed object.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/server/package-tree.html b/apidocs/com/threerings/parlor/server/package-tree.html new file mode 100644 index 00000000..c87e7679 --- /dev/null +++ b/apidocs/com/threerings/parlor/server/package-tree.html @@ -0,0 +1,167 @@ + + + + + + + +com.threerings.parlor.server Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.parlor.server +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/server/package-use.html b/apidocs/com/threerings/parlor/server/package-use.html new file mode 100644 index 00000000..0984cc62 --- /dev/null +++ b/apidocs/com/threerings/parlor/server/package-use.html @@ -0,0 +1,337 @@ + + + + + + + +Uses of Package com.threerings.parlor.server (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.parlor.server

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Packages that use com.threerings.parlor.server
com.threerings.parlor.card.server  
com.threerings.parlor.card.trick.server  
com.threerings.parlor.game.server  
com.threerings.parlor.rating.server  
com.threerings.parlor.server  
com.threerings.parlor.turn.server  
com.threerings.puzzle.drop.server  
com.threerings.puzzle.server  
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.server used by com.threerings.parlor.card.server
PlayManager + +
+          An interface to be implemented by a PlaceManager that wishes to host + places that have players.
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.server used by com.threerings.parlor.card.trick.server
PlayManagerDelegate + +
+          The base class for any delegate that wishes to service both GameManager + games and AVRGameManager games -- or, in fact, any PlaceManager + that implements PlayManager.
+  +

+ + + + + + + + + + + +
+Classes in com.threerings.parlor.server used by com.threerings.parlor.game.server
PlayManager + +
+          An interface to be implemented by a PlaceManager that wishes to host + places that have players.
PlayManagerDelegate + +
+          The base class for any delegate that wishes to service both GameManager + games and AVRGameManager games -- or, in fact, any PlaceManager + that implements PlayManager.
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.server used by com.threerings.parlor.rating.server
PlayManagerDelegate + +
+          The base class for any delegate that wishes to service both GameManager + games and AVRGameManager games -- or, in fact, any PlaceManager + that implements PlayManager.
+  +

+ + + + + + + + + + + +
+Classes in com.threerings.parlor.server used by com.threerings.parlor.server
ParlorProvider + +
+          Defines the server-side of the ParlorService.
TableProvider + +
+          Defines the server-side of the TableService.
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.server used by com.threerings.parlor.turn.server
PlayManagerDelegate + +
+          The base class for any delegate that wishes to service both GameManager + games and AVRGameManager games -- or, in fact, any PlaceManager + that implements PlayManager.
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.server used by com.threerings.puzzle.drop.server
PlayManagerDelegate + +
+          The base class for any delegate that wishes to service both GameManager + games and AVRGameManager games -- or, in fact, any PlaceManager + that implements PlayManager.
+  +

+ + + + + + + + + + + +
+Classes in com.threerings.parlor.server used by com.threerings.puzzle.server
PlayManager + +
+          An interface to be implemented by a PlaceManager that wishes to host + places that have players.
PlayManagerDelegate + +
+          The base class for any delegate that wishes to service both GameManager + games and AVRGameManager games -- or, in fact, any PlaceManager + that implements PlayManager.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/tourney/client/TourneyService.html b/apidocs/com/threerings/parlor/tourney/client/TourneyService.html new file mode 100644 index 00000000..0578b45b --- /dev/null +++ b/apidocs/com/threerings/parlor/tourney/client/TourneyService.html @@ -0,0 +1,290 @@ + + + + + + + +TourneyService (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.tourney.client +
+Interface TourneyService

+
+
All Superinterfaces:
com.threerings.presents.client.InvocationService
+
+
+
All Known Implementing Classes:
TourneyMarshaller
+
+
+
+
public interface TourneyService
extends com.threerings.presents.client.InvocationService
+ + +

+Provides tourney management services for the particular tourney this + service is attached to. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.presents.client.InvocationService
com.threerings.presents.client.InvocationService.ConfirmListener, com.threerings.presents.client.InvocationService.InvocationListener, com.threerings.presents.client.InvocationService.ResultListener
+  + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidcancel(com.threerings.presents.client.InvocationService.ConfirmListener listener) + +
+          Handles a request to cancel the tourney.
+ voidjoin(com.threerings.presents.client.InvocationService.ConfirmListener listener) + +
+          Handles a request to join the tourney.
+ voidleave(com.threerings.presents.client.InvocationService.ConfirmListener listener) + +
+          Handles a request to leave the tourney.
+  +

+ + + + + + + + +
+Method Detail
+ +

+join

+
+void join(com.threerings.presents.client.InvocationService.ConfirmListener listener)
+
+
Handles a request to join the tourney. +

+

+
+
+
+
+
+
+
+ +

+leave

+
+void leave(com.threerings.presents.client.InvocationService.ConfirmListener listener)
+
+
Handles a request to leave the tourney. +

+

+
+
+
+
+
+
+
+ +

+cancel

+
+void cancel(com.threerings.presents.client.InvocationService.ConfirmListener listener)
+
+
Handles a request to cancel the tourney. +

+

+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/tourney/client/TourniesService.html b/apidocs/com/threerings/parlor/tourney/client/TourniesService.html new file mode 100644 index 00000000..4ef9e52e --- /dev/null +++ b/apidocs/com/threerings/parlor/tourney/client/TourniesService.html @@ -0,0 +1,243 @@ + + + + + + + +TourniesService (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.tourney.client +
+Interface TourniesService

+
+
All Superinterfaces:
com.threerings.presents.client.InvocationService
+
+
+
All Known Implementing Classes:
TourniesMarshaller
+
+
+
+
public interface TourniesService
extends com.threerings.presents.client.InvocationService
+ + +

+Provices services for creating/modifying tournies. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.presents.client.InvocationService
com.threerings.presents.client.InvocationService.ConfirmListener, com.threerings.presents.client.InvocationService.InvocationListener, com.threerings.presents.client.InvocationService.ResultListener
+  + + + + + + + + + + + + +
+Method Summary
+ voidcreateTourney(TourneyConfig config, + com.threerings.presents.client.InvocationService.ResultListener listener) + +
+          Creates a new tourney.
+  +

+ + + + + + + + +
+Method Detail
+ +

+createTourney

+
+void createTourney(TourneyConfig config,
+                   com.threerings.presents.client.InvocationService.ResultListener listener)
+
+
Creates a new tourney. +

+

+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/tourney/client/class-use/TourneyService.html b/apidocs/com/threerings/parlor/tourney/client/class-use/TourneyService.html new file mode 100644 index 00000000..86c1c063 --- /dev/null +++ b/apidocs/com/threerings/parlor/tourney/client/class-use/TourneyService.html @@ -0,0 +1,183 @@ + + + + + + + +Uses of Interface com.threerings.parlor.tourney.client.TourneyService (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.parlor.tourney.client.TourneyService

+
+ + + + + + + + + +
+Packages that use TourneyService
com.threerings.parlor.tourney.data  
+  +

+ + + + + +
+Uses of TourneyService in com.threerings.parlor.tourney.data
+  +

+ + + + + + + + + +
Classes in com.threerings.parlor.tourney.data that implement TourneyService
+ classTourneyMarshaller + +
+          Provides the implementation of the TourneyService interface + that marshalls the arguments and delivers the request to the provider + on the server.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/tourney/client/class-use/TourniesService.html b/apidocs/com/threerings/parlor/tourney/client/class-use/TourniesService.html new file mode 100644 index 00000000..f8371a5a --- /dev/null +++ b/apidocs/com/threerings/parlor/tourney/client/class-use/TourniesService.html @@ -0,0 +1,183 @@ + + + + + + + +Uses of Interface com.threerings.parlor.tourney.client.TourniesService (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.parlor.tourney.client.TourniesService

+
+ + + + + + + + + +
+Packages that use TourniesService
com.threerings.parlor.tourney.data  
+  +

+ + + + + +
+Uses of TourniesService in com.threerings.parlor.tourney.data
+  +

+ + + + + + + + + +
Classes in com.threerings.parlor.tourney.data that implement TourniesService
+ classTourniesMarshaller + +
+          Provides the implementation of the TourniesService interface + that marshalls the arguments and delivers the request to the provider + on the server.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/tourney/client/package-frame.html b/apidocs/com/threerings/parlor/tourney/client/package-frame.html new file mode 100644 index 00000000..91fa7024 --- /dev/null +++ b/apidocs/com/threerings/parlor/tourney/client/package-frame.html @@ -0,0 +1,35 @@ + + + + + + + +com.threerings.parlor.tourney.client (vilya 1.3 API) + + + + + + + + + + + +com.threerings.parlor.tourney.client + + + + +
+Interfaces  + +
+TourneyService +
+TourniesService
+ + + + diff --git a/apidocs/com/threerings/parlor/tourney/client/package-summary.html b/apidocs/com/threerings/parlor/tourney/client/package-summary.html new file mode 100644 index 00000000..e93b5a7f --- /dev/null +++ b/apidocs/com/threerings/parlor/tourney/client/package-summary.html @@ -0,0 +1,163 @@ + + + + + + + +com.threerings.parlor.tourney.client (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.parlor.tourney.client +

+ + + + + + + + + + + + + +
+Interface Summary
TourneyServiceProvides tourney management services for the particular tourney this + service is attached to.
TourniesServiceProvices services for creating/modifying tournies.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/tourney/client/package-tree.html b/apidocs/com/threerings/parlor/tourney/client/package-tree.html new file mode 100644 index 00000000..cc687287 --- /dev/null +++ b/apidocs/com/threerings/parlor/tourney/client/package-tree.html @@ -0,0 +1,154 @@ + + + + + + + +com.threerings.parlor.tourney.client Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.parlor.tourney.client +

+
+
+
Package Hierarchies:
All Packages
+
+

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/tourney/client/package-use.html b/apidocs/com/threerings/parlor/tourney/client/package-use.html new file mode 100644 index 00000000..8971c880 --- /dev/null +++ b/apidocs/com/threerings/parlor/tourney/client/package-use.html @@ -0,0 +1,178 @@ + + + + + + + +Uses of Package com.threerings.parlor.tourney.client (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.parlor.tourney.client

+
+ + + + + + + + + +
+Packages that use com.threerings.parlor.tourney.client
com.threerings.parlor.tourney.data  
+  +

+ + + + + + + + + + + +
+Classes in com.threerings.parlor.tourney.client used by com.threerings.parlor.tourney.data
TourneyService + +
+          Provides tourney management services for the particular tourney this + service is attached to.
TourniesService + +
+          Provices services for creating/modifying tournies.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/tourney/data/EntryFee.html b/apidocs/com/threerings/parlor/tourney/data/EntryFee.html new file mode 100644 index 00000000..04f28553 --- /dev/null +++ b/apidocs/com/threerings/parlor/tourney/data/EntryFee.html @@ -0,0 +1,356 @@ + + + + + + + +EntryFee (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.tourney.data +
+Class EntryFee

+
+java.lang.Object
+  extended by com.threerings.io.SimpleStreamableObject
+      extended by com.threerings.parlor.tourney.data.EntryFee
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable
+
+
+
+
public abstract class EntryFee
extends com.threerings.io.SimpleStreamableObject
+ + +

+Extensible entry fee class that specifies entry requirements for a tourney. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + +
+Constructor Summary
EntryFee() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+abstract  StringgetDescription() + +
+          Returns a description of the entry fee.
+abstract  booleanhasFee(com.threerings.crowd.data.BodyObject body) + +
+          Checks if the user has the required entry fee.
+abstract  voidreserveFee(com.threerings.crowd.data.BodyObject body, + ResultListener<Void> listener) + +
+          Attempts to reserve the entry fee.
+abstract  voidreturnFee(com.threerings.crowd.data.BodyObject body) + +
+          Returns the entry fee.
+  + + + + + + + +
Methods inherited from class com.threerings.io.SimpleStreamableObject
toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+EntryFee

+
+public EntryFee()
+
+
+ + + + + + + + +
+Method Detail
+ +

+getDescription

+
+public abstract String getDescription()
+
+
Returns a description of the entry fee. +

+

+
+
+
+
+ +

+hasFee

+
+public abstract boolean hasFee(com.threerings.crowd.data.BodyObject body)
+
+
Checks if the user has the required entry fee. +

+

+
+
+
+
+ +

+reserveFee

+
+public abstract void reserveFee(com.threerings.crowd.data.BodyObject body,
+                                ResultListener<Void> listener)
+
+
Attempts to reserve the entry fee. +

+

+
+
+
+
+ +

+returnFee

+
+public abstract void returnFee(com.threerings.crowd.data.BodyObject body)
+
+
Returns the entry fee. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/tourney/data/Participant.html b/apidocs/com/threerings/parlor/tourney/data/Participant.html new file mode 100644 index 00000000..f93b1163 --- /dev/null +++ b/apidocs/com/threerings/parlor/tourney/data/Participant.html @@ -0,0 +1,409 @@ + + + + + + + +Participant (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.tourney.data +
+Class Participant

+
+java.lang.Object
+  extended by com.threerings.io.SimpleStreamableObject
+      extended by com.threerings.parlor.tourney.data.Participant
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable, com.threerings.presents.dobj.DSet.Entry, Comparable<Participant>
+
+
+
+
public class Participant
extends com.threerings.io.SimpleStreamableObject
implements com.threerings.presents.dobj.DSet.Entry, Comparable<Participant>
+ + +

+Contains information on a particular tourney participant. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + +
+Field Summary
+ com.threerings.util.Nameusername + +
+          The username of the participant.
+  + + + + + + + + + + +
+Constructor Summary
Participant() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ intcompareTo(Participant op) + +
+           
+ booleanequals(Object other) + +
+           
+ Comparable<?>getKey() + +
+           
+ inthashCode() + +
+           
+ StringtoString() + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+username

+
+public com.threerings.util.Name username
+
+
The username of the participant. +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+Participant

+
+public Participant()
+
+
+ + + + + + + + +
+Method Detail
+ +

+getKey

+
+public Comparable<?> getKey()
+
+
+
Specified by:
getKey in interface com.threerings.presents.dobj.DSet.Entry
+
+
+
+
+
+
+ +

+compareTo

+
+public int compareTo(Participant op)
+
+
+
Specified by:
compareTo in interface Comparable<Participant>
+
+
+
+
+
+
+ +

+equals

+
+public boolean equals(Object other)
+
+
+
Overrides:
equals in class Object
+
+
+
+
+
+
+ +

+hashCode

+
+public int hashCode()
+
+
+
Overrides:
hashCode in class Object
+
+
+
+
+
+
+ +

+toString

+
+public String toString()
+
+
+
Overrides:
toString in class com.threerings.io.SimpleStreamableObject
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/tourney/data/Prize.html b/apidocs/com/threerings/parlor/tourney/data/Prize.html new file mode 100644 index 00000000..ebd0b429 --- /dev/null +++ b/apidocs/com/threerings/parlor/tourney/data/Prize.html @@ -0,0 +1,291 @@ + + + + + + + +Prize (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.tourney.data +
+Class Prize

+
+java.lang.Object
+  extended by com.threerings.io.SimpleStreamableObject
+      extended by com.threerings.parlor.tourney.data.Prize
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable
+
+
+
+
public abstract class Prize
extends com.threerings.io.SimpleStreamableObject
+ + +

+Extensible class that specifies the prize for a tourney. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + +
+Constructor Summary
Prize() + +
+           
+  + + + + + + + + + + + +
+Method Summary
+abstract  StringgetDescription() + +
+          Returns a description of the prize.
+  + + + + + + + +
Methods inherited from class com.threerings.io.SimpleStreamableObject
toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+Prize

+
+public Prize()
+
+
+ + + + + + + + +
+Method Detail
+ +

+getDescription

+
+public abstract String getDescription()
+
+
Returns a description of the prize. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/tourney/data/TourneyCodes.html b/apidocs/com/threerings/parlor/tourney/data/TourneyCodes.html new file mode 100644 index 00000000..c5911991 --- /dev/null +++ b/apidocs/com/threerings/parlor/tourney/data/TourneyCodes.html @@ -0,0 +1,366 @@ + + + + + + + +TourneyCodes (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.tourney.data +
+Interface TourneyCodes

+
+
All Superinterfaces:
com.threerings.presents.data.InvocationCodes
+
+
+
All Known Implementing Classes:
TourneyManager
+
+
+
+
public interface TourneyCodes
extends com.threerings.presents.data.InvocationCodes
+ + +

+Constants and codes relating to the tourney services. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static StringALREADY_IN_PROGRESS + +
+          The tourney is already in progress.
+static StringALREADY_IN_TOURNEY + +
+          User already in a tourney.
+static StringCANCELLED + +
+          The tournament was canceled.
+static StringFAILED_ENTRY_FEE + +
+          User failed to meet the entry fee requirements.
+static StringHAS_PLAYERS + +
+          This tourney has participating players.
+static StringNOT_IN_TOURNEY + +
+          User is not in the tourney.
+static StringTOO_LATE + +
+          Too late to join a tourney.
+static StringTOO_LATE_LEAVE + +
+          It's too late to leave the tourney.
+  + + + + + + + +
Fields inherited from interface com.threerings.presents.data.InvocationCodes
ACCESS_DENIED, E_ACCESS_DENIED, E_INTERNAL_ERROR, GLOBAL_GROUP, INTERNAL_ERROR
+  +

+ + + + + + + + +
+Field Detail
+ +

+TOO_LATE

+
+static final String TOO_LATE
+
+
Too late to join a tourney. +

+

+
See Also:
Constant Field Values
+
+
+ +

+ALREADY_IN_TOURNEY

+
+static final String ALREADY_IN_TOURNEY
+
+
User already in a tourney. +

+

+
See Also:
Constant Field Values
+
+
+ +

+FAILED_ENTRY_FEE

+
+static final String FAILED_ENTRY_FEE
+
+
User failed to meet the entry fee requirements. +

+

+
See Also:
Constant Field Values
+
+
+ +

+TOO_LATE_LEAVE

+
+static final String TOO_LATE_LEAVE
+
+
It's too late to leave the tourney. +

+

+
See Also:
Constant Field Values
+
+
+ +

+NOT_IN_TOURNEY

+
+static final String NOT_IN_TOURNEY
+
+
User is not in the tourney. +

+

+
See Also:
Constant Field Values
+
+
+ +

+ALREADY_IN_PROGRESS

+
+static final String ALREADY_IN_PROGRESS
+
+
The tourney is already in progress. +

+

+
See Also:
Constant Field Values
+
+
+ +

+HAS_PLAYERS

+
+static final String HAS_PLAYERS
+
+
This tourney has participating players. +

+

+
See Also:
Constant Field Values
+
+
+ +

+CANCELLED

+
+static final String CANCELLED
+
+
The tournament was canceled. +

+

+
See Also:
Constant Field Values
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/tourney/data/TourneyConfig.html b/apidocs/com/threerings/parlor/tourney/data/TourneyConfig.html new file mode 100644 index 00000000..32193741 --- /dev/null +++ b/apidocs/com/threerings/parlor/tourney/data/TourneyConfig.html @@ -0,0 +1,419 @@ + + + + + + + +TourneyConfig (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.tourney.data +
+Class TourneyConfig

+
+java.lang.Object
+  extended by com.threerings.io.SimpleStreamableObject
+      extended by com.threerings.parlor.tourney.data.TourneyConfig
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable
+
+
+
+
public class TourneyConfig
extends com.threerings.io.SimpleStreamableObject
+ + +

+Stores tournament configuration data. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+ com.threerings.util.Namecreator + +
+          The tourney creator.
+ EntryFeeentryFee + +
+          The fee to join the tourney.
+ TourneyLogicDatalogic + +
+          The tournament logic runtime persistent data.
+ intminPlayers + +
+          The minimum number of players needed for the tourney to start.
+ Prizeprize + +
+          The prize for this tourney.
+ intstartsIn + +
+          The number of minutes to wait for entrants before starting.
+ inttourneyId + +
+          Our unique tourney id.
+  + + + + + + + + + + +
+Constructor Summary
TourneyConfig() + +
+           
+  + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from class com.threerings.io.SimpleStreamableObject
toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+tourneyId

+
+public int tourneyId
+
+
Our unique tourney id. +

+

+
+
+
+ +

+prize

+
+public Prize prize
+
+
The prize for this tourney. +

+

+
+
+
+ +

+entryFee

+
+public EntryFee entryFee
+
+
The fee to join the tourney. +

+

+
+
+
+ +

+creator

+
+public com.threerings.util.Name creator
+
+
The tourney creator. +

+

+
+
+
+ +

+minPlayers

+
+public int minPlayers
+
+
The minimum number of players needed for the tourney to start. +

+

+
+
+
+ +

+startsIn

+
+public int startsIn
+
+
The number of minutes to wait for entrants before starting. +

+

+
+
+
+ +

+logic

+
+public TourneyLogicData logic
+
+
The tournament logic runtime persistent data. +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+TourneyConfig

+
+public TourneyConfig()
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/tourney/data/TourneyLogicData.html b/apidocs/com/threerings/parlor/tourney/data/TourneyLogicData.html new file mode 100644 index 00000000..a2af135c --- /dev/null +++ b/apidocs/com/threerings/parlor/tourney/data/TourneyLogicData.html @@ -0,0 +1,261 @@ + + + + + + + +TourneyLogicData (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.tourney.data +
+Class TourneyLogicData

+
+java.lang.Object
+  extended by com.threerings.io.SimpleStreamableObject
+      extended by com.threerings.parlor.tourney.data.TourneyLogicData
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable
+
+
+
+
public class TourneyLogicData
extends com.threerings.io.SimpleStreamableObject
+ + +

+Contains TourneyLogic runtime data that should be persisted. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + +
+Constructor Summary
TourneyLogicData() + +
+           
+  + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from class com.threerings.io.SimpleStreamableObject
toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+TourneyLogicData

+
+public TourneyLogicData()
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/tourney/data/TourneyMarshaller.html b/apidocs/com/threerings/parlor/tourney/data/TourneyMarshaller.html new file mode 100644 index 00000000..0a504bdc --- /dev/null +++ b/apidocs/com/threerings/parlor/tourney/data/TourneyMarshaller.html @@ -0,0 +1,449 @@ + + + + + + + +TourneyMarshaller (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.tourney.data +
+Class TourneyMarshaller

+
+java.lang.Object
+  extended by com.threerings.presents.data.InvocationMarshaller
+      extended by com.threerings.parlor.tourney.data.TourneyMarshaller
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable, TourneyService, com.threerings.presents.client.InvocationService
+
+
+
+
@Generated(value="com.threerings.presents.tools.GenServiceTask",
+           comments="Derived from TourneyService.java.")
+public class TourneyMarshaller
extends com.threerings.presents.data.InvocationMarshaller
implements TourneyService
+ + +

+Provides the implementation of the TourneyService interface + that marshalls the arguments and delivers the request to the provider + on the server. Also provides an implementation of the response listener + interfaces that marshall the response arguments and deliver them back + to the requesting client. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.presents.data.InvocationMarshaller
com.threerings.presents.data.InvocationMarshaller.ConfirmMarshaller, com.threerings.presents.data.InvocationMarshaller.ListenerMarshaller, com.threerings.presents.data.InvocationMarshaller.ResultMarshaller
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.presents.client.InvocationService
com.threerings.presents.client.InvocationService.ConfirmListener, com.threerings.presents.client.InvocationService.InvocationListener, com.threerings.presents.client.InvocationService.ResultListener
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static intCANCEL + +
+          The method id used to dispatch cancel(com.threerings.presents.client.InvocationService.ConfirmListener) requests.
+static intJOIN + +
+          The method id used to dispatch join(com.threerings.presents.client.InvocationService.ConfirmListener) requests.
+static intLEAVE + +
+          The method id used to dispatch leave(com.threerings.presents.client.InvocationService.ConfirmListener) requests.
+  + + + + + + + + + + +
+Constructor Summary
TourneyMarshaller() + +
+           
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidcancel(com.threerings.presents.client.InvocationService.ConfirmListener arg1) + +
+          Handles a request to cancel the tourney.
+ voidjoin(com.threerings.presents.client.InvocationService.ConfirmListener arg1) + +
+          Handles a request to join the tourney.
+ voidleave(com.threerings.presents.client.InvocationService.ConfirmListener arg1) + +
+          Handles a request to leave the tourney.
+  + + + + + + + +
Methods inherited from class com.threerings.presents.data.InvocationMarshaller
getInvocationCode, init, readField__invCode, readField__invOid, readObject, setInvocationOid, setNoResponse, toString, writeField__invCode, writeField__invOid
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+CANCEL

+
+public static final int CANCEL
+
+
The method id used to dispatch cancel(com.threerings.presents.client.InvocationService.ConfirmListener) requests. +

+

+
See Also:
Constant Field Values
+
+
+ +

+JOIN

+
+public static final int JOIN
+
+
The method id used to dispatch join(com.threerings.presents.client.InvocationService.ConfirmListener) requests. +

+

+
See Also:
Constant Field Values
+
+
+ +

+LEAVE

+
+public static final int LEAVE
+
+
The method id used to dispatch leave(com.threerings.presents.client.InvocationService.ConfirmListener) requests. +

+

+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Constructor Detail
+ +

+TourneyMarshaller

+
+public TourneyMarshaller()
+
+
+ + + + + + + + +
+Method Detail
+ +

+cancel

+
+public void cancel(com.threerings.presents.client.InvocationService.ConfirmListener arg1)
+
+
Description copied from interface: TourneyService
+
Handles a request to cancel the tourney. +

+

+
Specified by:
cancel in interface TourneyService
+
+
+
+
+
+
+ +

+join

+
+public void join(com.threerings.presents.client.InvocationService.ConfirmListener arg1)
+
+
Description copied from interface: TourneyService
+
Handles a request to join the tourney. +

+

+
Specified by:
join in interface TourneyService
+
+
+
+
+
+
+ +

+leave

+
+public void leave(com.threerings.presents.client.InvocationService.ConfirmListener arg1)
+
+
Description copied from interface: TourneyService
+
Handles a request to leave the tourney. +

+

+
Specified by:
leave in interface TourneyService
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/tourney/data/TourneyObject.html b/apidocs/com/threerings/parlor/tourney/data/TourneyObject.html new file mode 100644 index 00000000..796519bb --- /dev/null +++ b/apidocs/com/threerings/parlor/tourney/data/TourneyObject.html @@ -0,0 +1,810 @@ + + + + + + + +TourneyObject (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.tourney.data +
+Class TourneyObject

+
+java.lang.Object
+  extended by com.threerings.presents.dobj.DObject
+      extended by com.threerings.parlor.tourney.data.TourneyObject
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable
+
+
+
+
public class TourneyObject
extends com.threerings.presents.dobj.DObject
+ + +

+Provides information on a specific tourney. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static intCANCELLED + +
+          Tourney has been cancelled.
+ TourneyConfigconfig + +
+          The tourney configuration.
+static StringCONFIG + +
+          The field name of the config field.
+static intFINISHED + +
+          Tourney has completed.
+ com.threerings.presents.dobj.DSet<Participant>participants + +
+          A DSet that accumulates Participant records for the players involved in this tourney.
+static StringPARTICIPANTS + +
+          The field name of the participants field.
+static intPAUSED + +
+          Tourney is paused.
+static intPENDING + +
+          Tourney is pending and accepting participants.
+static intRUNNING + +
+          Tourney is currently running.
+static StringSTARTS_IN + +
+          The field name of the startsIn field.
+ intstartsIn + +
+          The real-time number of minutes before it starts.
+ intstate + +
+          The current state of the tourney.
+static StringSTATE + +
+          The field name of the state field.
+static StringTOURNEY_SERVICE + +
+          The field name of the tourneyService field.
+ TourneyMarshallertourneyService + +
+          Provides the way in which tourney participants can communicate with the server.
+  + + + + + + + + + + +
+Constructor Summary
TourneyObject() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidaddToParticipants(Participant elem) + +
+          Requests that the specified entry be added to the + participants set.
+ voidremoveFromParticipants(Comparable<?> key) + +
+          Requests that the entry matching the supplied key be removed from + the participants set.
+ voidsetConfig(TourneyConfig value) + +
+          Requests that the config field be set to the + specified value.
+ voidsetParticipants(com.threerings.presents.dobj.DSet<Participant> value) + +
+          Requests that the participants field be set to the + specified value.
+ voidsetStartsIn(int value) + +
+          Requests that the startsIn field be set to the + specified value.
+ voidsetState(int value) + +
+          Requests that the state field be set to the + specified value.
+ voidsetTourneyService(TourneyMarshaller value) + +
+          Requests that the tourneyService field be set to the + specified value.
+ voidupdateParticipants(Participant elem) + +
+          Requests that the specified entry be updated in the + participants set.
+  + + + + + + + +
Methods inherited from class com.threerings.presents.dobj.DObject
acquireLock, addListener, addListener, addSubscriber, addToSet, cancelTransaction, changeAttribute, checkPermissions, checkPermissions, commitTransaction, destroy, getAccessController, getAttribute, getLocal, getLocals, getManager, getOid, getSet, inTransaction, isActive, notifyListeners, notifyProxies, postEvent, postMessage, postMessage, readField__oid, releaseLock, removeFromSet, removeListener, removeSubscriber, setAccessController, setAttribute, setDestroyOnLastSubscriberRemoved, setLocal, setManager, setOid, startTransaction, toString, updateSet, which, writeField__oid
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+STATE

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public static final String STATE
+
+
The field name of the state field. +

+

+
See Also:
Constant Field Values
+
+
+ +

+CONFIG

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public static final String CONFIG
+
+
The field name of the config field. +

+

+
See Also:
Constant Field Values
+
+
+ +

+STARTS_IN

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public static final String STARTS_IN
+
+
The field name of the startsIn field. +

+

+
See Also:
Constant Field Values
+
+
+ +

+TOURNEY_SERVICE

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public static final String TOURNEY_SERVICE
+
+
The field name of the tourneyService field. +

+

+
See Also:
Constant Field Values
+
+
+ +

+PARTICIPANTS

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public static final String PARTICIPANTS
+
+
The field name of the participants field. +

+

+
See Also:
Constant Field Values
+
+
+ +

+PENDING

+
+public static final int PENDING
+
+
Tourney is pending and accepting participants. +

+

+
See Also:
Constant Field Values
+
+
+ +

+RUNNING

+
+public static final int RUNNING
+
+
Tourney is currently running. +

+

+
See Also:
Constant Field Values
+
+
+ +

+CANCELLED

+
+public static final int CANCELLED
+
+
Tourney has been cancelled. +

+

+
See Also:
Constant Field Values
+
+
+ +

+PAUSED

+
+public static final int PAUSED
+
+
Tourney is paused. +

+

+
See Also:
Constant Field Values
+
+
+ +

+FINISHED

+
+public static final int FINISHED
+
+
Tourney has completed. +

+

+
See Also:
Constant Field Values
+
+
+ +

+state

+
+public int state
+
+
The current state of the tourney. +

+

+
+
+
+ +

+config

+
+public TourneyConfig config
+
+
The tourney configuration. +

+

+
+
+
+ +

+startsIn

+
+public int startsIn
+
+
The real-time number of minutes before it starts. +

+

+
+
+
+ +

+tourneyService

+
+public TourneyMarshaller tourneyService
+
+
Provides the way in which tourney participants can communicate with the server. +

+

+
+
+
+ +

+participants

+
+public com.threerings.presents.dobj.DSet<Participant> participants
+
+
A DSet that accumulates Participant records for the players involved in this tourney. +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+TourneyObject

+
+public TourneyObject()
+
+
+ + + + + + + + +
+Method Detail
+ +

+setState

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public void setState(int value)
+
+
Requests that the state field be set to the + specified value. The local value will be updated immediately and an + event will be propagated through the system to notify all listeners + that the attribute did change. Proxied copies of this object (on + clients) will apply the value change when they received the + attribute changed notification. +

+

+
+
+
+
+ +

+setConfig

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public void setConfig(TourneyConfig value)
+
+
Requests that the config field be set to the + specified value. The local value will be updated immediately and an + event will be propagated through the system to notify all listeners + that the attribute did change. Proxied copies of this object (on + clients) will apply the value change when they received the + attribute changed notification. +

+

+
+
+
+
+ +

+setStartsIn

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public void setStartsIn(int value)
+
+
Requests that the startsIn field be set to the + specified value. The local value will be updated immediately and an + event will be propagated through the system to notify all listeners + that the attribute did change. Proxied copies of this object (on + clients) will apply the value change when they received the + attribute changed notification. +

+

+
+
+
+
+ +

+setTourneyService

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public void setTourneyService(TourneyMarshaller value)
+
+
Requests that the tourneyService field be set to the + specified value. The local value will be updated immediately and an + event will be propagated through the system to notify all listeners + that the attribute did change. Proxied copies of this object (on + clients) will apply the value change when they received the + attribute changed notification. +

+

+
+
+
+
+ +

+addToParticipants

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public void addToParticipants(Participant elem)
+
+
Requests that the specified entry be added to the + participants set. The set will not change until the event is + actually propagated through the system. +

+

+
+
+
+
+ +

+removeFromParticipants

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public void removeFromParticipants(Comparable<?> key)
+
+
Requests that the entry matching the supplied key be removed from + the participants set. The set will not change until the + event is actually propagated through the system. +

+

+
+
+
+
+ +

+updateParticipants

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public void updateParticipants(Participant elem)
+
+
Requests that the specified entry be updated in the + participants set. The set will not change until the event is + actually propagated through the system. +

+

+
+
+
+
+ +

+setParticipants

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public void setParticipants(com.threerings.presents.dobj.DSet<Participant> value)
+
+
Requests that the participants field be set to the + specified value. Generally one only adds, updates and removes + entries of a distributed set, but certain situations call for a + complete replacement of the set value. The local value will be + updated immediately and an event will be propagated through the + system to notify all listeners that the attribute did + change. Proxied copies of this object (on clients) will apply the + value change when they received the attribute changed notification. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/tourney/data/TourniesMarshaller.html b/apidocs/com/threerings/parlor/tourney/data/TourniesMarshaller.html new file mode 100644 index 00000000..9891d700 --- /dev/null +++ b/apidocs/com/threerings/parlor/tourney/data/TourniesMarshaller.html @@ -0,0 +1,361 @@ + + + + + + + +TourniesMarshaller (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.tourney.data +
+Class TourniesMarshaller

+
+java.lang.Object
+  extended by com.threerings.presents.data.InvocationMarshaller
+      extended by com.threerings.parlor.tourney.data.TourniesMarshaller
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable, TourniesService, com.threerings.presents.client.InvocationService
+
+
+
+
@Generated(value="com.threerings.presents.tools.GenServiceTask",
+           comments="Derived from TourniesService.java.")
+public class TourniesMarshaller
extends com.threerings.presents.data.InvocationMarshaller
implements TourniesService
+ + +

+Provides the implementation of the TourniesService interface + that marshalls the arguments and delivers the request to the provider + on the server. Also provides an implementation of the response listener + interfaces that marshall the response arguments and deliver them back + to the requesting client. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.presents.data.InvocationMarshaller
com.threerings.presents.data.InvocationMarshaller.ConfirmMarshaller, com.threerings.presents.data.InvocationMarshaller.ListenerMarshaller, com.threerings.presents.data.InvocationMarshaller.ResultMarshaller
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.presents.client.InvocationService
com.threerings.presents.client.InvocationService.ConfirmListener, com.threerings.presents.client.InvocationService.InvocationListener, com.threerings.presents.client.InvocationService.ResultListener
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + +
+Field Summary
+static intCREATE_TOURNEY + +
+          The method id used to dispatch createTourney(com.threerings.parlor.tourney.data.TourneyConfig, com.threerings.presents.client.InvocationService.ResultListener) requests.
+  + + + + + + + + + + +
+Constructor Summary
TourniesMarshaller() + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ voidcreateTourney(TourneyConfig arg1, + com.threerings.presents.client.InvocationService.ResultListener arg2) + +
+          Creates a new tourney.
+  + + + + + + + +
Methods inherited from class com.threerings.presents.data.InvocationMarshaller
getInvocationCode, init, readField__invCode, readField__invOid, readObject, setInvocationOid, setNoResponse, toString, writeField__invCode, writeField__invOid
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+CREATE_TOURNEY

+
+public static final int CREATE_TOURNEY
+
+
The method id used to dispatch createTourney(com.threerings.parlor.tourney.data.TourneyConfig, com.threerings.presents.client.InvocationService.ResultListener) requests. +

+

+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Constructor Detail
+ +

+TourniesMarshaller

+
+public TourniesMarshaller()
+
+
+ + + + + + + + +
+Method Detail
+ +

+createTourney

+
+public void createTourney(TourneyConfig arg1,
+                          com.threerings.presents.client.InvocationService.ResultListener arg2)
+
+
Description copied from interface: TourniesService
+
Creates a new tourney. +

+

+
Specified by:
createTourney in interface TourniesService
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/tourney/data/class-use/EntryFee.html b/apidocs/com/threerings/parlor/tourney/data/class-use/EntryFee.html new file mode 100644 index 00000000..81b0ca2e --- /dev/null +++ b/apidocs/com/threerings/parlor/tourney/data/class-use/EntryFee.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class com.threerings.parlor.tourney.data.EntryFee (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.tourney.data.EntryFee

+
+ + + + + + + + + +
+Packages that use EntryFee
com.threerings.parlor.tourney.data  
+  +

+ + + + + +
+Uses of EntryFee in com.threerings.parlor.tourney.data
+  +

+ + + + + + + + + +
Fields in com.threerings.parlor.tourney.data declared as EntryFee
+ EntryFeeTourneyConfig.entryFee + +
+          The fee to join the tourney.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/tourney/data/class-use/Participant.html b/apidocs/com/threerings/parlor/tourney/data/class-use/Participant.html new file mode 100644 index 00000000..eb852ff3 --- /dev/null +++ b/apidocs/com/threerings/parlor/tourney/data/class-use/Participant.html @@ -0,0 +1,232 @@ + + + + + + + +Uses of Class com.threerings.parlor.tourney.data.Participant (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.tourney.data.Participant

+
+ + + + + + + + + +
+Packages that use Participant
com.threerings.parlor.tourney.data  
+  +

+ + + + + +
+Uses of Participant in com.threerings.parlor.tourney.data
+  +

+ + + + + + + + + +
Fields in com.threerings.parlor.tourney.data with type parameters of type Participant
+ com.threerings.presents.dobj.DSet<Participant>TourneyObject.participants + +
+          A DSet that accumulates Participant records for the players involved in this tourney.
+  +

+ + + + + + + + + + + + + + + + + +
Methods in com.threerings.parlor.tourney.data with parameters of type Participant
+ voidTourneyObject.addToParticipants(Participant elem) + +
+          Requests that the specified entry be added to the + participants set.
+ intParticipant.compareTo(Participant op) + +
+           
+ voidTourneyObject.updateParticipants(Participant elem) + +
+          Requests that the specified entry be updated in the + participants set.
+  +

+ + + + + + + + + +
Method parameters in com.threerings.parlor.tourney.data with type arguments of type Participant
+ voidTourneyObject.setParticipants(com.threerings.presents.dobj.DSet<Participant> value) + +
+          Requests that the participants field be set to the + specified value.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/tourney/data/class-use/Prize.html b/apidocs/com/threerings/parlor/tourney/data/class-use/Prize.html new file mode 100644 index 00000000..15f5b217 --- /dev/null +++ b/apidocs/com/threerings/parlor/tourney/data/class-use/Prize.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class com.threerings.parlor.tourney.data.Prize (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.tourney.data.Prize

+
+ + + + + + + + + +
+Packages that use Prize
com.threerings.parlor.tourney.data  
+  +

+ + + + + +
+Uses of Prize in com.threerings.parlor.tourney.data
+  +

+ + + + + + + + + +
Fields in com.threerings.parlor.tourney.data declared as Prize
+ PrizeTourneyConfig.prize + +
+          The prize for this tourney.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/tourney/data/class-use/TourneyCodes.html b/apidocs/com/threerings/parlor/tourney/data/class-use/TourneyCodes.html new file mode 100644 index 00000000..4201d31d --- /dev/null +++ b/apidocs/com/threerings/parlor/tourney/data/class-use/TourneyCodes.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Interface com.threerings.parlor.tourney.data.TourneyCodes (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.parlor.tourney.data.TourneyCodes

+
+ + + + + + + + + +
+Packages that use TourneyCodes
com.threerings.parlor.tourney.server  
+  +

+ + + + + +
+Uses of TourneyCodes in com.threerings.parlor.tourney.server
+  +

+ + + + + + + + + +
Classes in com.threerings.parlor.tourney.server that implement TourneyCodes
+ classTourneyManager + +
+          Controls a running tourney.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/tourney/data/class-use/TourneyConfig.html b/apidocs/com/threerings/parlor/tourney/data/class-use/TourneyConfig.html new file mode 100644 index 00000000..114b8e92 --- /dev/null +++ b/apidocs/com/threerings/parlor/tourney/data/class-use/TourneyConfig.html @@ -0,0 +1,370 @@ + + + + + + + +Uses of Class com.threerings.parlor.tourney.data.TourneyConfig (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.tourney.data.TourneyConfig

+
+ + + + + + + + + + + + + + + + + + + + + +
+Packages that use TourneyConfig
com.threerings.parlor.tourney.client  
com.threerings.parlor.tourney.data  
com.threerings.parlor.tourney.server  
com.threerings.parlor.tourney.server.persist  
+  +

+ + + + + +
+Uses of TourneyConfig in com.threerings.parlor.tourney.client
+  +

+ + + + + + + + + +
Methods in com.threerings.parlor.tourney.client with parameters of type TourneyConfig
+ voidTourniesService.createTourney(TourneyConfig config, + com.threerings.presents.client.InvocationService.ResultListener listener) + +
+          Creates a new tourney.
+  +

+ + + + + +
+Uses of TourneyConfig in com.threerings.parlor.tourney.data
+  +

+ + + + + + + + + +
Fields in com.threerings.parlor.tourney.data declared as TourneyConfig
+ TourneyConfigTourneyObject.config + +
+          The tourney configuration.
+  +

+ + + + + + + + + + + + + +
Methods in com.threerings.parlor.tourney.data with parameters of type TourneyConfig
+ voidTourniesMarshaller.createTourney(TourneyConfig arg1, + com.threerings.presents.client.InvocationService.ResultListener arg2) + +
+           
+ voidTourneyObject.setConfig(TourneyConfig value) + +
+          Requests that the config field be set to the + specified value.
+  +

+ + + + + +
+Uses of TourneyConfig in com.threerings.parlor.tourney.server
+  +

+ + + + + + + + + + + + + + + + + +
Methods in com.threerings.parlor.tourney.server with parameters of type TourneyConfig
+ voidTourniesProvider.createTourney(com.threerings.presents.data.ClientObject caller, + TourneyConfig arg1, + com.threerings.presents.client.InvocationService.ResultListener arg2) + +
+          Handles a TourniesService.createTourney(com.threerings.parlor.tourney.data.TourneyConfig, com.threerings.presents.client.InvocationService.ResultListener) request.
+ voidTourniesManager.createTourney(com.threerings.presents.data.ClientObject caller, + TourneyConfig config, + com.threerings.presents.client.InvocationService.ResultListener listener) + +
+           
+ intTourneyManager.init(TourneyConfig config, + Comparable<?> key) + +
+          Initializes this tourney manager and prepares it for operation.
+  +

+ + + + + +
+Uses of TourneyConfig in com.threerings.parlor.tourney.server.persist
+  +

+ + + + + + + + + +
Methods in com.threerings.parlor.tourney.server.persist that return TourneyConfig
+ TourneyConfigTourneyRepository.TourneyRecord.getTourneyConfig() + +
+           
+  +

+ + + + + + + + + +
Methods in com.threerings.parlor.tourney.server.persist that return types with arguments of type TourneyConfig
+ ArrayList<TourneyConfig>TourneyRepository.loadTournies() + +
+          Loads all the tourney configs from the repository.
+  +

+ + + + + + + + + + + + + +
Methods in com.threerings.parlor.tourney.server.persist with parameters of type TourneyConfig
+ voidTourneyRepository.insertTourney(TourneyConfig tourney) + +
+          Inserts a new tourney into the repository, assigning a unique id to the tourney.
+ voidTourneyRepository.updateTourney(TourneyConfig tourney) + +
+          Updates the tourney in the repository.
+  +

+ + + + + + + + +
Constructors in com.threerings.parlor.tourney.server.persist with parameters of type TourneyConfig
TourneyRepository.TourneyRecord(TourneyConfig tourneyConfig) + +
+           
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/tourney/data/class-use/TourneyLogicData.html b/apidocs/com/threerings/parlor/tourney/data/class-use/TourneyLogicData.html new file mode 100644 index 00000000..8ea41224 --- /dev/null +++ b/apidocs/com/threerings/parlor/tourney/data/class-use/TourneyLogicData.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class com.threerings.parlor.tourney.data.TourneyLogicData (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.tourney.data.TourneyLogicData

+
+ + + + + + + + + +
+Packages that use TourneyLogicData
com.threerings.parlor.tourney.data  
+  +

+ + + + + +
+Uses of TourneyLogicData in com.threerings.parlor.tourney.data
+  +

+ + + + + + + + + +
Fields in com.threerings.parlor.tourney.data declared as TourneyLogicData
+ TourneyLogicDataTourneyConfig.logic + +
+          The tournament logic runtime persistent data.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/tourney/data/class-use/TourneyMarshaller.html b/apidocs/com/threerings/parlor/tourney/data/class-use/TourneyMarshaller.html new file mode 100644 index 00000000..279a982d --- /dev/null +++ b/apidocs/com/threerings/parlor/tourney/data/class-use/TourneyMarshaller.html @@ -0,0 +1,198 @@ + + + + + + + +Uses of Class com.threerings.parlor.tourney.data.TourneyMarshaller (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.tourney.data.TourneyMarshaller

+
+ + + + + + + + + +
+Packages that use TourneyMarshaller
com.threerings.parlor.tourney.data  
+  +

+ + + + + +
+Uses of TourneyMarshaller in com.threerings.parlor.tourney.data
+  +

+ + + + + + + + + +
Fields in com.threerings.parlor.tourney.data declared as TourneyMarshaller
+ TourneyMarshallerTourneyObject.tourneyService + +
+          Provides the way in which tourney participants can communicate with the server.
+  +

+ + + + + + + + + +
Methods in com.threerings.parlor.tourney.data with parameters of type TourneyMarshaller
+ voidTourneyObject.setTourneyService(TourneyMarshaller value) + +
+          Requests that the tourneyService field be set to the + specified value.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/tourney/data/class-use/TourneyObject.html b/apidocs/com/threerings/parlor/tourney/data/class-use/TourneyObject.html new file mode 100644 index 00000000..628d6abf --- /dev/null +++ b/apidocs/com/threerings/parlor/tourney/data/class-use/TourneyObject.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.parlor.tourney.data.TourneyObject (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.tourney.data.TourneyObject

+
+No usage of com.threerings.parlor.tourney.data.TourneyObject +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/tourney/data/class-use/TourniesMarshaller.html b/apidocs/com/threerings/parlor/tourney/data/class-use/TourniesMarshaller.html new file mode 100644 index 00000000..2eab1bd7 --- /dev/null +++ b/apidocs/com/threerings/parlor/tourney/data/class-use/TourniesMarshaller.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.parlor.tourney.data.TourniesMarshaller (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.tourney.data.TourniesMarshaller

+
+No usage of com.threerings.parlor.tourney.data.TourniesMarshaller +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/tourney/data/package-frame.html b/apidocs/com/threerings/parlor/tourney/data/package-frame.html new file mode 100644 index 00000000..f10e0806 --- /dev/null +++ b/apidocs/com/threerings/parlor/tourney/data/package-frame.html @@ -0,0 +1,58 @@ + + + + + + + +com.threerings.parlor.tourney.data (vilya 1.3 API) + + + + + + + + + + + +com.threerings.parlor.tourney.data + + + + +
+Interfaces  + +
+TourneyCodes
+ + + + + + +
+Classes  + +
+EntryFee +
+Participant +
+Prize +
+TourneyConfig +
+TourneyLogicData +
+TourneyMarshaller +
+TourneyObject +
+TourniesMarshaller
+ + + + diff --git a/apidocs/com/threerings/parlor/tourney/data/package-summary.html b/apidocs/com/threerings/parlor/tourney/data/package-summary.html new file mode 100644 index 00000000..bf94de9a --- /dev/null +++ b/apidocs/com/threerings/parlor/tourney/data/package-summary.html @@ -0,0 +1,204 @@ + + + + + + + +com.threerings.parlor.tourney.data (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.parlor.tourney.data +

+ + + + + + + + + +
+Interface Summary
TourneyCodesConstants and codes relating to the tourney services.
+  + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Class Summary
EntryFeeExtensible entry fee class that specifies entry requirements for a tourney.
ParticipantContains information on a particular tourney participant.
PrizeExtensible class that specifies the prize for a tourney.
TourneyConfigStores tournament configuration data.
TourneyLogicDataContains TourneyLogic runtime data that should be persisted.
TourneyMarshallerProvides the implementation of the TourneyService interface + that marshalls the arguments and delivers the request to the provider + on the server.
TourneyObjectProvides information on a specific tourney.
TourniesMarshallerProvides the implementation of the TourniesService interface + that marshalls the arguments and delivers the request to the provider + on the server.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/tourney/data/package-tree.html b/apidocs/com/threerings/parlor/tourney/data/package-tree.html new file mode 100644 index 00000000..4bff7a3a --- /dev/null +++ b/apidocs/com/threerings/parlor/tourney/data/package-tree.html @@ -0,0 +1,173 @@ + + + + + + + +com.threerings.parlor.tourney.data Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.parlor.tourney.data +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/tourney/data/package-use.html b/apidocs/com/threerings/parlor/tourney/data/package-use.html new file mode 100644 index 00000000..a9ec774f --- /dev/null +++ b/apidocs/com/threerings/parlor/tourney/data/package-use.html @@ -0,0 +1,266 @@ + + + + + + + +Uses of Package com.threerings.parlor.tourney.data (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.parlor.tourney.data

+
+ + + + + + + + + + + + + + + + + + + + + +
+Packages that use com.threerings.parlor.tourney.data
com.threerings.parlor.tourney.client  
com.threerings.parlor.tourney.data  
com.threerings.parlor.tourney.server  
com.threerings.parlor.tourney.server.persist  
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.tourney.data used by com.threerings.parlor.tourney.client
TourneyConfig + +
+          Stores tournament configuration data.
+  +

+ + + + + + + + + + + + + + + + + + + + + + + +
+Classes in com.threerings.parlor.tourney.data used by com.threerings.parlor.tourney.data
EntryFee + +
+          Extensible entry fee class that specifies entry requirements for a tourney.
Participant + +
+          Contains information on a particular tourney participant.
Prize + +
+          Extensible class that specifies the prize for a tourney.
TourneyConfig + +
+          Stores tournament configuration data.
TourneyLogicData + +
+          Contains TourneyLogic runtime data that should be persisted.
TourneyMarshaller + +
+          Provides the implementation of the TourneyService interface + that marshalls the arguments and delivers the request to the provider + on the server.
+  +

+ + + + + + + + + + + +
+Classes in com.threerings.parlor.tourney.data used by com.threerings.parlor.tourney.server
TourneyCodes + +
+          Constants and codes relating to the tourney services.
TourneyConfig + +
+          Stores tournament configuration data.
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.tourney.data used by com.threerings.parlor.tourney.server.persist
TourneyConfig + +
+          Stores tournament configuration data.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/tourney/server/TourneyManager.html b/apidocs/com/threerings/parlor/tourney/server/TourneyManager.html new file mode 100644 index 00000000..91ab74a4 --- /dev/null +++ b/apidocs/com/threerings/parlor/tourney/server/TourneyManager.html @@ -0,0 +1,551 @@ + + + + + + + +TourneyManager (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.tourney.server +
+Class TourneyManager

+
+java.lang.Object
+  extended by com.threerings.parlor.tourney.server.TourneyManager
+
+
+
All Implemented Interfaces:
TourneyCodes, TourneyProvider, com.threerings.presents.data.InvocationCodes, com.threerings.presents.server.InvocationProvider
+
+
+
+
public abstract class TourneyManager
extends Object
implements TourneyProvider, TourneyCodes
+ + +

+Controls a running tourney. +

+ +

+

+ +

+ + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from interface com.threerings.parlor.tourney.data.TourneyCodes
ALREADY_IN_PROGRESS, ALREADY_IN_TOURNEY, CANCELLED, FAILED_ENTRY_FEE, HAS_PLAYERS, NOT_IN_TOURNEY, TOO_LATE, TOO_LATE_LEAVE
+  + + + + + + + +
Fields inherited from interface com.threerings.presents.data.InvocationCodes
ACCESS_DENIED, E_ACCESS_DENIED, E_INTERNAL_ERROR, GLOBAL_GROUP, INTERNAL_ERROR
+  + + + + + + + + + + +
+Constructor Summary
TourneyManager() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidcancel(com.threerings.presents.data.ClientObject caller, + com.threerings.presents.client.InvocationService.ConfirmListener listener) + +
+          Handles a TourneyService.cancel(com.threerings.presents.client.InvocationService.ConfirmListener) request.
+ voidcancelTourney(String cause) + +
+          Cancel the tourney, return entry fees to all participants.
+ intinit(TourneyConfig config, + Comparable<?> key) + +
+          Initializes this tourney manager and prepares it for operation.
+ booleanisFinished() + +
+          Returns true if the tourney is finished.
+ booleanisPaused() + +
+          Returns true if the tourney is paused.
+ booleanisPending() + +
+          Returns true if the tourney is pending.
+ booleanisRunning() + +
+          Returns true if the tourney is running.
+ voidjoin(com.threerings.presents.data.ClientObject caller, + com.threerings.presents.client.InvocationService.ConfirmListener listener) + +
+          Handles a TourneyService.join(com.threerings.presents.client.InvocationService.ConfirmListener) request.
+ voidleave(com.threerings.presents.data.ClientObject caller, + com.threerings.presents.client.InvocationService.ConfirmListener listener) + +
+          Handles a TourneyService.leave(com.threerings.presents.client.InvocationService.ConfirmListener) request.
+abstract  voidnotifyAllParticipants(String msg) + +
+           
+ booleanshouldStart(long now) + +
+          Returns true if it is time or past time the tourney starts.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+TourneyManager

+
+public TourneyManager()
+
+
+ + + + + + + + +
+Method Detail
+ +

+init

+
+public int init(TourneyConfig config,
+                Comparable<?> key)
+
+
Initializes this tourney manager and prepares it for operation. +

+

+
+
+
+ +
Returns:
the oid of this manager's tourney object.
+
+
+
+ +

+cancel

+
+public void cancel(com.threerings.presents.data.ClientObject caller,
+                   com.threerings.presents.client.InvocationService.ConfirmListener listener)
+            throws com.threerings.presents.server.InvocationException
+
+
Description copied from interface: TourneyProvider
+
Handles a TourneyService.cancel(com.threerings.presents.client.InvocationService.ConfirmListener) request. +

+

+
Specified by:
cancel in interface TourneyProvider
+
+
+ +
Throws: +
com.threerings.presents.server.InvocationException
+
+
+
+ +

+join

+
+public void join(com.threerings.presents.data.ClientObject caller,
+                 com.threerings.presents.client.InvocationService.ConfirmListener listener)
+          throws com.threerings.presents.server.InvocationException
+
+
Description copied from interface: TourneyProvider
+
Handles a TourneyService.join(com.threerings.presents.client.InvocationService.ConfirmListener) request. +

+

+
Specified by:
join in interface TourneyProvider
+
+
+ +
Throws: +
com.threerings.presents.server.InvocationException
+
+
+
+ +

+leave

+
+public void leave(com.threerings.presents.data.ClientObject caller,
+                  com.threerings.presents.client.InvocationService.ConfirmListener listener)
+           throws com.threerings.presents.server.InvocationException
+
+
Description copied from interface: TourneyProvider
+
Handles a TourneyService.leave(com.threerings.presents.client.InvocationService.ConfirmListener) request. +

+

+
Specified by:
leave in interface TourneyProvider
+
+
+ +
Throws: +
com.threerings.presents.server.InvocationException
+
+
+
+ +

+cancelTourney

+
+public void cancelTourney(String cause)
+
+
Cancel the tourney, return entry fees to all participants. +

+

+
+
+
+
+
+
+
+ +

+isFinished

+
+public boolean isFinished()
+
+
Returns true if the tourney is finished. +

+

+
+
+
+
+
+
+
+ +

+isPending

+
+public boolean isPending()
+
+
Returns true if the tourney is pending. +

+

+
+
+
+
+
+
+
+ +

+isRunning

+
+public boolean isRunning()
+
+
Returns true if the tourney is running. +

+

+
+
+
+
+
+
+
+ +

+isPaused

+
+public boolean isPaused()
+
+
Returns true if the tourney is paused. +

+

+
+
+
+
+
+
+
+ +

+shouldStart

+
+public boolean shouldStart(long now)
+
+
Returns true if it is time or past time the tourney starts. +

+

+
+
+
+
+
+
+
+ +

+notifyAllParticipants

+
+public abstract void notifyAllParticipants(String msg)
+
+
+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/tourney/server/TourneyProvider.html b/apidocs/com/threerings/parlor/tourney/server/TourneyProvider.html new file mode 100644 index 00000000..1182cb0f --- /dev/null +++ b/apidocs/com/threerings/parlor/tourney/server/TourneyProvider.html @@ -0,0 +1,287 @@ + + + + + + + +TourneyProvider (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.tourney.server +
+Interface TourneyProvider

+
+
All Superinterfaces:
com.threerings.presents.server.InvocationProvider
+
+
+
All Known Implementing Classes:
TourneyManager
+
+
+
+
@Generated(value="com.threerings.presents.tools.GenServiceTask",
+           comments="Derived from TourneyService.java.")
+public interface TourneyProvider
extends com.threerings.presents.server.InvocationProvider
+ + +

+Defines the server-side of the TourneyService. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidcancel(com.threerings.presents.data.ClientObject caller, + com.threerings.presents.client.InvocationService.ConfirmListener arg1) + +
+          Handles a TourneyService.cancel(com.threerings.presents.client.InvocationService.ConfirmListener) request.
+ voidjoin(com.threerings.presents.data.ClientObject caller, + com.threerings.presents.client.InvocationService.ConfirmListener arg1) + +
+          Handles a TourneyService.join(com.threerings.presents.client.InvocationService.ConfirmListener) request.
+ voidleave(com.threerings.presents.data.ClientObject caller, + com.threerings.presents.client.InvocationService.ConfirmListener arg1) + +
+          Handles a TourneyService.leave(com.threerings.presents.client.InvocationService.ConfirmListener) request.
+  +

+ + + + + + + + +
+Method Detail
+ +

+cancel

+
+void cancel(com.threerings.presents.data.ClientObject caller,
+            com.threerings.presents.client.InvocationService.ConfirmListener arg1)
+            throws com.threerings.presents.server.InvocationException
+
+
Handles a TourneyService.cancel(com.threerings.presents.client.InvocationService.ConfirmListener) request. +

+

+
+
+
+ +
Throws: +
com.threerings.presents.server.InvocationException
+
+
+
+ +

+join

+
+void join(com.threerings.presents.data.ClientObject caller,
+          com.threerings.presents.client.InvocationService.ConfirmListener arg1)
+          throws com.threerings.presents.server.InvocationException
+
+
Handles a TourneyService.join(com.threerings.presents.client.InvocationService.ConfirmListener) request. +

+

+
+
+
+ +
Throws: +
com.threerings.presents.server.InvocationException
+
+
+
+ +

+leave

+
+void leave(com.threerings.presents.data.ClientObject caller,
+           com.threerings.presents.client.InvocationService.ConfirmListener arg1)
+           throws com.threerings.presents.server.InvocationException
+
+
Handles a TourneyService.leave(com.threerings.presents.client.InvocationService.ConfirmListener) request. +

+

+
+
+
+ +
Throws: +
com.threerings.presents.server.InvocationException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/tourney/server/TourniesManager.html b/apidocs/com/threerings/parlor/tourney/server/TourniesManager.html new file mode 100644 index 00000000..861ce164 --- /dev/null +++ b/apidocs/com/threerings/parlor/tourney/server/TourniesManager.html @@ -0,0 +1,296 @@ + + + + + + + +TourniesManager (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.tourney.server +
+Class TourniesManager

+
+java.lang.Object
+  extended by com.threerings.parlor.tourney.server.TourniesManager
+
+
+
All Implemented Interfaces:
Lifecycle.BaseComponent, Lifecycle.InitComponent, TourniesProvider, com.threerings.presents.server.InvocationProvider
+
+
+
+
public abstract class TourniesManager
extends Object
implements TourniesProvider, Lifecycle.InitComponent
+ + +

+An extensible tournament manager. +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
TourniesManager(Lifecycle cycle) + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ voidcreateTourney(com.threerings.presents.data.ClientObject caller, + TourneyConfig config, + com.threerings.presents.client.InvocationService.ResultListener listener) + +
+          Handles a TourniesService.createTourney(com.threerings.parlor.tourney.data.TourneyConfig, com.threerings.presents.client.InvocationService.ResultListener) request.
+ voidinit() + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+TourniesManager

+
+@Inject
+public TourniesManager(Lifecycle cycle)
+
+
+ + + + + + + + +
+Method Detail
+ +

+init

+
+public void init()
+
+
+
Specified by:
init in interface Lifecycle.InitComponent
+
+
+
+
+
+
+ +

+createTourney

+
+public void createTourney(com.threerings.presents.data.ClientObject caller,
+                          TourneyConfig config,
+                          com.threerings.presents.client.InvocationService.ResultListener listener)
+                   throws com.threerings.presents.server.InvocationException
+
+
Description copied from interface: TourniesProvider
+
Handles a TourniesService.createTourney(com.threerings.parlor.tourney.data.TourneyConfig, com.threerings.presents.client.InvocationService.ResultListener) request. +

+

+
Specified by:
createTourney in interface TourniesProvider
+
+
+ +
Throws: +
com.threerings.presents.server.InvocationException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/tourney/server/TourniesProvider.html b/apidocs/com/threerings/parlor/tourney/server/TourniesProvider.html new file mode 100644 index 00000000..7d6539e4 --- /dev/null +++ b/apidocs/com/threerings/parlor/tourney/server/TourniesProvider.html @@ -0,0 +1,231 @@ + + + + + + + +TourniesProvider (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.tourney.server +
+Interface TourniesProvider

+
+
All Superinterfaces:
com.threerings.presents.server.InvocationProvider
+
+
+
All Known Implementing Classes:
TourniesManager
+
+
+
+
@Generated(value="com.threerings.presents.tools.GenServiceTask",
+           comments="Derived from TourniesService.java.")
+public interface TourniesProvider
extends com.threerings.presents.server.InvocationProvider
+ + +

+Defines the server-side of the TourniesService. +

+ +

+

+ +

+ + + + + + + + + + + + +
+Method Summary
+ voidcreateTourney(com.threerings.presents.data.ClientObject caller, + TourneyConfig arg1, + com.threerings.presents.client.InvocationService.ResultListener arg2) + +
+          Handles a TourniesService.createTourney(com.threerings.parlor.tourney.data.TourneyConfig, com.threerings.presents.client.InvocationService.ResultListener) request.
+  +

+ + + + + + + + +
+Method Detail
+ +

+createTourney

+
+void createTourney(com.threerings.presents.data.ClientObject caller,
+                   TourneyConfig arg1,
+                   com.threerings.presents.client.InvocationService.ResultListener arg2)
+                   throws com.threerings.presents.server.InvocationException
+
+
Handles a TourniesService.createTourney(com.threerings.parlor.tourney.data.TourneyConfig, com.threerings.presents.client.InvocationService.ResultListener) request. +

+

+
+
+
+ +
Throws: +
com.threerings.presents.server.InvocationException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/tourney/server/class-use/TourneyManager.html b/apidocs/com/threerings/parlor/tourney/server/class-use/TourneyManager.html new file mode 100644 index 00000000..8360982f --- /dev/null +++ b/apidocs/com/threerings/parlor/tourney/server/class-use/TourneyManager.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.parlor.tourney.server.TourneyManager (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.tourney.server.TourneyManager

+
+No usage of com.threerings.parlor.tourney.server.TourneyManager +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/tourney/server/class-use/TourneyProvider.html b/apidocs/com/threerings/parlor/tourney/server/class-use/TourneyProvider.html new file mode 100644 index 00000000..06b951ee --- /dev/null +++ b/apidocs/com/threerings/parlor/tourney/server/class-use/TourneyProvider.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Interface com.threerings.parlor.tourney.server.TourneyProvider (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.parlor.tourney.server.TourneyProvider

+
+ + + + + + + + + +
+Packages that use TourneyProvider
com.threerings.parlor.tourney.server  
+  +

+ + + + + +
+Uses of TourneyProvider in com.threerings.parlor.tourney.server
+  +

+ + + + + + + + + +
Classes in com.threerings.parlor.tourney.server that implement TourneyProvider
+ classTourneyManager + +
+          Controls a running tourney.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/tourney/server/class-use/TourniesManager.html b/apidocs/com/threerings/parlor/tourney/server/class-use/TourniesManager.html new file mode 100644 index 00000000..6f5e1553 --- /dev/null +++ b/apidocs/com/threerings/parlor/tourney/server/class-use/TourniesManager.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.parlor.tourney.server.TourniesManager (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.tourney.server.TourniesManager

+
+No usage of com.threerings.parlor.tourney.server.TourniesManager +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/tourney/server/class-use/TourniesProvider.html b/apidocs/com/threerings/parlor/tourney/server/class-use/TourniesProvider.html new file mode 100644 index 00000000..a308b7cf --- /dev/null +++ b/apidocs/com/threerings/parlor/tourney/server/class-use/TourniesProvider.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Interface com.threerings.parlor.tourney.server.TourniesProvider (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.parlor.tourney.server.TourniesProvider

+
+ + + + + + + + + +
+Packages that use TourniesProvider
com.threerings.parlor.tourney.server  
+  +

+ + + + + +
+Uses of TourniesProvider in com.threerings.parlor.tourney.server
+  +

+ + + + + + + + + +
Classes in com.threerings.parlor.tourney.server that implement TourniesProvider
+ classTourniesManager + +
+          An extensible tournament manager.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/tourney/server/package-frame.html b/apidocs/com/threerings/parlor/tourney/server/package-frame.html new file mode 100644 index 00000000..24d5c69c --- /dev/null +++ b/apidocs/com/threerings/parlor/tourney/server/package-frame.html @@ -0,0 +1,48 @@ + + + + + + + +com.threerings.parlor.tourney.server (vilya 1.3 API) + + + + + + + + + + + +com.threerings.parlor.tourney.server + + + + +
+Interfaces  + +
+TourneyProvider +
+TourniesProvider
+ + + + + + +
+Classes  + +
+TourneyManager +
+TourniesManager
+ + + + diff --git a/apidocs/com/threerings/parlor/tourney/server/package-summary.html b/apidocs/com/threerings/parlor/tourney/server/package-summary.html new file mode 100644 index 00000000..576e725c --- /dev/null +++ b/apidocs/com/threerings/parlor/tourney/server/package-summary.html @@ -0,0 +1,180 @@ + + + + + + + +com.threerings.parlor.tourney.server (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.parlor.tourney.server +

+ + + + + + + + + + + + + +
+Interface Summary
TourneyProviderDefines the server-side of the TourneyService.
TourniesProviderDefines the server-side of the TourniesService.
+  + +

+ + + + + + + + + + + + + +
+Class Summary
TourneyManagerControls a running tourney.
TourniesManagerAn extensible tournament manager.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/tourney/server/package-tree.html b/apidocs/com/threerings/parlor/tourney/server/package-tree.html new file mode 100644 index 00000000..de65f147 --- /dev/null +++ b/apidocs/com/threerings/parlor/tourney/server/package-tree.html @@ -0,0 +1,163 @@ + + + + + + + +com.threerings.parlor.tourney.server Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.parlor.tourney.server +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/tourney/server/package-use.html b/apidocs/com/threerings/parlor/tourney/server/package-use.html new file mode 100644 index 00000000..e45ead2a --- /dev/null +++ b/apidocs/com/threerings/parlor/tourney/server/package-use.html @@ -0,0 +1,177 @@ + + + + + + + +Uses of Package com.threerings.parlor.tourney.server (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.parlor.tourney.server

+
+ + + + + + + + + +
+Packages that use com.threerings.parlor.tourney.server
com.threerings.parlor.tourney.server  
+  +

+ + + + + + + + + + + +
+Classes in com.threerings.parlor.tourney.server used by com.threerings.parlor.tourney.server
TourneyProvider + +
+          Defines the server-side of the TourneyService.
TourniesProvider + +
+          Defines the server-side of the TourniesService.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/tourney/server/persist/TourneyRepository.TourneyRecord.html b/apidocs/com/threerings/parlor/tourney/server/persist/TourneyRepository.TourneyRecord.html new file mode 100644 index 00000000..b6821304 --- /dev/null +++ b/apidocs/com/threerings/parlor/tourney/server/persist/TourneyRepository.TourneyRecord.html @@ -0,0 +1,346 @@ + + + + + + + +TourneyRepository.TourneyRecord (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.tourney.server.persist +
+Class TourneyRepository.TourneyRecord

+
+java.lang.Object
+  extended by com.threerings.parlor.tourney.server.persist.TourneyRepository.TourneyRecord
+
+
+
Enclosing class:
TourneyRepository
+
+
+
+
public static class TourneyRepository.TourneyRecord
extends Object
+ + +

+Contains tourney information loaded from the database. +

+ +

+

+ +

+ + + + + + + + + + + + + + + +
+Field Summary
+ byte[]config + +
+          The tourney configuration.
+ inttourneyId + +
+          The tourney's unique identifier.
+  + + + + + + + + + + + + + + + + +
+Constructor Summary
TourneyRepository.TourneyRecord() + +
+           
TourneyRepository.TourneyRecord(int tourneyId) + +
+           
TourneyRepository.TourneyRecord(TourneyConfig tourneyConfig) + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ TourneyConfiggetTourneyConfig() + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+tourneyId

+
+public int tourneyId
+
+
The tourney's unique identifier. +

+

+
+
+
+ +

+config

+
+public byte[] config
+
+
The tourney configuration. +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+TourneyRepository.TourneyRecord

+
+public TourneyRepository.TourneyRecord()
+
+
+
+ +

+TourneyRepository.TourneyRecord

+
+public TourneyRepository.TourneyRecord(int tourneyId)
+
+
+
+ +

+TourneyRepository.TourneyRecord

+
+public TourneyRepository.TourneyRecord(TourneyConfig tourneyConfig)
+
+
+ + + + + + + + +
+Method Detail
+ +

+getTourneyConfig

+
+public TourneyConfig getTourneyConfig()
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/tourney/server/persist/TourneyRepository.html b/apidocs/com/threerings/parlor/tourney/server/persist/TourneyRepository.html new file mode 100644 index 00000000..2075247c --- /dev/null +++ b/apidocs/com/threerings/parlor/tourney/server/persist/TourneyRepository.html @@ -0,0 +1,423 @@ + + + + + + + +TourneyRepository (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.tourney.server.persist +
+Class TourneyRepository

+
+java.lang.Object
+  extended by com.samskivert.jdbc.Repository
+      extended by com.samskivert.jdbc.SimpleRepository
+          extended by com.samskivert.jdbc.JORARepository
+              extended by com.threerings.parlor.tourney.server.persist.TourneyRepository
+
+
+
+
public class TourneyRepository
extends JORARepository
+ + +

+The persistent store for tourney related information. +

+ +

+

+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static classTourneyRepository.TourneyRecord + +
+          Contains tourney information loaded from the database.
+  + + + + + + + +
Nested classes/interfaces inherited from class com.samskivert.jdbc.SimpleRepository
SimpleRepository.PreCondition
+  + + + + + + + + +
Nested classes/interfaces inherited from class com.samskivert.jdbc.Repository
Repository.Operation<V>
+  + + + + + + + + + + + +
+Field Summary
+static StringTOURNEY_DB_IDENT + +
+          The database identifier used when establishing a database connection.
+  + + + + + + + + + + +
+Constructor Summary
TourneyRepository(ConnectionProvider conprov) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voiddeleteTourney(int tourneyId) + +
+          Deletes a tourney from the repository.
+ voidinsertTourney(TourneyConfig tourney) + +
+          Inserts a new tourney into the repository, assigning a unique id to the tourney.
+ ArrayList<TourneyConfig>loadTournies() + +
+          Loads all the tourney configs from the repository.
+ voidupdateTourney(TourneyConfig tourney) + +
+          Updates the tourney in the repository.
+  + + + + + + + +
Methods inherited from class com.samskivert.jdbc.SimpleRepository
setExecutePreCondition
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+TOURNEY_DB_IDENT

+
+public static final String TOURNEY_DB_IDENT
+
+
The database identifier used when establishing a database connection. This value being + tourneydb. +

+

+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Constructor Detail
+ +

+TourneyRepository

+
+@Inject
+public TourneyRepository(ConnectionProvider conprov)
+
+
+ + + + + + + + +
+Method Detail
+ +

+insertTourney

+
+public void insertTourney(TourneyConfig tourney)
+                   throws PersistenceException
+
+
Inserts a new tourney into the repository, assigning a unique id to the tourney. +

+

+ +
Throws: +
PersistenceException
+
+
+
+ +

+updateTourney

+
+public void updateTourney(TourneyConfig tourney)
+                   throws PersistenceException
+
+
Updates the tourney in the repository. +

+

+ +
Throws: +
PersistenceException
+
+
+
+ +

+deleteTourney

+
+public void deleteTourney(int tourneyId)
+                   throws PersistenceException
+
+
Deletes a tourney from the repository. +

+

+ +
Throws: +
PersistenceException
+
+
+
+ +

+loadTournies

+
+public ArrayList<TourneyConfig> loadTournies()
+                                      throws PersistenceException
+
+
Loads all the tourney configs from the repository. +

+

+ +
Throws: +
PersistenceException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/tourney/server/persist/class-use/TourneyRepository.TourneyRecord.html b/apidocs/com/threerings/parlor/tourney/server/persist/class-use/TourneyRepository.TourneyRecord.html new file mode 100644 index 00000000..ee697864 --- /dev/null +++ b/apidocs/com/threerings/parlor/tourney/server/persist/class-use/TourneyRepository.TourneyRecord.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.parlor.tourney.server.persist.TourneyRepository.TourneyRecord (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.tourney.server.persist.TourneyRepository.TourneyRecord

+
+No usage of com.threerings.parlor.tourney.server.persist.TourneyRepository.TourneyRecord +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/tourney/server/persist/class-use/TourneyRepository.html b/apidocs/com/threerings/parlor/tourney/server/persist/class-use/TourneyRepository.html new file mode 100644 index 00000000..e514febc --- /dev/null +++ b/apidocs/com/threerings/parlor/tourney/server/persist/class-use/TourneyRepository.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.parlor.tourney.server.persist.TourneyRepository (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.tourney.server.persist.TourneyRepository

+
+No usage of com.threerings.parlor.tourney.server.persist.TourneyRepository +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/tourney/server/persist/package-frame.html b/apidocs/com/threerings/parlor/tourney/server/persist/package-frame.html new file mode 100644 index 00000000..faba874c --- /dev/null +++ b/apidocs/com/threerings/parlor/tourney/server/persist/package-frame.html @@ -0,0 +1,35 @@ + + + + + + + +com.threerings.parlor.tourney.server.persist (vilya 1.3 API) + + + + + + + + + + + +com.threerings.parlor.tourney.server.persist + + + + +
+Classes  + +
+TourneyRepository +
+TourneyRepository.TourneyRecord
+ + + + diff --git a/apidocs/com/threerings/parlor/tourney/server/persist/package-summary.html b/apidocs/com/threerings/parlor/tourney/server/persist/package-summary.html new file mode 100644 index 00000000..e943afe2 --- /dev/null +++ b/apidocs/com/threerings/parlor/tourney/server/persist/package-summary.html @@ -0,0 +1,162 @@ + + + + + + + +com.threerings.parlor.tourney.server.persist (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.parlor.tourney.server.persist +

+ + + + + + + + + + + + + +
+Class Summary
TourneyRepositoryThe persistent store for tourney related information.
TourneyRepository.TourneyRecordContains tourney information loaded from the database.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/tourney/server/persist/package-tree.html b/apidocs/com/threerings/parlor/tourney/server/persist/package-tree.html new file mode 100644 index 00000000..809533c8 --- /dev/null +++ b/apidocs/com/threerings/parlor/tourney/server/persist/package-tree.html @@ -0,0 +1,160 @@ + + + + + + + +com.threerings.parlor.tourney.server.persist Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.parlor.tourney.server.persist +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/tourney/server/persist/package-use.html b/apidocs/com/threerings/parlor/tourney/server/persist/package-use.html new file mode 100644 index 00000000..e27f0bd5 --- /dev/null +++ b/apidocs/com/threerings/parlor/tourney/server/persist/package-use.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Package com.threerings.parlor.tourney.server.persist (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.parlor.tourney.server.persist

+
+No usage of com.threerings.parlor.tourney.server.persist +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/turn/client/TurnDisplay.html b/apidocs/com/threerings/parlor/turn/client/TurnDisplay.html new file mode 100644 index 00000000..62d35dc8 --- /dev/null +++ b/apidocs/com/threerings/parlor/turn/client/TurnDisplay.html @@ -0,0 +1,555 @@ + + + + + + + +TurnDisplay (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.turn.client +
+Class TurnDisplay

+
+java.lang.Object
+  extended by java.awt.Component
+      extended by java.awt.Container
+          extended by javax.swing.JComponent
+              extended by javax.swing.JPanel
+                  extended by com.threerings.parlor.turn.client.TurnDisplay
+
+
+
All Implemented Interfaces:
com.threerings.crowd.client.PlaceView, com.threerings.presents.dobj.AttributeChangeListener, com.threerings.presents.dobj.ChangeListener, com.threerings.presents.dobj.ElementUpdateListener, ImageObserver, MenuContainer, Serializable, Accessible
+
+
+
+
public class TurnDisplay
extends JPanel
implements com.threerings.crowd.client.PlaceView, com.threerings.presents.dobj.AttributeChangeListener, com.threerings.presents.dobj.ElementUpdateListener
+ + +

+Automatically display a list of players and turn change information + in a turn-based game. +

+ +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent
+  + + + + + + + + +
Nested classes/interfaces inherited from class java.awt.Component
Component.BaselineResizeBehavior
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class javax.swing.JComponent
TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
+  + + + + + + + +
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
+  + + + + + + + +
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
+  + + + + + + + + + + + + + +
+Constructor Summary
TurnDisplay() + +
+          Create a TurnDisplay.
TurnDisplay(Icon turnIcon) + +
+          Create a TurnDisplay for a game using the specified Icon to denote + whose turn it is.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidattributeChanged(com.threerings.presents.dobj.AttributeChangedEvent event) + +
+           
+ voiddidLeavePlace(com.threerings.crowd.data.PlaceObject plobj) + +
+           
+ voidelementUpdated(com.threerings.presents.dobj.ElementUpdatedEvent event) + +
+           
+ voidsetDrawText(String drawText) + +
+          Sets the text to be displayed next to everyone's name in the event of a + draw.
+ voidsetPlayerIcons(Icon[] icons) + +
+          Set optional icons to use for identifying each player in the game.
+ voidsetTurnIcon(Icon turnIcon) + +
+          Set the icon to use.
+ voidsetWinnerText(String winnerText) + +
+          Set the text to be displayed next to the winner's name.
+ voidwillEnterPlace(com.threerings.crowd.data.PlaceObject plobj) + +
+           
+  + + + + + + + +
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, setUI, updateUI
+  + + + + + + + +
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
+  + + + + + + + +
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate
+  + + + + + + + +
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+TurnDisplay

+
+public TurnDisplay()
+
+
Create a TurnDisplay. +

+

+
+ +

+TurnDisplay

+
+public TurnDisplay(Icon turnIcon)
+
+
Create a TurnDisplay for a game using the specified Icon to denote + whose turn it is. +

+

+ + + + + + + + +
+Method Detail
+ +

+setTurnIcon

+
+public void setTurnIcon(Icon turnIcon)
+
+
Set the icon to use. +

+

+
+
+
+
+
+
+
+ +

+setWinnerText

+
+public void setWinnerText(String winnerText)
+
+
Set the text to be displayed next to the winner's name. +

+

+
+
+
+
+
+
+
+ +

+setDrawText

+
+public void setDrawText(String drawText)
+
+
Sets the text to be displayed next to everyone's name in the event of a + draw. +

+

+
+
+
+
+
+
+
+ +

+setPlayerIcons

+
+public void setPlayerIcons(Icon[] icons)
+
+
Set optional icons to use for identifying each player in the game. +

+

+
+
+
+
+
+
+
+ +

+willEnterPlace

+
+public void willEnterPlace(com.threerings.crowd.data.PlaceObject plobj)
+
+
+
Specified by:
willEnterPlace in interface com.threerings.crowd.client.PlaceView
+
+
+
+
+
+
+ +

+didLeavePlace

+
+public void didLeavePlace(com.threerings.crowd.data.PlaceObject plobj)
+
+
+
Specified by:
didLeavePlace in interface com.threerings.crowd.client.PlaceView
+
+
+
+
+
+
+ +

+attributeChanged

+
+public void attributeChanged(com.threerings.presents.dobj.AttributeChangedEvent event)
+
+
+
Specified by:
attributeChanged in interface com.threerings.presents.dobj.AttributeChangeListener
+
+
+
+
+
+
+ +

+elementUpdated

+
+public void elementUpdated(com.threerings.presents.dobj.ElementUpdatedEvent event)
+
+
+
Specified by:
elementUpdated in interface com.threerings.presents.dobj.ElementUpdateListener
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/turn/client/TurnGameController.html b/apidocs/com/threerings/parlor/turn/client/TurnGameController.html new file mode 100644 index 00000000..3f547742 --- /dev/null +++ b/apidocs/com/threerings/parlor/turn/client/TurnGameController.html @@ -0,0 +1,219 @@ + + + + + + + +TurnGameController (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.turn.client +
+Interface TurnGameController

+
+
All Known Implementing Classes:
CardGameController
+
+
+
+
public interface TurnGameController
+ + +

+Games that wish to make use of the turn game services should have their + controller implement this interface and create an instance of TurnGameControllerDelegate which should be passed to PlaceController.addDelegate(com.threerings.crowd.client.PlaceControllerDelegate). +

+ +

+

+ +

+ + + + + + + + + + + + +
+Method Summary
+ voidturnDidChange(com.threerings.util.Name turnHolder) + +
+          Called when the turn changed.
+  +

+ + + + + + + + +
+Method Detail
+ +

+turnDidChange

+
+void turnDidChange(com.threerings.util.Name turnHolder)
+
+
Called when the turn changed. This indicates the start of a turn + and the user interface should adjust itself accordingly (activating + controls if it is our turn and deactivating them if it is not). +

+

+
Parameters:
turnHolder - the username of the new holder of the turn.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/turn/client/TurnGameControllerDelegate.html b/apidocs/com/threerings/parlor/turn/client/TurnGameControllerDelegate.html new file mode 100644 index 00000000..9bb8c07a --- /dev/null +++ b/apidocs/com/threerings/parlor/turn/client/TurnGameControllerDelegate.html @@ -0,0 +1,417 @@ + + + + + + + +TurnGameControllerDelegate (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.turn.client +
+Class TurnGameControllerDelegate

+
+java.lang.Object
+  extended by com.threerings.crowd.client.PlaceControllerDelegate
+      extended by com.threerings.parlor.game.client.GameControllerDelegate
+          extended by com.threerings.parlor.turn.client.TurnGameControllerDelegate
+
+
+
All Implemented Interfaces:
com.threerings.presents.dobj.AttributeChangeListener, com.threerings.presents.dobj.ChangeListener
+
+
+
Direct Known Subclasses:
TrickCardGameControllerDelegate
+
+
+
+
public class TurnGameControllerDelegate
extends GameControllerDelegate
implements com.threerings.presents.dobj.AttributeChangeListener
+ + +

+Performs the client-side processing for a turn-based game. Games which + wish to make use of these services must construct a delegate and call + out to it at the appropriate times (see the method documentation for + which methods should be called when). The game's controller must also + implement the TurnGameController interface so that it can be + notified when turn-based game events take place. +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
TurnGameControllerDelegate(TurnGameController tgctrl) + +
+          Constructs a delegate which will call back to the supplied TurnGameController implementation wen turn-based game related + things happen.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidattributeChanged(com.threerings.presents.dobj.AttributeChangedEvent event) + +
+           
+ voiddidLeavePlace(com.threerings.crowd.data.PlaceObject plobj) + +
+           
+ intgetTurnHolderIndex() + +
+          Returns the index of the current turn holder as configured in the + game object.
+ voidinit(com.threerings.crowd.util.CrowdContext ctx, + com.threerings.crowd.data.PlaceConfig config) + +
+           
+ booleanisOurTurn() + +
+          Returns true if the game is in progress and it is our turn; false + otherwise.
+ voidwillEnterPlace(com.threerings.crowd.data.PlaceObject plobj) + +
+           
+  + + + + + + + +
Methods inherited from class com.threerings.parlor.game.client.GameControllerDelegate
gameDidEnd, gameDidStart, gameWasCancelled, gameWillReset
+  + + + + + + + +
Methods inherited from class com.threerings.crowd.client.PlaceControllerDelegate
handleAction, mayLeavePlace
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+TurnGameControllerDelegate

+
+public TurnGameControllerDelegate(TurnGameController tgctrl)
+
+
Constructs a delegate which will call back to the supplied TurnGameController implementation wen turn-based game related + things happen. +

+

+ + + + + + + + +
+Method Detail
+ +

+isOurTurn

+
+public boolean isOurTurn()
+
+
Returns true if the game is in progress and it is our turn; false + otherwise. +

+

+
+
+
+
+
+
+
+ +

+getTurnHolderIndex

+
+public int getTurnHolderIndex()
+
+
Returns the index of the current turn holder as configured in the + game object. +

+

+
+
+
+ +
Returns:
the index into the players array of the current turn holder + or -1 if there is no current turn holder.
+
+
+
+ +

+init

+
+public void init(com.threerings.crowd.util.CrowdContext ctx,
+                 com.threerings.crowd.data.PlaceConfig config)
+
+
+
Overrides:
init in class com.threerings.crowd.client.PlaceControllerDelegate
+
+
+
+
+
+
+ +

+willEnterPlace

+
+public void willEnterPlace(com.threerings.crowd.data.PlaceObject plobj)
+
+
+
Overrides:
willEnterPlace in class com.threerings.crowd.client.PlaceControllerDelegate
+
+
+
+
+
+
+ +

+didLeavePlace

+
+public void didLeavePlace(com.threerings.crowd.data.PlaceObject plobj)
+
+
+
Overrides:
didLeavePlace in class com.threerings.crowd.client.PlaceControllerDelegate
+
+
+
+
+
+
+ +

+attributeChanged

+
+public void attributeChanged(com.threerings.presents.dobj.AttributeChangedEvent event)
+
+
+
Specified by:
attributeChanged in interface com.threerings.presents.dobj.AttributeChangeListener
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/turn/client/class-use/TurnDisplay.html b/apidocs/com/threerings/parlor/turn/client/class-use/TurnDisplay.html new file mode 100644 index 00000000..d9a6b536 --- /dev/null +++ b/apidocs/com/threerings/parlor/turn/client/class-use/TurnDisplay.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.parlor.turn.client.TurnDisplay (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.turn.client.TurnDisplay

+
+No usage of com.threerings.parlor.turn.client.TurnDisplay +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/turn/client/class-use/TurnGameController.html b/apidocs/com/threerings/parlor/turn/client/class-use/TurnGameController.html new file mode 100644 index 00000000..f5127f09 --- /dev/null +++ b/apidocs/com/threerings/parlor/turn/client/class-use/TurnGameController.html @@ -0,0 +1,209 @@ + + + + + + + +Uses of Interface com.threerings.parlor.turn.client.TurnGameController (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.parlor.turn.client.TurnGameController

+
+ + + + + + + + + + + + + +
+Packages that use TurnGameController
com.threerings.parlor.card.client  
com.threerings.parlor.turn.client  
+  +

+ + + + + +
+Uses of TurnGameController in com.threerings.parlor.card.client
+  +

+ + + + + + + + + +
Classes in com.threerings.parlor.card.client that implement TurnGameController
+ classCardGameController + +
+          A controller class for card games.
+  +

+ + + + + +
+Uses of TurnGameController in com.threerings.parlor.turn.client
+  +

+ + + + + + + + +
Constructors in com.threerings.parlor.turn.client with parameters of type TurnGameController
TurnGameControllerDelegate(TurnGameController tgctrl) + +
+          Constructs a delegate which will call back to the supplied TurnGameController implementation wen turn-based game related + things happen.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/turn/client/class-use/TurnGameControllerDelegate.html b/apidocs/com/threerings/parlor/turn/client/class-use/TurnGameControllerDelegate.html new file mode 100644 index 00000000..1db58690 --- /dev/null +++ b/apidocs/com/threerings/parlor/turn/client/class-use/TurnGameControllerDelegate.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class com.threerings.parlor.turn.client.TurnGameControllerDelegate (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.turn.client.TurnGameControllerDelegate

+
+ + + + + + + + + +
+Packages that use TurnGameControllerDelegate
com.threerings.parlor.card.trick.client  
+  +

+ + + + + +
+Uses of TurnGameControllerDelegate in com.threerings.parlor.card.trick.client
+  +

+ + + + + + + + + +
Subclasses of TurnGameControllerDelegate in com.threerings.parlor.card.trick.client
+ classTrickCardGameControllerDelegate + +
+          A card game controller delegate for trick-based card games, such as Spades and Hearts.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/turn/client/package-frame.html b/apidocs/com/threerings/parlor/turn/client/package-frame.html new file mode 100644 index 00000000..f46c7b43 --- /dev/null +++ b/apidocs/com/threerings/parlor/turn/client/package-frame.html @@ -0,0 +1,46 @@ + + + + + + + +com.threerings.parlor.turn.client (vilya 1.3 API) + + + + + + + + + + + +com.threerings.parlor.turn.client + + + + +
+Interfaces  + +
+TurnGameController
+ + + + + + +
+Classes  + +
+TurnDisplay +
+TurnGameControllerDelegate
+ + + + diff --git a/apidocs/com/threerings/parlor/turn/client/package-summary.html b/apidocs/com/threerings/parlor/turn/client/package-summary.html new file mode 100644 index 00000000..18cd5fbb --- /dev/null +++ b/apidocs/com/threerings/parlor/turn/client/package-summary.html @@ -0,0 +1,178 @@ + + + + + + + +com.threerings.parlor.turn.client (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.parlor.turn.client +

+ + + + + + + + + +
+Interface Summary
TurnGameControllerGames that wish to make use of the turn game services should have their + controller implement this interface and create an instance of TurnGameControllerDelegate which should be passed to PlaceController.addDelegate(com.threerings.crowd.client.PlaceControllerDelegate).
+  + +

+ + + + + + + + + + + + + +
+Class Summary
TurnDisplayAutomatically display a list of players and turn change information + in a turn-based game.
TurnGameControllerDelegatePerforms the client-side processing for a turn-based game.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/turn/client/package-tree.html b/apidocs/com/threerings/parlor/turn/client/package-tree.html new file mode 100644 index 00000000..155158c1 --- /dev/null +++ b/apidocs/com/threerings/parlor/turn/client/package-tree.html @@ -0,0 +1,176 @@ + + + + + + + +com.threerings.parlor.turn.client Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.parlor.turn.client +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/turn/client/package-use.html b/apidocs/com/threerings/parlor/turn/client/package-use.html new file mode 100644 index 00000000..fcfc1717 --- /dev/null +++ b/apidocs/com/threerings/parlor/turn/client/package-use.html @@ -0,0 +1,211 @@ + + + + + + + +Uses of Package com.threerings.parlor.turn.client (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.parlor.turn.client

+
+ + + + + + + + + + + + + + + + + +
+Packages that use com.threerings.parlor.turn.client
com.threerings.parlor.card.client  
com.threerings.parlor.card.trick.client  
com.threerings.parlor.turn.client  
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.turn.client used by com.threerings.parlor.card.client
TurnGameController + +
+          Games that wish to make use of the turn game services should have their + controller implement this interface and create an instance of TurnGameControllerDelegate which should be passed to PlaceController.addDelegate(com.threerings.crowd.client.PlaceControllerDelegate).
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.turn.client used by com.threerings.parlor.card.trick.client
TurnGameControllerDelegate + +
+          Performs the client-side processing for a turn-based game.
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.turn.client used by com.threerings.parlor.turn.client
TurnGameController + +
+          Games that wish to make use of the turn game services should have their + controller implement this interface and create an instance of TurnGameControllerDelegate which should be passed to PlaceController.addDelegate(com.threerings.crowd.client.PlaceControllerDelegate).
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/turn/data/TurnGameObject.html b/apidocs/com/threerings/parlor/turn/data/TurnGameObject.html new file mode 100644 index 00000000..dc3cb956 --- /dev/null +++ b/apidocs/com/threerings/parlor/turn/data/TurnGameObject.html @@ -0,0 +1,354 @@ + + + + + + + +TurnGameObject (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.turn.data +
+Interface TurnGameObject

+
+
All Known Subinterfaces:
TrickCardGameObject
+
+
+
+
public interface TurnGameObject
+ + +

+Games that wish to support turn-based play must implement this + interface with their GameObject. +

+ +

+

+ +

+ + + + + + + + + + + +
+Field Summary
+static com.threerings.util.NameTURN_HOLDER_REPLACED + +
+          A special value used to communicate to the client that the current + turn holder was replaced (perhaps due to disconnection or departure + and being replaced by an AI).
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ com.threerings.util.Name[]getPlayers() + +
+          Returns the array of player names involved in the game.
+ com.threerings.util.NamegetTurnHolder() + +
+          Returns the username of the player who is currently taking their + turn in this turn-based game or null if no user + currently holds the turn.
+ StringgetTurnHolderFieldName() + +
+          Returns the distributed object field name of the + turnHolder field in the object that implements this + interface.
+ booleanisInPlay() + +
+          Returns true if the game is in play, false if not.
+ voidsetTurnHolder(com.threerings.util.Name turnHolder) + +
+          Requests that the turnHolder field be set to the specified + value.
+  +

+ + + + + + + + +
+Field Detail
+ +

+TURN_HOLDER_REPLACED

+
+static final com.threerings.util.Name TURN_HOLDER_REPLACED
+
+
A special value used to communicate to the client that the current + turn holder was replaced (perhaps due to disconnection or departure + and being replaced by an AI). +

+

+
+
+ + + + + + + + +
+Method Detail
+ +

+getTurnHolderFieldName

+
+String getTurnHolderFieldName()
+
+
Returns the distributed object field name of the + turnHolder field in the object that implements this + interface. +

+

+
+
+
+
+ +

+getTurnHolder

+
+com.threerings.util.Name getTurnHolder()
+
+
Returns the username of the player who is currently taking their + turn in this turn-based game or null if no user + currently holds the turn. +

+

+
+
+
+
+ +

+setTurnHolder

+
+void setTurnHolder(com.threerings.util.Name turnHolder)
+
+
Requests that the turnHolder field be set to the specified + value. +

+

+
+
+
+
+ +

+getPlayers

+
+com.threerings.util.Name[] getPlayers()
+
+
Returns the array of player names involved in the game. +

+

+
+
+
+
+ +

+isInPlay

+
+boolean isInPlay()
+
+
Returns true if the game is in play, false if not. If a game is not in + play after a turn has ended, the next turn will not be started. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/turn/data/class-use/TurnGameObject.html b/apidocs/com/threerings/parlor/turn/data/class-use/TurnGameObject.html new file mode 100644 index 00000000..06a7cd85 --- /dev/null +++ b/apidocs/com/threerings/parlor/turn/data/class-use/TurnGameObject.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Interface com.threerings.parlor.turn.data.TurnGameObject (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.parlor.turn.data.TurnGameObject

+
+ + + + + + + + + +
+Packages that use TurnGameObject
com.threerings.parlor.card.trick.data  
+  +

+ + + + + +
+Uses of TurnGameObject in com.threerings.parlor.card.trick.data
+  +

+ + + + + + + + + +
Subinterfaces of TurnGameObject in com.threerings.parlor.card.trick.data
+ interfaceTrickCardGameObject + +
+          Game objects for trick-based card games must implement this interface.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/turn/data/package-frame.html b/apidocs/com/threerings/parlor/turn/data/package-frame.html new file mode 100644 index 00000000..b7ca8eaf --- /dev/null +++ b/apidocs/com/threerings/parlor/turn/data/package-frame.html @@ -0,0 +1,33 @@ + + + + + + + +com.threerings.parlor.turn.data (vilya 1.3 API) + + + + + + + + + + + +com.threerings.parlor.turn.data + + + + +
+Interfaces  + +
+TurnGameObject
+ + + + diff --git a/apidocs/com/threerings/parlor/turn/data/package-summary.html b/apidocs/com/threerings/parlor/turn/data/package-summary.html new file mode 100644 index 00000000..9d5f99eb --- /dev/null +++ b/apidocs/com/threerings/parlor/turn/data/package-summary.html @@ -0,0 +1,159 @@ + + + + + + + +com.threerings.parlor.turn.data (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.parlor.turn.data +

+ + + + + + + + + +
+Interface Summary
TurnGameObjectGames that wish to support turn-based play must implement this + interface with their GameObject.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/turn/data/package-tree.html b/apidocs/com/threerings/parlor/turn/data/package-tree.html new file mode 100644 index 00000000..00e3dc14 --- /dev/null +++ b/apidocs/com/threerings/parlor/turn/data/package-tree.html @@ -0,0 +1,152 @@ + + + + + + + +com.threerings.parlor.turn.data Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.parlor.turn.data +

+
+
+
Package Hierarchies:
All Packages
+
+

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/turn/data/package-use.html b/apidocs/com/threerings/parlor/turn/data/package-use.html new file mode 100644 index 00000000..02aac896 --- /dev/null +++ b/apidocs/com/threerings/parlor/turn/data/package-use.html @@ -0,0 +1,172 @@ + + + + + + + +Uses of Package com.threerings.parlor.turn.data (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.parlor.turn.data

+
+ + + + + + + + + +
+Packages that use com.threerings.parlor.turn.data
com.threerings.parlor.card.trick.data  
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.turn.data used by com.threerings.parlor.card.trick.data
TurnGameObject + +
+          Games that wish to support turn-based play must implement this + interface with their GameObject.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/turn/server/TurnGameManager.html b/apidocs/com/threerings/parlor/turn/server/TurnGameManager.html new file mode 100644 index 00000000..e7f8099b --- /dev/null +++ b/apidocs/com/threerings/parlor/turn/server/TurnGameManager.html @@ -0,0 +1,371 @@ + + + + + + + +TurnGameManager (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.turn.server +
+Interface TurnGameManager

+
+
All Known Implementing Classes:
CardGameManager
+
+
+
+
public interface TurnGameManager
+ + +

+A game manager that wishes to make use of the turn game services should + implement this interface and create a TurnGameManagerDelegate + which will perform the basic turn game processing and call back to the + main manager via this interface. + +

The basic flow of a turn-based game is as follows: + 

+ GameManager.gameWillStart()
+ GameManager.gameDidStart()
+   TurnGameManagerDelegate.setFirstTurnHolder()
+   TurnGameManagerDelegate.startTurn()
+     TurnGameManager.turnWillStart()
+   TurnGameManagerDelegate.endTurn()
+     TurnGameManager.turnDidEnd()
+   TurnGameManagerDelegate.setNextTurnHolder()
+   TurnGameManagerDelegate.startTurn()
+     ...
+ GameManager.endGame()
+
+

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ intgetPlayerCount() + +
+          Extending GameManager should automatically handle + implementing this method.
+ intgetPlayerIndex(com.threerings.util.Name username) + +
+          Extending GameManager should automatically handle + implementing this method.
+ com.threerings.util.NamegetPlayerName(int index) + +
+          Extending GameManager should automatically handle + implementing this method.
+ booleanisActivePlayer(int pidx) + +
+          Extending GameManager should automatically handle + implementing this method.
+ voidturnDidEnd() + +
+          Called when the turn was ended.
+ voidturnDidStart() + +
+          Called when we have started the next turn.
+ voidturnWillStart() + +
+          Called when we are about to start the next turn.
+  +

+ + + + + + + + +
+Method Detail
+ +

+getPlayerName

+
+com.threerings.util.Name getPlayerName(int index)
+
+
Extending GameManager should automatically handle + implementing this method. +

+

+
+
+
+
+ +

+getPlayerIndex

+
+int getPlayerIndex(com.threerings.util.Name username)
+
+
Extending GameManager should automatically handle + implementing this method. +

+

+
+
+
+
+ +

+getPlayerCount

+
+int getPlayerCount()
+
+
Extending GameManager should automatically handle + implementing this method. +

+

+
+
+
+
+ +

+isActivePlayer

+
+boolean isActivePlayer(int pidx)
+
+
Extending GameManager should automatically handle + implementing this method. +

+

+
+
+
+
+ +

+turnWillStart

+
+void turnWillStart()
+
+
Called when we are about to start the next turn. Implementations + can do whatever pre-start turn activities need to be done. +

+

+
+
+
+
+ +

+turnDidStart

+
+void turnDidStart()
+
+
Called when we have started the next turn. Implementations can do + whatever post-start turn activities need to be done. +

+

+
+
+
+
+ +

+turnDidEnd

+
+void turnDidEnd()
+
+
Called when the turn was ended. Implementations can perform any + post-turn processing (like updating scores, etc.). +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/turn/server/TurnGameManagerDelegate.html b/apidocs/com/threerings/parlor/turn/server/TurnGameManagerDelegate.html new file mode 100644 index 00000000..ae2579c2 --- /dev/null +++ b/apidocs/com/threerings/parlor/turn/server/TurnGameManagerDelegate.html @@ -0,0 +1,487 @@ + + + + + + + +TurnGameManagerDelegate (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.turn.server +
+Class TurnGameManagerDelegate

+
+java.lang.Object
+  extended by com.threerings.crowd.server.PlaceManagerDelegate
+      extended by com.threerings.parlor.server.PlayManagerDelegate
+          extended by com.threerings.parlor.game.server.GameManagerDelegate
+              extended by com.threerings.parlor.turn.server.TurnGameManagerDelegate
+
+
+
Direct Known Subclasses:
TrickCardGameManagerDelegate
+
+
+
+
public class TurnGameManagerDelegate
extends GameManagerDelegate
+ + +

+Performs the server-side turn-based game processing for a turn based game. Game managers which + wish to make use of the turn services must implement TurnGameManager and either create + an instance of this class, or an instance of a derivation which customizes the behavior, either + of which would be passed to PlaceManager.addDelegate(com.threerings.crowd.server.PlaceManagerDelegate) to be activated. +

+ +

+

+ +

+ + + + + + + + + + + + + + +
+Constructor Summary
TurnGameManagerDelegate() + +
+           
TurnGameManagerDelegate(TurnGameManager tgmgr) + +
+          Deprecated. use the zero-argument constructor.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voiddidInit(com.threerings.crowd.data.PlaceConfig config) + +
+           
+ voiddidStartup(com.threerings.crowd.data.PlaceObject plobj) + +
+           
+ voidendTurn() + +
+          Called to end the turn.
+ voidgameDidStart() + +
+          This should be called from GameManager.gameDidStart() to let the turn delegate perform + start of game processing.
+ intgetTurnHolderIndex() + +
+          Returns the index of the current turn holder as configured in the game object.
+ booleanisPlayersTurn(int playerIndex) + +
+          Test if it's the inputted player's turn.
+ voidplayerWasReplaced(int pidx, + com.threerings.util.Name oplayer, + com.threerings.util.Name nplayer) + +
+          Called when a player in the game has been replaced by a call to GameManager.replacePlayer(int, com.threerings.util.Name).
+ voidstartTurn() + +
+          Called to start the next turn.
+  + + + + + + + +
Methods inherited from class com.threerings.parlor.game.server.GameManagerDelegate
gameDidEnd, gameWillEnd, gameWillReset, gameWillStart, setAI, tickAI
+  + + + + + + + +
Methods inherited from class com.threerings.crowd.server.PlaceManagerDelegate
bodyEntered, bodyLeft, bodyUpdated, didShutdown, init, placeBecameEmpty, where
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+TurnGameManagerDelegate

+
+public TurnGameManagerDelegate()
+
+
+
+ +

+TurnGameManagerDelegate

+
+@Deprecated
+public TurnGameManagerDelegate(TurnGameManager tgmgr)
+
+
Deprecated. use the zero-argument constructor. +

+

+ + + + + + + + +
+Method Detail
+ +

+getTurnHolderIndex

+
+public int getTurnHolderIndex()
+
+
Returns the index of the current turn holder as configured in the game object. +

+

+ +
Returns:
the index into the players array of the current turn holder or -1 if + there is no current turn holder.
+
+
+
+ +

+isPlayersTurn

+
+public boolean isPlayersTurn(int playerIndex)
+
+
Test if it's the inputted player's turn. +

+

+
+
+
+
+ +

+startTurn

+
+public void startTurn()
+
+
Called to start the next turn. It calls TurnGameManager.turnWillStart() to allow our + owning manager to perform any pre-start turn processing, sets the turn holder that was + configured either when the game started or when finishing up the last turn, and then calls + TurnGameManager.turnDidStart() to allow the manager to perform any post-start turn + processing. This assumes that a valid turn holder has been assigned. If some pre-game + preparation needs to take place in a non-turn-based manner, this function should not be + called until it is time to start the first turn. +

+

+
+
+
+
+ +

+endTurn

+
+public void endTurn()
+
+
Called to end the turn. Whatever indication a game manager has that the turn has ended + (probably the submission of a valid move of some sort by the turn holding player), it + should call this function to cause this turn to end and the next to begin. + +

+ If the game is no longer in play (see TurnGameObject.isInPlay()) after having called + TurnGameManager.turnDidEnd() and setNextTurnHolder(), then the next turn will + not automatically be started. + +

+ If the game is in play, but the next turn should not be started immediately, the game + manager should have setNextTurnHolder() set the _turnIdx field to + -1 which will cause us to not start the next turn. To start things back up + again it would set _turnIdx to the next turn holder and call startTurn() + itself. +

+

+
+
+
+
+ +

+didInit

+
+public void didInit(com.threerings.crowd.data.PlaceConfig config)
+
+
+
Overrides:
didInit in class PlayManagerDelegate
+
+
+
+
+
+
+ +

+didStartup

+
+public void didStartup(com.threerings.crowd.data.PlaceObject plobj)
+
+
+
Overrides:
didStartup in class com.threerings.crowd.server.PlaceManagerDelegate
+
+
+
+
+
+
+ +

+playerWasReplaced

+
+public void playerWasReplaced(int pidx,
+                              com.threerings.util.Name oplayer,
+                              com.threerings.util.Name nplayer)
+
+
Description copied from class: GameManagerDelegate
+
Called when a player in the game has been replaced by a call to GameManager.replacePlayer(int, com.threerings.util.Name). +

+

+
Overrides:
playerWasReplaced in class GameManagerDelegate
+
+
+
+
+
+
+ +

+gameDidStart

+
+public void gameDidStart()
+
+
This should be called from GameManager.gameDidStart() to let the turn delegate perform + start of game processing. +

+

+
Overrides:
gameDidStart in class GameManagerDelegate
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/turn/server/class-use/TurnGameManager.html b/apidocs/com/threerings/parlor/turn/server/class-use/TurnGameManager.html new file mode 100644 index 00000000..1b07fe1f --- /dev/null +++ b/apidocs/com/threerings/parlor/turn/server/class-use/TurnGameManager.html @@ -0,0 +1,208 @@ + + + + + + + +Uses of Interface com.threerings.parlor.turn.server.TurnGameManager (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.parlor.turn.server.TurnGameManager

+
+ + + + + + + + + + + + + +
+Packages that use TurnGameManager
com.threerings.parlor.card.server  
com.threerings.parlor.turn.server  
+  +

+ + + + + +
+Uses of TurnGameManager in com.threerings.parlor.card.server
+  +

+ + + + + + + + + +
Classes in com.threerings.parlor.card.server that implement TurnGameManager
+ classCardGameManager + +
+          A manager class for card games.
+  +

+ + + + + +
+Uses of TurnGameManager in com.threerings.parlor.turn.server
+  +

+ + + + + + + + +
Constructors in com.threerings.parlor.turn.server with parameters of type TurnGameManager
TurnGameManagerDelegate(TurnGameManager tgmgr) + +
+          Deprecated. use the zero-argument constructor.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/turn/server/class-use/TurnGameManagerDelegate.html b/apidocs/com/threerings/parlor/turn/server/class-use/TurnGameManagerDelegate.html new file mode 100644 index 00000000..aa920c9d --- /dev/null +++ b/apidocs/com/threerings/parlor/turn/server/class-use/TurnGameManagerDelegate.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class com.threerings.parlor.turn.server.TurnGameManagerDelegate (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.turn.server.TurnGameManagerDelegate

+
+ + + + + + + + + +
+Packages that use TurnGameManagerDelegate
com.threerings.parlor.card.trick.server  
+  +

+ + + + + +
+Uses of TurnGameManagerDelegate in com.threerings.parlor.card.trick.server
+  +

+ + + + + + + + + +
Subclasses of TurnGameManagerDelegate in com.threerings.parlor.card.trick.server
+ classTrickCardGameManagerDelegate + +
+          A card game manager delegate for trick-based card games, such as Spades and Hearts.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/turn/server/package-frame.html b/apidocs/com/threerings/parlor/turn/server/package-frame.html new file mode 100644 index 00000000..c5a92d9b --- /dev/null +++ b/apidocs/com/threerings/parlor/turn/server/package-frame.html @@ -0,0 +1,44 @@ + + + + + + + +com.threerings.parlor.turn.server (vilya 1.3 API) + + + + + + + + + + + +com.threerings.parlor.turn.server + + + + +
+Interfaces  + +
+TurnGameManager
+ + + + + + +
+Classes  + +
+TurnGameManagerDelegate
+ + + + diff --git a/apidocs/com/threerings/parlor/turn/server/package-summary.html b/apidocs/com/threerings/parlor/turn/server/package-summary.html new file mode 100644 index 00000000..ee863496 --- /dev/null +++ b/apidocs/com/threerings/parlor/turn/server/package-summary.html @@ -0,0 +1,175 @@ + + + + + + + +com.threerings.parlor.turn.server (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.parlor.turn.server +

+ + + + + + + + + +
+Interface Summary
TurnGameManagerA game manager that wishes to make use of the turn game services should + implement this interface and create a TurnGameManagerDelegate + which will perform the basic turn game processing and call back to the + main manager via this interface.
+  + +

+ + + + + + + + + +
+Class Summary
TurnGameManagerDelegatePerforms the server-side turn-based game processing for a turn based game.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/turn/server/package-tree.html b/apidocs/com/threerings/parlor/turn/server/package-tree.html new file mode 100644 index 00000000..ad3b9a58 --- /dev/null +++ b/apidocs/com/threerings/parlor/turn/server/package-tree.html @@ -0,0 +1,165 @@ + + + + + + + +com.threerings.parlor.turn.server Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.parlor.turn.server +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/turn/server/package-use.html b/apidocs/com/threerings/parlor/turn/server/package-use.html new file mode 100644 index 00000000..100bba78 --- /dev/null +++ b/apidocs/com/threerings/parlor/turn/server/package-use.html @@ -0,0 +1,215 @@ + + + + + + + +Uses of Package com.threerings.parlor.turn.server (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.parlor.turn.server

+
+ + + + + + + + + + + + + + + + + +
+Packages that use com.threerings.parlor.turn.server
com.threerings.parlor.card.server  
com.threerings.parlor.card.trick.server  
com.threerings.parlor.turn.server  
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.turn.server used by com.threerings.parlor.card.server
TurnGameManager + +
+          A game manager that wishes to make use of the turn game services should + implement this interface and create a TurnGameManagerDelegate + which will perform the basic turn game processing and call back to the + main manager via this interface.
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.turn.server used by com.threerings.parlor.card.trick.server
TurnGameManagerDelegate + +
+          Performs the server-side turn-based game processing for a turn based game.
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.turn.server used by com.threerings.parlor.turn.server
TurnGameManager + +
+          A game manager that wishes to make use of the turn game services should + implement this interface and create a TurnGameManagerDelegate + which will perform the basic turn game processing and call back to the + main manager via this interface.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/util/ParlorContext.html b/apidocs/com/threerings/parlor/util/ParlorContext.html new file mode 100644 index 00000000..af53cc79 --- /dev/null +++ b/apidocs/com/threerings/parlor/util/ParlorContext.html @@ -0,0 +1,241 @@ + + + + + + + +ParlorContext (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.util +
+Interface ParlorContext

+
+
All Superinterfaces:
com.threerings.crowd.util.CrowdContext, com.threerings.presents.util.PresentsContext
+
+
+
All Known Subinterfaces:
MiCasaContext, PuzzleContext, SimulatorContext
+
+
+
+
public interface ParlorContext
extends com.threerings.crowd.util.CrowdContext
+ + +

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

+ +

+

+ +

+ + + + + + + + + + + + +
+Method Summary
+ ParlorDirectorgetParlorDirector() + +
+          Returns a reference to the parlor director.
+  + + + + + + + +
Methods inherited from interface com.threerings.crowd.util.CrowdContext
clearPlaceView, getChatDirector, getLocationDirector, getMessageManager, getOccupantDirector, setPlaceView
+  + + + + + + + +
Methods inherited from interface com.threerings.presents.util.PresentsContext
getClient, getConfig, getDObjectManager
+  +

+ + + + + + + + +
+Method Detail
+ +

+getParlorDirector

+
+ParlorDirector getParlorDirector()
+
+
Returns a reference to the parlor director. +

+

+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/util/RobotPlayer.html b/apidocs/com/threerings/parlor/util/RobotPlayer.html new file mode 100644 index 00000000..d178331b --- /dev/null +++ b/apidocs/com/threerings/parlor/util/RobotPlayer.html @@ -0,0 +1,365 @@ + + + + + + + +RobotPlayer (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.parlor.util +
+Class RobotPlayer

+
+java.lang.Object
+  extended by com.samskivert.util.Interval
+      extended by com.threerings.parlor.util.RobotPlayer
+
+
+
+
public class RobotPlayer
extends Interval
+ + +

+The robot player is a computer player with truly rudimentary artificial + intelligence that periodically posts random commands selected from the + available key press and release commands to the target component. + + Note that Robot could have been used to post key + events to the target component rather than commands, but not all key + events can be simulated in that fashion (e.g., a right shift key + press), and this seemed somehow more proper in any case. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class com.samskivert.util.Interval
Interval.RunBuddy
+  + + + + + + + + + + + +
+Constructor Summary
RobotPlayer(Component target, + com.threerings.util.KeyTranslator xlate) + +
+          Constructs a robot player.
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidexpired() + +
+           
+ booleanisActive() + +
+          Returns whether the robot is currently active and periodically + posting action commands.
+ voidsetActive(boolean active) + +
+          Sets whether the robot player is actively posting action commands.
+ voidsetRobotDelay(long delay) + +
+          Sets the delay in milliseconds between posting each action command.
+  + + + + + + + +
Methods inherited from class com.samskivert.util.Interval
cancel, create, create, resetTimer, schedule, schedule, schedule, schedule, schedule, setRunQueue
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+RobotPlayer

+
+public RobotPlayer(Component target,
+                   com.threerings.util.KeyTranslator xlate)
+
+
Constructs a robot player. +

+

+ + + + + + + + +
+Method Detail
+ +

+setActive

+
+public void setActive(boolean active)
+
+
Sets whether the robot player is actively posting action commands. +

+

+
+
+
+
+ +

+setRobotDelay

+
+public void setRobotDelay(long delay)
+
+
Sets the delay in milliseconds between posting each action command. +

+

+
+
+
+
+ +

+isActive

+
+public boolean isActive()
+
+
Returns whether the robot is currently active and periodically + posting action commands. +

+

+
+
+
+
+ +

+expired

+
+public void expired()
+
+
+
Specified by:
expired in class Interval
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/util/class-use/ParlorContext.html b/apidocs/com/threerings/parlor/util/class-use/ParlorContext.html new file mode 100644 index 00000000..0739a1b8 --- /dev/null +++ b/apidocs/com/threerings/parlor/util/class-use/ParlorContext.html @@ -0,0 +1,392 @@ + + + + + + + +Uses of Interface com.threerings.parlor.util.ParlorContext (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.parlor.util.ParlorContext

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Packages that use ParlorContext
com.threerings.micasa.simulator.client  
com.threerings.micasa.simulator.util  
com.threerings.micasa.util  
com.threerings.parlor.client  
com.threerings.parlor.game.client  
com.threerings.puzzle.util  
+  +

+ + + + + +
+Uses of ParlorContext in com.threerings.micasa.simulator.client
+  +

+ + + + + + + + + + + + + +
Methods in com.threerings.micasa.simulator.client that return ParlorContext
+ ParlorContextSimulatorClient.getParlorContext() + +
+           
+ ParlorContextSimpleClient.getParlorContext() + +
+          Returns a reference to the context in effect for this client.
+  +

+ + + + + + + + +
Constructors in com.threerings.micasa.simulator.client with parameters of type ParlorContext
SimulatorController(ParlorContext ctx, + SimulatorFrame frame, + SimulatorInfo info) + +
+          Creates a new simulator controller.
+  +

+ + + + + +
+Uses of ParlorContext in com.threerings.micasa.simulator.util
+  +

+ + + + + + + + + +
Subinterfaces of ParlorContext in com.threerings.micasa.simulator.util
+ interfaceSimulatorContext + +
+          The simulator context encapsulates the contexts of all of the services + that are used by the simulator client so that we can pass around one + single context implementation that provides all of the necessary + components to all of the services in use.
+  +

+ + + + + +
+Uses of ParlorContext in com.threerings.micasa.util
+  +

+ + + + + + + + + +
Subinterfaces of ParlorContext in com.threerings.micasa.util
+ interfaceMiCasaContext + +
+          The micasa context encapsulates the contexts of all of the services + that are used by the micasa client so that we can pass around one + single context implementation that provides all of the necessary + components to all of the services in use.
+  +

+ + + + + +
+Uses of ParlorContext in com.threerings.parlor.client
+  +

+ + + + + + + + + +
Methods in com.threerings.parlor.client with parameters of type ParlorContext
+ voidTableConfigurator.init(ParlorContext ctx, + GameConfigurator gameConfigurator) + +
+          Initialize the TableConfigurator.
+  +

+ + + + + + + + + + + + + + +
Constructors in com.threerings.parlor.client with parameters of type ParlorContext
Invitation(ParlorContext ctx, + ParlorService pservice, + com.threerings.util.Name opponent, + GameConfig config, + InvitationResponseObserver observer) + +
+          Constructs a new invitation record.
ParlorDirector(ParlorContext ctx) + +
+          Constructs a parlor director and provides it with the parlor context that it can use to + access the client services that it needs to provide its own services.
TableDirector(ParlorContext ctx, + String tableField, + TableObserver observer) + +
+          Creates a new table director to manage tables with the specified observer which will receive + callbacks when interesting table related things happen.
+  +

+ + + + + +
+Uses of ParlorContext in com.threerings.parlor.game.client
+  +

+ + + + + + + + + +
Methods in com.threerings.parlor.game.client with parameters of type ParlorContext
+ voidGameConfigurator.init(ParlorContext ctx) + +
+          Initializes this game configurator, creates its user interface elements and prepares it for + display.
+  +

+ + + + + +
+Uses of ParlorContext in com.threerings.puzzle.util
+  +

+ + + + + + + + + +
Subinterfaces of ParlorContext in com.threerings.puzzle.util
+ interfacePuzzleContext + +
+          Provides access to entities needed by the puzzle services.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/util/class-use/RobotPlayer.html b/apidocs/com/threerings/parlor/util/class-use/RobotPlayer.html new file mode 100644 index 00000000..ce994d59 --- /dev/null +++ b/apidocs/com/threerings/parlor/util/class-use/RobotPlayer.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.parlor.util.RobotPlayer (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.parlor.util.RobotPlayer

+
+No usage of com.threerings.parlor.util.RobotPlayer +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/util/package-frame.html b/apidocs/com/threerings/parlor/util/package-frame.html new file mode 100644 index 00000000..1c2d4da9 --- /dev/null +++ b/apidocs/com/threerings/parlor/util/package-frame.html @@ -0,0 +1,44 @@ + + + + + + + +com.threerings.parlor.util (vilya 1.3 API) + + + + + + + + + + + +com.threerings.parlor.util + + + + +
+Interfaces  + +
+ParlorContext
+ + + + + + +
+Classes  + +
+RobotPlayer
+ + + + diff --git a/apidocs/com/threerings/parlor/util/package-summary.html b/apidocs/com/threerings/parlor/util/package-summary.html new file mode 100644 index 00000000..d290bf0a --- /dev/null +++ b/apidocs/com/threerings/parlor/util/package-summary.html @@ -0,0 +1,174 @@ + + + + + + + +com.threerings.parlor.util (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.parlor.util +

+ + + + + + + + + +
+Interface Summary
ParlorContextThe parlor context provides access to the various managers, etc.
+  + +

+ + + + + + + + + +
+Class Summary
RobotPlayerThe robot player is a computer player with truly rudimentary artificial + intelligence that periodically posts random commands selected from the + available key press and release commands to the target component.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/util/package-tree.html b/apidocs/com/threerings/parlor/util/package-tree.html new file mode 100644 index 00000000..4ff4c1f1 --- /dev/null +++ b/apidocs/com/threerings/parlor/util/package-tree.html @@ -0,0 +1,165 @@ + + + + + + + +com.threerings.parlor.util Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.parlor.util +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/parlor/util/package-use.html b/apidocs/com/threerings/parlor/util/package-use.html new file mode 100644 index 00000000..d897d7cc --- /dev/null +++ b/apidocs/com/threerings/parlor/util/package-use.html @@ -0,0 +1,266 @@ + + + + + + + +Uses of Package com.threerings.parlor.util (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.parlor.util

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Packages that use com.threerings.parlor.util
com.threerings.micasa.simulator.client  
com.threerings.micasa.simulator.util  
com.threerings.micasa.util  
com.threerings.parlor.client  
com.threerings.parlor.game.client  
com.threerings.puzzle.util  
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.util used by com.threerings.micasa.simulator.client
ParlorContext + +
+          The parlor context provides access to the various managers, etc.
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.util used by com.threerings.micasa.simulator.util
ParlorContext + +
+          The parlor context provides access to the various managers, etc.
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.util used by com.threerings.micasa.util
ParlorContext + +
+          The parlor context provides access to the various managers, etc.
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.util used by com.threerings.parlor.client
ParlorContext + +
+          The parlor context provides access to the various managers, etc.
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.util used by com.threerings.parlor.game.client
ParlorContext + +
+          The parlor context provides access to the various managers, etc.
+  +

+ + + + + + + + +
+Classes in com.threerings.parlor.util used by com.threerings.puzzle.util
ParlorContext + +
+          The parlor context provides access to the various managers, etc.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/Log.html b/apidocs/com/threerings/puzzle/Log.html new file mode 100644 index 00000000..3ab742cd --- /dev/null +++ b/apidocs/com/threerings/puzzle/Log.html @@ -0,0 +1,265 @@ + + + + + + + +Log (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.puzzle +
+Class Log

+
+java.lang.Object
+  extended by com.threerings.puzzle.Log
+
+
+
+
public class Log
extends Object
+ + +

+Contains a reference to the log object used by this package. +

+ +

+

+ +

+ + + + + + + + + + + +
+Field Summary
+static Loggerlog + +
+           
+  + + + + + + + + + + +
+Constructor Summary
Log() + +
+           
+  + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+log

+
+public static Logger log
+
+
+
+
+ + + + + + + + +
+Constructor Detail
+ +

+Log

+
+public Log()
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/class-use/Log.html b/apidocs/com/threerings/puzzle/class-use/Log.html new file mode 100644 index 00000000..8cee0285 --- /dev/null +++ b/apidocs/com/threerings/puzzle/class-use/Log.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.puzzle.Log (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.puzzle.Log

+
+No usage of com.threerings.puzzle.Log +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/client/PlayerStatusView.html b/apidocs/com/threerings/puzzle/client/PlayerStatusView.html new file mode 100644 index 00000000..7f454a73 --- /dev/null +++ b/apidocs/com/threerings/puzzle/client/PlayerStatusView.html @@ -0,0 +1,479 @@ + + + + + + + +PlayerStatusView (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.puzzle.client +
+Class PlayerStatusView

+
+java.lang.Object
+  extended by java.awt.Component
+      extended by java.awt.Container
+          extended by javax.swing.JComponent
+              extended by javax.swing.JPanel
+                  extended by com.threerings.puzzle.client.PlayerStatusView
+
+
+
All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, Accessible
+
+
+
+
public class PlayerStatusView
extends JPanel
+ + +

+The player status view displays a player's current status in the game. +

+ +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent
+  + + + + + + + + +
Nested classes/interfaces inherited from class java.awt.Component
Component.BaselineResizeBehavior
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class javax.swing.JComponent
TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
+  + + + + + + + +
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
+  + + + + + + + +
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
+  + + + + + + + + + + +
+Constructor Summary
PlayerStatusView(GameObject gameobj, + int pidx) + +
+          Constructs a player status view.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ intgetPlayerIndex() + +
+          Get the player index of the player represented by this view.
+ voidinit(GameConfig config) + +
+          Initializes the player status view with the puzzle config.
+ voidsetBoardSummary(BoardSummary summary) + +
+          Sets the player board summary.
+ voidsetHighlighted(boolean highlight) + +
+          Sets whether to highlight the player status display when rendered.
+ voidsetStatus(int status) + +
+          Sets the player status.
+ StringtoString() + +
+           
+  + + + + + + + +
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, setUI, updateUI
+  + + + + + + + +
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
+  + + + + + + + +
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate
+  + + + + + + + +
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, transferFocus, transferFocusUpCycle
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+PlayerStatusView

+
+public PlayerStatusView(GameObject gameobj,
+                        int pidx)
+
+
Constructs a player status view. +

+

+ + + + + + + + +
+Method Detail
+ +

+init

+
+public void init(GameConfig config)
+
+
Initializes the player status view with the puzzle config. +

+

+
+
+
+
+ +

+getPlayerIndex

+
+public int getPlayerIndex()
+
+
Get the player index of the player represented by this view. +

+

+
+
+
+
+ +

+setBoardSummary

+
+public void setBoardSummary(BoardSummary summary)
+
+
Sets the player board summary. +

+

+
+
+
+
+ +

+setStatus

+
+public void setStatus(int status)
+
+
Sets the player status. +

+

+
+
+
+
+ +

+setHighlighted

+
+public void setHighlighted(boolean highlight)
+
+
Sets whether to highlight the player status display when rendered. +

+

+
+
+
+
+ +

+toString

+
+public String toString()
+
+
+
Overrides:
toString in class Component
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/client/PuzzleAnimationWaiter.html b/apidocs/com/threerings/puzzle/client/PuzzleAnimationWaiter.html new file mode 100644 index 00000000..9bfc4504 --- /dev/null +++ b/apidocs/com/threerings/puzzle/client/PuzzleAnimationWaiter.html @@ -0,0 +1,276 @@ + + + + + + + +PuzzleAnimationWaiter (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.puzzle.client +
+Class PuzzleAnimationWaiter

+
+java.lang.Object
+  extended by com.threerings.media.animation.AnimationWaiter
+      extended by com.threerings.puzzle.client.PuzzleAnimationWaiter
+
+
+
All Implemented Interfaces:
com.threerings.media.animation.AnimationObserver
+
+
+
+
public abstract class PuzzleAnimationWaiter
extends com.threerings.media.animation.AnimationWaiter
+ + +

+An animation waiter to be used with puzzles that want to modify the game object or board in some + way after the animations end, and would like to do so in a safe fashion such that their changes + aren't unwittingly performed on game data for a subsequent round of the puzzle. +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
PuzzleAnimationWaiter(PuzzleObject puzobj) + +
+          Constructs a puzzle animation waiter.
+  + + + + + + + + + + + +
+Method Summary
+ booleanpuzzleStillValid() + +
+          Returns whether the puzzle associated with this puzzle animation waiter is still valid.
+  + + + + + + + +
Methods inherited from class com.threerings.media.animation.AnimationWaiter
addAnimation, addAnimations, animationCompleted, animationStarted
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+PuzzleAnimationWaiter

+
+public PuzzleAnimationWaiter(PuzzleObject puzobj)
+
+
Constructs a puzzle animation waiter. +

+

+ + + + + + + + +
+Method Detail
+ +

+puzzleStillValid

+
+public boolean puzzleStillValid()
+
+
Returns whether the puzzle associated with this puzzle animation waiter is still valid. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/client/PuzzleBoardView.html b/apidocs/com/threerings/puzzle/client/PuzzleBoardView.html new file mode 100644 index 00000000..c7c82d84 --- /dev/null +++ b/apidocs/com/threerings/puzzle/client/PuzzleBoardView.html @@ -0,0 +1,830 @@ + + + + + + + +PuzzleBoardView (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.puzzle.client +
+Class PuzzleBoardView

+
+java.lang.Object
+  extended by java.awt.Component
+      extended by java.awt.Container
+          extended by javax.swing.JComponent
+              extended by com.threerings.media.MediaPanel
+                  extended by com.threerings.media.VirtualMediaPanel
+                      extended by com.threerings.puzzle.client.PuzzleBoardView
+
+
+
All Implemented Interfaces:
com.threerings.media.FrameParticipant, com.threerings.media.MediaConstants, com.threerings.media.MediaHost, ImageObserver, MenuContainer, Serializable
+
+
+
Direct Known Subclasses:
DropBoardView
+
+
+
+
public abstract class PuzzleBoardView
extends com.threerings.media.VirtualMediaPanel
+ + +

+The puzzle board view displays a view of a puzzle game. +

+ +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.media.MediaPanel
com.threerings.media.MediaPanel.Obscurer
+  + + + + + + + + +
Nested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent
+  + + + + + + + + +
Nested classes/interfaces inherited from class java.awt.Component
Component.BaselineResizeBehavior
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class com.threerings.media.VirtualMediaPanel
CENTER_ON_PATHABLE, ENCLOSE_PATHABLE, TRACK_PATHABLE
+  + + + + + + + +
Fields inherited from class javax.swing.JComponent
TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
+  + + + + + + + +
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
+  + + + + + + + +
Fields inherited from interface com.threerings.media.MediaConstants
ALL, BACK, FRONT
+  + + + + + + + +
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
+  + + + + + + + + + + +
+Constructor Summary
PuzzleBoardView(PuzzleContext ctx) + +
+          Constructs a puzzle board view.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidabortAnimation(com.threerings.media.animation.Animation anim) + +
+           
+ voidaddActionAnimation(com.threerings.media.animation.Animation anim) + +
+          Adds the given animation to the set of animations currently present on the board.
+ voidaddActionSprite(com.threerings.media.sprite.Sprite sprite) + +
+          Adds the given sprite to the set of sprites currently present on the board.
+ voidclearAnimations() + +
+           
+ voidclearSprites() + +
+           
+ ScoreAnimationcreateScoreAnimation(String score, + Color color, + Font font, + int x, + int y) + +
+          Creates and returns an animation displaying the given string with the specified parameters, + floating it a short distance up the view.
+ voiddumpActors() + +
+          Dumps to the logs, a list of interesting sprites and animations + currently active on the puzzle board.
+ intgetActionAnimationCount() + +
+          Returns the number of action animations on the board.
+ intgetActionCount() + +
+          Returns the count of action sprites and animations on the board.
+ intgetActionSpriteCount() + +
+          Returns the number of action sprites on the board.
+ voidinit(GameConfig config) + +
+          Initializes the board with the board dimensions.
+ voidpaintBehind(Graphics2D gfx, + Rectangle dirty) + +
+           
+ voidpaintBetween(Graphics2D gfx, + Rectangle dirty) + +
+           
+ voidremoveSprite(com.threerings.media.sprite.Sprite sprite) + +
+           
+ voidsetBackgroundImage(com.threerings.media.image.Mirage image) + +
+          Sets the background image displayed by the board view.
+ voidsetBoard(Board board) + +
+          Sets the board to be displayed.
+ voidsetController(PuzzleController pctrl) + +
+          Provides the board view with a reference to its controller so that it may communicate + directly rather than by posting actions up the interface hierarchy which sometimes fails if + the puzzle board view is hidden before we get a chance to post our actions.
+ voidsetPaused(boolean paused) + +
+          Set whether this puzzle is paused or not.
+ voidtrackAvoidAnimation(com.threerings.media.animation.Animation anim) + +
+          Positions the supplied animation so as to avoid any active animations previously registered + with this method, and adds the animation to the list of animations to be avoided by any + future avoid animations.
+  + + + + + + + +
Methods inherited from class com.threerings.media.VirtualMediaPanel
addViewTracker, clearPathable, doLayout, getViewBounds, removeViewTracker, setBackground, setBounds, setFollowsPathable, setViewLocation
+  + + + + + + + +
Methods inherited from class com.threerings.media.MediaPanel
addAnimation, addObscurer, addSprite, createGraphics, getAnimationManager, getComponent, getRegionManager, getSpriteManager, getTimeStamp, isManaged, isManaged, needsPaint, paint, removeObscurer, repaint, setOpaque, tick
+  + + + + + + + +
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI
+  + + + + + + + +
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate
+  + + + + + + + +
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+PuzzleBoardView

+
+public PuzzleBoardView(PuzzleContext ctx)
+
+
Constructs a puzzle board view. +

+

+ + + + + + + + +
+Method Detail
+ +

+init

+
+public void init(GameConfig config)
+
+
Initializes the board with the board dimensions. +

+

+
+
+
+
+ +

+setBoard

+
+public void setBoard(Board board)
+
+
Sets the board to be displayed. +

+

+
+
+
+
+ +

+setController

+
+public void setController(PuzzleController pctrl)
+
+
Provides the board view with a reference to its controller so that it may communicate + directly rather than by posting actions up the interface hierarchy which sometimes fails if + the puzzle board view is hidden before we get a chance to post our actions. +

+

+
+
+
+
+ +

+setBackgroundImage

+
+public void setBackgroundImage(com.threerings.media.image.Mirage image)
+
+
Sets the background image displayed by the board view. +

+

+
+
+
+
+ +

+setPaused

+
+public void setPaused(boolean paused)
+
+
Set whether this puzzle is paused or not. If paused, a label will be displayed with the + component's font, which may be set with setFont(). +

+

+
Overrides:
setPaused in class com.threerings.media.MediaPanel
+
+
+
+
+
+
+ +

+addActionAnimation

+
+public void addActionAnimation(com.threerings.media.animation.Animation anim)
+
+
Adds the given animation to the set of animations currently present on the board. The + animation will be added to a list of action animations whose count can be queried with + getActionAnimationCount(). The animation will automatically be removed from the + action list when it completes. +

+

+
+
+
+
+ +

+abortAnimation

+
+public void abortAnimation(com.threerings.media.animation.Animation anim)
+
+
+
Overrides:
abortAnimation in class com.threerings.media.MediaPanel
+
+
+
+
+
+
+ +

+addActionSprite

+
+public void addActionSprite(com.threerings.media.sprite.Sprite sprite)
+
+
Adds the given sprite to the set of sprites currently present on the board. The sprite will + be added to a list of action sprites whose count can be queried with + getActionSpriteCount(). Callers should be sure to remove the sprite when their work + with it is done via removeSprite(com.threerings.media.sprite.Sprite). +

+

+
+
+
+
+ +

+removeSprite

+
+public void removeSprite(com.threerings.media.sprite.Sprite sprite)
+
+
+
Overrides:
removeSprite in class com.threerings.media.MediaPanel
+
+
+
+
+
+
+ +

+clearSprites

+
+public void clearSprites()
+
+
+
Overrides:
clearSprites in class com.threerings.media.MediaPanel
+
+
+
+
+
+
+ +

+clearAnimations

+
+public void clearAnimations()
+
+
+
Overrides:
clearAnimations in class com.threerings.media.MediaPanel
+
+
+
+
+
+
+ +

+getActionAnimationCount

+
+public int getActionAnimationCount()
+
+
Returns the number of action animations on the board. +

+

+
+
+
+
+ +

+getActionSpriteCount

+
+public int getActionSpriteCount()
+
+
Returns the number of action sprites on the board. +

+

+
+
+
+
+ +

+getActionCount

+
+public int getActionCount()
+
+
Returns the count of action sprites and animations on the board. +

+

+
+
+
+
+ +

+dumpActors

+
+public void dumpActors()
+
+
Dumps to the logs, a list of interesting sprites and animations + currently active on the puzzle board. +

+

+
+
+
+
+ +

+createScoreAnimation

+
+public ScoreAnimation createScoreAnimation(String score,
+                                           Color color,
+                                           Font font,
+                                           int x,
+                                           int y)
+
+
Creates and returns an animation displaying the given string with the specified parameters, + floating it a short distance up the view. +

+

+
Parameters:
score - the score text to display.
color - the color of the text.
font - the font with which to create the score animation.
x - the x-position at which the score is to be placed.
y - the y-position at which the score is to be placed.
+
+
+
+ +

+trackAvoidAnimation

+
+public void trackAvoidAnimation(com.threerings.media.animation.Animation anim)
+
+
Positions the supplied animation so as to avoid any active animations previously registered + with this method, and adds the animation to the list of animations to be avoided by any + future avoid animations. +

+

+
+
+
+
+ +

+paintBehind

+
+public void paintBehind(Graphics2D gfx,
+                        Rectangle dirty)
+
+
+
Overrides:
paintBehind in class com.threerings.media.VirtualMediaPanel
+
+
+
+
+
+
+ +

+paintBetween

+
+public void paintBetween(Graphics2D gfx,
+                         Rectangle dirty)
+
+
+
Overrides:
paintBetween in class com.threerings.media.MediaPanel
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/client/PuzzleController.ClearPender.html b/apidocs/com/threerings/puzzle/client/PuzzleController.ClearPender.html new file mode 100644 index 00000000..30e1536a --- /dev/null +++ b/apidocs/com/threerings/puzzle/client/PuzzleController.ClearPender.html @@ -0,0 +1,296 @@ + + + + + + + +PuzzleController.ClearPender (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.puzzle.client +
+Interface PuzzleController.ClearPender

+
+
Enclosing class:
PuzzleController
+
+
+
+
public static interface PuzzleController.ClearPender
+ + +

+Used by PuzzleController.fireWhenActionCleared(com.threerings.puzzle.client.PuzzleController.ClearPender). +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + +
+Field Summary
+static intCARE_NOT + +
+          actionCleared() return code.
+static intNO_RESTART_ACTION + +
+          actionCleared() return code.
+static intRESTART_ACTION + +
+          actionCleared() return code.
+  + + + + + + + + + + + +
+Method Summary
+ intactionCleared() + +
+          Called when the action is fully cleared.
+  +

+ + + + + + + + +
+Field Detail
+ +

+RESTART_ACTION

+
+static final int RESTART_ACTION
+
+
actionCleared() return code. +

+

+
See Also:
Constant Field Values
+
+
+ +

+CARE_NOT

+
+static final int CARE_NOT
+
+
actionCleared() return code. +

+

+
See Also:
Constant Field Values
+
+
+ +

+NO_RESTART_ACTION

+
+static final int NO_RESTART_ACTION
+
+
actionCleared() return code. +

+

+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Method Detail
+ +

+actionCleared

+
+int actionCleared()
+
+
Called when the action is fully cleared. +

+

+ +
Returns:
One of RESTART_ACTION, CARE_NOT or + NO_RESTART_ACTION.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/client/PuzzleController.html b/apidocs/com/threerings/puzzle/client/PuzzleController.html new file mode 100644 index 00000000..9455fcd8 --- /dev/null +++ b/apidocs/com/threerings/puzzle/client/PuzzleController.html @@ -0,0 +1,759 @@ + + + + + + + +PuzzleController (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.puzzle.client +
+Class PuzzleController

+
+java.lang.Object
+  extended by com.samskivert.swing.Controller
+      extended by com.threerings.crowd.client.PlaceController
+          extended by com.threerings.parlor.game.client.GameController
+              extended by com.threerings.puzzle.client.PuzzleController
+
+
+
All Implemented Interfaces:
com.threerings.presents.data.InvocationCodes, com.threerings.presents.dobj.AttributeChangeListener, com.threerings.presents.dobj.ChangeListener, PuzzleCodes, ActionListener, EventListener
+
+
+
+
public abstract class PuzzleController
extends GameController
implements PuzzleCodes
+ + +

+The puzzle game controller handles logical actions for a puzzle game. +

+ +

+

+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static interfacePuzzleController.ClearPender + +
+          Used by fireWhenActionCleared(com.threerings.puzzle.client.PuzzleController.ClearPender).
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.crowd.client.PlaceController
com.threerings.crowd.client.PlaceController.DelegateOp
+  + + + + + + + + + + + +
+Field Summary
+static StringTOGGLE_CHATTING + +
+          The action command to toggle chatting mode.
+  + + + + + + + +
Fields inherited from class com.samskivert.swing.Controller
DISPATCHER
+  + + + + + + + +
Fields inherited from interface com.threerings.puzzle.data.PuzzleCodes
DEBUG_PUZZLE, DEFAULT_DIFFICULTY, PUZZLE_MESSAGE_BUNDLE
+  + + + + + + + +
Fields inherited from interface com.threerings.presents.data.InvocationCodes
ACCESS_DENIED, E_ACCESS_DENIED, E_INTERNAL_ERROR, GLOBAL_GROUP, INTERNAL_ERROR
+  + + + + + + + + + + +
+Constructor Summary
PuzzleController() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidaddProgressEvent(int event, + Board board) + +
+          Adds the given progress event and a snapshot of the supplied board state to the set of + progress events and associated board states for later transmission to the server.
+ voidattributeChanged(com.threerings.presents.dobj.AttributeChangedEvent event) + +
+           
+ voiddidLeavePlace(com.threerings.crowd.data.PlaceObject plobj) + +
+          Removes our listener registration from the game object and cleans house.
+ BoardgetBoard() + +
+          Returns the board associated with the puzzle.
+ intgetEventCount() + +
+          Returns the number of progress events currently queued up for sending to the server with + the next progress update.
+ StringgetPauseString() + +
+          Get the (untranslated) string to display when the puzzle is paused.
+ intgetPlayerIndex() + +
+          Returns the player's index in the list of players for the game.
+ booleanhandleAction(ActionEvent action) + +
+          Handles basic game controller action events.
+ booleanhasAction() + +
+          Returns true if the puzzle has action, false if the action is cleared or it is suspended.
+ booleanisChatting() + +
+          Returns true if the puzzle has been defocused because the player is doing some chatting.
+ voidmayLeavePlace(com.threerings.crowd.data.PlaceObject plobj) + +
+           
+ voidsendProgressUpdate() + +
+          Sends the server a game progress update with the list of events, as well as board states if + PuzzlePanel.isSyncingBoards() is true.
+ voidsetBoard(Board board) + +
+          Called when a new board is set.
+ voidsetChatting(boolean chatting) + +
+          Sets whether we're focusing on the chat window rather than the puzzle.
+ voidsetGameOver(boolean gameOver) + +
+          Sets the client game over override.
+ voidwillEnterPlace(com.threerings.crowd.data.PlaceObject plobj) + +
+          Adds this controller as a listener to the game object (thus derived classes need not do so) + and lets the game manager know that we are now ready to go.
+  + + + + + + + +
Methods inherited from class com.threerings.parlor.game.client.GameController
getMatchType, getSessionId, init, isGameOver, resetGame, systemMessage
+  + + + + + + + +
Methods inherited from class com.threerings.crowd.client.PlaceController
getPlaceConfig, getPlaceView
+  + + + + + + + +
Methods inherited from class com.samskivert.swing.Controller
actionPerformed, configureAction, createActionButton, handleAction, handleAction, handleAction, postAction, postAction, postAction, setControlledPanel, wasAdded, wasRemoved
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+TOGGLE_CHATTING

+
+public static final String TOGGLE_CHATTING
+
+
The action command to toggle chatting mode. +

+

+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Constructor Detail
+ +

+PuzzleController

+
+public PuzzleController()
+
+
+ + + + + + + + +
+Method Detail
+ +

+getBoard

+
+public Board getBoard()
+
+
Returns the board associated with the puzzle. +

+

+
+
+
+
+
+
+
+ +

+getPlayerIndex

+
+public int getPlayerIndex()
+
+
Returns the player's index in the list of players for the game. +

+

+
+
+
+
+
+
+
+ +

+setGameOver

+
+public void setGameOver(boolean gameOver)
+
+
Description copied from class: GameController
+
Sets the client game over override. This is used in situations where we determine that the + game is over before the server has informed us of such. +

+

+
Overrides:
setGameOver in class GameController
+
+
+
+
+
+
+ +

+hasAction

+
+public boolean hasAction()
+
+
Returns true if the puzzle has action, false if the action is cleared or it is suspended. +

+

+
+
+
+
+
+
+
+ +

+setChatting

+
+public void setChatting(boolean chatting)
+
+
Sets whether we're focusing on the chat window rather than the puzzle. +

+

+
+
+
+
+
+
+
+ +

+getPauseString

+
+public String getPauseString()
+
+
Get the (untranslated) string to display when the puzzle is paused. +

+

+
+
+
+
+
+
+
+ +

+isChatting

+
+public boolean isChatting()
+
+
Returns true if the puzzle has been defocused because the player is doing some chatting. +

+

+
+
+
+
+
+
+
+ +

+willEnterPlace

+
+public void willEnterPlace(com.threerings.crowd.data.PlaceObject plobj)
+
+
Description copied from class: GameController
+
Adds this controller as a listener to the game object (thus derived classes need not do so) + and lets the game manager know that we are now ready to go. +

+

+
Overrides:
willEnterPlace in class GameController
+
+
+
+
+
+
+ +

+mayLeavePlace

+
+public void mayLeavePlace(com.threerings.crowd.data.PlaceObject plobj)
+
+
+
Overrides:
mayLeavePlace in class com.threerings.crowd.client.PlaceController
+
+
+
+
+
+
+ +

+didLeavePlace

+
+public void didLeavePlace(com.threerings.crowd.data.PlaceObject plobj)
+
+
Description copied from class: GameController
+
Removes our listener registration from the game object and cleans house. +

+

+
Overrides:
didLeavePlace in class GameController
+
+
+
+
+
+
+ +

+attributeChanged

+
+public void attributeChanged(com.threerings.presents.dobj.AttributeChangedEvent event)
+
+
+
Specified by:
attributeChanged in interface com.threerings.presents.dobj.AttributeChangeListener
Overrides:
attributeChanged in class GameController
+
+
+
+
+
+
+ +

+setBoard

+
+public void setBoard(Board board)
+
+
Called when a new board is set. +

+

+
+
+
+
+
+
+
+ +

+handleAction

+
+public boolean handleAction(ActionEvent action)
+
+
Description copied from class: GameController
+
Handles basic game controller action events. Derived classes should be sure to call + super.handleAction for events they don't specifically handle. +

+

+
Overrides:
handleAction in class GameController
+
+
+
+
+
+
+ +

+getEventCount

+
+public int getEventCount()
+
+
Returns the number of progress events currently queued up for sending to the server with + the next progress update. +

+

+
+
+
+
+
+
+
+ +

+addProgressEvent

+
+public void addProgressEvent(int event,
+                             Board board)
+
+
Adds the given progress event and a snapshot of the supplied board state to the set of + progress events and associated board states for later transmission to the server. +

+

+
+
+
+
+
+
+
+ +

+sendProgressUpdate

+
+public void sendProgressUpdate()
+
+
Sends the server a game progress update with the list of events, as well as board states if + PuzzlePanel.isSyncingBoards() is true. +

+

+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/client/PuzzleControllerDelegate.html b/apidocs/com/threerings/puzzle/client/PuzzleControllerDelegate.html new file mode 100644 index 00000000..d75357af --- /dev/null +++ b/apidocs/com/threerings/puzzle/client/PuzzleControllerDelegate.html @@ -0,0 +1,411 @@ + + + + + + + +PuzzleControllerDelegate (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.puzzle.client +
+Class PuzzleControllerDelegate

+
+java.lang.Object
+  extended by com.threerings.crowd.client.PlaceControllerDelegate
+      extended by com.threerings.parlor.game.client.GameControllerDelegate
+          extended by com.threerings.puzzle.client.PuzzleControllerDelegate
+
+
+
All Implemented Interfaces:
com.threerings.presents.data.InvocationCodes, PuzzleCodes, PuzzleGameCodes
+
+
+
Direct Known Subclasses:
DropControllerDelegate
+
+
+
+
public class PuzzleControllerDelegate
extends GameControllerDelegate
implements PuzzleCodes, PuzzleGameCodes
+ + +

+A base class for puzzle controller delegates. Provides access to some delegated puzzle + controller methods (startAction(), clearAction(), etc.) and provides a casted + reference to the puzzle object. +

+ +

+

+ +

+ + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from interface com.threerings.puzzle.data.PuzzleCodes
DEBUG_PUZZLE, DEFAULT_DIFFICULTY, PUZZLE_MESSAGE_BUNDLE
+  + + + + + + + +
Fields inherited from interface com.threerings.presents.data.InvocationCodes
ACCESS_DENIED, E_ACCESS_DENIED, E_INTERNAL_ERROR, GLOBAL_GROUP, INTERNAL_ERROR
+  + + + + + + + + + + +
+Constructor Summary
PuzzleControllerDelegate(PuzzleController ctrl) + +
+          Constructs a puzzle controller delegate.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voiddidLeavePlace(com.threerings.crowd.data.PlaceObject plobj) + +
+           
+ voidplayerKnockedOut(int pidx) + +
+          Called when a player is knocked out of the game.
+ voidsetBoard(Board board) + +
+          Called when the puzzle controller sets up a new board for the player.
+ voidsetChatting(boolean chatting) + +
+          Called when the user toggles chatting mode.
+ voidwillEnterPlace(com.threerings.crowd.data.PlaceObject plobj) + +
+           
+  + + + + + + + +
Methods inherited from class com.threerings.parlor.game.client.GameControllerDelegate
gameDidEnd, gameDidStart, gameWasCancelled, gameWillReset
+  + + + + + + + +
Methods inherited from class com.threerings.crowd.client.PlaceControllerDelegate
handleAction, init, mayLeavePlace
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+PuzzleControllerDelegate

+
+public PuzzleControllerDelegate(PuzzleController ctrl)
+
+
Constructs a puzzle controller delegate. +

+

+ + + + + + + + +
+Method Detail
+ +

+willEnterPlace

+
+public void willEnterPlace(com.threerings.crowd.data.PlaceObject plobj)
+
+
+
Overrides:
willEnterPlace in class com.threerings.crowd.client.PlaceControllerDelegate
+
+
+
+
+
+
+ +

+didLeavePlace

+
+public void didLeavePlace(com.threerings.crowd.data.PlaceObject plobj)
+
+
+
Overrides:
didLeavePlace in class com.threerings.crowd.client.PlaceControllerDelegate
+
+
+
+
+
+
+ +

+playerKnockedOut

+
+public void playerKnockedOut(int pidx)
+
+
Called when a player is knocked out of the game. +

+

+
+
+
+
+
+
+
+ +

+setChatting

+
+public void setChatting(boolean chatting)
+
+
Called when the user toggles chatting mode. +

+

+
+
+
+
+
+
+
+ +

+setBoard

+
+public void setBoard(Board board)
+
+
Called when the puzzle controller sets up a new board for the player. +

+

+
+
+
+
Parameters:
board - the newly initialized and ready-to-go board.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/client/PuzzleGameService.html b/apidocs/com/threerings/puzzle/client/PuzzleGameService.html new file mode 100644 index 00000000..d2ce8e09 --- /dev/null +++ b/apidocs/com/threerings/puzzle/client/PuzzleGameService.html @@ -0,0 +1,305 @@ + + + + + + + +PuzzleGameService (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.puzzle.client +
+Interface PuzzleGameService

+
+
All Superinterfaces:
com.threerings.presents.data.InvocationCodes, com.threerings.presents.client.InvocationService, PuzzleCodes
+
+
+
All Known Implementing Classes:
PuzzleGameMarshaller
+
+
+
+
public interface PuzzleGameService
extends com.threerings.presents.client.InvocationService, PuzzleCodes
+ + +

+Provides services used by puzzle game clients to request that actions be taken by the puzzle + manager. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.presents.client.InvocationService
com.threerings.presents.client.InvocationService.ConfirmListener, com.threerings.presents.client.InvocationService.InvocationListener, com.threerings.presents.client.InvocationService.ResultListener
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from interface com.threerings.puzzle.data.PuzzleCodes
DEBUG_PUZZLE, DEFAULT_DIFFICULTY, PUZZLE_MESSAGE_BUNDLE
+  + + + + + + + +
Fields inherited from interface com.threerings.presents.data.InvocationCodes
ACCESS_DENIED, E_ACCESS_DENIED, E_INTERNAL_ERROR, GLOBAL_GROUP, INTERNAL_ERROR
+  + + + + + + + + + + + + + + + +
+Method Summary
+ voidupdateProgress(int sessionId, + int[] events) + +
+          Asks the puzzle manager to apply the supplied progress events for the specified puzzle round + to the player's state.
+ voidupdateProgressSync(int sessionId, + int[] events, + Board[] states) + +
+          Debug variant of updateProgress(int, int[]) that is only used when + PuzzlePanel.isSyncingBoards() is true and which includes the board states associated + with each event.
+  +

+ + + + + + + + +
+Method Detail
+ +

+updateProgress

+
+void updateProgress(int sessionId,
+                    int[] events)
+
+
Asks the puzzle manager to apply the supplied progress events for the specified puzzle round + to the player's state. +

+

+
+
+
+
+
+
+
+ +

+updateProgressSync

+
+void updateProgressSync(int sessionId,
+                        int[] events,
+                        Board[] states)
+
+
Debug variant of updateProgress(int, int[]) that is only used when + PuzzlePanel.isSyncingBoards() is true and which includes the board states associated + with each event. +

+

+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/client/PuzzlePanel.html b/apidocs/com/threerings/puzzle/client/PuzzlePanel.html new file mode 100644 index 00000000..c979b835 --- /dev/null +++ b/apidocs/com/threerings/puzzle/client/PuzzlePanel.html @@ -0,0 +1,751 @@ + + + + + + + +PuzzlePanel (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.puzzle.client +
+Class PuzzlePanel

+
+java.lang.Object
+  extended by java.awt.Component
+      extended by java.awt.Container
+          extended by javax.swing.JComponent
+              extended by javax.swing.JPanel
+                  extended by com.threerings.puzzle.client.PuzzlePanel
+
+
+
All Implemented Interfaces:
ControllerProvider, com.threerings.crowd.client.PlaceView, com.threerings.presents.data.InvocationCodes, PuzzleCodes, PuzzleGameCodes, ImageObserver, MenuContainer, Serializable, Accessible
+
+
+
+
public abstract class PuzzlePanel
extends JPanel
implements com.threerings.crowd.client.PlaceView, ControllerProvider, PuzzleCodes, PuzzleGameCodes
+ + +

+The puzzle panel class should be extended by classes that provide a view for a puzzle game. The + PuzzleController calls these methods as necessary to perform its duties in managing the + logical actions of a puzzle game. +

+ +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent
+  + + + + + + + + +
Nested classes/interfaces inherited from class java.awt.Component
Component.BaselineResizeBehavior
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class javax.swing.JComponent
TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
+  + + + + + + + +
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
+  + + + + + + + +
Fields inherited from interface com.threerings.puzzle.data.PuzzleCodes
DEBUG_PUZZLE, DEFAULT_DIFFICULTY, PUZZLE_MESSAGE_BUNDLE
+  + + + + + + + +
Fields inherited from interface com.threerings.presents.data.InvocationCodes
ACCESS_DENIED, E_ACCESS_DENIED, E_INTERNAL_ERROR, GLOBAL_GROUP, INTERNAL_ERROR
+  + + + + + + + +
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
+  + + + + + + + + + + +
+Constructor Summary
PuzzlePanel(PuzzleContext ctx, + PuzzleController controller) + +
+          Constructs a puzzle panel.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidaddNotify() + +
+           
+ voidclearAction() + +
+          Called by the controller when the action stops.
+ voiddidLeavePlace(com.threerings.crowd.data.PlaceObject plobj) + +
+           
+ PuzzleBoardViewgetBoardView() + +
+          Returns a reference to the PuzzleBoardView in use.
+ ControllergetController() + +
+           
+ booleanhasOverlay() + +
+          Returns true if an overlay panel is currently being displayed.
+ voidinit(GameConfig config) + +
+          Initializes the puzzle panel with the puzzle config of the puzzle whose user interface is + being displayed by the panel
+static booleanisRobotTesting() + +
+          Returns true if the robot tester is activated.
+static booleanisSyncingBoards() + +
+          Returns true if board syncing is activated.
+ voidpopOverlayPanel() + +
+          Pops the overlay panel off of the main puzzle board display.
+ booleanpushOverlayPanel(JPanel opanel) + +
+          Temporarily replaces the puzzle board display with the supplied overlay panel.
+ voidremoveNotify() + +
+           
+ voidsetPuzzleGrabsKeys(boolean puzgrabs) + +
+          Sets whether the puzzle grabs keys or if they should go to the chat window.
+ voidsetRobotPlayer(boolean isrobot) + +
+          Sets whether this panel receives events periodically from a robot player.
+ voidstartAction() + +
+          Called by the controller when the action starts.
+ voidwillEnterPlace(com.threerings.crowd.data.PlaceObject plobj) + +
+           
+  + + + + + + + +
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, setUI, updateUI
+  + + + + + + + +
Methods inherited from class javax.swing.JComponent
addAncestorListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
+  + + + + + + + +
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate
+  + + + + + + + +
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+PuzzlePanel

+
+public PuzzlePanel(PuzzleContext ctx,
+                   PuzzleController controller)
+
+
Constructs a puzzle panel. +

+

+ + + + + + + + +
+Method Detail
+ +

+addNotify

+
+public void addNotify()
+
+
+
Overrides:
addNotify in class JComponent
+
+
+
+
+
+
+ +

+removeNotify

+
+public void removeNotify()
+
+
+
Overrides:
removeNotify in class JComponent
+
+
+
+
+
+
+ +

+pushOverlayPanel

+
+public boolean pushOverlayPanel(JPanel opanel)
+
+
Temporarily replaces the puzzle board display with the supplied overlay panel. The panel + can be removed and the board display restored by calling popOverlayPanel(). +

+

+
+
+
+ +
Returns:
true if the specified panel will be displayed, false if it was not able to be + pushed because another overlay panel is already pushed onto the primary panel.
+
+
+
+ +

+popOverlayPanel

+
+public void popOverlayPanel()
+
+
Pops the overlay panel off of the main puzzle board display. +

+

+
+
+
+
+
+
+
+ +

+hasOverlay

+
+public boolean hasOverlay()
+
+
Returns true if an overlay panel is currently being displayed. +

+

+
+
+
+
+
+
+
+ +

+init

+
+public void init(GameConfig config)
+
+
Initializes the puzzle panel with the puzzle config of the puzzle whose user interface is + being displayed by the panel +

+

+
+
+
+
+
+
+
+ +

+setRobotPlayer

+
+public void setRobotPlayer(boolean isrobot)
+
+
Sets whether this panel receives events periodically from a robot player. +

+

+
+
+
+
+
+
+
+ +

+setPuzzleGrabsKeys

+
+public void setPuzzleGrabsKeys(boolean puzgrabs)
+
+
Sets whether the puzzle grabs keys or if they should go to the chat window. +

+

+
+
+
+
+
+
+
+ +

+startAction

+
+public void startAction()
+
+
Called by the controller when the action starts. +

+

+
+
+
+
+
+
+
+ +

+clearAction

+
+public void clearAction()
+
+
Called by the controller when the action stops. +

+

+
+
+
+
+
+
+
+ +

+willEnterPlace

+
+public void willEnterPlace(com.threerings.crowd.data.PlaceObject plobj)
+
+
+
Specified by:
willEnterPlace in interface com.threerings.crowd.client.PlaceView
+
+
+
+
+
+
+ +

+didLeavePlace

+
+public void didLeavePlace(com.threerings.crowd.data.PlaceObject plobj)
+
+
+
Specified by:
didLeavePlace in interface com.threerings.crowd.client.PlaceView
+
+
+
+
+
+
+ +

+getBoardView

+
+public PuzzleBoardView getBoardView()
+
+
Returns a reference to the PuzzleBoardView in use. +

+

+
+
+
+
+
+
+
+ +

+getController

+
+public Controller getController()
+
+
+
Specified by:
getController in interface ControllerProvider
+
+
+
+
+
+
+ +

+isRobotTesting

+
+public static boolean isRobotTesting()
+
+
Returns true if the robot tester is activated. +

+

+
+
+
+
+
+
+
+ +

+isSyncingBoards

+
+public static boolean isSyncingBoards()
+
+
Returns true if board syncing is activated. +

+

+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/client/PuzzlePrefs.html b/apidocs/com/threerings/puzzle/client/PuzzlePrefs.html new file mode 100644 index 00000000..f9f9d101 --- /dev/null +++ b/apidocs/com/threerings/puzzle/client/PuzzlePrefs.html @@ -0,0 +1,269 @@ + + + + + + + +PuzzlePrefs (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.puzzle.client +
+Class PuzzlePrefs

+
+java.lang.Object
+  extended by com.threerings.puzzle.client.PuzzlePrefs
+
+
+
+
public class PuzzlePrefs
extends Object
+ + +

+Provides access to runtime configuration parameters for this package and its subpackages. +

+ +

+

+ +

+ + + + + + + + + + + +
+Field Summary
+static PrefsConfigconfig + +
+          Used to load our preferences from a properties file and map them to the persistent Java + preferences repository.
+  + + + + + + + + + + +
+Constructor Summary
PuzzlePrefs() + +
+           
+  + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+config

+
+public static PrefsConfig config
+
+
Used to load our preferences from a properties file and map them to the persistent Java + preferences repository. +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+PuzzlePrefs

+
+public PuzzlePrefs()
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/client/class-use/PlayerStatusView.html b/apidocs/com/threerings/puzzle/client/class-use/PlayerStatusView.html new file mode 100644 index 00000000..e039a50e --- /dev/null +++ b/apidocs/com/threerings/puzzle/client/class-use/PlayerStatusView.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.puzzle.client.PlayerStatusView (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.puzzle.client.PlayerStatusView

+
+No usage of com.threerings.puzzle.client.PlayerStatusView +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/client/class-use/PuzzleAnimationWaiter.html b/apidocs/com/threerings/puzzle/client/class-use/PuzzleAnimationWaiter.html new file mode 100644 index 00000000..fa6711b0 --- /dev/null +++ b/apidocs/com/threerings/puzzle/client/class-use/PuzzleAnimationWaiter.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.puzzle.client.PuzzleAnimationWaiter (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.puzzle.client.PuzzleAnimationWaiter

+
+No usage of com.threerings.puzzle.client.PuzzleAnimationWaiter +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/client/class-use/PuzzleBoardView.html b/apidocs/com/threerings/puzzle/client/class-use/PuzzleBoardView.html new file mode 100644 index 00000000..f97ccec8 --- /dev/null +++ b/apidocs/com/threerings/puzzle/client/class-use/PuzzleBoardView.html @@ -0,0 +1,210 @@ + + + + + + + +Uses of Class com.threerings.puzzle.client.PuzzleBoardView (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.puzzle.client.PuzzleBoardView

+
+ + + + + + + + + + + + + +
+Packages that use PuzzleBoardView
com.threerings.puzzle.client  
com.threerings.puzzle.drop.client  
+  +

+ + + + + +
+Uses of PuzzleBoardView in com.threerings.puzzle.client
+  +

+ + + + + + + + + +
Methods in com.threerings.puzzle.client that return PuzzleBoardView
+ PuzzleBoardViewPuzzlePanel.getBoardView() + +
+          Returns a reference to the PuzzleBoardView in use.
+  +

+ + + + + +
+Uses of PuzzleBoardView in com.threerings.puzzle.drop.client
+  +

+ + + + + + + + + +
Subclasses of PuzzleBoardView in com.threerings.puzzle.drop.client
+ classDropBoardView + +
+          The drop board view displays a drop puzzle game in progress for a single player.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/client/class-use/PuzzleController.ClearPender.html b/apidocs/com/threerings/puzzle/client/class-use/PuzzleController.ClearPender.html new file mode 100644 index 00000000..b7a36699 --- /dev/null +++ b/apidocs/com/threerings/puzzle/client/class-use/PuzzleController.ClearPender.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Interface com.threerings.puzzle.client.PuzzleController.ClearPender (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.puzzle.client.PuzzleController.ClearPender

+
+No usage of com.threerings.puzzle.client.PuzzleController.ClearPender +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/client/class-use/PuzzleController.html b/apidocs/com/threerings/puzzle/client/class-use/PuzzleController.html new file mode 100644 index 00000000..e601ac4a --- /dev/null +++ b/apidocs/com/threerings/puzzle/client/class-use/PuzzleController.html @@ -0,0 +1,232 @@ + + + + + + + +Uses of Class com.threerings.puzzle.client.PuzzleController (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.puzzle.client.PuzzleController

+
+ + + + + + + + + + + + + +
+Packages that use PuzzleController
com.threerings.puzzle.client  
com.threerings.puzzle.drop.client  
+  +

+ + + + + +
+Uses of PuzzleController in com.threerings.puzzle.client
+  +

+ + + + + + + + + +
Methods in com.threerings.puzzle.client with parameters of type PuzzleController
+ voidPuzzleBoardView.setController(PuzzleController pctrl) + +
+          Provides the board view with a reference to its controller so that it may communicate + directly rather than by posting actions up the interface hierarchy which sometimes fails if + the puzzle board view is hidden before we get a chance to post our actions.
+  +

+ + + + + + + + + + + +
Constructors in com.threerings.puzzle.client with parameters of type PuzzleController
PuzzleControllerDelegate(PuzzleController ctrl) + +
+          Constructs a puzzle controller delegate.
PuzzlePanel(PuzzleContext ctx, + PuzzleController controller) + +
+          Constructs a puzzle panel.
+  +

+ + + + + +
+Uses of PuzzleController in com.threerings.puzzle.drop.client
+  +

+ + + + + + + + +
Constructors in com.threerings.puzzle.drop.client with parameters of type PuzzleController
DropControllerDelegate(PuzzleController ctrl, + DropLogic logic) + +
+          Creates a delegate with the specified drop game logic and controller.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/client/class-use/PuzzleControllerDelegate.html b/apidocs/com/threerings/puzzle/client/class-use/PuzzleControllerDelegate.html new file mode 100644 index 00000000..deea8934 --- /dev/null +++ b/apidocs/com/threerings/puzzle/client/class-use/PuzzleControllerDelegate.html @@ -0,0 +1,183 @@ + + + + + + + +Uses of Class com.threerings.puzzle.client.PuzzleControllerDelegate (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.puzzle.client.PuzzleControllerDelegate

+
+ + + + + + + + + +
+Packages that use PuzzleControllerDelegate
com.threerings.puzzle.drop.client  
+  +

+ + + + + +
+Uses of PuzzleControllerDelegate in com.threerings.puzzle.drop.client
+  +

+ + + + + + + + + +
Subclasses of PuzzleControllerDelegate in com.threerings.puzzle.drop.client
+ classDropControllerDelegate + +
+          Games that wish to make use of the drop puzzle services will need to create an extension of + this delegate class, customizing it for their particular game and then adding it via + PlaceController.addDelegate(com.threerings.crowd.client.PlaceControllerDelegate).
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/client/class-use/PuzzleGameService.html b/apidocs/com/threerings/puzzle/client/class-use/PuzzleGameService.html new file mode 100644 index 00000000..0caa7f6c --- /dev/null +++ b/apidocs/com/threerings/puzzle/client/class-use/PuzzleGameService.html @@ -0,0 +1,183 @@ + + + + + + + +Uses of Interface com.threerings.puzzle.client.PuzzleGameService (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.puzzle.client.PuzzleGameService

+
+ + + + + + + + + +
+Packages that use PuzzleGameService
com.threerings.puzzle.data  
+  +

+ + + + + +
+Uses of PuzzleGameService in com.threerings.puzzle.data
+  +

+ + + + + + + + + +
Classes in com.threerings.puzzle.data that implement PuzzleGameService
+ classPuzzleGameMarshaller + +
+          Provides the implementation of the PuzzleGameService interface + that marshalls the arguments and delivers the request to the provider + on the server.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/client/class-use/PuzzlePanel.html b/apidocs/com/threerings/puzzle/client/class-use/PuzzlePanel.html new file mode 100644 index 00000000..c8d856ad --- /dev/null +++ b/apidocs/com/threerings/puzzle/client/class-use/PuzzlePanel.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.puzzle.client.PuzzlePanel (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.puzzle.client.PuzzlePanel

+
+No usage of com.threerings.puzzle.client.PuzzlePanel +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/client/class-use/PuzzlePrefs.html b/apidocs/com/threerings/puzzle/client/class-use/PuzzlePrefs.html new file mode 100644 index 00000000..1a17daa1 --- /dev/null +++ b/apidocs/com/threerings/puzzle/client/class-use/PuzzlePrefs.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.puzzle.client.PuzzlePrefs (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.puzzle.client.PuzzlePrefs

+
+No usage of com.threerings.puzzle.client.PuzzlePrefs +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/client/package-frame.html b/apidocs/com/threerings/puzzle/client/package-frame.html new file mode 100644 index 00000000..56d65203 --- /dev/null +++ b/apidocs/com/threerings/puzzle/client/package-frame.html @@ -0,0 +1,58 @@ + + + + + + + +com.threerings.puzzle.client (vilya 1.3 API) + + + + + + + + + + + +com.threerings.puzzle.client + + + + +
+Interfaces  + +
+PuzzleController.ClearPender +
+PuzzleGameService
+ + + + + + +
+Classes  + +
+PlayerStatusView +
+PuzzleAnimationWaiter +
+PuzzleBoardView +
+PuzzleController +
+PuzzleControllerDelegate +
+PuzzlePanel +
+PuzzlePrefs
+ + + + diff --git a/apidocs/com/threerings/puzzle/client/package-summary.html b/apidocs/com/threerings/puzzle/client/package-summary.html new file mode 100644 index 00000000..2e0b6778 --- /dev/null +++ b/apidocs/com/threerings/puzzle/client/package-summary.html @@ -0,0 +1,203 @@ + + + + + + + +com.threerings.puzzle.client (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.puzzle.client +

+ + + + + + + + + + + + + +
+Interface Summary
PuzzleController.ClearPenderUsed by PuzzleController.fireWhenActionCleared(com.threerings.puzzle.client.PuzzleController.ClearPender).
PuzzleGameServiceProvides services used by puzzle game clients to request that actions be taken by the puzzle + manager.
+  + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Class Summary
PlayerStatusViewThe player status view displays a player's current status in the game.
PuzzleAnimationWaiterAn animation waiter to be used with puzzles that want to modify the game object or board in some + way after the animations end, and would like to do so in a safe fashion such that their changes + aren't unwittingly performed on game data for a subsequent round of the puzzle.
PuzzleBoardViewThe puzzle board view displays a view of a puzzle game.
PuzzleControllerThe puzzle game controller handles logical actions for a puzzle game.
PuzzleControllerDelegateA base class for puzzle controller delegates.
PuzzlePanelThe puzzle panel class should be extended by classes that provide a view for a puzzle game.
PuzzlePrefsProvides access to runtime configuration parameters for this package and its subpackages.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/client/package-tree.html b/apidocs/com/threerings/puzzle/client/package-tree.html new file mode 100644 index 00000000..16c66d21 --- /dev/null +++ b/apidocs/com/threerings/puzzle/client/package-tree.html @@ -0,0 +1,201 @@ + + + + + + + +com.threerings.puzzle.client Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.puzzle.client +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/client/package-use.html b/apidocs/com/threerings/puzzle/client/package-use.html new file mode 100644 index 00000000..0d68124d --- /dev/null +++ b/apidocs/com/threerings/puzzle/client/package-use.html @@ -0,0 +1,228 @@ + + + + + + + +Uses of Package com.threerings.puzzle.client (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.puzzle.client

+
+ + + + + + + + + + + + + + + + + +
+Packages that use com.threerings.puzzle.client
com.threerings.puzzle.client  
com.threerings.puzzle.data  
com.threerings.puzzle.drop.client  
+  +

+ + + + + + + + + + + +
+Classes in com.threerings.puzzle.client used by com.threerings.puzzle.client
PuzzleBoardView + +
+          The puzzle board view displays a view of a puzzle game.
PuzzleController + +
+          The puzzle game controller handles logical actions for a puzzle game.
+  +

+ + + + + + + + +
+Classes in com.threerings.puzzle.client used by com.threerings.puzzle.data
PuzzleGameService + +
+          Provides services used by puzzle game clients to request that actions be taken by the puzzle + manager.
+  +

+ + + + + + + + + + + + + + +
+Classes in com.threerings.puzzle.client used by com.threerings.puzzle.drop.client
PuzzleBoardView + +
+          The puzzle board view displays a view of a puzzle game.
PuzzleController + +
+          The puzzle game controller handles logical actions for a puzzle game.
PuzzleControllerDelegate + +
+          A base class for puzzle controller delegates.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/data/Board.html b/apidocs/com/threerings/puzzle/data/Board.html new file mode 100644 index 00000000..d3ea03f2 --- /dev/null +++ b/apidocs/com/threerings/puzzle/data/Board.html @@ -0,0 +1,439 @@ + + + + + + + +Board (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.puzzle.data +
+Class Board

+
+java.lang.Object
+  extended by com.threerings.puzzle.data.Board
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable, Cloneable
+
+
+
Direct Known Subclasses:
DropBoard
+
+
+
+
public abstract class Board
extends Object
implements Cloneable, com.threerings.io.Streamable
+ + +

+An abstract base class for generating and storing puzzle board data. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + +
+Constructor Summary
Board() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ Boardclone() + +
+           
+abstract  voiddump() + +
+          Outputs a string representation of the board contents.
+abstract  voiddumpAndCompare(Board other) + +
+          Outputs a string representation of the board contents, interlaced with the supplied + comparison board.
+abstract  booleanequals(Board other) + +
+          Returns whether this board is equal to the given comparison board.
+ RandomgetRandom() + +
+          Returns the random number generator used by the board to generate random numbers for our + puzzles.
+ voidinitializeSeed(long seed) + +
+          Sets the seed in the board's random number generator and calls populate().
+ voidseedFromEvent(int pidx, + int gevent) + +
+          Allows puzzles to add extra noise to their random number generators based on the specific + events sent from the client to make it more difficult for a hacked client to predict things + such as piece generation.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+Board

+
+public Board()
+
+
+ + + + + + + + +
+Method Detail
+ +

+dump

+
+public abstract void dump()
+
+
Outputs a string representation of the board contents. +

+

+
+
+
+
+
+
+
+ +

+dumpAndCompare

+
+public abstract void dumpAndCompare(Board other)
+
+
Outputs a string representation of the board contents, interlaced with the supplied + comparison board. +

+

+
+
+
+
+
+
+
+ +

+equals

+
+public abstract boolean equals(Board other)
+
+
Returns whether this board is equal to the given comparison board. +

+

+
+
+
+
+
+
+
+ +

+clone

+
+public Board clone()
+
+
+
Overrides:
clone in class Object
+
+
+
+
+
+
+ +

+initializeSeed

+
+public void initializeSeed(long seed)
+
+
Sets the seed in the board's random number generator and calls populate(). +

+

+
+
+
+
+
+
+
+ +

+getRandom

+
+public Random getRandom()
+
+
Returns the random number generator used by the board to generate random numbers for our + puzzles. +

+

+
+
+
+
+
+
+
+ +

+seedFromEvent

+
+public void seedFromEvent(int pidx,
+                          int gevent)
+
+
Allows puzzles to add extra noise to their random number generators based on the specific + events sent from the client to make it more difficult for a hacked client to predict things + such as piece generation. +

+

+
+
+
+
Parameters:
pidx - the player index that submitted the progress event.
gevent - the progress event itself.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/data/BoardSummary.html b/apidocs/com/threerings/puzzle/data/BoardSummary.html new file mode 100644 index 00000000..a958ab52 --- /dev/null +++ b/apidocs/com/threerings/puzzle/data/BoardSummary.html @@ -0,0 +1,346 @@ + + + + + + + +BoardSummary (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.puzzle.data +
+Class BoardSummary

+
+java.lang.Object
+  extended by com.threerings.io.SimpleStreamableObject
+      extended by com.threerings.puzzle.data.BoardSummary
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable
+
+
+
Direct Known Subclasses:
DropBoardSummary
+
+
+
+
public abstract class BoardSummary
extends com.threerings.io.SimpleStreamableObject
+ + +

+Provides summarized data representing a player's board in a puzzle game. Board summaries are + maintained by the puzzle server and are periodically sent to the clients to give them a view + into how well their opponent(s) are doing. The data required to marshal a board summary object + should be notably smaller in size than what would be required to marshal the entire associated + Board. + +

Note all non-transient members of this and derived classes will automatically be serialized + when the summary is sent over the wire. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + + + + +
+Constructor Summary
BoardSummary() + +
+          Constructs an empty board summary for use when un-serializing.
BoardSummary(Board board) + +
+          Constructs a board summary that retrieves full board information from the supplied board + when summarizing.
+  + + + + + + + + + + + + + + + +
+Method Summary
+ voidsetBoard(Board board) + +
+          Sets the board associated with this board summary, causing an immediate update to this + summary.
+abstract  voidsummarize() + +
+          Called by the PuzzleManager to refresh the board + summary information by studying the associated board contents.
+  + + + + + + + +
Methods inherited from class com.threerings.io.SimpleStreamableObject
toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+BoardSummary

+
+public BoardSummary()
+
+
Constructs an empty board summary for use when un-serializing. +

+

+
+ +

+BoardSummary

+
+public BoardSummary(Board board)
+
+
Constructs a board summary that retrieves full board information from the supplied board + when summarizing. +

+

+ + + + + + + + +
+Method Detail
+ +

+setBoard

+
+public void setBoard(Board board)
+
+
Sets the board associated with this board summary, causing an immediate update to this + summary. +

+

+
+
+
+
+ +

+summarize

+
+public abstract void summarize()
+
+
Called by the PuzzleManager to refresh the board + summary information by studying the associated board contents. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/data/PuzzleCodes.html b/apidocs/com/threerings/puzzle/data/PuzzleCodes.html new file mode 100644 index 00000000..13bd99df --- /dev/null +++ b/apidocs/com/threerings/puzzle/data/PuzzleCodes.html @@ -0,0 +1,272 @@ + + + + + + + +PuzzleCodes (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.puzzle.data +
+Interface PuzzleCodes

+
+
All Superinterfaces:
com.threerings.presents.data.InvocationCodes
+
+
+
All Known Subinterfaces:
PuzzleGameService
+
+
+
All Known Implementing Classes:
DropControllerDelegate, DropManagerDelegate, PuzzleController, PuzzleControllerDelegate, PuzzleGameMarshaller, PuzzleManager, PuzzleObject, PuzzlePanel
+
+
+
+
public interface PuzzleCodes
extends com.threerings.presents.data.InvocationCodes
+ + +

+Constants relating to the puzzle services. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + +
+Field Summary
+static booleanDEBUG_PUZZLE + +
+          Whether to enable debug logging and assertions for puzzles.
+static intDEFAULT_DIFFICULTY + +
+          The default puzzle difficulty level.
+static StringPUZZLE_MESSAGE_BUNDLE + +
+          The message bundle identifier for general puzzle messages.
+  + + + + + + + +
Fields inherited from interface com.threerings.presents.data.InvocationCodes
ACCESS_DENIED, E_ACCESS_DENIED, E_INTERNAL_ERROR, GLOBAL_GROUP, INTERNAL_ERROR
+  +

+ + + + + + + + +
+Field Detail
+ +

+PUZZLE_MESSAGE_BUNDLE

+
+static final String PUZZLE_MESSAGE_BUNDLE
+
+
The message bundle identifier for general puzzle messages. +

+

+
See Also:
Constant Field Values
+
+
+ +

+DEFAULT_DIFFICULTY

+
+static final int DEFAULT_DIFFICULTY
+
+
The default puzzle difficulty level. +

+

+
See Also:
Constant Field Values
+
+
+ +

+DEBUG_PUZZLE

+
+static final boolean DEBUG_PUZZLE
+
+
Whether to enable debug logging and assertions for puzzles. Note that enabling this may + result in the server or client exiting unexpectedly if certain error conditions arise in + order to facilitate debugging, and so this should never be enabled in any environment even + remotely resembling production. +

+

+
See Also:
Constant Field Values
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/data/PuzzleGameCodes.html b/apidocs/com/threerings/puzzle/data/PuzzleGameCodes.html new file mode 100644 index 00000000..028c9e54 --- /dev/null +++ b/apidocs/com/threerings/puzzle/data/PuzzleGameCodes.html @@ -0,0 +1,181 @@ + + + + + + + +PuzzleGameCodes (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.puzzle.data +
+Interface PuzzleGameCodes

+
+
All Known Subinterfaces:
DropCodes
+
+
+
All Known Implementing Classes:
DropControllerDelegate, DropManagerDelegate, PuzzleControllerDelegate, PuzzlePanel
+
+
+
+
public interface PuzzleGameCodes
+ + +

+Contains codes used by the puzzle game client implementations. This differs from + PuzzleCodes as that is related to the puzzle services which span the client and the + server. +

+ +

+

+ +

+ +

+ +

+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/data/PuzzleGameMarshaller.html b/apidocs/com/threerings/puzzle/data/PuzzleGameMarshaller.html new file mode 100644 index 00000000..8b93a42b --- /dev/null +++ b/apidocs/com/threerings/puzzle/data/PuzzleGameMarshaller.html @@ -0,0 +1,434 @@ + + + + + + + +PuzzleGameMarshaller (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.puzzle.data +
+Class PuzzleGameMarshaller

+
+java.lang.Object
+  extended by com.threerings.presents.data.InvocationMarshaller
+      extended by com.threerings.puzzle.data.PuzzleGameMarshaller
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable, com.threerings.presents.client.InvocationService, com.threerings.presents.data.InvocationCodes, PuzzleGameService, PuzzleCodes
+
+
+
+
@Generated(value="com.threerings.presents.tools.GenServiceTask",
+           comments="Derived from PuzzleGameService.java.")
+public class PuzzleGameMarshaller
extends com.threerings.presents.data.InvocationMarshaller
implements PuzzleGameService
+ + +

+Provides the implementation of the PuzzleGameService interface + that marshalls the arguments and delivers the request to the provider + on the server. Also provides an implementation of the response listener + interfaces that marshall the response arguments and deliver them back + to the requesting client. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.presents.data.InvocationMarshaller
com.threerings.presents.data.InvocationMarshaller.ConfirmMarshaller, com.threerings.presents.data.InvocationMarshaller.ListenerMarshaller, com.threerings.presents.data.InvocationMarshaller.ResultMarshaller
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.presents.client.InvocationService
com.threerings.presents.client.InvocationService.ConfirmListener, com.threerings.presents.client.InvocationService.InvocationListener, com.threerings.presents.client.InvocationService.ResultListener
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + + + + + +
+Field Summary
+static intUPDATE_PROGRESS + +
+          The method id used to dispatch updateProgress(int, int[]) requests.
+static intUPDATE_PROGRESS_SYNC + +
+          The method id used to dispatch updateProgressSync(int, int[], com.threerings.puzzle.data.Board[]) requests.
+  + + + + + + + +
Fields inherited from interface com.threerings.puzzle.data.PuzzleCodes
DEBUG_PUZZLE, DEFAULT_DIFFICULTY, PUZZLE_MESSAGE_BUNDLE
+  + + + + + + + +
Fields inherited from interface com.threerings.presents.data.InvocationCodes
ACCESS_DENIED, E_ACCESS_DENIED, E_INTERNAL_ERROR, GLOBAL_GROUP, INTERNAL_ERROR
+  + + + + + + + + + + +
+Constructor Summary
PuzzleGameMarshaller() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ voidupdateProgress(int arg1, + int[] arg2) + +
+          Asks the puzzle manager to apply the supplied progress events for the specified puzzle round + to the player's state.
+ voidupdateProgressSync(int arg1, + int[] arg2, + Board[] arg3) + +
+          Debug variant of PuzzleGameService.updateProgress(int, int[]) that is only used when + PuzzlePanel.isSyncingBoards() is true and which includes the board states associated + with each event.
+  + + + + + + + +
Methods inherited from class com.threerings.presents.data.InvocationMarshaller
getInvocationCode, init, readField__invCode, readField__invOid, readObject, setInvocationOid, setNoResponse, toString, writeField__invCode, writeField__invOid
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+UPDATE_PROGRESS

+
+public static final int UPDATE_PROGRESS
+
+
The method id used to dispatch updateProgress(int, int[]) requests. +

+

+
See Also:
Constant Field Values
+
+
+ +

+UPDATE_PROGRESS_SYNC

+
+public static final int UPDATE_PROGRESS_SYNC
+
+
The method id used to dispatch updateProgressSync(int, int[], com.threerings.puzzle.data.Board[]) requests. +

+

+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Constructor Detail
+ +

+PuzzleGameMarshaller

+
+public PuzzleGameMarshaller()
+
+
+ + + + + + + + +
+Method Detail
+ +

+updateProgress

+
+public void updateProgress(int arg1,
+                           int[] arg2)
+
+
Description copied from interface: PuzzleGameService
+
Asks the puzzle manager to apply the supplied progress events for the specified puzzle round + to the player's state. +

+

+
Specified by:
updateProgress in interface PuzzleGameService
+
+
+
+
+
+
+ +

+updateProgressSync

+
+public void updateProgressSync(int arg1,
+                               int[] arg2,
+                               Board[] arg3)
+
+
Description copied from interface: PuzzleGameService
+
Debug variant of PuzzleGameService.updateProgress(int, int[]) that is only used when + PuzzlePanel.isSyncingBoards() is true and which includes the board states associated + with each event. +

+

+
Specified by:
updateProgressSync in interface PuzzleGameService
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/data/PuzzleObject.html b/apidocs/com/threerings/puzzle/data/PuzzleObject.html new file mode 100644 index 00000000..e5de6bab --- /dev/null +++ b/apidocs/com/threerings/puzzle/data/PuzzleObject.html @@ -0,0 +1,690 @@ + + + + + + + +PuzzleObject (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.puzzle.data +
+Class PuzzleObject

+
+java.lang.Object
+  extended by com.threerings.presents.dobj.DObject
+      extended by com.threerings.crowd.data.PlaceObject
+          extended by com.threerings.parlor.game.data.GameObject
+              extended by com.threerings.puzzle.data.PuzzleObject
+
+
+
All Implemented Interfaces:
com.threerings.crowd.chat.data.SpeakObject, com.threerings.io.Streamable, com.threerings.presents.data.InvocationCodes, PuzzleCodes
+
+
+
+
public class PuzzleObject
extends GameObject
implements PuzzleCodes
+ + +

+Extends the basic GameObject to add individual player status. Puzzle games typically + contain numerous players that may be knocked out of the game while the overall game continues + on, thereby necessitating this second level of game status. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.crowd.data.PlaceObject
com.threerings.crowd.data.PlaceObject.ManagerCaller
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.crowd.chat.data.SpeakObject
com.threerings.crowd.chat.data.SpeakObject.ListenerOp
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+ intdifficulty + +
+          The puzzle difficulty level.
+static StringDIFFICULTY + +
+          The field name of the difficulty field.
+static StringPUZZLE_GAME_SERVICE + +
+          The field name of the puzzleGameService field.
+ PuzzleGameMarshallerpuzzleGameService + +
+          Provides general puzzle game invocation services.
+ longseed + +
+          The seed used to germinate the boards.
+static StringSEED + +
+          The field name of the seed field.
+ BoardSummary[]summaries + +
+          Summaries of the boards of all players in this puzzle (may be null if the puzzle doesn't + support individual player boards).
+static StringSUMMARIES + +
+          The field name of the summaries field.
+  + + + + + + + +
Fields inherited from class com.threerings.parlor.game.data.GameObject
CANCELLED, GAME_OVER, IN_PLAY, IS_PRIVATE, IS_RATED, isPrivate, isRated, PLAYER_IN_PLAY, PLAYER_LEFT_GAME, PLAYER_STATUS, players, PLAYERS, playerStatus, PRE_GAME, SESSION_ID, sessionId, state, STATE, winners, WINNERS
+  + + + + + + + +
Fields inherited from class com.threerings.crowd.data.PlaceObject
manager, OCCUPANT_INFO, occupantInfo, occupants, OCCUPANTS, SPEAK_SERVICE, speakService
+  + + + + + + + +
Fields inherited from interface com.threerings.puzzle.data.PuzzleCodes
DEBUG_PUZZLE, DEFAULT_DIFFICULTY, PUZZLE_MESSAGE_BUNDLE
+  + + + + + + + +
Fields inherited from interface com.threerings.presents.data.InvocationCodes
ACCESS_DENIED, E_ACCESS_DENIED, E_INTERNAL_ERROR, GLOBAL_GROUP, INTERNAL_ERROR
+  + + + + + + + + + + +
+Constructor Summary
PuzzleObject() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidsetDifficulty(int value) + +
+          Requests that the difficulty field be set to the + specified value.
+ voidsetPuzzleGameService(PuzzleGameMarshaller value) + +
+          Requests that the puzzleGameService field be set to the + specified value.
+ voidsetSeed(long value) + +
+          Requests that the seed field be set to the + specified value.
+ voidsetSummaries(BoardSummary[] value) + +
+          Requests that the summaries field be set to the + specified value.
+ voidsetSummariesAt(BoardSummary value, + int index) + +
+          Requests that the indexth element of + summaries field be set to the specified value.
+  + + + + + + + +
Methods inherited from class com.threerings.parlor.game.data.GameObject
getActivePlayerCount, getPlayerCount, getPlayerIndex, getWinnerCount, getWinnerIndex, isActivePlayer, isDraw, isInPlay, isOccupiedPlayer, isWinner, setIsPrivate, setIsRated, setPlayers, setPlayersAt, setPlayerStatus, setPlayerStatusAt, setSessionId, setState, setWinners, setWinnersAt
+  + + + + + + + +
Methods inherited from class com.threerings.crowd.data.PlaceObject
addToOccupantInfo, addToOccupants, applyToListeners, getOccupantInfo, initManagerCaller, removeFromOccupantInfo, removeFromOccupants, setOccupantInfo, setSpeakService, shouldBroadcast, updateOccupantInfo
+  + + + + + + + +
Methods inherited from class com.threerings.presents.dobj.DObject
acquireLock, addListener, addListener, addSubscriber, addToSet, cancelTransaction, changeAttribute, checkPermissions, checkPermissions, commitTransaction, destroy, getAccessController, getAttribute, getLocal, getLocals, getManager, getOid, getSet, inTransaction, isActive, notifyListeners, notifyProxies, postEvent, postMessage, postMessage, readField__oid, releaseLock, removeFromSet, removeListener, removeSubscriber, setAccessController, setAttribute, setDestroyOnLastSubscriberRemoved, setLocal, setManager, setOid, startTransaction, toString, updateSet, which, writeField__oid
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+PUZZLE_GAME_SERVICE

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public static final String PUZZLE_GAME_SERVICE
+
+
The field name of the puzzleGameService field. +

+

+
See Also:
Constant Field Values
+
+
+ +

+DIFFICULTY

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public static final String DIFFICULTY
+
+
The field name of the difficulty field. +

+

+
See Also:
Constant Field Values
+
+
+ +

+SUMMARIES

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public static final String SUMMARIES
+
+
The field name of the summaries field. +

+

+
See Also:
Constant Field Values
+
+
+ +

+SEED

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public static final String SEED
+
+
The field name of the seed field. +

+

+
See Also:
Constant Field Values
+
+
+ +

+puzzleGameService

+
+public PuzzleGameMarshaller puzzleGameService
+
+
Provides general puzzle game invocation services. +

+

+
+
+
+ +

+difficulty

+
+public int difficulty
+
+
The puzzle difficulty level. +

+

+
+
+
+ +

+summaries

+
+public BoardSummary[] summaries
+
+
Summaries of the boards of all players in this puzzle (may be null if the puzzle doesn't + support individual player boards). +

+

+
+
+
+ +

+seed

+
+public long seed
+
+
The seed used to germinate the boards. +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+PuzzleObject

+
+public PuzzleObject()
+
+
+ + + + + + + + +
+Method Detail
+ +

+setPuzzleGameService

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public void setPuzzleGameService(PuzzleGameMarshaller value)
+
+
Requests that the puzzleGameService field be set to the + specified value. The local value will be updated immediately and an + event will be propagated through the system to notify all listeners + that the attribute did change. Proxied copies of this object (on + clients) will apply the value change when they received the + attribute changed notification. +

+

+
+
+
+
+
+
+
+ +

+setDifficulty

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public void setDifficulty(int value)
+
+
Requests that the difficulty field be set to the + specified value. The local value will be updated immediately and an + event will be propagated through the system to notify all listeners + that the attribute did change. Proxied copies of this object (on + clients) will apply the value change when they received the + attribute changed notification. +

+

+
+
+
+
+
+
+
+ +

+setSummaries

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public void setSummaries(BoardSummary[] value)
+
+
Requests that the summaries field be set to the + specified value. The local value will be updated immediately and an + event will be propagated through the system to notify all listeners + that the attribute did change. Proxied copies of this object (on + clients) will apply the value change when they received the + attribute changed notification. +

+

+
+
+
+
+
+
+
+ +

+setSummariesAt

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public void setSummariesAt(BoardSummary value,
+                                     int index)
+
+
Requests that the indexth element of + summaries field be set to the specified value. + The local value will be updated immediately and an event will be + propagated through the system to notify all listeners that the + attribute did change. Proxied copies of this object (on clients) + will apply the value change when they received the attribute + changed notification. +

+

+
+
+
+
+
+
+
+ +

+setSeed

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public void setSeed(long value)
+
+
Requests that the seed field be set to the + specified value. The local value will be updated immediately and an + event will be propagated through the system to notify all listeners + that the attribute did change. Proxied copies of this object (on + clients) will apply the value change when they received the + attribute changed notification. +

+

+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/data/class-use/Board.html b/apidocs/com/threerings/puzzle/data/class-use/Board.html new file mode 100644 index 00000000..c6196472 --- /dev/null +++ b/apidocs/com/threerings/puzzle/data/class-use/Board.html @@ -0,0 +1,496 @@ + + + + + + + +Uses of Class com.threerings.puzzle.data.Board (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.puzzle.data.Board

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
+Packages that use Board
com.threerings.puzzle.client  
com.threerings.puzzle.data  
com.threerings.puzzle.drop.client  
com.threerings.puzzle.drop.data  
com.threerings.puzzle.server  
+  +

+ + + + + +
+Uses of Board in com.threerings.puzzle.client
+  +

+ + + + + + + + + +
Methods in com.threerings.puzzle.client that return Board
+ BoardPuzzleController.getBoard() + +
+          Returns the board associated with the puzzle.
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in com.threerings.puzzle.client with parameters of type Board
+ voidPuzzleController.addProgressEvent(int event, + Board board) + +
+          Adds the given progress event and a snapshot of the supplied board state to the set of + progress events and associated board states for later transmission to the server.
+ voidPuzzleControllerDelegate.setBoard(Board board) + +
+          Called when the puzzle controller sets up a new board for the player.
+ voidPuzzleController.setBoard(Board board) + +
+          Called when a new board is set.
+ voidPuzzleBoardView.setBoard(Board board) + +
+          Sets the board to be displayed.
+ voidPuzzleGameService.updateProgressSync(int sessionId, + int[] events, + Board[] states) + +
+          Debug variant of PuzzleGameService.updateProgress(int, int[]) that is only used when + PuzzlePanel.isSyncingBoards() is true and which includes the board states associated + with each event.
+  +

+ + + + + +
+Uses of Board in com.threerings.puzzle.data
+  +

+ + + + + + + + + +
Methods in com.threerings.puzzle.data that return Board
+ BoardBoard.clone() + +
+           
+  +

+ + + + + + + + + + + + + + + + + + + + + +
Methods in com.threerings.puzzle.data with parameters of type Board
+abstract  voidBoard.dumpAndCompare(Board other) + +
+          Outputs a string representation of the board contents, interlaced with the supplied + comparison board.
+abstract  booleanBoard.equals(Board other) + +
+          Returns whether this board is equal to the given comparison board.
+ voidBoardSummary.setBoard(Board board) + +
+          Sets the board associated with this board summary, causing an immediate update to this + summary.
+ voidPuzzleGameMarshaller.updateProgressSync(int arg1, + int[] arg2, + Board[] arg3) + +
+           
+  +

+ + + + + + + + +
Constructors in com.threerings.puzzle.data with parameters of type Board
BoardSummary(Board board) + +
+          Constructs a board summary that retrieves full board information from the supplied board + when summarizing.
+  +

+ + + + + +
+Uses of Board in com.threerings.puzzle.drop.client
+  +

+ + + + + + + + + + + + + +
Methods in com.threerings.puzzle.drop.client with parameters of type Board
+ voidDropControllerDelegate.setBoard(Board board) + +
+           
+ voidDropBoardView.setBoard(Board board) + +
+           
+  +

+ + + + + +
+Uses of Board in com.threerings.puzzle.drop.data
+  +

+ + + + + + + + + +
Subclasses of Board in com.threerings.puzzle.drop.data
+ classDropBoard + +
+          A class that provides for various useful logical operations to be enacted on a two-dimensional + board and provides an easier mechanism for referencing pieces by position.
+  +

+ + + + + + + + + + + + + + + + + +
Methods in com.threerings.puzzle.drop.data with parameters of type Board
+ voidDropBoard.dumpAndCompare(Board other) + +
+           
+ booleanDropBoard.equals(Board other) + +
+           
+ voidDropBoardSummary.setBoard(Board board) + +
+           
+  +

+ + + + + + + + +
Constructors in com.threerings.puzzle.drop.data with parameters of type Board
DropBoardSummary(Board board) + +
+          Constructs a drop board summary that retrieves board information from the supplied board + when summarizing.
+  +

+ + + + + +
+Uses of Board in com.threerings.puzzle.server
+  +

+ + + + + + + + + +
Methods in com.threerings.puzzle.server that return Board
+ Board[]PuzzleManager.getBoards() + +
+          Returns the boards for all players.
+  +

+ + + + + + + + + + + + + +
Methods in com.threerings.puzzle.server with parameters of type Board
+ voidPuzzleManager.updateProgressSync(com.threerings.presents.data.ClientObject caller, + int sessionId, + int[] events, + Board[] states) + +
+          Called when the puzzle manager receives a progress update.
+ voidPuzzleGameProvider.updateProgressSync(com.threerings.presents.data.ClientObject caller, + int arg1, + int[] arg2, + Board[] arg3) + +
+          Handles a PuzzleGameService.updateProgressSync(int, int[], com.threerings.puzzle.data.Board[]) request.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/data/class-use/BoardSummary.html b/apidocs/com/threerings/puzzle/data/class-use/BoardSummary.html new file mode 100644 index 00000000..db85b652 --- /dev/null +++ b/apidocs/com/threerings/puzzle/data/class-use/BoardSummary.html @@ -0,0 +1,326 @@ + + + + + + + +Uses of Class com.threerings.puzzle.data.BoardSummary (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.puzzle.data.BoardSummary

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
+Packages that use BoardSummary
com.threerings.puzzle.client  
com.threerings.puzzle.data  
com.threerings.puzzle.drop.client  
com.threerings.puzzle.drop.data  
com.threerings.puzzle.server  
+  +

+ + + + + +
+Uses of BoardSummary in com.threerings.puzzle.client
+  +

+ + + + + + + + + +
Methods in com.threerings.puzzle.client with parameters of type BoardSummary
+ voidPlayerStatusView.setBoardSummary(BoardSummary summary) + +
+          Sets the player board summary.
+  +

+ + + + + +
+Uses of BoardSummary in com.threerings.puzzle.data
+  +

+ + + + + + + + + +
Fields in com.threerings.puzzle.data declared as BoardSummary
+ BoardSummary[]PuzzleObject.summaries + +
+          Summaries of the boards of all players in this puzzle (may be null if the puzzle doesn't + support individual player boards).
+  +

+ + + + + + + + + + + + + +
Methods in com.threerings.puzzle.data with parameters of type BoardSummary
+ voidPuzzleObject.setSummaries(BoardSummary[] value) + +
+          Requests that the summaries field be set to the + specified value.
+ voidPuzzleObject.setSummariesAt(BoardSummary value, + int index) + +
+          Requests that the indexth element of + summaries field be set to the specified value.
+  +

+ + + + + +
+Uses of BoardSummary in com.threerings.puzzle.drop.client
+  +

+ + + + + + + + + +
Methods in com.threerings.puzzle.drop.client with parameters of type BoardSummary
+ voidDropPanel.setSummary(int pidx, + BoardSummary summary) + +
+          Updates the board summary display for the given player.
+  +

+ + + + + +
+Uses of BoardSummary in com.threerings.puzzle.drop.data
+  +

+ + + + + + + + + +
Subclasses of BoardSummary in com.threerings.puzzle.drop.data
+ classDropBoardSummary + +
+          Provides a summary of a DropBoard.
+  +

+ + + + + +
+Uses of BoardSummary in com.threerings.puzzle.server
+  +

+ + + + + + + + + +
Methods in com.threerings.puzzle.server that return BoardSummary
+ BoardSummaryPuzzleManager.getBoardSummary(int pidx) + +
+          Returns the board summary for the given player index.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/data/class-use/PuzzleCodes.html b/apidocs/com/threerings/puzzle/data/class-use/PuzzleCodes.html new file mode 100644 index 00000000..26d46a32 --- /dev/null +++ b/apidocs/com/threerings/puzzle/data/class-use/PuzzleCodes.html @@ -0,0 +1,345 @@ + + + + + + + +Uses of Interface com.threerings.puzzle.data.PuzzleCodes (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.puzzle.data.PuzzleCodes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
+Packages that use PuzzleCodes
com.threerings.puzzle.client  
com.threerings.puzzle.data  
com.threerings.puzzle.drop.client  
com.threerings.puzzle.drop.server  
com.threerings.puzzle.server  
+  +

+ + + + + +
+Uses of PuzzleCodes in com.threerings.puzzle.client
+  +

+ + + + + + + + + +
Subinterfaces of PuzzleCodes in com.threerings.puzzle.client
+ interfacePuzzleGameService + +
+          Provides services used by puzzle game clients to request that actions be taken by the puzzle + manager.
+  +

+ + + + + + + + + + + + + + + + + +
Classes in com.threerings.puzzle.client that implement PuzzleCodes
+ classPuzzleController + +
+          The puzzle game controller handles logical actions for a puzzle game.
+ classPuzzleControllerDelegate + +
+          A base class for puzzle controller delegates.
+ classPuzzlePanel + +
+          The puzzle panel class should be extended by classes that provide a view for a puzzle game.
+  +

+ + + + + +
+Uses of PuzzleCodes in com.threerings.puzzle.data
+  +

+ + + + + + + + + + + + + +
Classes in com.threerings.puzzle.data that implement PuzzleCodes
+ classPuzzleGameMarshaller + +
+          Provides the implementation of the PuzzleGameService interface + that marshalls the arguments and delivers the request to the provider + on the server.
+ classPuzzleObject + +
+          Extends the basic GameObject to add individual player status.
+  +

+ + + + + +
+Uses of PuzzleCodes in com.threerings.puzzle.drop.client
+  +

+ + + + + + + + + +
Classes in com.threerings.puzzle.drop.client that implement PuzzleCodes
+ classDropControllerDelegate + +
+          Games that wish to make use of the drop puzzle services will need to create an extension of + this delegate class, customizing it for their particular game and then adding it via + PlaceController.addDelegate(com.threerings.crowd.client.PlaceControllerDelegate).
+  +

+ + + + + +
+Uses of PuzzleCodes in com.threerings.puzzle.drop.server
+  +

+ + + + + + + + + +
Classes in com.threerings.puzzle.drop.server that implement PuzzleCodes
+ classDropManagerDelegate + +
+          Provides the necessary support for a puzzle game that involves a two-dimensional board + containing pieces, with new pieces either falling into the board as a "drop block", or rising + into the bottom of the board in new piece rows, groups of blocks can be "broken" and garbage + can be sent to other players' boards as a result.
+  +

+ + + + + +
+Uses of PuzzleCodes in com.threerings.puzzle.server
+  +

+ + + + + + + + + +
Classes in com.threerings.puzzle.server that implement PuzzleCodes
+ classPuzzleManager + +
+          Extends the GameManager with facilities for puzzle games.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/data/class-use/PuzzleGameCodes.html b/apidocs/com/threerings/puzzle/data/class-use/PuzzleGameCodes.html new file mode 100644 index 00000000..5271560f --- /dev/null +++ b/apidocs/com/threerings/puzzle/data/class-use/PuzzleGameCodes.html @@ -0,0 +1,281 @@ + + + + + + + +Uses of Interface com.threerings.puzzle.data.PuzzleGameCodes (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.puzzle.data.PuzzleGameCodes

+
+ + + + + + + + + + + + + + + + + + + + + +
+Packages that use PuzzleGameCodes
com.threerings.puzzle.client  
com.threerings.puzzle.drop.client  
com.threerings.puzzle.drop.data  
com.threerings.puzzle.drop.server  
+  +

+ + + + + +
+Uses of PuzzleGameCodes in com.threerings.puzzle.client
+  +

+ + + + + + + + + + + + + +
Classes in com.threerings.puzzle.client that implement PuzzleGameCodes
+ classPuzzleControllerDelegate + +
+          A base class for puzzle controller delegates.
+ classPuzzlePanel + +
+          The puzzle panel class should be extended by classes that provide a view for a puzzle game.
+  +

+ + + + + +
+Uses of PuzzleGameCodes in com.threerings.puzzle.drop.client
+  +

+ + + + + + + + + +
Classes in com.threerings.puzzle.drop.client that implement PuzzleGameCodes
+ classDropControllerDelegate + +
+          Games that wish to make use of the drop puzzle services will need to create an extension of + this delegate class, customizing it for their particular game and then adding it via + PlaceController.addDelegate(com.threerings.crowd.client.PlaceControllerDelegate).
+  +

+ + + + + +
+Uses of PuzzleGameCodes in com.threerings.puzzle.drop.data
+  +

+ + + + + + + + + +
Subinterfaces of PuzzleGameCodes in com.threerings.puzzle.drop.data
+ interfaceDropCodes + +
+          Contains codes used by the drop game services.
+  +

+ + + + + +
+Uses of PuzzleGameCodes in com.threerings.puzzle.drop.server
+  +

+ + + + + + + + + +
Classes in com.threerings.puzzle.drop.server that implement PuzzleGameCodes
+ classDropManagerDelegate + +
+          Provides the necessary support for a puzzle game that involves a two-dimensional board + containing pieces, with new pieces either falling into the board as a "drop block", or rising + into the bottom of the board in new piece rows, groups of blocks can be "broken" and garbage + can be sent to other players' boards as a result.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/data/class-use/PuzzleGameMarshaller.html b/apidocs/com/threerings/puzzle/data/class-use/PuzzleGameMarshaller.html new file mode 100644 index 00000000..cd57cf44 --- /dev/null +++ b/apidocs/com/threerings/puzzle/data/class-use/PuzzleGameMarshaller.html @@ -0,0 +1,198 @@ + + + + + + + +Uses of Class com.threerings.puzzle.data.PuzzleGameMarshaller (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.puzzle.data.PuzzleGameMarshaller

+
+ + + + + + + + + +
+Packages that use PuzzleGameMarshaller
com.threerings.puzzle.data  
+  +

+ + + + + +
+Uses of PuzzleGameMarshaller in com.threerings.puzzle.data
+  +

+ + + + + + + + + +
Fields in com.threerings.puzzle.data declared as PuzzleGameMarshaller
+ PuzzleGameMarshallerPuzzleObject.puzzleGameService + +
+          Provides general puzzle game invocation services.
+  +

+ + + + + + + + + +
Methods in com.threerings.puzzle.data with parameters of type PuzzleGameMarshaller
+ voidPuzzleObject.setPuzzleGameService(PuzzleGameMarshaller value) + +
+          Requests that the puzzleGameService field be set to the + specified value.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/data/class-use/PuzzleObject.html b/apidocs/com/threerings/puzzle/data/class-use/PuzzleObject.html new file mode 100644 index 00000000..68b8013f --- /dev/null +++ b/apidocs/com/threerings/puzzle/data/class-use/PuzzleObject.html @@ -0,0 +1,179 @@ + + + + + + + +Uses of Class com.threerings.puzzle.data.PuzzleObject (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.puzzle.data.PuzzleObject

+
+ + + + + + + + + +
+Packages that use PuzzleObject
com.threerings.puzzle.client  
+  +

+ + + + + +
+Uses of PuzzleObject in com.threerings.puzzle.client
+  +

+ + + + + + + + +
Constructors in com.threerings.puzzle.client with parameters of type PuzzleObject
PuzzleAnimationWaiter(PuzzleObject puzobj) + +
+          Constructs a puzzle animation waiter.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/data/package-frame.html b/apidocs/com/threerings/puzzle/data/package-frame.html new file mode 100644 index 00000000..0fb4bba7 --- /dev/null +++ b/apidocs/com/threerings/puzzle/data/package-frame.html @@ -0,0 +1,52 @@ + + + + + + + +com.threerings.puzzle.data (vilya 1.3 API) + + + + + + + + + + + +com.threerings.puzzle.data + + + + +
+Interfaces  + +
+PuzzleCodes +
+PuzzleGameCodes
+ + + + + + +
+Classes  + +
+Board +
+BoardSummary +
+PuzzleGameMarshaller +
+PuzzleObject
+ + + + diff --git a/apidocs/com/threerings/puzzle/data/package-summary.html b/apidocs/com/threerings/puzzle/data/package-summary.html new file mode 100644 index 00000000..ead9745b --- /dev/null +++ b/apidocs/com/threerings/puzzle/data/package-summary.html @@ -0,0 +1,190 @@ + + + + + + + +com.threerings.puzzle.data (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.puzzle.data +

+ + + + + + + + + + + + + +
+Interface Summary
PuzzleCodesConstants relating to the puzzle services.
PuzzleGameCodesContains codes used by the puzzle game client implementations.
+  + +

+ + + + + + + + + + + + + + + + + + + + + +
+Class Summary
BoardAn abstract base class for generating and storing puzzle board data.
BoardSummaryProvides summarized data representing a player's board in a puzzle game.
PuzzleGameMarshallerProvides the implementation of the PuzzleGameService interface + that marshalls the arguments and delivers the request to the provider + on the server.
PuzzleObjectExtends the basic GameObject to add individual player status.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/data/package-tree.html b/apidocs/com/threerings/puzzle/data/package-tree.html new file mode 100644 index 00000000..f4cc07d2 --- /dev/null +++ b/apidocs/com/threerings/puzzle/data/package-tree.html @@ -0,0 +1,178 @@ + + + + + + + +com.threerings.puzzle.data Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.puzzle.data +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/data/package-use.html b/apidocs/com/threerings/puzzle/data/package-use.html new file mode 100644 index 00000000..715d9b67 --- /dev/null +++ b/apidocs/com/threerings/puzzle/data/package-use.html @@ -0,0 +1,358 @@ + + + + + + + +Uses of Package com.threerings.puzzle.data (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.puzzle.data

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Packages that use com.threerings.puzzle.data
com.threerings.puzzle.client  
com.threerings.puzzle.data  
com.threerings.puzzle.drop.client  
com.threerings.puzzle.drop.data  
com.threerings.puzzle.drop.server  
com.threerings.puzzle.server  
+  +

+ + + + + + + + + + + + + + + + + + + + +
+Classes in com.threerings.puzzle.data used by com.threerings.puzzle.client
Board + +
+          An abstract base class for generating and storing puzzle board data.
BoardSummary + +
+          Provides summarized data representing a player's board in a puzzle game.
PuzzleCodes + +
+          Constants relating to the puzzle services.
PuzzleGameCodes + +
+          Contains codes used by the puzzle game client implementations.
PuzzleObject + +
+          Extends the basic GameObject to add individual player status.
+  +

+ + + + + + + + + + + + + + + + + +
+Classes in com.threerings.puzzle.data used by com.threerings.puzzle.data
Board + +
+          An abstract base class for generating and storing puzzle board data.
BoardSummary + +
+          Provides summarized data representing a player's board in a puzzle game.
PuzzleCodes + +
+          Constants relating to the puzzle services.
PuzzleGameMarshaller + +
+          Provides the implementation of the PuzzleGameService interface + that marshalls the arguments and delivers the request to the provider + on the server.
+  +

+ + + + + + + + + + + + + + + + + +
+Classes in com.threerings.puzzle.data used by com.threerings.puzzle.drop.client
Board + +
+          An abstract base class for generating and storing puzzle board data.
BoardSummary + +
+          Provides summarized data representing a player's board in a puzzle game.
PuzzleCodes + +
+          Constants relating to the puzzle services.
PuzzleGameCodes + +
+          Contains codes used by the puzzle game client implementations.
+  +

+ + + + + + + + + + + + + + +
+Classes in com.threerings.puzzle.data used by com.threerings.puzzle.drop.data
Board + +
+          An abstract base class for generating and storing puzzle board data.
BoardSummary + +
+          Provides summarized data representing a player's board in a puzzle game.
PuzzleGameCodes + +
+          Contains codes used by the puzzle game client implementations.
+  +

+ + + + + + + + + + + +
+Classes in com.threerings.puzzle.data used by com.threerings.puzzle.drop.server
PuzzleCodes + +
+          Constants relating to the puzzle services.
PuzzleGameCodes + +
+          Contains codes used by the puzzle game client implementations.
+  +

+ + + + + + + + + + + + + + +
+Classes in com.threerings.puzzle.data used by com.threerings.puzzle.server
Board + +
+          An abstract base class for generating and storing puzzle board data.
BoardSummary + +
+          Provides summarized data representing a player's board in a puzzle game.
PuzzleCodes + +
+          Constants relating to the puzzle services.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/client/DropBlockSprite.html b/apidocs/com/threerings/puzzle/drop/client/DropBlockSprite.html new file mode 100644 index 00000000..3dc1644c --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/client/DropBlockSprite.html @@ -0,0 +1,628 @@ + + + + + + + +DropBlockSprite (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.puzzle.drop.client +
+Class DropBlockSprite

+
+java.lang.Object
+  extended by com.threerings.media.AbstractMedia
+      extended by com.threerings.media.sprite.Sprite
+          extended by com.threerings.puzzle.drop.client.DropSprite
+              extended by com.threerings.puzzle.drop.client.DropBlockSprite
+
+
+
All Implemented Interfaces:
com.threerings.media.util.Pathable, com.threerings.util.DirectionCodes, Shape
+
+
+
+
public class DropBlockSprite
extends DropSprite
+ + +

+The drop block sprite represents a block of multiple pieces that can be rotated to any of the + four cardinal compass directions. As such, it may span multiple columns or rows depending on + its orientation. The block has a "central" piece around which it rotates, with the other pieces + referred to as "external" pieces. +

+ +

+

+ +

+ + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class com.threerings.media.AbstractMedia
HUD_LAYER
+  + + + + + + + +
Fields inherited from interface com.threerings.util.DirectionCodes
CARDINAL_DIRECTIONS, CCW, CW, DIRECTION_COUNT, DOWN, EAST, EASTNORTHEAST, EASTSOUTHEAST, FINE_DIRECTION_COUNT, HORIZONTAL, LEFT, NONE, NORTH, NORTHEAST, NORTHNORTHEAST, NORTHNORTHWEST, NORTHWEST, RIGHT, SOUTH, SOUTHEAST, SOUTHSOUTHEAST, SOUTHSOUTHWEST, SOUTHWEST, UP, VERTICAL, WEST, WESTNORTHWEST, WESTSOUTHWEST
+  + + + + + + + + + + + + + +
+Constructor Summary
DropBlockSprite(DropBoardView view, + int col, + int row, + int orient, + int[] pieces) + +
+          Constructs a drop block sprite and starts it dropping.
DropBlockSprite(DropBoardView view, + int col, + int row, + int orient, + int[] pieces, + int renderOrder) + +
+          Constructs a drop block sprite and starts it dropping.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ booleancanPopup() + +
+          Can this sprite pop-up a row on a forgiving rotation?
+ voiddidPopup() + +
+          Called if we pop up to decrement the remaining popups we have.
+ RectanglegetBoardBounds() + +
+          Returns the bounds of the block in board piece coordinates.
+ int[]getColumns() + +
+          Returns an array of the column numbers containing the block pieces.
+ intgetExternalColumn() + +
+          Returns the column the external piece is located in.
+ intgetExternalRow() + +
+          Returns the row the external piece is located in.
+ int[]getRows() + +
+          Returns an array of the row numbers containing the block pieces.
+ voidsetBoardLocation(int row, + int col) + +
+          Sets the row and column the piece is located in.
+ voidsetColumn(int col) + +
+          Sets the column the piece is located in.
+ voidsetOrientation(int orient) + +
+          Updates the sprite image offset to reflect the direction in which the external piece is + hanging.
+ voidsetRow(int row) + +
+          Set the row the piece is located in.
+ voidtoString(StringBuilder buf) + +
+           
+  + + + + + + + +
Methods inherited from class com.threerings.puzzle.drop.client.DropSprite
drop, fastForward, getColumn, getDistance, getPercentDone, getPieces, getRow, getVelocity, inside, isBouncing, isDropping, paint, setBouncing, setColumnOffset, setPieces, setRowOffset, setVelocity, stop, tick
+  + + + + + + + +
Methods inherited from class com.threerings.media.sprite.Sprite
addSpriteObserver, cancelMove, contains, getHeight, getOrientation, getPath, getWidth, getX, getXOffset, getY, getYOffset, hitTest, intersects, isMoving, move, paintPath, pathBeginning, pathCompleted, removeSpriteObserver, setLocation, viewLocationDidChange
+  + + + + + + + +
Methods inherited from class com.threerings.media.AbstractMedia
contains, contains, contains, contains, getBounds, getBounds2D, getPathIterator, getPathIterator, getRenderOrder, init, intersects, intersects, invalidate, queueNotification, renderCompareTo, setRenderOrder, toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  + + + + + + + +
Methods inherited from interface com.threerings.media.util.Pathable
getBounds
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+DropBlockSprite

+
+public DropBlockSprite(DropBoardView view,
+                       int col,
+                       int row,
+                       int orient,
+                       int[] pieces)
+
+
Constructs a drop block sprite and starts it dropping. +

+

+
Parameters:
view - the board view upon which this sprite will be displayed.
col - the column of the central piece.
row - the row of the central piece.
orient - the orientation of the sprite.
pieces - the pieces displayed by the sprite.
+
+
+ +

+DropBlockSprite

+
+public DropBlockSprite(DropBoardView view,
+                       int col,
+                       int row,
+                       int orient,
+                       int[] pieces,
+                       int renderOrder)
+
+
Constructs a drop block sprite and starts it dropping. +

+

+
Parameters:
view - the board view upon which this sprite will be displayed.
col - the column of the central piece.
row - the row of the central piece.
orient - the orientation of the sprite.
pieces - the pieces displayed by the sprite.
renderOrder - the rendering order of the sprite.
+
+ + + + + + + + +
+Method Detail
+ +

+getRows

+
+public int[] getRows()
+
+
Returns an array of the row numbers containing the block pieces. The first index is the row + of the central piece. The array is cached and re-used internally and so the caller should + make their own copy if they care to modify it. +

+

+
+
+
+
+ +

+getColumns

+
+public int[] getColumns()
+
+
Returns an array of the column numbers containing the block pieces. The first index is the + column of the central piece. The array is cached and re-used internally and so the caller + should make their own copy if they care to modify it. +

+

+
+
+
+
+ +

+getBoardBounds

+
+public Rectangle getBoardBounds()
+
+
Returns the bounds of the block in board piece coordinates. The bounds rectangle is cached + and re-used internally and so the caller should make their own copy if they care to modify + it. +

+

+
+
+
+
+ +

+getExternalRow

+
+public int getExternalRow()
+
+
Returns the row the external piece is located in. +

+

+
+
+
+
+ +

+getExternalColumn

+
+public int getExternalColumn()
+
+
Returns the column the external piece is located in. +

+

+
+
+
+
+ +

+setColumn

+
+public void setColumn(int col)
+
+
Description copied from class: DropSprite
+
Sets the column the piece is located in. +

+

+
Overrides:
setColumn in class DropSprite
+
+
+
+
+
+
+ +

+setRow

+
+public void setRow(int row)
+
+
Description copied from class: DropSprite
+
Set the row the piece is located in. +

+

+
Overrides:
setRow in class DropSprite
+
+
+
+
+
+
+ +

+setBoardLocation

+
+public void setBoardLocation(int row,
+                             int col)
+
+
Description copied from class: DropSprite
+
Sets the row and column the piece is located in. +

+

+
Overrides:
setBoardLocation in class DropSprite
+
+
+
+
+
+
+ +

+setOrientation

+
+public void setOrientation(int orient)
+
+
Updates the sprite image offset to reflect the direction in which the external piece is + hanging. +

+

+
Specified by:
setOrientation in interface com.threerings.media.util.Pathable
Overrides:
setOrientation in class DropSprite
+
+
+
+
+
+
+ +

+toString

+
+public void toString(StringBuilder buf)
+
+
+
Overrides:
toString in class DropSprite
+
+
+
+
+
+
+ +

+canPopup

+
+public boolean canPopup()
+
+
Can this sprite pop-up a row on a forgiving rotation? +

+

+
+
+
+
+ +

+didPopup

+
+public void didPopup()
+
+
Called if we pop up to decrement the remaining popups we have. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/client/DropBoardView.html b/apidocs/com/threerings/puzzle/drop/client/DropBoardView.html new file mode 100644 index 00000000..d1a4bce7 --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/client/DropBoardView.html @@ -0,0 +1,1165 @@ + + + + + + + +DropBoardView (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.puzzle.drop.client +
+Class DropBoardView

+
+java.lang.Object
+  extended by java.awt.Component
+      extended by java.awt.Container
+          extended by javax.swing.JComponent
+              extended by com.threerings.media.MediaPanel
+                  extended by com.threerings.media.VirtualMediaPanel
+                      extended by com.threerings.puzzle.client.PuzzleBoardView
+                          extended by com.threerings.puzzle.drop.client.DropBoardView
+
+
+
All Implemented Interfaces:
com.threerings.media.FrameParticipant, com.threerings.media.MediaConstants, com.threerings.media.MediaHost, DropPieceCodes, com.threerings.util.DirectionCodes, ImageObserver, MenuContainer, Serializable
+
+
+
+
public abstract class DropBoardView
extends PuzzleBoardView
implements DropPieceCodes
+ + +

+The drop board view displays a drop puzzle game in progress for a single player. +

+ +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.media.MediaPanel
com.threerings.media.MediaPanel.Obscurer
+  + + + + + + + + +
Nested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent
+  + + + + + + + + +
Nested classes/interfaces inherited from class java.awt.Component
Component.BaselineResizeBehavior
+  + + + + + + + + + + + + + + + +
+Field Summary
+static ColorCHAIN_COLOR + +
+          The color used to render chain reward scoring text.
+static ColorSCORE_COLOR + +
+          The color used to render normal scoring text.
+  + + + + + + + +
Fields inherited from class com.threerings.media.VirtualMediaPanel
CENTER_ON_PATHABLE, ENCLOSE_PATHABLE, TRACK_PATHABLE
+  + + + + + + + +
Fields inherited from class javax.swing.JComponent
TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
+  + + + + + + + +
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
+  + + + + + + + +
Fields inherited from interface com.threerings.puzzle.drop.data.DropPieceCodes
DROP_BLOCK_PIECE_COUNT, PIECE_NONE
+  + + + + + + + +
Fields inherited from interface com.threerings.util.DirectionCodes
CARDINAL_DIRECTIONS, CCW, CW, DIRECTION_COUNT, DOWN, EAST, EASTNORTHEAST, EASTSOUTHEAST, FINE_DIRECTION_COUNT, HORIZONTAL, LEFT, NONE, NORTH, NORTHEAST, NORTHNORTHEAST, NORTHNORTHWEST, NORTHWEST, RIGHT, SOUTH, SOUTHEAST, SOUTHSOUTHEAST, SOUTHSOUTHWEST, SOUTHWEST, UP, VERTICAL, WEST, WESTNORTHWEST, WESTSOUTHWEST
+  + + + + + + + +
Fields inherited from interface com.threerings.media.MediaConstants
ALL, BACK, FRONT
+  + + + + + + + +
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
+  + + + + + + + + + + +
+Constructor Summary
DropBoardView(PuzzleContext ctx, + int pwid, + int phei) + +
+          Constructs a drop board view.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidclearPiece(int xx, + int yy) + +
+          Clears out a piece from the board along with its piece sprite.
+ voidclearPieceSprite(int xx, + int yy) + +
+          Clears the specified piece from the board.
+ voidcreatePiece(int piece, + int sx, + int sy) + +
+          Creates a new piece sprite and places it directly in its correct position.
+ voidcreatePiece(int piece, + int sx, + int sy, + int tx, + int ty, + long duration) + +
+          Creates a new piece sprite and moves it into position on the board.
+ DropSpritecreatePieces(int col, + int row, + int[] pieces, + int dist) + +
+          Creates a new drop sprite used to animate the given pieces falling in the specified column.
+ ScoreAnimationcreateScoreAnimation(String score, + Color color, + Font font) + +
+          Creates and returns an animation showing the specified score floating up the view, with the + label initially centered within the view.
+ ScoreAnimationcreateScoreAnimation(String score, + Color color, + Font font, + int x, + int y, + int width, + int height) + +
+          Creates and returns an animation showing the specified score floating up the view.
+ voiddirtySegment(int dir, + int col, + int row, + int len) + +
+          Dirties the rectangle encompassing the segment with the given direction and length whose + bottom-leftmost corner is at (col, row).
+ intgetPieceHeight() + +
+          Returns the height in pixels of a single board piece.
+ com.threerings.media.image.MiragegetPieceImage(int piece) + +
+          Returns the image used to display the given piece at coordinates (0, 0) with + an orientation of DirectionCodes.NORTH.
+abstract  com.threerings.media.image.MiragegetPieceImage(int piece, + int col, + int row, + int orient) + +
+          Returns the image used to display the given piece at the specified column and row with the + given orientation.
+ voidgetPiecePosition(int col, + int row, + Point pos) + +
+          Called by the DropSprite to populate pos with the screen coordinates + in pixels at which a piece at (col, row) in the board should be drawn.
+ DimensiongetPieceSegmentSize(int col, + int row, + int orient, + int len) + +
+          Called by the DropSprite to get the dimensions of the area that will be occupied by + rendering a piece segment of the given orientation and length whose bottom-leftmost corner + is at (col, row).
+ com.threerings.media.sprite.SpritegetPieceSprite(int xx, + int yy) + +
+          Returns the piece sprite at the specified location.
+ intgetPieceWidth() + +
+          Returns the width in pixels of a single board piece.
+ DimensiongetPreferredSize() + +
+           
+ booleaninBounds(int col, + int row) + +
+          Returns true if the specified coordinate is within the bounds of the board, false if it is + not.
+ voidinit(GameConfig config) + +
+          Initializes the board with the board dimensions.
+ com.threerings.media.sprite.SpritemovePiece(int sx, + int sy, + int tx, + int ty, + long duration) + +
+          Instructs the view to move the piece at the specified starting position to the specified + destination position.
+ voidpaintBetween(Graphics2D gfx, + Rectangle dirtyRect) + +
+           
+ voidrotateDropBlock(DropBlockSprite sprite, + int orient) + +
+          Rotates the given drop block sprite to the specified orientation, updating the image as + necessary.
+ voidsetBoard(Board board) + +
+          Sets the board to be displayed.
+ voidupdatePiece(int sx, + int sy) + +
+          Refreshes the piece sprite at the specified location, if no sprite exists at the location, + one will be created.
+ voidupdatePiece(int piece, + int sx, + int sy) + +
+          Updates the piece sprite at the specified location, if no sprite exists at the location, + one will be created.
+  + + + + + + + +
Methods inherited from class com.threerings.puzzle.client.PuzzleBoardView
abortAnimation, addActionAnimation, addActionSprite, clearAnimations, clearSprites, createScoreAnimation, dumpActors, getActionAnimationCount, getActionCount, getActionSpriteCount, paintBehind, removeSprite, setBackgroundImage, setController, setPaused, trackAvoidAnimation
+  + + + + + + + +
Methods inherited from class com.threerings.media.VirtualMediaPanel
addViewTracker, clearPathable, doLayout, getViewBounds, removeViewTracker, setBackground, setBounds, setFollowsPathable, setViewLocation
+  + + + + + + + +
Methods inherited from class com.threerings.media.MediaPanel
addAnimation, addObscurer, addSprite, createGraphics, getAnimationManager, getComponent, getRegionManager, getSpriteManager, getTimeStamp, isManaged, isManaged, needsPaint, paint, removeObscurer, repaint, setOpaque, tick
+  + + + + + + + +
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI
+  + + + + + + + +
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate
+  + + + + + + + +
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+SCORE_COLOR

+
+public static final Color SCORE_COLOR
+
+
The color used to render normal scoring text. +

+

+
+
+
+ +

+CHAIN_COLOR

+
+public static final Color CHAIN_COLOR
+
+
The color used to render chain reward scoring text. +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+DropBoardView

+
+public DropBoardView(PuzzleContext ctx,
+                     int pwid,
+                     int phei)
+
+
Constructs a drop board view. +

+

+ + + + + + + + +
+Method Detail
+ +

+init

+
+public void init(GameConfig config)
+
+
Initializes the board with the board dimensions. +

+

+
Overrides:
init in class PuzzleBoardView
+
+
+
+
+
+
+ +

+getPieceWidth

+
+public int getPieceWidth()
+
+
Returns the width in pixels of a single board piece. +

+

+
+
+
+
+
+
+
+ +

+getPieceHeight

+
+public int getPieceHeight()
+
+
Returns the height in pixels of a single board piece. +

+

+
+
+
+
+
+
+
+ +

+getPiecePosition

+
+public void getPiecePosition(int col,
+                             int row,
+                             Point pos)
+
+
Called by the DropSprite to populate pos with the screen coordinates + in pixels at which a piece at (col, row) in the board should be drawn. Derived + classes may wish to override this method to allow specialized positioning of sprites. +

+

+
+
+
+
+
+
+
+ +

+getPieceSegmentSize

+
+public Dimension getPieceSegmentSize(int col,
+                                     int row,
+                                     int orient,
+                                     int len)
+
+
Called by the DropSprite to get the dimensions of the area that will be occupied by + rendering a piece segment of the given orientation and length whose bottom-leftmost corner + is at (col, row). +

+

+
+
+
+
+
+
+
+ +

+createPiece

+
+public void createPiece(int piece,
+                        int sx,
+                        int sy)
+
+
Creates a new piece sprite and places it directly in its correct position. +

+

+
+
+
+
+
+
+
+ +

+updatePiece

+
+public void updatePiece(int sx,
+                        int sy)
+
+
Refreshes the piece sprite at the specified location, if no sprite exists at the location, + one will be created. Note: this method assumes the default ImageSprite is + being used to display pieces. If createPieceSprite(int, int, int) is overridden to return a + non-ImageSprite, this method must also be customized. +

+

+
+
+
+
+
+
+
+ +

+updatePiece

+
+public void updatePiece(int piece,
+                        int sx,
+                        int sy)
+
+
Updates the piece sprite at the specified location, if no sprite exists at the location, + one will be created. Note: this method assumes the default ImageSprite is + being used to display pieces. If createPieceSprite(int, int, int) is overridden to return a + non-ImageSprite, this method must also be customized. +

+

+
+
+
+
+
+
+
+ +

+createPiece

+
+public void createPiece(int piece,
+                        int sx,
+                        int sy,
+                        int tx,
+                        int ty,
+                        long duration)
+
+
Creates a new piece sprite and moves it into position on the board. +

+

+
+
+
+
+
+
+
+ +

+movePiece

+
+public com.threerings.media.sprite.Sprite movePiece(int sx,
+                                                    int sy,
+                                                    int tx,
+                                                    int ty,
+                                                    long duration)
+
+
Instructs the view to move the piece at the specified starting position to the specified + destination position. There must be a sprite at the starting position, if there is a sprite + at the destination position, it must also be moved immediately following this call (as in + the case of a swap) to avoid badness. +

+

+
+
+
+ +
Returns:
the piece sprite that is being moved.
+
+
+
+ +

+getPieceImage

+
+public com.threerings.media.image.Mirage getPieceImage(int piece)
+
+
Returns the image used to display the given piece at coordinates (0, 0) with + an orientation of DirectionCodes.NORTH. This serves as a convenience routine for those puzzles + that don't bother rendering their pieces differently when placed at different board + coordinates or in different orientations. +

+

+
+
+
+
+
+
+
+ +

+getPieceImage

+
+public abstract com.threerings.media.image.Mirage getPieceImage(int piece,
+                                                                int col,
+                                                                int row,
+                                                                int orient)
+
+
Returns the image used to display the given piece at the specified column and row with the + given orientation. +

+

+
+
+
+
+
+
+
+ +

+setBoard

+
+public void setBoard(Board board)
+
+
Description copied from class: PuzzleBoardView
+
Sets the board to be displayed. +

+

+
Overrides:
setBoard in class PuzzleBoardView
+
+
+
+
+
+
+ +

+getPieceSprite

+
+public com.threerings.media.sprite.Sprite getPieceSprite(int xx,
+                                                         int yy)
+
+
Returns the piece sprite at the specified location. +

+

+
+
+
+
+
+
+
+ +

+clearPieceSprite

+
+public void clearPieceSprite(int xx,
+                             int yy)
+
+
Clears the specified piece from the board. +

+

+
+
+
+
+
+
+
+ +

+clearPiece

+
+public void clearPiece(int xx,
+                       int yy)
+
+
Clears out a piece from the board along with its piece sprite. +

+

+
+
+
+
+
+
+
+ +

+createPieces

+
+public DropSprite createPieces(int col,
+                               int row,
+                               int[] pieces,
+                               int dist)
+
+
Creates a new drop sprite used to animate the given pieces falling in the specified column. +

+

+
+
+
+
+
+
+
+ +

+dirtySegment

+
+public void dirtySegment(int dir,
+                         int col,
+                         int row,
+                         int len)
+
+
Dirties the rectangle encompassing the segment with the given direction and length whose + bottom-leftmost corner is at (col, row). +

+

+
+
+
+
+
+
+
+ +

+createScoreAnimation

+
+public ScoreAnimation createScoreAnimation(String score,
+                                           Color color,
+                                           Font font)
+
+
Creates and returns an animation showing the specified score floating up the view, with the + label initially centered within the view. +

+

+
+
+
+
Parameters:
score - the score text to display.
color - the color of the text.
font - the font.
+
+
+
+ +

+createScoreAnimation

+
+public ScoreAnimation createScoreAnimation(String score,
+                                           Color color,
+                                           Font font,
+                                           int x,
+                                           int y,
+                                           int width,
+                                           int height)
+
+
Creates and returns an animation showing the specified score floating up the view. +

+

+
+
+
+
Parameters:
score - the score text to display.
color - the color of the text.
font - the font to use.
x - the left coordinate in board coordinates of the rectangle within which the score + is to be centered.
y - the bottom coordinate in board coordinates of the rectangle within which the score + is to be centered.
width - the width in board coordinates of the rectangle within which the score is to + be centered.
height - the height in board coordinates of the rectangle within which the score is to + be centered.
+
+
+
+ +

+rotateDropBlock

+
+public void rotateDropBlock(DropBlockSprite sprite,
+                            int orient)
+
+
Rotates the given drop block sprite to the specified orientation, updating the image as + necessary. Derived classes that make use of block dropping functionality should override + this method to do the right thing. +

+

+
+
+
+
+
+
+
+ +

+paintBetween

+
+public void paintBetween(Graphics2D gfx,
+                         Rectangle dirtyRect)
+
+
+
Overrides:
paintBetween in class PuzzleBoardView
+
+
+
+
+
+
+ +

+getPreferredSize

+
+public Dimension getPreferredSize()
+
+
+
Overrides:
getPreferredSize in class JComponent
+
+
+
+
+
+
+ +

+inBounds

+
+public boolean inBounds(int col,
+                        int row)
+
+
Returns true if the specified coordinate is within the bounds of the board, false if it is + not. +

+

+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/client/DropControllerDelegate.html b/apidocs/com/threerings/puzzle/drop/client/DropControllerDelegate.html new file mode 100644 index 00000000..a01dea4f --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/client/DropControllerDelegate.html @@ -0,0 +1,733 @@ + + + + + + + +DropControllerDelegate (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.puzzle.drop.client +
+Class DropControllerDelegate

+
+java.lang.Object
+  extended by com.threerings.crowd.client.PlaceControllerDelegate
+      extended by com.threerings.parlor.game.client.GameControllerDelegate
+          extended by com.threerings.puzzle.client.PuzzleControllerDelegate
+              extended by com.threerings.puzzle.drop.client.DropControllerDelegate
+
+
+
All Implemented Interfaces:
com.threerings.media.FrameParticipant, com.threerings.presents.data.InvocationCodes, PuzzleCodes, PuzzleGameCodes, DropCodes, DropPieceCodes, com.threerings.util.DirectionCodes
+
+
+
+
public abstract class DropControllerDelegate
extends PuzzleControllerDelegate
implements DropCodes, DropPieceCodes, com.threerings.media.FrameParticipant
+ + +

+Games that wish to make use of the drop puzzle services will need to create an extension of + this delegate class, customizing it for their particular game and then adding it via + PlaceController.addDelegate(com.threerings.crowd.client.PlaceControllerDelegate). + +

It handles logical actions for a puzzle game that generally consists of a two-dimensional + board containing pieces, with new pieces either falling into the board as a "drop block", or + rising into the bottom of the board in new piece rows. + +

Derived classes must implement getPieceVelocity(boolean) and evolveBoard(). + +

Block-dropping puzzles will likely want to override createNextBlock(), + blockDidLand(), and getPieceDropLogic(). + +

Board-rising puzzles will likely want to override getRiseVelocity(), + getRiseDistance(), getPieceDropLogic(), and boardDidRise(). +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static StringEND_DROP_BLOCK + +
+          The action command for ending dropping the block.
+static StringMOVE_BLOCK_LEFT + +
+          The action command for moving the block to the left.
+static StringMOVE_BLOCK_RIGHT + +
+          The action command for moving the block to the right.
+static StringRAISE_ROW + +
+          The action command for raising the next rising row.
+static StringROTATE_BLOCK_CCW + +
+          The action command for rotating the block counter-clockwise.
+static StringROTATE_BLOCK_CW + +
+          The action command for rotating the block clockwise.
+static StringSTART_DROP_BLOCK + +
+          The action command for starting to dropping the block.
+  + + + + + + + +
Fields inherited from interface com.threerings.puzzle.drop.data.DropCodes
DROP_MESSAGE_BUNDLE, DROP_STREAM, RISE_STREAM
+  + + + + + + + +
Fields inherited from interface com.threerings.puzzle.drop.data.DropPieceCodes
DROP_BLOCK_PIECE_COUNT, PIECE_NONE
+  + + + + + + + +
Fields inherited from interface com.threerings.util.DirectionCodes
CARDINAL_DIRECTIONS, CCW, CW, DIRECTION_COUNT, DOWN, EAST, EASTNORTHEAST, EASTSOUTHEAST, FINE_DIRECTION_COUNT, HORIZONTAL, LEFT, NONE, NORTH, NORTHEAST, NORTHNORTHEAST, NORTHNORTHWEST, NORTHWEST, RIGHT, SOUTH, SOUTHEAST, SOUTHSOUTHEAST, SOUTHSOUTHWEST, SOUTHWEST, UP, VERTICAL, WEST, WESTNORTHWEST, WESTSOUTHWEST
+  + + + + + + + +
Fields inherited from interface com.threerings.puzzle.data.PuzzleCodes
DEBUG_PUZZLE, DEFAULT_DIFFICULTY, PUZZLE_MESSAGE_BUNDLE
+  + + + + + + + +
Fields inherited from interface com.threerings.presents.data.InvocationCodes
ACCESS_DENIED, E_ACCESS_DENIED, E_INTERNAL_ERROR, GLOBAL_GROUP, INTERNAL_ERROR
+  + + + + + + + + + + +
+Constructor Summary
DropControllerDelegate(PuzzleController ctrl, + DropLogic logic) + +
+          Creates a delegate with the specified drop game logic and controller.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidgameDidEnd() + +
+          Called when the game transitions to the GAME_OVER + state.
+ ComponentgetComponent() + +
+           
+ booleanhandleAction(ActionEvent action) + +
+           
+ voidinit(com.threerings.crowd.util.CrowdContext ctx, + com.threerings.crowd.data.PlaceConfig config) + +
+           
+ booleanneedsPaint() + +
+           
+ voidsetBoard(Board board) + +
+          Called when the puzzle controller sets up a new board for the player.
+ voidsetRisingPaused(boolean paused) + +
+          Sets whether the board rising is paused.
+ voidtick(long tickStamp) + +
+           
+ voidupdateSelfSummary() + +
+          Updates the player's own local board summary to reflect the local copy of the player's + board which is likely to be more up to date than the server-side board from which all other + player board summaries originate.
+ voidzipToNextRow() + +
+          Causes the board to zip quickly to the next row.
+  + + + + + + + +
Methods inherited from class com.threerings.puzzle.client.PuzzleControllerDelegate
didLeavePlace, playerKnockedOut, setChatting, willEnterPlace
+  + + + + + + + +
Methods inherited from class com.threerings.parlor.game.client.GameControllerDelegate
gameDidStart, gameWasCancelled, gameWillReset
+  + + + + + + + +
Methods inherited from class com.threerings.crowd.client.PlaceControllerDelegate
mayLeavePlace
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+MOVE_BLOCK_LEFT

+
+public static final String MOVE_BLOCK_LEFT
+
+
The action command for moving the block to the left. +

+

+
See Also:
Constant Field Values
+
+
+ +

+MOVE_BLOCK_RIGHT

+
+public static final String MOVE_BLOCK_RIGHT
+
+
The action command for moving the block to the right. +

+

+
See Also:
Constant Field Values
+
+
+ +

+ROTATE_BLOCK_CCW

+
+public static final String ROTATE_BLOCK_CCW
+
+
The action command for rotating the block counter-clockwise. +

+

+
See Also:
Constant Field Values
+
+
+ +

+ROTATE_BLOCK_CW

+
+public static final String ROTATE_BLOCK_CW
+
+
The action command for rotating the block clockwise. +

+

+
See Also:
Constant Field Values
+
+
+ +

+START_DROP_BLOCK

+
+public static final String START_DROP_BLOCK
+
+
The action command for starting to dropping the block. +

+

+
See Also:
Constant Field Values
+
+
+ +

+END_DROP_BLOCK

+
+public static final String END_DROP_BLOCK
+
+
The action command for ending dropping the block. +

+

+
See Also:
Constant Field Values
+
+
+ +

+RAISE_ROW

+
+public static final String RAISE_ROW
+
+
The action command for raising the next rising row. +

+

+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Constructor Detail
+ +

+DropControllerDelegate

+
+public DropControllerDelegate(PuzzleController ctrl,
+                              DropLogic logic)
+
+
Creates a delegate with the specified drop game logic and controller. +

+

+ + + + + + + + +
+Method Detail
+ +

+init

+
+public void init(com.threerings.crowd.util.CrowdContext ctx,
+                 com.threerings.crowd.data.PlaceConfig config)
+
+
+
Overrides:
init in class com.threerings.crowd.client.PlaceControllerDelegate
+
+
+
+
+
+
+ +

+gameDidEnd

+
+public void gameDidEnd()
+
+
Description copied from class: GameControllerDelegate
+
Called when the game transitions to the GAME_OVER + state. This happens when the game reaches some end condition by + normal means (is not cancelled or aborted). +

+

+
Overrides:
gameDidEnd in class GameControllerDelegate
+
+
+
+
+
+
+ +

+handleAction

+
+public boolean handleAction(ActionEvent action)
+
+
+
Overrides:
handleAction in class com.threerings.crowd.client.PlaceControllerDelegate
+
+
+
+
+
+
+ +

+setBoard

+
+public void setBoard(Board board)
+
+
Description copied from class: PuzzleControllerDelegate
+
Called when the puzzle controller sets up a new board for the player. +

+

+
Overrides:
setBoard in class PuzzleControllerDelegate
+
+
+
Parameters:
board - the newly initialized and ready-to-go board.
+
+
+
+ +

+updateSelfSummary

+
+public void updateSelfSummary()
+
+
Updates the player's own local board summary to reflect the local copy of the player's + board which is likely to be more up to date than the server-side board from which all other + player board summaries originate. +

+

+
+
+
+
+
+
+
+ +

+tick

+
+public void tick(long tickStamp)
+
+
+
Specified by:
tick in interface com.threerings.media.FrameParticipant
+
+
+
+
+
+
+ +

+getComponent

+
+public Component getComponent()
+
+
+
Specified by:
getComponent in interface com.threerings.media.FrameParticipant
+
+
+
+
+
+
+ +

+needsPaint

+
+public boolean needsPaint()
+
+
+
Specified by:
needsPaint in interface com.threerings.media.FrameParticipant
+
+
+
+
+
+
+ +

+setRisingPaused

+
+public void setRisingPaused(boolean paused)
+
+
Sets whether the board rising is paused. +

+

+
+
+
+
+
+
+
+ +

+zipToNextRow

+
+public void zipToNextRow()
+
+
Causes the board to zip quickly to the next row. +

+

+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/client/DropPanel.html b/apidocs/com/threerings/puzzle/drop/client/DropPanel.html new file mode 100644 index 00000000..b29356c5 --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/client/DropPanel.html @@ -0,0 +1,237 @@ + + + + + + + +DropPanel (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.puzzle.drop.client +
+Interface DropPanel

+
+
+
public interface DropPanel
+ + +

+Puzzles using the drop services need implement this interface to display drop puzzle related + information. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + +
+Method Summary
+ voidsetNextBlock(int[] pieces) + +
+          Sets the next block to be displayed.
+ voidsetSummary(int pidx, + BoardSummary summary) + +
+          Updates the board summary display for the given player.
+  +

+ + + + + + + + +
+Method Detail
+ +

+setNextBlock

+
+void setNextBlock(int[] pieces)
+
+
Sets the next block to be displayed. +

+

+
+
+
+
+ +

+setSummary

+
+void setSummary(int pidx,
+                BoardSummary summary)
+
+
Updates the board summary display for the given player. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/client/DropSprite.html b/apidocs/com/threerings/puzzle/drop/client/DropSprite.html new file mode 100644 index 00000000..3a248598 --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/client/DropSprite.html @@ -0,0 +1,862 @@ + + + + + + + +DropSprite (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.puzzle.drop.client +
+Class DropSprite

+
+java.lang.Object
+  extended by com.threerings.media.AbstractMedia
+      extended by com.threerings.media.sprite.Sprite
+          extended by com.threerings.puzzle.drop.client.DropSprite
+
+
+
All Implemented Interfaces:
com.threerings.media.util.Pathable, com.threerings.util.DirectionCodes, Shape
+
+
+
Direct Known Subclasses:
DropBlockSprite
+
+
+
+
public class DropSprite
extends com.threerings.media.sprite.Sprite
+ + +

+The drop sprite is a sprite that displays one or more pieces falling toward the bottom of the + board. +

+ +

+

+ +

+ + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class com.threerings.media.AbstractMedia
HUD_LAYER
+  + + + + + + + +
Fields inherited from interface com.threerings.util.DirectionCodes
CARDINAL_DIRECTIONS, CCW, CW, DIRECTION_COUNT, DOWN, EAST, EASTNORTHEAST, EASTSOUTHEAST, FINE_DIRECTION_COUNT, HORIZONTAL, LEFT, NONE, NORTH, NORTHEAST, NORTHNORTHEAST, NORTHNORTHWEST, NORTHWEST, RIGHT, SOUTH, SOUTHEAST, SOUTHSOUTHEAST, SOUTHSOUTHWEST, SOUTHWEST, UP, VERTICAL, WEST, WESTNORTHWEST, WESTSOUTHWEST
+  + + + + + + + + + + + + + +
+Constructor Summary
DropSprite(DropBoardView view, + int col, + int row, + int[] pieces, + int dist) + +
+          Constructs a drop sprite and starts it dropping.
DropSprite(DropBoardView view, + int col, + int row, + int[] pieces, + int dist, + int renderOrder) + +
+          Constructs a drop sprite and starts it dropping.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voiddrop() + +
+          Starts the piece dropping toward the next row.
+ voidfastForward(long timeDelta) + +
+           
+ intgetColumn() + +
+          Returns the column the piece is located in.
+ intgetDistance() + +
+          Returns the remaining number of columns to drop.
+ floatgetPercentDone(long timestamp) + +
+          Returns a value between 0.0 and 1.0 representing how far the + piece has moved toward the next row as of the given time stamp.
+ int[]getPieces() + +
+          Returns the pieces the sprite is displaying.
+ intgetRow() + +
+          Returns the row the piece is located in.
+ floatgetVelocity() + +
+          Returns the velocity of this sprite.
+ booleaninside(Shape shape) + +
+           
+ booleanisBouncing() + +
+          Returns true if this sprite is bouncing.
+ booleanisDropping() + +
+          Returns true if this drop sprite is dropping, false if it has been stop()ped or has + not yet been drop()ped.
+ voidpaint(Graphics2D gfx) + +
+           
+ voidsetBoardLocation(int row, + int col) + +
+          Sets the row and column the piece is located in.
+ voidsetBouncing(boolean bouncing) + +
+          Puts the drop sprite into (or takes it out of) bouncing mode.
+ voidsetColumn(int col) + +
+          Sets the column the piece is located in.
+ voidsetColumnOffset(int count) + +
+          Sets the column offset of the sprite image.
+ voidsetOrientation(int orient) + +
+           
+ voidsetPieces(int[] pieces) + +
+          Sets the pieces the sprite is displaying.
+ voidsetRow(int row) + +
+          Set the row the piece is located in.
+ voidsetRowOffset(int count) + +
+          Sets the row offset of the sprite image.
+ voidsetVelocity(float velocity) + +
+          Sets the velocity of this sprite.
+ voidstop() + +
+          Stops the piece from dropping.
+ voidtick(long timestamp) + +
+           
+ voidtoString(StringBuilder buf) + +
+           
+  + + + + + + + +
Methods inherited from class com.threerings.media.sprite.Sprite
addSpriteObserver, cancelMove, contains, getHeight, getOrientation, getPath, getWidth, getX, getXOffset, getY, getYOffset, hitTest, intersects, isMoving, move, paintPath, pathBeginning, pathCompleted, removeSpriteObserver, setLocation, viewLocationDidChange
+  + + + + + + + +
Methods inherited from class com.threerings.media.AbstractMedia
contains, contains, contains, contains, getBounds, getBounds2D, getPathIterator, getPathIterator, getRenderOrder, init, intersects, intersects, invalidate, queueNotification, renderCompareTo, setRenderOrder, toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  + + + + + + + +
Methods inherited from interface com.threerings.media.util.Pathable
getBounds
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+DropSprite

+
+public DropSprite(DropBoardView view,
+                  int col,
+                  int row,
+                  int[] pieces,
+                  int dist)
+
+
Constructs a drop sprite and starts it dropping. +

+

+
Parameters:
view - the board view upon which this sprite will be displayed.
col - the column of the sprite.
row - the row of the bottom-most piece.
pieces - the pieces displayed by the sprite.
dist - the distance the sprite is to drop in rows.
+
+
+ +

+DropSprite

+
+public DropSprite(DropBoardView view,
+                  int col,
+                  int row,
+                  int[] pieces,
+                  int dist,
+                  int renderOrder)
+
+
Constructs a drop sprite and starts it dropping. +

+

+
Parameters:
view - the board view upon which this sprite will be displayed.
col - the column of the sprite.
row - the row of the bottom-most piece.
pieces - the pieces displayed by the sprite.
dist - the distance the sprite is to drop in rows.
renderOrder - the render order.
+
+ + + + + + + + +
+Method Detail
+ +

+getDistance

+
+public int getDistance()
+
+
Returns the remaining number of columns to drop. +

+

+
+
+
+
+ +

+getColumn

+
+public int getColumn()
+
+
Returns the column the piece is located in. +

+

+
+
+
+
+ +

+getRow

+
+public int getRow()
+
+
Returns the row the piece is located in. +

+

+
+
+
+
+ +

+getPieces

+
+public int[] getPieces()
+
+
Returns the pieces the sprite is displaying. +

+

+
+
+
+
+ +

+getVelocity

+
+public float getVelocity()
+
+
Returns the velocity of this sprite. +

+

+
+
+
+
+ +

+setBoardLocation

+
+public void setBoardLocation(int row,
+                             int col)
+
+
Sets the row and column the piece is located in. +

+

+
+
+
+
+ +

+setColumn

+
+public void setColumn(int col)
+
+
Sets the column the piece is located in. +

+

+
+
+
+
+ +

+setRow

+
+public void setRow(int row)
+
+
Set the row the piece is located in. +

+

+
+
+
+
+ +

+setColumnOffset

+
+public void setColumnOffset(int count)
+
+
Sets the column offset of the sprite image. +

+

+
+
+
+
+ +

+setRowOffset

+
+public void setRowOffset(int count)
+
+
Sets the row offset of the sprite image. +

+

+
+
+
+
+ +

+setPieces

+
+public void setPieces(int[] pieces)
+
+
Sets the pieces the sprite is displaying. +

+

+
+
+
+
+ +

+setVelocity

+
+public void setVelocity(float velocity)
+
+
Sets the velocity of this sprite. The time at which the current row was entered is modified + so that the sprite position will remain the same when calculated using the new velocity + since the piece sprite may have its velocity modified in the middle of a row traversal. +

+

+
+
+
+
+ +

+drop

+
+public void drop()
+
+
Starts the piece dropping toward the next row. +

+

+
+
+
+
+ +

+isDropping

+
+public boolean isDropping()
+
+
Returns true if this drop sprite is dropping, false if it has been stop()ped or has + not yet been drop()ped. +

+

+
+
+
+
+ +

+stop

+
+public void stop()
+
+
Stops the piece from dropping. +

+

+
+
+
+
+ +

+setBouncing

+
+public void setBouncing(boolean bouncing)
+
+
Puts the drop sprite into (or takes it out of) bouncing mode. Bouncing mode is used to put + the sprite into limbo after it lands but before we commit the landing, giving the user a + last moment change move or rotate the piece. While the sprite is "bouncing" it will be + rendered one pixel below its at rest state. +

+

+
+
+
+
+ +

+isBouncing

+
+public boolean isBouncing()
+
+
Returns true if this sprite is bouncing. +

+

+
+
+
+
+ +

+inside

+
+public boolean inside(Shape shape)
+
+
+
Overrides:
inside in class com.threerings.media.sprite.Sprite
+
+
+
+
+
+
+ +

+getPercentDone

+
+public float getPercentDone(long timestamp)
+
+
Returns a value between 0.0 and 1.0 representing how far the + piece has moved toward the next row as of the given time stamp. +

+

+
+
+
+
+ +

+paint

+
+public void paint(Graphics2D gfx)
+
+
+
Overrides:
paint in class com.threerings.media.sprite.Sprite
+
+
+
+
+
+
+ +

+tick

+
+public void tick(long timestamp)
+
+
+
Overrides:
tick in class com.threerings.media.sprite.Sprite
+
+
+
+
+
+
+ +

+fastForward

+
+public void fastForward(long timeDelta)
+
+
+
Overrides:
fastForward in class com.threerings.media.sprite.Sprite
+
+
+
+
+
+
+ +

+toString

+
+public void toString(StringBuilder buf)
+
+
+
Overrides:
toString in class com.threerings.media.sprite.Sprite
+
+
+
+
+
+
+ +

+setOrientation

+
+public void setOrientation(int orient)
+
+
+
Specified by:
setOrientation in interface com.threerings.media.util.Pathable
Overrides:
setOrientation in class com.threerings.media.sprite.Sprite
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/client/DropSpriteObserver.html b/apidocs/com/threerings/puzzle/drop/client/DropSpriteObserver.html new file mode 100644 index 00000000..4f20d9ff --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/client/DropSpriteObserver.html @@ -0,0 +1,219 @@ + + + + + + + +DropSpriteObserver (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.puzzle.drop.client +
+Interface DropSpriteObserver

+
+
+
public interface DropSpriteObserver
+ + +

+Provides notifications for drop puzzle specific stuff. +

+ +

+

+ +

+ + + + + + + + + + + + +
+Method Summary
+ voidpieceMoved(DropSprite sprite, + long when, + int col, + int row) + +
+          Called when the drop sprite has moved completely to the specified board coordinates.
+  +

+ + + + + + + + +
+Method Detail
+ +

+pieceMoved

+
+void pieceMoved(DropSprite sprite,
+                long when,
+                int col,
+                int row)
+
+
Called when the drop sprite has moved completely to the specified board coordinates. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/client/NextBlockView.html b/apidocs/com/threerings/puzzle/drop/client/NextBlockView.html new file mode 100644 index 00000000..1b42ac95 --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/client/NextBlockView.html @@ -0,0 +1,423 @@ + + + + + + + +NextBlockView (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.puzzle.drop.client +
+Class NextBlockView

+
+java.lang.Object
+  extended by java.awt.Component
+      extended by java.awt.Container
+          extended by javax.swing.JComponent
+              extended by com.threerings.puzzle.drop.client.NextBlockView
+
+
+
All Implemented Interfaces:
com.threerings.util.DirectionCodes, ImageObserver, MenuContainer, Serializable
+
+
+
+
public class NextBlockView
extends JComponent
implements com.threerings.util.DirectionCodes
+ + +

+The next block view displays an image representing the next drop block to appear in the game. +

+ +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent
+  + + + + + + + + +
Nested classes/interfaces inherited from class java.awt.Component
Component.BaselineResizeBehavior
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class javax.swing.JComponent
TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
+  + + + + + + + +
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
+  + + + + + + + +
Fields inherited from interface com.threerings.util.DirectionCodes
CARDINAL_DIRECTIONS, CCW, CW, DIRECTION_COUNT, DOWN, EAST, EASTNORTHEAST, EASTSOUTHEAST, FINE_DIRECTION_COUNT, HORIZONTAL, LEFT, NONE, NORTH, NORTHEAST, NORTHNORTHEAST, NORTHNORTHWEST, NORTHWEST, RIGHT, SOUTH, SOUTHEAST, SOUTHSOUTHEAST, SOUTHSOUTHWEST, SOUTHWEST, UP, VERTICAL, WEST, WESTNORTHWEST, WESTSOUTHWEST
+  + + + + + + + +
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
+  + + + + + + + + + + +
+Constructor Summary
NextBlockView(DropBoardView view, + int pwid, + int phei, + int orient) + +
+          Constructs a next block view.
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ DimensiongetPreferredSize() + +
+           
+ voidpaintComponent(Graphics g) + +
+           
+ voidsetPieces(int[] pieces) + +
+          Sets the pieces displayed by the view.
+  + + + + + + + +
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI
+  + + + + + + + +
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate
+  + + + + + + + +
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+NextBlockView

+
+public NextBlockView(DropBoardView view,
+                     int pwid,
+                     int phei,
+                     int orient)
+
+
Constructs a next block view. +

+

+ + + + + + + + +
+Method Detail
+ +

+setPieces

+
+public void setPieces(int[] pieces)
+
+
Sets the pieces displayed by the view. +

+

+
+
+
+
+
+
+
+ +

+paintComponent

+
+public void paintComponent(Graphics g)
+
+
+
Overrides:
paintComponent in class JComponent
+
+
+
+
+
+
+ +

+getPreferredSize

+
+public Dimension getPreferredSize()
+
+
+
Overrides:
getPreferredSize in class JComponent
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/client/PieceGroupAnimation.html b/apidocs/com/threerings/puzzle/drop/client/PieceGroupAnimation.html new file mode 100644 index 00000000..063282c3 --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/client/PieceGroupAnimation.html @@ -0,0 +1,380 @@ + + + + + + + +PieceGroupAnimation (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.puzzle.drop.client +
+Class PieceGroupAnimation

+
+java.lang.Object
+  extended by com.threerings.media.AbstractMedia
+      extended by com.threerings.media.animation.Animation
+          extended by com.threerings.puzzle.drop.client.PieceGroupAnimation
+
+
+
All Implemented Interfaces:
com.threerings.media.sprite.PathObserver, Shape
+
+
+
+
public abstract class PieceGroupAnimation
extends com.threerings.media.animation.Animation
implements com.threerings.media.sprite.PathObserver
+ + +

+Animates all the pieces on a puzzle board doing some sort of global effect like all flying into + place or out into the ether. +

+ +

+

+ +

+ + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class com.threerings.media.AbstractMedia
HUD_LAYER
+  + + + + + + + + + + +
+Constructor Summary
PieceGroupAnimation(DropBoardView view, + DropBoard board) + +
+          Creates a piece group animation which must be initialized with a subsequent call to + AbstractMedia.init(AbstractMediaManager).
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidpaint(Graphics2D gfx) + +
+           
+ voidpathCancelled(com.threerings.media.sprite.Sprite sprite, + com.threerings.media.util.Path path) + +
+           
+ voidpathCompleted(com.threerings.media.sprite.Sprite sprite, + com.threerings.media.util.Path path, + long when) + +
+           
+ voidtick(long tickStamp) + +
+           
+  + + + + + + + +
Methods inherited from class com.threerings.media.animation.Animation
addAnimationObserver, isFinished, removeAnimationObserver, reset, setLocation
+  + + + + + + + +
Methods inherited from class com.threerings.media.AbstractMedia
contains, contains, contains, contains, fastForward, getBounds, getBounds2D, getPathIterator, getPathIterator, getRenderOrder, init, intersects, intersects, invalidate, queueNotification, renderCompareTo, setRenderOrder, toString, viewLocationDidChange
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+PieceGroupAnimation

+
+public PieceGroupAnimation(DropBoardView view,
+                           DropBoard board)
+
+
Creates a piece group animation which must be initialized with a subsequent call to + AbstractMedia.init(AbstractMediaManager). +

+

+ + + + + + + + +
+Method Detail
+ +

+tick

+
+public void tick(long tickStamp)
+
+
+
Specified by:
tick in class com.threerings.media.AbstractMedia
+
+
+
+
+
+
+ +

+paint

+
+public void paint(Graphics2D gfx)
+
+
+
Specified by:
paint in class com.threerings.media.AbstractMedia
+
+
+
+
+
+
+ +

+pathCancelled

+
+public void pathCancelled(com.threerings.media.sprite.Sprite sprite,
+                          com.threerings.media.util.Path path)
+
+
+
Specified by:
pathCancelled in interface com.threerings.media.sprite.PathObserver
+
+
+
+
+
+
+ +

+pathCompleted

+
+public void pathCompleted(com.threerings.media.sprite.Sprite sprite,
+                          com.threerings.media.util.Path path,
+                          long when)
+
+
+
Specified by:
pathCompleted in interface com.threerings.media.sprite.PathObserver
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/client/class-use/DropBlockSprite.html b/apidocs/com/threerings/puzzle/drop/client/class-use/DropBlockSprite.html new file mode 100644 index 00000000..e4f20b05 --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/client/class-use/DropBlockSprite.html @@ -0,0 +1,183 @@ + + + + + + + +Uses of Class com.threerings.puzzle.drop.client.DropBlockSprite (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.puzzle.drop.client.DropBlockSprite

+
+ + + + + + + + + +
+Packages that use DropBlockSprite
com.threerings.puzzle.drop.client  
+  +

+ + + + + +
+Uses of DropBlockSprite in com.threerings.puzzle.drop.client
+  +

+ + + + + + + + + +
Methods in com.threerings.puzzle.drop.client with parameters of type DropBlockSprite
+ voidDropBoardView.rotateDropBlock(DropBlockSprite sprite, + int orient) + +
+          Rotates the given drop block sprite to the specified orientation, updating the image as + necessary.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/client/class-use/DropBoardView.html b/apidocs/com/threerings/puzzle/drop/client/class-use/DropBoardView.html new file mode 100644 index 00000000..7eb15a73 --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/client/class-use/DropBoardView.html @@ -0,0 +1,232 @@ + + + + + + + +Uses of Class com.threerings.puzzle.drop.client.DropBoardView (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.puzzle.drop.client.DropBoardView

+
+ + + + + + + + + +
+Packages that use DropBoardView
com.threerings.puzzle.drop.client  
+  +

+ + + + + +
+Uses of DropBoardView in com.threerings.puzzle.drop.client
+  +

+ + + + + + + + + + + + + + + + + + + + + + + +
Constructors in com.threerings.puzzle.drop.client with parameters of type DropBoardView
DropBlockSprite(DropBoardView view, + int col, + int row, + int orient, + int[] pieces) + +
+          Constructs a drop block sprite and starts it dropping.
DropBlockSprite(DropBoardView view, + int col, + int row, + int orient, + int[] pieces, + int renderOrder) + +
+          Constructs a drop block sprite and starts it dropping.
DropSprite(DropBoardView view, + int col, + int row, + int[] pieces, + int dist) + +
+          Constructs a drop sprite and starts it dropping.
DropSprite(DropBoardView view, + int col, + int row, + int[] pieces, + int dist, + int renderOrder) + +
+          Constructs a drop sprite and starts it dropping.
NextBlockView(DropBoardView view, + int pwid, + int phei, + int orient) + +
+          Constructs a next block view.
PieceGroupAnimation(DropBoardView view, + DropBoard board) + +
+          Creates a piece group animation which must be initialized with a subsequent call to + AbstractMedia.init(AbstractMediaManager).
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/client/class-use/DropControllerDelegate.html b/apidocs/com/threerings/puzzle/drop/client/class-use/DropControllerDelegate.html new file mode 100644 index 00000000..c8bd4ed8 --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/client/class-use/DropControllerDelegate.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.puzzle.drop.client.DropControllerDelegate (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.puzzle.drop.client.DropControllerDelegate

+
+No usage of com.threerings.puzzle.drop.client.DropControllerDelegate +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/client/class-use/DropPanel.html b/apidocs/com/threerings/puzzle/drop/client/class-use/DropPanel.html new file mode 100644 index 00000000..8a1bfdf7 --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/client/class-use/DropPanel.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Interface com.threerings.puzzle.drop.client.DropPanel (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.puzzle.drop.client.DropPanel

+
+No usage of com.threerings.puzzle.drop.client.DropPanel +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/client/class-use/DropSprite.html b/apidocs/com/threerings/puzzle/drop/client/class-use/DropSprite.html new file mode 100644 index 00000000..af651c7c --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/client/class-use/DropSprite.html @@ -0,0 +1,220 @@ + + + + + + + +Uses of Class com.threerings.puzzle.drop.client.DropSprite (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.puzzle.drop.client.DropSprite

+
+ + + + + + + + + +
+Packages that use DropSprite
com.threerings.puzzle.drop.client  
+  +

+ + + + + +
+Uses of DropSprite in com.threerings.puzzle.drop.client
+  +

+ + + + + + + + + +
Subclasses of DropSprite in com.threerings.puzzle.drop.client
+ classDropBlockSprite + +
+          The drop block sprite represents a block of multiple pieces that can be rotated to any of the + four cardinal compass directions.
+  +

+ + + + + + + + + +
Methods in com.threerings.puzzle.drop.client that return DropSprite
+ DropSpriteDropBoardView.createPieces(int col, + int row, + int[] pieces, + int dist) + +
+          Creates a new drop sprite used to animate the given pieces falling in the specified column.
+  +

+ + + + + + + + + +
Methods in com.threerings.puzzle.drop.client with parameters of type DropSprite
+ voidDropSpriteObserver.pieceMoved(DropSprite sprite, + long when, + int col, + int row) + +
+          Called when the drop sprite has moved completely to the specified board coordinates.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/client/class-use/DropSpriteObserver.html b/apidocs/com/threerings/puzzle/drop/client/class-use/DropSpriteObserver.html new file mode 100644 index 00000000..20397651 --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/client/class-use/DropSpriteObserver.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Interface com.threerings.puzzle.drop.client.DropSpriteObserver (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.puzzle.drop.client.DropSpriteObserver

+
+No usage of com.threerings.puzzle.drop.client.DropSpriteObserver +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/client/class-use/NextBlockView.html b/apidocs/com/threerings/puzzle/drop/client/class-use/NextBlockView.html new file mode 100644 index 00000000..e9847c51 --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/client/class-use/NextBlockView.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.puzzle.drop.client.NextBlockView (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.puzzle.drop.client.NextBlockView

+
+No usage of com.threerings.puzzle.drop.client.NextBlockView +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/client/class-use/PieceGroupAnimation.html b/apidocs/com/threerings/puzzle/drop/client/class-use/PieceGroupAnimation.html new file mode 100644 index 00000000..68b7c37d --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/client/class-use/PieceGroupAnimation.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.puzzle.drop.client.PieceGroupAnimation (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.puzzle.drop.client.PieceGroupAnimation

+
+No usage of com.threerings.puzzle.drop.client.PieceGroupAnimation +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/client/package-frame.html b/apidocs/com/threerings/puzzle/drop/client/package-frame.html new file mode 100644 index 00000000..3a75e7a2 --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/client/package-frame.html @@ -0,0 +1,56 @@ + + + + + + + +com.threerings.puzzle.drop.client (vilya 1.3 API) + + + + + + + + + + + +com.threerings.puzzle.drop.client + + + + +
+Interfaces  + +
+DropPanel +
+DropSpriteObserver
+ + + + + + +
+Classes  + +
+DropBlockSprite +
+DropBoardView +
+DropControllerDelegate +
+DropSprite +
+NextBlockView +
+PieceGroupAnimation
+ + + + diff --git a/apidocs/com/threerings/puzzle/drop/client/package-summary.html b/apidocs/com/threerings/puzzle/drop/client/package-summary.html new file mode 100644 index 00000000..47725e05 --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/client/package-summary.html @@ -0,0 +1,202 @@ + + + + + + + +com.threerings.puzzle.drop.client (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.puzzle.drop.client +

+ + + + + + + + + + + + + +
+Interface Summary
DropPanelPuzzles using the drop services need implement this interface to display drop puzzle related + information.
DropSpriteObserverProvides notifications for drop puzzle specific stuff.
+  + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Class Summary
DropBlockSpriteThe drop block sprite represents a block of multiple pieces that can be rotated to any of the + four cardinal compass directions.
DropBoardViewThe drop board view displays a drop puzzle game in progress for a single player.
DropControllerDelegateGames that wish to make use of the drop puzzle services will need to create an extension of + this delegate class, customizing it for their particular game and then adding it via + PlaceController.addDelegate(com.threerings.crowd.client.PlaceControllerDelegate).
DropSpriteThe drop sprite is a sprite that displays one or more pieces falling toward the bottom of the + board.
NextBlockViewThe next block view displays an image representing the next drop block to appear in the game.
PieceGroupAnimationAnimates all the pieces on a puzzle board doing some sort of global effect like all flying into + place or out into the ether.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/client/package-tree.html b/apidocs/com/threerings/puzzle/drop/client/package-tree.html new file mode 100644 index 00000000..e3c74166 --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/client/package-tree.html @@ -0,0 +1,195 @@ + + + + + + + +com.threerings.puzzle.drop.client Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.puzzle.drop.client +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/client/package-use.html b/apidocs/com/threerings/puzzle/drop/client/package-use.html new file mode 100644 index 00000000..b05fa022 --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/client/package-use.html @@ -0,0 +1,185 @@ + + + + + + + +Uses of Package com.threerings.puzzle.drop.client (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.puzzle.drop.client

+
+ + + + + + + + + +
+Packages that use com.threerings.puzzle.drop.client
com.threerings.puzzle.drop.client  
+  +

+ + + + + + + + + + + + + + +
+Classes in com.threerings.puzzle.drop.client used by com.threerings.puzzle.drop.client
DropBlockSprite + +
+          The drop block sprite represents a block of multiple pieces that can be rotated to any of the + four cardinal compass directions.
DropBoardView + +
+          The drop board view displays a drop puzzle game in progress for a single player.
DropSprite + +
+          The drop sprite is a sprite that displays one or more pieces falling toward the bottom of the + board.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/data/DropBoard.PieceOperation.html b/apidocs/com/threerings/puzzle/drop/data/DropBoard.PieceOperation.html new file mode 100644 index 00000000..87dca65c --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/data/DropBoard.PieceOperation.html @@ -0,0 +1,223 @@ + + + + + + + +DropBoard.PieceOperation (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.puzzle.drop.data +
+Interface DropBoard.PieceOperation

+
+
Enclosing class:
DropBoard
+
+
+
+
public static interface DropBoard.PieceOperation
+ + +

+An interface to be implemented by classes that would like to apply some operation to each + piece in a column or row segment in the board. +

+ +

+

+ +

+ + + + + + + + + + + + +
+Method Summary
+ booleanexecute(DropBoard board, + int col, + int row) + +
+          Called for each piece in the board segment the operation is being applied to.
+  +

+ + + + + + + + +
+Method Detail
+ +

+execute

+
+boolean execute(DropBoard board,
+                int col,
+                int row)
+
+
Called for each piece in the board segment the operation is being applied to. +

+

+ +
Returns:
true if the operation should continue to be applied if being applied to multiple + pieces, or false if it should terminate after this application.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/data/DropBoard.html b/apidocs/com/threerings/puzzle/drop/data/DropBoard.html new file mode 100644 index 00000000..5fed45f5 --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/data/DropBoard.html @@ -0,0 +1,1385 @@ + + + + + + + +DropBoard (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.puzzle.drop.data +
+Class DropBoard

+
+java.lang.Object
+  extended by com.threerings.puzzle.data.Board
+      extended by com.threerings.puzzle.drop.data.DropBoard
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable, DropPieceCodes, com.threerings.util.DirectionCodes, Cloneable
+
+
+
+
public class DropBoard
extends Board
implements DropPieceCodes
+ + +

+A class that provides for various useful logical operations to be enacted on a two-dimensional + board and provides an easier mechanism for referencing pieces by position. +

+ +

+

+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static interfaceDropBoard.PieceOperation + +
+          An interface to be implemented by classes that would like to apply some operation to each + piece in a column or row segment in the board.
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static DropBoard.PieceOperationCLEAR_OP + +
+          An operation that does naught but clear pieces, which proves to be generally useful.
+static intINPLACE_ROTATION + +
+          The rotation constant for rotation wherein the block occupies the same columns when + rotating.
+static intRADIAL_ROTATION + +
+          The rotation constant for rotation around a central piece.
+  + + + + + + + +
Fields inherited from interface com.threerings.puzzle.drop.data.DropPieceCodes
DROP_BLOCK_PIECE_COUNT, PIECE_NONE
+  + + + + + + + +
Fields inherited from interface com.threerings.util.DirectionCodes
CARDINAL_DIRECTIONS, CCW, CW, DIRECTION_COUNT, DOWN, EAST, EASTNORTHEAST, EASTSOUTHEAST, FINE_DIRECTION_COUNT, HORIZONTAL, LEFT, NONE, NORTH, NORTHEAST, NORTHNORTHEAST, NORTHNORTHWEST, NORTHWEST, RIGHT, SOUTH, SOUTHEAST, SOUTHSOUTHEAST, SOUTHSOUTHWEST, SOUTHWEST, UP, VERTICAL, WEST, WESTNORTHWEST, WESTSOUTHWEST
+  + + + + + + + + + + + + + + + + + + + +
+Constructor Summary
DropBoard() + +
+          Constructs an empty drop board for use when unserializing.
DropBoard(int[] board, + int bwid, + int bhei) + +
+          Constructs a drop board with the given board and dimensions.
DropBoard(int bwid, + int bhei) + +
+          Constructs a drop board of the given dimensions with its pieces initialized to PIECE_NONE.
DropBoard(int bwid, + int bhei, + int piece) + +
+          Constructs a drop board of the given dimensions with its pieces initialized to the given + piece.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidapplyOp(int col, + int row, + DropBoard.PieceOperation op) + +
+          Applies a specified DropBoard.PieceOperation to the specified piece in the board.
+ voidapplyOp(int dir, + int col, + int row, + DropBoard.PieceOperation op) + +
+          Applies a specified DropBoard.PieceOperation to all pieces in the specified row or column + starting at the specified coordinates and spanning the remainder of the row or column + (depending on the application direction) in the board.
+ voidapplyOp(int dir, + int col, + int row, + int len, + DropBoard.PieceOperation op) + +
+          Applies a specified DropBoard.PieceOperation to all pieces in a row or column segment + starting at the specified coordinates and of the specified length in the board.
+ voidapplyRisingPieces(int[] pieces) + +
+          Called by the DropControllerDelegate when it's time to apply a rising row of pieces + to the board.
+ DropBoardclone() + +
+           
+ voidcopyInto(DropBoard board) + +
+          Copies the contents of this board directly into the supplied board, overwriting the + destination board in its entirety.
+ voiddump() + +
+          Outputs a string representation of the board contents.
+ voiddumpAndCompare(Board other) + +
+          Outputs a string representation of the board contents, interlaced with the supplied + comparison board.
+ booleanequals(Board other) + +
+          Returns whether this board is equal to the given comparison board.
+ voidfill(int piece) + +
+          Fills the board contents with the given piece.
+ int[]getBoard() + +
+          Returns the raw board data associated with this board.
+ RectanglegetBounds() + +
+          Returns the bounds of this board.
+ voidgetColumnLevels(byte[] columns) + +
+          Populates the given array with the column levels for this board.
+ intgetDropDistance(int col, + int row) + +
+          Returns the distance the piece at the given column and row can drop until it hits a + non-empty piece (defined as DropPieceCodes.PIECE_NONE).
+ PointgetForgivingMove(int col, + int row, + int wid, + int hei, + int dx, + int dy, + float pctdone) + +
+          Returns a Point object containing the coordinates to place the bottom-left of the + given block at after moving it the given distance on the x- and y-axes, or + null if the move is not valid.
+ int[]getForgivingRotation(int[] rows, + int[] cols, + int orient, + int dir, + int rtype, + float pctdone, + boolean canPopup) + +
+          Rotates the given block in the given direction and returns its final state as (orient, + col, row, popped), where orient is the final orientation of the drop + block; col and row are the final column and row coordinates, + respectively, of the central drop block piece.
+ intgetHeight() + +
+          Returns the height of the board in rows.
+ intgetNextPiece() + +
+          For boards that are always filled, this method is called to obtain pieces to fill the board.
+ intgetPiece(int col, + int row) + +
+          Returns the piece at the given column and row in the board.
+ intgetWidth() + +
+          Returns the width of the board in columns.
+ booleaninBounds(int col, + int row) + +
+          Returns true if the specified coordinate is within the bounds of the board, false if it is + not.
+ booleanisBlockEmpty(int col, + int row, + int wid, + int hei) + +
+          Returns whether the specified block in the board is empty.
+ booleanisRowEmpty(int row) + +
+          Returns whether the given row in the board is empty.
+ booleanisValidDrop(int[] rows, + int[] cols, + float pctdone) + +
+          Returns whether all of the pieces at the given coordinates can be dropped one row.
+ booleanisValidPosition(int x, + int y) + +
+          Returns whether the given coordinates are within the board bounds.
+ booleanrowContainsPieces(int row, + int blankPiece) + +
+          Returns true if the specified row (which count down, with zero at the top of the board) + contains any pieces.
+ voidsetBoard(int[] board) + +
+          Sets the board pieces.
+ voidsetBoard(int[] board, + int bwid, + int bhei) + +
+          Sets the board data and board dimensions.
+ booleansetPiece(int col, + int row, + int piece) + +
+          Sets the piece at the given coordinates.
+ voidsetRect(int x, + int y, + int width, + int height, + int piece) + +
+          Sets the pieces within the specified rectangle to the given piece.
+ voidsetSegment(int dir, + int col, + int row, + int[] pieces) + +
+          Sets the pieces in the given board segment to the specified pieces.
+ booleansetSegment(int dir, + int col, + int row, + int len, + int piece) + +
+          Sets the pieces in the given board segment to the specified piece.
+ intsize() + +
+          Returns the size of the board in pieces.
+ StringtoString() + +
+           
+  + + + + + + + +
Methods inherited from class com.threerings.puzzle.data.Board
getRandom, initializeSeed, seedFromEvent
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+RADIAL_ROTATION

+
+public static final int RADIAL_ROTATION
+
+
The rotation constant for rotation around a central piece. +

+

+
See Also:
Constant Field Values
+
+
+ +

+INPLACE_ROTATION

+
+public static final int INPLACE_ROTATION
+
+
The rotation constant for rotation wherein the block occupies the same columns when + rotating. +

+

+
See Also:
Constant Field Values
+
+
+ +

+CLEAR_OP

+
+public static final DropBoard.PieceOperation CLEAR_OP
+
+
An operation that does naught but clear pieces, which proves to be generally useful. +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+DropBoard

+
+public DropBoard()
+
+
Constructs an empty drop board for use when unserializing. +

+

+
+ +

+DropBoard

+
+public DropBoard(int bwid,
+                 int bhei)
+
+
Constructs a drop board of the given dimensions with its pieces initialized to PIECE_NONE. +

+

+
+ +

+DropBoard

+
+public DropBoard(int bwid,
+                 int bhei,
+                 int piece)
+
+
Constructs a drop board of the given dimensions with its pieces initialized to the given + piece. +

+

+
+ +

+DropBoard

+
+public DropBoard(int[] board,
+                 int bwid,
+                 int bhei)
+
+
Constructs a drop board with the given board and dimensions. +

+

+ + + + + + + + +
+Method Detail
+ +

+getWidth

+
+public int getWidth()
+
+
Returns the width of the board in columns. +

+

+
+
+
+
+
+
+
+ +

+getHeight

+
+public int getHeight()
+
+
Returns the height of the board in rows. +

+

+
+
+
+
+
+
+
+ +

+getPiece

+
+public int getPiece(int col,
+                    int row)
+
+
Returns the piece at the given column and row in the board. +

+

+
+
+
+
+
+
+
+ +

+getNextPiece

+
+public int getNextPiece()
+
+
For boards that are always filled, this method is called to obtain pieces to fill the board. +

+

+
+
+
+
+
+
+
+ +

+getDropDistance

+
+public int getDropDistance(int col,
+                           int row)
+
+
Returns the distance the piece at the given column and row can drop until it hits a + non-empty piece (defined as DropPieceCodes.PIECE_NONE). +

+

+
+
+
+
+
+
+
+ +

+isRowEmpty

+
+public boolean isRowEmpty(int row)
+
+
Returns whether the given row in the board is empty. +

+

+
+
+
+
+
+
+
+ +

+isValidDrop

+
+public boolean isValidDrop(int[] rows,
+                           int[] cols,
+                           float pctdone)
+
+
Returns whether all of the pieces at the given coordinates can be dropped one row. +

+

+
+
+
+
+
+
+
+ +

+inBounds

+
+public boolean inBounds(int col,
+                        int row)
+
+
Returns true if the specified coordinate is within the bounds of the board, false if it is + not. +

+

+
+
+
+
+
+
+
+ +

+isBlockEmpty

+
+public boolean isBlockEmpty(int col,
+                            int row,
+                            int wid,
+                            int hei)
+
+
Returns whether the specified block in the board is empty. The block is allowed to occupy + space off the top of the board as long as it is within the horizontal board bounds. +

+

+
+
+
+
Parameters:
col - the left coordinate of the block.
row - the bottom coordinate of the block.
wid - the width of the block.
hei - the height of the block.
+
+
+
+ +

+getForgivingRotation

+
+public int[] getForgivingRotation(int[] rows,
+                                  int[] cols,
+                                  int orient,
+                                  int dir,
+                                  int rtype,
+                                  float pctdone,
+                                  boolean canPopup)
+
+
Rotates the given block in the given direction and returns its final state as (orient, + col, row, popped), where orient is the final orientation of the drop + block; col and row are the final column and row coordinates, + respectively, of the central drop block piece. popped will be set to 1 if the + piece was popped up, 0 otherwise. +

+

+
+
+
+
+
+
+
+ +

+getForgivingMove

+
+public Point getForgivingMove(int col,
+                              int row,
+                              int wid,
+                              int hei,
+                              int dx,
+                              int dy,
+                              float pctdone)
+
+
Returns a Point object containing the coordinates to place the bottom-left of the + given block at after moving it the given distance on the x- and y-axes, or + null if the move is not valid. Note that only the final block position is + checked. +

+

+
+
+
+
Parameters:
col - the leftmost column of the block.
row - the bottommost row of the block.
wid - the width of the block.
hei - the height of the block.
dx - the distance to move the block in columns.
dy - the distance to move the block in rows.
pctdone - the percentage of the inter-block distance that the piece has fallen thus + far.
+
+
+
+ +

+getColumnLevels

+
+public void getColumnLevels(byte[] columns)
+
+
Populates the given array with the column levels for this board. +

+

+
+
+
+
+
+
+
+ +

+applyRisingPieces

+
+public void applyRisingPieces(int[] pieces)
+
+
Called by the DropControllerDelegate when it's time to apply a rising row of pieces + to the board. Shifts all of the pieces in the given board up one row and places the given + row of pieces at the bottom of the board. +

+

+
+
+
+
+
+
+
+ +

+rowContainsPieces

+
+public boolean rowContainsPieces(int row,
+                                 int blankPiece)
+
+
Returns true if the specified row (which count down, with zero at the top of the board) + contains any pieces. +

+

+
+
+
+
Parameters:
row - the row to check for pieces.
blankPiece - the blank piece value, non-instances of which will be sought.
+
+
+
+ +

+fill

+
+public void fill(int piece)
+
+
Fills the board contents with the given piece. +

+

+
+
+
+
+
+
+
+ +

+setPiece

+
+public boolean setPiece(int col,
+                        int row,
+                        int piece)
+
+
Sets the piece at the given coordinates. +

+

+
+
+
+ +
Returns:
true if the piece was set, false if it was invalid.
+
+
+
+ +

+setRect

+
+public void setRect(int x,
+                    int y,
+                    int width,
+                    int height,
+                    int piece)
+
+
Sets the pieces within the specified rectangle to the given piece. +

+

+
+
+
+
+
+
+
+ +

+setSegment

+
+public boolean setSegment(int dir,
+                          int col,
+                          int row,
+                          int len,
+                          int piece)
+
+
Sets the pieces in the given board segment to the specified piece. +

+

+
+
+
+
Parameters:
dir - the direction of the segment; one of DirectionCodes.HORIZONTAL or DirectionCodes.VERTICAL.
col - the starting column of the segment.
row - the starting row of the segment.
len - the length of the segment in pieces.
piece - the piece to set in the segment. +
Returns:
false if the segment was only partially applied because some pieces were outside + the bounds of the board, true if it was completely applied.
+
+
+
+ +

+setSegment

+
+public void setSegment(int dir,
+                       int col,
+                       int row,
+                       int[] pieces)
+
+
Sets the pieces in the given board segment to the specified pieces. +

+

+
+
+
+
Parameters:
dir - the direction of the segment; one of DirectionCodes.HORIZONTAL or DirectionCodes.VERTICAL.
col - the starting column of the segment.
row - the starting row of the segment.
pieces - the pieces to set in the segment.
+
+
+
+ +

+applyOp

+
+public void applyOp(int dir,
+                    int col,
+                    int row,
+                    DropBoard.PieceOperation op)
+
+
Applies a specified DropBoard.PieceOperation to all pieces in the specified row or column + starting at the specified coordinates and spanning the remainder of the row or column + (depending on the application direction) in the board. +

+

+
+
+
+
Parameters:
dir - the direction to iterate in; one of DirectionCodes.HORIZONTAL or DirectionCodes.VERTICAL.
col - the starting column of the segment.
row - the starting row of the segment.
op - the piece operation to apply to each piece.
+
+
+
+ +

+applyOp

+
+public void applyOp(int dir,
+                    int col,
+                    int row,
+                    int len,
+                    DropBoard.PieceOperation op)
+
+
Applies a specified DropBoard.PieceOperation to all pieces in a row or column segment + starting at the specified coordinates and of the specified length in the board. +

+

+
+
+
+
Parameters:
dir - the direction to iterate in; one of DirectionCodes.HORIZONTAL or DirectionCodes.VERTICAL.
col - the starting leftmost column of the segment.
row - the starting bottommost row of the segment.
len - the number of pieces in the segment.
op - the piece operation to apply to each piece.
+
+
+
+ +

+applyOp

+
+public void applyOp(int col,
+                    int row,
+                    DropBoard.PieceOperation op)
+
+
Applies a specified DropBoard.PieceOperation to the specified piece in the board. +

+

+
+
+
+
Parameters:
col - the column of the piece.
row - the row of the piece.
op - the piece operation to apply to the piece.
+
+
+
+ +

+dump

+
+public void dump()
+
+
Description copied from class: Board
+
Outputs a string representation of the board contents. +

+

+
Specified by:
dump in class Board
+
+
+
+
+
+
+ +

+dumpAndCompare

+
+public void dumpAndCompare(Board other)
+
+
Description copied from class: Board
+
Outputs a string representation of the board contents, interlaced with the supplied + comparison board. +

+

+
Specified by:
dumpAndCompare in class Board
+
+
+
+
+
+
+ +

+toString

+
+public String toString()
+
+
+
Overrides:
toString in class Object
+
+
+
+
+
+
+ +

+equals

+
+public boolean equals(Board other)
+
+
Description copied from class: Board
+
Returns whether this board is equal to the given comparison board. +

+

+
Specified by:
equals in class Board
+
+
+
+
+
+
+ +

+isValidPosition

+
+public boolean isValidPosition(int x,
+                               int y)
+
+
Returns whether the given coordinates are within the board bounds. +

+

+
+
+
+
+
+
+
+ +

+getBounds

+
+public Rectangle getBounds()
+
+
Returns the bounds of this board. Note that a single rectangle is re-used internally and so + the caller should not modify the returned rectangle. +

+

+
+
+
+
+
+
+
+ +

+size

+
+public int size()
+
+
Returns the size of the board in pieces. +

+

+
+
+
+
+
+
+
+ +

+copyInto

+
+public void copyInto(DropBoard board)
+
+
Copies the contents of this board directly into the supplied board, overwriting the + destination board in its entirety. +

+

+
+
+
+
+
+
+
+ +

+getBoard

+
+public int[] getBoard()
+
+
Returns the raw board data associated with this board. One shouldn't fiddle about with this + unless one knows what one is doing. +

+

+
+
+
+
+
+
+
+ +

+setBoard

+
+public void setBoard(int[] board,
+                     int bwid,
+                     int bhei)
+
+
Sets the board data and board dimensions. +

+

+
+
+
+
+
+
+
+ +

+setBoard

+
+public void setBoard(int[] board)
+
+
Sets the board pieces. +

+

+
+
+
+
+
+
+
+ +

+clone

+
+public DropBoard clone()
+
+
+
Overrides:
clone in class Board
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/data/DropBoardSummary.html b/apidocs/com/threerings/puzzle/drop/data/DropBoardSummary.html new file mode 100644 index 00000000..239f9315 --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/data/DropBoardSummary.html @@ -0,0 +1,408 @@ + + + + + + + +DropBoardSummary (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.puzzle.drop.data +
+Class DropBoardSummary

+
+java.lang.Object
+  extended by com.threerings.io.SimpleStreamableObject
+      extended by com.threerings.puzzle.data.BoardSummary
+          extended by com.threerings.puzzle.drop.data.DropBoardSummary
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable
+
+
+
+
public class DropBoardSummary
extends BoardSummary
+ + +

+Provides a summary of a DropBoard. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + +
+Field Summary
+ byte[]columns + +
+          The row levels for each column.
+  + + + + + + + + + + + + + +
+Constructor Summary
DropBoardSummary() + +
+          Constructs an empty drop board summary for use when un-serializing.
DropBoardSummary(Board board) + +
+          Constructs a drop board summary that retrieves board information from the supplied board + when summarizing.
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ intgetHighestColumn(int startx, + int endx) + +
+          Returns the column number of the column within the given column range that contains the + most pieces.
+ voidsetBoard(Board board) + +
+          Sets the board associated with this board summary, causing an immediate update to this + summary.
+ voidsummarize() + +
+          Called by the PuzzleManager to refresh the board + summary information by studying the associated board contents.
+  + + + + + + + +
Methods inherited from class com.threerings.io.SimpleStreamableObject
toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+columns

+
+public byte[] columns
+
+
The row levels for each column. +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+DropBoardSummary

+
+public DropBoardSummary()
+
+
Constructs an empty drop board summary for use when un-serializing. +

+

+
+ +

+DropBoardSummary

+
+public DropBoardSummary(Board board)
+
+
Constructs a drop board summary that retrieves board information from the supplied board + when summarizing. +

+

+ + + + + + + + +
+Method Detail
+ +

+getHighestColumn

+
+public int getHighestColumn(int startx,
+                            int endx)
+
+
Returns the column number of the column within the given column range that contains the + most pieces. +

+

+
+
+
+
+ +

+setBoard

+
+public void setBoard(Board board)
+
+
Description copied from class: BoardSummary
+
Sets the board associated with this board summary, causing an immediate update to this + summary. +

+

+
Overrides:
setBoard in class BoardSummary
+
+
+
+
+
+
+ +

+summarize

+
+public void summarize()
+
+
Description copied from class: BoardSummary
+
Called by the PuzzleManager to refresh the board + summary information by studying the associated board contents. +

+

+
Specified by:
summarize in class BoardSummary
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/data/DropCodes.html b/apidocs/com/threerings/puzzle/drop/data/DropCodes.html new file mode 100644 index 00000000..f7d595b3 --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/data/DropCodes.html @@ -0,0 +1,257 @@ + + + + + + + +DropCodes (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.puzzle.drop.data +
+Interface DropCodes

+
+
All Superinterfaces:
PuzzleGameCodes
+
+
+
All Known Implementing Classes:
DropControllerDelegate, DropManagerDelegate
+
+
+
+
public interface DropCodes
extends PuzzleGameCodes
+ + +

+Contains codes used by the drop game services. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + +
+Field Summary
+static StringDROP_MESSAGE_BUNDLE + +
+          The message bundle identifier for drop puzzle messages.
+static StringDROP_STREAM + +
+          The name of the control stream that provides drop pieces.
+static StringRISE_STREAM + +
+          The name of the control stream that provides rise pieces.
+  +

+ + + + + + + + +
+Field Detail
+ +

+DROP_MESSAGE_BUNDLE

+
+static final String DROP_MESSAGE_BUNDLE
+
+
The message bundle identifier for drop puzzle messages. +

+

+
See Also:
Constant Field Values
+
+
+ +

+DROP_STREAM

+
+static final String DROP_STREAM
+
+
The name of the control stream that provides drop pieces. +

+

+
See Also:
Constant Field Values
+
+
+ +

+RISE_STREAM

+
+static final String RISE_STREAM
+
+
The name of the control stream that provides rise pieces. +

+

+
See Also:
Constant Field Values
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/data/DropConfig.html b/apidocs/com/threerings/puzzle/drop/data/DropConfig.html new file mode 100644 index 00000000..055eb9fb --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/data/DropConfig.html @@ -0,0 +1,234 @@ + + + + + + + +DropConfig (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.puzzle.drop.data +
+Interface DropConfig

+
+
+
public interface DropConfig
+ + +

+Provides access to the configuration information for a drop puzzle game. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + +
+Method Summary
+ intgetBoardHeight() + +
+          Returns the board height in pieces.
+ intgetBoardWidth() + +
+          Returns the board width in pieces.
+  +

+ + + + + + + + +
+Method Detail
+ +

+getBoardWidth

+
+int getBoardWidth()
+
+
Returns the board width in pieces. +

+

+
+
+
+
+ +

+getBoardHeight

+
+int getBoardHeight()
+
+
Returns the board height in pieces. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/data/DropLogic.html b/apidocs/com/threerings/puzzle/drop/data/DropLogic.html new file mode 100644 index 00000000..25df2f17 --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/data/DropLogic.html @@ -0,0 +1,236 @@ + + + + + + + +DropLogic (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.puzzle.drop.data +
+Interface DropLogic

+
+
+
public interface DropLogic
+ + +

+Describes the features and configuration desired for a given drop puzzle game. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + +
+Method Summary
+ booleanuseBlockDropping() + +
+          Returns whether the puzzle game would like to make use of the manipulable block dropping + functionality.
+ booleanuseBoardRising() + +
+          Returns whether the puzzle game would like to make use of the rising board functionality.
+  +

+ + + + + + + + +
+Method Detail
+ +

+useBlockDropping

+
+boolean useBlockDropping()
+
+
Returns whether the puzzle game would like to make use of the manipulable block dropping + functionality. +

+

+
+
+
+
+ +

+useBoardRising

+
+boolean useBoardRising()
+
+
Returns whether the puzzle game would like to make use of the rising board functionality. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/data/DropPieceCodes.html b/apidocs/com/threerings/puzzle/drop/data/DropPieceCodes.html new file mode 100644 index 00000000..fa45a537 --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/data/DropPieceCodes.html @@ -0,0 +1,246 @@ + + + + + + + +DropPieceCodes (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.puzzle.drop.data +
+Interface DropPieceCodes

+
+
All Superinterfaces:
com.threerings.util.DirectionCodes
+
+
+
All Known Implementing Classes:
DropBoard, DropBoardView, DropControllerDelegate, PieceDestroyer, PieceDropper
+
+
+
+
public interface DropPieceCodes
extends com.threerings.util.DirectionCodes
+ + +

+The drop piece codes interface contains constants common to the drop game package. +

+ +

+

+ +

+ + + + + + + + + + + + + + + +
+Field Summary
+static intDROP_BLOCK_PIECE_COUNT + +
+          The number of pieces in a drop block.
+static bytePIECE_NONE + +
+          The piece constant denoting an empty board piece.
+  + + + + + + + +
Fields inherited from interface com.threerings.util.DirectionCodes
CARDINAL_DIRECTIONS, CCW, CW, DIRECTION_COUNT, DOWN, EAST, EASTNORTHEAST, EASTSOUTHEAST, FINE_DIRECTION_COUNT, HORIZONTAL, LEFT, NONE, NORTH, NORTHEAST, NORTHNORTHEAST, NORTHNORTHWEST, NORTHWEST, RIGHT, SOUTH, SOUTHEAST, SOUTHSOUTHEAST, SOUTHSOUTHWEST, SOUTHWEST, UP, VERTICAL, WEST, WESTNORTHWEST, WESTSOUTHWEST
+  +

+ + + + + + + + +
+Field Detail
+ +

+PIECE_NONE

+
+static final byte PIECE_NONE
+
+
The piece constant denoting an empty board piece. +

+

+
See Also:
Constant Field Values
+
+
+ +

+DROP_BLOCK_PIECE_COUNT

+
+static final int DROP_BLOCK_PIECE_COUNT
+
+
The number of pieces in a drop block. +

+

+
See Also:
Constant Field Values
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/data/SegmentInfo.html b/apidocs/com/threerings/puzzle/drop/data/SegmentInfo.html new file mode 100644 index 00000000..462db7d1 --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/data/SegmentInfo.html @@ -0,0 +1,368 @@ + + + + + + + +SegmentInfo (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.puzzle.drop.data +
+Class SegmentInfo

+
+java.lang.Object
+  extended by com.threerings.puzzle.drop.data.SegmentInfo
+
+
+
+
public class SegmentInfo
extends Object
+ + +

+Describes a segment of pieces in a DropBoard. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+ intdir + +
+          The segment's direction; one of DirectionCodes.HORIZONTAL + or DirectionCodes.VERTICAL.
+ intlen + +
+          The segment's length in pieces.
+ intx + +
+          The segment's lower-left board coordinates.
+ inty + +
+          The segment's lower-left board coordinates.
+  + + + + + + + + + + +
+Constructor Summary
SegmentInfo(int dir, + int x, + int y, + int len) + +
+          Constructs a segment info object.
+  + + + + + + + + + + + +
+Method Summary
+ StringtoString() + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+dir

+
+public int dir
+
+
The segment's direction; one of DirectionCodes.HORIZONTAL + or DirectionCodes.VERTICAL. +

+

+
+
+
+ +

+x

+
+public int x
+
+
The segment's lower-left board coordinates. +

+

+
+
+
+ +

+y

+
+public int y
+
+
The segment's lower-left board coordinates. +

+

+
+
+
+ +

+len

+
+public int len
+
+
The segment's length in pieces. +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+SegmentInfo

+
+public SegmentInfo(int dir,
+                   int x,
+                   int y,
+                   int len)
+
+
Constructs a segment info object. +

+

+ + + + + + + + +
+Method Detail
+ +

+toString

+
+public String toString()
+
+
+
Overrides:
toString in class Object
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/data/class-use/DropBoard.PieceOperation.html b/apidocs/com/threerings/puzzle/drop/data/class-use/DropBoard.PieceOperation.html new file mode 100644 index 00000000..35d0f910 --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/data/class-use/DropBoard.PieceOperation.html @@ -0,0 +1,256 @@ + + + + + + + +Uses of Interface com.threerings.puzzle.drop.data.DropBoard.PieceOperation (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.puzzle.drop.data.DropBoard.PieceOperation

+
+ + + + + + + + + + + + + +
+Packages that use DropBoard.PieceOperation
com.threerings.puzzle.drop.data  
com.threerings.puzzle.drop.util  
+  +

+ + + + + +
+Uses of DropBoard.PieceOperation in com.threerings.puzzle.drop.data
+  +

+ + + + + + + + + +
Fields in com.threerings.puzzle.drop.data declared as DropBoard.PieceOperation
+static DropBoard.PieceOperationDropBoard.CLEAR_OP + +
+          An operation that does naught but clear pieces, which proves to be generally useful.
+  +

+ + + + + + + + + + + + + + + + + +
Methods in com.threerings.puzzle.drop.data with parameters of type DropBoard.PieceOperation
+ voidDropBoard.applyOp(int col, + int row, + DropBoard.PieceOperation op) + +
+          Applies a specified DropBoard.PieceOperation to the specified piece in the board.
+ voidDropBoard.applyOp(int dir, + int col, + int row, + DropBoard.PieceOperation op) + +
+          Applies a specified DropBoard.PieceOperation to all pieces in the specified row or column + starting at the specified coordinates and spanning the remainder of the row or column + (depending on the application direction) in the board.
+ voidDropBoard.applyOp(int dir, + int col, + int row, + int len, + DropBoard.PieceOperation op) + +
+          Applies a specified DropBoard.PieceOperation to all pieces in a row or column segment + starting at the specified coordinates and of the specified length in the board.
+  +

+ + + + + +
+Uses of DropBoard.PieceOperation in com.threerings.puzzle.drop.util
+  +

+ + + + + + + + + +
Methods in com.threerings.puzzle.drop.util with parameters of type DropBoard.PieceOperation
+ List<SegmentInfo>PieceDestroyer.destroyPieces(DropBoard board, + DropBoard.PieceOperation destroyOp) + +
+          Destroys all pieces in the given board that are in contiguous rows or columns of pieces, + returning a list of SegmentInfo objects detailing the destroyed piece segments.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/data/class-use/DropBoard.html b/apidocs/com/threerings/puzzle/drop/data/class-use/DropBoard.html new file mode 100644 index 00000000..b37f96a3 --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/data/class-use/DropBoard.html @@ -0,0 +1,298 @@ + + + + + + + +Uses of Class com.threerings.puzzle.drop.data.DropBoard (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.puzzle.drop.data.DropBoard

+
+ + + + + + + + + + + + + + + + + +
+Packages that use DropBoard
com.threerings.puzzle.drop.client  
com.threerings.puzzle.drop.data  
com.threerings.puzzle.drop.util  
+  +

+ + + + + +
+Uses of DropBoard in com.threerings.puzzle.drop.client
+  +

+ + + + + + + + +
Constructors in com.threerings.puzzle.drop.client with parameters of type DropBoard
PieceGroupAnimation(DropBoardView view, + DropBoard board) + +
+          Creates a piece group animation which must be initialized with a subsequent call to + AbstractMedia.init(AbstractMediaManager).
+  +

+ + + + + +
+Uses of DropBoard in com.threerings.puzzle.drop.data
+  +

+ + + + + + + + + +
Methods in com.threerings.puzzle.drop.data that return DropBoard
+ DropBoardDropBoard.clone() + +
+           
+  +

+ + + + + + + + + + + + + +
Methods in com.threerings.puzzle.drop.data with parameters of type DropBoard
+ voidDropBoard.copyInto(DropBoard board) + +
+          Copies the contents of this board directly into the supplied board, overwriting the + destination board in its entirety.
+ booleanDropBoard.PieceOperation.execute(DropBoard board, + int col, + int row) + +
+          Called for each piece in the board segment the operation is being applied to.
+  +

+ + + + + +
+Uses of DropBoard in com.threerings.puzzle.drop.util
+  +

+ + + + + + + + + + + + + + + + + + + + + +
Methods in com.threerings.puzzle.drop.util with parameters of type DropBoard
+ List<SegmentInfo>PieceDestroyer.destroyPieces(DropBoard board, + DropBoard.PieceOperation destroyOp) + +
+          Destroys all pieces in the given board that are in contiguous rows or columns of pieces, + returning a list of SegmentInfo objects detailing the destroyed piece segments.
+ intPieceDropper.dropPieces(DropBoard board, + PieceDropper.DropObserver drobs) + +
+          Effects any drops possible on the supplied board (modifying the board in the progress) and + notifying the supplied drop observer of those drops.
+ intPieceDropper.fillBoard(DropBoard board, + PieceDropper.DropObserver drobs) + +
+          Drops new pieces onto the board to fill the gaps.
+ intPieceDropLogic.getConstrainedEdge(DropBoard board, + int col, + int row, + int dir) + +
+          Returns the x-axis coordinate of the specified edge of the given constrained piece.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/data/class-use/DropBoardSummary.html b/apidocs/com/threerings/puzzle/drop/data/class-use/DropBoardSummary.html new file mode 100644 index 00000000..8685925f --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/data/class-use/DropBoardSummary.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.puzzle.drop.data.DropBoardSummary (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.puzzle.drop.data.DropBoardSummary

+
+No usage of com.threerings.puzzle.drop.data.DropBoardSummary +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/data/class-use/DropCodes.html b/apidocs/com/threerings/puzzle/drop/data/class-use/DropCodes.html new file mode 100644 index 00000000..633043ba --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/data/class-use/DropCodes.html @@ -0,0 +1,215 @@ + + + + + + + +Uses of Interface com.threerings.puzzle.drop.data.DropCodes (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.puzzle.drop.data.DropCodes

+
+ + + + + + + + + + + + + +
+Packages that use DropCodes
com.threerings.puzzle.drop.client  
com.threerings.puzzle.drop.server  
+  +

+ + + + + +
+Uses of DropCodes in com.threerings.puzzle.drop.client
+  +

+ + + + + + + + + +
Classes in com.threerings.puzzle.drop.client that implement DropCodes
+ classDropControllerDelegate + +
+          Games that wish to make use of the drop puzzle services will need to create an extension of + this delegate class, customizing it for their particular game and then adding it via + PlaceController.addDelegate(com.threerings.crowd.client.PlaceControllerDelegate).
+  +

+ + + + + +
+Uses of DropCodes in com.threerings.puzzle.drop.server
+  +

+ + + + + + + + + +
Classes in com.threerings.puzzle.drop.server that implement DropCodes
+ classDropManagerDelegate + +
+          Provides the necessary support for a puzzle game that involves a two-dimensional board + containing pieces, with new pieces either falling into the board as a "drop block", or rising + into the bottom of the board in new piece rows, groups of blocks can be "broken" and garbage + can be sent to other players' boards as a result.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/data/class-use/DropConfig.html b/apidocs/com/threerings/puzzle/drop/data/class-use/DropConfig.html new file mode 100644 index 00000000..d0788350 --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/data/class-use/DropConfig.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Interface com.threerings.puzzle.drop.data.DropConfig (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.puzzle.drop.data.DropConfig

+
+No usage of com.threerings.puzzle.drop.data.DropConfig +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/data/class-use/DropLogic.html b/apidocs/com/threerings/puzzle/drop/data/class-use/DropLogic.html new file mode 100644 index 00000000..c3fa4382 --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/data/class-use/DropLogic.html @@ -0,0 +1,215 @@ + + + + + + + +Uses of Interface com.threerings.puzzle.drop.data.DropLogic (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.puzzle.drop.data.DropLogic

+
+ + + + + + + + + + + + + +
+Packages that use DropLogic
com.threerings.puzzle.drop.client  
com.threerings.puzzle.drop.server  
+  +

+ + + + + +
+Uses of DropLogic in com.threerings.puzzle.drop.client
+  +

+ + + + + + + + +
Constructors in com.threerings.puzzle.drop.client with parameters of type DropLogic
DropControllerDelegate(PuzzleController ctrl, + DropLogic logic) + +
+          Creates a delegate with the specified drop game logic and controller.
+  +

+ + + + + +
+Uses of DropLogic in com.threerings.puzzle.drop.server
+  +

+ + + + + + + + + + + +
Constructors in com.threerings.puzzle.drop.server with parameters of type DropLogic
DropManagerDelegate(DropLogic logic) + +
+          Creates a drop manager delegate with a logic that it uses to determine how to manage the + drop puzzle.
DropManagerDelegate(PuzzleManager puzmgr, + DropLogic logic) + +
+          Deprecated. use DropManagerDelegate.DropManagerDelegate(DropLogic).
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/data/class-use/DropPieceCodes.html b/apidocs/com/threerings/puzzle/drop/data/class-use/DropPieceCodes.html new file mode 100644 index 00000000..23f1b28b --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/data/class-use/DropPieceCodes.html @@ -0,0 +1,258 @@ + + + + + + + +Uses of Interface com.threerings.puzzle.drop.data.DropPieceCodes (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.puzzle.drop.data.DropPieceCodes

+
+ + + + + + + + + + + + + + + + + +
+Packages that use DropPieceCodes
com.threerings.puzzle.drop.client  
com.threerings.puzzle.drop.data  
com.threerings.puzzle.drop.util  
+  +

+ + + + + +
+Uses of DropPieceCodes in com.threerings.puzzle.drop.client
+  +

+ + + + + + + + + + + + + +
Classes in com.threerings.puzzle.drop.client that implement DropPieceCodes
+ classDropBoardView + +
+          The drop board view displays a drop puzzle game in progress for a single player.
+ classDropControllerDelegate + +
+          Games that wish to make use of the drop puzzle services will need to create an extension of + this delegate class, customizing it for their particular game and then adding it via + PlaceController.addDelegate(com.threerings.crowd.client.PlaceControllerDelegate).
+  +

+ + + + + +
+Uses of DropPieceCodes in com.threerings.puzzle.drop.data
+  +

+ + + + + + + + + +
Classes in com.threerings.puzzle.drop.data that implement DropPieceCodes
+ classDropBoard + +
+          A class that provides for various useful logical operations to be enacted on a two-dimensional + board and provides an easier mechanism for referencing pieces by position.
+  +

+ + + + + +
+Uses of DropPieceCodes in com.threerings.puzzle.drop.util
+  +

+ + + + + + + + + + + + + +
Classes in com.threerings.puzzle.drop.util that implement DropPieceCodes
+ classPieceDestroyer + +
+          Handles destroying contiguous piece segments in a drop board.
+ classPieceDropper + +
+          Handles dropping pieces in a board.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/data/class-use/SegmentInfo.html b/apidocs/com/threerings/puzzle/drop/data/class-use/SegmentInfo.html new file mode 100644 index 00000000..ed9b27a2 --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/data/class-use/SegmentInfo.html @@ -0,0 +1,183 @@ + + + + + + + +Uses of Class com.threerings.puzzle.drop.data.SegmentInfo (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.puzzle.drop.data.SegmentInfo

+
+ + + + + + + + + +
+Packages that use SegmentInfo
com.threerings.puzzle.drop.util  
+  +

+ + + + + +
+Uses of SegmentInfo in com.threerings.puzzle.drop.util
+  +

+ + + + + + + + + +
Methods in com.threerings.puzzle.drop.util that return types with arguments of type SegmentInfo
+ List<SegmentInfo>PieceDestroyer.destroyPieces(DropBoard board, + DropBoard.PieceOperation destroyOp) + +
+          Destroys all pieces in the given board that are in contiguous rows or columns of pieces, + returning a list of SegmentInfo objects detailing the destroyed piece segments.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/data/package-frame.html b/apidocs/com/threerings/puzzle/drop/data/package-frame.html new file mode 100644 index 00000000..b529b105 --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/data/package-frame.html @@ -0,0 +1,56 @@ + + + + + + + +com.threerings.puzzle.drop.data (vilya 1.3 API) + + + + + + + + + + + +com.threerings.puzzle.drop.data + + + + +
+Interfaces  + +
+DropBoard.PieceOperation +
+DropCodes +
+DropConfig +
+DropLogic +
+DropPieceCodes
+ + + + + + +
+Classes  + +
+DropBoard +
+DropBoardSummary +
+SegmentInfo
+ + + + diff --git a/apidocs/com/threerings/puzzle/drop/data/package-summary.html b/apidocs/com/threerings/puzzle/drop/data/package-summary.html new file mode 100644 index 00000000..95d68c48 --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/data/package-summary.html @@ -0,0 +1,198 @@ + + + + + + + +com.threerings.puzzle.drop.data (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.puzzle.drop.data +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
+Interface Summary
DropBoard.PieceOperationAn interface to be implemented by classes that would like to apply some operation to each + piece in a column or row segment in the board.
DropCodesContains codes used by the drop game services.
DropConfigProvides access to the configuration information for a drop puzzle game.
DropLogicDescribes the features and configuration desired for a given drop puzzle game.
DropPieceCodesThe drop piece codes interface contains constants common to the drop game package.
+  + +

+ + + + + + + + + + + + + + + + + +
+Class Summary
DropBoardA class that provides for various useful logical operations to be enacted on a two-dimensional + board and provides an easier mechanism for referencing pieces by position.
DropBoardSummaryProvides a summary of a DropBoard.
SegmentInfoDescribes a segment of pieces in a DropBoard.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/data/package-tree.html b/apidocs/com/threerings/puzzle/drop/data/package-tree.html new file mode 100644 index 00000000..3aedace7 --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/data/package-tree.html @@ -0,0 +1,172 @@ + + + + + + + +com.threerings.puzzle.drop.data Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.puzzle.drop.data +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/data/package-use.html b/apidocs/com/threerings/puzzle/drop/data/package-use.html new file mode 100644 index 00000000..ac2bbf84 --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/data/package-use.html @@ -0,0 +1,287 @@ + + + + + + + +Uses of Package com.threerings.puzzle.drop.data (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.puzzle.drop.data

+
+ + + + + + + + + + + + + + + + + + + + + +
+Packages that use com.threerings.puzzle.drop.data
com.threerings.puzzle.drop.client  
com.threerings.puzzle.drop.data  
com.threerings.puzzle.drop.server  
com.threerings.puzzle.drop.util  
+  +

+ + + + + + + + + + + + + + + + + +
+Classes in com.threerings.puzzle.drop.data used by com.threerings.puzzle.drop.client
DropBoard + +
+          A class that provides for various useful logical operations to be enacted on a two-dimensional + board and provides an easier mechanism for referencing pieces by position.
DropCodes + +
+          Contains codes used by the drop game services.
DropLogic + +
+          Describes the features and configuration desired for a given drop puzzle game.
DropPieceCodes + +
+          The drop piece codes interface contains constants common to the drop game package.
+  +

+ + + + + + + + + + + + + + +
+Classes in com.threerings.puzzle.drop.data used by com.threerings.puzzle.drop.data
DropBoard + +
+          A class that provides for various useful logical operations to be enacted on a two-dimensional + board and provides an easier mechanism for referencing pieces by position.
DropBoard.PieceOperation + +
+          An interface to be implemented by classes that would like to apply some operation to each + piece in a column or row segment in the board.
DropPieceCodes + +
+          The drop piece codes interface contains constants common to the drop game package.
+  +

+ + + + + + + + + + + +
+Classes in com.threerings.puzzle.drop.data used by com.threerings.puzzle.drop.server
DropCodes + +
+          Contains codes used by the drop game services.
DropLogic + +
+          Describes the features and configuration desired for a given drop puzzle game.
+  +

+ + + + + + + + + + + + + + + + + +
+Classes in com.threerings.puzzle.drop.data used by com.threerings.puzzle.drop.util
DropBoard + +
+          A class that provides for various useful logical operations to be enacted on a two-dimensional + board and provides an easier mechanism for referencing pieces by position.
DropBoard.PieceOperation + +
+          An interface to be implemented by classes that would like to apply some operation to each + piece in a column or row segment in the board.
DropPieceCodes + +
+          The drop piece codes interface contains constants common to the drop game package.
SegmentInfo + +
+          Describes a segment of pieces in a DropBoard.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/server/DropManagerDelegate.html b/apidocs/com/threerings/puzzle/drop/server/DropManagerDelegate.html new file mode 100644 index 00000000..4956315d --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/server/DropManagerDelegate.html @@ -0,0 +1,407 @@ + + + + + + + +DropManagerDelegate (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.puzzle.drop.server +
+Class DropManagerDelegate

+
+java.lang.Object
+  extended by com.threerings.crowd.server.PlaceManagerDelegate
+      extended by com.threerings.parlor.server.PlayManagerDelegate
+          extended by com.threerings.parlor.game.server.GameManagerDelegate
+              extended by com.threerings.puzzle.server.PuzzleManagerDelegate
+                  extended by com.threerings.puzzle.drop.server.DropManagerDelegate
+
+
+
All Implemented Interfaces:
com.threerings.presents.data.InvocationCodes, PuzzleCodes, PuzzleGameCodes, DropCodes
+
+
+
+
public abstract class DropManagerDelegate
extends PuzzleManagerDelegate
implements PuzzleCodes, DropCodes
+ + +

+Provides the necessary support for a puzzle game that involves a two-dimensional board + containing pieces, with new pieces either falling into the board as a "drop block", or rising + into the bottom of the board in new piece rows, groups of blocks can be "broken" and garbage + can be sent to other players' boards as a result. This is implemented as a delegate so that the + natural hierarchy need not be twisted to differentiate between puzzles that use piece dropping + and those that don't. Because we have need to structure our hierarchy around things like + whether a puzzle is a duty puzzle, this becomes necessary. + +

A puzzle game using these services will then need to extend this delegate, implementing the + necessary methods to customize it for the particulars of their game and then register it with + their game manager via PlaceManager.addDelegate(com.threerings.crowd.server.PlaceManagerDelegate). + +

It also keeps track of, for each player, board level information, and player game status. + Miscellaneous utility routines are provided for checking things like whether the game is over, + whether a player is still active in the game, and so forth. + +

Derived classes are likely to want to override getPieceDropLogic(). +

+ +

+

+ +

+ + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from interface com.threerings.puzzle.data.PuzzleCodes
DEBUG_PUZZLE, DEFAULT_DIFFICULTY, PUZZLE_MESSAGE_BUNDLE
+  + + + + + + + +
Fields inherited from interface com.threerings.presents.data.InvocationCodes
ACCESS_DENIED, E_ACCESS_DENIED, E_INTERNAL_ERROR, GLOBAL_GROUP, INTERNAL_ERROR
+  + + + + + + + +
Fields inherited from interface com.threerings.puzzle.drop.data.DropCodes
DROP_MESSAGE_BUNDLE, DROP_STREAM, RISE_STREAM
+  + + + + + + + + + + + + + +
+Constructor Summary
DropManagerDelegate(DropLogic logic) + +
+          Creates a drop manager delegate with a logic that it uses to determine how to manage the + drop puzzle.
DropManagerDelegate(PuzzleManager puzmgr, + DropLogic logic) + +
+          Deprecated. use DropManagerDelegate(DropLogic).
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voiddidInit(com.threerings.crowd.data.PlaceConfig config) + +
+           
+ voiddidStartup(com.threerings.crowd.data.PlaceObject plobj) + +
+           
+ voidgameWillStart() + +
+          Called by the game manager when the game is about to start.
+  + + + + + + + +
Methods inherited from class com.threerings.parlor.game.server.GameManagerDelegate
gameDidEnd, gameDidStart, gameWillEnd, gameWillReset, playerWasReplaced, setAI, tickAI
+  + + + + + + + +
Methods inherited from class com.threerings.crowd.server.PlaceManagerDelegate
bodyEntered, bodyLeft, bodyUpdated, didShutdown, init, placeBecameEmpty, where
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+DropManagerDelegate

+
+@Deprecated
+public DropManagerDelegate(PuzzleManager puzmgr,
+                                      DropLogic logic)
+
+
Deprecated. use DropManagerDelegate(DropLogic). +

+

+
+ +

+DropManagerDelegate

+
+public DropManagerDelegate(DropLogic logic)
+
+
Creates a drop manager delegate with a logic that it uses to determine how to manage the + drop puzzle. +

+

+ + + + + + + + +
+Method Detail
+ +

+didInit

+
+public void didInit(com.threerings.crowd.data.PlaceConfig config)
+
+
+
Overrides:
didInit in class PuzzleManagerDelegate
+
+
+
+
+
+
+ +

+didStartup

+
+public void didStartup(com.threerings.crowd.data.PlaceObject plobj)
+
+
+
Overrides:
didStartup in class com.threerings.crowd.server.PlaceManagerDelegate
+
+
+
+
+
+
+ +

+gameWillStart

+
+public void gameWillStart()
+
+
Description copied from class: GameManagerDelegate
+
Called by the game manager when the game is about to start. +

+

+
Overrides:
gameWillStart in class GameManagerDelegate
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/server/class-use/DropManagerDelegate.html b/apidocs/com/threerings/puzzle/drop/server/class-use/DropManagerDelegate.html new file mode 100644 index 00000000..725ca52f --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/server/class-use/DropManagerDelegate.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.puzzle.drop.server.DropManagerDelegate (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.puzzle.drop.server.DropManagerDelegate

+
+No usage of com.threerings.puzzle.drop.server.DropManagerDelegate +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/server/package-frame.html b/apidocs/com/threerings/puzzle/drop/server/package-frame.html new file mode 100644 index 00000000..25771b3f --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/server/package-frame.html @@ -0,0 +1,33 @@ + + + + + + + +com.threerings.puzzle.drop.server (vilya 1.3 API) + + + + + + + + + + + +com.threerings.puzzle.drop.server + + + + +
+Classes  + +
+DropManagerDelegate
+ + + + diff --git a/apidocs/com/threerings/puzzle/drop/server/package-summary.html b/apidocs/com/threerings/puzzle/drop/server/package-summary.html new file mode 100644 index 00000000..e8e0fa4d --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/server/package-summary.html @@ -0,0 +1,161 @@ + + + + + + + +com.threerings.puzzle.drop.server (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.puzzle.drop.server +

+ + + + + + + + + +
+Class Summary
DropManagerDelegateProvides the necessary support for a puzzle game that involves a two-dimensional board + containing pieces, with new pieces either falling into the board as a "drop block", or rising + into the bottom of the board in new piece rows, groups of blocks can be "broken" and garbage + can be sent to other players' boards as a result.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/server/package-tree.html b/apidocs/com/threerings/puzzle/drop/server/package-tree.html new file mode 100644 index 00000000..193eb9e0 --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/server/package-tree.html @@ -0,0 +1,163 @@ + + + + + + + +com.threerings.puzzle.drop.server Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.puzzle.drop.server +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/server/package-use.html b/apidocs/com/threerings/puzzle/drop/server/package-use.html new file mode 100644 index 00000000..a848b1f9 --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/server/package-use.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Package com.threerings.puzzle.drop.server (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.puzzle.drop.server

+
+No usage of com.threerings.puzzle.drop.server +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/util/DropBoardUtil.html b/apidocs/com/threerings/puzzle/drop/util/DropBoardUtil.html new file mode 100644 index 00000000..720250c6 --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/util/DropBoardUtil.html @@ -0,0 +1,313 @@ + + + + + + + +DropBoardUtil (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.puzzle.drop.util +
+Class DropBoardUtil

+
+java.lang.Object
+  extended by com.threerings.puzzle.drop.util.DropBoardUtil
+
+
+
All Implemented Interfaces:
com.threerings.util.DirectionCodes
+
+
+
+
public class DropBoardUtil
extends Object
implements com.threerings.util.DirectionCodes
+ + +

+

+ +

+ + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from interface com.threerings.util.DirectionCodes
CARDINAL_DIRECTIONS, CCW, CW, DIRECTION_COUNT, DOWN, EAST, EASTNORTHEAST, EASTSOUTHEAST, FINE_DIRECTION_COUNT, HORIZONTAL, LEFT, NONE, NORTH, NORTHEAST, NORTHNORTHEAST, NORTHNORTHWEST, NORTHWEST, RIGHT, SOUTH, SOUTHEAST, SOUTHSOUTHEAST, SOUTHSOUTHWEST, SOUTHWEST, UP, VERTICAL, WEST, WESTNORTHWEST, WESTSOUTHWEST
+  + + + + + + + + + + +
+Constructor Summary
DropBoardUtil() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+static intgetRotatedOrientation(int orient, + int dir) + +
+          Returns the orientation resulting from rotating the block in the given direction.
+static intgetRotatedOrientation(int orient, + int dir, + int count) + +
+          Returns the orientation resulting from rotating the block in the given direction the + specified number of times.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+DropBoardUtil

+
+public DropBoardUtil()
+
+
+ + + + + + + + +
+Method Detail
+ +

+getRotatedOrientation

+
+public static int getRotatedOrientation(int orient,
+                                        int dir,
+                                        int count)
+
+
Returns the orientation resulting from rotating the block in the given direction the + specified number of times. +

+

+
+
+
+
Parameters:
orient - the current orientation.
dir - the direction to rotate in; one of CW or CCW.
count - the number of rotations to perform. +
Returns:
the rotated orientation.
+
+
+
+ +

+getRotatedOrientation

+
+public static int getRotatedOrientation(int orient,
+                                        int dir)
+
+
Returns the orientation resulting from rotating the block in the given direction. +

+

+
+
+
+
Parameters:
orient - the current orientation.
dir - the direction to rotate in; one of CW or CCW. +
Returns:
the rotated orientation.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/util/DropGameUtil.html b/apidocs/com/threerings/puzzle/drop/util/DropGameUtil.html new file mode 100644 index 00000000..dad2898a --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/util/DropGameUtil.html @@ -0,0 +1,259 @@ + + + + + + + +DropGameUtil (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.puzzle.drop.util +
+Class DropGameUtil

+
+java.lang.Object
+  extended by com.threerings.puzzle.drop.util.DropGameUtil
+
+
+
+
public class DropGameUtil
extends Object
+ + +

+Drop puzzle game related utilities. +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
DropGameUtil() + +
+           
+  + + + + + + + + + + + +
+Method Summary
+static com.threerings.util.KeyTranslatorImplgetKeyTranslator() + +
+          Returns a key translator configured with mappings suitable for a drop puzzle game.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+DropGameUtil

+
+public DropGameUtil()
+
+
+ + + + + + + + +
+Method Detail
+ +

+getKeyTranslator

+
+public static com.threerings.util.KeyTranslatorImpl getKeyTranslator()
+
+
Returns a key translator configured with mappings suitable for a drop puzzle game. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/util/PieceDestroyer.DestroyLogic.html b/apidocs/com/threerings/puzzle/drop/util/PieceDestroyer.DestroyLogic.html new file mode 100644 index 00000000..b34d2d84 --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/util/PieceDestroyer.DestroyLogic.html @@ -0,0 +1,242 @@ + + + + + + + +PieceDestroyer.DestroyLogic (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.puzzle.drop.util +
+Interface PieceDestroyer.DestroyLogic

+
+
Enclosing class:
PieceDestroyer
+
+
+
+
public static interface PieceDestroyer.DestroyLogic
+ + +

+An interface to be implemented by specific puzzles to detail the parameters and methodology + by which pieces are destroyed in the puzzle board. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + +
+Method Summary
+ intgetMinimumLength() + +
+          Returns the minimum length of a contiguously piece segment that should be destroyed.
+ booleanisEquivalent(int a, + int b) + +
+          Returns whether piece a is equivalent to piece b for the + purposes of including it in a contiguous piece segment to be destroyed.
+  +

+ + + + + + + + +
+Method Detail
+ +

+getMinimumLength

+
+int getMinimumLength()
+
+
Returns the minimum length of a contiguously piece segment that should be destroyed. +

+

+
+
+
+
+ +

+isEquivalent

+
+boolean isEquivalent(int a,
+                     int b)
+
+
Returns whether piece a is equivalent to piece b for the + purposes of including it in a contiguous piece segment to be destroyed. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/util/PieceDestroyer.html b/apidocs/com/threerings/puzzle/drop/util/PieceDestroyer.html new file mode 100644 index 00000000..f4be7a44 --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/util/PieceDestroyer.html @@ -0,0 +1,321 @@ + + + + + + + +PieceDestroyer (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.puzzle.drop.util +
+Class PieceDestroyer

+
+java.lang.Object
+  extended by com.threerings.puzzle.drop.util.PieceDestroyer
+
+
+
All Implemented Interfaces:
DropPieceCodes, com.threerings.util.DirectionCodes
+
+
+
+
public class PieceDestroyer
extends Object
implements DropPieceCodes
+ + +

+Handles destroying contiguous piece segments in a drop board. +

+ +

+

+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static interfacePieceDestroyer.DestroyLogic + +
+          An interface to be implemented by specific puzzles to detail the parameters and methodology + by which pieces are destroyed in the puzzle board.
+  + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from interface com.threerings.puzzle.drop.data.DropPieceCodes
DROP_BLOCK_PIECE_COUNT, PIECE_NONE
+  + + + + + + + +
Fields inherited from interface com.threerings.util.DirectionCodes
CARDINAL_DIRECTIONS, CCW, CW, DIRECTION_COUNT, DOWN, EAST, EASTNORTHEAST, EASTSOUTHEAST, FINE_DIRECTION_COUNT, HORIZONTAL, LEFT, NONE, NORTH, NORTHEAST, NORTHNORTHEAST, NORTHNORTHWEST, NORTHWEST, RIGHT, SOUTH, SOUTHEAST, SOUTHSOUTHEAST, SOUTHSOUTHWEST, SOUTHWEST, UP, VERTICAL, WEST, WESTNORTHWEST, WESTSOUTHWEST
+  + + + + + + + + + + +
+Constructor Summary
PieceDestroyer(PieceDestroyer.DestroyLogic logic) + +
+          Constructs a piece destroyer that destroys pieces as specified by the supplied destroy + logic.
+  + + + + + + + + + + + +
+Method Summary
+ List<SegmentInfo>destroyPieces(DropBoard board, + DropBoard.PieceOperation destroyOp) + +
+          Destroys all pieces in the given board that are in contiguous rows or columns of pieces, + returning a list of SegmentInfo objects detailing the destroyed piece segments.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+PieceDestroyer

+
+public PieceDestroyer(PieceDestroyer.DestroyLogic logic)
+
+
Constructs a piece destroyer that destroys pieces as specified by the supplied destroy + logic. +

+

+ + + + + + + + +
+Method Detail
+ +

+destroyPieces

+
+public List<SegmentInfo> destroyPieces(DropBoard board,
+                                       DropBoard.PieceOperation destroyOp)
+
+
Destroys all pieces in the given board that are in contiguous rows or columns of pieces, + returning a list of SegmentInfo objects detailing the destroyed piece segments. + Note that a single list is used internally to gather the segment info, and so callers that + care to modify the list should create their own copy; also, the pieces in the segments may + overlap, i.e., two segments may contain the same piece. +

+

+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/util/PieceDropLogic.html b/apidocs/com/threerings/puzzle/drop/util/PieceDropLogic.html new file mode 100644 index 00000000..294dd97c --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/util/PieceDropLogic.html @@ -0,0 +1,317 @@ + + + + + + + +PieceDropLogic (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.puzzle.drop.util +
+Interface PieceDropLogic

+
+
+
public interface PieceDropLogic
+ + +

+An interface to be implemented by games that would like to be able to drop their pieces during + game play. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ booleanboardAlwaysFilled() + +
+          Should the board always be filled?
+ intgetConstrainedEdge(DropBoard board, + int col, + int row, + int dir) + +
+          Returns the x-axis coordinate of the specified edge of the given constrained piece.
+ booleanisClimbablePiece(boolean allowConst, + int piece, + boolean pre) + +
+          Returns whether the given piece terminates a column climb when determining the height of a + piece column to be dropped.
+ booleanisConstrainedPiece(int piece) + +
+          Returns whether the given piece has constraints upon it that impact its droppability.
+ booleanisDroppablePiece(int piece) + +
+          Returns whether the given piece is potentially droppable.
+  +

+ + + + + + + + +
+Method Detail
+ +

+boardAlwaysFilled

+
+boolean boardAlwaysFilled()
+
+
Should the board always be filled? +

+

+ +
Returns:
false for normal behavior.
+
+
+
+ +

+isDroppablePiece

+
+boolean isDroppablePiece(int piece)
+
+
Returns whether the given piece is potentially droppable. +

+

+
+
+
+
+ +

+isConstrainedPiece

+
+boolean isConstrainedPiece(int piece)
+
+
Returns whether the given piece has constraints upon it that impact its droppability. +

+

+
+
+
+
+ +

+isClimbablePiece

+
+boolean isClimbablePiece(boolean allowConst,
+                         int piece,
+                         boolean pre)
+
+
Returns whether the given piece terminates a column climb when determining the height of a + piece column to be dropped. +

+

+
Parameters:
allowConst - whether to allow dropping constrained pieces (though only in the first + encountered constrained block.)
piece - the piece to consider.
pre - whether the climbability check is being performed before the height is + incremented, or after.
+
+
+
+ +

+getConstrainedEdge

+
+int getConstrainedEdge(DropBoard board,
+                       int col,
+                       int row,
+                       int dir)
+
+
Returns the x-axis coordinate of the specified edge of the given constrained piece. + +

TODO: This should go away once the sword and sail games have standardized on WEST/EAST + or BLOCK_LEFT/BLOCK_RIGHT to reference block edges. +

+

+
Parameters:
board - the board to search.
col - the column of the constrained piece.
row - the row of the constrained piece.
dir - the edge direction to find; one of DirectionCodes.LEFT or + DirectionCodes.RIGHT.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/util/PieceDropper.DropObserver.html b/apidocs/com/threerings/puzzle/drop/util/PieceDropper.DropObserver.html new file mode 100644 index 00000000..6023f5a3 --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/util/PieceDropper.DropObserver.html @@ -0,0 +1,224 @@ + + + + + + + +PieceDropper.DropObserver (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.puzzle.drop.util +
+Interface PieceDropper.DropObserver

+
+
Enclosing class:
PieceDropper
+
+
+
+
public static interface PieceDropper.DropObserver
+ + +

+Called to inform a drop observer that a piece has been dropped. +

+ +

+

+ +

+ + + + + + + + + + + + +
+Method Summary
+ voidpieceDropped(int piece, + int sx, + int sy, + int dx, + int dy) + +
+          Indicates that the specified piece was dropped.
+  +

+ + + + + + + + +
+Method Detail
+ +

+pieceDropped

+
+void pieceDropped(int piece,
+                  int sx,
+                  int sy,
+                  int dx,
+                  int dy)
+
+
Indicates that the specified piece was dropped. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/util/PieceDropper.PieceDropInfo.html b/apidocs/com/threerings/puzzle/drop/util/PieceDropper.PieceDropInfo.html new file mode 100644 index 00000000..b3fafc8e --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/util/PieceDropper.PieceDropInfo.html @@ -0,0 +1,367 @@ + + + + + + + +PieceDropper.PieceDropInfo (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.puzzle.drop.util +
+Class PieceDropper.PieceDropInfo

+
+java.lang.Object
+  extended by com.threerings.puzzle.drop.util.PieceDropper.PieceDropInfo
+
+
+
Enclosing class:
PieceDropper
+
+
+
+
public static class PieceDropper.PieceDropInfo
extends Object
+ + +

+A class to hold information detailing the pieces to be dropped in a particular column. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+ intcol + +
+          The column number.
+ intdist + +
+          The distance to drop the pieces.
+ int[]pieces + +
+          The pieces to be dropped.
+ introw + +
+          The starting row of the bottom piece being dropped.
+  + + + + + + + + + + +
+Constructor Summary
PieceDropper.PieceDropInfo(int col, + int row, + int dist) + +
+          Constructs a piece drop info object.
+  + + + + + + + + + + + +
+Method Summary
+ StringtoString() + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+row

+
+public int row
+
+
The starting row of the bottom piece being dropped. +

+

+
+
+
+ +

+col

+
+public int col
+
+
The column number. +

+

+
+
+
+ +

+dist

+
+public int dist
+
+
The distance to drop the pieces. +

+

+
+
+
+ +

+pieces

+
+public int[] pieces
+
+
The pieces to be dropped. +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+PieceDropper.PieceDropInfo

+
+public PieceDropper.PieceDropInfo(int col,
+                                  int row,
+                                  int dist)
+
+
Constructs a piece drop info object. +

+

+ + + + + + + + +
+Method Detail
+ +

+toString

+
+public String toString()
+
+
+
Overrides:
toString in class Object
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/util/PieceDropper.html b/apidocs/com/threerings/puzzle/drop/util/PieceDropper.html new file mode 100644 index 00000000..d6d64333 --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/util/PieceDropper.html @@ -0,0 +1,353 @@ + + + + + + + +PieceDropper (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.puzzle.drop.util +
+Class PieceDropper

+
+java.lang.Object
+  extended by com.threerings.puzzle.drop.util.PieceDropper
+
+
+
All Implemented Interfaces:
DropPieceCodes, com.threerings.util.DirectionCodes
+
+
+
+
public class PieceDropper
extends Object
implements DropPieceCodes
+ + +

+Handles dropping pieces in a board. +

+ +

+

+ +

+ + + + + + + + + + + + + + + +
+Nested Class Summary
+static interfacePieceDropper.DropObserver + +
+          Called to inform a drop observer that a piece has been dropped.
+static classPieceDropper.PieceDropInfo + +
+          A class to hold information detailing the pieces to be dropped in a particular column.
+  + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from interface com.threerings.puzzle.drop.data.DropPieceCodes
DROP_BLOCK_PIECE_COUNT, PIECE_NONE
+  + + + + + + + +
Fields inherited from interface com.threerings.util.DirectionCodes
CARDINAL_DIRECTIONS, CCW, CW, DIRECTION_COUNT, DOWN, EAST, EASTNORTHEAST, EASTSOUTHEAST, FINE_DIRECTION_COUNT, HORIZONTAL, LEFT, NONE, NORTH, NORTHEAST, NORTHNORTHEAST, NORTHNORTHWEST, NORTHWEST, RIGHT, SOUTH, SOUTHEAST, SOUTHSOUTHEAST, SOUTHSOUTHWEST, SOUTHWEST, UP, VERTICAL, WEST, WESTNORTHWEST, WESTSOUTHWEST
+  + + + + + + + + + + +
+Constructor Summary
PieceDropper(PieceDropLogic logic) + +
+          Constructs a piece dropper that uses the supplied piece drop logic to specialize itself for + a particular puzzle.
+  + + + + + + + + + + + + + + + +
+Method Summary
+ intdropPieces(DropBoard board, + PieceDropper.DropObserver drobs) + +
+          Effects any drops possible on the supplied board (modifying the board in the progress) and + notifying the supplied drop observer of those drops.
+ intfillBoard(DropBoard board, + PieceDropper.DropObserver drobs) + +
+          Drops new pieces onto the board to fill the gaps.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+PieceDropper

+
+public PieceDropper(PieceDropLogic logic)
+
+
Constructs a piece dropper that uses the supplied piece drop logic to specialize itself for + a particular puzzle. +

+

+ + + + + + + + +
+Method Detail
+ +

+dropPieces

+
+public int dropPieces(DropBoard board,
+                      PieceDropper.DropObserver drobs)
+
+
Effects any drops possible on the supplied board (modifying the board in the progress) and + notifying the supplied drop observer of those drops. +

+

+
+
+
+ +
Returns:
the number of pieces dropped.
+
+
+
+ +

+fillBoard

+
+public int fillBoard(DropBoard board,
+                     PieceDropper.DropObserver drobs)
+
+
Drops new pieces onto the board to fill the gaps. +

+

+
+
+
+ +
Returns:
the number of pieces dropped.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/util/class-use/DropBoardUtil.html b/apidocs/com/threerings/puzzle/drop/util/class-use/DropBoardUtil.html new file mode 100644 index 00000000..758cad61 --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/util/class-use/DropBoardUtil.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.puzzle.drop.util.DropBoardUtil (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.puzzle.drop.util.DropBoardUtil

+
+No usage of com.threerings.puzzle.drop.util.DropBoardUtil +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/util/class-use/DropGameUtil.html b/apidocs/com/threerings/puzzle/drop/util/class-use/DropGameUtil.html new file mode 100644 index 00000000..707a7d84 --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/util/class-use/DropGameUtil.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.puzzle.drop.util.DropGameUtil (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.puzzle.drop.util.DropGameUtil

+
+No usage of com.threerings.puzzle.drop.util.DropGameUtil +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/util/class-use/PieceDestroyer.DestroyLogic.html b/apidocs/com/threerings/puzzle/drop/util/class-use/PieceDestroyer.DestroyLogic.html new file mode 100644 index 00000000..17123f4b --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/util/class-use/PieceDestroyer.DestroyLogic.html @@ -0,0 +1,180 @@ + + + + + + + +Uses of Interface com.threerings.puzzle.drop.util.PieceDestroyer.DestroyLogic (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.puzzle.drop.util.PieceDestroyer.DestroyLogic

+
+ + + + + + + + + +
+Packages that use PieceDestroyer.DestroyLogic
com.threerings.puzzle.drop.util  
+  +

+ + + + + +
+Uses of PieceDestroyer.DestroyLogic in com.threerings.puzzle.drop.util
+  +

+ + + + + + + + +
Constructors in com.threerings.puzzle.drop.util with parameters of type PieceDestroyer.DestroyLogic
PieceDestroyer(PieceDestroyer.DestroyLogic logic) + +
+          Constructs a piece destroyer that destroys pieces as specified by the supplied destroy + logic.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/util/class-use/PieceDestroyer.html b/apidocs/com/threerings/puzzle/drop/util/class-use/PieceDestroyer.html new file mode 100644 index 00000000..fbfb1d0f --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/util/class-use/PieceDestroyer.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.puzzle.drop.util.PieceDestroyer (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.puzzle.drop.util.PieceDestroyer

+
+No usage of com.threerings.puzzle.drop.util.PieceDestroyer +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/util/class-use/PieceDropLogic.html b/apidocs/com/threerings/puzzle/drop/util/class-use/PieceDropLogic.html new file mode 100644 index 00000000..8f8298e9 --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/util/class-use/PieceDropLogic.html @@ -0,0 +1,180 @@ + + + + + + + +Uses of Interface com.threerings.puzzle.drop.util.PieceDropLogic (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.puzzle.drop.util.PieceDropLogic

+
+ + + + + + + + + +
+Packages that use PieceDropLogic
com.threerings.puzzle.drop.util  
+  +

+ + + + + +
+Uses of PieceDropLogic in com.threerings.puzzle.drop.util
+  +

+ + + + + + + + +
Constructors in com.threerings.puzzle.drop.util with parameters of type PieceDropLogic
PieceDropper(PieceDropLogic logic) + +
+          Constructs a piece dropper that uses the supplied piece drop logic to specialize itself for + a particular puzzle.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/util/class-use/PieceDropper.DropObserver.html b/apidocs/com/threerings/puzzle/drop/util/class-use/PieceDropper.DropObserver.html new file mode 100644 index 00000000..9ee39684 --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/util/class-use/PieceDropper.DropObserver.html @@ -0,0 +1,192 @@ + + + + + + + +Uses of Interface com.threerings.puzzle.drop.util.PieceDropper.DropObserver (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.puzzle.drop.util.PieceDropper.DropObserver

+
+ + + + + + + + + +
+Packages that use PieceDropper.DropObserver
com.threerings.puzzle.drop.util  
+  +

+ + + + + +
+Uses of PieceDropper.DropObserver in com.threerings.puzzle.drop.util
+  +

+ + + + + + + + + + + + + +
Methods in com.threerings.puzzle.drop.util with parameters of type PieceDropper.DropObserver
+ intPieceDropper.dropPieces(DropBoard board, + PieceDropper.DropObserver drobs) + +
+          Effects any drops possible on the supplied board (modifying the board in the progress) and + notifying the supplied drop observer of those drops.
+ intPieceDropper.fillBoard(DropBoard board, + PieceDropper.DropObserver drobs) + +
+          Drops new pieces onto the board to fill the gaps.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/util/class-use/PieceDropper.PieceDropInfo.html b/apidocs/com/threerings/puzzle/drop/util/class-use/PieceDropper.PieceDropInfo.html new file mode 100644 index 00000000..9005333e --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/util/class-use/PieceDropper.PieceDropInfo.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.puzzle.drop.util.PieceDropper.PieceDropInfo (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.puzzle.drop.util.PieceDropper.PieceDropInfo

+
+No usage of com.threerings.puzzle.drop.util.PieceDropper.PieceDropInfo +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/util/class-use/PieceDropper.html b/apidocs/com/threerings/puzzle/drop/util/class-use/PieceDropper.html new file mode 100644 index 00000000..0519d4e9 --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/util/class-use/PieceDropper.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.puzzle.drop.util.PieceDropper (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.puzzle.drop.util.PieceDropper

+
+No usage of com.threerings.puzzle.drop.util.PieceDropper +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/util/package-frame.html b/apidocs/com/threerings/puzzle/drop/util/package-frame.html new file mode 100644 index 00000000..3cad001c --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/util/package-frame.html @@ -0,0 +1,56 @@ + + + + + + + +com.threerings.puzzle.drop.util (vilya 1.3 API) + + + + + + + + + + + +com.threerings.puzzle.drop.util + + + + +
+Interfaces  + +
+PieceDestroyer.DestroyLogic +
+PieceDropLogic +
+PieceDropper.DropObserver
+ + + + + + +
+Classes  + +
+DropBoardUtil +
+DropGameUtil +
+PieceDestroyer +
+PieceDropper +
+PieceDropper.PieceDropInfo
+ + + + diff --git a/apidocs/com/threerings/puzzle/drop/util/package-summary.html b/apidocs/com/threerings/puzzle/drop/util/package-summary.html new file mode 100644 index 00000000..0045123f --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/util/package-summary.html @@ -0,0 +1,198 @@ + + + + + + + +com.threerings.puzzle.drop.util (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.puzzle.drop.util +

+ + + + + + + + + + + + + + + + + +
+Interface Summary
PieceDestroyer.DestroyLogicAn interface to be implemented by specific puzzles to detail the parameters and methodology + by which pieces are destroyed in the puzzle board.
PieceDropLogicAn interface to be implemented by games that would like to be able to drop their pieces during + game play.
PieceDropper.DropObserverCalled to inform a drop observer that a piece has been dropped.
+  + +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
+Class Summary
DropBoardUtil 
DropGameUtilDrop puzzle game related utilities.
PieceDestroyerHandles destroying contiguous piece segments in a drop board.
PieceDropperHandles dropping pieces in a board.
PieceDropper.PieceDropInfoA class to hold information detailing the pieces to be dropped in a particular column.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/util/package-tree.html b/apidocs/com/threerings/puzzle/drop/util/package-tree.html new file mode 100644 index 00000000..f4bc238c --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/util/package-tree.html @@ -0,0 +1,162 @@ + + + + + + + +com.threerings.puzzle.drop.util Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.puzzle.drop.util +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/drop/util/package-use.html b/apidocs/com/threerings/puzzle/drop/util/package-use.html new file mode 100644 index 00000000..846a099c --- /dev/null +++ b/apidocs/com/threerings/puzzle/drop/util/package-use.html @@ -0,0 +1,185 @@ + + + + + + + +Uses of Package com.threerings.puzzle.drop.util (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.puzzle.drop.util

+
+ + + + + + + + + +
+Packages that use com.threerings.puzzle.drop.util
com.threerings.puzzle.drop.util  
+  +

+ + + + + + + + + + + + + + +
+Classes in com.threerings.puzzle.drop.util used by com.threerings.puzzle.drop.util
PieceDestroyer.DestroyLogic + +
+          An interface to be implemented by specific puzzles to detail the parameters and methodology + by which pieces are destroyed in the puzzle board.
PieceDropLogic + +
+          An interface to be implemented by games that would like to be able to drop their pieces during + game play.
PieceDropper.DropObserver + +
+          Called to inform a drop observer that a piece has been dropped.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/package-frame.html b/apidocs/com/threerings/puzzle/package-frame.html new file mode 100644 index 00000000..e653ba02 --- /dev/null +++ b/apidocs/com/threerings/puzzle/package-frame.html @@ -0,0 +1,33 @@ + + + + + + + +com.threerings.puzzle (vilya 1.3 API) + + + + + + + + + + + +com.threerings.puzzle + + + + +
+Classes  + +
+Log
+ + + + diff --git a/apidocs/com/threerings/puzzle/package-summary.html b/apidocs/com/threerings/puzzle/package-summary.html new file mode 100644 index 00000000..898a983b --- /dev/null +++ b/apidocs/com/threerings/puzzle/package-summary.html @@ -0,0 +1,158 @@ + + + + + + + +com.threerings.puzzle (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.puzzle +

+ + + + + + + + + +
+Class Summary
LogContains a reference to the log object used by this package.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/package-tree.html b/apidocs/com/threerings/puzzle/package-tree.html new file mode 100644 index 00000000..5de68fc1 --- /dev/null +++ b/apidocs/com/threerings/puzzle/package-tree.html @@ -0,0 +1,154 @@ + + + + + + + +com.threerings.puzzle Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.puzzle +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/package-use.html b/apidocs/com/threerings/puzzle/package-use.html new file mode 100644 index 00000000..26d234f6 --- /dev/null +++ b/apidocs/com/threerings/puzzle/package-use.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Package com.threerings.puzzle (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.puzzle

+
+No usage of com.threerings.puzzle +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/server/PuzzleGameProvider.html b/apidocs/com/threerings/puzzle/server/PuzzleGameProvider.html new file mode 100644 index 00000000..7d9439be --- /dev/null +++ b/apidocs/com/threerings/puzzle/server/PuzzleGameProvider.html @@ -0,0 +1,258 @@ + + + + + + + +PuzzleGameProvider (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.puzzle.server +
+Interface PuzzleGameProvider

+
+
All Superinterfaces:
com.threerings.presents.server.InvocationProvider
+
+
+
All Known Implementing Classes:
PuzzleManager
+
+
+
+
@Generated(value="com.threerings.presents.tools.GenServiceTask",
+           comments="Derived from PuzzleGameService.java.")
+public interface PuzzleGameProvider
extends com.threerings.presents.server.InvocationProvider
+ + +

+Defines the server-side of the PuzzleGameService. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + +
+Method Summary
+ voidupdateProgress(com.threerings.presents.data.ClientObject caller, + int arg1, + int[] arg2) + +
+          Handles a PuzzleGameService.updateProgress(int, int[]) request.
+ voidupdateProgressSync(com.threerings.presents.data.ClientObject caller, + int arg1, + int[] arg2, + Board[] arg3) + +
+          Handles a PuzzleGameService.updateProgressSync(int, int[], com.threerings.puzzle.data.Board[]) request.
+  +

+ + + + + + + + +
+Method Detail
+ +

+updateProgress

+
+void updateProgress(com.threerings.presents.data.ClientObject caller,
+                    int arg1,
+                    int[] arg2)
+
+
Handles a PuzzleGameService.updateProgress(int, int[]) request. +

+

+
+
+
+
+
+
+
+ +

+updateProgressSync

+
+void updateProgressSync(com.threerings.presents.data.ClientObject caller,
+                        int arg1,
+                        int[] arg2,
+                        Board[] arg3)
+
+
Handles a PuzzleGameService.updateProgressSync(int, int[], com.threerings.puzzle.data.Board[]) request. +

+

+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/server/PuzzleManager.html b/apidocs/com/threerings/puzzle/server/PuzzleManager.html new file mode 100644 index 00000000..6498cda8 --- /dev/null +++ b/apidocs/com/threerings/puzzle/server/PuzzleManager.html @@ -0,0 +1,512 @@ + + + + + + + +PuzzleManager (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.puzzle.server +
+Class PuzzleManager

+
+java.lang.Object
+  extended by com.threerings.crowd.server.PlaceManager
+      extended by com.threerings.parlor.game.server.GameManager
+          extended by com.threerings.puzzle.server.PuzzleManager
+
+
+
All Implemented Interfaces:
com.threerings.crowd.chat.server.SpeakHandler.SpeakerValidator, ParlorCodes, GameCodes, PlayManager, com.threerings.presents.data.InvocationCodes, com.threerings.presents.dobj.ChangeListener, com.threerings.presents.dobj.MessageListener, com.threerings.presents.server.InvocationProvider, PuzzleCodes, PuzzleGameProvider
+
+
+
+
public abstract class PuzzleManager
extends GameManager
implements PuzzleCodes, PuzzleGameProvider
+ + +

+Extends the GameManager with facilities for puzzle games. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.crowd.server.PlaceManager
com.threerings.crowd.server.PlaceManager.DelegateOp, com.threerings.crowd.server.PlaceManager.MessageHandler
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from interface com.threerings.puzzle.data.PuzzleCodes
DEBUG_PUZZLE, DEFAULT_DIFFICULTY, PUZZLE_MESSAGE_BUNDLE
+  + + + + + + + +
Fields inherited from interface com.threerings.presents.data.InvocationCodes
ACCESS_DENIED, E_ACCESS_DENIED, E_INTERNAL_ERROR, GLOBAL_GROUP, INTERNAL_ERROR
+  + + + + + + + +
Fields inherited from interface com.threerings.parlor.data.ParlorCodes
ALREADY_AT_TABLE, BANNED_FROM_TABLE, GAME_ALREADY_STARTED, INVALID_TABLE_POSITION, INVITATION_ACCEPTED, INVITATION_COUNTERED, INVITATION_REFUSED, INVITEE_NOT_ONLINE, MUST_BE_CREATOR, NO_SELF_BOOT, NO_SUCH_TABLE, NOT_AT_TABLE, PARLOR_GROUP, TABLE_POSITION_OCCUPIED
+  + + + + + + + +
Fields inherited from interface com.threerings.parlor.game.data.GameCodes
GAME_CHAT_TYPE, GAME_MESSAGE_BUNDLE, PLAYER_KNOCKED_OUT, WINNERS_AND_LOSERS
+  + + + + + + + + + + +
+Constructor Summary
PuzzleManager() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ Board[]getBoards() + +
+          Returns the boards for all players.
+ BoardSummarygetBoardSummary(int pidx) + +
+          Returns the board summary for the given player index.
+ booleanneedsBoardSummaries() + +
+          Returns whether this puzzle cares to make use of per-player board summaries that are sent + periodically to all users in the puzzle via sendStatusUpdate().
+ voidupdateBoardSummaries() + +
+          Applies updateBoardSummary on all the players' boards.
+ voidupdateBoardSummary(int pidx) + +
+          Calls BoardSummary.summarize() on the given player's board summary to refresh the + summary information in preparation for sending along to the client(s).
+ voidupdateProgress(com.threerings.presents.data.ClientObject caller, + int sessionId, + int[] events) + +
+          Handles a PuzzleGameService.updateProgress(int, int[]) request.
+ voidupdateProgressSync(com.threerings.presents.data.ClientObject caller, + int sessionId, + int[] events, + Board[] states) + +
+          Called when the puzzle manager receives a progress update.
+  + + + + + + + +
Methods inherited from class com.threerings.parlor.game.server.GameManager
addPlayer, addPlayerAt, allPlayersReady, cancelGame, checkWritePermission, endGame, endPlayerGame, getGameConfig, getGameId, getMatchType, getPlayer, getPlayerCount, getPlayerDisplayName, getPlayerIndex, getPlayerName, getPlayerOid, getPlayerPersistentId, getPlayerPersistentId, getPlayerSlots, getPresentPlayerIndex, getSessionId, isActivePlayer, isAgent, isAI, isPlayer, occupantInRoom, playerIsReady, playerReady, removePlayer, replacePlayer, resetGame, setAI, shouldConcludeGame, startGame, systemMessage, systemMessage
+  + + + + + + + +
Methods inherited from class com.threerings.crowd.server.PlaceManager
addDelegate, applyToDelegates, applyToOccupants, bodyWillEnter, bodyWillLeave, checkPermissions, getConfig, getLocation, getPlaceObject, init, isValidSpeaker, messageReceived, ratifyBodyEntry, registerMessageHandler, shutdown, startup, toString, updateOccupantInfo, where
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+PuzzleManager

+
+public PuzzleManager()
+
+
+ + + + + + + + +
+Method Detail
+ +

+getBoards

+
+public Board[] getBoards()
+
+
Returns the boards for all players. +

+

+
+
+
+
+
+
+
+ +

+getBoardSummary

+
+public BoardSummary getBoardSummary(int pidx)
+
+
Returns the board summary for the given player index. +

+

+
+
+
+
+
+
+
+ +

+needsBoardSummaries

+
+public boolean needsBoardSummaries()
+
+
Returns whether this puzzle cares to make use of per-player board summaries that are sent + periodically to all users in the puzzle via sendStatusUpdate(). The default + implementation returns false. +

+

+
+
+
+
+
+
+
+ +

+updateBoardSummary

+
+public void updateBoardSummary(int pidx)
+
+
Calls BoardSummary.summarize() on the given player's board summary to refresh the + summary information in preparation for sending along to the client(s). +

+

+
+
+
+
Parameters:
pidx - the player index of the player whose board is to be summarized.
+
+
+
+ +

+updateBoardSummaries

+
+public void updateBoardSummaries()
+
+
Applies updateBoardSummary on all the players' boards. AI board summaries should be updated + by the AI logic. +

+

+
+
+
+
+
+
+
+ +

+updateProgress

+
+public void updateProgress(com.threerings.presents.data.ClientObject caller,
+                           int sessionId,
+                           int[] events)
+
+
Description copied from interface: PuzzleGameProvider
+
Handles a PuzzleGameService.updateProgress(int, int[]) request. +

+

+
Specified by:
updateProgress in interface PuzzleGameProvider
+
+
+
+
+
+
+ +

+updateProgressSync

+
+public void updateProgressSync(com.threerings.presents.data.ClientObject caller,
+                               int sessionId,
+                               int[] events,
+                               Board[] states)
+
+
Called when the puzzle manager receives a progress update. It checks to make sure that the + progress update is valid and the puzzle is still in play and then applies the updates via + applyProgressEvents(int, int[], com.threerings.puzzle.data.Board[]). +

+

+
Specified by:
updateProgressSync in interface PuzzleGameProvider
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/server/PuzzleManagerDelegate.html b/apidocs/com/threerings/puzzle/server/PuzzleManagerDelegate.html new file mode 100644 index 00000000..24de7541 --- /dev/null +++ b/apidocs/com/threerings/puzzle/server/PuzzleManagerDelegate.html @@ -0,0 +1,302 @@ + + + + + + + +PuzzleManagerDelegate (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.puzzle.server +
+Class PuzzleManagerDelegate

+
+java.lang.Object
+  extended by com.threerings.crowd.server.PlaceManagerDelegate
+      extended by com.threerings.parlor.server.PlayManagerDelegate
+          extended by com.threerings.parlor.game.server.GameManagerDelegate
+              extended by com.threerings.puzzle.server.PuzzleManagerDelegate
+
+
+
Direct Known Subclasses:
DropManagerDelegate
+
+
+
+
public class PuzzleManagerDelegate
extends GameManagerDelegate
+ + +

+Extends the GameManagerDelegate mechanism with puzzle manager specific methods (of + which there are currently none). +

+ +

+

+ +

+ + + + + + + + + + + + + + +
+Constructor Summary
PuzzleManagerDelegate() + +
+           
PuzzleManagerDelegate(PuzzleManager puzmgr) + +
+          Deprecated. use the zero-argument constructor.
+  + + + + + + + + + + + +
+Method Summary
+ voiddidInit(com.threerings.crowd.data.PlaceConfig config) + +
+           
+  + + + + + + + +
Methods inherited from class com.threerings.parlor.game.server.GameManagerDelegate
gameDidEnd, gameDidStart, gameWillEnd, gameWillReset, gameWillStart, playerWasReplaced, setAI, tickAI
+  + + + + + + + +
Methods inherited from class com.threerings.crowd.server.PlaceManagerDelegate
bodyEntered, bodyLeft, bodyUpdated, didShutdown, didStartup, init, placeBecameEmpty, where
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+PuzzleManagerDelegate

+
+public PuzzleManagerDelegate()
+
+
+
+ +

+PuzzleManagerDelegate

+
+@Deprecated
+public PuzzleManagerDelegate(PuzzleManager puzmgr)
+
+
Deprecated. use the zero-argument constructor. +

+

+ + + + + + + + +
+Method Detail
+ +

+didInit

+
+public void didInit(com.threerings.crowd.data.PlaceConfig config)
+
+
+
Overrides:
didInit in class PlayManagerDelegate
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/server/class-use/PuzzleGameProvider.html b/apidocs/com/threerings/puzzle/server/class-use/PuzzleGameProvider.html new file mode 100644 index 00000000..9a88ee3a --- /dev/null +++ b/apidocs/com/threerings/puzzle/server/class-use/PuzzleGameProvider.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Interface com.threerings.puzzle.server.PuzzleGameProvider (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.puzzle.server.PuzzleGameProvider

+
+ + + + + + + + + +
+Packages that use PuzzleGameProvider
com.threerings.puzzle.server  
+  +

+ + + + + +
+Uses of PuzzleGameProvider in com.threerings.puzzle.server
+  +

+ + + + + + + + + +
Classes in com.threerings.puzzle.server that implement PuzzleGameProvider
+ classPuzzleManager + +
+          Extends the GameManager with facilities for puzzle games.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/server/class-use/PuzzleManager.html b/apidocs/com/threerings/puzzle/server/class-use/PuzzleManager.html new file mode 100644 index 00000000..5959d4ef --- /dev/null +++ b/apidocs/com/threerings/puzzle/server/class-use/PuzzleManager.html @@ -0,0 +1,207 @@ + + + + + + + +Uses of Class com.threerings.puzzle.server.PuzzleManager (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.puzzle.server.PuzzleManager

+
+ + + + + + + + + + + + + +
+Packages that use PuzzleManager
com.threerings.puzzle.drop.server  
com.threerings.puzzle.server  
+  +

+ + + + + +
+Uses of PuzzleManager in com.threerings.puzzle.drop.server
+  +

+ + + + + + + + +
Constructors in com.threerings.puzzle.drop.server with parameters of type PuzzleManager
DropManagerDelegate(PuzzleManager puzmgr, + DropLogic logic) + +
+          Deprecated. use DropManagerDelegate.DropManagerDelegate(DropLogic).
+  +

+ + + + + +
+Uses of PuzzleManager in com.threerings.puzzle.server
+  +

+ + + + + + + + +
Constructors in com.threerings.puzzle.server with parameters of type PuzzleManager
PuzzleManagerDelegate(PuzzleManager puzmgr) + +
+          Deprecated. use the zero-argument constructor.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/server/class-use/PuzzleManagerDelegate.html b/apidocs/com/threerings/puzzle/server/class-use/PuzzleManagerDelegate.html new file mode 100644 index 00000000..189d7f4a --- /dev/null +++ b/apidocs/com/threerings/puzzle/server/class-use/PuzzleManagerDelegate.html @@ -0,0 +1,184 @@ + + + + + + + +Uses of Class com.threerings.puzzle.server.PuzzleManagerDelegate (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.puzzle.server.PuzzleManagerDelegate

+
+ + + + + + + + + +
+Packages that use PuzzleManagerDelegate
com.threerings.puzzle.drop.server  
+  +

+ + + + + +
+Uses of PuzzleManagerDelegate in com.threerings.puzzle.drop.server
+  +

+ + + + + + + + + +
Subclasses of PuzzleManagerDelegate in com.threerings.puzzle.drop.server
+ classDropManagerDelegate + +
+          Provides the necessary support for a puzzle game that involves a two-dimensional board + containing pieces, with new pieces either falling into the board as a "drop block", or rising + into the bottom of the board in new piece rows, groups of blocks can be "broken" and garbage + can be sent to other players' boards as a result.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/server/package-frame.html b/apidocs/com/threerings/puzzle/server/package-frame.html new file mode 100644 index 00000000..4dd63e5b --- /dev/null +++ b/apidocs/com/threerings/puzzle/server/package-frame.html @@ -0,0 +1,46 @@ + + + + + + + +com.threerings.puzzle.server (vilya 1.3 API) + + + + + + + + + + + +com.threerings.puzzle.server + + + + +
+Interfaces  + +
+PuzzleGameProvider
+ + + + + + +
+Classes  + +
+PuzzleManager +
+PuzzleManagerDelegate
+ + + + diff --git a/apidocs/com/threerings/puzzle/server/package-summary.html b/apidocs/com/threerings/puzzle/server/package-summary.html new file mode 100644 index 00000000..fd179b60 --- /dev/null +++ b/apidocs/com/threerings/puzzle/server/package-summary.html @@ -0,0 +1,177 @@ + + + + + + + +com.threerings.puzzle.server (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.puzzle.server +

+ + + + + + + + + +
+Interface Summary
PuzzleGameProviderDefines the server-side of the PuzzleGameService.
+  + +

+ + + + + + + + + + + + + +
+Class Summary
PuzzleManagerExtends the GameManager with facilities for puzzle games.
PuzzleManagerDelegateExtends the GameManagerDelegate mechanism with puzzle manager specific methods (of + which there are currently none).
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/server/package-tree.html b/apidocs/com/threerings/puzzle/server/package-tree.html new file mode 100644 index 00000000..b20d0f76 --- /dev/null +++ b/apidocs/com/threerings/puzzle/server/package-tree.html @@ -0,0 +1,174 @@ + + + + + + + +com.threerings.puzzle.server Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.puzzle.server +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/server/package-use.html b/apidocs/com/threerings/puzzle/server/package-use.html new file mode 100644 index 00000000..4e85f56e --- /dev/null +++ b/apidocs/com/threerings/puzzle/server/package-use.html @@ -0,0 +1,203 @@ + + + + + + + +Uses of Package com.threerings.puzzle.server (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.puzzle.server

+
+ + + + + + + + + + + + + +
+Packages that use com.threerings.puzzle.server
com.threerings.puzzle.drop.server  
com.threerings.puzzle.server  
+  +

+ + + + + + + + + + + +
+Classes in com.threerings.puzzle.server used by com.threerings.puzzle.drop.server
PuzzleManager + +
+          Extends the GameManager with facilities for puzzle games.
PuzzleManagerDelegate + +
+          Extends the GameManagerDelegate mechanism with puzzle manager specific methods (of + which there are currently none).
+  +

+ + + + + + + + + + + +
+Classes in com.threerings.puzzle.server used by com.threerings.puzzle.server
PuzzleGameProvider + +
+          Defines the server-side of the PuzzleGameService.
PuzzleManager + +
+          Extends the GameManager with facilities for puzzle games.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/util/PointSet.html b/apidocs/com/threerings/puzzle/util/PointSet.html new file mode 100644 index 00000000..bc5da3bd --- /dev/null +++ b/apidocs/com/threerings/puzzle/util/PointSet.html @@ -0,0 +1,451 @@ + + + + + + + +PointSet (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.puzzle.util +
+Class PointSet

+
+java.lang.Object
+  extended by com.threerings.puzzle.util.PointSet
+
+
+
+
public class PointSet
extends Object
+ + +

+The point set class provides an efficient implementation of a set containing two-dimensional + point values as (x, y). +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
PointSet(int rangeX, + int rangeY) + +
+          Creates a point set that can contain points within the given range of values.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ booleanadd(int x, + int y) + +
+          Adds a point to the set and returns whether the point was already present in the set.
+ voidaddAll(PointSet set) + +
+          Adds all points in the given set to this set.
+ voidclear() + +
+          Clears all points from this set.
+ booleancontains(int x, + int y) + +
+          Returns whether this set contains the given point.
+ booleanisEmpty() + +
+          Returns whether this set is empty.
+ Iterator<Point>iterator() + +
+          Returns an iterator that iterates over the points in this set, returning them as + Point objects.
+ booleanremove(int x, + int y) + +
+          Removes the given point from the set and returns whether the point was present in the set.
+ intsize() + +
+          Returns the number of points in the set.
+ StringtoString() + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+PointSet

+
+public PointSet(int rangeX,
+                int rangeY)
+
+
Creates a point set that can contain points within the given range of values. +

+

+
Parameters:
rangeX - the maximum x-axis range.
rangeY - the maximum y-axis range.
+
+ + + + + + + + +
+Method Detail
+ +

+add

+
+public boolean add(int x,
+                   int y)
+
+
Adds a point to the set and returns whether the point was already present in the set. +

+

+
Parameters:
x - the point x-coordinate.
y - the point y-coordinate. +
Returns:
true if the point was already present, false if not.
+
+
+
+ +

+addAll

+
+public void addAll(PointSet set)
+
+
Adds all points in the given set to this set. +

+

+
Parameters:
set - the set containing points to add.
+
+
+
+ +

+clear

+
+public void clear()
+
+
Clears all points from this set. +

+

+
+
+
+
+ +

+contains

+
+public boolean contains(int x,
+                        int y)
+
+
Returns whether this set contains the given point. +

+

+
Parameters:
x - the point x-coordinate.
y - the point y-coordinate. +
Returns:
true if the set contains the point, false if not.
+
+
+
+ +

+isEmpty

+
+public boolean isEmpty()
+
+
Returns whether this set is empty. +

+

+ +
Returns:
true if the set is empty, false if not.
+
+
+
+ +

+iterator

+
+public Iterator<Point> iterator()
+
+
Returns an iterator that iterates over the points in this set, returning them as + Point objects. Note that the iterator uses a single point object internally, and so + callers should create their own copy of the point if they plan to do something fancy with + it. +

+

+ +
Returns:
the iterator over the set's points.
+
+
+
+ +

+remove

+
+public boolean remove(int x,
+                      int y)
+
+
Removes the given point from the set and returns whether the point was present in the set. +

+

+
Parameters:
x - the point x-coordinate.
y - the point y-coordinate. +
Returns:
true if the point was present, false if not.
+
+
+
+ +

+size

+
+public int size()
+
+
Returns the number of points in the set. +

+

+ +
Returns:
the number of points.
+
+
+
+ +

+toString

+
+public String toString()
+
+
+
Overrides:
toString in class Object
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/util/PuzzleContext.html b/apidocs/com/threerings/puzzle/util/PuzzleContext.html new file mode 100644 index 00000000..2ea61f2d --- /dev/null +++ b/apidocs/com/threerings/puzzle/util/PuzzleContext.html @@ -0,0 +1,342 @@ + + + + + + + +PuzzleContext (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.puzzle.util +
+Interface PuzzleContext

+
+
All Superinterfaces:
com.threerings.crowd.util.CrowdContext, ParlorContext, com.threerings.presents.util.PresentsContext
+
+
+
+
public interface PuzzleContext
extends ParlorContext
+ + +

+Provides access to entities needed by the puzzle services. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ com.threerings.media.FrameManagergetFrameManager() + +
+          Provides access to the frame manager.
+ com.threerings.util.KeyboardManagergetKeyboardManager() + +
+          Provides access to the keyboard manager.
+ com.threerings.util.KeyDispatchergetKeyDispatcher() + +
+          Provides access to the key dispatcher.
+ com.threerings.util.MessageManagergetMessageManager() + +
+          Returns a reference to the message manager used by the client.
+ com.threerings.util.NamegetUsername() + +
+          Returns the username of the local user.
+  + + + + + + + +
Methods inherited from interface com.threerings.parlor.util.ParlorContext
getParlorDirector
+  + + + + + + + +
Methods inherited from interface com.threerings.crowd.util.CrowdContext
clearPlaceView, getChatDirector, getLocationDirector, getOccupantDirector, setPlaceView
+  + + + + + + + +
Methods inherited from interface com.threerings.presents.util.PresentsContext
getClient, getConfig, getDObjectManager
+  +

+ + + + + + + + +
+Method Detail
+ +

+getUsername

+
+com.threerings.util.Name getUsername()
+
+
Returns the username of the local user. +

+

+
+
+
+
+
+
+
+ +

+getMessageManager

+
+com.threerings.util.MessageManager getMessageManager()
+
+
Returns a reference to the message manager used by the client. +

+

+
Specified by:
getMessageManager in interface com.threerings.crowd.util.CrowdContext
+
+
+
+
+
+
+ +

+getFrameManager

+
+com.threerings.media.FrameManager getFrameManager()
+
+
Provides access to the frame manager. +

+

+
+
+
+
+
+
+
+ +

+getKeyboardManager

+
+com.threerings.util.KeyboardManager getKeyboardManager()
+
+
Provides access to the keyboard manager. +

+

+
+
+
+
+
+
+
+ +

+getKeyDispatcher

+
+com.threerings.util.KeyDispatcher getKeyDispatcher()
+
+
Provides access to the key dispatcher. +

+

+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/util/PuzzleGameUtil.html b/apidocs/com/threerings/puzzle/util/PuzzleGameUtil.html new file mode 100644 index 00000000..3e5d0861 --- /dev/null +++ b/apidocs/com/threerings/puzzle/util/PuzzleGameUtil.html @@ -0,0 +1,259 @@ + + + + + + + +PuzzleGameUtil (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.puzzle.util +
+Class PuzzleGameUtil

+
+java.lang.Object
+  extended by com.threerings.puzzle.util.PuzzleGameUtil
+
+
+
+
public class PuzzleGameUtil
extends Object
+ + +

+Puzzle game related utilities. +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
PuzzleGameUtil() + +
+           
+  + + + + + + + + + + + +
+Method Summary
+static com.threerings.util.KeyTranslatorImplgetKeyTranslator() + +
+          Returns a key translator configured with basic puzzle game mappings.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+PuzzleGameUtil

+
+public PuzzleGameUtil()
+
+
+ + + + + + + + +
+Method Detail
+ +

+getKeyTranslator

+
+public static com.threerings.util.KeyTranslatorImpl getKeyTranslator()
+
+
Returns a key translator configured with basic puzzle game mappings. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/util/class-use/PointSet.html b/apidocs/com/threerings/puzzle/util/class-use/PointSet.html new file mode 100644 index 00000000..540fa22e --- /dev/null +++ b/apidocs/com/threerings/puzzle/util/class-use/PointSet.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class com.threerings.puzzle.util.PointSet (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.puzzle.util.PointSet

+
+ + + + + + + + + +
+Packages that use PointSet
com.threerings.puzzle.util  
+  +

+ + + + + +
+Uses of PointSet in com.threerings.puzzle.util
+  +

+ + + + + + + + + +
Methods in com.threerings.puzzle.util with parameters of type PointSet
+ voidPointSet.addAll(PointSet set) + +
+          Adds all points in the given set to this set.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/util/class-use/PuzzleContext.html b/apidocs/com/threerings/puzzle/util/class-use/PuzzleContext.html new file mode 100644 index 00000000..f3ad894c --- /dev/null +++ b/apidocs/com/threerings/puzzle/util/class-use/PuzzleContext.html @@ -0,0 +1,215 @@ + + + + + + + +Uses of Interface com.threerings.puzzle.util.PuzzleContext (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.puzzle.util.PuzzleContext

+
+ + + + + + + + + + + + + +
+Packages that use PuzzleContext
com.threerings.puzzle.client  
com.threerings.puzzle.drop.client  
+  +

+ + + + + +
+Uses of PuzzleContext in com.threerings.puzzle.client
+  +

+ + + + + + + + + + + +
Constructors in com.threerings.puzzle.client with parameters of type PuzzleContext
PuzzleBoardView(PuzzleContext ctx) + +
+          Constructs a puzzle board view.
PuzzlePanel(PuzzleContext ctx, + PuzzleController controller) + +
+          Constructs a puzzle panel.
+  +

+ + + + + +
+Uses of PuzzleContext in com.threerings.puzzle.drop.client
+  +

+ + + + + + + + +
Constructors in com.threerings.puzzle.drop.client with parameters of type PuzzleContext
DropBoardView(PuzzleContext ctx, + int pwid, + int phei) + +
+          Constructs a drop board view.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/util/class-use/PuzzleGameUtil.html b/apidocs/com/threerings/puzzle/util/class-use/PuzzleGameUtil.html new file mode 100644 index 00000000..16db7764 --- /dev/null +++ b/apidocs/com/threerings/puzzle/util/class-use/PuzzleGameUtil.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.puzzle.util.PuzzleGameUtil (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.puzzle.util.PuzzleGameUtil

+
+No usage of com.threerings.puzzle.util.PuzzleGameUtil +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/util/package-frame.html b/apidocs/com/threerings/puzzle/util/package-frame.html new file mode 100644 index 00000000..b3728b0c --- /dev/null +++ b/apidocs/com/threerings/puzzle/util/package-frame.html @@ -0,0 +1,46 @@ + + + + + + + +com.threerings.puzzle.util (vilya 1.3 API) + + + + + + + + + + + +com.threerings.puzzle.util + + + + +
+Interfaces  + +
+PuzzleContext
+ + + + + + +
+Classes  + +
+PointSet +
+PuzzleGameUtil
+ + + + diff --git a/apidocs/com/threerings/puzzle/util/package-summary.html b/apidocs/com/threerings/puzzle/util/package-summary.html new file mode 100644 index 00000000..ba196a3f --- /dev/null +++ b/apidocs/com/threerings/puzzle/util/package-summary.html @@ -0,0 +1,177 @@ + + + + + + + +com.threerings.puzzle.util (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.puzzle.util +

+ + + + + + + + + +
+Interface Summary
PuzzleContextProvides access to entities needed by the puzzle services.
+  + +

+ + + + + + + + + + + + + +
+Class Summary
PointSetThe point set class provides an efficient implementation of a set containing two-dimensional + point values as (x, y).
PuzzleGameUtilPuzzle game related utilities.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/util/package-tree.html b/apidocs/com/threerings/puzzle/util/package-tree.html new file mode 100644 index 00000000..a0e9f68b --- /dev/null +++ b/apidocs/com/threerings/puzzle/util/package-tree.html @@ -0,0 +1,165 @@ + + + + + + + +com.threerings.puzzle.util Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.puzzle.util +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/puzzle/util/package-use.html b/apidocs/com/threerings/puzzle/util/package-use.html new file mode 100644 index 00000000..71e67363 --- /dev/null +++ b/apidocs/com/threerings/puzzle/util/package-use.html @@ -0,0 +1,210 @@ + + + + + + + +Uses of Package com.threerings.puzzle.util (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.puzzle.util

+
+ + + + + + + + + + + + + + + + + +
+Packages that use com.threerings.puzzle.util
com.threerings.puzzle.client  
com.threerings.puzzle.drop.client  
com.threerings.puzzle.util  
+  +

+ + + + + + + + +
+Classes in com.threerings.puzzle.util used by com.threerings.puzzle.client
PuzzleContext + +
+          Provides access to entities needed by the puzzle services.
+  +

+ + + + + + + + +
+Classes in com.threerings.puzzle.util used by com.threerings.puzzle.drop.client
PuzzleContext + +
+          Provides access to entities needed by the puzzle services.
+  +

+ + + + + + + + +
+Classes in com.threerings.puzzle.util used by com.threerings.puzzle.util
PointSet + +
+          The point set class provides an efficient implementation of a set containing two-dimensional + point values as (x, y).
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/Log.html b/apidocs/com/threerings/stage/Log.html new file mode 100644 index 00000000..1475b762 --- /dev/null +++ b/apidocs/com/threerings/stage/Log.html @@ -0,0 +1,265 @@ + + + + + + + +Log (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stage +
+Class Log

+
+java.lang.Object
+  extended by com.threerings.stage.Log
+
+
+
+
public class Log
extends Object
+ + +

+Contains a reference to the log object used by this package. +

+ +

+

+ +

+ + + + + + + + + + + +
+Field Summary
+static Loggerlog + +
+           
+  + + + + + + + + + + +
+Constructor Summary
Log() + +
+           
+  + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+log

+
+public static Logger log
+
+
+
+
+ + + + + + + + +
+Constructor Detail
+ +

+Log

+
+public Log()
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/class-use/Log.html b/apidocs/com/threerings/stage/class-use/Log.html new file mode 100644 index 00000000..75a97e6d --- /dev/null +++ b/apidocs/com/threerings/stage/class-use/Log.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.stage.Log (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stage.Log

+
+No usage of com.threerings.stage.Log +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/client/SceneColorizer.html b/apidocs/com/threerings/stage/client/SceneColorizer.html new file mode 100644 index 00000000..6061b8a4 --- /dev/null +++ b/apidocs/com/threerings/stage/client/SceneColorizer.html @@ -0,0 +1,341 @@ + + + + + + + +SceneColorizer (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stage.client +
+Class SceneColorizer

+
+java.lang.Object
+  extended by com.threerings.stage.client.SceneColorizer
+
+
+
All Implemented Interfaces:
com.threerings.media.tile.TileSet.Colorizer
+
+
+
+
public class SceneColorizer
extends Object
implements com.threerings.media.tile.TileSet.Colorizer
+ + +

+Handles colorization of object tiles in a scene. +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
SceneColorizer(com.threerings.media.image.ColorPository cpos, + StageScene scene) + +
+          Creates a scene colorizer for the supplied scene.
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ intgetColorId(String zation) + +
+          Get the colorId to use for the specified colorization.
+ com.threerings.media.image.ColorizationgetColorization(int index, + String zation) + +
+           
+ com.threerings.media.tile.TileSet.ColorizergetColorizer(com.threerings.miso.data.ObjectInfo oinfo) + +
+          Obtains a colorizer for the supplied scene object.
+ voidsetAuxiliary(com.threerings.media.tile.TileSet.Colorizer aux) + +
+          Set an auxiliary colorizer that overrides our colorizations.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+SceneColorizer

+
+public SceneColorizer(com.threerings.media.image.ColorPository cpos,
+                      StageScene scene)
+
+
Creates a scene colorizer for the supplied scene. +

+

+ + + + + + + + +
+Method Detail
+ +

+setAuxiliary

+
+public void setAuxiliary(com.threerings.media.tile.TileSet.Colorizer aux)
+
+
Set an auxiliary colorizer that overrides our colorizations. +

+

+
+
+
+
+
+
+
+ +

+getColorizer

+
+public com.threerings.media.tile.TileSet.Colorizer getColorizer(com.threerings.miso.data.ObjectInfo oinfo)
+
+
Obtains a colorizer for the supplied scene object. +

+

+
+
+
+
+
+
+
+ +

+getColorization

+
+public com.threerings.media.image.Colorization getColorization(int index,
+                                                               String zation)
+
+
+
Specified by:
getColorization in interface com.threerings.media.tile.TileSet.Colorizer
+
+
+
+
+
+
+ +

+getColorId

+
+public int getColorId(String zation)
+
+
Get the colorId to use for the specified colorization. +

+

+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/client/StageSceneController.html b/apidocs/com/threerings/stage/client/StageSceneController.html new file mode 100644 index 00000000..b9289edb --- /dev/null +++ b/apidocs/com/threerings/stage/client/StageSceneController.html @@ -0,0 +1,356 @@ + + + + + + + +StageSceneController (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stage.client +
+Class StageSceneController

+
+java.lang.Object
+  extended by com.samskivert.swing.Controller
+      extended by com.threerings.crowd.client.PlaceController
+          extended by com.threerings.whirled.client.SceneController
+              extended by com.threerings.whirled.spot.client.SpotSceneController
+                  extended by com.threerings.stage.client.StageSceneController
+
+
+
All Implemented Interfaces:
ActionListener, EventListener
+
+
+
+
public class StageSceneController
extends SpotSceneController
+ + +

+Extends the SpotSceneController with functionality specific to + displaying Stage scenes. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.crowd.client.PlaceController
com.threerings.crowd.client.PlaceController.DelegateOp
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class com.samskivert.swing.Controller
DISPATCHER
+  + + + + + + + + + + +
+Constructor Summary
StageSceneController() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ voidhandleClusterClicked(Object source, + Tuple<Cluster,Point> tuple) + +
+          Handles a cluster clicked event.
+ voidhandleLocationClicked(Object source, + StageLocation loc) + +
+          Called when the user clicks on a location within the scene.
+  + + + + + + + +
Methods inherited from class com.threerings.whirled.client.SceneController
didLeavePlace, init, willEnterPlace
+  + + + + + + + +
Methods inherited from class com.threerings.crowd.client.PlaceController
getPlaceConfig, getPlaceView, handleAction, mayLeavePlace
+  + + + + + + + +
Methods inherited from class com.samskivert.swing.Controller
actionPerformed, configureAction, createActionButton, handleAction, handleAction, handleAction, postAction, postAction, postAction, setControlledPanel, wasAdded, wasRemoved
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+StageSceneController

+
+public StageSceneController()
+
+
+ + + + + + + + +
+Method Detail
+ +

+handleLocationClicked

+
+public void handleLocationClicked(Object source,
+                                  StageLocation loc)
+
+
Called when the user clicks on a location within the scene. +

+

+
+
+
+
+ +

+handleClusterClicked

+
+public void handleClusterClicked(Object source,
+                                 Tuple<Cluster,Point> tuple)
+
+
Handles a cluster clicked event. +

+

+
Parameters:
tuple - the cluster that was clicked and the screen coords of the click.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/client/StageScenePanel.html b/apidocs/com/threerings/stage/client/StageScenePanel.html new file mode 100644 index 00000000..a6eb61e4 --- /dev/null +++ b/apidocs/com/threerings/stage/client/StageScenePanel.html @@ -0,0 +1,811 @@ + + + + + + + +StageScenePanel (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stage.client +
+Class StageScenePanel

+
+java.lang.Object
+  extended by java.awt.Component
+      extended by java.awt.Container
+          extended by javax.swing.JComponent
+              extended by com.threerings.media.MediaPanel
+                  extended by com.threerings.media.VirtualMediaPanel
+                      extended by com.threerings.miso.client.MisoScenePanel
+                          extended by com.threerings.stage.client.StageScenePanel
+
+
+
All Implemented Interfaces:
ControllerProvider, RadialMenu.Host, com.threerings.crowd.client.PlaceView, com.threerings.media.FrameParticipant, com.threerings.media.MediaConstants, com.threerings.media.MediaHost, com.threerings.media.util.AStarPathUtil.TraversalPred, KeyListener, MouseListener, MouseMotionListener, ImageObserver, MenuContainer, Serializable, EventListener
+
+
+
Direct Known Subclasses:
EditorScenePanel, ViewerScenePanel
+
+
+
+
public class StageScenePanel
extends com.threerings.miso.client.MisoScenePanel
implements ControllerProvider, KeyListener, com.threerings.crowd.client.PlaceView
+ + +

+Extends the basic Miso scene panel with Stage fun stuff like portals, clusters and locations. +

+ +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.media.MediaPanel
com.threerings.media.MediaPanel.Obscurer
+  + + + + + + + + +
Nested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent
+  + + + + + + + + +
Nested classes/interfaces inherited from class java.awt.Component
Component.BaselineResizeBehavior
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static StringCLUSTER_CLICKED + +
+          An action command generated when a cluster is clicked.
+static StringLOCATION_CLICKED + +
+          An action command generated when the user clicks on a location within the scene.
+static intSHOW_CLUSTERS + +
+          Show flag that indicates we should show all clusters.
+static intSHOW_PLOTS + +
+          Show flag that indicates we should render known land plots + (expensive, don't turn this on willy nilly).
+  + + + + + + + +
Fields inherited from class com.threerings.miso.client.MisoScenePanel
SHOW_TIPS
+  + + + + + + + +
Fields inherited from class com.threerings.media.VirtualMediaPanel
CENTER_ON_PATHABLE, ENCLOSE_PATHABLE, TRACK_PATHABLE
+  + + + + + + + +
Fields inherited from class javax.swing.JComponent
TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
+  + + + + + + + +
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
+  + + + + + + + +
Fields inherited from interface com.threerings.media.MediaConstants
ALL, BACK, FRONT
+  + + + + + + + +
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
+  + + + + + + + + + + +
+Constructor Summary
StageScenePanel(StageContext ctx, + Controller ctrl) + +
+          Constructs a stage scene view panel.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voiddidLeavePlace(com.threerings.crowd.data.PlaceObject plobj) + +
+           
+ SceneColorizergetColorizer() + +
+          Get the tileset colorizer in use in this scene.
+ ControllergetController() + +
+           
+ PortalgetPortal(int fullX, + int fullY) + +
+          Returns the portal at the specified full coordinates or null if no + portal exists at said coordinates.
+ StageScenegetScene() + +
+          Returns the scene being displayed by this panel.
+ voidkeyPressed(KeyEvent e) + +
+           
+ voidkeyReleased(KeyEvent e) + +
+           
+ voidkeyTyped(KeyEvent e) + +
+           
+ booleanremoveCluster(int clusterOid) + +
+          Removes the specified cluster from the view.
+ voidsceneUpdated(SceneUpdate update) + +
+          Called when we have received a scene update from the server.
+ voidsetScene(StageScene scene) + +
+          Sets the scene managed by the panel.
+ voidupdateCluster(Cluster cluster, + Rectangle bounds) + +
+          Adds or updates the specified cluster in the view.
+ voidwillEnterPlace(com.threerings.crowd.data.PlaceObject plobj) + +
+           
+  + + + + + + + +
Methods inherited from class com.threerings.miso.client.MisoScenePanel
addNotify, canTraverse, centerOnTile, checkShowFlag, clearRadialMenu, computeIndicators, computeInfluentialBounds, enumerateResolvedBlocks, getBlock, getComponent, getFullCoords, getHoverCoords, getHoverObject, getPath, getSceneMetrics, getSceneModel, getScreenCoords, getTileCoords, getViewBounds, menuDeactivated, mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, paint, pressObject, refreshScene, removeNotify, repaintRect, reportMemoryUsage, setBounds, setSceneModel, setShowFlags
+  + + + + + + + +
Methods inherited from class com.threerings.media.VirtualMediaPanel
addViewTracker, clearPathable, doLayout, removeViewTracker, setBackground, setFollowsPathable, setViewLocation
+  + + + + + + + +
Methods inherited from class com.threerings.media.MediaPanel
abortAnimation, addAnimation, addObscurer, addSprite, clearAnimations, clearSprites, createGraphics, getAnimationManager, getRegionManager, getSpriteManager, getTimeStamp, isManaged, isManaged, needsPaint, removeObscurer, removeSprite, repaint, setOpaque, setPaused, tick
+  + + + + + + + +
Methods inherited from class javax.swing.JComponent
addAncestorListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI
+  + + + + + + + +
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate
+  + + + + + + + +
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+LOCATION_CLICKED

+
+public static final String LOCATION_CLICKED
+
+
An action command generated when the user clicks on a location within the scene. +

+

+
See Also:
Constant Field Values
+
+
+ +

+CLUSTER_CLICKED

+
+public static final String CLUSTER_CLICKED
+
+
An action command generated when a cluster is clicked. +

+

+
See Also:
Constant Field Values
+
+
+ +

+SHOW_CLUSTERS

+
+public static final int SHOW_CLUSTERS
+
+
Show flag that indicates we should show all clusters. +

+

+
See Also:
Constant Field Values
+
+
+ +

+SHOW_PLOTS

+
+public static final int SHOW_PLOTS
+
+
Show flag that indicates we should render known land plots + (expensive, don't turn this on willy nilly). +

+

+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Constructor Detail
+ +

+StageScenePanel

+
+public StageScenePanel(StageContext ctx,
+                       Controller ctrl)
+
+
Constructs a stage scene view panel. +

+

+ + + + + + + + +
+Method Detail
+ +

+getColorizer

+
+public SceneColorizer getColorizer()
+
+
Get the tileset colorizer in use in this scene. +

+

+
+
+
+
+
+
+
+ +

+getScene

+
+public StageScene getScene()
+
+
Returns the scene being displayed by this panel. Do not modify it. +

+

+
+
+
+
+
+
+
+ +

+setScene

+
+public void setScene(StageScene scene)
+
+
Sets the scene managed by the panel. +

+

+
+
+
+
+
+
+
+ +

+sceneUpdated

+
+public void sceneUpdated(SceneUpdate update)
+
+
Called when we have received a scene update from the server. +

+

+
+
+
+
+
+
+
+ +

+getController

+
+public Controller getController()
+
+
+
Specified by:
getController in interface ControllerProvider
+
+
+
+
+
+
+ +

+keyPressed

+
+public void keyPressed(KeyEvent e)
+
+
+
Specified by:
keyPressed in interface KeyListener
+
+
+
+
+
+
+ +

+keyReleased

+
+public void keyReleased(KeyEvent e)
+
+
+
Specified by:
keyReleased in interface KeyListener
+
+
+
+
+
+
+ +

+willEnterPlace

+
+public void willEnterPlace(com.threerings.crowd.data.PlaceObject plobj)
+
+
+
Specified by:
willEnterPlace in interface com.threerings.crowd.client.PlaceView
+
+
+
+
+
+
+ +

+didLeavePlace

+
+public void didLeavePlace(com.threerings.crowd.data.PlaceObject plobj)
+
+
+
Specified by:
didLeavePlace in interface com.threerings.crowd.client.PlaceView
+
+
+
+
+
+
+ +

+keyTyped

+
+public void keyTyped(KeyEvent e)
+
+
+
Specified by:
keyTyped in interface KeyListener
+
+
+
+
+
+
+ +

+updateCluster

+
+public void updateCluster(Cluster cluster,
+                          Rectangle bounds)
+
+
Adds or updates the specified cluster in the view. Metrics will be created that allow the + cluster to be rendered and hovered over. +

+

+
+
+
+
Parameters:
cluster - the cluster record to be added.
bounds - the screen coordinates that bound the occupants of the cluster.
+
+
+
+ +

+removeCluster

+
+public boolean removeCluster(int clusterOid)
+
+
Removes the specified cluster from the view. +

+

+
+
+
+ +
Returns:
true if such a cluster existed and was removed.
+
+
+
+ +

+getPortal

+
+public Portal getPortal(int fullX,
+                        int fullY)
+
+
Returns the portal at the specified full coordinates or null if no + portal exists at said coordinates. +

+

+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/client/StageSceneService.html b/apidocs/com/threerings/stage/client/StageSceneService.html new file mode 100644 index 00000000..22216d25 --- /dev/null +++ b/apidocs/com/threerings/stage/client/StageSceneService.html @@ -0,0 +1,269 @@ + + + + + + + +StageSceneService (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stage.client +
+Interface StageSceneService

+
+
All Superinterfaces:
com.threerings.presents.client.InvocationService
+
+
+
All Known Implementing Classes:
StageSceneMarshaller
+
+
+
+
public interface StageSceneService
extends com.threerings.presents.client.InvocationService
+ + +

+Provides services relating to Stage scenes. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.presents.client.InvocationService
com.threerings.presents.client.InvocationService.ConfirmListener, com.threerings.presents.client.InvocationService.InvocationListener, com.threerings.presents.client.InvocationService.ResultListener
+  + + + + + + + + + + + + + + + + +
+Method Summary
+ voidaddObject(com.threerings.miso.data.ObjectInfo info, + com.threerings.presents.client.InvocationService.ConfirmListener listener) + +
+          Requests to add the supplied object to the current scene.
+ voidremoveObjects(com.threerings.miso.data.ObjectInfo[] info, + com.threerings.presents.client.InvocationService.ConfirmListener listener) + +
+          Requests to remove the supplied objects from the current scene.
+  +

+ + + + + + + + +
+Method Detail
+ +

+addObject

+
+void addObject(com.threerings.miso.data.ObjectInfo info,
+               com.threerings.presents.client.InvocationService.ConfirmListener listener)
+
+
Requests to add the supplied object to the current scene. +

+

+
+
+
+
+
+
+
+ +

+removeObjects

+
+void removeObjects(com.threerings.miso.data.ObjectInfo[] info,
+                   com.threerings.presents.client.InvocationService.ConfirmListener listener)
+
+
Requests to remove the supplied objects from the current scene. +

+

+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/client/class-use/SceneColorizer.html b/apidocs/com/threerings/stage/client/class-use/SceneColorizer.html new file mode 100644 index 00000000..5e5db02b --- /dev/null +++ b/apidocs/com/threerings/stage/client/class-use/SceneColorizer.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class com.threerings.stage.client.SceneColorizer (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stage.client.SceneColorizer

+
+ + + + + + + + + +
+Packages that use SceneColorizer
com.threerings.stage.client  
+  +

+ + + + + +
+Uses of SceneColorizer in com.threerings.stage.client
+  +

+ + + + + + + + + +
Methods in com.threerings.stage.client that return SceneColorizer
+ SceneColorizerStageScenePanel.getColorizer() + +
+          Get the tileset colorizer in use in this scene.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/client/class-use/StageSceneController.html b/apidocs/com/threerings/stage/client/class-use/StageSceneController.html new file mode 100644 index 00000000..0bec05f9 --- /dev/null +++ b/apidocs/com/threerings/stage/client/class-use/StageSceneController.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.stage.client.StageSceneController (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stage.client.StageSceneController

+
+No usage of com.threerings.stage.client.StageSceneController +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/client/class-use/StageScenePanel.html b/apidocs/com/threerings/stage/client/class-use/StageScenePanel.html new file mode 100644 index 00000000..e8632787 --- /dev/null +++ b/apidocs/com/threerings/stage/client/class-use/StageScenePanel.html @@ -0,0 +1,210 @@ + + + + + + + +Uses of Class com.threerings.stage.client.StageScenePanel (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stage.client.StageScenePanel

+
+ + + + + + + + + + + + + +
+Packages that use StageScenePanel
com.threerings.stage.tools.editor  
com.threerings.stage.tools.viewer  
+  +

+ + + + + +
+Uses of StageScenePanel in com.threerings.stage.tools.editor
+  +

+ + + + + + + + + +
Subclasses of StageScenePanel in com.threerings.stage.tools.editor
+ classEditorScenePanel + +
+          Displays the scene view and handles UI events on the scene.
+  +

+ + + + + +
+Uses of StageScenePanel in com.threerings.stage.tools.viewer
+  +

+ + + + + + + + + +
Subclasses of StageScenePanel in com.threerings.stage.tools.viewer
+ classViewerScenePanel + +
+           
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/client/class-use/StageSceneService.html b/apidocs/com/threerings/stage/client/class-use/StageSceneService.html new file mode 100644 index 00000000..ead5957c --- /dev/null +++ b/apidocs/com/threerings/stage/client/class-use/StageSceneService.html @@ -0,0 +1,183 @@ + + + + + + + +Uses of Interface com.threerings.stage.client.StageSceneService (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.stage.client.StageSceneService

+
+ + + + + + + + + +
+Packages that use StageSceneService
com.threerings.stage.data  
+  +

+ + + + + +
+Uses of StageSceneService in com.threerings.stage.data
+  +

+ + + + + + + + + +
Classes in com.threerings.stage.data that implement StageSceneService
+ classStageSceneMarshaller + +
+          Provides the implementation of the StageSceneService interface + that marshalls the arguments and delivers the request to the provider + on the server.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/client/package-frame.html b/apidocs/com/threerings/stage/client/package-frame.html new file mode 100644 index 00000000..dcb0682e --- /dev/null +++ b/apidocs/com/threerings/stage/client/package-frame.html @@ -0,0 +1,48 @@ + + + + + + + +com.threerings.stage.client (vilya 1.3 API) + + + + + + + + + + + +com.threerings.stage.client + + + + +
+Interfaces  + +
+StageSceneService
+ + + + + + +
+Classes  + +
+SceneColorizer +
+StageSceneController +
+StageScenePanel
+ + + + diff --git a/apidocs/com/threerings/stage/client/package-summary.html b/apidocs/com/threerings/stage/client/package-summary.html new file mode 100644 index 00000000..c0ae270b --- /dev/null +++ b/apidocs/com/threerings/stage/client/package-summary.html @@ -0,0 +1,181 @@ + + + + + + + +com.threerings.stage.client (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.stage.client +

+ + + + + + + + + +
+Interface Summary
StageSceneServiceProvides services relating to Stage scenes.
+  + +

+ + + + + + + + + + + + + + + + + +
+Class Summary
SceneColorizerHandles colorization of object tiles in a scene.
StageSceneControllerExtends the SpotSceneController with functionality specific to + displaying Stage scenes.
StageScenePanelExtends the basic Miso scene panel with Stage fun stuff like portals, clusters and locations.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/client/package-tree.html b/apidocs/com/threerings/stage/client/package-tree.html new file mode 100644 index 00000000..6b7329f3 --- /dev/null +++ b/apidocs/com/threerings/stage/client/package-tree.html @@ -0,0 +1,188 @@ + + + + + + + +com.threerings.stage.client Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.stage.client +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/client/package-use.html b/apidocs/com/threerings/stage/client/package-use.html new file mode 100644 index 00000000..e330ea31 --- /dev/null +++ b/apidocs/com/threerings/stage/client/package-use.html @@ -0,0 +1,228 @@ + + + + + + + +Uses of Package com.threerings.stage.client (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.stage.client

+
+ + + + + + + + + + + + + + + + + + + + + +
+Packages that use com.threerings.stage.client
com.threerings.stage.client  
com.threerings.stage.data  
com.threerings.stage.tools.editor  
com.threerings.stage.tools.viewer  
+  +

+ + + + + + + + +
+Classes in com.threerings.stage.client used by com.threerings.stage.client
SceneColorizer + +
+          Handles colorization of object tiles in a scene.
+  +

+ + + + + + + + +
+Classes in com.threerings.stage.client used by com.threerings.stage.data
StageSceneService + +
+          Provides services relating to Stage scenes.
+  +

+ + + + + + + + +
+Classes in com.threerings.stage.client used by com.threerings.stage.tools.editor
StageScenePanel + +
+          Extends the basic Miso scene panel with Stage fun stuff like portals, clusters and locations.
+  +

+ + + + + + + + +
+Classes in com.threerings.stage.client used by com.threerings.stage.tools.viewer
StageScenePanel + +
+          Extends the basic Miso scene panel with Stage fun stuff like portals, clusters and locations.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/data/DefaultColorUpdate.html b/apidocs/com/threerings/stage/data/DefaultColorUpdate.html new file mode 100644 index 00000000..50d5a936 --- /dev/null +++ b/apidocs/com/threerings/stage/data/DefaultColorUpdate.html @@ -0,0 +1,382 @@ + + + + + + + +DefaultColorUpdate (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stage.data +
+Class DefaultColorUpdate

+
+java.lang.Object
+  extended by com.threerings.whirled.data.SceneUpdate
+      extended by com.threerings.stage.data.DefaultColorUpdate
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable, Cloneable
+
+
+
+
public class DefaultColorUpdate
extends SceneUpdate
+ + +

+Update to change the default colorization for objects in a scene which + do not define their own colorization. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + + + + + +
+Field Summary
+ intclassId + +
+          The class id of the colorization we're changing.
+ intcolorId + +
+          The color id to set as the new default, or -1 to remove the default.
+  + + + + + + + + + + +
+Constructor Summary
DefaultColorUpdate() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ voidapply(SceneModel model) + +
+          Applies this update to the specified scene model.
+ voidinit(int targetId, + int targetVersion, + int classId, + int colorId) + +
+          Initializes this update.
+  + + + + + + + +
Methods inherited from class com.threerings.whirled.data.SceneUpdate
getSceneId, getSceneVersion, getVersionIncrement, init, persistTo, readObject, toString, unpersistFrom, validate, writeObject
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+classId

+
+public int classId
+
+
The class id of the colorization we're changing. +

+

+
+
+
+ +

+colorId

+
+public int colorId
+
+
The color id to set as the new default, or -1 to remove the default. +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+DefaultColorUpdate

+
+public DefaultColorUpdate()
+
+
+ + + + + + + + +
+Method Detail
+ +

+init

+
+public void init(int targetId,
+                 int targetVersion,
+                 int classId,
+                 int colorId)
+
+
Initializes this update. +

+

+
+
+
+
+ +

+apply

+
+public void apply(SceneModel model)
+
+
Description copied from class: SceneUpdate
+
Applies this update to the specified scene model. Derived classes will want to override this + method and apply updates of their own, being sure to call super.apply. +

+

+
Overrides:
apply in class SceneUpdate
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/data/ModifyObjectsUpdate.html b/apidocs/com/threerings/stage/data/ModifyObjectsUpdate.html new file mode 100644 index 00000000..8bfea049 --- /dev/null +++ b/apidocs/com/threerings/stage/data/ModifyObjectsUpdate.html @@ -0,0 +1,384 @@ + + + + + + + +ModifyObjectsUpdate (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stage.data +
+Class ModifyObjectsUpdate

+
+java.lang.Object
+  extended by com.threerings.whirled.data.SceneUpdate
+      extended by com.threerings.stage.data.ModifyObjectsUpdate
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable, Cloneable
+
+
+
+
public class ModifyObjectsUpdate
extends SceneUpdate
+ + +

+A scene update that is broadcast when objects have been added to or removed + from the scene. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + + + + + +
+Field Summary
+ com.threerings.miso.data.ObjectInfo[]added + +
+          The objects added to the scene (or null for none).
+ com.threerings.miso.data.ObjectInfo[]removed + +
+          The objects removed from the scene (or null for none).
+  + + + + + + + + + + +
+Constructor Summary
ModifyObjectsUpdate() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ voidapply(SceneModel model) + +
+          Applies this update to the specified scene model.
+ voidinit(int targetId, + int targetVersion, + com.threerings.miso.data.ObjectInfo[] added, + com.threerings.miso.data.ObjectInfo[] removed) + +
+          Initializes this update with all necessary data.
+  + + + + + + + +
Methods inherited from class com.threerings.whirled.data.SceneUpdate
getSceneId, getSceneVersion, getVersionIncrement, init, persistTo, readObject, toString, unpersistFrom, validate, writeObject
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+added

+
+public com.threerings.miso.data.ObjectInfo[] added
+
+
The objects added to the scene (or null for none). +

+

+
+
+
+ +

+removed

+
+public com.threerings.miso.data.ObjectInfo[] removed
+
+
The objects removed from the scene (or null for none). +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+ModifyObjectsUpdate

+
+public ModifyObjectsUpdate()
+
+
+ + + + + + + + +
+Method Detail
+ +

+init

+
+public void init(int targetId,
+                 int targetVersion,
+                 com.threerings.miso.data.ObjectInfo[] added,
+                 com.threerings.miso.data.ObjectInfo[] removed)
+
+
Initializes this update with all necessary data. +

+

+
Parameters:
added - the objects added to the scene, or null for + none
removed - the objects removed from the scene, or null + for none
+
+
+
+ +

+apply

+
+public void apply(SceneModel model)
+
+
Description copied from class: SceneUpdate
+
Applies this update to the specified scene model. Derived classes will want to override this + method and apply updates of their own, being sure to call super.apply. +

+

+
Overrides:
apply in class SceneUpdate
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/data/StageCodes.html b/apidocs/com/threerings/stage/data/StageCodes.html new file mode 100644 index 00000000..687407c3 --- /dev/null +++ b/apidocs/com/threerings/stage/data/StageCodes.html @@ -0,0 +1,326 @@ + + + + + + + +StageCodes (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stage.data +
+Interface StageCodes

+
+
All Superinterfaces:
com.threerings.presents.data.InvocationCodes
+
+
+
All Known Implementing Classes:
PlacementConstraints
+
+
+
+
public interface StageCodes
extends com.threerings.presents.data.InvocationCodes
+ + +

+Codes and constants relating to the Stage system. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static StringERR_CANNOT_CLUSTER + +
+          An error delivered when adding objects to scenes.
+static StringERR_NO_OVERLAP + +
+          An error delivered when adding objects to scenes.
+static com.threerings.presents.data.PermissionMODIFY_SCENE_ACCESS + +
+          The access control identifier for scene modification privileges.
+static com.threerings.presents.data.PermissionMUTILATE_SCENE_ACCESS + +
+          The access control identifier for potentially damaging scene modification privileges.
+static StringSTAGE_MESSAGE_BUNDLE + +
+          The i18n bundle identifier for the Stage system.
+static StringTILESET_RSRC_SET + +
+          The resource set that contains our tileset bundles.
+  + + + + + + + +
Fields inherited from interface com.threerings.presents.data.InvocationCodes
ACCESS_DENIED, E_ACCESS_DENIED, E_INTERNAL_ERROR, GLOBAL_GROUP, INTERNAL_ERROR
+  +

+ + + + + + + + +
+Field Detail
+ +

+STAGE_MESSAGE_BUNDLE

+
+static final String STAGE_MESSAGE_BUNDLE
+
+
The i18n bundle identifier for the Stage system. +

+

+
See Also:
Constant Field Values
+
+
+ +

+TILESET_RSRC_SET

+
+static final String TILESET_RSRC_SET
+
+
The resource set that contains our tileset bundles. +

+

+
See Also:
Constant Field Values
+
+
+ +

+MODIFY_SCENE_ACCESS

+
+static final com.threerings.presents.data.Permission MODIFY_SCENE_ACCESS
+
+
The access control identifier for scene modification privileges. +

+

+
+
+
+ +

+MUTILATE_SCENE_ACCESS

+
+static final com.threerings.presents.data.Permission MUTILATE_SCENE_ACCESS
+
+
The access control identifier for potentially damaging scene modification privileges. +

+

+
+
+
+ +

+ERR_NO_OVERLAP

+
+static final String ERR_NO_OVERLAP
+
+
An error delivered when adding objects to scenes. +

+

+
+
+
+ +

+ERR_CANNOT_CLUSTER

+
+static final String ERR_CANNOT_CLUSTER
+
+
An error delivered when adding objects to scenes. +

+

+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/data/StageLocation.html b/apidocs/com/threerings/stage/data/StageLocation.html new file mode 100644 index 00000000..756bb967 --- /dev/null +++ b/apidocs/com/threerings/stage/data/StageLocation.html @@ -0,0 +1,522 @@ + + + + + + + +StageLocation (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stage.data +
+Class StageLocation

+
+java.lang.Object
+  extended by com.threerings.io.SimpleStreamableObject
+      extended by com.threerings.stage.data.StageLocation
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable, Location, Cloneable
+
+
+
+
public class StageLocation
extends com.threerings.io.SimpleStreamableObject
implements Location
+ + +

+Contains information on a scene occupant's position and orientation. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + + + + + + + + + +
+Field Summary
+ byteorient + +
+          The user's orientation (defined by DirectionCodes).
+ intx + +
+          The user's x position (interpreted by the display system).
+ inty + +
+          The user's y position (interpreted by the display system).
+  + + + + + + + + + + + + + +
+Constructor Summary
StageLocation() + +
+          A zero-argument constructor used when unserializing instances.
StageLocation(int x, + int y, + byte orient) + +
+          Constructs a location with the specified coordinates and + orientation.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ StageLocationclone() + +
+          Locations are cloneable.
+ booleanequals(Object other) + +
+          Location equality is determined by coordinates.
+ booleanequivalent(Location oloc) + +
+          Location equivalence means that the coordinates and orientation are + the same.
+ LocationgetOpposite() + +
+          Get a new Location instance that is equals() to this one but that + has an orientation facing the opposite direction.
+ inthashCode() + +
+          Computes a reasonable hashcode for location instances.
+ StringorientToString() + +
+          Object.toString() helper function.
+  + + + + + + + +
Methods inherited from class com.threerings.io.SimpleStreamableObject
toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+x

+
+public int x
+
+
The user's x position (interpreted by the display system). +

+

+
+
+
+ +

+y

+
+public int y
+
+
The user's y position (interpreted by the display system). +

+

+
+
+
+ +

+orient

+
+public byte orient
+
+
The user's orientation (defined by DirectionCodes). +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+StageLocation

+
+public StageLocation()
+
+
A zero-argument constructor used when unserializing instances. +

+

+
+ +

+StageLocation

+
+public StageLocation(int x,
+                     int y,
+                     byte orient)
+
+
Constructs a location with the specified coordinates and + orientation. +

+

+ + + + + + + + +
+Method Detail
+ +

+orientToString

+
+public String orientToString()
+
+
Object.toString() helper function. +

+

+
+
+
+
+
+
+
+ +

+getOpposite

+
+public Location getOpposite()
+
+
Description copied from interface: Location
+
Get a new Location instance that is equals() to this one but that + has an orientation facing the opposite direction. +

+

+
Specified by:
getOpposite in interface Location
+
+
+
+
+
+
+ +

+equivalent

+
+public boolean equivalent(Location oloc)
+
+
Location equivalence means that the coordinates and orientation are + the same. +

+

+
Specified by:
equivalent in interface Location
+
+
+
+
+
+
+ +

+equals

+
+public boolean equals(Object other)
+
+
Location equality is determined by coordinates. +

+

+
Specified by:
equals in interface Location
Overrides:
equals in class Object
+
+
+
+
+
+
+ +

+hashCode

+
+public int hashCode()
+
+
Computes a reasonable hashcode for location instances. +

+

+
Specified by:
hashCode in interface Location
Overrides:
hashCode in class Object
+
+
+
+
+
+
+ +

+clone

+
+public StageLocation clone()
+
+
Description copied from interface: Location
+
Locations are cloneable. +

+

+
Specified by:
clone in interface Location
Overrides:
clone in class Object
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/data/StageMisoSceneModel.html b/apidocs/com/threerings/stage/data/StageMisoSceneModel.html new file mode 100644 index 00000000..6c4db167 --- /dev/null +++ b/apidocs/com/threerings/stage/data/StageMisoSceneModel.html @@ -0,0 +1,466 @@ + + + + + + + +StageMisoSceneModel (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stage.data +
+Class StageMisoSceneModel

+
+java.lang.Object
+  extended by com.threerings.io.SimpleStreamableObject
+      extended by com.threerings.miso.data.MisoSceneModel
+          extended by com.threerings.miso.data.SparseMisoSceneModel
+              extended by com.threerings.stage.data.StageMisoSceneModel
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable, AuxModel, Cloneable
+
+
+
+
public class StageMisoSceneModel
extends com.threerings.miso.data.SparseMisoSceneModel
implements AuxModel
+ + +

+Extends the SparseMisoSceneModel with the necessary interface + to wire it up to the Whirled auxiliary model system. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.miso.data.SparseMisoSceneModel
com.threerings.miso.data.SparseMisoSceneModel.ObjectVisitor, com.threerings.miso.data.SparseMisoSceneModel.Section
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + + + + + +
+Field Summary
+static intSECTION_HEIGHT + +
+          The height (in tiles) of a scene section.
+static intSECTION_WIDTH + +
+          The width (in tiles) of a scene section.
+  + + + + + + + +
Fields inherited from class com.threerings.miso.data.SparseMisoSceneModel
defTileSet, sheight, swidth
+  + + + + + + + + + + +
+Constructor Summary
StageMisoSceneModel() + +
+          Creates a completely uninitialized scene model.
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ StageMisoSceneModelclone() + +
+          Creates a clone of this auxiliary model.
+static StageMisoSceneModelgetSceneModel(SceneModel model) + +
+          Locates and returns the StageMisoSceneModel among the + auxiliary scene models associated with the supplied scene model.
+ com.threerings.miso.data.SparseMisoSceneModel.SectiongetSection(int key) + +
+          Returns the section identified by the specified key, or null if no + section exists for that key.
+ intgetSectionKey(int x, + int y) + +
+          Returns the section key for the specified tile coordinate.
+  + + + + + + + +
Methods inherited from class com.threerings.miso.data.SparseMisoSceneModel
addObject, getAllObjects, getBaseTileId, getDefaultBaseTileSet, getInterestingObjects, getObjects, getSections, readField__sections, removeObject, setBaseTile, setDefaultBaseTileSet, setSection, updateObject, visitObjects, visitObjects, writeField__sections
+  + + + + + + + +
Methods inherited from class com.threerings.io.SimpleStreamableObject
toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+SECTION_WIDTH

+
+public static final int SECTION_WIDTH
+
+
The width (in tiles) of a scene section. +

+

+
See Also:
Constant Field Values
+
+
+ +

+SECTION_HEIGHT

+
+public static final int SECTION_HEIGHT
+
+
The height (in tiles) of a scene section. +

+

+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Constructor Detail
+ +

+StageMisoSceneModel

+
+public StageMisoSceneModel()
+
+
Creates a completely uninitialized scene model. +

+

+ + + + + + + + +
+Method Detail
+ +

+getSceneModel

+
+public static StageMisoSceneModel getSceneModel(SceneModel model)
+
+
Locates and returns the StageMisoSceneModel among the + auxiliary scene models associated with the supplied scene model. + null is returned if no miso scene model could be + found. +

+

+
+
+
+
+
+
+
+ +

+getSectionKey

+
+public int getSectionKey(int x,
+                         int y)
+
+
Returns the section key for the specified tile coordinate. +

+

+
+
+
+
+
+
+
+ +

+getSection

+
+public com.threerings.miso.data.SparseMisoSceneModel.Section getSection(int key)
+
+
Returns the section identified by the specified key, or null if no + section exists for that key. +

+

+
+
+
+
+
+
+
+ +

+clone

+
+public StageMisoSceneModel clone()
+
+
Description copied from interface: AuxModel
+
Creates a clone of this auxiliary model. +

+

+
Specified by:
clone in interface AuxModel
Overrides:
clone in class com.threerings.miso.data.SparseMisoSceneModel
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/data/StageOccupantInfo.html b/apidocs/com/threerings/stage/data/StageOccupantInfo.html new file mode 100644 index 00000000..af5cd25b --- /dev/null +++ b/apidocs/com/threerings/stage/data/StageOccupantInfo.html @@ -0,0 +1,350 @@ + + + + + + + +StageOccupantInfo (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stage.data +
+Class StageOccupantInfo

+
+java.lang.Object
+  extended by com.threerings.io.SimpleStreamableObject
+      extended by com.threerings.crowd.data.OccupantInfo
+          extended by com.threerings.stage.data.StageOccupantInfo
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable, com.threerings.presents.dobj.DSet.Entry, Cloneable
+
+
+
+
public class StageOccupantInfo
extends com.threerings.crowd.data.OccupantInfo
+ + +

+Extends the standard occupant info with stage specific business. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.crowd.data.OccupantInfo
com.threerings.crowd.data.OccupantInfo.NameUpdater, com.threerings.crowd.data.OccupantInfo.Updater<T extends com.threerings.crowd.data.OccupantInfo>
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class com.threerings.crowd.data.OccupantInfo
ACTIVE, bodyOid, DISCONNECTED, IDLE, status, username, X_STATUS
+  + + + + + + + + + + + + + +
+Constructor Summary
StageOccupantInfo() + +
+          Used for unserialization.
StageOccupantInfo(com.threerings.crowd.data.BodyObject body) + +
+          Creates a new instance for the specified body.
+  + + + + + + + + + + + +
+Method Summary
+ booleanisClusterable() + +
+          Should return true if the occupant in question is available to be + clustered with, false if they are "busy".
+  + + + + + + + +
Methods inherited from class com.threerings.crowd.data.OccupantInfo
clone, getBodyOid, getKey
+  + + + + + + + +
Methods inherited from class com.threerings.io.SimpleStreamableObject
toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+StageOccupantInfo

+
+public StageOccupantInfo(com.threerings.crowd.data.BodyObject body)
+
+
Creates a new instance for the specified body. +

+

+
+ +

+StageOccupantInfo

+
+public StageOccupantInfo()
+
+
Used for unserialization. +

+

+ + + + + + + + +
+Method Detail
+ +

+isClusterable

+
+public boolean isClusterable()
+
+
Should return true if the occupant in question is available to be + clustered with, false if they are "busy". This means that a user + can click on them and start a chat circle. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/data/StageScene.html b/apidocs/com/threerings/stage/data/StageScene.html new file mode 100644 index 00000000..d1cf168b --- /dev/null +++ b/apidocs/com/threerings/stage/data/StageScene.html @@ -0,0 +1,717 @@ + + + + + + + +StageScene (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stage.data +
+Class StageScene

+
+java.lang.Object
+  extended by com.threerings.whirled.data.SceneImpl
+      extended by com.threerings.stage.data.StageScene
+
+
+
All Implemented Interfaces:
Scene, SpotScene, Cloneable
+
+
+
+
public class StageScene
extends SceneImpl
implements SpotScene, Cloneable
+ + +

+The implementation of the Stage scene interface. +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
StageScene(StageSceneModel model, + com.threerings.crowd.data.PlaceConfig config) + +
+          Creates an instance that will obtain data from the supplied scene + model and place config.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidaddObject(com.threerings.miso.data.ObjectInfo info) + +
+          Adds a new object to this scene.
+ voidaddPortal(Portal portal) + +
+          Adds a portal to this scene, immediately making the requisite modifications to the + underlying scene model.
+ StageSceneclone() + +
+           
+ Iterator<com.threerings.miso.data.ObjectInfo>enumerateObjects() + +
+          Iterates over all of the interesting objects in this scene.
+ intgetDefaultColor(int classId) + +
+          Get the default color id to use for the specified colorization class, + or -1 if no default is set.
+ PortalgetDefaultEntrance() + +
+          Returns the portal that represents the default entrance to this scene.
+ shortgetNextPortalId() + +
+          Returns the portal id that should be assigned to the next portal added to this scene.
+ PortalgetPortal(int portalId) + +
+          Returns a Portal object for the portal with the specified id or null if no portal + exists with that id.
+ intgetPortalCount() + +
+          Returns the number of portals in this scene.
+ Iterator<Portal>getPortals() + +
+          Returns an iterator over the portals in this scene.
+ StringgetType() + +
+          Returns the scene type (e.g.
+ intgetZoneId() + +
+          Returns the zone id to which this scene belongs.
+ booleanremoveObject(com.threerings.miso.data.ObjectInfo info) + +
+          Removes an object from this scene.
+ voidremovePortal(Portal portal) + +
+          Removes the specified portal from the scene.
+ voidsetDefaultColor(int classId, + int colorId) + +
+          Set the default color to use for the specified colorization class id.
+ voidsetDefaultEntrance(Portal portal) + +
+          Sets the default entrance in this scene, immediately making the requisite modifications to + the underlying scene model.
+ voidsetType(String type) + +
+          Sets the type of this scene.
+ voidupdateReceived(SceneUpdate update) + +
+          Called to inform the scene that an update has been received while + the scene was resolved and active.
+  + + + + + + + +
Methods inherited from class com.threerings.whirled.data.SceneImpl
getId, getName, getPlaceConfig, getSceneModel, getVersion, setId, setName, setVersion, toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+StageScene

+
+public StageScene(StageSceneModel model,
+                  com.threerings.crowd.data.PlaceConfig config)
+
+
Creates an instance that will obtain data from the supplied scene + model and place config. +

+

+ + + + + + + + +
+Method Detail
+ +

+getType

+
+public String getType()
+
+
Returns the scene type (e.g. "world", "port", "bank", etc.). +

+

+
+
+
+
+
+
+
+ +

+getZoneId

+
+public int getZoneId()
+
+
Returns the zone id to which this scene belongs. +

+

+
+
+
+
+
+
+
+ +

+setType

+
+public void setType(String type)
+
+
Sets the type of this scene. +

+

+
+
+
+
+
+
+
+ +

+getDefaultColor

+
+public int getDefaultColor(int classId)
+
+
Get the default color id to use for the specified colorization class, + or -1 if no default is set. +

+

+
+
+
+
+
+
+
+ +

+setDefaultColor

+
+public void setDefaultColor(int classId,
+                            int colorId)
+
+
Set the default color to use for the specified colorization class id. + Setting the colorId to -1 disables the default. +

+

+
+
+
+
+
+
+
+ +

+enumerateObjects

+
+public Iterator<com.threerings.miso.data.ObjectInfo> enumerateObjects()
+
+
Iterates over all of the interesting objects in this scene. +

+

+
+
+
+
+
+
+
+ +

+addObject

+
+public void addObject(com.threerings.miso.data.ObjectInfo info)
+
+
Adds a new object to this scene. +

+

+
+
+
+
+
+
+
+ +

+removeObject

+
+public boolean removeObject(com.threerings.miso.data.ObjectInfo info)
+
+
Removes an object from this scene. +

+

+
+
+
+
+
+
+
+ +

+updateReceived

+
+public void updateReceived(SceneUpdate update)
+
+
Description copied from interface: Scene
+
Called to inform the scene that an update has been received while + the scene was resolved and active. The update should be applied to + the underlying scene model and any derivative data should be + appropriately updated. +

+

+
Specified by:
updateReceived in interface Scene
Overrides:
updateReceived in class SceneImpl
+
+
+
+
+
+
+ +

+clone

+
+public StageScene clone()
+                 throws CloneNotSupportedException
+
+
+
Overrides:
clone in class Object
+
+
+ +
Throws: +
CloneNotSupportedException
+
+
+
+ +

+getPortal

+
+public Portal getPortal(int portalId)
+
+
Description copied from interface: SpotScene
+
Returns a Portal object for the portal with the specified id or null if no portal + exists with that id. +

+

+
Specified by:
getPortal in interface SpotScene
+
+
+
+
+
+
+ +

+getPortalCount

+
+public int getPortalCount()
+
+
Description copied from interface: SpotScene
+
Returns the number of portals in this scene. +

+

+
Specified by:
getPortalCount in interface SpotScene
+
+
+
+
+
+
+ +

+getPortals

+
+public Iterator<Portal> getPortals()
+
+
Description copied from interface: SpotScene
+
Returns an iterator over the portals in this scene. +

+

+
Specified by:
getPortals in interface SpotScene
+
+
+
+
+
+
+ +

+getNextPortalId

+
+public short getNextPortalId()
+
+
Description copied from interface: SpotScene
+
Returns the portal id that should be assigned to the next portal added to this scene. +

+

+
Specified by:
getNextPortalId in interface SpotScene
+
+
+
+
+
+
+ +

+getDefaultEntrance

+
+public Portal getDefaultEntrance()
+
+
Description copied from interface: SpotScene
+
Returns the portal that represents the default entrance to this scene. If a body enters the + scene at logon time rather than entering from some other scene, this is the portal at which + they would appear. +

+

+
Specified by:
getDefaultEntrance in interface SpotScene
+
+
+
+
+
+
+ +

+addPortal

+
+public void addPortal(Portal portal)
+
+
Description copied from interface: SpotScene
+
Adds a portal to this scene, immediately making the requisite modifications to the + underlying scene model. The portal id should have already been assigned using the value + obtained from SpotScene.getNextPortalId(). +

+

+
Specified by:
addPortal in interface SpotScene
+
+
+
+
+
+
+ +

+removePortal

+
+public void removePortal(Portal portal)
+
+
Description copied from interface: SpotScene
+
Removes the specified portal from the scene. +

+

+
Specified by:
removePortal in interface SpotScene
+
+
+
+
+
+
+ +

+setDefaultEntrance

+
+public void setDefaultEntrance(Portal portal)
+
+
Description copied from interface: SpotScene
+
Sets the default entrance in this scene, immediately making the requisite modifications to + the underlying scene model. +

+

+
Specified by:
setDefaultEntrance in interface SpotScene
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/data/StageSceneConfig.html b/apidocs/com/threerings/stage/data/StageSceneConfig.html new file mode 100644 index 00000000..e5298f07 --- /dev/null +++ b/apidocs/com/threerings/stage/data/StageSceneConfig.html @@ -0,0 +1,324 @@ + + + + + + + +StageSceneConfig (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stage.data +
+Class StageSceneConfig

+
+java.lang.Object
+  extended by com.threerings.io.SimpleStreamableObject
+      extended by com.threerings.crowd.data.PlaceConfig
+          extended by com.threerings.stage.data.StageSceneConfig
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable
+
+
+
+
public class StageSceneConfig
extends com.threerings.crowd.data.PlaceConfig
+ + +

+Place configuration for the main isometric scenes in Stage. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + +
+Constructor Summary
StageSceneConfig() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ com.threerings.crowd.client.PlaceControllercreateController() + +
+           
+ StringgetManagerClassName() + +
+           
+  + + + + + + + +
Methods inherited from class com.threerings.crowd.data.PlaceConfig
getControllerClass
+  + + + + + + + +
Methods inherited from class com.threerings.io.SimpleStreamableObject
toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+StageSceneConfig

+
+public StageSceneConfig()
+
+
+ + + + + + + + +
+Method Detail
+ +

+createController

+
+public com.threerings.crowd.client.PlaceController createController()
+
+
+
Overrides:
createController in class com.threerings.crowd.data.PlaceConfig
+
+
+
+
+
+
+ +

+getManagerClassName

+
+public String getManagerClassName()
+
+
+
Specified by:
getManagerClassName in class com.threerings.crowd.data.PlaceConfig
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/data/StageSceneMarshaller.html b/apidocs/com/threerings/stage/data/StageSceneMarshaller.html new file mode 100644 index 00000000..867a456e --- /dev/null +++ b/apidocs/com/threerings/stage/data/StageSceneMarshaller.html @@ -0,0 +1,408 @@ + + + + + + + +StageSceneMarshaller (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stage.data +
+Class StageSceneMarshaller

+
+java.lang.Object
+  extended by com.threerings.presents.data.InvocationMarshaller
+      extended by com.threerings.stage.data.StageSceneMarshaller
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable, com.threerings.presents.client.InvocationService, StageSceneService
+
+
+
+
@Generated(value="com.threerings.presents.tools.GenServiceTask",
+           comments="Derived from StageSceneService.java.")
+public class StageSceneMarshaller
extends com.threerings.presents.data.InvocationMarshaller
implements StageSceneService
+ + +

+Provides the implementation of the StageSceneService interface + that marshalls the arguments and delivers the request to the provider + on the server. Also provides an implementation of the response listener + interfaces that marshall the response arguments and deliver them back + to the requesting client. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.presents.data.InvocationMarshaller
com.threerings.presents.data.InvocationMarshaller.ConfirmMarshaller, com.threerings.presents.data.InvocationMarshaller.ListenerMarshaller, com.threerings.presents.data.InvocationMarshaller.ResultMarshaller
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.presents.client.InvocationService
com.threerings.presents.client.InvocationService.ConfirmListener, com.threerings.presents.client.InvocationService.InvocationListener, com.threerings.presents.client.InvocationService.ResultListener
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + + + + + +
+Field Summary
+static intADD_OBJECT + +
+          The method id used to dispatch addObject(com.threerings.miso.data.ObjectInfo, com.threerings.presents.client.InvocationService.ConfirmListener) requests.
+static intREMOVE_OBJECTS + +
+          The method id used to dispatch removeObjects(com.threerings.miso.data.ObjectInfo[], com.threerings.presents.client.InvocationService.ConfirmListener) requests.
+  + + + + + + + + + + +
+Constructor Summary
StageSceneMarshaller() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ voidaddObject(com.threerings.miso.data.ObjectInfo arg1, + com.threerings.presents.client.InvocationService.ConfirmListener arg2) + +
+          Requests to add the supplied object to the current scene.
+ voidremoveObjects(com.threerings.miso.data.ObjectInfo[] arg1, + com.threerings.presents.client.InvocationService.ConfirmListener arg2) + +
+          Requests to remove the supplied objects from the current scene.
+  + + + + + + + +
Methods inherited from class com.threerings.presents.data.InvocationMarshaller
getInvocationCode, init, readField__invCode, readField__invOid, readObject, setInvocationOid, setNoResponse, toString, writeField__invCode, writeField__invOid
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+ADD_OBJECT

+
+public static final int ADD_OBJECT
+
+
The method id used to dispatch addObject(com.threerings.miso.data.ObjectInfo, com.threerings.presents.client.InvocationService.ConfirmListener) requests. +

+

+
See Also:
Constant Field Values
+
+
+ +

+REMOVE_OBJECTS

+
+public static final int REMOVE_OBJECTS
+
+
The method id used to dispatch removeObjects(com.threerings.miso.data.ObjectInfo[], com.threerings.presents.client.InvocationService.ConfirmListener) requests. +

+

+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Constructor Detail
+ +

+StageSceneMarshaller

+
+public StageSceneMarshaller()
+
+
+ + + + + + + + +
+Method Detail
+ +

+addObject

+
+public void addObject(com.threerings.miso.data.ObjectInfo arg1,
+                      com.threerings.presents.client.InvocationService.ConfirmListener arg2)
+
+
Description copied from interface: StageSceneService
+
Requests to add the supplied object to the current scene. +

+

+
Specified by:
addObject in interface StageSceneService
+
+
+
+
+
+
+ +

+removeObjects

+
+public void removeObjects(com.threerings.miso.data.ObjectInfo[] arg1,
+                          com.threerings.presents.client.InvocationService.ConfirmListener arg2)
+
+
Description copied from interface: StageSceneService
+
Requests to remove the supplied objects from the current scene. +

+

+
Specified by:
removeObjects in interface StageSceneService
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/data/StageSceneModel.html b/apidocs/com/threerings/stage/data/StageSceneModel.html new file mode 100644 index 00000000..808596fb --- /dev/null +++ b/apidocs/com/threerings/stage/data/StageSceneModel.html @@ -0,0 +1,461 @@ + + + + + + + +StageSceneModel (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stage.data +
+Class StageSceneModel

+
+java.lang.Object
+  extended by com.threerings.io.SimpleStreamableObject
+      extended by com.threerings.whirled.data.SceneModel
+          extended by com.threerings.stage.data.StageSceneModel
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable, Cloneable
+
+
+
+
public class StageSceneModel
extends SceneModel
+ + +

+Extends the basic scene model with the notion of a scene type and + incorporates the necessary auxiliary models used by the Stage system. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+ com.threerings.util.StreamableHashMap<Integer,Integer>defaultColors + +
+          If non-null, contains default colorizations to use for objects + that do not have colorizations defined.
+ Stringtype + +
+          This scene's type which is a string identifier used to later + construct a specific controller to handle this scene.
+static StringWORLD + +
+          A scene type code.
+ intzoneId + +
+          The zone id to which this scene belongs.
+  + + + + + + + +
Fields inherited from class com.threerings.whirled.data.SceneModel
auxModels, name, sceneId, version
+  + + + + + + + + + + +
+Constructor Summary
StageSceneModel() + +
+           
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+static StageSceneModelblankStageSceneModel() + +
+          Creates and returns a blank scene model.
+ intgetDefaultColor(int classId) + +
+          Get the default color to use for the specified colorization + classId, or -1 if no default is set for that colorization.
+ voidsetDefaultColor(int classId, + int colorId) + +
+          Set the default colorId to use for a specified colorization + classId, or -1 to clear the default for that colorization.
+  + + + + + + + +
Methods inherited from class com.threerings.whirled.data.SceneModel
addAuxModel, blankSceneModel, clone
+  + + + + + + + +
Methods inherited from class com.threerings.io.SimpleStreamableObject
toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+WORLD

+
+public static final String WORLD
+
+
A scene type code. +

+

+
See Also:
Constant Field Values
+
+
+ +

+type

+
+public String type
+
+
This scene's type which is a string identifier used to later + construct a specific controller to handle this scene. +

+

+
+
+
+ +

+zoneId

+
+public int zoneId
+
+
The zone id to which this scene belongs. +

+

+
+
+
+ +

+defaultColors

+
+public com.threerings.util.StreamableHashMap<Integer,Integer> defaultColors
+
+
If non-null, contains default colorizations to use for objects + that do not have colorizations defined. +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+StageSceneModel

+
+public StageSceneModel()
+
+
+ + + + + + + + +
+Method Detail
+ +

+getDefaultColor

+
+public int getDefaultColor(int classId)
+
+
Get the default color to use for the specified colorization + classId, or -1 if no default is set for that colorization. +

+

+
+
+
+
+ +

+setDefaultColor

+
+public void setDefaultColor(int classId,
+                            int colorId)
+
+
Set the default colorId to use for a specified colorization + classId, or -1 to clear the default for that colorization. +

+

+
+
+
+
+ +

+blankStageSceneModel

+
+public static StageSceneModel blankStageSceneModel()
+
+
Creates and returns a blank scene model. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/data/StageSceneObject.html b/apidocs/com/threerings/stage/data/StageSceneObject.html new file mode 100644 index 00000000..8ed6ea79 --- /dev/null +++ b/apidocs/com/threerings/stage/data/StageSceneObject.html @@ -0,0 +1,555 @@ + + + + + + + +StageSceneObject (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stage.data +
+Class StageSceneObject

+
+java.lang.Object
+  extended by com.threerings.presents.dobj.DObject
+      extended by com.threerings.crowd.data.PlaceObject
+          extended by com.threerings.whirled.data.SceneObject
+              extended by com.threerings.whirled.spot.data.SpotSceneObject
+                  extended by com.threerings.stage.data.StageSceneObject
+
+
+
All Implemented Interfaces:
com.threerings.crowd.chat.data.SpeakObject, com.threerings.io.Streamable
+
+
+
+
public class StageSceneObject
extends SpotSceneObject
+ + +

+Extends the basic SpotSceneObject with data and services + specific to isometric stage scenes. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.crowd.data.PlaceObject
com.threerings.crowd.data.PlaceObject.ManagerCaller
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.crowd.chat.data.SpeakObject
com.threerings.crowd.chat.data.SpeakObject.ListenerOp
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static StringLIGHT_LEVEL + +
+          The field name of the lightLevel field.
+static StringLIGHT_SHADE + +
+          The field name of the lightShade field.
+ floatlightLevel + +
+          The light level in this scene.
+ intlightShade + +
+          The color of the light.
+static StringSTAGE_SCENE_SERVICE + +
+          The field name of the stageSceneService field.
+ StageSceneMarshallerstageSceneService + +
+          Provides stage scene services.
+  + + + + + + + +
Fields inherited from class com.threerings.whirled.spot.data.SpotSceneObject
clusters, CLUSTERS, OCCUPANT_LOCS, occupantLocs
+  + + + + + + + +
Fields inherited from class com.threerings.crowd.data.PlaceObject
manager, OCCUPANT_INFO, occupantInfo, occupants, OCCUPANTS, SPEAK_SERVICE, speakService
+  + + + + + + + + + + +
+Constructor Summary
StageSceneObject() + +
+           
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidsetLightLevel(float value) + +
+          Requests that the lightLevel field be set to the + specified value.
+ voidsetLightShade(int value) + +
+          Requests that the lightShade field be set to the + specified value.
+ voidsetStageSceneService(StageSceneMarshaller value) + +
+          Requests that the stageSceneService field be set to the + specified value.
+  + + + + + + + +
Methods inherited from class com.threerings.whirled.spot.data.SpotSceneObject
addToClusters, addToOccupantLocs, removeFromClusters, removeFromOccupantLocs, setClusters, setOccupantLocs, updateClusters, updateOccupantLocs
+  + + + + + + + +
Methods inherited from class com.threerings.crowd.data.PlaceObject
addToOccupantInfo, addToOccupants, applyToListeners, getOccupantInfo, initManagerCaller, removeFromOccupantInfo, removeFromOccupants, setOccupantInfo, setSpeakService, shouldBroadcast, updateOccupantInfo
+  + + + + + + + +
Methods inherited from class com.threerings.presents.dobj.DObject
acquireLock, addListener, addListener, addSubscriber, addToSet, cancelTransaction, changeAttribute, checkPermissions, checkPermissions, commitTransaction, destroy, getAccessController, getAttribute, getLocal, getLocals, getManager, getOid, getSet, inTransaction, isActive, notifyListeners, notifyProxies, postEvent, postMessage, postMessage, readField__oid, releaseLock, removeFromSet, removeListener, removeSubscriber, setAccessController, setAttribute, setDestroyOnLastSubscriberRemoved, setLocal, setManager, setOid, startTransaction, toString, updateSet, which, writeField__oid
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+STAGE_SCENE_SERVICE

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public static final String STAGE_SCENE_SERVICE
+
+
The field name of the stageSceneService field. +

+

+
See Also:
Constant Field Values
+
+
+ +

+LIGHT_LEVEL

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public static final String LIGHT_LEVEL
+
+
The field name of the lightLevel field. +

+

+
See Also:
Constant Field Values
+
+
+ +

+LIGHT_SHADE

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public static final String LIGHT_SHADE
+
+
The field name of the lightShade field. +

+

+
See Also:
Constant Field Values
+
+
+ +

+stageSceneService

+
+public StageSceneMarshaller stageSceneService
+
+
Provides stage scene services. +

+

+
+
+
+ +

+lightLevel

+
+public float lightLevel
+
+
The light level in this scene. 0f being fully on, 1f fully shaded. +

+

+
+
+
+ +

+lightShade

+
+public int lightShade
+
+
The color of the light. +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+StageSceneObject

+
+public StageSceneObject()
+
+
+ + + + + + + + +
+Method Detail
+ +

+setStageSceneService

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public void setStageSceneService(StageSceneMarshaller value)
+
+
Requests that the stageSceneService field be set to the + specified value. The local value will be updated immediately and an + event will be propagated through the system to notify all listeners + that the attribute did change. Proxied copies of this object (on + clients) will apply the value change when they received the + attribute changed notification. +

+

+
+
+
+
+ +

+setLightLevel

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public void setLightLevel(float value)
+
+
Requests that the lightLevel field be set to the + specified value. The local value will be updated immediately and an + event will be propagated through the system to notify all listeners + that the attribute did change. Proxied copies of this object (on + clients) will apply the value change when they received the + attribute changed notification. +

+

+
+
+
+
+ +

+setLightShade

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public void setLightShade(int value)
+
+
Requests that the lightShade field be set to the + specified value. The local value will be updated immediately and an + event will be propagated through the system to notify all listeners + that the attribute did change. Proxied copies of this object (on + clients) will apply the value change when they received the + attribute changed notification. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/data/class-use/DefaultColorUpdate.html b/apidocs/com/threerings/stage/data/class-use/DefaultColorUpdate.html new file mode 100644 index 00000000..9f30e3b5 --- /dev/null +++ b/apidocs/com/threerings/stage/data/class-use/DefaultColorUpdate.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.stage.data.DefaultColorUpdate (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stage.data.DefaultColorUpdate

+
+No usage of com.threerings.stage.data.DefaultColorUpdate +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/data/class-use/ModifyObjectsUpdate.html b/apidocs/com/threerings/stage/data/class-use/ModifyObjectsUpdate.html new file mode 100644 index 00000000..345383c2 --- /dev/null +++ b/apidocs/com/threerings/stage/data/class-use/ModifyObjectsUpdate.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.stage.data.ModifyObjectsUpdate (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stage.data.ModifyObjectsUpdate

+
+No usage of com.threerings.stage.data.ModifyObjectsUpdate +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/data/class-use/StageCodes.html b/apidocs/com/threerings/stage/data/class-use/StageCodes.html new file mode 100644 index 00000000..d6db72ed --- /dev/null +++ b/apidocs/com/threerings/stage/data/class-use/StageCodes.html @@ -0,0 +1,182 @@ + + + + + + + +Uses of Interface com.threerings.stage.data.StageCodes (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.stage.data.StageCodes

+
+ + + + + + + + + +
+Packages that use StageCodes
com.threerings.stage.util  
+  +

+ + + + + +
+Uses of StageCodes in com.threerings.stage.util
+  +

+ + + + + + + + + +
Classes in com.threerings.stage.util that implement StageCodes
+ classPlacementConstraints + +
+          Maintains extra information on objects in a scene and checks proposed + placement operations for constraint violations.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/data/class-use/StageLocation.html b/apidocs/com/threerings/stage/data/class-use/StageLocation.html new file mode 100644 index 00000000..c390cd2e --- /dev/null +++ b/apidocs/com/threerings/stage/data/class-use/StageLocation.html @@ -0,0 +1,322 @@ + + + + + + + +Uses of Class com.threerings.stage.data.StageLocation (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stage.data.StageLocation

+
+ + + + + + + + + + + + + + + + + + + + + +
+Packages that use StageLocation
com.threerings.stage.client  
com.threerings.stage.data  
com.threerings.stage.server  
com.threerings.stage.util  
+  +

+ + + + + +
+Uses of StageLocation in com.threerings.stage.client
+  +

+ + + + + + + + + +
Methods in com.threerings.stage.client with parameters of type StageLocation
+ voidStageSceneController.handleLocationClicked(Object source, + StageLocation loc) + +
+          Called when the user clicks on a location within the scene.
+  +

+ + + + + +
+Uses of StageLocation in com.threerings.stage.data
+  +

+ + + + + + + + + +
Methods in com.threerings.stage.data that return StageLocation
+ StageLocationStageLocation.clone() + +
+           
+  +

+ + + + + +
+Uses of StageLocation in com.threerings.stage.server
+  +

+ + + + + + + + + +
Methods in com.threerings.stage.server with parameters of type StageLocation
+ booleanStageSceneManager.mayStandAtLocation(com.threerings.crowd.data.BodyObject source, + StageLocation loc) + +
+          Called by NPPs to determine whether or not they can stand at the + specified location.
+  +

+ + + + + +
+Uses of StageLocation in com.threerings.stage.util
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in com.threerings.stage.util that return StageLocation
+static StageLocationStageSceneUtil.findStandingSpot(Rectangle foot, + int dist, + com.threerings.media.util.AStarPathUtil.TraversalPred pred, + Object traverser, + Point nearto, + int orient) + +
+          Locates a spot to stand near the supplied rectangular footprint.
+static StageLocationStageSceneUtil.locationForObject(com.threerings.media.tile.TileManager tilemgr, + int tileId, + int tx, + int ty) + +
+          Does the necessary jiggery pokery to figure out where the specified object's associated + location is.
+static StageLocationStageSceneUtil.locationForObject(com.threerings.media.tile.TileManager tilemgr, + int tileId, + int tx, + int ty, + int orient) + +
+          Does the necessary jiggery pokery to figure out where the specified object's associated + location is.
+static StageLocationStageSceneUtil.locationForObject(com.threerings.media.tile.TileManager tilemgr, + com.threerings.miso.data.ObjectInfo info) + +
+          Does the necessary jiggery pokery to figure out where the specified object's associated + location is.
+static StageLocationStageSceneUtil.locationForObject(com.threerings.media.tile.TileManager tilemgr, + com.threerings.miso.data.ObjectInfo info, + int orient) + +
+          Does the necessary jiggery pokery to figure out where the specified object's associated + location is.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/data/class-use/StageMisoSceneModel.html b/apidocs/com/threerings/stage/data/class-use/StageMisoSceneModel.html new file mode 100644 index 00000000..a6b277ea --- /dev/null +++ b/apidocs/com/threerings/stage/data/class-use/StageMisoSceneModel.html @@ -0,0 +1,227 @@ + + + + + + + +Uses of Class com.threerings.stage.data.StageMisoSceneModel (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stage.data.StageMisoSceneModel

+
+ + + + + + + + + + + + + +
+Packages that use StageMisoSceneModel
com.threerings.stage.data  
com.threerings.stage.tools.editor  
+  +

+ + + + + +
+Uses of StageMisoSceneModel in com.threerings.stage.data
+  +

+ + + + + + + + + + + + + +
Methods in com.threerings.stage.data that return StageMisoSceneModel
+ StageMisoSceneModelStageMisoSceneModel.clone() + +
+           
+static StageMisoSceneModelStageMisoSceneModel.getSceneModel(SceneModel model) + +
+          Locates and returns the StageMisoSceneModel among the + auxiliary scene models associated with the supplied scene model.
+  +

+ + + + + +
+Uses of StageMisoSceneModel in com.threerings.stage.tools.editor
+  +

+ + + + + + + + + + + + + +
Methods in com.threerings.stage.tools.editor with parameters of type StageMisoSceneModel
+ voidEditorScenePanel.SceneModelListener.setMisoSceneModel(StageMisoSceneModel sceneModel) + +
+           
+ voidEditorFrame.setMisoSceneModel(StageMisoSceneModel model) + +
+           
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/data/class-use/StageOccupantInfo.html b/apidocs/com/threerings/stage/data/class-use/StageOccupantInfo.html new file mode 100644 index 00000000..a97f96f5 --- /dev/null +++ b/apidocs/com/threerings/stage/data/class-use/StageOccupantInfo.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.stage.data.StageOccupantInfo (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stage.data.StageOccupantInfo

+
+No usage of com.threerings.stage.data.StageOccupantInfo +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/data/class-use/StageScene.html b/apidocs/com/threerings/stage/data/class-use/StageScene.html new file mode 100644 index 00000000..0ec64514 --- /dev/null +++ b/apidocs/com/threerings/stage/data/class-use/StageScene.html @@ -0,0 +1,337 @@ + + + + + + + +Uses of Class com.threerings.stage.data.StageScene (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stage.data.StageScene

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
+Packages that use StageScene
com.threerings.stage.client  
com.threerings.stage.data  
com.threerings.stage.tools.editor  
com.threerings.stage.tools.viewer  
com.threerings.stage.util  
+  +

+ + + + + +
+Uses of StageScene in com.threerings.stage.client
+  +

+ + + + + + + + + +
Methods in com.threerings.stage.client that return StageScene
+ StageSceneStageScenePanel.getScene() + +
+          Returns the scene being displayed by this panel.
+  +

+ + + + + + + + + +
Methods in com.threerings.stage.client with parameters of type StageScene
+ voidStageScenePanel.setScene(StageScene scene) + +
+          Sets the scene managed by the panel.
+  +

+ + + + + + + + +
Constructors in com.threerings.stage.client with parameters of type StageScene
SceneColorizer(com.threerings.media.image.ColorPository cpos, + StageScene scene) + +
+          Creates a scene colorizer for the supplied scene.
+  +

+ + + + + +
+Uses of StageScene in com.threerings.stage.data
+  +

+ + + + + + + + + +
Methods in com.threerings.stage.data that return StageScene
+ StageSceneStageScene.clone() + +
+           
+  +

+ + + + + +
+Uses of StageScene in com.threerings.stage.tools.editor
+  +

+ + + + + + + + + + + + + +
Methods in com.threerings.stage.tools.editor with parameters of type StageScene
+ voidPortalDialog.prepare(StageScene scene, + EditablePortal port) + +
+          Prepare the dialog for display.
+ voidSceneInfoPanel.setScene(StageScene scene) + +
+          Called when the scene in the editor changes.
+  +

+ + + + + +
+Uses of StageScene in com.threerings.stage.tools.viewer
+  +

+ + + + + + + + + +
Methods in com.threerings.stage.tools.viewer with parameters of type StageScene
+ voidViewerScenePanel.setScene(StageScene scene, + Location defloc) + +
+           
+  +

+ + + + + +
+Uses of StageScene in com.threerings.stage.util
+  +

+ + + + + + + + +
Constructors in com.threerings.stage.util with parameters of type StageScene
PlacementConstraints(com.threerings.media.tile.TileManager tilemgr, + StageScene scene) + +
+          Default constructor.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/data/class-use/StageSceneConfig.html b/apidocs/com/threerings/stage/data/class-use/StageSceneConfig.html new file mode 100644 index 00000000..10d11bbe --- /dev/null +++ b/apidocs/com/threerings/stage/data/class-use/StageSceneConfig.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.stage.data.StageSceneConfig (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stage.data.StageSceneConfig

+
+No usage of com.threerings.stage.data.StageSceneConfig +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/data/class-use/StageSceneMarshaller.html b/apidocs/com/threerings/stage/data/class-use/StageSceneMarshaller.html new file mode 100644 index 00000000..53d2f687 --- /dev/null +++ b/apidocs/com/threerings/stage/data/class-use/StageSceneMarshaller.html @@ -0,0 +1,198 @@ + + + + + + + +Uses of Class com.threerings.stage.data.StageSceneMarshaller (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stage.data.StageSceneMarshaller

+
+ + + + + + + + + +
+Packages that use StageSceneMarshaller
com.threerings.stage.data  
+  +

+ + + + + +
+Uses of StageSceneMarshaller in com.threerings.stage.data
+  +

+ + + + + + + + + +
Fields in com.threerings.stage.data declared as StageSceneMarshaller
+ StageSceneMarshallerStageSceneObject.stageSceneService + +
+          Provides stage scene services.
+  +

+ + + + + + + + + +
Methods in com.threerings.stage.data with parameters of type StageSceneMarshaller
+ voidStageSceneObject.setStageSceneService(StageSceneMarshaller value) + +
+          Requests that the stageSceneService field be set to the + specified value.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/data/class-use/StageSceneModel.html b/apidocs/com/threerings/stage/data/class-use/StageSceneModel.html new file mode 100644 index 00000000..cf691f8f --- /dev/null +++ b/apidocs/com/threerings/stage/data/class-use/StageSceneModel.html @@ -0,0 +1,229 @@ + + + + + + + +Uses of Class com.threerings.stage.data.StageSceneModel (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stage.data.StageSceneModel

+
+ + + + + + + + + + + + + +
+Packages that use StageSceneModel
com.threerings.stage.data  
com.threerings.stage.util  
+  +

+ + + + + +
+Uses of StageSceneModel in com.threerings.stage.data
+  +

+ + + + + + + + + +
Methods in com.threerings.stage.data that return StageSceneModel
+static StageSceneModelStageSceneModel.blankStageSceneModel() + +
+          Creates and returns a blank scene model.
+  +

+ + + + + + + + +
Constructors in com.threerings.stage.data with parameters of type StageSceneModel
StageScene(StageSceneModel model, + com.threerings.crowd.data.PlaceConfig config) + +
+          Creates an instance that will obtain data from the supplied scene + model and place config.
+  +

+ + + + + +
+Uses of StageSceneModel in com.threerings.stage.util
+  +

+ + + + + + + + + +
Methods in com.threerings.stage.util with parameters of type StageSceneModel
+static com.threerings.miso.data.ObjectInfo[]StageSceneUtil.getIntersectedObjects(com.threerings.media.tile.TileManager tmgr, + StageSceneModel model, + Rectangle rect) + +
+          Returns an array of the objects intersected by the supplied tile + coordinate rectangle.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/data/class-use/StageSceneObject.html b/apidocs/com/threerings/stage/data/class-use/StageSceneObject.html new file mode 100644 index 00000000..7df9c3f3 --- /dev/null +++ b/apidocs/com/threerings/stage/data/class-use/StageSceneObject.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.stage.data.StageSceneObject (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stage.data.StageSceneObject

+
+No usage of com.threerings.stage.data.StageSceneObject +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/data/package-frame.html b/apidocs/com/threerings/stage/data/package-frame.html new file mode 100644 index 00000000..5ef1019d --- /dev/null +++ b/apidocs/com/threerings/stage/data/package-frame.html @@ -0,0 +1,62 @@ + + + + + + + +com.threerings.stage.data (vilya 1.3 API) + + + + + + + + + + + +com.threerings.stage.data + + + + +
+Interfaces  + +
+StageCodes
+ + + + + + +
+Classes  + +
+DefaultColorUpdate +
+ModifyObjectsUpdate +
+StageLocation +
+StageMisoSceneModel +
+StageOccupantInfo +
+StageScene +
+StageSceneConfig +
+StageSceneMarshaller +
+StageSceneModel +
+StageSceneObject
+ + + + diff --git a/apidocs/com/threerings/stage/data/package-summary.html b/apidocs/com/threerings/stage/data/package-summary.html new file mode 100644 index 00000000..5917fe72 --- /dev/null +++ b/apidocs/com/threerings/stage/data/package-summary.html @@ -0,0 +1,215 @@ + + + + + + + +com.threerings.stage.data (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.stage.data +

+ + + + + + + + + +
+Interface Summary
StageCodesCodes and constants relating to the Stage system.
+  + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Class Summary
DefaultColorUpdateUpdate to change the default colorization for objects in a scene which + do not define their own colorization.
ModifyObjectsUpdateA scene update that is broadcast when objects have been added to or removed + from the scene.
StageLocationContains information on a scene occupant's position and orientation.
StageMisoSceneModelExtends the SparseMisoSceneModel with the necessary interface + to wire it up to the Whirled auxiliary model system.
StageOccupantInfoExtends the standard occupant info with stage specific business.
StageSceneThe implementation of the Stage scene interface.
StageSceneConfigPlace configuration for the main isometric scenes in Stage.
StageSceneMarshallerProvides the implementation of the StageSceneService interface + that marshalls the arguments and delivers the request to the provider + on the server.
StageSceneModelExtends the basic scene model with the notion of a scene type and + incorporates the necessary auxiliary models used by the Stage system.
StageSceneObjectExtends the basic SpotSceneObject with data and services + specific to isometric stage scenes.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/data/package-tree.html b/apidocs/com/threerings/stage/data/package-tree.html new file mode 100644 index 00000000..fdb99b52 --- /dev/null +++ b/apidocs/com/threerings/stage/data/package-tree.html @@ -0,0 +1,200 @@ + + + + + + + +com.threerings.stage.data Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.stage.data +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/data/package-use.html b/apidocs/com/threerings/stage/data/package-use.html new file mode 100644 index 00000000..5f23b75d --- /dev/null +++ b/apidocs/com/threerings/stage/data/package-use.html @@ -0,0 +1,326 @@ + + + + + + + +Uses of Package com.threerings.stage.data (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.stage.data

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Packages that use com.threerings.stage.data
com.threerings.stage.client  
com.threerings.stage.data  
com.threerings.stage.server  
com.threerings.stage.tools.editor  
com.threerings.stage.tools.viewer  
com.threerings.stage.util  
+  +

+ + + + + + + + + + + +
+Classes in com.threerings.stage.data used by com.threerings.stage.client
StageLocation + +
+          Contains information on a scene occupant's position and orientation.
StageScene + +
+          The implementation of the Stage scene interface.
+  +

+ + + + + + + + + + + + + + + + + + + + +
+Classes in com.threerings.stage.data used by com.threerings.stage.data
StageLocation + +
+          Contains information on a scene occupant's position and orientation.
StageMisoSceneModel + +
+          Extends the SparseMisoSceneModel with the necessary interface + to wire it up to the Whirled auxiliary model system.
StageScene + +
+          The implementation of the Stage scene interface.
StageSceneMarshaller + +
+          Provides the implementation of the StageSceneService interface + that marshalls the arguments and delivers the request to the provider + on the server.
StageSceneModel + +
+          Extends the basic scene model with the notion of a scene type and + incorporates the necessary auxiliary models used by the Stage system.
+  +

+ + + + + + + + +
+Classes in com.threerings.stage.data used by com.threerings.stage.server
StageLocation + +
+          Contains information on a scene occupant's position and orientation.
+  +

+ + + + + + + + + + + +
+Classes in com.threerings.stage.data used by com.threerings.stage.tools.editor
StageMisoSceneModel + +
+          Extends the SparseMisoSceneModel with the necessary interface + to wire it up to the Whirled auxiliary model system.
StageScene + +
+          The implementation of the Stage scene interface.
+  +

+ + + + + + + + +
+Classes in com.threerings.stage.data used by com.threerings.stage.tools.viewer
StageScene + +
+          The implementation of the Stage scene interface.
+  +

+ + + + + + + + + + + + + + + + + +
+Classes in com.threerings.stage.data used by com.threerings.stage.util
StageCodes + +
+          Codes and constants relating to the Stage system.
StageLocation + +
+          Contains information on a scene occupant's position and orientation.
StageScene + +
+          The implementation of the Stage scene interface.
StageSceneModel + +
+          Extends the basic scene model with the notion of a scene type and + incorporates the necessary auxiliary models used by the Stage system.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/package-frame.html b/apidocs/com/threerings/stage/package-frame.html new file mode 100644 index 00000000..bdc78a24 --- /dev/null +++ b/apidocs/com/threerings/stage/package-frame.html @@ -0,0 +1,33 @@ + + + + + + + +com.threerings.stage (vilya 1.3 API) + + + + + + + + + + + +com.threerings.stage + + + + +
+Classes  + +
+Log
+ + + + diff --git a/apidocs/com/threerings/stage/package-summary.html b/apidocs/com/threerings/stage/package-summary.html new file mode 100644 index 00000000..e074c5b3 --- /dev/null +++ b/apidocs/com/threerings/stage/package-summary.html @@ -0,0 +1,158 @@ + + + + + + + +com.threerings.stage (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.stage +

+ + + + + + + + + +
+Class Summary
LogContains a reference to the log object used by this package.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/package-tree.html b/apidocs/com/threerings/stage/package-tree.html new file mode 100644 index 00000000..1d6b4db4 --- /dev/null +++ b/apidocs/com/threerings/stage/package-tree.html @@ -0,0 +1,154 @@ + + + + + + + +com.threerings.stage Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.stage +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/package-use.html b/apidocs/com/threerings/stage/package-use.html new file mode 100644 index 00000000..339de54e --- /dev/null +++ b/apidocs/com/threerings/stage/package-use.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Package com.threerings.stage (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.stage

+
+No usage of com.threerings.stage +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/server/StageSceneManager.html b/apidocs/com/threerings/stage/server/StageSceneManager.html new file mode 100644 index 00000000..6924d33f --- /dev/null +++ b/apidocs/com/threerings/stage/server/StageSceneManager.html @@ -0,0 +1,558 @@ + + + + + + + +StageSceneManager (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stage.server +
+Class StageSceneManager

+
+java.lang.Object
+  extended by com.threerings.crowd.server.PlaceManager
+      extended by com.threerings.whirled.server.SceneManager
+          extended by com.threerings.whirled.spot.server.SpotSceneManager
+              extended by com.threerings.stage.server.StageSceneManager
+
+
+
All Implemented Interfaces:
com.threerings.crowd.chat.data.ChatCodes, com.threerings.crowd.chat.server.SpeakHandler.SpeakerValidator, com.threerings.crowd.data.LocationCodes, com.threerings.presents.data.InvocationCodes, com.threerings.presents.dobj.ChangeListener, com.threerings.presents.dobj.MessageListener, com.threerings.presents.server.InvocationProvider, StageSceneProvider, SceneCodes, SpotCodes
+
+
+
+
public class StageSceneManager
extends SpotSceneManager
implements StageSceneProvider
+ + +

+Defines extensions to the basic Stage scene manager specific to displaying isometric "stage" + scenes (these may be indoor, outdoor or aboard a vessel). +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.crowd.server.PlaceManager
com.threerings.crowd.server.PlaceManager.DelegateOp, com.threerings.crowd.server.PlaceManager.MessageHandler
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from interface com.threerings.whirled.spot.data.SpotCodes
CLUSTER_CHAT_TYPE, CLUSTER_FULL, INVALID_LOCATION, LOCATION_OCCUPIED, NO_SUCH_CLUSTER, NO_SUCH_PORTAL
+  + + + + + + + +
Fields inherited from interface com.threerings.crowd.chat.data.ChatCodes
BROADCAST_ACCESS, BROADCAST_MODE, CHAT_ACCESS, CHAT_CHANNEL_NOTIFICATION, CHAT_NOTIFICATION, DEFAULT_IDLE_TIME, DEFAULT_MODE, EMOTE_MODE, IDLE_TIME_KEY, LAST_MODE, PLACE_CHAT_TYPE, SHOUT_MODE, SUCCESS, THINK_MODE, USER_CHAT_TYPE, USER_DISCONNECTED, USER_NOT_ONLINE, XLATE_MODES
+  + + + + + + + +
Fields inherited from interface com.threerings.whirled.data.SceneCodes
SCENE_UPDATE, WHIRLED_GROUP
+  + + + + + + + +
Fields inherited from interface com.threerings.crowd.data.LocationCodes
ALREADY_THERE, MOVE_IN_PROGRESS, NO_SUCH_PLACE
+  + + + + + + + +
Fields inherited from interface com.threerings.presents.data.InvocationCodes
ACCESS_DENIED, E_ACCESS_DENIED, E_INTERNAL_ERROR, GLOBAL_GROUP, INTERNAL_ERROR
+  + + + + + + + + + + +
+Constructor Summary
StageSceneManager() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidaddObject(com.threerings.presents.data.ClientObject caller, + com.threerings.miso.data.ObjectInfo info, + com.threerings.presents.client.InvocationService.ConfirmListener listener) + +
+          Handles a StageSceneService.addObject(com.threerings.miso.data.ObjectInfo, com.threerings.presents.client.InvocationService.ConfirmListener) request.
+ booleanaddObject(com.threerings.miso.data.ObjectInfo info, + boolean killOverlap, + boolean allowOverlap) + +
+          Adds the supplied object to this scene.
+ com.threerings.media.util.AStarPathUtil.TraversalPredgetCanStandPred() + +
+          Returns a traversal predicate for use with StageSceneUtil.findStandingSpot(java.awt.Rectangle, int, com.threerings.media.util.AStarPathUtil.TraversalPred, java.lang.Object, java.awt.Point, int) that + validates whether a player can stand in the searched spots.
+ booleanisPassable(int tx, + int ty) + +
+          Returns true if the specified tile coordinate is passable (the base + tile is passable and it is not in the footprint of an object).
+ booleanmayStandAtLocation(com.threerings.crowd.data.BodyObject source, + StageLocation loc) + +
+          Called by NPPs to determine whether or not they can stand at the + specified location.
+ voidremoveObjects(com.threerings.presents.data.ClientObject caller, + com.threerings.miso.data.ObjectInfo[] info, + com.threerings.presents.client.InvocationService.ConfirmListener listener) + +
+          Handles a StageSceneService.removeObjects(com.threerings.miso.data.ObjectInfo[], com.threerings.presents.client.InvocationService.ConfirmListener) request.
+ voidsetColor(int classId, + int colorId) + +
+          Changes the default colorization for the specified color class.
+  + + + + + + + +
Methods inherited from class com.threerings.whirled.spot.server.SpotSceneManager
clearEnteringBody, mapEnteringBody, mayTraversePortal, moveBodyToDefaultPortal, willTraversePortal
+  + + + + + + + +
Methods inherited from class com.threerings.whirled.server.SceneManager
getLocation, getScene, getUpdates, isPersistent, where
+  + + + + + + + +
Methods inherited from class com.threerings.crowd.server.PlaceManager
addDelegate, applyToDelegates, applyToOccupants, bodyWillEnter, bodyWillLeave, checkPermissions, getConfig, getPlaceObject, init, isValidSpeaker, messageReceived, ratifyBodyEntry, registerMessageHandler, shutdown, startup, toString, updateOccupantInfo
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+StageSceneManager

+
+public StageSceneManager()
+
+
+ + + + + + + + +
+Method Detail
+ +

+getCanStandPred

+
+public com.threerings.media.util.AStarPathUtil.TraversalPred getCanStandPred()
+
+
Returns a traversal predicate for use with StageSceneUtil.findStandingSpot(java.awt.Rectangle, int, com.threerings.media.util.AStarPathUtil.TraversalPred, java.lang.Object, java.awt.Point, int) that + validates whether a player can stand in the searched spots. +

+

+
+
+
+
+
+
+
+ +

+addObject

+
+public boolean addObject(com.threerings.miso.data.ObjectInfo info,
+                         boolean killOverlap,
+                         boolean allowOverlap)
+
+
Adds the supplied object to this scene. A persistent update is generated and broadcast to + all scene occupants. The update is stored in the repository for communication to future + occupants of the scene and then entire complex process of changing our virtual game world is + effected at the simple call of this single method. +

+

+
+
+
+
Parameters:
killOverlap - if true, overlapping object will be removed, and the allowOverlap + argument will be ignored.
allowOverlap - if true, overlapping objects will be allowed but one must be *very* + careful to ensure that they know what they are doing (i.e. the objects have render priorities + that correctly handle the overlap). +
Returns:
true if the object was added, false if the add was rejected because the object + overlaps an existing scene object.
+
+
+
+ +

+setColor

+
+public void setColor(int classId,
+                     int colorId)
+
+
Changes the default colorization for the specified color class. + A persistent update is generated and broadcast to all scene + occupants. The update is stored in the repository for communication + to future occupants of the scene and then entire complex process + of changing our virtual game world is effected at the simple call + of this single method. +

+

+
+
+
+
+
+
+
+ +

+isPassable

+
+public boolean isPassable(int tx,
+                          int ty)
+
+
Returns true if the specified tile coordinate is passable (the base + tile is passable and it is not in the footprint of an object). +

+

+
+
+
+
+
+
+
+ +

+mayStandAtLocation

+
+public boolean mayStandAtLocation(com.threerings.crowd.data.BodyObject source,
+                                  StageLocation loc)
+
+
Called by NPPs to determine whether or not they can stand at the + specified location. +

+

+
+
+
+
+
+
+
+ +

+addObject

+
+public void addObject(com.threerings.presents.data.ClientObject caller,
+                      com.threerings.miso.data.ObjectInfo info,
+                      com.threerings.presents.client.InvocationService.ConfirmListener listener)
+               throws com.threerings.presents.server.InvocationException
+
+
Description copied from interface: StageSceneProvider
+
Handles a StageSceneService.addObject(com.threerings.miso.data.ObjectInfo, com.threerings.presents.client.InvocationService.ConfirmListener) request. +

+

+
Specified by:
addObject in interface StageSceneProvider
+
+
+ +
Throws: +
com.threerings.presents.server.InvocationException
+
+
+
+ +

+removeObjects

+
+public void removeObjects(com.threerings.presents.data.ClientObject caller,
+                          com.threerings.miso.data.ObjectInfo[] info,
+                          com.threerings.presents.client.InvocationService.ConfirmListener listener)
+                   throws com.threerings.presents.server.InvocationException
+
+
Description copied from interface: StageSceneProvider
+
Handles a StageSceneService.removeObjects(com.threerings.miso.data.ObjectInfo[], com.threerings.presents.client.InvocationService.ConfirmListener) request. +

+

+
Specified by:
removeObjects in interface StageSceneProvider
+
+
+ +
Throws: +
com.threerings.presents.server.InvocationException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/server/StageSceneProvider.html b/apidocs/com/threerings/stage/server/StageSceneProvider.html new file mode 100644 index 00000000..dcf8ccc5 --- /dev/null +++ b/apidocs/com/threerings/stage/server/StageSceneProvider.html @@ -0,0 +1,262 @@ + + + + + + + +StageSceneProvider (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stage.server +
+Interface StageSceneProvider

+
+
All Superinterfaces:
com.threerings.presents.server.InvocationProvider
+
+
+
All Known Implementing Classes:
StageSceneManager
+
+
+
+
@Generated(value="com.threerings.presents.tools.GenServiceTask",
+           comments="Derived from StageSceneService.java.")
+public interface StageSceneProvider
extends com.threerings.presents.server.InvocationProvider
+ + +

+Defines the server-side of the StageSceneService. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + +
+Method Summary
+ voidaddObject(com.threerings.presents.data.ClientObject caller, + com.threerings.miso.data.ObjectInfo arg1, + com.threerings.presents.client.InvocationService.ConfirmListener arg2) + +
+          Handles a StageSceneService.addObject(com.threerings.miso.data.ObjectInfo, com.threerings.presents.client.InvocationService.ConfirmListener) request.
+ voidremoveObjects(com.threerings.presents.data.ClientObject caller, + com.threerings.miso.data.ObjectInfo[] arg1, + com.threerings.presents.client.InvocationService.ConfirmListener arg2) + +
+          Handles a StageSceneService.removeObjects(com.threerings.miso.data.ObjectInfo[], com.threerings.presents.client.InvocationService.ConfirmListener) request.
+  +

+ + + + + + + + +
+Method Detail
+ +

+addObject

+
+void addObject(com.threerings.presents.data.ClientObject caller,
+               com.threerings.miso.data.ObjectInfo arg1,
+               com.threerings.presents.client.InvocationService.ConfirmListener arg2)
+               throws com.threerings.presents.server.InvocationException
+
+
Handles a StageSceneService.addObject(com.threerings.miso.data.ObjectInfo, com.threerings.presents.client.InvocationService.ConfirmListener) request. +

+

+
+
+
+ +
Throws: +
com.threerings.presents.server.InvocationException
+
+
+
+ +

+removeObjects

+
+void removeObjects(com.threerings.presents.data.ClientObject caller,
+                   com.threerings.miso.data.ObjectInfo[] arg1,
+                   com.threerings.presents.client.InvocationService.ConfirmListener arg2)
+                   throws com.threerings.presents.server.InvocationException
+
+
Handles a StageSceneService.removeObjects(com.threerings.miso.data.ObjectInfo[], com.threerings.presents.client.InvocationService.ConfirmListener) request. +

+

+
+
+
+ +
Throws: +
com.threerings.presents.server.InvocationException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/server/StageServer.StageModule.html b/apidocs/com/threerings/stage/server/StageServer.StageModule.html new file mode 100644 index 00000000..cc766a76 --- /dev/null +++ b/apidocs/com/threerings/stage/server/StageServer.StageModule.html @@ -0,0 +1,248 @@ + + + + + + + +StageServer.StageModule (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stage.server +
+Class StageServer.StageModule

+
+java.lang.Object
+  extended by com.google.inject.AbstractModule
+      extended by com.threerings.presents.server.PresentsServer.PresentsModule
+          extended by com.threerings.crowd.server.CrowdServer.CrowdModule
+              extended by com.threerings.whirled.server.WhirledServer.WhirledModule
+                  extended by com.threerings.stage.server.StageServer.StageModule
+
+
+
All Implemented Interfaces:
com.google.inject.Module
+
+
+
Enclosing class:
StageServer
+
+
+
+
public static class StageServer.StageModule
extends WhirledServer.WhirledModule
+ + +

+Configures dependencies needed by the Stage services. +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
StageServer.StageModule() + +
+           
+  + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from class com.google.inject.AbstractModule
configure
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+StageServer.StageModule

+
+public StageServer.StageModule()
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/server/StageServer.html b/apidocs/com/threerings/stage/server/StageServer.html new file mode 100644 index 00000000..1c8de9c9 --- /dev/null +++ b/apidocs/com/threerings/stage/server/StageServer.html @@ -0,0 +1,400 @@ + + + + + + + +StageServer (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stage.server +
+Class StageServer

+
+java.lang.Object
+  extended by com.threerings.presents.server.PresentsServer
+      extended by com.threerings.crowd.server.CrowdServer
+          extended by com.threerings.whirled.server.WhirledServer
+              extended by com.threerings.stage.server.StageServer
+
+
+
+
public abstract class StageServer
extends WhirledServer
+ + +

+Extends the Whirled server to provide services needed by the Stage system. +

+ +

+

+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static classStageServer.StageModule + +
+          Configures dependencies needed by the Stage services.
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.whirled.server.WhirledServer
WhirledServer.WhirledModule
+  + + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.crowd.server.CrowdServer
com.threerings.crowd.server.CrowdServer.CrowdModule
+  + + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.presents.server.PresentsServer
com.threerings.presents.server.PresentsServer.PresentsModule, com.threerings.presents.server.PresentsServer.PresentsServerModule
+  + + + + + + + + + + + + + + + +
+Field Summary
+ com.threerings.resource.ResourceManagerrsrcmgr + +
+          A resource manager with which we can load resources in the same manner that the client does + (for resources that are used on both the server and client).
+static com.threerings.media.tile.TileManagertilemgr + +
+          Provides access to our tile repository.
+  + + + + + + + +
Fields inherited from class com.threerings.presents.server.PresentsServer
invmgr, omgr
+  + + + + + + + + + + +
+Constructor Summary
StageServer() + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ voidinit(com.google.inject.Injector injector) + +
+           
+  + + + + + + + +
Methods inherited from class com.threerings.crowd.server.CrowdServer
main
+  + + + + + + + +
Methods inherited from class com.threerings.presents.server.PresentsServer
queueShutdown, run, runServer
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+rsrcmgr

+
+public com.threerings.resource.ResourceManager rsrcmgr
+
+
A resource manager with which we can load resources in the same manner that the client does + (for resources that are used on both the server and client). +

+

+
+
+
+ +

+tilemgr

+
+public static com.threerings.media.tile.TileManager tilemgr
+
+
Provides access to our tile repository. +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+StageServer

+
+public StageServer()
+
+
+ + + + + + + + +
+Method Detail
+ +

+init

+
+public void init(com.google.inject.Injector injector)
+          throws Exception
+
+
+
Overrides:
init in class WhirledServer
+
+
+ +
Throws: +
Exception
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/server/class-use/StageSceneManager.html b/apidocs/com/threerings/stage/server/class-use/StageSceneManager.html new file mode 100644 index 00000000..46fb3846 --- /dev/null +++ b/apidocs/com/threerings/stage/server/class-use/StageSceneManager.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.stage.server.StageSceneManager (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stage.server.StageSceneManager

+
+No usage of com.threerings.stage.server.StageSceneManager +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/server/class-use/StageSceneProvider.html b/apidocs/com/threerings/stage/server/class-use/StageSceneProvider.html new file mode 100644 index 00000000..d5744dd7 --- /dev/null +++ b/apidocs/com/threerings/stage/server/class-use/StageSceneProvider.html @@ -0,0 +1,182 @@ + + + + + + + +Uses of Interface com.threerings.stage.server.StageSceneProvider (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.stage.server.StageSceneProvider

+
+ + + + + + + + + +
+Packages that use StageSceneProvider
com.threerings.stage.server  
+  +

+ + + + + +
+Uses of StageSceneProvider in com.threerings.stage.server
+  +

+ + + + + + + + + +
Classes in com.threerings.stage.server that implement StageSceneProvider
+ classStageSceneManager + +
+          Defines extensions to the basic Stage scene manager specific to displaying isometric "stage" + scenes (these may be indoor, outdoor or aboard a vessel).
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/server/class-use/StageServer.StageModule.html b/apidocs/com/threerings/stage/server/class-use/StageServer.StageModule.html new file mode 100644 index 00000000..9b74e76f --- /dev/null +++ b/apidocs/com/threerings/stage/server/class-use/StageServer.StageModule.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.stage.server.StageServer.StageModule (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stage.server.StageServer.StageModule

+
+No usage of com.threerings.stage.server.StageServer.StageModule +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/server/class-use/StageServer.html b/apidocs/com/threerings/stage/server/class-use/StageServer.html new file mode 100644 index 00000000..981decfd --- /dev/null +++ b/apidocs/com/threerings/stage/server/class-use/StageServer.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.stage.server.StageServer (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stage.server.StageServer

+
+No usage of com.threerings.stage.server.StageServer +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/server/package-frame.html b/apidocs/com/threerings/stage/server/package-frame.html new file mode 100644 index 00000000..4303d92a --- /dev/null +++ b/apidocs/com/threerings/stage/server/package-frame.html @@ -0,0 +1,48 @@ + + + + + + + +com.threerings.stage.server (vilya 1.3 API) + + + + + + + + + + + +com.threerings.stage.server + + + + +
+Interfaces  + +
+StageSceneProvider
+ + + + + + +
+Classes  + +
+StageSceneManager +
+StageServer +
+StageServer.StageModule
+ + + + diff --git a/apidocs/com/threerings/stage/server/package-summary.html b/apidocs/com/threerings/stage/server/package-summary.html new file mode 100644 index 00000000..08d30a60 --- /dev/null +++ b/apidocs/com/threerings/stage/server/package-summary.html @@ -0,0 +1,181 @@ + + + + + + + +com.threerings.stage.server (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.stage.server +

+ + + + + + + + + +
+Interface Summary
StageSceneProviderDefines the server-side of the StageSceneService.
+  + +

+ + + + + + + + + + + + + + + + + +
+Class Summary
StageSceneManagerDefines extensions to the basic Stage scene manager specific to displaying isometric "stage" + scenes (these may be indoor, outdoor or aboard a vessel).
StageServerExtends the Whirled server to provide services needed by the Stage system.
StageServer.StageModuleConfigures dependencies needed by the Stage services.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/server/package-tree.html b/apidocs/com/threerings/stage/server/package-tree.html new file mode 100644 index 00000000..ce13b699 --- /dev/null +++ b/apidocs/com/threerings/stage/server/package-tree.html @@ -0,0 +1,185 @@ + + + + + + + +com.threerings.stage.server Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.stage.server +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/server/package-use.html b/apidocs/com/threerings/stage/server/package-use.html new file mode 100644 index 00000000..2e202537 --- /dev/null +++ b/apidocs/com/threerings/stage/server/package-use.html @@ -0,0 +1,171 @@ + + + + + + + +Uses of Package com.threerings.stage.server (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.stage.server

+
+ + + + + + + + + +
+Packages that use com.threerings.stage.server
com.threerings.stage.server  
+  +

+ + + + + + + + +
+Classes in com.threerings.stage.server used by com.threerings.stage.server
StageSceneProvider + +
+          Defines the server-side of the StageSceneService.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/editor/DirectionButton.html b/apidocs/com/threerings/stage/tools/editor/DirectionButton.html new file mode 100644 index 00000000..71e626c0 --- /dev/null +++ b/apidocs/com/threerings/stage/tools/editor/DirectionButton.html @@ -0,0 +1,496 @@ + + + + + + + +DirectionButton (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stage.tools.editor +
+Class DirectionButton

+
+java.lang.Object
+  extended by java.awt.Component
+      extended by java.awt.Container
+          extended by javax.swing.JComponent
+              extended by javax.swing.AbstractButton
+                  extended by com.threerings.stage.tools.editor.DirectionButton
+
+
+
All Implemented Interfaces:
ImageObserver, ItemSelectable, MenuContainer, Serializable, SwingConstants
+
+
+
+
public class DirectionButton
extends AbstractButton
+ + +

+A button that allows for selection from the compass directions. +

+ +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent
+  + + + + + + + + +
Nested classes/interfaces inherited from class java.awt.Component
Component.BaselineResizeBehavior
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class javax.swing.AbstractButton
BORDER_PAINTED_CHANGED_PROPERTY, CONTENT_AREA_FILLED_CHANGED_PROPERTY, DISABLED_ICON_CHANGED_PROPERTY, DISABLED_SELECTED_ICON_CHANGED_PROPERTY, FOCUS_PAINTED_CHANGED_PROPERTY, HORIZONTAL_ALIGNMENT_CHANGED_PROPERTY, HORIZONTAL_TEXT_POSITION_CHANGED_PROPERTY, ICON_CHANGED_PROPERTY, MARGIN_CHANGED_PROPERTY, MNEMONIC_CHANGED_PROPERTY, MODEL_CHANGED_PROPERTY, PRESSED_ICON_CHANGED_PROPERTY, ROLLOVER_ENABLED_CHANGED_PROPERTY, ROLLOVER_ICON_CHANGED_PROPERTY, ROLLOVER_SELECTED_ICON_CHANGED_PROPERTY, SELECTED_ICON_CHANGED_PROPERTY, TEXT_CHANGED_PROPERTY, VERTICAL_ALIGNMENT_CHANGED_PROPERTY, VERTICAL_TEXT_POSITION_CHANGED_PROPERTY
+  + + + + + + + +
Fields inherited from class javax.swing.JComponent
TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
+  + + + + + + + +
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
+  + + + + + + + +
Fields inherited from interface javax.swing.SwingConstants
BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST
+  + + + + + + + +
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
+  + + + + + + + + + + + + + +
+Constructor Summary
DirectionButton() + +
+          Construct a 41x41 DirectionButton.
DirectionButton(int preferredDiameter) + +
+          Construct a DirectionButton with the specified preferred diameter.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ intgetDirection() + +
+          Get the direction that is currently selected.
+ DimensiongetPreferredSize() + +
+           
+ voidpaintComponent(Graphics g) + +
+          Paint this component and the selected direction, + dimmed if we're inactive.
+ voidsetDirection(int direction) + +
+          Set the currently displayed direction
+ voidsetSize(Dimension d) + +
+           
+  + + + + + + + +
Methods inherited from class javax.swing.AbstractButton
addActionListener, addChangeListener, addItemListener, doClick, doClick, getAction, getActionCommand, getActionListeners, getChangeListeners, getDisabledIcon, getDisabledSelectedIcon, getDisplayedMnemonicIndex, getHideActionText, getHorizontalAlignment, getHorizontalTextPosition, getIcon, getIconTextGap, getItemListeners, getLabel, getMargin, getMnemonic, getModel, getMultiClickThreshhold, getPressedIcon, getRolloverIcon, getRolloverSelectedIcon, getSelectedIcon, getSelectedObjects, getText, getUI, getVerticalAlignment, getVerticalTextPosition, imageUpdate, isBorderPainted, isContentAreaFilled, isFocusPainted, isRolloverEnabled, isSelected, removeActionListener, removeChangeListener, removeItemListener, removeNotify, setAction, setActionCommand, setBorderPainted, setContentAreaFilled, setDisabledIcon, setDisabledSelectedIcon, setDisplayedMnemonicIndex, setEnabled, setFocusPainted, setHideActionText, setHorizontalAlignment, setHorizontalTextPosition, setIcon, setIconTextGap, setLabel, setLayout, setMargin, setMnemonic, setMnemonic, setModel, setMultiClickThreshhold, setPressedIcon, setRolloverEnabled, setRolloverIcon, setRolloverSelectedIcon, setSelected, setSelectedIcon, setText, setUI, setVerticalAlignment, setVerticalTextPosition, updateUI
+  + + + + + + + +
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
+  + + + + + + + +
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, transferFocusBackward, transferFocusDownCycle, validate
+  + + + + + + + +
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+DirectionButton

+
+public DirectionButton()
+
+
Construct a 41x41 DirectionButton. +

+

+
+ +

+DirectionButton

+
+public DirectionButton(int preferredDiameter)
+
+
Construct a DirectionButton with the specified preferred diameter. +

+

+ + + + + + + + +
+Method Detail
+ +

+paintComponent

+
+public void paintComponent(Graphics g)
+
+
Paint this component and the selected direction, + dimmed if we're inactive. +

+

+
Overrides:
paintComponent in class JComponent
+
+
+
+
+
+
+ +

+getDirection

+
+public int getDirection()
+
+
Get the direction that is currently selected. +

+

+
+
+
+
+ +

+setDirection

+
+public void setDirection(int direction)
+
+
Set the currently displayed direction +

+

+
+
+
+
+ +

+setSize

+
+public void setSize(Dimension d)
+
+
+
Overrides:
setSize in class Component
+
+
+
+
+
+
+ +

+getPreferredSize

+
+public Dimension getPreferredSize()
+
+
+
Overrides:
getPreferredSize in class JComponent
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/editor/EditorApp.html b/apidocs/com/threerings/stage/tools/editor/EditorApp.html new file mode 100644 index 00000000..03f72bc3 --- /dev/null +++ b/apidocs/com/threerings/stage/tools/editor/EditorApp.html @@ -0,0 +1,345 @@ + + + + + + + +EditorApp (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stage.tools.editor +
+Class EditorApp

+
+java.lang.Object
+  extended by com.threerings.stage.tools.editor.EditorApp
+
+
+
All Implemented Interfaces:
Runnable
+
+
+
+
public class EditorApp
extends Object
implements Runnable
+ + +

+A scene editor application that provides facilities for viewing, editing, and saving the scene + templates that comprise a game. +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
EditorApp(String[] args) + +
+          Construct and initialize the EditorApp object.
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidfinishInit(String target) + +
+           
+static StringlocalDataDir(String subdir) + +
+          Given a subdirectory name (that should correspond to the calling service), returns a file + path that can be used to store local data.
+static voidmain(String[] args) + +
+          Instantiate the application object and start it running.
+ voidrun() + +
+          Run the application.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+EditorApp

+
+public EditorApp(String[] args)
+          throws IOException
+
+
Construct and initialize the EditorApp object. +

+

+ +
Throws: +
IOException
+
+ + + + + + + + +
+Method Detail
+ +

+finishInit

+
+public void finishInit(String target)
+
+
+
+
+
+
+
+
+
+ +

+localDataDir

+
+public static String localDataDir(String subdir)
+
+
Given a subdirectory name (that should correspond to the calling service), returns a file + path that can be used to store local data. +

+

+
+
+
+
+
+
+
+ +

+run

+
+public void run()
+
+
Run the application. +

+

+
Specified by:
run in interface Runnable
+
+
+
+
+
+
+ +

+main

+
+public static void main(String[] args)
+
+
Instantiate the application object and start it running. +

+

+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/editor/EditorConfig.html b/apidocs/com/threerings/stage/tools/editor/EditorConfig.html new file mode 100644 index 00000000..c6fb1243 --- /dev/null +++ b/apidocs/com/threerings/stage/tools/editor/EditorConfig.html @@ -0,0 +1,318 @@ + + + + + + + +EditorConfig (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stage.tools.editor +
+Class EditorConfig

+
+java.lang.Object
+  extended by com.threerings.stage.tools.editor.EditorConfig
+
+
+
+
public class EditorConfig
extends Object
+ + +

+Provides access to configuration data for the editor. +

+ +

+

+ +

+ + + + + + + + + + + +
+Field Summary
+static PrefsConfigconfig + +
+          Provides access to config data for this package.
+  + + + + + + + + + + +
+Constructor Summary
EditorConfig() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+static StringgetTestTileDirectory() + +
+          Accessor method for getting the test tile directory.
+static voidsetTestTileDirectory(String newvalue) + +
+          Accessor method for setting the test tile directory.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+config

+
+public static PrefsConfig config
+
+
Provides access to config data for this package. +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+EditorConfig

+
+public EditorConfig()
+
+
+ + + + + + + + +
+Method Detail
+ +

+getTestTileDirectory

+
+public static String getTestTileDirectory()
+
+
Accessor method for getting the test tile directory. +

+

+
+
+
+
+ +

+setTestTileDirectory

+
+public static void setTestTileDirectory(String newvalue)
+
+
Accessor method for setting the test tile directory. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/editor/EditorDialog.html b/apidocs/com/threerings/stage/tools/editor/EditorDialog.html new file mode 100644 index 00000000..b4c64807 --- /dev/null +++ b/apidocs/com/threerings/stage/tools/editor/EditorDialog.html @@ -0,0 +1,475 @@ + + + + + + + +EditorDialog (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stage.tools.editor +
+Class EditorDialog

+
+java.lang.Object
+  extended by java.awt.Component
+      extended by java.awt.Container
+          extended by javax.swing.JComponent
+              extended by javax.swing.JInternalFrame
+                  extended by com.threerings.stage.tools.editor.EditorDialog
+
+
+
All Implemented Interfaces:
ActionListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, RootPaneContainer, WindowConstants
+
+
+
Direct Known Subclasses:
ObjectEditorDialog, PortalDialog
+
+
+
+
public abstract class EditorDialog
extends JInternalFrame
implements ActionListener
+ + +

+Basic ok cancel dialog for use by editor components. +

+ +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class javax.swing.JInternalFrame
JInternalFrame.JDesktopIcon
+  + + + + + + + + +
Nested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent
+  + + + + + + + + +
Nested classes/interfaces inherited from class java.awt.Component
Component.BaselineResizeBehavior
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class javax.swing.JInternalFrame
CONTENT_PANE_PROPERTY, FRAME_ICON_PROPERTY, GLASS_PANE_PROPERTY, IS_CLOSED_PROPERTY, IS_ICON_PROPERTY, IS_MAXIMUM_PROPERTY, IS_SELECTED_PROPERTY, LAYERED_PANE_PROPERTY, MENU_BAR_PROPERTY, ROOT_PANE_PROPERTY, TITLE_PROPERTY
+  + + + + + + + +
Fields inherited from class javax.swing.JComponent
TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
+  + + + + + + + +
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
+  + + + + + + + +
Fields inherited from interface javax.swing.WindowConstants
DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE
+  + + + + + + + +
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
+  + + + + + + + + + + +
+Constructor Summary
EditorDialog(String title, + EditorContext ctx, + EditorScenePanel panel) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+abstract  voidaccepted() + +
+          Called when ok is clicked.
+ voidactionPerformed(ActionEvent e) + +
+           
+abstract  voidaddComponents(JComponent dialogBody) + +
+           
+ voidcancelled() + +
+          Called when cancel is clicked.
+  + + + + + + + +
Methods inherited from class javax.swing.JInternalFrame
addInternalFrameListener, dispose, doDefaultCloseAction, getAccessibleContext, getContentPane, getDefaultCloseOperation, getDesktopIcon, getDesktopPane, getFocusCycleRootAncestor, getFocusOwner, getFrameIcon, getGlassPane, getInternalFrameListeners, getJMenuBar, getLastCursor, getLayer, getLayeredPane, getMenuBar, getMostRecentFocusOwner, getNormalBounds, getRootPane, getTitle, getUI, getUIClassID, getWarningString, hide, isClosable, isClosed, isFocusCycleRoot, isIcon, isIconifiable, isMaximizable, isMaximum, isResizable, isSelected, moveToBack, moveToFront, pack, remove, removeInternalFrameListener, reshape, restoreSubcomponentFocus, setClosable, setClosed, setContentPane, setCursor, setDefaultCloseOperation, setDesktopIcon, setFocusCycleRoot, setFrameIcon, setGlassPane, setIcon, setIconifiable, setJMenuBar, setLayer, setLayer, setLayeredPane, setLayout, setMaximizable, setMaximum, setMenuBar, setNormalBounds, setResizable, setSelected, setTitle, setUI, show, toBack, toFront, updateUI
+  + + + + + + + +
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
+  + + + + + + + +
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, transferFocusBackward, transferFocusDownCycle, validate
+  + + + + + + + +
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, size, toString, transferFocus, transferFocusUpCycle
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+EditorDialog

+
+public EditorDialog(String title,
+                    EditorContext ctx,
+                    EditorScenePanel panel)
+
+
+ + + + + + + + +
+Method Detail
+ +

+addComponents

+
+public abstract void addComponents(JComponent dialogBody)
+
+
+
+
+
+
+
+
+
+ +

+actionPerformed

+
+public void actionPerformed(ActionEvent e)
+
+
+
Specified by:
actionPerformed in interface ActionListener
+
+
+
+
+
+
+ +

+accepted

+
+public abstract void accepted()
+
+
Called when ok is clicked. +

+

+
+
+
+
+
+
+
+ +

+cancelled

+
+public void cancelled()
+
+
Called when cancel is clicked. +

+

+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/editor/EditorFrame.html b/apidocs/com/threerings/stage/tools/editor/EditorFrame.html new file mode 100644 index 00000000..0727ffa6 --- /dev/null +++ b/apidocs/com/threerings/stage/tools/editor/EditorFrame.html @@ -0,0 +1,779 @@ + + + + + + + +EditorFrame (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stage.tools.editor +
+Class EditorFrame

+
+java.lang.Object
+  extended by java.awt.Component
+      extended by java.awt.Container
+          extended by java.awt.Window
+              extended by java.awt.Frame
+                  extended by javax.swing.JFrame
+                      extended by com.threerings.media.ManagedJFrame
+                          extended by com.threerings.stage.tools.editor.EditorFrame
+
+
+
All Implemented Interfaces:
com.threerings.media.FrameManager.ManagedRoot, EditorScenePanel.SceneModelListener, ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants
+
+
+
+
public class EditorFrame
extends com.threerings.media.ManagedJFrame
implements EditorScenePanel.SceneModelListener
+ + +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class java.awt.Component
Component.BaselineResizeBehavior
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class javax.swing.JFrame
EXIT_ON_CLOSE
+  + + + + + + + +
Fields inherited from class java.awt.Frame
CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR
+  + + + + + + + +
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
+  + + + + + + + +
Fields inherited from interface javax.swing.WindowConstants
DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE
+  + + + + + + + +
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
+  + + + + + + + + + + +
+Constructor Summary
EditorFrame(StageSceneWriter writer) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidcreateMenuBar() + +
+          Create the menu bar and menu items and add them to the frame.
+ voidhandleNew(ActionEvent evt) + +
+          Creates a blank scene and configures the editor to begin editing + it.
+ voidhandleOpen(ActionEvent evt) + +
+          Presents the user with an open file dialog and loads the scenes + from the selected file.
+ voidhandlePreferences(ActionEvent evt) + +
+          Handles a request to open the preferences dialog.
+ voidhandleQuit(ActionEvent evt) + +
+          Handles a request to quit.
+ voidhandleSave(ActionEvent evt) + +
+          Save the scenes to the file they were last associated with.
+ voidhandleSaveAs(ActionEvent evt) + +
+          Present the user with a save file dialog and save the scenes to + the selected file.
+ voidhandleSetDefBase(ActionEvent evt) + +
+          Make the currently selected base tile into the scene's default + tile.
+ voidhandleTestTiles(ActionEvent evt) + +
+          Handles a request to reload the test tiles.
+ voidinit(EditorContext ctx, + String target) + +
+           
+ voidopenScene(String path) + +
+          Loads the scene from the specified path into the editor and displays an error dialog if it + fails.
+ voidredo(ActionEvent evt) + +
+           
+ voidsetMisoSceneModel(StageMisoSceneModel model) + +
+           
+ voidundo(ActionEvent evt) + +
+           
+ voidupdateMiniView(ActionEvent evt) + +
+          Update the mini view in the scrollbox.
+ voidupdateTileInfo() + +
+           
+  + + + + + + + +
Methods inherited from class com.threerings.media.ManagedJFrame
getFrameManager, getWindow, init, paint, update
+  + + + + + + + +
Methods inherited from class javax.swing.JFrame
getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setTransferHandler
+  + + + + + + + +
Methods inherited from class java.awt.Frame
addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setResizable, setState, setTitle, setUndecorated
+  + + + + + + + +
Methods inherited from class java.awt.Window
addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOwnedWindows, getOwner, getOwnerlessWindows, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setVisible, show, toBack, toFront
+  + + + + + + + +
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusBackward, transferFocusDownCycle, validate
+  + + + + + + + +
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, dispatchEvent, enable, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocusInWindow, resize, resize, setBackground, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusUpCycle
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  + + + + + + + +
Methods inherited from interface com.threerings.media.FrameManager.ManagedRoot
getRootPane
+  + + + + + + + +
Methods inherited from interface java.awt.MenuContainer
getFont, postEvent
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+EditorFrame

+
+public EditorFrame(StageSceneWriter writer)
+
+
+ + + + + + + + +
+Method Detail
+ +

+init

+
+public void init(EditorContext ctx,
+                 String target)
+
+
+
+
+
+
+
+
+
+ +

+createMenuBar

+
+public void createMenuBar()
+
+
Create the menu bar and menu items and add them to the frame. +

+

+
+
+
+
+
+
+
+ +

+setMisoSceneModel

+
+public void setMisoSceneModel(StageMisoSceneModel model)
+
+
+
Specified by:
setMisoSceneModel in interface EditorScenePanel.SceneModelListener
+
+
+
+
+
+
+ +

+handleNew

+
+public void handleNew(ActionEvent evt)
+
+
Creates a blank scene and configures the editor to begin editing + it. Eventually this should make sure the user has a chance to save + any scene for which editing is currently in progress. +

+

+
+
+
+
+
+
+
+ +

+handleOpen

+
+public void handleOpen(ActionEvent evt)
+
+
Presents the user with an open file dialog and loads the scenes + from the selected file. +

+

+
+
+
+
+
+
+
+ +

+openScene

+
+public void openScene(String path)
+
+
Loads the scene from the specified path into the editor and displays an error dialog if it + fails. +

+

+
+
+
+
+
+
+
+ +

+handleSave

+
+public void handleSave(ActionEvent evt)
+
+
Save the scenes to the file they were last associated with. +

+

+
+
+
+
+
+
+
+ +

+handleSaveAs

+
+public void handleSaveAs(ActionEvent evt)
+
+
Present the user with a save file dialog and save the scenes to + the selected file. +

+

+
+
+
+
+
+
+
+ +

+handleQuit

+
+public void handleQuit(ActionEvent evt)
+
+
Handles a request to quit. Presently this just quits, but + eventually it should give the user the chance to save any edits in + progress. +

+

+
+
+
+
+
+
+
+ +

+handleTestTiles

+
+public void handleTestTiles(ActionEvent evt)
+
+
Handles a request to reload the test tiles. +

+

+
+
+
+
+
+
+
+ +

+updateMiniView

+
+public void updateMiniView(ActionEvent evt)
+
+
Update the mini view in the scrollbox. +

+

+
+
+
+
+
+
+
+ +

+undo

+
+public void undo(ActionEvent evt)
+
+
+
+
+
+
+
+
+
+ +

+redo

+
+public void redo(ActionEvent evt)
+
+
+
+
+
+
+
+
+
+ +

+updateTileInfo

+
+public void updateTileInfo()
+
+
+
+
+
+
+
+
+
+ +

+handlePreferences

+
+public void handlePreferences(ActionEvent evt)
+
+
Handles a request to open the preferences dialog. +

+

+
+
+
+
+
+
+
+ +

+handleSetDefBase

+
+public void handleSetDefBase(ActionEvent evt)
+
+
Make the currently selected base tile into the scene's default + tile. +

+

+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/editor/EditorModel.html b/apidocs/com/threerings/stage/tools/editor/EditorModel.html new file mode 100644 index 00000000..059d9ede --- /dev/null +++ b/apidocs/com/threerings/stage/tools/editor/EditorModel.html @@ -0,0 +1,801 @@ + + + + + + + +EditorModel (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stage.tools.editor +
+Class EditorModel

+
+java.lang.Object
+  extended by com.threerings.stage.tools.editor.EditorModel
+
+
+
+
public class EditorModel
extends Object
+ + +

+The EditorModel class provides a holding place for storing, + modifying and retrieving data that is shared across the Editor + application and its myriad UI components. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static intACTION_EDIT_TILE + +
+           
+static intACTION_PLACE_PORTAL + +
+           
+static intACTION_PLACE_TILE + +
+          Action mode constants.
+static intBASE_LAYER + +
+          Miso layer constants.
+static String[]CMD_ACTIONS + +
+          String translations for action identifiers.
+static String[]LAYER_NAMES + +
+           
+static intNUM_ACTIONS + +
+          The number of actions.
+static intOBJECT_LAYER + +
+           
+static String[]TIP_ACTIONS + +
+          Prose descriptions of actions suitable for tool tip display.
+  + + + + + + + + + + +
+Constructor Summary
EditorModel(com.threerings.media.tile.TileManager tilemgr) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidaddListener(EditorModelListener l) + +
+          Add an editor model listener.
+ voidclearTile() + +
+          Marks the currently selected tile as invalid such that editing + when no tiles are available can be properly effected.
+ intgetActionMode() + +
+          Returns the current editor action mode.
+ intgetFQTileId() + +
+          Returns the fully qualified tile id of the currently selected tile.
+ intgetLayerIndex() + +
+          Returns the current scene layer index undergoing edit.
+ intgetObjectGripDirection() + +
+          Gets the direction in which we should grip objects.
+ com.threerings.media.tile.TilegetTile() + +
+          Returns the currently selected tile for placement within the + scene.
+ intgetTileId() + +
+          Returns the currently selected tile id within the selected tile + set.
+ com.threerings.media.tile.TileSetgetTileSet() + +
+          Returns the currently selected tile set.
+ intgetTileSetId() + +
+          Returns the currently selected tile set id.
+ booleanisTileValid() + +
+          Returns whether the currently selected tile is valid.
+ voidsetActionMode(String cmd) + +
+          Sets the editor action mode.
+ voidsetLayerIndex(int lnum) + +
+          Sets the scene layer index undergoing edit.
+ voidsetObjectGripDirection(int direction) + +
+          Sets the direction in which we should grip objects.
+ voidsetTile(com.threerings.media.tile.TileSet set, + int tileSetId, + int tileIndex) + +
+          Sets the selected tile for placement within the scene.
+ voidsetTileId(int tileIndex) + +
+          Sets the tile id of the tile selected for placement within the + scene.
+ StringtoString() + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+ACTION_PLACE_TILE

+
+public static final int ACTION_PLACE_TILE
+
+
Action mode constants. +

+

+
See Also:
Constant Field Values
+
+
+ +

+ACTION_EDIT_TILE

+
+public static final int ACTION_EDIT_TILE
+
+
+
See Also:
Constant Field Values
+
+
+ +

+ACTION_PLACE_PORTAL

+
+public static final int ACTION_PLACE_PORTAL
+
+
+
See Also:
Constant Field Values
+
+
+ +

+NUM_ACTIONS

+
+public static final int NUM_ACTIONS
+
+
The number of actions. +

+

+
See Also:
Constant Field Values
+
+
+ +

+BASE_LAYER

+
+public static final int BASE_LAYER
+
+
Miso layer constants. +

+

+
See Also:
Constant Field Values
+
+
+ +

+OBJECT_LAYER

+
+public static final int OBJECT_LAYER
+
+
+
See Also:
Constant Field Values
+
+
+ +

+LAYER_NAMES

+
+public static final String[] LAYER_NAMES
+
+
+
+
+
+ +

+TIP_ACTIONS

+
+public static final String[] TIP_ACTIONS
+
+
Prose descriptions of actions suitable for tool tip display. +

+

+
+
+
+ +

+CMD_ACTIONS

+
+public static final String[] CMD_ACTIONS
+
+
String translations for action identifiers. +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+EditorModel

+
+public EditorModel(com.threerings.media.tile.TileManager tilemgr)
+
+
+ + + + + + + + +
+Method Detail
+ +

+addListener

+
+public void addListener(EditorModelListener l)
+
+
Add an editor model listener. +

+

+
Parameters:
l - the listener.
+
+
+
+ +

+isTileValid

+
+public boolean isTileValid()
+
+
Returns whether the currently selected tile is valid. +

+

+
+
+
+
+ +

+getActionMode

+
+public int getActionMode()
+
+
Returns the current editor action mode. +

+

+
+
+
+
+ +

+getLayerIndex

+
+public int getLayerIndex()
+
+
Returns the current scene layer index undergoing edit. +

+

+
+
+
+
+ +

+getTileSet

+
+public com.threerings.media.tile.TileSet getTileSet()
+
+
Returns the currently selected tile set. +

+

+
+
+
+
+ +

+getTileSetId

+
+public int getTileSetId()
+
+
Returns the currently selected tile set id. +

+

+
+
+
+
+ +

+getTileId

+
+public int getTileId()
+
+
Returns the currently selected tile id within the selected tile + set. +

+

+
+
+
+
+ +

+getTile

+
+public com.threerings.media.tile.Tile getTile()
+
+
Returns the currently selected tile for placement within the + scene. +

+

+
+
+
+
+ +

+getFQTileId

+
+public int getFQTileId()
+
+
Returns the fully qualified tile id of the currently selected tile. +

+

+
+
+
+
+ +

+clearTile

+
+public void clearTile()
+
+
Marks the currently selected tile as invalid such that editing + when no tiles are available can be properly effected. +

+

+
+
+
+
+ +

+setActionMode

+
+public void setActionMode(String cmd)
+
+
Sets the editor action mode. The specified mode should be one + of CMD_ACTIONS. +

+

+
+
+
+
+ +

+setLayerIndex

+
+public void setLayerIndex(int lnum)
+
+
Sets the scene layer index undergoing edit. +

+

+
+
+
+
+ +

+setTile

+
+public void setTile(com.threerings.media.tile.TileSet set,
+                    int tileSetId,
+                    int tileIndex)
+
+
Sets the selected tile for placement within the scene. +

+

+
+
+
+
+ +

+setTileId

+
+public void setTileId(int tileIndex)
+
+
Sets the tile id of the tile selected for placement within the + scene. +

+

+
+
+
+
+ +

+setObjectGripDirection

+
+public void setObjectGripDirection(int direction)
+
+
Sets the direction in which we should grip objects. +

+

+
+
+
+
+ +

+getObjectGripDirection

+
+public int getObjectGripDirection()
+
+
Gets the direction in which we should grip objects. +

+

+
+
+
+
+ +

+toString

+
+public String toString()
+
+
+
Overrides:
toString in class Object
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/editor/EditorModelListener.html b/apidocs/com/threerings/stage/tools/editor/EditorModelListener.html new file mode 100644 index 00000000..93c9cc58 --- /dev/null +++ b/apidocs/com/threerings/stage/tools/editor/EditorModelListener.html @@ -0,0 +1,294 @@ + + + + + + + +EditorModelListener (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stage.tools.editor +
+Interface EditorModelListener

+
+
All Known Implementing Classes:
EditorScenePanel, TileInfoPanel
+
+
+
+
public interface EditorModelListener
+ + +

+The editor model listener interface should be implemented by + classes that would like to be notified when the editor model is + changed. +

+ +

+

+
See Also:
EditorModel
+
+ +

+ + + + + + + + + + + + + + + + + + + +
+Field Summary
+static intACTION_MODE_CHANGED + +
+          Notification event constants.
+static intLAYER_INDEX_CHANGED + +
+           
+static intTILE_CHANGED + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ voidmodelChanged(int event) + +
+          Called by the EditorModel when the model is changed.
+  +

+ + + + + + + + +
+Field Detail
+ +

+ACTION_MODE_CHANGED

+
+static final int ACTION_MODE_CHANGED
+
+
Notification event constants. +

+

+
See Also:
Constant Field Values
+
+
+ +

+LAYER_INDEX_CHANGED

+
+static final int LAYER_INDEX_CHANGED
+
+
+
See Also:
Constant Field Values
+
+
+ +

+TILE_CHANGED

+
+static final int TILE_CHANGED
+
+
+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Method Detail
+ +

+modelChanged

+
+void modelChanged(int event)
+
+
Called by the EditorModel when the model is changed. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/editor/EditorScenePanel.SceneModelListener.html b/apidocs/com/threerings/stage/tools/editor/EditorScenePanel.SceneModelListener.html new file mode 100644 index 00000000..1a77154a --- /dev/null +++ b/apidocs/com/threerings/stage/tools/editor/EditorScenePanel.SceneModelListener.html @@ -0,0 +1,213 @@ + + + + + + + +EditorScenePanel.SceneModelListener (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stage.tools.editor +
+Interface EditorScenePanel.SceneModelListener

+
+
All Known Implementing Classes:
EditorFrame
+
+
+
Enclosing class:
EditorScenePanel
+
+
+
+
public static interface EditorScenePanel.SceneModelListener
+ + +

+

+ +

+ + + + + + + + + + + + +
+Method Summary
+ voidsetMisoSceneModel(StageMisoSceneModel sceneModel) + +
+           
+  +

+ + + + + + + + +
+Method Detail
+ +

+setMisoSceneModel

+
+void setMisoSceneModel(StageMisoSceneModel sceneModel)
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/editor/EditorScenePanel.html b/apidocs/com/threerings/stage/tools/editor/EditorScenePanel.html new file mode 100644 index 00000000..65aa54a3 --- /dev/null +++ b/apidocs/com/threerings/stage/tools/editor/EditorScenePanel.html @@ -0,0 +1,1224 @@ + + + + + + + +EditorScenePanel (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stage.tools.editor +
+Class EditorScenePanel

+
+java.lang.Object
+  extended by java.awt.Component
+      extended by java.awt.Container
+          extended by javax.swing.JComponent
+              extended by com.threerings.media.MediaPanel
+                  extended by com.threerings.media.VirtualMediaPanel
+                      extended by com.threerings.miso.client.MisoScenePanel
+                          extended by com.threerings.stage.client.StageScenePanel
+                              extended by com.threerings.stage.tools.editor.EditorScenePanel
+
+
+
All Implemented Interfaces:
ControllerProvider, RadialMenu.Host, com.threerings.crowd.client.PlaceView, com.threerings.media.FrameParticipant, com.threerings.media.MediaConstants, com.threerings.media.MediaHost, com.threerings.media.util.AStarPathUtil.TraversalPred, EditorModelListener, KeyListener, MouseListener, MouseMotionListener, ImageObserver, MenuContainer, Serializable, EventListener, ChangeListener
+
+
+
+
public class EditorScenePanel
extends StageScenePanel
implements EditorModelListener, ChangeListener
+ + +

+Displays the scene view and handles UI events on the scene. Various actions may be performed on + the scene depending on the selected action mode, including placing and deleting tiles or + locations and creating portals. +

+ +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static interfaceEditorScenePanel.SceneModelListener + +
+           
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.media.MediaPanel
com.threerings.media.MediaPanel.Obscurer
+  + + + + + + + + +
Nested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent
+  + + + + + + + + +
Nested classes/interfaces inherited from class java.awt.Component
Component.BaselineResizeBehavior
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class com.threerings.stage.client.StageScenePanel
CLUSTER_CLICKED, LOCATION_CLICKED, SHOW_CLUSTERS, SHOW_PLOTS
+  + + + + + + + +
Fields inherited from class com.threerings.miso.client.MisoScenePanel
SHOW_TIPS
+  + + + + + + + +
Fields inherited from class com.threerings.media.VirtualMediaPanel
CENTER_ON_PATHABLE, ENCLOSE_PATHABLE, TRACK_PATHABLE
+  + + + + + + + +
Fields inherited from class javax.swing.JComponent
TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
+  + + + + + + + +
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
+  + + + + + + + +
Fields inherited from interface com.threerings.stage.tools.editor.EditorModelListener
ACTION_MODE_CHANGED, LAYER_INDEX_CHANGED, TILE_CHANGED
+  + + + + + + + +
Fields inherited from interface com.threerings.media.MediaConstants
ALL, BACK, FRONT
+  + + + + + + + +
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
+  + + + + + + + + + + +
+Constructor Summary
EditorScenePanel(EditorContext ctx, + JFrame frame, + EditorModel model, + EditorScenePanel.SceneModelListener sceneListener) + +
+          Constructs the editor scene view panel.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ com.threerings.miso.data.ObjectInfoaddObject(com.threerings.miso.data.ObjectInfo oinfo) + +
+          Adds the given object to the scene.
+ com.threerings.miso.data.ObjectInfoaddObject(com.threerings.media.tile.ObjectTile tile, + int fqTileId, + int x, + int y) + +
+          Sets an object tile at the specified position in the scene (in tile coordinates).
+ RectangleclearTileSelectRegion(int x, + int y) + +
+          Clear and return the drag rectangle for selecting a rectangular + region.
+ booleandeleteObject(com.threerings.miso.data.ObjectInfo info) + +
+          Delete the given object from the scene.
+ booleandeleteObject(com.threerings.miso.client.SceneObject scobj) + +
+          Deletes the object tile at the specified tile coordinates.
+ voiddeletePortal(int x, + int y) + +
+          Deletes the portal at the specified full coordinates.
+ voidenableCoordHighlighting(boolean enabled) + +
+          Enables or disables highlighting of the tile over which the mouse + is currently positioned.
+ PortalgetEntrance() + +
+          Returns the portal that serves as the default entrance to this + scene or null if no default is set.
+ BoundedRangeModelgetHorizModel() + +
+          Returns a range model that controls the scrollability of the scene + in the horizontal direction.
+ BoundedRangeModelgetVertModel() + +
+          Returns a range model that controls the scrollability of the scene + in the vertical direction.
+ voidkeyPressed(KeyEvent e) + +
+           
+ voidkeyReleased(KeyEvent e) + +
+           
+ voidmodelChanged(int event) + +
+          Called by the EditorModel when the model is changed.
+ voidmouseDragged(MouseEvent e) + +
+           
+ voidmouseExited(MouseEvent e) + +
+           
+ voidmouseMoved(MouseEvent e) + +
+           
+ voidmousePressed(MouseEvent event) + +
+           
+ voidmouseReleased(MouseEvent e) + +
+           
+ voidredo() + +
+           
+ booleansetBaseTile(int fqTileId, + int x, + int y) + +
+          Sets a base tile at the specified position in the scene (in tile + coordinates).
+ voidsetBaseTiles(Rectangle r, + int setId, + int tileCount) + +
+          Set a region of tiles to a random selection from the supplied tileset.
+ voidsetBounds(int x, + int y, + int width, + int height) + +
+           
+ voidsetEditorScrollBox(EditorScrollBox box) + +
+          Set the scroll box that tracks our view.
+ voidsetEntrance(Portal port) + +
+          Makes the specified portal the default entrance to this scene.
+ voidsetPlacingTile(com.threerings.media.tile.Tile tile) + +
+          Sets the tile that is currently being placed.
+ voidsetSceneModel(com.threerings.miso.data.MisoSceneModel model) + +
+           
+ voidsetTileSelectRegion(Point drag) + +
+          Sets the start (in tile coords) of a mouse drag when placing + a rectangular area of base tiles.
+ voidstateChanged(ChangeEvent e) + +
+           
+ voidundo() + +
+           
+ booleanupdateCoordPos(int x, + int y, + Point cpos) + +
+          Updates the coordinate position and returns true if it has changed.
+ voidupdateDefaultTileSet(int tileSetId) + +
+          Updates the default tileset in the currently edited scene.
+  + + + + + + + +
Methods inherited from class com.threerings.stage.client.StageScenePanel
didLeavePlace, getColorizer, getController, getPortal, getScene, keyTyped, removeCluster, sceneUpdated, setScene, updateCluster, willEnterPlace
+  + + + + + + + +
Methods inherited from class com.threerings.miso.client.MisoScenePanel
addNotify, canTraverse, centerOnTile, checkShowFlag, clearRadialMenu, computeIndicators, computeInfluentialBounds, enumerateResolvedBlocks, getBlock, getComponent, getFullCoords, getHoverCoords, getHoverObject, getPath, getSceneMetrics, getSceneModel, getScreenCoords, getTileCoords, getViewBounds, menuDeactivated, mouseClicked, mouseEntered, paint, pressObject, refreshScene, removeNotify, repaintRect, reportMemoryUsage, setShowFlags
+  + + + + + + + +
Methods inherited from class com.threerings.media.VirtualMediaPanel
addViewTracker, clearPathable, doLayout, removeViewTracker, setBackground, setFollowsPathable, setViewLocation
+  + + + + + + + +
Methods inherited from class com.threerings.media.MediaPanel
abortAnimation, addAnimation, addObscurer, addSprite, clearAnimations, clearSprites, createGraphics, getAnimationManager, getRegionManager, getSpriteManager, getTimeStamp, isManaged, isManaged, needsPaint, removeObscurer, removeSprite, repaint, setOpaque, setPaused, tick
+  + + + + + + + +
Methods inherited from class javax.swing.JComponent
addAncestorListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI
+  + + + + + + + +
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate
+  + + + + + + + +
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+EditorScenePanel

+
+public EditorScenePanel(EditorContext ctx,
+                        JFrame frame,
+                        EditorModel model,
+                        EditorScenePanel.SceneModelListener sceneListener)
+
+
Constructs the editor scene view panel. +

+

+ + + + + + + + +
+Method Detail
+ +

+getHorizModel

+
+public BoundedRangeModel getHorizModel()
+
+
Returns a range model that controls the scrollability of the scene + in the horizontal direction. +

+

+
+
+
+
+
+
+
+ +

+getVertModel

+
+public BoundedRangeModel getVertModel()
+
+
Returns a range model that controls the scrollability of the scene + in the vertical direction. +

+

+
+
+
+
+
+
+
+ +

+stateChanged

+
+public void stateChanged(ChangeEvent e)
+
+
+
Specified by:
stateChanged in interface ChangeListener
+
+
+
+
+
+
+ +

+setSceneModel

+
+public void setSceneModel(com.threerings.miso.data.MisoSceneModel model)
+
+
+
Overrides:
setSceneModel in class com.threerings.miso.client.MisoScenePanel
+
+
+
+
+
+
+ +

+updateDefaultTileSet

+
+public void updateDefaultTileSet(int tileSetId)
+
+
Updates the default tileset in the currently edited scene. +

+

+
+
+
+
+
+
+
+ +

+setBounds

+
+public void setBounds(int x,
+                      int y,
+                      int width,
+                      int height)
+
+
+
Overrides:
setBounds in class com.threerings.miso.client.MisoScenePanel
+
+
+
+
+
+
+ +

+modelChanged

+
+public void modelChanged(int event)
+
+
Description copied from interface: EditorModelListener
+
Called by the EditorModel when the model is changed. +

+

+
Specified by:
modelChanged in interface EditorModelListener
+
+
+
+
+
+
+ +

+mousePressed

+
+public void mousePressed(MouseEvent event)
+
+
+
Specified by:
mousePressed in interface MouseListener
Overrides:
mousePressed in class com.threerings.miso.client.MisoScenePanel
+
+
+
+
+
+
+ +

+mouseReleased

+
+public void mouseReleased(MouseEvent e)
+
+
+
Specified by:
mouseReleased in interface MouseListener
Overrides:
mouseReleased in class com.threerings.miso.client.MisoScenePanel
+
+
+
+
+
+
+ +

+mouseMoved

+
+public void mouseMoved(MouseEvent e)
+
+
+
Specified by:
mouseMoved in interface MouseMotionListener
Overrides:
mouseMoved in class com.threerings.miso.client.MisoScenePanel
+
+
+
+
+
+
+ +

+mouseDragged

+
+public void mouseDragged(MouseEvent e)
+
+
+
Specified by:
mouseDragged in interface MouseMotionListener
Overrides:
mouseDragged in class com.threerings.miso.client.MisoScenePanel
+
+
+
+
+
+
+ +

+mouseExited

+
+public void mouseExited(MouseEvent e)
+
+
+
Specified by:
mouseExited in interface MouseListener
Overrides:
mouseExited in class com.threerings.miso.client.MisoScenePanel
+
+
+
+
+
+
+ +

+keyPressed

+
+public void keyPressed(KeyEvent e)
+
+
+
Specified by:
keyPressed in interface KeyListener
Overrides:
keyPressed in class StageScenePanel
+
+
+
+
+
+
+ +

+keyReleased

+
+public void keyReleased(KeyEvent e)
+
+
+
Specified by:
keyReleased in interface KeyListener
Overrides:
keyReleased in class StageScenePanel
+
+
+
+
+
+
+ +

+setBaseTile

+
+public boolean setBaseTile(int fqTileId,
+                           int x,
+                           int y)
+
+
Sets a base tile at the specified position in the scene (in tile + coordinates). +

+

+
+
+
+ +
Returns:
- if the tile was successfully set
+
+
+
+ +

+setBaseTiles

+
+public void setBaseTiles(Rectangle r,
+                         int setId,
+                         int tileCount)
+
+
Set a region of tiles to a random selection from the supplied tileset. +

+

+
+
+
+
+
+
+
+ +

+addObject

+
+public com.threerings.miso.data.ObjectInfo addObject(com.threerings.media.tile.ObjectTile tile,
+                                                     int fqTileId,
+                                                     int x,
+                                                     int y)
+
+
Sets an object tile at the specified position in the scene (in tile coordinates). +

+

+
+
+
+ +
Returns:
- the created object or null if an identical object was already in that spot.
+
+
+
+ +

+addObject

+
+public com.threerings.miso.data.ObjectInfo addObject(com.threerings.miso.data.ObjectInfo oinfo)
+
+
Adds the given object to the scene. +

+

+
+
+
+ +
Returns:
the added object or null if an identical object was already in that spot.
+
+
+
+ +

+deleteObject

+
+public boolean deleteObject(com.threerings.miso.client.SceneObject scobj)
+
+
Deletes the object tile at the specified tile coordinates. +

+

+
+
+
+ +
Returns:
true - if a matching object was found and deleted.
+
+
+
+ +

+deleteObject

+
+public boolean deleteObject(com.threerings.miso.data.ObjectInfo info)
+
+
Delete the given object from the scene. +

+

+
+
+
+ +
Returns:
true - if a matching object was found and deleted.
+
+
+
+ +

+setPlacingTile

+
+public void setPlacingTile(com.threerings.media.tile.Tile tile)
+
+
Sets the tile that is currently being placed. It will not be + rendered until after a call to MisoScenePanel.updateTileCoords(int, int, java.awt.Point) on the + placing tile (which happens automatically when the mouse moves). +

+

+
+
+
+
+
+
+
+ +

+setTileSelectRegion

+
+public void setTileSelectRegion(Point drag)
+
+
Sets the start (in tile coords) of a mouse drag when placing + a rectangular area of base tiles. +

+

+
+
+
+
+
+
+
+ +

+clearTileSelectRegion

+
+public Rectangle clearTileSelectRegion(int x,
+                                       int y)
+
+
Clear and return the drag rectangle for selecting a rectangular + region. +

+

+
+
+
+ +
Returns:
null if the drag is the same as the supplied tile + coordinates, a rectangle containing the selected region if it was + different.
+
+
+
+ +

+enableCoordHighlighting

+
+public void enableCoordHighlighting(boolean enabled)
+
+
Enables or disables highlighting of the tile over which the mouse + is currently positioned. +

+

+
+
+
+
+
+
+
+ +

+deletePortal

+
+public void deletePortal(int x,
+                         int y)
+
+
Deletes the portal at the specified full coordinates. +

+

+
+
+
+
+
+
+
+ +

+getEntrance

+
+public Portal getEntrance()
+
+
Returns the portal that serves as the default entrance to this + scene or null if no default is set. +

+

+
+
+
+
+
+
+
+ +

+setEntrance

+
+public void setEntrance(Portal port)
+
+
Makes the specified portal the default entrance to this scene. +

+

+
+
+
+
+
+
+
+ +

+updateCoordPos

+
+public boolean updateCoordPos(int x,
+                              int y,
+                              Point cpos)
+
+
Updates the coordinate position and returns true if it has changed. +

+

+
+
+
+
+
+
+
+ +

+setEditorScrollBox

+
+public void setEditorScrollBox(EditorScrollBox box)
+
+
Set the scroll box that tracks our view. +

+

+
+
+
+
+
+
+
+ +

+undo

+
+public void undo()
+
+
+
+
+
+
+
+
+
+ +

+redo

+
+public void redo()
+
+
+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/editor/EditorScrollBox.html b/apidocs/com/threerings/stage/tools/editor/EditorScrollBox.html new file mode 100644 index 00000000..2db635c1 --- /dev/null +++ b/apidocs/com/threerings/stage/tools/editor/EditorScrollBox.html @@ -0,0 +1,452 @@ + + + + + + + +EditorScrollBox (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stage.tools.editor +
+Class EditorScrollBox

+
+java.lang.Object
+  extended by java.awt.Component
+      extended by java.awt.Container
+          extended by javax.swing.JComponent
+              extended by javax.swing.JPanel
+                  extended by com.samskivert.swing.ScrollBox
+                      extended by com.threerings.stage.tools.editor.EditorScrollBox
+
+
+
All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, Accessible
+
+
+
+
public class EditorScrollBox
extends ScrollBox
+ + +

+A scrollbox that shows our position in the editor. +

+ +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent
+  + + + + + + + + +
Nested classes/interfaces inherited from class java.awt.Component
Component.BaselineResizeBehavior
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class javax.swing.JComponent
TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
+  + + + + + + + +
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
+  + + + + + + + +
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
+  + + + + + + + + + + +
+Constructor Summary
EditorScrollBox(EditorScenePanel panel) + +
+          Create the tightly-coupled EditorScrollBox.
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ Graphics2DgetMiniGraphics() + +
+          Get the graphics to draw into when rendering onto the minimap.
+ DimensiongetPreferredSize() + +
+           
+ voidsetBounds(int x, + int y, + int w, + int h) + +
+           
+ voidupdateView() + +
+          Update the view of the editor map.
+  + + + + + + + +
Methods inherited from class com.samskivert.swing.ScrollBox
addNotify, paintComponent, removeNotify
+  + + + + + + + +
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, setUI, updateUI
+  + + + + + + + +
Methods inherited from class javax.swing.JComponent
addAncestorListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
+  + + + + + + + +
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate
+  + + + + + + + +
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+EditorScrollBox

+
+public EditorScrollBox(EditorScenePanel panel)
+
+
Create the tightly-coupled EditorScrollBox. +

+

+ + + + + + + + +
+Method Detail
+ +

+updateView

+
+public void updateView()
+
+
Update the view of the editor map. +

+

+
+
+
+
+ +

+getMiniGraphics

+
+public Graphics2D getMiniGraphics()
+
+
Get the graphics to draw into when rendering onto the minimap. +

+

+
+
+
+
+ +

+getPreferredSize

+
+public Dimension getPreferredSize()
+
+
+
Overrides:
getPreferredSize in class JComponent
+
+
+
+
+
+
+ +

+setBounds

+
+public void setBounds(int x,
+                      int y,
+                      int w,
+                      int h)
+
+
+
Overrides:
setBounds in class ScrollBox
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/editor/EditorTileManager.html b/apidocs/com/threerings/stage/tools/editor/EditorTileManager.html new file mode 100644 index 00000000..079be95d --- /dev/null +++ b/apidocs/com/threerings/stage/tools/editor/EditorTileManager.html @@ -0,0 +1,330 @@ + + + + + + + +EditorTileManager (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stage.tools.editor +
+Class EditorTileManager

+
+java.lang.Object
+  extended by com.threerings.media.tile.TileManager
+      extended by com.threerings.miso.tile.MisoTileManager
+          extended by com.threerings.stage.tools.editor.EditorTileManager
+
+
+
+
public class EditorTileManager
extends com.threerings.miso.tile.MisoTileManager
+ + +

+Extends the normal Miso Tile Manager to allow the use of a set of test tiles that can be used in + the editor. These are loaded through the TestTileLoader. +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
EditorTileManager(com.threerings.resource.ResourceManager rmgr, + com.threerings.media.image.ImageManager imgr) + +
+           
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidaddTestTileSet(int id, + com.threerings.media.tile.TileSet set) + +
+          Add a test tile set to search before normal tilesets.
+ voidclearTestTileSets() + +
+          Clear all of our existing test tile sets.
+ com.threerings.media.tile.TileSetgetTileSet(int tileSetId) + +
+           
+  + + + + + + + +
Methods inherited from class com.threerings.miso.tile.MisoTileManager
getAutoFringer
+  + + + + + + + +
Methods inherited from class com.threerings.media.tile.TileManager
clearCache, getImageProvider, getTile, getTile, getTile, getTileSet, getTileSetRepository, loadTileSet, loadTileSet, loadTileSet, setTileSetRepository
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+EditorTileManager

+
+public EditorTileManager(com.threerings.resource.ResourceManager rmgr,
+                         com.threerings.media.image.ImageManager imgr)
+
+
+ + + + + + + + +
+Method Detail
+ +

+getTileSet

+
+public com.threerings.media.tile.TileSet getTileSet(int tileSetId)
+                                             throws com.threerings.media.tile.NoSuchTileSetException
+
+
+
Overrides:
getTileSet in class com.threerings.media.tile.TileManager
+
+
+ +
Throws: +
com.threerings.media.tile.NoSuchTileSetException
+
+
+
+ +

+addTestTileSet

+
+public void addTestTileSet(int id,
+                           com.threerings.media.tile.TileSet set)
+
+
Add a test tile set to search before normal tilesets. +

+

+
+
+
+
+ +

+clearTestTileSets

+
+public void clearTestTileSets()
+
+
Clear all of our existing test tile sets. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/editor/EditorToolBarPanel.html b/apidocs/com/threerings/stage/tools/editor/EditorToolBarPanel.html new file mode 100644 index 00000000..62831056 --- /dev/null +++ b/apidocs/com/threerings/stage/tools/editor/EditorToolBarPanel.html @@ -0,0 +1,368 @@ + + + + + + + +EditorToolBarPanel (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stage.tools.editor +
+Class EditorToolBarPanel

+
+java.lang.Object
+  extended by java.awt.Component
+      extended by java.awt.Container
+          extended by javax.swing.JComponent
+              extended by javax.swing.JPanel
+                  extended by com.threerings.stage.tools.editor.EditorToolBarPanel
+
+
+
All Implemented Interfaces:
ActionListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible
+
+
+
+
public class EditorToolBarPanel
extends JPanel
implements ActionListener
+ + +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent
+  + + + + + + + + +
Nested classes/interfaces inherited from class java.awt.Component
Component.BaselineResizeBehavior
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class javax.swing.JComponent
TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
+  + + + + + + + +
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
+  + + + + + + + +
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
+  + + + + + + + + + + +
+Constructor Summary
EditorToolBarPanel(com.threerings.media.tile.TileManager tilemgr, + EditorModel model) + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ voidactionPerformed(ActionEvent e) + +
+           
+  + + + + + + + +
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, setUI, updateUI
+  + + + + + + + +
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
+  + + + + + + + +
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate
+  + + + + + + + +
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+EditorToolBarPanel

+
+public EditorToolBarPanel(com.threerings.media.tile.TileManager tilemgr,
+                          EditorModel model)
+
+
+ + + + + + + + +
+Method Detail
+ +

+actionPerformed

+
+public void actionPerformed(ActionEvent e)
+
+
+
Specified by:
actionPerformed in interface ActionListener
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/editor/ObjectEditorDialog.html b/apidocs/com/threerings/stage/tools/editor/ObjectEditorDialog.html new file mode 100644 index 00000000..83e84cfd --- /dev/null +++ b/apidocs/com/threerings/stage/tools/editor/ObjectEditorDialog.html @@ -0,0 +1,482 @@ + + + + + + + +ObjectEditorDialog (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stage.tools.editor +
+Class ObjectEditorDialog

+
+java.lang.Object
+  extended by java.awt.Component
+      extended by java.awt.Container
+          extended by javax.swing.JComponent
+              extended by javax.swing.JInternalFrame
+                  extended by com.threerings.stage.tools.editor.EditorDialog
+                      extended by com.threerings.stage.tools.editor.ObjectEditorDialog
+
+
+
All Implemented Interfaces:
ActionListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, RootPaneContainer, WindowConstants
+
+
+
+
public class ObjectEditorDialog
extends EditorDialog
+ + +

+Used to edit object attributes. +

+ +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class javax.swing.JInternalFrame
JInternalFrame.JDesktopIcon
+  + + + + + + + + +
Nested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent
+  + + + + + + + + +
Nested classes/interfaces inherited from class java.awt.Component
Component.BaselineResizeBehavior
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class javax.swing.JInternalFrame
CONTENT_PANE_PROPERTY, FRAME_ICON_PROPERTY, GLASS_PANE_PROPERTY, IS_CLOSED_PROPERTY, IS_ICON_PROPERTY, IS_MAXIMUM_PROPERTY, IS_SELECTED_PROPERTY, LAYERED_PANE_PROPERTY, MENU_BAR_PROPERTY, ROOT_PANE_PROPERTY, TITLE_PROPERTY
+  + + + + + + + +
Fields inherited from class javax.swing.JComponent
TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
+  + + + + + + + +
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
+  + + + + + + + +
Fields inherited from interface javax.swing.WindowConstants
DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE
+  + + + + + + + +
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
+  + + + + + + + + + + +
+Constructor Summary
ObjectEditorDialog(EditorContext ctx, + EditorScenePanel panel) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidaccepted() + +
+          Called when ok is clicked.
+ voidaddComponents(JComponent panel) + +
+           
+ voidcancelled() + +
+          Called when cancel is clicked.
+ voidprepare(com.threerings.miso.client.SceneObject scobj) + +
+          Prepare the dialog for display.
+  + + + + + + + +
Methods inherited from class com.threerings.stage.tools.editor.EditorDialog
actionPerformed
+  + + + + + + + +
Methods inherited from class javax.swing.JInternalFrame
addInternalFrameListener, dispose, doDefaultCloseAction, getAccessibleContext, getContentPane, getDefaultCloseOperation, getDesktopIcon, getDesktopPane, getFocusCycleRootAncestor, getFocusOwner, getFrameIcon, getGlassPane, getInternalFrameListeners, getJMenuBar, getLastCursor, getLayer, getLayeredPane, getMenuBar, getMostRecentFocusOwner, getNormalBounds, getRootPane, getTitle, getUI, getUIClassID, getWarningString, hide, isClosable, isClosed, isFocusCycleRoot, isIcon, isIconifiable, isMaximizable, isMaximum, isResizable, isSelected, moveToBack, moveToFront, pack, remove, removeInternalFrameListener, reshape, restoreSubcomponentFocus, setClosable, setClosed, setContentPane, setCursor, setDefaultCloseOperation, setDesktopIcon, setFocusCycleRoot, setFrameIcon, setGlassPane, setIcon, setIconifiable, setJMenuBar, setLayer, setLayer, setLayeredPane, setLayout, setMaximizable, setMaximum, setMenuBar, setNormalBounds, setResizable, setSelected, setTitle, setUI, show, toBack, toFront, updateUI
+  + + + + + + + +
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
+  + + + + + + + +
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, transferFocusBackward, transferFocusDownCycle, validate
+  + + + + + + + +
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, size, toString, transferFocus, transferFocusUpCycle
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+ObjectEditorDialog

+
+public ObjectEditorDialog(EditorContext ctx,
+                          EditorScenePanel panel)
+
+
+ + + + + + + + +
+Method Detail
+ +

+addComponents

+
+public void addComponents(JComponent panel)
+
+
+
Specified by:
addComponents in class EditorDialog
+
+
+
+
+
+
+ +

+prepare

+
+public void prepare(com.threerings.miso.client.SceneObject scobj)
+
+
Prepare the dialog for display. This method should be called before display() + is called. +

+

+
Parameters:
scobj - the object to edit.
+
+
+
+ +

+accepted

+
+public void accepted()
+
+
Description copied from class: EditorDialog
+
Called when ok is clicked. +

+

+
Specified by:
accepted in class EditorDialog
+
+
+
+
+
+
+ +

+cancelled

+
+public void cancelled()
+
+
Description copied from class: EditorDialog
+
Called when cancel is clicked. +

+

+
Overrides:
cancelled in class EditorDialog
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/editor/PortalDialog.html b/apidocs/com/threerings/stage/tools/editor/PortalDialog.html new file mode 100644 index 00000000..ab298a18 --- /dev/null +++ b/apidocs/com/threerings/stage/tools/editor/PortalDialog.html @@ -0,0 +1,487 @@ + + + + + + + +PortalDialog (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stage.tools.editor +
+Class PortalDialog

+
+java.lang.Object
+  extended by java.awt.Component
+      extended by java.awt.Container
+          extended by javax.swing.JComponent
+              extended by javax.swing.JInternalFrame
+                  extended by com.threerings.stage.tools.editor.EditorDialog
+                      extended by com.threerings.stage.tools.editor.PortalDialog
+
+
+
All Implemented Interfaces:
ActionListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, RootPaneContainer, WindowConstants
+
+
+
+
public class PortalDialog
extends EditorDialog
+ + +

+The PortalDialog is used to present the user with a dialog + allowing them to enter the information associated with an + EditablePortal. The dialog is used both to set up a new + portal and to edit an existing portal. +

+ +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class javax.swing.JInternalFrame
JInternalFrame.JDesktopIcon
+  + + + + + + + + +
Nested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent
+  + + + + + + + + +
Nested classes/interfaces inherited from class java.awt.Component
Component.BaselineResizeBehavior
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class javax.swing.JInternalFrame
CONTENT_PANE_PROPERTY, FRAME_ICON_PROPERTY, GLASS_PANE_PROPERTY, IS_CLOSED_PROPERTY, IS_ICON_PROPERTY, IS_MAXIMUM_PROPERTY, IS_SELECTED_PROPERTY, LAYERED_PANE_PROPERTY, MENU_BAR_PROPERTY, ROOT_PANE_PROPERTY, TITLE_PROPERTY
+  + + + + + + + +
Fields inherited from class javax.swing.JComponent
TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
+  + + + + + + + +
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
+  + + + + + + + +
Fields inherited from interface javax.swing.WindowConstants
DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE
+  + + + + + + + +
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
+  + + + + + + + + + + +
+Constructor Summary
PortalDialog(EditorContext ctx, + EditorScenePanel panel) + +
+          Constructs the portal dialog.
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidaccepted() + +
+          Handles the user submitting the dialog via the "OK" button.
+ voidactionPerformed(ActionEvent e) + +
+          Handle action events on the dialog user interface elements.
+ voidaddComponents(JComponent top) + +
+           
+ voidprepare(StageScene scene, + EditablePortal port) + +
+          Prepare the dialog for display.
+  + + + + + + + +
Methods inherited from class com.threerings.stage.tools.editor.EditorDialog
cancelled
+  + + + + + + + +
Methods inherited from class javax.swing.JInternalFrame
addInternalFrameListener, dispose, doDefaultCloseAction, getAccessibleContext, getContentPane, getDefaultCloseOperation, getDesktopIcon, getDesktopPane, getFocusCycleRootAncestor, getFocusOwner, getFrameIcon, getGlassPane, getInternalFrameListeners, getJMenuBar, getLastCursor, getLayer, getLayeredPane, getMenuBar, getMostRecentFocusOwner, getNormalBounds, getRootPane, getTitle, getUI, getUIClassID, getWarningString, hide, isClosable, isClosed, isFocusCycleRoot, isIcon, isIconifiable, isMaximizable, isMaximum, isResizable, isSelected, moveToBack, moveToFront, pack, remove, removeInternalFrameListener, reshape, restoreSubcomponentFocus, setClosable, setClosed, setContentPane, setCursor, setDefaultCloseOperation, setDesktopIcon, setFocusCycleRoot, setFrameIcon, setGlassPane, setIcon, setIconifiable, setJMenuBar, setLayer, setLayer, setLayeredPane, setLayout, setMaximizable, setMaximum, setMenuBar, setNormalBounds, setResizable, setSelected, setTitle, setUI, show, toBack, toFront, updateUI
+  + + + + + + + +
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
+  + + + + + + + +
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, transferFocusBackward, transferFocusDownCycle, validate
+  + + + + + + + +
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, size, toString, transferFocus, transferFocusUpCycle
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+PortalDialog

+
+public PortalDialog(EditorContext ctx,
+                    EditorScenePanel panel)
+
+
Constructs the portal dialog. +

+

+ + + + + + + + +
+Method Detail
+ +

+addComponents

+
+public void addComponents(JComponent top)
+
+
+
Specified by:
addComponents in class EditorDialog
+
+
+
+
+
+
+ +

+prepare

+
+public void prepare(StageScene scene,
+                    EditablePortal port)
+
+
Prepare the dialog for display. This method should be called + before display() is called. +

+

+
Parameters:
port - the portal to edit.
+
+
+
+ +

+actionPerformed

+
+public void actionPerformed(ActionEvent e)
+
+
Handle action events on the dialog user interface elements. +

+

+
Specified by:
actionPerformed in interface ActionListener
Overrides:
actionPerformed in class EditorDialog
+
+
+
+
+
+
+ +

+accepted

+
+public void accepted()
+
+
Handles the user submitting the dialog via the "OK" button. +

+

+
Specified by:
accepted in class EditorDialog
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/editor/PortalTool.html b/apidocs/com/threerings/stage/tools/editor/PortalTool.html new file mode 100644 index 00000000..178291d8 --- /dev/null +++ b/apidocs/com/threerings/stage/tools/editor/PortalTool.html @@ -0,0 +1,372 @@ + + + + + + + +PortalTool (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stage.tools.editor +
+Class PortalTool

+
+java.lang.Object
+  extended by java.awt.event.MouseAdapter
+      extended by javax.swing.event.MouseInputAdapter
+          extended by com.threerings.stage.tools.editor.PortalTool
+
+
+
All Implemented Interfaces:
ExtrasPainter, MouseListener, MouseMotionListener, MouseWheelListener, EventListener, MouseInputListener
+
+
+
+
public class PortalTool
extends MouseInputAdapter
implements ExtrasPainter
+ + +

+A tool for setting a portal. +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
PortalTool() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidinit(EditorScenePanel panel, + int centerx, + int centery) + +
+           
+ voidmouseDragged(MouseEvent event) + +
+          When the mouse is dragged we update the current portal.
+ voidmouseReleased(MouseEvent event) + +
+          If button1 is released, we store the new portal, if button3: we + cancel.
+ voidpaintExtras(Graphics2D gfx) + +
+          Paint what the clusters would look like if we were to add them to + the scene.
+  + + + + + + + +
Methods inherited from class java.awt.event.MouseAdapter
mouseClicked, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseWheelMoved
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  + + + + + + + +
Methods inherited from interface java.awt.event.MouseListener
mouseClicked, mouseEntered, mouseExited, mousePressed
+  + + + + + + + +
Methods inherited from interface java.awt.event.MouseMotionListener
mouseMoved
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+PortalTool

+
+public PortalTool()
+
+
+ + + + + + + + +
+Method Detail
+ +

+init

+
+public void init(EditorScenePanel panel,
+                 int centerx,
+                 int centery)
+
+
+
+
+
+
+
+
+
+ +

+mouseDragged

+
+public void mouseDragged(MouseEvent event)
+
+
When the mouse is dragged we update the current portal. +

+

+
Specified by:
mouseDragged in interface MouseMotionListener
Overrides:
mouseDragged in class MouseAdapter
+
+
+
+
+
+
+ +

+mouseReleased

+
+public void mouseReleased(MouseEvent event)
+
+
If button1 is released, we store the new portal, if button3: we + cancel. +

+

+
Specified by:
mouseReleased in interface MouseListener
Overrides:
mouseReleased in class MouseAdapter
+
+
+
+
+
+
+ +

+paintExtras

+
+public void paintExtras(Graphics2D gfx)
+
+
Paint what the clusters would look like if we were to add them to + the scene. +

+

+
Specified by:
paintExtras in interface ExtrasPainter
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/editor/PreferencesDialog.html b/apidocs/com/threerings/stage/tools/editor/PreferencesDialog.html new file mode 100644 index 00000000..755e602c --- /dev/null +++ b/apidocs/com/threerings/stage/tools/editor/PreferencesDialog.html @@ -0,0 +1,402 @@ + + + + + + + +PreferencesDialog (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stage.tools.editor +
+Class PreferencesDialog

+
+java.lang.Object
+  extended by java.awt.Component
+      extended by java.awt.Container
+          extended by javax.swing.JComponent
+              extended by javax.swing.JInternalFrame
+                  extended by com.threerings.stage.tools.editor.PreferencesDialog
+
+
+
All Implemented Interfaces:
ActionListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, RootPaneContainer, WindowConstants
+
+
+
+
public class PreferencesDialog
extends JInternalFrame
implements ActionListener
+ + +

+A dialog for editing preferences. +

+ +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class javax.swing.JInternalFrame
JInternalFrame.JDesktopIcon
+  + + + + + + + + +
Nested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent
+  + + + + + + + + +
Nested classes/interfaces inherited from class java.awt.Component
Component.BaselineResizeBehavior
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class javax.swing.JInternalFrame
CONTENT_PANE_PROPERTY, FRAME_ICON_PROPERTY, GLASS_PANE_PROPERTY, IS_CLOSED_PROPERTY, IS_ICON_PROPERTY, IS_MAXIMUM_PROPERTY, IS_SELECTED_PROPERTY, LAYERED_PANE_PROPERTY, MENU_BAR_PROPERTY, ROOT_PANE_PROPERTY, TITLE_PROPERTY
+  + + + + + + + +
Fields inherited from class javax.swing.JComponent
TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
+  + + + + + + + +
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
+  + + + + + + + +
Fields inherited from interface javax.swing.WindowConstants
DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE
+  + + + + + + + +
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
+  + + + + + + + + + + +
+Constructor Summary
PreferencesDialog() + +
+          Creates a preferences dialog.
+  + + + + + + + + + + + +
+Method Summary
+ voidactionPerformed(ActionEvent e) + +
+          Handle action events.
+  + + + + + + + +
Methods inherited from class javax.swing.JInternalFrame
addInternalFrameListener, dispose, doDefaultCloseAction, getAccessibleContext, getContentPane, getDefaultCloseOperation, getDesktopIcon, getDesktopPane, getFocusCycleRootAncestor, getFocusOwner, getFrameIcon, getGlassPane, getInternalFrameListeners, getJMenuBar, getLastCursor, getLayer, getLayeredPane, getMenuBar, getMostRecentFocusOwner, getNormalBounds, getRootPane, getTitle, getUI, getUIClassID, getWarningString, hide, isClosable, isClosed, isFocusCycleRoot, isIcon, isIconifiable, isMaximizable, isMaximum, isResizable, isSelected, moveToBack, moveToFront, pack, remove, removeInternalFrameListener, reshape, restoreSubcomponentFocus, setClosable, setClosed, setContentPane, setCursor, setDefaultCloseOperation, setDesktopIcon, setFocusCycleRoot, setFrameIcon, setGlassPane, setIcon, setIconifiable, setJMenuBar, setLayer, setLayer, setLayeredPane, setLayout, setMaximizable, setMaximum, setMenuBar, setNormalBounds, setResizable, setSelected, setTitle, setUI, show, toBack, toFront, updateUI
+  + + + + + + + +
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
+  + + + + + + + +
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, transferFocusBackward, transferFocusDownCycle, validate
+  + + + + + + + +
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, size, toString, transferFocus, transferFocusUpCycle
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+PreferencesDialog

+
+public PreferencesDialog()
+
+
Creates a preferences dialog. +

+

+ + + + + + + + +
+Method Detail
+ +

+actionPerformed

+
+public void actionPerformed(ActionEvent e)
+
+
Handle action events. +

+

+
Specified by:
actionPerformed in interface ActionListener
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/editor/SceneInfoPanel.html b/apidocs/com/threerings/stage/tools/editor/SceneInfoPanel.html new file mode 100644 index 00000000..994f90b4 --- /dev/null +++ b/apidocs/com/threerings/stage/tools/editor/SceneInfoPanel.html @@ -0,0 +1,401 @@ + + + + + + + +SceneInfoPanel (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stage.tools.editor +
+Class SceneInfoPanel

+
+java.lang.Object
+  extended by java.awt.Component
+      extended by java.awt.Container
+          extended by javax.swing.JComponent
+              extended by javax.swing.JPanel
+                  extended by com.threerings.stage.tools.editor.SceneInfoPanel
+
+
+
All Implemented Interfaces:
ActionListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible
+
+
+
+
public class SceneInfoPanel
extends JPanel
implements ActionListener
+ + +

+The scene info panel presents the user with options to select the scene layer to edit, and + whether to display tile coordinates and locations in the scene view. +

+ +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent
+  + + + + + + + + +
Nested classes/interfaces inherited from class java.awt.Component
Component.BaselineResizeBehavior
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class javax.swing.JComponent
TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
+  + + + + + + + +
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
+  + + + + + + + +
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
+  + + + + + + + + + + +
+Constructor Summary
SceneInfoPanel(EditorContext ctx, + EditorModel model, + EditorScenePanel svpanel) + +
+          Constructs the scene info panel.
+  + + + + + + + + + + + + + + + +
+Method Summary
+ voidactionPerformed(ActionEvent e) + +
+           
+ voidsetScene(StageScene scene) + +
+          Called when the scene in the editor changes.
+  + + + + + + + +
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, setUI, updateUI
+  + + + + + + + +
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
+  + + + + + + + +
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate
+  + + + + + + + +
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+SceneInfoPanel

+
+public SceneInfoPanel(EditorContext ctx,
+                      EditorModel model,
+                      EditorScenePanel svpanel)
+
+
Constructs the scene info panel. +

+

+ + + + + + + + +
+Method Detail
+ +

+setScene

+
+public void setScene(StageScene scene)
+
+
Called when the scene in the editor changes. +

+

+
+
+
+
+
+
+
+ +

+actionPerformed

+
+public void actionPerformed(ActionEvent e)
+
+
+
Specified by:
actionPerformed in interface ActionListener
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/editor/TestTileLoader.html b/apidocs/com/threerings/stage/tools/editor/TestTileLoader.html new file mode 100644 index 00000000..1205e477 --- /dev/null +++ b/apidocs/com/threerings/stage/tools/editor/TestTileLoader.html @@ -0,0 +1,346 @@ + + + + + + + +TestTileLoader (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stage.tools.editor +
+Class TestTileLoader

+
+java.lang.Object
+  extended by com.threerings.stage.tools.editor.TestTileLoader
+
+
+
All Implemented Interfaces:
com.threerings.media.tile.TileSetIDBroker
+
+
+
+
public class TestTileLoader
extends Object
implements com.threerings.media.tile.TileSetIDBroker
+ + +

+The TestTileLoader handles test tiles. Test tiles are tiles that an + artist can load in on-the-fly to see how things look in the scene editor. +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
TestTileLoader() + +
+          Construct the TestTileLoader.
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidcommit() + +
+          Since we're just testing, we don't save these crazy IDs.
+ intgetTileSetID(String tileSetPath) + +
+          Generate unique and completely fake tileset IDs that will be stable + even after a reload of test tiles.
+ HashIntMap<com.threerings.media.tile.TileSet>loadTestTiles() + +
+          Check the specified directory and all its subdirectories for xml files.
+ booleantileSetMapped(String tilesetPath) + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+TestTileLoader

+
+public TestTileLoader()
+
+
Construct the TestTileLoader. +

+

+ + + + + + + + +
+Method Detail
+ +

+loadTestTiles

+
+public HashIntMap<com.threerings.media.tile.TileSet> loadTestTiles()
+
+
Check the specified directory and all its subdirectories for xml files. + Each directory should contain at most one xml file, each xml file + should specify at most one tileset. That tileset specification + will be used to create tilesets for all the .png files in the same + directory. +

+

+
+
+
+ +
Returns:
a HashIntMap containing a TileSetId -> TileSet mapping for + all the tilesets we create.
+
+
+
+ +

+getTileSetID

+
+public int getTileSetID(String tileSetPath)
+
+
Generate unique and completely fake tileset IDs that will be stable + even after a reload of test tiles. +

+

+
Specified by:
getTileSetID in interface com.threerings.media.tile.TileSetIDBroker
+
+
+
+
+
+
+ +

+tileSetMapped

+
+public boolean tileSetMapped(String tilesetPath)
+
+
+
Specified by:
tileSetMapped in interface com.threerings.media.tile.TileSetIDBroker
+
+
+
+
+
+
+ +

+commit

+
+public void commit()
+
+
Since we're just testing, we don't save these crazy IDs. +

+

+
Specified by:
commit in interface com.threerings.media.tile.TileSetIDBroker
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/editor/TileInfoPanel.html b/apidocs/com/threerings/stage/tools/editor/TileInfoPanel.html new file mode 100644 index 00000000..ed5b01a0 --- /dev/null +++ b/apidocs/com/threerings/stage/tools/editor/TileInfoPanel.html @@ -0,0 +1,538 @@ + + + + + + + +TileInfoPanel (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stage.tools.editor +
+Class TileInfoPanel

+
+java.lang.Object
+  extended by java.awt.Component
+      extended by java.awt.Container
+          extended by javax.swing.JComponent
+              extended by javax.swing.JSplitPane
+                  extended by com.threerings.stage.tools.editor.TileInfoPanel
+
+
+
All Implemented Interfaces:
EditorModelListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, ListSelectionListener, TreeSelectionListener
+
+
+
+
public class TileInfoPanel
extends JSplitPane
implements ListSelectionListener, TreeSelectionListener, EditorModelListener
+ + +

+The tile info panel presents the user with options to select the tile to be applied to the + scene. +

+ +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent
+  + + + + + + + + +
Nested classes/interfaces inherited from class java.awt.Component
Component.BaselineResizeBehavior
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class javax.swing.JSplitPane
BOTTOM, CONTINUOUS_LAYOUT_PROPERTY, DIVIDER, DIVIDER_LOCATION_PROPERTY, DIVIDER_SIZE_PROPERTY, HORIZONTAL_SPLIT, LAST_DIVIDER_LOCATION_PROPERTY, LEFT, ONE_TOUCH_EXPANDABLE_PROPERTY, ORIENTATION_PROPERTY, RESIZE_WEIGHT_PROPERTY, RIGHT, TOP, VERTICAL_SPLIT
+  + + + + + + + +
Fields inherited from class javax.swing.JComponent
TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
+  + + + + + + + +
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
+  + + + + + + + +
Fields inherited from interface com.threerings.stage.tools.editor.EditorModelListener
ACTION_MODE_CHANGED, LAYER_INDEX_CHANGED, TILE_CHANGED
+  + + + + + + + +
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, PROPERTIES, SOMEBITS
+  + + + + + + + + + + +
+Constructor Summary
TileInfoPanel(EditorContext ctx, + EditorModel model) + +
+          Constructs the tile info panel.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ DimensiongetPreferredSize() + +
+           
+ voidmodelChanged(int event) + +
+          Called by the EditorModel when the model is changed.
+ voidselectNextTile() + +
+          Selects the next tile in the list of available tiles.
+ voidselectPreviousTile() + +
+          Selects the previous tile in the list of available tiles.
+ voidupdateTileSetTree() + +
+          The layer has changed, update the tree to reflect the tilesets now available.
+ voidvalueChanged(ListSelectionEvent e) + +
+          Handle tile table selections.
+ voidvalueChanged(TreeSelectionEvent e) + +
+          Display the tiles in a tileset when it is selected.
+  + + + + + + + +
Methods inherited from class javax.swing.JSplitPane
getAccessibleContext, getBottomComponent, getDividerLocation, getDividerSize, getLastDividerLocation, getLeftComponent, getMaximumDividerLocation, getMinimumDividerLocation, getOrientation, getResizeWeight, getRightComponent, getTopComponent, getUI, getUIClassID, isContinuousLayout, isOneTouchExpandable, isValidateRoot, remove, remove, removeAll, resetToPreferredSizes, setBottomComponent, setContinuousLayout, setDividerLocation, setDividerLocation, setDividerSize, setLastDividerLocation, setLeftComponent, setOneTouchExpandable, setOrientation, setResizeWeight, setRightComponent, setTopComponent, setUI, updateUI
+  + + + + + + + +
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
+  + + + + + + + +
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate
+  + + + + + + + +
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+TileInfoPanel

+
+public TileInfoPanel(EditorContext ctx,
+                     EditorModel model)
+
+
Constructs the tile info panel. +

+

+ + + + + + + + +
+Method Detail
+ +

+modelChanged

+
+public void modelChanged(int event)
+
+
Description copied from interface: EditorModelListener
+
Called by the EditorModel when the model is changed. +

+

+
Specified by:
modelChanged in interface EditorModelListener
+
+
+
+
+
+
+ +

+selectPreviousTile

+
+public void selectPreviousTile()
+
+
Selects the previous tile in the list of available tiles. +

+

+
+
+
+
+
+
+
+ +

+selectNextTile

+
+public void selectNextTile()
+
+
Selects the next tile in the list of available tiles. +

+

+
+
+
+
+
+
+
+ +

+getPreferredSize

+
+public Dimension getPreferredSize()
+
+
+
Overrides:
getPreferredSize in class JComponent
+
+
+
+
+
+
+ +

+valueChanged

+
+public void valueChanged(TreeSelectionEvent e)
+
+
Display the tiles in a tileset when it is selected. +

+

+
Specified by:
valueChanged in interface TreeSelectionListener
+
+
+
+
+
+
+ +

+updateTileSetTree

+
+public void updateTileSetTree()
+
+
The layer has changed, update the tree to reflect the tilesets now available. +

+

+
+
+
+
+
+
+
+ +

+valueChanged

+
+public void valueChanged(ListSelectionEvent e)
+
+
Handle tile table selections. +

+

+
Specified by:
valueChanged in interface ListSelectionListener
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/editor/class-use/DirectionButton.html b/apidocs/com/threerings/stage/tools/editor/class-use/DirectionButton.html new file mode 100644 index 00000000..ff86dae9 --- /dev/null +++ b/apidocs/com/threerings/stage/tools/editor/class-use/DirectionButton.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.stage.tools.editor.DirectionButton (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stage.tools.editor.DirectionButton

+
+No usage of com.threerings.stage.tools.editor.DirectionButton +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/editor/class-use/EditorApp.html b/apidocs/com/threerings/stage/tools/editor/class-use/EditorApp.html new file mode 100644 index 00000000..30b9acc7 --- /dev/null +++ b/apidocs/com/threerings/stage/tools/editor/class-use/EditorApp.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.stage.tools.editor.EditorApp (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stage.tools.editor.EditorApp

+
+No usage of com.threerings.stage.tools.editor.EditorApp +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/editor/class-use/EditorConfig.html b/apidocs/com/threerings/stage/tools/editor/class-use/EditorConfig.html new file mode 100644 index 00000000..4992a645 --- /dev/null +++ b/apidocs/com/threerings/stage/tools/editor/class-use/EditorConfig.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.stage.tools.editor.EditorConfig (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stage.tools.editor.EditorConfig

+
+No usage of com.threerings.stage.tools.editor.EditorConfig +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/editor/class-use/EditorDialog.html b/apidocs/com/threerings/stage/tools/editor/class-use/EditorDialog.html new file mode 100644 index 00000000..a478416e --- /dev/null +++ b/apidocs/com/threerings/stage/tools/editor/class-use/EditorDialog.html @@ -0,0 +1,191 @@ + + + + + + + +Uses of Class com.threerings.stage.tools.editor.EditorDialog (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stage.tools.editor.EditorDialog

+
+ + + + + + + + + +
+Packages that use EditorDialog
com.threerings.stage.tools.editor  
+  +

+ + + + + +
+Uses of EditorDialog in com.threerings.stage.tools.editor
+  +

+ + + + + + + + + + + + + +
Subclasses of EditorDialog in com.threerings.stage.tools.editor
+ classObjectEditorDialog + +
+          Used to edit object attributes.
+ classPortalDialog + +
+          The PortalDialog is used to present the user with a dialog + allowing them to enter the information associated with an + EditablePortal.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/editor/class-use/EditorFrame.html b/apidocs/com/threerings/stage/tools/editor/class-use/EditorFrame.html new file mode 100644 index 00000000..ca24b7a3 --- /dev/null +++ b/apidocs/com/threerings/stage/tools/editor/class-use/EditorFrame.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.stage.tools.editor.EditorFrame (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stage.tools.editor.EditorFrame

+
+No usage of com.threerings.stage.tools.editor.EditorFrame +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/editor/class-use/EditorModel.html b/apidocs/com/threerings/stage/tools/editor/class-use/EditorModel.html new file mode 100644 index 00000000..2a78998a --- /dev/null +++ b/apidocs/com/threerings/stage/tools/editor/class-use/EditorModel.html @@ -0,0 +1,204 @@ + + + + + + + +Uses of Class com.threerings.stage.tools.editor.EditorModel (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stage.tools.editor.EditorModel

+
+ + + + + + + + + +
+Packages that use EditorModel
com.threerings.stage.tools.editor  
+  +

+ + + + + +
+Uses of EditorModel in com.threerings.stage.tools.editor
+  +

+ + + + + + + + + + + + + + + + + +
Constructors in com.threerings.stage.tools.editor with parameters of type EditorModel
EditorScenePanel(EditorContext ctx, + JFrame frame, + EditorModel model, + EditorScenePanel.SceneModelListener sceneListener) + +
+          Constructs the editor scene view panel.
EditorToolBarPanel(com.threerings.media.tile.TileManager tilemgr, + EditorModel model) + +
+           
SceneInfoPanel(EditorContext ctx, + EditorModel model, + EditorScenePanel svpanel) + +
+          Constructs the scene info panel.
TileInfoPanel(EditorContext ctx, + EditorModel model) + +
+          Constructs the tile info panel.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/editor/class-use/EditorModelListener.html b/apidocs/com/threerings/stage/tools/editor/class-use/EditorModelListener.html new file mode 100644 index 00000000..0a7e6d5d --- /dev/null +++ b/apidocs/com/threerings/stage/tools/editor/class-use/EditorModelListener.html @@ -0,0 +1,206 @@ + + + + + + + +Uses of Interface com.threerings.stage.tools.editor.EditorModelListener (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.stage.tools.editor.EditorModelListener

+
+ + + + + + + + + +
+Packages that use EditorModelListener
com.threerings.stage.tools.editor  
+  +

+ + + + + +
+Uses of EditorModelListener in com.threerings.stage.tools.editor
+  +

+ + + + + + + + + + + + + +
Classes in com.threerings.stage.tools.editor that implement EditorModelListener
+ classEditorScenePanel + +
+          Displays the scene view and handles UI events on the scene.
+ classTileInfoPanel + +
+          The tile info panel presents the user with options to select the tile to be applied to the + scene.
+  +

+ + + + + + + + + +
Methods in com.threerings.stage.tools.editor with parameters of type EditorModelListener
+ voidEditorModel.addListener(EditorModelListener l) + +
+          Add an editor model listener.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/editor/class-use/EditorScenePanel.SceneModelListener.html b/apidocs/com/threerings/stage/tools/editor/class-use/EditorScenePanel.SceneModelListener.html new file mode 100644 index 00000000..f1361c16 --- /dev/null +++ b/apidocs/com/threerings/stage/tools/editor/class-use/EditorScenePanel.SceneModelListener.html @@ -0,0 +1,198 @@ + + + + + + + +Uses of Interface com.threerings.stage.tools.editor.EditorScenePanel.SceneModelListener (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.stage.tools.editor.EditorScenePanel.SceneModelListener

+
+ + + + + + + + + +
+Packages that use EditorScenePanel.SceneModelListener
com.threerings.stage.tools.editor  
+  +

+ + + + + +
+Uses of EditorScenePanel.SceneModelListener in com.threerings.stage.tools.editor
+  +

+ + + + + + + + + +
Classes in com.threerings.stage.tools.editor that implement EditorScenePanel.SceneModelListener
+ classEditorFrame + +
+           
+  +

+ + + + + + + + +
Constructors in com.threerings.stage.tools.editor with parameters of type EditorScenePanel.SceneModelListener
EditorScenePanel(EditorContext ctx, + JFrame frame, + EditorModel model, + EditorScenePanel.SceneModelListener sceneListener) + +
+          Constructs the editor scene view panel.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/editor/class-use/EditorScenePanel.html b/apidocs/com/threerings/stage/tools/editor/class-use/EditorScenePanel.html new file mode 100644 index 00000000..eadec92c --- /dev/null +++ b/apidocs/com/threerings/stage/tools/editor/class-use/EditorScenePanel.html @@ -0,0 +1,227 @@ + + + + + + + +Uses of Class com.threerings.stage.tools.editor.EditorScenePanel (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stage.tools.editor.EditorScenePanel

+
+ + + + + + + + + +
+Packages that use EditorScenePanel
com.threerings.stage.tools.editor  
+  +

+ + + + + +
+Uses of EditorScenePanel in com.threerings.stage.tools.editor
+  +

+ + + + + + + + + +
Methods in com.threerings.stage.tools.editor with parameters of type EditorScenePanel
+ voidPortalTool.init(EditorScenePanel panel, + int centerx, + int centery) + +
+           
+  +

+ + + + + + + + + + + + + + + + + + + + +
Constructors in com.threerings.stage.tools.editor with parameters of type EditorScenePanel
EditorDialog(String title, + EditorContext ctx, + EditorScenePanel panel) + +
+           
EditorScrollBox(EditorScenePanel panel) + +
+          Create the tightly-coupled EditorScrollBox.
ObjectEditorDialog(EditorContext ctx, + EditorScenePanel panel) + +
+           
PortalDialog(EditorContext ctx, + EditorScenePanel panel) + +
+          Constructs the portal dialog.
SceneInfoPanel(EditorContext ctx, + EditorModel model, + EditorScenePanel svpanel) + +
+          Constructs the scene info panel.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/editor/class-use/EditorScrollBox.html b/apidocs/com/threerings/stage/tools/editor/class-use/EditorScrollBox.html new file mode 100644 index 00000000..37773886 --- /dev/null +++ b/apidocs/com/threerings/stage/tools/editor/class-use/EditorScrollBox.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class com.threerings.stage.tools.editor.EditorScrollBox (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stage.tools.editor.EditorScrollBox

+
+ + + + + + + + + +
+Packages that use EditorScrollBox
com.threerings.stage.tools.editor  
+  +

+ + + + + +
+Uses of EditorScrollBox in com.threerings.stage.tools.editor
+  +

+ + + + + + + + + +
Methods in com.threerings.stage.tools.editor with parameters of type EditorScrollBox
+ voidEditorScenePanel.setEditorScrollBox(EditorScrollBox box) + +
+          Set the scroll box that tracks our view.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/editor/class-use/EditorTileManager.html b/apidocs/com/threerings/stage/tools/editor/class-use/EditorTileManager.html new file mode 100644 index 00000000..31553094 --- /dev/null +++ b/apidocs/com/threerings/stage/tools/editor/class-use/EditorTileManager.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.stage.tools.editor.EditorTileManager (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stage.tools.editor.EditorTileManager

+
+No usage of com.threerings.stage.tools.editor.EditorTileManager +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/editor/class-use/EditorToolBarPanel.html b/apidocs/com/threerings/stage/tools/editor/class-use/EditorToolBarPanel.html new file mode 100644 index 00000000..639c261c --- /dev/null +++ b/apidocs/com/threerings/stage/tools/editor/class-use/EditorToolBarPanel.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.stage.tools.editor.EditorToolBarPanel (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stage.tools.editor.EditorToolBarPanel

+
+No usage of com.threerings.stage.tools.editor.EditorToolBarPanel +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/editor/class-use/ObjectEditorDialog.html b/apidocs/com/threerings/stage/tools/editor/class-use/ObjectEditorDialog.html new file mode 100644 index 00000000..f069ad78 --- /dev/null +++ b/apidocs/com/threerings/stage/tools/editor/class-use/ObjectEditorDialog.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.stage.tools.editor.ObjectEditorDialog (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stage.tools.editor.ObjectEditorDialog

+
+No usage of com.threerings.stage.tools.editor.ObjectEditorDialog +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/editor/class-use/PortalDialog.html b/apidocs/com/threerings/stage/tools/editor/class-use/PortalDialog.html new file mode 100644 index 00000000..468f53f8 --- /dev/null +++ b/apidocs/com/threerings/stage/tools/editor/class-use/PortalDialog.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.stage.tools.editor.PortalDialog (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stage.tools.editor.PortalDialog

+
+No usage of com.threerings.stage.tools.editor.PortalDialog +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/editor/class-use/PortalTool.html b/apidocs/com/threerings/stage/tools/editor/class-use/PortalTool.html new file mode 100644 index 00000000..a867c52e --- /dev/null +++ b/apidocs/com/threerings/stage/tools/editor/class-use/PortalTool.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.stage.tools.editor.PortalTool (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stage.tools.editor.PortalTool

+
+No usage of com.threerings.stage.tools.editor.PortalTool +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/editor/class-use/PreferencesDialog.html b/apidocs/com/threerings/stage/tools/editor/class-use/PreferencesDialog.html new file mode 100644 index 00000000..03b7a956 --- /dev/null +++ b/apidocs/com/threerings/stage/tools/editor/class-use/PreferencesDialog.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.stage.tools.editor.PreferencesDialog (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stage.tools.editor.PreferencesDialog

+
+No usage of com.threerings.stage.tools.editor.PreferencesDialog +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/editor/class-use/SceneInfoPanel.html b/apidocs/com/threerings/stage/tools/editor/class-use/SceneInfoPanel.html new file mode 100644 index 00000000..ce175bc1 --- /dev/null +++ b/apidocs/com/threerings/stage/tools/editor/class-use/SceneInfoPanel.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.stage.tools.editor.SceneInfoPanel (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stage.tools.editor.SceneInfoPanel

+
+No usage of com.threerings.stage.tools.editor.SceneInfoPanel +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/editor/class-use/TestTileLoader.html b/apidocs/com/threerings/stage/tools/editor/class-use/TestTileLoader.html new file mode 100644 index 00000000..cf27fba2 --- /dev/null +++ b/apidocs/com/threerings/stage/tools/editor/class-use/TestTileLoader.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.stage.tools.editor.TestTileLoader (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stage.tools.editor.TestTileLoader

+
+No usage of com.threerings.stage.tools.editor.TestTileLoader +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/editor/class-use/TileInfoPanel.html b/apidocs/com/threerings/stage/tools/editor/class-use/TileInfoPanel.html new file mode 100644 index 00000000..119f22f5 --- /dev/null +++ b/apidocs/com/threerings/stage/tools/editor/class-use/TileInfoPanel.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.stage.tools.editor.TileInfoPanel (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stage.tools.editor.TileInfoPanel

+
+No usage of com.threerings.stage.tools.editor.TileInfoPanel +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/editor/package-frame.html b/apidocs/com/threerings/stage/tools/editor/package-frame.html new file mode 100644 index 00000000..f36b3ba2 --- /dev/null +++ b/apidocs/com/threerings/stage/tools/editor/package-frame.html @@ -0,0 +1,78 @@ + + + + + + + +com.threerings.stage.tools.editor (vilya 1.3 API) + + + + + + + + + + + +com.threerings.stage.tools.editor + + + + +
+Interfaces  + +
+EditorModelListener +
+EditorScenePanel.SceneModelListener
+ + + + + + +
+Classes  + +
+DirectionButton +
+EditorApp +
+EditorConfig +
+EditorDialog +
+EditorFrame +
+EditorModel +
+EditorScenePanel +
+EditorScrollBox +
+EditorTileManager +
+EditorToolBarPanel +
+ObjectEditorDialog +
+PortalDialog +
+PortalTool +
+PreferencesDialog +
+SceneInfoPanel +
+TestTileLoader +
+TileInfoPanel
+ + + + diff --git a/apidocs/com/threerings/stage/tools/editor/package-summary.html b/apidocs/com/threerings/stage/tools/editor/package-summary.html new file mode 100644 index 00000000..8040141b --- /dev/null +++ b/apidocs/com/threerings/stage/tools/editor/package-summary.html @@ -0,0 +1,250 @@ + + + + + + + +com.threerings.stage.tools.editor (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.stage.tools.editor +

+ + + + + + + + + + + + + +
+Interface Summary
EditorModelListenerThe editor model listener interface should be implemented by + classes that would like to be notified when the editor model is + changed.
EditorScenePanel.SceneModelListener 
+  + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Class Summary
DirectionButtonA button that allows for selection from the compass directions.
EditorAppA scene editor application that provides facilities for viewing, editing, and saving the scene + templates that comprise a game.
EditorConfigProvides access to configuration data for the editor.
EditorDialogBasic ok cancel dialog for use by editor components.
EditorFrame 
EditorModelThe EditorModel class provides a holding place for storing, + modifying and retrieving data that is shared across the Editor + application and its myriad UI components.
EditorScenePanelDisplays the scene view and handles UI events on the scene.
EditorScrollBoxA scrollbox that shows our position in the editor.
EditorTileManagerExtends the normal Miso Tile Manager to allow the use of a set of test tiles that can be used in + the editor.
EditorToolBarPanel 
ObjectEditorDialogUsed to edit object attributes.
PortalDialogThe PortalDialog is used to present the user with a dialog + allowing them to enter the information associated with an + EditablePortal.
PortalToolA tool for setting a portal.
PreferencesDialogA dialog for editing preferences.
SceneInfoPanelThe scene info panel presents the user with options to select the scene layer to edit, and + whether to display tile coordinates and locations in the scene view.
TestTileLoaderThe TestTileLoader handles test tiles.
TileInfoPanelThe tile info panel presents the user with options to select the tile to be applied to the + scene.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/editor/package-tree.html b/apidocs/com/threerings/stage/tools/editor/package-tree.html new file mode 100644 index 00000000..7377f092 --- /dev/null +++ b/apidocs/com/threerings/stage/tools/editor/package-tree.html @@ -0,0 +1,226 @@ + + + + + + + +com.threerings.stage.tools.editor Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.stage.tools.editor +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/editor/package-use.html b/apidocs/com/threerings/stage/tools/editor/package-use.html new file mode 100644 index 00000000..16db614f --- /dev/null +++ b/apidocs/com/threerings/stage/tools/editor/package-use.html @@ -0,0 +1,205 @@ + + + + + + + +Uses of Package com.threerings.stage.tools.editor (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.stage.tools.editor

+
+ + + + + + + + + +
+Packages that use com.threerings.stage.tools.editor
com.threerings.stage.tools.editor  
+  +

+ + + + + + + + + + + + + + + + + + + + + + + +
+Classes in com.threerings.stage.tools.editor used by com.threerings.stage.tools.editor
EditorDialog + +
+          Basic ok cancel dialog for use by editor components.
EditorModel + +
+          The EditorModel class provides a holding place for storing, + modifying and retrieving data that is shared across the Editor + application and its myriad UI components.
EditorModelListener + +
+          The editor model listener interface should be implemented by + classes that would like to be notified when the editor model is + changed.
EditorScenePanel + +
+          Displays the scene view and handles UI events on the scene.
EditorScenePanel.SceneModelListener + +
+           
EditorScrollBox + +
+          A scrollbox that shows our position in the editor.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/editor/util/EditorContext.html b/apidocs/com/threerings/stage/tools/editor/util/EditorContext.html new file mode 100644 index 00000000..44c544e7 --- /dev/null +++ b/apidocs/com/threerings/stage/tools/editor/util/EditorContext.html @@ -0,0 +1,284 @@ + + + + + + + +EditorContext (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stage.tools.editor.util +
+Interface EditorContext

+
+
All Superinterfaces:
com.threerings.miso.util.MisoContext, StageContext
+
+
+
+
public interface EditorContext
extends StageContext
+ + +

+

+ +

+ + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidenumerateSceneTypes(List<String> types) + +
+          Inserts all known scene types into the supplied list.
+ com.threerings.media.image.ColorPositorygetColorPository() + +
+          Returns a colorization repository for use by the editor.
+ com.threerings.media.tile.TileSetRepositorygetTileSetRepository() + +
+          Return a reference to the tile set repository in use by the tile + manager.
+  + + + + + + + +
Methods inherited from interface com.threerings.stage.util.StageContext
getComponentRepository, getImageManager, getKeyboardManager, getKeyDispatcher, getMessageManager, getResourceManager, xlate, xlate
+  + + + + + + + +
Methods inherited from interface com.threerings.miso.util.MisoContext
getFrameManager, getTileManager
+  +

+ + + + + + + + +
+Method Detail
+ +

+getTileSetRepository

+
+com.threerings.media.tile.TileSetRepository getTileSetRepository()
+
+
Return a reference to the tile set repository in use by the tile + manager. This reference is valid for the lifetime of the + application. +

+

+
+
+
+
+
+
+
+ +

+getColorPository

+
+com.threerings.media.image.ColorPository getColorPository()
+
+
Returns a colorization repository for use by the editor. +

+

+
Specified by:
getColorPository in interface StageContext
+
+
+
+
+
+
+ +

+enumerateSceneTypes

+
+void enumerateSceneTypes(List<String> types)
+
+
Inserts all known scene types into the supplied list. +

+

+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/editor/util/EditorDialogUtil.html b/apidocs/com/threerings/stage/tools/editor/util/EditorDialogUtil.html new file mode 100644 index 00000000..5f53b0c2 --- /dev/null +++ b/apidocs/com/threerings/stage/tools/editor/util/EditorDialogUtil.html @@ -0,0 +1,377 @@ + + + + + + + +EditorDialogUtil (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stage.tools.editor.util +
+Class EditorDialogUtil

+
+java.lang.Object
+  extended by com.threerings.stage.tools.editor.util.EditorDialogUtil
+
+
+
+
public class EditorDialogUtil
extends Object
+ + +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
EditorDialogUtil() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+static voidaddButton(ActionListener l, + Container container, + String name, + String cmd) + +
+          Add a button to a container with the given parameters and + action listener.
+static voidcenter(JFrame parent, + JInternalFrame dialog) + +
+          Centers the supplied dialog in its parent's bounds.
+static voiddismiss(JInternalFrame dialog) + +
+          Removes the supplied dialog from its parent container, but does not + dispose it.
+static voiddisplay(JFrame parent, + JInternalFrame dialog) + +
+          Display a dialog centered within the given frame.
+static voiddispose(JInternalFrame dialog) + +
+          Handles safely dismissing and disposing of the supplied dialog.
+static JComboBoxgetOrientationComboBox(ActionListener l) + +
+          Create and return a combo box seeded with the various possible + orientation direction names.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+EditorDialogUtil

+
+public EditorDialogUtil()
+
+
+ + + + + + + + +
+Method Detail
+ +

+addButton

+
+public static void addButton(ActionListener l,
+                             Container container,
+                             String name,
+                             String cmd)
+
+
Add a button to a container with the given parameters and + action listener. +

+

+
Parameters:
l - the listener.
container - the container.
name - the button name.
cmd - the action command.
+
+
+
+ +

+getOrientationComboBox

+
+public static JComboBox getOrientationComboBox(ActionListener l)
+
+
Create and return a combo box seeded with the various possible + orientation direction names. +

+

+
Parameters:
l - the listener. +
Returns:
the combo box.
+
+
+
+ +

+center

+
+public static void center(JFrame parent,
+                          JInternalFrame dialog)
+
+
Centers the supplied dialog in its parent's bounds. +

+

+
+
+
+
+ +

+display

+
+public static void display(JFrame parent,
+                           JInternalFrame dialog)
+
+
Display a dialog centered within the given frame. +

+

+
Parameters:
parent - the parent frame.
dialog - the dialog.
+
+
+
+ +

+dismiss

+
+public static void dismiss(JInternalFrame dialog)
+
+
Removes the supplied dialog from its parent container, but does not + dispose it. +

+

+
+
+
+
+ +

+dispose

+
+public static void dispose(JInternalFrame dialog)
+
+
Handles safely dismissing and disposing of the supplied dialog. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/editor/util/ExtrasPainter.html b/apidocs/com/threerings/stage/tools/editor/util/ExtrasPainter.html new file mode 100644 index 00000000..05c40fbe --- /dev/null +++ b/apidocs/com/threerings/stage/tools/editor/util/ExtrasPainter.html @@ -0,0 +1,214 @@ + + + + + + + +ExtrasPainter (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stage.tools.editor.util +
+Interface ExtrasPainter

+
+
All Known Implementing Classes:
PortalTool
+
+
+
+
public interface ExtrasPainter
+ + +

+An interface for painting extra stuff. +

+ +

+

+ +

+ + + + + + + + + + + + +
+Method Summary
+ voidpaintExtras(Graphics2D gfx) + +
+           
+  +

+ + + + + + + + +
+Method Detail
+ +

+paintExtras

+
+void paintExtras(Graphics2D gfx)
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/editor/util/TileSetUtil.html b/apidocs/com/threerings/stage/tools/editor/util/TileSetUtil.html new file mode 100644 index 00000000..6a02f78d --- /dev/null +++ b/apidocs/com/threerings/stage/tools/editor/util/TileSetUtil.html @@ -0,0 +1,262 @@ + + + + + + + +TileSetUtil (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stage.tools.editor.util +
+Class TileSetUtil

+
+java.lang.Object
+  extended by com.threerings.stage.tools.editor.util.TileSetUtil
+
+
+
+
public class TileSetUtil
extends Object
+ + +

+Miscellaneous useful routines for working with lists of TileSet + and BaseTileSet objects. +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
TileSetUtil() + +
+           
+  + + + + + + + + + + + +
+Method Summary
+static intgetLayerIndex(com.threerings.media.tile.TileSet set) + +
+          Returns the layer index of the layer for which this tileset + provides tiles.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+TileSetUtil

+
+public TileSetUtil()
+
+
+ + + + + + + + +
+Method Detail
+ +

+getLayerIndex

+
+public static int getLayerIndex(com.threerings.media.tile.TileSet set)
+
+
Returns the layer index of the layer for which this tileset + provides tiles. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/editor/util/class-use/EditorContext.html b/apidocs/com/threerings/stage/tools/editor/util/class-use/EditorContext.html new file mode 100644 index 00000000..31ba3182 --- /dev/null +++ b/apidocs/com/threerings/stage/tools/editor/util/class-use/EditorContext.html @@ -0,0 +1,236 @@ + + + + + + + +Uses of Interface com.threerings.stage.tools.editor.util.EditorContext (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.stage.tools.editor.util.EditorContext

+
+ + + + + + + + + +
+Packages that use EditorContext
com.threerings.stage.tools.editor  
+  +

+ + + + + +
+Uses of EditorContext in com.threerings.stage.tools.editor
+  +

+ + + + + + + + + +
Methods in com.threerings.stage.tools.editor with parameters of type EditorContext
+ voidEditorFrame.init(EditorContext ctx, + String target) + +
+           
+  +

+ + + + + + + + + + + + + + + + + + + + + + + +
Constructors in com.threerings.stage.tools.editor with parameters of type EditorContext
EditorDialog(String title, + EditorContext ctx, + EditorScenePanel panel) + +
+           
EditorScenePanel(EditorContext ctx, + JFrame frame, + EditorModel model, + EditorScenePanel.SceneModelListener sceneListener) + +
+          Constructs the editor scene view panel.
ObjectEditorDialog(EditorContext ctx, + EditorScenePanel panel) + +
+           
PortalDialog(EditorContext ctx, + EditorScenePanel panel) + +
+          Constructs the portal dialog.
SceneInfoPanel(EditorContext ctx, + EditorModel model, + EditorScenePanel svpanel) + +
+          Constructs the scene info panel.
TileInfoPanel(EditorContext ctx, + EditorModel model) + +
+          Constructs the tile info panel.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/editor/util/class-use/EditorDialogUtil.html b/apidocs/com/threerings/stage/tools/editor/util/class-use/EditorDialogUtil.html new file mode 100644 index 00000000..405883a5 --- /dev/null +++ b/apidocs/com/threerings/stage/tools/editor/util/class-use/EditorDialogUtil.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.stage.tools.editor.util.EditorDialogUtil (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stage.tools.editor.util.EditorDialogUtil

+
+No usage of com.threerings.stage.tools.editor.util.EditorDialogUtil +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/editor/util/class-use/ExtrasPainter.html b/apidocs/com/threerings/stage/tools/editor/util/class-use/ExtrasPainter.html new file mode 100644 index 00000000..b6e3db29 --- /dev/null +++ b/apidocs/com/threerings/stage/tools/editor/util/class-use/ExtrasPainter.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Interface com.threerings.stage.tools.editor.util.ExtrasPainter (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.stage.tools.editor.util.ExtrasPainter

+
+ + + + + + + + + +
+Packages that use ExtrasPainter
com.threerings.stage.tools.editor  
+  +

+ + + + + +
+Uses of ExtrasPainter in com.threerings.stage.tools.editor
+  +

+ + + + + + + + + +
Classes in com.threerings.stage.tools.editor that implement ExtrasPainter
+ classPortalTool + +
+          A tool for setting a portal.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/editor/util/class-use/TileSetUtil.html b/apidocs/com/threerings/stage/tools/editor/util/class-use/TileSetUtil.html new file mode 100644 index 00000000..aed441e7 --- /dev/null +++ b/apidocs/com/threerings/stage/tools/editor/util/class-use/TileSetUtil.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.stage.tools.editor.util.TileSetUtil (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stage.tools.editor.util.TileSetUtil

+
+No usage of com.threerings.stage.tools.editor.util.TileSetUtil +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/editor/util/package-frame.html b/apidocs/com/threerings/stage/tools/editor/util/package-frame.html new file mode 100644 index 00000000..b05a5334 --- /dev/null +++ b/apidocs/com/threerings/stage/tools/editor/util/package-frame.html @@ -0,0 +1,48 @@ + + + + + + + +com.threerings.stage.tools.editor.util (vilya 1.3 API) + + + + + + + + + + + +com.threerings.stage.tools.editor.util + + + + +
+Interfaces  + +
+EditorContext +
+ExtrasPainter
+ + + + + + +
+Classes  + +
+EditorDialogUtil +
+TileSetUtil
+ + + + diff --git a/apidocs/com/threerings/stage/tools/editor/util/package-summary.html b/apidocs/com/threerings/stage/tools/editor/util/package-summary.html new file mode 100644 index 00000000..8a35de97 --- /dev/null +++ b/apidocs/com/threerings/stage/tools/editor/util/package-summary.html @@ -0,0 +1,181 @@ + + + + + + + +com.threerings.stage.tools.editor.util (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.stage.tools.editor.util +

+ + + + + + + + + + + + + +
+Interface Summary
EditorContext 
ExtrasPainterAn interface for painting extra stuff.
+  + +

+ + + + + + + + + + + + + +
+Class Summary
EditorDialogUtil 
TileSetUtilMiscellaneous useful routines for working with lists of TileSet + and BaseTileSet objects.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/editor/util/package-tree.html b/apidocs/com/threerings/stage/tools/editor/util/package-tree.html new file mode 100644 index 00000000..8c661bb1 --- /dev/null +++ b/apidocs/com/threerings/stage/tools/editor/util/package-tree.html @@ -0,0 +1,163 @@ + + + + + + + +com.threerings.stage.tools.editor.util Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.stage.tools.editor.util +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/editor/util/package-use.html b/apidocs/com/threerings/stage/tools/editor/util/package-use.html new file mode 100644 index 00000000..7b3c0ec4 --- /dev/null +++ b/apidocs/com/threerings/stage/tools/editor/util/package-use.html @@ -0,0 +1,177 @@ + + + + + + + +Uses of Package com.threerings.stage.tools.editor.util (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.stage.tools.editor.util

+
+ + + + + + + + + +
+Packages that use com.threerings.stage.tools.editor.util
com.threerings.stage.tools.editor  
+  +

+ + + + + + + + + + + +
+Classes in com.threerings.stage.tools.editor.util used by com.threerings.stage.tools.editor
EditorContext + +
+           
ExtrasPainter + +
+          An interface for painting extra stuff.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/viewer/ViewerApp.html b/apidocs/com/threerings/stage/tools/viewer/ViewerApp.html new file mode 100644 index 00000000..1f1c8a8f --- /dev/null +++ b/apidocs/com/threerings/stage/tools/viewer/ViewerApp.html @@ -0,0 +1,288 @@ + + + + + + + +ViewerApp (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stage.tools.viewer +
+Class ViewerApp

+
+java.lang.Object
+  extended by com.threerings.stage.tools.viewer.ViewerApp
+
+
+
+
public class ViewerApp
extends Object
+ + +

+The ViewerApp is a scene viewing application that allows for trying out + Stage scenes in a pseudo-runtime environment. +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
ViewerApp(String[] args) + +
+          Construct and initialize the ViewerApp object.
+  + + + + + + + + + + + + + + + +
+Method Summary
+static voidmain(String[] args) + +
+          Instantiate the application object and start it running.
+ voidrun() + +
+          Run the application.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+ViewerApp

+
+public ViewerApp(String[] args)
+          throws IOException
+
+
Construct and initialize the ViewerApp object. +

+

+ +
Throws: +
IOException
+
+ + + + + + + + +
+Method Detail
+ +

+run

+
+public void run()
+
+
Run the application. +

+

+
+
+
+
+ +

+main

+
+public static void main(String[] args)
+
+
Instantiate the application object and start it running. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/viewer/ViewerFrame.html b/apidocs/com/threerings/stage/tools/viewer/ViewerFrame.html new file mode 100644 index 00000000..275fe383 --- /dev/null +++ b/apidocs/com/threerings/stage/tools/viewer/ViewerFrame.html @@ -0,0 +1,499 @@ + + + + + + + +ViewerFrame (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stage.tools.viewer +
+Class ViewerFrame

+
+java.lang.Object
+  extended by java.awt.Component
+      extended by java.awt.Container
+          extended by java.awt.Window
+              extended by java.awt.Frame
+                  extended by javax.swing.JFrame
+                      extended by com.threerings.media.ManagedJFrame
+                          extended by com.threerings.stage.tools.viewer.ViewerFrame
+
+
+
All Implemented Interfaces:
com.threerings.media.FrameManager.ManagedRoot, ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants
+
+
+
+
public class ViewerFrame
extends com.threerings.media.ManagedJFrame
+ + +

+The viewer frame is the main application window. +

+ +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class java.awt.Component
Component.BaselineResizeBehavior
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class javax.swing.JFrame
EXIT_ON_CLOSE
+  + + + + + + + +
Fields inherited from class java.awt.Frame
CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR
+  + + + + + + + +
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
+  + + + + + + + +
Fields inherited from interface javax.swing.WindowConstants
DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE
+  + + + + + + + +
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
+  + + + + + + + + + + +
+Constructor Summary
ViewerFrame(GraphicsConfiguration gc) + +
+          Creates a frame in which the viewer application can operate.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidgetJiggy(ActionEvent event) + +
+           
+ voidhandleQuit(ActionEvent evt) + +
+          Handles a request to get the fuck out of dodge.
+ voidinit(StageContext ctx, + com.threerings.cast.CharacterManager charmgr) + +
+          Instructs us to create our scene panel.
+ voidloadScene(String path) + +
+           
+ voidopenScene(ActionEvent event) + +
+          Callback for opening a new scene.
+  + + + + + + + +
Methods inherited from class com.threerings.media.ManagedJFrame
getFrameManager, getWindow, init, paint, update
+  + + + + + + + +
Methods inherited from class javax.swing.JFrame
getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setTransferHandler
+  + + + + + + + +
Methods inherited from class java.awt.Frame
addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setResizable, setState, setTitle, setUndecorated
+  + + + + + + + +
Methods inherited from class java.awt.Window
addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOwnedWindows, getOwner, getOwnerlessWindows, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setVisible, show, toBack, toFront
+  + + + + + + + +
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusBackward, transferFocusDownCycle, validate
+  + + + + + + + +
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, dispatchEvent, enable, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocusInWindow, resize, resize, setBackground, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusUpCycle
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  + + + + + + + +
Methods inherited from interface com.threerings.media.FrameManager.ManagedRoot
getRootPane
+  + + + + + + + +
Methods inherited from interface java.awt.MenuContainer
getFont, postEvent
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+ViewerFrame

+
+public ViewerFrame(GraphicsConfiguration gc)
+
+
Creates a frame in which the viewer application can operate. +

+

+ + + + + + + + +
+Method Detail
+ +

+init

+
+public void init(StageContext ctx,
+                 com.threerings.cast.CharacterManager charmgr)
+
+
Instructs us to create our scene panel. +

+

+
+
+
+
+ +

+openScene

+
+public void openScene(ActionEvent event)
+
+
Callback for opening a new scene. +

+

+
+
+
+
+ +

+getJiggy

+
+public void getJiggy(ActionEvent event)
+
+
+
+
+
+
+ +

+handleQuit

+
+public void handleQuit(ActionEvent evt)
+
+
Handles a request to get the fuck out of dodge. +

+

+
+
+
+
+ +

+loadScene

+
+public void loadScene(String path)
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/viewer/ViewerScenePanel.html b/apidocs/com/threerings/stage/tools/viewer/ViewerScenePanel.html new file mode 100644 index 00000000..3c908c1a --- /dev/null +++ b/apidocs/com/threerings/stage/tools/viewer/ViewerScenePanel.html @@ -0,0 +1,590 @@ + + + + + + + +ViewerScenePanel (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stage.tools.viewer +
+Class ViewerScenePanel

+
+java.lang.Object
+  extended by java.awt.Component
+      extended by java.awt.Container
+          extended by javax.swing.JComponent
+              extended by com.threerings.media.MediaPanel
+                  extended by com.threerings.media.VirtualMediaPanel
+                      extended by com.threerings.miso.client.MisoScenePanel
+                          extended by com.threerings.stage.client.StageScenePanel
+                              extended by com.threerings.stage.tools.viewer.ViewerScenePanel
+
+
+
All Implemented Interfaces:
ControllerProvider, RadialMenu.Host, com.threerings.crowd.client.PlaceView, com.threerings.media.FrameParticipant, com.threerings.media.MediaConstants, com.threerings.media.MediaHost, com.threerings.media.sprite.PathObserver, com.threerings.media.util.AStarPathUtil.TraversalPred, com.threerings.media.util.PerformanceObserver, KeyListener, MouseListener, MouseMotionListener, ImageObserver, MenuContainer, Serializable, EventListener
+
+
+
+
public class ViewerScenePanel
extends StageScenePanel
implements com.threerings.media.util.PerformanceObserver, com.threerings.media.sprite.PathObserver
+ + +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.media.MediaPanel
com.threerings.media.MediaPanel.Obscurer
+  + + + + + + + + +
Nested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent
+  + + + + + + + + +
Nested classes/interfaces inherited from class java.awt.Component
Component.BaselineResizeBehavior
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class com.threerings.stage.client.StageScenePanel
CLUSTER_CLICKED, LOCATION_CLICKED, SHOW_CLUSTERS, SHOW_PLOTS
+  + + + + + + + +
Fields inherited from class com.threerings.miso.client.MisoScenePanel
SHOW_TIPS
+  + + + + + + + +
Fields inherited from class com.threerings.media.VirtualMediaPanel
CENTER_ON_PATHABLE, ENCLOSE_PATHABLE, TRACK_PATHABLE
+  + + + + + + + +
Fields inherited from class javax.swing.JComponent
TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
+  + + + + + + + +
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
+  + + + + + + + +
Fields inherited from interface com.threerings.media.MediaConstants
ALL, BACK, FRONT
+  + + + + + + + +
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
+  + + + + + + + + + + +
+Constructor Summary
ViewerScenePanel(StageContext ctx, + com.threerings.cast.CharacterManager charmgr) + +
+          Construct the panel and initialize it with a context.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidcheckpoint(String name, + int ticks) + +
+           
+ voidcreateDecoys() + +
+          Creates the decoy sprites.
+ voidmousePressed(MouseEvent e) + +
+           
+ voidpaint(Graphics g) + +
+           
+ voidpathCancelled(com.threerings.media.sprite.Sprite sprite, + com.threerings.media.util.Path path) + +
+           
+ voidpathCompleted(com.threerings.media.sprite.Sprite sprite, + com.threerings.media.util.Path path, + long when) + +
+           
+ voidsetScene(StageScene scene, + Location defloc) + +
+           
+  + + + + + + + +
Methods inherited from class com.threerings.stage.client.StageScenePanel
didLeavePlace, getColorizer, getController, getPortal, getScene, keyPressed, keyReleased, keyTyped, removeCluster, sceneUpdated, setScene, updateCluster, willEnterPlace
+  + + + + + + + +
Methods inherited from class com.threerings.miso.client.MisoScenePanel
addNotify, canTraverse, centerOnTile, checkShowFlag, clearRadialMenu, computeIndicators, computeInfluentialBounds, enumerateResolvedBlocks, getBlock, getComponent, getFullCoords, getHoverCoords, getHoverObject, getPath, getSceneMetrics, getSceneModel, getScreenCoords, getTileCoords, getViewBounds, menuDeactivated, mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, mouseReleased, pressObject, refreshScene, removeNotify, repaintRect, reportMemoryUsage, setBounds, setSceneModel, setShowFlags
+  + + + + + + + +
Methods inherited from class com.threerings.media.VirtualMediaPanel
addViewTracker, clearPathable, doLayout, removeViewTracker, setBackground, setFollowsPathable, setViewLocation
+  + + + + + + + +
Methods inherited from class com.threerings.media.MediaPanel
abortAnimation, addAnimation, addObscurer, addSprite, clearAnimations, clearSprites, createGraphics, getAnimationManager, getRegionManager, getSpriteManager, getTimeStamp, isManaged, isManaged, needsPaint, removeObscurer, removeSprite, repaint, setOpaque, setPaused, tick
+  + + + + + + + +
Methods inherited from class javax.swing.JComponent
addAncestorListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI
+  + + + + + + + +
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate
+  + + + + + + + +
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+ViewerScenePanel

+
+public ViewerScenePanel(StageContext ctx,
+                        com.threerings.cast.CharacterManager charmgr)
+
+
Construct the panel and initialize it with a context. +

+

+ + + + + + + + +
+Method Detail
+ +

+setScene

+
+public void setScene(StageScene scene,
+                     Location defloc)
+
+
+
+
+
+
+
+
+
+ +

+createDecoys

+
+public void createDecoys()
+
+
Creates the decoy sprites. +

+

+
+
+
+
+
+
+
+ +

+paint

+
+public void paint(Graphics g)
+
+
+
Overrides:
paint in class com.threerings.miso.client.MisoScenePanel
+
+
+
+
+
+
+ +

+checkpoint

+
+public void checkpoint(String name,
+                       int ticks)
+
+
+
Specified by:
checkpoint in interface com.threerings.media.util.PerformanceObserver
+
+
+
+
+
+
+ +

+mousePressed

+
+public void mousePressed(MouseEvent e)
+
+
+
Specified by:
mousePressed in interface MouseListener
Overrides:
mousePressed in class com.threerings.miso.client.MisoScenePanel
+
+
+
+
+
+
+ +

+pathCancelled

+
+public void pathCancelled(com.threerings.media.sprite.Sprite sprite,
+                          com.threerings.media.util.Path path)
+
+
+
Specified by:
pathCancelled in interface com.threerings.media.sprite.PathObserver
+
+
+
+
+
+
+ +

+pathCompleted

+
+public void pathCompleted(com.threerings.media.sprite.Sprite sprite,
+                          com.threerings.media.util.Path path,
+                          long when)
+
+
+
Specified by:
pathCompleted in interface com.threerings.media.sprite.PathObserver
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/viewer/class-use/ViewerApp.html b/apidocs/com/threerings/stage/tools/viewer/class-use/ViewerApp.html new file mode 100644 index 00000000..06c00cdd --- /dev/null +++ b/apidocs/com/threerings/stage/tools/viewer/class-use/ViewerApp.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.stage.tools.viewer.ViewerApp (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stage.tools.viewer.ViewerApp

+
+No usage of com.threerings.stage.tools.viewer.ViewerApp +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/viewer/class-use/ViewerFrame.html b/apidocs/com/threerings/stage/tools/viewer/class-use/ViewerFrame.html new file mode 100644 index 00000000..7954442f --- /dev/null +++ b/apidocs/com/threerings/stage/tools/viewer/class-use/ViewerFrame.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.stage.tools.viewer.ViewerFrame (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stage.tools.viewer.ViewerFrame

+
+No usage of com.threerings.stage.tools.viewer.ViewerFrame +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/viewer/class-use/ViewerScenePanel.html b/apidocs/com/threerings/stage/tools/viewer/class-use/ViewerScenePanel.html new file mode 100644 index 00000000..8eb0db4d --- /dev/null +++ b/apidocs/com/threerings/stage/tools/viewer/class-use/ViewerScenePanel.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.stage.tools.viewer.ViewerScenePanel (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stage.tools.viewer.ViewerScenePanel

+
+No usage of com.threerings.stage.tools.viewer.ViewerScenePanel +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/viewer/package-frame.html b/apidocs/com/threerings/stage/tools/viewer/package-frame.html new file mode 100644 index 00000000..1fccbb77 --- /dev/null +++ b/apidocs/com/threerings/stage/tools/viewer/package-frame.html @@ -0,0 +1,37 @@ + + + + + + + +com.threerings.stage.tools.viewer (vilya 1.3 API) + + + + + + + + + + + +com.threerings.stage.tools.viewer + + + + +
+Classes  + +
+ViewerApp +
+ViewerFrame +
+ViewerScenePanel
+ + + + diff --git a/apidocs/com/threerings/stage/tools/viewer/package-summary.html b/apidocs/com/threerings/stage/tools/viewer/package-summary.html new file mode 100644 index 00000000..1bdde65a --- /dev/null +++ b/apidocs/com/threerings/stage/tools/viewer/package-summary.html @@ -0,0 +1,167 @@ + + + + + + + +com.threerings.stage.tools.viewer (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.stage.tools.viewer +

+ + + + + + + + + + + + + + + + + +
+Class Summary
ViewerAppThe ViewerApp is a scene viewing application that allows for trying out + Stage scenes in a pseudo-runtime environment.
ViewerFrameThe viewer frame is the main application window.
ViewerScenePanel 
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/viewer/package-tree.html b/apidocs/com/threerings/stage/tools/viewer/package-tree.html new file mode 100644 index 00000000..2d31eb84 --- /dev/null +++ b/apidocs/com/threerings/stage/tools/viewer/package-tree.html @@ -0,0 +1,186 @@ + + + + + + + +com.threerings.stage.tools.viewer Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.stage.tools.viewer +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/viewer/package-use.html b/apidocs/com/threerings/stage/tools/viewer/package-use.html new file mode 100644 index 00000000..62b691b6 --- /dev/null +++ b/apidocs/com/threerings/stage/tools/viewer/package-use.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Package com.threerings.stage.tools.viewer (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.stage.tools.viewer

+
+No usage of com.threerings.stage.tools.viewer +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/xml/StageMisoSceneRuleSet.html b/apidocs/com/threerings/stage/tools/xml/StageMisoSceneRuleSet.html new file mode 100644 index 00000000..0e47f19c --- /dev/null +++ b/apidocs/com/threerings/stage/tools/xml/StageMisoSceneRuleSet.html @@ -0,0 +1,242 @@ + + + + + + + +StageMisoSceneRuleSet (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stage.tools.xml +
+Class StageMisoSceneRuleSet

+
+java.lang.Object
+  extended by com.threerings.miso.tools.xml.SparseMisoSceneRuleSet
+      extended by com.threerings.stage.tools.xml.StageMisoSceneRuleSet
+
+
+
All Implemented Interfaces:
com.threerings.tools.xml.NestableRuleSet
+
+
+
+
public class StageMisoSceneRuleSet
extends com.threerings.miso.tools.xml.SparseMisoSceneRuleSet
+ + +

+Customizes the miso scene rule set such that it creates StageMisoSceneModel instances. +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
StageMisoSceneRuleSet() + +
+           
+  + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from class com.threerings.miso.tools.xml.SparseMisoSceneRuleSet
addObjectExtractor, addRuleInstances, getOuterElement
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+StageMisoSceneRuleSet

+
+public StageMisoSceneRuleSet()
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/xml/StageSceneParser.html b/apidocs/com/threerings/stage/tools/xml/StageSceneParser.html new file mode 100644 index 00000000..0befefc6 --- /dev/null +++ b/apidocs/com/threerings/stage/tools/xml/StageSceneParser.html @@ -0,0 +1,271 @@ + + + + + + + +StageSceneParser (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stage.tools.xml +
+Class StageSceneParser

+
+java.lang.Object
+  extended by com.threerings.whirled.tools.xml.SceneParser
+      extended by com.threerings.stage.tools.xml.StageSceneParser
+
+
+
+
public class StageSceneParser
extends SceneParser
+ + +

+Parses StageSceneModel instances from an XML description file. +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
StageSceneParser() + +
+          Constructs a parser that can be used to parse Stage scene models.
+  + + + + + + + + + + + +
+Method Summary
+static voidmain(String[] args) + +
+          A simple hook for parsing a single scene from the command line.
+  + + + + + + + +
Methods inherited from class com.threerings.whirled.tools.xml.SceneParser
parseScene, registerAuxRuleSet, setScene
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+StageSceneParser

+
+public StageSceneParser()
+
+
Constructs a parser that can be used to parse Stage scene models. +

+

+ + + + + + + + +
+Method Detail
+ +

+main

+
+public static void main(String[] args)
+
+
A simple hook for parsing a single scene from the command line. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/xml/StageSceneRuleSet.html b/apidocs/com/threerings/stage/tools/xml/StageSceneRuleSet.html new file mode 100644 index 00000000..05a53f21 --- /dev/null +++ b/apidocs/com/threerings/stage/tools/xml/StageSceneRuleSet.html @@ -0,0 +1,242 @@ + + + + + + + +StageSceneRuleSet (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stage.tools.xml +
+Class StageSceneRuleSet

+
+java.lang.Object
+  extended by com.threerings.whirled.tools.xml.SceneRuleSet
+      extended by com.threerings.stage.tools.xml.StageSceneRuleSet
+
+
+
All Implemented Interfaces:
com.threerings.tools.xml.NestableRuleSet
+
+
+
+
public class StageSceneRuleSet
extends SceneRuleSet
+ + +

+Used to parse an StageScene from XML. +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
StageSceneRuleSet() + +
+           
+  + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from class com.threerings.whirled.tools.xml.SceneRuleSet
addRuleInstances, getOuterElement
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+StageSceneRuleSet

+
+public StageSceneRuleSet()
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/xml/StageSceneWriter.html b/apidocs/com/threerings/stage/tools/xml/StageSceneWriter.html new file mode 100644 index 00000000..63f043f7 --- /dev/null +++ b/apidocs/com/threerings/stage/tools/xml/StageSceneWriter.html @@ -0,0 +1,257 @@ + + + + + + + +StageSceneWriter (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stage.tools.xml +
+Class StageSceneWriter

+
+java.lang.Object
+  extended by com.threerings.whirled.tools.xml.SceneWriter
+      extended by com.threerings.stage.tools.xml.StageSceneWriter
+
+
+
+
public class StageSceneWriter
extends SceneWriter
+ + +

+Generates an XML representation of a StageSceneModel. +

+ +

+

+ +

+ + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class com.threerings.whirled.tools.xml.SceneWriter
OUTER_ELEMENT
+  + + + + + + + + + + +
+Constructor Summary
StageSceneWriter() + +
+           
+  + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from class com.threerings.whirled.tools.xml.SceneWriter
registerAuxWriter, writeScene, writeSceneModel
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+StageSceneWriter

+
+public StageSceneWriter()
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/xml/class-use/StageMisoSceneRuleSet.html b/apidocs/com/threerings/stage/tools/xml/class-use/StageMisoSceneRuleSet.html new file mode 100644 index 00000000..bc03d44b --- /dev/null +++ b/apidocs/com/threerings/stage/tools/xml/class-use/StageMisoSceneRuleSet.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.stage.tools.xml.StageMisoSceneRuleSet (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stage.tools.xml.StageMisoSceneRuleSet

+
+No usage of com.threerings.stage.tools.xml.StageMisoSceneRuleSet +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/xml/class-use/StageSceneParser.html b/apidocs/com/threerings/stage/tools/xml/class-use/StageSceneParser.html new file mode 100644 index 00000000..e2a20f32 --- /dev/null +++ b/apidocs/com/threerings/stage/tools/xml/class-use/StageSceneParser.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.stage.tools.xml.StageSceneParser (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stage.tools.xml.StageSceneParser

+
+No usage of com.threerings.stage.tools.xml.StageSceneParser +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/xml/class-use/StageSceneRuleSet.html b/apidocs/com/threerings/stage/tools/xml/class-use/StageSceneRuleSet.html new file mode 100644 index 00000000..830ebd27 --- /dev/null +++ b/apidocs/com/threerings/stage/tools/xml/class-use/StageSceneRuleSet.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.stage.tools.xml.StageSceneRuleSet (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stage.tools.xml.StageSceneRuleSet

+
+No usage of com.threerings.stage.tools.xml.StageSceneRuleSet +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/xml/class-use/StageSceneWriter.html b/apidocs/com/threerings/stage/tools/xml/class-use/StageSceneWriter.html new file mode 100644 index 00000000..41b372c9 --- /dev/null +++ b/apidocs/com/threerings/stage/tools/xml/class-use/StageSceneWriter.html @@ -0,0 +1,179 @@ + + + + + + + +Uses of Class com.threerings.stage.tools.xml.StageSceneWriter (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stage.tools.xml.StageSceneWriter

+
+ + + + + + + + + +
+Packages that use StageSceneWriter
com.threerings.stage.tools.editor  
+  +

+ + + + + +
+Uses of StageSceneWriter in com.threerings.stage.tools.editor
+  +

+ + + + + + + + +
Constructors in com.threerings.stage.tools.editor with parameters of type StageSceneWriter
EditorFrame(StageSceneWriter writer) + +
+           
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/xml/package-frame.html b/apidocs/com/threerings/stage/tools/xml/package-frame.html new file mode 100644 index 00000000..18906d73 --- /dev/null +++ b/apidocs/com/threerings/stage/tools/xml/package-frame.html @@ -0,0 +1,39 @@ + + + + + + + +com.threerings.stage.tools.xml (vilya 1.3 API) + + + + + + + + + + + +com.threerings.stage.tools.xml + + + + +
+Classes  + +
+StageMisoSceneRuleSet +
+StageSceneParser +
+StageSceneRuleSet +
+StageSceneWriter
+ + + + diff --git a/apidocs/com/threerings/stage/tools/xml/package-summary.html b/apidocs/com/threerings/stage/tools/xml/package-summary.html new file mode 100644 index 00000000..cbf8706e --- /dev/null +++ b/apidocs/com/threerings/stage/tools/xml/package-summary.html @@ -0,0 +1,170 @@ + + + + + + + +com.threerings.stage.tools.xml (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.stage.tools.xml +

+ + + + + + + + + + + + + + + + + + + + + +
+Class Summary
StageMisoSceneRuleSetCustomizes the miso scene rule set such that it creates StageMisoSceneModel instances.
StageSceneParserParses StageSceneModel instances from an XML description file.
StageSceneRuleSetUsed to parse an StageScene from XML.
StageSceneWriterGenerates an XML representation of a StageSceneModel.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/xml/package-tree.html b/apidocs/com/threerings/stage/tools/xml/package-tree.html new file mode 100644 index 00000000..d3e1c2ae --- /dev/null +++ b/apidocs/com/threerings/stage/tools/xml/package-tree.html @@ -0,0 +1,164 @@ + + + + + + + +com.threerings.stage.tools.xml Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.stage.tools.xml +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/tools/xml/package-use.html b/apidocs/com/threerings/stage/tools/xml/package-use.html new file mode 100644 index 00000000..b4aa1d70 --- /dev/null +++ b/apidocs/com/threerings/stage/tools/xml/package-use.html @@ -0,0 +1,171 @@ + + + + + + + +Uses of Package com.threerings.stage.tools.xml (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.stage.tools.xml

+
+ + + + + + + + + +
+Packages that use com.threerings.stage.tools.xml
com.threerings.stage.tools.editor  
+  +

+ + + + + + + + +
+Classes in com.threerings.stage.tools.xml used by com.threerings.stage.tools.editor
StageSceneWriter + +
+          Generates an XML representation of a StageSceneModel.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/util/PlacementConstraints.html b/apidocs/com/threerings/stage/util/PlacementConstraints.html new file mode 100644 index 00000000..4c834f2a --- /dev/null +++ b/apidocs/com/threerings/stage/util/PlacementConstraints.html @@ -0,0 +1,422 @@ + + + + + + + +PlacementConstraints (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stage.util +
+Class PlacementConstraints

+
+java.lang.Object
+  extended by com.threerings.stage.util.PlacementConstraints
+
+
+
All Implemented Interfaces:
com.threerings.presents.data.InvocationCodes, StageCodes, com.threerings.util.DirectionCodes
+
+
+
+
public class PlacementConstraints
extends Object
implements com.threerings.util.DirectionCodes, StageCodes
+ + +

+Maintains extra information on objects in a scene and checks proposed + placement operations for constraint violations. When the constraints + object is in use, all placement operations (object additions and removals) + must go through the constraints object so that the object's internal state + remains consistent. +

+ +

+

+ +

+ + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from interface com.threerings.util.DirectionCodes
CARDINAL_DIRECTIONS, CCW, CW, DIRECTION_COUNT, DOWN, EAST, EASTNORTHEAST, EASTSOUTHEAST, FINE_DIRECTION_COUNT, HORIZONTAL, LEFT, NONE, NORTH, NORTHEAST, NORTHNORTHEAST, NORTHNORTHWEST, NORTHWEST, RIGHT, SOUTH, SOUTHEAST, SOUTHSOUTHEAST, SOUTHSOUTHWEST, SOUTHWEST, UP, VERTICAL, WEST, WESTNORTHWEST, WESTSOUTHWEST
+  + + + + + + + +
Fields inherited from interface com.threerings.stage.data.StageCodes
ERR_CANNOT_CLUSTER, ERR_NO_OVERLAP, MODIFY_SCENE_ACCESS, MUTILATE_SCENE_ACCESS, STAGE_MESSAGE_BUNDLE, TILESET_RSRC_SET
+  + + + + + + + +
Fields inherited from interface com.threerings.presents.data.InvocationCodes
ACCESS_DENIED, E_ACCESS_DENIED, E_INTERNAL_ERROR, GLOBAL_GROUP, INTERNAL_ERROR
+  + + + + + + + + + + +
+Constructor Summary
PlacementConstraints(com.threerings.media.tile.TileManager tilemgr, + StageScene scene) + +
+          Default constructor.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidaddObject(com.threerings.miso.data.ObjectInfo info) + +
+          Adds the specified object through the constraints.
+ StringallowAddObject(com.threerings.miso.data.ObjectInfo info) + +
+          Determines whether the constraints allow the specified object to be + added to the scene.
+ StringallowModifyObjects(com.threerings.miso.data.ObjectInfo[] added, + com.threerings.miso.data.ObjectInfo[] removed) + +
+          Determines whether the constraints allow the specified objects to be + added and removed simultaneously.
+ StringallowRemoveObject(com.threerings.miso.data.ObjectInfo info) + +
+          Determines whether the constraints allow the specified object to be + removed from the scene.
+ voidremoveObject(com.threerings.miso.data.ObjectInfo info) + +
+          Removes the specified object through the constraints.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+PlacementConstraints

+
+public PlacementConstraints(com.threerings.media.tile.TileManager tilemgr,
+                            StageScene scene)
+
+
Default constructor. +

+

+ + + + + + + + +
+Method Detail
+ +

+allowAddObject

+
+public String allowAddObject(com.threerings.miso.data.ObjectInfo info)
+
+
Determines whether the constraints allow the specified object to be + added to the scene. +

+

+
+
+
+ +
Returns:
null if the constraints allow the operation, + otherwise a translatable string explaining why the object can't be + added
+
+
+
+ +

+addObject

+
+public void addObject(com.threerings.miso.data.ObjectInfo info)
+
+
Adds the specified object through the constraints. +

+

+
+
+
+
+
+
+
+ +

+allowRemoveObject

+
+public String allowRemoveObject(com.threerings.miso.data.ObjectInfo info)
+
+
Determines whether the constraints allow the specified object to be + removed from the scene. +

+

+
+
+
+ +
Returns:
null if the constraints allow the operation, + otherwise a translatable string explaining why the object can't be + removed
+
+
+
+ +

+removeObject

+
+public void removeObject(com.threerings.miso.data.ObjectInfo info)
+
+
Removes the specified object through the constraints. +

+

+
+
+
+
+
+
+
+ +

+allowModifyObjects

+
+public String allowModifyObjects(com.threerings.miso.data.ObjectInfo[] added,
+                                 com.threerings.miso.data.ObjectInfo[] removed)
+
+
Determines whether the constraints allow the specified objects to be + added and removed simultaneously. +

+

+
+
+
+ +
Returns:
null if the constraints allow the operation, + otherwise a translatable string explaining why the objects can't be + modified
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/util/StageContext.html b/apidocs/com/threerings/stage/util/StageContext.html new file mode 100644 index 00000000..08443015 --- /dev/null +++ b/apidocs/com/threerings/stage/util/StageContext.html @@ -0,0 +1,425 @@ + + + + + + + +StageContext (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stage.util +
+Interface StageContext

+
+
All Superinterfaces:
com.threerings.miso.util.MisoContext
+
+
+
All Known Subinterfaces:
EditorContext
+
+
+
+
public interface StageContext
extends com.threerings.miso.util.MisoContext
+ + +

+A context that provides for the myriad requirements of the Stage system. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ com.threerings.media.image.ColorPositorygetColorPository() + +
+          Returns a reference to the colorization repository.
+ com.threerings.cast.ComponentRepositorygetComponentRepository() + +
+          Returns the component repository in use by this client.
+ com.threerings.media.image.ImageManagergetImageManager() + +
+          Access to the image manager.
+ com.threerings.util.KeyboardManagergetKeyboardManager() + +
+          Returns a reference to the keyboard manager.
+ com.threerings.util.KeyDispatchergetKeyDispatcher() + +
+          Provides access to the key dispatcher.
+ com.threerings.util.MessageManagergetMessageManager() + +
+          Returns a reference to the message manager used by the client.
+ com.threerings.resource.ResourceManagergetResourceManager() + +
+          Returns the resource manager via which all client resources are loaded.
+ Stringxlate(String message) + +
+          Translates the specified message using the default bundle.
+ Stringxlate(String bundle, + String message) + +
+          Translates the specified message using the specified bundle.
+  + + + + + + + +
Methods inherited from interface com.threerings.miso.util.MisoContext
getFrameManager, getTileManager
+  +

+ + + + + + + + +
+Method Detail
+ +

+getResourceManager

+
+com.threerings.resource.ResourceManager getResourceManager()
+
+
Returns the resource manager via which all client resources are loaded. +

+

+
+
+
+
+
+
+
+ +

+getImageManager

+
+com.threerings.media.image.ImageManager getImageManager()
+
+
Access to the image manager. +

+

+
+
+
+
+
+
+
+ +

+getKeyDispatcher

+
+com.threerings.util.KeyDispatcher getKeyDispatcher()
+
+
Provides access to the key dispatcher. +

+

+
+
+
+
+
+
+
+ +

+getMessageManager

+
+com.threerings.util.MessageManager getMessageManager()
+
+
Returns a reference to the message manager used by the client. +

+

+
+
+
+
+
+
+
+ +

+getKeyboardManager

+
+com.threerings.util.KeyboardManager getKeyboardManager()
+
+
Returns a reference to the keyboard manager. +

+

+
+
+
+
+
+
+
+ +

+getComponentRepository

+
+com.threerings.cast.ComponentRepository getComponentRepository()
+
+
Returns the component repository in use by this client. +

+

+
+
+
+
+
+
+
+ +

+getColorPository

+
+com.threerings.media.image.ColorPository getColorPository()
+
+
Returns a reference to the colorization repository. +

+

+
+
+
+
+
+
+
+ +

+xlate

+
+String xlate(String message)
+
+
Translates the specified message using the default bundle. +

+

+
+
+
+
+
+
+
+ +

+xlate

+
+String xlate(String bundle,
+             String message)
+
+
Translates the specified message using the specified bundle. +

+

+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/util/StageSceneUtil.html b/apidocs/com/threerings/stage/util/StageSceneUtil.html new file mode 100644 index 00000000..fd931f59 --- /dev/null +++ b/apidocs/com/threerings/stage/util/StageSceneUtil.html @@ -0,0 +1,645 @@ + + + + + + + +StageSceneUtil (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stage.util +
+Class StageSceneUtil

+
+java.lang.Object
+  extended by com.threerings.stage.util.StageSceneUtil
+
+
+
+
public class StageSceneUtil
extends Object
+ + +

+Provides scene related utility functions. +

+ +

+

+ +

+ + + + + + + + + + + +
+Field Summary
+static intOBJECT_ORIENTATION + +
+          Value to pass to locationForObject(TileManager, ObjectInfo, int) and + locationForObject(TileManager, int, int, int, int)for orientation to indicate it + should use the object's orientation.
+  + + + + + + + + + + +
+Constructor Summary
StageSceneUtil() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+static voidcoordsToLocation(int cx, + int cy, + Point loc) + +
+          Converts Cartesian coordinates back to full coordinates.
+static StageLocationfindStandingSpot(Rectangle foot, + int dist, + com.threerings.media.util.AStarPathUtil.TraversalPred pred, + Object traverser, + Point nearto, + int orient) + +
+          Locates a spot to stand near the supplied rectangular footprint.
+static List<SceneLocation>getClusterLocs(Cluster cluster) + +
+          Computes a list of the valid locations in this cluster.
+static com.threerings.miso.data.ObjectInfo[]getIntersectedObjects(com.threerings.media.tile.TileManager tmgr, + StageSceneModel model, + Rectangle rect) + +
+          Returns an array of the objects intersected by the supplied tile + coordinate rectangle.
+static com.threerings.miso.util.MisoSceneMetricsgetMetrics() + +
+          Returns the scene metrics we use to do our calculations.
+static RectanglegetObjectFootprint(com.threerings.media.tile.TileManager tilemgr, + int tileId, + int ox, + int oy) + +
+          Returns the footprint, in absolute tile coordinates, for the + specified object with origin as specified.
+static booleangetObjectFootprint(com.threerings.media.tile.TileManager tilemgr, + int tileId, + int ox, + int oy, + Rectangle foot) + +
+          Fills in the footprint, in absolute tile coordinates, for the + specified object with origin as specified.
+static booleanisPassable(com.threerings.media.tile.TileManager tilemgr, + int tileId) + +
+          Looks up the base tile set for the specified fully qualified tile + identifier and returns true if the associated tile is passable.
+static StageLocationlocationForObject(com.threerings.media.tile.TileManager tilemgr, + int tileId, + int tx, + int ty) + +
+          Does the necessary jiggery pokery to figure out where the specified object's associated + location is.
+static StageLocationlocationForObject(com.threerings.media.tile.TileManager tilemgr, + int tileId, + int tx, + int ty, + int orient) + +
+          Does the necessary jiggery pokery to figure out where the specified object's associated + location is.
+static StageLocationlocationForObject(com.threerings.media.tile.TileManager tilemgr, + com.threerings.miso.data.ObjectInfo info) + +
+          Does the necessary jiggery pokery to figure out where the specified object's associated + location is.
+static StageLocationlocationForObject(com.threerings.media.tile.TileManager tilemgr, + com.threerings.miso.data.ObjectInfo info, + int orient) + +
+          Does the necessary jiggery pokery to figure out where the specified object's associated + location is.
+static voidlocationToCoords(int lx, + int ly, + Point coords) + +
+          Converts full coordinates to Cartesian coordinates.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+OBJECT_ORIENTATION

+
+public static final int OBJECT_ORIENTATION
+
+
Value to pass to locationForObject(TileManager, ObjectInfo, int) and + locationForObject(TileManager, int, int, int, int)for orientation to indicate it + should use the object's orientation. +

+

+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Constructor Detail
+ +

+StageSceneUtil

+
+public StageSceneUtil()
+
+
+ + + + + + + + +
+Method Detail
+ +

+getMetrics

+
+public static com.threerings.miso.util.MisoSceneMetrics getMetrics()
+
+
Returns the scene metrics we use to do our calculations. +

+

+
+
+
+
+ +

+locationForObject

+
+public static StageLocation locationForObject(com.threerings.media.tile.TileManager tilemgr,
+                                              com.threerings.miso.data.ObjectInfo info)
+
+
Does the necessary jiggery pokery to figure out where the specified object's associated + location is. +

+

+
+
+
+
+ +

+locationForObject

+
+public static StageLocation locationForObject(com.threerings.media.tile.TileManager tilemgr,
+                                              com.threerings.miso.data.ObjectInfo info,
+                                              int orient)
+
+
Does the necessary jiggery pokery to figure out where the specified object's associated + location is. +

+

+
Parameters:
orient - - the orientation to use in the returned location, or + OBJECT_ORIENTATION if the object's orientation should be used
+
+
+
+ +

+locationForObject

+
+public static StageLocation locationForObject(com.threerings.media.tile.TileManager tilemgr,
+                                              int tileId,
+                                              int tx,
+                                              int ty)
+
+
Does the necessary jiggery pokery to figure out where the specified object's associated + location is. +

+

+
Parameters:
tilemgr - a tile manager that can be used to look up the tile information.
tileId - the fully qualified tile id of the object tile.
tx - the object's x tile coordinate.
ty - the object's y tile coordinate.
+
+
+
+ +

+locationForObject

+
+public static StageLocation locationForObject(com.threerings.media.tile.TileManager tilemgr,
+                                              int tileId,
+                                              int tx,
+                                              int ty,
+                                              int orient)
+
+
Does the necessary jiggery pokery to figure out where the specified object's associated + location is. +

+

+
Parameters:
tilemgr - a tile manager that can be used to look up the tile information.
tileId - the fully qualified tile id of the object tile.
tx - the object's x tile coordinate.
ty - the object's y tile coordinate.
orient - - the orientation to use in the returned location, or + OBJECT_ORIENTATION if the tile's orientation should be used
+
+
+
+ +

+locationToCoords

+
+public static void locationToCoords(int lx,
+                                    int ly,
+                                    Point coords)
+
+
Converts full coordinates to Cartesian coordinates. +

+

+
+
+
+
+ +

+coordsToLocation

+
+public static void coordsToLocation(int cx,
+                                    int cy,
+                                    Point loc)
+
+
Converts Cartesian coordinates back to full coordinates. +

+

+
+
+
+
+ +

+getObjectFootprint

+
+public static Rectangle getObjectFootprint(com.threerings.media.tile.TileManager tilemgr,
+                                           int tileId,
+                                           int ox,
+                                           int oy)
+
+
Returns the footprint, in absolute tile coordinates, for the + specified object with origin as specified. +

+

+
+
+
+
+ +

+getObjectFootprint

+
+public static boolean getObjectFootprint(com.threerings.media.tile.TileManager tilemgr,
+                                         int tileId,
+                                         int ox,
+                                         int oy,
+                                         Rectangle foot)
+
+
Fills in the footprint, in absolute tile coordinates, for the + specified object with origin as specified. +

+

+ +
Returns:
true if the object was successfully looked up and the + footprint filled in, false if an error occurred trying to look up + the associated object tile.
+
+
+
+ +

+isPassable

+
+public static boolean isPassable(com.threerings.media.tile.TileManager tilemgr,
+                                 int tileId)
+
+
Looks up the base tile set for the specified fully qualified tile + identifier and returns true if the associated tile is passable. +

+

+
+
+
+
+ +

+getClusterLocs

+
+public static List<SceneLocation> getClusterLocs(Cluster cluster)
+
+
Computes a list of the valid locations in this cluster. +

+

+
+
+
+
+ +

+findStandingSpot

+
+public static StageLocation findStandingSpot(Rectangle foot,
+                                             int dist,
+                                             com.threerings.media.util.AStarPathUtil.TraversalPred pred,
+                                             Object traverser,
+                                             Point nearto,
+                                             int orient)
+
+
Locates a spot to stand near the supplied rectangular footprint. + First a spot will be sought in a tile immediately next to the + footprint, then one tile removed, then two, up to the maximum + distance specified by dist. +

+

+
Parameters:
foot - the tile coordinate footprint around which we are + attempting to stand.
dist - the maximum number of tiles away from the footprint to + search before giving up.
pred - a predicate that will be used to determine whether a + particular spot can be stood upon (we're hijacking the meaning of + "traverse" in this case, but the interface is otherwise so nice).
traverser - the object that will be passed to the traversal + predicate.
nearto - a point (in tile coordinates) which will be used to + select from among the valid standing spots, the one nearest to the + supplied point will be returned.
orient - if not DirectionCodes.NONE this orientation + will be used to override the "natural" orientation of the spot + which is facing toward the footprint. +
Returns:
the closest spot to the
+
+
+
+ +

+getIntersectedObjects

+
+public static com.threerings.miso.data.ObjectInfo[] getIntersectedObjects(com.threerings.media.tile.TileManager tmgr,
+                                                                          StageSceneModel model,
+                                                                          Rectangle rect)
+
+
Returns an array of the objects intersected by the supplied tile + coordinate rectangle. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/util/class-use/PlacementConstraints.html b/apidocs/com/threerings/stage/util/class-use/PlacementConstraints.html new file mode 100644 index 00000000..40108264 --- /dev/null +++ b/apidocs/com/threerings/stage/util/class-use/PlacementConstraints.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.stage.util.PlacementConstraints (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stage.util.PlacementConstraints

+
+No usage of com.threerings.stage.util.PlacementConstraints +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/util/class-use/StageContext.html b/apidocs/com/threerings/stage/util/class-use/StageContext.html new file mode 100644 index 00000000..f42cd940 --- /dev/null +++ b/apidocs/com/threerings/stage/util/class-use/StageContext.html @@ -0,0 +1,254 @@ + + + + + + + +Uses of Interface com.threerings.stage.util.StageContext (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.stage.util.StageContext

+
+ + + + + + + + + + + + + + + + + +
+Packages that use StageContext
com.threerings.stage.client  
com.threerings.stage.tools.editor.util  
com.threerings.stage.tools.viewer  
+  +

+ + + + + +
+Uses of StageContext in com.threerings.stage.client
+  +

+ + + + + + + + +
Constructors in com.threerings.stage.client with parameters of type StageContext
StageScenePanel(StageContext ctx, + Controller ctrl) + +
+          Constructs a stage scene view panel.
+  +

+ + + + + +
+Uses of StageContext in com.threerings.stage.tools.editor.util
+  +

+ + + + + + + + + +
Subinterfaces of StageContext in com.threerings.stage.tools.editor.util
+ interfaceEditorContext + +
+           
+  +

+ + + + + +
+Uses of StageContext in com.threerings.stage.tools.viewer
+  +

+ + + + + + + + + +
Methods in com.threerings.stage.tools.viewer with parameters of type StageContext
+ voidViewerFrame.init(StageContext ctx, + com.threerings.cast.CharacterManager charmgr) + +
+          Instructs us to create our scene panel.
+  +

+ + + + + + + + +
Constructors in com.threerings.stage.tools.viewer with parameters of type StageContext
ViewerScenePanel(StageContext ctx, + com.threerings.cast.CharacterManager charmgr) + +
+          Construct the panel and initialize it with a context.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/util/class-use/StageSceneUtil.html b/apidocs/com/threerings/stage/util/class-use/StageSceneUtil.html new file mode 100644 index 00000000..f70e065b --- /dev/null +++ b/apidocs/com/threerings/stage/util/class-use/StageSceneUtil.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.stage.util.StageSceneUtil (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stage.util.StageSceneUtil

+
+No usage of com.threerings.stage.util.StageSceneUtil +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/util/package-frame.html b/apidocs/com/threerings/stage/util/package-frame.html new file mode 100644 index 00000000..25779d4d --- /dev/null +++ b/apidocs/com/threerings/stage/util/package-frame.html @@ -0,0 +1,46 @@ + + + + + + + +com.threerings.stage.util (vilya 1.3 API) + + + + + + + + + + + +com.threerings.stage.util + + + + +
+Interfaces  + +
+StageContext
+ + + + + + +
+Classes  + +
+PlacementConstraints +
+StageSceneUtil
+ + + + diff --git a/apidocs/com/threerings/stage/util/package-summary.html b/apidocs/com/threerings/stage/util/package-summary.html new file mode 100644 index 00000000..22fc6a82 --- /dev/null +++ b/apidocs/com/threerings/stage/util/package-summary.html @@ -0,0 +1,177 @@ + + + + + + + +com.threerings.stage.util (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.stage.util +

+ + + + + + + + + +
+Interface Summary
StageContextA context that provides for the myriad requirements of the Stage system.
+  + +

+ + + + + + + + + + + + + +
+Class Summary
PlacementConstraintsMaintains extra information on objects in a scene and checks proposed + placement operations for constraint violations.
StageSceneUtilProvides scene related utility functions.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/util/package-tree.html b/apidocs/com/threerings/stage/util/package-tree.html new file mode 100644 index 00000000..9b7c35e9 --- /dev/null +++ b/apidocs/com/threerings/stage/util/package-tree.html @@ -0,0 +1,162 @@ + + + + + + + +com.threerings.stage.util Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.stage.util +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stage/util/package-use.html b/apidocs/com/threerings/stage/util/package-use.html new file mode 100644 index 00000000..76715246 --- /dev/null +++ b/apidocs/com/threerings/stage/util/package-use.html @@ -0,0 +1,209 @@ + + + + + + + +Uses of Package com.threerings.stage.util (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.stage.util

+
+ + + + + + + + + + + + + + + + + +
+Packages that use com.threerings.stage.util
com.threerings.stage.client  
com.threerings.stage.tools.editor.util  
com.threerings.stage.tools.viewer  
+  +

+ + + + + + + + +
+Classes in com.threerings.stage.util used by com.threerings.stage.client
StageContext + +
+          A context that provides for the myriad requirements of the Stage system.
+  +

+ + + + + + + + +
+Classes in com.threerings.stage.util used by com.threerings.stage.tools.editor.util
StageContext + +
+          A context that provides for the myriad requirements of the Stage system.
+  +

+ + + + + + + + +
+Classes in com.threerings.stage.util used by com.threerings.stage.tools.viewer
StageContext + +
+          A context that provides for the myriad requirements of the Stage system.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stats/Log.html b/apidocs/com/threerings/stats/Log.html new file mode 100644 index 00000000..e5e85088 --- /dev/null +++ b/apidocs/com/threerings/stats/Log.html @@ -0,0 +1,267 @@ + + + + + + + +Log (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stats +
+Class Log

+
+java.lang.Object
+  extended by com.threerings.stats.Log
+
+
+
+
public class Log
extends Object
+ + +

+A placeholder class that contains a reference to the log object used by this project. +

+ +

+

+ +

+ + + + + + + + + + + +
+Field Summary
+static Loggerlog + +
+          We dispatch our log messages through this logger.
+  + + + + + + + + + + +
+Constructor Summary
Log() + +
+           
+  + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+log

+
+public static Logger log
+
+
We dispatch our log messages through this logger. +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+Log

+
+public Log()
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stats/class-use/Log.html b/apidocs/com/threerings/stats/class-use/Log.html new file mode 100644 index 00000000..fdbb8642 --- /dev/null +++ b/apidocs/com/threerings/stats/class-use/Log.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.stats.Log (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stats.Log

+
+No usage of com.threerings.stats.Log +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stats/data/ByteByteStringMapStat.html b/apidocs/com/threerings/stats/data/ByteByteStringMapStat.html new file mode 100644 index 00000000..21ac05cf --- /dev/null +++ b/apidocs/com/threerings/stats/data/ByteByteStringMapStat.html @@ -0,0 +1,354 @@ + + + + + + + +ByteByteStringMapStat (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stats.data +
+Class ByteByteStringMapStat

+
+java.lang.Object
+  extended by com.threerings.stats.data.Stat
+      extended by com.threerings.stats.data.StringMapStat
+          extended by com.threerings.stats.data.ByteByteStringMapStat
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable, com.threerings.presents.dobj.DSet.Entry, Cloneable
+
+
+
+
public class ByteByteStringMapStat
extends StringMapStat
+ + +

+Maps up to 127 string values to integers in the range 0 - 127. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.stats.data.Stat
Stat.AuxDataSource, Stat.Type
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + +
+Constructor Summary
ByteByteStringMapStat() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ voidpersistTo(com.threerings.io.ObjectOutputStream out, + Stat.AuxDataSource aux) + +
+          Serializes this instance for storage in the item database.
+ voidunpersistFrom(com.threerings.io.ObjectInputStream in, + Stat.AuxDataSource aux) + +
+          Unserializes this item from data obtained from the item database.
+  + + + + + + + +
Methods inherited from class com.threerings.stats.data.StringMapStat
containsKey, get, increment, put, valueToString
+  + + + + + + + +
Methods inherited from class com.threerings.stats.data.Stat
clone, getCode, getKey, getModCount, getType, getType, initType, isModified, setModCount, setModified, toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+ByteByteStringMapStat

+
+public ByteByteStringMapStat()
+
+
+ + + + + + + + +
+Method Detail
+ +

+persistTo

+
+public void persistTo(com.threerings.io.ObjectOutputStream out,
+                      Stat.AuxDataSource aux)
+               throws IOException
+
+
Description copied from class: Stat
+
Serializes this instance for storage in the item database. Derived classes must override + this method to implement persistence. +

+

+
Specified by:
persistTo in class Stat
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+unpersistFrom

+
+public void unpersistFrom(com.threerings.io.ObjectInputStream in,
+                          Stat.AuxDataSource aux)
+                   throws IOException,
+                          ClassNotFoundException
+
+
Description copied from class: Stat
+
Unserializes this item from data obtained from the item database. Derived classes must + override this method to implement persistence. +

+

+
Specified by:
unpersistFrom in class Stat
+
+
+ +
Throws: +
IOException +
ClassNotFoundException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stats/data/ByteStringSetStat.html b/apidocs/com/threerings/stats/data/ByteStringSetStat.html new file mode 100644 index 00000000..bccd0a4d --- /dev/null +++ b/apidocs/com/threerings/stats/data/ByteStringSetStat.html @@ -0,0 +1,355 @@ + + + + + + + +ByteStringSetStat (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stats.data +
+Class ByteStringSetStat

+
+java.lang.Object
+  extended by com.threerings.stats.data.Stat
+      extended by com.threerings.stats.data.SetStat<String>
+          extended by com.threerings.stats.data.StringSetStat
+              extended by com.threerings.stats.data.ByteStringSetStat
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable, com.threerings.presents.dobj.DSet.Entry, Cloneable
+
+
+
+
public class ByteStringSetStat
extends StringSetStat
+ + +

+A string set that maps its values to bytes. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.stats.data.Stat
Stat.AuxDataSource, Stat.Type
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + +
+Constructor Summary
ByteStringSetStat() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ voidpersistTo(com.threerings.io.ObjectOutputStream out, + Stat.AuxDataSource aux) + +
+          Serializes this instance for storage in the item database.
+ voidunpersistFrom(com.threerings.io.ObjectInputStream in, + Stat.AuxDataSource aux) + +
+          Unserializes this item from data obtained from the item database.
+  + + + + + + + +
Methods inherited from class com.threerings.stats.data.StringSetStat
add, contains, size, values, valueToString
+  + + + + + + + +
Methods inherited from class com.threerings.stats.data.Stat
clone, getCode, getKey, getModCount, getType, getType, initType, isModified, setModCount, setModified, toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+ByteStringSetStat

+
+public ByteStringSetStat()
+
+
+ + + + + + + + +
+Method Detail
+ +

+persistTo

+
+public void persistTo(com.threerings.io.ObjectOutputStream out,
+                      Stat.AuxDataSource aux)
+               throws IOException
+
+
Description copied from class: Stat
+
Serializes this instance for storage in the item database. Derived classes must override + this method to implement persistence. +

+

+
Specified by:
persistTo in class Stat
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+unpersistFrom

+
+public void unpersistFrom(com.threerings.io.ObjectInputStream in,
+                          Stat.AuxDataSource aux)
+                   throws IOException,
+                          ClassNotFoundException
+
+
Description copied from class: Stat
+
Unserializes this item from data obtained from the item database. Derived classes must + override this method to implement persistence. +

+

+
Specified by:
unpersistFrom in class Stat
+
+
+ +
Throws: +
IOException +
ClassNotFoundException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stats/data/IntArrayStat.html b/apidocs/com/threerings/stats/data/IntArrayStat.html new file mode 100644 index 00000000..cff2ce89 --- /dev/null +++ b/apidocs/com/threerings/stats/data/IntArrayStat.html @@ -0,0 +1,434 @@ + + + + + + + +IntArrayStat (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stats.data +
+Class IntArrayStat

+
+java.lang.Object
+  extended by com.threerings.stats.data.Stat
+      extended by com.threerings.stats.data.IntArrayStat
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable, com.threerings.presents.dobj.DSet.Entry, Cloneable
+
+
+
+
public class IntArrayStat
extends Stat
+ + +

+Used to track an integer array statistic. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.stats.data.Stat
Stat.AuxDataSource, Stat.Type
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + +
+Constructor Summary
IntArrayStat() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidappendValue(int value) + +
+          Appends a value to this statistic.
+ int[]getValue() + +
+          Returns the value of this statistic.
+ voidpersistTo(com.threerings.io.ObjectOutputStream out, + Stat.AuxDataSource aux) + +
+          Serializes this instance for storage in the item database.
+ booleansetValue(int[] value) + +
+          Sets this statistic's value to the specified value.
+ voidunpersistFrom(com.threerings.io.ObjectInputStream in, + Stat.AuxDataSource aux) + +
+          Unserializes this item from data obtained from the item database.
+ StringvalueToString() + +
+          Derived statistics must override this method and render their value to a string.
+  + + + + + + + +
Methods inherited from class com.threerings.stats.data.Stat
clone, getCode, getKey, getModCount, getType, getType, initType, isModified, setModCount, setModified, toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+IntArrayStat

+
+public IntArrayStat()
+
+
+ + + + + + + + +
+Method Detail
+ +

+getValue

+
+public int[] getValue()
+
+
Returns the value of this statistic. +

+

+
+
+
+
+ +

+setValue

+
+public boolean setValue(int[] value)
+
+
Sets this statistic's value to the specified value. +

+

+ +
Returns:
true if the stat was modified, false if not.
+
+
+
+ +

+appendValue

+
+public void appendValue(int value)
+
+
Appends a value to this statistic. +

+

+
+
+
+
+ +

+valueToString

+
+public String valueToString()
+
+
Description copied from class: Stat
+
Derived statistics must override this method and render their value to a string. Used by + Stat.toString() and to display the value in game. +

+

+
Specified by:
valueToString in class Stat
+
+
+
+
+
+
+ +

+persistTo

+
+public void persistTo(com.threerings.io.ObjectOutputStream out,
+                      Stat.AuxDataSource aux)
+               throws IOException
+
+
Description copied from class: Stat
+
Serializes this instance for storage in the item database. Derived classes must override + this method to implement persistence. +

+

+
Specified by:
persistTo in class Stat
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+unpersistFrom

+
+public void unpersistFrom(com.threerings.io.ObjectInputStream in,
+                          Stat.AuxDataSource aux)
+                   throws IOException,
+                          ClassNotFoundException
+
+
Description copied from class: Stat
+
Unserializes this item from data obtained from the item database. Derived classes must + override this method to implement persistence. +

+

+
Specified by:
unpersistFrom in class Stat
+
+
+ +
Throws: +
IOException +
ClassNotFoundException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stats/data/IntSetStat.html b/apidocs/com/threerings/stats/data/IntSetStat.html new file mode 100644 index 00000000..2d09265e --- /dev/null +++ b/apidocs/com/threerings/stats/data/IntSetStat.html @@ -0,0 +1,465 @@ + + + + + + + +IntSetStat (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stats.data +
+Class IntSetStat

+
+java.lang.Object
+  extended by com.threerings.stats.data.Stat
+      extended by com.threerings.stats.data.SetStat<Integer>
+          extended by com.threerings.stats.data.IntSetStat
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable, com.threerings.presents.dobj.DSet.Entry, Cloneable
+
+
+
+
public class IntSetStat
extends SetStat<Integer>
+ + +

+Used to track a statistic comprised of a bounded set of integers. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.stats.data.Stat
Stat.AuxDataSource, Stat.Type
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + + + + +
+Constructor Summary
IntSetStat() + +
+          Constructs a new IntSetStat that will store up to 255 ints.
IntSetStat(int maxSize) + +
+          Constructs a new IntSetStat that will store up to maxSize ints.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ booleanadd(Integer key) + +
+          Adds the specified int to this set.
+ booleancontains(Integer key) + +
+          Returns true if the specified int is contained in this set.
+ voidpersistTo(com.threerings.io.ObjectOutputStream out, + Stat.AuxDataSource aux) + +
+          Serializes this instance for storage in the item database.
+ intsize() + +
+          Returns the number of values stored in the set.
+ voidunpersistFrom(com.threerings.io.ObjectInputStream in, + Stat.AuxDataSource aux) + +
+          Unserializes this item from data obtained from the item database.
+ StringvalueToString() + +
+          Derived statistics must override this method and render their value to a string.
+  + + + + + + + +
Methods inherited from class com.threerings.stats.data.Stat
clone, getCode, getKey, getModCount, getType, getType, initType, isModified, setModCount, setModified, toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+IntSetStat

+
+public IntSetStat()
+
+
Constructs a new IntSetStat that will store up to 255 ints. +

+

+
+ +

+IntSetStat

+
+public IntSetStat(int maxSize)
+
+
Constructs a new IntSetStat that will store up to maxSize ints. +

+

+
Parameters:
maxSize - the maximum number of ints to store in the IntSetStat. Must be <= 255.
+
+ + + + + + + + +
+Method Detail
+ +

+size

+
+public int size()
+
+
Returns the number of values stored in the set. +

+

+
Specified by:
size in class SetStat<Integer>
+
+
+
+
+
+
+ +

+contains

+
+public boolean contains(Integer key)
+
+
Returns true if the specified int is contained in this set. +

+

+
Specified by:
contains in class SetStat<Integer>
+
+
+
+
+
+
+ +

+add

+
+public boolean add(Integer key)
+
+
Adds the specified int to this set. +

+

+
Specified by:
add in class SetStat<Integer>
+
+
+ +
Returns:
true if the int was newly added, false if it was already contained in the set, or + if the set is full.
+
+
+
+ +

+persistTo

+
+public void persistTo(com.threerings.io.ObjectOutputStream out,
+                      Stat.AuxDataSource aux)
+               throws IOException
+
+
Description copied from class: Stat
+
Serializes this instance for storage in the item database. Derived classes must override + this method to implement persistence. +

+

+
Specified by:
persistTo in class Stat
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+unpersistFrom

+
+public void unpersistFrom(com.threerings.io.ObjectInputStream in,
+                          Stat.AuxDataSource aux)
+                   throws IOException,
+                          ClassNotFoundException
+
+
Description copied from class: Stat
+
Unserializes this item from data obtained from the item database. Derived classes must + override this method to implement persistence. +

+

+
Specified by:
unpersistFrom in class Stat
+
+
+ +
Throws: +
IOException +
ClassNotFoundException
+
+
+
+ +

+valueToString

+
+public String valueToString()
+
+
Description copied from class: Stat
+
Derived statistics must override this method and render their value to a string. Used by + Stat.toString() and to display the value in game. +

+

+
Specified by:
valueToString in class Stat
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stats/data/IntSetStatAdder.html b/apidocs/com/threerings/stats/data/IntSetStatAdder.html new file mode 100644 index 00000000..ff410dc8 --- /dev/null +++ b/apidocs/com/threerings/stats/data/IntSetStatAdder.html @@ -0,0 +1,313 @@ + + + + + + + +IntSetStatAdder (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stats.data +
+Class IntSetStatAdder

+
+java.lang.Object
+  extended by com.threerings.stats.data.StatModifier<IntSetStat>
+      extended by com.threerings.stats.data.IntSetStatAdder
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable
+
+
+
+
public class IntSetStatAdder
extends StatModifier<IntSetStat>
+ + +

+Adds a value to an IntSetStat. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + + + + +
+Constructor Summary
IntSetStatAdder() + +
+          Constructs an empty IntSetStatAdder (for Streaming purposes).
IntSetStatAdder(Stat.Type type, + int value) + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ voidmodify(IntSetStat stat) + +
+          Applies the modification to the stat in question.
+  + + + + + + + +
Methods inherited from class com.threerings.stats.data.StatModifier
getType, readObject, writeObject
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+IntSetStatAdder

+
+public IntSetStatAdder(Stat.Type type,
+                       int value)
+
+
+
+ +

+IntSetStatAdder

+
+public IntSetStatAdder()
+
+
Constructs an empty IntSetStatAdder (for Streaming purposes). +

+

+ + + + + + + + +
+Method Detail
+ +

+modify

+
+public void modify(IntSetStat stat)
+
+
Description copied from class: StatModifier
+
Applies the modification to the stat in question. +

+

+
Specified by:
modify in class StatModifier<IntSetStat>
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stats/data/IntStat.html b/apidocs/com/threerings/stats/data/IntStat.html new file mode 100644 index 00000000..e10fc5d0 --- /dev/null +++ b/apidocs/com/threerings/stats/data/IntStat.html @@ -0,0 +1,438 @@ + + + + + + + +IntStat (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stats.data +
+Class IntStat

+
+java.lang.Object
+  extended by com.threerings.stats.data.Stat
+      extended by com.threerings.stats.data.IntStat
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable, com.threerings.presents.dobj.DSet.Entry, Cloneable
+
+
+
Direct Known Subclasses:
MaxIntStat, MaxValueIntStat
+
+
+
+
public class IntStat
extends Stat
+ + +

+Used to track a single integer statistic. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.stats.data.Stat
Stat.AuxDataSource, Stat.Type
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + +
+Constructor Summary
IntStat() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ intgetValue() + +
+          Returns the value of this integer statistic.
+ booleanincrement(int delta) + +
+          Increments this statistic by the specified delta value.
+ voidpersistTo(com.threerings.io.ObjectOutputStream out, + Stat.AuxDataSource aux) + +
+          Serializes this instance for storage in the item database.
+ booleansetValue(int value) + +
+          Sets this statistic's value to the specified value.
+ voidunpersistFrom(com.threerings.io.ObjectInputStream in, + Stat.AuxDataSource aux) + +
+          Unserializes this item from data obtained from the item database.
+ StringvalueToString() + +
+          Derived statistics must override this method and render their value to a string.
+  + + + + + + + +
Methods inherited from class com.threerings.stats.data.Stat
clone, getCode, getKey, getModCount, getType, getType, initType, isModified, setModCount, setModified, toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+IntStat

+
+public IntStat()
+
+
+ + + + + + + + +
+Method Detail
+ +

+getValue

+
+public int getValue()
+
+
Returns the value of this integer statistic. +

+

+
+
+
+
+ +

+setValue

+
+public boolean setValue(int value)
+
+
Sets this statistic's value to the specified value. +

+

+ +
Returns:
true if the stat was modified, false if not.
+
+
+
+ +

+increment

+
+public boolean increment(int delta)
+
+
Increments this statistic by the specified delta value. +

+

+ +
Returns:
true if the stat was modified, false if not.
+
+
+
+ +

+valueToString

+
+public String valueToString()
+
+
Description copied from class: Stat
+
Derived statistics must override this method and render their value to a string. Used by + Stat.toString() and to display the value in game. +

+

+
Specified by:
valueToString in class Stat
+
+
+
+
+
+
+ +

+persistTo

+
+public void persistTo(com.threerings.io.ObjectOutputStream out,
+                      Stat.AuxDataSource aux)
+               throws IOException
+
+
Description copied from class: Stat
+
Serializes this instance for storage in the item database. Derived classes must override + this method to implement persistence. +

+

+
Specified by:
persistTo in class Stat
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+unpersistFrom

+
+public void unpersistFrom(com.threerings.io.ObjectInputStream in,
+                          Stat.AuxDataSource aux)
+                   throws IOException,
+                          ClassNotFoundException
+
+
Description copied from class: Stat
+
Unserializes this item from data obtained from the item database. Derived classes must + override this method to implement persistence. +

+

+
Specified by:
unpersistFrom in class Stat
+
+
+ +
Throws: +
IOException +
ClassNotFoundException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stats/data/IntStatIncrementer.html b/apidocs/com/threerings/stats/data/IntStatIncrementer.html new file mode 100644 index 00000000..0f3a166d --- /dev/null +++ b/apidocs/com/threerings/stats/data/IntStatIncrementer.html @@ -0,0 +1,313 @@ + + + + + + + +IntStatIncrementer (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stats.data +
+Class IntStatIncrementer

+
+java.lang.Object
+  extended by com.threerings.stats.data.StatModifier<IntStat>
+      extended by com.threerings.stats.data.IntStatIncrementer
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable
+
+
+
+
public class IntStatIncrementer
extends StatModifier<IntStat>
+ + +

+Increments a particular int stat by a specified amount. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + + + + +
+Constructor Summary
IntStatIncrementer() + +
+          Constructs an empty IntStatIncrementer (for Streaming purposes).
IntStatIncrementer(Stat.Type type, + int delta) + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ voidmodify(IntStat stat) + +
+          Applies the modification to the stat in question.
+  + + + + + + + +
Methods inherited from class com.threerings.stats.data.StatModifier
getType, readObject, writeObject
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+IntStatIncrementer

+
+public IntStatIncrementer(Stat.Type type,
+                          int delta)
+
+
+
+ +

+IntStatIncrementer

+
+public IntStatIncrementer()
+
+
Constructs an empty IntStatIncrementer (for Streaming purposes). +

+

+ + + + + + + + +
+Method Detail
+ +

+modify

+
+public void modify(IntStat stat)
+
+
Description copied from class: StatModifier
+
Applies the modification to the stat in question. +

+

+
Specified by:
modify in class StatModifier<IntStat>
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stats/data/IntStatMinimumer.html b/apidocs/com/threerings/stats/data/IntStatMinimumer.html new file mode 100644 index 00000000..49ca2435 --- /dev/null +++ b/apidocs/com/threerings/stats/data/IntStatMinimumer.html @@ -0,0 +1,314 @@ + + + + + + + +IntStatMinimumer (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stats.data +
+Class IntStatMinimumer

+
+java.lang.Object
+  extended by com.threerings.stats.data.StatModifier<IntStat>
+      extended by com.threerings.stats.data.IntStatMinimumer
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable
+
+
+
+
public class IntStatMinimumer
extends StatModifier<IntStat>
+ + +

+Ensures that a particular stat has been set to a minimum value. If the value of the stat is + already greater than or equal to the requested minimum, the stat is not modified. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + + + + +
+Constructor Summary
IntStatMinimumer() + +
+          Constructs an empty IntStatMinimumer (for Streaming purposes).
IntStatMinimumer(Stat.Type type, + int minimum) + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ voidmodify(IntStat stat) + +
+          Applies the modification to the stat in question.
+  + + + + + + + +
Methods inherited from class com.threerings.stats.data.StatModifier
getType, readObject, writeObject
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+IntStatMinimumer

+
+public IntStatMinimumer(Stat.Type type,
+                        int minimum)
+
+
+
+ +

+IntStatMinimumer

+
+public IntStatMinimumer()
+
+
Constructs an empty IntStatMinimumer (for Streaming purposes). +

+

+ + + + + + + + +
+Method Detail
+ +

+modify

+
+public void modify(IntStat stat)
+
+
Description copied from class: StatModifier
+
Applies the modification to the stat in question. +

+

+
Specified by:
modify in class StatModifier<IntStat>
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stats/data/IntStringSetStat.html b/apidocs/com/threerings/stats/data/IntStringSetStat.html new file mode 100644 index 00000000..bde5b072 --- /dev/null +++ b/apidocs/com/threerings/stats/data/IntStringSetStat.html @@ -0,0 +1,355 @@ + + + + + + + +IntStringSetStat (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stats.data +
+Class IntStringSetStat

+
+java.lang.Object
+  extended by com.threerings.stats.data.Stat
+      extended by com.threerings.stats.data.SetStat<String>
+          extended by com.threerings.stats.data.StringSetStat
+              extended by com.threerings.stats.data.IntStringSetStat
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable, com.threerings.presents.dobj.DSet.Entry, Cloneable
+
+
+
+
public class IntStringSetStat
extends StringSetStat
+ + +

+A string set that maps its values to integers. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.stats.data.Stat
Stat.AuxDataSource, Stat.Type
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + +
+Constructor Summary
IntStringSetStat() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ voidpersistTo(com.threerings.io.ObjectOutputStream out, + Stat.AuxDataSource aux) + +
+          Serializes this instance for storage in the item database.
+ voidunpersistFrom(com.threerings.io.ObjectInputStream in, + Stat.AuxDataSource aux) + +
+          Unserializes this item from data obtained from the item database.
+  + + + + + + + +
Methods inherited from class com.threerings.stats.data.StringSetStat
add, contains, size, values, valueToString
+  + + + + + + + +
Methods inherited from class com.threerings.stats.data.Stat
clone, getCode, getKey, getModCount, getType, getType, initType, isModified, setModCount, setModified, toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+IntStringSetStat

+
+public IntStringSetStat()
+
+
+ + + + + + + + +
+Method Detail
+ +

+persistTo

+
+public void persistTo(com.threerings.io.ObjectOutputStream out,
+                      Stat.AuxDataSource aux)
+               throws IOException
+
+
Description copied from class: Stat
+
Serializes this instance for storage in the item database. Derived classes must override + this method to implement persistence. +

+

+
Specified by:
persistTo in class Stat
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+unpersistFrom

+
+public void unpersistFrom(com.threerings.io.ObjectInputStream in,
+                          Stat.AuxDataSource aux)
+                   throws IOException,
+                          ClassNotFoundException
+
+
Description copied from class: Stat
+
Unserializes this item from data obtained from the item database. Derived classes must + override this method to implement persistence. +

+

+
Specified by:
unpersistFrom in class Stat
+
+
+ +
Throws: +
IOException +
ClassNotFoundException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stats/data/MaxIntStat.html b/apidocs/com/threerings/stats/data/MaxIntStat.html new file mode 100644 index 00000000..55e6abf0 --- /dev/null +++ b/apidocs/com/threerings/stats/data/MaxIntStat.html @@ -0,0 +1,429 @@ + + + + + + + +MaxIntStat (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stats.data +
+Class MaxIntStat

+
+java.lang.Object
+  extended by com.threerings.stats.data.Stat
+      extended by com.threerings.stats.data.IntStat
+          extended by com.threerings.stats.data.MaxIntStat
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable, com.threerings.presents.dobj.DSet.Entry, Cloneable
+
+
+
+
public class MaxIntStat
extends IntStat
+ + +

+Extends the IntStat by maintaining a maximum value which is updated every time a value + is accumulated to the stat. Thus we track an accumulating value as well as the largest amount by + which it has ever accumulated. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.stats.data.Stat
Stat.AuxDataSource, Stat.Type
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + +
+Constructor Summary
MaxIntStat() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ intgetMaxValue() + +
+          Returns the maximum value every accumulated to this integer statistic.
+ booleanincrement(int delta) + +
+          Increments this statistic by the specified delta value.
+ voidpersistTo(com.threerings.io.ObjectOutputStream out, + Stat.AuxDataSource aux) + +
+          Serializes this instance for storage in the item database.
+ voidunpersistFrom(com.threerings.io.ObjectInputStream in, + Stat.AuxDataSource aux) + +
+          Unserializes this item from data obtained from the item database.
+ StringvalueToString() + +
+          Derived statistics must override this method and render their value to a string.
+  + + + + + + + +
Methods inherited from class com.threerings.stats.data.IntStat
getValue, setValue
+  + + + + + + + +
Methods inherited from class com.threerings.stats.data.Stat
clone, getCode, getKey, getModCount, getType, getType, initType, isModified, setModCount, setModified, toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+MaxIntStat

+
+public MaxIntStat()
+
+
+ + + + + + + + +
+Method Detail
+ +

+getMaxValue

+
+public int getMaxValue()
+
+
Returns the maximum value every accumulated to this integer statistic. +

+

+
+
+
+
+ +

+increment

+
+public boolean increment(int delta)
+
+
Description copied from class: IntStat
+
Increments this statistic by the specified delta value. +

+

+
Overrides:
increment in class IntStat
+
+
+ +
Returns:
true if the stat was modified, false if not.
+
+
+
+ +

+valueToString

+
+public String valueToString()
+
+
Description copied from class: Stat
+
Derived statistics must override this method and render their value to a string. Used by + Stat.toString() and to display the value in game. +

+

+
Overrides:
valueToString in class IntStat
+
+
+
+
+
+
+ +

+persistTo

+
+public void persistTo(com.threerings.io.ObjectOutputStream out,
+                      Stat.AuxDataSource aux)
+               throws IOException
+
+
Description copied from class: Stat
+
Serializes this instance for storage in the item database. Derived classes must override + this method to implement persistence. +

+

+
Overrides:
persistTo in class IntStat
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+unpersistFrom

+
+public void unpersistFrom(com.threerings.io.ObjectInputStream in,
+                          Stat.AuxDataSource aux)
+                   throws IOException,
+                          ClassNotFoundException
+
+
Description copied from class: Stat
+
Unserializes this item from data obtained from the item database. Derived classes must + override this method to implement persistence. +

+

+
Overrides:
unpersistFrom in class IntStat
+
+
+ +
Throws: +
IOException +
ClassNotFoundException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stats/data/MaxValueIntStat.html b/apidocs/com/threerings/stats/data/MaxValueIntStat.html new file mode 100644 index 00000000..94626b1c --- /dev/null +++ b/apidocs/com/threerings/stats/data/MaxValueIntStat.html @@ -0,0 +1,429 @@ + + + + + + + +MaxValueIntStat (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stats.data +
+Class MaxValueIntStat

+
+java.lang.Object
+  extended by com.threerings.stats.data.Stat
+      extended by com.threerings.stats.data.IntStat
+          extended by com.threerings.stats.data.MaxValueIntStat
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable, com.threerings.presents.dobj.DSet.Entry, Cloneable
+
+
+
+
public class MaxValueIntStat
extends IntStat
+ + +

+Extends the IntStat by maintaining the maximum value that the stat has ever been + assigned (unlike MaxIntStat, which tracks the maximum value that the stat has ever + been incremented by). +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.stats.data.Stat
Stat.AuxDataSource, Stat.Type
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + +
+Constructor Summary
MaxValueIntStat() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ intgetMaxValue() + +
+          Returns the maximum value that this integer statistic has ever been assigned.
+ voidpersistTo(com.threerings.io.ObjectOutputStream out, + Stat.AuxDataSource aux) + +
+          Serializes this instance for storage in the item database.
+ booleansetValue(int value) + +
+          Sets this statistic's value to the specified value.
+ voidunpersistFrom(com.threerings.io.ObjectInputStream in, + Stat.AuxDataSource aux) + +
+          Unserializes this item from data obtained from the item database.
+ StringvalueToString() + +
+          Derived statistics must override this method and render their value to a string.
+  + + + + + + + +
Methods inherited from class com.threerings.stats.data.IntStat
getValue, increment
+  + + + + + + + +
Methods inherited from class com.threerings.stats.data.Stat
clone, getCode, getKey, getModCount, getType, getType, initType, isModified, setModCount, setModified, toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+MaxValueIntStat

+
+public MaxValueIntStat()
+
+
+ + + + + + + + +
+Method Detail
+ +

+getMaxValue

+
+public int getMaxValue()
+
+
Returns the maximum value that this integer statistic has ever been assigned. +

+

+
+
+
+
+ +

+setValue

+
+public boolean setValue(int value)
+
+
Description copied from class: IntStat
+
Sets this statistic's value to the specified value. +

+

+
Overrides:
setValue in class IntStat
+
+
+ +
Returns:
true if the stat was modified, false if not.
+
+
+
+ +

+valueToString

+
+public String valueToString()
+
+
Description copied from class: Stat
+
Derived statistics must override this method and render their value to a string. Used by + Stat.toString() and to display the value in game. +

+

+
Overrides:
valueToString in class IntStat
+
+
+
+
+
+
+ +

+persistTo

+
+public void persistTo(com.threerings.io.ObjectOutputStream out,
+                      Stat.AuxDataSource aux)
+               throws IOException
+
+
Description copied from class: Stat
+
Serializes this instance for storage in the item database. Derived classes must override + this method to implement persistence. +

+

+
Overrides:
persistTo in class IntStat
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+unpersistFrom

+
+public void unpersistFrom(com.threerings.io.ObjectInputStream in,
+                          Stat.AuxDataSource aux)
+                   throws IOException,
+                          ClassNotFoundException
+
+
Description copied from class: Stat
+
Unserializes this item from data obtained from the item database. Derived classes must + override this method to implement persistence. +

+

+
Overrides:
unpersistFrom in class IntStat
+
+
+ +
Throws: +
IOException +
ClassNotFoundException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stats/data/SetStat.html b/apidocs/com/threerings/stats/data/SetStat.html new file mode 100644 index 00000000..6d51b074 --- /dev/null +++ b/apidocs/com/threerings/stats/data/SetStat.html @@ -0,0 +1,344 @@ + + + + + + + +SetStat (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stats.data +
+Class SetStat<T>

+
+java.lang.Object
+  extended by com.threerings.stats.data.Stat
+      extended by com.threerings.stats.data.SetStat<T>
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable, com.threerings.presents.dobj.DSet.Entry, Cloneable
+
+
+
Direct Known Subclasses:
IntSetStat, StringSetStat
+
+
+
+
public abstract class SetStat<T>
extends Stat
+ + +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.stats.data.Stat
Stat.AuxDataSource, Stat.Type
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + +
+Constructor Summary
SetStat() + +
+           
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+abstract  booleanadd(T key) + +
+          Adds the specified object to this set.
+abstract  booleancontains(T key) + +
+          Returns true if the specified object is contained in this set.
+abstract  intsize() + +
+          Returns the number of elements in this set.
+  + + + + + + + +
Methods inherited from class com.threerings.stats.data.Stat
clone, getCode, getKey, getModCount, getType, getType, initType, isModified, persistTo, setModCount, setModified, toString, unpersistFrom, valueToString
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+SetStat

+
+public SetStat()
+
+
+ + + + + + + + +
+Method Detail
+ +

+size

+
+public abstract int size()
+
+
Returns the number of elements in this set. +

+

+
+
+
+
+ +

+add

+
+public abstract boolean add(T key)
+
+
Adds the specified object to this set. +

+

+ +
Returns:
true if the object was newly added, false if it was already + contained in the set.
+
+
+
+ +

+contains

+
+public abstract boolean contains(T key)
+
+
Returns true if the specified object is contained in this set. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stats/data/ShortStringSetStat.html b/apidocs/com/threerings/stats/data/ShortStringSetStat.html new file mode 100644 index 00000000..b47fa10c --- /dev/null +++ b/apidocs/com/threerings/stats/data/ShortStringSetStat.html @@ -0,0 +1,355 @@ + + + + + + + +ShortStringSetStat (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stats.data +
+Class ShortStringSetStat

+
+java.lang.Object
+  extended by com.threerings.stats.data.Stat
+      extended by com.threerings.stats.data.SetStat<String>
+          extended by com.threerings.stats.data.StringSetStat
+              extended by com.threerings.stats.data.ShortStringSetStat
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable, com.threerings.presents.dobj.DSet.Entry, Cloneable
+
+
+
+
public class ShortStringSetStat
extends StringSetStat
+ + +

+A string set that maps its values to shorts. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.stats.data.Stat
Stat.AuxDataSource, Stat.Type
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + +
+Constructor Summary
ShortStringSetStat() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ voidpersistTo(com.threerings.io.ObjectOutputStream out, + Stat.AuxDataSource aux) + +
+          Serializes this instance for storage in the item database.
+ voidunpersistFrom(com.threerings.io.ObjectInputStream in, + Stat.AuxDataSource aux) + +
+          Unserializes this item from data obtained from the item database.
+  + + + + + + + +
Methods inherited from class com.threerings.stats.data.StringSetStat
add, contains, size, values, valueToString
+  + + + + + + + +
Methods inherited from class com.threerings.stats.data.Stat
clone, getCode, getKey, getModCount, getType, getType, initType, isModified, setModCount, setModified, toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+ShortStringSetStat

+
+public ShortStringSetStat()
+
+
+ + + + + + + + +
+Method Detail
+ +

+persistTo

+
+public void persistTo(com.threerings.io.ObjectOutputStream out,
+                      Stat.AuxDataSource aux)
+               throws IOException
+
+
Description copied from class: Stat
+
Serializes this instance for storage in the item database. Derived classes must override + this method to implement persistence. +

+

+
Specified by:
persistTo in class Stat
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+unpersistFrom

+
+public void unpersistFrom(com.threerings.io.ObjectInputStream in,
+                          Stat.AuxDataSource aux)
+                   throws IOException,
+                          ClassNotFoundException
+
+
Description copied from class: Stat
+
Unserializes this item from data obtained from the item database. Derived classes must + override this method to implement persistence. +

+

+
Specified by:
unpersistFrom in class Stat
+
+
+ +
Throws: +
IOException +
ClassNotFoundException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stats/data/Stat.AuxDataSource.html b/apidocs/com/threerings/stats/data/Stat.AuxDataSource.html new file mode 100644 index 00000000..1567b4d5 --- /dev/null +++ b/apidocs/com/threerings/stats/data/Stat.AuxDataSource.html @@ -0,0 +1,244 @@ + + + + + + + +Stat.AuxDataSource (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stats.data +
+Interface Stat.AuxDataSource

+
+
All Known Implementing Classes:
StatRepository
+
+
+
Enclosing class:
Stat
+
+
+
+
public static interface Stat.AuxDataSource
+ + +

+Provides auxilliary information to statistics during the persisting process. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + +
+Method Summary
+ StringgetCodeString(Stat.Type type, + int code) + +
+          Maps the specified unique code back to its string value.
+ intgetStringCode(Stat.Type type, + String value) + +
+          Maps the specified string to a unique integer value.
+  +

+ + + + + + + + +
+Method Detail
+ +

+getStringCode

+
+int getStringCode(Stat.Type type,
+                  String value)
+
+
Maps the specified string to a unique integer value. +

+

+
+
+
+
+ +

+getCodeString

+
+String getCodeString(Stat.Type type,
+                     int code)
+
+
Maps the specified unique code back to its string value. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stats/data/Stat.Type.html b/apidocs/com/threerings/stats/data/Stat.Type.html new file mode 100644 index 00000000..8b1272ef --- /dev/null +++ b/apidocs/com/threerings/stats/data/Stat.Type.html @@ -0,0 +1,294 @@ + + + + + + + +Stat.Type (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stats.data +
+Interface Stat.Type

+
+
All Superinterfaces:
Serializable
+
+
+
Enclosing class:
Stat
+
+
+
+
public static interface Stat.Type
extends Serializable
+ + +

+Defines the various per-player tracked statistics. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ intcode() + +
+          Returns the unique code for this stat which is a function of its name.
+ booleanisPersistent() + +
+          Returns true if this stat is persisted between sessions.
+ Stringname() + +
+          Returns the enum name of stat.
+ StatnewStat() + +
+          Returns a new blank stat instance of the specified type.
+  +

+ + + + + + + + +
+Method Detail
+ +

+newStat

+
+Stat newStat()
+
+
Returns a new blank stat instance of the specified type. +

+

+
+
+
+
+
+
+
+ +

+name

+
+String name()
+
+
Returns the enum name of stat. +

+

+
+
+
+
+
+
+
+ +

+code

+
+int code()
+
+
Returns the unique code for this stat which is a function of its name. +

+

+
+
+
+
+
+
+
+ +

+isPersistent

+
+boolean isPersistent()
+
+
Returns true if this stat is persisted between sessions. +

+

+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stats/data/Stat.html b/apidocs/com/threerings/stats/data/Stat.html new file mode 100644 index 00000000..67f77b68 --- /dev/null +++ b/apidocs/com/threerings/stats/data/Stat.html @@ -0,0 +1,633 @@ + + + + + + + +Stat (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stats.data +
+Class Stat

+
+java.lang.Object
+  extended by com.threerings.stats.data.Stat
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable, com.threerings.presents.dobj.DSet.Entry, Cloneable
+
+
+
Direct Known Subclasses:
IntArrayStat, IntStat, SetStat, StringMapStat
+
+
+
+
public abstract class Stat
extends Object
implements com.threerings.presents.dobj.DSet.Entry, Cloneable
+ + +

+A base class for persistent statistics tracked on a per-player basis (some for a single game, + others for all time). +

+ +

+

+ +

+ + + + + + + + + + + + + + + +
+Nested Class Summary
+static interfaceStat.AuxDataSource + +
+          Provides auxilliary information to statistics during the persisting process.
+static interfaceStat.Type + +
+          Defines the various per-player tracked statistics.
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + +
+Constructor Summary
Stat() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ Statclone() + +
+           
+ intgetCode() + +
+          Returns the integer code to which this statistic's name maps.
+ StringgetKey() + +
+           
+ bytegetModCount() + +
+          Returns the modification count of this Stat when it was loaded from the repository.
+ Stat.TypegetType() + +
+          Returns the type of this statistic.
+static Stat.TypegetType(int code) + +
+          Maps a Stat.Type's code code back to a Stat.Type instance.
+static intinitType(Stat.Type type, + Stat prototype) + +
+          Used by the Stat.Type implementation to map itself to an integer code.
+ booleanisModified() + +
+          Returns true if the supplied statistic has been modified since it + was loaded from the repository.
+abstract  voidpersistTo(com.threerings.io.ObjectOutputStream out, + Stat.AuxDataSource aux) + +
+          Serializes this instance for storage in the item database.
+ voidsetModCount(byte modCount) + +
+          Sets the modification count for this Stat.
+ voidsetModified(boolean modified) + +
+          Forces this stat to consider itself modified.
+ StringtoString() + +
+           
+abstract  voidunpersistFrom(com.threerings.io.ObjectInputStream in, + Stat.AuxDataSource aux) + +
+          Unserializes this item from data obtained from the item database.
+abstract  StringvalueToString() + +
+          Derived statistics must override this method and render their value to a string.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+Stat

+
+public Stat()
+
+
+ + + + + + + + +
+Method Detail
+ +

+getType

+
+public static Stat.Type getType(int code)
+
+
Maps a Stat.Type's code code back to a Stat.Type instance. +

+

+
+
+
+
+
+
+
+ +

+initType

+
+public static int initType(Stat.Type type,
+                           Stat prototype)
+
+
Used by the Stat.Type implementation to map itself to an integer code. +

+

+
+
+
+ +
Returns:
the code to which the supplied type was mapped.
+
+
+
+ +

+getType

+
+public Stat.Type getType()
+
+
Returns the type of this statistic. +

+

+
+
+
+
+
+
+
+ +

+getCode

+
+public int getCode()
+
+
Returns the integer code to which this statistic's name maps. +

+

+
+
+
+
+
+
+
+ +

+isModified

+
+public boolean isModified()
+
+
Returns true if the supplied statistic has been modified since it + was loaded from the repository. +

+

+
+
+
+
+
+
+
+ +

+setModified

+
+public void setModified(boolean modified)
+
+
Forces this stat to consider itself modified. Generally this is not + called but rather the derived class will update its modified state when + it is actually modified. +

+

+
+
+
+
+
+
+
+ +

+getModCount

+
+public byte getModCount()
+
+
Returns the modification count of this Stat when it was loaded from the repository. +

+

+
+
+
+
+
+
+
+ +

+setModCount

+
+public void setModCount(byte modCount)
+
+
Sets the modification count for this Stat. StatRepository calls this when converting + a StatRecord into a Stat; it shouldn't be called otherwise. +

+

+
+
+
+
+
+
+
+ +

+persistTo

+
+public abstract void persistTo(com.threerings.io.ObjectOutputStream out,
+                               Stat.AuxDataSource aux)
+                        throws IOException
+
+
Serializes this instance for storage in the item database. Derived classes must override + this method to implement persistence. +

+

+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+unpersistFrom

+
+public abstract void unpersistFrom(com.threerings.io.ObjectInputStream in,
+                                   Stat.AuxDataSource aux)
+                            throws IOException,
+                                   ClassNotFoundException
+
+
Unserializes this item from data obtained from the item database. Derived classes must + override this method to implement persistence. +

+

+
+
+
+ +
Throws: +
IOException +
ClassNotFoundException
+
+
+
+ +

+toString

+
+public String toString()
+
+
+
Overrides:
toString in class Object
+
+
+
+
+
+
+ +

+valueToString

+
+public abstract String valueToString()
+
+
Derived statistics must override this method and render their value to a string. Used by + toString() and to display the value in game. +

+

+
+
+
+
+
+
+
+ +

+getKey

+
+public String getKey()
+
+
+
Specified by:
getKey in interface com.threerings.presents.dobj.DSet.Entry
+
+
+
+
+
+
+ +

+clone

+
+public Stat clone()
+
+
+
Overrides:
clone in class Object
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stats/data/StatModifier.html b/apidocs/com/threerings/stats/data/StatModifier.html new file mode 100644 index 00000000..822f164e --- /dev/null +++ b/apidocs/com/threerings/stats/data/StatModifier.html @@ -0,0 +1,371 @@ + + + + + + + +StatModifier (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stats.data +
+Class StatModifier<T extends Stat>

+
+java.lang.Object
+  extended by com.threerings.stats.data.StatModifier<T>
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable
+
+
+
Direct Known Subclasses:
IntSetStatAdder, IntStatIncrementer, IntStatMinimumer
+
+
+
+
public abstract class StatModifier<T extends Stat>
extends Object
implements com.threerings.io.Streamable
+ + +

+Encapsulates a modification to a single stat that can be serialized and sent to a different + server, if needed, to update stats loaded at runtime. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + +
+Constructor Summary
StatModifier(Stat.Type type) + +
+          Creates a modifier that will operate on the supplied stat type.
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ Stat.TypegetType() + +
+          Returns the Stat.Type of the stat being modified.
+abstract  voidmodify(T stat) + +
+          Applies the modification to the stat in question.
+ voidreadObject(com.threerings.io.ObjectInputStream in) + +
+          Reads our custom streamable fields.
+ voidwriteObject(com.threerings.io.ObjectOutputStream out) + +
+          Writes our custom streamable fields.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+StatModifier

+
+public StatModifier(Stat.Type type)
+
+
Creates a modifier that will operate on the supplied stat type. Note that this type may be + serialized and shipped between servers. +

+

+ + + + + + + + +
+Method Detail
+ +

+getType

+
+public Stat.Type getType()
+
+
Returns the Stat.Type of the stat being modified. +

+

+
+
+
+
+
+
+
+ +

+writeObject

+
+public void writeObject(com.threerings.io.ObjectOutputStream out)
+                 throws IOException
+
+
Writes our custom streamable fields. +

+

+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+readObject

+
+public void readObject(com.threerings.io.ObjectInputStream in)
+                throws IOException,
+                       ClassNotFoundException
+
+
Reads our custom streamable fields. +

+

+
+
+
+ +
Throws: +
IOException +
ClassNotFoundException
+
+
+
+ +

+modify

+
+public abstract void modify(T stat)
+
+
Applies the modification to the stat in question. +

+

+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stats/data/StatSet.Container.html b/apidocs/com/threerings/stats/data/StatSet.Container.html new file mode 100644 index 00000000..453e6b9f --- /dev/null +++ b/apidocs/com/threerings/stats/data/StatSet.Container.html @@ -0,0 +1,234 @@ + + + + + + + +StatSet.Container (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stats.data +
+Interface StatSet.Container

+
+
Enclosing class:
StatSet
+
+
+
+
public static interface StatSet.Container
+ + +

+An interface to be implemented by an entity that wishes to be notified when the contents of + a stat set change. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + +
+Method Summary
+ voidaddToStats(Stat stat) + +
+           
+ voidupdateStats(Stat stat) + +
+           
+  +

+ + + + + + + + +
+Method Detail
+ +

+addToStats

+
+void addToStats(Stat stat)
+
+
+
+
+
+
+ +

+updateStats

+
+void updateStats(Stat stat)
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stats/data/StatSet.html b/apidocs/com/threerings/stats/data/StatSet.html new file mode 100644 index 00000000..28c2f16f --- /dev/null +++ b/apidocs/com/threerings/stats/data/StatSet.html @@ -0,0 +1,721 @@ + + + + + + + +StatSet (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stats.data +
+Class StatSet

+
+java.lang.Object
+  extended by com.threerings.presents.dobj.DSet<Stat>
+      extended by com.threerings.stats.data.StatSet
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable, Cloneable, Iterable<Stat>
+
+
+
+
public class StatSet
extends com.threerings.presents.dobj.DSet<Stat>
+ + +

+A distributed set containing Stat objects. +

+ +

+

+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static interfaceStatSet.Container + +
+          An interface to be implemented by an entity that wishes to be notified when the contents of + a stat set change.
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.presents.dobj.DSet
com.threerings.presents.dobj.DSet.Entry
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + + + + + + + +
+Constructor Summary
StatSet() + +
+          Creates a blank stat set.
StatSet(Iterable<Stat> contents) + +
+          Creates a stat set with the specified contents.
StatSet(Iterator<Stat> contents) + +
+          Creates a stat set with the specified contents.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidaddQuietly(Stat stat) + +
+          Don't call this method, it's only needed by some tricky business we do when preventing + distributed object event generation for all but the bounty criteria related stats.
+ + + + + +
+<T> void
+		addToSetStat(Stat.Type type, + T value) + +
+          Adds a value to a SetStat.
+ voidappendStat(Stat.Type type, + int value) + +
+          Appends an integer value to an IntArrayStat.
+ + + + + +
+<T> boolean
+		containsValue(Stat.Type type, + T value) + +
+          Returns true if the specified SetStat contains the specified value, false + otherwise.
+ int[]getIntArrayStat(Stat.Type type) + +
+          Returns the current value of the specified integer array statistic.
+ intgetIntStat(Stat.Type type) + +
+          Returns the current value of the specified integer statistic.
+ intgetMapValue(Stat.Type type, + String value) + +
+          Returns the value to which the specified string is mapped in a StringMapStat or zero + if the value has not been mapped.
+ intgetMaxIntStat(Stat.Type type) + +
+          Returns the maximum value by which the specified integer statistic has ever been + incremented.
+ intgetSetStatSize(Stat.Type type) + +
+          Returns the current size of the specified SetStat statistic.
+ voidincrementMapStat(Stat.Type type, + String value, + int amount) + +
+          Increments a string value in a StringMapStat.
+ voidincrementStat(Stat.Type type, + int delta) + +
+          Increments an integer statistic in this set.
+ voidmaxStat(Stat.Type type, + int value) + +
+          Sets an integer stat to the specified value, if it exceeds our existing recorded value.
+ voidsetContainer(StatSet.Container container) + +
+          Wires this stat set up to a containing user object.
+ voidsetStat(Stat.Type type, + int value) + +
+          Sets an integer statistic in this set.
+ + + + + +
+<T extends Stat> +
+void
+		syncStat(StatModifier<T> modifier) + +
+          Updates a stat in this set, using the supplied StatModifier.
+  + + + + + + + +
Methods inherited from class com.threerings.presents.dobj.DSet
asSet, clone, compare, contains, containsKey, entries, get, iterator, newDSet, newDSet, readField__entries, readField__size, readObject, size, toArray, toArray, toString, typedClone, writeField__entries, writeField__size, writeObject
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+StatSet

+
+public StatSet(Iterable<Stat> contents)
+
+
Creates a stat set with the specified contents. +

+

+
+ +

+StatSet

+
+public StatSet(Iterator<Stat> contents)
+
+
Creates a stat set with the specified contents. +

+

+
+ +

+StatSet

+
+public StatSet()
+
+
Creates a blank stat set. +

+

+ + + + + + + + +
+Method Detail
+ +

+setContainer

+
+public void setContainer(StatSet.Container container)
+
+
Wires this stat set up to a containing user object. All subsequent modifications will be + published to the container. +

+

+
+
+
+
+ +

+syncStat

+
+public <T extends Stat> void syncStat(StatModifier<T> modifier)
+
+
Updates a stat in this set, using the supplied StatModifier. This function should + only be called after a successful stat modification has been made to the StatRepository. + It will increment the Stat's modCount, and won't set its dirty bit if it's not already + set, to prevent the Stat from being re-written to the repo unnecessarily. +

+

+
+
+
+
+ +

+setStat

+
+public void setStat(Stat.Type type,
+                    int value)
+
+
Sets an integer statistic in this set. +

+

+ +
Throws: +
ClassCastException - thrown if the registered type of the specified stat is not an + IntStat.
+
+
+
+ +

+maxStat

+
+public void maxStat(Stat.Type type,
+                    int value)
+
+
Sets an integer stat to the specified value, if it exceeds our existing recorded value. +

+

+ +
Throws: +
ClassCastException - thrown if the registered type of the specified stat is not an + IntStat.
+
+
+
+ +

+incrementStat

+
+public void incrementStat(Stat.Type type,
+                          int delta)
+
+
Increments an integer statistic in this set. +

+

+ +
Throws: +
ClassCastException - thrown if the registered type of the specified stat is not an + IntStat.
+
+
+
+ +

+appendStat

+
+public void appendStat(Stat.Type type,
+                       int value)
+
+
Appends an integer value to an IntArrayStat. +

+

+ +
Throws: +
ClassCastException - thrown if the registered type of the specified stat is not an + IntArrayStat.
+
+
+
+ +

+addToSetStat

+
+public <T> void addToSetStat(Stat.Type type,
+                             T value)
+
+
Adds a value to a SetStat. +

+

+ +
Throws: +
ClassCastException - thrown if the registered type of the specified stat is not + an SetStat parameterized on the given type.
+
+
+
+ +

+incrementMapStat

+
+public void incrementMapStat(Stat.Type type,
+                             String value,
+                             int amount)
+
+
Increments a string value in a StringMapStat. +

+

+ +
Throws: +
ClassCastException - thrown if the registered type of the specified stat is not an + StringMapStat.
+
+
+
+ +

+getIntStat

+
+public int getIntStat(Stat.Type type)
+
+
Returns the current value of the specified integer statistic. +

+

+ +
Throws: +
ClassCastException - thrown if the registered type of the specified stat is not an + IntStat.
+
+
+
+ +

+getMaxIntStat

+
+public int getMaxIntStat(Stat.Type type)
+
+
Returns the maximum value by which the specified integer statistic has ever been + incremented. +

+

+ +
Throws: +
ClassCastException - thrown if the registered type of the specified stat is not an + MaxIntStat.
+
+
+
+ +

+getIntArrayStat

+
+public int[] getIntArrayStat(Stat.Type type)
+
+
Returns the current value of the specified integer array statistic. +

+

+ +
Throws: +
ClassCastException - thrown if the registered type of the specified stat is not an + IntArrayStat.
+
+
+
+ +

+getSetStatSize

+
+public int getSetStatSize(Stat.Type type)
+
+
Returns the current size of the specified SetStat statistic. +

+

+ +
Throws: +
ClassCastException - thrown if the registered type of the specified stat is not an + SetStat.
+
+
+
+ +

+containsValue

+
+public <T> boolean containsValue(Stat.Type type,
+                                 T value)
+
+
Returns true if the specified SetStat contains the specified value, false + otherwise. +

+

+
+
+
+
+ +

+getMapValue

+
+public int getMapValue(Stat.Type type,
+                       String value)
+
+
Returns the value to which the specified string is mapped in a StringMapStat or zero + if the value has not been mapped. +

+

+
+
+
+
+ +

+addQuietly

+
+public void addQuietly(Stat stat)
+
+
Don't call this method, it's only needed by some tricky business we do when preventing + distributed object event generation for all but the bounty criteria related stats. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stats/data/StringMapStat.html b/apidocs/com/threerings/stats/data/StringMapStat.html new file mode 100644 index 00000000..38d7c46c --- /dev/null +++ b/apidocs/com/threerings/stats/data/StringMapStat.html @@ -0,0 +1,401 @@ + + + + + + + +StringMapStat (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stats.data +
+Class StringMapStat

+
+java.lang.Object
+  extended by com.threerings.stats.data.Stat
+      extended by com.threerings.stats.data.StringMapStat
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable, com.threerings.presents.dobj.DSet.Entry, Cloneable
+
+
+
Direct Known Subclasses:
ByteByteStringMapStat
+
+
+
+
public abstract class StringMapStat
extends Stat
+ + +

+Used to track a statistic comprised of a set of strings that map to numeric counts. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.stats.data.Stat
Stat.AuxDataSource, Stat.Type
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + +
+Constructor Summary
StringMapStat() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ booleancontainsKey(String key) + +
+          Returns true if the specified key is contained in this map.
+ intget(String key) + +
+          Returns the value to which the specified key maps or zero if it is not contained in this + map.
+ booleanincrement(String key, + int amount) + +
+          Adds the specified key value pair to this set, overwriting any existing mapping.
+ booleanput(String key, + int value) + +
+          Adds the specified key value pair to this set, overwriting any existing mapping.
+ StringvalueToString() + +
+          Derived statistics must override this method and render their value to a string.
+  + + + + + + + +
Methods inherited from class com.threerings.stats.data.Stat
clone, getCode, getKey, getModCount, getType, getType, initType, isModified, persistTo, setModCount, setModified, toString, unpersistFrom
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+StringMapStat

+
+public StringMapStat()
+
+
+ + + + + + + + +
+Method Detail
+ +

+containsKey

+
+public boolean containsKey(String key)
+
+
Returns true if the specified key is contained in this map. +

+

+
+
+
+
+ +

+get

+
+public int get(String key)
+
+
Returns the value to which the specified key maps or zero if it is not contained in this + map. +

+

+
+
+
+
+ +

+put

+
+public boolean put(String key,
+                   int value)
+
+
Adds the specified key value pair to this set, overwriting any existing mapping. +

+

+ +
Returns:
true if the stat's value was changed, false otherwise.
+
+
+
+ +

+increment

+
+public boolean increment(String key,
+                         int amount)
+
+
Adds the specified key value pair to this set, overwriting any existing mapping. +

+

+ +
Returns:
true if the stat's value was changed, false otherwise.
+
+
+
+ +

+valueToString

+
+public String valueToString()
+
+
Description copied from class: Stat
+
Derived statistics must override this method and render their value to a string. Used by + Stat.toString() and to display the value in game. +

+

+
Specified by:
valueToString in class Stat
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stats/data/StringSetStat.html b/apidocs/com/threerings/stats/data/StringSetStat.html new file mode 100644 index 00000000..4fdf11ad --- /dev/null +++ b/apidocs/com/threerings/stats/data/StringSetStat.html @@ -0,0 +1,405 @@ + + + + + + + +StringSetStat (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stats.data +
+Class StringSetStat

+
+java.lang.Object
+  extended by com.threerings.stats.data.Stat
+      extended by com.threerings.stats.data.SetStat<String>
+          extended by com.threerings.stats.data.StringSetStat
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable, com.threerings.presents.dobj.DSet.Entry, Cloneable
+
+
+
Direct Known Subclasses:
ByteStringSetStat, IntStringSetStat, ShortStringSetStat
+
+
+
+
public abstract class StringSetStat
extends SetStat<String>
+ + +

+Used to track a statistic comprised of a set of strings. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.stats.data.Stat
Stat.AuxDataSource, Stat.Type
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + +
+Constructor Summary
StringSetStat() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ booleanadd(String key) + +
+          Adds the specified string to this set.
+ booleancontains(String key) + +
+          Returns true if the specified string is contained in this set.
+ intsize() + +
+          Returns the number of Strings in this set.
+ String[]values() + +
+          Returns the values in this set.
+ StringvalueToString() + +
+          Derived statistics must override this method and render their value to a string.
+  + + + + + + + +
Methods inherited from class com.threerings.stats.data.Stat
clone, getCode, getKey, getModCount, getType, getType, initType, isModified, persistTo, setModCount, setModified, toString, unpersistFrom
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+StringSetStat

+
+public StringSetStat()
+
+
+ + + + + + + + +
+Method Detail
+ +

+size

+
+public int size()
+
+
Returns the number of Strings in this set. +

+

+
Specified by:
size in class SetStat<String>
+
+
+
+
+
+
+ +

+contains

+
+public boolean contains(String key)
+
+
Returns true if the specified string is contained in this set. +

+

+
Specified by:
contains in class SetStat<String>
+
+
+
+
+
+
+ +

+add

+
+public boolean add(String key)
+
+
Adds the specified string to this set. +

+

+
Specified by:
add in class SetStat<String>
+
+
+ +
Returns:
true if the string was newly added, false if it was already + contained in the set.
+
+
+
+ +

+values

+
+public String[] values()
+
+
Returns the values in this set. Do not modify the returned array. +

+

+
+
+
+
+ +

+valueToString

+
+public String valueToString()
+
+
Description copied from class: Stat
+
Derived statistics must override this method and render their value to a string. Used by + Stat.toString() and to display the value in game. +

+

+
Specified by:
valueToString in class Stat
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stats/data/class-use/ByteByteStringMapStat.html b/apidocs/com/threerings/stats/data/class-use/ByteByteStringMapStat.html new file mode 100644 index 00000000..ef5062e9 --- /dev/null +++ b/apidocs/com/threerings/stats/data/class-use/ByteByteStringMapStat.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.stats.data.ByteByteStringMapStat (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stats.data.ByteByteStringMapStat

+
+No usage of com.threerings.stats.data.ByteByteStringMapStat +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stats/data/class-use/ByteStringSetStat.html b/apidocs/com/threerings/stats/data/class-use/ByteStringSetStat.html new file mode 100644 index 00000000..8205cb71 --- /dev/null +++ b/apidocs/com/threerings/stats/data/class-use/ByteStringSetStat.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.stats.data.ByteStringSetStat (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stats.data.ByteStringSetStat

+
+No usage of com.threerings.stats.data.ByteStringSetStat +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stats/data/class-use/IntArrayStat.html b/apidocs/com/threerings/stats/data/class-use/IntArrayStat.html new file mode 100644 index 00000000..398b4e14 --- /dev/null +++ b/apidocs/com/threerings/stats/data/class-use/IntArrayStat.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.stats.data.IntArrayStat (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stats.data.IntArrayStat

+
+No usage of com.threerings.stats.data.IntArrayStat +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stats/data/class-use/IntSetStat.html b/apidocs/com/threerings/stats/data/class-use/IntSetStat.html new file mode 100644 index 00000000..07d7c289 --- /dev/null +++ b/apidocs/com/threerings/stats/data/class-use/IntSetStat.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class com.threerings.stats.data.IntSetStat (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stats.data.IntSetStat

+
+ + + + + + + + + +
+Packages that use IntSetStat
com.threerings.stats.data  
+  +

+ + + + + +
+Uses of IntSetStat in com.threerings.stats.data
+  +

+ + + + + + + + + +
Methods in com.threerings.stats.data with parameters of type IntSetStat
+ voidIntSetStatAdder.modify(IntSetStat stat) + +
+           
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stats/data/class-use/IntSetStatAdder.html b/apidocs/com/threerings/stats/data/class-use/IntSetStatAdder.html new file mode 100644 index 00000000..1ceebc35 --- /dev/null +++ b/apidocs/com/threerings/stats/data/class-use/IntSetStatAdder.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.stats.data.IntSetStatAdder (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stats.data.IntSetStatAdder

+
+No usage of com.threerings.stats.data.IntSetStatAdder +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stats/data/class-use/IntStat.html b/apidocs/com/threerings/stats/data/class-use/IntStat.html new file mode 100644 index 00000000..104e382f --- /dev/null +++ b/apidocs/com/threerings/stats/data/class-use/IntStat.html @@ -0,0 +1,216 @@ + + + + + + + +Uses of Class com.threerings.stats.data.IntStat (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stats.data.IntStat

+
+ + + + + + + + + +
+Packages that use IntStat
com.threerings.stats.data  
+  +

+ + + + + +
+Uses of IntStat in com.threerings.stats.data
+  +

+ + + + + + + + + + + + + +
Subclasses of IntStat in com.threerings.stats.data
+ classMaxIntStat + +
+          Extends the IntStat by maintaining a maximum value which is updated every time a value + is accumulated to the stat.
+ classMaxValueIntStat + +
+          Extends the IntStat by maintaining the maximum value that the stat has ever been + assigned (unlike MaxIntStat, which tracks the maximum value that the stat has ever + been incremented by).
+  +

+ + + + + + + + + + + + + +
Methods in com.threerings.stats.data with parameters of type IntStat
+ voidIntStatMinimumer.modify(IntStat stat) + +
+           
+ voidIntStatIncrementer.modify(IntStat stat) + +
+           
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stats/data/class-use/IntStatIncrementer.html b/apidocs/com/threerings/stats/data/class-use/IntStatIncrementer.html new file mode 100644 index 00000000..2fb3f492 --- /dev/null +++ b/apidocs/com/threerings/stats/data/class-use/IntStatIncrementer.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.stats.data.IntStatIncrementer (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stats.data.IntStatIncrementer

+
+No usage of com.threerings.stats.data.IntStatIncrementer +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stats/data/class-use/IntStatMinimumer.html b/apidocs/com/threerings/stats/data/class-use/IntStatMinimumer.html new file mode 100644 index 00000000..008feb38 --- /dev/null +++ b/apidocs/com/threerings/stats/data/class-use/IntStatMinimumer.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.stats.data.IntStatMinimumer (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stats.data.IntStatMinimumer

+
+No usage of com.threerings.stats.data.IntStatMinimumer +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stats/data/class-use/IntStringSetStat.html b/apidocs/com/threerings/stats/data/class-use/IntStringSetStat.html new file mode 100644 index 00000000..887a0d5a --- /dev/null +++ b/apidocs/com/threerings/stats/data/class-use/IntStringSetStat.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.stats.data.IntStringSetStat (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stats.data.IntStringSetStat

+
+No usage of com.threerings.stats.data.IntStringSetStat +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stats/data/class-use/MaxIntStat.html b/apidocs/com/threerings/stats/data/class-use/MaxIntStat.html new file mode 100644 index 00000000..355ea3a8 --- /dev/null +++ b/apidocs/com/threerings/stats/data/class-use/MaxIntStat.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.stats.data.MaxIntStat (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stats.data.MaxIntStat

+
+No usage of com.threerings.stats.data.MaxIntStat +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stats/data/class-use/MaxValueIntStat.html b/apidocs/com/threerings/stats/data/class-use/MaxValueIntStat.html new file mode 100644 index 00000000..c8366db1 --- /dev/null +++ b/apidocs/com/threerings/stats/data/class-use/MaxValueIntStat.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.stats.data.MaxValueIntStat (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stats.data.MaxValueIntStat

+
+No usage of com.threerings.stats.data.MaxValueIntStat +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stats/data/class-use/SetStat.html b/apidocs/com/threerings/stats/data/class-use/SetStat.html new file mode 100644 index 00000000..d555a88c --- /dev/null +++ b/apidocs/com/threerings/stats/data/class-use/SetStat.html @@ -0,0 +1,213 @@ + + + + + + + +Uses of Class com.threerings.stats.data.SetStat (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stats.data.SetStat

+
+ + + + + + + + + +
+Packages that use SetStat
com.threerings.stats.data  
+  +

+ + + + + +
+Uses of SetStat in com.threerings.stats.data
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Subclasses of SetStat in com.threerings.stats.data
+ classByteStringSetStat + +
+          A string set that maps its values to bytes.
+ classIntSetStat + +
+          Used to track a statistic comprised of a bounded set of integers.
+ classIntStringSetStat + +
+          A string set that maps its values to integers.
+ classShortStringSetStat + +
+          A string set that maps its values to shorts.
+ classStringSetStat + +
+          Used to track a statistic comprised of a set of strings.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stats/data/class-use/ShortStringSetStat.html b/apidocs/com/threerings/stats/data/class-use/ShortStringSetStat.html new file mode 100644 index 00000000..e79c4e12 --- /dev/null +++ b/apidocs/com/threerings/stats/data/class-use/ShortStringSetStat.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.stats.data.ShortStringSetStat (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stats.data.ShortStringSetStat

+
+No usage of com.threerings.stats.data.ShortStringSetStat +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stats/data/class-use/Stat.AuxDataSource.html b/apidocs/com/threerings/stats/data/class-use/Stat.AuxDataSource.html new file mode 100644 index 00000000..bf38ce32 --- /dev/null +++ b/apidocs/com/threerings/stats/data/class-use/Stat.AuxDataSource.html @@ -0,0 +1,382 @@ + + + + + + + +Uses of Interface com.threerings.stats.data.Stat.AuxDataSource (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.stats.data.Stat.AuxDataSource

+
+ + + + + + + + + + + + + +
+Packages that use Stat.AuxDataSource
com.threerings.stats.data  
com.threerings.stats.server.persist  
+  +

+ + + + + +
+Uses of Stat.AuxDataSource in com.threerings.stats.data
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in com.threerings.stats.data with parameters of type Stat.AuxDataSource
+abstract  voidStat.persistTo(com.threerings.io.ObjectOutputStream out, + Stat.AuxDataSource aux) + +
+          Serializes this instance for storage in the item database.
+ voidShortStringSetStat.persistTo(com.threerings.io.ObjectOutputStream out, + Stat.AuxDataSource aux) + +
+           
+ voidMaxValueIntStat.persistTo(com.threerings.io.ObjectOutputStream out, + Stat.AuxDataSource aux) + +
+           
+ voidMaxIntStat.persistTo(com.threerings.io.ObjectOutputStream out, + Stat.AuxDataSource aux) + +
+           
+ voidIntStringSetStat.persistTo(com.threerings.io.ObjectOutputStream out, + Stat.AuxDataSource aux) + +
+           
+ voidIntStat.persistTo(com.threerings.io.ObjectOutputStream out, + Stat.AuxDataSource aux) + +
+           
+ voidIntSetStat.persistTo(com.threerings.io.ObjectOutputStream out, + Stat.AuxDataSource aux) + +
+           
+ voidIntArrayStat.persistTo(com.threerings.io.ObjectOutputStream out, + Stat.AuxDataSource aux) + +
+           
+ voidByteStringSetStat.persistTo(com.threerings.io.ObjectOutputStream out, + Stat.AuxDataSource aux) + +
+           
+ voidByteByteStringMapStat.persistTo(com.threerings.io.ObjectOutputStream out, + Stat.AuxDataSource aux) + +
+           
+abstract  voidStat.unpersistFrom(com.threerings.io.ObjectInputStream in, + Stat.AuxDataSource aux) + +
+          Unserializes this item from data obtained from the item database.
+ voidShortStringSetStat.unpersistFrom(com.threerings.io.ObjectInputStream in, + Stat.AuxDataSource aux) + +
+           
+ voidMaxValueIntStat.unpersistFrom(com.threerings.io.ObjectInputStream in, + Stat.AuxDataSource aux) + +
+           
+ voidMaxIntStat.unpersistFrom(com.threerings.io.ObjectInputStream in, + Stat.AuxDataSource aux) + +
+           
+ voidIntStringSetStat.unpersistFrom(com.threerings.io.ObjectInputStream in, + Stat.AuxDataSource aux) + +
+           
+ voidIntStat.unpersistFrom(com.threerings.io.ObjectInputStream in, + Stat.AuxDataSource aux) + +
+           
+ voidIntSetStat.unpersistFrom(com.threerings.io.ObjectInputStream in, + Stat.AuxDataSource aux) + +
+           
+ voidIntArrayStat.unpersistFrom(com.threerings.io.ObjectInputStream in, + Stat.AuxDataSource aux) + +
+           
+ voidByteStringSetStat.unpersistFrom(com.threerings.io.ObjectInputStream in, + Stat.AuxDataSource aux) + +
+           
+ voidByteByteStringMapStat.unpersistFrom(com.threerings.io.ObjectInputStream in, + Stat.AuxDataSource aux) + +
+           
+  +

+ + + + + +
+Uses of Stat.AuxDataSource in com.threerings.stats.server.persist
+  +

+ + + + + + + + + +
Classes in com.threerings.stats.server.persist that implement Stat.AuxDataSource
+ classStatRepository + +
+          Responsible for the persistent storage of per-player statistics.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stats/data/class-use/Stat.Type.html b/apidocs/com/threerings/stats/data/class-use/Stat.Type.html new file mode 100644 index 00000000..e874c4e8 --- /dev/null +++ b/apidocs/com/threerings/stats/data/class-use/Stat.Type.html @@ -0,0 +1,437 @@ + + + + + + + +Uses of Interface com.threerings.stats.data.Stat.Type (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.stats.data.Stat.Type

+
+ + + + + + + + + + + + + +
+Packages that use Stat.Type
com.threerings.stats.data  
com.threerings.stats.server.persist  
+  +

+ + + + + +
+Uses of Stat.Type in com.threerings.stats.data
+  +

+ + + + + + + + + + + + + + + + + +
Methods in com.threerings.stats.data that return Stat.Type
+ Stat.TypeStatModifier.getType() + +
+          Returns the Stat.Type of the stat being modified.
+ Stat.TypeStat.getType() + +
+          Returns the type of this statistic.
+static Stat.TypeStat.getType(int code) + +
+          Maps a Stat.Type's code code back to a Stat.Type instance.
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in com.threerings.stats.data with parameters of type Stat.Type
+ + + + + +
+<T> void
+		StatSet.addToSetStat(Stat.Type type, + T value) + +
+          Adds a value to a SetStat.
+ voidStatSet.appendStat(Stat.Type type, + int value) + +
+          Appends an integer value to an IntArrayStat.
+ + + + + +
+<T> boolean
+		StatSet.containsValue(Stat.Type type, + T value) + +
+          Returns true if the specified SetStat contains the specified value, false + otherwise.
+ StringStat.AuxDataSource.getCodeString(Stat.Type type, + int code) + +
+          Maps the specified unique code back to its string value.
+ int[]StatSet.getIntArrayStat(Stat.Type type) + +
+          Returns the current value of the specified integer array statistic.
+ intStatSet.getIntStat(Stat.Type type) + +
+          Returns the current value of the specified integer statistic.
+ intStatSet.getMapValue(Stat.Type type, + String value) + +
+          Returns the value to which the specified string is mapped in a StringMapStat or zero + if the value has not been mapped.
+ intStatSet.getMaxIntStat(Stat.Type type) + +
+          Returns the maximum value by which the specified integer statistic has ever been + incremented.
+ intStatSet.getSetStatSize(Stat.Type type) + +
+          Returns the current size of the specified SetStat statistic.
+ intStat.AuxDataSource.getStringCode(Stat.Type type, + String value) + +
+          Maps the specified string to a unique integer value.
+ voidStatSet.incrementMapStat(Stat.Type type, + String value, + int amount) + +
+          Increments a string value in a StringMapStat.
+ voidStatSet.incrementStat(Stat.Type type, + int delta) + +
+          Increments an integer statistic in this set.
+static intStat.initType(Stat.Type type, + Stat prototype) + +
+          Used by the Stat.Type implementation to map itself to an integer code.
+ voidStatSet.maxStat(Stat.Type type, + int value) + +
+          Sets an integer stat to the specified value, if it exceeds our existing recorded value.
+ voidStatSet.setStat(Stat.Type type, + int value) + +
+          Sets an integer statistic in this set.
+  +

+ + + + + + + + + + + + + + + + + +
Constructors in com.threerings.stats.data with parameters of type Stat.Type
IntSetStatAdder(Stat.Type type, + int value) + +
+           
IntStatIncrementer(Stat.Type type, + int delta) + +
+           
IntStatMinimumer(Stat.Type type, + int minimum) + +
+           
StatModifier(Stat.Type type) + +
+          Creates a modifier that will operate on the supplied stat type.
+  +

+ + + + + +
+Uses of Stat.Type in com.threerings.stats.server.persist
+  +

+ + + + + + + + + + + + + + + + + +
Methods in com.threerings.stats.server.persist with parameters of type Stat.Type
+ voidStatRepository.clearMapping(Stat.Type type, + String value) + +
+          This is only used for testing.
+ StringStatRepository.getCodeString(Stat.Type type, + int code) + +
+           
+ intStatRepository.getStringCode(Stat.Type type, + String value) + +
+           
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stats/data/class-use/Stat.html b/apidocs/com/threerings/stats/data/class-use/Stat.html new file mode 100644 index 00000000..2ae08018 --- /dev/null +++ b/apidocs/com/threerings/stats/data/class-use/Stat.html @@ -0,0 +1,491 @@ + + + + + + + +Uses of Class com.threerings.stats.data.Stat (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stats.data.Stat

+
+ + + + + + + + + + + + + +
+Packages that use Stat
com.threerings.stats.data  
com.threerings.stats.server.persist  
+  +

+ + + + + +
+Uses of Stat in com.threerings.stats.data
+  +

+ + + + + + + + + +
Classes in com.threerings.stats.data with type parameters of type Stat
+ classStatModifier<T extends Stat> + +
+          Encapsulates a modification to a single stat that can be serialized and sent to a different + server, if needed, to update stats loaded at runtime.
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Subclasses of Stat in com.threerings.stats.data
+ classByteByteStringMapStat + +
+          Maps up to 127 string values to integers in the range 0 - 127.
+ classByteStringSetStat + +
+          A string set that maps its values to bytes.
+ classIntArrayStat + +
+          Used to track an integer array statistic.
+ classIntSetStat + +
+          Used to track a statistic comprised of a bounded set of integers.
+ classIntStat + +
+          Used to track a single integer statistic.
+ classIntStringSetStat + +
+          A string set that maps its values to integers.
+ classMaxIntStat + +
+          Extends the IntStat by maintaining a maximum value which is updated every time a value + is accumulated to the stat.
+ classMaxValueIntStat + +
+          Extends the IntStat by maintaining the maximum value that the stat has ever been + assigned (unlike MaxIntStat, which tracks the maximum value that the stat has ever + been incremented by).
+ classSetStat<T> + +
+           
+ classShortStringSetStat + +
+          A string set that maps its values to shorts.
+ classStringMapStat + +
+          Used to track a statistic comprised of a set of strings that map to numeric counts.
+ classStringSetStat + +
+          Used to track a statistic comprised of a set of strings.
+  +

+ + + + + + + + + +
Methods in com.threerings.stats.data with type parameters of type Stat
+ + + + + +
+<T extends Stat> +
+void
+		StatSet.syncStat(StatModifier<T> modifier) + +
+          Updates a stat in this set, using the supplied StatModifier.
+  +

+ + + + + + + + + + + + + +
Methods in com.threerings.stats.data that return Stat
+ StatStat.clone() + +
+           
+ StatStat.Type.newStat() + +
+          Returns a new blank stat instance of the specified type.
+  +

+ + + + + + + + + + + + + + + + + + + + + +
Methods in com.threerings.stats.data with parameters of type Stat
+ voidStatSet.addQuietly(Stat stat) + +
+          Don't call this method, it's only needed by some tricky business we do when preventing + distributed object event generation for all but the bounty criteria related stats.
+ voidStatSet.Container.addToStats(Stat stat) + +
+           
+static intStat.initType(Stat.Type type, + Stat prototype) + +
+          Used by the Stat.Type implementation to map itself to an integer code.
+ voidStatSet.Container.updateStats(Stat stat) + +
+           
+  +

+ + + + + + + + + + + +
Constructor parameters in com.threerings.stats.data with type arguments of type Stat
StatSet(Iterable<Stat> contents) + +
+          Creates a stat set with the specified contents.
StatSet(Iterator<Stat> contents) + +
+          Creates a stat set with the specified contents.
+  +

+ + + + + +
+Uses of Stat in com.threerings.stats.server.persist
+  +

+ + + + + + + + + +
Methods in com.threerings.stats.server.persist with type parameters of type Stat
+ + + + + +
+<T extends Stat> +
+T
+		StatRepository.updateStat(int playerId, + StatModifier<T> modifier) + +
+          Applies a modification to a single stat.
+  +

+ + + + + + + + + +
Methods in com.threerings.stats.server.persist that return types with arguments of type Stat
+ ArrayList<Stat>StatRepository.loadStats(int playerId) + +
+          Loads the stats associated with the specified player.
+  +

+ + + + + + + + + +
Methods in com.threerings.stats.server.persist with parameters of type Stat
+ voidStatRepository.writeModified(int playerId, + Stat[] stats) + +
+          Writes out any of the stats in the supplied array that have been modified since they were + first loaded.
+  +

+ + + + + + + + + +
Method parameters in com.threerings.stats.server.persist with type arguments of type Stat
+ voidStatRepository.writeModified(int playerId, + Iterable<Stat> stats) + +
+          Writes out any of the stats in the supplied iterable that have been modified since they were + first loaded.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stats/data/class-use/StatModifier.html b/apidocs/com/threerings/stats/data/class-use/StatModifier.html new file mode 100644 index 00000000..6c780d8a --- /dev/null +++ b/apidocs/com/threerings/stats/data/class-use/StatModifier.html @@ -0,0 +1,261 @@ + + + + + + + +Uses of Class com.threerings.stats.data.StatModifier (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stats.data.StatModifier

+
+ + + + + + + + + + + + + +
+Packages that use StatModifier
com.threerings.stats.data  
com.threerings.stats.server.persist  
+  +

+ + + + + +
+Uses of StatModifier in com.threerings.stats.data
+  +

+ + + + + + + + + + + + + + + + + +
Subclasses of StatModifier in com.threerings.stats.data
+ classIntSetStatAdder + +
+          Adds a value to an IntSetStat.
+ classIntStatIncrementer + +
+          Increments a particular int stat by a specified amount.
+ classIntStatMinimumer + +
+          Ensures that a particular stat has been set to a minimum value.
+  +

+ + + + + + + + + +
Methods in com.threerings.stats.data with parameters of type StatModifier
+ + + + + +
+<T extends Stat> +
+void
+		StatSet.syncStat(StatModifier<T> modifier) + +
+          Updates a stat in this set, using the supplied StatModifier.
+  +

+ + + + + +
+Uses of StatModifier in com.threerings.stats.server.persist
+  +

+ + + + + + + + + +
Methods in com.threerings.stats.server.persist with parameters of type StatModifier
+ + + + + +
+<T extends Stat> +
+T
+		StatRepository.updateStat(int playerId, + StatModifier<T> modifier) + +
+          Applies a modification to a single stat.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stats/data/class-use/StatSet.Container.html b/apidocs/com/threerings/stats/data/class-use/StatSet.Container.html new file mode 100644 index 00000000..c145afe5 --- /dev/null +++ b/apidocs/com/threerings/stats/data/class-use/StatSet.Container.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Interface com.threerings.stats.data.StatSet.Container (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.stats.data.StatSet.Container

+
+ + + + + + + + + +
+Packages that use StatSet.Container
com.threerings.stats.data  
+  +

+ + + + + +
+Uses of StatSet.Container in com.threerings.stats.data
+  +

+ + + + + + + + + +
Methods in com.threerings.stats.data with parameters of type StatSet.Container
+ voidStatSet.setContainer(StatSet.Container container) + +
+          Wires this stat set up to a containing user object.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stats/data/class-use/StatSet.html b/apidocs/com/threerings/stats/data/class-use/StatSet.html new file mode 100644 index 00000000..30a12e98 --- /dev/null +++ b/apidocs/com/threerings/stats/data/class-use/StatSet.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.stats.data.StatSet (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stats.data.StatSet

+
+No usage of com.threerings.stats.data.StatSet +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stats/data/class-use/StringMapStat.html b/apidocs/com/threerings/stats/data/class-use/StringMapStat.html new file mode 100644 index 00000000..5d7d1a86 --- /dev/null +++ b/apidocs/com/threerings/stats/data/class-use/StringMapStat.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class com.threerings.stats.data.StringMapStat (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stats.data.StringMapStat

+
+ + + + + + + + + +
+Packages that use StringMapStat
com.threerings.stats.data  
+  +

+ + + + + +
+Uses of StringMapStat in com.threerings.stats.data
+  +

+ + + + + + + + + +
Subclasses of StringMapStat in com.threerings.stats.data
+ classByteByteStringMapStat + +
+          Maps up to 127 string values to integers in the range 0 - 127.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stats/data/class-use/StringSetStat.html b/apidocs/com/threerings/stats/data/class-use/StringSetStat.html new file mode 100644 index 00000000..47ad553b --- /dev/null +++ b/apidocs/com/threerings/stats/data/class-use/StringSetStat.html @@ -0,0 +1,197 @@ + + + + + + + +Uses of Class com.threerings.stats.data.StringSetStat (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stats.data.StringSetStat

+
+ + + + + + + + + +
+Packages that use StringSetStat
com.threerings.stats.data  
+  +

+ + + + + +
+Uses of StringSetStat in com.threerings.stats.data
+  +

+ + + + + + + + + + + + + + + + + +
Subclasses of StringSetStat in com.threerings.stats.data
+ classByteStringSetStat + +
+          A string set that maps its values to bytes.
+ classIntStringSetStat + +
+          A string set that maps its values to integers.
+ classShortStringSetStat + +
+          A string set that maps its values to shorts.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stats/data/package-frame.html b/apidocs/com/threerings/stats/data/package-frame.html new file mode 100644 index 00000000..1cb4cc8e --- /dev/null +++ b/apidocs/com/threerings/stats/data/package-frame.html @@ -0,0 +1,82 @@ + + + + + + + +com.threerings.stats.data (vilya 1.3 API) + + + + + + + + + + + +com.threerings.stats.data + + + + +
+Interfaces  + +
+Stat.AuxDataSource +
+Stat.Type +
+StatSet.Container
+ + + + + + +
+Classes  + +
+ByteByteStringMapStat +
+ByteStringSetStat +
+IntArrayStat +
+IntSetStat +
+IntSetStatAdder +
+IntStat +
+IntStatIncrementer +
+IntStatMinimumer +
+IntStringSetStat +
+MaxIntStat +
+MaxValueIntStat +
+SetStat +
+ShortStringSetStat +
+Stat +
+StatModifier +
+StatSet +
+StringMapStat +
+StringSetStat
+ + + + diff --git a/apidocs/com/threerings/stats/data/package-summary.html b/apidocs/com/threerings/stats/data/package-summary.html new file mode 100644 index 00000000..7fee963c --- /dev/null +++ b/apidocs/com/threerings/stats/data/package-summary.html @@ -0,0 +1,254 @@ + + + + + + + +com.threerings.stats.data (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.stats.data +

+ + + + + + + + + + + + + + + + + +
+Interface Summary
Stat.AuxDataSourceProvides auxilliary information to statistics during the persisting process.
Stat.TypeDefines the various per-player tracked statistics.
StatSet.ContainerAn interface to be implemented by an entity that wishes to be notified when the contents of + a stat set change.
+  + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Class Summary
ByteByteStringMapStatMaps up to 127 string values to integers in the range 0 - 127.
ByteStringSetStatA string set that maps its values to bytes.
IntArrayStatUsed to track an integer array statistic.
IntSetStatUsed to track a statistic comprised of a bounded set of integers.
IntSetStatAdderAdds a value to an IntSetStat.
IntStatUsed to track a single integer statistic.
IntStatIncrementerIncrements a particular int stat by a specified amount.
IntStatMinimumerEnsures that a particular stat has been set to a minimum value.
IntStringSetStatA string set that maps its values to integers.
MaxIntStatExtends the IntStat by maintaining a maximum value which is updated every time a value + is accumulated to the stat.
MaxValueIntStatExtends the IntStat by maintaining the maximum value that the stat has ever been + assigned (unlike MaxIntStat, which tracks the maximum value that the stat has ever + been incremented by).
SetStat<T> 
ShortStringSetStatA string set that maps its values to shorts.
StatA base class for persistent statistics tracked on a per-player basis (some for a single game, + others for all time).
StatModifier<T extends Stat>Encapsulates a modification to a single stat that can be serialized and sent to a different + server, if needed, to update stats loaded at runtime.
StatSetA distributed set containing Stat objects.
StringMapStatUsed to track a statistic comprised of a set of strings that map to numeric counts.
StringSetStatUsed to track a statistic comprised of a set of strings.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stats/data/package-tree.html b/apidocs/com/threerings/stats/data/package-tree.html new file mode 100644 index 00000000..c675ad95 --- /dev/null +++ b/apidocs/com/threerings/stats/data/package-tree.html @@ -0,0 +1,178 @@ + + + + + + + +com.threerings.stats.data Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.stats.data +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stats/data/package-use.html b/apidocs/com/threerings/stats/data/package-use.html new file mode 100644 index 00000000..8f38dba0 --- /dev/null +++ b/apidocs/com/threerings/stats/data/package-use.html @@ -0,0 +1,267 @@ + + + + + + + +Uses of Package com.threerings.stats.data (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.stats.data

+
+ + + + + + + + + + + + + +
+Packages that use com.threerings.stats.data
com.threerings.stats.data  
com.threerings.stats.server.persist  
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Classes in com.threerings.stats.data used by com.threerings.stats.data
IntSetStat + +
+          Used to track a statistic comprised of a bounded set of integers.
IntStat + +
+          Used to track a single integer statistic.
SetStat + +
+           
Stat + +
+          A base class for persistent statistics tracked on a per-player basis (some for a single game, + others for all time).
Stat.AuxDataSource + +
+          Provides auxilliary information to statistics during the persisting process.
Stat.Type + +
+          Defines the various per-player tracked statistics.
StatModifier + +
+          Encapsulates a modification to a single stat that can be serialized and sent to a different + server, if needed, to update stats loaded at runtime.
StatSet.Container + +
+          An interface to be implemented by an entity that wishes to be notified when the contents of + a stat set change.
StringMapStat + +
+          Used to track a statistic comprised of a set of strings that map to numeric counts.
StringSetStat + +
+          Used to track a statistic comprised of a set of strings.
+  +

+ + + + + + + + + + + + + + + + + +
+Classes in com.threerings.stats.data used by com.threerings.stats.server.persist
Stat + +
+          A base class for persistent statistics tracked on a per-player basis (some for a single game, + others for all time).
Stat.AuxDataSource + +
+          Provides auxilliary information to statistics during the persisting process.
Stat.Type + +
+          Defines the various per-player tracked statistics.
StatModifier + +
+          Encapsulates a modification to a single stat that can be serialized and sent to a different + server, if needed, to update stats loaded at runtime.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stats/package-frame.html b/apidocs/com/threerings/stats/package-frame.html new file mode 100644 index 00000000..6b13c199 --- /dev/null +++ b/apidocs/com/threerings/stats/package-frame.html @@ -0,0 +1,33 @@ + + + + + + + +com.threerings.stats (vilya 1.3 API) + + + + + + + + + + + +com.threerings.stats + + + + +
+Classes  + +
+Log
+ + + + diff --git a/apidocs/com/threerings/stats/package-summary.html b/apidocs/com/threerings/stats/package-summary.html new file mode 100644 index 00000000..206ec2c6 --- /dev/null +++ b/apidocs/com/threerings/stats/package-summary.html @@ -0,0 +1,158 @@ + + + + + + + +com.threerings.stats (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.stats +

+ + + + + + + + + +
+Class Summary
LogA placeholder class that contains a reference to the log object used by this project.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stats/package-tree.html b/apidocs/com/threerings/stats/package-tree.html new file mode 100644 index 00000000..8a7c88cb --- /dev/null +++ b/apidocs/com/threerings/stats/package-tree.html @@ -0,0 +1,154 @@ + + + + + + + +com.threerings.stats Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.stats +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stats/package-use.html b/apidocs/com/threerings/stats/package-use.html new file mode 100644 index 00000000..49d97d02 --- /dev/null +++ b/apidocs/com/threerings/stats/package-use.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Package com.threerings.stats (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.stats

+
+No usage of com.threerings.stats +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stats/server/persist/MaxStatCodeRecord.html b/apidocs/com/threerings/stats/server/persist/MaxStatCodeRecord.html new file mode 100644 index 00000000..074258c3 --- /dev/null +++ b/apidocs/com/threerings/stats/server/persist/MaxStatCodeRecord.html @@ -0,0 +1,313 @@ + + + + + + + +MaxStatCodeRecord (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stats.server.persist +
+Class MaxStatCodeRecord

+
+java.lang.Object
+  extended by com.samskivert.depot.impl.QueryResult
+      extended by com.samskivert.depot.PersistentRecord
+          extended by com.threerings.stats.server.persist.MaxStatCodeRecord
+
+
+
All Implemented Interfaces:
Serializable, Cloneable
+
+
+
+
public class MaxStatCodeRecord
extends PersistentRecord
+ + +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + + + + + + + + + + + + + +
+Field Summary
+static Class<MaxStatCodeRecord>_R + +
+           
+static ColumnExp<Integer>MAX_CODE + +
+           
+ intmaxCode + +
+           
+  + + + + + + + + + + +
+Constructor Summary
MaxStatCodeRecord() + +
+           
+  + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from class com.samskivert.depot.impl.QueryResult
clone
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+_R

+
+public static final Class<MaxStatCodeRecord> _R
+
+
+
+
+
+ +

+MAX_CODE

+
+public static final ColumnExp<Integer> MAX_CODE
+
+
+
+
+
+ +

+maxCode

+
+public int maxCode
+
+
+
+
+ + + + + + + + +
+Constructor Detail
+ +

+MaxStatCodeRecord

+
+public MaxStatCodeRecord()
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stats/server/persist/StatRecord.html b/apidocs/com/threerings/stats/server/persist/StatRecord.html new file mode 100644 index 00000000..acf3c655 --- /dev/null +++ b/apidocs/com/threerings/stats/server/persist/StatRecord.html @@ -0,0 +1,548 @@ + + + + + + + +StatRecord (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stats.server.persist +
+Class StatRecord

+
+java.lang.Object
+  extended by com.samskivert.depot.impl.QueryResult
+      extended by com.samskivert.depot.PersistentRecord
+          extended by com.threerings.stats.server.persist.StatRecord
+
+
+
All Implemented Interfaces:
Serializable, Cloneable
+
+
+
+
public class StatRecord
extends PersistentRecord
+ + +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static Class<StatRecord>_R + +
+           
+static ColumnExp<Byte>MOD_COUNT + +
+           
+ bytemodCount + +
+          The number of times this stat has been updated, so that simultaneous attempts to update + the same stat in the repository can be caught and handled.
+static ColumnExp<Integer>PLAYER_ID + +
+           
+ intplayerId + +
+          The identifier of the player this is a stat for.
+static intSCHEMA_VERSION + +
+           
+static ColumnExp<Integer>STAT_CODE + +
+           
+static ColumnExp<byte[]>STAT_DATA + +
+           
+ intstatCode + +
+          The code of the stat.
+ byte[]statData + +
+          The data associated with the stat.
+  + + + + + + + + + + + + + + + + +
+Constructor Summary
StatRecord() + +
+          An empty constructor for unmarshalling.
StatRecord(int playerId, + int statCode, + byte[] data) + +
+          A constructor that populates all our fields.
StatRecord(int playerId, + int statCode, + byte[] data, + byte modCount) + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+static Key<StatRecord>getKey(int playerId, + int statCode) + +
+          Create and return a primary Key to identify a StatRecord + with the supplied key values.
+ StringtoString() + +
+           
+  + + + + + + + +
Methods inherited from class com.samskivert.depot.impl.QueryResult
clone
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+_R

+
+public static final Class<StatRecord> _R
+
+
+
+
+
+ +

+PLAYER_ID

+
+public static final ColumnExp<Integer> PLAYER_ID
+
+
+
+
+
+ +

+STAT_CODE

+
+public static final ColumnExp<Integer> STAT_CODE
+
+
+
+
+
+ +

+STAT_DATA

+
+public static final ColumnExp<byte[]> STAT_DATA
+
+
+
+
+
+ +

+MOD_COUNT

+
+public static final ColumnExp<Byte> MOD_COUNT
+
+
+
+
+
+ +

+SCHEMA_VERSION

+
+public static final int SCHEMA_VERSION
+
+
+
See Also:
Constant Field Values
+
+
+ +

+playerId

+
+public int playerId
+
+
The identifier of the player this is a stat for. +

+

+
+
+
+ +

+statCode

+
+public int statCode
+
+
The code of the stat. +

+

+
+
+
+ +

+statData

+
+public byte[] statData
+
+
The data associated with the stat. +

+

+
+
+
+ +

+modCount

+
+public byte modCount
+
+
The number of times this stat has been updated, so that simultaneous attempts to update + the same stat in the repository can be caught and handled. Stored as a byte because + we don't expect to ever have more than a couple simultaneous attempts to update a stat. +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+StatRecord

+
+public StatRecord()
+
+
An empty constructor for unmarshalling. +

+

+
+ +

+StatRecord

+
+public StatRecord(int playerId,
+                  int statCode,
+                  byte[] data)
+
+
A constructor that populates all our fields. +

+

+
+ +

+StatRecord

+
+public StatRecord(int playerId,
+                  int statCode,
+                  byte[] data,
+                  byte modCount)
+
+
+ + + + + + + + +
+Method Detail
+ +

+toString

+
+public String toString()
+
+
+
Overrides:
toString in class Object
+
+
+
+
+
+
+ +

+getKey

+
+public static Key<StatRecord> getKey(int playerId,
+                                     int statCode)
+
+
Create and return a primary Key to identify a StatRecord + with the supplied key values. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stats/server/persist/StatRepository.html b/apidocs/com/threerings/stats/server/persist/StatRepository.html new file mode 100644 index 00000000..0a52b356 --- /dev/null +++ b/apidocs/com/threerings/stats/server/persist/StatRepository.html @@ -0,0 +1,519 @@ + + + + + + + +StatRepository (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stats.server.persist +
+Class StatRepository

+
+java.lang.Object
+  extended by com.samskivert.depot.DepotRepository
+      extended by com.threerings.stats.server.persist.StatRepository
+
+
+
All Implemented Interfaces:
Stat.AuxDataSource
+
+
+
+
public class StatRepository
extends DepotRepository
implements Stat.AuxDataSource
+ + +

+Responsible for the persistent storage of per-player statistics. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class com.samskivert.depot.DepotRepository
DepotRepository.CacheStrategy
+  + + + + + + + + + + + +
+Constructor Summary
StatRepository(PersistenceContext context) + +
+          Constructs a new statistics repository with the specified persistence context.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidclearMapping(Stat.Type type, + String value) + +
+          This is only used for testing.
+ voiddeleteStats(int playerId) + +
+          Deletes all stats associated with the specified player.
+ StringgetCodeString(Stat.Type type, + int code) + +
+          Maps the specified unique code back to its string value.
+ intgetStringCode(Stat.Type type, + String value) + +
+          Maps the specified string to a unique integer value.
+ ArrayList<Stat>loadStats(int playerId) + +
+          Loads the stats associated with the specified player.
+ voidpurgePlayers(Collection<Integer> playerIds) + +
+          Deletes all data associated with the supplied players.
+ + + + + +
+<T extends Stat> +
+T
+		updateStat(int playerId, + StatModifier<T> modifier) + +
+          Applies a modification to a single stat.
+ voidwriteModified(int playerId, + Iterable<Stat> stats) + +
+          Writes out any of the stats in the supplied iterable that have been modified since they were + first loaded.
+ voidwriteModified(int playerId, + Stat[] stats) + +
+          Writes out any of the stats in the supplied array that have been modified since they were + first loaded.
+  + + + + + + + +
Methods inherited from class com.samskivert.depot.DepotRepository
delete, delete, deleteAll, deleteAll, findAll, findAll, findAll, findAll, findAllKeys, findAllKeys, from, insert, load, load, load, load, loadAll, loadAll, store, update, update, updatePartial, updatePartial, updatePartial, updatePartial, updatePartial
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+StatRepository

+
+@Inject
+public StatRepository(PersistenceContext context)
+
+
Constructs a new statistics repository with the specified persistence context. +

+

+ + + + + + + + +
+Method Detail
+ +

+updateStat

+
+public <T extends Stat> T updateStat(int playerId,
+                                     StatModifier<T> modifier)
+
+
Applies a modification to a single stat. If the stat in question does not exist, a blank + instance will be created via Stat.Type.newStat(). +

+

+
+
+
+ +
Returns:
the modified Stat, if any modification took place; or null if the modification had + no effect on the stat's data.
+
+
+
+ +

+loadStats

+
+public ArrayList<Stat> loadStats(int playerId)
+
+
Loads the stats associated with the specified player. +

+

+
+
+
+
+
+
+
+ +

+deleteStats

+
+public void deleteStats(int playerId)
+
+
Deletes all stats associated with the specified player. +

+

+
+
+
+
+
+
+
+ +

+writeModified

+
+public void writeModified(int playerId,
+                          Stat[] stats)
+
+
Writes out any of the stats in the supplied array that have been modified since they were + first loaded. Exceptions that occur while writing the stats will be caught and logged. +

+

+
+
+
+
+
+
+
+ +

+writeModified

+
+public void writeModified(int playerId,
+                          Iterable<Stat> stats)
+
+
Writes out any of the stats in the supplied iterable that have been modified since they were + first loaded. Exceptions that occur while writing the stats will be caught and logged. +

+

+
+
+
+
+
+
+
+ +

+getStringCode

+
+public int getStringCode(Stat.Type type,
+                         String value)
+
+
Description copied from interface: Stat.AuxDataSource
+
Maps the specified string to a unique integer value. +

+

+
Specified by:
getStringCode in interface Stat.AuxDataSource
+
+
+
+
+
+
+ +

+getCodeString

+
+public String getCodeString(Stat.Type type,
+                            int code)
+
+
Description copied from interface: Stat.AuxDataSource
+
Maps the specified unique code back to its string value. +

+

+
Specified by:
getCodeString in interface Stat.AuxDataSource
+
+
+
+
+
+
+ +

+clearMapping

+
+public void clearMapping(Stat.Type type,
+                         String value)
+
+
This is only used for testing. Do not call this method. +

+

+
+
+
+
+
+
+
+ +

+purgePlayers

+
+public void purgePlayers(Collection<Integer> playerIds)
+
+
Deletes all data associated with the supplied players. +

+

+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stats/server/persist/StringCodeRecord.html b/apidocs/com/threerings/stats/server/persist/StringCodeRecord.html new file mode 100644 index 00000000..1d6af159 --- /dev/null +++ b/apidocs/com/threerings/stats/server/persist/StringCodeRecord.html @@ -0,0 +1,503 @@ + + + + + + + +StringCodeRecord (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.stats.server.persist +
+Class StringCodeRecord

+
+java.lang.Object
+  extended by com.samskivert.depot.impl.QueryResult
+      extended by com.samskivert.depot.PersistentRecord
+          extended by com.threerings.stats.server.persist.StringCodeRecord
+
+
+
All Implemented Interfaces:
Serializable, Cloneable
+
+
+
+
public class StringCodeRecord
extends PersistentRecord
+ + +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static Class<StringCodeRecord>_R + +
+           
+ intcode + +
+           
+static ColumnExp<Integer>CODE + +
+           
+static intSCHEMA_VERSION + +
+           
+static ColumnExp<Integer>STAT_CODE + +
+           
+ intstatCode + +
+          The code of the stat.
+ Stringvalue + +
+           
+static ColumnExp<String>VALUE + +
+           
+  + + + + + + + + + + + + + +
+Constructor Summary
StringCodeRecord() + +
+          An empty constructor for unmarshalling.
StringCodeRecord(int statCode, + String value, + int code) + +
+          A constructor that populates all our fields.
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+static Key<StringCodeRecord>getKey(int statCode, + String value) + +
+          Create and return a primary Key to identify a StringCodeRecord + with the supplied key values.
+static ColumnExp<?>[]statCodeCode() + +
+          Defines the statCodeCode unique index.
+static ColumnExp<?>[]statCodeValue() + +
+          Defines the statCodeValue unique index.
+  + + + + + + + +
Methods inherited from class com.samskivert.depot.impl.QueryResult
clone
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+_R

+
+public static final Class<StringCodeRecord> _R
+
+
+
+
+
+ +

+STAT_CODE

+
+public static final ColumnExp<Integer> STAT_CODE
+
+
+
+
+
+ +

+VALUE

+
+public static final ColumnExp<String> VALUE
+
+
+
+
+
+ +

+CODE

+
+public static final ColumnExp<Integer> CODE
+
+
+
+
+
+ +

+SCHEMA_VERSION

+
+public static final int SCHEMA_VERSION
+
+
+
See Also:
Constant Field Values
+
+
+ +

+statCode

+
+public int statCode
+
+
The code of the stat. +

+

+
+
+
+ +

+value

+
+public String value
+
+
+
+
+
+ +

+code

+
+public int code
+
+
+
+
+ + + + + + + + +
+Constructor Detail
+ +

+StringCodeRecord

+
+public StringCodeRecord()
+
+
An empty constructor for unmarshalling. +

+

+
+ +

+StringCodeRecord

+
+public StringCodeRecord(int statCode,
+                        String value,
+                        int code)
+
+
A constructor that populates all our fields. +

+

+ + + + + + + + +
+Method Detail
+ +

+statCodeValue

+
+public static ColumnExp<?>[] statCodeValue()
+
+
Defines the statCodeValue unique index. +

+

+
+
+
+
+ +

+statCodeCode

+
+public static ColumnExp<?>[] statCodeCode()
+
+
Defines the statCodeCode unique index. +

+

+
+
+
+
+ +

+getKey

+
+public static Key<StringCodeRecord> getKey(int statCode,
+                                           String value)
+
+
Create and return a primary Key to identify a StringCodeRecord + with the supplied key values. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stats/server/persist/class-use/MaxStatCodeRecord.html b/apidocs/com/threerings/stats/server/persist/class-use/MaxStatCodeRecord.html new file mode 100644 index 00000000..b5461724 --- /dev/null +++ b/apidocs/com/threerings/stats/server/persist/class-use/MaxStatCodeRecord.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class com.threerings.stats.server.persist.MaxStatCodeRecord (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stats.server.persist.MaxStatCodeRecord

+
+ + + + + + + + + +
+Packages that use MaxStatCodeRecord
com.threerings.stats.server.persist  
+  +

+ + + + + +
+Uses of MaxStatCodeRecord in com.threerings.stats.server.persist
+  +

+ + + + + + + + + +
Fields in com.threerings.stats.server.persist with type parameters of type MaxStatCodeRecord
+static Class<MaxStatCodeRecord>MaxStatCodeRecord._R + +
+           
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stats/server/persist/class-use/StatRecord.html b/apidocs/com/threerings/stats/server/persist/class-use/StatRecord.html new file mode 100644 index 00000000..9c4651b6 --- /dev/null +++ b/apidocs/com/threerings/stats/server/persist/class-use/StatRecord.html @@ -0,0 +1,199 @@ + + + + + + + +Uses of Class com.threerings.stats.server.persist.StatRecord (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stats.server.persist.StatRecord

+
+ + + + + + + + + +
+Packages that use StatRecord
com.threerings.stats.server.persist  
+  +

+ + + + + +
+Uses of StatRecord in com.threerings.stats.server.persist
+  +

+ + + + + + + + + +
Fields in com.threerings.stats.server.persist with type parameters of type StatRecord
+static Class<StatRecord>StatRecord._R + +
+           
+  +

+ + + + + + + + + +
Methods in com.threerings.stats.server.persist that return types with arguments of type StatRecord
+static Key<StatRecord>StatRecord.getKey(int playerId, + int statCode) + +
+          Create and return a primary Key to identify a StatRecord + with the supplied key values.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stats/server/persist/class-use/StatRepository.html b/apidocs/com/threerings/stats/server/persist/class-use/StatRepository.html new file mode 100644 index 00000000..12a6362b --- /dev/null +++ b/apidocs/com/threerings/stats/server/persist/class-use/StatRepository.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.stats.server.persist.StatRepository (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stats.server.persist.StatRepository

+
+No usage of com.threerings.stats.server.persist.StatRepository +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stats/server/persist/class-use/StringCodeRecord.html b/apidocs/com/threerings/stats/server/persist/class-use/StringCodeRecord.html new file mode 100644 index 00000000..0233a351 --- /dev/null +++ b/apidocs/com/threerings/stats/server/persist/class-use/StringCodeRecord.html @@ -0,0 +1,199 @@ + + + + + + + +Uses of Class com.threerings.stats.server.persist.StringCodeRecord (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.stats.server.persist.StringCodeRecord

+
+ + + + + + + + + +
+Packages that use StringCodeRecord
com.threerings.stats.server.persist  
+  +

+ + + + + +
+Uses of StringCodeRecord in com.threerings.stats.server.persist
+  +

+ + + + + + + + + +
Fields in com.threerings.stats.server.persist with type parameters of type StringCodeRecord
+static Class<StringCodeRecord>StringCodeRecord._R + +
+           
+  +

+ + + + + + + + + +
Methods in com.threerings.stats.server.persist that return types with arguments of type StringCodeRecord
+static Key<StringCodeRecord>StringCodeRecord.getKey(int statCode, + String value) + +
+          Create and return a primary Key to identify a StringCodeRecord + with the supplied key values.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stats/server/persist/package-frame.html b/apidocs/com/threerings/stats/server/persist/package-frame.html new file mode 100644 index 00000000..5e942990 --- /dev/null +++ b/apidocs/com/threerings/stats/server/persist/package-frame.html @@ -0,0 +1,39 @@ + + + + + + + +com.threerings.stats.server.persist (vilya 1.3 API) + + + + + + + + + + + +com.threerings.stats.server.persist + + + + +
+Classes  + +
+MaxStatCodeRecord +
+StatRecord +
+StatRepository +
+StringCodeRecord
+ + + + diff --git a/apidocs/com/threerings/stats/server/persist/package-summary.html b/apidocs/com/threerings/stats/server/persist/package-summary.html new file mode 100644 index 00000000..a644a906 --- /dev/null +++ b/apidocs/com/threerings/stats/server/persist/package-summary.html @@ -0,0 +1,170 @@ + + + + + + + +com.threerings.stats.server.persist (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.stats.server.persist +

+ + + + + + + + + + + + + + + + + + + + + +
+Class Summary
MaxStatCodeRecord 
StatRecord 
StatRepositoryResponsible for the persistent storage of per-player statistics.
StringCodeRecord 
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stats/server/persist/package-tree.html b/apidocs/com/threerings/stats/server/persist/package-tree.html new file mode 100644 index 00000000..93b4d90b --- /dev/null +++ b/apidocs/com/threerings/stats/server/persist/package-tree.html @@ -0,0 +1,162 @@ + + + + + + + +com.threerings.stats.server.persist Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.stats.server.persist +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/stats/server/persist/package-use.html b/apidocs/com/threerings/stats/server/persist/package-use.html new file mode 100644 index 00000000..34e02f9a --- /dev/null +++ b/apidocs/com/threerings/stats/server/persist/package-use.html @@ -0,0 +1,183 @@ + + + + + + + +Uses of Package com.threerings.stats.server.persist (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.stats.server.persist

+
+ + + + + + + + + +
+Packages that use com.threerings.stats.server.persist
com.threerings.stats.server.persist  
+  +

+ + + + + + + + + + + + + + +
+Classes in com.threerings.stats.server.persist used by com.threerings.stats.server.persist
MaxStatCodeRecord + +
+           
StatRecord + +
+           
StringCodeRecord + +
+           
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/Log.html b/apidocs/com/threerings/whirled/Log.html new file mode 100644 index 00000000..544aa0f9 --- /dev/null +++ b/apidocs/com/threerings/whirled/Log.html @@ -0,0 +1,265 @@ + + + + + + + +Log (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled +
+Class Log

+
+java.lang.Object
+  extended by com.threerings.whirled.Log
+
+
+
+
public class Log
extends Object
+ + +

+Contains a reference to the log object used by the Whirled services. +

+ +

+

+ +

+ + + + + + + + + + + +
+Field Summary
+static Loggerlog + +
+           
+  + + + + + + + + + + +
+Constructor Summary
Log() + +
+           
+  + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+log

+
+public static Logger log
+
+
+
+
+ + + + + + + + +
+Constructor Detail
+ +

+Log

+
+public Log()
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/class-use/Log.html b/apidocs/com/threerings/whirled/class-use/Log.html new file mode 100644 index 00000000..343f899f --- /dev/null +++ b/apidocs/com/threerings/whirled/class-use/Log.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.whirled.Log (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.Log

+
+No usage of com.threerings.whirled.Log +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/client/SceneController.html b/apidocs/com/threerings/whirled/client/SceneController.html new file mode 100644 index 00000000..13a046a3 --- /dev/null +++ b/apidocs/com/threerings/whirled/client/SceneController.html @@ -0,0 +1,371 @@ + + + + + + + +SceneController (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.client +
+Class SceneController

+
+java.lang.Object
+  extended by com.samskivert.swing.Controller
+      extended by com.threerings.crowd.client.PlaceController
+          extended by com.threerings.whirled.client.SceneController
+
+
+
All Implemented Interfaces:
ActionListener, EventListener
+
+
+
Direct Known Subclasses:
SpotSceneController
+
+
+
+
public abstract class SceneController
extends com.threerings.crowd.client.PlaceController
+ + +

+The base scene controller class. It is expected that users of the + Whirled services will extend this controller class when creating + specialized controllers for their scenes. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.crowd.client.PlaceController
com.threerings.crowd.client.PlaceController.DelegateOp
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class com.samskivert.swing.Controller
DISPATCHER
+  + + + + + + + + + + +
+Constructor Summary
SceneController() + +
+           
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voiddidLeavePlace(com.threerings.crowd.data.PlaceObject plobj) + +
+           
+ voidinit(com.threerings.crowd.util.CrowdContext ctx, + com.threerings.crowd.data.PlaceConfig config) + +
+           
+ voidwillEnterPlace(com.threerings.crowd.data.PlaceObject plobj) + +
+           
+  + + + + + + + +
Methods inherited from class com.threerings.crowd.client.PlaceController
getPlaceConfig, getPlaceView, handleAction, mayLeavePlace
+  + + + + + + + +
Methods inherited from class com.samskivert.swing.Controller
actionPerformed, configureAction, createActionButton, handleAction, handleAction, handleAction, postAction, postAction, postAction, setControlledPanel, wasAdded, wasRemoved
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+SceneController

+
+public SceneController()
+
+
+ + + + + + + + +
+Method Detail
+ +

+init

+
+public void init(com.threerings.crowd.util.CrowdContext ctx,
+                 com.threerings.crowd.data.PlaceConfig config)
+
+
+
Overrides:
init in class com.threerings.crowd.client.PlaceController
+
+
+
+
+
+
+ +

+willEnterPlace

+
+public void willEnterPlace(com.threerings.crowd.data.PlaceObject plobj)
+
+
+
Overrides:
willEnterPlace in class com.threerings.crowd.client.PlaceController
+
+
+
+
+
+
+ +

+didLeavePlace

+
+public void didLeavePlace(com.threerings.crowd.data.PlaceObject plobj)
+
+
+
Overrides:
didLeavePlace in class com.threerings.crowd.client.PlaceController
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/client/SceneDecoder.html b/apidocs/com/threerings/whirled/client/SceneDecoder.html new file mode 100644 index 00000000..272649d3 --- /dev/null +++ b/apidocs/com/threerings/whirled/client/SceneDecoder.html @@ -0,0 +1,358 @@ + + + + + + + +SceneDecoder (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.client +
+Class SceneDecoder

+
+java.lang.Object
+  extended by com.threerings.presents.client.InvocationDecoder
+      extended by com.threerings.whirled.client.SceneDecoder
+
+
+
+
public class SceneDecoder
extends com.threerings.presents.client.InvocationDecoder
+ + +

+Dispatches calls to a SceneReceiver instance. +

+ +

+

+ +

+ + + + + + + + + + + + + + + +
+Field Summary
+static intFORCED_MOVE + +
+          The method id used to dispatch SceneReceiver.forcedMove(int) + notifications.
+static StringRECEIVER_CODE + +
+          The generated hash code used to identify this receiver class.
+  + + + + + + + +
Fields inherited from class com.threerings.presents.client.InvocationDecoder
receiver
+  + + + + + + + + + + +
+Constructor Summary
SceneDecoder(SceneReceiver receiver) + +
+          Creates a decoder that may be registered to dispatch invocation + service notifications to the specified receiver.
+  + + + + + + + + + + + + + + + +
+Method Summary
+ voiddispatchNotification(int methodId, + Object[] args) + +
+           
+ StringgetReceiverCode() + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+RECEIVER_CODE

+
+public static final String RECEIVER_CODE
+
+
The generated hash code used to identify this receiver class. +

+

+
See Also:
Constant Field Values
+
+
+ +

+FORCED_MOVE

+
+public static final int FORCED_MOVE
+
+
The method id used to dispatch SceneReceiver.forcedMove(int) + notifications. +

+

+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Constructor Detail
+ +

+SceneDecoder

+
+public SceneDecoder(SceneReceiver receiver)
+
+
Creates a decoder that may be registered to dispatch invocation + service notifications to the specified receiver. +

+

+ + + + + + + + +
+Method Detail
+ +

+getReceiverCode

+
+public String getReceiverCode()
+
+
+
Specified by:
getReceiverCode in class com.threerings.presents.client.InvocationDecoder
+
+
+
+
+
+
+ +

+dispatchNotification

+
+public void dispatchNotification(int methodId,
+                                 Object[] args)
+
+
+
Overrides:
dispatchNotification in class com.threerings.presents.client.InvocationDecoder
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/client/SceneDirector.MoveHandler.html b/apidocs/com/threerings/whirled/client/SceneDirector.MoveHandler.html new file mode 100644 index 00000000..3e888a68 --- /dev/null +++ b/apidocs/com/threerings/whirled/client/SceneDirector.MoveHandler.html @@ -0,0 +1,221 @@ + + + + + + + +SceneDirector.MoveHandler (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.client +
+Interface SceneDirector.MoveHandler

+
+
All Known Implementing Classes:
ZoneDirector
+
+
+
Enclosing class:
SceneDirector
+
+
+
+
public static interface SceneDirector.MoveHandler
+ + +

+Used to recover from a problem after a completed moveTo. +

+ +

+

+ +

+ + + + + + + + + + + + +
+Method Summary
+ voidrecoverMoveTo(int previousSceneId) + +
+          Should instruct the client to move the last known working location (as well as clean up + after the failed moveTo request).
+  +

+ + + + + + + + +
+Method Detail
+ +

+recoverMoveTo

+
+void recoverMoveTo(int previousSceneId)
+
+
Should instruct the client to move the last known working location (as well as clean up + after the failed moveTo request). +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/client/SceneDirector.html b/apidocs/com/threerings/whirled/client/SceneDirector.html new file mode 100644 index 00000000..b6497310 --- /dev/null +++ b/apidocs/com/threerings/whirled/client/SceneDirector.html @@ -0,0 +1,842 @@ + + + + + + + +SceneDirector (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.client +
+Class SceneDirector

+
+java.lang.Object
+  extended by com.threerings.presents.client.BasicDirector
+      extended by com.threerings.whirled.client.SceneDirector
+
+
+
All Implemented Interfaces:
com.threerings.crowd.client.LocationDirector.FailureHandler, com.threerings.crowd.data.LocationCodes, com.threerings.presents.client.InvocationReceiver, com.threerings.presents.client.InvocationService.InvocationListener, com.threerings.presents.client.SessionObserver, com.threerings.presents.data.InvocationCodes, SceneReceiver, SceneService.SceneMoveListener, SceneCodes
+
+
+
+
public class SceneDirector
extends com.threerings.presents.client.BasicDirector
implements SceneCodes, com.threerings.crowd.client.LocationDirector.FailureHandler, SceneReceiver, SceneService.SceneMoveListener
+ + +

+The scene director is the client's interface to all things scene related. It interfaces with the + scene repository to ensure that scene objects are available when the client enters a particular + scene. It handles moving from scene to scene (it coordinates with the LocationDirector + in order to do this). + +

Note that when the scene director is in use instead of the location director, scene ids + instead of place oids will be supplied to LocationObserver.locationMayChange(int) and LocationObserver.locationChangeFailed(int, java.lang.String). +

+ +

+

+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static interfaceSceneDirector.MoveHandler + +
+          Used to recover from a problem after a completed moveTo.
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.presents.client.InvocationReceiver
com.threerings.presents.client.InvocationReceiver.Registration
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from interface com.threerings.whirled.data.SceneCodes
SCENE_UPDATE, WHIRLED_GROUP
+  + + + + + + + +
Fields inherited from interface com.threerings.crowd.data.LocationCodes
ALREADY_THERE, MOVE_IN_PROGRESS, NO_SUCH_PLACE
+  + + + + + + + +
Fields inherited from interface com.threerings.presents.data.InvocationCodes
ACCESS_DENIED, E_ACCESS_DENIED, E_INTERNAL_ERROR, GLOBAL_GROUP, INTERNAL_ERROR
+  + + + + + + + + + + +
+Constructor Summary
SceneDirector(WhirledContext ctx, + com.threerings.crowd.client.LocationDirector locdir, + SceneRepository screp, + SceneFactory fact) + +
+          Creates a new scene director with the specified context.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidaddPendingForcedMove(Runnable move) + +
+           
+ voidcancelMoveRequest() + +
+           
+ voidclientDidLogoff(com.threerings.presents.client.Client client) + +
+           
+ voiddidLeaveScene() + +
+          Called to clean up our place and scene state information when we leave a scene.
+ voidforcedMove(int sceneId) + +
+          Used to communicate a required move notification to the client.
+ SceneModelgetPendingModel() + +
+          Returns the model loaded in preparation for a scene transition.
+ intgetPendingSceneId() + +
+          Returns the scene id set in preparation for a scene transition.
+ ScenegetScene() + +
+          Returns the display scene object associated with the scene we currently occupy or null if we + currently occupy no scene.
+ booleanmovePending() + +
+          Returns true if there is a pending move request.
+ voidmoveRequiresServerSwitch(String hostname, + int[] ports) + +
+          Indicates that the client must switch to the specified server and reissue its move + request in order to relocate to its desired scene.
+ voidmoveSucceeded(int placeId, + com.threerings.crowd.data.PlaceConfig config) + +
+          Indicates that a move succeeded.
+ voidmoveSucceededWithScene(int placeId, + com.threerings.crowd.data.PlaceConfig config, + SceneModel model) + +
+          Indicates that a move succeeded and that the client's cached scene information should be + updated with the supplied data.
+ voidmoveSucceededWithUpdates(int placeId, + com.threerings.crowd.data.PlaceConfig config, + SceneUpdate[] updates) + +
+          Indicates that a move succeeded and that the client's cached scene information should be + updated with the supplied data.
+ booleanmoveTo(int sceneId) + +
+          Requests that this client move the specified scene.
+ booleanprepareMoveTo(int sceneId, + ResultListener<com.threerings.crowd.data.PlaceConfig> rl) + +
+          Prepares to move to the requested scene.
+ voidrecoverFailedMove(int placeId) + +
+           
+ voidrequestFailed(String reason) + +
+           
+ voidsetMoveHandler(SceneDirector.MoveHandler handler) + +
+          Sets the moveHandler for use in recoverFailedMove(int).
+ voidsetSceneRepository(SceneRepository screp) + +
+          Set the scene repository.
+ voidupdateReceived(SceneUpdate update) + +
+          Called by SceneController instances to tell us about an update to the current scene.
+  + + + + + + + +
Methods inherited from class com.threerings.presents.client.BasicDirector
clientDidLogon, clientObjectDidChange, clientWillLogon, isAvailableInStandalone, setAvailableInStandalone
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+SceneDirector

+
+public SceneDirector(WhirledContext ctx,
+                     com.threerings.crowd.client.LocationDirector locdir,
+                     SceneRepository screp,
+                     SceneFactory fact)
+
+
Creates a new scene director with the specified context. +

+

+
Parameters:
ctx - the active client context.
locdir - the location director in use on the client, with which the scene director will + coordinate when changing location.
screp - the entity from which the scene director will load scene data from the local + client scene storage. This may be null when the SceneDirector is constructed, but it should + be supplied via setSceneRepository(com.threerings.whirled.client.persist.SceneRepository) prior to really using this director.
fact - the factory that knows which derivation of Scene to create for the + current system.
+
+ + + + + + + + +
+Method Detail
+ +

+setSceneRepository

+
+public void setSceneRepository(SceneRepository screp)
+
+
Set the scene repository. +

+

+
+
+
+
+
+
+
+ +

+getScene

+
+public Scene getScene()
+
+
Returns the display scene object associated with the scene we currently occupy or null if we + currently occupy no scene. +

+

+
+
+
+
+
+
+
+ +

+movePending

+
+public boolean movePending()
+
+
Returns true if there is a pending move request. +

+

+
+
+
+
+
+
+
+ +

+moveTo

+
+public boolean moveTo(int sceneId)
+
+
Requests that this client move the specified scene. A request will be made and when the + response is received, the location observers will be notified of success or failure. +

+

+
+
+
+ +
Returns:
true if the move to request was issued, false if it was rejected by a location + observer or because we have another request outstanding.
+
+
+
+ +

+prepareMoveTo

+
+public boolean prepareMoveTo(int sceneId,
+                             ResultListener<com.threerings.crowd.data.PlaceConfig> rl)
+
+
Prepares to move to the requested scene. The location observers are asked to ratify the move + and our pending scene mode is loaded from the scene repository. This can be called by + cooperating directors that need to coopt the moveTo process. +

+

+
+
+
+
+
+
+
+ +

+getPendingModel

+
+public SceneModel getPendingModel()
+
+
Returns the model loaded in preparation for a scene transition. This is made available only + for cooperating directors which may need to coopt the scene transition process. The pending + model is only valid immediately following a call to prepareMoveTo(int, com.samskivert.util.ResultListener). +

+

+
+
+
+
+
+
+
+ +

+getPendingSceneId

+
+public int getPendingSceneId()
+
+
Returns the scene id set in preparation for a scene transition. As with + getPendingModel(), this is for cooperating directors. +

+

+
+
+
+
+
+
+
+ +

+moveSucceeded

+
+public void moveSucceeded(int placeId,
+                          com.threerings.crowd.data.PlaceConfig config)
+
+
Description copied from interface: SceneService.SceneMoveListener
+
Indicates that a move succeeded. +

+

+
Specified by:
moveSucceeded in interface SceneService.SceneMoveListener
+
+
+
Parameters:
placeId - the place object id of the newly occupied scene.
config - metadata related to the newly occupied scene.
+
+
+
+ +

+moveSucceededWithUpdates

+
+public void moveSucceededWithUpdates(int placeId,
+                                     com.threerings.crowd.data.PlaceConfig config,
+                                     SceneUpdate[] updates)
+
+
Description copied from interface: SceneService.SceneMoveListener
+
Indicates that a move succeeded and that the client's cached scene information should be + updated with the supplied data. +

+

+
Specified by:
moveSucceededWithUpdates in interface SceneService.SceneMoveListener
+
+
+
Parameters:
placeId - the place object id of the newly occupied scene.
config - metadata related to the newly occupied scene.
updates - updates that must be applied to the client's copy of a scene model to + bring it up to date.
+
+
+
+ +

+moveSucceededWithScene

+
+public void moveSucceededWithScene(int placeId,
+                                   com.threerings.crowd.data.PlaceConfig config,
+                                   SceneModel model)
+
+
Description copied from interface: SceneService.SceneMoveListener
+
Indicates that a move succeeded and that the client's cached scene information should be + updated with the supplied data. +

+

+
Specified by:
moveSucceededWithScene in interface SceneService.SceneMoveListener
+
+
+
Parameters:
placeId - the place object id of the newly occupied scene.
config - metadata related to the newly occupied scene.
model - a fresh copy of the most recent scene data for the newly occupied scene.
+
+
+
+ +

+moveRequiresServerSwitch

+
+public void moveRequiresServerSwitch(String hostname,
+                                     int[] ports)
+
+
Description copied from interface: SceneService.SceneMoveListener
+
Indicates that the client must switch to the specified server and reissue its move + request in order to relocate to its desired scene. +

+

+
Specified by:
moveRequiresServerSwitch in interface SceneService.SceneMoveListener
+
+
+
+
+
+
+ +

+requestFailed

+
+public void requestFailed(String reason)
+
+
+
Specified by:
requestFailed in interface com.threerings.presents.client.InvocationService.InvocationListener
+
+
+
+
+
+
+ +

+updateReceived

+
+public void updateReceived(SceneUpdate update)
+
+
Called by SceneController instances to tell us about an update to the current scene. +

+

+
+
+
+
+
+
+
+ +

+didLeaveScene

+
+public void didLeaveScene()
+
+
Called to clean up our place and scene state information when we leave a scene. +

+

+
+
+
+
+
+
+
+ +

+setMoveHandler

+
+public void setMoveHandler(SceneDirector.MoveHandler handler)
+
+
Sets the moveHandler for use in recoverFailedMove(int). +

+

+
+
+
+
+
+
+
+ +

+forcedMove

+
+public void forcedMove(int sceneId)
+
+
Description copied from interface: SceneReceiver
+
Used to communicate a required move notification to the client. The server will have removed + the client from their existing scene and the client is then responsible for generating a + SceneService.moveTo(int, int, com.threerings.whirled.client.SceneService.SceneMoveListener) request to move to the new scene. +

+

+
Specified by:
forcedMove in interface SceneReceiver
+
+
+
+
+
+
+ +

+recoverFailedMove

+
+public void recoverFailedMove(int placeId)
+
+
+
Specified by:
recoverFailedMove in interface com.threerings.crowd.client.LocationDirector.FailureHandler
+
+
+
+
+
+
+ +

+clientDidLogoff

+
+public void clientDidLogoff(com.threerings.presents.client.Client client)
+
+
+
Specified by:
clientDidLogoff in interface com.threerings.presents.client.SessionObserver
Overrides:
clientDidLogoff in class com.threerings.presents.client.BasicDirector
+
+
+
+
+
+
+ +

+cancelMoveRequest

+
+public void cancelMoveRequest()
+
+
+
+
+
+
+
+
+
+ +

+addPendingForcedMove

+
+public void addPendingForcedMove(Runnable move)
+
+
+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/client/SceneMoveAdapter.html b/apidocs/com/threerings/whirled/client/SceneMoveAdapter.html new file mode 100644 index 00000000..d7ebcf1e --- /dev/null +++ b/apidocs/com/threerings/whirled/client/SceneMoveAdapter.html @@ -0,0 +1,382 @@ + + + + + + + +SceneMoveAdapter (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.client +
+Class SceneMoveAdapter

+
+java.lang.Object
+  extended by com.threerings.whirled.client.SceneMoveAdapter
+
+
+
All Implemented Interfaces:
com.threerings.presents.client.InvocationService.InvocationListener, SceneService.SceneMoveListener
+
+
+
+
public class SceneMoveAdapter
extends Object
implements SceneService.SceneMoveListener
+ + +

+A useful base class for implementing part of a SceneService.SceneMoveListener. +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
SceneMoveAdapter() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidmoveRequiresServerSwitch(String hostname, + int[] ports) + +
+          Indicates that the client must switch to the specified server and reissue its move + request in order to relocate to its desired scene.
+ voidmoveSucceeded(int placeId, + com.threerings.crowd.data.PlaceConfig config) + +
+          Indicates that a move succeeded.
+ voidmoveSucceededWithScene(int placeId, + com.threerings.crowd.data.PlaceConfig config, + SceneModel model) + +
+          Indicates that a move succeeded and that the client's cached scene information should be + updated with the supplied data.
+ voidmoveSucceededWithUpdates(int placeId, + com.threerings.crowd.data.PlaceConfig config, + SceneUpdate[] updates) + +
+          Indicates that a move succeeded and that the client's cached scene information should be + updated with the supplied data.
+ voidrequestFailed(String cause) + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+SceneMoveAdapter

+
+public SceneMoveAdapter()
+
+
+ + + + + + + + +
+Method Detail
+ +

+moveSucceeded

+
+public void moveSucceeded(int placeId,
+                          com.threerings.crowd.data.PlaceConfig config)
+
+
Description copied from interface: SceneService.SceneMoveListener
+
Indicates that a move succeeded. +

+

+
Specified by:
moveSucceeded in interface SceneService.SceneMoveListener
+
+
+
Parameters:
placeId - the place object id of the newly occupied scene.
config - metadata related to the newly occupied scene.
+
+
+
+ +

+moveSucceededWithUpdates

+
+public void moveSucceededWithUpdates(int placeId,
+                                     com.threerings.crowd.data.PlaceConfig config,
+                                     SceneUpdate[] updates)
+
+
Description copied from interface: SceneService.SceneMoveListener
+
Indicates that a move succeeded and that the client's cached scene information should be + updated with the supplied data. +

+

+
Specified by:
moveSucceededWithUpdates in interface SceneService.SceneMoveListener
+
+
+
Parameters:
placeId - the place object id of the newly occupied scene.
config - metadata related to the newly occupied scene.
updates - updates that must be applied to the client's copy of a scene model to + bring it up to date.
+
+
+
+ +

+moveSucceededWithScene

+
+public void moveSucceededWithScene(int placeId,
+                                   com.threerings.crowd.data.PlaceConfig config,
+                                   SceneModel model)
+
+
Description copied from interface: SceneService.SceneMoveListener
+
Indicates that a move succeeded and that the client's cached scene information should be + updated with the supplied data. +

+

+
Specified by:
moveSucceededWithScene in interface SceneService.SceneMoveListener
+
+
+
Parameters:
placeId - the place object id of the newly occupied scene.
config - metadata related to the newly occupied scene.
model - a fresh copy of the most recent scene data for the newly occupied scene.
+
+
+
+ +

+moveRequiresServerSwitch

+
+public void moveRequiresServerSwitch(String hostname,
+                                     int[] ports)
+
+
Description copied from interface: SceneService.SceneMoveListener
+
Indicates that the client must switch to the specified server and reissue its move + request in order to relocate to its desired scene. +

+

+
Specified by:
moveRequiresServerSwitch in interface SceneService.SceneMoveListener
+
+
+
+
+
+
+ +

+requestFailed

+
+public void requestFailed(String cause)
+
+
+
Specified by:
requestFailed in interface com.threerings.presents.client.InvocationService.InvocationListener
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/client/SceneReceiver.html b/apidocs/com/threerings/whirled/client/SceneReceiver.html new file mode 100644 index 00000000..e4b550b5 --- /dev/null +++ b/apidocs/com/threerings/whirled/client/SceneReceiver.html @@ -0,0 +1,244 @@ + + + + + + + +SceneReceiver (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.client +
+Interface SceneReceiver

+
+
All Superinterfaces:
com.threerings.presents.client.InvocationReceiver
+
+
+
All Known Implementing Classes:
SceneDirector
+
+
+
+
public interface SceneReceiver
extends com.threerings.presents.client.InvocationReceiver
+ + +

+Defines, for the scene services, a set of notifications delivered asynchronously by the server + to the client. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.presents.client.InvocationReceiver
com.threerings.presents.client.InvocationReceiver.Registration
+  + + + + + + + + + + + + +
+Method Summary
+ voidforcedMove(int sceneId) + +
+          Used to communicate a required move notification to the client.
+  +

+ + + + + + + + +
+Method Detail
+ +

+forcedMove

+
+void forcedMove(int sceneId)
+
+
Used to communicate a required move notification to the client. The server will have removed + the client from their existing scene and the client is then responsible for generating a + SceneService.moveTo(int, int, com.threerings.whirled.client.SceneService.SceneMoveListener) request to move to the new scene. +

+

+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/client/SceneService.SceneMoveListener.html b/apidocs/com/threerings/whirled/client/SceneService.SceneMoveListener.html new file mode 100644 index 00000000..6d091c36 --- /dev/null +++ b/apidocs/com/threerings/whirled/client/SceneService.SceneMoveListener.html @@ -0,0 +1,328 @@ + + + + + + + +SceneService.SceneMoveListener (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.client +
+Interface SceneService.SceneMoveListener

+
+
All Superinterfaces:
com.threerings.presents.client.InvocationService.InvocationListener
+
+
+
All Known Subinterfaces:
SpotService.SpotSceneMoveListener
+
+
+
All Known Implementing Classes:
SceneDirector, SceneMarshaller.SceneMoveMarshaller, SceneMoveAdapter, SpotMarshaller.SpotSceneMoveMarshaller
+
+
+
Enclosing interface:
SceneService
+
+
+
+
public static interface SceneService.SceneMoveListener
extends com.threerings.presents.client.InvocationService.InvocationListener
+ + +

+Used to communicate the response to a SceneService.moveTo(int, int, com.threerings.whirled.client.SceneService.SceneMoveListener) request. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidmoveRequiresServerSwitch(String hostname, + int[] ports) + +
+          Indicates that the client must switch to the specified server and reissue its move + request in order to relocate to its desired scene.
+ voidmoveSucceeded(int placeId, + com.threerings.crowd.data.PlaceConfig config) + +
+          Indicates that a move succeeded.
+ voidmoveSucceededWithScene(int placeId, + com.threerings.crowd.data.PlaceConfig config, + SceneModel model) + +
+          Indicates that a move succeeded and that the client's cached scene information should be + updated with the supplied data.
+ voidmoveSucceededWithUpdates(int placeId, + com.threerings.crowd.data.PlaceConfig config, + SceneUpdate[] updates) + +
+          Indicates that a move succeeded and that the client's cached scene information should be + updated with the supplied data.
+  + + + + + + + +
Methods inherited from interface com.threerings.presents.client.InvocationService.InvocationListener
requestFailed
+  +

+ + + + + + + + +
+Method Detail
+ +

+moveSucceeded

+
+void moveSucceeded(int placeId,
+                   com.threerings.crowd.data.PlaceConfig config)
+
+
Indicates that a move succeeded. +

+

+
+
+
+
Parameters:
placeId - the place object id of the newly occupied scene.
config - metadata related to the newly occupied scene.
+
+
+
+ +

+moveSucceededWithUpdates

+
+void moveSucceededWithUpdates(int placeId,
+                              com.threerings.crowd.data.PlaceConfig config,
+                              SceneUpdate[] updates)
+
+
Indicates that a move succeeded and that the client's cached scene information should be + updated with the supplied data. +

+

+
+
+
+
Parameters:
placeId - the place object id of the newly occupied scene.
config - metadata related to the newly occupied scene.
updates - updates that must be applied to the client's copy of a scene model to + bring it up to date.
+
+
+
+ +

+moveSucceededWithScene

+
+void moveSucceededWithScene(int placeId,
+                            com.threerings.crowd.data.PlaceConfig config,
+                            SceneModel model)
+
+
Indicates that a move succeeded and that the client's cached scene information should be + updated with the supplied data. +

+

+
+
+
+
Parameters:
placeId - the place object id of the newly occupied scene.
config - metadata related to the newly occupied scene.
model - a fresh copy of the most recent scene data for the newly occupied scene.
+
+
+
+ +

+moveRequiresServerSwitch

+
+void moveRequiresServerSwitch(String hostname,
+                              int[] ports)
+
+
Indicates that the client must switch to the specified server and reissue its move + request in order to relocate to its desired scene. +

+

+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/client/SceneService.html b/apidocs/com/threerings/whirled/client/SceneService.html new file mode 100644 index 00000000..b0b1bfa7 --- /dev/null +++ b/apidocs/com/threerings/whirled/client/SceneService.html @@ -0,0 +1,254 @@ + + + + + + + +SceneService (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.client +
+Interface SceneService

+
+
All Superinterfaces:
com.threerings.presents.client.InvocationService
+
+
+
All Known Implementing Classes:
SceneMarshaller
+
+
+
+
public interface SceneService
extends com.threerings.presents.client.InvocationService
+ + +

+The scene service class provides the client interface to the scene related invocation services + (e.g. moving from scene to scene). +

+ +

+

+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static interfaceSceneService.SceneMoveListener + +
+          Used to communicate the response to a moveTo(int, int, com.threerings.whirled.client.SceneService.SceneMoveListener) request.
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.presents.client.InvocationService
com.threerings.presents.client.InvocationService.ConfirmListener, com.threerings.presents.client.InvocationService.InvocationListener, com.threerings.presents.client.InvocationService.ResultListener
+  + + + + + + + + + + + + +
+Method Summary
+ voidmoveTo(int sceneId, + int version, + SceneService.SceneMoveListener listener) + +
+          Requests that that this client's body be moved to the specified scene.
+  +

+ + + + + + + + +
+Method Detail
+ +

+moveTo

+
+void moveTo(int sceneId,
+            int version,
+            SceneService.SceneMoveListener listener)
+
+
Requests that that this client's body be moved to the specified scene. +

+

+
+
+
+
Parameters:
sceneId - the scene id to which we want to move.
version - the version number of the scene object that we have in our local repository.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/client/class-use/SceneController.html b/apidocs/com/threerings/whirled/client/class-use/SceneController.html new file mode 100644 index 00000000..6810ffdf --- /dev/null +++ b/apidocs/com/threerings/whirled/client/class-use/SceneController.html @@ -0,0 +1,211 @@ + + + + + + + +Uses of Class com.threerings.whirled.client.SceneController (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.client.SceneController

+
+ + + + + + + + + + + + + +
+Packages that use SceneController
com.threerings.stage.client  
com.threerings.whirled.spot.client  
+  +

+ + + + + +
+Uses of SceneController in com.threerings.stage.client
+  +

+ + + + + + + + + +
Subclasses of SceneController in com.threerings.stage.client
+ classStageSceneController + +
+          Extends the SpotSceneController with functionality specific to + displaying Stage scenes.
+  +

+ + + + + +
+Uses of SceneController in com.threerings.whirled.spot.client
+  +

+ + + + + + + + + +
Subclasses of SceneController in com.threerings.whirled.spot.client
+ classSpotSceneController + +
+          The base spot scene controller class.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/client/class-use/SceneDecoder.html b/apidocs/com/threerings/whirled/client/class-use/SceneDecoder.html new file mode 100644 index 00000000..5b2cc9f3 --- /dev/null +++ b/apidocs/com/threerings/whirled/client/class-use/SceneDecoder.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.whirled.client.SceneDecoder (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.client.SceneDecoder

+
+No usage of com.threerings.whirled.client.SceneDecoder +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/client/class-use/SceneDirector.MoveHandler.html b/apidocs/com/threerings/whirled/client/class-use/SceneDirector.MoveHandler.html new file mode 100644 index 00000000..bd91c7db --- /dev/null +++ b/apidocs/com/threerings/whirled/client/class-use/SceneDirector.MoveHandler.html @@ -0,0 +1,210 @@ + + + + + + + +Uses of Interface com.threerings.whirled.client.SceneDirector.MoveHandler (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.whirled.client.SceneDirector.MoveHandler

+
+ + + + + + + + + + + + + +
+Packages that use SceneDirector.MoveHandler
com.threerings.whirled.client  
com.threerings.whirled.zone.client  
+  +

+ + + + + +
+Uses of SceneDirector.MoveHandler in com.threerings.whirled.client
+  +

+ + + + + + + + + +
Methods in com.threerings.whirled.client with parameters of type SceneDirector.MoveHandler
+ voidSceneDirector.setMoveHandler(SceneDirector.MoveHandler handler) + +
+          Sets the moveHandler for use in SceneDirector.recoverFailedMove(int).
+  +

+ + + + + +
+Uses of SceneDirector.MoveHandler in com.threerings.whirled.zone.client
+  +

+ + + + + + + + + +
Classes in com.threerings.whirled.zone.client that implement SceneDirector.MoveHandler
+ classZoneDirector + +
+          The zone director augments the scene services with the notion of zones.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/client/class-use/SceneDirector.html b/apidocs/com/threerings/whirled/client/class-use/SceneDirector.html new file mode 100644 index 00000000..0af8d90b --- /dev/null +++ b/apidocs/com/threerings/whirled/client/class-use/SceneDirector.html @@ -0,0 +1,240 @@ + + + + + + + +Uses of Class com.threerings.whirled.client.SceneDirector (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.client.SceneDirector

+
+ + + + + + + + + + + + + + + + + +
+Packages that use SceneDirector
com.threerings.whirled.spot.client  
com.threerings.whirled.util  
com.threerings.whirled.zone.client  
+  +

+ + + + + +
+Uses of SceneDirector in com.threerings.whirled.spot.client
+  +

+ + + + + + + + +
Constructors in com.threerings.whirled.spot.client with parameters of type SceneDirector
SpotSceneDirector(WhirledContext ctx, + com.threerings.crowd.client.LocationDirector locdir, + SceneDirector scdir) + +
+          Creates a new spot scene director with the specified context and which will cooperate with + the supplied scene director.
+  +

+ + + + + +
+Uses of SceneDirector in com.threerings.whirled.util
+  +

+ + + + + + + + + +
Methods in com.threerings.whirled.util that return SceneDirector
+ SceneDirectorWhirledContext.getSceneDirector() + +
+          Returns a reference to the scene director.
+  +

+ + + + + +
+Uses of SceneDirector in com.threerings.whirled.zone.client
+  +

+ + + + + + + + +
Constructors in com.threerings.whirled.zone.client with parameters of type SceneDirector
ZoneDirector(WhirledContext ctx, + SceneDirector scdir) + +
+          Constructs a zone director with the supplied context, and delegate scene director (which the + zone director will coordinate with when moving from scene to scene).
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/client/class-use/SceneMoveAdapter.html b/apidocs/com/threerings/whirled/client/class-use/SceneMoveAdapter.html new file mode 100644 index 00000000..8091539f --- /dev/null +++ b/apidocs/com/threerings/whirled/client/class-use/SceneMoveAdapter.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.whirled.client.SceneMoveAdapter (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.client.SceneMoveAdapter

+
+No usage of com.threerings.whirled.client.SceneMoveAdapter +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/client/class-use/SceneReceiver.html b/apidocs/com/threerings/whirled/client/class-use/SceneReceiver.html new file mode 100644 index 00000000..b944b4c0 --- /dev/null +++ b/apidocs/com/threerings/whirled/client/class-use/SceneReceiver.html @@ -0,0 +1,196 @@ + + + + + + + +Uses of Interface com.threerings.whirled.client.SceneReceiver (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.whirled.client.SceneReceiver

+
+ + + + + + + + + +
+Packages that use SceneReceiver
com.threerings.whirled.client  
+  +

+ + + + + +
+Uses of SceneReceiver in com.threerings.whirled.client
+  +

+ + + + + + + + + +
Classes in com.threerings.whirled.client that implement SceneReceiver
+ classSceneDirector + +
+          The scene director is the client's interface to all things scene related.
+  +

+ + + + + + + + +
Constructors in com.threerings.whirled.client with parameters of type SceneReceiver
SceneDecoder(SceneReceiver receiver) + +
+          Creates a decoder that may be registered to dispatch invocation + service notifications to the specified receiver.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/client/class-use/SceneService.SceneMoveListener.html b/apidocs/com/threerings/whirled/client/class-use/SceneService.SceneMoveListener.html new file mode 100644 index 00000000..613aa363 --- /dev/null +++ b/apidocs/com/threerings/whirled/client/class-use/SceneService.SceneMoveListener.html @@ -0,0 +1,404 @@ + + + + + + + +Uses of Interface com.threerings.whirled.client.SceneService.SceneMoveListener (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.whirled.client.SceneService.SceneMoveListener

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Packages that use SceneService.SceneMoveListener
com.threerings.whirled.client  
com.threerings.whirled.data  
com.threerings.whirled.server  
com.threerings.whirled.spot.client  
com.threerings.whirled.spot.data  
com.threerings.whirled.spot.server  
+  +

+ + + + + +
+Uses of SceneService.SceneMoveListener in com.threerings.whirled.client
+  +

+ + + + + + + + + + + + + +
Classes in com.threerings.whirled.client that implement SceneService.SceneMoveListener
+ classSceneDirector + +
+          The scene director is the client's interface to all things scene related.
+ classSceneMoveAdapter + +
+          A useful base class for implementing part of a SceneService.SceneMoveListener.
+  +

+ + + + + + + + + +
Methods in com.threerings.whirled.client with parameters of type SceneService.SceneMoveListener
+ voidSceneService.moveTo(int sceneId, + int version, + SceneService.SceneMoveListener listener) + +
+          Requests that that this client's body be moved to the specified scene.
+  +

+ + + + + +
+Uses of SceneService.SceneMoveListener in com.threerings.whirled.data
+  +

+ + + + + + + + + +
Classes in com.threerings.whirled.data that implement SceneService.SceneMoveListener
+static classSceneMarshaller.SceneMoveMarshaller + +
+          Marshalls results to implementations of SceneService.SceneMoveListener.
+  +

+ + + + + + + + + +
Methods in com.threerings.whirled.data with parameters of type SceneService.SceneMoveListener
+ voidSceneMarshaller.moveTo(int arg1, + int arg2, + SceneService.SceneMoveListener arg3) + +
+           
+  +

+ + + + + +
+Uses of SceneService.SceneMoveListener in com.threerings.whirled.server
+  +

+ + + + + + + + + + + + + +
Methods in com.threerings.whirled.server with parameters of type SceneService.SceneMoveListener
+ voidSceneRegistry.moveTo(com.threerings.presents.data.ClientObject caller, + int sceneId, + int sceneVer, + SceneService.SceneMoveListener listener) + +
+           
+ voidSceneProvider.moveTo(com.threerings.presents.data.ClientObject caller, + int arg1, + int arg2, + SceneService.SceneMoveListener arg3) + +
+          Handles a SceneService.moveTo(int, int, com.threerings.whirled.client.SceneService.SceneMoveListener) request.
+  +

+ + + + + + + + +
Constructors in com.threerings.whirled.server with parameters of type SceneService.SceneMoveListener
SceneMoveHandler(com.threerings.crowd.server.LocationManager locman, + com.threerings.crowd.data.BodyObject body, + int sceneVer, + SceneService.SceneMoveListener listener) + +
+           
+  +

+ + + + + +
+Uses of SceneService.SceneMoveListener in com.threerings.whirled.spot.client
+  +

+ + + + + + + + + +
Subinterfaces of SceneService.SceneMoveListener in com.threerings.whirled.spot.client
+static interfaceSpotService.SpotSceneMoveListener + +
+          Used to communicate the response to a SceneService.moveTo(int, int, com.threerings.whirled.client.SceneService.SceneMoveListener) request.
+  +

+ + + + + +
+Uses of SceneService.SceneMoveListener in com.threerings.whirled.spot.data
+  +

+ + + + + + + + + +
Classes in com.threerings.whirled.spot.data that implement SceneService.SceneMoveListener
+static classSpotMarshaller.SpotSceneMoveMarshaller + +
+          Marshalls results to implementations of SpotService.SpotSceneMoveListener.
+  +

+ + + + + +
+Uses of SceneService.SceneMoveListener in com.threerings.whirled.spot.server
+  +

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

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/client/class-use/SceneService.html b/apidocs/com/threerings/whirled/client/class-use/SceneService.html new file mode 100644 index 00000000..fa10af55 --- /dev/null +++ b/apidocs/com/threerings/whirled/client/class-use/SceneService.html @@ -0,0 +1,183 @@ + + + + + + + +Uses of Interface com.threerings.whirled.client.SceneService (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.whirled.client.SceneService

+
+ + + + + + + + + +
+Packages that use SceneService
com.threerings.whirled.data  
+  +

+ + + + + +
+Uses of SceneService in com.threerings.whirled.data
+  +

+ + + + + + + + + +
Classes in com.threerings.whirled.data that implement SceneService
+ classSceneMarshaller + +
+          Provides the implementation of the SceneService interface + that marshalls the arguments and delivers the request to the provider + on the server.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/client/package-frame.html b/apidocs/com/threerings/whirled/client/package-frame.html new file mode 100644 index 00000000..b02a53be --- /dev/null +++ b/apidocs/com/threerings/whirled/client/package-frame.html @@ -0,0 +1,56 @@ + + + + + + + +com.threerings.whirled.client (vilya 1.3 API) + + + + + + + + + + + +com.threerings.whirled.client + + + + +
+Interfaces  + +
+SceneDirector.MoveHandler +
+SceneReceiver +
+SceneService +
+SceneService.SceneMoveListener
+ + + + + + +
+Classes  + +
+SceneController +
+SceneDecoder +
+SceneDirector +
+SceneMoveAdapter
+ + + + diff --git a/apidocs/com/threerings/whirled/client/package-summary.html b/apidocs/com/threerings/whirled/client/package-summary.html new file mode 100644 index 00000000..d41fe60b --- /dev/null +++ b/apidocs/com/threerings/whirled/client/package-summary.html @@ -0,0 +1,198 @@ + + + + + + + +com.threerings.whirled.client (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.whirled.client +

+ + + + + + + + + + + + + + + + + + + + + +
+Interface Summary
SceneDirector.MoveHandlerUsed to recover from a problem after a completed moveTo.
SceneReceiverDefines, for the scene services, a set of notifications delivered asynchronously by the server + to the client.
SceneServiceThe scene service class provides the client interface to the scene related invocation services + (e.g.
SceneService.SceneMoveListenerUsed to communicate the response to a SceneService.moveTo(int, int, com.threerings.whirled.client.SceneService.SceneMoveListener) request.
+  + +

+ + + + + + + + + + + + + + + + + + + + + +
+Class Summary
SceneControllerThe base scene controller class.
SceneDecoderDispatches calls to a SceneReceiver instance.
SceneDirectorThe scene director is the client's interface to all things scene related.
SceneMoveAdapterA useful base class for implementing part of a SceneService.SceneMoveListener.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/client/package-tree.html b/apidocs/com/threerings/whirled/client/package-tree.html new file mode 100644 index 00000000..59c07373 --- /dev/null +++ b/apidocs/com/threerings/whirled/client/package-tree.html @@ -0,0 +1,177 @@ + + + + + + + +com.threerings.whirled.client Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.whirled.client +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/client/package-use.html b/apidocs/com/threerings/whirled/client/package-use.html new file mode 100644 index 00000000..e2cd068f --- /dev/null +++ b/apidocs/com/threerings/whirled/client/package-use.html @@ -0,0 +1,361 @@ + + + + + + + +Uses of Package com.threerings.whirled.client (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.whirled.client

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Packages that use com.threerings.whirled.client
com.threerings.stage.client  
com.threerings.whirled.client  
com.threerings.whirled.data  
com.threerings.whirled.server  
com.threerings.whirled.spot.client  
com.threerings.whirled.spot.data  
com.threerings.whirled.spot.server  
com.threerings.whirled.util  
com.threerings.whirled.zone.client  
+  +

+ + + + + + + + +
+Classes in com.threerings.whirled.client used by com.threerings.stage.client
SceneController + +
+          The base scene controller class.
+  +

+ + + + + + + + + + + + + + +
+Classes in com.threerings.whirled.client used by com.threerings.whirled.client
SceneDirector.MoveHandler + +
+          Used to recover from a problem after a completed moveTo.
SceneReceiver + +
+          Defines, for the scene services, a set of notifications delivered asynchronously by the server + to the client.
SceneService.SceneMoveListener + +
+          Used to communicate the response to a SceneService.moveTo(int, int, com.threerings.whirled.client.SceneService.SceneMoveListener) request.
+  +

+ + + + + + + + + + + +
+Classes in com.threerings.whirled.client used by com.threerings.whirled.data
SceneService + +
+          The scene service class provides the client interface to the scene related invocation services + (e.g.
SceneService.SceneMoveListener + +
+          Used to communicate the response to a SceneService.moveTo(int, int, com.threerings.whirled.client.SceneService.SceneMoveListener) request.
+  +

+ + + + + + + + +
+Classes in com.threerings.whirled.client used by com.threerings.whirled.server
SceneService.SceneMoveListener + +
+          Used to communicate the response to a SceneService.moveTo(int, int, com.threerings.whirled.client.SceneService.SceneMoveListener) request.
+  +

+ + + + + + + + + + + + + + +
+Classes in com.threerings.whirled.client used by com.threerings.whirled.spot.client
SceneController + +
+          The base scene controller class.
SceneDirector + +
+          The scene director is the client's interface to all things scene related.
SceneService.SceneMoveListener + +
+          Used to communicate the response to a SceneService.moveTo(int, int, com.threerings.whirled.client.SceneService.SceneMoveListener) request.
+  +

+ + + + + + + + +
+Classes in com.threerings.whirled.client used by com.threerings.whirled.spot.data
SceneService.SceneMoveListener + +
+          Used to communicate the response to a SceneService.moveTo(int, int, com.threerings.whirled.client.SceneService.SceneMoveListener) request.
+  +

+ + + + + + + + +
+Classes in com.threerings.whirled.client used by com.threerings.whirled.spot.server
SceneService.SceneMoveListener + +
+          Used to communicate the response to a SceneService.moveTo(int, int, com.threerings.whirled.client.SceneService.SceneMoveListener) request.
+  +

+ + + + + + + + +
+Classes in com.threerings.whirled.client used by com.threerings.whirled.util
SceneDirector + +
+          The scene director is the client's interface to all things scene related.
+  +

+ + + + + + + + + + + +
+Classes in com.threerings.whirled.client used by com.threerings.whirled.zone.client
SceneDirector + +
+          The scene director is the client's interface to all things scene related.
SceneDirector.MoveHandler + +
+          Used to recover from a problem after a completed moveTo.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/client/persist/SceneRepository.html b/apidocs/com/threerings/whirled/client/persist/SceneRepository.html new file mode 100644 index 00000000..03c30e40 --- /dev/null +++ b/apidocs/com/threerings/whirled/client/persist/SceneRepository.html @@ -0,0 +1,273 @@ + + + + + + + +SceneRepository (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.client.persist +
+Interface SceneRepository

+
+
+
public interface SceneRepository
+ + +

+The scene repository provides access to a persistent repository of + scene information. +

+ +

+

+
See Also:
SceneModel
+
+ +

+ + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voiddeleteSceneModel(int sceneId) + +
+          Deletes the specified scene model from the repository.
+ SceneModelloadSceneModel(int sceneId) + +
+          Fetches the model for the scene with the specified id.
+ voidstoreSceneModel(SceneModel model) + +
+          Updates or inserts this scene model as appropriate.
+  +

+ + + + + + + + +
+Method Detail
+ +

+loadSceneModel

+
+SceneModel loadSceneModel(int sceneId)
+                          throws IOException,
+                                 NoSuchSceneException
+
+
Fetches the model for the scene with the specified id. +

+

+ +
Throws: +
IOException - thrown if an error occurs attempting to load + the scene data. +
NoSuchSceneException - thrown if no scene exists with the + specified scene id.
+
+
+
+ +

+storeSceneModel

+
+void storeSceneModel(SceneModel model)
+                     throws IOException
+
+
Updates or inserts this scene model as appropriate. +

+

+ +
Throws: +
IOException - thrown if an error occurs attempting to + access the repository.
+
+
+
+ +

+deleteSceneModel

+
+void deleteSceneModel(int sceneId)
+                      throws IOException
+
+
Deletes the specified scene model from the repository. +

+

+ +
Throws: +
IOException - thrown if an error occurs attempting to + access the repository.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/client/persist/class-use/SceneRepository.html b/apidocs/com/threerings/whirled/client/persist/class-use/SceneRepository.html new file mode 100644 index 00000000..8555d288 --- /dev/null +++ b/apidocs/com/threerings/whirled/client/persist/class-use/SceneRepository.html @@ -0,0 +1,198 @@ + + + + + + + +Uses of Interface com.threerings.whirled.client.persist.SceneRepository (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.whirled.client.persist.SceneRepository

+
+ + + + + + + + + +
+Packages that use SceneRepository
com.threerings.whirled.client  
+  +

+ + + + + +
+Uses of SceneRepository in com.threerings.whirled.client
+  +

+ + + + + + + + + +
Methods in com.threerings.whirled.client with parameters of type SceneRepository
+ voidSceneDirector.setSceneRepository(SceneRepository screp) + +
+          Set the scene repository.
+  +

+ + + + + + + + +
Constructors in com.threerings.whirled.client with parameters of type SceneRepository
SceneDirector(WhirledContext ctx, + com.threerings.crowd.client.LocationDirector locdir, + SceneRepository screp, + SceneFactory fact) + +
+          Creates a new scene director with the specified context.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/client/persist/package-frame.html b/apidocs/com/threerings/whirled/client/persist/package-frame.html new file mode 100644 index 00000000..c7150d34 --- /dev/null +++ b/apidocs/com/threerings/whirled/client/persist/package-frame.html @@ -0,0 +1,33 @@ + + + + + + + +com.threerings.whirled.client.persist (vilya 1.3 API) + + + + + + + + + + + +com.threerings.whirled.client.persist + + + + +
+Interfaces  + +
+SceneRepository
+ + + + diff --git a/apidocs/com/threerings/whirled/client/persist/package-summary.html b/apidocs/com/threerings/whirled/client/persist/package-summary.html new file mode 100644 index 00000000..3a453f6e --- /dev/null +++ b/apidocs/com/threerings/whirled/client/persist/package-summary.html @@ -0,0 +1,159 @@ + + + + + + + +com.threerings.whirled.client.persist (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.whirled.client.persist +

+ + + + + + + + + +
+Interface Summary
SceneRepositoryThe scene repository provides access to a persistent repository of + scene information.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/client/persist/package-tree.html b/apidocs/com/threerings/whirled/client/persist/package-tree.html new file mode 100644 index 00000000..ee0ed0b0 --- /dev/null +++ b/apidocs/com/threerings/whirled/client/persist/package-tree.html @@ -0,0 +1,152 @@ + + + + + + + +com.threerings.whirled.client.persist Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.whirled.client.persist +

+
+
+
Package Hierarchies:
All Packages
+
+

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/client/persist/package-use.html b/apidocs/com/threerings/whirled/client/persist/package-use.html new file mode 100644 index 00000000..60d31001 --- /dev/null +++ b/apidocs/com/threerings/whirled/client/persist/package-use.html @@ -0,0 +1,172 @@ + + + + + + + +Uses of Package com.threerings.whirled.client.persist (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.whirled.client.persist

+
+ + + + + + + + + +
+Packages that use com.threerings.whirled.client.persist
com.threerings.whirled.client  
+  +

+ + + + + + + + +
+Classes in com.threerings.whirled.client.persist used by com.threerings.whirled.client
SceneRepository + +
+          The scene repository provides access to a persistent repository of + scene information.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/data/AuxModel.html b/apidocs/com/threerings/whirled/data/AuxModel.html new file mode 100644 index 00000000..b4d5bfd3 --- /dev/null +++ b/apidocs/com/threerings/whirled/data/AuxModel.html @@ -0,0 +1,244 @@ + + + + + + + +AuxModel (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.data +
+Interface AuxModel

+
+
All Superinterfaces:
Cloneable, com.threerings.io.Streamable
+
+
+
All Known Implementing Classes:
SpotSceneModel, StageMisoSceneModel
+
+
+
+
public interface AuxModel
extends com.threerings.io.Streamable, Cloneable
+ + +

+An interface that must be implemented by auxiliary scene models. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + + +
+Method Summary
+ AuxModelclone() + +
+          Creates a clone of this auxiliary model.
+  +

+ + + + + + + + +
+Method Detail
+ +

+clone

+
+AuxModel clone()
+               throws CloneNotSupportedException
+
+
Creates a clone of this auxiliary model. +

+

+
+
+
+ +
Throws: +
CloneNotSupportedException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/data/DefaultSceneConfig.html b/apidocs/com/threerings/whirled/data/DefaultSceneConfig.html new file mode 100644 index 00000000..2c7b19ee --- /dev/null +++ b/apidocs/com/threerings/whirled/data/DefaultSceneConfig.html @@ -0,0 +1,309 @@ + + + + + + + +DefaultSceneConfig (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.data +
+Class DefaultSceneConfig

+
+java.lang.Object
+  extended by com.threerings.io.SimpleStreamableObject
+      extended by com.threerings.crowd.data.PlaceConfig
+          extended by com.threerings.whirled.data.DefaultSceneConfig
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable
+
+
+
+
public class DefaultSceneConfig
extends com.threerings.crowd.data.PlaceConfig
+ + +

+The default scene config simply causes the default scene manager and + controller to be created. A user of the Whirled services would most + likely extend the default scene config. + +

Note that this place config won't even work on the client side + because it instantiates a SceneController which is an abstract + class. It is used only for testing the server side and as a placeholder + in case standard scene configuration information is one day needed. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + +
+Constructor Summary
DefaultSceneConfig() + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ StringgetManagerClassName() + +
+           
+  + + + + + + + +
Methods inherited from class com.threerings.crowd.data.PlaceConfig
createController, getControllerClass
+  + + + + + + + +
Methods inherited from class com.threerings.io.SimpleStreamableObject
toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+DefaultSceneConfig

+
+public DefaultSceneConfig()
+
+
+ + + + + + + + +
+Method Detail
+ +

+getManagerClassName

+
+public String getManagerClassName()
+
+
+
Specified by:
getManagerClassName in class com.threerings.crowd.data.PlaceConfig
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/data/Scene.html b/apidocs/com/threerings/whirled/data/Scene.html new file mode 100644 index 00000000..b52166d5 --- /dev/null +++ b/apidocs/com/threerings/whirled/data/Scene.html @@ -0,0 +1,395 @@ + + + + + + + +Scene (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.data +
+Interface Scene

+
+
All Known Implementing Classes:
SceneImpl, StageScene
+
+
+
+
public interface Scene
+ + +

+This interface makes available basic scene information. At this basic + level, not much information is available, but extensions to this + interface begin to create a more comprehensive picture of a scene in a + system built from the Whirled services. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ intgetId() + +
+          Returns the unique identifier for this scene.
+ StringgetName() + +
+          Returns the human readable name of this scene.
+ com.threerings.crowd.data.PlaceConfiggetPlaceConfig() + +
+          Returns the place config that can be used to determine which place + controller instance should be used to display this scene as well as + to obtain runtime configuration information.
+ SceneModelgetSceneModel() + +
+          Returns the scene model from which this scene was created.
+ intgetVersion() + +
+          Returns the version number of this scene.
+ voidsetId(int sceneId) + +
+          Sets this scene's unique identifier.
+ voidsetName(String name) + +
+          Sets the human readable name of this scene.
+ voidsetVersion(int version) + +
+          Sets this scene's version number.
+ voidupdateReceived(SceneUpdate update) + +
+          Called to inform the scene that an update has been received while + the scene was resolved and active.
+  +

+ + + + + + + + +
+Method Detail
+ +

+getId

+
+int getId()
+
+
Returns the unique identifier for this scene. +

+

+
+
+
+
+ +

+getName

+
+String getName()
+
+
Returns the human readable name of this scene. +

+

+
+
+
+
+ +

+getVersion

+
+int getVersion()
+
+
Returns the version number of this scene. +

+

+
+
+
+
+ +

+getPlaceConfig

+
+com.threerings.crowd.data.PlaceConfig getPlaceConfig()
+
+
Returns the place config that can be used to determine which place + controller instance should be used to display this scene as well as + to obtain runtime configuration information. +

+

+
+
+
+
+ +

+setId

+
+void setId(int sceneId)
+
+
Sets this scene's unique identifier. +

+

+
+
+
+
+ +

+setName

+
+void setName(String name)
+
+
Sets the human readable name of this scene. +

+

+
+
+
+
+ +

+setVersion

+
+void setVersion(int version)
+
+
Sets this scene's version number. +

+

+
+
+
+
+ +

+updateReceived

+
+void updateReceived(SceneUpdate update)
+
+
Called to inform the scene that an update has been received while + the scene was resolved and active. The update should be applied to + the underlying scene model and any derivative data should be + appropriately updated. +

+

+
+
+
+
+ +

+getSceneModel

+
+SceneModel getSceneModel()
+
+
Returns the scene model from which this scene was created. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/data/SceneCodes.html b/apidocs/com/threerings/whirled/data/SceneCodes.html new file mode 100644 index 00000000..51527e75 --- /dev/null +++ b/apidocs/com/threerings/whirled/data/SceneCodes.html @@ -0,0 +1,258 @@ + + + + + + + +SceneCodes (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.data +
+Interface SceneCodes

+
+
All Superinterfaces:
com.threerings.presents.data.InvocationCodes, com.threerings.crowd.data.LocationCodes
+
+
+
All Known Subinterfaces:
SpotCodes, ZoneCodes
+
+
+
All Known Implementing Classes:
SceneDirector, SceneRegistry, SpotSceneDirector, SpotSceneManager, SpotSceneRegistry, StageSceneManager
+
+
+
+
public interface SceneCodes
extends com.threerings.crowd.data.LocationCodes
+ + +

+Contains codes used by the scene invocation services. +

+ +

+

+ +

+ + + + + + + + + + + + + + + +
+Field Summary
+static StringSCENE_UPDATE + +
+          The message identifier for scene update messages.
+static StringWHIRLED_GROUP + +
+          Defines our invocation services group.
+  + + + + + + + +
Fields inherited from interface com.threerings.crowd.data.LocationCodes
ALREADY_THERE, MOVE_IN_PROGRESS, NO_SUCH_PLACE
+  + + + + + + + +
Fields inherited from interface com.threerings.presents.data.InvocationCodes
ACCESS_DENIED, E_ACCESS_DENIED, E_INTERNAL_ERROR, GLOBAL_GROUP, INTERNAL_ERROR
+  +

+ + + + + + + + +
+Field Detail
+ +

+WHIRLED_GROUP

+
+static final String WHIRLED_GROUP
+
+
Defines our invocation services group. +

+

+
See Also:
Constant Field Values
+
+
+ +

+SCENE_UPDATE

+
+static final String SCENE_UPDATE
+
+
The message identifier for scene update messages. +

+

+
See Also:
Constant Field Values
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/data/SceneImpl.html b/apidocs/com/threerings/whirled/data/SceneImpl.html new file mode 100644 index 00000000..75732178 --- /dev/null +++ b/apidocs/com/threerings/whirled/data/SceneImpl.html @@ -0,0 +1,522 @@ + + + + + + + +SceneImpl (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.data +
+Class SceneImpl

+
+java.lang.Object
+  extended by com.threerings.whirled.data.SceneImpl
+
+
+
All Implemented Interfaces:
Scene
+
+
+
Direct Known Subclasses:
StageScene
+
+
+
+
public class SceneImpl
extends Object
implements Scene
+ + +

+An implementation of the Scene interface. +

+ +

+

+ +

+ + + + + + + + + + + + + + +
+Constructor Summary
SceneImpl() + +
+          Instantiates a blank scene implementation.
SceneImpl(SceneModel model, + com.threerings.crowd.data.PlaceConfig config) + +
+          Creates an instance that will obtain data from the supplied scene + model and place config.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ intgetId() + +
+          Returns the unique identifier for this scene.
+ StringgetName() + +
+          Returns the human readable name of this scene.
+ com.threerings.crowd.data.PlaceConfiggetPlaceConfig() + +
+          Returns the place config that can be used to determine which place + controller instance should be used to display this scene as well as + to obtain runtime configuration information.
+ SceneModelgetSceneModel() + +
+          Returns the scene model from which this scene was created.
+ intgetVersion() + +
+          Returns the version number of this scene.
+ voidsetId(int sceneId) + +
+          Sets this scene's unique identifier.
+ voidsetName(String name) + +
+          Sets the human readable name of this scene.
+ voidsetVersion(int version) + +
+          Sets this scene's version number.
+ StringtoString() + +
+           
+ voidupdateReceived(SceneUpdate update) + +
+          Called to inform the scene that an update has been received while + the scene was resolved and active.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+SceneImpl

+
+public SceneImpl(SceneModel model,
+                 com.threerings.crowd.data.PlaceConfig config)
+
+
Creates an instance that will obtain data from the supplied scene + model and place config. +

+

+
+ +

+SceneImpl

+
+public SceneImpl()
+
+
Instantiates a blank scene implementation. No place config will be + associated with this scene. +

+

+ + + + + + + + +
+Method Detail
+ +

+getId

+
+public int getId()
+
+
Description copied from interface: Scene
+
Returns the unique identifier for this scene. +

+

+
Specified by:
getId in interface Scene
+
+
+
+
+
+
+ +

+getName

+
+public String getName()
+
+
Description copied from interface: Scene
+
Returns the human readable name of this scene. +

+

+
Specified by:
getName in interface Scene
+
+
+
+
+
+
+ +

+getVersion

+
+public int getVersion()
+
+
Description copied from interface: Scene
+
Returns the version number of this scene. +

+

+
Specified by:
getVersion in interface Scene
+
+
+
+
+
+
+ +

+getPlaceConfig

+
+public com.threerings.crowd.data.PlaceConfig getPlaceConfig()
+
+
Description copied from interface: Scene
+
Returns the place config that can be used to determine which place + controller instance should be used to display this scene as well as + to obtain runtime configuration information. +

+

+
Specified by:
getPlaceConfig in interface Scene
+
+
+
+
+
+
+ +

+setId

+
+public void setId(int sceneId)
+
+
Description copied from interface: Scene
+
Sets this scene's unique identifier. +

+

+
Specified by:
setId in interface Scene
+
+
+
+
+
+
+ +

+setName

+
+public void setName(String name)
+
+
Description copied from interface: Scene
+
Sets the human readable name of this scene. +

+

+
Specified by:
setName in interface Scene
+
+
+
+
+
+
+ +

+setVersion

+
+public void setVersion(int version)
+
+
Description copied from interface: Scene
+
Sets this scene's version number. +

+

+
Specified by:
setVersion in interface Scene
+
+
+
+
+
+
+ +

+updateReceived

+
+public void updateReceived(SceneUpdate update)
+
+
Description copied from interface: Scene
+
Called to inform the scene that an update has been received while + the scene was resolved and active. The update should be applied to + the underlying scene model and any derivative data should be + appropriately updated. +

+

+
Specified by:
updateReceived in interface Scene
+
+
+
+
+
+
+ +

+getSceneModel

+
+public SceneModel getSceneModel()
+
+
Description copied from interface: Scene
+
Returns the scene model from which this scene was created. +

+

+
Specified by:
getSceneModel in interface Scene
+
+
+
+
+
+
+ +

+toString

+
+public String toString()
+
+
+
Overrides:
toString in class Object
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/data/SceneMarshaller.SceneMoveMarshaller.html b/apidocs/com/threerings/whirled/data/SceneMarshaller.SceneMoveMarshaller.html new file mode 100644 index 00000000..958ff258 --- /dev/null +++ b/apidocs/com/threerings/whirled/data/SceneMarshaller.SceneMoveMarshaller.html @@ -0,0 +1,540 @@ + + + + + + + +SceneMarshaller.SceneMoveMarshaller (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.data +
+Class SceneMarshaller.SceneMoveMarshaller

+
+java.lang.Object
+  extended by com.threerings.presents.data.InvocationMarshaller.ListenerMarshaller
+      extended by com.threerings.whirled.data.SceneMarshaller.SceneMoveMarshaller
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable, com.threerings.presents.client.InvocationService.InvocationListener, SceneService.SceneMoveListener
+
+
+
Enclosing class:
SceneMarshaller
+
+
+
+
public static class SceneMarshaller.SceneMoveMarshaller
extends com.threerings.presents.data.InvocationMarshaller.ListenerMarshaller
implements SceneService.SceneMoveListener
+ + +

+Marshalls results to implementations of SceneService.SceneMoveListener. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static intMOVE_REQUIRES_SERVER_SWITCH + +
+          The method id used to dispatch moveRequiresServerSwitch(java.lang.String, int[]) + responses.
+static intMOVE_SUCCEEDED + +
+          The method id used to dispatch moveSucceeded(int, com.threerings.crowd.data.PlaceConfig) + responses.
+static intMOVE_SUCCEEDED_WITH_SCENE + +
+          The method id used to dispatch moveSucceededWithScene(int, com.threerings.crowd.data.PlaceConfig, com.threerings.whirled.data.SceneModel) + responses.
+static intMOVE_SUCCEEDED_WITH_UPDATES + +
+          The method id used to dispatch moveSucceededWithUpdates(int, com.threerings.crowd.data.PlaceConfig, com.threerings.whirled.data.SceneUpdate[]) + responses.
+  + + + + + + + +
Fields inherited from class com.threerings.presents.data.InvocationMarshaller.ListenerMarshaller
callerOid, listener, mapStamp, omgr, REQUEST_FAILED_RSPID, requestId, transport
+  + + + + + + + + + + +
+Constructor Summary
SceneMarshaller.SceneMoveMarshaller() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voiddispatchResponse(int methodId, + Object[] args) + +
+           
+ voidmoveRequiresServerSwitch(String arg1, + int[] arg2) + +
+          Indicates that the client must switch to the specified server and reissue its move + request in order to relocate to its desired scene.
+ voidmoveSucceeded(int arg1, + com.threerings.crowd.data.PlaceConfig arg2) + +
+          Indicates that a move succeeded.
+ voidmoveSucceededWithScene(int arg1, + com.threerings.crowd.data.PlaceConfig arg2, + SceneModel arg3) + +
+          Indicates that a move succeeded and that the client's cached scene information should be + updated with the supplied data.
+ voidmoveSucceededWithUpdates(int arg1, + com.threerings.crowd.data.PlaceConfig arg2, + SceneUpdate[] arg3) + +
+          Indicates that a move succeeded and that the client's cached scene information should be + updated with the supplied data.
+  + + + + + + + +
Methods inherited from class com.threerings.presents.data.InvocationMarshaller.ListenerMarshaller
requestFailed, setInvocationId, setNoResponse, toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  + + + + + + + +
Methods inherited from interface com.threerings.presents.client.InvocationService.InvocationListener
requestFailed
+  +

+ + + + + + + + +
+Field Detail
+ +

+MOVE_REQUIRES_SERVER_SWITCH

+
+public static final int MOVE_REQUIRES_SERVER_SWITCH
+
+
The method id used to dispatch moveRequiresServerSwitch(java.lang.String, int[]) + responses. +

+

+
See Also:
Constant Field Values
+
+
+ +

+MOVE_SUCCEEDED

+
+public static final int MOVE_SUCCEEDED
+
+
The method id used to dispatch moveSucceeded(int, com.threerings.crowd.data.PlaceConfig) + responses. +

+

+
See Also:
Constant Field Values
+
+
+ +

+MOVE_SUCCEEDED_WITH_SCENE

+
+public static final int MOVE_SUCCEEDED_WITH_SCENE
+
+
The method id used to dispatch moveSucceededWithScene(int, com.threerings.crowd.data.PlaceConfig, com.threerings.whirled.data.SceneModel) + responses. +

+

+
See Also:
Constant Field Values
+
+
+ +

+MOVE_SUCCEEDED_WITH_UPDATES

+
+public static final int MOVE_SUCCEEDED_WITH_UPDATES
+
+
The method id used to dispatch moveSucceededWithUpdates(int, com.threerings.crowd.data.PlaceConfig, com.threerings.whirled.data.SceneUpdate[]) + responses. +

+

+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Constructor Detail
+ +

+SceneMarshaller.SceneMoveMarshaller

+
+public SceneMarshaller.SceneMoveMarshaller()
+
+
+ + + + + + + + +
+Method Detail
+ +

+moveRequiresServerSwitch

+
+public void moveRequiresServerSwitch(String arg1,
+                                     int[] arg2)
+
+
Description copied from interface: SceneService.SceneMoveListener
+
Indicates that the client must switch to the specified server and reissue its move + request in order to relocate to its desired scene. +

+

+
Specified by:
moveRequiresServerSwitch in interface SceneService.SceneMoveListener
+
+
+
+
+
+
+ +

+moveSucceeded

+
+public void moveSucceeded(int arg1,
+                          com.threerings.crowd.data.PlaceConfig arg2)
+
+
Description copied from interface: SceneService.SceneMoveListener
+
Indicates that a move succeeded. +

+

+
Specified by:
moveSucceeded in interface SceneService.SceneMoveListener
+
+
+
Parameters:
arg1 - the place object id of the newly occupied scene.
arg2 - metadata related to the newly occupied scene.
+
+
+
+ +

+moveSucceededWithScene

+
+public void moveSucceededWithScene(int arg1,
+                                   com.threerings.crowd.data.PlaceConfig arg2,
+                                   SceneModel arg3)
+
+
Description copied from interface: SceneService.SceneMoveListener
+
Indicates that a move succeeded and that the client's cached scene information should be + updated with the supplied data. +

+

+
Specified by:
moveSucceededWithScene in interface SceneService.SceneMoveListener
+
+
+
Parameters:
arg1 - the place object id of the newly occupied scene.
arg2 - metadata related to the newly occupied scene.
arg3 - a fresh copy of the most recent scene data for the newly occupied scene.
+
+
+
+ +

+moveSucceededWithUpdates

+
+public void moveSucceededWithUpdates(int arg1,
+                                     com.threerings.crowd.data.PlaceConfig arg2,
+                                     SceneUpdate[] arg3)
+
+
Description copied from interface: SceneService.SceneMoveListener
+
Indicates that a move succeeded and that the client's cached scene information should be + updated with the supplied data. +

+

+
Specified by:
moveSucceededWithUpdates in interface SceneService.SceneMoveListener
+
+
+
Parameters:
arg1 - the place object id of the newly occupied scene.
arg2 - metadata related to the newly occupied scene.
arg3 - updates that must be applied to the client's copy of a scene model to + bring it up to date.
+
+
+
+ +

+dispatchResponse

+
+public void dispatchResponse(int methodId,
+                             Object[] args)
+
+
+
Overrides:
dispatchResponse in class com.threerings.presents.data.InvocationMarshaller.ListenerMarshaller
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/data/SceneMarshaller.html b/apidocs/com/threerings/whirled/data/SceneMarshaller.html new file mode 100644 index 00000000..c3ac5181 --- /dev/null +++ b/apidocs/com/threerings/whirled/data/SceneMarshaller.html @@ -0,0 +1,381 @@ + + + + + + + +SceneMarshaller (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.data +
+Class SceneMarshaller

+
+java.lang.Object
+  extended by com.threerings.presents.data.InvocationMarshaller
+      extended by com.threerings.whirled.data.SceneMarshaller
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable, com.threerings.presents.client.InvocationService, SceneService
+
+
+
+
@Generated(value="com.threerings.presents.tools.GenServiceTask",
+           comments="Derived from SceneService.java.")
+public class SceneMarshaller
extends com.threerings.presents.data.InvocationMarshaller
implements SceneService
+ + +

+Provides the implementation of the SceneService interface + that marshalls the arguments and delivers the request to the provider + on the server. Also provides an implementation of the response listener + interfaces that marshall the response arguments and deliver them back + to the requesting client. +

+ +

+

+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static classSceneMarshaller.SceneMoveMarshaller + +
+          Marshalls results to implementations of SceneService.SceneMoveListener.
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.presents.data.InvocationMarshaller
com.threerings.presents.data.InvocationMarshaller.ConfirmMarshaller, com.threerings.presents.data.InvocationMarshaller.ListenerMarshaller, com.threerings.presents.data.InvocationMarshaller.ResultMarshaller
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.whirled.client.SceneService
SceneService.SceneMoveListener
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.presents.client.InvocationService
com.threerings.presents.client.InvocationService.ConfirmListener, com.threerings.presents.client.InvocationService.InvocationListener, com.threerings.presents.client.InvocationService.ResultListener
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + +
+Field Summary
+static intMOVE_TO + +
+          The method id used to dispatch moveTo(int, int, com.threerings.whirled.client.SceneService.SceneMoveListener) requests.
+  + + + + + + + + + + +
+Constructor Summary
SceneMarshaller() + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ voidmoveTo(int arg1, + int arg2, + SceneService.SceneMoveListener arg3) + +
+          Requests that that this client's body be moved to the specified scene.
+  + + + + + + + +
Methods inherited from class com.threerings.presents.data.InvocationMarshaller
getInvocationCode, init, readField__invCode, readField__invOid, readObject, setInvocationOid, setNoResponse, toString, writeField__invCode, writeField__invOid
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+MOVE_TO

+
+public static final int MOVE_TO
+
+
The method id used to dispatch moveTo(int, int, com.threerings.whirled.client.SceneService.SceneMoveListener) requests. +

+

+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Constructor Detail
+ +

+SceneMarshaller

+
+public SceneMarshaller()
+
+
+ + + + + + + + +
+Method Detail
+ +

+moveTo

+
+public void moveTo(int arg1,
+                   int arg2,
+                   SceneService.SceneMoveListener arg3)
+
+
Description copied from interface: SceneService
+
Requests that that this client's body be moved to the specified scene. +

+

+
Specified by:
moveTo in interface SceneService
+
+
+
Parameters:
arg1 - the scene id to which we want to move.
arg2 - the version number of the scene object that we have in our local repository.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/data/SceneModel.html b/apidocs/com/threerings/whirled/data/SceneModel.html new file mode 100644 index 00000000..c9c19a04 --- /dev/null +++ b/apidocs/com/threerings/whirled/data/SceneModel.html @@ -0,0 +1,453 @@ + + + + + + + +SceneModel (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.data +
+Class SceneModel

+
+java.lang.Object
+  extended by com.threerings.io.SimpleStreamableObject
+      extended by com.threerings.whirled.data.SceneModel
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable, Cloneable
+
+
+
Direct Known Subclasses:
StageSceneModel
+
+
+
+
public class SceneModel
extends com.threerings.io.SimpleStreamableObject
implements Cloneable
+ + +

+The scene model is the bare bones representation of the data for a + scene in the Whirled system. From the scene model, one would create an + instance of Scene. + +

The scene model is what is loaded from the scene repositories and + what is transmitted over the wire when communicating scenes from the + server to the client. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+ AuxModel[]auxModels + +
+          Auxiliary scene model information.
+ Stringname + +
+          The human readable name of this scene.
+ intsceneId + +
+          This scene's unique identifier.
+ intversion + +
+          The version number of this scene.
+  + + + + + + + + + + +
+Constructor Summary
SceneModel() + +
+           
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidaddAuxModel(AuxModel auxModel) + +
+          Adds the specified auxiliary model to this scene model.
+static SceneModelblankSceneModel() + +
+          Creates and returns a blank scene model.
+ SceneModelclone() + +
+           
+  + + + + + + + +
Methods inherited from class com.threerings.io.SimpleStreamableObject
toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+sceneId

+
+public int sceneId
+
+
This scene's unique identifier. +

+

+
+
+
+ +

+name

+
+public String name
+
+
The human readable name of this scene. +

+

+
+
+
+ +

+version

+
+public int version
+
+
The version number of this scene. Versions are incremented + whenever modifications are made to a scene so that clients can + determine whether or not they have the latest version of a + scene. +

+

+
+
+
+ +

+auxModels

+
+public AuxModel[] auxModels
+
+
Auxiliary scene model information. +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+SceneModel

+
+public SceneModel()
+
+
+ + + + + + + + +
+Method Detail
+ +

+addAuxModel

+
+public void addAuxModel(AuxModel auxModel)
+
+
Adds the specified auxiliary model to this scene model. +

+

+
+
+
+
+
+
+
+ +

+clone

+
+public SceneModel clone()
+                 throws CloneNotSupportedException
+
+
+
Overrides:
clone in class Object
+
+
+ +
Throws: +
CloneNotSupportedException
+
+
+
+ +

+blankSceneModel

+
+public static SceneModel blankSceneModel()
+
+
Creates and returns a blank scene model. +

+

+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/data/SceneObject.html b/apidocs/com/threerings/whirled/data/SceneObject.html new file mode 100644 index 00000000..44c5950e --- /dev/null +++ b/apidocs/com/threerings/whirled/data/SceneObject.html @@ -0,0 +1,308 @@ + + + + + + + +SceneObject (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.data +
+Class SceneObject

+
+java.lang.Object
+  extended by com.threerings.presents.dobj.DObject
+      extended by com.threerings.crowd.data.PlaceObject
+          extended by com.threerings.whirled.data.SceneObject
+
+
+
All Implemented Interfaces:
com.threerings.crowd.chat.data.SpeakObject, com.threerings.io.Streamable
+
+
+
Direct Known Subclasses:
SpotSceneObject
+
+
+
+
public class SceneObject
extends com.threerings.crowd.data.PlaceObject
+ + +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.crowd.data.PlaceObject
com.threerings.crowd.data.PlaceObject.ManagerCaller
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.crowd.chat.data.SpeakObject
com.threerings.crowd.chat.data.SpeakObject.ListenerOp
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class com.threerings.crowd.data.PlaceObject
manager, OCCUPANT_INFO, occupantInfo, occupants, OCCUPANTS, SPEAK_SERVICE, speakService
+  + + + + + + + + + + +
+Constructor Summary
SceneObject() + +
+           
+  + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from class com.threerings.crowd.data.PlaceObject
addToOccupantInfo, addToOccupants, applyToListeners, getOccupantInfo, initManagerCaller, removeFromOccupantInfo, removeFromOccupants, setOccupantInfo, setSpeakService, shouldBroadcast, updateOccupantInfo
+  + + + + + + + +
Methods inherited from class com.threerings.presents.dobj.DObject
acquireLock, addListener, addListener, addSubscriber, addToSet, cancelTransaction, changeAttribute, checkPermissions, checkPermissions, commitTransaction, destroy, getAccessController, getAttribute, getLocal, getLocals, getManager, getOid, getSet, inTransaction, isActive, notifyListeners, notifyProxies, postEvent, postMessage, postMessage, readField__oid, releaseLock, removeFromSet, removeListener, removeSubscriber, setAccessController, setAttribute, setDestroyOnLastSubscriberRemoved, setLocal, setManager, setOid, startTransaction, toString, updateSet, which, writeField__oid
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+SceneObject

+
+public SceneObject()
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/data/ScenePlace.html b/apidocs/com/threerings/whirled/data/ScenePlace.html new file mode 100644 index 00000000..5ce48430 --- /dev/null +++ b/apidocs/com/threerings/whirled/data/ScenePlace.html @@ -0,0 +1,373 @@ + + + + + + + +ScenePlace (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.data +
+Class ScenePlace

+
+java.lang.Object
+  extended by com.threerings.io.SimpleStreamableObject
+      extended by com.threerings.crowd.data.Place
+          extended by com.threerings.whirled.data.ScenePlace
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable
+
+
+
+
public class ScenePlace
extends com.threerings.crowd.data.Place
+ + +

+Extends Place with scene information. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + +
+Field Summary
+ intsceneId + +
+          The id of the scene occupied by the body.
+  + + + + + + + +
Fields inherited from class com.threerings.crowd.data.Place
placeOid
+  + + + + + + + + + + +
+Constructor Summary
ScenePlace(int sceneOid, + int sceneId) + +
+          Creates a scene place with the supplied SceneObject oid and scene id.
+  + + + + + + + + + + + + + + + +
+Method Summary
+static intgetSceneId(com.threerings.crowd.data.BodyObject bobj) + +
+          Returns the scene id occupied by the supplied body or -1 if the body is not in a scene.
+static intgetSceneId(com.threerings.crowd.data.Place place) + +
+          Returns the scene id for the supplied place or -1 if the place is null or not a scene place.
+  + + + + + + + +
Methods inherited from class com.threerings.crowd.data.Place
equals, hashCode
+  + + + + + + + +
Methods inherited from class com.threerings.io.SimpleStreamableObject
toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+sceneId

+
+public int sceneId
+
+
The id of the scene occupied by the body. +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+ScenePlace

+
+public ScenePlace(int sceneOid,
+                  int sceneId)
+
+
Creates a scene place with the supplied SceneObject oid and scene id. +

+

+ + + + + + + + +
+Method Detail
+ +

+getSceneId

+
+public static int getSceneId(com.threerings.crowd.data.Place place)
+
+
Returns the scene id for the supplied place or -1 if the place is null or not a scene place. +

+

+
+
+
+
+ +

+getSceneId

+
+public static int getSceneId(com.threerings.crowd.data.BodyObject bobj)
+
+
Returns the scene id occupied by the supplied body or -1 if the body is not in a scene. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/data/SceneUpdate.html b/apidocs/com/threerings/whirled/data/SceneUpdate.html new file mode 100644 index 00000000..d7f395da --- /dev/null +++ b/apidocs/com/threerings/whirled/data/SceneUpdate.html @@ -0,0 +1,554 @@ + + + + + + + +SceneUpdate (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.data +
+Class SceneUpdate

+
+java.lang.Object
+  extended by com.threerings.whirled.data.SceneUpdate
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable, Cloneable
+
+
+
Direct Known Subclasses:
DefaultColorUpdate, ModifyObjectsUpdate, ModifyPortalsUpdate
+
+
+
+
public class SceneUpdate
extends Object
implements com.threerings.io.Streamable, Cloneable
+ + +

+Used to encapsulate updates to scenes in such a manner that updates can be stored persistently + and sent to clients to update their own local copies of scenes. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + +
+Constructor Summary
SceneUpdate() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidapply(SceneModel model) + +
+          Applies this update to the specified scene model.
+ intgetSceneId() + +
+          Returns the scene id for which this update is appropriate.
+ intgetSceneVersion() + +
+          Returns the scene version for which this update is appropriate.
+ intgetVersionIncrement() + +
+          Returns the amount by which this update increments the scene version.
+ voidinit(int targetId, + int targetVersion) + +
+          Initializes this scene update such that it will operate on a scene with the specified target + scene and version number.
+ voidpersistTo(com.threerings.io.ObjectOutputStream out) + +
+          Serializes the bare representation of this instance without the scene id and version fields.
+ voidreadObject(com.threerings.io.ObjectInputStream in) + +
+          Reads our custom streamable fields.
+ StringtoString() + +
+           
+ voidunpersistFrom(com.threerings.io.ObjectInputStream in) + +
+          Unserializes this instance from the bare representation created by persistTo(com.threerings.io.ObjectOutputStream).
+ voidvalidate(SceneModel model) + +
+          Called to ensure that the scene is in the appropriate state prior to applying the update.
+ voidwriteObject(com.threerings.io.ObjectOutputStream out) + +
+          Writes our custom streamable fields.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+SceneUpdate

+
+public SceneUpdate()
+
+
+ + + + + + + + +
+Method Detail
+ +

+init

+
+public void init(int targetId,
+                 int targetVersion)
+
+
Initializes this scene update such that it will operate on a scene with the specified target + scene and version number. +

+

+
+
+
+
Parameters:
targetId - the id of the scene on which we are to operate.
targetVersion - the version of the scene on which we are to operate.
+
+
+
+ +

+getSceneId

+
+public int getSceneId()
+
+
Returns the scene id for which this update is appropriate. +

+

+
+
+
+
+
+
+
+ +

+getSceneVersion

+
+public int getSceneVersion()
+
+
Returns the scene version for which this update is appropriate. +

+

+
+
+
+
+
+
+
+ +

+getVersionIncrement

+
+public int getVersionIncrement()
+
+
Returns the amount by which this update increments the scene version. +

+

+
+
+
+
+
+
+
+ +

+validate

+
+public void validate(SceneModel model)
+              throws IllegalStateException
+
+
Called to ensure that the scene is in the appropriate state prior to applying the update. +

+

+
+
+
+ +
Throws: +
IllegalStateException - thrown if the update cannot be applied to the scene because + it is not in a valid state (appropriate previous updates were not applied, it's the wrong + kind of scene, etc.).
+
+
+
+ +

+apply

+
+public void apply(SceneModel model)
+
+
Applies this update to the specified scene model. Derived classes will want to override this + method and apply updates of their own, being sure to call super.apply. +

+

+
+
+
+
+
+
+
+ +

+writeObject

+
+public void writeObject(com.threerings.io.ObjectOutputStream out)
+                 throws IOException
+
+
Writes our custom streamable fields. +

+

+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+readObject

+
+public void readObject(com.threerings.io.ObjectInputStream in)
+                throws IOException,
+                       ClassNotFoundException
+
+
Reads our custom streamable fields. +

+

+
+
+
+ +
Throws: +
IOException +
ClassNotFoundException
+
+
+
+ +

+persistTo

+
+public void persistTo(com.threerings.io.ObjectOutputStream out)
+               throws IOException
+
+
Serializes the bare representation of this instance without the scene id and version fields. + Useful when storing updates in a database where the scene id and version fields are stored + in separate columns and the rest if the representation is contained in an opaque blob. +

+

+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+unpersistFrom

+
+public void unpersistFrom(com.threerings.io.ObjectInputStream in)
+                   throws IOException,
+                          ClassNotFoundException
+
+
Unserializes this instance from the bare representation created by persistTo(com.threerings.io.ObjectOutputStream). +

+

+
+
+
+ +
Throws: +
IOException +
ClassNotFoundException
+
+
+
+ +

+toString

+
+public String toString()
+
+
+
Overrides:
toString in class Object
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/data/class-use/AuxModel.html b/apidocs/com/threerings/whirled/data/class-use/AuxModel.html new file mode 100644 index 00000000..17c814e5 --- /dev/null +++ b/apidocs/com/threerings/whirled/data/class-use/AuxModel.html @@ -0,0 +1,272 @@ + + + + + + + +Uses of Interface com.threerings.whirled.data.AuxModel (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.whirled.data.AuxModel

+
+ + + + + + + + + + + + + + + + + +
+Packages that use AuxModel
com.threerings.stage.data  
com.threerings.whirled.data  
com.threerings.whirled.spot.data  
+  +

+ + + + + +
+Uses of AuxModel in com.threerings.stage.data
+  +

+ + + + + + + + + +
Classes in com.threerings.stage.data that implement AuxModel
+ classStageMisoSceneModel + +
+          Extends the SparseMisoSceneModel with the necessary interface + to wire it up to the Whirled auxiliary model system.
+  +

+ + + + + +
+Uses of AuxModel in com.threerings.whirled.data
+  +

+ + + + + + + + + +
Fields in com.threerings.whirled.data declared as AuxModel
+ AuxModel[]SceneModel.auxModels + +
+          Auxiliary scene model information.
+  +

+ + + + + + + + + +
Methods in com.threerings.whirled.data that return AuxModel
+ AuxModelAuxModel.clone() + +
+          Creates a clone of this auxiliary model.
+  +

+ + + + + + + + + +
Methods in com.threerings.whirled.data with parameters of type AuxModel
+ voidSceneModel.addAuxModel(AuxModel auxModel) + +
+          Adds the specified auxiliary model to this scene model.
+  +

+ + + + + +
+Uses of AuxModel in com.threerings.whirled.spot.data
+  +

+ + + + + + + + + +
Classes in com.threerings.whirled.spot.data that implement AuxModel
+ classSpotSceneModel + +
+          The spot scene model extends the standard scene model with information on portals.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/data/class-use/DefaultSceneConfig.html b/apidocs/com/threerings/whirled/data/class-use/DefaultSceneConfig.html new file mode 100644 index 00000000..c58ff5d1 --- /dev/null +++ b/apidocs/com/threerings/whirled/data/class-use/DefaultSceneConfig.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.whirled.data.DefaultSceneConfig (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.data.DefaultSceneConfig

+
+No usage of com.threerings.whirled.data.DefaultSceneConfig +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/data/class-use/Scene.html b/apidocs/com/threerings/whirled/data/class-use/Scene.html new file mode 100644 index 00000000..8b55e21f --- /dev/null +++ b/apidocs/com/threerings/whirled/data/class-use/Scene.html @@ -0,0 +1,301 @@ + + + + + + + +Uses of Interface com.threerings.whirled.data.Scene (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.whirled.data.Scene

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
+Packages that use Scene
com.threerings.stage.data  
com.threerings.whirled.client  
com.threerings.whirled.data  
com.threerings.whirled.server  
com.threerings.whirled.util  
+  +

+ + + + + +
+Uses of Scene in com.threerings.stage.data
+  +

+ + + + + + + + + +
Classes in com.threerings.stage.data that implement Scene
+ classStageScene + +
+          The implementation of the Stage scene interface.
+  +

+ + + + + +
+Uses of Scene in com.threerings.whirled.client
+  +

+ + + + + + + + + +
Methods in com.threerings.whirled.client that return Scene
+ SceneSceneDirector.getScene() + +
+          Returns the display scene object associated with the scene we currently occupy or null if we + currently occupy no scene.
+  +

+ + + + + +
+Uses of Scene in com.threerings.whirled.data
+  +

+ + + + + + + + + +
Classes in com.threerings.whirled.data that implement Scene
+ classSceneImpl + +
+          An implementation of the Scene interface.
+  +

+ + + + + +
+Uses of Scene in com.threerings.whirled.server
+  +

+ + + + + + + + + +
Methods in com.threerings.whirled.server that return Scene
+ SceneSceneManager.getScene() + +
+          Returns the scene object (not the scene distributed object) being managed by this scene + manager.
+  +

+ + + + + +
+Uses of Scene in com.threerings.whirled.util
+  +

+ + + + + + + + + +
Methods in com.threerings.whirled.util that return Scene
+ SceneSceneFactory.createScene(SceneModel model, + com.threerings.crowd.data.PlaceConfig config) + +
+          Creates a Scene implementation given the supplied scene + model and place config.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/data/class-use/SceneCodes.html b/apidocs/com/threerings/whirled/data/class-use/SceneCodes.html new file mode 100644 index 00000000..ec09be34 --- /dev/null +++ b/apidocs/com/threerings/whirled/data/class-use/SceneCodes.html @@ -0,0 +1,365 @@ + + + + + + + +Uses of Interface com.threerings.whirled.data.SceneCodes (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.whirled.data.SceneCodes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Packages that use SceneCodes
com.threerings.stage.server  
com.threerings.whirled.client  
com.threerings.whirled.server  
com.threerings.whirled.spot.client  
com.threerings.whirled.spot.data  
com.threerings.whirled.spot.server  
com.threerings.whirled.zone.data  
+  +

+ + + + + +
+Uses of SceneCodes in com.threerings.stage.server
+  +

+ + + + + + + + + +
Classes in com.threerings.stage.server that implement SceneCodes
+ classStageSceneManager + +
+          Defines extensions to the basic Stage scene manager specific to displaying isometric "stage" + scenes (these may be indoor, outdoor or aboard a vessel).
+  +

+ + + + + +
+Uses of SceneCodes in com.threerings.whirled.client
+  +

+ + + + + + + + + +
Classes in com.threerings.whirled.client that implement SceneCodes
+ classSceneDirector + +
+          The scene director is the client's interface to all things scene related.
+  +

+ + + + + +
+Uses of SceneCodes in com.threerings.whirled.server
+  +

+ + + + + + + + + +
Classes in com.threerings.whirled.server that implement SceneCodes
+ classSceneRegistry + +
+          The scene registry is responsible for the management of all scenes.
+  +

+ + + + + +
+Uses of SceneCodes in com.threerings.whirled.spot.client
+  +

+ + + + + + + + + +
Classes in com.threerings.whirled.spot.client that implement SceneCodes
+ classSpotSceneDirector + +
+          Extends the standard scene director with facilities to move between locations within a scene.
+  +

+ + + + + +
+Uses of SceneCodes in com.threerings.whirled.spot.data
+  +

+ + + + + + + + + +
Subinterfaces of SceneCodes in com.threerings.whirled.spot.data
+ interfaceSpotCodes + +
+          Contains codes used by the Spot invocation services.
+  +

+ + + + + +
+Uses of SceneCodes in com.threerings.whirled.spot.server
+  +

+ + + + + + + + + + + + + +
Classes in com.threerings.whirled.spot.server that implement SceneCodes
+ classSpotSceneManager + +
+          Handles the movement of bodies between locations in the scene and creates the necessary + distributed objects to allow bodies in clusters to chat with one another.
+ classSpotSceneRegistry + +
+          Extends the SceneRegistry with spot-related services.
+  +

+ + + + + +
+Uses of SceneCodes in com.threerings.whirled.zone.data
+  +

+ + + + + + + + + +
Subinterfaces of SceneCodes in com.threerings.whirled.zone.data
+ interfaceZoneCodes + +
+          Contains codes used by the zone services.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/data/class-use/SceneImpl.html b/apidocs/com/threerings/whirled/data/class-use/SceneImpl.html new file mode 100644 index 00000000..03735d3f --- /dev/null +++ b/apidocs/com/threerings/whirled/data/class-use/SceneImpl.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class com.threerings.whirled.data.SceneImpl (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.data.SceneImpl

+
+ + + + + + + + + +
+Packages that use SceneImpl
com.threerings.stage.data  
+  +

+ + + + + +
+Uses of SceneImpl in com.threerings.stage.data
+  +

+ + + + + + + + + +
Subclasses of SceneImpl in com.threerings.stage.data
+ classStageScene + +
+          The implementation of the Stage scene interface.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/data/class-use/SceneMarshaller.SceneMoveMarshaller.html b/apidocs/com/threerings/whirled/data/class-use/SceneMarshaller.SceneMoveMarshaller.html new file mode 100644 index 00000000..9cc9ee62 --- /dev/null +++ b/apidocs/com/threerings/whirled/data/class-use/SceneMarshaller.SceneMoveMarshaller.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.whirled.data.SceneMarshaller.SceneMoveMarshaller (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.data.SceneMarshaller.SceneMoveMarshaller

+
+No usage of com.threerings.whirled.data.SceneMarshaller.SceneMoveMarshaller +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/data/class-use/SceneMarshaller.html b/apidocs/com/threerings/whirled/data/class-use/SceneMarshaller.html new file mode 100644 index 00000000..89a02137 --- /dev/null +++ b/apidocs/com/threerings/whirled/data/class-use/SceneMarshaller.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.whirled.data.SceneMarshaller (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.data.SceneMarshaller

+
+No usage of com.threerings.whirled.data.SceneMarshaller +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/data/class-use/SceneModel.html b/apidocs/com/threerings/whirled/data/class-use/SceneModel.html new file mode 100644 index 00000000..c0e910f7 --- /dev/null +++ b/apidocs/com/threerings/whirled/data/class-use/SceneModel.html @@ -0,0 +1,762 @@ + + + + + + + +Uses of Class com.threerings.whirled.data.SceneModel (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.data.SceneModel

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Packages that use SceneModel
com.threerings.stage.data  
com.threerings.whirled.client  
com.threerings.whirled.client.persist  
com.threerings.whirled.data  
com.threerings.whirled.server  
com.threerings.whirled.server.persist  
com.threerings.whirled.spot.data  
com.threerings.whirled.tools.xml  
com.threerings.whirled.util  
com.threerings.whirled.zone.client  
com.threerings.whirled.zone.data  
+  +

+ + + + + +
+Uses of SceneModel in com.threerings.stage.data
+  +

+ + + + + + + + + +
Subclasses of SceneModel in com.threerings.stage.data
+ classStageSceneModel + +
+          Extends the basic scene model with the notion of a scene type and + incorporates the necessary auxiliary models used by the Stage system.
+  +

+ + + + + + + + + + + + + + + + + +
Methods in com.threerings.stage.data with parameters of type SceneModel
+ voidModifyObjectsUpdate.apply(SceneModel model) + +
+           
+ voidDefaultColorUpdate.apply(SceneModel model) + +
+           
+static StageMisoSceneModelStageMisoSceneModel.getSceneModel(SceneModel model) + +
+          Locates and returns the StageMisoSceneModel among the + auxiliary scene models associated with the supplied scene model.
+  +

+ + + + + +
+Uses of SceneModel in com.threerings.whirled.client
+  +

+ + + + + + + + + +
Methods in com.threerings.whirled.client that return SceneModel
+ SceneModelSceneDirector.getPendingModel() + +
+          Returns the model loaded in preparation for a scene transition.
+  +

+ + + + + + + + + + + + + + + + + +
Methods in com.threerings.whirled.client with parameters of type SceneModel
+ voidSceneService.SceneMoveListener.moveSucceededWithScene(int placeId, + com.threerings.crowd.data.PlaceConfig config, + SceneModel model) + +
+          Indicates that a move succeeded and that the client's cached scene information should be + updated with the supplied data.
+ voidSceneMoveAdapter.moveSucceededWithScene(int placeId, + com.threerings.crowd.data.PlaceConfig config, + SceneModel model) + +
+           
+ voidSceneDirector.moveSucceededWithScene(int placeId, + com.threerings.crowd.data.PlaceConfig config, + SceneModel model) + +
+           
+  +

+ + + + + +
+Uses of SceneModel in com.threerings.whirled.client.persist
+  +

+ + + + + + + + + +
Methods in com.threerings.whirled.client.persist that return SceneModel
+ SceneModelSceneRepository.loadSceneModel(int sceneId) + +
+          Fetches the model for the scene with the specified id.
+  +

+ + + + + + + + + +
Methods in com.threerings.whirled.client.persist with parameters of type SceneModel
+ voidSceneRepository.storeSceneModel(SceneModel model) + +
+          Updates or inserts this scene model as appropriate.
+  +

+ + + + + +
+Uses of SceneModel in com.threerings.whirled.data
+  +

+ + + + + + + + + + + + + + + + + + + + + +
Methods in com.threerings.whirled.data that return SceneModel
+static SceneModelSceneModel.blankSceneModel() + +
+          Creates and returns a blank scene model.
+ SceneModelSceneModel.clone() + +
+           
+ SceneModelSceneImpl.getSceneModel() + +
+           
+ SceneModelScene.getSceneModel() + +
+          Returns the scene model from which this scene was created.
+  +

+ + + + + + + + + + + + + + + + + +
Methods in com.threerings.whirled.data with parameters of type SceneModel
+ voidSceneUpdate.apply(SceneModel model) + +
+          Applies this update to the specified scene model.
+ voidSceneMarshaller.SceneMoveMarshaller.moveSucceededWithScene(int arg1, + com.threerings.crowd.data.PlaceConfig arg2, + SceneModel arg3) + +
+           
+ voidSceneUpdate.validate(SceneModel model) + +
+          Called to ensure that the scene is in the appropriate state prior to applying the update.
+  +

+ + + + + + + + +
Constructors in com.threerings.whirled.data with parameters of type SceneModel
SceneImpl(SceneModel model, + com.threerings.crowd.data.PlaceConfig config) + +
+          Creates an instance that will obtain data from the supplied scene + model and place config.
+  +

+ + + + + +
+Uses of SceneModel in com.threerings.whirled.server
+  +

+ + + + + + + + + +
Methods in com.threerings.whirled.server with parameters of type SceneModel
+ com.threerings.crowd.data.PlaceConfigSceneRegistry.ConfigFactory.createPlaceConfig(SceneModel model) + +
+          Creates the place config instance appropriate to the specified scene.
+  +

+ + + + + +
+Uses of SceneModel in com.threerings.whirled.server.persist
+  +

+ + + + + + + + + + + + + +
Methods in com.threerings.whirled.server.persist that return SceneModel
+ SceneModelSceneRepository.loadSceneModel(int sceneId) + +
+          Fetches the model for the scene with the specified scene id.
+ SceneModelDummySceneRepository.loadSceneModel(int sceneId) + +
+           
+  +

+ + + + + + + + + + + + + + + + + + + + + +
Methods in com.threerings.whirled.server.persist with parameters of type SceneModel
+ voidSceneRepository.applyAndRecordUpdate(SceneModel model, + SceneUpdate update) + +
+          Applise the supplied scene update to persistent representation of its associated scene, then + stores the update persistently for future invocations of the server to load.
+ voidDummySceneRepository.applyAndRecordUpdate(SceneModel model, + SceneUpdate update) + +
+           
+ ObjectSceneRepository.loadExtras(int sceneId, + SceneModel model) + +
+          Loads optional additional scene data.
+ ObjectDummySceneRepository.loadExtras(int sceneId, + SceneModel model) + +
+           
+  +

+ + + + + +
+Uses of SceneModel in com.threerings.whirled.spot.data
+  +

+ + + + + + + + + + + + + + + + + +
Methods in com.threerings.whirled.spot.data with parameters of type SceneModel
+ voidModifyPortalsUpdate.apply(SceneModel model) + +
+           
+static SpotSceneModelSpotSceneModel.getSceneModel(SceneModel model) + +
+          Locates and returns the SpotSceneModel among the auxiliary scene models associated + with the supplied scene model.
+ voidSpotMarshaller.SpotSceneMoveMarshaller.moveSucceededWithScene(int arg1, + com.threerings.crowd.data.PlaceConfig arg2, + SceneModel arg3) + +
+           
+  +

+ + + + + +
+Uses of SceneModel in com.threerings.whirled.tools.xml
+  +

+ + + + + + + + + +
Methods in com.threerings.whirled.tools.xml that return SceneModel
+ SceneModelSceneParser.parseScene(String path) + +
+          Parses the XML file at the specified path into a scene model + instance.
+  +

+ + + + + + + + + + + + + + + + + +
Methods in com.threerings.whirled.tools.xml with parameters of type SceneModel
+ voidSceneParser.setScene(SceneModel model) + +
+          Called by the parser once the scene is parsed.
+ voidSceneWriter.writeScene(File out, + SceneModel model) + +
+          Writes the supplied scene out to the specified file.
+ voidSceneWriter.writeSceneModel(SceneModel model, + com.megginson.sax.DataWriter writer) + +
+          Writes the data for the supplied SceneModel to the XML data + writer supplied.
+  +

+ + + + + +
+Uses of SceneModel in com.threerings.whirled.util
+  +

+ + + + + + + + + +
Methods in com.threerings.whirled.util with parameters of type SceneModel
+ SceneSceneFactory.createScene(SceneModel model, + com.threerings.crowd.data.PlaceConfig config) + +
+          Creates a Scene implementation given the supplied scene + model and place config.
+  +

+ + + + + +
+Uses of SceneModel in com.threerings.whirled.zone.client
+  +

+ + + + + + + + + + + + + +
Methods in com.threerings.whirled.zone.client with parameters of type SceneModel
+ voidZoneService.ZoneMoveListener.moveSucceededWithScene(int placeId, + com.threerings.crowd.data.PlaceConfig config, + ZoneSummary summary, + SceneModel model) + +
+          Called in response to a successful ZoneService.moveTo(int, int, int, com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener) request when our cached + scene was out of date and the server determined that we needed an updated copy.
+ voidZoneDirector.moveSucceededWithScene(int placeId, + com.threerings.crowd.data.PlaceConfig config, + ZoneSummary summary, + SceneModel model) + +
+           
+  +

+ + + + + +
+Uses of SceneModel in com.threerings.whirled.zone.data
+  +

+ + + + + + + + + +
Methods in com.threerings.whirled.zone.data with parameters of type SceneModel
+ voidZoneMarshaller.ZoneMoveMarshaller.moveSucceededWithScene(int arg1, + com.threerings.crowd.data.PlaceConfig arg2, + ZoneSummary arg3, + SceneModel arg4) + +
+           
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/data/class-use/SceneObject.html b/apidocs/com/threerings/whirled/data/class-use/SceneObject.html new file mode 100644 index 00000000..8708ba50 --- /dev/null +++ b/apidocs/com/threerings/whirled/data/class-use/SceneObject.html @@ -0,0 +1,211 @@ + + + + + + + +Uses of Class com.threerings.whirled.data.SceneObject (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.data.SceneObject

+
+ + + + + + + + + + + + + +
+Packages that use SceneObject
com.threerings.stage.data  
com.threerings.whirled.spot.data  
+  +

+ + + + + +
+Uses of SceneObject in com.threerings.stage.data
+  +

+ + + + + + + + + +
Subclasses of SceneObject in com.threerings.stage.data
+ classStageSceneObject + +
+          Extends the basic SpotSceneObject with data and services + specific to isometric stage scenes.
+  +

+ + + + + +
+Uses of SceneObject in com.threerings.whirled.spot.data
+  +

+ + + + + + + + + +
Subclasses of SceneObject in com.threerings.whirled.spot.data
+ classSpotSceneObject + +
+          Extends the SceneObject with information specific to spots.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/data/class-use/ScenePlace.html b/apidocs/com/threerings/whirled/data/class-use/ScenePlace.html new file mode 100644 index 00000000..04c39fa9 --- /dev/null +++ b/apidocs/com/threerings/whirled/data/class-use/ScenePlace.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.whirled.data.ScenePlace (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.data.ScenePlace

+
+No usage of com.threerings.whirled.data.ScenePlace +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/data/class-use/SceneUpdate.html b/apidocs/com/threerings/whirled/data/class-use/SceneUpdate.html new file mode 100644 index 00000000..866e72f5 --- /dev/null +++ b/apidocs/com/threerings/whirled/data/class-use/SceneUpdate.html @@ -0,0 +1,617 @@ + + + + + + + +Uses of Class com.threerings.whirled.data.SceneUpdate (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.data.SceneUpdate

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Packages that use SceneUpdate
com.threerings.stage.client  
com.threerings.stage.data  
com.threerings.whirled.client  
com.threerings.whirled.data  
com.threerings.whirled.server  
com.threerings.whirled.server.persist  
com.threerings.whirled.spot.data  
com.threerings.whirled.util  
com.threerings.whirled.zone.client  
com.threerings.whirled.zone.data  
+  +

+ + + + + +
+Uses of SceneUpdate in com.threerings.stage.client
+  +

+ + + + + + + + + +
Methods in com.threerings.stage.client with parameters of type SceneUpdate
+ voidStageScenePanel.sceneUpdated(SceneUpdate update) + +
+          Called when we have received a scene update from the server.
+  +

+ + + + + +
+Uses of SceneUpdate in com.threerings.stage.data
+  +

+ + + + + + + + + + + + + +
Subclasses of SceneUpdate in com.threerings.stage.data
+ classDefaultColorUpdate + +
+          Update to change the default colorization for objects in a scene which + do not define their own colorization.
+ classModifyObjectsUpdate + +
+          A scene update that is broadcast when objects have been added to or removed + from the scene.
+  +

+ + + + + + + + + +
Methods in com.threerings.stage.data with parameters of type SceneUpdate
+ voidStageScene.updateReceived(SceneUpdate update) + +
+           
+  +

+ + + + + +
+Uses of SceneUpdate in com.threerings.whirled.client
+  +

+ + + + + + + + + + + + + + + + + + + + + +
Methods in com.threerings.whirled.client with parameters of type SceneUpdate
+ voidSceneService.SceneMoveListener.moveSucceededWithUpdates(int placeId, + com.threerings.crowd.data.PlaceConfig config, + SceneUpdate[] updates) + +
+          Indicates that a move succeeded and that the client's cached scene information should be + updated with the supplied data.
+ voidSceneMoveAdapter.moveSucceededWithUpdates(int placeId, + com.threerings.crowd.data.PlaceConfig config, + SceneUpdate[] updates) + +
+           
+ voidSceneDirector.moveSucceededWithUpdates(int placeId, + com.threerings.crowd.data.PlaceConfig config, + SceneUpdate[] updates) + +
+           
+ voidSceneDirector.updateReceived(SceneUpdate update) + +
+          Called by SceneController instances to tell us about an update to the current scene.
+  +

+ + + + + +
+Uses of SceneUpdate in com.threerings.whirled.data
+  +

+ + + + + + + + + + + + + + + + + +
Methods in com.threerings.whirled.data with parameters of type SceneUpdate
+ voidSceneMarshaller.SceneMoveMarshaller.moveSucceededWithUpdates(int arg1, + com.threerings.crowd.data.PlaceConfig arg2, + SceneUpdate[] arg3) + +
+           
+ voidSceneImpl.updateReceived(SceneUpdate update) + +
+           
+ voidScene.updateReceived(SceneUpdate update) + +
+          Called to inform the scene that an update has been received while + the scene was resolved and active.
+  +

+ + + + + +
+Uses of SceneUpdate in com.threerings.whirled.server
+  +

+ + + + + + + + + +
Methods in com.threerings.whirled.server that return SceneUpdate
+ SceneUpdate[]SceneManager.getUpdates(int fromVersion) + +
+          Returns UpdateList.getUpdates(int) for this scene's updates.
+  +

+ + + + + +
+Uses of SceneUpdate in com.threerings.whirled.server.persist
+  +

+ + + + + + + + + +
Methods in com.threerings.whirled.server.persist that return SceneUpdate
+ SceneUpdateSceneUpdateMarshaller.decodeUpdate(int sceneId, + int sceneVersion, + int updateType, + byte[] data) + +
+          Instantiates the appropriate update class and decodes the update from the data.
+  +

+ + + + + + + + + + + + + + + + + + + + + +
Methods in com.threerings.whirled.server.persist with parameters of type SceneUpdate
+ voidSceneRepository.applyAndRecordUpdate(SceneModel model, + SceneUpdate update) + +
+          Applise the supplied scene update to persistent representation of its associated scene, then + stores the update persistently for future invocations of the server to load.
+ voidDummySceneRepository.applyAndRecordUpdate(SceneModel model, + SceneUpdate update) + +
+           
+ intSceneUpdateMarshaller.getUpdateType(SceneUpdate update) + +
+          Returns the type code that is assigned to the specified SceneUpdate instance, or -1.
+ byte[]SceneUpdateMarshaller.persistUpdate(SceneUpdate update) + +
+          Persists the specified update to a new ByteArrayOutInputStream.
+  +

+ + + + + +
+Uses of SceneUpdate in com.threerings.whirled.spot.data
+  +

+ + + + + + + + + +
Subclasses of SceneUpdate in com.threerings.whirled.spot.data
+ classModifyPortalsUpdate + +
+          A scene update to add/remove portals.
+  +

+ + + + + + + + + +
Methods in com.threerings.whirled.spot.data with parameters of type SceneUpdate
+ voidSpotMarshaller.SpotSceneMoveMarshaller.moveSucceededWithUpdates(int arg1, + com.threerings.crowd.data.PlaceConfig arg2, + SceneUpdate[] arg3) + +
+           
+  +

+ + + + + +
+Uses of SceneUpdate in com.threerings.whirled.util
+  +

+ + + + + + + + + +
Methods in com.threerings.whirled.util that return SceneUpdate
+ SceneUpdate[]UpdateList.getUpdates(int fromVersion) + +
+          Returns all of the updates that should be applied to a scene with the specified version to + bring it up to date.
+  +

+ + + + + + + + + +
Methods in com.threerings.whirled.util with parameters of type SceneUpdate
+ voidUpdateList.addUpdate(SceneUpdate update) + +
+          Adds an update to this list.
+  +

+ + + + + +
+Uses of SceneUpdate in com.threerings.whirled.zone.client
+  +

+ + + + + + + + + + + + + +
Methods in com.threerings.whirled.zone.client with parameters of type SceneUpdate
+ voidZoneService.ZoneMoveListener.moveSucceededWithUpdates(int placeId, + com.threerings.crowd.data.PlaceConfig config, + ZoneSummary summary, + SceneUpdate[] updates) + +
+          Called in response to a successful ZoneService.moveTo(int, int, int, com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener) request when our cached + scene was out of date and the server determined that we needed some updates.
+ voidZoneDirector.moveSucceededWithUpdates(int placeId, + com.threerings.crowd.data.PlaceConfig config, + ZoneSummary summary, + SceneUpdate[] updates) + +
+           
+  +

+ + + + + +
+Uses of SceneUpdate in com.threerings.whirled.zone.data
+  +

+ + + + + + + + + +
Methods in com.threerings.whirled.zone.data with parameters of type SceneUpdate
+ voidZoneMarshaller.ZoneMoveMarshaller.moveSucceededWithUpdates(int arg1, + com.threerings.crowd.data.PlaceConfig arg2, + ZoneSummary arg3, + SceneUpdate[] arg4) + +
+           
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/data/package-frame.html b/apidocs/com/threerings/whirled/data/package-frame.html new file mode 100644 index 00000000..a519dc16 --- /dev/null +++ b/apidocs/com/threerings/whirled/data/package-frame.html @@ -0,0 +1,62 @@ + + + + + + + +com.threerings.whirled.data (vilya 1.3 API) + + + + + + + + + + + +com.threerings.whirled.data + + + + +
+Interfaces  + +
+AuxModel +
+Scene +
+SceneCodes
+ + + + + + +
+Classes  + +
+DefaultSceneConfig +
+SceneImpl +
+SceneMarshaller +
+SceneMarshaller.SceneMoveMarshaller +
+SceneModel +
+SceneObject +
+ScenePlace +
+SceneUpdate
+ + + + diff --git a/apidocs/com/threerings/whirled/data/package-summary.html b/apidocs/com/threerings/whirled/data/package-summary.html new file mode 100644 index 00000000..d342942c --- /dev/null +++ b/apidocs/com/threerings/whirled/data/package-summary.html @@ -0,0 +1,213 @@ + + + + + + + +com.threerings.whirled.data (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.whirled.data +

+ + + + + + + + + + + + + + + + + +
+Interface Summary
AuxModelAn interface that must be implemented by auxiliary scene models.
SceneThis interface makes available basic scene information.
SceneCodesContains codes used by the scene invocation services.
+  + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Class Summary
DefaultSceneConfigThe default scene config simply causes the default scene manager and + controller to be created.
SceneImplAn implementation of the Scene interface.
SceneMarshallerProvides the implementation of the SceneService interface + that marshalls the arguments and delivers the request to the provider + on the server.
SceneMarshaller.SceneMoveMarshallerMarshalls results to implementations of SceneService.SceneMoveListener.
SceneModelThe scene model is the bare bones representation of the data for a + scene in the Whirled system.
SceneObject 
ScenePlaceExtends Place with scene information.
SceneUpdateUsed to encapsulate updates to scenes in such a manner that updates can be stored persistently + and sent to clients to update their own local copies of scenes.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/data/package-tree.html b/apidocs/com/threerings/whirled/data/package-tree.html new file mode 100644 index 00000000..aba10bb9 --- /dev/null +++ b/apidocs/com/threerings/whirled/data/package-tree.html @@ -0,0 +1,193 @@ + + + + + + + +com.threerings.whirled.data Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.whirled.data +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/data/package-use.html b/apidocs/com/threerings/whirled/data/package-use.html new file mode 100644 index 00000000..ab573e70 --- /dev/null +++ b/apidocs/com/threerings/whirled/data/package-use.html @@ -0,0 +1,602 @@ + + + + + + + +Uses of Package com.threerings.whirled.data (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.whirled.data

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Packages that use com.threerings.whirled.data
com.threerings.stage.client  
com.threerings.stage.data  
com.threerings.stage.server  
com.threerings.whirled.client  
com.threerings.whirled.client.persist  
com.threerings.whirled.data  
com.threerings.whirled.server  
com.threerings.whirled.server.persist  
com.threerings.whirled.spot.client  
com.threerings.whirled.spot.data  
com.threerings.whirled.spot.server  
com.threerings.whirled.tools.xml  
com.threerings.whirled.util  
com.threerings.whirled.zone.client  
com.threerings.whirled.zone.data  
+  +

+ + + + + + + + +
+Classes in com.threerings.whirled.data used by com.threerings.stage.client
SceneUpdate + +
+          Used to encapsulate updates to scenes in such a manner that updates can be stored persistently + and sent to clients to update their own local copies of scenes.
+  +

+ + + + + + + + + + + + + + + + + + + + + + + +
+Classes in com.threerings.whirled.data used by com.threerings.stage.data
AuxModel + +
+          An interface that must be implemented by auxiliary scene models.
Scene + +
+          This interface makes available basic scene information.
SceneImpl + +
+          An implementation of the Scene interface.
SceneModel + +
+          The scene model is the bare bones representation of the data for a + scene in the Whirled system.
SceneObject + +
+           
SceneUpdate + +
+          Used to encapsulate updates to scenes in such a manner that updates can be stored persistently + and sent to clients to update their own local copies of scenes.
+  +

+ + + + + + + + +
+Classes in com.threerings.whirled.data used by com.threerings.stage.server
SceneCodes + +
+          Contains codes used by the scene invocation services.
+  +

+ + + + + + + + + + + + + + + + + +
+Classes in com.threerings.whirled.data used by com.threerings.whirled.client
Scene + +
+          This interface makes available basic scene information.
SceneCodes + +
+          Contains codes used by the scene invocation services.
SceneModel + +
+          The scene model is the bare bones representation of the data for a + scene in the Whirled system.
SceneUpdate + +
+          Used to encapsulate updates to scenes in such a manner that updates can be stored persistently + and sent to clients to update their own local copies of scenes.
+  +

+ + + + + + + + +
+Classes in com.threerings.whirled.data used by com.threerings.whirled.client.persist
SceneModel + +
+          The scene model is the bare bones representation of the data for a + scene in the Whirled system.
+  +

+ + + + + + + + + + + + + + + + + +
+Classes in com.threerings.whirled.data used by com.threerings.whirled.data
AuxModel + +
+          An interface that must be implemented by auxiliary scene models.
Scene + +
+          This interface makes available basic scene information.
SceneModel + +
+          The scene model is the bare bones representation of the data for a + scene in the Whirled system.
SceneUpdate + +
+          Used to encapsulate updates to scenes in such a manner that updates can be stored persistently + and sent to clients to update their own local copies of scenes.
+  +

+ + + + + + + + + + + + + + + + + +
+Classes in com.threerings.whirled.data used by com.threerings.whirled.server
Scene + +
+          This interface makes available basic scene information.
SceneCodes + +
+          Contains codes used by the scene invocation services.
SceneModel + +
+          The scene model is the bare bones representation of the data for a + scene in the Whirled system.
SceneUpdate + +
+          Used to encapsulate updates to scenes in such a manner that updates can be stored persistently + and sent to clients to update their own local copies of scenes.
+  +

+ + + + + + + + + + + +
+Classes in com.threerings.whirled.data used by com.threerings.whirled.server.persist
SceneModel + +
+          The scene model is the bare bones representation of the data for a + scene in the Whirled system.
SceneUpdate + +
+          Used to encapsulate updates to scenes in such a manner that updates can be stored persistently + and sent to clients to update their own local copies of scenes.
+  +

+ + + + + + + + +
+Classes in com.threerings.whirled.data used by com.threerings.whirled.spot.client
SceneCodes + +
+          Contains codes used by the scene invocation services.
+  +

+ + + + + + + + + + + + + + + + + + + + +
+Classes in com.threerings.whirled.data used by com.threerings.whirled.spot.data
AuxModel + +
+          An interface that must be implemented by auxiliary scene models.
SceneCodes + +
+          Contains codes used by the scene invocation services.
SceneModel + +
+          The scene model is the bare bones representation of the data for a + scene in the Whirled system.
SceneObject + +
+           
SceneUpdate + +
+          Used to encapsulate updates to scenes in such a manner that updates can be stored persistently + and sent to clients to update their own local copies of scenes.
+  +

+ + + + + + + + +
+Classes in com.threerings.whirled.data used by com.threerings.whirled.spot.server
SceneCodes + +
+          Contains codes used by the scene invocation services.
+  +

+ + + + + + + + +
+Classes in com.threerings.whirled.data used by com.threerings.whirled.tools.xml
SceneModel + +
+          The scene model is the bare bones representation of the data for a + scene in the Whirled system.
+  +

+ + + + + + + + + + + + + + +
+Classes in com.threerings.whirled.data used by com.threerings.whirled.util
Scene + +
+          This interface makes available basic scene information.
SceneModel + +
+          The scene model is the bare bones representation of the data for a + scene in the Whirled system.
SceneUpdate + +
+          Used to encapsulate updates to scenes in such a manner that updates can be stored persistently + and sent to clients to update their own local copies of scenes.
+  +

+ + + + + + + + + + + +
+Classes in com.threerings.whirled.data used by com.threerings.whirled.zone.client
SceneModel + +
+          The scene model is the bare bones representation of the data for a + scene in the Whirled system.
SceneUpdate + +
+          Used to encapsulate updates to scenes in such a manner that updates can be stored persistently + and sent to clients to update their own local copies of scenes.
+  +

+ + + + + + + + + + + + + + +
+Classes in com.threerings.whirled.data used by com.threerings.whirled.zone.data
SceneCodes + +
+          Contains codes used by the scene invocation services.
SceneModel + +
+          The scene model is the bare bones representation of the data for a + scene in the Whirled system.
SceneUpdate + +
+          Used to encapsulate updates to scenes in such a manner that updates can be stored persistently + and sent to clients to update their own local copies of scenes.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/package-frame.html b/apidocs/com/threerings/whirled/package-frame.html new file mode 100644 index 00000000..bec22df6 --- /dev/null +++ b/apidocs/com/threerings/whirled/package-frame.html @@ -0,0 +1,33 @@ + + + + + + + +com.threerings.whirled (vilya 1.3 API) + + + + + + + + + + + +com.threerings.whirled + + + + +
+Classes  + +
+Log
+ + + + diff --git a/apidocs/com/threerings/whirled/package-summary.html b/apidocs/com/threerings/whirled/package-summary.html new file mode 100644 index 00000000..4df5726a --- /dev/null +++ b/apidocs/com/threerings/whirled/package-summary.html @@ -0,0 +1,158 @@ + + + + + + + +com.threerings.whirled (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.whirled +

+ + + + + + + + + +
+Class Summary
LogContains a reference to the log object used by the Whirled services.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/package-tree.html b/apidocs/com/threerings/whirled/package-tree.html new file mode 100644 index 00000000..51a595aa --- /dev/null +++ b/apidocs/com/threerings/whirled/package-tree.html @@ -0,0 +1,154 @@ + + + + + + + +com.threerings.whirled Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.whirled +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/package-use.html b/apidocs/com/threerings/whirled/package-use.html new file mode 100644 index 00000000..2cc0a96d --- /dev/null +++ b/apidocs/com/threerings/whirled/package-use.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Package com.threerings.whirled (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.whirled

+
+No usage of com.threerings.whirled +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/server/AbstractSceneMoveHandler.html b/apidocs/com/threerings/whirled/server/AbstractSceneMoveHandler.html new file mode 100644 index 00000000..e4ea5364 --- /dev/null +++ b/apidocs/com/threerings/whirled/server/AbstractSceneMoveHandler.html @@ -0,0 +1,304 @@ + + + + + + + +AbstractSceneMoveHandler (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.server +
+Class AbstractSceneMoveHandler

+
+java.lang.Object
+  extended by com.threerings.whirled.server.AbstractSceneMoveHandler
+
+
+
All Implemented Interfaces:
SceneRegistry.ResolutionListener
+
+
+
Direct Known Subclasses:
SceneMoveHandler, ZoneMoveHandler
+
+
+
+
public abstract class AbstractSceneMoveHandler
extends Object
implements SceneRegistry.ResolutionListener
+ + +

+Handles the basics of moving a client into a new scene, which may involve resolution. Takes care + of annoying edge cases like the client logging off before their target scene is resolved and can + be extended to handle extra fun stuff. +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
AbstractSceneMoveHandler(com.threerings.crowd.server.LocationManager locman, + com.threerings.crowd.data.BodyObject body, + com.threerings.presents.client.InvocationService.InvocationListener listener) + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ voidsceneFailedToResolve(int sceneId, + Exception reason) + +
+          Called if some failure occurred in the scene resolution process.
+ voidsceneWasResolved(SceneManager scmgr) + +
+          Called when the scene has been successfully resolved.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+AbstractSceneMoveHandler

+
+public AbstractSceneMoveHandler(com.threerings.crowd.server.LocationManager locman,
+                                com.threerings.crowd.data.BodyObject body,
+                                com.threerings.presents.client.InvocationService.InvocationListener listener)
+
+
+ + + + + + + + +
+Method Detail
+ +

+sceneWasResolved

+
+public void sceneWasResolved(SceneManager scmgr)
+
+
Description copied from interface: SceneRegistry.ResolutionListener
+
Called when the scene has been successfully resolved. The scene manager instance + provided can be used to obtain a reference to the scene, or the scene distributed + object. +

+

+
Specified by:
sceneWasResolved in interface SceneRegistry.ResolutionListener
+
+
+
+
+
+
+ +

+sceneFailedToResolve

+
+public void sceneFailedToResolve(int sceneId,
+                                 Exception reason)
+
+
Description copied from interface: SceneRegistry.ResolutionListener
+
Called if some failure occurred in the scene resolution process. +

+

+
Specified by:
sceneFailedToResolve in interface SceneRegistry.ResolutionListener
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/server/SceneManager.html b/apidocs/com/threerings/whirled/server/SceneManager.html new file mode 100644 index 00000000..18f61ff2 --- /dev/null +++ b/apidocs/com/threerings/whirled/server/SceneManager.html @@ -0,0 +1,386 @@ + + + + + + + +SceneManager (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.server +
+Class SceneManager

+
+java.lang.Object
+  extended by com.threerings.crowd.server.PlaceManager
+      extended by com.threerings.whirled.server.SceneManager
+
+
+
All Implemented Interfaces:
com.threerings.crowd.chat.server.SpeakHandler.SpeakerValidator, com.threerings.presents.dobj.ChangeListener, com.threerings.presents.dobj.MessageListener
+
+
+
Direct Known Subclasses:
SpotSceneManager
+
+
+
+
public class SceneManager
extends com.threerings.crowd.server.PlaceManager
+ + +

+The scene manager extends the place manager and takes care of basic scene services. Presently + that is little more than registering the scene manager with the scene registry so that the + manager can be looked up by scene id in addition to place object id. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.crowd.server.PlaceManager
com.threerings.crowd.server.PlaceManager.DelegateOp, com.threerings.crowd.server.PlaceManager.MessageHandler
+  + + + + + + + + + + + +
+Constructor Summary
SceneManager() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ com.threerings.crowd.data.PlacegetLocation() + +
+           
+ ScenegetScene() + +
+          Returns the scene object (not the scene distributed object) being managed by this scene + manager.
+ SceneUpdate[]getUpdates(int fromVersion) + +
+          Returns UpdateList.getUpdates(int) for this scene's updates.
+ booleanisPersistent() + +
+          Returns true if this scene stores data in the database, or false if it's instantiated anew + with each server restart
+ Stringwhere() + +
+           
+  + + + + + + + +
Methods inherited from class com.threerings.crowd.server.PlaceManager
addDelegate, applyToDelegates, applyToOccupants, bodyWillEnter, bodyWillLeave, checkPermissions, getConfig, getPlaceObject, init, isValidSpeaker, messageReceived, ratifyBodyEntry, registerMessageHandler, shutdown, startup, toString, updateOccupantInfo
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+SceneManager

+
+public SceneManager()
+
+
+ + + + + + + + +
+Method Detail
+ +

+getScene

+
+public Scene getScene()
+
+
Returns the scene object (not the scene distributed object) being managed by this scene + manager. +

+

+
+
+
+
+ +

+getUpdates

+
+public SceneUpdate[] getUpdates(int fromVersion)
+
+
Returns UpdateList.getUpdates(int) for this scene's updates. +

+

+
+
+
+
+ +

+getLocation

+
+public com.threerings.crowd.data.Place getLocation()
+
+
+
Overrides:
getLocation in class com.threerings.crowd.server.PlaceManager
+
+
+
+
+
+
+ +

+isPersistent

+
+public boolean isPersistent()
+
+
Returns true if this scene stores data in the database, or false if it's instantiated anew + with each server restart +

+

+
+
+
+
+ +

+where

+
+public String where()
+
+
+
Overrides:
where in class com.threerings.crowd.server.PlaceManager
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/server/SceneMoveHandler.html b/apidocs/com/threerings/whirled/server/SceneMoveHandler.html new file mode 100644 index 00000000..1d8ebfff --- /dev/null +++ b/apidocs/com/threerings/whirled/server/SceneMoveHandler.html @@ -0,0 +1,251 @@ + + + + + + + +SceneMoveHandler (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.server +
+Class SceneMoveHandler

+
+java.lang.Object
+  extended by com.threerings.whirled.server.AbstractSceneMoveHandler
+      extended by com.threerings.whirled.server.SceneMoveHandler
+
+
+
All Implemented Interfaces:
SceneRegistry.ResolutionListener
+
+
+
Direct Known Subclasses:
SpotSceneMoveHandler
+
+
+
+
public class SceneMoveHandler
extends AbstractSceneMoveHandler
+ + +

+Handles a simple scene to scene move. +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
SceneMoveHandler(com.threerings.crowd.server.LocationManager locman, + com.threerings.crowd.data.BodyObject body, + int sceneVer, + SceneService.SceneMoveListener listener) + +
+           
+  + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from class com.threerings.whirled.server.AbstractSceneMoveHandler
sceneFailedToResolve, sceneWasResolved
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+SceneMoveHandler

+
+public SceneMoveHandler(com.threerings.crowd.server.LocationManager locman,
+                        com.threerings.crowd.data.BodyObject body,
+                        int sceneVer,
+                        SceneService.SceneMoveListener listener)
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/server/SceneProvider.html b/apidocs/com/threerings/whirled/server/SceneProvider.html new file mode 100644 index 00000000..47e465f1 --- /dev/null +++ b/apidocs/com/threerings/whirled/server/SceneProvider.html @@ -0,0 +1,233 @@ + + + + + + + +SceneProvider (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.server +
+Interface SceneProvider

+
+
All Superinterfaces:
com.threerings.presents.server.InvocationProvider
+
+
+
All Known Implementing Classes:
SceneRegistry, SpotSceneRegistry
+
+
+
+
@Generated(value="com.threerings.presents.tools.GenServiceTask",
+           comments="Derived from SceneService.java.")
+public interface SceneProvider
extends com.threerings.presents.server.InvocationProvider
+ + +

+Defines the server-side of the SceneService. +

+ +

+

+ +

+ + + + + + + + + + + + +
+Method Summary
+ voidmoveTo(com.threerings.presents.data.ClientObject caller, + int arg1, + int arg2, + SceneService.SceneMoveListener arg3) + +
+          Handles a SceneService.moveTo(int, int, com.threerings.whirled.client.SceneService.SceneMoveListener) request.
+  +

+ + + + + + + + +
+Method Detail
+ +

+moveTo

+
+void moveTo(com.threerings.presents.data.ClientObject caller,
+            int arg1,
+            int arg2,
+            SceneService.SceneMoveListener arg3)
+            throws com.threerings.presents.server.InvocationException
+
+
Handles a SceneService.moveTo(int, int, com.threerings.whirled.client.SceneService.SceneMoveListener) request. +

+

+
+
+
+ +
Throws: +
com.threerings.presents.server.InvocationException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/server/SceneRegistry.ConfigFactory.html b/apidocs/com/threerings/whirled/server/SceneRegistry.ConfigFactory.html new file mode 100644 index 00000000..bc4015e9 --- /dev/null +++ b/apidocs/com/threerings/whirled/server/SceneRegistry.ConfigFactory.html @@ -0,0 +1,216 @@ + + + + + + + +SceneRegistry.ConfigFactory (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.server +
+Interface SceneRegistry.ConfigFactory

+
+
Enclosing class:
SceneRegistry
+
+
+
+
public static interface SceneRegistry.ConfigFactory
+ + +

+Used to create PlaceConfig instances for scenes. +

+ +

+

+ +

+ + + + + + + + + + + + +
+Method Summary
+ com.threerings.crowd.data.PlaceConfigcreatePlaceConfig(SceneModel model) + +
+          Creates the place config instance appropriate to the specified scene.
+  +

+ + + + + + + + +
+Method Detail
+ +

+createPlaceConfig

+
+com.threerings.crowd.data.PlaceConfig createPlaceConfig(SceneModel model)
+
+
Creates the place config instance appropriate to the specified scene. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/server/SceneRegistry.ResolutionListener.html b/apidocs/com/threerings/whirled/server/SceneRegistry.ResolutionListener.html new file mode 100644 index 00000000..85df8fe4 --- /dev/null +++ b/apidocs/com/threerings/whirled/server/SceneRegistry.ResolutionListener.html @@ -0,0 +1,247 @@ + + + + + + + +SceneRegistry.ResolutionListener (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.server +
+Interface SceneRegistry.ResolutionListener

+
+
All Known Implementing Classes:
AbstractSceneMoveHandler, PeeredZoneRegistry.PeerZoneMoveHandler, SceneMoveHandler, SpotSceneMoveHandler, ZoneMoveHandler
+
+
+
Enclosing class:
SceneRegistry
+
+
+
+
public static interface SceneRegistry.ResolutionListener
+ + +

+Because scenes must be loaded from the scene repository and this must not be done on the + dobjmgr thread, the interface for resolving scenes requires that the entity that wishes for + a scene to be resolved implement this callback interface so that it can be notified when a + scene has been loaded and initialized. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + +
+Method Summary
+ voidsceneFailedToResolve(int sceneId, + Exception reason) + +
+          Called if some failure occurred in the scene resolution process.
+ voidsceneWasResolved(SceneManager scmgr) + +
+          Called when the scene has been successfully resolved.
+  +

+ + + + + + + + +
+Method Detail
+ +

+sceneWasResolved

+
+void sceneWasResolved(SceneManager scmgr)
+
+
Called when the scene has been successfully resolved. The scene manager instance + provided can be used to obtain a reference to the scene, or the scene distributed + object. +

+

+
+
+
+
+ +

+sceneFailedToResolve

+
+void sceneFailedToResolve(int sceneId,
+                          Exception reason)
+
+
Called if some failure occurred in the scene resolution process. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/server/SceneRegistry.html b/apidocs/com/threerings/whirled/server/SceneRegistry.html new file mode 100644 index 00000000..2f6e469e --- /dev/null +++ b/apidocs/com/threerings/whirled/server/SceneRegistry.html @@ -0,0 +1,511 @@ + + + + + + + +SceneRegistry (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.server +
+Class SceneRegistry

+
+java.lang.Object
+  extended by com.threerings.whirled.server.SceneRegistry
+
+
+
All Implemented Interfaces:
com.threerings.crowd.data.LocationCodes, com.threerings.presents.data.InvocationCodes, com.threerings.presents.server.InvocationProvider, SceneCodes, SceneProvider
+
+
+
Direct Known Subclasses:
SpotSceneRegistry
+
+
+
+
public class SceneRegistry
extends Object
implements SceneCodes, SceneProvider
+ + +

+The scene registry is responsible for the management of all scenes. It handles interaction with + the scene repository and ensures that scenes are loaded into memory when needed and flushed from + memory when not needed. + +

The scene repository also takes care of bridging from the blocking, synchronous world of the + scene repository to the non-blocking asynchronous world of the distributed object event + queue. Thus its interfaces for accessing scenes are structured so as to not block the dobjmgr + thread while waiting for scenes to be read from or written to the repository. + +

Note: All access to the scene registry should take place from the dobjmgr thread. +

+ +

+

+ +

+ + + + + + + + + + + + + + + +
+Nested Class Summary
+static interfaceSceneRegistry.ConfigFactory + +
+          Used to create PlaceConfig instances for scenes.
+static interfaceSceneRegistry.ResolutionListener + +
+          Because scenes must be loaded from the scene repository and this must not be done on the + dobjmgr thread, the interface for resolving scenes requires that the entity that wishes for + a scene to be resolved implement this callback interface so that it can be notified when a + scene has been loaded and initialized.
+  + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from interface com.threerings.whirled.data.SceneCodes
SCENE_UPDATE, WHIRLED_GROUP
+  + + + + + + + +
Fields inherited from interface com.threerings.crowd.data.LocationCodes
ALREADY_THERE, MOVE_IN_PROGRESS, NO_SUCH_PLACE
+  + + + + + + + +
Fields inherited from interface com.threerings.presents.data.InvocationCodes
ACCESS_DENIED, E_ACCESS_DENIED, E_INTERNAL_ERROR, GLOBAL_GROUP, INTERNAL_ERROR
+  + + + + + + + + + + +
+Constructor Summary
SceneRegistry(com.threerings.presents.server.InvocationManager invmgr) + +
+          Constructs a scene registry.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ SceneManagergetSceneManager(int sceneId) + +
+          Fetches the scene manager associated with the specified scene.
+ SceneRepositorygetSceneRepository() + +
+          Returns a reference to the scene repository in use by this registry.
+ voidleaveOccupiedScene(com.threerings.crowd.data.BodyObject source) + +
+          Ejects the specified body from their current scene and zone.
+ voidmoveBody(com.threerings.crowd.data.BodyObject source, + int sceneId) + +
+          Ejects the specified body from their current scene and sends them a request to move to the + specified new scene.
+ voidmoveTo(com.threerings.presents.data.ClientObject caller, + int sceneId, + int sceneVer, + SceneService.SceneMoveListener listener) + +
+          Handles a SceneService.moveTo(int, int, com.threerings.whirled.client.SceneService.SceneMoveListener) request.
+ voidresolveScene(int sceneId, + SceneRegistry.ResolutionListener target) + +
+          Requests that the specified scene be resolved, which means loaded into the server and + initialized if the scene is not currently active.
+ Stringwhere(int sceneId) + +
+          Returns SceneManager.where() for the specified scene or null:sceneId if + no scene manager exists for that scene.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+SceneRegistry

+
+@Inject
+public SceneRegistry(com.threerings.presents.server.InvocationManager invmgr)
+
+
Constructs a scene registry. +

+

+ + + + + + + + +
+Method Detail
+ +

+getSceneManager

+
+public SceneManager getSceneManager(int sceneId)
+
+
Fetches the scene manager associated with the specified scene. +

+

+
+
+
+ +
Returns:
the scene manager for the specified scene or null if no scene manager is loaded for + that scene.
+
+
+
+ +

+getSceneRepository

+
+public SceneRepository getSceneRepository()
+
+
Returns a reference to the scene repository in use by this registry. +

+

+
+
+
+
+
+
+
+ +

+where

+
+public String where(int sceneId)
+
+
Returns SceneManager.where() for the specified scene or null:sceneId if + no scene manager exists for that scene. +

+

+
+
+
+
+
+
+
+ +

+resolveScene

+
+public void resolveScene(int sceneId,
+                         SceneRegistry.ResolutionListener target)
+
+
Requests that the specified scene be resolved, which means loaded into the server and + initialized if the scene is not currently active. The supplied callback instance will be + notified, on the dobjmgr thread, when the scene has been resolved. If the scene is already + active, it will be notified immediately (before the call to resolveScene(int, com.threerings.whirled.server.SceneRegistry.ResolutionListener) returns). +

+

+
+
+
+
Parameters:
sceneId - the id of the scene to resolve.
target - a reference to a callback instance that will be notified when the scene has + been resolved (which may be immediately if the scene is already active).
+
+
+
+ +

+moveTo

+
+public void moveTo(com.threerings.presents.data.ClientObject caller,
+                   int sceneId,
+                   int sceneVer,
+                   SceneService.SceneMoveListener listener)
+
+
Description copied from interface: SceneProvider
+
Handles a SceneService.moveTo(int, int, com.threerings.whirled.client.SceneService.SceneMoveListener) request. +

+

+
Specified by:
moveTo in interface SceneProvider
+
+
+
+
+
+
+ +

+moveBody

+
+public void moveBody(com.threerings.crowd.data.BodyObject source,
+                     int sceneId)
+
+
Ejects the specified body from their current scene and sends them a request to move to the + specified new scene. This is the scene-equivalent to LocationProvider.moveTo(com.threerings.presents.data.ClientObject, int, com.threerings.crowd.client.LocationService.MoveListener). +

+

+
+
+
+
+
+
+
+ +

+leaveOccupiedScene

+
+public void leaveOccupiedScene(com.threerings.crowd.data.BodyObject source)
+
+
Ejects the specified body from their current scene and zone. This is the zone equivalent to + LocationProvider.leavePlace(com.threerings.presents.data.ClientObject). +

+

+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/server/SceneSender.html b/apidocs/com/threerings/whirled/server/SceneSender.html new file mode 100644 index 00000000..8c16b7ec --- /dev/null +++ b/apidocs/com/threerings/whirled/server/SceneSender.html @@ -0,0 +1,272 @@ + + + + + + + +SceneSender (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.server +
+Class SceneSender

+
+java.lang.Object
+  extended by com.threerings.presents.server.InvocationSender
+      extended by com.threerings.whirled.server.SceneSender
+
+
+
+
public class SceneSender
extends com.threerings.presents.server.InvocationSender
+ + +

+Used to issue notifications to a SceneReceiver instance on a + client. +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
SceneSender() + +
+           
+  + + + + + + + + + + + +
+Method Summary
+static voidforcedMove(com.threerings.presents.data.ClientObject target, + int arg1) + +
+          Issues a notification that will result in a call to SceneReceiver.forcedMove(int) on a client.
+  + + + + + + + +
Methods inherited from class com.threerings.presents.server.InvocationSender
sendNotification, sendNotification
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+SceneSender

+
+public SceneSender()
+
+
+ + + + + + + + +
+Method Detail
+ +

+forcedMove

+
+public static void forcedMove(com.threerings.presents.data.ClientObject target,
+                              int arg1)
+
+
Issues a notification that will result in a call to SceneReceiver.forcedMove(int) on a client. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/server/WhirledServer.WhirledModule.html b/apidocs/com/threerings/whirled/server/WhirledServer.WhirledModule.html new file mode 100644 index 00000000..5870796d --- /dev/null +++ b/apidocs/com/threerings/whirled/server/WhirledServer.WhirledModule.html @@ -0,0 +1,250 @@ + + + + + + + +WhirledServer.WhirledModule (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.server +
+Class WhirledServer.WhirledModule

+
+java.lang.Object
+  extended by com.google.inject.AbstractModule
+      extended by com.threerings.presents.server.PresentsServer.PresentsModule
+          extended by com.threerings.crowd.server.CrowdServer.CrowdModule
+              extended by com.threerings.whirled.server.WhirledServer.WhirledModule
+
+
+
All Implemented Interfaces:
com.google.inject.Module
+
+
+
Direct Known Subclasses:
StageServer.StageModule
+
+
+
Enclosing class:
WhirledServer
+
+
+
+
public static class WhirledServer.WhirledModule
extends com.threerings.crowd.server.CrowdServer.CrowdModule
+ + +

+Configures dependencies needed by the Whirled server. +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
WhirledServer.WhirledModule() + +
+           
+  + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from class com.google.inject.AbstractModule
configure
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+WhirledServer.WhirledModule

+
+public WhirledServer.WhirledModule()
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/server/WhirledServer.html b/apidocs/com/threerings/whirled/server/WhirledServer.html new file mode 100644 index 00000000..e2c1afb6 --- /dev/null +++ b/apidocs/com/threerings/whirled/server/WhirledServer.html @@ -0,0 +1,342 @@ + + + + + + + +WhirledServer (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.server +
+Class WhirledServer

+
+java.lang.Object
+  extended by com.threerings.presents.server.PresentsServer
+      extended by com.threerings.crowd.server.CrowdServer
+          extended by com.threerings.whirled.server.WhirledServer
+
+
+
Direct Known Subclasses:
StageServer
+
+
+
+
public abstract class WhirledServer
extends com.threerings.crowd.server.CrowdServer
+ + +

+The Whirled server extends the CrowdServer and provides access to managers and the like + that are needed by the Whirled serviecs. +

+ +

+

+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static classWhirledServer.WhirledModule + +
+          Configures dependencies needed by the Whirled server.
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.crowd.server.CrowdServer
com.threerings.crowd.server.CrowdServer.CrowdModule
+  + + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.presents.server.PresentsServer
com.threerings.presents.server.PresentsServer.PresentsModule, com.threerings.presents.server.PresentsServer.PresentsServerModule
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class com.threerings.presents.server.PresentsServer
invmgr, omgr
+  + + + + + + + + + + +
+Constructor Summary
WhirledServer() + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ voidinit(com.google.inject.Injector injector) + +
+           
+  + + + + + + + +
Methods inherited from class com.threerings.crowd.server.CrowdServer
main
+  + + + + + + + +
Methods inherited from class com.threerings.presents.server.PresentsServer
queueShutdown, run, runServer
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+WhirledServer

+
+public WhirledServer()
+
+
+ + + + + + + + +
+Method Detail
+ +

+init

+
+public void init(com.google.inject.Injector injector)
+          throws Exception
+
+
+
Overrides:
init in class com.threerings.crowd.server.CrowdServer
+
+
+ +
Throws: +
Exception
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/server/WhirledSession.html b/apidocs/com/threerings/whirled/server/WhirledSession.html new file mode 100644 index 00000000..18f39e93 --- /dev/null +++ b/apidocs/com/threerings/whirled/server/WhirledSession.html @@ -0,0 +1,265 @@ + + + + + + + +WhirledSession (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.server +
+Class WhirledSession

+
+java.lang.Object
+  extended by com.threerings.presents.server.PresentsSession
+      extended by com.threerings.crowd.server.CrowdSession
+          extended by com.threerings.whirled.server.WhirledSession
+
+
+
All Implemented Interfaces:
com.threerings.presents.server.ClientResolutionListener, com.threerings.presents.server.net.PresentsConnection.MessageHandler
+
+
+
Direct Known Subclasses:
SpotClient
+
+
+
+
public class WhirledSession
extends com.threerings.crowd.server.CrowdSession
+ + +

+The client object used by client management on the Whirled server. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.presents.server.PresentsSession
com.threerings.presents.server.PresentsSession.UserChangeListener
+  + + + + + + + + + + + +
+Constructor Summary
WhirledSession() + +
+           
+  + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from class com.threerings.presents.server.PresentsSession
checkExpired, clientResolved, endSession, getAuthName, getClientObject, getCredentials, getInetAddress, getNetworkStamp, getSecret, getSessionStamp, getTimeZone, getTransmitDatagrams, handleMessage, resolutionFailed, setClassLoader, setIncomingMessageThrottle, setUsername, shutdown, toString, updateUsername
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+WhirledSession

+
+public WhirledSession()
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/server/class-use/AbstractSceneMoveHandler.html b/apidocs/com/threerings/whirled/server/class-use/AbstractSceneMoveHandler.html new file mode 100644 index 00000000..9bd6393d --- /dev/null +++ b/apidocs/com/threerings/whirled/server/class-use/AbstractSceneMoveHandler.html @@ -0,0 +1,268 @@ + + + + + + + +Uses of Class com.threerings.whirled.server.AbstractSceneMoveHandler (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.server.AbstractSceneMoveHandler

+
+ + + + + + + + + + + + + + + + + + + + + +
+Packages that use AbstractSceneMoveHandler
com.threerings.whirled.server  
com.threerings.whirled.spot.server  
com.threerings.whirled.zone.peer.server  
com.threerings.whirled.zone.server  
+  +

+ + + + + +
+Uses of AbstractSceneMoveHandler in com.threerings.whirled.server
+  +

+ + + + + + + + + +
Subclasses of AbstractSceneMoveHandler in com.threerings.whirled.server
+ classSceneMoveHandler + +
+          Handles a simple scene to scene move.
+  +

+ + + + + +
+Uses of AbstractSceneMoveHandler in com.threerings.whirled.spot.server
+  +

+ + + + + + + + + +
Subclasses of AbstractSceneMoveHandler in com.threerings.whirled.spot.server
+ classSpotSceneMoveHandler + +
+          Moves a player between scenes, accounting for their exit and entry via portals.
+  +

+ + + + + +
+Uses of AbstractSceneMoveHandler in com.threerings.whirled.zone.peer.server
+  +

+ + + + + + + + + +
Subclasses of AbstractSceneMoveHandler in com.threerings.whirled.zone.peer.server
+static classPeeredZoneRegistry.PeerZoneMoveHandler + +
+          A ZoneMoveHandler that can receive the sceneOnNode() callback.
+  +

+ + + + + +
+Uses of AbstractSceneMoveHandler in com.threerings.whirled.zone.server
+  +

+ + + + + + + + + +
Subclasses of AbstractSceneMoveHandler in com.threerings.whirled.zone.server
+ classZoneMoveHandler + +
+          Handles transitioning between zones.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/server/class-use/SceneManager.html b/apidocs/com/threerings/whirled/server/class-use/SceneManager.html new file mode 100644 index 00000000..853dc942 --- /dev/null +++ b/apidocs/com/threerings/whirled/server/class-use/SceneManager.html @@ -0,0 +1,265 @@ + + + + + + + +Uses of Class com.threerings.whirled.server.SceneManager (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.server.SceneManager

+
+ + + + + + + + + + + + + + + + + +
+Packages that use SceneManager
com.threerings.stage.server  
com.threerings.whirled.server  
com.threerings.whirled.spot.server  
+  +

+ + + + + +
+Uses of SceneManager in com.threerings.stage.server
+  +

+ + + + + + + + + +
Subclasses of SceneManager in com.threerings.stage.server
+ classStageSceneManager + +
+          Defines extensions to the basic Stage scene manager specific to displaying isometric "stage" + scenes (these may be indoor, outdoor or aboard a vessel).
+  +

+ + + + + +
+Uses of SceneManager in com.threerings.whirled.server
+  +

+ + + + + + + + + +
Methods in com.threerings.whirled.server that return SceneManager
+ SceneManagerSceneRegistry.getSceneManager(int sceneId) + +
+          Fetches the scene manager associated with the specified scene.
+  +

+ + + + + + + + + + + + + +
Methods in com.threerings.whirled.server with parameters of type SceneManager
+ voidSceneRegistry.ResolutionListener.sceneWasResolved(SceneManager scmgr) + +
+          Called when the scene has been successfully resolved.
+ voidAbstractSceneMoveHandler.sceneWasResolved(SceneManager scmgr) + +
+           
+  +

+ + + + + +
+Uses of SceneManager in com.threerings.whirled.spot.server
+  +

+ + + + + + + + + +
Subclasses of SceneManager in com.threerings.whirled.spot.server
+ classSpotSceneManager + +
+          Handles the movement of bodies between locations in the scene and creates the necessary + distributed objects to allow bodies in clusters to chat with one another.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/server/class-use/SceneMoveHandler.html b/apidocs/com/threerings/whirled/server/class-use/SceneMoveHandler.html new file mode 100644 index 00000000..6aa6e979 --- /dev/null +++ b/apidocs/com/threerings/whirled/server/class-use/SceneMoveHandler.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class com.threerings.whirled.server.SceneMoveHandler (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.server.SceneMoveHandler

+
+ + + + + + + + + +
+Packages that use SceneMoveHandler
com.threerings.whirled.spot.server  
+  +

+ + + + + +
+Uses of SceneMoveHandler in com.threerings.whirled.spot.server
+  +

+ + + + + + + + + +
Subclasses of SceneMoveHandler in com.threerings.whirled.spot.server
+ classSpotSceneMoveHandler + +
+          Moves a player between scenes, accounting for their exit and entry via portals.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/server/class-use/SceneProvider.html b/apidocs/com/threerings/whirled/server/class-use/SceneProvider.html new file mode 100644 index 00000000..48d6fb1e --- /dev/null +++ b/apidocs/com/threerings/whirled/server/class-use/SceneProvider.html @@ -0,0 +1,210 @@ + + + + + + + +Uses of Interface com.threerings.whirled.server.SceneProvider (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.whirled.server.SceneProvider

+
+ + + + + + + + + + + + + +
+Packages that use SceneProvider
com.threerings.whirled.server  
com.threerings.whirled.spot.server  
+  +

+ + + + + +
+Uses of SceneProvider in com.threerings.whirled.server
+  +

+ + + + + + + + + +
Classes in com.threerings.whirled.server that implement SceneProvider
+ classSceneRegistry + +
+          The scene registry is responsible for the management of all scenes.
+  +

+ + + + + +
+Uses of SceneProvider in com.threerings.whirled.spot.server
+  +

+ + + + + + + + + +
Classes in com.threerings.whirled.spot.server that implement SceneProvider
+ classSpotSceneRegistry + +
+          Extends the SceneRegistry with spot-related services.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/server/class-use/SceneRegistry.ConfigFactory.html b/apidocs/com/threerings/whirled/server/class-use/SceneRegistry.ConfigFactory.html new file mode 100644 index 00000000..ad00c2ab --- /dev/null +++ b/apidocs/com/threerings/whirled/server/class-use/SceneRegistry.ConfigFactory.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Interface com.threerings.whirled.server.SceneRegistry.ConfigFactory (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.whirled.server.SceneRegistry.ConfigFactory

+
+No usage of com.threerings.whirled.server.SceneRegistry.ConfigFactory +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/server/class-use/SceneRegistry.ResolutionListener.html b/apidocs/com/threerings/whirled/server/class-use/SceneRegistry.ResolutionListener.html new file mode 100644 index 00000000..ade4af65 --- /dev/null +++ b/apidocs/com/threerings/whirled/server/class-use/SceneRegistry.ResolutionListener.html @@ -0,0 +1,294 @@ + + + + + + + +Uses of Interface com.threerings.whirled.server.SceneRegistry.ResolutionListener (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.whirled.server.SceneRegistry.ResolutionListener

+
+ + + + + + + + + + + + + + + + + + + + + +
+Packages that use SceneRegistry.ResolutionListener
com.threerings.whirled.server  
com.threerings.whirled.spot.server  
com.threerings.whirled.zone.peer.server  
com.threerings.whirled.zone.server  
+  +

+ + + + + +
+Uses of SceneRegistry.ResolutionListener in com.threerings.whirled.server
+  +

+ + + + + + + + + + + + + +
Classes in com.threerings.whirled.server that implement SceneRegistry.ResolutionListener
+ classAbstractSceneMoveHandler + +
+          Handles the basics of moving a client into a new scene, which may involve resolution.
+ classSceneMoveHandler + +
+          Handles a simple scene to scene move.
+  +

+ + + + + + + + + +
Methods in com.threerings.whirled.server with parameters of type SceneRegistry.ResolutionListener
+ voidSceneRegistry.resolveScene(int sceneId, + SceneRegistry.ResolutionListener target) + +
+          Requests that the specified scene be resolved, which means loaded into the server and + initialized if the scene is not currently active.
+  +

+ + + + + +
+Uses of SceneRegistry.ResolutionListener in com.threerings.whirled.spot.server
+  +

+ + + + + + + + + +
Classes in com.threerings.whirled.spot.server that implement SceneRegistry.ResolutionListener
+ classSpotSceneMoveHandler + +
+          Moves a player between scenes, accounting for their exit and entry via portals.
+  +

+ + + + + +
+Uses of SceneRegistry.ResolutionListener in com.threerings.whirled.zone.peer.server
+  +

+ + + + + + + + + +
Classes in com.threerings.whirled.zone.peer.server that implement SceneRegistry.ResolutionListener
+static classPeeredZoneRegistry.PeerZoneMoveHandler + +
+          A ZoneMoveHandler that can receive the sceneOnNode() callback.
+  +

+ + + + + +
+Uses of SceneRegistry.ResolutionListener in com.threerings.whirled.zone.server
+  +

+ + + + + + + + + +
Classes in com.threerings.whirled.zone.server that implement SceneRegistry.ResolutionListener
+ classZoneMoveHandler + +
+          Handles transitioning between zones.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/server/class-use/SceneRegistry.html b/apidocs/com/threerings/whirled/server/class-use/SceneRegistry.html new file mode 100644 index 00000000..c4e76b86 --- /dev/null +++ b/apidocs/com/threerings/whirled/server/class-use/SceneRegistry.html @@ -0,0 +1,247 @@ + + + + + + + +Uses of Class com.threerings.whirled.server.SceneRegistry (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.server.SceneRegistry

+
+ + + + + + + + + + + + + + + + + +
+Packages that use SceneRegistry
com.threerings.whirled.spot.server  
com.threerings.whirled.zone.peer.server  
com.threerings.whirled.zone.server  
+  +

+ + + + + +
+Uses of SceneRegistry in com.threerings.whirled.spot.server
+  +

+ + + + + + + + + +
Subclasses of SceneRegistry in com.threerings.whirled.spot.server
+ classSpotSceneRegistry + +
+          Extends the SceneRegistry with spot-related services.
+  +

+ + + + + +
+Uses of SceneRegistry in com.threerings.whirled.zone.peer.server
+  +

+ + + + + + + + +
Constructors in com.threerings.whirled.zone.peer.server with parameters of type SceneRegistry
PeeredZoneRegistry.PeerZoneMoveHandler(com.threerings.crowd.server.LocationManager locman, + ZoneManager zmgr, + SceneRegistry scReg, + com.threerings.crowd.data.BodyObject body, + int sceneId, + int sceneVer, + ZoneService.ZoneMoveListener listener) + +
+           
+  +

+ + + + + +
+Uses of SceneRegistry in com.threerings.whirled.zone.server
+  +

+ + + + + + + + +
Constructors in com.threerings.whirled.zone.server with parameters of type SceneRegistry
ZoneMoveHandler(com.threerings.crowd.server.LocationManager locmgr, + ZoneManager zmgr, + SceneRegistry screg, + com.threerings.crowd.data.BodyObject body, + int sceneId, + int sceneVer, + ZoneService.ZoneMoveListener listener) + +
+           
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/server/class-use/SceneSender.html b/apidocs/com/threerings/whirled/server/class-use/SceneSender.html new file mode 100644 index 00000000..8b209e3d --- /dev/null +++ b/apidocs/com/threerings/whirled/server/class-use/SceneSender.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.whirled.server.SceneSender (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.server.SceneSender

+
+No usage of com.threerings.whirled.server.SceneSender +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/server/class-use/WhirledServer.WhirledModule.html b/apidocs/com/threerings/whirled/server/class-use/WhirledServer.WhirledModule.html new file mode 100644 index 00000000..1cfb1f7c --- /dev/null +++ b/apidocs/com/threerings/whirled/server/class-use/WhirledServer.WhirledModule.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class com.threerings.whirled.server.WhirledServer.WhirledModule (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.server.WhirledServer.WhirledModule

+
+ + + + + + + + + +
+Packages that use WhirledServer.WhirledModule
com.threerings.stage.server  
+  +

+ + + + + +
+Uses of WhirledServer.WhirledModule in com.threerings.stage.server
+  +

+ + + + + + + + + +
Subclasses of WhirledServer.WhirledModule in com.threerings.stage.server
+static classStageServer.StageModule + +
+          Configures dependencies needed by the Stage services.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/server/class-use/WhirledServer.html b/apidocs/com/threerings/whirled/server/class-use/WhirledServer.html new file mode 100644 index 00000000..a1454ac7 --- /dev/null +++ b/apidocs/com/threerings/whirled/server/class-use/WhirledServer.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class com.threerings.whirled.server.WhirledServer (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.server.WhirledServer

+
+ + + + + + + + + +
+Packages that use WhirledServer
com.threerings.stage.server  
+  +

+ + + + + +
+Uses of WhirledServer in com.threerings.stage.server
+  +

+ + + + + + + + + +
Subclasses of WhirledServer in com.threerings.stage.server
+ classStageServer + +
+          Extends the Whirled server to provide services needed by the Stage system.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/server/class-use/WhirledSession.html b/apidocs/com/threerings/whirled/server/class-use/WhirledSession.html new file mode 100644 index 00000000..31e05de7 --- /dev/null +++ b/apidocs/com/threerings/whirled/server/class-use/WhirledSession.html @@ -0,0 +1,183 @@ + + + + + + + +Uses of Class com.threerings.whirled.server.WhirledSession (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.server.WhirledSession

+
+ + + + + + + + + +
+Packages that use WhirledSession
com.threerings.whirled.spot.server  
+  +

+ + + + + +
+Uses of WhirledSession in com.threerings.whirled.spot.server
+  +

+ + + + + + + + + +
Subclasses of WhirledSession in com.threerings.whirled.spot.server
+ classSpotClient + +
+          Extends the Whirled client and handles the necessary notifications that take place when a user + logs off to let the clients displaying the scene they were occupying know that they didn't exit + via a portal, but instead just disappeared.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/server/package-frame.html b/apidocs/com/threerings/whirled/server/package-frame.html new file mode 100644 index 00000000..a349869f --- /dev/null +++ b/apidocs/com/threerings/whirled/server/package-frame.html @@ -0,0 +1,62 @@ + + + + + + + +com.threerings.whirled.server (vilya 1.3 API) + + + + + + + + + + + +com.threerings.whirled.server + + + + +
+Interfaces  + +
+SceneProvider +
+SceneRegistry.ConfigFactory +
+SceneRegistry.ResolutionListener
+ + + + + + +
+Classes  + +
+AbstractSceneMoveHandler +
+SceneManager +
+SceneMoveHandler +
+SceneRegistry +
+SceneSender +
+WhirledServer +
+WhirledServer.WhirledModule +
+WhirledSession
+ + + + diff --git a/apidocs/com/threerings/whirled/server/package-summary.html b/apidocs/com/threerings/whirled/server/package-summary.html new file mode 100644 index 00000000..b712aea0 --- /dev/null +++ b/apidocs/com/threerings/whirled/server/package-summary.html @@ -0,0 +1,213 @@ + + + + + + + +com.threerings.whirled.server (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.whirled.server +

+ + + + + + + + + + + + + + + + + +
+Interface Summary
SceneProviderDefines the server-side of the SceneService.
SceneRegistry.ConfigFactoryUsed to create PlaceConfig instances for scenes.
SceneRegistry.ResolutionListenerBecause scenes must be loaded from the scene repository and this must not be done on the + dobjmgr thread, the interface for resolving scenes requires that the entity that wishes for + a scene to be resolved implement this callback interface so that it can be notified when a + scene has been loaded and initialized.
+  + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Class Summary
AbstractSceneMoveHandlerHandles the basics of moving a client into a new scene, which may involve resolution.
SceneManagerThe scene manager extends the place manager and takes care of basic scene services.
SceneMoveHandlerHandles a simple scene to scene move.
SceneRegistryThe scene registry is responsible for the management of all scenes.
SceneSenderUsed to issue notifications to a SceneReceiver instance on a + client.
WhirledServerThe Whirled server extends the CrowdServer and provides access to managers and the like + that are needed by the Whirled serviecs.
WhirledServer.WhirledModuleConfigures dependencies needed by the Whirled server.
WhirledSessionThe client object used by client management on the Whirled server.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/server/package-tree.html b/apidocs/com/threerings/whirled/server/package-tree.html new file mode 100644 index 00000000..99232dc5 --- /dev/null +++ b/apidocs/com/threerings/whirled/server/package-tree.html @@ -0,0 +1,186 @@ + + + + + + + +com.threerings.whirled.server Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.whirled.server +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/server/package-use.html b/apidocs/com/threerings/whirled/server/package-use.html new file mode 100644 index 00000000..a4b4aac6 --- /dev/null +++ b/apidocs/com/threerings/whirled/server/package-use.html @@ -0,0 +1,350 @@ + + + + + + + +Uses of Package com.threerings.whirled.server (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.whirled.server

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
+Packages that use com.threerings.whirled.server
com.threerings.stage.server  
com.threerings.whirled.server  
com.threerings.whirled.spot.server  
com.threerings.whirled.zone.peer.server  
com.threerings.whirled.zone.server  
+  +

+ + + + + + + + + + + + + + +
+Classes in com.threerings.whirled.server used by com.threerings.stage.server
SceneManager + +
+          The scene manager extends the place manager and takes care of basic scene services.
WhirledServer + +
+          The Whirled server extends the CrowdServer and provides access to managers and the like + that are needed by the Whirled serviecs.
WhirledServer.WhirledModule + +
+          Configures dependencies needed by the Whirled server.
+  +

+ + + + + + + + + + + + + + + + + +
+Classes in com.threerings.whirled.server used by com.threerings.whirled.server
AbstractSceneMoveHandler + +
+          Handles the basics of moving a client into a new scene, which may involve resolution.
SceneManager + +
+          The scene manager extends the place manager and takes care of basic scene services.
SceneProvider + +
+          Defines the server-side of the SceneService.
SceneRegistry.ResolutionListener + +
+          Because scenes must be loaded from the scene repository and this must not be done on the + dobjmgr thread, the interface for resolving scenes requires that the entity that wishes for + a scene to be resolved implement this callback interface so that it can be notified when a + scene has been loaded and initialized.
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+Classes in com.threerings.whirled.server used by com.threerings.whirled.spot.server
AbstractSceneMoveHandler + +
+          Handles the basics of moving a client into a new scene, which may involve resolution.
SceneManager + +
+          The scene manager extends the place manager and takes care of basic scene services.
SceneMoveHandler + +
+          Handles a simple scene to scene move.
SceneProvider + +
+          Defines the server-side of the SceneService.
SceneRegistry + +
+          The scene registry is responsible for the management of all scenes.
SceneRegistry.ResolutionListener + +
+          Because scenes must be loaded from the scene repository and this must not be done on the + dobjmgr thread, the interface for resolving scenes requires that the entity that wishes for + a scene to be resolved implement this callback interface so that it can be notified when a + scene has been loaded and initialized.
WhirledSession + +
+          The client object used by client management on the Whirled server.
+  +

+ + + + + + + + + + + + + + +
+Classes in com.threerings.whirled.server used by com.threerings.whirled.zone.peer.server
AbstractSceneMoveHandler + +
+          Handles the basics of moving a client into a new scene, which may involve resolution.
SceneRegistry + +
+          The scene registry is responsible for the management of all scenes.
SceneRegistry.ResolutionListener + +
+          Because scenes must be loaded from the scene repository and this must not be done on the + dobjmgr thread, the interface for resolving scenes requires that the entity that wishes for + a scene to be resolved implement this callback interface so that it can be notified when a + scene has been loaded and initialized.
+  +

+ + + + + + + + + + + + + + +
+Classes in com.threerings.whirled.server used by com.threerings.whirled.zone.server
AbstractSceneMoveHandler + +
+          Handles the basics of moving a client into a new scene, which may involve resolution.
SceneRegistry + +
+          The scene registry is responsible for the management of all scenes.
SceneRegistry.ResolutionListener + +
+          Because scenes must be loaded from the scene repository and this must not be done on the + dobjmgr thread, the interface for resolving scenes requires that the entity that wishes for + a scene to be resolved implement this callback interface so that it can be notified when a + scene has been loaded and initialized.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/server/persist/DummySceneRepository.html b/apidocs/com/threerings/whirled/server/persist/DummySceneRepository.html new file mode 100644 index 00000000..fd0761e9 --- /dev/null +++ b/apidocs/com/threerings/whirled/server/persist/DummySceneRepository.html @@ -0,0 +1,367 @@ + + + + + + + +DummySceneRepository (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.server.persist +
+Class DummySceneRepository

+
+java.lang.Object
+  extended by com.threerings.whirled.server.persist.DummySceneRepository
+
+
+
All Implemented Interfaces:
SceneRepository
+
+
+
+
public class DummySceneRepository
extends Object
implements SceneRepository
+ + +

+The dummy scene repository just pretends to load and store scenes, but + in fact it just creates new blank scenes when requested to load a scene + and does nothing when requested to save one. +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
DummySceneRepository() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidapplyAndRecordUpdate(SceneModel model, + SceneUpdate update) + +
+          Applise the supplied scene update to persistent representation of its associated scene, then + stores the update persistently for future invocations of the server to load.
+ ObjectloadExtras(int sceneId, + SceneModel model) + +
+          Loads optional additional scene data.
+ SceneModelloadSceneModel(int sceneId) + +
+          Fetches the model for the scene with the specified scene id.
+ UpdateListloadUpdates(int sceneId) + +
+          Fetches the set of updates associated with the specified scene.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+DummySceneRepository

+
+public DummySceneRepository()
+
+
+ + + + + + + + +
+Method Detail
+ +

+loadSceneModel

+
+public SceneModel loadSceneModel(int sceneId)
+                          throws PersistenceException,
+                                 NoSuchSceneException
+
+
Description copied from interface: SceneRepository
+
Fetches the model for the scene with the specified scene id. +

+

+
Specified by:
loadSceneModel in interface SceneRepository
+
+
+ +
Throws: +
PersistenceException - thrown if an error occurs attempting to load the scene data. +
NoSuchSceneException - thrown if no scene exists with the specified scene id.
+
+
+
+ +

+loadUpdates

+
+public UpdateList loadUpdates(int sceneId)
+                       throws PersistenceException
+
+
Description copied from interface: SceneRepository
+
Fetches the set of updates associated with the specified scene. +

+

+
Specified by:
loadUpdates in interface SceneRepository
+
+
+ +
Throws: +
PersistenceException - thrown if an error occurs attempting to load the scene + updates.
+
+
+
+ +

+loadExtras

+
+public Object loadExtras(int sceneId,
+                         SceneModel model)
+                  throws PersistenceException
+
+
Description copied from interface: SceneRepository
+
Loads optional additional scene data. This data is loaded during the scene resolution + process and made available to the scene manager via SceneManager.gotSceneData(java.lang.Object). +

+

+
Specified by:
loadExtras in interface SceneRepository
+
+
+ +
Throws: +
PersistenceException
+
+
+
+ +

+applyAndRecordUpdate

+
+public void applyAndRecordUpdate(SceneModel model,
+                                 SceneUpdate update)
+                          throws PersistenceException
+
+
Description copied from interface: SceneRepository
+
Applise the supplied scene update to persistent representation of its associated scene, then + stores the update persistently for future invocations of the server to load. Note: + the scene update will have already been applied to the supplied scene model. +

+

+
Specified by:
applyAndRecordUpdate in interface SceneRepository
+
+
+ +
Throws: +
PersistenceException - thrown if an error occurs attempting to apply the scene + update.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/server/persist/SceneRepository.html b/apidocs/com/threerings/whirled/server/persist/SceneRepository.html new file mode 100644 index 00000000..99e279d0 --- /dev/null +++ b/apidocs/com/threerings/whirled/server/persist/SceneRepository.html @@ -0,0 +1,306 @@ + + + + + + + +SceneRepository (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.server.persist +
+Interface SceneRepository

+
+
All Known Implementing Classes:
DummySceneRepository
+
+
+
+
public interface SceneRepository
+ + +

+The scene repository provides the basic interface for loading and updating scene data. It is + used by the scene registry and though more scene related persistence services may be needed in a + full-fledged application, the scene repository only encapsulates those needed by the scene + registry and other services provided by the Whirled framework. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidapplyAndRecordUpdate(SceneModel model, + SceneUpdate update) + +
+          Applise the supplied scene update to persistent representation of its associated scene, then + stores the update persistently for future invocations of the server to load.
+ ObjectloadExtras(int sceneId, + SceneModel model) + +
+          Loads optional additional scene data.
+ SceneModelloadSceneModel(int sceneId) + +
+          Fetches the model for the scene with the specified scene id.
+ UpdateListloadUpdates(int sceneId) + +
+          Fetches the set of updates associated with the specified scene.
+  +

+ + + + + + + + +
+Method Detail
+ +

+loadSceneModel

+
+SceneModel loadSceneModel(int sceneId)
+                          throws PersistenceException,
+                                 NoSuchSceneException
+
+
Fetches the model for the scene with the specified scene id. +

+

+ +
Throws: +
PersistenceException - thrown if an error occurs attempting to load the scene data. +
NoSuchSceneException - thrown if no scene exists with the specified scene id.
+
+
+
+ +

+loadUpdates

+
+UpdateList loadUpdates(int sceneId)
+                       throws PersistenceException
+
+
Fetches the set of updates associated with the specified scene. +

+

+ +
Throws: +
PersistenceException - thrown if an error occurs attempting to load the scene + updates.
+
+
+
+ +

+loadExtras

+
+Object loadExtras(int sceneId,
+                  SceneModel model)
+                  throws PersistenceException
+
+
Loads optional additional scene data. This data is loaded during the scene resolution + process and made available to the scene manager via SceneManager.gotSceneData(java.lang.Object). +

+

+ +
Throws: +
PersistenceException
+
+
+
+ +

+applyAndRecordUpdate

+
+void applyAndRecordUpdate(SceneModel model,
+                          SceneUpdate update)
+                          throws PersistenceException
+
+
Applise the supplied scene update to persistent representation of its associated scene, then + stores the update persistently for future invocations of the server to load. Note: + the scene update will have already been applied to the supplied scene model. +

+

+ +
Throws: +
PersistenceException - thrown if an error occurs attempting to apply the scene + update.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/server/persist/SceneUpdateMarshaller.html b/apidocs/com/threerings/whirled/server/persist/SceneUpdateMarshaller.html new file mode 100644 index 00000000..96a8c7c2 --- /dev/null +++ b/apidocs/com/threerings/whirled/server/persist/SceneUpdateMarshaller.html @@ -0,0 +1,361 @@ + + + + + + + +SceneUpdateMarshaller (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.server.persist +
+Class SceneUpdateMarshaller

+
+java.lang.Object
+  extended by com.threerings.whirled.server.persist.SceneUpdateMarshaller
+
+
+
+
public class SceneUpdateMarshaller
extends Object
+ + +

+A utility class to assist the management of scene updates by a SceneRepository. +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
SceneUpdateMarshaller(Class<?>... typesClasses) + +
+          Create a SceneUpdateMarshaller that understands the update types specified.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ SceneUpdatedecodeUpdate(int sceneId, + int sceneVersion, + int updateType, + byte[] data) + +
+          Instantiates the appropriate update class and decodes the update from the data.
+ Class<?>getUpdateClass(int type) + +
+          Returns the update class associated with the specified type code, or null.
+ intgetUpdateType(Class<?> typeClass) + +
+          Returns the type code that is assigned to the specified SceneUpdate class, or -1.
+ intgetUpdateType(SceneUpdate update) + +
+          Returns the type code that is assigned to the specified SceneUpdate instance, or -1.
+ byte[]persistUpdate(SceneUpdate update) + +
+          Persists the specified update to a new ByteArrayOutInputStream.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+SceneUpdateMarshaller

+
+public SceneUpdateMarshaller(Class<?>... typesClasses)
+
+
Create a SceneUpdateMarshaller that understands the update types specified. + + Note: Once a type is registered and in use by some SceneRepository that type id can never be + used again. If you need to remove an update type, it should be replaced with null in the + class list to reserve the old type id that it represented. +

+

+ + + + + + + + +
+Method Detail
+ +

+getUpdateType

+
+public int getUpdateType(SceneUpdate update)
+
+
Returns the type code that is assigned to the specified SceneUpdate instance, or -1. +

+

+
+
+
+
+ +

+getUpdateType

+
+public int getUpdateType(Class<?> typeClass)
+
+
Returns the type code that is assigned to the specified SceneUpdate class, or -1. +

+

+
+
+
+
+ +

+getUpdateClass

+
+public Class<?> getUpdateClass(int type)
+
+
Returns the update class associated with the specified type code, or null. +

+

+
+
+
+
+ +

+persistUpdate

+
+public byte[] persistUpdate(SceneUpdate update)
+                     throws PersistenceException
+
+
Persists the specified update to a new ByteArrayOutInputStream. +

+

+ +
Throws: +
PersistenceException
+
+
+
+ +

+decodeUpdate

+
+public SceneUpdate decodeUpdate(int sceneId,
+                                int sceneVersion,
+                                int updateType,
+                                byte[] data)
+                         throws PersistenceException
+
+
Instantiates the appropriate update class and decodes the update from the data. +

+

+ +
Throws: +
PersistenceException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/server/persist/class-use/DummySceneRepository.html b/apidocs/com/threerings/whirled/server/persist/class-use/DummySceneRepository.html new file mode 100644 index 00000000..11615893 --- /dev/null +++ b/apidocs/com/threerings/whirled/server/persist/class-use/DummySceneRepository.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.whirled.server.persist.DummySceneRepository (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.server.persist.DummySceneRepository

+
+No usage of com.threerings.whirled.server.persist.DummySceneRepository +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/server/persist/class-use/SceneRepository.html b/apidocs/com/threerings/whirled/server/persist/class-use/SceneRepository.html new file mode 100644 index 00000000..ad580255 --- /dev/null +++ b/apidocs/com/threerings/whirled/server/persist/class-use/SceneRepository.html @@ -0,0 +1,212 @@ + + + + + + + +Uses of Interface com.threerings.whirled.server.persist.SceneRepository (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.whirled.server.persist.SceneRepository

+
+ + + + + + + + + + + + + +
+Packages that use SceneRepository
com.threerings.whirled.server  
com.threerings.whirled.server.persist  
+  +

+ + + + + +
+Uses of SceneRepository in com.threerings.whirled.server
+  +

+ + + + + + + + + +
Methods in com.threerings.whirled.server that return SceneRepository
+ SceneRepositorySceneRegistry.getSceneRepository() + +
+          Returns a reference to the scene repository in use by this registry.
+  +

+ + + + + +
+Uses of SceneRepository in com.threerings.whirled.server.persist
+  +

+ + + + + + + + + +
Classes in com.threerings.whirled.server.persist that implement SceneRepository
+ classDummySceneRepository + +
+          The dummy scene repository just pretends to load and store scenes, but + in fact it just creates new blank scenes when requested to load a scene + and does nothing when requested to save one.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/server/persist/class-use/SceneUpdateMarshaller.html b/apidocs/com/threerings/whirled/server/persist/class-use/SceneUpdateMarshaller.html new file mode 100644 index 00000000..b1b1a324 --- /dev/null +++ b/apidocs/com/threerings/whirled/server/persist/class-use/SceneUpdateMarshaller.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.whirled.server.persist.SceneUpdateMarshaller (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.server.persist.SceneUpdateMarshaller

+
+No usage of com.threerings.whirled.server.persist.SceneUpdateMarshaller +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/server/persist/package-frame.html b/apidocs/com/threerings/whirled/server/persist/package-frame.html new file mode 100644 index 00000000..cd373500 --- /dev/null +++ b/apidocs/com/threerings/whirled/server/persist/package-frame.html @@ -0,0 +1,46 @@ + + + + + + + +com.threerings.whirled.server.persist (vilya 1.3 API) + + + + + + + + + + + +com.threerings.whirled.server.persist + + + + +
+Interfaces  + +
+SceneRepository
+ + + + + + +
+Classes  + +
+DummySceneRepository +
+SceneUpdateMarshaller
+ + + + diff --git a/apidocs/com/threerings/whirled/server/persist/package-summary.html b/apidocs/com/threerings/whirled/server/persist/package-summary.html new file mode 100644 index 00000000..e4237b6c --- /dev/null +++ b/apidocs/com/threerings/whirled/server/persist/package-summary.html @@ -0,0 +1,178 @@ + + + + + + + +com.threerings.whirled.server.persist (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.whirled.server.persist +

+ + + + + + + + + +
+Interface Summary
SceneRepositoryThe scene repository provides the basic interface for loading and updating scene data.
+  + +

+ + + + + + + + + + + + + +
+Class Summary
DummySceneRepositoryThe dummy scene repository just pretends to load and store scenes, but + in fact it just creates new blank scenes when requested to load a scene + and does nothing when requested to save one.
SceneUpdateMarshallerA utility class to assist the management of scene updates by a SceneRepository.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/server/persist/package-tree.html b/apidocs/com/threerings/whirled/server/persist/package-tree.html new file mode 100644 index 00000000..9e31ed25 --- /dev/null +++ b/apidocs/com/threerings/whirled/server/persist/package-tree.html @@ -0,0 +1,160 @@ + + + + + + + +com.threerings.whirled.server.persist Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.whirled.server.persist +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/server/persist/package-use.html b/apidocs/com/threerings/whirled/server/persist/package-use.html new file mode 100644 index 00000000..3d8d870f --- /dev/null +++ b/apidocs/com/threerings/whirled/server/persist/package-use.html @@ -0,0 +1,190 @@ + + + + + + + +Uses of Package com.threerings.whirled.server.persist (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.whirled.server.persist

+
+ + + + + + + + + + + + + +
+Packages that use com.threerings.whirled.server.persist
com.threerings.whirled.server  
com.threerings.whirled.server.persist  
+  +

+ + + + + + + + +
+Classes in com.threerings.whirled.server.persist used by com.threerings.whirled.server
SceneRepository + +
+          The scene repository provides the basic interface for loading and updating scene data.
+  +

+ + + + + + + + +
+Classes in com.threerings.whirled.server.persist used by com.threerings.whirled.server.persist
SceneRepository + +
+          The scene repository provides the basic interface for loading and updating scene data.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/Log.html b/apidocs/com/threerings/whirled/spot/Log.html new file mode 100644 index 00000000..0cb6e400 --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/Log.html @@ -0,0 +1,265 @@ + + + + + + + +Log (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.spot +
+Class Log

+
+java.lang.Object
+  extended by com.threerings.whirled.spot.Log
+
+
+
+
public class Log
extends Object
+ + +

+Contains a reference to the log object used by the Whirled Spot services. +

+ +

+

+ +

+ + + + + + + + + + + +
+Field Summary
+static Loggerlog + +
+           
+  + + + + + + + + + + +
+Constructor Summary
Log() + +
+           
+  + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+log

+
+public static Logger log
+
+
+
+
+ + + + + + + + +
+Constructor Detail
+ +

+Log

+
+public Log()
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/class-use/Log.html b/apidocs/com/threerings/whirled/spot/class-use/Log.html new file mode 100644 index 00000000..414f3054 --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/class-use/Log.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.whirled.spot.Log (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.spot.Log

+
+No usage of com.threerings.whirled.spot.Log +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/client/SpotSceneController.html b/apidocs/com/threerings/whirled/spot/client/SpotSceneController.html new file mode 100644 index 00000000..dd8b7b64 --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/client/SpotSceneController.html @@ -0,0 +1,307 @@ + + + + + + + +SpotSceneController (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.spot.client +
+Class SpotSceneController

+
+java.lang.Object
+  extended by com.samskivert.swing.Controller
+      extended by com.threerings.crowd.client.PlaceController
+          extended by com.threerings.whirled.client.SceneController
+              extended by com.threerings.whirled.spot.client.SpotSceneController
+
+
+
All Implemented Interfaces:
ActionListener, EventListener
+
+
+
Direct Known Subclasses:
StageSceneController
+
+
+
+
public abstract class SpotSceneController
extends SceneController
+ + +

+The base spot scene controller class. It is expected that users of the + Whirled Spot services will extend this controller class when creating + specialized controllers for their scenes. Presently there are no basic + scene services provided by this controller, but its existence affords + the addition of such services should they become necessary in the + future. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.crowd.client.PlaceController
com.threerings.crowd.client.PlaceController.DelegateOp
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class com.samskivert.swing.Controller
DISPATCHER
+  + + + + + + + + + + +
+Constructor Summary
SpotSceneController() + +
+           
+  + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from class com.threerings.whirled.client.SceneController
didLeavePlace, init, willEnterPlace
+  + + + + + + + +
Methods inherited from class com.threerings.crowd.client.PlaceController
getPlaceConfig, getPlaceView, handleAction, mayLeavePlace
+  + + + + + + + +
Methods inherited from class com.samskivert.swing.Controller
actionPerformed, configureAction, createActionButton, handleAction, handleAction, handleAction, postAction, postAction, postAction, setControlledPanel, wasAdded, wasRemoved
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+SpotSceneController

+
+public SpotSceneController()
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/client/SpotSceneDirector.html b/apidocs/com/threerings/whirled/spot/client/SpotSceneDirector.html new file mode 100644 index 00000000..1f05031e --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/client/SpotSceneDirector.html @@ -0,0 +1,674 @@ + + + + + + + +SpotSceneDirector (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.spot.client +
+Class SpotSceneDirector

+
+java.lang.Object
+  extended by com.threerings.presents.client.BasicDirector
+      extended by com.threerings.whirled.spot.client.SpotSceneDirector
+
+
+
All Implemented Interfaces:
com.threerings.crowd.chat.data.ChatCodes, com.threerings.crowd.data.LocationCodes, com.threerings.presents.client.SessionObserver, com.threerings.presents.data.InvocationCodes, com.threerings.presents.dobj.AttributeChangeListener, com.threerings.presents.dobj.ChangeListener, com.threerings.presents.dobj.Subscriber<com.threerings.presents.dobj.DObject>, SceneCodes, SpotCodes
+
+
+
+
public class SpotSceneDirector
extends com.threerings.presents.client.BasicDirector
implements SpotCodes, com.threerings.presents.dobj.Subscriber<com.threerings.presents.dobj.DObject>, com.threerings.presents.dobj.AttributeChangeListener
+ + +

+Extends the standard scene director with facilities to move between locations within a scene. +

+ +

+

+ +

+ + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from interface com.threerings.whirled.spot.data.SpotCodes
CLUSTER_CHAT_TYPE, CLUSTER_FULL, INVALID_LOCATION, LOCATION_OCCUPIED, NO_SUCH_CLUSTER, NO_SUCH_PORTAL
+  + + + + + + + +
Fields inherited from interface com.threerings.crowd.chat.data.ChatCodes
BROADCAST_ACCESS, BROADCAST_MODE, CHAT_ACCESS, CHAT_CHANNEL_NOTIFICATION, CHAT_NOTIFICATION, DEFAULT_IDLE_TIME, DEFAULT_MODE, EMOTE_MODE, IDLE_TIME_KEY, LAST_MODE, PLACE_CHAT_TYPE, SHOUT_MODE, SUCCESS, THINK_MODE, USER_CHAT_TYPE, USER_DISCONNECTED, USER_NOT_ONLINE, XLATE_MODES
+  + + + + + + + +
Fields inherited from interface com.threerings.whirled.data.SceneCodes
SCENE_UPDATE, WHIRLED_GROUP
+  + + + + + + + +
Fields inherited from interface com.threerings.crowd.data.LocationCodes
ALREADY_THERE, MOVE_IN_PROGRESS, NO_SUCH_PLACE
+  + + + + + + + +
Fields inherited from interface com.threerings.presents.data.InvocationCodes
ACCESS_DENIED, E_ACCESS_DENIED, E_INTERNAL_ERROR, GLOBAL_GROUP, INTERNAL_ERROR
+  + + + + + + + + + + +
+Constructor Summary
SpotSceneDirector(WhirledContext ctx, + com.threerings.crowd.client.LocationDirector locdir, + SceneDirector scdir) + +
+          Creates a new spot scene director with the specified context and which will cooperate with + the supplied scene director.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidattributeChanged(com.threerings.presents.dobj.AttributeChangedEvent event) + +
+           
+ voidchangeLocation(Location loc, + ResultListener<Location> listener) + +
+          Issues a request to change our location within the scene to the specified location.
+ voidclientDidLogoff(com.threerings.presents.client.Client client) + +
+           
+ voidclientDidLogon(com.threerings.presents.client.Client client) + +
+           
+ voidclientObjectDidChange(com.threerings.presents.client.Client client) + +
+           
+ LocationgetIntendedLocation() + +
+          Returns our current location unless we have a location change pending, in which case our + pending location is returned.
+ voidjoinCluster(int froid, + ResultListener<Void> listener) + +
+          Issues a request to join the cluster associated with the specified user (starting one if + necessary).
+ voidobjectAvailable(com.threerings.presents.dobj.DObject object) + +
+           
+ booleanrequestClusterSpeak(String message) + +
+          Sends a chat message to the other users in the cluster to which the location that we + currently occupy belongs.
+ booleanrequestClusterSpeak(String message, + byte mode) + +
+          Sends a chat message to the other users in the cluster to which the location that we + currently occupy belongs.
+ voidrequestFailed(int oid, + com.threerings.presents.dobj.ObjectAccessException cause) + +
+           
+ voidsetChatDirector(com.threerings.crowd.chat.client.ChatDirector chatdir) + +
+          Configures this spot scene director with a chat director, with which it will coordinate to + implement cluster chatting.
+ booleantraversePortal(int portalId) + +
+          Requests that this client move to the location specified by the supplied portal id.
+ booleantraversePortal(int portalId, + ResultListener<com.threerings.crowd.data.PlaceConfig> rl) + +
+          Requests that this client move to the location specified by the supplied portal id.
+  + + + + + + + +
Methods inherited from class com.threerings.presents.client.BasicDirector
clientWillLogon, isAvailableInStandalone, setAvailableInStandalone
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+SpotSceneDirector

+
+public SpotSceneDirector(WhirledContext ctx,
+                         com.threerings.crowd.client.LocationDirector locdir,
+                         SceneDirector scdir)
+
+
Creates a new spot scene director with the specified context and which will cooperate with + the supplied scene director. +

+

+
Parameters:
ctx - the active client context.
locdir - the location director with which we will be cooperating.
scdir - the scene director with which we will be cooperating.
+
+ + + + + + + + +
+Method Detail
+ +

+setChatDirector

+
+public void setChatDirector(com.threerings.crowd.chat.client.ChatDirector chatdir)
+
+
Configures this spot scene director with a chat director, with which it will coordinate to + implement cluster chatting. +

+

+
+
+
+
+
+
+
+ +

+getIntendedLocation

+
+public Location getIntendedLocation()
+
+
Returns our current location unless we have a location change pending, in which case our + pending location is returned. +

+

+
+
+
+
+
+
+
+ +

+traversePortal

+
+public boolean traversePortal(int portalId)
+
+
Requests that this client move to the location specified by the supplied portal id. A + request will be made and when the response is received, the location observers will be + notified of success or failure. +

+

+
+
+
+ +
Returns:
true if the request was issued, false if it was rejected by a location observer or + because we have another request outstanding.
+
+
+
+ +

+traversePortal

+
+public boolean traversePortal(int portalId,
+                              ResultListener<com.threerings.crowd.data.PlaceConfig> rl)
+
+
Requests that this client move to the location specified by the supplied portal id. A + request will be made and when the response is received, the location observers will be + notified of success or failure. +

+

+
+
+
+
+
+
+
+ +

+changeLocation

+
+public void changeLocation(Location loc,
+                           ResultListener<Location> listener)
+
+
Issues a request to change our location within the scene to the specified location. +

+

+
+
+
+
Parameters:
loc - the new location to which to move.
listener - will be notified of success or failure. Most client entities find out about + location changes via changes to the occupant info data, but the initiator of a location + change request can be notified of its success or failure, primarily so that it can act in + anticipation of a successful location change (like by starting a sprite moving toward the + new location), but backtrack if it finds out that the location change failed.
+
+
+
+ +

+joinCluster

+
+public void joinCluster(int froid,
+                        ResultListener<Void> listener)
+
+
Issues a request to join the cluster associated with the specified user (starting one if + necessary). +

+

+
+
+
+
Parameters:
froid - the bodyOid of another user; the calling user will be made to join the target + user's cluster.
listener - will be notified of success or failure.
+
+
+
+ +

+requestClusterSpeak

+
+public boolean requestClusterSpeak(String message)
+
+
Sends a chat message to the other users in the cluster to which the location that we + currently occupy belongs. +

+

+
+
+
+ +
Returns:
true if a cluster speak message was delivered, false if we are not in a valid + cluster and refused to deliver the request.
+
+
+
+ +

+requestClusterSpeak

+
+public boolean requestClusterSpeak(String message,
+                                   byte mode)
+
+
Sends a chat message to the other users in the cluster to which the location that we + currently occupy belongs. +

+

+
+
+
+ +
Returns:
true if a cluster speak message was delivered, false if we are not in a valid + cluster and refused to deliver the request.
+
+
+
+ +

+objectAvailable

+
+public void objectAvailable(com.threerings.presents.dobj.DObject object)
+
+
+
Specified by:
objectAvailable in interface com.threerings.presents.dobj.Subscriber<com.threerings.presents.dobj.DObject>
+
+
+
+
+
+
+ +

+requestFailed

+
+public void requestFailed(int oid,
+                          com.threerings.presents.dobj.ObjectAccessException cause)
+
+
+
Specified by:
requestFailed in interface com.threerings.presents.dobj.Subscriber<com.threerings.presents.dobj.DObject>
+
+
+
+
+
+
+ +

+attributeChanged

+
+public void attributeChanged(com.threerings.presents.dobj.AttributeChangedEvent event)
+
+
+
Specified by:
attributeChanged in interface com.threerings.presents.dobj.AttributeChangeListener
+
+
+
+
+
+
+ +

+clientDidLogon

+
+public void clientDidLogon(com.threerings.presents.client.Client client)
+
+
+
Specified by:
clientDidLogon in interface com.threerings.presents.client.SessionObserver
Overrides:
clientDidLogon in class com.threerings.presents.client.BasicDirector
+
+
+
+
+
+
+ +

+clientObjectDidChange

+
+public void clientObjectDidChange(com.threerings.presents.client.Client client)
+
+
+
Specified by:
clientObjectDidChange in interface com.threerings.presents.client.SessionObserver
Overrides:
clientObjectDidChange in class com.threerings.presents.client.BasicDirector
+
+
+
+
+
+
+ +

+clientDidLogoff

+
+public void clientDidLogoff(com.threerings.presents.client.Client client)
+
+
+
Specified by:
clientDidLogoff in interface com.threerings.presents.client.SessionObserver
Overrides:
clientDidLogoff in class com.threerings.presents.client.BasicDirector
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/client/SpotService.SpotSceneMoveListener.html b/apidocs/com/threerings/whirled/spot/client/SpotService.SpotSceneMoveListener.html new file mode 100644 index 00000000..cf565aa8 --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/client/SpotService.SpotSceneMoveListener.html @@ -0,0 +1,243 @@ + + + + + + + +SpotService.SpotSceneMoveListener (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.spot.client +
+Interface SpotService.SpotSceneMoveListener

+
+
All Superinterfaces:
com.threerings.presents.client.InvocationService.InvocationListener, SceneService.SceneMoveListener
+
+
+
All Known Implementing Classes:
SpotMarshaller.SpotSceneMoveMarshaller
+
+
+
Enclosing interface:
SpotService
+
+
+
+
public static interface SpotService.SpotSceneMoveListener
extends SceneService.SceneMoveListener
+ + +

+Used to communicate the response to a SceneService.moveTo(int, int, com.threerings.whirled.client.SceneService.SceneMoveListener) request. +

+ +

+

+ +

+ + + + + + + + + + + + +
+Method Summary
+ voidrequestCancelled() + +
+          The request is not going through because it was cancelled due to some other action.
+  + + + + + + + +
Methods inherited from interface com.threerings.whirled.client.SceneService.SceneMoveListener
moveRequiresServerSwitch, moveSucceeded, moveSucceededWithScene, moveSucceededWithUpdates
+  + + + + + + + +
Methods inherited from interface com.threerings.presents.client.InvocationService.InvocationListener
requestFailed
+  +

+ + + + + + + + +
+Method Detail
+ +

+requestCancelled

+
+void requestCancelled()
+
+
The request is not going through because it was cancelled due to some other action. +

+

+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/client/SpotService.html b/apidocs/com/threerings/whirled/spot/client/SpotService.html new file mode 100644 index 00000000..e085f392 --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/client/SpotService.html @@ -0,0 +1,350 @@ + + + + + + + +SpotService (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.spot.client +
+Interface SpotService

+
+
All Superinterfaces:
com.threerings.presents.client.InvocationService
+
+
+
All Known Implementing Classes:
SpotMarshaller
+
+
+
+
public interface SpotService
extends com.threerings.presents.client.InvocationService
+ + +

+Defines the mechanism by which the client can request to move around + within a scene and between scenes (taking exit and entry locations into + account). These services should not be used directly, but instead + should be accessed via the SpotSceneDirector. +

+ +

+

+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static interfaceSpotService.SpotSceneMoveListener + +
+          Used to communicate the response to a SceneService.moveTo(int, int, com.threerings.whirled.client.SceneService.SceneMoveListener) request.
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.presents.client.InvocationService
com.threerings.presents.client.InvocationService.ConfirmListener, com.threerings.presents.client.InvocationService.InvocationListener, com.threerings.presents.client.InvocationService.ResultListener
+  + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidchangeLocation(int sceneId, + Location loc, + com.threerings.presents.client.InvocationService.ConfirmListener listener) + +
+          Requests that this client's body be made to move to the specified + location.
+ voidclusterSpeak(String message, + byte mode) + +
+          Requests that the supplied message be delivered to listeners in the + cluster to which the specified location belongs.
+ voidjoinCluster(int friendOid, + com.threerings.presents.client.InvocationService.ConfirmListener listener) + +
+          Requests that this client start or join the specified cluster.
+ voidtraversePortal(int sceneId, + int portalId, + int destSceneVer, + SpotService.SpotSceneMoveListener listener) + +
+          Requests to traverse the specified portal.
+  +

+ + + + + + + + +
+Method Detail
+ +

+traversePortal

+
+void traversePortal(int sceneId,
+                    int portalId,
+                    int destSceneVer,
+                    SpotService.SpotSceneMoveListener listener)
+
+
Requests to traverse the specified portal. +

+

+
+
+
+
Parameters:
sceneId - the player's current scene which is used to sanity + check things when the request actually arrives.
portalId - the portal to be traversed.
destSceneVer - the version of the destination scene data that + the client has in its local repository.
+
+
+
+ +

+changeLocation

+
+void changeLocation(int sceneId,
+                    Location loc,
+                    com.threerings.presents.client.InvocationService.ConfirmListener listener)
+
+
Requests that this client's body be made to move to the specified + location. The user will be removed from any cluster from which they + are an occupant. +

+

+
+
+
+
Parameters:
sceneId - the id of the scene in which to change location.
loc - the location to which to move.
+
+
+
+ +

+joinCluster

+
+void joinCluster(int friendOid,
+                 com.threerings.presents.client.InvocationService.ConfirmListener listener)
+
+
Requests that this client start or join the specified cluster. They + will be relocated appropriately by the scene manager. +

+

+
+
+
+
Parameters:
friendOid - the bodyOid of another user or the oid of an + existing cluster; the calling user will be made to join the cluster + or target user's cluster, or create a cluster with the target user + if they are not already in one.
+
+
+
+ +

+clusterSpeak

+
+void clusterSpeak(String message,
+                  byte mode)
+
+
Requests that the supplied message be delivered to listeners in the + cluster to which the specified location belongs. +

+

+
+
+
+
Parameters:
message - the text of the message to be spoken.
mode - an associated mode constant that can be used to + identify different kinds of "speech" (emote, thought bubble, etc.).
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/client/class-use/SpotSceneController.html b/apidocs/com/threerings/whirled/spot/client/class-use/SpotSceneController.html new file mode 100644 index 00000000..049ad432 --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/client/class-use/SpotSceneController.html @@ -0,0 +1,182 @@ + + + + + + + +Uses of Class com.threerings.whirled.spot.client.SpotSceneController (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.spot.client.SpotSceneController

+
+ + + + + + + + + +
+Packages that use SpotSceneController
com.threerings.stage.client  
+  +

+ + + + + +
+Uses of SpotSceneController in com.threerings.stage.client
+  +

+ + + + + + + + + +
Subclasses of SpotSceneController in com.threerings.stage.client
+ classStageSceneController + +
+          Extends the SpotSceneController with functionality specific to + displaying Stage scenes.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/client/class-use/SpotSceneDirector.html b/apidocs/com/threerings/whirled/spot/client/class-use/SpotSceneDirector.html new file mode 100644 index 00000000..479959f5 --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/client/class-use/SpotSceneDirector.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.whirled.spot.client.SpotSceneDirector (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.spot.client.SpotSceneDirector

+
+No usage of com.threerings.whirled.spot.client.SpotSceneDirector +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/client/class-use/SpotService.SpotSceneMoveListener.html b/apidocs/com/threerings/whirled/spot/client/class-use/SpotService.SpotSceneMoveListener.html new file mode 100644 index 00000000..9ce2852a --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/client/class-use/SpotService.SpotSceneMoveListener.html @@ -0,0 +1,277 @@ + + + + + + + +Uses of Interface com.threerings.whirled.spot.client.SpotService.SpotSceneMoveListener (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.whirled.spot.client.SpotService.SpotSceneMoveListener

+
+ + + + + + + + + + + + + + + + + +
+Packages that use SpotService.SpotSceneMoveListener
com.threerings.whirled.spot.client  
com.threerings.whirled.spot.data  
com.threerings.whirled.spot.server  
+  +

+ + + + + +
+Uses of SpotService.SpotSceneMoveListener in com.threerings.whirled.spot.client
+  +

+ + + + + + + + + +
Methods in com.threerings.whirled.spot.client with parameters of type SpotService.SpotSceneMoveListener
+ voidSpotService.traversePortal(int sceneId, + int portalId, + int destSceneVer, + SpotService.SpotSceneMoveListener listener) + +
+          Requests to traverse the specified portal.
+  +

+ + + + + +
+Uses of SpotService.SpotSceneMoveListener in com.threerings.whirled.spot.data
+  +

+ + + + + + + + + +
Classes in com.threerings.whirled.spot.data that implement SpotService.SpotSceneMoveListener
+static classSpotMarshaller.SpotSceneMoveMarshaller + +
+          Marshalls results to implementations of SpotService.SpotSceneMoveListener.
+  +

+ + + + + + + + + +
Methods in com.threerings.whirled.spot.data with parameters of type SpotService.SpotSceneMoveListener
+ voidSpotMarshaller.traversePortal(int arg1, + int arg2, + int arg3, + SpotService.SpotSceneMoveListener arg4) + +
+           
+  +

+ + + + + +
+Uses of SpotService.SpotSceneMoveListener in com.threerings.whirled.spot.server
+  +

+ + + + + + + + + + + + + +
Methods in com.threerings.whirled.spot.server with parameters of type SpotService.SpotSceneMoveListener
+ voidSpotSceneRegistry.traversePortal(com.threerings.presents.data.ClientObject caller, + int sceneId, + int portalId, + int destSceneVer, + SpotService.SpotSceneMoveListener listener) + +
+           
+ voidSpotProvider.traversePortal(com.threerings.presents.data.ClientObject caller, + int arg1, + int arg2, + int arg3, + SpotService.SpotSceneMoveListener arg4) + +
+          Handles a SpotService.traversePortal(int, int, int, com.threerings.whirled.spot.client.SpotService.SpotSceneMoveListener) request.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/client/class-use/SpotService.html b/apidocs/com/threerings/whirled/spot/client/class-use/SpotService.html new file mode 100644 index 00000000..5cb12863 --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/client/class-use/SpotService.html @@ -0,0 +1,183 @@ + + + + + + + +Uses of Interface com.threerings.whirled.spot.client.SpotService (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.whirled.spot.client.SpotService

+
+ + + + + + + + + +
+Packages that use SpotService
com.threerings.whirled.spot.data  
+  +

+ + + + + +
+Uses of SpotService in com.threerings.whirled.spot.data
+  +

+ + + + + + + + + +
Classes in com.threerings.whirled.spot.data that implement SpotService
+ classSpotMarshaller + +
+          Provides the implementation of the SpotService interface + that marshalls the arguments and delivers the request to the provider + on the server.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/client/package-frame.html b/apidocs/com/threerings/whirled/spot/client/package-frame.html new file mode 100644 index 00000000..a2d9ffac --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/client/package-frame.html @@ -0,0 +1,48 @@ + + + + + + + +com.threerings.whirled.spot.client (vilya 1.3 API) + + + + + + + + + + + +com.threerings.whirled.spot.client + + + + +
+Interfaces  + +
+SpotService +
+SpotService.SpotSceneMoveListener
+ + + + + + +
+Classes  + +
+SpotSceneController +
+SpotSceneDirector
+ + + + diff --git a/apidocs/com/threerings/whirled/spot/client/package-summary.html b/apidocs/com/threerings/whirled/spot/client/package-summary.html new file mode 100644 index 00000000..ca8e88d0 --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/client/package-summary.html @@ -0,0 +1,182 @@ + + + + + + + +com.threerings.whirled.spot.client (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.whirled.spot.client +

+ + + + + + + + + + + + + +
+Interface Summary
SpotServiceDefines the mechanism by which the client can request to move around + within a scene and between scenes (taking exit and entry locations into + account).
SpotService.SpotSceneMoveListenerUsed to communicate the response to a SceneService.moveTo(int, int, com.threerings.whirled.client.SceneService.SceneMoveListener) request.
+  + +

+ + + + + + + + + + + + + +
+Class Summary
SpotSceneControllerThe base spot scene controller class.
SpotSceneDirectorExtends the standard scene director with facilities to move between locations within a scene.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/client/package-tree.html b/apidocs/com/threerings/whirled/spot/client/package-tree.html new file mode 100644 index 00000000..1900f9e8 --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/client/package-tree.html @@ -0,0 +1,176 @@ + + + + + + + +com.threerings.whirled.spot.client Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.whirled.spot.client +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/client/package-use.html b/apidocs/com/threerings/whirled/spot/client/package-use.html new file mode 100644 index 00000000..6627926e --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/client/package-use.html @@ -0,0 +1,236 @@ + + + + + + + +Uses of Package com.threerings.whirled.spot.client (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.whirled.spot.client

+
+ + + + + + + + + + + + + + + + + + + + + +
+Packages that use com.threerings.whirled.spot.client
com.threerings.stage.client  
com.threerings.whirled.spot.client  
com.threerings.whirled.spot.data  
com.threerings.whirled.spot.server  
+  +

+ + + + + + + + +
+Classes in com.threerings.whirled.spot.client used by com.threerings.stage.client
SpotSceneController + +
+          The base spot scene controller class.
+  +

+ + + + + + + + +
+Classes in com.threerings.whirled.spot.client used by com.threerings.whirled.spot.client
SpotService.SpotSceneMoveListener + +
+          Used to communicate the response to a SceneService.moveTo(int, int, com.threerings.whirled.client.SceneService.SceneMoveListener) request.
+  +

+ + + + + + + + + + + +
+Classes in com.threerings.whirled.spot.client used by com.threerings.whirled.spot.data
SpotService + +
+          Defines the mechanism by which the client can request to move around + within a scene and between scenes (taking exit and entry locations into + account).
SpotService.SpotSceneMoveListener + +
+          Used to communicate the response to a SceneService.moveTo(int, int, com.threerings.whirled.client.SceneService.SceneMoveListener) request.
+  +

+ + + + + + + + +
+Classes in com.threerings.whirled.spot.client used by com.threerings.whirled.spot.server
SpotService.SpotSceneMoveListener + +
+          Used to communicate the response to a SceneService.moveTo(int, int, com.threerings.whirled.client.SceneService.SceneMoveListener) request.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/data/Cluster.html b/apidocs/com/threerings/whirled/spot/data/Cluster.html new file mode 100644 index 00000000..61463f82 --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/data/Cluster.html @@ -0,0 +1,457 @@ + + + + + + + +Cluster (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.spot.data +
+Class Cluster

+
+java.lang.Object
+  extended by java.awt.geom.RectangularShape
+      extended by java.awt.geom.Rectangle2D
+          extended by java.awt.Rectangle
+              extended by com.threerings.whirled.spot.data.Cluster
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable, com.threerings.presents.dobj.DSet.Entry, Shape, Serializable, Cloneable
+
+
+
+
public class Cluster
extends Rectangle
implements com.threerings.presents.dobj.DSet.Entry
+ + +

+Contains information on clusters. +

+ +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class java.awt.geom.Rectangle2D
Rectangle2D.Double, Rectangle2D.Float
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + +
+Field Summary
+ intclusterOid + +
+          A unique identifier for this cluster (also the distributed object + id of the cluster chat object).
+  + + + + + + + +
Fields inherited from class java.awt.Rectangle
height, width, x, y
+  + + + + + + + +
Fields inherited from class java.awt.geom.Rectangle2D
OUT_BOTTOM, OUT_LEFT, OUT_RIGHT, OUT_TOP
+  + + + + + + + + + + +
+Constructor Summary
Cluster() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ booleanequals(Object other) + +
+           
+ Comparable<?>getKey() + +
+           
+ inthashCode() + +
+           
+ StringtoString() + +
+           
+  + + + + + + + +
Methods inherited from class java.awt.Rectangle
add, add, add, contains, contains, contains, contains, createIntersection, createUnion, getBounds, getBounds2D, getHeight, getLocation, getSize, getWidth, getX, getY, grow, inside, intersection, intersects, isEmpty, move, outcode, reshape, resize, setBounds, setBounds, setLocation, setLocation, setRect, setSize, setSize, translate, union
+  + + + + + + + +
Methods inherited from class java.awt.geom.Rectangle2D
add, add, add, contains, contains, getPathIterator, getPathIterator, intersect, intersects, intersectsLine, intersectsLine, outcode, setFrame, setRect, union
+  + + + + + + + +
Methods inherited from class java.awt.geom.RectangularShape
clone, contains, contains, getCenterX, getCenterY, getFrame, getMaxX, getMaxY, getMinX, getMinY, intersects, setFrame, setFrame, setFrameFromCenter, setFrameFromCenter, setFrameFromDiagonal, setFrameFromDiagonal
+  + + + + + + + +
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
+  + + + + + + + +
Methods inherited from interface java.awt.Shape
contains, contains, contains, contains, getPathIterator, getPathIterator, intersects, intersects
+  +

+ + + + + + + + +
+Field Detail
+ +

+clusterOid

+
+public int clusterOid
+
+
A unique identifier for this cluster (also the distributed object + id of the cluster chat object). +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+Cluster

+
+public Cluster()
+
+
+ + + + + + + + +
+Method Detail
+ +

+getKey

+
+public Comparable<?> getKey()
+
+
+
Specified by:
getKey in interface com.threerings.presents.dobj.DSet.Entry
+
+
+
+
+
+
+ +

+equals

+
+public boolean equals(Object other)
+
+
+
Overrides:
equals in class Rectangle
+
+
+
+
+
+
+ +

+hashCode

+
+public int hashCode()
+
+
+
Overrides:
hashCode in class Rectangle2D
+
+
+
+
+
+
+ +

+toString

+
+public String toString()
+
+
+
Overrides:
toString in class Rectangle
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/data/ClusterObject.html b/apidocs/com/threerings/whirled/spot/data/ClusterObject.html new file mode 100644 index 00000000..ba92fbb8 --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/data/ClusterObject.html @@ -0,0 +1,417 @@ + + + + + + + +ClusterObject (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.spot.data +
+Class ClusterObject

+
+java.lang.Object
+  extended by com.threerings.presents.dobj.DObject
+      extended by com.threerings.whirled.spot.data.ClusterObject
+
+
+
All Implemented Interfaces:
com.threerings.crowd.chat.data.SpeakObject, com.threerings.io.Streamable
+
+
+
+
public class ClusterObject
extends com.threerings.presents.dobj.DObject
implements com.threerings.crowd.chat.data.SpeakObject
+ + +

+Used to dispatch chat in clusters. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.crowd.chat.data.SpeakObject
com.threerings.crowd.chat.data.SpeakObject.ListenerOp
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + + + + + +
+Field Summary
+ com.threerings.presents.dobj.OidListoccupants + +
+          Tracks the oid of the body objects that occupy this cluster.
+static StringOCCUPANTS + +
+          The field name of the occupants field.
+  + + + + + + + + + + +
+Constructor Summary
ClusterObject() + +
+           
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidaddToOccupants(int oid) + +
+          Requests that oid be added to the occupants + oid list.
+ voidapplyToListeners(com.threerings.crowd.chat.data.SpeakObject.ListenerOp op) + +
+           
+ voidremoveFromOccupants(int oid) + +
+          Requests that oid be removed from the + occupants oid list.
+  + + + + + + + +
Methods inherited from class com.threerings.presents.dobj.DObject
acquireLock, addListener, addListener, addSubscriber, addToSet, cancelTransaction, changeAttribute, checkPermissions, checkPermissions, commitTransaction, destroy, getAccessController, getAttribute, getLocal, getLocals, getManager, getOid, getSet, inTransaction, isActive, notifyListeners, notifyProxies, postEvent, postMessage, postMessage, readField__oid, releaseLock, removeFromSet, removeListener, removeSubscriber, setAccessController, setAttribute, setDestroyOnLastSubscriberRemoved, setLocal, setManager, setOid, startTransaction, toString, updateSet, which, writeField__oid
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+OCCUPANTS

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public static final String OCCUPANTS
+
+
The field name of the occupants field. +

+

+
See Also:
Constant Field Values
+
+
+ +

+occupants

+
+public com.threerings.presents.dobj.OidList occupants
+
+
Tracks the oid of the body objects that occupy this cluster. +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+ClusterObject

+
+public ClusterObject()
+
+
+ + + + + + + + +
+Method Detail
+ +

+applyToListeners

+
+public void applyToListeners(com.threerings.crowd.chat.data.SpeakObject.ListenerOp op)
+
+
+
Specified by:
applyToListeners in interface com.threerings.crowd.chat.data.SpeakObject
+
+
+
+
+
+
+ +

+addToOccupants

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public void addToOccupants(int oid)
+
+
Requests that oid be added to the occupants + oid list. The list will not change until the event is actually + propagated through the system. +

+

+
+
+
+
+
+
+
+ +

+removeFromOccupants

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public void removeFromOccupants(int oid)
+
+
Requests that oid be removed from the + occupants oid list. The list will not change until the + event is actually propagated through the system. +

+

+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/data/ClusteredBodyObject.html b/apidocs/com/threerings/whirled/spot/data/ClusteredBodyObject.html new file mode 100644 index 00000000..52924ee4 --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/data/ClusteredBodyObject.html @@ -0,0 +1,256 @@ + + + + + + + +ClusteredBodyObject (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.spot.data +
+Interface ClusteredBodyObject

+
+
+
public interface ClusteredBodyObject
+ + +

+Defines some required methods for a BodyObject that is to participate in the Whirled + Spot system. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ StringgetClusterField() + +
+          Returns the field name of the cluster oid distributed object field.
+ intgetClusterOid() + +
+          Returns the oid of the cluster to which this user currently belongs.
+ voidsetClusterOid(int clusterOid) + +
+          Sets the oid of the cluster to which this user currently belongs.
+  +

+ + + + + + + + +
+Method Detail
+ +

+getClusterField

+
+String getClusterField()
+
+
Returns the field name of the cluster oid distributed object field. +

+

+
+
+
+
+ +

+getClusterOid

+
+int getClusterOid()
+
+
Returns the oid of the cluster to which this user currently belongs. +

+

+
+
+
+
+ +

+setClusterOid

+
+void setClusterOid(int clusterOid)
+
+
Sets the oid of the cluster to which this user currently belongs. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/data/Location.html b/apidocs/com/threerings/whirled/spot/data/Location.html new file mode 100644 index 00000000..97a49a5f --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/data/Location.html @@ -0,0 +1,339 @@ + + + + + + + +Location (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.spot.data +
+Interface Location

+
+
All Superinterfaces:
Cloneable, com.threerings.io.Streamable
+
+
+
All Known Implementing Classes:
StageLocation
+
+
+
+
public interface Location
extends com.threerings.io.Streamable, Cloneable
+ + +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ Locationclone() + +
+          Locations are cloneable.
+ booleanequals(Object other) + +
+          Two locations are equals if they specify the same coordinates, but + the orientation may be different.
+ booleanequivalent(Location other) + +
+          Two locations are equivalent if they specify the same location + and orientation.
+ LocationgetOpposite() + +
+          Get a new Location instance that is equals() to this one but that + has an orientation facing the opposite direction.
+ inthashCode() + +
+          The hashcode of a Location should be based only on its coordinates.
+  +

+ + + + + + + + +
+Method Detail
+ +

+getOpposite

+
+Location getOpposite()
+
+
Get a new Location instance that is equals() to this one but that + has an orientation facing the opposite direction. +

+

+
+
+
+
+
+
+
+ +

+equivalent

+
+boolean equivalent(Location other)
+
+
Two locations are equivalent if they specify the same location + and orientation. +

+

+
+
+
+
+
+
+
+ +

+equals

+
+boolean equals(Object other)
+
+
Two locations are equals if they specify the same coordinates, but + the orientation may be different. +

+

+
Overrides:
equals in class Object
+
+
+
+
+
+
+ +

+hashCode

+
+int hashCode()
+
+
The hashcode of a Location should be based only on its coordinates. +

+

+
Overrides:
hashCode in class Object
+
+
+
+
+
+
+ +

+clone

+
+Location clone()
+
+
Locations are cloneable. +

+

+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/data/ModifyPortalsUpdate.html b/apidocs/com/threerings/whirled/spot/data/ModifyPortalsUpdate.html new file mode 100644 index 00000000..2f8dc7c9 --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/data/ModifyPortalsUpdate.html @@ -0,0 +1,381 @@ + + + + + + + +ModifyPortalsUpdate (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.spot.data +
+Class ModifyPortalsUpdate

+
+java.lang.Object
+  extended by com.threerings.whirled.data.SceneUpdate
+      extended by com.threerings.whirled.spot.data.ModifyPortalsUpdate
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable, Cloneable
+
+
+
+
public class ModifyPortalsUpdate
extends SceneUpdate
+ + +

+A scene update to add/remove portals. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + + + + + +
+Field Summary
+ Portal[]portalsAdded + +
+          The portals to be added to the scene.
+ Portal[]portalsRemoved + +
+          The portals to be removed from the room.
+  + + + + + + + + + + +
+Constructor Summary
ModifyPortalsUpdate() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ voidapply(SceneModel model) + +
+          Applies this update to the specified scene model.
+ voidinitialize(int targetId, + int targetVersion, + Portal[] removed, + Portal[] added) + +
+          Initialize the update with all necessary data.
+  + + + + + + + +
Methods inherited from class com.threerings.whirled.data.SceneUpdate
getSceneId, getSceneVersion, getVersionIncrement, init, persistTo, readObject, toString, unpersistFrom, validate, writeObject
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+portalsRemoved

+
+public Portal[] portalsRemoved
+
+
The portals to be removed from the room. +

+

+
+
+
+ +

+portalsAdded

+
+public Portal[] portalsAdded
+
+
The portals to be added to the scene. +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+ModifyPortalsUpdate

+
+public ModifyPortalsUpdate()
+
+
+ + + + + + + + +
+Method Detail
+ +

+initialize

+
+public void initialize(int targetId,
+                       int targetVersion,
+                       Portal[] removed,
+                       Portal[] added)
+
+
Initialize the update with all necessary data. +

+

+
+
+
+
+ +

+apply

+
+public void apply(SceneModel model)
+
+
Description copied from class: SceneUpdate
+
Applies this update to the specified scene model. Derived classes will want to override this + method and apply updates of their own, being sure to call super.apply. +

+

+
Overrides:
apply in class SceneUpdate
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/data/Portal.html b/apidocs/com/threerings/whirled/spot/data/Portal.html new file mode 100644 index 00000000..e4ae315a --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/data/Portal.html @@ -0,0 +1,537 @@ + + + + + + + +Portal (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.spot.data +
+Class Portal

+
+java.lang.Object
+  extended by com.threerings.io.SimpleStreamableObject
+      extended by com.threerings.whirled.spot.data.Portal
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable, Cloneable
+
+
+
Direct Known Subclasses:
EditablePortal
+
+
+
+
public class Portal
extends com.threerings.io.SimpleStreamableObject
implements Cloneable
+ + +

+Represents an exit to another scene. A body sprite would walk over to a + portal's coordinates and then either proceed off of the edge of the + display, or open a door and walk through it, or fizzle away in a Star + Trekkian transporter style or whatever is appropriate for the game in + question. It contains information on the scene to which the body exits + when using this portal and the location at which the body sprite should + appear in that target scene. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+ Locationloc + +
+          The location of the portal.
+ shortportalId + +
+          This portal's unique identifier.
+ shorttargetPortalId + +
+          The portal identifier of the portal at which a body will enter + the target scene when they "use" this portal, or -1 to specify + that the body enters on the default portal, whatever id it is.
+ inttargetSceneId + +
+          The scene identifier of the scene to which a body will exit when + they "use" this portal.
+  + + + + + + + + + + +
+Constructor Summary
Portal() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ Portalclone() + +
+           
+ booleanequals(Object other) + +
+          Portal equality is determined by portal id.
+ LocationgetLocation() + +
+          Returns a location instance configured with the location and + orientation of this portal.
+ LocationgetOppLocation() + +
+          Returns a location instance configured with the location and + opposite orientation of this portal.
+ inthashCode() + +
+          Computes a reasonable hashcode for portal instances.
+ booleanisValid() + +
+          Returns true if the portal has a potentially valid target scene and + portal id (they are not guaranteed to exist, but they are at least + potentially valid values rather than -1 or 0).
+  + + + + + + + +
Methods inherited from class com.threerings.io.SimpleStreamableObject
toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+portalId

+
+public short portalId
+
+
This portal's unique identifier. +

+

+
+
+
+ +

+loc

+
+public Location loc
+
+
The location of the portal. + This field is present on client and server, it is streamed specially. +

+

+
+
+
+ +

+targetSceneId

+
+public int targetSceneId
+
+
The scene identifier of the scene to which a body will exit when + they "use" this portal. +

+

+
+
+
+ +

+targetPortalId

+
+public short targetPortalId
+
+
The portal identifier of the portal at which a body will enter + the target scene when they "use" this portal, or -1 to specify + that the body enters on the default portal, whatever id it is. +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+Portal

+
+public Portal()
+
+
+ + + + + + + + +
+Method Detail
+ +

+getLocation

+
+public Location getLocation()
+
+
Returns a location instance configured with the location and + orientation of this portal. +

+

+
+
+
+
+
+
+
+ +

+getOppLocation

+
+public Location getOppLocation()
+
+
Returns a location instance configured with the location and + opposite orientation of this portal. This is useful for when a body + is entering a scene at a portal and we want them to face the + opposite direction (as they are entering via the portal rather than + leaving, which is the natural "orientation" of a portal). +

+

+
+
+
+
+
+
+
+ +

+isValid

+
+public boolean isValid()
+
+
Returns true if the portal has a potentially valid target scene and + portal id (they are not guaranteed to exist, but they are at least + potentially valid values rather than -1 or 0). +

+

+
+
+
+
+
+
+
+ +

+clone

+
+public Portal clone()
+
+
+
Overrides:
clone in class Object
+
+
+
+
+
+
+ +

+equals

+
+public boolean equals(Object other)
+
+
Portal equality is determined by portal id. +

+

+
Overrides:
equals in class Object
+
+
+
+
+
+
+ +

+hashCode

+
+public int hashCode()
+
+
Computes a reasonable hashcode for portal instances. +

+

+
Overrides:
hashCode in class Object
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/data/SceneLocation.html b/apidocs/com/threerings/whirled/spot/data/SceneLocation.html new file mode 100644 index 00000000..1e6c004d --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/data/SceneLocation.html @@ -0,0 +1,415 @@ + + + + + + + +SceneLocation (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.spot.data +
+Class SceneLocation

+
+java.lang.Object
+  extended by com.threerings.io.SimpleStreamableObject
+      extended by com.threerings.whirled.spot.data.SceneLocation
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable, com.threerings.presents.dobj.DSet.Entry
+
+
+
+
public class SceneLocation
extends com.threerings.io.SimpleStreamableObject
implements com.threerings.presents.dobj.DSet.Entry
+ + +

+Extends Location with the data and functionality needed to + represent a particular user's location in a scene. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + + + + + +
+Field Summary
+ intbodyOid + +
+          The oid of the body that occupies this location.
+ Locationloc + +
+          The actual location, which is interpreted by the display system.
+  + + + + + + + + + + + + + +
+Constructor Summary
SceneLocation() + +
+          Creates a blank instance suitable for unserialization.
SceneLocation(Location loc, + int bodyOid) + +
+          Creates a scene location with the specified information.
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ booleanequals(Object other) + +
+           
+ Comparable<?>getKey() + +
+           
+ inthashCode() + +
+           
+  + + + + + + + +
Methods inherited from class com.threerings.io.SimpleStreamableObject
toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+bodyOid

+
+public int bodyOid
+
+
The oid of the body that occupies this location. +

+

+
+
+
+ +

+loc

+
+public Location loc
+
+
The actual location, which is interpreted by the display system. +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+SceneLocation

+
+public SceneLocation(Location loc,
+                     int bodyOid)
+
+
Creates a scene location with the specified information. +

+

+
+ +

+SceneLocation

+
+public SceneLocation()
+
+
Creates a blank instance suitable for unserialization. +

+

+ + + + + + + + +
+Method Detail
+ +

+getKey

+
+public Comparable<?> getKey()
+
+
+
Specified by:
getKey in interface com.threerings.presents.dobj.DSet.Entry
+
+
+
+
+
+
+ +

+equals

+
+public boolean equals(Object other)
+
+
+
Overrides:
equals in class Object
+
+
+
+
+
+
+ +

+hashCode

+
+public int hashCode()
+
+
+
Overrides:
hashCode in class Object
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/data/SpotCodes.html b/apidocs/com/threerings/whirled/spot/data/SpotCodes.html new file mode 100644 index 00000000..51436886 --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/data/SpotCodes.html @@ -0,0 +1,362 @@ + + + + + + + +SpotCodes (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.spot.data +
+Interface SpotCodes

+
+
All Superinterfaces:
com.threerings.crowd.chat.data.ChatCodes, com.threerings.presents.data.InvocationCodes, com.threerings.crowd.data.LocationCodes, SceneCodes
+
+
+
All Known Implementing Classes:
SpotSceneDirector, SpotSceneManager, StageSceneManager
+
+
+
+
public interface SpotCodes
extends com.threerings.crowd.chat.data.ChatCodes, SceneCodes
+ + +

+Contains codes used by the Spot invocation services. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static StringCLUSTER_CHAT_TYPE + +
+          The chat type code with which we register our cluster auxiliary + chat objects.
+static StringCLUSTER_FULL + +
+          An error code indicating that a cluster is full.
+static StringINVALID_LOCATION + +
+          An error code indicating that a location is not valid.
+static StringLOCATION_OCCUPIED + +
+          An error code indicating that a location is occupied.
+static StringNO_SUCH_CLUSTER + +
+          An error code indicating that a cluster is not valid.
+static StringNO_SUCH_PORTAL + +
+          An error code indicating that the portal specified in a + traversePortal request does not exist.
+  + + + + + + + +
Fields inherited from interface com.threerings.crowd.chat.data.ChatCodes
BROADCAST_ACCESS, BROADCAST_MODE, CHAT_ACCESS, CHAT_CHANNEL_NOTIFICATION, CHAT_NOTIFICATION, DEFAULT_IDLE_TIME, DEFAULT_MODE, EMOTE_MODE, IDLE_TIME_KEY, LAST_MODE, PLACE_CHAT_TYPE, SHOUT_MODE, SUCCESS, THINK_MODE, USER_CHAT_TYPE, USER_DISCONNECTED, USER_NOT_ONLINE, XLATE_MODES
+  + + + + + + + +
Fields inherited from interface com.threerings.whirled.data.SceneCodes
SCENE_UPDATE, WHIRLED_GROUP
+  + + + + + + + +
Fields inherited from interface com.threerings.crowd.data.LocationCodes
ALREADY_THERE, MOVE_IN_PROGRESS, NO_SUCH_PLACE
+  + + + + + + + +
Fields inherited from interface com.threerings.presents.data.InvocationCodes
ACCESS_DENIED, E_ACCESS_DENIED, E_INTERNAL_ERROR, GLOBAL_GROUP, INTERNAL_ERROR
+  +

+ + + + + + + + +
+Field Detail
+ +

+NO_SUCH_PORTAL

+
+static final String NO_SUCH_PORTAL
+
+
An error code indicating that the portal specified in a + traversePortal request does not exist. +

+

+
See Also:
Constant Field Values
+
+
+ +

+LOCATION_OCCUPIED

+
+static final String LOCATION_OCCUPIED
+
+
An error code indicating that a location is occupied. Usually + generated by a failed changeLoc request. +

+

+
See Also:
Constant Field Values
+
+
+ +

+INVALID_LOCATION

+
+static final String INVALID_LOCATION
+
+
An error code indicating that a location is not valid. Usually + generated by a failed changeLoc request. +

+

+
See Also:
Constant Field Values
+
+
+ +

+NO_SUCH_CLUSTER

+
+static final String NO_SUCH_CLUSTER
+
+
An error code indicating that a cluster is not valid. Usually + generated by a failed joinCluster request. +

+

+
See Also:
Constant Field Values
+
+
+ +

+CLUSTER_FULL

+
+static final String CLUSTER_FULL
+
+
An error code indicating that a cluster is full. Usually generated + by a failed joinCluster request. +

+

+
See Also:
Constant Field Values
+
+
+ +

+CLUSTER_CHAT_TYPE

+
+static final String CLUSTER_CHAT_TYPE
+
+
The chat type code with which we register our cluster auxiliary + chat objects. Chat display implementations should interpret chat + messages with this type accordingly. +

+

+
See Also:
Constant Field Values
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/data/SpotMarshaller.SpotSceneMoveMarshaller.html b/apidocs/com/threerings/whirled/spot/data/SpotMarshaller.SpotSceneMoveMarshaller.html new file mode 100644 index 00000000..a3fa714d --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/data/SpotMarshaller.SpotSceneMoveMarshaller.html @@ -0,0 +1,587 @@ + + + + + + + +SpotMarshaller.SpotSceneMoveMarshaller (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.spot.data +
+Class SpotMarshaller.SpotSceneMoveMarshaller

+
+java.lang.Object
+  extended by com.threerings.presents.data.InvocationMarshaller.ListenerMarshaller
+      extended by com.threerings.whirled.spot.data.SpotMarshaller.SpotSceneMoveMarshaller
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable, com.threerings.presents.client.InvocationService.InvocationListener, SceneService.SceneMoveListener, SpotService.SpotSceneMoveListener
+
+
+
Enclosing class:
SpotMarshaller
+
+
+
+
public static class SpotMarshaller.SpotSceneMoveMarshaller
extends com.threerings.presents.data.InvocationMarshaller.ListenerMarshaller
implements SpotService.SpotSceneMoveListener
+ + +

+Marshalls results to implementations of SpotService.SpotSceneMoveListener. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static intMOVE_REQUIRES_SERVER_SWITCH + +
+          The method id used to dispatch moveRequiresServerSwitch(java.lang.String, int[]) + responses.
+static intMOVE_SUCCEEDED + +
+          The method id used to dispatch moveSucceeded(int, com.threerings.crowd.data.PlaceConfig) + responses.
+static intMOVE_SUCCEEDED_WITH_SCENE + +
+          The method id used to dispatch moveSucceededWithScene(int, com.threerings.crowd.data.PlaceConfig, com.threerings.whirled.data.SceneModel) + responses.
+static intMOVE_SUCCEEDED_WITH_UPDATES + +
+          The method id used to dispatch moveSucceededWithUpdates(int, com.threerings.crowd.data.PlaceConfig, com.threerings.whirled.data.SceneUpdate[]) + responses.
+static intREQUEST_CANCELLED + +
+          The method id used to dispatch requestCancelled() + responses.
+  + + + + + + + +
Fields inherited from class com.threerings.presents.data.InvocationMarshaller.ListenerMarshaller
callerOid, listener, mapStamp, omgr, REQUEST_FAILED_RSPID, requestId, transport
+  + + + + + + + + + + +
+Constructor Summary
SpotMarshaller.SpotSceneMoveMarshaller() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voiddispatchResponse(int methodId, + Object[] args) + +
+           
+ voidmoveRequiresServerSwitch(String arg1, + int[] arg2) + +
+          Indicates that the client must switch to the specified server and reissue its move + request in order to relocate to its desired scene.
+ voidmoveSucceeded(int arg1, + com.threerings.crowd.data.PlaceConfig arg2) + +
+          Indicates that a move succeeded.
+ voidmoveSucceededWithScene(int arg1, + com.threerings.crowd.data.PlaceConfig arg2, + SceneModel arg3) + +
+          Indicates that a move succeeded and that the client's cached scene information should be + updated with the supplied data.
+ voidmoveSucceededWithUpdates(int arg1, + com.threerings.crowd.data.PlaceConfig arg2, + SceneUpdate[] arg3) + +
+          Indicates that a move succeeded and that the client's cached scene information should be + updated with the supplied data.
+ voidrequestCancelled() + +
+          The request is not going through because it was cancelled due to some other action.
+  + + + + + + + +
Methods inherited from class com.threerings.presents.data.InvocationMarshaller.ListenerMarshaller
requestFailed, setInvocationId, setNoResponse, toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  + + + + + + + +
Methods inherited from interface com.threerings.presents.client.InvocationService.InvocationListener
requestFailed
+  +

+ + + + + + + + +
+Field Detail
+ +

+MOVE_REQUIRES_SERVER_SWITCH

+
+public static final int MOVE_REQUIRES_SERVER_SWITCH
+
+
The method id used to dispatch moveRequiresServerSwitch(java.lang.String, int[]) + responses. +

+

+
See Also:
Constant Field Values
+
+
+ +

+MOVE_SUCCEEDED

+
+public static final int MOVE_SUCCEEDED
+
+
The method id used to dispatch moveSucceeded(int, com.threerings.crowd.data.PlaceConfig) + responses. +

+

+
See Also:
Constant Field Values
+
+
+ +

+MOVE_SUCCEEDED_WITH_SCENE

+
+public static final int MOVE_SUCCEEDED_WITH_SCENE
+
+
The method id used to dispatch moveSucceededWithScene(int, com.threerings.crowd.data.PlaceConfig, com.threerings.whirled.data.SceneModel) + responses. +

+

+
See Also:
Constant Field Values
+
+
+ +

+MOVE_SUCCEEDED_WITH_UPDATES

+
+public static final int MOVE_SUCCEEDED_WITH_UPDATES
+
+
The method id used to dispatch moveSucceededWithUpdates(int, com.threerings.crowd.data.PlaceConfig, com.threerings.whirled.data.SceneUpdate[]) + responses. +

+

+
See Also:
Constant Field Values
+
+
+ +

+REQUEST_CANCELLED

+
+public static final int REQUEST_CANCELLED
+
+
The method id used to dispatch requestCancelled() + responses. +

+

+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Constructor Detail
+ +

+SpotMarshaller.SpotSceneMoveMarshaller

+
+public SpotMarshaller.SpotSceneMoveMarshaller()
+
+
+ + + + + + + + +
+Method Detail
+ +

+moveRequiresServerSwitch

+
+public void moveRequiresServerSwitch(String arg1,
+                                     int[] arg2)
+
+
Description copied from interface: SceneService.SceneMoveListener
+
Indicates that the client must switch to the specified server and reissue its move + request in order to relocate to its desired scene. +

+

+
Specified by:
moveRequiresServerSwitch in interface SceneService.SceneMoveListener
+
+
+
+
+
+
+ +

+moveSucceeded

+
+public void moveSucceeded(int arg1,
+                          com.threerings.crowd.data.PlaceConfig arg2)
+
+
Description copied from interface: SceneService.SceneMoveListener
+
Indicates that a move succeeded. +

+

+
Specified by:
moveSucceeded in interface SceneService.SceneMoveListener
+
+
+
Parameters:
arg1 - the place object id of the newly occupied scene.
arg2 - metadata related to the newly occupied scene.
+
+
+
+ +

+moveSucceededWithScene

+
+public void moveSucceededWithScene(int arg1,
+                                   com.threerings.crowd.data.PlaceConfig arg2,
+                                   SceneModel arg3)
+
+
Description copied from interface: SceneService.SceneMoveListener
+
Indicates that a move succeeded and that the client's cached scene information should be + updated with the supplied data. +

+

+
Specified by:
moveSucceededWithScene in interface SceneService.SceneMoveListener
+
+
+
Parameters:
arg1 - the place object id of the newly occupied scene.
arg2 - metadata related to the newly occupied scene.
arg3 - a fresh copy of the most recent scene data for the newly occupied scene.
+
+
+
+ +

+moveSucceededWithUpdates

+
+public void moveSucceededWithUpdates(int arg1,
+                                     com.threerings.crowd.data.PlaceConfig arg2,
+                                     SceneUpdate[] arg3)
+
+
Description copied from interface: SceneService.SceneMoveListener
+
Indicates that a move succeeded and that the client's cached scene information should be + updated with the supplied data. +

+

+
Specified by:
moveSucceededWithUpdates in interface SceneService.SceneMoveListener
+
+
+
Parameters:
arg1 - the place object id of the newly occupied scene.
arg2 - metadata related to the newly occupied scene.
arg3 - updates that must be applied to the client's copy of a scene model to + bring it up to date.
+
+
+
+ +

+requestCancelled

+
+public void requestCancelled()
+
+
Description copied from interface: SpotService.SpotSceneMoveListener
+
The request is not going through because it was cancelled due to some other action. +

+

+
Specified by:
requestCancelled in interface SpotService.SpotSceneMoveListener
+
+
+
+
+
+
+ +

+dispatchResponse

+
+public void dispatchResponse(int methodId,
+                             Object[] args)
+
+
+
Overrides:
dispatchResponse in class com.threerings.presents.data.InvocationMarshaller.ListenerMarshaller
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/data/SpotMarshaller.html b/apidocs/com/threerings/whirled/spot/data/SpotMarshaller.html new file mode 100644 index 00000000..afb4c5bc --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/data/SpotMarshaller.html @@ -0,0 +1,538 @@ + + + + + + + +SpotMarshaller (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.spot.data +
+Class SpotMarshaller

+
+java.lang.Object
+  extended by com.threerings.presents.data.InvocationMarshaller
+      extended by com.threerings.whirled.spot.data.SpotMarshaller
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable, com.threerings.presents.client.InvocationService, SpotService
+
+
+
+
@Generated(value="com.threerings.presents.tools.GenServiceTask",
+           comments="Derived from SpotService.java.")
+public class SpotMarshaller
extends com.threerings.presents.data.InvocationMarshaller
implements SpotService
+ + +

+Provides the implementation of the SpotService interface + that marshalls the arguments and delivers the request to the provider + on the server. Also provides an implementation of the response listener + interfaces that marshall the response arguments and deliver them back + to the requesting client. +

+ +

+

+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static classSpotMarshaller.SpotSceneMoveMarshaller + +
+          Marshalls results to implementations of SpotService.SpotSceneMoveListener.
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.presents.data.InvocationMarshaller
com.threerings.presents.data.InvocationMarshaller.ConfirmMarshaller, com.threerings.presents.data.InvocationMarshaller.ListenerMarshaller, com.threerings.presents.data.InvocationMarshaller.ResultMarshaller
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.whirled.spot.client.SpotService
SpotService.SpotSceneMoveListener
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.presents.client.InvocationService
com.threerings.presents.client.InvocationService.ConfirmListener, com.threerings.presents.client.InvocationService.InvocationListener, com.threerings.presents.client.InvocationService.ResultListener
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static intCHANGE_LOCATION + +
+          The method id used to dispatch changeLocation(int, com.threerings.whirled.spot.data.Location, com.threerings.presents.client.InvocationService.ConfirmListener) requests.
+static intCLUSTER_SPEAK + +
+          The method id used to dispatch clusterSpeak(java.lang.String, byte) requests.
+static intJOIN_CLUSTER + +
+          The method id used to dispatch joinCluster(int, com.threerings.presents.client.InvocationService.ConfirmListener) requests.
+static intTRAVERSE_PORTAL + +
+          The method id used to dispatch traversePortal(int, int, int, com.threerings.whirled.spot.client.SpotService.SpotSceneMoveListener) requests.
+  + + + + + + + + + + +
+Constructor Summary
SpotMarshaller() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidchangeLocation(int arg1, + Location arg2, + com.threerings.presents.client.InvocationService.ConfirmListener arg3) + +
+          Requests that this client's body be made to move to the specified + location.
+ voidclusterSpeak(String arg1, + byte arg2) + +
+          Requests that the supplied message be delivered to listeners in the + cluster to which the specified location belongs.
+ voidjoinCluster(int arg1, + com.threerings.presents.client.InvocationService.ConfirmListener arg2) + +
+          Requests that this client start or join the specified cluster.
+ voidtraversePortal(int arg1, + int arg2, + int arg3, + SpotService.SpotSceneMoveListener arg4) + +
+          Requests to traverse the specified portal.
+  + + + + + + + +
Methods inherited from class com.threerings.presents.data.InvocationMarshaller
getInvocationCode, init, readField__invCode, readField__invOid, readObject, setInvocationOid, setNoResponse, toString, writeField__invCode, writeField__invOid
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+CHANGE_LOCATION

+
+public static final int CHANGE_LOCATION
+
+
The method id used to dispatch changeLocation(int, com.threerings.whirled.spot.data.Location, com.threerings.presents.client.InvocationService.ConfirmListener) requests. +

+

+
See Also:
Constant Field Values
+
+
+ +

+CLUSTER_SPEAK

+
+public static final int CLUSTER_SPEAK
+
+
The method id used to dispatch clusterSpeak(java.lang.String, byte) requests. +

+

+
See Also:
Constant Field Values
+
+
+ +

+JOIN_CLUSTER

+
+public static final int JOIN_CLUSTER
+
+
The method id used to dispatch joinCluster(int, com.threerings.presents.client.InvocationService.ConfirmListener) requests. +

+

+
See Also:
Constant Field Values
+
+
+ +

+TRAVERSE_PORTAL

+
+public static final int TRAVERSE_PORTAL
+
+
The method id used to dispatch traversePortal(int, int, int, com.threerings.whirled.spot.client.SpotService.SpotSceneMoveListener) requests. +

+

+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Constructor Detail
+ +

+SpotMarshaller

+
+public SpotMarshaller()
+
+
+ + + + + + + + +
+Method Detail
+ +

+changeLocation

+
+public void changeLocation(int arg1,
+                           Location arg2,
+                           com.threerings.presents.client.InvocationService.ConfirmListener arg3)
+
+
Description copied from interface: SpotService
+
Requests that this client's body be made to move to the specified + location. The user will be removed from any cluster from which they + are an occupant. +

+

+
Specified by:
changeLocation in interface SpotService
+
+
+
Parameters:
arg1 - the id of the scene in which to change location.
arg2 - the location to which to move.
+
+
+
+ +

+clusterSpeak

+
+public void clusterSpeak(String arg1,
+                         byte arg2)
+
+
Description copied from interface: SpotService
+
Requests that the supplied message be delivered to listeners in the + cluster to which the specified location belongs. +

+

+
Specified by:
clusterSpeak in interface SpotService
+
+
+
Parameters:
arg1 - the text of the message to be spoken.
arg2 - an associated mode constant that can be used to + identify different kinds of "speech" (emote, thought bubble, etc.).
+
+
+
+ +

+joinCluster

+
+public void joinCluster(int arg1,
+                        com.threerings.presents.client.InvocationService.ConfirmListener arg2)
+
+
Description copied from interface: SpotService
+
Requests that this client start or join the specified cluster. They + will be relocated appropriately by the scene manager. +

+

+
Specified by:
joinCluster in interface SpotService
+
+
+
Parameters:
arg1 - the bodyOid of another user or the oid of an + existing cluster; the calling user will be made to join the cluster + or target user's cluster, or create a cluster with the target user + if they are not already in one.
+
+
+
+ +

+traversePortal

+
+public void traversePortal(int arg1,
+                           int arg2,
+                           int arg3,
+                           SpotService.SpotSceneMoveListener arg4)
+
+
Description copied from interface: SpotService
+
Requests to traverse the specified portal. +

+

+
Specified by:
traversePortal in interface SpotService
+
+
+
Parameters:
arg1 - the player's current scene which is used to sanity + check things when the request actually arrives.
arg2 - the portal to be traversed.
arg3 - the version of the destination scene data that + the client has in its local repository.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/data/SpotScene.html b/apidocs/com/threerings/whirled/spot/data/SpotScene.html new file mode 100644 index 00000000..4e4f7e10 --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/data/SpotScene.html @@ -0,0 +1,372 @@ + + + + + + + +SpotScene (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.spot.data +
+Interface SpotScene

+
+
All Known Implementing Classes:
SpotSceneImpl, StageScene
+
+
+
+
public interface SpotScene
+ + +

+Makes available the spot scene information that the server needs to do its business. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidaddPortal(Portal portal) + +
+          Adds a portal to this scene, immediately making the requisite modifications to the + underlying scene model.
+ PortalgetDefaultEntrance() + +
+          Returns the portal that represents the default entrance to this scene.
+ shortgetNextPortalId() + +
+          Returns the portal id that should be assigned to the next portal added to this scene.
+ PortalgetPortal(int portalId) + +
+          Returns a Portal object for the portal with the specified id or null if no portal + exists with that id.
+ intgetPortalCount() + +
+          Returns the number of portals in this scene.
+ Iterator<Portal>getPortals() + +
+          Returns an iterator over the portals in this scene.
+ voidremovePortal(Portal portal) + +
+          Removes the specified portal from the scene.
+ voidsetDefaultEntrance(Portal portal) + +
+          Sets the default entrance in this scene, immediately making the requisite modifications to + the underlying scene model.
+  +

+ + + + + + + + +
+Method Detail
+ +

+getPortal

+
+Portal getPortal(int portalId)
+
+
Returns a Portal object for the portal with the specified id or null if no portal + exists with that id. +

+

+
+
+
+
+ +

+getPortalCount

+
+int getPortalCount()
+
+
Returns the number of portals in this scene. +

+

+
+
+
+
+ +

+getPortals

+
+Iterator<Portal> getPortals()
+
+
Returns an iterator over the portals in this scene. +

+

+
+
+
+
+ +

+getNextPortalId

+
+short getNextPortalId()
+
+
Returns the portal id that should be assigned to the next portal added to this scene. +

+

+
+
+
+
+ +

+getDefaultEntrance

+
+Portal getDefaultEntrance()
+
+
Returns the portal that represents the default entrance to this scene. If a body enters the + scene at logon time rather than entering from some other scene, this is the portal at which + they would appear. +

+

+
+
+
+
+ +

+addPortal

+
+void addPortal(Portal portal)
+
+
Adds a portal to this scene, immediately making the requisite modifications to the + underlying scene model. The portal id should have already been assigned using the value + obtained from getNextPortalId(). +

+

+
+
+
+
+ +

+removePortal

+
+void removePortal(Portal portal)
+
+
Removes the specified portal from the scene. +

+

+
+
+
+
+ +

+setDefaultEntrance

+
+void setDefaultEntrance(Portal portal)
+
+
Sets the default entrance in this scene, immediately making the requisite modifications to + the underlying scene model. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/data/SpotSceneImpl.html b/apidocs/com/threerings/whirled/spot/data/SpotSceneImpl.html new file mode 100644 index 00000000..06241b9a --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/data/SpotSceneImpl.html @@ -0,0 +1,518 @@ + + + + + + + +SpotSceneImpl (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.spot.data +
+Class SpotSceneImpl

+
+java.lang.Object
+  extended by com.threerings.whirled.spot.data.SpotSceneImpl
+
+
+
All Implemented Interfaces:
SpotScene
+
+
+
+
public class SpotSceneImpl
extends Object
implements SpotScene
+ + +

+An implementation of the SpotScene interface. +

+ +

+

+ +

+ + + + + + + + + + + + + + +
+Constructor Summary
SpotSceneImpl() + +
+          Instantiates a blank scene implementation.
SpotSceneImpl(SpotSceneModel smodel) + +
+          Creates an instance that will obtain data from the supplied spot scene model.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidaddPortal(Portal portal) + +
+          Adds a portal to this scene, immediately making the requisite modifications to the + underlying scene model.
+ PortalgetDefaultEntrance() + +
+          Returns the portal that represents the default entrance to this scene.
+ shortgetNextPortalId() + +
+          Returns the portal id that should be assigned to the next portal added to this scene.
+ PortalgetPortal(int portalId) + +
+          Returns a Portal object for the portal with the specified id or null if no portal + exists with that id.
+ intgetPortalCount() + +
+          Returns the number of portals in this scene.
+ Iterator<Portal>getPortals() + +
+          Returns an iterator over the portals in this scene.
+ voidremovePortal(Portal portal) + +
+          Removes the specified portal from the scene.
+ voidsetDefaultEntrance(Portal portal) + +
+          Sets the default entrance in this scene, immediately making the requisite modifications to + the underlying scene model.
+ voidsetDefaultEntranceId(int defaultEntranceId) + +
+          Used when we're being parsed from an XML scene model.
+ voidupdateReceived() + +
+          This should be called if a scene update was received that caused our underlying scene model + to change.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+SpotSceneImpl

+
+public SpotSceneImpl(SpotSceneModel smodel)
+
+
Creates an instance that will obtain data from the supplied spot scene model. +

+

+
+ +

+SpotSceneImpl

+
+public SpotSceneImpl()
+
+
Instantiates a blank scene implementation. +

+

+ + + + + + + + +
+Method Detail
+ +

+getPortal

+
+public Portal getPortal(int portalId)
+
+
Description copied from interface: SpotScene
+
Returns a Portal object for the portal with the specified id or null if no portal + exists with that id. +

+

+
Specified by:
getPortal in interface SpotScene
+
+
+
+
+
+
+ +

+getPortalCount

+
+public int getPortalCount()
+
+
Description copied from interface: SpotScene
+
Returns the number of portals in this scene. +

+

+
Specified by:
getPortalCount in interface SpotScene
+
+
+
+
+
+
+ +

+getPortals

+
+public Iterator<Portal> getPortals()
+
+
Description copied from interface: SpotScene
+
Returns an iterator over the portals in this scene. +

+

+
Specified by:
getPortals in interface SpotScene
+
+
+
+
+
+
+ +

+getNextPortalId

+
+public short getNextPortalId()
+
+
Description copied from interface: SpotScene
+
Returns the portal id that should be assigned to the next portal added to this scene. +

+

+
Specified by:
getNextPortalId in interface SpotScene
+
+
+
+
+
+
+ +

+getDefaultEntrance

+
+public Portal getDefaultEntrance()
+
+
Description copied from interface: SpotScene
+
Returns the portal that represents the default entrance to this scene. If a body enters the + scene at logon time rather than entering from some other scene, this is the portal at which + they would appear. +

+

+
Specified by:
getDefaultEntrance in interface SpotScene
+
+
+
+
+
+
+ +

+addPortal

+
+public void addPortal(Portal portal)
+
+
Description copied from interface: SpotScene
+
Adds a portal to this scene, immediately making the requisite modifications to the + underlying scene model. The portal id should have already been assigned using the value + obtained from SpotScene.getNextPortalId(). +

+

+
Specified by:
addPortal in interface SpotScene
+
+
+
+
+
+
+ +

+removePortal

+
+public void removePortal(Portal portal)
+
+
Description copied from interface: SpotScene
+
Removes the specified portal from the scene. +

+

+
Specified by:
removePortal in interface SpotScene
+
+
+
+
+
+
+ +

+setDefaultEntranceId

+
+public void setDefaultEntranceId(int defaultEntranceId)
+
+
Used when we're being parsed from an XML scene model. +

+

+
+
+
+
+
+
+
+ +

+setDefaultEntrance

+
+public void setDefaultEntrance(Portal portal)
+
+
Description copied from interface: SpotScene
+
Sets the default entrance in this scene, immediately making the requisite modifications to + the underlying scene model. +

+

+
Specified by:
setDefaultEntrance in interface SpotScene
+
+
+
+
+
+
+ +

+updateReceived

+
+public void updateReceived()
+
+
This should be called if a scene update was received that caused our underlying scene model + to change. +

+

+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/data/SpotSceneModel.html b/apidocs/com/threerings/whirled/spot/data/SpotSceneModel.html new file mode 100644 index 00000000..69e06c3b --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/data/SpotSceneModel.html @@ -0,0 +1,434 @@ + + + + + + + +SpotSceneModel (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.spot.data +
+Class SpotSceneModel

+
+java.lang.Object
+  extended by com.threerings.io.SimpleStreamableObject
+      extended by com.threerings.whirled.spot.data.SpotSceneModel
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable, AuxModel, Cloneable
+
+
+
+
public class SpotSceneModel
extends com.threerings.io.SimpleStreamableObject
implements AuxModel
+ + +

+The spot scene model extends the standard scene model with information on portals. Portals are + referenced by an identifier, unique within the scene and unchanging, so that portals can stably + reference the target portal in the scene to which they connect. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + + + + + +
+Field Summary
+ intdefaultEntranceId + +
+          The portal id of the default entrance to this scene.
+ Portal[]portals + +
+          An array containing all portals in this scene.
+  + + + + + + + + + + +
+Constructor Summary
SpotSceneModel() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidaddPortal(Portal portal) + +
+          Adds a portal to this scene model.
+ SpotSceneModelclone() + +
+          Creates a clone of this auxiliary model.
+static SpotSceneModelgetSceneModel(SceneModel model) + +
+          Locates and returns the SpotSceneModel among the auxiliary scene models associated + with the supplied scene model.
+ voidremovePortal(Portal portal) + +
+          Removes a portal from this model.
+  + + + + + + + +
Methods inherited from class com.threerings.io.SimpleStreamableObject
toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+portals

+
+public Portal[] portals
+
+
An array containing all portals in this scene. +

+

+
+
+
+ +

+defaultEntranceId

+
+public int defaultEntranceId
+
+
The portal id of the default entrance to this scene. If a body enters the scene without + coming from another scene, this is the portal at which they would appear. +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+SpotSceneModel

+
+public SpotSceneModel()
+
+
+ + + + + + + + +
+Method Detail
+ +

+addPortal

+
+public void addPortal(Portal portal)
+
+
Adds a portal to this scene model. +

+

+
+
+
+
+
+
+
+ +

+removePortal

+
+public void removePortal(Portal portal)
+
+
Removes a portal from this model. +

+

+
+
+
+
+
+
+
+ +

+clone

+
+public SpotSceneModel clone()
+                     throws CloneNotSupportedException
+
+
Description copied from interface: AuxModel
+
Creates a clone of this auxiliary model. +

+

+
Specified by:
clone in interface AuxModel
Overrides:
clone in class Object
+
+
+ +
Throws: +
CloneNotSupportedException
+
+
+
+ +

+getSceneModel

+
+public static SpotSceneModel getSceneModel(SceneModel model)
+
+
Locates and returns the SpotSceneModel among the auxiliary scene models associated + with the supplied scene model. null is returned if no spot scene model could + be found. +

+

+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/data/SpotSceneObject.html b/apidocs/com/threerings/whirled/spot/data/SpotSceneObject.html new file mode 100644 index 00000000..f88e4e4e --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/data/SpotSceneObject.html @@ -0,0 +1,625 @@ + + + + + + + +SpotSceneObject (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.spot.data +
+Class SpotSceneObject

+
+java.lang.Object
+  extended by com.threerings.presents.dobj.DObject
+      extended by com.threerings.crowd.data.PlaceObject
+          extended by com.threerings.whirled.data.SceneObject
+              extended by com.threerings.whirled.spot.data.SpotSceneObject
+
+
+
All Implemented Interfaces:
com.threerings.crowd.chat.data.SpeakObject, com.threerings.io.Streamable
+
+
+
Direct Known Subclasses:
StageSceneObject
+
+
+
+
public class SpotSceneObject
extends SceneObject
+ + +

+Extends the SceneObject with information specific to spots. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.crowd.data.PlaceObject
com.threerings.crowd.data.PlaceObject.ManagerCaller
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.crowd.chat.data.SpeakObject
com.threerings.crowd.chat.data.SpeakObject.ListenerOp
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+ com.threerings.presents.dobj.DSet<Cluster>clusters + +
+          Contains information on all Clusters in this scene.
+static StringCLUSTERS + +
+          The field name of the clusters field.
+static StringOCCUPANT_LOCS + +
+          The field name of the occupantLocs field.
+ com.threerings.presents.dobj.DSet<SceneLocation>occupantLocs + +
+          A distributed set containing SceneLocation records for all + occupants of this scene.
+  + + + + + + + +
Fields inherited from class com.threerings.crowd.data.PlaceObject
manager, OCCUPANT_INFO, occupantInfo, occupants, OCCUPANTS, SPEAK_SERVICE, speakService
+  + + + + + + + + + + +
+Constructor Summary
SpotSceneObject() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidaddToClusters(Cluster elem) + +
+          Requests that the specified entry be added to the + clusters set.
+ voidaddToOccupantLocs(SceneLocation elem) + +
+          Requests that the specified entry be added to the + occupantLocs set.
+ voidremoveFromClusters(Comparable<?> key) + +
+          Requests that the entry matching the supplied key be removed from + the clusters set.
+ voidremoveFromOccupantLocs(Comparable<?> key) + +
+          Requests that the entry matching the supplied key be removed from + the occupantLocs set.
+ voidsetClusters(com.threerings.presents.dobj.DSet<Cluster> value) + +
+          Requests that the clusters field be set to the + specified value.
+ voidsetOccupantLocs(com.threerings.presents.dobj.DSet<SceneLocation> value) + +
+          Requests that the occupantLocs field be set to the + specified value.
+ voidupdateClusters(Cluster elem) + +
+          Requests that the specified entry be updated in the + clusters set.
+ voidupdateOccupantLocs(SceneLocation elem) + +
+          Requests that the specified entry be updated in the + occupantLocs set.
+  + + + + + + + +
Methods inherited from class com.threerings.crowd.data.PlaceObject
addToOccupantInfo, addToOccupants, applyToListeners, getOccupantInfo, initManagerCaller, removeFromOccupantInfo, removeFromOccupants, setOccupantInfo, setSpeakService, shouldBroadcast, updateOccupantInfo
+  + + + + + + + +
Methods inherited from class com.threerings.presents.dobj.DObject
acquireLock, addListener, addListener, addSubscriber, addToSet, cancelTransaction, changeAttribute, checkPermissions, checkPermissions, commitTransaction, destroy, getAccessController, getAttribute, getLocal, getLocals, getManager, getOid, getSet, inTransaction, isActive, notifyListeners, notifyProxies, postEvent, postMessage, postMessage, readField__oid, releaseLock, removeFromSet, removeListener, removeSubscriber, setAccessController, setAttribute, setDestroyOnLastSubscriberRemoved, setLocal, setManager, setOid, startTransaction, toString, updateSet, which, writeField__oid
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+OCCUPANT_LOCS

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public static final String OCCUPANT_LOCS
+
+
The field name of the occupantLocs field. +

+

+
See Also:
Constant Field Values
+
+
+ +

+CLUSTERS

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public static final String CLUSTERS
+
+
The field name of the clusters field. +

+

+
See Also:
Constant Field Values
+
+
+ +

+occupantLocs

+
+public com.threerings.presents.dobj.DSet<SceneLocation> occupantLocs
+
+
A distributed set containing SceneLocation records for all + occupants of this scene. +

+

+
+
+
+ +

+clusters

+
+public com.threerings.presents.dobj.DSet<Cluster> clusters
+
+
Contains information on all Clusters in this scene. +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+SpotSceneObject

+
+public SpotSceneObject()
+
+
+ + + + + + + + +
+Method Detail
+ +

+addToOccupantLocs

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public void addToOccupantLocs(SceneLocation elem)
+
+
Requests that the specified entry be added to the + occupantLocs set. The set will not change until the event is + actually propagated through the system. +

+

+
+
+
+
+ +

+removeFromOccupantLocs

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public void removeFromOccupantLocs(Comparable<?> key)
+
+
Requests that the entry matching the supplied key be removed from + the occupantLocs set. The set will not change until the + event is actually propagated through the system. +

+

+
+
+
+
+ +

+updateOccupantLocs

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public void updateOccupantLocs(SceneLocation elem)
+
+
Requests that the specified entry be updated in the + occupantLocs set. The set will not change until the event is + actually propagated through the system. +

+

+
+
+
+
+ +

+setOccupantLocs

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public void setOccupantLocs(com.threerings.presents.dobj.DSet<SceneLocation> value)
+
+
Requests that the occupantLocs field be set to the + specified value. Generally one only adds, updates and removes + entries of a distributed set, but certain situations call for a + complete replacement of the set value. The local value will be + updated immediately and an event will be propagated through the + system to notify all listeners that the attribute did + change. Proxied copies of this object (on clients) will apply the + value change when they received the attribute changed notification. +

+

+
+
+
+
+ +

+addToClusters

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public void addToClusters(Cluster elem)
+
+
Requests that the specified entry be added to the + clusters set. The set will not change until the event is + actually propagated through the system. +

+

+
+
+
+
+ +

+removeFromClusters

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public void removeFromClusters(Comparable<?> key)
+
+
Requests that the entry matching the supplied key be removed from + the clusters set. The set will not change until the + event is actually propagated through the system. +

+

+
+
+
+
+ +

+updateClusters

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public void updateClusters(Cluster elem)
+
+
Requests that the specified entry be updated in the + clusters set. The set will not change until the event is + actually propagated through the system. +

+

+
+
+
+
+ +

+setClusters

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public void setClusters(com.threerings.presents.dobj.DSet<Cluster> value)
+
+
Requests that the clusters field be set to the + specified value. Generally one only adds, updates and removes + entries of a distributed set, but certain situations call for a + complete replacement of the set value. The local value will be + updated immediately and an event will be propagated through the + system to notify all listeners that the attribute did + change. Proxied copies of this object (on clients) will apply the + value change when they received the attribute changed notification. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/data/class-use/Cluster.html b/apidocs/com/threerings/whirled/spot/data/class-use/Cluster.html new file mode 100644 index 00000000..e49e766b --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/data/class-use/Cluster.html @@ -0,0 +1,300 @@ + + + + + + + +Uses of Class com.threerings.whirled.spot.data.Cluster (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.spot.data.Cluster

+
+ + + + + + + + + + + + + + + + + +
+Packages that use Cluster
com.threerings.stage.client  
com.threerings.stage.util  
com.threerings.whirled.spot.data  
+  +

+ + + + + +
+Uses of Cluster in com.threerings.stage.client
+  +

+ + + + + + + + + +
Methods in com.threerings.stage.client with parameters of type Cluster
+ voidStageScenePanel.updateCluster(Cluster cluster, + Rectangle bounds) + +
+          Adds or updates the specified cluster in the view.
+  +

+ + + + + + + + + +
Method parameters in com.threerings.stage.client with type arguments of type Cluster
+ voidStageSceneController.handleClusterClicked(Object source, + Tuple<Cluster,Point> tuple) + +
+          Handles a cluster clicked event.
+  +

+ + + + + +
+Uses of Cluster in com.threerings.stage.util
+  +

+ + + + + + + + + +
Methods in com.threerings.stage.util with parameters of type Cluster
+static List<SceneLocation>StageSceneUtil.getClusterLocs(Cluster cluster) + +
+          Computes a list of the valid locations in this cluster.
+  +

+ + + + + +
+Uses of Cluster in com.threerings.whirled.spot.data
+  +

+ + + + + + + + + +
Fields in com.threerings.whirled.spot.data with type parameters of type Cluster
+ com.threerings.presents.dobj.DSet<Cluster>SpotSceneObject.clusters + +
+          Contains information on all Clusters in this scene.
+  +

+ + + + + + + + + + + + + +
Methods in com.threerings.whirled.spot.data with parameters of type Cluster
+ voidSpotSceneObject.addToClusters(Cluster elem) + +
+          Requests that the specified entry be added to the + clusters set.
+ voidSpotSceneObject.updateClusters(Cluster elem) + +
+          Requests that the specified entry be updated in the + clusters set.
+  +

+ + + + + + + + + +
Method parameters in com.threerings.whirled.spot.data with type arguments of type Cluster
+ voidSpotSceneObject.setClusters(com.threerings.presents.dobj.DSet<Cluster> value) + +
+          Requests that the clusters field be set to the + specified value.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/data/class-use/ClusterObject.html b/apidocs/com/threerings/whirled/spot/data/class-use/ClusterObject.html new file mode 100644 index 00000000..285963ff --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/data/class-use/ClusterObject.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.whirled.spot.data.ClusterObject (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.spot.data.ClusterObject

+
+No usage of com.threerings.whirled.spot.data.ClusterObject +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/data/class-use/ClusteredBodyObject.html b/apidocs/com/threerings/whirled/spot/data/class-use/ClusteredBodyObject.html new file mode 100644 index 00000000..c3b6a893 --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/data/class-use/ClusteredBodyObject.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Interface com.threerings.whirled.spot.data.ClusteredBodyObject (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.whirled.spot.data.ClusteredBodyObject

+
+No usage of com.threerings.whirled.spot.data.ClusteredBodyObject +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/data/class-use/Location.html b/apidocs/com/threerings/whirled/spot/data/class-use/Location.html new file mode 100644 index 00000000..fa5d5132 --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/data/class-use/Location.html @@ -0,0 +1,484 @@ + + + + + + + +Uses of Interface com.threerings.whirled.spot.data.Location (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.whirled.spot.data.Location

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
+Packages that use Location
com.threerings.stage.data  
com.threerings.stage.tools.viewer  
com.threerings.whirled.spot.client  
com.threerings.whirled.spot.data  
com.threerings.whirled.spot.server  
+  +

+ + + + + +
+Uses of Location in com.threerings.stage.data
+  +

+ + + + + + + + + +
Classes in com.threerings.stage.data that implement Location
+ classStageLocation + +
+          Contains information on a scene occupant's position and orientation.
+  +

+ + + + + + + + + +
Methods in com.threerings.stage.data that return Location
+ LocationStageLocation.getOpposite() + +
+           
+  +

+ + + + + + + + + +
Methods in com.threerings.stage.data with parameters of type Location
+ booleanStageLocation.equivalent(Location oloc) + +
+          Location equivalence means that the coordinates and orientation are + the same.
+  +

+ + + + + +
+Uses of Location in com.threerings.stage.tools.viewer
+  +

+ + + + + + + + + +
Methods in com.threerings.stage.tools.viewer with parameters of type Location
+ voidViewerScenePanel.setScene(StageScene scene, + Location defloc) + +
+           
+  +

+ + + + + +
+Uses of Location in com.threerings.whirled.spot.client
+  +

+ + + + + + + + + +
Methods in com.threerings.whirled.spot.client that return Location
+ LocationSpotSceneDirector.getIntendedLocation() + +
+          Returns our current location unless we have a location change pending, in which case our + pending location is returned.
+  +

+ + + + + + + + + + + + + +
Methods in com.threerings.whirled.spot.client with parameters of type Location
+ voidSpotService.changeLocation(int sceneId, + Location loc, + com.threerings.presents.client.InvocationService.ConfirmListener listener) + +
+          Requests that this client's body be made to move to the specified + location.
+ voidSpotSceneDirector.changeLocation(Location loc, + ResultListener<Location> listener) + +
+          Issues a request to change our location within the scene to the specified location.
+  +

+ + + + + + + + + +
Method parameters in com.threerings.whirled.spot.client with type arguments of type Location
+ voidSpotSceneDirector.changeLocation(Location loc, + ResultListener<Location> listener) + +
+          Issues a request to change our location within the scene to the specified location.
+  +

+ + + + + +
+Uses of Location in com.threerings.whirled.spot.data
+  +

+ + + + + + + + + + + + + +
Fields in com.threerings.whirled.spot.data declared as Location
+ LocationSceneLocation.loc + +
+          The actual location, which is interpreted by the display system.
+ LocationPortal.loc + +
+          The location of the portal.
+  +

+ + + + + + + + + + + + + + + + + + + + + +
Methods in com.threerings.whirled.spot.data that return Location
+ LocationLocation.clone() + +
+          Locations are cloneable.
+ LocationPortal.getLocation() + +
+          Returns a location instance configured with the location and + orientation of this portal.
+ LocationPortal.getOppLocation() + +
+          Returns a location instance configured with the location and + opposite orientation of this portal.
+ LocationLocation.getOpposite() + +
+          Get a new Location instance that is equals() to this one but that + has an orientation facing the opposite direction.
+  +

+ + + + + + + + + + + + + +
Methods in com.threerings.whirled.spot.data with parameters of type Location
+ voidSpotMarshaller.changeLocation(int arg1, + Location arg2, + com.threerings.presents.client.InvocationService.ConfirmListener arg3) + +
+           
+ booleanLocation.equivalent(Location other) + +
+          Two locations are equivalent if they specify the same location + and orientation.
+  +

+ + + + + + + + +
Constructors in com.threerings.whirled.spot.data with parameters of type Location
SceneLocation(Location loc, + int bodyOid) + +
+          Creates a scene location with the specified information.
+  +

+ + + + + +
+Uses of Location in com.threerings.whirled.spot.server
+  +

+ + + + + + + + + + + + + +
Methods in com.threerings.whirled.spot.server with parameters of type Location
+ voidSpotSceneRegistry.changeLocation(com.threerings.presents.data.ClientObject caller, + int sceneId, + Location loc, + com.threerings.presents.client.InvocationService.ConfirmListener listener) + +
+           
+ voidSpotProvider.changeLocation(com.threerings.presents.data.ClientObject caller, + int arg1, + Location arg2, + com.threerings.presents.client.InvocationService.ConfirmListener arg3) + +
+          Handles a SpotService.changeLocation(int, com.threerings.whirled.spot.data.Location, com.threerings.presents.client.InvocationService.ConfirmListener) request.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/data/class-use/ModifyPortalsUpdate.html b/apidocs/com/threerings/whirled/spot/data/class-use/ModifyPortalsUpdate.html new file mode 100644 index 00000000..5e8d5ae2 --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/data/class-use/ModifyPortalsUpdate.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.whirled.spot.data.ModifyPortalsUpdate (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.spot.data.ModifyPortalsUpdate

+
+No usage of com.threerings.whirled.spot.data.ModifyPortalsUpdate +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/data/class-use/Portal.html b/apidocs/com/threerings/whirled/spot/data/class-use/Portal.html new file mode 100644 index 00000000..7a117c49 --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/data/class-use/Portal.html @@ -0,0 +1,626 @@ + + + + + + + +Uses of Class com.threerings.whirled.spot.data.Portal (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+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
+ PortalStageScenePanel.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
+ PortalStageScene.getDefaultEntrance() + +
+           
+ PortalStageScene.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
+ voidStageScene.addPortal(Portal portal) + +
+           
+ voidStageScene.removePortal(Portal portal) + +
+           
+ voidStageScene.setDefaultEntrance(Portal portal) + +
+           
+  +

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

+ + + + + + + + + +
Methods in com.threerings.stage.tools.editor that return Portal
+ PortalEditorScenePanel.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
+ voidEditorScenePanel.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
+ PortalPortal.clone() + +
+           
+ PortalSpotSceneImpl.getDefaultEntrance() + +
+           
+ PortalSpotScene.getDefaultEntrance() + +
+          Returns the portal that represents the default entrance to this scene.
+ PortalSpotSceneImpl.getPortal(int portalId) + +
+           
+ PortalSpotScene.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
+ voidSpotSceneModel.addPortal(Portal portal) + +
+          Adds a portal to this scene model.
+ voidSpotSceneImpl.addPortal(Portal portal) + +
+           
+ voidSpotScene.addPortal(Portal portal) + +
+          Adds a portal to this scene, immediately making the requisite modifications to the + underlying scene model.
+ voidModifyPortalsUpdate.initialize(int targetId, + int targetVersion, + Portal[] removed, + Portal[] added) + +
+          Initialize the update with all necessary data.
+ voidModifyPortalsUpdate.initialize(int targetId, + int targetVersion, + Portal[] removed, + Portal[] added) + +
+          Initialize the update with all necessary data.
+ voidSpotSceneModel.removePortal(Portal portal) + +
+          Removes a portal from this model.
+ voidSpotSceneImpl.removePortal(Portal portal) + +
+           
+ voidSpotScene.removePortal(Portal portal) + +
+          Removes the specified portal from the scene.
+ voidSpotSceneImpl.setDefaultEntrance(Portal portal) + +
+           
+ voidSpotScene.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
+ voidSpotSceneManager.mapEnteringBody(com.threerings.crowd.data.BodyObject body, + Portal from) + +
+          Assigns a starting location for an entering body.
+ StringSpotSceneManager.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.
+ voidSpotSceneManager.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
+ classEditablePortal + +
+          An editable portal extends the standard portal with information needed + by the loader and editor.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/data/class-use/SceneLocation.html b/apidocs/com/threerings/whirled/spot/data/class-use/SceneLocation.html new file mode 100644 index 00000000..6f23d89e --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/data/class-use/SceneLocation.html @@ -0,0 +1,254 @@ + + + + + + + +Uses of Class com.threerings.whirled.spot.data.SceneLocation (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.spot.data.SceneLocation

+
+ + + + + + + + + + + + + +
+Packages that use SceneLocation
com.threerings.stage.util  
com.threerings.whirled.spot.data  
+  +

+ + + + + +
+Uses of SceneLocation in com.threerings.stage.util
+  +

+ + + + + + + + + +
Methods in com.threerings.stage.util that return types with arguments of type SceneLocation
+static List<SceneLocation>StageSceneUtil.getClusterLocs(Cluster cluster) + +
+          Computes a list of the valid locations in this cluster.
+  +

+ + + + + +
+Uses of SceneLocation in com.threerings.whirled.spot.data
+  +

+ + + + + + + + + +
Fields in com.threerings.whirled.spot.data with type parameters of type SceneLocation
+ com.threerings.presents.dobj.DSet<SceneLocation>SpotSceneObject.occupantLocs + +
+          A distributed set containing SceneLocation records for all + occupants of this scene.
+  +

+ + + + + + + + + + + + + +
Methods in com.threerings.whirled.spot.data with parameters of type SceneLocation
+ voidSpotSceneObject.addToOccupantLocs(SceneLocation elem) + +
+          Requests that the specified entry be added to the + occupantLocs set.
+ voidSpotSceneObject.updateOccupantLocs(SceneLocation elem) + +
+          Requests that the specified entry be updated in the + occupantLocs set.
+  +

+ + + + + + + + + +
Method parameters in com.threerings.whirled.spot.data with type arguments of type SceneLocation
+ voidSpotSceneObject.setOccupantLocs(com.threerings.presents.dobj.DSet<SceneLocation> value) + +
+          Requests that the occupantLocs field be set to the + specified value.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/data/class-use/SpotCodes.html b/apidocs/com/threerings/whirled/spot/data/class-use/SpotCodes.html new file mode 100644 index 00000000..8d7fca70 --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/data/class-use/SpotCodes.html @@ -0,0 +1,241 @@ + + + + + + + +Uses of Interface com.threerings.whirled.spot.data.SpotCodes (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.whirled.spot.data.SpotCodes

+
+ + + + + + + + + + + + + + + + + +
+Packages that use SpotCodes
com.threerings.stage.server  
com.threerings.whirled.spot.client  
com.threerings.whirled.spot.server  
+  +

+ + + + + +
+Uses of SpotCodes in com.threerings.stage.server
+  +

+ + + + + + + + + +
Classes in com.threerings.stage.server that implement SpotCodes
+ classStageSceneManager + +
+          Defines extensions to the basic Stage scene manager specific to displaying isometric "stage" + scenes (these may be indoor, outdoor or aboard a vessel).
+  +

+ + + + + +
+Uses of SpotCodes in com.threerings.whirled.spot.client
+  +

+ + + + + + + + + +
Classes in com.threerings.whirled.spot.client that implement SpotCodes
+ classSpotSceneDirector + +
+          Extends the standard scene director with facilities to move between locations within a scene.
+  +

+ + + + + +
+Uses of SpotCodes in com.threerings.whirled.spot.server
+  +

+ + + + + + + + + +
Classes in com.threerings.whirled.spot.server that implement SpotCodes
+ classSpotSceneManager + +
+          Handles the movement of bodies between locations in the scene and creates the necessary + distributed objects to allow bodies in clusters to chat with one another.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/data/class-use/SpotMarshaller.SpotSceneMoveMarshaller.html b/apidocs/com/threerings/whirled/spot/data/class-use/SpotMarshaller.SpotSceneMoveMarshaller.html new file mode 100644 index 00000000..b84cba25 --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/data/class-use/SpotMarshaller.SpotSceneMoveMarshaller.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.whirled.spot.data.SpotMarshaller.SpotSceneMoveMarshaller (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.spot.data.SpotMarshaller.SpotSceneMoveMarshaller

+
+No usage of com.threerings.whirled.spot.data.SpotMarshaller.SpotSceneMoveMarshaller +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/data/class-use/SpotMarshaller.html b/apidocs/com/threerings/whirled/spot/data/class-use/SpotMarshaller.html new file mode 100644 index 00000000..45af8cce --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/data/class-use/SpotMarshaller.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.whirled.spot.data.SpotMarshaller (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.spot.data.SpotMarshaller

+
+No usage of com.threerings.whirled.spot.data.SpotMarshaller +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/data/class-use/SpotScene.html b/apidocs/com/threerings/whirled/spot/data/class-use/SpotScene.html new file mode 100644 index 00000000..1ab11217 --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/data/class-use/SpotScene.html @@ -0,0 +1,210 @@ + + + + + + + +Uses of Interface com.threerings.whirled.spot.data.SpotScene (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.whirled.spot.data.SpotScene

+
+ + + + + + + + + + + + + +
+Packages that use SpotScene
com.threerings.stage.data  
com.threerings.whirled.spot.data  
+  +

+ + + + + +
+Uses of SpotScene in com.threerings.stage.data
+  +

+ + + + + + + + + +
Classes in com.threerings.stage.data that implement SpotScene
+ classStageScene + +
+          The implementation of the Stage scene interface.
+  +

+ + + + + +
+Uses of SpotScene in com.threerings.whirled.spot.data
+  +

+ + + + + + + + + +
Classes in com.threerings.whirled.spot.data that implement SpotScene
+ classSpotSceneImpl + +
+          An implementation of the SpotScene interface.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/data/class-use/SpotSceneImpl.html b/apidocs/com/threerings/whirled/spot/data/class-use/SpotSceneImpl.html new file mode 100644 index 00000000..7fdc93c3 --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/data/class-use/SpotSceneImpl.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.whirled.spot.data.SpotSceneImpl (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.spot.data.SpotSceneImpl

+
+No usage of com.threerings.whirled.spot.data.SpotSceneImpl +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/data/class-use/SpotSceneModel.html b/apidocs/com/threerings/whirled/spot/data/class-use/SpotSceneModel.html new file mode 100644 index 00000000..c3f6f646 --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/data/class-use/SpotSceneModel.html @@ -0,0 +1,204 @@ + + + + + + + +Uses of Class com.threerings.whirled.spot.data.SpotSceneModel (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.spot.data.SpotSceneModel

+
+ + + + + + + + + +
+Packages that use SpotSceneModel
com.threerings.whirled.spot.data  
+  +

+ + + + + +
+Uses of SpotSceneModel in com.threerings.whirled.spot.data
+  +

+ + + + + + + + + + + + + +
Methods in com.threerings.whirled.spot.data that return SpotSceneModel
+ SpotSceneModelSpotSceneModel.clone() + +
+           
+static SpotSceneModelSpotSceneModel.getSceneModel(SceneModel model) + +
+          Locates and returns the SpotSceneModel among the auxiliary scene models associated + with the supplied scene model.
+  +

+ + + + + + + + +
Constructors in com.threerings.whirled.spot.data with parameters of type SpotSceneModel
SpotSceneImpl(SpotSceneModel smodel) + +
+          Creates an instance that will obtain data from the supplied spot scene model.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/data/class-use/SpotSceneObject.html b/apidocs/com/threerings/whirled/spot/data/class-use/SpotSceneObject.html new file mode 100644 index 00000000..64a16e7d --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/data/class-use/SpotSceneObject.html @@ -0,0 +1,182 @@ + + + + + + + +Uses of Class com.threerings.whirled.spot.data.SpotSceneObject (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.spot.data.SpotSceneObject

+
+ + + + + + + + + +
+Packages that use SpotSceneObject
com.threerings.stage.data  
+  +

+ + + + + +
+Uses of SpotSceneObject in com.threerings.stage.data
+  +

+ + + + + + + + + +
Subclasses of SpotSceneObject in com.threerings.stage.data
+ classStageSceneObject + +
+          Extends the basic SpotSceneObject with data and services + specific to isometric stage scenes.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/data/package-frame.html b/apidocs/com/threerings/whirled/spot/data/package-frame.html new file mode 100644 index 00000000..048e2c53 --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/data/package-frame.html @@ -0,0 +1,68 @@ + + + + + + + +com.threerings.whirled.spot.data (vilya 1.3 API) + + + + + + + + + + + +com.threerings.whirled.spot.data + + + + +
+Interfaces  + +
+ClusteredBodyObject +
+Location +
+SpotCodes +
+SpotScene
+ + + + + + +
+Classes  + +
+Cluster +
+ClusterObject +
+ModifyPortalsUpdate +
+Portal +
+SceneLocation +
+SpotMarshaller +
+SpotMarshaller.SpotSceneMoveMarshaller +
+SpotSceneImpl +
+SpotSceneModel +
+SpotSceneObject
+ + + + diff --git a/apidocs/com/threerings/whirled/spot/data/package-summary.html b/apidocs/com/threerings/whirled/spot/data/package-summary.html new file mode 100644 index 00000000..0b2622ff --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/data/package-summary.html @@ -0,0 +1,224 @@ + + + + + + + +com.threerings.whirled.spot.data (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.whirled.spot.data +

+ + + + + + + + + + + + + + + + + + + + + +
+Interface Summary
ClusteredBodyObjectDefines some required methods for a BodyObject that is to participate in the Whirled + Spot system.
Location 
SpotCodesContains codes used by the Spot invocation services.
SpotSceneMakes available the spot scene information that the server needs to do its business.
+  + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Class Summary
ClusterContains information on clusters.
ClusterObjectUsed to dispatch chat in clusters.
ModifyPortalsUpdateA scene update to add/remove portals.
PortalRepresents an exit to another scene.
SceneLocationExtends Location with the data and functionality needed to + represent a particular user's location in a scene.
SpotMarshallerProvides the implementation of the SpotService interface + that marshalls the arguments and delivers the request to the provider + on the server.
SpotMarshaller.SpotSceneMoveMarshallerMarshalls results to implementations of SpotService.SpotSceneMoveListener.
SpotSceneImplAn implementation of the SpotScene interface.
SpotSceneModelThe spot scene model extends the standard scene model with information on portals.
SpotSceneObjectExtends the SceneObject with information specific to spots.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/data/package-tree.html b/apidocs/com/threerings/whirled/spot/data/package-tree.html new file mode 100644 index 00000000..51b364eb --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/data/package-tree.html @@ -0,0 +1,211 @@ + + + + + + + +com.threerings.whirled.spot.data Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.whirled.spot.data +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/data/package-use.html b/apidocs/com/threerings/whirled/spot/data/package-use.html new file mode 100644 index 00000000..8ccd0121 --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/data/package-use.html @@ -0,0 +1,422 @@ + + + + + + + +Uses of Package com.threerings.whirled.spot.data (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.whirled.spot.data

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Packages that use com.threerings.whirled.spot.data
com.threerings.stage.client  
com.threerings.stage.data  
com.threerings.stage.server  
com.threerings.stage.tools.editor  
com.threerings.stage.tools.viewer  
com.threerings.stage.util  
com.threerings.whirled.spot.client  
com.threerings.whirled.spot.data  
com.threerings.whirled.spot.server  
com.threerings.whirled.spot.tools  
+  +

+ + + + + + + + + + + +
+Classes in com.threerings.whirled.spot.data used by com.threerings.stage.client
Cluster + +
+          Contains information on clusters.
Portal + +
+          Represents an exit to another scene.
+  +

+ + + + + + + + + + + + + + + + + +
+Classes in com.threerings.whirled.spot.data used by com.threerings.stage.data
Location + +
+           
Portal + +
+          Represents an exit to another scene.
SpotScene + +
+          Makes available the spot scene information that the server needs to do its business.
SpotSceneObject + +
+          Extends the SceneObject with information specific to spots.
+  +

+ + + + + + + + +
+Classes in com.threerings.whirled.spot.data used by com.threerings.stage.server
SpotCodes + +
+          Contains codes used by the Spot invocation services.
+  +

+ + + + + + + + +
+Classes in com.threerings.whirled.spot.data used by com.threerings.stage.tools.editor
Portal + +
+          Represents an exit to another scene.
+  +

+ + + + + + + + +
+Classes in com.threerings.whirled.spot.data used by com.threerings.stage.tools.viewer
Location + +
+           
+  +

+ + + + + + + + + + + +
+Classes in com.threerings.whirled.spot.data used by com.threerings.stage.util
Cluster + +
+          Contains information on clusters.
SceneLocation + +
+          Extends Location with the data and functionality needed to + represent a particular user's location in a scene.
+  +

+ + + + + + + + + + + +
+Classes in com.threerings.whirled.spot.data used by com.threerings.whirled.spot.client
Location + +
+           
SpotCodes + +
+          Contains codes used by the Spot invocation services.
+  +

+ + + + + + + + + + + + + + + + + + + + + + + +
+Classes in com.threerings.whirled.spot.data used by com.threerings.whirled.spot.data
Cluster + +
+          Contains information on clusters.
Location + +
+           
Portal + +
+          Represents an exit to another scene.
SceneLocation + +
+          Extends Location with the data and functionality needed to + represent a particular user's location in a scene.
SpotScene + +
+          Makes available the spot scene information that the server needs to do its business.
SpotSceneModel + +
+          The spot scene model extends the standard scene model with information on portals.
+  +

+ + + + + + + + + + + + + + +
+Classes in com.threerings.whirled.spot.data used by com.threerings.whirled.spot.server
Location + +
+           
Portal + +
+          Represents an exit to another scene.
SpotCodes + +
+          Contains codes used by the Spot invocation services.
+  +

+ + + + + + + + +
+Classes in com.threerings.whirled.spot.data used by com.threerings.whirled.spot.tools
Portal + +
+          Represents an exit to another scene.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/package-frame.html b/apidocs/com/threerings/whirled/spot/package-frame.html new file mode 100644 index 00000000..ab2cfa02 --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/package-frame.html @@ -0,0 +1,33 @@ + + + + + + + +com.threerings.whirled.spot (vilya 1.3 API) + + + + + + + + + + + +com.threerings.whirled.spot + + + + +
+Classes  + +
+Log
+ + + + diff --git a/apidocs/com/threerings/whirled/spot/package-summary.html b/apidocs/com/threerings/whirled/spot/package-summary.html new file mode 100644 index 00000000..9fadc789 --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/package-summary.html @@ -0,0 +1,271 @@ + + + + + + + +com.threerings.whirled.spot (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.whirled.spot +

+Extends the Whirled services with the notion of locations, clusters, + coordinates and orientation. +

+See: +
+          Description +

+ + + + + + + + + +
+Class Summary
LogContains a reference to the log object used by the Whirled Spot services.
+  + +

+

+Package com.threerings.whirled.spot Description +

+ +

+Extends the Whirled services with the notion of locations, clusters, + coordinates and orientation. + +

The basic Whirled services facilitate a game that provides a + connected set of scenes and the ability for the bodies to move from + a scene to its neighboring scenes. The Spot package extends those + services by providing the notion of locations within scenes which a + body can occupy and which, while occupied, cannot be occupied by + other bodies. +

+ +

The philosophy is that a game that uses these services wants to + create a constrained universe where a body cannot simply stand + anywhere on the screen, but can only stand in a set of predefined + locations. This is a simplified mechanism for providing finer + grained locality management, such that expensive distance monitoring + algorithms need not be used to determine who can interact (speak) + with others in a particular scene. For many games, the overhead of + tracking each users' position in near-realtime coupled with a + complex message broadcasting system that dispatches messages to + users in geometric proximity to one another is serious overkill and + does not add sufficient value to the game to merit inclusion. +

+ +

Locations and clusters
+ + The Spot package provides a functional approximation in the form of + clusters of locations, with predefined coordinates, that are + sufficiently proximal that bodies in that cluster of locations can + all speak to one another. The locations for a particular scene are + specified in advance which serves the additional purpose of putting + a limit on the number of bodies that can be standing (and + participating) in a particular scene. This puts a natural upper + bound on the amount of network traffic that will be generated by the + need to broadcast scene updates to all occupants of a scene. +

+ +

Locations also serve as entry and exit points for a scene, + providing a means both for the graphical user interface to identify + the location at which bodies enter and exit a scene as well as + providing a spatial context for the connections between scenes + (i.e. the exit to the scene to the north can be located in the + northward part of a scene display). +

+ +

Orientation
+ + Locations define a notion of orientation which is assigned a priori, + along with the coordinates of the location and which can be + interpreted by the graphical display as the direction that body + sprites should face when standing on that location. Clusters of + locations can be constructed such that all of the bodies standing in + that cluster appear to be facing one another which provides visible + reinforcement that members of the cluster can "hear" the + conversation, while members of other clusters cannot. The + orientation of entry and exit locations are also useful in + establishing an initial orientation for a body sprite that enters a + scene based on the visualization of the entrance mechanism (i.e. if + they appear to enter through the door, the body sprite should be + oriented as if it just walked in the proper direction through the + door). +

+ +

Because the Spot services redefine the scope at which speak + messages are normally distributed (the Crowd services would, by + default, have speak messages dispatched to everyone in the entire + scene because the scene is a place and the default chat mechanisms + dispatch speak messages to all occupants of a place), it defines an + additional communication mode known as shouting, which conveys the + message to everyone in the entire scene. +

+ +

Portals
+ + Portals are a combination of locations and the standard Whirled + notion of neighboring scenes. They contain the coordinates to which + a body sprite would traverse prior to exiting to a neighboring scene + (generally so that they appear to walk to whatever visual + representation of the portal is provided by the scene, like a door + or perhaps simply the edge of the scene). Conversely, they represent + the coordinates at which a body arriving from same neighboring scene + would appear in the displayed scene. +

+ +

Example display
+ + This is an example of how these concepts might look in a game + providing top-down 2D display of its scenes.
+

+ +
+ Example scene image +
+ +

The arrows would, of course, not be rendered but are shown to + indicate the presence of locations (and portals) and their + associated orientation information. +

+

+ +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/package-tree.html b/apidocs/com/threerings/whirled/spot/package-tree.html new file mode 100644 index 00000000..75220ac5 --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/package-tree.html @@ -0,0 +1,154 @@ + + + + + + + +com.threerings.whirled.spot Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.whirled.spot +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/package-use.html b/apidocs/com/threerings/whirled/spot/package-use.html new file mode 100644 index 00000000..223816ed --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/package-use.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Package com.threerings.whirled.spot (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.whirled.spot

+
+No usage of com.threerings.whirled.spot +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/server/SpotClient.html b/apidocs/com/threerings/whirled/spot/server/SpotClient.html new file mode 100644 index 00000000..d9ea5d08 --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/server/SpotClient.html @@ -0,0 +1,265 @@ + + + + + + + +SpotClient (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.spot.server +
+Class SpotClient

+
+java.lang.Object
+  extended by com.threerings.presents.server.PresentsSession
+      extended by com.threerings.crowd.server.CrowdSession
+          extended by com.threerings.whirled.server.WhirledSession
+              extended by com.threerings.whirled.spot.server.SpotClient
+
+
+
All Implemented Interfaces:
com.threerings.presents.server.ClientResolutionListener, com.threerings.presents.server.net.PresentsConnection.MessageHandler
+
+
+
+
public class SpotClient
extends WhirledSession
+ + +

+Extends the Whirled client and handles the necessary notifications that take place when a user + logs off to let the clients displaying the scene they were occupying know that they didn't exit + via a portal, but instead just disappeared. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.presents.server.PresentsSession
com.threerings.presents.server.PresentsSession.UserChangeListener
+  + + + + + + + + + + + +
+Constructor Summary
SpotClient() + +
+           
+  + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from class com.threerings.presents.server.PresentsSession
checkExpired, clientResolved, endSession, getAuthName, getClientObject, getCredentials, getInetAddress, getNetworkStamp, getSecret, getSessionStamp, getTimeZone, getTransmitDatagrams, handleMessage, resolutionFailed, setClassLoader, setIncomingMessageThrottle, setUsername, shutdown, toString, updateUsername
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+SpotClient

+
+public SpotClient()
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/server/SpotProvider.html b/apidocs/com/threerings/whirled/spot/server/SpotProvider.html new file mode 100644 index 00000000..cb8dec10 --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/server/SpotProvider.html @@ -0,0 +1,327 @@ + + + + + + + +SpotProvider (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.spot.server +
+Interface SpotProvider

+
+
All Superinterfaces:
com.threerings.presents.server.InvocationProvider
+
+
+
All Known Implementing Classes:
SpotSceneRegistry
+
+
+
+
@Generated(value="com.threerings.presents.tools.GenServiceTask",
+           comments="Derived from SpotService.java.")
+public interface SpotProvider
extends com.threerings.presents.server.InvocationProvider
+ + +

+Defines the server-side of the SpotService. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidchangeLocation(com.threerings.presents.data.ClientObject caller, + int arg1, + Location arg2, + com.threerings.presents.client.InvocationService.ConfirmListener arg3) + +
+          Handles a SpotService.changeLocation(int, com.threerings.whirled.spot.data.Location, com.threerings.presents.client.InvocationService.ConfirmListener) request.
+ voidclusterSpeak(com.threerings.presents.data.ClientObject caller, + String arg1, + byte arg2) + +
+          Handles a SpotService.clusterSpeak(java.lang.String, byte) request.
+ voidjoinCluster(com.threerings.presents.data.ClientObject caller, + int arg1, + com.threerings.presents.client.InvocationService.ConfirmListener arg2) + +
+          Handles a SpotService.joinCluster(int, com.threerings.presents.client.InvocationService.ConfirmListener) request.
+ voidtraversePortal(com.threerings.presents.data.ClientObject caller, + int arg1, + int arg2, + int arg3, + SpotService.SpotSceneMoveListener arg4) + +
+          Handles a SpotService.traversePortal(int, int, int, com.threerings.whirled.spot.client.SpotService.SpotSceneMoveListener) request.
+  +

+ + + + + + + + +
+Method Detail
+ +

+changeLocation

+
+void changeLocation(com.threerings.presents.data.ClientObject caller,
+                    int arg1,
+                    Location arg2,
+                    com.threerings.presents.client.InvocationService.ConfirmListener arg3)
+                    throws com.threerings.presents.server.InvocationException
+
+
Handles a SpotService.changeLocation(int, com.threerings.whirled.spot.data.Location, com.threerings.presents.client.InvocationService.ConfirmListener) request. +

+

+
+
+
+ +
Throws: +
com.threerings.presents.server.InvocationException
+
+
+
+ +

+clusterSpeak

+
+void clusterSpeak(com.threerings.presents.data.ClientObject caller,
+                  String arg1,
+                  byte arg2)
+
+
Handles a SpotService.clusterSpeak(java.lang.String, byte) request. +

+

+
+
+
+
+
+
+
+ +

+joinCluster

+
+void joinCluster(com.threerings.presents.data.ClientObject caller,
+                 int arg1,
+                 com.threerings.presents.client.InvocationService.ConfirmListener arg2)
+                 throws com.threerings.presents.server.InvocationException
+
+
Handles a SpotService.joinCluster(int, com.threerings.presents.client.InvocationService.ConfirmListener) request. +

+

+
+
+
+ +
Throws: +
com.threerings.presents.server.InvocationException
+
+
+
+ +

+traversePortal

+
+void traversePortal(com.threerings.presents.data.ClientObject caller,
+                    int arg1,
+                    int arg2,
+                    int arg3,
+                    SpotService.SpotSceneMoveListener arg4)
+                    throws com.threerings.presents.server.InvocationException
+
+
Handles a SpotService.traversePortal(int, int, int, com.threerings.whirled.spot.client.SpotService.SpotSceneMoveListener) request. +

+

+
+
+
+ +
Throws: +
com.threerings.presents.server.InvocationException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/server/SpotSceneManager.html b/apidocs/com/threerings/whirled/spot/server/SpotSceneManager.html new file mode 100644 index 00000000..b7850343 --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/server/SpotSceneManager.html @@ -0,0 +1,475 @@ + + + + + + + +SpotSceneManager (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.spot.server +
+Class SpotSceneManager

+
+java.lang.Object
+  extended by com.threerings.crowd.server.PlaceManager
+      extended by com.threerings.whirled.server.SceneManager
+          extended by com.threerings.whirled.spot.server.SpotSceneManager
+
+
+
All Implemented Interfaces:
com.threerings.crowd.chat.data.ChatCodes, com.threerings.crowd.chat.server.SpeakHandler.SpeakerValidator, com.threerings.crowd.data.LocationCodes, com.threerings.presents.data.InvocationCodes, com.threerings.presents.dobj.ChangeListener, com.threerings.presents.dobj.MessageListener, SceneCodes, SpotCodes
+
+
+
Direct Known Subclasses:
StageSceneManager
+
+
+
+
public class SpotSceneManager
extends SceneManager
implements SpotCodes
+ + +

+Handles the movement of bodies between locations in the scene and creates the necessary + distributed objects to allow bodies in clusters to chat with one another. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.crowd.server.PlaceManager
com.threerings.crowd.server.PlaceManager.DelegateOp, com.threerings.crowd.server.PlaceManager.MessageHandler
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from interface com.threerings.whirled.spot.data.SpotCodes
CLUSTER_CHAT_TYPE, CLUSTER_FULL, INVALID_LOCATION, LOCATION_OCCUPIED, NO_SUCH_CLUSTER, NO_SUCH_PORTAL
+  + + + + + + + +
Fields inherited from interface com.threerings.crowd.chat.data.ChatCodes
BROADCAST_ACCESS, BROADCAST_MODE, CHAT_ACCESS, CHAT_CHANNEL_NOTIFICATION, CHAT_NOTIFICATION, DEFAULT_IDLE_TIME, DEFAULT_MODE, EMOTE_MODE, IDLE_TIME_KEY, LAST_MODE, PLACE_CHAT_TYPE, SHOUT_MODE, SUCCESS, THINK_MODE, USER_CHAT_TYPE, USER_DISCONNECTED, USER_NOT_ONLINE, XLATE_MODES
+  + + + + + + + +
Fields inherited from interface com.threerings.whirled.data.SceneCodes
SCENE_UPDATE, WHIRLED_GROUP
+  + + + + + + + +
Fields inherited from interface com.threerings.crowd.data.LocationCodes
ALREADY_THERE, MOVE_IN_PROGRESS, NO_SUCH_PLACE
+  + + + + + + + +
Fields inherited from interface com.threerings.presents.data.InvocationCodes
ACCESS_DENIED, E_ACCESS_DENIED, E_INTERNAL_ERROR, GLOBAL_GROUP, INTERNAL_ERROR
+  + + + + + + + + + + +
+Constructor Summary
SpotSceneManager() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidclearEnteringBody(com.threerings.crowd.data.BodyObject body) + +
+          Called if a body failed to enter our scene after we assigned them an entering position.
+ voidmapEnteringBody(com.threerings.crowd.data.BodyObject body, + Portal from) + +
+          Assigns a starting location for an entering body.
+ StringmayTraversePortal(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.
+static voidmoveBodyToDefaultPortal(com.threerings.crowd.server.PlaceRegistry plreg, + com.threerings.crowd.data.BodyObject body) + +
+          Move the specified body to the default portal, if possible.
+ voidwillTraversePortal(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.
+  + + + + + + + +
Methods inherited from class com.threerings.whirled.server.SceneManager
getLocation, getScene, getUpdates, isPersistent, where
+  + + + + + + + +
Methods inherited from class com.threerings.crowd.server.PlaceManager
addDelegate, applyToDelegates, applyToOccupants, bodyWillEnter, bodyWillLeave, checkPermissions, getConfig, getPlaceObject, init, isValidSpeaker, messageReceived, ratifyBodyEntry, registerMessageHandler, shutdown, startup, toString, updateOccupantInfo
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+SpotSceneManager

+
+public SpotSceneManager()
+
+
+ + + + + + + + +
+Method Detail
+ +

+moveBodyToDefaultPortal

+
+public static void moveBodyToDefaultPortal(com.threerings.crowd.server.PlaceRegistry plreg,
+                                           com.threerings.crowd.data.BodyObject body)
+
+
Move the specified body to the default portal, if possible. +

+

+
+
+
+
+
+
+
+ +

+mapEnteringBody

+
+public void mapEnteringBody(com.threerings.crowd.data.BodyObject body,
+                            Portal from)
+
+
Assigns a starting location for an entering body. This will happen before the body is made + to "occupy" the scene (defined by their having an occupant info record). So when they do + finally occupy the scene, the client will know where to render them. +

+

+
+
+
+
+
+
+
+ +

+clearEnteringBody

+
+public void clearEnteringBody(com.threerings.crowd.data.BodyObject body)
+
+
Called if a body failed to enter our scene after we assigned them an entering position. +

+

+
+
+
+
+
+
+
+ +

+mayTraversePortal

+
+public String 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. + The manager may return an error code string that will be reported back to the caller + explaining the failure or null indicating that it is OK for the caller to + traverse the portal. +

+

+
+
+
+
+
+
+
+ +

+willTraversePortal

+
+public void 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. The default implementation relocates the user to the location associated + with the portal. It is still possible that the traversal will fail, so don't do anything too + crazy. +

+

+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/server/SpotSceneMoveHandler.html b/apidocs/com/threerings/whirled/spot/server/SpotSceneMoveHandler.html new file mode 100644 index 00000000..9745152c --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/server/SpotSceneMoveHandler.html @@ -0,0 +1,253 @@ + + + + + + + +SpotSceneMoveHandler (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.spot.server +
+Class SpotSceneMoveHandler

+
+java.lang.Object
+  extended by com.threerings.whirled.server.AbstractSceneMoveHandler
+      extended by com.threerings.whirled.server.SceneMoveHandler
+          extended by com.threerings.whirled.spot.server.SpotSceneMoveHandler
+
+
+
All Implemented Interfaces:
SceneRegistry.ResolutionListener
+
+
+
+
public class SpotSceneMoveHandler
extends SceneMoveHandler
+ + +

+Moves a player between scenes, accounting for their exit and entry via portals. +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
SpotSceneMoveHandler(com.threerings.crowd.server.LocationManager locman, + SpotSceneManager srcmgr, + com.threerings.crowd.data.BodyObject body, + int sceneVer, + Portal dest, + SceneService.SceneMoveListener listener) + +
+           
+  + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from class com.threerings.whirled.server.AbstractSceneMoveHandler
sceneFailedToResolve, sceneWasResolved
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+SpotSceneMoveHandler

+
+public SpotSceneMoveHandler(com.threerings.crowd.server.LocationManager locman,
+                            SpotSceneManager srcmgr,
+                            com.threerings.crowd.data.BodyObject body,
+                            int sceneVer,
+                            Portal dest,
+                            SceneService.SceneMoveListener listener)
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/server/SpotSceneRegistry.html b/apidocs/com/threerings/whirled/spot/server/SpotSceneRegistry.html new file mode 100644 index 00000000..3d5d01d0 --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/server/SpotSceneRegistry.html @@ -0,0 +1,517 @@ + + + + + + + +SpotSceneRegistry (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.spot.server +
+Class SpotSceneRegistry

+
+java.lang.Object
+  extended by com.threerings.whirled.server.SceneRegistry
+      extended by com.threerings.whirled.spot.server.SpotSceneRegistry
+
+
+
All Implemented Interfaces:
com.threerings.crowd.data.LocationCodes, com.threerings.presents.data.InvocationCodes, com.threerings.presents.server.InvocationProvider, SceneCodes, SceneProvider, SpotProvider
+
+
+
+
public class SpotSceneRegistry
extends SceneRegistry
implements SpotProvider
+ + +

+Extends the SceneRegistry with spot-related services. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.whirled.server.SceneRegistry
SceneRegistry.ConfigFactory, SceneRegistry.ResolutionListener
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from interface com.threerings.whirled.data.SceneCodes
SCENE_UPDATE, WHIRLED_GROUP
+  + + + + + + + +
Fields inherited from interface com.threerings.crowd.data.LocationCodes
ALREADY_THERE, MOVE_IN_PROGRESS, NO_SUCH_PLACE
+  + + + + + + + +
Fields inherited from interface com.threerings.presents.data.InvocationCodes
ACCESS_DENIED, E_ACCESS_DENIED, E_INTERNAL_ERROR, GLOBAL_GROUP, INTERNAL_ERROR
+  + + + + + + + + + + +
+Constructor Summary
SpotSceneRegistry(com.threerings.presents.server.InvocationManager invmgr) + +
+          Constructs a spot scene registry.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidchangeLocation(com.threerings.presents.data.ClientObject caller, + int sceneId, + Location loc, + com.threerings.presents.client.InvocationService.ConfirmListener listener) + +
+          Handles a SpotService.changeLocation(int, com.threerings.whirled.spot.data.Location, com.threerings.presents.client.InvocationService.ConfirmListener) request.
+ voidclusterSpeak(com.threerings.presents.data.ClientObject caller, + String message, + byte mode) + +
+          Handles a SpotService.clusterSpeak(java.lang.String, byte) request.
+ voidjoinCluster(com.threerings.presents.data.ClientObject caller, + int friendOid, + com.threerings.presents.client.InvocationService.ConfirmListener listener) + +
+          Handles a SpotService.joinCluster(int, com.threerings.presents.client.InvocationService.ConfirmListener) request.
+ voidsendClusterChatMessage(int sceneId, + int speakerOid, + com.threerings.util.Name speaker, + String bundle, + String message, + byte mode) + +
+          Sends a cluster chat notification to the specified location in the specified place object + originating with the specified speaker (the speaker can be a server entity that wishes to + fake a "speak" message, in which case the bundle argument should be non-null and should + contain the id of the bundle to be used to translate the message text) and with the supplied + message content.
+ voidsendClusterChatMessage(int sceneId, + int speakerOid, + com.threerings.crowd.chat.data.UserMessage message) + +
+          Sends a cluster chat notification to the specified location in the specified place object + originating with the specified speaker.
+ voidtraversePortal(com.threerings.presents.data.ClientObject caller, + int sceneId, + int portalId, + int destSceneVer, + SpotService.SpotSceneMoveListener listener) + +
+          Handles a SpotService.traversePortal(int, int, int, com.threerings.whirled.spot.client.SpotService.SpotSceneMoveListener) request.
+  + + + + + + + +
Methods inherited from class com.threerings.whirled.server.SceneRegistry
getSceneManager, getSceneRepository, leaveOccupiedScene, moveBody, moveTo, resolveScene, where
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+SpotSceneRegistry

+
+@Inject
+public SpotSceneRegistry(com.threerings.presents.server.InvocationManager invmgr)
+
+
Constructs a spot scene registry. +

+

+ + + + + + + + +
+Method Detail
+ +

+sendClusterChatMessage

+
+public void sendClusterChatMessage(int sceneId,
+                                   int speakerOid,
+                                   com.threerings.util.Name speaker,
+                                   String bundle,
+                                   String message,
+                                   byte mode)
+
+
Sends a cluster chat notification to the specified location in the specified place object + originating with the specified speaker (the speaker can be a server entity that wishes to + fake a "speak" message, in which case the bundle argument should be non-null and should + contain the id of the bundle to be used to translate the message text) and with the supplied + message content. +

+

+
+
+
+
Parameters:
sceneId - the scene id in which to deliver the chat message.
speakerOid - the body object id of the speaker (used to verify that they are in the + cluster in question).
speaker - the username of the user that generated the message (or some special speaker + name for server messages).
bundle - the bundle identifier that will be used by the client to translate the message + text (or null if the message originated from a real live human who wrote it in their native + tongue).
message - the text of the chat message.
+
+
+
+ +

+sendClusterChatMessage

+
+public void sendClusterChatMessage(int sceneId,
+                                   int speakerOid,
+                                   com.threerings.crowd.chat.data.UserMessage message)
+
+
Sends a cluster chat notification to the specified location in the specified place object + originating with the specified speaker. +

+

+
+
+
+
Parameters:
sceneId - the scene id in which to deliver the chat message.
speakerOid - the body object id of the speaker (used to verify that they are in the + cluster in question).
message - the message.
+
+
+
+ +

+traversePortal

+
+public void traversePortal(com.threerings.presents.data.ClientObject caller,
+                           int sceneId,
+                           int portalId,
+                           int destSceneVer,
+                           SpotService.SpotSceneMoveListener listener)
+                    throws com.threerings.presents.server.InvocationException
+
+
Description copied from interface: SpotProvider
+
Handles a SpotService.traversePortal(int, int, int, com.threerings.whirled.spot.client.SpotService.SpotSceneMoveListener) request. +

+

+
Specified by:
traversePortal in interface SpotProvider
+
+
+ +
Throws: +
com.threerings.presents.server.InvocationException
+
+
+
+ +

+changeLocation

+
+public void changeLocation(com.threerings.presents.data.ClientObject caller,
+                           int sceneId,
+                           Location loc,
+                           com.threerings.presents.client.InvocationService.ConfirmListener listener)
+                    throws com.threerings.presents.server.InvocationException
+
+
Description copied from interface: SpotProvider
+
Handles a SpotService.changeLocation(int, com.threerings.whirled.spot.data.Location, com.threerings.presents.client.InvocationService.ConfirmListener) request. +

+

+
Specified by:
changeLocation in interface SpotProvider
+
+
+ +
Throws: +
com.threerings.presents.server.InvocationException
+
+
+
+ +

+joinCluster

+
+public void joinCluster(com.threerings.presents.data.ClientObject caller,
+                        int friendOid,
+                        com.threerings.presents.client.InvocationService.ConfirmListener listener)
+                 throws com.threerings.presents.server.InvocationException
+
+
Description copied from interface: SpotProvider
+
Handles a SpotService.joinCluster(int, com.threerings.presents.client.InvocationService.ConfirmListener) request. +

+

+
Specified by:
joinCluster in interface SpotProvider
+
+
+ +
Throws: +
com.threerings.presents.server.InvocationException
+
+
+
+ +

+clusterSpeak

+
+public void clusterSpeak(com.threerings.presents.data.ClientObject caller,
+                         String message,
+                         byte mode)
+
+
Description copied from interface: SpotProvider
+
Handles a SpotService.clusterSpeak(java.lang.String, byte) request. +

+

+
Specified by:
clusterSpeak in interface SpotProvider
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/server/class-use/SpotClient.html b/apidocs/com/threerings/whirled/spot/server/class-use/SpotClient.html new file mode 100644 index 00000000..d567c9d0 --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/server/class-use/SpotClient.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.whirled.spot.server.SpotClient (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.spot.server.SpotClient

+
+No usage of com.threerings.whirled.spot.server.SpotClient +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/server/class-use/SpotProvider.html b/apidocs/com/threerings/whirled/spot/server/class-use/SpotProvider.html new file mode 100644 index 00000000..ce6dfb51 --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/server/class-use/SpotProvider.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Interface com.threerings.whirled.spot.server.SpotProvider (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.whirled.spot.server.SpotProvider

+
+ + + + + + + + + +
+Packages that use SpotProvider
com.threerings.whirled.spot.server  
+  +

+ + + + + +
+Uses of SpotProvider in com.threerings.whirled.spot.server
+  +

+ + + + + + + + + +
Classes in com.threerings.whirled.spot.server that implement SpotProvider
+ classSpotSceneRegistry + +
+          Extends the SceneRegistry with spot-related services.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/server/class-use/SpotSceneManager.html b/apidocs/com/threerings/whirled/spot/server/class-use/SpotSceneManager.html new file mode 100644 index 00000000..9705601e --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/server/class-use/SpotSceneManager.html @@ -0,0 +1,214 @@ + + + + + + + +Uses of Class com.threerings.whirled.spot.server.SpotSceneManager (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.spot.server.SpotSceneManager

+
+ + + + + + + + + + + + + +
+Packages that use SpotSceneManager
com.threerings.stage.server  
com.threerings.whirled.spot.server  
+  +

+ + + + + +
+Uses of SpotSceneManager in com.threerings.stage.server
+  +

+ + + + + + + + + +
Subclasses of SpotSceneManager in com.threerings.stage.server
+ classStageSceneManager + +
+          Defines extensions to the basic Stage scene manager specific to displaying isometric "stage" + scenes (these may be indoor, outdoor or aboard a vessel).
+  +

+ + + + + +
+Uses of SpotSceneManager in com.threerings.whirled.spot.server
+  +

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

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/server/class-use/SpotSceneMoveHandler.html b/apidocs/com/threerings/whirled/spot/server/class-use/SpotSceneMoveHandler.html new file mode 100644 index 00000000..7b1c4612 --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/server/class-use/SpotSceneMoveHandler.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.whirled.spot.server.SpotSceneMoveHandler (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.spot.server.SpotSceneMoveHandler

+
+No usage of com.threerings.whirled.spot.server.SpotSceneMoveHandler +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/server/class-use/SpotSceneRegistry.html b/apidocs/com/threerings/whirled/spot/server/class-use/SpotSceneRegistry.html new file mode 100644 index 00000000..8bc5a0b9 --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/server/class-use/SpotSceneRegistry.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.whirled.spot.server.SpotSceneRegistry (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.spot.server.SpotSceneRegistry

+
+No usage of com.threerings.whirled.spot.server.SpotSceneRegistry +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/server/package-frame.html b/apidocs/com/threerings/whirled/spot/server/package-frame.html new file mode 100644 index 00000000..d5bc3750 --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/server/package-frame.html @@ -0,0 +1,50 @@ + + + + + + + +com.threerings.whirled.spot.server (vilya 1.3 API) + + + + + + + + + + + +com.threerings.whirled.spot.server + + + + +
+Interfaces  + +
+SpotProvider
+ + + + + + +
+Classes  + +
+SpotClient +
+SpotSceneManager +
+SpotSceneMoveHandler +
+SpotSceneRegistry
+ + + + diff --git a/apidocs/com/threerings/whirled/spot/server/package-summary.html b/apidocs/com/threerings/whirled/spot/server/package-summary.html new file mode 100644 index 00000000..8cb711bc --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/server/package-summary.html @@ -0,0 +1,187 @@ + + + + + + + +com.threerings.whirled.spot.server (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.whirled.spot.server +

+ + + + + + + + + +
+Interface Summary
SpotProviderDefines the server-side of the SpotService.
+  + +

+ + + + + + + + + + + + + + + + + + + + + +
+Class Summary
SpotClientExtends the Whirled client and handles the necessary notifications that take place when a user + logs off to let the clients displaying the scene they were occupying know that they didn't exit + via a portal, but instead just disappeared.
SpotSceneManagerHandles the movement of bodies between locations in the scene and creates the necessary + distributed objects to allow bodies in clusters to chat with one another.
SpotSceneMoveHandlerMoves a player between scenes, accounting for their exit and entry via portals.
SpotSceneRegistryExtends the SceneRegistry with spot-related services.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/server/package-tree.html b/apidocs/com/threerings/whirled/spot/server/package-tree.html new file mode 100644 index 00000000..e1b33d89 --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/server/package-tree.html @@ -0,0 +1,183 @@ + + + + + + + +com.threerings.whirled.spot.server Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.whirled.spot.server +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/server/package-use.html b/apidocs/com/threerings/whirled/spot/server/package-use.html new file mode 100644 index 00000000..6ed982b0 --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/server/package-use.html @@ -0,0 +1,198 @@ + + + + + + + +Uses of Package com.threerings.whirled.spot.server (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.whirled.spot.server

+
+ + + + + + + + + + + + + +
+Packages that use com.threerings.whirled.spot.server
com.threerings.stage.server  
com.threerings.whirled.spot.server  
+  +

+ + + + + + + + +
+Classes in com.threerings.whirled.spot.server used by com.threerings.stage.server
SpotSceneManager + +
+          Handles the movement of bodies between locations in the scene and creates the necessary + distributed objects to allow bodies in clusters to chat with one another.
+  +

+ + + + + + + + + + + +
+Classes in com.threerings.whirled.spot.server used by com.threerings.whirled.spot.server
SpotProvider + +
+          Defines the server-side of the SpotService.
SpotSceneManager + +
+          Handles the movement of bodies between locations in the scene and creates the necessary + distributed objects to allow bodies in clusters to chat with one another.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/tools/EditablePortal.html b/apidocs/com/threerings/whirled/spot/tools/EditablePortal.html new file mode 100644 index 00000000..cc40671c --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/tools/EditablePortal.html @@ -0,0 +1,363 @@ + + + + + + + +EditablePortal (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.spot.tools +
+Class EditablePortal

+
+java.lang.Object
+  extended by com.threerings.io.SimpleStreamableObject
+      extended by com.threerings.whirled.spot.data.Portal
+          extended by com.threerings.whirled.spot.tools.EditablePortal
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable, Cloneable
+
+
+
+
public class EditablePortal
extends Portal
+ + +

+An editable portal extends the standard portal with information needed + by the loader and editor. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + + + + + + + + + +
+Field Summary
+ Stringname + +
+          The human-readable name of this portal.
+ StringtargetPortalName + +
+          The human-readable name of the portal to which this portal links + in its target scene.
+ StringtargetSceneName + +
+          The human-readable name of the scene to which this portal + links.
+  + + + + + + + +
Fields inherited from class com.threerings.whirled.spot.data.Portal
loc, portalId, targetPortalId, targetSceneId
+  + + + + + + + + + + +
+Constructor Summary
EditablePortal() + +
+           
+  + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from class com.threerings.whirled.spot.data.Portal
clone, equals, getLocation, getOppLocation, hashCode, isValid
+  + + + + + + + +
Methods inherited from class com.threerings.io.SimpleStreamableObject
toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+name

+
+public String name
+
+
The human-readable name of this portal. +

+

+
+
+
+ +

+targetSceneName

+
+public String targetSceneName
+
+
The human-readable name of the scene to which this portal + links. +

+

+
+
+
+ +

+targetPortalName

+
+public String targetPortalName
+
+
The human-readable name of the portal to which this portal links + in its target scene. +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+EditablePortal

+
+public EditablePortal()
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/tools/class-use/EditablePortal.html b/apidocs/com/threerings/whirled/spot/tools/class-use/EditablePortal.html new file mode 100644 index 00000000..f6d96e9d --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/tools/class-use/EditablePortal.html @@ -0,0 +1,182 @@ + + + + + + + +Uses of Class com.threerings.whirled.spot.tools.EditablePortal (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.spot.tools.EditablePortal

+
+ + + + + + + + + +
+Packages that use EditablePortal
com.threerings.stage.tools.editor  
+  +

+ + + + + +
+Uses of EditablePortal in com.threerings.stage.tools.editor
+  +

+ + + + + + + + + +
Methods in com.threerings.stage.tools.editor with parameters of type EditablePortal
+ voidPortalDialog.prepare(StageScene scene, + EditablePortal port) + +
+          Prepare the dialog for display.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/tools/package-frame.html b/apidocs/com/threerings/whirled/spot/tools/package-frame.html new file mode 100644 index 00000000..2e5fcaea --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/tools/package-frame.html @@ -0,0 +1,33 @@ + + + + + + + +com.threerings.whirled.spot.tools (vilya 1.3 API) + + + + + + + + + + + +com.threerings.whirled.spot.tools + + + + +
+Classes  + +
+EditablePortal
+ + + + diff --git a/apidocs/com/threerings/whirled/spot/tools/package-summary.html b/apidocs/com/threerings/whirled/spot/tools/package-summary.html new file mode 100644 index 00000000..06c1959c --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/tools/package-summary.html @@ -0,0 +1,159 @@ + + + + + + + +com.threerings.whirled.spot.tools (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.whirled.spot.tools +

+ + + + + + + + + +
+Class Summary
EditablePortalAn editable portal extends the standard portal with information needed + by the loader and editor.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/tools/package-tree.html b/apidocs/com/threerings/whirled/spot/tools/package-tree.html new file mode 100644 index 00000000..99698f42 --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/tools/package-tree.html @@ -0,0 +1,160 @@ + + + + + + + +com.threerings.whirled.spot.tools Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.whirled.spot.tools +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/tools/package-use.html b/apidocs/com/threerings/whirled/spot/tools/package-use.html new file mode 100644 index 00000000..1adc2b52 --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/tools/package-use.html @@ -0,0 +1,172 @@ + + + + + + + +Uses of Package com.threerings.whirled.spot.tools (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.whirled.spot.tools

+
+ + + + + + + + + +
+Packages that use com.threerings.whirled.spot.tools
com.threerings.stage.tools.editor  
+  +

+ + + + + + + + +
+Classes in com.threerings.whirled.spot.tools used by com.threerings.stage.tools.editor
EditablePortal + +
+          An editable portal extends the standard portal with information needed + by the loader and editor.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/tools/xml/SpotSceneRuleSet.html b/apidocs/com/threerings/whirled/spot/tools/xml/SpotSceneRuleSet.html new file mode 100644 index 00000000..54c5665f --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/tools/xml/SpotSceneRuleSet.html @@ -0,0 +1,287 @@ + + + + + + + +SpotSceneRuleSet (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.spot.tools.xml +
+Class SpotSceneRuleSet

+
+java.lang.Object
+  extended by com.threerings.whirled.spot.tools.xml.SpotSceneRuleSet
+
+
+
All Implemented Interfaces:
com.threerings.tools.xml.NestableRuleSet
+
+
+
+
public abstract class SpotSceneRuleSet
extends Object
implements com.threerings.tools.xml.NestableRuleSet
+ + +

+Used to parse a SpotSceneModel from XML. +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
SpotSceneRuleSet() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ voidaddRuleInstances(String prefix, + org.apache.commons.digester.Digester digester) + +
+           
+ StringgetOuterElement() + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+SpotSceneRuleSet

+
+public SpotSceneRuleSet()
+
+
+ + + + + + + + +
+Method Detail
+ +

+getOuterElement

+
+public String getOuterElement()
+
+
+
Specified by:
getOuterElement in interface com.threerings.tools.xml.NestableRuleSet
+
+
+
+
+
+
+ +

+addRuleInstances

+
+public void addRuleInstances(String prefix,
+                             org.apache.commons.digester.Digester digester)
+
+
+
Specified by:
addRuleInstances in interface com.threerings.tools.xml.NestableRuleSet
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/tools/xml/SpotSceneWriter.html b/apidocs/com/threerings/whirled/spot/tools/xml/SpotSceneWriter.html new file mode 100644 index 00000000..61bd18fc --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/tools/xml/SpotSceneWriter.html @@ -0,0 +1,306 @@ + + + + + + + +SpotSceneWriter (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.spot.tools.xml +
+Class SpotSceneWriter

+
+java.lang.Object
+  extended by com.threerings.whirled.spot.tools.xml.SpotSceneWriter
+
+
+
All Implemented Interfaces:
com.threerings.tools.xml.NestableWriter
+
+
+
+
public class SpotSceneWriter
extends Object
implements com.threerings.tools.xml.NestableWriter
+ + +

+Generates an XML representation of a SpotSceneModel. +

+ +

+

+ +

+ + + + + + + + + + + +
+Field Summary
+static StringOUTER_ELEMENT + +
+          The outer element used to enclose our spot scene definition.
+  + + + + + + + + + + +
+Constructor Summary
SpotSceneWriter() + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ voidwrite(Object object, + com.megginson.sax.DataWriter writer) + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+OUTER_ELEMENT

+
+public static final String OUTER_ELEMENT
+
+
The outer element used to enclose our spot scene definition. +

+

+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Constructor Detail
+ +

+SpotSceneWriter

+
+public SpotSceneWriter()
+
+
+ + + + + + + + +
+Method Detail
+ +

+write

+
+public void write(Object object,
+                  com.megginson.sax.DataWriter writer)
+           throws SAXException
+
+
+
Specified by:
write in interface com.threerings.tools.xml.NestableWriter
+
+
+ +
Throws: +
SAXException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/tools/xml/class-use/SpotSceneRuleSet.html b/apidocs/com/threerings/whirled/spot/tools/xml/class-use/SpotSceneRuleSet.html new file mode 100644 index 00000000..2635ce54 --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/tools/xml/class-use/SpotSceneRuleSet.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.whirled.spot.tools.xml.SpotSceneRuleSet (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.spot.tools.xml.SpotSceneRuleSet

+
+No usage of com.threerings.whirled.spot.tools.xml.SpotSceneRuleSet +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/tools/xml/class-use/SpotSceneWriter.html b/apidocs/com/threerings/whirled/spot/tools/xml/class-use/SpotSceneWriter.html new file mode 100644 index 00000000..f397e476 --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/tools/xml/class-use/SpotSceneWriter.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.whirled.spot.tools.xml.SpotSceneWriter (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.spot.tools.xml.SpotSceneWriter

+
+No usage of com.threerings.whirled.spot.tools.xml.SpotSceneWriter +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/tools/xml/package-frame.html b/apidocs/com/threerings/whirled/spot/tools/xml/package-frame.html new file mode 100644 index 00000000..0284e973 --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/tools/xml/package-frame.html @@ -0,0 +1,35 @@ + + + + + + + +com.threerings.whirled.spot.tools.xml (vilya 1.3 API) + + + + + + + + + + + +com.threerings.whirled.spot.tools.xml + + + + +
+Classes  + +
+SpotSceneRuleSet +
+SpotSceneWriter
+ + + + diff --git a/apidocs/com/threerings/whirled/spot/tools/xml/package-summary.html b/apidocs/com/threerings/whirled/spot/tools/xml/package-summary.html new file mode 100644 index 00000000..303ba513 --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/tools/xml/package-summary.html @@ -0,0 +1,162 @@ + + + + + + + +com.threerings.whirled.spot.tools.xml (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.whirled.spot.tools.xml +

+ + + + + + + + + + + + + +
+Class Summary
SpotSceneRuleSetUsed to parse a SpotSceneModel from XML.
SpotSceneWriterGenerates an XML representation of a SpotSceneModel.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/tools/xml/package-tree.html b/apidocs/com/threerings/whirled/spot/tools/xml/package-tree.html new file mode 100644 index 00000000..2f7ae6bb --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/tools/xml/package-tree.html @@ -0,0 +1,156 @@ + + + + + + + +com.threerings.whirled.spot.tools.xml Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.whirled.spot.tools.xml +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/spot/tools/xml/package-use.html b/apidocs/com/threerings/whirled/spot/tools/xml/package-use.html new file mode 100644 index 00000000..37b38605 --- /dev/null +++ b/apidocs/com/threerings/whirled/spot/tools/xml/package-use.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Package com.threerings.whirled.spot.tools.xml (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.whirled.spot.tools.xml

+
+No usage of com.threerings.whirled.spot.tools.xml +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/tools/xml/SceneParser.html b/apidocs/com/threerings/whirled/tools/xml/SceneParser.html new file mode 100644 index 00000000..33be6951 --- /dev/null +++ b/apidocs/com/threerings/whirled/tools/xml/SceneParser.html @@ -0,0 +1,315 @@ + + + + + + + +SceneParser (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.tools.xml +
+Class SceneParser

+
+java.lang.Object
+  extended by com.threerings.whirled.tools.xml.SceneParser
+
+
+
Direct Known Subclasses:
StageSceneParser
+
+
+
+
public class SceneParser
extends Object
+ + +

+A simple class for parsing an editable scene instance. +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
SceneParser(String prefix) + +
+          Constructs a scene parser that parses scenes with the specified XML + path prefix.
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ SceneModelparseScene(String path) + +
+          Parses the XML file at the specified path into a scene model + instance.
+ voidregisterAuxRuleSet(com.threerings.tools.xml.NestableRuleSet set) + +
+          Adds a NestableRuleSet for parsing auxiliary scene models.
+ voidsetScene(SceneModel model) + +
+          Called by the parser once the scene is parsed.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+SceneParser

+
+public SceneParser(String prefix)
+
+
Constructs a scene parser that parses scenes with the specified XML + path prefix. +

+

+ + + + + + + + +
+Method Detail
+ +

+registerAuxRuleSet

+
+public void registerAuxRuleSet(com.threerings.tools.xml.NestableRuleSet set)
+
+
Adds a NestableRuleSet for parsing auxiliary scene models. +

+

+
+
+
+
+ +

+parseScene

+
+public SceneModel parseScene(String path)
+                      throws IOException,
+                             SAXException
+
+
Parses the XML file at the specified path into a scene model + instance. +

+

+ +
Throws: +
IOException +
SAXException
+
+
+
+ +

+setScene

+
+public void setScene(SceneModel model)
+
+
Called by the parser once the scene is parsed. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/tools/xml/SceneRuleSet.html b/apidocs/com/threerings/whirled/tools/xml/SceneRuleSet.html new file mode 100644 index 00000000..df2daa36 --- /dev/null +++ b/apidocs/com/threerings/whirled/tools/xml/SceneRuleSet.html @@ -0,0 +1,290 @@ + + + + + + + +SceneRuleSet (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.tools.xml +
+Class SceneRuleSet

+
+java.lang.Object
+  extended by com.threerings.whirled.tools.xml.SceneRuleSet
+
+
+
All Implemented Interfaces:
com.threerings.tools.xml.NestableRuleSet
+
+
+
Direct Known Subclasses:
StageSceneRuleSet
+
+
+
+
public class SceneRuleSet
extends Object
implements com.threerings.tools.xml.NestableRuleSet
+ + +

+Used to parse a SceneModel from XML. +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
SceneRuleSet() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ voidaddRuleInstances(String prefix, + org.apache.commons.digester.Digester digester) + +
+           
+ StringgetOuterElement() + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+SceneRuleSet

+
+public SceneRuleSet()
+
+
+ + + + + + + + +
+Method Detail
+ +

+getOuterElement

+
+public String getOuterElement()
+
+
+
Specified by:
getOuterElement in interface com.threerings.tools.xml.NestableRuleSet
+
+
+
+
+
+
+ +

+addRuleInstances

+
+public void addRuleInstances(String prefix,
+                             org.apache.commons.digester.Digester digester)
+
+
+
Specified by:
addRuleInstances in interface com.threerings.tools.xml.NestableRuleSet
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/tools/xml/SceneWriter.html b/apidocs/com/threerings/whirled/tools/xml/SceneWriter.html new file mode 100644 index 00000000..bfd39d64 --- /dev/null +++ b/apidocs/com/threerings/whirled/tools/xml/SceneWriter.html @@ -0,0 +1,363 @@ + + + + + + + +SceneWriter (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.tools.xml +
+Class SceneWriter

+
+java.lang.Object
+  extended by com.threerings.whirled.tools.xml.SceneWriter
+
+
+
Direct Known Subclasses:
StageSceneWriter
+
+
+
+
public class SceneWriter
extends Object
+ + +

+Generates an XML representation of an SceneModel. +

+ +

+

+ +

+ + + + + + + + + + + +
+Field Summary
+static StringOUTER_ELEMENT + +
+          The outer element used to enclose our scene definition.
+  + + + + + + + + + + +
+Constructor Summary
SceneWriter() + +
+           
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidregisterAuxWriter(Class<?> aclass, + com.threerings.tools.xml.NestableWriter writer) + +
+          Registers a writer for writing auxiliary scene models of the + supplied class.
+ voidwriteScene(File out, + SceneModel model) + +
+          Writes the supplied scene out to the specified file.
+ voidwriteSceneModel(SceneModel model, + com.megginson.sax.DataWriter writer) + +
+          Writes the data for the supplied SceneModel to the XML data + writer supplied.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+OUTER_ELEMENT

+
+public static final String OUTER_ELEMENT
+
+
The outer element used to enclose our scene definition. +

+

+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Constructor Detail
+ +

+SceneWriter

+
+public SceneWriter()
+
+
+ + + + + + + + +
+Method Detail
+ +

+registerAuxWriter

+
+public void registerAuxWriter(Class<?> aclass,
+                              com.threerings.tools.xml.NestableWriter writer)
+
+
Registers a writer for writing auxiliary scene models of the + supplied class. +

+

+
+
+
+
+ +

+writeScene

+
+public void writeScene(File out,
+                       SceneModel model)
+                throws IOException,
+                       SAXException
+
+
Writes the supplied scene out to the specified file. +

+

+ +
Throws: +
IOException +
SAXException
+
+
+
+ +

+writeSceneModel

+
+public void writeSceneModel(SceneModel model,
+                            com.megginson.sax.DataWriter writer)
+                     throws SAXException
+
+
Writes the data for the supplied SceneModel to the XML data + writer supplied. The writer should already be configured with the + appropriate indentation level so that this writer can simply output + its elements and allow the calling code to determine where in the + greater scene description file the scene data should live. +

+

+ +
Throws: +
SAXException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/tools/xml/class-use/SceneParser.html b/apidocs/com/threerings/whirled/tools/xml/class-use/SceneParser.html new file mode 100644 index 00000000..43883027 --- /dev/null +++ b/apidocs/com/threerings/whirled/tools/xml/class-use/SceneParser.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class com.threerings.whirled.tools.xml.SceneParser (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.tools.xml.SceneParser

+
+ + + + + + + + + +
+Packages that use SceneParser
com.threerings.stage.tools.xml  
+  +

+ + + + + +
+Uses of SceneParser in com.threerings.stage.tools.xml
+  +

+ + + + + + + + + +
Subclasses of SceneParser in com.threerings.stage.tools.xml
+ classStageSceneParser + +
+          Parses StageSceneModel instances from an XML description file.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/tools/xml/class-use/SceneRuleSet.html b/apidocs/com/threerings/whirled/tools/xml/class-use/SceneRuleSet.html new file mode 100644 index 00000000..9a500276 --- /dev/null +++ b/apidocs/com/threerings/whirled/tools/xml/class-use/SceneRuleSet.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class com.threerings.whirled.tools.xml.SceneRuleSet (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.tools.xml.SceneRuleSet

+
+ + + + + + + + + +
+Packages that use SceneRuleSet
com.threerings.stage.tools.xml  
+  +

+ + + + + +
+Uses of SceneRuleSet in com.threerings.stage.tools.xml
+  +

+ + + + + + + + + +
Subclasses of SceneRuleSet in com.threerings.stage.tools.xml
+ classStageSceneRuleSet + +
+          Used to parse an StageScene from XML.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/tools/xml/class-use/SceneWriter.html b/apidocs/com/threerings/whirled/tools/xml/class-use/SceneWriter.html new file mode 100644 index 00000000..ddb79267 --- /dev/null +++ b/apidocs/com/threerings/whirled/tools/xml/class-use/SceneWriter.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class com.threerings.whirled.tools.xml.SceneWriter (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.tools.xml.SceneWriter

+
+ + + + + + + + + +
+Packages that use SceneWriter
com.threerings.stage.tools.xml  
+  +

+ + + + + +
+Uses of SceneWriter in com.threerings.stage.tools.xml
+  +

+ + + + + + + + + +
Subclasses of SceneWriter in com.threerings.stage.tools.xml
+ classStageSceneWriter + +
+          Generates an XML representation of a StageSceneModel.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/tools/xml/package-frame.html b/apidocs/com/threerings/whirled/tools/xml/package-frame.html new file mode 100644 index 00000000..a6edb696 --- /dev/null +++ b/apidocs/com/threerings/whirled/tools/xml/package-frame.html @@ -0,0 +1,37 @@ + + + + + + + +com.threerings.whirled.tools.xml (vilya 1.3 API) + + + + + + + + + + + +com.threerings.whirled.tools.xml + + + + +
+Classes  + +
+SceneParser +
+SceneRuleSet +
+SceneWriter
+ + + + diff --git a/apidocs/com/threerings/whirled/tools/xml/package-summary.html b/apidocs/com/threerings/whirled/tools/xml/package-summary.html new file mode 100644 index 00000000..21908543 --- /dev/null +++ b/apidocs/com/threerings/whirled/tools/xml/package-summary.html @@ -0,0 +1,166 @@ + + + + + + + +com.threerings.whirled.tools.xml (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.whirled.tools.xml +

+ + + + + + + + + + + + + + + + + +
+Class Summary
SceneParserA simple class for parsing an editable scene instance.
SceneRuleSetUsed to parse a SceneModel from XML.
SceneWriterGenerates an XML representation of an SceneModel.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/tools/xml/package-tree.html b/apidocs/com/threerings/whirled/tools/xml/package-tree.html new file mode 100644 index 00000000..56fc3c4f --- /dev/null +++ b/apidocs/com/threerings/whirled/tools/xml/package-tree.html @@ -0,0 +1,155 @@ + + + + + + + +com.threerings.whirled.tools.xml Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.whirled.tools.xml +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/tools/xml/package-use.html b/apidocs/com/threerings/whirled/tools/xml/package-use.html new file mode 100644 index 00000000..a08be6b9 --- /dev/null +++ b/apidocs/com/threerings/whirled/tools/xml/package-use.html @@ -0,0 +1,183 @@ + + + + + + + +Uses of Package com.threerings.whirled.tools.xml (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.whirled.tools.xml

+
+ + + + + + + + + +
+Packages that use com.threerings.whirled.tools.xml
com.threerings.stage.tools.xml  
+  +

+ + + + + + + + + + + + + + +
+Classes in com.threerings.whirled.tools.xml used by com.threerings.stage.tools.xml
SceneParser + +
+          A simple class for parsing an editable scene instance.
SceneRuleSet + +
+          Used to parse a SceneModel from XML.
SceneWriter + +
+          Generates an XML representation of an SceneModel.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/util/NoSuchSceneException.html b/apidocs/com/threerings/whirled/util/NoSuchSceneException.html new file mode 100644 index 00000000..2b28530e --- /dev/null +++ b/apidocs/com/threerings/whirled/util/NoSuchSceneException.html @@ -0,0 +1,274 @@ + + + + + + + +NoSuchSceneException (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.util +
+Class NoSuchSceneException

+
+java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by com.threerings.whirled.util.NoSuchSceneException
+
+
+
All Implemented Interfaces:
Serializable
+
+
+
+
public class NoSuchSceneException
extends Exception
+ + +

+Thrown when an attempt to load a non-existent scene is made on the + repository. +

+ +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + + + + + +
+Constructor Summary
NoSuchSceneException(int sceneid) + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ intgetSceneId() + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+NoSuchSceneException

+
+public NoSuchSceneException(int sceneid)
+
+
+ + + + + + + + +
+Method Detail
+ +

+getSceneId

+
+public int getSceneId()
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/util/SceneFactory.html b/apidocs/com/threerings/whirled/util/SceneFactory.html new file mode 100644 index 00000000..bc1506de --- /dev/null +++ b/apidocs/com/threerings/whirled/util/SceneFactory.html @@ -0,0 +1,218 @@ + + + + + + + +SceneFactory (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.util +
+Interface SceneFactory

+
+
+
public interface SceneFactory
+ + +

+This is used by the Whirled services to obtain a Scene + implementation given a scene model and associated data. +

+ +

+

+ +

+ + + + + + + + + + + + +
+Method Summary
+ ScenecreateScene(SceneModel model, + com.threerings.crowd.data.PlaceConfig config) + +
+          Creates a Scene implementation given the supplied scene + model and place config.
+  +

+ + + + + + + + +
+Method Detail
+ +

+createScene

+
+Scene createScene(SceneModel model,
+                  com.threerings.crowd.data.PlaceConfig config)
+
+
Creates a Scene implementation given the supplied scene + model and place config. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/util/UpdateList.html b/apidocs/com/threerings/whirled/util/UpdateList.html new file mode 100644 index 00000000..e6260716 --- /dev/null +++ b/apidocs/com/threerings/whirled/util/UpdateList.html @@ -0,0 +1,309 @@ + + + + + + + +UpdateList (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.util +
+Class UpdateList

+
+java.lang.Object
+  extended by com.threerings.whirled.util.UpdateList
+
+
+
+
public class UpdateList
extends Object
+ + +

+A list specialized for storing SceneUpdate objects. +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
UpdateList() + +
+           
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidaddUpdate(SceneUpdate update) + +
+          Adds an update to this list.
+ SceneUpdate[]getUpdates(int fromVersion) + +
+          Returns all of the updates that should be applied to a scene with the specified version to + bring it up to date.
+ booleanvalidate(int sceneVersion) + +
+          Returns true if the supplied actual scene version is in accordance with the updates + contained in this list.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+UpdateList

+
+public UpdateList()
+
+
+ + + + + + + + +
+Method Detail
+ +

+addUpdate

+
+public void addUpdate(SceneUpdate update)
+
+
Adds an update to this list. The update must follow appropriately the chain of updates + established by the updates already in the list (meaning it must operate on one version + higher than the most recent update already in the list). +

+

+
+
+
+
+ +

+getUpdates

+
+public SceneUpdate[] getUpdates(int fromVersion)
+
+
Returns all of the updates that should be applied to a scene with the specified version to + bring it up to date. null is returned if the scene's version is older than the + oldest update in our list, in which case it cannot be brought up to date by applying updates + from this list. +

+

+
+
+
+
+ +

+validate

+
+public boolean validate(int sceneVersion)
+
+
Returns true if the supplied actual scene version is in accordance with the updates + contained in this list. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/util/WhirledContext.html b/apidocs/com/threerings/whirled/util/WhirledContext.html new file mode 100644 index 00000000..5cf3f647 --- /dev/null +++ b/apidocs/com/threerings/whirled/util/WhirledContext.html @@ -0,0 +1,238 @@ + + + + + + + +WhirledContext (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.util +
+Interface WhirledContext

+
+
All Superinterfaces:
com.threerings.crowd.util.CrowdContext, com.threerings.presents.util.PresentsContext
+
+
+
+
public interface WhirledContext
extends com.threerings.crowd.util.CrowdContext
+ + +

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

+ +

+

+ +

+ + + + + + + + + + + + +
+Method Summary
+ SceneDirectorgetSceneDirector() + +
+          Returns a reference to the scene director.
+  + + + + + + + +
Methods inherited from interface com.threerings.crowd.util.CrowdContext
clearPlaceView, getChatDirector, getLocationDirector, getMessageManager, getOccupantDirector, setPlaceView
+  + + + + + + + +
Methods inherited from interface com.threerings.presents.util.PresentsContext
getClient, getConfig, getDObjectManager
+  +

+ + + + + + + + +
+Method Detail
+ +

+getSceneDirector

+
+SceneDirector getSceneDirector()
+
+
Returns a reference to the scene director. +

+

+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/util/class-use/NoSuchSceneException.html b/apidocs/com/threerings/whirled/util/class-use/NoSuchSceneException.html new file mode 100644 index 00000000..f9740edf --- /dev/null +++ b/apidocs/com/threerings/whirled/util/class-use/NoSuchSceneException.html @@ -0,0 +1,218 @@ + + + + + + + +Uses of Class com.threerings.whirled.util.NoSuchSceneException (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.util.NoSuchSceneException

+
+ + + + + + + + + + + + + +
+Packages that use NoSuchSceneException
com.threerings.whirled.client.persist  
com.threerings.whirled.server.persist  
+  +

+ + + + + +
+Uses of NoSuchSceneException in com.threerings.whirled.client.persist
+  +

+ + + + + + + + + +
Methods in com.threerings.whirled.client.persist that throw NoSuchSceneException
+ SceneModelSceneRepository.loadSceneModel(int sceneId) + +
+          Fetches the model for the scene with the specified id.
+  +

+ + + + + +
+Uses of NoSuchSceneException in com.threerings.whirled.server.persist
+  +

+ + + + + + + + + + + + + +
Methods in com.threerings.whirled.server.persist that throw NoSuchSceneException
+ SceneModelSceneRepository.loadSceneModel(int sceneId) + +
+          Fetches the model for the scene with the specified scene id.
+ SceneModelDummySceneRepository.loadSceneModel(int sceneId) + +
+           
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/util/class-use/SceneFactory.html b/apidocs/com/threerings/whirled/util/class-use/SceneFactory.html new file mode 100644 index 00000000..9e43832f --- /dev/null +++ b/apidocs/com/threerings/whirled/util/class-use/SceneFactory.html @@ -0,0 +1,182 @@ + + + + + + + +Uses of Interface com.threerings.whirled.util.SceneFactory (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.whirled.util.SceneFactory

+
+ + + + + + + + + +
+Packages that use SceneFactory
com.threerings.whirled.client  
+  +

+ + + + + +
+Uses of SceneFactory in com.threerings.whirled.client
+  +

+ + + + + + + + +
Constructors in com.threerings.whirled.client with parameters of type SceneFactory
SceneDirector(WhirledContext ctx, + com.threerings.crowd.client.LocationDirector locdir, + SceneRepository screp, + SceneFactory fact) + +
+          Creates a new scene director with the specified context.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/util/class-use/UpdateList.html b/apidocs/com/threerings/whirled/util/class-use/UpdateList.html new file mode 100644 index 00000000..7217ec3d --- /dev/null +++ b/apidocs/com/threerings/whirled/util/class-use/UpdateList.html @@ -0,0 +1,189 @@ + + + + + + + +Uses of Class com.threerings.whirled.util.UpdateList (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.util.UpdateList

+
+ + + + + + + + + +
+Packages that use UpdateList
com.threerings.whirled.server.persist  
+  +

+ + + + + +
+Uses of UpdateList in com.threerings.whirled.server.persist
+  +

+ + + + + + + + + + + + + +
Methods in com.threerings.whirled.server.persist that return UpdateList
+ UpdateListSceneRepository.loadUpdates(int sceneId) + +
+          Fetches the set of updates associated with the specified scene.
+ UpdateListDummySceneRepository.loadUpdates(int sceneId) + +
+           
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/util/class-use/WhirledContext.html b/apidocs/com/threerings/whirled/util/class-use/WhirledContext.html new file mode 100644 index 00000000..eb79e9cd --- /dev/null +++ b/apidocs/com/threerings/whirled/util/class-use/WhirledContext.html @@ -0,0 +1,241 @@ + + + + + + + +Uses of Interface com.threerings.whirled.util.WhirledContext (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.whirled.util.WhirledContext

+
+ + + + + + + + + + + + + + + + + +
+Packages that use WhirledContext
com.threerings.whirled.client  
com.threerings.whirled.spot.client  
com.threerings.whirled.zone.client  
+  +

+ + + + + +
+Uses of WhirledContext in com.threerings.whirled.client
+  +

+ + + + + + + + +
Constructors in com.threerings.whirled.client with parameters of type WhirledContext
SceneDirector(WhirledContext ctx, + com.threerings.crowd.client.LocationDirector locdir, + SceneRepository screp, + SceneFactory fact) + +
+          Creates a new scene director with the specified context.
+  +

+ + + + + +
+Uses of WhirledContext in com.threerings.whirled.spot.client
+  +

+ + + + + + + + +
Constructors in com.threerings.whirled.spot.client with parameters of type WhirledContext
SpotSceneDirector(WhirledContext ctx, + com.threerings.crowd.client.LocationDirector locdir, + SceneDirector scdir) + +
+          Creates a new spot scene director with the specified context and which will cooperate with + the supplied scene director.
+  +

+ + + + + +
+Uses of WhirledContext in com.threerings.whirled.zone.client
+  +

+ + + + + + + + +
Constructors in com.threerings.whirled.zone.client with parameters of type WhirledContext
ZoneDirector(WhirledContext ctx, + SceneDirector scdir) + +
+          Constructs a zone director with the supplied context, and delegate scene director (which the + zone director will coordinate with when moving from scene to scene).
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/util/package-frame.html b/apidocs/com/threerings/whirled/util/package-frame.html new file mode 100644 index 00000000..3320eac1 --- /dev/null +++ b/apidocs/com/threerings/whirled/util/package-frame.html @@ -0,0 +1,57 @@ + + + + + + + +com.threerings.whirled.util (vilya 1.3 API) + + + + + + + + + + + +com.threerings.whirled.util + + + + +
+Interfaces  + +
+SceneFactory +
+WhirledContext
+ + + + + + +
+Classes  + +
+UpdateList
+ + + + + + +
+Exceptions  + +
+NoSuchSceneException
+ + + + diff --git a/apidocs/com/threerings/whirled/util/package-summary.html b/apidocs/com/threerings/whirled/util/package-summary.html new file mode 100644 index 00000000..608588c9 --- /dev/null +++ b/apidocs/com/threerings/whirled/util/package-summary.html @@ -0,0 +1,192 @@ + + + + + + + +com.threerings.whirled.util (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.whirled.util +

+ + + + + + + + + + + + + +
+Interface Summary
SceneFactoryThis is used by the Whirled services to obtain a Scene + implementation given a scene model and associated data.
WhirledContextThe whirled context provides access to the various managers, etc.
+  + +

+ + + + + + + + + +
+Class Summary
UpdateListA list specialized for storing SceneUpdate objects.
+  + +

+ + + + + + + + + +
+Exception Summary
NoSuchSceneExceptionThrown when an attempt to load a non-existent scene is made on the + repository.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/util/package-tree.html b/apidocs/com/threerings/whirled/util/package-tree.html new file mode 100644 index 00000000..6fe61ce7 --- /dev/null +++ b/apidocs/com/threerings/whirled/util/package-tree.html @@ -0,0 +1,168 @@ + + + + + + + +com.threerings.whirled.util Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.whirled.util +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/util/package-use.html b/apidocs/com/threerings/whirled/util/package-use.html new file mode 100644 index 00000000..62b2aa04 --- /dev/null +++ b/apidocs/com/threerings/whirled/util/package-use.html @@ -0,0 +1,262 @@ + + + + + + + +Uses of Package com.threerings.whirled.util (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.whirled.util

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
+Packages that use com.threerings.whirled.util
com.threerings.whirled.client  
com.threerings.whirled.client.persist  
com.threerings.whirled.server.persist  
com.threerings.whirled.spot.client  
com.threerings.whirled.zone.client  
+  +

+ + + + + + + + + + + +
+Classes in com.threerings.whirled.util used by com.threerings.whirled.client
SceneFactory + +
+          This is used by the Whirled services to obtain a Scene + implementation given a scene model and associated data.
WhirledContext + +
+          The whirled context provides access to the various managers, etc.
+  +

+ + + + + + + + +
+Classes in com.threerings.whirled.util used by com.threerings.whirled.client.persist
NoSuchSceneException + +
+          Thrown when an attempt to load a non-existent scene is made on the + repository.
+  +

+ + + + + + + + + + + +
+Classes in com.threerings.whirled.util used by com.threerings.whirled.server.persist
NoSuchSceneException + +
+          Thrown when an attempt to load a non-existent scene is made on the + repository.
UpdateList + +
+          A list specialized for storing SceneUpdate objects.
+  +

+ + + + + + + + +
+Classes in com.threerings.whirled.util used by com.threerings.whirled.spot.client
WhirledContext + +
+          The whirled context provides access to the various managers, etc.
+  +

+ + + + + + + + +
+Classes in com.threerings.whirled.util used by com.threerings.whirled.zone.client
WhirledContext + +
+          The whirled context provides access to the various managers, etc.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/Log.html b/apidocs/com/threerings/whirled/zone/Log.html new file mode 100644 index 00000000..291adaf9 --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/Log.html @@ -0,0 +1,265 @@ + + + + + + + +Log (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.zone +
+Class Log

+
+java.lang.Object
+  extended by com.threerings.whirled.zone.Log
+
+
+
+
public class Log
extends Object
+ + +

+Contains a reference to the log object used by the Whirled Zone services. +

+ +

+

+ +

+ + + + + + + + + + + +
+Field Summary
+static Loggerlog + +
+           
+  + + + + + + + + + + +
+Constructor Summary
Log() + +
+           
+  + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+log

+
+public static Logger log
+
+
+
+
+ + + + + + + + +
+Constructor Detail
+ +

+Log

+
+public Log()
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/class-use/Log.html b/apidocs/com/threerings/whirled/zone/class-use/Log.html new file mode 100644 index 00000000..08c0347d --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/class-use/Log.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.whirled.zone.Log (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.zone.Log

+
+No usage of com.threerings.whirled.zone.Log +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/client/ZoneAdapter.html b/apidocs/com/threerings/whirled/zone/client/ZoneAdapter.html new file mode 100644 index 00000000..9cdc87da --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/client/ZoneAdapter.html @@ -0,0 +1,329 @@ + + + + + + + +ZoneAdapter (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.zone.client +
+Class ZoneAdapter

+
+java.lang.Object
+  extended by com.threerings.whirled.zone.client.ZoneAdapter
+
+
+
All Implemented Interfaces:
ZoneObserver
+
+
+
+
public class ZoneAdapter
extends Object
implements ZoneObserver
+ + +

+The zone adapter makes life easier for a class that really only cares + about one or two of the zone observer callbacks and doesn't want to + provide empty implementations of the others. One can either extend zone + adapter, or create an anonymous instance that overrides the desired + callback(s). +

+ +

+

+
See Also:
ZoneObserver
+
+ +

+ + + + + + + + + + + +
+Constructor Summary
ZoneAdapter() + +
+           
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidzoneChangeFailed(String reason) + +
+          This is called on all zone observers when a zone change request is + rejected by the server or fails for some other reason.
+ voidzoneDidChange(ZoneSummary summary) + +
+          Called when we have switched to a new zone.
+ voidzoneWillChange(int zoneId) + +
+          Called when we begin the process of switching to a new zone.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+ZoneAdapter

+
+public ZoneAdapter()
+
+
+ + + + + + + + +
+Method Detail
+ +

+zoneWillChange

+
+public void zoneWillChange(int zoneId)
+
+
Description copied from interface: ZoneObserver
+
Called when we begin the process of switching to a new zone. This + will be followed by a call to ZoneObserver.zoneDidChange(com.threerings.whirled.zone.data.ZoneSummary) to indicate + that the change was successful or ZoneObserver.zoneChangeFailed(java.lang.String) if the + change fails. +

+

+
Specified by:
zoneWillChange in interface ZoneObserver
+
+
+
Parameters:
zoneId - the zone id of the zone to which we are changing.
+
+
+
+ +

+zoneDidChange

+
+public void zoneDidChange(ZoneSummary summary)
+
+
Description copied from interface: ZoneObserver
+
Called when we have switched to a new zone. +

+

+
Specified by:
zoneDidChange in interface ZoneObserver
+
+
+
Parameters:
summary - the summary information for the new zone or null if + we have switched to no zone.
+
+
+
+ +

+zoneChangeFailed

+
+public void zoneChangeFailed(String reason)
+
+
Description copied from interface: ZoneObserver
+
This is called on all zone observers when a zone change request is + rejected by the server or fails for some other reason. +

+

+
Specified by:
zoneChangeFailed in interface ZoneObserver
+
+
+
Parameters:
reason - the reason code that explains why the zone change + request was rejected or otherwise failed.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/client/ZoneDecoder.html b/apidocs/com/threerings/whirled/zone/client/ZoneDecoder.html new file mode 100644 index 00000000..42d26e2a --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/client/ZoneDecoder.html @@ -0,0 +1,358 @@ + + + + + + + +ZoneDecoder (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.zone.client +
+Class ZoneDecoder

+
+java.lang.Object
+  extended by com.threerings.presents.client.InvocationDecoder
+      extended by com.threerings.whirled.zone.client.ZoneDecoder
+
+
+
+
public class ZoneDecoder
extends com.threerings.presents.client.InvocationDecoder
+ + +

+Dispatches calls to a ZoneReceiver instance. +

+ +

+

+ +

+ + + + + + + + + + + + + + + +
+Field Summary
+static intFORCED_MOVE + +
+          The method id used to dispatch ZoneReceiver.forcedMove(int, int) + notifications.
+static StringRECEIVER_CODE + +
+          The generated hash code used to identify this receiver class.
+  + + + + + + + +
Fields inherited from class com.threerings.presents.client.InvocationDecoder
receiver
+  + + + + + + + + + + +
+Constructor Summary
ZoneDecoder(ZoneReceiver receiver) + +
+          Creates a decoder that may be registered to dispatch invocation + service notifications to the specified receiver.
+  + + + + + + + + + + + + + + + +
+Method Summary
+ voiddispatchNotification(int methodId, + Object[] args) + +
+           
+ StringgetReceiverCode() + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+RECEIVER_CODE

+
+public static final String RECEIVER_CODE
+
+
The generated hash code used to identify this receiver class. +

+

+
See Also:
Constant Field Values
+
+
+ +

+FORCED_MOVE

+
+public static final int FORCED_MOVE
+
+
The method id used to dispatch ZoneReceiver.forcedMove(int, int) + notifications. +

+

+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Constructor Detail
+ +

+ZoneDecoder

+
+public ZoneDecoder(ZoneReceiver receiver)
+
+
Creates a decoder that may be registered to dispatch invocation + service notifications to the specified receiver. +

+

+ + + + + + + + +
+Method Detail
+ +

+getReceiverCode

+
+public String getReceiverCode()
+
+
+
Specified by:
getReceiverCode in class com.threerings.presents.client.InvocationDecoder
+
+
+
+
+
+
+ +

+dispatchNotification

+
+public void dispatchNotification(int methodId,
+                                 Object[] args)
+
+
+
Overrides:
dispatchNotification in class com.threerings.presents.client.InvocationDecoder
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/client/ZoneDirector.html b/apidocs/com/threerings/whirled/zone/client/ZoneDirector.html new file mode 100644 index 00000000..df802c76 --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/client/ZoneDirector.html @@ -0,0 +1,639 @@ + + + + + + + +ZoneDirector (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.zone.client +
+Class ZoneDirector

+
+java.lang.Object
+  extended by com.threerings.presents.client.BasicDirector
+      extended by com.threerings.whirled.zone.client.ZoneDirector
+
+
+
All Implemented Interfaces:
com.threerings.presents.client.InvocationReceiver, com.threerings.presents.client.InvocationService.InvocationListener, com.threerings.presents.client.SessionObserver, SceneDirector.MoveHandler, ZoneReceiver, ZoneService.ZoneMoveListener
+
+
+
+
public class ZoneDirector
extends com.threerings.presents.client.BasicDirector
implements ZoneReceiver, ZoneService.ZoneMoveListener, SceneDirector.MoveHandler
+ + +

+The zone director augments the scene services with the notion of zones. Zones are + self-contained, connected groups of scenes. The normal scene director services can be used to + move from scene to scene, but moving to a new zone requires a special move request which can be + accomplished via the zone director. The zone director also makes available the zone summary + which provides information on the zone which can be used to generate an overview map or similar. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.presents.client.InvocationReceiver
com.threerings.presents.client.InvocationReceiver.Registration
+  + + + + + + + + + + + +
+Constructor Summary
ZoneDirector(WhirledContext ctx, + SceneDirector scdir) + +
+          Constructs a zone director with the supplied context, and delegate scene director (which the + zone director will coordinate with when moving from scene to scene).
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidaddZoneObserver(ZoneObserver observer) + +
+          Adds a zone observer to the list.
+ voidclientDidLogoff(com.threerings.presents.client.Client client) + +
+           
+ voidforcedMove(int zoneId, + int sceneId) + +
+          Used to communicate a required move notification to the client.
+ ZoneSummarygetZoneSummary() + +
+          Returns the summary for the zone currently occupied by the client or null if the client does + not currently occupy a zone (not a normal situation).
+ voidmoveRequiresServerSwitch(String hostname, + int[] ports) + +
+          Indicates that the client must switch to the specified server and reissue its move + request in order to relocate to its desired zone.
+ voidmoveSucceeded(int placeId, + com.threerings.crowd.data.PlaceConfig config, + ZoneSummary summary) + +
+          Called in response to a successful ZoneService.moveTo(int, int, int, com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener) request.
+ voidmoveSucceededWithScene(int placeId, + com.threerings.crowd.data.PlaceConfig config, + ZoneSummary summary, + SceneModel model) + +
+          Called in response to a successful ZoneService.moveTo(int, int, int, com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener) request when our cached + scene was out of date and the server determined that we needed an updated copy.
+ voidmoveSucceededWithUpdates(int placeId, + com.threerings.crowd.data.PlaceConfig config, + ZoneSummary summary, + SceneUpdate[] updates) + +
+          Called in response to a successful ZoneService.moveTo(int, int, int, com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener) request when our cached + scene was out of date and the server determined that we needed some updates.
+ booleanmoveTo(int zoneId, + int sceneId) + +
+          Requests that this client move the specified scene in the specified zone.
+ booleanmoveTo(int zoneId, + int sceneId, + ResultListener<com.threerings.crowd.data.PlaceConfig> rl) + +
+          Requests that this client move the specified scene in the specified zone.
+ voidrecoverMoveTo(int previousSceneId) + +
+          Should instruct the client to move the last known working location (as well as clean up + after the failed moveTo request).
+ voidremoveZoneObserver(ZoneObserver observer) + +
+          Removes a zone observer from the list.
+ voidrequestFailed(String reason) + +
+           
+  + + + + + + + +
Methods inherited from class com.threerings.presents.client.BasicDirector
clientDidLogon, clientObjectDidChange, clientWillLogon, isAvailableInStandalone, setAvailableInStandalone
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+ZoneDirector

+
+public ZoneDirector(WhirledContext ctx,
+                    SceneDirector scdir)
+
+
Constructs a zone director with the supplied context, and delegate scene director (which the + zone director will coordinate with when moving from scene to scene). A zone director is + required on the client side for systems that wish to use the zone services. +

+

+ + + + + + + + +
+Method Detail
+ +

+getZoneSummary

+
+public ZoneSummary getZoneSummary()
+
+
Returns the summary for the zone currently occupied by the client or null if the client does + not currently occupy a zone (not a normal situation). +

+

+
+
+
+
+
+
+
+ +

+addZoneObserver

+
+public void addZoneObserver(ZoneObserver observer)
+
+
Adds a zone observer to the list. This observer will subsequently be notified of effected + and failed zone changes. +

+

+
+
+
+
+
+
+
+ +

+removeZoneObserver

+
+public void removeZoneObserver(ZoneObserver observer)
+
+
Removes a zone observer from the list. +

+

+
+
+
+
+
+
+
+ +

+moveTo

+
+public boolean moveTo(int zoneId,
+                      int sceneId)
+
+
Requests that this client move the specified scene in the specified zone. A request will be + made and when the response is received, the location observers will be notified of success + or failure. +

+

+
+
+
+
+
+
+
+ +

+moveTo

+
+public boolean moveTo(int zoneId,
+                      int sceneId,
+                      ResultListener<com.threerings.crowd.data.PlaceConfig> rl)
+
+
Requests that this client move the specified scene in the specified zone. A request will be + made and when the response is received, the location observers will be notified of success + or failure. +

+

+
+
+
+
+
+
+
+ +

+clientDidLogoff

+
+public void clientDidLogoff(com.threerings.presents.client.Client client)
+
+
+
Specified by:
clientDidLogoff in interface com.threerings.presents.client.SessionObserver
Overrides:
clientDidLogoff in class com.threerings.presents.client.BasicDirector
+
+
+
+
+
+
+ +

+moveRequiresServerSwitch

+
+public void moveRequiresServerSwitch(String hostname,
+                                     int[] ports)
+
+
Description copied from interface: ZoneService.ZoneMoveListener
+
Indicates that the client must switch to the specified server and reissue its move + request in order to relocate to its desired zone. +

+

+
Specified by:
moveRequiresServerSwitch in interface ZoneService.ZoneMoveListener
+
+
+
+
+
+
+ +

+moveSucceeded

+
+public void moveSucceeded(int placeId,
+                          com.threerings.crowd.data.PlaceConfig config,
+                          ZoneSummary summary)
+
+
Description copied from interface: ZoneService.ZoneMoveListener
+
Called in response to a successful ZoneService.moveTo(int, int, int, com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener) request. +

+

+
Specified by:
moveSucceeded in interface ZoneService.ZoneMoveListener
+
+
+
+
+
+
+ +

+moveSucceededWithUpdates

+
+public void moveSucceededWithUpdates(int placeId,
+                                     com.threerings.crowd.data.PlaceConfig config,
+                                     ZoneSummary summary,
+                                     SceneUpdate[] updates)
+
+
Description copied from interface: ZoneService.ZoneMoveListener
+
Called in response to a successful ZoneService.moveTo(int, int, int, com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener) request when our cached + scene was out of date and the server determined that we needed some updates. +

+

+
Specified by:
moveSucceededWithUpdates in interface ZoneService.ZoneMoveListener
+
+
+
+
+
+
+ +

+moveSucceededWithScene

+
+public void moveSucceededWithScene(int placeId,
+                                   com.threerings.crowd.data.PlaceConfig config,
+                                   ZoneSummary summary,
+                                   SceneModel model)
+
+
Description copied from interface: ZoneService.ZoneMoveListener
+
Called in response to a successful ZoneService.moveTo(int, int, int, com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener) request when our cached + scene was out of date and the server determined that we needed an updated copy. +

+

+
Specified by:
moveSucceededWithScene in interface ZoneService.ZoneMoveListener
+
+
+
+
+
+
+ +

+requestFailed

+
+public void requestFailed(String reason)
+
+
+
Specified by:
requestFailed in interface com.threerings.presents.client.InvocationService.InvocationListener
+
+
+
+
+
+
+ +

+forcedMove

+
+public void forcedMove(int zoneId,
+                       int sceneId)
+
+
Description copied from interface: ZoneReceiver
+
Used to communicate a required move notification to the client. The server will have + removed the client from their existing scene and the client is then responsible for + generating a ZoneService.moveTo(int, int, int, com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener) request to move to the new scene in the specified + zone. +

+

+
Specified by:
forcedMove in interface ZoneReceiver
+
+
+
+
+
+
+ +

+recoverMoveTo

+
+public void recoverMoveTo(int previousSceneId)
+
+
Description copied from interface: SceneDirector.MoveHandler
+
Should instruct the client to move the last known working location (as well as clean up + after the failed moveTo request). +

+

+
Specified by:
recoverMoveTo in interface SceneDirector.MoveHandler
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/client/ZoneObserver.html b/apidocs/com/threerings/whirled/zone/client/ZoneObserver.html new file mode 100644 index 00000000..7529a94e --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/client/ZoneObserver.html @@ -0,0 +1,266 @@ + + + + + + + +ZoneObserver (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.zone.client +
+Interface ZoneObserver

+
+
All Known Implementing Classes:
ZoneAdapter
+
+
+
+
public interface ZoneObserver
+ + +

+The zone observer interface makes it possible for entities to be + notified when the client moves to a new zone. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidzoneChangeFailed(String reason) + +
+          This is called on all zone observers when a zone change request is + rejected by the server or fails for some other reason.
+ voidzoneDidChange(ZoneSummary summary) + +
+          Called when we have switched to a new zone.
+ voidzoneWillChange(int zoneId) + +
+          Called when we begin the process of switching to a new zone.
+  +

+ + + + + + + + +
+Method Detail
+ +

+zoneWillChange

+
+void zoneWillChange(int zoneId)
+
+
Called when we begin the process of switching to a new zone. This + will be followed by a call to zoneDidChange(com.threerings.whirled.zone.data.ZoneSummary) to indicate + that the change was successful or zoneChangeFailed(java.lang.String) if the + change fails. +

+

+
Parameters:
zoneId - the zone id of the zone to which we are changing.
+
+
+
+ +

+zoneDidChange

+
+void zoneDidChange(ZoneSummary summary)
+
+
Called when we have switched to a new zone. +

+

+
Parameters:
summary - the summary information for the new zone or null if + we have switched to no zone.
+
+
+
+ +

+zoneChangeFailed

+
+void zoneChangeFailed(String reason)
+
+
This is called on all zone observers when a zone change request is + rejected by the server or fails for some other reason. +

+

+
Parameters:
reason - the reason code that explains why the zone change + request was rejected or otherwise failed.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/client/ZoneReceiver.html b/apidocs/com/threerings/whirled/zone/client/ZoneReceiver.html new file mode 100644 index 00000000..1ae177b5 --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/client/ZoneReceiver.html @@ -0,0 +1,247 @@ + + + + + + + +ZoneReceiver (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.zone.client +
+Interface ZoneReceiver

+
+
All Superinterfaces:
com.threerings.presents.client.InvocationReceiver
+
+
+
All Known Implementing Classes:
ZoneDirector
+
+
+
+
public interface ZoneReceiver
extends com.threerings.presents.client.InvocationReceiver
+ + +

+Defines, for the zone services, a set of notifications delivered asynchronously by the server + to the client. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.presents.client.InvocationReceiver
com.threerings.presents.client.InvocationReceiver.Registration
+  + + + + + + + + + + + + +
+Method Summary
+ voidforcedMove(int zoneId, + int sceneId) + +
+          Used to communicate a required move notification to the client.
+  +

+ + + + + + + + +
+Method Detail
+ +

+forcedMove

+
+void forcedMove(int zoneId,
+                int sceneId)
+
+
Used to communicate a required move notification to the client. The server will have + removed the client from their existing scene and the client is then responsible for + generating a ZoneService.moveTo(int, int, int, com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener) request to move to the new scene in the specified + zone. +

+

+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/client/ZoneService.ZoneMoveListener.html b/apidocs/com/threerings/whirled/zone/client/ZoneService.ZoneMoveListener.html new file mode 100644 index 00000000..c92d1626 --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/client/ZoneService.ZoneMoveListener.html @@ -0,0 +1,330 @@ + + + + + + + +ZoneService.ZoneMoveListener (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.zone.client +
+Interface ZoneService.ZoneMoveListener

+
+
All Superinterfaces:
com.threerings.presents.client.InvocationService.InvocationListener
+
+
+
All Known Implementing Classes:
ZoneDirector, ZoneMarshaller.ZoneMoveMarshaller
+
+
+
Enclosing interface:
ZoneService
+
+
+
+
public static interface ZoneService.ZoneMoveListener
extends com.threerings.presents.client.InvocationService.InvocationListener
+ + +

+Used to deliver responses to ZoneService.moveTo(int, int, int, com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener) requests. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidmoveRequiresServerSwitch(String hostname, + int[] ports) + +
+          Indicates that the client must switch to the specified server and reissue its move + request in order to relocate to its desired zone.
+ voidmoveSucceeded(int placeId, + com.threerings.crowd.data.PlaceConfig config, + ZoneSummary summary) + +
+          Called in response to a successful ZoneService.moveTo(int, int, int, com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener) request.
+ voidmoveSucceededWithScene(int placeId, + com.threerings.crowd.data.PlaceConfig config, + ZoneSummary summary, + SceneModel model) + +
+          Called in response to a successful ZoneService.moveTo(int, int, int, com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener) request when our cached + scene was out of date and the server determined that we needed an updated copy.
+ voidmoveSucceededWithUpdates(int placeId, + com.threerings.crowd.data.PlaceConfig config, + ZoneSummary summary, + SceneUpdate[] updates) + +
+          Called in response to a successful ZoneService.moveTo(int, int, int, com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener) request when our cached + scene was out of date and the server determined that we needed some updates.
+  + + + + + + + +
Methods inherited from interface com.threerings.presents.client.InvocationService.InvocationListener
requestFailed
+  +

+ + + + + + + + +
+Method Detail
+ +

+moveSucceeded

+
+void moveSucceeded(int placeId,
+                   com.threerings.crowd.data.PlaceConfig config,
+                   ZoneSummary summary)
+
+
Called in response to a successful ZoneService.moveTo(int, int, int, com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener) request. +

+

+
+
+
+
+
+
+
+ +

+moveSucceededWithUpdates

+
+void moveSucceededWithUpdates(int placeId,
+                              com.threerings.crowd.data.PlaceConfig config,
+                              ZoneSummary summary,
+                              SceneUpdate[] updates)
+
+
Called in response to a successful ZoneService.moveTo(int, int, int, com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener) request when our cached + scene was out of date and the server determined that we needed some updates. +

+

+
+
+
+
+
+
+
+ +

+moveSucceededWithScene

+
+void moveSucceededWithScene(int placeId,
+                            com.threerings.crowd.data.PlaceConfig config,
+                            ZoneSummary summary,
+                            SceneModel model)
+
+
Called in response to a successful ZoneService.moveTo(int, int, int, com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener) request when our cached + scene was out of date and the server determined that we needed an updated copy. +

+

+
+
+
+
+
+
+
+ +

+moveRequiresServerSwitch

+
+void moveRequiresServerSwitch(String hostname,
+                              int[] ports)
+
+
Indicates that the client must switch to the specified server and reissue its move + request in order to relocate to its desired zone. +

+

+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/client/ZoneService.html b/apidocs/com/threerings/whirled/zone/client/ZoneService.html new file mode 100644 index 00000000..57413ce3 --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/client/ZoneService.html @@ -0,0 +1,255 @@ + + + + + + + +ZoneService (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.zone.client +
+Interface ZoneService

+
+
All Superinterfaces:
com.threerings.presents.client.InvocationService
+
+
+
All Known Implementing Classes:
ZoneMarshaller
+
+
+
+
public interface ZoneService
extends com.threerings.presents.client.InvocationService
+ + +

+The client interface for zone related invocation services (e.g. moving between zones). +

+ +

+

+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static interfaceZoneService.ZoneMoveListener + +
+          Used to deliver responses to moveTo(int, int, int, com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener) requests.
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.presents.client.InvocationService
com.threerings.presents.client.InvocationService.ConfirmListener, com.threerings.presents.client.InvocationService.InvocationListener, com.threerings.presents.client.InvocationService.ResultListener
+  + + + + + + + + + + + + +
+Method Summary
+ voidmoveTo(int zoneId, + int sceneId, + int version, + ZoneService.ZoneMoveListener listener) + +
+          Requests that that this client's body be moved to the specified scene in the specified zone.
+  +

+ + + + + + + + +
+Method Detail
+ +

+moveTo

+
+void moveTo(int zoneId,
+            int sceneId,
+            int version,
+            ZoneService.ZoneMoveListener listener)
+
+
Requests that that this client's body be moved to the specified scene in the specified zone. +

+

+
+
+
+
Parameters:
zoneId - the zone id to which we want to move.
sceneId - the scene id to which we want to move.
version - the version number of the scene object that we have in our local repository.
listener - receives the callback when the request succeeds or fails.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/client/class-use/ZoneAdapter.html b/apidocs/com/threerings/whirled/zone/client/class-use/ZoneAdapter.html new file mode 100644 index 00000000..a31132a8 --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/client/class-use/ZoneAdapter.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.whirled.zone.client.ZoneAdapter (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.zone.client.ZoneAdapter

+
+No usage of com.threerings.whirled.zone.client.ZoneAdapter +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/client/class-use/ZoneDecoder.html b/apidocs/com/threerings/whirled/zone/client/class-use/ZoneDecoder.html new file mode 100644 index 00000000..32468b15 --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/client/class-use/ZoneDecoder.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.whirled.zone.client.ZoneDecoder (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.zone.client.ZoneDecoder

+
+No usage of com.threerings.whirled.zone.client.ZoneDecoder +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/client/class-use/ZoneDirector.html b/apidocs/com/threerings/whirled/zone/client/class-use/ZoneDirector.html new file mode 100644 index 00000000..e9675e62 --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/client/class-use/ZoneDirector.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.whirled.zone.client.ZoneDirector (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.zone.client.ZoneDirector

+
+No usage of com.threerings.whirled.zone.client.ZoneDirector +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/client/class-use/ZoneObserver.html b/apidocs/com/threerings/whirled/zone/client/class-use/ZoneObserver.html new file mode 100644 index 00000000..0f4bcd35 --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/client/class-use/ZoneObserver.html @@ -0,0 +1,207 @@ + + + + + + + +Uses of Interface com.threerings.whirled.zone.client.ZoneObserver (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.whirled.zone.client.ZoneObserver

+
+ + + + + + + + + +
+Packages that use ZoneObserver
com.threerings.whirled.zone.client  
+  +

+ + + + + +
+Uses of ZoneObserver in com.threerings.whirled.zone.client
+  +

+ + + + + + + + + +
Classes in com.threerings.whirled.zone.client that implement ZoneObserver
+ classZoneAdapter + +
+          The zone adapter makes life easier for a class that really only cares + about one or two of the zone observer callbacks and doesn't want to + provide empty implementations of the others.
+  +

+ + + + + + + + + + + + + +
Methods in com.threerings.whirled.zone.client with parameters of type ZoneObserver
+ voidZoneDirector.addZoneObserver(ZoneObserver observer) + +
+          Adds a zone observer to the list.
+ voidZoneDirector.removeZoneObserver(ZoneObserver observer) + +
+          Removes a zone observer from the list.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/client/class-use/ZoneReceiver.html b/apidocs/com/threerings/whirled/zone/client/class-use/ZoneReceiver.html new file mode 100644 index 00000000..7817773e --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/client/class-use/ZoneReceiver.html @@ -0,0 +1,196 @@ + + + + + + + +Uses of Interface com.threerings.whirled.zone.client.ZoneReceiver (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.whirled.zone.client.ZoneReceiver

+
+ + + + + + + + + +
+Packages that use ZoneReceiver
com.threerings.whirled.zone.client  
+  +

+ + + + + +
+Uses of ZoneReceiver in com.threerings.whirled.zone.client
+  +

+ + + + + + + + + +
Classes in com.threerings.whirled.zone.client that implement ZoneReceiver
+ classZoneDirector + +
+          The zone director augments the scene services with the notion of zones.
+  +

+ + + + + + + + +
Constructors in com.threerings.whirled.zone.client with parameters of type ZoneReceiver
ZoneDecoder(ZoneReceiver receiver) + +
+          Creates a decoder that may be registered to dispatch invocation + service notifications to the specified receiver.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/client/class-use/ZoneService.ZoneMoveListener.html b/apidocs/com/threerings/whirled/zone/client/class-use/ZoneService.ZoneMoveListener.html new file mode 100644 index 00000000..912db29d --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/client/class-use/ZoneService.ZoneMoveListener.html @@ -0,0 +1,366 @@ + + + + + + + +Uses of Interface com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener

+
+ + + + + + + + + + + + + + + + + + + + + +
+Packages that use ZoneService.ZoneMoveListener
com.threerings.whirled.zone.client  
com.threerings.whirled.zone.data  
com.threerings.whirled.zone.peer.server  
com.threerings.whirled.zone.server  
+  +

+ + + + + +
+Uses of ZoneService.ZoneMoveListener in com.threerings.whirled.zone.client
+  +

+ + + + + + + + + +
Classes in com.threerings.whirled.zone.client that implement ZoneService.ZoneMoveListener
+ classZoneDirector + +
+          The zone director augments the scene services with the notion of zones.
+  +

+ + + + + + + + + +
Methods in com.threerings.whirled.zone.client with parameters of type ZoneService.ZoneMoveListener
+ voidZoneService.moveTo(int zoneId, + int sceneId, + int version, + ZoneService.ZoneMoveListener listener) + +
+          Requests that that this client's body be moved to the specified scene in the specified zone.
+  +

+ + + + + +
+Uses of ZoneService.ZoneMoveListener in com.threerings.whirled.zone.data
+  +

+ + + + + + + + + +
Classes in com.threerings.whirled.zone.data that implement ZoneService.ZoneMoveListener
+static classZoneMarshaller.ZoneMoveMarshaller + +
+          Marshalls results to implementations of ZoneService.ZoneMoveListener.
+  +

+ + + + + + + + + +
Methods in com.threerings.whirled.zone.data with parameters of type ZoneService.ZoneMoveListener
+ voidZoneMarshaller.moveTo(int arg1, + int arg2, + int arg3, + ZoneService.ZoneMoveListener arg4) + +
+           
+  +

+ + + + + +
+Uses of ZoneService.ZoneMoveListener in com.threerings.whirled.zone.peer.server
+  +

+ + + + + + + + + +
Methods in com.threerings.whirled.zone.peer.server with parameters of type ZoneService.ZoneMoveListener
+ voidPeeredZoneRegistry.moveTo(com.threerings.presents.data.ClientObject caller, + int zoneId, + int sceneId, + int sceneVer, + ZoneService.ZoneMoveListener listener) + +
+           
+  +

+ + + + + + + + +
Constructors in com.threerings.whirled.zone.peer.server with parameters of type ZoneService.ZoneMoveListener
PeeredZoneRegistry.PeerZoneMoveHandler(com.threerings.crowd.server.LocationManager locman, + ZoneManager zmgr, + SceneRegistry scReg, + com.threerings.crowd.data.BodyObject body, + int sceneId, + int sceneVer, + ZoneService.ZoneMoveListener listener) + +
+           
+  +

+ + + + + +
+Uses of ZoneService.ZoneMoveListener in com.threerings.whirled.zone.server
+  +

+ + + + + + + + + + + + + +
Methods in com.threerings.whirled.zone.server with parameters of type ZoneService.ZoneMoveListener
+ voidZoneRegistry.moveTo(com.threerings.presents.data.ClientObject caller, + int zoneId, + int sceneId, + int sceneVer, + ZoneService.ZoneMoveListener listener) + +
+           
+ voidZoneProvider.moveTo(com.threerings.presents.data.ClientObject caller, + int arg1, + int arg2, + int arg3, + ZoneService.ZoneMoveListener arg4) + +
+          Handles a ZoneService.moveTo(int, int, int, com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener) request.
+  +

+ + + + + + + + +
Constructors in com.threerings.whirled.zone.server with parameters of type ZoneService.ZoneMoveListener
ZoneMoveHandler(com.threerings.crowd.server.LocationManager locmgr, + ZoneManager zmgr, + SceneRegistry screg, + com.threerings.crowd.data.BodyObject body, + int sceneId, + int sceneVer, + ZoneService.ZoneMoveListener listener) + +
+           
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/client/class-use/ZoneService.html b/apidocs/com/threerings/whirled/zone/client/class-use/ZoneService.html new file mode 100644 index 00000000..732427ca --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/client/class-use/ZoneService.html @@ -0,0 +1,183 @@ + + + + + + + +Uses of Interface com.threerings.whirled.zone.client.ZoneService (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.whirled.zone.client.ZoneService

+
+ + + + + + + + + +
+Packages that use ZoneService
com.threerings.whirled.zone.data  
+  +

+ + + + + +
+Uses of ZoneService in com.threerings.whirled.zone.data
+  +

+ + + + + + + + + +
Classes in com.threerings.whirled.zone.data that implement ZoneService
+ classZoneMarshaller + +
+          Provides the implementation of the ZoneService interface + that marshalls the arguments and delivers the request to the provider + on the server.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/client/package-frame.html b/apidocs/com/threerings/whirled/zone/client/package-frame.html new file mode 100644 index 00000000..4ed784ac --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/client/package-frame.html @@ -0,0 +1,54 @@ + + + + + + + +com.threerings.whirled.zone.client (vilya 1.3 API) + + + + + + + + + + + +com.threerings.whirled.zone.client + + + + +
+Interfaces  + +
+ZoneObserver +
+ZoneReceiver +
+ZoneService +
+ZoneService.ZoneMoveListener
+ + + + + + +
+Classes  + +
+ZoneAdapter +
+ZoneDecoder +
+ZoneDirector
+ + + + diff --git a/apidocs/com/threerings/whirled/zone/client/package-summary.html b/apidocs/com/threerings/whirled/zone/client/package-summary.html new file mode 100644 index 00000000..d67e687f --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/client/package-summary.html @@ -0,0 +1,196 @@ + + + + + + + +com.threerings.whirled.zone.client (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.whirled.zone.client +

+ + + + + + + + + + + + + + + + + + + + + +
+Interface Summary
ZoneObserverThe zone observer interface makes it possible for entities to be + notified when the client moves to a new zone.
ZoneReceiverDefines, for the zone services, a set of notifications delivered asynchronously by the server + to the client.
ZoneServiceThe client interface for zone related invocation services (e.g.
ZoneService.ZoneMoveListenerUsed to deliver responses to ZoneService.moveTo(int, int, int, com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener) requests.
+  + +

+ + + + + + + + + + + + + + + + + +
+Class Summary
ZoneAdapterThe zone adapter makes life easier for a class that really only cares + about one or two of the zone observer callbacks and doesn't want to + provide empty implementations of the others.
ZoneDecoderDispatches calls to a ZoneReceiver instance.
ZoneDirectorThe zone director augments the scene services with the notion of zones.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/client/package-tree.html b/apidocs/com/threerings/whirled/zone/client/package-tree.html new file mode 100644 index 00000000..70cc00c0 --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/client/package-tree.html @@ -0,0 +1,172 @@ + + + + + + + +com.threerings.whirled.zone.client Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.whirled.zone.client +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/client/package-use.html b/apidocs/com/threerings/whirled/zone/client/package-use.html new file mode 100644 index 00000000..5f88ff8f --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/client/package-use.html @@ -0,0 +1,248 @@ + + + + + + + +Uses of Package com.threerings.whirled.zone.client (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.whirled.zone.client

+
+ + + + + + + + + + + + + + + + + + + + + +
+Packages that use com.threerings.whirled.zone.client
com.threerings.whirled.zone.client  
com.threerings.whirled.zone.data  
com.threerings.whirled.zone.peer.server  
com.threerings.whirled.zone.server  
+  +

+ + + + + + + + + + + + + + +
+Classes in com.threerings.whirled.zone.client used by com.threerings.whirled.zone.client
ZoneObserver + +
+          The zone observer interface makes it possible for entities to be + notified when the client moves to a new zone.
ZoneReceiver + +
+          Defines, for the zone services, a set of notifications delivered asynchronously by the server + to the client.
ZoneService.ZoneMoveListener + +
+          Used to deliver responses to ZoneService.moveTo(int, int, int, com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener) requests.
+  +

+ + + + + + + + + + + +
+Classes in com.threerings.whirled.zone.client used by com.threerings.whirled.zone.data
ZoneService + +
+          The client interface for zone related invocation services (e.g.
ZoneService.ZoneMoveListener + +
+          Used to deliver responses to ZoneService.moveTo(int, int, int, com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener) requests.
+  +

+ + + + + + + + +
+Classes in com.threerings.whirled.zone.client used by com.threerings.whirled.zone.peer.server
ZoneService.ZoneMoveListener + +
+          Used to deliver responses to ZoneService.moveTo(int, int, int, com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener) requests.
+  +

+ + + + + + + + +
+Classes in com.threerings.whirled.zone.client used by com.threerings.whirled.zone.server
ZoneService.ZoneMoveListener + +
+          Used to deliver responses to ZoneService.moveTo(int, int, int, com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener) requests.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/data/SceneSummary.html b/apidocs/com/threerings/whirled/zone/data/SceneSummary.html new file mode 100644 index 00000000..31c1e9c7 --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/data/SceneSummary.html @@ -0,0 +1,385 @@ + + + + + + + +SceneSummary (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.zone.data +
+Class SceneSummary

+
+java.lang.Object
+  extended by com.threerings.whirled.zone.data.SceneSummary
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable
+
+
+
+
public class SceneSummary
extends Object
implements com.threerings.io.Streamable
+ + +

+The scene summary class is used to provide info about the connected + group of scenes that make up a zone. The group of scenes that make up a + zone is a self-contained set of scenes, connected with one another (by + portals) but not to any scenes outside the group. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+ Stringname + +
+          The name of this scene.
+ int[]neighborDirs + +
+          The directions in which each of the neighbors lay.
+ int[]neighbors + +
+          The ids of the scenes to which this scene is connected via + portals.
+ intsceneId + +
+          The id of this scene.
+  + + + + + + + + + + +
+Constructor Summary
SceneSummary() + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ StringtoString() + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+sceneId

+
+public int sceneId
+
+
The id of this scene. +

+

+
+
+
+ +

+name

+
+public String name
+
+
The name of this scene. +

+

+
+
+
+ +

+neighbors

+
+public int[] neighbors
+
+
The ids of the scenes to which this scene is connected via + portals. +

+

+
+
+
+ +

+neighborDirs

+
+public int[] neighborDirs
+
+
The directions in which each of the neighbors lay. +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+SceneSummary

+
+public SceneSummary()
+
+
+ + + + + + + + +
+Method Detail
+ +

+toString

+
+public String toString()
+
+
+
Overrides:
toString in class Object
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/data/ZoneCodes.html b/apidocs/com/threerings/whirled/zone/data/ZoneCodes.html new file mode 100644 index 00000000..f9ecda69 --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/data/ZoneCodes.html @@ -0,0 +1,244 @@ + + + + + + + +ZoneCodes (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.zone.data +
+Interface ZoneCodes

+
+
All Superinterfaces:
com.threerings.presents.data.InvocationCodes, com.threerings.crowd.data.LocationCodes, SceneCodes
+
+
+
+
public interface ZoneCodes
extends SceneCodes
+ + +

+Contains codes used by the zone services. +

+ +

+

+ +

+ + + + + + + + + + + +
+Field Summary
+static StringNO_SUCH_ZONE + +
+          An error code indicating that a zone identified by a particular + zone id does not exist.
+  + + + + + + + +
Fields inherited from interface com.threerings.whirled.data.SceneCodes
SCENE_UPDATE, WHIRLED_GROUP
+  + + + + + + + +
Fields inherited from interface com.threerings.crowd.data.LocationCodes
ALREADY_THERE, MOVE_IN_PROGRESS, NO_SUCH_PLACE
+  + + + + + + + +
Fields inherited from interface com.threerings.presents.data.InvocationCodes
ACCESS_DENIED, E_ACCESS_DENIED, E_INTERNAL_ERROR, GLOBAL_GROUP, INTERNAL_ERROR
+  +

+ + + + + + + + +
+Field Detail
+ +

+NO_SUCH_ZONE

+
+static final String NO_SUCH_ZONE
+
+
An error code indicating that a zone identified by a particular + zone id does not exist. Usually generated by a failed moveTo + request. +

+

+
See Also:
Constant Field Values
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/data/ZoneMarshaller.ZoneMoveMarshaller.html b/apidocs/com/threerings/whirled/zone/data/ZoneMarshaller.ZoneMoveMarshaller.html new file mode 100644 index 00000000..7178e346 --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/data/ZoneMarshaller.ZoneMoveMarshaller.html @@ -0,0 +1,545 @@ + + + + + + + +ZoneMarshaller.ZoneMoveMarshaller (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.zone.data +
+Class ZoneMarshaller.ZoneMoveMarshaller

+
+java.lang.Object
+  extended by com.threerings.presents.data.InvocationMarshaller.ListenerMarshaller
+      extended by com.threerings.whirled.zone.data.ZoneMarshaller.ZoneMoveMarshaller
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable, com.threerings.presents.client.InvocationService.InvocationListener, ZoneService.ZoneMoveListener
+
+
+
Enclosing class:
ZoneMarshaller
+
+
+
+
public static class ZoneMarshaller.ZoneMoveMarshaller
extends com.threerings.presents.data.InvocationMarshaller.ListenerMarshaller
implements ZoneService.ZoneMoveListener
+ + +

+Marshalls results to implementations of ZoneService.ZoneMoveListener. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static intMOVE_REQUIRES_SERVER_SWITCH + +
+          The method id used to dispatch moveRequiresServerSwitch(java.lang.String, int[]) + responses.
+static intMOVE_SUCCEEDED + +
+          The method id used to dispatch moveSucceeded(int, com.threerings.crowd.data.PlaceConfig, com.threerings.whirled.zone.data.ZoneSummary) + responses.
+static intMOVE_SUCCEEDED_WITH_SCENE + +
+          The method id used to dispatch moveSucceededWithScene(int, com.threerings.crowd.data.PlaceConfig, com.threerings.whirled.zone.data.ZoneSummary, com.threerings.whirled.data.SceneModel) + responses.
+static intMOVE_SUCCEEDED_WITH_UPDATES + +
+          The method id used to dispatch moveSucceededWithUpdates(int, com.threerings.crowd.data.PlaceConfig, com.threerings.whirled.zone.data.ZoneSummary, com.threerings.whirled.data.SceneUpdate[]) + responses.
+  + + + + + + + +
Fields inherited from class com.threerings.presents.data.InvocationMarshaller.ListenerMarshaller
callerOid, listener, mapStamp, omgr, REQUEST_FAILED_RSPID, requestId, transport
+  + + + + + + + + + + +
+Constructor Summary
ZoneMarshaller.ZoneMoveMarshaller() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voiddispatchResponse(int methodId, + Object[] args) + +
+           
+ voidmoveRequiresServerSwitch(String arg1, + int[] arg2) + +
+          Indicates that the client must switch to the specified server and reissue its move + request in order to relocate to its desired zone.
+ voidmoveSucceeded(int arg1, + com.threerings.crowd.data.PlaceConfig arg2, + ZoneSummary arg3) + +
+          Called in response to a successful ZoneService.moveTo(int, int, int, com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener) request.
+ voidmoveSucceededWithScene(int arg1, + com.threerings.crowd.data.PlaceConfig arg2, + ZoneSummary arg3, + SceneModel arg4) + +
+          Called in response to a successful ZoneService.moveTo(int, int, int, com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener) request when our cached + scene was out of date and the server determined that we needed an updated copy.
+ voidmoveSucceededWithUpdates(int arg1, + com.threerings.crowd.data.PlaceConfig arg2, + ZoneSummary arg3, + SceneUpdate[] arg4) + +
+          Called in response to a successful ZoneService.moveTo(int, int, int, com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener) request when our cached + scene was out of date and the server determined that we needed some updates.
+  + + + + + + + +
Methods inherited from class com.threerings.presents.data.InvocationMarshaller.ListenerMarshaller
requestFailed, setInvocationId, setNoResponse, toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  + + + + + + + +
Methods inherited from interface com.threerings.presents.client.InvocationService.InvocationListener
requestFailed
+  +

+ + + + + + + + +
+Field Detail
+ +

+MOVE_REQUIRES_SERVER_SWITCH

+
+public static final int MOVE_REQUIRES_SERVER_SWITCH
+
+
The method id used to dispatch moveRequiresServerSwitch(java.lang.String, int[]) + responses. +

+

+
See Also:
Constant Field Values
+
+
+ +

+MOVE_SUCCEEDED

+
+public static final int MOVE_SUCCEEDED
+
+
The method id used to dispatch moveSucceeded(int, com.threerings.crowd.data.PlaceConfig, com.threerings.whirled.zone.data.ZoneSummary) + responses. +

+

+
See Also:
Constant Field Values
+
+
+ +

+MOVE_SUCCEEDED_WITH_SCENE

+
+public static final int MOVE_SUCCEEDED_WITH_SCENE
+
+
The method id used to dispatch moveSucceededWithScene(int, com.threerings.crowd.data.PlaceConfig, com.threerings.whirled.zone.data.ZoneSummary, com.threerings.whirled.data.SceneModel) + responses. +

+

+
See Also:
Constant Field Values
+
+
+ +

+MOVE_SUCCEEDED_WITH_UPDATES

+
+public static final int MOVE_SUCCEEDED_WITH_UPDATES
+
+
The method id used to dispatch moveSucceededWithUpdates(int, com.threerings.crowd.data.PlaceConfig, com.threerings.whirled.zone.data.ZoneSummary, com.threerings.whirled.data.SceneUpdate[]) + responses. +

+

+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Constructor Detail
+ +

+ZoneMarshaller.ZoneMoveMarshaller

+
+public ZoneMarshaller.ZoneMoveMarshaller()
+
+
+ + + + + + + + +
+Method Detail
+ +

+moveRequiresServerSwitch

+
+public void moveRequiresServerSwitch(String arg1,
+                                     int[] arg2)
+
+
Description copied from interface: ZoneService.ZoneMoveListener
+
Indicates that the client must switch to the specified server and reissue its move + request in order to relocate to its desired zone. +

+

+
Specified by:
moveRequiresServerSwitch in interface ZoneService.ZoneMoveListener
+
+
+
+
+
+
+ +

+moveSucceeded

+
+public void moveSucceeded(int arg1,
+                          com.threerings.crowd.data.PlaceConfig arg2,
+                          ZoneSummary arg3)
+
+
Description copied from interface: ZoneService.ZoneMoveListener
+
Called in response to a successful ZoneService.moveTo(int, int, int, com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener) request. +

+

+
Specified by:
moveSucceeded in interface ZoneService.ZoneMoveListener
+
+
+
+
+
+
+ +

+moveSucceededWithScene

+
+public void moveSucceededWithScene(int arg1,
+                                   com.threerings.crowd.data.PlaceConfig arg2,
+                                   ZoneSummary arg3,
+                                   SceneModel arg4)
+
+
Description copied from interface: ZoneService.ZoneMoveListener
+
Called in response to a successful ZoneService.moveTo(int, int, int, com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener) request when our cached + scene was out of date and the server determined that we needed an updated copy. +

+

+
Specified by:
moveSucceededWithScene in interface ZoneService.ZoneMoveListener
+
+
+
+
+
+
+ +

+moveSucceededWithUpdates

+
+public void moveSucceededWithUpdates(int arg1,
+                                     com.threerings.crowd.data.PlaceConfig arg2,
+                                     ZoneSummary arg3,
+                                     SceneUpdate[] arg4)
+
+
Description copied from interface: ZoneService.ZoneMoveListener
+
Called in response to a successful ZoneService.moveTo(int, int, int, com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener) request when our cached + scene was out of date and the server determined that we needed some updates. +

+

+
Specified by:
moveSucceededWithUpdates in interface ZoneService.ZoneMoveListener
+
+
+
+
+
+
+ +

+dispatchResponse

+
+public void dispatchResponse(int methodId,
+                             Object[] args)
+
+
+
Overrides:
dispatchResponse in class com.threerings.presents.data.InvocationMarshaller.ListenerMarshaller
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/data/ZoneMarshaller.html b/apidocs/com/threerings/whirled/zone/data/ZoneMarshaller.html new file mode 100644 index 00000000..0cb8d408 --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/data/ZoneMarshaller.html @@ -0,0 +1,383 @@ + + + + + + + +ZoneMarshaller (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.zone.data +
+Class ZoneMarshaller

+
+java.lang.Object
+  extended by com.threerings.presents.data.InvocationMarshaller
+      extended by com.threerings.whirled.zone.data.ZoneMarshaller
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable, com.threerings.presents.client.InvocationService, ZoneService
+
+
+
+
@Generated(value="com.threerings.presents.tools.GenServiceTask",
+           comments="Derived from ZoneService.java.")
+public class ZoneMarshaller
extends com.threerings.presents.data.InvocationMarshaller
implements ZoneService
+ + +

+Provides the implementation of the ZoneService interface + that marshalls the arguments and delivers the request to the provider + on the server. Also provides an implementation of the response listener + interfaces that marshall the response arguments and deliver them back + to the requesting client. +

+ +

+

+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static classZoneMarshaller.ZoneMoveMarshaller + +
+          Marshalls results to implementations of ZoneService.ZoneMoveListener.
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.presents.data.InvocationMarshaller
com.threerings.presents.data.InvocationMarshaller.ConfirmMarshaller, com.threerings.presents.data.InvocationMarshaller.ListenerMarshaller, com.threerings.presents.data.InvocationMarshaller.ResultMarshaller
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.whirled.zone.client.ZoneService
ZoneService.ZoneMoveListener
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.presents.client.InvocationService
com.threerings.presents.client.InvocationService.ConfirmListener, com.threerings.presents.client.InvocationService.InvocationListener, com.threerings.presents.client.InvocationService.ResultListener
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + +
+Field Summary
+static intMOVE_TO + +
+          The method id used to dispatch moveTo(int, int, int, com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener) requests.
+  + + + + + + + + + + +
+Constructor Summary
ZoneMarshaller() + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ voidmoveTo(int arg1, + int arg2, + int arg3, + ZoneService.ZoneMoveListener arg4) + +
+          Requests that that this client's body be moved to the specified scene in the specified zone.
+  + + + + + + + +
Methods inherited from class com.threerings.presents.data.InvocationMarshaller
getInvocationCode, init, readField__invCode, readField__invOid, readObject, setInvocationOid, setNoResponse, toString, writeField__invCode, writeField__invOid
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+MOVE_TO

+
+public static final int MOVE_TO
+
+
The method id used to dispatch moveTo(int, int, int, com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener) requests. +

+

+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Constructor Detail
+ +

+ZoneMarshaller

+
+public ZoneMarshaller()
+
+
+ + + + + + + + +
+Method Detail
+ +

+moveTo

+
+public void moveTo(int arg1,
+                   int arg2,
+                   int arg3,
+                   ZoneService.ZoneMoveListener arg4)
+
+
Description copied from interface: ZoneService
+
Requests that that this client's body be moved to the specified scene in the specified zone. +

+

+
Specified by:
moveTo in interface ZoneService
+
+
+
Parameters:
arg1 - the zone id to which we want to move.
arg2 - the scene id to which we want to move.
arg3 - the version number of the scene object that we have in our local repository.
arg4 - receives the callback when the request succeeds or fails.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/data/ZoneSummary.html b/apidocs/com/threerings/whirled/zone/data/ZoneSummary.html new file mode 100644 index 00000000..9dee7044 --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/data/ZoneSummary.html @@ -0,0 +1,363 @@ + + + + + + + +ZoneSummary (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.zone.data +
+Class ZoneSummary

+
+java.lang.Object
+  extended by com.threerings.io.SimpleStreamableObject
+      extended by com.threerings.whirled.zone.data.ZoneSummary
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable
+
+
+
+
public class ZoneSummary
extends com.threerings.io.SimpleStreamableObject
+ + +

+The zone summary contains information on a zone, including its name and + summary info on all of the scenes in this zone (which can be used to + generate a map of the zone on the client). +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + + + + + + + + + +
+Field Summary
+ com.threerings.util.Namename + +
+          The name of the zone.
+ SceneSummary[]scenes + +
+          The summary information for all of the scenes in the zone.
+ intzoneId + +
+          The zone's fully qualified unique identifier.
+  + + + + + + + + + + +
+Constructor Summary
ZoneSummary() + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ StringtoString() + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+zoneId

+
+public int zoneId
+
+
The zone's fully qualified unique identifier. +

+

+
+
+
+ +

+name

+
+public com.threerings.util.Name name
+
+
The name of the zone. +

+

+
+
+
+ +

+scenes

+
+public SceneSummary[] scenes
+
+
The summary information for all of the scenes in the zone. +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+ZoneSummary

+
+public ZoneSummary()
+
+
+ + + + + + + + +
+Method Detail
+ +

+toString

+
+public String toString()
+
+
+
Overrides:
toString in class com.threerings.io.SimpleStreamableObject
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/data/ZonedBodyObject.html b/apidocs/com/threerings/whirled/zone/data/ZonedBodyObject.html new file mode 100644 index 00000000..2f074723 --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/data/ZonedBodyObject.html @@ -0,0 +1,235 @@ + + + + + + + +ZonedBodyObject (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.zone.data +
+Interface ZonedBodyObject

+
+
+
public interface ZonedBodyObject
+ + +

+A system that uses the zone services must extend BodyObject and implement this + interface. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + +
+Method Summary
+ intgetZoneId() + +
+          Returns the zone id currently occupied by this body.
+ voidsetZoneId(int zoneId) + +
+          Sets the zone id currently occupied by this body.
+  +

+ + + + + + + + +
+Method Detail
+ +

+getZoneId

+
+int getZoneId()
+
+
Returns the zone id currently occupied by this body. +

+

+
+
+
+
+ +

+setZoneId

+
+void setZoneId(int zoneId)
+
+
Sets the zone id currently occupied by this body. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/data/class-use/SceneSummary.html b/apidocs/com/threerings/whirled/zone/data/class-use/SceneSummary.html new file mode 100644 index 00000000..2b797444 --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/data/class-use/SceneSummary.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class com.threerings.whirled.zone.data.SceneSummary (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.zone.data.SceneSummary

+
+ + + + + + + + + +
+Packages that use SceneSummary
com.threerings.whirled.zone.data  
+  +

+ + + + + +
+Uses of SceneSummary in com.threerings.whirled.zone.data
+  +

+ + + + + + + + + +
Fields in com.threerings.whirled.zone.data declared as SceneSummary
+ SceneSummary[]ZoneSummary.scenes + +
+          The summary information for all of the scenes in the zone.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/data/class-use/ZoneCodes.html b/apidocs/com/threerings/whirled/zone/data/class-use/ZoneCodes.html new file mode 100644 index 00000000..19120233 --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/data/class-use/ZoneCodes.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Interface com.threerings.whirled.zone.data.ZoneCodes (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.whirled.zone.data.ZoneCodes

+
+No usage of com.threerings.whirled.zone.data.ZoneCodes +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/data/class-use/ZoneMarshaller.ZoneMoveMarshaller.html b/apidocs/com/threerings/whirled/zone/data/class-use/ZoneMarshaller.ZoneMoveMarshaller.html new file mode 100644 index 00000000..acfb3940 --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/data/class-use/ZoneMarshaller.ZoneMoveMarshaller.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.whirled.zone.data.ZoneMarshaller.ZoneMoveMarshaller (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.zone.data.ZoneMarshaller.ZoneMoveMarshaller

+
+No usage of com.threerings.whirled.zone.data.ZoneMarshaller.ZoneMoveMarshaller +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/data/class-use/ZoneMarshaller.html b/apidocs/com/threerings/whirled/zone/data/class-use/ZoneMarshaller.html new file mode 100644 index 00000000..092a6e7e --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/data/class-use/ZoneMarshaller.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.whirled.zone.data.ZoneMarshaller (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.zone.data.ZoneMarshaller

+
+No usage of com.threerings.whirled.zone.data.ZoneMarshaller +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/data/class-use/ZoneSummary.html b/apidocs/com/threerings/whirled/zone/data/class-use/ZoneSummary.html new file mode 100644 index 00000000..aae8f658 --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/data/class-use/ZoneSummary.html @@ -0,0 +1,362 @@ + + + + + + + +Uses of Class com.threerings.whirled.zone.data.ZoneSummary (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.zone.data.ZoneSummary

+
+ + + + + + + + + + + + + + + + + +
+Packages that use ZoneSummary
com.threerings.whirled.zone.client  
com.threerings.whirled.zone.data  
com.threerings.whirled.zone.server  
+  +

+ + + + + +
+Uses of ZoneSummary in com.threerings.whirled.zone.client
+  +

+ + + + + + + + + +
Methods in com.threerings.whirled.zone.client that return ZoneSummary
+ ZoneSummaryZoneDirector.getZoneSummary() + +
+          Returns the summary for the zone currently occupied by the client or null if the client does + not currently occupy a zone (not a normal situation).
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in com.threerings.whirled.zone.client with parameters of type ZoneSummary
+ voidZoneService.ZoneMoveListener.moveSucceeded(int placeId, + com.threerings.crowd.data.PlaceConfig config, + ZoneSummary summary) + +
+          Called in response to a successful ZoneService.moveTo(int, int, int, com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener) request.
+ voidZoneDirector.moveSucceeded(int placeId, + com.threerings.crowd.data.PlaceConfig config, + ZoneSummary summary) + +
+           
+ voidZoneService.ZoneMoveListener.moveSucceededWithScene(int placeId, + com.threerings.crowd.data.PlaceConfig config, + ZoneSummary summary, + SceneModel model) + +
+          Called in response to a successful ZoneService.moveTo(int, int, int, com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener) request when our cached + scene was out of date and the server determined that we needed an updated copy.
+ voidZoneDirector.moveSucceededWithScene(int placeId, + com.threerings.crowd.data.PlaceConfig config, + ZoneSummary summary, + SceneModel model) + +
+           
+ voidZoneService.ZoneMoveListener.moveSucceededWithUpdates(int placeId, + com.threerings.crowd.data.PlaceConfig config, + ZoneSummary summary, + SceneUpdate[] updates) + +
+          Called in response to a successful ZoneService.moveTo(int, int, int, com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener) request when our cached + scene was out of date and the server determined that we needed some updates.
+ voidZoneDirector.moveSucceededWithUpdates(int placeId, + com.threerings.crowd.data.PlaceConfig config, + ZoneSummary summary, + SceneUpdate[] updates) + +
+           
+ voidZoneObserver.zoneDidChange(ZoneSummary summary) + +
+          Called when we have switched to a new zone.
+ voidZoneAdapter.zoneDidChange(ZoneSummary summary) + +
+           
+  +

+ + + + + +
+Uses of ZoneSummary in com.threerings.whirled.zone.data
+  +

+ + + + + + + + + + + + + + + + + +
Methods in com.threerings.whirled.zone.data with parameters of type ZoneSummary
+ voidZoneMarshaller.ZoneMoveMarshaller.moveSucceeded(int arg1, + com.threerings.crowd.data.PlaceConfig arg2, + ZoneSummary arg3) + +
+           
+ voidZoneMarshaller.ZoneMoveMarshaller.moveSucceededWithScene(int arg1, + com.threerings.crowd.data.PlaceConfig arg2, + ZoneSummary arg3, + SceneModel arg4) + +
+           
+ voidZoneMarshaller.ZoneMoveMarshaller.moveSucceededWithUpdates(int arg1, + com.threerings.crowd.data.PlaceConfig arg2, + ZoneSummary arg3, + SceneUpdate[] arg4) + +
+           
+  +

+ + + + + +
+Uses of ZoneSummary in com.threerings.whirled.zone.server
+  +

+ + + + + + + + + + + + + +
Methods in com.threerings.whirled.zone.server with parameters of type ZoneSummary
+ voidZoneMoveHandler.zoneWasResolved(ZoneSummary summary) + +
+           
+ voidZoneManager.ResolutionListener.zoneWasResolved(ZoneSummary summary) + +
+          Called when a zone was successfully resolved.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/data/class-use/ZonedBodyObject.html b/apidocs/com/threerings/whirled/zone/data/class-use/ZonedBodyObject.html new file mode 100644 index 00000000..6b55086b --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/data/class-use/ZonedBodyObject.html @@ -0,0 +1,192 @@ + + + + + + + +Uses of Interface com.threerings.whirled.zone.data.ZonedBodyObject (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.whirled.zone.data.ZonedBodyObject

+
+ + + + + + + + + +
+Packages that use ZonedBodyObject
com.threerings.whirled.zone.server  
+  +

+ + + + + +
+Uses of ZonedBodyObject in com.threerings.whirled.zone.server
+  +

+ + + + + + + + + + + + + +
Methods in com.threerings.whirled.zone.server with parameters of type ZonedBodyObject
+ StringZoneRegistry.leaveOccupiedZone(ZonedBodyObject source) + +
+          Ejects the specified body from their current scene and zone.
+ StringZoneRegistry.moveBody(ZonedBodyObject source, + int zoneId, + int sceneId) + +
+          Ejects the specified body from their current scene and sends them a request to move to the + specified new zone and scene.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/data/package-frame.html b/apidocs/com/threerings/whirled/zone/data/package-frame.html new file mode 100644 index 00000000..da200337 --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/data/package-frame.html @@ -0,0 +1,52 @@ + + + + + + + +com.threerings.whirled.zone.data (vilya 1.3 API) + + + + + + + + + + + +com.threerings.whirled.zone.data + + + + +
+Interfaces  + +
+ZoneCodes +
+ZonedBodyObject
+ + + + + + +
+Classes  + +
+SceneSummary +
+ZoneMarshaller +
+ZoneMarshaller.ZoneMoveMarshaller +
+ZoneSummary
+ + + + diff --git a/apidocs/com/threerings/whirled/zone/data/package-summary.html b/apidocs/com/threerings/whirled/zone/data/package-summary.html new file mode 100644 index 00000000..c7f61336 --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/data/package-summary.html @@ -0,0 +1,194 @@ + + + + + + + +com.threerings.whirled.zone.data (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.whirled.zone.data +

+ + + + + + + + + + + + + +
+Interface Summary
ZoneCodesContains codes used by the zone services.
ZonedBodyObjectA system that uses the zone services must extend BodyObject and implement this + interface.
+  + +

+ + + + + + + + + + + + + + + + + + + + + +
+Class Summary
SceneSummaryThe scene summary class is used to provide info about the connected + group of scenes that make up a zone.
ZoneMarshallerProvides the implementation of the ZoneService interface + that marshalls the arguments and delivers the request to the provider + on the server.
ZoneMarshaller.ZoneMoveMarshallerMarshalls results to implementations of ZoneService.ZoneMoveListener.
ZoneSummaryThe zone summary contains information on a zone, including its name and + summary info on all of the scenes in this zone (which can be used to + generate a map of the zone on the client).
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/data/package-tree.html b/apidocs/com/threerings/whirled/zone/data/package-tree.html new file mode 100644 index 00000000..cde575f0 --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/data/package-tree.html @@ -0,0 +1,177 @@ + + + + + + + +com.threerings.whirled.zone.data Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.whirled.zone.data +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/data/package-use.html b/apidocs/com/threerings/whirled/zone/data/package-use.html new file mode 100644 index 00000000..f8db7855 --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/data/package-use.html @@ -0,0 +1,229 @@ + + + + + + + +Uses of Package com.threerings.whirled.zone.data (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.whirled.zone.data

+
+ + + + + + + + + + + + + + + + + +
+Packages that use com.threerings.whirled.zone.data
com.threerings.whirled.zone.client  
com.threerings.whirled.zone.data  
com.threerings.whirled.zone.server  
+  +

+ + + + + + + + +
+Classes in com.threerings.whirled.zone.data used by com.threerings.whirled.zone.client
ZoneSummary + +
+          The zone summary contains information on a zone, including its name and + summary info on all of the scenes in this zone (which can be used to + generate a map of the zone on the client).
+  +

+ + + + + + + + + + + +
+Classes in com.threerings.whirled.zone.data used by com.threerings.whirled.zone.data
SceneSummary + +
+          The scene summary class is used to provide info about the connected + group of scenes that make up a zone.
ZoneSummary + +
+          The zone summary contains information on a zone, including its name and + summary info on all of the scenes in this zone (which can be used to + generate a map of the zone on the client).
+  +

+ + + + + + + + + + + +
+Classes in com.threerings.whirled.zone.data used by com.threerings.whirled.zone.server
ZonedBodyObject + +
+          A system that uses the zone services must extend BodyObject and implement this + interface.
ZoneSummary + +
+          The zone summary contains information on a zone, including its name and + summary info on all of the scenes in this zone (which can be used to + generate a map of the zone on the client).
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/package-frame.html b/apidocs/com/threerings/whirled/zone/package-frame.html new file mode 100644 index 00000000..7e96c9a6 --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/package-frame.html @@ -0,0 +1,33 @@ + + + + + + + +com.threerings.whirled.zone (vilya 1.3 API) + + + + + + + + + + + +com.threerings.whirled.zone + + + + +
+Classes  + +
+Log
+ + + + diff --git a/apidocs/com/threerings/whirled/zone/package-summary.html b/apidocs/com/threerings/whirled/zone/package-summary.html new file mode 100644 index 00000000..ac9fb69a --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/package-summary.html @@ -0,0 +1,158 @@ + + + + + + + +com.threerings.whirled.zone (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.whirled.zone +

+ + + + + + + + + +
+Class Summary
LogContains a reference to the log object used by the Whirled Zone services.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/package-tree.html b/apidocs/com/threerings/whirled/zone/package-tree.html new file mode 100644 index 00000000..888acd28 --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/package-tree.html @@ -0,0 +1,154 @@ + + + + + + + +com.threerings.whirled.zone Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.whirled.zone +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/package-use.html b/apidocs/com/threerings/whirled/zone/package-use.html new file mode 100644 index 00000000..f99a3e9a --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/package-use.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Package com.threerings.whirled.zone (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.whirled.zone

+
+No usage of com.threerings.whirled.zone +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/peer/data/HostedZone.html b/apidocs/com/threerings/whirled/zone/peer/data/HostedZone.html new file mode 100644 index 00000000..f61e7245 --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/peer/data/HostedZone.html @@ -0,0 +1,366 @@ + + + + + + + +HostedZone (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.zone.peer.data +
+Class HostedZone

+
+java.lang.Object
+  extended by com.threerings.io.SimpleStreamableObject
+      extended by com.threerings.whirled.zone.peer.data.HostedZone
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable, com.threerings.presents.dobj.DSet.Entry
+
+
+
+
public class HostedZone
extends com.threerings.io.SimpleStreamableObject
implements com.threerings.presents.dobj.DSet.Entry
+ + +

+Represents a zone hosted on some node. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + + + + + +
+Field Summary
+ com.threerings.util.Namename + +
+          The name of the zone being hosted.
+ intzoneId + +
+          The unique ID for the zone in question.
+  + + + + + + + + + + + + + +
+Constructor Summary
HostedZone() + +
+           
HostedZone(int zoneId, + com.threerings.util.Name name) + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ Comparable<?>getKey() + +
+           
+  + + + + + + + +
Methods inherited from class com.threerings.io.SimpleStreamableObject
toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+zoneId

+
+public int zoneId
+
+
The unique ID for the zone in question. +

+

+
+
+
+ +

+name

+
+public com.threerings.util.Name name
+
+
The name of the zone being hosted. +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+HostedZone

+
+public HostedZone()
+
+
+
+ +

+HostedZone

+
+public HostedZone(int zoneId,
+                  com.threerings.util.Name name)
+
+
+ + + + + + + + +
+Method Detail
+ +

+getKey

+
+public Comparable<?> getKey()
+
+
+
Specified by:
getKey in interface com.threerings.presents.dobj.DSet.Entry
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/peer/data/class-use/HostedZone.html b/apidocs/com/threerings/whirled/zone/peer/data/class-use/HostedZone.html new file mode 100644 index 00000000..313ddb3c --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/peer/data/class-use/HostedZone.html @@ -0,0 +1,249 @@ + + + + + + + +Uses of Class com.threerings.whirled.zone.peer.data.HostedZone (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.zone.peer.data.HostedZone

+
+ + + + + + + + + +
+Packages that use HostedZone
com.threerings.whirled.zone.peer.server  
+  +

+ + + + + +
+Uses of HostedZone in com.threerings.whirled.zone.peer.server
+  +

+ + + + + + + + + +
Fields in com.threerings.whirled.zone.peer.server with type parameters of type HostedZone
+ com.threerings.presents.dobj.DSet<HostedZone>ZoneNodeObject.hostedZones + +
+          Contains info on all zones hosted by this server.
+  +

+ + + + + + + + + +
Methods in com.threerings.whirled.zone.peer.server that return types with arguments of type HostedZone
+ Tuple<String,HostedZone>ZonePeerManager.getZoneHost(int zoneId) + +
+          Returns the node name of the peer that is hosting the specified scene, or null if no peer + has published that they are hosting the scene.
+  +

+ + + + + + + + + + + + + +
Methods in com.threerings.whirled.zone.peer.server with parameters of type HostedZone
+ voidZoneNodeObject.addToHostedZones(HostedZone elem) + +
+          Requests that the specified entry be added to the + hostedZones set.
+ voidZoneNodeObject.updateHostedZones(HostedZone elem) + +
+          Requests that the specified entry be updated in the + hostedZones set.
+  +

+ + + + + + + + + + + + + +
Method parameters in com.threerings.whirled.zone.peer.server with type arguments of type HostedZone
+ voidZoneNodeObject.setHostedZones(com.threerings.presents.dobj.DSet<HostedZone> value) + +
+          Requests that the hostedZones field be set to the + specified value.
+ voidPeeredZoneRegistry.PeerZoneResolutionListener.zoneOnNode(Tuple<String,HostedZone> nodeInfo) + +
+          Called when the zone is already hosted on another node.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/peer/data/package-frame.html b/apidocs/com/threerings/whirled/zone/peer/data/package-frame.html new file mode 100644 index 00000000..87b4bd34 --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/peer/data/package-frame.html @@ -0,0 +1,33 @@ + + + + + + + +com.threerings.whirled.zone.peer.data (vilya 1.3 API) + + + + + + + + + + + +com.threerings.whirled.zone.peer.data + + + + +
+Classes  + +
+HostedZone
+ + + + diff --git a/apidocs/com/threerings/whirled/zone/peer/data/package-summary.html b/apidocs/com/threerings/whirled/zone/peer/data/package-summary.html new file mode 100644 index 00000000..06aa581f --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/peer/data/package-summary.html @@ -0,0 +1,158 @@ + + + + + + + +com.threerings.whirled.zone.peer.data (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.whirled.zone.peer.data +

+ + + + + + + + + +
+Class Summary
HostedZoneRepresents a zone hosted on some node.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/peer/data/package-tree.html b/apidocs/com/threerings/whirled/zone/peer/data/package-tree.html new file mode 100644 index 00000000..d33ed20a --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/peer/data/package-tree.html @@ -0,0 +1,158 @@ + + + + + + + +com.threerings.whirled.zone.peer.data Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.whirled.zone.peer.data +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/peer/data/package-use.html b/apidocs/com/threerings/whirled/zone/peer/data/package-use.html new file mode 100644 index 00000000..73af7216 --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/peer/data/package-use.html @@ -0,0 +1,171 @@ + + + + + + + +Uses of Package com.threerings.whirled.zone.peer.data (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.whirled.zone.peer.data

+
+ + + + + + + + + +
+Packages that use com.threerings.whirled.zone.peer.data
com.threerings.whirled.zone.peer.server  
+  +

+ + + + + + + + +
+Classes in com.threerings.whirled.zone.peer.data used by com.threerings.whirled.zone.peer.server
HostedZone + +
+          Represents a zone hosted on some node.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/peer/server/PeeredZoneManager.html b/apidocs/com/threerings/whirled/zone/peer/server/PeeredZoneManager.html new file mode 100644 index 00000000..c132af4f --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/peer/server/PeeredZoneManager.html @@ -0,0 +1,245 @@ + + + + + + + +PeeredZoneManager (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.zone.peer.server +
+Interface PeeredZoneManager

+
+
All Superinterfaces:
ZoneManager
+
+
+
+
public interface PeeredZoneManager
extends ZoneManager
+ + +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.whirled.zone.server.ZoneManager
ZoneManager.ResolutionListener
+  + + + + + + + + + + + + +
+Method Summary
+ voidsetShutdownListener(int zoneId, + PeeredZoneRegistry.PeerZoneShutdownListener shutdowner) + +
+          Registers a shutdown listener with the zone.
+  + + + + + + + +
Methods inherited from interface com.threerings.whirled.zone.server.ZoneManager
bodyDidEnterZone, ratifyBodyEntry, ratifyBodyExit, resolveZone
+  +

+ + + + + + + + +
+Method Detail
+ +

+setShutdownListener

+
+void setShutdownListener(int zoneId,
+                         PeeredZoneRegistry.PeerZoneShutdownListener shutdowner)
+
+
Registers a shutdown listener with the zone. +

+

+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/peer/server/PeeredZoneRegistry.PeerZoneMoveHandler.html b/apidocs/com/threerings/whirled/zone/peer/server/PeeredZoneRegistry.PeerZoneMoveHandler.html new file mode 100644 index 00000000..16f79766 --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/peer/server/PeeredZoneRegistry.PeerZoneMoveHandler.html @@ -0,0 +1,285 @@ + + + + + + + +PeeredZoneRegistry.PeerZoneMoveHandler (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.zone.peer.server +
+Class PeeredZoneRegistry.PeerZoneMoveHandler

+
+java.lang.Object
+  extended by com.threerings.whirled.server.AbstractSceneMoveHandler
+      extended by com.threerings.whirled.zone.server.ZoneMoveHandler
+          extended by com.threerings.whirled.zone.peer.server.PeeredZoneRegistry.PeerZoneMoveHandler
+
+
+
All Implemented Interfaces:
SceneRegistry.ResolutionListener, PeeredZoneRegistry.PeerZoneResolutionListener, ZoneManager.ResolutionListener
+
+
+
Enclosing class:
PeeredZoneRegistry
+
+
+
+
public abstract static class PeeredZoneRegistry.PeerZoneMoveHandler
extends ZoneMoveHandler
implements PeeredZoneRegistry.PeerZoneResolutionListener
+ + +

+A ZoneMoveHandler that can receive the sceneOnNode() callback. +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
PeeredZoneRegistry.PeerZoneMoveHandler(com.threerings.crowd.server.LocationManager locman, + ZoneManager zmgr, + SceneRegistry scReg, + com.threerings.crowd.data.BodyObject body, + int sceneId, + int sceneVer, + ZoneService.ZoneMoveListener listener) + +
+           
+  + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from class com.threerings.whirled.zone.server.ZoneMoveHandler
zoneFailedToResolve, zoneWasResolved
+  + + + + + + + +
Methods inherited from class com.threerings.whirled.server.AbstractSceneMoveHandler
sceneFailedToResolve, sceneWasResolved
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  + + + + + + + +
Methods inherited from interface com.threerings.whirled.zone.peer.server.PeeredZoneRegistry.PeerZoneResolutionListener
zoneOnNode
+  + + + + + + + +
Methods inherited from interface com.threerings.whirled.zone.server.ZoneManager.ResolutionListener
zoneFailedToResolve, zoneWasResolved
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+PeeredZoneRegistry.PeerZoneMoveHandler

+
+public PeeredZoneRegistry.PeerZoneMoveHandler(com.threerings.crowd.server.LocationManager locman,
+                                              ZoneManager zmgr,
+                                              SceneRegistry scReg,
+                                              com.threerings.crowd.data.BodyObject body,
+                                              int sceneId,
+                                              int sceneVer,
+                                              ZoneService.ZoneMoveListener listener)
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/peer/server/PeeredZoneRegistry.PeerZoneResolutionListener.html b/apidocs/com/threerings/whirled/zone/peer/server/PeeredZoneRegistry.PeerZoneResolutionListener.html new file mode 100644 index 00000000..16bf8dac --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/peer/server/PeeredZoneRegistry.PeerZoneResolutionListener.html @@ -0,0 +1,234 @@ + + + + + + + +PeeredZoneRegistry.PeerZoneResolutionListener (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.zone.peer.server +
+Interface PeeredZoneRegistry.PeerZoneResolutionListener

+
+
All Superinterfaces:
ZoneManager.ResolutionListener
+
+
+
All Known Implementing Classes:
PeeredZoneRegistry.PeerZoneMoveHandler
+
+
+
Enclosing class:
PeeredZoneRegistry
+
+
+
+
public static interface PeeredZoneRegistry.PeerZoneResolutionListener
extends ZoneManager.ResolutionListener
+ + +

+Peer-awareness for finding out about zones. +

+ +

+

+ +

+ + + + + + + + + + + + +
+Method Summary
+ voidzoneOnNode(Tuple<String,HostedZone> nodeInfo) + +
+          Called when the zone is already hosted on another node.
+  + + + + + + + +
Methods inherited from interface com.threerings.whirled.zone.server.ZoneManager.ResolutionListener
zoneFailedToResolve, zoneWasResolved
+  +

+ + + + + + + + +
+Method Detail
+ +

+zoneOnNode

+
+void zoneOnNode(Tuple<String,HostedZone> nodeInfo)
+
+
Called when the zone is already hosted on another node. +

+

+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/peer/server/PeeredZoneRegistry.PeerZoneShutdownListener.html b/apidocs/com/threerings/whirled/zone/peer/server/PeeredZoneRegistry.PeerZoneShutdownListener.html new file mode 100644 index 00000000..4b3159da --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/peer/server/PeeredZoneRegistry.PeerZoneShutdownListener.html @@ -0,0 +1,214 @@ + + + + + + + +PeeredZoneRegistry.PeerZoneShutdownListener (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.zone.peer.server +
+Interface PeeredZoneRegistry.PeerZoneShutdownListener

+
+
Enclosing class:
PeeredZoneRegistry
+
+
+
+
public static interface PeeredZoneRegistry.PeerZoneShutdownListener
+ + +

+Peered zones should be sure to call back to one of these when they're going away. +

+ +

+

+ +

+ + + + + + + + + + + + +
+Method Summary
+ voidzoneDidShutdown(int zoneId) + +
+           
+  +

+ + + + + + + + +
+Method Detail
+ +

+zoneDidShutdown

+
+void zoneDidShutdown(int zoneId)
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/peer/server/PeeredZoneRegistry.html b/apidocs/com/threerings/whirled/zone/peer/server/PeeredZoneRegistry.html new file mode 100644 index 00000000..a172636b --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/peer/server/PeeredZoneRegistry.html @@ -0,0 +1,439 @@ + + + + + + + +PeeredZoneRegistry (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.zone.peer.server +
+Class PeeredZoneRegistry

+
+java.lang.Object
+  extended by com.threerings.whirled.zone.server.ZoneRegistry
+      extended by com.threerings.whirled.zone.peer.server.PeeredZoneRegistry
+
+
+
All Implemented Interfaces:
com.threerings.presents.server.InvocationProvider, ZoneProvider
+
+
+
+
public abstract class PeeredZoneRegistry
extends ZoneRegistry
+ + +

+

+ +

+ + + + + + + + + + + + + + + + + + + +
+Nested Class Summary
+static classPeeredZoneRegistry.PeerZoneMoveHandler + +
+          A ZoneMoveHandler that can receive the sceneOnNode() callback.
+static interfacePeeredZoneRegistry.PeerZoneResolutionListener + +
+          Peer-awareness for finding out about zones.
+static interfacePeeredZoneRegistry.PeerZoneShutdownListener + +
+          Peered zones should be sure to call back to one of these when they're going away.
+  + + + + + + + + + + +
+Constructor Summary
PeeredZoneRegistry(com.threerings.presents.server.InvocationManager invmgr, + ZonePeerManager peerMgr) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ PeeredZoneManagergetZoneManager(int qualifiedZoneId) + +
+          Returns the zone manager that handles the specified zone id.
+ voidmoveTo(com.threerings.presents.data.ClientObject caller, + int zoneId, + int sceneId, + int sceneVer, + ZoneService.ZoneMoveListener listener) + +
+          Handles a ZoneService.moveTo(int, int, int, com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener) request.
+ voidregisterZoneManager(byte zoneType, + ZoneManager manager) + +
+          Registers the supplied zone manager as the manager for the specified zone type.
+ voidresolvePeerZone(int zoneId, + PeeredZoneRegistry.PeerZoneResolutionListener listener) + +
+          Resolve a zone, or return the information on the peer on which it's hosted.
+ voidresolveZone(int zoneId, + ZoneManager.ResolutionListener listener) + +
+           
+ voidzoneDidShutdown(int zoneId) + +
+          Pass on that the zone has shutdown.
+  + + + + + + + +
Methods inherited from class com.threerings.whirled.zone.server.ZoneRegistry
leaveOccupiedZone, moveBody
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+PeeredZoneRegistry

+
+@Inject
+public PeeredZoneRegistry(com.threerings.presents.server.InvocationManager invmgr,
+                                 ZonePeerManager peerMgr)
+
+
+ + + + + + + + +
+Method Detail
+ +

+registerZoneManager

+
+public void registerZoneManager(byte zoneType,
+                                ZoneManager manager)
+
+
Description copied from class: ZoneRegistry
+
Registers the supplied zone manager as the manager for the specified zone type. Zone types + are 7 bits and managers are responsible for making sure they don't use a zone type that + collides with another manager (given that we have only three zone types at present, this + doesn't seem unreasonable). +

+

+
Overrides:
registerZoneManager in class ZoneRegistry
+
+
+
+
+
+
+ +

+getZoneManager

+
+public PeeredZoneManager getZoneManager(int qualifiedZoneId)
+
+
Description copied from class: ZoneRegistry
+
Returns the zone manager that handles the specified zone id. +

+

+
Overrides:
getZoneManager in class ZoneRegistry
+
+
+
Parameters:
qualifiedZoneId - the qualified zone id for which the manager should be looked up.
+
+
+
+ +

+moveTo

+
+public void moveTo(com.threerings.presents.data.ClientObject caller,
+                   int zoneId,
+                   int sceneId,
+                   int sceneVer,
+                   ZoneService.ZoneMoveListener listener)
+            throws com.threerings.presents.server.InvocationException
+
+
Description copied from interface: ZoneProvider
+
Handles a ZoneService.moveTo(int, int, int, com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener) request. +

+

+
Specified by:
moveTo in interface ZoneProvider
Overrides:
moveTo in class ZoneRegistry
+
+
+ +
Throws: +
com.threerings.presents.server.InvocationException
+
+
+
+ +

+resolveZone

+
+public void resolveZone(int zoneId,
+                        ZoneManager.ResolutionListener listener)
+
+
+
+
+
+
+ +

+resolvePeerZone

+
+public void resolvePeerZone(int zoneId,
+                            PeeredZoneRegistry.PeerZoneResolutionListener listener)
+
+
Resolve a zone, or return the information on the peer on which it's hosted. +

+

+
+
+
+
+ +

+zoneDidShutdown

+
+public void zoneDidShutdown(int zoneId)
+
+
Pass on that the zone has shutdown. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/peer/server/ZoneNodeObject.html b/apidocs/com/threerings/whirled/zone/peer/server/ZoneNodeObject.html new file mode 100644 index 00000000..e74bd9b8 --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/peer/server/ZoneNodeObject.html @@ -0,0 +1,478 @@ + + + + + + + +ZoneNodeObject (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.zone.peer.server +
+Class ZoneNodeObject

+
+java.lang.Object
+  extended by com.threerings.presents.dobj.DObject
+      extended by com.threerings.presents.peer.data.NodeObject
+          extended by com.threerings.crowd.peer.data.CrowdNodeObject
+              extended by com.threerings.whirled.zone.peer.server.ZoneNodeObject
+
+
+
All Implemented Interfaces:
com.threerings.io.Streamable
+
+
+
+
public class ZoneNodeObject
extends com.threerings.crowd.peer.data.CrowdNodeObject
+ + +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.presents.peer.data.NodeObject
com.threerings.presents.peer.data.NodeObject.CacheData, com.threerings.presents.peer.data.NodeObject.Lock
+  + + + + + + + + +
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
+  + + + + + + + + + + + + + + + +
+Field Summary
+static StringHOSTED_ZONES + +
+          The field name of the hostedZones field.
+ com.threerings.presents.dobj.DSet<HostedZone>hostedZones + +
+          Contains info on all zones hosted by this server.
+  + + + + + + + +
Fields inherited from class com.threerings.crowd.peer.data.CrowdNodeObject
CROWD_PEER_SERVICE, crowdPeerService, HOSTED_CHANNELS, hostedChannels
+  + + + + + + + +
Fields inherited from class com.threerings.presents.peer.data.NodeObject
ACQUIRING_LOCK, acquiringLock, BOOT_STAMP, bootStamp, CACHE_DATA, cacheData, clients, CLIENTS, locks, LOCKS, NODE_NAME, nodeName, PEER_SERVICE, peerService, RELEASING_LOCK, releasingLock
+  + + + + + + + + + + +
+Constructor Summary
ZoneNodeObject() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidaddToHostedZones(HostedZone elem) + +
+          Requests that the specified entry be added to the + hostedZones set.
+ voidremoveFromHostedZones(Comparable<?> key) + +
+          Requests that the entry matching the supplied key be removed from + the hostedZones set.
+ voidsetHostedZones(com.threerings.presents.dobj.DSet<HostedZone> value) + +
+          Requests that the hostedZones field be set to the + specified value.
+ voidupdateHostedZones(HostedZone elem) + +
+          Requests that the specified entry be updated in the + hostedZones set.
+  + + + + + + + +
Methods inherited from class com.threerings.crowd.peer.data.CrowdNodeObject
addToHostedChannels, removeFromHostedChannels, setCrowdPeerService, setHostedChannels, updateHostedChannels
+  + + + + + + + +
Methods inherited from class com.threerings.presents.peer.data.NodeObject
addToClients, addToLocks, removeFromClients, removeFromLocks, setAcquiringLock, setBootStamp, setCacheData, setClients, setLocks, setNodeName, setPeerService, setReleasingLock, updateClients, updateLocks
+  + + + + + + + +
Methods inherited from class com.threerings.presents.dobj.DObject
acquireLock, addListener, addListener, addSubscriber, addToSet, cancelTransaction, changeAttribute, checkPermissions, checkPermissions, commitTransaction, destroy, getAccessController, getAttribute, getLocal, getLocals, getManager, getOid, getSet, inTransaction, isActive, notifyListeners, notifyProxies, postEvent, postMessage, postMessage, readField__oid, releaseLock, removeFromSet, removeListener, removeSubscriber, setAccessController, setAttribute, setDestroyOnLastSubscriberRemoved, setLocal, setManager, setOid, startTransaction, toString, updateSet, which, writeField__oid
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+HOSTED_ZONES

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public static final String HOSTED_ZONES
+
+
The field name of the hostedZones field. +

+

+
See Also:
Constant Field Values
+
+
+ +

+hostedZones

+
+public com.threerings.presents.dobj.DSet<HostedZone> hostedZones
+
+
Contains info on all zones hosted by this server. +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+ZoneNodeObject

+
+public ZoneNodeObject()
+
+
+ + + + + + + + +
+Method Detail
+ +

+addToHostedZones

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public void addToHostedZones(HostedZone elem)
+
+
Requests that the specified entry be added to the + hostedZones set. The set will not change until the event is + actually propagated through the system. +

+

+
+
+
+
+ +

+removeFromHostedZones

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public void removeFromHostedZones(Comparable<?> key)
+
+
Requests that the entry matching the supplied key be removed from + the hostedZones set. The set will not change until the + event is actually propagated through the system. +

+

+
+
+
+
+ +

+updateHostedZones

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public void updateHostedZones(HostedZone elem)
+
+
Requests that the specified entry be updated in the + hostedZones set. The set will not change until the event is + actually propagated through the system. +

+

+
+
+
+
+ +

+setHostedZones

+
+@Generated(value="com.threerings.presents.tools.GenDObjectTask")
+public void setHostedZones(com.threerings.presents.dobj.DSet<HostedZone> value)
+
+
Requests that the hostedZones field be set to the + specified value. Generally one only adds, updates and removes + entries of a distributed set, but certain situations call for a + complete replacement of the set value. The local value will be + updated immediately and an event will be propagated through the + system to notify all listeners that the attribute did + change. Proxied copies of this object (on clients) will apply the + value change when they received the attribute changed notification. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/peer/server/ZonePeerManager.NodeFunc.html b/apidocs/com/threerings/whirled/zone/peer/server/ZonePeerManager.NodeFunc.html new file mode 100644 index 00000000..a613fc2d --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/peer/server/ZonePeerManager.NodeFunc.html @@ -0,0 +1,297 @@ + + + + + + + +ZonePeerManager.NodeFunc (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.zone.peer.server +
+Class ZonePeerManager.NodeFunc<T>

+
+java.lang.Object
+  extended by com.threerings.whirled.zone.peer.server.ZonePeerManager.NodeFunc<T>
+
+
+
All Implemented Interfaces:
Function<com.threerings.presents.peer.data.NodeObject,T>
+
+
+
Enclosing class:
ZonePeerManager
+
+
+
+
public abstract static class ZonePeerManager.NodeFunc<T>
extends Object
implements Function<com.threerings.presents.peer.data.NodeObject,T>
+ + +

+Useful with PeerManager.lookupNodeDatum(com.google.common.base.Function). +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
ZonePeerManager.NodeFunc() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ Tapply(com.threerings.presents.peer.data.NodeObject nodeobj) + +
+           
+abstract  Tapply(ZoneNodeObject mnobj) + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  + + + + + + + +
Methods inherited from interface com.google.common.base.Function
equals
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+ZonePeerManager.NodeFunc

+
+public ZonePeerManager.NodeFunc()
+
+
+ + + + + + + + +
+Method Detail
+ +

+apply

+
+public abstract T apply(ZoneNodeObject mnobj)
+
+
+
+
+
+
+
+
+
+ +

+apply

+
+public T apply(com.threerings.presents.peer.data.NodeObject nodeobj)
+
+
+
Specified by:
apply in interface Function<com.threerings.presents.peer.data.NodeObject,T>
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/peer/server/ZonePeerManager.html b/apidocs/com/threerings/whirled/zone/peer/server/ZonePeerManager.html new file mode 100644 index 00000000..f8dc2e93 --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/peer/server/ZonePeerManager.html @@ -0,0 +1,375 @@ + + + + + + + +ZonePeerManager (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.zone.peer.server +
+Class ZonePeerManager

+
+java.lang.Object
+  extended by com.threerings.presents.peer.server.PeerManager
+      extended by com.threerings.crowd.peer.server.CrowdPeerManager
+          extended by com.threerings.whirled.zone.peer.server.ZonePeerManager
+
+
+
All Implemented Interfaces:
Lifecycle.BaseComponent, Lifecycle.ShutdownComponent, com.threerings.crowd.chat.server.ChatProvider.ChatForwarder, com.threerings.crowd.peer.server.CrowdPeerProvider, com.threerings.presents.peer.server.PeerProvider, com.threerings.presents.server.ClientManager.ClientObserver, com.threerings.presents.server.InvocationProvider
+
+
+
+
public abstract class ZonePeerManager
extends com.threerings.crowd.peer.server.CrowdPeerManager
+ + +

+

+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static classZonePeerManager.NodeFunc<T> + +
+          Useful with PeerManager.lookupNodeDatum(com.google.common.base.Function).
+  + + + + + + + +
Nested classes/interfaces inherited from class com.threerings.presents.peer.server.PeerManager
com.threerings.presents.peer.server.PeerManager.DroppedLockObserver, com.threerings.presents.peer.server.PeerManager.LockedOperation, com.threerings.presents.peer.server.PeerManager.NodeAction, com.threerings.presents.peer.server.PeerManager.NodeRequest, com.threerings.presents.peer.server.PeerManager.StaleCacheObserver, com.threerings.presents.peer.server.PeerManager.Stats
+  + + + + + + + + + + + +
+Constructor Summary
ZonePeerManager(Lifecycle cycle) + +
+          Creates an uninitialized peer manager.
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ Tuple<String,HostedZone>getZoneHost(int zoneId) + +
+          Returns the node name of the peer that is hosting the specified scene, or null if no peer + has published that they are hosting the scene.
+static com.threerings.presents.peer.data.NodeObject.LockgetZoneLock(int sceneId) + +
+          Returns a lock used to claim resolution of the specified scene.
+ voidzoneDidShutdown(int zoneId) + +
+          Called by the ZoneManager when it is no longer hosting a scene.
+ voidzoneDidStartup(int zoneId, + com.threerings.util.Name name) + +
+          Called by the ZoneManager when it is hosting a zone.
+  + + + + + + + +
Methods inherited from class com.threerings.crowd.peer.server.CrowdPeerManager
deliverBroadcast, deliverTell, forwardBroadcast, forwardTell, shutdown
+  + + + + + + + +
Methods inherited from class com.threerings.presents.peer.server.PeerManager
acquireLock, addDroppedLockObserver, addStaleCacheObserver, broadcastStaleCacheData, clientSessionDidEnd, clientSessionDidStart, clientSubscribedToNode, clientUnsubscribedFromNode, findApplicableNodes, generateReport, getNodeObject, getNodeObjects, getPeerClient, getPeerInternalHostName, getPeerPort, getPeerPublicHostName, getStats, init, init, invokeAction, invokeNodeAction, invokeNodeAction, invokeNodeAction, invokeNodeRequest, invokeNodeRequest, invokeOnNodes, invokeRequest, isAuthenticPeer, locateClient, lookupNodeDatum, performWithLock, proxyRemoteObject, proxyRemoteObject, queryLock, queryLock, ratifyLockAction, reacquireLock, releaseLock, removeDroppedLockObserver, removeStaleCacheObserver, unproxyRemoteObject
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+ZonePeerManager

+
+@Inject
+public ZonePeerManager(Lifecycle cycle)
+
+
Creates an uninitialized peer manager. +

+

+ + + + + + + + +
+Method Detail
+ +

+getZoneLock

+
+public static com.threerings.presents.peer.data.NodeObject.Lock getZoneLock(int sceneId)
+
+
Returns a lock used to claim resolution of the specified scene. +

+

+
+
+
+
+ +

+getZoneHost

+
+public Tuple<String,HostedZone> getZoneHost(int zoneId)
+
+
Returns the node name of the peer that is hosting the specified scene, or null if no peer + has published that they are hosting the scene. +

+

+
+
+
+
+ +

+zoneDidStartup

+
+public void zoneDidStartup(int zoneId,
+                           com.threerings.util.Name name)
+
+
Called by the ZoneManager when it is hosting a zone. +

+

+
+
+
+
+ +

+zoneDidShutdown

+
+public void zoneDidShutdown(int zoneId)
+
+
Called by the ZoneManager when it is no longer hosting a scene. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/peer/server/class-use/PeeredZoneManager.html b/apidocs/com/threerings/whirled/zone/peer/server/class-use/PeeredZoneManager.html new file mode 100644 index 00000000..d394f24d --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/peer/server/class-use/PeeredZoneManager.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Interface com.threerings.whirled.zone.peer.server.PeeredZoneManager (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.whirled.zone.peer.server.PeeredZoneManager

+
+ + + + + + + + + +
+Packages that use PeeredZoneManager
com.threerings.whirled.zone.peer.server  
+  +

+ + + + + +
+Uses of PeeredZoneManager in com.threerings.whirled.zone.peer.server
+  +

+ + + + + + + + + +
Methods in com.threerings.whirled.zone.peer.server that return PeeredZoneManager
+ PeeredZoneManagerPeeredZoneRegistry.getZoneManager(int qualifiedZoneId) + +
+           
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/peer/server/class-use/PeeredZoneRegistry.PeerZoneMoveHandler.html b/apidocs/com/threerings/whirled/zone/peer/server/class-use/PeeredZoneRegistry.PeerZoneMoveHandler.html new file mode 100644 index 00000000..e11c22a2 --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/peer/server/class-use/PeeredZoneRegistry.PeerZoneMoveHandler.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.whirled.zone.peer.server.PeeredZoneRegistry.PeerZoneMoveHandler (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.zone.peer.server.PeeredZoneRegistry.PeerZoneMoveHandler

+
+No usage of com.threerings.whirled.zone.peer.server.PeeredZoneRegistry.PeerZoneMoveHandler +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/peer/server/class-use/PeeredZoneRegistry.PeerZoneResolutionListener.html b/apidocs/com/threerings/whirled/zone/peer/server/class-use/PeeredZoneRegistry.PeerZoneResolutionListener.html new file mode 100644 index 00000000..567bdaa7 --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/peer/server/class-use/PeeredZoneRegistry.PeerZoneResolutionListener.html @@ -0,0 +1,198 @@ + + + + + + + +Uses of Interface com.threerings.whirled.zone.peer.server.PeeredZoneRegistry.PeerZoneResolutionListener (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.whirled.zone.peer.server.PeeredZoneRegistry.PeerZoneResolutionListener

+
+ + + + + + + + + +
+Packages that use PeeredZoneRegistry.PeerZoneResolutionListener
com.threerings.whirled.zone.peer.server  
+  +

+ + + + + +
+Uses of PeeredZoneRegistry.PeerZoneResolutionListener in com.threerings.whirled.zone.peer.server
+  +

+ + + + + + + + + +
Classes in com.threerings.whirled.zone.peer.server that implement PeeredZoneRegistry.PeerZoneResolutionListener
+static classPeeredZoneRegistry.PeerZoneMoveHandler + +
+          A ZoneMoveHandler that can receive the sceneOnNode() callback.
+  +

+ + + + + + + + + +
Methods in com.threerings.whirled.zone.peer.server with parameters of type PeeredZoneRegistry.PeerZoneResolutionListener
+ voidPeeredZoneRegistry.resolvePeerZone(int zoneId, + PeeredZoneRegistry.PeerZoneResolutionListener listener) + +
+          Resolve a zone, or return the information on the peer on which it's hosted.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/peer/server/class-use/PeeredZoneRegistry.PeerZoneShutdownListener.html b/apidocs/com/threerings/whirled/zone/peer/server/class-use/PeeredZoneRegistry.PeerZoneShutdownListener.html new file mode 100644 index 00000000..50fa71c5 --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/peer/server/class-use/PeeredZoneRegistry.PeerZoneShutdownListener.html @@ -0,0 +1,182 @@ + + + + + + + +Uses of Interface com.threerings.whirled.zone.peer.server.PeeredZoneRegistry.PeerZoneShutdownListener (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.whirled.zone.peer.server.PeeredZoneRegistry.PeerZoneShutdownListener

+
+ + + + + + + + + +
+Packages that use PeeredZoneRegistry.PeerZoneShutdownListener
com.threerings.whirled.zone.peer.server  
+  +

+ + + + + +
+Uses of PeeredZoneRegistry.PeerZoneShutdownListener in com.threerings.whirled.zone.peer.server
+  +

+ + + + + + + + + +
Methods in com.threerings.whirled.zone.peer.server with parameters of type PeeredZoneRegistry.PeerZoneShutdownListener
+ voidPeeredZoneManager.setShutdownListener(int zoneId, + PeeredZoneRegistry.PeerZoneShutdownListener shutdowner) + +
+          Registers a shutdown listener with the zone.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/peer/server/class-use/PeeredZoneRegistry.html b/apidocs/com/threerings/whirled/zone/peer/server/class-use/PeeredZoneRegistry.html new file mode 100644 index 00000000..543f36a2 --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/peer/server/class-use/PeeredZoneRegistry.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.whirled.zone.peer.server.PeeredZoneRegistry (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.zone.peer.server.PeeredZoneRegistry

+
+No usage of com.threerings.whirled.zone.peer.server.PeeredZoneRegistry +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/peer/server/class-use/ZoneNodeObject.html b/apidocs/com/threerings/whirled/zone/peer/server/class-use/ZoneNodeObject.html new file mode 100644 index 00000000..e924bb19 --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/peer/server/class-use/ZoneNodeObject.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class com.threerings.whirled.zone.peer.server.ZoneNodeObject (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.zone.peer.server.ZoneNodeObject

+
+ + + + + + + + + +
+Packages that use ZoneNodeObject
com.threerings.whirled.zone.peer.server  
+  +

+ + + + + +
+Uses of ZoneNodeObject in com.threerings.whirled.zone.peer.server
+  +

+ + + + + + + + + +
Methods in com.threerings.whirled.zone.peer.server with parameters of type ZoneNodeObject
+abstract  TZonePeerManager.NodeFunc.apply(ZoneNodeObject mnobj) + +
+           
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/peer/server/class-use/ZonePeerManager.NodeFunc.html b/apidocs/com/threerings/whirled/zone/peer/server/class-use/ZonePeerManager.NodeFunc.html new file mode 100644 index 00000000..c297ca99 --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/peer/server/class-use/ZonePeerManager.NodeFunc.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.whirled.zone.peer.server.ZonePeerManager.NodeFunc (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.zone.peer.server.ZonePeerManager.NodeFunc

+
+No usage of com.threerings.whirled.zone.peer.server.ZonePeerManager.NodeFunc +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/peer/server/class-use/ZonePeerManager.html b/apidocs/com/threerings/whirled/zone/peer/server/class-use/ZonePeerManager.html new file mode 100644 index 00000000..261d4370 --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/peer/server/class-use/ZonePeerManager.html @@ -0,0 +1,180 @@ + + + + + + + +Uses of Class com.threerings.whirled.zone.peer.server.ZonePeerManager (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.zone.peer.server.ZonePeerManager

+
+ + + + + + + + + +
+Packages that use ZonePeerManager
com.threerings.whirled.zone.peer.server  
+  +

+ + + + + +
+Uses of ZonePeerManager in com.threerings.whirled.zone.peer.server
+  +

+ + + + + + + + +
Constructors in com.threerings.whirled.zone.peer.server with parameters of type ZonePeerManager
PeeredZoneRegistry(com.threerings.presents.server.InvocationManager invmgr, + ZonePeerManager peerMgr) + +
+           
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/peer/server/package-frame.html b/apidocs/com/threerings/whirled/zone/peer/server/package-frame.html new file mode 100644 index 00000000..ea0219f3 --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/peer/server/package-frame.html @@ -0,0 +1,56 @@ + + + + + + + +com.threerings.whirled.zone.peer.server (vilya 1.3 API) + + + + + + + + + + + +com.threerings.whirled.zone.peer.server + + + + +
+Interfaces  + +
+PeeredZoneManager +
+PeeredZoneRegistry.PeerZoneResolutionListener +
+PeeredZoneRegistry.PeerZoneShutdownListener
+ + + + + + +
+Classes  + +
+PeeredZoneRegistry +
+PeeredZoneRegistry.PeerZoneMoveHandler +
+ZoneNodeObject +
+ZonePeerManager +
+ZonePeerManager.NodeFunc
+ + + + diff --git a/apidocs/com/threerings/whirled/zone/peer/server/package-summary.html b/apidocs/com/threerings/whirled/zone/peer/server/package-summary.html new file mode 100644 index 00000000..3c523e58 --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/peer/server/package-summary.html @@ -0,0 +1,196 @@ + + + + + + + +com.threerings.whirled.zone.peer.server (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.whirled.zone.peer.server +

+ + + + + + + + + + + + + + + + + +
+Interface Summary
PeeredZoneManager 
PeeredZoneRegistry.PeerZoneResolutionListenerPeer-awareness for finding out about zones.
PeeredZoneRegistry.PeerZoneShutdownListenerPeered zones should be sure to call back to one of these when they're going away.
+  + +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
+Class Summary
PeeredZoneRegistry 
PeeredZoneRegistry.PeerZoneMoveHandlerA ZoneMoveHandler that can receive the sceneOnNode() callback.
ZoneNodeObject 
ZonePeerManager 
ZonePeerManager.NodeFunc<T>Useful with PeerManager.lookupNodeDatum(com.google.common.base.Function).
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/peer/server/package-tree.html b/apidocs/com/threerings/whirled/zone/peer/server/package-tree.html new file mode 100644 index 00000000..78c0e569 --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/peer/server/package-tree.html @@ -0,0 +1,187 @@ + + + + + + + +com.threerings.whirled.zone.peer.server Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.whirled.zone.peer.server +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/peer/server/package-use.html b/apidocs/com/threerings/whirled/zone/peer/server/package-use.html new file mode 100644 index 00000000..27a4f66d --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/peer/server/package-use.html @@ -0,0 +1,195 @@ + + + + + + + +Uses of Package com.threerings.whirled.zone.peer.server (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.whirled.zone.peer.server

+
+ + + + + + + + + +
+Packages that use com.threerings.whirled.zone.peer.server
com.threerings.whirled.zone.peer.server  
+  +

+ + + + + + + + + + + + + + + + + + + + +
+Classes in com.threerings.whirled.zone.peer.server used by com.threerings.whirled.zone.peer.server
PeeredZoneManager + +
+           
PeeredZoneRegistry.PeerZoneResolutionListener + +
+          Peer-awareness for finding out about zones.
PeeredZoneRegistry.PeerZoneShutdownListener + +
+          Peered zones should be sure to call back to one of these when they're going away.
ZoneNodeObject + +
+           
ZonePeerManager + +
+           
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/server/ZoneManager.ResolutionListener.html b/apidocs/com/threerings/whirled/zone/server/ZoneManager.ResolutionListener.html new file mode 100644 index 00000000..293bab9a --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/server/ZoneManager.ResolutionListener.html @@ -0,0 +1,246 @@ + + + + + + + +ZoneManager.ResolutionListener (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.zone.server +
+Interface ZoneManager.ResolutionListener

+
+
All Known Subinterfaces:
PeeredZoneRegistry.PeerZoneResolutionListener
+
+
+
All Known Implementing Classes:
PeeredZoneRegistry.PeerZoneMoveHandler, ZoneMoveHandler
+
+
+
Enclosing interface:
ZoneManager
+
+
+
+
public static interface ZoneManager.ResolutionListener
+ + +

+Used to notify requesters when an asynchronous zone load has + completed (successfully or not). +

+ +

+

+ +

+ + + + + + + + + + + + + + + + +
+Method Summary
+ voidzoneFailedToResolve(int zoneId, + Exception reason) + +
+          Called when a zone failed to resolve.
+ voidzoneWasResolved(ZoneSummary summary) + +
+          Called when a zone was successfully resolved.
+  +

+ + + + + + + + +
+Method Detail
+ +

+zoneWasResolved

+
+void zoneWasResolved(ZoneSummary summary)
+
+
Called when a zone was successfully resolved. +

+

+
+
+
+
+ +

+zoneFailedToResolve

+
+void zoneFailedToResolve(int zoneId,
+                         Exception reason)
+
+
Called when a zone failed to resolve. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/server/ZoneManager.html b/apidocs/com/threerings/whirled/zone/server/ZoneManager.html new file mode 100644 index 00000000..62ef8030 --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/server/ZoneManager.html @@ -0,0 +1,327 @@ + + + + + + + +ZoneManager (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.zone.server +
+Interface ZoneManager

+
+
All Known Subinterfaces:
PeeredZoneManager
+
+
+
+
public interface ZoneManager
+ + +

+A zone is a collection of scenes organized into a connected group. A + user can wander around within a zone, moving from scene to scene via + the standard mechanisms. To move between zones, they must use a special + mechanism (like at the dock, they can move from an island zone into + their ship zone; or they can move from an island zone into their house + zone). A zone provides scene summary information that can be used to + display a map of the zone to the client. +

+ +

+

+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static interfaceZoneManager.ResolutionListener + +
+          Used to notify requesters when an asynchronous zone load has + completed (successfully or not).
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidbodyDidEnterZone(com.threerings.crowd.data.BodyObject body, + int zoneId) + +
+          Called when a body has been granted access to a zone.
+ StringratifyBodyEntry(com.threerings.crowd.data.BodyObject body, + int zoneId) + +
+          Called when a body has requested to enter a zone.
+ StringratifyBodyExit(com.threerings.crowd.data.BodyObject body) + +
+          Called when a body has requested to leave a zone.
+ voidresolveZone(int zoneId, + ZoneManager.ResolutionListener listener) + +
+          Resolves and delivers the scene summary information for the + requested zone.
+  +

+ + + + + + + + +
+Method Detail
+ +

+resolveZone

+
+void resolveZone(int zoneId,
+                 ZoneManager.ResolutionListener listener)
+
+
Resolves and delivers the scene summary information for the + requested zone. Zone resolution is an asynchronous process, which + necessitates this callback-style interface. +

+

+
Parameters:
zoneId - the qualified zone id of the zone to resolve.
listener - the listener that should be notified when the zone + is successfully resolved or is known to have failed to resolve.
+
+
+
+ +

+ratifyBodyExit

+
+String ratifyBodyExit(com.threerings.crowd.data.BodyObject body)
+
+
Called when a body has requested to leave a zone. The zone manager + may return null to indicate that the body is allowed to leave the + current zone or a string error code indicating the reason for + denial of access (which will be propagated back to the requesting + client). +

+

+
Parameters:
body - the body object of the user that desires to depart + their current zone (which can be obtained by casting the BodyObject to a ZonedBodyObject).
+
+
+
+ +

+ratifyBodyEntry

+
+String ratifyBodyEntry(com.threerings.crowd.data.BodyObject body,
+                       int zoneId)
+
+
Called when a body has requested to enter a zone. The zone manager + may return null to indicate that the body is allowed access to the + zone or a string error code indicating the reason for denial of + access (which will be propagated back to the requesting client). + This method is called after the zone is resolved so that + the zone manager may complete the ratification process without + blocking (which it must do). +

+

+
Parameters:
body - the body object of the user that desires access to the + specified zone.
zoneId - the id of the zone to which the user desires access.
+
+
+
+ +

+bodyDidEnterZone

+
+void bodyDidEnterZone(com.threerings.crowd.data.BodyObject body,
+                      int zoneId)
+
+
Called when a body has been granted access to a zone. This method + must not block. +

+

+
Parameters:
body - the body object of the user that was just granted + access to a zone.
zoneId - the id of the zone to which they were granted access.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/server/ZoneMoveHandler.html b/apidocs/com/threerings/whirled/zone/server/ZoneMoveHandler.html new file mode 100644 index 00000000..7ee261dc --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/server/ZoneMoveHandler.html @@ -0,0 +1,318 @@ + + + + + + + +ZoneMoveHandler (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.zone.server +
+Class ZoneMoveHandler

+
+java.lang.Object
+  extended by com.threerings.whirled.server.AbstractSceneMoveHandler
+      extended by com.threerings.whirled.zone.server.ZoneMoveHandler
+
+
+
All Implemented Interfaces:
SceneRegistry.ResolutionListener, ZoneManager.ResolutionListener
+
+
+
Direct Known Subclasses:
PeeredZoneRegistry.PeerZoneMoveHandler
+
+
+
+
public class ZoneMoveHandler
extends AbstractSceneMoveHandler
implements ZoneManager.ResolutionListener
+ + +

+Handles transitioning between zones. +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
ZoneMoveHandler(com.threerings.crowd.server.LocationManager locmgr, + ZoneManager zmgr, + SceneRegistry screg, + com.threerings.crowd.data.BodyObject body, + int sceneId, + int sceneVer, + ZoneService.ZoneMoveListener listener) + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ voidzoneFailedToResolve(int zoneId, + Exception reason) + +
+          Called when a zone failed to resolve.
+ voidzoneWasResolved(ZoneSummary summary) + +
+          Called when a zone was successfully resolved.
+  + + + + + + + +
Methods inherited from class com.threerings.whirled.server.AbstractSceneMoveHandler
sceneFailedToResolve, sceneWasResolved
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+ZoneMoveHandler

+
+public ZoneMoveHandler(com.threerings.crowd.server.LocationManager locmgr,
+                       ZoneManager zmgr,
+                       SceneRegistry screg,
+                       com.threerings.crowd.data.BodyObject body,
+                       int sceneId,
+                       int sceneVer,
+                       ZoneService.ZoneMoveListener listener)
+
+
+ + + + + + + + +
+Method Detail
+ +

+zoneWasResolved

+
+public void zoneWasResolved(ZoneSummary summary)
+
+
Description copied from interface: ZoneManager.ResolutionListener
+
Called when a zone was successfully resolved. +

+

+
Specified by:
zoneWasResolved in interface ZoneManager.ResolutionListener
+
+
+
+
+
+
+ +

+zoneFailedToResolve

+
+public void zoneFailedToResolve(int zoneId,
+                                Exception reason)
+
+
Description copied from interface: ZoneManager.ResolutionListener
+
Called when a zone failed to resolve. +

+

+
Specified by:
zoneFailedToResolve in interface ZoneManager.ResolutionListener
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/server/ZoneProvider.html b/apidocs/com/threerings/whirled/zone/server/ZoneProvider.html new file mode 100644 index 00000000..25bb7e54 --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/server/ZoneProvider.html @@ -0,0 +1,235 @@ + + + + + + + +ZoneProvider (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.zone.server +
+Interface ZoneProvider

+
+
All Superinterfaces:
com.threerings.presents.server.InvocationProvider
+
+
+
All Known Implementing Classes:
PeeredZoneRegistry, ZoneRegistry
+
+
+
+
@Generated(value="com.threerings.presents.tools.GenServiceTask",
+           comments="Derived from ZoneService.java.")
+public interface ZoneProvider
extends com.threerings.presents.server.InvocationProvider
+ + +

+Defines the server-side of the ZoneService. +

+ +

+

+ +

+ + + + + + + + + + + + +
+Method Summary
+ voidmoveTo(com.threerings.presents.data.ClientObject caller, + int arg1, + int arg2, + int arg3, + ZoneService.ZoneMoveListener arg4) + +
+          Handles a ZoneService.moveTo(int, int, int, com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener) request.
+  +

+ + + + + + + + +
+Method Detail
+ +

+moveTo

+
+void moveTo(com.threerings.presents.data.ClientObject caller,
+            int arg1,
+            int arg2,
+            int arg3,
+            ZoneService.ZoneMoveListener arg4)
+            throws com.threerings.presents.server.InvocationException
+
+
Handles a ZoneService.moveTo(int, int, int, com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener) request. +

+

+
+
+
+ +
Throws: +
com.threerings.presents.server.InvocationException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/server/ZoneRegistry.html b/apidocs/com/threerings/whirled/zone/server/ZoneRegistry.html new file mode 100644 index 00000000..56cfb262 --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/server/ZoneRegistry.html @@ -0,0 +1,396 @@ + + + + + + + +ZoneRegistry (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.zone.server +
+Class ZoneRegistry

+
+java.lang.Object
+  extended by com.threerings.whirled.zone.server.ZoneRegistry
+
+
+
All Implemented Interfaces:
com.threerings.presents.server.InvocationProvider, ZoneProvider
+
+
+
Direct Known Subclasses:
PeeredZoneRegistry
+
+
+
+
public class ZoneRegistry
extends Object
implements ZoneProvider
+ + +

+The zone registry takes care of mapping zone requests to the appropriate registered zone manager. +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
ZoneRegistry(com.threerings.presents.server.InvocationManager invmgr) + +
+          Creates a zone manager with the supplied configuration.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ ZoneManagergetZoneManager(int qualifiedZoneId) + +
+          Returns the zone manager that handles the specified zone id.
+ StringleaveOccupiedZone(ZonedBodyObject source) + +
+          Ejects the specified body from their current scene and zone.
+ StringmoveBody(ZonedBodyObject source, + int zoneId, + int sceneId) + +
+          Ejects the specified body from their current scene and sends them a request to move to the + specified new zone and scene.
+ voidmoveTo(com.threerings.presents.data.ClientObject caller, + int zoneId, + int sceneId, + int sceneVer, + ZoneService.ZoneMoveListener listener) + +
+          Handles a ZoneService.moveTo(int, int, int, com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener) request.
+ voidregisterZoneManager(byte zoneType, + ZoneManager manager) + +
+          Registers the supplied zone manager as the manager for the specified zone type.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+ZoneRegistry

+
+@Inject
+public ZoneRegistry(com.threerings.presents.server.InvocationManager invmgr)
+
+
Creates a zone manager with the supplied configuration. +

+

+ + + + + + + + +
+Method Detail
+ +

+registerZoneManager

+
+public void registerZoneManager(byte zoneType,
+                                ZoneManager manager)
+
+
Registers the supplied zone manager as the manager for the specified zone type. Zone types + are 7 bits and managers are responsible for making sure they don't use a zone type that + collides with another manager (given that we have only three zone types at present, this + doesn't seem unreasonable). +

+

+
+
+
+
+
+
+
+ +

+getZoneManager

+
+public ZoneManager getZoneManager(int qualifiedZoneId)
+
+
Returns the zone manager that handles the specified zone id. +

+

+
+
+
+
Parameters:
qualifiedZoneId - the qualified zone id for which the manager should be looked up.
+
+
+
+ +

+moveBody

+
+public String moveBody(ZonedBodyObject source,
+                       int zoneId,
+                       int sceneId)
+
+
Ejects the specified body from their current scene and sends them a request to move to the + specified new zone and scene. This is the zone-equivalent to + LocationProvider.moveTo(com.threerings.presents.data.ClientObject, int, com.threerings.crowd.client.LocationService.MoveListener). +

+

+
+
+
+ +
Returns:
null if the user was forcibly moved, or a string indicating the reason for denial + of departure of their current zone (from ZoneManager.ratifyBodyExit(com.threerings.crowd.data.BodyObject)).
+
+
+
+ +

+leaveOccupiedZone

+
+public String leaveOccupiedZone(ZonedBodyObject source)
+
+
Ejects the specified body from their current scene and zone. This is the zone equivalent to + LocationProvider.leavePlace(com.threerings.presents.data.ClientObject). +

+

+
+
+
+ +
Returns:
null if the user was forcibly moved, or a string indicating the reason for denial of + departure of their current zone (from ZoneManager.ratifyBodyExit(com.threerings.crowd.data.BodyObject)).
+
+
+
+ +

+moveTo

+
+public void moveTo(com.threerings.presents.data.ClientObject caller,
+                   int zoneId,
+                   int sceneId,
+                   int sceneVer,
+                   ZoneService.ZoneMoveListener listener)
+            throws com.threerings.presents.server.InvocationException
+
+
Description copied from interface: ZoneProvider
+
Handles a ZoneService.moveTo(int, int, int, com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener) request. +

+

+
Specified by:
moveTo in interface ZoneProvider
+
+
+ +
Throws: +
com.threerings.presents.server.InvocationException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/server/ZoneSender.html b/apidocs/com/threerings/whirled/zone/server/ZoneSender.html new file mode 100644 index 00000000..7dc52e56 --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/server/ZoneSender.html @@ -0,0 +1,274 @@ + + + + + + + +ZoneSender (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.zone.server +
+Class ZoneSender

+
+java.lang.Object
+  extended by com.threerings.presents.server.InvocationSender
+      extended by com.threerings.whirled.zone.server.ZoneSender
+
+
+
+
public class ZoneSender
extends com.threerings.presents.server.InvocationSender
+ + +

+Used to issue notifications to a ZoneReceiver instance on a + client. +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
ZoneSender() + +
+           
+  + + + + + + + + + + + +
+Method Summary
+static voidforcedMove(com.threerings.presents.data.ClientObject target, + int arg1, + int arg2) + +
+          Issues a notification that will result in a call to ZoneReceiver.forcedMove(int, int) on a client.
+  + + + + + + + +
Methods inherited from class com.threerings.presents.server.InvocationSender
sendNotification, sendNotification
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+ZoneSender

+
+public ZoneSender()
+
+
+ + + + + + + + +
+Method Detail
+ +

+forcedMove

+
+public static void forcedMove(com.threerings.presents.data.ClientObject target,
+                              int arg1,
+                              int arg2)
+
+
Issues a notification that will result in a call to ZoneReceiver.forcedMove(int, int) on a client. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/server/class-use/ZoneManager.ResolutionListener.html b/apidocs/com/threerings/whirled/zone/server/class-use/ZoneManager.ResolutionListener.html new file mode 100644 index 00000000..70844d75 --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/server/class-use/ZoneManager.ResolutionListener.html @@ -0,0 +1,261 @@ + + + + + + + +Uses of Interface com.threerings.whirled.zone.server.ZoneManager.ResolutionListener (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.whirled.zone.server.ZoneManager.ResolutionListener

+
+ + + + + + + + + + + + + +
+Packages that use ZoneManager.ResolutionListener
com.threerings.whirled.zone.peer.server  
com.threerings.whirled.zone.server  
+  +

+ + + + + +
+Uses of ZoneManager.ResolutionListener in com.threerings.whirled.zone.peer.server
+  +

+ + + + + + + + + +
Subinterfaces of ZoneManager.ResolutionListener in com.threerings.whirled.zone.peer.server
+static interfacePeeredZoneRegistry.PeerZoneResolutionListener + +
+          Peer-awareness for finding out about zones.
+  +

+ + + + + + + + + +
Classes in com.threerings.whirled.zone.peer.server that implement ZoneManager.ResolutionListener
+static classPeeredZoneRegistry.PeerZoneMoveHandler + +
+          A ZoneMoveHandler that can receive the sceneOnNode() callback.
+  +

+ + + + + + + + + +
Methods in com.threerings.whirled.zone.peer.server with parameters of type ZoneManager.ResolutionListener
+ voidPeeredZoneRegistry.resolveZone(int zoneId, + ZoneManager.ResolutionListener listener) + +
+           
+  +

+ + + + + +
+Uses of ZoneManager.ResolutionListener in com.threerings.whirled.zone.server
+  +

+ + + + + + + + + +
Classes in com.threerings.whirled.zone.server that implement ZoneManager.ResolutionListener
+ classZoneMoveHandler + +
+          Handles transitioning between zones.
+  +

+ + + + + + + + + +
Methods in com.threerings.whirled.zone.server with parameters of type ZoneManager.ResolutionListener
+ voidZoneManager.resolveZone(int zoneId, + ZoneManager.ResolutionListener listener) + +
+          Resolves and delivers the scene summary information for the + requested zone.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/server/class-use/ZoneManager.html b/apidocs/com/threerings/whirled/zone/server/class-use/ZoneManager.html new file mode 100644 index 00000000..112bb1f6 --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/server/class-use/ZoneManager.html @@ -0,0 +1,284 @@ + + + + + + + +Uses of Interface com.threerings.whirled.zone.server.ZoneManager (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.whirled.zone.server.ZoneManager

+
+ + + + + + + + + + + + + +
+Packages that use ZoneManager
com.threerings.whirled.zone.peer.server  
com.threerings.whirled.zone.server  
+  +

+ + + + + +
+Uses of ZoneManager in com.threerings.whirled.zone.peer.server
+  +

+ + + + + + + + + +
Subinterfaces of ZoneManager in com.threerings.whirled.zone.peer.server
+ interfacePeeredZoneManager + +
+           
+  +

+ + + + + + + + + +
Methods in com.threerings.whirled.zone.peer.server with parameters of type ZoneManager
+ voidPeeredZoneRegistry.registerZoneManager(byte zoneType, + ZoneManager manager) + +
+           
+  +

+ + + + + + + + +
Constructors in com.threerings.whirled.zone.peer.server with parameters of type ZoneManager
PeeredZoneRegistry.PeerZoneMoveHandler(com.threerings.crowd.server.LocationManager locman, + ZoneManager zmgr, + SceneRegistry scReg, + com.threerings.crowd.data.BodyObject body, + int sceneId, + int sceneVer, + ZoneService.ZoneMoveListener listener) + +
+           
+  +

+ + + + + +
+Uses of ZoneManager in com.threerings.whirled.zone.server
+  +

+ + + + + + + + + +
Methods in com.threerings.whirled.zone.server that return ZoneManager
+ ZoneManagerZoneRegistry.getZoneManager(int qualifiedZoneId) + +
+          Returns the zone manager that handles the specified zone id.
+  +

+ + + + + + + + + +
Methods in com.threerings.whirled.zone.server with parameters of type ZoneManager
+ voidZoneRegistry.registerZoneManager(byte zoneType, + ZoneManager manager) + +
+          Registers the supplied zone manager as the manager for the specified zone type.
+  +

+ + + + + + + + +
Constructors in com.threerings.whirled.zone.server with parameters of type ZoneManager
ZoneMoveHandler(com.threerings.crowd.server.LocationManager locmgr, + ZoneManager zmgr, + SceneRegistry screg, + com.threerings.crowd.data.BodyObject body, + int sceneId, + int sceneVer, + ZoneService.ZoneMoveListener listener) + +
+           
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/server/class-use/ZoneMoveHandler.html b/apidocs/com/threerings/whirled/zone/server/class-use/ZoneMoveHandler.html new file mode 100644 index 00000000..26fa6cda --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/server/class-use/ZoneMoveHandler.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class com.threerings.whirled.zone.server.ZoneMoveHandler (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.zone.server.ZoneMoveHandler

+
+ + + + + + + + + +
+Packages that use ZoneMoveHandler
com.threerings.whirled.zone.peer.server  
+  +

+ + + + + +
+Uses of ZoneMoveHandler in com.threerings.whirled.zone.peer.server
+  +

+ + + + + + + + + +
Subclasses of ZoneMoveHandler in com.threerings.whirled.zone.peer.server
+static classPeeredZoneRegistry.PeerZoneMoveHandler + +
+          A ZoneMoveHandler that can receive the sceneOnNode() callback.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/server/class-use/ZoneProvider.html b/apidocs/com/threerings/whirled/zone/server/class-use/ZoneProvider.html new file mode 100644 index 00000000..077f5ced --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/server/class-use/ZoneProvider.html @@ -0,0 +1,210 @@ + + + + + + + +Uses of Interface com.threerings.whirled.zone.server.ZoneProvider (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
com.threerings.whirled.zone.server.ZoneProvider

+
+ + + + + + + + + + + + + +
+Packages that use ZoneProvider
com.threerings.whirled.zone.peer.server  
com.threerings.whirled.zone.server  
+  +

+ + + + + +
+Uses of ZoneProvider in com.threerings.whirled.zone.peer.server
+  +

+ + + + + + + + + +
Classes in com.threerings.whirled.zone.peer.server that implement ZoneProvider
+ classPeeredZoneRegistry + +
+           
+  +

+ + + + + +
+Uses of ZoneProvider in com.threerings.whirled.zone.server
+  +

+ + + + + + + + + +
Classes in com.threerings.whirled.zone.server that implement ZoneProvider
+ classZoneRegistry + +
+          The zone registry takes care of mapping zone requests to the appropriate registered zone manager.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/server/class-use/ZoneRegistry.html b/apidocs/com/threerings/whirled/zone/server/class-use/ZoneRegistry.html new file mode 100644 index 00000000..c5667158 --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/server/class-use/ZoneRegistry.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class com.threerings.whirled.zone.server.ZoneRegistry (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.zone.server.ZoneRegistry

+
+ + + + + + + + + +
+Packages that use ZoneRegistry
com.threerings.whirled.zone.peer.server  
+  +

+ + + + + +
+Uses of ZoneRegistry in com.threerings.whirled.zone.peer.server
+  +

+ + + + + + + + + +
Subclasses of ZoneRegistry in com.threerings.whirled.zone.peer.server
+ classPeeredZoneRegistry + +
+           
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/server/class-use/ZoneSender.html b/apidocs/com/threerings/whirled/zone/server/class-use/ZoneSender.html new file mode 100644 index 00000000..aded92b0 --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/server/class-use/ZoneSender.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.whirled.zone.server.ZoneSender (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.zone.server.ZoneSender

+
+No usage of com.threerings.whirled.zone.server.ZoneSender +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/server/package-frame.html b/apidocs/com/threerings/whirled/zone/server/package-frame.html new file mode 100644 index 00000000..e0b9a445 --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/server/package-frame.html @@ -0,0 +1,52 @@ + + + + + + + +com.threerings.whirled.zone.server (vilya 1.3 API) + + + + + + + + + + + +com.threerings.whirled.zone.server + + + + +
+Interfaces  + +
+ZoneManager +
+ZoneManager.ResolutionListener +
+ZoneProvider
+ + + + + + +
+Classes  + +
+ZoneMoveHandler +
+ZoneRegistry +
+ZoneSender
+ + + + diff --git a/apidocs/com/threerings/whirled/zone/server/package-summary.html b/apidocs/com/threerings/whirled/zone/server/package-summary.html new file mode 100644 index 00000000..07328af5 --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/server/package-summary.html @@ -0,0 +1,190 @@ + + + + + + + +com.threerings.whirled.zone.server (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.whirled.zone.server +

+ + + + + + + + + + + + + + + + + +
+Interface Summary
ZoneManagerA zone is a collection of scenes organized into a connected group.
ZoneManager.ResolutionListenerUsed to notify requesters when an asynchronous zone load has + completed (successfully or not).
ZoneProviderDefines the server-side of the ZoneService.
+  + +

+ + + + + + + + + + + + + + + + + +
+Class Summary
ZoneMoveHandlerHandles transitioning between zones.
ZoneRegistryThe zone registry takes care of mapping zone requests to the appropriate registered zone manager.
ZoneSenderUsed to issue notifications to a ZoneReceiver instance on a + client.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/server/package-tree.html b/apidocs/com/threerings/whirled/zone/server/package-tree.html new file mode 100644 index 00000000..bef2e9f2 --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/server/package-tree.html @@ -0,0 +1,168 @@ + + + + + + + +com.threerings.whirled.zone.server Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.whirled.zone.server +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/server/package-use.html b/apidocs/com/threerings/whirled/zone/server/package-use.html new file mode 100644 index 00000000..ab41acad --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/server/package-use.html @@ -0,0 +1,228 @@ + + + + + + + +Uses of Package com.threerings.whirled.zone.server (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.whirled.zone.server

+
+ + + + + + + + + + + + + +
+Packages that use com.threerings.whirled.zone.server
com.threerings.whirled.zone.peer.server  
com.threerings.whirled.zone.server  
+  +

+ + + + + + + + + + + + + + + + + + + + +
+Classes in com.threerings.whirled.zone.server used by com.threerings.whirled.zone.peer.server
ZoneManager + +
+          A zone is a collection of scenes organized into a connected group.
ZoneManager.ResolutionListener + +
+          Used to notify requesters when an asynchronous zone load has + completed (successfully or not).
ZoneMoveHandler + +
+          Handles transitioning between zones.
ZoneProvider + +
+          Defines the server-side of the ZoneService.
ZoneRegistry + +
+          The zone registry takes care of mapping zone requests to the appropriate registered zone manager.
+  +

+ + + + + + + + + + + + + + +
+Classes in com.threerings.whirled.zone.server used by com.threerings.whirled.zone.server
ZoneManager + +
+          A zone is a collection of scenes organized into a connected group.
ZoneManager.ResolutionListener + +
+          Used to notify requesters when an asynchronous zone load has + completed (successfully or not).
ZoneProvider + +
+          Defines the server-side of the ZoneService.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/util/ZoneUtil.html b/apidocs/com/threerings/whirled/zone/util/ZoneUtil.html new file mode 100644 index 00000000..fb0128a9 --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/util/ZoneUtil.html @@ -0,0 +1,328 @@ + + + + + + + +ZoneUtil (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.threerings.whirled.zone.util +
+Class ZoneUtil

+
+java.lang.Object
+  extended by com.threerings.whirled.zone.util.ZoneUtil
+
+
+
+
public class ZoneUtil
extends Object
+ + +

+Server-specific, zone-related utility functions. +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
ZoneUtil() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+static intqualifyZoneId(byte zoneType, + int zoneId) + +
+          Composes the zone type and zone id into a qualified zone id.
+static StringtoString(int qualifiedZoneId) + +
+          Returns an easier to read representation of the supplied qualified + zone id: type:id.
+static intzoneId(int qualifiedZoneId) + +
+          Extracts the zone id from a qualified zone id.
+static intzoneType(int qualifiedZoneId) + +
+          Extracts the zone type from a qualified zone id.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+ZoneUtil

+
+public ZoneUtil()
+
+
+ + + + + + + + +
+Method Detail
+ +

+qualifyZoneId

+
+public static int qualifyZoneId(byte zoneType,
+                                int zoneId)
+
+
Composes the zone type and zone id into a qualified zone id. A + qualified zone id is what should be passed around so that the + server can determine the zone type from the zone id when necessary. +

+

+
+
+
+
+ +

+zoneType

+
+public static int zoneType(int qualifiedZoneId)
+
+
Extracts the zone type from a qualified zone id. +

+

+
+
+
+
+ +

+zoneId

+
+public static int zoneId(int qualifiedZoneId)
+
+
Extracts the zone id from a qualified zone id. +

+

+
+
+
+
+ +

+toString

+
+public static String toString(int qualifiedZoneId)
+
+
Returns an easier to read representation of the supplied qualified + zone id: type:id. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/util/class-use/ZoneUtil.html b/apidocs/com/threerings/whirled/zone/util/class-use/ZoneUtil.html new file mode 100644 index 00000000..f7e0c2df --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/util/class-use/ZoneUtil.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class com.threerings.whirled.zone.util.ZoneUtil (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
com.threerings.whirled.zone.util.ZoneUtil

+
+No usage of com.threerings.whirled.zone.util.ZoneUtil +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/util/package-frame.html b/apidocs/com/threerings/whirled/zone/util/package-frame.html new file mode 100644 index 00000000..e3d9975a --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/util/package-frame.html @@ -0,0 +1,33 @@ + + + + + + + +com.threerings.whirled.zone.util (vilya 1.3 API) + + + + + + + + + + + +com.threerings.whirled.zone.util + + + + +
+Classes  + +
+ZoneUtil
+ + + + diff --git a/apidocs/com/threerings/whirled/zone/util/package-summary.html b/apidocs/com/threerings/whirled/zone/util/package-summary.html new file mode 100644 index 00000000..e5e46a1b --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/util/package-summary.html @@ -0,0 +1,158 @@ + + + + + + + +com.threerings.whirled.zone.util (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.threerings.whirled.zone.util +

+ + + + + + + + + +
+Class Summary
ZoneUtilServer-specific, zone-related utility functions.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/util/package-tree.html b/apidocs/com/threerings/whirled/zone/util/package-tree.html new file mode 100644 index 00000000..4e876445 --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/util/package-tree.html @@ -0,0 +1,154 @@ + + + + + + + +com.threerings.whirled.zone.util Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.threerings.whirled.zone.util +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/com/threerings/whirled/zone/util/package-use.html b/apidocs/com/threerings/whirled/zone/util/package-use.html new file mode 100644 index 00000000..ee97abfb --- /dev/null +++ b/apidocs/com/threerings/whirled/zone/util/package-use.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Package com.threerings.whirled.zone.util (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
com.threerings.whirled.zone.util

+
+No usage of com.threerings.whirled.zone.util +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/constant-values.html b/apidocs/constant-values.html new file mode 100644 index 00000000..036665be --- /dev/null +++ b/apidocs/constant-values.html @@ -0,0 +1,2191 @@ + + + + + + + +Constant Field Values (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Constant Field Values

+
+
+Contents + + + + + + +
+com.threerings.*
+ +

+ + + + + + + + + + + + + + + + + +
com.threerings.micasa.lobby.LobbyMarshaller
+public static final intGET_CATEGORIES1
+public static final intGET_LOBBIES2
+ +

+ +

+ + + + + + + + + + + + +
com.threerings.micasa.lobby.LobbyMarshaller.CategoriesMarshaller
+public static final intGOT_CATEGORIES1
+ +

+ +

+ + + + + + + + + + + + +
com.threerings.micasa.lobby.LobbyMarshaller.LobbiesMarshaller
+public static final intGOT_LOBBIES1
+ +

+ +

+ + + + + + + + + + + + + + + + + +
com.threerings.micasa.lobby.table.TableLobbyObject
+public static final StringTABLE_SERVICE"tableService"
+public static final StringTABLE_SET"tableSet"
+ +

+ +

+ + + + + + + + + + + + +
com.threerings.micasa.simulator.client.SimulatorController
+public static final StringLOGOFF"logoff"
+ +

+ +

+ + + + + + + + + + + + +
com.threerings.micasa.simulator.data.SimulatorMarshaller
+public static final intCREATE_GAME1
+ +

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
com.threerings.parlor.card.client.CardGameDecoder
+public static final intCARDS_TRANSFERRED_BETWEEN_PLAYERS1
+public static final intRECEIVED_CARDS_FROM_PLAYER2
+public static final intRECEIVED_HAND3
+public static final StringRECEIVER_CODE"0718199d459e31d8d673744c71b0e788"
+public static final intSENT_CARDS_TO_PLAYER4
+ +

+ +

+ + + + + + + + + + + + + + + + + + + + + + +
com.threerings.parlor.card.client.CardPanel
+public static final intMULTIPLE2
+public static final intNONE0
+public static final intSINGLE1
+ +

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
com.threerings.parlor.card.data.CardCodes
+public static final intACE14
+public static final intBLACK_JOKER16
+public static final intCLUBS2
+public static final intDIAMONDS3
+public static final intHEARTS1
+public static final intJACK11
+public static final intKING13
+public static final intQUEEN12
+public static final intRED_JOKER15
+public static final intSPADES0
+ +

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
com.threerings.parlor.card.trick.data.TrickCardCodes
+public static final intBOTTOM0
+public static final intLEFT1
+public static final intRIGHT3
+public static final intTOP2
+ +

+ +

+ + + + + + + + + + + + + + + + + + + + + + +
com.threerings.parlor.card.trick.data.TrickCardGameMarshaller
+public static final intPLAY_CARD1
+public static final intREQUEST_REMATCH2
+public static final intSEND_CARDS_TO_PLAYER3
+ +

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
com.threerings.parlor.card.trick.data.TrickCardGameObject
+public static final intACCEPTS_REMATCH2
+public static final intBETWEEN_HANDS0
+public static final intNO_REQUEST0
+public static final intPLAYING_HAND1
+public static final intPLAYING_TRICK2
+public static final intREQUESTS_REMATCH1
+public static final intTRICK_STATE_COUNT3
+ +

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
com.threerings.parlor.client.ParlorDecoder
+public static final intGAME_IS_READY1
+public static final intRECEIVED_INVITE2
+public static final intRECEIVED_INVITE_CANCELLATION3
+public static final intRECEIVED_INVITE_RESPONSE4
+public static final StringRECEIVER_CODE"5ef9ee0d359c42a9024498ee9aad119a"
+ +

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
com.threerings.parlor.data.ParlorCodes
+public static final StringALREADY_AT_TABLE"m.already_at_table"
+public static final StringBANNED_FROM_TABLE"m.banned_from_table"
+public static final StringGAME_ALREADY_STARTED"m.game_already_started"
+public static final StringINVALID_TABLE_POSITION"m.invalid_table_position"
+public static final intINVITATION_ACCEPTED0
+public static final intINVITATION_COUNTERED2
+public static final intINVITATION_REFUSED1
+public static final StringINVITEE_NOT_ONLINE"m.invitee_not_online"
+public static final StringMUST_BE_CREATOR"m.must_be_creator"
+public static final StringNO_SELF_BOOT"m.no_self_boot"
+public static final StringNO_SUCH_TABLE"m.no_such_table"
+public static final StringNOT_AT_TABLE"m.not_at_table"
+public static final StringPARLOR_GROUP"parlor"
+public static final StringTABLE_POSITION_OCCUPIED"m.table_position_occupied"
+ +

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
com.threerings.parlor.data.ParlorMarshaller
+public static final intCANCEL1
+public static final intINVITE2
+public static final intRESPOND3
+public static final intSTART_SOLITAIRE4
+ +

+ +

+ + + + + + + + + + + + +
com.threerings.parlor.data.ParlorMarshaller.InviteMarshaller
+public static final intINVITE_RECEIVED1
+ +

+ +

+ + + + + + + + + + + + +
com.threerings.parlor.data.Table
+public static final intANY_POSITION-1
+ +

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
com.threerings.parlor.data.TableMarshaller
+public static final intBOOT_PLAYER1
+public static final intCREATE_TABLE2
+public static final intJOIN_TABLE3
+public static final intLEAVE_TABLE4
+public static final intSTART_TABLE_NOW5
+ +

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
com.threerings.parlor.game.data.GameCodes
+public static final StringGAME_CHAT_TYPE"gameChat"
+public static final StringGAME_MESSAGE_BUNDLE"game.general"
+public static final StringPLAYER_KNOCKED_OUT"playerKnocked"
+public static final StringWINNERS_AND_LOSERS"winnersAndLosers"
+ +

+ +

+ + + + + + + + + + + + + + + + + + + + + + +
com.threerings.parlor.game.data.GameConfig
+public static final intPARTY2
+public static final intSEATED_CONTINUOUS1
+public static final intSEATED_GAME0
+ +

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
com.threerings.parlor.game.data.GameObject
+public static final intCANCELLED3
+public static final intGAME_OVER2
+public static final intIN_PLAY1
+public static final StringIS_PRIVATE"isPrivate"
+public static final StringIS_RATED"isRated"
+public static final intPLAYER_IN_PLAY0
+public static final intPLAYER_LEFT_GAME1
+public static final StringPLAYER_STATUS"playerStatus"
+public static final StringPLAYERS"players"
+public static final intPRE_GAME0
+public static final StringSESSION_ID"sessionId"
+public static final StringSTATE"state"
+public static final StringWINNERS"winners"
+ +

+ +

+ + + + + + + + + + + + + + + + + + + + + + +
com.threerings.parlor.rating.data.RatingCodes
+public static final intDEFAULT_RATING1200
+public static final intMAXIMUM_RATING3000
+public static final intMINIMUM_RATING1000
+ +

+ +

+ + + + + + + + + + + + +
com.threerings.parlor.rating.server.persist.PercentileRecord
+public static final intSCHEMA_VERSION4
+ +

+ +

+ + + + + + + + + + + + +
com.threerings.parlor.rating.server.persist.RatingRecord
+public static final intSCHEMA_VERSION4
+ +

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
com.threerings.parlor.tourney.data.TourneyCodes
+public static final StringALREADY_IN_PROGRESS"m.already_in_progress"
+public static final StringALREADY_IN_TOURNEY"m.already_in_tourney"
+public static final StringCANCELLED"m.cancelled"
+public static final StringFAILED_ENTRY_FEE"m.failed_entry_fee"
+public static final StringHAS_PLAYERS"m.has_players"
+public static final StringNOT_IN_TOURNEY"m.not_in_tourney"
+public static final StringTOO_LATE"m.too_late"
+public static final StringTOO_LATE_LEAVE"m.too_late_leave"
+ +

+ +

+ + + + + + + + + + + + + + + + + + + + + + +
com.threerings.parlor.tourney.data.TourneyMarshaller
+public static final intCANCEL1
+public static final intJOIN2
+public static final intLEAVE3
+ +

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
com.threerings.parlor.tourney.data.TourneyObject
+public static final intCANCELLED2
+public static final StringCONFIG"config"
+public static final intFINISHED4
+public static final StringPARTICIPANTS"participants"
+public static final intPAUSED3
+public static final intPENDING0
+public static final intRUNNING1
+public static final StringSTARTS_IN"startsIn"
+public static final StringSTATE"state"
+public static final StringTOURNEY_SERVICE"tourneyService"
+ +

+ +

+ + + + + + + + + + + + +
com.threerings.parlor.tourney.data.TourniesMarshaller
+public static final intCREATE_TOURNEY1
+ +

+ +

+ + + + + + + + + + + + +
com.threerings.parlor.tourney.server.persist.TourneyRepository
+public static final StringTOURNEY_DB_IDENT"tourneydb"
+ +

+ +

+ + + + + + + + + + + + +
com.threerings.puzzle.client.PuzzleController
+public static final StringTOGGLE_CHATTING"toggle_chat"
+ +

+ +

+ + + + + + + + + + + + + + + + + + + + + + +
com.threerings.puzzle.client.PuzzleController.ClearPender
+public static final intCARE_NOT0
+public static final intNO_RESTART_ACTION1
+public static final intRESTART_ACTION-1
+ +

+ +

+ + + + + + + + + + + + + + + + + + + + + + +
com.threerings.puzzle.data.PuzzleCodes
+public static final booleanDEBUG_PUZZLEfalse
+public static final intDEFAULT_DIFFICULTY2
+public static final StringPUZZLE_MESSAGE_BUNDLE"puzzle.general"
+ +

+ +

+ + + + + + + + + + + + + + + + + +
com.threerings.puzzle.data.PuzzleGameMarshaller
+public static final intUPDATE_PROGRESS1
+public static final intUPDATE_PROGRESS_SYNC2
+ +

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
com.threerings.puzzle.data.PuzzleObject
+public static final StringDIFFICULTY"difficulty"
+public static final StringPUZZLE_GAME_SERVICE"puzzleGameService"
+public static final StringSEED"seed"
+public static final StringSUMMARIES"summaries"
+ +

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
com.threerings.puzzle.drop.client.DropControllerDelegate
+public static final StringEND_DROP_BLOCK"end_drop_block"
+public static final StringMOVE_BLOCK_LEFT"move_block_left"
+public static final StringMOVE_BLOCK_RIGHT"move_block_right"
+public static final StringRAISE_ROW"raise_row"
+public static final StringROTATE_BLOCK_CCW"rotate_block_ccw"
+public static final StringROTATE_BLOCK_CW"rotate_block_cw"
+public static final StringSTART_DROP_BLOCK"start_drop_block"
+ +

+ +

+ + + + + + + + + + + + + + + + + +
com.threerings.puzzle.drop.data.DropBoard
+public static final intINPLACE_ROTATION1
+public static final intRADIAL_ROTATION0
+ +

+ +

+ + + + + + + + + + + + + + + + + + + + + + +
com.threerings.puzzle.drop.data.DropCodes
+public static final StringDROP_MESSAGE_BUNDLE"puzzle.drop"
+public static final StringDROP_STREAM"drop"
+public static final StringRISE_STREAM"rise"
+ +

+ +

+ + + + + + + + + + + + + + + + + +
com.threerings.puzzle.drop.data.DropPieceCodes
+public static final intDROP_BLOCK_PIECE_COUNT2
+public static final bytePIECE_NONE-1
+ +

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
com.threerings.stage.client.StageScenePanel
+public static final StringCLUSTER_CLICKED"ClusterClicked"
+public static final StringLOCATION_CLICKED"LocationClicked"
+public static final intSHOW_CLUSTERS2
+public static final intSHOW_PLOTS4
+ +

+ +

+ + + + + + + + + + + + + + + + + +
com.threerings.stage.data.StageCodes
+public static final StringSTAGE_MESSAGE_BUNDLE"stage.general"
+public static final StringTILESET_RSRC_SET"tilesets"
+ +

+ +

+ + + + + + + + + + + + + + + + + +
com.threerings.stage.data.StageMisoSceneModel
+public static final intSECTION_HEIGHT9
+public static final intSECTION_WIDTH9
+ +

+ +

+ + + + + + + + + + + + + + + + + +
com.threerings.stage.data.StageSceneMarshaller
+public static final intADD_OBJECT1
+public static final intREMOVE_OBJECTS2
+ +

+ +

+ + + + + + + + + + + + +
com.threerings.stage.data.StageSceneModel
+public static final StringWORLD"world"
+ +

+ +

+ + + + + + + + + + + + + + + + + + + + + + +
com.threerings.stage.data.StageSceneObject
+public static final StringLIGHT_LEVEL"lightLevel"
+public static final StringLIGHT_SHADE"lightShade"
+public static final StringSTAGE_SCENE_SERVICE"stageSceneService"
+ +

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
com.threerings.stage.tools.editor.EditorModel
+public static final intACTION_EDIT_TILE1
+public static final intACTION_PLACE_PORTAL2
+public static final intACTION_PLACE_TILE0
+public static final intBASE_LAYER0
+public static final intNUM_ACTIONS3
+public static final intOBJECT_LAYER1
+ +

+ +

+ + + + + + + + + + + + + + + + + + + + + + +
com.threerings.stage.tools.editor.EditorModelListener
+public static final intACTION_MODE_CHANGED0
+public static final intLAYER_INDEX_CHANGED1
+public static final intTILE_CHANGED2
+ +

+ +

+ + + + + + + + + + + + +
com.threerings.stage.util.StageSceneUtil
+public static final intOBJECT_ORIENTATION-1
+ +

+ +

+ + + + + + + + + + + + +
com.threerings.stats.server.persist.StatRecord
+public static final intSCHEMA_VERSION4
+ +

+ +

+ + + + + + + + + + + + +
com.threerings.stats.server.persist.StringCodeRecord
+public static final intSCHEMA_VERSION2
+ +

+ +

+ + + + + + + + + + + + + + + + + +
com.threerings.whirled.client.SceneDecoder
+public static final intFORCED_MOVE1
+public static final StringRECEIVER_CODE"c4d0cf66b81a6e83d119b2d607725651"
+ +

+ +

+ + + + + + + + + + + + + + + + + +
com.threerings.whirled.data.SceneCodes
+public static final StringSCENE_UPDATE"scene_update"
+public static final StringWHIRLED_GROUP"whirled"
+ +

+ +

+ + + + + + + + + + + + +
com.threerings.whirled.data.SceneMarshaller
+public static final intMOVE_TO1
+ +

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
com.threerings.whirled.data.SceneMarshaller.SceneMoveMarshaller
+public static final intMOVE_REQUIRES_SERVER_SWITCH1
+public static final intMOVE_SUCCEEDED2
+public static final intMOVE_SUCCEEDED_WITH_SCENE3
+public static final intMOVE_SUCCEEDED_WITH_UPDATES4
+ +

+ +

+ + + + + + + + + + + + +
com.threerings.whirled.spot.data.ClusterObject
+public static final StringOCCUPANTS"occupants"
+ +

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
com.threerings.whirled.spot.data.SpotCodes
+public static final StringCLUSTER_CHAT_TYPE"clusterChat"
+public static final StringCLUSTER_FULL"m.cluster_full"
+public static final StringINVALID_LOCATION"m.invalid_location"
+public static final StringLOCATION_OCCUPIED"m.location_occupied"
+public static final StringNO_SUCH_CLUSTER"m.no_such_cluster"
+public static final StringNO_SUCH_PORTAL"m.no_such_portal"
+ +

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
com.threerings.whirled.spot.data.SpotMarshaller
+public static final intCHANGE_LOCATION1
+public static final intCLUSTER_SPEAK2
+public static final intJOIN_CLUSTER3
+public static final intTRAVERSE_PORTAL4
+ +

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
com.threerings.whirled.spot.data.SpotMarshaller.SpotSceneMoveMarshaller
+public static final intMOVE_REQUIRES_SERVER_SWITCH1
+public static final intMOVE_SUCCEEDED2
+public static final intMOVE_SUCCEEDED_WITH_SCENE3
+public static final intMOVE_SUCCEEDED_WITH_UPDATES4
+public static final intREQUEST_CANCELLED5
+ +

+ +

+ + + + + + + + + + + + + + + + + +
com.threerings.whirled.spot.data.SpotSceneObject
+public static final StringCLUSTERS"clusters"
+public static final StringOCCUPANT_LOCS"occupantLocs"
+ +

+ +

+ + + + + + + + + + + + +
com.threerings.whirled.spot.tools.xml.SpotSceneWriter
+public static final StringOUTER_ELEMENT"spot"
+ +

+ +

+ + + + + + + + + + + + +
com.threerings.whirled.tools.xml.SceneWriter
+public static final StringOUTER_ELEMENT"scene"
+ +

+ +

+ + + + + + + + + + + + + + + + + +
com.threerings.whirled.zone.client.ZoneDecoder
+public static final intFORCED_MOVE1
+public static final StringRECEIVER_CODE"2d900cf54355111b4bb4befcdff42b82"
+ +

+ +

+ + + + + + + + + + + + +
com.threerings.whirled.zone.data.ZoneCodes
+public static final StringNO_SUCH_ZONE"m.no_such_zone"
+ +

+ +

+ + + + + + + + + + + + +
com.threerings.whirled.zone.data.ZoneMarshaller
+public static final intMOVE_TO1
+ +

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
com.threerings.whirled.zone.data.ZoneMarshaller.ZoneMoveMarshaller
+public static final intMOVE_REQUIRES_SERVER_SWITCH1
+public static final intMOVE_SUCCEEDED2
+public static final intMOVE_SUCCEEDED_WITH_SCENE3
+public static final intMOVE_SUCCEEDED_WITH_UPDATES4
+ +

+ +

+ + + + + + + + + + + + +
com.threerings.whirled.zone.peer.server.ZoneNodeObject
+public static final StringHOSTED_ZONES"hostedZones"
+ +

+ +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/deprecated-list.html b/apidocs/deprecated-list.html new file mode 100644 index 00000000..7490774d --- /dev/null +++ b/apidocs/deprecated-list.html @@ -0,0 +1,197 @@ + + + + + + + +Deprecated List (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use  Tree   Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Deprecated API

+
+
+Contents + + + + + + + + + +
+Deprecated Methods
com.threerings.parlor.media.ScoreAnimation.createLabel(String, Color, Font, MediaPanel) +
+          This signature is retained for backwards compatibility. 
+  +

+ + + + + + + + + + + + + + + + + + + + +
+Deprecated Constructors
com.threerings.puzzle.drop.server.DropManagerDelegate(PuzzleManager, DropLogic) +
+          use DropManagerDelegate.DropManagerDelegate(DropLogic). 
com.threerings.parlor.game.server.GameManagerDelegate(GameManager) +
+          use the zero-argument constructor. 
com.threerings.puzzle.server.PuzzleManagerDelegate(PuzzleManager) +
+          use the zero-argument constructor. 
com.threerings.parlor.card.trick.server.TrickCardGameManagerDelegate(CardGameManager) +
+          use the zero-argument constructor. 
com.threerings.parlor.turn.server.TurnGameManagerDelegate(TurnGameManager) +
+          use the zero-argument constructor. 
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use  Tree   Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/help-doc.html b/apidocs/help-doc.html new file mode 100644 index 00000000..b3a690b9 --- /dev/null +++ b/apidocs/help-doc.html @@ -0,0 +1,224 @@ + + + + + + + +API Help (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use  Tree  Deprecated  Index   Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+How This API Document Is Organized

+
+This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.

+Overview

+
+ +

+The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.

+

+Package

+
+ +

+Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain four categories:

+
+

+Class/Interface

+
+ +

+Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

+Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
+ +

+Annotation Type

+
+ +

+Each annotation type has its own separate page with the following sections:

+
+ +

+Enum

+
+ +

+Each enum has its own separate page with the following sections:

+
+

+Use

+
+Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.
+

+Tree (Class Hierarchy)

+
+There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object. +
+

+Deprecated API

+
+The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
+

+Index

+
+The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
+

+Prev/Next

+These links take you to the next or previous class, interface, package, or related page.

+Frames/No Frames

+These links show and hide the HTML frames. All pages are available with or without frames. +

+

+Serialized Form

+Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description. +

+

+Constant Field Values

+The Constant Field Values page lists the static final fields and their values. +

+ + +This help file applies to API documentation generated using the standard doclet. + +
+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use  Tree  Deprecated  Index   Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/index-all.html b/apidocs/index-all.html new file mode 100644 index 00000000..b8a84252 --- /dev/null +++ b/apidocs/index-all.html @@ -0,0 +1,7783 @@ + + + + + + + +Index (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C D E F G H I J K L M N O P Q R S T U V W X Y Z _
+

+A

+
+
abortAnimation(Animation) - +Method in class com.threerings.puzzle.client.PuzzleBoardView +
  +
AbstractSceneMoveHandler - Class in com.threerings.whirled.server
Handles the basics of moving a client into a new scene, which may involve resolution.
AbstractSceneMoveHandler(LocationManager, BodyObject, InvocationService.InvocationListener) - +Constructor for class com.threerings.whirled.server.AbstractSceneMoveHandler +
  +
accept() - +Method in class com.threerings.parlor.client.Invitation +
Accepts this invitation. +
accepted() - +Method in class com.threerings.stage.tools.editor.EditorDialog +
Called when ok is clicked. +
accepted() - +Method in class com.threerings.stage.tools.editor.ObjectEditorDialog +
  +
accepted() - +Method in class com.threerings.stage.tools.editor.PortalDialog +
Handles the user submitting the dialog via the "OK" button. +
ACCEPTS_REMATCH - +Static variable in interface com.threerings.parlor.card.trick.data.TrickCardGameObject +
Indicates that the player has accepted the rematch request. +
ACE - +Static variable in interface com.threerings.parlor.card.data.CardCodes +
The number of the ace. +
ACTION_EDIT_TILE - +Static variable in class com.threerings.stage.tools.editor.EditorModel +
  +
ACTION_MODE_CHANGED - +Static variable in interface com.threerings.stage.tools.editor.EditorModelListener +
Notification event constants. +
ACTION_PLACE_PORTAL - +Static variable in class com.threerings.stage.tools.editor.EditorModel +
  +
ACTION_PLACE_TILE - +Static variable in class com.threerings.stage.tools.editor.EditorModel +
Action mode constants. +
actionCleared() - +Method in interface com.threerings.puzzle.client.PuzzleController.ClearPender +
Called when the action is fully cleared. +
actionPerformed(ActionEvent) - +Method in class com.threerings.micasa.client.ChatPanel +
  +
actionPerformed(ActionEvent) - +Method in class com.threerings.micasa.client.LogonPanel +
  +
actionPerformed(ActionEvent) - +Method in class com.threerings.micasa.lobby.LobbySelector +
Called when the user selects a category or double-clicks on a + lobby. +
actionPerformed(ActionEvent) - +Method in class com.threerings.micasa.lobby.table.TableItem +
  +
actionPerformed(ActionEvent) - +Method in class com.threerings.micasa.lobby.table.TableListView +
  +
actionPerformed(ActionEvent) - +Method in class com.threerings.stage.tools.editor.EditorDialog +
  +
actionPerformed(ActionEvent) - +Method in class com.threerings.stage.tools.editor.EditorToolBarPanel +
  +
actionPerformed(ActionEvent) - +Method in class com.threerings.stage.tools.editor.PortalDialog +
Handle action events on the dialog user interface elements. +
actionPerformed(ActionEvent) - +Method in class com.threerings.stage.tools.editor.PreferencesDialog +
Handle action events. +
actionPerformed(ActionEvent) - +Method in class com.threerings.stage.tools.editor.SceneInfoPanel +
  +
add(int, int) - +Method in class com.threerings.puzzle.util.PointSet +
Adds a point to the set and returns whether the point was already present in the set. +
add(Integer) - +Method in class com.threerings.stats.data.IntSetStat +
Adds the specified int to this set. +
add(T) - +Method in class com.threerings.stats.data.SetStat +
Adds the specified object to this set. +
add(String) - +Method in class com.threerings.stats.data.StringSetStat +
Adds the specified string to this set. +
ADD_OBJECT - +Static variable in class com.threerings.stage.data.StageSceneMarshaller +
The method id used to dispatch StageSceneMarshaller.addObject(com.threerings.miso.data.ObjectInfo, com.threerings.presents.client.InvocationService.ConfirmListener) requests. +
addActionAnimation(Animation) - +Method in class com.threerings.puzzle.client.PuzzleBoardView +
Adds the given animation to the set of animations currently present on the board. +
addActionSprite(Sprite) - +Method in class com.threerings.puzzle.client.PuzzleBoardView +
Adds the given sprite to the set of sprites currently present on the board. +
addAll(Card[]) - +Method in class com.threerings.parlor.card.data.Hand +
Adds all of the specified cards to this hand. +
addAll(PointSet) - +Method in class com.threerings.puzzle.util.PointSet +
Adds all points in the given set to this set. +
addAuxModel(AuxModel) - +Method in class com.threerings.whirled.data.SceneModel +
Adds the specified auxiliary model to this scene model. +
addBannedUser(Name) - +Method in class com.threerings.parlor.data.Table +
Indicate to this table that a user was booted and should + be prevented from rejoining. +
addButton(ActionListener, Container, String, String) - +Static method in class com.threerings.stage.tools.editor.util.EditorDialogUtil +
Add a button to a container with the given parameters and + action listener. +
addComponents(JComponent) - +Method in class com.threerings.stage.tools.editor.EditorDialog +
  +
addComponents(JComponent) - +Method in class com.threerings.stage.tools.editor.ObjectEditorDialog +
  +
addComponents(JComponent) - +Method in class com.threerings.stage.tools.editor.PortalDialog +
  +
addControl(JComponent, JComponent) - +Method in class com.threerings.parlor.game.client.SwingGameConfigurator +
Add a control to the interface. +
added - +Variable in class com.threerings.stage.data.ModifyObjectsUpdate +
The objects added to the scene (or null for none). +
addGameReadyObserver(GameReadyObserver) - +Method in class com.threerings.parlor.client.ParlorDirector +
Adds the specified observer to the list of entities that are notified when we receive a game + ready notification. +
addHandSelectionObserver(CardPanel.CardSelectionObserver) - +Method in class com.threerings.parlor.card.client.CardPanel +
Adds an object to the list of observers to notify when cards in the hand are + selected/deselected. +
addListener(EditorModelListener) - +Method in class com.threerings.stage.tools.editor.EditorModel +
Add an editor model listener. +
addNotify() - +Method in class com.threerings.micasa.lobby.LobbySelector +
  +
addNotify() - +Method in class com.threerings.puzzle.client.PuzzlePanel +
  +
addObject(ObjectInfo, InvocationService.ConfirmListener) - +Method in interface com.threerings.stage.client.StageSceneService +
Requests to add the supplied object to the current scene. +
addObject(ObjectInfo) - +Method in class com.threerings.stage.data.StageScene +
Adds a new object to this scene. +
addObject(ObjectInfo, InvocationService.ConfirmListener) - +Method in class com.threerings.stage.data.StageSceneMarshaller +
  +
addObject(ObjectInfo, boolean, boolean) - +Method in class com.threerings.stage.server.StageSceneManager +
Adds the supplied object to this scene. +
addObject(ClientObject, ObjectInfo, InvocationService.ConfirmListener) - +Method in class com.threerings.stage.server.StageSceneManager +
  +
addObject(ClientObject, ObjectInfo, InvocationService.ConfirmListener) - +Method in interface com.threerings.stage.server.StageSceneProvider +
Handles a StageSceneService.addObject(com.threerings.miso.data.ObjectInfo, com.threerings.presents.client.InvocationService.ConfirmListener) request. +
addObject(ObjectTile, int, int, int) - +Method in class com.threerings.stage.tools.editor.EditorScenePanel +
Sets an object tile at the specified position in the scene (in tile coordinates). +
addObject(ObjectInfo) - +Method in class com.threerings.stage.tools.editor.EditorScenePanel +
Adds the given object to the scene. +
addObject(ObjectInfo) - +Method in class com.threerings.stage.util.PlacementConstraints +
Adds the specified object through the constraints. +
addPendingForcedMove(Runnable) - +Method in class com.threerings.whirled.client.SceneDirector +
  +
addPlayer(Name) - +Method in class com.threerings.parlor.game.server.GameManager +
Adds the given player to the game at the first available player index. +
addPlayerAt(Name, int) - +Method in class com.threerings.parlor.game.server.GameManager +
Adds the given player to the game at the specified player index. +
addPortal(Portal) - +Method in class com.threerings.stage.data.StageScene +
  +
addPortal(Portal) - +Method in interface com.threerings.whirled.spot.data.SpotScene +
Adds a portal to this scene, immediately making the requisite modifications to the + underlying scene model. +
addPortal(Portal) - +Method in class com.threerings.whirled.spot.data.SpotSceneImpl +
  +
addPortal(Portal) - +Method in class com.threerings.whirled.spot.data.SpotSceneModel +
Adds a portal to this scene model. +
addProgressEvent(int, Board) - +Method in class com.threerings.puzzle.client.PuzzleController +
Adds the given progress event and a snapshot of the supplied board state to the set of + progress events and associated board states for later transmission to the server. +
addQuietly(Stat) - +Method in class com.threerings.stats.data.StatSet +
Don't call this method, it's only needed by some tricky business we do when preventing + distributed object event generation for all but the bounty criteria related stats. +
addRuleInstances(String, Digester) - +Method in class com.threerings.whirled.spot.tools.xml.SpotSceneRuleSet +
  +
addRuleInstances(String, Digester) - +Method in class com.threerings.whirled.tools.xml.SceneRuleSet +
  +
addSeatednessObserver(SeatednessObserver) - +Method in class com.threerings.parlor.client.TableDirector +
Requests that the specified observer be added to the list of observers that are notified + when this client sits down at or stands up from a table. +
addTestTileSet(int, TileSet) - +Method in class com.threerings.stage.tools.editor.EditorTileManager +
Add a test tile set to search before normal tilesets. +
addToBoard(Card, Point) - +Method in class com.threerings.parlor.card.client.CardPanel +
Adds a card to the board immediately. +
addToClusters(Cluster) - +Method in class com.threerings.whirled.spot.data.SpotSceneObject +
Requests that the specified entry be added to the + clusters set. +
addToHostedZones(HostedZone) - +Method in class com.threerings.whirled.zone.peer.server.ZoneNodeObject +
Requests that the specified entry be added to the + hostedZones set. +
addToOccupantLocs(SceneLocation) - +Method in class com.threerings.whirled.spot.data.SpotSceneObject +
Requests that the specified entry be added to the + occupantLocs set. +
addToOccupants(int) - +Method in class com.threerings.whirled.spot.data.ClusterObject +
Requests that oid be added to the occupants + oid list. +
addToParticipants(Participant) - +Method in class com.threerings.parlor.tourney.data.TourneyObject +
Requests that the specified entry be added to the + participants set. +
addToSetStat(Stat.Type, T) - +Method in class com.threerings.stats.data.StatSet +
Adds a value to a SetStat. +
addToStats(Stat) - +Method in interface com.threerings.stats.data.StatSet.Container +
  +
addToTables(Table) - +Method in class com.threerings.micasa.lobby.table.TableLobbyObject +
  +
addToTables(Table) - +Method in interface com.threerings.parlor.data.TableLobbyObject +
Adds the supplied table instance to the tables set (using the + appropriate distributed object mechanisms). +
addToTableSet(Table) - +Method in class com.threerings.micasa.lobby.table.TableLobbyObject +
Requests that the specified entry be added to the + tableSet set. +
addUpdate(SceneUpdate) - +Method in class com.threerings.whirled.util.UpdateList +
Adds an update to this list. +
addWideControl(JComponent) - +Method in class com.threerings.parlor.game.client.SwingGameConfigurator +
Add a control to the interface. +
addZoneObserver(ZoneObserver) - +Method in class com.threerings.whirled.zone.client.ZoneDirector +
Adds a zone observer to the list. +
ais - +Variable in class com.threerings.parlor.game.data.GameConfig +
Configurations for AIs to be used in this game. +
allowAddObject(ObjectInfo) - +Method in class com.threerings.stage.util.PlacementConstraints +
Determines whether the constraints allow the specified object to be + added to the scene. +
allowModifyObjects(ObjectInfo[], ObjectInfo[]) - +Method in class com.threerings.stage.util.PlacementConstraints +
Determines whether the constraints allow the specified objects to be + added and removed simultaneously. +
allowRemoveObject(ObjectInfo) - +Method in class com.threerings.stage.util.PlacementConstraints +
Determines whether the constraints allow the specified object to be + removed from the scene. +
allPlayersReady() - +Method in class com.threerings.parlor.game.server.GameManager +
Returns true if all (non-AI) players have delivered their GameManager.playerReady(com.threerings.crowd.data.BodyObject) + notifications, false if they have not. +
ALREADY_AT_TABLE - +Static variable in interface com.threerings.parlor.data.ParlorCodes +
An error code returned by the table services when a user requests to create or join a table + but they're already sitting at another table. +
ALREADY_IN_PROGRESS - +Static variable in interface com.threerings.parlor.tourney.data.TourneyCodes +
The tourney is already in progress. +
ALREADY_IN_TOURNEY - +Static variable in interface com.threerings.parlor.tourney.data.TourneyCodes +
User already in a tourney. +
ANY_POSITION - +Static variable in class com.threerings.parlor.data.Table +
Used to request any position at a table. +
appendStat(Stat.Type, int) - +Method in class com.threerings.stats.data.StatSet +
Appends an integer value to an IntArrayStat. +
appendValue(int) - +Method in class com.threerings.stats.data.IntArrayStat +
Appends a value to this statistic. +
apply(SceneModel) - +Method in class com.threerings.stage.data.DefaultColorUpdate +
  +
apply(SceneModel) - +Method in class com.threerings.stage.data.ModifyObjectsUpdate +
  +
apply(SceneModel) - +Method in class com.threerings.whirled.data.SceneUpdate +
Applies this update to the specified scene model. +
apply(SceneModel) - +Method in class com.threerings.whirled.spot.data.ModifyPortalsUpdate +
  +
apply(ZoneNodeObject) - +Method in class com.threerings.whirled.zone.peer.server.ZonePeerManager.NodeFunc +
  +
apply(NodeObject) - +Method in class com.threerings.whirled.zone.peer.server.ZonePeerManager.NodeFunc +
  +
applyAndRecordUpdate(SceneModel, SceneUpdate) - +Method in class com.threerings.whirled.server.persist.DummySceneRepository +
  +
applyAndRecordUpdate(SceneModel, SceneUpdate) - +Method in interface com.threerings.whirled.server.persist.SceneRepository +
Applise the supplied scene update to persistent representation of its associated scene, then + stores the update persistently for future invocations of the server to load. +
applyOp(int, int, int, DropBoard.PieceOperation) - +Method in class com.threerings.puzzle.drop.data.DropBoard +
Applies a specified DropBoard.PieceOperation to all pieces in the specified row or column + starting at the specified coordinates and spanning the remainder of the row or column + (depending on the application direction) in the board. +
applyOp(int, int, int, int, DropBoard.PieceOperation) - +Method in class com.threerings.puzzle.drop.data.DropBoard +
Applies a specified DropBoard.PieceOperation to all pieces in a row or column segment + starting at the specified coordinates and of the specified length in the board. +
applyOp(int, int, DropBoard.PieceOperation) - +Method in class com.threerings.puzzle.drop.data.DropBoard +
Applies a specified DropBoard.PieceOperation to the specified piece in the board. +
applyRisingPieces(int[]) - +Method in class com.threerings.puzzle.drop.data.DropBoard +
Called by the DropControllerDelegate when it's time to apply a rising row of pieces + to the board. +
applyToListeners(SpeakObject.ListenerOp) - +Method in class com.threerings.whirled.spot.data.ClusterObject +
  +
attributeChanged(AttributeChangedEvent) - +Method in class com.threerings.parlor.game.client.GameController +
  +
attributeChanged(AttributeChangedEvent) - +Method in class com.threerings.parlor.game.server.GameWatcher +
  +
attributeChanged(AttributeChangedEvent) - +Method in class com.threerings.parlor.turn.client.TurnDisplay +
  +
attributeChanged(AttributeChangedEvent) - +Method in class com.threerings.parlor.turn.client.TurnGameControllerDelegate +
  +
attributeChanged(AttributeChangedEvent) - +Method in class com.threerings.puzzle.client.PuzzleController +
  +
attributeChanged(AttributeChangedEvent) - +Method in class com.threerings.whirled.spot.client.SpotSceneDirector +
  +
AuxModel - Interface in com.threerings.whirled.data
An interface that must be implemented by auxiliary scene models.
auxModels - +Variable in class com.threerings.whirled.data.SceneModel +
Auxiliary scene model information. +
+
+

+B

+
+
BANNED_FROM_TABLE - +Static variable in interface com.threerings.parlor.data.ParlorCodes +
An error code returned by the table services for a request to join a table that the + requester been banned from. +
BASE_LAYER - +Static variable in class com.threerings.stage.tools.editor.EditorModel +
Miso layer constants. +
BETWEEN_HANDS - +Static variable in interface com.threerings.parlor.card.trick.data.TrickCardGameObject +
The state that indicates the game is currently between hands. +
BLACK_JOKER - +Static variable in interface com.threerings.parlor.card.data.CardCodes +
The number of the black joker. +
blankSceneModel() - +Static method in class com.threerings.whirled.data.SceneModel +
Creates and returns a blank scene model. +
blankStageSceneModel() - +Static method in class com.threerings.stage.data.StageSceneModel +
Creates and returns a blank scene model. +
Board - Class in com.threerings.puzzle.data
An abstract base class for generating and storing puzzle board data.
Board() - +Constructor for class com.threerings.puzzle.data.Board +
  +
boardAlwaysFilled() - +Method in interface com.threerings.puzzle.drop.util.PieceDropLogic +
Should the board always be filled? +
BoardSummary - Class in com.threerings.puzzle.data
Provides summarized data representing a player's board in a puzzle game.
BoardSummary() - +Constructor for class com.threerings.puzzle.data.BoardSummary +
Constructs an empty board summary for use when un-serializing. +
BoardSummary(Board) - +Constructor for class com.threerings.puzzle.data.BoardSummary +
Constructs a board summary that retrieves full board information from the supplied board + when summarizing. +
bodyDidEnterZone(BodyObject, int) - +Method in interface com.threerings.whirled.zone.server.ZoneManager +
Called when a body has been granted access to a zone. +
bodyEntered(int) - +Method in class com.threerings.parlor.rating.server.RatingDelegate +
  +
bodyLeft(int) - +Method in class com.threerings.parlor.rating.server.RatingDelegate +
  +
bodyOid - +Variable in class com.threerings.whirled.spot.data.SceneLocation +
The oid of the body that occupies this location. +
bodyOids - +Variable in class com.threerings.parlor.data.Table +
The body oids of the players of this table, or null if a party game. +
BOOT_PLAYER - +Static variable in class com.threerings.parlor.data.TableMarshaller +
The method id used to dispatch TableMarshaller.bootPlayer(int, com.threerings.util.Name, com.threerings.presents.client.InvocationService.InvocationListener) requests. +
bootPlayer(int, Name) - +Method in class com.threerings.parlor.client.TableDirector +
Sends a request to boot a player from a table. +
bootPlayer(int, Name, InvocationService.InvocationListener) - +Method in interface com.threerings.parlor.client.TableService +
Requests that another user be booted from the specified table. +
bootPlayer(int, Name, InvocationService.InvocationListener) - +Method in class com.threerings.parlor.data.TableMarshaller +
  +
bootPlayer(ClientObject, int, Name, InvocationService.InvocationListener) - +Method in class com.threerings.parlor.server.TableManager +
  +
bootPlayer(ClientObject, int, Name, InvocationService.InvocationListener) - +Method in interface com.threerings.parlor.server.TableProvider +
Handles a TableService.bootPlayer(int, com.threerings.util.Name, com.threerings.presents.client.InvocationService.InvocationListener) request. +
BOTTOM - +Static variable in interface com.threerings.parlor.card.trick.data.TrickCardCodes +
For four-player games, the bottom (own) player. +
ByteByteStringMapStat - Class in com.threerings.stats.data
Maps up to 127 string values to integers in the range 0 - 127.
ByteByteStringMapStat() - +Constructor for class com.threerings.stats.data.ByteByteStringMapStat +
  +
ByteStringSetStat - Class in com.threerings.stats.data
A string set that maps its values to bytes.
ByteStringSetStat() - +Constructor for class com.threerings.stats.data.ByteStringSetStat +
  +
+
+

+C

+
+
cancel() - +Method in class com.threerings.parlor.client.Invitation +
Cancels this invitation. +
cancel(int, InvocationService.InvocationListener) - +Method in interface com.threerings.parlor.client.ParlorService +
You probably don't want to call this directly, but want to call Invitation.cancel(). +
CANCEL - +Static variable in class com.threerings.parlor.data.ParlorMarshaller +
The method id used to dispatch ParlorMarshaller.cancel(int, com.threerings.presents.client.InvocationService.InvocationListener) requests. +
cancel(int, InvocationService.InvocationListener) - +Method in class com.threerings.parlor.data.ParlorMarshaller +
  +
cancel(ClientObject, int, InvocationService.InvocationListener) - +Method in class com.threerings.parlor.server.ParlorManager +
  +
cancel(ClientObject, int, InvocationService.InvocationListener) - +Method in interface com.threerings.parlor.server.ParlorProvider +
Handles a ParlorService.cancel(int, com.threerings.presents.client.InvocationService.InvocationListener) request. +
cancel(InvocationService.ConfirmListener) - +Method in interface com.threerings.parlor.tourney.client.TourneyService +
Handles a request to cancel the tourney. +
CANCEL - +Static variable in class com.threerings.parlor.tourney.data.TourneyMarshaller +
The method id used to dispatch TourneyMarshaller.cancel(com.threerings.presents.client.InvocationService.ConfirmListener) requests. +
cancel(InvocationService.ConfirmListener) - +Method in class com.threerings.parlor.tourney.data.TourneyMarshaller +
  +
cancel(ClientObject, InvocationService.ConfirmListener) - +Method in class com.threerings.parlor.tourney.server.TourneyManager +
  +
cancel(ClientObject, InvocationService.ConfirmListener) - +Method in interface com.threerings.parlor.tourney.server.TourneyProvider +
Handles a TourneyService.cancel(com.threerings.presents.client.InvocationService.ConfirmListener) request. +
cancelGame() - +Method in class com.threerings.parlor.game.server.GameManager +
Sets the state of the game to GameObject.CANCELLED. +
cancelInvite(BodyObject, int) - +Method in class com.threerings.parlor.server.ParlorManager +
Requests that an outstanding invitation be cancelled. +
CANCELLED - +Static variable in class com.threerings.parlor.game.data.GameObject +
A game state constant indicating that the game was cancelled. +
CANCELLED - +Static variable in interface com.threerings.parlor.tourney.data.TourneyCodes +
The tournament was canceled. +
CANCELLED - +Static variable in class com.threerings.parlor.tourney.data.TourneyObject +
Tourney has been cancelled. +
cancelled() - +Method in class com.threerings.stage.tools.editor.EditorDialog +
Called when cancel is clicked. +
cancelled() - +Method in class com.threerings.stage.tools.editor.ObjectEditorDialog +
  +
cancelMoveRequest() - +Method in class com.threerings.whirled.client.SceneDirector +
  +
cancelTourney(String) - +Method in class com.threerings.parlor.tourney.server.TourneyManager +
Cancel the tourney, return entry fees to all participants. +
canFollowSuit(PlayerCard[], Hand) - +Static method in class com.threerings.parlor.card.trick.util.TrickCardGameUtil +
Checks whether the player can follow the suit lead with the hand given. +
canPopup() - +Method in class com.threerings.puzzle.drop.client.DropBlockSprite +
Can this sprite pop-up a row on a forgiving rotation? +
Card - Class in com.threerings.parlor.card.data
Instances of this class represent individual playing cards.
Card() - +Constructor for class com.threerings.parlor.card.data.Card +
No-arg constructor for deserialization. +
Card(int, int) - +Constructor for class com.threerings.parlor.card.data.Card +
Creates a new card. +
card - +Variable in class com.threerings.parlor.card.data.PlayerCard +
The card that the player played. +
CardCodes - Interface in com.threerings.parlor.card.data
Constants relating to the card services.
CardGameController - Class in com.threerings.parlor.card.client
A controller class for card games.
CardGameController() - +Constructor for class com.threerings.parlor.card.client.CardGameController +
  +
CardGameDecoder - Class in com.threerings.parlor.card.client
Dispatches calls to a CardGameReceiver instance.
CardGameDecoder(CardGameReceiver) - +Constructor for class com.threerings.parlor.card.client.CardGameDecoder +
Creates a decoder that may be registered to dispatch invocation + service notifications to the specified receiver. +
CardGameManager - Class in com.threerings.parlor.card.server
A manager class for card games.
CardGameManager() - +Constructor for class com.threerings.parlor.card.server.CardGameManager +
  +
CardGameObject - Class in com.threerings.parlor.card.data
Game object class for card games.
CardGameObject() - +Constructor for class com.threerings.parlor.card.data.CardGameObject +
  +
CardGameReceiver - Interface in com.threerings.parlor.card.client
Defines, for the card game services, a set of notifications delivered + asynchronously by the server to the client.
CardGameSender - Class in com.threerings.parlor.card.server
Used to issue notifications to a CardGameReceiver instance on a + client.
CardGameSender() - +Constructor for class com.threerings.parlor.card.server.CardGameSender +
  +
CardPanel - Class in com.threerings.parlor.card.client
Extends VirtualMediaPanel to provide services specific to rendering and manipulating playing + cards.
CardPanel(FrameManager) - +Constructor for class com.threerings.parlor.card.client.CardPanel +
Constructor. +
CardPanel.CardSelectionObserver - Interface in com.threerings.parlor.card.client
A listener for card selection/deselection.
CARDS_TRANSFERRED_BETWEEN_PLAYERS - +Static variable in class com.threerings.parlor.card.client.CardGameDecoder +
The method id used to dispatch CardGameReceiver.cardsTransferredBetweenPlayers(int, int, int) + notifications. +
CardSprite - Class in com.threerings.parlor.card.client
A sprite representing a playing card.
CardSprite(CardPanel, Card) - +Constructor for class com.threerings.parlor.card.client.CardSprite +
Creates a new upward-facing card sprite. +
CardSprite(CardPanel, Card, boolean) - +Constructor for class com.threerings.parlor.card.client.CardSprite +
Creates a new card sprite. +
cardSpriteClicked(CardSprite, MouseEvent) - +Method in interface com.threerings.parlor.card.client.CardSpriteObserver +
Notifies the observer that the user clicked a card sprite. +
cardSpriteDeselected(CardSprite) - +Method in interface com.threerings.parlor.card.client.CardPanel.CardSelectionObserver +
Called when a card has been deselected. +
cardSpriteDragged(CardSprite, MouseEvent) - +Method in interface com.threerings.parlor.card.client.CardSpriteObserver +
Notifies the observer that the user dragged a card sprite to a new + location. +
cardSpriteEntered(CardSprite, MouseEvent) - +Method in interface com.threerings.parlor.card.client.CardSpriteObserver +
Notifies the observer that the user moved the mouse pointer onto + a card sprite. +
cardSpriteExited(CardSprite, MouseEvent) - +Method in interface com.threerings.parlor.card.client.CardSpriteObserver +
Notifies the observer that the user moved the mouse pointer off of + a card sprite. +
CardSpriteObserver - Interface in com.threerings.parlor.card.client
Observer interface for (draggable) card sprites.
cardSpriteSelected(CardSprite) - +Method in interface com.threerings.parlor.card.client.CardPanel.CardSelectionObserver +
Called when a card has been selected. +
cardsTransferredBetweenPlayers(int, int, int) - +Method in class com.threerings.parlor.card.client.CardGameController +
Dispatched to the client when a set of cards is transferred between two other players in + the game. +
cardsTransferredBetweenPlayers(int, int, int) - +Method in interface com.threerings.parlor.card.client.CardGameReceiver +
Dispatched to the client when a set of cards is transferred between + two other players in the game. +
cardsTransferredBetweenPlayers(ClientObject, int, int, int) - +Static method in class com.threerings.parlor.card.server.CardGameSender +
Issues a notification that will result in a call to CardGameReceiver.cardsTransferredBetweenPlayers(int, int, int) on a client. +
CARE_NOT - +Static variable in interface com.threerings.puzzle.client.PuzzleController.ClearPender +
PuzzleController.ClearPender.actionCleared() return code. +
center(JFrame, JInternalFrame) - +Static method in class com.threerings.stage.tools.editor.util.EditorDialogUtil +
Centers the supplied dialog in its parent's bounds. +
CHAIN_COLOR - +Static variable in class com.threerings.puzzle.drop.client.DropBoardView +
The color used to render chain reward scoring text. +
CHANGE_LOCATION - +Static variable in class com.threerings.whirled.spot.data.SpotMarshaller +
The method id used to dispatch SpotMarshaller.changeLocation(int, com.threerings.whirled.spot.data.Location, com.threerings.presents.client.InvocationService.ConfirmListener) requests. +
changeLocation(Location, ResultListener<Location>) - +Method in class com.threerings.whirled.spot.client.SpotSceneDirector +
Issues a request to change our location within the scene to the specified location. +
changeLocation(int, Location, InvocationService.ConfirmListener) - +Method in interface com.threerings.whirled.spot.client.SpotService +
Requests that this client's body be made to move to the specified + location. +
changeLocation(int, Location, InvocationService.ConfirmListener) - +Method in class com.threerings.whirled.spot.data.SpotMarshaller +
  +
changeLocation(ClientObject, int, Location, InvocationService.ConfirmListener) - +Method in interface com.threerings.whirled.spot.server.SpotProvider +
Handles a SpotService.changeLocation(int, com.threerings.whirled.spot.data.Location, com.threerings.presents.client.InvocationService.ConfirmListener) request. +
changeLocation(ClientObject, int, Location, InvocationService.ConfirmListener) - +Method in class com.threerings.whirled.spot.server.SpotSceneRegistry +
  +
ChatPanel - Class in com.threerings.micasa.client
 
ChatPanel(CrowdContext) - +Constructor for class com.threerings.micasa.client.ChatPanel +
  +
ChatPanel(CrowdContext, boolean) - +Constructor for class com.threerings.micasa.client.ChatPanel +
  +
checkpoint(String, int) - +Method in class com.threerings.stage.tools.viewer.ViewerScenePanel +
  +
checkWritePermission(ClientObject, int) - +Method in class com.threerings.parlor.game.server.GameManager +
  +
checkWritePermission(ClientObject, int) - +Method in interface com.threerings.parlor.server.PlayManager +
Make sure that the given caller is a player or an agent and can write to the data + of the given playerId. +
ChoiceParameter - Class in com.threerings.parlor.data
Models a parameter that allows the selection of one of a list of choices (specified as strings).
ChoiceParameter() - +Constructor for class com.threerings.parlor.data.ChoiceParameter +
  +
choices - +Variable in class com.threerings.parlor.data.ChoiceParameter +
The set of choices available for this parameter. +
classId - +Variable in class com.threerings.stage.data.DefaultColorUpdate +
The class id of the colorization we're changing. +
clear() - +Method in class com.threerings.micasa.client.ChatPanel +
  +
clear() - +Method in class com.threerings.puzzle.util.PointSet +
Clears all points from this set. +
CLEAR_OP - +Static variable in class com.threerings.puzzle.drop.data.DropBoard +
An operation that does naught but clear pieces, which proves to be generally useful. +
clearAction() - +Method in class com.threerings.puzzle.client.PuzzlePanel +
Called by the controller when the action stops. +
clearAnimations() - +Method in class com.threerings.puzzle.client.PuzzleBoardView +
  +
clearBoard() - +Method in class com.threerings.parlor.card.client.CardPanel +
Clears all cards from the board. +
clearEnteringBody(BodyObject) - +Method in class com.threerings.whirled.spot.server.SpotSceneManager +
Called if a body failed to enter our scene after we assigned them an entering position. +
clearHand() - +Method in class com.threerings.parlor.card.client.CardPanel +
Clears all cards from the hand. +
clearHandSelection() - +Method in class com.threerings.parlor.card.client.CardPanel +
Clears any existing hand sprite selection. +
clearMapping(Stat.Type, String) - +Method in class com.threerings.stats.server.persist.StatRepository +
This is only used for testing. +
clearModified() - +Method in class com.threerings.parlor.rating.util.Percentiler +
Clears this percentiler's "is modified" state. +
clearPiece(int, int) - +Method in class com.threerings.puzzle.drop.client.DropBoardView +
Clears out a piece from the board along with its piece sprite. +
clearPieceSprite(int, int) - +Method in class com.threerings.puzzle.drop.client.DropBoardView +
Clears the specified piece from the board. +
clearPlayer(Name) - +Method in class com.threerings.parlor.data.Table +
Requests that the specified user be removed from their seat at this table. +
clearPlayerByOid(int) - +Method in class com.threerings.parlor.data.Table +
Requests that the user identified by the specified body object id be removed from their seat + at this table. +
clearPlayerPos(int) - +Method in class com.threerings.parlor.data.Table +
Called to clear a player at the specified position. +
clearSprites() - +Method in class com.threerings.puzzle.client.PuzzleBoardView +
  +
clearTableObject() - +Method in class com.threerings.parlor.client.TableDirector +
This must be called by the entity that uses the table director when the using entity has + left and is done dealing with tables. +
clearTestTileSets() - +Method in class com.threerings.stage.tools.editor.EditorTileManager +
Clear all of our existing test tile sets. +
clearTile() - +Method in class com.threerings.stage.tools.editor.EditorModel +
Marks the currently selected tile as invalid such that editing + when no tiles are available can be properly effected. +
clearTileSelectRegion(int, int) - +Method in class com.threerings.stage.tools.editor.EditorScenePanel +
Clear and return the drag rectangle for selecting a rectangular + region. +
clientConnectionFailed(Client, Exception) - +Method in class com.threerings.micasa.client.LogonPanel +
  +
ClientController - Class in com.threerings.micasa.client
Responsible for top-level control of the client user interface.
ClientController(MiCasaContext, MiCasaFrame) - +Constructor for class com.threerings.micasa.client.ClientController +
Creates a new client controller. +
clientDidClear(Client) - +Method in class com.threerings.micasa.client.LogonPanel +
  +
clientDidLogoff(Client) - +Method in class com.threerings.micasa.client.ClientController +
  +
clientDidLogoff(Client) - +Method in class com.threerings.micasa.client.LogonPanel +
  +
clientDidLogoff(Client) - +Method in class com.threerings.micasa.simulator.client.SimulatorController +
  +
clientDidLogoff(Client) - +Method in class com.threerings.parlor.client.ParlorDirector +
  +
clientDidLogoff(Client) - +Method in class com.threerings.parlor.client.TableDirector +
  +
clientDidLogoff(Client) - +Method in class com.threerings.whirled.client.SceneDirector +
  +
clientDidLogoff(Client) - +Method in class com.threerings.whirled.spot.client.SpotSceneDirector +
  +
clientDidLogoff(Client) - +Method in class com.threerings.whirled.zone.client.ZoneDirector +
  +
clientDidLogon(Client) - +Method in class com.threerings.micasa.client.ClientController +
  +
clientDidLogon(Client) - +Method in class com.threerings.micasa.client.LogonPanel +
  +
clientDidLogon(Client) - +Method in class com.threerings.micasa.simulator.client.SimulatorController +
  +
clientDidLogon(Client) - +Method in class com.threerings.whirled.spot.client.SpotSceneDirector +
  +
clientFailedToLogon(Client, Exception) - +Method in class com.threerings.micasa.client.LogonPanel +
  +
clientObjectDidChange(Client) - +Method in class com.threerings.micasa.client.ClientController +
  +
clientObjectDidChange(Client) - +Method in class com.threerings.micasa.client.LogonPanel +
  +
clientObjectDidChange(Client) - +Method in class com.threerings.micasa.simulator.client.SimulatorController +
  +
clientObjectDidChange(Client) - +Method in class com.threerings.whirled.spot.client.SpotSceneDirector +
  +
clientWillLogoff(Client) - +Method in class com.threerings.micasa.client.LogonPanel +
  +
clientWillLogon(Client) - +Method in class com.threerings.micasa.client.ClientController +
  +
clientWillLogon(Client) - +Method in class com.threerings.micasa.client.LogonPanel +
  +
clientWillLogon(Client) - +Method in class com.threerings.micasa.simulator.client.SimulatorController +
  +
clone() - +Method in class com.threerings.parlor.game.data.GameConfig +
  +
clone() - +Method in class com.threerings.puzzle.data.Board +
  +
clone() - +Method in class com.threerings.puzzle.drop.data.DropBoard +
  +
clone() - +Method in class com.threerings.stage.data.StageLocation +
  +
clone() - +Method in class com.threerings.stage.data.StageMisoSceneModel +
  +
clone() - +Method in class com.threerings.stage.data.StageScene +
  +
clone() - +Method in class com.threerings.stats.data.Stat +
  +
clone() - +Method in interface com.threerings.whirled.data.AuxModel +
Creates a clone of this auxiliary model. +
clone() - +Method in class com.threerings.whirled.data.SceneModel +
  +
clone() - +Method in interface com.threerings.whirled.spot.data.Location +
Locations are cloneable. +
clone() - +Method in class com.threerings.whirled.spot.data.Portal +
  +
clone() - +Method in class com.threerings.whirled.spot.data.SpotSceneModel +
  +
CLUBS - +Static variable in interface com.threerings.parlor.card.data.CardCodes +
The suit of clubs. +
Cluster - Class in com.threerings.whirled.spot.data
Contains information on clusters.
Cluster() - +Constructor for class com.threerings.whirled.spot.data.Cluster +
  +
CLUSTER_CHAT_TYPE - +Static variable in interface com.threerings.whirled.spot.data.SpotCodes +
The chat type code with which we register our cluster auxiliary + chat objects. +
CLUSTER_CLICKED - +Static variable in class com.threerings.stage.client.StageScenePanel +
An action command generated when a cluster is clicked. +
CLUSTER_FULL - +Static variable in interface com.threerings.whirled.spot.data.SpotCodes +
An error code indicating that a cluster is full. +
CLUSTER_SPEAK - +Static variable in class com.threerings.whirled.spot.data.SpotMarshaller +
The method id used to dispatch SpotMarshaller.clusterSpeak(java.lang.String, byte) requests. +
ClusteredBodyObject - Interface in com.threerings.whirled.spot.data
Defines some required methods for a BodyObject that is to participate in the Whirled + Spot system.
ClusterObject - Class in com.threerings.whirled.spot.data
Used to dispatch chat in clusters.
ClusterObject() - +Constructor for class com.threerings.whirled.spot.data.ClusterObject +
  +
clusterOid - +Variable in class com.threerings.whirled.spot.data.Cluster +
A unique identifier for this cluster (also the distributed object + id of the cluster chat object). +
CLUSTERS - +Static variable in class com.threerings.whirled.spot.data.SpotSceneObject +
The field name of the clusters field. +
clusters - +Variable in class com.threerings.whirled.spot.data.SpotSceneObject +
Contains information on all Clusters in this scene. +
clusterSpeak(String, byte) - +Method in interface com.threerings.whirled.spot.client.SpotService +
Requests that the supplied message be delivered to listeners in the + cluster to which the specified location belongs. +
clusterSpeak(String, byte) - +Method in class com.threerings.whirled.spot.data.SpotMarshaller +
  +
clusterSpeak(ClientObject, String, byte) - +Method in interface com.threerings.whirled.spot.server.SpotProvider +
Handles a SpotService.clusterSpeak(java.lang.String, byte) request. +
clusterSpeak(ClientObject, String, byte) - +Method in class com.threerings.whirled.spot.server.SpotSceneRegistry +
  +
CMD_ACTIONS - +Static variable in class com.threerings.stage.tools.editor.EditorModel +
String translations for action identifiers. +
code() - +Method in interface com.threerings.stats.data.Stat.Type +
Returns the unique code for this stat which is a function of its name. +
CODE - +Static variable in class com.threerings.stats.server.persist.StringCodeRecord +
  +
code - +Variable in class com.threerings.stats.server.persist.StringCodeRecord +
  +
col - +Variable in class com.threerings.puzzle.drop.util.PieceDropper.PieceDropInfo +
The column number. +
colorId - +Variable in class com.threerings.stage.data.DefaultColorUpdate +
The color id to set as the new default, or -1 to remove the default. +
columns - +Variable in class com.threerings.puzzle.drop.data.DropBoardSummary +
The row levels for each column. +
com.threerings.micasa - package com.threerings.micasa
 
com.threerings.micasa.client - package com.threerings.micasa.client
 
com.threerings.micasa.data - package com.threerings.micasa.data
 
com.threerings.micasa.lobby - package com.threerings.micasa.lobby
 
com.threerings.micasa.lobby.table - package com.threerings.micasa.lobby.table
 
com.threerings.micasa.server - package com.threerings.micasa.server
 
com.threerings.micasa.simulator.client - package com.threerings.micasa.simulator.client
 
com.threerings.micasa.simulator.data - package com.threerings.micasa.simulator.data
 
com.threerings.micasa.simulator.server - package com.threerings.micasa.simulator.server
 
com.threerings.micasa.simulator.util - package com.threerings.micasa.simulator.util
 
com.threerings.micasa.util - package com.threerings.micasa.util
 
com.threerings.parlor - package com.threerings.parlor
 
com.threerings.parlor.card - package com.threerings.parlor.card
 
com.threerings.parlor.card.client - package com.threerings.parlor.card.client
 
com.threerings.parlor.card.data - package com.threerings.parlor.card.data
 
com.threerings.parlor.card.server - package com.threerings.parlor.card.server
 
com.threerings.parlor.card.trick.client - package com.threerings.parlor.card.trick.client
 
com.threerings.parlor.card.trick.data - package com.threerings.parlor.card.trick.data
 
com.threerings.parlor.card.trick.server - package com.threerings.parlor.card.trick.server
 
com.threerings.parlor.card.trick.util - package com.threerings.parlor.card.trick.util
 
com.threerings.parlor.client - package com.threerings.parlor.client
 
com.threerings.parlor.data - package com.threerings.parlor.data
 
com.threerings.parlor.game.client - package com.threerings.parlor.game.client
 
com.threerings.parlor.game.data - package com.threerings.parlor.game.data
 
com.threerings.parlor.game.server - package com.threerings.parlor.game.server
 
com.threerings.parlor.media - package com.threerings.parlor.media
 
com.threerings.parlor.rating.data - package com.threerings.parlor.rating.data
 
com.threerings.parlor.rating.server - package com.threerings.parlor.rating.server
 
com.threerings.parlor.rating.server.persist - package com.threerings.parlor.rating.server.persist
 
com.threerings.parlor.rating.util - package com.threerings.parlor.rating.util
 
com.threerings.parlor.server - package com.threerings.parlor.server
 
com.threerings.parlor.tourney.client - package com.threerings.parlor.tourney.client
 
com.threerings.parlor.tourney.data - package com.threerings.parlor.tourney.data
 
com.threerings.parlor.tourney.server - package com.threerings.parlor.tourney.server
 
com.threerings.parlor.tourney.server.persist - package com.threerings.parlor.tourney.server.persist
 
com.threerings.parlor.turn.client - package com.threerings.parlor.turn.client
 
com.threerings.parlor.turn.data - package com.threerings.parlor.turn.data
 
com.threerings.parlor.turn.server - package com.threerings.parlor.turn.server
 
com.threerings.parlor.util - package com.threerings.parlor.util
 
com.threerings.puzzle - package com.threerings.puzzle
 
com.threerings.puzzle.client - package com.threerings.puzzle.client
 
com.threerings.puzzle.data - package com.threerings.puzzle.data
 
com.threerings.puzzle.drop.client - package com.threerings.puzzle.drop.client
 
com.threerings.puzzle.drop.data - package com.threerings.puzzle.drop.data
 
com.threerings.puzzle.drop.server - package com.threerings.puzzle.drop.server
 
com.threerings.puzzle.drop.util - package com.threerings.puzzle.drop.util
 
com.threerings.puzzle.server - package com.threerings.puzzle.server
 
com.threerings.puzzle.util - package com.threerings.puzzle.util
 
com.threerings.stage - package com.threerings.stage
 
com.threerings.stage.client - package com.threerings.stage.client
 
com.threerings.stage.data - package com.threerings.stage.data
 
com.threerings.stage.server - package com.threerings.stage.server
 
com.threerings.stage.tools.editor - package com.threerings.stage.tools.editor
 
com.threerings.stage.tools.editor.util - package com.threerings.stage.tools.editor.util
 
com.threerings.stage.tools.viewer - package com.threerings.stage.tools.viewer
 
com.threerings.stage.tools.xml - package com.threerings.stage.tools.xml
 
com.threerings.stage.util - package com.threerings.stage.util
 
com.threerings.stats - package com.threerings.stats
 
com.threerings.stats.data - package com.threerings.stats.data
 
com.threerings.stats.server.persist - package com.threerings.stats.server.persist
 
com.threerings.whirled - package com.threerings.whirled
 
com.threerings.whirled.client - package com.threerings.whirled.client
 
com.threerings.whirled.client.persist - package com.threerings.whirled.client.persist
 
com.threerings.whirled.data - package com.threerings.whirled.data
 
com.threerings.whirled.server - package com.threerings.whirled.server
 
com.threerings.whirled.server.persist - package com.threerings.whirled.server.persist
 
com.threerings.whirled.spot - package com.threerings.whirled.spot
Extends the Whirled services with the notion of locations, clusters, + coordinates and orientation.
com.threerings.whirled.spot.client - package com.threerings.whirled.spot.client
 
com.threerings.whirled.spot.data - package com.threerings.whirled.spot.data
 
com.threerings.whirled.spot.server - package com.threerings.whirled.spot.server
 
com.threerings.whirled.spot.tools - package com.threerings.whirled.spot.tools
 
com.threerings.whirled.spot.tools.xml - package com.threerings.whirled.spot.tools.xml
 
com.threerings.whirled.tools.xml - package com.threerings.whirled.tools.xml
 
com.threerings.whirled.util - package com.threerings.whirled.util
 
com.threerings.whirled.zone - package com.threerings.whirled.zone
 
com.threerings.whirled.zone.client - package com.threerings.whirled.zone.client
 
com.threerings.whirled.zone.data - package com.threerings.whirled.zone.data
 
com.threerings.whirled.zone.peer.data - package com.threerings.whirled.zone.peer.data
 
com.threerings.whirled.zone.peer.server - package com.threerings.whirled.zone.peer.server
 
com.threerings.whirled.zone.server - package com.threerings.whirled.zone.server
 
com.threerings.whirled.zone.util - package com.threerings.whirled.zone.util
 
commit() - +Method in class com.threerings.stage.tools.editor.TestTileLoader +
Since we're just testing, we don't save these crazy IDs. +
compareTo(Card) - +Method in class com.threerings.parlor.card.data.Card +
Compares this card to another. +
compareTo(Participant) - +Method in class com.threerings.parlor.tourney.data.Participant +
  +
computeAdjustment(float, int, Rating) - +Static method in class com.threerings.parlor.rating.server.Rating +
Computes a ratings adjustment for the given player, using a modified + version of the FIDE Chess rating system as: +
computeRating(Rating[], int, float) - +Static method in class com.threerings.parlor.rating.server.Rating +
Computes a player's updated rating using a modified version of the + FIDE/ELO system. +
config - +Static variable in class com.threerings.micasa.server.MiCasaConfig +
Provides access to configuration data for this package. +
config - +Variable in class com.threerings.parlor.client.Invitation +
The configuration of the game to be created. +
config - +Variable in class com.threerings.parlor.data.Table +
The game config for the game that is being matchmade. +
CONFIG - +Static variable in class com.threerings.parlor.tourney.data.TourneyObject +
The field name of the config field. +
config - +Variable in class com.threerings.parlor.tourney.data.TourneyObject +
The tourney configuration. +
config - +Variable in class com.threerings.parlor.tourney.server.persist.TourneyRepository.TourneyRecord +
The tourney configuration. +
config - +Static variable in class com.threerings.puzzle.client.PuzzlePrefs +
Used to load our preferences from a properties file and map them to the persistent Java + preferences repository. +
config - +Static variable in class com.threerings.stage.tools.editor.EditorConfig +
Provides access to config data for this package. +
contains(int, int) - +Method in class com.threerings.puzzle.util.PointSet +
Returns whether this set contains the given point. +
contains(Integer) - +Method in class com.threerings.stats.data.IntSetStat +
Returns true if the specified int is contained in this set. +
contains(T) - +Method in class com.threerings.stats.data.SetStat +
Returns true if the specified object is contained in this set. +
contains(String) - +Method in class com.threerings.stats.data.StringSetStat +
Returns true if the specified string is contained in this set. +
containsAll(Card[]) - +Method in class com.threerings.parlor.card.data.Hand +
Checks whether this hand contains all of the specified cards. +
containsCard(PlayerCard[], Card) - +Static method in class com.threerings.parlor.card.trick.util.TrickCardGameUtil +
Checks whether the specified array contains the given card. +
containsKey(String) - +Method in class com.threerings.stats.data.StringMapStat +
Returns true if the specified key is contained in this map. +
containsPlayer(Name) - +Method in class com.threerings.parlor.data.Table +
Returns true if this table contains the specified player. +
containsValue(Stat.Type, T) - +Method in class com.threerings.stats.data.StatSet +
Returns true if the specified SetStat contains the specified value, false + otherwise. +
coordsToLocation(int, int, Point) - +Static method in class com.threerings.stage.util.StageSceneUtil +
Converts Cartesian coordinates back to full coordinates. +
copyInto(DropBoard) - +Method in class com.threerings.puzzle.drop.data.DropBoard +
Copies the contents of this board directly into the supplied board, overwriting the + destination board in its entirety. +
counter(GameConfig, InvitationResponseObserver) - +Method in class com.threerings.parlor.client.Invitation +
Counters this invitation with an invitation with different game + configuration parameters. +
countSuitMembers(PlayerCard[], int) - +Static method in class com.threerings.parlor.card.trick.util.TrickCardGameUtil +
Determines the number of cards that belong to the specified suit within the array given. +
CREATE_GAME - +Static variable in class com.threerings.micasa.simulator.data.SimulatorMarshaller +
The method id used to dispatch SimulatorMarshaller.createGame(com.threerings.parlor.game.data.GameConfig, java.lang.String, int) requests. +
CREATE_TABLE - +Static variable in class com.threerings.parlor.data.TableMarshaller +
The method id used to dispatch TableMarshaller.createTable(com.threerings.parlor.data.TableConfig, com.threerings.parlor.game.data.GameConfig, com.threerings.presents.client.InvocationService.ResultListener) requests. +
CREATE_TOURNEY - +Static variable in class com.threerings.parlor.tourney.data.TourniesMarshaller +
The method id used to dispatch TourniesMarshaller.createTourney(com.threerings.parlor.tourney.data.TourneyConfig, com.threerings.presents.client.InvocationService.ResultListener) requests. +
createConfigurator() - +Method in class com.threerings.parlor.game.data.GameConfig +
Creates a configurator that can be used to create a user interface for configuring this + instance prior to starting the game. +
createController() - +Method in class com.threerings.micasa.lobby.LobbyConfig +
  +
createController() - +Method in class com.threerings.stage.data.StageSceneConfig +
  +
createDecoys() - +Method in class com.threerings.stage.tools.viewer.ViewerScenePanel +
Creates the decoy sprites. +
createGame(Client) - +Method in class com.threerings.micasa.simulator.client.SimulatorController +
  +
createGame(GameConfig, String, int) - +Method in interface com.threerings.micasa.simulator.client.SimulatorService +
Requests that a new game be created. +
createGame(GameConfig, String, int) - +Method in class com.threerings.micasa.simulator.data.SimulatorMarshaller +
  +
createGame(BodyObject, GameConfig, String, int) - +Method in class com.threerings.micasa.simulator.server.SimulatorManager +
Creates a game along with the specified number of simulant players and forcibly moves all + players into the game room. +
createGame(ClientObject, GameConfig, String, int) - +Method in class com.threerings.micasa.simulator.server.SimulatorProvider +
Processes a request from the client to create a new game. +
createLabel(String, Color, Font, MediaPanel) - +Static method in class com.threerings.parlor.media.ScoreAnimation +
Deprecated. This signature is retained for backwards compatibility. +
createLabel(String, Color, Font, Component) - +Static method in class com.threerings.parlor.media.ScoreAnimation +
Create and configure a Label suitable for a ScoreAnimation with all the most common options. +
createMatchMakingView(MiCasaContext) - +Method in class com.threerings.micasa.lobby.LobbyConfig +
Derived classes override this function and create the appropriate + matchmaking user interface component. +
createMatchMakingView(MiCasaContext) - +Method in class com.threerings.micasa.lobby.table.TableLobbyConfig +
  +
createMenuBar() - +Method in class com.threerings.stage.tools.editor.EditorFrame +
Create the menu bar and menu items and add them to the frame. +
createPiece(int, int, int) - +Method in class com.threerings.puzzle.drop.client.DropBoardView +
Creates a new piece sprite and places it directly in its correct position. +
createPiece(int, int, int, int, int, long) - +Method in class com.threerings.puzzle.drop.client.DropBoardView +
Creates a new piece sprite and moves it into position on the board. +
createPieces(int, int, int[], int) - +Method in class com.threerings.puzzle.drop.client.DropBoardView +
Creates a new drop sprite used to animate the given pieces falling in the specified column. +
createPlaceConfig(SceneModel) - +Method in interface com.threerings.whirled.server.SceneRegistry.ConfigFactory +
Creates the place config instance appropriate to the specified scene. +
createScene(SceneModel, PlaceConfig) - +Method in interface com.threerings.whirled.util.SceneFactory +
Creates a Scene implementation given the supplied scene + model and place config. +
createScoreAnimation(String, Color, Font, int, int) - +Method in class com.threerings.puzzle.client.PuzzleBoardView +
Creates and returns an animation displaying the given string with the specified parameters, + floating it a short distance up the view. +
createScoreAnimation(String, Color, Font) - +Method in class com.threerings.puzzle.drop.client.DropBoardView +
Creates and returns an animation showing the specified score floating up the view, with the + label initially centered within the view. +
createScoreAnimation(String, Color, Font, int, int, int, int) - +Method in class com.threerings.puzzle.drop.client.DropBoardView +
Creates and returns an animation showing the specified score floating up the view. +
createTable(TableConfig, GameConfig) - +Method in class com.threerings.parlor.client.TableDirector +
Sends a request to create a table with the specified game configuration. +
createTable(TableConfig, GameConfig, InvocationService.ResultListener) - +Method in interface com.threerings.parlor.client.TableService +
Requests that a new table be created. +
createTable(TableConfig, GameConfig, InvocationService.ResultListener) - +Method in class com.threerings.parlor.data.TableMarshaller +
  +
createTable(BodyObject, TableConfig, GameConfig) - +Method in class com.threerings.parlor.server.TableManager +
Creates a table for the specified creator and returns said table. +
createTable(ClientObject, TableConfig, GameConfig, InvocationService.ResultListener) - +Method in class com.threerings.parlor.server.TableManager +
  +
createTable(ClientObject, TableConfig, GameConfig, InvocationService.ResultListener) - +Method in interface com.threerings.parlor.server.TableProvider +
Handles a TableService.createTable(com.threerings.parlor.data.TableConfig, com.threerings.parlor.game.data.GameConfig, com.threerings.presents.client.InvocationService.ResultListener) request. +
createTableConfigurator() - +Method in class com.threerings.parlor.game.data.GameConfig +
Creates a table configurator for initializing 'table' properties of the game. +
createTourney(TourneyConfig, InvocationService.ResultListener) - +Method in interface com.threerings.parlor.tourney.client.TourniesService +
Creates a new tourney. +
createTourney(TourneyConfig, InvocationService.ResultListener) - +Method in class com.threerings.parlor.tourney.data.TourniesMarshaller +
  +
createTourney(ClientObject, TourneyConfig, InvocationService.ResultListener) - +Method in class com.threerings.parlor.tourney.server.TourniesManager +
  +
createTourney(ClientObject, TourneyConfig, InvocationService.ResultListener) - +Method in interface com.threerings.parlor.tourney.server.TourniesProvider +
Handles a TourniesService.createTourney(com.threerings.parlor.tourney.data.TourneyConfig, com.threerings.presents.client.InvocationService.ResultListener) request. +
creator - +Variable in class com.threerings.parlor.tourney.data.TourneyConfig +
The tourney creator. +
+
+

+D

+
+
DATA - +Static variable in class com.threerings.parlor.rating.server.persist.PercentileRecord +
  +
data - +Variable in class com.threerings.parlor.rating.server.persist.PercentileRecord +
The raw percentiler data. +
dealHand(int) - +Method in class com.threerings.parlor.card.data.Deck +
Deals a hand of cards from the deck. +
dealHand(Deck, int, int) - +Method in class com.threerings.parlor.card.server.CardGameManager +
Deals a hand of cards to the player at the specified index from the given Deck. +
dealHands(Deck, int) - +Method in class com.threerings.parlor.card.server.CardGameManager +
Deals a hand of cards to each player from the specified Deck. +
DEBUG_PUZZLE - +Static variable in interface com.threerings.puzzle.data.PuzzleCodes +
Whether to enable debug logging and assertions for puzzles. +
Deck - Class in com.threerings.parlor.card.data
Instances of this class represent decks of cards.
Deck() - +Constructor for class com.threerings.parlor.card.data.Deck +
Default constructor creates an unshuffled deck of cards without + jokers. +
Deck(boolean) - +Constructor for class com.threerings.parlor.card.data.Deck +
Constructor. +
decodeUpdate(int, int, int, byte[]) - +Method in class com.threerings.whirled.server.persist.SceneUpdateMarshaller +
Instantiates the appropriate update class and decodes the update from the data. +
DEFAULT_DIFFICULTY - +Static variable in interface com.threerings.puzzle.data.PuzzleCodes +
The default puzzle difficulty level. +
DEFAULT_RATING - +Static variable in interface com.threerings.parlor.rating.data.RatingCodes +
The default rating value. +
defaultColors - +Variable in class com.threerings.stage.data.StageSceneModel +
If non-null, contains default colorizations to use for objects + that do not have colorizations defined. +
DefaultColorUpdate - Class in com.threerings.stage.data
Update to change the default colorization for objects in a scene which + do not define their own colorization.
DefaultColorUpdate() - +Constructor for class com.threerings.stage.data.DefaultColorUpdate +
  +
defaultEntranceId - +Variable in class com.threerings.whirled.spot.data.SpotSceneModel +
The portal id of the default entrance to this scene. +
DefaultSceneConfig - Class in com.threerings.whirled.data
The default scene config simply causes the default scene manager and + controller to be created.
DefaultSceneConfig() - +Constructor for class com.threerings.whirled.data.DefaultSceneConfig +
  +
DefaultSwingTableConfigurator - Class in com.threerings.parlor.client
Provides a default implementation of a TableConfigurator for + a Swing interface.
DefaultSwingTableConfigurator(int) - +Constructor for class com.threerings.parlor.client.DefaultSwingTableConfigurator +
Create a TableConfigurator that allows only the specified number + of players and lets the configuring user enable private games + only if the number of players is greater than 2. +
DefaultSwingTableConfigurator(int, boolean) - +Constructor for class com.threerings.parlor.client.DefaultSwingTableConfigurator +
Create a TableConfigurator that allows only the specified number + of players and lets the user configure a private table, or not. +
DefaultSwingTableConfigurator(int, int, int, boolean) - +Constructor for class com.threerings.parlor.client.DefaultSwingTableConfigurator +
Create a TableConfigurator that allows for the specified configuration + parameters. +
defLobbyOid - +Variable in class com.threerings.micasa.data.MiCasaBootstrapData +
The oid of the default lobby. +
deleteObject(SceneObject) - +Method in class com.threerings.stage.tools.editor.EditorScenePanel +
Deletes the object tile at the specified tile coordinates. +
deleteObject(ObjectInfo) - +Method in class com.threerings.stage.tools.editor.EditorScenePanel +
Delete the given object from the scene. +
deletePercentile(int, int) - +Method in class com.threerings.parlor.rating.server.persist.RatingRepository +
Deletes the percentile record for the specified game and game mode. +
deletePortal(int, int) - +Method in class com.threerings.stage.tools.editor.EditorScenePanel +
Deletes the portal at the specified full coordinates. +
deleteRating(int, int) - +Method in class com.threerings.parlor.rating.server.persist.RatingRepository +
Deletes the specified rating record. +
deleteSceneModel(int) - +Method in interface com.threerings.whirled.client.persist.SceneRepository +
Deletes the specified scene model from the repository. +
deleteStats(int) - +Method in class com.threerings.stats.server.persist.StatRepository +
Deletes all stats associated with the specified player. +
deleteTourney(int) - +Method in class com.threerings.parlor.tourney.server.persist.TourneyRepository +
Deletes a tourney from the repository. +
deselectHandSprite(CardSprite) - +Method in class com.threerings.parlor.card.client.CardPanel +
Programmatically deselects a sprite in the hand. +
desiredPlayerCount - +Variable in class com.threerings.parlor.data.TableConfig +
The total number of players that are desired for the table. +
destroyPieces(DropBoard, DropBoard.PieceOperation) - +Method in class com.threerings.puzzle.drop.util.PieceDestroyer +
Destroys all pieces in the given board that are in contiguous rows or columns of pieces, + returning a list of SegmentInfo objects detailing the destroyed piece segments. +
DIAMONDS - +Static variable in interface com.threerings.parlor.card.data.CardCodes +
The suit of diamonds. +
didInit(PlaceConfig) - +Method in class com.threerings.parlor.card.trick.server.TrickCardGameManagerDelegate +
  +
didInit(PlaceConfig) - +Method in class com.threerings.parlor.rating.server.RatingDelegate +
  +
didInit(PlaceConfig) - +Method in class com.threerings.parlor.server.PlayManagerDelegate +
  +
didInit(PlaceConfig) - +Method in class com.threerings.parlor.turn.server.TurnGameManagerDelegate +
  +
didInit(PlaceConfig) - +Method in class com.threerings.puzzle.drop.server.DropManagerDelegate +
  +
didInit(PlaceConfig) - +Method in class com.threerings.puzzle.server.PuzzleManagerDelegate +
  +
didLeavePlace(PlaceObject) - +Method in class com.threerings.micasa.client.ChatPanel +
  +
didLeavePlace(PlaceObject) - +Method in class com.threerings.micasa.client.OccupantList +
  +
didLeavePlace(PlaceObject) - +Method in class com.threerings.micasa.lobby.LobbyPanel +
  +
didLeavePlace(PlaceObject) - +Method in class com.threerings.micasa.lobby.table.TableListView +
  +
didLeavePlace(PlaceObject) - +Method in class com.threerings.parlor.card.client.CardGameController +
  +
didLeavePlace(PlaceObject) - +Method in class com.threerings.parlor.game.client.GameController +
Removes our listener registration from the game object and cleans house. +
didLeavePlace(PlaceObject) - +Method in class com.threerings.parlor.turn.client.TurnDisplay +
  +
didLeavePlace(PlaceObject) - +Method in class com.threerings.parlor.turn.client.TurnGameControllerDelegate +
  +
didLeavePlace(PlaceObject) - +Method in class com.threerings.puzzle.client.PuzzleController +
  +
didLeavePlace(PlaceObject) - +Method in class com.threerings.puzzle.client.PuzzleControllerDelegate +
  +
didLeavePlace(PlaceObject) - +Method in class com.threerings.puzzle.client.PuzzlePanel +
  +
didLeavePlace(PlaceObject) - +Method in class com.threerings.stage.client.StageScenePanel +
  +
didLeavePlace(PlaceObject) - +Method in class com.threerings.whirled.client.SceneController +
  +
didLeaveScene() - +Method in class com.threerings.whirled.client.SceneDirector +
Called to clean up our place and scene state information when we leave a scene. +
didPopup() - +Method in class com.threerings.puzzle.drop.client.DropBlockSprite +
Called if we pop up to decrement the remaining popups we have. +
didStartup(PlaceObject) - +Method in class com.threerings.parlor.card.trick.server.TrickCardGameManagerDelegate +
  +
didStartup(PlaceObject) - +Method in class com.threerings.parlor.rating.server.RatingDelegate +
  +
didStartup(PlaceObject) - +Method in class com.threerings.parlor.turn.server.TurnGameManagerDelegate +
  +
didStartup(PlaceObject) - +Method in class com.threerings.puzzle.drop.server.DropManagerDelegate +
  +
DIFFICULTY - +Static variable in class com.threerings.puzzle.data.PuzzleObject +
The field name of the difficulty field. +
difficulty - +Variable in class com.threerings.puzzle.data.PuzzleObject +
The puzzle difficulty level. +
dir - +Variable in class com.threerings.puzzle.drop.data.SegmentInfo +
The segment's direction; one of DirectionCodes.HORIZONTAL + or DirectionCodes.VERTICAL. +
DirectionButton - Class in com.threerings.stage.tools.editor
A button that allows for selection from the compass directions.
DirectionButton() - +Constructor for class com.threerings.stage.tools.editor.DirectionButton +
Construct a 41x41 DirectionButton. +
DirectionButton(int) - +Constructor for class com.threerings.stage.tools.editor.DirectionButton +
Construct a DirectionButton with the specified preferred diameter. +
dirtySegment(int, int, int, int) - +Method in class com.threerings.puzzle.drop.client.DropBoardView +
Dirties the rectangle encompassing the segment with the given direction and length whose + bottom-leftmost corner is at (col, row). +
dismiss(JInternalFrame) - +Static method in class com.threerings.stage.tools.editor.util.EditorDialogUtil +
Removes the supplied dialog from its parent container, but does not + dispose it. +
dispatchNotification(int, Object[]) - +Method in class com.threerings.parlor.card.client.CardGameDecoder +
  +
dispatchNotification(int, Object[]) - +Method in class com.threerings.parlor.client.ParlorDecoder +
  +
dispatchNotification(int, Object[]) - +Method in class com.threerings.whirled.client.SceneDecoder +
  +
dispatchNotification(int, Object[]) - +Method in class com.threerings.whirled.zone.client.ZoneDecoder +
  +
dispatchResponse(int, Object[]) - +Method in class com.threerings.micasa.lobby.LobbyMarshaller.CategoriesMarshaller +
  +
dispatchResponse(int, Object[]) - +Method in class com.threerings.micasa.lobby.LobbyMarshaller.LobbiesMarshaller +
  +
dispatchResponse(int, Object[]) - +Method in class com.threerings.parlor.data.ParlorMarshaller.InviteMarshaller +
  +
dispatchResponse(int, Object[]) - +Method in class com.threerings.whirled.data.SceneMarshaller.SceneMoveMarshaller +
  +
dispatchResponse(int, Object[]) - +Method in class com.threerings.whirled.spot.data.SpotMarshaller.SpotSceneMoveMarshaller +
  +
dispatchResponse(int, Object[]) - +Method in class com.threerings.whirled.zone.data.ZoneMarshaller.ZoneMoveMarshaller +
  +
display(JFrame, JInternalFrame) - +Static method in class com.threerings.stage.tools.editor.util.EditorDialogUtil +
Display a dialog centered within the given frame. +
displayMessage(ChatMessage, boolean) - +Method in class com.threerings.micasa.client.ChatPanel +
  +
dispose(JInternalFrame) - +Static method in class com.threerings.stage.tools.editor.util.EditorDialogUtil +
Handles safely dismissing and disposing of the supplied dialog. +
dist - +Variable in class com.threerings.puzzle.drop.util.PieceDropper.PieceDropInfo +
The distance to drop the pieces. +
drop() - +Method in class com.threerings.puzzle.drop.client.DropSprite +
Starts the piece dropping toward the next row. +
DROP_BLOCK_PIECE_COUNT - +Static variable in interface com.threerings.puzzle.drop.data.DropPieceCodes +
The number of pieces in a drop block. +
DROP_MESSAGE_BUNDLE - +Static variable in interface com.threerings.puzzle.drop.data.DropCodes +
The message bundle identifier for drop puzzle messages. +
DROP_STREAM - +Static variable in interface com.threerings.puzzle.drop.data.DropCodes +
The name of the control stream that provides drop pieces. +
DropBlockSprite - Class in com.threerings.puzzle.drop.client
The drop block sprite represents a block of multiple pieces that can be rotated to any of the + four cardinal compass directions.
DropBlockSprite(DropBoardView, int, int, int, int[]) - +Constructor for class com.threerings.puzzle.drop.client.DropBlockSprite +
Constructs a drop block sprite and starts it dropping. +
DropBlockSprite(DropBoardView, int, int, int, int[], int) - +Constructor for class com.threerings.puzzle.drop.client.DropBlockSprite +
Constructs a drop block sprite and starts it dropping. +
DropBoard - Class in com.threerings.puzzle.drop.data
A class that provides for various useful logical operations to be enacted on a two-dimensional + board and provides an easier mechanism for referencing pieces by position.
DropBoard() - +Constructor for class com.threerings.puzzle.drop.data.DropBoard +
Constructs an empty drop board for use when unserializing. +
DropBoard(int, int) - +Constructor for class com.threerings.puzzle.drop.data.DropBoard +
Constructs a drop board of the given dimensions with its pieces initialized to PIECE_NONE. +
DropBoard(int, int, int) - +Constructor for class com.threerings.puzzle.drop.data.DropBoard +
Constructs a drop board of the given dimensions with its pieces initialized to the given + piece. +
DropBoard(int[], int, int) - +Constructor for class com.threerings.puzzle.drop.data.DropBoard +
Constructs a drop board with the given board and dimensions. +
DropBoard.PieceOperation - Interface in com.threerings.puzzle.drop.data
An interface to be implemented by classes that would like to apply some operation to each + piece in a column or row segment in the board.
DropBoardSummary - Class in com.threerings.puzzle.drop.data
Provides a summary of a DropBoard.
DropBoardSummary() - +Constructor for class com.threerings.puzzle.drop.data.DropBoardSummary +
Constructs an empty drop board summary for use when un-serializing. +
DropBoardSummary(Board) - +Constructor for class com.threerings.puzzle.drop.data.DropBoardSummary +
Constructs a drop board summary that retrieves board information from the supplied board + when summarizing. +
DropBoardUtil - Class in com.threerings.puzzle.drop.util
 
DropBoardUtil() - +Constructor for class com.threerings.puzzle.drop.util.DropBoardUtil +
  +
DropBoardView - Class in com.threerings.puzzle.drop.client
The drop board view displays a drop puzzle game in progress for a single player.
DropBoardView(PuzzleContext, int, int) - +Constructor for class com.threerings.puzzle.drop.client.DropBoardView +
Constructs a drop board view. +
DropCodes - Interface in com.threerings.puzzle.drop.data
Contains codes used by the drop game services.
DropConfig - Interface in com.threerings.puzzle.drop.data
Provides access to the configuration information for a drop puzzle game.
DropControllerDelegate - Class in com.threerings.puzzle.drop.client
Games that wish to make use of the drop puzzle services will need to create an extension of + this delegate class, customizing it for their particular game and then adding it via + PlaceController.addDelegate(com.threerings.crowd.client.PlaceControllerDelegate).
DropControllerDelegate(PuzzleController, DropLogic) - +Constructor for class com.threerings.puzzle.drop.client.DropControllerDelegate +
Creates a delegate with the specified drop game logic and controller. +
DropGameUtil - Class in com.threerings.puzzle.drop.util
Drop puzzle game related utilities.
DropGameUtil() - +Constructor for class com.threerings.puzzle.drop.util.DropGameUtil +
  +
DropLogic - Interface in com.threerings.puzzle.drop.data
Describes the features and configuration desired for a given drop puzzle game.
DropManagerDelegate - Class in com.threerings.puzzle.drop.server
Provides the necessary support for a puzzle game that involves a two-dimensional board + containing pieces, with new pieces either falling into the board as a "drop block", or rising + into the bottom of the board in new piece rows, groups of blocks can be "broken" and garbage + can be sent to other players' boards as a result.
DropManagerDelegate(PuzzleManager, DropLogic) - +Constructor for class com.threerings.puzzle.drop.server.DropManagerDelegate +
Deprecated. use DropManagerDelegate.DropManagerDelegate(DropLogic). +
DropManagerDelegate(DropLogic) - +Constructor for class com.threerings.puzzle.drop.server.DropManagerDelegate +
Creates a drop manager delegate with a logic that it uses to determine how to manage the + drop puzzle. +
DropPanel - Interface in com.threerings.puzzle.drop.client
Puzzles using the drop services need implement this interface to display drop puzzle related + information.
DropPieceCodes - Interface in com.threerings.puzzle.drop.data
The drop piece codes interface contains constants common to the drop game package.
dropPieces(DropBoard, PieceDropper.DropObserver) - +Method in class com.threerings.puzzle.drop.util.PieceDropper +
Effects any drops possible on the supplied board (modifying the board in the progress) and + notifying the supplied drop observer of those drops. +
DropSprite - Class in com.threerings.puzzle.drop.client
The drop sprite is a sprite that displays one or more pieces falling toward the bottom of the + board.
DropSprite(DropBoardView, int, int, int[], int) - +Constructor for class com.threerings.puzzle.drop.client.DropSprite +
Constructs a drop sprite and starts it dropping. +
DropSprite(DropBoardView, int, int, int[], int, int) - +Constructor for class com.threerings.puzzle.drop.client.DropSprite +
Constructs a drop sprite and starts it dropping. +
DropSpriteObserver - Interface in com.threerings.puzzle.drop.client
Provides notifications for drop puzzle specific stuff.
DummySceneRepository - Class in com.threerings.whirled.server.persist
The dummy scene repository just pretends to load and store scenes, but + in fact it just creates new blank scenes when requested to load a scene + and does nothing when requested to save one.
DummySceneRepository() - +Constructor for class com.threerings.whirled.server.persist.DummySceneRepository +
  +
dump(PrintWriter) - +Method in class com.threerings.parlor.rating.util.Percentiler +
Dumps a text representation of this percentiler to the supplied print stream. +
dump() - +Method in class com.threerings.puzzle.data.Board +
Outputs a string representation of the board contents. +
dump() - +Method in class com.threerings.puzzle.drop.data.DropBoard +
  +
dumpActors() - +Method in class com.threerings.puzzle.client.PuzzleBoardView +
Dumps to the logs, a list of interesting sprites and animations + currently active on the puzzle board. +
dumpAndCompare(Board) - +Method in class com.threerings.puzzle.data.Board +
Outputs a string representation of the board contents, interlaced with the supplied + comparison board. +
dumpAndCompare(Board) - +Method in class com.threerings.puzzle.drop.data.DropBoard +
  +
dumpGnuPlot(PrintWriter) - +Method in class com.threerings.parlor.rating.util.Percentiler +
Dumps out our data in a format that can be used to generate a gnuplot. +
+
+

+E

+
+
EditablePortal - Class in com.threerings.whirled.spot.tools
An editable portal extends the standard portal with information needed + by the loader and editor.
EditablePortal() - +Constructor for class com.threerings.whirled.spot.tools.EditablePortal +
  +
EditorApp - Class in com.threerings.stage.tools.editor
A scene editor application that provides facilities for viewing, editing, and saving the scene + templates that comprise a game.
EditorApp(String[]) - +Constructor for class com.threerings.stage.tools.editor.EditorApp +
Construct and initialize the EditorApp object. +
EditorConfig - Class in com.threerings.stage.tools.editor
Provides access to configuration data for the editor.
EditorConfig() - +Constructor for class com.threerings.stage.tools.editor.EditorConfig +
  +
EditorContext - Interface in com.threerings.stage.tools.editor.util
 
EditorDialog - Class in com.threerings.stage.tools.editor
Basic ok cancel dialog for use by editor components.
EditorDialog(String, EditorContext, EditorScenePanel) - +Constructor for class com.threerings.stage.tools.editor.EditorDialog +
  +
EditorDialogUtil - Class in com.threerings.stage.tools.editor.util
 
EditorDialogUtil() - +Constructor for class com.threerings.stage.tools.editor.util.EditorDialogUtil +
  +
EditorFrame - Class in com.threerings.stage.tools.editor
 
EditorFrame(StageSceneWriter) - +Constructor for class com.threerings.stage.tools.editor.EditorFrame +
  +
EditorModel - Class in com.threerings.stage.tools.editor
The EditorModel class provides a holding place for storing, + modifying and retrieving data that is shared across the Editor + application and its myriad UI components.
EditorModel(TileManager) - +Constructor for class com.threerings.stage.tools.editor.EditorModel +
  +
EditorModelListener - Interface in com.threerings.stage.tools.editor
The editor model listener interface should be implemented by + classes that would like to be notified when the editor model is + changed.
EditorScenePanel - Class in com.threerings.stage.tools.editor
Displays the scene view and handles UI events on the scene.
EditorScenePanel(EditorContext, JFrame, EditorModel, EditorScenePanel.SceneModelListener) - +Constructor for class com.threerings.stage.tools.editor.EditorScenePanel +
Constructs the editor scene view panel. +
EditorScenePanel.SceneModelListener - Interface in com.threerings.stage.tools.editor
 
EditorScrollBox - Class in com.threerings.stage.tools.editor
A scrollbox that shows our position in the editor.
EditorScrollBox(EditorScenePanel) - +Constructor for class com.threerings.stage.tools.editor.EditorScrollBox +
Create the tightly-coupled EditorScrollBox. +
EditorTileManager - Class in com.threerings.stage.tools.editor
Extends the normal Miso Tile Manager to allow the use of a set of test tiles that can be used in + the editor.
EditorTileManager(ResourceManager, ImageManager) - +Constructor for class com.threerings.stage.tools.editor.EditorTileManager +
  +
EditorToolBarPanel - Class in com.threerings.stage.tools.editor
 
EditorToolBarPanel(TileManager, EditorModel) - +Constructor for class com.threerings.stage.tools.editor.EditorToolBarPanel +
  +
elementUpdated(ElementUpdatedEvent) - +Method in class com.threerings.parlor.turn.client.TurnDisplay +
  +
enableCoordHighlighting(boolean) - +Method in class com.threerings.stage.tools.editor.EditorScenePanel +
Enables or disables highlighting of the tile over which the mouse + is currently positioned. +
END_DROP_BLOCK - +Static variable in class com.threerings.puzzle.drop.client.DropControllerDelegate +
The action command for ending dropping the block. +
endGame() - +Method in class com.threerings.parlor.game.server.GameManager +
Called when the game is known to be over. +
endHand() - +Method in class com.threerings.parlor.card.trick.server.TrickCardGameManagerDelegate +
Ends the hand of cards. +
endPlayerGame(int) - +Method in class com.threerings.parlor.game.server.GameManager +
Ends the game for the given player. +
endTrick() - +Method in class com.threerings.parlor.card.trick.server.TrickCardGameManagerDelegate +
Ends the trick. +
endTurn() - +Method in class com.threerings.parlor.card.trick.server.TrickCardGameManagerDelegate +
  +
endTurn() - +Method in class com.threerings.parlor.turn.server.TurnGameManagerDelegate +
Called to end the turn. +
entryAdded(EntryAddedEvent<Table>) - +Method in class com.threerings.parlor.client.TableDirector +
  +
EntryFee - Class in com.threerings.parlor.tourney.data
Extensible entry fee class that specifies entry requirements for a tourney.
EntryFee() - +Constructor for class com.threerings.parlor.tourney.data.EntryFee +
  +
entryFee - +Variable in class com.threerings.parlor.tourney.data.TourneyConfig +
The fee to join the tourney. +
entryRemoved(EntryRemovedEvent<Table>) - +Method in class com.threerings.parlor.client.TableDirector +
  +
entryUpdated(EntryUpdatedEvent<Table>) - +Method in class com.threerings.parlor.client.TableDirector +
  +
enumerateObjects() - +Method in class com.threerings.stage.data.StageScene +
Iterates over all of the interesting objects in this scene. +
enumerateSceneTypes(List<String>) - +Method in interface com.threerings.stage.tools.editor.util.EditorContext +
Inserts all known scene types into the supplied list. +
equals(Object) - +Method in class com.threerings.parlor.card.data.Card +
  +
equals(Object) - +Method in class com.threerings.parlor.data.Table +
  +
equals(Object) - +Method in class com.threerings.parlor.game.data.GameConfig +
Returns true if this game config object is equal to the supplied object (meaning it is a + game config for the same game and its configuration settings are the same as ours). +
equals(Object) - +Method in class com.threerings.parlor.tourney.data.Participant +
  +
equals(Board) - +Method in class com.threerings.puzzle.data.Board +
Returns whether this board is equal to the given comparison board. +
equals(Board) - +Method in class com.threerings.puzzle.drop.data.DropBoard +
  +
equals(Object) - +Method in class com.threerings.stage.data.StageLocation +
Location equality is determined by coordinates. +
equals(Object) - +Method in class com.threerings.whirled.spot.data.Cluster +
  +
equals(Object) - +Method in interface com.threerings.whirled.spot.data.Location +
Two locations are equals if they specify the same coordinates, but + the orientation may be different. +
equals(Object) - +Method in class com.threerings.whirled.spot.data.Portal +
Portal equality is determined by portal id. +
equals(Object) - +Method in class com.threerings.whirled.spot.data.SceneLocation +
  +
equivalent(Location) - +Method in class com.threerings.stage.data.StageLocation +
Location equivalence means that the coordinates and orientation are + the same. +
equivalent(Location) - +Method in interface com.threerings.whirled.spot.data.Location +
Two locations are equivalent if they specify the same location + and orientation. +
ERR_CANNOT_CLUSTER - +Static variable in interface com.threerings.stage.data.StageCodes +
An error delivered when adding objects to scenes. +
ERR_NO_OVERLAP - +Static variable in interface com.threerings.stage.data.StageCodes +
An error delivered when adding objects to scenes. +
execute(DropBoard, int, int) - +Method in interface com.threerings.puzzle.drop.data.DropBoard.PieceOperation +
Called for each piece in the board segment the operation is being applied to. +
EXPERIENCE - +Static variable in class com.threerings.parlor.rating.server.persist.RatingRecord +
  +
experience - +Variable in class com.threerings.parlor.rating.server.persist.RatingRecord +
The number of times the player has played this game. +
experience - +Variable in class com.threerings.parlor.rating.server.Rating +
The number of times the player's played our game. +
expired() - +Method in class com.threerings.parlor.util.RobotPlayer +
  +
ExtrasPainter - Interface in com.threerings.stage.tools.editor.util
An interface for painting extra stuff.
+
+

+F

+
+
FAILED_ENTRY_FEE - +Static variable in interface com.threerings.parlor.tourney.data.TourneyCodes +
User failed to meet the entry fee requirements. +
fastForward(long) - +Method in class com.threerings.puzzle.drop.client.DropSprite +
  +
fill(int) - +Method in class com.threerings.puzzle.drop.data.DropBoard +
Fills the board contents with the given piece. +
fillBoard(DropBoard, PieceDropper.DropObserver) - +Method in class com.threerings.puzzle.drop.util.PieceDropper +
Drops new pieces onto the board to fill the gaps. +
findStandingSpot(Rectangle, int, AStarPathUtil.TraversalPred, Object, Point, int) - +Static method in class com.threerings.stage.util.StageSceneUtil +
Locates a spot to stand near the supplied rectangular footprint. +
FINISHED - +Static variable in class com.threerings.parlor.tourney.data.TourneyObject +
Tourney has completed. +
finishInit(String) - +Method in class com.threerings.stage.tools.editor.EditorApp +
  +
flip(Card, long) - +Method in class com.threerings.parlor.card.client.CardSprite +
Flip the card from its current displayed card to the specified card. +
flyAcross(Card[], Point, Point, long, long, float) - +Method in class com.threerings.parlor.card.client.CardPanel +
Flies a set of cards from the ether into the ether. +
flyAcross(int, Point, Point, long, long, float) - +Method in class com.threerings.parlor.card.client.CardPanel +
Flies a set of cards from the ether into the ether face-down. +
flyFromBoard(CardSprite[], Point, long, float) - +Method in class com.threerings.parlor.card.client.CardPanel +
Flies a set of cards from the board into the ether. +
flyFromBoard(CardSprite[], Point, Point, long, float) - +Method in class com.threerings.parlor.card.client.CardPanel +
Flies a set of cards from the board into the ether through an intermediate point. +
flyFromHand(CardSprite[], Point, long, float) - +Method in class com.threerings.parlor.card.client.CardPanel +
Flies a set of cards from the hand into the ether. +
flyFromHandToBoard(CardSprite, Point, long) - +Method in class com.threerings.parlor.card.client.CardPanel +
Flies a card from the hand onto the board. +
flyIntoHand(Card[], Point, long, long, long, float) - +Method in class com.threerings.parlor.card.client.CardPanel +
Flies a set of cards from the ether into the hand. +
flyToBoard(Card, Point, Point, long, float) - +Method in class com.threerings.parlor.card.client.CardPanel +
Flies a card from the ether onto the board. +
followsSuit(PlayerCard[], Card) - +Static method in class com.threerings.parlor.card.trick.util.TrickCardGameUtil +
Checks whether the proposed card follows the suit lead. +
FORCED_MOVE - +Static variable in class com.threerings.whirled.client.SceneDecoder +
The method id used to dispatch SceneReceiver.forcedMove(int) + notifications. +
FORCED_MOVE - +Static variable in class com.threerings.whirled.zone.client.ZoneDecoder +
The method id used to dispatch ZoneReceiver.forcedMove(int, int) + notifications. +
forcedMove(int) - +Method in class com.threerings.whirled.client.SceneDirector +
  +
forcedMove(int) - +Method in interface com.threerings.whirled.client.SceneReceiver +
Used to communicate a required move notification to the client. +
forcedMove(ClientObject, int) - +Static method in class com.threerings.whirled.server.SceneSender +
Issues a notification that will result in a call to SceneReceiver.forcedMove(int) on a client. +
forcedMove(int, int) - +Method in class com.threerings.whirled.zone.client.ZoneDirector +
  +
forcedMove(int, int) - +Method in interface com.threerings.whirled.zone.client.ZoneReceiver +
Used to communicate a required move notification to the client. +
forcedMove(ClientObject, int, int) - +Static method in class com.threerings.whirled.zone.server.ZoneSender +
Issues a notification that will result in a call to ZoneReceiver.forcedMove(int, int) on a client. +
+
+

+G

+
+
GAME_ALREADY_STARTED - +Static variable in interface com.threerings.parlor.data.ParlorCodes +
An error code returned by the table services when a user requests to leave a table for + which the game is already in progress. +
GAME_CHAT_TYPE - +Static variable in interface com.threerings.parlor.game.data.GameCodes +
A chat type for chatting on the game object. +
GAME_ID - +Static variable in class com.threerings.parlor.rating.server.persist.PercentileRecord +
  +
GAME_ID - +Static variable in class com.threerings.parlor.rating.server.persist.RatingRecord +
  +
GAME_IS_READY - +Static variable in class com.threerings.parlor.client.ParlorDecoder +
The method id used to dispatch ParlorReceiver.gameIsReady(int) + notifications. +
GAME_MESSAGE_BUNDLE - +Static variable in interface com.threerings.parlor.game.data.GameCodes +
The message bundle identifier for general game messages. +
GAME_MODE - +Static variable in class com.threerings.parlor.rating.server.persist.PercentileRecord +
  +
GAME_OVER - +Static variable in class com.threerings.parlor.game.data.GameObject +
A game state constant indicating that the game ended normally. +
GameAI - Class in com.threerings.parlor.game.data
Represents attributes of an AI player.
GameAI() - +Constructor for class com.threerings.parlor.game.data.GameAI +
A blank constructor for serialization. +
GameAI(int, int) - +Constructor for class com.threerings.parlor.game.data.GameAI +
Constructs an AI with the specified (game-interpreted) skill and + personality. +
GameCodes - Interface in com.threerings.parlor.game.data
Constants relating to the game services.
GameConfig - Class in com.threerings.parlor.game.data
The game config class encapsulates the configuration information for a particular type of game.
GameConfig() - +Constructor for class com.threerings.parlor.game.data.GameConfig +
  +
gameConfigClass - +Variable in class com.threerings.micasa.simulator.data.SimulatorInfo +
The game config classname. +
GameConfigurator - Class in com.threerings.parlor.game.client
Provides the base from which interfaces can be built to configure games prior to starting + them.
GameConfigurator() - +Constructor for class com.threerings.parlor.game.client.GameConfigurator +
  +
GameController - Class in com.threerings.parlor.game.client
The game controller manages the flow and control of a game on the client side.
GameController() - +Constructor for class com.threerings.parlor.game.client.GameController +
  +
GameControllerDelegate - Class in com.threerings.parlor.game.client
Extends the PlaceControllerDelegate mechanism with game + controller specific methods.
GameControllerDelegate(GameController) - +Constructor for class com.threerings.parlor.game.client.GameControllerDelegate +
Provides the delegate with a reference to the game controller for + which it is delegating. +
gameDidEnd() - +Method in class com.threerings.parlor.card.trick.server.TrickCardGameManagerDelegate +
  +
gameDidEnd() - +Method in class com.threerings.parlor.game.client.GameControllerDelegate +
Called when the game transitions to the GAME_OVER + state. +
gameDidEnd() - +Method in class com.threerings.parlor.game.server.GameManagerDelegate +
Called by the game manager after the game ended. +
gameDidEnd() - +Method in class com.threerings.parlor.rating.server.RatingDelegate +
  +
gameDidEnd() - +Method in class com.threerings.puzzle.drop.client.DropControllerDelegate +
  +
gameDidStart() - +Method in class com.threerings.parlor.card.trick.server.TrickCardGameManagerDelegate +
Called when the game has started. +
gameDidStart() - +Method in class com.threerings.parlor.game.client.GameControllerDelegate +
Called when the game transitions to the IN_PLAY + state. +
gameDidStart() - +Method in class com.threerings.parlor.game.server.GameManagerDelegate +
Called by the game manager after the game was started. +
gameDidStart() - +Method in class com.threerings.parlor.turn.server.TurnGameManagerDelegate +
This should be called from GameManager.gameDidStart() to let the turn delegate perform + start of game processing. +
gameId - +Variable in class com.threerings.parlor.rating.server.persist.PercentileRecord +
The id of the game for which we're tracking a percentile distribution. +
gameId - +Variable in class com.threerings.parlor.rating.server.persist.RatingRecord +
The identifier of the game we're rating for. +
gameIdent - +Variable in class com.threerings.micasa.lobby.Lobby +
The universal game identifier string for the game matchmade by + this lobby. +
gameIsReady(int) - +Method in class com.threerings.parlor.client.ParlorDirector +
  +
gameIsReady(int) - +Method in interface com.threerings.parlor.client.ParlorReceiver +
Dispatched to the client when a game in which they are a + participant is ready for play. +
gameIsReady(ClientObject, int) - +Static method in class com.threerings.parlor.server.ParlorSender +
Issues a notification that will result in a call to ParlorReceiver.gameIsReady(int) on a client. +
GameManager - Class in com.threerings.parlor.game.server
The game manager handles the server side management of a game.
GameManager() - +Constructor for class com.threerings.parlor.game.server.GameManager +
  +
GameManagerDelegate - Class in com.threerings.parlor.game.server
Extends the PlayManagerDelegate mechanism with game manager specific methods.
GameManagerDelegate() - +Constructor for class com.threerings.parlor.game.server.GameManagerDelegate +
  +
GameManagerDelegate(GameManager) - +Constructor for class com.threerings.parlor.game.server.GameManagerDelegate +
Deprecated. use the zero-argument constructor. +
gameMode - +Variable in class com.threerings.parlor.rating.server.persist.PercentileRecord +
The mode of the game. +
GameObject - Class in com.threerings.parlor.game.data
A game object hosts the shared data associated with a game played by one or more players.
GameObject() - +Constructor for class com.threerings.parlor.game.data.GameObject +
  +
gameOid - +Variable in class com.threerings.parlor.data.Table +
The oid of the game that was created from this table or -1 if the table is still in + matchmaking mode. +
GameReadyObserver - Interface in com.threerings.parlor.client
Used to inform interested parties when the ParlorDirector + receives a game ready notification.
gameWasCancelled() - +Method in class com.threerings.parlor.game.client.GameControllerDelegate +
Called when the game was cancelled for some reason. +
GameWatcher<T extends GameObject> - Class in com.threerings.parlor.game.server
An abstract convenience class used server-side to keep an eye on a game and perform a one-time + game-over activity when the game ends.
GameWatcher() - +Constructor for class com.threerings.parlor.game.server.GameWatcher +
  +
gameWillEnd() - +Method in class com.threerings.parlor.game.server.GameManagerDelegate +
Called by the game manager when the game is about to end. +
gameWillReset() - +Method in class com.threerings.parlor.game.client.GameControllerDelegate +
Called to give derived classes a chance to display animations, send + a final packet, or do any other business they care to do when the + game is about to reset. +
gameWillReset() - +Method in class com.threerings.parlor.game.server.GameManagerDelegate +
Called when the game is about to reset, but before any other clearing out of game data has + taken place. +
gameWillStart() - +Method in class com.threerings.parlor.card.trick.server.TrickCardGameManagerDelegate +
  +
gameWillStart() - +Method in class com.threerings.parlor.game.server.GameManagerDelegate +
Called by the game manager when the game is about to start. +
gameWillStart() - +Method in class com.threerings.parlor.rating.server.RatingDelegate +
  +
gameWillStart() - +Method in class com.threerings.puzzle.drop.server.DropManagerDelegate +
  +
get(String) - +Method in class com.threerings.stats.data.StringMapStat +
Returns the value to which the specified key maps or zero if it is not contained in this + map. +
GET_CATEGORIES - +Static variable in class com.threerings.micasa.lobby.LobbyMarshaller +
The method id used to dispatch LobbyMarshaller.getCategories(com.threerings.micasa.lobby.LobbyService.CategoriesListener) requests. +
GET_LOBBIES - +Static variable in class com.threerings.micasa.lobby.LobbyMarshaller +
The method id used to dispatch LobbyMarshaller.getLobbies(java.lang.String, com.threerings.micasa.lobby.LobbyService.LobbiesListener) requests. +
getActionAnimationCount() - +Method in class com.threerings.puzzle.client.PuzzleBoardView +
Returns the number of action animations on the board. +
getActionCount() - +Method in class com.threerings.puzzle.client.PuzzleBoardView +
Returns the count of action sprites and animations on the board. +
getActionMode() - +Method in class com.threerings.stage.tools.editor.EditorModel +
Returns the current editor action mode. +
getActionSpriteCount() - +Method in class com.threerings.puzzle.client.PuzzleBoardView +
Returns the number of action sprites on the board. +
getActivePlayerCount() - +Method in class com.threerings.parlor.game.data.GameObject +
Returns the number of active players in the game. +
getBoard() - +Method in class com.threerings.puzzle.client.PuzzleController +
Returns the board associated with the puzzle. +
getBoard() - +Method in class com.threerings.puzzle.drop.data.DropBoard +
Returns the raw board data associated with this board. +
getBoardBounds() - +Method in class com.threerings.puzzle.drop.client.DropBlockSprite +
Returns the bounds of the block in board piece coordinates. +
getBoardHeight() - +Method in interface com.threerings.puzzle.drop.data.DropConfig +
Returns the board height in pieces. +
getBoards() - +Method in class com.threerings.puzzle.server.PuzzleManager +
Returns the boards for all players. +
getBoardSummary(int) - +Method in class com.threerings.puzzle.server.PuzzleManager +
Returns the board summary for the given player index. +
getBoardView() - +Method in class com.threerings.puzzle.client.PuzzlePanel +
Returns a reference to the PuzzleBoardView in use. +
getBoardWidth() - +Method in interface com.threerings.puzzle.drop.data.DropConfig +
Returns the board width in pieces. +
getBounds() - +Method in class com.threerings.puzzle.drop.data.DropBoard +
Returns the bounds of this board. +
getCanStandPred() - +Method in class com.threerings.stage.server.StageSceneManager +
Returns a traversal predicate for use with StageSceneUtil.findStandingSpot(java.awt.Rectangle, int, com.threerings.media.util.AStarPathUtil.TraversalPred, java.lang.Object, java.awt.Point, int) that + validates whether a player can stand in the searched spots. +
getCard() - +Method in class com.threerings.parlor.card.client.CardSprite +
Returns the card being depicted. +
getCardBackImage() - +Method in class com.threerings.parlor.card.client.CardPanel +
Returns the full-sized image for the back of a playing card. +
getCardImage(Card) - +Method in class com.threerings.parlor.card.client.CardPanel +
Returns the full-sized image for the front of the specified card. +
getCards() - +Method in class com.threerings.parlor.card.data.Hand +
Converts this list of cards into an array. +
getCardsPlayed() - +Method in interface com.threerings.parlor.card.trick.data.TrickCardGameObject +
Returns an array containing the history of the trick in terms of the + cards played by each player. +
getCardsPlayedFieldName() - +Method in interface com.threerings.parlor.card.trick.data.TrickCardGameObject +
Returns the name of the field that contains the history of the trick + in terms of the cards played by each player. +
getCategories(LobbyService.CategoriesListener) - +Method in class com.threerings.micasa.lobby.LobbyMarshaller +
  +
getCategories(ClientObject, LobbyService.CategoriesListener) - +Method in interface com.threerings.micasa.lobby.LobbyProvider +
Handles a LobbyService.getCategories(com.threerings.micasa.lobby.LobbyService.CategoriesListener) request. +
getCategories(BodyObject) - +Method in class com.threerings.micasa.lobby.LobbyRegistry +
Returns an array containing the category identifiers of all the categories in which lobbies + have been registered with the registry. +
getCategories(ClientObject, LobbyService.CategoriesListener) - +Method in class com.threerings.micasa.lobby.LobbyRegistry +
Processes a request by the client to obtain a list of the lobby categories available on this + server. +
getCategories(LobbyService.CategoriesListener) - +Method in interface com.threerings.micasa.lobby.LobbyService +
Requests the list of lobby categories that are available on this + server. +
getChoiceLabel(int) - +Method in class com.threerings.parlor.data.ChoiceParameter +
Returns the translation key for the specified choice. +
getClientObject(int) - +Method in class com.threerings.parlor.card.server.CardGameManager +
Returns the client object corresponding to the specified player index, or null if the + position is not occupied by a player. +
getClusterField() - +Method in interface com.threerings.whirled.spot.data.ClusteredBodyObject +
Returns the field name of the cluster oid distributed object field. +
getClusterLocs(Cluster) - +Static method in class com.threerings.stage.util.StageSceneUtil +
Computes a list of the valid locations in this cluster. +
getClusterOid() - +Method in interface com.threerings.whirled.spot.data.ClusteredBodyObject +
Returns the oid of the cluster to which this user currently belongs. +
getCode() - +Method in class com.threerings.stats.data.Stat +
Returns the integer code to which this statistic's name maps. +
getCodeString(Stat.Type, int) - +Method in interface com.threerings.stats.data.Stat.AuxDataSource +
Maps the specified unique code back to its string value. +
getCodeString(Stat.Type, int) - +Method in class com.threerings.stats.server.persist.StatRepository +
  +
getColorId(String) - +Method in class com.threerings.stage.client.SceneColorizer +
Get the colorId to use for the specified colorization. +
getColorization(int, String) - +Method in class com.threerings.stage.client.SceneColorizer +
  +
getColorizer(ObjectInfo) - +Method in class com.threerings.stage.client.SceneColorizer +
Obtains a colorizer for the supplied scene object. +
getColorizer() - +Method in class com.threerings.stage.client.StageScenePanel +
Get the tileset colorizer in use in this scene. +
getColorPository() - +Method in interface com.threerings.stage.tools.editor.util.EditorContext +
Returns a colorization repository for use by the editor. +
getColorPository() - +Method in interface com.threerings.stage.util.StageContext +
Returns a reference to the colorization repository. +
getColumn() - +Method in class com.threerings.puzzle.drop.client.DropSprite +
Returns the column the piece is located in. +
getColumnLevels(byte[]) - +Method in class com.threerings.puzzle.drop.data.DropBoard +
Populates the given array with the column levels for this board. +
getColumns() - +Method in class com.threerings.puzzle.drop.client.DropBlockSprite +
Returns an array of the column numbers containing the block pieces. +
getComponent() - +Method in class com.threerings.puzzle.drop.client.DropControllerDelegate +
  +
getComponentRepository() - +Method in interface com.threerings.stage.util.StageContext +
Returns the component repository in use by this client. +
getConstrainedEdge(DropBoard, int, int, int) - +Method in interface com.threerings.puzzle.drop.util.PieceDropLogic +
Returns the x-axis coordinate of the specified edge of the given constrained piece. +
getContext() - +Method in class com.threerings.micasa.client.MiCasaClient +
Returns a reference to the context in effect for this client. +
getController() - +Method in class com.threerings.micasa.client.MiCasaFrame +
  +
getController() - +Method in class com.threerings.puzzle.client.PuzzlePanel +
  +
getController() - +Method in class com.threerings.stage.client.StageScenePanel +
  +
getCounts() - +Method in class com.threerings.parlor.rating.util.Percentiler +
Returns the counts for each bucket. +
getDefaultColor(int) - +Method in class com.threerings.stage.data.StageScene +
Get the default color id to use for the specified colorization class, + or -1 if no default is set. +
getDefaultColor(int) - +Method in class com.threerings.stage.data.StageSceneModel +
Get the default color to use for the specified colorization + classId, or -1 if no default is set for that colorization. +
getDefaultEntrance() - +Method in class com.threerings.stage.data.StageScene +
  +
getDefaultEntrance() - +Method in interface com.threerings.whirled.spot.data.SpotScene +
Returns the portal that represents the default entrance to this scene. +
getDefaultEntrance() - +Method in class com.threerings.whirled.spot.data.SpotSceneImpl +
  +
getDefaultLobbyOid() - +Method in class com.threerings.micasa.lobby.LobbyRegistry +
Returns the oid of the default lobby. +
getDefaultValue() - +Method in class com.threerings.parlor.data.ChoiceParameter +
  +
getDefaultValue() - +Method in class com.threerings.parlor.data.Parameter +
Returns the default value of this parameter. +
getDefaultValue() - +Method in class com.threerings.parlor.data.RangeParameter +
  +
getDefaultValue() - +Method in class com.threerings.parlor.data.ToggleParameter +
  +
getDescription() - +Method in class com.threerings.parlor.game.data.GameConfig +
Returns a List of strings that describe the configuration of this game. +
getDescription() - +Method in class com.threerings.parlor.tourney.data.EntryFee +
Returns a description of the entry fee. +
getDescription() - +Method in class com.threerings.parlor.tourney.data.Prize +
Returns a description of the prize. +
getDirection() - +Method in class com.threerings.stage.tools.editor.DirectionButton +
Get the direction that is currently selected. +
getDistance() - +Method in class com.threerings.puzzle.drop.client.DropSprite +
Returns the remaining number of columns to drop. +
getDropDistance(int, int) - +Method in class com.threerings.puzzle.drop.data.DropBoard +
Returns the distance the piece at the given column and row can drop until it hits a + non-empty piece (defined as DropPieceCodes.PIECE_NONE). +
getEntrance() - +Method in class com.threerings.stage.tools.editor.EditorScenePanel +
Returns the portal that serves as the default entrance to this + scene or null if no default is set. +
getEventCount() - +Method in class com.threerings.puzzle.client.PuzzleController +
Returns the number of progress events currently queued up for sending to the server with + the next progress update. +
getExternalColumn() - +Method in class com.threerings.puzzle.drop.client.DropBlockSprite +
Returns the column the external piece is located in. +
getExternalRow() - +Method in class com.threerings.puzzle.drop.client.DropBlockSprite +
Returns the row the external piece is located in. +
getForgivingMove(int, int, int, int, int, int, float) - +Method in class com.threerings.puzzle.drop.data.DropBoard +
Returns a Point object containing the coordinates to place the bottom-left of the + given block at after moving it the given distance on the x- and y-axes, or + null if the move is not valid. +
getForgivingRotation(int[], int[], int, int, int, float, boolean) - +Method in class com.threerings.puzzle.drop.data.DropBoard +
Rotates the given block in the given direction and returns its final state as (orient, + col, row, popped), where orient is the final orientation of the drop + block; col and row are the final column and row coordinates, + respectively, of the central drop block piece. +
getFQTileId() - +Method in class com.threerings.stage.tools.editor.EditorModel +
Returns the fully qualified tile id of the currently selected tile. +
getFrame() - +Method in class com.threerings.micasa.simulator.client.SimpleFrame +
  +
getFrame() - +Method in interface com.threerings.micasa.simulator.client.SimulatorFrame +
Returns a reference to the top-level frame that the simulator will + use to display everything. +
getFrame() - +Method in interface com.threerings.micasa.simulator.util.SimulatorContext +
Returns a reference to the primary user interface frame. +
getFrame() - +Method in interface com.threerings.micasa.util.MiCasaContext +
Returns a reference to the primary user interface frame. +
getFrameManager() - +Method in interface com.threerings.puzzle.util.PuzzleContext +
Provides access to the frame manager. +
getGameConfig() - +Method in class com.threerings.micasa.lobby.LobbyConfig +
Instantiates and returns a game config instance using the game + config classname provided by the lobby configuration parameters. +
getGameConfig() - +Method in class com.threerings.parlor.game.client.GameConfigurator +
Obtains a configured game configuration. +
getGameConfig() - +Method in class com.threerings.parlor.game.server.GameManager +
Returns the configuration object for the game being managed by this manager. +
getGameId() - +Method in class com.threerings.parlor.game.data.GameConfig +
Returns a numeric identifier for this game class. +
getGameId() - +Method in class com.threerings.parlor.game.server.GameManager +
Returns the unique numeric identifier for our managed game. +
getGameIdent() - +Method in class com.threerings.parlor.game.data.GameConfig +
Returns a string identifier for this game class (e.g. +
getHandSprite(Card) - +Method in class com.threerings.parlor.card.client.CardPanel +
Returns the first sprite in the hand that corresponds to the specified card, or null if the + card is not in the hand. +
getHeight() - +Method in class com.threerings.puzzle.drop.data.DropBoard +
Returns the height of the board in rows. +
getHighestColumn(int, int) - +Method in class com.threerings.puzzle.drop.data.DropBoardSummary +
Returns the column number of the column within the given column range that contains the + most pieces. +
getHighestInLeadSuit(PlayerCard[], int) - +Static method in class com.threerings.parlor.card.trick.util.TrickCardGameUtil +
Returns the highest card (according to the standard A,K,...,2 ordering) in the suit lead, + with an optional trump suit. +
getHorizModel() - +Method in class com.threerings.stage.tools.editor.EditorScenePanel +
Returns a range model that controls the scrollability of the scene + in the horizontal direction. +
getId() - +Method in interface com.threerings.whirled.data.Scene +
Returns the unique identifier for this scene. +
getId() - +Method in class com.threerings.whirled.data.SceneImpl +
  +
getImageManager() - +Method in interface com.threerings.stage.util.StageContext +
Access to the image manager. +
getIntArrayStat(Stat.Type) - +Method in class com.threerings.stats.data.StatSet +
Returns the current value of the specified integer array statistic. +
getIntendedLocation() - +Method in class com.threerings.whirled.spot.client.SpotSceneDirector +
Returns our current location unless we have a location change pending, in which case our + pending location is returned. +
getIntersectedObjects(TileManager, StageSceneModel, Rectangle) - +Static method in class com.threerings.stage.util.StageSceneUtil +
Returns an array of the objects intersected by the supplied tile + coordinate rectangle. +
getIntStat(Stat.Type) - +Method in class com.threerings.stats.data.StatSet +
Returns the current value of the specified integer statistic. +
getJiggy(ActionEvent) - +Method in class com.threerings.stage.tools.viewer.ViewerFrame +
  +
getKey() - +Method in class com.threerings.parlor.card.data.Card +
  +
getKey() - +Method in class com.threerings.parlor.data.Table +
  +
getKey(int, int) - +Static method in class com.threerings.parlor.rating.server.persist.PercentileRecord +
Create and return a primary Key to identify a PercentileRecord + with the supplied key values. +
getKey(int, int) - +Static method in class com.threerings.parlor.rating.server.persist.RatingRecord +
Create and return a primary Key to identify a RatingRecord + with the supplied key values. +
getKey() - +Method in class com.threerings.parlor.tourney.data.Participant +
  +
getKey() - +Method in class com.threerings.stats.data.Stat +
  +
getKey(int, int) - +Static method in class com.threerings.stats.server.persist.StatRecord +
Create and return a primary Key to identify a StatRecord + with the supplied key values. +
getKey(int, String) - +Static method in class com.threerings.stats.server.persist.StringCodeRecord +
Create and return a primary Key to identify a StringCodeRecord + with the supplied key values. +
getKey() - +Method in class com.threerings.whirled.spot.data.Cluster +
  +
getKey() - +Method in class com.threerings.whirled.spot.data.SceneLocation +
  +
getKey() - +Method in class com.threerings.whirled.zone.peer.data.HostedZone +
  +
getKeyboardManager() - +Method in interface com.threerings.puzzle.util.PuzzleContext +
Provides access to the keyboard manager. +
getKeyboardManager() - +Method in interface com.threerings.stage.util.StageContext +
Returns a reference to the keyboard manager. +
getKeyDispatcher() - +Method in interface com.threerings.puzzle.util.PuzzleContext +
Provides access to the key dispatcher. +
getKeyDispatcher() - +Method in interface com.threerings.stage.util.StageContext +
Provides access to the key dispatcher. +
getKeyTranslator() - +Static method in class com.threerings.puzzle.drop.util.DropGameUtil +
Returns a key translator configured with mappings suitable for a drop puzzle game. +
getKeyTranslator() - +Static method in class com.threerings.puzzle.util.PuzzleGameUtil +
Returns a key translator configured with basic puzzle game mappings. +
getLabel() - +Method in class com.threerings.parlor.data.ChoiceParameter +
  +
getLabel() - +Method in class com.threerings.parlor.data.Parameter +
Returns the translation key for this parameter's label. +
getLabel() - +Method in class com.threerings.parlor.data.RangeParameter +
  +
getLabel() - +Method in class com.threerings.parlor.data.ToggleParameter +
  +
getLastCardsPlayed() - +Method in interface com.threerings.parlor.card.trick.data.TrickCardGameObject +
Returns an array containing the history of the last trick in terms of + the cards played by each player. +
getLastCardsPlayedFieldName() - +Method in interface com.threerings.parlor.card.trick.data.TrickCardGameObject +
Returns the name of the field that contains the history of the last + trick in terms of the cards played by each player. +
getLayerIndex() - +Method in class com.threerings.stage.tools.editor.EditorModel +
Returns the current scene layer index undergoing edit. +
getLayerIndex(TileSet) - +Static method in class com.threerings.stage.tools.editor.util.TileSetUtil +
Returns the layer index of the layer for which this tileset + provides tiles. +
getLeftIndex(int) - +Static method in class com.threerings.parlor.card.trick.util.TrickCardGameUtil +
For four-player games, returns the index of the player to the left of the specified player. +
getLobbies(String, LobbyService.LobbiesListener) - +Method in class com.threerings.micasa.lobby.LobbyMarshaller +
  +
getLobbies(ClientObject, String, LobbyService.LobbiesListener) - +Method in interface com.threerings.micasa.lobby.LobbyProvider +
Handles a LobbyService.getLobbies(java.lang.String, com.threerings.micasa.lobby.LobbyService.LobbiesListener) request. +
getLobbies(BodyObject, String, List<Lobby>) - +Method in class com.threerings.micasa.lobby.LobbyRegistry +
Returns information about all lobbies hosting games in the specified category. +
getLobbies(ClientObject, String, LobbyService.LobbiesListener) - +Method in class com.threerings.micasa.lobby.LobbyRegistry +
Processes a request by the client to obtain a list of lobbies matching the supplied category + string. +
getLobbies(String, LobbyService.LobbiesListener) - +Method in interface com.threerings.micasa.lobby.LobbyService +
Requests information on all active lobbies that match the specified category. +
getLocation() - +Method in class com.threerings.whirled.server.SceneManager +
  +
getLocation() - +Method in class com.threerings.whirled.spot.data.Portal +
Returns a location instance configured with the location and + orientation of this portal. +
getManagerClassName() - +Method in class com.threerings.micasa.lobby.LobbyConfig +
  +
getManagerClassName() - +Method in class com.threerings.micasa.lobby.table.TableLobbyConfig +
  +
getManagerClassName() - +Method in class com.threerings.stage.data.StageSceneConfig +
  +
getManagerClassName() - +Method in class com.threerings.whirled.data.DefaultSceneConfig +
  +
getMapValue(Stat.Type, String) - +Method in class com.threerings.stats.data.StatSet +
Returns the value to which the specified string is mapped in a StringMapStat or zero + if the value has not been mapped. +
getMatchType() - +Method in class com.threerings.parlor.game.client.GameController +
Convenience method to determine the type of game. +
getMatchType() - +Method in class com.threerings.parlor.game.data.GameConfig +
Returns the matchmaking type of this game: GameConfig.SEATED_GAME, etc. +
getMatchType() - +Method in class com.threerings.parlor.game.server.GameManager +
A convenience method for getting the game type. +
getMaxIntStat(Stat.Type) - +Method in class com.threerings.stats.data.StatSet +
Returns the maximum value by which the specified integer statistic has ever been + incremented. +
getMaxScore() - +Method in class com.threerings.parlor.rating.util.Percentiler +
Returns the largest score seen by this percentiler. +
getMaxValue() - +Method in class com.threerings.stats.data.MaxIntStat +
Returns the maximum value every accumulated to this integer statistic. +
getMaxValue() - +Method in class com.threerings.stats.data.MaxValueIntStat +
Returns the maximum value that this integer statistic has ever been assigned. +
getMessageManager() - +Method in interface com.threerings.micasa.util.MiCasaContext +
Returns a reference to the message manager used by the client to + generate localized messages. +
getMessageManager() - +Method in interface com.threerings.puzzle.util.PuzzleContext +
Returns a reference to the message manager used by the client. +
getMessageManager() - +Method in interface com.threerings.stage.util.StageContext +
Returns a reference to the message manager used by the client. +
getMetrics() - +Static method in class com.threerings.stage.util.StageSceneUtil +
Returns the scene metrics we use to do our calculations. +
getMicroCardBackImage() - +Method in class com.threerings.parlor.card.client.CardPanel +
Returns the small-sized image for the back of a playing card. +
getMicroCardImage(Card) - +Method in class com.threerings.parlor.card.client.CardPanel +
Returns the small-sized image for the front of the specified card. +
getMiniGraphics() - +Method in class com.threerings.stage.tools.editor.EditorScrollBox +
Get the graphics to draw into when rendering onto the minimap. +
getMinimumLength() - +Method in interface com.threerings.puzzle.drop.util.PieceDestroyer.DestroyLogic +
Returns the minimum length of a contiguously piece segment that should be destroyed. +
getMinScore() - +Method in class com.threerings.parlor.rating.util.Percentiler +
Returns the smallest score seen by this percentiler. +
getModCount() - +Method in class com.threerings.stats.data.Stat +
Returns the modification count of this Stat when it was loaded from the repository. +
getMostRecentRatings(Collection<Integer>, int) - +Method in class com.threerings.parlor.rating.server.persist.RatingRepository +
Load the most recently entered rating for each of a collection of players. +
getMostRecentRatings(Collection<Integer>, Collection<Integer>, int) - +Method in class com.threerings.parlor.rating.server.persist.RatingRepository +
Load the most recently entered rating for each of a collection of players. +
getName() - +Method in interface com.threerings.whirled.data.Scene +
Returns the human readable name of this scene. +
getName() - +Method in class com.threerings.whirled.data.SceneImpl +
  +
getNextInClockwiseSequence(int) - +Static method in class com.threerings.parlor.card.trick.util.TrickCardGameUtil +
For four-player games, this returns the index of the player after the specified player + going clockwise around the table. +
getNextPiece() - +Method in class com.threerings.puzzle.drop.data.DropBoard +
For boards that are always filled, this method is called to obtain pieces to fill the board. +
getNextPortalId() - +Method in class com.threerings.stage.data.StageScene +
  +
getNextPortalId() - +Method in interface com.threerings.whirled.spot.data.SpotScene +
Returns the portal id that should be assigned to the next portal added to this scene. +
getNextPortalId() - +Method in class com.threerings.whirled.spot.data.SpotSceneImpl +
  +
getNumber() - +Method in class com.threerings.parlor.card.data.Card +
Returns the value of the card, either from 2 to 11 or KING, QUEEN, JACK, ACE, RED_JOKER, or + BLACK_JOKER. +
getObjectFootprint(TileManager, int, int, int) - +Static method in class com.threerings.stage.util.StageSceneUtil +
Returns the footprint, in absolute tile coordinates, for the + specified object with origin as specified. +
getObjectFootprint(TileManager, int, int, int, Rectangle) - +Static method in class com.threerings.stage.util.StageSceneUtil +
Fills in the footprint, in absolute tile coordinates, for the + specified object with origin as specified. +
getObjectGripDirection() - +Method in class com.threerings.stage.tools.editor.EditorModel +
Gets the direction in which we should grip objects. +
getOccupiedCount() - +Method in class com.threerings.parlor.data.Table +
Count the number of players currently occupying this table. +
getOppLocation() - +Method in class com.threerings.whirled.spot.data.Portal +
Returns a location instance configured with the location and + opposite orientation of this portal. +
getOpposite() - +Method in class com.threerings.stage.data.StageLocation +
  +
getOpposite() - +Method in interface com.threerings.whirled.spot.data.Location +
Get a new Location instance that is equals() to this one but that + has an orientation facing the opposite direction. +
getOppositeIndex(int) - +Static method in class com.threerings.parlor.card.trick.util.TrickCardGameUtil +
For four-player games, returns the index of the player across from the specified player. +
getOrientationComboBox(ActionListener) - +Static method in class com.threerings.stage.tools.editor.util.EditorDialogUtil +
Create and return a combo box seeded with the various possible + orientation direction names. +
getOtherTeamIndex(int) - +Static method in class com.threerings.parlor.card.trick.util.TrickCardGameUtil +
For four-player games with fixed partnerships, this returns the index of the other team. +
getOuterElement() - +Method in class com.threerings.whirled.spot.tools.xml.SpotSceneRuleSet +
  +
getOuterElement() - +Method in class com.threerings.whirled.tools.xml.SceneRuleSet +
  +
getPanel() - +Method in class com.threerings.parlor.game.client.SwingGameConfigurator +
Get the Swing JPanel that contains the UI elements for this configurator. +
getParlorContext() - +Method in class com.threerings.micasa.simulator.client.SimpleClient +
Returns a reference to the context in effect for this client. +
getParlorContext() - +Method in interface com.threerings.micasa.simulator.client.SimulatorClient +
  +
getParlorDirector() - +Method in interface com.threerings.parlor.util.ParlorContext +
Returns a reference to the parlor director. +
getPartnerIndex(int) - +Static method in class com.threerings.parlor.card.trick.util.TrickCardGameUtil +
For four-player games with fixed partnerships, this returns the index of the player's + partner. +
getPauseString() - +Method in class com.threerings.puzzle.client.PuzzleController +
Get the (untranslated) string to display when the puzzle is paused. +
getPendingModel() - +Method in class com.threerings.whirled.client.SceneDirector +
Returns the model loaded in preparation for a scene transition. +
getPendingSceneId() - +Method in class com.threerings.whirled.client.SceneDirector +
Returns the scene id set in preparation for a scene transition. +
getPercentDone(long) - +Method in class com.threerings.puzzle.drop.client.DropSprite +
Returns a value between 0.0 and 1.0 representing how far the + piece has moved toward the next row as of the given time stamp. +
getPercentile(float) - +Method in class com.threerings.parlor.rating.util.Percentiler +
Returns the percent of all numbers seen that are lower than the specified value. +
getPiece(int, int) - +Method in class com.threerings.puzzle.drop.data.DropBoard +
Returns the piece at the given column and row in the board. +
getPieceHeight() - +Method in class com.threerings.puzzle.drop.client.DropBoardView +
Returns the height in pixels of a single board piece. +
getPieceImage(int) - +Method in class com.threerings.puzzle.drop.client.DropBoardView +
Returns the image used to display the given piece at coordinates (0, 0) with + an orientation of DirectionCodes.NORTH. +
getPieceImage(int, int, int, int) - +Method in class com.threerings.puzzle.drop.client.DropBoardView +
Returns the image used to display the given piece at the specified column and row with the + given orientation. +
getPiecePosition(int, int, Point) - +Method in class com.threerings.puzzle.drop.client.DropBoardView +
Called by the DropSprite to populate pos with the screen coordinates + in pixels at which a piece at (col, row) in the board should be drawn. +
getPieces() - +Method in class com.threerings.puzzle.drop.client.DropSprite +
Returns the pieces the sprite is displaying. +
getPieceSegmentSize(int, int, int, int) - +Method in class com.threerings.puzzle.drop.client.DropBoardView +
Called by the DropSprite to get the dimensions of the area that will be occupied by + rendering a piece segment of the given orientation and length whose bottom-leftmost corner + is at (col, row). +
getPieceSprite(int, int) - +Method in class com.threerings.puzzle.drop.client.DropBoardView +
Returns the piece sprite at the specified location. +
getPieceWidth() - +Method in class com.threerings.puzzle.drop.client.DropBoardView +
Returns the width in pixels of a single board piece. +
getPlaceConfig() - +Method in interface com.threerings.whirled.data.Scene +
Returns the place config that can be used to determine which place + controller instance should be used to display this scene as well as + to obtain runtime configuration information. +
getPlaceConfig() - +Method in class com.threerings.whirled.data.SceneImpl +
  +
getPlayer(int) - +Method in class com.threerings.parlor.game.server.GameManager +
Returns the user object for the player with the specified index or null if the player at + that index is not online. +
getPlayerCount() - +Method in class com.threerings.parlor.game.data.GameObject +
Returns the number of players in the game. +
getPlayerCount() - +Method in class com.threerings.parlor.game.server.GameManager +
Returns the number of players in the game. +
getPlayerCount() - +Method in interface com.threerings.parlor.turn.server.TurnGameManager +
Extending GameManager should automatically handle + implementing this method. +
getPlayerDisplayName(int) - +Method in class com.threerings.parlor.game.server.GameManager +
Returns the name that should be shown in the client for the player with the specified index + or null if no player exists at that index. +
getPlayerIndex(ClientObject) - +Method in class com.threerings.parlor.card.server.CardGameManager +
Gets the player index of the specified client object, or -1 if the client object does not + represent a player. +
getPlayerIndex(Name) - +Method in class com.threerings.parlor.game.data.GameObject +
Returns the player index of the given user in the game, or -1 if the player is + not involved in the game. +
getPlayerIndex(Name) - +Method in class com.threerings.parlor.game.server.GameManager +
Returns the player index of the given user in the game, or -1 if the player is + not involved in the game. +
getPlayerIndex(Name) - +Method in interface com.threerings.parlor.turn.server.TurnGameManager +
Extending GameManager should automatically handle + implementing this method. +
getPlayerIndex() - +Method in class com.threerings.puzzle.client.PlayerStatusView +
Get the player index of the player represented by this view. +
getPlayerIndex() - +Method in class com.threerings.puzzle.client.PuzzleController +
Returns the player's index in the list of players for the game. +
getPlayerName(int) - +Method in class com.threerings.parlor.game.server.GameManager +
Returns the name of the player with the specified index or null if no player exists at that + index. +
getPlayerName(int) - +Method in interface com.threerings.parlor.turn.server.TurnGameManager +
Extending GameManager should automatically handle + implementing this method. +
getPlayerOid(int) - +Method in class com.threerings.parlor.game.server.GameManager +
Returns the user object oid of the player with the specified index. +
getPlayerPersistentId(Name) - +Method in class com.threerings.parlor.game.server.GameManager +
Returns the persistent user id for the supplied player name. +
getPlayerPersistentId(BodyObject) - +Method in class com.threerings.parlor.game.server.GameManager +
Convenience for getting the persistent id from a body. +
getPlayers() - +Method in class com.threerings.parlor.data.Table +
Once a table is ready to play (see Table.mayBeStarted() and Table.shouldBeStarted()), the + players array can be fetched using this method. +
getPlayers() - +Method in interface com.threerings.parlor.turn.data.TurnGameObject +
Returns the array of player names involved in the game. +
getPlayerSlots() - +Method in class com.threerings.parlor.game.server.GameManager +
Returns the number of players allowed in this game. +
getPortal(int, int) - +Method in class com.threerings.stage.client.StageScenePanel +
Returns the portal at the specified full coordinates or null if no + portal exists at said coordinates. +
getPortal(int) - +Method in class com.threerings.stage.data.StageScene +
  +
getPortal(int) - +Method in interface com.threerings.whirled.spot.data.SpotScene +
Returns a Portal object for the portal with the specified id or null if no portal + exists with that id. +
getPortal(int) - +Method in class com.threerings.whirled.spot.data.SpotSceneImpl +
  +
getPortalCount() - +Method in class com.threerings.stage.data.StageScene +
  +
getPortalCount() - +Method in interface com.threerings.whirled.spot.data.SpotScene +
Returns the number of portals in this scene. +
getPortalCount() - +Method in class com.threerings.whirled.spot.data.SpotSceneImpl +
  +
getPortals() - +Method in class com.threerings.stage.data.StageScene +
  +
getPortals() - +Method in interface com.threerings.whirled.spot.data.SpotScene +
Returns an iterator over the portals in this scene. +
getPortals() - +Method in class com.threerings.whirled.spot.data.SpotSceneImpl +
  +
getPreferredSize() - +Method in class com.threerings.micasa.client.ChatPanel +
  +
getPreferredSize() - +Method in class com.threerings.puzzle.drop.client.DropBoardView +
  +
getPreferredSize() - +Method in class com.threerings.puzzle.drop.client.NextBlockView +
  +
getPreferredSize() - +Method in class com.threerings.stage.tools.editor.DirectionButton +
  +
getPreferredSize() - +Method in class com.threerings.stage.tools.editor.EditorScrollBox +
  +
getPreferredSize() - +Method in class com.threerings.stage.tools.editor.TileInfoPanel +
  +
getPresentPlayerIndex(int) - +Method in class com.threerings.parlor.game.server.GameManager +
Get the player index of the specified oid, or -1 if the oid is not a player or is a player + that is not presently in the game. +
getRandom() - +Method in class com.threerings.puzzle.data.Board +
Returns the random number generator used by the board to generate random numbers for our + puzzles. +
getRating(int, int) - +Method in class com.threerings.parlor.rating.server.persist.RatingRepository +
Loads the rating for the given player for the given game and returns it as a + RatingRecord object, or null if the player has no previous rating for the game. +
getRatings(int, Integer...) - +Method in class com.threerings.parlor.rating.server.persist.RatingRepository +
Fetch the ratings registered for any of the given players for the given game and return + them as a list of RatingRecord objects. +
getRatings(int, long, int) - +Method in class com.threerings.parlor.rating.server.persist.RatingRepository +
Fetch and return all the registered RatingRecord rows for the given player. +
getReceiverCode() - +Method in class com.threerings.parlor.card.client.CardGameDecoder +
  +
getReceiverCode() - +Method in class com.threerings.parlor.client.ParlorDecoder +
  +
getReceiverCode() - +Method in class com.threerings.whirled.client.SceneDecoder +
  +
getReceiverCode() - +Method in class com.threerings.whirled.zone.client.ZoneDecoder +
  +
getRecordedCount() - +Method in class com.threerings.parlor.rating.util.Percentiler +
Returns the total number of values ever recorded to this percentiler. +
getRelativeLocation(int, int) - +Static method in class com.threerings.parlor.card.trick.util.TrickCardGameUtil +
For four-player games with fixed partnerships, this returns the relative location of one + player from the point of view of another. +
getRematchRequests() - +Method in interface com.threerings.parlor.card.trick.data.TrickCardGameObject +
Returns the array of rematch requests. +
getRematchRequestsFieldName() - +Method in interface com.threerings.parlor.card.trick.data.TrickCardGameObject +
Returns the name of the field that contains the rematch requests. +
getRequiredScore(int) - +Method in class com.threerings.parlor.rating.util.Percentiler +
Returns the score necessary to attain the specified percentile. +
getRequiredScores() - +Method in class com.threerings.parlor.rating.util.Percentiler +
Returns the scores required to obtain a percentile rating from 0 to 99. +
getResourceManager() - +Method in interface com.threerings.stage.util.StageContext +
Returns the resource manager via which all client resources are loaded. +
getRightIndex(int) - +Static method in class com.threerings.parlor.card.trick.util.TrickCardGameUtil +
For four-player games, returns the index of the player to the right of the specified + player. +
getRotatedOrientation(int, int, int) - +Static method in class com.threerings.puzzle.drop.util.DropBoardUtil +
Returns the orientation resulting from rotating the block in the given direction the + specified number of times. +
getRotatedOrientation(int, int) - +Static method in class com.threerings.puzzle.drop.util.DropBoardUtil +
Returns the orientation resulting from rotating the block in the given direction. +
getRow() - +Method in class com.threerings.puzzle.drop.client.DropSprite +
Returns the row the piece is located in. +
getRows() - +Method in class com.threerings.puzzle.drop.client.DropBlockSprite +
Returns an array of the row numbers containing the block pieces. +
getScene() - +Method in class com.threerings.stage.client.StageScenePanel +
Returns the scene being displayed by this panel. +
getScene() - +Method in class com.threerings.whirled.client.SceneDirector +
Returns the display scene object associated with the scene we currently occupy or null if we + currently occupy no scene. +
getScene() - +Method in class com.threerings.whirled.server.SceneManager +
Returns the scene object (not the scene distributed object) being managed by this scene + manager. +
getSceneDirector() - +Method in interface com.threerings.whirled.util.WhirledContext +
Returns a reference to the scene director. +
getSceneId(Place) - +Static method in class com.threerings.whirled.data.ScenePlace +
Returns the scene id for the supplied place or -1 if the place is null or not a scene place. +
getSceneId(BodyObject) - +Static method in class com.threerings.whirled.data.ScenePlace +
Returns the scene id occupied by the supplied body or -1 if the body is not in a scene. +
getSceneId() - +Method in class com.threerings.whirled.data.SceneUpdate +
Returns the scene id for which this update is appropriate. +
getSceneId() - +Method in exception com.threerings.whirled.util.NoSuchSceneException +
  +
getSceneManager(int) - +Method in class com.threerings.whirled.server.SceneRegistry +
Fetches the scene manager associated with the specified scene. +
getSceneModel(SceneModel) - +Static method in class com.threerings.stage.data.StageMisoSceneModel +
Locates and returns the StageMisoSceneModel among the + auxiliary scene models associated with the supplied scene model. +
getSceneModel() - +Method in interface com.threerings.whirled.data.Scene +
Returns the scene model from which this scene was created. +
getSceneModel() - +Method in class com.threerings.whirled.data.SceneImpl +
  +
getSceneModel(SceneModel) - +Static method in class com.threerings.whirled.spot.data.SpotSceneModel +
Locates and returns the SpotSceneModel among the auxiliary scene models associated + with the supplied scene model. +
getSceneRepository() - +Method in class com.threerings.whirled.server.SceneRegistry +
Returns a reference to the scene repository in use by this registry. +
getSceneVersion() - +Method in class com.threerings.whirled.data.SceneUpdate +
Returns the scene version for which this update is appropriate. +
getSeatedTable() - +Method in class com.threerings.parlor.client.TableDirector +
Returns the current table this client is seated at, or null. +
getSection(int) - +Method in class com.threerings.stage.data.StageMisoSceneModel +
Returns the section identified by the specified key, or null if no + section exists for that key. +
getSectionKey(int, int) - +Method in class com.threerings.stage.data.StageMisoSceneModel +
Returns the section key for the specified tile coordinate. +
getSelectedHandSprite() - +Method in class com.threerings.parlor.card.client.CardPanel +
Returns the currently selected hand sprite (null if no sprites are selected, the first + sprite if multiple sprites are selected). +
getSelectedHandSprites() - +Method in class com.threerings.parlor.card.client.CardPanel +
Returns an array containing the currently selected hand sprites (returns an empty array if + no sprites are selected). +
getSessionId() - +Method in class com.threerings.parlor.game.client.GameController +
Returns the unique session identifier for the current gameplay session. +
getSessionId() - +Method in class com.threerings.parlor.game.server.GameManager +
Returns the unique session identifier for this game session. +
getSetStatSize(Stat.Type) - +Method in class com.threerings.stats.data.StatSet +
Returns the current size of the specified SetStat statistic. +
getSimulatorInfo() - +Method in interface com.threerings.micasa.simulator.util.SimulatorContext +
Returns a reference to the simulator info describing the game and + other details of the simulation. +
getStringCode(Stat.Type, String) - +Method in interface com.threerings.stats.data.Stat.AuxDataSource +
Maps the specified string to a unique integer value. +
getStringCode(Stat.Type, String) - +Method in class com.threerings.stats.server.persist.StatRepository +
  +
getSuit() - +Method in class com.threerings.parlor.card.data.Card +
Returns the suit of the card: SPADES, HEARTS, DIAMONDS, or CLUBS. +
getSuitMemberCount(int) - +Method in class com.threerings.parlor.card.data.Hand +
Counts the members of a particular suit within this hand. +
getTableConfig() - +Method in class com.threerings.parlor.client.TableConfigurator +
Return the fully configured table config according to the currently + configured user interface elements. +
getTableCount() - +Method in class com.threerings.parlor.server.TableManager +
Returns the number of tables being managed currently. +
getTables() - +Method in class com.threerings.micasa.lobby.table.TableLobbyObject +
  +
getTables() - +Method in interface com.threerings.parlor.data.TableLobbyObject +
Returns a reference to the distributed set instance that will be + holding the tables. +
getTableService() - +Method in class com.threerings.micasa.lobby.table.TableLobbyObject +
  +
getTableService() - +Method in interface com.threerings.parlor.data.TableLobbyObject +
Returns a reference to the table service configured in this object. +
getTeamIndex(int) - +Static method in class com.threerings.parlor.card.trick.util.TrickCardGameUtil +
For four-player games with fixed partnerships, this returns the index of the player's team. +
getTeamMemberIndex(int, int) - +Static method in class com.threerings.parlor.card.trick.util.TrickCardGameUtil +
For four-player games with fixed partnerships, this returns the index of one of the members + of a team. +
getTeamMemberIndices() - +Method in class com.threerings.parlor.data.Table +
For a team game, get the team member indices of the compressed players array returned by + Table.getPlayers(). +
getTestTileDirectory() - +Static method in class com.threerings.stage.tools.editor.EditorConfig +
Accessor method for getting the test tile directory. +
getTile() - +Method in class com.threerings.stage.tools.editor.EditorModel +
Returns the currently selected tile for placement within the + scene. +
getTileId() - +Method in class com.threerings.stage.tools.editor.EditorModel +
Returns the currently selected tile id within the selected tile + set. +
getTileSet() - +Method in class com.threerings.stage.tools.editor.EditorModel +
Returns the currently selected tile set. +
getTileSet(int) - +Method in class com.threerings.stage.tools.editor.EditorTileManager +
  +
getTileSetId() - +Method in class com.threerings.stage.tools.editor.EditorModel +
Returns the currently selected tile set id. +
getTileSetID(String) - +Method in class com.threerings.stage.tools.editor.TestTileLoader +
Generate unique and completely fake tileset IDs that will be stable + even after a reload of test tiles. +
getTileSetRepository() - +Method in interface com.threerings.stage.tools.editor.util.EditorContext +
Return a reference to the tile set repository in use by the tile + manager. +
getTopRatings(int, int, long, Set<Integer>) - +Method in class com.threerings.parlor.rating.server.persist.RatingRepository +
Returns the top-ratings for the specified game. +
getTourneyConfig() - +Method in class com.threerings.parlor.tourney.server.persist.TourneyRepository.TourneyRecord +
  +
getTrickCardGameService() - +Method in interface com.threerings.parlor.card.trick.data.TrickCardGameObject +
Returns a reference to the trick card game service used to make + requests to the server. +
getTrickState() - +Method in interface com.threerings.parlor.card.trick.data.TrickCardGameObject +
Returns the trick state: between hands, playing a hand, or playing a + trick. +
getTrickStateFieldName() - +Method in interface com.threerings.parlor.card.trick.data.TrickCardGameObject +
Returns the name of the field that contains the trick state: between + hands, playing a hand, or playing a trick. +
getTrickTaker() - +Method in interface com.threerings.parlor.card.trick.data.TrickCardGameObject +
Returns the card of the player who took the current trick. +
getTurnDuration() - +Method in interface com.threerings.parlor.card.trick.data.TrickCardGameObject +
Returns the duration of the current turn, which may depend on the state + of the game as well as the duration scale of the active player. +
getTurnDurationScales() - +Method in interface com.threerings.parlor.card.trick.data.TrickCardGameObject +
Returns an array containing the turn duration scales for each player. +
getTurnHolder() - +Method in interface com.threerings.parlor.turn.data.TurnGameObject +
Returns the username of the player who is currently taking their + turn in this turn-based game or null if no user + currently holds the turn. +
getTurnHolderFieldName() - +Method in interface com.threerings.parlor.turn.data.TurnGameObject +
Returns the distributed object field name of the + turnHolder field in the object that implements this + interface. +
getTurnHolderIndex() - +Method in class com.threerings.parlor.turn.client.TurnGameControllerDelegate +
Returns the index of the current turn holder as configured in the + game object. +
getTurnHolderIndex() - +Method in class com.threerings.parlor.turn.server.TurnGameManagerDelegate +
Returns the index of the current turn holder as configured in the game object. +
getType() - +Method in class com.threerings.stage.data.StageScene +
Returns the scene type (e.g. +
getType(int) - +Static method in class com.threerings.stats.data.Stat +
Maps a Stat.Type's code code back to a Stat.Type instance. +
getType() - +Method in class com.threerings.stats.data.Stat +
Returns the type of this statistic. +
getType() - +Method in class com.threerings.stats.data.StatModifier +
Returns the Stat.Type of the stat being modified. +
getUpdateClass(int) - +Method in class com.threerings.whirled.server.persist.SceneUpdateMarshaller +
Returns the update class associated with the specified type code, or null. +
getUpdates(int) - +Method in class com.threerings.whirled.server.SceneManager +
Returns UpdateList.getUpdates(int) for this scene's updates. +
getUpdates(int) - +Method in class com.threerings.whirled.util.UpdateList +
Returns all of the updates that should be applied to a scene with the specified version to + bring it up to date. +
getUpdateType(SceneUpdate) - +Method in class com.threerings.whirled.server.persist.SceneUpdateMarshaller +
Returns the type code that is assigned to the specified SceneUpdate instance, or -1. +
getUpdateType(Class<?>) - +Method in class com.threerings.whirled.server.persist.SceneUpdateMarshaller +
Returns the type code that is assigned to the specified SceneUpdate class, or -1. +
getUserId(Name) - +Static method in class com.threerings.parlor.game.data.UserIdentifier +
Returns the id of the specified user, or 0 if they're not valid. +
getUserId(Name) - +Method in interface com.threerings.parlor.game.data.UserIdentifier.Ider +
  +
getUsername() - +Method in interface com.threerings.puzzle.util.PuzzleContext +
Returns the username of the local user. +
getValue() - +Method in class com.threerings.stats.data.IntArrayStat +
Returns the value of this statistic. +
getValue() - +Method in class com.threerings.stats.data.IntStat +
Returns the value of this integer statistic. +
getVelocity() - +Method in class com.threerings.puzzle.drop.client.DropSprite +
Returns the velocity of this sprite. +
getVersion() - +Method in interface com.threerings.whirled.data.Scene +
Returns the version number of this scene. +
getVersion() - +Method in class com.threerings.whirled.data.SceneImpl +
  +
getVersionIncrement() - +Method in class com.threerings.whirled.data.SceneUpdate +
Returns the amount by which this update increments the scene version. +
getVertModel() - +Method in class com.threerings.stage.tools.editor.EditorScenePanel +
Returns a range model that controls the scrollability of the scene + in the vertical direction. +
getWidth() - +Method in class com.threerings.puzzle.drop.data.DropBoard +
Returns the width of the board in columns. +
getWinnerCount() - +Method in class com.threerings.parlor.game.data.GameObject +
Returns the number of winners for this game, or 0 if the winners array is not + populated, e.g., the game is not yet over. +
getWinnerIndex() - +Method in class com.threerings.parlor.game.data.GameObject +
Returns the winner index of the first winning player for this game, or -1 if + there are no winners or the winners array is not yet assigned. +
getZoneHost(int) - +Method in class com.threerings.whirled.zone.peer.server.ZonePeerManager +
Returns the node name of the peer that is hosting the specified scene, or null if no peer + has published that they are hosting the scene. +
getZoneId() - +Method in class com.threerings.stage.data.StageScene +
Returns the zone id to which this scene belongs. +
getZoneId() - +Method in interface com.threerings.whirled.zone.data.ZonedBodyObject +
Returns the zone id currently occupied by this body. +
getZoneLock(int) - +Static method in class com.threerings.whirled.zone.peer.server.ZonePeerManager +
Returns a lock used to claim resolution of the specified scene. +
getZoneManager(int) - +Method in class com.threerings.whirled.zone.peer.server.PeeredZoneRegistry +
  +
getZoneManager(int) - +Method in class com.threerings.whirled.zone.server.ZoneRegistry +
Returns the zone manager that handles the specified zone id. +
getZoneSummary() - +Method in class com.threerings.whirled.zone.client.ZoneDirector +
Returns the summary for the zone currently occupied by the client or null if the client does + not currently occupy a zone (not a normal situation). +
GOT_CATEGORIES - +Static variable in class com.threerings.micasa.lobby.LobbyMarshaller.CategoriesMarshaller +
The method id used to dispatch LobbyMarshaller.CategoriesMarshaller.gotCategories(java.lang.String[]) + responses. +
GOT_LOBBIES - +Static variable in class com.threerings.micasa.lobby.LobbyMarshaller.LobbiesMarshaller +
The method id used to dispatch LobbyMarshaller.LobbiesMarshaller.gotLobbies(java.util.List) + responses. +
gotCategories(String[]) - +Method in class com.threerings.micasa.lobby.LobbyMarshaller.CategoriesMarshaller +
  +
gotCategories(String[]) - +Method in class com.threerings.micasa.lobby.LobbySelector +
  +
gotCategories(String[]) - +Method in interface com.threerings.micasa.lobby.LobbyService.CategoriesListener +
Supplies the listener with the results of a LobbyService.getCategories(com.threerings.micasa.lobby.LobbyService.CategoriesListener) request. +
gotLobbies(List<Lobby>) - +Method in class com.threerings.micasa.lobby.LobbyMarshaller.LobbiesMarshaller +
  +
gotLobbies(List<Lobby>) - +Method in class com.threerings.micasa.lobby.LobbySelector +
  +
gotLobbies(List<Lobby>) - +Method in interface com.threerings.micasa.lobby.LobbyService.LobbiesListener +
Supplies the listener with the results of a LobbyService.getLobbies(java.lang.String, com.threerings.micasa.lobby.LobbyService.LobbiesListener) request. +
+
+

+H

+
+
Hand - Class in com.threerings.parlor.card.data
Instances of this class represent hands of cards.
Hand() - +Constructor for class com.threerings.parlor.card.data.Hand +
  +
handleAction(ActionEvent) - +Method in class com.threerings.micasa.client.ClientController +
  +
handleAction(ActionEvent) - +Method in class com.threerings.micasa.simulator.client.SimulatorController +
  +
handleAction(ActionEvent) - +Method in class com.threerings.parlor.game.client.GameController +
Handles basic game controller action events. +
handleAction(ActionEvent) - +Method in class com.threerings.puzzle.client.PuzzleController +
  +
handleAction(ActionEvent) - +Method in class com.threerings.puzzle.drop.client.DropControllerDelegate +
  +
handleClusterClicked(Object, Tuple<Cluster, Point>) - +Method in class com.threerings.stage.client.StageSceneController +
Handles a cluster clicked event. +
handleLocationClicked(Object, StageLocation) - +Method in class com.threerings.stage.client.StageSceneController +
Called when the user clicks on a location within the scene. +
handleNew(ActionEvent) - +Method in class com.threerings.stage.tools.editor.EditorFrame +
Creates a blank scene and configures the editor to begin editing + it. +
handleOpen(ActionEvent) - +Method in class com.threerings.stage.tools.editor.EditorFrame +
Presents the user with an open file dialog and loads the scenes + from the selected file. +
handlePreferences(ActionEvent) - +Method in class com.threerings.stage.tools.editor.EditorFrame +
Handles a request to open the preferences dialog. +
handleQuit(ActionEvent) - +Method in class com.threerings.stage.tools.editor.EditorFrame +
Handles a request to quit. +
handleQuit(ActionEvent) - +Method in class com.threerings.stage.tools.viewer.ViewerFrame +
Handles a request to get the fuck out of dodge. +
handleSave(ActionEvent) - +Method in class com.threerings.stage.tools.editor.EditorFrame +
Save the scenes to the file they were last associated with. +
handleSaveAs(ActionEvent) - +Method in class com.threerings.stage.tools.editor.EditorFrame +
Present the user with a save file dialog and save the scenes to + the selected file. +
handleSetDefBase(ActionEvent) - +Method in class com.threerings.stage.tools.editor.EditorFrame +
Make the currently selected base tile into the scene's default + tile. +
handleTestTiles(ActionEvent) - +Method in class com.threerings.stage.tools.editor.EditorFrame +
Handles a request to reload the test tiles. +
HAS_PLAYERS - +Static variable in interface com.threerings.parlor.tourney.data.TourneyCodes +
This tourney has participating players. +
hasAction() - +Method in class com.threerings.puzzle.client.PuzzleController +
Returns true if the puzzle has action, false if the action is cleared or it is suspended. +
hasFee(BodyObject) - +Method in class com.threerings.parlor.tourney.data.EntryFee +
Checks if the user has the required entry fee. +
hashCode() - +Method in class com.threerings.parlor.card.data.Card +
  +
hashCode() - +Method in class com.threerings.parlor.data.Table +
  +
hashCode() - +Method in class com.threerings.parlor.game.data.GameConfig +
Computes a hashcode for this game config object that supports our GameConfig.equals(java.lang.Object) + implementation. +
hashCode() - +Method in class com.threerings.parlor.tourney.data.Participant +
  +
hashCode() - +Method in class com.threerings.stage.data.StageLocation +
Computes a reasonable hashcode for location instances. +
hashCode() - +Method in class com.threerings.whirled.spot.data.Cluster +
  +
hashCode() - +Method in interface com.threerings.whirled.spot.data.Location +
The hashcode of a Location should be based only on its coordinates. +
hashCode() - +Method in class com.threerings.whirled.spot.data.Portal +
Computes a reasonable hashcode for portal instances. +
hashCode() - +Method in class com.threerings.whirled.spot.data.SceneLocation +
  +
hasOverlay() - +Method in class com.threerings.puzzle.client.PuzzlePanel +
Returns true if an overlay panel is currently being displayed. +
HEARTS - +Static variable in interface com.threerings.parlor.card.data.CardCodes +
The suit of hearts. +
HOSTED_ZONES - +Static variable in class com.threerings.whirled.zone.peer.server.ZoneNodeObject +
The field name of the hostedZones field. +
HostedZone - Class in com.threerings.whirled.zone.peer.data
Represents a zone hosted on some node.
HostedZone() - +Constructor for class com.threerings.whirled.zone.peer.data.HostedZone +
  +
HostedZone(int, Name) - +Constructor for class com.threerings.whirled.zone.peer.data.HostedZone +
  +
hostedZones - +Variable in class com.threerings.whirled.zone.peer.server.ZoneNodeObject +
Contains info on all zones hosted by this server. +
+
+

+I

+
+
ident - +Variable in class com.threerings.parlor.data.Parameter +
A string identifier that names this parameter. +
IN_PLAY - +Static variable in class com.threerings.parlor.game.data.GameObject +
A game state constant indicating that the game is in play. +
inBounds(int, int) - +Method in class com.threerings.puzzle.drop.client.DropBoardView +
Returns true if the specified coordinate is within the bounds of the board, false if it is + not. +
inBounds(int, int) - +Method in class com.threerings.puzzle.drop.data.DropBoard +
Returns true if the specified coordinate is within the bounds of the board, false if it is + not. +
increment(int) - +Method in class com.threerings.stats.data.IntStat +
Increments this statistic by the specified delta value. +
increment(int) - +Method in class com.threerings.stats.data.MaxIntStat +
  +
increment(String, int) - +Method in class com.threerings.stats.data.StringMapStat +
Adds the specified key value pair to this set, overwriting any existing mapping. +
incrementMapStat(Stat.Type, String, int) - +Method in class com.threerings.stats.data.StatSet +
Increments a string value in a StringMapStat. +
incrementStat(Stat.Type, int) - +Method in class com.threerings.stats.data.StatSet +
Increments an integer statistic in this set. +
init() - +Method in class com.threerings.micasa.client.MiCasaApp +
  +
init() - +Method in class com.threerings.micasa.client.MiCasaApplet +
Create the client instance and set things up. +
init(MiCasaFrame) - +Method in class com.threerings.micasa.client.MiCasaClient +
Initializes a new client and provides it with a frame in which to + display everything. +
init(Properties) - +Method in class com.threerings.micasa.lobby.LobbyConfig +
Initializes this lobby config object with the properties that are + used to configure the lobby. +
init(CrowdContext, PlaceConfig) - +Method in class com.threerings.micasa.lobby.LobbyController +
  +
init(LobbyRegistry, Properties) - +Method in class com.threerings.micasa.lobby.LobbyManager +
Initializes this lobby manager with its configuration properties. +
init() - +Method in class com.threerings.micasa.lobby.LobbyRegistry +
Initializes the registry, creating our default lobbies. +
init(Injector) - +Method in class com.threerings.micasa.server.MiCasaServer +
  +
init(Injector, ResultListener<SimulatorServer>) - +Method in class com.threerings.micasa.simulator.server.SimpleServer +
  +
init(BodyObject, GameConfig, GameManager, DObjectManager) - +Method in class com.threerings.micasa.simulator.server.Simulant +
Initializes the simulant with a body object and the game config for + the game they'll be engaged in. +
init(Injector, ResultListener<SimulatorServer>) - +Method in interface com.threerings.micasa.simulator.server.SimulatorServer +
Called to initialize this server instance. +
init(PlaceManager, RootDObjectManager, InvocationManager) - +Method in class com.threerings.parlor.card.trick.server.TrickCardGameManagerDelegate +
  +
init(ParlorContext, GameConfigurator) - +Method in class com.threerings.parlor.client.TableConfigurator +
Initialize the TableConfigurator. +
init(int, TableConfig, GameConfig) - +Method in class com.threerings.parlor.data.Table +
Initializes a new table instance, and assigns it the next monotonically increasing table id. +
init(ParlorContext) - +Method in class com.threerings.parlor.game.client.GameConfigurator +
Initializes this game configurator, creates its user interface elements and prepares it for + display. +
init(CrowdContext, PlaceConfig) - +Method in class com.threerings.parlor.game.client.GameController +
Initializes this game controller with the game configuration that was established during the + match making process. +
init(PlaceManager) - +Method in class com.threerings.parlor.game.server.GameWatcher +
  +
init(T) - +Method in class com.threerings.parlor.game.server.GameWatcher +
  +
init(TourneyConfig, Comparable<?>) - +Method in class com.threerings.parlor.tourney.server.TourneyManager +
Initializes this tourney manager and prepares it for operation. +
init() - +Method in class com.threerings.parlor.tourney.server.TourniesManager +
  +
init(CrowdContext, PlaceConfig) - +Method in class com.threerings.parlor.turn.client.TurnGameControllerDelegate +
  +
init(GameConfig) - +Method in class com.threerings.puzzle.client.PlayerStatusView +
Initializes the player status view with the puzzle config. +
init(GameConfig) - +Method in class com.threerings.puzzle.client.PuzzleBoardView +
Initializes the board with the board dimensions. +
init(GameConfig) - +Method in class com.threerings.puzzle.client.PuzzlePanel +
Initializes the puzzle panel with the puzzle config of the puzzle whose user interface is + being displayed by the panel +
init(GameConfig) - +Method in class com.threerings.puzzle.drop.client.DropBoardView +
Initializes the board with the board dimensions. +
init(CrowdContext, PlaceConfig) - +Method in class com.threerings.puzzle.drop.client.DropControllerDelegate +
  +
init(int, int, int, int) - +Method in class com.threerings.stage.data.DefaultColorUpdate +
Initializes this update. +
init(int, int, ObjectInfo[], ObjectInfo[]) - +Method in class com.threerings.stage.data.ModifyObjectsUpdate +
Initializes this update with all necessary data. +
init(Injector) - +Method in class com.threerings.stage.server.StageServer +
  +
init(EditorContext, String) - +Method in class com.threerings.stage.tools.editor.EditorFrame +
  +
init(EditorScenePanel, int, int) - +Method in class com.threerings.stage.tools.editor.PortalTool +
  +
init(StageContext, CharacterManager) - +Method in class com.threerings.stage.tools.viewer.ViewerFrame +
Instructs us to create our scene panel. +
init(CrowdContext, PlaceConfig) - +Method in class com.threerings.whirled.client.SceneController +
  +
init(int, int) - +Method in class com.threerings.whirled.data.SceneUpdate +
Initializes this scene update such that it will operate on a scene with the specified target + scene and version number. +
init(Injector) - +Method in class com.threerings.whirled.server.WhirledServer +
  +
initialize(int, int, Portal[], Portal[]) - +Method in class com.threerings.whirled.spot.data.ModifyPortalsUpdate +
Initialize the update with all necessary data. +
initializeSeed(long) - +Method in class com.threerings.puzzle.data.Board +
Sets the seed in the board's random number generator and calls Board.populate(). +
initType(Stat.Type, Stat) - +Static method in class com.threerings.stats.data.Stat +
Used by the Stat.Type implementation to map itself to an integer code. +
INPLACE_ROTATION - +Static variable in class com.threerings.puzzle.drop.data.DropBoard +
The rotation constant for rotation wherein the block occupies the same columns when + rotating. +
inPlay() - +Method in class com.threerings.parlor.data.Table +
Returns true if this table is in play, false if it is still being matchmade. +
insertTourney(TourneyConfig) - +Method in class com.threerings.parlor.tourney.server.persist.TourneyRepository +
Inserts a new tourney into the repository, assigning a unique id to the tourney. +
inside(Shape) - +Method in class com.threerings.puzzle.drop.client.DropSprite +
  +
IntArrayStat - Class in com.threerings.stats.data
Used to track an integer array statistic.
IntArrayStat() - +Constructor for class com.threerings.stats.data.IntArrayStat +
  +
IntSetStat - Class in com.threerings.stats.data
Used to track a statistic comprised of a bounded set of integers.
IntSetStat() - +Constructor for class com.threerings.stats.data.IntSetStat +
Constructs a new IntSetStat that will store up to 255 ints. +
IntSetStat(int) - +Constructor for class com.threerings.stats.data.IntSetStat +
Constructs a new IntSetStat that will store up to maxSize ints. +
IntSetStatAdder - Class in com.threerings.stats.data
Adds a value to an IntSetStat.
IntSetStatAdder(Stat.Type, int) - +Constructor for class com.threerings.stats.data.IntSetStatAdder +
  +
IntSetStatAdder() - +Constructor for class com.threerings.stats.data.IntSetStatAdder +
Constructs an empty IntSetStatAdder (for Streaming purposes). +
IntStat - Class in com.threerings.stats.data
Used to track a single integer statistic.
IntStat() - +Constructor for class com.threerings.stats.data.IntStat +
  +
IntStatIncrementer - Class in com.threerings.stats.data
Increments a particular int stat by a specified amount.
IntStatIncrementer(Stat.Type, int) - +Constructor for class com.threerings.stats.data.IntStatIncrementer +
  +
IntStatIncrementer() - +Constructor for class com.threerings.stats.data.IntStatIncrementer +
Constructs an empty IntStatIncrementer (for Streaming purposes). +
IntStatMinimumer - Class in com.threerings.stats.data
Ensures that a particular stat has been set to a minimum value.
IntStatMinimumer(Stat.Type, int) - +Constructor for class com.threerings.stats.data.IntStatMinimumer +
  +
IntStatMinimumer() - +Constructor for class com.threerings.stats.data.IntStatMinimumer +
Constructs an empty IntStatMinimumer (for Streaming purposes). +
IntStringSetStat - Class in com.threerings.stats.data
A string set that maps its values to integers.
IntStringSetStat() - +Constructor for class com.threerings.stats.data.IntStringSetStat +
  +
INVALID_LOCATION - +Static variable in interface com.threerings.whirled.spot.data.SpotCodes +
An error code indicating that a location is not valid. +
INVALID_TABLE_POSITION - +Static variable in interface com.threerings.parlor.data.ParlorCodes +
An error code returned by the table services. +
Invitation - Class in com.threerings.parlor.client
The invitation class is used to track information related to + outstanding invitations generated by or targeted to this client.
Invitation(ParlorContext, ParlorService, Name, GameConfig, InvitationResponseObserver) - +Constructor for class com.threerings.parlor.client.Invitation +
Constructs a new invitation record. +
INVITATION_ACCEPTED - +Static variable in interface com.threerings.parlor.data.ParlorCodes +
The response code for an accepted invitation. +
INVITATION_COUNTERED - +Static variable in interface com.threerings.parlor.data.ParlorCodes +
The response code for a countered invitation. +
INVITATION_REFUSED - +Static variable in interface com.threerings.parlor.data.ParlorCodes +
The response code for a refused invitation. +
invitationAccepted(Invitation) - +Method in class com.threerings.micasa.lobby.LobbyController +
  +
invitationAccepted(Invitation) - +Method in interface com.threerings.parlor.client.InvitationResponseObserver +
Called if the invitation was accepted. +
invitationCancelled(Invitation) - +Method in class com.threerings.micasa.lobby.LobbyController +
  +
invitationCancelled(Invitation) - +Method in interface com.threerings.parlor.client.InvitationHandler +
Called when an invitation is cancelled by the inviting player. +
invitationCountered(Invitation, GameConfig) - +Method in class com.threerings.micasa.lobby.LobbyController +
  +
invitationCountered(Invitation, GameConfig) - +Method in interface com.threerings.parlor.client.InvitationResponseObserver +
Called if the invitation was countered with an alternate game + configuration. +
InvitationHandler - Interface in com.threerings.parlor.client
A client entity that wishes to handle invitations received by other + clients should implement this interface and register itself with the + parlor director.
invitationReceived(Invitation) - +Method in class com.threerings.micasa.lobby.LobbyController +
  +
invitationReceived(Invitation) - +Method in interface com.threerings.parlor.client.InvitationHandler +
Called when an invitation is received from another player. +
invitationRefused(Invitation, String) - +Method in class com.threerings.micasa.lobby.LobbyController +
  +
invitationRefused(Invitation, String) - +Method in interface com.threerings.parlor.client.InvitationResponseObserver +
Called if the invitation was refused. +
InvitationResponseObserver - Interface in com.threerings.parlor.client
A client entity that wishes to generate invitations for games must + implement this interface.
invite(Name, GameConfig, InvitationResponseObserver) - +Method in class com.threerings.parlor.client.ParlorDirector +
Requests that the named user be invited to a game described by the supplied game config. +
invite(Name, GameConfig, ParlorService.InviteListener) - +Method in interface com.threerings.parlor.client.ParlorService +
You probably don't want to call this directly, but want to generate your invitation request + via ParlorDirector.invite(com.threerings.util.Name, com.threerings.parlor.game.data.GameConfig, com.threerings.parlor.client.InvitationResponseObserver). +
INVITE - +Static variable in class com.threerings.parlor.data.ParlorMarshaller +
The method id used to dispatch ParlorMarshaller.invite(com.threerings.util.Name, com.threerings.parlor.game.data.GameConfig, com.threerings.parlor.client.ParlorService.InviteListener) requests. +
invite(Name, GameConfig, ParlorService.InviteListener) - +Method in class com.threerings.parlor.data.ParlorMarshaller +
  +
invite(ClientObject, Name, GameConfig, ParlorService.InviteListener) - +Method in class com.threerings.parlor.server.ParlorManager +
  +
invite(BodyObject, BodyObject, GameConfig) - +Method in class com.threerings.parlor.server.ParlorManager +
Issues an invitation from the inviter to the invitee for a game as + described by the supplied config object. +
invite(ClientObject, Name, GameConfig, ParlorService.InviteListener) - +Method in interface com.threerings.parlor.server.ParlorProvider +
Handles a ParlorService.invite(com.threerings.util.Name, com.threerings.parlor.game.data.GameConfig, com.threerings.parlor.client.ParlorService.InviteListener) request. +
INVITE_RECEIVED - +Static variable in class com.threerings.parlor.data.ParlorMarshaller.InviteMarshaller +
The method id used to dispatch ParlorMarshaller.InviteMarshaller.inviteReceived(int) + responses. +
INVITEE_NOT_ONLINE - +Static variable in interface com.threerings.parlor.data.ParlorCodes +
An error code explaining that an invitation was rejected because the invited user was not + online at the time the invitation was received. +
inviteId - +Variable in class com.threerings.parlor.client.Invitation +
The unique id for this invitation (as assigned by the + server). +
inviteReceived(int) - +Method in class com.threerings.parlor.client.Invitation +
  +
inviteReceived(int) - +Method in interface com.threerings.parlor.client.ParlorService.InviteListener +
Called in response to a successful ParlorService.invite(com.threerings.util.Name, com.threerings.parlor.game.data.GameConfig, com.threerings.parlor.client.ParlorService.InviteListener) request. +
inviteReceived(int) - +Method in class com.threerings.parlor.data.ParlorMarshaller.InviteMarshaller +
  +
IS_PRIVATE - +Static variable in class com.threerings.parlor.game.data.GameObject +
The field name of the isPrivate field. +
IS_RATED - +Static variable in class com.threerings.parlor.game.data.GameObject +
The field name of the isRated field. +
isAce() - +Method in class com.threerings.parlor.card.data.Card +
Checks whether the card is an ace. +
isActive() - +Method in class com.threerings.parlor.util.RobotPlayer +
Returns whether the robot is currently active and periodically + posting action commands. +
isActivePlayer(int) - +Method in class com.threerings.parlor.game.data.GameObject +
Returns whether the given player is still an active player in the game. +
isActivePlayer(int) - +Method in class com.threerings.parlor.game.server.GameManager +
Returns whether the player at the specified player index is actively playing the game +
isActivePlayer(int) - +Method in interface com.threerings.parlor.turn.server.TurnGameManager +
Extending GameManager should automatically handle + implementing this method. +
isAgent(ClientObject) - +Method in class com.threerings.parlor.game.server.GameManager +
  +
isAgent(ClientObject) - +Method in interface com.threerings.parlor.server.PlayManager +
Return true if the given client is a server-side agent in this place. +
isAI(int) - +Method in class com.threerings.parlor.game.server.GameManager +
Returns whether the player at the specified player index is an AI. +
isBlockEmpty(int, int, int, int) - +Method in class com.threerings.puzzle.drop.data.DropBoard +
Returns whether the specified block in the board is empty. +
isBouncing() - +Method in class com.threerings.puzzle.drop.client.DropSprite +
Returns true if this sprite is bouncing. +
isCardPlayable(Hand, Card) - +Method in interface com.threerings.parlor.card.trick.data.TrickCardGameObject +
Checks whether a user can play the specified card at this time. +
isChatting() - +Method in class com.threerings.puzzle.client.PuzzleController +
Returns true if the puzzle has been defocused because the player is doing some chatting. +
isClimbablePiece(boolean, int, boolean) - +Method in interface com.threerings.puzzle.drop.util.PieceDropLogic +
Returns whether the given piece terminates a column climb when determining the height of a + piece column to be dropped. +
isClusterable() - +Method in class com.threerings.stage.data.StageOccupantInfo +
Should return true if the occupant in question is available to be + clustered with, false if they are "busy". +
isConstrainedPiece(int) - +Method in interface com.threerings.puzzle.drop.util.PieceDropLogic +
Returns whether the given piece has constraints upon it that impact its droppability. +
isDraggable() - +Method in class com.threerings.parlor.card.client.CardSprite +
Checks whether or not the user can drag this card. +
isDraw() - +Method in class com.threerings.parlor.game.data.GameObject +
Returns true if the game is ended in a draw. +
isDroppablePiece(int) - +Method in interface com.threerings.puzzle.drop.util.PieceDropLogic +
Returns whether the given piece is potentially droppable. +
isDropping() - +Method in class com.threerings.puzzle.drop.client.DropSprite +
Returns true if this drop sprite is dropping, false if it has been DropSprite.stop()ped or has + not yet been DropSprite.drop()ped. +
isEmpty() - +Method in class com.threerings.parlor.client.DefaultSwingTableConfigurator +
  +
isEmpty() - +Method in class com.threerings.parlor.client.TableConfigurator +
If true, the TableConfigurator is empty, which doesn't mean that + it will not return a TableConfig object (for it must), but rather + that there are no user-editable options being presented in the + config interface. +
isEmpty() - +Method in class com.threerings.parlor.data.Table +
Returns true if there is no one sitting at this table. +
isEmpty() - +Method in class com.threerings.puzzle.util.PointSet +
Returns whether this set is empty. +
isEquivalent(int, int) - +Method in interface com.threerings.puzzle.drop.util.PieceDestroyer.DestroyLogic +
Returns whether piece a is equivalent to piece b for the + purposes of including it in a contiguous piece segment to be destroyed. +
isFace() - +Method in class com.threerings.parlor.card.data.Card +
Checks whether the card is a face card (KING, QUEEN, or JACK). +
isFacingUp() - +Method in class com.threerings.parlor.card.client.CardSprite +
Checks whether this card is facing up or down. +
isFinished() - +Method in class com.threerings.parlor.tourney.server.TourneyManager +
Returns true if the tourney is finished. +
isGameOver() - +Method in class com.threerings.parlor.game.client.GameController +
Returns whether the game is over. +
isInPlay() - +Method in class com.threerings.parlor.game.data.GameObject +
Returns whether the game is in play. +
isInPlay() - +Method in interface com.threerings.parlor.turn.data.TurnGameObject +
Returns true if the game is in play, false if not. +
isJoker() - +Method in class com.threerings.parlor.card.data.Card +
Checks whether the card is a joker. +
isModified() - +Method in class com.threerings.parlor.rating.util.Percentiler +
Returns true if thsi percentiler has been modified since it was created or since the last + call to Percentiler.clearModified(). +
isModified() - +Method in class com.threerings.stats.data.Stat +
Returns true if the supplied statistic has been modified since it + was loaded from the repository. +
isNumber() - +Method in class com.threerings.parlor.card.data.Card +
Checks whether the card is a number card (2 to 10). +
isOccupiedPlayer(int) - +Method in class com.threerings.parlor.game.data.GameObject +
Returns whether the given player index in the game is occupied. +
isOurTurn() - +Method in class com.threerings.parlor.turn.client.TurnGameControllerDelegate +
Returns true if the game is in progress and it is our turn; false + otherwise. +
isPassable(int, int) - +Method in class com.threerings.stage.server.StageSceneManager +
Returns true if the specified tile coordinate is passable (the base + tile is passable and it is not in the footprint of an object). +
isPassable(TileManager, int) - +Static method in class com.threerings.stage.util.StageSceneUtil +
Looks up the base tile set for the specified fully qualified tile + identifier and returns true if the associated tile is passable. +
isPaused() - +Method in class com.threerings.parlor.tourney.server.TourneyManager +
Returns true if the tourney is paused. +
isPending() - +Method in class com.threerings.parlor.tourney.server.TourneyManager +
Returns true if the tourney is pending. +
isPersistent() - +Method in interface com.threerings.stats.data.Stat.Type +
Returns true if this stat is persisted between sessions. +
isPersistent() - +Method in class com.threerings.whirled.server.SceneManager +
Returns true if this scene stores data in the database, or false if it's instantiated anew + with each server restart +
isPlayer(ClientObject) - +Method in class com.threerings.parlor.game.server.GameManager +
  +
isPlayer(ClientObject) - +Method in interface com.threerings.parlor.server.PlayManager +
Return true if the given client is a player in this place. +
isPlayersTurn(int) - +Method in class com.threerings.parlor.turn.server.TurnGameManagerDelegate +
Test if it's the inputted player's turn. +
isPrivate - +Variable in class com.threerings.parlor.game.data.GameObject +
Indicates whether the game is "private". +
isProvisional() - +Method in class com.threerings.parlor.rating.server.Rating +
Returns true if this rating is provisional (experience < 20). +
isRated - +Variable in class com.threerings.parlor.game.data.GameObject +
Indicates whether or not this game is rated. +
isRobotTesting() - +Static method in class com.threerings.puzzle.client.PuzzlePanel +
Returns true if the robot tester is activated. +
isRowEmpty(int) - +Method in class com.threerings.puzzle.drop.data.DropBoard +
Returns whether the given row in the board is empty. +
isRunning() - +Method in class com.threerings.parlor.tourney.server.TourneyManager +
Returns true if the tourney is running. +
isSeated() - +Method in class com.threerings.parlor.client.TableDirector +
Returns true if this client is currently seated at a table, false if they are not. +
isSyncingBoards() - +Static method in class com.threerings.puzzle.client.PuzzlePanel +
Returns true if board syncing is activated. +
isTileValid() - +Method in class com.threerings.stage.tools.editor.EditorModel +
Returns whether the currently selected tile is valid. +
isValid() - +Method in class com.threerings.parlor.card.data.Card +
Checks whether or not this card is valid. +
isValid() - +Method in class com.threerings.whirled.spot.data.Portal +
Returns true if the portal has a potentially valid target scene and + portal id (they are not guaranteed to exist, but they are at least + potentially valid values rather than -1 or 0). +
isValidDrop(int[], int[], float) - +Method in class com.threerings.puzzle.drop.data.DropBoard +
Returns whether all of the pieces at the given coordinates can be dropped one row. +
isValidPosition(int, int) - +Method in class com.threerings.puzzle.drop.data.DropBoard +
Returns whether the given coordinates are within the board bounds. +
isWinner(int) - +Method in class com.threerings.parlor.game.data.GameObject +
Returns whether the given player index is a winner, or false if the winners are not yet + assigned. +
iterator() - +Method in class com.threerings.puzzle.util.PointSet +
Returns an iterator that iterates over the points in this set, returning them as + Point objects. +
+
+

+J

+
+
JACK - +Static variable in interface com.threerings.parlor.card.data.CardCodes +
The number of the jack. +
join(InvocationService.ConfirmListener) - +Method in interface com.threerings.parlor.tourney.client.TourneyService +
Handles a request to join the tourney. +
JOIN - +Static variable in class com.threerings.parlor.tourney.data.TourneyMarshaller +
The method id used to dispatch TourneyMarshaller.join(com.threerings.presents.client.InvocationService.ConfirmListener) requests. +
join(InvocationService.ConfirmListener) - +Method in class com.threerings.parlor.tourney.data.TourneyMarshaller +
  +
join(ClientObject, InvocationService.ConfirmListener) - +Method in class com.threerings.parlor.tourney.server.TourneyManager +
  +
join(ClientObject, InvocationService.ConfirmListener) - +Method in interface com.threerings.parlor.tourney.server.TourneyProvider +
Handles a TourneyService.join(com.threerings.presents.client.InvocationService.ConfirmListener) request. +
JOIN_CLUSTER - +Static variable in class com.threerings.whirled.spot.data.SpotMarshaller +
The method id used to dispatch SpotMarshaller.joinCluster(int, com.threerings.presents.client.InvocationService.ConfirmListener) requests. +
JOIN_TABLE - +Static variable in class com.threerings.parlor.data.TableMarshaller +
The method id used to dispatch TableMarshaller.joinTable(int, int, com.threerings.presents.client.InvocationService.InvocationListener) requests. +
joinCluster(int, ResultListener<Void>) - +Method in class com.threerings.whirled.spot.client.SpotSceneDirector +
Issues a request to join the cluster associated with the specified user (starting one if + necessary). +
joinCluster(int, InvocationService.ConfirmListener) - +Method in interface com.threerings.whirled.spot.client.SpotService +
Requests that this client start or join the specified cluster. +
joinCluster(int, InvocationService.ConfirmListener) - +Method in class com.threerings.whirled.spot.data.SpotMarshaller +
  +
joinCluster(ClientObject, int, InvocationService.ConfirmListener) - +Method in interface com.threerings.whirled.spot.server.SpotProvider +
Handles a SpotService.joinCluster(int, com.threerings.presents.client.InvocationService.ConfirmListener) request. +
joinCluster(ClientObject, int, InvocationService.ConfirmListener) - +Method in class com.threerings.whirled.spot.server.SpotSceneRegistry +
  +
joinTable(int, int) - +Method in class com.threerings.parlor.client.TableDirector +
Sends a request to join the specified table at the specified position. +
joinTable(int, int, InvocationService.InvocationListener) - +Method in interface com.threerings.parlor.client.TableService +
Requests that the current user be added to the specified table at the specified position. +
joinTable(int, int, InvocationService.InvocationListener) - +Method in class com.threerings.parlor.data.TableMarshaller +
  +
joinTable(ClientObject, int, int, InvocationService.InvocationListener) - +Method in class com.threerings.parlor.server.TableManager +
  +
joinTable(ClientObject, int, int, InvocationService.InvocationListener) - +Method in interface com.threerings.parlor.server.TableProvider +
Handles a TableService.joinTable(int, int, com.threerings.presents.client.InvocationService.InvocationListener) request. +
+
+

+K

+
+
keyPressed(KeyEvent) - +Method in class com.threerings.stage.client.StageScenePanel +
  +
keyPressed(KeyEvent) - +Method in class com.threerings.stage.tools.editor.EditorScenePanel +
  +
keyReleased(KeyEvent) - +Method in class com.threerings.stage.client.StageScenePanel +
  +
keyReleased(KeyEvent) - +Method in class com.threerings.stage.tools.editor.EditorScenePanel +
  +
keyTyped(KeyEvent) - +Method in class com.threerings.stage.client.StageScenePanel +
  +
KING - +Static variable in interface com.threerings.parlor.card.data.CardCodes +
The number of the king. +
+
+

+L

+
+
LAST_UPDATED - +Static variable in class com.threerings.parlor.rating.server.persist.RatingRecord +
  +
lastUpdated - +Variable in class com.threerings.parlor.rating.server.persist.RatingRecord +
The last time this rating was updated. +
LAYER_INDEX_CHANGED - +Static variable in interface com.threerings.stage.tools.editor.EditorModelListener +
  +
LAYER_NAMES - +Static variable in class com.threerings.stage.tools.editor.EditorModel +
  +
leave(InvocationService.ConfirmListener) - +Method in interface com.threerings.parlor.tourney.client.TourneyService +
Handles a request to leave the tourney. +
LEAVE - +Static variable in class com.threerings.parlor.tourney.data.TourneyMarshaller +
The method id used to dispatch TourneyMarshaller.leave(com.threerings.presents.client.InvocationService.ConfirmListener) requests. +
leave(InvocationService.ConfirmListener) - +Method in class com.threerings.parlor.tourney.data.TourneyMarshaller +
  +
leave(ClientObject, InvocationService.ConfirmListener) - +Method in class com.threerings.parlor.tourney.server.TourneyManager +
  +
leave(ClientObject, InvocationService.ConfirmListener) - +Method in interface com.threerings.parlor.tourney.server.TourneyProvider +
Handles a TourneyService.leave(com.threerings.presents.client.InvocationService.ConfirmListener) request. +
LEAVE_TABLE - +Static variable in class com.threerings.parlor.data.TableMarshaller +
The method id used to dispatch TableMarshaller.leaveTable(int, com.threerings.presents.client.InvocationService.InvocationListener) requests. +
leaveOccupiedScene(BodyObject) - +Method in class com.threerings.whirled.server.SceneRegistry +
Ejects the specified body from their current scene and zone. +
leaveOccupiedZone(ZonedBodyObject) - +Method in class com.threerings.whirled.zone.server.ZoneRegistry +
Ejects the specified body from their current scene and zone. +
leaveTable(int) - +Method in class com.threerings.parlor.client.TableDirector +
Sends a request to leave the specified table at which we are presumably seated. +
leaveTable(int, InvocationService.InvocationListener) - +Method in interface com.threerings.parlor.client.TableService +
Requests that the current user be removed from the specified table. +
leaveTable(int, InvocationService.InvocationListener) - +Method in class com.threerings.parlor.data.TableMarshaller +
  +
leaveTable(ClientObject, int, InvocationService.InvocationListener) - +Method in class com.threerings.parlor.server.TableManager +
  +
leaveTable(ClientObject, int, InvocationService.InvocationListener) - +Method in interface com.threerings.parlor.server.TableProvider +
Handles a TableService.leaveTable(int, com.threerings.presents.client.InvocationService.InvocationListener) request. +
LEFT - +Static variable in interface com.threerings.parlor.card.trick.data.TrickCardCodes +
For four-player games, the player on the left. +
len - +Variable in class com.threerings.puzzle.drop.data.SegmentInfo +
The segment's length in pieces. +
LIGHT_LEVEL - +Static variable in class com.threerings.stage.data.StageSceneObject +
The field name of the lightLevel field. +
LIGHT_SHADE - +Static variable in class com.threerings.stage.data.StageSceneObject +
The field name of the lightShade field. +
lightLevel - +Variable in class com.threerings.stage.data.StageSceneObject +
The light level in this scene. +
lightShade - +Variable in class com.threerings.stage.data.StageSceneObject +
The color of the light. +
loadExtras(int, SceneModel) - +Method in class com.threerings.whirled.server.persist.DummySceneRepository +
  +
loadExtras(int, SceneModel) - +Method in interface com.threerings.whirled.server.persist.SceneRepository +
Loads optional additional scene data. +
loadPercentile(int, int) - +Method in class com.threerings.parlor.rating.server.persist.RatingRepository +
Loads the percentile distribution associated with the specified game and mode. +
loadPercentiles(int) - +Method in class com.threerings.parlor.rating.server.persist.RatingRepository +
Loads all the percentile distributions associated with the specified game. +
loadScene(String) - +Method in class com.threerings.stage.tools.viewer.ViewerFrame +
  +
loadSceneModel(int) - +Method in interface com.threerings.whirled.client.persist.SceneRepository +
Fetches the model for the scene with the specified id. +
loadSceneModel(int) - +Method in class com.threerings.whirled.server.persist.DummySceneRepository +
  +
loadSceneModel(int) - +Method in interface com.threerings.whirled.server.persist.SceneRepository +
Fetches the model for the scene with the specified scene id. +
loadStats(int) - +Method in class com.threerings.stats.server.persist.StatRepository +
Loads the stats associated with the specified player. +
loadTestTiles() - +Method in class com.threerings.stage.tools.editor.TestTileLoader +
Check the specified directory and all its subdirectories for xml files. +
loadTournies() - +Method in class com.threerings.parlor.tourney.server.persist.TourneyRepository +
Loads all the tourney configs from the repository. +
loadUpdates(int) - +Method in class com.threerings.whirled.server.persist.DummySceneRepository +
  +
loadUpdates(int) - +Method in interface com.threerings.whirled.server.persist.SceneRepository +
Fetches the set of updates associated with the specified scene. +
Lobby - Class in com.threerings.micasa.lobby
A simple class for keeping track of information for each lobby in + operation on the server.
Lobby(int, String, String) - +Constructor for class com.threerings.micasa.lobby.Lobby +
Constructs a lobby record and initializes it with the specified + values. +
Lobby() - +Constructor for class com.threerings.micasa.lobby.Lobby +
Constructs a blank lobby record suitable for unserialization. +
LobbyConfig - Class in com.threerings.micasa.lobby
 
LobbyConfig() - +Constructor for class com.threerings.micasa.lobby.LobbyConfig +
  +
LobbyController - Class in com.threerings.micasa.lobby
 
LobbyController() - +Constructor for class com.threerings.micasa.lobby.LobbyController +
  +
LobbyManager - Class in com.threerings.micasa.lobby
Takes care of the server side of a particular lobby.
LobbyManager() - +Constructor for class com.threerings.micasa.lobby.LobbyManager +
  +
LobbyMarshaller - Class in com.threerings.micasa.lobby
Provides the implementation of the LobbyService interface + that marshalls the arguments and delivers the request to the provider + on the server.
LobbyMarshaller() - +Constructor for class com.threerings.micasa.lobby.LobbyMarshaller +
  +
LobbyMarshaller.CategoriesMarshaller - Class in com.threerings.micasa.lobby
Marshalls results to implementations of LobbyService.CategoriesListener.
LobbyMarshaller.CategoriesMarshaller() - +Constructor for class com.threerings.micasa.lobby.LobbyMarshaller.CategoriesMarshaller +
  +
LobbyMarshaller.LobbiesMarshaller - Class in com.threerings.micasa.lobby
Marshalls results to implementations of LobbyService.LobbiesListener.
LobbyMarshaller.LobbiesMarshaller() - +Constructor for class com.threerings.micasa.lobby.LobbyMarshaller.LobbiesMarshaller +
  +
LobbyObject - Class in com.threerings.micasa.lobby
Presently the lobby object contains nothing specific, but the class + acts as a placeholder in case lobby-wide fields are needed in the + future.
LobbyObject() - +Constructor for class com.threerings.micasa.lobby.LobbyObject +
  +
lobbyOid - +Variable in class com.threerings.parlor.data.Table +
The object id of the lobby object with which this table is associated. +
LobbyPanel - Class in com.threerings.micasa.lobby
Used to display the interface for the lobbies.
LobbyPanel(MiCasaContext, LobbyConfig) - +Constructor for class com.threerings.micasa.lobby.LobbyPanel +
Constructs a new lobby panel and the associated user interface + elements. +
LobbyProvider - Interface in com.threerings.micasa.lobby
Defines the server-side of the LobbyService.
LobbyRegistry - Class in com.threerings.micasa.lobby
The lobby registry is the primary class that coordinates the lobby services on the client.
LobbyRegistry(InvocationManager) - +Constructor for class com.threerings.micasa.lobby.LobbyRegistry +
  +
LobbySelector - Class in com.threerings.micasa.lobby
The lobby selector displays a drop-down box listing the categories of + lobbies available on this server and when a category is selected, it + displays a list of the lobbies that are available in that category.
LobbySelector(MiCasaContext) - +Constructor for class com.threerings.micasa.lobby.LobbySelector +
Constructs a new lobby selector component. +
LobbyService - Interface in com.threerings.micasa.lobby
Provides an interface to the various parlor services that are directly + invokable by the client (by means of the invocation services).
LobbyService.CategoriesListener - Interface in com.threerings.micasa.lobby
Used to communicate the results of a LobbyService.getCategories(com.threerings.micasa.lobby.LobbyService.CategoriesListener) request.
LobbyService.LobbiesListener - Interface in com.threerings.micasa.lobby
Used to communicate the results of a LobbyService.getLobbies(java.lang.String, com.threerings.micasa.lobby.LobbyService.LobbiesListener) request.
loc - +Variable in class com.threerings.whirled.spot.data.Portal +
The location of the portal. +
loc - +Variable in class com.threerings.whirled.spot.data.SceneLocation +
The actual location, which is interpreted by the display system. +
localDataDir(String) - +Static method in class com.threerings.stage.tools.editor.EditorApp +
Given a subdirectory name (that should correspond to the calling service), returns a file + path that can be used to store local data. +
Location - Interface in com.threerings.whirled.spot.data
 
LOCATION_CLICKED - +Static variable in class com.threerings.stage.client.StageScenePanel +
An action command generated when the user clicks on a location within the scene. +
LOCATION_OCCUPIED - +Static variable in interface com.threerings.whirled.spot.data.SpotCodes +
An error code indicating that a location is occupied. +
locationForObject(TileManager, ObjectInfo) - +Static method in class com.threerings.stage.util.StageSceneUtil +
Does the necessary jiggery pokery to figure out where the specified object's associated + location is. +
locationForObject(TileManager, ObjectInfo, int) - +Static method in class com.threerings.stage.util.StageSceneUtil +
Does the necessary jiggery pokery to figure out where the specified object's associated + location is. +
locationForObject(TileManager, int, int, int) - +Static method in class com.threerings.stage.util.StageSceneUtil +
Does the necessary jiggery pokery to figure out where the specified object's associated + location is. +
locationForObject(TileManager, int, int, int, int) - +Static method in class com.threerings.stage.util.StageSceneUtil +
Does the necessary jiggery pokery to figure out where the specified object's associated + location is. +
locationToCoords(int, int, Point) - +Static method in class com.threerings.stage.util.StageSceneUtil +
Converts full coordinates to Cartesian coordinates. +
Log - Class in com.threerings.micasa
Contains a reference to the log object used by the MiCasa package.
Log() - +Constructor for class com.threerings.micasa.Log +
  +
log - +Static variable in class com.threerings.micasa.Log +
The static log instance configured for use by this package. +
Log - Class in com.threerings.parlor.card
Contains a reference to the log object used by the Card services.
Log() - +Constructor for class com.threerings.parlor.card.Log +
  +
log - +Static variable in class com.threerings.parlor.card.Log +
  +
Log - Class in com.threerings.parlor
Contains a reference to the log object used by the Parlor services.
Log() - +Constructor for class com.threerings.parlor.Log +
  +
log - +Static variable in class com.threerings.parlor.Log +
We dispatch our log messages through this logger. +
Log - Class in com.threerings.puzzle
Contains a reference to the log object used by this package.
Log() - +Constructor for class com.threerings.puzzle.Log +
  +
log - +Static variable in class com.threerings.puzzle.Log +
  +
Log - Class in com.threerings.stage
Contains a reference to the log object used by this package.
Log() - +Constructor for class com.threerings.stage.Log +
  +
log - +Static variable in class com.threerings.stage.Log +
  +
Log - Class in com.threerings.stats
A placeholder class that contains a reference to the log object used by this project.
Log() - +Constructor for class com.threerings.stats.Log +
  +
log - +Static variable in class com.threerings.stats.Log +
We dispatch our log messages through this logger. +
Log - Class in com.threerings.whirled
Contains a reference to the log object used by the Whirled services.
Log() - +Constructor for class com.threerings.whirled.Log +
  +
log - +Static variable in class com.threerings.whirled.Log +
  +
Log - Class in com.threerings.whirled.spot
Contains a reference to the log object used by the Whirled Spot services.
Log() - +Constructor for class com.threerings.whirled.spot.Log +
  +
log - +Static variable in class com.threerings.whirled.spot.Log +
  +
Log - Class in com.threerings.whirled.zone
Contains a reference to the log object used by the Whirled Zone services.
Log() - +Constructor for class com.threerings.whirled.zone.Log +
  +
log - +Static variable in class com.threerings.whirled.zone.Log +
  +
logic - +Variable in class com.threerings.parlor.tourney.data.TourneyConfig +
The tournament logic runtime persistent data. +
LOGOFF - +Static variable in class com.threerings.micasa.simulator.client.SimulatorController +
Command constant used to logoff the client. +
LogonPanel - Class in com.threerings.micasa.client
 
LogonPanel(MiCasaContext) - +Constructor for class com.threerings.micasa.client.LogonPanel +
  +
+
+

+M

+
+
main(String[]) - +Static method in class com.threerings.micasa.client.MiCasaApp +
  +
main(String[]) - +Static method in class com.threerings.micasa.server.MiCasaServer +
  +
main(String[]) - +Static method in class com.threerings.micasa.simulator.client.SimulatorApp +
  +
main(String[]) - +Static method in class com.threerings.stage.tools.editor.EditorApp +
Instantiate the application object and start it running. +
main(String[]) - +Static method in class com.threerings.stage.tools.viewer.ViewerApp +
Instantiate the application object and start it running. +
main(String[]) - +Static method in class com.threerings.stage.tools.xml.StageSceneParser +
A simple hook for parsing a single scene from the command line. +
mapEnteringBody(BodyObject, Portal) - +Method in class com.threerings.whirled.spot.server.SpotSceneManager +
Assigns a starting location for an entering body. +
MAX_CODE - +Static variable in class com.threerings.stats.server.persist.MaxStatCodeRecord +
  +
maxCode - +Variable in class com.threerings.stats.server.persist.MaxStatCodeRecord +
  +
maximum - +Variable in class com.threerings.parlor.data.RangeParameter +
The maximum value of this parameter. +
MAXIMUM_RATING - +Static variable in interface com.threerings.parlor.rating.data.RatingCodes +
The maximum rating value. +
MaxIntStat - Class in com.threerings.stats.data
Extends the IntStat by maintaining a maximum value which is updated every time a value + is accumulated to the stat.
MaxIntStat() - +Constructor for class com.threerings.stats.data.MaxIntStat +
  +
maxStat(Stat.Type, int) - +Method in class com.threerings.stats.data.StatSet +
Sets an integer stat to the specified value, if it exceeds our existing recorded value. +
MaxStatCodeRecord - Class in com.threerings.stats.server.persist
 
MaxStatCodeRecord() - +Constructor for class com.threerings.stats.server.persist.MaxStatCodeRecord +
  +
MaxValueIntStat - Class in com.threerings.stats.data
Extends the IntStat by maintaining the maximum value that the stat has ever been + assigned (unlike MaxIntStat, which tracks the maximum value that the stat has ever + been incremented by).
MaxValueIntStat() - +Constructor for class com.threerings.stats.data.MaxValueIntStat +
  +
mayBeStarted() - +Method in class com.threerings.parlor.data.Table +
Returns true if this table has a sufficient number of players that the game can be + started. +
mayLeavePlace(PlaceObject) - +Method in class com.threerings.puzzle.client.PuzzleController +
  +
mayStandAtLocation(BodyObject, StageLocation) - +Method in class com.threerings.stage.server.StageSceneManager +
Called by NPPs to determine whether or not they can stand at the + specified location. +
mayTraversePortal(BodyObject, Portal) - +Method in class com.threerings.whirled.spot.server.SpotSceneManager +
This is called when a user requests to traverse a portal from this scene to another scene. +
MiCasaApp - Class in com.threerings.micasa.client
The micasa app is the main point of entry for the MiCasa client application.
MiCasaApp() - +Constructor for class com.threerings.micasa.client.MiCasaApp +
  +
MiCasaApplet - Class in com.threerings.micasa.client
The MiCasa applet is used to make MiCasa games available via the web + browser.
MiCasaApplet() - +Constructor for class com.threerings.micasa.client.MiCasaApplet +
  +
MiCasaBootstrapData - Class in com.threerings.micasa.data
Extends the basic Presents bootstrap data and provides some bootstrap + information specific to the MiCasa services.
MiCasaBootstrapData() - +Constructor for class com.threerings.micasa.data.MiCasaBootstrapData +
  +
MiCasaClient - Class in com.threerings.micasa.client
The MiCasa client takes care of instantiating all of the proper + managers and loading up all of the necessary configuration and getting + the client bootstrapped.
MiCasaClient() - +Constructor for class com.threerings.micasa.client.MiCasaClient +
  +
MiCasaConfig - Class in com.threerings.micasa.server
Provides access to the MiCasa server configuration.
MiCasaConfig() - +Constructor for class com.threerings.micasa.server.MiCasaConfig +
  +
MiCasaContext - Interface in com.threerings.micasa.util
The micasa context encapsulates the contexts of all of the services + that are used by the micasa client so that we can pass around one + single context implementation that provides all of the necessary + components to all of the services in use.
MiCasaFrame - Class in com.threerings.micasa.client
Contains the user interface for the MiCasa client application.
MiCasaFrame() - +Constructor for class com.threerings.micasa.client.MiCasaFrame +
Constructs the top-level MiCasa client frame. +
MiCasaFrame(String) - +Constructor for class com.threerings.micasa.client.MiCasaFrame +
Constructs the top-level MiCasa client frame with the specified + window title. +
MiCasaServer - Class in com.threerings.micasa.server
The main general organizer of everything that goes on in the MiCasa game server process.
MiCasaServer() - +Constructor for class com.threerings.micasa.server.MiCasaServer +
  +
MiCasaSession - Class in com.threerings.micasa.server
Extends the Crowd session and provides bootstrap data specific to the MiCasa services.
MiCasaSession() - +Constructor for class com.threerings.micasa.server.MiCasaSession +
  +
MicroCardSprite - Class in com.threerings.parlor.card.client
 
MicroCardSprite(CardPanel, Card) - +Constructor for class com.threerings.parlor.card.client.MicroCardSprite +
Creates a new upward-facing micro-card sprite. +
MicroCardSprite(CardPanel, Card, boolean) - +Constructor for class com.threerings.parlor.card.client.MicroCardSprite +
Creates a new micro-card sprite. +
minimum - +Variable in class com.threerings.parlor.data.RangeParameter +
The minimum value of this parameter. +
MINIMUM_RATING - +Static variable in interface com.threerings.parlor.rating.data.RatingCodes +
The minimum rating value. +
minimumPlayerCount - +Variable in class com.threerings.parlor.data.TableConfig +
The minimum number of players needed overall (or per-team if a team-based game) for the + game to start at the creator's discretion. +
minPlayers - +Variable in class com.threerings.parlor.tourney.data.TourneyConfig +
The minimum number of players needed for the tourney to start. +
MOD_COUNT - +Static variable in class com.threerings.stats.server.persist.StatRecord +
  +
modCount - +Variable in class com.threerings.stats.server.persist.StatRecord +
The number of times this stat has been updated, so that simultaneous attempts to update + the same stat in the repository can be caught and handled. +
modelChanged(int) - +Method in interface com.threerings.stage.tools.editor.EditorModelListener +
Called by the EditorModel when the model is changed. +
modelChanged(int) - +Method in class com.threerings.stage.tools.editor.EditorScenePanel +
  +
modelChanged(int) - +Method in class com.threerings.stage.tools.editor.TileInfoPanel +
  +
modify(IntSetStat) - +Method in class com.threerings.stats.data.IntSetStatAdder +
  +
modify(IntStat) - +Method in class com.threerings.stats.data.IntStatIncrementer +
  +
modify(IntStat) - +Method in class com.threerings.stats.data.IntStatMinimumer +
  +
modify(T) - +Method in class com.threerings.stats.data.StatModifier +
Applies the modification to the stat in question. +
MODIFY_SCENE_ACCESS - +Static variable in interface com.threerings.stage.data.StageCodes +
The access control identifier for scene modification privileges. +
ModifyObjectsUpdate - Class in com.threerings.stage.data
A scene update that is broadcast when objects have been added to or removed + from the scene.
ModifyObjectsUpdate() - +Constructor for class com.threerings.stage.data.ModifyObjectsUpdate +
  +
ModifyPortalsUpdate - Class in com.threerings.whirled.spot.data
A scene update to add/remove portals.
ModifyPortalsUpdate() - +Constructor for class com.threerings.whirled.spot.data.ModifyPortalsUpdate +
  +
mouseDragged(MouseEvent) - +Method in class com.threerings.stage.tools.editor.EditorScenePanel +
  +
mouseDragged(MouseEvent) - +Method in class com.threerings.stage.tools.editor.PortalTool +
When the mouse is dragged we update the current portal. +
mouseExited(MouseEvent) - +Method in class com.threerings.stage.tools.editor.EditorScenePanel +
  +
mouseMoved(MouseEvent) - +Method in class com.threerings.stage.tools.editor.EditorScenePanel +
  +
mousePressed(MouseEvent) - +Method in class com.threerings.stage.tools.editor.EditorScenePanel +
  +
mousePressed(MouseEvent) - +Method in class com.threerings.stage.tools.viewer.ViewerScenePanel +
  +
mouseReleased(MouseEvent) - +Method in class com.threerings.stage.tools.editor.EditorScenePanel +
  +
mouseReleased(MouseEvent) - +Method in class com.threerings.stage.tools.editor.PortalTool +
If button1 is released, we store the new portal, if button3: we + cancel. +
MOVE_BLOCK_LEFT - +Static variable in class com.threerings.puzzle.drop.client.DropControllerDelegate +
The action command for moving the block to the left. +
MOVE_BLOCK_RIGHT - +Static variable in class com.threerings.puzzle.drop.client.DropControllerDelegate +
The action command for moving the block to the right. +
MOVE_REQUIRES_SERVER_SWITCH - +Static variable in class com.threerings.whirled.data.SceneMarshaller.SceneMoveMarshaller +
The method id used to dispatch SceneMarshaller.SceneMoveMarshaller.moveRequiresServerSwitch(java.lang.String, int[]) + responses. +
MOVE_REQUIRES_SERVER_SWITCH - +Static variable in class com.threerings.whirled.spot.data.SpotMarshaller.SpotSceneMoveMarshaller +
The method id used to dispatch SpotMarshaller.SpotSceneMoveMarshaller.moveRequiresServerSwitch(java.lang.String, int[]) + responses. +
MOVE_REQUIRES_SERVER_SWITCH - +Static variable in class com.threerings.whirled.zone.data.ZoneMarshaller.ZoneMoveMarshaller +
The method id used to dispatch ZoneMarshaller.ZoneMoveMarshaller.moveRequiresServerSwitch(java.lang.String, int[]) + responses. +
MOVE_SUCCEEDED - +Static variable in class com.threerings.whirled.data.SceneMarshaller.SceneMoveMarshaller +
The method id used to dispatch SceneMarshaller.SceneMoveMarshaller.moveSucceeded(int, com.threerings.crowd.data.PlaceConfig) + responses. +
MOVE_SUCCEEDED - +Static variable in class com.threerings.whirled.spot.data.SpotMarshaller.SpotSceneMoveMarshaller +
The method id used to dispatch SpotMarshaller.SpotSceneMoveMarshaller.moveSucceeded(int, com.threerings.crowd.data.PlaceConfig) + responses. +
MOVE_SUCCEEDED - +Static variable in class com.threerings.whirled.zone.data.ZoneMarshaller.ZoneMoveMarshaller +
The method id used to dispatch ZoneMarshaller.ZoneMoveMarshaller.moveSucceeded(int, com.threerings.crowd.data.PlaceConfig, com.threerings.whirled.zone.data.ZoneSummary) + responses. +
MOVE_SUCCEEDED_WITH_SCENE - +Static variable in class com.threerings.whirled.data.SceneMarshaller.SceneMoveMarshaller +
The method id used to dispatch SceneMarshaller.SceneMoveMarshaller.moveSucceededWithScene(int, com.threerings.crowd.data.PlaceConfig, com.threerings.whirled.data.SceneModel) + responses. +
MOVE_SUCCEEDED_WITH_SCENE - +Static variable in class com.threerings.whirled.spot.data.SpotMarshaller.SpotSceneMoveMarshaller +
The method id used to dispatch SpotMarshaller.SpotSceneMoveMarshaller.moveSucceededWithScene(int, com.threerings.crowd.data.PlaceConfig, com.threerings.whirled.data.SceneModel) + responses. +
MOVE_SUCCEEDED_WITH_SCENE - +Static variable in class com.threerings.whirled.zone.data.ZoneMarshaller.ZoneMoveMarshaller +
The method id used to dispatch ZoneMarshaller.ZoneMoveMarshaller.moveSucceededWithScene(int, com.threerings.crowd.data.PlaceConfig, com.threerings.whirled.zone.data.ZoneSummary, com.threerings.whirled.data.SceneModel) + responses. +
MOVE_SUCCEEDED_WITH_UPDATES - +Static variable in class com.threerings.whirled.data.SceneMarshaller.SceneMoveMarshaller +
The method id used to dispatch SceneMarshaller.SceneMoveMarshaller.moveSucceededWithUpdates(int, com.threerings.crowd.data.PlaceConfig, com.threerings.whirled.data.SceneUpdate[]) + responses. +
MOVE_SUCCEEDED_WITH_UPDATES - +Static variable in class com.threerings.whirled.spot.data.SpotMarshaller.SpotSceneMoveMarshaller +
The method id used to dispatch SpotMarshaller.SpotSceneMoveMarshaller.moveSucceededWithUpdates(int, com.threerings.crowd.data.PlaceConfig, com.threerings.whirled.data.SceneUpdate[]) + responses. +
MOVE_SUCCEEDED_WITH_UPDATES - +Static variable in class com.threerings.whirled.zone.data.ZoneMarshaller.ZoneMoveMarshaller +
The method id used to dispatch ZoneMarshaller.ZoneMoveMarshaller.moveSucceededWithUpdates(int, com.threerings.crowd.data.PlaceConfig, com.threerings.whirled.zone.data.ZoneSummary, com.threerings.whirled.data.SceneUpdate[]) + responses. +
MOVE_TO - +Static variable in class com.threerings.whirled.data.SceneMarshaller +
The method id used to dispatch SceneMarshaller.moveTo(int, int, com.threerings.whirled.client.SceneService.SceneMoveListener) requests. +
MOVE_TO - +Static variable in class com.threerings.whirled.zone.data.ZoneMarshaller +
The method id used to dispatch ZoneMarshaller.moveTo(int, int, int, com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener) requests. +
moveBody(BodyObject, int) - +Method in class com.threerings.whirled.server.SceneRegistry +
Ejects the specified body from their current scene and sends them a request to move to the + specified new scene. +
moveBody(ZonedBodyObject, int, int) - +Method in class com.threerings.whirled.zone.server.ZoneRegistry +
Ejects the specified body from their current scene and sends them a request to move to the + specified new zone and scene. +
moveBodyToDefaultPortal(PlaceRegistry, BodyObject) - +Static method in class com.threerings.whirled.spot.server.SpotSceneManager +
Move the specified body to the default portal, if possible. +
movePending() - +Method in class com.threerings.whirled.client.SceneDirector +
Returns true if there is a pending move request. +
movePiece(int, int, int, int, long) - +Method in class com.threerings.puzzle.drop.client.DropBoardView +
Instructs the view to move the piece at the specified starting position to the specified + destination position. +
moveRequiresServerSwitch(String, int[]) - +Method in class com.threerings.whirled.client.SceneDirector +
  +
moveRequiresServerSwitch(String, int[]) - +Method in class com.threerings.whirled.client.SceneMoveAdapter +
  +
moveRequiresServerSwitch(String, int[]) - +Method in interface com.threerings.whirled.client.SceneService.SceneMoveListener +
Indicates that the client must switch to the specified server and reissue its move + request in order to relocate to its desired scene. +
moveRequiresServerSwitch(String, int[]) - +Method in class com.threerings.whirled.data.SceneMarshaller.SceneMoveMarshaller +
  +
moveRequiresServerSwitch(String, int[]) - +Method in class com.threerings.whirled.spot.data.SpotMarshaller.SpotSceneMoveMarshaller +
  +
moveRequiresServerSwitch(String, int[]) - +Method in class com.threerings.whirled.zone.client.ZoneDirector +
  +
moveRequiresServerSwitch(String, int[]) - +Method in interface com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener +
Indicates that the client must switch to the specified server and reissue its move + request in order to relocate to its desired zone. +
moveRequiresServerSwitch(String, int[]) - +Method in class com.threerings.whirled.zone.data.ZoneMarshaller.ZoneMoveMarshaller +
  +
moveSucceeded(int, PlaceConfig) - +Method in class com.threerings.whirled.client.SceneDirector +
  +
moveSucceeded(int, PlaceConfig) - +Method in class com.threerings.whirled.client.SceneMoveAdapter +
  +
moveSucceeded(int, PlaceConfig) - +Method in interface com.threerings.whirled.client.SceneService.SceneMoveListener +
Indicates that a move succeeded. +
moveSucceeded(int, PlaceConfig) - +Method in class com.threerings.whirled.data.SceneMarshaller.SceneMoveMarshaller +
  +
moveSucceeded(int, PlaceConfig) - +Method in class com.threerings.whirled.spot.data.SpotMarshaller.SpotSceneMoveMarshaller +
  +
moveSucceeded(int, PlaceConfig, ZoneSummary) - +Method in class com.threerings.whirled.zone.client.ZoneDirector +
  +
moveSucceeded(int, PlaceConfig, ZoneSummary) - +Method in interface com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener +
Called in response to a successful ZoneService.moveTo(int, int, int, com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener) request. +
moveSucceeded(int, PlaceConfig, ZoneSummary) - +Method in class com.threerings.whirled.zone.data.ZoneMarshaller.ZoneMoveMarshaller +
  +
moveSucceededWithScene(int, PlaceConfig, SceneModel) - +Method in class com.threerings.whirled.client.SceneDirector +
  +
moveSucceededWithScene(int, PlaceConfig, SceneModel) - +Method in class com.threerings.whirled.client.SceneMoveAdapter +
  +
moveSucceededWithScene(int, PlaceConfig, SceneModel) - +Method in interface com.threerings.whirled.client.SceneService.SceneMoveListener +
Indicates that a move succeeded and that the client's cached scene information should be + updated with the supplied data. +
moveSucceededWithScene(int, PlaceConfig, SceneModel) - +Method in class com.threerings.whirled.data.SceneMarshaller.SceneMoveMarshaller +
  +
moveSucceededWithScene(int, PlaceConfig, SceneModel) - +Method in class com.threerings.whirled.spot.data.SpotMarshaller.SpotSceneMoveMarshaller +
  +
moveSucceededWithScene(int, PlaceConfig, ZoneSummary, SceneModel) - +Method in class com.threerings.whirled.zone.client.ZoneDirector +
  +
moveSucceededWithScene(int, PlaceConfig, ZoneSummary, SceneModel) - +Method in interface com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener +
Called in response to a successful ZoneService.moveTo(int, int, int, com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener) request when our cached + scene was out of date and the server determined that we needed an updated copy. +
moveSucceededWithScene(int, PlaceConfig, ZoneSummary, SceneModel) - +Method in class com.threerings.whirled.zone.data.ZoneMarshaller.ZoneMoveMarshaller +
  +
moveSucceededWithUpdates(int, PlaceConfig, SceneUpdate[]) - +Method in class com.threerings.whirled.client.SceneDirector +
  +
moveSucceededWithUpdates(int, PlaceConfig, SceneUpdate[]) - +Method in class com.threerings.whirled.client.SceneMoveAdapter +
  +
moveSucceededWithUpdates(int, PlaceConfig, SceneUpdate[]) - +Method in interface com.threerings.whirled.client.SceneService.SceneMoveListener +
Indicates that a move succeeded and that the client's cached scene information should be + updated with the supplied data. +
moveSucceededWithUpdates(int, PlaceConfig, SceneUpdate[]) - +Method in class com.threerings.whirled.data.SceneMarshaller.SceneMoveMarshaller +
  +
moveSucceededWithUpdates(int, PlaceConfig, SceneUpdate[]) - +Method in class com.threerings.whirled.spot.data.SpotMarshaller.SpotSceneMoveMarshaller +
  +
moveSucceededWithUpdates(int, PlaceConfig, ZoneSummary, SceneUpdate[]) - +Method in class com.threerings.whirled.zone.client.ZoneDirector +
  +
moveSucceededWithUpdates(int, PlaceConfig, ZoneSummary, SceneUpdate[]) - +Method in interface com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener +
Called in response to a successful ZoneService.moveTo(int, int, int, com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener) request when our cached + scene was out of date and the server determined that we needed some updates. +
moveSucceededWithUpdates(int, PlaceConfig, ZoneSummary, SceneUpdate[]) - +Method in class com.threerings.whirled.zone.data.ZoneMarshaller.ZoneMoveMarshaller +
  +
moveTo(int) - +Method in class com.threerings.whirled.client.SceneDirector +
Requests that this client move the specified scene. +
moveTo(int, int, SceneService.SceneMoveListener) - +Method in interface com.threerings.whirled.client.SceneService +
Requests that that this client's body be moved to the specified scene. +
moveTo(int, int, SceneService.SceneMoveListener) - +Method in class com.threerings.whirled.data.SceneMarshaller +
  +
moveTo(ClientObject, int, int, SceneService.SceneMoveListener) - +Method in interface com.threerings.whirled.server.SceneProvider +
Handles a SceneService.moveTo(int, int, com.threerings.whirled.client.SceneService.SceneMoveListener) request. +
moveTo(ClientObject, int, int, SceneService.SceneMoveListener) - +Method in class com.threerings.whirled.server.SceneRegistry +
  +
moveTo(int, int) - +Method in class com.threerings.whirled.zone.client.ZoneDirector +
Requests that this client move the specified scene in the specified zone. +
moveTo(int, int, ResultListener<PlaceConfig>) - +Method in class com.threerings.whirled.zone.client.ZoneDirector +
Requests that this client move the specified scene in the specified zone. +
moveTo(int, int, int, ZoneService.ZoneMoveListener) - +Method in interface com.threerings.whirled.zone.client.ZoneService +
Requests that that this client's body be moved to the specified scene in the specified zone. +
moveTo(int, int, int, ZoneService.ZoneMoveListener) - +Method in class com.threerings.whirled.zone.data.ZoneMarshaller +
  +
moveTo(ClientObject, int, int, int, ZoneService.ZoneMoveListener) - +Method in class com.threerings.whirled.zone.peer.server.PeeredZoneRegistry +
  +
moveTo(ClientObject, int, int, int, ZoneService.ZoneMoveListener) - +Method in interface com.threerings.whirled.zone.server.ZoneProvider +
Handles a ZoneService.moveTo(int, int, int, com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener) request. +
moveTo(ClientObject, int, int, int, ZoneService.ZoneMoveListener) - +Method in class com.threerings.whirled.zone.server.ZoneRegistry +
  +
MULTIPLE - +Static variable in class com.threerings.parlor.card.client.CardPanel +
The selection mode in which the user can select multiple cards. +
MUST_BE_CREATOR - +Static variable in interface com.threerings.parlor.data.ParlorCodes +
An error code returned by the table services. +
MUTILATE_SCENE_ACCESS - +Static variable in interface com.threerings.stage.data.StageCodes +
The access control identifier for potentially damaging scene modification privileges. +
+
+

+N

+
+
name - +Variable in class com.threerings.micasa.lobby.Lobby +
The human readable name of the lobby. +
name - +Variable in class com.threerings.parlor.data.Parameter +
A human readable name for this configuration parameter. +
name() - +Method in interface com.threerings.stats.data.Stat.Type +
Returns the enum name of stat. +
name - +Variable in class com.threerings.whirled.data.SceneModel +
The human readable name of this scene. +
name - +Variable in class com.threerings.whirled.spot.tools.EditablePortal +
The human-readable name of this portal. +
name - +Variable in class com.threerings.whirled.zone.data.SceneSummary +
The name of this scene. +
name - +Variable in class com.threerings.whirled.zone.data.ZoneSummary +
The name of the zone. +
name - +Variable in class com.threerings.whirled.zone.peer.data.HostedZone +
The name of the zone being hosted. +
needsBoardSummaries() - +Method in class com.threerings.puzzle.server.PuzzleManager +
Returns whether this puzzle cares to make use of per-player board summaries that are sent + periodically to all users in the puzzle via PuzzleManager.sendStatusUpdate(). +
needsPaint() - +Method in class com.threerings.puzzle.drop.client.DropControllerDelegate +
  +
neighborDirs - +Variable in class com.threerings.whirled.zone.data.SceneSummary +
The directions in which each of the neighbors lay. +
neighbors - +Variable in class com.threerings.whirled.zone.data.SceneSummary +
The ids of the scenes to which this scene is connected via + portals. +
newStat() - +Method in interface com.threerings.stats.data.Stat.Type +
Returns a new blank stat instance of the specified type. +
NextBlockView - Class in com.threerings.puzzle.drop.client
The next block view displays an image representing the next drop block to appear in the game.
NextBlockView(DropBoardView, int, int, int) - +Constructor for class com.threerings.puzzle.drop.client.NextBlockView +
Constructs a next block view. +
NO_REQUEST - +Static variable in interface com.threerings.parlor.card.trick.data.TrickCardGameObject +
Indicates that the player has not requested or accepted a rematch. +
NO_RESTART_ACTION - +Static variable in interface com.threerings.puzzle.client.PuzzleController.ClearPender +
PuzzleController.ClearPender.actionCleared() return code. +
NO_SELF_BOOT - +Static variable in interface com.threerings.parlor.data.ParlorCodes +
An error code returned by the table services. +
NO_SUCH_CLUSTER - +Static variable in interface com.threerings.whirled.spot.data.SpotCodes +
An error code indicating that a cluster is not valid. +
NO_SUCH_PORTAL - +Static variable in interface com.threerings.whirled.spot.data.SpotCodes +
An error code indicating that the portal specified in a + traversePortal request does not exist. +
NO_SUCH_TABLE - +Static variable in interface com.threerings.parlor.data.ParlorCodes +
An error code returned by the table services. +
NO_SUCH_ZONE - +Static variable in interface com.threerings.whirled.zone.data.ZoneCodes +
An error code indicating that a zone identified by a particular + zone id does not exist. +
NONE - +Static variable in class com.threerings.parlor.card.client.CardPanel +
The selection mode in which cards are not selectable. +
NoSuchSceneException - Exception in com.threerings.whirled.util
Thrown when an attempt to load a non-existent scene is made on the + repository.
NoSuchSceneException(int) - +Constructor for exception com.threerings.whirled.util.NoSuchSceneException +
  +
NOT_AT_TABLE - +Static variable in interface com.threerings.parlor.data.ParlorCodes +
An error code returned by the table services when a user requests to leave a table that + they were not sitting at in the first place. +
NOT_IN_TOURNEY - +Static variable in interface com.threerings.parlor.tourney.data.TourneyCodes +
User is not in the tourney. +
notifyAllParticipants(String) - +Method in class com.threerings.parlor.tourney.server.TourneyManager +
  +
NUM_ACTIONS - +Static variable in class com.threerings.stage.tools.editor.EditorModel +
The number of actions. +
+
+

+O

+
+
OBJECT_LAYER - +Static variable in class com.threerings.stage.tools.editor.EditorModel +
  +
OBJECT_ORIENTATION - +Static variable in class com.threerings.stage.util.StageSceneUtil +
Value to pass to StageSceneUtil.locationForObject(TileManager, ObjectInfo, int) and + StageSceneUtil.locationForObject(TileManager, int, int, int, int)for orientation to indicate it + should use the object's orientation. +
objectAvailable(DObject) - +Method in class com.threerings.whirled.spot.client.SpotSceneDirector +
  +
ObjectEditorDialog - Class in com.threerings.stage.tools.editor
Used to edit object attributes.
ObjectEditorDialog(EditorContext, EditorScenePanel) - +Constructor for class com.threerings.stage.tools.editor.ObjectEditorDialog +
  +
OCCUPANT_LOCS - +Static variable in class com.threerings.whirled.spot.data.SpotSceneObject +
The field name of the occupantLocs field. +
occupantEntered(OccupantInfo) - +Method in class com.threerings.micasa.client.ChatPanel +
  +
occupantEntered(OccupantInfo) - +Method in class com.threerings.micasa.client.OccupantList +
  +
occupantInRoom(BodyObject) - +Method in class com.threerings.parlor.game.server.GameManager +
Called by the client when an occupant has arrived in the game room and has loaded their + bits. +
occupantLeft(OccupantInfo) - +Method in class com.threerings.micasa.client.ChatPanel +
  +
occupantLeft(OccupantInfo) - +Method in class com.threerings.micasa.client.OccupantList +
  +
OccupantList - Class in com.threerings.micasa.client
The occupant list displays the list of users that are in a particular + place.
OccupantList(CrowdContext) - +Constructor for class com.threerings.micasa.client.OccupantList +
Constructs an occupant list with the supplied context which it will + use to register itself with the necessary managers. +
occupantLocs - +Variable in class com.threerings.whirled.spot.data.SpotSceneObject +
A distributed set containing SceneLocation records for all + occupants of this scene. +
OCCUPANTS - +Static variable in class com.threerings.whirled.spot.data.ClusterObject +
The field name of the occupants field. +
occupants - +Variable in class com.threerings.whirled.spot.data.ClusterObject +
Tracks the oid of the body objects that occupy this cluster. +
occupantUpdated(OccupantInfo, OccupantInfo) - +Method in class com.threerings.micasa.client.ChatPanel +
  +
occupantUpdated(OccupantInfo, OccupantInfo) - +Method in class com.threerings.micasa.client.OccupantList +
  +
openScene(String) - +Method in class com.threerings.stage.tools.editor.EditorFrame +
Loads the scene from the specified path into the editor and displays an error dialog if it + fails. +
openScene(ActionEvent) - +Method in class com.threerings.stage.tools.viewer.ViewerFrame +
Callback for opening a new scene. +
opponent - +Variable in class com.threerings.parlor.client.Invitation +
The name of the other user involved in this invitation. +
orient - +Variable in class com.threerings.stage.data.StageLocation +
The user's orientation (defined by DirectionCodes). +
orientToString() - +Method in class com.threerings.stage.data.StageLocation +
Object.toString() helper function. +
OUTER_ELEMENT - +Static variable in class com.threerings.whirled.spot.tools.xml.SpotSceneWriter +
The outer element used to enclose our spot scene definition. +
OUTER_ELEMENT - +Static variable in class com.threerings.whirled.tools.xml.SceneWriter +
The outer element used to enclose our scene definition. +
+
+

+P

+
+
paint(Graphics2D) - +Method in class com.threerings.parlor.card.client.CardSprite +
  +
paint(Graphics2D) - +Method in class com.threerings.puzzle.drop.client.DropSprite +
  +
paint(Graphics2D) - +Method in class com.threerings.puzzle.drop.client.PieceGroupAnimation +
  +
paint(Graphics) - +Method in class com.threerings.stage.tools.viewer.ViewerScenePanel +
  +
paintBehind(Graphics2D, Rectangle) - +Method in class com.threerings.puzzle.client.PuzzleBoardView +
  +
paintBetween(Graphics2D, Rectangle) - +Method in class com.threerings.puzzle.client.PuzzleBoardView +
  +
paintBetween(Graphics2D, Rectangle) - +Method in class com.threerings.puzzle.drop.client.DropBoardView +
  +
paintComponent(Graphics) - +Method in class com.threerings.puzzle.drop.client.NextBlockView +
  +
paintComponent(Graphics) - +Method in class com.threerings.stage.tools.editor.DirectionButton +
Paint this component and the selected direction, + dimmed if we're inactive. +
paintExtras(Graphics2D) - +Method in class com.threerings.stage.tools.editor.PortalTool +
Paint what the clusters would look like if we were to add them to + the scene. +
paintExtras(Graphics2D) - +Method in interface com.threerings.stage.tools.editor.util.ExtrasPainter +
  +
Parameter - Class in com.threerings.parlor.data
Defines a configuration parameter for a game.
Parameter() - +Constructor for class com.threerings.parlor.data.Parameter +
  +
PARLOR_GROUP - +Static variable in interface com.threerings.parlor.data.ParlorCodes +
Defines our invocation services group. +
ParlorCodes - Interface in com.threerings.parlor.data
Contains codes used by the parlor invocation services.
ParlorContext - Interface in com.threerings.parlor.util
The parlor context provides access to the various managers, etc.
ParlorDecoder - Class in com.threerings.parlor.client
Dispatches calls to a ParlorReceiver instance.
ParlorDecoder(ParlorReceiver) - +Constructor for class com.threerings.parlor.client.ParlorDecoder +
Creates a decoder that may be registered to dispatch invocation + service notifications to the specified receiver. +
ParlorDirector - Class in com.threerings.parlor.client
The parlor director manages the client side of the game configuration and matchmaking + processes.
ParlorDirector(ParlorContext) - +Constructor for class com.threerings.parlor.client.ParlorDirector +
Constructs a parlor director and provides it with the parlor context that it can use to + access the client services that it needs to provide its own services. +
ParlorManager - Class in com.threerings.parlor.server
The parlor manager is responsible for the parlor services in aggregate.
ParlorManager(InvocationManager) - +Constructor for class com.threerings.parlor.server.ParlorManager +
  +
ParlorMarshaller - Class in com.threerings.parlor.data
Provides the implementation of the ParlorService interface + that marshalls the arguments and delivers the request to the provider + on the server.
ParlorMarshaller() - +Constructor for class com.threerings.parlor.data.ParlorMarshaller +
  +
ParlorMarshaller.InviteMarshaller - Class in com.threerings.parlor.data
Marshalls results to implementations of ParlorService.InviteListener.
ParlorMarshaller.InviteMarshaller() - +Constructor for class com.threerings.parlor.data.ParlorMarshaller.InviteMarshaller +
  +
ParlorProvider - Interface in com.threerings.parlor.server
Defines the server-side of the ParlorService.
ParlorReceiver - Interface in com.threerings.parlor.client
Defines, for the parlor services, a set of notifications delivered + asynchronously by the server to the client.
ParlorSender - Class in com.threerings.parlor.server
Used to issue notifications to a ParlorReceiver instance on a + client.
ParlorSender() - +Constructor for class com.threerings.parlor.server.ParlorSender +
  +
ParlorService - Interface in com.threerings.parlor.client
Provides an interface to the various parlor invocation services.
ParlorService.InviteListener - Interface in com.threerings.parlor.client
Used to communicate responses to ParlorService.invite(com.threerings.util.Name, com.threerings.parlor.game.data.GameConfig, com.threerings.parlor.client.ParlorService.InviteListener) requests.
parseScene(String) - +Method in class com.threerings.whirled.tools.xml.SceneParser +
Parses the XML file at the specified path into a scene model + instance. +
Participant - Class in com.threerings.parlor.tourney.data
Contains information on a particular tourney participant.
Participant() - +Constructor for class com.threerings.parlor.tourney.data.Participant +
  +
PARTICIPANTS - +Static variable in class com.threerings.parlor.tourney.data.TourneyObject +
The field name of the participants field. +
participants - +Variable in class com.threerings.parlor.tourney.data.TourneyObject +
A DSet that accumulates Participant records for the players involved in this tourney. +
PARTY - +Static variable in class com.threerings.parlor.game.data.GameConfig +
Matchmaking type constant: a game that starts immediately, and every user that enters is a + player. +
pathCancelled(Sprite, Path) - +Method in class com.threerings.puzzle.drop.client.PieceGroupAnimation +
  +
pathCancelled(Sprite, Path) - +Method in class com.threerings.stage.tools.viewer.ViewerScenePanel +
  +
pathCompleted(Sprite, Path, long) - +Method in class com.threerings.puzzle.drop.client.PieceGroupAnimation +
  +
pathCompleted(Sprite, Path, long) - +Method in class com.threerings.stage.tools.viewer.ViewerScenePanel +
  +
PAUSED - +Static variable in class com.threerings.parlor.tourney.data.TourneyObject +
Tourney is paused. +
PeeredZoneManager - Interface in com.threerings.whirled.zone.peer.server
 
PeeredZoneRegistry - Class in com.threerings.whirled.zone.peer.server
 
PeeredZoneRegistry(InvocationManager, ZonePeerManager) - +Constructor for class com.threerings.whirled.zone.peer.server.PeeredZoneRegistry +
  +
PeeredZoneRegistry.PeerZoneMoveHandler - Class in com.threerings.whirled.zone.peer.server
A ZoneMoveHandler that can receive the sceneOnNode() callback.
PeeredZoneRegistry.PeerZoneMoveHandler(LocationManager, ZoneManager, SceneRegistry, BodyObject, int, int, ZoneService.ZoneMoveListener) - +Constructor for class com.threerings.whirled.zone.peer.server.PeeredZoneRegistry.PeerZoneMoveHandler +
  +
PeeredZoneRegistry.PeerZoneResolutionListener - Interface in com.threerings.whirled.zone.peer.server
Peer-awareness for finding out about zones.
PeeredZoneRegistry.PeerZoneShutdownListener - Interface in com.threerings.whirled.zone.peer.server
Peered zones should be sure to call back to one of these when they're going away.
PENDING - +Static variable in class com.threerings.parlor.tourney.data.TourneyObject +
Tourney is pending and accepting participants. +
Percentiler - Class in com.threerings.parlor.rating.util
Used to keep track of the percentile distribution of positive values (generally puzzle scores).
Percentiler() - +Constructor for class com.threerings.parlor.rating.util.Percentiler +
Creates an empty percentiler. +
Percentiler(int, int) - +Constructor for class com.threerings.parlor.rating.util.Percentiler +
Creates a percentiler that expects values to fall within the given range. +
Percentiler(byte[]) - +Constructor for class com.threerings.parlor.rating.util.Percentiler +
Creates a percentiler from its serialized representation. +
PercentileRecord - Class in com.threerings.parlor.rating.server.persist
Contains data for a Percentiler record.
PercentileRecord() - +Constructor for class com.threerings.parlor.rating.server.persist.PercentileRecord +
  +
persistTo(ObjectOutputStream, Stat.AuxDataSource) - +Method in class com.threerings.stats.data.ByteByteStringMapStat +
  +
persistTo(ObjectOutputStream, Stat.AuxDataSource) - +Method in class com.threerings.stats.data.ByteStringSetStat +
  +
persistTo(ObjectOutputStream, Stat.AuxDataSource) - +Method in class com.threerings.stats.data.IntArrayStat +
  +
persistTo(ObjectOutputStream, Stat.AuxDataSource) - +Method in class com.threerings.stats.data.IntSetStat +
  +
persistTo(ObjectOutputStream, Stat.AuxDataSource) - +Method in class com.threerings.stats.data.IntStat +
  +
persistTo(ObjectOutputStream, Stat.AuxDataSource) - +Method in class com.threerings.stats.data.IntStringSetStat +
  +
persistTo(ObjectOutputStream, Stat.AuxDataSource) - +Method in class com.threerings.stats.data.MaxIntStat +
  +
persistTo(ObjectOutputStream, Stat.AuxDataSource) - +Method in class com.threerings.stats.data.MaxValueIntStat +
  +
persistTo(ObjectOutputStream, Stat.AuxDataSource) - +Method in class com.threerings.stats.data.ShortStringSetStat +
  +
persistTo(ObjectOutputStream, Stat.AuxDataSource) - +Method in class com.threerings.stats.data.Stat +
Serializes this instance for storage in the item database. +
persistTo(ObjectOutputStream) - +Method in class com.threerings.whirled.data.SceneUpdate +
Serializes the bare representation of this instance without the scene id and version fields. +
persistUpdate(SceneUpdate) - +Method in class com.threerings.whirled.server.persist.SceneUpdateMarshaller +
Persists the specified update to a new ByteArrayOutInputStream. +
personality - +Variable in class com.threerings.parlor.game.data.GameAI +
The "personality" of the AI, which can be interpreted by + each puzzle. +
pidx - +Variable in class com.threerings.parlor.card.data.PlayerCard +
The index of the player. +
PIECE_NONE - +Static variable in interface com.threerings.puzzle.drop.data.DropPieceCodes +
The piece constant denoting an empty board piece. +
PieceDestroyer - Class in com.threerings.puzzle.drop.util
Handles destroying contiguous piece segments in a drop board.
PieceDestroyer(PieceDestroyer.DestroyLogic) - +Constructor for class com.threerings.puzzle.drop.util.PieceDestroyer +
Constructs a piece destroyer that destroys pieces as specified by the supplied destroy + logic. +
PieceDestroyer.DestroyLogic - Interface in com.threerings.puzzle.drop.util
An interface to be implemented by specific puzzles to detail the parameters and methodology + by which pieces are destroyed in the puzzle board.
PieceDropLogic - Interface in com.threerings.puzzle.drop.util
An interface to be implemented by games that would like to be able to drop their pieces during + game play.
pieceDropped(int, int, int, int, int) - +Method in interface com.threerings.puzzle.drop.util.PieceDropper.DropObserver +
Indicates that the specified piece was dropped. +
PieceDropper - Class in com.threerings.puzzle.drop.util
Handles dropping pieces in a board.
PieceDropper(PieceDropLogic) - +Constructor for class com.threerings.puzzle.drop.util.PieceDropper +
Constructs a piece dropper that uses the supplied piece drop logic to specialize itself for + a particular puzzle. +
PieceDropper.DropObserver - Interface in com.threerings.puzzle.drop.util
Called to inform a drop observer that a piece has been dropped.
PieceDropper.PieceDropInfo - Class in com.threerings.puzzle.drop.util
A class to hold information detailing the pieces to be dropped in a particular column.
PieceDropper.PieceDropInfo(int, int, int) - +Constructor for class com.threerings.puzzle.drop.util.PieceDropper.PieceDropInfo +
Constructs a piece drop info object. +
PieceGroupAnimation - Class in com.threerings.puzzle.drop.client
Animates all the pieces on a puzzle board doing some sort of global effect like all flying into + place or out into the ether.
PieceGroupAnimation(DropBoardView, DropBoard) - +Constructor for class com.threerings.puzzle.drop.client.PieceGroupAnimation +
Creates a piece group animation which must be initialized with a subsequent call to + AbstractMedia.init(AbstractMediaManager). +
pieceMoved(DropSprite, long, int, int) - +Method in interface com.threerings.puzzle.drop.client.DropSpriteObserver +
Called when the drop sprite has moved completely to the specified board coordinates. +
pieces - +Variable in class com.threerings.puzzle.drop.util.PieceDropper.PieceDropInfo +
The pieces to be dropped. +
PlacementConstraints - Class in com.threerings.stage.util
Maintains extra information on objects in a scene and checks proposed + placement operations for constraint violations.
PlacementConstraints(TileManager, StageScene) - +Constructor for class com.threerings.stage.util.PlacementConstraints +
Default constructor. +
placeOid - +Variable in class com.threerings.micasa.lobby.Lobby +
The object id of the lobby place object. +
PLAY_CARD - +Static variable in class com.threerings.parlor.card.trick.data.TrickCardGameMarshaller +
The method id used to dispatch TrickCardGameMarshaller.playCard(com.threerings.parlor.card.data.Card, int) requests. +
playCard(Card, int) - +Method in interface com.threerings.parlor.card.trick.client.TrickCardGameService +
Plays a card in the trick. +
playCard(Card, int) - +Method in class com.threerings.parlor.card.trick.data.TrickCardGameMarshaller +
  +
playCard(ClientObject, Card, int) - +Method in class com.threerings.parlor.card.trick.server.TrickCardGameManagerDelegate +
  +
playCard(ClientObject, Card, int) - +Method in interface com.threerings.parlor.card.trick.server.TrickCardGameProvider +
Handles a TrickCardGameService.playCard(com.threerings.parlor.card.data.Card, int) request. +
PLAYER_ID - +Static variable in class com.threerings.parlor.rating.server.persist.RatingRecord +
  +
PLAYER_ID - +Static variable in class com.threerings.stats.server.persist.StatRecord +
  +
PLAYER_IN_PLAY - +Static variable in class com.threerings.parlor.game.data.GameObject +
The player status constant for a player whose game is in play. +
PLAYER_KNOCKED_OUT - +Static variable in interface com.threerings.parlor.game.data.GameCodes +
The name of the message event to a placeObject that a player + was knocked out of a puzzle. +
PLAYER_LEFT_GAME - +Static variable in class com.threerings.parlor.game.data.GameObject +
The player status constant for a player whose has been knocked out of the game. +
PLAYER_STATUS - +Static variable in class com.threerings.parlor.game.data.GameObject +
The field name of the playerStatus field. +
PlayerCard - Class in com.threerings.parlor.card.data
Pairs a player index with the card that the player played in the trick.
PlayerCard() - +Constructor for class com.threerings.parlor.card.data.PlayerCard +
No-argument constructor for deserialization. +
PlayerCard(int, Card) - +Constructor for class com.threerings.parlor.card.data.PlayerCard +
Creates a new player card. +
playerCount - +Variable in class com.threerings.micasa.simulator.data.SimulatorInfo +
The number of players in the game. +
playerId - +Variable in class com.threerings.parlor.rating.server.persist.RatingRecord +
The identifier of the player we're rating. +
playerId - +Variable in class com.threerings.stats.server.persist.StatRecord +
The identifier of the player this is a stat for. +
playerIsReady(int) - +Method in class com.threerings.parlor.game.server.GameManager +
Returns true if the player at the specified slot is ready (or if there is meant to be no + player in that slot), false if there is meant to be a player in the specified slot and they + have not yet reported that they are ready. +
playerKnockedOut(int) - +Method in class com.threerings.puzzle.client.PuzzleControllerDelegate +
Called when a player is knocked out of the game. +
playerReady(BodyObject) - +Method in class com.threerings.parlor.game.server.GameManager +
Called by the client when the player is ready for the game to start. +
players - +Variable in class com.threerings.parlor.data.Table +
An array of the usernames of the players of this table (some slots may not be filled), or + null if a party game. +
players - +Variable in class com.threerings.parlor.game.data.GameConfig +
The usernames of the players involved in this game, or an empty array if such information + is not needed by this particular game. +
PLAYERS - +Static variable in class com.threerings.parlor.game.data.GameObject +
The field name of the players field. +
players - +Variable in class com.threerings.parlor.game.data.GameObject +
The usernames of the players involved in this game. +
playerStatus - +Variable in class com.threerings.parlor.game.data.GameObject +
If null, indicates that all present players are active, or for more complex games can be + non-null to indicate the current status of each player in the game. +
PlayerStatusView - Class in com.threerings.puzzle.client
The player status view displays a player's current status in the game.
PlayerStatusView(GameObject, int) - +Constructor for class com.threerings.puzzle.client.PlayerStatusView +
Constructs a player status view. +
playerWasReplaced(int, Name, Name) - +Method in class com.threerings.parlor.game.server.GameManagerDelegate +
Called when a player in the game has been replaced by a call to GameManager.replacePlayer(int, com.threerings.util.Name). +
playerWasReplaced(int, Name, Name) - +Method in class com.threerings.parlor.turn.server.TurnGameManagerDelegate +
  +
PLAYING_HAND - +Static variable in interface com.threerings.parlor.card.trick.data.TrickCardGameObject +
The state that indicates the game is currently playing a hand. +
PLAYING_TRICK - +Static variable in interface com.threerings.parlor.card.trick.data.TrickCardGameObject +
The state that indicates the game is currently playing a trick. +
PlayManager - Interface in com.threerings.parlor.server
An interface to be implemented by a PlaceManager that wishes to host + places that have players.
PlayManagerDelegate - Class in com.threerings.parlor.server
The base class for any delegate that wishes to service both GameManager + games and AVRGameManager games -- or, in fact, any PlaceManager + that implements PlayManager.
PlayManagerDelegate() - +Constructor for class com.threerings.parlor.server.PlayManagerDelegate +
  +
PointSet - Class in com.threerings.puzzle.util
The point set class provides an efficient implementation of a set containing two-dimensional + point values as (x, y).
PointSet(int, int) - +Constructor for class com.threerings.puzzle.util.PointSet +
Creates a point set that can contain points within the given range of values. +
popOverlayPanel() - +Method in class com.threerings.puzzle.client.PuzzlePanel +
Pops the overlay panel off of the main puzzle board display. +
Portal - Class in com.threerings.whirled.spot.data
Represents an exit to another scene.
Portal() - +Constructor for class com.threerings.whirled.spot.data.Portal +
  +
PortalDialog - Class in com.threerings.stage.tools.editor
The PortalDialog is used to present the user with a dialog + allowing them to enter the information associated with an + EditablePortal.
PortalDialog(EditorContext, EditorScenePanel) - +Constructor for class com.threerings.stage.tools.editor.PortalDialog +
Constructs the portal dialog. +
portalId - +Variable in class com.threerings.whirled.spot.data.Portal +
This portal's unique identifier. +
portals - +Variable in class com.threerings.whirled.spot.data.SpotSceneModel +
An array containing all portals in this scene. +
portalsAdded - +Variable in class com.threerings.whirled.spot.data.ModifyPortalsUpdate +
The portals to be added to the scene. +
portalsRemoved - +Variable in class com.threerings.whirled.spot.data.ModifyPortalsUpdate +
The portals to be removed from the room. +
PortalTool - Class in com.threerings.stage.tools.editor
A tool for setting a portal.
PortalTool() - +Constructor for class com.threerings.stage.tools.editor.PortalTool +
  +
PRE_GAME - +Static variable in class com.threerings.parlor.game.data.GameObject +
A game state constant indicating that the game has not yet started and is still awaiting + the arrival of all of the players. +
PreferencesDialog - Class in com.threerings.stage.tools.editor
A dialog for editing preferences.
PreferencesDialog() - +Constructor for class com.threerings.stage.tools.editor.PreferencesDialog +
Creates a preferences dialog. +
prepare(SceneObject) - +Method in class com.threerings.stage.tools.editor.ObjectEditorDialog +
Prepare the dialog for display. +
prepare(StageScene, EditablePortal) - +Method in class com.threerings.stage.tools.editor.PortalDialog +
Prepare the dialog for display. +
prepareMoveTo(int, ResultListener<PlaceConfig>) - +Method in class com.threerings.whirled.client.SceneDirector +
Prepares to move to the requested scene. +
privateTable - +Variable in class com.threerings.parlor.data.TableConfig +
Whether the table is "private". +
Prize - Class in com.threerings.parlor.tourney.data
Extensible class that specifies the prize for a tourney.
Prize() - +Constructor for class com.threerings.parlor.tourney.data.Prize +
  +
prize - +Variable in class com.threerings.parlor.tourney.data.TourneyConfig +
The prize for this tourney. +
purgeGame(int) - +Method in class com.threerings.parlor.rating.server.persist.RatingRepository +
Deletes all rating and percentile records for the specified game. +
purgePlayers(Collection<Integer>) - +Method in class com.threerings.parlor.rating.server.persist.RatingRepository +
Deletes all rating records for the specified players. +
purgePlayers(Collection<Integer>) - +Method in class com.threerings.stats.server.persist.StatRepository +
Deletes all data associated with the supplied players. +
pushOverlayPanel(JPanel) - +Method in class com.threerings.puzzle.client.PuzzlePanel +
Temporarily replaces the puzzle board display with the supplied overlay panel. +
put(String, int) - +Method in class com.threerings.stats.data.StringMapStat +
Adds the specified key value pair to this set, overwriting any existing mapping. +
PUZZLE_GAME_SERVICE - +Static variable in class com.threerings.puzzle.data.PuzzleObject +
The field name of the puzzleGameService field. +
PUZZLE_MESSAGE_BUNDLE - +Static variable in interface com.threerings.puzzle.data.PuzzleCodes +
The message bundle identifier for general puzzle messages. +
PuzzleAnimationWaiter - Class in com.threerings.puzzle.client
An animation waiter to be used with puzzles that want to modify the game object or board in some + way after the animations end, and would like to do so in a safe fashion such that their changes + aren't unwittingly performed on game data for a subsequent round of the puzzle.
PuzzleAnimationWaiter(PuzzleObject) - +Constructor for class com.threerings.puzzle.client.PuzzleAnimationWaiter +
Constructs a puzzle animation waiter. +
PuzzleBoardView - Class in com.threerings.puzzle.client
The puzzle board view displays a view of a puzzle game.
PuzzleBoardView(PuzzleContext) - +Constructor for class com.threerings.puzzle.client.PuzzleBoardView +
Constructs a puzzle board view. +
PuzzleCodes - Interface in com.threerings.puzzle.data
Constants relating to the puzzle services.
PuzzleContext - Interface in com.threerings.puzzle.util
Provides access to entities needed by the puzzle services.
PuzzleController - Class in com.threerings.puzzle.client
The puzzle game controller handles logical actions for a puzzle game.
PuzzleController() - +Constructor for class com.threerings.puzzle.client.PuzzleController +
  +
PuzzleController.ClearPender - Interface in com.threerings.puzzle.client
Used by PuzzleController.fireWhenActionCleared(com.threerings.puzzle.client.PuzzleController.ClearPender).
PuzzleControllerDelegate - Class in com.threerings.puzzle.client
A base class for puzzle controller delegates.
PuzzleControllerDelegate(PuzzleController) - +Constructor for class com.threerings.puzzle.client.PuzzleControllerDelegate +
Constructs a puzzle controller delegate. +
PuzzleGameCodes - Interface in com.threerings.puzzle.data
Contains codes used by the puzzle game client implementations.
PuzzleGameMarshaller - Class in com.threerings.puzzle.data
Provides the implementation of the PuzzleGameService interface + that marshalls the arguments and delivers the request to the provider + on the server.
PuzzleGameMarshaller() - +Constructor for class com.threerings.puzzle.data.PuzzleGameMarshaller +
  +
PuzzleGameProvider - Interface in com.threerings.puzzle.server
Defines the server-side of the PuzzleGameService.
PuzzleGameService - Interface in com.threerings.puzzle.client
Provides services used by puzzle game clients to request that actions be taken by the puzzle + manager.
puzzleGameService - +Variable in class com.threerings.puzzle.data.PuzzleObject +
Provides general puzzle game invocation services. +
PuzzleGameUtil - Class in com.threerings.puzzle.util
Puzzle game related utilities.
PuzzleGameUtil() - +Constructor for class com.threerings.puzzle.util.PuzzleGameUtil +
  +
PuzzleManager - Class in com.threerings.puzzle.server
Extends the GameManager with facilities for puzzle games.
PuzzleManager() - +Constructor for class com.threerings.puzzle.server.PuzzleManager +
  +
PuzzleManagerDelegate - Class in com.threerings.puzzle.server
Extends the GameManagerDelegate mechanism with puzzle manager specific methods (of + which there are currently none).
PuzzleManagerDelegate() - +Constructor for class com.threerings.puzzle.server.PuzzleManagerDelegate +
  +
PuzzleManagerDelegate(PuzzleManager) - +Constructor for class com.threerings.puzzle.server.PuzzleManagerDelegate +
Deprecated. use the zero-argument constructor. +
PuzzleObject - Class in com.threerings.puzzle.data
Extends the basic GameObject to add individual player status.
PuzzleObject() - +Constructor for class com.threerings.puzzle.data.PuzzleObject +
  +
PuzzlePanel - Class in com.threerings.puzzle.client
The puzzle panel class should be extended by classes that provide a view for a puzzle game.
PuzzlePanel(PuzzleContext, PuzzleController) - +Constructor for class com.threerings.puzzle.client.PuzzlePanel +
Constructs a puzzle panel. +
PuzzlePrefs - Class in com.threerings.puzzle.client
Provides access to runtime configuration parameters for this package and its subpackages.
PuzzlePrefs() - +Constructor for class com.threerings.puzzle.client.PuzzlePrefs +
  +
puzzleStillValid() - +Method in class com.threerings.puzzle.client.PuzzleAnimationWaiter +
Returns whether the puzzle associated with this puzzle animation waiter is still valid. +
+
+

+Q

+
+
qualifyZoneId(byte, int) - +Static method in class com.threerings.whirled.zone.util.ZoneUtil +
Composes the zone type and zone id into a qualified zone id. +
QUEEN - +Static variable in interface com.threerings.parlor.card.data.CardCodes +
The number of the queen. +
+
+

+R

+
+
RADIAL_ROTATION - +Static variable in class com.threerings.puzzle.drop.data.DropBoard +
The rotation constant for rotation around a central piece. +
RAISE_ROW - +Static variable in class com.threerings.puzzle.drop.client.DropControllerDelegate +
The action command for raising the next rising row. +
RangeParameter - Class in com.threerings.parlor.data
Models a parameter that can contain an integer value in a specified range.
RangeParameter() - +Constructor for class com.threerings.parlor.data.RangeParameter +
  +
rated - +Variable in class com.threerings.parlor.game.data.GameConfig +
Indicates whether or not this game is rated. +
ratifyBodyEntry(BodyObject, int) - +Method in interface com.threerings.whirled.zone.server.ZoneManager +
Called when a body has requested to enter a zone. +
ratifyBodyExit(BodyObject) - +Method in interface com.threerings.whirled.zone.server.ZoneManager +
Called when a body has requested to leave a zone. +
RATING - +Static variable in class com.threerings.parlor.rating.server.persist.RatingRecord +
  +
rating - +Variable in class com.threerings.parlor.rating.server.persist.RatingRecord +
The player's current rating. +
Rating - Class in com.threerings.parlor.rating.server
Encapsulates the rating/experience tuple representing a player's rating for a game, and logic + for calculating rating changes.
Rating() - +Constructor for class com.threerings.parlor.rating.server.Rating +
  +
rating - +Variable in class com.threerings.parlor.rating.server.Rating +
The player's rating for our game. +
RatingCodes - Interface in com.threerings.parlor.rating.data
Constants relating to the rating services.
RatingDelegate - Class in com.threerings.parlor.rating.server
Rates players after each game and handles persisting the results.
RatingDelegate() - +Constructor for class com.threerings.parlor.rating.server.RatingDelegate +
  +
RatingRecord - Class in com.threerings.parlor.rating.server.persist
 
RatingRecord() - +Constructor for class com.threerings.parlor.rating.server.persist.RatingRecord +
An empty constructor for unmarshalling. +
RatingRecord(int, int, int, int) - +Constructor for class com.threerings.parlor.rating.server.persist.RatingRecord +
A constructor that populates all our fields. +
RatingRepository - Class in com.threerings.parlor.rating.server.persist
Handles the persistent storage of per-user per-game ratings.
RatingRepository(PersistenceContext) - +Constructor for class com.threerings.parlor.rating.server.persist.RatingRepository +
Initialize the RatingRepository. +
readObject(ObjectInputStream) - +Method in class com.threerings.stats.data.StatModifier +
Reads our custom streamable fields. +
readObject(ObjectInputStream) - +Method in class com.threerings.whirled.data.SceneUpdate +
Reads our custom streamable fields. +
RECEIVED_CARDS_FROM_PLAYER - +Static variable in class com.threerings.parlor.card.client.CardGameDecoder +
The method id used to dispatch CardGameReceiver.receivedCardsFromPlayer(int, com.threerings.parlor.card.data.Card[]) + notifications. +
RECEIVED_HAND - +Static variable in class com.threerings.parlor.card.client.CardGameDecoder +
The method id used to dispatch CardGameReceiver.receivedHand(int, com.threerings.parlor.card.data.Hand) + notifications. +
RECEIVED_INVITE - +Static variable in class com.threerings.parlor.client.ParlorDecoder +
The method id used to dispatch ParlorReceiver.receivedInvite(int, com.threerings.util.Name, com.threerings.parlor.game.data.GameConfig) + notifications. +
RECEIVED_INVITE_CANCELLATION - +Static variable in class com.threerings.parlor.client.ParlorDecoder +
The method id used to dispatch ParlorReceiver.receivedInviteCancellation(int) + notifications. +
RECEIVED_INVITE_RESPONSE - +Static variable in class com.threerings.parlor.client.ParlorDecoder +
The method id used to dispatch ParlorReceiver.receivedInviteResponse(int, int, java.lang.Object) + notifications. +
receivedCardsFromPlayer(int, Card[]) - +Method in class com.threerings.parlor.card.client.CardGameController +
Dispatched to the client when it has received a set of cards from another player. +
receivedCardsFromPlayer(int, Card[]) - +Method in interface com.threerings.parlor.card.client.CardGameReceiver +
Dispatched to the client when it has received a set of cards + from another player. +
receivedGameReady(int) - +Method in interface com.threerings.parlor.client.GameReadyObserver +
Called when a game ready notification is received. +
receivedHand(int, Hand) - +Method in class com.threerings.parlor.card.client.CardGameController +
Called by our sender to notify us of a received hand. +
receivedHand(Hand) - +Method in class com.threerings.parlor.card.client.CardGameController +
Called when the server deals the client a new hand of cards. +
receivedHand(int, Hand) - +Method in interface com.threerings.parlor.card.client.CardGameReceiver +
Dispatched to the client when it has received a hand of cards. +
receivedInvite(int, Name, GameConfig) - +Method in class com.threerings.parlor.client.ParlorDirector +
  +
receivedInvite(int, Name, GameConfig) - +Method in interface com.threerings.parlor.client.ParlorReceiver +
Called by the invocation services when another user has invited us + to play a game. +
receivedInviteCancellation(int) - +Method in class com.threerings.parlor.client.ParlorDirector +
  +
receivedInviteCancellation(int) - +Method in interface com.threerings.parlor.client.ParlorReceiver +
Called by the invocation services when an outstanding invitation + has been cancelled by the inviting user. +
receivedInviteResponse(int, int, Object) - +Method in class com.threerings.parlor.client.ParlorDirector +
  +
receivedInviteResponse(int, int, Object) - +Method in interface com.threerings.parlor.client.ParlorReceiver +
Called by the invocation services when another user has responded + to our invitation by either accepting, refusing or countering it. +
RECEIVER_CODE - +Static variable in class com.threerings.parlor.card.client.CardGameDecoder +
The generated hash code used to identify this receiver class. +
RECEIVER_CODE - +Static variable in class com.threerings.parlor.client.ParlorDecoder +
The generated hash code used to identify this receiver class. +
RECEIVER_CODE - +Static variable in class com.threerings.whirled.client.SceneDecoder +
The generated hash code used to identify this receiver class. +
RECEIVER_CODE - +Static variable in class com.threerings.whirled.zone.client.ZoneDecoder +
The generated hash code used to identify this receiver class. +
recomputePercentiles() - +Method in class com.threerings.parlor.rating.util.Percentiler +
Recomputes the percentile cutoffs based on the values recorded since the last percentile + computation. +
recordValue(float) - +Method in class com.threerings.parlor.rating.util.Percentiler +
Records a value, updating the histogram but not the percentiles (a call to Percentiler.recomputePercentiles() is required for that and is sufficiently expensive that it shouldn't + be done every time a value is added). +
recordValue(float, boolean) - +Method in class com.threerings.parlor.rating.util.Percentiler +
See Percentiler.recordValue(float). +
recoverFailedMove(int) - +Method in class com.threerings.whirled.client.SceneDirector +
  +
recoverMoveTo(int) - +Method in interface com.threerings.whirled.client.SceneDirector.MoveHandler +
Should instruct the client to move the last known working location (as well as clean up + after the failed moveTo request). +
recoverMoveTo(int) - +Method in class com.threerings.whirled.zone.client.ZoneDirector +
  +
RED_JOKER - +Static variable in interface com.threerings.parlor.card.data.CardCodes +
The number of the red joker. +
redo(ActionEvent) - +Method in class com.threerings.stage.tools.editor.EditorFrame +
  +
redo() - +Method in class com.threerings.stage.tools.editor.EditorScenePanel +
  +
refuse(String) - +Method in class com.threerings.parlor.client.Invitation +
Refuses this invitation. +
registerAuxRuleSet(NestableRuleSet) - +Method in class com.threerings.whirled.tools.xml.SceneParser +
Adds a NestableRuleSet for parsing auxiliary scene models. +
registerAuxWriter(Class<?>, NestableWriter) - +Method in class com.threerings.whirled.tools.xml.SceneWriter +
Registers a writer for writing auxiliary scene models of the + supplied class. +
registerZoneManager(byte, ZoneManager) - +Method in class com.threerings.whirled.zone.peer.server.PeeredZoneRegistry +
  +
registerZoneManager(byte, ZoneManager) - +Method in class com.threerings.whirled.zone.server.ZoneRegistry +
Registers the supplied zone manager as the manager for the specified zone type. +
rematchGame() - +Method in class com.threerings.parlor.card.server.CardGameManager +
This should be called to start a rematched game. +
remove(int, int) - +Method in class com.threerings.puzzle.util.PointSet +
Removes the given point from the set and returns whether the point was present in the set. +
REMOVE_OBJECTS - +Static variable in class com.threerings.stage.data.StageSceneMarshaller +
The method id used to dispatch StageSceneMarshaller.removeObjects(com.threerings.miso.data.ObjectInfo[], com.threerings.presents.client.InvocationService.ConfirmListener) requests. +
removeAll(Card[]) - +Method in class com.threerings.parlor.card.data.Hand +
Removes all of the specified cards from this hand. +
removeCluster(int) - +Method in class com.threerings.stage.client.StageScenePanel +
Removes the specified cluster from the view. +
removed - +Variable in class com.threerings.stage.data.ModifyObjectsUpdate +
The objects removed from the scene (or null for none). +
removeFromClusters(Comparable<?>) - +Method in class com.threerings.whirled.spot.data.SpotSceneObject +
Requests that the entry matching the supplied key be removed from + the clusters set. +
removeFromHostedZones(Comparable<?>) - +Method in class com.threerings.whirled.zone.peer.server.ZoneNodeObject +
Requests that the entry matching the supplied key be removed from + the hostedZones set. +
removeFromOccupantLocs(Comparable<?>) - +Method in class com.threerings.whirled.spot.data.SpotSceneObject +
Requests that the entry matching the supplied key be removed from + the occupantLocs set. +
removeFromOccupants(int) - +Method in class com.threerings.whirled.spot.data.ClusterObject +
Requests that oid be removed from the + occupants oid list. +
removeFromParticipants(Comparable<?>) - +Method in class com.threerings.parlor.tourney.data.TourneyObject +
Requests that the entry matching the supplied key be removed from + the participants set. +
removeFromTables(Comparable<?>) - +Method in class com.threerings.micasa.lobby.table.TableLobbyObject +
  +
removeFromTables(Comparable<?>) - +Method in interface com.threerings.parlor.data.TableLobbyObject +
Removes the table instance that matches the specified key from the + tables set (using the appropriate distributed object mechanisms). +
removeFromTableSet(Comparable<?>) - +Method in class com.threerings.micasa.lobby.table.TableLobbyObject +
Requests that the entry matching the supplied key be removed from + the tableSet set. +
removeGameReadyObserver(GameReadyObserver) - +Method in class com.threerings.parlor.client.ParlorDirector +
Removes the specified observer from the list of entities that are notified when we receive a + game ready notification. +
removeHandSelectionObserver(CardPanel.CardSelectionObserver) - +Method in class com.threerings.parlor.card.client.CardPanel +
Removes an object from the hand selection observer list. +
removeNotify() - +Method in class com.threerings.puzzle.client.PuzzlePanel +
  +
removeObject(ObjectInfo) - +Method in class com.threerings.stage.data.StageScene +
Removes an object from this scene. +
removeObject(ObjectInfo) - +Method in class com.threerings.stage.util.PlacementConstraints +
Removes the specified object through the constraints. +
removeObjects(ObjectInfo[], InvocationService.ConfirmListener) - +Method in interface com.threerings.stage.client.StageSceneService +
Requests to remove the supplied objects from the current scene. +
removeObjects(ObjectInfo[], InvocationService.ConfirmListener) - +Method in class com.threerings.stage.data.StageSceneMarshaller +
  +
removeObjects(ClientObject, ObjectInfo[], InvocationService.ConfirmListener) - +Method in class com.threerings.stage.server.StageSceneManager +
  +
removeObjects(ClientObject, ObjectInfo[], InvocationService.ConfirmListener) - +Method in interface com.threerings.stage.server.StageSceneProvider +
Handles a StageSceneService.removeObjects(com.threerings.miso.data.ObjectInfo[], com.threerings.presents.client.InvocationService.ConfirmListener) request. +
removePlayer(Name) - +Method in class com.threerings.parlor.game.server.GameManager +
Removes the given player from the game. +
removePortal(Portal) - +Method in class com.threerings.stage.data.StageScene +
  +
removePortal(Portal) - +Method in interface com.threerings.whirled.spot.data.SpotScene +
Removes the specified portal from the scene. +
removePortal(Portal) - +Method in class com.threerings.whirled.spot.data.SpotSceneImpl +
  +
removePortal(Portal) - +Method in class com.threerings.whirled.spot.data.SpotSceneModel +
Removes a portal from this model. +
removeSeatednessObserver(SeatednessObserver) - +Method in class com.threerings.parlor.client.TableDirector +
Requests that the specified observer be removed from to the list of observers that are + notified when this client sits down at or stands up from a table. +
removeSendButton() - +Method in class com.threerings.micasa.client.ChatPanel +
For applications where the chat box has extremely limited space, + the send button can be removed to leave more space for the text + input box. +
removeSprite(Sprite) - +Method in class com.threerings.puzzle.client.PuzzleBoardView +
  +
removeZoneObserver(ZoneObserver) - +Method in class com.threerings.whirled.zone.client.ZoneDirector +
Removes a zone observer from the list. +
replacePlayer(int, Name) - +Method in class com.threerings.parlor.game.server.GameManager +
Replaces the player at the specified index and calls GameManager.playerWasReplaced(int, com.threerings.util.Name, com.threerings.util.Name) to let + derived classes and delegates know what's going on. +
REQUEST_CANCELLED - +Static variable in class com.threerings.whirled.spot.data.SpotMarshaller.SpotSceneMoveMarshaller +
The method id used to dispatch SpotMarshaller.SpotSceneMoveMarshaller.requestCancelled() + responses. +
REQUEST_REMATCH - +Static variable in class com.threerings.parlor.card.trick.data.TrickCardGameMarshaller +
The method id used to dispatch TrickCardGameMarshaller.requestRematch() requests. +
requestCancelled() - +Method in interface com.threerings.whirled.spot.client.SpotService.SpotSceneMoveListener +
The request is not going through because it was cancelled due to some other action. +
requestCancelled() - +Method in class com.threerings.whirled.spot.data.SpotMarshaller.SpotSceneMoveMarshaller +
  +
requestClusterSpeak(String) - +Method in class com.threerings.whirled.spot.client.SpotSceneDirector +
Sends a chat message to the other users in the cluster to which the location that we + currently occupy belongs. +
requestClusterSpeak(String, byte) - +Method in class com.threerings.whirled.spot.client.SpotSceneDirector +
Sends a chat message to the other users in the cluster to which the location that we + currently occupy belongs. +
requestFailed(String) - +Method in class com.threerings.micasa.lobby.LobbySelector +
  +
requestFailed(String) - +Method in class com.threerings.parlor.client.Invitation +
  +
requestFailed(String) - +Method in class com.threerings.parlor.client.TableDirector +
  +
requestFailed(String) - +Method in class com.threerings.whirled.client.SceneDirector +
  +
requestFailed(String) - +Method in class com.threerings.whirled.client.SceneMoveAdapter +
  +
requestFailed(int, ObjectAccessException) - +Method in class com.threerings.whirled.spot.client.SpotSceneDirector +
  +
requestFailed(String) - +Method in class com.threerings.whirled.zone.client.ZoneDirector +
  +
requestProcessed(Object) - +Method in class com.threerings.parlor.client.TableDirector +
  +
requestRematch() - +Method in interface com.threerings.parlor.card.trick.client.TrickCardGameService +
A request for a rematch. +
requestRematch() - +Method in class com.threerings.parlor.card.trick.data.TrickCardGameMarshaller +
  +
requestRematch(ClientObject) - +Method in class com.threerings.parlor.card.trick.server.TrickCardGameManagerDelegate +
  +
requestRematch(ClientObject) - +Method in interface com.threerings.parlor.card.trick.server.TrickCardGameProvider +
Handles a TrickCardGameService.requestRematch() request. +
REQUESTS_REMATCH - +Static variable in interface com.threerings.parlor.card.trick.data.TrickCardGameObject +
Indicates that the player has requested a rematch. +
reserveFee(BodyObject, ResultListener<Void>) - +Method in class com.threerings.parlor.tourney.data.EntryFee +
Attempts to reserve the entry fee. +
reset(boolean) - +Method in class com.threerings.parlor.card.data.Deck +
Resets the deck to its initial state: an unshuffled deck of + 52 or 54 cards, depending on whether the jokers are included. +
resetGame() - +Method in class com.threerings.parlor.game.client.GameController +
Calls GameController.gameWillReset(), ends the current game (locally, it does not tell the server to + end the game), and waits to receive a reset notification (which is simply an event setting + the game state to IN_PLAY even though it's already set to IN_PLAY) + from the server which will start up a new game. +
resetGame() - +Method in class com.threerings.parlor.game.server.GameManager +
Called when the game is to be reset to its starting state in preparation for a new game + without actually ending the current game. +
resolvePeerZone(int, PeeredZoneRegistry.PeerZoneResolutionListener) - +Method in class com.threerings.whirled.zone.peer.server.PeeredZoneRegistry +
Resolve a zone, or return the information on the peer on which it's hosted. +
resolveScene(int, SceneRegistry.ResolutionListener) - +Method in class com.threerings.whirled.server.SceneRegistry +
Requests that the specified scene be resolved, which means loaded into the server and + initialized if the scene is not currently active. +
resolveZone(int, ZoneManager.ResolutionListener) - +Method in class com.threerings.whirled.zone.peer.server.PeeredZoneRegistry +
  +
resolveZone(int, ZoneManager.ResolutionListener) - +Method in interface com.threerings.whirled.zone.server.ZoneManager +
Resolves and delivers the scene summary information for the + requested zone. +
respond(int, int, Object, InvocationService.InvocationListener) - +Method in interface com.threerings.parlor.client.ParlorService +
You probably don't want to call this directly, but want to call one of Invitation.accept(), Invitation.refuse(java.lang.String), or Invitation.counter(com.threerings.parlor.game.data.GameConfig, com.threerings.parlor.client.InvitationResponseObserver). +
RESPOND - +Static variable in class com.threerings.parlor.data.ParlorMarshaller +
The method id used to dispatch ParlorMarshaller.respond(int, int, java.lang.Object, com.threerings.presents.client.InvocationService.InvocationListener) requests. +
respond(int, int, Object, InvocationService.InvocationListener) - +Method in class com.threerings.parlor.data.ParlorMarshaller +
  +
respond(ClientObject, int, int, Object, InvocationService.InvocationListener) - +Method in class com.threerings.parlor.server.ParlorManager +
  +
respond(ClientObject, int, int, Object, InvocationService.InvocationListener) - +Method in interface com.threerings.parlor.server.ParlorProvider +
Handles a ParlorService.respond(int, int, java.lang.Object, com.threerings.presents.client.InvocationService.InvocationListener) request. +
respondToInvite(BodyObject, int, int, Object) - +Method in class com.threerings.parlor.server.ParlorManager +
Effects a response to an invitation (accept, refuse or counter), made by the specified + source user with the specified arguments. +
RESTART_ACTION - +Static variable in interface com.threerings.puzzle.client.PuzzleController.ClearPender +
PuzzleController.ClearPender.actionCleared() return code. +
returnFee(BodyObject) - +Method in class com.threerings.parlor.tourney.data.EntryFee +
Returns the entry fee. +
returnHand(Hand) - +Method in class com.threerings.parlor.card.data.Deck +
Returns a hand of cards to the deck. +
RIGHT - +Static variable in interface com.threerings.parlor.card.trick.data.TrickCardCodes +
For four-player games, the player on the right. +
RISE_STREAM - +Static variable in interface com.threerings.puzzle.drop.data.DropCodes +
The name of the control stream that provides rise pieces. +
RobotPlayer - Class in com.threerings.parlor.util
The robot player is a computer player with truly rudimentary artificial + intelligence that periodically posts random commands selected from the + available key press and release commands to the target component.
RobotPlayer(Component, KeyTranslator) - +Constructor for class com.threerings.parlor.util.RobotPlayer +
Constructs a robot player. +
ROTATE_BLOCK_CCW - +Static variable in class com.threerings.puzzle.drop.client.DropControllerDelegate +
The action command for rotating the block counter-clockwise. +
ROTATE_BLOCK_CW - +Static variable in class com.threerings.puzzle.drop.client.DropControllerDelegate +
The action command for rotating the block clockwise. +
rotateDropBlock(DropBlockSprite, int) - +Method in class com.threerings.puzzle.drop.client.DropBoardView +
Rotates the given drop block sprite to the specified orientation, updating the image as + necessary. +
row - +Variable in class com.threerings.puzzle.drop.util.PieceDropper.PieceDropInfo +
The starting row of the bottom piece being dropped. +
rowContainsPieces(int, int) - +Method in class com.threerings.puzzle.drop.data.DropBoard +
Returns true if the specified row (which count down, with zero at the top of the board) + contains any pieces. +
rsrcmgr - +Variable in class com.threerings.stage.server.StageServer +
A resource manager with which we can load resources in the same manner that the client does + (for resources that are used on both the server and client). +
run(String, String, String) - +Method in class com.threerings.micasa.client.MiCasaApp +
  +
run() - +Method in class com.threerings.micasa.simulator.client.SimulatorApp +
  +
run() - +Method in interface com.threerings.micasa.simulator.server.SimulatorServer +
Called to perform the main body of server processing. +
run() - +Method in class com.threerings.stage.tools.editor.EditorApp +
Run the application. +
run() - +Method in class com.threerings.stage.tools.viewer.ViewerApp +
Run the application. +
RUNNING - +Static variable in class com.threerings.parlor.tourney.data.TourneyObject +
Tourney is currently running. +
+
+

+S

+
+
Scene - Interface in com.threerings.whirled.data
This interface makes available basic scene information.
SCENE_UPDATE - +Static variable in interface com.threerings.whirled.data.SceneCodes +
The message identifier for scene update messages. +
SceneCodes - Interface in com.threerings.whirled.data
Contains codes used by the scene invocation services.
SceneColorizer - Class in com.threerings.stage.client
Handles colorization of object tiles in a scene.
SceneColorizer(ColorPository, StageScene) - +Constructor for class com.threerings.stage.client.SceneColorizer +
Creates a scene colorizer for the supplied scene. +
SceneController - Class in com.threerings.whirled.client
The base scene controller class.
SceneController() - +Constructor for class com.threerings.whirled.client.SceneController +
  +
SceneDecoder - Class in com.threerings.whirled.client
Dispatches calls to a SceneReceiver instance.
SceneDecoder(SceneReceiver) - +Constructor for class com.threerings.whirled.client.SceneDecoder +
Creates a decoder that may be registered to dispatch invocation + service notifications to the specified receiver. +
SceneDirector - Class in com.threerings.whirled.client
The scene director is the client's interface to all things scene related.
SceneDirector(WhirledContext, LocationDirector, SceneRepository, SceneFactory) - +Constructor for class com.threerings.whirled.client.SceneDirector +
Creates a new scene director with the specified context. +
SceneDirector.MoveHandler - Interface in com.threerings.whirled.client
Used to recover from a problem after a completed moveTo.
SceneFactory - Interface in com.threerings.whirled.util
This is used by the Whirled services to obtain a Scene + implementation given a scene model and associated data.
sceneFailedToResolve(int, Exception) - +Method in class com.threerings.whirled.server.AbstractSceneMoveHandler +
  +
sceneFailedToResolve(int, Exception) - +Method in interface com.threerings.whirled.server.SceneRegistry.ResolutionListener +
Called if some failure occurred in the scene resolution process. +
sceneId - +Variable in class com.threerings.whirled.data.SceneModel +
This scene's unique identifier. +
sceneId - +Variable in class com.threerings.whirled.data.ScenePlace +
The id of the scene occupied by the body. +
sceneId - +Variable in class com.threerings.whirled.zone.data.SceneSummary +
The id of this scene. +
SceneImpl - Class in com.threerings.whirled.data
An implementation of the Scene interface.
SceneImpl(SceneModel, PlaceConfig) - +Constructor for class com.threerings.whirled.data.SceneImpl +
Creates an instance that will obtain data from the supplied scene + model and place config. +
SceneImpl() - +Constructor for class com.threerings.whirled.data.SceneImpl +
Instantiates a blank scene implementation. +
SceneInfoPanel - Class in com.threerings.stage.tools.editor
The scene info panel presents the user with options to select the scene layer to edit, and + whether to display tile coordinates and locations in the scene view.
SceneInfoPanel(EditorContext, EditorModel, EditorScenePanel) - +Constructor for class com.threerings.stage.tools.editor.SceneInfoPanel +
Constructs the scene info panel. +
SceneLocation - Class in com.threerings.whirled.spot.data
Extends Location with the data and functionality needed to + represent a particular user's location in a scene.
SceneLocation(Location, int) - +Constructor for class com.threerings.whirled.spot.data.SceneLocation +
Creates a scene location with the specified information. +
SceneLocation() - +Constructor for class com.threerings.whirled.spot.data.SceneLocation +
Creates a blank instance suitable for unserialization. +
SceneManager - Class in com.threerings.whirled.server
The scene manager extends the place manager and takes care of basic scene services.
SceneManager() - +Constructor for class com.threerings.whirled.server.SceneManager +
  +
SceneMarshaller - Class in com.threerings.whirled.data
Provides the implementation of the SceneService interface + that marshalls the arguments and delivers the request to the provider + on the server.
SceneMarshaller() - +Constructor for class com.threerings.whirled.data.SceneMarshaller +
  +
SceneMarshaller.SceneMoveMarshaller - Class in com.threerings.whirled.data
Marshalls results to implementations of SceneService.SceneMoveListener.
SceneMarshaller.SceneMoveMarshaller() - +Constructor for class com.threerings.whirled.data.SceneMarshaller.SceneMoveMarshaller +
  +
SceneModel - Class in com.threerings.whirled.data
The scene model is the bare bones representation of the data for a + scene in the Whirled system.
SceneModel() - +Constructor for class com.threerings.whirled.data.SceneModel +
  +
SceneMoveAdapter - Class in com.threerings.whirled.client
A useful base class for implementing part of a SceneService.SceneMoveListener.
SceneMoveAdapter() - +Constructor for class com.threerings.whirled.client.SceneMoveAdapter +
  +
SceneMoveHandler - Class in com.threerings.whirled.server
Handles a simple scene to scene move.
SceneMoveHandler(LocationManager, BodyObject, int, SceneService.SceneMoveListener) - +Constructor for class com.threerings.whirled.server.SceneMoveHandler +
  +
SceneObject - Class in com.threerings.whirled.data
 
SceneObject() - +Constructor for class com.threerings.whirled.data.SceneObject +
  +
SceneParser - Class in com.threerings.whirled.tools.xml
A simple class for parsing an editable scene instance.
SceneParser(String) - +Constructor for class com.threerings.whirled.tools.xml.SceneParser +
Constructs a scene parser that parses scenes with the specified XML + path prefix. +
ScenePlace - Class in com.threerings.whirled.data
Extends Place with scene information.
ScenePlace(int, int) - +Constructor for class com.threerings.whirled.data.ScenePlace +
Creates a scene place with the supplied SceneObject oid and scene id. +
SceneProvider - Interface in com.threerings.whirled.server
Defines the server-side of the SceneService.
SceneReceiver - Interface in com.threerings.whirled.client
Defines, for the scene services, a set of notifications delivered asynchronously by the server + to the client.
SceneRegistry - Class in com.threerings.whirled.server
The scene registry is responsible for the management of all scenes.
SceneRegistry(InvocationManager) - +Constructor for class com.threerings.whirled.server.SceneRegistry +
Constructs a scene registry. +
SceneRegistry.ConfigFactory - Interface in com.threerings.whirled.server
Used to create PlaceConfig instances for scenes.
SceneRegistry.ResolutionListener - Interface in com.threerings.whirled.server
Because scenes must be loaded from the scene repository and this must not be done on the + dobjmgr thread, the interface for resolving scenes requires that the entity that wishes for + a scene to be resolved implement this callback interface so that it can be notified when a + scene has been loaded and initialized.
SceneRepository - Interface in com.threerings.whirled.client.persist
The scene repository provides access to a persistent repository of + scene information.
SceneRepository - Interface in com.threerings.whirled.server.persist
The scene repository provides the basic interface for loading and updating scene data.
SceneRuleSet - Class in com.threerings.whirled.tools.xml
Used to parse a SceneModel from XML.
SceneRuleSet() - +Constructor for class com.threerings.whirled.tools.xml.SceneRuleSet +
  +
scenes - +Variable in class com.threerings.whirled.zone.data.ZoneSummary +
The summary information for all of the scenes in the zone. +
SceneSender - Class in com.threerings.whirled.server
Used to issue notifications to a SceneReceiver instance on a + client.
SceneSender() - +Constructor for class com.threerings.whirled.server.SceneSender +
  +
SceneService - Interface in com.threerings.whirled.client
The scene service class provides the client interface to the scene related invocation services + (e.g.
SceneService.SceneMoveListener - Interface in com.threerings.whirled.client
Used to communicate the response to a SceneService.moveTo(int, int, com.threerings.whirled.client.SceneService.SceneMoveListener) request.
SceneSummary - Class in com.threerings.whirled.zone.data
The scene summary class is used to provide info about the connected + group of scenes that make up a zone.
SceneSummary() - +Constructor for class com.threerings.whirled.zone.data.SceneSummary +
  +
SceneUpdate - Class in com.threerings.whirled.data
Used to encapsulate updates to scenes in such a manner that updates can be stored persistently + and sent to clients to update their own local copies of scenes.
SceneUpdate() - +Constructor for class com.threerings.whirled.data.SceneUpdate +
  +
sceneUpdated(SceneUpdate) - +Method in class com.threerings.stage.client.StageScenePanel +
Called when we have received a scene update from the server. +
SceneUpdateMarshaller - Class in com.threerings.whirled.server.persist
A utility class to assist the management of scene updates by a SceneRepository.
SceneUpdateMarshaller(Class<?>...) - +Constructor for class com.threerings.whirled.server.persist.SceneUpdateMarshaller +
Create a SceneUpdateMarshaller that understands the update types specified. +
sceneWasResolved(SceneManager) - +Method in class com.threerings.whirled.server.AbstractSceneMoveHandler +
  +
sceneWasResolved(SceneManager) - +Method in interface com.threerings.whirled.server.SceneRegistry.ResolutionListener +
Called when the scene has been successfully resolved. +
SceneWriter - Class in com.threerings.whirled.tools.xml
Generates an XML representation of an SceneModel.
SceneWriter() - +Constructor for class com.threerings.whirled.tools.xml.SceneWriter +
  +
SCHEMA_VERSION - +Static variable in class com.threerings.parlor.rating.server.persist.PercentileRecord +
Increment this value to reflect changes to this object's schema. +
SCHEMA_VERSION - +Static variable in class com.threerings.parlor.rating.server.persist.RatingRecord +
  +
SCHEMA_VERSION - +Static variable in class com.threerings.stats.server.persist.StatRecord +
  +
SCHEMA_VERSION - +Static variable in class com.threerings.stats.server.persist.StringCodeRecord +
  +
SCORE_COLOR - +Static variable in class com.threerings.puzzle.drop.client.DropBoardView +
The color used to render normal scoring text. +
ScoreAnimation - Class in com.threerings.parlor.media
 
ScoreAnimation(Label, int, int) - +Constructor for class com.threerings.parlor.media.ScoreAnimation +
Constructs a score animation for the given score value centered at the given coordinates. +
ScoreAnimation(Label, int, int, long) - +Constructor for class com.threerings.parlor.media.ScoreAnimation +
Constructs a score animation for the given score value centered at the given coordinates. +
ScoreAnimation(Label, int, int, int, int, long) - +Constructor for class com.threerings.parlor.media.ScoreAnimation +
Constructs a score animation for the given score value starting at the given coordinates and + floating toward the specified coordinates. +
SEATED_CONTINUOUS - +Static variable in class com.threerings.parlor.game.data.GameConfig +
Matchmaking type constant: a game that starts immediately, but only has a certain number of + player slots. +
SEATED_GAME - +Static variable in class com.threerings.parlor.game.data.GameConfig +
Matchmaking type constant: a game that is started with a list of players, and those are the + only players that may play. +
seatednessDidChange(boolean) - +Method in class com.threerings.micasa.lobby.table.TableItem +
  +
seatednessDidChange(boolean) - +Method in class com.threerings.micasa.lobby.table.TableListView +
  +
seatednessDidChange(boolean) - +Method in interface com.threerings.parlor.client.SeatednessObserver +
Called when this client sits down at or stands up from a table. +
SeatednessObserver - Interface in com.threerings.parlor.client
Entites that wish to hear about when we sit down at a table or stand up + from a table can implement this interface and register themselves with + the TableDirector.
SECTION_HEIGHT - +Static variable in class com.threerings.stage.data.StageMisoSceneModel +
The height (in tiles) of a scene section. +
SECTION_WIDTH - +Static variable in class com.threerings.stage.data.StageMisoSceneModel +
The width (in tiles) of a scene section. +
SEED - +Static variable in class com.threerings.puzzle.data.PuzzleObject +
The field name of the seed field. +
seed - +Variable in class com.threerings.puzzle.data.PuzzleObject +
The seed used to germinate the boards. +
seedFromEvent(int, int) - +Method in class com.threerings.puzzle.data.Board +
Allows puzzles to add extra noise to their random number generators based on the specific + events sent from the client to make it more difficult for a hacked client to predict things + such as piece generation. +
SegmentInfo - Class in com.threerings.puzzle.drop.data
Describes a segment of pieces in a DropBoard.
SegmentInfo(int, int, int, int) - +Constructor for class com.threerings.puzzle.drop.data.SegmentInfo +
Constructs a segment info object. +
selectHandSprite(CardSprite) - +Method in class com.threerings.parlor.card.client.CardPanel +
Programmatically selects a sprite in the hand. +
selectNextTile() - +Method in class com.threerings.stage.tools.editor.TileInfoPanel +
Selects the next tile in the list of available tiles. +
selectPreviousTile() - +Method in class com.threerings.stage.tools.editor.TileInfoPanel +
Selects the previous tile in the list of available tiles. +
SEND_CARDS_TO_PLAYER - +Static variable in class com.threerings.parlor.card.trick.data.TrickCardGameMarshaller +
The method id used to dispatch TrickCardGameMarshaller.sendCardsToPlayer(int, com.threerings.parlor.card.data.Card[]) requests. +
sendCardsFromPlayer(ClientObject, int, Card[]) - +Static method in class com.threerings.parlor.card.server.CardGameSender +
Issues a notification that will result in a call to CardGameReceiver.receivedCardsFromPlayer(int, com.threerings.parlor.card.data.Card[]) on a client. +
sendCardsToPlayer(int, Card[]) - +Method in interface com.threerings.parlor.card.trick.client.TrickCardGameService +
Sends a group of cards to the player at the specified index. +
sendCardsToPlayer(int, Card[]) - +Method in class com.threerings.parlor.card.trick.data.TrickCardGameMarshaller +
  +
sendCardsToPlayer(ClientObject, int, Card[]) - +Method in class com.threerings.parlor.card.trick.server.TrickCardGameManagerDelegate +
  +
sendCardsToPlayer(ClientObject, int, Card[]) - +Method in interface com.threerings.parlor.card.trick.server.TrickCardGameProvider +
Handles a TrickCardGameService.sendCardsToPlayer(int, com.threerings.parlor.card.data.Card[]) request. +
sendClusterChatMessage(int, int, Name, String, String, byte) - +Method in class com.threerings.whirled.spot.server.SpotSceneRegistry +
Sends a cluster chat notification to the specified location in the specified place object + originating with the specified speaker (the speaker can be a server entity that wishes to + fake a "speak" message, in which case the bundle argument should be non-null and should + contain the id of the bundle to be used to translate the message text) and with the supplied + message content. +
sendClusterChatMessage(int, int, UserMessage) - +Method in class com.threerings.whirled.spot.server.SpotSceneRegistry +
Sends a cluster chat notification to the specified location in the specified place object + originating with the specified speaker. +
sendHand(ClientObject, int, Hand) - +Static method in class com.threerings.parlor.card.server.CardGameSender +
Issues a notification that will result in a call to CardGameReceiver.receivedHand(int, com.threerings.parlor.card.data.Hand) on a client. +
sendInvite(ClientObject, int, Name, GameConfig) - +Static method in class com.threerings.parlor.server.ParlorSender +
Issues a notification that will result in a call to ParlorReceiver.receivedInvite(int, com.threerings.util.Name, com.threerings.parlor.game.data.GameConfig) on a client. +
sendInviteCancellation(ClientObject, int) - +Static method in class com.threerings.parlor.server.ParlorSender +
Issues a notification that will result in a call to ParlorReceiver.receivedInviteCancellation(int) on a client. +
sendInviteResponse(ClientObject, int, int, Object) - +Static method in class com.threerings.parlor.server.ParlorSender +
Issues a notification that will result in a call to ParlorReceiver.receivedInviteResponse(int, int, java.lang.Object) on a client. +
sendProgressUpdate() - +Method in class com.threerings.puzzle.client.PuzzleController +
Sends the server a game progress update with the list of events, as well as board states if + PuzzlePanel.isSyncingBoards() is true. +
SENT_CARDS_TO_PLAYER - +Static variable in class com.threerings.parlor.card.client.CardGameDecoder +
The method id used to dispatch CardGameReceiver.sentCardsToPlayer(int, com.threerings.parlor.card.data.Card[]) + notifications. +
sentCardsToPlayer(int, Card[]) - +Method in class com.threerings.parlor.card.client.CardGameController +
Dispatched to the client when the server has forced it to send a set of cards to another + player. +
sentCardsToPlayer(int, Card[]) - +Method in interface com.threerings.parlor.card.client.CardGameReceiver +
Dispatched to the client when the server has forced it to send + a set of cards to another player. +
sentCardsToPlayer(ClientObject, int, Card[]) - +Static method in class com.threerings.parlor.card.server.CardGameSender +
Issues a notification that will result in a call to CardGameReceiver.sentCardsToPlayer(int, com.threerings.parlor.card.data.Card[]) on a client. +
SESSION_ID - +Static variable in class com.threerings.parlor.game.data.GameObject +
The field name of the sessionId field. +
sessionId - +Variable in class com.threerings.parlor.game.data.GameObject +
A unique identifier for each game session. +
setActionMode(String) - +Method in class com.threerings.stage.tools.editor.EditorModel +
Sets the editor action mode. +
setActive(boolean) - +Method in class com.threerings.parlor.util.RobotPlayer +
Sets whether the robot player is actively posting action commands. +
setAI(int, GameAI) - +Method in class com.threerings.parlor.game.server.GameManager +
Sets the specified player as an AI with the specified configuration. +
setAI(int, GameAI) - +Method in class com.threerings.parlor.game.server.GameManagerDelegate +
Called when the specified player has been set as an AI with the supplied AI configuration. +
setAllowBooting(boolean) - +Method in class com.threerings.parlor.server.TableManager +
Allow a player in the first position of a table to boot others. +
setAuxiliary(TileSet.Colorizer) - +Method in class com.threerings.stage.client.SceneColorizer +
Set an auxiliary colorizer that overrides our colorizations. +
setBackgroundImage(Mirage) - +Method in class com.threerings.puzzle.client.PuzzleBoardView +
Sets the background image displayed by the board view. +
setBaseTile(int, int, int) - +Method in class com.threerings.stage.tools.editor.EditorScenePanel +
Sets a base tile at the specified position in the scene (in tile + coordinates). +
setBaseTiles(Rectangle, int, int) - +Method in class com.threerings.stage.tools.editor.EditorScenePanel +
Set a region of tiles to a random selection from the supplied tileset. +
setBoard(Board) - +Method in class com.threerings.puzzle.client.PuzzleBoardView +
Sets the board to be displayed. +
setBoard(Board) - +Method in class com.threerings.puzzle.client.PuzzleController +
Called when a new board is set. +
setBoard(Board) - +Method in class com.threerings.puzzle.client.PuzzleControllerDelegate +
Called when the puzzle controller sets up a new board for the player. +
setBoard(Board) - +Method in class com.threerings.puzzle.data.BoardSummary +
Sets the board associated with this board summary, causing an immediate update to this + summary. +
setBoard(Board) - +Method in class com.threerings.puzzle.drop.client.DropBoardView +
  +
setBoard(Board) - +Method in class com.threerings.puzzle.drop.client.DropControllerDelegate +
  +
setBoard(int[], int, int) - +Method in class com.threerings.puzzle.drop.data.DropBoard +
Sets the board data and board dimensions. +
setBoard(int[]) - +Method in class com.threerings.puzzle.drop.data.DropBoard +
Sets the board pieces. +
setBoard(Board) - +Method in class com.threerings.puzzle.drop.data.DropBoardSummary +
  +
setBoardLocation(int, int) - +Method in class com.threerings.puzzle.drop.client.DropBlockSprite +
  +
setBoardLocation(int, int) - +Method in class com.threerings.puzzle.drop.client.DropSprite +
Sets the row and column the piece is located in. +
setBoardSummary(BoardSummary) - +Method in class com.threerings.puzzle.client.PlayerStatusView +
Sets the player board summary. +
setBouncing(boolean) - +Method in class com.threerings.puzzle.drop.client.DropSprite +
Puts the drop sprite into (or takes it out of) bouncing mode. +
setBounds(int, int, int, int) - +Method in class com.threerings.stage.tools.editor.EditorScenePanel +
  +
setBounds(int, int, int, int) - +Method in class com.threerings.stage.tools.editor.EditorScrollBox +
  +
setCard(Card) - +Method in class com.threerings.parlor.card.client.CardSprite +
Sets the card to depict. +
setCardsPlayed(PlayerCard[]) - +Method in interface com.threerings.parlor.card.trick.data.TrickCardGameObject +
Sets the array of cards played by each player. +
setChatDirector(ChatDirector) - +Method in class com.threerings.whirled.spot.client.SpotSceneDirector +
Configures this spot scene director with a chat director, with which it will coordinate to + implement cluster chatting. +
setChatting(boolean) - +Method in class com.threerings.puzzle.client.PuzzleController +
Sets whether we're focusing on the chat window rather than the puzzle. +
setChatting(boolean) - +Method in class com.threerings.puzzle.client.PuzzleControllerDelegate +
Called when the user toggles chatting mode. +
setClusterOid(int) - +Method in interface com.threerings.whirled.spot.data.ClusteredBodyObject +
Sets the oid of the cluster to which this user currently belongs. +
setClusters(DSet<Cluster>) - +Method in class com.threerings.whirled.spot.data.SpotSceneObject +
Requests that the clusters field be set to the + specified value. +
setColor(int, int) - +Method in class com.threerings.stage.server.StageSceneManager +
Changes the default colorization for the specified color class. +
setColumn(int) - +Method in class com.threerings.puzzle.drop.client.DropBlockSprite +
  +
setColumn(int) - +Method in class com.threerings.puzzle.drop.client.DropSprite +
Sets the column the piece is located in. +
setColumnOffset(int) - +Method in class com.threerings.puzzle.drop.client.DropSprite +
Sets the column offset of the sprite image. +
setConfig(TourneyConfig) - +Method in class com.threerings.parlor.tourney.data.TourneyObject +
Requests that the config field be set to the + specified value. +
setContainer(StatSet.Container) - +Method in class com.threerings.stats.data.StatSet +
Wires this stat set up to a containing user object. +
setController(Controller) - +Method in class com.threerings.micasa.client.MiCasaFrame +
Sets the controller for the outermost scope. +
setController(Controller) - +Method in interface com.threerings.micasa.simulator.client.SimulatorFrame +
Sets the controller for the outermost scope. +
setController(PuzzleController) - +Method in class com.threerings.puzzle.client.PuzzleBoardView +
Provides the board view with a reference to its controller so that it may communicate + directly rather than by posting actions up the interface hierarchy which sometimes fails if + the puzzle board view is hidden before we get a chance to post our actions. +
setDefaultColor(int, int) - +Method in class com.threerings.stage.data.StageScene +
Set the default color to use for the specified colorization class id. +
setDefaultColor(int, int) - +Method in class com.threerings.stage.data.StageSceneModel +
Set the default colorId to use for a specified colorization + classId, or -1 to clear the default for that colorization. +
setDefaultEntrance(Portal) - +Method in class com.threerings.stage.data.StageScene +
  +
setDefaultEntrance(Portal) - +Method in interface com.threerings.whirled.spot.data.SpotScene +
Sets the default entrance in this scene, immediately making the requisite modifications to + the underlying scene model. +
setDefaultEntrance(Portal) - +Method in class com.threerings.whirled.spot.data.SpotSceneImpl +
  +
setDefaultEntranceId(int) - +Method in class com.threerings.whirled.spot.data.SpotSceneImpl +
Used when we're being parsed from an XML scene model. +
setDifficulty(int) - +Method in class com.threerings.puzzle.data.PuzzleObject +
Requests that the difficulty field be set to the + specified value. +
setDirection(int) - +Method in class com.threerings.stage.tools.editor.DirectionButton +
Set the currently displayed direction +
setDraggable(boolean) - +Method in class com.threerings.parlor.card.client.CardSprite +
Sets whether or not the user can drag this card around the board. +
setDrawText(String) - +Method in class com.threerings.parlor.turn.client.TurnDisplay +
Sets the text to be displayed next to everyone's name in the event of a + draw. +
setEditorScrollBox(EditorScrollBox) - +Method in class com.threerings.stage.tools.editor.EditorScenePanel +
Set the scroll box that tracks our view. +
setEntrance(Portal) - +Method in class com.threerings.stage.tools.editor.EditorScenePanel +
Makes the specified portal the default entrance to this scene. +
setFacingUp(boolean) - +Method in class com.threerings.parlor.card.client.CardSprite +
Turns this card up or down. +
setGameConfig(GameConfig) - +Method in class com.threerings.parlor.game.client.GameConfigurator +
Provides this configurator with its configuration. +
setGameOver(boolean) - +Method in class com.threerings.parlor.game.client.GameController +
Sets the client game over override. +
setGameOver(boolean) - +Method in class com.threerings.puzzle.client.PuzzleController +
  +
setHand(Hand, long) - +Method in class com.threerings.parlor.card.client.CardPanel +
Fades a hand of cards in. +
setHand(int, long) - +Method in class com.threerings.parlor.card.client.CardPanel +
Fades a hand of cards in face-down. +
setHandLocation(int, int) - +Method in class com.threerings.parlor.card.client.CardPanel +
Sets the location of the hand (the location of the center of the hand's upper edge). +
setHandSelectionMode(int) - +Method in class com.threerings.parlor.card.client.CardPanel +
Sets the selection mode for the hand (NONE, PLAY_SINGLE, SINGLE, or MULTIPLE). +
setHandSelectionPredicate(Predicate<CardSprite>) - +Method in class com.threerings.parlor.card.client.CardPanel +
Sets the selection predicate that determines which cards from the hand may be selected (if + null, all cards may be selected). +
setHandSpacing(int) - +Method in class com.threerings.parlor.card.client.CardPanel +
Sets the horizontal spacing between cards in the hand. +
setHighlighted(boolean) - +Method in class com.threerings.puzzle.client.PlayerStatusView +
Sets whether to highlight the player status display when rendered. +
setHostedZones(DSet<HostedZone>) - +Method in class com.threerings.whirled.zone.peer.server.ZoneNodeObject +
Requests that the hostedZones field be set to the + specified value. +
setId(int) - +Method in interface com.threerings.whirled.data.Scene +
Sets this scene's unique identifier. +
setId(int) - +Method in class com.threerings.whirled.data.SceneImpl +
  +
setIder(UserIdentifier.Ider) - +Static method in class com.threerings.parlor.game.data.UserIdentifier +
Set the global user identifier to use. +
setInvitationHandler(InvitationHandler) - +Method in class com.threerings.parlor.client.ParlorDirector +
Sets the invitation handler, which is the entity that will be notified when we receive + incoming invitation notifications and when invitations have been cancelled. +
setIsPrivate(boolean) - +Method in class com.threerings.parlor.game.data.GameObject +
Requests that the isPrivate field be set to the + specified value. +
setIsRated(boolean) - +Method in class com.threerings.parlor.game.data.GameObject +
Requests that the isRated field be set to the + specified value. +
setLastCardsPlayed(PlayerCard[]) - +Method in interface com.threerings.parlor.card.trick.data.TrickCardGameObject +
Sets the last array of cards played by each player. +
setLayerIndex(int) - +Method in class com.threerings.stage.tools.editor.EditorModel +
Sets the scene layer index undergoing edit. +
setLightLevel(float) - +Method in class com.threerings.stage.data.StageSceneObject +
Requests that the lightLevel field be set to the + specified value. +
setLightShade(int) - +Method in class com.threerings.stage.data.StageSceneObject +
Requests that the lightShade field be set to the + specified value. +
setMisoSceneModel(StageMisoSceneModel) - +Method in class com.threerings.stage.tools.editor.EditorFrame +
  +
setMisoSceneModel(StageMisoSceneModel) - +Method in interface com.threerings.stage.tools.editor.EditorScenePanel.SceneModelListener +
  +
setModCount(byte) - +Method in class com.threerings.stats.data.Stat +
Sets the modification count for this Stat. +
setModified(boolean) - +Method in class com.threerings.stats.data.Stat +
Forces this stat to consider itself modified. +
setMoveHandler(SceneDirector.MoveHandler) - +Method in class com.threerings.whirled.client.SceneDirector +
Sets the moveHandler for use in SceneDirector.recoverFailedMove(int). +
setName(String) - +Method in interface com.threerings.whirled.data.Scene +
Sets the human readable name of this scene. +
setName(String) - +Method in class com.threerings.whirled.data.SceneImpl +
  +
setNextBlock(int[]) - +Method in interface com.threerings.puzzle.drop.client.DropPanel +
Sets the next block to be displayed. +
setObjectGripDirection(int) - +Method in class com.threerings.stage.tools.editor.EditorModel +
Sets the direction in which we should grip objects. +
setOccupantLocs(DSet<SceneLocation>) - +Method in class com.threerings.whirled.spot.data.SpotSceneObject +
Requests that the occupantLocs field be set to the + specified value. +
setOrientation(int) - +Method in class com.threerings.puzzle.drop.client.DropBlockSprite +
Updates the sprite image offset to reflect the direction in which the external piece is + hanging. +
setOrientation(int) - +Method in class com.threerings.puzzle.drop.client.DropSprite +
  +
setPanel(JPanel) - +Method in class com.threerings.micasa.client.MiCasaFrame +
Sets the panel that makes up the entire client display. +
setPanel(JPanel) - +Method in interface com.threerings.micasa.simulator.client.SimulatorFrame +
Sets the panel that makes up the entire client display. +
setParticipants(DSet<Participant>) - +Method in class com.threerings.parlor.tourney.data.TourneyObject +
Requests that the participants field be set to the + specified value. +
setPaused(boolean) - +Method in class com.threerings.puzzle.client.PuzzleBoardView +
Set whether this puzzle is paused or not. +
setPiece(int, int, int) - +Method in class com.threerings.puzzle.drop.data.DropBoard +
Sets the piece at the given coordinates. +
setPieces(int[]) - +Method in class com.threerings.puzzle.drop.client.DropSprite +
Sets the pieces the sprite is displaying. +
setPieces(int[]) - +Method in class com.threerings.puzzle.drop.client.NextBlockView +
Sets the pieces displayed by the view. +
setPlacingTile(Tile) - +Method in class com.threerings.stage.tools.editor.EditorScenePanel +
Sets the tile that is currently being placed. +
setPlayer(int, BodyObject) - +Method in class com.threerings.parlor.data.Table +
Requests to seat the specified user at the specified position in this table. +
setPlayerIcons(Icon[]) - +Method in class com.threerings.parlor.turn.client.TurnDisplay +
Set optional icons to use for identifying each player in the game. +
setPlayerPos(int, BodyObject) - +Method in class com.threerings.parlor.data.Table +
This method is used for party games, it does no bounds checking or verification of the + player's ability to join, if you are unsure you should call 'setPlayer'. +
setPlayers(Name[]) - +Method in class com.threerings.parlor.game.data.GameObject +
Requests that the players field be set to the + specified value. +
setPlayersAt(Name, int) - +Method in class com.threerings.parlor.game.data.GameObject +
Requests that the indexth element of + players field be set to the specified value. +
setPlayerStatus(int[]) - +Method in class com.threerings.parlor.game.data.GameObject +
Requests that the playerStatus field be set to the + specified value. +
setPlayerStatusAt(int, int) - +Method in class com.threerings.parlor.game.data.GameObject +
Requests that the indexth element of + playerStatus field be set to the specified value. +
setPuzzleGameService(PuzzleGameMarshaller) - +Method in class com.threerings.puzzle.data.PuzzleObject +
Requests that the puzzleGameService field be set to the + specified value. +
setPuzzleGrabsKeys(boolean) - +Method in class com.threerings.puzzle.client.PuzzlePanel +
Sets whether the puzzle grabs keys or if they should go to the chat window. +
setRating(int, int, int, int) - +Method in class com.threerings.parlor.rating.server.persist.RatingRepository +
Set the rating and experience for a given player and game. +
setRect(int, int, int, int, int) - +Method in class com.threerings.puzzle.drop.data.DropBoard +
Sets the pieces within the specified rectangle to the given piece. +
setRematchRequests(int[]) - +Method in interface com.threerings.parlor.card.trick.data.TrickCardGameObject +
Sets the array of rematch requests. +
setRematchRequestsAt(int, int) - +Method in interface com.threerings.parlor.card.trick.data.TrickCardGameObject +
Sets an element of the rematch request array. +
setRequestFocus(boolean) - +Method in class com.threerings.micasa.client.ChatPanel +
Sets whether the chat box text entry field requests the keyboard + focus when the panel receives AncestorListener.ancestorAdded(javax.swing.event.AncestorEvent) or PlaceView.willEnterPlace(com.threerings.crowd.data.PlaceObject) + events. +
setRisingPaused(boolean) - +Method in class com.threerings.puzzle.drop.client.DropControllerDelegate +
Sets whether the board rising is paused. +
setRobotDelay(long) - +Method in class com.threerings.parlor.util.RobotPlayer +
Sets the delay in milliseconds between posting each action command. +
setRobotPlayer(boolean) - +Method in class com.threerings.puzzle.client.PuzzlePanel +
Sets whether this panel receives events periodically from a robot player. +
setRow(int) - +Method in class com.threerings.puzzle.drop.client.DropBlockSprite +
  +
setRow(int) - +Method in class com.threerings.puzzle.drop.client.DropSprite +
Set the row the piece is located in. +
setRowOffset(int) - +Method in class com.threerings.puzzle.drop.client.DropSprite +
Sets the row offset of the sprite image. +
setScene(StageScene) - +Method in class com.threerings.stage.client.StageScenePanel +
Sets the scene managed by the panel. +
setScene(StageScene) - +Method in class com.threerings.stage.tools.editor.SceneInfoPanel +
Called when the scene in the editor changes. +
setScene(StageScene, Location) - +Method in class com.threerings.stage.tools.viewer.ViewerScenePanel +
  +
setScene(SceneModel) - +Method in class com.threerings.whirled.tools.xml.SceneParser +
Called by the parser once the scene is parsed. +
setSceneModel(MisoSceneModel) - +Method in class com.threerings.stage.tools.editor.EditorScenePanel +
  +
setSceneRepository(SceneRepository) - +Method in class com.threerings.whirled.client.SceneDirector +
Set the scene repository. +
setSeed(long) - +Method in class com.threerings.puzzle.data.PuzzleObject +
Requests that the seed field be set to the + specified value. +
setSegment(int, int, int, int, int) - +Method in class com.threerings.puzzle.drop.data.DropBoard +
Sets the pieces in the given board segment to the specified piece. +
setSegment(int, int, int, int[]) - +Method in class com.threerings.puzzle.drop.data.DropBoard +
Sets the pieces in the given board segment to the specified pieces. +
setSelectableCardOffset(int) - +Method in class com.threerings.parlor.card.client.CardPanel +
Sets the vertical distance to offset cards that are selectable or playable. +
setSelectedCardOffset(int) - +Method in class com.threerings.parlor.card.client.CardPanel +
Sets the vertical distance to offset cards that are selected. +
setSessionId(int) - +Method in class com.threerings.parlor.game.data.GameObject +
Requests that the sessionId field be set to the + specified value. +
setShutdownListener(int, PeeredZoneRegistry.PeerZoneShutdownListener) - +Method in interface com.threerings.whirled.zone.peer.server.PeeredZoneManager +
Registers a shutdown listener with the zone. +
setSize(Dimension) - +Method in class com.threerings.stage.tools.editor.DirectionButton +
  +
setStageSceneService(StageSceneMarshaller) - +Method in class com.threerings.stage.data.StageSceneObject +
Requests that the stageSceneService field be set to the + specified value. +
setStartsIn(int) - +Method in class com.threerings.parlor.tourney.data.TourneyObject +
Requests that the startsIn field be set to the + specified value. +
SetStat<T> - Class in com.threerings.stats.data
 
SetStat() - +Constructor for class com.threerings.stats.data.SetStat +
  +
setStat(Stat.Type, int) - +Method in class com.threerings.stats.data.StatSet +
Sets an integer statistic in this set. +
setState(int) - +Method in class com.threerings.parlor.game.data.GameObject +
Requests that the state field be set to the + specified value. +
setState(int) - +Method in class com.threerings.parlor.tourney.data.TourneyObject +
Requests that the state field be set to the + specified value. +
setStatus(int) - +Method in class com.threerings.puzzle.client.PlayerStatusView +
Sets the player status. +
setSummaries(BoardSummary[]) - +Method in class com.threerings.puzzle.data.PuzzleObject +
Requests that the summaries field be set to the + specified value. +
setSummariesAt(BoardSummary, int) - +Method in class com.threerings.puzzle.data.PuzzleObject +
Requests that the indexth element of + summaries field be set to the specified value. +
setSummary(int, BoardSummary) - +Method in interface com.threerings.puzzle.drop.client.DropPanel +
Updates the board summary display for the given player. +
setTableClass(Class<? extends Table>) - +Method in class com.threerings.parlor.server.TableManager +
Set the subclass of Table that this instance should generate. +
setTableConfig(TableConfig) - +Method in class com.threerings.parlor.client.TableConfigurator +
Optionally, you can set a pre-configured TableConfig + that will be used to initialize the display parameters (if possible). +
setTableObject(DObject) - +Method in class com.threerings.parlor.client.TableDirector +
This must be called by the entity that uses the table director when the using entity + prepares to enter and display a place. +
setTableObject(DObject) - +Method in class com.threerings.parlor.server.TableManager +
Initialize the TableLobbyObject. +
setTableService(TableMarshaller) - +Method in class com.threerings.micasa.lobby.table.TableLobbyObject +
Requests that the tableService field be set to the + specified value. +
setTableService(TableMarshaller) - +Method in interface com.threerings.parlor.data.TableLobbyObject +
Configures the table service that clients should use to communicate table requests back to + the table manager handling these tables. +
setTableSet(DSet<Table>) - +Method in class com.threerings.micasa.lobby.table.TableLobbyObject +
Requests that the tableSet field be set to the + specified value. +
setTeamMemberIndices(int[][]) - +Method in interface com.threerings.parlor.game.server.TeamGameManager +
Set the team member indices. +
setTestTileDirectory(String) - +Static method in class com.threerings.stage.tools.editor.EditorConfig +
Accessor method for setting the test tile directory. +
setTile(TileSet, int, int) - +Method in class com.threerings.stage.tools.editor.EditorModel +
Sets the selected tile for placement within the scene. +
setTileId(int) - +Method in class com.threerings.stage.tools.editor.EditorModel +
Sets the tile id of the tile selected for placement within the + scene. +
setTileSelectRegion(Point) - +Method in class com.threerings.stage.tools.editor.EditorScenePanel +
Sets the start (in tile coords) of a mouse drag when placing + a rectangular area of base tiles. +
setTourneyService(TourneyMarshaller) - +Method in class com.threerings.parlor.tourney.data.TourneyObject +
Requests that the tourneyService field be set to the + specified value. +
setTrickCardGameService(TrickCardGameMarshaller) - +Method in interface com.threerings.parlor.card.trick.data.TrickCardGameObject +
Sets the reference to the trick card game service. +
setTrickState(int) - +Method in interface com.threerings.parlor.card.trick.data.TrickCardGameObject +
Sets the trick state. +
setTurnDurationScales(float[]) - +Method in interface com.threerings.parlor.card.trick.data.TrickCardGameObject +
Sets the array of turn duration scales. +
setTurnDurationScalesAt(float, int) - +Method in interface com.threerings.parlor.card.trick.data.TrickCardGameObject +
Sets an element of the array of turn duration scales. +
setTurnHolder(Name) - +Method in interface com.threerings.parlor.turn.data.TurnGameObject +
Requests that the turnHolder field be set to the specified + value. +
setTurnIcon(Icon) - +Method in class com.threerings.parlor.turn.client.TurnDisplay +
Set the icon to use. +
setType(String) - +Method in class com.threerings.stage.data.StageScene +
Sets the type of this scene. +
setValue(int[]) - +Method in class com.threerings.stats.data.IntArrayStat +
Sets this statistic's value to the specified value. +
setValue(int) - +Method in class com.threerings.stats.data.IntStat +
Sets this statistic's value to the specified value. +
setValue(int) - +Method in class com.threerings.stats.data.MaxValueIntStat +
  +
setVelocity(float) - +Method in class com.threerings.puzzle.drop.client.DropSprite +
Sets the velocity of this sprite. +
setVersion(int) - +Method in interface com.threerings.whirled.data.Scene +
Sets this scene's version number. +
setVersion(int) - +Method in class com.threerings.whirled.data.SceneImpl +
  +
setWinners(boolean[]) - +Method in class com.threerings.parlor.game.data.GameObject +
Requests that the winners field be set to the + specified value. +
setWinnersAt(boolean, int) - +Method in class com.threerings.parlor.game.data.GameObject +
Requests that the indexth element of + winners field be set to the specified value. +
setWinnerText(String) - +Method in class com.threerings.parlor.turn.client.TurnDisplay +
Set the text to be displayed next to the winner's name. +
setZoneId(int) - +Method in interface com.threerings.whirled.zone.data.ZonedBodyObject +
Sets the zone id currently occupied by this body. +
ShortStringSetStat - Class in com.threerings.stats.data
A string set that maps its values to shorts.
ShortStringSetStat() - +Constructor for class com.threerings.stats.data.ShortStringSetStat +
  +
shouldBeStarted() - +Method in class com.threerings.parlor.data.Table +
Returns true if sufficient seats are occupied that the game should be automatically started. +
shouldConcludeGame() - +Method in class com.threerings.parlor.game.server.GameManager +
Returns whether game conclusion antics such as rating updates should be performed when an + in-play game is ended. +
shouldStart(long) - +Method in class com.threerings.parlor.tourney.server.TourneyManager +
Returns true if it is time or past time the tourney starts. +
SHOW_CLUSTERS - +Static variable in class com.threerings.stage.client.StageScenePanel +
Show flag that indicates we should show all clusters. +
SHOW_PLOTS - +Static variable in class com.threerings.stage.client.StageScenePanel +
Show flag that indicates we should render known land plots + (expensive, don't turn this on willy nilly). +
showHand(Hand) - +Method in class com.threerings.parlor.card.client.CardPanel +
Shows a hand that was previous set face-down. +
shuffle() - +Method in class com.threerings.parlor.card.data.Deck +
Shuffles the deck. +
shuffle(Random) - +Method in class com.threerings.parlor.card.data.Deck +
Shuffles the deck. +
shutdown() - +Method in class com.threerings.parlor.server.TableManager +
This must be called when the table manager is no longer needed. +
simClass - +Variable in class com.threerings.micasa.simulator.data.SimulatorInfo +
The simulant classname. +
SimpleClient - Class in com.threerings.micasa.simulator.client
 
SimpleClient(SimulatorFrame) - +Constructor for class com.threerings.micasa.simulator.client.SimpleClient +
  +
SimpleFrame - Class in com.threerings.micasa.simulator.client
Contains the user interface for the Simulator client application.
SimpleFrame() - +Constructor for class com.threerings.micasa.simulator.client.SimpleFrame +
Constructs the top-level Simulator client frame. +
SimpleServer - Class in com.threerings.micasa.simulator.server
A simple simulator server implementation that extends the MiCasa server.
SimpleServer() - +Constructor for class com.threerings.micasa.simulator.server.SimpleServer +
  +
Simulant - Class in com.threerings.micasa.simulator.server
 
Simulant() - +Constructor for class com.threerings.micasa.simulator.server.Simulant +
  +
SimulatorApp - Class in com.threerings.micasa.simulator.client
The simulator application is a test harness to facilitate development and debugging of games.
SimulatorApp() - +Constructor for class com.threerings.micasa.simulator.client.SimulatorApp +
  +
SimulatorClient - Interface in com.threerings.micasa.simulator.client
 
SimulatorContext - Interface in com.threerings.micasa.simulator.util
The simulator context encapsulates the contexts of all of the services + that are used by the simulator client so that we can pass around one + single context implementation that provides all of the necessary + components to all of the services in use.
SimulatorController - Class in com.threerings.micasa.simulator.client
Responsible for top-level control of the simulator client user interface.
SimulatorController(ParlorContext, SimulatorFrame, SimulatorInfo) - +Constructor for class com.threerings.micasa.simulator.client.SimulatorController +
Creates a new simulator controller. +
SimulatorFrame - Interface in com.threerings.micasa.simulator.client
Contains the user interface for the Simulator client application.
SimulatorInfo - Class in com.threerings.micasa.simulator.data
 
SimulatorInfo() - +Constructor for class com.threerings.micasa.simulator.data.SimulatorInfo +
  +
SimulatorManager - Class in com.threerings.micasa.simulator.server
The simulator manager is responsible for handling the simulator services on the server side.
SimulatorManager(InvocationManager) - +Constructor for class com.threerings.micasa.simulator.server.SimulatorManager +
  +
SimulatorManager.CreateGameTask - Class in com.threerings.micasa.simulator.server
 
SimulatorManager.CreateGameTask(BodyObject, GameConfig, String, int) - +Constructor for class com.threerings.micasa.simulator.server.SimulatorManager.CreateGameTask +
  +
SimulatorMarshaller - Class in com.threerings.micasa.simulator.data
Provides the implementation of the SimulatorService interface + that marshalls the arguments and delivers the request to the provider + on the server.
SimulatorMarshaller() - +Constructor for class com.threerings.micasa.simulator.data.SimulatorMarshaller +
  +
SimulatorProvider - Class in com.threerings.micasa.simulator.server
The simulator provider handles game creation requests on the server + side, passing them off to the SimulatorManager.
SimulatorProvider(SimulatorManager) - +Constructor for class com.threerings.micasa.simulator.server.SimulatorProvider +
Constructs a simulator provider. +
SimulatorServer - Interface in com.threerings.micasa.simulator.server
The simulator manager needs a mechanism for faking body object registrations, which is provided + by implementations of this interface.
SimulatorService - Interface in com.threerings.micasa.simulator.client
Provides access to simulator invocation services.
SINGLE - +Static variable in class com.threerings.parlor.card.client.CardPanel +
The selection mode in which the user can select a single card. +
size() - +Method in class com.threerings.puzzle.drop.data.DropBoard +
Returns the size of the board in pieces. +
size() - +Method in class com.threerings.puzzle.util.PointSet +
Returns the number of points in the set. +
size() - +Method in class com.threerings.stats.data.IntSetStat +
Returns the number of values stored in the set. +
size() - +Method in class com.threerings.stats.data.SetStat +
Returns the number of elements in this set. +
size() - +Method in class com.threerings.stats.data.StringSetStat +
Returns the number of Strings in this set. +
skill - +Variable in class com.threerings.parlor.game.data.GameAI +
The skill level of the AI. +
SPADES - +Static variable in interface com.threerings.parlor.card.data.CardCodes +
The suit of spades. +
SpotClient - Class in com.threerings.whirled.spot.server
Extends the Whirled client and handles the necessary notifications that take place when a user + logs off to let the clients displaying the scene they were occupying know that they didn't exit + via a portal, but instead just disappeared.
SpotClient() - +Constructor for class com.threerings.whirled.spot.server.SpotClient +
  +
SpotCodes - Interface in com.threerings.whirled.spot.data
Contains codes used by the Spot invocation services.
SpotMarshaller - Class in com.threerings.whirled.spot.data
Provides the implementation of the SpotService interface + that marshalls the arguments and delivers the request to the provider + on the server.
SpotMarshaller() - +Constructor for class com.threerings.whirled.spot.data.SpotMarshaller +
  +
SpotMarshaller.SpotSceneMoveMarshaller - Class in com.threerings.whirled.spot.data
Marshalls results to implementations of SpotService.SpotSceneMoveListener.
SpotMarshaller.SpotSceneMoveMarshaller() - +Constructor for class com.threerings.whirled.spot.data.SpotMarshaller.SpotSceneMoveMarshaller +
  +
SpotProvider - Interface in com.threerings.whirled.spot.server
Defines the server-side of the SpotService.
SpotScene - Interface in com.threerings.whirled.spot.data
Makes available the spot scene information that the server needs to do its business.
SpotSceneController - Class in com.threerings.whirled.spot.client
The base spot scene controller class.
SpotSceneController() - +Constructor for class com.threerings.whirled.spot.client.SpotSceneController +
  +
SpotSceneDirector - Class in com.threerings.whirled.spot.client
Extends the standard scene director with facilities to move between locations within a scene.
SpotSceneDirector(WhirledContext, LocationDirector, SceneDirector) - +Constructor for class com.threerings.whirled.spot.client.SpotSceneDirector +
Creates a new spot scene director with the specified context and which will cooperate with + the supplied scene director. +
SpotSceneImpl - Class in com.threerings.whirled.spot.data
An implementation of the SpotScene interface.
SpotSceneImpl(SpotSceneModel) - +Constructor for class com.threerings.whirled.spot.data.SpotSceneImpl +
Creates an instance that will obtain data from the supplied spot scene model. +
SpotSceneImpl() - +Constructor for class com.threerings.whirled.spot.data.SpotSceneImpl +
Instantiates a blank scene implementation. +
SpotSceneManager - Class in com.threerings.whirled.spot.server
Handles the movement of bodies between locations in the scene and creates the necessary + distributed objects to allow bodies in clusters to chat with one another.
SpotSceneManager() - +Constructor for class com.threerings.whirled.spot.server.SpotSceneManager +
  +
SpotSceneModel - Class in com.threerings.whirled.spot.data
The spot scene model extends the standard scene model with information on portals.
SpotSceneModel() - +Constructor for class com.threerings.whirled.spot.data.SpotSceneModel +
  +
SpotSceneMoveHandler - Class in com.threerings.whirled.spot.server
Moves a player between scenes, accounting for their exit and entry via portals.
SpotSceneMoveHandler(LocationManager, SpotSceneManager, BodyObject, int, Portal, SceneService.SceneMoveListener) - +Constructor for class com.threerings.whirled.spot.server.SpotSceneMoveHandler +
  +
SpotSceneObject - Class in com.threerings.whirled.spot.data
Extends the SceneObject with information specific to spots.
SpotSceneObject() - +Constructor for class com.threerings.whirled.spot.data.SpotSceneObject +
  +
SpotSceneRegistry - Class in com.threerings.whirled.spot.server
Extends the SceneRegistry with spot-related services.
SpotSceneRegistry(InvocationManager) - +Constructor for class com.threerings.whirled.spot.server.SpotSceneRegistry +
Constructs a spot scene registry. +
SpotSceneRuleSet - Class in com.threerings.whirled.spot.tools.xml
Used to parse a SpotSceneModel from XML.
SpotSceneRuleSet() - +Constructor for class com.threerings.whirled.spot.tools.xml.SpotSceneRuleSet +
  +
SpotSceneWriter - Class in com.threerings.whirled.spot.tools.xml
Generates an XML representation of a SpotSceneModel.
SpotSceneWriter() - +Constructor for class com.threerings.whirled.spot.tools.xml.SpotSceneWriter +
  +
SpotService - Interface in com.threerings.whirled.spot.client
Defines the mechanism by which the client can request to move around + within a scene and between scenes (taking exit and entry locations into + account).
SpotService.SpotSceneMoveListener - Interface in com.threerings.whirled.spot.client
Used to communicate the response to a SceneService.moveTo(int, int, com.threerings.whirled.client.SceneService.SceneMoveListener) request.
STAGE_MESSAGE_BUNDLE - +Static variable in interface com.threerings.stage.data.StageCodes +
The i18n bundle identifier for the Stage system. +
STAGE_SCENE_SERVICE - +Static variable in class com.threerings.stage.data.StageSceneObject +
The field name of the stageSceneService field. +
StageCodes - Interface in com.threerings.stage.data
Codes and constants relating to the Stage system.
StageContext - Interface in com.threerings.stage.util
A context that provides for the myriad requirements of the Stage system.
StageLocation - Class in com.threerings.stage.data
Contains information on a scene occupant's position and orientation.
StageLocation() - +Constructor for class com.threerings.stage.data.StageLocation +
A zero-argument constructor used when unserializing instances. +
StageLocation(int, int, byte) - +Constructor for class com.threerings.stage.data.StageLocation +
Constructs a location with the specified coordinates and + orientation. +
StageMisoSceneModel - Class in com.threerings.stage.data
Extends the SparseMisoSceneModel with the necessary interface + to wire it up to the Whirled auxiliary model system.
StageMisoSceneModel() - +Constructor for class com.threerings.stage.data.StageMisoSceneModel +
Creates a completely uninitialized scene model. +
StageMisoSceneRuleSet - Class in com.threerings.stage.tools.xml
Customizes the miso scene rule set such that it creates StageMisoSceneModel instances.
StageMisoSceneRuleSet() - +Constructor for class com.threerings.stage.tools.xml.StageMisoSceneRuleSet +
  +
StageOccupantInfo - Class in com.threerings.stage.data
Extends the standard occupant info with stage specific business.
StageOccupantInfo(BodyObject) - +Constructor for class com.threerings.stage.data.StageOccupantInfo +
Creates a new instance for the specified body. +
StageOccupantInfo() - +Constructor for class com.threerings.stage.data.StageOccupantInfo +
Used for unserialization. +
StageScene - Class in com.threerings.stage.data
The implementation of the Stage scene interface.
StageScene(StageSceneModel, PlaceConfig) - +Constructor for class com.threerings.stage.data.StageScene +
Creates an instance that will obtain data from the supplied scene + model and place config. +
StageSceneConfig - Class in com.threerings.stage.data
Place configuration for the main isometric scenes in Stage.
StageSceneConfig() - +Constructor for class com.threerings.stage.data.StageSceneConfig +
  +
StageSceneController - Class in com.threerings.stage.client
Extends the SpotSceneController with functionality specific to + displaying Stage scenes.
StageSceneController() - +Constructor for class com.threerings.stage.client.StageSceneController +
  +
StageSceneManager - Class in com.threerings.stage.server
Defines extensions to the basic Stage scene manager specific to displaying isometric "stage" + scenes (these may be indoor, outdoor or aboard a vessel).
StageSceneManager() - +Constructor for class com.threerings.stage.server.StageSceneManager +
  +
StageSceneMarshaller - Class in com.threerings.stage.data
Provides the implementation of the StageSceneService interface + that marshalls the arguments and delivers the request to the provider + on the server.
StageSceneMarshaller() - +Constructor for class com.threerings.stage.data.StageSceneMarshaller +
  +
StageSceneModel - Class in com.threerings.stage.data
Extends the basic scene model with the notion of a scene type and + incorporates the necessary auxiliary models used by the Stage system.
StageSceneModel() - +Constructor for class com.threerings.stage.data.StageSceneModel +
  +
StageSceneObject - Class in com.threerings.stage.data
Extends the basic SpotSceneObject with data and services + specific to isometric stage scenes.
StageSceneObject() - +Constructor for class com.threerings.stage.data.StageSceneObject +
  +
StageScenePanel - Class in com.threerings.stage.client
Extends the basic Miso scene panel with Stage fun stuff like portals, clusters and locations.
StageScenePanel(StageContext, Controller) - +Constructor for class com.threerings.stage.client.StageScenePanel +
Constructs a stage scene view panel. +
StageSceneParser - Class in com.threerings.stage.tools.xml
Parses StageSceneModel instances from an XML description file.
StageSceneParser() - +Constructor for class com.threerings.stage.tools.xml.StageSceneParser +
Constructs a parser that can be used to parse Stage scene models. +
StageSceneProvider - Interface in com.threerings.stage.server
Defines the server-side of the StageSceneService.
StageSceneRuleSet - Class in com.threerings.stage.tools.xml
Used to parse an StageScene from XML.
StageSceneRuleSet() - +Constructor for class com.threerings.stage.tools.xml.StageSceneRuleSet +
  +
StageSceneService - Interface in com.threerings.stage.client
Provides services relating to Stage scenes.
stageSceneService - +Variable in class com.threerings.stage.data.StageSceneObject +
Provides stage scene services. +
StageSceneUtil - Class in com.threerings.stage.util
Provides scene related utility functions.
StageSceneUtil() - +Constructor for class com.threerings.stage.util.StageSceneUtil +
  +
StageSceneWriter - Class in com.threerings.stage.tools.xml
Generates an XML representation of a StageSceneModel.
StageSceneWriter() - +Constructor for class com.threerings.stage.tools.xml.StageSceneWriter +
  +
StageServer - Class in com.threerings.stage.server
Extends the Whirled server to provide services needed by the Stage system.
StageServer() - +Constructor for class com.threerings.stage.server.StageServer +
  +
StageServer.StageModule - Class in com.threerings.stage.server
Configures dependencies needed by the Stage services.
StageServer.StageModule() - +Constructor for class com.threerings.stage.server.StageServer.StageModule +
  +
start() - +Method in class com.threerings.micasa.client.MiCasaApplet +
Display the client frame and really get things going. +
start(String[]) - +Method in class com.threerings.micasa.simulator.client.SimulatorApp +
  +
start - +Variable in class com.threerings.parlor.data.ChoiceParameter +
The starting selection. +
start - +Variable in class com.threerings.parlor.data.RangeParameter +
The starting value for this parameter. +
start - +Variable in class com.threerings.parlor.data.ToggleParameter +
The starting state for this parameter. +
START_DROP_BLOCK - +Static variable in class com.threerings.puzzle.drop.client.DropControllerDelegate +
The action command for starting to dropping the block. +
START_SOLITAIRE - +Static variable in class com.threerings.parlor.data.ParlorMarshaller +
The method id used to dispatch ParlorMarshaller.startSolitaire(com.threerings.parlor.game.data.GameConfig, com.threerings.presents.client.InvocationService.ConfirmListener) requests. +
START_TABLE_NOW - +Static variable in class com.threerings.parlor.data.TableMarshaller +
The method id used to dispatch TableMarshaller.startTableNow(int, com.threerings.presents.client.InvocationService.InvocationListener) requests. +
startAction() - +Method in class com.threerings.puzzle.client.PuzzlePanel +
Called by the controller when the action starts. +
startGame() - +Method in class com.threerings.parlor.game.server.GameManager +
This is called when the game is ready to start (all players involved have delivered their + "am ready" notifications). +
startHand() - +Method in class com.threerings.parlor.card.trick.server.TrickCardGameManagerDelegate +
Starts a hand of cards. +
STARTS_IN - +Static variable in class com.threerings.parlor.tourney.data.TourneyObject +
The field name of the startsIn field. +
startsIn - +Variable in class com.threerings.parlor.tourney.data.TourneyConfig +
The number of minutes to wait for entrants before starting. +
startsIn - +Variable in class com.threerings.parlor.tourney.data.TourneyObject +
The real-time number of minutes before it starts. +
startSolitaire(GameConfig, InvocationService.ConfirmListener) - +Method in class com.threerings.parlor.client.ParlorDirector +
Requests that the specified single player game be started. +
startSolitaire(GameConfig, InvocationService.ConfirmListener) - +Method in interface com.threerings.parlor.client.ParlorService +
Requests to start a single player game with the specified game configuration. +
startSolitaire(GameConfig, InvocationService.ConfirmListener) - +Method in class com.threerings.parlor.data.ParlorMarshaller +
  +
startSolitaire(ClientObject, GameConfig, InvocationService.ConfirmListener) - +Method in class com.threerings.parlor.server.ParlorManager +
  +
startSolitaire(ClientObject, GameConfig, InvocationService.ConfirmListener) - +Method in interface com.threerings.parlor.server.ParlorProvider +
Handles a ParlorService.startSolitaire(com.threerings.parlor.game.data.GameConfig, com.threerings.presents.client.InvocationService.ConfirmListener) request. +
startTableNow(int) - +Method in class com.threerings.parlor.client.TableDirector +
Sends a request to have the specified table start now, even if all the seats have not yet + been filled. +
startTableNow(int, InvocationService.InvocationListener) - +Method in interface com.threerings.parlor.client.TableService +
Requests that the specified table be started now, even if all seats are not occupied. +
startTableNow(int, InvocationService.InvocationListener) - +Method in class com.threerings.parlor.data.TableMarshaller +
  +
startTableNow(ClientObject, int, InvocationService.InvocationListener) - +Method in class com.threerings.parlor.server.TableManager +
  +
startTableNow(ClientObject, int, InvocationService.InvocationListener) - +Method in interface com.threerings.parlor.server.TableProvider +
Handles a TableService.startTableNow(int, com.threerings.presents.client.InvocationService.InvocationListener) request. +
startTrick() - +Method in class com.threerings.parlor.card.trick.server.TrickCardGameManagerDelegate +
Starts a trick. +
startTurn() - +Method in class com.threerings.parlor.card.trick.server.TrickCardGameManagerDelegate +
  +
startTurn() - +Method in class com.threerings.parlor.turn.server.TurnGameManagerDelegate +
Called to start the next turn. +
Stat - Class in com.threerings.stats.data
A base class for persistent statistics tracked on a per-player basis (some for a single game, + others for all time).
Stat() - +Constructor for class com.threerings.stats.data.Stat +
  +
Stat.AuxDataSource - Interface in com.threerings.stats.data
Provides auxilliary information to statistics during the persisting process.
Stat.Type - Interface in com.threerings.stats.data
Defines the various per-player tracked statistics.
STAT_CODE - +Static variable in class com.threerings.stats.server.persist.StatRecord +
  +
STAT_CODE - +Static variable in class com.threerings.stats.server.persist.StringCodeRecord +
  +
STAT_DATA - +Static variable in class com.threerings.stats.server.persist.StatRecord +
  +
statCode - +Variable in class com.threerings.stats.server.persist.StatRecord +
The code of the stat. +
statCode - +Variable in class com.threerings.stats.server.persist.StringCodeRecord +
The code of the stat. +
statCodeCode() - +Static method in class com.threerings.stats.server.persist.StringCodeRecord +
Defines the statCodeCode unique index. +
statCodeValue() - +Static method in class com.threerings.stats.server.persist.StringCodeRecord +
Defines the statCodeValue unique index. +
statData - +Variable in class com.threerings.stats.server.persist.StatRecord +
The data associated with the stat. +
STATE - +Static variable in class com.threerings.parlor.game.data.GameObject +
The field name of the state field. +
state - +Variable in class com.threerings.parlor.game.data.GameObject +
The game state, one of GameObject.PRE_GAME, GameObject.IN_PLAY, GameObject.GAME_OVER, or + GameObject.CANCELLED. +
STATE - +Static variable in class com.threerings.parlor.tourney.data.TourneyObject +
The field name of the state field. +
state - +Variable in class com.threerings.parlor.tourney.data.TourneyObject +
The current state of the tourney. +
stateChanged(ChangeEvent) - +Method in class com.threerings.stage.tools.editor.EditorScenePanel +
  +
StatModifier<T extends Stat> - Class in com.threerings.stats.data
Encapsulates a modification to a single stat that can be serialized and sent to a different + server, if needed, to update stats loaded at runtime.
StatModifier(Stat.Type) - +Constructor for class com.threerings.stats.data.StatModifier +
Creates a modifier that will operate on the supplied stat type. +
StatRecord - Class in com.threerings.stats.server.persist
 
StatRecord() - +Constructor for class com.threerings.stats.server.persist.StatRecord +
An empty constructor for unmarshalling. +
StatRecord(int, int, byte[]) - +Constructor for class com.threerings.stats.server.persist.StatRecord +
A constructor that populates all our fields. +
StatRecord(int, int, byte[], byte) - +Constructor for class com.threerings.stats.server.persist.StatRecord +
  +
StatRepository - Class in com.threerings.stats.server.persist
Responsible for the persistent storage of per-player statistics.
StatRepository(PersistenceContext) - +Constructor for class com.threerings.stats.server.persist.StatRepository +
Constructs a new statistics repository with the specified persistence context. +
StatSet - Class in com.threerings.stats.data
A distributed set containing Stat objects.
StatSet(Iterable<Stat>) - +Constructor for class com.threerings.stats.data.StatSet +
Creates a stat set with the specified contents. +
StatSet(Iterator<Stat>) - +Constructor for class com.threerings.stats.data.StatSet +
Creates a stat set with the specified contents. +
StatSet() - +Constructor for class com.threerings.stats.data.StatSet +
Creates a blank stat set. +
StatSet.Container - Interface in com.threerings.stats.data
An interface to be implemented by an entity that wishes to be notified when the contents of + a stat set change.
stop() - +Method in class com.threerings.micasa.client.MiCasaApplet +
Log off and shut on down. +
stop() - +Method in class com.threerings.puzzle.drop.client.DropSprite +
Stops the piece from dropping. +
storeSceneModel(SceneModel) - +Method in interface com.threerings.whirled.client.persist.SceneRepository +
Updates or inserts this scene model as appropriate. +
StringCodeRecord - Class in com.threerings.stats.server.persist
 
StringCodeRecord() - +Constructor for class com.threerings.stats.server.persist.StringCodeRecord +
An empty constructor for unmarshalling. +
StringCodeRecord(int, String, int) - +Constructor for class com.threerings.stats.server.persist.StringCodeRecord +
A constructor that populates all our fields. +
StringMapStat - Class in com.threerings.stats.data
Used to track a statistic comprised of a set of strings that map to numeric counts.
StringMapStat() - +Constructor for class com.threerings.stats.data.StringMapStat +
  +
StringSetStat - Class in com.threerings.stats.data
Used to track a statistic comprised of a set of strings.
StringSetStat() - +Constructor for class com.threerings.stats.data.StringSetStat +
  +
SUMMARIES - +Static variable in class com.threerings.puzzle.data.PuzzleObject +
The field name of the summaries field. +
summaries - +Variable in class com.threerings.puzzle.data.PuzzleObject +
Summaries of the boards of all players in this puzzle (may be null if the puzzle doesn't + support individual player boards). +
summarize() - +Method in class com.threerings.puzzle.data.BoardSummary +
Called by the PuzzleManager to refresh the board + summary information by studying the associated board contents. +
summarize() - +Method in class com.threerings.puzzle.drop.data.DropBoardSummary +
  +
SwingGameConfigurator - Class in com.threerings.parlor.game.client
Provides the base from which interfaces can be built to configure games + prior to starting them.
SwingGameConfigurator() - +Constructor for class com.threerings.parlor.game.client.SwingGameConfigurator +
  +
syncStat(StatModifier<T>) - +Method in class com.threerings.stats.data.StatSet +
Updates a stat in this set, using the supplied StatModifier. +
systemMessage(String, String) - +Method in class com.threerings.parlor.game.client.GameController +
A way for controllers to display a game-related system message. +
systemMessage(String, String) - +Method in class com.threerings.parlor.game.server.GameManager +
Sends a system message to the players in the game room. +
systemMessage(String, String, boolean) - +Method in class com.threerings.parlor.game.server.GameManager +
Sends a system message to the players in the game room. +
+
+

+T

+
+
table - +Variable in class com.threerings.micasa.lobby.table.TableItem +
A reference to the table we are displaying. +
Table - Class in com.threerings.parlor.data
This class represents a table that is being used to matchmake a game by the Parlor services.
Table() - +Constructor for class com.threerings.parlor.data.Table +
Constructs a blank table instance, suitable for unserialization. +
TABLE_POSITION_OCCUPIED - +Static variable in interface com.threerings.parlor.data.ParlorCodes +
An error code returned by the table services. +
TABLE_SERVICE - +Static variable in class com.threerings.micasa.lobby.table.TableLobbyObject +
The field name of the tableService field. +
TABLE_SET - +Static variable in class com.threerings.micasa.lobby.table.TableLobbyObject +
The field name of the tableSet field. +
tableAdded(Table) - +Method in class com.threerings.micasa.lobby.table.TableListView +
  +
tableAdded(Table) - +Method in interface com.threerings.parlor.client.TableObserver +
Called when a new table is created. +
TableConfig - Class in com.threerings.parlor.data
Table configuration parameters for a game that is to be matchmade using the table services.
TableConfig() - +Constructor for class com.threerings.parlor.data.TableConfig +
  +
TableConfigurator - Class in com.threerings.parlor.client
This should be implemented some user-interface element that allows + the user to configure whichever TableConfig options are relevant.
TableConfigurator() - +Constructor for class com.threerings.parlor.client.TableConfigurator +
Create a TableConfigurator. +
TableDirector - Class in com.threerings.parlor.client
As tables are created and managed within the scope of a place (a lobby), we want to fold the + table management functionality into the standard hierarchy of place controllers that deal with + place-related functionality on the client.
TableDirector(ParlorContext, String, TableObserver) - +Constructor for class com.threerings.parlor.client.TableDirector +
Creates a new table director to manage tables with the specified observer which will receive + callbacks when interesting table related things happen. +
tableId - +Variable in class com.threerings.parlor.data.Table +
The unique identifier for this table. +
TableItem - Class in com.threerings.micasa.lobby.table
A table item displays the user interface for a single table (whether it + be in-play or still being matchmade).
TableItem(MiCasaContext, TableDirector, Table) - +Constructor for class com.threerings.micasa.lobby.table.TableItem +
Creates a new table item to display and interact with the supplied + table. +
TableListView - Class in com.threerings.micasa.lobby.table
A view that displays the tables in a table lobby.
TableListView(MiCasaContext, LobbyConfig) - +Constructor for class com.threerings.micasa.lobby.table.TableListView +
Creates a new table list view, suitable for providing the user + interface for table-style matchmaking in a table lobby. +
TableLobbyConfig - Class in com.threerings.micasa.lobby.table
Instructs the lobby services to use a TableListView as the + matchmaking component.
TableLobbyConfig() - +Constructor for class com.threerings.micasa.lobby.table.TableLobbyConfig +
  +
TableLobbyManager - Class in com.threerings.micasa.lobby.table
Extends lobby manager only to ensure that a table lobby object is used for table lobbies.
TableLobbyManager() - +Constructor for class com.threerings.micasa.lobby.table.TableLobbyManager +
  +
TableLobbyObject - Class in com.threerings.micasa.lobby.table
 
TableLobbyObject() - +Constructor for class com.threerings.micasa.lobby.table.TableLobbyObject +
  +
TableLobbyObject - Interface in com.threerings.parlor.data
This interface must be implemented by the place object used by a lobby + that wishes to make use of the table services.
TableManager - Class in com.threerings.parlor.server
A table manager can be used by a place manager (or other entity) to take care of the management + of a table matchmaking service on a particular distributed object.
TableManager(RootDObjectManager, InvocationManager, PlaceRegistry, DObject) - +Constructor for class com.threerings.parlor.server.TableManager +
Creates a table manager that will manage tables in the supplied distributed object (which + must implement TableLobbyObject. +
TableMarshaller - Class in com.threerings.parlor.data
Provides the implementation of the TableService interface + that marshalls the arguments and delivers the request to the provider + on the server.
TableMarshaller() - +Constructor for class com.threerings.parlor.data.TableMarshaller +
  +
TableObserver - Interface in com.threerings.parlor.client
The TableDirector converts distributed object events into + higher level callbacks to implementers of this interface, which are + expected to render these events sensically in a user interface.
TableProvider - Interface in com.threerings.parlor.server
Defines the server-side of the TableService.
tableRemoved() - +Method in class com.threerings.micasa.lobby.table.TableItem +
Called by the table list view prior to removing us. +
tableRemoved(int) - +Method in class com.threerings.micasa.lobby.table.TableListView +
  +
tableRemoved(int) - +Method in interface com.threerings.parlor.client.TableObserver +
Called when a table goes away. +
tableService - +Variable in class com.threerings.micasa.lobby.table.TableLobbyObject +
Handles our table services. +
TableService - Interface in com.threerings.parlor.client
Provides table lobbying services.
tableSet - +Variable in class com.threerings.micasa.lobby.table.TableLobbyObject +
A set containing all of the tables being managed by this lobby. +
tableUpdated(Table) - +Method in class com.threerings.micasa.lobby.table.TableItem +
Called when our table has been updated and we need to update the UI + to reflect the new information. +
tableUpdated(Table) - +Method in class com.threerings.micasa.lobby.table.TableListView +
  +
tableUpdated(Table) - +Method in interface com.threerings.parlor.client.TableObserver +
Called when something has changed about a table (occupant list + updated, state changed from matchmaking to in-play, etc.). +
targetPortalId - +Variable in class com.threerings.whirled.spot.data.Portal +
The portal identifier of the portal at which a body will enter + the target scene when they "use" this portal, or -1 to specify + that the body enters on the default portal, whatever id it is. +
targetPortalName - +Variable in class com.threerings.whirled.spot.tools.EditablePortal +
The human-readable name of the portal to which this portal links + in its target scene. +
targetSceneId - +Variable in class com.threerings.whirled.spot.data.Portal +
The scene identifier of the scene to which a body will exit when + they "use" this portal. +
targetSceneName - +Variable in class com.threerings.whirled.spot.tools.EditablePortal +
The human-readable name of the scene to which this portal + links. +
tconfig - +Variable in class com.threerings.parlor.data.Table +
The table configuration object. +
TeamGameManager - Interface in com.threerings.parlor.game.server
An interface to be implemented by a game if it wants to hear about + the team indices that were configured during matchmaking.
teamMemberIndices - +Variable in class com.threerings.parlor.data.TableConfig +
If non-null, indicates that this is a team-based game and contains the team assignments for + each player. +
TestTileLoader - Class in com.threerings.stage.tools.editor
The TestTileLoader handles test tiles.
TestTileLoader() - +Constructor for class com.threerings.stage.tools.editor.TestTileLoader +
Construct the TestTileLoader. +
tick(long) - +Method in class com.threerings.parlor.card.client.CardSprite +
  +
tick(long) - +Method in class com.threerings.puzzle.drop.client.DropControllerDelegate +
  +
tick(long) - +Method in class com.threerings.puzzle.drop.client.DropSprite +
  +
tick(long) - +Method in class com.threerings.puzzle.drop.client.PieceGroupAnimation +
  +
tickAI(int, GameAI) - +Method in class com.threerings.parlor.game.server.GameManagerDelegate +
Called by the manager when we should do some AI. +
TILE_CHANGED - +Static variable in interface com.threerings.stage.tools.editor.EditorModelListener +
  +
TileInfoPanel - Class in com.threerings.stage.tools.editor
The tile info panel presents the user with options to select the tile to be applied to the + scene.
TileInfoPanel(EditorContext, EditorModel) - +Constructor for class com.threerings.stage.tools.editor.TileInfoPanel +
Constructs the tile info panel. +
tilemgr - +Static variable in class com.threerings.stage.server.StageServer +
Provides access to our tile repository. +
TILESET_RSRC_SET - +Static variable in interface com.threerings.stage.data.StageCodes +
The resource set that contains our tileset bundles. +
tileSetMapped(String) - +Method in class com.threerings.stage.tools.editor.TestTileLoader +
  +
TileSetUtil - Class in com.threerings.stage.tools.editor.util
Miscellaneous useful routines for working with lists of TileSet + and BaseTileSet objects.
TileSetUtil() - +Constructor for class com.threerings.stage.tools.editor.util.TileSetUtil +
  +
tip - +Variable in class com.threerings.parlor.data.Parameter +
A human readable tooltip to display when the mouse is hovered over this configuration + parameter. +
TIP_ACTIONS - +Static variable in class com.threerings.stage.tools.editor.EditorModel +
Prose descriptions of actions suitable for tool tip display. +
toBytes() - +Method in class com.threerings.parlor.rating.util.Percentiler +
Converts this percentiler to a byte array so that it may be stored into a database. +
TOGGLE_CHATTING - +Static variable in class com.threerings.puzzle.client.PuzzleController +
The action command to toggle chatting mode. +
ToggleParameter - Class in com.threerings.parlor.data
Models a parameter that allows the toggling of a single value.
ToggleParameter() - +Constructor for class com.threerings.parlor.data.ToggleParameter +
  +
TOO_LATE - +Static variable in interface com.threerings.parlor.tourney.data.TourneyCodes +
Too late to join a tourney. +
TOO_LATE_LEAVE - +Static variable in interface com.threerings.parlor.tourney.data.TourneyCodes +
It's too late to leave the tourney. +
TOP - +Static variable in interface com.threerings.parlor.card.trick.data.TrickCardCodes +
For four-player games, the top (opposite) player. +
toString() - +Method in class com.threerings.micasa.simulator.data.SimulatorInfo +
  +
toString() - +Method in class com.threerings.parlor.card.data.Card +
  +
toString() - +Method in class com.threerings.parlor.client.Invitation +
  +
toString() - +Method in class com.threerings.parlor.data.Parameter +
  +
toString() - +Method in class com.threerings.parlor.data.Table +
  +
toString() - +Method in class com.threerings.parlor.rating.server.persist.RatingRecord +
  +
toString() - +Method in class com.threerings.parlor.rating.server.Rating +
  +
toString() - +Method in class com.threerings.parlor.rating.util.Percentiler +
  +
toString() - +Method in class com.threerings.parlor.tourney.data.Participant +
  +
toString() - +Method in class com.threerings.puzzle.client.PlayerStatusView +
  +
toString(StringBuilder) - +Method in class com.threerings.puzzle.drop.client.DropBlockSprite +
  +
toString(StringBuilder) - +Method in class com.threerings.puzzle.drop.client.DropSprite +
  +
toString() - +Method in class com.threerings.puzzle.drop.data.DropBoard +
  +
toString() - +Method in class com.threerings.puzzle.drop.data.SegmentInfo +
  +
toString() - +Method in class com.threerings.puzzle.drop.util.PieceDropper.PieceDropInfo +
  +
toString() - +Method in class com.threerings.puzzle.util.PointSet +
  +
toString() - +Method in class com.threerings.stage.tools.editor.EditorModel +
  +
toString() - +Method in class com.threerings.stats.data.Stat +
  +
toString() - +Method in class com.threerings.stats.server.persist.StatRecord +
  +
toString() - +Method in class com.threerings.whirled.data.SceneImpl +
  +
toString() - +Method in class com.threerings.whirled.data.SceneUpdate +
  +
toString() - +Method in class com.threerings.whirled.spot.data.Cluster +
  +
toString() - +Method in class com.threerings.whirled.zone.data.SceneSummary +
  +
toString() - +Method in class com.threerings.whirled.zone.data.ZoneSummary +
  +
toString(int) - +Static method in class com.threerings.whirled.zone.util.ZoneUtil +
Returns an easier to read representation of the supplied qualified + zone id: type:id. +
TOURNEY_DB_IDENT - +Static variable in class com.threerings.parlor.tourney.server.persist.TourneyRepository +
The database identifier used when establishing a database connection. +
TOURNEY_SERVICE - +Static variable in class com.threerings.parlor.tourney.data.TourneyObject +
The field name of the tourneyService field. +
TourneyCodes - Interface in com.threerings.parlor.tourney.data
Constants and codes relating to the tourney services.
TourneyConfig - Class in com.threerings.parlor.tourney.data
Stores tournament configuration data.
TourneyConfig() - +Constructor for class com.threerings.parlor.tourney.data.TourneyConfig +
  +
tourneyId - +Variable in class com.threerings.parlor.tourney.data.TourneyConfig +
Our unique tourney id. +
tourneyId - +Variable in class com.threerings.parlor.tourney.server.persist.TourneyRepository.TourneyRecord +
The tourney's unique identifier. +
TourneyLogicData - Class in com.threerings.parlor.tourney.data
Contains TourneyLogic runtime data that should be persisted.
TourneyLogicData() - +Constructor for class com.threerings.parlor.tourney.data.TourneyLogicData +
  +
TourneyManager - Class in com.threerings.parlor.tourney.server
Controls a running tourney.
TourneyManager() - +Constructor for class com.threerings.parlor.tourney.server.TourneyManager +
  +
TourneyMarshaller - Class in com.threerings.parlor.tourney.data
Provides the implementation of the TourneyService interface + that marshalls the arguments and delivers the request to the provider + on the server.
TourneyMarshaller() - +Constructor for class com.threerings.parlor.tourney.data.TourneyMarshaller +
  +
TourneyObject - Class in com.threerings.parlor.tourney.data
Provides information on a specific tourney.
TourneyObject() - +Constructor for class com.threerings.parlor.tourney.data.TourneyObject +
  +
TourneyProvider - Interface in com.threerings.parlor.tourney.server
Defines the server-side of the TourneyService.
TourneyRepository - Class in com.threerings.parlor.tourney.server.persist
The persistent store for tourney related information.
TourneyRepository(ConnectionProvider) - +Constructor for class com.threerings.parlor.tourney.server.persist.TourneyRepository +
  +
TourneyRepository.TourneyRecord - Class in com.threerings.parlor.tourney.server.persist
Contains tourney information loaded from the database.
TourneyRepository.TourneyRecord() - +Constructor for class com.threerings.parlor.tourney.server.persist.TourneyRepository.TourneyRecord +
  +
TourneyRepository.TourneyRecord(int) - +Constructor for class com.threerings.parlor.tourney.server.persist.TourneyRepository.TourneyRecord +
  +
TourneyRepository.TourneyRecord(TourneyConfig) - +Constructor for class com.threerings.parlor.tourney.server.persist.TourneyRepository.TourneyRecord +
  +
TourneyService - Interface in com.threerings.parlor.tourney.client
Provides tourney management services for the particular tourney this + service is attached to.
tourneyService - +Variable in class com.threerings.parlor.tourney.data.TourneyObject +
Provides the way in which tourney participants can communicate with the server. +
TourniesManager - Class in com.threerings.parlor.tourney.server
An extensible tournament manager.
TourniesManager(Lifecycle) - +Constructor for class com.threerings.parlor.tourney.server.TourniesManager +
  +
TourniesMarshaller - Class in com.threerings.parlor.tourney.data
Provides the implementation of the TourniesService interface + that marshalls the arguments and delivers the request to the provider + on the server.
TourniesMarshaller() - +Constructor for class com.threerings.parlor.tourney.data.TourniesMarshaller +
  +
TourniesProvider - Interface in com.threerings.parlor.tourney.server
Defines the server-side of the TourniesService.
TourniesService - Interface in com.threerings.parlor.tourney.client
Provices services for creating/modifying tournies.
trackAvoidAnimation(Animation) - +Method in class com.threerings.puzzle.client.PuzzleBoardView +
Positions the supplied animation so as to avoid any active animations previously registered + with this method, and adds the animation to the list of animations to be avoided by any + future avoid animations. +
transferCardsBetweenPlayers(int, int, Card[]) - +Method in class com.threerings.parlor.card.server.CardGameManager +
Sends a set of cards from one player to another. +
transferCardsBetweenPlayers(int[], Card[][]) - +Method in class com.threerings.parlor.card.server.CardGameManager +
Sends sets of cards between players simultaneously. +
TRAVERSE_PORTAL - +Static variable in class com.threerings.whirled.spot.data.SpotMarshaller +
The method id used to dispatch SpotMarshaller.traversePortal(int, int, int, com.threerings.whirled.spot.client.SpotService.SpotSceneMoveListener) requests. +
traversePortal(int) - +Method in class com.threerings.whirled.spot.client.SpotSceneDirector +
Requests that this client move to the location specified by the supplied portal id. +
traversePortal(int, ResultListener<PlaceConfig>) - +Method in class com.threerings.whirled.spot.client.SpotSceneDirector +
Requests that this client move to the location specified by the supplied portal id. +
traversePortal(int, int, int, SpotService.SpotSceneMoveListener) - +Method in interface com.threerings.whirled.spot.client.SpotService +
Requests to traverse the specified portal. +
traversePortal(int, int, int, SpotService.SpotSceneMoveListener) - +Method in class com.threerings.whirled.spot.data.SpotMarshaller +
  +
traversePortal(ClientObject, int, int, int, SpotService.SpotSceneMoveListener) - +Method in interface com.threerings.whirled.spot.server.SpotProvider +
Handles a SpotService.traversePortal(int, int, int, com.threerings.whirled.spot.client.SpotService.SpotSceneMoveListener) request. +
traversePortal(ClientObject, int, int, int, SpotService.SpotSceneMoveListener) - +Method in class com.threerings.whirled.spot.server.SpotSceneRegistry +
  +
TRICK_STATE_COUNT - +Static variable in interface com.threerings.parlor.card.trick.data.TrickCardGameObject +
The number of states defined for the base trick card game object. +
TrickCardCodes - Interface in com.threerings.parlor.card.trick.data
Constants relating to trick-based card games.
TrickCardGameControllerDelegate - Class in com.threerings.parlor.card.trick.client
A card game controller delegate for trick-based card games, such as Spades and Hearts.
TrickCardGameControllerDelegate(CardGameController) - +Constructor for class com.threerings.parlor.card.trick.client.TrickCardGameControllerDelegate +
Constructor. +
TrickCardGameManagerDelegate - Class in com.threerings.parlor.card.trick.server
A card game manager delegate for trick-based card games, such as Spades and Hearts.
TrickCardGameManagerDelegate() - +Constructor for class com.threerings.parlor.card.trick.server.TrickCardGameManagerDelegate +
  +
TrickCardGameManagerDelegate(CardGameManager) - +Constructor for class com.threerings.parlor.card.trick.server.TrickCardGameManagerDelegate +
Deprecated. use the zero-argument constructor. +
TrickCardGameMarshaller - Class in com.threerings.parlor.card.trick.data
Provides the implementation of the TrickCardGameService interface + that marshalls the arguments and delivers the request to the provider + on the server.
TrickCardGameMarshaller() - +Constructor for class com.threerings.parlor.card.trick.data.TrickCardGameMarshaller +
  +
TrickCardGameObject - Interface in com.threerings.parlor.card.trick.data
Game objects for trick-based card games must implement this interface.
TrickCardGameProvider - Interface in com.threerings.parlor.card.trick.server
Defines the server-side of the TrickCardGameService.
TrickCardGameService - Interface in com.threerings.parlor.card.trick.client
Service calls related to trick card games.
TrickCardGameUtil - Class in com.threerings.parlor.card.trick.util
Methods of general utility to trick-taking card games.
TrickCardGameUtil() - +Constructor for class com.threerings.parlor.card.trick.util.TrickCardGameUtil +
  +
TURN_HOLDER_REPLACED - +Static variable in interface com.threerings.parlor.turn.data.TurnGameObject +
A special value used to communicate to the client that the current + turn holder was replaced (perhaps due to disconnection or departure + and being replaced by an AI). +
turnDidChange(Name) - +Method in class com.threerings.parlor.card.client.CardGameController +
  +
turnDidChange(Name) - +Method in interface com.threerings.parlor.turn.client.TurnGameController +
Called when the turn changed. +
turnDidEnd() - +Method in class com.threerings.parlor.card.server.CardGameManager +
  +
turnDidEnd() - +Method in interface com.threerings.parlor.turn.server.TurnGameManager +
Called when the turn was ended. +
turnDidStart() - +Method in class com.threerings.parlor.card.server.CardGameManager +
  +
turnDidStart() - +Method in interface com.threerings.parlor.turn.server.TurnGameManager +
Called when we have started the next turn. +
TurnDisplay - Class in com.threerings.parlor.turn.client
Automatically display a list of players and turn change information + in a turn-based game.
TurnDisplay() - +Constructor for class com.threerings.parlor.turn.client.TurnDisplay +
Create a TurnDisplay. +
TurnDisplay(Icon) - +Constructor for class com.threerings.parlor.turn.client.TurnDisplay +
Create a TurnDisplay for a game using the specified Icon to denote + whose turn it is. +
TurnGameController - Interface in com.threerings.parlor.turn.client
Games that wish to make use of the turn game services should have their + controller implement this interface and create an instance of TurnGameControllerDelegate which should be passed to PlaceController.addDelegate(com.threerings.crowd.client.PlaceControllerDelegate).
TurnGameControllerDelegate - Class in com.threerings.parlor.turn.client
Performs the client-side processing for a turn-based game.
TurnGameControllerDelegate(TurnGameController) - +Constructor for class com.threerings.parlor.turn.client.TurnGameControllerDelegate +
Constructs a delegate which will call back to the supplied TurnGameController implementation wen turn-based game related + things happen. +
TurnGameManager - Interface in com.threerings.parlor.turn.server
A game manager that wishes to make use of the turn game services should + implement this interface and create a TurnGameManagerDelegate + which will perform the basic turn game processing and call back to the + main manager via this interface.
TurnGameManagerDelegate - Class in com.threerings.parlor.turn.server
Performs the server-side turn-based game processing for a turn based game.
TurnGameManagerDelegate() - +Constructor for class com.threerings.parlor.turn.server.TurnGameManagerDelegate +
  +
TurnGameManagerDelegate(TurnGameManager) - +Constructor for class com.threerings.parlor.turn.server.TurnGameManagerDelegate +
Deprecated. use the zero-argument constructor. +
TurnGameObject - Interface in com.threerings.parlor.turn.data
Games that wish to support turn-based play must implement this + interface with their GameObject.
turnWillStart() - +Method in class com.threerings.parlor.card.server.CardGameManager +
  +
turnWillStart() - +Method in interface com.threerings.parlor.turn.server.TurnGameManager +
Called when we are about to start the next turn. +
type - +Variable in class com.threerings.stage.data.StageSceneModel +
This scene's type which is a string identifier used to later + construct a specific controller to handle this scene. +
TYPE_STRINGS - +Static variable in class com.threerings.parlor.game.data.GameConfig +
Maps the matchmaking type codes into strings used in our XML configuration. +
+
+

+U

+
+
undo(ActionEvent) - +Method in class com.threerings.stage.tools.editor.EditorFrame +
  +
undo() - +Method in class com.threerings.stage.tools.editor.EditorScenePanel +
  +
unpersistFrom(ObjectInputStream, Stat.AuxDataSource) - +Method in class com.threerings.stats.data.ByteByteStringMapStat +
  +
unpersistFrom(ObjectInputStream, Stat.AuxDataSource) - +Method in class com.threerings.stats.data.ByteStringSetStat +
  +
unpersistFrom(ObjectInputStream, Stat.AuxDataSource) - +Method in class com.threerings.stats.data.IntArrayStat +
  +
unpersistFrom(ObjectInputStream, Stat.AuxDataSource) - +Method in class com.threerings.stats.data.IntSetStat +
  +
unpersistFrom(ObjectInputStream, Stat.AuxDataSource) - +Method in class com.threerings.stats.data.IntStat +
  +
unpersistFrom(ObjectInputStream, Stat.AuxDataSource) - +Method in class com.threerings.stats.data.IntStringSetStat +
  +
unpersistFrom(ObjectInputStream, Stat.AuxDataSource) - +Method in class com.threerings.stats.data.MaxIntStat +
  +
unpersistFrom(ObjectInputStream, Stat.AuxDataSource) - +Method in class com.threerings.stats.data.MaxValueIntStat +
  +
unpersistFrom(ObjectInputStream, Stat.AuxDataSource) - +Method in class com.threerings.stats.data.ShortStringSetStat +
  +
unpersistFrom(ObjectInputStream, Stat.AuxDataSource) - +Method in class com.threerings.stats.data.Stat +
Unserializes this item from data obtained from the item database. +
unpersistFrom(ObjectInputStream) - +Method in class com.threerings.whirled.data.SceneUpdate +
Unserializes this instance from the bare representation created by SceneUpdate.persistTo(com.threerings.io.ObjectOutputStream). +
UPDATE_PROGRESS - +Static variable in class com.threerings.puzzle.data.PuzzleGameMarshaller +
The method id used to dispatch PuzzleGameMarshaller.updateProgress(int, int[]) requests. +
UPDATE_PROGRESS_SYNC - +Static variable in class com.threerings.puzzle.data.PuzzleGameMarshaller +
The method id used to dispatch PuzzleGameMarshaller.updateProgressSync(int, int[], com.threerings.puzzle.data.Board[]) requests. +
updateBoardSummaries() - +Method in class com.threerings.puzzle.server.PuzzleManager +
Applies updateBoardSummary on all the players' boards. +
updateBoardSummary(int) - +Method in class com.threerings.puzzle.server.PuzzleManager +
Calls BoardSummary.summarize() on the given player's board summary to refresh the + summary information in preparation for sending along to the client(s). +
updateCluster(Cluster, Rectangle) - +Method in class com.threerings.stage.client.StageScenePanel +
Adds or updates the specified cluster in the view. +
updateClusters(Cluster) - +Method in class com.threerings.whirled.spot.data.SpotSceneObject +
Requests that the specified entry be updated in the + clusters set. +
updateCoordPos(int, int, Point) - +Method in class com.threerings.stage.tools.editor.EditorScenePanel +
Updates the coordinate position and returns true if it has changed. +
updateDefaultTileSet(int) - +Method in class com.threerings.stage.tools.editor.EditorScenePanel +
Updates the default tileset in the currently edited scene. +
updateHostedZones(HostedZone) - +Method in class com.threerings.whirled.zone.peer.server.ZoneNodeObject +
Requests that the specified entry be updated in the + hostedZones set. +
UpdateList - Class in com.threerings.whirled.util
A list specialized for storing SceneUpdate objects.
UpdateList() - +Constructor for class com.threerings.whirled.util.UpdateList +
  +
updateMiniView(ActionEvent) - +Method in class com.threerings.stage.tools.editor.EditorFrame +
Update the mini view in the scrollbox. +
updateOccupantLocs(SceneLocation) - +Method in class com.threerings.whirled.spot.data.SpotSceneObject +
Requests that the specified entry be updated in the + occupantLocs set. +
updateOccupants(GameObject) - +Method in class com.threerings.parlor.data.Table +
Called by the table manager when the game object's players have changed. +
updateParticipants(Participant) - +Method in class com.threerings.parlor.tourney.data.TourneyObject +
Requests that the specified entry be updated in the + participants set. +
updatePercentile(int, int, Percentiler) - +Method in class com.threerings.parlor.rating.server.persist.RatingRepository +
Writes the supplied percentiler's data out to the database. +
updatePiece(int, int) - +Method in class com.threerings.puzzle.drop.client.DropBoardView +
Refreshes the piece sprite at the specified location, if no sprite exists at the location, + one will be created. +
updatePiece(int, int, int) - +Method in class com.threerings.puzzle.drop.client.DropBoardView +
Updates the piece sprite at the specified location, if no sprite exists at the location, + one will be created. +
updateProgress(int, int[]) - +Method in interface com.threerings.puzzle.client.PuzzleGameService +
Asks the puzzle manager to apply the supplied progress events for the specified puzzle round + to the player's state. +
updateProgress(int, int[]) - +Method in class com.threerings.puzzle.data.PuzzleGameMarshaller +
  +
updateProgress(ClientObject, int, int[]) - +Method in interface com.threerings.puzzle.server.PuzzleGameProvider +
Handles a PuzzleGameService.updateProgress(int, int[]) request. +
updateProgress(ClientObject, int, int[]) - +Method in class com.threerings.puzzle.server.PuzzleManager +
  +
updateProgressSync(int, int[], Board[]) - +Method in interface com.threerings.puzzle.client.PuzzleGameService +
Debug variant of PuzzleGameService.updateProgress(int, int[]) that is only used when + PuzzlePanel.isSyncingBoards() is true and which includes the board states associated + with each event. +
updateProgressSync(int, int[], Board[]) - +Method in class com.threerings.puzzle.data.PuzzleGameMarshaller +
  +
updateProgressSync(ClientObject, int, int[], Board[]) - +Method in interface com.threerings.puzzle.server.PuzzleGameProvider +
Handles a PuzzleGameService.updateProgressSync(int, int[], com.threerings.puzzle.data.Board[]) request. +
updateProgressSync(ClientObject, int, int[], Board[]) - +Method in class com.threerings.puzzle.server.PuzzleManager +
Called when the puzzle manager receives a progress update. +
updateReceived(SceneUpdate) - +Method in class com.threerings.stage.data.StageScene +
  +
updateReceived(SceneUpdate) - +Method in class com.threerings.whirled.client.SceneDirector +
Called by SceneController instances to tell us about an update to the current scene. +
updateReceived(SceneUpdate) - +Method in interface com.threerings.whirled.data.Scene +
Called to inform the scene that an update has been received while + the scene was resolved and active. +
updateReceived(SceneUpdate) - +Method in class com.threerings.whirled.data.SceneImpl +
  +
updateReceived() - +Method in class com.threerings.whirled.spot.data.SpotSceneImpl +
This should be called if a scene update was received that caused our underlying scene model + to change. +
updateSelfSummary() - +Method in class com.threerings.puzzle.drop.client.DropControllerDelegate +
Updates the player's own local board summary to reflect the local copy of the player's + board which is likely to be more up to date than the server-side board from which all other + player board summaries originate. +
updateStat(int, StatModifier<T>) - +Method in class com.threerings.stats.server.persist.StatRepository +
Applies a modification to a single stat. +
updateStats(Stat) - +Method in interface com.threerings.stats.data.StatSet.Container +
  +
updateTables(Table) - +Method in class com.threerings.micasa.lobby.table.TableLobbyObject +
  +
updateTables(Table) - +Method in interface com.threerings.parlor.data.TableLobbyObject +
Updates the value of the specified table instance in the tables + distributed set (using the appropriate distributed object + mechanisms). +
updateTableSet(Table) - +Method in class com.threerings.micasa.lobby.table.TableLobbyObject +
Requests that the specified entry be updated in the + tableSet set. +
updateTileInfo() - +Method in class com.threerings.stage.tools.editor.EditorFrame +
  +
updateTileSetTree() - +Method in class com.threerings.stage.tools.editor.TileInfoPanel +
The layer has changed, update the tree to reflect the tilesets now available. +
updateTourney(TourneyConfig) - +Method in class com.threerings.parlor.tourney.server.persist.TourneyRepository +
Updates the tourney in the repository. +
updateView() - +Method in class com.threerings.stage.tools.editor.EditorScrollBox +
Update the view of the editor map. +
useBlockDropping() - +Method in interface com.threerings.puzzle.drop.data.DropLogic +
Returns whether the puzzle game would like to make use of the manipulable block dropping + functionality. +
useBoardRising() - +Method in interface com.threerings.puzzle.drop.data.DropLogic +
Returns whether the puzzle game would like to make use of the rising board functionality. +
UserIdentifier - Class in com.threerings.parlor.game.data
 
UserIdentifier() - +Constructor for class com.threerings.parlor.game.data.UserIdentifier +
  +
UserIdentifier.Ider - Interface in com.threerings.parlor.game.data
Implement this and set the mutha up.
username - +Variable in class com.threerings.parlor.tourney.data.Participant +
The username of the participant. +
+
+

+V

+
+
validate(SceneModel) - +Method in class com.threerings.whirled.data.SceneUpdate +
Called to ensure that the scene is in the appropriate state prior to applying the update. +
validate(int) - +Method in class com.threerings.whirled.util.UpdateList +
Returns true if the supplied actual scene version is in accordance with the updates + contained in this list. +
VALUE - +Static variable in class com.threerings.stats.server.persist.StringCodeRecord +
  +
value - +Variable in class com.threerings.stats.server.persist.StringCodeRecord +
  +
valueChanged(TreeSelectionEvent) - +Method in class com.threerings.stage.tools.editor.TileInfoPanel +
Display the tiles in a tileset when it is selected. +
valueChanged(ListSelectionEvent) - +Method in class com.threerings.stage.tools.editor.TileInfoPanel +
Handle tile table selections. +
values() - +Method in class com.threerings.stats.data.StringSetStat +
Returns the values in this set. +
valueToString() - +Method in class com.threerings.stats.data.IntArrayStat +
  +
valueToString() - +Method in class com.threerings.stats.data.IntSetStat +
  +
valueToString() - +Method in class com.threerings.stats.data.IntStat +
  +
valueToString() - +Method in class com.threerings.stats.data.MaxIntStat +
  +
valueToString() - +Method in class com.threerings.stats.data.MaxValueIntStat +
  +
valueToString() - +Method in class com.threerings.stats.data.Stat +
Derived statistics must override this method and render their value to a string. +
valueToString() - +Method in class com.threerings.stats.data.StringMapStat +
  +
valueToString() - +Method in class com.threerings.stats.data.StringSetStat +
  +
version - +Variable in class com.threerings.whirled.data.SceneModel +
The version number of this scene. +
ViewerApp - Class in com.threerings.stage.tools.viewer
The ViewerApp is a scene viewing application that allows for trying out + Stage scenes in a pseudo-runtime environment.
ViewerApp(String[]) - +Constructor for class com.threerings.stage.tools.viewer.ViewerApp +
Construct and initialize the ViewerApp object. +
ViewerFrame - Class in com.threerings.stage.tools.viewer
The viewer frame is the main application window.
ViewerFrame(GraphicsConfiguration) - +Constructor for class com.threerings.stage.tools.viewer.ViewerFrame +
Creates a frame in which the viewer application can operate. +
ViewerScenePanel - Class in com.threerings.stage.tools.viewer
 
ViewerScenePanel(StageContext, CharacterManager) - +Constructor for class com.threerings.stage.tools.viewer.ViewerScenePanel +
Construct the panel and initialize it with a context. +
+
+

+W

+
+
watchers - +Variable in class com.threerings.parlor.data.Table +
An array of the usernames of the non-player occupants of this game. +
where() - +Method in class com.threerings.whirled.server.SceneManager +
  +
where(int) - +Method in class com.threerings.whirled.server.SceneRegistry +
Returns SceneManager.where() for the specified scene or null:sceneId if + no scene manager exists for that scene. +
WHIRLED_GROUP - +Static variable in interface com.threerings.whirled.data.SceneCodes +
Defines our invocation services group. +
WhirledContext - Interface in com.threerings.whirled.util
The whirled context provides access to the various managers, etc.
WhirledServer - Class in com.threerings.whirled.server
The Whirled server extends the CrowdServer and provides access to managers and the like + that are needed by the Whirled serviecs.
WhirledServer() - +Constructor for class com.threerings.whirled.server.WhirledServer +
  +
WhirledServer.WhirledModule - Class in com.threerings.whirled.server
Configures dependencies needed by the Whirled server.
WhirledServer.WhirledModule() - +Constructor for class com.threerings.whirled.server.WhirledServer.WhirledModule +
  +
WhirledSession - Class in com.threerings.whirled.server
The client object used by client management on the Whirled server.
WhirledSession() - +Constructor for class com.threerings.whirled.server.WhirledSession +
  +
willEnterPlace(PlaceObject) - +Method in class com.threerings.micasa.client.ChatPanel +
  +
willEnterPlace(PlaceObject) - +Method in class com.threerings.micasa.client.OccupantList +
  +
willEnterPlace(PlaceObject) - +Method in class com.threerings.micasa.lobby.LobbyController +
  +
willEnterPlace(PlaceObject) - +Method in class com.threerings.micasa.lobby.LobbyPanel +
  +
willEnterPlace(PlaceObject) - +Method in class com.threerings.micasa.lobby.table.TableListView +
  +
willEnterPlace(PlaceObject) - +Method in class com.threerings.micasa.simulator.server.Simulant +
Called when the simulant is about to enter the room in which it + will be doing all of its business. +
willEnterPlace(PlaceObject) - +Method in class com.threerings.parlor.card.client.CardGameController +
  +
willEnterPlace(PlaceObject) - +Method in class com.threerings.parlor.game.client.GameController +
Adds this controller as a listener to the game object (thus derived classes need not do so) + and lets the game manager know that we are now ready to go. +
willEnterPlace(PlaceObject) - +Method in class com.threerings.parlor.turn.client.TurnDisplay +
  +
willEnterPlace(PlaceObject) - +Method in class com.threerings.parlor.turn.client.TurnGameControllerDelegate +
  +
willEnterPlace(PlaceObject) - +Method in class com.threerings.puzzle.client.PuzzleController +
  +
willEnterPlace(PlaceObject) - +Method in class com.threerings.puzzle.client.PuzzleControllerDelegate +
  +
willEnterPlace(PlaceObject) - +Method in class com.threerings.puzzle.client.PuzzlePanel +
  +
willEnterPlace(PlaceObject) - +Method in class com.threerings.stage.client.StageScenePanel +
  +
willEnterPlace(PlaceObject) - +Method in class com.threerings.whirled.client.SceneController +
  +
willTraversePortal(BodyObject, Portal) - +Method in class com.threerings.whirled.spot.server.SpotSceneManager +
This is called to let this scene manager know that the user is about to traverse the + specified portal. +
WINNERS - +Static variable in class com.threerings.parlor.game.data.GameObject +
The field name of the winners field. +
winners - +Variable in class com.threerings.parlor.game.data.GameObject +
Whether each player in the game is a winner, or null if the game is not yet over. +
WINNERS_AND_LOSERS - +Static variable in interface com.threerings.parlor.game.data.GameCodes +
The name of the message event to a placeObject that reports + the winners and losers of a game. +
WORLD - +Static variable in class com.threerings.stage.data.StageSceneModel +
A scene type code. +
write(Object, DataWriter) - +Method in class com.threerings.whirled.spot.tools.xml.SpotSceneWriter +
  +
writeModified(int, Stat[]) - +Method in class com.threerings.stats.server.persist.StatRepository +
Writes out any of the stats in the supplied array that have been modified since they were + first loaded. +
writeModified(int, Iterable<Stat>) - +Method in class com.threerings.stats.server.persist.StatRepository +
Writes out any of the stats in the supplied iterable that have been modified since they were + first loaded. +
writeObject(ObjectOutputStream) - +Method in class com.threerings.stats.data.StatModifier +
Writes our custom streamable fields. +
writeObject(ObjectOutputStream) - +Method in class com.threerings.whirled.data.SceneUpdate +
Writes our custom streamable fields. +
writeScene(File, SceneModel) - +Method in class com.threerings.whirled.tools.xml.SceneWriter +
Writes the supplied scene out to the specified file. +
writeSceneModel(SceneModel, DataWriter) - +Method in class com.threerings.whirled.tools.xml.SceneWriter +
Writes the data for the supplied SceneModel to the XML data + writer supplied. +
+
+

+X

+
+
x - +Variable in class com.threerings.puzzle.drop.data.SegmentInfo +
The segment's lower-left board coordinates. +
x - +Variable in class com.threerings.stage.data.StageLocation +
The user's x position (interpreted by the display system). +
xlate(String) - +Method in interface com.threerings.stage.util.StageContext +
Translates the specified message using the default bundle. +
xlate(String, String) - +Method in interface com.threerings.stage.util.StageContext +
Translates the specified message using the specified bundle. +
+
+

+Y

+
+
y - +Variable in class com.threerings.puzzle.drop.data.SegmentInfo +
The segment's lower-left board coordinates. +
y - +Variable in class com.threerings.stage.data.StageLocation +
The user's y position (interpreted by the display system). +
+
+

+Z

+
+
zipToNextRow() - +Method in class com.threerings.puzzle.drop.client.DropControllerDelegate +
Causes the board to zip quickly to the next row. +
ZoneAdapter - Class in com.threerings.whirled.zone.client
The zone adapter makes life easier for a class that really only cares + about one or two of the zone observer callbacks and doesn't want to + provide empty implementations of the others.
ZoneAdapter() - +Constructor for class com.threerings.whirled.zone.client.ZoneAdapter +
  +
zoneChangeFailed(String) - +Method in class com.threerings.whirled.zone.client.ZoneAdapter +
  +
zoneChangeFailed(String) - +Method in interface com.threerings.whirled.zone.client.ZoneObserver +
This is called on all zone observers when a zone change request is + rejected by the server or fails for some other reason. +
ZoneCodes - Interface in com.threerings.whirled.zone.data
Contains codes used by the zone services.
ZonedBodyObject - Interface in com.threerings.whirled.zone.data
A system that uses the zone services must extend BodyObject and implement this + interface.
ZoneDecoder - Class in com.threerings.whirled.zone.client
Dispatches calls to a ZoneReceiver instance.
ZoneDecoder(ZoneReceiver) - +Constructor for class com.threerings.whirled.zone.client.ZoneDecoder +
Creates a decoder that may be registered to dispatch invocation + service notifications to the specified receiver. +
zoneDidChange(ZoneSummary) - +Method in class com.threerings.whirled.zone.client.ZoneAdapter +
  +
zoneDidChange(ZoneSummary) - +Method in interface com.threerings.whirled.zone.client.ZoneObserver +
Called when we have switched to a new zone. +
zoneDidShutdown(int) - +Method in interface com.threerings.whirled.zone.peer.server.PeeredZoneRegistry.PeerZoneShutdownListener +
  +
zoneDidShutdown(int) - +Method in class com.threerings.whirled.zone.peer.server.PeeredZoneRegistry +
Pass on that the zone has shutdown. +
zoneDidShutdown(int) - +Method in class com.threerings.whirled.zone.peer.server.ZonePeerManager +
Called by the ZoneManager when it is no longer hosting a scene. +
zoneDidStartup(int, Name) - +Method in class com.threerings.whirled.zone.peer.server.ZonePeerManager +
Called by the ZoneManager when it is hosting a zone. +
ZoneDirector - Class in com.threerings.whirled.zone.client
The zone director augments the scene services with the notion of zones.
ZoneDirector(WhirledContext, SceneDirector) - +Constructor for class com.threerings.whirled.zone.client.ZoneDirector +
Constructs a zone director with the supplied context, and delegate scene director (which the + zone director will coordinate with when moving from scene to scene). +
zoneFailedToResolve(int, Exception) - +Method in interface com.threerings.whirled.zone.server.ZoneManager.ResolutionListener +
Called when a zone failed to resolve. +
zoneFailedToResolve(int, Exception) - +Method in class com.threerings.whirled.zone.server.ZoneMoveHandler +
  +
zoneId - +Variable in class com.threerings.stage.data.StageSceneModel +
The zone id to which this scene belongs. +
zoneId - +Variable in class com.threerings.whirled.zone.data.ZoneSummary +
The zone's fully qualified unique identifier. +
zoneId - +Variable in class com.threerings.whirled.zone.peer.data.HostedZone +
The unique ID for the zone in question. +
zoneId(int) - +Static method in class com.threerings.whirled.zone.util.ZoneUtil +
Extracts the zone id from a qualified zone id. +
ZoneManager - Interface in com.threerings.whirled.zone.server
A zone is a collection of scenes organized into a connected group.
ZoneManager.ResolutionListener - Interface in com.threerings.whirled.zone.server
Used to notify requesters when an asynchronous zone load has + completed (successfully or not).
ZoneMarshaller - Class in com.threerings.whirled.zone.data
Provides the implementation of the ZoneService interface + that marshalls the arguments and delivers the request to the provider + on the server.
ZoneMarshaller() - +Constructor for class com.threerings.whirled.zone.data.ZoneMarshaller +
  +
ZoneMarshaller.ZoneMoveMarshaller - Class in com.threerings.whirled.zone.data
Marshalls results to implementations of ZoneService.ZoneMoveListener.
ZoneMarshaller.ZoneMoveMarshaller() - +Constructor for class com.threerings.whirled.zone.data.ZoneMarshaller.ZoneMoveMarshaller +
  +
ZoneMoveHandler - Class in com.threerings.whirled.zone.server
Handles transitioning between zones.
ZoneMoveHandler(LocationManager, ZoneManager, SceneRegistry, BodyObject, int, int, ZoneService.ZoneMoveListener) - +Constructor for class com.threerings.whirled.zone.server.ZoneMoveHandler +
  +
ZoneNodeObject - Class in com.threerings.whirled.zone.peer.server
 
ZoneNodeObject() - +Constructor for class com.threerings.whirled.zone.peer.server.ZoneNodeObject +
  +
ZoneObserver - Interface in com.threerings.whirled.zone.client
The zone observer interface makes it possible for entities to be + notified when the client moves to a new zone.
zoneOnNode(Tuple<String, HostedZone>) - +Method in interface com.threerings.whirled.zone.peer.server.PeeredZoneRegistry.PeerZoneResolutionListener +
Called when the zone is already hosted on another node. +
ZonePeerManager - Class in com.threerings.whirled.zone.peer.server
 
ZonePeerManager(Lifecycle) - +Constructor for class com.threerings.whirled.zone.peer.server.ZonePeerManager +
Creates an uninitialized peer manager. +
ZonePeerManager.NodeFunc<T> - Class in com.threerings.whirled.zone.peer.server
Useful with PeerManager.lookupNodeDatum(com.google.common.base.Function).
ZonePeerManager.NodeFunc() - +Constructor for class com.threerings.whirled.zone.peer.server.ZonePeerManager.NodeFunc +
  +
ZoneProvider - Interface in com.threerings.whirled.zone.server
Defines the server-side of the ZoneService.
ZoneReceiver - Interface in com.threerings.whirled.zone.client
Defines, for the zone services, a set of notifications delivered asynchronously by the server + to the client.
ZoneRegistry - Class in com.threerings.whirled.zone.server
The zone registry takes care of mapping zone requests to the appropriate registered zone manager.
ZoneRegistry(InvocationManager) - +Constructor for class com.threerings.whirled.zone.server.ZoneRegistry +
Creates a zone manager with the supplied configuration. +
ZoneSender - Class in com.threerings.whirled.zone.server
Used to issue notifications to a ZoneReceiver instance on a + client.
ZoneSender() - +Constructor for class com.threerings.whirled.zone.server.ZoneSender +
  +
ZoneService - Interface in com.threerings.whirled.zone.client
The client interface for zone related invocation services (e.g.
ZoneService.ZoneMoveListener - Interface in com.threerings.whirled.zone.client
Used to deliver responses to ZoneService.moveTo(int, int, int, com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener) requests.
ZoneSummary - Class in com.threerings.whirled.zone.data
The zone summary contains information on a zone, including its name and + summary info on all of the scenes in this zone (which can be used to + generate a map of the zone on the client).
ZoneSummary() - +Constructor for class com.threerings.whirled.zone.data.ZoneSummary +
  +
zoneType(int) - +Static method in class com.threerings.whirled.zone.util.ZoneUtil +
Extracts the zone type from a qualified zone id. +
ZoneUtil - Class in com.threerings.whirled.zone.util
Server-specific, zone-related utility functions.
ZoneUtil() - +Constructor for class com.threerings.whirled.zone.util.ZoneUtil +
  +
zoneWasResolved(ZoneSummary) - +Method in interface com.threerings.whirled.zone.server.ZoneManager.ResolutionListener +
Called when a zone was successfully resolved. +
zoneWasResolved(ZoneSummary) - +Method in class com.threerings.whirled.zone.server.ZoneMoveHandler +
  +
zoneWillChange(int) - +Method in class com.threerings.whirled.zone.client.ZoneAdapter +
  +
zoneWillChange(int) - +Method in interface com.threerings.whirled.zone.client.ZoneObserver +
Called when we begin the process of switching to a new zone. +
+
+

+_

+
+
_R - +Static variable in class com.threerings.parlor.rating.server.persist.PercentileRecord +
  +
_R - +Static variable in class com.threerings.parlor.rating.server.persist.RatingRecord +
  +
_R - +Static variable in class com.threerings.stats.server.persist.MaxStatCodeRecord +
  +
_R - +Static variable in class com.threerings.stats.server.persist.StatRecord +
  +
_R - +Static variable in class com.threerings.stats.server.persist.StringCodeRecord +
  +
+
+A B C D E F G H I J K L M N O P Q R S T U V W X Y Z _ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/index.html b/apidocs/index.html new file mode 100644 index 00000000..3e4d9a37 --- /dev/null +++ b/apidocs/index.html @@ -0,0 +1,40 @@ + + + + + + + +vilya 1.3 API + + + + + + + + + + + +<H2> +Frame Alert</H2> + +<P> +This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. +<BR> +Link to<A HREF="overview-summary.html">Non-frame version.</A> + + + diff --git a/apidocs/overview-frame.html b/apidocs/overview-frame.html new file mode 100644 index 00000000..bd937584 --- /dev/null +++ b/apidocs/overview-frame.html @@ -0,0 +1,203 @@ + + + + + + + +Overview List (vilya 1.3 API) + + + + + + + + + + + + + + + +
+
+ + + + + +
All Classes +

+ +Packages +
+com.threerings.micasa +
+com.threerings.micasa.client +
+com.threerings.micasa.data +
+com.threerings.micasa.lobby +
+com.threerings.micasa.lobby.table +
+com.threerings.micasa.server +
+com.threerings.micasa.simulator.client +
+com.threerings.micasa.simulator.data +
+com.threerings.micasa.simulator.server +
+com.threerings.micasa.simulator.util +
+com.threerings.micasa.util +
+com.threerings.parlor +
+com.threerings.parlor.card +
+com.threerings.parlor.card.client +
+com.threerings.parlor.card.data +
+com.threerings.parlor.card.server +
+com.threerings.parlor.card.trick.client +
+com.threerings.parlor.card.trick.data +
+com.threerings.parlor.card.trick.server +
+com.threerings.parlor.card.trick.util +
+com.threerings.parlor.client +
+com.threerings.parlor.data +
+com.threerings.parlor.game.client +
+com.threerings.parlor.game.data +
+com.threerings.parlor.game.server +
+com.threerings.parlor.media +
+com.threerings.parlor.rating.data +
+com.threerings.parlor.rating.server +
+com.threerings.parlor.rating.server.persist +
+com.threerings.parlor.rating.util +
+com.threerings.parlor.server +
+com.threerings.parlor.tourney.client +
+com.threerings.parlor.tourney.data +
+com.threerings.parlor.tourney.server +
+com.threerings.parlor.tourney.server.persist +
+com.threerings.parlor.turn.client +
+com.threerings.parlor.turn.data +
+com.threerings.parlor.turn.server +
+com.threerings.parlor.util +
+com.threerings.puzzle +
+com.threerings.puzzle.client +
+com.threerings.puzzle.data +
+com.threerings.puzzle.drop.client +
+com.threerings.puzzle.drop.data +
+com.threerings.puzzle.drop.server +
+com.threerings.puzzle.drop.util +
+com.threerings.puzzle.server +
+com.threerings.puzzle.util +
+com.threerings.stage +
+com.threerings.stage.client +
+com.threerings.stage.data +
+com.threerings.stage.server +
+com.threerings.stage.tools.editor +
+com.threerings.stage.tools.editor.util +
+com.threerings.stage.tools.viewer +
+com.threerings.stage.tools.xml +
+com.threerings.stage.util +
+com.threerings.stats +
+com.threerings.stats.data +
+com.threerings.stats.server.persist +
+com.threerings.whirled +
+com.threerings.whirled.client +
+com.threerings.whirled.client.persist +
+com.threerings.whirled.data +
+com.threerings.whirled.server +
+com.threerings.whirled.server.persist +
+com.threerings.whirled.spot +
+com.threerings.whirled.spot.client +
+com.threerings.whirled.spot.data +
+com.threerings.whirled.spot.server +
+com.threerings.whirled.spot.tools +
+com.threerings.whirled.spot.tools.xml +
+com.threerings.whirled.tools.xml +
+com.threerings.whirled.util +
+com.threerings.whirled.zone +
+com.threerings.whirled.zone.client +
+com.threerings.whirled.zone.data +
+com.threerings.whirled.zone.peer.data +
+com.threerings.whirled.zone.peer.server +
+com.threerings.whirled.zone.server +
+com.threerings.whirled.zone.util +
+

+ +

+  + + diff --git a/apidocs/overview-summary.html b/apidocs/overview-summary.html new file mode 100644 index 00000000..ffb11ad1 --- /dev/null +++ b/apidocs/overview-summary.html @@ -0,0 +1,478 @@ + + + + + + + +Overview (vilya 1.3 API) + + + + + + + + + + + + +

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
 Overview  Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+vilya 1.3 API +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Packages
com.threerings.micasa 
com.threerings.micasa.client 
com.threerings.micasa.data 
com.threerings.micasa.lobby 
com.threerings.micasa.lobby.table 
com.threerings.micasa.server 
com.threerings.micasa.simulator.client 
com.threerings.micasa.simulator.data 
com.threerings.micasa.simulator.server 
com.threerings.micasa.simulator.util 
com.threerings.micasa.util 
com.threerings.parlor 
com.threerings.parlor.card 
com.threerings.parlor.card.client 
com.threerings.parlor.card.data 
com.threerings.parlor.card.server 
com.threerings.parlor.card.trick.client 
com.threerings.parlor.card.trick.data 
com.threerings.parlor.card.trick.server 
com.threerings.parlor.card.trick.util 
com.threerings.parlor.client 
com.threerings.parlor.data 
com.threerings.parlor.game.client 
com.threerings.parlor.game.data 
com.threerings.parlor.game.server 
com.threerings.parlor.media 
com.threerings.parlor.rating.data 
com.threerings.parlor.rating.server 
com.threerings.parlor.rating.server.persist 
com.threerings.parlor.rating.util 
com.threerings.parlor.server 
com.threerings.parlor.tourney.client 
com.threerings.parlor.tourney.data 
com.threerings.parlor.tourney.server 
com.threerings.parlor.tourney.server.persist 
com.threerings.parlor.turn.client 
com.threerings.parlor.turn.data 
com.threerings.parlor.turn.server 
com.threerings.parlor.util 
com.threerings.puzzle 
com.threerings.puzzle.client 
com.threerings.puzzle.data 
com.threerings.puzzle.drop.client 
com.threerings.puzzle.drop.data 
com.threerings.puzzle.drop.server 
com.threerings.puzzle.drop.util 
com.threerings.puzzle.server 
com.threerings.puzzle.util 
com.threerings.stage 
com.threerings.stage.client 
com.threerings.stage.data 
com.threerings.stage.server 
com.threerings.stage.tools.editor 
com.threerings.stage.tools.editor.util 
com.threerings.stage.tools.viewer 
com.threerings.stage.tools.xml 
com.threerings.stage.util 
com.threerings.stats 
com.threerings.stats.data 
com.threerings.stats.server.persist 
com.threerings.whirled 
com.threerings.whirled.client 
com.threerings.whirled.client.persist 
com.threerings.whirled.data 
com.threerings.whirled.server 
com.threerings.whirled.server.persist 
com.threerings.whirled.spotExtends the Whirled services with the notion of locations, clusters, + coordinates and orientation.
com.threerings.whirled.spot.client 
com.threerings.whirled.spot.data 
com.threerings.whirled.spot.server 
com.threerings.whirled.spot.tools 
com.threerings.whirled.spot.tools.xml 
com.threerings.whirled.tools.xml 
com.threerings.whirled.util 
com.threerings.whirled.zone 
com.threerings.whirled.zone.client 
com.threerings.whirled.zone.data 
com.threerings.whirled.zone.peer.data 
com.threerings.whirled.zone.peer.server 
com.threerings.whirled.zone.server 
com.threerings.whirled.zone.util 
+ +

+ 

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
 Overview  Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/overview-tree.html b/apidocs/overview-tree.html new file mode 100644 index 00000000..4ba83d9d --- /dev/null +++ b/apidocs/overview-tree.html @@ -0,0 +1,652 @@ + + + + + + + +Class Hierarchy (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For All Packages

+
+
+
Package Hierarchies:
com.threerings.micasa, com.threerings.micasa.client, com.threerings.micasa.data, com.threerings.micasa.lobby, com.threerings.micasa.lobby.table, com.threerings.micasa.server, com.threerings.micasa.simulator.client, com.threerings.micasa.simulator.data, com.threerings.micasa.simulator.server, com.threerings.micasa.simulator.util, com.threerings.micasa.util, com.threerings.parlor, com.threerings.parlor.card, com.threerings.parlor.card.client, com.threerings.parlor.card.data, com.threerings.parlor.card.server, com.threerings.parlor.card.trick.client, com.threerings.parlor.card.trick.data, com.threerings.parlor.card.trick.server, com.threerings.parlor.card.trick.util, com.threerings.parlor.client, com.threerings.parlor.data, com.threerings.parlor.game.client, com.threerings.parlor.game.data, com.threerings.parlor.game.server, com.threerings.parlor.media, com.threerings.parlor.rating.data, com.threerings.parlor.rating.server, com.threerings.parlor.rating.server.persist, com.threerings.parlor.rating.util, com.threerings.parlor.server, com.threerings.parlor.tourney.client, com.threerings.parlor.tourney.data, com.threerings.parlor.tourney.server, com.threerings.parlor.tourney.server.persist, com.threerings.parlor.turn.client, com.threerings.parlor.turn.data, com.threerings.parlor.turn.server, com.threerings.parlor.util, com.threerings.puzzle, com.threerings.puzzle.client, com.threerings.puzzle.data, com.threerings.puzzle.drop.client, com.threerings.puzzle.drop.data, com.threerings.puzzle.drop.server, com.threerings.puzzle.drop.util, com.threerings.puzzle.server, com.threerings.puzzle.util, com.threerings.stage, com.threerings.stage.client, com.threerings.stage.data, com.threerings.stage.server, com.threerings.stage.tools.editor, com.threerings.stage.tools.editor.util, com.threerings.stage.tools.viewer, com.threerings.stage.tools.xml, com.threerings.stage.util, com.threerings.stats, com.threerings.stats.data, com.threerings.stats.server.persist, com.threerings.whirled, com.threerings.whirled.client, com.threerings.whirled.client.persist, com.threerings.whirled.data, com.threerings.whirled.server, com.threerings.whirled.server.persist, com.threerings.whirled.spot, com.threerings.whirled.spot.client, com.threerings.whirled.spot.data, com.threerings.whirled.spot.server, com.threerings.whirled.spot.tools, com.threerings.whirled.spot.tools.xml, com.threerings.whirled.tools.xml, com.threerings.whirled.util, com.threerings.whirled.zone, com.threerings.whirled.zone.client, com.threerings.whirled.zone.data, com.threerings.whirled.zone.peer.data, com.threerings.whirled.zone.peer.server, com.threerings.whirled.zone.server, com.threerings.whirled.zone.util
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/package-list b/apidocs/package-list new file mode 100644 index 00000000..7c5d6691 --- /dev/null +++ b/apidocs/package-list @@ -0,0 +1,81 @@ +com.threerings.micasa +com.threerings.micasa.client +com.threerings.micasa.data +com.threerings.micasa.lobby +com.threerings.micasa.lobby.table +com.threerings.micasa.server +com.threerings.micasa.simulator.client +com.threerings.micasa.simulator.data +com.threerings.micasa.simulator.server +com.threerings.micasa.simulator.util +com.threerings.micasa.util +com.threerings.parlor +com.threerings.parlor.card +com.threerings.parlor.card.client +com.threerings.parlor.card.data +com.threerings.parlor.card.server +com.threerings.parlor.card.trick.client +com.threerings.parlor.card.trick.data +com.threerings.parlor.card.trick.server +com.threerings.parlor.card.trick.util +com.threerings.parlor.client +com.threerings.parlor.data +com.threerings.parlor.game.client +com.threerings.parlor.game.data +com.threerings.parlor.game.server +com.threerings.parlor.media +com.threerings.parlor.rating.data +com.threerings.parlor.rating.server +com.threerings.parlor.rating.server.persist +com.threerings.parlor.rating.util +com.threerings.parlor.server +com.threerings.parlor.tourney.client +com.threerings.parlor.tourney.data +com.threerings.parlor.tourney.server +com.threerings.parlor.tourney.server.persist +com.threerings.parlor.turn.client +com.threerings.parlor.turn.data +com.threerings.parlor.turn.server +com.threerings.parlor.util +com.threerings.puzzle +com.threerings.puzzle.client +com.threerings.puzzle.data +com.threerings.puzzle.drop.client +com.threerings.puzzle.drop.data +com.threerings.puzzle.drop.server +com.threerings.puzzle.drop.util +com.threerings.puzzle.server +com.threerings.puzzle.util +com.threerings.stage +com.threerings.stage.client +com.threerings.stage.data +com.threerings.stage.server +com.threerings.stage.tools.editor +com.threerings.stage.tools.editor.util +com.threerings.stage.tools.viewer +com.threerings.stage.tools.xml +com.threerings.stage.util +com.threerings.stats +com.threerings.stats.data +com.threerings.stats.server.persist +com.threerings.whirled +com.threerings.whirled.client +com.threerings.whirled.client.persist +com.threerings.whirled.data +com.threerings.whirled.server +com.threerings.whirled.server.persist +com.threerings.whirled.spot +com.threerings.whirled.spot.client +com.threerings.whirled.spot.data +com.threerings.whirled.spot.server +com.threerings.whirled.spot.tools +com.threerings.whirled.spot.tools.xml +com.threerings.whirled.tools.xml +com.threerings.whirled.util +com.threerings.whirled.zone +com.threerings.whirled.zone.client +com.threerings.whirled.zone.data +com.threerings.whirled.zone.peer.data +com.threerings.whirled.zone.peer.server +com.threerings.whirled.zone.server +com.threerings.whirled.zone.util diff --git a/apidocs/resources/inherit.gif b/apidocs/resources/inherit.gif new file mode 100644 index 0000000000000000000000000000000000000000..c814867a13deb0ca7ea2156c6ca1d5a03372af7e GIT binary patch literal 57 zcmZ?wbhEHbIIT!9-C*e{wE9>Kx3D)-;0v)C; KYxQGgum%9JOA&7X literal 0 HcmV?d00001 diff --git a/apidocs/serialized-form.html b/apidocs/serialized-form.html new file mode 100644 index 00000000..20d4adbb --- /dev/null +++ b/apidocs/serialized-form.html @@ -0,0 +1,3457 @@ + + + + + + + +Serialized Form (vilya 1.3 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Serialized Form

+
+
+ + + + + +
+Package com.threerings.micasa.client
+ +

+ + + + + +
+Class com.threerings.micasa.client.ChatPanel extends JPanel implements Serializable
+ +

+ + + + + +
+Serialized Fields
+ +

+_ctx

+
+com.threerings.crowd.util.CrowdContext _ctx
+
+
+
+
+
+

+_focus

+
+boolean _focus
+
+
+
+
+
+

+_roombox

+
+JComboBox _roombox
+
+
+
+
+
+

+_text

+
+JTextPane _text
+
+
+
+
+
+

+_send

+
+JButton _send
+
+
+
+
+
+

+_entry

+
+JTextField _entry
+
+
+
+
+
+

+_nameStyle

+
+Style _nameStyle
+
+
+
+
+
+

+_msgStyle

+
+Style _msgStyle
+
+
+
+
+
+

+_errStyle

+
+Style _errStyle
+
+
+
+
+
+

+_noticeStyle

+
+Style _noticeStyle
+
+
+
+
+ +

+ + + + + +
+Class com.threerings.micasa.client.LogonPanel extends JPanel implements Serializable
+ +

+ + + + + +
+Serialized Fields
+ +

+_ctx

+
+MiCasaContext _ctx
+
+
+
+
+
+

+_msgs

+
+com.threerings.util.MessageBundle _msgs
+
+
+
+
+
+

+_username

+
+JTextField _username
+
+
+
+
+
+

+_password

+
+JPasswordField _password
+
+
+
+
+
+

+_logon

+
+JButton _logon
+
+
+
+
+
+

+_status

+
+JTextArea _status
+
+
+
+
+ +

+ + + + + +
+Class com.threerings.micasa.client.MiCasaApplet extends Applet implements Serializable
+ +

+ + + + + +
+Serialized Fields
+ +

+_client

+
+MiCasaClient _client
+
+
+
+
+
+

+_frame

+
+MiCasaFrame _frame
+
+
+
+
+ +

+ + + + + +
+Class com.threerings.micasa.client.MiCasaFrame extends JFrame implements Serializable
+ +

+ + + + + +
+Serialized Fields
+ +

+_controller

+
+Controller _controller
+
+
+
+
+ +

+ + + + + +
+Class com.threerings.micasa.client.OccupantList extends JList implements Serializable
+ +

+ + + + + +
+Serialized Fields
+ +

+_ctx

+
+com.threerings.crowd.util.CrowdContext _ctx
+
+
Our client context. +

+

+
+
+
+

+_model

+
+DefaultListModel _model
+
+
A list model that provides a vector interface. +

+

+
+
+
+ + + + + +
+Package com.threerings.micasa.lobby
+ +

+ + + + + +
+Class com.threerings.micasa.lobby.LobbyPanel extends JPanel implements Serializable
+ +

+ + + + + +
+Serialized Fields
+ +

+_main

+
+JPanel _main
+
+
Contains the match-making view and the chatbox. +

+

+
+
+
+

+_occupants

+
+OccupantList _occupants
+
+
Our occupant list display. +

+

+
+
+ +

+ + + + + +
+Class com.threerings.micasa.lobby.LobbySelector extends JPanel implements Serializable
+ +

+ + + + + +
+Serialized Fields
+ +

+_ctx

+
+MiCasaContext _ctx
+
+
+
+
+
+

+_lservice

+
+LobbyService _lservice
+
+
+
+
+
+

+_combo

+
+JComboBox _combo
+
+
+
+
+
+

+_loblist

+
+JList _loblist
+
+
+
+
+
+

+_catlists

+
+Map<K,V> _catlists
+
+
+
+
+
+

+_pendingCategory

+
+String _pendingCategory
+
+
+
+
+ +

+ + + + + +
+Class com.threerings.micasa.lobby.LobbySelector.LobbyCellRenderer extends DefaultListCellRenderer implements Serializable
+ +

+

+ + + + + +
+Package com.threerings.micasa.lobby.table
+ +

+ + + + + +
+Class com.threerings.micasa.lobby.table.TableItem extends JPanel implements Serializable
+ +

+ + + + + +
+Serialized Fields
+ +

+table

+
+Table table
+
+
A reference to the table we are displaying. +

+

+
+
+
+

+_ctx

+
+MiCasaContext _ctx
+
+
A reference to our context. +

+

+
+
+
+

+_self

+
+com.threerings.util.Name _self
+
+
Our username. +

+

+
+
+
+

+_tdtr

+
+TableDirector _tdtr
+
+
A reference to our table director. +

+

+
+
+
+

+_seats

+
+JButton[] _seats
+
+
We have a button for each "seat" at the table. +

+

+
+
+
+

+_goButton

+
+JButton _goButton
+
+
We have a button for going to games that are already in + progress. +

+

+
+
+ +

+ + + + + +
+Class com.threerings.micasa.lobby.table.TableListView extends JPanel implements Serializable
+ +

+ + + + + +
+Serialized Fields
+ +

+_ctx

+
+MiCasaContext _ctx
+
+
A reference to the client context. +

+

+
+
+
+

+_config

+
+LobbyConfig _config
+
+
A reference to the lobby config for the lobby in which we are + doing table-style matchmaking. +

+

+
+
+
+

+_tdtr

+
+TableDirector _tdtr
+
+
A reference to our table director. +

+

+
+
+
+

+_matchList

+
+JPanel _matchList
+
+
The list of tables currently being matchmade. +

+

+
+
+
+

+_playList

+
+JPanel _playList
+
+
The list of tables that are in play. +

+

+
+
+
+

+_tableFigger

+
+TableConfigurator _tableFigger
+
+
The interface used to configure the table for a game. +

+

+
+
+
+

+_figger

+
+GameConfigurator _figger
+
+
The interface used to configure a game before creating it. +

+

+
+
+
+

+_create

+
+JButton _create
+
+
Our create table button. +

+

+
+
+
+

+_pcount

+
+JLabel _pcount
+
+
Our number of players indicator. +

+

+
+
+
+ + + + + +
+Package com.threerings.micasa.simulator.client
+ +

+ + + + + +
+Class com.threerings.micasa.simulator.client.SimpleFrame extends MiCasaFrame implements Serializable
+ +

+ + + + + +
+Serialized Fields
+ +

+_controller

+
+Controller _controller
+
+
+
+
+
+ + + + + +
+Package com.threerings.parlor.card.client
+ +

+ + + + + +
+Class com.threerings.parlor.card.client.CardPanel extends com.threerings.media.VirtualMediaPanel implements Serializable
+ +

+ + + + + +
+Serialized Fields
+ +

+_cardWidth

+
+int _cardWidth
+
+
The width of the playing cards. +

+

+
+
+
+

+_mouseEvent

+
+MouseEvent _mouseEvent
+
+
The last motion/entrance/exit event received from the mouse. +

+

+
+
+
+

+_activeCardSprite

+
+CardSprite _activeCardSprite
+
+
The currently active card sprite (the one that the mouse is over). +

+

+
+
+
+

+_handSprites

+
+ArrayList<E> _handSprites
+
+
The sprites for cards within the hand. +

+

+
+
+
+

+_selectedHandSprites

+
+ArrayList<E> _selectedHandSprites
+
+
The sprites for cards within the hand that have been selected. +

+

+
+
+
+

+_handSelectionMode

+
+int _handSelectionMode
+
+
The current selection mode for the hand. +

+

+
+
+
+

+_handSelectionPredicate

+
+Predicate<T> _handSelectionPredicate
+
+
The predicate that determines which cards are selectable (if null, all + cards are selectable). +

+

+
+
+
+

+_handSelectionObservers

+
+ObserverList<T> _handSelectionObservers
+
+
Observers of hand card selection/deselection. +

+

+
+
+
+

+_handLocation

+
+Point _handLocation
+
+
The location of the center of the hand's upper edge. +

+

+
+
+
+

+_handSpacing

+
+int _handSpacing
+
+
The horizontal distance between cards in the hand. +

+

+
+
+
+

+_selectableCardOffset

+
+int _selectableCardOffset
+
+
The vertical distance to offset cards that are selectable. +

+

+
+
+
+

+_selectedCardOffset

+
+int _selectedCardOffset
+
+
The vertical distance to offset cards that are selected. +

+

+
+
+
+

+_boardSprites

+
+ArrayList<E> _boardSprites
+
+
The sprites for cards on the board. +

+

+
+
+
+

+_handSpriteObserver

+
+com.threerings.parlor.card.client.CardPanel.HandSpriteObserver _handSpriteObserver
+
+
The hand sprite observer instance. +

+

+
+
+
+

+_pathEndRemover

+
+com.threerings.media.sprite.PathAdapter _pathEndRemover
+
+
A path observer that removes the sprite at the end of its path. +

+

+
+
+
+ + + + + +
+Package com.threerings.parlor.card.data
+ +

+ + + + + +
+Class com.threerings.parlor.card.data.Deck extends com.threerings.util.StreamableArrayList<Card> implements Serializable
+ +

+ +

+ + + + + +
+Class com.threerings.parlor.card.data.Hand extends com.threerings.util.StreamableArrayList<Card> implements Serializable
+ +

+

+ + + + + +
+Package com.threerings.parlor.rating.server.persist
+ +

+ + + + + +
+Class com.threerings.parlor.rating.server.persist.PercentileRecord extends PersistentRecord implements Serializable
+ +

+ + + + + +
+Serialized Fields
+ +

+gameId

+
+int gameId
+
+
The id of the game for which we're tracking a percentile distribution. +

+

+
+
+
+

+gameMode

+
+int gameMode
+
+
The mode of the game. Games can maintain distributions for many different modes. +

+

+
+
+
+

+data

+
+byte[] data
+
+
The raw percentiler data. +

+

+
+
+ +

+ + + + + +
+Class com.threerings.parlor.rating.server.persist.RatingRecord extends PersistentRecord implements Serializable
+ +

+ + + + + +
+Serialized Fields
+ +

+gameId

+
+int gameId
+
+
The identifier of the game we're rating for. +

+

+
+
+
+

+playerId

+
+int playerId
+
+
The identifier of the player we're rating. +

+

+
+
+
+

+rating

+
+int rating
+
+
The player's current rating. +

+

+
+
+
+

+experience

+
+int experience
+
+
The number of times the player has played this game. +

+

+
+
+
+

+lastUpdated

+
+Timestamp lastUpdated
+
+
The last time this rating was updated. +

+

+
+
+
+ + + + + +
+Package com.threerings.parlor.turn.client
+ +

+ + + + + +
+Class com.threerings.parlor.turn.client.TurnDisplay extends JPanel implements Serializable
+ +

+ + + + + +
+Serialized Fields
+ +

+_turnObj

+
+TurnGameObject _turnObj
+
+
The TurnGameObject we're displaying. +

+

+
+
+
+

+_labels

+
+HashMap<K,V> _labels
+
+
A mapping of the labels currently associated with each player. +

+

+
+
+
+

+_playerIcons

+
+Icon[] _playerIcons
+
+
The game-specified player icons. +

+

+
+
+
+

+_winnerText

+
+String _winnerText
+
+
The text to display next to a winner's name. +

+

+
+
+
+

+_drawText

+
+String _drawText
+
+
The text to display next to a drawing player's name. +

+

+
+
+
+

+_turnIcon

+
+Icon _turnIcon
+
+
The Icon we use for indicating the turn. +

+

+
+
+
+ + + + + +
+Package com.threerings.puzzle.client
+ +

+ + + + + +
+Class com.threerings.puzzle.client.PlayerStatusView extends JPanel implements Serializable
+ +

+ + + + + +
+Serialized Fields
+ +

+_gameobj

+
+GameObject _gameobj
+
+
The game object associated with this view. +

+

+
+
+
+

+_username

+
+com.threerings.util.Name _username
+
+
The player name. +

+

+
+
+
+

+_pidx

+
+int _pidx
+
+
The player index. +

+

+
+
+
+

+_highlight

+
+boolean _highlight
+
+
Whether this display is highlighted. +

+

+
+
+
+

+_summary

+
+BoardSummary _summary
+
+
The player board summary. +

+

+
+
+
+

+_status

+
+int _status
+
+
The player game status. +

+

+
+
+ +

+ + + + + +
+Class com.threerings.puzzle.client.PuzzleBoardView extends com.threerings.media.VirtualMediaPanel implements Serializable
+ +

+ + + + + +
+Serialized Fields
+ +

+_ctx

+
+PuzzleContext _ctx
+
+
Our client context. +

+

+
+
+
+

+_pctrl

+
+PuzzleController _pctrl
+
+
Our puzzle controller. +

+

+
+
+
+

+_board

+
+Board _board
+
+
The board data to be displayed. +

+

+
+
+
+

+_bounds

+
+Rectangle _bounds
+
+
The board's bounding rectangle. +

+

+
+
+
+

+_actionAnims

+
+List<E> _actionAnims
+
+
The action animations on the board. +

+

+
+
+
+

+_actionSprites

+
+List<E> _actionSprites
+
+
The action sprites on the board. +

+

+
+
+
+

+_avoidArranger

+
+com.threerings.media.animation.AnimationArranger _avoidArranger
+
+
Prevents certain animations from overlapping others. +

+

+
+
+
+

+_background

+
+com.threerings.media.image.Mirage _background
+
+
Our background image. +

+

+
+
+
+

+_pauseLabel

+
+Label _pauseLabel
+
+
A label to show when the puzzle is paused. +

+

+
+
+
+

+_scoreDist

+
+int _scoreDist
+
+
The distance in pixels that score animations float. +

+

+
+
+
+

+_actionAnimObs

+
+com.threerings.media.animation.AnimationAdapter _actionAnimObs
+
+
Listens to our action animations and clears them when they're done. +

+

+
+
+ +

+ + + + + +
+Class com.threerings.puzzle.client.PuzzlePanel extends JPanel implements Serializable
+ +

+ + + + + +
+Serialized Fields
+ +

+_ctx

+
+PuzzleContext _ctx
+
+
Our puzzle context. +

+

+
+
+
+

+_bview

+
+PuzzleBoardView _bview
+
+
The board view on which the primary puzzle interface is displayed. +

+

+
+
+
+

+_bpanel

+
+JPanel _bpanel
+
+
The board panel displayed while the puzzle is in progress. +

+

+
+
+
+

+_opanel

+
+JPanel _opanel
+
+
The board overlay panel displayed as requested. +

+

+
+
+
+

+_config

+
+GameConfig _config
+
+
The game config. +

+

+
+
+
+

+_robot

+
+RobotPlayer _robot
+
+
The robot player. +

+

+
+
+
+

+_xlate

+
+com.threerings.util.KeyTranslator _xlate
+
+
Our key translations. +

+

+
+
+
+

+_controller

+
+PuzzleController _controller
+
+
The puzzle game controller. +

+

+
+
+
+ + + + + +
+Package com.threerings.puzzle.data
+ +

+ + + + + +
+Class com.threerings.puzzle.data.Board.BoardRandom extends Random implements Serializable
+ +

+ + + + + +
+Serialized Fields
+ +

+_seed

+
+long _seed
+
+
The internal state related to generating random numbers. +

+

+
+
+
+

+_nextNextGaussian

+
+double _nextNextGaussian
+
+
+
+
+
+

+_haveNextNextGaussian

+
+boolean _haveNextNextGaussian
+
+
+
+
+
+ + + + + +
+Package com.threerings.puzzle.drop.client
+ +

+ + + + + +
+Class com.threerings.puzzle.drop.client.DropBoardView extends PuzzleBoardView implements Serializable
+ +

+ + + + + +
+Serialized Fields
+ +

+_dboard

+
+DropBoard _dboard
+
+
The drop board. +

+

+
+
+
+

+_pieces

+
+com.threerings.media.sprite.Sprite[] _pieces
+
+
A sprite for every piece displayed in the drop board. +

+

+
+
+
+

+_moving

+
+boolean[] _moving
+
+
Indicates whether a piece is en route to its destination. +

+

+
+
+
+

+_pwid

+
+int _pwid
+
+
The piece dimensions in pixels. +

+

+
+
+
+

+_phei

+
+int _phei
+
+
The piece dimensions in pixels. +

+

+
+
+
+

+_roff

+
+int _roff
+
+
The board rising offset. +

+

+
+
+
+

+_bwid

+
+int _bwid
+
+
The board dimensions in pieces. +

+

+
+
+
+

+_bhei

+
+int _bhei
+
+
The board dimensions in pieces. +

+

+
+
+ +

+ + + + + +
+Class com.threerings.puzzle.drop.client.NextBlockView extends JComponent implements Serializable
+ +

+ + + + + +
+Serialized Fields
+ +

+_view

+
+DropBoardView _view
+
+
The drop board view from which we obtain piece images. +

+

+
+
+
+

+_pieces

+
+int[] _pieces
+
+
The pieces displayed by this view. +

+

+
+
+
+

+_pwid

+
+int _pwid
+
+
The piece dimensions in pixels. +

+

+
+
+
+

+_phei

+
+int _phei
+
+
The piece dimensions in pixels. +

+

+
+
+
+

+_orient

+
+int _orient
+
+
The view orientation; one of DirectionCodes.HORIZONTAL or DirectionCodes.VERTICAL. +

+

+
+
+
+ + + + + +
+Package com.threerings.stage.client
+ +

+ + + + + +
+Class com.threerings.stage.client.StageScenePanel extends com.threerings.miso.client.MisoScenePanel implements Serializable
+ +

+ + + + + +
+Serialized Fields
+ +

+_ctx

+
+StageContext _ctx
+
+
A reference to our client context. +

+

+
+
+
+

+_ctrl

+
+Controller _ctrl
+
+
The controller with which we work in tandem. +

+

+
+
+
+

+_scene

+
+StageScene _scene
+
+
Our currently displayed scene. +

+

+
+
+
+

+_portobjs

+
+List<E> _portobjs
+
+
Contains scene objects for our portals. +

+

+
+
+
+

+_clusters

+
+Map<K,V> _clusters
+
+
Shapes describing the clusters, indexed by cluster. +

+

+
+
+
+

+_clusterWells

+
+Map<K,V> _clusterWells
+
+
Shapes describing the clusters, indexed by cluster. +

+

+
+
+
+

+_rizer

+
+SceneColorizer _rizer
+
+
Handles scene object colorization. +

+

+
+
+
+ + + + + +
+Package com.threerings.stage.tools.editor
+ +

+ + + + + +
+Class com.threerings.stage.tools.editor.DirectionButton extends AbstractButton implements Serializable
+ +

+ + + + + +
+Serialized Fields
+ +

+_direction

+
+int _direction
+
+
The current direction displayed by the button. +

+

+
+
+
+

+_armed

+
+int _armed
+
+
+
+
+
+

+_dia

+
+int _dia
+
+
Diameter of the drawn enclosing circle. +

+

+
+
+
+

+_cdia

+
+int _cdia
+
+
Diameter of selection circles. +

+

+
+
+
+

+_coords

+
+int[][] _coords
+
+
Coordinates of each of the selection circles. +

+

+
+
+
+

+_prefdia

+
+int _prefdia
+
+
Our preferred diameter. +

+

+
+
+ +

+ + + + + +
+Class com.threerings.stage.tools.editor.EditorDialog extends JInternalFrame implements Serializable
+ +

+ + + + + +
+Serialized Fields
+ +

+_ctx

+
+EditorContext _ctx
+
+
+
+
+
+

+_panel

+
+EditorScenePanel _panel
+
+
+
+
+ +

+ + + + + +
+Class com.threerings.stage.tools.editor.EditorFrame extends com.threerings.media.ManagedJFrame implements Serializable
+ +

+ + + + + +
+Serialized Fields
+ +

+_openListener

+
+ActionListener _openListener
+
+
Handles JFileChooser responses when opening files. +

+

+
+
+
+

+_scene

+
+StageScene _scene
+
+
The scene currently undergoing edit. +

+

+
+
+
+

+_filepath

+
+String _filepath
+
+
The file last associated with the current scene. +

+

+
+
+
+

+_main

+
+JPanel _main
+
+
Contains the scene view panel or other fun stuff. +

+

+
+
+
+

+_dialog

+
+JInternalFrame _dialog
+
+
Used for displaying dialogs. +

+

+
+
+
+

+_chooser

+
+JFileChooser _chooser
+
+
The file chooser used for loading and saving scenes. +

+

+
+
+
+

+_svpanel

+
+EditorScenePanel _svpanel
+
+
The panel that displays the scene view. +

+

+
+
+
+

+_tpanel

+
+TileInfoPanel _tpanel
+
+
The panel that displays tile info. +

+

+
+
+
+

+_sceneInfoPanel

+
+SceneInfoPanel _sceneInfoPanel
+
+
The panel that displays scene info. +

+

+
+
+
+

+_scrollBox

+
+EditorScrollBox _scrollBox
+
+
The scrollbox used to display the view position within the scene. +

+

+
+
+
+

+_model

+
+EditorModel _model
+
+
The editor data model. +

+

+
+
+
+

+_ctx

+
+EditorContext _ctx
+
+
The editor context. +

+

+
+
+
+

+_parser

+
+SceneParser _parser
+
+
We use this to load scenes. +

+

+
+
+
+

+_writer

+
+StageSceneWriter _writer
+
+
We use this to save scenes. +

+

+
+
+
+

+_testLoader

+
+TestTileLoader _testLoader
+
+
The test tileset loader. +

+

+
+
+ +

+ + + + + +
+Class com.threerings.stage.tools.editor.EditorScenePanel extends StageScenePanel implements Serializable
+ +

+ + + + + +
+Serialized Fields
+ +

+_ctx

+
+EditorContext _ctx
+
+
Provides access to stuff. +

+

+
+
+
+

+_emodel

+
+EditorModel _emodel
+
+
Our editor model. +

+

+
+
+
+

+_box

+
+EditorScrollBox _box
+
+
The scrollbox that tracks our view. +

+

+
+
+
+

+_refreshBox

+
+boolean _refreshBox
+
+
Do we need to refresh the image being displayed in our scrollbox? +

+

+
+
+
+

+_frame

+
+JFrame _frame
+
+
We need this to create our dialogs when they are needed. +

+

+
+
+
+

+_horizRange

+
+BoundedRangeModel _horizRange
+
+
Allows scrolling horizontally. +

+

+
+
+
+

+_vertRange

+
+BoundedRangeModel _vertRange
+
+
Allows scrolling vertically. +

+

+
+
+
+

+_area

+
+Rectangle _area
+
+
The virtual screen rectangle around which we scroll. +

+

+
+
+
+

+_coordHighlighting

+
+boolean _coordHighlighting
+
+
Whether or not coordinate highlighting is enabled. +

+

+
+
+
+

+_hfull

+
+Point _hfull
+
+
The currently highlighted full coordinate. +

+

+
+
+
+

+_drag

+
+Point _drag
+
+
The location of the start of a tile drag in tile coords. +

+

+
+
+
+

+_ppos

+
+Point _ppos
+
+
The position of the tile currently being placed. +

+

+
+
+
+

+_validPlacement

+
+boolean _validPlacement
+
+
Used to track whether or not the current "placing" tile is in a + valid position. +

+

+
+
+
+

+_ptile

+
+com.threerings.media.tile.Tile _ptile
+
+
The tile currently being placed. +

+

+
+
+
+

+_pscobj

+
+com.threerings.miso.client.SceneObject _pscobj
+
+
Metrics for the tile currently being placed if it is an object + tile. +

+

+
+
+
+

+_extras

+
+ArrayList<E> _extras
+
+
A list of things that will do some extra painting for us. +

+

+
+
+
+

+_dialogPortal

+
+PortalDialog _dialogPortal
+
+
The dialog providing portal edit functionality. +

+

+
+
+
+

+_objEditor

+
+ObjectEditorDialog _objEditor
+
+
The dialog providing object edit functionality. +

+

+
+
+
+

+_eobject

+
+com.threerings.miso.client.SceneObject _eobject
+
+
The object currently being edited by the object editor dialog. +

+

+
+
+
+

+_undo

+
+com.threerings.stage.tools.editor.EditorScenePanel.UndoStack _undo
+
+
+
+
+
+

+_redo

+
+com.threerings.stage.tools.editor.EditorScenePanel.UndoStack _redo
+
+
+
+
+
+

+_sceneListener

+
+EditorScenePanel.SceneModelListener _sceneListener
+
+
+
+
+ +

+ + + + + +
+Class com.threerings.stage.tools.editor.EditorScrollBox extends ScrollBox implements Serializable
+ +

+ + + + + +
+Serialized Fields
+ +

+_miniMap

+
+BufferedImage _miniMap
+
+
The minimap image. +

+

+
+
+
+

+_panel

+
+EditorScenePanel _panel
+
+
The panel we box for. +

+

+
+
+
+

+_updatingView

+
+boolean _updatingView
+
+
Whether or not we're updating our little view. +

+

+
+
+ +

+ + + + + +
+Class com.threerings.stage.tools.editor.EditorToolBarPanel extends JPanel implements Serializable
+ +

+ + + + + +
+Serialized Fields
+ +

+_buttons

+
+List<E> _buttons
+
+
The buttons in the tool bar. +

+

+
+
+
+

+_model

+
+EditorModel _model
+
+
The editor data model. +

+

+
+
+ +

+ + + + + +
+Class com.threerings.stage.tools.editor.ObjectEditorDialog extends EditorDialog implements Serializable
+ +

+ + + + + +
+Serialized Fields
+ +

+_action

+
+JTextField _action
+
+
+
+
+
+

+_priority

+
+JSlider _priority
+
+
+
+
+
+

+_scobj

+
+com.threerings.miso.client.SceneObject _scobj
+
+
+
+
+
+

+_primary

+
+JComboBox _primary
+
+
+
+
+
+

+_secondary

+
+JComboBox _secondary
+
+
+
+
+
+

+_tertiary

+
+JComboBox _tertiary
+
+
+
+
+
+

+_quaternary

+
+JComboBox _quaternary
+
+
+
+
+ +

+ + + + + +
+Class com.threerings.stage.tools.editor.PortalDialog extends EditorDialog implements Serializable
+ +

+ + + + + +
+Serialized Fields
+ +

+_scene

+
+StageScene _scene
+
+
The scene. +

+

+
+
+
+

+_portalText

+
+JTextField _portalText
+
+
The portal name text entry field. +

+

+
+
+
+

+_entrance

+
+JCheckBox _entrance
+
+
The portal default entrance check box. +

+

+
+
+
+

+_port

+
+EditablePortal _port
+
+
The location object denoting the portal location. +

+

+
+
+
+

+_orientcombo

+
+JComboBox _orientcombo
+
+
The combo box listing the direction orientations. +

+

+
+
+ +

+ + + + + +
+Class com.threerings.stage.tools.editor.PreferencesDialog extends JInternalFrame implements Serializable
+ +

+ +

+ + + + + +
+Class com.threerings.stage.tools.editor.SceneInfoPanel extends JPanel implements Serializable
+ +

+ + + + + +
+Serialized Fields
+ +

+_ctx

+
+EditorContext _ctx
+
+
The giver of life. +

+

+
+
+
+

+_scene

+
+StageScene _scene
+
+
The scene we're controlling. +

+

+
+
+
+

+_scenename

+
+JTextField _scenename
+
+
The scene name entry field. +

+

+
+
+
+

+_scenetype

+
+JComboBox _scenetype
+
+
The scene type selector. +

+

+
+
+
+

+_colorClasses

+
+JComboBox _colorClasses
+
+
The scene type selector. +

+

+
+
+
+

+_colorIds

+
+JComboBox _colorIds
+
+
The scene type selector. +

+

+
+
+
+

+_svpanel

+
+EditorScenePanel _svpanel
+
+
The scene panel, which we hackily repaint when default colors change. +

+

+
+
+
+

+_dirbutton

+
+DirectionButton _dirbutton
+
+
The object grip direction button. +

+

+
+
+ +

+ + + + + +
+Class com.threerings.stage.tools.editor.TileInfoPanel extends JSplitPane implements Serializable
+ +

+ + + + + +
+Serialized Fields
+ +

+_layerSets

+
+Map<K,V> _layerSets
+
+
An ArrayList of TileSetRecords for each layer. +

+

+
+
+
+

+_idToTreePathMap

+
+Map<K,V> _idToTreePathMap
+
+
Map of tileset ID to TreePath. +

+

+
+
+
+

+_layerLengths

+
+int[] _layerLengths
+
+
The original number of TileSetRecords for each layer. +

+

+
+
+
+

+_tsettree

+
+JTree _tsettree
+
+
The tree listing available tilesets. +

+

+
+
+
+

+_selected

+
+DefaultMutableTreeNode _selected
+
+
The selected tree node. +

+

+
+
+
+

+_tiletable

+
+JTable _tiletable
+
+
The table listing all tiles in the selected tileset. +

+

+
+
+
+

+_quickList

+
+JList _quickList
+
+
The list of quickly-selectable tilesets. +

+

+
+
+
+

+_curTrec

+
+com.threerings.stage.tools.editor.TileInfoPanel.TileSetRecord _curTrec
+
+
The currently selected tileset record. +

+

+
+
+
+

+_tablewid

+
+int _tablewid
+
+
The width of the tile table column in pixels. +

+

+
+
+
+

+_scroller

+
+com.threerings.media.SafeScrollPane _scroller
+
+
The scroll pane containing the tile table. +

+

+
+
+
+

+_model

+
+EditorModel _model
+
+
The editor model. +

+

+
+
+
+

+_ctx

+
+EditorContext _ctx
+
+
Our editor client context. +

+

+
+
+
+

+_tablemodel

+
+com.threerings.stage.tools.editor.TileInfoPanel.TileTableModel _tablemodel
+
+
The tile table data model. +

+

+
+
+
+

+_settingTileOurselves

+
+boolean _settingTileOurselves
+
+
+
+
+ +

+ + + + + +
+Class com.threerings.stage.tools.editor.TileInfoPanel.TileTableModel extends AbstractTableModel implements Serializable
+ +

+ + + + + +
+Serialized Fields
+ +

+_icons

+
+ImageIcon[] _icons
+
+
The image icons used to display the table cell contents. +

+

+
+
+
+ + + + + +
+Package com.threerings.stage.tools.viewer
+ +

+ + + + + +
+Class com.threerings.stage.tools.viewer.ViewerFrame extends com.threerings.media.ManagedJFrame implements Serializable
+ +

+ + + + + +
+Serialized Fields
+ +

+_panel

+
+ViewerScenePanel _panel
+
+
+
+
+ +

+ + + + + +
+Class com.threerings.stage.tools.viewer.ViewerScenePanel extends StageScenePanel implements Serializable
+ +

+ + + + + +
+Serialized Fields
+ +

+_defloc

+
+StageLocation _defloc
+
+
The current scene's default entrance. +

+

+
+
+
+

+_charmgr

+
+com.threerings.cast.CharacterManager _charmgr
+
+
Provides character sprite data. +

+

+
+
+
+

+_descUser

+
+com.threerings.cast.CharacterDescriptor _descUser
+
+
The character descriptor for the user character. +

+

+
+
+
+

+_descDecoy

+
+com.threerings.cast.CharacterDescriptor _descDecoy
+
+
The character descriptor for the decoy characters. +

+

+
+
+
+

+_sprite

+
+com.threerings.cast.CharacterSprite _sprite
+
+
The sprite we're manipulating within the view. +

+

+
+
+
+

+_decoys

+
+com.threerings.cast.CharacterSprite[] _decoys
+
+
The test sprites that meander about aimlessly. +

+

+
+
+
+ + + + + +
+Package com.threerings.stats.data
+
+ + + + + +
+Package com.threerings.stats.server.persist
+ +

+ + + + + +
+Class com.threerings.stats.server.persist.MaxStatCodeRecord extends PersistentRecord implements Serializable
+ +

+ + + + + +
+Serialized Fields
+ +

+maxCode

+
+int maxCode
+
+
+
+
+ +

+ + + + + +
+Class com.threerings.stats.server.persist.StatRecord extends PersistentRecord implements Serializable
+ +

+ + + + + +
+Serialized Fields
+ +

+playerId

+
+int playerId
+
+
The identifier of the player this is a stat for. +

+

+
+
+
+

+statCode

+
+int statCode
+
+
The code of the stat. +

+

+
+
+
+

+statData

+
+byte[] statData
+
+
The data associated with the stat. +

+

+
+
+
+

+modCount

+
+byte modCount
+
+
The number of times this stat has been updated, so that simultaneous attempts to update + the same stat in the repository can be caught and handled. Stored as a byte because + we don't expect to ever have more than a couple simultaneous attempts to update a stat. +

+

+
+
+ +

+ + + + + +
+Class com.threerings.stats.server.persist.StringCodeRecord extends PersistentRecord implements Serializable
+ +

+ + + + + +
+Serialized Fields
+ +

+statCode

+
+int statCode
+
+
The code of the stat. +

+

+
+
+
+

+value

+
+String value
+
+
+
+
+
+

+code

+
+int code
+
+
+
+
+
+ + + + + +
+Package com.threerings.whirled.spot.data
+ +

+ + + + + +
+Class com.threerings.whirled.spot.data.Cluster extends Rectangle implements Serializable
+ +

+ + + + + +
+Serialized Fields
+ +

+clusterOid

+
+int clusterOid
+
+
A unique identifier for this cluster (also the distributed object + id of the cluster chat object). +

+

+
+
+
+ + + + + +
+Package com.threerings.whirled.spot.server
+ +

+ + + + + +
+Class com.threerings.whirled.spot.server.SpotSceneManager.ClusterRecord extends HashIntMap<ClusteredBodyObject> implements Serializable
+ +

+ + + + + +
+Serialized Fields
+ +

+_clobj

+
+ClusterObject _clobj
+
+
+
+
+
+

+_cluster

+
+Cluster _cluster
+
+
+
+
+
+ + + + + +
+Package com.threerings.whirled.util
+ +

+ + + + + +
+Class com.threerings.whirled.util.NoSuchSceneException extends Exception implements Serializable
+ +

+ + + + + +
+Serialized Fields
+ +

+_sceneid

+
+int _sceneid
+
+
+
+
+ +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/stylesheet.css b/apidocs/stylesheet.css new file mode 100644 index 00000000..6ea9e516 --- /dev/null +++ b/apidocs/stylesheet.css @@ -0,0 +1,29 @@ +/* Javadoc style sheet */ + +/* Define colors, fonts and other style attributes here to override the defaults */ + +/* Page background color */ +body { background-color: #FFFFFF; color:#000000 } + +/* Headings */ +h1 { font-size: 145% } + +/* Table colors */ +.TableHeadingColor { background: #CCCCFF; color:#000000 } /* Dark mauve */ +.TableSubHeadingColor { background: #EEEEFF; color:#000000 } /* Light mauve */ +.TableRowColor { background: #FFFFFF; color:#000000 } /* White */ + +/* Font used in left-hand frame lists */ +.FrameTitleFont { font-size: 100%; font-family: Helvetica, Arial, sans-serif; color:#000000 } +.FrameHeadingFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 } +.FrameItemFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 } + +/* Navigation bar fonts and colors */ +.NavBarCell1 { background-color:#EEEEFF; color:#000000} /* Light mauve */ +.NavBarCell1Rev { background-color:#00008B; color:#FFFFFF} /* Dark Blue */ +.NavBarFont1 { font-family: Arial, Helvetica, sans-serif; color:#000000;color:#000000;} +.NavBarFont1Rev { font-family: Arial, Helvetica, sans-serif; color:#FFFFFF;color:#FFFFFF;} + +.NavBarCell2 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000} +.NavBarCell3 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000} +