From 37c859e4c947f098bdb4acaa15d36649a6c7914f Mon Sep 17 00:00:00 2001 From: benwoo1110 Date: Thu, 14 Nov 2024 05:57:53 +0000 Subject: [PATCH] Deploy javadoc for 4.3.14 --- javadoc/4.3.14/member-search-index.zip | Bin 13731 -> 13731 bytes javadoc/4.3.14/package-search-index.zip | Bin 349 -> 349 bytes javadoc/4.3.14/type-search-index.zip | Bin 1588 -> 1588 bytes javadoc/latest/allclasses-index.html | 1101 ++ javadoc/latest/allclasses.html | 189 + javadoc/latest/allpackages-index.html | 249 + .../MultiverseCore/MVWorld.NullLocation.html | 438 + .../onarandombox/MultiverseCore/MVWorld.html | 2376 ++++ .../MultiverseCore/MultiverseCore.html | 1716 +++ .../MultiverseCoreConfiguration.html | 1273 ++ .../MultiverseCore/WorldProperties.html | 1323 ++ .../MultiverseCore/api/BlockSafety.html | 457 + .../onarandombox/MultiverseCore/api/Core.html | 859 ++ .../MultiverseCore/api/FancyText.html | 260 + .../api/LocationManipulation.html | 480 + .../MultiverseCore/api/LoggablePlugin.html | 296 + .../MultiverseCore/api/MVDestination.html | 523 + .../MultiverseCore/api/MVPlugin.html | 346 + .../MultiverseCore/api/MVWorldManager.html | 1154 ++ .../api/MultiverseCoreConfig.html | 1033 ++ .../api/MultiverseMessaging.html | 372 + .../MultiverseCore/api/MultiversePlugin.html | 619 + .../MultiverseCore/api/MultiverseWorld.html | 2044 +++ .../MultiverseCore/api/SafeTTeleporter.html | 416 + .../MultiverseCore/api/Teleporter.html | 260 + .../MultiverseCore/api/WorldPurger.html | 402 + .../MultiverseCore/api/package-summary.html | 266 + .../MultiverseCore/api/package-tree.html | 198 + .../commands/AnchorCommand.html | 436 + .../MultiverseCore/commands/CheckCommand.html | 345 + .../MultiverseCore/commands/CloneCommand.html | 345 + .../commands/ConfigCommand.html | 345 + .../commands/ConfirmCommand.html | 345 + .../MultiverseCore/commands/CoordCommand.html | 345 + .../commands/CreateCommand.html | 345 + .../MultiverseCore/commands/DebugCommand.html | 345 + .../commands/DeleteCommand.html | 345 + .../commands/EnvironmentCommand.html | 433 + .../commands/GameruleCommand.html | 345 + .../commands/GamerulesCommand.html | 345 + .../commands/GeneratorCommand.html | 345 + .../MultiverseCore/commands/HelpCommand.html | 436 + .../commands/ImportCommand.html | 345 + .../MultiverseCore/commands/InfoCommand.html | 368 + .../MultiverseCore/commands/ListCommand.html | 345 + .../MultiverseCore/commands/LoadCommand.html | 345 + .../commands/ModifyAddCommand.html | 345 + .../commands/ModifyClearCommand.html | 345 + .../commands/ModifyCommand.html | 371 + .../commands/ModifyRemoveCommand.html | 345 + .../commands/ModifySetCommand.html | 345 + .../commands/MultiverseCommand.html | 389 + .../PaginatedCommand.FilterObject.html | 360 + .../commands/PaginatedCommand.html | 556 + .../commands/PaginatedCoreCommand.html | 368 + .../MultiverseCore/commands/PurgeCommand.html | 345 + .../MultiverseCore/commands/RegenCommand.html | 345 + .../commands/ReloadCommand.html | 345 + .../commands/RemoveCommand.html | 345 + .../commands/ScriptCommand.html | 345 + .../commands/SetSpawnCommand.html | 445 + .../commands/SilentCommand.html | 345 + .../MultiverseCore/commands/SleepCommand.html | 345 + .../MultiverseCore/commands/SpawnCommand.html | 345 + .../commands/TeleportCommand.html | 345 + .../commands/UnloadCommand.html | 345 + .../commands/VersionCommand.html | 345 + .../MultiverseCore/commands/WhoCommand.html | 345 + .../commands/package-summary.html | 399 + .../MultiverseCore/commands/package-tree.html | 213 + .../queue/CommandQueueManager.html | 364 + .../commandtools/queue/QueuedCommand.html | 333 + .../commandtools/queue/package-summary.html | 178 + .../commandtools/queue/package-tree.html | 162 + .../EntryFee.EntryFeeCurrencySerializor.html | 337 + .../configuration/EntryFee.html | 440 + .../configuration/SpawnLocation.html | 461 + .../configuration/SpawnSettings.html | 373 + .../configuration/SubSpawnSettings.html | 427 + .../configuration/WorldPropertyValidator.html | 339 + .../configuration/package-summary.html | 200 + .../configuration/package-tree.html | 178 + .../destination/AnchorDestination.html | 602 + .../destination/BedDestination.html | 648 + .../destination/CannonDestination.html | 626 + .../CustomTeleporterDestination.html | 430 + .../destination/DestinationFactory.html | 391 + .../destination/ExactDestination.html | 622 + .../destination/InvalidDestination.html | 602 + .../destination/PlayerDestination.html | 602 + .../destination/WorldDestination.html | 602 + .../destination/package-summary.html | 217 + .../destination/package-tree.html | 169 + .../display/ColorAlternator.html | 409 + .../MultiverseCore/display/ColorTool.html | 310 + .../display/ContentDisplay.Builder.html | 465 + .../display/ContentDisplay.html | 606 + .../MultiverseCore/display/ContentFilter.html | 525 + .../display/DisplayFormatException.html | 352 + .../display/DisplayHandler.html | 360 + .../display/DisplayHandlers.html | 372 + .../handlers/InlineListDisplayHandler.html | 336 + .../handlers/InlineMapDisplayHandler.html | 336 + .../display/handlers/ListDisplayHandler.html | 340 + .../handlers/PagedListDisplayHandler.html | 369 + .../display/handlers/package-summary.html | 176 + .../display/handlers/package-tree.html | 167 + .../display/package-summary.html | 230 + .../MultiverseCore/display/package-tree.html | 181 + .../display/settings/DisplaySetting.html | 265 + .../settings/InlineDisplaySettings.html | 312 + .../display/settings/MapDisplaySettings.html | 312 + .../settings/PagedDisplaySettings.html | 379 + .../display/settings/package-summary.html | 193 + .../display/settings/package-tree.html | 169 + .../MultiverseCore/enums/Action.html | 415 + .../MultiverseCore/enums/AddProperties.html | 399 + .../enums/AllowedPortalType.html | 450 + .../enums/EnglishChatColor.html | 672 + .../enums/EnglishChatStyle.html | 480 + .../MultiverseCore/enums/RespawnType.html | 389 + .../MultiverseCore/enums/TeleportResult.html | 447 + .../MultiverseCore/enums/package-summary.html | 205 + .../MultiverseCore/enums/package-tree.html | 171 + .../event/MVConfigReloadEvent.html | 400 + .../event/MVDebugModeEvent.html | 379 + .../event/MVPlayerTouchedPortalEvent.html | 487 + .../MultiverseCore/event/MVRespawnEvent.html | 446 + .../MultiverseCore/event/MVTeleportEvent.html | 510 + .../MultiverseCore/event/MVVersionEvent.html | 475 + .../event/MVWorldDeleteEvent.html | 441 + .../event/MVWorldPropertyChangeEvent.html | 582 + .../MultiverseCore/event/package-summary.html | 213 + .../MultiverseCore/event/package-tree.html | 172 + .../PropertyDoesNotExistException.html | 307 + .../exceptions/package-summary.html | 171 + .../exceptions/package-tree.html | 169 + .../listeners/AsyncChatEvent.html | 380 + .../MultiverseCore/listeners/ChatEvent.html | 314 + .../listeners/MVAsyncPlayerChatListener.html | 330 + .../listeners/MVChatListener.html | 323 + .../listeners/MVEntityListener.html | 380 + .../listeners/MVMapListener.html | 317 + .../listeners/MVPlayerChatListener.html | 330 + .../listeners/MVPlayerListener.html | 487 + .../listeners/MVPortalListener.html | 359 + .../listeners/MVWeatherListener.html | 338 + .../listeners/MVWorldInitListener.html | 309 + .../listeners/MVWorldListener.html | 338 + .../listeners/MultiverseCoreListener.html | 443 + .../listeners/NormalChatEvent.html | 398 + .../listeners/package-summary.html | 258 + .../listeners/package-tree.html | 182 + .../MultiverseCore/package-summary.html | 193 + .../MultiverseCore/package-tree.html | 185 + .../MultiverseCore/utils/AnchorManager.html | 471 + .../utils/BukkitTravelAgent.html | 462 + .../utils/CompatibilityLayer.html | 408 + .../MultiverseCore/utils/DebugLog.html | 429 + .../utils/FancyColorScheme.html | 404 + .../MultiverseCore/utils/FancyHeader.html | 343 + .../MultiverseCore/utils/FancyMessage.html | 410 + .../MultiverseCore/utils/FileUtils.html | 394 + .../utils/LocationManipulation.html | 516 + .../MultiverseCore/utils/MVEconomist.html | 639 + .../MultiverseCore/utils/MVMessaging.html | 439 + .../MultiverseCore/utils/MVPermissions.html | 575 + .../MultiverseCore/utils/MVPlayerSession.html | 331 + .../MultiverseCore/utils/MVTravelAgent.html | 341 + .../utils/MaterialConverter.html | 347 + .../MultiverseCore/utils/PermissionTools.html | 437 + .../MultiverseCore/utils/PlayerFinder.html | 484 + .../MultiverseCore/utils/PurgeWorlds.html | 385 + .../MultiverseCore/utils/ReflectHelper.html | 531 + .../utils/SimpleBlockSafety.html | 546 + .../utils/SimpleLocationManipulation.html | 557 + .../utils/SimpleSafeTTeleporter.html | 495 + .../utils/SimpleWorldPurger.html | 471 + .../MultiverseCore/utils/TestingMode.html | 320 + .../utils/UnsafeCallWrapper.html | 326 + .../MultiverseCore/utils/VaultHandler.html | 338 + .../MultiverseCore/utils/WorldManager.html | 1306 ++ .../utils/WorldNameChecker.FolderStatus.html | 403 + .../utils/WorldNameChecker.NameStatus.html | 403 + .../utils/WorldNameChecker.html | 473 + .../utils/metrics/MetricsConfigurator.html | 264 + .../utils/metrics/package-summary.html | 164 + .../utils/metrics/package-tree.html | 161 + .../MultiverseCore/utils/package-summary.html | 354 + .../MultiverseCore/utils/package-tree.html | 207 + .../utils/webpaste/PasteFailedException.html | 305 + .../utils/webpaste/PasteService.html | 335 + .../utils/webpaste/PasteServiceFactory.html | 277 + .../utils/webpaste/PasteServiceType.html | 424 + .../utils/webpaste/URLShortener.html | 280 + .../utils/webpaste/URLShortenerFactory.html | 274 + .../utils/webpaste/URLShortenerType.html | 373 + .../utils/webpaste/package-summary.html | 229 + .../utils/webpaste/package-tree.html | 188 + javadoc/latest/constant-values.html | 200 + javadoc/latest/deprecated-list.html | 441 + javadoc/latest/element-list | 16 + javadoc/latest/help-doc.html | 272 + javadoc/latest/index-all.html | 5283 +++++++ javadoc/latest/index.html | 245 + javadoc/latest/jquery-ui.overrides.css | 35 + .../latest/jquery/external/jquery/jquery.js | 10872 +++++++++++++++ javadoc/latest/jquery/jquery-3.7.1.min.js | 2 + javadoc/latest/jquery/jquery-ui.min.css | 6 + javadoc/latest/jquery/jquery-ui.min.js | 6 + .../jquery/jszip-utils/dist/jszip-utils-ie.js | 56 + .../jszip-utils/dist/jszip-utils-ie.min.js | 10 + .../jquery/jszip-utils/dist/jszip-utils.js | 118 + .../jszip-utils/dist/jszip-utils.min.js | 10 + javadoc/latest/jquery/jszip/dist/jszip.js | 11370 ++++++++++++++++ javadoc/latest/jquery/jszip/dist/jszip.min.js | 13 + javadoc/latest/legal/ADDITIONAL_LICENSE_INFO | 37 + javadoc/latest/legal/ASSEMBLY_EXCEPTION | 27 + javadoc/latest/legal/LICENSE | 347 + javadoc/latest/legal/jquery.md | 26 + javadoc/latest/legal/jqueryUI.md | 49 + javadoc/latest/legal/jszip.md | 653 + javadoc/latest/legal/pako.md | 45 + javadoc/latest/member-search-index.js | 1 + javadoc/latest/member-search-index.zip | Bin 0 -> 13731 bytes javadoc/latest/overview-summary.html | 23 + javadoc/latest/overview-tree.html | 422 + javadoc/latest/package-search-index.js | 1 + javadoc/latest/package-search-index.zip | Bin 0 -> 349 bytes javadoc/latest/resources/glass.png | Bin 0 -> 499 bytes javadoc/latest/resources/x.png | Bin 0 -> 394 bytes javadoc/latest/script.js | 149 + javadoc/latest/search.js | 326 + javadoc/latest/serialized-form.html | 185 + javadoc/latest/stylesheet.css | 910 ++ javadoc/latest/type-search-index.js | 1 + javadoc/latest/type-search-index.zip | Bin 0 -> 1588 bytes 237 files changed, 114461 insertions(+) create mode 100644 javadoc/latest/allclasses-index.html create mode 100644 javadoc/latest/allclasses.html create mode 100644 javadoc/latest/allpackages-index.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/MVWorld.NullLocation.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/MVWorld.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/MultiverseCore.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/MultiverseCoreConfiguration.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/WorldProperties.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/api/BlockSafety.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/api/Core.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/api/FancyText.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/api/LocationManipulation.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/api/LoggablePlugin.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/api/MVDestination.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/api/MVPlugin.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/api/MVWorldManager.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/api/MultiverseCoreConfig.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/api/MultiverseMessaging.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/api/MultiversePlugin.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/api/MultiverseWorld.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/api/SafeTTeleporter.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/api/Teleporter.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/api/WorldPurger.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/api/package-summary.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/api/package-tree.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/commands/AnchorCommand.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/commands/CheckCommand.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/commands/CloneCommand.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/commands/ConfigCommand.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/commands/ConfirmCommand.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/commands/CoordCommand.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/commands/CreateCommand.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/commands/DebugCommand.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/commands/DeleteCommand.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/commands/EnvironmentCommand.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/commands/GameruleCommand.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/commands/GamerulesCommand.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/commands/GeneratorCommand.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/commands/HelpCommand.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/commands/ImportCommand.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/commands/InfoCommand.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/commands/ListCommand.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/commands/LoadCommand.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/commands/ModifyAddCommand.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/commands/ModifyClearCommand.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/commands/ModifyCommand.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/commands/ModifyRemoveCommand.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/commands/ModifySetCommand.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/commands/MultiverseCommand.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/commands/PaginatedCommand.FilterObject.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/commands/PaginatedCommand.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/commands/PaginatedCoreCommand.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/commands/PurgeCommand.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/commands/RegenCommand.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/commands/ReloadCommand.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/commands/RemoveCommand.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/commands/ScriptCommand.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/commands/SetSpawnCommand.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/commands/SilentCommand.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/commands/SleepCommand.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/commands/SpawnCommand.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/commands/TeleportCommand.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/commands/UnloadCommand.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/commands/VersionCommand.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/commands/WhoCommand.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/commands/package-summary.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/commands/package-tree.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/commandtools/queue/CommandQueueManager.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/commandtools/queue/QueuedCommand.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/commandtools/queue/package-summary.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/commandtools/queue/package-tree.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/configuration/EntryFee.EntryFeeCurrencySerializor.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/configuration/EntryFee.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/configuration/SpawnLocation.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/configuration/SpawnSettings.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/configuration/SubSpawnSettings.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/configuration/WorldPropertyValidator.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/configuration/package-summary.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/configuration/package-tree.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/destination/AnchorDestination.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/destination/BedDestination.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/destination/CannonDestination.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/destination/CustomTeleporterDestination.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/destination/DestinationFactory.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/destination/ExactDestination.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/destination/InvalidDestination.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/destination/PlayerDestination.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/destination/WorldDestination.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/destination/package-summary.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/destination/package-tree.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/display/ColorAlternator.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/display/ColorTool.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/display/ContentDisplay.Builder.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/display/ContentDisplay.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/display/ContentFilter.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/display/DisplayFormatException.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/display/DisplayHandler.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/display/DisplayHandlers.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/display/handlers/InlineListDisplayHandler.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/display/handlers/InlineMapDisplayHandler.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/display/handlers/ListDisplayHandler.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/display/handlers/PagedListDisplayHandler.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/display/handlers/package-summary.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/display/handlers/package-tree.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/display/package-summary.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/display/package-tree.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/display/settings/DisplaySetting.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/display/settings/InlineDisplaySettings.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/display/settings/MapDisplaySettings.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/display/settings/PagedDisplaySettings.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/display/settings/package-summary.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/display/settings/package-tree.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/enums/Action.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/enums/AddProperties.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/enums/AllowedPortalType.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/enums/EnglishChatColor.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/enums/EnglishChatStyle.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/enums/RespawnType.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/enums/TeleportResult.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/enums/package-summary.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/enums/package-tree.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/event/MVConfigReloadEvent.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/event/MVDebugModeEvent.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/event/MVPlayerTouchedPortalEvent.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/event/MVRespawnEvent.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/event/MVTeleportEvent.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/event/MVVersionEvent.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/event/MVWorldDeleteEvent.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/event/MVWorldPropertyChangeEvent.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/event/package-summary.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/event/package-tree.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/exceptions/PropertyDoesNotExistException.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/exceptions/package-summary.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/exceptions/package-tree.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/listeners/AsyncChatEvent.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/listeners/ChatEvent.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/listeners/MVAsyncPlayerChatListener.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/listeners/MVChatListener.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/listeners/MVEntityListener.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/listeners/MVMapListener.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/listeners/MVPlayerChatListener.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/listeners/MVPlayerListener.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/listeners/MVPortalListener.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/listeners/MVWeatherListener.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/listeners/MVWorldInitListener.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/listeners/MVWorldListener.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/listeners/MultiverseCoreListener.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/listeners/NormalChatEvent.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/listeners/package-summary.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/listeners/package-tree.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/package-summary.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/package-tree.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/utils/AnchorManager.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/utils/BukkitTravelAgent.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/utils/CompatibilityLayer.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/utils/DebugLog.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/utils/FancyColorScheme.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/utils/FancyHeader.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/utils/FancyMessage.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/utils/FileUtils.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/utils/LocationManipulation.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/utils/MVEconomist.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/utils/MVMessaging.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/utils/MVPermissions.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/utils/MVPlayerSession.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/utils/MVTravelAgent.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/utils/MaterialConverter.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/utils/PermissionTools.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/utils/PlayerFinder.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/utils/PurgeWorlds.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/utils/ReflectHelper.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/utils/SimpleBlockSafety.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/utils/SimpleLocationManipulation.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/utils/SimpleSafeTTeleporter.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/utils/SimpleWorldPurger.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/utils/TestingMode.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/utils/UnsafeCallWrapper.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/utils/VaultHandler.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/utils/WorldManager.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/utils/WorldNameChecker.FolderStatus.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/utils/WorldNameChecker.NameStatus.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/utils/WorldNameChecker.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/utils/metrics/MetricsConfigurator.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/utils/metrics/package-summary.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/utils/metrics/package-tree.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/utils/package-summary.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/utils/package-tree.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/utils/webpaste/PasteFailedException.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/utils/webpaste/PasteService.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/utils/webpaste/PasteServiceFactory.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/utils/webpaste/PasteServiceType.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/utils/webpaste/URLShortener.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/utils/webpaste/URLShortenerFactory.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/utils/webpaste/URLShortenerType.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/utils/webpaste/package-summary.html create mode 100644 javadoc/latest/com/onarandombox/MultiverseCore/utils/webpaste/package-tree.html create mode 100644 javadoc/latest/constant-values.html create mode 100644 javadoc/latest/deprecated-list.html create mode 100644 javadoc/latest/element-list create mode 100644 javadoc/latest/help-doc.html create mode 100644 javadoc/latest/index-all.html create mode 100644 javadoc/latest/index.html create mode 100644 javadoc/latest/jquery-ui.overrides.css create mode 100644 javadoc/latest/jquery/external/jquery/jquery.js create mode 100644 javadoc/latest/jquery/jquery-3.7.1.min.js create mode 100644 javadoc/latest/jquery/jquery-ui.min.css create mode 100644 javadoc/latest/jquery/jquery-ui.min.js create mode 100644 javadoc/latest/jquery/jszip-utils/dist/jszip-utils-ie.js create mode 100644 javadoc/latest/jquery/jszip-utils/dist/jszip-utils-ie.min.js create mode 100644 javadoc/latest/jquery/jszip-utils/dist/jszip-utils.js create mode 100644 javadoc/latest/jquery/jszip-utils/dist/jszip-utils.min.js create mode 100644 javadoc/latest/jquery/jszip/dist/jszip.js create mode 100644 javadoc/latest/jquery/jszip/dist/jszip.min.js create mode 100644 javadoc/latest/legal/ADDITIONAL_LICENSE_INFO create mode 100644 javadoc/latest/legal/ASSEMBLY_EXCEPTION create mode 100644 javadoc/latest/legal/LICENSE create mode 100644 javadoc/latest/legal/jquery.md create mode 100644 javadoc/latest/legal/jqueryUI.md create mode 100644 javadoc/latest/legal/jszip.md create mode 100644 javadoc/latest/legal/pako.md create mode 100644 javadoc/latest/member-search-index.js create mode 100644 javadoc/latest/member-search-index.zip create mode 100644 javadoc/latest/overview-summary.html create mode 100644 javadoc/latest/overview-tree.html create mode 100644 javadoc/latest/package-search-index.js create mode 100644 javadoc/latest/package-search-index.zip create mode 100644 javadoc/latest/resources/glass.png create mode 100644 javadoc/latest/resources/x.png create mode 100644 javadoc/latest/script.js create mode 100644 javadoc/latest/search.js create mode 100644 javadoc/latest/serialized-form.html create mode 100644 javadoc/latest/stylesheet.css create mode 100644 javadoc/latest/type-search-index.js create mode 100644 javadoc/latest/type-search-index.zip diff --git a/javadoc/4.3.14/member-search-index.zip b/javadoc/4.3.14/member-search-index.zip index 81c17f5286d7e9569e87922502eff9db793ecf87..48acef12eae47d5cecd430c455d320caad23a847 100644 GIT binary patch delta 28 jcmZ3Sy*QgEz?+#xgn@&DgTYdNBagc&lcoOTP*XnuVk`!2 delta 28 jcmZ3Sy*QgEz?+#xgn@&DgW;3PMjm%lrcWx9LrwhvZ!8DN diff --git a/javadoc/4.3.14/package-search-index.zip b/javadoc/4.3.14/package-search-index.zip index 0cd31421d3a3f9db63778e2eefbf023a1b961c40..c0bd58f885f86ba4bc95d5b1a31241ea6fa774b3 100644 GIT binary patch delta 27 icmcc1beD-Iz?+#xgn@&DgTYdNArB*yrT%0-Mt=ZLTLlUL delta 27 icmcc1beD-Iz?+#xgn@&DgW;3PLLNq@Pb!o782tfTtp;WQ diff --git a/javadoc/4.3.14/type-search-index.zip b/javadoc/4.3.14/type-search-index.zip index 5702128102f0bc3634d16671e9236d6f3e8ed359..745da26edd72e49a7bebeda2fdcb9718669118d3 100644 GIT binary patch delta 28 jcmdnOvxSEzz?+#xgn@&DgTYdNBhM{XCQJRvFIas5S9k`M delta 28 kcmdnOvxSEzz?+#xgn@&DgW;3PMxI-&OrKOHzhLzN0AzRv@c;k- diff --git a/javadoc/latest/allclasses-index.html b/javadoc/latest/allclasses-index.html new file mode 100644 index 000000000..3bbff7449 --- /dev/null +++ b/javadoc/latest/allclasses-index.html @@ -0,0 +1,1101 @@ + + + + + +All Classes (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+
+
+

All Classes

+
+
+ +
+
+ + + diff --git a/javadoc/latest/allclasses.html b/javadoc/latest/allclasses.html new file mode 100644 index 000000000..1233d6c38 --- /dev/null +++ b/javadoc/latest/allclasses.html @@ -0,0 +1,189 @@ + + + + + +All Classes (multiverse-core 4.3.14 API) + + + + + + + + + + + + +
+

All Classes

+
+ +
+
+ + diff --git a/javadoc/latest/allpackages-index.html b/javadoc/latest/allpackages-index.html new file mode 100644 index 000000000..78fe4b33d --- /dev/null +++ b/javadoc/latest/allpackages-index.html @@ -0,0 +1,249 @@ + + + + + +All Packages (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+
+
+

All Packages

+
+
+ +
+
+ + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/MVWorld.NullLocation.html b/javadoc/latest/com/onarandombox/MultiverseCore/MVWorld.NullLocation.html new file mode 100644 index 000000000..67ca4a4c2 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/MVWorld.NullLocation.html @@ -0,0 +1,438 @@ + + + + + +MVWorld.NullLocation (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore
+

Class MVWorld.NullLocation

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable, org.bukkit.configuration.serialization.ConfigurationSerializable
    +
    +
    +
    Enclosing class:
    +
    MVWorld
    +
    +
    +
    public static final class MVWorld.NullLocation
+extends SpawnLocation
    +
    Null-location.
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      NullLocation() 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      org.bukkit.Locationclone() 
      static MVWorld.NullLocationdeserialize​(java.util.Map<java.lang.String,​java.lang.Object> args) +
      Let Bukkit be able to deserialize this.
      +
      inthashCode() 
      java.util.Map<java.lang.String,​java.lang.Object>serialize()
      java.lang.StringtoString() 
      org.bukkit.util.VectortoVector() 
      + +
        +
      • + + +

        Methods inherited from class org.bukkit.Location

        +add, add, add, checkFinite, distance, distanceSquared, equals, getBlockX, getBlockY, getBlockZ, getDirection, getPitch, getX, getY, getYaw, getZ, length, lengthSquared, locToBlock, multiply, normalizePitch, normalizeYaw, setDirection, setPitch, setX, setY, setYaw, setZ, subtract, subtract, subtract, zero
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        NullLocation

        +
        public NullLocation()
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        clone

        +
        public org.bukkit.Location clone()
        +
        +
        Overrides:
        +
        clone in class org.bukkit.Location
        +
        +
        • +
      + + + +
        +
      • +

        serialize

        +
        public java.util.Map<java.lang.String,​java.lang.Object> serialize()
        +
        Description copied from class: SpawnLocation
        +
        +
        Specified by:
        +
        serialize in interface org.bukkit.configuration.serialization.ConfigurationSerializable
        +
        Overrides:
        +
        serialize in class SpawnLocation
        +
        +
        • +
      + + + +
        +
      • +

        deserialize

        +
        public static MVWorld.NullLocation deserialize​(java.util.Map<java.lang.String,​java.lang.Object> args)
        +
        Let Bukkit be able to deserialize this.
        +
        +
        Parameters:
        +
        args - The map.
        +
        Returns:
        +
        The deserialized object.
        +
        +
        • +
      + + + +
        +
      • +

        toVector

        +
        public org.bukkit.util.Vector toVector()
        +
        +
        Overrides:
        +
        toVector in class org.bukkit.Location
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class org.bukkit.Location
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class org.bukkit.Location
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/MVWorld.html b/javadoc/latest/com/onarandombox/MultiverseCore/MVWorld.html new file mode 100644 index 000000000..a9b02ea7b --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/MVWorld.html @@ -0,0 +1,2376 @@ + + + + + +MVWorld (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore
+

Class MVWorld

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.MVWorld
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    MultiverseWorld
    +
    +
    +
    public class MVWorld
+extends java.lang.Object
+implements MultiverseWorld
    +
    The implementation of a Multiverse handled world.
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClassDescription
      static class MVWorld.NullLocation +
      Null-location.
      +
      +
      • +
    +
    + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and TypeMethodDescription
      booleanaddToVariable​(java.lang.String property, + java.lang.String value) +
      Deprecated. +
      This is deprecated.
      +
      +
      voidallowPortalMaking​(AllowedPortalType portalType) +
      Sets The types of portals that are allowed in this world.
      +
      booleancanAnimalsSpawn() +
      Gets whether or not animals are allowed to spawn in this world.
      +
      booleancanMonstersSpawn() +
      Gets whether or not monsters are allowed to spawn in this world.
      +
      booleanclearList​(java.lang.String property) +
      Deprecated. +
      This is deprecated.
      +
      +
      booleanclearVariable​(java.lang.String property) +
      Deprecated. +
      This is deprecated.
      +
      +
      voidcopyValues​(MVWorld other) +
      Copies all properties from another MVWorld object.
      +
      voidcopyValues​(WorldProperties other) +
      Copies all properties from a WorldProperties object.
      +
      org.bukkit.permissions.PermissiongetAccessPermission() +
      Gets the permission required to enter this world.
      +
      booleangetAdjustSpawn() +
      Gets whether or not Multiverse should auto-adjust the spawn for this world.
      +
      java.lang.StringgetAlias() +
      Gets the alias of this world.
      +
      AllowedPortalTypegetAllowedPortals() +
      Gets which type(s) of portals are allowed to be constructed in this world.
      +
      booleangetAllowFlight() +
      Whether or not players are allowed to fly in this world.
      +
      java.lang.StringgetAllPropertyNames() +
      Gets all the names of all properties that can be SET.
      +
      java.util.List<java.lang.String>getAnimalList() +
      Returns a list of animals.
      +
      booleangetAutoHeal() +
      Gets whether or not a world will auto-heal players if the difficulty is on peaceful.
      +
      booleangetAutoLoad() +
      Gets whether or not Multiverse should auto-load this world.
      +
      booleangetBedRespawn() +
      Gets whether or not a player who dies in this world will respawn in their + bed or follow the normal respawn pattern.
      +
      org.bukkit.WorldgetCBWorld() +
      Returns the Bukkit world object that this world describes.
      +
      org.bukkit.ChatColorgetColor() +
      Gets the color that this world's name/alias will display as.
      +
      java.lang.StringgetColoredWorldString() +
      Returns a very nicely colored string (using Alias and Color if they are set).
      +
      org.bukkit.MaterialgetCurrency() +
      Gets the type of currency that will be used when users enter this world.
      +
      org.bukkit.DifficultygetDifficulty() +
      Gets the difficulty of this world.
      +
      org.bukkit.World.EnvironmentgetEnvironment() +
      Gets the environment of this world.
      +
      org.bukkit.permissions.PermissiongetExemptPermission() +
      Gets the permission required to be exempt when entering.
      +
      booleangetFakePVP() +
      Deprecated. +
      This is deprecated.
      +
      +
      org.bukkit.GameModegetGameMode() +
      Gets the GameMode of this world.
      +
      java.lang.StringgetGenerator() +
      Gets the generator of this world.
      +
      booleangetHunger() +
      Gets whether or not the hunger level of players will go down in a world.
      +
      java.util.List<java.lang.String>getMonsterList() +
      Returns a list of monsters.
      +
      java.lang.StringgetName() +
      Gets the name of this world.
      +
      java.lang.StringgetPermissibleName() +
      Gets the lowercased name of the world.
      +
      intgetPlayerLimit() +
      Gets the player limit for this world after which players without an override + permission node will not be allowed in.
      +
      doublegetPrice() +
      Gets the amount of currency it requires to enter this world.
      +
      java.lang.StringgetPropertyHelp​(java.lang.String property) +
      Gets the help-message for a property.
      +
      java.lang.StringgetPropertyValue​(java.lang.String property) +
      Gets a property as String.
      +
      org.bukkit.WorldgetRespawnToWorld() +
      Gets the world players will respawn in if they die in this one.
      +
      doublegetScaling() +
      Gets the scaling value of this world.Really only has an effect if you use + Multiverse-NetherPortals.
      +
      longgetSeed() +
      Gets the world seed of this world.
      +
      org.bukkit.LocationgetSpawnLocation() +
      Gets the spawn location of this world.
      +
      org.bukkit.ChatColorgetStyle() +
      Gets the style that this world's name/alias will display as.
      +
      java.lang.StringgetTime() +
      Same as MultiverseWorld.getTime(), but returns a string.
      +
      java.util.List<java.lang.String>getWorldBlacklist() +
      Gets a list of all the worlds that players CANNOT travel to from this world, + regardless of their access permissions.
      +
      org.bukkit.WorldTypegetWorldType() +
      Gets the type of this world.
      +
      booleanisHidden() +
      Gets whether or not this world will display in chat, mvw and mvl regardless if a user has the + access permissions to go to this world.
      +
      booleanisKeepingSpawnInMemory() +
      Gets whether or not CraftBukkit is keeping the chunks for this world in memory.
      +
      booleanisPVPEnabled() +
      Gets whether or not PVP is enabled in this world in some form (fake or not).
      +
      booleanisValidAliasColor​(java.lang.String aliasColor) +
      Deprecated. +
      This is deprecated.
      +
      +
      booleanisWeatherEnabled() +
      Gets whether weather is enabled in this world.
      +
      booleanremoveFromVariable​(java.lang.String property, + java.lang.String value) +
      Deprecated. +
      This is deprecated.
      +
      +
      voidsetAdjustSpawn​(boolean adjust) +
      Sets whether or not Multiverse should auto-adjust the spawn for this world.
      +
      voidsetAlias​(java.lang.String alias) +
      Sets the alias of the world.
      +
      voidsetAllowAnimalSpawn​(boolean animals) +
      Sets whether or not animals can spawn.
      +
      voidsetAllowFlight​(boolean allowFlight) +
      Sets whether or not players are allowed to fly in this world.
      +
      voidsetAllowMonsterSpawn​(boolean monsters) +
      Sets whether or not monsters can spawn.
      +
      voidsetAutoHeal​(boolean heal) +
      Sets whether or not a world will auto-heal players if the difficulty is on peaceful.
      +
      voidsetAutoLoad​(boolean load) +
      Sets whether or not Multiverse should auto-load this world.
      +
      voidsetBedRespawn​(boolean respawn) +
      Sets whether or not a player who dies in this world will respawn in their + bed or follow the normal respawn pattern.
      +
      booleansetColor​(java.lang.String aliasColor) +
      Sets the color that this world's name/alias will display as.
      +
      voidsetCurrency​(@Nullable org.bukkit.Material currency) +
      Sets the type of item that will be required given the price is not 0.
      +
      booleansetDifficulty​(java.lang.String difficulty) +
      Deprecated. +
      This is deprecated.
      +
      +
      booleansetDifficulty​(org.bukkit.Difficulty difficulty) +
      Sets the difficulty of this world and returns true on success.
      +
      voidsetEnableWeather​(boolean weather) +
      Sets whether or not there will be weather events in a given world.
      +
      voidsetEnvironment​(org.bukkit.World.Environment environment) +
      Sets the environment of a world.
      +
      booleansetGameMode​(java.lang.String mode) +
      Sets the game mode of this world.
      +
      booleansetGameMode​(org.bukkit.GameMode mode) +
      Sets the game mode of this world.
      +
      voidsetGenerator​(java.lang.String generator) +
      Sets the generator of this world.
      +
      voidsetHidden​(boolean hidden) +
      Sets whether or not this world will display in chat, mvw and mvl regardless if a user has the + access permissions to go to this world.
      +
      voidsetHunger​(boolean hunger) +
      Sets whether or not the hunger level of players will go down in a world.
      +
      voidsetKeepSpawnInMemory​(boolean value) +
      If true, tells Craftbukkit to keep a worlds spawn chunks loaded in memory (default: true) + If not, CraftBukkit will attempt to free memory when players have not used that world.
      +
      voidsetPlayerLimit​(int limit) +
      Sets the player limit for this world after which players without an override + permission node will not be allowed in.
      +
      voidsetPrice​(double price) +
      Sets the price for entry to this world.
      +
      booleansetPropertyValue​(java.lang.String property, + java.lang.String value) +
      Sets a property to a given value.
      +
      voidsetPVPMode​(boolean pvp) +
      Turn pvp on or off.
      +
      booleansetRespawnToWorld​(java.lang.String respawnToWorld) +
      Sets the world players will respawn in if they die in this one.
      +
      booleansetScaling​(double scaling) +
      Sets the scale of this world.
      +
      voidsetSeed​(long seed) +
      Sets the seed of this world.
      +
      voidsetSpawnLocation​(org.bukkit.Location l) +
      Sets the spawn location for a world.
      +
      booleansetStyle​(java.lang.String style) +
      Sets the style that this world's name/alias will display as.
      +
      booleansetTime​(java.lang.String timeAsString) +
      Sets the current time in a world.
      +
      java.lang.StringtoString() 
      voidvalidateEntitySpawns() +
      This method is here to provide a stopgap until the add/remove/clear methods are implemented with + SerializationConfig.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        validateEntitySpawns

        +
        public void validateEntitySpawns()
        +
        This method is here to provide a stopgap until the add/remove/clear methods are implemented with + SerializationConfig.
        +
        • +
      + + + +
        +
      • +

        copyValues

        +
        public void copyValues​(MVWorld other)
        +
        Copies all properties from another MVWorld object.
        +
        +
        Parameters:
        +
        other - The other world object.
        +
        +
        • +
      + + + +
        +
      • +

        copyValues

        +
        public void copyValues​(WorldProperties other)
        +
        Copies all properties from a WorldProperties object.
        +
        +
        Parameters:
        +
        other - The world properties object.
        +
        +
        • +
      + + + +
        +
      • +

        getCBWorld

        +
        public org.bukkit.World getCBWorld()
        +
        Returns the Bukkit world object that this world describes.
        +
        +
        Specified by:
        +
        getCBWorld in interface MultiverseWorld
        +
        Returns:
        +
        A World
        +
        +
        • +
      + + + +
        +
      • +

        getColoredWorldString

        +
        public java.lang.String getColoredWorldString()
        +
        Returns a very nicely colored string (using Alias and Color if they are set).
        +
        +
        Specified by:
        +
        getColoredWorldString in interface MultiverseWorld
        +
        Returns:
        +
        A nicely colored string.
        +
        +
        • +
      + + + +
        +
      • +

        clearList

        +
        @Deprecated
+public boolean clearList​(java.lang.String property)
        +
        Deprecated. +
        This is deprecated.
        +
        +
        Clears a list property (sets it to []).
        +
        +
        Specified by:
        +
        clearList in interface MultiverseWorld
        +
        Parameters:
        +
        property - The property to clear.
        +
        Returns:
        +
        True if success, false if fail.
        +
        +
        • +
      + + + +
        +
      • +

        clearVariable

        +
        @Deprecated
+public boolean clearVariable​(java.lang.String property)
        +
        Deprecated. +
        This is deprecated.
        +
        +
        Removes all values from the given property. The property must be a AddProperties.
        +
        +
        Specified by:
        +
        clearVariable in interface MultiverseWorld
        +
        Parameters:
        +
        property - The name of a AddProperties to clear.
        +
        Returns:
        +
        True if it was cleared, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        addToVariable

        +
        @Deprecated
+public boolean addToVariable​(java.lang.String property,
+                             java.lang.String value)
        +
        Deprecated. +
        This is deprecated.
        +
        +
        Adds a value to the given property. The property must be a AddProperties.
        +
        +
        Specified by:
        +
        addToVariable in interface MultiverseWorld
        +
        Parameters:
        +
        property - The name of a AddProperties to add a value to.
        +
        value - A value in string representation, it will be parsed to the correct type.
        +
        Returns:
        +
        True if the value was added, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        removeFromVariable

        +
        @Deprecated
+public boolean removeFromVariable​(java.lang.String property,
+                                  java.lang.String value)
        +
        Deprecated. +
        This is deprecated.
        +
        +
        Removes a value from the given property. The property must be a AddProperties.
        +
        +
        Specified by:
        +
        removeFromVariable in interface MultiverseWorld
        +
        Parameters:
        +
        property - The name of a AddProperties to remove a value + from.
        +
        value - A value in string representation, it will be parsed to the correct type.
        +
        Returns:
        +
        True if the value was removed, false if not.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        setPropertyValue

        +
        public boolean setPropertyValue​(java.lang.String property,
+                                java.lang.String value)
+                         throws PropertyDoesNotExistException
        +
        Sets a property to a given value.
        +
        +
        Specified by:
        +
        setPropertyValue in interface MultiverseWorld
        +
        Parameters:
        +
        property - The name of a world property to set.
        +
        value - A value in string representation, it will be parsed to the correct type.
        +
        Returns:
        +
        True if the value was set, false if not.
        +
        Throws:
        +
        PropertyDoesNotExistException - Thrown if the property was not found in the world.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        getWorldType

        +
        public org.bukkit.WorldType getWorldType()
        +
        Gets the type of this world. As of 1.2 this will be: + FLAT, NORMAL or VERSION_1_1 +

        + This is not the generator.

        +
        +
        Specified by:
        +
        getWorldType in interface MultiverseWorld
        +
        Returns:
        +
        The Type of this world.
        +
        +
        • +
      + + + +
        +
      • +

        getEnvironment

        +
        public org.bukkit.World.Environment getEnvironment()
        +
        Gets the environment of this world.
        +
        +
        Specified by:
        +
        getEnvironment in interface MultiverseWorld
        +
        Returns:
        +
        A World.Environment.
        +
        +
        • +
      + + + +
        +
      • +

        setEnvironment

        +
        public void setEnvironment​(org.bukkit.World.Environment environment)
        +
        Sets the environment of a world. +

        + Note: This will ONLY take effect once the world is unloaded/reloaded.

        +
        +
        Specified by:
        +
        setEnvironment in interface MultiverseWorld
        +
        Parameters:
        +
        environment - A World.Environment.
        +
        +
        • +
      + + + +
        +
      • +

        getSeed

        +
        public long getSeed()
        +
        Gets the world seed of this world.
        +
        +
        Specified by:
        +
        getSeed in interface MultiverseWorld
        +
        Returns:
        +
        The Long version of the seed.
        +
        +
        • +
      + + + +
        +
      • +

        setSeed

        +
        public void setSeed​(long seed)
        +
        Sets the seed of this world.
        +
        +
        Specified by:
        +
        setSeed in interface MultiverseWorld
        +
        Parameters:
        +
        seed - A Long that is the seed.
        +
        +
        • +
      + + + +
        +
      • +

        getGenerator

        +
        public java.lang.String getGenerator()
        +
        Gets the generator of this world.
        +
        +
        Specified by:
        +
        getGenerator in interface MultiverseWorld
        +
        Returns:
        +
        The name of the generator.
        +
        +
        • +
      + + + +
        +
      • +

        setGenerator

        +
        public void setGenerator​(java.lang.String generator)
        +
        Sets the generator of this world.
        +
        +
        Specified by:
        +
        setGenerator in interface MultiverseWorld
        +
        Parameters:
        +
        generator - The new generator's name.
        +
        +
        • +
      + + + +
        +
      • +

        getPlayerLimit

        +
        public int getPlayerLimit()
        +
        Gets the player limit for this world after which players without an override + permission node will not be allowed in. A value of -1 or less signifies no limit
        +
        +
        Specified by:
        +
        getPlayerLimit in interface MultiverseWorld
        +
        Returns:
        +
        The player limit
        +
        +
        • +
      + + + +
        +
      • +

        setPlayerLimit

        +
        public void setPlayerLimit​(int limit)
        +
        Sets the player limit for this world after which players without an override + permission node will not be allowed in. A value of -1 or less signifies no limit
        +
        +
        Specified by:
        +
        setPlayerLimit in interface MultiverseWorld
        +
        Parameters:
        +
        limit - The new limit
        +
        +
        • +
      + + + +
        +
      • +

        getName

        +
        public java.lang.String getName()
        +
        Gets the name of this world. The name cannot be changed. +

        + Note for plugin developers: Usually MultiverseWorld.getAlias() + is what you want to use instead of this method.

        +
        +
        Specified by:
        +
        getName in interface MultiverseWorld
        +
        Returns:
        +
        The name of the world as a String.
        +
        +
        • +
      + + + +
        +
      • +

        getPermissibleName

        +
        public java.lang.String getPermissibleName()
        +
        Gets the lowercased name of the world. This method is required, since the permissables + lowercase all permissions when recalculating. +

        + Note: This also means if a user has worlds named: world and WORLD, that they can both + exist, and both be teleported to independently, but their permissions **cannot** be + uniqueified at this time. See bug report #.

        +
        +
        Specified by:
        +
        getPermissibleName in interface MultiverseWorld
        +
        Returns:
        +
        The lowercased name of the world.
        +
        +
        • +
      + + + +
        +
      • +

        getAlias

        +
        public java.lang.String getAlias()
        +
        Gets the alias of this world. +

        + This alias allows users to have a world named "world" but show up in the list as "FernIsland"

        +
        +
        Specified by:
        +
        getAlias in interface MultiverseWorld
        +
        Returns:
        +
        The alias of the world as a String.
        +
        +
        • +
      + + + +
        +
      • +

        setAlias

        +
        public void setAlias​(java.lang.String alias)
        +
        Sets the alias of the world.
        +
        +
        Specified by:
        +
        setAlias in interface MultiverseWorld
        +
        Parameters:
        +
        alias - A string that is the new alias.
        +
        +
        • +
      + + + +
        +
      • +

        canAnimalsSpawn

        +
        public boolean canAnimalsSpawn()
        +
        Gets whether or not animals are allowed to spawn in this world.
        +
        +
        Specified by:
        +
        canAnimalsSpawn in interface MultiverseWorld
        +
        Returns:
        +
        True if ANY animal can, false if no animals can spawn.
        +
        +
        • +
      + + + +
        +
      • +

        setAllowAnimalSpawn

        +
        public void setAllowAnimalSpawn​(boolean animals)
        +
        Sets whether or not animals can spawn. + If there are values in MultiverseWorld.getAnimalList() and this is false, + those animals become the exceptions, and will spawn
        +
        +
        Specified by:
        +
        setAllowAnimalSpawn in interface MultiverseWorld
        +
        Parameters:
        +
        animals - True to allow spawning of monsters, false to prevent.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        canMonstersSpawn

        +
        public boolean canMonstersSpawn()
        +
        Gets whether or not monsters are allowed to spawn in this world.
        +
        +
        Specified by:
        +
        canMonstersSpawn in interface MultiverseWorld
        +
        Returns:
        +
        True if ANY monster can, false if no monsters can spawn.
        +
        +
        • +
      + + + +
        +
      • +

        setAllowMonsterSpawn

        +
        public void setAllowMonsterSpawn​(boolean monsters)
        +
        Sets whether or not monsters can spawn. + If there are values in MultiverseWorld.getMonsterList() and this is false, + those monsters become the exceptions, and will spawn
        +
        +
        Specified by:
        +
        setAllowMonsterSpawn in interface MultiverseWorld
        +
        Parameters:
        +
        monsters - True to allow spawning of monsters, false to prevent.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        isPVPEnabled

        +
        public boolean isPVPEnabled()
        +
        Gets whether or not PVP is enabled in this world in some form (fake or not).
        +
        +
        Specified by:
        +
        isPVPEnabled in interface MultiverseWorld
        +
        Returns:
        +
        True if players can take damage from other players.
        +
        +
        • +
      + + + +
        +
      • +

        setPVPMode

        +
        public void setPVPMode​(boolean pvp)
        +
        Turn pvp on or off. This setting is used to set the world's PVP mode.
        +
        +
        Specified by:
        +
        setPVPMode in interface MultiverseWorld
        +
        Parameters:
        +
        pvp - True to enable PVP damage, false to disable it.
        +
        +
        • +
      + + + +
        +
      • +

        isHidden

        +
        public boolean isHidden()
        +
        Gets whether or not this world will display in chat, mvw and mvl regardless if a user has the + access permissions to go to this world.
        +
        +
        Specified by:
        +
        isHidden in interface MultiverseWorld
        +
        Returns:
        +
        True if the world will be hidden, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        setHidden

        +
        public void setHidden​(boolean hidden)
        +
        Sets whether or not this world will display in chat, mvw and mvl regardless if a user has the + access permissions to go to this world.
        +
        +
        Specified by:
        +
        setHidden in interface MultiverseWorld
        +
        Parameters:
        +
        hidden - Set
        +
        +
        • +
      + + + +
        +
      • +

        getWorldBlacklist

        +
        public java.util.List<java.lang.String> getWorldBlacklist()
        +
        Gets a list of all the worlds that players CANNOT travel to from this world, + regardless of their access permissions.
        +
        +
        Specified by:
        +
        getWorldBlacklist in interface MultiverseWorld
        +
        Returns:
        +
        A List of world names.
        +
        +
        • +
      + + + +
        +
      • +

        getScaling

        +
        public double getScaling()
        +
        Gets the scaling value of this world.Really only has an effect if you use + Multiverse-NetherPortals.
        +
        +
        Specified by:
        +
        getScaling in interface MultiverseWorld
        +
        Returns:
        +
        This world's non-negative, non-zero scale.
        +
        +
        • +
      + + + +
        +
      • +

        setScaling

        +
        public boolean setScaling​(double scaling)
        +
        Sets the scale of this world. Really only has an effect if you use + Multiverse-NetherPortals.
        +
        +
        Specified by:
        +
        setScaling in interface MultiverseWorld
        +
        Parameters:
        +
        scaling - A scaling value, cannot be negative or 0.
        +
        Returns:
        +
        Whether the scale was set successfully.
        +
        +
        • +
      + + + +
        +
      • +

        setColor

        +
        public boolean setColor​(java.lang.String aliasColor)
        +
        Sets the color that this world's name/alias will display as.
        +
        +
        Specified by:
        +
        setColor in interface MultiverseWorld
        +
        Parameters:
        +
        aliasColor - A valid color name.
        +
        Returns:
        +
        True if the color was set, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        isValidAliasColor

        +
        @Deprecated
+public boolean isValidAliasColor​(java.lang.String aliasColor)
        +
        Deprecated. +
        This is deprecated.
        +
        +
        Tells you if someone entered a valid color.
        +
        +
        Specified by:
        +
        isValidAliasColor in interface MultiverseWorld
        +
        Parameters:
        +
        aliasColor - A string that may translate to a color.
        +
        Returns:
        +
        True if it is a color, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        getColor

        +
        public org.bukkit.ChatColor getColor()
        +
        Gets the color that this world's name/alias will display as.
        +
        +
        Specified by:
        +
        getColor in interface MultiverseWorld
        +
        Returns:
        +
        The color of this world.
        +
        +
        • +
      + + + +
        +
      • +

        getFakePVP

        +
        @Deprecated
+public boolean getFakePVP()
        +
        Deprecated. +
        This is deprecated.
        +
        +
        Turn pvp on or off. This setting is used to set the world's PVP mode, and thus relies on fakePVP
        +
        +
        Specified by:
        +
        getFakePVP in interface MultiverseWorld
        +
        Returns:
        +
        True if this world has fakepvp on
        +
        +
        • +
      + + + +
        +
      • +

        getRespawnToWorld

        +
        public org.bukkit.World getRespawnToWorld()
        +
        Gets the world players will respawn in if they die in this one.
        +
        +
        Specified by:
        +
        getRespawnToWorld in interface MultiverseWorld
        +
        Returns:
        +
        A world that exists on the server.
        +
        +
        • +
      + + + +
        +
      • +

        setRespawnToWorld

        +
        public boolean setRespawnToWorld​(java.lang.String respawnToWorld)
        +
        Sets the world players will respawn in if they die in this one. + Returns true upon success, false upon failure.
        +
        +
        Specified by:
        +
        setRespawnToWorld in interface MultiverseWorld
        +
        Parameters:
        +
        respawnToWorld - The name of a world that exists on the server.
        +
        Returns:
        +
        True if respawnWorld existed, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        getAccessPermission

        +
        public org.bukkit.permissions.Permission getAccessPermission()
        +
        Gets the permission required to enter this world.
        +
        +
        Specified by:
        +
        getAccessPermission in interface MultiverseWorld
        +
        Returns:
        +
        The permission required to be exempt from charges to/from this world.
        +
        +
        • +
      + + + +
        +
      • +

        getCurrency

        +
        public org.bukkit.Material getCurrency()
        +
        Gets the type of currency that will be used when users enter this world. A value of null indicates a non-item + based currency is used.
        +
        +
        Specified by:
        +
        getCurrency in interface MultiverseWorld
        +
        Returns:
        +
        The type of currency that will be used when users enter this world.
        +
        +
        • +
      + + + +
        +
      • +

        setCurrency

        +
        public void setCurrency​(@Nullable
+                        @Nullable org.bukkit.Material currency)
        +
        Sets the type of item that will be required given the price is not 0. + Use a value of null to specify a non-item based currency.
        +
        +
        Specified by:
        +
        setCurrency in interface MultiverseWorld
        +
        Parameters:
        +
        currency - The Type of currency that will be used when users enter this world.
        +
        +
        • +
      + + + +
        +
      • +

        getPrice

        +
        public double getPrice()
        +
        Gets the amount of currency it requires to enter this world.
        +
        +
        Specified by:
        +
        getPrice in interface MultiverseWorld
        +
        Returns:
        +
        The amount it costs to enter this world.
        +
        +
        • +
      + + + +
        +
      • +

        setPrice

        +
        public void setPrice​(double price)
        +
        Sets the price for entry to this world. + You can think of this like an amount. + The type can be set with MultiverseWorld.setCurrency(Material)
        +
        +
        Specified by:
        +
        setPrice in interface MultiverseWorld
        +
        Parameters:
        +
        price - The Amount of money/item to enter the world.
        +
        +
        • +
      + + + +
        +
      • +

        getExemptPermission

        +
        public org.bukkit.permissions.Permission getExemptPermission()
        +
        Gets the permission required to be exempt when entering.
        +
        +
        Specified by:
        +
        getExemptPermission in interface MultiverseWorld
        +
        Returns:
        +
        The permission required to be exempt when entering.
        +
        +
        • +
      + + + +
        +
      • +

        setGameMode

        +
        public boolean setGameMode​(java.lang.String mode)
        +
        Sets the game mode of this world.
        +
        +
        Specified by:
        +
        setGameMode in interface MultiverseWorld
        +
        Parameters:
        +
        mode - A valid game mode string (either + an int ex. 0 or a string ex. creative).
        +
        Returns:
        +
        True if the game mode was successfully changed, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        setGameMode

        +
        public boolean setGameMode​(org.bukkit.GameMode mode)
        +
        Description copied from interface: MultiverseWorld
        +
        Sets the game mode of this world.
        +
        +
        Specified by:
        +
        setGameMode in interface MultiverseWorld
        +
        Parameters:
        +
        mode - The new GameMode.
        +
        Returns:
        +
        True if the game mode was successfully changed, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        getGameMode

        +
        public org.bukkit.GameMode getGameMode()
        +
        Gets the GameMode of this world.
        +
        +
        Specified by:
        +
        getGameMode in interface MultiverseWorld
        +
        Returns:
        +
        The GameMode of this world.
        +
        +
        • +
      + + + +
        +
      • +

        setEnableWeather

        +
        public void setEnableWeather​(boolean weather)
        +
        Sets whether or not there will be weather events in a given world. + If set to false, Multiverse will disable the weather in the world immediately.
        +
        +
        Specified by:
        +
        setEnableWeather in interface MultiverseWorld
        +
        Parameters:
        +
        weather - True if weather events should occur in a world, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        isWeatherEnabled

        +
        public boolean isWeatherEnabled()
        +
        Gets whether weather is enabled in this world.
        +
        +
        Specified by:
        +
        isWeatherEnabled in interface MultiverseWorld
        +
        Returns:
        +
        True if weather events will occur, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        isKeepingSpawnInMemory

        +
        public boolean isKeepingSpawnInMemory()
        +
        Gets whether or not CraftBukkit is keeping the chunks for this world in memory.
        +
        +
        Specified by:
        +
        isKeepingSpawnInMemory in interface MultiverseWorld
        +
        Returns:
        +
        True if CraftBukkit is keeping spawn chunks in memory.
        +
        +
        • +
      + + + +
        +
      • +

        setKeepSpawnInMemory

        +
        public void setKeepSpawnInMemory​(boolean value)
        +
        If true, tells Craftbukkit to keep a worlds spawn chunks loaded in memory (default: true) + If not, CraftBukkit will attempt to free memory when players have not used that world. + This will not happen immediately.
        +
        +
        Specified by:
        +
        setKeepSpawnInMemory in interface MultiverseWorld
        +
        Parameters:
        +
        value - If true, CraftBukkit will keep the spawn chunks loaded in memory.
        +
        +
        • +
      + + + +
        +
      • +

        getHunger

        +
        public boolean getHunger()
        +
        Gets whether or not the hunger level of players will go down in a world.
        +
        +
        Specified by:
        +
        getHunger in interface MultiverseWorld
        +
        Returns:
        +
        True if it will go down, false if it will remain steady.
        +
        +
        • +
      + + + +
        +
      • +

        setHunger

        +
        public void setHunger​(boolean hunger)
        +
        Sets whether or not the hunger level of players will go down in a world.
        +
        +
        Specified by:
        +
        setHunger in interface MultiverseWorld
        +
        Parameters:
        +
        hunger - True if hunger will go down, false to keep it at + the level they entered a world with.
        +
        +
        • +
      + + + +
        +
      • +

        getSpawnLocation

        +
        public org.bukkit.Location getSpawnLocation()
        +
        Gets the spawn location of this world.
        +
        +
        Specified by:
        +
        getSpawnLocation in interface MultiverseWorld
        +
        Returns:
        +
        The spawn location of this world.
        +
        +
        • +
      + + + +
        +
      • +

        setSpawnLocation

        +
        public void setSpawnLocation​(org.bukkit.Location l)
        +
        Sets the spawn location for a world.
        +
        +
        Specified by:
        +
        setSpawnLocation in interface MultiverseWorld
        +
        Parameters:
        +
        l - The spawn location for a world.
        +
        +
        • +
      + + + +
        +
      • +

        getDifficulty

        +
        public org.bukkit.Difficulty getDifficulty()
        +
        Gets the difficulty of this world.
        +
        +
        Specified by:
        +
        getDifficulty in interface MultiverseWorld
        +
        Returns:
        +
        The difficulty of this world.
        +
        +
        • +
      + + + +
        +
      • +

        setDifficulty

        +
        @Deprecated
+public boolean setDifficulty​(java.lang.String difficulty)
        +
        Deprecated. +
        This is deprecated.
        +
        +
        Sets the difficulty of this world and returns true if success. + Valid string values are either an integer of difficulty(0-3) or + the name that resides in the Bukkit enum, ex. PEACEFUL
        +
        +
        Specified by:
        +
        setDifficulty in interface MultiverseWorld
        +
        Parameters:
        +
        difficulty - The difficulty to set the world to as a string.
        +
        Returns:
        +
        True if success, false if the provided string + could not be translated to a difficulty.
        +
        +
        • +
      + + + +
        +
      • +

        setDifficulty

        +
        public boolean setDifficulty​(org.bukkit.Difficulty difficulty)
        +
        Description copied from interface: MultiverseWorld
        +
        Sets the difficulty of this world and returns true on success. + Valid string values are either an integer of difficulty(0-3) or + the name that resides in the Bukkit enum, ex. PEACEFUL
        +
        +
        Specified by:
        +
        setDifficulty in interface MultiverseWorld
        +
        Parameters:
        +
        difficulty - The new difficulty.
        +
        Returns:
        +
        True if success, false if the operation failed... for whatever reason.
        +
        +
        • +
      + + + +
        +
      • +

        getAutoHeal

        +
        public boolean getAutoHeal()
        +
        Gets whether or not a world will auto-heal players if the difficulty is on peaceful.
        +
        +
        Specified by:
        +
        getAutoHeal in interface MultiverseWorld
        +
        Returns:
        +
        True if the world should heal (default), false if not.
        +
        +
        • +
      + + + +
        +
      • +

        setAutoHeal

        +
        public void setAutoHeal​(boolean heal)
        +
        Sets whether or not a world will auto-heal players if the difficulty is on peaceful.
        +
        +
        Specified by:
        +
        setAutoHeal in interface MultiverseWorld
        +
        Parameters:
        +
        heal - True if the world will heal.
        +
        +
        • +
      + + + +
        +
      • +

        setAdjustSpawn

        +
        public void setAdjustSpawn​(boolean adjust)
        +
        Sets whether or not Multiverse should auto-adjust the spawn for this world.
        +
        +
        Specified by:
        +
        setAdjustSpawn in interface MultiverseWorld
        +
        Parameters:
        +
        adjust - True if multiverse should adjust the spawn, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        getAdjustSpawn

        +
        public boolean getAdjustSpawn()
        +
        Gets whether or not Multiverse should auto-adjust the spawn for this world.
        +
        +
        Specified by:
        +
        getAdjustSpawn in interface MultiverseWorld
        +
        Returns:
        +
        True if Multiverse should adjust the spawn, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        setAutoLoad

        +
        public void setAutoLoad​(boolean load)
        +
        Sets whether or not Multiverse should auto-load this world. +

        + True is default.

        +
        +
        Specified by:
        +
        setAutoLoad in interface MultiverseWorld
        +
        Parameters:
        +
        load - True if multiverse should autoload this world the spawn, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        getAutoLoad

        +
        public boolean getAutoLoad()
        +
        Gets whether or not Multiverse should auto-load this world.
        +
        +
        Specified by:
        +
        getAutoLoad in interface MultiverseWorld
        +
        Returns:
        +
        True if Multiverse should auto-load this world.
        +
        +
        • +
      + + + +
        +
      • +

        setBedRespawn

        +
        public void setBedRespawn​(boolean respawn)
        +
        Sets whether or not a player who dies in this world will respawn in their + bed or follow the normal respawn pattern. +

        + True is default.

        +
        +
        Specified by:
        +
        setBedRespawn in interface MultiverseWorld
        +
        Parameters:
        +
        respawn - True if players dying in this world respawn at their bed.
        +
        +
        • +
      + + + +
        +
      • +

        getBedRespawn

        +
        public boolean getBedRespawn()
        +
        Gets whether or not a player who dies in this world will respawn in their + bed or follow the normal respawn pattern.
        +
        +
        Specified by:
        +
        getBedRespawn in interface MultiverseWorld
        +
        Returns:
        +
        True if players dying in this world should respawn at their bed.
        +
        +
        • +
      + + + +
        +
      • +

        getAllPropertyNames

        +
        public java.lang.String getAllPropertyNames()
        +
        Gets all the names of all properties that can be SET.
        +
        +
        Specified by:
        +
        getAllPropertyNames in interface MultiverseWorld
        +
        Returns:
        +
        All property names, with alternating colors.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        setTime

        +
        public boolean setTime​(java.lang.String timeAsString)
        +
        Sets the current time in a world. +

        + This method will take the following formats: + 11:37am + 4:30p + day(morning), night, noon, midnight

        +
        +
        Specified by:
        +
        setTime in interface MultiverseWorld
        +
        Parameters:
        +
        timeAsString - The formatted time to set the world to.
        +
        Returns:
        +
        True if the time was set, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        getAllowedPortals

        +
        public AllowedPortalType getAllowedPortals()
        +
        Gets which type(s) of portals are allowed to be constructed in this world.
        +
        +
        Specified by:
        +
        getAllowedPortals in interface MultiverseWorld
        +
        Returns:
        +
        The type of portals that are allowed.
        +
        +
        • +
      + + + +
        +
      • +

        allowPortalMaking

        +
        public void allowPortalMaking​(AllowedPortalType portalType)
        +
        Sets The types of portals that are allowed in this world.
        +
        +
        Specified by:
        +
        allowPortalMaking in interface MultiverseWorld
        +
        Parameters:
        +
        portalType - The type of portals allowed in this world.
        +
        +
        • +
      + + + +
        +
      • +

        getStyle

        +
        public org.bukkit.ChatColor getStyle()
        +
        Gets the style that this world's name/alias will display as.
        +
        +
        Specified by:
        +
        getStyle in interface MultiverseWorld
        +
        Returns:
        +
        The style of this world. null for "normal" style.
        +
        +
        • +
      + + + +
        +
      • +

        setStyle

        +
        public boolean setStyle​(java.lang.String style)
        +
        Sets the style that this world's name/alias will display as.
        +
        +
        Specified by:
        +
        setStyle in interface MultiverseWorld
        +
        Parameters:
        +
        style - A valid style name.
        +
        Returns:
        +
        True if the style was set, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        getAllowFlight

        +
        public boolean getAllowFlight()
        +
        Whether or not players are allowed to fly in this world.
        +
        +
        Specified by:
        +
        getAllowFlight in interface MultiverseWorld
        +
        Returns:
        +
        True if players allowed to fly in this world.
        +
        +
        • +
      + + + +
        +
      • +

        setAllowFlight

        +
        public void setAllowFlight​(boolean allowFlight)
        +
        Sets whether or not players are allowed to fly in this world.
        +
        +
        Specified by:
        +
        setAllowFlight in interface MultiverseWorld
        +
        Parameters:
        +
        allowFlight - True to allow flight in this world.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/MultiverseCore.html b/javadoc/latest/com/onarandombox/MultiverseCore/MultiverseCore.html new file mode 100644 index 000000000..bcf95e47a --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/MultiverseCore.html @@ -0,0 +1,1716 @@ + + + + + +MultiverseCore (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore
+

Class MultiverseCore

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • org.bukkit.plugin.PluginBase
      • +
    • +
        +
      • org.bukkit.plugin.java.JavaPlugin
        • +
      • +
          +
        • com.onarandombox.MultiverseCore.MultiverseCore
          • +
        +
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Core, LoggablePlugin, MVPlugin, org.bukkit.command.CommandExecutor, org.bukkit.command.TabCompleter, org.bukkit.command.TabExecutor, org.bukkit.plugin.Plugin
    +
    +
    +
    public class MultiverseCore
+extends org.bukkit.plugin.java.JavaPlugin
+implements MVPlugin, Core
    +
    The implementation of the Multiverse-Core.
    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MultiverseCore

        +
        public MultiverseCore()
        +
        • +
      + + + +
        +
      • +

        MultiverseCore

        +
        public MultiverseCore​(org.bukkit.plugin.java.JavaPluginLoader loader,
+                      org.bukkit.plugin.PluginDescriptionFile description,
+                      java.io.File dataFolder,
+                      java.io.File file)
        +
        This is for unit testing.
        +
        +
        Parameters:
        +
        loader - The PluginLoader to use.
        +
        description - The Description file to use.
        +
        dataFolder - The folder that other datafiles can be found in.
        +
        file - The location of the plugin.
        +
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getPlayerTeleporter

        +
        public static java.lang.String getPlayerTeleporter​(java.lang.String playerName)
        +
        This method is used to find out who is teleporting a player.
        +
        +
        Parameters:
        +
        playerName - The teleported player (the teleportee).
        +
        Returns:
        +
        The player that teleported the other one (the teleporter).
        +
        +
        • +
      + + + +
        +
      • +

        addPlayerToTeleportQueue

        +
        public static void addPlayerToTeleportQueue​(java.lang.String teleporter,
+                                            java.lang.String teleportee)
        +
        This method is used to add a teleportation to the teleportQueue.
        +
        +
        Parameters:
        +
        teleporter - The name of the player that initiated the teleportation.
        +
        teleportee - The name of the player that was teleported.
        +
        +
        • +
      + + + +
        +
      • +

        dumpVersionInfo

        +
        @Deprecated
+public java.lang.String dumpVersionInfo​(java.lang.String buffer)
        +
        Deprecated. +
        This is now deprecated, nobody needs it any longer. + All version info-dumping is now done with MVVersionEvent.
        +
        +
        Adds This plugin's version information to the buffer and returns the new string.
        +
        +
        Specified by:
        +
        dumpVersionInfo in interface MVPlugin
        +
        Parameters:
        +
        buffer - The string that contains Core and all other MV plugins' versions.
        +
        Returns:
        +
        A modified buffer that contains this MVPlugin's version information.
        +
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        getProtocolVersion

        +
        public int getProtocolVersion()
        +
        Description copied from interface: MVPlugin
        +
        Allows Multiverse or a plugin to query another Multiverse plugin to see what version its protocol is. This + number + should change when something will break the code.
        +
        +
        Specified by:
        +
        getProtocolVersion in interface MVPlugin
        +
        Returns:
        +
        The Integer protocol version.
        +
        +
        • +
      + + + +
        +
      • +

        onLoad

        +
        public void onLoad()
        +
        +
        Specified by:
        +
        onLoad in interface org.bukkit.plugin.Plugin
        +
        Overrides:
        +
        onLoad in class org.bukkit.plugin.java.JavaPlugin
        +
        +
        • +
      + + + +
        +
      • +

        getVaultHandler

        +
        @Deprecated
+public VaultHandler getVaultHandler()
        +
        Deprecated.
        +
        Description copied from interface: Core
        +
        Returns the Vault handler used by Multiverse. The returned object will have all methods necessary for + interfacing with Vault.
        +
        +
        Specified by:
        +
        getVaultHandler in interface Core
        +
        Returns:
        +
        the Vault handler for Multiverse.
        +
        +
        • +
      + + + +
        +
      • +

        getEconomist

        +
        public MVEconomist getEconomist()
        +
        Description copied from interface: Core
        +
        Retrieves Multiverse's friendly economist. The economist can be used for dealing with economies without + worrying about any of the messy details.
        +
        +
        Specified by:
        +
        getEconomist in interface Core
        +
        Returns:
        +
        the economy manager for Multiverse.
        +
        +
        • +
      + + + +
        +
      • +

        onEnable

        +
        public void onEnable()
        +
        +
        Specified by:
        +
        onEnable in interface org.bukkit.plugin.Plugin
        +
        Overrides:
        +
        onEnable in class org.bukkit.plugin.java.JavaPlugin
        +
        +
        • +
      + + + +
        +
      • +

        loadConfigs

        +
        public void loadConfigs()
        +
        Reloads the Multiverse Configuration files: + worlds.yml and config.yml.
        +
        +
        Specified by:
        +
        loadConfigs in interface Core
        +
        +
        • +
      + + + + + + + +
        +
      • +

        onDisable

        +
        public void onDisable()
        +
        +
        Specified by:
        +
        onDisable in interface org.bukkit.plugin.Plugin
        +
        Overrides:
        +
        onDisable in class org.bukkit.plugin.java.JavaPlugin
        +
        +
        • +
      + + + +
        +
      • +

        getPlayerSession

        +
        public MVPlayerSession getPlayerSession​(org.bukkit.entity.Player player)
        +
        Gets the MVPlayerSession for the given player. + This will also create a player session if one does not exist + for a player.
        +
        +
        Specified by:
        +
        getPlayerSession in interface Core
        +
        Parameters:
        +
        player - The player's session to grab.
        +
        Returns:
        +
        The corresponding MVPlayerSession.
        +
        +
        • +
      + + + +
        +
      • +

        getMVPerms

        +
        public MVPermissions getMVPerms()
        +
        Multiverse uses an advanced permissions setup, this object + simplifies getting/setting permissions.
        +
        +
        Specified by:
        +
        getMVPerms in interface Core
        +
        Returns:
        +
        A non-null MVPermissions.
        +
        +
        • +
      + + + +
        +
      • +

        onCommand

        +
        public boolean onCommand​(org.bukkit.command.CommandSender sender,
+                         org.bukkit.command.Command command,
+                         java.lang.String commandLabel,
+                         java.lang.String[] args)
        +
        +
        Specified by:
        +
        onCommand in interface org.bukkit.command.CommandExecutor
        +
        Overrides:
        +
        onCommand in class org.bukkit.plugin.java.JavaPlugin
        +
        +
        • +
      + + + +
        +
      • +

        log

        +
        @Deprecated
+public void log​(java.util.logging.Level level,
+                java.lang.String msg)
        +
        Deprecated. +
        This is now deprecated, nobody needs it any longer. + All logging is now done with Logging.
        +
        +
        Logs a message at the specified level.
        +
        +
        Specified by:
        +
        log in interface LoggablePlugin
        +
        Parameters:
        +
        level - The Log-Level.
        +
        msg - The message to log.
        +
        +
        • +
      + + + +
        +
      • +

        staticLog

        +
        @Deprecated
+public static void staticLog​(java.util.logging.Level level,
+                             java.lang.String msg)
        +
        Deprecated. +
        Replaced by Logging. Please refrain from using this from a third party plugin as the + messages will appear to originate from Multiverse-Core.
        +
        +
        Logs a message at the specified level.
        +
        +
        Parameters:
        +
        level - The Log-Level.
        +
        msg - The message to log.
        +
        +
        • +
      + + + +
        +
      • +

        staticDebugLog

        +
        @Deprecated
+public static void staticDebugLog​(java.util.logging.Level level,
+                                  java.lang.String msg)
        +
        Deprecated. +
        Replaced by Logging. Please refrain from using this from a third party plugin as the + messages will appear to originate from Multiverse-Core.
        +
        +
        Print messages to the Debug Log, if the servers in Debug Mode then we also want to print the messages to the + standard Server Console.
        +
        +
        Parameters:
        +
        level - The Log-Level
        +
        msg - The message
        +
        +
        • +
      + + + +
        +
      • +

        getAuthors

        +
        public java.lang.String getAuthors()
        +
        Parse the Authors Array into a readable String with ',' and 'and'.
        +
        +
        Specified by:
        +
        getAuthors in interface Core
        +
        Returns:
        +
        The readable authors-String
        +
        +
        • +
      + + + +
        +
      • +

        getCommandHandler

        +
        public com.pneumaticraft.commandhandler.CommandHandler getCommandHandler()
        +
        Multiverse uses CommandHandler to make adding and using commands + a piece of cake.
        +
        +
        Specified by:
        +
        getCommandHandler in interface Core
        +
        Returns:
        +
        A non-null CommandHandler.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        getTag

        +
        public java.lang.String getTag()
        +
        Gets the log-tag.
        +
        +
        Returns:
        +
        The log-tag
        +
        +
        • +
      + + + +
        +
      • +

        showNotMVWorldMessage

        +
        public void showNotMVWorldMessage​(org.bukkit.command.CommandSender sender,
+                                  java.lang.String worldName)
        +
        Shows a message that the given world is not a MultiverseWorld.
        +
        +
        Parameters:
        +
        sender - The CommandSender that should receive the message
        +
        worldName - The name of the invalid world
        +
        +
        • +
      + + + +
        +
      • +

        removePlayerSession

        +
        public void removePlayerSession​(org.bukkit.entity.Player player)
        +
        Removes a player-session.
        +
        +
        Parameters:
        +
        player - The Player that owned the session.
        +
        +
        • +
      + + + +
        +
      • +

        getPluginCount

        +
        public int getPluginCount()
        +
        Returns the number of plugins that have specifically hooked into core.
        +
        +
        Specified by:
        +
        getPluginCount in interface Core
        +
        Returns:
        +
        The number if plugins that have hooked into core.
        +
        +
        • +
      + + + +
        +
      • +

        incrementPluginCount

        +
        public void incrementPluginCount()
        +
        Increments the number of plugins that have specifically hooked into core.
        +
        +
        Specified by:
        +
        incrementPluginCount in interface Core
        +
        +
        • +
      + + + +
        +
      • +

        decrementPluginCount

        +
        public void decrementPluginCount()
        +
        Decrements the number of plugins that have specifically hooked into core.
        +
        +
        Specified by:
        +
        decrementPluginCount in interface Core
        +
        +
        • +
      + + + + + + + +
        +
      • +

        teleportPlayer

        +
        public void teleportPlayer​(org.bukkit.command.CommandSender teleporter,
+                           org.bukkit.entity.Player p,
+                           org.bukkit.Location l)
        +
        This is a convenience method to allow the QueuedCommand system to call it. You should NEVER call this directly.
        +
        +
        Parameters:
        +
        teleporter - The Person requesting that the teleport should happen.
        +
        p - Player The Person being teleported.
        +
        l - The potentially unsafe location.
        +
        +
        • +
      + + + +
        +
      • +

        getServerFolder

        +
        public java.io.File getServerFolder()
        +
        Gets the server's root-folder as File.
        +
        +
        Returns:
        +
        The server's root-folder
        +
        +
        • +
      + + + +
        +
      • +

        setServerFolder

        +
        public void setServerFolder​(java.io.File newServerFolder)
        +
        Sets this server's root-folder.
        +
        +
        Parameters:
        +
        newServerFolder - The new server-root
        +
        +
        • +
      + + + + + + + + + + + + + + + + + + + + + + + +
        +
      • +

        saveMVConfig

        +
        public boolean saveMVConfig()
        +
        Saves the Multiverse-Config.
        +
        +
        Returns:
        +
        Whether the Multiverse-Config was successfully saved
        +
        +
        • +
      + + + +
        +
      • +

        saveWorldConfig

        +
        public boolean saveWorldConfig()
        +
        Saves the world config.
        +
        +
        Returns:
        +
        Whether the world-config was successfully saved
        +
        +
        • +
      + + + +
        +
      • +

        saveMVConfigs

        +
        public boolean saveMVConfigs()
        +
        Saves all configs.
        +
        +
        Specified by:
        +
        saveMVConfigs in interface Core
        +
        Returns:
        +
        Whether the config was successfully saved
        +
        +
        • +
      + + + +
        +
      • +

        deleteWorld

        +
        public java.lang.Boolean deleteWorld​(java.lang.String name)
        +
        NOT deprecated for the time as queued commands use this. + However, this is not in the API and other plugins should therefore not use it.
        +
        +
        Parameters:
        +
        name - World to delete
        +
        Returns:
        +
        True if success, false if fail.
        +
        +
        • +
      + + + +
        +
      • +

        cloneWorld

        +
        public java.lang.Boolean cloneWorld​(java.lang.String oldName,
+                                    java.lang.String newName,
+                                    java.lang.String generator)
        +
        NOT deprecated for the time as queued commands use this. + However, this is not in the API and other plugins should therefore not use it.
        +
        +
        Parameters:
        +
        oldName - World to copy
        +
        newName - World to create
        +
        generator - The Custom generator plugin to use.
        +
        Returns:
        +
        True if success, false if fail.
        +
        +
        • +
      + + + +
        +
      • +

        regenWorld

        +
        @Deprecated
+public java.lang.Boolean regenWorld​(java.lang.String name,
+                                    java.lang.Boolean useNewSeed,
+                                    java.lang.Boolean randomSeed,
+                                    java.lang.String seed)
        +
        Deprecated. +
        This is deprecated! Do not use!
        +
        +
        Previously used by queued commands to regenerate a world on a delay. + Do not use api method for any other purpose.
        +
        +
        Specified by:
        +
        regenWorld in interface Core
        +
        Parameters:
        +
        name - Name of the world to regenerate
        +
        useNewSeed - If a new seed should be used
        +
        randomSeed - If the new seed should be random
        +
        seed - The seed of the world.
        +
        Returns:
        +
        True if success, false if fail.
        +
        +
        • +
      + + + +
        +
      • +

        regenWorld

        +
        @Deprecated
+public java.lang.Boolean regenWorld​(java.lang.String name,
+                                    java.lang.Boolean useNewSeed,
+                                    java.lang.Boolean randomSeed,
+                                    java.lang.String seed,
+                                    java.lang.Boolean keepGameRules)
        +
        Deprecated. +
        This is deprecated! Do not use!
        +
        +
        Used by queued commands to regenerate a world on a delay. + Do not use api method for any other purpose.
        +
        +
        Specified by:
        +
        regenWorld in interface Core
        +
        Parameters:
        +
        name - Name of the world to regenerate
        +
        useNewSeed - If a new seed should be used
        +
        randomSeed - If the new seed should be random
        +
        seed - The seed of the world.
        +
        keepGameRules - If GameRules should be kept on world regen.
        +
        Returns:
        +
        True if success, false if fail.
        +
        +
        • +
      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
      • +

        getStaticConfig

        +
        @Deprecated
+public static MultiverseCoreConfiguration getStaticConfig()
        +
        Deprecated. +
        This is deprecated.
        +
        +
        This method is currently used by other plugins. + It will be removed in 2.4
        +
        +
        Returns:
        +
        The Multiverse config.
        +
        +
        • +
      + + + +
        +
      • +

        getScriptAPI

        +
        public buscript.Buscript getScriptAPI()
        +
        Description copied from interface: Core
        +
        Gets the buscript object for Multiverse. This is what handles Javascript processing.
        +
        +
        Specified by:
        +
        getScriptAPI in interface Core
        +
        Returns:
        +
        The Multiverse buscript object.
        +
        +
        • +
      + + + + +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/MultiverseCoreConfiguration.html b/javadoc/latest/com/onarandombox/MultiverseCore/MultiverseCoreConfiguration.html new file mode 100644 index 000000000..e4e554487 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/MultiverseCoreConfiguration.html @@ -0,0 +1,1273 @@ + + + + + +MultiverseCoreConfiguration (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore
+

Class MultiverseCoreConfiguration

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • me.main__.util.SerializationConfig.SerializationConfig
      • +
    • +
        +
      • com.onarandombox.MultiverseCore.MultiverseCoreConfiguration
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    MultiverseCoreConfig, org.bukkit.configuration.serialization.ConfigurationSerializable
    +
    +
    +
    public class MultiverseCoreConfiguration
+extends me.main__.util.SerializationConfig.SerializationConfig
+implements MultiverseCoreConfig
    +
    Our configuration.
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      booleangetDisplayPermErrors() +
      Gets displayPermErrors.
      +
      booleangetEnableBuscript() +
      Gets enableBuscript.
      +
      booleangetEnforceAccess() +
      Gets enforceAccess.
      +
      booleangetFirstSpawnOverride() +
      Gets firstSpawnOverride.
      +
      java.lang.StringgetFirstSpawnWorld() +
      Gets firstSpawnWorld.
      +
      intgetGlobalDebug() +
      Gets globalDebug.
      +
      static MultiverseCoreConfigurationgetInstance() +
      Gets the statically saved instance.
      +
      intgetMessageCooldown() +
      Gets messageCooldown.
      +
      intgetPortalSearchRadius() +
      Gets the radius at which vanilla style portals will be searched for to connect to worlds together.
      +
      booleangetPrefixChat() +
      Gets prefixChat.
      +
      java.lang.StringgetPrefixChatFormat() +
      Gets prefixChatFormat.
      +
      booleangetSilentStart() +
      Whether we are suppressing startup messages.
      +
      intgetTeleportCooldown() +
      Gets portalCooldown.
      +
      booleangetTeleportIntercept() +
      Gets teleportIntercept.
      +
      booleangetUseAsyncChat() +
      Gets useasyncchat.
      +
      doublegetVersion() +
      Gets version.
      +
      booleanisAutoPurgeEnabled() +
      Gets whether or not the automatic purge of entities is enabled.
      +
      static booleanisSet() 
      booleanisShowingDonateMessage() +
      Gets whether or not the donation/patreon messages are shown.
      +
      booleanisUsingDefaultPortalSearch() +
      Gets whether or not Bukkit will be determining portal search radius on its own or if Multiverse should help.
      +
      voidsetAutoPurgeEnabled​(boolean autopurge) +
      Sets whether or not the automatic purge of entities is enabled.
      +
      booleansetConfigProperty​(java.lang.String property, + java.lang.String value) +
      Sets a property using a String.
      +
      protected voidsetDefaults()
      voidsetDisplayPermErrors​(boolean displayPermErrors) +
      Sets displayPermErrors.
      +
      voidsetEnableBuscript​(boolean enableBuscript) +
      Sets enableBuscript.
      +
      voidsetEnforceAccess​(boolean enforceAccess) +
      Sets enforceAccess.
      +
      voidsetFirstSpawnOverride​(boolean firstSpawnOverride) +
      Sets firstSpawnOverride.
      +
      voidsetFirstSpawnWorld​(java.lang.String firstSpawnWorld) +
      Sets firstSpawnWorld.
      +
      voidsetGlobalDebug​(int globalDebug) +
      Sets globalDebug.
      +
      static voidsetInstance​(MultiverseCoreConfiguration instance) +
      Sets the statically saved instance.
      +
      voidsetMessageCooldown​(int messageCooldown) +
      Sets messageCooldown.
      +
      voidsetPortalSearchRadius​(int searchRadius) +
      Sets the radius at which vanilla style portals will be searched for to connect to worlds together.
      +
      voidsetPrefixChat​(boolean prefixChat) +
      Sets prefixChat.
      +
      voidsetPrefixChatFormat​(java.lang.String prefixChatFormat) +
      Sets prefixChatFormat.
      +
      voidsetShowDonateMessage​(boolean showDonateMessage) +
      Sets whether or not the donation/patreon messages are shown.
      +
      voidsetSilentStart​(boolean silentStart) +
      Sets whether to suppress startup messages.
      +
      voidsetTeleportCooldown​(int teleportCooldown) +
      Sets portalCooldown.
      +
      voidsetTeleportIntercept​(boolean teleportIntercept) +
      Sets teleportIntercept.
      +
      voidsetUseAsyncChat​(boolean useAsyncChat) +
      Sets useasyncchat.
      +
      voidsetUseDefaultPortalSearch​(boolean useDefaultPortalSearch) +
      Sets whether or not to let Bukkit determine portal search radius on its own or if Multiverse should give input.
      +
      voidsetVersion​(int version) +
      Sets version.
      +
      +
        +
      • + + +

        Methods inherited from class me.main__.util.SerializationConfig.SerializationConfig

        +buildVPropChanges, copyValues, flushPendingVPropChanges, getAliasMap, getAliasMap, getProperty, getProperty, getPropertyDescription, getPropertyDescription, getPropertyDescriptionUnchecked, getPropertyDescriptionUnchecked, getPropertyUnchecked, getPropertyUnchecked, initLogging, loadValues, registerAlias, registerAlias, registerAll, registerGlobalValidator, registerObjectUsing, registerValidator, serialize, setProperty, setProperty, setPropertyUnchecked, setPropertyUnchecked, setPropertyValue, setPropertyValue, setPropertyValueUnchecked, setPropertyValueUnchecked, unregisterAll
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface org.bukkit.configuration.serialization.ConfigurationSerializable

        +serialize
        • +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MultiverseCoreConfiguration

        +
        public MultiverseCoreConfiguration()
        +
        • +
      + + + +
        +
      • +

        MultiverseCoreConfiguration

        +
        public MultiverseCoreConfiguration​(java.util.Map<java.lang.String,​java.lang.Object> values)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setInstance

        +
        public static void setInstance​(MultiverseCoreConfiguration instance)
        +
        Sets the statically saved instance.
        +
        +
        Parameters:
        +
        instance - The new instance.
        +
        +
        • +
      + + + +
        +
      • +

        isSet

        +
        public static boolean isSet()
        +
        +
        Returns:
        +
        True if the static instance of config is set.
        +
        +
        • +
      + + + +
        +
      • +

        getInstance

        +
        public static MultiverseCoreConfiguration getInstance()
        +
        Gets the statically saved instance.
        +
        +
        Returns:
        +
        The statically saved instance.
        +
        +
        • +
      + + + +
        +
      • +

        setDefaults

        +
        protected void setDefaults()
        +
        +
        Specified by:
        +
        setDefaults in class me.main__.util.SerializationConfig.SerializationConfig
        +
        +
        • +
      + + + +
        +
      • +

        setConfigProperty

        +
        public boolean setConfigProperty​(java.lang.String property,
+                                 java.lang.String value)
        +
        Sets a property using a String.
        +
        +
        Specified by:
        +
        setConfigProperty in interface MultiverseCoreConfig
        +
        Parameters:
        +
        property - The name of the property.
        +
        value - The value.
        +
        Returns:
        +
        True on success, false if the operation failed.
        +
        +
        • +
      + + + +
        +
      • +

        getEnforceAccess

        +
        public boolean getEnforceAccess()
        +
        Gets enforceAccess.
        +
        +
        Specified by:
        +
        getEnforceAccess in interface MultiverseCoreConfig
        +
        Returns:
        +
        enforceAccess.
        +
        +
        • +
      + + + +
        +
      • +

        setEnforceAccess

        +
        public void setEnforceAccess​(boolean enforceAccess)
        +
        Sets enforceAccess.
        +
        +
        Specified by:
        +
        setEnforceAccess in interface MultiverseCoreConfig
        +
        Parameters:
        +
        enforceAccess - The new value.
        +
        +
        • +
      + + + +
        +
      • +

        getPrefixChat

        +
        public boolean getPrefixChat()
        +
        Gets prefixChat.
        +
        +
        Specified by:
        +
        getPrefixChat in interface MultiverseCoreConfig
        +
        Returns:
        +
        prefixChat.
        +
        +
        • +
      + + + +
        +
      • +

        setPrefixChat

        +
        public void setPrefixChat​(boolean prefixChat)
        +
        Sets prefixChat.
        +
        +
        Specified by:
        +
        setPrefixChat in interface MultiverseCoreConfig
        +
        Parameters:
        +
        prefixChat - The new value.
        +
        +
        • +
      + + + +
        +
      • +

        getPrefixChatFormat

        +
        public java.lang.String getPrefixChatFormat()
        +
        Gets prefixChatFormat.
        +
        +
        Specified by:
        +
        getPrefixChatFormat in interface MultiverseCoreConfig
        +
        Returns:
        +
        prefixChatFormat.
        +
        +
        • +
      + + + +
        +
      • +

        setPrefixChatFormat

        +
        public void setPrefixChatFormat​(java.lang.String prefixChatFormat)
        +
        Sets prefixChatFormat.
        +
        +
        Specified by:
        +
        setPrefixChatFormat in interface MultiverseCoreConfig
        +
        Parameters:
        +
        prefixChatFormat - The new value.
        +
        +
        • +
      + + + +
        +
      • +

        getTeleportIntercept

        +
        public boolean getTeleportIntercept()
        +
        Gets teleportIntercept.
        +
        +
        Specified by:
        +
        getTeleportIntercept in interface MultiverseCoreConfig
        +
        Returns:
        +
        teleportIntercept.
        +
        +
        • +
      + + + +
        +
      • +

        setTeleportIntercept

        +
        public void setTeleportIntercept​(boolean teleportIntercept)
        +
        Sets teleportIntercept.
        +
        +
        Specified by:
        +
        setTeleportIntercept in interface MultiverseCoreConfig
        +
        Parameters:
        +
        teleportIntercept - The new value.
        +
        +
        • +
      + + + +
        +
      • +

        getFirstSpawnOverride

        +
        public boolean getFirstSpawnOverride()
        +
        Gets firstSpawnOverride.
        +
        +
        Specified by:
        +
        getFirstSpawnOverride in interface MultiverseCoreConfig
        +
        Returns:
        +
        firstSpawnOverride.
        +
        +
        • +
      + + + +
        +
      • +

        setFirstSpawnOverride

        +
        public void setFirstSpawnOverride​(boolean firstSpawnOverride)
        +
        Sets firstSpawnOverride.
        +
        +
        Specified by:
        +
        setFirstSpawnOverride in interface MultiverseCoreConfig
        +
        Parameters:
        +
        firstSpawnOverride - The new value.
        +
        +
        • +
      + + + +
        +
      • +

        getDisplayPermErrors

        +
        public boolean getDisplayPermErrors()
        +
        Gets displayPermErrors.
        +
        +
        Specified by:
        +
        getDisplayPermErrors in interface MultiverseCoreConfig
        +
        Returns:
        +
        displayPermErrors.
        +
        +
        • +
      + + + +
        +
      • +

        getEnableBuscript

        +
        public boolean getEnableBuscript()
        +
        Gets enableBuscript.
        +
        +
        Specified by:
        +
        getEnableBuscript in interface MultiverseCoreConfig
        +
        Returns:
        +
        enableBuscript.
        +
        +
        • +
      + + + +
        +
      • +

        setEnableBuscript

        +
        public void setEnableBuscript​(boolean enableBuscript)
        +
        Sets enableBuscript.
        +
        +
        Specified by:
        +
        setEnableBuscript in interface MultiverseCoreConfig
        +
        Parameters:
        +
        enableBuscript - The new value.
        +
        +
        • +
      + + + +
        +
      • +

        setDisplayPermErrors

        +
        public void setDisplayPermErrors​(boolean displayPermErrors)
        +
        Sets displayPermErrors.
        +
        +
        Specified by:
        +
        setDisplayPermErrors in interface MultiverseCoreConfig
        +
        Parameters:
        +
        displayPermErrors - The new value.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        setGlobalDebug

        +
        public void setGlobalDebug​(int globalDebug)
        +
        Sets globalDebug.
        +
        +
        Specified by:
        +
        setGlobalDebug in interface MultiverseCoreConfig
        +
        Parameters:
        +
        globalDebug - The new value.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        setMessageCooldown

        +
        public void setMessageCooldown​(int messageCooldown)
        +
        Sets messageCooldown.
        +
        +
        Specified by:
        +
        setMessageCooldown in interface MultiverseCoreConfig
        +
        Parameters:
        +
        messageCooldown - The new value.
        +
        +
        • +
      + + + +
        +
      • +

        getVersion

        +
        public double getVersion()
        +
        Gets version.
        +
        +
        Specified by:
        +
        getVersion in interface MultiverseCoreConfig
        +
        Returns:
        +
        version.
        +
        +
        • +
      + + + +
        +
      • +

        setVersion

        +
        public void setVersion​(int version)
        +
        Sets version.
        +
        +
        Specified by:
        +
        setVersion in interface MultiverseCoreConfig
        +
        Parameters:
        +
        version - The new value.
        +
        +
        • +
      + + + +
        +
      • +

        getFirstSpawnWorld

        +
        public java.lang.String getFirstSpawnWorld()
        +
        Gets firstSpawnWorld.
        +
        +
        Specified by:
        +
        getFirstSpawnWorld in interface MultiverseCoreConfig
        +
        Returns:
        +
        firstSpawnWorld.
        +
        +
        • +
      + + + +
        +
      • +

        setFirstSpawnWorld

        +
        public void setFirstSpawnWorld​(java.lang.String firstSpawnWorld)
        +
        Sets firstSpawnWorld.
        +
        +
        Specified by:
        +
        setFirstSpawnWorld in interface MultiverseCoreConfig
        +
        Parameters:
        +
        firstSpawnWorld - The new value.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        setTeleportCooldown

        +
        public void setTeleportCooldown​(int teleportCooldown)
        +
        Sets portalCooldown.
        +
        +
        Specified by:
        +
        setTeleportCooldown in interface MultiverseCoreConfig
        +
        Parameters:
        +
        teleportCooldown - The new value.
        +
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        setSilentStart

        +
        public void setSilentStart​(boolean silentStart)
        +
        Description copied from interface: MultiverseCoreConfig
        +
        Sets whether to suppress startup messages.
        +
        +
        Specified by:
        +
        setSilentStart in interface MultiverseCoreConfig
        +
        Parameters:
        +
        silentStart - true to suppress messages.
        +
        +
        • +
      + + + +
        +
      • +

        getSilentStart

        +
        public boolean getSilentStart()
        +
        Description copied from interface: MultiverseCoreConfig
        +
        Whether we are suppressing startup messages.
        +
        +
        Specified by:
        +
        getSilentStart in interface MultiverseCoreConfig
        +
        Returns:
        +
        true if we are suppressing startup messages.
        +
        +
        • +
      + + + +
        +
      • +

        setUseDefaultPortalSearch

        +
        public void setUseDefaultPortalSearch​(boolean useDefaultPortalSearch)
        +
        Description copied from interface: MultiverseCoreConfig
        +
        Sets whether or not to let Bukkit determine portal search radius on its own or if Multiverse should give input.
        +
        +
        Specified by:
        +
        setUseDefaultPortalSearch in interface MultiverseCoreConfig
        +
        Parameters:
        +
        useDefaultPortalSearch - True to let Bukkit determine portal search radius on its own.
        +
        +
        • +
      + + + +
        +
      • +

        isUsingDefaultPortalSearch

        +
        public boolean isUsingDefaultPortalSearch()
        +
        Description copied from interface: MultiverseCoreConfig
        +
        Gets whether or not Bukkit will be determining portal search radius on its own or if Multiverse should help.
        +
        +
        Specified by:
        +
        isUsingDefaultPortalSearch in interface MultiverseCoreConfig
        +
        Returns:
        +
        True means Bukkit will use its own default values.
        +
        +
        • +
      + + + +
        +
      • +

        setPortalSearchRadius

        +
        public void setPortalSearchRadius​(int searchRadius)
        +
        Description copied from interface: MultiverseCoreConfig
        +
        Sets the radius at which vanilla style portals will be searched for to connect to worlds together.
        +
        +
        Specified by:
        +
        setPortalSearchRadius in interface MultiverseCoreConfig
        +
        Parameters:
        +
        searchRadius - The portal search radius.
        +
        +
        • +
      + + + +
        +
      • +

        getPortalSearchRadius

        +
        public int getPortalSearchRadius()
        +
        Description copied from interface: MultiverseCoreConfig
        +
        Gets the radius at which vanilla style portals will be searched for to connect to worlds together.
        +
        +
        Specified by:
        +
        getPortalSearchRadius in interface MultiverseCoreConfig
        +
        Returns:
        +
        The portal search radius.
        +
        +
        • +
      + + + +
        +
      • +

        isAutoPurgeEnabled

        +
        public boolean isAutoPurgeEnabled()
        +
        Description copied from interface: MultiverseCoreConfig
        +
        Gets whether or not the automatic purge of entities is enabled.
        +
        +
        Specified by:
        +
        isAutoPurgeEnabled in interface MultiverseCoreConfig
        +
        Returns:
        +
        True if automatic purge is enabled.
        +
        +
        • +
      + + + +
        +
      • +

        setAutoPurgeEnabled

        +
        public void setAutoPurgeEnabled​(boolean autopurge)
        +
        Description copied from interface: MultiverseCoreConfig
        +
        Sets whether or not the automatic purge of entities is enabled.
        +
        +
        Specified by:
        +
        setAutoPurgeEnabled in interface MultiverseCoreConfig
        +
        Parameters:
        +
        autopurge - True if automatic purge should be enabled.
        +
        +
        • +
      + + + +
        +
      • +

        isShowingDonateMessage

        +
        public boolean isShowingDonateMessage()
        +
        Description copied from interface: MultiverseCoreConfig
        +
        Gets whether or not the donation/patreon messages are shown.
        +
        +
        Specified by:
        +
        isShowingDonateMessage in interface MultiverseCoreConfig
        +
        Returns:
        +
        True if donation/patreon messages should be shown.
        +
        +
        • +
      + + + +
        +
      • +

        setShowDonateMessage

        +
        public void setShowDonateMessage​(boolean showDonateMessage)
        +
        Description copied from interface: MultiverseCoreConfig
        +
        Sets whether or not the donation/patreon messages are shown.
        +
        +
        Specified by:
        +
        setShowDonateMessage in interface MultiverseCoreConfig
        +
        Parameters:
        +
        showDonateMessage - True if donation/patreon messages should be shown.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/WorldProperties.html b/javadoc/latest/com/onarandombox/MultiverseCore/WorldProperties.html new file mode 100644 index 000000000..994374102 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/WorldProperties.html @@ -0,0 +1,1323 @@ + + + + + +WorldProperties (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore
+

Class WorldProperties

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • me.main__.util.SerializationConfig.SerializationConfig
      • +
    • +
        +
      • com.onarandombox.MultiverseCore.WorldProperties
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    org.bukkit.configuration.serialization.ConfigurationSerializable
    +
    +
    +
    public class WorldProperties
+extends me.main__.util.SerializationConfig.SerializationConfig
    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        WorldProperties

        +
        public WorldProperties​(java.util.Map<java.lang.String,​java.lang.Object> values)
        +
        • +
      + + + +
        +
      • +

        WorldProperties

        +
        public WorldProperties()
        +
        • +
      + + + +
        +
      • +

        WorldProperties

        +
        public WorldProperties​(boolean fixSpawn,
+                       org.bukkit.World.Environment environment)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        copyValues

        +
        public void copyValues​(me.main__.util.SerializationConfig.SerializationConfig other)
        +
        +
        Overrides:
        +
        copyValues in class me.main__.util.SerializationConfig.SerializationConfig
        +
        +
        • +
      + + + +
        +
      • +

        cacheVirtualProperties

        +
        public void cacheVirtualProperties()
        +
        This prepares the MVWorld for unloading.
        +
        • +
      + + + +
        +
      • +

        setDefaults

        +
        protected void setDefaults()
        +
        +
        Specified by:
        +
        setDefaults in class me.main__.util.SerializationConfig.SerializationConfig
        +
        +
        • +
      + + + +
        +
      • +

        getAliases

        +
        protected static java.util.Map<java.lang.String,​java.lang.String> getAliases()
        +
        getAliases().
        +
        +
        Returns:
        +
        The alias-map.
        +
        See Also:
        +
        SerializationConfig
        +
        +
        • +
      + + + +
        +
      • +

        getAlias

        +
        public java.lang.String getAlias()
        +
        • +
      + + + +
        +
      • +

        setAlias

        +
        public void setAlias​(java.lang.String alias)
        +
        • +
      + + + +
        +
      • +

        getEnvironment

        +
        public org.bukkit.World.Environment getEnvironment()
        +
        • +
      + + + +
        +
      • +

        setEnvironment

        +
        public void setEnvironment​(org.bukkit.World.Environment environment)
        +
        • +
      + + + +
        +
      • +

        getSeed

        +
        public long getSeed()
        +
        • +
      + + + +
        +
      • +

        setSeed

        +
        public void setSeed​(long seed)
        +
        • +
      + + + +
        +
      • +

        getGenerator

        +
        public java.lang.String getGenerator()
        +
        • +
      + + + +
        +
      • +

        setGenerator

        +
        public void setGenerator​(java.lang.String generator)
        +
        • +
      + + + +
        +
      • +

        getPlayerLimit

        +
        public int getPlayerLimit()
        +
        • +
      + + + +
        +
      • +

        setPlayerLimit

        +
        public void setPlayerLimit​(int limit)
        +
        • +
      + + + +
        +
      • +

        canAnimalsSpawn

        +
        public boolean canAnimalsSpawn()
        +
        • +
      + + + +
        +
      • +

        setAllowAnimalSpawn

        +
        public void setAllowAnimalSpawn​(boolean animals)
        +
        • +
      + + + +
        +
      • +

        getAnimalList

        +
        public java.util.List<java.lang.String> getAnimalList()
        +
        • +
      + + + +
        +
      • +

        canMonstersSpawn

        +
        public boolean canMonstersSpawn()
        +
        • +
      + + + +
        +
      • +

        setAllowMonsterSpawn

        +
        public void setAllowMonsterSpawn​(boolean monsters)
        +
        • +
      + + + +
        +
      • +

        getAnimalSpawnRate

        +
        public int getAnimalSpawnRate()
        +
        • +
      + + + +
        +
      • +

        getMonsterSpawnRate

        +
        public int getMonsterSpawnRate()
        +
        • +
      + + + +
        +
      • +

        getMonsterList

        +
        public java.util.List<java.lang.String> getMonsterList()
        +
        • +
      + + + +
        +
      • +

        isPVPEnabled

        +
        public boolean isPVPEnabled()
        +
        • +
      + + + +
        +
      • +

        setPVPMode

        +
        public void setPVPMode​(boolean pvp)
        +
        • +
      + + + +
        +
      • +

        isHidden

        +
        public boolean isHidden()
        +
        • +
      + + + +
        +
      • +

        setHidden

        +
        public void setHidden​(boolean hidden)
        +
        • +
      + + + +
        +
      • +

        getWorldBlacklist

        +
        public java.util.List<java.lang.String> getWorldBlacklist()
        +
        • +
      + + + +
        +
      • +

        getScaling

        +
        public double getScaling()
        +
        • +
      + + + +
        +
      • +

        setScaling

        +
        public boolean setScaling​(double scaling)
        +
        • +
      + + + +
        +
      • +

        setColor

        +
        public boolean setColor​(java.lang.String aliasColor)
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        getRespawnToWorld

        +
        public java.lang.String getRespawnToWorld()
        +
        • +
      + + + +
        +
      • +

        setRespawnToWorld

        +
        public boolean setRespawnToWorld​(java.lang.String respawnToWorld)
        +
        • +
      + + + +
        +
      • +

        getCurrency

        +
        public org.bukkit.Material getCurrency()
        +
        • +
      + + + +
        +
      • +

        setCurrency

        +
        public void setCurrency​(@Nullable
+                        @Nullable org.bukkit.Material currency)
        +
        • +
      + + + +
        +
      • +

        getPrice

        +
        public double getPrice()
        +
        • +
      + + + +
        +
      • +

        setPrice

        +
        public void setPrice​(double price)
        +
        • +
      + + + +
        +
      • +

        setGameMode

        +
        public boolean setGameMode​(java.lang.String mode)
        +
        • +
      + + + +
        +
      • +

        setGameMode

        +
        public boolean setGameMode​(org.bukkit.GameMode mode)
        +
        • +
      + + + +
        +
      • +

        getGameMode

        +
        public org.bukkit.GameMode getGameMode()
        +
        • +
      + + + +
        +
      • +

        setEnableWeather

        +
        public void setEnableWeather​(boolean weather)
        +
        • +
      + + + +
        +
      • +

        isWeatherEnabled

        +
        public boolean isWeatherEnabled()
        +
        • +
      + + + +
        +
      • +

        isKeepingSpawnInMemory

        +
        public boolean isKeepingSpawnInMemory()
        +
        • +
      + + + +
        +
      • +

        setKeepSpawnInMemory

        +
        public void setKeepSpawnInMemory​(boolean value)
        +
        • +
      + + + +
        +
      • +

        getHunger

        +
        public boolean getHunger()
        +
        • +
      + + + +
        +
      • +

        setHunger

        +
        public void setHunger​(boolean hunger)
        +
        • +
      + + + +
        +
      • +

        getSpawnLocation

        +
        public org.bukkit.Location getSpawnLocation()
        +
        • +
      + + + +
        +
      • +

        setSpawnLocation

        +
        public void setSpawnLocation​(org.bukkit.Location l)
        +
        • +
      + + + +
        +
      • +

        getDifficulty

        +
        public org.bukkit.Difficulty getDifficulty()
        +
        • +
      + + + +
        +
      • +

        setDifficulty

        +
        @Deprecated
+public boolean setDifficulty​(java.lang.String difficulty)
        +
        Deprecated.
        +
        • +
      + + + +
        +
      • +

        setDifficulty

        +
        public boolean setDifficulty​(org.bukkit.Difficulty difficulty)
        +
        • +
      + + + +
        +
      • +

        getAutoHeal

        +
        public boolean getAutoHeal()
        +
        • +
      + + + +
        +
      • +

        setAutoHeal

        +
        public void setAutoHeal​(boolean heal)
        +
        • +
      + + + +
        +
      • +

        setAdjustSpawn

        +
        public void setAdjustSpawn​(boolean adjust)
        +
        • +
      + + + +
        +
      • +

        getAdjustSpawn

        +
        public boolean getAdjustSpawn()
        +
        • +
      + + + +
        +
      • +

        setAutoLoad

        +
        public void setAutoLoad​(boolean load)
        +
        • +
      + + + +
        +
      • +

        getAutoLoad

        +
        public boolean getAutoLoad()
        +
        • +
      + + + +
        +
      • +

        setBedRespawn

        +
        public void setBedRespawn​(boolean respawn)
        +
        • +
      + + + +
        +
      • +

        getBedRespawn

        +
        public boolean getBedRespawn()
        +
        • +
      + + + +
        +
      • +

        getAllPropertyNames

        +
        public java.lang.String getAllPropertyNames()
        +
        • +
      + + + +
        +
      • +

        getTime

        +
        public java.lang.String getTime()
        +
        • +
      + + + +
        +
      • +

        setTime

        +
        public boolean setTime​(java.lang.String timeAsString)
        +
        • +
      + + + + + + + +
        +
      • +

        allowPortalMaking

        +
        public void allowPortalMaking​(AllowedPortalType portalType)
        +
        • +
      + + + + + + + +
        +
      • +

        setStyle

        +
        public boolean setStyle​(java.lang.String style)
        +
        • +
      + + + +
        +
      • +

        getAllowFlight

        +
        public boolean getAllowFlight()
        +
        • +
      + + + +
        +
      • +

        setAllowFlight

        +
        public void setAllowFlight​(boolean allowFlight)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/api/BlockSafety.html b/javadoc/latest/com/onarandombox/MultiverseCore/api/BlockSafety.html new file mode 100644 index 000000000..ed49f7a89 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/api/BlockSafety.html @@ -0,0 +1,457 @@ + + + + + +BlockSafety (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.api
+

Interface BlockSafety

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    SimpleBlockSafety
    +
    +
    +
    public interface BlockSafety
    +
    Used to get block/location-related information.
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethodDescription
      booleancanSpawnCartSafely​(org.bukkit.entity.Minecart cart) +
      Checks if the specified Minecart can spawn safely.
      +
      booleancanSpawnVehicleSafely​(org.bukkit.entity.Vehicle vehicle) +
      Checks if the specified Vehicle can spawn safely.
      +
      org.bukkit.LocationgetBottomBlock​(org.bukkit.Location l) +
      Gets the location of the top block at the specified Location.
      +
      org.bukkit.LocationgetSafeBedSpawn​(org.bukkit.Location l) +
      Gets a safe bed spawn location OR null if the bed is invalid.
      +
      org.bukkit.LocationgetTopBlock​(org.bukkit.Location l) +
      Gets the location of the top block at the specified Location.
      +
      booleanisBlockAboveAir​(org.bukkit.Location l) +
      This function checks whether the block at the given coordinates are above air or not.
      +
      booleanisEntitiyOnTrack​(org.bukkit.Location l) +
      Checks if an entity would be on track at the specified Location.
      +
      booleanplayerCanSpawnHereSafely​(org.bukkit.Location l) +
      This function checks whether the block at the coordinates given is safe or not by checking for Lava/Fire/Air + etc.
      +
      booleanplayerCanSpawnHereSafely​(org.bukkit.World world, + double x, + double y, + double z) +
      Checks if a player can spawn safely at the given coordinates.
      +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        isBlockAboveAir

        +
        boolean isBlockAboveAir​(org.bukkit.Location l)
        +
        This function checks whether the block at the given coordinates are above air or not.
        +
        +
        Parameters:
        +
        l - The Location of the block.
        +
        Returns:
        +
        True if the block at that Location is above air.
        +
        +
        • +
      + + + +
        +
      • +

        playerCanSpawnHereSafely

        +
        boolean playerCanSpawnHereSafely​(org.bukkit.World world,
+                                 double x,
+                                 double y,
+                                 double z)
        +
        Checks if a player can spawn safely at the given coordinates.
        +
        +
        Parameters:
        +
        world - The World.
        +
        x - The x-coordinate.
        +
        y - The y-coordinate.
        +
        z - The z-coordinate.
        +
        Returns:
        +
        True if a player can spawn safely at the given coordinates.
        +
        +
        • +
      + + + +
        +
      • +

        playerCanSpawnHereSafely

        +
        boolean playerCanSpawnHereSafely​(org.bukkit.Location l)
        +
        This function checks whether the block at the coordinates given is safe or not by checking for Lava/Fire/Air + etc. This also ensures there is enough space for a player to spawn!
        +
        +
        Parameters:
        +
        l - The Location
        +
        Returns:
        +
        Whether the player can spawn safely at the given Location
        +
        +
        • +
      + + + +
        +
      • +

        getSafeBedSpawn

        +
        org.bukkit.Location getSafeBedSpawn​(org.bukkit.Location l)
        +
        Gets a safe bed spawn location OR null if the bed is invalid.
        +
        +
        Parameters:
        +
        l - The location of the bead head (block with the pillow on it).
        +
        Returns:
        +
        Safe location around the bed or null if no location was found.
        +
        +
        • +
      + + + +
        +
      • +

        getTopBlock

        +
        org.bukkit.Location getTopBlock​(org.bukkit.Location l)
        +
        Gets the location of the top block at the specified Location.
        +
        +
        Parameters:
        +
        l - Any Location.
        +
        Returns:
        +
        The Location of the top-block.
        +
        +
        • +
      + + + +
        +
      • +

        getBottomBlock

        +
        org.bukkit.Location getBottomBlock​(org.bukkit.Location l)
        +
        Gets the location of the top block at the specified Location.
        +
        +
        Parameters:
        +
        l - Any Location.
        +
        Returns:
        +
        The Location of the top-block.
        +
        +
        • +
      + + + +
        +
      • +

        isEntitiyOnTrack

        +
        boolean isEntitiyOnTrack​(org.bukkit.Location l)
        +
        Checks if an entity would be on track at the specified Location.
        +
        +
        Parameters:
        +
        l - The Location.
        +
        Returns:
        +
        True if an entity would be on tracks at the specified Location.
        +
        +
        • +
      + + + +
        +
      • +

        canSpawnCartSafely

        +
        boolean canSpawnCartSafely​(org.bukkit.entity.Minecart cart)
        +
        Checks if the specified Minecart can spawn safely.
        +
        +
        Parameters:
        +
        cart - The Minecart.
        +
        Returns:
        +
        True if the minecart can spawn safely.
        +
        +
        • +
      + + + +
        +
      • +

        canSpawnVehicleSafely

        +
        boolean canSpawnVehicleSafely​(org.bukkit.entity.Vehicle vehicle)
        +
        Checks if the specified Vehicle can spawn safely.
        +
        +
        Parameters:
        +
        vehicle - The Vehicle.
        +
        Returns:
        +
        True if the vehicle can spawn safely.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/api/Core.html b/javadoc/latest/com/onarandombox/MultiverseCore/api/Core.html new file mode 100644 index 000000000..fa3a3dad1 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/api/Core.html @@ -0,0 +1,859 @@ + + + + + +Core (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.api
+

Interface Core

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    MultiverseCore
    +
    +
    +
    public interface Core
    +
    Multiverse 2 Core API +

    + This API contains a bunch of useful things you can get out of Multiverse in general!

    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getVaultHandler

        +
        @Deprecated
+VaultHandler getVaultHandler()
        +
        Deprecated. +
        we are now using getEconomist() for all economy needs.
        +
        +
        Returns the Vault handler used by Multiverse. The returned object will have all methods necessary for + interfacing with Vault.
        +
        +
        Returns:
        +
        the Vault handler for Multiverse.
        +
        +
        • +
      + + + +
        +
      • +

        getEconomist

        +
        MVEconomist getEconomist()
        +
        Retrieves Multiverse's friendly economist. The economist can be used for dealing with economies without + worrying about any of the messy details.
        +
        +
        Returns:
        +
        the economy manager for Multiverse.
        +
        +
        • +
      + + + +
        +
      • +

        loadConfigs

        +
        void loadConfigs()
        +
        Reloads the Multiverse Configuration files: + worlds.yml and config.yml.
        +
        • +
      + + + +
        +
      • +

        getMessaging

        +
        MultiverseMessaging getMessaging()
        +
        Gets the Multiverse message system. This allows you to send messages + to users at specified intervals.
        +
        +
        Returns:
        +
        The loaded MultiverseMessaging.
        +
        +
        • +
      + + + +
        +
      • +

        getPlayerSession

        +
        MVPlayerSession getPlayerSession​(org.bukkit.entity.Player player)
        +
        Gets the MVPlayerSession for the given player. + This will also create a player session if one does not exist + for a player.
        +
        +
        Parameters:
        +
        player - The player's session to grab.
        +
        Returns:
        +
        The corresponding MVPlayerSession.
        +
        +
        • +
      + + + +
        +
      • +

        getMVPerms

        +
        MVPermissions getMVPerms()
        +
        Multiverse uses an advanced permissions setup, this object + simplifies getting/setting permissions.
        +
        +
        Returns:
        +
        A non-null MVPermissions.
        +
        +
        • +
      + + + +
        +
      • +

        getCommandHandler

        +
        com.pneumaticraft.commandhandler.CommandHandler getCommandHandler()
        +
        Multiverse uses CommandHandler to make adding and using commands + a piece of cake.
        +
        +
        Returns:
        +
        A non-null CommandHandler.
        +
        +
        • +
      + + + +
        +
      • +

        getCommandQueueManager

        +
        @Deprecated
+CommandQueueManager getCommandQueueManager()
        +
        Deprecated. +
        To be moved to new command manager in 5.0.0
        +
        +
        Manager for command that requires /mv confirm before execution.
        +
        +
        Returns:
        +
        A non-null CommandQueueManager.
        +
        +
        • +
      + + + +
        +
      • +

        getDestFactory

        +
        DestinationFactory getDestFactory()
        +
        Gets the factory class responsible for loading many different destinations + on demand.
        +
        +
        Returns:
        +
        A valid DestinationFactory.
        +
        +
        • +
      + + + +
        +
      • +

        getMVWorldManager

        +
        MVWorldManager getMVWorldManager()
        +
        Gets the primary class responsible for managing Multiverse Worlds.
        +
        +
        Returns:
        +
        MVWorldManager.
        +
        +
        • +
      + + + +
        +
      • +

        saveMVConfigs

        +
        boolean saveMVConfigs()
        +
        Saves all configs.
        +
        +
        Returns:
        +
        Whether the config was successfully saved
        +
        +
        • +
      + + + + + + + +
        +
      • +

        regenWorld

        +
        @Deprecated
+java.lang.Boolean regenWorld​(java.lang.String name,
+                             java.lang.Boolean useNewSeed,
+                             java.lang.Boolean randomSeed,
+                             java.lang.String seed)
        +
        Deprecated. +
        Use MVWorldManager.regenWorld(String, boolean, boolean, String, boolean) instead.
        +
        +
        Previously used by queued commands to regenerate a world on a delay. + Do not use api method for any other purpose.
        +
        +
        Parameters:
        +
        name - Name of the world to regenerate
        +
        useNewSeed - If a new seed should be used
        +
        randomSeed - If the new seed should be random
        +
        seed - The seed of the world.
        +
        Returns:
        +
        True if success, false if fail.
        +
        +
        • +
      + + + +
        +
      • +

        regenWorld

        +
        @Deprecated
+java.lang.Boolean regenWorld​(java.lang.String name,
+                             java.lang.Boolean useNewSeed,
+                             java.lang.Boolean randomSeed,
+                             java.lang.String seed,
+                             java.lang.Boolean keepGameRules)
        +
        Deprecated. +
        Use MVWorldManager.regenWorld(String, boolean, boolean, String, boolean) instead.
        +
        +
        Used by queued commands to regenerate a world on a delay. + Do not use api method for any other purpose.
        +
        +
        Parameters:
        +
        name - Name of the world to regenerate
        +
        useNewSeed - If a new seed should be used
        +
        randomSeed - If the new seed should be random
        +
        seed - The seed of the world.
        +
        keepGameRules - If GameRules should be kept on world regen.
        +
        Returns:
        +
        True if success, false if fail.
        +
        +
        • +
      + + + +
        +
      • +

        decrementPluginCount

        +
        void decrementPluginCount()
        +
        Decrements the number of plugins that have specifically hooked into core.
        +
        • +
      + + + +
        +
      • +

        incrementPluginCount

        +
        void incrementPluginCount()
        +
        Increments the number of plugins that have specifically hooked into core.
        +
        • +
      + + + +
        +
      • +

        getPluginCount

        +
        int getPluginCount()
        +
        Returns the number of plugins that have specifically hooked into core.
        +
        +
        Returns:
        +
        The number if plugins that have hooked into core.
        +
        +
        • +
      + + + +
        +
      • +

        getAuthors

        +
        java.lang.String getAuthors()
        +
        Parse the Authors Array into a readable String with ',' and 'and'.
        +
        +
        Returns:
        +
        The readable authors-String
        +
        +
        • +
      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
      • +

        getScriptAPI

        +
        buscript.Buscript getScriptAPI()
        +
        Gets the buscript object for Multiverse. This is what handles Javascript processing.
        +
        +
        Returns:
        +
        The Multiverse buscript object.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/api/FancyText.html b/javadoc/latest/com/onarandombox/MultiverseCore/api/FancyText.html new file mode 100644 index 000000000..5d5abb482 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/api/FancyText.html @@ -0,0 +1,260 @@ + + + + + +FancyText (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.api
+

Interface FancyText

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    FancyHeader, FancyMessage
    +
    +
    +
    public interface FancyText
    +
    A fancy text.
    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getFancyText

        +
        java.lang.String getFancyText()
        +
        Gets the String-representation of this FancyText.
        +
        +
        Returns:
        +
        The String-representation of this FancyText.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/api/LocationManipulation.html b/javadoc/latest/com/onarandombox/MultiverseCore/api/LocationManipulation.html new file mode 100644 index 000000000..f1636f926 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/api/LocationManipulation.html @@ -0,0 +1,480 @@ + + + + + +LocationManipulation (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.api
+

Interface LocationManipulation

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    SimpleLocationManipulation
    +
    +
    +
    public interface LocationManipulation
    +
    Used to manipulate locations.
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethodDescription
      org.bukkit.LocationgetBlockLocation​(org.bukkit.Location l) +
      This method simply does some rounding, rather than forcing a call to the server to get the blockdata.
      +
      java.lang.StringgetDirection​(org.bukkit.Location location) +
      Return the NESW Direction a Location is facing.
      +
      org.bukkit.LocationgetNextBlock​(org.bukkit.entity.Vehicle v) +
      Returns the next Location that a Vehicle is traveling at.
      +
      floatgetSpeed​(org.bukkit.util.Vector v) +
      Returns a speed float from a given vector.
      +
      org.bukkit.util.VectorgetTranslatedVector​(org.bukkit.util.Vector v, + java.lang.String direction) +
      Returns a translated vector from the given direction.
      +
      floatgetYaw​(java.lang.String orientation) +
      Returns the float yaw position for the given cardinal direction.
      +
      java.lang.StringlocationToString​(org.bukkit.Location location) +
      Convert a Location into a Colon separated string to allow us to store it in text.
      +
      java.lang.StringstrCoords​(org.bukkit.Location l) +
      Returns a colored string with the coords.
      +
      java.lang.StringstrCoordsRaw​(org.bukkit.Location l) +
      Converts a location to a printable readable formatted string including pitch/yaw.
      +
      org.bukkit.LocationstringToLocation​(java.lang.String locationString) +
      Returns a new location from a given string.
      +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        locationToString

        +
        java.lang.String locationToString​(org.bukkit.Location location)
        +
        Convert a Location into a Colon separated string to allow us to store it in text. +

        + WORLD:X,Y,Z:yaw:pitch +

        + The corresponding String2Loc function is stringToLocation(java.lang.String)

        +
        +
        Parameters:
        +
        location - The Location to save.
        +
        Returns:
        +
        The location as a string in this format: WORLD:x,y,z:yaw:pitch
        +
        +
        • +
      + + + +
        +
      • +

        getBlockLocation

        +
        org.bukkit.Location getBlockLocation​(org.bukkit.Location l)
        +
        This method simply does some rounding, rather than forcing a call to the server to get the blockdata.
        +
        +
        Parameters:
        +
        l - The location to round to the block location
        +
        Returns:
        +
        A rounded location.
        +
        +
        • +
      + + + +
        +
      • +

        stringToLocation

        +
        org.bukkit.Location stringToLocation​(java.lang.String locationString)
        +
        Returns a new location from a given string. The format is as follows: +

        + WORLD:X,Y,Z:yaw:pitch +

        + The corresponding Location2String function is stringToLocation(java.lang.String)

        +
        +
        Parameters:
        +
        locationString - The location represented as a string (WORLD:X,Y,Z:yaw:pitch)
        +
        Returns:
        +
        A new location defined by the string or null if the string was invalid.
        +
        +
        • +
      + + + +
        +
      • +

        strCoords

        +
        java.lang.String strCoords​(org.bukkit.Location l)
        +
        Returns a colored string with the coords.
        +
        +
        Parameters:
        +
        l - The Location
        +
        Returns:
        +
        The String
        +
        +
        • +
      + + + +
        +
      • +

        strCoordsRaw

        +
        java.lang.String strCoordsRaw​(org.bukkit.Location l)
        +
        Converts a location to a printable readable formatted string including pitch/yaw.
        +
        +
        Parameters:
        +
        l - The Location
        +
        Returns:
        +
        The String
        +
        +
        • +
      + + + +
        +
      • +

        getDirection

        +
        java.lang.String getDirection​(org.bukkit.Location location)
        +
        Return the NESW Direction a Location is facing.
        +
        +
        Parameters:
        +
        location - The Location
        +
        Returns:
        +
        The NESW Direction
        +
        +
        • +
      + + + +
        +
      • +

        getYaw

        +
        float getYaw​(java.lang.String orientation)
        +
        Returns the float yaw position for the given cardinal direction.
        +
        +
        Parameters:
        +
        orientation - The cardinal direction
        +
        Returns:
        +
        The yaw
        +
        +
        • +
      + + + +
        +
      • +

        getSpeed

        +
        float getSpeed​(org.bukkit.util.Vector v)
        +
        Returns a speed float from a given vector.
        +
        +
        Parameters:
        +
        v - The Vector
        +
        Returns:
        +
        The speed
        +
        +
        • +
      + + + +
        +
      • +

        getTranslatedVector

        +
        org.bukkit.util.Vector getTranslatedVector​(org.bukkit.util.Vector v,
+                                           java.lang.String direction)
        +
        Returns a translated vector from the given direction.
        +
        +
        Parameters:
        +
        v - The old Vector
        +
        direction - The new direction
        +
        Returns:
        +
        The translated Vector
        +
        +
        • +
      + + + +
        +
      • +

        getNextBlock

        +
        org.bukkit.Location getNextBlock​(org.bukkit.entity.Vehicle v)
        +
        Returns the next Location that a Vehicle is traveling at.
        +
        +
        Parameters:
        +
        v - The Vehicle
        +
        Returns:
        +
        The Location
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/api/LoggablePlugin.html b/javadoc/latest/com/onarandombox/MultiverseCore/api/LoggablePlugin.html new file mode 100644 index 000000000..bbfdac5d0 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/api/LoggablePlugin.html @@ -0,0 +1,296 @@ + + + + + +LoggablePlugin (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.api
+

Interface LoggablePlugin

+
+
+
+
    +
  • +
    +
    All Known Subinterfaces:
    +
    MVPlugin
    +
    +
    +
    All Known Implementing Classes:
    +
    MultiverseCore, MultiversePlugin
    +
    +
    +
    @Deprecated
+public interface LoggablePlugin
    +
    Deprecated. +
    Replaced by Logging.
    +
    +
    A simple API to require plugins to have a log method.
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and TypeMethodDescription
      org.bukkit.ServergetServer() +
      Deprecated.
      +
      Gets the server instance that this plugin is attached to.
      +
      voidlog​(java.util.logging.Level level, + java.lang.String msg) +
      Deprecated.
      +
      Logs a message at the specified level.
      +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        log

        +
        void log​(java.util.logging.Level level,
+         java.lang.String msg)
        +
        Deprecated.
        +
        Logs a message at the specified level.
        +
        +
        Parameters:
        +
        level - The Log-Level.
        +
        msg - The message to log.
        +
        +
        • +
      + + + +
        +
      • +

        getServer

        +
        org.bukkit.Server getServer()
        +
        Deprecated.
        +
        Gets the server instance that this plugin is attached to.
        +
        +
        Returns:
        +
        A Server instance.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/api/MVDestination.html b/javadoc/latest/com/onarandombox/MultiverseCore/api/MVDestination.html new file mode 100644 index 000000000..b8e58616e --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/api/MVDestination.html @@ -0,0 +1,523 @@ + + + + + +MVDestination (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.api
+

Interface MVDestination

+
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethodDescription
      java.lang.StringgetIdentifier() +
      Returns the identifier or prefix that is required for this destination.
      +
      org.bukkit.LocationgetLocation​(org.bukkit.entity.Entity entity) +
      Returns the location a specific entity will spawn at when being teleported to this Destination.
      +
      java.lang.StringgetName() +
      Gives you a specific name of the destination.
      +
      java.lang.StringgetRequiredPermission() +
      Returns the permissions string required to go here.
      +
      java.lang.StringgetType() +
      Gives you a general friendly description of the type of destination.
      +
      org.bukkit.util.VectorgetVelocity() +
      Returns the velocity vector for this destination.
      +
      booleanisThisType​(org.bukkit.plugin.java.JavaPlugin plugin, + java.lang.String destination) +
      Allows you to determine if a Destination is valid for the type it thinks it is.
      +
      booleanisValid() +
      Returns true if the destination is valid and players will be taken to it.
      +
      voidsetDestination​(org.bukkit.plugin.java.JavaPlugin plugin, + java.lang.String destination) +
      Sets the destination string.
      +
      java.lang.StringtoString() +
      Returns a string that can easily be saved in the config that contains all the details needed to rebuild this + destination.
      +
      booleanuseSafeTeleporter() +
      Should the Multiverse SafeTeleporter be used?
      +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getIdentifier

        +
        java.lang.String getIdentifier()
        +
        Returns the identifier or prefix that is required for this destination. +

        + Portals have a prefix of "p" for example and OpenWarp (third party plugin) uses "ow". This is derived from a + hash and cannot have duplicate values. Read that as your plugin cannot use 'p' because it's already used. + Please check the wiki when adding a custom destination!

        +
        +
        Returns:
        +
        The identifier or prefix that is required for this destination.
        +
        +
        • +
      + + + +
        +
      • +

        isThisType

        +
        boolean isThisType​(org.bukkit.plugin.java.JavaPlugin plugin,
+                   java.lang.String destination)
        +
        Allows you to determine if a Destination is valid for the type it thinks it is. +

        + An example of this would be the exact destination. A valid string would be: e:0,0,0 where an invalid one would + be e:1:2:3. The first string would return true the second would return false. This is simply a convenience + method + and does not even NEED to be called, but it's highly recommended if you're teleporting, but it's mainly for + Multiverse Internal use.

        +
        +
        Parameters:
        +
        plugin - The plugin who the type belongs to.
        +
        destination - The destination string. ex: p:MyPortal:nw
        +
        Returns:
        +
        True if the destination is valid, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        getLocation

        +
        org.bukkit.Location getLocation​(org.bukkit.entity.Entity entity)
        +
        Returns the location a specific entity will spawn at when being teleported to this Destination. +

        + To just retrieve the location as it is stored you can just pass null, but be warned some destinations may return + null back to you if you do this. It is always safer to pass an actual entity. This is used so things like + minecarts can be teleported. +

        + Do not forget to use getVelocity() as destinations can use this too!

        +
        +
        Parameters:
        +
        entity - The entity to be teleported.
        +
        Returns:
        +
        The location of the entity.
        +
        +
        • +
      + + + +
        +
      • +

        getVelocity

        +
        org.bukkit.util.Vector getVelocity()
        +
        Returns the velocity vector for this destination. +

        + Plugins wishing to fully support MVDestinations MUST implement this.

        +
        +
        Returns:
        +
        A vector representing the speed/direction the player should travel when arriving
        +
        +
        • +
      + + + +
        +
      • +

        setDestination

        +
        void setDestination​(org.bukkit.plugin.java.JavaPlugin plugin,
+                    java.lang.String destination)
        +
        Sets the destination string. +

        + This should be used when you want to tell this destination object about a change in where it should take people. + The destination param should be match the result from getIdentifier(). A valid example would be that if + getIdentifier() returned "ow" our destination string could be "ow:TownCenter" but could not be + "p:HomePortal"

        +
        +
        Parameters:
        +
        plugin - The plugin who the type belongs to.
        +
        destination - The destination string. ex: p:MyPortal:nw
        +
        +
        • +
      + + + +
        +
      • +

        isValid

        +
        boolean isValid()
        +
        Returns true if the destination is valid and players will be taken to it. +

        + Even if destinations are in the correct format (p:MyPortal) MyPortal may not exist, and therefore this would + return false.

        +
        +
        Returns:
        +
        True if the destination is valid; false if not.
        +
        +
        • +
      + + + +
        +
      • +

        getType

        +
        java.lang.String getType()
        +
        Gives you a general friendly description of the type of destination. +

        + For example, the PlayerDestination sets this to "Player". You can use this to show where a player will be taken.

        +
        +
        Returns:
        +
        A friendly string description of the type of destination.
        +
        +
        • +
      + + + +
        +
      • +

        getName

        +
        java.lang.String getName()
        +
        Gives you a specific name of the destination. +

        + For example, the PlayerDestination sets this to The Player's Name.

        +
        +
        Returns:
        +
        A friendly string stating the name of the destination.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        java.lang.String toString()
        +
        Returns a string that can easily be saved in the config that contains all the details needed to rebuild this + destination. +

        + ex: e:0,0,0:50:50

        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        Returns:
        +
        The savable config string.
        +
        +
        • +
      + + + +
        +
      • +

        getRequiredPermission

        +
        java.lang.String getRequiredPermission()
        +
        Returns the permissions string required to go here. +

        + ex: multiverse.access.world +

        + NOTE: This is NOT the permission to use the teleport command.

        +
        +
        Returns:
        +
        the permissions string required to go here.
        +
        +
        • +
      + + + +
        +
      • +

        useSafeTeleporter

        +
        boolean useSafeTeleporter()
        +
        Should the Multiverse SafeTeleporter be used? +

        + If not, MV will blindly take people to the location specified.

        +
        +
        Returns:
        +
        True if the SafeTeleporter will be used, false if not.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/api/MVPlugin.html b/javadoc/latest/com/onarandombox/MultiverseCore/api/MVPlugin.html new file mode 100644 index 000000000..c0edc299a --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/api/MVPlugin.html @@ -0,0 +1,346 @@ + + + + + +MVPlugin (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.api
+

Interface MVPlugin

+
+
+
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        dumpVersionInfo

        +
        @Deprecated
+java.lang.String dumpVersionInfo​(java.lang.String buffer)
        +
        Deprecated. +
        This is now deprecated, nobody needs it any longer. + All version info-dumping is now done with MVVersionEvent.
        +
        +
        Adds This plugin's version information to the buffer and returns the new string.
        +
        +
        Parameters:
        +
        buffer - The string that contains Core and all other MV plugins' versions.
        +
        Returns:
        +
        A modified buffer that contains this MVPlugin's version information.
        +
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        getProtocolVersion

        +
        int getProtocolVersion()
        +
        Allows Multiverse or a plugin to query another Multiverse plugin to see what version its protocol is. This + number + should change when something will break the code.
        +
        +
        Returns:
        +
        The Integer protocol version.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/api/MVWorldManager.html b/javadoc/latest/com/onarandombox/MultiverseCore/api/MVWorldManager.html new file mode 100644 index 000000000..5277deaa4 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/api/MVWorldManager.html @@ -0,0 +1,1154 @@ + + + + + +MVWorldManager (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.api
+

Interface MVWorldManager

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    WorldManager
    +
    +
    +
    public interface MVWorldManager
    +
    Multiverse 2 World Manager API +

    + This API contains all of the world managing + functions that your heart desires!

    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and TypeMethodDescription
      booleanaddWorld​(java.lang.String name, + org.bukkit.World.Environment env, + java.lang.String seedString, + org.bukkit.WorldType type, + java.lang.Boolean generateStructures, + java.lang.String generator) +
      Add a new World to the Multiverse Setup.
      +
      booleanaddWorld​(java.lang.String name, + org.bukkit.World.Environment env, + java.lang.String seedString, + org.bukkit.WorldType type, + java.lang.Boolean generateStructures, + java.lang.String generator, + boolean useSpawnAdjust) +
      Add a new World to the Multiverse Setup.
      +
      booleancloneWorld​(java.lang.String oldName, + java.lang.String newName) +
      Make a copy of a world.
      +
      booleancloneWorld​(java.lang.String oldName, + java.lang.String newName, + java.lang.String generator) +
      Deprecated. +
      Use cloneWorld(String, String) instead.
      +
      +
      booleandeleteWorld​(java.lang.String name) +
      Remove the world from the Multiverse list, from the config and deletes + the folder.
      +
      booleandeleteWorld​(java.lang.String name, + boolean removeConfig) +
      Remove the world from the Multiverse list, from the + config if wanted, and deletes the folder.
      +
      booleandeleteWorld​(java.lang.String name, + boolean removeFromConfig, + boolean deleteWorldFolder) 
      org.bukkit.generator.ChunkGeneratorgetChunkGenerator​(java.lang.String generator, + java.lang.String generatorID, + java.lang.String worldName) +
      Test if a given chunk generator is valid.
      +
      voidgetDefaultWorldGenerators() +
      This method populates an internal list and needs to be called after multiverse initialization.
      +
      MultiverseWorldgetFirstSpawnWorld() +
      Gets the world players should spawn in first.
      +
      MultiverseWorldgetMVWorld​(java.lang.String name) +
      Returns a MultiverseWorld if it exists, and null if it does not.
      +
      MultiverseWorldgetMVWorld​(java.lang.String name, + boolean checkAliases) +
      Returns a MultiverseWorld if the world with name given exists, and null if it does not.
      +
      MultiverseWorldgetMVWorld​(org.bukkit.World world) +
      Returns a MultiverseWorld if it exists, and null if it does not.
      +
      java.util.Collection<MultiverseWorld>getMVWorlds() +
      Returns a list of all the worlds Multiverse knows about.
      +
      java.util.Collection<java.lang.String>getPotentialWorlds() +
      Get all the possible worlds that Multiverse has detected to be importable.
      +
      MultiverseWorldgetSpawnWorld() +
      Gets the world players will spawn in on first join.
      +
      WorldPurgergetTheWorldPurger() +
      Gets the WorldPurger.
      +
      java.util.List<java.lang.String>getUnloadedWorlds() +
      Gets the list of worlds in the config, but unloaded.
      +
      PurgeWorldsgetWorldPurger() +
      Deprecated. +
      PurgeWorlds is deprecated!
      +
      +
      booleanhasUnloadedWorld​(java.lang.String name, + boolean includeLoaded) +
      Checks whether Multiverse knows about a provided unloaded world.
      +
      booleanisKeepingSpawnInMemory​(org.bukkit.World world) 
      booleanisMVWorld​(java.lang.String name) +
      Checks to see if the given name is a valid MultiverseWorld + Searches based on world name AND alias.
      +
      booleanisMVWorld​(java.lang.String name, + boolean checkAliases) +
      Checks to see if the given name is a valid MultiverseWorld.
      +
      booleanisMVWorld​(org.bukkit.World world) +
      Checks to see if the given world is a valid MultiverseWorld.
      +
      voidloadDefaultWorlds() +
      Loads the Worlds & Settings for any worlds that bukkit loaded before us.
      +
      booleanloadWorld​(java.lang.String name) +
      Loads the world.
      +
      org.bukkit.configuration.file.FileConfigurationloadWorldConfig​(java.io.File file) +
      Load the config from a file.
      +
      voidloadWorlds​(boolean forceLoad) +
      Load the Worlds & Settings from the configuration file.
      +
      booleanregenWorld​(java.lang.String name, + boolean useNewSeed, + boolean randomSeed, + java.lang.String seed) +
      Regenerates a world.
      +
      booleanregenWorld​(java.lang.String name, + boolean useNewSeed, + boolean randomSeed, + java.lang.String seed, + boolean keepGameRules) +
      Regenerates a world.
      +
      voidremovePlayersFromWorld​(java.lang.String name) +
      Removes all players from the specified world.
      +
      booleanremoveWorldFromConfig​(java.lang.String name) +
      Remove the world from the Multiverse list and from the config.
      +
      booleansaveWorldsConfig() +
      Saves the world config to disk.
      +
      voidsetFirstSpawnWorld​(java.lang.String world) +
      Sets the initial spawn world for new players.
      +
      booleanunloadWorld​(java.lang.String name) +
      Unload a world from Multiverse.
      +
      booleanunloadWorld​(java.lang.String name, + boolean unloadBukkit) +
      Unload a world from Multiverse with option to prevent calling unloadWorld in Bukkit.
      +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        addWorld

        +
        boolean addWorld​(java.lang.String name,
+                 org.bukkit.World.Environment env,
+                 java.lang.String seedString,
+                 org.bukkit.WorldType type,
+                 java.lang.Boolean generateStructures,
+                 java.lang.String generator)
        +
        Add a new World to the Multiverse Setup.
        +
        +
        Parameters:
        +
        name - World Name
        +
        env - Environment Type
        +
        seedString - The seed in the form of a string. + If the seed is a Long, + it will be interpreted as such.
        +
        type - The Type of the world to be made.
        +
        generateStructures - If true, this world will get NPC villages.
        +
        generator - The Custom generator plugin to use.
        +
        Returns:
        +
        True if the world is added, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        addWorld

        +
        boolean addWorld​(java.lang.String name,
+                 org.bukkit.World.Environment env,
+                 java.lang.String seedString,
+                 org.bukkit.WorldType type,
+                 java.lang.Boolean generateStructures,
+                 java.lang.String generator,
+                 boolean useSpawnAdjust)
        +
        Add a new World to the Multiverse Setup.
        +
        +
        Parameters:
        +
        name - World Name
        +
        env - Environment Type
        +
        seedString - The seed in the form of a string. + If the seed is a Long, + it will be interpreted as such.
        +
        type - The Type of the world to be made.
        +
        generateStructures - If true, this world will get NPC villages.
        +
        generator - The Custom generator plugin to use.
        +
        useSpawnAdjust - If true, multiverse will search for a safe spawn. If not, It will not modify the level.dat.
        +
        Returns:
        +
        True if the world is added, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        cloneWorld

        +
        @Deprecated
+boolean cloneWorld​(java.lang.String oldName,
+                   java.lang.String newName,
+                   java.lang.String generator)
        +
        Deprecated. +
        Use cloneWorld(String, String) instead.
        +
        +
        Make a copy of a world.
        +
        +
        Parameters:
        +
        oldName - Name of world to be copied
        +
        newName - Name of world to be created
        +
        generator - The Custom generator plugin to use. Ignored.
        +
        Returns:
        +
        True if the world is copied successfully, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        cloneWorld

        +
        boolean cloneWorld​(java.lang.String oldName,
+                   java.lang.String newName)
        +
        Make a copy of a world.
        +
        +
        Parameters:
        +
        oldName - Name of world to be copied
        +
        newName - Name of world to be created
        +
        Returns:
        +
        True if the world is copied successfully, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        deleteWorld

        +
        boolean deleteWorld​(java.lang.String name)
        +
        Remove the world from the Multiverse list, from the config and deletes + the folder.
        +
        +
        Parameters:
        +
        name - The name of the world to remove
        +
        Returns:
        +
        True if success, false if failure.
        +
        +
        • +
      + + + +
        +
      • +

        deleteWorld

        +
        boolean deleteWorld​(java.lang.String name,
+                    boolean removeConfig)
        +
        Remove the world from the Multiverse list, from the + config if wanted, and deletes the folder.
        +
        +
        Parameters:
        +
        name - The name of the world to remove
        +
        removeConfig - If true(default), we'll remove the entries from the + config. If false, they'll stay and the world may come back.
        +
        Returns:
        +
        True if success, false if failure.
        +
        +
        • +
      + + + +
        +
      • +

        deleteWorld

        +
        boolean deleteWorld​(java.lang.String name,
+                    boolean removeFromConfig,
+                    boolean deleteWorldFolder)
        +
        +
        Parameters:
        +
        name - The name of the world to remove
        +
        removeFromConfig - If true(default), we'll remove the entries from the + config. If false, they'll stay and the world may come back.
        +
        deleteWorldFolder - If true the world folder will be completely deleted. If false + only the contents of the world folder will be deleted
        +
        Returns:
        +
        True if success, false if failure.
        +
        +
        • +
      + + + +
        +
      • +

        unloadWorld

        +
        boolean unloadWorld​(java.lang.String name)
        +
        Unload a world from Multiverse.
        +
        +
        Parameters:
        +
        name - Name of the world to unload
        +
        Returns:
        +
        True if the world was unloaded, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        unloadWorld

        +
        boolean unloadWorld​(java.lang.String name,
+                    boolean unloadBukkit)
        +
        Unload a world from Multiverse with option to prevent calling unloadWorld in Bukkit.
        +
        +
        Parameters:
        +
        name - Name of the world to unload
        +
        unloadBukkit - True if Bukkit world should be unloaded
        +
        Returns:
        +
        True if the world was unloaded, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        loadWorld

        +
        boolean loadWorld​(java.lang.String name)
        +
        Loads the world. Only use this if the world has been + unloaded with unloadWorld(String).
        +
        +
        Parameters:
        +
        name - The name of the world to load
        +
        Returns:
        +
        True if success, false if failure.
        +
        +
        • +
      + + + +
        +
      • +

        removePlayersFromWorld

        +
        void removePlayersFromWorld​(java.lang.String name)
        +
        Removes all players from the specified world.
        +
        +
        Parameters:
        +
        name - World to remove players from.
        +
        +
        • +
      + + + +
        +
      • +

        getChunkGenerator

        +
        org.bukkit.generator.ChunkGenerator getChunkGenerator​(java.lang.String generator,
+                                                      java.lang.String generatorID,
+                                                      java.lang.String worldName)
        +
        Test if a given chunk generator is valid.
        +
        +
        Parameters:
        +
        generator - The generator name.
        +
        generatorID - The generator id.
        +
        worldName - The worldName to use as the default.
        +
        Returns:
        +
        A ChunkGenerator or null
        +
        +
        • +
      + + + +
        +
      • +

        getMVWorlds

        +
        java.util.Collection<MultiverseWorld> getMVWorlds()
        +
        Returns a list of all the worlds Multiverse knows about.
        +
        +
        Returns:
        +
        A list of MultiverseWorld.
        +
        +
        • +
      + + + +
        +
      • +

        getMVWorld

        +
        MultiverseWorld getMVWorld​(java.lang.String name)
        +
        Returns a MultiverseWorld if it exists, and null if it does not. + This will search name AND alias.
        +
        +
        Parameters:
        +
        name - The name or alias of the world to get.
        +
        Returns:
        +
        A MultiverseWorld or null.
        +
        +
        • +
      + + + +
        +
      • +

        getMVWorld

        +
        MultiverseWorld getMVWorld​(java.lang.String name,
+                           boolean checkAliases)
        +
        Returns a MultiverseWorld if the world with name given exists, and null if it does not. + This will search optionally for alias names.
        +
        +
        Parameters:
        +
        name - The name or optionally the alias of the world to get.
        +
        checkAliases - Indicates whether to check for world alias name.
        +
        Returns:
        +
        A MultiverseWorld or null.
        +
        +
        • +
      + + + +
        +
      • +

        getMVWorld

        +
        MultiverseWorld getMVWorld​(org.bukkit.World world)
        +
        Returns a MultiverseWorld if it exists, and null if it does not.
        +
        +
        Parameters:
        +
        world - The Bukkit world to check.
        +
        Returns:
        +
        A MultiverseWorld or null.
        +
        +
        • +
      + + + +
        +
      • +

        isMVWorld

        +
        boolean isMVWorld​(java.lang.String name)
        +
        Checks to see if the given name is a valid MultiverseWorld + Searches based on world name AND alias.
        +
        +
        Parameters:
        +
        name - The name or alias of the world to check.
        +
        Returns:
        +
        True if the world exists, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        isMVWorld

        +
        boolean isMVWorld​(java.lang.String name,
+                  boolean checkAliases)
        +
        Checks to see if the given name is a valid MultiverseWorld. + Optionally searches by alias is specified.
        +
        +
        Parameters:
        +
        name - The name or alias of the world to check.
        +
        checkAliases - Indicates whether to check for world alias name.
        +
        Returns:
        +
        True if the world exists, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        isMVWorld

        +
        boolean isMVWorld​(org.bukkit.World world)
        +
        Checks to see if the given world is a valid MultiverseWorld.
        +
        +
        Parameters:
        +
        world - The Bukkit world to check.
        +
        Returns:
        +
        True if the world has been loaded into MV2, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        loadWorlds

        +
        void loadWorlds​(boolean forceLoad)
        +
        Load the Worlds & Settings from the configuration file.
        +
        +
        Parameters:
        +
        forceLoad - If set to true, this will perform a total + reset and not just load new worlds.
        +
        +
        • +
      + + + +
        +
      • +

        loadDefaultWorlds

        +
        void loadDefaultWorlds()
        +
        Loads the Worlds & Settings for any worlds that bukkit loaded before us. +

        + This way people will _always_ have some worlds in the list.

        +
        • +
      + + + +
        +
      • +

        getWorldPurger

        +
        @Deprecated
+PurgeWorlds getWorldPurger()
        +
        Deprecated. +
        PurgeWorlds is deprecated!
        +
        +
        Return the World Purger.
        +
        +
        Returns:
        +
        A valid PurgeWorlds.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        getSpawnWorld

        +
        MultiverseWorld getSpawnWorld()
        +
        Gets the world players will spawn in on first join. + Currently this always returns worlds.get(0) from Bukkit.
        +
        +
        Returns:
        +
        A Multiverse world that players will spawn in or null if no MV world has been set.
        +
        +
        • +
      + + + +
        +
      • +

        getUnloadedWorlds

        +
        java.util.List<java.lang.String> getUnloadedWorlds()
        +
        Gets the list of worlds in the config, but unloaded.
        +
        +
        Returns:
        +
        A List of worlds as strings.
        +
        +
        • +
      + + + +
        +
      • +

        getDefaultWorldGenerators

        +
        void getDefaultWorldGenerators()
        +
        This method populates an internal list and needs to be called after multiverse initialization.
        +
        • +
      + + + +
        +
      • +

        loadWorldConfig

        +
        org.bukkit.configuration.file.FileConfiguration loadWorldConfig​(java.io.File file)
        +
        Load the config from a file.
        +
        +
        Parameters:
        +
        file - The file to load.
        +
        Returns:
        +
        A loaded configuration.
        +
        +
        • +
      + + + +
        +
      • +

        saveWorldsConfig

        +
        boolean saveWorldsConfig()
        +
        Saves the world config to disk.
        +
        +
        Returns:
        +
        True if success, false if fail.
        +
        +
        • +
      + + + +
        +
      • +

        removeWorldFromConfig

        +
        boolean removeWorldFromConfig​(java.lang.String name)
        +
        Remove the world from the Multiverse list and from the config.
        +
        +
        Parameters:
        +
        name - The name of the world to remove
        +
        Returns:
        +
        True if success, false if failure.
        +
        +
        • +
      + + + +
        +
      • +

        setFirstSpawnWorld

        +
        void setFirstSpawnWorld​(java.lang.String world)
        +
        Sets the initial spawn world for new players.
        +
        +
        Parameters:
        +
        world - The World new players should spawn in.
        +
        +
        • +
      + + + +
        +
      • +

        getFirstSpawnWorld

        +
        MultiverseWorld getFirstSpawnWorld()
        +
        Gets the world players should spawn in first.
        +
        +
        Returns:
        +
        The MultiverseWorld new players should spawn in.
        +
        +
        • +
      + + + +
        +
      • +

        regenWorld

        +
        boolean regenWorld​(java.lang.String name,
+                   boolean useNewSeed,
+                   boolean randomSeed,
+                   java.lang.String seed)
        +
        Regenerates a world.
        +
        +
        Parameters:
        +
        name - Name of the world to regenerate
        +
        useNewSeed - If a new seed should be used
        +
        randomSeed - If the new seed should be random
        +
        seed - The seed of the world.
        +
        Returns:
        +
        True if success, false if fail.
        +
        +
        • +
      + + + +
        +
      • +

        regenWorld

        +
        boolean regenWorld​(java.lang.String name,
+                   boolean useNewSeed,
+                   boolean randomSeed,
+                   java.lang.String seed,
+                   boolean keepGameRules)
        +
        Regenerates a world.
        +
        +
        Parameters:
        +
        name - Name of the world to regenerate
        +
        useNewSeed - If a new seed should be used
        +
        randomSeed - If the new seed should be random
        +
        seed - The seed of the world.
        +
        keepGameRules - If GameRules should be kept on world regen.
        +
        Returns:
        +
        True if success, false if fail.
        +
        +
        • +
      + + + +
        +
      • +

        isKeepingSpawnInMemory

        +
        boolean isKeepingSpawnInMemory​(org.bukkit.World world)
        +
        • +
      + + + +
        +
      • +

        hasUnloadedWorld

        +
        boolean hasUnloadedWorld​(java.lang.String name,
+                         boolean includeLoaded)
        +
        Checks whether Multiverse knows about a provided unloaded world. This + method will check the parameter against the alias mappings.
        +
        +
        Parameters:
        +
        name - The name of the unloaded world
        +
        includeLoaded - The value to return if the world is loaded
        +
        Returns:
        +
        True if the world exists and is unloaded. False if the world + does not exist. includeLoaded if the world exists and is loaded.
        +
        +
        • +
      + + + +
        +
      • +

        getPotentialWorlds

        +
        java.util.Collection<java.lang.String> getPotentialWorlds()
        +
        Get all the possible worlds that Multiverse has detected to be importable.
        +
        +
        Returns:
        +
        A collection of world names that are deemed importable.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/api/MultiverseCoreConfig.html b/javadoc/latest/com/onarandombox/MultiverseCore/api/MultiverseCoreConfig.html new file mode 100644 index 000000000..e550a76ca --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/api/MultiverseCoreConfig.html @@ -0,0 +1,1033 @@ + + + + + +MultiverseCoreConfig (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.api
+

Interface MultiverseCoreConfig

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    org.bukkit.configuration.serialization.ConfigurationSerializable
    +
    +
    +
    All Known Implementing Classes:
    +
    MultiverseCoreConfiguration
    +
    +
    +
    public interface MultiverseCoreConfig
+extends org.bukkit.configuration.serialization.ConfigurationSerializable
    +
    The configuration of MultiverseCore.
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethodDescription
      booleangetDisplayPermErrors() +
      Gets displayPermErrors.
      +
      booleangetEnableBuscript() +
      Gets enableBuscript.
      +
      booleangetEnforceAccess() +
      Gets enforceAccess.
      +
      booleangetFirstSpawnOverride() +
      Gets firstSpawnOverride.
      +
      java.lang.StringgetFirstSpawnWorld() +
      Gets firstSpawnWorld.
      +
      intgetGlobalDebug() +
      Gets globalDebug.
      +
      intgetMessageCooldown() +
      Gets messageCooldown.
      +
      intgetPortalSearchRadius() +
      Gets the radius at which vanilla style portals will be searched for to connect to worlds together.
      +
      booleangetPrefixChat() +
      Gets prefixChat.
      +
      java.lang.StringgetPrefixChatFormat() +
      Gets prefixChatFormat.
      +
      booleangetSilentStart() +
      Whether we are suppressing startup messages.
      +
      intgetTeleportCooldown() +
      Gets portalCooldown.
      +
      booleangetTeleportIntercept() +
      Gets teleportIntercept.
      +
      booleangetUseAsyncChat() +
      Gets useasyncchat.
      +
      doublegetVersion() +
      Gets version.
      +
      booleanisAutoPurgeEnabled() +
      Gets whether or not the automatic purge of entities is enabled.
      +
      booleanisShowingDonateMessage() +
      Gets whether or not the donation/patreon messages are shown.
      +
      booleanisUsingDefaultPortalSearch() +
      Gets whether or not Bukkit will be determining portal search radius on its own or if Multiverse should help.
      +
      voidsetAutoPurgeEnabled​(boolean autopurge) +
      Sets whether or not the automatic purge of entities is enabled.
      +
      booleansetConfigProperty​(java.lang.String property, + java.lang.String value) +
      Sets a property using a String.
      +
      voidsetDisplayPermErrors​(boolean displayPermErrors) +
      Sets displayPermErrors.
      +
      voidsetEnableBuscript​(boolean enableBuscript) +
      Sets enableBuscript.
      +
      voidsetEnforceAccess​(boolean enforceAccess) +
      Sets enforceAccess.
      +
      voidsetFirstSpawnOverride​(boolean firstSpawnOverride) +
      Sets firstSpawnOverride.
      +
      voidsetFirstSpawnWorld​(java.lang.String firstSpawnWorld) +
      Sets firstSpawnWorld.
      +
      voidsetGlobalDebug​(int globalDebug) +
      Sets globalDebug.
      +
      voidsetMessageCooldown​(int messageCooldown) +
      Sets messageCooldown.
      +
      voidsetPortalSearchRadius​(int searchRadius) +
      Sets the radius at which vanilla style portals will be searched for to connect to worlds together.
      +
      voidsetPrefixChat​(boolean prefixChat) +
      Sets prefixChat.
      +
      voidsetPrefixChatFormat​(java.lang.String prefixChatFormat) +
      Sets prefixChatFormat.
      +
      voidsetShowDonateMessage​(boolean idonotwanttodonate) +
      Sets whether or not the donation/patreon messages are shown.
      +
      voidsetSilentStart​(boolean silentStart) +
      Sets whether to suppress startup messages.
      +
      voidsetTeleportCooldown​(int portalCooldown) +
      Sets portalCooldown.
      +
      voidsetTeleportIntercept​(boolean teleportIntercept) +
      Sets teleportIntercept.
      +
      voidsetUseAsyncChat​(boolean useAsyncChat) +
      Sets useasyncchat.
      +
      voidsetUseDefaultPortalSearch​(boolean useDefaultPortalSearch) +
      Sets whether or not to let Bukkit determine portal search radius on its own or if Multiverse should give input.
      +
      voidsetVersion​(int version) +
      Sets version.
      +
      +
        +
      • + + +

        Methods inherited from interface org.bukkit.configuration.serialization.ConfigurationSerializable

        +serialize
        • +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setConfigProperty

        +
        boolean setConfigProperty​(java.lang.String property,
+                          java.lang.String value)
        +
        Sets a property using a String.
        +
        +
        Parameters:
        +
        property - The name of the property.
        +
        value - The value.
        +
        Returns:
        +
        True on success, false if the operation failed.
        +
        +
        • +
      + + + +
        +
      • +

        setTeleportCooldown

        +
        void setTeleportCooldown​(int portalCooldown)
        +
        Sets portalCooldown.
        +
        +
        Parameters:
        +
        portalCooldown - The new value.
        +
        +
        • +
      + + + +
        +
      • +

        getTeleportCooldown

        +
        int getTeleportCooldown()
        +
        Gets portalCooldown.
        +
        +
        Returns:
        +
        portalCooldown.
        +
        +
        • +
      + + + +
        +
      • +

        setFirstSpawnWorld

        +
        void setFirstSpawnWorld​(java.lang.String firstSpawnWorld)
        +
        Sets firstSpawnWorld.
        +
        +
        Parameters:
        +
        firstSpawnWorld - The new value.
        +
        +
        • +
      + + + +
        +
      • +

        getFirstSpawnWorld

        +
        java.lang.String getFirstSpawnWorld()
        +
        Gets firstSpawnWorld.
        +
        +
        Returns:
        +
        firstSpawnWorld.
        +
        +
        • +
      + + + +
        +
      • +

        setVersion

        +
        void setVersion​(int version)
        +
        Sets version.
        +
        +
        Parameters:
        +
        version - The new value.
        +
        +
        • +
      + + + +
        +
      • +

        getVersion

        +
        double getVersion()
        +
        Gets version.
        +
        +
        Returns:
        +
        version.
        +
        +
        • +
      + + + +
        +
      • +

        setMessageCooldown

        +
        void setMessageCooldown​(int messageCooldown)
        +
        Sets messageCooldown.
        +
        +
        Parameters:
        +
        messageCooldown - The new value.
        +
        +
        • +
      + + + +
        +
      • +

        getMessageCooldown

        +
        int getMessageCooldown()
        +
        Gets messageCooldown.
        +
        +
        Returns:
        +
        messageCooldown.
        +
        +
        • +
      + + + +
        +
      • +

        setGlobalDebug

        +
        void setGlobalDebug​(int globalDebug)
        +
        Sets globalDebug.
        +
        +
        Parameters:
        +
        globalDebug - The new value.
        +
        +
        • +
      + + + +
        +
      • +

        getGlobalDebug

        +
        int getGlobalDebug()
        +
        Gets globalDebug.
        +
        +
        Returns:
        +
        globalDebug.
        +
        +
        • +
      + + + +
        +
      • +

        setDisplayPermErrors

        +
        void setDisplayPermErrors​(boolean displayPermErrors)
        +
        Sets displayPermErrors.
        +
        +
        Parameters:
        +
        displayPermErrors - The new value.
        +
        +
        • +
      + + + +
        +
      • +

        getDisplayPermErrors

        +
        boolean getDisplayPermErrors()
        +
        Gets displayPermErrors.
        +
        +
        Returns:
        +
        displayPermErrors.
        +
        +
        • +
      + + + +
        +
      • +

        setEnableBuscript

        +
        void setEnableBuscript​(boolean enableBuscript)
        +
        Sets enableBuscript.
        +
        +
        Parameters:
        +
        enableBuscript - The new value.
        +
        +
        • +
      + + + +
        +
      • +

        getEnableBuscript

        +
        boolean getEnableBuscript()
        +
        Gets enableBuscript.
        +
        +
        Returns:
        +
        enableBuscript.
        +
        +
        • +
      + + + +
        +
      • +

        setFirstSpawnOverride

        +
        void setFirstSpawnOverride​(boolean firstSpawnOverride)
        +
        Sets firstSpawnOverride.
        +
        +
        Parameters:
        +
        firstSpawnOverride - The new value.
        +
        +
        • +
      + + + +
        +
      • +

        getFirstSpawnOverride

        +
        boolean getFirstSpawnOverride()
        +
        Gets firstSpawnOverride.
        +
        +
        Returns:
        +
        firstSpawnOverride.
        +
        +
        • +
      + + + +
        +
      • +

        setTeleportIntercept

        +
        void setTeleportIntercept​(boolean teleportIntercept)
        +
        Sets teleportIntercept.
        +
        +
        Parameters:
        +
        teleportIntercept - The new value.
        +
        +
        • +
      + + + +
        +
      • +

        getTeleportIntercept

        +
        boolean getTeleportIntercept()
        +
        Gets teleportIntercept.
        +
        +
        Returns:
        +
        teleportIntercept.
        +
        +
        • +
      + + + +
        +
      • +

        setPrefixChat

        +
        void setPrefixChat​(boolean prefixChat)
        +
        Sets prefixChat.
        +
        +
        Parameters:
        +
        prefixChat - The new value.
        +
        +
        • +
      + + + +
        +
      • +

        getPrefixChat

        +
        boolean getPrefixChat()
        +
        Gets prefixChat.
        +
        +
        Returns:
        +
        prefixChat.
        +
        +
        • +
      + + + +
        +
      • +

        setPrefixChatFormat

        +
        void setPrefixChatFormat​(java.lang.String prefixChatFormat)
        +
        Sets prefixChatFormat.
        +
        +
        Parameters:
        +
        prefixChatFormat - The new value.
        +
        +
        • +
      + + + +
        +
      • +

        getPrefixChatFormat

        +
        java.lang.String getPrefixChatFormat()
        +
        Gets prefixChatFormat.
        +
        +
        Returns:
        +
        prefixChatFormat.
        +
        +
        • +
      + + + +
        +
      • +

        setEnforceAccess

        +
        void setEnforceAccess​(boolean enforceAccess)
        +
        Sets enforceAccess.
        +
        +
        Parameters:
        +
        enforceAccess - The new value.
        +
        +
        • +
      + + + +
        +
      • +

        getEnforceAccess

        +
        boolean getEnforceAccess()
        +
        Gets enforceAccess.
        +
        +
        Returns:
        +
        enforceAccess.
        +
        +
        • +
      + + + +
        +
      • +

        setUseAsyncChat

        +
        void setUseAsyncChat​(boolean useAsyncChat)
        +
        Sets useasyncchat.
        +
        +
        Parameters:
        +
        useAsyncChat - The new value.
        +
        +
        • +
      + + + +
        +
      • +

        getUseAsyncChat

        +
        boolean getUseAsyncChat()
        +
        Gets useasyncchat.
        +
        +
        Returns:
        +
        useasyncchat.
        +
        +
        • +
      + + + +
        +
      • +

        setSilentStart

        +
        void setSilentStart​(boolean silentStart)
        +
        Sets whether to suppress startup messages.
        +
        +
        Parameters:
        +
        silentStart - true to suppress messages.
        +
        +
        • +
      + + + +
        +
      • +

        getSilentStart

        +
        boolean getSilentStart()
        +
        Whether we are suppressing startup messages.
        +
        +
        Returns:
        +
        true if we are suppressing startup messages.
        +
        +
        • +
      + + + +
        +
      • +

        setUseDefaultPortalSearch

        +
        void setUseDefaultPortalSearch​(boolean useDefaultPortalSearch)
        +
        Sets whether or not to let Bukkit determine portal search radius on its own or if Multiverse should give input.
        +
        +
        Parameters:
        +
        useDefaultPortalSearch - True to let Bukkit determine portal search radius on its own.
        +
        +
        • +
      + + + +
        +
      • +

        isUsingDefaultPortalSearch

        +
        boolean isUsingDefaultPortalSearch()
        +
        Gets whether or not Bukkit will be determining portal search radius on its own or if Multiverse should help.
        +
        +
        Returns:
        +
        True means Bukkit will use its own default values.
        +
        +
        • +
      + + + +
        +
      • +

        setPortalSearchRadius

        +
        void setPortalSearchRadius​(int searchRadius)
        +
        Sets the radius at which vanilla style portals will be searched for to connect to worlds together.
        +
        +
        Parameters:
        +
        searchRadius - The portal search radius.
        +
        +
        • +
      + + + +
        +
      • +

        getPortalSearchRadius

        +
        int getPortalSearchRadius()
        +
        Gets the radius at which vanilla style portals will be searched for to connect to worlds together.
        +
        +
        Returns:
        +
        The portal search radius.
        +
        +
        • +
      + + + +
        +
      • +

        isAutoPurgeEnabled

        +
        boolean isAutoPurgeEnabled()
        +
        Gets whether or not the automatic purge of entities is enabled.
        +
        +
        Returns:
        +
        True if automatic purge is enabled.
        +
        +
        • +
      + + + +
        +
      • +

        setAutoPurgeEnabled

        +
        void setAutoPurgeEnabled​(boolean autopurge)
        +
        Sets whether or not the automatic purge of entities is enabled.
        +
        +
        Parameters:
        +
        autopurge - True if automatic purge should be enabled.
        +
        +
        • +
      + + + +
        +
      • +

        isShowingDonateMessage

        +
        boolean isShowingDonateMessage()
        +
        Gets whether or not the donation/patreon messages are shown.
        +
        +
        Returns:
        +
        True if donation/patreon messages should be shown.
        +
        +
        • +
      + + + +
        +
      • +

        setShowDonateMessage

        +
        void setShowDonateMessage​(boolean idonotwanttodonate)
        +
        Sets whether or not the donation/patreon messages are shown.
        +
        +
        Parameters:
        +
        idonotwanttodonate - True if donation/patreon messages should be shown.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/api/MultiverseMessaging.html b/javadoc/latest/com/onarandombox/MultiverseCore/api/MultiverseMessaging.html new file mode 100644 index 000000000..640c21638 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/api/MultiverseMessaging.html @@ -0,0 +1,372 @@ + + + + + +MultiverseMessaging (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.api
+

Interface MultiverseMessaging

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    MVMessaging
    +
    +
    +
    public interface MultiverseMessaging
    +
    Multiverse-messaging.
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethodDescription
      intgetCooldown() +
      Gets the message-cooldown.
      +
      booleansendMessage​(org.bukkit.command.CommandSender sender, + java.lang.String message, + boolean ignoreCooldown) +
      Sends a message to the specified sender if the cooldown has passed.
      +
      booleansendMessages​(org.bukkit.command.CommandSender sender, + java.lang.String[] messages, + boolean ignoreCooldown) +
      Sends a group of messages to the specified sender if the cooldown has passed.
      +
      booleansendMessages​(org.bukkit.command.CommandSender sender, + java.util.Collection<java.lang.String> messages, + boolean ignoreCooldown) +
      Sends a group of messages to the specified sender if the cooldown has passed.
      +
      voidsetCooldown​(int milliseconds) +
      Sets the message-cooldown.
      +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setCooldown

        +
        void setCooldown​(int milliseconds)
        +
        Sets the message-cooldown.
        +
        +
        Parameters:
        +
        milliseconds - The new message-cooldown in milliseconds.
        +
        +
        • +
      + + + +
        +
      • +

        sendMessage

        +
        boolean sendMessage​(org.bukkit.command.CommandSender sender,
+                    java.lang.String message,
+                    boolean ignoreCooldown)
        +
        Sends a message to the specified sender if the cooldown has passed.
        +
        +
        Parameters:
        +
        sender - The person/console to send the message to.
        +
        message - The message to send.
        +
        ignoreCooldown - If true this message will always be sent. Useful for things like menus
        +
        Returns:
        +
        true if the message was sent, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        sendMessages

        +
        boolean sendMessages​(org.bukkit.command.CommandSender sender,
+                     java.lang.String[] messages,
+                     boolean ignoreCooldown)
        +
        Sends a group of messages to the specified sender if the cooldown has passed. + This method is needed, since sending many messages in quick succession would violate + the cooldown.
        +
        +
        Parameters:
        +
        sender - The person/console to send the message to.
        +
        messages - The messages to send.
        +
        ignoreCooldown - If true these messages will always be sent. Useful for things like menus
        +
        Returns:
        +
        true if the message was sent, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        sendMessages

        +
        boolean sendMessages​(org.bukkit.command.CommandSender sender,
+                     java.util.Collection<java.lang.String> messages,
+                     boolean ignoreCooldown)
        +
        Sends a group of messages to the specified sender if the cooldown has passed. + This method is needed, since sending many messages in quick succession would violate + the cooldown.
        +
        +
        Parameters:
        +
        sender - The person/console to send the message to.
        +
        messages - The messages to send.
        +
        ignoreCooldown - If true these messages will always be sent. Useful for things like menus
        +
        Returns:
        +
        true if the message was sent, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        getCooldown

        +
        int getCooldown()
        +
        Gets the message-cooldown.
        +
        +
        Returns:
        +
        The message-cooldown.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/api/MultiversePlugin.html b/javadoc/latest/com/onarandombox/MultiverseCore/api/MultiversePlugin.html new file mode 100644 index 000000000..12332df54 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/api/MultiversePlugin.html @@ -0,0 +1,619 @@ + + + + + +MultiversePlugin (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.api
+

Class MultiversePlugin

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • org.bukkit.plugin.PluginBase
      • +
    • +
        +
      • org.bukkit.plugin.java.JavaPlugin
        • +
      • +
          +
        • com.onarandombox.MultiverseCore.api.MultiversePlugin
          • +
        +
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    LoggablePlugin, MVPlugin, org.bukkit.command.CommandExecutor, org.bukkit.command.TabCompleter, org.bukkit.command.TabExecutor, org.bukkit.plugin.Plugin
    +
    +
    +
    public abstract class MultiversePlugin
+extends org.bukkit.plugin.java.JavaPlugin
+implements MVPlugin
    +
    Make things easier for MV-Plugins!
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      protected java.lang.StringlogTag +
      Prefix for standard log entrys.
      +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      MultiversePlugin() 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and TypeMethodDescription
      java.lang.StringdumpVersionInfo​(java.lang.String buffer) +
      Adds This plugin's version information to the buffer and returns the new string.
      +
      protected java.lang.StringgetAuthors() +
      Parse the Authors Array into a readable String with ',' and 'and'.
      +
      MultiverseCoregetCore() +
      Gets the reference to MultiverseCore.
      +
      voidlog​(java.util.logging.Level level, + java.lang.String msg) +
      Logs a message at the specified level.
      +
      booleanonCommand​(org.bukkit.command.CommandSender sender, + org.bukkit.command.Command command, + java.lang.String label, + java.lang.String[] args) 
      voidonEnable() +
      + + Note: You can't override this, use onPluginEnable() instead!
      +
      protected abstract voidonPluginEnable() +
      Called when the plugin is enabled.
      +
      protected abstract voidregisterCommands​(com.pneumaticraft.commandhandler.CommandHandler handler) +
      You can register commands here.
      +
      voidsetCore​(MultiverseCore core) +
      Sets the reference to MultiverseCore.
      +
      protected voidsetDebugLogTag​(java.lang.String tag) +
      Sets the debug log-tag.
      +
      +
        +
      • + + +

        Methods inherited from class org.bukkit.plugin.java.JavaPlugin

        +getClassLoader, getCommand, getConfig, getDataFolder, getDefaultWorldGenerator, getDescription, getFile, getLogger, getPlugin, getPluginLoader, getProvidingPlugin, getResource, getServer, getTextResource, isEnabled, isNaggable, onDisable, onLoad, onTabComplete, reloadConfig, saveConfig, saveDefaultConfig, saveResource, setEnabled, setNaggable, toString
        • +
      +
        +
      • + + +

        Methods inherited from class org.bukkit.plugin.PluginBase

        +equals, getName, hashCode
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      + + +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        logTag

        +
        protected java.lang.String logTag
        +
        Prefix for standard log entrys.
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MultiversePlugin

        +
        public MultiversePlugin()
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        onEnable

        +
        public final void onEnable()
        +
        + + Note: You can't override this, use onPluginEnable() instead!
        +
        +
        Specified by:
        +
        onEnable in interface org.bukkit.plugin.Plugin
        +
        Overrides:
        +
        onEnable in class org.bukkit.plugin.java.JavaPlugin
        +
        See Also:
        +
        onPluginEnable()
        +
        +
        • +
      + + + +
        +
      • +

        getAuthors

        +
        protected java.lang.String getAuthors()
        +
        Parse the Authors Array into a readable String with ',' and 'and'.
        +
        +
        Returns:
        +
        The readable authors-String
        +
        +
        • +
      + + + +
        +
      • +

        onPluginEnable

        +
        protected abstract void onPluginEnable()
        +
        Called when the plugin is enabled.
        +
        +
        See Also:
        +
        onEnable()
        +
        +
        • +
      + + + +
        +
      • +

        registerCommands

        +
        protected abstract void registerCommands​(com.pneumaticraft.commandhandler.CommandHandler handler)
        +
        You can register commands here.
        +
        +
        Parameters:
        +
        handler - The CommandHandler.
        +
        +
        • +
      + + + +
        +
      • +

        onCommand

        +
        public boolean onCommand​(org.bukkit.command.CommandSender sender,
+                         org.bukkit.command.Command command,
+                         java.lang.String label,
+                         java.lang.String[] args)
        +
        +
        Specified by:
        +
        onCommand in interface org.bukkit.command.CommandExecutor
        +
        Overrides:
        +
        onCommand in class org.bukkit.plugin.java.JavaPlugin
        +
        +
        • +
      + + + +
        +
      • +

        log

        +
        public void log​(java.util.logging.Level level,
+                java.lang.String msg)
        +
        Description copied from interface: LoggablePlugin
        +
        Logs a message at the specified level.
        +
        +
        Specified by:
        +
        log in interface LoggablePlugin
        +
        Parameters:
        +
        level - The Log-Level.
        +
        msg - The message to log.
        +
        +
        • +
      + + + +
        +
      • +

        setDebugLogTag

        +
        protected final void setDebugLogTag​(java.lang.String tag)
        +
        Sets the debug log-tag.
        +
        +
        Parameters:
        +
        tag - The new tag.
        +
        +
        • +
      + + + +
        +
      • +

        dumpVersionInfo

        +
        public final java.lang.String dumpVersionInfo​(java.lang.String buffer)
        +
        Description copied from interface: MVPlugin
        +
        Adds This plugin's version information to the buffer and returns the new string.
        +
        +
        Specified by:
        +
        dumpVersionInfo in interface MVPlugin
        +
        Parameters:
        +
        buffer - The string that contains Core and all other MV plugins' versions.
        +
        Returns:
        +
        A modified buffer that contains this MVPlugin's version information.
        +
        +
        • +
      + + + + + + + + +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/api/MultiverseWorld.html b/javadoc/latest/com/onarandombox/MultiverseCore/api/MultiverseWorld.html new file mode 100644 index 000000000..157f34f6f --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/api/MultiverseWorld.html @@ -0,0 +1,2044 @@ + + + + + +MultiverseWorld (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.api
+

Interface MultiverseWorld

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    MVWorld
    +
    +
    +
    public interface MultiverseWorld
    +
    The API for a Multiverse Handled World.
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and TypeMethodDescription
      booleanaddToVariable​(java.lang.String property, + java.lang.String value) +
      Deprecated. +
      We changed the entire world-config-system.
      +
      +
      voidallowPortalMaking​(AllowedPortalType type) +
      Sets The types of portals that are allowed in this world.
      +
      booleancanAnimalsSpawn() +
      Gets whether or not animals are allowed to spawn in this world.
      +
      booleancanMonstersSpawn() +
      Gets whether or not monsters are allowed to spawn in this world.
      +
      booleanclearList​(java.lang.String property) +
      Deprecated. +
      We changed the entire world-config-system.
      +
      +
      booleanclearVariable​(java.lang.String property) +
      Deprecated. +
      We changed the entire world-config-system.
      +
      +
      org.bukkit.permissions.PermissiongetAccessPermission() +
      Gets the permission required to enter this world.
      +
      booleangetAdjustSpawn() +
      Gets whether or not Multiverse should auto-adjust the spawn for this world.
      +
      java.lang.StringgetAlias() +
      Gets the alias of this world.
      +
      AllowedPortalTypegetAllowedPortals() +
      Gets which type(s) of portals are allowed to be constructed in this world.
      +
      booleangetAllowFlight() +
      Whether or not players are allowed to fly in this world.
      +
      java.lang.StringgetAllPropertyNames() +
      Gets all the names of all properties that can be SET.
      +
      java.util.List<java.lang.String>getAnimalList() +
      Returns a list of animals.
      +
      booleangetAutoHeal() +
      Gets whether or not a world will auto-heal players if the difficulty is on peaceful.
      +
      booleangetAutoLoad() +
      Gets whether or not Multiverse should auto-load this world.
      +
      booleangetBedRespawn() +
      Gets whether or not a player who dies in this world will respawn in their + bed or follow the normal respawn pattern.
      +
      org.bukkit.WorldgetCBWorld() +
      Returns the Bukkit world object that this world describes.
      +
      org.bukkit.ChatColorgetColor() +
      Gets the color that this world's name/alias will display as.
      +
      java.lang.StringgetColoredWorldString() +
      Returns a very nicely colored string (using Alias and Color if they are set).
      +
      @Nullable org.bukkit.MaterialgetCurrency() +
      Gets the type of currency that will be used when users enter this world.
      +
      org.bukkit.DifficultygetDifficulty() +
      Gets the difficulty of this world.
      +
      org.bukkit.World.EnvironmentgetEnvironment() +
      Gets the environment of this world.
      +
      org.bukkit.permissions.PermissiongetExemptPermission() +
      Gets the permission required to be exempt when entering.
      +
      booleangetFakePVP() +
      Deprecated. +
      This is deprecated.
      +
      +
      org.bukkit.GameModegetGameMode() +
      Gets the GameMode of this world.
      +
      java.lang.StringgetGenerator() +
      Gets the generator of this world.
      +
      booleangetHunger() +
      Gets whether or not the hunger level of players will go down in a world.
      +
      java.util.List<java.lang.String>getMonsterList() +
      Returns a list of monsters.
      +
      java.lang.StringgetName() +
      Gets the name of this world.
      +
      java.lang.StringgetPermissibleName() +
      Gets the lowercased name of the world.
      +
      intgetPlayerLimit() +
      Gets the player limit for this world after which players without an override + permission node will not be allowed in.
      +
      doublegetPrice() +
      Gets the amount of currency it requires to enter this world.
      +
      java.lang.StringgetPropertyHelp​(java.lang.String property) +
      Gets the help-message for a property.
      +
      java.lang.StringgetPropertyValue​(java.lang.String property) +
      Gets a property as String.
      +
      org.bukkit.WorldgetRespawnToWorld() +
      Gets the world players will respawn in if they die in this one.
      +
      doublegetScaling() +
      Gets the scaling value of this world.Really only has an effect if you use + Multiverse-NetherPortals.
      +
      longgetSeed() +
      Gets the world seed of this world.
      +
      org.bukkit.LocationgetSpawnLocation() +
      Gets the spawn location of this world.
      +
      org.bukkit.ChatColorgetStyle() +
      Gets the style that this world's name/alias will display as.
      +
      java.lang.StringgetTime() +
      Same as getTime(), but returns a string.
      +
      java.util.List<java.lang.String>getWorldBlacklist() +
      Gets a list of all the worlds that players CANNOT travel to from this world, + regardless of their access permissions.
      +
      org.bukkit.WorldTypegetWorldType() +
      Gets the type of this world.
      +
      booleanisHidden() +
      Gets whether or not this world will display in chat, mvw and mvl regardless if a user has the + access permissions to go to this world.
      +
      booleanisKeepingSpawnInMemory() +
      Gets whether or not CraftBukkit is keeping the chunks for this world in memory.
      +
      booleanisPVPEnabled() +
      Gets whether or not PVP is enabled in this world in some form (fake or not).
      +
      booleanisValidAliasColor​(java.lang.String color) +
      Deprecated. +
      This has been moved: EnglishChatColor.isValidAliasColor(String)
      +
      +
      booleanisWeatherEnabled() +
      Gets whether weather is enabled in this world.
      +
      booleanremoveFromVariable​(java.lang.String property, + java.lang.String value) +
      Deprecated. +
      We changed the entire world-config-system.
      +
      +
      voidsetAdjustSpawn​(boolean adjust) +
      Sets whether or not Multiverse should auto-adjust the spawn for this world.
      +
      voidsetAlias​(java.lang.String alias) +
      Sets the alias of the world.
      +
      voidsetAllowAnimalSpawn​(boolean allowAnimalSpawn) +
      Sets whether or not animals can spawn.
      +
      voidsetAllowFlight​(boolean allowFlight) +
      Sets whether or not players are allowed to fly in this world.
      +
      voidsetAllowMonsterSpawn​(boolean allowMonsterSpawn) +
      Sets whether or not monsters can spawn.
      +
      voidsetAutoHeal​(boolean heal) +
      Sets whether or not a world will auto-heal players if the difficulty is on peaceful.
      +
      voidsetAutoLoad​(boolean autoLoad) +
      Sets whether or not Multiverse should auto-load this world.
      +
      voidsetBedRespawn​(boolean autoLoad) +
      Sets whether or not a player who dies in this world will respawn in their + bed or follow the normal respawn pattern.
      +
      booleansetColor​(java.lang.String color) +
      Sets the color that this world's name/alias will display as.
      +
      voidsetCurrency​(@Nullable org.bukkit.Material item) +
      Sets the type of item that will be required given the price is not 0.
      +
      booleansetDifficulty​(java.lang.String difficulty) +
      Deprecated. +
      Use setDifficulty(Difficulty) or, if you have to + pass a string, use setPropertyValue(String, String) instead.
      +
      +
      booleansetDifficulty​(org.bukkit.Difficulty difficulty) +
      Sets the difficulty of this world and returns true on success.
      +
      voidsetEnableWeather​(boolean enableWeather) +
      Sets whether or not there will be weather events in a given world.
      +
      voidsetEnvironment​(org.bukkit.World.Environment environment) +
      Sets the environment of a world.
      +
      booleansetGameMode​(java.lang.String gameMode) +
      Deprecated. +
      Use setGameMode(GameMode) instead.
      +
      +
      booleansetGameMode​(org.bukkit.GameMode gameMode) +
      Sets the game mode of this world.
      +
      voidsetGenerator​(java.lang.String generator) +
      Sets the generator of this world.
      +
      voidsetHidden​(boolean hidden) +
      Sets whether or not this world will display in chat, mvw and mvl regardless if a user has the + access permissions to go to this world.
      +
      voidsetHunger​(boolean hungerEnabled) +
      Sets whether or not the hunger level of players will go down in a world.
      +
      voidsetKeepSpawnInMemory​(boolean keepSpawnInMemory) +
      If true, tells Craftbukkit to keep a worlds spawn chunks loaded in memory (default: true) + If not, CraftBukkit will attempt to free memory when players have not used that world.
      +
      voidsetPlayerLimit​(int limit) +
      Sets the player limit for this world after which players without an override + permission node will not be allowed in.
      +
      voidsetPrice​(double price) +
      Sets the price for entry to this world.
      +
      booleansetPropertyValue​(java.lang.String property, + java.lang.String value) +
      Sets a property to a given value.
      +
      voidsetPVPMode​(boolean pvpMode) +
      Turn pvp on or off.
      +
      booleansetRespawnToWorld​(java.lang.String respawnWorld) +
      Sets the world players will respawn in if they die in this one.
      +
      booleansetScaling​(double scaling) +
      Sets the scale of this world.
      +
      voidsetSeed​(long seed) +
      Sets the seed of this world.
      +
      voidsetSpawnLocation​(org.bukkit.Location spawnLocation) +
      Sets the spawn location for a world.
      +
      booleansetStyle​(java.lang.String style) +
      Sets the style that this world's name/alias will display as.
      +
      booleansetTime​(java.lang.String timeAsString) +
      Sets the current time in a world.
      +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getCBWorld

        +
        org.bukkit.World getCBWorld()
        +
        Returns the Bukkit world object that this world describes.
        +
        +
        Returns:
        +
        A World
        +
        +
        • +
      + + + +
        +
      • +

        getName

        +
        java.lang.String getName()
        +
        Gets the name of this world. The name cannot be changed. +

        + Note for plugin developers: Usually getAlias() + is what you want to use instead of this method.

        +
        +
        Returns:
        +
        The name of the world as a String.
        +
        +
        • +
      + + + +
        +
      • +

        getWorldType

        +
        org.bukkit.WorldType getWorldType()
        +
        Gets the type of this world. As of 1.2 this will be: + FLAT, NORMAL or VERSION_1_1 +

        + This is not the generator.

        +
        +
        Returns:
        +
        The Type of this world.
        +
        +
        • +
      + + + +
        +
      • +

        getEnvironment

        +
        org.bukkit.World.Environment getEnvironment()
        +
        Gets the environment of this world.
        +
        +
        Returns:
        +
        A World.Environment.
        +
        +
        • +
      + + + +
        +
      • +

        setEnvironment

        +
        void setEnvironment​(org.bukkit.World.Environment environment)
        +
        Sets the environment of a world. +

        + Note: This will ONLY take effect once the world is unloaded/reloaded.

        +
        +
        Parameters:
        +
        environment - A World.Environment.
        +
        +
        • +
      + + + +
        +
      • +

        getDifficulty

        +
        org.bukkit.Difficulty getDifficulty()
        +
        Gets the difficulty of this world.
        +
        +
        Returns:
        +
        The difficulty of this world.
        +
        +
        • +
      + + + +
        +
      • +

        setDifficulty

        +
        @Deprecated
+boolean setDifficulty​(java.lang.String difficulty)
        +
        Deprecated. +
        Use setDifficulty(Difficulty) or, if you have to + pass a string, use setPropertyValue(String, String) instead.
        +
        +
        Sets the difficulty of this world and returns true if success. + Valid string values are either an integer of difficulty(0-3) or + the name that resides in the Bukkit enum, ex. PEACEFUL
        +
        +
        Parameters:
        +
        difficulty - The difficulty to set the world to as a string.
        +
        Returns:
        +
        True if success, false if the provided string + could not be translated to a difficulty.
        +
        +
        • +
      + + + +
        +
      • +

        setDifficulty

        +
        boolean setDifficulty​(org.bukkit.Difficulty difficulty)
        +
        Sets the difficulty of this world and returns true on success. + Valid string values are either an integer of difficulty(0-3) or + the name that resides in the Bukkit enum, ex. PEACEFUL
        +
        +
        Parameters:
        +
        difficulty - The new difficulty.
        +
        Returns:
        +
        True if success, false if the operation failed... for whatever reason.
        +
        +
        • +
      + + + +
        +
      • +

        getSeed

        +
        long getSeed()
        +
        Gets the world seed of this world.
        +
        +
        Returns:
        +
        The Long version of the seed.
        +
        +
        • +
      + + + +
        +
      • +

        setSeed

        +
        void setSeed​(long seed)
        +
        Sets the seed of this world.
        +
        +
        Parameters:
        +
        seed - A Long that is the seed.
        +
        +
        • +
      + + + +
        +
      • +

        getGenerator

        +
        java.lang.String getGenerator()
        +
        Gets the generator of this world.
        +
        +
        Returns:
        +
        The name of the generator.
        +
        +
        • +
      + + + +
        +
      • +

        setGenerator

        +
        void setGenerator​(java.lang.String generator)
        +
        Sets the generator of this world.
        +
        +
        Parameters:
        +
        generator - The new generator's name.
        +
        +
        • +
      + + + +
        +
      • +

        getPropertyHelp

        +
        java.lang.String getPropertyHelp​(java.lang.String property)
+                          throws PropertyDoesNotExistException
        +
        Gets the help-message for a property.
        +
        +
        Parameters:
        +
        property - The name of the property.
        +
        Returns:
        +
        The help-message.
        +
        Throws:
        +
        PropertyDoesNotExistException - Thrown if the property was not found.
        +
        +
        • +
      + + + +
        +
      • +

        getPropertyValue

        +
        java.lang.String getPropertyValue​(java.lang.String property)
+                           throws PropertyDoesNotExistException
        +
        Gets a property as String.
        +
        +
        Parameters:
        +
        property - The name of a world property to get.
        +
        Returns:
        +
        The string-representation of that property.
        +
        Throws:
        +
        PropertyDoesNotExistException - Thrown if the property was not found in the world.
        +
        +
        • +
      + + + +
        +
      • +

        setPropertyValue

        +
        boolean setPropertyValue​(java.lang.String property,
+                         java.lang.String value)
+                  throws PropertyDoesNotExistException
        +
        Sets a property to a given value.
        +
        +
        Parameters:
        +
        property - The name of a world property to set.
        +
        value - A value in string representation, it will be parsed to the correct type.
        +
        Returns:
        +
        True if the value was set, false if not.
        +
        Throws:
        +
        PropertyDoesNotExistException - Thrown if the property was not found in the world.
        +
        +
        • +
      + + + +
        +
      • +

        addToVariable

        +
        @Deprecated
+boolean addToVariable​(java.lang.String property,
+                      java.lang.String value)
        +
        Deprecated. +
        We changed the entire world-config-system. This is not compatible any more.
        +
        +
        Adds a value to the given property. The property must be a AddProperties.
        +
        +
        Parameters:
        +
        property - The name of a AddProperties to add a value to.
        +
        value - A value in string representation, it will be parsed to the correct type.
        +
        Returns:
        +
        True if the value was added, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        removeFromVariable

        +
        @Deprecated
+boolean removeFromVariable​(java.lang.String property,
+                           java.lang.String value)
        +
        Deprecated. +
        We changed the entire world-config-system. This is not compatible any more.
        +
        +
        Removes a value from the given property. The property must be a AddProperties.
        +
        +
        Parameters:
        +
        property - The name of a AddProperties to remove a value + from.
        +
        value - A value in string representation, it will be parsed to the correct type.
        +
        Returns:
        +
        True if the value was removed, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        clearVariable

        +
        @Deprecated
+boolean clearVariable​(java.lang.String property)
        +
        Deprecated. +
        We changed the entire world-config-system. This is not compatible any more.
        +
        +
        Removes all values from the given property. The property must be a AddProperties.
        +
        +
        Parameters:
        +
        property - The name of a AddProperties to clear.
        +
        Returns:
        +
        True if it was cleared, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        clearList

        +
        @Deprecated
+boolean clearList​(java.lang.String property)
        +
        Deprecated. +
        We changed the entire world-config-system. This is not compatible any more.
        +
        +
        Clears a list property (sets it to []).
        +
        +
        Parameters:
        +
        property - The property to clear.
        +
        Returns:
        +
        True if success, false if fail.
        +
        +
        • +
      + + + +
        +
      • +

        getPermissibleName

        +
        java.lang.String getPermissibleName()
        +
        Gets the lowercased name of the world. This method is required, since the permissables + lowercase all permissions when recalculating. +

        + Note: This also means if a user has worlds named: world and WORLD, that they can both + exist, and both be teleported to independently, but their permissions **cannot** be + uniqueified at this time. See bug report #.

        +
        +
        Returns:
        +
        The lowercased name of the world.
        +
        +
        • +
      + + + +
        +
      • +

        getAccessPermission

        +
        org.bukkit.permissions.Permission getAccessPermission()
        +
        Gets the permission required to enter this world.
        +
        +
        Returns:
        +
        The permission required to be exempt from charges to/from this world.
        +
        +
        • +
      + + + +
        +
      • +

        getExemptPermission

        +
        org.bukkit.permissions.Permission getExemptPermission()
        +
        Gets the permission required to be exempt when entering.
        +
        +
        Returns:
        +
        The permission required to be exempt when entering.
        +
        +
        • +
      + + + +
        +
      • +

        getAlias

        +
        java.lang.String getAlias()
        +
        Gets the alias of this world. +

        + This alias allows users to have a world named "world" but show up in the list as "FernIsland"

        +
        +
        Returns:
        +
        The alias of the world as a String.
        +
        +
        • +
      + + + +
        +
      • +

        setAlias

        +
        void setAlias​(java.lang.String alias)
        +
        Sets the alias of the world.
        +
        +
        Parameters:
        +
        alias - A string that is the new alias.
        +
        +
        • +
      + + + +
        +
      • +

        getColor

        +
        org.bukkit.ChatColor getColor()
        +
        Gets the color that this world's name/alias will display as.
        +
        +
        Returns:
        +
        The color of this world.
        +
        +
        • +
      + + + +
        +
      • +

        setColor

        +
        boolean setColor​(java.lang.String color)
        +
        Sets the color that this world's name/alias will display as.
        +
        +
        Parameters:
        +
        color - A valid color name.
        +
        Returns:
        +
        True if the color was set, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        getStyle

        +
        org.bukkit.ChatColor getStyle()
        +
        Gets the style that this world's name/alias will display as.
        +
        +
        Returns:
        +
        The style of this world. null for "normal" style.
        +
        +
        • +
      + + + +
        +
      • +

        setStyle

        +
        boolean setStyle​(java.lang.String style)
        +
        Sets the style that this world's name/alias will display as.
        +
        +
        Parameters:
        +
        style - A valid style name.
        +
        Returns:
        +
        True if the style was set, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        isValidAliasColor

        +
        @Deprecated
+boolean isValidAliasColor​(java.lang.String color)
        +
        Deprecated. +
        This has been moved: EnglishChatColor.isValidAliasColor(String)
        +
        +
        Tells you if someone entered a valid color.
        +
        +
        Parameters:
        +
        color - A string that may translate to a color.
        +
        Returns:
        +
        True if it is a color, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        getColoredWorldString

        +
        java.lang.String getColoredWorldString()
        +
        Returns a very nicely colored string (using Alias and Color if they are set).
        +
        +
        Returns:
        +
        A nicely colored string.
        +
        +
        • +
      + + + +
        +
      • +

        canAnimalsSpawn

        +
        boolean canAnimalsSpawn()
        +
        Gets whether or not animals are allowed to spawn in this world.
        +
        +
        Returns:
        +
        True if ANY animal can, false if no animals can spawn.
        +
        +
        • +
      + + + +
        +
      • +

        setAllowAnimalSpawn

        +
        void setAllowAnimalSpawn​(boolean allowAnimalSpawn)
        +
        Sets whether or not animals can spawn. + If there are values in getAnimalList() and this is false, + those animals become the exceptions, and will spawn
        +
        +
        Parameters:
        +
        allowAnimalSpawn - True to allow spawning of monsters, false to prevent.
        +
        +
        • +
      + + + +
        +
      • +

        getAnimalList

        +
        java.util.List<java.lang.String> getAnimalList()
        +
        Returns a list of animals. This list always negates the canAnimalsSpawn() result.
        +
        +
        Returns:
        +
        A list of animals that will spawn if canAnimalsSpawn() is false.
        +
        +
        • +
      + + + +
        +
      • +

        canMonstersSpawn

        +
        boolean canMonstersSpawn()
        +
        Gets whether or not monsters are allowed to spawn in this world.
        +
        +
        Returns:
        +
        True if ANY monster can, false if no monsters can spawn.
        +
        +
        • +
      + + + +
        +
      • +

        setAllowMonsterSpawn

        +
        void setAllowMonsterSpawn​(boolean allowMonsterSpawn)
        +
        Sets whether or not monsters can spawn. + If there are values in getMonsterList() and this is false, + those monsters become the exceptions, and will spawn
        +
        +
        Parameters:
        +
        allowMonsterSpawn - True to allow spawning of monsters, false to prevent.
        +
        +
        • +
      + + + +
        +
      • +

        getMonsterList

        +
        java.util.List<java.lang.String> getMonsterList()
        +
        Returns a list of monsters. This list always negates the canMonstersSpawn() result.
        +
        +
        Returns:
        +
        A list of monsters that will spawn if canMonstersSpawn() is false.
        +
        +
        • +
      + + + +
        +
      • +

        isPVPEnabled

        +
        boolean isPVPEnabled()
        +
        Gets whether or not PVP is enabled in this world in some form (fake or not).
        +
        +
        Returns:
        +
        True if players can take damage from other players.
        +
        +
        • +
      + + + +
        +
      • +

        setPVPMode

        +
        void setPVPMode​(boolean pvpMode)
        +
        Turn pvp on or off. This setting is used to set the world's PVP mode.
        +
        +
        Parameters:
        +
        pvpMode - True to enable PVP damage, false to disable it.
        +
        +
        • +
      + + + +
        +
      • +

        getFakePVP

        +
        @Deprecated
+boolean getFakePVP()
        +
        Deprecated. +
        This is deprecated.
        +
        +
        Turn pvp on or off. This setting is used to set the world's PVP mode, and thus relies on fakePVP
        +
        +
        Returns:
        +
        True if this world has fakepvp on
        +
        +
        • +
      + + + +
        +
      • +

        isHidden

        +
        boolean isHidden()
        +
        Gets whether or not this world will display in chat, mvw and mvl regardless if a user has the + access permissions to go to this world.
        +
        +
        Returns:
        +
        True if the world will be hidden, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        setHidden

        +
        void setHidden​(boolean hidden)
        +
        Sets whether or not this world will display in chat, mvw and mvl regardless if a user has the + access permissions to go to this world.
        +
        +
        Parameters:
        +
        hidden - Set
        +
        +
        • +
      + + + +
        +
      • +

        isWeatherEnabled

        +
        boolean isWeatherEnabled()
        +
        Gets whether weather is enabled in this world.
        +
        +
        Returns:
        +
        True if weather events will occur, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        setEnableWeather

        +
        void setEnableWeather​(boolean enableWeather)
        +
        Sets whether or not there will be weather events in a given world. + If set to false, Multiverse will disable the weather in the world immediately.
        +
        +
        Parameters:
        +
        enableWeather - True if weather events should occur in a world, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        isKeepingSpawnInMemory

        +
        boolean isKeepingSpawnInMemory()
        +
        Gets whether or not CraftBukkit is keeping the chunks for this world in memory.
        +
        +
        Returns:
        +
        True if CraftBukkit is keeping spawn chunks in memory.
        +
        +
        • +
      + + + +
        +
      • +

        setKeepSpawnInMemory

        +
        void setKeepSpawnInMemory​(boolean keepSpawnInMemory)
        +
        If true, tells Craftbukkit to keep a worlds spawn chunks loaded in memory (default: true) + If not, CraftBukkit will attempt to free memory when players have not used that world. + This will not happen immediately.
        +
        +
        Parameters:
        +
        keepSpawnInMemory - If true, CraftBukkit will keep the spawn chunks loaded in memory.
        +
        +
        • +
      + + + +
        +
      • +

        getSpawnLocation

        +
        org.bukkit.Location getSpawnLocation()
        +
        Gets the spawn location of this world.
        +
        +
        Returns:
        +
        The spawn location of this world.
        +
        +
        • +
      + + + +
        +
      • +

        setSpawnLocation

        +
        void setSpawnLocation​(org.bukkit.Location spawnLocation)
        +
        Sets the spawn location for a world.
        +
        +
        Parameters:
        +
        spawnLocation - The spawn location for a world.
        +
        +
        • +
      + + + +
        +
      • +

        getHunger

        +
        boolean getHunger()
        +
        Gets whether or not the hunger level of players will go down in a world.
        +
        +
        Returns:
        +
        True if it will go down, false if it will remain steady.
        +
        +
        • +
      + + + +
        +
      • +

        setHunger

        +
        void setHunger​(boolean hungerEnabled)
        +
        Sets whether or not the hunger level of players will go down in a world.
        +
        +
        Parameters:
        +
        hungerEnabled - True if hunger will go down, false to keep it at + the level they entered a world with.
        +
        +
        • +
      + + + +
        +
      • +

        getGameMode

        +
        org.bukkit.GameMode getGameMode()
        +
        Gets the GameMode of this world.
        +
        +
        Returns:
        +
        The GameMode of this world.
        +
        +
        • +
      + + + +
        +
      • +

        setGameMode

        +
        @Deprecated
+boolean setGameMode​(java.lang.String gameMode)
        +
        Deprecated. +
        Use setGameMode(GameMode) instead. If you have to + pass a string, use setPropertyValue(String, String).
        +
        +
        Sets the game mode of this world.
        +
        +
        Parameters:
        +
        gameMode - A valid game mode string (either + an int ex. 0 or a string ex. creative).
        +
        Returns:
        +
        True if the game mode was successfully changed, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        setGameMode

        +
        boolean setGameMode​(org.bukkit.GameMode gameMode)
        +
        Sets the game mode of this world.
        +
        +
        Parameters:
        +
        gameMode - The new GameMode.
        +
        Returns:
        +
        True if the game mode was successfully changed, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        getPrice

        +
        double getPrice()
        +
        Gets the amount of currency it requires to enter this world.
        +
        +
        Returns:
        +
        The amount it costs to enter this world.
        +
        +
        • +
      + + + +
        +
      • +

        setPrice

        +
        void setPrice​(double price)
        +
        Sets the price for entry to this world. + You can think of this like an amount. + The type can be set with setCurrency(Material)
        +
        +
        Parameters:
        +
        price - The Amount of money/item to enter the world.
        +
        +
        • +
      + + + +
        +
      • +

        getCurrency

        +
        @Nullable
+@Nullable org.bukkit.Material getCurrency()
        +
        Gets the type of currency that will be used when users enter this world. A value of null indicates a non-item + based currency is used.
        +
        +
        Returns:
        +
        The type of currency that will be used when users enter this world.
        +
        +
        • +
      + + + +
        +
      • +

        setCurrency

        +
        void setCurrency​(@Nullable
+                 @Nullable org.bukkit.Material item)
        +
        Sets the type of item that will be required given the price is not 0. + Use a value of null to specify a non-item based currency.
        +
        +
        Parameters:
        +
        item - The Type of currency that will be used when users enter this world.
        +
        +
        • +
      + + + +
        +
      • +

        getRespawnToWorld

        +
        org.bukkit.World getRespawnToWorld()
        +
        Gets the world players will respawn in if they die in this one.
        +
        +
        Returns:
        +
        A world that exists on the server.
        +
        +
        • +
      + + + +
        +
      • +

        setRespawnToWorld

        +
        boolean setRespawnToWorld​(java.lang.String respawnWorld)
        +
        Sets the world players will respawn in if they die in this one. + Returns true upon success, false upon failure.
        +
        +
        Parameters:
        +
        respawnWorld - The name of a world that exists on the server.
        +
        Returns:
        +
        True if respawnWorld existed, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        getScaling

        +
        double getScaling()
        +
        Gets the scaling value of this world.Really only has an effect if you use + Multiverse-NetherPortals.
        +
        +
        Returns:
        +
        This world's non-negative, non-zero scale.
        +
        +
        • +
      + + + +
        +
      • +

        setScaling

        +
        boolean setScaling​(double scaling)
        +
        Sets the scale of this world. Really only has an effect if you use + Multiverse-NetherPortals.
        +
        +
        Parameters:
        +
        scaling - A scaling value, cannot be negative or 0.
        +
        Returns:
        +
        Whether the scale was set successfully.
        +
        +
        • +
      + + + +
        +
      • +

        getAutoHeal

        +
        boolean getAutoHeal()
        +
        Gets whether or not a world will auto-heal players if the difficulty is on peaceful.
        +
        +
        Returns:
        +
        True if the world should heal (default), false if not.
        +
        +
        • +
      + + + +
        +
      • +

        setAutoHeal

        +
        void setAutoHeal​(boolean heal)
        +
        Sets whether or not a world will auto-heal players if the difficulty is on peaceful.
        +
        +
        Parameters:
        +
        heal - True if the world will heal.
        +
        +
        • +
      + + + +
        +
      • +

        getAdjustSpawn

        +
        boolean getAdjustSpawn()
        +
        Gets whether or not Multiverse should auto-adjust the spawn for this world.
        +
        +
        Returns:
        +
        True if Multiverse should adjust the spawn, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        setAdjustSpawn

        +
        void setAdjustSpawn​(boolean adjust)
        +
        Sets whether or not Multiverse should auto-adjust the spawn for this world.
        +
        +
        Parameters:
        +
        adjust - True if multiverse should adjust the spawn, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        getAutoLoad

        +
        boolean getAutoLoad()
        +
        Gets whether or not Multiverse should auto-load this world.
        +
        +
        Returns:
        +
        True if Multiverse should auto-load this world.
        +
        +
        • +
      + + + +
        +
      • +

        setAutoLoad

        +
        void setAutoLoad​(boolean autoLoad)
        +
        Sets whether or not Multiverse should auto-load this world. +

        + True is default.

        +
        +
        Parameters:
        +
        autoLoad - True if multiverse should autoload this world the spawn, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        getBedRespawn

        +
        boolean getBedRespawn()
        +
        Gets whether or not a player who dies in this world will respawn in their + bed or follow the normal respawn pattern.
        +
        +
        Returns:
        +
        True if players dying in this world should respawn at their bed.
        +
        +
        • +
      + + + +
        +
      • +

        setBedRespawn

        +
        void setBedRespawn​(boolean autoLoad)
        +
        Sets whether or not a player who dies in this world will respawn in their + bed or follow the normal respawn pattern. +

        + True is default.

        +
        +
        Parameters:
        +
        autoLoad - True if players dying in this world respawn at their bed.
        +
        +
        • +
      + + + +
        +
      • +

        setPlayerLimit

        +
        void setPlayerLimit​(int limit)
        +
        Sets the player limit for this world after which players without an override + permission node will not be allowed in. A value of -1 or less signifies no limit
        +
        +
        Parameters:
        +
        limit - The new limit
        +
        +
        • +
      + + + +
        +
      • +

        getPlayerLimit

        +
        int getPlayerLimit()
        +
        Gets the player limit for this world after which players without an override + permission node will not be allowed in. A value of -1 or less signifies no limit
        +
        +
        Returns:
        +
        The player limit
        +
        +
        • +
      + + + +
        +
      • +

        getTime

        +
        java.lang.String getTime()
        +
        Same as getTime(), but returns a string.
        +
        +
        Returns:
        +
        The time as a short string: 12:34pm
        +
        +
        • +
      + + + +
        +
      • +

        setTime

        +
        boolean setTime​(java.lang.String timeAsString)
        +
        Sets the current time in a world. +

        + This method will take the following formats: + 11:37am + 4:30p + day(morning), night, noon, midnight

        +
        +
        Parameters:
        +
        timeAsString - The formatted time to set the world to.
        +
        Returns:
        +
        True if the time was set, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        allowPortalMaking

        +
        void allowPortalMaking​(AllowedPortalType type)
        +
        Sets The types of portals that are allowed in this world.
        +
        +
        Parameters:
        +
        type - The type of portals allowed in this world.
        +
        +
        • +
      + + + +
        +
      • +

        getAllowedPortals

        +
        AllowedPortalType getAllowedPortals()
        +
        Gets which type(s) of portals are allowed to be constructed in this world.
        +
        +
        Returns:
        +
        The type of portals that are allowed.
        +
        +
        • +
      + + + +
        +
      • +

        getWorldBlacklist

        +
        java.util.List<java.lang.String> getWorldBlacklist()
        +
        Gets a list of all the worlds that players CANNOT travel to from this world, + regardless of their access permissions.
        +
        +
        Returns:
        +
        A List of world names.
        +
        +
        • +
      + + + +
        +
      • +

        getAllPropertyNames

        +
        java.lang.String getAllPropertyNames()
        +
        Gets all the names of all properties that can be SET.
        +
        +
        Returns:
        +
        All property names, with alternating colors.
        +
        +
        • +
      + + + +
        +
      • +

        getAllowFlight

        +
        boolean getAllowFlight()
        +
        Whether or not players are allowed to fly in this world.
        +
        +
        Returns:
        +
        True if players allowed to fly in this world.
        +
        +
        • +
      + + + +
        +
      • +

        setAllowFlight

        +
        void setAllowFlight​(boolean allowFlight)
        +
        Sets whether or not players are allowed to fly in this world.
        +
        +
        Parameters:
        +
        allowFlight - True to allow flight in this world.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/api/SafeTTeleporter.html b/javadoc/latest/com/onarandombox/MultiverseCore/api/SafeTTeleporter.html new file mode 100644 index 000000000..ad05f7594 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/api/SafeTTeleporter.html @@ -0,0 +1,416 @@ + + + + + +SafeTTeleporter (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.api
+

Interface SafeTTeleporter

+
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethodDescription
      org.bukkit.LocationfindPortalBlockNextTo​(org.bukkit.Location l) +
      Finds a portal-block next to the specified Location.
      +
      org.bukkit.LocationgetSafeLocation​(org.bukkit.entity.Entity e, + MVDestination d) +
      Returns a safe location for the entity to spawn at.
      +
      org.bukkit.LocationgetSafeLocation​(org.bukkit.Location l) +
      Gets the next safe location around the given location.
      +
      org.bukkit.LocationgetSafeLocation​(org.bukkit.Location l, + int tolerance, + int radius) +
      Gets the next safe location around the given location.
      +
      TeleportResultsafelyTeleport​(org.bukkit.command.CommandSender teleporter, + org.bukkit.entity.Entity teleportee, + MVDestination d) +
      Safely teleport the entity to the MVDestination.
      +
      TeleportResultsafelyTeleport​(org.bukkit.command.CommandSender teleporter, + org.bukkit.entity.Entity teleportee, + org.bukkit.Location location, + boolean safely) +
      Safely teleport the entity to the Location.
      +
      + +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getSafeLocation

        +
        org.bukkit.Location getSafeLocation​(org.bukkit.Location l)
        +
        Gets the next safe location around the given location.
        +
        +
        Parameters:
        +
        l - A Location.
        +
        Returns:
        +
        A safe Location.
        +
        +
        • +
      + + + +
        +
      • +

        getSafeLocation

        +
        org.bukkit.Location getSafeLocation​(org.bukkit.Location l,
+                                    int tolerance,
+                                    int radius)
        +
        Gets the next safe location around the given location.
        +
        +
        Parameters:
        +
        l - A Location.
        +
        tolerance - The tolerance.
        +
        radius - The radius.
        +
        Returns:
        +
        A safe Location.
        +
        +
        • +
      + + + +
        +
      • +

        safelyTeleport

        +
        TeleportResult safelyTeleport​(org.bukkit.command.CommandSender teleporter,
+                              org.bukkit.entity.Entity teleportee,
+                              MVDestination d)
        +
        Safely teleport the entity to the MVDestination. This will perform checks to see if the place is safe, and if + it's not, will adjust the final destination accordingly.
        +
        +
        Parameters:
        +
        teleporter - Person who performed the teleport command.
        +
        teleportee - Entity to teleport
        +
        d - Destination to teleport them to
        +
        Returns:
        +
        true for success, false for failure
        +
        +
        • +
      + + + +
        +
      • +

        safelyTeleport

        +
        TeleportResult safelyTeleport​(org.bukkit.command.CommandSender teleporter,
+                              org.bukkit.entity.Entity teleportee,
+                              org.bukkit.Location location,
+                              boolean safely)
        +
        Safely teleport the entity to the Location. This may perform checks to + see if the place is safe, and if + it's not, will adjust the final destination accordingly.
        +
        +
        Parameters:
        +
        teleporter - Person who issued the teleport command.
        +
        teleportee - Entity to teleport.
        +
        location - Location to teleport them to.
        +
        safely - Should the destination be checked for safety before teleport?
        +
        Returns:
        +
        true for success, false for failure.
        +
        +
        • +
      + + + +
        +
      • +

        getSafeLocation

        +
        org.bukkit.Location getSafeLocation​(org.bukkit.entity.Entity e,
+                                    MVDestination d)
        +
        Returns a safe location for the entity to spawn at.
        +
        +
        Parameters:
        +
        e - The entity to spawn
        +
        d - The MVDestination to take the entity to.
        +
        Returns:
        +
        A new location to spawn the entity at.
        +
        +
        • +
      + + + +
        +
      • +

        findPortalBlockNextTo

        +
        org.bukkit.Location findPortalBlockNextTo​(org.bukkit.Location l)
        +
        Finds a portal-block next to the specified Location.
        +
        +
        Parameters:
        +
        l - The Location
        +
        Returns:
        +
        The next portal-block's Location.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/api/Teleporter.html b/javadoc/latest/com/onarandombox/MultiverseCore/api/Teleporter.html new file mode 100644 index 000000000..4dc304773 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/api/Teleporter.html @@ -0,0 +1,260 @@ + + + + + +Teleporter (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.api
+

Interface Teleporter

+
+
+
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        teleport

        +
        TeleportResult teleport​(org.bukkit.command.CommandSender teleporter,
+                        org.bukkit.entity.Player teleportee,
+                        MVDestination destination)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/api/WorldPurger.html b/javadoc/latest/com/onarandombox/MultiverseCore/api/WorldPurger.html new file mode 100644 index 000000000..d60f88529 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/api/WorldPurger.html @@ -0,0 +1,402 @@ + + + + + +WorldPurger (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.api
+

Interface WorldPurger

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    SimpleWorldPurger
    +
    +
    +
    public interface WorldPurger
    +
    Used to remove animals from worlds that don't belong there.
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethodDescription
      voidpurgeWorld​(MultiverseWorld world) +
      Convenience method for purgeWorld(MultiverseWorld, java.util.List, boolean, boolean) that takes the settings from the world-config.
      +
      voidpurgeWorld​(MultiverseWorld mvworld, + java.util.List<java.lang.String> thingsToKill, + boolean negateAnimals, + boolean negateMonsters) +
      Clear all animals/monsters that do not belong to a world according to the config.
      +
      voidpurgeWorld​(MultiverseWorld mvworld, + java.util.List<java.lang.String> thingsToKill, + boolean negateAnimals, + boolean negateMonsters, + org.bukkit.command.CommandSender sender) +
      Clear all animals/monsters that do not belong to a world according to the config.
      +
      voidpurgeWorlds​(java.util.List<MultiverseWorld> worlds) +
      Synchronizes the given worlds with their settings.
      +
      booleanshouldWeKillThisCreature​(MultiverseWorld w, + org.bukkit.entity.Entity e) +
      Determines whether the specified creature should be killed and automatically reads the params from a world object.
      +
      booleanshouldWeKillThisCreature​(org.bukkit.entity.Entity e, + java.util.List<java.lang.String> thingsToKill, + boolean negateAnimals, + boolean negateMonsters) +
      Determines whether the specified creature should be killed.
      +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        purgeWorlds

        +
        void purgeWorlds​(java.util.List<MultiverseWorld> worlds)
        +
        Synchronizes the given worlds with their settings.
        +
        +
        Parameters:
        +
        worlds - A list of MultiverseWorld
        +
        +
        • +
      + + + + + + + +
        +
      • +

        purgeWorld

        +
        void purgeWorld​(MultiverseWorld mvworld,
+                java.util.List<java.lang.String> thingsToKill,
+                boolean negateAnimals,
+                boolean negateMonsters)
        +
        Clear all animals/monsters that do not belong to a world according to the config.
        +
        +
        Parameters:
        +
        mvworld - The MultiverseWorld.
        +
        thingsToKill - A List of animals/monsters to be killed.
        +
        negateAnimals - Whether the monsters in the list should be negated.
        +
        negateMonsters - Whether the animals in the list should be negated.
        +
        +
        • +
      + + + +
        +
      • +

        purgeWorld

        +
        void purgeWorld​(MultiverseWorld mvworld,
+                java.util.List<java.lang.String> thingsToKill,
+                boolean negateAnimals,
+                boolean negateMonsters,
+                org.bukkit.command.CommandSender sender)
        +
        Clear all animals/monsters that do not belong to a world according to the config.
        +
        +
        Parameters:
        +
        mvworld - The MultiverseWorld.
        +
        thingsToKill - A List of animals/monsters to be killed.
        +
        negateAnimals - Whether the monsters in the list should be negated.
        +
        negateMonsters - Whether the animals in the list should be negated.
        +
        sender - The CommandSender that initiated the action. He will/should be notified.
        +
        +
        • +
      + + + +
        +
      • +

        shouldWeKillThisCreature

        +
        boolean shouldWeKillThisCreature​(org.bukkit.entity.Entity e,
+                                 java.util.List<java.lang.String> thingsToKill,
+                                 boolean negateAnimals,
+                                 boolean negateMonsters)
        +
        Determines whether the specified creature should be killed.
        +
        +
        Parameters:
        +
        e - The creature.
        +
        thingsToKill - A List of animals/monsters to be killed.
        +
        negateAnimals - Whether the monsters in the list should be negated.
        +
        negateMonsters - Whether the animals in the list should be negated.
        +
        Returns:
        +
        true if the creature should be killed, otherwise false.
        +
        +
        • +
      + + + +
        +
      • +

        shouldWeKillThisCreature

        +
        boolean shouldWeKillThisCreature​(MultiverseWorld w,
+                                 org.bukkit.entity.Entity e)
        +
        Determines whether the specified creature should be killed and automatically reads the params from a world object.
        +
        +
        Parameters:
        +
        w - The world.
        +
        e - The creature.
        +
        Returns:
        +
        true if the creature should be killed, otherwise false.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/api/package-summary.html b/javadoc/latest/com/onarandombox/MultiverseCore/api/package-summary.html new file mode 100644 index 000000000..0b2c79e85 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/api/package-summary.html @@ -0,0 +1,266 @@ + + + + + +com.onarandombox.MultiverseCore.api (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+
+
+

Package com.onarandombox.MultiverseCore.api

+
+
+
+ + +
The Multiverse-API, containing lots of interfaces that can be quite useful for other + plugins when interacting with Multiverse.
+
+
    +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Interface Summary 
    InterfaceDescription
    BlockSafety +
    Used to get block/location-related information.
    +
    Core +
    Multiverse 2 Core API
    +
    FancyText +
    A fancy text.
    +
    LocationManipulation +
    Used to manipulate locations.
    +
    LoggablePluginDeprecated. +
    Replaced by Logging.
    +
    MultiverseCoreConfig +
    The configuration of MultiverseCore.
    +
    MultiverseMessaging +
    Multiverse-messaging.
    +
    MultiverseWorld +
    The API for a Multiverse Handled World.
    +
    MVDestination +
    A destination API for Multiverse + Any plugin can add these to MV and when they are, any action that uses them (portals, MVTP, etc.) can use them!
    +
    MVPlugin +
    This interface is implemented by every official Multiverse-plugin.
    +
    MVWorldManager +
    Multiverse 2 World Manager API
    +
    SafeTTeleporter +
    Used to safely teleport people.
    +
    Teleporter 
    WorldPurger +
    Used to remove animals from worlds that don't belong there.
    +
    +
    • +
  • + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    MultiversePlugin +
    Make things easier for MV-Plugins!
    +
    +
    • +
+
+
+ + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/api/package-tree.html b/javadoc/latest/com/onarandombox/MultiverseCore/api/package-tree.html new file mode 100644 index 000000000..60ffdd331 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/api/package-tree.html @@ -0,0 +1,198 @@ + + + + + +com.onarandombox.MultiverseCore.api Class Hierarchy (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package com.onarandombox.MultiverseCore.api

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+
    +
  • java.lang.Object +
      +
    • org.bukkit.plugin.PluginBase (implements org.bukkit.plugin.Plugin) +
        +
      • org.bukkit.plugin.java.JavaPlugin + +
        • +
      +
      • +
    +
    • +
+
+
+

Interface Hierarchy

+ +
+
+
+ + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/commands/AnchorCommand.html b/javadoc/latest/com/onarandombox/MultiverseCore/commands/AnchorCommand.html new file mode 100644 index 000000000..18a3c4a9d --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/commands/AnchorCommand.html @@ -0,0 +1,436 @@ + + + + + +AnchorCommand (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.commands
+

Class AnchorCommand

+
+
+ +
+
    +
  • +
    +
    public class AnchorCommand
+extends PaginatedCoreCommand<java.lang.String>
    +
    Allows management of Anchor Destinations.
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    + +
    + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      protected java.util.List<java.lang.String>getFilteredItems​(java.util.List<java.lang.String> availableItems, + java.lang.String filter) +
      Gets filtered items.
      +
      protected java.lang.StringgetItemText​(java.lang.String item) +
      Converts an item into a string.
      +
      voidrunCommand​(org.bukkit.command.CommandSender sender, + java.util.List<java.lang.String> args) 
      + +
        +
      • + + +

        Methods inherited from class com.pneumaticraft.commandhandler.Command

        +addAdditonalPermission, addCommandExample, addKey, addKey, checkArgLength, getAllPermissionStrings, getCommandDesc, getCommandExamples, getCommandName, getCommandUsage, getKey, getKeys, getKeyStrings, getMaxArgs, getMinArgs, getNumKeyArgs, getPermission, getPermissionString, getPlugin, isOpRequired, removeKeyArgs, setArgRange, setCommandUsage, setName, setPermission, setPermission, showHelp
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        runCommand

        +
        public void runCommand​(org.bukkit.command.CommandSender sender,
+                       java.util.List<java.lang.String> args)
        +
        +
        Specified by:
        +
        runCommand in class com.pneumaticraft.commandhandler.Command
        +
        +
        • +
      + + + +
        +
      • +

        getFilteredItems

        +
        protected java.util.List<java.lang.String> getFilteredItems​(java.util.List<java.lang.String> availableItems,
+                                                            java.lang.String filter)
        +
        Description copied from class: PaginatedCommand
        +
        Gets filtered items.
        +
        +
        Specified by:
        +
        getFilteredItems in class PaginatedCommand<java.lang.String>
        +
        Parameters:
        +
        availableItems - All available items.
        +
        filter - The filter-String.
        +
        Returns:
        +
        A list of items that match the filter.
        +
        +
        • +
      + + + +
        +
      • +

        getItemText

        +
        protected java.lang.String getItemText​(java.lang.String item)
        +
        Description copied from class: PaginatedCommand
        +
        Converts an item into a string.
        +
        +
        Specified by:
        +
        getItemText in class PaginatedCommand<java.lang.String>
        +
        Parameters:
        +
        item - The item.
        +
        Returns:
        +
        A String.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/commands/CheckCommand.html b/javadoc/latest/com/onarandombox/MultiverseCore/commands/CheckCommand.html new file mode 100644 index 000000000..9ead266f5 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/commands/CheckCommand.html @@ -0,0 +1,345 @@ + + + + + +CheckCommand (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.commands
+

Class CheckCommand

+
+
+ +
+
    +
  • +
    +
    public class CheckCommand
+extends MultiverseCommand
    +
    Checks to see if a player can go to a destination.
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      voidrunCommand​(org.bukkit.command.CommandSender sender, + java.util.List<java.lang.String> args) 
      +
        +
      • + + +

        Methods inherited from class com.pneumaticraft.commandhandler.Command

        +addAdditonalPermission, addCommandExample, addKey, addKey, checkArgLength, getAllPermissionStrings, getCommandDesc, getCommandExamples, getCommandName, getCommandUsage, getKey, getKeys, getKeyStrings, getMaxArgs, getMinArgs, getNumKeyArgs, getPermission, getPermissionString, getPlugin, isOpRequired, removeKeyArgs, setArgRange, setCommandUsage, setName, setPermission, setPermission, showHelp
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        runCommand

        +
        public void runCommand​(org.bukkit.command.CommandSender sender,
+                       java.util.List<java.lang.String> args)
        +
        +
        Specified by:
        +
        runCommand in class MultiverseCommand
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/commands/CloneCommand.html b/javadoc/latest/com/onarandombox/MultiverseCore/commands/CloneCommand.html new file mode 100644 index 000000000..32e4a2225 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/commands/CloneCommand.html @@ -0,0 +1,345 @@ + + + + + +CloneCommand (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.commands
+

Class CloneCommand

+
+
+ +
+
    +
  • +
    +
    public class CloneCommand
+extends MultiverseCommand
    +
    Creates a clone of a world.
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      voidrunCommand​(org.bukkit.command.CommandSender sender, + java.util.List<java.lang.String> args) 
      +
        +
      • + + +

        Methods inherited from class com.pneumaticraft.commandhandler.Command

        +addAdditonalPermission, addCommandExample, addKey, addKey, checkArgLength, getAllPermissionStrings, getCommandDesc, getCommandExamples, getCommandName, getCommandUsage, getKey, getKeys, getKeyStrings, getMaxArgs, getMinArgs, getNumKeyArgs, getPermission, getPermissionString, getPlugin, isOpRequired, removeKeyArgs, setArgRange, setCommandUsage, setName, setPermission, setPermission, showHelp
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        runCommand

        +
        public void runCommand​(org.bukkit.command.CommandSender sender,
+                       java.util.List<java.lang.String> args)
        +
        +
        Specified by:
        +
        runCommand in class MultiverseCommand
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/commands/ConfigCommand.html b/javadoc/latest/com/onarandombox/MultiverseCore/commands/ConfigCommand.html new file mode 100644 index 000000000..b505f5d38 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/commands/ConfigCommand.html @@ -0,0 +1,345 @@ + + + + + +ConfigCommand (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.commands
+

Class ConfigCommand

+
+
+ +
+
    +
  • +
    +
    public class ConfigCommand
+extends MultiverseCommand
    +
    Allows you to set Global MV Variables.
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      voidrunCommand​(org.bukkit.command.CommandSender sender, + java.util.List<java.lang.String> args) 
      +
        +
      • + + +

        Methods inherited from class com.pneumaticraft.commandhandler.Command

        +addAdditonalPermission, addCommandExample, addKey, addKey, checkArgLength, getAllPermissionStrings, getCommandDesc, getCommandExamples, getCommandName, getCommandUsage, getKey, getKeys, getKeyStrings, getMaxArgs, getMinArgs, getNumKeyArgs, getPermission, getPermissionString, getPlugin, isOpRequired, removeKeyArgs, setArgRange, setCommandUsage, setName, setPermission, setPermission, showHelp
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        runCommand

        +
        public void runCommand​(org.bukkit.command.CommandSender sender,
+                       java.util.List<java.lang.String> args)
        +
        +
        Specified by:
        +
        runCommand in class MultiverseCommand
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/commands/ConfirmCommand.html b/javadoc/latest/com/onarandombox/MultiverseCore/commands/ConfirmCommand.html new file mode 100644 index 000000000..66e46d2c0 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/commands/ConfirmCommand.html @@ -0,0 +1,345 @@ + + + + + +ConfirmCommand (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.commands
+

Class ConfirmCommand

+
+
+ +
+ +
+
+
    +
  • + +
    + +
    + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      voidrunCommand​(org.bukkit.command.CommandSender sender, + java.util.List<java.lang.String> args) 
      +
        +
      • + + +

        Methods inherited from class com.pneumaticraft.commandhandler.Command

        +addAdditonalPermission, addCommandExample, addKey, addKey, checkArgLength, getAllPermissionStrings, getCommandDesc, getCommandExamples, getCommandName, getCommandUsage, getKey, getKeys, getKeyStrings, getMaxArgs, getMinArgs, getNumKeyArgs, getPermission, getPermissionString, getPlugin, isOpRequired, removeKeyArgs, setArgRange, setCommandUsage, setName, setPermission, setPermission, showHelp
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        ConfirmCommand

        +
        public ConfirmCommand​(MultiverseCore plugin)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        runCommand

        +
        public void runCommand​(org.bukkit.command.CommandSender sender,
+                       java.util.List<java.lang.String> args)
        +
        +
        Specified by:
        +
        runCommand in class MultiverseCommand
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/commands/CoordCommand.html b/javadoc/latest/com/onarandombox/MultiverseCore/commands/CoordCommand.html new file mode 100644 index 000000000..94a9fded4 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/commands/CoordCommand.html @@ -0,0 +1,345 @@ + + + + + +CoordCommand (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.commands
+

Class CoordCommand

+
+
+ +
+
    +
  • +
    +
    public class CoordCommand
+extends MultiverseCommand
    +
    Returns detailed information on the Players where abouts.
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      voidrunCommand​(org.bukkit.command.CommandSender sender, + java.util.List<java.lang.String> args) 
      +
        +
      • + + +

        Methods inherited from class com.pneumaticraft.commandhandler.Command

        +addAdditonalPermission, addCommandExample, addKey, addKey, checkArgLength, getAllPermissionStrings, getCommandDesc, getCommandExamples, getCommandName, getCommandUsage, getKey, getKeys, getKeyStrings, getMaxArgs, getMinArgs, getNumKeyArgs, getPermission, getPermissionString, getPlugin, isOpRequired, removeKeyArgs, setArgRange, setCommandUsage, setName, setPermission, setPermission, showHelp
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        runCommand

        +
        public void runCommand​(org.bukkit.command.CommandSender sender,
+                       java.util.List<java.lang.String> args)
        +
        +
        Specified by:
        +
        runCommand in class MultiverseCommand
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/commands/CreateCommand.html b/javadoc/latest/com/onarandombox/MultiverseCore/commands/CreateCommand.html new file mode 100644 index 000000000..a80b405dd --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/commands/CreateCommand.html @@ -0,0 +1,345 @@ + + + + + +CreateCommand (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.commands
+

Class CreateCommand

+
+
+ +
+
    +
  • +
    +
    public class CreateCommand
+extends MultiverseCommand
    +
    Creates a new world and loads it.
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      voidrunCommand​(org.bukkit.command.CommandSender sender, + java.util.List<java.lang.String> args) 
      +
        +
      • + + +

        Methods inherited from class com.pneumaticraft.commandhandler.Command

        +addAdditonalPermission, addCommandExample, addKey, addKey, checkArgLength, getAllPermissionStrings, getCommandDesc, getCommandExamples, getCommandName, getCommandUsage, getKey, getKeys, getKeyStrings, getMaxArgs, getMinArgs, getNumKeyArgs, getPermission, getPermissionString, getPlugin, isOpRequired, removeKeyArgs, setArgRange, setCommandUsage, setName, setPermission, setPermission, showHelp
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        runCommand

        +
        public void runCommand​(org.bukkit.command.CommandSender sender,
+                       java.util.List<java.lang.String> args)
        +
        +
        Specified by:
        +
        runCommand in class MultiverseCommand
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/commands/DebugCommand.html b/javadoc/latest/com/onarandombox/MultiverseCore/commands/DebugCommand.html new file mode 100644 index 000000000..fa51fd9b2 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/commands/DebugCommand.html @@ -0,0 +1,345 @@ + + + + + +DebugCommand (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.commands
+

Class DebugCommand

+
+
+ +
+
    +
  • +
    +
    public class DebugCommand
+extends MultiverseCommand
    +
    Enables debug-information.
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      voidrunCommand​(org.bukkit.command.CommandSender sender, + java.util.List<java.lang.String> args) 
      +
        +
      • + + +

        Methods inherited from class com.pneumaticraft.commandhandler.Command

        +addAdditonalPermission, addCommandExample, addKey, addKey, checkArgLength, getAllPermissionStrings, getCommandDesc, getCommandExamples, getCommandName, getCommandUsage, getKey, getKeys, getKeyStrings, getMaxArgs, getMinArgs, getNumKeyArgs, getPermission, getPermissionString, getPlugin, isOpRequired, removeKeyArgs, setArgRange, setCommandUsage, setName, setPermission, setPermission, showHelp
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        runCommand

        +
        public void runCommand​(org.bukkit.command.CommandSender sender,
+                       java.util.List<java.lang.String> args)
        +
        +
        Specified by:
        +
        runCommand in class MultiverseCommand
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/commands/DeleteCommand.html b/javadoc/latest/com/onarandombox/MultiverseCore/commands/DeleteCommand.html new file mode 100644 index 000000000..a7254511f --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/commands/DeleteCommand.html @@ -0,0 +1,345 @@ + + + + + +DeleteCommand (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.commands
+

Class DeleteCommand

+
+
+ +
+ +
+
+
    +
  • + +
    + +
    + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      voidrunCommand​(org.bukkit.command.CommandSender sender, + java.util.List<java.lang.String> args) 
      +
        +
      • + + +

        Methods inherited from class com.pneumaticraft.commandhandler.Command

        +addAdditonalPermission, addCommandExample, addKey, addKey, checkArgLength, getAllPermissionStrings, getCommandDesc, getCommandExamples, getCommandName, getCommandUsage, getKey, getKeys, getKeyStrings, getMaxArgs, getMinArgs, getNumKeyArgs, getPermission, getPermissionString, getPlugin, isOpRequired, removeKeyArgs, setArgRange, setCommandUsage, setName, setPermission, setPermission, showHelp
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        runCommand

        +
        public void runCommand​(org.bukkit.command.CommandSender sender,
+                       java.util.List<java.lang.String> args)
        +
        +
        Specified by:
        +
        runCommand in class MultiverseCommand
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/commands/EnvironmentCommand.html b/javadoc/latest/com/onarandombox/MultiverseCore/commands/EnvironmentCommand.html new file mode 100644 index 000000000..4edbd38c1 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/commands/EnvironmentCommand.html @@ -0,0 +1,433 @@ + + + + + +EnvironmentCommand (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.commands
+

Class EnvironmentCommand

+
+
+ +
+
    +
  • +
    +
    public class EnvironmentCommand
+extends MultiverseCommand
    +
    Lists valid known environments.
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      static org.bukkit.World.EnvironmentgetEnvFromString​(java.lang.String env) +
      Converts a String into an World.Environment.
      +
      static org.bukkit.WorldTypegetWorldTypeFromString​(java.lang.String type) +
      Converts a String into a WorldType.
      +
      voidrunCommand​(org.bukkit.command.CommandSender sender, + java.util.List<java.lang.String> args) 
      static voidshowEnvironments​(org.bukkit.command.CommandSender sender) +
      Shows all valid known environments to a CommandSender.
      +
      static voidshowWorldTypes​(org.bukkit.command.CommandSender sender) +
      Shows all valid known world types to a CommandSender.
      +
      +
        +
      • + + +

        Methods inherited from class com.pneumaticraft.commandhandler.Command

        +addAdditonalPermission, addCommandExample, addKey, addKey, checkArgLength, getAllPermissionStrings, getCommandDesc, getCommandExamples, getCommandName, getCommandUsage, getKey, getKeys, getKeyStrings, getMaxArgs, getMinArgs, getNumKeyArgs, getPermission, getPermissionString, getPlugin, isOpRequired, removeKeyArgs, setArgRange, setCommandUsage, setName, setPermission, setPermission, showHelp
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        EnvironmentCommand

        +
        public EnvironmentCommand​(MultiverseCore plugin)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        showEnvironments

        +
        public static void showEnvironments​(org.bukkit.command.CommandSender sender)
        +
        Shows all valid known environments to a CommandSender.
        +
        +
        Parameters:
        +
        sender - The CommandSender.
        +
        +
        • +
      + + + +
        +
      • +

        showWorldTypes

        +
        public static void showWorldTypes​(org.bukkit.command.CommandSender sender)
        +
        Shows all valid known world types to a CommandSender.
        +
        +
        Parameters:
        +
        sender - The CommandSender.
        +
        +
        • +
      + + + +
        +
      • +

        runCommand

        +
        public void runCommand​(org.bukkit.command.CommandSender sender,
+                       java.util.List<java.lang.String> args)
        +
        +
        Specified by:
        +
        runCommand in class MultiverseCommand
        +
        +
        • +
      + + + +
        +
      • +

        getWorldTypeFromString

        +
        public static org.bukkit.WorldType getWorldTypeFromString​(java.lang.String type)
        +
        Converts a String into a WorldType.
        +
        +
        Parameters:
        +
        type - The WorldType as a String
        +
        Returns:
        +
        The WorldType as a WorldType
        +
        +
        • +
      + + + +
        +
      • +

        getEnvFromString

        +
        public static org.bukkit.World.Environment getEnvFromString​(java.lang.String env)
        +
        Converts a String into an World.Environment.
        +
        +
        Parameters:
        +
        env - The environment as String
        +
        Returns:
        +
        The environment as World.Environment
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/commands/GameruleCommand.html b/javadoc/latest/com/onarandombox/MultiverseCore/commands/GameruleCommand.html new file mode 100644 index 000000000..895dd9153 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/commands/GameruleCommand.html @@ -0,0 +1,345 @@ + + + + + +GameruleCommand (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.commands
+

Class GameruleCommand

+
+
+ +
+
    +
  • +
    +
    public class GameruleCommand
+extends MultiverseCommand
    +
    Allows management of Anchor Destinations.
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      voidrunCommand​(org.bukkit.command.CommandSender sender, + java.util.List<java.lang.String> args) 
      +
        +
      • + + +

        Methods inherited from class com.pneumaticraft.commandhandler.Command

        +addAdditonalPermission, addCommandExample, addKey, addKey, checkArgLength, getAllPermissionStrings, getCommandDesc, getCommandExamples, getCommandName, getCommandUsage, getKey, getKeys, getKeyStrings, getMaxArgs, getMinArgs, getNumKeyArgs, getPermission, getPermissionString, getPlugin, isOpRequired, removeKeyArgs, setArgRange, setCommandUsage, setName, setPermission, setPermission, showHelp
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        GameruleCommand

        +
        public GameruleCommand​(MultiverseCore plugin)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        runCommand

        +
        public void runCommand​(org.bukkit.command.CommandSender sender,
+                       java.util.List<java.lang.String> args)
        +
        +
        Specified by:
        +
        runCommand in class MultiverseCommand
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/commands/GamerulesCommand.html b/javadoc/latest/com/onarandombox/MultiverseCore/commands/GamerulesCommand.html new file mode 100644 index 000000000..0ee568d0a --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/commands/GamerulesCommand.html @@ -0,0 +1,345 @@ + + + + + +GamerulesCommand (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.commands
+

Class GamerulesCommand

+
+
+ +
+
    +
  • +
    +
    public class GamerulesCommand
+extends MultiverseCommand
    +
    Allows management of Anchor Destinations.
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      voidrunCommand​(org.bukkit.command.CommandSender sender, + java.util.List<java.lang.String> args) 
      +
        +
      • + + +

        Methods inherited from class com.pneumaticraft.commandhandler.Command

        +addAdditonalPermission, addCommandExample, addKey, addKey, checkArgLength, getAllPermissionStrings, getCommandDesc, getCommandExamples, getCommandName, getCommandUsage, getKey, getKeys, getKeyStrings, getMaxArgs, getMinArgs, getNumKeyArgs, getPermission, getPermissionString, getPlugin, isOpRequired, removeKeyArgs, setArgRange, setCommandUsage, setName, setPermission, setPermission, showHelp
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        GamerulesCommand

        +
        public GamerulesCommand​(MultiverseCore plugin)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        runCommand

        +
        public void runCommand​(org.bukkit.command.CommandSender sender,
+                       java.util.List<java.lang.String> args)
        +
        +
        Specified by:
        +
        runCommand in class MultiverseCommand
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/commands/GeneratorCommand.html b/javadoc/latest/com/onarandombox/MultiverseCore/commands/GeneratorCommand.html new file mode 100644 index 000000000..22ba46db6 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/commands/GeneratorCommand.html @@ -0,0 +1,345 @@ + + + + + +GeneratorCommand (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.commands
+

Class GeneratorCommand

+
+
+ +
+
    +
  • +
    +
    public class GeneratorCommand
+extends MultiverseCommand
    +
    Returns a list of loaded generator plugins.
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      voidrunCommand​(org.bukkit.command.CommandSender sender, + java.util.List<java.lang.String> args) 
      +
        +
      • + + +

        Methods inherited from class com.pneumaticraft.commandhandler.Command

        +addAdditonalPermission, addCommandExample, addKey, addKey, checkArgLength, getAllPermissionStrings, getCommandDesc, getCommandExamples, getCommandName, getCommandUsage, getKey, getKeys, getKeyStrings, getMaxArgs, getMinArgs, getNumKeyArgs, getPermission, getPermissionString, getPlugin, isOpRequired, removeKeyArgs, setArgRange, setCommandUsage, setName, setPermission, setPermission, showHelp
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        GeneratorCommand

        +
        public GeneratorCommand​(MultiverseCore plugin)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        runCommand

        +
        public void runCommand​(org.bukkit.command.CommandSender sender,
+                       java.util.List<java.lang.String> args)
        +
        +
        Specified by:
        +
        runCommand in class MultiverseCommand
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/commands/HelpCommand.html b/javadoc/latest/com/onarandombox/MultiverseCore/commands/HelpCommand.html new file mode 100644 index 000000000..004f9c73a --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/commands/HelpCommand.html @@ -0,0 +1,436 @@ + + + + + +HelpCommand (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.commands
+

Class HelpCommand

+
+
+ +
+
    +
  • +
    +
    public class HelpCommand
+extends PaginatedCoreCommand<com.pneumaticraft.commandhandler.Command>
    +
    Displays a nice help menu.
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    + +
    + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      protected java.util.List<com.pneumaticraft.commandhandler.Command>getFilteredItems​(java.util.List<com.pneumaticraft.commandhandler.Command> availableItems, + java.lang.String filter) +
      Gets filtered items.
      +
      protected java.lang.StringgetItemText​(com.pneumaticraft.commandhandler.Command item) +
      Converts an item into a string.
      +
      voidrunCommand​(org.bukkit.command.CommandSender sender, + java.util.List<java.lang.String> args) 
      + +
        +
      • + + +

        Methods inherited from class com.pneumaticraft.commandhandler.Command

        +addAdditonalPermission, addCommandExample, addKey, addKey, checkArgLength, getAllPermissionStrings, getCommandDesc, getCommandExamples, getCommandName, getCommandUsage, getKey, getKeys, getKeyStrings, getMaxArgs, getMinArgs, getNumKeyArgs, getPermission, getPermissionString, getPlugin, isOpRequired, removeKeyArgs, setArgRange, setCommandUsage, setName, setPermission, setPermission, showHelp
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        getFilteredItems

        +
        protected java.util.List<com.pneumaticraft.commandhandler.Command> getFilteredItems​(java.util.List<com.pneumaticraft.commandhandler.Command> availableItems,
+                                                                                    java.lang.String filter)
        +
        Description copied from class: PaginatedCommand
        +
        Gets filtered items.
        +
        +
        Specified by:
        +
        getFilteredItems in class PaginatedCommand<com.pneumaticraft.commandhandler.Command>
        +
        Parameters:
        +
        availableItems - All available items.
        +
        filter - The filter-String.
        +
        Returns:
        +
        A list of items that match the filter.
        +
        +
        • +
      + + + +
        +
      • +

        getItemText

        +
        protected java.lang.String getItemText​(com.pneumaticraft.commandhandler.Command item)
        +
        Description copied from class: PaginatedCommand
        +
        Converts an item into a string.
        +
        +
        Specified by:
        +
        getItemText in class PaginatedCommand<com.pneumaticraft.commandhandler.Command>
        +
        Parameters:
        +
        item - The item.
        +
        Returns:
        +
        A String.
        +
        +
        • +
      + + + +
        +
      • +

        runCommand

        +
        public void runCommand​(org.bukkit.command.CommandSender sender,
+                       java.util.List<java.lang.String> args)
        +
        +
        Specified by:
        +
        runCommand in class com.pneumaticraft.commandhandler.Command
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/commands/ImportCommand.html b/javadoc/latest/com/onarandombox/MultiverseCore/commands/ImportCommand.html new file mode 100644 index 000000000..74550ecaa --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/commands/ImportCommand.html @@ -0,0 +1,345 @@ + + + + + +ImportCommand (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.commands
+

Class ImportCommand

+
+
+ +
+
    +
  • +
    +
    public class ImportCommand
+extends MultiverseCommand
    +
    Imports a new world of the specified type.
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      voidrunCommand​(org.bukkit.command.CommandSender sender, + java.util.List<java.lang.String> args) 
      +
        +
      • + + +

        Methods inherited from class com.pneumaticraft.commandhandler.Command

        +addAdditonalPermission, addCommandExample, addKey, addKey, checkArgLength, getAllPermissionStrings, getCommandDesc, getCommandExamples, getCommandName, getCommandUsage, getKey, getKeys, getKeyStrings, getMaxArgs, getMinArgs, getNumKeyArgs, getPermission, getPermissionString, getPlugin, isOpRequired, removeKeyArgs, setArgRange, setCommandUsage, setName, setPermission, setPermission, showHelp
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        runCommand

        +
        public void runCommand​(org.bukkit.command.CommandSender sender,
+                       java.util.List<java.lang.String> args)
        +
        +
        Specified by:
        +
        runCommand in class MultiverseCommand
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/commands/InfoCommand.html b/javadoc/latest/com/onarandombox/MultiverseCore/commands/InfoCommand.html new file mode 100644 index 000000000..fbc2f8132 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/commands/InfoCommand.html @@ -0,0 +1,368 @@ + + + + + +InfoCommand (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.commands
+

Class InfoCommand

+
+
+ +
+
    +
  • +
    +
    public class InfoCommand
+extends MultiverseCommand
    +
    Returns detailed information about a world.
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      protected org.bukkit.ChatColorgetChatColor​(boolean positive) +
      Gets a "positive" or "negative" ChatColor.
      +
      voidrunCommand​(org.bukkit.command.CommandSender sender, + java.util.List<java.lang.String> args) 
      +
        +
      • + + +

        Methods inherited from class com.pneumaticraft.commandhandler.Command

        +addAdditonalPermission, addCommandExample, addKey, addKey, checkArgLength, getAllPermissionStrings, getCommandDesc, getCommandExamples, getCommandName, getCommandUsage, getKey, getKeys, getKeyStrings, getMaxArgs, getMinArgs, getNumKeyArgs, getPermission, getPermissionString, getPlugin, isOpRequired, removeKeyArgs, setArgRange, setCommandUsage, setName, setPermission, setPermission, showHelp
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        runCommand

        +
        public void runCommand​(org.bukkit.command.CommandSender sender,
+                       java.util.List<java.lang.String> args)
        +
        +
        Specified by:
        +
        runCommand in class MultiverseCommand
        +
        +
        • +
      + + + +
        +
      • +

        getChatColor

        +
        protected org.bukkit.ChatColor getChatColor​(boolean positive)
        +
        Gets a "positive" or "negative" ChatColor.
        +
        +
        Parameters:
        +
        positive - Whether this ChatColor should be "positive".
        +
        Returns:
        +
        The ChatColor.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/commands/ListCommand.html b/javadoc/latest/com/onarandombox/MultiverseCore/commands/ListCommand.html new file mode 100644 index 000000000..d37ecd9a6 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/commands/ListCommand.html @@ -0,0 +1,345 @@ + + + + + +ListCommand (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.commands
+

Class ListCommand

+
+
+ +
+
    +
  • +
    +
    public class ListCommand
+extends MultiverseCommand
    +
    Displays a listing of all worlds that a player can enter.
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      voidrunCommand​(org.bukkit.command.CommandSender sender, + java.util.List<java.lang.String> args) 
      +
        +
      • + + +

        Methods inherited from class com.pneumaticraft.commandhandler.Command

        +addAdditonalPermission, addCommandExample, addKey, addKey, checkArgLength, getAllPermissionStrings, getCommandDesc, getCommandExamples, getCommandName, getCommandUsage, getKey, getKeys, getKeyStrings, getMaxArgs, getMinArgs, getNumKeyArgs, getPermission, getPermissionString, getPlugin, isOpRequired, removeKeyArgs, setArgRange, setCommandUsage, setName, setPermission, setPermission, showHelp
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        runCommand

        +
        public void runCommand​(org.bukkit.command.CommandSender sender,
+                       java.util.List<java.lang.String> args)
        +
        +
        Specified by:
        +
        runCommand in class MultiverseCommand
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/commands/LoadCommand.html b/javadoc/latest/com/onarandombox/MultiverseCore/commands/LoadCommand.html new file mode 100644 index 000000000..80963363d --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/commands/LoadCommand.html @@ -0,0 +1,345 @@ + + + + + +LoadCommand (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.commands
+

Class LoadCommand

+
+
+ +
+
    +
  • +
    +
    public class LoadCommand
+extends MultiverseCommand
    +
    Loads a world into Multiverse.
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      voidrunCommand​(org.bukkit.command.CommandSender sender, + java.util.List<java.lang.String> args) 
      +
        +
      • + + +

        Methods inherited from class com.pneumaticraft.commandhandler.Command

        +addAdditonalPermission, addCommandExample, addKey, addKey, checkArgLength, getAllPermissionStrings, getCommandDesc, getCommandExamples, getCommandName, getCommandUsage, getKey, getKeys, getKeyStrings, getMaxArgs, getMinArgs, getNumKeyArgs, getPermission, getPermissionString, getPlugin, isOpRequired, removeKeyArgs, setArgRange, setCommandUsage, setName, setPermission, setPermission, showHelp
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        runCommand

        +
        public void runCommand​(org.bukkit.command.CommandSender sender,
+                       java.util.List<java.lang.String> args)
        +
        +
        Specified by:
        +
        runCommand in class MultiverseCommand
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/commands/ModifyAddCommand.html b/javadoc/latest/com/onarandombox/MultiverseCore/commands/ModifyAddCommand.html new file mode 100644 index 000000000..4c53fa13c --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/commands/ModifyAddCommand.html @@ -0,0 +1,345 @@ + + + + + +ModifyAddCommand (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.commands
+

Class ModifyAddCommand

+
+
+ +
+
    +
  • +
    +
    public class ModifyAddCommand
+extends MultiverseCommand
    +
    Used to modify various aspects of worlds.
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      voidrunCommand​(org.bukkit.command.CommandSender sender, + java.util.List<java.lang.String> args) 
      +
        +
      • + + +

        Methods inherited from class com.pneumaticraft.commandhandler.Command

        +addAdditonalPermission, addCommandExample, addKey, addKey, checkArgLength, getAllPermissionStrings, getCommandDesc, getCommandExamples, getCommandName, getCommandUsage, getKey, getKeys, getKeyStrings, getMaxArgs, getMinArgs, getNumKeyArgs, getPermission, getPermissionString, getPlugin, isOpRequired, removeKeyArgs, setArgRange, setCommandUsage, setName, setPermission, setPermission, showHelp
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        ModifyAddCommand

        +
        public ModifyAddCommand​(MultiverseCore plugin)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        runCommand

        +
        public void runCommand​(org.bukkit.command.CommandSender sender,
+                       java.util.List<java.lang.String> args)
        +
        +
        Specified by:
        +
        runCommand in class MultiverseCommand
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/commands/ModifyClearCommand.html b/javadoc/latest/com/onarandombox/MultiverseCore/commands/ModifyClearCommand.html new file mode 100644 index 000000000..3a792b53c --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/commands/ModifyClearCommand.html @@ -0,0 +1,345 @@ + + + + + +ModifyClearCommand (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.commands
+

Class ModifyClearCommand

+
+
+ +
+
    +
  • +
    +
    public class ModifyClearCommand
+extends MultiverseCommand
    +
    Removes all values from a world-property.
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      voidrunCommand​(org.bukkit.command.CommandSender sender, + java.util.List<java.lang.String> args) 
      +
        +
      • + + +

        Methods inherited from class com.pneumaticraft.commandhandler.Command

        +addAdditonalPermission, addCommandExample, addKey, addKey, checkArgLength, getAllPermissionStrings, getCommandDesc, getCommandExamples, getCommandName, getCommandUsage, getKey, getKeys, getKeyStrings, getMaxArgs, getMinArgs, getNumKeyArgs, getPermission, getPermissionString, getPlugin, isOpRequired, removeKeyArgs, setArgRange, setCommandUsage, setName, setPermission, setPermission, showHelp
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        ModifyClearCommand

        +
        public ModifyClearCommand​(MultiverseCore plugin)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        runCommand

        +
        public void runCommand​(org.bukkit.command.CommandSender sender,
+                       java.util.List<java.lang.String> args)
        +
        +
        Specified by:
        +
        runCommand in class MultiverseCommand
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/commands/ModifyCommand.html b/javadoc/latest/com/onarandombox/MultiverseCore/commands/ModifyCommand.html new file mode 100644 index 000000000..5cb99ca3e --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/commands/ModifyCommand.html @@ -0,0 +1,371 @@ + + + + + +ModifyCommand (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.commands
+

Class ModifyCommand

+
+
+ +
+
    +
  • +
    +
    public class ModifyCommand
+extends MultiverseCommand
    +
    Used to modify various aspects of worlds.
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      voidrunCommand​(org.bukkit.command.CommandSender sender, + java.util.List<java.lang.String> args) 
      protected static booleanvalidateAction​(Action action, + java.lang.String property) +
      Validates the specified action.
      +
      +
        +
      • + + +

        Methods inherited from class com.pneumaticraft.commandhandler.Command

        +addAdditonalPermission, addCommandExample, addKey, addKey, checkArgLength, getAllPermissionStrings, getCommandDesc, getCommandExamples, getCommandName, getCommandUsage, getKey, getKeys, getKeyStrings, getMaxArgs, getMinArgs, getNumKeyArgs, getPermission, getPermissionString, getPlugin, isOpRequired, removeKeyArgs, setArgRange, setCommandUsage, setName, setPermission, setPermission, showHelp
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        validateAction

        +
        protected static boolean validateAction​(Action action,
+                                        java.lang.String property)
        +
        Validates the specified action.
        +
        +
        Parameters:
        +
        action - The Action.
        +
        property - The property.
        +
        Returns:
        +
        Whether this action is valid.
        +
        +
        • +
      + + + +
        +
      • +

        runCommand

        +
        public void runCommand​(org.bukkit.command.CommandSender sender,
+                       java.util.List<java.lang.String> args)
        +
        +
        Specified by:
        +
        runCommand in class MultiverseCommand
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/commands/ModifyRemoveCommand.html b/javadoc/latest/com/onarandombox/MultiverseCore/commands/ModifyRemoveCommand.html new file mode 100644 index 000000000..9d6a7dcf2 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/commands/ModifyRemoveCommand.html @@ -0,0 +1,345 @@ + + + + + +ModifyRemoveCommand (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.commands
+

Class ModifyRemoveCommand

+
+
+ +
+
    +
  • +
    +
    public class ModifyRemoveCommand
+extends MultiverseCommand
    +
    Removes values from a world-property.
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      voidrunCommand​(org.bukkit.command.CommandSender sender, + java.util.List<java.lang.String> args) 
      +
        +
      • + + +

        Methods inherited from class com.pneumaticraft.commandhandler.Command

        +addAdditonalPermission, addCommandExample, addKey, addKey, checkArgLength, getAllPermissionStrings, getCommandDesc, getCommandExamples, getCommandName, getCommandUsage, getKey, getKeys, getKeyStrings, getMaxArgs, getMinArgs, getNumKeyArgs, getPermission, getPermissionString, getPlugin, isOpRequired, removeKeyArgs, setArgRange, setCommandUsage, setName, setPermission, setPermission, showHelp
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        ModifyRemoveCommand

        +
        public ModifyRemoveCommand​(MultiverseCore plugin)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        runCommand

        +
        public void runCommand​(org.bukkit.command.CommandSender sender,
+                       java.util.List<java.lang.String> args)
        +
        +
        Specified by:
        +
        runCommand in class MultiverseCommand
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/commands/ModifySetCommand.html b/javadoc/latest/com/onarandombox/MultiverseCore/commands/ModifySetCommand.html new file mode 100644 index 000000000..9588e3ea2 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/commands/ModifySetCommand.html @@ -0,0 +1,345 @@ + + + + + +ModifySetCommand (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.commands
+

Class ModifySetCommand

+
+
+ +
+
    +
  • +
    +
    public class ModifySetCommand
+extends MultiverseCommand
    +
    Used to set world-properties.
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      voidrunCommand​(org.bukkit.command.CommandSender sender, + java.util.List<java.lang.String> args) 
      +
        +
      • + + +

        Methods inherited from class com.pneumaticraft.commandhandler.Command

        +addAdditonalPermission, addCommandExample, addKey, addKey, checkArgLength, getAllPermissionStrings, getCommandDesc, getCommandExamples, getCommandName, getCommandUsage, getKey, getKeys, getKeyStrings, getMaxArgs, getMinArgs, getNumKeyArgs, getPermission, getPermissionString, getPlugin, isOpRequired, removeKeyArgs, setArgRange, setCommandUsage, setName, setPermission, setPermission, showHelp
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        ModifySetCommand

        +
        public ModifySetCommand​(MultiverseCore plugin)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        runCommand

        +
        public void runCommand​(org.bukkit.command.CommandSender sender,
+                       java.util.List<java.lang.String> args)
        +
        +
        Specified by:
        +
        runCommand in class MultiverseCommand
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/commands/MultiverseCommand.html b/javadoc/latest/com/onarandombox/MultiverseCore/commands/MultiverseCommand.html new file mode 100644 index 000000000..47d346168 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/commands/MultiverseCommand.html @@ -0,0 +1,389 @@ + + + + + +MultiverseCommand (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.commands
+

Class MultiverseCommand

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.pneumaticraft.commandhandler.Command
      • +
    • +
        +
      • com.onarandombox.MultiverseCore.commands.MultiverseCommand
        • +
      +
      • +
    +
    • +
+
+ +
+
+
    +
  • + +
    + +
    + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethodDescription
      abstract voidrunCommand​(org.bukkit.command.CommandSender sender, + java.util.List<java.lang.String> args) 
      +
        +
      • + + +

        Methods inherited from class com.pneumaticraft.commandhandler.Command

        +addAdditonalPermission, addCommandExample, addKey, addKey, checkArgLength, getAllPermissionStrings, getCommandDesc, getCommandExamples, getCommandName, getCommandUsage, getKey, getKeys, getKeyStrings, getMaxArgs, getMinArgs, getNumKeyArgs, getPermission, getPermissionString, getPlugin, isOpRequired, removeKeyArgs, setArgRange, setCommandUsage, setName, setPermission, setPermission, showHelp
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        MultiverseCommand

        +
        public MultiverseCommand​(MultiverseCore plugin)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        runCommand

        +
        public abstract void runCommand​(org.bukkit.command.CommandSender sender,
+                                java.util.List<java.lang.String> args)
        +
        +
        Specified by:
        +
        runCommand in class com.pneumaticraft.commandhandler.Command
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/commands/PaginatedCommand.FilterObject.html b/javadoc/latest/com/onarandombox/MultiverseCore/commands/PaginatedCommand.FilterObject.html new file mode 100644 index 000000000..b49cff994 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/commands/PaginatedCommand.FilterObject.html @@ -0,0 +1,360 @@ + + + + + +PaginatedCommand.FilterObject (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.commands
+

Class PaginatedCommand.FilterObject

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.commands.PaginatedCommand.FilterObject
      • +
    +
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    PaginatedCommand<T>
    +
    +
    +
    protected class PaginatedCommand.FilterObject
+extends java.lang.Object
    +
    "Key-Object" containing information about the page and the filter that were requested.
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      FilterObject​(java.lang.Integer page, + java.lang.String filter) 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      java.lang.StringgetFilter() +
      Gets the filter.
      +
      java.lang.IntegergetPage() +
      Gets the page.
      +
      voidsetPage​(int page) +
      Sets the page.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        FilterObject

        +
        public FilterObject​(java.lang.Integer page,
+                    java.lang.String filter)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getPage

        +
        public java.lang.Integer getPage()
        +
        Gets the page.
        +
        +
        Returns:
        +
        The page.
        +
        +
        • +
      + + + +
        +
      • +

        setPage

        +
        public void setPage​(int page)
        +
        Sets the page.
        +
        +
        Parameters:
        +
        page - The new page.
        +
        +
        • +
      + + + +
        +
      • +

        getFilter

        +
        public java.lang.String getFilter()
        +
        Gets the filter.
        +
        +
        Returns:
        +
        The filter.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/commands/PaginatedCommand.html b/javadoc/latest/com/onarandombox/MultiverseCore/commands/PaginatedCommand.html new file mode 100644 index 000000000..26815ea52 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/commands/PaginatedCommand.html @@ -0,0 +1,556 @@ + + + + + +PaginatedCommand (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.commands
+

Class PaginatedCommand<T>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.pneumaticraft.commandhandler.Command
      • +
    • +
        +
      • com.onarandombox.MultiverseCore.commands.PaginatedCommand<T>
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    T - The type of items on the page.
    +
    +
    +
    Direct Known Subclasses:
    +
    PaginatedCoreCommand
    +
    +
    +
    public abstract class PaginatedCommand<T>
+extends com.pneumaticraft.commandhandler.Command
    +
    A generic paginated command.
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClassDescription
      protected class PaginatedCommand.FilterObject +
      "Key-Object" containing information about the page and the filter that were requested.
      +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      protected intitemsPerPage +
      The number of items per page.
      +
      +
        +
      • + + +

        Fields inherited from class com.pneumaticraft.commandhandler.Command

        +plugin
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      PaginatedCommand​(org.bukkit.plugin.java.JavaPlugin plugin) 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and TypeMethodDescription
      protected java.lang.StringcleanFilter​(java.lang.String filter) +
      Escape regex special characters from filter
      +
      protected abstract java.util.List<T>getFilteredItems​(java.util.List<T> availableItems, + java.lang.String filter) +
      Gets filtered items.
      +
      protected abstract java.lang.StringgetItemText​(T item) +
      Converts an item into a string.
      +
      protected PaginatedCommand.FilterObjectgetPageAndFilter​(java.util.List<java.lang.String> args) +
      Constructs a PaginatedCommand.FilterObject from a List of arguments.
      +
      protected voidsetItemsPerPage​(int items) +
      Set the number of items per page.
      +
      protected voidshowPage​(int page, + org.bukkit.command.CommandSender sender, + java.util.List<T> cmds) +
      Shows a page.
      +
      protected java.lang.StringstitchThisString​(java.util.List<java.lang.String> list) +
      Constructs a single string from a list of strings.
      +
      +
        +
      • + + +

        Methods inherited from class com.pneumaticraft.commandhandler.Command

        +addAdditonalPermission, addCommandExample, addKey, addKey, checkArgLength, getAllPermissionStrings, getCommandDesc, getCommandExamples, getCommandName, getCommandUsage, getKey, getKeys, getKeyStrings, getMaxArgs, getMinArgs, getNumKeyArgs, getPermission, getPermissionString, getPlugin, isOpRequired, removeKeyArgs, runCommand, setArgRange, setCommandUsage, setName, setPermission, setPermission, showHelp
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        itemsPerPage

        +
        protected int itemsPerPage
        +
        The number of items per page.
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PaginatedCommand

        +
        public PaginatedCommand​(org.bukkit.plugin.java.JavaPlugin plugin)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setItemsPerPage

        +
        protected void setItemsPerPage​(int items)
        +
        Set the number of items per page.
        +
        +
        Parameters:
        +
        items - The new number of items per page.
        +
        +
        • +
      + + + +
        +
      • +

        getFilteredItems

        +
        protected abstract java.util.List<T> getFilteredItems​(java.util.List<T> availableItems,
+                                                      java.lang.String filter)
        +
        Gets filtered items.
        +
        +
        Parameters:
        +
        availableItems - All available items.
        +
        filter - The filter-String.
        +
        Returns:
        +
        A list of items that match the filter.
        +
        +
        • +
      + + + +
        +
      • +

        cleanFilter

        +
        protected java.lang.String cleanFilter​(java.lang.String filter)
        +
        Escape regex special characters from filter
        +
        +
        Parameters:
        +
        filter - The filter-String.
        +
        Returns:
        +
        String with regex characters escaped
        +
        +
        • +
      + + + +
        +
      • +

        stitchThisString

        +
        protected java.lang.String stitchThisString​(java.util.List<java.lang.String> list)
        +
        Constructs a single string from a list of strings.
        +
        +
        Parameters:
        +
        list - The List of strings.
        +
        Returns:
        +
        A single String.
        +
        +
        • +
      + + + +
        +
      • +

        showPage

        +
        protected void showPage​(int page,
+                        org.bukkit.command.CommandSender sender,
+                        java.util.List<T> cmds)
        +
        Shows a page.
        +
        +
        Parameters:
        +
        page - The number of the page to show.
        +
        sender - The CommandSender that wants to see the page.
        +
        cmds - The items that should be displayed on the page.
        +
        +
        • +
      + + + + + +
        +
      • +

        getItemText

        +
        protected abstract java.lang.String getItemText​(T item)
        +
        Converts an item into a string.
        +
        +
        Parameters:
        +
        item - The item.
        +
        Returns:
        +
        A String.
        +
        +
        • +
      + + + + +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/commands/PaginatedCoreCommand.html b/javadoc/latest/com/onarandombox/MultiverseCore/commands/PaginatedCoreCommand.html new file mode 100644 index 000000000..e317cd08e --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/commands/PaginatedCoreCommand.html @@ -0,0 +1,368 @@ + + + + + +PaginatedCoreCommand (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.commands
+

Class PaginatedCoreCommand<T>

+
+
+ +
+
    +
  • +
    +
    Type Parameters:
    +
    T - The type of items on the page.
    +
    +
    +
    Direct Known Subclasses:
    +
    AnchorCommand, HelpCommand
    +
    +
    +
    public abstract class PaginatedCoreCommand<T>
+extends PaginatedCommand<T>
    +
    A generic paginated Multiverse-command.
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    + +
    + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class com.pneumaticraft.commandhandler.Command

        +addAdditonalPermission, addCommandExample, addKey, addKey, checkArgLength, getAllPermissionStrings, getCommandDesc, getCommandExamples, getCommandName, getCommandUsage, getKey, getKeys, getKeyStrings, getMaxArgs, getMinArgs, getNumKeyArgs, getPermission, getPermissionString, getPlugin, isOpRequired, removeKeyArgs, runCommand, setArgRange, setCommandUsage, setName, setPermission, setPermission, showHelp
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        PaginatedCoreCommand

        +
        public PaginatedCoreCommand​(MultiverseCore plugin)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/commands/PurgeCommand.html b/javadoc/latest/com/onarandombox/MultiverseCore/commands/PurgeCommand.html new file mode 100644 index 000000000..15b372bd7 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/commands/PurgeCommand.html @@ -0,0 +1,345 @@ + + + + + +PurgeCommand (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.commands
+

Class PurgeCommand

+
+
+ +
+
    +
  • +
    +
    public class PurgeCommand
+extends MultiverseCommand
    +
    Removes a type of mob from a world.
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      voidrunCommand​(org.bukkit.command.CommandSender sender, + java.util.List<java.lang.String> args) 
      +
        +
      • + + +

        Methods inherited from class com.pneumaticraft.commandhandler.Command

        +addAdditonalPermission, addCommandExample, addKey, addKey, checkArgLength, getAllPermissionStrings, getCommandDesc, getCommandExamples, getCommandName, getCommandUsage, getKey, getKeys, getKeyStrings, getMaxArgs, getMinArgs, getNumKeyArgs, getPermission, getPermissionString, getPlugin, isOpRequired, removeKeyArgs, setArgRange, setCommandUsage, setName, setPermission, setPermission, showHelp
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        runCommand

        +
        public void runCommand​(org.bukkit.command.CommandSender sender,
+                       java.util.List<java.lang.String> args)
        +
        +
        Specified by:
        +
        runCommand in class MultiverseCommand
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/commands/RegenCommand.html b/javadoc/latest/com/onarandombox/MultiverseCore/commands/RegenCommand.html new file mode 100644 index 000000000..541ea1e05 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/commands/RegenCommand.html @@ -0,0 +1,345 @@ + + + + + +RegenCommand (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.commands
+

Class RegenCommand

+
+
+ +
+ +
+
+
    +
  • + +
    + +
    + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      voidrunCommand​(org.bukkit.command.CommandSender sender, + java.util.List<java.lang.String> args) 
      +
        +
      • + + +

        Methods inherited from class com.pneumaticraft.commandhandler.Command

        +addAdditonalPermission, addCommandExample, addKey, addKey, checkArgLength, getAllPermissionStrings, getCommandDesc, getCommandExamples, getCommandName, getCommandUsage, getKey, getKeys, getKeyStrings, getMaxArgs, getMinArgs, getNumKeyArgs, getPermission, getPermissionString, getPlugin, isOpRequired, removeKeyArgs, setArgRange, setCommandUsage, setName, setPermission, setPermission, showHelp
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        runCommand

        +
        public void runCommand​(org.bukkit.command.CommandSender sender,
+                       java.util.List<java.lang.String> args)
        +
        +
        Specified by:
        +
        runCommand in class MultiverseCommand
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/commands/ReloadCommand.html b/javadoc/latest/com/onarandombox/MultiverseCore/commands/ReloadCommand.html new file mode 100644 index 000000000..3c87562e7 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/commands/ReloadCommand.html @@ -0,0 +1,345 @@ + + + + + +ReloadCommand (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.commands
+

Class ReloadCommand

+
+
+ +
+
    +
  • +
    +
    public class ReloadCommand
+extends MultiverseCommand
    +
    Reloads worlds.yml and config.yml.
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      voidrunCommand​(org.bukkit.command.CommandSender sender, + java.util.List<java.lang.String> args) 
      +
        +
      • + + +

        Methods inherited from class com.pneumaticraft.commandhandler.Command

        +addAdditonalPermission, addCommandExample, addKey, addKey, checkArgLength, getAllPermissionStrings, getCommandDesc, getCommandExamples, getCommandName, getCommandUsage, getKey, getKeys, getKeyStrings, getMaxArgs, getMinArgs, getNumKeyArgs, getPermission, getPermissionString, getPlugin, isOpRequired, removeKeyArgs, setArgRange, setCommandUsage, setName, setPermission, setPermission, showHelp
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        runCommand

        +
        public void runCommand​(org.bukkit.command.CommandSender sender,
+                       java.util.List<java.lang.String> args)
        +
        +
        Specified by:
        +
        runCommand in class MultiverseCommand
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/commands/RemoveCommand.html b/javadoc/latest/com/onarandombox/MultiverseCore/commands/RemoveCommand.html new file mode 100644 index 000000000..6e26c4033 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/commands/RemoveCommand.html @@ -0,0 +1,345 @@ + + + + + +RemoveCommand (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.commands
+

Class RemoveCommand

+
+
+ +
+
    +
  • +
    +
    public class RemoveCommand
+extends MultiverseCommand
    +
    Unloads a world and removes it from the config.
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      voidrunCommand​(org.bukkit.command.CommandSender sender, + java.util.List<java.lang.String> args) 
      +
        +
      • + + +

        Methods inherited from class com.pneumaticraft.commandhandler.Command

        +addAdditonalPermission, addCommandExample, addKey, addKey, checkArgLength, getAllPermissionStrings, getCommandDesc, getCommandExamples, getCommandName, getCommandUsage, getKey, getKeys, getKeyStrings, getMaxArgs, getMinArgs, getNumKeyArgs, getPermission, getPermissionString, getPlugin, isOpRequired, removeKeyArgs, setArgRange, setCommandUsage, setName, setPermission, setPermission, showHelp
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        runCommand

        +
        public void runCommand​(org.bukkit.command.CommandSender sender,
+                       java.util.List<java.lang.String> args)
        +
        +
        Specified by:
        +
        runCommand in class MultiverseCommand
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/commands/ScriptCommand.html b/javadoc/latest/com/onarandombox/MultiverseCore/commands/ScriptCommand.html new file mode 100644 index 000000000..22992cf22 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/commands/ScriptCommand.html @@ -0,0 +1,345 @@ + + + + + +ScriptCommand (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.commands
+

Class ScriptCommand

+
+
+ +
+
    +
  • +
    +
    public class ScriptCommand
+extends MultiverseCommand
    +
    States who is in what world.
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      voidrunCommand​(org.bukkit.command.CommandSender sender, + java.util.List<java.lang.String> args) 
      +
        +
      • + + +

        Methods inherited from class com.pneumaticraft.commandhandler.Command

        +addAdditonalPermission, addCommandExample, addKey, addKey, checkArgLength, getAllPermissionStrings, getCommandDesc, getCommandExamples, getCommandName, getCommandUsage, getKey, getKeys, getKeyStrings, getMaxArgs, getMinArgs, getNumKeyArgs, getPermission, getPermissionString, getPlugin, isOpRequired, removeKeyArgs, setArgRange, setCommandUsage, setName, setPermission, setPermission, showHelp
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        runCommand

        +
        public void runCommand​(org.bukkit.command.CommandSender sender,
+                       java.util.List<java.lang.String> args)
        +
        +
        Specified by:
        +
        runCommand in class MultiverseCommand
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/commands/SetSpawnCommand.html b/javadoc/latest/com/onarandombox/MultiverseCore/commands/SetSpawnCommand.html new file mode 100644 index 000000000..fa34d0531 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/commands/SetSpawnCommand.html @@ -0,0 +1,445 @@ + + + + + +SetSpawnCommand (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.commands
+

Class SetSpawnCommand

+
+
+ +
+
    +
  • +
    +
    public class SetSpawnCommand
+extends MultiverseCommand
    +
    Sets the spawn for a world.
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      voidrunCommand​(org.bukkit.command.CommandSender sender, + java.util.List<java.lang.String> args) +
      Dispatches the user's command depending on the number of parameters
      +
      protected voidsetWorldSpawn​(org.bukkit.command.CommandSender sender) +
      Set the world spawn when no parameters are given
      +
      protected voidsetWorldSpawn​(org.bukkit.command.CommandSender sender, + java.lang.String world, + java.lang.String x, + java.lang.String y, + java.lang.String z) +
      Set the world spawn when 4 parameters are given
      +
      protected voidsetWorldSpawn​(org.bukkit.command.CommandSender sender, + java.lang.String world, + java.lang.String x, + java.lang.String y, + java.lang.String z, + java.lang.String yaw, + java.lang.String pitch) +
      Set the world spawn when 6 parameters are given
      +
      +
        +
      • + + +

        Methods inherited from class com.pneumaticraft.commandhandler.Command

        +addAdditonalPermission, addCommandExample, addKey, addKey, checkArgLength, getAllPermissionStrings, getCommandDesc, getCommandExamples, getCommandName, getCommandUsage, getKey, getKeys, getKeyStrings, getMaxArgs, getMinArgs, getNumKeyArgs, getPermission, getPermissionString, getPlugin, isOpRequired, removeKeyArgs, setArgRange, setCommandUsage, setName, setPermission, setPermission, showHelp
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        SetSpawnCommand

        +
        public SetSpawnCommand​(MultiverseCore plugin)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        runCommand

        +
        public void runCommand​(org.bukkit.command.CommandSender sender,
+                       java.util.List<java.lang.String> args)
        +
        Dispatches the user's command depending on the number of parameters
        +
        +
        Specified by:
        +
        runCommand in class MultiverseCommand
        +
        Parameters:
        +
        sender - The player who executes the command, may be console as well.
        +
        args - Command line parameters
        +
        +
        • +
      + + + +
        +
      • +

        setWorldSpawn

        +
        protected void setWorldSpawn​(org.bukkit.command.CommandSender sender)
        +
        Set the world spawn when no parameters are given
        +
        +
        Parameters:
        +
        sender - The CommandSender who executes the command. + Everything not a Player, e.g. console, gets rejected, as we can't get coordinates from there.
        +
        +
        • +
      + + + +
        +
      • +

        setWorldSpawn

        +
        protected void setWorldSpawn​(org.bukkit.command.CommandSender sender,
+                             java.lang.String world,
+                             java.lang.String x,
+                             java.lang.String y,
+                             java.lang.String z)
        +
        Set the world spawn when 4 parameters are given
        +
        +
        Parameters:
        +
        sender - The CommandSender who executes the command
        +
        world - The world to set the spawn in
        +
        x - X-coordinate to set the spawn to (as a String as it's from the command line, gets parsed into a double)
        +
        y - Y-coordinate to set the spawn to (as a String as it's from the command line, gets parsed into a double)
        +
        z - Z-coordinate to set the spawn to (as a String as it's from the command line, gets parsed into a double)
        +
        +
        • +
      + + + +
        +
      • +

        setWorldSpawn

        +
        protected void setWorldSpawn​(org.bukkit.command.CommandSender sender,
+                             java.lang.String world,
+                             java.lang.String x,
+                             java.lang.String y,
+                             java.lang.String z,
+                             java.lang.String yaw,
+                             java.lang.String pitch)
        +
        Set the world spawn when 6 parameters are given
        +
        +
        Parameters:
        +
        sender - The CommandSender who executes the command
        +
        world - The world to set the spawn in
        +
        x - X-coordinate to set the spawn to (as a String as it's from the command line, gets parsed into a double)
        +
        y - Y-coordinate to set the spawn to (as a String as it's from the command line, gets parsed into a double)
        +
        z - Z-coordinate to set the spawn to (as a String as it's from the command line, gets parsed into a double)
        +
        yaw - Yaw a newly spawned player should look at (as a String as it's from the command line, gets parsed into a float)
        +
        pitch - Pitch a newly spawned player should look at (as a String as it's from the command line, gets parsed into a float)
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/commands/SilentCommand.html b/javadoc/latest/com/onarandombox/MultiverseCore/commands/SilentCommand.html new file mode 100644 index 000000000..55c66db37 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/commands/SilentCommand.html @@ -0,0 +1,345 @@ + + + + + +SilentCommand (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.commands
+

Class SilentCommand

+
+
+ +
+
    +
  • +
    +
    public class SilentCommand
+extends MultiverseCommand
    +
    Enables debug-information.
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      voidrunCommand​(org.bukkit.command.CommandSender sender, + java.util.List<java.lang.String> args) 
      +
        +
      • + + +

        Methods inherited from class com.pneumaticraft.commandhandler.Command

        +addAdditonalPermission, addCommandExample, addKey, addKey, checkArgLength, getAllPermissionStrings, getCommandDesc, getCommandExamples, getCommandName, getCommandUsage, getKey, getKeys, getKeyStrings, getMaxArgs, getMinArgs, getNumKeyArgs, getPermission, getPermissionString, getPlugin, isOpRequired, removeKeyArgs, setArgRange, setCommandUsage, setName, setPermission, setPermission, showHelp
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        runCommand

        +
        public void runCommand​(org.bukkit.command.CommandSender sender,
+                       java.util.List<java.lang.String> args)
        +
        +
        Specified by:
        +
        runCommand in class MultiverseCommand
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/commands/SleepCommand.html b/javadoc/latest/com/onarandombox/MultiverseCore/commands/SleepCommand.html new file mode 100644 index 000000000..cdc5c2706 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/commands/SleepCommand.html @@ -0,0 +1,345 @@ + + + + + +SleepCommand (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.commands
+

Class SleepCommand

+
+
+ +
+
    +
  • +
    +
    public class SleepCommand
+extends MultiverseCommand
    +
    Takes the player to the latest bed he's slept in.
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      voidrunCommand​(org.bukkit.command.CommandSender sender, + java.util.List<java.lang.String> args) 
      +
        +
      • + + +

        Methods inherited from class com.pneumaticraft.commandhandler.Command

        +addAdditonalPermission, addCommandExample, addKey, addKey, checkArgLength, getAllPermissionStrings, getCommandDesc, getCommandExamples, getCommandName, getCommandUsage, getKey, getKeys, getKeyStrings, getMaxArgs, getMinArgs, getNumKeyArgs, getPermission, getPermissionString, getPlugin, isOpRequired, removeKeyArgs, setArgRange, setCommandUsage, setName, setPermission, setPermission, showHelp
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        runCommand

        +
        public void runCommand​(org.bukkit.command.CommandSender sender,
+                       java.util.List<java.lang.String> args)
        +
        +
        Specified by:
        +
        runCommand in class MultiverseCommand
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/commands/SpawnCommand.html b/javadoc/latest/com/onarandombox/MultiverseCore/commands/SpawnCommand.html new file mode 100644 index 000000000..66a3d83b4 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/commands/SpawnCommand.html @@ -0,0 +1,345 @@ + + + + + +SpawnCommand (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.commands
+

Class SpawnCommand

+
+
+ +
+
    +
  • +
    +
    public class SpawnCommand
+extends MultiverseCommand
    +
    Teleports a player to the spawn.
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      voidrunCommand​(org.bukkit.command.CommandSender sender, + java.util.List<java.lang.String> args) 
      +
        +
      • + + +

        Methods inherited from class com.pneumaticraft.commandhandler.Command

        +addAdditonalPermission, addCommandExample, addKey, addKey, checkArgLength, getAllPermissionStrings, getCommandDesc, getCommandExamples, getCommandName, getCommandUsage, getKey, getKeys, getKeyStrings, getMaxArgs, getMinArgs, getNumKeyArgs, getPermission, getPermissionString, getPlugin, isOpRequired, removeKeyArgs, setArgRange, setCommandUsage, setName, setPermission, setPermission, showHelp
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        runCommand

        +
        public void runCommand​(org.bukkit.command.CommandSender sender,
+                       java.util.List<java.lang.String> args)
        +
        +
        Specified by:
        +
        runCommand in class MultiverseCommand
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/commands/TeleportCommand.html b/javadoc/latest/com/onarandombox/MultiverseCore/commands/TeleportCommand.html new file mode 100644 index 000000000..69377bd84 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/commands/TeleportCommand.html @@ -0,0 +1,345 @@ + + + + + +TeleportCommand (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.commands
+

Class TeleportCommand

+
+
+ +
+
    +
  • +
    +
    public class TeleportCommand
+extends MultiverseCommand
    +
    Used to teleport players.
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      voidrunCommand​(org.bukkit.command.CommandSender sender, + java.util.List<java.lang.String> args) 
      +
        +
      • + + +

        Methods inherited from class com.pneumaticraft.commandhandler.Command

        +addAdditonalPermission, addCommandExample, addKey, addKey, checkArgLength, getAllPermissionStrings, getCommandDesc, getCommandExamples, getCommandName, getCommandUsage, getKey, getKeys, getKeyStrings, getMaxArgs, getMinArgs, getNumKeyArgs, getPermission, getPermissionString, getPlugin, isOpRequired, removeKeyArgs, setArgRange, setCommandUsage, setName, setPermission, setPermission, showHelp
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        TeleportCommand

        +
        public TeleportCommand​(MultiverseCore plugin)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        runCommand

        +
        public void runCommand​(org.bukkit.command.CommandSender sender,
+                       java.util.List<java.lang.String> args)
        +
        +
        Specified by:
        +
        runCommand in class MultiverseCommand
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/commands/UnloadCommand.html b/javadoc/latest/com/onarandombox/MultiverseCore/commands/UnloadCommand.html new file mode 100644 index 000000000..eb65b248c --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/commands/UnloadCommand.html @@ -0,0 +1,345 @@ + + + + + +UnloadCommand (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.commands
+

Class UnloadCommand

+
+
+ +
+
    +
  • +
    +
    public class UnloadCommand
+extends MultiverseCommand
    +
    Unloads worlds from Multiverse.
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      voidrunCommand​(org.bukkit.command.CommandSender sender, + java.util.List<java.lang.String> args) 
      +
        +
      • + + +

        Methods inherited from class com.pneumaticraft.commandhandler.Command

        +addAdditonalPermission, addCommandExample, addKey, addKey, checkArgLength, getAllPermissionStrings, getCommandDesc, getCommandExamples, getCommandName, getCommandUsage, getKey, getKeys, getKeyStrings, getMaxArgs, getMinArgs, getNumKeyArgs, getPermission, getPermissionString, getPlugin, isOpRequired, removeKeyArgs, setArgRange, setCommandUsage, setName, setPermission, setPermission, showHelp
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        runCommand

        +
        public void runCommand​(org.bukkit.command.CommandSender sender,
+                       java.util.List<java.lang.String> args)
        +
        +
        Specified by:
        +
        runCommand in class MultiverseCommand
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/commands/VersionCommand.html b/javadoc/latest/com/onarandombox/MultiverseCore/commands/VersionCommand.html new file mode 100644 index 000000000..5c6a3f8da --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/commands/VersionCommand.html @@ -0,0 +1,345 @@ + + + + + +VersionCommand (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.commands
+

Class VersionCommand

+
+
+ +
+
    +
  • +
    +
    public class VersionCommand
+extends MultiverseCommand
    +
    Dumps version info to the console.
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      voidrunCommand​(org.bukkit.command.CommandSender sender, + java.util.List<java.lang.String> args) 
      +
        +
      • + + +

        Methods inherited from class com.pneumaticraft.commandhandler.Command

        +addAdditonalPermission, addCommandExample, addKey, addKey, checkArgLength, getAllPermissionStrings, getCommandDesc, getCommandExamples, getCommandName, getCommandUsage, getKey, getKeys, getKeyStrings, getMaxArgs, getMinArgs, getNumKeyArgs, getPermission, getPermissionString, getPlugin, isOpRequired, removeKeyArgs, setArgRange, setCommandUsage, setName, setPermission, setPermission, showHelp
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        VersionCommand

        +
        public VersionCommand​(MultiverseCore plugin)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        runCommand

        +
        public void runCommand​(org.bukkit.command.CommandSender sender,
+                       java.util.List<java.lang.String> args)
        +
        +
        Specified by:
        +
        runCommand in class MultiverseCommand
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/commands/WhoCommand.html b/javadoc/latest/com/onarandombox/MultiverseCore/commands/WhoCommand.html new file mode 100644 index 000000000..0c10ab911 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/commands/WhoCommand.html @@ -0,0 +1,345 @@ + + + + + +WhoCommand (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.commands
+

Class WhoCommand

+
+
+ +
+
    +
  • +
    +
    public class WhoCommand
+extends MultiverseCommand
    +
    States who is in what world.
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      voidrunCommand​(org.bukkit.command.CommandSender sender, + java.util.List<java.lang.String> args) 
      +
        +
      • + + +

        Methods inherited from class com.pneumaticraft.commandhandler.Command

        +addAdditonalPermission, addCommandExample, addKey, addKey, checkArgLength, getAllPermissionStrings, getCommandDesc, getCommandExamples, getCommandName, getCommandUsage, getKey, getKeys, getKeyStrings, getMaxArgs, getMinArgs, getNumKeyArgs, getPermission, getPermissionString, getPlugin, isOpRequired, removeKeyArgs, setArgRange, setCommandUsage, setName, setPermission, setPermission, showHelp
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        runCommand

        +
        public void runCommand​(org.bukkit.command.CommandSender sender,
+                       java.util.List<java.lang.String> args)
        +
        +
        Specified by:
        +
        runCommand in class MultiverseCommand
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/commands/package-summary.html b/javadoc/latest/com/onarandombox/MultiverseCore/commands/package-summary.html new file mode 100644 index 000000000..56f1a46f2 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/commands/package-summary.html @@ -0,0 +1,399 @@ + + + + + +com.onarandombox.MultiverseCore.commands (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+
+
+

Package com.onarandombox.MultiverseCore.commands

+
+
+
+ + +
This package contains all Commands.
+
+ +
+
+ + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/commands/package-tree.html b/javadoc/latest/com/onarandombox/MultiverseCore/commands/package-tree.html new file mode 100644 index 000000000..d9adab1b2 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/commands/package-tree.html @@ -0,0 +1,213 @@ + + + + + +com.onarandombox.MultiverseCore.commands Class Hierarchy (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package com.onarandombox.MultiverseCore.commands

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+ +
+
+
+ + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/commandtools/queue/CommandQueueManager.html b/javadoc/latest/com/onarandombox/MultiverseCore/commandtools/queue/CommandQueueManager.html new file mode 100644 index 000000000..76e06c0a7 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/commandtools/queue/CommandQueueManager.html @@ -0,0 +1,364 @@ + + + + + +CommandQueueManager (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.commandtools.queue
+

Class CommandQueueManager

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.commandtools.queue.CommandQueueManager
      • +
    +
    • +
+
+
    +
  • +
    +
    public class CommandQueueManager
+extends java.lang.Object
    +

    Manages the queuing of dangerous commands that require /mv confirm before executing.

    + +

    Each sender can only have one command in queue at any given time. When a queued command is added + for a sender that already has a command in queue, it will replace the old queued command.

    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      voidaddToQueue​(QueuedCommand queuedCommand) +
      Adds a QueuedCommand into queue.
      +
      booleanremoveFromQueue​(@NotNull org.bukkit.command.CommandSender sender) +
      Since only one command is stored in queue per sender, we remove the old one.
      +
      booleanrunQueuedCommand​(@NotNull org.bukkit.command.CommandSender sender) +
      Runs the command in queue for the given sender, if any.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        CommandQueueManager

        +
        public CommandQueueManager​(@NotNull
+                           @NotNull MultiverseCore plugin)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        addToQueue

        +
        public void addToQueue​(QueuedCommand queuedCommand)
        +
        Adds a QueuedCommand into queue.
        +
        +
        Parameters:
        +
        queuedCommand - The queued command to add.
        +
        +
        • +
      + + + +
        +
      • +

        runQueuedCommand

        +
        public boolean runQueuedCommand​(@NotNull
+                                @NotNull org.bukkit.command.CommandSender sender)
        +
        Runs the command in queue for the given sender, if any.
        +
        +
        Parameters:
        +
        sender - CommandSender that confirmed the command.
        +
        Returns:
        +
        True if queued command ran successfully, else false.
        +
        +
        • +
      + + + +
        +
      • +

        removeFromQueue

        +
        public boolean removeFromQueue​(@NotNull
+                               @NotNull org.bukkit.command.CommandSender sender)
        +
        Since only one command is stored in queue per sender, we remove the old one.
        +
        +
        Parameters:
        +
        sender - The CommandSender that executed the command.
        +
        Returns:
        +
        True if queue command is removed from sender successfully, else false.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/commandtools/queue/QueuedCommand.html b/javadoc/latest/com/onarandombox/MultiverseCore/commandtools/queue/QueuedCommand.html new file mode 100644 index 000000000..5d2ae59aa --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/commandtools/queue/QueuedCommand.html @@ -0,0 +1,333 @@ + + + + + +QueuedCommand (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.commandtools.queue
+

Class QueuedCommand

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.commandtools.queue.QueuedCommand
      • +
    +
    • +
+
+
    +
  • +
    +
    public class QueuedCommand
+extends java.lang.Object
    +
    Represents a single command used in CommandQueueManager for confirming before running potentially + dangerous action.
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      QueuedCommand​(org.bukkit.command.CommandSender sender, + java.lang.Runnable action) 
      QueuedCommand​(org.bukkit.command.CommandSender sender, + java.lang.Runnable action, + int validDuration) 
      QueuedCommand​(org.bukkit.command.CommandSender sender, + java.lang.Runnable action, + java.lang.String prompt) 
      QueuedCommand​(org.bukkit.command.CommandSender sender, + java.lang.Runnable action, + java.lang.String prompt, + int validDuration) +
      Creates a new queue command, to be registered at CommandQueueManager.addToQueue(QueuedCommand).
      +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        QueuedCommand

        +
        public QueuedCommand​(org.bukkit.command.CommandSender sender,
+                     java.lang.Runnable action)
        +
        • +
      + + + +
        +
      • +

        QueuedCommand

        +
        public QueuedCommand​(org.bukkit.command.CommandSender sender,
+                     java.lang.Runnable action,
+                     java.lang.String prompt)
        +
        • +
      + + + +
        +
      • +

        QueuedCommand

        +
        public QueuedCommand​(org.bukkit.command.CommandSender sender,
+                     java.lang.Runnable action,
+                     int validDuration)
        +
        • +
      + + + +
        +
      • +

        QueuedCommand

        +
        public QueuedCommand​(org.bukkit.command.CommandSender sender,
+                     java.lang.Runnable action,
+                     java.lang.String prompt,
+                     int validDuration)
        +
        Creates a new queue command, to be registered at CommandQueueManager.addToQueue(QueuedCommand).
        +
        +
        Parameters:
        +
        sender - The sender that ran the command needed for confirmation.
        +
        action - The logic to execute upon confirming.
        +
        prompt - Question to ask sender to confirm.
        +
        validDuration - Duration in which the command is valid for confirm in seconds.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/commandtools/queue/package-summary.html b/javadoc/latest/com/onarandombox/MultiverseCore/commandtools/queue/package-summary.html new file mode 100644 index 000000000..6f489e551 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/commandtools/queue/package-summary.html @@ -0,0 +1,178 @@ + + + + + +com.onarandombox.MultiverseCore.commandtools.queue (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+
+
+

Package com.onarandombox.MultiverseCore.commandtools.queue

+
+
+
+ + +
Manager queuing of dangerous commands in need of confirmation.
+
+
    +
  • + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    CommandQueueManager +
    Manages the queuing of dangerous commands that require /mv confirm before executing.
    +
    QueuedCommand +
    Represents a single command used in CommandQueueManager for confirming before running potentially + dangerous action.
    +
    +
    • +
+
+
+ + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/commandtools/queue/package-tree.html b/javadoc/latest/com/onarandombox/MultiverseCore/commandtools/queue/package-tree.html new file mode 100644 index 000000000..9d1425de8 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/commandtools/queue/package-tree.html @@ -0,0 +1,162 @@ + + + + + +com.onarandombox.MultiverseCore.commandtools.queue Class Hierarchy (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package com.onarandombox.MultiverseCore.commandtools.queue

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+
    +
  • java.lang.Object + +
    • +
+
+
+
+ + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/configuration/EntryFee.EntryFeeCurrencySerializor.html b/javadoc/latest/com/onarandombox/MultiverseCore/configuration/EntryFee.EntryFeeCurrencySerializor.html new file mode 100644 index 000000000..c065ab293 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/configuration/EntryFee.EntryFeeCurrencySerializor.html @@ -0,0 +1,337 @@ + + + + + +EntryFee.EntryFeeCurrencySerializor (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.configuration
+

Class EntryFee.EntryFeeCurrencySerializor

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.configuration.EntryFee.EntryFeeCurrencySerializor
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    me.main__.util.SerializationConfig.Serializor<org.bukkit.Material,​java.lang.Object>
    +
    +
    +
    Enclosing class:
    +
    EntryFee
    +
    +
    +
    public static final class EntryFee.EntryFeeCurrencySerializor
+extends java.lang.Object
+implements me.main__.util.SerializationConfig.Serializor<org.bukkit.Material,​java.lang.Object>
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      org.bukkit.Materialdeserialize​(java.lang.Object o, + java.lang.Class<org.bukkit.Material> aClass) 
      java.lang.Stringserialize​(org.bukkit.Material material) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        EntryFeeCurrencySerializor

        +
        public EntryFeeCurrencySerializor()
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        serialize

        +
        public java.lang.String serialize​(org.bukkit.Material material)
        +
        +
        Specified by:
        +
        serialize in interface me.main__.util.SerializationConfig.Serializor<org.bukkit.Material,​java.lang.Object>
        +
        +
        • +
      + + + +
        +
      • +

        deserialize

        +
        public org.bukkit.Material deserialize​(java.lang.Object o,
+                                       java.lang.Class<org.bukkit.Material> aClass)
        +
        +
        Specified by:
        +
        deserialize in interface me.main__.util.SerializationConfig.Serializor<org.bukkit.Material,​java.lang.Object>
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/configuration/EntryFee.html b/javadoc/latest/com/onarandombox/MultiverseCore/configuration/EntryFee.html new file mode 100644 index 000000000..7b5c0d3cb --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/configuration/EntryFee.html @@ -0,0 +1,440 @@ + + + + + +EntryFee (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.configuration
+

Class EntryFee

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • me.main__.util.SerializationConfig.SerializationConfig
      • +
    • +
        +
      • com.onarandombox.MultiverseCore.configuration.EntryFee
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    org.bukkit.configuration.serialization.ConfigurationSerializable
    +
    +
    +
    public class EntryFee
+extends me.main__.util.SerializationConfig.SerializationConfig
    +
    Entryfee-settings.
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      EntryFee() 
      EntryFee​(java.util.Map<java.lang.String,​java.lang.Object> values) 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      doublegetAmount() 
      @Nullable org.bukkit.MaterialgetCurrency() 
      voidsetAmount​(double amount) +
      Sets the amount.
      +
      voidsetCurrency​(@Nullable org.bukkit.Material currency) +
      Sets the currency.
      +
      protected voidsetDefaults()
      +
        +
      • + + +

        Methods inherited from class me.main__.util.SerializationConfig.SerializationConfig

        +buildVPropChanges, copyValues, flushPendingVPropChanges, getAliasMap, getAliasMap, getProperty, getProperty, getPropertyDescription, getPropertyDescription, getPropertyDescriptionUnchecked, getPropertyDescriptionUnchecked, getPropertyUnchecked, getPropertyUnchecked, initLogging, loadValues, registerAlias, registerAlias, registerAll, registerGlobalValidator, registerObjectUsing, registerValidator, serialize, setProperty, setProperty, setPropertyUnchecked, setPropertyUnchecked, setPropertyValue, setPropertyValue, setPropertyValueUnchecked, setPropertyValueUnchecked, unregisterAll
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        EntryFee

        +
        public EntryFee()
        +
        • +
      + + + +
        +
      • +

        EntryFee

        +
        public EntryFee​(java.util.Map<java.lang.String,​java.lang.Object> values)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setDefaults

        +
        protected void setDefaults()
        +
        +
        Specified by:
        +
        setDefaults in class me.main__.util.SerializationConfig.SerializationConfig
        +
        +
        • +
      + + + +
        +
      • +

        getAmount

        +
        public double getAmount()
        +
        +
        Returns:
        +
        the amount
        +
        +
        • +
      + + + +
        +
      • +

        getCurrency

        +
        @Nullable
+public @Nullable org.bukkit.Material getCurrency()
        +
        +
        Returns:
        +
        the currency
        +
        +
        • +
      + + + +
        +
      • +

        setAmount

        +
        public void setAmount​(double amount)
        +
        Sets the amount.
        +
        +
        Parameters:
        +
        amount - The new value.
        +
        +
        • +
      + + + +
        +
      • +

        setCurrency

        +
        public void setCurrency​(@Nullable
+                        @Nullable org.bukkit.Material currency)
        +
        Sets the currency.
        +
        +
        Parameters:
        +
        currency - The new value.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/configuration/SpawnLocation.html b/javadoc/latest/com/onarandombox/MultiverseCore/configuration/SpawnLocation.html new file mode 100644 index 000000000..e41a7891e --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/configuration/SpawnLocation.html @@ -0,0 +1,461 @@ + + + + + +SpawnLocation (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.configuration
+

Class SpawnLocation

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • org.bukkit.Location
      • +
    • +
        +
      • com.onarandombox.MultiverseCore.configuration.SpawnLocation
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable, org.bukkit.configuration.serialization.ConfigurationSerializable
    +
    +
    +
    Direct Known Subclasses:
    +
    MVWorld.NullLocation
    +
    +
    +
    public class SpawnLocation
+extends org.bukkit.Location
+implements org.bukkit.configuration.serialization.ConfigurationSerializable
    +
    Just like a regular Location, however world is usually null + or just a weak reference and it implements ConfigurationSerializable.
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      SpawnLocation​(double x, + double y, + double z) 
      SpawnLocation​(double x, + double y, + double z, + float yaw, + float pitch) 
      SpawnLocation​(org.bukkit.Location loc) 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      static SpawnLocationdeserialize​(java.util.Map<java.lang.String,​java.lang.Object> args) +
      Let Bukkit be able to deserialize this.
      +
      org.bukkit.block.BlockgetBlock()
      org.bukkit.ChunkgetChunk()
      org.bukkit.WorldgetWorld()
      java.util.Map<java.lang.String,​java.lang.Object>serialize()
      voidsetWorld​(org.bukkit.World world)
      +
        +
      • + + +

        Methods inherited from class org.bukkit.Location

        +add, add, add, checkFinite, clone, distance, distanceSquared, equals, getBlockX, getBlockY, getBlockZ, getDirection, getPitch, getX, getY, getYaw, getZ, hashCode, length, lengthSquared, locToBlock, multiply, normalizePitch, normalizeYaw, setDirection, setPitch, setX, setY, setYaw, setZ, subtract, subtract, subtract, toString, toVector, zero
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        SpawnLocation

        +
        public SpawnLocation​(double x,
+                     double y,
+                     double z)
        +
        • +
      + + + +
        +
      • +

        SpawnLocation

        +
        public SpawnLocation​(double x,
+                     double y,
+                     double z,
+                     float yaw,
+                     float pitch)
        +
        • +
      + + + +
        +
      • +

        SpawnLocation

        +
        public SpawnLocation​(org.bukkit.Location loc)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getWorld

        +
        public org.bukkit.World getWorld()
        +
        +
        Overrides:
        +
        getWorld in class org.bukkit.Location
        +
        +
        • +
      + + + +
        +
      • +

        setWorld

        +
        public void setWorld​(org.bukkit.World world)
        +
        +
        Overrides:
        +
        setWorld in class org.bukkit.Location
        +
        +
        • +
      + + + +
        +
      • +

        getChunk

        +
        public org.bukkit.Chunk getChunk()
        +
        +
        Overrides:
        +
        getChunk in class org.bukkit.Location
        +
        +
        • +
      + + + +
        +
      • +

        getBlock

        +
        public org.bukkit.block.Block getBlock()
        +
        +
        Overrides:
        +
        getBlock in class org.bukkit.Location
        +
        +
        • +
      + + + +
        +
      • +

        serialize

        +
        public java.util.Map<java.lang.String,​java.lang.Object> serialize()
        +
        +
        Specified by:
        +
        serialize in interface org.bukkit.configuration.serialization.ConfigurationSerializable
        +
        Overrides:
        +
        serialize in class org.bukkit.Location
        +
        +
        • +
      + + + +
        +
      • +

        deserialize

        +
        public static SpawnLocation deserialize​(java.util.Map<java.lang.String,​java.lang.Object> args)
        +
        Let Bukkit be able to deserialize this.
        +
        +
        Parameters:
        +
        args - The map.
        +
        Returns:
        +
        The deserialized object.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/configuration/SpawnSettings.html b/javadoc/latest/com/onarandombox/MultiverseCore/configuration/SpawnSettings.html new file mode 100644 index 000000000..8cad6f999 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/configuration/SpawnSettings.html @@ -0,0 +1,373 @@ + + + + + +SpawnSettings (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.configuration
+

Class SpawnSettings

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • me.main__.util.SerializationConfig.SerializationConfig
      • +
    • +
        +
      • com.onarandombox.MultiverseCore.configuration.SpawnSettings
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    org.bukkit.configuration.serialization.ConfigurationSerializable
    +
    +
    +
    public class SpawnSettings
+extends me.main__.util.SerializationConfig.SerializationConfig
    +
    Spawning-Settings.
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      SpawnSettings() 
      SpawnSettings​(java.util.Map<java.lang.String,​java.lang.Object> values) 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      SubSpawnSettingsgetAnimalSettings() 
      SubSpawnSettingsgetMonsterSettings() 
      voidsetDefaults()
      +
        +
      • + + +

        Methods inherited from class me.main__.util.SerializationConfig.SerializationConfig

        +buildVPropChanges, copyValues, flushPendingVPropChanges, getAliasMap, getAliasMap, getProperty, getProperty, getPropertyDescription, getPropertyDescription, getPropertyDescriptionUnchecked, getPropertyDescriptionUnchecked, getPropertyUnchecked, getPropertyUnchecked, initLogging, loadValues, registerAlias, registerAlias, registerAll, registerGlobalValidator, registerObjectUsing, registerValidator, serialize, setProperty, setProperty, setPropertyUnchecked, setPropertyUnchecked, setPropertyValue, setPropertyValue, setPropertyValueUnchecked, setPropertyValueUnchecked, unregisterAll
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        SpawnSettings

        +
        public SpawnSettings()
        +
        • +
      + + + +
        +
      • +

        SpawnSettings

        +
        public SpawnSettings​(java.util.Map<java.lang.String,​java.lang.Object> values)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setDefaults

        +
        public void setDefaults()
        +
        +
        Specified by:
        +
        setDefaults in class me.main__.util.SerializationConfig.SerializationConfig
        +
        +
        • +
      + + + +
        +
      • +

        getAnimalSettings

        +
        public SubSpawnSettings getAnimalSettings()
        +
        +
        Returns:
        +
        the animal-settings
        +
        +
        • +
      + + + +
        +
      • +

        getMonsterSettings

        +
        public SubSpawnSettings getMonsterSettings()
        +
        +
        Returns:
        +
        the monster-settings
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/configuration/SubSpawnSettings.html b/javadoc/latest/com/onarandombox/MultiverseCore/configuration/SubSpawnSettings.html new file mode 100644 index 000000000..a561af30e --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/configuration/SubSpawnSettings.html @@ -0,0 +1,427 @@ + + + + + +SubSpawnSettings (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.configuration
+

Class SubSpawnSettings

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • me.main__.util.SerializationConfig.SerializationConfig
      • +
    • +
        +
      • com.onarandombox.MultiverseCore.configuration.SubSpawnSettings
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    org.bukkit.configuration.serialization.ConfigurationSerializable
    +
    +
    +
    public class SubSpawnSettings
+extends me.main__.util.SerializationConfig.SerializationConfig
    +
    SpawnSubSettings.
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      SubSpawnSettings() 
      SubSpawnSettings​(java.util.Map<java.lang.String,​java.lang.Object> values) 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      booleandoSpawn() 
      java.util.List<java.lang.String>getExceptions() 
      intgetSpawnRate() 
      voidsetDefaults()
      voidsetSpawn​(boolean spawn) 
      voidsetSpawnRate​(int rate) 
      +
        +
      • + + +

        Methods inherited from class me.main__.util.SerializationConfig.SerializationConfig

        +buildVPropChanges, copyValues, flushPendingVPropChanges, getAliasMap, getAliasMap, getProperty, getProperty, getPropertyDescription, getPropertyDescription, getPropertyDescriptionUnchecked, getPropertyDescriptionUnchecked, getPropertyUnchecked, getPropertyUnchecked, initLogging, loadValues, registerAlias, registerAlias, registerAll, registerGlobalValidator, registerObjectUsing, registerValidator, serialize, setProperty, setProperty, setPropertyUnchecked, setPropertyUnchecked, setPropertyValue, setPropertyValue, setPropertyValueUnchecked, setPropertyValueUnchecked, unregisterAll
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        SubSpawnSettings

        +
        public SubSpawnSettings()
        +
        • +
      + + + +
        +
      • +

        SubSpawnSettings

        +
        public SubSpawnSettings​(java.util.Map<java.lang.String,​java.lang.Object> values)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setDefaults

        +
        public void setDefaults()
        +
        +
        Specified by:
        +
        setDefaults in class me.main__.util.SerializationConfig.SerializationConfig
        +
        +
        • +
      + + + +
        +
      • +

        doSpawn

        +
        public boolean doSpawn()
        +
        +
        Returns:
        +
        spawn
        +
        +
        • +
      + + + +
        +
      • +

        setSpawn

        +
        public void setSpawn​(boolean spawn)
        +
        +
        Parameters:
        +
        spawn - The new value.
        +
        +
        • +
      + + + +
        +
      • +

        getExceptions

        +
        public java.util.List<java.lang.String> getExceptions()
        +
        +
        Returns:
        +
        The exceptions
        +
        +
        • +
      + + + +
        +
      • +

        setSpawnRate

        +
        public void setSpawnRate​(int rate)
        +
        +
        Parameters:
        +
        rate - The new spawn rate
        +
        +
        • +
      + + + +
        +
      • +

        getSpawnRate

        +
        public int getSpawnRate()
        +
        +
        Returns:
        +
        The spawn rate
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/configuration/WorldPropertyValidator.html b/javadoc/latest/com/onarandombox/MultiverseCore/configuration/WorldPropertyValidator.html new file mode 100644 index 000000000..7d19d5761 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/configuration/WorldPropertyValidator.html @@ -0,0 +1,339 @@ + + + + + +WorldPropertyValidator (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.configuration
+

Class WorldPropertyValidator<T>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • me.main__.util.SerializationConfig.ObjectUsingValidator<T,​MVWorld>
      • +
    • +
        +
      • com.onarandombox.MultiverseCore.configuration.WorldPropertyValidator<T>
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    T - The type of the property that should be validated.
    +
    +
    +
    All Implemented Interfaces:
    +
    me.main__.util.SerializationConfig.Validator<T>
    +
    +
    +
    public class WorldPropertyValidator<T>
+extends me.main__.util.SerializationConfig.ObjectUsingValidator<T,​MVWorld>
    +
    Validates world-property-changes.
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      TvalidateChange​(java.lang.String property, + T newValue, + T oldValue, + MVWorld object)
      +
        +
      • + + +

        Methods inherited from class me.main__.util.SerializationConfig.ObjectUsingValidator

        +validateChange
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        WorldPropertyValidator

        +
        public WorldPropertyValidator()
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        validateChange

        +
        public T validateChange​(java.lang.String property,
+                        T newValue,
+                        T oldValue,
+                        MVWorld object)
+                 throws me.main__.util.SerializationConfig.ChangeDeniedException
        +
        +
        Specified by:
        +
        validateChange in class me.main__.util.SerializationConfig.ObjectUsingValidator<T,​MVWorld>
        +
        Throws:
        +
        me.main__.util.SerializationConfig.ChangeDeniedException
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/configuration/package-summary.html b/javadoc/latest/com/onarandombox/MultiverseCore/configuration/package-summary.html new file mode 100644 index 000000000..d213656a4 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/configuration/package-summary.html @@ -0,0 +1,200 @@ + + + + + +com.onarandombox.MultiverseCore.configuration (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+
+
+

Package com.onarandombox.MultiverseCore.configuration

+
+
+
+ + +
This package contains the Multiverse-configuration.
+
+ +
+
+ + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/configuration/package-tree.html b/javadoc/latest/com/onarandombox/MultiverseCore/configuration/package-tree.html new file mode 100644 index 000000000..32cdba8b2 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/configuration/package-tree.html @@ -0,0 +1,178 @@ + + + + + +com.onarandombox.MultiverseCore.configuration Class Hierarchy (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package com.onarandombox.MultiverseCore.configuration

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+
    +
  • java.lang.Object +
      +
    • com.onarandombox.MultiverseCore.configuration.EntryFee.EntryFeeCurrencySerializor (implements me.main__.util.SerializationConfig.Serializor<T,​U>)
      • +
    • org.bukkit.Location (implements java.lang.Cloneable, org.bukkit.configuration.serialization.ConfigurationSerializable) +
        +
      • com.onarandombox.MultiverseCore.configuration.SpawnLocation (implements org.bukkit.configuration.serialization.ConfigurationSerializable)
        • +
      +
      • +
    • me.main__.util.SerializationConfig.ObjectUsingValidator<T,​U> (implements me.main__.util.SerializationConfig.Validator<T>) + +
      • +
    • me.main__.util.SerializationConfig.SerializationConfig (implements org.bukkit.configuration.serialization.ConfigurationSerializable) + +
      • +
    +
    • +
+
+
+
+ + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/destination/AnchorDestination.html b/javadoc/latest/com/onarandombox/MultiverseCore/destination/AnchorDestination.html new file mode 100644 index 000000000..c9b55389a --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/destination/AnchorDestination.html @@ -0,0 +1,602 @@ + + + + + +AnchorDestination (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.destination
+

Class AnchorDestination

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.destination.AnchorDestination
      • +
    +
    • +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      AnchorDestination() 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      java.lang.StringgetIdentifier() +
      Returns the identifier or prefix that is required for this destination.
      +
      org.bukkit.LocationgetLocation​(org.bukkit.entity.Entity e) +
      Returns the location a specific entity will spawn at when being teleported to this Destination.
      +
      java.lang.StringgetName() +
      Gives you a specific name of the destination.
      +
      java.lang.StringgetRequiredPermission() +
      Returns the permissions string required to go here.
      +
      java.lang.StringgetType() +
      Gives you a general friendly description of the type of destination.
      +
      org.bukkit.util.VectorgetVelocity() +
      Returns the velocity vector for this destination.
      +
      booleanisThisType​(org.bukkit.plugin.java.JavaPlugin plugin, + java.lang.String destination) +
      Allows you to determine if a Destination is valid for the type it thinks it is.
      +
      booleanisValid() +
      Returns true if the destination is valid and players will be taken to it.
      +
      voidsetDestination​(org.bukkit.plugin.java.JavaPlugin plugin, + java.lang.String destination) +
      Sets the destination string.
      +
      java.lang.StringtoString() +
      Returns a string that can easily be saved in the config that contains all the details needed to rebuild this + destination.
      +
      booleanuseSafeTeleporter() +
      Should the Multiverse SafeTeleporter be used?
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        AnchorDestination

        +
        public AnchorDestination()
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getIdentifier

        +
        public java.lang.String getIdentifier()
        +
        Returns the identifier or prefix that is required for this destination. +

        + Portals have a prefix of "p" for example and OpenWarp (third party plugin) uses "ow". This is derived from a + hash and cannot have duplicate values. Read that as your plugin cannot use 'p' because it's already used. + Please check the wiki when adding a custom destination!

        +
        +
        Specified by:
        +
        getIdentifier in interface MVDestination
        +
        Returns:
        +
        The identifier or prefix that is required for this destination.
        +
        +
        • +
      + + + +
        +
      • +

        getVelocity

        +
        public org.bukkit.util.Vector getVelocity()
        +
        Returns the velocity vector for this destination. +

        + Plugins wishing to fully support MVDestinations MUST implement this.

        +
        +
        Specified by:
        +
        getVelocity in interface MVDestination
        +
        Returns:
        +
        A vector representing the speed/direction the player should travel when arriving
        +
        +
        • +
      + + + +
        +
      • +

        isThisType

        +
        public boolean isThisType​(org.bukkit.plugin.java.JavaPlugin plugin,
+                          java.lang.String destination)
        +
        Allows you to determine if a Destination is valid for the type it thinks it is. +

        + An example of this would be the exact destination. A valid string would be: e:0,0,0 where an invalid one would + be e:1:2:3. The first string would return true the second would return false. This is simply a convenience + method + and does not even NEED to be called, but it's highly recommended if you're teleporting, but it's mainly for + Multiverse Internal use.

        +
        +
        Specified by:
        +
        isThisType in interface MVDestination
        +
        Parameters:
        +
        plugin - The plugin who the type belongs to.
        +
        destination - The destination string. ex: p:MyPortal:nw
        +
        Returns:
        +
        True if the destination is valid, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        getLocation

        +
        public org.bukkit.Location getLocation​(org.bukkit.entity.Entity e)
        +
        Returns the location a specific entity will spawn at when being teleported to this Destination. +

        + To just retrieve the location as it is stored you can just pass null, but be warned some destinations may return + null back to you if you do this. It is always safer to pass an actual entity. This is used so things like + minecarts can be teleported. +

        + Do not forget to use MVDestination.getVelocity() as destinations can use this too!

        +
        +
        Specified by:
        +
        getLocation in interface MVDestination
        +
        Parameters:
        +
        e - The entity to be teleported.
        +
        Returns:
        +
        The location of the entity.
        +
        +
        • +
      + + + +
        +
      • +

        isValid

        +
        public boolean isValid()
        +
        Returns true if the destination is valid and players will be taken to it. +

        + Even if destinations are in the correct format (p:MyPortal) MyPortal may not exist, and therefore this would + return false.

        +
        +
        Specified by:
        +
        isValid in interface MVDestination
        +
        Returns:
        +
        True if the destination is valid; false if not.
        +
        +
        • +
      + + + +
        +
      • +

        setDestination

        +
        public void setDestination​(org.bukkit.plugin.java.JavaPlugin plugin,
+                           java.lang.String destination)
        +
        Sets the destination string. +

        + This should be used when you want to tell this destination object about a change in where it should take people. + The destination param should be match the result from MVDestination.getIdentifier(). A valid example would be that if + MVDestination.getIdentifier() returned "ow" our destination string could be "ow:TownCenter" but could not be + "p:HomePortal"

        +
        +
        Specified by:
        +
        setDestination in interface MVDestination
        +
        Parameters:
        +
        plugin - The plugin who the type belongs to.
        +
        destination - The destination string. ex: p:MyPortal:nw
        +
        +
        • +
      + + + +
        +
      • +

        getType

        +
        public java.lang.String getType()
        +
        Gives you a general friendly description of the type of destination. +

        + For example, the PlayerDestination sets this to "Player". You can use this to show where a player will be taken.

        +
        +
        Specified by:
        +
        getType in interface MVDestination
        +
        Returns:
        +
        A friendly string description of the type of destination.
        +
        +
        • +
      + + + +
        +
      • +

        getName

        +
        public java.lang.String getName()
        +
        Gives you a specific name of the destination. +

        + For example, the PlayerDestination sets this to The Player's Name.

        +
        +
        Specified by:
        +
        getName in interface MVDestination
        +
        Returns:
        +
        A friendly string stating the name of the destination.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        Description copied from interface: MVDestination
        +
        Returns a string that can easily be saved in the config that contains all the details needed to rebuild this + destination. +

        + ex: e:0,0,0:50:50

        +
        +
        Specified by:
        +
        toString in interface MVDestination
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        Returns:
        +
        The savable config string.
        +
        +
        • +
      + + + +
        +
      • +

        getRequiredPermission

        +
        public java.lang.String getRequiredPermission()
        +
        Returns the permissions string required to go here. +

        + ex: multiverse.access.world +

        + NOTE: This is NOT the permission to use the teleport command.

        +
        +
        Specified by:
        +
        getRequiredPermission in interface MVDestination
        +
        Returns:
        +
        the permissions string required to go here.
        +
        +
        • +
      + + + +
        +
      • +

        useSafeTeleporter

        +
        public boolean useSafeTeleporter()
        +
        Should the Multiverse SafeTeleporter be used? +

        + If not, MV will blindly take people to the location specified.

        +
        +
        Specified by:
        +
        useSafeTeleporter in interface MVDestination
        +
        Returns:
        +
        True if the SafeTeleporter will be used, false if not.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/destination/BedDestination.html b/javadoc/latest/com/onarandombox/MultiverseCore/destination/BedDestination.html new file mode 100644 index 000000000..9ac2e95e9 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/destination/BedDestination.html @@ -0,0 +1,648 @@ + + + + + +BedDestination (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.destination
+

Class BedDestination

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.destination.BedDestination
      • +
    +
    • +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      static java.lang.StringOWN_BED_STRING 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      BedDestination() 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      java.lang.StringgetIdentifier() +
      Returns the identifier or prefix that is required for this destination.
      +
      org.bukkit.LocationgetLocation​(org.bukkit.entity.Entity entity) +
      Returns the location a specific entity will spawn at when being teleported to this Destination.
      +
      java.lang.StringgetName() +
      Gives you a specific name of the destination.
      +
      java.lang.StringgetRequiredPermission() +
      Returns the permissions string required to go here.
      +
      java.lang.StringgetType() +
      Gives you a general friendly description of the type of destination.
      +
      org.bukkit.util.VectorgetVelocity() +
      Returns the velocity vector for this destination.
      +
      booleanisThisType​(org.bukkit.plugin.java.JavaPlugin plugin, + java.lang.String destination) +
      Allows you to determine if a Destination is valid for the type it thinks it is.
      +
      booleanisValid() +
      Returns true if the destination is valid and players will be taken to it.
      +
      voidsetDestination​(org.bukkit.plugin.java.JavaPlugin plugin, + java.lang.String destination) +
      Sets the destination string.
      +
      java.lang.StringtoString() +
      Returns a string that can easily be saved in the config that contains all the details needed to rebuild this + destination.
      +
      booleanuseSafeTeleporter() +
      Should the Multiverse SafeTeleporter be used?
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        OWN_BED_STRING

        +
        public static final java.lang.String OWN_BED_STRING
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        BedDestination

        +
        public BedDestination()
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getIdentifier

        +
        public java.lang.String getIdentifier()
        +
        Returns the identifier or prefix that is required for this destination. +

        + Portals have a prefix of "p" for example and OpenWarp (third party plugin) uses "ow". This is derived from a + hash and cannot have duplicate values. Read that as your plugin cannot use 'p' because it's already used. + Please check the wiki when adding a custom destination!

        +
        +
        Specified by:
        +
        getIdentifier in interface MVDestination
        +
        Returns:
        +
        The identifier or prefix that is required for this destination.
        +
        +
        • +
      + + + +
        +
      • +

        isThisType

        +
        public boolean isThisType​(org.bukkit.plugin.java.JavaPlugin plugin,
+                          java.lang.String destination)
        +
        Allows you to determine if a Destination is valid for the type it thinks it is. +

        + An example of this would be the exact destination. A valid string would be: e:0,0,0 where an invalid one would + be e:1:2:3. The first string would return true the second would return false. This is simply a convenience + method + and does not even NEED to be called, but it's highly recommended if you're teleporting, but it's mainly for + Multiverse Internal use.

        +
        +
        Specified by:
        +
        isThisType in interface MVDestination
        +
        Parameters:
        +
        plugin - The plugin who the type belongs to.
        +
        destination - The destination string. ex: p:MyPortal:nw
        +
        Returns:
        +
        True if the destination is valid, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        getLocation

        +
        public org.bukkit.Location getLocation​(org.bukkit.entity.Entity entity)
        +
        Returns the location a specific entity will spawn at when being teleported to this Destination. +

        + To just retrieve the location as it is stored you can just pass null, but be warned some destinations may return + null back to you if you do this. It is always safer to pass an actual entity. This is used so things like + minecarts can be teleported. +

        + Do not forget to use MVDestination.getVelocity() as destinations can use this too!

        +
        +
        Specified by:
        +
        getLocation in interface MVDestination
        +
        Parameters:
        +
        entity - The entity to be teleported.
        +
        Returns:
        +
        The location of the entity.
        +
        +
        • +
      + + + +
        +
      • +

        getVelocity

        +
        public org.bukkit.util.Vector getVelocity()
        +
        Returns the velocity vector for this destination. +

        + Plugins wishing to fully support MVDestinations MUST implement this.

        +
        +
        Specified by:
        +
        getVelocity in interface MVDestination
        +
        Returns:
        +
        A vector representing the speed/direction the player should travel when arriving
        +
        +
        • +
      + + + +
        +
      • +

        setDestination

        +
        public void setDestination​(org.bukkit.plugin.java.JavaPlugin plugin,
+                           java.lang.String destination)
        +
        Sets the destination string. +

        + This should be used when you want to tell this destination object about a change in where it should take people. + The destination param should be match the result from MVDestination.getIdentifier(). A valid example would be that if + MVDestination.getIdentifier() returned "ow" our destination string could be "ow:TownCenter" but could not be + "p:HomePortal"

        +
        +
        Specified by:
        +
        setDestination in interface MVDestination
        +
        Parameters:
        +
        plugin - The plugin who the type belongs to.
        +
        destination - The destination string. ex: p:MyPortal:nw
        +
        +
        • +
      + + + +
        +
      • +

        isValid

        +
        public boolean isValid()
        +
        Returns true if the destination is valid and players will be taken to it. +

        + Even if destinations are in the correct format (p:MyPortal) MyPortal may not exist, and therefore this would + return false.

        +
        +
        Specified by:
        +
        isValid in interface MVDestination
        +
        Returns:
        +
        True if the destination is valid; false if not.
        +
        +
        • +
      + + + +
        +
      • +

        getType

        +
        public java.lang.String getType()
        +
        Gives you a general friendly description of the type of destination. +

        + For example, the PlayerDestination sets this to "Player". You can use this to show where a player will be taken.

        +
        +
        Specified by:
        +
        getType in interface MVDestination
        +
        Returns:
        +
        A friendly string description of the type of destination.
        +
        +
        • +
      + + + +
        +
      • +

        getName

        +
        public java.lang.String getName()
        +
        Gives you a specific name of the destination. +

        + For example, the PlayerDestination sets this to The Player's Name.

        +
        +
        Specified by:
        +
        getName in interface MVDestination
        +
        Returns:
        +
        A friendly string stating the name of the destination.
        +
        +
        • +
      + + + +
        +
      • +

        getRequiredPermission

        +
        public java.lang.String getRequiredPermission()
        +
        Returns the permissions string required to go here. +

        + ex: multiverse.access.world +

        + NOTE: This is NOT the permission to use the teleport command.

        +
        +
        Specified by:
        +
        getRequiredPermission in interface MVDestination
        +
        Returns:
        +
        the permissions string required to go here.
        +
        +
        • +
      + + + +
        +
      • +

        useSafeTeleporter

        +
        public boolean useSafeTeleporter()
        +
        Should the Multiverse SafeTeleporter be used? +

        + If not, MV will blindly take people to the location specified.

        +
        +
        Specified by:
        +
        useSafeTeleporter in interface MVDestination
        +
        Returns:
        +
        True if the SafeTeleporter will be used, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        Description copied from interface: MVDestination
        +
        Returns a string that can easily be saved in the config that contains all the details needed to rebuild this + destination. +

        + ex: e:0,0,0:50:50

        +
        +
        Specified by:
        +
        toString in interface MVDestination
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        Returns:
        +
        The savable config string.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/destination/CannonDestination.html b/javadoc/latest/com/onarandombox/MultiverseCore/destination/CannonDestination.html new file mode 100644 index 000000000..73d6d7a5a --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/destination/CannonDestination.html @@ -0,0 +1,626 @@ + + + + + +CannonDestination (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.destination
+

Class CannonDestination

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.destination.CannonDestination
      • +
    +
    • +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      CannonDestination() 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      java.lang.StringgetIdentifier() +
      Returns the identifier or prefix that is required for this destination.
      +
      org.bukkit.LocationgetLocation​(org.bukkit.entity.Entity e) +
      Returns the location a specific entity will spawn at when being teleported to this Destination.
      +
      java.lang.StringgetName() +
      Gives you a specific name of the destination.
      +
      java.lang.StringgetRequiredPermission() +
      Returns the permissions string required to go here.
      +
      java.lang.StringgetType() +
      Gives you a general friendly description of the type of destination.
      +
      org.bukkit.util.VectorgetVelocity() +
      Returns the velocity vector for this destination.
      +
      booleanisThisType​(org.bukkit.plugin.java.JavaPlugin plugin, + java.lang.String destination) +
      Allows you to determine if a Destination is valid for the type it thinks it is.
      +
      booleanisValid() +
      Returns true if the destination is valid and players will be taken to it.
      +
      voidsetDestination​(org.bukkit.Location location, + double speed) +
      Sets this CannonDestination.
      +
      voidsetDestination​(org.bukkit.plugin.java.JavaPlugin plugin, + java.lang.String destination) +
      Sets the destination string.
      +
      java.lang.StringtoString() +
      Returns a string that can easily be saved in the config that contains all the details needed to rebuild this + destination.
      +
      booleanuseSafeTeleporter() +
      Should the Multiverse SafeTeleporter be used?
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        CannonDestination

        +
        public CannonDestination()
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getVelocity

        +
        public org.bukkit.util.Vector getVelocity()
        +
        Returns the velocity vector for this destination. +

        + Plugins wishing to fully support MVDestinations MUST implement this.

        +
        +
        Specified by:
        +
        getVelocity in interface MVDestination
        +
        Returns:
        +
        A vector representing the speed/direction the player should travel when arriving
        +
        +
        • +
      + + + +
        +
      • +

        getIdentifier

        +
        public java.lang.String getIdentifier()
        +
        Returns the identifier or prefix that is required for this destination. +

        + Portals have a prefix of "p" for example and OpenWarp (third party plugin) uses "ow". This is derived from a + hash and cannot have duplicate values. Read that as your plugin cannot use 'p' because it's already used. + Please check the wiki when adding a custom destination!

        +
        +
        Specified by:
        +
        getIdentifier in interface MVDestination
        +
        Returns:
        +
        The identifier or prefix that is required for this destination.
        +
        +
        • +
      + + + +
        +
      • +

        isThisType

        +
        public boolean isThisType​(org.bukkit.plugin.java.JavaPlugin plugin,
+                          java.lang.String destination)
        +
        Allows you to determine if a Destination is valid for the type it thinks it is. +

        + An example of this would be the exact destination. A valid string would be: e:0,0,0 where an invalid one would + be e:1:2:3. The first string would return true the second would return false. This is simply a convenience + method + and does not even NEED to be called, but it's highly recommended if you're teleporting, but it's mainly for + Multiverse Internal use.

        +
        +
        Specified by:
        +
        isThisType in interface MVDestination
        +
        Parameters:
        +
        plugin - The plugin who the type belongs to.
        +
        destination - The destination string. ex: p:MyPortal:nw
        +
        Returns:
        +
        True if the destination is valid, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        getLocation

        +
        public org.bukkit.Location getLocation​(org.bukkit.entity.Entity e)
        +
        Returns the location a specific entity will spawn at when being teleported to this Destination. +

        + To just retrieve the location as it is stored you can just pass null, but be warned some destinations may return + null back to you if you do this. It is always safer to pass an actual entity. This is used so things like + minecarts can be teleported. +

        + Do not forget to use MVDestination.getVelocity() as destinations can use this too!

        +
        +
        Specified by:
        +
        getLocation in interface MVDestination
        +
        Parameters:
        +
        e - The entity to be teleported.
        +
        Returns:
        +
        The location of the entity.
        +
        +
        • +
      + + + +
        +
      • +

        isValid

        +
        public boolean isValid()
        +
        Returns true if the destination is valid and players will be taken to it. +

        + Even if destinations are in the correct format (p:MyPortal) MyPortal may not exist, and therefore this would + return false.

        +
        +
        Specified by:
        +
        isValid in interface MVDestination
        +
        Returns:
        +
        True if the destination is valid; false if not.
        +
        +
        • +
      + + + +
        +
      • +

        setDestination

        +
        public void setDestination​(org.bukkit.plugin.java.JavaPlugin plugin,
+                           java.lang.String destination)
        +
        Sets the destination string. +

        + This should be used when you want to tell this destination object about a change in where it should take people. + The destination param should be match the result from MVDestination.getIdentifier(). A valid example would be that if + MVDestination.getIdentifier() returned "ow" our destination string could be "ow:TownCenter" but could not be + "p:HomePortal"

        +
        +
        Specified by:
        +
        setDestination in interface MVDestination
        +
        Parameters:
        +
        plugin - The plugin who the type belongs to.
        +
        destination - The destination string. ex: p:MyPortal:nw
        +
        +
        • +
      + + + +
        +
      • +

        getType

        +
        public java.lang.String getType()
        +
        Gives you a general friendly description of the type of destination. +

        + For example, the PlayerDestination sets this to "Player". You can use this to show where a player will be taken.

        +
        +
        Specified by:
        +
        getType in interface MVDestination
        +
        Returns:
        +
        A friendly string description of the type of destination.
        +
        +
        • +
      + + + +
        +
      • +

        getName

        +
        public java.lang.String getName()
        +
        Gives you a specific name of the destination. +

        + For example, the PlayerDestination sets this to The Player's Name.

        +
        +
        Specified by:
        +
        getName in interface MVDestination
        +
        Returns:
        +
        A friendly string stating the name of the destination.
        +
        +
        • +
      + + + +
        +
      • +

        setDestination

        +
        public void setDestination​(org.bukkit.Location location,
+                           double speed)
        +
        Sets this CannonDestination.
        +
        +
        Parameters:
        +
        location - The Location.
        +
        speed - The speed.
        +
        +
        • +
      + + + +
        +
      • +

        getRequiredPermission

        +
        public java.lang.String getRequiredPermission()
        +
        Returns the permissions string required to go here. +

        + ex: multiverse.access.world +

        + NOTE: This is NOT the permission to use the teleport command.

        +
        +
        Specified by:
        +
        getRequiredPermission in interface MVDestination
        +
        Returns:
        +
        the permissions string required to go here.
        +
        +
        • +
      + + + +
        +
      • +

        useSafeTeleporter

        +
        public boolean useSafeTeleporter()
        +
        Should the Multiverse SafeTeleporter be used? +

        + If not, MV will blindly take people to the location specified.

        +
        +
        Specified by:
        +
        useSafeTeleporter in interface MVDestination
        +
        Returns:
        +
        True if the SafeTeleporter will be used, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        Description copied from interface: MVDestination
        +
        Returns a string that can easily be saved in the config that contains all the details needed to rebuild this + destination. +

        + ex: e:0,0,0:50:50

        +
        +
        Specified by:
        +
        toString in interface MVDestination
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        Returns:
        +
        The savable config string.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/destination/CustomTeleporterDestination.html b/javadoc/latest/com/onarandombox/MultiverseCore/destination/CustomTeleporterDestination.html new file mode 100644 index 000000000..1ae488ed8 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/destination/CustomTeleporterDestination.html @@ -0,0 +1,430 @@ + + + + + +CustomTeleporterDestination (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.destination
+

Class CustomTeleporterDestination

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.destination.CustomTeleporterDestination
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    MVDestination
    +
    +
    +
    public abstract class CustomTeleporterDestination
+extends java.lang.Object
+implements MVDestination
    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        CustomTeleporterDestination

        +
        public CustomTeleporterDestination()
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getLocation

        +
        public final org.bukkit.Location getLocation​(org.bukkit.entity.Entity entity)
        +
        Description copied from interface: MVDestination
        +
        Returns the location a specific entity will spawn at when being teleported to this Destination. +

        + To just retrieve the location as it is stored you can just pass null, but be warned some destinations may return + null back to you if you do this. It is always safer to pass an actual entity. This is used so things like + minecarts can be teleported. +

        + Do not forget to use MVDestination.getVelocity() as destinations can use this too!

        +
        +
        Specified by:
        +
        getLocation in interface MVDestination
        +
        Parameters:
        +
        entity - The entity to be teleported.
        +
        Returns:
        +
        The location of the entity.
        +
        +
        • +
      + + + +
        +
      • +

        getVelocity

        +
        public final org.bukkit.util.Vector getVelocity()
        +
        Description copied from interface: MVDestination
        +
        Returns the velocity vector for this destination. +

        + Plugins wishing to fully support MVDestinations MUST implement this.

        +
        +
        Specified by:
        +
        getVelocity in interface MVDestination
        +
        Returns:
        +
        A vector representing the speed/direction the player should travel when arriving
        +
        +
        • +
      + + + +
        +
      • +

        useSafeTeleporter

        +
        public final boolean useSafeTeleporter()
        +
        Description copied from interface: MVDestination
        +
        Should the Multiverse SafeTeleporter be used? +

        + If not, MV will blindly take people to the location specified.

        +
        +
        Specified by:
        +
        useSafeTeleporter in interface MVDestination
        +
        Returns:
        +
        True if the SafeTeleporter will be used, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public abstract java.lang.String toString()
        +
        Description copied from interface: MVDestination
        +
        Returns a string that can easily be saved in the config that contains all the details needed to rebuild this + destination. +

        + ex: e:0,0,0:50:50

        +
        +
        Specified by:
        +
        toString in interface MVDestination
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        Returns:
        +
        The savable config string.
        +
        +
        • +
      + + + +
        +
      • +

        getTeleporter

        +
        public abstract Teleporter getTeleporter()
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/destination/DestinationFactory.html b/javadoc/latest/com/onarandombox/MultiverseCore/destination/DestinationFactory.html new file mode 100644 index 000000000..1c0bf168e --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/destination/DestinationFactory.html @@ -0,0 +1,391 @@ + + + + + +DestinationFactory (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.destination
+

Class DestinationFactory

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.destination.DestinationFactory
      • +
    +
    • +
+
+
    +
  • +
    +
    public class DestinationFactory
+extends java.lang.Object
    +
    A factory class that will create destinations from specific strings.
    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        DestinationFactory

        +
        public DestinationFactory​(MultiverseCore plugin)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getPlayerAwareDestination

        +
        @NotNull
+public @NotNull MVDestination getPlayerAwareDestination​(@NotNull
+                                                        @NotNull org.bukkit.entity.Player teleportee,
+                                                        @NotNull
+                                                        @NotNull java.lang.String destinationName)
        +
        Parse a destination that has relation to sender, such as a cannon or player destination.
        +
        +
        Parameters:
        +
        teleportee - The player that is going to be teleported.
        +
        destinationName - The destination to parse.
        +
        Returns:
        +
        A non-null MVDestination
        +
        +
        • +
      + + + +
        +
      • +

        getDestination

        +
        public MVDestination getDestination​(java.lang.String destination)
        +
        Gets a new destination from a string. + Returns a new InvalidDestination if the string could not be parsed.
        +
        +
        Parameters:
        +
        destination - The destination in string format.
        +
        Returns:
        +
        A non-null MVDestination
        +
        +
        • +
      + + + +
        +
      • +

        registerDestinationType

        +
        public boolean registerDestinationType​(java.lang.Class<? extends MVDestination> c,
+                                       java.lang.String identifier)
        +
        Registers a MVDestination.
        +
        +
        Parameters:
        +
        c - The Class of the MVDestination to register.
        +
        identifier - The String-identifier.
        +
        Returns:
        +
        True if the class was successfully registered.
        +
        +
        • +
      + + + +
        +
      • +

        getRegisteredIdentifiers

        +
        public java.util.Collection<java.lang.String> getRegisteredIdentifiers()
        +
        Gets all the MVDestination identifiers registered.
        +
        +
        Returns:
        +
        A collection of destination identifiers.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/destination/ExactDestination.html b/javadoc/latest/com/onarandombox/MultiverseCore/destination/ExactDestination.html new file mode 100644 index 000000000..f4a709cd9 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/destination/ExactDestination.html @@ -0,0 +1,622 @@ + + + + + +ExactDestination (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.destination
+

Class ExactDestination

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.destination.ExactDestination
      • +
    +
    • +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      ExactDestination() 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      java.lang.StringgetIdentifier() +
      Returns the identifier or prefix that is required for this destination.
      +
      org.bukkit.LocationgetLocation​(org.bukkit.entity.Entity e) +
      Returns the location a specific entity will spawn at when being teleported to this Destination.
      +
      java.lang.StringgetName() +
      Gives you a specific name of the destination.
      +
      java.lang.StringgetRequiredPermission() +
      Returns the permissions string required to go here.
      +
      java.lang.StringgetType() +
      Gives you a general friendly description of the type of destination.
      +
      org.bukkit.util.VectorgetVelocity() +
      Returns the velocity vector for this destination.
      +
      booleanisThisType​(org.bukkit.plugin.java.JavaPlugin plugin, + java.lang.String destination) +
      Allows you to determine if a Destination is valid for the type it thinks it is.
      +
      booleanisValid() +
      Returns true if the destination is valid and players will be taken to it.
      +
      voidsetDestination​(org.bukkit.Location location) +
      Sets this ExactDestination.
      +
      voidsetDestination​(org.bukkit.plugin.java.JavaPlugin plugin, + java.lang.String destination) +
      Sets the destination string.
      +
      java.lang.StringtoString() +
      Returns a string that can easily be saved in the config that contains all the details needed to rebuild this + destination.
      +
      booleanuseSafeTeleporter() +
      Should the Multiverse SafeTeleporter be used?
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ExactDestination

        +
        public ExactDestination()
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getIdentifier

        +
        public java.lang.String getIdentifier()
        +
        Returns the identifier or prefix that is required for this destination. +

        + Portals have a prefix of "p" for example and OpenWarp (third party plugin) uses "ow". This is derived from a + hash and cannot have duplicate values. Read that as your plugin cannot use 'p' because it's already used. + Please check the wiki when adding a custom destination!

        +
        +
        Specified by:
        +
        getIdentifier in interface MVDestination
        +
        Returns:
        +
        The identifier or prefix that is required for this destination.
        +
        +
        • +
      + + + +
        +
      • +

        getVelocity

        +
        public org.bukkit.util.Vector getVelocity()
        +
        Returns the velocity vector for this destination. +

        + Plugins wishing to fully support MVDestinations MUST implement this.

        +
        +
        Specified by:
        +
        getVelocity in interface MVDestination
        +
        Returns:
        +
        A vector representing the speed/direction the player should travel when arriving
        +
        +
        • +
      + + + +
        +
      • +

        isThisType

        +
        public boolean isThisType​(org.bukkit.plugin.java.JavaPlugin plugin,
+                          java.lang.String destination)
        +
        Allows you to determine if a Destination is valid for the type it thinks it is. +

        + An example of this would be the exact destination. A valid string would be: e:0,0,0 where an invalid one would + be e:1:2:3. The first string would return true the second would return false. This is simply a convenience + method + and does not even NEED to be called, but it's highly recommended if you're teleporting, but it's mainly for + Multiverse Internal use.

        +
        +
        Specified by:
        +
        isThisType in interface MVDestination
        +
        Parameters:
        +
        plugin - The plugin who the type belongs to.
        +
        destination - The destination string. ex: p:MyPortal:nw
        +
        Returns:
        +
        True if the destination is valid, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        getLocation

        +
        public org.bukkit.Location getLocation​(org.bukkit.entity.Entity e)
        +
        Returns the location a specific entity will spawn at when being teleported to this Destination. +

        + To just retrieve the location as it is stored you can just pass null, but be warned some destinations may return + null back to you if you do this. It is always safer to pass an actual entity. This is used so things like + minecarts can be teleported. +

        + Do not forget to use MVDestination.getVelocity() as destinations can use this too!

        +
        +
        Specified by:
        +
        getLocation in interface MVDestination
        +
        Parameters:
        +
        e - The entity to be teleported.
        +
        Returns:
        +
        The location of the entity.
        +
        +
        • +
      + + + +
        +
      • +

        isValid

        +
        public boolean isValid()
        +
        Returns true if the destination is valid and players will be taken to it. +

        + Even if destinations are in the correct format (p:MyPortal) MyPortal may not exist, and therefore this would + return false.

        +
        +
        Specified by:
        +
        isValid in interface MVDestination
        +
        Returns:
        +
        True if the destination is valid; false if not.
        +
        +
        • +
      + + + +
        +
      • +

        setDestination

        +
        public void setDestination​(org.bukkit.plugin.java.JavaPlugin plugin,
+                           java.lang.String destination)
        +
        Sets the destination string. +

        + This should be used when you want to tell this destination object about a change in where it should take people. + The destination param should be match the result from MVDestination.getIdentifier(). A valid example would be that if + MVDestination.getIdentifier() returned "ow" our destination string could be "ow:TownCenter" but could not be + "p:HomePortal"

        +
        +
        Specified by:
        +
        setDestination in interface MVDestination
        +
        Parameters:
        +
        plugin - The plugin who the type belongs to.
        +
        destination - The destination string. ex: p:MyPortal:nw
        +
        +
        • +
      + + + +
        +
      • +

        getType

        +
        public java.lang.String getType()
        +
        Gives you a general friendly description of the type of destination. +

        + For example, the PlayerDestination sets this to "Player". You can use this to show where a player will be taken.

        +
        +
        Specified by:
        +
        getType in interface MVDestination
        +
        Returns:
        +
        A friendly string description of the type of destination.
        +
        +
        • +
      + + + +
        +
      • +

        getName

        +
        public java.lang.String getName()
        +
        Gives you a specific name of the destination. +

        + For example, the PlayerDestination sets this to The Player's Name.

        +
        +
        Specified by:
        +
        getName in interface MVDestination
        +
        Returns:
        +
        A friendly string stating the name of the destination.
        +
        +
        • +
      + + + +
        +
      • +

        setDestination

        +
        public void setDestination​(org.bukkit.Location location)
        +
        Sets this ExactDestination.
        +
        +
        Parameters:
        +
        location - The Location.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        Returns a string that can easily be saved in the config that contains all the details needed to rebuild this + destination. +

        + ex: e:0,0,0:50:50

        +
        +
        Specified by:
        +
        toString in interface MVDestination
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        Returns:
        +
        The savable config string.
        +
        +
        • +
      + + + +
        +
      • +

        getRequiredPermission

        +
        public java.lang.String getRequiredPermission()
        +
        Returns the permissions string required to go here. +

        + ex: multiverse.access.world +

        + NOTE: This is NOT the permission to use the teleport command.

        +
        +
        Specified by:
        +
        getRequiredPermission in interface MVDestination
        +
        Returns:
        +
        the permissions string required to go here.
        +
        +
        • +
      + + + +
        +
      • +

        useSafeTeleporter

        +
        public boolean useSafeTeleporter()
        +
        Should the Multiverse SafeTeleporter be used? +

        + If not, MV will blindly take people to the location specified.

        +
        +
        Specified by:
        +
        useSafeTeleporter in interface MVDestination
        +
        Returns:
        +
        True if the SafeTeleporter will be used, false if not.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/destination/InvalidDestination.html b/javadoc/latest/com/onarandombox/MultiverseCore/destination/InvalidDestination.html new file mode 100644 index 000000000..abdee886f --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/destination/InvalidDestination.html @@ -0,0 +1,602 @@ + + + + + +InvalidDestination (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.destination
+

Class InvalidDestination

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.destination.InvalidDestination
      • +
    +
    • +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      InvalidDestination() 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      java.lang.StringgetIdentifier() +
      Returns the identifier or prefix that is required for this destination.
      +
      org.bukkit.LocationgetLocation​(org.bukkit.entity.Entity e) +
      Returns the location a specific entity will spawn at when being teleported to this Destination.
      +
      java.lang.StringgetName() +
      Gives you a specific name of the destination.
      +
      java.lang.StringgetRequiredPermission() +
      Returns the permissions string required to go here.
      +
      java.lang.StringgetType() +
      Gives you a general friendly description of the type of destination.
      +
      org.bukkit.util.VectorgetVelocity() +
      Returns the velocity vector for this destination.
      +
      booleanisThisType​(org.bukkit.plugin.java.JavaPlugin plugin, + java.lang.String destination) +
      Allows you to determine if a Destination is valid for the type it thinks it is.
      +
      booleanisValid() +
      Returns true if the destination is valid and players will be taken to it.
      +
      voidsetDestination​(org.bukkit.plugin.java.JavaPlugin plugin, + java.lang.String destination) +
      Sets the destination string.
      +
      java.lang.StringtoString() +
      Returns a string that can easily be saved in the config that contains all the details needed to rebuild this + destination.
      +
      booleanuseSafeTeleporter() +
      Should the Multiverse SafeTeleporter be used?
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        InvalidDestination

        +
        public InvalidDestination()
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getIdentifier

        +
        public java.lang.String getIdentifier()
        +
        Returns the identifier or prefix that is required for this destination. +

        + Portals have a prefix of "p" for example and OpenWarp (third party plugin) uses "ow". This is derived from a + hash and cannot have duplicate values. Read that as your plugin cannot use 'p' because it's already used. + Please check the wiki when adding a custom destination!

        +
        +
        Specified by:
        +
        getIdentifier in interface MVDestination
        +
        Returns:
        +
        The identifier or prefix that is required for this destination.
        +
        +
        • +
      + + + +
        +
      • +

        isThisType

        +
        public boolean isThisType​(org.bukkit.plugin.java.JavaPlugin plugin,
+                          java.lang.String destination)
        +
        Allows you to determine if a Destination is valid for the type it thinks it is. +

        + An example of this would be the exact destination. A valid string would be: e:0,0,0 where an invalid one would + be e:1:2:3. The first string would return true the second would return false. This is simply a convenience + method + and does not even NEED to be called, but it's highly recommended if you're teleporting, but it's mainly for + Multiverse Internal use.

        +
        +
        Specified by:
        +
        isThisType in interface MVDestination
        +
        Parameters:
        +
        plugin - The plugin who the type belongs to.
        +
        destination - The destination string. ex: p:MyPortal:nw
        +
        Returns:
        +
        True if the destination is valid, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        getLocation

        +
        public org.bukkit.Location getLocation​(org.bukkit.entity.Entity e)
        +
        Returns the location a specific entity will spawn at when being teleported to this Destination. +

        + To just retrieve the location as it is stored you can just pass null, but be warned some destinations may return + null back to you if you do this. It is always safer to pass an actual entity. This is used so things like + minecarts can be teleported. +

        + Do not forget to use MVDestination.getVelocity() as destinations can use this too!

        +
        +
        Specified by:
        +
        getLocation in interface MVDestination
        +
        Parameters:
        +
        e - The entity to be teleported.
        +
        Returns:
        +
        The location of the entity.
        +
        +
        • +
      + + + +
        +
      • +

        isValid

        +
        public boolean isValid()
        +
        Returns true if the destination is valid and players will be taken to it. +

        + Even if destinations are in the correct format (p:MyPortal) MyPortal may not exist, and therefore this would + return false.

        +
        +
        Specified by:
        +
        isValid in interface MVDestination
        +
        Returns:
        +
        True if the destination is valid; false if not.
        +
        +
        • +
      + + + +
        +
      • +

        setDestination

        +
        public void setDestination​(org.bukkit.plugin.java.JavaPlugin plugin,
+                           java.lang.String destination)
        +
        Sets the destination string. +

        + This should be used when you want to tell this destination object about a change in where it should take people. + The destination param should be match the result from MVDestination.getIdentifier(). A valid example would be that if + MVDestination.getIdentifier() returned "ow" our destination string could be "ow:TownCenter" but could not be + "p:HomePortal"

        +
        +
        Specified by:
        +
        setDestination in interface MVDestination
        +
        Parameters:
        +
        plugin - The plugin who the type belongs to.
        +
        destination - The destination string. ex: p:MyPortal:nw
        +
        +
        • +
      + + + +
        +
      • +

        getType

        +
        public java.lang.String getType()
        +
        Gives you a general friendly description of the type of destination. +

        + For example, the PlayerDestination sets this to "Player". You can use this to show where a player will be taken.

        +
        +
        Specified by:
        +
        getType in interface MVDestination
        +
        Returns:
        +
        A friendly string description of the type of destination.
        +
        +
        • +
      + + + +
        +
      • +

        getName

        +
        public java.lang.String getName()
        +
        Gives you a specific name of the destination. +

        + For example, the PlayerDestination sets this to The Player's Name.

        +
        +
        Specified by:
        +
        getName in interface MVDestination
        +
        Returns:
        +
        A friendly string stating the name of the destination.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        Description copied from interface: MVDestination
        +
        Returns a string that can easily be saved in the config that contains all the details needed to rebuild this + destination. +

        + ex: e:0,0,0:50:50

        +
        +
        Specified by:
        +
        toString in interface MVDestination
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        Returns:
        +
        The savable config string.
        +
        +
        • +
      + + + +
        +
      • +

        getRequiredPermission

        +
        public java.lang.String getRequiredPermission()
        +
        Returns the permissions string required to go here. +

        + ex: multiverse.access.world +

        + NOTE: This is NOT the permission to use the teleport command.

        +
        +
        Specified by:
        +
        getRequiredPermission in interface MVDestination
        +
        Returns:
        +
        the permissions string required to go here.
        +
        +
        • +
      + + + +
        +
      • +

        getVelocity

        +
        public org.bukkit.util.Vector getVelocity()
        +
        Returns the velocity vector for this destination. +

        + Plugins wishing to fully support MVDestinations MUST implement this.

        +
        +
        Specified by:
        +
        getVelocity in interface MVDestination
        +
        Returns:
        +
        A vector representing the speed/direction the player should travel when arriving
        +
        +
        • +
      + + + +
        +
      • +

        useSafeTeleporter

        +
        public boolean useSafeTeleporter()
        +
        Should the Multiverse SafeTeleporter be used? +

        + If not, MV will blindly take people to the location specified.

        +
        +
        Specified by:
        +
        useSafeTeleporter in interface MVDestination
        +
        Returns:
        +
        True if the SafeTeleporter will be used, false if not.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/destination/PlayerDestination.html b/javadoc/latest/com/onarandombox/MultiverseCore/destination/PlayerDestination.html new file mode 100644 index 000000000..665c461c8 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/destination/PlayerDestination.html @@ -0,0 +1,602 @@ + + + + + +PlayerDestination (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.destination
+

Class PlayerDestination

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.destination.PlayerDestination
      • +
    +
    • +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      PlayerDestination() 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      java.lang.StringgetIdentifier() +
      Returns the identifier or prefix that is required for this destination.
      +
      org.bukkit.LocationgetLocation​(org.bukkit.entity.Entity e) +
      Returns the location a specific entity will spawn at when being teleported to this Destination.
      +
      java.lang.StringgetName() +
      Gives you a specific name of the destination.
      +
      java.lang.StringgetRequiredPermission() +
      Returns the permissions string required to go here.
      +
      java.lang.StringgetType() +
      Gives you a general friendly description of the type of destination.
      +
      org.bukkit.util.VectorgetVelocity() +
      Returns the velocity vector for this destination.
      +
      booleanisThisType​(org.bukkit.plugin.java.JavaPlugin plugin, + java.lang.String destination) +
      Allows you to determine if a Destination is valid for the type it thinks it is.
      +
      booleanisValid() +
      Returns true if the destination is valid and players will be taken to it.
      +
      voidsetDestination​(org.bukkit.plugin.java.JavaPlugin plugin, + java.lang.String destination) +
      Sets the destination string.
      +
      java.lang.StringtoString() +
      Returns a string that can easily be saved in the config that contains all the details needed to rebuild this + destination.
      +
      booleanuseSafeTeleporter() +
      Should the Multiverse SafeTeleporter be used?
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PlayerDestination

        +
        public PlayerDestination()
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getIdentifier

        +
        public java.lang.String getIdentifier()
        +
        Returns the identifier or prefix that is required for this destination. +

        + Portals have a prefix of "p" for example and OpenWarp (third party plugin) uses "ow". This is derived from a + hash and cannot have duplicate values. Read that as your plugin cannot use 'p' because it's already used. + Please check the wiki when adding a custom destination!

        +
        +
        Specified by:
        +
        getIdentifier in interface MVDestination
        +
        Returns:
        +
        The identifier or prefix that is required for this destination.
        +
        +
        • +
      + + + +
        +
      • +

        isThisType

        +
        public boolean isThisType​(org.bukkit.plugin.java.JavaPlugin plugin,
+                          java.lang.String destination)
        +
        Allows you to determine if a Destination is valid for the type it thinks it is. +

        + An example of this would be the exact destination. A valid string would be: e:0,0,0 where an invalid one would + be e:1:2:3. The first string would return true the second would return false. This is simply a convenience + method + and does not even NEED to be called, but it's highly recommended if you're teleporting, but it's mainly for + Multiverse Internal use.

        +
        +
        Specified by:
        +
        isThisType in interface MVDestination
        +
        Parameters:
        +
        plugin - The plugin who the type belongs to.
        +
        destination - The destination string. ex: p:MyPortal:nw
        +
        Returns:
        +
        True if the destination is valid, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        getLocation

        +
        public org.bukkit.Location getLocation​(org.bukkit.entity.Entity e)
        +
        Returns the location a specific entity will spawn at when being teleported to this Destination. +

        + To just retrieve the location as it is stored you can just pass null, but be warned some destinations may return + null back to you if you do this. It is always safer to pass an actual entity. This is used so things like + minecarts can be teleported. +

        + Do not forget to use MVDestination.getVelocity() as destinations can use this too!

        +
        +
        Specified by:
        +
        getLocation in interface MVDestination
        +
        Parameters:
        +
        e - The entity to be teleported.
        +
        Returns:
        +
        The location of the entity.
        +
        +
        • +
      + + + +
        +
      • +

        isValid

        +
        public boolean isValid()
        +
        Returns true if the destination is valid and players will be taken to it. +

        + Even if destinations are in the correct format (p:MyPortal) MyPortal may not exist, and therefore this would + return false.

        +
        +
        Specified by:
        +
        isValid in interface MVDestination
        +
        Returns:
        +
        True if the destination is valid; false if not.
        +
        +
        • +
      + + + +
        +
      • +

        setDestination

        +
        public void setDestination​(org.bukkit.plugin.java.JavaPlugin plugin,
+                           java.lang.String destination)
        +
        Sets the destination string. +

        + This should be used when you want to tell this destination object about a change in where it should take people. + The destination param should be match the result from MVDestination.getIdentifier(). A valid example would be that if + MVDestination.getIdentifier() returned "ow" our destination string could be "ow:TownCenter" but could not be + "p:HomePortal"

        +
        +
        Specified by:
        +
        setDestination in interface MVDestination
        +
        Parameters:
        +
        plugin - The plugin who the type belongs to.
        +
        destination - The destination string. ex: p:MyPortal:nw
        +
        +
        • +
      + + + +
        +
      • +

        getType

        +
        public java.lang.String getType()
        +
        Gives you a general friendly description of the type of destination. +

        + For example, the PlayerDestination sets this to "Player". You can use this to show where a player will be taken.

        +
        +
        Specified by:
        +
        getType in interface MVDestination
        +
        Returns:
        +
        A friendly string description of the type of destination.
        +
        +
        • +
      + + + +
        +
      • +

        getName

        +
        public java.lang.String getName()
        +
        Gives you a specific name of the destination. +

        + For example, the PlayerDestination sets this to The Player's Name.

        +
        +
        Specified by:
        +
        getName in interface MVDestination
        +
        Returns:
        +
        A friendly string stating the name of the destination.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        Description copied from interface: MVDestination
        +
        Returns a string that can easily be saved in the config that contains all the details needed to rebuild this + destination. +

        + ex: e:0,0,0:50:50

        +
        +
        Specified by:
        +
        toString in interface MVDestination
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        Returns:
        +
        The savable config string.
        +
        +
        • +
      + + + +
        +
      • +

        getRequiredPermission

        +
        public java.lang.String getRequiredPermission()
        +
        Returns the permissions string required to go here. +

        + ex: multiverse.access.world +

        + NOTE: This is NOT the permission to use the teleport command.

        +
        +
        Specified by:
        +
        getRequiredPermission in interface MVDestination
        +
        Returns:
        +
        the permissions string required to go here.
        +
        +
        • +
      + + + +
        +
      • +

        getVelocity

        +
        public org.bukkit.util.Vector getVelocity()
        +
        Returns the velocity vector for this destination. +

        + Plugins wishing to fully support MVDestinations MUST implement this.

        +
        +
        Specified by:
        +
        getVelocity in interface MVDestination
        +
        Returns:
        +
        A vector representing the speed/direction the player should travel when arriving
        +
        +
        • +
      + + + +
        +
      • +

        useSafeTeleporter

        +
        public boolean useSafeTeleporter()
        +
        Should the Multiverse SafeTeleporter be used? +

        + If not, MV will blindly take people to the location specified.

        +
        +
        Specified by:
        +
        useSafeTeleporter in interface MVDestination
        +
        Returns:
        +
        True if the SafeTeleporter will be used, false if not.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/destination/WorldDestination.html b/javadoc/latest/com/onarandombox/MultiverseCore/destination/WorldDestination.html new file mode 100644 index 000000000..3e1be2de4 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/destination/WorldDestination.html @@ -0,0 +1,602 @@ + + + + + +WorldDestination (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.destination
+

Class WorldDestination

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.destination.WorldDestination
      • +
    +
    • +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      WorldDestination() 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      java.lang.StringgetIdentifier() +
      Returns the identifier or prefix that is required for this destination.
      +
      org.bukkit.LocationgetLocation​(org.bukkit.entity.Entity e) +
      Returns the location a specific entity will spawn at when being teleported to this Destination.
      +
      java.lang.StringgetName() +
      Gives you a specific name of the destination.
      +
      java.lang.StringgetRequiredPermission() +
      Returns the permissions string required to go here.
      +
      java.lang.StringgetType() +
      Gives you a general friendly description of the type of destination.
      +
      org.bukkit.util.VectorgetVelocity() +
      Returns the velocity vector for this destination.
      +
      booleanisThisType​(org.bukkit.plugin.java.JavaPlugin plugin, + java.lang.String destination) +
      Allows you to determine if a Destination is valid for the type it thinks it is.
      +
      booleanisValid() +
      Returns true if the destination is valid and players will be taken to it.
      +
      voidsetDestination​(org.bukkit.plugin.java.JavaPlugin plugin, + java.lang.String destination) +
      Sets the destination string.
      +
      java.lang.StringtoString() +
      Returns a string that can easily be saved in the config that contains all the details needed to rebuild this + destination.
      +
      booleanuseSafeTeleporter() +
      Should the Multiverse SafeTeleporter be used?
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        WorldDestination

        +
        public WorldDestination()
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getIdentifier

        +
        public java.lang.String getIdentifier()
        +
        Returns the identifier or prefix that is required for this destination. +

        + Portals have a prefix of "p" for example and OpenWarp (third party plugin) uses "ow". This is derived from a + hash and cannot have duplicate values. Read that as your plugin cannot use 'p' because it's already used. + Please check the wiki when adding a custom destination!

        +
        +
        Specified by:
        +
        getIdentifier in interface MVDestination
        +
        Returns:
        +
        The identifier or prefix that is required for this destination.
        +
        +
        • +
      + + + +
        +
      • +

        isThisType

        +
        public boolean isThisType​(org.bukkit.plugin.java.JavaPlugin plugin,
+                          java.lang.String destination)
        +
        Allows you to determine if a Destination is valid for the type it thinks it is. +

        + An example of this would be the exact destination. A valid string would be: e:0,0,0 where an invalid one would + be e:1:2:3. The first string would return true the second would return false. This is simply a convenience + method + and does not even NEED to be called, but it's highly recommended if you're teleporting, but it's mainly for + Multiverse Internal use.

        +
        +
        Specified by:
        +
        isThisType in interface MVDestination
        +
        Parameters:
        +
        plugin - The plugin who the type belongs to.
        +
        destination - The destination string. ex: p:MyPortal:nw
        +
        Returns:
        +
        True if the destination is valid, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        getLocation

        +
        public org.bukkit.Location getLocation​(org.bukkit.entity.Entity e)
        +
        Returns the location a specific entity will spawn at when being teleported to this Destination. +

        + To just retrieve the location as it is stored you can just pass null, but be warned some destinations may return + null back to you if you do this. It is always safer to pass an actual entity. This is used so things like + minecarts can be teleported. +

        + Do not forget to use MVDestination.getVelocity() as destinations can use this too!

        +
        +
        Specified by:
        +
        getLocation in interface MVDestination
        +
        Parameters:
        +
        e - The entity to be teleported.
        +
        Returns:
        +
        The location of the entity.
        +
        +
        • +
      + + + +
        +
      • +

        isValid

        +
        public boolean isValid()
        +
        Returns true if the destination is valid and players will be taken to it. +

        + Even if destinations are in the correct format (p:MyPortal) MyPortal may not exist, and therefore this would + return false.

        +
        +
        Specified by:
        +
        isValid in interface MVDestination
        +
        Returns:
        +
        True if the destination is valid; false if not.
        +
        +
        • +
      + + + +
        +
      • +

        setDestination

        +
        public void setDestination​(org.bukkit.plugin.java.JavaPlugin plugin,
+                           java.lang.String destination)
        +
        Sets the destination string. +

        + This should be used when you want to tell this destination object about a change in where it should take people. + The destination param should be match the result from MVDestination.getIdentifier(). A valid example would be that if + MVDestination.getIdentifier() returned "ow" our destination string could be "ow:TownCenter" but could not be + "p:HomePortal"

        +
        +
        Specified by:
        +
        setDestination in interface MVDestination
        +
        Parameters:
        +
        plugin - The plugin who the type belongs to.
        +
        destination - The destination string. ex: p:MyPortal:nw
        +
        +
        • +
      + + + +
        +
      • +

        getType

        +
        public java.lang.String getType()
        +
        Gives you a general friendly description of the type of destination. +

        + For example, the PlayerDestination sets this to "Player". You can use this to show where a player will be taken.

        +
        +
        Specified by:
        +
        getType in interface MVDestination
        +
        Returns:
        +
        A friendly string description of the type of destination.
        +
        +
        • +
      + + + +
        +
      • +

        getName

        +
        public java.lang.String getName()
        +
        Gives you a specific name of the destination. +

        + For example, the PlayerDestination sets this to The Player's Name.

        +
        +
        Specified by:
        +
        getName in interface MVDestination
        +
        Returns:
        +
        A friendly string stating the name of the destination.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        Description copied from interface: MVDestination
        +
        Returns a string that can easily be saved in the config that contains all the details needed to rebuild this + destination. +

        + ex: e:0,0,0:50:50

        +
        +
        Specified by:
        +
        toString in interface MVDestination
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        Returns:
        +
        The savable config string.
        +
        +
        • +
      + + + +
        +
      • +

        getRequiredPermission

        +
        public java.lang.String getRequiredPermission()
        +
        Returns the permissions string required to go here. +

        + ex: multiverse.access.world +

        + NOTE: This is NOT the permission to use the teleport command.

        +
        +
        Specified by:
        +
        getRequiredPermission in interface MVDestination
        +
        Returns:
        +
        the permissions string required to go here.
        +
        +
        • +
      + + + +
        +
      • +

        getVelocity

        +
        public org.bukkit.util.Vector getVelocity()
        +
        Returns the velocity vector for this destination. +

        + Plugins wishing to fully support MVDestinations MUST implement this.

        +
        +
        Specified by:
        +
        getVelocity in interface MVDestination
        +
        Returns:
        +
        A vector representing the speed/direction the player should travel when arriving
        +
        +
        • +
      + + + +
        +
      • +

        useSafeTeleporter

        +
        public boolean useSafeTeleporter()
        +
        Should the Multiverse SafeTeleporter be used? +

        + If not, MV will blindly take people to the location specified.

        +
        +
        Specified by:
        +
        useSafeTeleporter in interface MVDestination
        +
        Returns:
        +
        True if the SafeTeleporter will be used, false if not.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/destination/package-summary.html b/javadoc/latest/com/onarandombox/MultiverseCore/destination/package-summary.html new file mode 100644 index 000000000..66d12055c --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/destination/package-summary.html @@ -0,0 +1,217 @@ + + + + + +com.onarandombox.MultiverseCore.destination (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+
+
+

Package com.onarandombox.MultiverseCore.destination

+
+
+
+ + +
This package contains all destination-types.
+
+ +
+
+ + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/destination/package-tree.html b/javadoc/latest/com/onarandombox/MultiverseCore/destination/package-tree.html new file mode 100644 index 000000000..4966b444a --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/destination/package-tree.html @@ -0,0 +1,169 @@ + + + + + +com.onarandombox.MultiverseCore.destination Class Hierarchy (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package com.onarandombox.MultiverseCore.destination

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+ +
+
+
+ + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/display/ColorAlternator.html b/javadoc/latest/com/onarandombox/MultiverseCore/display/ColorAlternator.html new file mode 100644 index 000000000..2823af8f9 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/display/ColorAlternator.html @@ -0,0 +1,409 @@ + + + + + +ColorAlternator (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.display
+

Class ColorAlternator

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.display.ColorAlternator
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    ColorTool
    +
    +
    +
    public class ColorAlternator
+extends java.lang.Object
+implements ColorTool
    +
    Helper class to switch between 2 ChatColor.
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from interface com.onarandombox.MultiverseCore.display.ColorTool

        +DEFAULT
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      ColorAlternator​(@NotNull org.bukkit.ChatColor colorThis, + @NotNull org.bukkit.ChatColor colorThat) 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      org.bukkit.ChatColorget() +
      Gets the color.
      +
      org.bukkit.ChatColorgetThatColor() 
      org.bukkit.ChatColorgetThisColor() 
      static ColorAlternatorwith​(@NotNull org.bukkit.ChatColor colorThis, + @NotNull org.bukkit.ChatColor colorThat) +
      Creates a new ColorAlternator with 2 ChatColors.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        ColorAlternator

        +
        public ColorAlternator​(@NotNull
+                       @NotNull org.bukkit.ChatColor colorThis,
+                       @NotNull
+                       @NotNull org.bukkit.ChatColor colorThat)
        +
        +
        Parameters:
        +
        colorThis - The first color.
        +
        colorThat - The second color.
        +
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        with

        +
        public static ColorAlternator with​(@NotNull
+                                   @NotNull org.bukkit.ChatColor colorThis,
+                                   @NotNull
+                                   @NotNull org.bukkit.ChatColor colorThat)
        +
        Creates a new ColorAlternator with 2 ChatColors.
        +
        +
        Parameters:
        +
        colorThis - The first color.
        +
        colorThat - The second color.
        +
        Returns:
        +
        The ColorAlternator created for you.
        +
        +
        • +
      + + + +
        +
      • +

        get

        +
        public org.bukkit.ChatColor get()
        +
        Gets the color. Everytime this method is called, it swaps the color that it returns.
        +
        +
        Specified by:
        +
        get in interface ColorTool
        +
        Returns:
        +
        The color.
        +
        +
        • +
      + + + +
        +
      • +

        getThisColor

        +
        public org.bukkit.ChatColor getThisColor()
        +
        +
        Returns:
        +
        The first color.
        +
        +
        • +
      + + + +
        +
      • +

        getThatColor

        +
        public org.bukkit.ChatColor getThatColor()
        +
        +
        Returns:
        +
        The second color.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/display/ColorTool.html b/javadoc/latest/com/onarandombox/MultiverseCore/display/ColorTool.html new file mode 100644 index 000000000..754037a56 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/display/ColorTool.html @@ -0,0 +1,310 @@ + + + + + +ColorTool (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.display
+

Interface ColorTool

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    ColorAlternator
    +
    +
    +
    Functional Interface:
    +
    This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
    +
    +
    +
    @FunctionalInterface
+public interface ColorTool
    +
    Tools to allow customisation.
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      static ColorToolDEFAULT +
      Default implementation of this interface.
      +
      +
      • +
    +
    + +
    + +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        DEFAULT

        +
        static final ColorTool DEFAULT
        +
        Default implementation of this interface. Returns a default white color.
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        get

        +
        org.bukkit.ChatColor get()
        +
        Gets a chat color.
        +
        +
        Returns:
        +
        The color.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/display/ContentDisplay.Builder.html b/javadoc/latest/com/onarandombox/MultiverseCore/display/ContentDisplay.Builder.html new file mode 100644 index 000000000..1f9144832 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/display/ContentDisplay.Builder.html @@ -0,0 +1,465 @@ + + + + + +ContentDisplay.Builder (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.display
+

Class ContentDisplay.Builder<T>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.display.ContentDisplay.Builder<T>
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    T - Type of content to display.
    +
    +
    +
    Enclosing class:
    +
    ContentDisplay<T>
    +
    +
    +
    public static class ContentDisplay.Builder<T>
+extends java.lang.Object
    +
    Builds a ContentDisplay.
    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        header

        +
        @NotNull
+public @NotNull ContentDisplay.Builder<T> header​(@NotNull
+                                                 @NotNull java.lang.String header,
+                                                 java.lang.Object... replacements)
        +
        Sets header to be displayed.
        +
        +
        Parameters:
        +
        header - The header text.
        +
        replacements - String formatting replacements.
        +
        Returns:
        +
        The builder.
        +
        +
        • +
      + + + +
        +
      • +

        emptyMessage

        +
        @NotNull
+public @NotNull ContentDisplay.Builder<T> emptyMessage​(@NotNull
+                                                       @NotNull java.lang.String emptyMessage,
+                                                       java.lang.Object... replacements)
        +
        Sets the message to show when no content is available for display.
        +
        +
        Parameters:
        +
        emptyMessage - The message text.
        +
        replacements - String formatting replacements.
        +
        Returns:
        +
        The builder.
        +
        +
        • +
      + + + +
        +
      • +

        displayHandler

        +
        @NotNull
+public @NotNull ContentDisplay.Builder<T> displayHandler​(@NotNull
+                                                         @NotNull DisplayHandler<T> displayHandler)
        +
        Sets the display handler that does the formatting and sending of content. Required.
        +
        +
        Parameters:
        +
        displayHandler - The display handler for the given content type.
        +
        Returns:
        +
        The builder.
        +
        +
        • +
      + + + +
        +
      • +

        colorTool

        +
        @NotNull
+public @NotNull ContentDisplay.Builder<T> colorTool​(@NotNull
+                                                    @NotNull ColorTool colorTool)
        +
        Sets the color tool used to make messages more colourful.
        +
        +
        Parameters:
        +
        colorTool - The color tool to use.
        +
        Returns:
        +
        The builder.
        +
        +
        • +
      + + + +
        +
      • +

        filter

        +
        @NotNull
+public @NotNull ContentDisplay.Builder<T> filter​(@NotNull
+                                                 @NotNull ContentFilter filter)
        +
        Sets content filter used to match specific content to be displayed.
        +
        +
        Parameters:
        +
        filter - The filter to use.
        +
        Returns:
        +
        The builder.
        +
        +
        • +
      + + + + + +
        +
      • +

        setting

        +
        @NotNull
+public <S> @NotNull ContentDisplay.Builder<T> setting​(@NotNull
+                                                      @NotNull DisplaySetting<S> setting,
+                                                      S value)
        +
        Sets other specific settings that may be used by the DisplayHandler.
        +
        +
        Type Parameters:
        +
        S - The type of setting.
        +
        Parameters:
        +
        setting - The settings option.
        +
        value - The value to set.
        +
        Returns:
        +
        The builder.
        +
        +
        • +
      + + + +
        +
      • +

        build

        +
        @NotNull
+public @NotNull ContentDisplay<T> build()
        +
        Validates and build the content display.
        +
        +
        Returns:
        +
        The content display.
        +
        +
        • +
      + + + +
        +
      • +

        show

        +
        public void show​(org.bukkit.command.CommandSender sender)
        +
        Build and show the content to the sender.
        +
        +
        Parameters:
        +
        sender - The CommandSender to show the display to.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/display/ContentDisplay.html b/javadoc/latest/com/onarandombox/MultiverseCore/display/ContentDisplay.html new file mode 100644 index 000000000..e58b50e2b --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/display/ContentDisplay.html @@ -0,0 +1,606 @@ + + + + + +ContentDisplay (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.display
+

Class ContentDisplay<T>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.display.ContentDisplay<T>
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    T - Type of content to display.
    +
    +
    +
    public class ContentDisplay<T>
+extends java.lang.Object
    +
    Helps to display contents such as list and maps in a nicely formatted fashion.
    +
    • +
+
+
+ +
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        forContent

        +
        public static <T> ContentDisplay.Builder<T> forContent​(T content)
        +
        Creates a ContentDisplay.Builder for the given content.
        +
        +
        Type Parameters:
        +
        T - The type of the content which can be inferred.
        +
        Parameters:
        +
        content - The content to be displayed.
        +
        Returns:
        +
        A new Builder.
        +
        +
        • +
      + + + +
        +
      • +

        forContent

        +
        public static ContentDisplay.Builder<java.util.Collection<java.lang.String>> forContent​(java.util.Collection<java.lang.String> content)
        +
        Creates a ContentDisplay.Builder for the given collection of content.
        +
        +
        Parameters:
        +
        content - The content to be displayed.
        +
        Returns:
        +
        A new Builder.
        +
        +
        • +
      + + + +
        +
      • +

        forContent

        +
        public static ContentDisplay.Builder<java.util.Map<java.lang.String,​java.lang.Object>> forContent​(java.util.Map<java.lang.String,​java.lang.Object> content)
        +
        Creates a ContentDisplay.Builder for the given map of content.
        +
        +
        Parameters:
        +
        content - The content to be displayed.
        +
        Returns:
        +
        A new Builder.
        +
        +
        • +
      + + + +
        +
      • +

        show

        +
        public void show​(@NotNull
+                 @NotNull org.bukkit.command.CommandSender sender)
        +
        Do the actual displaying of contents to the sender.
        +
        +
        Parameters:
        +
        sender - The CommandSender to show the display to.
        +
        +
        • +
      + + + +
        +
      • +

        getHeader

        +
        public java.lang.String getHeader()
        +
        +
        Returns:
        +
        Gets the header to display.
        +
        +
        • +
      + + + +
        +
      • +

        setHeader

        +
        public void setHeader​(@NotNull
+                      @NotNull java.lang.String header)
        +
        Sets the header text.
        +
        • +
      + + + +
        +
      • +

        getContents

        +
        public T getContents()
        +
        +
        Returns:
        +
        Gets the contents to display.
        +
        +
        • +
      + + + +
        +
      • +

        getEmptyMessage

        +
        @NotNull
+public @NotNull java.lang.String getEmptyMessage()
        +
        +
        Returns:
        +
        Gets the message to display when no content is shown.
        +
        +
        • +
      + + + +
        +
      • +

        getDisplayHandler

        +
        @NotNull
+public @NotNull DisplayHandler<T> getDisplayHandler()
        +
        +
        Returns:
        +
        Gets the display handler that formats and sends content to sender.
        +
        +
        • +
      + + + +
        +
      • +

        getColorTool

        +
        @NotNull
+public @NotNull ColorTool getColorTool()
        +
        +
        Returns:
        +
        Gets the color tool used.
        +
        +
        • +
      + + + +
        +
      • +

        getFilter

        +
        @NotNull
+public @NotNull ContentFilter getFilter()
        +
        +
        Returns:
        +
        Gets the filter used.
        +
        +
        • +
      + + + +
        +
      • +

        getSetting

        +
        public <S> S getSetting​(@NotNull
+                        @NotNull DisplaySetting<S> setting)
        +
        Gets the value for a given setting option.
        +
        +
        Type Parameters:
        +
        S - The setting type.
        +
        Parameters:
        +
        setting - The setting option.
        +
        Returns:
        +
        Value set for the given setting.
        +
        +
        • +
      + + + + + +
        +
      • +

        setSetting

        +
        public <S> void setSetting​(@NotNull
+                           @NotNull DisplaySetting<S> setting,
+                           S value)
        +
        Sets other specific settings that may be used by the DisplayHandler.
        +
        +
        Type Parameters:
        +
        S - The type of setting.
        +
        Parameters:
        +
        setting - The settings option.
        +
        value - The value to set.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/display/ContentFilter.html b/javadoc/latest/com/onarandombox/MultiverseCore/display/ContentFilter.html new file mode 100644 index 000000000..df1650815 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/display/ContentFilter.html @@ -0,0 +1,525 @@ + + + + + +ContentFilter (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.display
+

Class ContentFilter

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.display.ContentFilter
      • +
    +
    • +
+
+
    +
  • +
    +
    public class ContentFilter
+extends java.lang.Object
    +

    Filter content and text based on regex matching.

    + +

    Compile regex pattern based on filterString. When prefixed with 'r=', + use filterString as the full regex pattern. Else, set to any match that + contains the filterString.

    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      static ContentFilterDEFAULT 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      ContentFilter​(@NotNull java.lang.String filterString) 
      ContentFilter​(@NotNull java.lang.String filterString, + boolean exactMatch) 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      booleancheckMatch​(@Nullable java.lang.Object text) +
      Do regex matching.
      +
      @NotNull java.lang.StringgetFormattedString() +
      Nicely format the filter string to be used for showing the sender.
      +
      @Nullable java.util.regex.PatterngetPattern() 
      @Nullable java.lang.StringgetString() 
      booleanhasFilter() +
      Checks if a filter string is present.
      +
      booleanhasValidPattern() +
      Checks if regex pattern syntax is valid.
      +
      booleanisExactMatch() 
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ContentFilter

        +
        public ContentFilter​(@NotNull
+                     @NotNull java.lang.String filterString)
        +
        +
        Parameters:
        +
        filterString - The text to do matching, either plaintext or regex.
        +
        +
        • +
      + + + +
        +
      • +

        ContentFilter

        +
        public ContentFilter​(@NotNull
+                     @NotNull java.lang.String filterString,
+                     boolean exactMatch)
        +
        +
        Parameters:
        +
        filterString - The text to do matching, else plaintext or regex.
        +
        exactMatch - Should check for exact match when doing regex matching.
        +
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        checkMatch

        +
        public boolean checkMatch​(@Nullable
+                          @Nullable java.lang.Object text)
        +
        Do regex matching.
        +
        +
        Parameters:
        +
        text - String to check regex on.
        +
        Returns:
        +
        True of matches regex pattern, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        hasFilter

        +
        public boolean hasFilter()
        +
        Checks if a filter string is present.
        +
        +
        Returns:
        +
        True if there is a filter string, else false.
        +
        +
        • +
      + + + +
        +
      • +

        hasValidPattern

        +
        public boolean hasValidPattern()
        +
        Checks if regex pattern syntax is valid.
        +
        +
        Returns:
        +
        True if valid, else false.
        +
        +
        • +
      + + + +
        +
      • +

        getString

        +
        @Nullable
+public @Nullable java.lang.String getString()
        +
        +
        Returns:
        +
        The filter string.
        +
        +
        • +
      + + + +
        +
      • +

        getPattern

        +
        @Nullable
+public @Nullable java.util.regex.Pattern getPattern()
        +
        +
        Returns:
        +
        The regex pattern.
        +
        +
        • +
      + + + +
        +
      • +

        isExactMatch

        +
        public boolean isExactMatch()
        +
        +
        Returns:
        +
        True if filter is set to do exact matching, else false.
        +
        +
        • +
      + + + +
        +
      • +

        getFormattedString

        +
        @NotNull
+public @NotNull java.lang.String getFormattedString()
        +
        Nicely format the filter string to be used for showing the sender.
        +
        +
        Returns:
        +
        The formatted filter string.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/display/DisplayFormatException.html b/javadoc/latest/com/onarandombox/MultiverseCore/display/DisplayFormatException.html new file mode 100644 index 000000000..d0b22cbd4 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/display/DisplayFormatException.html @@ -0,0 +1,352 @@ + + + + + +DisplayFormatException (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.display
+

Class DisplayFormatException

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • java.lang.Throwable
      • +
    • +
        +
      • java.lang.Exception
        • +
      • +
          +
        • com.onarandombox.MultiverseCore.display.DisplayFormatException
          • +
        +
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    public class DisplayFormatException
+extends java.lang.Exception
    +
    Thrown when an issue occur while formatting content.
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        DisplayFormatException

        +
        public DisplayFormatException()
        +
        • +
      + + + +
        +
      • +

        DisplayFormatException

        +
        public DisplayFormatException​(java.lang.String message)
        +
        • +
      + + + +
        +
      • +

        DisplayFormatException

        +
        public DisplayFormatException​(java.lang.String message,
+                              java.lang.Throwable cause)
        +
        • +
      + + + +
        +
      • +

        DisplayFormatException

        +
        public DisplayFormatException​(java.lang.Throwable cause)
        +
        • +
      + + + +
        +
      • +

        DisplayFormatException

        +
        public DisplayFormatException​(java.lang.String message,
+                              java.lang.Throwable cause,
+                              boolean enableSuppression,
+                              boolean writableStackTrace)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/display/DisplayHandler.html b/javadoc/latest/com/onarandombox/MultiverseCore/display/DisplayHandler.html new file mode 100644 index 000000000..684f3dad0 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/display/DisplayHandler.html @@ -0,0 +1,360 @@ + + + + + +DisplayHandler (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.display
+

Interface DisplayHandler<T>

+
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and TypeMethodDescription
      java.util.Collection<java.lang.String>format​(@NotNull org.bukkit.command.CommandSender sender, + @NotNull ContentDisplay<T> display) +
      Formats the raw content into a Collection for displaying to the given sender.
      +
      default voidsendBody​(@NotNull org.bukkit.command.CommandSender sender, + @NotNull ContentDisplay<T> display, + java.util.Collection<java.lang.String> formattedContent) +
      Sends the content.
      +
      default voidsendHeader​(@NotNull org.bukkit.command.CommandSender sender, + @NotNull ContentDisplay<T> display) +
      Sends the header.
      +
      default voidsendSubHeader​(@NotNull org.bukkit.command.CommandSender sender, + @NotNull ContentDisplay<T> display) +
      Sends info such as filter and page.
      +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        format

        +
        java.util.Collection<java.lang.String> format​(@NotNull
+                                              @NotNull org.bukkit.command.CommandSender sender,
+                                              @NotNull
+                                              @NotNull ContentDisplay<T> display)
+                                       throws DisplayFormatException
        +
        Formats the raw content into a Collection for displaying to the given sender.
        +
        +
        Parameters:
        +
        sender - The CommandSender who will the content will be displayed to.
        +
        display - The responsible ContentDisplay.
        +
        Returns:
        +
        The formatted content.
        +
        Throws:
        +
        DisplayFormatException - Issue occurred while formatting content. E.g. invalid page.
        +
        +
        • +
      + + + +
        +
      • +

        sendHeader

        +
        default void sendHeader​(@NotNull
+                        @NotNull org.bukkit.command.CommandSender sender,
+                        @NotNull
+                        @NotNull ContentDisplay<T> display)
        +
        Sends the header.
        +
        +
        Parameters:
        +
        sender - The CommandSender who will the header will be displayed to.
        +
        display - The responsible ContentDisplay.
        +
        +
        • +
      + + + +
        +
      • +

        sendSubHeader

        +
        default void sendSubHeader​(@NotNull
+                           @NotNull org.bukkit.command.CommandSender sender,
+                           @NotNull
+                           @NotNull ContentDisplay<T> display)
        +
        Sends info such as filter and page.
        +
        +
        Parameters:
        +
        sender - The CommandSender who will the sub header will be displayed to.
        +
        display - The responsible ContentDisplay.
        +
        +
        • +
      + + + +
        +
      • +

        sendBody

        +
        default void sendBody​(@NotNull
+                      @NotNull org.bukkit.command.CommandSender sender,
+                      @NotNull
+                      @NotNull ContentDisplay<T> display,
+                      java.util.Collection<java.lang.String> formattedContent)
        +
        Sends the content.
        +
        +
        Parameters:
        +
        sender - The CommandSender who will the body will be displayed to.
        +
        display - The responsible ContentDisplay.
        +
        formattedContent - The content after being formatted by format(CommandSender, ContentDisplay)
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/display/DisplayHandlers.html b/javadoc/latest/com/onarandombox/MultiverseCore/display/DisplayHandlers.html new file mode 100644 index 000000000..427d865ce --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/display/DisplayHandlers.html @@ -0,0 +1,372 @@ + + + + + +DisplayHandlers (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.display
+

Class DisplayHandlers

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.display.DisplayHandlers
      • +
    +
    • +
+
+
    +
  • +
    +
    public class DisplayHandlers
+extends java.lang.Object
    +
    Various implementations of DisplayHandler.
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      static DisplayHandler<java.util.Collection<java.lang.String>>INLINE_LIST +
      Display a list inline.
      +
      static DisplayHandler<java.util.Map<java.lang.String,​java.lang.Object>>INLINE_MAP +
      Display key value pair inline.
      +
      static DisplayHandler<java.util.Collection<java.lang.String>>LIST +
      Standard list display.
      +
      static DisplayHandler<java.util.Collection<java.lang.String>>PAGE_LIST +
      List display with paging.
      +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      DisplayHandlers() 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    +
    • +
+
+
+ +
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/display/handlers/InlineListDisplayHandler.html b/javadoc/latest/com/onarandombox/MultiverseCore/display/handlers/InlineListDisplayHandler.html new file mode 100644 index 000000000..d98dc4911 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/display/handlers/InlineListDisplayHandler.html @@ -0,0 +1,336 @@ + + + + + +InlineListDisplayHandler (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.display.handlers
+

Class InlineListDisplayHandler

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.display.handlers.InlineListDisplayHandler
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    DisplayHandler<java.util.Collection<java.lang.String>>
    +
    +
    +
    public class InlineListDisplayHandler
+extends java.lang.Object
+implements DisplayHandler<java.util.Collection<java.lang.String>>
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      java.util.Collection<java.lang.String>format​(@NotNull org.bukkit.command.CommandSender sender, + @NotNull ContentDisplay<java.util.Collection<java.lang.String>> display) +
      Formats the raw content into a Collection for displaying to the given sender.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        InlineListDisplayHandler

        +
        public InlineListDisplayHandler()
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        format

        +
        public java.util.Collection<java.lang.String> format​(@NotNull
+                                                     @NotNull org.bukkit.command.CommandSender sender,
+                                                     @NotNull
+                                                     @NotNull ContentDisplay<java.util.Collection<java.lang.String>> display)
+                                              throws DisplayFormatException
        +
        Description copied from interface: DisplayHandler
        +
        Formats the raw content into a Collection for displaying to the given sender.
        +
        +
        Specified by:
        +
        format in interface DisplayHandler<java.util.Collection<java.lang.String>>
        +
        Parameters:
        +
        sender - The CommandSender who will the content will be displayed to.
        +
        display - The responsible ContentDisplay.
        +
        Returns:
        +
        The formatted content.
        +
        Throws:
        +
        DisplayFormatException - Issue occurred while formatting content. E.g. invalid page.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/display/handlers/InlineMapDisplayHandler.html b/javadoc/latest/com/onarandombox/MultiverseCore/display/handlers/InlineMapDisplayHandler.html new file mode 100644 index 000000000..b96207fe3 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/display/handlers/InlineMapDisplayHandler.html @@ -0,0 +1,336 @@ + + + + + +InlineMapDisplayHandler (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.display.handlers
+

Class InlineMapDisplayHandler

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.display.handlers.InlineMapDisplayHandler
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    DisplayHandler<java.util.Map<java.lang.String,​java.lang.Object>>
    +
    +
    +
    public class InlineMapDisplayHandler
+extends java.lang.Object
+implements DisplayHandler<java.util.Map<java.lang.String,​java.lang.Object>>
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      java.util.Collection<java.lang.String>format​(@NotNull org.bukkit.command.CommandSender sender, + @NotNull ContentDisplay<java.util.Map<java.lang.String,​java.lang.Object>> display) +
      Formats the raw content into a Collection for displaying to the given sender.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        InlineMapDisplayHandler

        +
        public InlineMapDisplayHandler()
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        format

        +
        public java.util.Collection<java.lang.String> format​(@NotNull
+                                                     @NotNull org.bukkit.command.CommandSender sender,
+                                                     @NotNull
+                                                     @NotNull ContentDisplay<java.util.Map<java.lang.String,​java.lang.Object>> display)
+                                              throws DisplayFormatException
        +
        Description copied from interface: DisplayHandler
        +
        Formats the raw content into a Collection for displaying to the given sender.
        +
        +
        Specified by:
        +
        format in interface DisplayHandler<java.util.Map<java.lang.String,​java.lang.Object>>
        +
        Parameters:
        +
        sender - The CommandSender who will the content will be displayed to.
        +
        display - The responsible ContentDisplay.
        +
        Returns:
        +
        The formatted content.
        +
        Throws:
        +
        DisplayFormatException - Issue occurred while formatting content. E.g. invalid page.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/display/handlers/ListDisplayHandler.html b/javadoc/latest/com/onarandombox/MultiverseCore/display/handlers/ListDisplayHandler.html new file mode 100644 index 000000000..c53e32a65 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/display/handlers/ListDisplayHandler.html @@ -0,0 +1,340 @@ + + + + + +ListDisplayHandler (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.display.handlers
+

Class ListDisplayHandler

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.display.handlers.ListDisplayHandler
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    DisplayHandler<java.util.Collection<java.lang.String>>
    +
    +
    +
    Direct Known Subclasses:
    +
    PagedListDisplayHandler
    +
    +
    +
    public class ListDisplayHandler
+extends java.lang.Object
+implements DisplayHandler<java.util.Collection<java.lang.String>>
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      ListDisplayHandler() 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      java.util.Collection<java.lang.String>format​(@NotNull org.bukkit.command.CommandSender sender, + @NotNull ContentDisplay<java.util.Collection<java.lang.String>> display) +
      Formats the raw content into a Collection for displaying to the given sender.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        ListDisplayHandler

        +
        public ListDisplayHandler()
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        format

        +
        public java.util.Collection<java.lang.String> format​(@NotNull
+                                                     @NotNull org.bukkit.command.CommandSender sender,
+                                                     @NotNull
+                                                     @NotNull ContentDisplay<java.util.Collection<java.lang.String>> display)
+                                              throws DisplayFormatException
        +
        Description copied from interface: DisplayHandler
        +
        Formats the raw content into a Collection for displaying to the given sender.
        +
        +
        Specified by:
        +
        format in interface DisplayHandler<java.util.Collection<java.lang.String>>
        +
        Parameters:
        +
        sender - The CommandSender who will the content will be displayed to.
        +
        display - The responsible ContentDisplay.
        +
        Returns:
        +
        The formatted content.
        +
        Throws:
        +
        DisplayFormatException - Issue occurred while formatting content. E.g. invalid page.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/display/handlers/PagedListDisplayHandler.html b/javadoc/latest/com/onarandombox/MultiverseCore/display/handlers/PagedListDisplayHandler.html new file mode 100644 index 000000000..e4119de84 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/display/handlers/PagedListDisplayHandler.html @@ -0,0 +1,369 @@ + + + + + +PagedListDisplayHandler (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.display.handlers
+

Class PagedListDisplayHandler

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    DisplayHandler<java.util.Collection<java.lang.String>>
    +
    +
    +
    public class PagedListDisplayHandler
+extends ListDisplayHandler
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      java.util.Collection<java.lang.String>format​(@NotNull org.bukkit.command.CommandSender sender, + @NotNull ContentDisplay<java.util.Collection<java.lang.String>> display) +
      Formats the raw content into a Collection for displaying to the given sender.
      +
      voidsendSubHeader​(@NotNull org.bukkit.command.CommandSender sender, + @NotNull ContentDisplay<java.util.Collection<java.lang.String>> display) +
      Sends info such as filter and page.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        PagedListDisplayHandler

        +
        public PagedListDisplayHandler()
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        format

        +
        public java.util.Collection<java.lang.String> format​(@NotNull
+                                                     @NotNull org.bukkit.command.CommandSender sender,
+                                                     @NotNull
+                                                     @NotNull ContentDisplay<java.util.Collection<java.lang.String>> display)
+                                              throws DisplayFormatException
        +
        Description copied from interface: DisplayHandler
        +
        Formats the raw content into a Collection for displaying to the given sender.
        +
        +
        Specified by:
        +
        format in interface DisplayHandler<java.util.Collection<java.lang.String>>
        +
        Overrides:
        +
        format in class ListDisplayHandler
        +
        Parameters:
        +
        sender - The CommandSender who will the content will be displayed to.
        +
        display - The responsible ContentDisplay.
        +
        Returns:
        +
        The formatted content.
        +
        Throws:
        +
        DisplayFormatException - Issue occurred while formatting content. E.g. invalid page.
        +
        +
        • +
      + + + +
        +
      • +

        sendSubHeader

        +
        public void sendSubHeader​(@NotNull
+                          @NotNull org.bukkit.command.CommandSender sender,
+                          @NotNull
+                          @NotNull ContentDisplay<java.util.Collection<java.lang.String>> display)
        +
        Description copied from interface: DisplayHandler
        +
        Sends info such as filter and page.
        +
        +
        Parameters:
        +
        sender - The CommandSender who will the sub header will be displayed to.
        +
        display - The responsible ContentDisplay.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/display/handlers/package-summary.html b/javadoc/latest/com/onarandombox/MultiverseCore/display/handlers/package-summary.html new file mode 100644 index 000000000..4cb988fcb --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/display/handlers/package-summary.html @@ -0,0 +1,176 @@ + + + + + +com.onarandombox.MultiverseCore.display.handlers (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+
+
+

Package com.onarandombox.MultiverseCore.display.handlers

+
+
+ +
+
+ + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/display/handlers/package-tree.html b/javadoc/latest/com/onarandombox/MultiverseCore/display/handlers/package-tree.html new file mode 100644 index 000000000..f2fdb08bf --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/display/handlers/package-tree.html @@ -0,0 +1,167 @@ + + + + + +com.onarandombox.MultiverseCore.display.handlers Class Hierarchy (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package com.onarandombox.MultiverseCore.display.handlers

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+ +
+
+
+ + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/display/package-summary.html b/javadoc/latest/com/onarandombox/MultiverseCore/display/package-summary.html new file mode 100644 index 000000000..1a55c0bd4 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/display/package-summary.html @@ -0,0 +1,230 @@ + + + + + +com.onarandombox.MultiverseCore.display (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+
+
+

Package com.onarandombox.MultiverseCore.display

+
+
+ +
+
+ + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/display/package-tree.html b/javadoc/latest/com/onarandombox/MultiverseCore/display/package-tree.html new file mode 100644 index 000000000..bb0046fd5 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/display/package-tree.html @@ -0,0 +1,181 @@ + + + + + +com.onarandombox.MultiverseCore.display Class Hierarchy (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package com.onarandombox.MultiverseCore.display

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+ +
+
+

Interface Hierarchy

+ +
+
+
+ + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/display/settings/DisplaySetting.html b/javadoc/latest/com/onarandombox/MultiverseCore/display/settings/DisplaySetting.html new file mode 100644 index 000000000..344935771 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/display/settings/DisplaySetting.html @@ -0,0 +1,265 @@ + + + + + +DisplaySetting (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.display.settings
+

Interface DisplaySetting<T>

+
+
+
+
    +
  • +
    +
    Type Parameters:
    +
    T -
    +
    +
    +
    Functional Interface:
    +
    This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
    +
    +
    +
    @FunctionalInterface
+public interface DisplaySetting<T>
    +
    Represents a setting option that can be used by DisplayHandler.
    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        defaultValue

        +
        T defaultValue()
        +
        Gets the default value of this Display Setting.
        +
        +
        Returns:
        +
        The default value.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/display/settings/InlineDisplaySettings.html b/javadoc/latest/com/onarandombox/MultiverseCore/display/settings/InlineDisplaySettings.html new file mode 100644 index 000000000..c3eb6bc76 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/display/settings/InlineDisplaySettings.html @@ -0,0 +1,312 @@ + + + + + +InlineDisplaySettings (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.display.settings
+

Class InlineDisplaySettings

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.display.settings.InlineDisplaySettings
      • +
    +
    • +
+
+
    +
  • +
    +
    public class InlineDisplaySettings
+extends java.lang.Object
    +
    Collection of DisplaySetting that are used by various DisplayHandler.
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      static DisplaySetting<java.lang.String>SEPARATOR +
      Inline separator.
      +
      +
      • +
    +
    + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        SEPARATOR

        +
        public static final DisplaySetting<java.lang.String> SEPARATOR
        +
        Inline separator. E.g. '1, 2, 3'
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        InlineDisplaySettings

        +
        public InlineDisplaySettings()
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/display/settings/MapDisplaySettings.html b/javadoc/latest/com/onarandombox/MultiverseCore/display/settings/MapDisplaySettings.html new file mode 100644 index 000000000..78b4616f8 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/display/settings/MapDisplaySettings.html @@ -0,0 +1,312 @@ + + + + + +MapDisplaySettings (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.display.settings
+

Class MapDisplaySettings

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.display.settings.MapDisplaySettings
      • +
    +
    • +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      static DisplaySetting<java.lang.String>OPERATOR +
      The thing between a key value pair.
      +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      MapDisplaySettings() 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        OPERATOR

        +
        public static final DisplaySetting<java.lang.String> OPERATOR
        +
        The thing between a key value pair. E.g. 'Me = Smart'
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MapDisplaySettings

        +
        public MapDisplaySettings()
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/display/settings/PagedDisplaySettings.html b/javadoc/latest/com/onarandombox/MultiverseCore/display/settings/PagedDisplaySettings.html new file mode 100644 index 000000000..a739068d5 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/display/settings/PagedDisplaySettings.html @@ -0,0 +1,379 @@ + + + + + +PagedDisplaySettings (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.display.settings
+

Class PagedDisplaySettings

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.display.settings.PagedDisplaySettings
      • +
    +
    • +
+
+
    +
  • +
    +
    public class PagedDisplaySettings
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        SHOW_PAGE

        +
        public static final DisplaySetting<java.lang.Integer> SHOW_PAGE
        +
        Page to display.
        +
        • +
      + + + +
        +
      • +

        TOTAL_PAGE

        +
        public static final DisplaySetting<java.lang.Integer> TOTAL_PAGE
        +
        Total pages available to display.
        +
        • +
      + + + +
        +
      • +

        LINES_PER_PAGE

        +
        public static final DisplaySetting<java.lang.Integer> LINES_PER_PAGE
        +
        The max number of lines per page. This excludes header.
        +
        • +
      + + + +
        +
      • +

        DO_END_PADDING

        +
        public static final DisplaySetting<java.lang.Boolean> DO_END_PADDING
        +
        Should add empty lines if content lines shown is less that LINES_PER_PAGE.
        +
        • +
      + + + +
        +
      • +

        PAGE_IN_CONSOLE

        +
        public static final DisplaySetting<java.lang.Boolean> PAGE_IN_CONSOLE
        +
        Should display with paging when it's sent to console.
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PagedDisplaySettings

        +
        public PagedDisplaySettings()
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/display/settings/package-summary.html b/javadoc/latest/com/onarandombox/MultiverseCore/display/settings/package-summary.html new file mode 100644 index 000000000..381a60705 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/display/settings/package-summary.html @@ -0,0 +1,193 @@ + + + + + +com.onarandombox.MultiverseCore.display.settings (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+
+
+

Package com.onarandombox.MultiverseCore.display.settings

+
+
+ +
+
+ + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/display/settings/package-tree.html b/javadoc/latest/com/onarandombox/MultiverseCore/display/settings/package-tree.html new file mode 100644 index 000000000..b5130c609 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/display/settings/package-tree.html @@ -0,0 +1,169 @@ + + + + + +com.onarandombox.MultiverseCore.display.settings Class Hierarchy (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package com.onarandombox.MultiverseCore.display.settings

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+ +
+
+

Interface Hierarchy

+
    +
  • com.onarandombox.MultiverseCore.display.settings.DisplaySetting<T>
    • +
+
+
+
+ + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/enums/Action.html b/javadoc/latest/com/onarandombox/MultiverseCore/enums/Action.html new file mode 100644 index 000000000..5554fd293 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/enums/Action.html @@ -0,0 +1,415 @@ + + + + + +Action (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.enums
+

Enum Action

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • java.lang.Enum<Action>
      • +
    • +
        +
      • com.onarandombox.MultiverseCore.enums.Action
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Comparable<Action>
    +
    +
    +
    public enum Action
+extends java.lang.Enum<Action>
    +
    A enum containing all actions that can be used to modify world-properties.
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Enum Constants 
      Enum ConstantDescription
      Add +
      Adding something to a list-property.
      +
      Clear +
      Clearing a list-property.
      +
      Remove +
      Removing something from a list-property.
      +
      Set +
      Setting a property.
      +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethodDescription
      static ActionvalueOf​(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static Action[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Enum Constant Detail

      + + + +
        +
      • +

        Set

        +
        public static final Action Set
        +
        Setting a property.
        +
        • +
      + + + +
        +
      • +

        Add

        +
        public static final Action Add
        +
        Adding something to a list-property.
        +
        • +
      + + + +
        +
      • +

        Remove

        +
        public static final Action Remove
        +
        Removing something from a list-property.
        +
        • +
      + + + +
        +
      • +

        Clear

        +
        public static final Action Clear
        +
        Clearing a list-property.
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static Action[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (Action c : Action.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static Action valueOf​(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/enums/AddProperties.html b/javadoc/latest/com/onarandombox/MultiverseCore/enums/AddProperties.html new file mode 100644 index 000000000..a688af31d --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/enums/AddProperties.html @@ -0,0 +1,399 @@ + + + + + +AddProperties (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.enums
+

Enum AddProperties

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • java.lang.Enum<AddProperties>
      • +
    • +
        +
      • com.onarandombox.MultiverseCore.enums.AddProperties
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Comparable<AddProperties>
    +
    +
    +
    public enum AddProperties
+extends java.lang.Enum<AddProperties>
    +
    An enum containing all list-properties.
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + + + + + + + + + + + +
      Enum Constants 
      Enum ConstantDescription
      animals +
      Animal-exceptions.
      +
      monsters +
      Monster-exceptions.
      +
      worldblacklist +
      Worlds that people cannot go to from a world.
      +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethodDescription
      static AddPropertiesvalueOf​(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static AddProperties[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Enum Constant Detail

      + + + +
        +
      • +

        worldblacklist

        +
        public static final AddProperties worldblacklist
        +
        Worlds that people cannot go to from a world.
        +
        • +
      + + + +
        +
      • +

        animals

        +
        public static final AddProperties animals
        +
        Animal-exceptions.
        +
        • +
      + + + +
        +
      • +

        monsters

        +
        public static final AddProperties monsters
        +
        Monster-exceptions.
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static AddProperties[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (AddProperties c : AddProperties.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static AddProperties valueOf​(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/enums/AllowedPortalType.html b/javadoc/latest/com/onarandombox/MultiverseCore/enums/AllowedPortalType.html new file mode 100644 index 000000000..0c839d233 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/enums/AllowedPortalType.html @@ -0,0 +1,450 @@ + + + + + +AllowedPortalType (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.enums
+

Enum AllowedPortalType

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • java.lang.Enum<AllowedPortalType>
      • +
    • +
        +
      • com.onarandombox.MultiverseCore.enums.AllowedPortalType
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Comparable<AllowedPortalType>
    +
    +
    +
    public enum AllowedPortalType
+extends java.lang.Enum<AllowedPortalType>
    +
    Custom enum that adds all/none for allowing portal creation.
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Enum Constants 
      Enum ConstantDescription
      ALL +
      All portal types are allowed.
      +
      END +
      Only Ender style portals are allowed.
      +
      NETHER +
      Only Nether style portals are allowed.
      +
      NONE +
      No portals are allowed.
      +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      org.bukkit.PortalTypegetActualPortalType() +
      Gets the text.
      +
      booleanisPortalAllowed​(org.bukkit.PortalType portalType) 
      static AllowedPortalTypevalueOf​(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static AllowedPortalType[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static AllowedPortalType[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (AllowedPortalType c : AllowedPortalType.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static AllowedPortalType valueOf​(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        +
        • +
      + + + +
        +
      • +

        getActualPortalType

        +
        public org.bukkit.PortalType getActualPortalType()
        +
        Gets the text.
        +
        +
        Returns:
        +
        The text.
        +
        +
        • +
      + + + +
        +
      • +

        isPortalAllowed

        +
        public boolean isPortalAllowed​(org.bukkit.PortalType portalType)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/enums/EnglishChatColor.html b/javadoc/latest/com/onarandombox/MultiverseCore/enums/EnglishChatColor.html new file mode 100644 index 000000000..df5b0dc14 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/enums/EnglishChatColor.html @@ -0,0 +1,672 @@ + + + + + +EnglishChatColor (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.enums
+

Enum EnglishChatColor

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • java.lang.Enum<EnglishChatColor>
      • +
    • +
        +
      • com.onarandombox.MultiverseCore.enums.EnglishChatColor
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Comparable<EnglishChatColor>
    +
    +
    +
    public enum EnglishChatColor
+extends java.lang.Enum<EnglishChatColor>
    +
    A regular ChatColor represented by an english string.
    +
    +
    See Also:
    +
    ChatColor
    +
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      static EnglishChatColorfromString​(java.lang.String text) +
      Constructs an EnglishChatColor from a String.
      +
      static java.lang.StringgetAllColors() +
      Constructs a string containing all available colors.
      +
      org.bukkit.ChatColorgetColor() +
      Gets the color.
      +
      java.lang.StringgetText() +
      Gets the text.
      +
      static booleanisValidAliasColor​(java.lang.String aliasColor) +
      Looks if the given-color name is a valid color.
      +
      static EnglishChatColorvalueOf​(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static EnglishChatColor[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static EnglishChatColor[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (EnglishChatColor c : EnglishChatColor.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static EnglishChatColor valueOf​(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        +
        • +
      + + + +
        +
      • +

        getText

        +
        public java.lang.String getText()
        +
        Gets the text.
        +
        +
        Returns:
        +
        The text.
        +
        +
        • +
      + + + +
        +
      • +

        getColor

        +
        public org.bukkit.ChatColor getColor()
        +
        Gets the color.
        +
        +
        Returns:
        +
        The color as ChatColor.
        +
        +
        • +
      + + + +
        +
      • +

        getAllColors

        +
        public static java.lang.String getAllColors()
        +
        Constructs a string containing all available colors.
        +
        +
        Returns:
        +
        That String.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        isValidAliasColor

        +
        public static boolean isValidAliasColor​(java.lang.String aliasColor)
        +
        Looks if the given-color name is a valid color.
        +
        +
        Parameters:
        +
        aliasColor - A color-name.
        +
        Returns:
        +
        True if the name is a valid color, false if it isn't.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/enums/EnglishChatStyle.html b/javadoc/latest/com/onarandombox/MultiverseCore/enums/EnglishChatStyle.html new file mode 100644 index 000000000..e6b1b6114 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/enums/EnglishChatStyle.html @@ -0,0 +1,480 @@ + + + + + +EnglishChatStyle (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.enums
+

Enum EnglishChatStyle

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • java.lang.Enum<EnglishChatStyle>
      • +
    • +
        +
      • com.onarandombox.MultiverseCore.enums.EnglishChatStyle
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Comparable<EnglishChatStyle>
    +
    +
    +
    public enum EnglishChatStyle
+extends java.lang.Enum<EnglishChatStyle>
    +
    A regular ChatColor represented by an english string.
    +
    +
    See Also:
    +
    ChatColor
    +
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      static EnglishChatStylefromString​(java.lang.String text) +
      Constructs an EnglishChatStyle from a String.
      +
      org.bukkit.ChatColorgetColor() +
      Gets the color.
      +
      static EnglishChatStylevalueOf​(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static EnglishChatStyle[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static EnglishChatStyle[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (EnglishChatStyle c : EnglishChatStyle.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static EnglishChatStyle valueOf​(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        +
        • +
      + + + +
        +
      • +

        getColor

        +
        public org.bukkit.ChatColor getColor()
        +
        Gets the color.
        +
        +
        Returns:
        +
        The color as ChatColor.
        +
        +
        • +
      + + + + +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/enums/RespawnType.html b/javadoc/latest/com/onarandombox/MultiverseCore/enums/RespawnType.html new file mode 100644 index 000000000..60a91589c --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/enums/RespawnType.html @@ -0,0 +1,389 @@ + + + + + +RespawnType (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.enums
+

Enum RespawnType

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • java.lang.Enum<RespawnType>
      • +
    • +
        +
      • com.onarandombox.MultiverseCore.enums.RespawnType
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Comparable<RespawnType>
    +
    +
    +
    public enum RespawnType
+extends java.lang.Enum<RespawnType>
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + + + + + + + + + + + +
      Enum Constants 
      Enum ConstantDescription
      ANCHOR 
      BED 
      OTHER 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethodDescription
      static RespawnTypevalueOf​(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static RespawnType[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static RespawnType[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (RespawnType c : RespawnType.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static RespawnType valueOf​(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/enums/TeleportResult.html b/javadoc/latest/com/onarandombox/MultiverseCore/enums/TeleportResult.html new file mode 100644 index 000000000..5785187e2 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/enums/TeleportResult.html @@ -0,0 +1,447 @@ + + + + + +TeleportResult (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.enums
+

Enum TeleportResult

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • java.lang.Enum<TeleportResult>
      • +
    • +
        +
      • com.onarandombox.MultiverseCore.enums.TeleportResult
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Comparable<TeleportResult>
    +
    +
    +
    public enum TeleportResult
+extends java.lang.Enum<TeleportResult>
    +
    An enum containing possible teleport-results.
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Enum Constants 
      Enum ConstantDescription
      FAIL_INVALID +
      The teleport was invalid.
      +
      FAIL_OTHER +
      Unknown reason.
      +
      FAIL_PERMISSION +
      Insufficient permissions.
      +
      FAIL_TOO_POOR +
      The player was to poor.
      +
      FAIL_UNSAFE +
      The teleport was unsafe.
      +
      SUCCESS +
      The player was successfully teleported.
      +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethodDescription
      static TeleportResultvalueOf​(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static TeleportResult[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Enum Constant Detail

      + + + +
        +
      • +

        FAIL_PERMISSION

        +
        public static final TeleportResult FAIL_PERMISSION
        +
        Insufficient permissions.
        +
        • +
      + + + +
        +
      • +

        FAIL_UNSAFE

        +
        public static final TeleportResult FAIL_UNSAFE
        +
        The teleport was unsafe.
        +
        • +
      + + + +
        +
      • +

        FAIL_TOO_POOR

        +
        public static final TeleportResult FAIL_TOO_POOR
        +
        The player was to poor.
        +
        • +
      + + + +
        +
      • +

        FAIL_INVALID

        +
        public static final TeleportResult FAIL_INVALID
        +
        The teleport was invalid.
        +
        • +
      + + + +
        +
      • +

        FAIL_OTHER

        +
        public static final TeleportResult FAIL_OTHER
        +
        Unknown reason.
        +
        • +
      + + + +
        +
      • +

        SUCCESS

        +
        public static final TeleportResult SUCCESS
        +
        The player was successfully teleported.
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static TeleportResult[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (TeleportResult c : TeleportResult.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static TeleportResult valueOf​(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/enums/package-summary.html b/javadoc/latest/com/onarandombox/MultiverseCore/enums/package-summary.html new file mode 100644 index 000000000..cb4e787ef --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/enums/package-summary.html @@ -0,0 +1,205 @@ + + + + + +com.onarandombox.MultiverseCore.enums (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+
+
+

Package com.onarandombox.MultiverseCore.enums

+
+
+
+ + +
This package contains all enums.
+
+
    +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Enum Summary 
    EnumDescription
    Action +
    A enum containing all actions that can be used to modify world-properties.
    +
    AddProperties +
    An enum containing all list-properties.
    +
    AllowedPortalType +
    Custom enum that adds all/none for allowing portal creation.
    +
    EnglishChatColor +
    A regular ChatColor represented by an english string.
    +
    EnglishChatStyle +
    A regular ChatColor represented by an english string.
    +
    RespawnType 
    TeleportResult +
    An enum containing possible teleport-results.
    +
    +
    • +
+
+
+ + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/enums/package-tree.html b/javadoc/latest/com/onarandombox/MultiverseCore/enums/package-tree.html new file mode 100644 index 000000000..0e41726e3 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/enums/package-tree.html @@ -0,0 +1,171 @@ + + + + + +com.onarandombox.MultiverseCore.enums Class Hierarchy (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package com.onarandombox.MultiverseCore.enums

+Package Hierarchies: + +
+
+
+

Enum Hierarchy

+
    +
  • java.lang.Object + +
    • +
+
+
+
+ + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/event/MVConfigReloadEvent.html b/javadoc/latest/com/onarandombox/MultiverseCore/event/MVConfigReloadEvent.html new file mode 100644 index 000000000..c0c443944 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/event/MVConfigReloadEvent.html @@ -0,0 +1,400 @@ + + + + + +MVConfigReloadEvent (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.event
+

Class MVConfigReloadEvent

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • org.bukkit.event.Event
      • +
    • +
        +
      • com.onarandombox.MultiverseCore.event.MVConfigReloadEvent
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    public class MVConfigReloadEvent
+extends org.bukkit.event.Event
    +
    Called when the Multiverse-config should be reloaded.
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

        Nested classes/interfaces inherited from class org.bukkit.event.Event

        +org.bukkit.event.Event.Result
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      MVConfigReloadEvent​(java.util.List<java.lang.String> configsLoaded) 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      voidaddConfig​(java.lang.String config) +
      Adds a config to this event.
      +
      java.util.List<java.lang.String>getAllConfigsLoaded() +
      Gets all loaded configs.
      +
      static org.bukkit.event.HandlerListgetHandlerList() +
      Gets the handler list.
      +
      org.bukkit.event.HandlerListgetHandlers()
      +
        +
      • + + +

        Methods inherited from class org.bukkit.event.Event

        +getEventName, isAsynchronous
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        MVConfigReloadEvent

        +
        public MVConfigReloadEvent​(java.util.List<java.lang.String> configsLoaded)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getHandlers

        +
        public org.bukkit.event.HandlerList getHandlers()
        +
        +
        Specified by:
        +
        getHandlers in class org.bukkit.event.Event
        +
        +
        • +
      + + + +
        +
      • +

        getHandlerList

        +
        public static org.bukkit.event.HandlerList getHandlerList()
        +
        Gets the handler list. This is required by the event system.
        +
        +
        Returns:
        +
        A list of HANDLERS.
        +
        +
        • +
      + + + +
        +
      • +

        addConfig

        +
        public void addConfig​(java.lang.String config)
        +
        Adds a config to this event.
        +
        +
        Parameters:
        +
        config - The config to add.
        +
        +
        • +
      + + + +
        +
      • +

        getAllConfigsLoaded

        +
        public java.util.List<java.lang.String> getAllConfigsLoaded()
        +
        Gets all loaded configs.
        +
        +
        Returns:
        +
        A list of all loaded configs.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/event/MVDebugModeEvent.html b/javadoc/latest/com/onarandombox/MultiverseCore/event/MVDebugModeEvent.html new file mode 100644 index 000000000..8da1688b8 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/event/MVDebugModeEvent.html @@ -0,0 +1,379 @@ + + + + + +MVDebugModeEvent (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.event
+

Class MVDebugModeEvent

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • org.bukkit.event.Event
      • +
    • +
        +
      • com.onarandombox.MultiverseCore.event.MVDebugModeEvent
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    public class MVDebugModeEvent
+extends org.bukkit.event.Event
    +
    Called when Core's debug level is changed.
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

        Nested classes/interfaces inherited from class org.bukkit.event.Event

        +org.bukkit.event.Event.Result
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      MVDebugModeEvent​(int level) 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      static org.bukkit.event.HandlerListgetHandlerList() +
      Gets the handler list.
      +
      org.bukkit.event.HandlerListgetHandlers()
      intgetLevel() +
      Returns the current debug level of Core.
      +
      +
        +
      • + + +

        Methods inherited from class org.bukkit.event.Event

        +getEventName, isAsynchronous
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        MVDebugModeEvent

        +
        public MVDebugModeEvent​(int level)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getHandlers

        +
        public org.bukkit.event.HandlerList getHandlers()
        +
        +
        Specified by:
        +
        getHandlers in class org.bukkit.event.Event
        +
        +
        • +
      + + + +
        +
      • +

        getHandlerList

        +
        public static org.bukkit.event.HandlerList getHandlerList()
        +
        Gets the handler list. This is required by the event system.
        +
        +
        Returns:
        +
        A list of HANDLERS.
        +
        +
        • +
      + + + +
        +
      • +

        getLevel

        +
        public int getLevel()
        +
        Returns the current debug level of Core.
        +
        +
        Returns:
        +
        the current debug level of Core.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/event/MVPlayerTouchedPortalEvent.html b/javadoc/latest/com/onarandombox/MultiverseCore/event/MVPlayerTouchedPortalEvent.html new file mode 100644 index 000000000..8b90655bd --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/event/MVPlayerTouchedPortalEvent.html @@ -0,0 +1,487 @@ + + + + + +MVPlayerTouchedPortalEvent (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.event
+

Class MVPlayerTouchedPortalEvent

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • org.bukkit.event.Event
      • +
    • +
        +
      • com.onarandombox.MultiverseCore.event.MVPlayerTouchedPortalEvent
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    org.bukkit.event.Cancellable
    +
    +
    +
    public class MVPlayerTouchedPortalEvent
+extends org.bukkit.event.Event
+implements org.bukkit.event.Cancellable
    +
    This event is thrown when a portal is touched.
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

        Nested classes/interfaces inherited from class org.bukkit.event.Event

        +org.bukkit.event.Event.Result
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      MVPlayerTouchedPortalEvent​(org.bukkit.entity.Player p, + org.bukkit.Location l) 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      booleancanUseThisPortal() +
      Gets whether or not the player in this event can use this portal.
      +
      org.bukkit.LocationgetBlockTouched() +
      Gets the Location of the portal-block that was touched.
      +
      static org.bukkit.event.HandlerListgetHandlerList() +
      Gets the handler list.
      +
      org.bukkit.event.HandlerListgetHandlers()
      org.bukkit.entity.PlayergetPlayer() +
      Gets the Player that's touching the portal.
      +
      booleanisCancelled() 
      voidsetCancelled​(boolean b) 
      voidsetCanUseThisPortal​(boolean canUse) +
      Sets whether or not the player in this event can use this portal.
      +
      +
        +
      • + + +

        Methods inherited from class org.bukkit.event.Event

        +getEventName, isAsynchronous
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        MVPlayerTouchedPortalEvent

        +
        public MVPlayerTouchedPortalEvent​(org.bukkit.entity.Player p,
+                                  org.bukkit.Location l)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getHandlers

        +
        public org.bukkit.event.HandlerList getHandlers()
        +
        +
        Specified by:
        +
        getHandlers in class org.bukkit.event.Event
        +
        +
        • +
      + + + +
        +
      • +

        getHandlerList

        +
        public static org.bukkit.event.HandlerList getHandlerList()
        +
        Gets the handler list. This is required by the event system.
        +
        +
        Returns:
        +
        A list of HANDLERS.
        +
        +
        • +
      + + + +
        +
      • +

        getBlockTouched

        +
        public org.bukkit.Location getBlockTouched()
        +
        Gets the Location of the portal-block that was touched.
        +
        +
        Returns:
        +
        The Location of the portal-block that was touched.
        +
        +
        • +
      + + + +
        +
      • +

        getPlayer

        +
        public org.bukkit.entity.Player getPlayer()
        +
        Gets the Player that's touching the portal.
        +
        +
        Returns:
        +
        The Player that's touching the portal.
        +
        +
        • +
      + + + +
        +
      • +

        canUseThisPortal

        +
        public boolean canUseThisPortal()
        +
        Gets whether or not the player in this event can use this portal.
        +
        +
        Returns:
        +
        True if the player can use this portal.
        +
        +
        • +
      + + + +
        +
      • +

        setCanUseThisPortal

        +
        public void setCanUseThisPortal​(boolean canUse)
        +
        Sets whether or not the player in this event can use this portal. +

        + Setting this to false will cause the player to bounce back!

        +
        +
        Parameters:
        +
        canUse - Whether or not the user can go through this portal.
        +
        +
        • +
      + + + +
        +
      • +

        isCancelled

        +
        public boolean isCancelled()
        +
        +
        Specified by:
        +
        isCancelled in interface org.bukkit.event.Cancellable
        +
        +
        • +
      + + + +
        +
      • +

        setCancelled

        +
        public void setCancelled​(boolean b)
        +
        +
        Specified by:
        +
        setCancelled in interface org.bukkit.event.Cancellable
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/event/MVRespawnEvent.html b/javadoc/latest/com/onarandombox/MultiverseCore/event/MVRespawnEvent.html new file mode 100644 index 000000000..65c7c8252 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/event/MVRespawnEvent.html @@ -0,0 +1,446 @@ + + + + + +MVRespawnEvent (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.event
+

Class MVRespawnEvent

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • org.bukkit.event.Event
      • +
    • +
        +
      • com.onarandombox.MultiverseCore.event.MVRespawnEvent
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    public class MVRespawnEvent
+extends org.bukkit.event.Event
    +
    Called when a player is respawning.
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

        Nested classes/interfaces inherited from class org.bukkit.event.Event

        +org.bukkit.event.Event.Result
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      MVRespawnEvent​(org.bukkit.Location spawningAt, + org.bukkit.entity.Player p, + java.lang.String respawnMethod) 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      static org.bukkit.event.HandlerListgetHandlerList() +
      Gets the handler list.
      +
      org.bukkit.event.HandlerListgetHandlers()
      org.bukkit.entity.PlayergetPlayer() +
      Gets the Player that's respawning.
      +
      org.bukkit.LocationgetPlayersRespawnLocation() +
      Gets the player's respawn-Location.
      +
      java.lang.StringgetRespawnMethod() +
      Gets the respawn-method.
      +
      voidsetRespawnLocation​(org.bukkit.Location l) +
      Sets the player's respawn-Location.
      +
      +
        +
      • + + +

        Methods inherited from class org.bukkit.event.Event

        +getEventName, isAsynchronous
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        MVRespawnEvent

        +
        public MVRespawnEvent​(org.bukkit.Location spawningAt,
+                      org.bukkit.entity.Player p,
+                      java.lang.String respawnMethod)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getHandlers

        +
        public org.bukkit.event.HandlerList getHandlers()
        +
        +
        Specified by:
        +
        getHandlers in class org.bukkit.event.Event
        +
        +
        • +
      + + + +
        +
      • +

        getHandlerList

        +
        public static org.bukkit.event.HandlerList getHandlerList()
        +
        Gets the handler list. This is required by the event system.
        +
        +
        Returns:
        +
        A list of HANDLERS.
        +
        +
        • +
      + + + +
        +
      • +

        getPlayer

        +
        public org.bukkit.entity.Player getPlayer()
        +
        Gets the Player that's respawning.
        +
        +
        Returns:
        +
        The Player that's respawning.
        +
        +
        • +
      + + + +
        +
      • +

        getRespawnMethod

        +
        public java.lang.String getRespawnMethod()
        +
        Gets the respawn-method.
        +
        +
        Returns:
        +
        The respawn-method.
        +
        +
        • +
      + + + +
        +
      • +

        getPlayersRespawnLocation

        +
        public org.bukkit.Location getPlayersRespawnLocation()
        +
        Gets the player's respawn-Location.
        +
        +
        Returns:
        +
        The player's respawn-Location.
        +
        +
        • +
      + + + +
        +
      • +

        setRespawnLocation

        +
        public void setRespawnLocation​(org.bukkit.Location l)
        +
        Sets the player's respawn-Location.
        +
        +
        Parameters:
        +
        l - The new respawn-Location.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/event/MVTeleportEvent.html b/javadoc/latest/com/onarandombox/MultiverseCore/event/MVTeleportEvent.html new file mode 100644 index 000000000..c47b54aa1 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/event/MVTeleportEvent.html @@ -0,0 +1,510 @@ + + + + + +MVTeleportEvent (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.event
+

Class MVTeleportEvent

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • org.bukkit.event.Event
      • +
    • +
        +
      • com.onarandombox.MultiverseCore.event.MVTeleportEvent
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    org.bukkit.event.Cancellable
    +
    +
    +
    public class MVTeleportEvent
+extends org.bukkit.event.Event
+implements org.bukkit.event.Cancellable
    +
    Event that gets called when a player use the /mvtp command.
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

        Nested classes/interfaces inherited from class org.bukkit.event.Event

        +org.bukkit.event.Event.Result
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      MVTeleportEvent​(MVDestination dest, + org.bukkit.entity.Player teleportee, + org.bukkit.command.CommandSender teleporter, + boolean safeTeleport) 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      MVDestinationgetDestination() +
      Returns the destination that the player will spawn at.
      +
      org.bukkit.LocationgetFrom() +
      Returns the location the player was before the teleport.
      +
      static org.bukkit.event.HandlerListgetHandlerList() +
      Gets the handler list.
      +
      org.bukkit.event.HandlerListgetHandlers()
      org.bukkit.entity.PlayergetTeleportee() +
      Returns the player who will be teleported by this event.
      +
      org.bukkit.command.CommandSendergetTeleporter() +
      Gets the CommandSender who requested the Teleport.
      +
      booleanisCancelled() 
      booleanisUsingSafeTTeleporter() +
      Looks if this MVTeleportEvent is using the SafeTTeleporter.
      +
      voidsetCancelled​(boolean cancel) 
      +
        +
      • + + +

        Methods inherited from class org.bukkit.event.Event

        +getEventName, isAsynchronous
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        MVTeleportEvent

        +
        public MVTeleportEvent​(MVDestination dest,
+                       org.bukkit.entity.Player teleportee,
+                       org.bukkit.command.CommandSender teleporter,
+                       boolean safeTeleport)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getHandlers

        +
        public org.bukkit.event.HandlerList getHandlers()
        +
        +
        Specified by:
        +
        getHandlers in class org.bukkit.event.Event
        +
        +
        • +
      + + + +
        +
      • +

        getHandlerList

        +
        public static org.bukkit.event.HandlerList getHandlerList()
        +
        Gets the handler list. This is required by the event system.
        +
        +
        Returns:
        +
        A list of HANDLERS.
        +
        +
        • +
      + + + +
        +
      • +

        getTeleportee

        +
        public org.bukkit.entity.Player getTeleportee()
        +
        Returns the player who will be teleported by this event.
        +
        +
        Returns:
        +
        The player who will be teleported by this event.
        +
        +
        • +
      + + + +
        +
      • +

        getFrom

        +
        public org.bukkit.Location getFrom()
        +
        Returns the location the player was before the teleport.
        +
        +
        Returns:
        +
        The location the player was before the teleport.
        +
        +
        • +
      + + + +
        +
      • +

        getTeleporter

        +
        public org.bukkit.command.CommandSender getTeleporter()
        +
        Gets the CommandSender who requested the Teleport.
        +
        +
        Returns:
        +
        The CommandSender who requested the Teleport
        +
        +
        • +
      + + + +
        +
      • +

        getDestination

        +
        public MVDestination getDestination()
        +
        Returns the destination that the player will spawn at.
        +
        +
        Returns:
        +
        The destination the player will spawn at.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        isCancelled

        +
        public boolean isCancelled()
        +
        +
        Specified by:
        +
        isCancelled in interface org.bukkit.event.Cancellable
        +
        +
        • +
      + + + +
        +
      • +

        setCancelled

        +
        public void setCancelled​(boolean cancel)
        +
        +
        Specified by:
        +
        setCancelled in interface org.bukkit.event.Cancellable
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/event/MVVersionEvent.html b/javadoc/latest/com/onarandombox/MultiverseCore/event/MVVersionEvent.html new file mode 100644 index 000000000..bab4e6cf1 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/event/MVVersionEvent.html @@ -0,0 +1,475 @@ + + + + + +MVVersionEvent (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.event
+

Class MVVersionEvent

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • org.bukkit.event.Event
      • +
    • +
        +
      • com.onarandombox.MultiverseCore.event.MVVersionEvent
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    public class MVVersionEvent
+extends org.bukkit.event.Event
    +
    Called when somebody requests version information about Multiverse.
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

        Nested classes/interfaces inherited from class org.bukkit.event.Event

        +org.bukkit.event.Event.Result
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      MVVersionEvent() 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      voidappendVersionInfo​(java.lang.String moreVersionInfo) +
      Appends more version-info to the version-info currently saved in this event.
      +
      java.util.Map<java.lang.String,​java.lang.String>getDetailedVersionInfo() +
      Gets the key/value pair of the detailed version info.
      +
      static org.bukkit.event.HandlerListgetHandlerList() +
      Gets the handler list.
      +
      org.bukkit.event.HandlerListgetHandlers()
      java.lang.StringgetVersionInfo() +
      Gets the version-info currently saved in this event.
      +
      voidputDetailedVersionInfo​(java.lang.String filename, + java.io.File file) +
      Adds a file to to the detailed version-info currently saved in this event.
      +
      voidputDetailedVersionInfo​(java.lang.String fileName, + java.lang.String contents) +
      Adds a file to to the detailed version-info currently saved in this event.
      +
      +
        +
      • + + +

        Methods inherited from class org.bukkit.event.Event

        +getEventName, isAsynchronous
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        MVVersionEvent

        +
        public MVVersionEvent()
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getHandlers

        +
        public org.bukkit.event.HandlerList getHandlers()
        +
        +
        Specified by:
        +
        getHandlers in class org.bukkit.event.Event
        +
        +
        • +
      + + + +
        +
      • +

        getHandlerList

        +
        public static org.bukkit.event.HandlerList getHandlerList()
        +
        Gets the handler list. This is required by the event system.
        +
        +
        Returns:
        +
        A list of HANDLERS.
        +
        +
        • +
      + + + +
        +
      • +

        getVersionInfo

        +
        public java.lang.String getVersionInfo()
        +
        Gets the version-info currently saved in this event.
        +
        +
        Returns:
        +
        The version-info.
        +
        +
        • +
      + + + +
        +
      • +

        getDetailedVersionInfo

        +
        public java.util.Map<java.lang.String,​java.lang.String> getDetailedVersionInfo()
        +
        Gets the key/value pair of the detailed version info. + + This information is used for advanced paste services that would prefer + to get the information as several files. Examples include config.yml or + portals.yml. Note that the map returned is immutable. + + The keys are filenames, the values are the contents of the files.
        +
        +
        Returns:
        +
        The immutable key value mapping of files and the contents of those files.
        +
        +
        • +
      + + + +
        +
      • +

        appendVersionInfo

        +
        public void appendVersionInfo​(java.lang.String moreVersionInfo)
        +
        Appends more version-info to the version-info currently saved in this event.
        +
        +
        Parameters:
        +
        moreVersionInfo - The version-info to add. Should end with '\n'.
        +
        +
        • +
      + + + +
        +
      • +

        putDetailedVersionInfo

        +
        public void putDetailedVersionInfo​(java.lang.String fileName,
+                                   java.lang.String contents)
        +
        Adds a file to to the detailed version-info currently saved in this event.
        +
        +
        Parameters:
        +
        fileName - The name of the file.
        +
        contents - The contents of the file.
        +
        +
        • +
      + + + +
        +
      • +

        putDetailedVersionInfo

        +
        public void putDetailedVersionInfo​(java.lang.String filename,
+                                   java.io.File file)
        +
        Adds a file to to the detailed version-info currently saved in this event.
        +
        +
        Parameters:
        +
        filename - The name of the file.
        +
        file - The file.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/event/MVWorldDeleteEvent.html b/javadoc/latest/com/onarandombox/MultiverseCore/event/MVWorldDeleteEvent.html new file mode 100644 index 000000000..9f062a36e --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/event/MVWorldDeleteEvent.html @@ -0,0 +1,441 @@ + + + + + +MVWorldDeleteEvent (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.event
+

Class MVWorldDeleteEvent

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • org.bukkit.event.Event
      • +
    • +
        +
      • com.onarandombox.MultiverseCore.event.MVWorldDeleteEvent
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    org.bukkit.event.Cancellable
    +
    +
    +
    public class MVWorldDeleteEvent
+extends org.bukkit.event.Event
+implements org.bukkit.event.Cancellable
    +
    Called when a world is about to be deleted by Multiverse.
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

        Nested classes/interfaces inherited from class org.bukkit.event.Event

        +org.bukkit.event.Event.Result
        • +
      +
      • +
    +
    + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      static org.bukkit.event.HandlerListgetHandlerList() +
      Gets the handler list.
      +
      org.bukkit.event.HandlerListgetHandlers()
      MultiverseWorldgetWorld() +
      Gets the world that's about to be deleted.
      +
      booleanisCancelled()
      booleanremoveWorldFromConfig() +
      Is the world about to be removed from the config?
      +
      voidsetCancelled​(boolean cancel)
      +
        +
      • + + +

        Methods inherited from class org.bukkit.event.Event

        +getEventName, isAsynchronous
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        MVWorldDeleteEvent

        +
        public MVWorldDeleteEvent​(MultiverseWorld world,
+                          boolean removeFromConfig)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getHandlers

        +
        public org.bukkit.event.HandlerList getHandlers()
        +
        +
        Specified by:
        +
        getHandlers in class org.bukkit.event.Event
        +
        +
        • +
      + + + +
        +
      • +

        getHandlerList

        +
        public static org.bukkit.event.HandlerList getHandlerList()
        +
        Gets the handler list. This is required by the event system.
        +
        +
        Returns:
        +
        A list of HANDLERS.
        +
        +
        • +
      + + + +
        +
      • +

        isCancelled

        +
        public boolean isCancelled()
        +
        +
        Specified by:
        +
        isCancelled in interface org.bukkit.event.Cancellable
        +
        +
        • +
      + + + +
        +
      • +

        setCancelled

        +
        public void setCancelled​(boolean cancel)
        +
        +
        Specified by:
        +
        setCancelled in interface org.bukkit.event.Cancellable
        +
        +
        • +
      + + + + + + + +
        +
      • +

        removeWorldFromConfig

        +
        public boolean removeWorldFromConfig()
        +
        Is the world about to be removed from the config?
        +
        +
        Returns:
        +
        True if yes, false if no.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/event/MVWorldPropertyChangeEvent.html b/javadoc/latest/com/onarandombox/MultiverseCore/event/MVWorldPropertyChangeEvent.html new file mode 100644 index 000000000..1d55b258a --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/event/MVWorldPropertyChangeEvent.html @@ -0,0 +1,582 @@ + + + + + +MVWorldPropertyChangeEvent (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.event
+

Class MVWorldPropertyChangeEvent<T>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • org.bukkit.event.Event
      • +
    • +
        +
      • com.onarandombox.MultiverseCore.event.MVWorldPropertyChangeEvent<T>
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    T - The type of the property that was set.
    +
    +
    +
    All Implemented Interfaces:
    +
    org.bukkit.event.Cancellable
    +
    +
    +
    public class MVWorldPropertyChangeEvent<T>
+extends org.bukkit.event.Event
+implements org.bukkit.event.Cancellable
    +
    This event is fired *before* the property is actually changed. +

    + If it is cancelled, no change will happen. +

    + If you want to get the values of the world before the change, query the world. + To get the name of the property that was changed, use getPropertyName(). + To get the new value, use getTheNewValue(). To change it, use setTheNewValue(Object).

    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

        Nested classes/interfaces inherited from class org.bukkit.event.Event

        +org.bukkit.event.Event.Result
        • +
      +
      • +
    +
    + +
    + +
    + +
    + +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + + + +
        +
      • +

        MVWorldPropertyChangeEvent

        +
        public MVWorldPropertyChangeEvent​(MultiverseWorld world,
+                                  org.bukkit.command.CommandSender changer,
+                                  java.lang.String name,
+                                  T value)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getHandlers

        +
        public org.bukkit.event.HandlerList getHandlers()
        +
        +
        Specified by:
        +
        getHandlers in class org.bukkit.event.Event
        +
        +
        • +
      + + + +
        +
      • +

        getHandlerList

        +
        public static org.bukkit.event.HandlerList getHandlerList()
        +
        Gets the handler list. This is required by the event system.
        +
        +
        Returns:
        +
        A list of handlers.
        +
        +
        • +
      + + + +
        +
      • +

        getPropertyName

        +
        public java.lang.String getPropertyName()
        +
        Gets the changed world property's name.
        +
        +
        Returns:
        +
        The changed world property's name.
        +
        +
        • +
      + + + +
        +
      • +

        getNewValue

        +
        @Deprecated
+public java.lang.String getNewValue()
        +
        Deprecated. +
        Use getTheNewValue() instead.
        +
        +
        Gets the new value.
        +
        +
        Returns:
        +
        The new value.
        +
        +
        • +
      + + + +
        +
      • +

        getTheNewValue

        +
        public T getTheNewValue()
        +
        Gets the new value.
        +
        +
        Returns:
        +
        The new value.
        +
        +
        • +
      + + + +
        +
      • +

        setNewValue

        +
        @Deprecated
+public void setNewValue​(java.lang.String value)
        +
        Deprecated. +
        Use setTheNewValue(Object) instead.
        +
        +
        Sets the new value. +

        + This method is only a stub, it'll always throw an UnsupportedOperationException!

        +
        +
        Parameters:
        +
        value - The new new value.
        +
        +
        • +
      + + + + + +
        +
      • +

        setTheNewValue

        +
        public void setTheNewValue​(T value)
        +
        Sets the new value.
        +
        +
        Parameters:
        +
        value - The new value.
        +
        +
        • +
      + + + +
        +
      • +

        getWorld

        +
        public MultiverseWorld getWorld()
        +
        Get the world targeted because of this change.
        +
        +
        Returns:
        +
        A valid MultiverseWorld.
        +
        +
        • +
      + + + +
        +
      • +

        getCommandSender

        +
        public org.bukkit.command.CommandSender getCommandSender()
        +
        Gets the person (or console) who was responsible for the change. +

        + This may be null!

        +
        +
        Returns:
        +
        The person (or console) who was responsible for the change.
        +
        +
        • +
      + + + +
        +
      • +

        isCancelled

        +
        public boolean isCancelled()
        +
        +
        Specified by:
        +
        isCancelled in interface org.bukkit.event.Cancellable
        +
        +
        • +
      + + + +
        +
      • +

        setCancelled

        +
        public void setCancelled​(boolean cancelled)
        +
        +
        Specified by:
        +
        setCancelled in interface org.bukkit.event.Cancellable
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/event/package-summary.html b/javadoc/latest/com/onarandombox/MultiverseCore/event/package-summary.html new file mode 100644 index 000000000..940f82189 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/event/package-summary.html @@ -0,0 +1,213 @@ + + + + + +com.onarandombox.MultiverseCore.event (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+
+
+

Package com.onarandombox.MultiverseCore.event

+
+
+
+ + +
This package contains all events.
+
+ +
+
+ + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/event/package-tree.html b/javadoc/latest/com/onarandombox/MultiverseCore/event/package-tree.html new file mode 100644 index 000000000..2709a17ba --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/event/package-tree.html @@ -0,0 +1,172 @@ + + + + + +com.onarandombox.MultiverseCore.event Class Hierarchy (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package com.onarandombox.MultiverseCore.event

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+ +
+
+
+ + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/exceptions/PropertyDoesNotExistException.html b/javadoc/latest/com/onarandombox/MultiverseCore/exceptions/PropertyDoesNotExistException.html new file mode 100644 index 000000000..38395c069 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/exceptions/PropertyDoesNotExistException.html @@ -0,0 +1,307 @@ + + + + + +PropertyDoesNotExistException (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.exceptions
+

Class PropertyDoesNotExistException

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • java.lang.Throwable
      • +
    • +
        +
      • java.lang.Exception
        • +
      • +
          +
        • com.onarandombox.MultiverseCore.exceptions.PropertyDoesNotExistException
          • +
        +
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    public class PropertyDoesNotExistException
+extends java.lang.Exception
    +
    Thrown when a world-property doesn't exist.
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PropertyDoesNotExistException

        +
        public PropertyDoesNotExistException​(java.lang.String name)
        +
        • +
      + + + +
        +
      • +

        PropertyDoesNotExistException

        +
        public PropertyDoesNotExistException​(java.lang.String name,
+                                     java.lang.Throwable cause)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/exceptions/package-summary.html b/javadoc/latest/com/onarandombox/MultiverseCore/exceptions/package-summary.html new file mode 100644 index 000000000..b092b7bb7 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/exceptions/package-summary.html @@ -0,0 +1,171 @@ + + + + + +com.onarandombox.MultiverseCore.exceptions (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+
+
+

Package com.onarandombox.MultiverseCore.exceptions

+
+
+
+ + +
This package contains all exceptions.
+
+
    +
  • + + + + + + + + + + + + +
    Exception Summary 
    ExceptionDescription
    PropertyDoesNotExistException +
    Thrown when a world-property doesn't exist.
    +
    +
    • +
+
+
+ + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/exceptions/package-tree.html b/javadoc/latest/com/onarandombox/MultiverseCore/exceptions/package-tree.html new file mode 100644 index 000000000..9f13a2615 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/exceptions/package-tree.html @@ -0,0 +1,169 @@ + + + + + +com.onarandombox.MultiverseCore.exceptions Class Hierarchy (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package com.onarandombox.MultiverseCore.exceptions

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+
    +
  • java.lang.Object +
      +
    • java.lang.Throwable (implements java.io.Serializable) + +
      • +
    +
    • +
+
+
+
+ + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/listeners/AsyncChatEvent.html b/javadoc/latest/com/onarandombox/MultiverseCore/listeners/AsyncChatEvent.html new file mode 100644 index 000000000..38f55952f --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/listeners/AsyncChatEvent.html @@ -0,0 +1,380 @@ + + + + + +AsyncChatEvent (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.listeners
+

Class AsyncChatEvent

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.listeners.AsyncChatEvent
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    ChatEvent
    +
    +
    +
    public class AsyncChatEvent
+extends java.lang.Object
+implements ChatEvent
    +
    A wrapper for the AsyncPlayerChatEvent.
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      AsyncChatEvent​(org.bukkit.event.player.AsyncPlayerChatEvent event) 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      java.lang.StringgetFormat() 
      org.bukkit.entity.PlayergetPlayer() 
      booleanisCancelled() 
      voidsetFormat​(java.lang.String s) +
      Sets the format.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        AsyncChatEvent

        +
        public AsyncChatEvent​(org.bukkit.event.player.AsyncPlayerChatEvent event)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        isCancelled

        +
        public boolean isCancelled()
        +
        +
        Specified by:
        +
        isCancelled in interface ChatEvent
        +
        Returns:
        +
        Whether this event is cancelled.
        +
        +
        • +
      + + + +
        +
      • +

        getFormat

        +
        public java.lang.String getFormat()
        +
        +
        Specified by:
        +
        getFormat in interface ChatEvent
        +
        Returns:
        +
        The format.
        +
        +
        • +
      + + + +
        +
      • +

        setFormat

        +
        public void setFormat​(java.lang.String s)
        +
        Description copied from interface: ChatEvent
        +
        Sets the format.
        +
        +
        Specified by:
        +
        setFormat in interface ChatEvent
        +
        Parameters:
        +
        s - The new format.
        +
        +
        • +
      + + + +
        +
      • +

        getPlayer

        +
        public org.bukkit.entity.Player getPlayer()
        +
        +
        Specified by:
        +
        getPlayer in interface ChatEvent
        +
        Returns:
        +
        The player.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/listeners/ChatEvent.html b/javadoc/latest/com/onarandombox/MultiverseCore/listeners/ChatEvent.html new file mode 100644 index 000000000..c3c388233 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/listeners/ChatEvent.html @@ -0,0 +1,314 @@ + + + + + +ChatEvent (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.listeners
+

Interface ChatEvent

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    AsyncChatEvent, NormalChatEvent
    +
    +
    +
    public interface ChatEvent
    +
    A wrapper for the two chat-events in Bukkit.
    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        isCancelled

        +
        boolean isCancelled()
        +
        +
        Returns:
        +
        Whether this event is cancelled.
        +
        +
        • +
      + + + +
        +
      • +

        getFormat

        +
        java.lang.String getFormat()
        +
        +
        Returns:
        +
        The format.
        +
        +
        • +
      + + + +
        +
      • +

        setFormat

        +
        void setFormat​(java.lang.String s)
        +
        Sets the format.
        +
        +
        Parameters:
        +
        s - The new format.
        +
        +
        • +
      + + + +
        +
      • +

        getPlayer

        +
        org.bukkit.entity.Player getPlayer()
        +
        +
        Returns:
        +
        The player.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/listeners/MVAsyncPlayerChatListener.html b/javadoc/latest/com/onarandombox/MultiverseCore/listeners/MVAsyncPlayerChatListener.html new file mode 100644 index 000000000..073cf9867 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/listeners/MVAsyncPlayerChatListener.html @@ -0,0 +1,330 @@ + + + + + +MVAsyncPlayerChatListener (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.listeners
+

Class MVAsyncPlayerChatListener

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    org.bukkit.event.Listener
    +
    +
    +
    public class MVAsyncPlayerChatListener
+extends MVChatListener
    +
    Multiverse's Listener for players.
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      voidplayerChat​(org.bukkit.event.player.AsyncPlayerChatEvent event) +
      This method is called when a player wants to chat.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        playerChat

        +
        public void playerChat​(org.bukkit.event.player.AsyncPlayerChatEvent event)
        +
        This method is called when a player wants to chat.
        +
        +
        Parameters:
        +
        event - The Event that was fired.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/listeners/MVChatListener.html b/javadoc/latest/com/onarandombox/MultiverseCore/listeners/MVChatListener.html new file mode 100644 index 000000000..76d3c59c4 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/listeners/MVChatListener.html @@ -0,0 +1,323 @@ + + + + + +MVChatListener (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.listeners
+

Class MVChatListener

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.listeners.MVChatListener
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    org.bukkit.event.Listener
    +
    +
    +
    Direct Known Subclasses:
    +
    MVAsyncPlayerChatListener, MVPlayerChatListener
    +
    +
    +
    public abstract class MVChatListener
+extends java.lang.Object
+implements org.bukkit.event.Listener
    +
    Multiverse's Listener for players.
    +
    • +
+
+
+ +
+
+ +
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/listeners/MVEntityListener.html b/javadoc/latest/com/onarandombox/MultiverseCore/listeners/MVEntityListener.html new file mode 100644 index 000000000..0a1e4132d --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/listeners/MVEntityListener.html @@ -0,0 +1,380 @@ + + + + + +MVEntityListener (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.listeners
+

Class MVEntityListener

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.listeners.MVEntityListener
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    org.bukkit.event.Listener
    +
    +
    +
    public class MVEntityListener
+extends java.lang.Object
+implements org.bukkit.event.Listener
    +
    Multiverse's Entity Listener.
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      voidcreatureSpawn​(org.bukkit.event.entity.CreatureSpawnEvent event) +
      Handle Animal/Monster Spawn settings, seems like a more concrete method than using CraftBukkit.
      +
      voidentityPortal​(org.bukkit.event.entity.EntityPortalEvent event) +
      Handles portal search radius adjustment.
      +
      voidentityRegainHealth​(org.bukkit.event.entity.EntityRegainHealthEvent event) +
      This method is called when an entity's health goes up or down.
      +
      voidfoodLevelChange​(org.bukkit.event.entity.FoodLevelChangeEvent event) +
      This method is called when an entity's food level goes higher or lower.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        MVEntityListener

        +
        public MVEntityListener​(MultiverseCore plugin)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        foodLevelChange

        +
        public void foodLevelChange​(org.bukkit.event.entity.FoodLevelChangeEvent event)
        +
        This method is called when an entity's food level goes higher or lower.
        +
        +
        Parameters:
        +
        event - The Event that was fired.
        +
        +
        • +
      + + + +
        +
      • +

        entityRegainHealth

        +
        public void entityRegainHealth​(org.bukkit.event.entity.EntityRegainHealthEvent event)
        +
        This method is called when an entity's health goes up or down.
        +
        +
        Parameters:
        +
        event - The Event that was fired.
        +
        +
        • +
      + + + +
        +
      • +

        creatureSpawn

        +
        public void creatureSpawn​(org.bukkit.event.entity.CreatureSpawnEvent event)
        +
        Handle Animal/Monster Spawn settings, seems like a more concrete method than using CraftBukkit.
        +
        +
        Parameters:
        +
        event - The event.
        +
        +
        • +
      + + + +
        +
      • +

        entityPortal

        +
        public void entityPortal​(org.bukkit.event.entity.EntityPortalEvent event)
        +
        Handles portal search radius adjustment.
        +
        +
        Parameters:
        +
        event - The Event that was fired.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/listeners/MVMapListener.html b/javadoc/latest/com/onarandombox/MultiverseCore/listeners/MVMapListener.html new file mode 100644 index 000000000..8232278bd --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/listeners/MVMapListener.html @@ -0,0 +1,317 @@ + + + + + +MVMapListener (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.listeners
+

Class MVMapListener

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.listeners.MVMapListener
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    org.bukkit.event.Listener
    +
    +
    +
    public class MVMapListener
+extends java.lang.Object
+implements org.bukkit.event.Listener
    +
    A listener for bukkit map events.
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      voidmapInitialize​(org.bukkit.event.server.MapInitializeEvent event) +
      This method is called when a map is initialized.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        mapInitialize

        +
        public void mapInitialize​(org.bukkit.event.server.MapInitializeEvent event)
        +
        This method is called when a map is initialized.
        +
        +
        Parameters:
        +
        event - The event that was fired.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/listeners/MVPlayerChatListener.html b/javadoc/latest/com/onarandombox/MultiverseCore/listeners/MVPlayerChatListener.html new file mode 100644 index 000000000..27fd532cb --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/listeners/MVPlayerChatListener.html @@ -0,0 +1,330 @@ + + + + + +MVPlayerChatListener (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.listeners
+

Class MVPlayerChatListener

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    org.bukkit.event.Listener
    +
    +
    +
    public class MVPlayerChatListener
+extends MVChatListener
    +
    Multiverse's Listener for players.
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      voidplayerChat​(org.bukkit.event.player.PlayerChatEvent event) +
      This method is called when a player wants to chat.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        playerChat

        +
        public void playerChat​(org.bukkit.event.player.PlayerChatEvent event)
        +
        This method is called when a player wants to chat.
        +
        +
        Parameters:
        +
        event - The Event that was fired.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/listeners/MVPlayerListener.html b/javadoc/latest/com/onarandombox/MultiverseCore/listeners/MVPlayerListener.html new file mode 100644 index 000000000..589e6e35e --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/listeners/MVPlayerListener.html @@ -0,0 +1,487 @@ + + + + + +MVPlayerListener (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.listeners
+

Class MVPlayerListener

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.listeners.MVPlayerListener
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    org.bukkit.event.Listener
    +
    +
    +
    public class MVPlayerListener
+extends java.lang.Object
+implements org.bukkit.event.Listener
    +
    Multiverse's Listener for players.
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      java.util.Map<java.lang.String,​java.lang.String>getPlayerWorld() 
      voidhandleGameModeAndFlight​(org.bukkit.entity.Player player, + MultiverseWorld world) +
      Handles the gamemode for the specified Player.
      +
      voidplayerChangedWorld​(org.bukkit.event.player.PlayerChangedWorldEvent event) +
      This method is called when a player changes worlds.
      +
      voidplayerJoin​(org.bukkit.event.player.PlayerJoinEvent event) +
      This method is called when a player joins the server.
      +
      voidplayerPortal​(org.bukkit.event.player.PlayerPortalEvent event) +
      This method is called when a player actually portals via a vanilla style portal.
      +
      voidplayerPortalCheck​(org.bukkit.event.player.PlayerPortalEvent event) +
      This method is called to adjust the portal location to the actual portal location (and not + right outside of it.
      +
      voidplayerQuit​(org.bukkit.event.player.PlayerQuitEvent event) +
      This method is called when a player quits the game.
      +
      voidplayerRespawn​(org.bukkit.event.player.PlayerRespawnEvent event) +
      This method is called when a player respawns.
      +
      voidplayerTeleport​(org.bukkit.event.player.PlayerTeleportEvent event) +
      This method is called when a player teleports anywhere.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        MVPlayerListener

        +
        public MVPlayerListener​(MultiverseCore plugin)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getPlayerWorld

        +
        public java.util.Map<java.lang.String,​java.lang.String> getPlayerWorld()
        +
        +
        Returns:
        +
        the playerWorld-map
        +
        +
        • +
      + + + +
        +
      • +

        playerRespawn

        +
        public void playerRespawn​(org.bukkit.event.player.PlayerRespawnEvent event)
        +
        This method is called when a player respawns.
        +
        +
        Parameters:
        +
        event - The Event that was fired.
        +
        +
        • +
      + + + +
        +
      • +

        playerJoin

        +
        public void playerJoin​(org.bukkit.event.player.PlayerJoinEvent event)
        +
        This method is called when a player joins the server.
        +
        +
        Parameters:
        +
        event - The Event that was fired.
        +
        +
        • +
      + + + +
        +
      • +

        playerChangedWorld

        +
        public void playerChangedWorld​(org.bukkit.event.player.PlayerChangedWorldEvent event)
        +
        This method is called when a player changes worlds.
        +
        +
        Parameters:
        +
        event - The Event that was fired.
        +
        +
        • +
      + + + +
        +
      • +

        playerQuit

        +
        public void playerQuit​(org.bukkit.event.player.PlayerQuitEvent event)
        +
        This method is called when a player quits the game.
        +
        +
        Parameters:
        +
        event - The Event that was fired.
        +
        +
        • +
      + + + +
        +
      • +

        playerTeleport

        +
        public void playerTeleport​(org.bukkit.event.player.PlayerTeleportEvent event)
        +
        This method is called when a player teleports anywhere.
        +
        +
        Parameters:
        +
        event - The Event that was fired.
        +
        +
        • +
      + + + +
        +
      • +

        playerPortalCheck

        +
        public void playerPortalCheck​(org.bukkit.event.player.PlayerPortalEvent event)
        +
        This method is called to adjust the portal location to the actual portal location (and not + right outside of it.
        +
        +
        Parameters:
        +
        event - The Event that was fired.
        +
        +
        • +
      + + + +
        +
      • +

        playerPortal

        +
        public void playerPortal​(org.bukkit.event.player.PlayerPortalEvent event)
        +
        This method is called when a player actually portals via a vanilla style portal.
        +
        +
        Parameters:
        +
        event - The Event that was fired.
        +
        +
        • +
      + + + +
        +
      • +

        handleGameModeAndFlight

        +
        public void handleGameModeAndFlight​(org.bukkit.entity.Player player,
+                                    MultiverseWorld world)
        +
        Handles the gamemode for the specified Player.
        +
        +
        Parameters:
        +
        player - The Player.
        +
        world - The world the player is in.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/listeners/MVPortalListener.html b/javadoc/latest/com/onarandombox/MultiverseCore/listeners/MVPortalListener.html new file mode 100644 index 000000000..d2511c343 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/listeners/MVPortalListener.html @@ -0,0 +1,359 @@ + + + + + +MVPortalListener (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.listeners
+

Class MVPortalListener

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.listeners.MVPortalListener
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    org.bukkit.event.Listener
    +
    +
    +
    public class MVPortalListener
+extends java.lang.Object
+implements org.bukkit.event.Listener
    +
    A custom listener for portal related events.
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      voidentityPortalCreate​(org.bukkit.event.entity.EntityCreatePortalEvent event) +
      This is called when an entity creates a portal.
      +
      voidportalForm​(org.bukkit.event.player.PlayerInteractEvent event) +
      This method will prevent ender portals from being created in worlds where they are not allowed due to portalForm.
      +
      voidportalForm​(org.bukkit.event.world.PortalCreateEvent event) +
      This is called when a portal is created as the result of another world being linked.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        MVPortalListener

        +
        public MVPortalListener​(MultiverseCore core)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        entityPortalCreate

        +
        public void entityPortalCreate​(org.bukkit.event.entity.EntityCreatePortalEvent event)
        +
        This is called when an entity creates a portal.
        +
        +
        Parameters:
        +
        event - The event where an entity created a portal.
        +
        +
        • +
      + + + +
        +
      • +

        portalForm

        +
        public void portalForm​(org.bukkit.event.world.PortalCreateEvent event)
        +
        This is called when a portal is created as the result of another world being linked.
        +
        +
        Parameters:
        +
        event - The event where a portal was formed due to a world link
        +
        +
        • +
      + + + +
        +
      • +

        portalForm

        +
        public void portalForm​(org.bukkit.event.player.PlayerInteractEvent event)
        +
        This method will prevent ender portals from being created in worlds where they are not allowed due to portalForm.
        +
        +
        Parameters:
        +
        event - The player interact event.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/listeners/MVWeatherListener.html b/javadoc/latest/com/onarandombox/MultiverseCore/listeners/MVWeatherListener.html new file mode 100644 index 000000000..832de410b --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/listeners/MVWeatherListener.html @@ -0,0 +1,338 @@ + + + + + +MVWeatherListener (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.listeners
+

Class MVWeatherListener

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.listeners.MVWeatherListener
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    org.bukkit.event.Listener
    +
    +
    +
    public class MVWeatherListener
+extends java.lang.Object
+implements org.bukkit.event.Listener
    +
    Multiverse's Weather Listener.
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      voidthunderChange​(org.bukkit.event.weather.ThunderChangeEvent event) +
      This method is called when a big storm is going to start.
      +
      voidweatherChange​(org.bukkit.event.weather.WeatherChangeEvent event) +
      This method is called when the weather changes.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        MVWeatherListener

        +
        public MVWeatherListener​(MultiverseCore plugin)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        weatherChange

        +
        public void weatherChange​(org.bukkit.event.weather.WeatherChangeEvent event)
        +
        This method is called when the weather changes.
        +
        +
        Parameters:
        +
        event - The Event that was fired.
        +
        +
        • +
      + + + +
        +
      • +

        thunderChange

        +
        public void thunderChange​(org.bukkit.event.weather.ThunderChangeEvent event)
        +
        This method is called when a big storm is going to start.
        +
        +
        Parameters:
        +
        event - The Event that was fired.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/listeners/MVWorldInitListener.html b/javadoc/latest/com/onarandombox/MultiverseCore/listeners/MVWorldInitListener.html new file mode 100644 index 000000000..56264d781 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/listeners/MVWorldInitListener.html @@ -0,0 +1,309 @@ + + + + + +MVWorldInitListener (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.listeners
+

Class MVWorldInitListener

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.listeners.MVWorldInitListener
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    org.bukkit.event.Listener
    +
    +
    +
    public class MVWorldInitListener
+extends java.lang.Object
+implements org.bukkit.event.Listener
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      voidinitWorld​(org.bukkit.event.world.WorldInitEvent event) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        MVWorldInitListener

        +
        public MVWorldInitListener​(MultiverseCore plugin)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        initWorld

        +
        public void initWorld​(org.bukkit.event.world.WorldInitEvent event)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/listeners/MVWorldListener.html b/javadoc/latest/com/onarandombox/MultiverseCore/listeners/MVWorldListener.html new file mode 100644 index 000000000..91fc87dd3 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/listeners/MVWorldListener.html @@ -0,0 +1,338 @@ + + + + + +MVWorldListener (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.listeners
+

Class MVWorldListener

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.listeners.MVWorldListener
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    org.bukkit.event.Listener
    +
    +
    +
    public class MVWorldListener
+extends java.lang.Object
+implements org.bukkit.event.Listener
    +
    Multiverse's World Listener.
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      voidloadWorld​(org.bukkit.event.world.WorldLoadEvent event) +
      This method is called when Bukkit fires off a WorldLoadEvent.
      +
      voidunloadWorld​(org.bukkit.event.world.WorldUnloadEvent event) +
      This method is called when Bukkit fires off a WorldUnloadEvent.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        MVWorldListener

        +
        public MVWorldListener​(MultiverseCore plugin)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        unloadWorld

        +
        public void unloadWorld​(org.bukkit.event.world.WorldUnloadEvent event)
        +
        This method is called when Bukkit fires off a WorldUnloadEvent.
        +
        +
        Parameters:
        +
        event - The Event that was fired.
        +
        +
        • +
      + + + +
        +
      • +

        loadWorld

        +
        public void loadWorld​(org.bukkit.event.world.WorldLoadEvent event)
        +
        This method is called when Bukkit fires off a WorldLoadEvent.
        +
        +
        Parameters:
        +
        event - The Event that was fired.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/listeners/MultiverseCoreListener.html b/javadoc/latest/com/onarandombox/MultiverseCore/listeners/MultiverseCoreListener.html new file mode 100644 index 000000000..2ab892ec2 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/listeners/MultiverseCoreListener.html @@ -0,0 +1,443 @@ + + + + + +MultiverseCoreListener (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.listeners
+

Class MultiverseCoreListener

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.listeners.MultiverseCoreListener
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    org.bukkit.event.Listener
    +
    +
    +
    public abstract class MultiverseCoreListener
+extends java.lang.Object
+implements org.bukkit.event.Listener
    +
    Subclasses of this listener can be used to conveniently listen to MultiverseCore-events.
    +
    • +
+
+
+ +
+
+ +
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/listeners/NormalChatEvent.html b/javadoc/latest/com/onarandombox/MultiverseCore/listeners/NormalChatEvent.html new file mode 100644 index 000000000..2181b8176 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/listeners/NormalChatEvent.html @@ -0,0 +1,398 @@ + + + + + +NormalChatEvent (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.listeners
+

Class NormalChatEvent

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.listeners.NormalChatEvent
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    ChatEvent
    +
    +
    +
    @Deprecated
+public class NormalChatEvent
+extends java.lang.Object
+implements ChatEvent
    +
    Deprecated. +
    This is deprecated like the PlayerChatEvent.
    +
    +
    A wrapper for the PlayerChatEvent.
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      NormalChatEvent​(org.bukkit.event.player.PlayerChatEvent event) +
      Deprecated.
      + 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and TypeMethodDescription
      java.lang.StringgetFormat() +
      Deprecated.
      + 
      org.bukkit.entity.PlayergetPlayer() +
      Deprecated.
      + 
      booleanisCancelled() +
      Deprecated.
      + 
      voidsetFormat​(java.lang.String s) +
      Deprecated.
      +
      Sets the format.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        NormalChatEvent

        +
        public NormalChatEvent​(org.bukkit.event.player.PlayerChatEvent event)
        +
        Deprecated.
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        isCancelled

        +
        public boolean isCancelled()
        +
        Deprecated.
        +
        +
        Specified by:
        +
        isCancelled in interface ChatEvent
        +
        Returns:
        +
        Whether this event is cancelled.
        +
        +
        • +
      + + + +
        +
      • +

        getFormat

        +
        public java.lang.String getFormat()
        +
        Deprecated.
        +
        +
        Specified by:
        +
        getFormat in interface ChatEvent
        +
        Returns:
        +
        The format.
        +
        +
        • +
      + + + +
        +
      • +

        setFormat

        +
        public void setFormat​(java.lang.String s)
        +
        Deprecated.
        +
        Description copied from interface: ChatEvent
        +
        Sets the format.
        +
        +
        Specified by:
        +
        setFormat in interface ChatEvent
        +
        Parameters:
        +
        s - The new format.
        +
        +
        • +
      + + + +
        +
      • +

        getPlayer

        +
        public org.bukkit.entity.Player getPlayer()
        +
        Deprecated.
        +
        +
        Specified by:
        +
        getPlayer in interface ChatEvent
        +
        Returns:
        +
        The player.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/listeners/package-summary.html b/javadoc/latest/com/onarandombox/MultiverseCore/listeners/package-summary.html new file mode 100644 index 000000000..38309af15 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/listeners/package-summary.html @@ -0,0 +1,258 @@ + + + + + +com.onarandombox.MultiverseCore.listeners (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+
+
+

Package com.onarandombox.MultiverseCore.listeners

+
+
+
+ + +
This package contains all listeners.
+
+ +
+
+ + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/listeners/package-tree.html b/javadoc/latest/com/onarandombox/MultiverseCore/listeners/package-tree.html new file mode 100644 index 000000000..4ac37aa5a --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/listeners/package-tree.html @@ -0,0 +1,182 @@ + + + + + +com.onarandombox.MultiverseCore.listeners Class Hierarchy (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package com.onarandombox.MultiverseCore.listeners

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+
    +
  • java.lang.Object +
      +
    • com.onarandombox.MultiverseCore.listeners.AsyncChatEvent (implements com.onarandombox.MultiverseCore.listeners.ChatEvent)
      • +
    • com.onarandombox.MultiverseCore.listeners.MultiverseCoreListener (implements org.bukkit.event.Listener)
      • +
    • com.onarandombox.MultiverseCore.listeners.MVChatListener (implements org.bukkit.event.Listener) + +
      • +
    • com.onarandombox.MultiverseCore.listeners.MVEntityListener (implements org.bukkit.event.Listener)
      • +
    • com.onarandombox.MultiverseCore.listeners.MVMapListener (implements org.bukkit.event.Listener)
      • +
    • com.onarandombox.MultiverseCore.listeners.MVPlayerListener (implements org.bukkit.event.Listener)
      • +
    • com.onarandombox.MultiverseCore.listeners.MVPortalListener (implements org.bukkit.event.Listener)
      • +
    • com.onarandombox.MultiverseCore.listeners.MVWeatherListener (implements org.bukkit.event.Listener)
      • +
    • com.onarandombox.MultiverseCore.listeners.MVWorldInitListener (implements org.bukkit.event.Listener)
      • +
    • com.onarandombox.MultiverseCore.listeners.MVWorldListener (implements org.bukkit.event.Listener)
      • +
    • com.onarandombox.MultiverseCore.listeners.NormalChatEvent (implements com.onarandombox.MultiverseCore.listeners.ChatEvent)
      • +
    +
    • +
+
+
+

Interface Hierarchy

+
    +
  • com.onarandombox.MultiverseCore.listeners.ChatEvent
    • +
+
+
+
+ + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/package-summary.html b/javadoc/latest/com/onarandombox/MultiverseCore/package-summary.html new file mode 100644 index 000000000..82a30dcd5 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/package-summary.html @@ -0,0 +1,193 @@ + + + + + +com.onarandombox.MultiverseCore (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+
+
+

Package com.onarandombox.MultiverseCore

+
+
+
+ + +
The "master"-package, containing everything related to Multiverse-Core.
+
+ +
+
+ + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/package-tree.html b/javadoc/latest/com/onarandombox/MultiverseCore/package-tree.html new file mode 100644 index 000000000..b1593548b --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/package-tree.html @@ -0,0 +1,185 @@ + + + + + +com.onarandombox.MultiverseCore Class Hierarchy (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package com.onarandombox.MultiverseCore

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+
    +
  • java.lang.Object +
      +
    • org.bukkit.Location (implements java.lang.Cloneable, org.bukkit.configuration.serialization.ConfigurationSerializable) +
        +
      • com.onarandombox.MultiverseCore.configuration.SpawnLocation (implements org.bukkit.configuration.serialization.ConfigurationSerializable) + +
        • +
      +
      • +
    • com.onarandombox.MultiverseCore.MVWorld (implements com.onarandombox.MultiverseCore.api.MultiverseWorld)
      • +
    • org.bukkit.plugin.PluginBase (implements org.bukkit.plugin.Plugin) +
        +
      • org.bukkit.plugin.java.JavaPlugin +
          +
        • com.onarandombox.MultiverseCore.MultiverseCore (implements com.onarandombox.MultiverseCore.api.Core, com.onarandombox.MultiverseCore.api.MVPlugin)
          • +
        +
        • +
      +
      • +
    • me.main__.util.SerializationConfig.SerializationConfig (implements org.bukkit.configuration.serialization.ConfigurationSerializable) + +
      • +
    +
    • +
+
+
+
+ + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/utils/AnchorManager.html b/javadoc/latest/com/onarandombox/MultiverseCore/utils/AnchorManager.html new file mode 100644 index 000000000..e7bc725bb --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/utils/AnchorManager.html @@ -0,0 +1,471 @@ + + + + + +AnchorManager (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.utils
+

Class AnchorManager

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.utils.AnchorManager
      • +
    +
    • +
+
+
    +
  • +
    +
    public class AnchorManager
+extends java.lang.Object
    +
    Manages anchors.
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      booleandeleteAnchor​(java.lang.String s) +
      Deletes the specified anchor.
      +
      java.util.Set<java.lang.String>getAllAnchors() +
      Gets all anchors.
      +
      org.bukkit.LocationgetAnchorLocation​(java.lang.String anchor) +
      Gets the Location associated with an anchor.
      +
      java.util.Set<java.lang.String>getAnchors​(org.bukkit.entity.Player p) +
      Gets all anchors that the specified Player can access.
      +
      voidloadAnchors() +
      Loads all anchors.
      +
      booleansaveAnchorLocation​(java.lang.String anchor, + java.lang.String location) +
      Saves an anchor.
      +
      booleansaveAnchorLocation​(java.lang.String anchor, + org.bukkit.Location l) +
      Saves an anchor.
      +
      booleansaveAnchors() +
      Saves all anchors.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        loadAnchors

        +
        public void loadAnchors()
        +
        Loads all anchors.
        +
        • +
      + + + +
        +
      • +

        saveAnchors

        +
        public boolean saveAnchors()
        +
        Saves all anchors.
        +
        +
        Returns:
        +
        True if all anchors were successfully saved.
        +
        +
        • +
      + + + +
        +
      • +

        getAnchorLocation

        +
        public org.bukkit.Location getAnchorLocation​(java.lang.String anchor)
        +
        Gets the Location associated with an anchor.
        +
        +
        Parameters:
        +
        anchor - The name of the anchor.
        +
        Returns:
        +
        The Location.
        +
        +
        • +
      + + + +
        +
      • +

        saveAnchorLocation

        +
        public boolean saveAnchorLocation​(java.lang.String anchor,
+                                  java.lang.String location)
        +
        Saves an anchor.
        +
        +
        Parameters:
        +
        anchor - The name of the anchor.
        +
        location - The location of the anchor as string.
        +
        Returns:
        +
        True if the anchor was successfully saved.
        +
        +
        • +
      + + + +
        +
      • +

        saveAnchorLocation

        +
        public boolean saveAnchorLocation​(java.lang.String anchor,
+                                  org.bukkit.Location l)
        +
        Saves an anchor.
        +
        +
        Parameters:
        +
        anchor - The name of the anchor.
        +
        l - The Location of the anchor.
        +
        Returns:
        +
        True if the anchor was successfully saved.
        +
        +
        • +
      + + + +
        +
      • +

        getAllAnchors

        +
        public java.util.Set<java.lang.String> getAllAnchors()
        +
        Gets all anchors.
        +
        +
        Returns:
        +
        An unmodifiable Set containing all anchors.
        +
        +
        • +
      + + + +
        +
      • +

        getAnchors

        +
        public java.util.Set<java.lang.String> getAnchors​(org.bukkit.entity.Player p)
        +
        Gets all anchors that the specified Player can access.
        +
        +
        Parameters:
        +
        p - The Player.
        +
        Returns:
        +
        An unmodifiable Set containing all anchors the specified Player can access.
        +
        +
        • +
      + + + +
        +
      • +

        deleteAnchor

        +
        public boolean deleteAnchor​(java.lang.String s)
        +
        Deletes the specified anchor.
        +
        +
        Parameters:
        +
        s - The name of the anchor.
        +
        Returns:
        +
        True if the anchor was successfully deleted.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/utils/BukkitTravelAgent.html b/javadoc/latest/com/onarandombox/MultiverseCore/utils/BukkitTravelAgent.html new file mode 100644 index 000000000..ddc1e54de --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/utils/BukkitTravelAgent.html @@ -0,0 +1,462 @@ + + + + + +BukkitTravelAgent (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.utils
+

Class BukkitTravelAgent

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.utils.BukkitTravelAgent
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    org.bukkit.TravelAgent
    +
    +
    +
    public class BukkitTravelAgent
+extends java.lang.Object
+implements org.bukkit.TravelAgent
    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        BukkitTravelAgent

        +
        public BukkitTravelAgent​(MVTravelAgent agent)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setSearchRadius

        +
        public BukkitTravelAgent setSearchRadius​(int radius)
        +
        +
        Specified by:
        +
        setSearchRadius in interface org.bukkit.TravelAgent
        +
        +
        • +
      + + + +
        +
      • +

        getSearchRadius

        +
        public int getSearchRadius()
        +
        +
        Specified by:
        +
        getSearchRadius in interface org.bukkit.TravelAgent
        +
        +
        • +
      + + + +
        +
      • +

        setCreationRadius

        +
        public BukkitTravelAgent setCreationRadius​(int radius)
        +
        +
        Specified by:
        +
        setCreationRadius in interface org.bukkit.TravelAgent
        +
        +
        • +
      + + + +
        +
      • +

        getCreationRadius

        +
        public int getCreationRadius()
        +
        +
        Specified by:
        +
        getCreationRadius in interface org.bukkit.TravelAgent
        +
        +
        • +
      + + + +
        +
      • +

        getCanCreatePortal

        +
        public boolean getCanCreatePortal()
        +
        +
        Specified by:
        +
        getCanCreatePortal in interface org.bukkit.TravelAgent
        +
        +
        • +
      + + + +
        +
      • +

        setCanCreatePortal

        +
        public void setCanCreatePortal​(boolean create)
        +
        +
        Specified by:
        +
        setCanCreatePortal in interface org.bukkit.TravelAgent
        +
        +
        • +
      + + + +
        +
      • +

        findOrCreate

        +
        public org.bukkit.Location findOrCreate​(org.bukkit.Location location)
        +
        +
        Specified by:
        +
        findOrCreate in interface org.bukkit.TravelAgent
        +
        +
        • +
      + + + +
        +
      • +

        findPortal

        +
        public org.bukkit.Location findPortal​(org.bukkit.Location location)
        +
        +
        Specified by:
        +
        findPortal in interface org.bukkit.TravelAgent
        +
        +
        • +
      + + + +
        +
      • +

        createPortal

        +
        public boolean createPortal​(org.bukkit.Location location)
        +
        +
        Specified by:
        +
        createPortal in interface org.bukkit.TravelAgent
        +
        +
        • +
      + + + +
        +
      • +

        setPortalEventTravelAgent

        +
        public void setPortalEventTravelAgent​(org.bukkit.event.player.PlayerPortalEvent event)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/utils/CompatibilityLayer.html b/javadoc/latest/com/onarandombox/MultiverseCore/utils/CompatibilityLayer.html new file mode 100644 index 000000000..80cd004f3 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/utils/CompatibilityLayer.html @@ -0,0 +1,408 @@ + + + + + +CompatibilityLayer (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.utils
+

Class CompatibilityLayer

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.utils.CompatibilityLayer
      • +
    +
    • +
+
+
    +
  • +
    +
    public class CompatibilityLayer
+extends java.lang.Object
    +
    Utility class to enable version specific minecraft features.
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      CompatibilityLayer() 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethodDescription
      static voidinit() +
      Initialise the reflection class, methods and fields.
      +
      static booleanisAnchorSpawn​(org.bukkit.event.player.PlayerRespawnEvent event) +
      Check if the respawn point is of respawn anchor type.
      +
      static booleanisUseTravelAgent() +
      Gets if Travel Agent is supported on the server's minecraft version.
      +
      static voidsetPortalSearchRadius​(org.bukkit.event.entity.EntityPortalEvent event, + int searchRadius) +
      Sets search radius for a EntityPortalEvent.
      +
      static voidsetPortalSearchRadius​(org.bukkit.event.player.PlayerPortalEvent event, + int searchRadius) +
      Sets search radius for a PlayerPortalEvent.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        CompatibilityLayer

        +
        public CompatibilityLayer()
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        init

        +
        public static void init()
        +
        Initialise the reflection class, methods and fields.
        +
        • +
      + + + +
        +
      • +

        isAnchorSpawn

        +
        public static boolean isAnchorSpawn​(org.bukkit.event.player.PlayerRespawnEvent event)
        +

        Check if the respawn point is of respawn anchor type.

        +

        Introduced in minecraft 1.16

        +
        +
        Parameters:
        +
        event - A player respawn event.
        +
        Returns:
        +
        If the respawn location is an anchor point.
        +
        +
        • +
      + + + +
        +
      • +

        isUseTravelAgent

        +
        public static boolean isUseTravelAgent()
        +

        Gets if Travel Agent is supported on the server's minecraft version.

        +

        Removed in minecraft 1.14

        +
        +
        Returns:
        +
        True if Travel Agent is supported, else false.
        +
        +
        • +
      + + + +
        +
      • +

        setPortalSearchRadius

        +
        public static void setPortalSearchRadius​(org.bukkit.event.player.PlayerPortalEvent event,
+                                         int searchRadius)
        +

        Sets search radius for a PlayerPortalEvent.

        + +

        Use travel agent if available, else using new PlayerPortalEvent.setSearchRadius(int) method + introduced in minecraft 1.15

        +
        +
        Parameters:
        +
        event - A Player Portal Event.
        +
        searchRadius - Target search radius to set to.
        +
        +
        • +
      + + + +
        +
      • +

        setPortalSearchRadius

        +
        public static void setPortalSearchRadius​(org.bukkit.event.entity.EntityPortalEvent event,
+                                         int searchRadius)
        +

        Sets search radius for a EntityPortalEvent.

        + +

        Use travel agent if available, else using new EntityPortalEvent.setSearchRadius(int) method + introduced in minecraft 1.15

        +
        +
        Parameters:
        +
        event - A Entity Portal Event.
        +
        searchRadius - Target search radius to set to.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/utils/DebugLog.html b/javadoc/latest/com/onarandombox/MultiverseCore/utils/DebugLog.html new file mode 100644 index 000000000..0dab37048 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/utils/DebugLog.html @@ -0,0 +1,429 @@ + + + + + +DebugLog (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.utils
+

Class DebugLog

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • java.util.logging.Logger
      • +
    • +
        +
      • com.onarandombox.MultiverseCore.utils.DebugLog
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    @Deprecated
+public class DebugLog
+extends java.util.logging.Logger
    +
    Deprecated. +
    Deprecated in favor of new Logging lib. See Logging.
    +
    +
    The Multiverse debug-logger.
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class java.util.logging.Logger

        +global, GLOBAL_LOGGER_NAME
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      DebugLog​(java.lang.String logger, + java.lang.String file) +
      Deprecated.
      +
      Creates a new debug logger.
      +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and TypeMethodDescription
      voidclose() +
      Deprecated.
      +
      Closes this DebugLog.
      +
      voidlog​(java.util.logging.Level level, + java.lang.String msg) +
      Deprecated.
      +
      Log a message at a certain level.
      +
      voidsetStandardLogger​(java.util.logging.Logger logger) +
      Deprecated.
      +
      Specifies the logger to use to send debug messages to as the debug logger itself only sends messages to a file.
      +
      voidsetTag​(java.lang.String tag) +
      Deprecated.
      +
      Sets the log-tag.
      +
      +
        +
      • + + +

        Methods inherited from class java.util.logging.Logger

        +addHandler, config, config, entering, entering, entering, exiting, exiting, fine, fine, finer, finer, finest, finest, getAnonymousLogger, getAnonymousLogger, getFilter, getGlobal, getHandlers, getLevel, getLogger, getLogger, getName, getParent, getResourceBundle, getResourceBundleName, getUseParentHandlers, info, info, isLoggable, log, log, log, log, log, log, logp, logp, logp, logp, logp, logp, logrb, logrb, logrb, logrb, logrb, logrb, logrb, logrb, removeHandler, setFilter, setLevel, setParent, setResourceBundle, setUseParentHandlers, severe, severe, throwing, warning, warning
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        DebugLog

        +
        public DebugLog​(java.lang.String logger,
+                java.lang.String file)
        +
        Deprecated.
        +
        Creates a new debug logger.
        +
        +
        Parameters:
        +
        logger - The name of the logger.
        +
        file - The file to log to.
        +
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setTag

        +
        public void setTag​(java.lang.String tag)
        +
        Deprecated.
        +
        Sets the log-tag.
        +
        +
        Parameters:
        +
        tag - The new tag.
        +
        +
        • +
      + + + +
        +
      • +

        setStandardLogger

        +
        public void setStandardLogger​(java.util.logging.Logger logger)
        +
        Deprecated.
        +
        Specifies the logger to use to send debug messages to as the debug logger itself only sends messages to a file.
        +
        +
        Parameters:
        +
        logger - Logger to send debug messages to.
        +
        +
        • +
      + + + +
        +
      • +

        log

        +
        public void log​(java.util.logging.Level level,
+                java.lang.String msg)
        +
        Deprecated.
        +
        Log a message at a certain level.
        +
        +
        Overrides:
        +
        log in class java.util.logging.Logger
        +
        Parameters:
        +
        level - The log-Level.
        +
        msg - the message.
        +
        +
        • +
      + + + +
        +
      • +

        close

        +
        public void close()
        +
        Deprecated.
        +
        Closes this DebugLog.
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/utils/FancyColorScheme.html b/javadoc/latest/com/onarandombox/MultiverseCore/utils/FancyColorScheme.html new file mode 100644 index 000000000..505040e8a --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/utils/FancyColorScheme.html @@ -0,0 +1,404 @@ + + + + + +FancyColorScheme (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.utils
+

Class FancyColorScheme

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.utils.FancyColorScheme
      • +
    +
    • +
+
+
    +
  • +
    +
    public class FancyColorScheme
+extends java.lang.Object
    +
    A color-scheme.
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      FancyColorScheme​(org.bukkit.ChatColor header, + org.bukkit.ChatColor main, + org.bukkit.ChatColor alt, + org.bukkit.ChatColor defaultColor) 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      org.bukkit.ChatColorgetAlt() +
      Gets the alt ChatColor.
      +
      org.bukkit.ChatColorgetDefault() +
      Gets the default ChatColor.
      +
      org.bukkit.ChatColorgetHeader() +
      Gets the header's ChatColor.
      +
      org.bukkit.ChatColorgetMain() +
      Gets the main ChatColor.
      +
      org.bukkit.ChatColorgetMain​(boolean main) +
      Gets either the main or the alt ChatColor.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        FancyColorScheme

        +
        public FancyColorScheme​(org.bukkit.ChatColor header,
+                        org.bukkit.ChatColor main,
+                        org.bukkit.ChatColor alt,
+                        org.bukkit.ChatColor defaultColor)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getHeader

        +
        public org.bukkit.ChatColor getHeader()
        +
        Gets the header's ChatColor.
        +
        +
        Returns:
        +
        The header's ChatColor.
        +
        +
        • +
      + + + +
        +
      • +

        getMain

        +
        public org.bukkit.ChatColor getMain()
        +
        Gets the main ChatColor.
        +
        +
        Returns:
        +
        The main ChatColor.
        +
        +
        • +
      + + + +
        +
      • +

        getAlt

        +
        public org.bukkit.ChatColor getAlt()
        +
        Gets the alt ChatColor.
        +
        +
        Returns:
        +
        The alt ChatColor.
        +
        +
        • +
      + + + +
        +
      • +

        getDefault

        +
        public org.bukkit.ChatColor getDefault()
        +
        Gets the default ChatColor.
        +
        +
        Returns:
        +
        The default ChatColor.
        +
        +
        • +
      + + + +
        +
      • +

        getMain

        +
        public org.bukkit.ChatColor getMain​(boolean main)
        +
        Gets either the main or the alt ChatColor.
        +
        +
        Parameters:
        +
        main - True if the main-color is desired, false to get the alt color.
        +
        Returns:
        +
        The desired ChatColor.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/utils/FancyHeader.html b/javadoc/latest/com/onarandombox/MultiverseCore/utils/FancyHeader.html new file mode 100644 index 000000000..6f6e7d0c0 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/utils/FancyHeader.html @@ -0,0 +1,343 @@ + + + + + +FancyHeader (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.utils
+

Class FancyHeader

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.utils.FancyHeader
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    FancyText
    +
    +
    +
    public class FancyHeader
+extends java.lang.Object
+implements FancyText
    +
    A colored text-header.
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      FancyHeader​(java.lang.String text, + FancyColorScheme scheme) 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      voidappendText​(java.lang.String string) +
      Appends text to this FancyHeader.
      +
      java.lang.StringgetFancyText() +
      Gets the String-representation of this FancyText.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        FancyHeader

        +
        public FancyHeader​(java.lang.String text,
+                   FancyColorScheme scheme)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getFancyText

        +
        public java.lang.String getFancyText()
        +
        Description copied from interface: FancyText
        +
        Gets the String-representation of this FancyText.
        +
        +
        Specified by:
        +
        getFancyText in interface FancyText
        +
        Returns:
        +
        The String-representation of this FancyText.
        +
        +
        • +
      + + + +
        +
      • +

        appendText

        +
        public void appendText​(java.lang.String string)
        +
        Appends text to this FancyHeader.
        +
        +
        Parameters:
        +
        string - The text to append.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/utils/FancyMessage.html b/javadoc/latest/com/onarandombox/MultiverseCore/utils/FancyMessage.html new file mode 100644 index 000000000..15ea2ea6b --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/utils/FancyMessage.html @@ -0,0 +1,410 @@ + + + + + +FancyMessage (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.utils
+

Class FancyMessage

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.utils.FancyMessage
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    FancyText
    +
    +
    +
    public class FancyMessage
+extends java.lang.Object
+implements FancyText
    +
    A colored text-message.
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      FancyMessage​(java.lang.String title, + java.lang.String message, + FancyColorScheme scheme) +
      Allows easy creation of an alternating colored list.
      +
      +
      • +
    +
    + +
    + +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FancyMessage

        +
        public FancyMessage​(java.lang.String title,
+                    java.lang.String message,
+                    FancyColorScheme scheme)
        +
        Allows easy creation of an alternating colored list. + TODO: Documentation! Why does CheckStyle just ignore this?
        +
        +
        Parameters:
        +
        title - The title.
        +
        message - The body of the message.
        +
        scheme - The color scheme to use for easy styling.
        +
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setColorMain

        +
        public void setColorMain()
        +
        Makes this FancyMessage use the main-color.
        +
        • +
      + + + +
        +
      • +

        setColorAlt

        +
        public void setColorAlt()
        +
        Makes this FancyMessage use the alt-color.
        +
        • +
      + + + +
        +
      • +

        getFancyText

        +
        public java.lang.String getFancyText()
        +
        Description copied from interface: FancyText
        +
        Gets the String-representation of this FancyText.
        +
        +
        Specified by:
        +
        getFancyText in interface FancyText
        +
        Returns:
        +
        The String-representation of this FancyText.
        +
        +
        • +
      + + + +
        +
      • +

        setAltColor

        +
        public void setAltColor​(boolean altColor)
        +
        Specifies whether this FancyMessage should use the alt-color.
        +
        +
        Parameters:
        +
        altColor - Whether this FancyMessage should use the alt-color.
        +
        +
        • +
      + + + +
        +
      • +

        setMainColor

        +
        public void setMainColor​(boolean mainColor)
        +
        Specifies whether this FancyMessage should use the main-color.
        +
        +
        Parameters:
        +
        mainColor - Whether this FancyMessage should use the main-color.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/utils/FileUtils.html b/javadoc/latest/com/onarandombox/MultiverseCore/utils/FileUtils.html new file mode 100644 index 000000000..e4eb60b08 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/utils/FileUtils.html @@ -0,0 +1,394 @@ + + + + + +FileUtils (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.utils
+

Class FileUtils

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.utils.FileUtils
      • +
    +
    • +
+
+
    +
  • +
    +
    public class FileUtils
+extends java.lang.Object
    +
    File-utilities.
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + +
      Constructors 
      ModifierConstructorDescription
      protected FileUtils() 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethodDescription
      static booleancopyFolder​(java.io.File source, + java.io.File target) +
      Helper method to copy the world-folder.
      +
      static booleancopyFolder​(java.io.File source, + java.io.File target, + java.util.List<java.lang.String> excludeFiles) +
      Helper method to copy the world-folder.
      +
      static booleandeleteFolder​(java.io.File file) +
      Used to delete a folder.
      +
      static booleandeleteFolderContents​(java.io.File file) +
      Used to delete the contents of a folder, without deleting the folder itself.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        FileUtils

        +
        protected FileUtils()
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        deleteFolder

        +
        public static boolean deleteFolder​(java.io.File file)
        +
        Used to delete a folder.
        +
        +
        Parameters:
        +
        file - The folder to delete.
        +
        Returns:
        +
        true if the folder was successfully deleted.
        +
        +
        • +
      + + + +
        +
      • +

        deleteFolderContents

        +
        public static boolean deleteFolderContents​(java.io.File file)
        +
        Used to delete the contents of a folder, without deleting the folder itself.
        +
        +
        Parameters:
        +
        file - The folder whose contents to delete.
        +
        Returns:
        +
        true if the contents were successfully deleted
        +
        +
        • +
      + + + +
        +
      • +

        copyFolder

        +
        public static boolean copyFolder​(java.io.File source,
+                                 java.io.File target)
        +
        Helper method to copy the world-folder.
        +
        +
        Parameters:
        +
        source - Source-File
        +
        target - Target-File
        +
        Returns:
        +
        true if it had success
        +
        +
        • +
      + + + +
        +
      • +

        copyFolder

        +
        public static boolean copyFolder​(java.io.File source,
+                                 java.io.File target,
+                                 java.util.List<java.lang.String> excludeFiles)
        +
        Helper method to copy the world-folder.
        +
        +
        Parameters:
        +
        source - Source-File
        +
        target - Target-File
        +
        excludeFiles - files to ignore and not copy over to Target-File
        +
        Returns:
        +
        true if it had success
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/utils/LocationManipulation.html b/javadoc/latest/com/onarandombox/MultiverseCore/utils/LocationManipulation.html new file mode 100644 index 000000000..04f50e2a1 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/utils/LocationManipulation.html @@ -0,0 +1,516 @@ + + + + + +LocationManipulation (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.utils
+

Class LocationManipulation

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.utils.LocationManipulation
      • +
    +
    • +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods Deprecated Methods 
      Modifier and TypeMethodDescription
      static org.bukkit.LocationgetBlockLocation​(org.bukkit.Location l) +
      Deprecated.
      +
      This method simply does some rounding, rather than forcing a call to the server to get the blockdata.
      +
      static java.lang.StringgetDirection​(org.bukkit.Location location) +
      Deprecated.
      +
      Return the NESW Direction a Location is facing.
      +
      static org.bukkit.LocationgetNextBlock​(org.bukkit.entity.Vehicle v) +
      Deprecated.
      +
      Returns the next Location that a Vehicle is traveling at.
      +
      static floatgetSpeed​(org.bukkit.util.Vector v) +
      Deprecated.
      +
      Returns a speed float from a given vector.
      +
      static org.bukkit.util.VectorgetTranslatedVector​(org.bukkit.util.Vector v, + java.lang.String direction) +
      Deprecated.
      +
      Returns a translated vector from the given direction.
      +
      static floatgetYaw​(java.lang.String orientation) +
      Deprecated.
      +
      Returns the float yaw position for the given cardinal direction.
      +
      static java.lang.StringlocationToString​(org.bukkit.Location location) +
      Deprecated.
      +
      Convert a Location into a Colon separated string to allow us to store it in text.
      +
      static java.lang.StringstrCoords​(org.bukkit.Location l) +
      Deprecated.
      +
      Returns a colored string with the coords.
      +
      static java.lang.StringstrCoordsRaw​(org.bukkit.Location l) +
      Deprecated.
      +
      Converts a location to a printable readable formatted string including pitch/yaw.
      +
      static org.bukkit.LocationstringToLocation​(java.lang.String locationString) +
      Deprecated.
      +
      Returns a new location from a given string.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        locationToString

        +
        public static java.lang.String locationToString​(org.bukkit.Location location)
        +
        Deprecated.
        +
        Convert a Location into a Colon separated string to allow us to store it in text. +

        + WORLD:X,Y,Z:yaw:pitch +

        + The corresponding String2Loc function is stringToLocation(java.lang.String)

        +
        +
        Parameters:
        +
        location - The Location to save.
        +
        Returns:
        +
        The location as a string in this format: WORLD:x,y,z:yaw:pitch
        +
        +
        • +
      + + + +
        +
      • +

        getBlockLocation

        +
        public static org.bukkit.Location getBlockLocation​(org.bukkit.Location l)
        +
        Deprecated.
        +
        This method simply does some rounding, rather than forcing a call to the server to get the blockdata.
        +
        +
        Parameters:
        +
        l - The location to round to the block location
        +
        Returns:
        +
        A rounded location.
        +
        +
        • +
      + + + +
        +
      • +

        stringToLocation

        +
        public static org.bukkit.Location stringToLocation​(java.lang.String locationString)
        +
        Deprecated.
        +
        Returns a new location from a given string. The format is as follows: +

        + WORLD:X,Y,Z:yaw:pitch +

        + The corresponding Location2String function is stringToLocation(java.lang.String)

        +
        +
        Parameters:
        +
        locationString - The location represented as a string (WORLD:X,Y,Z:yaw:pitch)
        +
        Returns:
        +
        A new location defined by the string or null if the string was invalid.
        +
        +
        • +
      + + + +
        +
      • +

        strCoords

        +
        public static java.lang.String strCoords​(org.bukkit.Location l)
        +
        Deprecated.
        +
        Returns a colored string with the coords.
        +
        +
        Parameters:
        +
        l - The Location
        +
        Returns:
        +
        The String
        +
        +
        • +
      + + + +
        +
      • +

        strCoordsRaw

        +
        public static java.lang.String strCoordsRaw​(org.bukkit.Location l)
        +
        Deprecated.
        +
        Converts a location to a printable readable formatted string including pitch/yaw.
        +
        +
        Parameters:
        +
        l - The Location
        +
        Returns:
        +
        The String
        +
        +
        • +
      + + + +
        +
      • +

        getDirection

        +
        public static java.lang.String getDirection​(org.bukkit.Location location)
        +
        Deprecated.
        +
        Return the NESW Direction a Location is facing.
        +
        +
        Parameters:
        +
        location - The Location
        +
        Returns:
        +
        The NESW Direction
        +
        +
        • +
      + + + +
        +
      • +

        getYaw

        +
        public static float getYaw​(java.lang.String orientation)
        +
        Deprecated.
        +
        Returns the float yaw position for the given cardinal direction.
        +
        +
        Parameters:
        +
        orientation - The cardinal direction
        +
        Returns:
        +
        The yaw
        +
        +
        • +
      + + + +
        +
      • +

        getSpeed

        +
        public static float getSpeed​(org.bukkit.util.Vector v)
        +
        Deprecated.
        +
        Returns a speed float from a given vector.
        +
        +
        Parameters:
        +
        v - The Vector
        +
        Returns:
        +
        The speed
        +
        +
        • +
      + + + +
        +
      • +

        getTranslatedVector

        +
        public static org.bukkit.util.Vector getTranslatedVector​(org.bukkit.util.Vector v,
+                                                         java.lang.String direction)
        +
        Deprecated.
        +
        Returns a translated vector from the given direction.
        +
        +
        Parameters:
        +
        v - The old Vector
        +
        direction - The new direction
        +
        Returns:
        +
        The translated Vector
        +
        +
        • +
      + + + +
        +
      • +

        getNextBlock

        +
        public static org.bukkit.Location getNextBlock​(org.bukkit.entity.Vehicle v)
        +
        Deprecated.
        +
        Returns the next Location that a Vehicle is traveling at.
        +
        +
        Parameters:
        +
        v - The Vehicle
        +
        Returns:
        +
        The Location
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/utils/MVEconomist.html b/javadoc/latest/com/onarandombox/MultiverseCore/utils/MVEconomist.html new file mode 100644 index 000000000..3f916f843 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/utils/MVEconomist.html @@ -0,0 +1,639 @@ + + + + + +MVEconomist (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.utils
+

Class MVEconomist

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.utils.MVEconomist
      • +
    +
    • +
+
+
    +
  • +
    +
    public class MVEconomist
+extends java.lang.Object
    +
    Multiverse's Friendly Economist. This is used to deal with external economies and also item costs for stuff in MV.
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      MVEconomist​(org.bukkit.plugin.Plugin plugin) 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and TypeMethodDescription
      voiddeposit​(org.bukkit.entity.Player player, + double amount, + @Nullable org.bukkit.Material currency) +
      Deposits a given amount of currency either into the player's economy account or inventory if the currency + is not null.
      +
      java.lang.StringformatPrice​(double amount, + @Nullable org.bukkit.Material currency) +
      Formats the amount to a human readable currency string.
      +
      doublegetBalance​(org.bukkit.entity.Player player) +
      Returns the economy balance of the given player.
      +
      doublegetBalance​(org.bukkit.entity.Player player, + org.bukkit.World world) +
      Returns the economy balance of the given player in the given world.
      +
      java.lang.StringgetEconomyName() +
      Returns the name of the economy in use.
      +
      java.lang.StringgetNSFMessage​(org.bukkit.Material currency, + java.lang.String message) +
      Formats a message for a player indicating they don't have enough currency.
      +
      VaultHandlergetVaultHandler() +
      Deprecated. +
      just use the other methods in this class for economy stuff.
      +
      +
      static booleanisItemCurrency​(org.bukkit.Material currency) +
      Determines if the currency type string given represents an item currency.
      +
      booleanisPlayerWealthyEnough​(org.bukkit.entity.Player player, + double amount, + org.bukkit.Material currency) +
      Determines if a player has enough of a given currency.
      +
      booleanisUsingEconomyPlugin() +
      Checks if an economy plugin is in use.
      +
      voidsetBalance​(org.bukkit.entity.Player player, + double amount) +
      Sets the economy balance for the given player.
      +
      voidsetBalance​(org.bukkit.entity.Player player, + org.bukkit.World world, + double amount) +
      Sets the economy balance for the given player in the given world.
      +
      voidwithdraw​(org.bukkit.entity.Player player, + double amount, + @Nullable org.bukkit.Material currency) +
      Withdraws a given amount of currency either from the player's economy account or inventory if the currency + is not null.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        MVEconomist

        +
        public MVEconomist​(org.bukkit.plugin.Plugin plugin)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        isUsingEconomyPlugin

        +
        public boolean isUsingEconomyPlugin()
        +
        Checks if an economy plugin is in use.
        +
        +
        Returns:
        +
        true if an economy plugin is detected by Vault.
        +
        +
        • +
      + + + +
        +
      • +

        formatPrice

        +
        public java.lang.String formatPrice​(double amount,
+                                    @Nullable
+                                    @Nullable org.bukkit.Material currency)
        +
        Formats the amount to a human readable currency string.
        +
        +
        Parameters:
        +
        amount - the amount of currency.
        +
        currency - the type of currency. Null indicates a non-item currency is used.
        +
        Returns:
        +
        the human readable currency string.
        +
        +
        • +
      + + + +
        +
      • +

        getEconomyName

        +
        public java.lang.String getEconomyName()
        +
        Returns the name of the economy in use.
        +
        +
        Returns:
        +
        the name of the economy in use.
        +
        +
        • +
      + + + +
        +
      • +

        isPlayerWealthyEnough

        +
        public boolean isPlayerWealthyEnough​(org.bukkit.entity.Player player,
+                                     double amount,
+                                     org.bukkit.Material currency)
        +
        Determines if a player has enough of a given currency.
        +
        +
        Parameters:
        +
        player - the player to check for currency.
        +
        amount - the amount of currency.
        +
        currency - the type of currency. Null indicates non-item currency is used.
        +
        Returns:
        +
        true if the player has enough of the given currency or the amount is 0 or less.
        +
        +
        • +
      + + + +
        +
      • +

        getNSFMessage

        +
        public java.lang.String getNSFMessage​(org.bukkit.Material currency,
+                                      java.lang.String message)
        +
        Formats a message for a player indicating they don't have enough currency.
        +
        +
        Parameters:
        +
        currency - the type of currency. Null indicates a non-item currency is used.
        +
        message - The more specific message to append to the generic message of not having enough.
        +
        Returns:
        +
        the formatted insufficient funds message.
        +
        +
        • +
      + + + +
        +
      • +

        deposit

        +
        public void deposit​(org.bukkit.entity.Player player,
+                    double amount,
+                    @Nullable
+                    @Nullable org.bukkit.Material currency)
        +
        Deposits a given amount of currency either into the player's economy account or inventory if the currency + is not null.
        +
        +
        Parameters:
        +
        player - the player to give currency to.
        +
        amount - the amount to give.
        +
        currency - the type of currency.
        +
        +
        • +
      + + + +
        +
      • +

        withdraw

        +
        public void withdraw​(org.bukkit.entity.Player player,
+                     double amount,
+                     @Nullable
+                     @Nullable org.bukkit.Material currency)
        +
        Withdraws a given amount of currency either from the player's economy account or inventory if the currency + is not null.
        +
        +
        Parameters:
        +
        player - the player to take currency from.
        +
        amount - the amount to take.
        +
        currency - the type of currency.
        +
        +
        • +
      + + + +
        +
      • +

        getBalance

        +
        public double getBalance​(org.bukkit.entity.Player player)
+                  throws java.lang.IllegalStateException
        +
        Returns the economy balance of the given player.
        +
        +
        Parameters:
        +
        player - the player to get the balance for.
        +
        Returns:
        +
        the economy balance of the given player.
        +
        Throws:
        +
        java.lang.IllegalStateException - thrown if this is used when no economy plugin is available.
        +
        +
        • +
      + + + +
        +
      • +

        getBalance

        +
        public double getBalance​(org.bukkit.entity.Player player,
+                         org.bukkit.World world)
+                  throws java.lang.IllegalStateException
        +
        Returns the economy balance of the given player in the given world. If the economy plugin does not have world + specific balances then the global balance will be returned.
        +
        +
        Parameters:
        +
        player - the player to get the balance for.
        +
        world - the world to get the balance for.
        +
        Returns:
        +
        the economy balance of the given player in the given world.
        +
        Throws:
        +
        java.lang.IllegalStateException - thrown if this is used when no economy plugin is available.
        +
        +
        • +
      + + + +
        +
      • +

        setBalance

        +
        public void setBalance​(org.bukkit.entity.Player player,
+                       double amount)
+                throws java.lang.IllegalStateException
        +
        Sets the economy balance for the given player.
        +
        +
        Parameters:
        +
        player - the player to set the balance for.
        +
        amount - the amount to set the player's balance to.
        +
        Throws:
        +
        java.lang.IllegalStateException - thrown if this is used when no economy plugin is available.
        +
        +
        • +
      + + + +
        +
      • +

        setBalance

        +
        public void setBalance​(org.bukkit.entity.Player player,
+                       org.bukkit.World world,
+                       double amount)
+                throws java.lang.IllegalStateException
        +
        Sets the economy balance for the given player in the given world. If the economy plugin does not have world + specific balances then the global balance will be set.
        +
        +
        Parameters:
        +
        player - the player to set the balance for.
        +
        world - the world to get the balance for.
        +
        amount - the amount to set the player's balance to.
        +
        Throws:
        +
        java.lang.IllegalStateException - thrown if this is used when no economy plugin is available.
        +
        +
        • +
      + + + +
        +
      • +

        getVaultHandler

        +
        @Deprecated
+public VaultHandler getVaultHandler()
        +
        Deprecated. +
        just use the other methods in this class for economy stuff.
        +
        +
        This method is public for backwards compatibility.
        +
        +
        Returns:
        +
        the old VaultHandler.
        +
        +
        • +
      + + + +
        +
      • +

        isItemCurrency

        +
        public static boolean isItemCurrency​(org.bukkit.Material currency)
        +
        Determines if the currency type string given represents an item currency.
        +
        +
        Parameters:
        +
        currency - the type of currency.
        +
        Returns:
        +
        true if currency string matches a valid material.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/utils/MVMessaging.html b/javadoc/latest/com/onarandombox/MultiverseCore/utils/MVMessaging.html new file mode 100644 index 000000000..df2ff6e01 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/utils/MVMessaging.html @@ -0,0 +1,439 @@ + + + + + +MVMessaging (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.utils
+

Class MVMessaging

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.utils.MVMessaging
      • +
    +
    • +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      MVMessaging() 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      intgetCooldown() +
      Gets the message-cooldown.
      +
      booleansendMessage​(org.bukkit.command.CommandSender sender, + java.lang.String message, + boolean ignoreCooldown) +
      Sends a message to the specified sender if the cooldown has passed.
      +
      booleansendMessages​(org.bukkit.command.CommandSender sender, + java.lang.String[] messages, + boolean ignoreCooldown) +
      Sends a group of messages to the specified sender if the cooldown has passed.
      +
      booleansendMessages​(org.bukkit.command.CommandSender sender, + java.util.Collection<java.lang.String> messages, + boolean ignoreCooldown) +
      Sends a group of messages to the specified sender if the cooldown has passed.
      +
      voidsetCooldown​(int milliseconds) +
      Sets the message-cooldown.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        MVMessaging

        +
        public MVMessaging()
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setCooldown

        +
        public void setCooldown​(int milliseconds)
        +
        Sets the message-cooldown.
        +
        +
        Specified by:
        +
        setCooldown in interface MultiverseMessaging
        +
        Parameters:
        +
        milliseconds - The new message-cooldown in milliseconds.
        +
        +
        • +
      + + + +
        +
      • +

        sendMessage

        +
        public boolean sendMessage​(org.bukkit.command.CommandSender sender,
+                           java.lang.String message,
+                           boolean ignoreCooldown)
        +
        Sends a message to the specified sender if the cooldown has passed.
        +
        +
        Specified by:
        +
        sendMessage in interface MultiverseMessaging
        +
        Parameters:
        +
        sender - The person/console to send the message to.
        +
        message - The message to send.
        +
        ignoreCooldown - If true this message will always be sent. Useful for things like menus
        +
        Returns:
        +
        true if the message was sent, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        sendMessages

        +
        public boolean sendMessages​(org.bukkit.command.CommandSender sender,
+                            java.lang.String[] messages,
+                            boolean ignoreCooldown)
        +
        Sends a group of messages to the specified sender if the cooldown has passed. + This method is needed, since sending many messages in quick succession would violate + the cooldown.
        +
        +
        Specified by:
        +
        sendMessages in interface MultiverseMessaging
        +
        Parameters:
        +
        sender - The person/console to send the message to.
        +
        messages - The messages to send.
        +
        ignoreCooldown - If true these messages will always be sent. Useful for things like menus
        +
        Returns:
        +
        true if the message was sent, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        sendMessages

        +
        public boolean sendMessages​(org.bukkit.command.CommandSender sender,
+                            java.util.Collection<java.lang.String> messages,
+                            boolean ignoreCooldown)
        +
        Sends a group of messages to the specified sender if the cooldown has passed. + This method is needed, since sending many messages in quick succession would violate + the cooldown.
        +
        +
        Specified by:
        +
        sendMessages in interface MultiverseMessaging
        +
        Parameters:
        +
        sender - The person/console to send the message to.
        +
        messages - The messages to send.
        +
        ignoreCooldown - If true these messages will always be sent. Useful for things like menus
        +
        Returns:
        +
        true if the message was sent, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        getCooldown

        +
        public int getCooldown()
        +
        Gets the message-cooldown.
        +
        +
        Specified by:
        +
        getCooldown in interface MultiverseMessaging
        +
        Returns:
        +
        The message-cooldown.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/utils/MVPermissions.html b/javadoc/latest/com/onarandombox/MultiverseCore/utils/MVPermissions.html new file mode 100644 index 000000000..7fe32e68d --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/utils/MVPermissions.html @@ -0,0 +1,575 @@ + + + + + +MVPermissions (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.utils
+

Class MVPermissions

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.utils.MVPermissions
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    com.pneumaticraft.commandhandler.PermissionsInterface
    +
    +
    +
    public class MVPermissions
+extends java.lang.Object
+implements com.pneumaticraft.commandhandler.PermissionsInterface
    +
    Multiverse's PermissionsInterface.
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      org.bukkit.permissions.PermissionaddPermission​(java.lang.String string, + org.bukkit.permissions.PermissionDefault defaultValue) +
      Adds a permission.
      +
      booleancanEnterDestination​(org.bukkit.command.CommandSender sender, + MVDestination d) +
      Check to see if a sender can enter a destination.
      +
      booleancanEnterWorld​(org.bukkit.entity.Player p, + MultiverseWorld w) +
      Check if the Player has the permissions to enter this world.
      +
      booleancanIgnoreGameModeRestriction​(org.bukkit.entity.Player p, + MultiverseWorld w) +
      Check if a Player can ignore GameMode restrictions for world they travel to.
      +
      booleancanTravelFromLocation​(org.bukkit.command.CommandSender sender, + org.bukkit.Location location) +
      Checks if the specified CommandSender can travel to the specified Location.
      +
      booleancanTravelFromWorld​(org.bukkit.entity.Player p, + MultiverseWorld w) +
      Check if a Player can teleport to the Destination world from there current world.
      +
      java.lang.StringgetType() +
      Gets the type of this PermissionsInterface.
      +
      booleanhasAllPermission​(org.bukkit.command.CommandSender sender, + java.util.List<java.lang.String> nodes, + boolean isOpRequired)
      booleanhasAnyPermission​(org.bukkit.command.CommandSender sender, + java.util.List<java.lang.String> nodes, + boolean isOpRequired)
      booleanhasPermission​(org.bukkit.command.CommandSender sender, + java.lang.String node, + boolean isOpRequired) +
      Check to see if a player has a permission.
      +
      voidtellMeWhyICantDoThis​(org.bukkit.command.CommandSender asker, + org.bukkit.command.CommandSender playerInQuestion, + MVDestination d) +
      Tells a CommandSender why another CommandSender can or can not access a certain MVDestination.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        canIgnoreGameModeRestriction

        +
        public boolean canIgnoreGameModeRestriction​(org.bukkit.entity.Player p,
+                                            MultiverseWorld w)
        +
        Check if a Player can ignore GameMode restrictions for world they travel to.
        +
        +
        Parameters:
        +
        p - The Player to check.
        +
        w - The MultiverseWorld the player wants to teleport to.
        +
        Returns:
        +
        True if they should bypass restrictions.
        +
        +
        • +
      + + + +
        +
      • +

        canTravelFromWorld

        +
        public boolean canTravelFromWorld​(org.bukkit.entity.Player p,
+                                  MultiverseWorld w)
        +
        Check if a Player can teleport to the Destination world from there current world.
        +
        +
        Parameters:
        +
        p - The Player to check.
        +
        w - The MultiverseWorld the player wants to teleport to.
        +
        Returns:
        +
        Whether the player can teleport to the given MultiverseWorld.
        +
        +
        • +
      + + + +
        +
      • +

        canTravelFromLocation

        +
        public boolean canTravelFromLocation​(org.bukkit.command.CommandSender sender,
+                                     org.bukkit.Location location)
        +
        Checks if the specified CommandSender can travel to the specified Location.
        +
        +
        Parameters:
        +
        sender - The CommandSender.
        +
        location - The Location.
        +
        Returns:
        +
        Whether the CommandSender can travel to the specified Location.
        +
        +
        • +
      + + + +
        +
      • +

        canEnterWorld

        +
        public boolean canEnterWorld​(org.bukkit.entity.Player p,
+                             MultiverseWorld w)
        +
        Check if the Player has the permissions to enter this world.
        +
        +
        Parameters:
        +
        p - The Player player that wants to enter
        +
        w - The MultiverseWorld he wants to enter
        +
        Returns:
        +
        Whether he has the permission to enter the world
        +
        +
        • +
      + + + +
        +
      • +

        canEnterDestination

        +
        public boolean canEnterDestination​(org.bukkit.command.CommandSender sender,
+                                   MVDestination d)
        +
        Check to see if a sender can enter a destination. + The reason this is not a player, is it can be used to simply check permissions + The console should, for exmaple, always see all worlds
        +
        +
        Parameters:
        +
        sender - The CommandSender to check.
        +
        d - The destination they are requesting.
        +
        Returns:
        +
        True if that sender can go to that destination
        +
        +
        • +
      + + + +
        +
      • +

        tellMeWhyICantDoThis

        +
        public void tellMeWhyICantDoThis​(org.bukkit.command.CommandSender asker,
+                                 org.bukkit.command.CommandSender playerInQuestion,
+                                 MVDestination d)
        +
        Tells a CommandSender why another CommandSender can or can not access a certain MVDestination.
        +
        +
        Parameters:
        +
        asker - The CommandSender that's asking.
        +
        playerInQuestion - The CommandSender whose permissions we want to know.
        +
        d - The MVDestination.
        +
        +
        • +
      + + + +
        +
      • +

        hasPermission

        +
        public boolean hasPermission​(org.bukkit.command.CommandSender sender,
+                             java.lang.String node,
+                             boolean isOpRequired)
        +
        Check to see if a player has a permission.
        +
        +
        Specified by:
        +
        hasPermission in interface com.pneumaticraft.commandhandler.PermissionsInterface
        +
        Parameters:
        +
        sender - Who is requesting the permission.
        +
        node - The permission node in string format; multiverse.core.list.worlds for example.
        +
        isOpRequired - deprecated This is not used for anything anymore.
        +
        Returns:
        +
        True if they have that permission or any parent.
        +
        +
        • +
      + + + +
        +
      • +

        getType

        +
        public java.lang.String getType()
        +
        Gets the type of this PermissionsInterface.
        +
        +
        Returns:
        +
        The type of this PermissionsInterface.
        +
        +
        • +
      + + + +
        +
      • +

        hasAnyPermission

        +
        public boolean hasAnyPermission​(org.bukkit.command.CommandSender sender,
+                                java.util.List<java.lang.String> nodes,
+                                boolean isOpRequired)
        +
        +
        Specified by:
        +
        hasAnyPermission in interface com.pneumaticraft.commandhandler.PermissionsInterface
        +
        +
        • +
      + + + +
        +
      • +

        hasAllPermission

        +
        public boolean hasAllPermission​(org.bukkit.command.CommandSender sender,
+                                java.util.List<java.lang.String> nodes,
+                                boolean isOpRequired)
        +
        +
        Specified by:
        +
        hasAllPermission in interface com.pneumaticraft.commandhandler.PermissionsInterface
        +
        +
        • +
      + + + +
        +
      • +

        addPermission

        +
        public org.bukkit.permissions.Permission addPermission​(java.lang.String string,
+                                                       org.bukkit.permissions.PermissionDefault defaultValue)
        +
        Adds a permission.
        +
        +
        Parameters:
        +
        string - The permission as String.
        +
        defaultValue - The default-value.
        +
        Returns:
        +
        The permission as Permission.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/utils/MVPlayerSession.html b/javadoc/latest/com/onarandombox/MultiverseCore/utils/MVPlayerSession.html new file mode 100644 index 000000000..bc7bc46df --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/utils/MVPlayerSession.html @@ -0,0 +1,331 @@ + + + + + +MVPlayerSession (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.utils
+

Class MVPlayerSession

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.utils.MVPlayerSession
      • +
    +
    • +
+
+
    +
  • +
    +
    public class MVPlayerSession
+extends java.lang.Object
    +
    A player-session.
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      booleangetTeleportable() +
      Grab whether the cooldown on Portal use has expired or not.
      +
      voidteleport() +
      Update the Teleport time.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        MVPlayerSession

        +
        public MVPlayerSession​(org.bukkit.entity.Player player,
+                       MultiverseCoreConfig config)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        teleport

        +
        public void teleport()
        +
        Update the Teleport time.
        +
        • +
      + + + +
        +
      • +

        getTeleportable

        +
        public boolean getTeleportable()
        +
        Grab whether the cooldown on Portal use has expired or not.
        +
        +
        Returns:
        +
        True if the Player associated with this player-session is teleportable.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/utils/MVTravelAgent.html b/javadoc/latest/com/onarandombox/MultiverseCore/utils/MVTravelAgent.html new file mode 100644 index 000000000..181f1394f --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/utils/MVTravelAgent.html @@ -0,0 +1,341 @@ + + + + + +MVTravelAgent (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.utils
+

Class MVTravelAgent

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.utils.MVTravelAgent
      • +
    +
    • +
+
+
    +
  • +
    +
    public class MVTravelAgent
+extends java.lang.Object
    +
    The Multiverse TravelAgent.
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    + +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/utils/MaterialConverter.html b/javadoc/latest/com/onarandombox/MultiverseCore/utils/MaterialConverter.html new file mode 100644 index 000000000..b98ebe4df --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/utils/MaterialConverter.html @@ -0,0 +1,347 @@ + + + + + +MaterialConverter (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.utils
+

Class MaterialConverter

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.utils.MaterialConverter
      • +
    +
    • +
+
+
    +
  • +
    +
    public class MaterialConverter
+extends java.lang.Object
    +
    A tool for converting values which may be an old type ID to a Material.
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      MaterialConverter() 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethodDescription
      static @Nullable org.bukkit.MaterialconvertConfigType​(@NotNull org.bukkit.configuration.ConfigurationSection config, + @NotNull java.lang.String path) +
      Converts the value in the given config at the given path from a numeric id or flattened material name to a + Material.
      +
      static @Nullable org.bukkit.MaterialconvertTypeString​(@Nullable java.lang.String value) +
      Converts a string representing a numeric id or flattened material name to a Material.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        MaterialConverter

        +
        public MaterialConverter()
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        convertConfigType

        +
        @Nullable
+public static @Nullable org.bukkit.Material convertConfigType​(@NotNull
+                                                              @NotNull org.bukkit.configuration.ConfigurationSection config,
+                                                              @NotNull
+                                                              @NotNull java.lang.String path)
        +
        Converts the value in the given config at the given path from a numeric id or flattened material name to a + Material.
        +
        +
        Parameters:
        +
        config - The config with the value to convert.
        +
        path - The path of the value in the config.
        +
        Returns:
        +
        The converted Material type or null if no matching type.
        +
        +
        • +
      + + + +
        +
      • +

        convertTypeString

        +
        @Nullable
+public static @Nullable org.bukkit.Material convertTypeString​(@Nullable
+                                                              @Nullable java.lang.String value)
        +
        Converts a string representing a numeric id or flattened material name to a Material.
        +
        +
        Parameters:
        +
        value - The value to convert.
        +
        Returns:
        +
        The converted Material type or null if no matching type.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/utils/PermissionTools.html b/javadoc/latest/com/onarandombox/MultiverseCore/utils/PermissionTools.html new file mode 100644 index 000000000..b82e2ff0c --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/utils/PermissionTools.html @@ -0,0 +1,437 @@ + + + + + +PermissionTools (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.utils
+

Class PermissionTools

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.utils.PermissionTools
      • +
    +
    • +
+
+
    +
  • +
    +
    public class PermissionTools
+extends java.lang.Object
    +
    Utility-class for permissions.
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      voidaddToParentPerms​(java.lang.String permString) +
      Adds a permission to the parent-permissions.
      +
      booleanplayerCanBypassPlayerLimit​(MultiverseWorld toWorld, + org.bukkit.command.CommandSender teleporter, + org.bukkit.entity.Player teleportee) +
      Checks to see if a player can bypass the player limit.
      +
      booleanplayerCanGoFromTo​(MultiverseWorld fromWorld, + MultiverseWorld toWorld, + org.bukkit.command.CommandSender teleporter, + org.bukkit.entity.Player teleportee) +
      Checks to see if player can go to a world given their current status.
      +
      booleanplayerCanIgnoreGameModeRestriction​(MultiverseWorld toWorld, + org.bukkit.entity.Player teleportee) +
      Checks to see if a player should bypass game mode restrictions.
      +
      booleanplayerHasMoneyToEnter​(MultiverseWorld fromWorld, + MultiverseWorld toWorld, + org.bukkit.command.CommandSender teleporter, + org.bukkit.entity.Player teleportee, + boolean pay) +
      Checks if the given Player has enough money to enter the specified MultiverseWorld.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        PermissionTools

        +
        public PermissionTools​(MultiverseCore plugin)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        addToParentPerms

        +
        public void addToParentPerms​(java.lang.String permString)
        +
        Adds a permission to the parent-permissions.
        +
        +
        Parameters:
        +
        permString - The new permission as String.
        +
        +
        • +
      + + + +
        +
      • +

        playerHasMoneyToEnter

        +
        public boolean playerHasMoneyToEnter​(MultiverseWorld fromWorld,
+                                     MultiverseWorld toWorld,
+                                     org.bukkit.command.CommandSender teleporter,
+                                     org.bukkit.entity.Player teleportee,
+                                     boolean pay)
        +
        Checks if the given Player has enough money to enter the specified MultiverseWorld.
        +
        +
        Parameters:
        +
        fromWorld - The MultiverseWorld the player is coming from.
        +
        toWorld - The MultiverseWorld the player is going to.
        +
        teleporter - The teleporter.
        +
        teleportee - The teleportee.
        +
        pay - If the player has to pay the money.
        +
        Returns:
        +
        True if the player can enter the world.
        +
        +
        • +
      + + + +
        +
      • +

        playerCanGoFromTo

        +
        public boolean playerCanGoFromTo​(MultiverseWorld fromWorld,
+                                 MultiverseWorld toWorld,
+                                 org.bukkit.command.CommandSender teleporter,
+                                 org.bukkit.entity.Player teleportee)
        +
        Checks to see if player can go to a world given their current status. +

        + The return is a little backwards, and will return a value safe for event.setCancelled.

        +
        +
        Parameters:
        +
        fromWorld - The MultiverseWorld they are in.
        +
        toWorld - The MultiverseWorld they want to go to.
        +
        teleporter - The CommandSender that wants to send someone somewhere. If null, + will be given the same value as teleportee.
        +
        teleportee - The player going somewhere.
        +
        Returns:
        +
        True if they can't go to the world, False if they can.
        +
        +
        • +
      + + + +
        +
      • +

        playerCanBypassPlayerLimit

        +
        public boolean playerCanBypassPlayerLimit​(MultiverseWorld toWorld,
+                                          org.bukkit.command.CommandSender teleporter,
+                                          org.bukkit.entity.Player teleportee)
        +
        Checks to see if a player can bypass the player limit.
        +
        +
        Parameters:
        +
        toWorld - The world travelling to.
        +
        teleporter - The player that initiated the teleport.
        +
        teleportee - The player travelling.
        +
        Returns:
        +
        True if they can bypass the player limit.
        +
        +
        • +
      + + + +
        +
      • +

        playerCanIgnoreGameModeRestriction

        +
        public boolean playerCanIgnoreGameModeRestriction​(MultiverseWorld toWorld,
+                                                  org.bukkit.entity.Player teleportee)
        +
        Checks to see if a player should bypass game mode restrictions.
        +
        +
        Parameters:
        +
        toWorld - world travelling to.
        +
        teleportee - player travelling.
        +
        Returns:
        +
        True if they should bypass restrictions
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/utils/PlayerFinder.html b/javadoc/latest/com/onarandombox/MultiverseCore/utils/PlayerFinder.html new file mode 100644 index 000000000..ba808e579 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/utils/PlayerFinder.html @@ -0,0 +1,484 @@ + + + + + +PlayerFinder (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.utils
+

Class PlayerFinder

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.utils.PlayerFinder
      • +
    +
    • +
+
+
    +
  • +
    +
    public class PlayerFinder
+extends java.lang.Object
    +
    Helper class to get Player from name, UUID or Selectors.
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      PlayerFinder() 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethodDescription
      static @Nullable org.bukkit.entity.Playerget​(@NotNull java.lang.String playerIdentifier, + @NotNull org.bukkit.command.CommandSender sender) +
      Get a Player based on an identifier of name UUID or selector.
      +
      static @Nullable org.bukkit.entity.PlayergetByName​(@NotNull java.lang.String playerName) +
      Get a Player based on player name.
      +
      static @Nullable org.bukkit.entity.PlayergetBySelector​(@NotNull java.lang.String playerSelector, + @NotNull org.bukkit.command.CommandSender sender) +
      Get a Player based on vanilla selectors.
      +
      static @Nullable org.bukkit.entity.PlayergetByUuid​(@NotNull java.lang.String playerUuid) +
      Get a Player based on player UUID.
      +
      static @Nullable org.bukkit.entity.PlayergetByUuid​(@NotNull java.util.UUID playerUuid) +
      Get a Player based on playerUUID.
      +
      static @Nullable java.util.List<org.bukkit.entity.Player>getMulti​(@NotNull java.lang.String playerIdentifiers, + @NotNull org.bukkit.command.CommandSender sender) +
      Get multiple Player based on many identifiers of name UUID or selector.
      +
      static @Nullable java.util.List<org.bukkit.entity.Player>getMultiBySelector​(@NotNull java.lang.String playerSelector, + @NotNull org.bukkit.command.CommandSender sender) +
      Get multiple Player based on selector.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        PlayerFinder

        +
        public PlayerFinder()
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        get

        +
        @Nullable
+public static @Nullable org.bukkit.entity.Player get​(@NotNull
+                                                     @NotNull java.lang.String playerIdentifier,
+                                                     @NotNull
+                                                     @NotNull org.bukkit.command.CommandSender sender)
        +
        Get a Player based on an identifier of name UUID or selector.
        +
        +
        Parameters:
        +
        playerIdentifier - An identifier of name UUID or selector.
        +
        sender - Target sender for selector.
        +
        Returns:
        +
        The player if found, else null.
        +
        +
        • +
      + + + +
        +
      • +

        getMulti

        +
        @Nullable
+public static @Nullable java.util.List<org.bukkit.entity.Player> getMulti​(@NotNull
+                                                                          @NotNull java.lang.String playerIdentifiers,
+                                                                          @NotNull
+                                                                          @NotNull org.bukkit.command.CommandSender sender)
        +
        Get multiple Player based on many identifiers of name UUID or selector.
        +
        +
        Parameters:
        +
        playerIdentifiers - An identifier of multiple names, UUIDs or selectors, separated by comma.
        +
        sender - Target sender for selector.
        +
        Returns:
        +
        A list of all the Player found.
        +
        +
        • +
      + + + +
        +
      • +

        getByName

        +
        @Nullable
+public static @Nullable org.bukkit.entity.Player getByName​(@NotNull
+                                                           @NotNull java.lang.String playerName)
        +
        Get a Player based on player name.
        +
        +
        Parameters:
        +
        playerName - Name of a Player.
        +
        Returns:
        +
        The player if found, else null.
        +
        +
        • +
      + + + +
        +
      • +

        getByUuid

        +
        @Nullable
+public static @Nullable org.bukkit.entity.Player getByUuid​(@NotNull
+                                                           @NotNull java.lang.String playerUuid)
        +
        Get a Player based on player UUID.
        +
        +
        Parameters:
        +
        playerUuid - UUID of a player.
        +
        Returns:
        +
        The player if found, else null.
        +
        +
        • +
      + + + +
        +
      • +

        getByUuid

        +
        @Nullable
+public static @Nullable org.bukkit.entity.Player getByUuid​(@NotNull
+                                                           @NotNull java.util.UUID playerUuid)
        +
        Get a Player based on playerUUID.
        +
        +
        Parameters:
        +
        playerUuid - UUID of a player.
        +
        Returns:
        +
        The player if found, else null.
        +
        +
        • +
      + + + +
        +
      • +

        getBySelector

        +
        @Nullable
+public static @Nullable org.bukkit.entity.Player getBySelector​(@NotNull
+                                                               @NotNull java.lang.String playerSelector,
+                                                               @NotNull
+                                                               @NotNull org.bukkit.command.CommandSender sender)
        +
        Get a Player based on vanilla selectors. + https://minecraft.gamepedia.com/Commands#Target_selectors
        +
        +
        Parameters:
        +
        playerSelector - A target selector, usually starts with an '@'.
        +
        sender - Target sender for selector.
        +
        Returns:
        +
        The player if only one found, else null.
        +
        +
        • +
      + + + +
        +
      • +

        getMultiBySelector

        +
        @Nullable
+public static @Nullable java.util.List<org.bukkit.entity.Player> getMultiBySelector​(@NotNull
+                                                                                    @NotNull java.lang.String playerSelector,
+                                                                                    @NotNull
+                                                                                    @NotNull org.bukkit.command.CommandSender sender)
        +
        Get multiple Player based on selector. + https://minecraft.gamepedia.com/Commands#Target_selectors
        +
        +
        Parameters:
        +
        playerSelector - A target selector, usually starts with an '@'.
        +
        sender - Target sender for selector.
        +
        Returns:
        +
        A list of all the Player found.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/utils/PurgeWorlds.html b/javadoc/latest/com/onarandombox/MultiverseCore/utils/PurgeWorlds.html new file mode 100644 index 000000000..2eb9cde9c --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/utils/PurgeWorlds.html @@ -0,0 +1,385 @@ + + + + + +PurgeWorlds (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.utils
+

Class PurgeWorlds

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.utils.PurgeWorlds
      • +
    +
    • +
+
+
    +
  • +
    +
    @Deprecated
+public class PurgeWorlds
+extends java.lang.Object
    +
    Deprecated. +
    Use instead: WorldPurger and SimpleWorldPurger.
    +
    +
    Utility class that removes animals from worlds that don't belong there.
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and TypeMethodDescription
      voidpurgeWorld​(org.bukkit.command.CommandSender sender, + MultiverseWorld world) +
      Deprecated.
      +
      Convenience method for purgeWorld(CommandSender, MultiverseWorld, List, boolean, boolean) that takes the settings from the world-config.
      +
      voidpurgeWorld​(org.bukkit.command.CommandSender sender, + MultiverseWorld mvworld, + java.util.List<java.lang.String> thingsToKill, + boolean negateAnimals, + boolean negateMonsters) +
      Deprecated.
      +
      Clear all animals/monsters that do not belong to a world according to the config.
      +
      voidpurgeWorlds​(org.bukkit.command.CommandSender sender, + java.util.List<MultiverseWorld> worlds) +
      Deprecated.
      +
      Synchronizes the given world with it's settings.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        PurgeWorlds

        +
        public PurgeWorlds​(MultiverseCore plugin)
        +
        Deprecated.
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        purgeWorlds

        +
        public void purgeWorlds​(org.bukkit.command.CommandSender sender,
+                        java.util.List<MultiverseWorld> worlds)
        +
        Deprecated.
        +
        Synchronizes the given world with it's settings.
        +
        +
        Parameters:
        +
        sender - The CommandSender who is requesting the world be purged.
        +
        worlds - A list of MultiverseWorld
        +
        +
        • +
      + + + + + + + +
        +
      • +

        purgeWorld

        +
        public void purgeWorld​(org.bukkit.command.CommandSender sender,
+                       MultiverseWorld mvworld,
+                       java.util.List<java.lang.String> thingsToKill,
+                       boolean negateAnimals,
+                       boolean negateMonsters)
        +
        Deprecated.
        +
        Clear all animals/monsters that do not belong to a world according to the config.
        +
        +
        Parameters:
        +
        sender - The CommandSender that initiated the action.
        +
        mvworld - The MultiverseWorld.
        +
        thingsToKill - A List of animals/monsters to be killed.
        +
        negateAnimals - Whether the monsters in the list should be negated.
        +
        negateMonsters - Whether the animals in the list should be negated.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/utils/ReflectHelper.html b/javadoc/latest/com/onarandombox/MultiverseCore/utils/ReflectHelper.html new file mode 100644 index 000000000..f4c71d4f1 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/utils/ReflectHelper.html @@ -0,0 +1,531 @@ + + + + + +ReflectHelper (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.utils
+

Class ReflectHelper

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.utils.ReflectHelper
      • +
    +
    • +
+
+
    +
  • +
    +
    public class ReflectHelper
+extends java.lang.Object
    +
    Utility class used to help in doing various reflection actions.
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      ReflectHelper() 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethodDescription
      static @Nullable java.lang.Class<?>getClass​(java.lang.String classPath) +
      Try to get the Class based on its classpath.
      +
      static <C> @Nullable java.lang.reflect.FieldgetField​(C classInstance, + java.lang.String fieldName) +
      Try to get a Field from a given class.
      +
      static <C> @Nullable java.lang.reflect.FieldgetField​(java.lang.Class<C> clazz, + java.lang.String fieldName) +
      Try to get a Field from a given class.
      +
      static <C,​V>
      V      		getFieldValue​(C classInstance, + java.lang.reflect.Field field) +
      Gets the value of an Field from an instance of the class responsible.
      +
      static <C> @Nullable java.lang.reflect.MethodgetMethod​(C classInstance, + java.lang.String methodName, + java.lang.Class<?>... parameterTypes) +
      Try to get a Method from a given class.
      +
      static <C> @Nullable java.lang.reflect.MethodgetMethod​(java.lang.Class<C> clazz, + java.lang.String methodName, + java.lang.Class<?>... parameterTypes) +
      Try to get a Method from a given class.
      +
      static booleanhasClass​(java.lang.String classPath) +
      Check if the Class for a give classpath is present/valid.
      +
      static <C,​R>
      R      		invokeMethod​(C classInstance, + java.lang.reflect.Method method, + java.lang.Object... parameters) +
      Calls a Method.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        ReflectHelper

        +
        public ReflectHelper()
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getClass

        +
        @Nullable
+public static @Nullable java.lang.Class<?> getClass​(java.lang.String classPath)
        +
        Try to get the Class based on its classpath.
        +
        +
        Parameters:
        +
        classPath - The target classpath.
        +
        Returns:
        +
        A Class if found, else null.
        +
        +
        • +
      + + + +
        +
      • +

        hasClass

        +
        public static boolean hasClass​(java.lang.String classPath)
        +
        Check if the Class for a give classpath is present/valid.
        +
        +
        Parameters:
        +
        classPath - Target classpath.
        +
        Returns:
        +
        True if class path is a valid class, else false.
        +
        +
        • +
      + + + +
        +
      • +

        getMethod

        +
        @Nullable
+public static <C> @Nullable java.lang.reflect.Method getMethod​(java.lang.Class<C> clazz,
+                                                               java.lang.String methodName,
+                                                               java.lang.Class<?>... parameterTypes)
        +
        Try to get a Method from a given class.
        +
        +
        Type Parameters:
        +
        C - The class type.
        +
        Parameters:
        +
        clazz - The class to search the method on.
        +
        methodName - Name of the method to get.
        +
        parameterTypes - Parameters present for that method.
        +
        Returns:
        +
        A Method if found, else null.
        +
        +
        • +
      + + + + + +
        +
      • +

        getMethod

        +
        @Nullable
+public static <C> @Nullable java.lang.reflect.Method getMethod​(C classInstance,
+                                                               java.lang.String methodName,
+                                                               java.lang.Class<?>... parameterTypes)
        +
        Try to get a Method from a given class.
        +
        +
        Type Parameters:
        +
        C - The class type.
        +
        Parameters:
        +
        classInstance - Instance of the class to search the method on.
        +
        methodName - Name of the method to get.
        +
        parameterTypes - Parameters present for that method.
        +
        Returns:
        +
        A Method if found, else null.
        +
        +
        • +
      + + + + + +
        +
      • +

        invokeMethod

        +
        @Nullable
+public static <C,​R> R invokeMethod​(C classInstance,
+                                         java.lang.reflect.Method method,
+                                         java.lang.Object... parameters)
        +
        Calls a Method.
        +
        +
        Type Parameters:
        +
        C - The class type.
        +
        R - The return type.
        +
        Parameters:
        +
        classInstance - Instance of the class responsible for the method.
        +
        method - The method to call.
        +
        parameters - Parameters needed when calling the method.
        +
        Returns:
        +
        Return value of the method call if any, else null.
        +
        +
        • +
      + + + +
        +
      • +

        getField

        +
        @Nullable
+public static <C> @Nullable java.lang.reflect.Field getField​(java.lang.Class<C> clazz,
+                                                             java.lang.String fieldName)
        +
        Try to get a Field from a given class.
        +
        +
        Type Parameters:
        +
        C - The class type.
        +
        Parameters:
        +
        clazz - The class to search the field on.
        +
        fieldName - Name of the field to get.
        +
        Returns:
        +
        A Field if found, else null.
        +
        +
        • +
      + + + + + +
        +
      • +

        getField

        +
        @Nullable
+public static <C> @Nullable java.lang.reflect.Field getField​(C classInstance,
+                                                             java.lang.String fieldName)
        +
        Try to get a Field from a given class.
        +
        +
        Type Parameters:
        +
        C - The class type.
        +
        Parameters:
        +
        classInstance - Instance of the class to search the field on.
        +
        fieldName - Name of the field to get.
        +
        Returns:
        +
        A Field if found, else null.
        +
        +
        • +
      + + + + + +
        +
      • +

        getFieldValue

        +
        @Nullable
+public static <C,​V> V getFieldValue​(C classInstance,
+                                          java.lang.reflect.Field field)
        +
        Gets the value of an Field from an instance of the class responsible.
        +
        +
        Type Parameters:
        +
        C - The class type.
        +
        V - The field value type.
        +
        Parameters:
        +
        classInstance - Instance of the class to get the field value from.
        +
        field - The field to get value from.
        +
        Returns:
        +
        The field value if any, else null.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/utils/SimpleBlockSafety.html b/javadoc/latest/com/onarandombox/MultiverseCore/utils/SimpleBlockSafety.html new file mode 100644 index 000000000..7479276cc --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/utils/SimpleBlockSafety.html @@ -0,0 +1,546 @@ + + + + + +SimpleBlockSafety (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.utils
+

Class SimpleBlockSafety

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.utils.SimpleBlockSafety
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    BlockSafety
    +
    +
    +
    public class SimpleBlockSafety
+extends java.lang.Object
+implements BlockSafety
    +
    The default-implementation of BlockSafety.
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      SimpleBlockSafety​(Core plugin) 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      booleancanSpawnCartSafely​(org.bukkit.entity.Minecart cart) +
      Checks if the specified Minecart can spawn safely.
      +
      booleancanSpawnVehicleSafely​(org.bukkit.entity.Vehicle vehicle) +
      Checks if the specified Vehicle can spawn safely.
      +
      org.bukkit.LocationgetBottomBlock​(org.bukkit.Location l) +
      Gets the location of the top block at the specified Location.
      +
      org.bukkit.LocationgetSafeBedSpawn​(org.bukkit.Location l) +
      Gets a safe bed spawn location OR null if the bed is invalid.
      +
      org.bukkit.LocationgetTopBlock​(org.bukkit.Location l) +
      Gets the location of the top block at the specified Location.
      +
      booleanisBlockAboveAir​(org.bukkit.Location l) +
      This function checks whether the block at the given coordinates are above air or not.
      +
      booleanisEntitiyOnTrack​(org.bukkit.Location l) +
      Checks if an entity would be on track at the specified Location.
      +
      static booleanisSolidBlock​(org.bukkit.Material type) 
      booleanplayerCanSpawnHereSafely​(org.bukkit.Location l) +
      This function checks whether the block at the coordinates given is safe or not by checking for Lava/Fire/Air + etc.
      +
      booleanplayerCanSpawnHereSafely​(org.bukkit.World world, + double x, + double y, + double z) +
      Checks if a player can spawn safely at the given coordinates.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        SimpleBlockSafety

        +
        public SimpleBlockSafety​(Core plugin)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        isBlockAboveAir

        +
        public boolean isBlockAboveAir​(org.bukkit.Location l)
        +
        This function checks whether the block at the given coordinates are above air or not.
        +
        +
        Specified by:
        +
        isBlockAboveAir in interface BlockSafety
        +
        Parameters:
        +
        l - The Location of the block.
        +
        Returns:
        +
        True if the block at that Location is above air.
        +
        +
        • +
      + + + +
        +
      • +

        playerCanSpawnHereSafely

        +
        public boolean playerCanSpawnHereSafely​(org.bukkit.World world,
+                                        double x,
+                                        double y,
+                                        double z)
        +
        Checks if a player can spawn safely at the given coordinates.
        +
        +
        Specified by:
        +
        playerCanSpawnHereSafely in interface BlockSafety
        +
        Parameters:
        +
        world - The World.
        +
        x - The x-coordinate.
        +
        y - The y-coordinate.
        +
        z - The z-coordinate.
        +
        Returns:
        +
        True if a player can spawn safely at the given coordinates.
        +
        +
        • +
      + + + +
        +
      • +

        playerCanSpawnHereSafely

        +
        public boolean playerCanSpawnHereSafely​(org.bukkit.Location l)
        +
        This function checks whether the block at the coordinates given is safe or not by checking for Lava/Fire/Air + etc. This also ensures there is enough space for a player to spawn!
        +
        +
        Specified by:
        +
        playerCanSpawnHereSafely in interface BlockSafety
        +
        Parameters:
        +
        l - The Location
        +
        Returns:
        +
        Whether the player can spawn safely at the given Location
        +
        +
        • +
      + + + +
        +
      • +

        getSafeBedSpawn

        +
        public org.bukkit.Location getSafeBedSpawn​(org.bukkit.Location l)
        +
        Gets a safe bed spawn location OR null if the bed is invalid.
        +
        +
        Specified by:
        +
        getSafeBedSpawn in interface BlockSafety
        +
        Parameters:
        +
        l - The location of the bead head (block with the pillow on it).
        +
        Returns:
        +
        Safe location around the bed or null if no location was found.
        +
        +
        • +
      + + + +
        +
      • +

        getTopBlock

        +
        public org.bukkit.Location getTopBlock​(org.bukkit.Location l)
        +
        Gets the location of the top block at the specified Location.
        +
        +
        Specified by:
        +
        getTopBlock in interface BlockSafety
        +
        Parameters:
        +
        l - Any Location.
        +
        Returns:
        +
        The Location of the top-block.
        +
        +
        • +
      + + + +
        +
      • +

        getBottomBlock

        +
        public org.bukkit.Location getBottomBlock​(org.bukkit.Location l)
        +
        Gets the location of the top block at the specified Location.
        +
        +
        Specified by:
        +
        getBottomBlock in interface BlockSafety
        +
        Parameters:
        +
        l - Any Location.
        +
        Returns:
        +
        The Location of the top-block.
        +
        +
        • +
      + + + +
        +
      • +

        isSolidBlock

        +
        public static boolean isSolidBlock​(org.bukkit.Material type)
        +
        • +
      + + + +
        +
      • +

        isEntitiyOnTrack

        +
        public boolean isEntitiyOnTrack​(org.bukkit.Location l)
        +
        Checks if an entity would be on track at the specified Location.
        +
        +
        Specified by:
        +
        isEntitiyOnTrack in interface BlockSafety
        +
        Parameters:
        +
        l - The Location.
        +
        Returns:
        +
        True if an entity would be on tracks at the specified Location.
        +
        +
        • +
      + + + +
        +
      • +

        canSpawnCartSafely

        +
        public boolean canSpawnCartSafely​(org.bukkit.entity.Minecart cart)
        +
        Checks if the specified Minecart can spawn safely.
        +
        +
        Specified by:
        +
        canSpawnCartSafely in interface BlockSafety
        +
        Parameters:
        +
        cart - The Minecart.
        +
        Returns:
        +
        True if the minecart can spawn safely.
        +
        +
        • +
      + + + +
        +
      • +

        canSpawnVehicleSafely

        +
        public boolean canSpawnVehicleSafely​(org.bukkit.entity.Vehicle vehicle)
        +
        Checks if the specified Vehicle can spawn safely.
        +
        +
        Specified by:
        +
        canSpawnVehicleSafely in interface BlockSafety
        +
        Parameters:
        +
        vehicle - The Vehicle.
        +
        Returns:
        +
        True if the vehicle can spawn safely.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/utils/SimpleLocationManipulation.html b/javadoc/latest/com/onarandombox/MultiverseCore/utils/SimpleLocationManipulation.html new file mode 100644 index 000000000..f2d63a0ac --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/utils/SimpleLocationManipulation.html @@ -0,0 +1,557 @@ + + + + + +SimpleLocationManipulation (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.utils
+

Class SimpleLocationManipulation

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.utils.SimpleLocationManipulation
      • +
    +
    • +
+
+ +
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      org.bukkit.LocationgetBlockLocation​(org.bukkit.Location l) +
      This method simply does some rounding, rather than forcing a call to the server to get the blockdata.
      +
      java.lang.StringgetDirection​(org.bukkit.Location location) +
      Return the NESW Direction a Location is facing.
      +
      org.bukkit.LocationgetNextBlock​(org.bukkit.entity.Vehicle v) +
      Returns the next Location that a Vehicle is traveling at.
      +
      floatgetSpeed​(org.bukkit.util.Vector v) +
      Returns a speed float from a given vector.
      +
      org.bukkit.util.VectorgetTranslatedVector​(org.bukkit.util.Vector v, + java.lang.String direction) +
      Returns a translated vector from the given direction.
      +
      floatgetYaw​(java.lang.String orientation) +
      Returns the float yaw position for the given cardinal direction.
      +
      java.lang.StringlocationToString​(org.bukkit.Location location) +
      Convert a Location into a Colon separated string to allow us to store it in text.
      +
      java.lang.StringstrCoords​(org.bukkit.Location l) +
      Returns a colored string with the coords.
      +
      java.lang.StringstrCoordsRaw​(org.bukkit.Location l) +
      Converts a location to a printable readable formatted string including pitch/yaw.
      +
      org.bukkit.LocationstringToLocation​(java.lang.String locationString) +
      Returns a new location from a given string.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        SimpleLocationManipulation

        +
        public SimpleLocationManipulation()
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        locationToString

        +
        public java.lang.String locationToString​(org.bukkit.Location location)
        +
        Convert a Location into a Colon separated string to allow us to store it in text. +

        + WORLD:X,Y,Z:yaw:pitch +

        + The corresponding String2Loc function is LocationManipulation.stringToLocation(java.lang.String)

        +
        +
        Specified by:
        +
        locationToString in interface LocationManipulation
        +
        Parameters:
        +
        location - The Location to save.
        +
        Returns:
        +
        The location as a string in this format: WORLD:x,y,z:yaw:pitch
        +
        +
        • +
      + + + +
        +
      • +

        getBlockLocation

        +
        public org.bukkit.Location getBlockLocation​(org.bukkit.Location l)
        +
        This method simply does some rounding, rather than forcing a call to the server to get the blockdata.
        +
        +
        Specified by:
        +
        getBlockLocation in interface LocationManipulation
        +
        Parameters:
        +
        l - The location to round to the block location
        +
        Returns:
        +
        A rounded location.
        +
        +
        • +
      + + + +
        +
      • +

        stringToLocation

        +
        public org.bukkit.Location stringToLocation​(java.lang.String locationString)
        +
        Returns a new location from a given string. The format is as follows: +

        + WORLD:X,Y,Z:yaw:pitch +

        + The corresponding Location2String function is LocationManipulation.stringToLocation(java.lang.String)

        +
        +
        Specified by:
        +
        stringToLocation in interface LocationManipulation
        +
        Parameters:
        +
        locationString - The location represented as a string (WORLD:X,Y,Z:yaw:pitch)
        +
        Returns:
        +
        A new location defined by the string or null if the string was invalid.
        +
        +
        • +
      + + + +
        +
      • +

        strCoords

        +
        public java.lang.String strCoords​(org.bukkit.Location l)
        +
        Returns a colored string with the coords.
        +
        +
        Specified by:
        +
        strCoords in interface LocationManipulation
        +
        Parameters:
        +
        l - The Location
        +
        Returns:
        +
        The String
        +
        +
        • +
      + + + +
        +
      • +

        strCoordsRaw

        +
        public java.lang.String strCoordsRaw​(org.bukkit.Location l)
        +
        Converts a location to a printable readable formatted string including pitch/yaw.
        +
        +
        Specified by:
        +
        strCoordsRaw in interface LocationManipulation
        +
        Parameters:
        +
        l - The Location
        +
        Returns:
        +
        The String
        +
        +
        • +
      + + + +
        +
      • +

        getDirection

        +
        public java.lang.String getDirection​(org.bukkit.Location location)
        +
        Return the NESW Direction a Location is facing.
        +
        +
        Specified by:
        +
        getDirection in interface LocationManipulation
        +
        Parameters:
        +
        location - The Location
        +
        Returns:
        +
        The NESW Direction
        +
        +
        • +
      + + + +
        +
      • +

        getYaw

        +
        public float getYaw​(java.lang.String orientation)
        +
        Returns the float yaw position for the given cardinal direction.
        +
        +
        Specified by:
        +
        getYaw in interface LocationManipulation
        +
        Parameters:
        +
        orientation - The cardinal direction
        +
        Returns:
        +
        The yaw
        +
        +
        • +
      + + + +
        +
      • +

        getSpeed

        +
        public float getSpeed​(org.bukkit.util.Vector v)
        +
        Returns a speed float from a given vector.
        +
        +
        Specified by:
        +
        getSpeed in interface LocationManipulation
        +
        Parameters:
        +
        v - The Vector
        +
        Returns:
        +
        The speed
        +
        +
        • +
      + + + +
        +
      • +

        getTranslatedVector

        +
        public org.bukkit.util.Vector getTranslatedVector​(org.bukkit.util.Vector v,
+                                                  java.lang.String direction)
        +
        Returns a translated vector from the given direction.
        +
        +
        Specified by:
        +
        getTranslatedVector in interface LocationManipulation
        +
        Parameters:
        +
        v - The old Vector
        +
        direction - The new direction
        +
        Returns:
        +
        The translated Vector
        +
        +
        • +
      + + + +
        +
      • +

        getNextBlock

        +
        public org.bukkit.Location getNextBlock​(org.bukkit.entity.Vehicle v)
        +
        Returns the next Location that a Vehicle is traveling at.
        +
        +
        Specified by:
        +
        getNextBlock in interface LocationManipulation
        +
        Parameters:
        +
        v - The Vehicle
        +
        Returns:
        +
        The Location
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/utils/SimpleSafeTTeleporter.html b/javadoc/latest/com/onarandombox/MultiverseCore/utils/SimpleSafeTTeleporter.html new file mode 100644 index 000000000..fd1938749 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/utils/SimpleSafeTTeleporter.html @@ -0,0 +1,495 @@ + + + + + +SimpleSafeTTeleporter (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.utils
+

Class SimpleSafeTTeleporter

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.utils.SimpleSafeTTeleporter
      • +
    +
    • +
+
+ +
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      org.bukkit.LocationfindPortalBlockNextTo​(org.bukkit.Location l) +
      Finds a portal-block next to the specified Location.
      +
      org.bukkit.LocationgetSafeLocation​(org.bukkit.entity.Entity e, + MVDestination d) +
      Returns a safe location for the entity to spawn at.
      +
      org.bukkit.LocationgetSafeLocation​(org.bukkit.Location l) +
      Gets the next safe location around the given location.
      +
      org.bukkit.LocationgetSafeLocation​(org.bukkit.Location l, + int tolerance, + int radius) +
      Gets the next safe location around the given location.
      +
      TeleportResultsafelyTeleport​(org.bukkit.command.CommandSender teleporter, + org.bukkit.entity.Entity teleportee, + MVDestination d) +
      Safely teleport the entity to the MVDestination.
      +
      TeleportResultsafelyTeleport​(org.bukkit.command.CommandSender teleporter, + org.bukkit.entity.Entity teleportee, + org.bukkit.Location location, + boolean safely) +
      Safely teleport the entity to the Location.
      +
      TeleportResultteleport​(org.bukkit.command.CommandSender teleporter, + org.bukkit.entity.Player teleportee, + MVDestination destination) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        SimpleSafeTTeleporter

        +
        public SimpleSafeTTeleporter​(MultiverseCore plugin)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getSafeLocation

        +
        public org.bukkit.Location getSafeLocation​(org.bukkit.Location l)
        +
        Gets the next safe location around the given location.
        +
        +
        Specified by:
        +
        getSafeLocation in interface SafeTTeleporter
        +
        Parameters:
        +
        l - A Location.
        +
        Returns:
        +
        A safe Location.
        +
        +
        • +
      + + + +
        +
      • +

        getSafeLocation

        +
        public org.bukkit.Location getSafeLocation​(org.bukkit.Location l,
+                                           int tolerance,
+                                           int radius)
        +
        Gets the next safe location around the given location.
        +
        +
        Specified by:
        +
        getSafeLocation in interface SafeTTeleporter
        +
        Parameters:
        +
        l - A Location.
        +
        tolerance - The tolerance.
        +
        radius - The radius.
        +
        Returns:
        +
        A safe Location.
        +
        +
        • +
      + + + +
        +
      • +

        safelyTeleport

        +
        public TeleportResult safelyTeleport​(org.bukkit.command.CommandSender teleporter,
+                                     org.bukkit.entity.Entity teleportee,
+                                     MVDestination d)
        +
        Safely teleport the entity to the MVDestination. This will perform checks to see if the place is safe, and if + it's not, will adjust the final destination accordingly.
        +
        +
        Specified by:
        +
        safelyTeleport in interface SafeTTeleporter
        +
        Parameters:
        +
        teleporter - Person who performed the teleport command.
        +
        teleportee - Entity to teleport
        +
        d - Destination to teleport them to
        +
        Returns:
        +
        true for success, false for failure
        +
        +
        • +
      + + + +
        +
      • +

        safelyTeleport

        +
        public TeleportResult safelyTeleport​(org.bukkit.command.CommandSender teleporter,
+                                     org.bukkit.entity.Entity teleportee,
+                                     org.bukkit.Location location,
+                                     boolean safely)
        +
        Safely teleport the entity to the Location. This may perform checks to + see if the place is safe, and if + it's not, will adjust the final destination accordingly.
        +
        +
        Specified by:
        +
        safelyTeleport in interface SafeTTeleporter
        +
        Parameters:
        +
        teleporter - Person who issued the teleport command.
        +
        teleportee - Entity to teleport.
        +
        location - Location to teleport them to.
        +
        safely - Should the destination be checked for safety before teleport?
        +
        Returns:
        +
        true for success, false for failure.
        +
        +
        • +
      + + + +
        +
      • +

        getSafeLocation

        +
        public org.bukkit.Location getSafeLocation​(org.bukkit.entity.Entity e,
+                                           MVDestination d)
        +
        Returns a safe location for the entity to spawn at.
        +
        +
        Specified by:
        +
        getSafeLocation in interface SafeTTeleporter
        +
        Parameters:
        +
        e - The entity to spawn
        +
        d - The MVDestination to take the entity to.
        +
        Returns:
        +
        A new location to spawn the entity at.
        +
        +
        • +
      + + + +
        +
      • +

        findPortalBlockNextTo

        +
        public org.bukkit.Location findPortalBlockNextTo​(org.bukkit.Location l)
        +
        Finds a portal-block next to the specified Location.
        +
        +
        Specified by:
        +
        findPortalBlockNextTo in interface SafeTTeleporter
        +
        Parameters:
        +
        l - The Location
        +
        Returns:
        +
        The next portal-block's Location.
        +
        +
        • +
      + + + + +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/utils/SimpleWorldPurger.html b/javadoc/latest/com/onarandombox/MultiverseCore/utils/SimpleWorldPurger.html new file mode 100644 index 000000000..19c095edc --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/utils/SimpleWorldPurger.html @@ -0,0 +1,471 @@ + + + + + +SimpleWorldPurger (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.utils
+

Class SimpleWorldPurger

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.utils.SimpleWorldPurger
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    WorldPurger
    +
    +
    +
    public class SimpleWorldPurger
+extends java.lang.Object
+implements WorldPurger
    +
    Utility class that removes animals from worlds that don't belong there.
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      voidpurgeWorld​(MultiverseWorld world) +
      Convenience method for WorldPurger.purgeWorld(MultiverseWorld, java.util.List, boolean, boolean) that takes the settings from the world-config.
      +
      voidpurgeWorld​(MultiverseWorld mvworld, + java.util.List<java.lang.String> thingsToKill, + boolean negateAnimals, + boolean negateMonsters) +
      Clear all animals/monsters that do not belong to a world according to the config.
      +
      voidpurgeWorld​(MultiverseWorld mvworld, + java.util.List<java.lang.String> thingsToKill, + boolean negateAnimals, + boolean negateMonsters, + org.bukkit.command.CommandSender sender) +
      Clear all animals/monsters that do not belong to a world according to the config.
      +
      voidpurgeWorlds​(java.util.List<MultiverseWorld> worlds) +
      Synchronizes the given worlds with their settings.
      +
      booleanshouldWeKillThisCreature​(MultiverseWorld world, + org.bukkit.entity.Entity e) +
      Determines whether the specified creature should be killed and automatically reads the params from a world object.
      +
      booleanshouldWeKillThisCreature​(org.bukkit.entity.Entity e, + java.util.List<java.lang.String> thingsToKill, + boolean negateAnimals, + boolean negateMonsters) +
      Determines whether the specified creature should be killed.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        SimpleWorldPurger

        +
        public SimpleWorldPurger​(MultiverseCore plugin)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + + + + + + + + + +
        +
      • +

        shouldWeKillThisCreature

        +
        public boolean shouldWeKillThisCreature​(MultiverseWorld world,
+                                        org.bukkit.entity.Entity e)
        +
        Determines whether the specified creature should be killed and automatically reads the params from a world object.
        +
        +
        Specified by:
        +
        shouldWeKillThisCreature in interface WorldPurger
        +
        Parameters:
        +
        world - The world.
        +
        e - The creature.
        +
        Returns:
        +
        true if the creature should be killed, otherwise false.
        +
        +
        • +
      + + + +
        +
      • +

        purgeWorld

        +
        public void purgeWorld​(MultiverseWorld mvworld,
+                       java.util.List<java.lang.String> thingsToKill,
+                       boolean negateAnimals,
+                       boolean negateMonsters,
+                       org.bukkit.command.CommandSender sender)
        +
        Clear all animals/monsters that do not belong to a world according to the config.
        +
        +
        Specified by:
        +
        purgeWorld in interface WorldPurger
        +
        Parameters:
        +
        mvworld - The MultiverseWorld.
        +
        thingsToKill - A List of animals/monsters to be killed.
        +
        negateAnimals - Whether the monsters in the list should be negated.
        +
        negateMonsters - Whether the animals in the list should be negated.
        +
        sender - The CommandSender that initiated the action. He will/should be notified.
        +
        +
        • +
      + + + +
        +
      • +

        shouldWeKillThisCreature

        +
        public boolean shouldWeKillThisCreature​(org.bukkit.entity.Entity e,
+                                        java.util.List<java.lang.String> thingsToKill,
+                                        boolean negateAnimals,
+                                        boolean negateMonsters)
        +
        Determines whether the specified creature should be killed.
        +
        +
        Specified by:
        +
        shouldWeKillThisCreature in interface WorldPurger
        +
        Parameters:
        +
        e - The creature.
        +
        thingsToKill - A List of animals/monsters to be killed.
        +
        negateAnimals - Whether the monsters in the list should be negated.
        +
        negateMonsters - Whether the animals in the list should be negated.
        +
        Returns:
        +
        true if the creature should be killed, otherwise false.
        +
        +
        • +
      + + + +
        +
      • +

        purgeWorld

        +
        public void purgeWorld​(MultiverseWorld mvworld,
+                       java.util.List<java.lang.String> thingsToKill,
+                       boolean negateAnimals,
+                       boolean negateMonsters)
        +
        Clear all animals/monsters that do not belong to a world according to the config.
        +
        +
        Specified by:
        +
        purgeWorld in interface WorldPurger
        +
        Parameters:
        +
        mvworld - The MultiverseWorld.
        +
        thingsToKill - A List of animals/monsters to be killed.
        +
        negateAnimals - Whether the monsters in the list should be negated.
        +
        negateMonsters - Whether the animals in the list should be negated.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/utils/TestingMode.html b/javadoc/latest/com/onarandombox/MultiverseCore/utils/TestingMode.html new file mode 100644 index 000000000..d595c2814 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/utils/TestingMode.html @@ -0,0 +1,320 @@ + + + + + +TestingMode (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.utils
+

Class TestingMode

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.utils.TestingMode
      • +
    +
    • +
+
+
    +
  • +
    +
    public class TestingMode
+extends java.lang.Object
    +
    A utility class that enables automated tests to flag Multiverse for testing. This allows Multiverse to not perform + certain behaviors such as enabled stats uploads.
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      TestingMode() 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethodDescription
      static voidenable() 
      static booleanisDisabled() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        TestingMode

        +
        public TestingMode()
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        enable

        +
        public static void enable()
        +
        • +
      + + + +
        +
      • +

        isDisabled

        +
        public static boolean isDisabled()
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/utils/UnsafeCallWrapper.html b/javadoc/latest/com/onarandombox/MultiverseCore/utils/UnsafeCallWrapper.html new file mode 100644 index 000000000..0e5515b37 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/utils/UnsafeCallWrapper.html @@ -0,0 +1,326 @@ + + + + + +UnsafeCallWrapper (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.utils
+

Class UnsafeCallWrapper

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.utils.UnsafeCallWrapper
      • +
    +
    • +
+
+
    +
  • +
    +
    public class UnsafeCallWrapper
+extends java.lang.Object
    +
    Wraps calls that could result in exceptions that are not Multiverse's fault.
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      <T> Twrap​(java.util.concurrent.Callable<T> callable, + java.lang.String plugin, + java.lang.String action, + java.lang.Object... formatArgs) +
      Wraps calls that could result in exceptions that are not Multiverse's fault.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        UnsafeCallWrapper

        +
        public UnsafeCallWrapper​(Core core)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        wrap

        +
        public <T> T wrap​(java.util.concurrent.Callable<T> callable,
+                  java.lang.String plugin,
+                  java.lang.String action,
+                  java.lang.Object... formatArgs)
        +
        Wraps calls that could result in exceptions that are not Multiverse's fault.
        +
        +
        Type Parameters:
        +
        T - The type of the return value.
        +
        Parameters:
        +
        callable - The potentially unsafe call.
        +
        plugin - The plugin that's probably the culprit.
        +
        action - What MV was attempting to do (error message, format string).
        +
        formatArgs - The formatting arguments for the error message. + The exception that was thrown will be appended to these objects.
        +
        Returns:
        +
        The return value or null if the call failed.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/utils/VaultHandler.html b/javadoc/latest/com/onarandombox/MultiverseCore/utils/VaultHandler.html new file mode 100644 index 000000000..8f6f9008c --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/utils/VaultHandler.html @@ -0,0 +1,338 @@ + + + + + +VaultHandler (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.utils
+

Class VaultHandler

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.utils.VaultHandler
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    org.bukkit.event.Listener
    +
    +
    +
    public class VaultHandler
+extends java.lang.Object
+implements org.bukkit.event.Listener
    +
    A class we use to interface with Vault when it is present.
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      VaultHandler​(org.bukkit.plugin.Plugin plugin) 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      net.milkbowl.vault.economy.EconomygetEconomy() +
      Returns the Vault economy system if Vault is present and has an economy system enabled.
      +
      booleanhasEconomy() +
      Checks whether Vault is in use and has an economy system enabled.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        VaultHandler

        +
        public VaultHandler​(org.bukkit.plugin.Plugin plugin)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        hasEconomy

        +
        public boolean hasEconomy()
        +
        Checks whether Vault is in use and has an economy system enabled.
        +
        +
        Returns:
        +
        true if vault is in use and has an economy system enabled.
        +
        +
        • +
      + + + +
        +
      • +

        getEconomy

        +
        public net.milkbowl.vault.economy.Economy getEconomy()
        +
        Returns the Vault economy system if Vault is present and has an economy system enabled.
        +
        +
        Returns:
        +
        The vault economy system or null if not configured.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/utils/WorldManager.html b/javadoc/latest/com/onarandombox/MultiverseCore/utils/WorldManager.html new file mode 100644 index 000000000..aa40b1c0a --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/utils/WorldManager.html @@ -0,0 +1,1306 @@ + + + + + +WorldManager (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.utils
+

Class WorldManager

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.utils.WorldManager
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    MVWorldManager
    +
    +
    +
    public class WorldManager
+extends java.lang.Object
+implements MVWorldManager
    +
    Public facing API to add/remove Multiverse worlds.
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and TypeMethodDescription
      booleanaddWorld​(java.lang.String name, + org.bukkit.World.Environment env, + java.lang.String seedString, + org.bukkit.WorldType type, + java.lang.Boolean generateStructures, + java.lang.String generator) +
      Add a new World to the Multiverse Setup.
      +
      booleanaddWorld​(java.lang.String name, + org.bukkit.World.Environment env, + java.lang.String seedString, + org.bukkit.WorldType type, + java.lang.Boolean generateStructures, + java.lang.String generator, + boolean useSpawnAdjust) +
      Add a new World to the Multiverse Setup.
      +
      booleancloneWorld​(java.lang.String oldName, + java.lang.String newName) +
      Make a copy of a world.
      +
      booleancloneWorld​(java.lang.String oldName, + java.lang.String newName, + java.lang.String generator) +
      Deprecated. +
      Use cloneWorld(String, String) instead.
      +
      +
      booleandeleteWorld​(java.lang.String name) +
      Remove the world from the Multiverse list, from the config and deletes + the folder.
      +
      booleandeleteWorld​(java.lang.String name, + boolean removeFromConfig) +
      Remove the world from the Multiverse list, from the + config if wanted, and deletes the folder.
      +
      booleandeleteWorld​(java.lang.String name, + boolean removeFromConfig, + boolean deleteWorldFolder)
      org.bukkit.generator.ChunkGeneratorgetChunkGenerator​(java.lang.String generator, + java.lang.String generatorID, + java.lang.String worldName) +
      Test if a given chunk generator is valid.
      +
      org.bukkit.configuration.file.FileConfigurationgetConfigWorlds() +
      Gets the FileConfiguration that this WorldManager is using.
      +
      voidgetDefaultWorldGenerators() +
      This method populates an internal list and needs to be called after multiverse initialization.
      +
      MultiverseWorldgetFirstSpawnWorld() +
      Gets the world players should spawn in first.
      +
      MultiverseWorldgetMVWorld​(java.lang.String name) +
      Returns a MultiverseWorld if it exists, and null if it does not.
      +
      MultiverseWorldgetMVWorld​(java.lang.String name, + boolean checkAliases) +
      Returns a MultiverseWorld if the world with name given exists, and null if it does not.
      +
      MultiverseWorldgetMVWorld​(org.bukkit.World world) +
      Returns a MultiverseWorld if it exists, and null if it does not.
      +
      java.util.Collection<MultiverseWorld>getMVWorlds() +
      Returns a list of all the worlds Multiverse knows about.
      +
      java.util.Collection<java.lang.String>getPotentialWorlds() +
      Get all the possible worlds that Multiverse has detected to be importable.
      +
      MultiverseWorldgetSpawnWorld() +
      Gets the world players will spawn in on first join.
      +
      WorldPurgergetTheWorldPurger() +
      Gets the WorldPurger.
      +
      java.util.List<java.lang.String>getUnloadedWorlds() +
      Gets the list of worlds in the config, but unloaded.
      +
      PurgeWorldsgetWorldPurger() +
      Deprecated. +
      This is deprecated!
      +
      +
      booleanhasUnloadedWorld​(java.lang.String name, + boolean includeLoaded) +
      Checks whether Multiverse knows about a provided unloaded world.
      +
      booleanisKeepingSpawnInMemory​(org.bukkit.World world) 
      booleanisMVWorld​(java.lang.String name) +
      Checks to see if the given name is a valid MultiverseWorld + Searches based on world name AND alias.
      +
      booleanisMVWorld​(java.lang.String name, + boolean checkAliases) +
      Checks to see if the given name is a valid MultiverseWorld.
      +
      booleanisMVWorld​(org.bukkit.World world) +
      Checks to see if the given world is a valid MultiverseWorld.
      +
      voidloadDefaultWorlds() +
      Loads the Worlds & Settings for any worlds that bukkit loaded before us.
      +
      booleanloadWorld​(java.lang.String name) +
      Loads the world.
      +
      org.bukkit.configuration.file.FileConfigurationloadWorldConfig​(java.io.File file) +
      Load the config from a file.
      +
      voidloadWorlds​(boolean forceLoad) +
      Load the Worlds & Settings from the configuration file.
      +
      booleanregenWorld​(java.lang.String name, + boolean useNewSeed, + boolean randomSeed, + java.lang.String seed) +
      Regenerates a world.
      +
      booleanregenWorld​(java.lang.String name, + boolean useNewSeed, + boolean randomSeed, + java.lang.String seed, + boolean keepGameRules) +
      Regenerates a world.
      +
      voidremovePlayersFromWorld​(java.lang.String name) +
      Removes all players from the specified world.
      +
      booleanremoveWorldFromConfig​(java.lang.String name) +
      Remove the world from the Multiverse list and from the config.
      +
      booleansaveWorldsConfig() +
      Saves the world config to disk.
      +
      voidsetFirstSpawnWorld​(java.lang.String world) +
      Sets the initial spawn world for new players.
      +
      booleanunloadWorld​(java.lang.String name) +
      Unload a world from Multiverse.
      +
      booleanunloadWorld​(java.lang.String name, + boolean unloadBukkit) +
      Unload a world from Multiverse with option to prevent calling unloadWorld in Bukkit.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        getDefaultWorldGenerators

        +
        public void getDefaultWorldGenerators()
        +
        This method populates an internal list and needs to be called after multiverse initialization.
        +
        +
        Specified by:
        +
        getDefaultWorldGenerators in interface MVWorldManager
        +
        +
        • +
      + + + +
        +
      • +

        cloneWorld

        +
        @Deprecated
+public boolean cloneWorld​(java.lang.String oldName,
+                          java.lang.String newName,
+                          java.lang.String generator)
        +
        Deprecated. +
        Use cloneWorld(String, String) instead.
        +
        +
        Make a copy of a world.
        +
        +
        Specified by:
        +
        cloneWorld in interface MVWorldManager
        +
        Parameters:
        +
        oldName - Name of world to be copied
        +
        newName - Name of world to be created
        +
        generator - The Custom generator plugin to use. Ignored.
        +
        Returns:
        +
        True if the world is copied successfully, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        cloneWorld

        +
        public boolean cloneWorld​(java.lang.String oldName,
+                          java.lang.String newName)
        +
        Make a copy of a world.
        +
        +
        Specified by:
        +
        cloneWorld in interface MVWorldManager
        +
        Parameters:
        +
        oldName - Name of world to be copied
        +
        newName - Name of world to be created
        +
        Returns:
        +
        True if the world is copied successfully, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        addWorld

        +
        public boolean addWorld​(java.lang.String name,
+                        org.bukkit.World.Environment env,
+                        java.lang.String seedString,
+                        org.bukkit.WorldType type,
+                        java.lang.Boolean generateStructures,
+                        java.lang.String generator)
        +
        Add a new World to the Multiverse Setup.
        +
        +
        Specified by:
        +
        addWorld in interface MVWorldManager
        +
        Parameters:
        +
        name - World Name
        +
        env - Environment Type
        +
        seedString - The seed in the form of a string. + If the seed is a Long, + it will be interpreted as such.
        +
        type - The Type of the world to be made.
        +
        generateStructures - If true, this world will get NPC villages.
        +
        generator - The Custom generator plugin to use.
        +
        Returns:
        +
        True if the world is added, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        addWorld

        +
        public boolean addWorld​(java.lang.String name,
+                        org.bukkit.World.Environment env,
+                        java.lang.String seedString,
+                        org.bukkit.WorldType type,
+                        java.lang.Boolean generateStructures,
+                        java.lang.String generator,
+                        boolean useSpawnAdjust)
        +
        Add a new World to the Multiverse Setup.
        +
        +
        Specified by:
        +
        addWorld in interface MVWorldManager
        +
        Parameters:
        +
        name - World Name
        +
        env - Environment Type
        +
        seedString - The seed in the form of a string. + If the seed is a Long, + it will be interpreted as such.
        +
        type - The Type of the world to be made.
        +
        generateStructures - If true, this world will get NPC villages.
        +
        generator - The Custom generator plugin to use.
        +
        useSpawnAdjust - If true, multiverse will search for a safe spawn. If not, It will not modify the level.dat.
        +
        Returns:
        +
        True if the world is added, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        getChunkGenerator

        +
        public org.bukkit.generator.ChunkGenerator getChunkGenerator​(java.lang.String generator,
+                                                             java.lang.String generatorID,
+                                                             java.lang.String worldName)
        +
        Test if a given chunk generator is valid.
        +
        +
        Specified by:
        +
        getChunkGenerator in interface MVWorldManager
        +
        Parameters:
        +
        generator - The generator name.
        +
        generatorID - The generator id.
        +
        worldName - The worldName to use as the default.
        +
        Returns:
        +
        A ChunkGenerator or null
        +
        +
        • +
      + + + +
        +
      • +

        removeWorldFromConfig

        +
        public boolean removeWorldFromConfig​(java.lang.String name)
        +
        Remove the world from the Multiverse list and from the config.
        +
        +
        Specified by:
        +
        removeWorldFromConfig in interface MVWorldManager
        +
        Parameters:
        +
        name - The name of the world to remove
        +
        Returns:
        +
        True if success, false if failure.
        +
        +
        • +
      + + + +
        +
      • +

        setFirstSpawnWorld

        +
        public void setFirstSpawnWorld​(java.lang.String world)
        +
        Sets the initial spawn world for new players.
        +
        +
        Specified by:
        +
        setFirstSpawnWorld in interface MVWorldManager
        +
        Parameters:
        +
        world - The World new players should spawn in.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        unloadWorld

        +
        public boolean unloadWorld​(java.lang.String name)
        +
        Unload a world from Multiverse.
        +
        +
        Specified by:
        +
        unloadWorld in interface MVWorldManager
        +
        Parameters:
        +
        name - Name of the world to unload
        +
        Returns:
        +
        True if the world was unloaded, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        unloadWorld

        +
        public boolean unloadWorld​(java.lang.String name,
+                           boolean unloadBukkit)
        +
        Unload a world from Multiverse with option to prevent calling unloadWorld in Bukkit.
        +
        +
        Specified by:
        +
        unloadWorld in interface MVWorldManager
        +
        Parameters:
        +
        name - Name of the world to unload
        +
        unloadBukkit - True if Bukkit world should be unloaded
        +
        Returns:
        +
        True if the world was unloaded, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        loadWorld

        +
        public boolean loadWorld​(java.lang.String name)
        +
        Loads the world. Only use this if the world has been + unloaded with MVWorldManager.unloadWorld(String).
        +
        +
        Specified by:
        +
        loadWorld in interface MVWorldManager
        +
        Parameters:
        +
        name - The name of the world to load
        +
        Returns:
        +
        True if success, false if failure.
        +
        +
        • +
      + + + +
        +
      • +

        deleteWorld

        +
        public boolean deleteWorld​(java.lang.String name,
+                           boolean removeFromConfig,
+                           boolean deleteWorldFolder)
        +
        +
        Specified by:
        +
        deleteWorld in interface MVWorldManager
        +
        Parameters:
        +
        name - The name of the world to remove
        +
        removeFromConfig - If true(default), we'll remove the entries from the + config. If false, they'll stay and the world may come back.
        +
        deleteWorldFolder - If true the world folder will be completely deleted. If false + only the contents of the world folder will be deleted
        +
        Returns:
        +
        True if success, false if failure.
        +
        +
        • +
      + + + +
        +
      • +

        deleteWorld

        +
        public boolean deleteWorld​(java.lang.String name,
+                           boolean removeFromConfig)
        +
        Remove the world from the Multiverse list, from the + config if wanted, and deletes the folder.
        +
        +
        Specified by:
        +
        deleteWorld in interface MVWorldManager
        +
        Parameters:
        +
        name - The name of the world to remove
        +
        removeFromConfig - If true(default), we'll remove the entries from the + config. If false, they'll stay and the world may come back.
        +
        Returns:
        +
        True if success, false if failure.
        +
        +
        • +
      + + + +
        +
      • +

        deleteWorld

        +
        public boolean deleteWorld​(java.lang.String name)
        +
        Remove the world from the Multiverse list, from the config and deletes + the folder.
        +
        +
        Specified by:
        +
        deleteWorld in interface MVWorldManager
        +
        Parameters:
        +
        name - The name of the world to remove
        +
        Returns:
        +
        True if success, false if failure.
        +
        +
        • +
      + + + +
        +
      • +

        removePlayersFromWorld

        +
        public void removePlayersFromWorld​(java.lang.String name)
        +
        Removes all players from the specified world.
        +
        +
        Specified by:
        +
        removePlayersFromWorld in interface MVWorldManager
        +
        Parameters:
        +
        name - World to remove players from.
        +
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        getMVWorld

        +
        public MultiverseWorld getMVWorld​(java.lang.String name,
+                                  boolean checkAliases)
        +
        Returns a MultiverseWorld if the world with name given exists, and null if it does not. + This will search optionally for alias names.
        +
        +
        Specified by:
        +
        getMVWorld in interface MVWorldManager
        +
        Parameters:
        +
        name - The name or optionally the alias of the world to get.
        +
        checkAliases - Indicates whether to check for world alias name.
        +
        Returns:
        +
        A MultiverseWorld or null.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        isMVWorld

        +
        public boolean isMVWorld​(java.lang.String name)
        +
        Checks to see if the given name is a valid MultiverseWorld + Searches based on world name AND alias.
        +
        +
        Specified by:
        +
        isMVWorld in interface MVWorldManager
        +
        Parameters:
        +
        name - The name or alias of the world to check.
        +
        Returns:
        +
        True if the world exists, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        isMVWorld

        +
        public boolean isMVWorld​(java.lang.String name,
+                         boolean checkAliases)
        +
        Checks to see if the given name is a valid MultiverseWorld. + Optionally searches by alias is specified.
        +
        +
        Specified by:
        +
        isMVWorld in interface MVWorldManager
        +
        Parameters:
        +
        name - The name or alias of the world to check.
        +
        checkAliases - Indicates whether to check for world alias name.
        +
        Returns:
        +
        True if the world exists, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        isMVWorld

        +
        public boolean isMVWorld​(org.bukkit.World world)
        +
        Checks to see if the given world is a valid MultiverseWorld.
        +
        +
        Specified by:
        +
        isMVWorld in interface MVWorldManager
        +
        Parameters:
        +
        world - The Bukkit world to check.
        +
        Returns:
        +
        True if the world has been loaded into MV2, false if not.
        +
        +
        • +
      + + + +
        +
      • +

        loadDefaultWorlds

        +
        public void loadDefaultWorlds()
        +
        Loads the Worlds & Settings for any worlds that bukkit loaded before us. +

        + This way people will _always_ have some worlds in the list.

        +
        +
        Specified by:
        +
        loadDefaultWorlds in interface MVWorldManager
        +
        +
        • +
      + + + +
        +
      • +

        loadWorlds

        +
        public void loadWorlds​(boolean forceLoad)
        +
        Load the Worlds & Settings from the configuration file.
        +
        +
        Specified by:
        +
        loadWorlds in interface MVWorldManager
        +
        Parameters:
        +
        forceLoad - If set to true, this will perform a total + reset and not just load new worlds.
        +
        +
        • +
      + + + + + + + + + + + + + + + +
        +
      • +

        loadWorldConfig

        +
        public org.bukkit.configuration.file.FileConfiguration loadWorldConfig​(java.io.File file)
        +
        Load the config from a file.
        +
        +
        Specified by:
        +
        loadWorldConfig in interface MVWorldManager
        +
        Parameters:
        +
        file - The file to load.
        +
        Returns:
        +
        A loaded configuration.
        +
        +
        • +
      + + + +
        +
      • +

        saveWorldsConfig

        +
        public boolean saveWorldsConfig()
        +
        Saves the world config to disk.
        +
        +
        Specified by:
        +
        saveWorldsConfig in interface MVWorldManager
        +
        Returns:
        +
        True if success, false if fail.
        +
        +
        • +
      + + + +
        +
      • +

        getSpawnWorld

        +
        public MultiverseWorld getSpawnWorld()
        +
        Gets the world players will spawn in on first join. + Currently this always returns worlds.get(0) from Bukkit.
        +
        +
        Specified by:
        +
        getSpawnWorld in interface MVWorldManager
        +
        Returns:
        +
        A Multiverse world that players will spawn in or null if no MV world has been set.
        +
        +
        • +
      + + + +
        +
      • +

        getUnloadedWorlds

        +
        public java.util.List<java.lang.String> getUnloadedWorlds()
        +
        Gets the list of worlds in the config, but unloaded.
        +
        +
        Specified by:
        +
        getUnloadedWorlds in interface MVWorldManager
        +
        Returns:
        +
        A List of worlds as strings.
        +
        +
        • +
      + + + +
        +
      • +

        regenWorld

        +
        public boolean regenWorld​(java.lang.String name,
+                          boolean useNewSeed,
+                          boolean randomSeed,
+                          java.lang.String seed)
        +
        Regenerates a world.
        +
        +
        Specified by:
        +
        regenWorld in interface MVWorldManager
        +
        Parameters:
        +
        name - Name of the world to regenerate
        +
        useNewSeed - If a new seed should be used
        +
        randomSeed - If the new seed should be random
        +
        seed - The seed of the world.
        +
        Returns:
        +
        True if success, false if fail.
        +
        +
        • +
      + + + +
        +
      • +

        regenWorld

        +
        public boolean regenWorld​(java.lang.String name,
+                          boolean useNewSeed,
+                          boolean randomSeed,
+                          java.lang.String seed,
+                          boolean keepGameRules)
        +
        Regenerates a world.
        +
        +
        Specified by:
        +
        regenWorld in interface MVWorldManager
        +
        Parameters:
        +
        name - Name of the world to regenerate
        +
        useNewSeed - If a new seed should be used
        +
        randomSeed - If the new seed should be random
        +
        seed - The seed of the world.
        +
        keepGameRules - If GameRules should be kept on world regen.
        +
        Returns:
        +
        True if success, false if fail.
        +
        +
        • +
      + + + +
        +
      • +

        getConfigWorlds

        +
        public org.bukkit.configuration.file.FileConfiguration getConfigWorlds()
        +
        Gets the FileConfiguration that this WorldManager is using.
        +
        +
        Returns:
        +
        The FileConfiguration that this WorldManager is using.
        +
        +
        • +
      + + + +
        +
      • +

        hasUnloadedWorld

        +
        public boolean hasUnloadedWorld​(java.lang.String name,
+                                boolean includeLoaded)
        +
        Checks whether Multiverse knows about a provided unloaded world. This + method will check the parameter against the alias mappings.
        +
        +
        Specified by:
        +
        hasUnloadedWorld in interface MVWorldManager
        +
        Parameters:
        +
        name - The name of the unloaded world
        +
        includeLoaded - The value to return if the world is loaded
        +
        Returns:
        +
        True if the world exists and is unloaded. False if the world + does not exist. includeLoaded if the world exists and is loaded.
        +
        +
        • +
      + + + +
        +
      • +

        getPotentialWorlds

        +
        public java.util.Collection<java.lang.String> getPotentialWorlds()
        +
        Get all the possible worlds that Multiverse has detected to be importable.
        +
        +
        Specified by:
        +
        getPotentialWorlds in interface MVWorldManager
        +
        Returns:
        +
        A collection of world names that are deemed importable.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/utils/WorldNameChecker.FolderStatus.html b/javadoc/latest/com/onarandombox/MultiverseCore/utils/WorldNameChecker.FolderStatus.html new file mode 100644 index 000000000..4eabdd028 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/utils/WorldNameChecker.FolderStatus.html @@ -0,0 +1,403 @@ + + + + + +WorldNameChecker.FolderStatus (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.utils
+

Enum WorldNameChecker.FolderStatus

+
+
+
    +
  • java.lang.Object
    • +
  • + +
    • +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + + + + + + + + + + + +
      Enum Constants 
      Enum ConstantDescription
      DOES_NOT_EXIST +
      Folder does not exist.
      +
      NOT_A_WORLD +
      Folder exist, but contents in it doesnt look like a world.
      +
      VALID +
      Folder is valid.
      +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethodDescription
      static WorldNameChecker.FolderStatusvalueOf​(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static WorldNameChecker.FolderStatus[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static WorldNameChecker.FolderStatus[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (WorldNameChecker.FolderStatus c : WorldNameChecker.FolderStatus.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static WorldNameChecker.FolderStatus valueOf​(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/utils/WorldNameChecker.NameStatus.html b/javadoc/latest/com/onarandombox/MultiverseCore/utils/WorldNameChecker.NameStatus.html new file mode 100644 index 000000000..3ff828938 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/utils/WorldNameChecker.NameStatus.html @@ -0,0 +1,403 @@ + + + + + +WorldNameChecker.NameStatus (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.utils
+

Enum WorldNameChecker.NameStatus

+
+
+
    +
  • java.lang.Object
    • +
  • + +
    • +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + + + + + + + + + + + +
      Enum Constants 
      Enum ConstantDescription
      BLACKLISTED +
      Name not valid as it is deemed blacklisted.
      +
      INVALID_CHARS +
      Name not valid as it contains invalid characters.
      +
      VALID +
      Name is valid.
      +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethodDescription
      static WorldNameChecker.NameStatusvalueOf​(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static WorldNameChecker.NameStatus[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static WorldNameChecker.NameStatus[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (WorldNameChecker.NameStatus c : WorldNameChecker.NameStatus.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static WorldNameChecker.NameStatus valueOf​(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/utils/WorldNameChecker.html b/javadoc/latest/com/onarandombox/MultiverseCore/utils/WorldNameChecker.html new file mode 100644 index 000000000..cd0b70513 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/utils/WorldNameChecker.html @@ -0,0 +1,473 @@ + + + + + +WorldNameChecker (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.utils
+

Class WorldNameChecker

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.utils.WorldNameChecker
      • +
    +
    • +
+
+
    +
  • +
    +
    public class WorldNameChecker
+extends java.lang.Object
    +

    Utility class in helping to check the status of a world name and it's associated world folder.

    + +

    Note this is for preliminary checks and better command output. A valid result will suggest but not + 100% determine that a world name can be created, loaded or imported.

    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClassDescription
      static class WorldNameChecker.FolderStatus +
      Result after checking validity of world folder.
      +
      static class WorldNameChecker.NameStatus +
      Result after checking validity of world name.
      +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      WorldNameChecker() 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethodDescription
      static @NotNull WorldNameChecker.FolderStatuscheckFolder​(@Nullable java.io.File worldFolder) +
      Checks the current folder status.
      +
      static @NotNull WorldNameChecker.FolderStatuscheckFolder​(@Nullable java.lang.String worldName) +
      Checks the current folder status for a world name.
      +
      static @NotNull WorldNameChecker.NameStatuscheckName​(@Nullable java.lang.String worldName) +
      Checks the current validity status of a world name.
      +
      static booleanisValidWorldFolder​(@Nullable java.io.File worldFolder) +
      Checks if a world folder is valid.
      +
      static booleanisValidWorldFolder​(@Nullable java.lang.String worldName) +
      Checks if a world name has a valid world folder.
      +
      static booleanisValidWorldName​(@Nullable java.lang.String worldName) +
      Checks if a world name is valid.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        WorldNameChecker

        +
        public WorldNameChecker()
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        isValidWorldName

        +
        public static boolean isValidWorldName​(@Nullable
+                                       @Nullable java.lang.String worldName)
        +
        Checks if a world name is valid.
        +
        +
        Parameters:
        +
        worldName - The world name to check on.
        +
        Returns:
        +
        True if check result is valid, else false.
        +
        +
        • +
      + + + +
        +
      • +

        checkName

        +
        @NotNull
+public static @NotNull WorldNameChecker.NameStatus checkName​(@Nullable
+                                                             @Nullable java.lang.String worldName)
        +
        Checks the current validity status of a world name.
        +
        +
        Parameters:
        +
        worldName - The world name to check on.
        +
        Returns:
        +
        The resulting name status.
        +
        +
        • +
      + + + +
        +
      • +

        isValidWorldFolder

        +
        public static boolean isValidWorldFolder​(@Nullable
+                                         @Nullable java.lang.String worldName)
        +
        Checks if a world name has a valid world folder.
        +
        +
        Parameters:
        +
        worldName - The world name to check on.
        +
        Returns:
        +
        True if check result is valid, else false.
        +
        +
        • +
      + + + +
        +
      • +

        isValidWorldFolder

        +
        public static boolean isValidWorldFolder​(@Nullable
+                                         @Nullable java.io.File worldFolder)
        +
        Checks if a world folder is valid.
        +
        +
        Parameters:
        +
        worldFolder - The world folder to check on.
        +
        Returns:
        +
        True if check result is valid, else false.
        +
        +
        • +
      + + + +
        +
      • +

        checkFolder

        +
        @NotNull
+public static @NotNull WorldNameChecker.FolderStatus checkFolder​(@Nullable
+                                                                 @Nullable java.lang.String worldName)
        +
        Checks the current folder status for a world name.
        +
        +
        Parameters:
        +
        worldName - The world name to check on.
        +
        Returns:
        +
        The resulting folder status.
        +
        +
        • +
      + + + +
        +
      • +

        checkFolder

        +
        @NotNull
+public static @NotNull WorldNameChecker.FolderStatus checkFolder​(@Nullable
+                                                                 @Nullable java.io.File worldFolder)
        +
        Checks the current folder status.
        +
        +
        Parameters:
        +
        worldFolder - The world folder to check on.
        +
        Returns:
        +
        The resulting folder status.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/utils/metrics/MetricsConfigurator.html b/javadoc/latest/com/onarandombox/MultiverseCore/utils/metrics/MetricsConfigurator.html new file mode 100644 index 000000000..fbc27dd9a --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/utils/metrics/MetricsConfigurator.html @@ -0,0 +1,264 @@ + + + + + +MetricsConfigurator (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.utils.metrics
+

Class MetricsConfigurator

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.utils.metrics.MetricsConfigurator
      • +
    +
    • +
+
+
    +
  • +
    +
    public class MetricsConfigurator
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + +
    + +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        configureMetrics

        +
        public static void configureMetrics​(MultiverseCore plugin)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/utils/metrics/package-summary.html b/javadoc/latest/com/onarandombox/MultiverseCore/utils/metrics/package-summary.html new file mode 100644 index 000000000..7b91c2fc3 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/utils/metrics/package-summary.html @@ -0,0 +1,164 @@ + + + + + +com.onarandombox.MultiverseCore.utils.metrics (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+
+
+

Package com.onarandombox.MultiverseCore.utils.metrics

+
+
+ +
+
+ + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/utils/metrics/package-tree.html b/javadoc/latest/com/onarandombox/MultiverseCore/utils/metrics/package-tree.html new file mode 100644 index 000000000..c70d68dcd --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/utils/metrics/package-tree.html @@ -0,0 +1,161 @@ + + + + + +com.onarandombox.MultiverseCore.utils.metrics Class Hierarchy (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package com.onarandombox.MultiverseCore.utils.metrics

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+ +
+
+
+ + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/utils/package-summary.html b/javadoc/latest/com/onarandombox/MultiverseCore/utils/package-summary.html new file mode 100644 index 000000000..5a13a253a --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/utils/package-summary.html @@ -0,0 +1,354 @@ + + + + + +com.onarandombox.MultiverseCore.utils (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+
+
+

Package com.onarandombox.MultiverseCore.utils

+
+
+
+ + +
This package contains all Utility-clases.
+
+ +
+
+ + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/utils/package-tree.html b/javadoc/latest/com/onarandombox/MultiverseCore/utils/package-tree.html new file mode 100644 index 000000000..028a8f9cb --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/utils/package-tree.html @@ -0,0 +1,207 @@ + + + + + +com.onarandombox.MultiverseCore.utils Class Hierarchy (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package com.onarandombox.MultiverseCore.utils

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+ +
+
+

Enum Hierarchy

+ +
+
+
+ + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/utils/webpaste/PasteFailedException.html b/javadoc/latest/com/onarandombox/MultiverseCore/utils/webpaste/PasteFailedException.html new file mode 100644 index 000000000..7c2d4e3ec --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/utils/webpaste/PasteFailedException.html @@ -0,0 +1,305 @@ + + + + + +PasteFailedException (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.utils.webpaste
+

Class PasteFailedException

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • java.lang.Throwable
      • +
    • +
        +
      • java.lang.Exception
        • +
      • +
          +
        • com.onarandombox.MultiverseCore.utils.webpaste.PasteFailedException
          • +
        +
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    public class PasteFailedException
+extends java.lang.Exception
    +
    Thrown when pasting fails.
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PasteFailedException

        +
        public PasteFailedException()
        +
        • +
      + + + +
        +
      • +

        PasteFailedException

        +
        public PasteFailedException​(java.lang.Throwable cause)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/utils/webpaste/PasteService.html b/javadoc/latest/com/onarandombox/MultiverseCore/utils/webpaste/PasteService.html new file mode 100644 index 000000000..6cd53979a --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/utils/webpaste/PasteService.html @@ -0,0 +1,335 @@ + + + + + +PasteService (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.utils.webpaste
+

Class PasteService

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.utils.webpaste.PasteService
      • +
    +
    • +
+
+
    +
  • +
    +
    public abstract class PasteService
+extends java.lang.Object
    +
    An interface to a web-based text-pasting service. Classes extending this + should implement its methods to send data to an online text-sharing service, + such as pastebin.com. Given some PasteService instance ps, a paste is accomplished by: + + ps.postData(someString); + + Services that provide a distinction between "public" and "private" pastes + should implement a constructor that specifies which kind the PasteService + instance is submitting; an example of this is the PastebinPasteService class.
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethodDescription
      abstract java.lang.StringpostData​(java.lang.String data) +
      Post data to the Web.
      +
      abstract java.lang.StringpostData​(java.util.Map<java.lang.String,​java.lang.String> data) +
      Post data to the Web.
      +
      abstract booleansupportsMultiFile() +
      Does this service support uploading multiple files.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        postData

        +
        public abstract java.lang.String postData​(java.lang.String data)
+                                   throws PasteFailedException
        +
        Post data to the Web.
        +
        +
        Parameters:
        +
        data - A String to post to the web.
        +
        Returns:
        +
        The URL at which the new paste is visible.
        +
        Throws:
        +
        PasteFailedException - When pasting/posting the data failed.
        +
        +
        • +
      + + + +
        +
      • +

        postData

        +
        public abstract java.lang.String postData​(java.util.Map<java.lang.String,​java.lang.String> data)
+                                   throws PasteFailedException
        +
        Post data to the Web.
        +
        +
        Parameters:
        +
        data - A Map to post to the web.
        +
        Returns:
        +
        The URL at which the new paste is visible.
        +
        Throws:
        +
        PasteFailedException - When pasting/posting the data failed.
        +
        +
        • +
      + + + +
        +
      • +

        supportsMultiFile

        +
        public abstract boolean supportsMultiFile()
        +
        Does this service support uploading multiple files. + + Newer services like GitHub's Gist support multi-file pastes, + which allows us to upload configs in addition to the standard logs.
        +
        +
        Returns:
        +
        True if this service supports multiple file upload.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/utils/webpaste/PasteServiceFactory.html b/javadoc/latest/com/onarandombox/MultiverseCore/utils/webpaste/PasteServiceFactory.html new file mode 100644 index 000000000..dd490370e --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/utils/webpaste/PasteServiceFactory.html @@ -0,0 +1,277 @@ + + + + + +PasteServiceFactory (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.utils.webpaste
+

Class PasteServiceFactory

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.utils.webpaste.PasteServiceFactory
      • +
    +
    • +
+
+
    +
  • +
    +
    public class PasteServiceFactory
+extends java.lang.Object
    +
    Used to construct PasteServices.
    +
    • +
+
+
+ +
+
+ +
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/utils/webpaste/PasteServiceType.html b/javadoc/latest/com/onarandombox/MultiverseCore/utils/webpaste/PasteServiceType.html new file mode 100644 index 000000000..b537b5e1c --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/utils/webpaste/PasteServiceType.html @@ -0,0 +1,424 @@ + + + + + +PasteServiceType (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.utils.webpaste
+

Enum PasteServiceType

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • java.lang.Enum<PasteServiceType>
      • +
    • +
        +
      • com.onarandombox.MultiverseCore.utils.webpaste.PasteServiceType
        • +
      +
      • +
    +
    • +
+
+ +
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethodDescription
      static PasteServiceTypevalueOf​(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static PasteServiceType[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Enum Constant Detail

      + + + +
        +
      • +

        PASTEGG

        +
        public static final PasteServiceType PASTEGG
        +
        +
        See Also:
        +
        PasteGGPasteService
        +
        +
        • +
      + + + +
        +
      • +

        PASTEBIN

        +
        public static final PasteServiceType PASTEBIN
        +
        +
        See Also:
        +
        PastebinPasteService
        +
        +
        • +
      + + + +
        +
      • +

        HASTEBIN

        +
        public static final PasteServiceType HASTEBIN
        +
        +
        See Also:
        +
        HastebinPasteService
        +
        +
        • +
      + + + +
        +
      • +

        GITHUB

        +
        public static final PasteServiceType GITHUB
        +
        +
        See Also:
        +
        GitHubPasteService
        +
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static PasteServiceType[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (PasteServiceType c : PasteServiceType.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static PasteServiceType valueOf​(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/utils/webpaste/URLShortener.html b/javadoc/latest/com/onarandombox/MultiverseCore/utils/webpaste/URLShortener.html new file mode 100644 index 000000000..176477264 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/utils/webpaste/URLShortener.html @@ -0,0 +1,280 @@ + + + + + +URLShortener (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.utils.webpaste
+

Class URLShortener

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.utils.webpaste.URLShortener
      • +
    +
    • +
+
+
    +
  • +
    +
    public abstract class URLShortener
+extends java.lang.Object
    +
    An interface to a web-based URL Shortener. Classes extending this should + implement its methods to shorten links using the service. Given some + URLShortener instance us, a URL is shortened by: + + us.shorten(longUrl); + + An example of this, is the BitlyURLShortener.
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethodDescription
      abstract java.lang.Stringshorten​(java.lang.String longUrl) +
      Shorten a URL.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        shorten

        +
        public abstract java.lang.String shorten​(java.lang.String longUrl)
        +
        Shorten a URL.
        +
        +
        Parameters:
        +
        longUrl - The long form.
        +
        Returns:
        +
        The shortened URL.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/utils/webpaste/URLShortenerFactory.html b/javadoc/latest/com/onarandombox/MultiverseCore/utils/webpaste/URLShortenerFactory.html new file mode 100644 index 000000000..9161fc752 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/utils/webpaste/URLShortenerFactory.html @@ -0,0 +1,274 @@ + + + + + +URLShortenerFactory (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.utils.webpaste
+

Class URLShortenerFactory

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.onarandombox.MultiverseCore.utils.webpaste.URLShortenerFactory
      • +
    +
    • +
+
+
    +
  • +
    +
    public class URLShortenerFactory
+extends java.lang.Object
    +
    Used to construct URLShorteners.
    +
    • +
+
+
+ +
+
+ +
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/utils/webpaste/URLShortenerType.html b/javadoc/latest/com/onarandombox/MultiverseCore/utils/webpaste/URLShortenerType.html new file mode 100644 index 000000000..ab9013b5e --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/utils/webpaste/URLShortenerType.html @@ -0,0 +1,373 @@ + + + + + +URLShortenerType (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package com.onarandombox.MultiverseCore.utils.webpaste
+

Enum URLShortenerType

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • java.lang.Enum<URLShortenerType>
      • +
    • +
        +
      • com.onarandombox.MultiverseCore.utils.webpaste.URLShortenerType
        • +
      +
      • +
    +
    • +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + + + +
      Enum Constants 
      Enum ConstantDescription
      BITLY 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethodDescription
      static URLShortenerTypevalueOf​(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static URLShortenerType[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Enum Constant Detail

      + + + +
        +
      • +

        BITLY

        +
        public static final URLShortenerType BITLY
        +
        +
        See Also:
        +
        BitlyURLShortener
        +
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static URLShortenerType[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (URLShortenerType c : URLShortenerType.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static URLShortenerType valueOf​(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/utils/webpaste/package-summary.html b/javadoc/latest/com/onarandombox/MultiverseCore/utils/webpaste/package-summary.html new file mode 100644 index 000000000..2fdaf99d3 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/utils/webpaste/package-summary.html @@ -0,0 +1,229 @@ + + + + + +com.onarandombox.MultiverseCore.utils.webpaste (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+
+
+

Package com.onarandombox.MultiverseCore.utils.webpaste

+
+
+
+ + +
This package contains webpaste-utilities.
+
+ +
+
+ + + diff --git a/javadoc/latest/com/onarandombox/MultiverseCore/utils/webpaste/package-tree.html b/javadoc/latest/com/onarandombox/MultiverseCore/utils/webpaste/package-tree.html new file mode 100644 index 000000000..40c942ce7 --- /dev/null +++ b/javadoc/latest/com/onarandombox/MultiverseCore/utils/webpaste/package-tree.html @@ -0,0 +1,188 @@ + + + + + +com.onarandombox.MultiverseCore.utils.webpaste Class Hierarchy (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package com.onarandombox.MultiverseCore.utils.webpaste

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+
    +
  • java.lang.Object +
      +
    • com.onarandombox.MultiverseCore.utils.webpaste.PasteService
      • +
    • com.onarandombox.MultiverseCore.utils.webpaste.PasteServiceFactory
      • +
    • java.lang.Throwable (implements java.io.Serializable) + +
      • +
    • com.onarandombox.MultiverseCore.utils.webpaste.URLShortener
      • +
    • com.onarandombox.MultiverseCore.utils.webpaste.URLShortenerFactory
      • +
    +
    • +
+
+
+

Enum Hierarchy

+
    +
  • java.lang.Object +
      +
    • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) + +
      • +
    +
    • +
+
+
+
+ + + diff --git a/javadoc/latest/constant-values.html b/javadoc/latest/constant-values.html new file mode 100644 index 000000000..27a6a653c --- /dev/null +++ b/javadoc/latest/constant-values.html @@ -0,0 +1,200 @@ + + + + + +Constant Field Values (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+
+
+

Constant Field Values

+
+

Contents

+ +
+
+
+ + +
+

com.onarandombox.*

+
    +
  • + + + + + + + + + + + + + + +
    com.onarandombox.MultiverseCore.destination.BedDestination 
    Modifier and TypeConstant FieldValue
    + +public static final java.lang.StringOWN_BED_STRING"playerbed"
    +
    • +
+
    +
  • + + + + + + + + + + + + + + +
    com.onarandombox.MultiverseCore.display.ContentDisplay<T> 
    Modifier and TypeConstant FieldValue
    + +public static final java.lang.StringLINE_BREAK"%br%"
    +
    • +
+
+
+
+ + + diff --git a/javadoc/latest/deprecated-list.html b/javadoc/latest/deprecated-list.html new file mode 100644 index 000000000..39df7d3df --- /dev/null +++ b/javadoc/latest/deprecated-list.html @@ -0,0 +1,441 @@ + + + + + +Deprecated List (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+
+
+

Deprecated API

+

Contents

+ +
+
+ + + + + + + + + + + +
+
+ + + diff --git a/javadoc/latest/element-list b/javadoc/latest/element-list new file mode 100644 index 000000000..27b0e38a3 --- /dev/null +++ b/javadoc/latest/element-list @@ -0,0 +1,16 @@ +com.onarandombox.MultiverseCore +com.onarandombox.MultiverseCore.api +com.onarandombox.MultiverseCore.commands +com.onarandombox.MultiverseCore.commandtools.queue +com.onarandombox.MultiverseCore.configuration +com.onarandombox.MultiverseCore.destination +com.onarandombox.MultiverseCore.display +com.onarandombox.MultiverseCore.display.handlers +com.onarandombox.MultiverseCore.display.settings +com.onarandombox.MultiverseCore.enums +com.onarandombox.MultiverseCore.event +com.onarandombox.MultiverseCore.exceptions +com.onarandombox.MultiverseCore.listeners +com.onarandombox.MultiverseCore.utils +com.onarandombox.MultiverseCore.utils.metrics +com.onarandombox.MultiverseCore.utils.webpaste diff --git a/javadoc/latest/help-doc.html b/javadoc/latest/help-doc.html new file mode 100644 index 000000000..5ccd3def8 --- /dev/null +++ b/javadoc/latest/help-doc.html @@ -0,0 +1,272 @@ + + + + + +API Help (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+
+
+

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. These pages may contain six categories:

    +
      +
    • Interfaces
      • +
    • Classes
      • +
    • Enums
      • +
    • Exceptions
      • +
    • Errors
      • +
    • Annotation Types
      • +
    +
    +
    • +
  • +
    +

    Class or 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:

    +
      +
    • Class Inheritance Diagram
      • +
    • Direct Subclasses
      • +
    • All Known Subinterfaces
      • +
    • All Known Implementing Classes
      • +
    • Class or Interface Declaration
      • +
    • Class or Interface Description
      • +
    +
    +
      +
    • Nested Class Summary
      • +
    • Field Summary
      • +
    • Property Summary
      • +
    • Constructor Summary
      • +
    • Method Summary
      • +
    +
    +
      +
    • Field Detail
      • +
    • Property Detail
      • +
    • Constructor Detail
      • +
    • Method Detail
      • +
    +

    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:

    +
      +
    • Annotation Type Declaration
      • +
    • Annotation Type Description
      • +
    • Required Element Summary
      • +
    • Optional Element Summary
      • +
    • Element Detail
      • +
    +
    +
    • +
  • +
    +

    Enum

    +

    Each enum has its own separate page with the following sections:

    +
      +
    • Enum Declaration
      • +
    • Enum Description
      • +
    • Enum Constant Summary
      • +
    • Enum Constant Detail
      • +
    +
    +
    • +
  • +
    +

    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. Classes are organized by inheritance structure starting with java.lang.Object. Interfaces do not inherit from java.lang.Object.

    +
      +
    • When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
      • +
    • When viewing a particular package, class or interface page, clicking on "Tree" displays the hierarchy for only that package.
      • +
    +
    +
    • +
  • +
    +

    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 index of all classes, interfaces, constructors, methods, and fields, as well as lists of all packages and all classes.

    +
    +
    • +
  • +
    +

    All Classes

    +

    The All Classes link shows all classes and interfaces except non-static nested types.

    +
    +
    • +
  • +
    +

    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.

    +
    +
    • +
  • +
    +

    Search

    +

    You can search for definitions of modules, packages, types, fields, methods and other terms defined in the API, using some or all of the name. "Camel-case" abbreviations are supported: for example, "InpStr" will find "InputStream" and "InputStreamReader".

    +
    +
    • +
+
+This help file applies to API documentation generated by the standard doclet.
+
+ + + diff --git a/javadoc/latest/index-all.html b/javadoc/latest/index-all.html new file mode 100644 index 000000000..1991ac9c6 --- /dev/null +++ b/javadoc/latest/index-all.html @@ -0,0 +1,5283 @@ + + + + + +Index (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+
+
A B C D E F G H I L M N O P Q R S T U V W Y 
All Classes All Packages + + +

A

+
+
Action - Enum in com.onarandombox.MultiverseCore.enums
+
+
A enum containing all actions that can be used to modify world-properties.
+
+
Add - com.onarandombox.MultiverseCore.enums.Action
+
+
Adding something to a list-property.
+
+
addConfig(String) - Method in class com.onarandombox.MultiverseCore.event.MVConfigReloadEvent
+
+
Adds a config to this event.
+
+
addPermission(String, PermissionDefault) - Method in class com.onarandombox.MultiverseCore.utils.MVPermissions
+
+
Adds a permission.
+
+
addPlayerToTeleportQueue(String, String) - Static method in class com.onarandombox.MultiverseCore.MultiverseCore
+
+
This method is used to add a teleportation to the teleportQueue.
+
+
AddProperties - Enum in com.onarandombox.MultiverseCore.enums
+
+
An enum containing all list-properties.
+
+
addToParentPerms(String) - Method in class com.onarandombox.MultiverseCore.utils.PermissionTools
+
+
Adds a permission to the parent-permissions.
+
+
addToQueue(QueuedCommand) - Method in class com.onarandombox.MultiverseCore.commandtools.queue.CommandQueueManager
+
+
Adds a QueuedCommand into queue.
+
+
addToVariable(String, String) - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Deprecated. +
We changed the entire world-config-system. This is not compatible any more.
+
+
+
addToVariable(String, String) - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Deprecated. +
This is deprecated.
+
+
+
addWorld(String, World.Environment, String, WorldType, Boolean, String) - Method in interface com.onarandombox.MultiverseCore.api.MVWorldManager
+
+
Add a new World to the Multiverse Setup.
+
+
addWorld(String, World.Environment, String, WorldType, Boolean, String) - Method in class com.onarandombox.MultiverseCore.utils.WorldManager
+
+
Add a new World to the Multiverse Setup.
+
+
addWorld(String, World.Environment, String, WorldType, Boolean, String, boolean) - Method in interface com.onarandombox.MultiverseCore.api.MVWorldManager
+
+
Add a new World to the Multiverse Setup.
+
+
addWorld(String, World.Environment, String, WorldType, Boolean, String, boolean) - Method in class com.onarandombox.MultiverseCore.utils.WorldManager
+
+
Add a new World to the Multiverse Setup.
+
+
ALL - com.onarandombox.MultiverseCore.enums.AllowedPortalType
+
+
All portal types are allowed.
+
+
AllowedPortalType - Enum in com.onarandombox.MultiverseCore.enums
+
+
Custom enum that adds all/none for allowing portal creation.
+
+
allowPortalMaking(AllowedPortalType) - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Sets The types of portals that are allowed in this world.
+
+
allowPortalMaking(AllowedPortalType) - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Sets The types of portals that are allowed in this world.
+
+
allowPortalMaking(AllowedPortalType) - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
ANCHOR - com.onarandombox.MultiverseCore.enums.RespawnType
+
 
+
AnchorCommand - Class in com.onarandombox.MultiverseCore.commands
+
+
Allows management of Anchor Destinations.
+
+
AnchorCommand(MultiverseCore) - Constructor for class com.onarandombox.MultiverseCore.commands.AnchorCommand
+
 
+
AnchorDestination - Class in com.onarandombox.MultiverseCore.destination
+
+
An anchor-MVDestination.
+
+
AnchorDestination() - Constructor for class com.onarandombox.MultiverseCore.destination.AnchorDestination
+
 
+
AnchorManager - Class in com.onarandombox.MultiverseCore.utils
+
+
Manages anchors.
+
+
AnchorManager(MultiverseCore) - Constructor for class com.onarandombox.MultiverseCore.utils.AnchorManager
+
 
+
animals - com.onarandombox.MultiverseCore.enums.AddProperties
+
+
Animal-exceptions.
+
+
appendText(String) - Method in class com.onarandombox.MultiverseCore.utils.FancyHeader
+
+
Appends text to this FancyHeader.
+
+
appendVersionInfo(String) - Method in class com.onarandombox.MultiverseCore.event.MVVersionEvent
+
+
Appends more version-info to the version-info currently saved in this event.
+
+
AQUA - com.onarandombox.MultiverseCore.enums.EnglishChatColor
+
 
+
AsyncChatEvent - Class in com.onarandombox.MultiverseCore.listeners
+
+
A wrapper for the AsyncPlayerChatEvent.
+
+
AsyncChatEvent(AsyncPlayerChatEvent) - Constructor for class com.onarandombox.MultiverseCore.listeners.AsyncChatEvent
+
 
+
+ + + +

B

+
+
BED - com.onarandombox.MultiverseCore.enums.RespawnType
+
 
+
BedDestination - Class in com.onarandombox.MultiverseCore.destination
+
+
A bed-MVDestination.
+
+
BedDestination() - Constructor for class com.onarandombox.MultiverseCore.destination.BedDestination
+
 
+
BITLY - com.onarandombox.MultiverseCore.utils.webpaste.URLShortenerType
+
 
+
BLACK - com.onarandombox.MultiverseCore.enums.EnglishChatColor
+
 
+
BLACKLISTED - com.onarandombox.MultiverseCore.utils.WorldNameChecker.NameStatus
+
+
Name not valid as it is deemed blacklisted.
+
+
BlockSafety - Interface in com.onarandombox.MultiverseCore.api
+
+
Used to get block/location-related information.
+
+
BLUE - com.onarandombox.MultiverseCore.enums.EnglishChatColor
+
 
+
BOLD - com.onarandombox.MultiverseCore.enums.EnglishChatStyle
+
 
+
build() - Method in class com.onarandombox.MultiverseCore.display.ContentDisplay.Builder
+
+
Validates and build the content display.
+
+
BukkitTravelAgent - Class in com.onarandombox.MultiverseCore.utils
+
 
+
BukkitTravelAgent(MVTravelAgent) - Constructor for class com.onarandombox.MultiverseCore.utils.BukkitTravelAgent
+
 
+
+ + + +

C

+
+
cacheVirtualProperties() - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
+
This prepares the MVWorld for unloading.
+
+
canAnimalsSpawn() - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Gets whether or not animals are allowed to spawn in this world.
+
+
canAnimalsSpawn() - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Gets whether or not animals are allowed to spawn in this world.
+
+
canAnimalsSpawn() - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
canEnterDestination(CommandSender, MVDestination) - Method in class com.onarandombox.MultiverseCore.utils.MVPermissions
+
+
Check to see if a sender can enter a destination.
+
+
canEnterWorld(Player, MultiverseWorld) - Method in class com.onarandombox.MultiverseCore.utils.MVPermissions
+
+
Check if the Player has the permissions to enter this world.
+
+
canIgnoreGameModeRestriction(Player, MultiverseWorld) - Method in class com.onarandombox.MultiverseCore.utils.MVPermissions
+
+
Check if a Player can ignore GameMode restrictions for world they travel to.
+
+
canMonstersSpawn() - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Gets whether or not monsters are allowed to spawn in this world.
+
+
canMonstersSpawn() - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Gets whether or not monsters are allowed to spawn in this world.
+
+
canMonstersSpawn() - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
CannonDestination - Class in com.onarandombox.MultiverseCore.destination
+
+
A cannon-MVDestination.
+
+
CannonDestination() - Constructor for class com.onarandombox.MultiverseCore.destination.CannonDestination
+
 
+
canSpawnCartSafely(Minecart) - Method in interface com.onarandombox.MultiverseCore.api.BlockSafety
+
+
Checks if the specified Minecart can spawn safely.
+
+
canSpawnCartSafely(Minecart) - Method in class com.onarandombox.MultiverseCore.utils.SimpleBlockSafety
+
+
Checks if the specified Minecart can spawn safely.
+
+
canSpawnVehicleSafely(Vehicle) - Method in interface com.onarandombox.MultiverseCore.api.BlockSafety
+
+
Checks if the specified Vehicle can spawn safely.
+
+
canSpawnVehicleSafely(Vehicle) - Method in class com.onarandombox.MultiverseCore.utils.SimpleBlockSafety
+
+
Checks if the specified Vehicle can spawn safely.
+
+
canTravelFromLocation(CommandSender, Location) - Method in class com.onarandombox.MultiverseCore.utils.MVPermissions
+
+
Checks if the specified CommandSender can travel to the specified Location.
+
+
canTravelFromWorld(Player, MultiverseWorld) - Method in class com.onarandombox.MultiverseCore.utils.MVPermissions
+
+
Check if a Player can teleport to the Destination world from there current world.
+
+
canUseThisPortal() - Method in class com.onarandombox.MultiverseCore.event.MVPlayerTouchedPortalEvent
+
+
Gets whether or not the player in this event can use this portal.
+
+
ChatEvent - Interface in com.onarandombox.MultiverseCore.listeners
+
+
A wrapper for the two chat-events in Bukkit.
+
+
CheckCommand - Class in com.onarandombox.MultiverseCore.commands
+
+
Checks to see if a player can go to a destination.
+
+
CheckCommand(MultiverseCore) - Constructor for class com.onarandombox.MultiverseCore.commands.CheckCommand
+
 
+
checkFolder(File) - Static method in class com.onarandombox.MultiverseCore.utils.WorldNameChecker
+
+
Checks the current folder status.
+
+
checkFolder(String) - Static method in class com.onarandombox.MultiverseCore.utils.WorldNameChecker
+
+
Checks the current folder status for a world name.
+
+
checkMatch(Object) - Method in class com.onarandombox.MultiverseCore.display.ContentFilter
+
+
Do regex matching.
+
+
checkName(String) - Static method in class com.onarandombox.MultiverseCore.utils.WorldNameChecker
+
+
Checks the current validity status of a world name.
+
+
cleanFilter(String) - Method in class com.onarandombox.MultiverseCore.commands.PaginatedCommand
+
+
Escape regex special characters from filter
+
+
Clear - com.onarandombox.MultiverseCore.enums.Action
+
+
Clearing a list-property.
+
+
clearList(String) - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Deprecated. +
We changed the entire world-config-system. This is not compatible any more.
+
+
+
clearList(String) - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Deprecated. +
This is deprecated.
+
+
+
clearVariable(String) - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Deprecated. +
We changed the entire world-config-system. This is not compatible any more.
+
+
+
clearVariable(String) - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Deprecated. +
This is deprecated.
+
+
+
clone() - Method in class com.onarandombox.MultiverseCore.MVWorld.NullLocation
+
 
+
CloneCommand - Class in com.onarandombox.MultiverseCore.commands
+
+
Creates a clone of a world.
+
+
CloneCommand(MultiverseCore) - Constructor for class com.onarandombox.MultiverseCore.commands.CloneCommand
+
 
+
cloneWorld(String, String) - Method in interface com.onarandombox.MultiverseCore.api.MVWorldManager
+
+
Make a copy of a world.
+
+
cloneWorld(String, String) - Method in class com.onarandombox.MultiverseCore.utils.WorldManager
+
+
Make a copy of a world.
+
+
cloneWorld(String, String, String) - Method in interface com.onarandombox.MultiverseCore.api.MVWorldManager
+
+
Deprecated. +
Use MVWorldManager.cloneWorld(String, String) instead.
+
+
+
cloneWorld(String, String, String) - Method in class com.onarandombox.MultiverseCore.MultiverseCore
+
+
NOT deprecated for the time as queued commands use this.
+
+
cloneWorld(String, String, String) - Method in class com.onarandombox.MultiverseCore.utils.WorldManager
+
+
Deprecated. +
Use WorldManager.cloneWorld(String, String) instead.
+
+
+
close() - Method in class com.onarandombox.MultiverseCore.utils.DebugLog
+
+
Deprecated.
+
Closes this DebugLog.
+
+
ColorAlternator - Class in com.onarandombox.MultiverseCore.display
+
+
Helper class to switch between 2 ChatColor.
+
+
ColorAlternator(ChatColor, ChatColor) - Constructor for class com.onarandombox.MultiverseCore.display.ColorAlternator
+
 
+
colorTool(ColorTool) - Method in class com.onarandombox.MultiverseCore.display.ContentDisplay.Builder
+
+
Sets the color tool used to make messages more colourful.
+
+
ColorTool - Interface in com.onarandombox.MultiverseCore.display
+
+
Tools to allow customisation.
+
+
com.onarandombox.MultiverseCore - package com.onarandombox.MultiverseCore
+
+
The "master"-package, containing everything related to Multiverse-Core.
+
+
com.onarandombox.MultiverseCore.api - package com.onarandombox.MultiverseCore.api
+
+
The Multiverse-API, containing lots of interfaces that can be quite useful for other + plugins when interacting with Multiverse.
+
+
com.onarandombox.MultiverseCore.commands - package com.onarandombox.MultiverseCore.commands
+
+
This package contains all Commands.
+
+
com.onarandombox.MultiverseCore.commandtools.queue - package com.onarandombox.MultiverseCore.commandtools.queue
+
+
Manager queuing of dangerous commands in need of confirmation.
+
+
com.onarandombox.MultiverseCore.configuration - package com.onarandombox.MultiverseCore.configuration
+
+
This package contains the Multiverse-configuration.
+
+
com.onarandombox.MultiverseCore.destination - package com.onarandombox.MultiverseCore.destination
+
+
This package contains all destination-types.
+
+
com.onarandombox.MultiverseCore.display - package com.onarandombox.MultiverseCore.display
+
 
+
com.onarandombox.MultiverseCore.display.handlers - package com.onarandombox.MultiverseCore.display.handlers
+
 
+
com.onarandombox.MultiverseCore.display.settings - package com.onarandombox.MultiverseCore.display.settings
+
 
+
com.onarandombox.MultiverseCore.enums - package com.onarandombox.MultiverseCore.enums
+
+
This package contains all enums.
+
+
com.onarandombox.MultiverseCore.event - package com.onarandombox.MultiverseCore.event
+
+
This package contains all events.
+
+
com.onarandombox.MultiverseCore.exceptions - package com.onarandombox.MultiverseCore.exceptions
+
+
This package contains all exceptions.
+
+
com.onarandombox.MultiverseCore.listeners - package com.onarandombox.MultiverseCore.listeners
+
+
This package contains all listeners.
+
+
com.onarandombox.MultiverseCore.utils - package com.onarandombox.MultiverseCore.utils
+
+
This package contains all Utility-clases.
+
+
com.onarandombox.MultiverseCore.utils.metrics - package com.onarandombox.MultiverseCore.utils.metrics
+
 
+
com.onarandombox.MultiverseCore.utils.webpaste - package com.onarandombox.MultiverseCore.utils.webpaste
+
+
This package contains webpaste-utilities.
+
+
CommandQueueManager - Class in com.onarandombox.MultiverseCore.commandtools.queue
+
+
Manages the queuing of dangerous commands that require /mv confirm before executing.
+
+
CommandQueueManager(MultiverseCore) - Constructor for class com.onarandombox.MultiverseCore.commandtools.queue.CommandQueueManager
+
 
+
CompatibilityLayer - Class in com.onarandombox.MultiverseCore.utils
+
+
Utility class to enable version specific minecraft features.
+
+
CompatibilityLayer() - Constructor for class com.onarandombox.MultiverseCore.utils.CompatibilityLayer
+
 
+
ConfigCommand - Class in com.onarandombox.MultiverseCore.commands
+
+
Allows you to set Global MV Variables.
+
+
ConfigCommand(MultiverseCore) - Constructor for class com.onarandombox.MultiverseCore.commands.ConfigCommand
+
 
+
configReload(MVConfigReloadEvent) - Method in class com.onarandombox.MultiverseCore.listeners.MultiverseCoreListener
+
+
Called when a MVConfigReloadEvent is fired.
+
+
configureMetrics(MultiverseCore) - Static method in class com.onarandombox.MultiverseCore.utils.metrics.MetricsConfigurator
+
 
+
ConfirmCommand - Class in com.onarandombox.MultiverseCore.commands
+
+
Confirms actions.
+
+
ConfirmCommand(MultiverseCore) - Constructor for class com.onarandombox.MultiverseCore.commands.ConfirmCommand
+
 
+
ContentDisplay<T> - Class in com.onarandombox.MultiverseCore.display
+
+
Helps to display contents such as list and maps in a nicely formatted fashion.
+
+
ContentDisplay.Builder<T> - Class in com.onarandombox.MultiverseCore.display
+
+
Builds a ContentDisplay.
+
+
ContentFilter - Class in com.onarandombox.MultiverseCore.display
+
+
Filter content and text based on regex matching.
+
+
ContentFilter(String) - Constructor for class com.onarandombox.MultiverseCore.display.ContentFilter
+
 
+
ContentFilter(String, boolean) - Constructor for class com.onarandombox.MultiverseCore.display.ContentFilter
+
 
+
convertConfigType(ConfigurationSection, String) - Static method in class com.onarandombox.MultiverseCore.utils.MaterialConverter
+
+
Converts the value in the given config at the given path from a numeric id or flattened material name to a + Material.
+
+
convertTypeString(String) - Static method in class com.onarandombox.MultiverseCore.utils.MaterialConverter
+
+
Converts a string representing a numeric id or flattened material name to a Material.
+
+
CoordCommand - Class in com.onarandombox.MultiverseCore.commands
+
+
Returns detailed information on the Players where abouts.
+
+
CoordCommand(MultiverseCore) - Constructor for class com.onarandombox.MultiverseCore.commands.CoordCommand
+
 
+
copyFolder(File, File) - Static method in class com.onarandombox.MultiverseCore.utils.FileUtils
+
+
Helper method to copy the world-folder.
+
+
copyFolder(File, File, List<String>) - Static method in class com.onarandombox.MultiverseCore.utils.FileUtils
+
+
Helper method to copy the world-folder.
+
+
copyValues(MVWorld) - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Copies all properties from another MVWorld object.
+
+
copyValues(WorldProperties) - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Copies all properties from a WorldProperties object.
+
+
copyValues(SerializationConfig) - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
core - Variable in class com.onarandombox.MultiverseCore.utils.MVTravelAgent
+
 
+
Core - Interface in com.onarandombox.MultiverseCore.api
+
+
Multiverse 2 Core API
+
+
CreateCommand - Class in com.onarandombox.MultiverseCore.commands
+
+
Creates a new world and loads it.
+
+
CreateCommand(MultiverseCore) - Constructor for class com.onarandombox.MultiverseCore.commands.CreateCommand
+
 
+
createPortal(Location) - Method in class com.onarandombox.MultiverseCore.utils.BukkitTravelAgent
+
creatureSpawn(CreatureSpawnEvent) - Method in class com.onarandombox.MultiverseCore.listeners.MVEntityListener
+
+
Handle Animal/Monster Spawn settings, seems like a more concrete method than using CraftBukkit.
+
+
CustomTeleporterDestination - Class in com.onarandombox.MultiverseCore.destination
+
 
+
CustomTeleporterDestination() - Constructor for class com.onarandombox.MultiverseCore.destination.CustomTeleporterDestination
+
 
+
+ + + +

D

+
+
DARKAQUA - com.onarandombox.MultiverseCore.enums.EnglishChatColor
+
 
+
DARKBLUE - com.onarandombox.MultiverseCore.enums.EnglishChatColor
+
 
+
DARKGRAY - com.onarandombox.MultiverseCore.enums.EnglishChatColor
+
 
+
DARKGREEN - com.onarandombox.MultiverseCore.enums.EnglishChatColor
+
 
+
DARKPURPLE - com.onarandombox.MultiverseCore.enums.EnglishChatColor
+
 
+
DARKRED - com.onarandombox.MultiverseCore.enums.EnglishChatColor
+
 
+
DebugCommand - Class in com.onarandombox.MultiverseCore.commands
+
+
Enables debug-information.
+
+
DebugCommand(MultiverseCore) - Constructor for class com.onarandombox.MultiverseCore.commands.DebugCommand
+
 
+
DebugLog - Class in com.onarandombox.MultiverseCore.utils
+
+
Deprecated. +
Deprecated in favor of new Logging lib. See Logging.
+
+
+
DebugLog(String, String) - Constructor for class com.onarandombox.MultiverseCore.utils.DebugLog
+
+
Deprecated.
+
Creates a new debug logger.
+
+
decrementPluginCount() - Method in interface com.onarandombox.MultiverseCore.api.Core
+
+
Decrements the number of plugins that have specifically hooked into core.
+
+
decrementPluginCount() - Method in class com.onarandombox.MultiverseCore.MultiverseCore
+
+
Decrements the number of plugins that have specifically hooked into core.
+
+
DEFAULT - Static variable in interface com.onarandombox.MultiverseCore.display.ColorTool
+
+
Default implementation of this interface.
+
+
DEFAULT - Static variable in class com.onarandombox.MultiverseCore.display.ContentFilter
+
 
+
defaultValue() - Method in interface com.onarandombox.MultiverseCore.display.settings.DisplaySetting
+
+
Gets the default value of this Display Setting.
+
+
deleteAnchor(String) - Method in class com.onarandombox.MultiverseCore.utils.AnchorManager
+
+
Deletes the specified anchor.
+
+
DeleteCommand - Class in com.onarandombox.MultiverseCore.commands
+
+
Deletes worlds.
+
+
DeleteCommand(MultiverseCore) - Constructor for class com.onarandombox.MultiverseCore.commands.DeleteCommand
+
 
+
deleteFolder(File) - Static method in class com.onarandombox.MultiverseCore.utils.FileUtils
+
+
Used to delete a folder.
+
+
deleteFolderContents(File) - Static method in class com.onarandombox.MultiverseCore.utils.FileUtils
+
+
Used to delete the contents of a folder, without deleting the folder itself.
+
+
deleteWorld(String) - Method in interface com.onarandombox.MultiverseCore.api.MVWorldManager
+
+
Remove the world from the Multiverse list, from the config and deletes + the folder.
+
+
deleteWorld(String) - Method in class com.onarandombox.MultiverseCore.MultiverseCore
+
+
NOT deprecated for the time as queued commands use this.
+
+
deleteWorld(String) - Method in class com.onarandombox.MultiverseCore.utils.WorldManager
+
+
Remove the world from the Multiverse list, from the config and deletes + the folder.
+
+
deleteWorld(String, boolean) - Method in interface com.onarandombox.MultiverseCore.api.MVWorldManager
+
+
Remove the world from the Multiverse list, from the + config if wanted, and deletes the folder.
+
+
deleteWorld(String, boolean) - Method in class com.onarandombox.MultiverseCore.utils.WorldManager
+
+
Remove the world from the Multiverse list, from the + config if wanted, and deletes the folder.
+
+
deleteWorld(String, boolean, boolean) - Method in interface com.onarandombox.MultiverseCore.api.MVWorldManager
+
 
+
deleteWorld(String, boolean, boolean) - Method in class com.onarandombox.MultiverseCore.utils.WorldManager
+
deposit(Player, double, Material) - Method in class com.onarandombox.MultiverseCore.utils.MVEconomist
+
+
Deposits a given amount of currency either into the player's economy account or inventory if the currency + is not null.
+
+
deserialize(Object, Class<Material>) - Method in class com.onarandombox.MultiverseCore.configuration.EntryFee.EntryFeeCurrencySerializor
+
 
+
deserialize(Map<String, Object>) - Static method in class com.onarandombox.MultiverseCore.configuration.SpawnLocation
+
+
Let Bukkit be able to deserialize this.
+
+
deserialize(Map<String, Object>) - Static method in class com.onarandombox.MultiverseCore.MVWorld.NullLocation
+
+
Let Bukkit be able to deserialize this.
+
+
destination - Variable in class com.onarandombox.MultiverseCore.utils.MVTravelAgent
+
 
+
DestinationFactory - Class in com.onarandombox.MultiverseCore.destination
+
+
A factory class that will create destinations from specific strings.
+
+
DestinationFactory(MultiverseCore) - Constructor for class com.onarandombox.MultiverseCore.destination.DestinationFactory
+
 
+
DisplayFormatException - Exception in com.onarandombox.MultiverseCore.display
+
+
Thrown when an issue occur while formatting content.
+
+
DisplayFormatException() - Constructor for exception com.onarandombox.MultiverseCore.display.DisplayFormatException
+
 
+
DisplayFormatException(String) - Constructor for exception com.onarandombox.MultiverseCore.display.DisplayFormatException
+
 
+
DisplayFormatException(String, Throwable) - Constructor for exception com.onarandombox.MultiverseCore.display.DisplayFormatException
+
 
+
DisplayFormatException(String, Throwable, boolean, boolean) - Constructor for exception com.onarandombox.MultiverseCore.display.DisplayFormatException
+
 
+
DisplayFormatException(Throwable) - Constructor for exception com.onarandombox.MultiverseCore.display.DisplayFormatException
+
 
+
displayHandler(DisplayHandler<T>) - Method in class com.onarandombox.MultiverseCore.display.ContentDisplay.Builder
+
+
Sets the display handler that does the formatting and sending of content.
+
+
DisplayHandler<T> - Interface in com.onarandombox.MultiverseCore.display
+
+
Handles the formatting and sending of all content by the ContentDisplay.
+
+
DisplayHandlers - Class in com.onarandombox.MultiverseCore.display
+
+
Various implementations of DisplayHandler.
+
+
DisplayHandlers() - Constructor for class com.onarandombox.MultiverseCore.display.DisplayHandlers
+
 
+
DisplaySetting<T> - Interface in com.onarandombox.MultiverseCore.display.settings
+
+
Represents a setting option that can be used by DisplayHandler.
+
+
DO_END_PADDING - Static variable in class com.onarandombox.MultiverseCore.display.settings.PagedDisplaySettings
+
+
Should add empty lines if content lines shown is less that PagedDisplaySettings.LINES_PER_PAGE.
+
+
DOES_NOT_EXIST - com.onarandombox.MultiverseCore.utils.WorldNameChecker.FolderStatus
+
+
Folder does not exist.
+
+
doSpawn() - Method in class com.onarandombox.MultiverseCore.configuration.SubSpawnSettings
+
 
+
dumpVersionInfo(String) - Method in class com.onarandombox.MultiverseCore.api.MultiversePlugin
+
 
+
dumpVersionInfo(String) - Method in interface com.onarandombox.MultiverseCore.api.MVPlugin
+
+
Deprecated. +
This is now deprecated, nobody needs it any longer. + All version info-dumping is now done with MVVersionEvent.
+
+
+
dumpVersionInfo(String) - Method in class com.onarandombox.MultiverseCore.MultiverseCore
+
+
Deprecated. +
This is now deprecated, nobody needs it any longer. + All version info-dumping is now done with MVVersionEvent.
+
+
+
+ + + +

E

+
+
emptyMessage(String, Object...) - Method in class com.onarandombox.MultiverseCore.display.ContentDisplay.Builder
+
+
Sets the message to show when no content is available for display.
+
+
enable() - Static method in class com.onarandombox.MultiverseCore.utils.TestingMode
+
 
+
END - com.onarandombox.MultiverseCore.enums.AllowedPortalType
+
+
Only Ender style portals are allowed.
+
+
EnglishChatColor - Enum in com.onarandombox.MultiverseCore.enums
+
+
A regular ChatColor represented by an english string.
+
+
EnglishChatStyle - Enum in com.onarandombox.MultiverseCore.enums
+
+
A regular ChatColor represented by an english string.
+
+
entityPortal(EntityPortalEvent) - Method in class com.onarandombox.MultiverseCore.listeners.MVEntityListener
+
+
Handles portal search radius adjustment.
+
+
entityPortalCreate(EntityCreatePortalEvent) - Method in class com.onarandombox.MultiverseCore.listeners.MVPortalListener
+
+
This is called when an entity creates a portal.
+
+
entityRegainHealth(EntityRegainHealthEvent) - Method in class com.onarandombox.MultiverseCore.listeners.MVEntityListener
+
+
This method is called when an entity's health goes up or down.
+
+
EntryFee - Class in com.onarandombox.MultiverseCore.configuration
+
+
Entryfee-settings.
+
+
EntryFee() - Constructor for class com.onarandombox.MultiverseCore.configuration.EntryFee
+
 
+
EntryFee(Map<String, Object>) - Constructor for class com.onarandombox.MultiverseCore.configuration.EntryFee
+
 
+
EntryFee.EntryFeeCurrencySerializor - Class in com.onarandombox.MultiverseCore.configuration
+
 
+
EntryFeeCurrencySerializor() - Constructor for class com.onarandombox.MultiverseCore.configuration.EntryFee.EntryFeeCurrencySerializor
+
 
+
EnvironmentCommand - Class in com.onarandombox.MultiverseCore.commands
+
+
Lists valid known environments.
+
+
EnvironmentCommand(MultiverseCore) - Constructor for class com.onarandombox.MultiverseCore.commands.EnvironmentCommand
+
 
+
ExactDestination - Class in com.onarandombox.MultiverseCore.destination
+
+
An exact MVDestination.
+
+
ExactDestination() - Constructor for class com.onarandombox.MultiverseCore.destination.ExactDestination
+
 
+
+ + + +

F

+
+
FAIL_INVALID - com.onarandombox.MultiverseCore.enums.TeleportResult
+
+
The teleport was invalid.
+
+
FAIL_OTHER - com.onarandombox.MultiverseCore.enums.TeleportResult
+
+
Unknown reason.
+
+
FAIL_PERMISSION - com.onarandombox.MultiverseCore.enums.TeleportResult
+
+
Insufficient permissions.
+
+
FAIL_TOO_POOR - com.onarandombox.MultiverseCore.enums.TeleportResult
+
+
The player was to poor.
+
+
FAIL_UNSAFE - com.onarandombox.MultiverseCore.enums.TeleportResult
+
+
The teleport was unsafe.
+
+
FancyColorScheme - Class in com.onarandombox.MultiverseCore.utils
+
+
A color-scheme.
+
+
FancyColorScheme(ChatColor, ChatColor, ChatColor, ChatColor) - Constructor for class com.onarandombox.MultiverseCore.utils.FancyColorScheme
+
 
+
FancyHeader - Class in com.onarandombox.MultiverseCore.utils
+
+
A colored text-header.
+
+
FancyHeader(String, FancyColorScheme) - Constructor for class com.onarandombox.MultiverseCore.utils.FancyHeader
+
 
+
FancyMessage - Class in com.onarandombox.MultiverseCore.utils
+
+
A colored text-message.
+
+
FancyMessage(String, String, FancyColorScheme) - Constructor for class com.onarandombox.MultiverseCore.utils.FancyMessage
+
+
Allows easy creation of an alternating colored list.
+
+
FancyText - Interface in com.onarandombox.MultiverseCore.api
+
+
A fancy text.
+
+
FileUtils - Class in com.onarandombox.MultiverseCore.utils
+
+
File-utilities.
+
+
FileUtils() - Constructor for class com.onarandombox.MultiverseCore.utils.FileUtils
+
 
+
filter(ContentFilter) - Method in class com.onarandombox.MultiverseCore.display.ContentDisplay.Builder
+
+
Sets content filter used to match specific content to be displayed.
+
+
FilterObject(Integer, String) - Constructor for class com.onarandombox.MultiverseCore.commands.PaginatedCommand.FilterObject
+
 
+
findOrCreate(Location) - Method in class com.onarandombox.MultiverseCore.utils.BukkitTravelAgent
+
findPortal(Location) - Method in class com.onarandombox.MultiverseCore.utils.BukkitTravelAgent
+
findPortalBlockNextTo(Location) - Method in interface com.onarandombox.MultiverseCore.api.SafeTTeleporter
+
+
Finds a portal-block next to the specified Location.
+
+
findPortalBlockNextTo(Location) - Method in class com.onarandombox.MultiverseCore.utils.SimpleSafeTTeleporter
+
+
Finds a portal-block next to the specified Location.
+
+
foodLevelChange(FoodLevelChangeEvent) - Method in class com.onarandombox.MultiverseCore.listeners.MVEntityListener
+
+
This method is called when an entity's food level goes higher or lower.
+
+
forContent(Collection<String>) - Static method in class com.onarandombox.MultiverseCore.display.ContentDisplay
+
+
Creates a ContentDisplay.Builder for the given collection of content.
+
+
forContent(Map<String, Object>) - Static method in class com.onarandombox.MultiverseCore.display.ContentDisplay
+
+
Creates a ContentDisplay.Builder for the given map of content.
+
+
forContent(T) - Static method in class com.onarandombox.MultiverseCore.display.ContentDisplay
+
+
Creates a ContentDisplay.Builder for the given content.
+
+
format(CommandSender, ContentDisplay<Collection<String>>) - Method in class com.onarandombox.MultiverseCore.display.handlers.InlineListDisplayHandler
+
 
+
format(CommandSender, ContentDisplay<Collection<String>>) - Method in class com.onarandombox.MultiverseCore.display.handlers.ListDisplayHandler
+
 
+
format(CommandSender, ContentDisplay<Collection<String>>) - Method in class com.onarandombox.MultiverseCore.display.handlers.PagedListDisplayHandler
+
 
+
format(CommandSender, ContentDisplay<Map<String, Object>>) - Method in class com.onarandombox.MultiverseCore.display.handlers.InlineMapDisplayHandler
+
 
+
format(CommandSender, ContentDisplay<T>) - Method in interface com.onarandombox.MultiverseCore.display.DisplayHandler
+
+
Formats the raw content into a Collection for displaying to the given sender.
+
+
formatPrice(double, Material) - Method in class com.onarandombox.MultiverseCore.utils.MVEconomist
+
+
Formats the amount to a human readable currency string.
+
+
fromString(String) - Static method in enum com.onarandombox.MultiverseCore.enums.EnglishChatColor
+
+
Constructs an EnglishChatColor from a String.
+
+
fromString(String) - Static method in enum com.onarandombox.MultiverseCore.enums.EnglishChatStyle
+
+
Constructs an EnglishChatStyle from a String.
+
+
+ + + +

G

+
+
GameruleCommand - Class in com.onarandombox.MultiverseCore.commands
+
+
Allows management of Anchor Destinations.
+
+
GameruleCommand(MultiverseCore) - Constructor for class com.onarandombox.MultiverseCore.commands.GameruleCommand
+
 
+
GamerulesCommand - Class in com.onarandombox.MultiverseCore.commands
+
+
Allows management of Anchor Destinations.
+
+
GamerulesCommand(MultiverseCore) - Constructor for class com.onarandombox.MultiverseCore.commands.GamerulesCommand
+
 
+
GeneratorCommand - Class in com.onarandombox.MultiverseCore.commands
+
+
Returns a list of loaded generator plugins.
+
+
GeneratorCommand(MultiverseCore) - Constructor for class com.onarandombox.MultiverseCore.commands.GeneratorCommand
+
 
+
get() - Method in class com.onarandombox.MultiverseCore.display.ColorAlternator
+
+
Gets the color.
+
+
get() - Method in interface com.onarandombox.MultiverseCore.display.ColorTool
+
+
Gets a chat color.
+
+
get(String, CommandSender) - Static method in class com.onarandombox.MultiverseCore.utils.PlayerFinder
+
+
Get a Player based on an identifier of name UUID or selector.
+
+
getAccessPermission() - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Gets the permission required to enter this world.
+
+
getAccessPermission() - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Gets the permission required to enter this world.
+
+
getActualPortalType() - Method in enum com.onarandombox.MultiverseCore.enums.AllowedPortalType
+
+
Gets the text.
+
+
getAdjustSpawn() - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Gets whether or not Multiverse should auto-adjust the spawn for this world.
+
+
getAdjustSpawn() - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Gets whether or not Multiverse should auto-adjust the spawn for this world.
+
+
getAdjustSpawn() - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
getAlias() - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Gets the alias of this world.
+
+
getAlias() - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Gets the alias of this world.
+
+
getAlias() - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
getAliases() - Static method in class com.onarandombox.MultiverseCore.WorldProperties
+
+
getAliases().
+
+
getAllAnchors() - Method in class com.onarandombox.MultiverseCore.utils.AnchorManager
+
+
Gets all anchors.
+
+
getAllColors() - Static method in enum com.onarandombox.MultiverseCore.enums.EnglishChatColor
+
+
Constructs a string containing all available colors.
+
+
getAllConfigsLoaded() - Method in class com.onarandombox.MultiverseCore.event.MVConfigReloadEvent
+
+
Gets all loaded configs.
+
+
getAllowedPortals() - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Gets which type(s) of portals are allowed to be constructed in this world.
+
+
getAllowedPortals() - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Gets which type(s) of portals are allowed to be constructed in this world.
+
+
getAllowedPortals() - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
getAllowFlight() - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Whether or not players are allowed to fly in this world.
+
+
getAllowFlight() - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Whether or not players are allowed to fly in this world.
+
+
getAllowFlight() - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
getAllPropertyNames() - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Gets all the names of all properties that can be SET.
+
+
getAllPropertyNames() - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Gets all the names of all properties that can be SET.
+
+
getAllPropertyNames() - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
getAlt() - Method in class com.onarandombox.MultiverseCore.utils.FancyColorScheme
+
+
Gets the alt ChatColor.
+
+
getAmount() - Method in class com.onarandombox.MultiverseCore.configuration.EntryFee
+
 
+
getAnchorLocation(String) - Method in class com.onarandombox.MultiverseCore.utils.AnchorManager
+
+
Gets the Location associated with an anchor.
+
+
getAnchorManager() - Method in interface com.onarandombox.MultiverseCore.api.Core
+
+
Gets the AnchorManager.
+
+
getAnchorManager() - Method in class com.onarandombox.MultiverseCore.MultiverseCore
+
+
Gets the AnchorManager.
+
+
getAnchors(Player) - Method in class com.onarandombox.MultiverseCore.utils.AnchorManager
+
+
Gets all anchors that the specified Player can access.
+
+
getAnimalList() - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Returns a list of animals.
+
+
getAnimalList() - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Returns a list of animals.
+
+
getAnimalList() - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
getAnimalSettings() - Method in class com.onarandombox.MultiverseCore.configuration.SpawnSettings
+
 
+
getAnimalSpawnRate() - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
getAuthors() - Method in interface com.onarandombox.MultiverseCore.api.Core
+
+
Parse the Authors Array into a readable String with ',' and 'and'.
+
+
getAuthors() - Method in class com.onarandombox.MultiverseCore.api.MultiversePlugin
+
+
Parse the Authors Array into a readable String with ',' and 'and'.
+
+
getAuthors() - Method in class com.onarandombox.MultiverseCore.MultiverseCore
+
+
Parse the Authors Array into a readable String with ',' and 'and'.
+
+
getAutoHeal() - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Gets whether or not a world will auto-heal players if the difficulty is on peaceful.
+
+
getAutoHeal() - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Gets whether or not a world will auto-heal players if the difficulty is on peaceful.
+
+
getAutoHeal() - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
getAutoLoad() - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Gets whether or not Multiverse should auto-load this world.
+
+
getAutoLoad() - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Gets whether or not Multiverse should auto-load this world.
+
+
getAutoLoad() - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
getBalance(Player) - Method in class com.onarandombox.MultiverseCore.utils.MVEconomist
+
+
Returns the economy balance of the given player.
+
+
getBalance(Player, World) - Method in class com.onarandombox.MultiverseCore.utils.MVEconomist
+
+
Returns the economy balance of the given player in the given world.
+
+
getBedRespawn() - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Gets whether or not a player who dies in this world will respawn in their + bed or follow the normal respawn pattern.
+
+
getBedRespawn() - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Gets whether or not a player who dies in this world will respawn in their + bed or follow the normal respawn pattern.
+
+
getBedRespawn() - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
getBlock() - Method in class com.onarandombox.MultiverseCore.configuration.SpawnLocation
+
getBlockLocation(Location) - Method in interface com.onarandombox.MultiverseCore.api.LocationManipulation
+
+
This method simply does some rounding, rather than forcing a call to the server to get the blockdata.
+
+
getBlockLocation(Location) - Static method in class com.onarandombox.MultiverseCore.utils.LocationManipulation
+
+
Deprecated.
+
This method simply does some rounding, rather than forcing a call to the server to get the blockdata.
+
+
getBlockLocation(Location) - Method in class com.onarandombox.MultiverseCore.utils.SimpleLocationManipulation
+
+
This method simply does some rounding, rather than forcing a call to the server to get the blockdata.
+
+
getBlockSafety() - Method in interface com.onarandombox.MultiverseCore.api.Core
+
+
Gets the BlockSafety this Core is using.
+
+
getBlockSafety() - Method in class com.onarandombox.MultiverseCore.MultiverseCore
+
+
Gets the BlockSafety this Core is using.
+
+
getBlockTouched() - Method in class com.onarandombox.MultiverseCore.event.MVPlayerTouchedPortalEvent
+
+
Gets the Location of the portal-block that was touched.
+
+
getBottomBlock(Location) - Method in interface com.onarandombox.MultiverseCore.api.BlockSafety
+
+
Gets the location of the top block at the specified Location.
+
+
getBottomBlock(Location) - Method in class com.onarandombox.MultiverseCore.utils.SimpleBlockSafety
+
+
Gets the location of the top block at the specified Location.
+
+
getByName(String) - Static method in class com.onarandombox.MultiverseCore.utils.PlayerFinder
+
+
Get a Player based on player name.
+
+
getBySelector(String, CommandSender) - Static method in class com.onarandombox.MultiverseCore.utils.PlayerFinder
+
+
Get a Player based on vanilla selectors.
+
+
getByUuid(String) - Static method in class com.onarandombox.MultiverseCore.utils.PlayerFinder
+
+
Get a Player based on player UUID.
+
+
getByUuid(UUID) - Static method in class com.onarandombox.MultiverseCore.utils.PlayerFinder
+
+
Get a Player based on playerUUID.
+
+
getCanCreatePortal() - Method in class com.onarandombox.MultiverseCore.utils.BukkitTravelAgent
+
getCBWorld() - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Returns the Bukkit world object that this world describes.
+
+
getCBWorld() - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Returns the Bukkit world object that this world describes.
+
+
getChatColor(boolean) - Method in class com.onarandombox.MultiverseCore.commands.InfoCommand
+
+
Gets a "positive" or "negative" ChatColor.
+
+
getChatListener() - Method in class com.onarandombox.MultiverseCore.MultiverseCore
+
+
Gets the MVChatListener.
+
+
getChunk() - Method in class com.onarandombox.MultiverseCore.configuration.SpawnLocation
+
getChunkGenerator(String, String, String) - Method in interface com.onarandombox.MultiverseCore.api.MVWorldManager
+
+
Test if a given chunk generator is valid.
+
+
getChunkGenerator(String, String, String) - Method in class com.onarandombox.MultiverseCore.utils.WorldManager
+
+
Test if a given chunk generator is valid.
+
+
getClass(String) - Static method in class com.onarandombox.MultiverseCore.utils.ReflectHelper
+
+
Try to get the Class based on its classpath.
+
+
getColor() - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Gets the color that this world's name/alias will display as.
+
+
getColor() - Method in enum com.onarandombox.MultiverseCore.enums.EnglishChatColor
+
+
Gets the color.
+
+
getColor() - Method in enum com.onarandombox.MultiverseCore.enums.EnglishChatStyle
+
+
Gets the color.
+
+
getColor() - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Gets the color that this world's name/alias will display as.
+
+
getColor() - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
getColoredWorldString() - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Returns a very nicely colored string (using Alias and Color if they are set).
+
+
getColoredWorldString() - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Returns a very nicely colored string (using Alias and Color if they are set).
+
+
getColorTool() - Method in class com.onarandombox.MultiverseCore.display.ContentDisplay
+
 
+
getCommandHandler() - Method in interface com.onarandombox.MultiverseCore.api.Core
+
+
Multiverse uses CommandHandler to make adding and using commands + a piece of cake.
+
+
getCommandHandler() - Method in class com.onarandombox.MultiverseCore.MultiverseCore
+
+
Multiverse uses CommandHandler to make adding and using commands + a piece of cake.
+
+
getCommandQueueManager() - Method in interface com.onarandombox.MultiverseCore.api.Core
+
+
Deprecated. +
To be moved to new command manager in 5.0.0
+
+
+
getCommandQueueManager() - Method in class com.onarandombox.MultiverseCore.MultiverseCore
+
+
Deprecated.
+
+
getCommandSender() - Method in class com.onarandombox.MultiverseCore.event.MVWorldPropertyChangeEvent
+
+
Gets the person (or console) who was responsible for the change.
+
+
getConfigWorlds() - Method in class com.onarandombox.MultiverseCore.utils.WorldManager
+
+
Gets the FileConfiguration that this WorldManager is using.
+
+
getContents() - Method in class com.onarandombox.MultiverseCore.display.ContentDisplay
+
 
+
getCooldown() - Method in interface com.onarandombox.MultiverseCore.api.MultiverseMessaging
+
+
Gets the message-cooldown.
+
+
getCooldown() - Method in class com.onarandombox.MultiverseCore.utils.MVMessaging
+
+
Gets the message-cooldown.
+
+
getCore() - Method in class com.onarandombox.MultiverseCore.api.MultiversePlugin
+
 
+
getCore() - Method in interface com.onarandombox.MultiverseCore.api.MVPlugin
+
+
Gets the reference to MultiverseCore.
+
+
getCore() - Method in class com.onarandombox.MultiverseCore.MultiverseCore
+
 
+
getCreationRadius() - Method in class com.onarandombox.MultiverseCore.utils.BukkitTravelAgent
+
getCurrency() - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Gets the type of currency that will be used when users enter this world.
+
+
getCurrency() - Method in class com.onarandombox.MultiverseCore.configuration.EntryFee
+
 
+
getCurrency() - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Gets the type of currency that will be used when users enter this world.
+
+
getCurrency() - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
getDefault() - Method in class com.onarandombox.MultiverseCore.utils.FancyColorScheme
+
+
Gets the default ChatColor.
+
+
getDefaultWorldGenerators() - Method in interface com.onarandombox.MultiverseCore.api.MVWorldManager
+
+
This method populates an internal list and needs to be called after multiverse initialization.
+
+
getDefaultWorldGenerators() - Method in class com.onarandombox.MultiverseCore.utils.WorldManager
+
+
This method populates an internal list and needs to be called after multiverse initialization.
+
+
getDestFactory() - Method in interface com.onarandombox.MultiverseCore.api.Core
+
+
Gets the factory class responsible for loading many different destinations + on demand.
+
+
getDestFactory() - Method in class com.onarandombox.MultiverseCore.MultiverseCore
+
+
Gets the factory class responsible for loading many different destinations + on demand.
+
+
getDestination() - Method in class com.onarandombox.MultiverseCore.event.MVTeleportEvent
+
+
Returns the destination that the player will spawn at.
+
+
getDestination(String) - Method in class com.onarandombox.MultiverseCore.destination.DestinationFactory
+
+
Gets a new destination from a string.
+
+
getDetailedVersionInfo() - Method in class com.onarandombox.MultiverseCore.event.MVVersionEvent
+
+
Gets the key/value pair of the detailed version info.
+
+
getDifficulty() - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Gets the difficulty of this world.
+
+
getDifficulty() - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Gets the difficulty of this world.
+
+
getDifficulty() - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
getDirection(Location) - Method in interface com.onarandombox.MultiverseCore.api.LocationManipulation
+
+
Return the NESW Direction a Location is facing.
+
+
getDirection(Location) - Static method in class com.onarandombox.MultiverseCore.utils.LocationManipulation
+
+
Deprecated.
+
Return the NESW Direction a Location is facing.
+
+
getDirection(Location) - Method in class com.onarandombox.MultiverseCore.utils.SimpleLocationManipulation
+
+
Return the NESW Direction a Location is facing.
+
+
getDisplayHandler() - Method in class com.onarandombox.MultiverseCore.display.ContentDisplay
+
 
+
getDisplayPermErrors() - Method in interface com.onarandombox.MultiverseCore.api.MultiverseCoreConfig
+
+
Gets displayPermErrors.
+
+
getDisplayPermErrors() - Method in class com.onarandombox.MultiverseCore.MultiverseCoreConfiguration
+
+
Gets displayPermErrors.
+
+
getEconomist() - Method in interface com.onarandombox.MultiverseCore.api.Core
+
+
Retrieves Multiverse's friendly economist.
+
+
getEconomist() - Method in class com.onarandombox.MultiverseCore.MultiverseCore
+
 
+
getEconomy() - Method in class com.onarandombox.MultiverseCore.utils.VaultHandler
+
+
Returns the Vault economy system if Vault is present and has an economy system enabled.
+
+
getEconomyName() - Method in class com.onarandombox.MultiverseCore.utils.MVEconomist
+
+
Returns the name of the economy in use.
+
+
getEmptyMessage() - Method in class com.onarandombox.MultiverseCore.display.ContentDisplay
+
 
+
getEnableBuscript() - Method in interface com.onarandombox.MultiverseCore.api.MultiverseCoreConfig
+
+
Gets enableBuscript.
+
+
getEnableBuscript() - Method in class com.onarandombox.MultiverseCore.MultiverseCoreConfiguration
+
+
Gets enableBuscript.
+
+
getEnforceAccess() - Method in interface com.onarandombox.MultiverseCore.api.MultiverseCoreConfig
+
+
Gets enforceAccess.
+
+
getEnforceAccess() - Method in class com.onarandombox.MultiverseCore.MultiverseCoreConfiguration
+
+
Gets enforceAccess.
+
+
getEntityListener() - Method in class com.onarandombox.MultiverseCore.MultiverseCore
+
+
Gets the MVEntityListener.
+
+
getEnvFromString(String) - Static method in class com.onarandombox.MultiverseCore.commands.EnvironmentCommand
+
+
Converts a String into an World.Environment.
+
+
getEnvironment() - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Gets the environment of this world.
+
+
getEnvironment() - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Gets the environment of this world.
+
+
getEnvironment() - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
getExceptions() - Method in class com.onarandombox.MultiverseCore.configuration.SubSpawnSettings
+
 
+
getExemptPermission() - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Gets the permission required to be exempt when entering.
+
+
getExemptPermission() - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Gets the permission required to be exempt when entering.
+
+
getFakePVP() - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Deprecated. +
This is deprecated.
+
+
+
getFakePVP() - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Deprecated. +
This is deprecated.
+
+
+
getFancyText() - Method in interface com.onarandombox.MultiverseCore.api.FancyText
+
+
Gets the String-representation of this FancyText.
+
+
getFancyText() - Method in class com.onarandombox.MultiverseCore.utils.FancyHeader
+
 
+
getFancyText() - Method in class com.onarandombox.MultiverseCore.utils.FancyMessage
+
 
+
getField(C, String) - Static method in class com.onarandombox.MultiverseCore.utils.ReflectHelper
+
+
Try to get a Field from a given class.
+
+
getField(Class<C>, String) - Static method in class com.onarandombox.MultiverseCore.utils.ReflectHelper
+
+
Try to get a Field from a given class.
+
+
getFieldValue(C, Field) - Static method in class com.onarandombox.MultiverseCore.utils.ReflectHelper
+
+
Gets the value of an Field from an instance of the class responsible.
+
+
getFilter() - Method in class com.onarandombox.MultiverseCore.commands.PaginatedCommand.FilterObject
+
+
Gets the filter.
+
+
getFilter() - Method in class com.onarandombox.MultiverseCore.display.ContentDisplay
+
 
+
getFilteredItems(List<Command>, String) - Method in class com.onarandombox.MultiverseCore.commands.HelpCommand
+
 
+
getFilteredItems(List<String>, String) - Method in class com.onarandombox.MultiverseCore.commands.AnchorCommand
+
 
+
getFilteredItems(List<T>, String) - Method in class com.onarandombox.MultiverseCore.commands.PaginatedCommand
+
+
Gets filtered items.
+
+
getFirstSpawnOverride() - Method in interface com.onarandombox.MultiverseCore.api.MultiverseCoreConfig
+
+
Gets firstSpawnOverride.
+
+
getFirstSpawnOverride() - Method in class com.onarandombox.MultiverseCore.MultiverseCoreConfiguration
+
+
Gets firstSpawnOverride.
+
+
getFirstSpawnWorld() - Method in interface com.onarandombox.MultiverseCore.api.MultiverseCoreConfig
+
+
Gets firstSpawnWorld.
+
+
getFirstSpawnWorld() - Method in interface com.onarandombox.MultiverseCore.api.MVWorldManager
+
+
Gets the world players should spawn in first.
+
+
getFirstSpawnWorld() - Method in class com.onarandombox.MultiverseCore.MultiverseCoreConfiguration
+
+
Gets firstSpawnWorld.
+
+
getFirstSpawnWorld() - Method in class com.onarandombox.MultiverseCore.utils.WorldManager
+
+
Gets the world players should spawn in first.
+
+
getFormat() - Method in class com.onarandombox.MultiverseCore.listeners.AsyncChatEvent
+
 
+
getFormat() - Method in interface com.onarandombox.MultiverseCore.listeners.ChatEvent
+
 
+
getFormat() - Method in class com.onarandombox.MultiverseCore.listeners.NormalChatEvent
+
+
Deprecated.
+ 
+
getFormattedString() - Method in class com.onarandombox.MultiverseCore.display.ContentFilter
+
+
Nicely format the filter string to be used for showing the sender.
+
+
getFrom() - Method in class com.onarandombox.MultiverseCore.event.MVTeleportEvent
+
+
Returns the location the player was before the teleport.
+
+
getGameMode() - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Gets the GameMode of this world.
+
+
getGameMode() - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Gets the GameMode of this world.
+
+
getGameMode() - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
getGenerator() - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Gets the generator of this world.
+
+
getGenerator() - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Gets the generator of this world.
+
+
getGenerator() - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
getGlobalDebug() - Method in interface com.onarandombox.MultiverseCore.api.MultiverseCoreConfig
+
+
Gets globalDebug.
+
+
getGlobalDebug() - Method in class com.onarandombox.MultiverseCore.MultiverseCoreConfiguration
+
+
Gets globalDebug.
+
+
getHandlerList() - Static method in class com.onarandombox.MultiverseCore.event.MVConfigReloadEvent
+
+
Gets the handler list.
+
+
getHandlerList() - Static method in class com.onarandombox.MultiverseCore.event.MVDebugModeEvent
+
+
Gets the handler list.
+
+
getHandlerList() - Static method in class com.onarandombox.MultiverseCore.event.MVPlayerTouchedPortalEvent
+
+
Gets the handler list.
+
+
getHandlerList() - Static method in class com.onarandombox.MultiverseCore.event.MVRespawnEvent
+
+
Gets the handler list.
+
+
getHandlerList() - Static method in class com.onarandombox.MultiverseCore.event.MVTeleportEvent
+
+
Gets the handler list.
+
+
getHandlerList() - Static method in class com.onarandombox.MultiverseCore.event.MVVersionEvent
+
+
Gets the handler list.
+
+
getHandlerList() - Static method in class com.onarandombox.MultiverseCore.event.MVWorldDeleteEvent
+
+
Gets the handler list.
+
+
getHandlerList() - Static method in class com.onarandombox.MultiverseCore.event.MVWorldPropertyChangeEvent
+
+
Gets the handler list.
+
+
getHandlers() - Method in class com.onarandombox.MultiverseCore.event.MVConfigReloadEvent
+
getHandlers() - Method in class com.onarandombox.MultiverseCore.event.MVDebugModeEvent
+
getHandlers() - Method in class com.onarandombox.MultiverseCore.event.MVPlayerTouchedPortalEvent
+
getHandlers() - Method in class com.onarandombox.MultiverseCore.event.MVRespawnEvent
+
getHandlers() - Method in class com.onarandombox.MultiverseCore.event.MVTeleportEvent
+
getHandlers() - Method in class com.onarandombox.MultiverseCore.event.MVVersionEvent
+
getHandlers() - Method in class com.onarandombox.MultiverseCore.event.MVWorldDeleteEvent
+
getHandlers() - Method in class com.onarandombox.MultiverseCore.event.MVWorldPropertyChangeEvent
+
getHeader() - Method in class com.onarandombox.MultiverseCore.display.ContentDisplay
+
 
+
getHeader() - Method in class com.onarandombox.MultiverseCore.utils.FancyColorScheme
+
+
Gets the header's ChatColor.
+
+
getHunger() - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Gets whether or not the hunger level of players will go down in a world.
+
+
getHunger() - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Gets whether or not the hunger level of players will go down in a world.
+
+
getHunger() - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
getIdentifier() - Method in interface com.onarandombox.MultiverseCore.api.MVDestination
+
+
Returns the identifier or prefix that is required for this destination.
+
+
getIdentifier() - Method in class com.onarandombox.MultiverseCore.destination.AnchorDestination
+
+
Returns the identifier or prefix that is required for this destination.
+
+
getIdentifier() - Method in class com.onarandombox.MultiverseCore.destination.BedDestination
+
+
Returns the identifier or prefix that is required for this destination.
+
+
getIdentifier() - Method in class com.onarandombox.MultiverseCore.destination.CannonDestination
+
+
Returns the identifier or prefix that is required for this destination.
+
+
getIdentifier() - Method in class com.onarandombox.MultiverseCore.destination.ExactDestination
+
+
Returns the identifier or prefix that is required for this destination.
+
+
getIdentifier() - Method in class com.onarandombox.MultiverseCore.destination.InvalidDestination
+
+
Returns the identifier or prefix that is required for this destination.
+
+
getIdentifier() - Method in class com.onarandombox.MultiverseCore.destination.PlayerDestination
+
+
Returns the identifier or prefix that is required for this destination.
+
+
getIdentifier() - Method in class com.onarandombox.MultiverseCore.destination.WorldDestination
+
+
Returns the identifier or prefix that is required for this destination.
+
+
getInstance() - Static method in class com.onarandombox.MultiverseCore.MultiverseCoreConfiguration
+
+
Gets the statically saved instance.
+
+
getItemText(Command) - Method in class com.onarandombox.MultiverseCore.commands.HelpCommand
+
 
+
getItemText(String) - Method in class com.onarandombox.MultiverseCore.commands.AnchorCommand
+
 
+
getItemText(T) - Method in class com.onarandombox.MultiverseCore.commands.PaginatedCommand
+
+
Converts an item into a string.
+
+
getLevel() - Method in class com.onarandombox.MultiverseCore.event.MVDebugModeEvent
+
+
Returns the current debug level of Core.
+
+
getLocation(Entity) - Method in interface com.onarandombox.MultiverseCore.api.MVDestination
+
+
Returns the location a specific entity will spawn at when being teleported to this Destination.
+
+
getLocation(Entity) - Method in class com.onarandombox.MultiverseCore.destination.AnchorDestination
+
+
Returns the location a specific entity will spawn at when being teleported to this Destination.
+
+
getLocation(Entity) - Method in class com.onarandombox.MultiverseCore.destination.BedDestination
+
+
Returns the location a specific entity will spawn at when being teleported to this Destination.
+
+
getLocation(Entity) - Method in class com.onarandombox.MultiverseCore.destination.CannonDestination
+
+
Returns the location a specific entity will spawn at when being teleported to this Destination.
+
+
getLocation(Entity) - Method in class com.onarandombox.MultiverseCore.destination.CustomTeleporterDestination
+
 
+
getLocation(Entity) - Method in class com.onarandombox.MultiverseCore.destination.ExactDestination
+
+
Returns the location a specific entity will spawn at when being teleported to this Destination.
+
+
getLocation(Entity) - Method in class com.onarandombox.MultiverseCore.destination.InvalidDestination
+
+
Returns the location a specific entity will spawn at when being teleported to this Destination.
+
+
getLocation(Entity) - Method in class com.onarandombox.MultiverseCore.destination.PlayerDestination
+
+
Returns the location a specific entity will spawn at when being teleported to this Destination.
+
+
getLocation(Entity) - Method in class com.onarandombox.MultiverseCore.destination.WorldDestination
+
+
Returns the location a specific entity will spawn at when being teleported to this Destination.
+
+
getLocationManipulation() - Method in interface com.onarandombox.MultiverseCore.api.Core
+
+
Gets the LocationManipulation this Core is using.
+
+
getLocationManipulation() - Method in class com.onarandombox.MultiverseCore.MultiverseCore
+
+
Gets the LocationManipulation this Core is using.
+
+
getMain() - Method in class com.onarandombox.MultiverseCore.utils.FancyColorScheme
+
+
Gets the main ChatColor.
+
+
getMain(boolean) - Method in class com.onarandombox.MultiverseCore.utils.FancyColorScheme
+
+
Gets either the main or the alt ChatColor.
+
+
getMessageCooldown() - Method in interface com.onarandombox.MultiverseCore.api.MultiverseCoreConfig
+
+
Gets messageCooldown.
+
+
getMessageCooldown() - Method in class com.onarandombox.MultiverseCore.MultiverseCoreConfiguration
+
+
Gets messageCooldown.
+
+
getMessaging() - Method in interface com.onarandombox.MultiverseCore.api.Core
+
+
Gets the Multiverse message system.
+
+
getMessaging() - Method in class com.onarandombox.MultiverseCore.MultiverseCore
+
+
Gets the Multiverse message system.
+
+
getMethod(C, String, Class<?>...) - Static method in class com.onarandombox.MultiverseCore.utils.ReflectHelper
+
+
Try to get a Method from a given class.
+
+
getMethod(Class<C>, String, Class<?>...) - Static method in class com.onarandombox.MultiverseCore.utils.ReflectHelper
+
+
Try to get a Method from a given class.
+
+
getMonsterList() - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Returns a list of monsters.
+
+
getMonsterList() - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Returns a list of monsters.
+
+
getMonsterList() - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
getMonsterSettings() - Method in class com.onarandombox.MultiverseCore.configuration.SpawnSettings
+
 
+
getMonsterSpawnRate() - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
getMulti(String, CommandSender) - Static method in class com.onarandombox.MultiverseCore.utils.PlayerFinder
+
+
Get multiple Player based on many identifiers of name UUID or selector.
+
+
getMultiBySelector(String, CommandSender) - Static method in class com.onarandombox.MultiverseCore.utils.PlayerFinder
+
+
Get multiple Player based on selector.
+
+
getMVConfig() - Method in interface com.onarandombox.MultiverseCore.api.Core
+
+
Gets the MultiverseCoreConfig.
+
+
getMVConfig() - Method in class com.onarandombox.MultiverseCore.MultiverseCore
+
+
Gets the MultiverseCoreConfig.
+
+
getMVPerms() - Method in interface com.onarandombox.MultiverseCore.api.Core
+
+
Multiverse uses an advanced permissions setup, this object + simplifies getting/setting permissions.
+
+
getMVPerms() - Method in class com.onarandombox.MultiverseCore.MultiverseCore
+
+
Multiverse uses an advanced permissions setup, this object + simplifies getting/setting permissions.
+
+
getMVWorld(String) - Method in interface com.onarandombox.MultiverseCore.api.MVWorldManager
+
+
Returns a MultiverseWorld if it exists, and null if it does not.
+
+
getMVWorld(String) - Method in class com.onarandombox.MultiverseCore.utils.WorldManager
+
+
Returns a MultiverseWorld if it exists, and null if it does not.
+
+
getMVWorld(String, boolean) - Method in interface com.onarandombox.MultiverseCore.api.MVWorldManager
+
+
Returns a MultiverseWorld if the world with name given exists, and null if it does not.
+
+
getMVWorld(String, boolean) - Method in class com.onarandombox.MultiverseCore.utils.WorldManager
+
+
Returns a MultiverseWorld if the world with name given exists, and null if it does not.
+
+
getMVWorld(World) - Method in interface com.onarandombox.MultiverseCore.api.MVWorldManager
+
+
Returns a MultiverseWorld if it exists, and null if it does not.
+
+
getMVWorld(World) - Method in class com.onarandombox.MultiverseCore.utils.WorldManager
+
+
Returns a MultiverseWorld if it exists, and null if it does not.
+
+
getMVWorldManager() - Method in interface com.onarandombox.MultiverseCore.api.Core
+
+
Gets the primary class responsible for managing Multiverse Worlds.
+
+
getMVWorldManager() - Method in class com.onarandombox.MultiverseCore.MultiverseCore
+
+
Gets the primary class responsible for managing Multiverse Worlds.
+
+
getMVWorlds() - Method in interface com.onarandombox.MultiverseCore.api.MVWorldManager
+
+
Returns a list of all the worlds Multiverse knows about.
+
+
getMVWorlds() - Method in class com.onarandombox.MultiverseCore.utils.WorldManager
+
+
Returns a list of all the worlds Multiverse knows about.
+
+
getName() - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Gets the name of this world.
+
+
getName() - Method in interface com.onarandombox.MultiverseCore.api.MVDestination
+
+
Gives you a specific name of the destination.
+
+
getName() - Method in class com.onarandombox.MultiverseCore.destination.AnchorDestination
+
+
Gives you a specific name of the destination.
+
+
getName() - Method in class com.onarandombox.MultiverseCore.destination.BedDestination
+
+
Gives you a specific name of the destination.
+
+
getName() - Method in class com.onarandombox.MultiverseCore.destination.CannonDestination
+
+
Gives you a specific name of the destination.
+
+
getName() - Method in class com.onarandombox.MultiverseCore.destination.ExactDestination
+
+
Gives you a specific name of the destination.
+
+
getName() - Method in class com.onarandombox.MultiverseCore.destination.InvalidDestination
+
+
Gives you a specific name of the destination.
+
+
getName() - Method in class com.onarandombox.MultiverseCore.destination.PlayerDestination
+
+
Gives you a specific name of the destination.
+
+
getName() - Method in class com.onarandombox.MultiverseCore.destination.WorldDestination
+
+
Gives you a specific name of the destination.
+
+
getName() - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Gets the name of this world.
+
+
getNewValue() - Method in class com.onarandombox.MultiverseCore.event.MVWorldPropertyChangeEvent
+
+
Deprecated. +
Use MVWorldPropertyChangeEvent.getTheNewValue() instead.
+
+
+
getNextBlock(Vehicle) - Method in interface com.onarandombox.MultiverseCore.api.LocationManipulation
+
+
Returns the next Location that a Vehicle is traveling at.
+
+
getNextBlock(Vehicle) - Static method in class com.onarandombox.MultiverseCore.utils.LocationManipulation
+
+
Deprecated.
+
Returns the next Location that a Vehicle is traveling at.
+
+
getNextBlock(Vehicle) - Method in class com.onarandombox.MultiverseCore.utils.SimpleLocationManipulation
+
+
Returns the next Location that a Vehicle is traveling at.
+
+
getNSFMessage(Material, String) - Method in class com.onarandombox.MultiverseCore.utils.MVEconomist
+
+
Formats a message for a player indicating they don't have enough currency.
+
+
getPage() - Method in class com.onarandombox.MultiverseCore.commands.PaginatedCommand.FilterObject
+
+
Gets the page.
+
+
getPageAndFilter(List<String>) - Method in class com.onarandombox.MultiverseCore.commands.PaginatedCommand
+
+
Constructs a PaginatedCommand.FilterObject from a List of arguments.
+
+
getPattern() - Method in class com.onarandombox.MultiverseCore.display.ContentFilter
+
 
+
getPermissibleName() - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Gets the lowercased name of the world.
+
+
getPermissibleName() - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Gets the lowercased name of the world.
+
+
getPlayer() - Method in class com.onarandombox.MultiverseCore.event.MVPlayerTouchedPortalEvent
+
+
Gets the Player that's touching the portal.
+
+
getPlayer() - Method in class com.onarandombox.MultiverseCore.event.MVRespawnEvent
+
+
Gets the Player that's respawning.
+
+
getPlayer() - Method in class com.onarandombox.MultiverseCore.listeners.AsyncChatEvent
+
 
+
getPlayer() - Method in interface com.onarandombox.MultiverseCore.listeners.ChatEvent
+
 
+
getPlayer() - Method in class com.onarandombox.MultiverseCore.listeners.NormalChatEvent
+
+
Deprecated.
+ 
+
getPlayerAwareDestination(Player, String) - Method in class com.onarandombox.MultiverseCore.destination.DestinationFactory
+
+
Parse a destination that has relation to sender, such as a cannon or player destination.
+
+
getPlayerLimit() - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Gets the player limit for this world after which players without an override + permission node will not be allowed in.
+
+
getPlayerLimit() - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Gets the player limit for this world after which players without an override + permission node will not be allowed in.
+
+
getPlayerLimit() - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
getPlayerListener() - Method in class com.onarandombox.MultiverseCore.MultiverseCore
+
+
Gets the MVPlayerListener.
+
+
getPlayerSession(Player) - Method in interface com.onarandombox.MultiverseCore.api.Core
+
+
Gets the MVPlayerSession for the given player.
+
+
getPlayerSession(Player) - Method in class com.onarandombox.MultiverseCore.MultiverseCore
+
+
Gets the MVPlayerSession for the given player.
+
+
getPlayersRespawnLocation() - Method in class com.onarandombox.MultiverseCore.event.MVRespawnEvent
+
+
Gets the player's respawn-Location.
+
+
getPlayerTeleporter(String) - Static method in class com.onarandombox.MultiverseCore.MultiverseCore
+
+
This method is used to find out who is teleporting a player.
+
+
getPlayerWorld() - Method in class com.onarandombox.MultiverseCore.listeners.MVPlayerListener
+
 
+
getPluginCount() - Method in interface com.onarandombox.MultiverseCore.api.Core
+
+
Returns the number of plugins that have specifically hooked into core.
+
+
getPluginCount() - Method in class com.onarandombox.MultiverseCore.MultiverseCore
+
+
Returns the number of plugins that have specifically hooked into core.
+
+
getPortalSearchRadius() - Method in interface com.onarandombox.MultiverseCore.api.MultiverseCoreConfig
+
+
Gets the radius at which vanilla style portals will be searched for to connect to worlds together.
+
+
getPortalSearchRadius() - Method in class com.onarandombox.MultiverseCore.MultiverseCoreConfiguration
+
 
+
getPotentialWorlds() - Method in interface com.onarandombox.MultiverseCore.api.MVWorldManager
+
+
Get all the possible worlds that Multiverse has detected to be importable.
+
+
getPotentialWorlds() - Method in class com.onarandombox.MultiverseCore.utils.WorldManager
+
+
Get all the possible worlds that Multiverse has detected to be importable.
+
+
getPrefixChat() - Method in interface com.onarandombox.MultiverseCore.api.MultiverseCoreConfig
+
+
Gets prefixChat.
+
+
getPrefixChat() - Method in class com.onarandombox.MultiverseCore.MultiverseCoreConfiguration
+
+
Gets prefixChat.
+
+
getPrefixChatFormat() - Method in interface com.onarandombox.MultiverseCore.api.MultiverseCoreConfig
+
+
Gets prefixChatFormat.
+
+
getPrefixChatFormat() - Method in class com.onarandombox.MultiverseCore.MultiverseCoreConfiguration
+
+
Gets prefixChatFormat.
+
+
getPrice() - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Gets the amount of currency it requires to enter this world.
+
+
getPrice() - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Gets the amount of currency it requires to enter this world.
+
+
getPrice() - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
getPropertyHelp(String) - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Gets the help-message for a property.
+
+
getPropertyHelp(String) - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Gets the help-message for a property.
+
+
getPropertyName() - Method in class com.onarandombox.MultiverseCore.event.MVWorldPropertyChangeEvent
+
+
Gets the changed world property's name.
+
+
getPropertyValue(String) - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Gets a property as String.
+
+
getPropertyValue(String) - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Gets a property as String.
+
+
getProtocolVersion() - Method in interface com.onarandombox.MultiverseCore.api.MVPlugin
+
+
Allows Multiverse or a plugin to query another Multiverse plugin to see what version its protocol is.
+
+
getProtocolVersion() - Method in class com.onarandombox.MultiverseCore.MultiverseCore
+
 
+
getRegisteredIdentifiers() - Method in class com.onarandombox.MultiverseCore.destination.DestinationFactory
+
+
Gets all the MVDestination identifiers registered.
+
+
getRequiredPermission() - Method in interface com.onarandombox.MultiverseCore.api.MVDestination
+
+
Returns the permissions string required to go here.
+
+
getRequiredPermission() - Method in class com.onarandombox.MultiverseCore.destination.AnchorDestination
+
+
Returns the permissions string required to go here.
+
+
getRequiredPermission() - Method in class com.onarandombox.MultiverseCore.destination.BedDestination
+
+
Returns the permissions string required to go here.
+
+
getRequiredPermission() - Method in class com.onarandombox.MultiverseCore.destination.CannonDestination
+
+
Returns the permissions string required to go here.
+
+
getRequiredPermission() - Method in class com.onarandombox.MultiverseCore.destination.ExactDestination
+
+
Returns the permissions string required to go here.
+
+
getRequiredPermission() - Method in class com.onarandombox.MultiverseCore.destination.InvalidDestination
+
+
Returns the permissions string required to go here.
+
+
getRequiredPermission() - Method in class com.onarandombox.MultiverseCore.destination.PlayerDestination
+
+
Returns the permissions string required to go here.
+
+
getRequiredPermission() - Method in class com.onarandombox.MultiverseCore.destination.WorldDestination
+
+
Returns the permissions string required to go here.
+
+
getRespawnMethod() - Method in class com.onarandombox.MultiverseCore.event.MVRespawnEvent
+
+
Gets the respawn-method.
+
+
getRespawnToWorld() - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Gets the world players will respawn in if they die in this one.
+
+
getRespawnToWorld() - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Gets the world players will respawn in if they die in this one.
+
+
getRespawnToWorld() - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
getSafeBedSpawn(Location) - Method in interface com.onarandombox.MultiverseCore.api.BlockSafety
+
+
Gets a safe bed spawn location OR null if the bed is invalid.
+
+
getSafeBedSpawn(Location) - Method in class com.onarandombox.MultiverseCore.utils.SimpleBlockSafety
+
+
Gets a safe bed spawn location OR null if the bed is invalid.
+
+
getSafeLocation(Entity, MVDestination) - Method in interface com.onarandombox.MultiverseCore.api.SafeTTeleporter
+
+
Returns a safe location for the entity to spawn at.
+
+
getSafeLocation(Entity, MVDestination) - Method in class com.onarandombox.MultiverseCore.utils.SimpleSafeTTeleporter
+
+
Returns a safe location for the entity to spawn at.
+
+
getSafeLocation(Location) - Method in interface com.onarandombox.MultiverseCore.api.SafeTTeleporter
+
+
Gets the next safe location around the given location.
+
+
getSafeLocation(Location) - Method in class com.onarandombox.MultiverseCore.utils.SimpleSafeTTeleporter
+
+
Gets the next safe location around the given location.
+
+
getSafeLocation(Location, int, int) - Method in interface com.onarandombox.MultiverseCore.api.SafeTTeleporter
+
+
Gets the next safe location around the given location.
+
+
getSafeLocation(Location, int, int) - Method in class com.onarandombox.MultiverseCore.utils.SimpleSafeTTeleporter
+
+
Gets the next safe location around the given location.
+
+
getSafeTTeleporter() - Method in interface com.onarandombox.MultiverseCore.api.Core
+
+
Gets the SafeTTeleporter this Core is using.
+
+
getSafeTTeleporter() - Method in class com.onarandombox.MultiverseCore.MultiverseCore
+
+
Gets the SafeTTeleporter this Core is using.
+
+
getScaling() - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Gets the scaling value of this world.Really only has an effect if you use + Multiverse-NetherPortals.
+
+
getScaling() - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Gets the scaling value of this world.Really only has an effect if you use + Multiverse-NetherPortals.
+
+
getScaling() - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
getScriptAPI() - Method in interface com.onarandombox.MultiverseCore.api.Core
+
+
Gets the buscript object for Multiverse.
+
+
getScriptAPI() - Method in class com.onarandombox.MultiverseCore.MultiverseCore
+
 
+
getSearchRadius() - Method in class com.onarandombox.MultiverseCore.utils.BukkitTravelAgent
+
getSeed() - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Gets the world seed of this world.
+
+
getSeed() - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Gets the world seed of this world.
+
+
getSeed() - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
getServer() - Method in interface com.onarandombox.MultiverseCore.api.LoggablePlugin
+
+
Deprecated.
+
Gets the server instance that this plugin is attached to.
+
+
getServerFolder() - Method in class com.onarandombox.MultiverseCore.MultiverseCore
+
+
Gets the server's root-folder as File.
+
+
getService(PasteServiceType, boolean) - Static method in class com.onarandombox.MultiverseCore.utils.webpaste.PasteServiceFactory
+
+
Constructs a new PasteService.
+
+
getService(URLShortenerType) - Static method in class com.onarandombox.MultiverseCore.utils.webpaste.URLShortenerFactory
+
+
Constructs a new URLShortener.
+
+
getSetting(DisplaySetting<S>) - Method in class com.onarandombox.MultiverseCore.display.ContentDisplay
+
+
Gets the value for a given setting option.
+
+
getSilentStart() - Method in interface com.onarandombox.MultiverseCore.api.MultiverseCoreConfig
+
+
Whether we are suppressing startup messages.
+
+
getSilentStart() - Method in class com.onarandombox.MultiverseCore.MultiverseCoreConfiguration
+
 
+
getSpawnLocation() - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Gets the spawn location of this world.
+
+
getSpawnLocation() - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Gets the spawn location of this world.
+
+
getSpawnLocation() - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
getSpawnRate() - Method in class com.onarandombox.MultiverseCore.configuration.SubSpawnSettings
+
 
+
getSpawnWorld() - Method in interface com.onarandombox.MultiverseCore.api.MVWorldManager
+
+
Gets the world players will spawn in on first join.
+
+
getSpawnWorld() - Method in class com.onarandombox.MultiverseCore.utils.WorldManager
+
+
Gets the world players will spawn in on first join.
+
+
getSpeed(Vector) - Method in interface com.onarandombox.MultiverseCore.api.LocationManipulation
+
+
Returns a speed float from a given vector.
+
+
getSpeed(Vector) - Static method in class com.onarandombox.MultiverseCore.utils.LocationManipulation
+
+
Deprecated.
+
Returns a speed float from a given vector.
+
+
getSpeed(Vector) - Method in class com.onarandombox.MultiverseCore.utils.SimpleLocationManipulation
+
+
Returns a speed float from a given vector.
+
+
getStaticConfig() - Static method in class com.onarandombox.MultiverseCore.MultiverseCore
+
+
Deprecated. +
This is deprecated.
+
+
+
getString() - Method in class com.onarandombox.MultiverseCore.display.ContentFilter
+
 
+
getStyle() - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Gets the style that this world's name/alias will display as.
+
+
getStyle() - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Gets the style that this world's name/alias will display as.
+
+
getStyle() - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
getTag() - Method in class com.onarandombox.MultiverseCore.MultiverseCore
+
+
Gets the log-tag.
+
+
getTeleportable() - Method in class com.onarandombox.MultiverseCore.utils.MVPlayerSession
+
+
Grab whether the cooldown on Portal use has expired or not.
+
+
getTeleportCooldown() - Method in interface com.onarandombox.MultiverseCore.api.MultiverseCoreConfig
+
+
Gets portalCooldown.
+
+
getTeleportCooldown() - Method in class com.onarandombox.MultiverseCore.MultiverseCoreConfiguration
+
+
Gets portalCooldown.
+
+
getTeleportee() - Method in class com.onarandombox.MultiverseCore.event.MVTeleportEvent
+
+
Returns the player who will be teleported by this event.
+
+
getTeleporter() - Method in class com.onarandombox.MultiverseCore.destination.CustomTeleporterDestination
+
 
+
getTeleporter() - Method in class com.onarandombox.MultiverseCore.event.MVTeleportEvent
+
+
Gets the CommandSender who requested the Teleport.
+
+
getTeleportIntercept() - Method in interface com.onarandombox.MultiverseCore.api.MultiverseCoreConfig
+
+
Gets teleportIntercept.
+
+
getTeleportIntercept() - Method in class com.onarandombox.MultiverseCore.MultiverseCoreConfiguration
+
+
Gets teleportIntercept.
+
+
getText() - Method in enum com.onarandombox.MultiverseCore.enums.EnglishChatColor
+
+
Gets the text.
+
+
getThatColor() - Method in class com.onarandombox.MultiverseCore.display.ColorAlternator
+
 
+
getTheNewValue() - Method in class com.onarandombox.MultiverseCore.event.MVWorldPropertyChangeEvent
+
+
Gets the new value.
+
+
getTheWorldPurger() - Method in interface com.onarandombox.MultiverseCore.api.MVWorldManager
+
+
Gets the WorldPurger.
+
+
getTheWorldPurger() - Method in class com.onarandombox.MultiverseCore.utils.WorldManager
+
+
Gets the WorldPurger.
+
+
getThisColor() - Method in class com.onarandombox.MultiverseCore.display.ColorAlternator
+
 
+
getTime() - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Same as MultiverseWorld.getTime(), but returns a string.
+
+
getTime() - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Same as MultiverseWorld.getTime(), but returns a string.
+
+
getTime() - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
getTopBlock(Location) - Method in interface com.onarandombox.MultiverseCore.api.BlockSafety
+
+
Gets the location of the top block at the specified Location.
+
+
getTopBlock(Location) - Method in class com.onarandombox.MultiverseCore.utils.SimpleBlockSafety
+
+
Gets the location of the top block at the specified Location.
+
+
getTranslatedVector(Vector, String) - Method in interface com.onarandombox.MultiverseCore.api.LocationManipulation
+
+
Returns a translated vector from the given direction.
+
+
getTranslatedVector(Vector, String) - Static method in class com.onarandombox.MultiverseCore.utils.LocationManipulation
+
+
Deprecated.
+
Returns a translated vector from the given direction.
+
+
getTranslatedVector(Vector, String) - Method in class com.onarandombox.MultiverseCore.utils.SimpleLocationManipulation
+
+
Returns a translated vector from the given direction.
+
+
getType() - Method in interface com.onarandombox.MultiverseCore.api.MVDestination
+
+
Gives you a general friendly description of the type of destination.
+
+
getType() - Method in class com.onarandombox.MultiverseCore.destination.AnchorDestination
+
+
Gives you a general friendly description of the type of destination.
+
+
getType() - Method in class com.onarandombox.MultiverseCore.destination.BedDestination
+
+
Gives you a general friendly description of the type of destination.
+
+
getType() - Method in class com.onarandombox.MultiverseCore.destination.CannonDestination
+
+
Gives you a general friendly description of the type of destination.
+
+
getType() - Method in class com.onarandombox.MultiverseCore.destination.ExactDestination
+
+
Gives you a general friendly description of the type of destination.
+
+
getType() - Method in class com.onarandombox.MultiverseCore.destination.InvalidDestination
+
+
Gives you a general friendly description of the type of destination.
+
+
getType() - Method in class com.onarandombox.MultiverseCore.destination.PlayerDestination
+
+
Gives you a general friendly description of the type of destination.
+
+
getType() - Method in class com.onarandombox.MultiverseCore.destination.WorldDestination
+
+
Gives you a general friendly description of the type of destination.
+
+
getType() - Method in class com.onarandombox.MultiverseCore.utils.MVPermissions
+
+
Gets the type of this PermissionsInterface.
+
+
getUnloadedWorlds() - Method in interface com.onarandombox.MultiverseCore.api.MVWorldManager
+
+
Gets the list of worlds in the config, but unloaded.
+
+
getUnloadedWorlds() - Method in class com.onarandombox.MultiverseCore.utils.WorldManager
+
+
Gets the list of worlds in the config, but unloaded.
+
+
getUnsafeCallWrapper() - Method in class com.onarandombox.MultiverseCore.MultiverseCore
+
 
+
getUseAsyncChat() - Method in interface com.onarandombox.MultiverseCore.api.MultiverseCoreConfig
+
+
Gets useasyncchat.
+
+
getUseAsyncChat() - Method in class com.onarandombox.MultiverseCore.MultiverseCoreConfiguration
+
 
+
getVaultHandler() - Method in interface com.onarandombox.MultiverseCore.api.Core
+
+
Deprecated. +
we are now using Core.getEconomist() for all economy needs.
+
+
+
getVaultHandler() - Method in class com.onarandombox.MultiverseCore.MultiverseCore
+
+
Deprecated.
+
+
getVaultHandler() - Method in class com.onarandombox.MultiverseCore.utils.MVEconomist
+
+
Deprecated. +
just use the other methods in this class for economy stuff.
+
+
+
getVelocity() - Method in interface com.onarandombox.MultiverseCore.api.MVDestination
+
+
Returns the velocity vector for this destination.
+
+
getVelocity() - Method in class com.onarandombox.MultiverseCore.destination.AnchorDestination
+
+
Returns the velocity vector for this destination.
+
+
getVelocity() - Method in class com.onarandombox.MultiverseCore.destination.BedDestination
+
+
Returns the velocity vector for this destination.
+
+
getVelocity() - Method in class com.onarandombox.MultiverseCore.destination.CannonDestination
+
+
Returns the velocity vector for this destination.
+
+
getVelocity() - Method in class com.onarandombox.MultiverseCore.destination.CustomTeleporterDestination
+
 
+
getVelocity() - Method in class com.onarandombox.MultiverseCore.destination.ExactDestination
+
+
Returns the velocity vector for this destination.
+
+
getVelocity() - Method in class com.onarandombox.MultiverseCore.destination.InvalidDestination
+
+
Returns the velocity vector for this destination.
+
+
getVelocity() - Method in class com.onarandombox.MultiverseCore.destination.PlayerDestination
+
+
Returns the velocity vector for this destination.
+
+
getVelocity() - Method in class com.onarandombox.MultiverseCore.destination.WorldDestination
+
+
Returns the velocity vector for this destination.
+
+
getVersion() - Method in interface com.onarandombox.MultiverseCore.api.MultiverseCoreConfig
+
+
Gets version.
+
+
getVersion() - Method in class com.onarandombox.MultiverseCore.MultiverseCoreConfiguration
+
+
Gets version.
+
+
getVersionInfo() - Method in class com.onarandombox.MultiverseCore.event.MVVersionEvent
+
+
Gets the version-info currently saved in this event.
+
+
getWeatherListener() - Method in class com.onarandombox.MultiverseCore.MultiverseCore
+
+
Gets the MVWeatherListener.
+
+
getWorld() - Method in class com.onarandombox.MultiverseCore.configuration.SpawnLocation
+
getWorld() - Method in class com.onarandombox.MultiverseCore.event.MVWorldDeleteEvent
+
+
Gets the world that's about to be deleted.
+
+
getWorld() - Method in class com.onarandombox.MultiverseCore.event.MVWorldPropertyChangeEvent
+
+
Get the world targeted because of this change.
+
+
getWorldBlacklist() - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Gets a list of all the worlds that players CANNOT travel to from this world, + regardless of their access permissions.
+
+
getWorldBlacklist() - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Gets a list of all the worlds that players CANNOT travel to from this world, + regardless of their access permissions.
+
+
getWorldBlacklist() - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
getWorldPurger() - Method in interface com.onarandombox.MultiverseCore.api.MVWorldManager
+
+
Deprecated. +
PurgeWorlds is deprecated!
+
+
+
getWorldPurger() - Method in class com.onarandombox.MultiverseCore.utils.WorldManager
+
+
Deprecated. +
This is deprecated!
+
+
+
getWorldType() - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Gets the type of this world.
+
+
getWorldType() - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Gets the type of this world.
+
+
getWorldTypeFromString(String) - Static method in class com.onarandombox.MultiverseCore.commands.EnvironmentCommand
+
+
Converts a String into a WorldType.
+
+
getYaw(String) - Method in interface com.onarandombox.MultiverseCore.api.LocationManipulation
+
+
Returns the float yaw position for the given cardinal direction.
+
+
getYaw(String) - Static method in class com.onarandombox.MultiverseCore.utils.LocationManipulation
+
+
Deprecated.
+
Returns the float yaw position for the given cardinal direction.
+
+
getYaw(String) - Method in class com.onarandombox.MultiverseCore.utils.SimpleLocationManipulation
+
+
Returns the float yaw position for the given cardinal direction.
+
+
GITHUB - com.onarandombox.MultiverseCore.utils.webpaste.PasteServiceType
+
 
+
GOLD - com.onarandombox.MultiverseCore.enums.EnglishChatColor
+
 
+
GRAY - com.onarandombox.MultiverseCore.enums.EnglishChatColor
+
 
+
GREEN - com.onarandombox.MultiverseCore.enums.EnglishChatColor
+
 
+
+ + + +

H

+
+
handleGameModeAndFlight(Player, MultiverseWorld) - Method in class com.onarandombox.MultiverseCore.listeners.MVPlayerListener
+
+
Handles the gamemode for the specified Player.
+
+
hasAllPermission(CommandSender, List<String>, boolean) - Method in class com.onarandombox.MultiverseCore.utils.MVPermissions
+
hasAnyPermission(CommandSender, List<String>, boolean) - Method in class com.onarandombox.MultiverseCore.utils.MVPermissions
+
hasClass(String) - Static method in class com.onarandombox.MultiverseCore.utils.ReflectHelper
+
+
Check if the Class for a give classpath is present/valid.
+
+
hasEconomy() - Method in class com.onarandombox.MultiverseCore.utils.VaultHandler
+
+
Checks whether Vault is in use and has an economy system enabled.
+
+
hasFilter() - Method in class com.onarandombox.MultiverseCore.display.ContentFilter
+
+
Checks if a filter string is present.
+
+
hashCode() - Method in class com.onarandombox.MultiverseCore.MVWorld.NullLocation
+
 
+
hasPermission(CommandSender, String, boolean) - Method in class com.onarandombox.MultiverseCore.utils.MVPermissions
+
+
Check to see if a player has a permission.
+
+
HASTEBIN - com.onarandombox.MultiverseCore.utils.webpaste.PasteServiceType
+
 
+
hasUnloadedWorld(String, boolean) - Method in interface com.onarandombox.MultiverseCore.api.MVWorldManager
+
+
Checks whether Multiverse knows about a provided unloaded world.
+
+
hasUnloadedWorld(String, boolean) - Method in class com.onarandombox.MultiverseCore.utils.WorldManager
+
+
Checks whether Multiverse knows about a provided unloaded world.
+
+
hasValidPattern() - Method in class com.onarandombox.MultiverseCore.display.ContentFilter
+
+
Checks if regex pattern syntax is valid.
+
+
header(String, Object...) - Method in class com.onarandombox.MultiverseCore.display.ContentDisplay.Builder
+
+
Sets header to be displayed.
+
+
HelpCommand - Class in com.onarandombox.MultiverseCore.commands
+
+
Displays a nice help menu.
+
+
HelpCommand(MultiverseCore) - Constructor for class com.onarandombox.MultiverseCore.commands.HelpCommand
+
 
+
+ + + +

I

+
+
ImportCommand - Class in com.onarandombox.MultiverseCore.commands
+
+
Imports a new world of the specified type.
+
+
ImportCommand(MultiverseCore) - Constructor for class com.onarandombox.MultiverseCore.commands.ImportCommand
+
 
+
incrementPluginCount() - Method in interface com.onarandombox.MultiverseCore.api.Core
+
+
Increments the number of plugins that have specifically hooked into core.
+
+
incrementPluginCount() - Method in class com.onarandombox.MultiverseCore.MultiverseCore
+
+
Increments the number of plugins that have specifically hooked into core.
+
+
InfoCommand - Class in com.onarandombox.MultiverseCore.commands
+
+
Returns detailed information about a world.
+
+
InfoCommand(MultiverseCore) - Constructor for class com.onarandombox.MultiverseCore.commands.InfoCommand
+
 
+
init() - Static method in class com.onarandombox.MultiverseCore.utils.CompatibilityLayer
+
+
Initialise the reflection class, methods and fields.
+
+
initWorld(WorldInitEvent) - Method in class com.onarandombox.MultiverseCore.listeners.MVWorldInitListener
+
 
+
INLINE_LIST - Static variable in class com.onarandombox.MultiverseCore.display.DisplayHandlers
+
+
Display a list inline.
+
+
INLINE_MAP - Static variable in class com.onarandombox.MultiverseCore.display.DisplayHandlers
+
+
Display key value pair inline.
+
+
InlineDisplaySettings - Class in com.onarandombox.MultiverseCore.display.settings
+
+
Collection of DisplaySetting that are used by various DisplayHandler.
+
+
InlineDisplaySettings() - Constructor for class com.onarandombox.MultiverseCore.display.settings.InlineDisplaySettings
+
 
+
InlineListDisplayHandler - Class in com.onarandombox.MultiverseCore.display.handlers
+
 
+
InlineListDisplayHandler() - Constructor for class com.onarandombox.MultiverseCore.display.handlers.InlineListDisplayHandler
+
 
+
InlineMapDisplayHandler - Class in com.onarandombox.MultiverseCore.display.handlers
+
 
+
InlineMapDisplayHandler() - Constructor for class com.onarandombox.MultiverseCore.display.handlers.InlineMapDisplayHandler
+
 
+
INVALID_CHARS - com.onarandombox.MultiverseCore.utils.WorldNameChecker.NameStatus
+
+
Name not valid as it contains invalid characters.
+
+
InvalidDestination - Class in com.onarandombox.MultiverseCore.destination
+
+
An invalid MVDestination.
+
+
InvalidDestination() - Constructor for class com.onarandombox.MultiverseCore.destination.InvalidDestination
+
 
+
invokeMethod(C, Method, Object...) - Static method in class com.onarandombox.MultiverseCore.utils.ReflectHelper
+
+
Calls a Method.
+
+
isAnchorSpawn(PlayerRespawnEvent) - Static method in class com.onarandombox.MultiverseCore.utils.CompatibilityLayer
+
+
Check if the respawn point is of respawn anchor type.
+
+
isAutoPurgeEnabled() - Method in interface com.onarandombox.MultiverseCore.api.MultiverseCoreConfig
+
+
Gets whether or not the automatic purge of entities is enabled.
+
+
isAutoPurgeEnabled() - Method in class com.onarandombox.MultiverseCore.MultiverseCoreConfiguration
+
 
+
isBlockAboveAir(Location) - Method in interface com.onarandombox.MultiverseCore.api.BlockSafety
+
+
This function checks whether the block at the given coordinates are above air or not.
+
+
isBlockAboveAir(Location) - Method in class com.onarandombox.MultiverseCore.utils.SimpleBlockSafety
+
+
This function checks whether the block at the given coordinates are above air or not.
+
+
isCancelled() - Method in class com.onarandombox.MultiverseCore.event.MVPlayerTouchedPortalEvent
+
 
+
isCancelled() - Method in class com.onarandombox.MultiverseCore.event.MVTeleportEvent
+
 
+
isCancelled() - Method in class com.onarandombox.MultiverseCore.event.MVWorldDeleteEvent
+
isCancelled() - Method in class com.onarandombox.MultiverseCore.event.MVWorldPropertyChangeEvent
+
 
+
isCancelled() - Method in class com.onarandombox.MultiverseCore.listeners.AsyncChatEvent
+
 
+
isCancelled() - Method in interface com.onarandombox.MultiverseCore.listeners.ChatEvent
+
 
+
isCancelled() - Method in class com.onarandombox.MultiverseCore.listeners.NormalChatEvent
+
+
Deprecated.
+ 
+
isDisabled() - Static method in class com.onarandombox.MultiverseCore.utils.TestingMode
+
 
+
isEntitiyOnTrack(Location) - Method in interface com.onarandombox.MultiverseCore.api.BlockSafety
+
+
Checks if an entity would be on track at the specified Location.
+
+
isEntitiyOnTrack(Location) - Method in class com.onarandombox.MultiverseCore.utils.SimpleBlockSafety
+
+
Checks if an entity would be on track at the specified Location.
+
+
isExactMatch() - Method in class com.onarandombox.MultiverseCore.display.ContentFilter
+
 
+
isHidden() - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Gets whether or not this world will display in chat, mvw and mvl regardless if a user has the + access permissions to go to this world.
+
+
isHidden() - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Gets whether or not this world will display in chat, mvw and mvl regardless if a user has the + access permissions to go to this world.
+
+
isHidden() - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
isItemCurrency(Material) - Static method in class com.onarandombox.MultiverseCore.utils.MVEconomist
+
+
Determines if the currency type string given represents an item currency.
+
+
isKeepingSpawnInMemory() - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Gets whether or not CraftBukkit is keeping the chunks for this world in memory.
+
+
isKeepingSpawnInMemory() - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Gets whether or not CraftBukkit is keeping the chunks for this world in memory.
+
+
isKeepingSpawnInMemory() - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
isKeepingSpawnInMemory(World) - Method in interface com.onarandombox.MultiverseCore.api.MVWorldManager
+
 
+
isKeepingSpawnInMemory(World) - Method in class com.onarandombox.MultiverseCore.utils.WorldManager
+
 
+
isMVWorld(String) - Method in interface com.onarandombox.MultiverseCore.api.MVWorldManager
+
+
Checks to see if the given name is a valid MultiverseWorld + Searches based on world name AND alias.
+
+
isMVWorld(String) - Method in class com.onarandombox.MultiverseCore.utils.WorldManager
+
+
Checks to see if the given name is a valid MultiverseWorld + Searches based on world name AND alias.
+
+
isMVWorld(String, boolean) - Method in interface com.onarandombox.MultiverseCore.api.MVWorldManager
+
+
Checks to see if the given name is a valid MultiverseWorld.
+
+
isMVWorld(String, boolean) - Method in class com.onarandombox.MultiverseCore.utils.WorldManager
+
+
Checks to see if the given name is a valid MultiverseWorld.
+
+
isMVWorld(World) - Method in interface com.onarandombox.MultiverseCore.api.MVWorldManager
+
+
Checks to see if the given world is a valid MultiverseWorld.
+
+
isMVWorld(World) - Method in class com.onarandombox.MultiverseCore.utils.WorldManager
+
+
Checks to see if the given world is a valid MultiverseWorld.
+
+
isPlayerWealthyEnough(Player, double, Material) - Method in class com.onarandombox.MultiverseCore.utils.MVEconomist
+
+
Determines if a player has enough of a given currency.
+
+
isPortalAllowed(PortalType) - Method in enum com.onarandombox.MultiverseCore.enums.AllowedPortalType
+
 
+
isPVPEnabled() - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Gets whether or not PVP is enabled in this world in some form (fake or not).
+
+
isPVPEnabled() - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Gets whether or not PVP is enabled in this world in some form (fake or not).
+
+
isPVPEnabled() - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
isSet() - Static method in class com.onarandombox.MultiverseCore.MultiverseCoreConfiguration
+
 
+
isShowingDonateMessage() - Method in interface com.onarandombox.MultiverseCore.api.MultiverseCoreConfig
+
+
Gets whether or not the donation/patreon messages are shown.
+
+
isShowingDonateMessage() - Method in class com.onarandombox.MultiverseCore.MultiverseCoreConfiguration
+
 
+
isSolidBlock(Material) - Static method in class com.onarandombox.MultiverseCore.utils.SimpleBlockSafety
+
 
+
isThisType(JavaPlugin, String) - Method in interface com.onarandombox.MultiverseCore.api.MVDestination
+
+
Allows you to determine if a Destination is valid for the type it thinks it is.
+
+
isThisType(JavaPlugin, String) - Method in class com.onarandombox.MultiverseCore.destination.AnchorDestination
+
+
Allows you to determine if a Destination is valid for the type it thinks it is.
+
+
isThisType(JavaPlugin, String) - Method in class com.onarandombox.MultiverseCore.destination.BedDestination
+
+
Allows you to determine if a Destination is valid for the type it thinks it is.
+
+
isThisType(JavaPlugin, String) - Method in class com.onarandombox.MultiverseCore.destination.CannonDestination
+
+
Allows you to determine if a Destination is valid for the type it thinks it is.
+
+
isThisType(JavaPlugin, String) - Method in class com.onarandombox.MultiverseCore.destination.ExactDestination
+
+
Allows you to determine if a Destination is valid for the type it thinks it is.
+
+
isThisType(JavaPlugin, String) - Method in class com.onarandombox.MultiverseCore.destination.InvalidDestination
+
+
Allows you to determine if a Destination is valid for the type it thinks it is.
+
+
isThisType(JavaPlugin, String) - Method in class com.onarandombox.MultiverseCore.destination.PlayerDestination
+
+
Allows you to determine if a Destination is valid for the type it thinks it is.
+
+
isThisType(JavaPlugin, String) - Method in class com.onarandombox.MultiverseCore.destination.WorldDestination
+
+
Allows you to determine if a Destination is valid for the type it thinks it is.
+
+
isUseTravelAgent() - Static method in class com.onarandombox.MultiverseCore.utils.CompatibilityLayer
+
+
Gets if Travel Agent is supported on the server's minecraft version.
+
+
isUsingDefaultPortalSearch() - Method in interface com.onarandombox.MultiverseCore.api.MultiverseCoreConfig
+
+
Gets whether or not Bukkit will be determining portal search radius on its own or if Multiverse should help.
+
+
isUsingDefaultPortalSearch() - Method in class com.onarandombox.MultiverseCore.MultiverseCoreConfiguration
+
 
+
isUsingEconomyPlugin() - Method in class com.onarandombox.MultiverseCore.utils.MVEconomist
+
+
Checks if an economy plugin is in use.
+
+
isUsingSafeTTeleporter() - Method in class com.onarandombox.MultiverseCore.event.MVTeleportEvent
+
+
Looks if this MVTeleportEvent is using the SafeTTeleporter.
+
+
isValid() - Method in interface com.onarandombox.MultiverseCore.api.MVDestination
+
+
Returns true if the destination is valid and players will be taken to it.
+
+
isValid() - Method in class com.onarandombox.MultiverseCore.destination.AnchorDestination
+
+
Returns true if the destination is valid and players will be taken to it.
+
+
isValid() - Method in class com.onarandombox.MultiverseCore.destination.BedDestination
+
+
Returns true if the destination is valid and players will be taken to it.
+
+
isValid() - Method in class com.onarandombox.MultiverseCore.destination.CannonDestination
+
+
Returns true if the destination is valid and players will be taken to it.
+
+
isValid() - Method in class com.onarandombox.MultiverseCore.destination.ExactDestination
+
+
Returns true if the destination is valid and players will be taken to it.
+
+
isValid() - Method in class com.onarandombox.MultiverseCore.destination.InvalidDestination
+
+
Returns true if the destination is valid and players will be taken to it.
+
+
isValid() - Method in class com.onarandombox.MultiverseCore.destination.PlayerDestination
+
+
Returns true if the destination is valid and players will be taken to it.
+
+
isValid() - Method in class com.onarandombox.MultiverseCore.destination.WorldDestination
+
+
Returns true if the destination is valid and players will be taken to it.
+
+
isValidAliasColor(String) - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Deprecated. +
This has been moved: EnglishChatColor.isValidAliasColor(String)
+
+
+
isValidAliasColor(String) - Static method in enum com.onarandombox.MultiverseCore.enums.EnglishChatColor
+
+
Looks if the given-color name is a valid color.
+
+
isValidAliasColor(String) - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Deprecated. +
This is deprecated.
+
+
+
isValidWorldFolder(File) - Static method in class com.onarandombox.MultiverseCore.utils.WorldNameChecker
+
+
Checks if a world folder is valid.
+
+
isValidWorldFolder(String) - Static method in class com.onarandombox.MultiverseCore.utils.WorldNameChecker
+
+
Checks if a world name has a valid world folder.
+
+
isValidWorldName(String) - Static method in class com.onarandombox.MultiverseCore.utils.WorldNameChecker
+
+
Checks if a world name is valid.
+
+
isWeatherEnabled() - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Gets whether weather is enabled in this world.
+
+
isWeatherEnabled() - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Gets whether weather is enabled in this world.
+
+
isWeatherEnabled() - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
ITALIC - com.onarandombox.MultiverseCore.enums.EnglishChatStyle
+
 
+
itemsPerPage - Variable in class com.onarandombox.MultiverseCore.commands.PaginatedCommand
+
+
The number of items per page.
+
+
+ + + +

L

+
+
LIGHTPURPLE - com.onarandombox.MultiverseCore.enums.EnglishChatColor
+
 
+
LINE_BREAK - Static variable in class com.onarandombox.MultiverseCore.display.ContentDisplay
+
 
+
LINES_PER_PAGE - Static variable in class com.onarandombox.MultiverseCore.display.settings.PagedDisplaySettings
+
+
The max number of lines per page.
+
+
LIST - Static variable in class com.onarandombox.MultiverseCore.display.DisplayHandlers
+
+
Standard list display.
+
+
ListCommand - Class in com.onarandombox.MultiverseCore.commands
+
+
Displays a listing of all worlds that a player can enter.
+
+
ListCommand(MultiverseCore) - Constructor for class com.onarandombox.MultiverseCore.commands.ListCommand
+
 
+
ListDisplayHandler - Class in com.onarandombox.MultiverseCore.display.handlers
+
 
+
ListDisplayHandler() - Constructor for class com.onarandombox.MultiverseCore.display.handlers.ListDisplayHandler
+
 
+
loadAnchors() - Method in class com.onarandombox.MultiverseCore.utils.AnchorManager
+
+
Loads all anchors.
+
+
LoadCommand - Class in com.onarandombox.MultiverseCore.commands
+
+
Loads a world into Multiverse.
+
+
LoadCommand(MultiverseCore) - Constructor for class com.onarandombox.MultiverseCore.commands.LoadCommand
+
 
+
loadConfigs() - Method in interface com.onarandombox.MultiverseCore.api.Core
+
+
Reloads the Multiverse Configuration files: + worlds.yml and config.yml.
+
+
loadConfigs() - Method in class com.onarandombox.MultiverseCore.MultiverseCore
+
+
Reloads the Multiverse Configuration files: + worlds.yml and config.yml.
+
+
loadDefaultWorlds() - Method in interface com.onarandombox.MultiverseCore.api.MVWorldManager
+
+
Loads the Worlds & Settings for any worlds that bukkit loaded before us.
+
+
loadDefaultWorlds() - Method in class com.onarandombox.MultiverseCore.utils.WorldManager
+
+
Loads the Worlds & Settings for any worlds that bukkit loaded before us.
+
+
loadWorld(String) - Method in interface com.onarandombox.MultiverseCore.api.MVWorldManager
+
+
Loads the world.
+
+
loadWorld(String) - Method in class com.onarandombox.MultiverseCore.utils.WorldManager
+
+
Loads the world.
+
+
loadWorld(WorldLoadEvent) - Method in class com.onarandombox.MultiverseCore.listeners.MVWorldListener
+
+
This method is called when Bukkit fires off a WorldLoadEvent.
+
+
loadWorldConfig(File) - Method in interface com.onarandombox.MultiverseCore.api.MVWorldManager
+
+
Load the config from a file.
+
+
loadWorldConfig(File) - Method in class com.onarandombox.MultiverseCore.utils.WorldManager
+
+
Load the config from a file.
+
+
loadWorlds(boolean) - Method in interface com.onarandombox.MultiverseCore.api.MVWorldManager
+
+
Load the Worlds & Settings from the configuration file.
+
+
loadWorlds(boolean) - Method in class com.onarandombox.MultiverseCore.utils.WorldManager
+
+
Load the Worlds & Settings from the configuration file.
+
+
LocationManipulation - Class in com.onarandombox.MultiverseCore.utils
+
+
Deprecated. +
Use instead: LocationManipulation and SimpleLocationManipulation.
+
+
+
LocationManipulation - Interface in com.onarandombox.MultiverseCore.api
+
+
Used to manipulate locations.
+
+
locationToString(Location) - Method in interface com.onarandombox.MultiverseCore.api.LocationManipulation
+
+
Convert a Location into a Colon separated string to allow us to store it in text.
+
+
locationToString(Location) - Static method in class com.onarandombox.MultiverseCore.utils.LocationManipulation
+
+
Deprecated.
+
Convert a Location into a Colon separated string to allow us to store it in text.
+
+
locationToString(Location) - Method in class com.onarandombox.MultiverseCore.utils.SimpleLocationManipulation
+
+
Convert a Location into a Colon separated string to allow us to store it in text.
+
+
log(Level, String) - Method in interface com.onarandombox.MultiverseCore.api.LoggablePlugin
+
+
Deprecated.
+
Logs a message at the specified level.
+
+
log(Level, String) - Method in class com.onarandombox.MultiverseCore.api.MultiversePlugin
+
 
+
log(Level, String) - Method in class com.onarandombox.MultiverseCore.MultiverseCore
+
+
Deprecated. +
This is now deprecated, nobody needs it any longer. + All logging is now done with Logging.
+
+
+
log(Level, String) - Method in class com.onarandombox.MultiverseCore.utils.DebugLog
+
+
Deprecated.
+
Log a message at a certain level.
+
+
LoggablePlugin - Interface in com.onarandombox.MultiverseCore.api
+
+
Deprecated. +
Replaced by Logging.
+
+
+
logTag - Variable in class com.onarandombox.MultiverseCore.api.MultiversePlugin
+
+
Prefix for standard log entrys.
+
+
+ + + +

M

+
+
MAGIC - com.onarandombox.MultiverseCore.enums.EnglishChatStyle
+
 
+
MapDisplaySettings - Class in com.onarandombox.MultiverseCore.display.settings
+
+
Collection of DisplaySetting that are used by various DisplayHandler.
+
+
MapDisplaySettings() - Constructor for class com.onarandombox.MultiverseCore.display.settings.MapDisplaySettings
+
 
+
mapInitialize(MapInitializeEvent) - Method in class com.onarandombox.MultiverseCore.listeners.MVMapListener
+
+
This method is called when a map is initialized.
+
+
MaterialConverter - Class in com.onarandombox.MultiverseCore.utils
+
+
A tool for converting values which may be an old type ID to a Material.
+
+
MaterialConverter() - Constructor for class com.onarandombox.MultiverseCore.utils.MaterialConverter
+
 
+
messaging - Variable in class com.onarandombox.MultiverseCore.commands.MultiverseCommand
+
+
The reference to MultiverseMessaging.
+
+
MetricsConfigurator - Class in com.onarandombox.MultiverseCore.utils.metrics
+
 
+
ModifyAddCommand - Class in com.onarandombox.MultiverseCore.commands
+
+
Used to modify various aspects of worlds.
+
+
ModifyAddCommand(MultiverseCore) - Constructor for class com.onarandombox.MultiverseCore.commands.ModifyAddCommand
+
 
+
ModifyClearCommand - Class in com.onarandombox.MultiverseCore.commands
+
+
Removes all values from a world-property.
+
+
ModifyClearCommand(MultiverseCore) - Constructor for class com.onarandombox.MultiverseCore.commands.ModifyClearCommand
+
 
+
ModifyCommand - Class in com.onarandombox.MultiverseCore.commands
+
+
Used to modify various aspects of worlds.
+
+
ModifyCommand(MultiverseCore) - Constructor for class com.onarandombox.MultiverseCore.commands.ModifyCommand
+
 
+
ModifyRemoveCommand - Class in com.onarandombox.MultiverseCore.commands
+
+
Removes values from a world-property.
+
+
ModifyRemoveCommand(MultiverseCore) - Constructor for class com.onarandombox.MultiverseCore.commands.ModifyRemoveCommand
+
 
+
ModifySetCommand - Class in com.onarandombox.MultiverseCore.commands
+
+
Used to set world-properties.
+
+
ModifySetCommand(MultiverseCore) - Constructor for class com.onarandombox.MultiverseCore.commands.ModifySetCommand
+
 
+
monsters - com.onarandombox.MultiverseCore.enums.AddProperties
+
+
Monster-exceptions.
+
+
MultiverseCommand - Class in com.onarandombox.MultiverseCore.commands
+
+
A generic Multiverse-command.
+
+
MultiverseCommand(MultiverseCore) - Constructor for class com.onarandombox.MultiverseCore.commands.MultiverseCommand
+
 
+
MultiverseCore - Class in com.onarandombox.MultiverseCore
+
+
The implementation of the Multiverse-Core.
+
+
MultiverseCore() - Constructor for class com.onarandombox.MultiverseCore.MultiverseCore
+
 
+
MultiverseCore(JavaPluginLoader, PluginDescriptionFile, File, File) - Constructor for class com.onarandombox.MultiverseCore.MultiverseCore
+
+
This is for unit testing.
+
+
MultiverseCoreConfig - Interface in com.onarandombox.MultiverseCore.api
+
+
The configuration of MultiverseCore.
+
+
MultiverseCoreConfiguration - Class in com.onarandombox.MultiverseCore
+
+
Our configuration.
+
+
MultiverseCoreConfiguration() - Constructor for class com.onarandombox.MultiverseCore.MultiverseCoreConfiguration
+
 
+
MultiverseCoreConfiguration(Map<String, Object>) - Constructor for class com.onarandombox.MultiverseCore.MultiverseCoreConfiguration
+
 
+
MultiverseCoreListener - Class in com.onarandombox.MultiverseCore.listeners
+
+
Subclasses of this listener can be used to conveniently listen to MultiverseCore-events.
+
+
MultiverseCoreListener() - Constructor for class com.onarandombox.MultiverseCore.listeners.MultiverseCoreListener
+
 
+
MultiverseMessaging - Interface in com.onarandombox.MultiverseCore.api
+
+
Multiverse-messaging.
+
+
MultiversePlugin - Class in com.onarandombox.MultiverseCore.api
+
+
Make things easier for MV-Plugins!
+
+
MultiversePlugin() - Constructor for class com.onarandombox.MultiverseCore.api.MultiversePlugin
+
 
+
MultiverseWorld - Interface in com.onarandombox.MultiverseCore.api
+
+
The API for a Multiverse Handled World.
+
+
MVAsyncPlayerChatListener - Class in com.onarandombox.MultiverseCore.listeners
+
+
Multiverse's Listener for players.
+
+
MVAsyncPlayerChatListener(MultiverseCore, MVPlayerListener) - Constructor for class com.onarandombox.MultiverseCore.listeners.MVAsyncPlayerChatListener
+
 
+
MVChatListener - Class in com.onarandombox.MultiverseCore.listeners
+
+
Multiverse's Listener for players.
+
+
MVChatListener(MultiverseCore, MVPlayerListener) - Constructor for class com.onarandombox.MultiverseCore.listeners.MVChatListener
+
 
+
MVConfigReloadEvent - Class in com.onarandombox.MultiverseCore.event
+
+
Called when the Multiverse-config should be reloaded.
+
+
MVConfigReloadEvent(List<String>) - Constructor for class com.onarandombox.MultiverseCore.event.MVConfigReloadEvent
+
 
+
MVDebugModeEvent - Class in com.onarandombox.MultiverseCore.event
+
+
Called when Core's debug level is changed.
+
+
MVDebugModeEvent(int) - Constructor for class com.onarandombox.MultiverseCore.event.MVDebugModeEvent
+
 
+
MVDestination - Interface in com.onarandombox.MultiverseCore.api
+
+
A destination API for Multiverse + Any plugin can add these to MV and when they are, any action that uses them (portals, MVTP, etc.) can use them!
+
+
MVEconomist - Class in com.onarandombox.MultiverseCore.utils
+
+
Multiverse's Friendly Economist.
+
+
MVEconomist(Plugin) - Constructor for class com.onarandombox.MultiverseCore.utils.MVEconomist
+
 
+
MVEntityListener - Class in com.onarandombox.MultiverseCore.listeners
+
+
Multiverse's Entity Listener.
+
+
MVEntityListener(MultiverseCore) - Constructor for class com.onarandombox.MultiverseCore.listeners.MVEntityListener
+
 
+
MVMapListener - Class in com.onarandombox.MultiverseCore.listeners
+
+
A listener for bukkit map events.
+
+
MVMapListener(MultiverseCore) - Constructor for class com.onarandombox.MultiverseCore.listeners.MVMapListener
+
 
+
MVMessaging - Class in com.onarandombox.MultiverseCore.utils
+
+
The default-implementation of MultiverseMessaging.
+
+
MVMessaging() - Constructor for class com.onarandombox.MultiverseCore.utils.MVMessaging
+
 
+
MVPermissions - Class in com.onarandombox.MultiverseCore.utils
+
+
Multiverse's PermissionsInterface.
+
+
MVPermissions(MultiverseCore) - Constructor for class com.onarandombox.MultiverseCore.utils.MVPermissions
+
 
+
MVPlayerChatListener - Class in com.onarandombox.MultiverseCore.listeners
+
+
Multiverse's Listener for players.
+
+
MVPlayerChatListener(MultiverseCore, MVPlayerListener) - Constructor for class com.onarandombox.MultiverseCore.listeners.MVPlayerChatListener
+
 
+
MVPlayerListener - Class in com.onarandombox.MultiverseCore.listeners
+
+
Multiverse's Listener for players.
+
+
MVPlayerListener(MultiverseCore) - Constructor for class com.onarandombox.MultiverseCore.listeners.MVPlayerListener
+
 
+
MVPlayerSession - Class in com.onarandombox.MultiverseCore.utils
+
+
A player-session.
+
+
MVPlayerSession(Player, MultiverseCoreConfig) - Constructor for class com.onarandombox.MultiverseCore.utils.MVPlayerSession
+
 
+
MVPlayerTouchedPortalEvent - Class in com.onarandombox.MultiverseCore.event
+
+
This event is thrown when a portal is touched.
+
+
MVPlayerTouchedPortalEvent(Player, Location) - Constructor for class com.onarandombox.MultiverseCore.event.MVPlayerTouchedPortalEvent
+
 
+
MVPlugin - Interface in com.onarandombox.MultiverseCore.api
+
+
This interface is implemented by every official Multiverse-plugin.
+
+
MVPortalListener - Class in com.onarandombox.MultiverseCore.listeners
+
+
A custom listener for portal related events.
+
+
MVPortalListener(MultiverseCore) - Constructor for class com.onarandombox.MultiverseCore.listeners.MVPortalListener
+
 
+
MVRespawnEvent - Class in com.onarandombox.MultiverseCore.event
+
+
Called when a player is respawning.
+
+
MVRespawnEvent(Location, Player, String) - Constructor for class com.onarandombox.MultiverseCore.event.MVRespawnEvent
+
 
+
MVTeleportEvent - Class in com.onarandombox.MultiverseCore.event
+
+
Event that gets called when a player use the /mvtp command.
+
+
MVTeleportEvent(MVDestination, Player, CommandSender, boolean) - Constructor for class com.onarandombox.MultiverseCore.event.MVTeleportEvent
+
 
+
MVTravelAgent - Class in com.onarandombox.MultiverseCore.utils
+
+
The Multiverse TravelAgent.
+
+
MVTravelAgent(MultiverseCore, MVDestination, Player) - Constructor for class com.onarandombox.MultiverseCore.utils.MVTravelAgent
+
 
+
MVVersionEvent - Class in com.onarandombox.MultiverseCore.event
+
+
Called when somebody requests version information about Multiverse.
+
+
MVVersionEvent() - Constructor for class com.onarandombox.MultiverseCore.event.MVVersionEvent
+
 
+
MVWeatherListener - Class in com.onarandombox.MultiverseCore.listeners
+
+
Multiverse's Weather Listener.
+
+
MVWeatherListener(MultiverseCore) - Constructor for class com.onarandombox.MultiverseCore.listeners.MVWeatherListener
+
 
+
MVWorld - Class in com.onarandombox.MultiverseCore
+
+
The implementation of a Multiverse handled world.
+
+
MVWorld(MultiverseCore, World, WorldProperties) - Constructor for class com.onarandombox.MultiverseCore.MVWorld
+
 
+
MVWorld(MultiverseCore, World, WorldProperties, boolean) - Constructor for class com.onarandombox.MultiverseCore.MVWorld
+
 
+
MVWorld.NullLocation - Class in com.onarandombox.MultiverseCore
+
+
Null-location.
+
+
MVWorldDeleteEvent - Class in com.onarandombox.MultiverseCore.event
+
+
Called when a world is about to be deleted by Multiverse.
+
+
MVWorldDeleteEvent(MultiverseWorld, boolean) - Constructor for class com.onarandombox.MultiverseCore.event.MVWorldDeleteEvent
+
 
+
MVWorldInitListener - Class in com.onarandombox.MultiverseCore.listeners
+
 
+
MVWorldInitListener(MultiverseCore) - Constructor for class com.onarandombox.MultiverseCore.listeners.MVWorldInitListener
+
 
+
MVWorldListener - Class in com.onarandombox.MultiverseCore.listeners
+
+
Multiverse's World Listener.
+
+
MVWorldListener(MultiverseCore) - Constructor for class com.onarandombox.MultiverseCore.listeners.MVWorldListener
+
 
+
MVWorldManager - Interface in com.onarandombox.MultiverseCore.api
+
+
Multiverse 2 World Manager API
+
+
MVWorldPropertyChangeEvent<T> - Class in com.onarandombox.MultiverseCore.event
+
+
This event is fired *before* the property is actually changed.
+
+
MVWorldPropertyChangeEvent(MultiverseWorld, CommandSender, String, T) - Constructor for class com.onarandombox.MultiverseCore.event.MVWorldPropertyChangeEvent
+
 
+
+ + + +

N

+
+
NETHER - com.onarandombox.MultiverseCore.enums.AllowedPortalType
+
+
Only Nether style portals are allowed.
+
+
NONE - com.onarandombox.MultiverseCore.enums.AllowedPortalType
+
+
No portals are allowed.
+
+
NORMAL - com.onarandombox.MultiverseCore.enums.EnglishChatStyle
+
+
No style.
+
+
NormalChatEvent - Class in com.onarandombox.MultiverseCore.listeners
+
+
Deprecated. +
This is deprecated like the PlayerChatEvent.
+
+
+
NormalChatEvent(PlayerChatEvent) - Constructor for class com.onarandombox.MultiverseCore.listeners.NormalChatEvent
+
+
Deprecated.
+ 
+
NOT_A_WORLD - com.onarandombox.MultiverseCore.utils.WorldNameChecker.FolderStatus
+
+
Folder exist, but contents in it doesnt look like a world.
+
+
NullLocation() - Constructor for class com.onarandombox.MultiverseCore.MVWorld.NullLocation
+
 
+
+ + + +

O

+
+
onCommand(CommandSender, Command, String, String[]) - Method in class com.onarandombox.MultiverseCore.api.MultiversePlugin
+
 
+
onCommand(CommandSender, Command, String, String[]) - Method in class com.onarandombox.MultiverseCore.MultiverseCore
+
onDisable() - Method in class com.onarandombox.MultiverseCore.MultiverseCore
+
onEnable() - Method in class com.onarandombox.MultiverseCore.api.MultiversePlugin
+
+
+ + Note: You can't override this, use MultiversePlugin.onPluginEnable() instead!
+
+
onEnable() - Method in class com.onarandombox.MultiverseCore.MultiverseCore
+
onLoad() - Method in class com.onarandombox.MultiverseCore.MultiverseCore
+
 
+
onPluginEnable() - Method in class com.onarandombox.MultiverseCore.api.MultiversePlugin
+
+
Called when the plugin is enabled.
+
+
OPERATOR - Static variable in class com.onarandombox.MultiverseCore.display.settings.MapDisplaySettings
+
+
The thing between a key value pair.
+
+
OTHER - com.onarandombox.MultiverseCore.enums.RespawnType
+
 
+
OWN_BED_STRING - Static variable in class com.onarandombox.MultiverseCore.destination.BedDestination
+
 
+
+ + + +

P

+
+
PAGE_IN_CONSOLE - Static variable in class com.onarandombox.MultiverseCore.display.settings.PagedDisplaySettings
+
+
Should display with paging when it's sent to console.
+
+
PAGE_LIST - Static variable in class com.onarandombox.MultiverseCore.display.DisplayHandlers
+
+
List display with paging.
+
+
PagedDisplaySettings - Class in com.onarandombox.MultiverseCore.display.settings
+
 
+
PagedDisplaySettings() - Constructor for class com.onarandombox.MultiverseCore.display.settings.PagedDisplaySettings
+
 
+
PagedListDisplayHandler - Class in com.onarandombox.MultiverseCore.display.handlers
+
 
+
PagedListDisplayHandler() - Constructor for class com.onarandombox.MultiverseCore.display.handlers.PagedListDisplayHandler
+
 
+
PaginatedCommand<T> - Class in com.onarandombox.MultiverseCore.commands
+
+
A generic paginated command.
+
+
PaginatedCommand(JavaPlugin) - Constructor for class com.onarandombox.MultiverseCore.commands.PaginatedCommand
+
 
+
PaginatedCommand.FilterObject - Class in com.onarandombox.MultiverseCore.commands
+
+
"Key-Object" containing information about the page and the filter that were requested.
+
+
PaginatedCoreCommand<T> - Class in com.onarandombox.MultiverseCore.commands
+
+
A generic paginated Multiverse-command.
+
+
PaginatedCoreCommand(MultiverseCore) - Constructor for class com.onarandombox.MultiverseCore.commands.PaginatedCoreCommand
+
 
+
PASTEBIN - com.onarandombox.MultiverseCore.utils.webpaste.PasteServiceType
+
 
+
PasteFailedException - Exception in com.onarandombox.MultiverseCore.utils.webpaste
+
+
Thrown when pasting fails.
+
+
PasteFailedException() - Constructor for exception com.onarandombox.MultiverseCore.utils.webpaste.PasteFailedException
+
 
+
PasteFailedException(Throwable) - Constructor for exception com.onarandombox.MultiverseCore.utils.webpaste.PasteFailedException
+
 
+
PASTEGG - com.onarandombox.MultiverseCore.utils.webpaste.PasteServiceType
+
 
+
PasteService - Class in com.onarandombox.MultiverseCore.utils.webpaste
+
+
An interface to a web-based text-pasting service.
+
+
PasteServiceFactory - Class in com.onarandombox.MultiverseCore.utils.webpaste
+
+
Used to construct PasteServices.
+
+
PasteServiceType - Enum in com.onarandombox.MultiverseCore.utils.webpaste
+
+
An enum containing all known PasteServices.
+
+
PermissionTools - Class in com.onarandombox.MultiverseCore.utils
+
+
Utility-class for permissions.
+
+
PermissionTools(MultiverseCore) - Constructor for class com.onarandombox.MultiverseCore.utils.PermissionTools
+
 
+
player - Variable in class com.onarandombox.MultiverseCore.utils.MVTravelAgent
+
 
+
playerCanBypassPlayerLimit(MultiverseWorld, CommandSender, Player) - Method in class com.onarandombox.MultiverseCore.utils.PermissionTools
+
+
Checks to see if a player can bypass the player limit.
+
+
playerCanGoFromTo(MultiverseWorld, MultiverseWorld, CommandSender, Player) - Method in class com.onarandombox.MultiverseCore.utils.PermissionTools
+
+
Checks to see if player can go to a world given their current status.
+
+
playerCanIgnoreGameModeRestriction(MultiverseWorld, Player) - Method in class com.onarandombox.MultiverseCore.utils.PermissionTools
+
+
Checks to see if a player should bypass game mode restrictions.
+
+
playerCanSpawnHereSafely(Location) - Method in interface com.onarandombox.MultiverseCore.api.BlockSafety
+
+
This function checks whether the block at the coordinates given is safe or not by checking for Lava/Fire/Air + etc.
+
+
playerCanSpawnHereSafely(Location) - Method in class com.onarandombox.MultiverseCore.utils.SimpleBlockSafety
+
+
This function checks whether the block at the coordinates given is safe or not by checking for Lava/Fire/Air + etc.
+
+
playerCanSpawnHereSafely(World, double, double, double) - Method in interface com.onarandombox.MultiverseCore.api.BlockSafety
+
+
Checks if a player can spawn safely at the given coordinates.
+
+
playerCanSpawnHereSafely(World, double, double, double) - Method in class com.onarandombox.MultiverseCore.utils.SimpleBlockSafety
+
+
Checks if a player can spawn safely at the given coordinates.
+
+
playerChangedWorld(PlayerChangedWorldEvent) - Method in class com.onarandombox.MultiverseCore.listeners.MVPlayerListener
+
+
This method is called when a player changes worlds.
+
+
playerChat(ChatEvent) - Method in class com.onarandombox.MultiverseCore.listeners.MVChatListener
+
+
This handles a ChatEvent.
+
+
playerChat(AsyncPlayerChatEvent) - Method in class com.onarandombox.MultiverseCore.listeners.MVAsyncPlayerChatListener
+
+
This method is called when a player wants to chat.
+
+
playerChat(PlayerChatEvent) - Method in class com.onarandombox.MultiverseCore.listeners.MVPlayerChatListener
+
+
This method is called when a player wants to chat.
+
+
PlayerDestination - Class in com.onarandombox.MultiverseCore.destination
+
+
A player-MVDestination.
+
+
PlayerDestination() - Constructor for class com.onarandombox.MultiverseCore.destination.PlayerDestination
+
 
+
PlayerFinder - Class in com.onarandombox.MultiverseCore.utils
+
+
Helper class to get Player from name, UUID or Selectors.
+
+
PlayerFinder() - Constructor for class com.onarandombox.MultiverseCore.utils.PlayerFinder
+
 
+
playerHasMoneyToEnter(MultiverseWorld, MultiverseWorld, CommandSender, Player, boolean) - Method in class com.onarandombox.MultiverseCore.utils.PermissionTools
+
+
Checks if the given Player has enough money to enter the specified MultiverseWorld.
+
+
playerJoin(PlayerJoinEvent) - Method in class com.onarandombox.MultiverseCore.listeners.MVPlayerListener
+
+
This method is called when a player joins the server.
+
+
playerPortal(PlayerPortalEvent) - Method in class com.onarandombox.MultiverseCore.listeners.MVPlayerListener
+
+
This method is called when a player actually portals via a vanilla style portal.
+
+
playerPortalCheck(PlayerPortalEvent) - Method in class com.onarandombox.MultiverseCore.listeners.MVPlayerListener
+
+
This method is called to adjust the portal location to the actual portal location (and not + right outside of it.
+
+
playerQuit(PlayerQuitEvent) - Method in class com.onarandombox.MultiverseCore.listeners.MVPlayerListener
+
+
This method is called when a player quits the game.
+
+
playerRespawn(MVRespawnEvent) - Method in class com.onarandombox.MultiverseCore.listeners.MultiverseCoreListener
+
+
Called when a MVRespawnEvent is fired.
+
+
playerRespawn(PlayerRespawnEvent) - Method in class com.onarandombox.MultiverseCore.listeners.MVPlayerListener
+
+
This method is called when a player respawns.
+
+
playerTeleport(MVTeleportEvent) - Method in class com.onarandombox.MultiverseCore.listeners.MultiverseCoreListener
+
+
Called when a MVTeleportEvent is fired.
+
+
playerTeleport(PlayerTeleportEvent) - Method in class com.onarandombox.MultiverseCore.listeners.MVPlayerListener
+
+
This method is called when a player teleports anywhere.
+
+
playerTouchedPortal(MVPlayerTouchedPortalEvent) - Method in class com.onarandombox.MultiverseCore.listeners.MultiverseCoreListener
+
+
Called when a MVPlayerTouchedPortalEvent is fired.
+
+
plugin - Variable in class com.onarandombox.MultiverseCore.commands.MultiverseCommand
+
+
The reference to the core.
+
+
plugin - Variable in class com.onarandombox.MultiverseCore.commands.PaginatedCoreCommand
+
+
The reference to the core.
+
+
portalForm(PlayerInteractEvent) - Method in class com.onarandombox.MultiverseCore.listeners.MVPortalListener
+
+
This method will prevent ender portals from being created in worlds where they are not allowed due to portalForm.
+
+
portalForm(PortalCreateEvent) - Method in class com.onarandombox.MultiverseCore.listeners.MVPortalListener
+
+
This is called when a portal is created as the result of another world being linked.
+
+
postData(String) - Method in class com.onarandombox.MultiverseCore.utils.webpaste.PasteService
+
+
Post data to the Web.
+
+
postData(Map<String, String>) - Method in class com.onarandombox.MultiverseCore.utils.webpaste.PasteService
+
+
Post data to the Web.
+
+
PropertyDoesNotExistException - Exception in com.onarandombox.MultiverseCore.exceptions
+
+
Thrown when a world-property doesn't exist.
+
+
PropertyDoesNotExistException(String) - Constructor for exception com.onarandombox.MultiverseCore.exceptions.PropertyDoesNotExistException
+
 
+
PropertyDoesNotExistException(String, Throwable) - Constructor for exception com.onarandombox.MultiverseCore.exceptions.PropertyDoesNotExistException
+
 
+
PurgeCommand - Class in com.onarandombox.MultiverseCore.commands
+
+
Removes a type of mob from a world.
+
+
PurgeCommand(MultiverseCore) - Constructor for class com.onarandombox.MultiverseCore.commands.PurgeCommand
+
 
+
purgeWorld(MultiverseWorld) - Method in interface com.onarandombox.MultiverseCore.api.WorldPurger
+
+
Convenience method for WorldPurger.purgeWorld(MultiverseWorld, java.util.List, boolean, boolean) that takes the settings from the world-config.
+
+
purgeWorld(MultiverseWorld) - Method in class com.onarandombox.MultiverseCore.utils.SimpleWorldPurger
+
+
Convenience method for WorldPurger.purgeWorld(MultiverseWorld, java.util.List, boolean, boolean) that takes the settings from the world-config.
+
+
purgeWorld(MultiverseWorld, List<String>, boolean, boolean) - Method in interface com.onarandombox.MultiverseCore.api.WorldPurger
+
+
Clear all animals/monsters that do not belong to a world according to the config.
+
+
purgeWorld(MultiverseWorld, List<String>, boolean, boolean) - Method in class com.onarandombox.MultiverseCore.utils.SimpleWorldPurger
+
+
Clear all animals/monsters that do not belong to a world according to the config.
+
+
purgeWorld(MultiverseWorld, List<String>, boolean, boolean, CommandSender) - Method in interface com.onarandombox.MultiverseCore.api.WorldPurger
+
+
Clear all animals/monsters that do not belong to a world according to the config.
+
+
purgeWorld(MultiverseWorld, List<String>, boolean, boolean, CommandSender) - Method in class com.onarandombox.MultiverseCore.utils.SimpleWorldPurger
+
+
Clear all animals/monsters that do not belong to a world according to the config.
+
+
purgeWorld(CommandSender, MultiverseWorld) - Method in class com.onarandombox.MultiverseCore.utils.PurgeWorlds
+
+
Deprecated.
+
Convenience method for PurgeWorlds.purgeWorld(CommandSender, MultiverseWorld, List, boolean, boolean) that takes the settings from the world-config.
+
+
purgeWorld(CommandSender, MultiverseWorld, List<String>, boolean, boolean) - Method in class com.onarandombox.MultiverseCore.utils.PurgeWorlds
+
+
Deprecated.
+
Clear all animals/monsters that do not belong to a world according to the config.
+
+
purgeWorlds(List<MultiverseWorld>) - Method in interface com.onarandombox.MultiverseCore.api.WorldPurger
+
+
Synchronizes the given worlds with their settings.
+
+
purgeWorlds(List<MultiverseWorld>) - Method in class com.onarandombox.MultiverseCore.utils.SimpleWorldPurger
+
+
Synchronizes the given worlds with their settings.
+
+
purgeWorlds(CommandSender, List<MultiverseWorld>) - Method in class com.onarandombox.MultiverseCore.utils.PurgeWorlds
+
+
Deprecated.
+
Synchronizes the given world with it's settings.
+
+
PurgeWorlds - Class in com.onarandombox.MultiverseCore.utils
+
+
Deprecated. +
Use instead: WorldPurger and SimpleWorldPurger.
+
+
+
PurgeWorlds(MultiverseCore) - Constructor for class com.onarandombox.MultiverseCore.utils.PurgeWorlds
+
+
Deprecated.
+ 
+
putDetailedVersionInfo(String, File) - Method in class com.onarandombox.MultiverseCore.event.MVVersionEvent
+
+
Adds a file to to the detailed version-info currently saved in this event.
+
+
putDetailedVersionInfo(String, String) - Method in class com.onarandombox.MultiverseCore.event.MVVersionEvent
+
+
Adds a file to to the detailed version-info currently saved in this event.
+
+
+ + + +

Q

+
+
QueuedCommand - Class in com.onarandombox.MultiverseCore.commandtools.queue
+
+
Represents a single command used in CommandQueueManager for confirming before running potentially + dangerous action.
+
+
QueuedCommand(CommandSender, Runnable) - Constructor for class com.onarandombox.MultiverseCore.commandtools.queue.QueuedCommand
+
 
+
QueuedCommand(CommandSender, Runnable, int) - Constructor for class com.onarandombox.MultiverseCore.commandtools.queue.QueuedCommand
+
 
+
QueuedCommand(CommandSender, Runnable, String) - Constructor for class com.onarandombox.MultiverseCore.commandtools.queue.QueuedCommand
+
 
+
QueuedCommand(CommandSender, Runnable, String, int) - Constructor for class com.onarandombox.MultiverseCore.commandtools.queue.QueuedCommand
+
+
Creates a new queue command, to be registered at CommandQueueManager.addToQueue(QueuedCommand).
+
+
+ + + +

R

+
+
RED - com.onarandombox.MultiverseCore.enums.EnglishChatColor
+
 
+
ReflectHelper - Class in com.onarandombox.MultiverseCore.utils
+
+
Utility class used to help in doing various reflection actions.
+
+
ReflectHelper() - Constructor for class com.onarandombox.MultiverseCore.utils.ReflectHelper
+
 
+
RegenCommand - Class in com.onarandombox.MultiverseCore.commands
+
+
Regenerates a world.
+
+
RegenCommand(MultiverseCore) - Constructor for class com.onarandombox.MultiverseCore.commands.RegenCommand
+
 
+
regenWorld(String, boolean, boolean, String) - Method in interface com.onarandombox.MultiverseCore.api.MVWorldManager
+
+
Regenerates a world.
+
+
regenWorld(String, boolean, boolean, String) - Method in class com.onarandombox.MultiverseCore.utils.WorldManager
+
+
Regenerates a world.
+
+
regenWorld(String, boolean, boolean, String, boolean) - Method in interface com.onarandombox.MultiverseCore.api.MVWorldManager
+
+
Regenerates a world.
+
+
regenWorld(String, boolean, boolean, String, boolean) - Method in class com.onarandombox.MultiverseCore.utils.WorldManager
+
+
Regenerates a world.
+
+
regenWorld(String, Boolean, Boolean, String) - Method in interface com.onarandombox.MultiverseCore.api.Core
+
+
Deprecated. +
Use MVWorldManager.regenWorld(String, boolean, boolean, String, boolean) instead.
+
+
+
regenWorld(String, Boolean, Boolean, String) - Method in class com.onarandombox.MultiverseCore.MultiverseCore
+
+
Deprecated. +
This is deprecated! Do not use!
+
+
+
regenWorld(String, Boolean, Boolean, String, Boolean) - Method in interface com.onarandombox.MultiverseCore.api.Core
+
+
Deprecated. +
Use MVWorldManager.regenWorld(String, boolean, boolean, String, boolean) instead.
+
+
+
regenWorld(String, Boolean, Boolean, String, Boolean) - Method in class com.onarandombox.MultiverseCore.MultiverseCore
+
+
Deprecated. +
This is deprecated! Do not use!
+
+
+
registerCommands(CommandHandler) - Method in class com.onarandombox.MultiverseCore.api.MultiversePlugin
+
+
You can register commands here.
+
+
registerDestinationType(Class<? extends MVDestination>, String) - Method in class com.onarandombox.MultiverseCore.destination.DestinationFactory
+
+
Registers a MVDestination.
+
+
ReloadCommand - Class in com.onarandombox.MultiverseCore.commands
+
+
Reloads worlds.yml and config.yml.
+
+
ReloadCommand(MultiverseCore) - Constructor for class com.onarandombox.MultiverseCore.commands.ReloadCommand
+
 
+
Remove - com.onarandombox.MultiverseCore.enums.Action
+
+
Removing something from a list-property.
+
+
RemoveCommand - Class in com.onarandombox.MultiverseCore.commands
+
+
Unloads a world and removes it from the config.
+
+
RemoveCommand(MultiverseCore) - Constructor for class com.onarandombox.MultiverseCore.commands.RemoveCommand
+
 
+
removeFromQueue(CommandSender) - Method in class com.onarandombox.MultiverseCore.commandtools.queue.CommandQueueManager
+
+
Since only one command is stored in queue per sender, we remove the old one.
+
+
removeFromVariable(String, String) - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Deprecated. +
We changed the entire world-config-system. This is not compatible any more.
+
+
+
removeFromVariable(String, String) - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Deprecated. +
This is deprecated.
+
+
+
removePlayerSession(Player) - Method in class com.onarandombox.MultiverseCore.MultiverseCore
+
+
Removes a player-session.
+
+
removePlayersFromWorld(String) - Method in interface com.onarandombox.MultiverseCore.api.MVWorldManager
+
+
Removes all players from the specified world.
+
+
removePlayersFromWorld(String) - Method in class com.onarandombox.MultiverseCore.utils.WorldManager
+
+
Removes all players from the specified world.
+
+
removeWorldFromConfig() - Method in class com.onarandombox.MultiverseCore.event.MVWorldDeleteEvent
+
+
Is the world about to be removed from the config?
+
+
removeWorldFromConfig(String) - Method in interface com.onarandombox.MultiverseCore.api.MVWorldManager
+
+
Remove the world from the Multiverse list and from the config.
+
+
removeWorldFromConfig(String) - Method in class com.onarandombox.MultiverseCore.utils.WorldManager
+
+
Remove the world from the Multiverse list and from the config.
+
+
RespawnType - Enum in com.onarandombox.MultiverseCore.enums
+
 
+
runCommand(CommandSender, List<String>) - Method in class com.onarandombox.MultiverseCore.commands.AnchorCommand
+
 
+
runCommand(CommandSender, List<String>) - Method in class com.onarandombox.MultiverseCore.commands.CheckCommand
+
 
+
runCommand(CommandSender, List<String>) - Method in class com.onarandombox.MultiverseCore.commands.CloneCommand
+
 
+
runCommand(CommandSender, List<String>) - Method in class com.onarandombox.MultiverseCore.commands.ConfigCommand
+
 
+
runCommand(CommandSender, List<String>) - Method in class com.onarandombox.MultiverseCore.commands.ConfirmCommand
+
 
+
runCommand(CommandSender, List<String>) - Method in class com.onarandombox.MultiverseCore.commands.CoordCommand
+
 
+
runCommand(CommandSender, List<String>) - Method in class com.onarandombox.MultiverseCore.commands.CreateCommand
+
 
+
runCommand(CommandSender, List<String>) - Method in class com.onarandombox.MultiverseCore.commands.DebugCommand
+
 
+
runCommand(CommandSender, List<String>) - Method in class com.onarandombox.MultiverseCore.commands.DeleteCommand
+
 
+
runCommand(CommandSender, List<String>) - Method in class com.onarandombox.MultiverseCore.commands.EnvironmentCommand
+
 
+
runCommand(CommandSender, List<String>) - Method in class com.onarandombox.MultiverseCore.commands.GameruleCommand
+
 
+
runCommand(CommandSender, List<String>) - Method in class com.onarandombox.MultiverseCore.commands.GamerulesCommand
+
 
+
runCommand(CommandSender, List<String>) - Method in class com.onarandombox.MultiverseCore.commands.GeneratorCommand
+
 
+
runCommand(CommandSender, List<String>) - Method in class com.onarandombox.MultiverseCore.commands.HelpCommand
+
 
+
runCommand(CommandSender, List<String>) - Method in class com.onarandombox.MultiverseCore.commands.ImportCommand
+
 
+
runCommand(CommandSender, List<String>) - Method in class com.onarandombox.MultiverseCore.commands.InfoCommand
+
 
+
runCommand(CommandSender, List<String>) - Method in class com.onarandombox.MultiverseCore.commands.ListCommand
+
 
+
runCommand(CommandSender, List<String>) - Method in class com.onarandombox.MultiverseCore.commands.LoadCommand
+
 
+
runCommand(CommandSender, List<String>) - Method in class com.onarandombox.MultiverseCore.commands.ModifyAddCommand
+
 
+
runCommand(CommandSender, List<String>) - Method in class com.onarandombox.MultiverseCore.commands.ModifyClearCommand
+
 
+
runCommand(CommandSender, List<String>) - Method in class com.onarandombox.MultiverseCore.commands.ModifyCommand
+
 
+
runCommand(CommandSender, List<String>) - Method in class com.onarandombox.MultiverseCore.commands.ModifyRemoveCommand
+
 
+
runCommand(CommandSender, List<String>) - Method in class com.onarandombox.MultiverseCore.commands.ModifySetCommand
+
 
+
runCommand(CommandSender, List<String>) - Method in class com.onarandombox.MultiverseCore.commands.MultiverseCommand
+
 
+
runCommand(CommandSender, List<String>) - Method in class com.onarandombox.MultiverseCore.commands.PurgeCommand
+
 
+
runCommand(CommandSender, List<String>) - Method in class com.onarandombox.MultiverseCore.commands.RegenCommand
+
 
+
runCommand(CommandSender, List<String>) - Method in class com.onarandombox.MultiverseCore.commands.ReloadCommand
+
 
+
runCommand(CommandSender, List<String>) - Method in class com.onarandombox.MultiverseCore.commands.RemoveCommand
+
 
+
runCommand(CommandSender, List<String>) - Method in class com.onarandombox.MultiverseCore.commands.ScriptCommand
+
 
+
runCommand(CommandSender, List<String>) - Method in class com.onarandombox.MultiverseCore.commands.SetSpawnCommand
+
+
Dispatches the user's command depending on the number of parameters
+
+
runCommand(CommandSender, List<String>) - Method in class com.onarandombox.MultiverseCore.commands.SilentCommand
+
 
+
runCommand(CommandSender, List<String>) - Method in class com.onarandombox.MultiverseCore.commands.SleepCommand
+
 
+
runCommand(CommandSender, List<String>) - Method in class com.onarandombox.MultiverseCore.commands.SpawnCommand
+
 
+
runCommand(CommandSender, List<String>) - Method in class com.onarandombox.MultiverseCore.commands.TeleportCommand
+
 
+
runCommand(CommandSender, List<String>) - Method in class com.onarandombox.MultiverseCore.commands.UnloadCommand
+
 
+
runCommand(CommandSender, List<String>) - Method in class com.onarandombox.MultiverseCore.commands.VersionCommand
+
 
+
runCommand(CommandSender, List<String>) - Method in class com.onarandombox.MultiverseCore.commands.WhoCommand
+
 
+
runQueuedCommand(CommandSender) - Method in class com.onarandombox.MultiverseCore.commandtools.queue.CommandQueueManager
+
+
Runs the command in queue for the given sender, if any.
+
+
+ + + +

S

+
+
safelyTeleport(CommandSender, Entity, MVDestination) - Method in interface com.onarandombox.MultiverseCore.api.SafeTTeleporter
+
+
Safely teleport the entity to the MVDestination.
+
+
safelyTeleport(CommandSender, Entity, MVDestination) - Method in class com.onarandombox.MultiverseCore.utils.SimpleSafeTTeleporter
+
+
Safely teleport the entity to the MVDestination.
+
+
safelyTeleport(CommandSender, Entity, Location, boolean) - Method in interface com.onarandombox.MultiverseCore.api.SafeTTeleporter
+
+
Safely teleport the entity to the Location.
+
+
safelyTeleport(CommandSender, Entity, Location, boolean) - Method in class com.onarandombox.MultiverseCore.utils.SimpleSafeTTeleporter
+
+
Safely teleport the entity to the Location.
+
+
SafeTTeleporter - Interface in com.onarandombox.MultiverseCore.api
+
+
Used to safely teleport people.
+
+
saveAnchorLocation(String, String) - Method in class com.onarandombox.MultiverseCore.utils.AnchorManager
+
+
Saves an anchor.
+
+
saveAnchorLocation(String, Location) - Method in class com.onarandombox.MultiverseCore.utils.AnchorManager
+
+
Saves an anchor.
+
+
saveAnchors() - Method in class com.onarandombox.MultiverseCore.utils.AnchorManager
+
+
Saves all anchors.
+
+
saveMVConfig() - Method in class com.onarandombox.MultiverseCore.MultiverseCore
+
+
Saves the Multiverse-Config.
+
+
saveMVConfigs() - Method in interface com.onarandombox.MultiverseCore.api.Core
+
+
Saves all configs.
+
+
saveMVConfigs() - Method in class com.onarandombox.MultiverseCore.MultiverseCore
+
+
Saves all configs.
+
+
saveWorldConfig() - Method in class com.onarandombox.MultiverseCore.MultiverseCore
+
+
Saves the world config.
+
+
saveWorldsConfig() - Method in interface com.onarandombox.MultiverseCore.api.MVWorldManager
+
+
Saves the world config to disk.
+
+
saveWorldsConfig() - Method in class com.onarandombox.MultiverseCore.utils.WorldManager
+
+
Saves the world config to disk.
+
+
ScriptCommand - Class in com.onarandombox.MultiverseCore.commands
+
+
States who is in what world.
+
+
ScriptCommand(MultiverseCore) - Constructor for class com.onarandombox.MultiverseCore.commands.ScriptCommand
+
 
+
sendBody(CommandSender, ContentDisplay<T>, Collection<String>) - Method in interface com.onarandombox.MultiverseCore.display.DisplayHandler
+
+
Sends the content.
+
+
sendHeader(CommandSender, ContentDisplay<T>) - Method in interface com.onarandombox.MultiverseCore.display.DisplayHandler
+
+
Sends the header.
+
+
sendMessage(CommandSender, String, boolean) - Method in interface com.onarandombox.MultiverseCore.api.MultiverseMessaging
+
+
Sends a message to the specified sender if the cooldown has passed.
+
+
sendMessage(CommandSender, String, boolean) - Method in class com.onarandombox.MultiverseCore.utils.MVMessaging
+
+
Sends a message to the specified sender if the cooldown has passed.
+
+
sendMessages(CommandSender, String[], boolean) - Method in interface com.onarandombox.MultiverseCore.api.MultiverseMessaging
+
+
Sends a group of messages to the specified sender if the cooldown has passed.
+
+
sendMessages(CommandSender, String[], boolean) - Method in class com.onarandombox.MultiverseCore.utils.MVMessaging
+
+
Sends a group of messages to the specified sender if the cooldown has passed.
+
+
sendMessages(CommandSender, Collection<String>, boolean) - Method in interface com.onarandombox.MultiverseCore.api.MultiverseMessaging
+
+
Sends a group of messages to the specified sender if the cooldown has passed.
+
+
sendMessages(CommandSender, Collection<String>, boolean) - Method in class com.onarandombox.MultiverseCore.utils.MVMessaging
+
+
Sends a group of messages to the specified sender if the cooldown has passed.
+
+
sendSubHeader(CommandSender, ContentDisplay<Collection<String>>) - Method in class com.onarandombox.MultiverseCore.display.handlers.PagedListDisplayHandler
+
 
+
sendSubHeader(CommandSender, ContentDisplay<T>) - Method in interface com.onarandombox.MultiverseCore.display.DisplayHandler
+
+
Sends info such as filter and page.
+
+
SEPARATOR - Static variable in class com.onarandombox.MultiverseCore.display.settings.InlineDisplaySettings
+
+
Inline separator.
+
+
serialize() - Method in class com.onarandombox.MultiverseCore.configuration.SpawnLocation
+
serialize() - Method in class com.onarandombox.MultiverseCore.MVWorld.NullLocation
+
 
+
serialize(Material) - Method in class com.onarandombox.MultiverseCore.configuration.EntryFee.EntryFeeCurrencySerializor
+
 
+
Set - com.onarandombox.MultiverseCore.enums.Action
+
+
Setting a property.
+
+
setAdjustSpawn(boolean) - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Sets whether or not Multiverse should auto-adjust the spawn for this world.
+
+
setAdjustSpawn(boolean) - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Sets whether or not Multiverse should auto-adjust the spawn for this world.
+
+
setAdjustSpawn(boolean) - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
setAlias(String) - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Sets the alias of the world.
+
+
setAlias(String) - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Sets the alias of the world.
+
+
setAlias(String) - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
setAllowAnimalSpawn(boolean) - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Sets whether or not animals can spawn.
+
+
setAllowAnimalSpawn(boolean) - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Sets whether or not animals can spawn.
+
+
setAllowAnimalSpawn(boolean) - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
setAllowFlight(boolean) - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Sets whether or not players are allowed to fly in this world.
+
+
setAllowFlight(boolean) - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Sets whether or not players are allowed to fly in this world.
+
+
setAllowFlight(boolean) - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
setAllowMonsterSpawn(boolean) - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Sets whether or not monsters can spawn.
+
+
setAllowMonsterSpawn(boolean) - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Sets whether or not monsters can spawn.
+
+
setAllowMonsterSpawn(boolean) - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
setAltColor(boolean) - Method in class com.onarandombox.MultiverseCore.utils.FancyMessage
+
+
Specifies whether this FancyMessage should use the alt-color.
+
+
setAmount(double) - Method in class com.onarandombox.MultiverseCore.configuration.EntryFee
+
+
Sets the amount.
+
+
setAutoHeal(boolean) - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Sets whether or not a world will auto-heal players if the difficulty is on peaceful.
+
+
setAutoHeal(boolean) - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Sets whether or not a world will auto-heal players if the difficulty is on peaceful.
+
+
setAutoHeal(boolean) - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
setAutoLoad(boolean) - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Sets whether or not Multiverse should auto-load this world.
+
+
setAutoLoad(boolean) - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Sets whether or not Multiverse should auto-load this world.
+
+
setAutoLoad(boolean) - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
setAutoPurgeEnabled(boolean) - Method in interface com.onarandombox.MultiverseCore.api.MultiverseCoreConfig
+
+
Sets whether or not the automatic purge of entities is enabled.
+
+
setAutoPurgeEnabled(boolean) - Method in class com.onarandombox.MultiverseCore.MultiverseCoreConfiguration
+
 
+
setBalance(Player, double) - Method in class com.onarandombox.MultiverseCore.utils.MVEconomist
+
+
Sets the economy balance for the given player.
+
+
setBalance(Player, World, double) - Method in class com.onarandombox.MultiverseCore.utils.MVEconomist
+
+
Sets the economy balance for the given player in the given world.
+
+
setBedRespawn(boolean) - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Sets whether or not a player who dies in this world will respawn in their + bed or follow the normal respawn pattern.
+
+
setBedRespawn(boolean) - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Sets whether or not a player who dies in this world will respawn in their + bed or follow the normal respawn pattern.
+
+
setBedRespawn(boolean) - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
setBlockSafety(BlockSafety) - Method in interface com.onarandombox.MultiverseCore.api.Core
+
+
Sets the BlockSafety this Core is using.
+
+
setBlockSafety(BlockSafety) - Method in class com.onarandombox.MultiverseCore.MultiverseCore
+
+
Sets the BlockSafety this Core is using.
+
+
setCancelled(boolean) - Method in class com.onarandombox.MultiverseCore.event.MVPlayerTouchedPortalEvent
+
 
+
setCancelled(boolean) - Method in class com.onarandombox.MultiverseCore.event.MVTeleportEvent
+
 
+
setCancelled(boolean) - Method in class com.onarandombox.MultiverseCore.event.MVWorldDeleteEvent
+
setCancelled(boolean) - Method in class com.onarandombox.MultiverseCore.event.MVWorldPropertyChangeEvent
+
 
+
setCanCreatePortal(boolean) - Method in class com.onarandombox.MultiverseCore.utils.BukkitTravelAgent
+
setCanUseThisPortal(boolean) - Method in class com.onarandombox.MultiverseCore.event.MVPlayerTouchedPortalEvent
+
+
Sets whether or not the player in this event can use this portal.
+
+
setColor(EnglishChatColor) - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
setColor(String) - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Sets the color that this world's name/alias will display as.
+
+
setColor(String) - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Sets the color that this world's name/alias will display as.
+
+
setColor(String) - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
setColorAlt() - Method in class com.onarandombox.MultiverseCore.utils.FancyMessage
+
+
Makes this FancyMessage use the alt-color.
+
+
setColorMain() - Method in class com.onarandombox.MultiverseCore.utils.FancyMessage
+
+
Makes this FancyMessage use the main-color.
+
+
setConfigProperty(String, String) - Method in interface com.onarandombox.MultiverseCore.api.MultiverseCoreConfig
+
+
Sets a property using a String.
+
+
setConfigProperty(String, String) - Method in class com.onarandombox.MultiverseCore.MultiverseCoreConfiguration
+
+
Sets a property using a String.
+
+
setCooldown(int) - Method in interface com.onarandombox.MultiverseCore.api.MultiverseMessaging
+
+
Sets the message-cooldown.
+
+
setCooldown(int) - Method in class com.onarandombox.MultiverseCore.utils.MVMessaging
+
+
Sets the message-cooldown.
+
+
setCore(MultiverseCore) - Method in class com.onarandombox.MultiverseCore.api.MultiversePlugin
+
 
+
setCore(MultiverseCore) - Method in interface com.onarandombox.MultiverseCore.api.MVPlugin
+
+
Sets the reference to MultiverseCore.
+
+
setCore(MultiverseCore) - Method in class com.onarandombox.MultiverseCore.MultiverseCore
+
 
+
setCreationRadius(int) - Method in class com.onarandombox.MultiverseCore.utils.BukkitTravelAgent
+
setCurrency(Material) - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Sets the type of item that will be required given the price is not 0.
+
+
setCurrency(Material) - Method in class com.onarandombox.MultiverseCore.configuration.EntryFee
+
+
Sets the currency.
+
+
setCurrency(Material) - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Sets the type of item that will be required given the price is not 0.
+
+
setCurrency(Material) - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
setDebugLogTag(String) - Method in class com.onarandombox.MultiverseCore.api.MultiversePlugin
+
+
Sets the debug log-tag.
+
+
setDefaults() - Method in class com.onarandombox.MultiverseCore.configuration.EntryFee
+
setDefaults() - Method in class com.onarandombox.MultiverseCore.configuration.SpawnSettings
+
setDefaults() - Method in class com.onarandombox.MultiverseCore.configuration.SubSpawnSettings
+
setDefaults() - Method in class com.onarandombox.MultiverseCore.MultiverseCoreConfiguration
+
setDefaults() - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
setDestination(Location) - Method in class com.onarandombox.MultiverseCore.destination.ExactDestination
+
+
Sets this ExactDestination.
+
+
setDestination(Location, double) - Method in class com.onarandombox.MultiverseCore.destination.CannonDestination
+
+
Sets this CannonDestination.
+
+
setDestination(JavaPlugin, String) - Method in interface com.onarandombox.MultiverseCore.api.MVDestination
+
+
Sets the destination string.
+
+
setDestination(JavaPlugin, String) - Method in class com.onarandombox.MultiverseCore.destination.AnchorDestination
+
+
Sets the destination string.
+
+
setDestination(JavaPlugin, String) - Method in class com.onarandombox.MultiverseCore.destination.BedDestination
+
+
Sets the destination string.
+
+
setDestination(JavaPlugin, String) - Method in class com.onarandombox.MultiverseCore.destination.CannonDestination
+
+
Sets the destination string.
+
+
setDestination(JavaPlugin, String) - Method in class com.onarandombox.MultiverseCore.destination.ExactDestination
+
+
Sets the destination string.
+
+
setDestination(JavaPlugin, String) - Method in class com.onarandombox.MultiverseCore.destination.InvalidDestination
+
+
Sets the destination string.
+
+
setDestination(JavaPlugin, String) - Method in class com.onarandombox.MultiverseCore.destination.PlayerDestination
+
+
Sets the destination string.
+
+
setDestination(JavaPlugin, String) - Method in class com.onarandombox.MultiverseCore.destination.WorldDestination
+
+
Sets the destination string.
+
+
setDifficulty(String) - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Deprecated. +
Use MultiverseWorld.setDifficulty(Difficulty) or, if you have to + pass a string, use MultiverseWorld.setPropertyValue(String, String) instead.
+
+
+
setDifficulty(String) - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Deprecated. +
This is deprecated.
+
+
+
setDifficulty(String) - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
+
Deprecated.
+
+
setDifficulty(Difficulty) - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Sets the difficulty of this world and returns true on success.
+
+
setDifficulty(Difficulty) - Method in class com.onarandombox.MultiverseCore.MVWorld
+
 
+
setDifficulty(Difficulty) - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
setDisplayPermErrors(boolean) - Method in interface com.onarandombox.MultiverseCore.api.MultiverseCoreConfig
+
+
Sets displayPermErrors.
+
+
setDisplayPermErrors(boolean) - Method in class com.onarandombox.MultiverseCore.MultiverseCoreConfiguration
+
+
Sets displayPermErrors.
+
+
setEnableBuscript(boolean) - Method in interface com.onarandombox.MultiverseCore.api.MultiverseCoreConfig
+
+
Sets enableBuscript.
+
+
setEnableBuscript(boolean) - Method in class com.onarandombox.MultiverseCore.MultiverseCoreConfiguration
+
+
Sets enableBuscript.
+
+
setEnableWeather(boolean) - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Sets whether or not there will be weather events in a given world.
+
+
setEnableWeather(boolean) - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Sets whether or not there will be weather events in a given world.
+
+
setEnableWeather(boolean) - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
setEnforceAccess(boolean) - Method in interface com.onarandombox.MultiverseCore.api.MultiverseCoreConfig
+
+
Sets enforceAccess.
+
+
setEnforceAccess(boolean) - Method in class com.onarandombox.MultiverseCore.MultiverseCoreConfiguration
+
+
Sets enforceAccess.
+
+
setEnvironment(World.Environment) - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Sets the environment of a world.
+
+
setEnvironment(World.Environment) - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Sets the environment of a world.
+
+
setEnvironment(World.Environment) - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
setFirstSpawnOverride(boolean) - Method in interface com.onarandombox.MultiverseCore.api.MultiverseCoreConfig
+
+
Sets firstSpawnOverride.
+
+
setFirstSpawnOverride(boolean) - Method in class com.onarandombox.MultiverseCore.MultiverseCoreConfiguration
+
+
Sets firstSpawnOverride.
+
+
setFirstSpawnWorld(String) - Method in interface com.onarandombox.MultiverseCore.api.MultiverseCoreConfig
+
+
Sets firstSpawnWorld.
+
+
setFirstSpawnWorld(String) - Method in interface com.onarandombox.MultiverseCore.api.MVWorldManager
+
+
Sets the initial spawn world for new players.
+
+
setFirstSpawnWorld(String) - Method in class com.onarandombox.MultiverseCore.MultiverseCoreConfiguration
+
+
Sets firstSpawnWorld.
+
+
setFirstSpawnWorld(String) - Method in class com.onarandombox.MultiverseCore.utils.WorldManager
+
+
Sets the initial spawn world for new players.
+
+
setFormat(String) - Method in class com.onarandombox.MultiverseCore.listeners.AsyncChatEvent
+
 
+
setFormat(String) - Method in interface com.onarandombox.MultiverseCore.listeners.ChatEvent
+
+
Sets the format.
+
+
setFormat(String) - Method in class com.onarandombox.MultiverseCore.listeners.NormalChatEvent
+
+
Deprecated.
+ 
+
setGameMode(String) - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Deprecated. +
Use MultiverseWorld.setGameMode(GameMode) instead. If you have to + pass a string, use MultiverseWorld.setPropertyValue(String, String).
+
+
+
setGameMode(String) - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Sets the game mode of this world.
+
+
setGameMode(String) - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
setGameMode(GameMode) - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Sets the game mode of this world.
+
+
setGameMode(GameMode) - Method in class com.onarandombox.MultiverseCore.MVWorld
+
 
+
setGameMode(GameMode) - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
setGenerator(String) - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Sets the generator of this world.
+
+
setGenerator(String) - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Sets the generator of this world.
+
+
setGenerator(String) - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
setGlobalDebug(int) - Method in interface com.onarandombox.MultiverseCore.api.MultiverseCoreConfig
+
+
Sets globalDebug.
+
+
setGlobalDebug(int) - Method in class com.onarandombox.MultiverseCore.MultiverseCoreConfiguration
+
+
Sets globalDebug.
+
+
setHeader(String) - Method in class com.onarandombox.MultiverseCore.display.ContentDisplay
+
+
Sets the header text.
+
+
setHidden(boolean) - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Sets whether or not this world will display in chat, mvw and mvl regardless if a user has the + access permissions to go to this world.
+
+
setHidden(boolean) - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Sets whether or not this world will display in chat, mvw and mvl regardless if a user has the + access permissions to go to this world.
+
+
setHidden(boolean) - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
setHunger(boolean) - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Sets whether or not the hunger level of players will go down in a world.
+
+
setHunger(boolean) - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Sets whether or not the hunger level of players will go down in a world.
+
+
setHunger(boolean) - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
setInstance(MultiverseCoreConfiguration) - Static method in class com.onarandombox.MultiverseCore.MultiverseCoreConfiguration
+
+
Sets the statically saved instance.
+
+
setItemsPerPage(int) - Method in class com.onarandombox.MultiverseCore.commands.PaginatedCommand
+
+
Set the number of items per page.
+
+
setKeepSpawnInMemory(boolean) - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
If true, tells Craftbukkit to keep a worlds spawn chunks loaded in memory (default: true) + If not, CraftBukkit will attempt to free memory when players have not used that world.
+
+
setKeepSpawnInMemory(boolean) - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
If true, tells Craftbukkit to keep a worlds spawn chunks loaded in memory (default: true) + If not, CraftBukkit will attempt to free memory when players have not used that world.
+
+
setKeepSpawnInMemory(boolean) - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
setLocationManipulation(LocationManipulation) - Method in interface com.onarandombox.MultiverseCore.api.Core
+
+
Sets the LocationManipulation this Core is using.
+
+
setLocationManipulation(LocationManipulation) - Method in class com.onarandombox.MultiverseCore.MultiverseCore
+
+
Sets the LocationManipulation this Core is using.
+
+
setMainColor(boolean) - Method in class com.onarandombox.MultiverseCore.utils.FancyMessage
+
+
Specifies whether this FancyMessage should use the main-color.
+
+
setMessageCooldown(int) - Method in interface com.onarandombox.MultiverseCore.api.MultiverseCoreConfig
+
+
Sets messageCooldown.
+
+
setMessageCooldown(int) - Method in class com.onarandombox.MultiverseCore.MultiverseCoreConfiguration
+
+
Sets messageCooldown.
+
+
setNewValue(String) - Method in class com.onarandombox.MultiverseCore.event.MVWorldPropertyChangeEvent
+
+
Deprecated. +
Use MVWorldPropertyChangeEvent.setTheNewValue(Object) instead.
+
+
+
setPage(int) - Method in class com.onarandombox.MultiverseCore.commands.PaginatedCommand.FilterObject
+
+
Sets the page.
+
+
setPlayerLimit(int) - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Sets the player limit for this world after which players without an override + permission node will not be allowed in.
+
+
setPlayerLimit(int) - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Sets the player limit for this world after which players without an override + permission node will not be allowed in.
+
+
setPlayerLimit(int) - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
setPortalEventTravelAgent(PlayerPortalEvent) - Method in class com.onarandombox.MultiverseCore.utils.BukkitTravelAgent
+
 
+
setPortalSearchRadius(int) - Method in interface com.onarandombox.MultiverseCore.api.MultiverseCoreConfig
+
+
Sets the radius at which vanilla style portals will be searched for to connect to worlds together.
+
+
setPortalSearchRadius(int) - Method in class com.onarandombox.MultiverseCore.MultiverseCoreConfiguration
+
 
+
setPortalSearchRadius(EntityPortalEvent, int) - Static method in class com.onarandombox.MultiverseCore.utils.CompatibilityLayer
+
+
Sets search radius for a EntityPortalEvent.
+
+
setPortalSearchRadius(PlayerPortalEvent, int) - Static method in class com.onarandombox.MultiverseCore.utils.CompatibilityLayer
+
+
Sets search radius for a PlayerPortalEvent.
+
+
setPrefixChat(boolean) - Method in interface com.onarandombox.MultiverseCore.api.MultiverseCoreConfig
+
+
Sets prefixChat.
+
+
setPrefixChat(boolean) - Method in class com.onarandombox.MultiverseCore.MultiverseCoreConfiguration
+
+
Sets prefixChat.
+
+
setPrefixChatFormat(String) - Method in interface com.onarandombox.MultiverseCore.api.MultiverseCoreConfig
+
+
Sets prefixChatFormat.
+
+
setPrefixChatFormat(String) - Method in class com.onarandombox.MultiverseCore.MultiverseCoreConfiguration
+
+
Sets prefixChatFormat.
+
+
setPrice(double) - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Sets the price for entry to this world.
+
+
setPrice(double) - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Sets the price for entry to this world.
+
+
setPrice(double) - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
setPropertyValue(String, String) - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Sets a property to a given value.
+
+
setPropertyValue(String, String) - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Sets a property to a given value.
+
+
setPVPMode(boolean) - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Turn pvp on or off.
+
+
setPVPMode(boolean) - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Turn pvp on or off.
+
+
setPVPMode(boolean) - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
setRespawnLocation(Location) - Method in class com.onarandombox.MultiverseCore.event.MVRespawnEvent
+
+
Sets the player's respawn-Location.
+
+
setRespawnToWorld(String) - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Sets the world players will respawn in if they die in this one.
+
+
setRespawnToWorld(String) - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Sets the world players will respawn in if they die in this one.
+
+
setRespawnToWorld(String) - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
setSafeTTeleporter(SafeTTeleporter) - Method in interface com.onarandombox.MultiverseCore.api.Core
+
+
Sets the SafeTTeleporter this Core is using.
+
+
setSafeTTeleporter(SafeTTeleporter) - Method in class com.onarandombox.MultiverseCore.MultiverseCore
+
+
Sets the SafeTTeleporter this Core is using.
+
+
setScaling(double) - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Sets the scale of this world.
+
+
setScaling(double) - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Sets the scale of this world.
+
+
setScaling(double) - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
setSearchRadius(int) - Method in class com.onarandombox.MultiverseCore.utils.BukkitTravelAgent
+
setSeed(long) - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Sets the seed of this world.
+
+
setSeed(long) - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Sets the seed of this world.
+
+
setSeed(long) - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
setServerFolder(File) - Method in class com.onarandombox.MultiverseCore.MultiverseCore
+
+
Sets this server's root-folder.
+
+
setSetting(DisplaySetting<S>, S) - Method in class com.onarandombox.MultiverseCore.display.ContentDisplay
+
+
Sets other specific settings that may be used by the DisplayHandler.
+
+
setShowDonateMessage(boolean) - Method in interface com.onarandombox.MultiverseCore.api.MultiverseCoreConfig
+
+
Sets whether or not the donation/patreon messages are shown.
+
+
setShowDonateMessage(boolean) - Method in class com.onarandombox.MultiverseCore.MultiverseCoreConfiguration
+
 
+
setSilentStart(boolean) - Method in interface com.onarandombox.MultiverseCore.api.MultiverseCoreConfig
+
+
Sets whether to suppress startup messages.
+
+
setSilentStart(boolean) - Method in class com.onarandombox.MultiverseCore.MultiverseCoreConfiguration
+
 
+
setSpawn(boolean) - Method in class com.onarandombox.MultiverseCore.configuration.SubSpawnSettings
+
 
+
SetSpawnCommand - Class in com.onarandombox.MultiverseCore.commands
+
+
Sets the spawn for a world.
+
+
SetSpawnCommand(MultiverseCore) - Constructor for class com.onarandombox.MultiverseCore.commands.SetSpawnCommand
+
 
+
setSpawnLocation(Location) - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Sets the spawn location for a world.
+
+
setSpawnLocation(Location) - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Sets the spawn location for a world.
+
+
setSpawnLocation(Location) - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
setSpawnRate(int) - Method in class com.onarandombox.MultiverseCore.configuration.SubSpawnSettings
+
 
+
setStandardLogger(Logger) - Method in class com.onarandombox.MultiverseCore.utils.DebugLog
+
+
Deprecated.
+
Specifies the logger to use to send debug messages to as the debug logger itself only sends messages to a file.
+
+
setStyle(String) - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Sets the style that this world's name/alias will display as.
+
+
setStyle(String) - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Sets the style that this world's name/alias will display as.
+
+
setStyle(String) - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
setTag(String) - Method in class com.onarandombox.MultiverseCore.utils.DebugLog
+
+
Deprecated.
+
Sets the log-tag.
+
+
setTeleportCooldown(int) - Method in interface com.onarandombox.MultiverseCore.api.MultiverseCoreConfig
+
+
Sets portalCooldown.
+
+
setTeleportCooldown(int) - Method in class com.onarandombox.MultiverseCore.MultiverseCoreConfiguration
+
+
Sets portalCooldown.
+
+
setTeleportIntercept(boolean) - Method in interface com.onarandombox.MultiverseCore.api.MultiverseCoreConfig
+
+
Sets teleportIntercept.
+
+
setTeleportIntercept(boolean) - Method in class com.onarandombox.MultiverseCore.MultiverseCoreConfiguration
+
+
Sets teleportIntercept.
+
+
setTheNewValue(T) - Method in class com.onarandombox.MultiverseCore.event.MVWorldPropertyChangeEvent
+
+
Sets the new value.
+
+
setTime(String) - Method in interface com.onarandombox.MultiverseCore.api.MultiverseWorld
+
+
Sets the current time in a world.
+
+
setTime(String) - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
Sets the current time in a world.
+
+
setTime(String) - Method in class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
setting(DisplaySetting<S>, S) - Method in class com.onarandombox.MultiverseCore.display.ContentDisplay.Builder
+
+
Sets other specific settings that may be used by the DisplayHandler.
+
+
setUseAsyncChat(boolean) - Method in interface com.onarandombox.MultiverseCore.api.MultiverseCoreConfig
+
+
Sets useasyncchat.
+
+
setUseAsyncChat(boolean) - Method in class com.onarandombox.MultiverseCore.MultiverseCoreConfiguration
+
 
+
setUseDefaultPortalSearch(boolean) - Method in interface com.onarandombox.MultiverseCore.api.MultiverseCoreConfig
+
+
Sets whether or not to let Bukkit determine portal search radius on its own or if Multiverse should give input.
+
+
setUseDefaultPortalSearch(boolean) - Method in class com.onarandombox.MultiverseCore.MultiverseCoreConfiguration
+
 
+
setVersion(int) - Method in interface com.onarandombox.MultiverseCore.api.MultiverseCoreConfig
+
+
Sets version.
+
+
setVersion(int) - Method in class com.onarandombox.MultiverseCore.MultiverseCoreConfiguration
+
+
Sets version.
+
+
setWorld(World) - Method in class com.onarandombox.MultiverseCore.configuration.SpawnLocation
+
setWorldSpawn(CommandSender) - Method in class com.onarandombox.MultiverseCore.commands.SetSpawnCommand
+
+
Set the world spawn when no parameters are given
+
+
setWorldSpawn(CommandSender, String, String, String, String) - Method in class com.onarandombox.MultiverseCore.commands.SetSpawnCommand
+
+
Set the world spawn when 4 parameters are given
+
+
setWorldSpawn(CommandSender, String, String, String, String, String, String) - Method in class com.onarandombox.MultiverseCore.commands.SetSpawnCommand
+
+
Set the world spawn when 6 parameters are given
+
+
shorten(String) - Method in class com.onarandombox.MultiverseCore.utils.webpaste.URLShortener
+
+
Shorten a URL.
+
+
shouldWeKillThisCreature(MultiverseWorld, Entity) - Method in interface com.onarandombox.MultiverseCore.api.WorldPurger
+
+
Determines whether the specified creature should be killed and automatically reads the params from a world object.
+
+
shouldWeKillThisCreature(MultiverseWorld, Entity) - Method in class com.onarandombox.MultiverseCore.utils.SimpleWorldPurger
+
+
Determines whether the specified creature should be killed and automatically reads the params from a world object.
+
+
shouldWeKillThisCreature(Entity, List<String>, boolean, boolean) - Method in interface com.onarandombox.MultiverseCore.api.WorldPurger
+
+
Determines whether the specified creature should be killed.
+
+
shouldWeKillThisCreature(Entity, List<String>, boolean, boolean) - Method in class com.onarandombox.MultiverseCore.utils.SimpleWorldPurger
+
+
Determines whether the specified creature should be killed.
+
+
show(CommandSender) - Method in class com.onarandombox.MultiverseCore.display.ContentDisplay
+
+
Do the actual displaying of contents to the sender.
+
+
show(CommandSender) - Method in class com.onarandombox.MultiverseCore.display.ContentDisplay.Builder
+
+
Build and show the content to the sender.
+
+
SHOW_PAGE - Static variable in class com.onarandombox.MultiverseCore.display.settings.PagedDisplaySettings
+
+
Page to display.
+
+
showEnvironments(CommandSender) - Static method in class com.onarandombox.MultiverseCore.commands.EnvironmentCommand
+
+
Shows all valid known environments to a CommandSender.
+
+
showNotMVWorldMessage(CommandSender, String) - Method in class com.onarandombox.MultiverseCore.MultiverseCore
+
+
Shows a message that the given world is not a MultiverseWorld.
+
+
showPage(int, CommandSender, List<T>) - Method in class com.onarandombox.MultiverseCore.commands.PaginatedCommand
+
+
Shows a page.
+
+
showWorldTypes(CommandSender) - Static method in class com.onarandombox.MultiverseCore.commands.EnvironmentCommand
+
+
Shows all valid known world types to a CommandSender.
+
+
SilentCommand - Class in com.onarandombox.MultiverseCore.commands
+
+
Enables debug-information.
+
+
SilentCommand(MultiverseCore) - Constructor for class com.onarandombox.MultiverseCore.commands.SilentCommand
+
 
+
SimpleBlockSafety - Class in com.onarandombox.MultiverseCore.utils
+
+
The default-implementation of BlockSafety.
+
+
SimpleBlockSafety(Core) - Constructor for class com.onarandombox.MultiverseCore.utils.SimpleBlockSafety
+
 
+
SimpleLocationManipulation - Class in com.onarandombox.MultiverseCore.utils
+
+
The default-implementation of LocationManipulation.
+
+
SimpleLocationManipulation() - Constructor for class com.onarandombox.MultiverseCore.utils.SimpleLocationManipulation
+
 
+
SimpleSafeTTeleporter - Class in com.onarandombox.MultiverseCore.utils
+
+
The default-implementation of SafeTTeleporter.
+
+
SimpleSafeTTeleporter(MultiverseCore) - Constructor for class com.onarandombox.MultiverseCore.utils.SimpleSafeTTeleporter
+
 
+
SimpleWorldPurger - Class in com.onarandombox.MultiverseCore.utils
+
+
Utility class that removes animals from worlds that don't belong there.
+
+
SimpleWorldPurger(MultiverseCore) - Constructor for class com.onarandombox.MultiverseCore.utils.SimpleWorldPurger
+
 
+
SleepCommand - Class in com.onarandombox.MultiverseCore.commands
+
+
Takes the player to the latest bed he's slept in.
+
+
SleepCommand(MultiverseCore) - Constructor for class com.onarandombox.MultiverseCore.commands.SleepCommand
+
 
+
SpawnCommand - Class in com.onarandombox.MultiverseCore.commands
+
+
Teleports a player to the spawn.
+
+
SpawnCommand(MultiverseCore) - Constructor for class com.onarandombox.MultiverseCore.commands.SpawnCommand
+
 
+
SpawnLocation - Class in com.onarandombox.MultiverseCore.configuration
+
+
Just like a regular Location, however world is usually null + or just a weak reference and it implements ConfigurationSerializable.
+
+
SpawnLocation(double, double, double) - Constructor for class com.onarandombox.MultiverseCore.configuration.SpawnLocation
+
 
+
SpawnLocation(double, double, double, float, float) - Constructor for class com.onarandombox.MultiverseCore.configuration.SpawnLocation
+
 
+
SpawnLocation(Location) - Constructor for class com.onarandombox.MultiverseCore.configuration.SpawnLocation
+
 
+
SpawnSettings - Class in com.onarandombox.MultiverseCore.configuration
+
+
Spawning-Settings.
+
+
SpawnSettings() - Constructor for class com.onarandombox.MultiverseCore.configuration.SpawnSettings
+
 
+
SpawnSettings(Map<String, Object>) - Constructor for class com.onarandombox.MultiverseCore.configuration.SpawnSettings
+
 
+
staticDebugLog(Level, String) - Static method in class com.onarandombox.MultiverseCore.MultiverseCore
+
+
Deprecated. +
Replaced by Logging. Please refrain from using this from a third party plugin as the + messages will appear to originate from Multiverse-Core.
+
+
+
staticLog(Level, String) - Static method in class com.onarandombox.MultiverseCore.MultiverseCore
+
+
Deprecated. +
Replaced by Logging. Please refrain from using this from a third party plugin as the + messages will appear to originate from Multiverse-Core.
+
+
+
stitchThisString(List<String>) - Method in class com.onarandombox.MultiverseCore.commands.PaginatedCommand
+
+
Constructs a single string from a list of strings.
+
+
strCoords(Location) - Method in interface com.onarandombox.MultiverseCore.api.LocationManipulation
+
+
Returns a colored string with the coords.
+
+
strCoords(Location) - Static method in class com.onarandombox.MultiverseCore.utils.LocationManipulation
+
+
Deprecated.
+
Returns a colored string with the coords.
+
+
strCoords(Location) - Method in class com.onarandombox.MultiverseCore.utils.SimpleLocationManipulation
+
+
Returns a colored string with the coords.
+
+
strCoordsRaw(Location) - Method in interface com.onarandombox.MultiverseCore.api.LocationManipulation
+
+
Converts a location to a printable readable formatted string including pitch/yaw.
+
+
strCoordsRaw(Location) - Static method in class com.onarandombox.MultiverseCore.utils.LocationManipulation
+
+
Deprecated.
+
Converts a location to a printable readable formatted string including pitch/yaw.
+
+
strCoordsRaw(Location) - Method in class com.onarandombox.MultiverseCore.utils.SimpleLocationManipulation
+
+
Converts a location to a printable readable formatted string including pitch/yaw.
+
+
STRIKETHROUGH - com.onarandombox.MultiverseCore.enums.EnglishChatStyle
+
 
+
stringToLocation(String) - Method in interface com.onarandombox.MultiverseCore.api.LocationManipulation
+
+
Returns a new location from a given string.
+
+
stringToLocation(String) - Static method in class com.onarandombox.MultiverseCore.utils.LocationManipulation
+
+
Deprecated.
+
Returns a new location from a given string.
+
+
stringToLocation(String) - Method in class com.onarandombox.MultiverseCore.utils.SimpleLocationManipulation
+
+
Returns a new location from a given string.
+
+
SubSpawnSettings - Class in com.onarandombox.MultiverseCore.configuration
+
+
SpawnSubSettings.
+
+
SubSpawnSettings() - Constructor for class com.onarandombox.MultiverseCore.configuration.SubSpawnSettings
+
 
+
SubSpawnSettings(Map<String, Object>) - Constructor for class com.onarandombox.MultiverseCore.configuration.SubSpawnSettings
+
 
+
SUCCESS - com.onarandombox.MultiverseCore.enums.TeleportResult
+
+
The player was successfully teleported.
+
+
supportsMultiFile() - Method in class com.onarandombox.MultiverseCore.utils.webpaste.PasteService
+
+
Does this service support uploading multiple files.
+
+
+ + + +

T

+
+
teleport() - Method in class com.onarandombox.MultiverseCore.utils.MVPlayerSession
+
+
Update the Teleport time.
+
+
teleport(CommandSender, Player, MVDestination) - Method in interface com.onarandombox.MultiverseCore.api.Teleporter
+
 
+
teleport(CommandSender, Player, MVDestination) - Method in class com.onarandombox.MultiverseCore.utils.SimpleSafeTTeleporter
+
 
+
TeleportCommand - Class in com.onarandombox.MultiverseCore.commands
+
+
Used to teleport players.
+
+
TeleportCommand(MultiverseCore) - Constructor for class com.onarandombox.MultiverseCore.commands.TeleportCommand
+
 
+
Teleporter - Interface in com.onarandombox.MultiverseCore.api
+
 
+
teleportPlayer(CommandSender, Player, Location) - Method in class com.onarandombox.MultiverseCore.MultiverseCore
+
+
This is a convenience method to allow the QueuedCommand system to call it.
+
+
TeleportResult - Enum in com.onarandombox.MultiverseCore.enums
+
+
An enum containing possible teleport-results.
+
+
tellMeWhyICantDoThis(CommandSender, CommandSender, MVDestination) - Method in class com.onarandombox.MultiverseCore.utils.MVPermissions
+
+
Tells a CommandSender why another CommandSender can or can not access a certain MVDestination.
+
+
TestingMode - Class in com.onarandombox.MultiverseCore.utils
+
+
A utility class that enables automated tests to flag Multiverse for testing.
+
+
TestingMode() - Constructor for class com.onarandombox.MultiverseCore.utils.TestingMode
+
 
+
thunderChange(ThunderChangeEvent) - Method in class com.onarandombox.MultiverseCore.listeners.MVWeatherListener
+
+
This method is called when a big storm is going to start.
+
+
toString() - Method in interface com.onarandombox.MultiverseCore.api.MVDestination
+
+
Returns a string that can easily be saved in the config that contains all the details needed to rebuild this + destination.
+
+
toString() - Method in class com.onarandombox.MultiverseCore.destination.AnchorDestination
+
 
+
toString() - Method in class com.onarandombox.MultiverseCore.destination.BedDestination
+
 
+
toString() - Method in class com.onarandombox.MultiverseCore.destination.CannonDestination
+
 
+
toString() - Method in class com.onarandombox.MultiverseCore.destination.CustomTeleporterDestination
+
 
+
toString() - Method in class com.onarandombox.MultiverseCore.destination.ExactDestination
+
+
Returns a string that can easily be saved in the config that contains all the details needed to rebuild this + destination.
+
+
toString() - Method in class com.onarandombox.MultiverseCore.destination.InvalidDestination
+
 
+
toString() - Method in class com.onarandombox.MultiverseCore.destination.PlayerDestination
+
 
+
toString() - Method in class com.onarandombox.MultiverseCore.destination.WorldDestination
+
 
+
toString() - Method in class com.onarandombox.MultiverseCore.display.ContentFilter
+
 
+
toString() - Method in class com.onarandombox.MultiverseCore.MVWorld.NullLocation
+
 
+
toString() - Method in class com.onarandombox.MultiverseCore.MVWorld
+
 
+
TOTAL_PAGE - Static variable in class com.onarandombox.MultiverseCore.display.settings.PagedDisplaySettings
+
+
Total pages available to display.
+
+
toVector() - Method in class com.onarandombox.MultiverseCore.MVWorld.NullLocation
+
 
+
+ + + +

U

+
+
UNDERLINE - com.onarandombox.MultiverseCore.enums.EnglishChatStyle
+
 
+
UnloadCommand - Class in com.onarandombox.MultiverseCore.commands
+
+
Unloads worlds from Multiverse.
+
+
UnloadCommand(MultiverseCore) - Constructor for class com.onarandombox.MultiverseCore.commands.UnloadCommand
+
 
+
unloadWorld(String) - Method in interface com.onarandombox.MultiverseCore.api.MVWorldManager
+
+
Unload a world from Multiverse.
+
+
unloadWorld(String) - Method in class com.onarandombox.MultiverseCore.utils.WorldManager
+
+
Unload a world from Multiverse.
+
+
unloadWorld(String, boolean) - Method in interface com.onarandombox.MultiverseCore.api.MVWorldManager
+
+
Unload a world from Multiverse with option to prevent calling unloadWorld in Bukkit.
+
+
unloadWorld(String, boolean) - Method in class com.onarandombox.MultiverseCore.utils.WorldManager
+
+
Unload a world from Multiverse with option to prevent calling unloadWorld in Bukkit.
+
+
unloadWorld(WorldUnloadEvent) - Method in class com.onarandombox.MultiverseCore.listeners.MVWorldListener
+
+
This method is called when Bukkit fires off a WorldUnloadEvent.
+
+
UnsafeCallWrapper - Class in com.onarandombox.MultiverseCore.utils
+
+
Wraps calls that could result in exceptions that are not Multiverse's fault.
+
+
UnsafeCallWrapper(Core) - Constructor for class com.onarandombox.MultiverseCore.utils.UnsafeCallWrapper
+
 
+
URLShortener - Class in com.onarandombox.MultiverseCore.utils.webpaste
+
+
An interface to a web-based URL Shortener.
+
+
URLShortenerFactory - Class in com.onarandombox.MultiverseCore.utils.webpaste
+
+
Used to construct URLShorteners.
+
+
URLShortenerType - Enum in com.onarandombox.MultiverseCore.utils.webpaste
+
+
An enum containing all known URLShorteners.
+
+
useSafeTeleporter() - Method in interface com.onarandombox.MultiverseCore.api.MVDestination
+
+
Should the Multiverse SafeTeleporter be used?
+
+
useSafeTeleporter() - Method in class com.onarandombox.MultiverseCore.destination.AnchorDestination
+
+
Should the Multiverse SafeTeleporter be used?
+
+
useSafeTeleporter() - Method in class com.onarandombox.MultiverseCore.destination.BedDestination
+
+
Should the Multiverse SafeTeleporter be used?
+
+
useSafeTeleporter() - Method in class com.onarandombox.MultiverseCore.destination.CannonDestination
+
+
Should the Multiverse SafeTeleporter be used?
+
+
useSafeTeleporter() - Method in class com.onarandombox.MultiverseCore.destination.CustomTeleporterDestination
+
 
+
useSafeTeleporter() - Method in class com.onarandombox.MultiverseCore.destination.ExactDestination
+
+
Should the Multiverse SafeTeleporter be used?
+
+
useSafeTeleporter() - Method in class com.onarandombox.MultiverseCore.destination.InvalidDestination
+
+
Should the Multiverse SafeTeleporter be used?
+
+
useSafeTeleporter() - Method in class com.onarandombox.MultiverseCore.destination.PlayerDestination
+
+
Should the Multiverse SafeTeleporter be used?
+
+
useSafeTeleporter() - Method in class com.onarandombox.MultiverseCore.destination.WorldDestination
+
+
Should the Multiverse SafeTeleporter be used?
+
+
+ + + +

V

+
+
VALID - com.onarandombox.MultiverseCore.utils.WorldNameChecker.FolderStatus
+
+
Folder is valid.
+
+
VALID - com.onarandombox.MultiverseCore.utils.WorldNameChecker.NameStatus
+
+
Name is valid.
+
+
validateAction(Action, String) - Static method in class com.onarandombox.MultiverseCore.commands.ModifyCommand
+
+
Validates the specified action.
+
+
validateChange(String, T, T, MVWorld) - Method in class com.onarandombox.MultiverseCore.configuration.WorldPropertyValidator
+
validateEntitySpawns() - Method in class com.onarandombox.MultiverseCore.MVWorld
+
+
This method is here to provide a stopgap until the add/remove/clear methods are implemented with + SerializationConfig.
+
+
valueOf(String) - Static method in enum com.onarandombox.MultiverseCore.enums.Action
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum com.onarandombox.MultiverseCore.enums.AddProperties
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum com.onarandombox.MultiverseCore.enums.AllowedPortalType
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum com.onarandombox.MultiverseCore.enums.EnglishChatColor
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum com.onarandombox.MultiverseCore.enums.EnglishChatStyle
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum com.onarandombox.MultiverseCore.enums.RespawnType
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum com.onarandombox.MultiverseCore.enums.TeleportResult
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum com.onarandombox.MultiverseCore.utils.webpaste.PasteServiceType
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum com.onarandombox.MultiverseCore.utils.webpaste.URLShortenerType
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum com.onarandombox.MultiverseCore.utils.WorldNameChecker.FolderStatus
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum com.onarandombox.MultiverseCore.utils.WorldNameChecker.NameStatus
+
+
Returns the enum constant of this type with the specified name.
+
+
values() - Static method in enum com.onarandombox.MultiverseCore.enums.Action
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum com.onarandombox.MultiverseCore.enums.AddProperties
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum com.onarandombox.MultiverseCore.enums.AllowedPortalType
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum com.onarandombox.MultiverseCore.enums.EnglishChatColor
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum com.onarandombox.MultiverseCore.enums.EnglishChatStyle
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum com.onarandombox.MultiverseCore.enums.RespawnType
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum com.onarandombox.MultiverseCore.enums.TeleportResult
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum com.onarandombox.MultiverseCore.utils.webpaste.PasteServiceType
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum com.onarandombox.MultiverseCore.utils.webpaste.URLShortenerType
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum com.onarandombox.MultiverseCore.utils.WorldNameChecker.FolderStatus
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum com.onarandombox.MultiverseCore.utils.WorldNameChecker.NameStatus
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
VaultHandler - Class in com.onarandombox.MultiverseCore.utils
+
+
A class we use to interface with Vault when it is present.
+
+
VaultHandler(Plugin) - Constructor for class com.onarandombox.MultiverseCore.utils.VaultHandler
+
 
+
VersionCommand - Class in com.onarandombox.MultiverseCore.commands
+
+
Dumps version info to the console.
+
+
VersionCommand(MultiverseCore) - Constructor for class com.onarandombox.MultiverseCore.commands.VersionCommand
+
 
+
versionRequest(MVVersionEvent) - Method in class com.onarandombox.MultiverseCore.listeners.MultiverseCoreListener
+
+
Called when a MVVersionEvent is fired.
+
+
+ + + +

W

+
+
weatherChange(WeatherChangeEvent) - Method in class com.onarandombox.MultiverseCore.listeners.MVWeatherListener
+
+
This method is called when the weather changes.
+
+
WHITE - com.onarandombox.MultiverseCore.enums.EnglishChatColor
+
 
+
WhoCommand - Class in com.onarandombox.MultiverseCore.commands
+
+
States who is in what world.
+
+
WhoCommand(MultiverseCore) - Constructor for class com.onarandombox.MultiverseCore.commands.WhoCommand
+
 
+
with(ChatColor, ChatColor) - Static method in class com.onarandombox.MultiverseCore.display.ColorAlternator
+
+
Creates a new ColorAlternator with 2 ChatColors.
+
+
withdraw(Player, double, Material) - Method in class com.onarandombox.MultiverseCore.utils.MVEconomist
+
+
Withdraws a given amount of currency either from the player's economy account or inventory if the currency + is not null.
+
+
worldblacklist - com.onarandombox.MultiverseCore.enums.AddProperties
+
+
Worlds that people cannot go to from a world.
+
+
worldDelete(MVWorldDeleteEvent) - Method in class com.onarandombox.MultiverseCore.listeners.MultiverseCoreListener
+
+
Called when a MVWorldDeleteEvent is fired.
+
+
WorldDestination - Class in com.onarandombox.MultiverseCore.destination
+
+
A world-MVDestination.
+
+
WorldDestination() - Constructor for class com.onarandombox.MultiverseCore.destination.WorldDestination
+
 
+
WorldManager - Class in com.onarandombox.MultiverseCore.utils
+
+
Public facing API to add/remove Multiverse worlds.
+
+
WorldManager(MultiverseCore) - Constructor for class com.onarandombox.MultiverseCore.utils.WorldManager
+
 
+
WorldNameChecker - Class in com.onarandombox.MultiverseCore.utils
+
+
Utility class in helping to check the status of a world name and it's associated world folder.
+
+
WorldNameChecker() - Constructor for class com.onarandombox.MultiverseCore.utils.WorldNameChecker
+
 
+
WorldNameChecker.FolderStatus - Enum in com.onarandombox.MultiverseCore.utils
+
+
Result after checking validity of world folder.
+
+
WorldNameChecker.NameStatus - Enum in com.onarandombox.MultiverseCore.utils
+
+
Result after checking validity of world name.
+
+
WorldProperties - Class in com.onarandombox.MultiverseCore
+
 
+
WorldProperties() - Constructor for class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
WorldProperties(boolean, World.Environment) - Constructor for class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
WorldProperties(Map<String, Object>) - Constructor for class com.onarandombox.MultiverseCore.WorldProperties
+
 
+
worldPropertyChange(MVWorldPropertyChangeEvent) - Method in class com.onarandombox.MultiverseCore.listeners.MultiverseCoreListener
+
+
Called when a MVWorldPropertyChangeEvent is fired.
+
+
WorldPropertyValidator<T> - Class in com.onarandombox.MultiverseCore.configuration
+
+
Validates world-property-changes.
+
+
WorldPropertyValidator() - Constructor for class com.onarandombox.MultiverseCore.configuration.WorldPropertyValidator
+
 
+
WorldPurger - Interface in com.onarandombox.MultiverseCore.api
+
+
Used to remove animals from worlds that don't belong there.
+
+
wrap(Callable<T>, String, String, Object...) - Method in class com.onarandombox.MultiverseCore.utils.UnsafeCallWrapper
+
+
Wraps calls that could result in exceptions that are not Multiverse's fault.
+
+
+ + + +

Y

+
+
YELLOW - com.onarandombox.MultiverseCore.enums.EnglishChatColor
+
 
+
+A B C D E F G H I L M N O P Q R S T U V W Y 
All Classes All Packages
+
+ + + diff --git a/javadoc/latest/index.html b/javadoc/latest/index.html new file mode 100644 index 000000000..a1ff7fbb4 --- /dev/null +++ b/javadoc/latest/index.html @@ -0,0 +1,245 @@ + + + + + +Overview (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+
+
+

multiverse-core 4.3.14 API

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Packages 
PackageDescription
com.onarandombox.MultiverseCore +
The "master"-package, containing everything related to Multiverse-Core.
+
com.onarandombox.MultiverseCore.api +
The Multiverse-API, containing lots of interfaces that can be quite useful for other + plugins when interacting with Multiverse.
+
com.onarandombox.MultiverseCore.commands +
This package contains all Commands.
+
com.onarandombox.MultiverseCore.commandtools.queue +
Manager queuing of dangerous commands in need of confirmation.
+
com.onarandombox.MultiverseCore.configuration +
This package contains the Multiverse-configuration.
+
com.onarandombox.MultiverseCore.destination +
This package contains all destination-types.
+
com.onarandombox.MultiverseCore.display 
com.onarandombox.MultiverseCore.display.handlers 
com.onarandombox.MultiverseCore.display.settings 
com.onarandombox.MultiverseCore.enums +
This package contains all enums.
+
com.onarandombox.MultiverseCore.event +
This package contains all events.
+
com.onarandombox.MultiverseCore.exceptions +
This package contains all exceptions.
+
com.onarandombox.MultiverseCore.listeners +
This package contains all listeners.
+
com.onarandombox.MultiverseCore.utils +
This package contains all Utility-clases.
+
com.onarandombox.MultiverseCore.utils.metrics 
com.onarandombox.MultiverseCore.utils.webpaste +
This package contains webpaste-utilities.
+
+
+
+ + + diff --git a/javadoc/latest/jquery-ui.overrides.css b/javadoc/latest/jquery-ui.overrides.css new file mode 100644 index 000000000..facf852c2 --- /dev/null +++ b/javadoc/latest/jquery-ui.overrides.css @@ -0,0 +1,35 @@ +/* + * Copyright (c) 2020, 2022, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +.ui-state-active, +.ui-widget-content .ui-state-active, +.ui-widget-header .ui-state-active, +a.ui-button:active, +.ui-button:active, +.ui-button.ui-state-active:hover { + /* Overrides the color of selection used in jQuery UI */ + background: #F8981D; + border: 1px solid #F8981D; +} diff --git a/javadoc/latest/jquery/external/jquery/jquery.js b/javadoc/latest/jquery/external/jquery/jquery.js new file mode 100644 index 000000000..50937333b --- /dev/null +++ b/javadoc/latest/jquery/external/jquery/jquery.js @@ -0,0 +1,10872 @@ +/*! + * jQuery JavaScript Library v3.5.1 + * https://jquery.com/ + * + * Includes Sizzle.js + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://jquery.org/license + * + * Date: 2020-05-04T22:49Z + */ +( function( global, factory ) { + + "use strict"; + + if ( typeof module === "object" && typeof module.exports === "object" ) { + + // For CommonJS and CommonJS-like environments where a proper `window` + // is present, execute the factory and get jQuery. + // For environments that do not have a `window` with a `document` + // (such as Node.js), expose a factory as module.exports. + // This accentuates the need for the creation of a real `window`. + // e.g. var jQuery = require("jquery")(window); + // See ticket #14549 for more info. + module.exports = global.document ? + factory( global, true ) : + function( w ) { + if ( !w.document ) { + throw new Error( "jQuery requires a window with a document" ); + } + return factory( w ); + }; + } else { + factory( global ); + } + +// Pass this if window is not defined yet +} )( typeof window !== "undefined" ? window : this, function( window, noGlobal ) { + +// Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1 +// throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode +// arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common +// enough that all such attempts are guarded in a try block. +"use strict"; + +var arr = []; + +var getProto = Object.getPrototypeOf; + +var slice = arr.slice; + +var flat = arr.flat ? function( array ) { + return arr.flat.call( array ); +} : function( array ) { + return arr.concat.apply( [], array ); +}; + + +var push = arr.push; + +var indexOf = arr.indexOf; + +var class2type = {}; + +var toString = class2type.toString; + +var hasOwn = class2type.hasOwnProperty; + +var fnToString = hasOwn.toString; + +var ObjectFunctionString = fnToString.call( Object ); + +var support = {}; + +var isFunction = function isFunction( obj ) { + + // Support: Chrome <=57, Firefox <=52 + // In some browsers, typeof returns "function" for HTML elements + // (i.e., `typeof document.createElement( "object" ) === "function"`). + // We don't want to classify *any* DOM node as a function. + return typeof obj === "function" && typeof obj.nodeType !== "number"; + }; + + +var isWindow = function isWindow( obj ) { + return obj != null && obj === obj.window; + }; + + +var document = window.document; + + + + var preservedScriptAttributes = { + type: true, + src: true, + nonce: true, + noModule: true + }; + + function DOMEval( code, node, doc ) { + doc = doc || document; + + var i, val, + script = doc.createElement( "script" ); + + script.text = code; + if ( node ) { + for ( i in preservedScriptAttributes ) { + + // Support: Firefox 64+, Edge 18+ + // Some browsers don't support the "nonce" property on scripts. + // On the other hand, just using `getAttribute` is not enough as + // the `nonce` attribute is reset to an empty string whenever it + // becomes browsing-context connected. + // See https://github.com/whatwg/html/issues/2369 + // See https://html.spec.whatwg.org/#nonce-attributes + // The `node.getAttribute` check was added for the sake of + // `jQuery.globalEval` so that it can fake a nonce-containing node + // via an object. + val = node[ i ] || node.getAttribute && node.getAttribute( i ); + if ( val ) { + script.setAttribute( i, val ); + } + } + } + doc.head.appendChild( script ).parentNode.removeChild( script ); + } + + +function toType( obj ) { + if ( obj == null ) { + return obj + ""; + } + + // Support: Android <=2.3 only (functionish RegExp) + return typeof obj === "object" || typeof obj === "function" ? + class2type[ toString.call( obj ) ] || "object" : + typeof obj; +} +/* global Symbol */ +// Defining this global in .eslintrc.json would create a danger of using the global +// unguarded in another place, it seems safer to define global only for this module + + + +var + version = "3.5.1", + + // Define a local copy of jQuery + jQuery = function( selector, context ) { + + // The jQuery object is actually just the init constructor 'enhanced' + // Need init if jQuery is called (just allow error to be thrown if not included) + return new jQuery.fn.init( selector, context ); + }; + +jQuery.fn = jQuery.prototype = { + + // The current version of jQuery being used + jquery: version, + + constructor: jQuery, + + // The default length of a jQuery object is 0 + length: 0, + + toArray: function() { + return slice.call( this ); + }, + + // Get the Nth element in the matched element set OR + // Get the whole matched element set as a clean array + get: function( num ) { + + // Return all the elements in a clean array + if ( num == null ) { + return slice.call( this ); + } + + // Return just the one element from the set + return num < 0 ? this[ num + this.length ] : this[ num ]; + }, + + // Take an array of elements and push it onto the stack + // (returning the new matched element set) + pushStack: function( elems ) { + + // Build a new jQuery matched element set + var ret = jQuery.merge( this.constructor(), elems ); + + // Add the old object onto the stack (as a reference) + ret.prevObject = this; + + // Return the newly-formed element set + return ret; + }, + + // Execute a callback for every element in the matched set. + each: function( callback ) { + return jQuery.each( this, callback ); + }, + + map: function( callback ) { + return this.pushStack( jQuery.map( this, function( elem, i ) { + return callback.call( elem, i, elem ); + } ) ); + }, + + slice: function() { + return this.pushStack( slice.apply( this, arguments ) ); + }, + + first: function() { + return this.eq( 0 ); + }, + + last: function() { + return this.eq( -1 ); + }, + + even: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return ( i + 1 ) % 2; + } ) ); + }, + + odd: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return i % 2; + } ) ); + }, + + eq: function( i ) { + var len = this.length, + j = +i + ( i < 0 ? len : 0 ); + return this.pushStack( j >= 0 && j < len ? [ this[ j ] ] : [] ); + }, + + end: function() { + return this.prevObject || this.constructor(); + }, + + // For internal use only. + // Behaves like an Array's method, not like a jQuery method. + push: push, + sort: arr.sort, + splice: arr.splice +}; + +jQuery.extend = jQuery.fn.extend = function() { + var options, name, src, copy, copyIsArray, clone, + target = arguments[ 0 ] || {}, + i = 1, + length = arguments.length, + deep = false; + + // Handle a deep copy situation + if ( typeof target === "boolean" ) { + deep = target; + + // Skip the boolean and the target + target = arguments[ i ] || {}; + i++; + } + + // Handle case when target is a string or something (possible in deep copy) + if ( typeof target !== "object" && !isFunction( target ) ) { + target = {}; + } + + // Extend jQuery itself if only one argument is passed + if ( i === length ) { + target = this; + i--; + } + + for ( ; i < length; i++ ) { + + // Only deal with non-null/undefined values + if ( ( options = arguments[ i ] ) != null ) { + + // Extend the base object + for ( name in options ) { + copy = options[ name ]; + + // Prevent Object.prototype pollution + // Prevent never-ending loop + if ( name === "__proto__" || target === copy ) { + continue; + } + + // Recurse if we're merging plain objects or arrays + if ( deep && copy && ( jQuery.isPlainObject( copy ) || + ( copyIsArray = Array.isArray( copy ) ) ) ) { + src = target[ name ]; + + // Ensure proper type for the source value + if ( copyIsArray && !Array.isArray( src ) ) { + clone = []; + } else if ( !copyIsArray && !jQuery.isPlainObject( src ) ) { + clone = {}; + } else { + clone = src; + } + copyIsArray = false; + + // Never move original objects, clone them + target[ name ] = jQuery.extend( deep, clone, copy ); + + // Don't bring in undefined values + } else if ( copy !== undefined ) { + target[ name ] = copy; + } + } + } + } + + // Return the modified object + return target; +}; + +jQuery.extend( { + + // Unique for each copy of jQuery on the page + expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ), + + // Assume jQuery is ready without the ready module + isReady: true, + + error: function( msg ) { + throw new Error( msg ); + }, + + noop: function() {}, + + isPlainObject: function( obj ) { + var proto, Ctor; + + // Detect obvious negatives + // Use toString instead of jQuery.type to catch host objects + if ( !obj || toString.call( obj ) !== "[object Object]" ) { + return false; + } + + proto = getProto( obj ); + + // Objects with no prototype (e.g., `Object.create( null )`) are plain + if ( !proto ) { + return true; + } + + // Objects with prototype are plain iff they were constructed by a global Object function + Ctor = hasOwn.call( proto, "constructor" ) && proto.constructor; + return typeof Ctor === "function" && fnToString.call( Ctor ) === ObjectFunctionString; + }, + + isEmptyObject: function( obj ) { + var name; + + for ( name in obj ) { + return false; + } + return true; + }, + + // Evaluates a script in a provided context; falls back to the global one + // if not specified. + globalEval: function( code, options, doc ) { + DOMEval( code, { nonce: options && options.nonce }, doc ); + }, + + each: function( obj, callback ) { + var length, i = 0; + + if ( isArrayLike( obj ) ) { + length = obj.length; + for ( ; i < length; i++ ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } else { + for ( i in obj ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } + + return obj; + }, + + // results is for internal usage only + makeArray: function( arr, results ) { + var ret = results || []; + + if ( arr != null ) { + if ( isArrayLike( Object( arr ) ) ) { + jQuery.merge( ret, + typeof arr === "string" ? + [ arr ] : arr + ); + } else { + push.call( ret, arr ); + } + } + + return ret; + }, + + inArray: function( elem, arr, i ) { + return arr == null ? -1 : indexOf.call( arr, elem, i ); + }, + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + merge: function( first, second ) { + var len = +second.length, + j = 0, + i = first.length; + + for ( ; j < len; j++ ) { + first[ i++ ] = second[ j ]; + } + + first.length = i; + + return first; + }, + + grep: function( elems, callback, invert ) { + var callbackInverse, + matches = [], + i = 0, + length = elems.length, + callbackExpect = !invert; + + // Go through the array, only saving the items + // that pass the validator function + for ( ; i < length; i++ ) { + callbackInverse = !callback( elems[ i ], i ); + if ( callbackInverse !== callbackExpect ) { + matches.push( elems[ i ] ); + } + } + + return matches; + }, + + // arg is for internal usage only + map: function( elems, callback, arg ) { + var length, value, + i = 0, + ret = []; + + // Go through the array, translating each of the items to their new values + if ( isArrayLike( elems ) ) { + length = elems.length; + for ( ; i < length; i++ ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + + // Go through every key on the object, + } else { + for ( i in elems ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + } + + // Flatten any nested arrays + return flat( ret ); + }, + + // A global GUID counter for objects + guid: 1, + + // jQuery.support is not used in Core but other projects attach their + // properties to it so it needs to exist. + support: support +} ); + +if ( typeof Symbol === "function" ) { + jQuery.fn[ Symbol.iterator ] = arr[ Symbol.iterator ]; +} + +// Populate the class2type map +jQuery.each( "Boolean Number String Function Array Date RegExp Object Error Symbol".split( " " ), +function( _i, name ) { + class2type[ "[object " + name + "]" ] = name.toLowerCase(); +} ); + +function isArrayLike( obj ) { + + // Support: real iOS 8.2 only (not reproducible in simulator) + // `in` check used to prevent JIT error (gh-2145) + // hasOwn isn't used here due to false negatives + // regarding Nodelist length in IE + var length = !!obj && "length" in obj && obj.length, + type = toType( obj ); + + if ( isFunction( obj ) || isWindow( obj ) ) { + return false; + } + + return type === "array" || length === 0 || + typeof length === "number" && length > 0 && ( length - 1 ) in obj; +} +var Sizzle = +/*! + * Sizzle CSS Selector Engine v2.3.5 + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://js.foundation/ + * + * Date: 2020-03-14 + */ +( function( window ) { +var i, + support, + Expr, + getText, + isXML, + tokenize, + compile, + select, + outermostContext, + sortInput, + hasDuplicate, + + // Local document vars + setDocument, + document, + docElem, + documentIsHTML, + rbuggyQSA, + rbuggyMatches, + matches, + contains, + + // Instance-specific data + expando = "sizzle" + 1 * new Date(), + preferredDoc = window.document, + dirruns = 0, + done = 0, + classCache = createCache(), + tokenCache = createCache(), + compilerCache = createCache(), + nonnativeSelectorCache = createCache(), + sortOrder = function( a, b ) { + if ( a === b ) { + hasDuplicate = true; + } + return 0; + }, + + // Instance methods + hasOwn = ( {} ).hasOwnProperty, + arr = [], + pop = arr.pop, + pushNative = arr.push, + push = arr.push, + slice = arr.slice, + + // Use a stripped-down indexOf as it's faster than native + // https://jsperf.com/thor-indexof-vs-for/5 + indexOf = function( list, elem ) { + var i = 0, + len = list.length; + for ( ; i < len; i++ ) { + if ( list[ i ] === elem ) { + return i; + } + } + return -1; + }, + + booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|" + + "ismap|loop|multiple|open|readonly|required|scoped", + + // Regular expressions + + // http://www.w3.org/TR/css3-selectors/#whitespace + whitespace = "[\\x20\\t\\r\\n\\f]", + + // https://www.w3.org/TR/css-syntax-3/#ident-token-diagram + identifier = "(?:\\\\[\\da-fA-F]{1,6}" + whitespace + + "?|\\\\[^\\r\\n\\f]|[\\w-]|[^\0-\\x7f])+", + + // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors + attributes = "\\[" + whitespace + "*(" + identifier + ")(?:" + whitespace + + + // Operator (capture 2) + "*([*^$|!~]?=)" + whitespace + + + // "Attribute values must be CSS identifiers [capture 5] + // or strings [capture 3 or capture 4]" + "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + + whitespace + "*\\]", + + pseudos = ":(" + identifier + ")(?:\\((" + + + // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments: + // 1. quoted (capture 3; capture 4 or capture 5) + "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" + + + // 2. simple (capture 6) + "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" + + + // 3. anything else (capture 2) + ".*" + + ")\\)|)", + + // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter + rwhitespace = new RegExp( whitespace + "+", "g" ), + rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + + whitespace + "+$", "g" ), + + rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ), + rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + + "*" ), + rdescend = new RegExp( whitespace + "|>" ), + + rpseudo = new RegExp( pseudos ), + ridentifier = new RegExp( "^" + identifier + "$" ), + + matchExpr = { + "ID": new RegExp( "^#(" + identifier + ")" ), + "CLASS": new RegExp( "^\\.(" + identifier + ")" ), + "TAG": new RegExp( "^(" + identifier + "|[*])" ), + "ATTR": new RegExp( "^" + attributes ), + "PSEUDO": new RegExp( "^" + pseudos ), + "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + + whitespace + "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + + whitespace + "*(\\d+)|))" + whitespace + "*\\)|)", "i" ), + "bool": new RegExp( "^(?:" + booleans + ")$", "i" ), + + // For use in libraries implementing .is() + // We use this for POS matching in `select` + "needsContext": new RegExp( "^" + whitespace + + "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" + whitespace + + "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" ) + }, + + rhtml = /HTML$/i, + rinputs = /^(?:input|select|textarea|button)$/i, + rheader = /^h\d$/i, + + rnative = /^[^{]+\{\s*\[native \w/, + + // Easily-parseable/retrievable ID or TAG or CLASS selectors + rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/, + + rsibling = /[+~]/, + + // CSS escapes + // http://www.w3.org/TR/CSS21/syndata.html#escaped-characters + runescape = new RegExp( "\\\\[\\da-fA-F]{1,6}" + whitespace + "?|\\\\([^\\r\\n\\f])", "g" ), + funescape = function( escape, nonHex ) { + var high = "0x" + escape.slice( 1 ) - 0x10000; + + return nonHex ? + + // Strip the backslash prefix from a non-hex escape sequence + nonHex : + + // Replace a hexadecimal escape sequence with the encoded Unicode code point + // Support: IE <=11+ + // For values outside the Basic Multilingual Plane (BMP), manually construct a + // surrogate pair + high < 0 ? + String.fromCharCode( high + 0x10000 ) : + String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 ); + }, + + // CSS string/identifier serialization + // https://drafts.csswg.org/cssom/#common-serializing-idioms + rcssescape = /([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g, + fcssescape = function( ch, asCodePoint ) { + if ( asCodePoint ) { + + // U+0000 NULL becomes U+FFFD REPLACEMENT CHARACTER + if ( ch === "\0" ) { + return "\uFFFD"; + } + + // Control characters and (dependent upon position) numbers get escaped as code points + return ch.slice( 0, -1 ) + "\\" + + ch.charCodeAt( ch.length - 1 ).toString( 16 ) + " "; + } + + // Other potentially-special ASCII characters get backslash-escaped + return "\\" + ch; + }, + + // Used for iframes + // See setDocument() + // Removing the function wrapper causes a "Permission Denied" + // error in IE + unloadHandler = function() { + setDocument(); + }, + + inDisabledFieldset = addCombinator( + function( elem ) { + return elem.disabled === true && elem.nodeName.toLowerCase() === "fieldset"; + }, + { dir: "parentNode", next: "legend" } + ); + +// Optimize for push.apply( _, NodeList ) +try { + push.apply( + ( arr = slice.call( preferredDoc.childNodes ) ), + preferredDoc.childNodes + ); + + // Support: Android<4.0 + // Detect silently failing push.apply + // eslint-disable-next-line no-unused-expressions + arr[ preferredDoc.childNodes.length ].nodeType; +} catch ( e ) { + push = { apply: arr.length ? + + // Leverage slice if possible + function( target, els ) { + pushNative.apply( target, slice.call( els ) ); + } : + + // Support: IE<9 + // Otherwise append directly + function( target, els ) { + var j = target.length, + i = 0; + + // Can't trust NodeList.length + while ( ( target[ j++ ] = els[ i++ ] ) ) {} + target.length = j - 1; + } + }; +} + +function Sizzle( selector, context, results, seed ) { + var m, i, elem, nid, match, groups, newSelector, + newContext = context && context.ownerDocument, + + // nodeType defaults to 9, since context defaults to document + nodeType = context ? context.nodeType : 9; + + results = results || []; + + // Return early from calls with invalid selector or context + if ( typeof selector !== "string" || !selector || + nodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) { + + return results; + } + + // Try to shortcut find operations (as opposed to filters) in HTML documents + if ( !seed ) { + setDocument( context ); + context = context || document; + + if ( documentIsHTML ) { + + // If the selector is sufficiently simple, try using a "get*By*" DOM method + // (excepting DocumentFragment context, where the methods don't exist) + if ( nodeType !== 11 && ( match = rquickExpr.exec( selector ) ) ) { + + // ID selector + if ( ( m = match[ 1 ] ) ) { + + // Document context + if ( nodeType === 9 ) { + if ( ( elem = context.getElementById( m ) ) ) { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( elem.id === m ) { + results.push( elem ); + return results; + } + } else { + return results; + } + + // Element context + } else { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( newContext && ( elem = newContext.getElementById( m ) ) && + contains( context, elem ) && + elem.id === m ) { + + results.push( elem ); + return results; + } + } + + // Type selector + } else if ( match[ 2 ] ) { + push.apply( results, context.getElementsByTagName( selector ) ); + return results; + + // Class selector + } else if ( ( m = match[ 3 ] ) && support.getElementsByClassName && + context.getElementsByClassName ) { + + push.apply( results, context.getElementsByClassName( m ) ); + return results; + } + } + + // Take advantage of querySelectorAll + if ( support.qsa && + !nonnativeSelectorCache[ selector + " " ] && + ( !rbuggyQSA || !rbuggyQSA.test( selector ) ) && + + // Support: IE 8 only + // Exclude object elements + ( nodeType !== 1 || context.nodeName.toLowerCase() !== "object" ) ) { + + newSelector = selector; + newContext = context; + + // qSA considers elements outside a scoping root when evaluating child or + // descendant combinators, which is not what we want. + // In such cases, we work around the behavior by prefixing every selector in the + // list with an ID selector referencing the scope context. + // The technique has to be used as well when a leading combinator is used + // as such selectors are not recognized by querySelectorAll. + // Thanks to Andrew Dupont for this technique. + if ( nodeType === 1 && + ( rdescend.test( selector ) || rcombinators.test( selector ) ) ) { + + // Expand context for sibling selectors + newContext = rsibling.test( selector ) && testContext( context.parentNode ) || + context; + + // We can use :scope instead of the ID hack if the browser + // supports it & if we're not changing the context. + if ( newContext !== context || !support.scope ) { + + // Capture the context ID, setting it first if necessary + if ( ( nid = context.getAttribute( "id" ) ) ) { + nid = nid.replace( rcssescape, fcssescape ); + } else { + context.setAttribute( "id", ( nid = expando ) ); + } + } + + // Prefix every selector in the list + groups = tokenize( selector ); + i = groups.length; + while ( i-- ) { + groups[ i ] = ( nid ? "#" + nid : ":scope" ) + " " + + toSelector( groups[ i ] ); + } + newSelector = groups.join( "," ); + } + + try { + push.apply( results, + newContext.querySelectorAll( newSelector ) + ); + return results; + } catch ( qsaError ) { + nonnativeSelectorCache( selector, true ); + } finally { + if ( nid === expando ) { + context.removeAttribute( "id" ); + } + } + } + } + } + + // All others + return select( selector.replace( rtrim, "$1" ), context, results, seed ); +} + +/** + * Create key-value caches of limited size + * @returns {function(string, object)} Returns the Object data after storing it on itself with + * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength) + * deleting the oldest entry + */ +function createCache() { + var keys = []; + + function cache( key, value ) { + + // Use (key + " ") to avoid collision with native prototype properties (see Issue #157) + if ( keys.push( key + " " ) > Expr.cacheLength ) { + + // Only keep the most recent entries + delete cache[ keys.shift() ]; + } + return ( cache[ key + " " ] = value ); + } + return cache; +} + +/** + * Mark a function for special use by Sizzle + * @param {Function} fn The function to mark + */ +function markFunction( fn ) { + fn[ expando ] = true; + return fn; +} + +/** + * Support testing using an element + * @param {Function} fn Passed the created element and returns a boolean result + */ +function assert( fn ) { + var el = document.createElement( "fieldset" ); + + try { + return !!fn( el ); + } catch ( e ) { + return false; + } finally { + + // Remove from its parent by default + if ( el.parentNode ) { + el.parentNode.removeChild( el ); + } + + // release memory in IE + el = null; + } +} + +/** + * Adds the same handler for all of the specified attrs + * @param {String} attrs Pipe-separated list of attributes + * @param {Function} handler The method that will be applied + */ +function addHandle( attrs, handler ) { + var arr = attrs.split( "|" ), + i = arr.length; + + while ( i-- ) { + Expr.attrHandle[ arr[ i ] ] = handler; + } +} + +/** + * Checks document order of two siblings + * @param {Element} a + * @param {Element} b + * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b + */ +function siblingCheck( a, b ) { + var cur = b && a, + diff = cur && a.nodeType === 1 && b.nodeType === 1 && + a.sourceIndex - b.sourceIndex; + + // Use IE sourceIndex if available on both nodes + if ( diff ) { + return diff; + } + + // Check if b follows a + if ( cur ) { + while ( ( cur = cur.nextSibling ) ) { + if ( cur === b ) { + return -1; + } + } + } + + return a ? 1 : -1; +} + +/** + * Returns a function to use in pseudos for input types + * @param {String} type + */ +function createInputPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for buttons + * @param {String} type + */ +function createButtonPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return ( name === "input" || name === "button" ) && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for :enabled/:disabled + * @param {Boolean} disabled true for :disabled; false for :enabled + */ +function createDisabledPseudo( disabled ) { + + // Known :disabled false positives: fieldset[disabled] > legend:nth-of-type(n+2) :can-disable + return function( elem ) { + + // Only certain elements can match :enabled or :disabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-enabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-disabled + if ( "form" in elem ) { + + // Check for inherited disabledness on relevant non-disabled elements: + // * listed form-associated elements in a disabled fieldset + // https://html.spec.whatwg.org/multipage/forms.html#category-listed + // https://html.spec.whatwg.org/multipage/forms.html#concept-fe-disabled + // * option elements in a disabled optgroup + // https://html.spec.whatwg.org/multipage/forms.html#concept-option-disabled + // All such elements have a "form" property. + if ( elem.parentNode && elem.disabled === false ) { + + // Option elements defer to a parent optgroup if present + if ( "label" in elem ) { + if ( "label" in elem.parentNode ) { + return elem.parentNode.disabled === disabled; + } else { + return elem.disabled === disabled; + } + } + + // Support: IE 6 - 11 + // Use the isDisabled shortcut property to check for disabled fieldset ancestors + return elem.isDisabled === disabled || + + // Where there is no isDisabled, check manually + /* jshint -W018 */ + elem.isDisabled !== !disabled && + inDisabledFieldset( elem ) === disabled; + } + + return elem.disabled === disabled; + + // Try to winnow out elements that can't be disabled before trusting the disabled property. + // Some victims get caught in our net (label, legend, menu, track), but it shouldn't + // even exist on them, let alone have a boolean value. + } else if ( "label" in elem ) { + return elem.disabled === disabled; + } + + // Remaining elements are neither :enabled nor :disabled + return false; + }; +} + +/** + * Returns a function to use in pseudos for positionals + * @param {Function} fn + */ +function createPositionalPseudo( fn ) { + return markFunction( function( argument ) { + argument = +argument; + return markFunction( function( seed, matches ) { + var j, + matchIndexes = fn( [], seed.length, argument ), + i = matchIndexes.length; + + // Match elements found at the specified indexes + while ( i-- ) { + if ( seed[ ( j = matchIndexes[ i ] ) ] ) { + seed[ j ] = !( matches[ j ] = seed[ j ] ); + } + } + } ); + } ); +} + +/** + * Checks a node for validity as a Sizzle context + * @param {Element|Object=} context + * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value + */ +function testContext( context ) { + return context && typeof context.getElementsByTagName !== "undefined" && context; +} + +// Expose support vars for convenience +support = Sizzle.support = {}; + +/** + * Detects XML nodes + * @param {Element|Object} elem An element or a document + * @returns {Boolean} True iff elem is a non-HTML XML node + */ +isXML = Sizzle.isXML = function( elem ) { + var namespace = elem.namespaceURI, + docElem = ( elem.ownerDocument || elem ).documentElement; + + // Support: IE <=8 + // Assume HTML when documentElement doesn't yet exist, such as inside loading iframes + // https://bugs.jquery.com/ticket/4833 + return !rhtml.test( namespace || docElem && docElem.nodeName || "HTML" ); +}; + +/** + * Sets document-related variables once based on the current document + * @param {Element|Object} [doc] An element or document object to use to set the document + * @returns {Object} Returns the current document + */ +setDocument = Sizzle.setDocument = function( node ) { + var hasCompare, subWindow, + doc = node ? node.ownerDocument || node : preferredDoc; + + // Return early if doc is invalid or already selected + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( doc == document || doc.nodeType !== 9 || !doc.documentElement ) { + return document; + } + + // Update global variables + document = doc; + docElem = document.documentElement; + documentIsHTML = !isXML( document ); + + // Support: IE 9 - 11+, Edge 12 - 18+ + // Accessing iframe documents after unload throws "permission denied" errors (jQuery #13936) + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( preferredDoc != document && + ( subWindow = document.defaultView ) && subWindow.top !== subWindow ) { + + // Support: IE 11, Edge + if ( subWindow.addEventListener ) { + subWindow.addEventListener( "unload", unloadHandler, false ); + + // Support: IE 9 - 10 only + } else if ( subWindow.attachEvent ) { + subWindow.attachEvent( "onunload", unloadHandler ); + } + } + + // Support: IE 8 - 11+, Edge 12 - 18+, Chrome <=16 - 25 only, Firefox <=3.6 - 31 only, + // Safari 4 - 5 only, Opera <=11.6 - 12.x only + // IE/Edge & older browsers don't support the :scope pseudo-class. + // Support: Safari 6.0 only + // Safari 6.0 supports :scope but it's an alias of :root there. + support.scope = assert( function( el ) { + docElem.appendChild( el ).appendChild( document.createElement( "div" ) ); + return typeof el.querySelectorAll !== "undefined" && + !el.querySelectorAll( ":scope fieldset div" ).length; + } ); + + /* Attributes + ---------------------------------------------------------------------- */ + + // Support: IE<8 + // Verify that getAttribute really returns attributes and not properties + // (excepting IE8 booleans) + support.attributes = assert( function( el ) { + el.className = "i"; + return !el.getAttribute( "className" ); + } ); + + /* getElement(s)By* + ---------------------------------------------------------------------- */ + + // Check if getElementsByTagName("*") returns only elements + support.getElementsByTagName = assert( function( el ) { + el.appendChild( document.createComment( "" ) ); + return !el.getElementsByTagName( "*" ).length; + } ); + + // Support: IE<9 + support.getElementsByClassName = rnative.test( document.getElementsByClassName ); + + // Support: IE<10 + // Check if getElementById returns elements by name + // The broken getElementById methods don't pick up programmatically-set names, + // so use a roundabout getElementsByName test + support.getById = assert( function( el ) { + docElem.appendChild( el ).id = expando; + return !document.getElementsByName || !document.getElementsByName( expando ).length; + } ); + + // ID filter and find + if ( support.getById ) { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + return elem.getAttribute( "id" ) === attrId; + }; + }; + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var elem = context.getElementById( id ); + return elem ? [ elem ] : []; + } + }; + } else { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + var node = typeof elem.getAttributeNode !== "undefined" && + elem.getAttributeNode( "id" ); + return node && node.value === attrId; + }; + }; + + // Support: IE 6 - 7 only + // getElementById is not reliable as a find shortcut + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var node, i, elems, + elem = context.getElementById( id ); + + if ( elem ) { + + // Verify the id attribute + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + + // Fall back on getElementsByName + elems = context.getElementsByName( id ); + i = 0; + while ( ( elem = elems[ i++ ] ) ) { + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + } + } + + return []; + } + }; + } + + // Tag + Expr.find[ "TAG" ] = support.getElementsByTagName ? + function( tag, context ) { + if ( typeof context.getElementsByTagName !== "undefined" ) { + return context.getElementsByTagName( tag ); + + // DocumentFragment nodes don't have gEBTN + } else if ( support.qsa ) { + return context.querySelectorAll( tag ); + } + } : + + function( tag, context ) { + var elem, + tmp = [], + i = 0, + + // By happy coincidence, a (broken) gEBTN appears on DocumentFragment nodes too + results = context.getElementsByTagName( tag ); + + // Filter out possible comments + if ( tag === "*" ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem.nodeType === 1 ) { + tmp.push( elem ); + } + } + + return tmp; + } + return results; + }; + + // Class + Expr.find[ "CLASS" ] = support.getElementsByClassName && function( className, context ) { + if ( typeof context.getElementsByClassName !== "undefined" && documentIsHTML ) { + return context.getElementsByClassName( className ); + } + }; + + /* QSA/matchesSelector + ---------------------------------------------------------------------- */ + + // QSA and matchesSelector support + + // matchesSelector(:active) reports false when true (IE9/Opera 11.5) + rbuggyMatches = []; + + // qSa(:focus) reports false when true (Chrome 21) + // We allow this because of a bug in IE8/9 that throws an error + // whenever `document.activeElement` is accessed on an iframe + // So, we allow :focus to pass through QSA all the time to avoid the IE error + // See https://bugs.jquery.com/ticket/13378 + rbuggyQSA = []; + + if ( ( support.qsa = rnative.test( document.querySelectorAll ) ) ) { + + // Build QSA regex + // Regex strategy adopted from Diego Perini + assert( function( el ) { + + var input; + + // Select is set to empty string on purpose + // This is to test IE's treatment of not explicitly + // setting a boolean content attribute, + // since its presence should be enough + // https://bugs.jquery.com/ticket/12359 + docElem.appendChild( el ).innerHTML = "" + + ""; + + // Support: IE8, Opera 11-12.16 + // Nothing should be selected when empty strings follow ^= or $= or *= + // The test attribute must be unknown in Opera but "safe" for WinRT + // https://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section + if ( el.querySelectorAll( "[msallowcapture^='']" ).length ) { + rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" ); + } + + // Support: IE8 + // Boolean attributes and "value" are not treated correctly + if ( !el.querySelectorAll( "[selected]" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" ); + } + + // Support: Chrome<29, Android<4.4, Safari<7.0+, iOS<7.0+, PhantomJS<1.9.8+ + if ( !el.querySelectorAll( "[id~=" + expando + "-]" ).length ) { + rbuggyQSA.push( "~=" ); + } + + // Support: IE 11+, Edge 15 - 18+ + // IE 11/Edge don't find elements on a `[name='']` query in some cases. + // Adding a temporary attribute to the document before the selection works + // around the issue. + // Interestingly, IE 10 & older don't seem to have the issue. + input = document.createElement( "input" ); + input.setAttribute( "name", "" ); + el.appendChild( input ); + if ( !el.querySelectorAll( "[name='']" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*name" + whitespace + "*=" + + whitespace + "*(?:''|\"\")" ); + } + + // Webkit/Opera - :checked should return selected option elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + // IE8 throws error here and will not see later tests + if ( !el.querySelectorAll( ":checked" ).length ) { + rbuggyQSA.push( ":checked" ); + } + + // Support: Safari 8+, iOS 8+ + // https://bugs.webkit.org/show_bug.cgi?id=136851 + // In-page `selector#id sibling-combinator selector` fails + if ( !el.querySelectorAll( "a#" + expando + "+*" ).length ) { + rbuggyQSA.push( ".#.+[+~]" ); + } + + // Support: Firefox <=3.6 - 5 only + // Old Firefox doesn't throw on a badly-escaped identifier. + el.querySelectorAll( "\\\f" ); + rbuggyQSA.push( "[\\r\\n\\f]" ); + } ); + + assert( function( el ) { + el.innerHTML = "" + + ""; + + // Support: Windows 8 Native Apps + // The type and name attributes are restricted during .innerHTML assignment + var input = document.createElement( "input" ); + input.setAttribute( "type", "hidden" ); + el.appendChild( input ).setAttribute( "name", "D" ); + + // Support: IE8 + // Enforce case-sensitivity of name attribute + if ( el.querySelectorAll( "[name=d]" ).length ) { + rbuggyQSA.push( "name" + whitespace + "*[*^$|!~]?=" ); + } + + // FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled) + // IE8 throws error here and will not see later tests + if ( el.querySelectorAll( ":enabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: IE9-11+ + // IE's :disabled selector does not pick up the children of disabled fieldsets + docElem.appendChild( el ).disabled = true; + if ( el.querySelectorAll( ":disabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: Opera 10 - 11 only + // Opera 10-11 does not throw on post-comma invalid pseudos + el.querySelectorAll( "*,:x" ); + rbuggyQSA.push( ",.*:" ); + } ); + } + + if ( ( support.matchesSelector = rnative.test( ( matches = docElem.matches || + docElem.webkitMatchesSelector || + docElem.mozMatchesSelector || + docElem.oMatchesSelector || + docElem.msMatchesSelector ) ) ) ) { + + assert( function( el ) { + + // Check to see if it's possible to do matchesSelector + // on a disconnected node (IE 9) + support.disconnectedMatch = matches.call( el, "*" ); + + // This should fail with an exception + // Gecko does not error, returns false instead + matches.call( el, "[s!='']:x" ); + rbuggyMatches.push( "!=", pseudos ); + } ); + } + + rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join( "|" ) ); + rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join( "|" ) ); + + /* Contains + ---------------------------------------------------------------------- */ + hasCompare = rnative.test( docElem.compareDocumentPosition ); + + // Element contains another + // Purposefully self-exclusive + // As in, an element does not contain itself + contains = hasCompare || rnative.test( docElem.contains ) ? + function( a, b ) { + var adown = a.nodeType === 9 ? a.documentElement : a, + bup = b && b.parentNode; + return a === bup || !!( bup && bup.nodeType === 1 && ( + adown.contains ? + adown.contains( bup ) : + a.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16 + ) ); + } : + function( a, b ) { + if ( b ) { + while ( ( b = b.parentNode ) ) { + if ( b === a ) { + return true; + } + } + } + return false; + }; + + /* Sorting + ---------------------------------------------------------------------- */ + + // Document order sorting + sortOrder = hasCompare ? + function( a, b ) { + + // Flag for duplicate removal + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + // Sort on method existence if only one input has compareDocumentPosition + var compare = !a.compareDocumentPosition - !b.compareDocumentPosition; + if ( compare ) { + return compare; + } + + // Calculate position if both inputs belong to the same document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + compare = ( a.ownerDocument || a ) == ( b.ownerDocument || b ) ? + a.compareDocumentPosition( b ) : + + // Otherwise we know they are disconnected + 1; + + // Disconnected nodes + if ( compare & 1 || + ( !support.sortDetached && b.compareDocumentPosition( a ) === compare ) ) { + + // Choose the first element that is related to our preferred document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( a == document || a.ownerDocument == preferredDoc && + contains( preferredDoc, a ) ) { + return -1; + } + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( b == document || b.ownerDocument == preferredDoc && + contains( preferredDoc, b ) ) { + return 1; + } + + // Maintain original order + return sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + } + + return compare & 4 ? -1 : 1; + } : + function( a, b ) { + + // Exit early if the nodes are identical + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + var cur, + i = 0, + aup = a.parentNode, + bup = b.parentNode, + ap = [ a ], + bp = [ b ]; + + // Parentless nodes are either documents or disconnected + if ( !aup || !bup ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + return a == document ? -1 : + b == document ? 1 : + /* eslint-enable eqeqeq */ + aup ? -1 : + bup ? 1 : + sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + + // If the nodes are siblings, we can do a quick check + } else if ( aup === bup ) { + return siblingCheck( a, b ); + } + + // Otherwise we need full lists of their ancestors for comparison + cur = a; + while ( ( cur = cur.parentNode ) ) { + ap.unshift( cur ); + } + cur = b; + while ( ( cur = cur.parentNode ) ) { + bp.unshift( cur ); + } + + // Walk down the tree looking for a discrepancy + while ( ap[ i ] === bp[ i ] ) { + i++; + } + + return i ? + + // Do a sibling check if the nodes have a common ancestor + siblingCheck( ap[ i ], bp[ i ] ) : + + // Otherwise nodes in our document sort first + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + ap[ i ] == preferredDoc ? -1 : + bp[ i ] == preferredDoc ? 1 : + /* eslint-enable eqeqeq */ + 0; + }; + + return document; +}; + +Sizzle.matches = function( expr, elements ) { + return Sizzle( expr, null, null, elements ); +}; + +Sizzle.matchesSelector = function( elem, expr ) { + setDocument( elem ); + + if ( support.matchesSelector && documentIsHTML && + !nonnativeSelectorCache[ expr + " " ] && + ( !rbuggyMatches || !rbuggyMatches.test( expr ) ) && + ( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) { + + try { + var ret = matches.call( elem, expr ); + + // IE 9's matchesSelector returns false on disconnected nodes + if ( ret || support.disconnectedMatch || + + // As well, disconnected nodes are said to be in a document + // fragment in IE 9 + elem.document && elem.document.nodeType !== 11 ) { + return ret; + } + } catch ( e ) { + nonnativeSelectorCache( expr, true ); + } + } + + return Sizzle( expr, document, null, [ elem ] ).length > 0; +}; + +Sizzle.contains = function( context, elem ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( context.ownerDocument || context ) != document ) { + setDocument( context ); + } + return contains( context, elem ); +}; + +Sizzle.attr = function( elem, name ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( elem.ownerDocument || elem ) != document ) { + setDocument( elem ); + } + + var fn = Expr.attrHandle[ name.toLowerCase() ], + + // Don't get fooled by Object.prototype properties (jQuery #13807) + val = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ? + fn( elem, name, !documentIsHTML ) : + undefined; + + return val !== undefined ? + val : + support.attributes || !documentIsHTML ? + elem.getAttribute( name ) : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; +}; + +Sizzle.escape = function( sel ) { + return ( sel + "" ).replace( rcssescape, fcssescape ); +}; + +Sizzle.error = function( msg ) { + throw new Error( "Syntax error, unrecognized expression: " + msg ); +}; + +/** + * Document sorting and removing duplicates + * @param {ArrayLike} results + */ +Sizzle.uniqueSort = function( results ) { + var elem, + duplicates = [], + j = 0, + i = 0; + + // Unless we *know* we can detect duplicates, assume their presence + hasDuplicate = !support.detectDuplicates; + sortInput = !support.sortStable && results.slice( 0 ); + results.sort( sortOrder ); + + if ( hasDuplicate ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem === results[ i ] ) { + j = duplicates.push( i ); + } + } + while ( j-- ) { + results.splice( duplicates[ j ], 1 ); + } + } + + // Clear input after sorting to release objects + // See https://github.com/jquery/sizzle/pull/225 + sortInput = null; + + return results; +}; + +/** + * Utility function for retrieving the text value of an array of DOM nodes + * @param {Array|Element} elem + */ +getText = Sizzle.getText = function( elem ) { + var node, + ret = "", + i = 0, + nodeType = elem.nodeType; + + if ( !nodeType ) { + + // If no nodeType, this is expected to be an array + while ( ( node = elem[ i++ ] ) ) { + + // Do not traverse comment nodes + ret += getText( node ); + } + } else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) { + + // Use textContent for elements + // innerText usage removed for consistency of new lines (jQuery #11153) + if ( typeof elem.textContent === "string" ) { + return elem.textContent; + } else { + + // Traverse its children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + ret += getText( elem ); + } + } + } else if ( nodeType === 3 || nodeType === 4 ) { + return elem.nodeValue; + } + + // Do not include comment or processing instruction nodes + + return ret; +}; + +Expr = Sizzle.selectors = { + + // Can be adjusted by the user + cacheLength: 50, + + createPseudo: markFunction, + + match: matchExpr, + + attrHandle: {}, + + find: {}, + + relative: { + ">": { dir: "parentNode", first: true }, + " ": { dir: "parentNode" }, + "+": { dir: "previousSibling", first: true }, + "~": { dir: "previousSibling" } + }, + + preFilter: { + "ATTR": function( match ) { + match[ 1 ] = match[ 1 ].replace( runescape, funescape ); + + // Move the given value to match[3] whether quoted or unquoted + match[ 3 ] = ( match[ 3 ] || match[ 4 ] || + match[ 5 ] || "" ).replace( runescape, funescape ); + + if ( match[ 2 ] === "~=" ) { + match[ 3 ] = " " + match[ 3 ] + " "; + } + + return match.slice( 0, 4 ); + }, + + "CHILD": function( match ) { + + /* matches from matchExpr["CHILD"] + 1 type (only|nth|...) + 2 what (child|of-type) + 3 argument (even|odd|\d*|\d*n([+-]\d+)?|...) + 4 xn-component of xn+y argument ([+-]?\d*n|) + 5 sign of xn-component + 6 x of xn-component + 7 sign of y-component + 8 y of y-component + */ + match[ 1 ] = match[ 1 ].toLowerCase(); + + if ( match[ 1 ].slice( 0, 3 ) === "nth" ) { + + // nth-* requires argument + if ( !match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + // numeric x and y parameters for Expr.filter.CHILD + // remember that false/true cast respectively to 0/1 + match[ 4 ] = +( match[ 4 ] ? + match[ 5 ] + ( match[ 6 ] || 1 ) : + 2 * ( match[ 3 ] === "even" || match[ 3 ] === "odd" ) ); + match[ 5 ] = +( ( match[ 7 ] + match[ 8 ] ) || match[ 3 ] === "odd" ); + + // other types prohibit arguments + } else if ( match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + return match; + }, + + "PSEUDO": function( match ) { + var excess, + unquoted = !match[ 6 ] && match[ 2 ]; + + if ( matchExpr[ "CHILD" ].test( match[ 0 ] ) ) { + return null; + } + + // Accept quoted arguments as-is + if ( match[ 3 ] ) { + match[ 2 ] = match[ 4 ] || match[ 5 ] || ""; + + // Strip excess characters from unquoted arguments + } else if ( unquoted && rpseudo.test( unquoted ) && + + // Get excess from tokenize (recursively) + ( excess = tokenize( unquoted, true ) ) && + + // advance to the next closing parenthesis + ( excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length ) ) { + + // excess is a negative index + match[ 0 ] = match[ 0 ].slice( 0, excess ); + match[ 2 ] = unquoted.slice( 0, excess ); + } + + // Return only captures needed by the pseudo filter method (type and argument) + return match.slice( 0, 3 ); + } + }, + + filter: { + + "TAG": function( nodeNameSelector ) { + var nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase(); + return nodeNameSelector === "*" ? + function() { + return true; + } : + function( elem ) { + return elem.nodeName && elem.nodeName.toLowerCase() === nodeName; + }; + }, + + "CLASS": function( className ) { + var pattern = classCache[ className + " " ]; + + return pattern || + ( pattern = new RegExp( "(^|" + whitespace + + ")" + className + "(" + whitespace + "|$)" ) ) && classCache( + className, function( elem ) { + return pattern.test( + typeof elem.className === "string" && elem.className || + typeof elem.getAttribute !== "undefined" && + elem.getAttribute( "class" ) || + "" + ); + } ); + }, + + "ATTR": function( name, operator, check ) { + return function( elem ) { + var result = Sizzle.attr( elem, name ); + + if ( result == null ) { + return operator === "!="; + } + if ( !operator ) { + return true; + } + + result += ""; + + /* eslint-disable max-len */ + + return operator === "=" ? result === check : + operator === "!=" ? result !== check : + operator === "^=" ? check && result.indexOf( check ) === 0 : + operator === "*=" ? check && result.indexOf( check ) > -1 : + operator === "$=" ? check && result.slice( -check.length ) === check : + operator === "~=" ? ( " " + result.replace( rwhitespace, " " ) + " " ).indexOf( check ) > -1 : + operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" : + false; + /* eslint-enable max-len */ + + }; + }, + + "CHILD": function( type, what, _argument, first, last ) { + var simple = type.slice( 0, 3 ) !== "nth", + forward = type.slice( -4 ) !== "last", + ofType = what === "of-type"; + + return first === 1 && last === 0 ? + + // Shortcut for :nth-*(n) + function( elem ) { + return !!elem.parentNode; + } : + + function( elem, _context, xml ) { + var cache, uniqueCache, outerCache, node, nodeIndex, start, + dir = simple !== forward ? "nextSibling" : "previousSibling", + parent = elem.parentNode, + name = ofType && elem.nodeName.toLowerCase(), + useCache = !xml && !ofType, + diff = false; + + if ( parent ) { + + // :(first|last|only)-(child|of-type) + if ( simple ) { + while ( dir ) { + node = elem; + while ( ( node = node[ dir ] ) ) { + if ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) { + + return false; + } + } + + // Reverse direction for :only-* (if we haven't yet done so) + start = dir = type === "only" && !start && "nextSibling"; + } + return true; + } + + start = [ forward ? parent.firstChild : parent.lastChild ]; + + // non-xml :nth-child(...) stores cache data on `parent` + if ( forward && useCache ) { + + // Seek `elem` from a previously-cached index + + // ...in a gzip-friendly way + node = parent; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex && cache[ 2 ]; + node = nodeIndex && parent.childNodes[ nodeIndex ]; + + while ( ( node = ++nodeIndex && node && node[ dir ] || + + // Fallback to seeking `elem` from the start + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + // When found, cache indexes on `parent` and break + if ( node.nodeType === 1 && ++diff && node === elem ) { + uniqueCache[ type ] = [ dirruns, nodeIndex, diff ]; + break; + } + } + + } else { + + // Use previously-cached element index if available + if ( useCache ) { + + // ...in a gzip-friendly way + node = elem; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex; + } + + // xml :nth-child(...) + // or :nth-last-child(...) or :nth(-last)?-of-type(...) + if ( diff === false ) { + + // Use the same loop as above to seek `elem` from the start + while ( ( node = ++nodeIndex && node && node[ dir ] || + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + if ( ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) && + ++diff ) { + + // Cache the index of each encountered element + if ( useCache ) { + outerCache = node[ expando ] || + ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + uniqueCache[ type ] = [ dirruns, diff ]; + } + + if ( node === elem ) { + break; + } + } + } + } + } + + // Incorporate the offset, then check against cycle size + diff -= last; + return diff === first || ( diff % first === 0 && diff / first >= 0 ); + } + }; + }, + + "PSEUDO": function( pseudo, argument ) { + + // pseudo-class names are case-insensitive + // http://www.w3.org/TR/selectors/#pseudo-classes + // Prioritize by case sensitivity in case custom pseudos are added with uppercase letters + // Remember that setFilters inherits from pseudos + var args, + fn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] || + Sizzle.error( "unsupported pseudo: " + pseudo ); + + // The user may use createPseudo to indicate that + // arguments are needed to create the filter function + // just as Sizzle does + if ( fn[ expando ] ) { + return fn( argument ); + } + + // But maintain support for old signatures + if ( fn.length > 1 ) { + args = [ pseudo, pseudo, "", argument ]; + return Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ? + markFunction( function( seed, matches ) { + var idx, + matched = fn( seed, argument ), + i = matched.length; + while ( i-- ) { + idx = indexOf( seed, matched[ i ] ); + seed[ idx ] = !( matches[ idx ] = matched[ i ] ); + } + } ) : + function( elem ) { + return fn( elem, 0, args ); + }; + } + + return fn; + } + }, + + pseudos: { + + // Potentially complex pseudos + "not": markFunction( function( selector ) { + + // Trim the selector passed to compile + // to avoid treating leading and trailing + // spaces as combinators + var input = [], + results = [], + matcher = compile( selector.replace( rtrim, "$1" ) ); + + return matcher[ expando ] ? + markFunction( function( seed, matches, _context, xml ) { + var elem, + unmatched = matcher( seed, null, xml, [] ), + i = seed.length; + + // Match elements unmatched by `matcher` + while ( i-- ) { + if ( ( elem = unmatched[ i ] ) ) { + seed[ i ] = !( matches[ i ] = elem ); + } + } + } ) : + function( elem, _context, xml ) { + input[ 0 ] = elem; + matcher( input, null, xml, results ); + + // Don't keep the element (issue #299) + input[ 0 ] = null; + return !results.pop(); + }; + } ), + + "has": markFunction( function( selector ) { + return function( elem ) { + return Sizzle( selector, elem ).length > 0; + }; + } ), + + "contains": markFunction( function( text ) { + text = text.replace( runescape, funescape ); + return function( elem ) { + return ( elem.textContent || getText( elem ) ).indexOf( text ) > -1; + }; + } ), + + // "Whether an element is represented by a :lang() selector + // is based solely on the element's language value + // being equal to the identifier C, + // or beginning with the identifier C immediately followed by "-". + // The matching of C against the element's language value is performed case-insensitively. + // The identifier C does not have to be a valid language name." + // http://www.w3.org/TR/selectors/#lang-pseudo + "lang": markFunction( function( lang ) { + + // lang value must be a valid identifier + if ( !ridentifier.test( lang || "" ) ) { + Sizzle.error( "unsupported lang: " + lang ); + } + lang = lang.replace( runescape, funescape ).toLowerCase(); + return function( elem ) { + var elemLang; + do { + if ( ( elemLang = documentIsHTML ? + elem.lang : + elem.getAttribute( "xml:lang" ) || elem.getAttribute( "lang" ) ) ) { + + elemLang = elemLang.toLowerCase(); + return elemLang === lang || elemLang.indexOf( lang + "-" ) === 0; + } + } while ( ( elem = elem.parentNode ) && elem.nodeType === 1 ); + return false; + }; + } ), + + // Miscellaneous + "target": function( elem ) { + var hash = window.location && window.location.hash; + return hash && hash.slice( 1 ) === elem.id; + }, + + "root": function( elem ) { + return elem === docElem; + }, + + "focus": function( elem ) { + return elem === document.activeElement && + ( !document.hasFocus || document.hasFocus() ) && + !!( elem.type || elem.href || ~elem.tabIndex ); + }, + + // Boolean properties + "enabled": createDisabledPseudo( false ), + "disabled": createDisabledPseudo( true ), + + "checked": function( elem ) { + + // In CSS3, :checked should return both checked and selected elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + var nodeName = elem.nodeName.toLowerCase(); + return ( nodeName === "input" && !!elem.checked ) || + ( nodeName === "option" && !!elem.selected ); + }, + + "selected": function( elem ) { + + // Accessing this property makes selected-by-default + // options in Safari work properly + if ( elem.parentNode ) { + // eslint-disable-next-line no-unused-expressions + elem.parentNode.selectedIndex; + } + + return elem.selected === true; + }, + + // Contents + "empty": function( elem ) { + + // http://www.w3.org/TR/selectors/#empty-pseudo + // :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5), + // but not by others (comment: 8; processing instruction: 7; etc.) + // nodeType < 6 works because attributes (2) do not appear as children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + if ( elem.nodeType < 6 ) { + return false; + } + } + return true; + }, + + "parent": function( elem ) { + return !Expr.pseudos[ "empty" ]( elem ); + }, + + // Element/input types + "header": function( elem ) { + return rheader.test( elem.nodeName ); + }, + + "input": function( elem ) { + return rinputs.test( elem.nodeName ); + }, + + "button": function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === "button" || name === "button"; + }, + + "text": function( elem ) { + var attr; + return elem.nodeName.toLowerCase() === "input" && + elem.type === "text" && + + // Support: IE<8 + // New HTML5 attribute values (e.g., "search") appear with elem.type === "text" + ( ( attr = elem.getAttribute( "type" ) ) == null || + attr.toLowerCase() === "text" ); + }, + + // Position-in-collection + "first": createPositionalPseudo( function() { + return [ 0 ]; + } ), + + "last": createPositionalPseudo( function( _matchIndexes, length ) { + return [ length - 1 ]; + } ), + + "eq": createPositionalPseudo( function( _matchIndexes, length, argument ) { + return [ argument < 0 ? argument + length : argument ]; + } ), + + "even": createPositionalPseudo( function( matchIndexes, length ) { + var i = 0; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "odd": createPositionalPseudo( function( matchIndexes, length ) { + var i = 1; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "lt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? + argument + length : + argument > length ? + length : + argument; + for ( ; --i >= 0; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "gt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? argument + length : argument; + for ( ; ++i < length; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ) + } +}; + +Expr.pseudos[ "nth" ] = Expr.pseudos[ "eq" ]; + +// Add button/input type pseudos +for ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) { + Expr.pseudos[ i ] = createInputPseudo( i ); +} +for ( i in { submit: true, reset: true } ) { + Expr.pseudos[ i ] = createButtonPseudo( i ); +} + +// Easy API for creating new setFilters +function setFilters() {} +setFilters.prototype = Expr.filters = Expr.pseudos; +Expr.setFilters = new setFilters(); + +tokenize = Sizzle.tokenize = function( selector, parseOnly ) { + var matched, match, tokens, type, + soFar, groups, preFilters, + cached = tokenCache[ selector + " " ]; + + if ( cached ) { + return parseOnly ? 0 : cached.slice( 0 ); + } + + soFar = selector; + groups = []; + preFilters = Expr.preFilter; + + while ( soFar ) { + + // Comma and first run + if ( !matched || ( match = rcomma.exec( soFar ) ) ) { + if ( match ) { + + // Don't consume trailing commas as valid + soFar = soFar.slice( match[ 0 ].length ) || soFar; + } + groups.push( ( tokens = [] ) ); + } + + matched = false; + + // Combinators + if ( ( match = rcombinators.exec( soFar ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + + // Cast descendant combinators to space + type: match[ 0 ].replace( rtrim, " " ) + } ); + soFar = soFar.slice( matched.length ); + } + + // Filters + for ( type in Expr.filter ) { + if ( ( match = matchExpr[ type ].exec( soFar ) ) && ( !preFilters[ type ] || + ( match = preFilters[ type ]( match ) ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + type: type, + matches: match + } ); + soFar = soFar.slice( matched.length ); + } + } + + if ( !matched ) { + break; + } + } + + // Return the length of the invalid excess + // if we're just parsing + // Otherwise, throw an error or return tokens + return parseOnly ? + soFar.length : + soFar ? + Sizzle.error( selector ) : + + // Cache the tokens + tokenCache( selector, groups ).slice( 0 ); +}; + +function toSelector( tokens ) { + var i = 0, + len = tokens.length, + selector = ""; + for ( ; i < len; i++ ) { + selector += tokens[ i ].value; + } + return selector; +} + +function addCombinator( matcher, combinator, base ) { + var dir = combinator.dir, + skip = combinator.next, + key = skip || dir, + checkNonElements = base && key === "parentNode", + doneName = done++; + + return combinator.first ? + + // Check against closest ancestor/preceding element + function( elem, context, xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + return matcher( elem, context, xml ); + } + } + return false; + } : + + // Check against all ancestor/preceding elements + function( elem, context, xml ) { + var oldCache, uniqueCache, outerCache, + newCache = [ dirruns, doneName ]; + + // We can't set arbitrary data on XML nodes, so they don't benefit from combinator caching + if ( xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + if ( matcher( elem, context, xml ) ) { + return true; + } + } + } + } else { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + outerCache = elem[ expando ] || ( elem[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ elem.uniqueID ] || + ( outerCache[ elem.uniqueID ] = {} ); + + if ( skip && skip === elem.nodeName.toLowerCase() ) { + elem = elem[ dir ] || elem; + } else if ( ( oldCache = uniqueCache[ key ] ) && + oldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) { + + // Assign to newCache so results back-propagate to previous elements + return ( newCache[ 2 ] = oldCache[ 2 ] ); + } else { + + // Reuse newcache so results back-propagate to previous elements + uniqueCache[ key ] = newCache; + + // A match means we're done; a fail means we have to keep checking + if ( ( newCache[ 2 ] = matcher( elem, context, xml ) ) ) { + return true; + } + } + } + } + } + return false; + }; +} + +function elementMatcher( matchers ) { + return matchers.length > 1 ? + function( elem, context, xml ) { + var i = matchers.length; + while ( i-- ) { + if ( !matchers[ i ]( elem, context, xml ) ) { + return false; + } + } + return true; + } : + matchers[ 0 ]; +} + +function multipleContexts( selector, contexts, results ) { + var i = 0, + len = contexts.length; + for ( ; i < len; i++ ) { + Sizzle( selector, contexts[ i ], results ); + } + return results; +} + +function condense( unmatched, map, filter, context, xml ) { + var elem, + newUnmatched = [], + i = 0, + len = unmatched.length, + mapped = map != null; + + for ( ; i < len; i++ ) { + if ( ( elem = unmatched[ i ] ) ) { + if ( !filter || filter( elem, context, xml ) ) { + newUnmatched.push( elem ); + if ( mapped ) { + map.push( i ); + } + } + } + } + + return newUnmatched; +} + +function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) { + if ( postFilter && !postFilter[ expando ] ) { + postFilter = setMatcher( postFilter ); + } + if ( postFinder && !postFinder[ expando ] ) { + postFinder = setMatcher( postFinder, postSelector ); + } + return markFunction( function( seed, results, context, xml ) { + var temp, i, elem, + preMap = [], + postMap = [], + preexisting = results.length, + + // Get initial elements from seed or context + elems = seed || multipleContexts( + selector || "*", + context.nodeType ? [ context ] : context, + [] + ), + + // Prefilter to get matcher input, preserving a map for seed-results synchronization + matcherIn = preFilter && ( seed || !selector ) ? + condense( elems, preMap, preFilter, context, xml ) : + elems, + + matcherOut = matcher ? + + // If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results, + postFinder || ( seed ? preFilter : preexisting || postFilter ) ? + + // ...intermediate processing is necessary + [] : + + // ...otherwise use results directly + results : + matcherIn; + + // Find primary matches + if ( matcher ) { + matcher( matcherIn, matcherOut, context, xml ); + } + + // Apply postFilter + if ( postFilter ) { + temp = condense( matcherOut, postMap ); + postFilter( temp, [], context, xml ); + + // Un-match failing elements by moving them back to matcherIn + i = temp.length; + while ( i-- ) { + if ( ( elem = temp[ i ] ) ) { + matcherOut[ postMap[ i ] ] = !( matcherIn[ postMap[ i ] ] = elem ); + } + } + } + + if ( seed ) { + if ( postFinder || preFilter ) { + if ( postFinder ) { + + // Get the final matcherOut by condensing this intermediate into postFinder contexts + temp = []; + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) ) { + + // Restore matcherIn since elem is not yet a final match + temp.push( ( matcherIn[ i ] = elem ) ); + } + } + postFinder( null, ( matcherOut = [] ), temp, xml ); + } + + // Move matched elements from seed to results to keep them synchronized + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) && + ( temp = postFinder ? indexOf( seed, elem ) : preMap[ i ] ) > -1 ) { + + seed[ temp ] = !( results[ temp ] = elem ); + } + } + } + + // Add elements to results, through postFinder if defined + } else { + matcherOut = condense( + matcherOut === results ? + matcherOut.splice( preexisting, matcherOut.length ) : + matcherOut + ); + if ( postFinder ) { + postFinder( null, results, matcherOut, xml ); + } else { + push.apply( results, matcherOut ); + } + } + } ); +} + +function matcherFromTokens( tokens ) { + var checkContext, matcher, j, + len = tokens.length, + leadingRelative = Expr.relative[ tokens[ 0 ].type ], + implicitRelative = leadingRelative || Expr.relative[ " " ], + i = leadingRelative ? 1 : 0, + + // The foundational matcher ensures that elements are reachable from top-level context(s) + matchContext = addCombinator( function( elem ) { + return elem === checkContext; + }, implicitRelative, true ), + matchAnyContext = addCombinator( function( elem ) { + return indexOf( checkContext, elem ) > -1; + }, implicitRelative, true ), + matchers = [ function( elem, context, xml ) { + var ret = ( !leadingRelative && ( xml || context !== outermostContext ) ) || ( + ( checkContext = context ).nodeType ? + matchContext( elem, context, xml ) : + matchAnyContext( elem, context, xml ) ); + + // Avoid hanging onto element (issue #299) + checkContext = null; + return ret; + } ]; + + for ( ; i < len; i++ ) { + if ( ( matcher = Expr.relative[ tokens[ i ].type ] ) ) { + matchers = [ addCombinator( elementMatcher( matchers ), matcher ) ]; + } else { + matcher = Expr.filter[ tokens[ i ].type ].apply( null, tokens[ i ].matches ); + + // Return special upon seeing a positional matcher + if ( matcher[ expando ] ) { + + // Find the next relative operator (if any) for proper handling + j = ++i; + for ( ; j < len; j++ ) { + if ( Expr.relative[ tokens[ j ].type ] ) { + break; + } + } + return setMatcher( + i > 1 && elementMatcher( matchers ), + i > 1 && toSelector( + + // If the preceding token was a descendant combinator, insert an implicit any-element `*` + tokens + .slice( 0, i - 1 ) + .concat( { value: tokens[ i - 2 ].type === " " ? "*" : "" } ) + ).replace( rtrim, "$1" ), + matcher, + i < j && matcherFromTokens( tokens.slice( i, j ) ), + j < len && matcherFromTokens( ( tokens = tokens.slice( j ) ) ), + j < len && toSelector( tokens ) + ); + } + matchers.push( matcher ); + } + } + + return elementMatcher( matchers ); +} + +function matcherFromGroupMatchers( elementMatchers, setMatchers ) { + var bySet = setMatchers.length > 0, + byElement = elementMatchers.length > 0, + superMatcher = function( seed, context, xml, results, outermost ) { + var elem, j, matcher, + matchedCount = 0, + i = "0", + unmatched = seed && [], + setMatched = [], + contextBackup = outermostContext, + + // We must always have either seed elements or outermost context + elems = seed || byElement && Expr.find[ "TAG" ]( "*", outermost ), + + // Use integer dirruns iff this is the outermost matcher + dirrunsUnique = ( dirruns += contextBackup == null ? 1 : Math.random() || 0.1 ), + len = elems.length; + + if ( outermost ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + outermostContext = context == document || context || outermost; + } + + // Add elements passing elementMatchers directly to results + // Support: IE<9, Safari + // Tolerate NodeList properties (IE: "length"; Safari: ) matching elements by id + for ( ; i !== len && ( elem = elems[ i ] ) != null; i++ ) { + if ( byElement && elem ) { + j = 0; + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( !context && elem.ownerDocument != document ) { + setDocument( elem ); + xml = !documentIsHTML; + } + while ( ( matcher = elementMatchers[ j++ ] ) ) { + if ( matcher( elem, context || document, xml ) ) { + results.push( elem ); + break; + } + } + if ( outermost ) { + dirruns = dirrunsUnique; + } + } + + // Track unmatched elements for set filters + if ( bySet ) { + + // They will have gone through all possible matchers + if ( ( elem = !matcher && elem ) ) { + matchedCount--; + } + + // Lengthen the array for every element, matched or not + if ( seed ) { + unmatched.push( elem ); + } + } + } + + // `i` is now the count of elements visited above, and adding it to `matchedCount` + // makes the latter nonnegative. + matchedCount += i; + + // Apply set filters to unmatched elements + // NOTE: This can be skipped if there are no unmatched elements (i.e., `matchedCount` + // equals `i`), unless we didn't visit _any_ elements in the above loop because we have + // no element matchers and no seed. + // Incrementing an initially-string "0" `i` allows `i` to remain a string only in that + // case, which will result in a "00" `matchedCount` that differs from `i` but is also + // numerically zero. + if ( bySet && i !== matchedCount ) { + j = 0; + while ( ( matcher = setMatchers[ j++ ] ) ) { + matcher( unmatched, setMatched, context, xml ); + } + + if ( seed ) { + + // Reintegrate element matches to eliminate the need for sorting + if ( matchedCount > 0 ) { + while ( i-- ) { + if ( !( unmatched[ i ] || setMatched[ i ] ) ) { + setMatched[ i ] = pop.call( results ); + } + } + } + + // Discard index placeholder values to get only actual matches + setMatched = condense( setMatched ); + } + + // Add matches to results + push.apply( results, setMatched ); + + // Seedless set matches succeeding multiple successful matchers stipulate sorting + if ( outermost && !seed && setMatched.length > 0 && + ( matchedCount + setMatchers.length ) > 1 ) { + + Sizzle.uniqueSort( results ); + } + } + + // Override manipulation of globals by nested matchers + if ( outermost ) { + dirruns = dirrunsUnique; + outermostContext = contextBackup; + } + + return unmatched; + }; + + return bySet ? + markFunction( superMatcher ) : + superMatcher; +} + +compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) { + var i, + setMatchers = [], + elementMatchers = [], + cached = compilerCache[ selector + " " ]; + + if ( !cached ) { + + // Generate a function of recursive functions that can be used to check each element + if ( !match ) { + match = tokenize( selector ); + } + i = match.length; + while ( i-- ) { + cached = matcherFromTokens( match[ i ] ); + if ( cached[ expando ] ) { + setMatchers.push( cached ); + } else { + elementMatchers.push( cached ); + } + } + + // Cache the compiled function + cached = compilerCache( + selector, + matcherFromGroupMatchers( elementMatchers, setMatchers ) + ); + + // Save selector and tokenization + cached.selector = selector; + } + return cached; +}; + +/** + * A low-level selection function that works with Sizzle's compiled + * selector functions + * @param {String|Function} selector A selector or a pre-compiled + * selector function built with Sizzle.compile + * @param {Element} context + * @param {Array} [results] + * @param {Array} [seed] A set of elements to match against + */ +select = Sizzle.select = function( selector, context, results, seed ) { + var i, tokens, token, type, find, + compiled = typeof selector === "function" && selector, + match = !seed && tokenize( ( selector = compiled.selector || selector ) ); + + results = results || []; + + // Try to minimize operations if there is only one selector in the list and no seed + // (the latter of which guarantees us context) + if ( match.length === 1 ) { + + // Reduce context if the leading compound selector is an ID + tokens = match[ 0 ] = match[ 0 ].slice( 0 ); + if ( tokens.length > 2 && ( token = tokens[ 0 ] ).type === "ID" && + context.nodeType === 9 && documentIsHTML && Expr.relative[ tokens[ 1 ].type ] ) { + + context = ( Expr.find[ "ID" ]( token.matches[ 0 ] + .replace( runescape, funescape ), context ) || [] )[ 0 ]; + if ( !context ) { + return results; + + // Precompiled matchers will still verify ancestry, so step up a level + } else if ( compiled ) { + context = context.parentNode; + } + + selector = selector.slice( tokens.shift().value.length ); + } + + // Fetch a seed set for right-to-left matching + i = matchExpr[ "needsContext" ].test( selector ) ? 0 : tokens.length; + while ( i-- ) { + token = tokens[ i ]; + + // Abort if we hit a combinator + if ( Expr.relative[ ( type = token.type ) ] ) { + break; + } + if ( ( find = Expr.find[ type ] ) ) { + + // Search, expanding context for leading sibling combinators + if ( ( seed = find( + token.matches[ 0 ].replace( runescape, funescape ), + rsibling.test( tokens[ 0 ].type ) && testContext( context.parentNode ) || + context + ) ) ) { + + // If seed is empty or no tokens remain, we can return early + tokens.splice( i, 1 ); + selector = seed.length && toSelector( tokens ); + if ( !selector ) { + push.apply( results, seed ); + return results; + } + + break; + } + } + } + } + + // Compile and execute a filtering function if one is not provided + // Provide `match` to avoid retokenization if we modified the selector above + ( compiled || compile( selector, match ) )( + seed, + context, + !documentIsHTML, + results, + !context || rsibling.test( selector ) && testContext( context.parentNode ) || context + ); + return results; +}; + +// One-time assignments + +// Sort stability +support.sortStable = expando.split( "" ).sort( sortOrder ).join( "" ) === expando; + +// Support: Chrome 14-35+ +// Always assume duplicates if they aren't passed to the comparison function +support.detectDuplicates = !!hasDuplicate; + +// Initialize against the default document +setDocument(); + +// Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27) +// Detached nodes confoundingly follow *each other* +support.sortDetached = assert( function( el ) { + + // Should return 1, but returns 4 (following) + return el.compareDocumentPosition( document.createElement( "fieldset" ) ) & 1; +} ); + +// Support: IE<8 +// Prevent attribute/property "interpolation" +// https://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx +if ( !assert( function( el ) { + el.innerHTML = ""; + return el.firstChild.getAttribute( "href" ) === "#"; +} ) ) { + addHandle( "type|href|height|width", function( elem, name, isXML ) { + if ( !isXML ) { + return elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 ); + } + } ); +} + +// Support: IE<9 +// Use defaultValue in place of getAttribute("value") +if ( !support.attributes || !assert( function( el ) { + el.innerHTML = ""; + el.firstChild.setAttribute( "value", "" ); + return el.firstChild.getAttribute( "value" ) === ""; +} ) ) { + addHandle( "value", function( elem, _name, isXML ) { + if ( !isXML && elem.nodeName.toLowerCase() === "input" ) { + return elem.defaultValue; + } + } ); +} + +// Support: IE<9 +// Use getAttributeNode to fetch booleans when getAttribute lies +if ( !assert( function( el ) { + return el.getAttribute( "disabled" ) == null; +} ) ) { + addHandle( booleans, function( elem, name, isXML ) { + var val; + if ( !isXML ) { + return elem[ name ] === true ? name.toLowerCase() : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; + } + } ); +} + +return Sizzle; + +} )( window ); + + + +jQuery.find = Sizzle; +jQuery.expr = Sizzle.selectors; + +// Deprecated +jQuery.expr[ ":" ] = jQuery.expr.pseudos; +jQuery.uniqueSort = jQuery.unique = Sizzle.uniqueSort; +jQuery.text = Sizzle.getText; +jQuery.isXMLDoc = Sizzle.isXML; +jQuery.contains = Sizzle.contains; +jQuery.escapeSelector = Sizzle.escape; + + + + +var dir = function( elem, dir, until ) { + var matched = [], + truncate = until !== undefined; + + while ( ( elem = elem[ dir ] ) && elem.nodeType !== 9 ) { + if ( elem.nodeType === 1 ) { + if ( truncate && jQuery( elem ).is( until ) ) { + break; + } + matched.push( elem ); + } + } + return matched; +}; + + +var siblings = function( n, elem ) { + var matched = []; + + for ( ; n; n = n.nextSibling ) { + if ( n.nodeType === 1 && n !== elem ) { + matched.push( n ); + } + } + + return matched; +}; + + +var rneedsContext = jQuery.expr.match.needsContext; + + + +function nodeName( elem, name ) { + + return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase(); + +}; +var rsingleTag = ( /^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i ); + + + +// Implement the identical functionality for filter and not +function winnow( elements, qualifier, not ) { + if ( isFunction( qualifier ) ) { + return jQuery.grep( elements, function( elem, i ) { + return !!qualifier.call( elem, i, elem ) !== not; + } ); + } + + // Single element + if ( qualifier.nodeType ) { + return jQuery.grep( elements, function( elem ) { + return ( elem === qualifier ) !== not; + } ); + } + + // Arraylike of elements (jQuery, arguments, Array) + if ( typeof qualifier !== "string" ) { + return jQuery.grep( elements, function( elem ) { + return ( indexOf.call( qualifier, elem ) > -1 ) !== not; + } ); + } + + // Filtered directly for both simple and complex selectors + return jQuery.filter( qualifier, elements, not ); +} + +jQuery.filter = function( expr, elems, not ) { + var elem = elems[ 0 ]; + + if ( not ) { + expr = ":not(" + expr + ")"; + } + + if ( elems.length === 1 && elem.nodeType === 1 ) { + return jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : []; + } + + return jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) { + return elem.nodeType === 1; + } ) ); +}; + +jQuery.fn.extend( { + find: function( selector ) { + var i, ret, + len = this.length, + self = this; + + if ( typeof selector !== "string" ) { + return this.pushStack( jQuery( selector ).filter( function() { + for ( i = 0; i < len; i++ ) { + if ( jQuery.contains( self[ i ], this ) ) { + return true; + } + } + } ) ); + } + + ret = this.pushStack( [] ); + + for ( i = 0; i < len; i++ ) { + jQuery.find( selector, self[ i ], ret ); + } + + return len > 1 ? jQuery.uniqueSort( ret ) : ret; + }, + filter: function( selector ) { + return this.pushStack( winnow( this, selector || [], false ) ); + }, + not: function( selector ) { + return this.pushStack( winnow( this, selector || [], true ) ); + }, + is: function( selector ) { + return !!winnow( + this, + + // If this is a positional/relative selector, check membership in the returned set + // so $("p:first").is("p:last") won't return true for a doc with two "p". + typeof selector === "string" && rneedsContext.test( selector ) ? + jQuery( selector ) : + selector || [], + false + ).length; + } +} ); + + +// Initialize a jQuery object + + +// A central reference to the root jQuery(document) +var rootjQuery, + + // A simple way to check for HTML strings + // Prioritize #id over to avoid XSS via location.hash (#9521) + // Strict HTML recognition (#11290: must start with <) + // Shortcut simple #id case for speed + rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/, + + init = jQuery.fn.init = function( selector, context, root ) { + var match, elem; + + // HANDLE: $(""), $(null), $(undefined), $(false) + if ( !selector ) { + return this; + } + + // Method init() accepts an alternate rootjQuery + // so migrate can support jQuery.sub (gh-2101) + root = root || rootjQuery; + + // Handle HTML strings + if ( typeof selector === "string" ) { + if ( selector[ 0 ] === "<" && + selector[ selector.length - 1 ] === ">" && + selector.length >= 3 ) { + + // Assume that strings that start and end with <> are HTML and skip the regex check + match = [ null, selector, null ]; + + } else { + match = rquickExpr.exec( selector ); + } + + // Match html or make sure no context is specified for #id + if ( match && ( match[ 1 ] || !context ) ) { + + // HANDLE: $(html) -> $(array) + if ( match[ 1 ] ) { + context = context instanceof jQuery ? context[ 0 ] : context; + + // Option to run scripts is true for back-compat + // Intentionally let the error be thrown if parseHTML is not present + jQuery.merge( this, jQuery.parseHTML( + match[ 1 ], + context && context.nodeType ? context.ownerDocument || context : document, + true + ) ); + + // HANDLE: $(html, props) + if ( rsingleTag.test( match[ 1 ] ) && jQuery.isPlainObject( context ) ) { + for ( match in context ) { + + // Properties of context are called as methods if possible + if ( isFunction( this[ match ] ) ) { + this[ match ]( context[ match ] ); + + // ...and otherwise set as attributes + } else { + this.attr( match, context[ match ] ); + } + } + } + + return this; + + // HANDLE: $(#id) + } else { + elem = document.getElementById( match[ 2 ] ); + + if ( elem ) { + + // Inject the element directly into the jQuery object + this[ 0 ] = elem; + this.length = 1; + } + return this; + } + + // HANDLE: $(expr, $(...)) + } else if ( !context || context.jquery ) { + return ( context || root ).find( selector ); + + // HANDLE: $(expr, context) + // (which is just equivalent to: $(context).find(expr) + } else { + return this.constructor( context ).find( selector ); + } + + // HANDLE: $(DOMElement) + } else if ( selector.nodeType ) { + this[ 0 ] = selector; + this.length = 1; + return this; + + // HANDLE: $(function) + // Shortcut for document ready + } else if ( isFunction( selector ) ) { + return root.ready !== undefined ? + root.ready( selector ) : + + // Execute immediately if ready is not present + selector( jQuery ); + } + + return jQuery.makeArray( selector, this ); + }; + +// Give the init function the jQuery prototype for later instantiation +init.prototype = jQuery.fn; + +// Initialize central reference +rootjQuery = jQuery( document ); + + +var rparentsprev = /^(?:parents|prev(?:Until|All))/, + + // Methods guaranteed to produce a unique set when starting from a unique set + guaranteedUnique = { + children: true, + contents: true, + next: true, + prev: true + }; + +jQuery.fn.extend( { + has: function( target ) { + var targets = jQuery( target, this ), + l = targets.length; + + return this.filter( function() { + var i = 0; + for ( ; i < l; i++ ) { + if ( jQuery.contains( this, targets[ i ] ) ) { + return true; + } + } + } ); + }, + + closest: function( selectors, context ) { + var cur, + i = 0, + l = this.length, + matched = [], + targets = typeof selectors !== "string" && jQuery( selectors ); + + // Positional selectors never match, since there's no _selection_ context + if ( !rneedsContext.test( selectors ) ) { + for ( ; i < l; i++ ) { + for ( cur = this[ i ]; cur && cur !== context; cur = cur.parentNode ) { + + // Always skip document fragments + if ( cur.nodeType < 11 && ( targets ? + targets.index( cur ) > -1 : + + // Don't pass non-elements to Sizzle + cur.nodeType === 1 && + jQuery.find.matchesSelector( cur, selectors ) ) ) { + + matched.push( cur ); + break; + } + } + } + } + + return this.pushStack( matched.length > 1 ? jQuery.uniqueSort( matched ) : matched ); + }, + + // Determine the position of an element within the set + index: function( elem ) { + + // No argument, return index in parent + if ( !elem ) { + return ( this[ 0 ] && this[ 0 ].parentNode ) ? this.first().prevAll().length : -1; + } + + // Index in selector + if ( typeof elem === "string" ) { + return indexOf.call( jQuery( elem ), this[ 0 ] ); + } + + // Locate the position of the desired element + return indexOf.call( this, + + // If it receives a jQuery object, the first element is used + elem.jquery ? elem[ 0 ] : elem + ); + }, + + add: function( selector, context ) { + return this.pushStack( + jQuery.uniqueSort( + jQuery.merge( this.get(), jQuery( selector, context ) ) + ) + ); + }, + + addBack: function( selector ) { + return this.add( selector == null ? + this.prevObject : this.prevObject.filter( selector ) + ); + } +} ); + +function sibling( cur, dir ) { + while ( ( cur = cur[ dir ] ) && cur.nodeType !== 1 ) {} + return cur; +} + +jQuery.each( { + parent: function( elem ) { + var parent = elem.parentNode; + return parent && parent.nodeType !== 11 ? parent : null; + }, + parents: function( elem ) { + return dir( elem, "parentNode" ); + }, + parentsUntil: function( elem, _i, until ) { + return dir( elem, "parentNode", until ); + }, + next: function( elem ) { + return sibling( elem, "nextSibling" ); + }, + prev: function( elem ) { + return sibling( elem, "previousSibling" ); + }, + nextAll: function( elem ) { + return dir( elem, "nextSibling" ); + }, + prevAll: function( elem ) { + return dir( elem, "previousSibling" ); + }, + nextUntil: function( elem, _i, until ) { + return dir( elem, "nextSibling", until ); + }, + prevUntil: function( elem, _i, until ) { + return dir( elem, "previousSibling", until ); + }, + siblings: function( elem ) { + return siblings( ( elem.parentNode || {} ).firstChild, elem ); + }, + children: function( elem ) { + return siblings( elem.firstChild ); + }, + contents: function( elem ) { + if ( elem.contentDocument != null && + + // Support: IE 11+ + // elements with no `data` attribute has an object + // `contentDocument` with a `null` prototype. + getProto( elem.contentDocument ) ) { + + return elem.contentDocument; + } + + // Support: IE 9 - 11 only, iOS 7 only, Android Browser <=4.3 only + // Treat the template element as a regular one in browsers that + // don't support it. + if ( nodeName( elem, "template" ) ) { + elem = elem.content || elem; + } + + return jQuery.merge( [], elem.childNodes ); + } +}, function( name, fn ) { + jQuery.fn[ name ] = function( until, selector ) { + var matched = jQuery.map( this, fn, until ); + + if ( name.slice( -5 ) !== "Until" ) { + selector = until; + } + + if ( selector && typeof selector === "string" ) { + matched = jQuery.filter( selector, matched ); + } + + if ( this.length > 1 ) { + + // Remove duplicates + if ( !guaranteedUnique[ name ] ) { + jQuery.uniqueSort( matched ); + } + + // Reverse order for parents* and prev-derivatives + if ( rparentsprev.test( name ) ) { + matched.reverse(); + } + } + + return this.pushStack( matched ); + }; +} ); +var rnothtmlwhite = ( /[^\x20\t\r\n\f]+/g ); + + + +// Convert String-formatted options into Object-formatted ones +function createOptions( options ) { + var object = {}; + jQuery.each( options.match( rnothtmlwhite ) || [], function( _, flag ) { + object[ flag ] = true; + } ); + return object; +} + +/* + * Create a callback list using the following parameters: + * + * options: an optional list of space-separated options that will change how + * the callback list behaves or a more traditional option object + * + * By default a callback list will act like an event callback list and can be + * "fired" multiple times. + * + * Possible options: + * + * once: will ensure the callback list can only be fired once (like a Deferred) + * + * memory: will keep track of previous values and will call any callback added + * after the list has been fired right away with the latest "memorized" + * values (like a Deferred) + * + * unique: will ensure a callback can only be added once (no duplicate in the list) + * + * stopOnFalse: interrupt callings when a callback returns false + * + */ +jQuery.Callbacks = function( options ) { + + // Convert options from String-formatted to Object-formatted if needed + // (we check in cache first) + options = typeof options === "string" ? + createOptions( options ) : + jQuery.extend( {}, options ); + + var // Flag to know if list is currently firing + firing, + + // Last fire value for non-forgettable lists + memory, + + // Flag to know if list was already fired + fired, + + // Flag to prevent firing + locked, + + // Actual callback list + list = [], + + // Queue of execution data for repeatable lists + queue = [], + + // Index of currently firing callback (modified by add/remove as needed) + firingIndex = -1, + + // Fire callbacks + fire = function() { + + // Enforce single-firing + locked = locked || options.once; + + // Execute callbacks for all pending executions, + // respecting firingIndex overrides and runtime changes + fired = firing = true; + for ( ; queue.length; firingIndex = -1 ) { + memory = queue.shift(); + while ( ++firingIndex < list.length ) { + + // Run callback and check for early termination + if ( list[ firingIndex ].apply( memory[ 0 ], memory[ 1 ] ) === false && + options.stopOnFalse ) { + + // Jump to end and forget the data so .add doesn't re-fire + firingIndex = list.length; + memory = false; + } + } + } + + // Forget the data if we're done with it + if ( !options.memory ) { + memory = false; + } + + firing = false; + + // Clean up if we're done firing for good + if ( locked ) { + + // Keep an empty list if we have data for future add calls + if ( memory ) { + list = []; + + // Otherwise, this object is spent + } else { + list = ""; + } + } + }, + + // Actual Callbacks object + self = { + + // Add a callback or a collection of callbacks to the list + add: function() { + if ( list ) { + + // If we have memory from a past run, we should fire after adding + if ( memory && !firing ) { + firingIndex = list.length - 1; + queue.push( memory ); + } + + ( function add( args ) { + jQuery.each( args, function( _, arg ) { + if ( isFunction( arg ) ) { + if ( !options.unique || !self.has( arg ) ) { + list.push( arg ); + } + } else if ( arg && arg.length && toType( arg ) !== "string" ) { + + // Inspect recursively + add( arg ); + } + } ); + } )( arguments ); + + if ( memory && !firing ) { + fire(); + } + } + return this; + }, + + // Remove a callback from the list + remove: function() { + jQuery.each( arguments, function( _, arg ) { + var index; + while ( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) { + list.splice( index, 1 ); + + // Handle firing indexes + if ( index <= firingIndex ) { + firingIndex--; + } + } + } ); + return this; + }, + + // Check if a given callback is in the list. + // If no argument is given, return whether or not list has callbacks attached. + has: function( fn ) { + return fn ? + jQuery.inArray( fn, list ) > -1 : + list.length > 0; + }, + + // Remove all callbacks from the list + empty: function() { + if ( list ) { + list = []; + } + return this; + }, + + // Disable .fire and .add + // Abort any current/pending executions + // Clear all callbacks and values + disable: function() { + locked = queue = []; + list = memory = ""; + return this; + }, + disabled: function() { + return !list; + }, + + // Disable .fire + // Also disable .add unless we have memory (since it would have no effect) + // Abort any pending executions + lock: function() { + locked = queue = []; + if ( !memory && !firing ) { + list = memory = ""; + } + return this; + }, + locked: function() { + return !!locked; + }, + + // Call all callbacks with the given context and arguments + fireWith: function( context, args ) { + if ( !locked ) { + args = args || []; + args = [ context, args.slice ? args.slice() : args ]; + queue.push( args ); + if ( !firing ) { + fire(); + } + } + return this; + }, + + // Call all the callbacks with the given arguments + fire: function() { + self.fireWith( this, arguments ); + return this; + }, + + // To know if the callbacks have already been called at least once + fired: function() { + return !!fired; + } + }; + + return self; +}; + + +function Identity( v ) { + return v; +} +function Thrower( ex ) { + throw ex; +} + +function adoptValue( value, resolve, reject, noValue ) { + var method; + + try { + + // Check for promise aspect first to privilege synchronous behavior + if ( value && isFunction( ( method = value.promise ) ) ) { + method.call( value ).done( resolve ).fail( reject ); + + // Other thenables + } else if ( value && isFunction( ( method = value.then ) ) ) { + method.call( value, resolve, reject ); + + // Other non-thenables + } else { + + // Control `resolve` arguments by letting Array#slice cast boolean `noValue` to integer: + // * false: [ value ].slice( 0 ) => resolve( value ) + // * true: [ value ].slice( 1 ) => resolve() + resolve.apply( undefined, [ value ].slice( noValue ) ); + } + + // For Promises/A+, convert exceptions into rejections + // Since jQuery.when doesn't unwrap thenables, we can skip the extra checks appearing in + // Deferred#then to conditionally suppress rejection. + } catch ( value ) { + + // Support: Android 4.0 only + // Strict mode functions invoked without .call/.apply get global-object context + reject.apply( undefined, [ value ] ); + } +} + +jQuery.extend( { + + Deferred: function( func ) { + var tuples = [ + + // action, add listener, callbacks, + // ... .then handlers, argument index, [final state] + [ "notify", "progress", jQuery.Callbacks( "memory" ), + jQuery.Callbacks( "memory" ), 2 ], + [ "resolve", "done", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 0, "resolved" ], + [ "reject", "fail", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 1, "rejected" ] + ], + state = "pending", + promise = { + state: function() { + return state; + }, + always: function() { + deferred.done( arguments ).fail( arguments ); + return this; + }, + "catch": function( fn ) { + return promise.then( null, fn ); + }, + + // Keep pipe for back-compat + pipe: function( /* fnDone, fnFail, fnProgress */ ) { + var fns = arguments; + + return jQuery.Deferred( function( newDefer ) { + jQuery.each( tuples, function( _i, tuple ) { + + // Map tuples (progress, done, fail) to arguments (done, fail, progress) + var fn = isFunction( fns[ tuple[ 4 ] ] ) && fns[ tuple[ 4 ] ]; + + // deferred.progress(function() { bind to newDefer or newDefer.notify }) + // deferred.done(function() { bind to newDefer or newDefer.resolve }) + // deferred.fail(function() { bind to newDefer or newDefer.reject }) + deferred[ tuple[ 1 ] ]( function() { + var returned = fn && fn.apply( this, arguments ); + if ( returned && isFunction( returned.promise ) ) { + returned.promise() + .progress( newDefer.notify ) + .done( newDefer.resolve ) + .fail( newDefer.reject ); + } else { + newDefer[ tuple[ 0 ] + "With" ]( + this, + fn ? [ returned ] : arguments + ); + } + } ); + } ); + fns = null; + } ).promise(); + }, + then: function( onFulfilled, onRejected, onProgress ) { + var maxDepth = 0; + function resolve( depth, deferred, handler, special ) { + return function() { + var that = this, + args = arguments, + mightThrow = function() { + var returned, then; + + // Support: Promises/A+ section 2.3.3.3.3 + // https://promisesaplus.com/#point-59 + // Ignore double-resolution attempts + if ( depth < maxDepth ) { + return; + } + + returned = handler.apply( that, args ); + + // Support: Promises/A+ section 2.3.1 + // https://promisesaplus.com/#point-48 + if ( returned === deferred.promise() ) { + throw new TypeError( "Thenable self-resolution" ); + } + + // Support: Promises/A+ sections 2.3.3.1, 3.5 + // https://promisesaplus.com/#point-54 + // https://promisesaplus.com/#point-75 + // Retrieve `then` only once + then = returned && + + // Support: Promises/A+ section 2.3.4 + // https://promisesaplus.com/#point-64 + // Only check objects and functions for thenability + ( typeof returned === "object" || + typeof returned === "function" ) && + returned.then; + + // Handle a returned thenable + if ( isFunction( then ) ) { + + // Special processors (notify) just wait for resolution + if ( special ) { + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ) + ); + + // Normal processors (resolve) also hook into progress + } else { + + // ...and disregard older resolution values + maxDepth++; + + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ), + resolve( maxDepth, deferred, Identity, + deferred.notifyWith ) + ); + } + + // Handle all other returned values + } else { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Identity ) { + that = undefined; + args = [ returned ]; + } + + // Process the value(s) + // Default process is resolve + ( special || deferred.resolveWith )( that, args ); + } + }, + + // Only normal processors (resolve) catch and reject exceptions + process = special ? + mightThrow : + function() { + try { + mightThrow(); + } catch ( e ) { + + if ( jQuery.Deferred.exceptionHook ) { + jQuery.Deferred.exceptionHook( e, + process.stackTrace ); + } + + // Support: Promises/A+ section 2.3.3.3.4.1 + // https://promisesaplus.com/#point-61 + // Ignore post-resolution exceptions + if ( depth + 1 >= maxDepth ) { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Thrower ) { + that = undefined; + args = [ e ]; + } + + deferred.rejectWith( that, args ); + } + } + }; + + // Support: Promises/A+ section 2.3.3.3.1 + // https://promisesaplus.com/#point-57 + // Re-resolve promises immediately to dodge false rejection from + // subsequent errors + if ( depth ) { + process(); + } else { + + // Call an optional hook to record the stack, in case of exception + // since it's otherwise lost when execution goes async + if ( jQuery.Deferred.getStackHook ) { + process.stackTrace = jQuery.Deferred.getStackHook(); + } + window.setTimeout( process ); + } + }; + } + + return jQuery.Deferred( function( newDefer ) { + + // progress_handlers.add( ... ) + tuples[ 0 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onProgress ) ? + onProgress : + Identity, + newDefer.notifyWith + ) + ); + + // fulfilled_handlers.add( ... ) + tuples[ 1 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onFulfilled ) ? + onFulfilled : + Identity + ) + ); + + // rejected_handlers.add( ... ) + tuples[ 2 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onRejected ) ? + onRejected : + Thrower + ) + ); + } ).promise(); + }, + + // Get a promise for this deferred + // If obj is provided, the promise aspect is added to the object + promise: function( obj ) { + return obj != null ? jQuery.extend( obj, promise ) : promise; + } + }, + deferred = {}; + + // Add list-specific methods + jQuery.each( tuples, function( i, tuple ) { + var list = tuple[ 2 ], + stateString = tuple[ 5 ]; + + // promise.progress = list.add + // promise.done = list.add + // promise.fail = list.add + promise[ tuple[ 1 ] ] = list.add; + + // Handle state + if ( stateString ) { + list.add( + function() { + + // state = "resolved" (i.e., fulfilled) + // state = "rejected" + state = stateString; + }, + + // rejected_callbacks.disable + // fulfilled_callbacks.disable + tuples[ 3 - i ][ 2 ].disable, + + // rejected_handlers.disable + // fulfilled_handlers.disable + tuples[ 3 - i ][ 3 ].disable, + + // progress_callbacks.lock + tuples[ 0 ][ 2 ].lock, + + // progress_handlers.lock + tuples[ 0 ][ 3 ].lock + ); + } + + // progress_handlers.fire + // fulfilled_handlers.fire + // rejected_handlers.fire + list.add( tuple[ 3 ].fire ); + + // deferred.notify = function() { deferred.notifyWith(...) } + // deferred.resolve = function() { deferred.resolveWith(...) } + // deferred.reject = function() { deferred.rejectWith(...) } + deferred[ tuple[ 0 ] ] = function() { + deferred[ tuple[ 0 ] + "With" ]( this === deferred ? undefined : this, arguments ); + return this; + }; + + // deferred.notifyWith = list.fireWith + // deferred.resolveWith = list.fireWith + // deferred.rejectWith = list.fireWith + deferred[ tuple[ 0 ] + "With" ] = list.fireWith; + } ); + + // Make the deferred a promise + promise.promise( deferred ); + + // Call given func if any + if ( func ) { + func.call( deferred, deferred ); + } + + // All done! + return deferred; + }, + + // Deferred helper + when: function( singleValue ) { + var + + // count of uncompleted subordinates + remaining = arguments.length, + + // count of unprocessed arguments + i = remaining, + + // subordinate fulfillment data + resolveContexts = Array( i ), + resolveValues = slice.call( arguments ), + + // the master Deferred + master = jQuery.Deferred(), + + // subordinate callback factory + updateFunc = function( i ) { + return function( value ) { + resolveContexts[ i ] = this; + resolveValues[ i ] = arguments.length > 1 ? slice.call( arguments ) : value; + if ( !( --remaining ) ) { + master.resolveWith( resolveContexts, resolveValues ); + } + }; + }; + + // Single- and empty arguments are adopted like Promise.resolve + if ( remaining <= 1 ) { + adoptValue( singleValue, master.done( updateFunc( i ) ).resolve, master.reject, + !remaining ); + + // Use .then() to unwrap secondary thenables (cf. gh-3000) + if ( master.state() === "pending" || + isFunction( resolveValues[ i ] && resolveValues[ i ].then ) ) { + + return master.then(); + } + } + + // Multiple arguments are aggregated like Promise.all array elements + while ( i-- ) { + adoptValue( resolveValues[ i ], updateFunc( i ), master.reject ); + } + + return master.promise(); + } +} ); + + +// These usually indicate a programmer mistake during development, +// warn about them ASAP rather than swallowing them by default. +var rerrorNames = /^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/; + +jQuery.Deferred.exceptionHook = function( error, stack ) { + + // Support: IE 8 - 9 only + // Console exists when dev tools are open, which can happen at any time + if ( window.console && window.console.warn && error && rerrorNames.test( error.name ) ) { + window.console.warn( "jQuery.Deferred exception: " + error.message, error.stack, stack ); + } +}; + + + + +jQuery.readyException = function( error ) { + window.setTimeout( function() { + throw error; + } ); +}; + + + + +// The deferred used on DOM ready +var readyList = jQuery.Deferred(); + +jQuery.fn.ready = function( fn ) { + + readyList + .then( fn ) + + // Wrap jQuery.readyException in a function so that the lookup + // happens at the time of error handling instead of callback + // registration. + .catch( function( error ) { + jQuery.readyException( error ); + } ); + + return this; +}; + +jQuery.extend( { + + // Is the DOM ready to be used? Set to true once it occurs. + isReady: false, + + // A counter to track how many items to wait for before + // the ready event fires. See #6781 + readyWait: 1, + + // Handle when the DOM is ready + ready: function( wait ) { + + // Abort if there are pending holds or we're already ready + if ( wait === true ? --jQuery.readyWait : jQuery.isReady ) { + return; + } + + // Remember that the DOM is ready + jQuery.isReady = true; + + // If a normal DOM Ready event fired, decrement, and wait if need be + if ( wait !== true && --jQuery.readyWait > 0 ) { + return; + } + + // If there are functions bound, to execute + readyList.resolveWith( document, [ jQuery ] ); + } +} ); + +jQuery.ready.then = readyList.then; + +// The ready event handler and self cleanup method +function completed() { + document.removeEventListener( "DOMContentLoaded", completed ); + window.removeEventListener( "load", completed ); + jQuery.ready(); +} + +// Catch cases where $(document).ready() is called +// after the browser event has already occurred. +// Support: IE <=9 - 10 only +// Older IE sometimes signals "interactive" too soon +if ( document.readyState === "complete" || + ( document.readyState !== "loading" && !document.documentElement.doScroll ) ) { + + // Handle it asynchronously to allow scripts the opportunity to delay ready + window.setTimeout( jQuery.ready ); + +} else { + + // Use the handy event callback + document.addEventListener( "DOMContentLoaded", completed ); + + // A fallback to window.onload, that will always work + window.addEventListener( "load", completed ); +} + + + + +// Multifunctional method to get and set values of a collection +// The value/s can optionally be executed if it's a function +var access = function( elems, fn, key, value, chainable, emptyGet, raw ) { + var i = 0, + len = elems.length, + bulk = key == null; + + // Sets many values + if ( toType( key ) === "object" ) { + chainable = true; + for ( i in key ) { + access( elems, fn, i, key[ i ], true, emptyGet, raw ); + } + + // Sets one value + } else if ( value !== undefined ) { + chainable = true; + + if ( !isFunction( value ) ) { + raw = true; + } + + if ( bulk ) { + + // Bulk operations run against the entire set + if ( raw ) { + fn.call( elems, value ); + fn = null; + + // ...except when executing function values + } else { + bulk = fn; + fn = function( elem, _key, value ) { + return bulk.call( jQuery( elem ), value ); + }; + } + } + + if ( fn ) { + for ( ; i < len; i++ ) { + fn( + elems[ i ], key, raw ? + value : + value.call( elems[ i ], i, fn( elems[ i ], key ) ) + ); + } + } + } + + if ( chainable ) { + return elems; + } + + // Gets + if ( bulk ) { + return fn.call( elems ); + } + + return len ? fn( elems[ 0 ], key ) : emptyGet; +}; + + +// Matches dashed string for camelizing +var rmsPrefix = /^-ms-/, + rdashAlpha = /-([a-z])/g; + +// Used by camelCase as callback to replace() +function fcamelCase( _all, letter ) { + return letter.toUpperCase(); +} + +// Convert dashed to camelCase; used by the css and data modules +// Support: IE <=9 - 11, Edge 12 - 15 +// Microsoft forgot to hump their vendor prefix (#9572) +function camelCase( string ) { + return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase ); +} +var acceptData = function( owner ) { + + // Accepts only: + // - Node + // - Node.ELEMENT_NODE + // - Node.DOCUMENT_NODE + // - Object + // - Any + return owner.nodeType === 1 || owner.nodeType === 9 || !( +owner.nodeType ); +}; + + + + +function Data() { + this.expando = jQuery.expando + Data.uid++; +} + +Data.uid = 1; + +Data.prototype = { + + cache: function( owner ) { + + // Check if the owner object already has a cache + var value = owner[ this.expando ]; + + // If not, create one + if ( !value ) { + value = {}; + + // We can accept data for non-element nodes in modern browsers, + // but we should not, see #8335. + // Always return an empty object. + if ( acceptData( owner ) ) { + + // If it is a node unlikely to be stringify-ed or looped over + // use plain assignment + if ( owner.nodeType ) { + owner[ this.expando ] = value; + + // Otherwise secure it in a non-enumerable property + // configurable must be true to allow the property to be + // deleted when data is removed + } else { + Object.defineProperty( owner, this.expando, { + value: value, + configurable: true + } ); + } + } + } + + return value; + }, + set: function( owner, data, value ) { + var prop, + cache = this.cache( owner ); + + // Handle: [ owner, key, value ] args + // Always use camelCase key (gh-2257) + if ( typeof data === "string" ) { + cache[ camelCase( data ) ] = value; + + // Handle: [ owner, { properties } ] args + } else { + + // Copy the properties one-by-one to the cache object + for ( prop in data ) { + cache[ camelCase( prop ) ] = data[ prop ]; + } + } + return cache; + }, + get: function( owner, key ) { + return key === undefined ? + this.cache( owner ) : + + // Always use camelCase key (gh-2257) + owner[ this.expando ] && owner[ this.expando ][ camelCase( key ) ]; + }, + access: function( owner, key, value ) { + + // In cases where either: + // + // 1. No key was specified + // 2. A string key was specified, but no value provided + // + // Take the "read" path and allow the get method to determine + // which value to return, respectively either: + // + // 1. The entire cache object + // 2. The data stored at the key + // + if ( key === undefined || + ( ( key && typeof key === "string" ) && value === undefined ) ) { + + return this.get( owner, key ); + } + + // When the key is not a string, or both a key and value + // are specified, set or extend (existing objects) with either: + // + // 1. An object of properties + // 2. A key and value + // + this.set( owner, key, value ); + + // Since the "set" path can have two possible entry points + // return the expected data based on which path was taken[*] + return value !== undefined ? value : key; + }, + remove: function( owner, key ) { + var i, + cache = owner[ this.expando ]; + + if ( cache === undefined ) { + return; + } + + if ( key !== undefined ) { + + // Support array or space separated string of keys + if ( Array.isArray( key ) ) { + + // If key is an array of keys... + // We always set camelCase keys, so remove that. + key = key.map( camelCase ); + } else { + key = camelCase( key ); + + // If a key with the spaces exists, use it. + // Otherwise, create an array by matching non-whitespace + key = key in cache ? + [ key ] : + ( key.match( rnothtmlwhite ) || [] ); + } + + i = key.length; + + while ( i-- ) { + delete cache[ key[ i ] ]; + } + } + + // Remove the expando if there's no more data + if ( key === undefined || jQuery.isEmptyObject( cache ) ) { + + // Support: Chrome <=35 - 45 + // Webkit & Blink performance suffers when deleting properties + // from DOM nodes, so set to undefined instead + // https://bugs.chromium.org/p/chromium/issues/detail?id=378607 (bug restricted) + if ( owner.nodeType ) { + owner[ this.expando ] = undefined; + } else { + delete owner[ this.expando ]; + } + } + }, + hasData: function( owner ) { + var cache = owner[ this.expando ]; + return cache !== undefined && !jQuery.isEmptyObject( cache ); + } +}; +var dataPriv = new Data(); + +var dataUser = new Data(); + + + +// Implementation Summary +// +// 1. Enforce API surface and semantic compatibility with 1.9.x branch +// 2. Improve the module's maintainability by reducing the storage +// paths to a single mechanism. +// 3. Use the same single mechanism to support "private" and "user" data. +// 4. _Never_ expose "private" data to user code (TODO: Drop _data, _removeData) +// 5. Avoid exposing implementation details on user objects (eg. expando properties) +// 6. Provide a clear path for implementation upgrade to WeakMap in 2014 + +var rbrace = /^(?:\{[\w\W]*\}|\[[\w\W]*\])$/, + rmultiDash = /[A-Z]/g; + +function getData( data ) { + if ( data === "true" ) { + return true; + } + + if ( data === "false" ) { + return false; + } + + if ( data === "null" ) { + return null; + } + + // Only convert to a number if it doesn't change the string + if ( data === +data + "" ) { + return +data; + } + + if ( rbrace.test( data ) ) { + return JSON.parse( data ); + } + + return data; +} + +function dataAttr( elem, key, data ) { + var name; + + // If nothing was found internally, try to fetch any + // data from the HTML5 data-* attribute + if ( data === undefined && elem.nodeType === 1 ) { + name = "data-" + key.replace( rmultiDash, "-$&" ).toLowerCase(); + data = elem.getAttribute( name ); + + if ( typeof data === "string" ) { + try { + data = getData( data ); + } catch ( e ) {} + + // Make sure we set the data so it isn't changed later + dataUser.set( elem, key, data ); + } else { + data = undefined; + } + } + return data; +} + +jQuery.extend( { + hasData: function( elem ) { + return dataUser.hasData( elem ) || dataPriv.hasData( elem ); + }, + + data: function( elem, name, data ) { + return dataUser.access( elem, name, data ); + }, + + removeData: function( elem, name ) { + dataUser.remove( elem, name ); + }, + + // TODO: Now that all calls to _data and _removeData have been replaced + // with direct calls to dataPriv methods, these can be deprecated. + _data: function( elem, name, data ) { + return dataPriv.access( elem, name, data ); + }, + + _removeData: function( elem, name ) { + dataPriv.remove( elem, name ); + } +} ); + +jQuery.fn.extend( { + data: function( key, value ) { + var i, name, data, + elem = this[ 0 ], + attrs = elem && elem.attributes; + + // Gets all values + if ( key === undefined ) { + if ( this.length ) { + data = dataUser.get( elem ); + + if ( elem.nodeType === 1 && !dataPriv.get( elem, "hasDataAttrs" ) ) { + i = attrs.length; + while ( i-- ) { + + // Support: IE 11 only + // The attrs elements can be null (#14894) + if ( attrs[ i ] ) { + name = attrs[ i ].name; + if ( name.indexOf( "data-" ) === 0 ) { + name = camelCase( name.slice( 5 ) ); + dataAttr( elem, name, data[ name ] ); + } + } + } + dataPriv.set( elem, "hasDataAttrs", true ); + } + } + + return data; + } + + // Sets multiple values + if ( typeof key === "object" ) { + return this.each( function() { + dataUser.set( this, key ); + } ); + } + + return access( this, function( value ) { + var data; + + // The calling jQuery object (element matches) is not empty + // (and therefore has an element appears at this[ 0 ]) and the + // `value` parameter was not undefined. An empty jQuery object + // will result in `undefined` for elem = this[ 0 ] which will + // throw an exception if an attempt to read a data cache is made. + if ( elem && value === undefined ) { + + // Attempt to get data from the cache + // The key will always be camelCased in Data + data = dataUser.get( elem, key ); + if ( data !== undefined ) { + return data; + } + + // Attempt to "discover" the data in + // HTML5 custom data-* attrs + data = dataAttr( elem, key ); + if ( data !== undefined ) { + return data; + } + + // We tried really hard, but the data doesn't exist. + return; + } + + // Set the data... + this.each( function() { + + // We always store the camelCased key + dataUser.set( this, key, value ); + } ); + }, null, value, arguments.length > 1, null, true ); + }, + + removeData: function( key ) { + return this.each( function() { + dataUser.remove( this, key ); + } ); + } +} ); + + +jQuery.extend( { + queue: function( elem, type, data ) { + var queue; + + if ( elem ) { + type = ( type || "fx" ) + "queue"; + queue = dataPriv.get( elem, type ); + + // Speed up dequeue by getting out quickly if this is just a lookup + if ( data ) { + if ( !queue || Array.isArray( data ) ) { + queue = dataPriv.access( elem, type, jQuery.makeArray( data ) ); + } else { + queue.push( data ); + } + } + return queue || []; + } + }, + + dequeue: function( elem, type ) { + type = type || "fx"; + + var queue = jQuery.queue( elem, type ), + startLength = queue.length, + fn = queue.shift(), + hooks = jQuery._queueHooks( elem, type ), + next = function() { + jQuery.dequeue( elem, type ); + }; + + // If the fx queue is dequeued, always remove the progress sentinel + if ( fn === "inprogress" ) { + fn = queue.shift(); + startLength--; + } + + if ( fn ) { + + // Add a progress sentinel to prevent the fx queue from being + // automatically dequeued + if ( type === "fx" ) { + queue.unshift( "inprogress" ); + } + + // Clear up the last queue stop function + delete hooks.stop; + fn.call( elem, next, hooks ); + } + + if ( !startLength && hooks ) { + hooks.empty.fire(); + } + }, + + // Not public - generate a queueHooks object, or return the current one + _queueHooks: function( elem, type ) { + var key = type + "queueHooks"; + return dataPriv.get( elem, key ) || dataPriv.access( elem, key, { + empty: jQuery.Callbacks( "once memory" ).add( function() { + dataPriv.remove( elem, [ type + "queue", key ] ); + } ) + } ); + } +} ); + +jQuery.fn.extend( { + queue: function( type, data ) { + var setter = 2; + + if ( typeof type !== "string" ) { + data = type; + type = "fx"; + setter--; + } + + if ( arguments.length < setter ) { + return jQuery.queue( this[ 0 ], type ); + } + + return data === undefined ? + this : + this.each( function() { + var queue = jQuery.queue( this, type, data ); + + // Ensure a hooks for this queue + jQuery._queueHooks( this, type ); + + if ( type === "fx" && queue[ 0 ] !== "inprogress" ) { + jQuery.dequeue( this, type ); + } + } ); + }, + dequeue: function( type ) { + return this.each( function() { + jQuery.dequeue( this, type ); + } ); + }, + clearQueue: function( type ) { + return this.queue( type || "fx", [] ); + }, + + // Get a promise resolved when queues of a certain type + // are emptied (fx is the type by default) + promise: function( type, obj ) { + var tmp, + count = 1, + defer = jQuery.Deferred(), + elements = this, + i = this.length, + resolve = function() { + if ( !( --count ) ) { + defer.resolveWith( elements, [ elements ] ); + } + }; + + if ( typeof type !== "string" ) { + obj = type; + type = undefined; + } + type = type || "fx"; + + while ( i-- ) { + tmp = dataPriv.get( elements[ i ], type + "queueHooks" ); + if ( tmp && tmp.empty ) { + count++; + tmp.empty.add( resolve ); + } + } + resolve(); + return defer.promise( obj ); + } +} ); +var pnum = ( /[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/ ).source; + +var rcssNum = new RegExp( "^(?:([+-])=|)(" + pnum + ")([a-z%]*)$", "i" ); + + +var cssExpand = [ "Top", "Right", "Bottom", "Left" ]; + +var documentElement = document.documentElement; + + + + var isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ); + }, + composed = { composed: true }; + + // Support: IE 9 - 11+, Edge 12 - 18+, iOS 10.0 - 10.2 only + // Check attachment across shadow DOM boundaries when possible (gh-3504) + // Support: iOS 10.0-10.2 only + // Early iOS 10 versions support `attachShadow` but not `getRootNode`, + // leading to errors. We need to check for `getRootNode`. + if ( documentElement.getRootNode ) { + isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ) || + elem.getRootNode( composed ) === elem.ownerDocument; + }; + } +var isHiddenWithinTree = function( elem, el ) { + + // isHiddenWithinTree might be called from jQuery#filter function; + // in that case, element will be second argument + elem = el || elem; + + // Inline style trumps all + return elem.style.display === "none" || + elem.style.display === "" && + + // Otherwise, check computed style + // Support: Firefox <=43 - 45 + // Disconnected elements can have computed display: none, so first confirm that elem is + // in the document. + isAttached( elem ) && + + jQuery.css( elem, "display" ) === "none"; + }; + + + +function adjustCSS( elem, prop, valueParts, tween ) { + var adjusted, scale, + maxIterations = 20, + currentValue = tween ? + function() { + return tween.cur(); + } : + function() { + return jQuery.css( elem, prop, "" ); + }, + initial = currentValue(), + unit = valueParts && valueParts[ 3 ] || ( jQuery.cssNumber[ prop ] ? "" : "px" ), + + // Starting value computation is required for potential unit mismatches + initialInUnit = elem.nodeType && + ( jQuery.cssNumber[ prop ] || unit !== "px" && +initial ) && + rcssNum.exec( jQuery.css( elem, prop ) ); + + if ( initialInUnit && initialInUnit[ 3 ] !== unit ) { + + // Support: Firefox <=54 + // Halve the iteration target value to prevent interference from CSS upper bounds (gh-2144) + initial = initial / 2; + + // Trust units reported by jQuery.css + unit = unit || initialInUnit[ 3 ]; + + // Iteratively approximate from a nonzero starting point + initialInUnit = +initial || 1; + + while ( maxIterations-- ) { + + // Evaluate and update our best guess (doubling guesses that zero out). + // Finish if the scale equals or crosses 1 (making the old*new product non-positive). + jQuery.style( elem, prop, initialInUnit + unit ); + if ( ( 1 - scale ) * ( 1 - ( scale = currentValue() / initial || 0.5 ) ) <= 0 ) { + maxIterations = 0; + } + initialInUnit = initialInUnit / scale; + + } + + initialInUnit = initialInUnit * 2; + jQuery.style( elem, prop, initialInUnit + unit ); + + // Make sure we update the tween properties later on + valueParts = valueParts || []; + } + + if ( valueParts ) { + initialInUnit = +initialInUnit || +initial || 0; + + // Apply relative offset (+=/-=) if specified + adjusted = valueParts[ 1 ] ? + initialInUnit + ( valueParts[ 1 ] + 1 ) * valueParts[ 2 ] : + +valueParts[ 2 ]; + if ( tween ) { + tween.unit = unit; + tween.start = initialInUnit; + tween.end = adjusted; + } + } + return adjusted; +} + + +var defaultDisplayMap = {}; + +function getDefaultDisplay( elem ) { + var temp, + doc = elem.ownerDocument, + nodeName = elem.nodeName, + display = defaultDisplayMap[ nodeName ]; + + if ( display ) { + return display; + } + + temp = doc.body.appendChild( doc.createElement( nodeName ) ); + display = jQuery.css( temp, "display" ); + + temp.parentNode.removeChild( temp ); + + if ( display === "none" ) { + display = "block"; + } + defaultDisplayMap[ nodeName ] = display; + + return display; +} + +function showHide( elements, show ) { + var display, elem, + values = [], + index = 0, + length = elements.length; + + // Determine new display value for elements that need to change + for ( ; index < length; index++ ) { + elem = elements[ index ]; + if ( !elem.style ) { + continue; + } + + display = elem.style.display; + if ( show ) { + + // Since we force visibility upon cascade-hidden elements, an immediate (and slow) + // check is required in this first loop unless we have a nonempty display value (either + // inline or about-to-be-restored) + if ( display === "none" ) { + values[ index ] = dataPriv.get( elem, "display" ) || null; + if ( !values[ index ] ) { + elem.style.display = ""; + } + } + if ( elem.style.display === "" && isHiddenWithinTree( elem ) ) { + values[ index ] = getDefaultDisplay( elem ); + } + } else { + if ( display !== "none" ) { + values[ index ] = "none"; + + // Remember what we're overwriting + dataPriv.set( elem, "display", display ); + } + } + } + + // Set the display of the elements in a second loop to avoid constant reflow + for ( index = 0; index < length; index++ ) { + if ( values[ index ] != null ) { + elements[ index ].style.display = values[ index ]; + } + } + + return elements; +} + +jQuery.fn.extend( { + show: function() { + return showHide( this, true ); + }, + hide: function() { + return showHide( this ); + }, + toggle: function( state ) { + if ( typeof state === "boolean" ) { + return state ? this.show() : this.hide(); + } + + return this.each( function() { + if ( isHiddenWithinTree( this ) ) { + jQuery( this ).show(); + } else { + jQuery( this ).hide(); + } + } ); + } +} ); +var rcheckableType = ( /^(?:checkbox|radio)$/i ); + +var rtagName = ( /<([a-z][^\/\0>\x20\t\r\n\f]*)/i ); + +var rscriptType = ( /^$|^module$|\/(?:java|ecma)script/i ); + + + +( function() { + var fragment = document.createDocumentFragment(), + div = fragment.appendChild( document.createElement( "div" ) ), + input = document.createElement( "input" ); + + // Support: Android 4.0 - 4.3 only + // Check state lost if the name is set (#11217) + // Support: Windows Web Apps (WWA) + // `name` and `type` must use .setAttribute for WWA (#14901) + input.setAttribute( "type", "radio" ); + input.setAttribute( "checked", "checked" ); + input.setAttribute( "name", "t" ); + + div.appendChild( input ); + + // Support: Android <=4.1 only + // Older WebKit doesn't clone checked state correctly in fragments + support.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked; + + // Support: IE <=11 only + // Make sure textarea (and checkbox) defaultValue is properly cloned + div.innerHTML = ""; + support.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue; + + // Support: IE <=9 only + // IE <=9 replaces "; + support.option = !!div.lastChild; +} )(); + + +// We have to close these tags to support XHTML (#13200) +var wrapMap = { + + // XHTML parsers do not magically insert elements in the + // same way that tag soup parsers do. So we cannot shorten + // this by omitting or other required elements. + thead: [ 1, "", "
" ], + col: [ 2, "", "
" ], + tr: [ 2, "", "
" ], + td: [ 3, "", "
" ], + + _default: [ 0, "", "" ] +}; + +wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; +wrapMap.th = wrapMap.td; + +// Support: IE <=9 only +if ( !support.option ) { + wrapMap.optgroup = wrapMap.option = [ 1, "" ]; +} + + +function getAll( context, tag ) { + + // Support: IE <=9 - 11 only + // Use typeof to avoid zero-argument method invocation on host objects (#15151) + var ret; + + if ( typeof context.getElementsByTagName !== "undefined" ) { + ret = context.getElementsByTagName( tag || "*" ); + + } else if ( typeof context.querySelectorAll !== "undefined" ) { + ret = context.querySelectorAll( tag || "*" ); + + } else { + ret = []; + } + + if ( tag === undefined || tag && nodeName( context, tag ) ) { + return jQuery.merge( [ context ], ret ); + } + + return ret; +} + + +// Mark scripts as having already been evaluated +function setGlobalEval( elems, refElements ) { + var i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + dataPriv.set( + elems[ i ], + "globalEval", + !refElements || dataPriv.get( refElements[ i ], "globalEval" ) + ); + } +} + + +var rhtml = /<|&#?\w+;/; + +function buildFragment( elems, context, scripts, selection, ignored ) { + var elem, tmp, tag, wrap, attached, j, + fragment = context.createDocumentFragment(), + nodes = [], + i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + elem = elems[ i ]; + + if ( elem || elem === 0 ) { + + // Add nodes directly + if ( toType( elem ) === "object" ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, elem.nodeType ? [ elem ] : elem ); + + // Convert non-html into a text node + } else if ( !rhtml.test( elem ) ) { + nodes.push( context.createTextNode( elem ) ); + + // Convert html into DOM nodes + } else { + tmp = tmp || fragment.appendChild( context.createElement( "div" ) ); + + // Deserialize a standard representation + tag = ( rtagName.exec( elem ) || [ "", "" ] )[ 1 ].toLowerCase(); + wrap = wrapMap[ tag ] || wrapMap._default; + tmp.innerHTML = wrap[ 1 ] + jQuery.htmlPrefilter( elem ) + wrap[ 2 ]; + + // Descend through wrappers to the right content + j = wrap[ 0 ]; + while ( j-- ) { + tmp = tmp.lastChild; + } + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, tmp.childNodes ); + + // Remember the top-level container + tmp = fragment.firstChild; + + // Ensure the created nodes are orphaned (#12392) + tmp.textContent = ""; + } + } + } + + // Remove wrapper from fragment + fragment.textContent = ""; + + i = 0; + while ( ( elem = nodes[ i++ ] ) ) { + + // Skip elements already in the context collection (trac-4087) + if ( selection && jQuery.inArray( elem, selection ) > -1 ) { + if ( ignored ) { + ignored.push( elem ); + } + continue; + } + + attached = isAttached( elem ); + + // Append to fragment + tmp = getAll( fragment.appendChild( elem ), "script" ); + + // Preserve script evaluation history + if ( attached ) { + setGlobalEval( tmp ); + } + + // Capture executables + if ( scripts ) { + j = 0; + while ( ( elem = tmp[ j++ ] ) ) { + if ( rscriptType.test( elem.type || "" ) ) { + scripts.push( elem ); + } + } + } + } + + return fragment; +} + + +var + rkeyEvent = /^key/, + rmouseEvent = /^(?:mouse|pointer|contextmenu|drag|drop)|click/, + rtypenamespace = /^([^.]*)(?:\.(.+)|)/; + +function returnTrue() { + return true; +} + +function returnFalse() { + return false; +} + +// Support: IE <=9 - 11+ +// focus() and blur() are asynchronous, except when they are no-op. +// So expect focus to be synchronous when the element is already active, +// and blur to be synchronous when the element is not already active. +// (focus and blur are always synchronous in other supported browsers, +// this just defines when we can count on it). +function expectSync( elem, type ) { + return ( elem === safeActiveElement() ) === ( type === "focus" ); +} + +// Support: IE <=9 only +// Accessing document.activeElement can throw unexpectedly +// https://bugs.jquery.com/ticket/13393 +function safeActiveElement() { + try { + return document.activeElement; + } catch ( err ) { } +} + +function on( elem, types, selector, data, fn, one ) { + var origFn, type; + + // Types can be a map of types/handlers + if ( typeof types === "object" ) { + + // ( types-Object, selector, data ) + if ( typeof selector !== "string" ) { + + // ( types-Object, data ) + data = data || selector; + selector = undefined; + } + for ( type in types ) { + on( elem, type, selector, data, types[ type ], one ); + } + return elem; + } + + if ( data == null && fn == null ) { + + // ( types, fn ) + fn = selector; + data = selector = undefined; + } else if ( fn == null ) { + if ( typeof selector === "string" ) { + + // ( types, selector, fn ) + fn = data; + data = undefined; + } else { + + // ( types, data, fn ) + fn = data; + data = selector; + selector = undefined; + } + } + if ( fn === false ) { + fn = returnFalse; + } else if ( !fn ) { + return elem; + } + + if ( one === 1 ) { + origFn = fn; + fn = function( event ) { + + // Can use an empty set, since event contains the info + jQuery().off( event ); + return origFn.apply( this, arguments ); + }; + + // Use same guid so caller can remove using origFn + fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ ); + } + return elem.each( function() { + jQuery.event.add( this, types, fn, data, selector ); + } ); +} + +/* + * Helper functions for managing events -- not part of the public interface. + * Props to Dean Edwards' addEvent library for many of the ideas. + */ +jQuery.event = { + + global: {}, + + add: function( elem, types, handler, data, selector ) { + + var handleObjIn, eventHandle, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.get( elem ); + + // Only attach events to objects that accept data + if ( !acceptData( elem ) ) { + return; + } + + // Caller can pass in an object of custom data in lieu of the handler + if ( handler.handler ) { + handleObjIn = handler; + handler = handleObjIn.handler; + selector = handleObjIn.selector; + } + + // Ensure that invalid selectors throw exceptions at attach time + // Evaluate against documentElement in case elem is a non-element node (e.g., document) + if ( selector ) { + jQuery.find.matchesSelector( documentElement, selector ); + } + + // Make sure that the handler has a unique ID, used to find/remove it later + if ( !handler.guid ) { + handler.guid = jQuery.guid++; + } + + // Init the element's event structure and main handler, if this is the first + if ( !( events = elemData.events ) ) { + events = elemData.events = Object.create( null ); + } + if ( !( eventHandle = elemData.handle ) ) { + eventHandle = elemData.handle = function( e ) { + + // Discard the second event of a jQuery.event.trigger() and + // when an event is called after a page has unloaded + return typeof jQuery !== "undefined" && jQuery.event.triggered !== e.type ? + jQuery.event.dispatch.apply( elem, arguments ) : undefined; + }; + } + + // Handle multiple events separated by a space + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // There *must* be a type, no attaching namespace-only handlers + if ( !type ) { + continue; + } + + // If event changes its type, use the special event handlers for the changed type + special = jQuery.event.special[ type ] || {}; + + // If selector defined, determine special event api type, otherwise given type + type = ( selector ? special.delegateType : special.bindType ) || type; + + // Update special based on newly reset type + special = jQuery.event.special[ type ] || {}; + + // handleObj is passed to all event handlers + handleObj = jQuery.extend( { + type: type, + origType: origType, + data: data, + handler: handler, + guid: handler.guid, + selector: selector, + needsContext: selector && jQuery.expr.match.needsContext.test( selector ), + namespace: namespaces.join( "." ) + }, handleObjIn ); + + // Init the event handler queue if we're the first + if ( !( handlers = events[ type ] ) ) { + handlers = events[ type ] = []; + handlers.delegateCount = 0; + + // Only use addEventListener if the special events handler returns false + if ( !special.setup || + special.setup.call( elem, data, namespaces, eventHandle ) === false ) { + + if ( elem.addEventListener ) { + elem.addEventListener( type, eventHandle ); + } + } + } + + if ( special.add ) { + special.add.call( elem, handleObj ); + + if ( !handleObj.handler.guid ) { + handleObj.handler.guid = handler.guid; + } + } + + // Add to the element's handler list, delegates in front + if ( selector ) { + handlers.splice( handlers.delegateCount++, 0, handleObj ); + } else { + handlers.push( handleObj ); + } + + // Keep track of which events have ever been used, for event optimization + jQuery.event.global[ type ] = true; + } + + }, + + // Detach an event or set of events from an element + remove: function( elem, types, handler, selector, mappedTypes ) { + + var j, origCount, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.hasData( elem ) && dataPriv.get( elem ); + + if ( !elemData || !( events = elemData.events ) ) { + return; + } + + // Once for each type.namespace in types; type may be omitted + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // Unbind all events (on this namespace, if provided) for the element + if ( !type ) { + for ( type in events ) { + jQuery.event.remove( elem, type + types[ t ], handler, selector, true ); + } + continue; + } + + special = jQuery.event.special[ type ] || {}; + type = ( selector ? special.delegateType : special.bindType ) || type; + handlers = events[ type ] || []; + tmp = tmp[ 2 ] && + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ); + + // Remove matching events + origCount = j = handlers.length; + while ( j-- ) { + handleObj = handlers[ j ]; + + if ( ( mappedTypes || origType === handleObj.origType ) && + ( !handler || handler.guid === handleObj.guid ) && + ( !tmp || tmp.test( handleObj.namespace ) ) && + ( !selector || selector === handleObj.selector || + selector === "**" && handleObj.selector ) ) { + handlers.splice( j, 1 ); + + if ( handleObj.selector ) { + handlers.delegateCount--; + } + if ( special.remove ) { + special.remove.call( elem, handleObj ); + } + } + } + + // Remove generic event handler if we removed something and no more handlers exist + // (avoids potential for endless recursion during removal of special event handlers) + if ( origCount && !handlers.length ) { + if ( !special.teardown || + special.teardown.call( elem, namespaces, elemData.handle ) === false ) { + + jQuery.removeEvent( elem, type, elemData.handle ); + } + + delete events[ type ]; + } + } + + // Remove data and the expando if it's no longer used + if ( jQuery.isEmptyObject( events ) ) { + dataPriv.remove( elem, "handle events" ); + } + }, + + dispatch: function( nativeEvent ) { + + var i, j, ret, matched, handleObj, handlerQueue, + args = new Array( arguments.length ), + + // Make a writable jQuery.Event from the native event object + event = jQuery.event.fix( nativeEvent ), + + handlers = ( + dataPriv.get( this, "events" ) || Object.create( null ) + )[ event.type ] || [], + special = jQuery.event.special[ event.type ] || {}; + + // Use the fix-ed jQuery.Event rather than the (read-only) native event + args[ 0 ] = event; + + for ( i = 1; i < arguments.length; i++ ) { + args[ i ] = arguments[ i ]; + } + + event.delegateTarget = this; + + // Call the preDispatch hook for the mapped type, and let it bail if desired + if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) { + return; + } + + // Determine handlers + handlerQueue = jQuery.event.handlers.call( this, event, handlers ); + + // Run delegates first; they may want to stop propagation beneath us + i = 0; + while ( ( matched = handlerQueue[ i++ ] ) && !event.isPropagationStopped() ) { + event.currentTarget = matched.elem; + + j = 0; + while ( ( handleObj = matched.handlers[ j++ ] ) && + !event.isImmediatePropagationStopped() ) { + + // If the event is namespaced, then each handler is only invoked if it is + // specially universal or its namespaces are a superset of the event's. + if ( !event.rnamespace || handleObj.namespace === false || + event.rnamespace.test( handleObj.namespace ) ) { + + event.handleObj = handleObj; + event.data = handleObj.data; + + ret = ( ( jQuery.event.special[ handleObj.origType ] || {} ).handle || + handleObj.handler ).apply( matched.elem, args ); + + if ( ret !== undefined ) { + if ( ( event.result = ret ) === false ) { + event.preventDefault(); + event.stopPropagation(); + } + } + } + } + } + + // Call the postDispatch hook for the mapped type + if ( special.postDispatch ) { + special.postDispatch.call( this, event ); + } + + return event.result; + }, + + handlers: function( event, handlers ) { + var i, handleObj, sel, matchedHandlers, matchedSelectors, + handlerQueue = [], + delegateCount = handlers.delegateCount, + cur = event.target; + + // Find delegate handlers + if ( delegateCount && + + // Support: IE <=9 + // Black-hole SVG instance trees (trac-13180) + cur.nodeType && + + // Support: Firefox <=42 + // Suppress spec-violating clicks indicating a non-primary pointer button (trac-3861) + // https://www.w3.org/TR/DOM-Level-3-Events/#event-type-click + // Support: IE 11 only + // ...but not arrow key "clicks" of radio inputs, which can have `button` -1 (gh-2343) + !( event.type === "click" && event.button >= 1 ) ) { + + for ( ; cur !== this; cur = cur.parentNode || this ) { + + // Don't check non-elements (#13208) + // Don't process clicks on disabled elements (#6911, #8165, #11382, #11764) + if ( cur.nodeType === 1 && !( event.type === "click" && cur.disabled === true ) ) { + matchedHandlers = []; + matchedSelectors = {}; + for ( i = 0; i < delegateCount; i++ ) { + handleObj = handlers[ i ]; + + // Don't conflict with Object.prototype properties (#13203) + sel = handleObj.selector + " "; + + if ( matchedSelectors[ sel ] === undefined ) { + matchedSelectors[ sel ] = handleObj.needsContext ? + jQuery( sel, this ).index( cur ) > -1 : + jQuery.find( sel, this, null, [ cur ] ).length; + } + if ( matchedSelectors[ sel ] ) { + matchedHandlers.push( handleObj ); + } + } + if ( matchedHandlers.length ) { + handlerQueue.push( { elem: cur, handlers: matchedHandlers } ); + } + } + } + } + + // Add the remaining (directly-bound) handlers + cur = this; + if ( delegateCount < handlers.length ) { + handlerQueue.push( { elem: cur, handlers: handlers.slice( delegateCount ) } ); + } + + return handlerQueue; + }, + + addProp: function( name, hook ) { + Object.defineProperty( jQuery.Event.prototype, name, { + enumerable: true, + configurable: true, + + get: isFunction( hook ) ? + function() { + if ( this.originalEvent ) { + return hook( this.originalEvent ); + } + } : + function() { + if ( this.originalEvent ) { + return this.originalEvent[ name ]; + } + }, + + set: function( value ) { + Object.defineProperty( this, name, { + enumerable: true, + configurable: true, + writable: true, + value: value + } ); + } + } ); + }, + + fix: function( originalEvent ) { + return originalEvent[ jQuery.expando ] ? + originalEvent : + new jQuery.Event( originalEvent ); + }, + + special: { + load: { + + // Prevent triggered image.load events from bubbling to window.load + noBubble: true + }, + click: { + + // Utilize native event to ensure correct state for checkable inputs + setup: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Claim the first handler + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + // dataPriv.set( el, "click", ... ) + leverageNative( el, "click", returnTrue ); + } + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Force setup before triggering a click + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + leverageNative( el, "click" ); + } + + // Return non-false to allow normal event-path propagation + return true; + }, + + // For cross-browser consistency, suppress native .click() on links + // Also prevent it if we're currently inside a leveraged native-event stack + _default: function( event ) { + var target = event.target; + return rcheckableType.test( target.type ) && + target.click && nodeName( target, "input" ) && + dataPriv.get( target, "click" ) || + nodeName( target, "a" ); + } + }, + + beforeunload: { + postDispatch: function( event ) { + + // Support: Firefox 20+ + // Firefox doesn't alert if the returnValue field is not set. + if ( event.result !== undefined && event.originalEvent ) { + event.originalEvent.returnValue = event.result; + } + } + } + } +}; + +// Ensure the presence of an event listener that handles manually-triggered +// synthetic events by interrupting progress until reinvoked in response to +// *native* events that it fires directly, ensuring that state changes have +// already occurred before other listeners are invoked. +function leverageNative( el, type, expectSync ) { + + // Missing expectSync indicates a trigger call, which must force setup through jQuery.event.add + if ( !expectSync ) { + if ( dataPriv.get( el, type ) === undefined ) { + jQuery.event.add( el, type, returnTrue ); + } + return; + } + + // Register the controller as a special universal handler for all event namespaces + dataPriv.set( el, type, false ); + jQuery.event.add( el, type, { + namespace: false, + handler: function( event ) { + var notAsync, result, + saved = dataPriv.get( this, type ); + + if ( ( event.isTrigger & 1 ) && this[ type ] ) { + + // Interrupt processing of the outer synthetic .trigger()ed event + // Saved data should be false in such cases, but might be a leftover capture object + // from an async native handler (gh-4350) + if ( !saved.length ) { + + // Store arguments for use when handling the inner native event + // There will always be at least one argument (an event object), so this array + // will not be confused with a leftover capture object. + saved = slice.call( arguments ); + dataPriv.set( this, type, saved ); + + // Trigger the native event and capture its result + // Support: IE <=9 - 11+ + // focus() and blur() are asynchronous + notAsync = expectSync( this, type ); + this[ type ](); + result = dataPriv.get( this, type ); + if ( saved !== result || notAsync ) { + dataPriv.set( this, type, false ); + } else { + result = {}; + } + if ( saved !== result ) { + + // Cancel the outer synthetic event + event.stopImmediatePropagation(); + event.preventDefault(); + return result.value; + } + + // If this is an inner synthetic event for an event with a bubbling surrogate + // (focus or blur), assume that the surrogate already propagated from triggering the + // native event and prevent that from happening again here. + // This technically gets the ordering wrong w.r.t. to `.trigger()` (in which the + // bubbling surrogate propagates *after* the non-bubbling base), but that seems + // less bad than duplication. + } else if ( ( jQuery.event.special[ type ] || {} ).delegateType ) { + event.stopPropagation(); + } + + // If this is a native event triggered above, everything is now in order + // Fire an inner synthetic event with the original arguments + } else if ( saved.length ) { + + // ...and capture the result + dataPriv.set( this, type, { + value: jQuery.event.trigger( + + // Support: IE <=9 - 11+ + // Extend with the prototype to reset the above stopImmediatePropagation() + jQuery.extend( saved[ 0 ], jQuery.Event.prototype ), + saved.slice( 1 ), + this + ) + } ); + + // Abort handling of the native event + event.stopImmediatePropagation(); + } + } + } ); +} + +jQuery.removeEvent = function( elem, type, handle ) { + + // This "if" is needed for plain objects + if ( elem.removeEventListener ) { + elem.removeEventListener( type, handle ); + } +}; + +jQuery.Event = function( src, props ) { + + // Allow instantiation without the 'new' keyword + if ( !( this instanceof jQuery.Event ) ) { + return new jQuery.Event( src, props ); + } + + // Event object + if ( src && src.type ) { + this.originalEvent = src; + this.type = src.type; + + // Events bubbling up the document may have been marked as prevented + // by a handler lower down the tree; reflect the correct value. + this.isDefaultPrevented = src.defaultPrevented || + src.defaultPrevented === undefined && + + // Support: Android <=2.3 only + src.returnValue === false ? + returnTrue : + returnFalse; + + // Create target properties + // Support: Safari <=6 - 7 only + // Target should not be a text node (#504, #13143) + this.target = ( src.target && src.target.nodeType === 3 ) ? + src.target.parentNode : + src.target; + + this.currentTarget = src.currentTarget; + this.relatedTarget = src.relatedTarget; + + // Event type + } else { + this.type = src; + } + + // Put explicitly provided properties onto the event object + if ( props ) { + jQuery.extend( this, props ); + } + + // Create a timestamp if incoming event doesn't have one + this.timeStamp = src && src.timeStamp || Date.now(); + + // Mark it as fixed + this[ jQuery.expando ] = true; +}; + +// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding +// https://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html +jQuery.Event.prototype = { + constructor: jQuery.Event, + isDefaultPrevented: returnFalse, + isPropagationStopped: returnFalse, + isImmediatePropagationStopped: returnFalse, + isSimulated: false, + + preventDefault: function() { + var e = this.originalEvent; + + this.isDefaultPrevented = returnTrue; + + if ( e && !this.isSimulated ) { + e.preventDefault(); + } + }, + stopPropagation: function() { + var e = this.originalEvent; + + this.isPropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopPropagation(); + } + }, + stopImmediatePropagation: function() { + var e = this.originalEvent; + + this.isImmediatePropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopImmediatePropagation(); + } + + this.stopPropagation(); + } +}; + +// Includes all common event props including KeyEvent and MouseEvent specific props +jQuery.each( { + altKey: true, + bubbles: true, + cancelable: true, + changedTouches: true, + ctrlKey: true, + detail: true, + eventPhase: true, + metaKey: true, + pageX: true, + pageY: true, + shiftKey: true, + view: true, + "char": true, + code: true, + charCode: true, + key: true, + keyCode: true, + button: true, + buttons: true, + clientX: true, + clientY: true, + offsetX: true, + offsetY: true, + pointerId: true, + pointerType: true, + screenX: true, + screenY: true, + targetTouches: true, + toElement: true, + touches: true, + + which: function( event ) { + var button = event.button; + + // Add which for key events + if ( event.which == null && rkeyEvent.test( event.type ) ) { + return event.charCode != null ? event.charCode : event.keyCode; + } + + // Add which for click: 1 === left; 2 === middle; 3 === right + if ( !event.which && button !== undefined && rmouseEvent.test( event.type ) ) { + if ( button & 1 ) { + return 1; + } + + if ( button & 2 ) { + return 3; + } + + if ( button & 4 ) { + return 2; + } + + return 0; + } + + return event.which; + } +}, jQuery.event.addProp ); + +jQuery.each( { focus: "focusin", blur: "focusout" }, function( type, delegateType ) { + jQuery.event.special[ type ] = { + + // Utilize native event if possible so blur/focus sequence is correct + setup: function() { + + // Claim the first handler + // dataPriv.set( this, "focus", ... ) + // dataPriv.set( this, "blur", ... ) + leverageNative( this, type, expectSync ); + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function() { + + // Force setup before trigger + leverageNative( this, type ); + + // Return non-false to allow normal event-path propagation + return true; + }, + + delegateType: delegateType + }; +} ); + +// Create mouseenter/leave events using mouseover/out and event-time checks +// so that event delegation works in jQuery. +// Do the same for pointerenter/pointerleave and pointerover/pointerout +// +// Support: Safari 7 only +// Safari sends mouseenter too often; see: +// https://bugs.chromium.org/p/chromium/issues/detail?id=470258 +// for the description of the bug (it existed in older Chrome versions as well). +jQuery.each( { + mouseenter: "mouseover", + mouseleave: "mouseout", + pointerenter: "pointerover", + pointerleave: "pointerout" +}, function( orig, fix ) { + jQuery.event.special[ orig ] = { + delegateType: fix, + bindType: fix, + + handle: function( event ) { + var ret, + target = this, + related = event.relatedTarget, + handleObj = event.handleObj; + + // For mouseenter/leave call the handler if related is outside the target. + // NB: No relatedTarget if the mouse left/entered the browser window + if ( !related || ( related !== target && !jQuery.contains( target, related ) ) ) { + event.type = handleObj.origType; + ret = handleObj.handler.apply( this, arguments ); + event.type = fix; + } + return ret; + } + }; +} ); + +jQuery.fn.extend( { + + on: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn ); + }, + one: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn, 1 ); + }, + off: function( types, selector, fn ) { + var handleObj, type; + if ( types && types.preventDefault && types.handleObj ) { + + // ( event ) dispatched jQuery.Event + handleObj = types.handleObj; + jQuery( types.delegateTarget ).off( + handleObj.namespace ? + handleObj.origType + "." + handleObj.namespace : + handleObj.origType, + handleObj.selector, + handleObj.handler + ); + return this; + } + if ( typeof types === "object" ) { + + // ( types-object [, selector] ) + for ( type in types ) { + this.off( type, selector, types[ type ] ); + } + return this; + } + if ( selector === false || typeof selector === "function" ) { + + // ( types [, fn] ) + fn = selector; + selector = undefined; + } + if ( fn === false ) { + fn = returnFalse; + } + return this.each( function() { + jQuery.event.remove( this, types, fn, selector ); + } ); + } +} ); + + +var + + // Support: IE <=10 - 11, Edge 12 - 13 only + // In IE/Edge using regex groups here causes severe slowdowns. + // See https://connect.microsoft.com/IE/feedback/details/1736512/ + rnoInnerhtml = /\s*$/g; + +// Prefer a tbody over its parent table for containing new rows +function manipulationTarget( elem, content ) { + if ( nodeName( elem, "table" ) && + nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ) { + + return jQuery( elem ).children( "tbody" )[ 0 ] || elem; + } + + return elem; +} + +// Replace/restore the type attribute of script elements for safe DOM manipulation +function disableScript( elem ) { + elem.type = ( elem.getAttribute( "type" ) !== null ) + "/" + elem.type; + return elem; +} +function restoreScript( elem ) { + if ( ( elem.type || "" ).slice( 0, 5 ) === "true/" ) { + elem.type = elem.type.slice( 5 ); + } else { + elem.removeAttribute( "type" ); + } + + return elem; +} + +function cloneCopyEvent( src, dest ) { + var i, l, type, pdataOld, udataOld, udataCur, events; + + if ( dest.nodeType !== 1 ) { + return; + } + + // 1. Copy private data: events, handlers, etc. + if ( dataPriv.hasData( src ) ) { + pdataOld = dataPriv.get( src ); + events = pdataOld.events; + + if ( events ) { + dataPriv.remove( dest, "handle events" ); + + for ( type in events ) { + for ( i = 0, l = events[ type ].length; i < l; i++ ) { + jQuery.event.add( dest, type, events[ type ][ i ] ); + } + } + } + } + + // 2. Copy user data + if ( dataUser.hasData( src ) ) { + udataOld = dataUser.access( src ); + udataCur = jQuery.extend( {}, udataOld ); + + dataUser.set( dest, udataCur ); + } +} + +// Fix IE bugs, see support tests +function fixInput( src, dest ) { + var nodeName = dest.nodeName.toLowerCase(); + + // Fails to persist the checked state of a cloned checkbox or radio button. + if ( nodeName === "input" && rcheckableType.test( src.type ) ) { + dest.checked = src.checked; + + // Fails to return the selected option to the default selected state when cloning options + } else if ( nodeName === "input" || nodeName === "textarea" ) { + dest.defaultValue = src.defaultValue; + } +} + +function domManip( collection, args, callback, ignored ) { + + // Flatten any nested arrays + args = flat( args ); + + var fragment, first, scripts, hasScripts, node, doc, + i = 0, + l = collection.length, + iNoClone = l - 1, + value = args[ 0 ], + valueIsFunction = isFunction( value ); + + // We can't cloneNode fragments that contain checked, in WebKit + if ( valueIsFunction || + ( l > 1 && typeof value === "string" && + !support.checkClone && rchecked.test( value ) ) ) { + return collection.each( function( index ) { + var self = collection.eq( index ); + if ( valueIsFunction ) { + args[ 0 ] = value.call( this, index, self.html() ); + } + domManip( self, args, callback, ignored ); + } ); + } + + if ( l ) { + fragment = buildFragment( args, collection[ 0 ].ownerDocument, false, collection, ignored ); + first = fragment.firstChild; + + if ( fragment.childNodes.length === 1 ) { + fragment = first; + } + + // Require either new content or an interest in ignored elements to invoke the callback + if ( first || ignored ) { + scripts = jQuery.map( getAll( fragment, "script" ), disableScript ); + hasScripts = scripts.length; + + // Use the original fragment for the last item + // instead of the first because it can end up + // being emptied incorrectly in certain situations (#8070). + for ( ; i < l; i++ ) { + node = fragment; + + if ( i !== iNoClone ) { + node = jQuery.clone( node, true, true ); + + // Keep references to cloned scripts for later restoration + if ( hasScripts ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( scripts, getAll( node, "script" ) ); + } + } + + callback.call( collection[ i ], node, i ); + } + + if ( hasScripts ) { + doc = scripts[ scripts.length - 1 ].ownerDocument; + + // Reenable scripts + jQuery.map( scripts, restoreScript ); + + // Evaluate executable scripts on first document insertion + for ( i = 0; i < hasScripts; i++ ) { + node = scripts[ i ]; + if ( rscriptType.test( node.type || "" ) && + !dataPriv.access( node, "globalEval" ) && + jQuery.contains( doc, node ) ) { + + if ( node.src && ( node.type || "" ).toLowerCase() !== "module" ) { + + // Optional AJAX dependency, but won't run scripts if not present + if ( jQuery._evalUrl && !node.noModule ) { + jQuery._evalUrl( node.src, { + nonce: node.nonce || node.getAttribute( "nonce" ) + }, doc ); + } + } else { + DOMEval( node.textContent.replace( rcleanScript, "" ), node, doc ); + } + } + } + } + } + } + + return collection; +} + +function remove( elem, selector, keepData ) { + var node, + nodes = selector ? jQuery.filter( selector, elem ) : elem, + i = 0; + + for ( ; ( node = nodes[ i ] ) != null; i++ ) { + if ( !keepData && node.nodeType === 1 ) { + jQuery.cleanData( getAll( node ) ); + } + + if ( node.parentNode ) { + if ( keepData && isAttached( node ) ) { + setGlobalEval( getAll( node, "script" ) ); + } + node.parentNode.removeChild( node ); + } + } + + return elem; +} + +jQuery.extend( { + htmlPrefilter: function( html ) { + return html; + }, + + clone: function( elem, dataAndEvents, deepDataAndEvents ) { + var i, l, srcElements, destElements, + clone = elem.cloneNode( true ), + inPage = isAttached( elem ); + + // Fix IE cloning issues + if ( !support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) && + !jQuery.isXMLDoc( elem ) ) { + + // We eschew Sizzle here for performance reasons: https://jsperf.com/getall-vs-sizzle/2 + destElements = getAll( clone ); + srcElements = getAll( elem ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + fixInput( srcElements[ i ], destElements[ i ] ); + } + } + + // Copy the events from the original to the clone + if ( dataAndEvents ) { + if ( deepDataAndEvents ) { + srcElements = srcElements || getAll( elem ); + destElements = destElements || getAll( clone ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + cloneCopyEvent( srcElements[ i ], destElements[ i ] ); + } + } else { + cloneCopyEvent( elem, clone ); + } + } + + // Preserve script evaluation history + destElements = getAll( clone, "script" ); + if ( destElements.length > 0 ) { + setGlobalEval( destElements, !inPage && getAll( elem, "script" ) ); + } + + // Return the cloned set + return clone; + }, + + cleanData: function( elems ) { + var data, elem, type, + special = jQuery.event.special, + i = 0; + + for ( ; ( elem = elems[ i ] ) !== undefined; i++ ) { + if ( acceptData( elem ) ) { + if ( ( data = elem[ dataPriv.expando ] ) ) { + if ( data.events ) { + for ( type in data.events ) { + if ( special[ type ] ) { + jQuery.event.remove( elem, type ); + + // This is a shortcut to avoid jQuery.event.remove's overhead + } else { + jQuery.removeEvent( elem, type, data.handle ); + } + } + } + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataPriv.expando ] = undefined; + } + if ( elem[ dataUser.expando ] ) { + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataUser.expando ] = undefined; + } + } + } + } +} ); + +jQuery.fn.extend( { + detach: function( selector ) { + return remove( this, selector, true ); + }, + + remove: function( selector ) { + return remove( this, selector ); + }, + + text: function( value ) { + return access( this, function( value ) { + return value === undefined ? + jQuery.text( this ) : + this.empty().each( function() { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + this.textContent = value; + } + } ); + }, null, value, arguments.length ); + }, + + append: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.appendChild( elem ); + } + } ); + }, + + prepend: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.insertBefore( elem, target.firstChild ); + } + } ); + }, + + before: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this ); + } + } ); + }, + + after: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this.nextSibling ); + } + } ); + }, + + empty: function() { + var elem, + i = 0; + + for ( ; ( elem = this[ i ] ) != null; i++ ) { + if ( elem.nodeType === 1 ) { + + // Prevent memory leaks + jQuery.cleanData( getAll( elem, false ) ); + + // Remove any remaining nodes + elem.textContent = ""; + } + } + + return this; + }, + + clone: function( dataAndEvents, deepDataAndEvents ) { + dataAndEvents = dataAndEvents == null ? false : dataAndEvents; + deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents; + + return this.map( function() { + return jQuery.clone( this, dataAndEvents, deepDataAndEvents ); + } ); + }, + + html: function( value ) { + return access( this, function( value ) { + var elem = this[ 0 ] || {}, + i = 0, + l = this.length; + + if ( value === undefined && elem.nodeType === 1 ) { + return elem.innerHTML; + } + + // See if we can take a shortcut and just use innerHTML + if ( typeof value === "string" && !rnoInnerhtml.test( value ) && + !wrapMap[ ( rtagName.exec( value ) || [ "", "" ] )[ 1 ].toLowerCase() ] ) { + + value = jQuery.htmlPrefilter( value ); + + try { + for ( ; i < l; i++ ) { + elem = this[ i ] || {}; + + // Remove element nodes and prevent memory leaks + if ( elem.nodeType === 1 ) { + jQuery.cleanData( getAll( elem, false ) ); + elem.innerHTML = value; + } + } + + elem = 0; + + // If using innerHTML throws an exception, use the fallback method + } catch ( e ) {} + } + + if ( elem ) { + this.empty().append( value ); + } + }, null, value, arguments.length ); + }, + + replaceWith: function() { + var ignored = []; + + // Make the changes, replacing each non-ignored context element with the new content + return domManip( this, arguments, function( elem ) { + var parent = this.parentNode; + + if ( jQuery.inArray( this, ignored ) < 0 ) { + jQuery.cleanData( getAll( this ) ); + if ( parent ) { + parent.replaceChild( elem, this ); + } + } + + // Force callback invocation + }, ignored ); + } +} ); + +jQuery.each( { + appendTo: "append", + prependTo: "prepend", + insertBefore: "before", + insertAfter: "after", + replaceAll: "replaceWith" +}, function( name, original ) { + jQuery.fn[ name ] = function( selector ) { + var elems, + ret = [], + insert = jQuery( selector ), + last = insert.length - 1, + i = 0; + + for ( ; i <= last; i++ ) { + elems = i === last ? this : this.clone( true ); + jQuery( insert[ i ] )[ original ]( elems ); + + // Support: Android <=4.0 only, PhantomJS 1 only + // .get() because push.apply(_, arraylike) throws on ancient WebKit + push.apply( ret, elems.get() ); + } + + return this.pushStack( ret ); + }; +} ); +var rnumnonpx = new RegExp( "^(" + pnum + ")(?!px)[a-z%]+$", "i" ); + +var getStyles = function( elem ) { + + // Support: IE <=11 only, Firefox <=30 (#15098, #14150) + // IE throws on elements created in popups + // FF meanwhile throws on frame elements through "defaultView.getComputedStyle" + var view = elem.ownerDocument.defaultView; + + if ( !view || !view.opener ) { + view = window; + } + + return view.getComputedStyle( elem ); + }; + +var swap = function( elem, options, callback ) { + var ret, name, + old = {}; + + // Remember the old values, and insert the new ones + for ( name in options ) { + old[ name ] = elem.style[ name ]; + elem.style[ name ] = options[ name ]; + } + + ret = callback.call( elem ); + + // Revert the old values + for ( name in options ) { + elem.style[ name ] = old[ name ]; + } + + return ret; +}; + + +var rboxStyle = new RegExp( cssExpand.join( "|" ), "i" ); + + + +( function() { + + // Executing both pixelPosition & boxSizingReliable tests require only one layout + // so they're executed at the same time to save the second computation. + function computeStyleTests() { + + // This is a singleton, we need to execute it only once + if ( !div ) { + return; + } + + container.style.cssText = "position:absolute;left:-11111px;width:60px;" + + "margin-top:1px;padding:0;border:0"; + div.style.cssText = + "position:relative;display:block;box-sizing:border-box;overflow:scroll;" + + "margin:auto;border:1px;padding:1px;" + + "width:60%;top:1%"; + documentElement.appendChild( container ).appendChild( div ); + + var divStyle = window.getComputedStyle( div ); + pixelPositionVal = divStyle.top !== "1%"; + + // Support: Android 4.0 - 4.3 only, Firefox <=3 - 44 + reliableMarginLeftVal = roundPixelMeasures( divStyle.marginLeft ) === 12; + + // Support: Android 4.0 - 4.3 only, Safari <=9.1 - 10.1, iOS <=7.0 - 9.3 + // Some styles come back with percentage values, even though they shouldn't + div.style.right = "60%"; + pixelBoxStylesVal = roundPixelMeasures( divStyle.right ) === 36; + + // Support: IE 9 - 11 only + // Detect misreporting of content dimensions for box-sizing:border-box elements + boxSizingReliableVal = roundPixelMeasures( divStyle.width ) === 36; + + // Support: IE 9 only + // Detect overflow:scroll screwiness (gh-3699) + // Support: Chrome <=64 + // Don't get tricked when zoom affects offsetWidth (gh-4029) + div.style.position = "absolute"; + scrollboxSizeVal = roundPixelMeasures( div.offsetWidth / 3 ) === 12; + + documentElement.removeChild( container ); + + // Nullify the div so it wouldn't be stored in the memory and + // it will also be a sign that checks already performed + div = null; + } + + function roundPixelMeasures( measure ) { + return Math.round( parseFloat( measure ) ); + } + + var pixelPositionVal, boxSizingReliableVal, scrollboxSizeVal, pixelBoxStylesVal, + reliableTrDimensionsVal, reliableMarginLeftVal, + container = document.createElement( "div" ), + div = document.createElement( "div" ); + + // Finish early in limited (non-browser) environments + if ( !div.style ) { + return; + } + + // Support: IE <=9 - 11 only + // Style of cloned element affects source element cloned (#8908) + div.style.backgroundClip = "content-box"; + div.cloneNode( true ).style.backgroundClip = ""; + support.clearCloneStyle = div.style.backgroundClip === "content-box"; + + jQuery.extend( support, { + boxSizingReliable: function() { + computeStyleTests(); + return boxSizingReliableVal; + }, + pixelBoxStyles: function() { + computeStyleTests(); + return pixelBoxStylesVal; + }, + pixelPosition: function() { + computeStyleTests(); + return pixelPositionVal; + }, + reliableMarginLeft: function() { + computeStyleTests(); + return reliableMarginLeftVal; + }, + scrollboxSize: function() { + computeStyleTests(); + return scrollboxSizeVal; + }, + + // Support: IE 9 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Behavior in IE 9 is more subtle than in newer versions & it passes + // some versions of this test; make sure not to make it pass there! + reliableTrDimensions: function() { + var table, tr, trChild, trStyle; + if ( reliableTrDimensionsVal == null ) { + table = document.createElement( "table" ); + tr = document.createElement( "tr" ); + trChild = document.createElement( "div" ); + + table.style.cssText = "position:absolute;left:-11111px"; + tr.style.height = "1px"; + trChild.style.height = "9px"; + + documentElement + .appendChild( table ) + .appendChild( tr ) + .appendChild( trChild ); + + trStyle = window.getComputedStyle( tr ); + reliableTrDimensionsVal = parseInt( trStyle.height ) > 3; + + documentElement.removeChild( table ); + } + return reliableTrDimensionsVal; + } + } ); +} )(); + + +function curCSS( elem, name, computed ) { + var width, minWidth, maxWidth, ret, + + // Support: Firefox 51+ + // Retrieving style before computed somehow + // fixes an issue with getting wrong values + // on detached elements + style = elem.style; + + computed = computed || getStyles( elem ); + + // getPropertyValue is needed for: + // .css('filter') (IE 9 only, #12537) + // .css('--customProperty) (#3144) + if ( computed ) { + ret = computed.getPropertyValue( name ) || computed[ name ]; + + if ( ret === "" && !isAttached( elem ) ) { + ret = jQuery.style( elem, name ); + } + + // A tribute to the "awesome hack by Dean Edwards" + // Android Browser returns percentage for some values, + // but width seems to be reliably pixels. + // This is against the CSSOM draft spec: + // https://drafts.csswg.org/cssom/#resolved-values + if ( !support.pixelBoxStyles() && rnumnonpx.test( ret ) && rboxStyle.test( name ) ) { + + // Remember the original values + width = style.width; + minWidth = style.minWidth; + maxWidth = style.maxWidth; + + // Put in the new values to get a computed value out + style.minWidth = style.maxWidth = style.width = ret; + ret = computed.width; + + // Revert the changed values + style.width = width; + style.minWidth = minWidth; + style.maxWidth = maxWidth; + } + } + + return ret !== undefined ? + + // Support: IE <=9 - 11 only + // IE returns zIndex value as an integer. + ret + "" : + ret; +} + + +function addGetHookIf( conditionFn, hookFn ) { + + // Define the hook, we'll check on the first run if it's really needed. + return { + get: function() { + if ( conditionFn() ) { + + // Hook not needed (or it's not possible to use it due + // to missing dependency), remove it. + delete this.get; + return; + } + + // Hook needed; redefine it so that the support test is not executed again. + return ( this.get = hookFn ).apply( this, arguments ); + } + }; +} + + +var cssPrefixes = [ "Webkit", "Moz", "ms" ], + emptyStyle = document.createElement( "div" ).style, + vendorProps = {}; + +// Return a vendor-prefixed property or undefined +function vendorPropName( name ) { + + // Check for vendor prefixed names + var capName = name[ 0 ].toUpperCase() + name.slice( 1 ), + i = cssPrefixes.length; + + while ( i-- ) { + name = cssPrefixes[ i ] + capName; + if ( name in emptyStyle ) { + return name; + } + } +} + +// Return a potentially-mapped jQuery.cssProps or vendor prefixed property +function finalPropName( name ) { + var final = jQuery.cssProps[ name ] || vendorProps[ name ]; + + if ( final ) { + return final; + } + if ( name in emptyStyle ) { + return name; + } + return vendorProps[ name ] = vendorPropName( name ) || name; +} + + +var + + // Swappable if display is none or starts with table + // except "table", "table-cell", or "table-caption" + // See here for display values: https://developer.mozilla.org/en-US/docs/CSS/display + rdisplayswap = /^(none|table(?!-c[ea]).+)/, + rcustomProp = /^--/, + cssShow = { position: "absolute", visibility: "hidden", display: "block" }, + cssNormalTransform = { + letterSpacing: "0", + fontWeight: "400" + }; + +function setPositiveNumber( _elem, value, subtract ) { + + // Any relative (+/-) values have already been + // normalized at this point + var matches = rcssNum.exec( value ); + return matches ? + + // Guard against undefined "subtract", e.g., when used as in cssHooks + Math.max( 0, matches[ 2 ] - ( subtract || 0 ) ) + ( matches[ 3 ] || "px" ) : + value; +} + +function boxModelAdjustment( elem, dimension, box, isBorderBox, styles, computedVal ) { + var i = dimension === "width" ? 1 : 0, + extra = 0, + delta = 0; + + // Adjustment may not be necessary + if ( box === ( isBorderBox ? "border" : "content" ) ) { + return 0; + } + + for ( ; i < 4; i += 2 ) { + + // Both box models exclude margin + if ( box === "margin" ) { + delta += jQuery.css( elem, box + cssExpand[ i ], true, styles ); + } + + // If we get here with a content-box, we're seeking "padding" or "border" or "margin" + if ( !isBorderBox ) { + + // Add padding + delta += jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + + // For "border" or "margin", add border + if ( box !== "padding" ) { + delta += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + + // But still keep track of it otherwise + } else { + extra += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + + // If we get here with a border-box (content + padding + border), we're seeking "content" or + // "padding" or "margin" + } else { + + // For "content", subtract padding + if ( box === "content" ) { + delta -= jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + } + + // For "content" or "padding", subtract border + if ( box !== "margin" ) { + delta -= jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + } + } + + // Account for positive content-box scroll gutter when requested by providing computedVal + if ( !isBorderBox && computedVal >= 0 ) { + + // offsetWidth/offsetHeight is a rounded sum of content, padding, scroll gutter, and border + // Assuming integer scroll gutter, subtract the rest and round down + delta += Math.max( 0, Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + computedVal - + delta - + extra - + 0.5 + + // If offsetWidth/offsetHeight is unknown, then we can't determine content-box scroll gutter + // Use an explicit zero to avoid NaN (gh-3964) + ) ) || 0; + } + + return delta; +} + +function getWidthOrHeight( elem, dimension, extra ) { + + // Start with computed style + var styles = getStyles( elem ), + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-4322). + // Fake content-box until we know it's needed to know the true value. + boxSizingNeeded = !support.boxSizingReliable() || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + valueIsBorderBox = isBorderBox, + + val = curCSS( elem, dimension, styles ), + offsetProp = "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ); + + // Support: Firefox <=54 + // Return a confounding non-pixel value or feign ignorance, as appropriate. + if ( rnumnonpx.test( val ) ) { + if ( !extra ) { + return val; + } + val = "auto"; + } + + + // Support: IE 9 - 11 only + // Use offsetWidth/offsetHeight for when box sizing is unreliable. + // In those cases, the computed value can be trusted to be border-box. + if ( ( !support.boxSizingReliable() && isBorderBox || + + // Support: IE 10 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Interestingly, in some cases IE 9 doesn't suffer from this issue. + !support.reliableTrDimensions() && nodeName( elem, "tr" ) || + + // Fall back to offsetWidth/offsetHeight when value is "auto" + // This happens for inline elements with no explicit setting (gh-3571) + val === "auto" || + + // Support: Android <=4.1 - 4.3 only + // Also use offsetWidth/offsetHeight for misreported inline dimensions (gh-3602) + !parseFloat( val ) && jQuery.css( elem, "display", false, styles ) === "inline" ) && + + // Make sure the element is visible & connected + elem.getClientRects().length ) { + + isBorderBox = jQuery.css( elem, "boxSizing", false, styles ) === "border-box"; + + // Where available, offsetWidth/offsetHeight approximate border box dimensions. + // Where not available (e.g., SVG), assume unreliable box-sizing and interpret the + // retrieved value as a content box dimension. + valueIsBorderBox = offsetProp in elem; + if ( valueIsBorderBox ) { + val = elem[ offsetProp ]; + } + } + + // Normalize "" and auto + val = parseFloat( val ) || 0; + + // Adjust for the element's box model + return ( val + + boxModelAdjustment( + elem, + dimension, + extra || ( isBorderBox ? "border" : "content" ), + valueIsBorderBox, + styles, + + // Provide the current computed size to request scroll gutter calculation (gh-3589) + val + ) + ) + "px"; +} + +jQuery.extend( { + + // Add in style property hooks for overriding the default + // behavior of getting and setting a style property + cssHooks: { + opacity: { + get: function( elem, computed ) { + if ( computed ) { + + // We should always get a number back from opacity + var ret = curCSS( elem, "opacity" ); + return ret === "" ? "1" : ret; + } + } + } + }, + + // Don't automatically add "px" to these possibly-unitless properties + cssNumber: { + "animationIterationCount": true, + "columnCount": true, + "fillOpacity": true, + "flexGrow": true, + "flexShrink": true, + "fontWeight": true, + "gridArea": true, + "gridColumn": true, + "gridColumnEnd": true, + "gridColumnStart": true, + "gridRow": true, + "gridRowEnd": true, + "gridRowStart": true, + "lineHeight": true, + "opacity": true, + "order": true, + "orphans": true, + "widows": true, + "zIndex": true, + "zoom": true + }, + + // Add in properties whose names you wish to fix before + // setting or getting the value + cssProps: {}, + + // Get and set the style property on a DOM Node + style: function( elem, name, value, extra ) { + + // Don't set styles on text and comment nodes + if ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) { + return; + } + + // Make sure that we're working with the right name + var ret, type, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ), + style = elem.style; + + // Make sure that we're working with the right name. We don't + // want to query the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Gets hook for the prefixed version, then unprefixed version + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // Check if we're setting a value + if ( value !== undefined ) { + type = typeof value; + + // Convert "+=" or "-=" to relative numbers (#7345) + if ( type === "string" && ( ret = rcssNum.exec( value ) ) && ret[ 1 ] ) { + value = adjustCSS( elem, name, ret ); + + // Fixes bug #9237 + type = "number"; + } + + // Make sure that null and NaN values aren't set (#7116) + if ( value == null || value !== value ) { + return; + } + + // If a number was passed in, add the unit (except for certain CSS properties) + // The isCustomProp check can be removed in jQuery 4.0 when we only auto-append + // "px" to a few hardcoded values. + if ( type === "number" && !isCustomProp ) { + value += ret && ret[ 3 ] || ( jQuery.cssNumber[ origName ] ? "" : "px" ); + } + + // background-* props affect original clone's values + if ( !support.clearCloneStyle && value === "" && name.indexOf( "background" ) === 0 ) { + style[ name ] = "inherit"; + } + + // If a hook was provided, use that value, otherwise just set the specified value + if ( !hooks || !( "set" in hooks ) || + ( value = hooks.set( elem, value, extra ) ) !== undefined ) { + + if ( isCustomProp ) { + style.setProperty( name, value ); + } else { + style[ name ] = value; + } + } + + } else { + + // If a hook was provided get the non-computed value from there + if ( hooks && "get" in hooks && + ( ret = hooks.get( elem, false, extra ) ) !== undefined ) { + + return ret; + } + + // Otherwise just get the value from the style object + return style[ name ]; + } + }, + + css: function( elem, name, extra, styles ) { + var val, num, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ); + + // Make sure that we're working with the right name. We don't + // want to modify the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Try prefixed name followed by the unprefixed name + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // If a hook was provided get the computed value from there + if ( hooks && "get" in hooks ) { + val = hooks.get( elem, true, extra ); + } + + // Otherwise, if a way to get the computed value exists, use that + if ( val === undefined ) { + val = curCSS( elem, name, styles ); + } + + // Convert "normal" to computed value + if ( val === "normal" && name in cssNormalTransform ) { + val = cssNormalTransform[ name ]; + } + + // Make numeric if forced or a qualifier was provided and val looks numeric + if ( extra === "" || extra ) { + num = parseFloat( val ); + return extra === true || isFinite( num ) ? num || 0 : val; + } + + return val; + } +} ); + +jQuery.each( [ "height", "width" ], function( _i, dimension ) { + jQuery.cssHooks[ dimension ] = { + get: function( elem, computed, extra ) { + if ( computed ) { + + // Certain elements can have dimension info if we invisibly show them + // but it must have a current display style that would benefit + return rdisplayswap.test( jQuery.css( elem, "display" ) ) && + + // Support: Safari 8+ + // Table columns in Safari have non-zero offsetWidth & zero + // getBoundingClientRect().width unless display is changed. + // Support: IE <=11 only + // Running getBoundingClientRect on a disconnected node + // in IE throws an error. + ( !elem.getClientRects().length || !elem.getBoundingClientRect().width ) ? + swap( elem, cssShow, function() { + return getWidthOrHeight( elem, dimension, extra ); + } ) : + getWidthOrHeight( elem, dimension, extra ); + } + }, + + set: function( elem, value, extra ) { + var matches, + styles = getStyles( elem ), + + // Only read styles.position if the test has a chance to fail + // to avoid forcing a reflow. + scrollboxSizeBuggy = !support.scrollboxSize() && + styles.position === "absolute", + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-3991) + boxSizingNeeded = scrollboxSizeBuggy || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + subtract = extra ? + boxModelAdjustment( + elem, + dimension, + extra, + isBorderBox, + styles + ) : + 0; + + // Account for unreliable border-box dimensions by comparing offset* to computed and + // faking a content-box to get border and padding (gh-3699) + if ( isBorderBox && scrollboxSizeBuggy ) { + subtract -= Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + parseFloat( styles[ dimension ] ) - + boxModelAdjustment( elem, dimension, "border", false, styles ) - + 0.5 + ); + } + + // Convert to pixels if value adjustment is needed + if ( subtract && ( matches = rcssNum.exec( value ) ) && + ( matches[ 3 ] || "px" ) !== "px" ) { + + elem.style[ dimension ] = value; + value = jQuery.css( elem, dimension ); + } + + return setPositiveNumber( elem, value, subtract ); + } + }; +} ); + +jQuery.cssHooks.marginLeft = addGetHookIf( support.reliableMarginLeft, + function( elem, computed ) { + if ( computed ) { + return ( parseFloat( curCSS( elem, "marginLeft" ) ) || + elem.getBoundingClientRect().left - + swap( elem, { marginLeft: 0 }, function() { + return elem.getBoundingClientRect().left; + } ) + ) + "px"; + } + } +); + +// These hooks are used by animate to expand properties +jQuery.each( { + margin: "", + padding: "", + border: "Width" +}, function( prefix, suffix ) { + jQuery.cssHooks[ prefix + suffix ] = { + expand: function( value ) { + var i = 0, + expanded = {}, + + // Assumes a single number if not a string + parts = typeof value === "string" ? value.split( " " ) : [ value ]; + + for ( ; i < 4; i++ ) { + expanded[ prefix + cssExpand[ i ] + suffix ] = + parts[ i ] || parts[ i - 2 ] || parts[ 0 ]; + } + + return expanded; + } + }; + + if ( prefix !== "margin" ) { + jQuery.cssHooks[ prefix + suffix ].set = setPositiveNumber; + } +} ); + +jQuery.fn.extend( { + css: function( name, value ) { + return access( this, function( elem, name, value ) { + var styles, len, + map = {}, + i = 0; + + if ( Array.isArray( name ) ) { + styles = getStyles( elem ); + len = name.length; + + for ( ; i < len; i++ ) { + map[ name[ i ] ] = jQuery.css( elem, name[ i ], false, styles ); + } + + return map; + } + + return value !== undefined ? + jQuery.style( elem, name, value ) : + jQuery.css( elem, name ); + }, name, value, arguments.length > 1 ); + } +} ); + + +function Tween( elem, options, prop, end, easing ) { + return new Tween.prototype.init( elem, options, prop, end, easing ); +} +jQuery.Tween = Tween; + +Tween.prototype = { + constructor: Tween, + init: function( elem, options, prop, end, easing, unit ) { + this.elem = elem; + this.prop = prop; + this.easing = easing || jQuery.easing._default; + this.options = options; + this.start = this.now = this.cur(); + this.end = end; + this.unit = unit || ( jQuery.cssNumber[ prop ] ? "" : "px" ); + }, + cur: function() { + var hooks = Tween.propHooks[ this.prop ]; + + return hooks && hooks.get ? + hooks.get( this ) : + Tween.propHooks._default.get( this ); + }, + run: function( percent ) { + var eased, + hooks = Tween.propHooks[ this.prop ]; + + if ( this.options.duration ) { + this.pos = eased = jQuery.easing[ this.easing ]( + percent, this.options.duration * percent, 0, 1, this.options.duration + ); + } else { + this.pos = eased = percent; + } + this.now = ( this.end - this.start ) * eased + this.start; + + if ( this.options.step ) { + this.options.step.call( this.elem, this.now, this ); + } + + if ( hooks && hooks.set ) { + hooks.set( this ); + } else { + Tween.propHooks._default.set( this ); + } + return this; + } +}; + +Tween.prototype.init.prototype = Tween.prototype; + +Tween.propHooks = { + _default: { + get: function( tween ) { + var result; + + // Use a property on the element directly when it is not a DOM element, + // or when there is no matching style property that exists. + if ( tween.elem.nodeType !== 1 || + tween.elem[ tween.prop ] != null && tween.elem.style[ tween.prop ] == null ) { + return tween.elem[ tween.prop ]; + } + + // Passing an empty string as a 3rd parameter to .css will automatically + // attempt a parseFloat and fallback to a string if the parse fails. + // Simple values such as "10px" are parsed to Float; + // complex values such as "rotate(1rad)" are returned as-is. + result = jQuery.css( tween.elem, tween.prop, "" ); + + // Empty strings, null, undefined and "auto" are converted to 0. + return !result || result === "auto" ? 0 : result; + }, + set: function( tween ) { + + // Use step hook for back compat. + // Use cssHook if its there. + // Use .style if available and use plain properties where available. + if ( jQuery.fx.step[ tween.prop ] ) { + jQuery.fx.step[ tween.prop ]( tween ); + } else if ( tween.elem.nodeType === 1 && ( + jQuery.cssHooks[ tween.prop ] || + tween.elem.style[ finalPropName( tween.prop ) ] != null ) ) { + jQuery.style( tween.elem, tween.prop, tween.now + tween.unit ); + } else { + tween.elem[ tween.prop ] = tween.now; + } + } + } +}; + +// Support: IE <=9 only +// Panic based approach to setting things on disconnected nodes +Tween.propHooks.scrollTop = Tween.propHooks.scrollLeft = { + set: function( tween ) { + if ( tween.elem.nodeType && tween.elem.parentNode ) { + tween.elem[ tween.prop ] = tween.now; + } + } +}; + +jQuery.easing = { + linear: function( p ) { + return p; + }, + swing: function( p ) { + return 0.5 - Math.cos( p * Math.PI ) / 2; + }, + _default: "swing" +}; + +jQuery.fx = Tween.prototype.init; + +// Back compat <1.8 extension point +jQuery.fx.step = {}; + + + + +var + fxNow, inProgress, + rfxtypes = /^(?:toggle|show|hide)$/, + rrun = /queueHooks$/; + +function schedule() { + if ( inProgress ) { + if ( document.hidden === false && window.requestAnimationFrame ) { + window.requestAnimationFrame( schedule ); + } else { + window.setTimeout( schedule, jQuery.fx.interval ); + } + + jQuery.fx.tick(); + } +} + +// Animations created synchronously will run synchronously +function createFxNow() { + window.setTimeout( function() { + fxNow = undefined; + } ); + return ( fxNow = Date.now() ); +} + +// Generate parameters to create a standard animation +function genFx( type, includeWidth ) { + var which, + i = 0, + attrs = { height: type }; + + // If we include width, step value is 1 to do all cssExpand values, + // otherwise step value is 2 to skip over Left and Right + includeWidth = includeWidth ? 1 : 0; + for ( ; i < 4; i += 2 - includeWidth ) { + which = cssExpand[ i ]; + attrs[ "margin" + which ] = attrs[ "padding" + which ] = type; + } + + if ( includeWidth ) { + attrs.opacity = attrs.width = type; + } + + return attrs; +} + +function createTween( value, prop, animation ) { + var tween, + collection = ( Animation.tweeners[ prop ] || [] ).concat( Animation.tweeners[ "*" ] ), + index = 0, + length = collection.length; + for ( ; index < length; index++ ) { + if ( ( tween = collection[ index ].call( animation, prop, value ) ) ) { + + // We're done with this property + return tween; + } + } +} + +function defaultPrefilter( elem, props, opts ) { + var prop, value, toggle, hooks, oldfire, propTween, restoreDisplay, display, + isBox = "width" in props || "height" in props, + anim = this, + orig = {}, + style = elem.style, + hidden = elem.nodeType && isHiddenWithinTree( elem ), + dataShow = dataPriv.get( elem, "fxshow" ); + + // Queue-skipping animations hijack the fx hooks + if ( !opts.queue ) { + hooks = jQuery._queueHooks( elem, "fx" ); + if ( hooks.unqueued == null ) { + hooks.unqueued = 0; + oldfire = hooks.empty.fire; + hooks.empty.fire = function() { + if ( !hooks.unqueued ) { + oldfire(); + } + }; + } + hooks.unqueued++; + + anim.always( function() { + + // Ensure the complete handler is called before this completes + anim.always( function() { + hooks.unqueued--; + if ( !jQuery.queue( elem, "fx" ).length ) { + hooks.empty.fire(); + } + } ); + } ); + } + + // Detect show/hide animations + for ( prop in props ) { + value = props[ prop ]; + if ( rfxtypes.test( value ) ) { + delete props[ prop ]; + toggle = toggle || value === "toggle"; + if ( value === ( hidden ? "hide" : "show" ) ) { + + // Pretend to be hidden if this is a "show" and + // there is still data from a stopped show/hide + if ( value === "show" && dataShow && dataShow[ prop ] !== undefined ) { + hidden = true; + + // Ignore all other no-op show/hide data + } else { + continue; + } + } + orig[ prop ] = dataShow && dataShow[ prop ] || jQuery.style( elem, prop ); + } + } + + // Bail out if this is a no-op like .hide().hide() + propTween = !jQuery.isEmptyObject( props ); + if ( !propTween && jQuery.isEmptyObject( orig ) ) { + return; + } + + // Restrict "overflow" and "display" styles during box animations + if ( isBox && elem.nodeType === 1 ) { + + // Support: IE <=9 - 11, Edge 12 - 15 + // Record all 3 overflow attributes because IE does not infer the shorthand + // from identically-valued overflowX and overflowY and Edge just mirrors + // the overflowX value there. + opts.overflow = [ style.overflow, style.overflowX, style.overflowY ]; + + // Identify a display type, preferring old show/hide data over the CSS cascade + restoreDisplay = dataShow && dataShow.display; + if ( restoreDisplay == null ) { + restoreDisplay = dataPriv.get( elem, "display" ); + } + display = jQuery.css( elem, "display" ); + if ( display === "none" ) { + if ( restoreDisplay ) { + display = restoreDisplay; + } else { + + // Get nonempty value(s) by temporarily forcing visibility + showHide( [ elem ], true ); + restoreDisplay = elem.style.display || restoreDisplay; + display = jQuery.css( elem, "display" ); + showHide( [ elem ] ); + } + } + + // Animate inline elements as inline-block + if ( display === "inline" || display === "inline-block" && restoreDisplay != null ) { + if ( jQuery.css( elem, "float" ) === "none" ) { + + // Restore the original display value at the end of pure show/hide animations + if ( !propTween ) { + anim.done( function() { + style.display = restoreDisplay; + } ); + if ( restoreDisplay == null ) { + display = style.display; + restoreDisplay = display === "none" ? "" : display; + } + } + style.display = "inline-block"; + } + } + } + + if ( opts.overflow ) { + style.overflow = "hidden"; + anim.always( function() { + style.overflow = opts.overflow[ 0 ]; + style.overflowX = opts.overflow[ 1 ]; + style.overflowY = opts.overflow[ 2 ]; + } ); + } + + // Implement show/hide animations + propTween = false; + for ( prop in orig ) { + + // General show/hide setup for this element animation + if ( !propTween ) { + if ( dataShow ) { + if ( "hidden" in dataShow ) { + hidden = dataShow.hidden; + } + } else { + dataShow = dataPriv.access( elem, "fxshow", { display: restoreDisplay } ); + } + + // Store hidden/visible for toggle so `.stop().toggle()` "reverses" + if ( toggle ) { + dataShow.hidden = !hidden; + } + + // Show elements before animating them + if ( hidden ) { + showHide( [ elem ], true ); + } + + /* eslint-disable no-loop-func */ + + anim.done( function() { + + /* eslint-enable no-loop-func */ + + // The final step of a "hide" animation is actually hiding the element + if ( !hidden ) { + showHide( [ elem ] ); + } + dataPriv.remove( elem, "fxshow" ); + for ( prop in orig ) { + jQuery.style( elem, prop, orig[ prop ] ); + } + } ); + } + + // Per-property setup + propTween = createTween( hidden ? dataShow[ prop ] : 0, prop, anim ); + if ( !( prop in dataShow ) ) { + dataShow[ prop ] = propTween.start; + if ( hidden ) { + propTween.end = propTween.start; + propTween.start = 0; + } + } + } +} + +function propFilter( props, specialEasing ) { + var index, name, easing, value, hooks; + + // camelCase, specialEasing and expand cssHook pass + for ( index in props ) { + name = camelCase( index ); + easing = specialEasing[ name ]; + value = props[ index ]; + if ( Array.isArray( value ) ) { + easing = value[ 1 ]; + value = props[ index ] = value[ 0 ]; + } + + if ( index !== name ) { + props[ name ] = value; + delete props[ index ]; + } + + hooks = jQuery.cssHooks[ name ]; + if ( hooks && "expand" in hooks ) { + value = hooks.expand( value ); + delete props[ name ]; + + // Not quite $.extend, this won't overwrite existing keys. + // Reusing 'index' because we have the correct "name" + for ( index in value ) { + if ( !( index in props ) ) { + props[ index ] = value[ index ]; + specialEasing[ index ] = easing; + } + } + } else { + specialEasing[ name ] = easing; + } + } +} + +function Animation( elem, properties, options ) { + var result, + stopped, + index = 0, + length = Animation.prefilters.length, + deferred = jQuery.Deferred().always( function() { + + // Don't match elem in the :animated selector + delete tick.elem; + } ), + tick = function() { + if ( stopped ) { + return false; + } + var currentTime = fxNow || createFxNow(), + remaining = Math.max( 0, animation.startTime + animation.duration - currentTime ), + + // Support: Android 2.3 only + // Archaic crash bug won't allow us to use `1 - ( 0.5 || 0 )` (#12497) + temp = remaining / animation.duration || 0, + percent = 1 - temp, + index = 0, + length = animation.tweens.length; + + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( percent ); + } + + deferred.notifyWith( elem, [ animation, percent, remaining ] ); + + // If there's more to do, yield + if ( percent < 1 && length ) { + return remaining; + } + + // If this was an empty animation, synthesize a final progress notification + if ( !length ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + } + + // Resolve the animation and report its conclusion + deferred.resolveWith( elem, [ animation ] ); + return false; + }, + animation = deferred.promise( { + elem: elem, + props: jQuery.extend( {}, properties ), + opts: jQuery.extend( true, { + specialEasing: {}, + easing: jQuery.easing._default + }, options ), + originalProperties: properties, + originalOptions: options, + startTime: fxNow || createFxNow(), + duration: options.duration, + tweens: [], + createTween: function( prop, end ) { + var tween = jQuery.Tween( elem, animation.opts, prop, end, + animation.opts.specialEasing[ prop ] || animation.opts.easing ); + animation.tweens.push( tween ); + return tween; + }, + stop: function( gotoEnd ) { + var index = 0, + + // If we are going to the end, we want to run all the tweens + // otherwise we skip this part + length = gotoEnd ? animation.tweens.length : 0; + if ( stopped ) { + return this; + } + stopped = true; + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( 1 ); + } + + // Resolve when we played the last frame; otherwise, reject + if ( gotoEnd ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + deferred.resolveWith( elem, [ animation, gotoEnd ] ); + } else { + deferred.rejectWith( elem, [ animation, gotoEnd ] ); + } + return this; + } + } ), + props = animation.props; + + propFilter( props, animation.opts.specialEasing ); + + for ( ; index < length; index++ ) { + result = Animation.prefilters[ index ].call( animation, elem, props, animation.opts ); + if ( result ) { + if ( isFunction( result.stop ) ) { + jQuery._queueHooks( animation.elem, animation.opts.queue ).stop = + result.stop.bind( result ); + } + return result; + } + } + + jQuery.map( props, createTween, animation ); + + if ( isFunction( animation.opts.start ) ) { + animation.opts.start.call( elem, animation ); + } + + // Attach callbacks from options + animation + .progress( animation.opts.progress ) + .done( animation.opts.done, animation.opts.complete ) + .fail( animation.opts.fail ) + .always( animation.opts.always ); + + jQuery.fx.timer( + jQuery.extend( tick, { + elem: elem, + anim: animation, + queue: animation.opts.queue + } ) + ); + + return animation; +} + +jQuery.Animation = jQuery.extend( Animation, { + + tweeners: { + "*": [ function( prop, value ) { + var tween = this.createTween( prop, value ); + adjustCSS( tween.elem, prop, rcssNum.exec( value ), tween ); + return tween; + } ] + }, + + tweener: function( props, callback ) { + if ( isFunction( props ) ) { + callback = props; + props = [ "*" ]; + } else { + props = props.match( rnothtmlwhite ); + } + + var prop, + index = 0, + length = props.length; + + for ( ; index < length; index++ ) { + prop = props[ index ]; + Animation.tweeners[ prop ] = Animation.tweeners[ prop ] || []; + Animation.tweeners[ prop ].unshift( callback ); + } + }, + + prefilters: [ defaultPrefilter ], + + prefilter: function( callback, prepend ) { + if ( prepend ) { + Animation.prefilters.unshift( callback ); + } else { + Animation.prefilters.push( callback ); + } + } +} ); + +jQuery.speed = function( speed, easing, fn ) { + var opt = speed && typeof speed === "object" ? jQuery.extend( {}, speed ) : { + complete: fn || !fn && easing || + isFunction( speed ) && speed, + duration: speed, + easing: fn && easing || easing && !isFunction( easing ) && easing + }; + + // Go to the end state if fx are off + if ( jQuery.fx.off ) { + opt.duration = 0; + + } else { + if ( typeof opt.duration !== "number" ) { + if ( opt.duration in jQuery.fx.speeds ) { + opt.duration = jQuery.fx.speeds[ opt.duration ]; + + } else { + opt.duration = jQuery.fx.speeds._default; + } + } + } + + // Normalize opt.queue - true/undefined/null -> "fx" + if ( opt.queue == null || opt.queue === true ) { + opt.queue = "fx"; + } + + // Queueing + opt.old = opt.complete; + + opt.complete = function() { + if ( isFunction( opt.old ) ) { + opt.old.call( this ); + } + + if ( opt.queue ) { + jQuery.dequeue( this, opt.queue ); + } + }; + + return opt; +}; + +jQuery.fn.extend( { + fadeTo: function( speed, to, easing, callback ) { + + // Show any hidden elements after setting opacity to 0 + return this.filter( isHiddenWithinTree ).css( "opacity", 0 ).show() + + // Animate to the value specified + .end().animate( { opacity: to }, speed, easing, callback ); + }, + animate: function( prop, speed, easing, callback ) { + var empty = jQuery.isEmptyObject( prop ), + optall = jQuery.speed( speed, easing, callback ), + doAnimation = function() { + + // Operate on a copy of prop so per-property easing won't be lost + var anim = Animation( this, jQuery.extend( {}, prop ), optall ); + + // Empty animations, or finishing resolves immediately + if ( empty || dataPriv.get( this, "finish" ) ) { + anim.stop( true ); + } + }; + doAnimation.finish = doAnimation; + + return empty || optall.queue === false ? + this.each( doAnimation ) : + this.queue( optall.queue, doAnimation ); + }, + stop: function( type, clearQueue, gotoEnd ) { + var stopQueue = function( hooks ) { + var stop = hooks.stop; + delete hooks.stop; + stop( gotoEnd ); + }; + + if ( typeof type !== "string" ) { + gotoEnd = clearQueue; + clearQueue = type; + type = undefined; + } + if ( clearQueue ) { + this.queue( type || "fx", [] ); + } + + return this.each( function() { + var dequeue = true, + index = type != null && type + "queueHooks", + timers = jQuery.timers, + data = dataPriv.get( this ); + + if ( index ) { + if ( data[ index ] && data[ index ].stop ) { + stopQueue( data[ index ] ); + } + } else { + for ( index in data ) { + if ( data[ index ] && data[ index ].stop && rrun.test( index ) ) { + stopQueue( data[ index ] ); + } + } + } + + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && + ( type == null || timers[ index ].queue === type ) ) { + + timers[ index ].anim.stop( gotoEnd ); + dequeue = false; + timers.splice( index, 1 ); + } + } + + // Start the next in the queue if the last step wasn't forced. + // Timers currently will call their complete callbacks, which + // will dequeue but only if they were gotoEnd. + if ( dequeue || !gotoEnd ) { + jQuery.dequeue( this, type ); + } + } ); + }, + finish: function( type ) { + if ( type !== false ) { + type = type || "fx"; + } + return this.each( function() { + var index, + data = dataPriv.get( this ), + queue = data[ type + "queue" ], + hooks = data[ type + "queueHooks" ], + timers = jQuery.timers, + length = queue ? queue.length : 0; + + // Enable finishing flag on private data + data.finish = true; + + // Empty the queue first + jQuery.queue( this, type, [] ); + + if ( hooks && hooks.stop ) { + hooks.stop.call( this, true ); + } + + // Look for any active animations, and finish them + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && timers[ index ].queue === type ) { + timers[ index ].anim.stop( true ); + timers.splice( index, 1 ); + } + } + + // Look for any animations in the old queue and finish them + for ( index = 0; index < length; index++ ) { + if ( queue[ index ] && queue[ index ].finish ) { + queue[ index ].finish.call( this ); + } + } + + // Turn off finishing flag + delete data.finish; + } ); + } +} ); + +jQuery.each( [ "toggle", "show", "hide" ], function( _i, name ) { + var cssFn = jQuery.fn[ name ]; + jQuery.fn[ name ] = function( speed, easing, callback ) { + return speed == null || typeof speed === "boolean" ? + cssFn.apply( this, arguments ) : + this.animate( genFx( name, true ), speed, easing, callback ); + }; +} ); + +// Generate shortcuts for custom animations +jQuery.each( { + slideDown: genFx( "show" ), + slideUp: genFx( "hide" ), + slideToggle: genFx( "toggle" ), + fadeIn: { opacity: "show" }, + fadeOut: { opacity: "hide" }, + fadeToggle: { opacity: "toggle" } +}, function( name, props ) { + jQuery.fn[ name ] = function( speed, easing, callback ) { + return this.animate( props, speed, easing, callback ); + }; +} ); + +jQuery.timers = []; +jQuery.fx.tick = function() { + var timer, + i = 0, + timers = jQuery.timers; + + fxNow = Date.now(); + + for ( ; i < timers.length; i++ ) { + timer = timers[ i ]; + + // Run the timer and safely remove it when done (allowing for external removal) + if ( !timer() && timers[ i ] === timer ) { + timers.splice( i--, 1 ); + } + } + + if ( !timers.length ) { + jQuery.fx.stop(); + } + fxNow = undefined; +}; + +jQuery.fx.timer = function( timer ) { + jQuery.timers.push( timer ); + jQuery.fx.start(); +}; + +jQuery.fx.interval = 13; +jQuery.fx.start = function() { + if ( inProgress ) { + return; + } + + inProgress = true; + schedule(); +}; + +jQuery.fx.stop = function() { + inProgress = null; +}; + +jQuery.fx.speeds = { + slow: 600, + fast: 200, + + // Default speed + _default: 400 +}; + + +// Based off of the plugin by Clint Helfers, with permission. +// https://web.archive.org/web/20100324014747/http://blindsignals.com/index.php/2009/07/jquery-delay/ +jQuery.fn.delay = function( time, type ) { + time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time; + type = type || "fx"; + + return this.queue( type, function( next, hooks ) { + var timeout = window.setTimeout( next, time ); + hooks.stop = function() { + window.clearTimeout( timeout ); + }; + } ); +}; + + +( function() { + var input = document.createElement( "input" ), + select = document.createElement( "select" ), + opt = select.appendChild( document.createElement( "option" ) ); + + input.type = "checkbox"; + + // Support: Android <=4.3 only + // Default value for a checkbox should be "on" + support.checkOn = input.value !== ""; + + // Support: IE <=11 only + // Must access selectedIndex to make default options select + support.optSelected = opt.selected; + + // Support: IE <=11 only + // An input loses its value after becoming a radio + input = document.createElement( "input" ); + input.value = "t"; + input.type = "radio"; + support.radioValue = input.value === "t"; +} )(); + + +var boolHook, + attrHandle = jQuery.expr.attrHandle; + +jQuery.fn.extend( { + attr: function( name, value ) { + return access( this, jQuery.attr, name, value, arguments.length > 1 ); + }, + + removeAttr: function( name ) { + return this.each( function() { + jQuery.removeAttr( this, name ); + } ); + } +} ); + +jQuery.extend( { + attr: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set attributes on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + // Fallback to prop when attributes are not supported + if ( typeof elem.getAttribute === "undefined" ) { + return jQuery.prop( elem, name, value ); + } + + // Attribute hooks are determined by the lowercase version + // Grab necessary hook if one is defined + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + hooks = jQuery.attrHooks[ name.toLowerCase() ] || + ( jQuery.expr.match.bool.test( name ) ? boolHook : undefined ); + } + + if ( value !== undefined ) { + if ( value === null ) { + jQuery.removeAttr( elem, name ); + return; + } + + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + elem.setAttribute( name, value + "" ); + return value; + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + ret = jQuery.find.attr( elem, name ); + + // Non-existent attributes return null, we normalize to undefined + return ret == null ? undefined : ret; + }, + + attrHooks: { + type: { + set: function( elem, value ) { + if ( !support.radioValue && value === "radio" && + nodeName( elem, "input" ) ) { + var val = elem.value; + elem.setAttribute( "type", value ); + if ( val ) { + elem.value = val; + } + return value; + } + } + } + }, + + removeAttr: function( elem, value ) { + var name, + i = 0, + + // Attribute names can contain non-HTML whitespace characters + // https://html.spec.whatwg.org/multipage/syntax.html#attributes-2 + attrNames = value && value.match( rnothtmlwhite ); + + if ( attrNames && elem.nodeType === 1 ) { + while ( ( name = attrNames[ i++ ] ) ) { + elem.removeAttribute( name ); + } + } + } +} ); + +// Hooks for boolean attributes +boolHook = { + set: function( elem, value, name ) { + if ( value === false ) { + + // Remove boolean attributes when set to false + jQuery.removeAttr( elem, name ); + } else { + elem.setAttribute( name, name ); + } + return name; + } +}; + +jQuery.each( jQuery.expr.match.bool.source.match( /\w+/g ), function( _i, name ) { + var getter = attrHandle[ name ] || jQuery.find.attr; + + attrHandle[ name ] = function( elem, name, isXML ) { + var ret, handle, + lowercaseName = name.toLowerCase(); + + if ( !isXML ) { + + // Avoid an infinite loop by temporarily removing this function from the getter + handle = attrHandle[ lowercaseName ]; + attrHandle[ lowercaseName ] = ret; + ret = getter( elem, name, isXML ) != null ? + lowercaseName : + null; + attrHandle[ lowercaseName ] = handle; + } + return ret; + }; +} ); + + + + +var rfocusable = /^(?:input|select|textarea|button)$/i, + rclickable = /^(?:a|area)$/i; + +jQuery.fn.extend( { + prop: function( name, value ) { + return access( this, jQuery.prop, name, value, arguments.length > 1 ); + }, + + removeProp: function( name ) { + return this.each( function() { + delete this[ jQuery.propFix[ name ] || name ]; + } ); + } +} ); + +jQuery.extend( { + prop: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set properties on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + + // Fix name and attach hooks + name = jQuery.propFix[ name ] || name; + hooks = jQuery.propHooks[ name ]; + } + + if ( value !== undefined ) { + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + return ( elem[ name ] = value ); + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + return elem[ name ]; + }, + + propHooks: { + tabIndex: { + get: function( elem ) { + + // Support: IE <=9 - 11 only + // elem.tabIndex doesn't always return the + // correct value when it hasn't been explicitly set + // https://web.archive.org/web/20141116233347/http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/ + // Use proper attribute retrieval(#12072) + var tabindex = jQuery.find.attr( elem, "tabindex" ); + + if ( tabindex ) { + return parseInt( tabindex, 10 ); + } + + if ( + rfocusable.test( elem.nodeName ) || + rclickable.test( elem.nodeName ) && + elem.href + ) { + return 0; + } + + return -1; + } + } + }, + + propFix: { + "for": "htmlFor", + "class": "className" + } +} ); + +// Support: IE <=11 only +// Accessing the selectedIndex property +// forces the browser to respect setting selected +// on the option +// The getter ensures a default option is selected +// when in an optgroup +// eslint rule "no-unused-expressions" is disabled for this code +// since it considers such accessions noop +if ( !support.optSelected ) { + jQuery.propHooks.selected = { + get: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent && parent.parentNode ) { + parent.parentNode.selectedIndex; + } + return null; + }, + set: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent ) { + parent.selectedIndex; + + if ( parent.parentNode ) { + parent.parentNode.selectedIndex; + } + } + } + }; +} + +jQuery.each( [ + "tabIndex", + "readOnly", + "maxLength", + "cellSpacing", + "cellPadding", + "rowSpan", + "colSpan", + "useMap", + "frameBorder", + "contentEditable" +], function() { + jQuery.propFix[ this.toLowerCase() ] = this; +} ); + + + + + // Strip and collapse whitespace according to HTML spec + // https://infra.spec.whatwg.org/#strip-and-collapse-ascii-whitespace + function stripAndCollapse( value ) { + var tokens = value.match( rnothtmlwhite ) || []; + return tokens.join( " " ); + } + + +function getClass( elem ) { + return elem.getAttribute && elem.getAttribute( "class" ) || ""; +} + +function classesToArray( value ) { + if ( Array.isArray( value ) ) { + return value; + } + if ( typeof value === "string" ) { + return value.match( rnothtmlwhite ) || []; + } + return []; +} + +jQuery.fn.extend( { + addClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).addClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + if ( cur.indexOf( " " + clazz + " " ) < 0 ) { + cur += clazz + " "; + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + removeClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).removeClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + if ( !arguments.length ) { + return this.attr( "class", "" ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + + // This expression is here for better compressibility (see addClass) + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + + // Remove *all* instances + while ( cur.indexOf( " " + clazz + " " ) > -1 ) { + cur = cur.replace( " " + clazz + " ", " " ); + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + toggleClass: function( value, stateVal ) { + var type = typeof value, + isValidValue = type === "string" || Array.isArray( value ); + + if ( typeof stateVal === "boolean" && isValidValue ) { + return stateVal ? this.addClass( value ) : this.removeClass( value ); + } + + if ( isFunction( value ) ) { + return this.each( function( i ) { + jQuery( this ).toggleClass( + value.call( this, i, getClass( this ), stateVal ), + stateVal + ); + } ); + } + + return this.each( function() { + var className, i, self, classNames; + + if ( isValidValue ) { + + // Toggle individual class names + i = 0; + self = jQuery( this ); + classNames = classesToArray( value ); + + while ( ( className = classNames[ i++ ] ) ) { + + // Check each className given, space separated list + if ( self.hasClass( className ) ) { + self.removeClass( className ); + } else { + self.addClass( className ); + } + } + + // Toggle whole class name + } else if ( value === undefined || type === "boolean" ) { + className = getClass( this ); + if ( className ) { + + // Store className if set + dataPriv.set( this, "__className__", className ); + } + + // If the element has a class name or if we're passed `false`, + // then remove the whole classname (if there was one, the above saved it). + // Otherwise bring back whatever was previously saved (if anything), + // falling back to the empty string if nothing was stored. + if ( this.setAttribute ) { + this.setAttribute( "class", + className || value === false ? + "" : + dataPriv.get( this, "__className__" ) || "" + ); + } + } + } ); + }, + + hasClass: function( selector ) { + var className, elem, + i = 0; + + className = " " + selector + " "; + while ( ( elem = this[ i++ ] ) ) { + if ( elem.nodeType === 1 && + ( " " + stripAndCollapse( getClass( elem ) ) + " " ).indexOf( className ) > -1 ) { + return true; + } + } + + return false; + } +} ); + + + + +var rreturn = /\r/g; + +jQuery.fn.extend( { + val: function( value ) { + var hooks, ret, valueIsFunction, + elem = this[ 0 ]; + + if ( !arguments.length ) { + if ( elem ) { + hooks = jQuery.valHooks[ elem.type ] || + jQuery.valHooks[ elem.nodeName.toLowerCase() ]; + + if ( hooks && + "get" in hooks && + ( ret = hooks.get( elem, "value" ) ) !== undefined + ) { + return ret; + } + + ret = elem.value; + + // Handle most common string cases + if ( typeof ret === "string" ) { + return ret.replace( rreturn, "" ); + } + + // Handle cases where value is null/undef or number + return ret == null ? "" : ret; + } + + return; + } + + valueIsFunction = isFunction( value ); + + return this.each( function( i ) { + var val; + + if ( this.nodeType !== 1 ) { + return; + } + + if ( valueIsFunction ) { + val = value.call( this, i, jQuery( this ).val() ); + } else { + val = value; + } + + // Treat null/undefined as ""; convert numbers to string + if ( val == null ) { + val = ""; + + } else if ( typeof val === "number" ) { + val += ""; + + } else if ( Array.isArray( val ) ) { + val = jQuery.map( val, function( value ) { + return value == null ? "" : value + ""; + } ); + } + + hooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ]; + + // If set returns undefined, fall back to normal setting + if ( !hooks || !( "set" in hooks ) || hooks.set( this, val, "value" ) === undefined ) { + this.value = val; + } + } ); + } +} ); + +jQuery.extend( { + valHooks: { + option: { + get: function( elem ) { + + var val = jQuery.find.attr( elem, "value" ); + return val != null ? + val : + + // Support: IE <=10 - 11 only + // option.text throws exceptions (#14686, #14858) + // Strip and collapse whitespace + // https://html.spec.whatwg.org/#strip-and-collapse-whitespace + stripAndCollapse( jQuery.text( elem ) ); + } + }, + select: { + get: function( elem ) { + var value, option, i, + options = elem.options, + index = elem.selectedIndex, + one = elem.type === "select-one", + values = one ? null : [], + max = one ? index + 1 : options.length; + + if ( index < 0 ) { + i = max; + + } else { + i = one ? index : 0; + } + + // Loop through all the selected options + for ( ; i < max; i++ ) { + option = options[ i ]; + + // Support: IE <=9 only + // IE8-9 doesn't update selected after form reset (#2551) + if ( ( option.selected || i === index ) && + + // Don't return options that are disabled or in a disabled optgroup + !option.disabled && + ( !option.parentNode.disabled || + !nodeName( option.parentNode, "optgroup" ) ) ) { + + // Get the specific value for the option + value = jQuery( option ).val(); + + // We don't need an array for one selects + if ( one ) { + return value; + } + + // Multi-Selects return an array + values.push( value ); + } + } + + return values; + }, + + set: function( elem, value ) { + var optionSet, option, + options = elem.options, + values = jQuery.makeArray( value ), + i = options.length; + + while ( i-- ) { + option = options[ i ]; + + /* eslint-disable no-cond-assign */ + + if ( option.selected = + jQuery.inArray( jQuery.valHooks.option.get( option ), values ) > -1 + ) { + optionSet = true; + } + + /* eslint-enable no-cond-assign */ + } + + // Force browsers to behave consistently when non-matching value is set + if ( !optionSet ) { + elem.selectedIndex = -1; + } + return values; + } + } + } +} ); + +// Radios and checkboxes getter/setter +jQuery.each( [ "radio", "checkbox" ], function() { + jQuery.valHooks[ this ] = { + set: function( elem, value ) { + if ( Array.isArray( value ) ) { + return ( elem.checked = jQuery.inArray( jQuery( elem ).val(), value ) > -1 ); + } + } + }; + if ( !support.checkOn ) { + jQuery.valHooks[ this ].get = function( elem ) { + return elem.getAttribute( "value" ) === null ? "on" : elem.value; + }; + } +} ); + + + + +// Return jQuery for attributes-only inclusion + + +support.focusin = "onfocusin" in window; + + +var rfocusMorph = /^(?:focusinfocus|focusoutblur)$/, + stopPropagationCallback = function( e ) { + e.stopPropagation(); + }; + +jQuery.extend( jQuery.event, { + + trigger: function( event, data, elem, onlyHandlers ) { + + var i, cur, tmp, bubbleType, ontype, handle, special, lastElement, + eventPath = [ elem || document ], + type = hasOwn.call( event, "type" ) ? event.type : event, + namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split( "." ) : []; + + cur = lastElement = tmp = elem = elem || document; + + // Don't do events on text and comment nodes + if ( elem.nodeType === 3 || elem.nodeType === 8 ) { + return; + } + + // focus/blur morphs to focusin/out; ensure we're not firing them right now + if ( rfocusMorph.test( type + jQuery.event.triggered ) ) { + return; + } + + if ( type.indexOf( "." ) > -1 ) { + + // Namespaced trigger; create a regexp to match event type in handle() + namespaces = type.split( "." ); + type = namespaces.shift(); + namespaces.sort(); + } + ontype = type.indexOf( ":" ) < 0 && "on" + type; + + // Caller can pass in a jQuery.Event object, Object, or just an event type string + event = event[ jQuery.expando ] ? + event : + new jQuery.Event( type, typeof event === "object" && event ); + + // Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true) + event.isTrigger = onlyHandlers ? 2 : 3; + event.namespace = namespaces.join( "." ); + event.rnamespace = event.namespace ? + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ) : + null; + + // Clean up the event in case it is being reused + event.result = undefined; + if ( !event.target ) { + event.target = elem; + } + + // Clone any incoming data and prepend the event, creating the handler arg list + data = data == null ? + [ event ] : + jQuery.makeArray( data, [ event ] ); + + // Allow special events to draw outside the lines + special = jQuery.event.special[ type ] || {}; + if ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) { + return; + } + + // Determine event propagation path in advance, per W3C events spec (#9951) + // Bubble up to document, then to window; watch for a global ownerDocument var (#9724) + if ( !onlyHandlers && !special.noBubble && !isWindow( elem ) ) { + + bubbleType = special.delegateType || type; + if ( !rfocusMorph.test( bubbleType + type ) ) { + cur = cur.parentNode; + } + for ( ; cur; cur = cur.parentNode ) { + eventPath.push( cur ); + tmp = cur; + } + + // Only add window if we got to document (e.g., not plain obj or detached DOM) + if ( tmp === ( elem.ownerDocument || document ) ) { + eventPath.push( tmp.defaultView || tmp.parentWindow || window ); + } + } + + // Fire handlers on the event path + i = 0; + while ( ( cur = eventPath[ i++ ] ) && !event.isPropagationStopped() ) { + lastElement = cur; + event.type = i > 1 ? + bubbleType : + special.bindType || type; + + // jQuery handler + handle = ( + dataPriv.get( cur, "events" ) || Object.create( null ) + )[ event.type ] && + dataPriv.get( cur, "handle" ); + if ( handle ) { + handle.apply( cur, data ); + } + + // Native handler + handle = ontype && cur[ ontype ]; + if ( handle && handle.apply && acceptData( cur ) ) { + event.result = handle.apply( cur, data ); + if ( event.result === false ) { + event.preventDefault(); + } + } + } + event.type = type; + + // If nobody prevented the default action, do it now + if ( !onlyHandlers && !event.isDefaultPrevented() ) { + + if ( ( !special._default || + special._default.apply( eventPath.pop(), data ) === false ) && + acceptData( elem ) ) { + + // Call a native DOM method on the target with the same name as the event. + // Don't do default actions on window, that's where global variables be (#6170) + if ( ontype && isFunction( elem[ type ] ) && !isWindow( elem ) ) { + + // Don't re-trigger an onFOO event when we call its FOO() method + tmp = elem[ ontype ]; + + if ( tmp ) { + elem[ ontype ] = null; + } + + // Prevent re-triggering of the same event, since we already bubbled it above + jQuery.event.triggered = type; + + if ( event.isPropagationStopped() ) { + lastElement.addEventListener( type, stopPropagationCallback ); + } + + elem[ type ](); + + if ( event.isPropagationStopped() ) { + lastElement.removeEventListener( type, stopPropagationCallback ); + } + + jQuery.event.triggered = undefined; + + if ( tmp ) { + elem[ ontype ] = tmp; + } + } + } + } + + return event.result; + }, + + // Piggyback on a donor event to simulate a different one + // Used only for `focus(in | out)` events + simulate: function( type, elem, event ) { + var e = jQuery.extend( + new jQuery.Event(), + event, + { + type: type, + isSimulated: true + } + ); + + jQuery.event.trigger( e, null, elem ); + } + +} ); + +jQuery.fn.extend( { + + trigger: function( type, data ) { + return this.each( function() { + jQuery.event.trigger( type, data, this ); + } ); + }, + triggerHandler: function( type, data ) { + var elem = this[ 0 ]; + if ( elem ) { + return jQuery.event.trigger( type, data, elem, true ); + } + } +} ); + + +// Support: Firefox <=44 +// Firefox doesn't have focus(in | out) events +// Related ticket - https://bugzilla.mozilla.org/show_bug.cgi?id=687787 +// +// Support: Chrome <=48 - 49, Safari <=9.0 - 9.1 +// focus(in | out) events fire after focus & blur events, +// which is spec violation - http://www.w3.org/TR/DOM-Level-3-Events/#events-focusevent-event-order +// Related ticket - https://bugs.chromium.org/p/chromium/issues/detail?id=449857 +if ( !support.focusin ) { + jQuery.each( { focus: "focusin", blur: "focusout" }, function( orig, fix ) { + + // Attach a single capturing handler on the document while someone wants focusin/focusout + var handler = function( event ) { + jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ) ); + }; + + jQuery.event.special[ fix ] = { + setup: function() { + + // Handle: regular nodes (via `this.ownerDocument`), window + // (via `this.document`) & document (via `this`). + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ); + + if ( !attaches ) { + doc.addEventListener( orig, handler, true ); + } + dataPriv.access( doc, fix, ( attaches || 0 ) + 1 ); + }, + teardown: function() { + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ) - 1; + + if ( !attaches ) { + doc.removeEventListener( orig, handler, true ); + dataPriv.remove( doc, fix ); + + } else { + dataPriv.access( doc, fix, attaches ); + } + } + }; + } ); +} +var location = window.location; + +var nonce = { guid: Date.now() }; + +var rquery = ( /\?/ ); + + + +// Cross-browser xml parsing +jQuery.parseXML = function( data ) { + var xml; + if ( !data || typeof data !== "string" ) { + return null; + } + + // Support: IE 9 - 11 only + // IE throws on parseFromString with invalid input. + try { + xml = ( new window.DOMParser() ).parseFromString( data, "text/xml" ); + } catch ( e ) { + xml = undefined; + } + + if ( !xml || xml.getElementsByTagName( "parsererror" ).length ) { + jQuery.error( "Invalid XML: " + data ); + } + return xml; +}; + + +var + rbracket = /\[\]$/, + rCRLF = /\r?\n/g, + rsubmitterTypes = /^(?:submit|button|image|reset|file)$/i, + rsubmittable = /^(?:input|select|textarea|keygen)/i; + +function buildParams( prefix, obj, traditional, add ) { + var name; + + if ( Array.isArray( obj ) ) { + + // Serialize array item. + jQuery.each( obj, function( i, v ) { + if ( traditional || rbracket.test( prefix ) ) { + + // Treat each array item as a scalar. + add( prefix, v ); + + } else { + + // Item is non-scalar (array or object), encode its numeric index. + buildParams( + prefix + "[" + ( typeof v === "object" && v != null ? i : "" ) + "]", + v, + traditional, + add + ); + } + } ); + + } else if ( !traditional && toType( obj ) === "object" ) { + + // Serialize object item. + for ( name in obj ) { + buildParams( prefix + "[" + name + "]", obj[ name ], traditional, add ); + } + + } else { + + // Serialize scalar item. + add( prefix, obj ); + } +} + +// Serialize an array of form elements or a set of +// key/values into a query string +jQuery.param = function( a, traditional ) { + var prefix, + s = [], + add = function( key, valueOrFunction ) { + + // If value is a function, invoke it and use its return value + var value = isFunction( valueOrFunction ) ? + valueOrFunction() : + valueOrFunction; + + s[ s.length ] = encodeURIComponent( key ) + "=" + + encodeURIComponent( value == null ? "" : value ); + }; + + if ( a == null ) { + return ""; + } + + // If an array was passed in, assume that it is an array of form elements. + if ( Array.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) { + + // Serialize the form elements + jQuery.each( a, function() { + add( this.name, this.value ); + } ); + + } else { + + // If traditional, encode the "old" way (the way 1.3.2 or older + // did it), otherwise encode params recursively. + for ( prefix in a ) { + buildParams( prefix, a[ prefix ], traditional, add ); + } + } + + // Return the resulting serialization + return s.join( "&" ); +}; + +jQuery.fn.extend( { + serialize: function() { + return jQuery.param( this.serializeArray() ); + }, + serializeArray: function() { + return this.map( function() { + + // Can add propHook for "elements" to filter or add form elements + var elements = jQuery.prop( this, "elements" ); + return elements ? jQuery.makeArray( elements ) : this; + } ) + .filter( function() { + var type = this.type; + + // Use .is( ":disabled" ) so that fieldset[disabled] works + return this.name && !jQuery( this ).is( ":disabled" ) && + rsubmittable.test( this.nodeName ) && !rsubmitterTypes.test( type ) && + ( this.checked || !rcheckableType.test( type ) ); + } ) + .map( function( _i, elem ) { + var val = jQuery( this ).val(); + + if ( val == null ) { + return null; + } + + if ( Array.isArray( val ) ) { + return jQuery.map( val, function( val ) { + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ); + } + + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ).get(); + } +} ); + + +var + r20 = /%20/g, + rhash = /#.*$/, + rantiCache = /([?&])_=[^&]*/, + rheaders = /^(.*?):[ \t]*([^\r\n]*)$/mg, + + // #7653, #8125, #8152: local protocol detection + rlocalProtocol = /^(?:about|app|app-storage|.+-extension|file|res|widget):$/, + rnoContent = /^(?:GET|HEAD)$/, + rprotocol = /^\/\//, + + /* Prefilters + * 1) They are useful to introduce custom dataTypes (see ajax/jsonp.js for an example) + * 2) These are called: + * - BEFORE asking for a transport + * - AFTER param serialization (s.data is a string if s.processData is true) + * 3) key is the dataType + * 4) the catchall symbol "*" can be used + * 5) execution will start with transport dataType and THEN continue down to "*" if needed + */ + prefilters = {}, + + /* Transports bindings + * 1) key is the dataType + * 2) the catchall symbol "*" can be used + * 3) selection will start with transport dataType and THEN go to "*" if needed + */ + transports = {}, + + // Avoid comment-prolog char sequence (#10098); must appease lint and evade compression + allTypes = "*/".concat( "*" ), + + // Anchor tag for parsing the document origin + originAnchor = document.createElement( "a" ); + originAnchor.href = location.href; + +// Base "constructor" for jQuery.ajaxPrefilter and jQuery.ajaxTransport +function addToPrefiltersOrTransports( structure ) { + + // dataTypeExpression is optional and defaults to "*" + return function( dataTypeExpression, func ) { + + if ( typeof dataTypeExpression !== "string" ) { + func = dataTypeExpression; + dataTypeExpression = "*"; + } + + var dataType, + i = 0, + dataTypes = dataTypeExpression.toLowerCase().match( rnothtmlwhite ) || []; + + if ( isFunction( func ) ) { + + // For each dataType in the dataTypeExpression + while ( ( dataType = dataTypes[ i++ ] ) ) { + + // Prepend if requested + if ( dataType[ 0 ] === "+" ) { + dataType = dataType.slice( 1 ) || "*"; + ( structure[ dataType ] = structure[ dataType ] || [] ).unshift( func ); + + // Otherwise append + } else { + ( structure[ dataType ] = structure[ dataType ] || [] ).push( func ); + } + } + } + }; +} + +// Base inspection function for prefilters and transports +function inspectPrefiltersOrTransports( structure, options, originalOptions, jqXHR ) { + + var inspected = {}, + seekingTransport = ( structure === transports ); + + function inspect( dataType ) { + var selected; + inspected[ dataType ] = true; + jQuery.each( structure[ dataType ] || [], function( _, prefilterOrFactory ) { + var dataTypeOrTransport = prefilterOrFactory( options, originalOptions, jqXHR ); + if ( typeof dataTypeOrTransport === "string" && + !seekingTransport && !inspected[ dataTypeOrTransport ] ) { + + options.dataTypes.unshift( dataTypeOrTransport ); + inspect( dataTypeOrTransport ); + return false; + } else if ( seekingTransport ) { + return !( selected = dataTypeOrTransport ); + } + } ); + return selected; + } + + return inspect( options.dataTypes[ 0 ] ) || !inspected[ "*" ] && inspect( "*" ); +} + +// A special extend for ajax options +// that takes "flat" options (not to be deep extended) +// Fixes #9887 +function ajaxExtend( target, src ) { + var key, deep, + flatOptions = jQuery.ajaxSettings.flatOptions || {}; + + for ( key in src ) { + if ( src[ key ] !== undefined ) { + ( flatOptions[ key ] ? target : ( deep || ( deep = {} ) ) )[ key ] = src[ key ]; + } + } + if ( deep ) { + jQuery.extend( true, target, deep ); + } + + return target; +} + +/* Handles responses to an ajax request: + * - finds the right dataType (mediates between content-type and expected dataType) + * - returns the corresponding response + */ +function ajaxHandleResponses( s, jqXHR, responses ) { + + var ct, type, finalDataType, firstDataType, + contents = s.contents, + dataTypes = s.dataTypes; + + // Remove auto dataType and get content-type in the process + while ( dataTypes[ 0 ] === "*" ) { + dataTypes.shift(); + if ( ct === undefined ) { + ct = s.mimeType || jqXHR.getResponseHeader( "Content-Type" ); + } + } + + // Check if we're dealing with a known content-type + if ( ct ) { + for ( type in contents ) { + if ( contents[ type ] && contents[ type ].test( ct ) ) { + dataTypes.unshift( type ); + break; + } + } + } + + // Check to see if we have a response for the expected dataType + if ( dataTypes[ 0 ] in responses ) { + finalDataType = dataTypes[ 0 ]; + } else { + + // Try convertible dataTypes + for ( type in responses ) { + if ( !dataTypes[ 0 ] || s.converters[ type + " " + dataTypes[ 0 ] ] ) { + finalDataType = type; + break; + } + if ( !firstDataType ) { + firstDataType = type; + } + } + + // Or just use first one + finalDataType = finalDataType || firstDataType; + } + + // If we found a dataType + // We add the dataType to the list if needed + // and return the corresponding response + if ( finalDataType ) { + if ( finalDataType !== dataTypes[ 0 ] ) { + dataTypes.unshift( finalDataType ); + } + return responses[ finalDataType ]; + } +} + +/* Chain conversions given the request and the original response + * Also sets the responseXXX fields on the jqXHR instance + */ +function ajaxConvert( s, response, jqXHR, isSuccess ) { + var conv2, current, conv, tmp, prev, + converters = {}, + + // Work with a copy of dataTypes in case we need to modify it for conversion + dataTypes = s.dataTypes.slice(); + + // Create converters map with lowercased keys + if ( dataTypes[ 1 ] ) { + for ( conv in s.converters ) { + converters[ conv.toLowerCase() ] = s.converters[ conv ]; + } + } + + current = dataTypes.shift(); + + // Convert to each sequential dataType + while ( current ) { + + if ( s.responseFields[ current ] ) { + jqXHR[ s.responseFields[ current ] ] = response; + } + + // Apply the dataFilter if provided + if ( !prev && isSuccess && s.dataFilter ) { + response = s.dataFilter( response, s.dataType ); + } + + prev = current; + current = dataTypes.shift(); + + if ( current ) { + + // There's only work to do if current dataType is non-auto + if ( current === "*" ) { + + current = prev; + + // Convert response if prev dataType is non-auto and differs from current + } else if ( prev !== "*" && prev !== current ) { + + // Seek a direct converter + conv = converters[ prev + " " + current ] || converters[ "* " + current ]; + + // If none found, seek a pair + if ( !conv ) { + for ( conv2 in converters ) { + + // If conv2 outputs current + tmp = conv2.split( " " ); + if ( tmp[ 1 ] === current ) { + + // If prev can be converted to accepted input + conv = converters[ prev + " " + tmp[ 0 ] ] || + converters[ "* " + tmp[ 0 ] ]; + if ( conv ) { + + // Condense equivalence converters + if ( conv === true ) { + conv = converters[ conv2 ]; + + // Otherwise, insert the intermediate dataType + } else if ( converters[ conv2 ] !== true ) { + current = tmp[ 0 ]; + dataTypes.unshift( tmp[ 1 ] ); + } + break; + } + } + } + } + + // Apply converter (if not an equivalence) + if ( conv !== true ) { + + // Unless errors are allowed to bubble, catch and return them + if ( conv && s.throws ) { + response = conv( response ); + } else { + try { + response = conv( response ); + } catch ( e ) { + return { + state: "parsererror", + error: conv ? e : "No conversion from " + prev + " to " + current + }; + } + } + } + } + } + } + + return { state: "success", data: response }; +} + +jQuery.extend( { + + // Counter for holding the number of active queries + active: 0, + + // Last-Modified header cache for next request + lastModified: {}, + etag: {}, + + ajaxSettings: { + url: location.href, + type: "GET", + isLocal: rlocalProtocol.test( location.protocol ), + global: true, + processData: true, + async: true, + contentType: "application/x-www-form-urlencoded; charset=UTF-8", + + /* + timeout: 0, + data: null, + dataType: null, + username: null, + password: null, + cache: null, + throws: false, + traditional: false, + headers: {}, + */ + + accepts: { + "*": allTypes, + text: "text/plain", + html: "text/html", + xml: "application/xml, text/xml", + json: "application/json, text/javascript" + }, + + contents: { + xml: /\bxml\b/, + html: /\bhtml/, + json: /\bjson\b/ + }, + + responseFields: { + xml: "responseXML", + text: "responseText", + json: "responseJSON" + }, + + // Data converters + // Keys separate source (or catchall "*") and destination types with a single space + converters: { + + // Convert anything to text + "* text": String, + + // Text to html (true = no transformation) + "text html": true, + + // Evaluate text as a json expression + "text json": JSON.parse, + + // Parse text as xml + "text xml": jQuery.parseXML + }, + + // For options that shouldn't be deep extended: + // you can add your own custom options here if + // and when you create one that shouldn't be + // deep extended (see ajaxExtend) + flatOptions: { + url: true, + context: true + } + }, + + // Creates a full fledged settings object into target + // with both ajaxSettings and settings fields. + // If target is omitted, writes into ajaxSettings. + ajaxSetup: function( target, settings ) { + return settings ? + + // Building a settings object + ajaxExtend( ajaxExtend( target, jQuery.ajaxSettings ), settings ) : + + // Extending ajaxSettings + ajaxExtend( jQuery.ajaxSettings, target ); + }, + + ajaxPrefilter: addToPrefiltersOrTransports( prefilters ), + ajaxTransport: addToPrefiltersOrTransports( transports ), + + // Main method + ajax: function( url, options ) { + + // If url is an object, simulate pre-1.5 signature + if ( typeof url === "object" ) { + options = url; + url = undefined; + } + + // Force options to be an object + options = options || {}; + + var transport, + + // URL without anti-cache param + cacheURL, + + // Response headers + responseHeadersString, + responseHeaders, + + // timeout handle + timeoutTimer, + + // Url cleanup var + urlAnchor, + + // Request state (becomes false upon send and true upon completion) + completed, + + // To know if global events are to be dispatched + fireGlobals, + + // Loop variable + i, + + // uncached part of the url + uncached, + + // Create the final options object + s = jQuery.ajaxSetup( {}, options ), + + // Callbacks context + callbackContext = s.context || s, + + // Context for global events is callbackContext if it is a DOM node or jQuery collection + globalEventContext = s.context && + ( callbackContext.nodeType || callbackContext.jquery ) ? + jQuery( callbackContext ) : + jQuery.event, + + // Deferreds + deferred = jQuery.Deferred(), + completeDeferred = jQuery.Callbacks( "once memory" ), + + // Status-dependent callbacks + statusCode = s.statusCode || {}, + + // Headers (they are sent all at once) + requestHeaders = {}, + requestHeadersNames = {}, + + // Default abort message + strAbort = "canceled", + + // Fake xhr + jqXHR = { + readyState: 0, + + // Builds headers hashtable if needed + getResponseHeader: function( key ) { + var match; + if ( completed ) { + if ( !responseHeaders ) { + responseHeaders = {}; + while ( ( match = rheaders.exec( responseHeadersString ) ) ) { + responseHeaders[ match[ 1 ].toLowerCase() + " " ] = + ( responseHeaders[ match[ 1 ].toLowerCase() + " " ] || [] ) + .concat( match[ 2 ] ); + } + } + match = responseHeaders[ key.toLowerCase() + " " ]; + } + return match == null ? null : match.join( ", " ); + }, + + // Raw string + getAllResponseHeaders: function() { + return completed ? responseHeadersString : null; + }, + + // Caches the header + setRequestHeader: function( name, value ) { + if ( completed == null ) { + name = requestHeadersNames[ name.toLowerCase() ] = + requestHeadersNames[ name.toLowerCase() ] || name; + requestHeaders[ name ] = value; + } + return this; + }, + + // Overrides response content-type header + overrideMimeType: function( type ) { + if ( completed == null ) { + s.mimeType = type; + } + return this; + }, + + // Status-dependent callbacks + statusCode: function( map ) { + var code; + if ( map ) { + if ( completed ) { + + // Execute the appropriate callbacks + jqXHR.always( map[ jqXHR.status ] ); + } else { + + // Lazy-add the new callbacks in a way that preserves old ones + for ( code in map ) { + statusCode[ code ] = [ statusCode[ code ], map[ code ] ]; + } + } + } + return this; + }, + + // Cancel the request + abort: function( statusText ) { + var finalText = statusText || strAbort; + if ( transport ) { + transport.abort( finalText ); + } + done( 0, finalText ); + return this; + } + }; + + // Attach deferreds + deferred.promise( jqXHR ); + + // Add protocol if not provided (prefilters might expect it) + // Handle falsy url in the settings object (#10093: consistency with old signature) + // We also use the url parameter if available + s.url = ( ( url || s.url || location.href ) + "" ) + .replace( rprotocol, location.protocol + "//" ); + + // Alias method option to type as per ticket #12004 + s.type = options.method || options.type || s.method || s.type; + + // Extract dataTypes list + s.dataTypes = ( s.dataType || "*" ).toLowerCase().match( rnothtmlwhite ) || [ "" ]; + + // A cross-domain request is in order when the origin doesn't match the current origin. + if ( s.crossDomain == null ) { + urlAnchor = document.createElement( "a" ); + + // Support: IE <=8 - 11, Edge 12 - 15 + // IE throws exception on accessing the href property if url is malformed, + // e.g. http://example.com:80x/ + try { + urlAnchor.href = s.url; + + // Support: IE <=8 - 11 only + // Anchor's host property isn't correctly set when s.url is relative + urlAnchor.href = urlAnchor.href; + s.crossDomain = originAnchor.protocol + "//" + originAnchor.host !== + urlAnchor.protocol + "//" + urlAnchor.host; + } catch ( e ) { + + // If there is an error parsing the URL, assume it is crossDomain, + // it can be rejected by the transport if it is invalid + s.crossDomain = true; + } + } + + // Convert data if not already a string + if ( s.data && s.processData && typeof s.data !== "string" ) { + s.data = jQuery.param( s.data, s.traditional ); + } + + // Apply prefilters + inspectPrefiltersOrTransports( prefilters, s, options, jqXHR ); + + // If request was aborted inside a prefilter, stop there + if ( completed ) { + return jqXHR; + } + + // We can fire global events as of now if asked to + // Don't fire events if jQuery.event is undefined in an AMD-usage scenario (#15118) + fireGlobals = jQuery.event && s.global; + + // Watch for a new set of requests + if ( fireGlobals && jQuery.active++ === 0 ) { + jQuery.event.trigger( "ajaxStart" ); + } + + // Uppercase the type + s.type = s.type.toUpperCase(); + + // Determine if request has content + s.hasContent = !rnoContent.test( s.type ); + + // Save the URL in case we're toying with the If-Modified-Since + // and/or If-None-Match header later on + // Remove hash to simplify url manipulation + cacheURL = s.url.replace( rhash, "" ); + + // More options handling for requests with no content + if ( !s.hasContent ) { + + // Remember the hash so we can put it back + uncached = s.url.slice( cacheURL.length ); + + // If data is available and should be processed, append data to url + if ( s.data && ( s.processData || typeof s.data === "string" ) ) { + cacheURL += ( rquery.test( cacheURL ) ? "&" : "?" ) + s.data; + + // #9682: remove data so that it's not used in an eventual retry + delete s.data; + } + + // Add or update anti-cache param if needed + if ( s.cache === false ) { + cacheURL = cacheURL.replace( rantiCache, "$1" ); + uncached = ( rquery.test( cacheURL ) ? "&" : "?" ) + "_=" + ( nonce.guid++ ) + + uncached; + } + + // Put hash and anti-cache on the URL that will be requested (gh-1732) + s.url = cacheURL + uncached; + + // Change '%20' to '+' if this is encoded form body content (gh-2658) + } else if ( s.data && s.processData && + ( s.contentType || "" ).indexOf( "application/x-www-form-urlencoded" ) === 0 ) { + s.data = s.data.replace( r20, "+" ); + } + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + if ( jQuery.lastModified[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-Modified-Since", jQuery.lastModified[ cacheURL ] ); + } + if ( jQuery.etag[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-None-Match", jQuery.etag[ cacheURL ] ); + } + } + + // Set the correct header, if data is being sent + if ( s.data && s.hasContent && s.contentType !== false || options.contentType ) { + jqXHR.setRequestHeader( "Content-Type", s.contentType ); + } + + // Set the Accepts header for the server, depending on the dataType + jqXHR.setRequestHeader( + "Accept", + s.dataTypes[ 0 ] && s.accepts[ s.dataTypes[ 0 ] ] ? + s.accepts[ s.dataTypes[ 0 ] ] + + ( s.dataTypes[ 0 ] !== "*" ? ", " + allTypes + "; q=0.01" : "" ) : + s.accepts[ "*" ] + ); + + // Check for headers option + for ( i in s.headers ) { + jqXHR.setRequestHeader( i, s.headers[ i ] ); + } + + // Allow custom headers/mimetypes and early abort + if ( s.beforeSend && + ( s.beforeSend.call( callbackContext, jqXHR, s ) === false || completed ) ) { + + // Abort if not done already and return + return jqXHR.abort(); + } + + // Aborting is no longer a cancellation + strAbort = "abort"; + + // Install callbacks on deferreds + completeDeferred.add( s.complete ); + jqXHR.done( s.success ); + jqXHR.fail( s.error ); + + // Get transport + transport = inspectPrefiltersOrTransports( transports, s, options, jqXHR ); + + // If no transport, we auto-abort + if ( !transport ) { + done( -1, "No Transport" ); + } else { + jqXHR.readyState = 1; + + // Send global event + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxSend", [ jqXHR, s ] ); + } + + // If request was aborted inside ajaxSend, stop there + if ( completed ) { + return jqXHR; + } + + // Timeout + if ( s.async && s.timeout > 0 ) { + timeoutTimer = window.setTimeout( function() { + jqXHR.abort( "timeout" ); + }, s.timeout ); + } + + try { + completed = false; + transport.send( requestHeaders, done ); + } catch ( e ) { + + // Rethrow post-completion exceptions + if ( completed ) { + throw e; + } + + // Propagate others as results + done( -1, e ); + } + } + + // Callback for when everything is done + function done( status, nativeStatusText, responses, headers ) { + var isSuccess, success, error, response, modified, + statusText = nativeStatusText; + + // Ignore repeat invocations + if ( completed ) { + return; + } + + completed = true; + + // Clear timeout if it exists + if ( timeoutTimer ) { + window.clearTimeout( timeoutTimer ); + } + + // Dereference transport for early garbage collection + // (no matter how long the jqXHR object will be used) + transport = undefined; + + // Cache response headers + responseHeadersString = headers || ""; + + // Set readyState + jqXHR.readyState = status > 0 ? 4 : 0; + + // Determine if successful + isSuccess = status >= 200 && status < 300 || status === 304; + + // Get response data + if ( responses ) { + response = ajaxHandleResponses( s, jqXHR, responses ); + } + + // Use a noop converter for missing script + if ( !isSuccess && jQuery.inArray( "script", s.dataTypes ) > -1 ) { + s.converters[ "text script" ] = function() {}; + } + + // Convert no matter what (that way responseXXX fields are always set) + response = ajaxConvert( s, response, jqXHR, isSuccess ); + + // If successful, handle type chaining + if ( isSuccess ) { + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + modified = jqXHR.getResponseHeader( "Last-Modified" ); + if ( modified ) { + jQuery.lastModified[ cacheURL ] = modified; + } + modified = jqXHR.getResponseHeader( "etag" ); + if ( modified ) { + jQuery.etag[ cacheURL ] = modified; + } + } + + // if no content + if ( status === 204 || s.type === "HEAD" ) { + statusText = "nocontent"; + + // if not modified + } else if ( status === 304 ) { + statusText = "notmodified"; + + // If we have data, let's convert it + } else { + statusText = response.state; + success = response.data; + error = response.error; + isSuccess = !error; + } + } else { + + // Extract error from statusText and normalize for non-aborts + error = statusText; + if ( status || !statusText ) { + statusText = "error"; + if ( status < 0 ) { + status = 0; + } + } + } + + // Set data for the fake xhr object + jqXHR.status = status; + jqXHR.statusText = ( nativeStatusText || statusText ) + ""; + + // Success/Error + if ( isSuccess ) { + deferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] ); + } else { + deferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] ); + } + + // Status-dependent callbacks + jqXHR.statusCode( statusCode ); + statusCode = undefined; + + if ( fireGlobals ) { + globalEventContext.trigger( isSuccess ? "ajaxSuccess" : "ajaxError", + [ jqXHR, s, isSuccess ? success : error ] ); + } + + // Complete + completeDeferred.fireWith( callbackContext, [ jqXHR, statusText ] ); + + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxComplete", [ jqXHR, s ] ); + + // Handle the global AJAX counter + if ( !( --jQuery.active ) ) { + jQuery.event.trigger( "ajaxStop" ); + } + } + } + + return jqXHR; + }, + + getJSON: function( url, data, callback ) { + return jQuery.get( url, data, callback, "json" ); + }, + + getScript: function( url, callback ) { + return jQuery.get( url, undefined, callback, "script" ); + } +} ); + +jQuery.each( [ "get", "post" ], function( _i, method ) { + jQuery[ method ] = function( url, data, callback, type ) { + + // Shift arguments if data argument was omitted + if ( isFunction( data ) ) { + type = type || callback; + callback = data; + data = undefined; + } + + // The url can be an options object (which then must have .url) + return jQuery.ajax( jQuery.extend( { + url: url, + type: method, + dataType: type, + data: data, + success: callback + }, jQuery.isPlainObject( url ) && url ) ); + }; +} ); + +jQuery.ajaxPrefilter( function( s ) { + var i; + for ( i in s.headers ) { + if ( i.toLowerCase() === "content-type" ) { + s.contentType = s.headers[ i ] || ""; + } + } +} ); + + +jQuery._evalUrl = function( url, options, doc ) { + return jQuery.ajax( { + url: url, + + // Make this explicit, since user can override this through ajaxSetup (#11264) + type: "GET", + dataType: "script", + cache: true, + async: false, + global: false, + + // Only evaluate the response if it is successful (gh-4126) + // dataFilter is not invoked for failure responses, so using it instead + // of the default converter is kludgy but it works. + converters: { + "text script": function() {} + }, + dataFilter: function( response ) { + jQuery.globalEval( response, options, doc ); + } + } ); +}; + + +jQuery.fn.extend( { + wrapAll: function( html ) { + var wrap; + + if ( this[ 0 ] ) { + if ( isFunction( html ) ) { + html = html.call( this[ 0 ] ); + } + + // The elements to wrap the target around + wrap = jQuery( html, this[ 0 ].ownerDocument ).eq( 0 ).clone( true ); + + if ( this[ 0 ].parentNode ) { + wrap.insertBefore( this[ 0 ] ); + } + + wrap.map( function() { + var elem = this; + + while ( elem.firstElementChild ) { + elem = elem.firstElementChild; + } + + return elem; + } ).append( this ); + } + + return this; + }, + + wrapInner: function( html ) { + if ( isFunction( html ) ) { + return this.each( function( i ) { + jQuery( this ).wrapInner( html.call( this, i ) ); + } ); + } + + return this.each( function() { + var self = jQuery( this ), + contents = self.contents(); + + if ( contents.length ) { + contents.wrapAll( html ); + + } else { + self.append( html ); + } + } ); + }, + + wrap: function( html ) { + var htmlIsFunction = isFunction( html ); + + return this.each( function( i ) { + jQuery( this ).wrapAll( htmlIsFunction ? html.call( this, i ) : html ); + } ); + }, + + unwrap: function( selector ) { + this.parent( selector ).not( "body" ).each( function() { + jQuery( this ).replaceWith( this.childNodes ); + } ); + return this; + } +} ); + + +jQuery.expr.pseudos.hidden = function( elem ) { + return !jQuery.expr.pseudos.visible( elem ); +}; +jQuery.expr.pseudos.visible = function( elem ) { + return !!( elem.offsetWidth || elem.offsetHeight || elem.getClientRects().length ); +}; + + + + +jQuery.ajaxSettings.xhr = function() { + try { + return new window.XMLHttpRequest(); + } catch ( e ) {} +}; + +var xhrSuccessStatus = { + + // File protocol always yields status code 0, assume 200 + 0: 200, + + // Support: IE <=9 only + // #1450: sometimes IE returns 1223 when it should be 204 + 1223: 204 + }, + xhrSupported = jQuery.ajaxSettings.xhr(); + +support.cors = !!xhrSupported && ( "withCredentials" in xhrSupported ); +support.ajax = xhrSupported = !!xhrSupported; + +jQuery.ajaxTransport( function( options ) { + var callback, errorCallback; + + // Cross domain only allowed if supported through XMLHttpRequest + if ( support.cors || xhrSupported && !options.crossDomain ) { + return { + send: function( headers, complete ) { + var i, + xhr = options.xhr(); + + xhr.open( + options.type, + options.url, + options.async, + options.username, + options.password + ); + + // Apply custom fields if provided + if ( options.xhrFields ) { + for ( i in options.xhrFields ) { + xhr[ i ] = options.xhrFields[ i ]; + } + } + + // Override mime type if needed + if ( options.mimeType && xhr.overrideMimeType ) { + xhr.overrideMimeType( options.mimeType ); + } + + // X-Requested-With header + // For cross-domain requests, seeing as conditions for a preflight are + // akin to a jigsaw puzzle, we simply never set it to be sure. + // (it can always be set on a per-request basis or even using ajaxSetup) + // For same-domain requests, won't change header if already provided. + if ( !options.crossDomain && !headers[ "X-Requested-With" ] ) { + headers[ "X-Requested-With" ] = "XMLHttpRequest"; + } + + // Set headers + for ( i in headers ) { + xhr.setRequestHeader( i, headers[ i ] ); + } + + // Callback + callback = function( type ) { + return function() { + if ( callback ) { + callback = errorCallback = xhr.onload = + xhr.onerror = xhr.onabort = xhr.ontimeout = + xhr.onreadystatechange = null; + + if ( type === "abort" ) { + xhr.abort(); + } else if ( type === "error" ) { + + // Support: IE <=9 only + // On a manual native abort, IE9 throws + // errors on any property access that is not readyState + if ( typeof xhr.status !== "number" ) { + complete( 0, "error" ); + } else { + complete( + + // File: protocol always yields status 0; see #8605, #14207 + xhr.status, + xhr.statusText + ); + } + } else { + complete( + xhrSuccessStatus[ xhr.status ] || xhr.status, + xhr.statusText, + + // Support: IE <=9 only + // IE9 has no XHR2 but throws on binary (trac-11426) + // For XHR2 non-text, let the caller handle it (gh-2498) + ( xhr.responseType || "text" ) !== "text" || + typeof xhr.responseText !== "string" ? + { binary: xhr.response } : + { text: xhr.responseText }, + xhr.getAllResponseHeaders() + ); + } + } + }; + }; + + // Listen to events + xhr.onload = callback(); + errorCallback = xhr.onerror = xhr.ontimeout = callback( "error" ); + + // Support: IE 9 only + // Use onreadystatechange to replace onabort + // to handle uncaught aborts + if ( xhr.onabort !== undefined ) { + xhr.onabort = errorCallback; + } else { + xhr.onreadystatechange = function() { + + // Check readyState before timeout as it changes + if ( xhr.readyState === 4 ) { + + // Allow onerror to be called first, + // but that will not handle a native abort + // Also, save errorCallback to a variable + // as xhr.onerror cannot be accessed + window.setTimeout( function() { + if ( callback ) { + errorCallback(); + } + } ); + } + }; + } + + // Create the abort callback + callback = callback( "abort" ); + + try { + + // Do send the request (this may raise an exception) + xhr.send( options.hasContent && options.data || null ); + } catch ( e ) { + + // #14683: Only rethrow if this hasn't been notified as an error yet + if ( callback ) { + throw e; + } + } + }, + + abort: function() { + if ( callback ) { + callback(); + } + } + }; + } +} ); + + + + +// Prevent auto-execution of scripts when no explicit dataType was provided (See gh-2432) +jQuery.ajaxPrefilter( function( s ) { + if ( s.crossDomain ) { + s.contents.script = false; + } +} ); + +// Install script dataType +jQuery.ajaxSetup( { + accepts: { + script: "text/javascript, application/javascript, " + + "application/ecmascript, application/x-ecmascript" + }, + contents: { + script: /\b(?:java|ecma)script\b/ + }, + converters: { + "text script": function( text ) { + jQuery.globalEval( text ); + return text; + } + } +} ); + +// Handle cache's special case and crossDomain +jQuery.ajaxPrefilter( "script", function( s ) { + if ( s.cache === undefined ) { + s.cache = false; + } + if ( s.crossDomain ) { + s.type = "GET"; + } +} ); + +// Bind script tag hack transport +jQuery.ajaxTransport( "script", function( s ) { + + // This transport only deals with cross domain or forced-by-attrs requests + if ( s.crossDomain || s.scriptAttrs ) { + var script, callback; + return { + send: function( _, complete ) { + script = jQuery( "\r\n"; + +// inject VBScript +document.write(IEBinaryToArray_ByteStr_Script); + +global.JSZipUtils._getBinaryFromXHR = function (xhr) { + var binary = xhr.responseBody; + var byteMapping = {}; + for ( var i = 0; i < 256; i++ ) { + for ( var j = 0; j < 256; j++ ) { + byteMapping[ String.fromCharCode( i + (j << 8) ) ] = + String.fromCharCode(i) + String.fromCharCode(j); + } + } + var rawBytes = IEBinaryToArray_ByteStr(binary); + var lastChr = IEBinaryToArray_ByteStr_Last(binary); + return rawBytes.replace(/[\s\S]/g, function( match ) { + return byteMapping[match]; + }) + lastChr; +}; + +// enforcing Stuk's coding style +// vim: set shiftwidth=4 softtabstop=4: + +},{}]},{},[1]) +; diff --git a/javadoc/latest/jquery/jszip-utils/dist/jszip-utils-ie.min.js b/javadoc/latest/jquery/jszip-utils/dist/jszip-utils-ie.min.js new file mode 100644 index 000000000..93d8bc8ef --- /dev/null +++ b/javadoc/latest/jquery/jszip-utils/dist/jszip-utils-ie.min.js @@ -0,0 +1,10 @@ +/*! + +JSZipUtils - A collection of cross-browser utilities to go along with JSZip. + + +(c) 2014 Stuart Knightley, David Duponchel +Dual licenced under the MIT license or GPLv3. See https://raw.github.com/Stuk/jszip-utils/master/LICENSE.markdown. + +*/ +!function a(b,c,d){function e(g,h){if(!c[g]){if(!b[g]){var i="function"==typeof require&&require;if(!h&&i)return i(g,!0);if(f)return f(g,!0);throw new Error("Cannot find module '"+g+"'")}var j=c[g]={exports:{}};b[g][0].call(j.exports,function(a){var c=b[g][1][a];return e(c?c:a)},j,j.exports,a,b,c,d)}return c[g].exports}for(var f="function"==typeof require&&require,g=0;g\r\n";document.write(b),a.JSZipUtils._getBinaryFromXHR=function(a){for(var b=a.responseBody,c={},d=0;256>d;d++)for(var e=0;256>e;e++)c[String.fromCharCode(d+(e<<8))]=String.fromCharCode(d)+String.fromCharCode(e);var f=IEBinaryToArray_ByteStr(b),g=IEBinaryToArray_ByteStr_Last(b);return f.replace(/[\s\S]/g,function(a){return c[a]})+g}},{}]},{},[1]); diff --git a/javadoc/latest/jquery/jszip-utils/dist/jszip-utils.js b/javadoc/latest/jquery/jszip-utils/dist/jszip-utils.js new file mode 100644 index 000000000..775895ec9 --- /dev/null +++ b/javadoc/latest/jquery/jszip-utils/dist/jszip-utils.js @@ -0,0 +1,118 @@ +/*! + +JSZipUtils - A collection of cross-browser utilities to go along with JSZip. + + +(c) 2014 Stuart Knightley, David Duponchel +Dual licenced under the MIT license or GPLv3. See https://raw.github.com/Stuk/jszip-utils/master/LICENSE.markdown. + +*/ +!function(e){"object"==typeof exports?module.exports=e():"function"==typeof define&&define.amd?define(e):"undefined"!=typeof window?window.JSZipUtils=e():"undefined"!=typeof global?global.JSZipUtils=e():"undefined"!=typeof self&&(self.JSZipUtils=e())}(function(){var define,module,exports;return (function e(t,n,r){function s(o,u){if(!n[o]){if(!t[o]){var a=typeof require=="function"&&require;if(!u&&a)return a(o,!0);if(i)return i(o,!0);throw new Error("Cannot find module '"+o+"'")}var f=n[o]={exports:{}};t[o][0].call(f.exports,function(e){var n=t[o][1][e];return s(n?n:e)},f,f.exports,e,t,n,r)}return n[o].exports}var i=typeof require=="function"&&require;for(var o=0;o + +(c) 2014 Stuart Knightley, David Duponchel +Dual licenced under the MIT license or GPLv3. See https://raw.github.com/Stuk/jszip-utils/master/LICENSE.markdown. + +*/ +!function(a){"object"==typeof exports?module.exports=a():"function"==typeof define&&define.amd?define(a):"undefined"!=typeof window?window.JSZipUtils=a():"undefined"!=typeof global?global.JSZipUtils=a():"undefined"!=typeof self&&(self.JSZipUtils=a())}(function(){return function a(b,c,d){function e(g,h){if(!c[g]){if(!b[g]){var i="function"==typeof require&&require;if(!h&&i)return i(g,!0);if(f)return f(g,!0);throw new Error("Cannot find module '"+g+"'")}var j=c[g]={exports:{}};b[g][0].call(j.exports,function(a){var c=b[g][1][a];return e(c?c:a)},j,j.exports,a,b,c,d)}return c[g].exports}for(var f="function"==typeof require&&require,g=0;g + +(c) 2009-2016 Stuart Knightley +Dual licenced under the MIT license or GPLv3. See https://raw.github.com/Stuk/jszip/master/LICENSE.markdown. + +JSZip uses the library pako released under the MIT license : +https://github.com/nodeca/pako/blob/master/LICENSE +*/ + +(function(f){if(typeof exports==="object"&&typeof module!=="undefined"){module.exports=f()}else if(typeof define==="function"&&define.amd){define([],f)}else{var g;if(typeof window!=="undefined"){g=window}else if(typeof global!=="undefined"){g=global}else if(typeof self!=="undefined"){g=self}else{g=this}g.JSZip = f()}})(function(){var define,module,exports;return (function e(t,n,r){function s(o,u){if(!n[o]){if(!t[o]){var a=typeof require=="function"&&require;if(!u&&a)return a(o,!0);if(i)return i(o,!0);var f=new Error("Cannot find module '"+o+"'");throw f.code="MODULE_NOT_FOUND",f}var l=n[o]={exports:{}};t[o][0].call(l.exports,function(e){var n=t[o][1][e];return s(n?n:e)},l,l.exports,e,t,n,r)}return n[o].exports}var i=typeof require=="function"&&require;for(var o=0;o> 2; + enc2 = ((chr1 & 3) << 4) | (chr2 >> 4); + enc3 = remainingBytes > 1 ? (((chr2 & 15) << 2) | (chr3 >> 6)) : 64; + enc4 = remainingBytes > 2 ? (chr3 & 63) : 64; + + output.push(_keyStr.charAt(enc1) + _keyStr.charAt(enc2) + _keyStr.charAt(enc3) + _keyStr.charAt(enc4)); + + } + + return output.join(""); +}; + +// public method for decoding +exports.decode = function(input) { + var chr1, chr2, chr3; + var enc1, enc2, enc3, enc4; + var i = 0, resultIndex = 0; + + var dataUrlPrefix = "data:"; + + if (input.substr(0, dataUrlPrefix.length) === dataUrlPrefix) { + // This is a common error: people give a data url + // (data:image/png;base64,iVBOR...) with a {base64: true} and + // wonders why things don't work. + // We can detect that the string input looks like a data url but we + // *can't* be sure it is one: removing everything up to the comma would + // be too dangerous. + throw new Error("Invalid base64 input, it looks like a data url."); + } + + input = input.replace(/[^A-Za-z0-9\+\/\=]/g, ""); + + var totalLength = input.length * 3 / 4; + if(input.charAt(input.length - 1) === _keyStr.charAt(64)) { + totalLength--; + } + if(input.charAt(input.length - 2) === _keyStr.charAt(64)) { + totalLength--; + } + if (totalLength % 1 !== 0) { + // totalLength is not an integer, the length does not match a valid + // base64 content. That can happen if: + // - the input is not a base64 content + // - the input is *almost* a base64 content, with a extra chars at the + // beginning or at the end + // - the input uses a base64 variant (base64url for example) + throw new Error("Invalid base64 input, bad content length."); + } + var output; + if (support.uint8array) { + output = new Uint8Array(totalLength|0); + } else { + output = new Array(totalLength|0); + } + + while (i < input.length) { + + enc1 = _keyStr.indexOf(input.charAt(i++)); + enc2 = _keyStr.indexOf(input.charAt(i++)); + enc3 = _keyStr.indexOf(input.charAt(i++)); + enc4 = _keyStr.indexOf(input.charAt(i++)); + + chr1 = (enc1 << 2) | (enc2 >> 4); + chr2 = ((enc2 & 15) << 4) | (enc3 >> 2); + chr3 = ((enc3 & 3) << 6) | enc4; + + output[resultIndex++] = chr1; + + if (enc3 !== 64) { + output[resultIndex++] = chr2; + } + if (enc4 !== 64) { + output[resultIndex++] = chr3; + } + + } + + return output; +}; + +},{"./support":30,"./utils":32}],2:[function(require,module,exports){ +'use strict'; + +var external = require("./external"); +var DataWorker = require('./stream/DataWorker'); +var Crc32Probe = require('./stream/Crc32Probe'); +var DataLengthProbe = require('./stream/DataLengthProbe'); + +/** + * Represent a compressed object, with everything needed to decompress it. + * @constructor + * @param {number} compressedSize the size of the data compressed. + * @param {number} uncompressedSize the size of the data after decompression. + * @param {number} crc32 the crc32 of the decompressed file. + * @param {object} compression the type of compression, see lib/compressions.js. + * @param {String|ArrayBuffer|Uint8Array|Buffer} data the compressed data. + */ +function CompressedObject(compressedSize, uncompressedSize, crc32, compression, data) { + this.compressedSize = compressedSize; + this.uncompressedSize = uncompressedSize; + this.crc32 = crc32; + this.compression = compression; + this.compressedContent = data; +} + +CompressedObject.prototype = { + /** + * Create a worker to get the uncompressed content. + * @return {GenericWorker} the worker. + */ + getContentWorker: function () { + var worker = new DataWorker(external.Promise.resolve(this.compressedContent)) + .pipe(this.compression.uncompressWorker()) + .pipe(new DataLengthProbe("data_length")); + + var that = this; + worker.on("end", function () { + if (this.streamInfo['data_length'] !== that.uncompressedSize) { + throw new Error("Bug : uncompressed data size mismatch"); + } + }); + return worker; + }, + /** + * Create a worker to get the compressed content. + * @return {GenericWorker} the worker. + */ + getCompressedWorker: function () { + return new DataWorker(external.Promise.resolve(this.compressedContent)) + .withStreamInfo("compressedSize", this.compressedSize) + .withStreamInfo("uncompressedSize", this.uncompressedSize) + .withStreamInfo("crc32", this.crc32) + .withStreamInfo("compression", this.compression) + ; + } +}; + +/** + * Chain the given worker with other workers to compress the content with the + * given compression. + * @param {GenericWorker} uncompressedWorker the worker to pipe. + * @param {Object} compression the compression object. + * @param {Object} compressionOptions the options to use when compressing. + * @return {GenericWorker} the new worker compressing the content. + */ +CompressedObject.createWorkerFrom = function (uncompressedWorker, compression, compressionOptions) { + return uncompressedWorker + .pipe(new Crc32Probe()) + .pipe(new DataLengthProbe("uncompressedSize")) + .pipe(compression.compressWorker(compressionOptions)) + .pipe(new DataLengthProbe("compressedSize")) + .withStreamInfo("compression", compression); +}; + +module.exports = CompressedObject; + +},{"./external":6,"./stream/Crc32Probe":25,"./stream/DataLengthProbe":26,"./stream/DataWorker":27}],3:[function(require,module,exports){ +'use strict'; + +var GenericWorker = require("./stream/GenericWorker"); + +exports.STORE = { + magic: "\x00\x00", + compressWorker : function (compressionOptions) { + return new GenericWorker("STORE compression"); + }, + uncompressWorker : function () { + return new GenericWorker("STORE decompression"); + } +}; +exports.DEFLATE = require('./flate'); + +},{"./flate":7,"./stream/GenericWorker":28}],4:[function(require,module,exports){ +'use strict'; + +var utils = require('./utils'); + +/** + * The following functions come from pako, from pako/lib/zlib/crc32.js + * released under the MIT license, see pako https://github.com/nodeca/pako/ + */ + +// Use ordinary array, since untyped makes no boost here +function makeTable() { + var c, table = []; + + for(var n =0; n < 256; n++){ + c = n; + for(var k =0; k < 8; k++){ + c = ((c&1) ? (0xEDB88320 ^ (c >>> 1)) : (c >>> 1)); + } + table[n] = c; + } + + return table; +} + +// Create table on load. Just 255 signed longs. Not a problem. +var crcTable = makeTable(); + + +function crc32(crc, buf, len, pos) { + var t = crcTable, end = pos + len; + + crc = crc ^ (-1); + + for (var i = pos; i < end; i++ ) { + crc = (crc >>> 8) ^ t[(crc ^ buf[i]) & 0xFF]; + } + + return (crc ^ (-1)); // >>> 0; +} + +// That's all for the pako functions. + +/** + * Compute the crc32 of a string. + * This is almost the same as the function crc32, but for strings. Using the + * same function for the two use cases leads to horrible performances. + * @param {Number} crc the starting value of the crc. + * @param {String} str the string to use. + * @param {Number} len the length of the string. + * @param {Number} pos the starting position for the crc32 computation. + * @return {Number} the computed crc32. + */ +function crc32str(crc, str, len, pos) { + var t = crcTable, end = pos + len; + + crc = crc ^ (-1); + + for (var i = pos; i < end; i++ ) { + crc = (crc >>> 8) ^ t[(crc ^ str.charCodeAt(i)) & 0xFF]; + } + + return (crc ^ (-1)); // >>> 0; +} + +module.exports = function crc32wrapper(input, crc) { + if (typeof input === "undefined" || !input.length) { + return 0; + } + + var isArray = utils.getTypeOf(input) !== "string"; + + if(isArray) { + return crc32(crc|0, input, input.length, 0); + } else { + return crc32str(crc|0, input, input.length, 0); + } +}; + +},{"./utils":32}],5:[function(require,module,exports){ +'use strict'; +exports.base64 = false; +exports.binary = false; +exports.dir = false; +exports.createFolders = true; +exports.date = null; +exports.compression = null; +exports.compressionOptions = null; +exports.comment = null; +exports.unixPermissions = null; +exports.dosPermissions = null; + +},{}],6:[function(require,module,exports){ +/* global Promise */ +'use strict'; + +// load the global object first: +// - it should be better integrated in the system (unhandledRejection in node) +// - the environment may have a custom Promise implementation (see zone.js) +var ES6Promise = null; +if (typeof Promise !== "undefined") { + ES6Promise = Promise; +} else { + ES6Promise = require("lie"); +} + +/** + * Let the user use/change some implementations. + */ +module.exports = { + Promise: ES6Promise +}; + +},{"lie":37}],7:[function(require,module,exports){ +'use strict'; +var USE_TYPEDARRAY = (typeof Uint8Array !== 'undefined') && (typeof Uint16Array !== 'undefined') && (typeof Uint32Array !== 'undefined'); + +var pako = require("pako"); +var utils = require("./utils"); +var GenericWorker = require("./stream/GenericWorker"); + +var ARRAY_TYPE = USE_TYPEDARRAY ? "uint8array" : "array"; + +exports.magic = "\x08\x00"; + +/** + * Create a worker that uses pako to inflate/deflate. + * @constructor + * @param {String} action the name of the pako function to call : either "Deflate" or "Inflate". + * @param {Object} options the options to use when (de)compressing. + */ +function FlateWorker(action, options) { + GenericWorker.call(this, "FlateWorker/" + action); + + this._pako = null; + this._pakoAction = action; + this._pakoOptions = options; + // the `meta` object from the last chunk received + // this allow this worker to pass around metadata + this.meta = {}; +} + +utils.inherits(FlateWorker, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +FlateWorker.prototype.processChunk = function (chunk) { + this.meta = chunk.meta; + if (this._pako === null) { + this._createPako(); + } + this._pako.push(utils.transformTo(ARRAY_TYPE, chunk.data), false); +}; + +/** + * @see GenericWorker.flush + */ +FlateWorker.prototype.flush = function () { + GenericWorker.prototype.flush.call(this); + if (this._pako === null) { + this._createPako(); + } + this._pako.push([], true); +}; +/** + * @see GenericWorker.cleanUp + */ +FlateWorker.prototype.cleanUp = function () { + GenericWorker.prototype.cleanUp.call(this); + this._pako = null; +}; + +/** + * Create the _pako object. + * TODO: lazy-loading this object isn't the best solution but it's the + * quickest. The best solution is to lazy-load the worker list. See also the + * issue #446. + */ +FlateWorker.prototype._createPako = function () { + this._pako = new pako[this._pakoAction]({ + raw: true, + level: this._pakoOptions.level || -1 // default compression + }); + var self = this; + this._pako.onData = function(data) { + self.push({ + data : data, + meta : self.meta + }); + }; +}; + +exports.compressWorker = function (compressionOptions) { + return new FlateWorker("Deflate", compressionOptions); +}; +exports.uncompressWorker = function () { + return new FlateWorker("Inflate", {}); +}; + +},{"./stream/GenericWorker":28,"./utils":32,"pako":38}],8:[function(require,module,exports){ +'use strict'; + +var utils = require('../utils'); +var GenericWorker = require('../stream/GenericWorker'); +var utf8 = require('../utf8'); +var crc32 = require('../crc32'); +var signature = require('../signature'); + +/** + * Transform an integer into a string in hexadecimal. + * @private + * @param {number} dec the number to convert. + * @param {number} bytes the number of bytes to generate. + * @returns {string} the result. + */ +var decToHex = function(dec, bytes) { + var hex = "", i; + for (i = 0; i < bytes; i++) { + hex += String.fromCharCode(dec & 0xff); + dec = dec >>> 8; + } + return hex; +}; + +/** + * Generate the UNIX part of the external file attributes. + * @param {Object} unixPermissions the unix permissions or null. + * @param {Boolean} isDir true if the entry is a directory, false otherwise. + * @return {Number} a 32 bit integer. + * + * adapted from http://unix.stackexchange.com/questions/14705/the-zip-formats-external-file-attribute : + * + * TTTTsstrwxrwxrwx0000000000ADVSHR + * ^^^^____________________________ file type, see zipinfo.c (UNX_*) + * ^^^_________________________ setuid, setgid, sticky + * ^^^^^^^^^________________ permissions + * ^^^^^^^^^^______ not used ? + * ^^^^^^ DOS attribute bits : Archive, Directory, Volume label, System file, Hidden, Read only + */ +var generateUnixExternalFileAttr = function (unixPermissions, isDir) { + + var result = unixPermissions; + if (!unixPermissions) { + // I can't use octal values in strict mode, hence the hexa. + // 040775 => 0x41fd + // 0100664 => 0x81b4 + result = isDir ? 0x41fd : 0x81b4; + } + return (result & 0xFFFF) << 16; +}; + +/** + * Generate the DOS part of the external file attributes. + * @param {Object} dosPermissions the dos permissions or null. + * @param {Boolean} isDir true if the entry is a directory, false otherwise. + * @return {Number} a 32 bit integer. + * + * Bit 0 Read-Only + * Bit 1 Hidden + * Bit 2 System + * Bit 3 Volume Label + * Bit 4 Directory + * Bit 5 Archive + */ +var generateDosExternalFileAttr = function (dosPermissions, isDir) { + + // the dir flag is already set for compatibility + return (dosPermissions || 0) & 0x3F; +}; + +/** + * Generate the various parts used in the construction of the final zip file. + * @param {Object} streamInfo the hash with information about the compressed file. + * @param {Boolean} streamedContent is the content streamed ? + * @param {Boolean} streamingEnded is the stream finished ? + * @param {number} offset the current offset from the start of the zip file. + * @param {String} platform let's pretend we are this platform (change platform dependents fields) + * @param {Function} encodeFileName the function to encode the file name / comment. + * @return {Object} the zip parts. + */ +var generateZipParts = function(streamInfo, streamedContent, streamingEnded, offset, platform, encodeFileName) { + var file = streamInfo['file'], + compression = streamInfo['compression'], + useCustomEncoding = encodeFileName !== utf8.utf8encode, + encodedFileName = utils.transformTo("string", encodeFileName(file.name)), + utfEncodedFileName = utils.transformTo("string", utf8.utf8encode(file.name)), + comment = file.comment, + encodedComment = utils.transformTo("string", encodeFileName(comment)), + utfEncodedComment = utils.transformTo("string", utf8.utf8encode(comment)), + useUTF8ForFileName = utfEncodedFileName.length !== file.name.length, + useUTF8ForComment = utfEncodedComment.length !== comment.length, + dosTime, + dosDate, + extraFields = "", + unicodePathExtraField = "", + unicodeCommentExtraField = "", + dir = file.dir, + date = file.date; + + + var dataInfo = { + crc32 : 0, + compressedSize : 0, + uncompressedSize : 0 + }; + + // if the content is streamed, the sizes/crc32 are only available AFTER + // the end of the stream. + if (!streamedContent || streamingEnded) { + dataInfo.crc32 = streamInfo['crc32']; + dataInfo.compressedSize = streamInfo['compressedSize']; + dataInfo.uncompressedSize = streamInfo['uncompressedSize']; + } + + var bitflag = 0; + if (streamedContent) { + // Bit 3: the sizes/crc32 are set to zero in the local header. + // The correct values are put in the data descriptor immediately + // following the compressed data. + bitflag |= 0x0008; + } + if (!useCustomEncoding && (useUTF8ForFileName || useUTF8ForComment)) { + // Bit 11: Language encoding flag (EFS). + bitflag |= 0x0800; + } + + + var extFileAttr = 0; + var versionMadeBy = 0; + if (dir) { + // dos or unix, we set the dos dir flag + extFileAttr |= 0x00010; + } + if(platform === "UNIX") { + versionMadeBy = 0x031E; // UNIX, version 3.0 + extFileAttr |= generateUnixExternalFileAttr(file.unixPermissions, dir); + } else { // DOS or other, fallback to DOS + versionMadeBy = 0x0014; // DOS, version 2.0 + extFileAttr |= generateDosExternalFileAttr(file.dosPermissions, dir); + } + + // date + // @see http://www.delorie.com/djgpp/doc/rbinter/it/52/13.html + // @see http://www.delorie.com/djgpp/doc/rbinter/it/65/16.html + // @see http://www.delorie.com/djgpp/doc/rbinter/it/66/16.html + + dosTime = date.getUTCHours(); + dosTime = dosTime << 6; + dosTime = dosTime | date.getUTCMinutes(); + dosTime = dosTime << 5; + dosTime = dosTime | date.getUTCSeconds() / 2; + + dosDate = date.getUTCFullYear() - 1980; + dosDate = dosDate << 4; + dosDate = dosDate | (date.getUTCMonth() + 1); + dosDate = dosDate << 5; + dosDate = dosDate | date.getUTCDate(); + + if (useUTF8ForFileName) { + // set the unicode path extra field. unzip needs at least one extra + // field to correctly handle unicode path, so using the path is as good + // as any other information. This could improve the situation with + // other archive managers too. + // This field is usually used without the utf8 flag, with a non + // unicode path in the header (winrar, winzip). This helps (a bit) + // with the messy Windows' default compressed folders feature but + // breaks on p7zip which doesn't seek the unicode path extra field. + // So for now, UTF-8 everywhere ! + unicodePathExtraField = + // Version + decToHex(1, 1) + + // NameCRC32 + decToHex(crc32(encodedFileName), 4) + + // UnicodeName + utfEncodedFileName; + + extraFields += + // Info-ZIP Unicode Path Extra Field + "\x75\x70" + + // size + decToHex(unicodePathExtraField.length, 2) + + // content + unicodePathExtraField; + } + + if(useUTF8ForComment) { + + unicodeCommentExtraField = + // Version + decToHex(1, 1) + + // CommentCRC32 + decToHex(crc32(encodedComment), 4) + + // UnicodeName + utfEncodedComment; + + extraFields += + // Info-ZIP Unicode Path Extra Field + "\x75\x63" + + // size + decToHex(unicodeCommentExtraField.length, 2) + + // content + unicodeCommentExtraField; + } + + var header = ""; + + // version needed to extract + header += "\x0A\x00"; + // general purpose bit flag + header += decToHex(bitflag, 2); + // compression method + header += compression.magic; + // last mod file time + header += decToHex(dosTime, 2); + // last mod file date + header += decToHex(dosDate, 2); + // crc-32 + header += decToHex(dataInfo.crc32, 4); + // compressed size + header += decToHex(dataInfo.compressedSize, 4); + // uncompressed size + header += decToHex(dataInfo.uncompressedSize, 4); + // file name length + header += decToHex(encodedFileName.length, 2); + // extra field length + header += decToHex(extraFields.length, 2); + + + var fileRecord = signature.LOCAL_FILE_HEADER + header + encodedFileName + extraFields; + + var dirRecord = signature.CENTRAL_FILE_HEADER + + // version made by (00: DOS) + decToHex(versionMadeBy, 2) + + // file header (common to file and central directory) + header + + // file comment length + decToHex(encodedComment.length, 2) + + // disk number start + "\x00\x00" + + // internal file attributes TODO + "\x00\x00" + + // external file attributes + decToHex(extFileAttr, 4) + + // relative offset of local header + decToHex(offset, 4) + + // file name + encodedFileName + + // extra field + extraFields + + // file comment + encodedComment; + + return { + fileRecord: fileRecord, + dirRecord: dirRecord + }; +}; + +/** + * Generate the EOCD record. + * @param {Number} entriesCount the number of entries in the zip file. + * @param {Number} centralDirLength the length (in bytes) of the central dir. + * @param {Number} localDirLength the length (in bytes) of the local dir. + * @param {String} comment the zip file comment as a binary string. + * @param {Function} encodeFileName the function to encode the comment. + * @return {String} the EOCD record. + */ +var generateCentralDirectoryEnd = function (entriesCount, centralDirLength, localDirLength, comment, encodeFileName) { + var dirEnd = ""; + var encodedComment = utils.transformTo("string", encodeFileName(comment)); + + // end of central dir signature + dirEnd = signature.CENTRAL_DIRECTORY_END + + // number of this disk + "\x00\x00" + + // number of the disk with the start of the central directory + "\x00\x00" + + // total number of entries in the central directory on this disk + decToHex(entriesCount, 2) + + // total number of entries in the central directory + decToHex(entriesCount, 2) + + // size of the central directory 4 bytes + decToHex(centralDirLength, 4) + + // offset of start of central directory with respect to the starting disk number + decToHex(localDirLength, 4) + + // .ZIP file comment length + decToHex(encodedComment.length, 2) + + // .ZIP file comment + encodedComment; + + return dirEnd; +}; + +/** + * Generate data descriptors for a file entry. + * @param {Object} streamInfo the hash generated by a worker, containing information + * on the file entry. + * @return {String} the data descriptors. + */ +var generateDataDescriptors = function (streamInfo) { + var descriptor = ""; + descriptor = signature.DATA_DESCRIPTOR + + // crc-32 4 bytes + decToHex(streamInfo['crc32'], 4) + + // compressed size 4 bytes + decToHex(streamInfo['compressedSize'], 4) + + // uncompressed size 4 bytes + decToHex(streamInfo['uncompressedSize'], 4); + + return descriptor; +}; + + +/** + * A worker to concatenate other workers to create a zip file. + * @param {Boolean} streamFiles `true` to stream the content of the files, + * `false` to accumulate it. + * @param {String} comment the comment to use. + * @param {String} platform the platform to use, "UNIX" or "DOS". + * @param {Function} encodeFileName the function to encode file names and comments. + */ +function ZipFileWorker(streamFiles, comment, platform, encodeFileName) { + GenericWorker.call(this, "ZipFileWorker"); + // The number of bytes written so far. This doesn't count accumulated chunks. + this.bytesWritten = 0; + // The comment of the zip file + this.zipComment = comment; + // The platform "generating" the zip file. + this.zipPlatform = platform; + // the function to encode file names and comments. + this.encodeFileName = encodeFileName; + // Should we stream the content of the files ? + this.streamFiles = streamFiles; + // If `streamFiles` is false, we will need to accumulate the content of the + // files to calculate sizes / crc32 (and write them *before* the content). + // This boolean indicates if we are accumulating chunks (it will change a lot + // during the lifetime of this worker). + this.accumulate = false; + // The buffer receiving chunks when accumulating content. + this.contentBuffer = []; + // The list of generated directory records. + this.dirRecords = []; + // The offset (in bytes) from the beginning of the zip file for the current source. + this.currentSourceOffset = 0; + // The total number of entries in this zip file. + this.entriesCount = 0; + // the name of the file currently being added, null when handling the end of the zip file. + // Used for the emitted metadata. + this.currentFile = null; + + + + this._sources = []; +} +utils.inherits(ZipFileWorker, GenericWorker); + +/** + * @see GenericWorker.push + */ +ZipFileWorker.prototype.push = function (chunk) { + + var currentFilePercent = chunk.meta.percent || 0; + var entriesCount = this.entriesCount; + var remainingFiles = this._sources.length; + + if(this.accumulate) { + this.contentBuffer.push(chunk); + } else { + this.bytesWritten += chunk.data.length; + + GenericWorker.prototype.push.call(this, { + data : chunk.data, + meta : { + currentFile : this.currentFile, + percent : entriesCount ? (currentFilePercent + 100 * (entriesCount - remainingFiles - 1)) / entriesCount : 100 + } + }); + } +}; + +/** + * The worker started a new source (an other worker). + * @param {Object} streamInfo the streamInfo object from the new source. + */ +ZipFileWorker.prototype.openedSource = function (streamInfo) { + this.currentSourceOffset = this.bytesWritten; + this.currentFile = streamInfo['file'].name; + + var streamedContent = this.streamFiles && !streamInfo['file'].dir; + + // don't stream folders (because they don't have any content) + if(streamedContent) { + var record = generateZipParts(streamInfo, streamedContent, false, this.currentSourceOffset, this.zipPlatform, this.encodeFileName); + this.push({ + data : record.fileRecord, + meta : {percent:0} + }); + } else { + // we need to wait for the whole file before pushing anything + this.accumulate = true; + } +}; + +/** + * The worker finished a source (an other worker). + * @param {Object} streamInfo the streamInfo object from the finished source. + */ +ZipFileWorker.prototype.closedSource = function (streamInfo) { + this.accumulate = false; + var streamedContent = this.streamFiles && !streamInfo['file'].dir; + var record = generateZipParts(streamInfo, streamedContent, true, this.currentSourceOffset, this.zipPlatform, this.encodeFileName); + + this.dirRecords.push(record.dirRecord); + if(streamedContent) { + // after the streamed file, we put data descriptors + this.push({ + data : generateDataDescriptors(streamInfo), + meta : {percent:100} + }); + } else { + // the content wasn't streamed, we need to push everything now + // first the file record, then the content + this.push({ + data : record.fileRecord, + meta : {percent:0} + }); + while(this.contentBuffer.length) { + this.push(this.contentBuffer.shift()); + } + } + this.currentFile = null; +}; + +/** + * @see GenericWorker.flush + */ +ZipFileWorker.prototype.flush = function () { + + var localDirLength = this.bytesWritten; + for(var i = 0; i < this.dirRecords.length; i++) { + this.push({ + data : this.dirRecords[i], + meta : {percent:100} + }); + } + var centralDirLength = this.bytesWritten - localDirLength; + + var dirEnd = generateCentralDirectoryEnd(this.dirRecords.length, centralDirLength, localDirLength, this.zipComment, this.encodeFileName); + + this.push({ + data : dirEnd, + meta : {percent:100} + }); +}; + +/** + * Prepare the next source to be read. + */ +ZipFileWorker.prototype.prepareNextSource = function () { + this.previous = this._sources.shift(); + this.openedSource(this.previous.streamInfo); + if (this.isPaused) { + this.previous.pause(); + } else { + this.previous.resume(); + } +}; + +/** + * @see GenericWorker.registerPrevious + */ +ZipFileWorker.prototype.registerPrevious = function (previous) { + this._sources.push(previous); + var self = this; + + previous.on('data', function (chunk) { + self.processChunk(chunk); + }); + previous.on('end', function () { + self.closedSource(self.previous.streamInfo); + if(self._sources.length) { + self.prepareNextSource(); + } else { + self.end(); + } + }); + previous.on('error', function (e) { + self.error(e); + }); + return this; +}; + +/** + * @see GenericWorker.resume + */ +ZipFileWorker.prototype.resume = function () { + if(!GenericWorker.prototype.resume.call(this)) { + return false; + } + + if (!this.previous && this._sources.length) { + this.prepareNextSource(); + return true; + } + if (!this.previous && !this._sources.length && !this.generatedError) { + this.end(); + return true; + } +}; + +/** + * @see GenericWorker.error + */ +ZipFileWorker.prototype.error = function (e) { + var sources = this._sources; + if(!GenericWorker.prototype.error.call(this, e)) { + return false; + } + for(var i = 0; i < sources.length; i++) { + try { + sources[i].error(e); + } catch(e) { + // the `error` exploded, nothing to do + } + } + return true; +}; + +/** + * @see GenericWorker.lock + */ +ZipFileWorker.prototype.lock = function () { + GenericWorker.prototype.lock.call(this); + var sources = this._sources; + for(var i = 0; i < sources.length; i++) { + sources[i].lock(); + } +}; + +module.exports = ZipFileWorker; + +},{"../crc32":4,"../signature":23,"../stream/GenericWorker":28,"../utf8":31,"../utils":32}],9:[function(require,module,exports){ +'use strict'; + +var compressions = require('../compressions'); +var ZipFileWorker = require('./ZipFileWorker'); + +/** + * Find the compression to use. + * @param {String} fileCompression the compression defined at the file level, if any. + * @param {String} zipCompression the compression defined at the load() level. + * @return {Object} the compression object to use. + */ +var getCompression = function (fileCompression, zipCompression) { + + var compressionName = fileCompression || zipCompression; + var compression = compressions[compressionName]; + if (!compression) { + throw new Error(compressionName + " is not a valid compression method !"); + } + return compression; +}; + +/** + * Create a worker to generate a zip file. + * @param {JSZip} zip the JSZip instance at the right root level. + * @param {Object} options to generate the zip file. + * @param {String} comment the comment to use. + */ +exports.generateWorker = function (zip, options, comment) { + + var zipFileWorker = new ZipFileWorker(options.streamFiles, comment, options.platform, options.encodeFileName); + var entriesCount = 0; + try { + + zip.forEach(function (relativePath, file) { + entriesCount++; + var compression = getCompression(file.options.compression, options.compression); + var compressionOptions = file.options.compressionOptions || options.compressionOptions || {}; + var dir = file.dir, date = file.date; + + file._compressWorker(compression, compressionOptions) + .withStreamInfo("file", { + name : relativePath, + dir : dir, + date : date, + comment : file.comment || "", + unixPermissions : file.unixPermissions, + dosPermissions : file.dosPermissions + }) + .pipe(zipFileWorker); + }); + zipFileWorker.entriesCount = entriesCount; + } catch (e) { + zipFileWorker.error(e); + } + + return zipFileWorker; +}; + +},{"../compressions":3,"./ZipFileWorker":8}],10:[function(require,module,exports){ +'use strict'; + +/** + * Representation a of zip file in js + * @constructor + */ +function JSZip() { + // if this constructor is used without `new`, it adds `new` before itself: + if(!(this instanceof JSZip)) { + return new JSZip(); + } + + if(arguments.length) { + throw new Error("The constructor with parameters has been removed in JSZip 3.0, please check the upgrade guide."); + } + + // object containing the files : + // { + // "folder/" : {...}, + // "folder/data.txt" : {...} + // } + // NOTE: we use a null prototype because we do not + // want filenames like "toString" coming from a zip file + // to overwrite methods and attributes in a normal Object. + this.files = Object.create(null); + + this.comment = null; + + // Where we are in the hierarchy + this.root = ""; + this.clone = function() { + var newObj = new JSZip(); + for (var i in this) { + if (typeof this[i] !== "function") { + newObj[i] = this[i]; + } + } + return newObj; + }; +} +JSZip.prototype = require('./object'); +JSZip.prototype.loadAsync = require('./load'); +JSZip.support = require('./support'); +JSZip.defaults = require('./defaults'); + +// TODO find a better way to handle this version, +// a require('package.json').version doesn't work with webpack, see #327 +JSZip.version = "3.7.1"; + +JSZip.loadAsync = function (content, options) { + return new JSZip().loadAsync(content, options); +}; + +JSZip.external = require("./external"); +module.exports = JSZip; + +},{"./defaults":5,"./external":6,"./load":11,"./object":15,"./support":30}],11:[function(require,module,exports){ +'use strict'; +var utils = require('./utils'); +var external = require("./external"); +var utf8 = require('./utf8'); +var ZipEntries = require('./zipEntries'); +var Crc32Probe = require('./stream/Crc32Probe'); +var nodejsUtils = require("./nodejsUtils"); + +/** + * Check the CRC32 of an entry. + * @param {ZipEntry} zipEntry the zip entry to check. + * @return {Promise} the result. + */ +function checkEntryCRC32(zipEntry) { + return new external.Promise(function (resolve, reject) { + var worker = zipEntry.decompressed.getContentWorker().pipe(new Crc32Probe()); + worker.on("error", function (e) { + reject(e); + }) + .on("end", function () { + if (worker.streamInfo.crc32 !== zipEntry.decompressed.crc32) { + reject(new Error("Corrupted zip : CRC32 mismatch")); + } else { + resolve(); + } + }) + .resume(); + }); +} + +module.exports = function (data, options) { + var zip = this; + options = utils.extend(options || {}, { + base64: false, + checkCRC32: false, + optimizedBinaryString: false, + createFolders: false, + decodeFileName: utf8.utf8decode + }); + + if (nodejsUtils.isNode && nodejsUtils.isStream(data)) { + return external.Promise.reject(new Error("JSZip can't accept a stream when loading a zip file.")); + } + + return utils.prepareContent("the loaded zip file", data, true, options.optimizedBinaryString, options.base64) + .then(function (data) { + var zipEntries = new ZipEntries(options); + zipEntries.load(data); + return zipEntries; + }).then(function checkCRC32(zipEntries) { + var promises = [external.Promise.resolve(zipEntries)]; + var files = zipEntries.files; + if (options.checkCRC32) { + for (var i = 0; i < files.length; i++) { + promises.push(checkEntryCRC32(files[i])); + } + } + return external.Promise.all(promises); + }).then(function addFiles(results) { + var zipEntries = results.shift(); + var files = zipEntries.files; + for (var i = 0; i < files.length; i++) { + var input = files[i]; + zip.file(input.fileNameStr, input.decompressed, { + binary: true, + optimizedBinaryString: true, + date: input.date, + dir: input.dir, + comment: input.fileCommentStr.length ? input.fileCommentStr : null, + unixPermissions: input.unixPermissions, + dosPermissions: input.dosPermissions, + createFolders: options.createFolders + }); + } + if (zipEntries.zipComment.length) { + zip.comment = zipEntries.zipComment; + } + + return zip; + }); +}; + +},{"./external":6,"./nodejsUtils":14,"./stream/Crc32Probe":25,"./utf8":31,"./utils":32,"./zipEntries":33}],12:[function(require,module,exports){ +"use strict"; + +var utils = require('../utils'); +var GenericWorker = require('../stream/GenericWorker'); + +/** + * A worker that use a nodejs stream as source. + * @constructor + * @param {String} filename the name of the file entry for this stream. + * @param {Readable} stream the nodejs stream. + */ +function NodejsStreamInputAdapter(filename, stream) { + GenericWorker.call(this, "Nodejs stream input adapter for " + filename); + this._upstreamEnded = false; + this._bindStream(stream); +} + +utils.inherits(NodejsStreamInputAdapter, GenericWorker); + +/** + * Prepare the stream and bind the callbacks on it. + * Do this ASAP on node 0.10 ! A lazy binding doesn't always work. + * @param {Stream} stream the nodejs stream to use. + */ +NodejsStreamInputAdapter.prototype._bindStream = function (stream) { + var self = this; + this._stream = stream; + stream.pause(); + stream + .on("data", function (chunk) { + self.push({ + data: chunk, + meta : { + percent : 0 + } + }); + }) + .on("error", function (e) { + if(self.isPaused) { + this.generatedError = e; + } else { + self.error(e); + } + }) + .on("end", function () { + if(self.isPaused) { + self._upstreamEnded = true; + } else { + self.end(); + } + }); +}; +NodejsStreamInputAdapter.prototype.pause = function () { + if(!GenericWorker.prototype.pause.call(this)) { + return false; + } + this._stream.pause(); + return true; +}; +NodejsStreamInputAdapter.prototype.resume = function () { + if(!GenericWorker.prototype.resume.call(this)) { + return false; + } + + if(this._upstreamEnded) { + this.end(); + } else { + this._stream.resume(); + } + + return true; +}; + +module.exports = NodejsStreamInputAdapter; + +},{"../stream/GenericWorker":28,"../utils":32}],13:[function(require,module,exports){ +'use strict'; + +var Readable = require('readable-stream').Readable; + +var utils = require('../utils'); +utils.inherits(NodejsStreamOutputAdapter, Readable); + +/** +* A nodejs stream using a worker as source. +* @see the SourceWrapper in http://nodejs.org/api/stream.html +* @constructor +* @param {StreamHelper} helper the helper wrapping the worker +* @param {Object} options the nodejs stream options +* @param {Function} updateCb the update callback. +*/ +function NodejsStreamOutputAdapter(helper, options, updateCb) { + Readable.call(this, options); + this._helper = helper; + + var self = this; + helper.on("data", function (data, meta) { + if (!self.push(data)) { + self._helper.pause(); + } + if(updateCb) { + updateCb(meta); + } + }) + .on("error", function(e) { + self.emit('error', e); + }) + .on("end", function () { + self.push(null); + }); +} + + +NodejsStreamOutputAdapter.prototype._read = function() { + this._helper.resume(); +}; + +module.exports = NodejsStreamOutputAdapter; + +},{"../utils":32,"readable-stream":16}],14:[function(require,module,exports){ +'use strict'; + +module.exports = { + /** + * True if this is running in Nodejs, will be undefined in a browser. + * In a browser, browserify won't include this file and the whole module + * will be resolved an empty object. + */ + isNode : typeof Buffer !== "undefined", + /** + * Create a new nodejs Buffer from an existing content. + * @param {Object} data the data to pass to the constructor. + * @param {String} encoding the encoding to use. + * @return {Buffer} a new Buffer. + */ + newBufferFrom: function(data, encoding) { + if (Buffer.from && Buffer.from !== Uint8Array.from) { + return Buffer.from(data, encoding); + } else { + if (typeof data === "number") { + // Safeguard for old Node.js versions. On newer versions, + // Buffer.from(number) / Buffer(number, encoding) already throw. + throw new Error("The \"data\" argument must not be a number"); + } + return new Buffer(data, encoding); + } + }, + /** + * Create a new nodejs Buffer with the specified size. + * @param {Integer} size the size of the buffer. + * @return {Buffer} a new Buffer. + */ + allocBuffer: function (size) { + if (Buffer.alloc) { + return Buffer.alloc(size); + } else { + var buf = new Buffer(size); + buf.fill(0); + return buf; + } + }, + /** + * Find out if an object is a Buffer. + * @param {Object} b the object to test. + * @return {Boolean} true if the object is a Buffer, false otherwise. + */ + isBuffer : function(b){ + return Buffer.isBuffer(b); + }, + + isStream : function (obj) { + return obj && + typeof obj.on === "function" && + typeof obj.pause === "function" && + typeof obj.resume === "function"; + } +}; + +},{}],15:[function(require,module,exports){ +'use strict'; +var utf8 = require('./utf8'); +var utils = require('./utils'); +var GenericWorker = require('./stream/GenericWorker'); +var StreamHelper = require('./stream/StreamHelper'); +var defaults = require('./defaults'); +var CompressedObject = require('./compressedObject'); +var ZipObject = require('./zipObject'); +var generate = require("./generate"); +var nodejsUtils = require("./nodejsUtils"); +var NodejsStreamInputAdapter = require("./nodejs/NodejsStreamInputAdapter"); + + +/** + * Add a file in the current folder. + * @private + * @param {string} name the name of the file + * @param {String|ArrayBuffer|Uint8Array|Buffer} data the data of the file + * @param {Object} originalOptions the options of the file + * @return {Object} the new file. + */ +var fileAdd = function(name, data, originalOptions) { + // be sure sub folders exist + var dataType = utils.getTypeOf(data), + parent; + + + /* + * Correct options. + */ + + var o = utils.extend(originalOptions || {}, defaults); + o.date = o.date || new Date(); + if (o.compression !== null) { + o.compression = o.compression.toUpperCase(); + } + + if (typeof o.unixPermissions === "string") { + o.unixPermissions = parseInt(o.unixPermissions, 8); + } + + // UNX_IFDIR 0040000 see zipinfo.c + if (o.unixPermissions && (o.unixPermissions & 0x4000)) { + o.dir = true; + } + // Bit 4 Directory + if (o.dosPermissions && (o.dosPermissions & 0x0010)) { + o.dir = true; + } + + if (o.dir) { + name = forceTrailingSlash(name); + } + if (o.createFolders && (parent = parentFolder(name))) { + folderAdd.call(this, parent, true); + } + + var isUnicodeString = dataType === "string" && o.binary === false && o.base64 === false; + if (!originalOptions || typeof originalOptions.binary === "undefined") { + o.binary = !isUnicodeString; + } + + + var isCompressedEmpty = (data instanceof CompressedObject) && data.uncompressedSize === 0; + + if (isCompressedEmpty || o.dir || !data || data.length === 0) { + o.base64 = false; + o.binary = true; + data = ""; + o.compression = "STORE"; + dataType = "string"; + } + + /* + * Convert content to fit. + */ + + var zipObjectContent = null; + if (data instanceof CompressedObject || data instanceof GenericWorker) { + zipObjectContent = data; + } else if (nodejsUtils.isNode && nodejsUtils.isStream(data)) { + zipObjectContent = new NodejsStreamInputAdapter(name, data); + } else { + zipObjectContent = utils.prepareContent(name, data, o.binary, o.optimizedBinaryString, o.base64); + } + + var object = new ZipObject(name, zipObjectContent, o); + this.files[name] = object; + /* + TODO: we can't throw an exception because we have async promises + (we can have a promise of a Date() for example) but returning a + promise is useless because file(name, data) returns the JSZip + object for chaining. Should we break that to allow the user + to catch the error ? + + return external.Promise.resolve(zipObjectContent) + .then(function () { + return object; + }); + */ +}; + +/** + * Find the parent folder of the path. + * @private + * @param {string} path the path to use + * @return {string} the parent folder, or "" + */ +var parentFolder = function (path) { + if (path.slice(-1) === '/') { + path = path.substring(0, path.length - 1); + } + var lastSlash = path.lastIndexOf('/'); + return (lastSlash > 0) ? path.substring(0, lastSlash) : ""; +}; + +/** + * Returns the path with a slash at the end. + * @private + * @param {String} path the path to check. + * @return {String} the path with a trailing slash. + */ +var forceTrailingSlash = function(path) { + // Check the name ends with a / + if (path.slice(-1) !== "/") { + path += "/"; // IE doesn't like substr(-1) + } + return path; +}; + +/** + * Add a (sub) folder in the current folder. + * @private + * @param {string} name the folder's name + * @param {boolean=} [createFolders] If true, automatically create sub + * folders. Defaults to false. + * @return {Object} the new folder. + */ +var folderAdd = function(name, createFolders) { + createFolders = (typeof createFolders !== 'undefined') ? createFolders : defaults.createFolders; + + name = forceTrailingSlash(name); + + // Does this folder already exist? + if (!this.files[name]) { + fileAdd.call(this, name, null, { + dir: true, + createFolders: createFolders + }); + } + return this.files[name]; +}; + +/** +* Cross-window, cross-Node-context regular expression detection +* @param {Object} object Anything +* @return {Boolean} true if the object is a regular expression, +* false otherwise +*/ +function isRegExp(object) { + return Object.prototype.toString.call(object) === "[object RegExp]"; +} + +// return the actual prototype of JSZip +var out = { + /** + * @see loadAsync + */ + load: function() { + throw new Error("This method has been removed in JSZip 3.0, please check the upgrade guide."); + }, + + + /** + * Call a callback function for each entry at this folder level. + * @param {Function} cb the callback function: + * function (relativePath, file) {...} + * It takes 2 arguments : the relative path and the file. + */ + forEach: function(cb) { + var filename, relativePath, file; + /* jshint ignore:start */ + // ignore warning about unwanted properties because this.files is a null prototype object + for (filename in this.files) { + file = this.files[filename]; + relativePath = filename.slice(this.root.length, filename.length); + if (relativePath && filename.slice(0, this.root.length) === this.root) { // the file is in the current root + cb(relativePath, file); // TODO reverse the parameters ? need to be clean AND consistent with the filter search fn... + } + } + /* jshint ignore:end */ + }, + + /** + * Filter nested files/folders with the specified function. + * @param {Function} search the predicate to use : + * function (relativePath, file) {...} + * It takes 2 arguments : the relative path and the file. + * @return {Array} An array of matching elements. + */ + filter: function(search) { + var result = []; + this.forEach(function (relativePath, entry) { + if (search(relativePath, entry)) { // the file matches the function + result.push(entry); + } + + }); + return result; + }, + + /** + * Add a file to the zip file, or search a file. + * @param {string|RegExp} name The name of the file to add (if data is defined), + * the name of the file to find (if no data) or a regex to match files. + * @param {String|ArrayBuffer|Uint8Array|Buffer} data The file data, either raw or base64 encoded + * @param {Object} o File options + * @return {JSZip|Object|Array} this JSZip object (when adding a file), + * a file (when searching by string) or an array of files (when searching by regex). + */ + file: function(name, data, o) { + if (arguments.length === 1) { + if (isRegExp(name)) { + var regexp = name; + return this.filter(function(relativePath, file) { + return !file.dir && regexp.test(relativePath); + }); + } + else { // text + var obj = this.files[this.root + name]; + if (obj && !obj.dir) { + return obj; + } else { + return null; + } + } + } + else { // more than one argument : we have data ! + name = this.root + name; + fileAdd.call(this, name, data, o); + } + return this; + }, + + /** + * Add a directory to the zip file, or search. + * @param {String|RegExp} arg The name of the directory to add, or a regex to search folders. + * @return {JSZip} an object with the new directory as the root, or an array containing matching folders. + */ + folder: function(arg) { + if (!arg) { + return this; + } + + if (isRegExp(arg)) { + return this.filter(function(relativePath, file) { + return file.dir && arg.test(relativePath); + }); + } + + // else, name is a new folder + var name = this.root + arg; + var newFolder = folderAdd.call(this, name); + + // Allow chaining by returning a new object with this folder as the root + var ret = this.clone(); + ret.root = newFolder.name; + return ret; + }, + + /** + * Delete a file, or a directory and all sub-files, from the zip + * @param {string} name the name of the file to delete + * @return {JSZip} this JSZip object + */ + remove: function(name) { + name = this.root + name; + var file = this.files[name]; + if (!file) { + // Look for any folders + if (name.slice(-1) !== "/") { + name += "/"; + } + file = this.files[name]; + } + + if (file && !file.dir) { + // file + delete this.files[name]; + } else { + // maybe a folder, delete recursively + var kids = this.filter(function(relativePath, file) { + return file.name.slice(0, name.length) === name; + }); + for (var i = 0; i < kids.length; i++) { + delete this.files[kids[i].name]; + } + } + + return this; + }, + + /** + * Generate the complete zip file + * @param {Object} options the options to generate the zip file : + * - compression, "STORE" by default. + * - type, "base64" by default. Values are : string, base64, uint8array, arraybuffer, blob. + * @return {String|Uint8Array|ArrayBuffer|Buffer|Blob} the zip file + */ + generate: function(options) { + throw new Error("This method has been removed in JSZip 3.0, please check the upgrade guide."); + }, + + /** + * Generate the complete zip file as an internal stream. + * @param {Object} options the options to generate the zip file : + * - compression, "STORE" by default. + * - type, "base64" by default. Values are : string, base64, uint8array, arraybuffer, blob. + * @return {StreamHelper} the streamed zip file. + */ + generateInternalStream: function(options) { + var worker, opts = {}; + try { + opts = utils.extend(options || {}, { + streamFiles: false, + compression: "STORE", + compressionOptions : null, + type: "", + platform: "DOS", + comment: null, + mimeType: 'application/zip', + encodeFileName: utf8.utf8encode + }); + + opts.type = opts.type.toLowerCase(); + opts.compression = opts.compression.toUpperCase(); + + // "binarystring" is preferred but the internals use "string". + if(opts.type === "binarystring") { + opts.type = "string"; + } + + if (!opts.type) { + throw new Error("No output type specified."); + } + + utils.checkSupport(opts.type); + + // accept nodejs `process.platform` + if( + opts.platform === 'darwin' || + opts.platform === 'freebsd' || + opts.platform === 'linux' || + opts.platform === 'sunos' + ) { + opts.platform = "UNIX"; + } + if (opts.platform === 'win32') { + opts.platform = "DOS"; + } + + var comment = opts.comment || this.comment || ""; + worker = generate.generateWorker(this, opts, comment); + } catch (e) { + worker = new GenericWorker("error"); + worker.error(e); + } + return new StreamHelper(worker, opts.type || "string", opts.mimeType); + }, + /** + * Generate the complete zip file asynchronously. + * @see generateInternalStream + */ + generateAsync: function(options, onUpdate) { + return this.generateInternalStream(options).accumulate(onUpdate); + }, + /** + * Generate the complete zip file asynchronously. + * @see generateInternalStream + */ + generateNodeStream: function(options, onUpdate) { + options = options || {}; + if (!options.type) { + options.type = "nodebuffer"; + } + return this.generateInternalStream(options).toNodejsStream(onUpdate); + } +}; +module.exports = out; + +},{"./compressedObject":2,"./defaults":5,"./generate":9,"./nodejs/NodejsStreamInputAdapter":12,"./nodejsUtils":14,"./stream/GenericWorker":28,"./stream/StreamHelper":29,"./utf8":31,"./utils":32,"./zipObject":35}],16:[function(require,module,exports){ +/* + * This file is used by module bundlers (browserify/webpack/etc) when + * including a stream implementation. We use "readable-stream" to get a + * consistent behavior between nodejs versions but bundlers often have a shim + * for "stream". Using this shim greatly improve the compatibility and greatly + * reduce the final size of the bundle (only one stream implementation, not + * two). + */ +module.exports = require("stream"); + +},{"stream":undefined}],17:[function(require,module,exports){ +'use strict'; +var DataReader = require('./DataReader'); +var utils = require('../utils'); + +function ArrayReader(data) { + DataReader.call(this, data); + for(var i = 0; i < this.data.length; i++) { + data[i] = data[i] & 0xFF; + } +} +utils.inherits(ArrayReader, DataReader); +/** + * @see DataReader.byteAt + */ +ArrayReader.prototype.byteAt = function(i) { + return this.data[this.zero + i]; +}; +/** + * @see DataReader.lastIndexOfSignature + */ +ArrayReader.prototype.lastIndexOfSignature = function(sig) { + var sig0 = sig.charCodeAt(0), + sig1 = sig.charCodeAt(1), + sig2 = sig.charCodeAt(2), + sig3 = sig.charCodeAt(3); + for (var i = this.length - 4; i >= 0; --i) { + if (this.data[i] === sig0 && this.data[i + 1] === sig1 && this.data[i + 2] === sig2 && this.data[i + 3] === sig3) { + return i - this.zero; + } + } + + return -1; +}; +/** + * @see DataReader.readAndCheckSignature + */ +ArrayReader.prototype.readAndCheckSignature = function (sig) { + var sig0 = sig.charCodeAt(0), + sig1 = sig.charCodeAt(1), + sig2 = sig.charCodeAt(2), + sig3 = sig.charCodeAt(3), + data = this.readData(4); + return sig0 === data[0] && sig1 === data[1] && sig2 === data[2] && sig3 === data[3]; +}; +/** + * @see DataReader.readData + */ +ArrayReader.prototype.readData = function(size) { + this.checkOffset(size); + if(size === 0) { + return []; + } + var result = this.data.slice(this.zero + this.index, this.zero + this.index + size); + this.index += size; + return result; +}; +module.exports = ArrayReader; + +},{"../utils":32,"./DataReader":18}],18:[function(require,module,exports){ +'use strict'; +var utils = require('../utils'); + +function DataReader(data) { + this.data = data; // type : see implementation + this.length = data.length; + this.index = 0; + this.zero = 0; +} +DataReader.prototype = { + /** + * Check that the offset will not go too far. + * @param {string} offset the additional offset to check. + * @throws {Error} an Error if the offset is out of bounds. + */ + checkOffset: function(offset) { + this.checkIndex(this.index + offset); + }, + /** + * Check that the specified index will not be too far. + * @param {string} newIndex the index to check. + * @throws {Error} an Error if the index is out of bounds. + */ + checkIndex: function(newIndex) { + if (this.length < this.zero + newIndex || newIndex < 0) { + throw new Error("End of data reached (data length = " + this.length + ", asked index = " + (newIndex) + "). Corrupted zip ?"); + } + }, + /** + * Change the index. + * @param {number} newIndex The new index. + * @throws {Error} if the new index is out of the data. + */ + setIndex: function(newIndex) { + this.checkIndex(newIndex); + this.index = newIndex; + }, + /** + * Skip the next n bytes. + * @param {number} n the number of bytes to skip. + * @throws {Error} if the new index is out of the data. + */ + skip: function(n) { + this.setIndex(this.index + n); + }, + /** + * Get the byte at the specified index. + * @param {number} i the index to use. + * @return {number} a byte. + */ + byteAt: function(i) { + // see implementations + }, + /** + * Get the next number with a given byte size. + * @param {number} size the number of bytes to read. + * @return {number} the corresponding number. + */ + readInt: function(size) { + var result = 0, + i; + this.checkOffset(size); + for (i = this.index + size - 1; i >= this.index; i--) { + result = (result << 8) + this.byteAt(i); + } + this.index += size; + return result; + }, + /** + * Get the next string with a given byte size. + * @param {number} size the number of bytes to read. + * @return {string} the corresponding string. + */ + readString: function(size) { + return utils.transformTo("string", this.readData(size)); + }, + /** + * Get raw data without conversion, bytes. + * @param {number} size the number of bytes to read. + * @return {Object} the raw data, implementation specific. + */ + readData: function(size) { + // see implementations + }, + /** + * Find the last occurrence of a zip signature (4 bytes). + * @param {string} sig the signature to find. + * @return {number} the index of the last occurrence, -1 if not found. + */ + lastIndexOfSignature: function(sig) { + // see implementations + }, + /** + * Read the signature (4 bytes) at the current position and compare it with sig. + * @param {string} sig the expected signature + * @return {boolean} true if the signature matches, false otherwise. + */ + readAndCheckSignature: function(sig) { + // see implementations + }, + /** + * Get the next date. + * @return {Date} the date. + */ + readDate: function() { + var dostime = this.readInt(4); + return new Date(Date.UTC( + ((dostime >> 25) & 0x7f) + 1980, // year + ((dostime >> 21) & 0x0f) - 1, // month + (dostime >> 16) & 0x1f, // day + (dostime >> 11) & 0x1f, // hour + (dostime >> 5) & 0x3f, // minute + (dostime & 0x1f) << 1)); // second + } +}; +module.exports = DataReader; + +},{"../utils":32}],19:[function(require,module,exports){ +'use strict'; +var Uint8ArrayReader = require('./Uint8ArrayReader'); +var utils = require('../utils'); + +function NodeBufferReader(data) { + Uint8ArrayReader.call(this, data); +} +utils.inherits(NodeBufferReader, Uint8ArrayReader); + +/** + * @see DataReader.readData + */ +NodeBufferReader.prototype.readData = function(size) { + this.checkOffset(size); + var result = this.data.slice(this.zero + this.index, this.zero + this.index + size); + this.index += size; + return result; +}; +module.exports = NodeBufferReader; + +},{"../utils":32,"./Uint8ArrayReader":21}],20:[function(require,module,exports){ +'use strict'; +var DataReader = require('./DataReader'); +var utils = require('../utils'); + +function StringReader(data) { + DataReader.call(this, data); +} +utils.inherits(StringReader, DataReader); +/** + * @see DataReader.byteAt + */ +StringReader.prototype.byteAt = function(i) { + return this.data.charCodeAt(this.zero + i); +}; +/** + * @see DataReader.lastIndexOfSignature + */ +StringReader.prototype.lastIndexOfSignature = function(sig) { + return this.data.lastIndexOf(sig) - this.zero; +}; +/** + * @see DataReader.readAndCheckSignature + */ +StringReader.prototype.readAndCheckSignature = function (sig) { + var data = this.readData(4); + return sig === data; +}; +/** + * @see DataReader.readData + */ +StringReader.prototype.readData = function(size) { + this.checkOffset(size); + // this will work because the constructor applied the "& 0xff" mask. + var result = this.data.slice(this.zero + this.index, this.zero + this.index + size); + this.index += size; + return result; +}; +module.exports = StringReader; + +},{"../utils":32,"./DataReader":18}],21:[function(require,module,exports){ +'use strict'; +var ArrayReader = require('./ArrayReader'); +var utils = require('../utils'); + +function Uint8ArrayReader(data) { + ArrayReader.call(this, data); +} +utils.inherits(Uint8ArrayReader, ArrayReader); +/** + * @see DataReader.readData + */ +Uint8ArrayReader.prototype.readData = function(size) { + this.checkOffset(size); + if(size === 0) { + // in IE10, when using subarray(idx, idx), we get the array [0x00] instead of []. + return new Uint8Array(0); + } + var result = this.data.subarray(this.zero + this.index, this.zero + this.index + size); + this.index += size; + return result; +}; +module.exports = Uint8ArrayReader; + +},{"../utils":32,"./ArrayReader":17}],22:[function(require,module,exports){ +'use strict'; + +var utils = require('../utils'); +var support = require('../support'); +var ArrayReader = require('./ArrayReader'); +var StringReader = require('./StringReader'); +var NodeBufferReader = require('./NodeBufferReader'); +var Uint8ArrayReader = require('./Uint8ArrayReader'); + +/** + * Create a reader adapted to the data. + * @param {String|ArrayBuffer|Uint8Array|Buffer} data the data to read. + * @return {DataReader} the data reader. + */ +module.exports = function (data) { + var type = utils.getTypeOf(data); + utils.checkSupport(type); + if (type === "string" && !support.uint8array) { + return new StringReader(data); + } + if (type === "nodebuffer") { + return new NodeBufferReader(data); + } + if (support.uint8array) { + return new Uint8ArrayReader(utils.transformTo("uint8array", data)); + } + return new ArrayReader(utils.transformTo("array", data)); +}; + +},{"../support":30,"../utils":32,"./ArrayReader":17,"./NodeBufferReader":19,"./StringReader":20,"./Uint8ArrayReader":21}],23:[function(require,module,exports){ +'use strict'; +exports.LOCAL_FILE_HEADER = "PK\x03\x04"; +exports.CENTRAL_FILE_HEADER = "PK\x01\x02"; +exports.CENTRAL_DIRECTORY_END = "PK\x05\x06"; +exports.ZIP64_CENTRAL_DIRECTORY_LOCATOR = "PK\x06\x07"; +exports.ZIP64_CENTRAL_DIRECTORY_END = "PK\x06\x06"; +exports.DATA_DESCRIPTOR = "PK\x07\x08"; + +},{}],24:[function(require,module,exports){ +'use strict'; + +var GenericWorker = require('./GenericWorker'); +var utils = require('../utils'); + +/** + * A worker which convert chunks to a specified type. + * @constructor + * @param {String} destType the destination type. + */ +function ConvertWorker(destType) { + GenericWorker.call(this, "ConvertWorker to " + destType); + this.destType = destType; +} +utils.inherits(ConvertWorker, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +ConvertWorker.prototype.processChunk = function (chunk) { + this.push({ + data : utils.transformTo(this.destType, chunk.data), + meta : chunk.meta + }); +}; +module.exports = ConvertWorker; + +},{"../utils":32,"./GenericWorker":28}],25:[function(require,module,exports){ +'use strict'; + +var GenericWorker = require('./GenericWorker'); +var crc32 = require('../crc32'); +var utils = require('../utils'); + +/** + * A worker which calculate the crc32 of the data flowing through. + * @constructor + */ +function Crc32Probe() { + GenericWorker.call(this, "Crc32Probe"); + this.withStreamInfo("crc32", 0); +} +utils.inherits(Crc32Probe, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +Crc32Probe.prototype.processChunk = function (chunk) { + this.streamInfo.crc32 = crc32(chunk.data, this.streamInfo.crc32 || 0); + this.push(chunk); +}; +module.exports = Crc32Probe; + +},{"../crc32":4,"../utils":32,"./GenericWorker":28}],26:[function(require,module,exports){ +'use strict'; + +var utils = require('../utils'); +var GenericWorker = require('./GenericWorker'); + +/** + * A worker which calculate the total length of the data flowing through. + * @constructor + * @param {String} propName the name used to expose the length + */ +function DataLengthProbe(propName) { + GenericWorker.call(this, "DataLengthProbe for " + propName); + this.propName = propName; + this.withStreamInfo(propName, 0); +} +utils.inherits(DataLengthProbe, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +DataLengthProbe.prototype.processChunk = function (chunk) { + if(chunk) { + var length = this.streamInfo[this.propName] || 0; + this.streamInfo[this.propName] = length + chunk.data.length; + } + GenericWorker.prototype.processChunk.call(this, chunk); +}; +module.exports = DataLengthProbe; + + +},{"../utils":32,"./GenericWorker":28}],27:[function(require,module,exports){ +'use strict'; + +var utils = require('../utils'); +var GenericWorker = require('./GenericWorker'); + +// the size of the generated chunks +// TODO expose this as a public variable +var DEFAULT_BLOCK_SIZE = 16 * 1024; + +/** + * A worker that reads a content and emits chunks. + * @constructor + * @param {Promise} dataP the promise of the data to split + */ +function DataWorker(dataP) { + GenericWorker.call(this, "DataWorker"); + var self = this; + this.dataIsReady = false; + this.index = 0; + this.max = 0; + this.data = null; + this.type = ""; + + this._tickScheduled = false; + + dataP.then(function (data) { + self.dataIsReady = true; + self.data = data; + self.max = data && data.length || 0; + self.type = utils.getTypeOf(data); + if(!self.isPaused) { + self._tickAndRepeat(); + } + }, function (e) { + self.error(e); + }); +} + +utils.inherits(DataWorker, GenericWorker); + +/** + * @see GenericWorker.cleanUp + */ +DataWorker.prototype.cleanUp = function () { + GenericWorker.prototype.cleanUp.call(this); + this.data = null; +}; + +/** + * @see GenericWorker.resume + */ +DataWorker.prototype.resume = function () { + if(!GenericWorker.prototype.resume.call(this)) { + return false; + } + + if (!this._tickScheduled && this.dataIsReady) { + this._tickScheduled = true; + utils.delay(this._tickAndRepeat, [], this); + } + return true; +}; + +/** + * Trigger a tick a schedule an other call to this function. + */ +DataWorker.prototype._tickAndRepeat = function() { + this._tickScheduled = false; + if(this.isPaused || this.isFinished) { + return; + } + this._tick(); + if(!this.isFinished) { + utils.delay(this._tickAndRepeat, [], this); + this._tickScheduled = true; + } +}; + +/** + * Read and push a chunk. + */ +DataWorker.prototype._tick = function() { + + if(this.isPaused || this.isFinished) { + return false; + } + + var size = DEFAULT_BLOCK_SIZE; + var data = null, nextIndex = Math.min(this.max, this.index + size); + if (this.index >= this.max) { + // EOF + return this.end(); + } else { + switch(this.type) { + case "string": + data = this.data.substring(this.index, nextIndex); + break; + case "uint8array": + data = this.data.subarray(this.index, nextIndex); + break; + case "array": + case "nodebuffer": + data = this.data.slice(this.index, nextIndex); + break; + } + this.index = nextIndex; + return this.push({ + data : data, + meta : { + percent : this.max ? this.index / this.max * 100 : 0 + } + }); + } +}; + +module.exports = DataWorker; + +},{"../utils":32,"./GenericWorker":28}],28:[function(require,module,exports){ +'use strict'; + +/** + * A worker that does nothing but passing chunks to the next one. This is like + * a nodejs stream but with some differences. On the good side : + * - it works on IE 6-9 without any issue / polyfill + * - it weights less than the full dependencies bundled with browserify + * - it forwards errors (no need to declare an error handler EVERYWHERE) + * + * A chunk is an object with 2 attributes : `meta` and `data`. The former is an + * object containing anything (`percent` for example), see each worker for more + * details. The latter is the real data (String, Uint8Array, etc). + * + * @constructor + * @param {String} name the name of the stream (mainly used for debugging purposes) + */ +function GenericWorker(name) { + // the name of the worker + this.name = name || "default"; + // an object containing metadata about the workers chain + this.streamInfo = {}; + // an error which happened when the worker was paused + this.generatedError = null; + // an object containing metadata to be merged by this worker into the general metadata + this.extraStreamInfo = {}; + // true if the stream is paused (and should not do anything), false otherwise + this.isPaused = true; + // true if the stream is finished (and should not do anything), false otherwise + this.isFinished = false; + // true if the stream is locked to prevent further structure updates (pipe), false otherwise + this.isLocked = false; + // the event listeners + this._listeners = { + 'data':[], + 'end':[], + 'error':[] + }; + // the previous worker, if any + this.previous = null; +} + +GenericWorker.prototype = { + /** + * Push a chunk to the next workers. + * @param {Object} chunk the chunk to push + */ + push : function (chunk) { + this.emit("data", chunk); + }, + /** + * End the stream. + * @return {Boolean} true if this call ended the worker, false otherwise. + */ + end : function () { + if (this.isFinished) { + return false; + } + + this.flush(); + try { + this.emit("end"); + this.cleanUp(); + this.isFinished = true; + } catch (e) { + this.emit("error", e); + } + return true; + }, + /** + * End the stream with an error. + * @param {Error} e the error which caused the premature end. + * @return {Boolean} true if this call ended the worker with an error, false otherwise. + */ + error : function (e) { + if (this.isFinished) { + return false; + } + + if(this.isPaused) { + this.generatedError = e; + } else { + this.isFinished = true; + + this.emit("error", e); + + // in the workers chain exploded in the middle of the chain, + // the error event will go downward but we also need to notify + // workers upward that there has been an error. + if(this.previous) { + this.previous.error(e); + } + + this.cleanUp(); + } + return true; + }, + /** + * Add a callback on an event. + * @param {String} name the name of the event (data, end, error) + * @param {Function} listener the function to call when the event is triggered + * @return {GenericWorker} the current object for chainability + */ + on : function (name, listener) { + this._listeners[name].push(listener); + return this; + }, + /** + * Clean any references when a worker is ending. + */ + cleanUp : function () { + this.streamInfo = this.generatedError = this.extraStreamInfo = null; + this._listeners = []; + }, + /** + * Trigger an event. This will call registered callback with the provided arg. + * @param {String} name the name of the event (data, end, error) + * @param {Object} arg the argument to call the callback with. + */ + emit : function (name, arg) { + if (this._listeners[name]) { + for(var i = 0; i < this._listeners[name].length; i++) { + this._listeners[name][i].call(this, arg); + } + } + }, + /** + * Chain a worker with an other. + * @param {Worker} next the worker receiving events from the current one. + * @return {worker} the next worker for chainability + */ + pipe : function (next) { + return next.registerPrevious(this); + }, + /** + * Same as `pipe` in the other direction. + * Using an API with `pipe(next)` is very easy. + * Implementing the API with the point of view of the next one registering + * a source is easier, see the ZipFileWorker. + * @param {Worker} previous the previous worker, sending events to this one + * @return {Worker} the current worker for chainability + */ + registerPrevious : function (previous) { + if (this.isLocked) { + throw new Error("The stream '" + this + "' has already been used."); + } + + // sharing the streamInfo... + this.streamInfo = previous.streamInfo; + // ... and adding our own bits + this.mergeStreamInfo(); + this.previous = previous; + var self = this; + previous.on('data', function (chunk) { + self.processChunk(chunk); + }); + previous.on('end', function () { + self.end(); + }); + previous.on('error', function (e) { + self.error(e); + }); + return this; + }, + /** + * Pause the stream so it doesn't send events anymore. + * @return {Boolean} true if this call paused the worker, false otherwise. + */ + pause : function () { + if(this.isPaused || this.isFinished) { + return false; + } + this.isPaused = true; + + if(this.previous) { + this.previous.pause(); + } + return true; + }, + /** + * Resume a paused stream. + * @return {Boolean} true if this call resumed the worker, false otherwise. + */ + resume : function () { + if(!this.isPaused || this.isFinished) { + return false; + } + this.isPaused = false; + + // if true, the worker tried to resume but failed + var withError = false; + if(this.generatedError) { + this.error(this.generatedError); + withError = true; + } + if(this.previous) { + this.previous.resume(); + } + + return !withError; + }, + /** + * Flush any remaining bytes as the stream is ending. + */ + flush : function () {}, + /** + * Process a chunk. This is usually the method overridden. + * @param {Object} chunk the chunk to process. + */ + processChunk : function(chunk) { + this.push(chunk); + }, + /** + * Add a key/value to be added in the workers chain streamInfo once activated. + * @param {String} key the key to use + * @param {Object} value the associated value + * @return {Worker} the current worker for chainability + */ + withStreamInfo : function (key, value) { + this.extraStreamInfo[key] = value; + this.mergeStreamInfo(); + return this; + }, + /** + * Merge this worker's streamInfo into the chain's streamInfo. + */ + mergeStreamInfo : function () { + for(var key in this.extraStreamInfo) { + if (!this.extraStreamInfo.hasOwnProperty(key)) { + continue; + } + this.streamInfo[key] = this.extraStreamInfo[key]; + } + }, + + /** + * Lock the stream to prevent further updates on the workers chain. + * After calling this method, all calls to pipe will fail. + */ + lock: function () { + if (this.isLocked) { + throw new Error("The stream '" + this + "' has already been used."); + } + this.isLocked = true; + if (this.previous) { + this.previous.lock(); + } + }, + + /** + * + * Pretty print the workers chain. + */ + toString : function () { + var me = "Worker " + this.name; + if (this.previous) { + return this.previous + " -> " + me; + } else { + return me; + } + } +}; + +module.exports = GenericWorker; + +},{}],29:[function(require,module,exports){ +'use strict'; + +var utils = require('../utils'); +var ConvertWorker = require('./ConvertWorker'); +var GenericWorker = require('./GenericWorker'); +var base64 = require('../base64'); +var support = require("../support"); +var external = require("../external"); + +var NodejsStreamOutputAdapter = null; +if (support.nodestream) { + try { + NodejsStreamOutputAdapter = require('../nodejs/NodejsStreamOutputAdapter'); + } catch(e) {} +} + +/** + * Apply the final transformation of the data. If the user wants a Blob for + * example, it's easier to work with an U8intArray and finally do the + * ArrayBuffer/Blob conversion. + * @param {String} type the name of the final type + * @param {String|Uint8Array|Buffer} content the content to transform + * @param {String} mimeType the mime type of the content, if applicable. + * @return {String|Uint8Array|ArrayBuffer|Buffer|Blob} the content in the right format. + */ +function transformZipOutput(type, content, mimeType) { + switch(type) { + case "blob" : + return utils.newBlob(utils.transformTo("arraybuffer", content), mimeType); + case "base64" : + return base64.encode(content); + default : + return utils.transformTo(type, content); + } +} + +/** + * Concatenate an array of data of the given type. + * @param {String} type the type of the data in the given array. + * @param {Array} dataArray the array containing the data chunks to concatenate + * @return {String|Uint8Array|Buffer} the concatenated data + * @throws Error if the asked type is unsupported + */ +function concat (type, dataArray) { + var i, index = 0, res = null, totalLength = 0; + for(i = 0; i < dataArray.length; i++) { + totalLength += dataArray[i].length; + } + switch(type) { + case "string": + return dataArray.join(""); + case "array": + return Array.prototype.concat.apply([], dataArray); + case "uint8array": + res = new Uint8Array(totalLength); + for(i = 0; i < dataArray.length; i++) { + res.set(dataArray[i], index); + index += dataArray[i].length; + } + return res; + case "nodebuffer": + return Buffer.concat(dataArray); + default: + throw new Error("concat : unsupported type '" + type + "'"); + } +} + +/** + * Listen a StreamHelper, accumulate its content and concatenate it into a + * complete block. + * @param {StreamHelper} helper the helper to use. + * @param {Function} updateCallback a callback called on each update. Called + * with one arg : + * - the metadata linked to the update received. + * @return Promise the promise for the accumulation. + */ +function accumulate(helper, updateCallback) { + return new external.Promise(function (resolve, reject){ + var dataArray = []; + var chunkType = helper._internalType, + resultType = helper._outputType, + mimeType = helper._mimeType; + helper + .on('data', function (data, meta) { + dataArray.push(data); + if(updateCallback) { + updateCallback(meta); + } + }) + .on('error', function(err) { + dataArray = []; + reject(err); + }) + .on('end', function (){ + try { + var result = transformZipOutput(resultType, concat(chunkType, dataArray), mimeType); + resolve(result); + } catch (e) { + reject(e); + } + dataArray = []; + }) + .resume(); + }); +} + +/** + * An helper to easily use workers outside of JSZip. + * @constructor + * @param {Worker} worker the worker to wrap + * @param {String} outputType the type of data expected by the use + * @param {String} mimeType the mime type of the content, if applicable. + */ +function StreamHelper(worker, outputType, mimeType) { + var internalType = outputType; + switch(outputType) { + case "blob": + case "arraybuffer": + internalType = "uint8array"; + break; + case "base64": + internalType = "string"; + break; + } + + try { + // the type used internally + this._internalType = internalType; + // the type used to output results + this._outputType = outputType; + // the mime type + this._mimeType = mimeType; + utils.checkSupport(internalType); + this._worker = worker.pipe(new ConvertWorker(internalType)); + // the last workers can be rewired without issues but we need to + // prevent any updates on previous workers. + worker.lock(); + } catch(e) { + this._worker = new GenericWorker("error"); + this._worker.error(e); + } +} + +StreamHelper.prototype = { + /** + * Listen a StreamHelper, accumulate its content and concatenate it into a + * complete block. + * @param {Function} updateCb the update callback. + * @return Promise the promise for the accumulation. + */ + accumulate : function (updateCb) { + return accumulate(this, updateCb); + }, + /** + * Add a listener on an event triggered on a stream. + * @param {String} evt the name of the event + * @param {Function} fn the listener + * @return {StreamHelper} the current helper. + */ + on : function (evt, fn) { + var self = this; + + if(evt === "data") { + this._worker.on(evt, function (chunk) { + fn.call(self, chunk.data, chunk.meta); + }); + } else { + this._worker.on(evt, function () { + utils.delay(fn, arguments, self); + }); + } + return this; + }, + /** + * Resume the flow of chunks. + * @return {StreamHelper} the current helper. + */ + resume : function () { + utils.delay(this._worker.resume, [], this._worker); + return this; + }, + /** + * Pause the flow of chunks. + * @return {StreamHelper} the current helper. + */ + pause : function () { + this._worker.pause(); + return this; + }, + /** + * Return a nodejs stream for this helper. + * @param {Function} updateCb the update callback. + * @return {NodejsStreamOutputAdapter} the nodejs stream. + */ + toNodejsStream : function (updateCb) { + utils.checkSupport("nodestream"); + if (this._outputType !== "nodebuffer") { + // an object stream containing blob/arraybuffer/uint8array/string + // is strange and I don't know if it would be useful. + // I you find this comment and have a good usecase, please open a + // bug report ! + throw new Error(this._outputType + " is not supported by this method"); + } + + return new NodejsStreamOutputAdapter(this, { + objectMode : this._outputType !== "nodebuffer" + }, updateCb); + } +}; + + +module.exports = StreamHelper; + +},{"../base64":1,"../external":6,"../nodejs/NodejsStreamOutputAdapter":13,"../support":30,"../utils":32,"./ConvertWorker":24,"./GenericWorker":28}],30:[function(require,module,exports){ +'use strict'; + +exports.base64 = true; +exports.array = true; +exports.string = true; +exports.arraybuffer = typeof ArrayBuffer !== "undefined" && typeof Uint8Array !== "undefined"; +exports.nodebuffer = typeof Buffer !== "undefined"; +// contains true if JSZip can read/generate Uint8Array, false otherwise. +exports.uint8array = typeof Uint8Array !== "undefined"; + +if (typeof ArrayBuffer === "undefined") { + exports.blob = false; +} +else { + var buffer = new ArrayBuffer(0); + try { + exports.blob = new Blob([buffer], { + type: "application/zip" + }).size === 0; + } + catch (e) { + try { + var Builder = self.BlobBuilder || self.WebKitBlobBuilder || self.MozBlobBuilder || self.MSBlobBuilder; + var builder = new Builder(); + builder.append(buffer); + exports.blob = builder.getBlob('application/zip').size === 0; + } + catch (e) { + exports.blob = false; + } + } +} + +try { + exports.nodestream = !!require('readable-stream').Readable; +} catch(e) { + exports.nodestream = false; +} + +},{"readable-stream":16}],31:[function(require,module,exports){ +'use strict'; + +var utils = require('./utils'); +var support = require('./support'); +var nodejsUtils = require('./nodejsUtils'); +var GenericWorker = require('./stream/GenericWorker'); + +/** + * The following functions come from pako, from pako/lib/utils/strings + * released under the MIT license, see pako https://github.com/nodeca/pako/ + */ + +// Table with utf8 lengths (calculated by first byte of sequence) +// Note, that 5 & 6-byte values and some 4-byte values can not be represented in JS, +// because max possible codepoint is 0x10ffff +var _utf8len = new Array(256); +for (var i=0; i<256; i++) { + _utf8len[i] = (i >= 252 ? 6 : i >= 248 ? 5 : i >= 240 ? 4 : i >= 224 ? 3 : i >= 192 ? 2 : 1); +} +_utf8len[254]=_utf8len[254]=1; // Invalid sequence start + +// convert string to array (typed, when possible) +var string2buf = function (str) { + var buf, c, c2, m_pos, i, str_len = str.length, buf_len = 0; + + // count binary size + for (m_pos = 0; m_pos < str_len; m_pos++) { + c = str.charCodeAt(m_pos); + if ((c & 0xfc00) === 0xd800 && (m_pos+1 < str_len)) { + c2 = str.charCodeAt(m_pos+1); + if ((c2 & 0xfc00) === 0xdc00) { + c = 0x10000 + ((c - 0xd800) << 10) + (c2 - 0xdc00); + m_pos++; + } + } + buf_len += c < 0x80 ? 1 : c < 0x800 ? 2 : c < 0x10000 ? 3 : 4; + } + + // allocate buffer + if (support.uint8array) { + buf = new Uint8Array(buf_len); + } else { + buf = new Array(buf_len); + } + + // convert + for (i=0, m_pos = 0; i < buf_len; m_pos++) { + c = str.charCodeAt(m_pos); + if ((c & 0xfc00) === 0xd800 && (m_pos+1 < str_len)) { + c2 = str.charCodeAt(m_pos+1); + if ((c2 & 0xfc00) === 0xdc00) { + c = 0x10000 + ((c - 0xd800) << 10) + (c2 - 0xdc00); + m_pos++; + } + } + if (c < 0x80) { + /* one byte */ + buf[i++] = c; + } else if (c < 0x800) { + /* two bytes */ + buf[i++] = 0xC0 | (c >>> 6); + buf[i++] = 0x80 | (c & 0x3f); + } else if (c < 0x10000) { + /* three bytes */ + buf[i++] = 0xE0 | (c >>> 12); + buf[i++] = 0x80 | (c >>> 6 & 0x3f); + buf[i++] = 0x80 | (c & 0x3f); + } else { + /* four bytes */ + buf[i++] = 0xf0 | (c >>> 18); + buf[i++] = 0x80 | (c >>> 12 & 0x3f); + buf[i++] = 0x80 | (c >>> 6 & 0x3f); + buf[i++] = 0x80 | (c & 0x3f); + } + } + + return buf; +}; + +// Calculate max possible position in utf8 buffer, +// that will not break sequence. If that's not possible +// - (very small limits) return max size as is. +// +// buf[] - utf8 bytes array +// max - length limit (mandatory); +var utf8border = function(buf, max) { + var pos; + + max = max || buf.length; + if (max > buf.length) { max = buf.length; } + + // go back from last position, until start of sequence found + pos = max-1; + while (pos >= 0 && (buf[pos] & 0xC0) === 0x80) { pos--; } + + // Fuckup - very small and broken sequence, + // return max, because we should return something anyway. + if (pos < 0) { return max; } + + // If we came to start of buffer - that means vuffer is too small, + // return max too. + if (pos === 0) { return max; } + + return (pos + _utf8len[buf[pos]] > max) ? pos : max; +}; + +// convert array to string +var buf2string = function (buf) { + var str, i, out, c, c_len; + var len = buf.length; + + // Reserve max possible length (2 words per char) + // NB: by unknown reasons, Array is significantly faster for + // String.fromCharCode.apply than Uint16Array. + var utf16buf = new Array(len*2); + + for (out=0, i=0; i 4) { utf16buf[out++] = 0xfffd; i += c_len-1; continue; } + + // apply mask on first byte + c &= c_len === 2 ? 0x1f : c_len === 3 ? 0x0f : 0x07; + // join the rest + while (c_len > 1 && i < len) { + c = (c << 6) | (buf[i++] & 0x3f); + c_len--; + } + + // terminated by end of string? + if (c_len > 1) { utf16buf[out++] = 0xfffd; continue; } + + if (c < 0x10000) { + utf16buf[out++] = c; + } else { + c -= 0x10000; + utf16buf[out++] = 0xd800 | ((c >> 10) & 0x3ff); + utf16buf[out++] = 0xdc00 | (c & 0x3ff); + } + } + + // shrinkBuf(utf16buf, out) + if (utf16buf.length !== out) { + if(utf16buf.subarray) { + utf16buf = utf16buf.subarray(0, out); + } else { + utf16buf.length = out; + } + } + + // return String.fromCharCode.apply(null, utf16buf); + return utils.applyFromCharCode(utf16buf); +}; + + +// That's all for the pako functions. + + +/** + * Transform a javascript string into an array (typed if possible) of bytes, + * UTF-8 encoded. + * @param {String} str the string to encode + * @return {Array|Uint8Array|Buffer} the UTF-8 encoded string. + */ +exports.utf8encode = function utf8encode(str) { + if (support.nodebuffer) { + return nodejsUtils.newBufferFrom(str, "utf-8"); + } + + return string2buf(str); +}; + + +/** + * Transform a bytes array (or a representation) representing an UTF-8 encoded + * string into a javascript string. + * @param {Array|Uint8Array|Buffer} buf the data de decode + * @return {String} the decoded string. + */ +exports.utf8decode = function utf8decode(buf) { + if (support.nodebuffer) { + return utils.transformTo("nodebuffer", buf).toString("utf-8"); + } + + buf = utils.transformTo(support.uint8array ? "uint8array" : "array", buf); + + return buf2string(buf); +}; + +/** + * A worker to decode utf8 encoded binary chunks into string chunks. + * @constructor + */ +function Utf8DecodeWorker() { + GenericWorker.call(this, "utf-8 decode"); + // the last bytes if a chunk didn't end with a complete codepoint. + this.leftOver = null; +} +utils.inherits(Utf8DecodeWorker, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +Utf8DecodeWorker.prototype.processChunk = function (chunk) { + + var data = utils.transformTo(support.uint8array ? "uint8array" : "array", chunk.data); + + // 1st step, re-use what's left of the previous chunk + if (this.leftOver && this.leftOver.length) { + if(support.uint8array) { + var previousData = data; + data = new Uint8Array(previousData.length + this.leftOver.length); + data.set(this.leftOver, 0); + data.set(previousData, this.leftOver.length); + } else { + data = this.leftOver.concat(data); + } + this.leftOver = null; + } + + var nextBoundary = utf8border(data); + var usableData = data; + if (nextBoundary !== data.length) { + if (support.uint8array) { + usableData = data.subarray(0, nextBoundary); + this.leftOver = data.subarray(nextBoundary, data.length); + } else { + usableData = data.slice(0, nextBoundary); + this.leftOver = data.slice(nextBoundary, data.length); + } + } + + this.push({ + data : exports.utf8decode(usableData), + meta : chunk.meta + }); +}; + +/** + * @see GenericWorker.flush + */ +Utf8DecodeWorker.prototype.flush = function () { + if(this.leftOver && this.leftOver.length) { + this.push({ + data : exports.utf8decode(this.leftOver), + meta : {} + }); + this.leftOver = null; + } +}; +exports.Utf8DecodeWorker = Utf8DecodeWorker; + +/** + * A worker to endcode string chunks into utf8 encoded binary chunks. + * @constructor + */ +function Utf8EncodeWorker() { + GenericWorker.call(this, "utf-8 encode"); +} +utils.inherits(Utf8EncodeWorker, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +Utf8EncodeWorker.prototype.processChunk = function (chunk) { + this.push({ + data : exports.utf8encode(chunk.data), + meta : chunk.meta + }); +}; +exports.Utf8EncodeWorker = Utf8EncodeWorker; + +},{"./nodejsUtils":14,"./stream/GenericWorker":28,"./support":30,"./utils":32}],32:[function(require,module,exports){ +'use strict'; + +var support = require('./support'); +var base64 = require('./base64'); +var nodejsUtils = require('./nodejsUtils'); +var setImmediate = require('set-immediate-shim'); +var external = require("./external"); + + +/** + * Convert a string that pass as a "binary string": it should represent a byte + * array but may have > 255 char codes. Be sure to take only the first byte + * and returns the byte array. + * @param {String} str the string to transform. + * @return {Array|Uint8Array} the string in a binary format. + */ +function string2binary(str) { + var result = null; + if (support.uint8array) { + result = new Uint8Array(str.length); + } else { + result = new Array(str.length); + } + return stringToArrayLike(str, result); +} + +/** + * Create a new blob with the given content and the given type. + * @param {String|ArrayBuffer} part the content to put in the blob. DO NOT use + * an Uint8Array because the stock browser of android 4 won't accept it (it + * will be silently converted to a string, "[object Uint8Array]"). + * + * Use only ONE part to build the blob to avoid a memory leak in IE11 / Edge: + * when a large amount of Array is used to create the Blob, the amount of + * memory consumed is nearly 100 times the original data amount. + * + * @param {String} type the mime type of the blob. + * @return {Blob} the created blob. + */ +exports.newBlob = function(part, type) { + exports.checkSupport("blob"); + + try { + // Blob constructor + return new Blob([part], { + type: type + }); + } + catch (e) { + + try { + // deprecated, browser only, old way + var Builder = self.BlobBuilder || self.WebKitBlobBuilder || self.MozBlobBuilder || self.MSBlobBuilder; + var builder = new Builder(); + builder.append(part); + return builder.getBlob(type); + } + catch (e) { + + // well, fuck ?! + throw new Error("Bug : can't construct the Blob."); + } + } + + +}; +/** + * The identity function. + * @param {Object} input the input. + * @return {Object} the same input. + */ +function identity(input) { + return input; +} + +/** + * Fill in an array with a string. + * @param {String} str the string to use. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} array the array to fill in (will be mutated). + * @return {Array|ArrayBuffer|Uint8Array|Buffer} the updated array. + */ +function stringToArrayLike(str, array) { + for (var i = 0; i < str.length; ++i) { + array[i] = str.charCodeAt(i) & 0xFF; + } + return array; +} + +/** + * An helper for the function arrayLikeToString. + * This contains static information and functions that + * can be optimized by the browser JIT compiler. + */ +var arrayToStringHelper = { + /** + * Transform an array of int into a string, chunk by chunk. + * See the performances notes on arrayLikeToString. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} array the array to transform. + * @param {String} type the type of the array. + * @param {Integer} chunk the chunk size. + * @return {String} the resulting string. + * @throws Error if the chunk is too big for the stack. + */ + stringifyByChunk: function(array, type, chunk) { + var result = [], k = 0, len = array.length; + // shortcut + if (len <= chunk) { + return String.fromCharCode.apply(null, array); + } + while (k < len) { + if (type === "array" || type === "nodebuffer") { + result.push(String.fromCharCode.apply(null, array.slice(k, Math.min(k + chunk, len)))); + } + else { + result.push(String.fromCharCode.apply(null, array.subarray(k, Math.min(k + chunk, len)))); + } + k += chunk; + } + return result.join(""); + }, + /** + * Call String.fromCharCode on every item in the array. + * This is the naive implementation, which generate A LOT of intermediate string. + * This should be used when everything else fail. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} array the array to transform. + * @return {String} the result. + */ + stringifyByChar: function(array){ + var resultStr = ""; + for(var i = 0; i < array.length; i++) { + resultStr += String.fromCharCode(array[i]); + } + return resultStr; + }, + applyCanBeUsed : { + /** + * true if the browser accepts to use String.fromCharCode on Uint8Array + */ + uint8array : (function () { + try { + return support.uint8array && String.fromCharCode.apply(null, new Uint8Array(1)).length === 1; + } catch (e) { + return false; + } + })(), + /** + * true if the browser accepts to use String.fromCharCode on nodejs Buffer. + */ + nodebuffer : (function () { + try { + return support.nodebuffer && String.fromCharCode.apply(null, nodejsUtils.allocBuffer(1)).length === 1; + } catch (e) { + return false; + } + })() + } +}; + +/** + * Transform an array-like object to a string. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} array the array to transform. + * @return {String} the result. + */ +function arrayLikeToString(array) { + // Performances notes : + // -------------------- + // String.fromCharCode.apply(null, array) is the fastest, see + // see http://jsperf.com/converting-a-uint8array-to-a-string/2 + // but the stack is limited (and we can get huge arrays !). + // + // result += String.fromCharCode(array[i]); generate too many strings ! + // + // This code is inspired by http://jsperf.com/arraybuffer-to-string-apply-performance/2 + // TODO : we now have workers that split the work. Do we still need that ? + var chunk = 65536, + type = exports.getTypeOf(array), + canUseApply = true; + if (type === "uint8array") { + canUseApply = arrayToStringHelper.applyCanBeUsed.uint8array; + } else if (type === "nodebuffer") { + canUseApply = arrayToStringHelper.applyCanBeUsed.nodebuffer; + } + + if (canUseApply) { + while (chunk > 1) { + try { + return arrayToStringHelper.stringifyByChunk(array, type, chunk); + } catch (e) { + chunk = Math.floor(chunk / 2); + } + } + } + + // no apply or chunk error : slow and painful algorithm + // default browser on android 4.* + return arrayToStringHelper.stringifyByChar(array); +} + +exports.applyFromCharCode = arrayLikeToString; + + +/** + * Copy the data from an array-like to an other array-like. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} arrayFrom the origin array. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} arrayTo the destination array which will be mutated. + * @return {Array|ArrayBuffer|Uint8Array|Buffer} the updated destination array. + */ +function arrayLikeToArrayLike(arrayFrom, arrayTo) { + for (var i = 0; i < arrayFrom.length; i++) { + arrayTo[i] = arrayFrom[i]; + } + return arrayTo; +} + +// a matrix containing functions to transform everything into everything. +var transform = {}; + +// string to ? +transform["string"] = { + "string": identity, + "array": function(input) { + return stringToArrayLike(input, new Array(input.length)); + }, + "arraybuffer": function(input) { + return transform["string"]["uint8array"](input).buffer; + }, + "uint8array": function(input) { + return stringToArrayLike(input, new Uint8Array(input.length)); + }, + "nodebuffer": function(input) { + return stringToArrayLike(input, nodejsUtils.allocBuffer(input.length)); + } +}; + +// array to ? +transform["array"] = { + "string": arrayLikeToString, + "array": identity, + "arraybuffer": function(input) { + return (new Uint8Array(input)).buffer; + }, + "uint8array": function(input) { + return new Uint8Array(input); + }, + "nodebuffer": function(input) { + return nodejsUtils.newBufferFrom(input); + } +}; + +// arraybuffer to ? +transform["arraybuffer"] = { + "string": function(input) { + return arrayLikeToString(new Uint8Array(input)); + }, + "array": function(input) { + return arrayLikeToArrayLike(new Uint8Array(input), new Array(input.byteLength)); + }, + "arraybuffer": identity, + "uint8array": function(input) { + return new Uint8Array(input); + }, + "nodebuffer": function(input) { + return nodejsUtils.newBufferFrom(new Uint8Array(input)); + } +}; + +// uint8array to ? +transform["uint8array"] = { + "string": arrayLikeToString, + "array": function(input) { + return arrayLikeToArrayLike(input, new Array(input.length)); + }, + "arraybuffer": function(input) { + return input.buffer; + }, + "uint8array": identity, + "nodebuffer": function(input) { + return nodejsUtils.newBufferFrom(input); + } +}; + +// nodebuffer to ? +transform["nodebuffer"] = { + "string": arrayLikeToString, + "array": function(input) { + return arrayLikeToArrayLike(input, new Array(input.length)); + }, + "arraybuffer": function(input) { + return transform["nodebuffer"]["uint8array"](input).buffer; + }, + "uint8array": function(input) { + return arrayLikeToArrayLike(input, new Uint8Array(input.length)); + }, + "nodebuffer": identity +}; + +/** + * Transform an input into any type. + * The supported output type are : string, array, uint8array, arraybuffer, nodebuffer. + * If no output type is specified, the unmodified input will be returned. + * @param {String} outputType the output type. + * @param {String|Array|ArrayBuffer|Uint8Array|Buffer} input the input to convert. + * @throws {Error} an Error if the browser doesn't support the requested output type. + */ +exports.transformTo = function(outputType, input) { + if (!input) { + // undefined, null, etc + // an empty string won't harm. + input = ""; + } + if (!outputType) { + return input; + } + exports.checkSupport(outputType); + var inputType = exports.getTypeOf(input); + var result = transform[inputType][outputType](input); + return result; +}; + +/** + * Return the type of the input. + * The type will be in a format valid for JSZip.utils.transformTo : string, array, uint8array, arraybuffer. + * @param {Object} input the input to identify. + * @return {String} the (lowercase) type of the input. + */ +exports.getTypeOf = function(input) { + if (typeof input === "string") { + return "string"; + } + if (Object.prototype.toString.call(input) === "[object Array]") { + return "array"; + } + if (support.nodebuffer && nodejsUtils.isBuffer(input)) { + return "nodebuffer"; + } + if (support.uint8array && input instanceof Uint8Array) { + return "uint8array"; + } + if (support.arraybuffer && input instanceof ArrayBuffer) { + return "arraybuffer"; + } +}; + +/** + * Throw an exception if the type is not supported. + * @param {String} type the type to check. + * @throws {Error} an Error if the browser doesn't support the requested type. + */ +exports.checkSupport = function(type) { + var supported = support[type.toLowerCase()]; + if (!supported) { + throw new Error(type + " is not supported by this platform"); + } +}; + +exports.MAX_VALUE_16BITS = 65535; +exports.MAX_VALUE_32BITS = -1; // well, "\xFF\xFF\xFF\xFF\xFF\xFF\xFF\xFF" is parsed as -1 + +/** + * Prettify a string read as binary. + * @param {string} str the string to prettify. + * @return {string} a pretty string. + */ +exports.pretty = function(str) { + var res = '', + code, i; + for (i = 0; i < (str || "").length; i++) { + code = str.charCodeAt(i); + res += '\\x' + (code < 16 ? "0" : "") + code.toString(16).toUpperCase(); + } + return res; +}; + +/** + * Defer the call of a function. + * @param {Function} callback the function to call asynchronously. + * @param {Array} args the arguments to give to the callback. + */ +exports.delay = function(callback, args, self) { + setImmediate(function () { + callback.apply(self || null, args || []); + }); +}; + +/** + * Extends a prototype with an other, without calling a constructor with + * side effects. Inspired by nodejs' `utils.inherits` + * @param {Function} ctor the constructor to augment + * @param {Function} superCtor the parent constructor to use + */ +exports.inherits = function (ctor, superCtor) { + var Obj = function() {}; + Obj.prototype = superCtor.prototype; + ctor.prototype = new Obj(); +}; + +/** + * Merge the objects passed as parameters into a new one. + * @private + * @param {...Object} var_args All objects to merge. + * @return {Object} a new object with the data of the others. + */ +exports.extend = function() { + var result = {}, i, attr; + for (i = 0; i < arguments.length; i++) { // arguments is not enumerable in some browsers + for (attr in arguments[i]) { + if (arguments[i].hasOwnProperty(attr) && typeof result[attr] === "undefined") { + result[attr] = arguments[i][attr]; + } + } + } + return result; +}; + +/** + * Transform arbitrary content into a Promise. + * @param {String} name a name for the content being processed. + * @param {Object} inputData the content to process. + * @param {Boolean} isBinary true if the content is not an unicode string + * @param {Boolean} isOptimizedBinaryString true if the string content only has one byte per character. + * @param {Boolean} isBase64 true if the string content is encoded with base64. + * @return {Promise} a promise in a format usable by JSZip. + */ +exports.prepareContent = function(name, inputData, isBinary, isOptimizedBinaryString, isBase64) { + + // if inputData is already a promise, this flatten it. + var promise = external.Promise.resolve(inputData).then(function(data) { + + + var isBlob = support.blob && (data instanceof Blob || ['[object File]', '[object Blob]'].indexOf(Object.prototype.toString.call(data)) !== -1); + + if (isBlob && typeof FileReader !== "undefined") { + return new external.Promise(function (resolve, reject) { + var reader = new FileReader(); + + reader.onload = function(e) { + resolve(e.target.result); + }; + reader.onerror = function(e) { + reject(e.target.error); + }; + reader.readAsArrayBuffer(data); + }); + } else { + return data; + } + }); + + return promise.then(function(data) { + var dataType = exports.getTypeOf(data); + + if (!dataType) { + return external.Promise.reject( + new Error("Can't read the data of '" + name + "'. Is it " + + "in a supported JavaScript type (String, Blob, ArrayBuffer, etc) ?") + ); + } + // special case : it's way easier to work with Uint8Array than with ArrayBuffer + if (dataType === "arraybuffer") { + data = exports.transformTo("uint8array", data); + } else if (dataType === "string") { + if (isBase64) { + data = base64.decode(data); + } + else if (isBinary) { + // optimizedBinaryString === true means that the file has already been filtered with a 0xFF mask + if (isOptimizedBinaryString !== true) { + // this is a string, not in a base64 format. + // Be sure that this is a correct "binary string" + data = string2binary(data); + } + } + } + return data; + }); +}; + +},{"./base64":1,"./external":6,"./nodejsUtils":14,"./support":30,"set-immediate-shim":54}],33:[function(require,module,exports){ +'use strict'; +var readerFor = require('./reader/readerFor'); +var utils = require('./utils'); +var sig = require('./signature'); +var ZipEntry = require('./zipEntry'); +var utf8 = require('./utf8'); +var support = require('./support'); +// class ZipEntries {{{ +/** + * All the entries in the zip file. + * @constructor + * @param {Object} loadOptions Options for loading the stream. + */ +function ZipEntries(loadOptions) { + this.files = []; + this.loadOptions = loadOptions; +} +ZipEntries.prototype = { + /** + * Check that the reader is on the specified signature. + * @param {string} expectedSignature the expected signature. + * @throws {Error} if it is an other signature. + */ + checkSignature: function(expectedSignature) { + if (!this.reader.readAndCheckSignature(expectedSignature)) { + this.reader.index -= 4; + var signature = this.reader.readString(4); + throw new Error("Corrupted zip or bug: unexpected signature " + "(" + utils.pretty(signature) + ", expected " + utils.pretty(expectedSignature) + ")"); + } + }, + /** + * Check if the given signature is at the given index. + * @param {number} askedIndex the index to check. + * @param {string} expectedSignature the signature to expect. + * @return {boolean} true if the signature is here, false otherwise. + */ + isSignature: function(askedIndex, expectedSignature) { + var currentIndex = this.reader.index; + this.reader.setIndex(askedIndex); + var signature = this.reader.readString(4); + var result = signature === expectedSignature; + this.reader.setIndex(currentIndex); + return result; + }, + /** + * Read the end of the central directory. + */ + readBlockEndOfCentral: function() { + this.diskNumber = this.reader.readInt(2); + this.diskWithCentralDirStart = this.reader.readInt(2); + this.centralDirRecordsOnThisDisk = this.reader.readInt(2); + this.centralDirRecords = this.reader.readInt(2); + this.centralDirSize = this.reader.readInt(4); + this.centralDirOffset = this.reader.readInt(4); + + this.zipCommentLength = this.reader.readInt(2); + // warning : the encoding depends of the system locale + // On a linux machine with LANG=en_US.utf8, this field is utf8 encoded. + // On a windows machine, this field is encoded with the localized windows code page. + var zipComment = this.reader.readData(this.zipCommentLength); + var decodeParamType = support.uint8array ? "uint8array" : "array"; + // To get consistent behavior with the generation part, we will assume that + // this is utf8 encoded unless specified otherwise. + var decodeContent = utils.transformTo(decodeParamType, zipComment); + this.zipComment = this.loadOptions.decodeFileName(decodeContent); + }, + /** + * Read the end of the Zip 64 central directory. + * Not merged with the method readEndOfCentral : + * The end of central can coexist with its Zip64 brother, + * I don't want to read the wrong number of bytes ! + */ + readBlockZip64EndOfCentral: function() { + this.zip64EndOfCentralSize = this.reader.readInt(8); + this.reader.skip(4); + // this.versionMadeBy = this.reader.readString(2); + // this.versionNeeded = this.reader.readInt(2); + this.diskNumber = this.reader.readInt(4); + this.diskWithCentralDirStart = this.reader.readInt(4); + this.centralDirRecordsOnThisDisk = this.reader.readInt(8); + this.centralDirRecords = this.reader.readInt(8); + this.centralDirSize = this.reader.readInt(8); + this.centralDirOffset = this.reader.readInt(8); + + this.zip64ExtensibleData = {}; + var extraDataSize = this.zip64EndOfCentralSize - 44, + index = 0, + extraFieldId, + extraFieldLength, + extraFieldValue; + while (index < extraDataSize) { + extraFieldId = this.reader.readInt(2); + extraFieldLength = this.reader.readInt(4); + extraFieldValue = this.reader.readData(extraFieldLength); + this.zip64ExtensibleData[extraFieldId] = { + id: extraFieldId, + length: extraFieldLength, + value: extraFieldValue + }; + } + }, + /** + * Read the end of the Zip 64 central directory locator. + */ + readBlockZip64EndOfCentralLocator: function() { + this.diskWithZip64CentralDirStart = this.reader.readInt(4); + this.relativeOffsetEndOfZip64CentralDir = this.reader.readInt(8); + this.disksCount = this.reader.readInt(4); + if (this.disksCount > 1) { + throw new Error("Multi-volumes zip are not supported"); + } + }, + /** + * Read the local files, based on the offset read in the central part. + */ + readLocalFiles: function() { + var i, file; + for (i = 0; i < this.files.length; i++) { + file = this.files[i]; + this.reader.setIndex(file.localHeaderOffset); + this.checkSignature(sig.LOCAL_FILE_HEADER); + file.readLocalPart(this.reader); + file.handleUTF8(); + file.processAttributes(); + } + }, + /** + * Read the central directory. + */ + readCentralDir: function() { + var file; + + this.reader.setIndex(this.centralDirOffset); + while (this.reader.readAndCheckSignature(sig.CENTRAL_FILE_HEADER)) { + file = new ZipEntry({ + zip64: this.zip64 + }, this.loadOptions); + file.readCentralPart(this.reader); + this.files.push(file); + } + + if (this.centralDirRecords !== this.files.length) { + if (this.centralDirRecords !== 0 && this.files.length === 0) { + // We expected some records but couldn't find ANY. + // This is really suspicious, as if something went wrong. + throw new Error("Corrupted zip or bug: expected " + this.centralDirRecords + " records in central dir, got " + this.files.length); + } else { + // We found some records but not all. + // Something is wrong but we got something for the user: no error here. + // console.warn("expected", this.centralDirRecords, "records in central dir, got", this.files.length); + } + } + }, + /** + * Read the end of central directory. + */ + readEndOfCentral: function() { + var offset = this.reader.lastIndexOfSignature(sig.CENTRAL_DIRECTORY_END); + if (offset < 0) { + // Check if the content is a truncated zip or complete garbage. + // A "LOCAL_FILE_HEADER" is not required at the beginning (auto + // extractible zip for example) but it can give a good hint. + // If an ajax request was used without responseType, we will also + // get unreadable data. + var isGarbage = !this.isSignature(0, sig.LOCAL_FILE_HEADER); + + if (isGarbage) { + throw new Error("Can't find end of central directory : is this a zip file ? " + + "If it is, see https://stuk.github.io/jszip/documentation/howto/read_zip.html"); + } else { + throw new Error("Corrupted zip: can't find end of central directory"); + } + + } + this.reader.setIndex(offset); + var endOfCentralDirOffset = offset; + this.checkSignature(sig.CENTRAL_DIRECTORY_END); + this.readBlockEndOfCentral(); + + + /* extract from the zip spec : + 4) If one of the fields in the end of central directory + record is too small to hold required data, the field + should be set to -1 (0xFFFF or 0xFFFFFFFF) and the + ZIP64 format record should be created. + 5) The end of central directory record and the + Zip64 end of central directory locator record must + reside on the same disk when splitting or spanning + an archive. + */ + if (this.diskNumber === utils.MAX_VALUE_16BITS || this.diskWithCentralDirStart === utils.MAX_VALUE_16BITS || this.centralDirRecordsOnThisDisk === utils.MAX_VALUE_16BITS || this.centralDirRecords === utils.MAX_VALUE_16BITS || this.centralDirSize === utils.MAX_VALUE_32BITS || this.centralDirOffset === utils.MAX_VALUE_32BITS) { + this.zip64 = true; + + /* + Warning : the zip64 extension is supported, but ONLY if the 64bits integer read from + the zip file can fit into a 32bits integer. This cannot be solved : JavaScript represents + all numbers as 64-bit double precision IEEE 754 floating point numbers. + So, we have 53bits for integers and bitwise operations treat everything as 32bits. + see https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Operators/Bitwise_Operators + and http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-262.pdf section 8.5 + */ + + // should look for a zip64 EOCD locator + offset = this.reader.lastIndexOfSignature(sig.ZIP64_CENTRAL_DIRECTORY_LOCATOR); + if (offset < 0) { + throw new Error("Corrupted zip: can't find the ZIP64 end of central directory locator"); + } + this.reader.setIndex(offset); + this.checkSignature(sig.ZIP64_CENTRAL_DIRECTORY_LOCATOR); + this.readBlockZip64EndOfCentralLocator(); + + // now the zip64 EOCD record + if (!this.isSignature(this.relativeOffsetEndOfZip64CentralDir, sig.ZIP64_CENTRAL_DIRECTORY_END)) { + // console.warn("ZIP64 end of central directory not where expected."); + this.relativeOffsetEndOfZip64CentralDir = this.reader.lastIndexOfSignature(sig.ZIP64_CENTRAL_DIRECTORY_END); + if (this.relativeOffsetEndOfZip64CentralDir < 0) { + throw new Error("Corrupted zip: can't find the ZIP64 end of central directory"); + } + } + this.reader.setIndex(this.relativeOffsetEndOfZip64CentralDir); + this.checkSignature(sig.ZIP64_CENTRAL_DIRECTORY_END); + this.readBlockZip64EndOfCentral(); + } + + var expectedEndOfCentralDirOffset = this.centralDirOffset + this.centralDirSize; + if (this.zip64) { + expectedEndOfCentralDirOffset += 20; // end of central dir 64 locator + expectedEndOfCentralDirOffset += 12 /* should not include the leading 12 bytes */ + this.zip64EndOfCentralSize; + } + + var extraBytes = endOfCentralDirOffset - expectedEndOfCentralDirOffset; + + if (extraBytes > 0) { + // console.warn(extraBytes, "extra bytes at beginning or within zipfile"); + if (this.isSignature(endOfCentralDirOffset, sig.CENTRAL_FILE_HEADER)) { + // The offsets seem wrong, but we have something at the specified offset. + // So… we keep it. + } else { + // the offset is wrong, update the "zero" of the reader + // this happens if data has been prepended (crx files for example) + this.reader.zero = extraBytes; + } + } else if (extraBytes < 0) { + throw new Error("Corrupted zip: missing " + Math.abs(extraBytes) + " bytes."); + } + }, + prepareReader: function(data) { + this.reader = readerFor(data); + }, + /** + * Read a zip file and create ZipEntries. + * @param {String|ArrayBuffer|Uint8Array|Buffer} data the binary string representing a zip file. + */ + load: function(data) { + this.prepareReader(data); + this.readEndOfCentral(); + this.readCentralDir(); + this.readLocalFiles(); + } +}; +// }}} end of ZipEntries +module.exports = ZipEntries; + +},{"./reader/readerFor":22,"./signature":23,"./support":30,"./utf8":31,"./utils":32,"./zipEntry":34}],34:[function(require,module,exports){ +'use strict'; +var readerFor = require('./reader/readerFor'); +var utils = require('./utils'); +var CompressedObject = require('./compressedObject'); +var crc32fn = require('./crc32'); +var utf8 = require('./utf8'); +var compressions = require('./compressions'); +var support = require('./support'); + +var MADE_BY_DOS = 0x00; +var MADE_BY_UNIX = 0x03; + +/** + * Find a compression registered in JSZip. + * @param {string} compressionMethod the method magic to find. + * @return {Object|null} the JSZip compression object, null if none found. + */ +var findCompression = function(compressionMethod) { + for (var method in compressions) { + if (!compressions.hasOwnProperty(method)) { + continue; + } + if (compressions[method].magic === compressionMethod) { + return compressions[method]; + } + } + return null; +}; + +// class ZipEntry {{{ +/** + * An entry in the zip file. + * @constructor + * @param {Object} options Options of the current file. + * @param {Object} loadOptions Options for loading the stream. + */ +function ZipEntry(options, loadOptions) { + this.options = options; + this.loadOptions = loadOptions; +} +ZipEntry.prototype = { + /** + * say if the file is encrypted. + * @return {boolean} true if the file is encrypted, false otherwise. + */ + isEncrypted: function() { + // bit 1 is set + return (this.bitFlag & 0x0001) === 0x0001; + }, + /** + * say if the file has utf-8 filename/comment. + * @return {boolean} true if the filename/comment is in utf-8, false otherwise. + */ + useUTF8: function() { + // bit 11 is set + return (this.bitFlag & 0x0800) === 0x0800; + }, + /** + * Read the local part of a zip file and add the info in this object. + * @param {DataReader} reader the reader to use. + */ + readLocalPart: function(reader) { + var compression, localExtraFieldsLength; + + // we already know everything from the central dir ! + // If the central dir data are false, we are doomed. + // On the bright side, the local part is scary : zip64, data descriptors, both, etc. + // The less data we get here, the more reliable this should be. + // Let's skip the whole header and dash to the data ! + reader.skip(22); + // in some zip created on windows, the filename stored in the central dir contains \ instead of /. + // Strangely, the filename here is OK. + // I would love to treat these zip files as corrupted (see http://www.info-zip.org/FAQ.html#backslashes + // or APPNOTE#4.4.17.1, "All slashes MUST be forward slashes '/'") but there are a lot of bad zip generators... + // Search "unzip mismatching "local" filename continuing with "central" filename version" on + // the internet. + // + // I think I see the logic here : the central directory is used to display + // content and the local directory is used to extract the files. Mixing / and \ + // may be used to display \ to windows users and use / when extracting the files. + // Unfortunately, this lead also to some issues : http://seclists.org/fulldisclosure/2009/Sep/394 + this.fileNameLength = reader.readInt(2); + localExtraFieldsLength = reader.readInt(2); // can't be sure this will be the same as the central dir + // the fileName is stored as binary data, the handleUTF8 method will take care of the encoding. + this.fileName = reader.readData(this.fileNameLength); + reader.skip(localExtraFieldsLength); + + if (this.compressedSize === -1 || this.uncompressedSize === -1) { + throw new Error("Bug or corrupted zip : didn't get enough information from the central directory " + "(compressedSize === -1 || uncompressedSize === -1)"); + } + + compression = findCompression(this.compressionMethod); + if (compression === null) { // no compression found + throw new Error("Corrupted zip : compression " + utils.pretty(this.compressionMethod) + " unknown (inner file : " + utils.transformTo("string", this.fileName) + ")"); + } + this.decompressed = new CompressedObject(this.compressedSize, this.uncompressedSize, this.crc32, compression, reader.readData(this.compressedSize)); + }, + + /** + * Read the central part of a zip file and add the info in this object. + * @param {DataReader} reader the reader to use. + */ + readCentralPart: function(reader) { + this.versionMadeBy = reader.readInt(2); + reader.skip(2); + // this.versionNeeded = reader.readInt(2); + this.bitFlag = reader.readInt(2); + this.compressionMethod = reader.readString(2); + this.date = reader.readDate(); + this.crc32 = reader.readInt(4); + this.compressedSize = reader.readInt(4); + this.uncompressedSize = reader.readInt(4); + var fileNameLength = reader.readInt(2); + this.extraFieldsLength = reader.readInt(2); + this.fileCommentLength = reader.readInt(2); + this.diskNumberStart = reader.readInt(2); + this.internalFileAttributes = reader.readInt(2); + this.externalFileAttributes = reader.readInt(4); + this.localHeaderOffset = reader.readInt(4); + + if (this.isEncrypted()) { + throw new Error("Encrypted zip are not supported"); + } + + // will be read in the local part, see the comments there + reader.skip(fileNameLength); + this.readExtraFields(reader); + this.parseZIP64ExtraField(reader); + this.fileComment = reader.readData(this.fileCommentLength); + }, + + /** + * Parse the external file attributes and get the unix/dos permissions. + */ + processAttributes: function () { + this.unixPermissions = null; + this.dosPermissions = null; + var madeBy = this.versionMadeBy >> 8; + + // Check if we have the DOS directory flag set. + // We look for it in the DOS and UNIX permissions + // but some unknown platform could set it as a compatibility flag. + this.dir = this.externalFileAttributes & 0x0010 ? true : false; + + if(madeBy === MADE_BY_DOS) { + // first 6 bits (0 to 5) + this.dosPermissions = this.externalFileAttributes & 0x3F; + } + + if(madeBy === MADE_BY_UNIX) { + this.unixPermissions = (this.externalFileAttributes >> 16) & 0xFFFF; + // the octal permissions are in (this.unixPermissions & 0x01FF).toString(8); + } + + // fail safe : if the name ends with a / it probably means a folder + if (!this.dir && this.fileNameStr.slice(-1) === '/') { + this.dir = true; + } + }, + + /** + * Parse the ZIP64 extra field and merge the info in the current ZipEntry. + * @param {DataReader} reader the reader to use. + */ + parseZIP64ExtraField: function(reader) { + + if (!this.extraFields[0x0001]) { + return; + } + + // should be something, preparing the extra reader + var extraReader = readerFor(this.extraFields[0x0001].value); + + // I really hope that these 64bits integer can fit in 32 bits integer, because js + // won't let us have more. + if (this.uncompressedSize === utils.MAX_VALUE_32BITS) { + this.uncompressedSize = extraReader.readInt(8); + } + if (this.compressedSize === utils.MAX_VALUE_32BITS) { + this.compressedSize = extraReader.readInt(8); + } + if (this.localHeaderOffset === utils.MAX_VALUE_32BITS) { + this.localHeaderOffset = extraReader.readInt(8); + } + if (this.diskNumberStart === utils.MAX_VALUE_32BITS) { + this.diskNumberStart = extraReader.readInt(4); + } + }, + /** + * Read the central part of a zip file and add the info in this object. + * @param {DataReader} reader the reader to use. + */ + readExtraFields: function(reader) { + var end = reader.index + this.extraFieldsLength, + extraFieldId, + extraFieldLength, + extraFieldValue; + + if (!this.extraFields) { + this.extraFields = {}; + } + + while (reader.index + 4 < end) { + extraFieldId = reader.readInt(2); + extraFieldLength = reader.readInt(2); + extraFieldValue = reader.readData(extraFieldLength); + + this.extraFields[extraFieldId] = { + id: extraFieldId, + length: extraFieldLength, + value: extraFieldValue + }; + } + + reader.setIndex(end); + }, + /** + * Apply an UTF8 transformation if needed. + */ + handleUTF8: function() { + var decodeParamType = support.uint8array ? "uint8array" : "array"; + if (this.useUTF8()) { + this.fileNameStr = utf8.utf8decode(this.fileName); + this.fileCommentStr = utf8.utf8decode(this.fileComment); + } else { + var upath = this.findExtraFieldUnicodePath(); + if (upath !== null) { + this.fileNameStr = upath; + } else { + // ASCII text or unsupported code page + var fileNameByteArray = utils.transformTo(decodeParamType, this.fileName); + this.fileNameStr = this.loadOptions.decodeFileName(fileNameByteArray); + } + + var ucomment = this.findExtraFieldUnicodeComment(); + if (ucomment !== null) { + this.fileCommentStr = ucomment; + } else { + // ASCII text or unsupported code page + var commentByteArray = utils.transformTo(decodeParamType, this.fileComment); + this.fileCommentStr = this.loadOptions.decodeFileName(commentByteArray); + } + } + }, + + /** + * Find the unicode path declared in the extra field, if any. + * @return {String} the unicode path, null otherwise. + */ + findExtraFieldUnicodePath: function() { + var upathField = this.extraFields[0x7075]; + if (upathField) { + var extraReader = readerFor(upathField.value); + + // wrong version + if (extraReader.readInt(1) !== 1) { + return null; + } + + // the crc of the filename changed, this field is out of date. + if (crc32fn(this.fileName) !== extraReader.readInt(4)) { + return null; + } + + return utf8.utf8decode(extraReader.readData(upathField.length - 5)); + } + return null; + }, + + /** + * Find the unicode comment declared in the extra field, if any. + * @return {String} the unicode comment, null otherwise. + */ + findExtraFieldUnicodeComment: function() { + var ucommentField = this.extraFields[0x6375]; + if (ucommentField) { + var extraReader = readerFor(ucommentField.value); + + // wrong version + if (extraReader.readInt(1) !== 1) { + return null; + } + + // the crc of the comment changed, this field is out of date. + if (crc32fn(this.fileComment) !== extraReader.readInt(4)) { + return null; + } + + return utf8.utf8decode(extraReader.readData(ucommentField.length - 5)); + } + return null; + } +}; +module.exports = ZipEntry; + +},{"./compressedObject":2,"./compressions":3,"./crc32":4,"./reader/readerFor":22,"./support":30,"./utf8":31,"./utils":32}],35:[function(require,module,exports){ +'use strict'; + +var StreamHelper = require('./stream/StreamHelper'); +var DataWorker = require('./stream/DataWorker'); +var utf8 = require('./utf8'); +var CompressedObject = require('./compressedObject'); +var GenericWorker = require('./stream/GenericWorker'); + +/** + * A simple object representing a file in the zip file. + * @constructor + * @param {string} name the name of the file + * @param {String|ArrayBuffer|Uint8Array|Buffer} data the data + * @param {Object} options the options of the file + */ +var ZipObject = function(name, data, options) { + this.name = name; + this.dir = options.dir; + this.date = options.date; + this.comment = options.comment; + this.unixPermissions = options.unixPermissions; + this.dosPermissions = options.dosPermissions; + + this._data = data; + this._dataBinary = options.binary; + // keep only the compression + this.options = { + compression : options.compression, + compressionOptions : options.compressionOptions + }; +}; + +ZipObject.prototype = { + /** + * Create an internal stream for the content of this object. + * @param {String} type the type of each chunk. + * @return StreamHelper the stream. + */ + internalStream: function (type) { + var result = null, outputType = "string"; + try { + if (!type) { + throw new Error("No output type specified."); + } + outputType = type.toLowerCase(); + var askUnicodeString = outputType === "string" || outputType === "text"; + if (outputType === "binarystring" || outputType === "text") { + outputType = "string"; + } + result = this._decompressWorker(); + + var isUnicodeString = !this._dataBinary; + + if (isUnicodeString && !askUnicodeString) { + result = result.pipe(new utf8.Utf8EncodeWorker()); + } + if (!isUnicodeString && askUnicodeString) { + result = result.pipe(new utf8.Utf8DecodeWorker()); + } + } catch (e) { + result = new GenericWorker("error"); + result.error(e); + } + + return new StreamHelper(result, outputType, ""); + }, + + /** + * Prepare the content in the asked type. + * @param {String} type the type of the result. + * @param {Function} onUpdate a function to call on each internal update. + * @return Promise the promise of the result. + */ + async: function (type, onUpdate) { + return this.internalStream(type).accumulate(onUpdate); + }, + + /** + * Prepare the content as a nodejs stream. + * @param {String} type the type of each chunk. + * @param {Function} onUpdate a function to call on each internal update. + * @return Stream the stream. + */ + nodeStream: function (type, onUpdate) { + return this.internalStream(type || "nodebuffer").toNodejsStream(onUpdate); + }, + + /** + * Return a worker for the compressed content. + * @private + * @param {Object} compression the compression object to use. + * @param {Object} compressionOptions the options to use when compressing. + * @return Worker the worker. + */ + _compressWorker: function (compression, compressionOptions) { + if ( + this._data instanceof CompressedObject && + this._data.compression.magic === compression.magic + ) { + return this._data.getCompressedWorker(); + } else { + var result = this._decompressWorker(); + if(!this._dataBinary) { + result = result.pipe(new utf8.Utf8EncodeWorker()); + } + return CompressedObject.createWorkerFrom(result, compression, compressionOptions); + } + }, + /** + * Return a worker for the decompressed content. + * @private + * @return Worker the worker. + */ + _decompressWorker : function () { + if (this._data instanceof CompressedObject) { + return this._data.getContentWorker(); + } else if (this._data instanceof GenericWorker) { + return this._data; + } else { + return new DataWorker(this._data); + } + } +}; + +var removedMethods = ["asText", "asBinary", "asNodeBuffer", "asUint8Array", "asArrayBuffer"]; +var removedFn = function () { + throw new Error("This method has been removed in JSZip 3.0, please check the upgrade guide."); +}; + +for(var i = 0; i < removedMethods.length; i++) { + ZipObject.prototype[removedMethods[i]] = removedFn; +} +module.exports = ZipObject; + +},{"./compressedObject":2,"./stream/DataWorker":27,"./stream/GenericWorker":28,"./stream/StreamHelper":29,"./utf8":31}],36:[function(require,module,exports){ +(function (global){ +'use strict'; +var Mutation = global.MutationObserver || global.WebKitMutationObserver; + +var scheduleDrain; + +{ + if (Mutation) { + var called = 0; + var observer = new Mutation(nextTick); + var element = global.document.createTextNode(''); + observer.observe(element, { + characterData: true + }); + scheduleDrain = function () { + element.data = (called = ++called % 2); + }; + } else if (!global.setImmediate && typeof global.MessageChannel !== 'undefined') { + var channel = new global.MessageChannel(); + channel.port1.onmessage = nextTick; + scheduleDrain = function () { + channel.port2.postMessage(0); + }; + } else if ('document' in global && 'onreadystatechange' in global.document.createElement('script')) { + scheduleDrain = function () { + + // Create a + + + + + +
+ +

index.html

+
+ + diff --git a/javadoc/latest/overview-tree.html b/javadoc/latest/overview-tree.html new file mode 100644 index 000000000..9e8830f6d --- /dev/null +++ b/javadoc/latest/overview-tree.html @@ -0,0 +1,422 @@ + + + + + +Class Hierarchy (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For All Packages

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+ +
+
+

Interface Hierarchy

+ +
+
+

Enum Hierarchy

+ +
+
+
+
+ +
+ + diff --git a/javadoc/latest/package-search-index.js b/javadoc/latest/package-search-index.js new file mode 100644 index 000000000..faafa5d4e --- /dev/null +++ b/javadoc/latest/package-search-index.js @@ -0,0 +1 @@ +packageSearchIndex = [{"l":"All Packages","url":"allpackages-index.html"},{"l":"com.onarandombox.MultiverseCore"},{"l":"com.onarandombox.MultiverseCore.api"},{"l":"com.onarandombox.MultiverseCore.commands"},{"l":"com.onarandombox.MultiverseCore.commandtools.queue"},{"l":"com.onarandombox.MultiverseCore.configuration"},{"l":"com.onarandombox.MultiverseCore.destination"},{"l":"com.onarandombox.MultiverseCore.display"},{"l":"com.onarandombox.MultiverseCore.display.handlers"},{"l":"com.onarandombox.MultiverseCore.display.settings"},{"l":"com.onarandombox.MultiverseCore.enums"},{"l":"com.onarandombox.MultiverseCore.event"},{"l":"com.onarandombox.MultiverseCore.exceptions"},{"l":"com.onarandombox.MultiverseCore.listeners"},{"l":"com.onarandombox.MultiverseCore.utils"},{"l":"com.onarandombox.MultiverseCore.utils.metrics"},{"l":"com.onarandombox.MultiverseCore.utils.webpaste"}] \ No newline at end of file diff --git a/javadoc/latest/package-search-index.zip b/javadoc/latest/package-search-index.zip new file mode 100644 index 0000000000000000000000000000000000000000..c0bd58f885f86ba4bc95d5b1a31241ea6fa774b3 GIT binary patch literal 349 zcmWIWW@Zs#;Nak3u+-0sWIzIvKz2c5a&}^Rs%~*=Vo`F2Zf0IeYK2}_aem&^366P8 zhCHt8gHm}d8FqJ>27M0|S4&P?V^!uMBhj+MT5>D9$F}?LPu~AmXH~}j{p6pItPjQ0 zbn>2O-E&It`+sv@%Au?JVmJ4e)%#s|5vtJaBXxe)ui(_h($AXQ&)zs)>2c-kw#uB% zMp`qp#Ov2a{H|u5%6-MkM%Tign7H1G3Eu>DgC(}UtMI$JoRsvExf%rEN>jUL}qZ_~k#FbE+Q;{`;0FZwVNX2n-^JoI; zP;4#$8DIy*Yk-P>VN(DUKmPse7mx+ExD4O|;?E5D0Z5($mjO3`*anwQU^s{ZDK#Lz zj>~{qyaIx5K!t%=G&2IJNzg!ChRpyLkO7}Ry!QaotAHAMpbB3AF(}|_f!G-oI|uK6 z`id_dumai5K%C3Y$;tKS_iqMPHg<*|-@e`liWLAggVM!zAP#@l;=c>S03;{#04Z~5 zN_+ss=Yg6*hTr59mzMwZ@+l~q!+?ft!fF66AXT#wWavHt30bZWFCK%!BNk}LN?0Hg z1VF_nfs`Lm^DjYZ1(1uD0u4CSIr)XAaqW6IT{!St5~1{i=i}zAy76p%_|w8rh@@c0Axr!ns=D-X+|*sY6!@wacG9%)Qn*O zl0sa739kT-&_?#oVxXF6tOnqTD)cZ}2vi$`ZU8RLAlo8=_z#*P3xI~i!lEh+Pdu-L zx{d*wgjtXbnGX_Yf@Tc7Q3YhLhPvc8noGJs2DA~1DySiA&6V{5JzFt ojAY1KXm~va;tU{v7C?Xj0BHw!K;2aXV*mgE07*qoM6N<$f;4TDA^-pY literal 0 HcmV?d00001 diff --git a/javadoc/latest/script.js b/javadoc/latest/script.js new file mode 100644 index 000000000..7dc93c48e --- /dev/null +++ b/javadoc/latest/script.js @@ -0,0 +1,149 @@ +/* + * Copyright (c) 2013, 2018, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +var moduleSearchIndex; +var packageSearchIndex; +var typeSearchIndex; +var memberSearchIndex; +var tagSearchIndex; +function loadScripts(doc, tag) { + createElem(doc, tag, 'jquery/jszip/dist/jszip.js'); + createElem(doc, tag, 'jquery/jszip-utils/dist/jszip-utils.js'); + if (window.navigator.userAgent.indexOf('MSIE ') > 0 || window.navigator.userAgent.indexOf('Trident/') > 0 || + window.navigator.userAgent.indexOf('Edge/') > 0) { + createElem(doc, tag, 'jquery/jszip-utils/dist/jszip-utils-ie.js'); + } + createElem(doc, tag, 'search.js'); + + $.get(pathtoroot + "module-search-index.zip") + .done(function() { + JSZipUtils.getBinaryContent(pathtoroot + "module-search-index.zip", function(e, data) { + JSZip.loadAsync(data).then(function(zip){ + zip.file("module-search-index.json").async("text").then(function(content){ + moduleSearchIndex = JSON.parse(content); + }); + }); + }); + }); + $.get(pathtoroot + "package-search-index.zip") + .done(function() { + JSZipUtils.getBinaryContent(pathtoroot + "package-search-index.zip", function(e, data) { + JSZip.loadAsync(data).then(function(zip){ + zip.file("package-search-index.json").async("text").then(function(content){ + packageSearchIndex = JSON.parse(content); + }); + }); + }); + }); + $.get(pathtoroot + "type-search-index.zip") + .done(function() { + JSZipUtils.getBinaryContent(pathtoroot + "type-search-index.zip", function(e, data) { + JSZip.loadAsync(data).then(function(zip){ + zip.file("type-search-index.json").async("text").then(function(content){ + typeSearchIndex = JSON.parse(content); + }); + }); + }); + }); + $.get(pathtoroot + "member-search-index.zip") + .done(function() { + JSZipUtils.getBinaryContent(pathtoroot + "member-search-index.zip", function(e, data) { + JSZip.loadAsync(data).then(function(zip){ + zip.file("member-search-index.json").async("text").then(function(content){ + memberSearchIndex = JSON.parse(content); + }); + }); + }); + }); + $.get(pathtoroot + "tag-search-index.zip") + .done(function() { + JSZipUtils.getBinaryContent(pathtoroot + "tag-search-index.zip", function(e, data) { + JSZip.loadAsync(data).then(function(zip){ + zip.file("tag-search-index.json").async("text").then(function(content){ + tagSearchIndex = JSON.parse(content); + }); + }); + }); + }); + if (!moduleSearchIndex) { + createElem(doc, tag, 'module-search-index.js'); + } + if (!packageSearchIndex) { + createElem(doc, tag, 'package-search-index.js'); + } + if (!typeSearchIndex) { + createElem(doc, tag, 'type-search-index.js'); + } + if (!memberSearchIndex) { + createElem(doc, tag, 'member-search-index.js'); + } + if (!tagSearchIndex) { + createElem(doc, tag, 'tag-search-index.js'); + } + $(window).resize(function() { + $('.navPadding').css('padding-top', $('.fixedNav').css("height")); + }); +} + +function createElem(doc, tag, path) { + var script = doc.createElement(tag); + var scriptElement = doc.getElementsByTagName(tag)[0]; + script.src = pathtoroot + path; + scriptElement.parentNode.insertBefore(script, scriptElement); +} + +function show(type) { + count = 0; + for (var key in data) { + var row = document.getElementById(key); + if ((data[key] & type) !== 0) { + row.style.display = ''; + row.className = (count++ % 2) ? rowColor : altColor; + } + else + row.style.display = 'none'; + } + updateTabs(type); +} + +function updateTabs(type) { + for (var value in tabs) { + var sNode = document.getElementById(tabs[value][0]); + var spanNode = sNode.firstChild; + if (value == type) { + sNode.className = activeTableTab; + spanNode.innerHTML = tabs[value][1]; + } + else { + sNode.className = tableTab; + spanNode.innerHTML = "" + tabs[value][1] + ""; + } + } +} + +function updateModuleFrame(pFrame, cFrame) { + top.packageFrame.location = pFrame; + top.classFrame.location = cFrame; +} diff --git a/javadoc/latest/search.js b/javadoc/latest/search.js new file mode 100644 index 000000000..8492271e7 --- /dev/null +++ b/javadoc/latest/search.js @@ -0,0 +1,326 @@ +/* + * Copyright (c) 2015, 2018, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +var noResult = {l: "No results found"}; +var catModules = "Modules"; +var catPackages = "Packages"; +var catTypes = "Types"; +var catMembers = "Members"; +var catSearchTags = "SearchTags"; +var highlight = "$&"; +var camelCaseRegexp = ""; +var secondaryMatcher = ""; +function getHighlightedText(item) { + var ccMatcher = new RegExp(camelCaseRegexp); + var label = item.replace(ccMatcher, highlight); + if (label === item) { + label = item.replace(secondaryMatcher, highlight); + } + return label; +} +function getURLPrefix(ui) { + var urlPrefix=""; + if (useModuleDirectories) { + var slash = "/"; + if (ui.item.category === catModules) { + return ui.item.l + slash; + } else if (ui.item.category === catPackages && ui.item.m) { + return ui.item.m + slash; + } else if ((ui.item.category === catTypes && ui.item.p) || ui.item.category === catMembers) { + $.each(packageSearchIndex, function(index, item) { + if (item.m && ui.item.p == item.l) { + urlPrefix = item.m + slash; + } + }); + return urlPrefix; + } else { + return urlPrefix; + } + } + return urlPrefix; +} +var watermark = 'Search'; +$(function() { + $("#search").val(''); + $("#search").prop("disabled", false); + $("#reset").prop("disabled", false); + $("#search").val(watermark).addClass('watermark'); + $("#search").blur(function() { + if ($(this).val().length == 0) { + $(this).val(watermark).addClass('watermark'); + } + }); + $("#search").on('click keydown', function() { + if ($(this).val() == watermark) { + $(this).val('').removeClass('watermark'); + } + }); + $("#reset").click(function() { + $("#search").val(''); + $("#search").focus(); + }); + $("#search").focus(); + $("#search")[0].setSelectionRange(0, 0); +}); +$.widget("custom.catcomplete", $.ui.autocomplete, { + _create: function() { + this._super(); + this.widget().menu("option", "items", "> :not(.ui-autocomplete-category)"); + }, + _renderMenu: function(ul, items) { + var rMenu = this, + currentCategory = ""; + rMenu.menu.bindings = $(); + $.each(items, function(index, item) { + var li; + if (item.l !== noResult.l && item.category !== currentCategory) { + ul.append("
  • " + item.category + "
    • "); + currentCategory = item.category; + } + li = rMenu._renderItemData(ul, item); + if (item.category) { + li.attr("aria-label", item.category + " : " + item.l); + li.attr("class", "resultItem"); + } else { + li.attr("aria-label", item.l); + li.attr("class", "resultItem"); + } + }); + }, + _renderItem: function(ul, item) { + var label = ""; + if (item.category === catModules) { + label = getHighlightedText(item.l); + } else if (item.category === catPackages) { + label = (item.m) + ? getHighlightedText(item.m + "/" + item.l) + : getHighlightedText(item.l); + } else if (item.category === catTypes) { + label = (item.p) + ? getHighlightedText(item.p + "." + item.l) + : getHighlightedText(item.l); + } else if (item.category === catMembers) { + label = getHighlightedText(item.p + "." + (item.c + "." + item.l)); + } else if (item.category === catSearchTags) { + label = getHighlightedText(item.l); + } else { + label = item.l; + } + var li = $("
  • ").appendTo(ul); + var div = $("
    ").appendTo(li); + if (item.category === catSearchTags) { + if (item.d) { + div.html(label + " (" + item.h + ")
    " + + item.d + "
    "); + } else { + div.html(label + " (" + item.h + ")"); + } + } else { + div.html(label); + } + return li; + } +}); +$(function() { + $("#search").catcomplete({ + minLength: 1, + delay: 100, + source: function(request, response) { + var result = new Array(); + var presult = new Array(); + var tresult = new Array(); + var mresult = new Array(); + var tgresult = new Array(); + var secondaryresult = new Array(); + var displayCount = 0; + var exactMatcher = new RegExp("^" + $.ui.autocomplete.escapeRegex(request.term) + "$", "i"); + camelCaseRegexp = ($.ui.autocomplete.escapeRegex(request.term)).split(/(?=[A-Z])/).join("([a-z0-9_$]*?)"); + var camelCaseMatcher = new RegExp("^" + camelCaseRegexp); + secondaryMatcher = new RegExp($.ui.autocomplete.escapeRegex(request.term), "i"); + + // Return the nested innermost name from the specified object + function nestedName(e) { + return e.l.substring(e.l.lastIndexOf(".") + 1); + } + + function concatResults(a1, a2) { + a1 = a1.concat(a2); + a2.length = 0; + return a1; + } + + if (moduleSearchIndex) { + var mdleCount = 0; + $.each(moduleSearchIndex, function(index, item) { + item.category = catModules; + if (exactMatcher.test(item.l)) { + result.push(item); + mdleCount++; + } else if (camelCaseMatcher.test(item.l)) { + result.push(item); + } else if (secondaryMatcher.test(item.l)) { + secondaryresult.push(item); + } + }); + displayCount = mdleCount; + result = concatResults(result, secondaryresult); + } + if (packageSearchIndex) { + var pCount = 0; + var pkg = ""; + $.each(packageSearchIndex, function(index, item) { + item.category = catPackages; + pkg = (item.m) + ? (item.m + "/" + item.l) + : item.l; + if (exactMatcher.test(item.l)) { + presult.push(item); + pCount++; + } else if (camelCaseMatcher.test(pkg)) { + presult.push(item); + } else if (secondaryMatcher.test(pkg)) { + secondaryresult.push(item); + } + }); + result = result.concat(concatResults(presult, secondaryresult)); + displayCount = (pCount > displayCount) ? pCount : displayCount; + } + if (typeSearchIndex) { + var tCount = 0; + $.each(typeSearchIndex, function(index, item) { + item.category = catTypes; + var s = nestedName(item); + if (exactMatcher.test(s)) { + tresult.push(item); + tCount++; + } else if (camelCaseMatcher.test(s)) { + tresult.push(item); + } else if (secondaryMatcher.test(item.p + "." + item.l)) { + secondaryresult.push(item); + } + }); + result = result.concat(concatResults(tresult, secondaryresult)); + displayCount = (tCount > displayCount) ? tCount : displayCount; + } + if (memberSearchIndex) { + var mCount = 0; + $.each(memberSearchIndex, function(index, item) { + item.category = catMembers; + var s = nestedName(item); + if (exactMatcher.test(s)) { + mresult.push(item); + mCount++; + } else if (camelCaseMatcher.test(s)) { + mresult.push(item); + } else if (secondaryMatcher.test(item.c + "." + item.l)) { + secondaryresult.push(item); + } + }); + result = result.concat(concatResults(mresult, secondaryresult)); + displayCount = (mCount > displayCount) ? mCount : displayCount; + } + if (tagSearchIndex) { + var tgCount = 0; + $.each(tagSearchIndex, function(index, item) { + item.category = catSearchTags; + if (exactMatcher.test(item.l)) { + tgresult.push(item); + tgCount++; + } else if (secondaryMatcher.test(item.l)) { + secondaryresult.push(item); + } + }); + result = result.concat(concatResults(tgresult, secondaryresult)); + displayCount = (tgCount > displayCount) ? tgCount : displayCount; + } + displayCount = (displayCount > 500) ? displayCount : 500; + var counter = function() { + var count = {Modules: 0, Packages: 0, Types: 0, Members: 0, SearchTags: 0}; + var f = function(item) { + count[item.category] += 1; + return (count[item.category] <= displayCount); + }; + return f; + }(); + response(result.filter(counter)); + }, + response: function(event, ui) { + if (!ui.content.length) { + ui.content.push(noResult); + } else { + $("#search").empty(); + } + }, + autoFocus: true, + position: { + collision: "flip" + }, + select: function(event, ui) { + if (ui.item.l !== noResult.l) { + var url = getURLPrefix(ui); + if (ui.item.category === catModules) { + if (useModuleDirectories) { + url += "module-summary.html"; + } else { + url = ui.item.l + "-summary.html"; + } + } else if (ui.item.category === catPackages) { + if (ui.item.url) { + url = ui.item.url; + } else { + url += ui.item.l.replace(/\./g, '/') + "/package-summary.html"; + } + } else if (ui.item.category === catTypes) { + if (ui.item.url) { + url = ui.item.url; + } else if (ui.item.p === "") { + url += ui.item.l + ".html"; + } else { + url += ui.item.p.replace(/\./g, '/') + "/" + ui.item.l + ".html"; + } + } else if (ui.item.category === catMembers) { + if (ui.item.p === "") { + url += ui.item.c + ".html" + "#"; + } else { + url += ui.item.p.replace(/\./g, '/') + "/" + ui.item.c + ".html" + "#"; + } + if (ui.item.url) { + url += ui.item.url; + } else { + url += ui.item.l; + } + } else if (ui.item.category === catSearchTags) { + url += ui.item.u; + } + if (top !== window) { + parent.classFrame.location = pathtoroot + url; + } else { + window.location.href = pathtoroot + url; + } + $("#search").focus(); + } + } + }); +}); diff --git a/javadoc/latest/serialized-form.html b/javadoc/latest/serialized-form.html new file mode 100644 index 000000000..085c2f821 --- /dev/null +++ b/javadoc/latest/serialized-form.html @@ -0,0 +1,185 @@ + + + + + +Serialized Form (multiverse-core 4.3.14 API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Serialized Form

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/latest/stylesheet.css b/javadoc/latest/stylesheet.css new file mode 100644 index 000000000..de945eda2 --- /dev/null +++ b/javadoc/latest/stylesheet.css @@ -0,0 +1,910 @@ +/* + * Javadoc style sheet + */ + +@import url('resources/fonts/dejavu.css'); + +/* + * Styles for individual HTML elements. + * + * These are styles that are specific to individual HTML elements. Changing them affects the style of a particular + * HTML element throughout the page. + */ + +body { + background-color:#ffffff; + color:#353833; + font-family:'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size:14px; + margin:0; + padding:0; + height:100%; + width:100%; +} +iframe { + margin:0; + padding:0; + height:100%; + width:100%; + overflow-y:scroll; + border:none; +} +a:link, a:visited { + text-decoration:none; + color:#4A6782; +} +a[href]:hover, a[href]:focus { + text-decoration:none; + color:#bb7a2a; +} +a[name] { + color:#353833; +} +a[name]:before, a[name]:target, a[id]:before, a[id]:target { + content:""; + display:inline-block; + position:relative; + padding-top:129px; + margin-top:-129px; +} +pre { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; +} +h1 { + font-size:20px; +} +h2 { + font-size:18px; +} +h3 { + font-size:16px; + font-style:italic; +} +h4 { + font-size:13px; +} +h5 { + font-size:12px; +} +h6 { + font-size:11px; +} +ul { + list-style-type:disc; +} +code, tt { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; + margin-top:8px; + line-height:1.4em; +} +dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; +} +table tr td dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + vertical-align:top; + padding-top:4px; +} +sup { + font-size:8px; +} + +/* + * Styles for HTML generated by javadoc. + * + * These are style classes that are used by the standard doclet to generate HTML documentation. + */ + +/* + * Styles for document title and copyright. + */ +.clear { + clear:both; + height:0px; + overflow:hidden; +} +.aboutLanguage { + float:right; + padding:0px 21px; + font-size:11px; + z-index:200; + margin-top:-9px; +} +.legalCopy { + margin-left:.5em; +} +.bar a, .bar a:link, .bar a:visited, .bar a:active { + color:#FFFFFF; + text-decoration:none; +} +.bar a:hover, .bar a:focus { + color:#bb7a2a; +} +.tab { + background-color:#0066FF; + color:#ffffff; + padding:8px; + width:5em; + font-weight:bold; +} +/* + * Styles for navigation bar. + */ +.bar { + background-color:#4D7A97; + color:#FFFFFF; + padding:.8em .5em .4em .8em; + height:auto;/*height:1.8em;*/ + font-size:11px; + margin:0; +} +.navPadding { + padding-top: 107px; +} +.fixedNav { + position:fixed; + width:100%; + z-index:999; + background-color:#ffffff; +} +.topNav { + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.bottomNav { + margin-top:10px; + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.subNav { + background-color:#dee3e9; + float:left; + width:100%; + overflow:hidden; + font-size:12px; +} +.subNav div { + clear:left; + float:left; + padding:0 0 5px 6px; + text-transform:uppercase; +} +ul.navList, ul.subNavList { + float:left; + margin:0 25px 0 0; + padding:0; +} +ul.navList li{ + list-style:none; + float:left; + padding: 5px 6px; + text-transform:uppercase; +} +ul.navListSearch { + float:right; + margin:0 0 0 0; + padding:0; +} +ul.navListSearch li { + list-style:none; + float:right; + padding: 5px 6px; + text-transform:uppercase; +} +ul.navListSearch li label { + position:relative; + right:-16px; +} +ul.subNavList li { + list-style:none; + float:left; +} +.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited { + color:#FFFFFF; + text-decoration:none; + text-transform:uppercase; +} +.topNav a:hover, .bottomNav a:hover { + text-decoration:none; + color:#bb7a2a; + text-transform:uppercase; +} +.navBarCell1Rev { + background-color:#F8981D; + color:#253441; + margin: auto 5px; +} +.skipNav { + position:absolute; + top:auto; + left:-9999px; + overflow:hidden; +} +/* + * Styles for page header and footer. + */ +.header, .footer { + clear:both; + margin:0 20px; + padding:5px 0 0 0; +} +.indexNav { + position:relative; + font-size:12px; + background-color:#dee3e9; +} +.indexNav ul { + margin-top:0; + padding:5px; +} +.indexNav ul li { + display:inline; + list-style-type:none; + padding-right:10px; + text-transform:uppercase; +} +.indexNav h1 { + font-size:13px; +} +.title { + color:#2c4557; + margin:10px 0; +} +.subTitle { + margin:5px 0 0 0; +} +.header ul { + margin:0 0 15px 0; + padding:0; +} +.footer ul { + margin:20px 0 5px 0; +} +.header ul li, .footer ul li { + list-style:none; + font-size:13px; +} +/* + * Styles for headings. + */ +div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList ul.blockList li.blockList h3 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList li.blockList h3 { + padding:0; + margin:15px 0; +} +ul.blockList li.blockList h2 { + padding:0px 0 20px 0; +} +/* + * Styles for page layout containers. + */ +.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer, +.allClassesContainer, .allPackagesContainer { + clear:both; + padding:10px 20px; + position:relative; +} +.indexContainer { + margin:10px; + position:relative; + font-size:12px; +} +.indexContainer h2 { + font-size:13px; + padding:0 0 3px 0; +} +.indexContainer ul { + margin:0; + padding:0; +} +.indexContainer ul li { + list-style:none; + padding-top:2px; +} +.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt { + font-size:12px; + font-weight:bold; + margin:10px 0 0 0; + color:#4E4E4E; +} +.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd { + margin:5px 0 10px 0px; + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} +.serializedFormContainer dl.nameValue dt { + margin-left:1px; + font-size:1.1em; + display:inline; + font-weight:bold; +} +.serializedFormContainer dl.nameValue dd { + margin:0 0 0 1px; + font-size:1.1em; + display:inline; +} +/* + * Styles for lists. + */ +li.circle { + list-style:circle; +} +ul.horizontal li { + display:inline; + font-size:0.9em; +} +ul.inheritance { + margin:0; + padding:0; +} +ul.inheritance li { + display:inline; + list-style:none; +} +ul.inheritance li ul.inheritance { + margin-left:15px; + padding-left:15px; + padding-top:1px; +} +ul.blockList, ul.blockListLast { + margin:10px 0 10px 0; + padding:0; +} +ul.blockList li.blockList, ul.blockListLast li.blockList { + list-style:none; + margin-bottom:15px; + line-height:1.4; +} +ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList { + padding:0px 20px 5px 10px; + border:1px solid #ededed; + background-color:#f8f8f8; +} +ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList { + padding:0 0 5px 8px; + background-color:#ffffff; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockList { + margin-left:0; + padding-left:0; + padding-bottom:15px; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast { + list-style:none; + border-bottom:none; + padding-bottom:0; +} +table tr td dl, table tr td dl dt, table tr td dl dd { + margin-top:0; + margin-bottom:1px; +} +/* + * Styles for tables. + */ +.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary, +.requiresSummary, .packagesSummary, .providesSummary, .usesSummary { + width:100%; + border-spacing:0; + border-left:1px solid #EEE; + border-right:1px solid #EEE; + border-bottom:1px solid #EEE; +} +.overviewSummary, .memberSummary, .requiresSummary, .packagesSummary, .providesSummary, .usesSummary { + padding:0px; +} +.overviewSummary caption, .memberSummary caption, .typeSummary caption, +.useSummary caption, .constantsSummary caption, .deprecatedSummary caption, +.requiresSummary caption, .packagesSummary caption, .providesSummary caption, .usesSummary caption { + position:relative; + text-align:left; + background-repeat:no-repeat; + color:#253441; + font-weight:bold; + clear:none; + overflow:hidden; + padding:0px; + padding-top:10px; + padding-left:1px; + margin:0px; + white-space:pre; +} +.constantsSummary caption a:link, .constantsSummary caption a:visited, +.useSummary caption a:link, .useSummary caption a:visited { + color:#1f389c; +} +.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link, +.deprecatedSummary caption a:link, +.requiresSummary caption a:link, .packagesSummary caption a:link, .providesSummary caption a:link, +.usesSummary caption a:link, +.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover, +.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover, +.requiresSummary caption a:hover, .packagesSummary caption a:hover, .providesSummary caption a:hover, +.usesSummary caption a:hover, +.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active, +.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active, +.requiresSummary caption a:active, .packagesSummary caption a:active, .providesSummary caption a:active, +.usesSummary caption a:active, +.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited, +.deprecatedSummary caption a:visited, +.requiresSummary caption a:visited, .packagesSummary caption a:visited, .providesSummary caption a:visited, +.usesSummary caption a:visited { + color:#FFFFFF; +} +.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span, +.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span, +.requiresSummary caption span, .packagesSummary caption span, .providesSummary caption span, +.usesSummary caption span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + padding-bottom:7px; + display:inline-block; + float:left; + background-color:#F8981D; + border: none; + height:16px; +} +.memberSummary caption span.activeTableTab span, .packagesSummary caption span.activeTableTab span, +.overviewSummary caption span.activeTableTab span, .typeSummary caption span.activeTableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#F8981D; + height:16px; +} +.memberSummary caption span.tableTab span, .packagesSummary caption span.tableTab span, +.overviewSummary caption span.tableTab span, .typeSummary caption span.tableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#4D7A97; + height:16px; +} +.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab, +.packagesSummary caption span.tableTab, .packagesSummary caption span.activeTableTab, +.overviewSummary caption span.tableTab, .overviewSummary caption span.activeTableTab, +.typeSummary caption span.tableTab, .typeSummary caption span.activeTableTab { + padding-top:0px; + padding-left:0px; + padding-right:0px; + background-image:none; + float:none; + display:inline; +} +.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd, +.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd, +.requiresSummary .tabEnd, .packagesSummary .tabEnd, .providesSummary .tabEnd, .usesSummary .tabEnd { + display:none; + width:5px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .activeTableTab .tabEnd, .packagesSummary .activeTableTab .tabEnd, +.overviewSummary .activeTableTab .tabEnd, .typeSummary .activeTableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .tableTab .tabEnd, .packagesSummary .tableTab .tabEnd, +.overviewSummary .tableTab .tabEnd, .typeSummary .tableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + background-color:#4D7A97; + float:left; +} +.rowColor th, .altColor th { + font-weight:normal; +} +.overviewSummary td, .memberSummary td, .typeSummary td, +.useSummary td, .constantsSummary td, .deprecatedSummary td, +.requiresSummary td, .packagesSummary td, .providesSummary td, .usesSummary td { + text-align:left; + padding:0px 0px 12px 10px; +} +th.colFirst, th.colSecond, th.colLast, th.colConstructorName, th.colDeprecatedItemName, .useSummary th, +.constantsSummary th, .packagesSummary th, td.colFirst, td.colSecond, td.colLast, .useSummary td, +.constantsSummary td { + vertical-align:top; + padding-right:0px; + padding-top:8px; + padding-bottom:3px; +} +th.colFirst, th.colSecond, th.colLast, th.colConstructorName, th.colDeprecatedItemName, .constantsSummary th, +.packagesSummary th { + background:#dee3e9; + text-align:left; + padding:8px 3px 3px 7px; +} +td.colFirst, th.colFirst { + font-size:13px; +} +td.colSecond, th.colSecond, td.colLast, th.colConstructorName, th.colDeprecatedItemName, th.colLast { + font-size:13px; +} +.constantsSummary th, .packagesSummary th { + font-size:13px; +} +.providesSummary th.colFirst, .providesSummary th.colLast, .providesSummary td.colFirst, +.providesSummary td.colLast { + white-space:normal; + font-size:13px; +} +.overviewSummary td.colFirst, .overviewSummary th.colFirst, +.requiresSummary td.colFirst, .requiresSummary th.colFirst, +.packagesSummary td.colFirst, .packagesSummary td.colSecond, .packagesSummary th.colFirst, .packagesSummary th, +.usesSummary td.colFirst, .usesSummary th.colFirst, +.providesSummary td.colFirst, .providesSummary th.colFirst, +.memberSummary td.colFirst, .memberSummary th.colFirst, +.memberSummary td.colSecond, .memberSummary th.colSecond, .memberSummary th.colConstructorName, +.typeSummary td.colFirst, .typeSummary th.colFirst { + vertical-align:top; +} +.packagesSummary th.colLast, .packagesSummary td.colLast { + white-space:normal; +} +td.colFirst a:link, td.colFirst a:visited, +td.colSecond a:link, td.colSecond a:visited, +th.colFirst a:link, th.colFirst a:visited, +th.colSecond a:link, th.colSecond a:visited, +th.colConstructorName a:link, th.colConstructorName a:visited, +th.colDeprecatedItemName a:link, th.colDeprecatedItemName a:visited, +.constantValuesContainer td a:link, .constantValuesContainer td a:visited, +.allClassesContainer td a:link, .allClassesContainer td a:visited, +.allPackagesContainer td a:link, .allPackagesContainer td a:visited { + font-weight:bold; +} +.tableSubHeadingColor { + background-color:#EEEEFF; +} +.altColor, .altColor th { + background-color:#FFFFFF; +} +.rowColor, .rowColor th { + background-color:#EEEEEF; +} +/* + * Styles for contents. + */ +.description pre { + margin-top:0; +} +.deprecatedContent { + margin:0; + padding:10px 0; +} +.docSummary { + padding:0; +} +ul.blockList ul.blockList ul.blockList li.blockList h3 { + font-style:normal; +} +div.block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} +td.colLast div { + padding-top:0px; +} +td.colLast a { + padding-bottom:3px; +} +/* + * Styles for formatting effect. + */ +.sourceLineNo { + color:green; + padding:0 30px 0 0; +} +h1.hidden { + visibility:hidden; + overflow:hidden; + font-size:10px; +} +.block { + display:block; + margin:3px 10px 2px 0px; + color:#474747; +} +.deprecatedLabel, .descfrmTypeLabel, .implementationLabel, .memberNameLabel, .memberNameLink, +.moduleLabelInPackage, .moduleLabelInType, .overrideSpecifyLabel, .packageLabelInType, +.packageHierarchyLabel, .paramLabel, .returnLabel, .seeLabel, .simpleTagLabel, +.throwsLabel, .typeNameLabel, .typeNameLink, .searchTagLink { + font-weight:bold; +} +.deprecationComment, .emphasizedPhrase, .interfaceName { + font-style:italic; +} +.deprecationBlock { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; + border-style:solid; + border-width:thin; + border-radius:10px; + padding:10px; + margin-bottom:10px; + margin-right:10px; + display:inline-block; +} +div.block div.deprecationComment, div.block div.block span.emphasizedPhrase, +div.block div.block span.interfaceName { + font-style:normal; +} +div.contentContainer ul.blockList li.blockList h2 { + padding-bottom:0px; +} +/* + * Styles for IFRAME. + */ +.mainContainer { + margin:0 auto; + padding:0; + height:100%; + width:100%; + position:fixed; + top:0; + left:0; +} +.leftContainer { + height:100%; + position:fixed; + width:320px; +} +.leftTop { + position:relative; + float:left; + width:315px; + top:0; + left:0; + height:30%; + border-right:6px solid #ccc; + border-bottom:6px solid #ccc; +} +.leftBottom { + position:relative; + float:left; + width:315px; + bottom:0; + left:0; + height:70%; + border-right:6px solid #ccc; + border-top:1px solid #000; +} +.rightContainer { + position:absolute; + left:320px; + top:0; + bottom:0; + height:100%; + right:0; + border-left:1px solid #000; +} +.rightIframe { + margin:0; + padding:0; + height:100%; + right:30px; + width:100%; + overflow:visible; + margin-bottom:30px; +} +/* + * Styles specific to HTML5 elements. + */ +main, nav, header, footer, section { + display:block; +} +/* + * Styles for javadoc search. + */ +.ui-autocomplete-category { + font-weight:bold; + font-size:15px; + padding:7px 0 7px 3px; + background-color:#4D7A97; + color:#FFFFFF; +} +.resultItem { + font-size:13px; +} +.ui-autocomplete { + max-height:85%; + max-width:65%; + overflow-y:scroll; + overflow-x:scroll; + white-space:nowrap; + box-shadow: 0 3px 6px rgba(0,0,0,0.16), 0 3px 6px rgba(0,0,0,0.23); +} +ul.ui-autocomplete { + position:fixed; + z-index:999999; + background-color: #FFFFFF; +} +ul.ui-autocomplete li { + float:left; + clear:both; + width:100%; +} +.resultHighlight { + font-weight:bold; +} +.ui-autocomplete .result-item { + font-size: inherit; +} +#search { + background-image:url('resources/glass.png'); + background-size:13px; + background-repeat:no-repeat; + background-position:2px 3px; + padding-left:20px; + position:relative; + right:-18px; +} +#reset { + background-color: rgb(255,255,255); + background-image:url('resources/x.png'); + background-position:center; + background-repeat:no-repeat; + background-size:12px; + border:0 none; + width:16px; + height:17px; + position:relative; + left:-4px; + top:-4px; + font-size:0px; +} +.watermark { + color:#545454; +} +.searchTagDescResult { + font-style:italic; + font-size:11px; +} +.searchTagHolderResult { + font-style:italic; + font-size:12px; +} +.searchTagResult:before, .searchTagResult:target { + color:red; +} +.moduleGraph span { + display:none; + position:absolute; +} +.moduleGraph:hover span { + display:block; + margin: -100px 0 0 100px; + z-index: 1; +} +.methodSignature { + white-space:normal; +} + +/* + * Styles for user-provided tables. + * + * borderless: + * No borders, vertical margins, styled caption. + * This style is provided for use with existing doc comments. + * In general, borderless tables should not be used for layout purposes. + * + * plain: + * Plain borders around table and cells, vertical margins, styled caption. + * Best for small tables or for complex tables for tables with cells that span + * rows and columns, when the "striped" style does not work well. + * + * striped: + * Borders around the table and vertical borders between cells, striped rows, + * vertical margins, styled caption. + * Best for tables that have a header row, and a body containing a series of simple rows. + */ + +table.borderless, +table.plain, +table.striped { + margin-top: 10px; + margin-bottom: 10px; +} +table.borderless > caption, +table.plain > caption, +table.striped > caption { + font-weight: bold; + font-size: smaller; +} +table.borderless th, table.borderless td, +table.plain th, table.plain td, +table.striped th, table.striped td { + padding: 2px 5px; +} +table.borderless, +table.borderless > thead > tr > th, table.borderless > tbody > tr > th, table.borderless > tr > th, +table.borderless > thead > tr > td, table.borderless > tbody > tr > td, table.borderless > tr > td { + border: none; +} +table.borderless > thead > tr, table.borderless > tbody > tr, table.borderless > tr { + background-color: transparent; +} +table.plain { + border-collapse: collapse; + border: 1px solid black; +} +table.plain > thead > tr, table.plain > tbody tr, table.plain > tr { + background-color: transparent; +} +table.plain > thead > tr > th, table.plain > tbody > tr > th, table.plain > tr > th, +table.plain > thead > tr > td, table.plain > tbody > tr > td, table.plain > tr > td { + border: 1px solid black; +} +table.striped { + border-collapse: collapse; + border: 1px solid black; +} +table.striped > thead { + background-color: #E3E3E3; +} +table.striped > thead > tr > th, table.striped > thead > tr > td { + border: 1px solid black; +} +table.striped > tbody > tr:nth-child(even) { + background-color: #EEE +} +table.striped > tbody > tr:nth-child(odd) { + background-color: #FFF +} +table.striped > tbody > tr > th, table.striped > tbody > tr > td { + border-left: 1px solid black; + border-right: 1px solid black; +} +table.striped > tbody > tr > th { + font-weight: normal; +} diff --git a/javadoc/latest/type-search-index.js b/javadoc/latest/type-search-index.js new file mode 100644 index 000000000..ff39c29ac --- /dev/null +++ b/javadoc/latest/type-search-index.js @@ -0,0 +1 @@ +typeSearchIndex = [{"p":"com.onarandombox.MultiverseCore.enums","l":"Action"},{"p":"com.onarandombox.MultiverseCore.enums","l":"AddProperties"},{"l":"All Classes","url":"allclasses-index.html"},{"p":"com.onarandombox.MultiverseCore.enums","l":"AllowedPortalType"},{"p":"com.onarandombox.MultiverseCore.commands","l":"AnchorCommand"},{"p":"com.onarandombox.MultiverseCore.destination","l":"AnchorDestination"},{"p":"com.onarandombox.MultiverseCore.utils","l":"AnchorManager"},{"p":"com.onarandombox.MultiverseCore.listeners","l":"AsyncChatEvent"},{"p":"com.onarandombox.MultiverseCore.destination","l":"BedDestination"},{"p":"com.onarandombox.MultiverseCore.api","l":"BlockSafety"},{"p":"com.onarandombox.MultiverseCore.display","l":"ContentDisplay.Builder"},{"p":"com.onarandombox.MultiverseCore.utils","l":"BukkitTravelAgent"},{"p":"com.onarandombox.MultiverseCore.destination","l":"CannonDestination"},{"p":"com.onarandombox.MultiverseCore.listeners","l":"ChatEvent"},{"p":"com.onarandombox.MultiverseCore.commands","l":"CheckCommand"},{"p":"com.onarandombox.MultiverseCore.commands","l":"CloneCommand"},{"p":"com.onarandombox.MultiverseCore.display","l":"ColorAlternator"},{"p":"com.onarandombox.MultiverseCore.display","l":"ColorTool"},{"p":"com.onarandombox.MultiverseCore.commandtools.queue","l":"CommandQueueManager"},{"p":"com.onarandombox.MultiverseCore.utils","l":"CompatibilityLayer"},{"p":"com.onarandombox.MultiverseCore.commands","l":"ConfigCommand"},{"p":"com.onarandombox.MultiverseCore.commands","l":"ConfirmCommand"},{"p":"com.onarandombox.MultiverseCore.display","l":"ContentDisplay"},{"p":"com.onarandombox.MultiverseCore.display","l":"ContentFilter"},{"p":"com.onarandombox.MultiverseCore.commands","l":"CoordCommand"},{"p":"com.onarandombox.MultiverseCore.api","l":"Core"},{"p":"com.onarandombox.MultiverseCore.commands","l":"CreateCommand"},{"p":"com.onarandombox.MultiverseCore.destination","l":"CustomTeleporterDestination"},{"p":"com.onarandombox.MultiverseCore.commands","l":"DebugCommand"},{"p":"com.onarandombox.MultiverseCore.utils","l":"DebugLog"},{"p":"com.onarandombox.MultiverseCore.commands","l":"DeleteCommand"},{"p":"com.onarandombox.MultiverseCore.destination","l":"DestinationFactory"},{"p":"com.onarandombox.MultiverseCore.display","l":"DisplayFormatException"},{"p":"com.onarandombox.MultiverseCore.display","l":"DisplayHandler"},{"p":"com.onarandombox.MultiverseCore.display","l":"DisplayHandlers"},{"p":"com.onarandombox.MultiverseCore.display.settings","l":"DisplaySetting"},{"p":"com.onarandombox.MultiverseCore.enums","l":"EnglishChatColor"},{"p":"com.onarandombox.MultiverseCore.enums","l":"EnglishChatStyle"},{"p":"com.onarandombox.MultiverseCore.configuration","l":"EntryFee"},{"p":"com.onarandombox.MultiverseCore.configuration","l":"EntryFee.EntryFeeCurrencySerializor"},{"p":"com.onarandombox.MultiverseCore.commands","l":"EnvironmentCommand"},{"p":"com.onarandombox.MultiverseCore.destination","l":"ExactDestination"},{"p":"com.onarandombox.MultiverseCore.utils","l":"FancyColorScheme"},{"p":"com.onarandombox.MultiverseCore.utils","l":"FancyHeader"},{"p":"com.onarandombox.MultiverseCore.utils","l":"FancyMessage"},{"p":"com.onarandombox.MultiverseCore.api","l":"FancyText"},{"p":"com.onarandombox.MultiverseCore.utils","l":"FileUtils"},{"p":"com.onarandombox.MultiverseCore.commands","l":"PaginatedCommand.FilterObject"},{"p":"com.onarandombox.MultiverseCore.utils","l":"WorldNameChecker.FolderStatus"},{"p":"com.onarandombox.MultiverseCore.commands","l":"GameruleCommand"},{"p":"com.onarandombox.MultiverseCore.commands","l":"GamerulesCommand"},{"p":"com.onarandombox.MultiverseCore.commands","l":"GeneratorCommand"},{"p":"com.onarandombox.MultiverseCore.commands","l":"HelpCommand"},{"p":"com.onarandombox.MultiverseCore.commands","l":"ImportCommand"},{"p":"com.onarandombox.MultiverseCore.commands","l":"InfoCommand"},{"p":"com.onarandombox.MultiverseCore.display.settings","l":"InlineDisplaySettings"},{"p":"com.onarandombox.MultiverseCore.display.handlers","l":"InlineListDisplayHandler"},{"p":"com.onarandombox.MultiverseCore.display.handlers","l":"InlineMapDisplayHandler"},{"p":"com.onarandombox.MultiverseCore.destination","l":"InvalidDestination"},{"p":"com.onarandombox.MultiverseCore.commands","l":"ListCommand"},{"p":"com.onarandombox.MultiverseCore.display.handlers","l":"ListDisplayHandler"},{"p":"com.onarandombox.MultiverseCore.commands","l":"LoadCommand"},{"p":"com.onarandombox.MultiverseCore.api","l":"LocationManipulation"},{"p":"com.onarandombox.MultiverseCore.utils","l":"LocationManipulation"},{"p":"com.onarandombox.MultiverseCore.api","l":"LoggablePlugin"},{"p":"com.onarandombox.MultiverseCore.display.settings","l":"MapDisplaySettings"},{"p":"com.onarandombox.MultiverseCore.utils","l":"MaterialConverter"},{"p":"com.onarandombox.MultiverseCore.utils.metrics","l":"MetricsConfigurator"},{"p":"com.onarandombox.MultiverseCore.commands","l":"ModifyAddCommand"},{"p":"com.onarandombox.MultiverseCore.commands","l":"ModifyClearCommand"},{"p":"com.onarandombox.MultiverseCore.commands","l":"ModifyCommand"},{"p":"com.onarandombox.MultiverseCore.commands","l":"ModifyRemoveCommand"},{"p":"com.onarandombox.MultiverseCore.commands","l":"ModifySetCommand"},{"p":"com.onarandombox.MultiverseCore.commands","l":"MultiverseCommand"},{"p":"com.onarandombox.MultiverseCore","l":"MultiverseCore"},{"p":"com.onarandombox.MultiverseCore.api","l":"MultiverseCoreConfig"},{"p":"com.onarandombox.MultiverseCore","l":"MultiverseCoreConfiguration"},{"p":"com.onarandombox.MultiverseCore.listeners","l":"MultiverseCoreListener"},{"p":"com.onarandombox.MultiverseCore.api","l":"MultiverseMessaging"},{"p":"com.onarandombox.MultiverseCore.api","l":"MultiversePlugin"},{"p":"com.onarandombox.MultiverseCore.api","l":"MultiverseWorld"},{"p":"com.onarandombox.MultiverseCore.listeners","l":"MVAsyncPlayerChatListener"},{"p":"com.onarandombox.MultiverseCore.listeners","l":"MVChatListener"},{"p":"com.onarandombox.MultiverseCore.event","l":"MVConfigReloadEvent"},{"p":"com.onarandombox.MultiverseCore.event","l":"MVDebugModeEvent"},{"p":"com.onarandombox.MultiverseCore.api","l":"MVDestination"},{"p":"com.onarandombox.MultiverseCore.utils","l":"MVEconomist"},{"p":"com.onarandombox.MultiverseCore.listeners","l":"MVEntityListener"},{"p":"com.onarandombox.MultiverseCore.listeners","l":"MVMapListener"},{"p":"com.onarandombox.MultiverseCore.utils","l":"MVMessaging"},{"p":"com.onarandombox.MultiverseCore.utils","l":"MVPermissions"},{"p":"com.onarandombox.MultiverseCore.listeners","l":"MVPlayerChatListener"},{"p":"com.onarandombox.MultiverseCore.listeners","l":"MVPlayerListener"},{"p":"com.onarandombox.MultiverseCore.utils","l":"MVPlayerSession"},{"p":"com.onarandombox.MultiverseCore.event","l":"MVPlayerTouchedPortalEvent"},{"p":"com.onarandombox.MultiverseCore.api","l":"MVPlugin"},{"p":"com.onarandombox.MultiverseCore.listeners","l":"MVPortalListener"},{"p":"com.onarandombox.MultiverseCore.event","l":"MVRespawnEvent"},{"p":"com.onarandombox.MultiverseCore.event","l":"MVTeleportEvent"},{"p":"com.onarandombox.MultiverseCore.utils","l":"MVTravelAgent"},{"p":"com.onarandombox.MultiverseCore.event","l":"MVVersionEvent"},{"p":"com.onarandombox.MultiverseCore.listeners","l":"MVWeatherListener"},{"p":"com.onarandombox.MultiverseCore","l":"MVWorld"},{"p":"com.onarandombox.MultiverseCore.event","l":"MVWorldDeleteEvent"},{"p":"com.onarandombox.MultiverseCore.listeners","l":"MVWorldInitListener"},{"p":"com.onarandombox.MultiverseCore.listeners","l":"MVWorldListener"},{"p":"com.onarandombox.MultiverseCore.api","l":"MVWorldManager"},{"p":"com.onarandombox.MultiverseCore.event","l":"MVWorldPropertyChangeEvent"},{"p":"com.onarandombox.MultiverseCore.utils","l":"WorldNameChecker.NameStatus"},{"p":"com.onarandombox.MultiverseCore.listeners","l":"NormalChatEvent"},{"p":"com.onarandombox.MultiverseCore","l":"MVWorld.NullLocation"},{"p":"com.onarandombox.MultiverseCore.display.settings","l":"PagedDisplaySettings"},{"p":"com.onarandombox.MultiverseCore.display.handlers","l":"PagedListDisplayHandler"},{"p":"com.onarandombox.MultiverseCore.commands","l":"PaginatedCommand"},{"p":"com.onarandombox.MultiverseCore.commands","l":"PaginatedCoreCommand"},{"p":"com.onarandombox.MultiverseCore.utils.webpaste","l":"PasteFailedException"},{"p":"com.onarandombox.MultiverseCore.utils.webpaste","l":"PasteService"},{"p":"com.onarandombox.MultiverseCore.utils.webpaste","l":"PasteServiceFactory"},{"p":"com.onarandombox.MultiverseCore.utils.webpaste","l":"PasteServiceType"},{"p":"com.onarandombox.MultiverseCore.utils","l":"PermissionTools"},{"p":"com.onarandombox.MultiverseCore.destination","l":"PlayerDestination"},{"p":"com.onarandombox.MultiverseCore.utils","l":"PlayerFinder"},{"p":"com.onarandombox.MultiverseCore.exceptions","l":"PropertyDoesNotExistException"},{"p":"com.onarandombox.MultiverseCore.commands","l":"PurgeCommand"},{"p":"com.onarandombox.MultiverseCore.utils","l":"PurgeWorlds"},{"p":"com.onarandombox.MultiverseCore.commandtools.queue","l":"QueuedCommand"},{"p":"com.onarandombox.MultiverseCore.utils","l":"ReflectHelper"},{"p":"com.onarandombox.MultiverseCore.commands","l":"RegenCommand"},{"p":"com.onarandombox.MultiverseCore.commands","l":"ReloadCommand"},{"p":"com.onarandombox.MultiverseCore.commands","l":"RemoveCommand"},{"p":"com.onarandombox.MultiverseCore.enums","l":"RespawnType"},{"p":"com.onarandombox.MultiverseCore.api","l":"SafeTTeleporter"},{"p":"com.onarandombox.MultiverseCore.commands","l":"ScriptCommand"},{"p":"com.onarandombox.MultiverseCore.commands","l":"SetSpawnCommand"},{"p":"com.onarandombox.MultiverseCore.commands","l":"SilentCommand"},{"p":"com.onarandombox.MultiverseCore.utils","l":"SimpleBlockSafety"},{"p":"com.onarandombox.MultiverseCore.utils","l":"SimpleLocationManipulation"},{"p":"com.onarandombox.MultiverseCore.utils","l":"SimpleSafeTTeleporter"},{"p":"com.onarandombox.MultiverseCore.utils","l":"SimpleWorldPurger"},{"p":"com.onarandombox.MultiverseCore.commands","l":"SleepCommand"},{"p":"com.onarandombox.MultiverseCore.commands","l":"SpawnCommand"},{"p":"com.onarandombox.MultiverseCore.configuration","l":"SpawnLocation"},{"p":"com.onarandombox.MultiverseCore.configuration","l":"SpawnSettings"},{"p":"com.onarandombox.MultiverseCore.configuration","l":"SubSpawnSettings"},{"p":"com.onarandombox.MultiverseCore.commands","l":"TeleportCommand"},{"p":"com.onarandombox.MultiverseCore.api","l":"Teleporter"},{"p":"com.onarandombox.MultiverseCore.enums","l":"TeleportResult"},{"p":"com.onarandombox.MultiverseCore.utils","l":"TestingMode"},{"p":"com.onarandombox.MultiverseCore.commands","l":"UnloadCommand"},{"p":"com.onarandombox.MultiverseCore.utils","l":"UnsafeCallWrapper"},{"p":"com.onarandombox.MultiverseCore.utils.webpaste","l":"URLShortener"},{"p":"com.onarandombox.MultiverseCore.utils.webpaste","l":"URLShortenerFactory"},{"p":"com.onarandombox.MultiverseCore.utils.webpaste","l":"URLShortenerType"},{"p":"com.onarandombox.MultiverseCore.utils","l":"VaultHandler"},{"p":"com.onarandombox.MultiverseCore.commands","l":"VersionCommand"},{"p":"com.onarandombox.MultiverseCore.commands","l":"WhoCommand"},{"p":"com.onarandombox.MultiverseCore.destination","l":"WorldDestination"},{"p":"com.onarandombox.MultiverseCore.utils","l":"WorldManager"},{"p":"com.onarandombox.MultiverseCore.utils","l":"WorldNameChecker"},{"p":"com.onarandombox.MultiverseCore","l":"WorldProperties"},{"p":"com.onarandombox.MultiverseCore.configuration","l":"WorldPropertyValidator"},{"p":"com.onarandombox.MultiverseCore.api","l":"WorldPurger"}] \ No newline at end of file diff --git a/javadoc/latest/type-search-index.zip b/javadoc/latest/type-search-index.zip new file mode 100644 index 0000000000000000000000000000000000000000..745da26edd72e49a7bebeda2fdcb9718669118d3 GIT binary patch literal 1588 zcmZvcYd8}M7{^!Ij3|joS}}y<*5yQwX}LAFh}<=I3&S{V8LMQ(&K9|=P%c?bv~p)9 z&D@$xwcJKSQp8LlMb4c1bUM#-e(#6(|2+Tqc|ZP~&{A8J0AMf}U}lW>0{jBxM<&Ka zV+{$|fOA2ihGF<%Y^)KE5QTq`k0#BUC?ss4w$Gi}NDwPZlL_0(l)zrgL=BM)Qx(lJ z$bNZS^7UHq-g=Fu)V6IA>m_lazKi=dw(&T|Nheik?ycb5xj+UY%RbE=&vDJbNy#wT zOwc&UuBExVvLE+pydeR(bP-3C=|C~z96#H2JzHnDiFgk+l7sr$UPcjv_f}IdyqPQ6 z>D*#{Y@kCHBSJOiTYcTiCT%H?xZ^N_d9pjp8p}}h#YXm7&#l!}j-W)Wv#=b`q^A6Y z>gwW|Im+pI*F5|cDBe;4E)i>N&$P=~1RTHB+}o}{Ed0`);YJH=&?)oIj94jYy76X6 zk&uEL;Wa-TA1m|ORRw%s=+Z#2I@Z_=jsyiK3R7k319K3lG<9H_u_ z=JPC1?g+13VbPOP%MOzpkB&@X0vtDWT#}cBOSLXGOW=_H+=2GZ3Mdp(A!iF2eIdcE zHzue4HTjw6L#|3f^j2Xl@t~q=d$Lo==;K+tg2c)9NRT$VMI~VT<4{+$@S(c$^(<8 z@j6u_>_smXr=R8yOs#dPj8VVQ7EkbQV8B;|?$K9Oya$uh1 zGw>qDk580fVDRq?loPk;bv1xJd=x*JIqrVh5>j8L5_#aVBJi8{){}?$EZJLU0_G;L z5)|A;)4VG_u{_X>rF%a2jMlWdzbY-(00T=)W_mz9wZ2#{-LWb!Rx4ip98a)Qik!K@ zrZh$nZ<_DG>aG~DEbbfH3W^;ch3wRcWIB)oPw28*bPZv$FRS{VpqShYY}#82Lbl)c z1=-LY>{6*G+d-B*PaDRM=S5n*8fM^Tcg;u_;yEr^n=3N~nS&S6=?tq_Nzn}EsaSlj zUJ5f+28Nkj6x%l>^c24w9bV=acdbmPEB6}N3E!;GvvqKu)04( z|Cl$Lu=FPTcC75qexI>s=#yauBcgn6s-?E8QM2R=_{!9URpInKe>+v>k4tNCl2NCF zMLorKmO<&^T!qX$ln*Ki$DzMY8@;{VEoY?CKdGY7lpErdJL%Idn&kGUcg}e0Oxct^ zrfd7?bT2~wWc8~k#BfRVua_!g$CWvV(UZ_S?a@r6c2w2haQ*%Ird!0TT%b^t?nzSe z=+7^|V;rI?K1|4ZHS{{WfCu}oRiW>{=&HGwT|C@@Ma}j_y{WqJVScSoa$^>>hs#YB++1sX2F)n1r7R*0NA9%ThNUXlLMH|vy$#?_*+ue{8FNh}wEfmeK4v53NytMvQD z4=5aZ+z>+`$8MPZe(d~iA;X*)3>6o)qIGVruOgh#(%=fUvBf+f0I=N<0B}NY+N=cl g*X_S{Ki&Rc{@?UYXdvk4-KHO7^J9