From 7abb7b888c0b727033c7595cc6c0c3a4171b59cb Mon Sep 17 00:00:00 2001 From: Redempt Date: Mon, 12 Jul 2021 23:52:21 -0400 Subject: [PATCH] Bugfix for plugins not using Java --- javadoc/allclasses-index.html | 815 +- javadoc/allclasses.html | 136 - javadoc/allpackages-index.html | 281 +- javadoc/constant-values.html | 123 +- javadoc/deprecated-list.html | 242 +- javadoc/help-doc.html | 223 +- javadoc/index-all.html | 2927 ++-- javadoc/index.html | 283 +- javadoc/jquery-ui.overrides.css | 34 + javadoc/jquery/external/jquery/jquery.js | 10872 --------------- javadoc/jquery/jquery-3.5.1.js | 10872 --------------- javadoc/jquery/jquery-ui.css | 582 - javadoc/jquery/jquery-ui.js | 2659 ---- javadoc/jquery/jquery-ui.structure.css | 156 - .../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/jquery/jszip/dist/jszip.js | 11367 ---------------- javadoc/jquery/jszip/dist/jszip.min.js | 13 - javadoc/member-search-index.js | 2 +- javadoc/module-search-index.js | 1 + javadoc/overview-summary.html | 10 +- javadoc/overview-tree.html | 359 +- javadoc/package-search-index.js | 2 +- javadoc/redempt/redlib/RedLib.html | 578 +- .../redlib/blockdata/BlockDataManager.html | 1252 +- .../redempt/redlib/blockdata/CustomBlock.html | 409 +- .../redlib/blockdata/CustomBlockRegistry.html | 620 +- .../redlib/blockdata/CustomBlockType.html | 631 +- .../redempt/redlib/blockdata/DataBlock.html | 1181 +- .../events/CustomBlockPlaceEvent.html | 568 +- .../DataBlockDestroyEvent.DestroyCause.html | 472 +- .../events/DataBlockDestroyEvent.html | 621 +- .../blockdata/events/DataBlockMoveEvent.html | 539 +- .../blockdata/events/package-summary.html | 183 +- .../redlib/blockdata/events/package-tree.html | 143 +- .../redlib/blockdata/package-summary.html | 175 +- .../redlib/blockdata/package-tree.html | 141 +- .../redlib/commandmanager/ArgSubtype.html | 432 +- .../commandmanager/ArgType.ArgConverter.html | 256 +- .../commandmanager/ArgType.TabCompleter.html | 256 +- .../ArgType.TabStreamCompleter.html | 256 +- .../redlib/commandmanager/ArgType.html | 962 +- .../commandmanager/Command.MethodHook.html | 349 +- .../commandmanager/Command.SenderType.html | 434 +- .../redlib/commandmanager/Command.html | 1135 +- .../commandmanager/CommandCollection.html | 437 +- .../redlib/commandmanager/CommandHook.html | 234 +- .../redlib/commandmanager/CommandParser.html | 411 +- .../commandmanager/ContextProvider.html | 711 +- .../redlib/commandmanager/Messages.html | 445 +- .../exceptions/CommandHookException.html | 307 +- .../exceptions/CommandParseException.html | 307 +- .../exceptions/package-summary.html | 157 +- .../exceptions/package-tree.html | 135 +- .../commandmanager/package-summary.html | 265 +- .../redlib/commandmanager/package-tree.html | 165 +- .../redlib/configmanager/ConfigManager.html | 953 +- .../redlib/configmanager/ConfigStorage.html | 286 +- .../redlib/configmanager/ConversionType.html | 476 +- .../annotations/ConfigMappable.html | 161 +- .../configmanager/annotations/ConfigPath.html | 161 +- .../annotations/ConfigPostInit.html | 161 +- .../annotations/ConfigValue.html | 334 +- .../annotations/package-summary.html | 169 +- .../annotations/package-tree.html | 139 +- .../exceptions/ConfigFieldException.html | 307 +- .../exceptions/ConfigListException.html | 307 +- .../exceptions/ConfigMapException.html | 307 +- .../exceptions/package-summary.html | 163 +- .../exceptions/package-tree.html | 137 +- .../redlib/configmanager/package-summary.html | 191 +- .../redlib/configmanager/package-tree.html | 143 +- javadoc/redempt/redlib/dev/ChainCommand.html | 347 +- javadoc/redempt/redlib/dev/StructureTool.html | 434 +- .../redempt/redlib/dev/package-summary.html | 157 +- javadoc/redempt/redlib/dev/package-tree.html | 135 +- .../redlib/dev/profiler/BurstProfiler.html | 445 +- .../redlib/dev/profiler/PassiveProfiler.html | 420 +- .../redempt/redlib/dev/profiler/Profiler.html | 412 +- .../redlib/dev/profiler/ProfilerCommands.html | 719 +- .../profiler/SampleSummary.SampleMethod.html | 631 +- .../redlib/dev/profiler/SampleSummary.html | 535 +- .../dev/profiler/TickMonitorProfiler.html | 406 +- .../redlib/dev/profiler/package-summary.html | 187 +- .../redlib/dev/profiler/package-tree.html | 145 +- .../redlib/enchants/CustomEnchant.html | 870 +- .../redempt/redlib/enchants/EnchantInfo.html | 359 +- .../redlib/enchants/EnchantRegistry.html | 725 +- .../redempt/redlib/enchants/EventItems.html | 473 +- .../events/PlayerChangedArmorEvent.html | 508 +- .../events/PlayerChangedHeldItemEvent.html | 510 +- .../enchants/events/package-summary.html | 157 +- .../redlib/enchants/events/package-tree.html | 135 +- .../redlib/enchants/package-summary.html | 169 +- .../redempt/redlib/enchants/package-tree.html | 139 +- .../enchants/trigger/EnchantTrigger.html | 692 +- .../enchants/trigger/KillEntityTrigger.html | 396 +- .../enchants/trigger/package-summary.html | 157 +- .../redlib/enchants/trigger/package-tree.html | 135 +- .../inventorygui/InventoryGUI.GUIState.html | 267 +- .../redlib/inventorygui/InventoryGUI.html | 1221 +- .../redlib/inventorygui/ItemButton.html | 510 +- .../redlib/inventorygui/package-summary.html | 163 +- .../redlib/inventorygui/package-tree.html | 137 +- .../redempt/redlib/itemutils/CustomItem.html | 436 +- .../redempt/redlib/itemutils/ItemBuilder.html | 819 +- .../redempt/redlib/itemutils/ItemTrait.html | 520 +- .../redempt/redlib/itemutils/ItemUtils.html | 1456 +- .../redempt/redlib/itemutils/LoreStats.html | 536 +- .../redlib/itemutils/package-summary.html | 189 +- .../redlib/itemutils/package-tree.html | 145 +- javadoc/redempt/redlib/json/JSONList.html | 743 +- javadoc/redempt/redlib/json/JSONMap.html | 727 +- javadoc/redempt/redlib/json/JSONParser.html | 355 +- .../redempt/redlib/json/package-summary.html | 163 +- javadoc/redempt/redlib/json/package-tree.html | 137 +- .../redlib/misc/ChatPrompt.CancelReason.html | 434 +- javadoc/redempt/redlib/misc/ChatPrompt.html | 394 +- .../redempt/redlib/misc/EntityPersistor.html | 333 +- .../redempt/redlib/misc/EventListener.html | 580 +- javadoc/redempt/redlib/misc/FormatUtils.html | 552 +- javadoc/redempt/redlib/misc/Hologram.html | 675 +- .../redempt/redlib/misc/LocationUtils.html | 1100 +- javadoc/redempt/redlib/misc/Path.html | 530 +- .../redempt/redlib/misc/PlayerWrapper.html | 332 +- .../redempt/redlib/misc/Task.TaskType.html | 453 +- javadoc/redempt/redlib/misc/Task.html | 1205 +- javadoc/redempt/redlib/misc/UserCache.html | 395 +- .../redempt/redlib/misc/WeightedRandom.html | 713 +- .../redempt/redlib/misc/package-summary.html | 237 +- javadoc/redempt/redlib/misc/package-tree.html | 161 +- .../multiblock/MultiBlockStructure.html | 2249 ++- .../redempt/redlib/multiblock/Rotator.html | 737 +- .../multiblock/Structure.StructureBlock.html | 446 +- .../redempt/redlib/multiblock/Structure.html | 592 +- .../redlib/multiblock/StructureData.html | 567 +- .../redlib/multiblock/package-summary.html | 175 +- .../redlib/multiblock/package-tree.html | 141 +- javadoc/redempt/redlib/nms/NMSArray.html | 405 +- javadoc/redempt/redlib/nms/NMSClass.html | 492 +- javadoc/redempt/redlib/nms/NMSHelper.html | 523 +- javadoc/redempt/redlib/nms/NMSObject.html | 591 +- .../redempt/redlib/nms/package-summary.html | 169 +- javadoc/redempt/redlib/nms/package-tree.html | 139 +- javadoc/redempt/redlib/package-summary.html | 151 +- javadoc/redempt/redlib/package-tree.html | 133 +- .../redlib/protection/BypassPolicy.html | 258 +- .../redlib/protection/ProtectedRegion.html | 411 +- .../ProtectionPolicy.ProtectionType.html | 935 +- .../redlib/protection/ProtectionPolicy.html | 946 +- .../redlib/protection/package-summary.html | 197 +- .../redlib/protection/package-tree.html | 145 +- .../region/CuboidRegion.RegionState.html | 292 +- .../redempt/redlib/region/CuboidRegion.html | 1245 +- .../redempt/redlib/region/MultiRegion.html | 1129 +- .../redempt/redlib/region/Overlappable.html | 279 +- javadoc/redempt/redlib/region/Region.html | 1179 +- .../region/RegionEnterExitListener.html | 343 +- javadoc/redempt/redlib/region/RegionMap.html | 581 +- .../redempt/redlib/region/RegionUtils.html | 328 +- .../redempt/redlib/region/SelectionTool.html | 455 +- .../redempt/redlib/region/SpheroidRegion.html | 1245 +- .../events/RegionEnterEvent.EnterCause.html | 453 +- .../region/events/RegionEnterEvent.html | 557 +- .../events/RegionExitEvent.ExitCause.html | 453 +- .../redlib/region/events/RegionExitEvent.html | 557 +- .../redlib/region/events/package-summary.html | 183 +- .../redlib/region/events/package-tree.html | 143 +- .../redlib/region/package-summary.html | 219 +- .../redempt/redlib/region/package-tree.html | 153 +- javadoc/redempt/redlib/sql/SQLCache.html | 669 +- .../redempt/redlib/sql/SQLHelper.Results.html | 456 +- javadoc/redempt/redlib/sql/SQLHelper.html | 1062 +- .../redempt/redlib/sql/package-summary.html | 163 +- javadoc/redempt/redlib/sql/package-tree.html | 137 +- .../redempt/redlib/worldgen/CustomBiome.html | 586 +- .../redlib/worldgen/CustomWorldGenerator.html | 476 +- .../redlib/worldgen/NoiseGenerator.html | 632 +- .../redempt/redlib/worldgen/NoiseOctave.html | 580 +- .../redlib/worldgen/package-summary.html | 173 +- .../redempt/redlib/worldgen/package-tree.html | 139 +- .../images/ui-bg_glass_55_fbf9ee_1x400.png | Bin .../images/ui-bg_glass_65_dadada_1x400.png | Bin .../images/ui-bg_glass_75_dadada_1x400.png | Bin .../images/ui-bg_glass_75_e6e6e6_1x400.png | Bin .../images/ui-bg_glass_95_fef1ec_1x400.png | Bin .../ui-bg_highlight-soft_75_cccccc_1x100.png | Bin .../images/ui-icons_222222_256x240.png | Bin .../images/ui-icons_2e83ff_256x240.png | Bin .../images/ui-icons_454545_256x240.png | Bin .../images/ui-icons_888888_256x240.png | Bin .../images/ui-icons_cd0a0a_256x240.png | Bin javadoc/script-dir/jquery-3.5.1.min.js | 2 + .../{jquery => script-dir}/jquery-ui.min.css | 0 .../{jquery => script-dir}/jquery-ui.min.js | 0 .../jquery-ui.structure.min.css | 0 javadoc/script.js | 122 +- javadoc/search.js | 392 +- javadoc/serialized-form.html | 223 +- javadoc/stylesheet.css | 620 +- javadoc/tag-search-index.js | 1 + javadoc/type-search-index.js | 2 +- .../redlib/commandmanager/Command.java | 8 +- .../commandmanager/CommandCollection.java | 2 +- 206 files changed, 31039 insertions(+), 84333 deletions(-) delete mode 100644 javadoc/allclasses.html create mode 100644 javadoc/jquery-ui.overrides.css delete mode 100644 javadoc/jquery/external/jquery/jquery.js delete mode 100644 javadoc/jquery/jquery-3.5.1.js delete mode 100644 javadoc/jquery/jquery-ui.css delete mode 100644 javadoc/jquery/jquery-ui.js delete mode 100644 javadoc/jquery/jquery-ui.structure.css delete mode 100644 javadoc/jquery/jszip-utils/dist/jszip-utils-ie.js delete mode 100644 javadoc/jquery/jszip-utils/dist/jszip-utils-ie.min.js delete mode 100644 javadoc/jquery/jszip-utils/dist/jszip-utils.js delete mode 100644 javadoc/jquery/jszip-utils/dist/jszip-utils.min.js delete mode 100644 javadoc/jquery/jszip/dist/jszip.js delete mode 100644 javadoc/jquery/jszip/dist/jszip.min.js create mode 100644 javadoc/module-search-index.js rename javadoc/{jquery => script-dir}/images/ui-bg_glass_55_fbf9ee_1x400.png (100%) rename javadoc/{jquery => script-dir}/images/ui-bg_glass_65_dadada_1x400.png (100%) rename javadoc/{jquery => script-dir}/images/ui-bg_glass_75_dadada_1x400.png (100%) rename javadoc/{jquery => script-dir}/images/ui-bg_glass_75_e6e6e6_1x400.png (100%) rename javadoc/{jquery => script-dir}/images/ui-bg_glass_95_fef1ec_1x400.png (100%) rename javadoc/{jquery => script-dir}/images/ui-bg_highlight-soft_75_cccccc_1x100.png (100%) rename javadoc/{jquery => script-dir}/images/ui-icons_222222_256x240.png (100%) rename javadoc/{jquery => script-dir}/images/ui-icons_2e83ff_256x240.png (100%) rename javadoc/{jquery => script-dir}/images/ui-icons_454545_256x240.png (100%) rename javadoc/{jquery => script-dir}/images/ui-icons_888888_256x240.png (100%) rename javadoc/{jquery => script-dir}/images/ui-icons_cd0a0a_256x240.png (100%) create mode 100644 javadoc/script-dir/jquery-3.5.1.min.js rename javadoc/{jquery => script-dir}/jquery-ui.min.css (100%) rename javadoc/{jquery => script-dir}/jquery-ui.min.js (100%) rename javadoc/{jquery => script-dir}/jquery-ui.structure.min.css (100%) create mode 100644 javadoc/tag-search-index.js diff --git a/javadoc/allclasses-index.html b/javadoc/allclasses-index.html index c7d3c44..c065402 100644 --- a/javadoc/allclasses-index.html +++ b/javadoc/allclasses-index.html @@ -5,51 +5,34 @@ All Classes (RedLib API) + + - + + - - - - - + + - - -
+
+ +

All Classes

-
- +
+ + +
+
+ diff --git a/javadoc/allclasses.html b/javadoc/allclasses.html deleted file mode 100644 index c3aa3ee..0000000 --- a/javadoc/allclasses.html +++ /dev/null @@ -1,136 +0,0 @@ - - - - - -All Classes (RedLib API) - - - - - - - - - - - -

All Classes

-
- -
- - diff --git a/javadoc/allpackages-index.html b/javadoc/allpackages-index.html index f9f2292..4ced97f 100644 --- a/javadoc/allpackages-index.html +++ b/javadoc/allpackages-index.html @@ -5,45 +5,28 @@ All Packages (RedLib API) + + - + + - - - - - + + - - -
+
+ +

All Packages

-
-
+ + +
+
+
diff --git a/javadoc/constant-values.html b/javadoc/constant-values.html index 3d44a97..0a99612 100644 --- a/javadoc/constant-values.html +++ b/javadoc/constant-values.html @@ -5,45 +5,28 @@ Constant Field Values (RedLib API) + + - + + - - - - - + + - - -
+
+ +

Constant Field Values

-
+

Contents

@@ -101,14 +59,9 @@

Contents

+ + +
+
+
diff --git a/javadoc/deprecated-list.html b/javadoc/deprecated-list.html index 9427cc6..2bd3e64 100644 --- a/javadoc/deprecated-list.html +++ b/javadoc/deprecated-list.html @@ -5,91 +5,49 @@ Deprecated List (RedLib API) + + - + + - - - - - + + - - -
+
+ +

Deprecated API

@@ -101,146 +59,126 @@

Contents

  • Constructors
    • -
    - - -
    - - - -
    - - - -
    - - - - - + + diff --git a/javadoc/help-doc.html b/javadoc/help-doc.html index a6b16b9..2e9d829 100644 --- a/javadoc/help-doc.html +++ b/javadoc/help-doc.html @@ -5,109 +5,62 @@ API Help (RedLib 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.
    +
    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
          • @@ -116,12 +69,10 @@

          Package

        • 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
          • @@ -130,7 +81,7 @@

          Class or Interface

        • Class or Interface Description

        -
          +
          • Nested Class Summary
          • Field Summary
          • Property Summary
            • @@ -138,134 +89,92 @@

            Class or Interface

          • Method Summary

          -
            -
          • Field Detail
            • -
          • Property Detail
            • -
          • Constructor Detail
            • -
          • Method Detail
            • +
              +
            • Field Details
              • +
            • Property Details
              • +
            • Constructor Details
              • +
            • Method Details
            -

            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.

            +

            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
          • +
        • Element Details
      -
      • -
    • -
      +

      Enum

      Each enum has its own separate page with the following sections:

      -
        +
        • Enum Declaration
        • Enum Description
        • Enum Constant Summary
          • -
        • Enum Constant Detail
          • +
        • Enum Constant Details
      -
      • -
    • -
      +

      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.

      +

      The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to shortcomings, 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.

      +

      Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to those who implement rather than use 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".

      -
      -
      • +

      You can search for definitions of modules, packages, types, fields, methods, system properties and other terms defined in the API, using some or all of the name, optionally using "camel-case" abbreviations. For example:

      +
        +
      • j.l.obj will match "java.lang.Object"
        • +
      • InpStr will match "java.io.InputStream"
        • +
      • HM.cK will match "java.util.HashMap.containsKey(Object)"
      +

      Refer to the Javadoc Search Specification for a full description of search features.

      +
      -This help file applies to API documentation generated by the standard doclet.
    -
    +This help file applies to API documentation generated by the standard doclet. +
    +
    diff --git a/javadoc/index-all.html b/javadoc/index-all.html index 74b8a92..bc4644c 100644 --- a/javadoc/index-all.html +++ b/javadoc/index-all.html @@ -5,3310 +5,3218 @@ Index (RedLib API) + + - + + - - - - - + + - - -
    +
    + +
    -
    A B C D E F G H I J K L M N O P Q R S T U V W 
    All Classes All Packages - - -

    A

    -
    -
    add(StackTraceElement[]) - Method in class redempt.redlib.dev.profiler.SampleSummary
    +
    +

    Index

    +
    +A B C D E F G H I J K L M N O P Q R S T U V W 
    All Classes|All Packages +

    A

    +
    +
    add(StackTraceElement[]) - Method in class redempt.redlib.dev.profiler.SampleSummary
     
    -
    add(String, Object) - Method in class redempt.redlib.json.JSONList
    +
    add(String, Object) - Method in class redempt.redlib.json.JSONList
     
    -
    add(String, Object) - Method in class redempt.redlib.json.JSONMap
    +
    add(String, Object) - Method in class redempt.redlib.json.JSONMap
     
    -
    add(Region) - Method in class redempt.redlib.region.MultiRegion
    +
    add(Region) - Method in class redempt.redlib.region.MultiRegion
    Adds a Region to this MultiRegion
    -
    addAttribute(Attribute, double, AttributeModifier.Operation) - Method in class redempt.redlib.itemutils.ItemBuilder
    +
    addAttribute(Attribute, double, AttributeModifier.Operation) - Method in class redempt.redlib.itemutils.ItemBuilder
    Adds an attribute to this ItemBuilder
    -
    addAttribute(Attribute, double, AttributeModifier.Operation, EquipmentSlot) - Method in class redempt.redlib.itemutils.ItemBuilder
    +
    addAttribute(Attribute, double, AttributeModifier.Operation, EquipmentSlot) - Method in class redempt.redlib.itemutils.ItemBuilder
    Adds an attribute to this ItemBuilder
    -
    addAttribute(Attribute, AttributeModifier) - Method in class redempt.redlib.itemutils.ItemBuilder
    +
    addAttribute(Attribute, AttributeModifier) - Method in class redempt.redlib.itemutils.ItemBuilder
    Adds an attribute to this ItemBuilder
    -
    addAttribute(ItemStack, Attribute, double, AttributeModifier.Operation) - Static method in class redempt.redlib.itemutils.ItemUtils
    +
    addAttribute(ItemStack, Attribute, double, AttributeModifier.Operation) - Static method in class redempt.redlib.itemutils.ItemUtils
    Add an attribute to the item
    -
    addAttribute(ItemStack, Attribute, double, AttributeModifier.Operation, EquipmentSlot) - Static method in class redempt.redlib.itemutils.ItemUtils
    +
    addAttribute(ItemStack, Attribute, double, AttributeModifier.Operation, EquipmentSlot) - Static method in class redempt.redlib.itemutils.ItemUtils
    Add an attribute to the item
    -
    addAttribute(ItemStack, Attribute, AttributeModifier) - Static method in class redempt.redlib.itemutils.ItemUtils
    +
    addAttribute(ItemStack, Attribute, AttributeModifier) - Static method in class redempt.redlib.itemutils.ItemUtils
    Add an attribute to the item
    -
    addButton(int, ItemButton) - Method in class redempt.redlib.inventorygui.InventoryGUI
    +
    addButton(int, ItemButton) - Method in class redempt.redlib.inventorygui.InventoryGUI
    Add a button to the GUI in the given slot
    -
    addButton(ItemButton, int) - Method in class redempt.redlib.inventorygui.InventoryGUI
    +
    addButton(ItemButton, int) - Method in class redempt.redlib.inventorygui.InventoryGUI
    Add a button to the GUI in the given slot
    -
    addButton(ItemButton, int, int) - Method in class redempt.redlib.inventorygui.InventoryGUI
    +
    addButton(ItemButton, int, int) - Method in class redempt.redlib.inventorygui.InventoryGUI
    Add a button at the given position in the inventory
    -
    addBypassPolicy(BiPredicate<Player, ProtectionPolicy.ProtectionType>) - Method in class redempt.redlib.protection.ProtectionPolicy
    +
    addBypassPolicy(BiPredicate<Player, ProtectionPolicy.ProtectionType>) - Method in class redempt.redlib.protection.ProtectionPolicy
    Adds a bypass policy, which allows certain players to bypass certain protection types
    -
    addBypassPolicy(BypassPolicy) - Method in class redempt.redlib.protection.ProtectionPolicy
    +
    addBypassPolicy(BypassPolicy) - Method in class redempt.redlib.protection.ProtectionPolicy
    Adds a bypass policy, which allows certain players to bypass certain protection types
    -
    addChild(SampleSummary.SampleMethod) - Method in class redempt.redlib.dev.profiler.SampleSummary.SampleMethod
    +
    addChild(SampleSummary.SampleMethod) - Method in class redempt.redlib.dev.profiler.SampleSummary.SampleMethod
     
    -
    addConverter(Class<T>, Function<String, T>, Function<T, String>) - Method in class redempt.redlib.configmanager.ConfigManager
    +
    addConverter(Class<T>, Function<String, T>, Function<T, String>) - Method in class redempt.redlib.configmanager.ConfigManager
    Adds a type converter, which will attempt to convert a String from config to another type that is not usually able to be stored in config
    -
    addDamage(int) - Method in class redempt.redlib.itemutils.ItemBuilder
    +
    addDamage(int) - Method in class redempt.redlib.itemutils.ItemBuilder
    Adds damage to this ItemBuilder
    -
    addEnchant(Enchantment, int) - Method in class redempt.redlib.itemutils.ItemBuilder
    +
    addEnchant(Enchantment, int) - Method in class redempt.redlib.itemutils.ItemBuilder
    Adds an enchantment to this ItemBuilder
    -
    addEnchant(ItemStack, Enchantment, int) - Static method in class redempt.redlib.itemutils.ItemUtils
    +
    addEnchant(ItemStack, Enchantment, int) - Static method in class redempt.redlib.itemutils.ItemUtils
    Add an enchantment to an ItemStack
    -
    addItemFlags(ItemFlag...) - Method in class redempt.redlib.itemutils.ItemBuilder
    +
    addItemFlags(ItemFlag...) - Method in class redempt.redlib.itemutils.ItemBuilder
    Adds ItemFlags to this ItemBuilder
    -
    addItemFlags(ItemStack, ItemFlag...) - Static method in class redempt.redlib.itemutils.ItemUtils
    +
    addItemFlags(ItemStack, ItemFlag...) - Static method in class redempt.redlib.itemutils.ItemUtils
    Adds ItemFlags to the item
    -
    addListener(Class<T>, Function<T, EventItems>) - Method in class redempt.redlib.enchants.trigger.EnchantTrigger
    +
    addListener(Class<T>, Function<T, EventItems>) - Method in class redempt.redlib.enchants.trigger.EnchantTrigger
    Registers a listener for this EventTrigger to get the items and event for the specified event
    -
    addLore(Iterable<String>) - Method in class redempt.redlib.itemutils.ItemBuilder
    +
    addLore(Iterable<String>) - Method in class redempt.redlib.itemutils.ItemBuilder
    Add multiple lines of lore to this ItemBuilder
    -
    addLore(String) - Method in class redempt.redlib.itemutils.ItemBuilder
    +
    addLore(String) - Method in class redempt.redlib.itemutils.ItemBuilder
    Add a line of lore to this ItemBuilder
    -
    addLore(ItemStack, Iterable<String>) - Static method in class redempt.redlib.itemutils.ItemUtils
    +
    addLore(ItemStack, Iterable<String>) - Static method in class redempt.redlib.itemutils.ItemUtils
    Adds multiple lines of lore to an ItemStack
    -
    addLore(ItemStack, String) - Static method in class redempt.redlib.itemutils.ItemUtils
    +
    addLore(ItemStack, String) - Static method in class redempt.redlib.itemutils.ItemUtils
    Add a line of lore to an ItemStack
    -
    addPersistentTag(ItemStack, NamespacedKey, PersistentDataType<T, Z>, Z) - Static method in class redempt.redlib.itemutils.ItemUtils
    +
    addPersistentTag(ItemStack, NamespacedKey, PersistentDataType<T, Z>, Z) - Static method in class redempt.redlib.itemutils.ItemUtils
    Adds persistent data to the item
    -
    addPersistentTag(NamespacedKey, PersistentDataType<T, Z>, Z) - Method in class redempt.redlib.itemutils.ItemBuilder
    +
    addPersistentTag(NamespacedKey, PersistentDataType<T, Z>, Z) - Method in class redempt.redlib.itemutils.ItemBuilder
    Add persistent tags to this ItemBuilder
    -
    addProtectionTypes(ProtectionPolicy.ProtectionType...) - Method in class redempt.redlib.protection.ProtectionPolicy
    +
    addProtectionTypes(ProtectionPolicy.ProtectionType...) - Method in class redempt.redlib.protection.ProtectionPolicy
    Adds ProtectionTypes to this ProtectionPolicy
    -
    addStrictModeExclusions(Material...) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    +
    addStrictModeExclusions(Material...) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    Add a list of Materials to be excluded from strict data checks rather than disabling strict mode for all blocks
    -
    addTrigger(EnchantTrigger<T>, BiConsumer<T, Integer>) - Method in class redempt.redlib.enchants.CustomEnchant
    +
    addTrigger(EnchantTrigger<T>, BiConsumer<T, Integer>) - Method in class redempt.redlib.enchants.CustomEnchant
    Registers an EnchantTrigger with a listener
    -
    addTrigger(EnchantTrigger<T>, BiConsumer<T, Integer>, BiConsumer<T, Integer>) - Method in class redempt.redlib.enchants.CustomEnchant
    +
    addTrigger(EnchantTrigger<T>, BiConsumer<T, Integer>, BiConsumer<T, Integer>) - Method in class redempt.redlib.enchants.CustomEnchant
    Registers an EnchantTrigger with a listener
    -
    ALL - Static variable in enum redempt.redlib.protection.ProtectionPolicy.ProtectionType
    +
    ALL - Static variable in enum redempt.redlib.protection.ProtectionPolicy.ProtectionType
    Every protection type
    -
    allExcept(ProtectionPolicy.ProtectionType...) - Static method in enum redempt.redlib.protection.ProtectionPolicy.ProtectionType
    +
    allExcept(ProtectionPolicy.ProtectionType...) - Static method in enum redempt.redlib.protection.ProtectionPolicy.ProtectionType
    Gets all protection types except those specified
    -
    allow(Block, ProtectionPolicy.ProtectionType, Player) - Method in class redempt.redlib.protection.ProtectionPolicy
    +
    allow(Block, ProtectionPolicy.ProtectionType, Player) - Method in class redempt.redlib.protection.ProtectionPolicy
     
    -
    AMOUNT - redempt.redlib.itemutils.ItemTrait
    +
    AMOUNT - redempt.redlib.itemutils.ItemTrait
    For comparing the amount of two items
    -
    and(ProtectionPolicy.ProtectionType[]...) - Static method in enum redempt.redlib.protection.ProtectionPolicy.ProtectionType
    +
    and(ProtectionPolicy.ProtectionType[]...) - Static method in enum redempt.redlib.protection.ProtectionPolicy.ProtectionType
    Combines arrays of protection types
    -
    ANVIL_BREAK - redempt.redlib.protection.ProtectionPolicy.ProtectionType
    +
    ANVIL_BREAK - redempt.redlib.protection.ProtectionPolicy.ProtectionType
    Players using an anvil damaging it (1.13+ only)
    -
    append(String) - Method in class redempt.redlib.misc.Hologram
    +
    append(String) - Method in class redempt.redlib.misc.Hologram
    Adds a line at the bottom of this Hologram
    -
    appliesTo(Material) - Method in class redempt.redlib.enchants.CustomEnchant
    +
    appliesTo(Material) - Method in class redempt.redlib.enchants.CustomEnchant
    Checks whether this CustomEnchant applies to a certain item type
    -
    apply(ItemStack, int) - Method in class redempt.redlib.enchants.CustomEnchant
    +
    apply(ItemStack, int) - Method in class redempt.redlib.enchants.CustomEnchant
    Applies this CustomEnchant to an item, replacing it if it was already present.
    -
    applyAll(Map<CustomEnchant, Integer>, ItemStack) - Method in class redempt.redlib.enchants.EnchantRegistry
    +
    applyAll(Map<CustomEnchant, Integer>, ItemStack) - Method in class redempt.redlib.enchants.EnchantRegistry
    Applies all the enchantments in a map of CustomEnchants to their levels to an item
    -
    ArgSubtype<T,​K> - Class in redempt.redlib.commandmanager
    +
    ArgSubtype<T,​K> - Class in redempt.redlib.commandmanager
    An ArgType which is dependent on another type appearing before it and uses it for conversions and tab completion
    -
    ArgSubtype(String, ArgType<?>, ArgType.ArgConverter<T, ?>) - Constructor for class redempt.redlib.commandmanager.ArgSubtype
    +
    ArgSubtype(String, ArgType<?>, ArgType.ArgConverter<T, ?>) - Constructor for class redempt.redlib.commandmanager.ArgSubtype
     
    -
    ArgType<T> - Class in redempt.redlib.commandmanager
    +
    ArgType<T> - Class in redempt.redlib.commandmanager
    A command argument type, which converts a String argument to another type
    -
    ArgType(String, BiFunction<CommandSender, String, T>) - Constructor for class redempt.redlib.commandmanager.ArgType
    +
    ArgType(String, BiFunction<CommandSender, String, T>) - Constructor for class redempt.redlib.commandmanager.ArgType
    Create a ArgType from a name and converter
    -
    ArgType(String, Function<String, T>) - Constructor for class redempt.redlib.commandmanager.ArgType
    +
    ArgType(String, Function<String, T>) - Constructor for class redempt.redlib.commandmanager.ArgType
    Create a ArgType from a name and converter
    -
    ArgType(String, ArgType<?>, ArgType.ArgConverter<T, ?>) - Constructor for class redempt.redlib.commandmanager.ArgType
    +
    ArgType(String, ArgType<?>, ArgType.ArgConverter<T, ?>) - Constructor for class redempt.redlib.commandmanager.ArgType
     
    -
    ArgType.ArgConverter<T,​K> - Interface in redempt.redlib.commandmanager
    +
    ArgType.ArgConverter<T,​K> - Interface in redempt.redlib.commandmanager
     
    -
    ArgType.TabCompleter<T> - Interface in redempt.redlib.commandmanager
    +
    ArgType.TabCompleter<T> - Interface in redempt.redlib.commandmanager
     
    -
    ArgType.TabStreamCompleter<T> - Interface in redempt.redlib.commandmanager
    +
    ArgType.TabStreamCompleter<T> - Interface in redempt.redlib.commandmanager
     
    -
    assertProvider(String, String, Predicate<Player>) - Static method in class redempt.redlib.commandmanager.ContextProvider
    +
    assertProvider(String, String, Predicate<Player>) - Static method in class redempt.redlib.commandmanager.ContextProvider
    Creates a ContextProvider which returns true if the predicate's condition is met, and null otherwise, which will cause the command to fail.
    -
    assertProvider(String, Predicate<Player>) - Static method in class redempt.redlib.commandmanager.ContextProvider
    +
    assertProvider(String, Predicate<Player>) - Static method in class redempt.redlib.commandmanager.ContextProvider
    Creates a ContextProvider which returns true if the predicate's condition is met, and null otherwise, which will cause the command to fail.
    -
    assumeAt(Location) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    +
    assumeAt(Location) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    Gets the Structure at the given block, performing no checks to ensure it exists.
    -
    assumeAt(Location, int) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    +
    assumeAt(Location, int) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    Gets the Structure at the given block, performing no checks to ensure it exists.
    -
    assumeAt(Location, int, boolean) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    +
    assumeAt(Location, int, boolean) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    Gets the Structure at the given block, performing no checks to ensure it exists.
    -
    assumeAt(Location, int, int, int, int, boolean) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    +
    assumeAt(Location, int, int, int, int, boolean) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    Gets the Structure at the given block, performing no checks to ensure it exists.
    -
    ASYNC_DELAYED - redempt.redlib.misc.Task.TaskType
    +
    ASYNC_DELAYED - redempt.redlib.misc.Task.TaskType
     
    -
    ASYNC_REPEATING - redempt.redlib.misc.Task.TaskType
    +
    ASYNC_REPEATING - redempt.redlib.misc.Task.TaskType
     
    -
    asyncDelayed(Runnable) - Static method in class redempt.redlib.misc.Task
    +
    asyncDelayed(Runnable) - Static method in class redempt.redlib.misc.Task
    Schedules an async delayed task to run as soon as possible
    -
    asyncDelayed(Runnable, long) - Static method in class redempt.redlib.misc.Task
    +
    asyncDelayed(Runnable, long) - Static method in class redempt.redlib.misc.Task
    Schedules an async delayed task to run after a delay
    -
    asyncDelayed(Consumer<Task>) - Static method in class redempt.redlib.misc.Task
    +
    asyncDelayed(Consumer<Task>) - Static method in class redempt.redlib.misc.Task
    Schedules an async delayed task to run as soon as possible
    -
    asyncDelayed(Consumer<Task>, long) - Static method in class redempt.redlib.misc.Task
    +
    asyncDelayed(Consumer<Task>, long) - Static method in class redempt.redlib.misc.Task
    Schedules an async delayed task to run after a delay
    -
    asyncDelayed(Plugin, Runnable) - Static method in class redempt.redlib.misc.Task
    +
    asyncDelayed(Plugin, Runnable) - Static method in class redempt.redlib.misc.Task
    Schedules an async delayed task to run as soon as possible
    -
    asyncDelayed(Plugin, Runnable, long) - Static method in class redempt.redlib.misc.Task
    +
    asyncDelayed(Plugin, Runnable, long) - Static method in class redempt.redlib.misc.Task
    Schedules an async delayed task to run after a delay
    -
    asyncDelayed(Plugin, Consumer<Task>) - Static method in class redempt.redlib.misc.Task
    +
    asyncDelayed(Plugin, Consumer<Task>) - Static method in class redempt.redlib.misc.Task
    Schedules an async delayed task to run as soon as possible
    -
    asyncDelayed(Plugin, Consumer<Task>, long) - Static method in class redempt.redlib.misc.Task
    +
    asyncDelayed(Plugin, Consumer<Task>, long) - Static method in class redempt.redlib.misc.Task
    Schedules an async delayed task to run after a delay
    -
    asyncInit() - Static method in class redempt.redlib.misc.UserCache
    +
    asyncInit() - Static method in class redempt.redlib.misc.UserCache
    Initializes the user cache asynchronously
    -
    asyncInit(Runnable) - Static method in class redempt.redlib.misc.UserCache
    +
    asyncInit(Runnable) - Static method in class redempt.redlib.misc.UserCache
    Initializes the user cache asynchronously
    -
    asyncRepeating(Runnable, long, long) - Static method in class redempt.redlib.misc.Task
    +
    asyncRepeating(Runnable, long, long) - Static method in class redempt.redlib.misc.Task
    Schedules an async repeating task to run later
    -
    asyncRepeating(Consumer<Task>, long, long) - Static method in class redempt.redlib.misc.Task
    +
    asyncRepeating(Consumer<Task>, long, long) - Static method in class redempt.redlib.misc.Task
    Schedules an async repeating task to run later
    -
    asyncRepeating(Plugin, Runnable, long, long) - Static method in class redempt.redlib.misc.Task
    +
    asyncRepeating(Plugin, Runnable, long, long) - Static method in class redempt.redlib.misc.Task
    Schedules an async repeating task to run later
    -
    asyncRepeating(Plugin, Consumer<Task>, long, long) - Static method in class redempt.redlib.misc.Task
    +
    asyncRepeating(Plugin, Consumer<Task>, long, long) - Static method in class redempt.redlib.misc.Task
    Schedules an async repeating task to run later
    -
    ATTACK_ENTITY - Static variable in class redempt.redlib.enchants.trigger.EnchantTrigger
    +
    ATTACK_ENTITY - Static variable in class redempt.redlib.enchants.trigger.EnchantTrigger
    Calls activate with an EntityDamageByEntityEvent when a player attacks an entity with an item that has a CustomEnchant with this trigger
    -
    auto(Class<?>, ConfigManager) - Static method in enum redempt.redlib.configmanager.ConversionType
    +
    auto(Class<?>, ConfigManager) - Static method in enum redempt.redlib.configmanager.ConversionType
     
    -
    AUTO - redempt.redlib.configmanager.ConversionType
    +
    AUTO - redempt.redlib.configmanager.ConversionType
    Auto-detect the conversion type based on context
    -
    autoCluster() - Method in class redempt.redlib.region.MultiRegion
    +
    autoCluster() - Method in class redempt.redlib.region.MultiRegion
    automatically clusters regions in clusters of 10 until there are less than 25 top-level regions
    - - - -

    B

    -
    -
    BLOCK_EXPLOSION - redempt.redlib.protection.ProtectionPolicy.ProtectionType
    +

    B

    +
    +
    BLOCK_EXPLOSION - redempt.redlib.protection.ProtectionPolicy.ProtectionType
    Blocks exploding
    -
    BlockDataManager - Class in redempt.redlib.blockdata
    +
    BlockDataManager - Class in redempt.redlib.blockdata
    Manages DataBlock instances, which allow you to attach persistent metadata to blocks, Keeps track of managed blocks, removing data if a block is destroyed or moving it if a block is pushed by a piston.
    -
    BlockDataManager(Path) - Constructor for class redempt.redlib.blockdata.BlockDataManager
    +
    BlockDataManager(Path) - Constructor for class redempt.redlib.blockdata.BlockDataManager
    Create a BlockDataManager instance with a save file location, to be saved to and loaded from.
    -
    BREAK_BLOCK - redempt.redlib.protection.ProtectionPolicy.ProtectionType
    +
    BREAK_BLOCK - redempt.redlib.protection.ProtectionPolicy.ProtectionType
    Players breaking blocks
    -
    build(Player, int, boolean) - Method in class redempt.redlib.dev.StructureTool
    +
    build(Player, int, boolean) - Method in class redempt.redlib.dev.StructureTool
     
    -
    build(Location) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    +
    build(Location) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    Builds this multi-block structure at the given location
    -
    build(Location, int) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    +
    build(Location, int) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    Builds this multi-block structure at the given location
    -
    build(Location, int, int, int) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    +
    build(Location, int, int, int) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    Builds this multi-block structure at the given location
    -
    build(Location, int, int, int, int) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    +
    build(Location, int, int, int, int) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    Builds this multi-block structure at the given location
    -
    build(Location, int, int, int, int, boolean) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    +
    build(Location, int, int, int, int, boolean) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    Builds this multi-block structure at the given location
    -
    buildAsync(Location, int, boolean, int, Consumer<Structure>) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    +
    buildAsync(Location, int, boolean, int, Consumer<Structure>) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    Build this multi-block structure over multiple ticks
    -
    buildAsync(Location, int, int, int, int, boolean, int, Consumer<Structure>) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    +
    buildAsync(Location, int, int, int, int, boolean, int, Consumer<Structure>) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    Build this multi-block structure over multiple ticks
    -
    buildAsync(Location, int, int, Consumer<Structure>) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    +
    buildAsync(Location, int, int, Consumer<Structure>) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    Build this multi-block structure over multiple ticks
    -
    buildAsync(Location, int, Consumer<Structure>) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    +
    buildAsync(Location, int, Consumer<Structure>) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    Build this multi-block structure over multiple ticks
    -
    BurstProfiler - Class in redempt.redlib.dev.profiler
    +
    BurstProfiler - Class in redempt.redlib.dev.profiler
    A profiler best used in bursts.
    -
    BurstProfiler() - Constructor for class redempt.redlib.dev.profiler.BurstProfiler
    +
    BurstProfiler() - Constructor for class redempt.redlib.dev.profiler.BurstProfiler
    Create a new BurstProfiler with a default size of 10,000 (10 seconds)
    -
    BurstProfiler(int) - Constructor for class redempt.redlib.dev.profiler.BurstProfiler
    +
    BurstProfiler(int) - Constructor for class redempt.redlib.dev.profiler.BurstProfiler
    Create a new BurstProfiler with an initial size, being the number of milliseconds it will be able to record
    -
    BypassPolicy - Interface in redempt.redlib.protection
    +
    BypassPolicy - Interface in redempt.redlib.protection
    Represents a policy that allows players to bypass certain protection types for certain blocks
    - - - -

    C

    -
    -
    callMethod(int, String, Object...) - Method in class redempt.redlib.nms.NMSObject
    +

    C

    +
    +
    callMethod(int, String, Object...) - Method in class redempt.redlib.nms.NMSObject
    Calls a method on the wrapped object
    -
    callMethod(String, Object...) - Method in class redempt.redlib.nms.NMSObject
    +
    callMethod(String, Object...) - Method in class redempt.redlib.nms.NMSObject
    Calls a method on the wrapped object
    -
    callStaticMethod(String, Object...) - Method in class redempt.redlib.nms.NMSClass
    +
    callStaticMethod(String, Object...) - Method in class redempt.redlib.nms.NMSClass
    Calls a static method of this class
    -
    canApply(ItemStack) - Method in class redempt.redlib.enchants.CustomEnchant
    +
    canApply(ItemStack) - Method in class redempt.redlib.enchants.CustomEnchant
    Checks if this CustomEnchant can be applied to the given item
    -
    canApply(Material) - Method in class redempt.redlib.enchants.CustomEnchant
    +
    canApply(Material) - Method in class redempt.redlib.enchants.CustomEnchant
    Checks whether this CustomEnchant applies to the given type
    -
    canBuild(Location, int, boolean, Predicate<Location>) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    +
    canBuild(Location, int, boolean, Predicate<Location>) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    Uses a Predicate to test each block where this structure would be built
    -
    canBuild(Location, int, int, int, int, boolean, Predicate<Location>) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    +
    canBuild(Location, int, int, int, int, boolean, Predicate<Location>) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    Uses a Predicate to test each block where this structure would be built
    -
    canBuild(Location, int, Predicate<Location>) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    +
    canBuild(Location, int, Predicate<Location>) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    Uses a Predicate to test each block where this structure would be built
    -
    canBuild(Location, Predicate<Location>) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    +
    canBuild(Location, Predicate<Location>) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    Uses a Predicate to test each block where this structure would be built
    -
    canBypass(Player, ProtectionPolicy.ProtectionType, Block) - Method in interface redempt.redlib.protection.BypassPolicy
    +
    canBypass(Player, ProtectionPolicy.ProtectionType, Block) - Method in interface redempt.redlib.protection.BypassPolicy
    Checks whether a player can bypass the given protection type for the given block
    -
    cancel() - Method in class redempt.redlib.misc.Task
    +
    cancel() - Method in class redempt.redlib.misc.Task
    Cancels this task, same as BukkitScheduler.cancelTask(int)
    -
    cast(Class<T>) - Method in class redempt.redlib.json.JSONList
    +
    cast(Class<T>) - Method in class redempt.redlib.json.JSONList
     
    -
    center(Block) - Static method in class redempt.redlib.misc.LocationUtils
    +
    center(Block) - Static method in class redempt.redlib.misc.LocationUtils
    Returns the Location at the center of a Block - shorthand
    -
    center(Location) - Static method in class redempt.redlib.misc.LocationUtils
    +
    center(Location) - Static method in class redempt.redlib.misc.LocationUtils
    Sets the location's coordinates to the center point of its block coordinates, then returns it
    -
    ChainCommand - Class in redempt.redlib.dev
    +
    ChainCommand - Class in redempt.redlib.dev
     
    -
    ChainCommand() - Constructor for class redempt.redlib.dev.ChainCommand
    +
    ChainCommand() - Constructor for class redempt.redlib.dev.ChainCommand
     
    -
    ChatPrompt - Class in redempt.redlib.misc
    +
    ChatPrompt - Class in redempt.redlib.misc
     
    -
    ChatPrompt.CancelReason - Enum in redempt.redlib.misc
    +
    ChatPrompt.CancelReason - Enum in redempt.redlib.misc
     
    -
    children - Variable in class redempt.redlib.commandmanager.Command
    +
    children - Variable in class redempt.redlib.commandmanager.Command
     
    -
    clear() - Method in class redempt.redlib.blockdata.DataBlock
    +
    clear() - Method in class redempt.redlib.blockdata.DataBlock
    Removes all of the data from this block.
    -
    clear() - Static method in class redempt.redlib.dev.profiler.TickMonitorProfiler
    +
    clear() - Static method in class redempt.redlib.dev.profiler.TickMonitorProfiler
     
    -
    clear() - Method in class redempt.redlib.enchants.EnchantRegistry
    +
    clear() - Method in class redempt.redlib.enchants.EnchantRegistry
    Removes all CustomEnchants from this EnchantRegistry
    -
    clear() - Method in class redempt.redlib.inventorygui.InventoryGUI
    +
    clear() - Method in class redempt.redlib.inventorygui.InventoryGUI
    Clears the inventory and its buttons
    -
    clear() - Method in class redempt.redlib.misc.Hologram
    +
    clear() - Method in class redempt.redlib.misc.Hologram
    Clears this Hologram
    -
    clear() - Method in class redempt.redlib.region.RegionMap
    +
    clear() - Method in class redempt.redlib.region.RegionMap
    Clears all data from this RegionMap
    -
    clear() - Method in class redempt.redlib.sql.SQLCache
    +
    clear() - Method in class redempt.redlib.sql.SQLCache
    Clears the cache.
    -
    clear(CommandSender) - Method in class redempt.redlib.dev.profiler.ProfilerCommands
    +
    clear(CommandSender) - Method in class redempt.redlib.dev.profiler.ProfilerCommands
     
    -
    clearAllCaches() - Method in class redempt.redlib.sql.SQLHelper
    +
    clearAllCaches() - Method in class redempt.redlib.sql.SQLHelper
    Calls SQLCache.clear() on all caches owned by this SQLHelper
    -
    clearBypassPolicies() - Method in class redempt.redlib.protection.ProtectionPolicy
    +
    clearBypassPolicies() - Method in class redempt.redlib.protection.ProtectionPolicy
    Removes all bypass policies
    -
    clearDenyMessages() - Method in class redempt.redlib.protection.ProtectionPolicy
    +
    clearDenyMessages() - Method in class redempt.redlib.protection.ProtectionPolicy
    Clear all deny messages
    -
    click(PlayerInteractEvent) - Method in class redempt.redlib.blockdata.CustomBlock
    +
    click(PlayerInteractEvent) - Method in class redempt.redlib.blockdata.CustomBlock
    Called when this CustomBlock is clicked.
    -
    clone() - Method in class redempt.redlib.dev.profiler.SampleSummary
    +
    clone() - Method in class redempt.redlib.dev.profiler.SampleSummary
     
    -
    clone() - Method in class redempt.redlib.misc.WeightedRandom
    +
    clone() - Method in class redempt.redlib.misc.WeightedRandom
    Creates a copy of this WeightedRandom
    -
    clone() - Method in class redempt.redlib.multiblock.Rotator
    +
    clone() - Method in class redempt.redlib.multiblock.Rotator
    Gets a clone of this Rotator
    -
    clone() - Method in class redempt.redlib.region.CuboidRegion
    +
    clone() - Method in class redempt.redlib.region.CuboidRegion
    Clones this Region
    -
    clone() - Method in class redempt.redlib.region.MultiRegion
    +
    clone() - Method in class redempt.redlib.region.MultiRegion
    Clones this MultiRegion
    -
    clone() - Method in class redempt.redlib.region.Region
    +
    clone() - Method in class redempt.redlib.region.Region
     
    -
    clone() - Method in class redempt.redlib.region.SpheroidRegion
    +
    clone() - Method in class redempt.redlib.region.SpheroidRegion
     
    -
    clone(SampleSummary) - Method in class redempt.redlib.dev.profiler.SampleSummary.SampleMethod
    +
    clone(SampleSummary) - Method in class redempt.redlib.dev.profiler.SampleSummary.SampleMethod
     
    -
    cloneInventory(Inventory) - Static method in class redempt.redlib.itemutils.ItemUtils
    +
    cloneInventory(Inventory) - Static method in class redempt.redlib.itemutils.ItemUtils
    Creates a mock inventory clone of the given inventory.
    -
    cloneOnGet() - Method in class redempt.redlib.itemutils.CustomItem
    +
    cloneOnGet() - Method in class redempt.redlib.itemutils.CustomItem
     
    -
    close() - Method in class redempt.redlib.sql.SQLHelper
    +
    close() - Method in class redempt.redlib.sql.SQLHelper
    Closes the underlying connection this SQLHelper wraps
    -
    close() - Method in class redempt.redlib.sql.SQLHelper.Results
    +
    close() - Method in class redempt.redlib.sql.SQLHelper.Results
    Closes the wrapped ResultSet.
    -
    closeSlot(int) - Method in class redempt.redlib.inventorygui.InventoryGUI
    +
    closeSlot(int) - Method in class redempt.redlib.inventorygui.InventoryGUI
    Closes a slot so that items can't be placed in it
    -
    closeSlots(int, int) - Method in class redempt.redlib.inventorygui.InventoryGUI
    +
    closeSlots(int, int) - Method in class redempt.redlib.inventorygui.InventoryGUI
    Closes slots so that items can't be placed in them
    -
    cluster(int) - Method in class redempt.redlib.region.MultiRegion
    +
    cluster(int) - Method in class redempt.redlib.region.MultiRegion
    Smartly groups Regions in close proximity into clusters.
    -
    collapse(Player) - Method in class redempt.redlib.dev.profiler.ProfilerCommands
    +
    collapse(Player) - Method in class redempt.redlib.dev.profiler.ProfilerCommands
     
    -
    color(String) - Static method in class redempt.redlib.misc.FormatUtils
    +
    color(String) - Static method in class redempt.redlib.misc.FormatUtils
    Shorthand for ChatColor.translateAlternateColorCodes(char, String)
    -
    combine(Map<CustomEnchant, Integer>, Map<CustomEnchant, Integer>) - Method in class redempt.redlib.enchants.EnchantRegistry
    +
    combine(Map<CustomEnchant, Integer>, Map<CustomEnchant, Integer>) - Method in class redempt.redlib.enchants.EnchantRegistry
    Combines two maps of CustomEnchants to their levels, in the same way that normal enchantments would be combined at an anvil
    -
    Command - Class in redempt.redlib.commandmanager
    +
    Command - Class in redempt.redlib.commandmanager
    Represents a command which can be registered
    -
    Command() - Constructor for class redempt.redlib.commandmanager.Command
    +
    Command() - Constructor for class redempt.redlib.commandmanager.Command
     
    -
    Command(String[], CommandArgument[], Flag[], ContextProvider<?>[], ContextProvider<?>[], String, String, Command.SenderType, String, List<Command>, boolean, boolean, boolean, boolean) - Constructor for class redempt.redlib.commandmanager.Command
    +
    Command(String[], CommandArgument[], Flag[], ContextProvider<?>[], ContextProvider<?>[], String, String, Command.SenderType, String, List<Command>, boolean, boolean, boolean, boolean) - Constructor for class redempt.redlib.commandmanager.Command
     
    -
    Command.MethodHook - Class in redempt.redlib.commandmanager
    +
    Command.MethodHook - Class in redempt.redlib.commandmanager
     
    -
    Command.SenderType - Enum in redempt.redlib.commandmanager
    +
    Command.SenderType - Enum in redempt.redlib.commandmanager
     
    -
    commandChain(CommandSender, String) - Method in class redempt.redlib.dev.ChainCommand
    +
    commandChain(CommandSender, String) - Method in class redempt.redlib.dev.ChainCommand
     
    -
    CommandCollection - Class in redempt.redlib.commandmanager
    +
    CommandCollection - Class in redempt.redlib.commandmanager
    Represents a collection of commands which can be mass-registered.
    -
    CommandCollection(List<Command>) - Constructor for class redempt.redlib.commandmanager.CommandCollection
    +
    CommandCollection(List<Command>) - Constructor for class redempt.redlib.commandmanager.CommandCollection
     
    -
    CommandHook - Annotation Type in redempt.redlib.commandmanager
    +
    CommandHook - Annotation Type in redempt.redlib.commandmanager
     
    -
    CommandHookException - Exception in redempt.redlib.commandmanager.exceptions
    +
    CommandHookException - Exception in redempt.redlib.commandmanager.exceptions
    Thrown when a command with a hook name specified does not find a method hook
    -
    CommandHookException(String) - Constructor for exception redempt.redlib.commandmanager.exceptions.CommandHookException
    +
    CommandHookException(String) - Constructor for exception redempt.redlib.commandmanager.exceptions.CommandHookException
     
    -
    CommandParseException - Exception in redempt.redlib.commandmanager.exceptions
    +
    CommandParseException - Exception in redempt.redlib.commandmanager.exceptions
    Thrown when there is a problem found while parsing a command file
    -
    CommandParseException(String) - Constructor for exception redempt.redlib.commandmanager.exceptions.CommandParseException
    +
    CommandParseException(String) - Constructor for exception redempt.redlib.commandmanager.exceptions.CommandParseException
     
    -
    CommandParser - Class in redempt.redlib.commandmanager
    +
    CommandParser - Class in redempt.redlib.commandmanager
    Used to get ContextProviders and CommandArgumentTypes for a command file, then parse it
    -
    CommandParser(InputStream) - Constructor for class redempt.redlib.commandmanager.CommandParser
    +
    CommandParser(InputStream) - Constructor for class redempt.redlib.commandmanager.CommandParser
    Constructs a CommandParser to parse input from the given stream.
    -
    CommandParser(InputStream, Messages) - Constructor for class redempt.redlib.commandmanager.CommandParser
    +
    CommandParser(InputStream, Messages) - Constructor for class redempt.redlib.commandmanager.CommandParser
    Constructs a CommandParser to parse input from the given stream.
    -
    commit() - Method in class redempt.redlib.sql.SQLHelper
    +
    commit() - Method in class redempt.redlib.sql.SQLHelper
    Flushes all caches and commits the transaction
    -
    compare(Block, boolean, boolean) - Method in class redempt.redlib.multiblock.StructureData
    +
    compare(Block, boolean, boolean) - Method in class redempt.redlib.multiblock.StructureData
    Compares this StructureData to a Block
    -
    compare(ItemStack, ItemStack) - Method in enum redempt.redlib.itemutils.ItemTrait
    +
    compare(ItemStack, ItemStack) - Method in enum redempt.redlib.itemutils.ItemTrait
    Compares this trait on the two items
    -
    compare(ItemStack, ItemStack) - Static method in class redempt.redlib.itemutils.ItemUtils
    +
    compare(ItemStack, ItemStack) - Static method in class redempt.redlib.itemutils.ItemUtils
    Compares the type, name, and lore of two items
    -
    compare(ItemStack, ItemStack, ItemTrait...) - Static method in class redempt.redlib.itemutils.ItemUtils
    +
    compare(ItemStack, ItemStack, ItemTrait...) - Static method in class redempt.redlib.itemutils.ItemUtils
    Compares the traits of two items
    -
    compare(StructureData, Block, Rotator) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    +
    compare(StructureData, Block, Rotator) - Method in class redempt.redlib.multiblock.MultiBlockStructure
     
    -
    configExists() - Method in class redempt.redlib.configmanager.ConfigManager
    +
    configExists() - Method in class redempt.redlib.configmanager.ConfigManager
     
    -
    ConfigFieldException - Exception in redempt.redlib.configmanager.exceptions
    +
    ConfigFieldException - Exception in redempt.redlib.configmanager.exceptions
    Thrown when a field with a CommandHook is final
    -
    ConfigFieldException(String) - Constructor for exception redempt.redlib.configmanager.exceptions.ConfigFieldException
    +
    ConfigFieldException(String) - Constructor for exception redempt.redlib.configmanager.exceptions.ConfigFieldException
     
    -
    ConfigListException - Exception in redempt.redlib.configmanager.exceptions
    +
    ConfigListException - Exception in redempt.redlib.configmanager.exceptions
    Thrown when an error occurs with a ConfigList
    -
    ConfigListException(String) - Constructor for exception redempt.redlib.configmanager.exceptions.ConfigListException
    +
    ConfigListException(String) - Constructor for exception redempt.redlib.configmanager.exceptions.ConfigListException
     
    -
    ConfigManager - Class in redempt.redlib.configmanager
    +
    ConfigManager - Class in redempt.redlib.configmanager
    Loads config values into variables annotated with ConfigValue
    -
    ConfigManager(File) - Constructor for class redempt.redlib.configmanager.ConfigManager
    +
    ConfigManager(File) - Constructor for class redempt.redlib.configmanager.ConfigManager
    Initiates a ConfigManager using a specific file for the config
    -
    ConfigManager(Path) - Constructor for class redempt.redlib.configmanager.ConfigManager
    +
    ConfigManager(Path) - Constructor for class redempt.redlib.configmanager.ConfigManager
    Initiates a ConfigManager using a specific path for the config
    -
    ConfigManager(Plugin) - Constructor for class redempt.redlib.configmanager.ConfigManager
    +
    ConfigManager(Plugin) - Constructor for class redempt.redlib.configmanager.ConfigManager
    Instantiates a ConfigManager with the default config name config.yml in the plugin's data folder
    -
    ConfigManager(Plugin, String) - Constructor for class redempt.redlib.configmanager.ConfigManager
    +
    ConfigManager(Plugin, String) - Constructor for class redempt.redlib.configmanager.ConfigManager
    Instantiates a ConfigManager with a specific config name in the plugin's config folder
    -
    ConfigMapException - Exception in redempt.redlib.configmanager.exceptions
    +
    ConfigMapException - Exception in redempt.redlib.configmanager.exceptions
    Thrown when there is an error mapping a ConfigurationSection to an object
    -
    ConfigMapException(String) - Constructor for exception redempt.redlib.configmanager.exceptions.ConfigMapException
    +
    ConfigMapException(String) - Constructor for exception redempt.redlib.configmanager.exceptions.ConfigMapException
     
    -
    ConfigMappable - Annotation Type in redempt.redlib.configmanager.annotations
    +
    ConfigMappable - Annotation Type in redempt.redlib.configmanager.annotations
     
    -
    ConfigPath - Annotation Type in redempt.redlib.configmanager.annotations
    +
    ConfigPath - Annotation Type in redempt.redlib.configmanager.annotations
     
    -
    ConfigPostInit - Annotation Type in redempt.redlib.configmanager.annotations
    +
    ConfigPostInit - Annotation Type in redempt.redlib.configmanager.annotations
     
    -
    ConfigStorage - Interface in redempt.redlib.configmanager
    +
    ConfigStorage - Interface in redempt.redlib.configmanager
     
    -
    ConfigValue - Annotation Type in redempt.redlib.configmanager.annotations
    +
    ConfigValue - Annotation Type in redempt.redlib.configmanager.annotations
     
    -
    CONSOLE - redempt.redlib.commandmanager.Command.SenderType
    +
    CONSOLE - redempt.redlib.commandmanager.Command.SenderType
     
    -
    CONTAINER_ACCESS - redempt.redlib.protection.ProtectionPolicy.ProtectionType
    +
    CONTAINER_ACCESS - redempt.redlib.protection.ProtectionPolicy.ProtectionType
    Players opening containers
    -
    contains(String) - Method in class redempt.redlib.blockdata.DataBlock
    +
    contains(String) - Method in class redempt.redlib.blockdata.DataBlock
    Checks to see if an object is associated with the key provided.
    -
    contains(Block) - Method in class redempt.redlib.region.Region
    +
    contains(Block) - Method in class redempt.redlib.region.Region
    Checks whether a Block is contained by this Region
    -
    contains(Location) - Method in class redempt.redlib.region.CuboidRegion
    +
    contains(Location) - Method in class redempt.redlib.region.CuboidRegion
    Check whether a location is inside this Region
    -
    contains(Location) - Method in class redempt.redlib.region.MultiRegion
    +
    contains(Location) - Method in class redempt.redlib.region.MultiRegion
    Checks whether this MultiRegion contains the given Location
    -
    contains(Location) - Method in class redempt.redlib.region.Region
    +
    contains(Location) - Method in class redempt.redlib.region.Region
    Determines if this Region contains a Location
    -
    contains(Location) - Method in class redempt.redlib.region.SpheroidRegion
    +
    contains(Location) - Method in class redempt.redlib.region.SpheroidRegion
    Checks if this SpheroidRegion contains a given point
    -
    containsTransientProperty(String) - Method in class redempt.redlib.blockdata.DataBlock
    +
    containsTransientProperty(String) - Method in class redempt.redlib.blockdata.DataBlock
    Checks to see if a transient property is associated with the key provided.
    -
    ContextProvider<T> - Class in redempt.redlib.commandmanager
    +
    ContextProvider<T> - Class in redempt.redlib.commandmanager
    Used to provide context arguments to command method hooks
    -
    ContextProvider(String, String, Function<Player, T>) - Constructor for class redempt.redlib.commandmanager.ContextProvider
    +
    ContextProvider(String, String, Function<Player, T>) - Constructor for class redempt.redlib.commandmanager.ContextProvider
    Constructs a ContextProvider.
    -
    ContextProvider(String, Function<Player, T>) - Constructor for class redempt.redlib.commandmanager.ContextProvider
    +
    ContextProvider(String, Function<Player, T>) - Constructor for class redempt.redlib.commandmanager.ContextProvider
    Constructs a ContextProvider.
    -
    ConversionType - Enum in redempt.redlib.configmanager
    +
    ConversionType - Enum in redempt.redlib.configmanager
    Represents ways in which objects can be mapped from config
    -
    convert(CommandSender, Object, String) - Method in class redempt.redlib.commandmanager.ArgType
    +
    convert(CommandSender, Object, String) - Method in class redempt.redlib.commandmanager.ArgType
    Converts an argument to another type
    -
    convert(CommandSender, K, String) - Method in interface redempt.redlib.commandmanager.ArgType.ArgConverter
    +
    convert(CommandSender, K, String) - Method in interface redempt.redlib.commandmanager.ArgType.ArgConverter
     
    -
    converters - Variable in class redempt.redlib.configmanager.ConfigManager
    +
    converters - Variable in class redempt.redlib.configmanager.ConfigManager
     
    -
    count(Inventory, ItemStack) - Static method in class redempt.redlib.itemutils.ItemUtils
    +
    count(Inventory, ItemStack) - Static method in class redempt.redlib.itemutils.ItemUtils
    Counts the number of the given item in the given inventory
    -
    count(Inventory, ItemStack, BiPredicate<ItemStack, ItemStack>) - Static method in class redempt.redlib.itemutils.ItemUtils
    +
    count(Inventory, ItemStack, BiPredicate<ItemStack, ItemStack>) - Static method in class redempt.redlib.itemutils.ItemUtils
    Counts the number of the given item in the given inventory
    -
    count(Inventory, Material) - Static method in class redempt.redlib.itemutils.ItemUtils
    +
    count(Inventory, Material) - Static method in class redempt.redlib.itemutils.ItemUtils
    Counts the number of items of the given type in the given inventory
    -
    countAndRemove(Inventory, ItemStack) - Static method in class redempt.redlib.itemutils.ItemUtils
    +
    countAndRemove(Inventory, ItemStack) - Static method in class redempt.redlib.itemutils.ItemUtils
    Remove all matching items, returning the number that were removed
    -
    countAndRemove(Inventory, ItemStack, int) - Static method in class redempt.redlib.itemutils.ItemUtils
    +
    countAndRemove(Inventory, ItemStack, int) - Static method in class redempt.redlib.itemutils.ItemUtils
    Remove all matching items up to a maximum, returning the number that were removed
    -
    countAndRemove(Inventory, ItemStack, int, BiPredicate<ItemStack, ItemStack>) - Static method in class redempt.redlib.itemutils.ItemUtils
    +
    countAndRemove(Inventory, ItemStack, int, BiPredicate<ItemStack, ItemStack>) - Static method in class redempt.redlib.itemutils.ItemUtils
    Remove all matching items up to a maximum, returning the number that were removed
    -
    countAndRemove(Inventory, Material) - Static method in class redempt.redlib.itemutils.ItemUtils
    +
    countAndRemove(Inventory, Material) - Static method in class redempt.redlib.itemutils.ItemUtils
    Remove all items of a specified type, returning the number that were removed
    -
    countAndRemove(Inventory, Material, int) - Static method in class redempt.redlib.itemutils.ItemUtils
    +
    countAndRemove(Inventory, Material, int) - Static method in class redempt.redlib.itemutils.ItemUtils
    Remove all matching items up to a maximum, returning the number that were removed
    -
    create(InputStream, String) - Static method in class redempt.redlib.multiblock.MultiBlockStructure
    +
    create(InputStream, String) - Static method in class redempt.redlib.multiblock.MultiBlockStructure
    Creates a MultiBlockStructure instance from an input stream containing the info string
    -
    create(InputStream, String, boolean) - Static method in class redempt.redlib.multiblock.MultiBlockStructure
    +
    create(InputStream, String, boolean) - Static method in class redempt.redlib.multiblock.MultiBlockStructure
    Creates a MultiBlockStructure instance from an input stream containing the info string
    -
    create(InputStream, String, boolean, boolean) - Static method in class redempt.redlib.multiblock.MultiBlockStructure
    +
    create(InputStream, String, boolean, boolean) - Static method in class redempt.redlib.multiblock.MultiBlockStructure
    Creates a MultiBlockStructure instance from an input stream containing the info string
    -
    create(String, String) - Static method in class redempt.redlib.multiblock.MultiBlockStructure
    +
    create(String, String) - Static method in class redempt.redlib.multiblock.MultiBlockStructure
    Creates a MultiBlockStructure instance from an info string
    -
    create(String, String, boolean) - Static method in class redempt.redlib.multiblock.MultiBlockStructure
    +
    create(String, String, boolean) - Static method in class redempt.redlib.multiblock.MultiBlockStructure
    Creates a MultiBlockStructure instance from an info string
    -
    create(String, String, boolean, boolean) - Static method in class redempt.redlib.multiblock.MultiBlockStructure
    +
    create(String, String, boolean, boolean) - Static method in class redempt.redlib.multiblock.MultiBlockStructure
    Creates a MultiBlockStructure instance from an info string
    -
    create(ItemStack, Consumer<InventoryClickEvent>) - Static method in class redempt.redlib.inventorygui.ItemButton
    +
    create(ItemStack, Consumer<InventoryClickEvent>) - Static method in class redempt.redlib.inventorygui.ItemButton
    Create an ItemButton from the given ItemStack and listener.
    -
    create(Location, String...) - Static method in class redempt.redlib.misc.Hologram
    +
    create(Location, String...) - Static method in class redempt.redlib.misc.Hologram
    Creates a Hologram
    -
    createArray(int) - Method in class redempt.redlib.nms.NMSClass
    +
    createArray(int) - Method in class redempt.redlib.nms.NMSClass
    Creates an array of this class type
    -
    createCache(String, String, String...) - Method in class redempt.redlib.sql.SQLHelper
    +
    createCache(String, String, String...) - Method in class redempt.redlib.sql.SQLHelper
    Creates and adds cache for a certain column
    -
    createHookMap(Object...) - Method in class redempt.redlib.commandmanager.Command
    +
    createHookMap(Object...) - Method in class redempt.redlib.commandmanager.Command
     
    -
    createStructure(Player, String) - Method in class redempt.redlib.dev.StructureTool
    +
    createStructure(Player, String) - Method in class redempt.redlib.dev.StructureTool
     
    -
    cubeRadius(Location, int) - Static method in class redempt.redlib.region.CuboidRegion
    +
    cubeRadius(Location, int) - Static method in class redempt.redlib.region.CuboidRegion
    Gets a Region covering a cubic radius centered around a Location
    -
    CuboidRegion - Class in redempt.redlib.region
    +
    CuboidRegion - Class in redempt.redlib.region
    Represents a cuboid region in a world
    -
    CuboidRegion() - Constructor for class redempt.redlib.region.CuboidRegion
    +
    CuboidRegion() - Constructor for class redempt.redlib.region.CuboidRegion
     
    -
    CuboidRegion(Location, Location) - Constructor for class redempt.redlib.region.CuboidRegion
    +
    CuboidRegion(Location, Location) - Constructor for class redempt.redlib.region.CuboidRegion
    Construct a Region using 2 corners
    -
    CuboidRegion.RegionState - Class in redempt.redlib.region
    +
    CuboidRegion.RegionState - Class in redempt.redlib.region
    Represents a state of a Region, not necessarily at the current point in time
    -
    CustomBiome - Class in redempt.redlib.worldgen
    +
    CustomBiome - Class in redempt.redlib.worldgen
    -
    Deprecated. -
    Implementation in progress.
    +
    Deprecated. +
    Implementation in progress.
    -
    CustomBiome(String, int, int, int, Biome) - Constructor for class redempt.redlib.worldgen.CustomBiome
    +
    CustomBiome(String, int, int, int, Biome) - Constructor for class redempt.redlib.worldgen.CustomBiome
    -
    Deprecated.
    +
    Deprecated.
     
    -
    CustomBlock - Class in redempt.redlib.blockdata
    +
    CustomBlock - Class in redempt.redlib.blockdata
    Represents an instance of a CustomBlockType.
    -
    CustomBlock(CustomBlockType<?>, DataBlock) - Constructor for class redempt.redlib.blockdata.CustomBlock
    +
    CustomBlock(CustomBlockType<?>, DataBlock) - Constructor for class redempt.redlib.blockdata.CustomBlock
     
    -
    CustomBlockPlaceEvent - Class in redempt.redlib.blockdata.events
    +
    CustomBlockPlaceEvent - Class in redempt.redlib.blockdata.events
    Called when a CustomBlock is placed by a Player
    -
    CustomBlockPlaceEvent(Block, ItemStack, CustomBlockType<?>, Player) - Constructor for class redempt.redlib.blockdata.events.CustomBlockPlaceEvent
    +
    CustomBlockPlaceEvent(Block, ItemStack, CustomBlockType<?>, Player) - Constructor for class redempt.redlib.blockdata.events.CustomBlockPlaceEvent
    Constructs a new CustomBlockPlaceEvent
    -
    CustomBlockRegistry - Class in redempt.redlib.blockdata
    +
    CustomBlockRegistry - Class in redempt.redlib.blockdata
    Loads and registers CustomBlockTypes
    -
    CustomBlockRegistry(BlockDataManager) - Constructor for class redempt.redlib.blockdata.CustomBlockRegistry
    +
    CustomBlockRegistry(BlockDataManager) - Constructor for class redempt.redlib.blockdata.CustomBlockRegistry
    Construct a CustomBlockRegistry without passing a plugin.
    -
    CustomBlockRegistry(BlockDataManager, Plugin) - Constructor for class redempt.redlib.blockdata.CustomBlockRegistry
    +
    CustomBlockRegistry(BlockDataManager, Plugin) - Constructor for class redempt.redlib.blockdata.CustomBlockRegistry
    Construct a CustomBlockRegistry, passing a plugin.
    -
    CustomBlockType<T extends CustomBlock> - Class in redempt.redlib.blockdata
    +
    CustomBlockType<T extends CustomBlock> - Class in redempt.redlib.blockdata
    Represents a type of a CustomBlock that can be set
    -
    CustomBlockType(String) - Constructor for class redempt.redlib.blockdata.CustomBlockType
    +
    CustomBlockType(String) - Constructor for class redempt.redlib.blockdata.CustomBlockType
    Construct a CustomBlockType with the type name.
    -
    CustomEnchant - Class in redempt.redlib.enchants
    +
    CustomEnchant - Class in redempt.redlib.enchants
    Represents a custom enchantment created by another plugin
    -
    CustomEnchant(String, int) - Constructor for class redempt.redlib.enchants.CustomEnchant
    +
    CustomEnchant(String, int) - Constructor for class redempt.redlib.enchants.CustomEnchant
    Constructs a new CustomEnchant
    -
    CustomItem - Class in redempt.redlib.itemutils
    +
    CustomItem - Class in redempt.redlib.itemutils
    Represents a custom item with special behavior
    -
    CustomItem(String) - Constructor for class redempt.redlib.itemutils.CustomItem
    +
    CustomItem(String) - Constructor for class redempt.redlib.itemutils.CustomItem
    A constructor that should only be called by CustomItem.getAll(Plugin)
    -
    CustomWorldGenerator - Class in redempt.redlib.worldgen
    +
    CustomWorldGenerator - Class in redempt.redlib.worldgen
    -
    Deprecated. -
    Implementation in progress.
    +
    Deprecated. +
    Implementation in progress.
    -
    CustomWorldGenerator(long, CustomBiome...) - Constructor for class redempt.redlib.worldgen.CustomWorldGenerator
    +
    CustomWorldGenerator(long, CustomBiome...) - Constructor for class redempt.redlib.worldgen.CustomWorldGenerator
    -
    Deprecated.
    +
    Deprecated.
     
    - - - -

    D

    -
    -
    damage(ItemStack, int) - Static method in class redempt.redlib.itemutils.ItemUtils
    +

    D

    +
    +
    damage(ItemStack, int) - Static method in class redempt.redlib.itemutils.ItemUtils
    Damages an item
    -
    data - Variable in class redempt.redlib.blockdata.DataBlock
    +
    data - Variable in class redempt.redlib.blockdata.DataBlock
     
    -
    data - Variable in class redempt.redlib.multiblock.MultiBlockStructure
    +
    data - Variable in class redempt.redlib.multiblock.MultiBlockStructure
     
    -
    DataBlock - Class in redempt.redlib.blockdata
    +
    DataBlock - Class in redempt.redlib.blockdata
    Represents a Block with various data attached to it
    -
    DataBlock(Block, BlockDataManager) - Constructor for class redempt.redlib.blockdata.DataBlock
    +
    DataBlock(Block, BlockDataManager) - Constructor for class redempt.redlib.blockdata.DataBlock
     
    -
    DataBlockDestroyEvent - Class in redempt.redlib.blockdata.events
    +
    DataBlockDestroyEvent - Class in redempt.redlib.blockdata.events
    Called when a DataBlock is destroyed by something other than a player
    -
    DataBlockDestroyEvent(DataBlock, Player, DataBlockDestroyEvent.DestroyCause, Event) - Constructor for class redempt.redlib.blockdata.events.DataBlockDestroyEvent
    +
    DataBlockDestroyEvent(DataBlock, Player, DataBlockDestroyEvent.DestroyCause, Event) - Constructor for class redempt.redlib.blockdata.events.DataBlockDestroyEvent
    Construct a DataBlockDestroyEvent
    -
    DataBlockDestroyEvent.DestroyCause - Enum in redempt.redlib.blockdata.events
    +
    DataBlockDestroyEvent.DestroyCause - Enum in redempt.redlib.blockdata.events
     
    -
    DataBlockMoveEvent - Class in redempt.redlib.blockdata.events
    +
    DataBlockMoveEvent - Class in redempt.redlib.blockdata.events
    Called when a DataBlock is moved
    -
    DataBlockMoveEvent(DataBlock, Location) - Constructor for class redempt.redlib.blockdata.events.DataBlockMoveEvent
    +
    DataBlockMoveEvent(DataBlock, Location) - Constructor for class redempt.redlib.blockdata.events.DataBlockMoveEvent
    Construct a DataBlockMoveEvent
    -
    DEATH - redempt.redlib.region.events.RegionExitEvent.ExitCause
    +
    DEATH - redempt.redlib.region.events.RegionExitEvent.ExitCause
    When a player dies in a region
    -
    decluster() - Method in class redempt.redlib.region.MultiRegion
    +
    decluster() - Method in class redempt.redlib.region.MultiRegion
    Flattens any clusters in this MultiRegion so that it is composed only of cuboid Regions
    -
    defaultAppliesTo(Material) - Method in class redempt.redlib.enchants.trigger.EnchantTrigger
    +
    defaultAppliesTo(Material) - Method in class redempt.redlib.enchants.trigger.EnchantTrigger
    Returns whether this EnchantTrigger applies to the given type by default
    -
    defaultAppliesTo(Material) - Method in class redempt.redlib.enchants.trigger.KillEntityTrigger
    +
    defaultAppliesTo(Material) - Method in class redempt.redlib.enchants.trigger.KillEntityTrigger
     
    -
    delayedTeleport(Player, Location, int) - Static method in class redempt.redlib.misc.LocationUtils
    +
    delayedTeleport(Player, Location, int) - Static method in class redempt.redlib.misc.LocationUtils
    Initiates a delayed teleport for a player which will be cancelled if the player moves.
    -
    delayedTeleport(Player, Location, int, Consumer<Boolean>) - Static method in class redempt.redlib.misc.LocationUtils
    +
    delayedTeleport(Player, Location, int, Consumer<Boolean>) - Static method in class redempt.redlib.misc.LocationUtils
    Initiates a delayed teleport for a player which will be cancelled if the player moves.
    -
    delete(Object...) - Method in class redempt.redlib.sql.SQLCache
    +
    delete(Object...) - Method in class redempt.redlib.sql.SQLCache
    Deletes a row from the table by its primary keys, and removes it from the cache.
    -
    destroy() - Method in class redempt.redlib.inventorygui.InventoryGUI
    +
    destroy() - Method in class redempt.redlib.inventorygui.InventoryGUI
    Remove this inventory as a listener and clean everything up to prevent memory leaks.
    -
    destroy(Player) - Method in class redempt.redlib.inventorygui.InventoryGUI
    +
    destroy(Player) - Method in class redempt.redlib.inventorygui.InventoryGUI
    Remove this inventory as a listener and clean everything up to prevent memory leaks.
    -
    destroysOnClose() - Method in class redempt.redlib.inventorygui.InventoryGUI
    +
    destroysOnClose() - Method in class redempt.redlib.inventorygui.InventoryGUI
    Returns whether this GUI is destroyed when it has been closed by all viewers
    -
    devMode - Static variable in class redempt.redlib.RedLib
    +
    devMode - Static variable in class redempt.redlib.RedLib
     
    -
    dimX - Variable in class redempt.redlib.multiblock.MultiBlockStructure
    +
    dimX - Variable in class redempt.redlib.multiblock.MultiBlockStructure
     
    -
    dimY - Variable in class redempt.redlib.multiblock.MultiBlockStructure
    +
    dimY - Variable in class redempt.redlib.multiblock.MultiBlockStructure
     
    -
    dimZ - Variable in class redempt.redlib.multiblock.MultiBlockStructure
    +
    dimZ - Variable in class redempt.redlib.multiblock.MultiBlockStructure
     
    -
    DIRECT_PLAYERS - Static variable in enum redempt.redlib.protection.ProtectionPolicy.ProtectionType
    +
    DIRECT_PLAYERS - Static variable in enum redempt.redlib.protection.ProtectionPolicy.ProtectionType
    All protection types relating to actions taken directly by players - Breaking, placing, and interacting with blocks
    -
    directPathfind(Block, Block, int) - Static method in class redempt.redlib.misc.LocationUtils
    +
    directPathfind(Block, Block, int) - Static method in class redempt.redlib.misc.LocationUtils
    Finds the fastest path between a starting and ending location using A*, then removes unneeded steps for straight
    -
    directPathfind(Block, Block, int, Predicate<Block>) - Static method in class redempt.redlib.misc.LocationUtils
    +
    directPathfind(Block, Block, int, Predicate<Block>) - Static method in class redempt.redlib.misc.LocationUtils
    Finds the fastest path between a starting and ending location using A*, then removes unneeded steps for straight
    -
    disable() - Method in class redempt.redlib.protection.ProtectionPolicy
    +
    disable() - Method in class redempt.redlib.protection.ProtectionPolicy
    Disables all protections for this ProtectionPolicy
    -
    disableEvents() - Method in class redempt.redlib.region.Region
    +
    disableEvents() - Method in class redempt.redlib.region.Region
    Disable RegionEnterEvent and RegionExitEvent for this region
    -
    DURABILITY - redempt.redlib.itemutils.ItemTrait
    +
    DURABILITY - redempt.redlib.itemutils.ItemTrait
    For comparing the durability of two items
    - - - -

    E

    -
    -
    enable() - Static method in class redempt.redlib.dev.StructureTool
    +

    E

    +
    +
    enable() - Static method in class redempt.redlib.dev.StructureTool
     
    -
    enable() - Method in class redempt.redlib.protection.ProtectionPolicy
    +
    enable() - Method in class redempt.redlib.protection.ProtectionPolicy
    Enables all protections specified for this ProtectionPolicy
    -
    enableEvents() - Method in class redempt.redlib.region.Region
    +
    enableEvents() - Method in class redempt.redlib.region.Region
    Enable RegionEnterEvent and RegionExitEvent for this region
    -
    EnchantInfo - Class in redempt.redlib.enchants
    +
    EnchantInfo - Class in redempt.redlib.enchants
    Represents a CustomEnchant and level
    -
    EnchantInfo(CustomEnchant, int) - Constructor for class redempt.redlib.enchants.EnchantInfo
    +
    EnchantInfo(CustomEnchant, int) - Constructor for class redempt.redlib.enchants.EnchantInfo
    Constructs an EnchantInfo from a CustomEnchant and level
    -
    ENCHANTMENTS - redempt.redlib.itemutils.ItemTrait
    +
    ENCHANTMENTS - redempt.redlib.itemutils.ItemTrait
    For comparing the enchantments of two items
    -
    EnchantRegistry - Class in redempt.redlib.enchants
    +
    EnchantRegistry - Class in redempt.redlib.enchants
    A registry for custom enchantments owned by a single plugin
    -
    EnchantRegistry(Plugin) - Constructor for class redempt.redlib.enchants.EnchantRegistry
    +
    EnchantRegistry(Plugin) - Constructor for class redempt.redlib.enchants.EnchantRegistry
    Instantiates a new EnchantRegistry with a namer that prepends the gray chat color
    -
    EnchantRegistry(Plugin, String) - Constructor for class redempt.redlib.enchants.EnchantRegistry
    +
    EnchantRegistry(Plugin, String) - Constructor for class redempt.redlib.enchants.EnchantRegistry
    Instantiates a new EnchantRegistry
    -
    EnchantRegistry(Plugin, Function<CustomEnchant, String>) - Constructor for class redempt.redlib.enchants.EnchantRegistry
    +
    EnchantRegistry(Plugin, Function<CustomEnchant, String>) - Constructor for class redempt.redlib.enchants.EnchantRegistry
    Instantiates a new EnchantRegistry
    -
    EnchantTrigger<T extends org.bukkit.event.Event> - Class in redempt.redlib.enchants.trigger
    +
    EnchantTrigger<T extends org.bukkit.event.Event> - Class in redempt.redlib.enchants.trigger
    Represents a trigger for a CustomEnchant which will smartly pass relevant events
    -
    EnchantTrigger() - Constructor for class redempt.redlib.enchants.trigger.EnchantTrigger
    +
    EnchantTrigger() - Constructor for class redempt.redlib.enchants.trigger.EnchantTrigger
     
    -
    end - Variable in class redempt.redlib.region.CuboidRegion
    +
    end - Variable in class redempt.redlib.region.CuboidRegion
     
    -
    end() - Method in class redempt.redlib.dev.profiler.BurstProfiler
    +
    end() - Method in class redempt.redlib.dev.profiler.BurstProfiler
     
    -
    end() - Method in class redempt.redlib.dev.profiler.PassiveProfiler
    +
    end() - Method in class redempt.redlib.dev.profiler.PassiveProfiler
     
    -
    end() - Method in class redempt.redlib.dev.profiler.Profiler
    +
    end() - Method in class redempt.redlib.dev.profiler.Profiler
     
    -
    ensureExists(World, BlockDataManager.ChunkPosition) - Method in class redempt.redlib.blockdata.BlockDataManager
    +
    ensureExists(World, BlockDataManager.ChunkPosition) - Method in class redempt.redlib.blockdata.BlockDataManager
     
    -
    ENTITY_EXPLOSION - redempt.redlib.protection.ProtectionPolicy.ProtectionType
    +
    ENTITY_EXPLOSION - redempt.redlib.protection.ProtectionPolicy.ProtectionType
    Entities exploding
    -
    EntityPersistor<T extends org.bukkit.entity.Entity> - Class in redempt.redlib.misc
    +
    EntityPersistor<T extends org.bukkit.entity.Entity> - Class in redempt.redlib.misc
    An Entity in Spigot may not persist if the entity it refers to is unloaded, then loaded again at a later time.
    -
    equals(Object) - Method in class redempt.redlib.blockdata.DataBlock
    +
    equals(Object) - Method in class redempt.redlib.blockdata.DataBlock
     
    -
    equals(Object) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    +
    equals(Object) - Method in class redempt.redlib.multiblock.MultiBlockStructure
     
    -
    EQUIP_ARMOR - Static variable in class redempt.redlib.enchants.trigger.EnchantTrigger
    +
    EQUIP_ARMOR - Static variable in class redempt.redlib.enchants.trigger.EnchantTrigger
    Calls activate with a PlayerChangedArmorEvent when a player equips armor that has a CustomEnchant with this trigger Also calls activate when a player joins wearing armor with this trigger Calls deactivate with a PlayerChangedArmorEvent when a player unequips armor that has a CustomEnchant with this trigger Also calls deactivate when a player leaves wearing armor with this trigger
    -
    EventItems - Class in redempt.redlib.enchants
    +
    EventItems - Class in redempt.redlib.enchants
    Represents the items related to an event, for handling by enchantments
    -
    EventItems(Event, ItemStack) - Constructor for class redempt.redlib.enchants.EventItems
    +
    EventItems(Event, ItemStack) - Constructor for class redempt.redlib.enchants.EventItems
     
    -
    EventItems(Event, ItemStack[]) - Constructor for class redempt.redlib.enchants.EventItems
    +
    EventItems(Event, ItemStack[]) - Constructor for class redempt.redlib.enchants.EventItems
     
    -
    EventItems(Event, ItemStack[], ItemStack[]) - Constructor for class redempt.redlib.enchants.EventItems
    +
    EventItems(Event, ItemStack[], ItemStack[]) - Constructor for class redempt.redlib.enchants.EventItems
     
    -
    EventItems(Event, ItemStack, ItemStack) - Constructor for class redempt.redlib.enchants.EventItems
    +
    EventItems(Event, ItemStack, ItemStack) - Constructor for class redempt.redlib.enchants.EventItems
     
    -
    EventListener<T extends org.bukkit.event.Event> - Class in redempt.redlib.misc
    +
    EventListener<T extends org.bukkit.event.Event> - Class in redempt.redlib.misc
    A compact way to define a Listener using a lambda
    -
    EventListener(Class<T>, BiConsumer<EventListener<T>, T>) - Constructor for class redempt.redlib.misc.EventListener
    +
    EventListener(Class<T>, BiConsumer<EventListener<T>, T>) - Constructor for class redempt.redlib.misc.EventListener
    Creates and registers a Listener for the given event
    -
    EventListener(Class<T>, Consumer<T>) - Constructor for class redempt.redlib.misc.EventListener
    +
    EventListener(Class<T>, Consumer<T>) - Constructor for class redempt.redlib.misc.EventListener
    Creates and registers a Listener for the given event
    -
    EventListener(Class<T>, EventPriority, BiConsumer<EventListener<T>, T>) - Constructor for class redempt.redlib.misc.EventListener
    +
    EventListener(Class<T>, EventPriority, BiConsumer<EventListener<T>, T>) - Constructor for class redempt.redlib.misc.EventListener
    Creates and registers a Listener for the given event
    -
    EventListener(Class<T>, EventPriority, Consumer<T>) - Constructor for class redempt.redlib.misc.EventListener
    +
    EventListener(Class<T>, EventPriority, Consumer<T>) - Constructor for class redempt.redlib.misc.EventListener
    Creates and registers a Listener for the given event
    -
    EventListener(Plugin, Class<T>, BiConsumer<EventListener<T>, T>) - Constructor for class redempt.redlib.misc.EventListener
    +
    EventListener(Plugin, Class<T>, BiConsumer<EventListener<T>, T>) - Constructor for class redempt.redlib.misc.EventListener
    Creates and registers a Listener for the given event
    -
    EventListener(Plugin, Class<T>, Consumer<T>) - Constructor for class redempt.redlib.misc.EventListener
    +
    EventListener(Plugin, Class<T>, Consumer<T>) - Constructor for class redempt.redlib.misc.EventListener
    Creates and registers a Listener for the given event
    -
    EventListener(Plugin, Class<T>, EventPriority, BiConsumer<EventListener<T>, T>) - Constructor for class redempt.redlib.misc.EventListener
    +
    EventListener(Plugin, Class<T>, EventPriority, BiConsumer<EventListener<T>, T>) - Constructor for class redempt.redlib.misc.EventListener
    Creates and registers a Listener for the given event
    -
    EventListener(Plugin, Class<T>, EventPriority, Consumer<T>) - Constructor for class redempt.redlib.misc.EventListener
    +
    EventListener(Plugin, Class<T>, EventPriority, Consumer<T>) - Constructor for class redempt.redlib.misc.EventListener
    Creates and registers a Listener for the given event
    -
    events - Variable in class redempt.redlib.enchants.trigger.EnchantTrigger
    +
    events - Variable in class redempt.redlib.enchants.trigger.EnchantTrigger
     
    -
    EVERYONE - redempt.redlib.commandmanager.Command.SenderType
    +
    EVERYONE - redempt.redlib.commandmanager.Command.SenderType
     
    -
    execute(String, Object...) - Method in class redempt.redlib.sql.SQLHelper
    +
    execute(String, Object...) - Method in class redempt.redlib.sql.SQLHelper
    Executes a SQL query as a prepared statement, setting its fields to the elements of the vararg passed
    -
    execute(CommandSender, String[], Object[]) - Method in class redempt.redlib.commandmanager.Command
    +
    execute(CommandSender, String[], Object[]) - Method in class redempt.redlib.commandmanager.Command
     
    -
    exists - Variable in class redempt.redlib.blockdata.DataBlock
    +
    exists - Variable in class redempt.redlib.blockdata.DataBlock
     
    -
    expand(double) - Method in class redempt.redlib.region.CuboidRegion
    +
    expand(double) - Method in class redempt.redlib.region.CuboidRegion
    Expands the region in all directions, or retracts if negative.
    -
    expand(double) - Method in class redempt.redlib.region.SpheroidRegion
    +
    expand(double) - Method in class redempt.redlib.region.SpheroidRegion
    Expands this SpheroidRegion in all directions
    -
    expand(double, double, double, double, double, double) - Method in class redempt.redlib.region.CuboidRegion
    +
    expand(double, double, double, double, double, double) - Method in class redempt.redlib.region.CuboidRegion
    Expands the region, or retracts where negative values are passed
    -
    expand(double, double, double, double, double, double) - Method in class redempt.redlib.region.MultiRegion
    +
    expand(double, double, double, double, double, double) - Method in class redempt.redlib.region.MultiRegion
    Expands the region, or retracts if negative.
    -
    expand(double, double, double, double, double, double) - Method in class redempt.redlib.region.Region
    +
    expand(double, double, double, double, double, double) - Method in class redempt.redlib.region.Region
    Expands this Region by a specified amount in each direction
    -
    expand(double, double, double, double, double, double) - Method in class redempt.redlib.region.SpheroidRegion
    +
    expand(double, double, double, double, double, double) - Method in class redempt.redlib.region.SpheroidRegion
    Expands this SpheroidRegion in all directions
    -
    expand(BlockFace, double) - Method in class redempt.redlib.region.CuboidRegion
    +
    expand(BlockFace, double) - Method in class redempt.redlib.region.CuboidRegion
    Expand the region in a given direction, or retracts if negative.
    -
    expand(BlockFace, double) - Method in class redempt.redlib.region.MultiRegion
    +
    expand(BlockFace, double) - Method in class redempt.redlib.region.MultiRegion
    Expands the MultiRegion in a given direction, or retracts if negative.
    -
    expand(BlockFace, double) - Method in class redempt.redlib.region.Region
    +
    expand(BlockFace, double) - Method in class redempt.redlib.region.Region
    Expands this Region in a specific direction
    -
    expand(BlockFace, double) - Method in class redempt.redlib.region.SpheroidRegion
    +
    expand(BlockFace, double) - Method in class redempt.redlib.region.SpheroidRegion
    Expands this SpheroidRegion in a specific direction
    -
    EXPLOSION - redempt.redlib.blockdata.events.DataBlockDestroyEvent.DestroyCause
    +
    EXPLOSION - redempt.redlib.blockdata.events.DataBlockDestroyEvent.DestroyCause
     
    -
    export(Player, String) - Method in class redempt.redlib.dev.StructureTool
    +
    export(Player, String) - Method in class redempt.redlib.dev.StructureTool
     
    - - - -

    F

    -
    -
    FADE - redempt.redlib.protection.ProtectionPolicy.ProtectionType
    +

    F

    +
    +
    FADE - redempt.redlib.protection.ProtectionPolicy.ProtectionType
    Blocks fading
    -
    FALLING_BLOCK - redempt.redlib.protection.ProtectionPolicy.ProtectionType
    +
    FALLING_BLOCK - redempt.redlib.protection.ProtectionPolicy.ProtectionType
    FallingBlock entities turning into solid blocks (sand, gravel)
    -
    fill(int, int, int, int, ItemStack) - Method in class redempt.redlib.inventorygui.InventoryGUI
    +
    fill(int, int, int, int, ItemStack) - Method in class redempt.redlib.inventorygui.InventoryGUI
    Fill a section of the inventory with the given item
    -
    fill(int, int, ItemStack) - Method in class redempt.redlib.inventorygui.InventoryGUI
    +
    fill(int, int, ItemStack) - Method in class redempt.redlib.inventorygui.InventoryGUI
    Fill a section of the inventory with the given item
    -
    FILLER - Static variable in class redempt.redlib.inventorygui.InventoryGUI
    +
    FILLER - Static variable in class redempt.redlib.inventorygui.InventoryGUI
    A gray stained glass pane with no name.
    -
    findInside(CuboidRegion) - Static method in class redempt.redlib.region.RegionUtils
    +
    findInside(CuboidRegion) - Static method in class redempt.redlib.region.RegionUtils
    Finds the spaces within a Region that can be considered "inside" - space that is surrounded by other blocks
    -
    FIRE - redempt.redlib.blockdata.events.DataBlockDestroyEvent.DestroyCause
    +
    FIRE - redempt.redlib.blockdata.events.DataBlockDestroyEvent.DestroyCause
     
    -
    FIRE - redempt.redlib.protection.ProtectionPolicy.ProtectionType
    +
    FIRE - redempt.redlib.protection.ProtectionPolicy.ProtectionType
    Fire destroying blocks
    -
    fixStands() - Method in class redempt.redlib.misc.Hologram
    +
    fixStands() - Method in class redempt.redlib.misc.Hologram
    Removes and re-adds all armor stands in this Hologram
    -
    FLOW - redempt.redlib.protection.ProtectionPolicy.ProtectionType
    +
    FLOW - redempt.redlib.protection.ProtectionPolicy.ProtectionType
    Lava and water flowing
    -
    flush() - Method in class redempt.redlib.sql.SQLCache
    +
    flush() - Method in class redempt.redlib.sql.SQLCache
    Flushes the cache, saving all changes that were made.
    -
    flush(Object...) - Method in class redempt.redlib.sql.SQLCache
    +
    flush(Object...) - Method in class redempt.redlib.sql.SQLCache
    Flushes a single value from the cache, saving changes that were made to it
    -
    flushAllCaches() - Method in class redempt.redlib.sql.SQLHelper
    +
    flushAllCaches() - Method in class redempt.redlib.sql.SQLHelper
    Calls SQLCache.flush() on all caches owned by this SQLHelper
    -
    flushAndRemoveFromMatchingCaches(String, Object...) - Method in class redempt.redlib.sql.SQLHelper
    +
    flushAndRemoveFromMatchingCaches(String, Object...) - Method in class redempt.redlib.sql.SQLHelper
    Finds matching caches by a pattern and flushes, then removes a specific entry from them.
    -
    flushMatchingCaches(String, Object...) - Method in class redempt.redlib.sql.SQLHelper
    +
    flushMatchingCaches(String, Object...) - Method in class redempt.redlib.sql.SQLHelper
    Finds matching caches by a pattern and flushes a specific entry from them.
    -
    forEach(Consumer<SQLHelper.Results>) - Method in class redempt.redlib.sql.SQLHelper.Results
    +
    forEach(Consumer<SQLHelper.Results>) - Method in class redempt.redlib.sql.SQLHelper.Results
    Performs an operation on every row in these Results, passing itself each time it iterates to a new row
    -
    forEachBlock(Consumer<Block>) - Method in class redempt.redlib.region.CuboidRegion
    +
    forEachBlock(Consumer<Block>) - Method in class redempt.redlib.region.CuboidRegion
    Run a lambda on every Block in this Region
    -
    forEachBlock(Consumer<Block>) - Method in class redempt.redlib.region.Region
    +
    forEachBlock(Consumer<Block>) - Method in class redempt.redlib.region.Region
    Streams every Block in this Region, running your lambda on it
    -
    forEachBlock(Location, int, boolean, Consumer<BlockState>) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    +
    forEachBlock(Location, int, boolean, Consumer<BlockState>) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    Iterates each block which would be set if this structure is built
    -
    forEachBlock(Location, int, int, int, int, boolean, Consumer<BlockState>) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    +
    forEachBlock(Location, int, int, int, int, boolean, Consumer<BlockState>) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    Iterates each block which would be set if this structure is built
    -
    forEachBlock(Location, int, Consumer<BlockState>) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    +
    forEachBlock(Location, int, Consumer<BlockState>) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    Iterates each block which would be set if this structure is built
    -
    forEachBlock(Location, Consumer<BlockState>) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    +
    forEachBlock(Location, Consumer<BlockState>) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    Iterates each block which would be set if this structure is built
    -
    formatLargeInteger(long) - Static method in class redempt.redlib.misc.FormatUtils
    +
    formatLargeInteger(long) - Static method in class redempt.redlib.misc.FormatUtils
    Formats a large number with commas, like 12345 as 12,345
    -
    formatMoney(double) - Static method in class redempt.redlib.misc.FormatUtils
    +
    formatMoney(double) - Static method in class redempt.redlib.misc.FormatUtils
    Formats money like 3.5B representing 3.5 billion
    -
    formatTimeOffset(long) - Static method in class redempt.redlib.misc.FormatUtils
    +
    formatTimeOffset(long) - Static method in class redempt.redlib.misc.FormatUtils
    Formats a time offset like 1h3m8s (1 hour, 3 minutes, 8 seconds)
    -
    formatTimeOffset(long, int) - Static method in class redempt.redlib.misc.FormatUtils
    +
    formatTimeOffset(long, int) - Static method in class redempt.redlib.misc.FormatUtils
    Formats a time offset like 1h3m8s (1 hour, 3 minutes, 8 seconds)
    -
    FormatUtils - Class in redempt.redlib.misc
    +
    FormatUtils - Class in redempt.redlib.misc
    Contains utilities for formatting various information
    -
    FormatUtils() - Constructor for class redempt.redlib.misc.FormatUtils
    +
    FormatUtils() - Constructor for class redempt.redlib.misc.FormatUtils
     
    -
    fromCollection(Collection<K>, Function<K, T>, ToDoubleFunction<K>) - Static method in class redempt.redlib.misc.WeightedRandom
    +
    fromCollection(Collection<K>, Function<K, T>, ToDoubleFunction<K>) - Static method in class redempt.redlib.misc.WeightedRandom
    Creates a WeightedRandom from a collection
    -
    fromDoubleMap(Map<T, Double>) - Static method in class redempt.redlib.misc.WeightedRandom
    +
    fromDoubleMap(Map<T, Double>) - Static method in class redempt.redlib.misc.WeightedRandom
    Create a new WeightedRandom from a map of outcomes to their weights
    -
    fromIntMap(Map<T, Integer>) - Static method in class redempt.redlib.misc.WeightedRandom
    +
    fromIntMap(Map<T, Integer>) - Static method in class redempt.redlib.misc.WeightedRandom
    Create a new WeightedRandom from a map of outcomes to their weights
    -
    fromLoreLine(String) - Method in class redempt.redlib.enchants.EnchantRegistry
    +
    fromLoreLine(String) - Method in class redempt.redlib.enchants.EnchantRegistry
    Gets a CustomEnchant and its level from a line of lore
    -
    fromRomanNumerals(String) - Static method in class redempt.redlib.enchants.CustomEnchant
    +
    fromRomanNumerals(String) - Static method in class redempt.redlib.enchants.CustomEnchant
    Converts roman numeral string, between 1 and 10, back to a number
    -
    fromStream(InputStream, ArgType<?>...) - Static method in class redempt.redlib.commandmanager.Command
    +
    fromStream(InputStream, ArgType<?>...) - Static method in class redempt.redlib.commandmanager.Command
    -
    Deprecated. -
    Outdated. Use CommandParser.parse()
    +
    Deprecated. +
    Outdated. Use CommandParser.parse()
    -
    fromString(String) - Static method in class redempt.redlib.itemutils.ItemUtils
    +
    fromString(String) - Static method in class redempt.redlib.itemutils.ItemUtils
    Constructs an ItemStack from a previously-serialized JSON string
    -
    fromString(String) - Static method in class redempt.redlib.misc.LocationUtils
    +
    fromString(String) - Static method in class redempt.redlib.misc.LocationUtils
    Converts a String back to a Location.
    -
    fromString(String) - Static method in class redempt.redlib.region.CuboidRegion
    +
    fromString(String) - Static method in class redempt.redlib.region.CuboidRegion
    Converts a String generated by CuboidRegion.toString() back to a Region
    -
    fromString(String) - Static method in class redempt.redlib.region.MultiRegion
    +
    fromString(String) - Static method in class redempt.redlib.region.MultiRegion
    Turns a String generated by MultiRegion.toString() back into a MultiRegion
    -
    fromString(String) - Static method in class redempt.redlib.region.SpheroidRegion
    +
    fromString(String) - Static method in class redempt.redlib.region.SpheroidRegion
    Deserializes a SpheroidRegion serialized with SpheroidRegion.toString()
    -
    fromString(String, String) - Static method in class redempt.redlib.misc.LocationUtils
    +
    fromString(String, String) - Static method in class redempt.redlib.misc.LocationUtils
    Converts a String back to a Location
    -
    fromString(String, Function<String, T>) - Static method in class redempt.redlib.misc.WeightedRandom
    +
    fromString(String, Function<String, T>) - Static method in class redempt.redlib.misc.WeightedRandom
    Deserializes a string to create a WeightedRandom
    -
    fromStringLater(String, String, Consumer<Location>) - Static method in class redempt.redlib.misc.LocationUtils
    +
    fromStringLater(String, String, Consumer<Location>) - Static method in class redempt.redlib.misc.LocationUtils
    Loads a Location from a String.
    -
    fromStringLater(String, Consumer<Location>) - Static method in class redempt.redlib.misc.LocationUtils
    +
    fromStringLater(String, Consumer<Location>) - Static method in class redempt.redlib.misc.LocationUtils
    Loads a Location from a String.
    - - - -

    G

    -
    -
    generateChunkData(World, Random, int, int, ChunkGenerator.BiomeGrid) - Method in class redempt.redlib.worldgen.CustomWorldGenerator
    +

    G

    +
    +
    generateChunkData(World, Random, int, int, ChunkGenerator.BiomeGrid) - Method in class redempt.redlib.worldgen.CustomWorldGenerator
    -
    Deprecated.
    +
    Deprecated.
     
    -
    generateColumn(ChunkGenerator.ChunkData, int, int, int, int, int) - Method in class redempt.redlib.worldgen.CustomBiome
    +
    generateColumn(ChunkGenerator.ChunkData, int, int, int, int, int) - Method in class redempt.redlib.worldgen.CustomBiome
    -
    Deprecated.
    +
    Deprecated.
     
    -
    get() - Method in class redempt.redlib.misc.EntityPersistor
    +
    get() - Method in class redempt.redlib.misc.EntityPersistor
    Gets the Entity held in this EntityPersistor.
    -
    get(int) - Method in class redempt.redlib.nms.NMSArray
    +
    get(int) - Method in class redempt.redlib.nms.NMSArray
    Gets a wrapped NMSObject with the value at a certain index in the array
    -
    get(int) - Method in class redempt.redlib.sql.SQLHelper.Results
    +
    get(int) - Method in class redempt.redlib.sql.SQLHelper.Results
    Gets an Object in the given column in the current row
    -
    get(String) - Method in class redempt.redlib.blockdata.DataBlock
    +
    get(String) - Method in class redempt.redlib.blockdata.DataBlock
    Gets the object mapped to a certain key
    -
    get(String) - Method in class redempt.redlib.commandmanager.Messages
    +
    get(String) - Method in class redempt.redlib.commandmanager.Messages
    Gets a color-formatted message by name
    -
    get(Block) - Method in class redempt.redlib.blockdata.CustomBlockType
    +
    get(Block) - Method in class redempt.redlib.blockdata.CustomBlockType
    Gets a CustomBlock of this type at the given block
    -
    get(Location) - Method in class redempt.redlib.region.RegionMap
    +
    get(Location) - Method in class redempt.redlib.region.RegionMap
    Gets all objects mapped to an approximate location
    -
    get(Plugin) - Static method in class redempt.redlib.enchants.EnchantRegistry
    +
    get(Plugin) - Static method in class redempt.redlib.enchants.EnchantRegistry
    Gets the EnchantRegistry owned by the given plugin
    -
    get(DataBlock) - Method in class redempt.redlib.blockdata.CustomBlockType
    +
    get(DataBlock) - Method in class redempt.redlib.blockdata.CustomBlockType
    Gets a CustomBlock of this type from the given DataBlock
    -
    getAfter() - Method in class redempt.redlib.enchants.EventItems
    +
    getAfter() - Method in class redempt.redlib.enchants.EventItems
     
    -
    getAliases() - Method in class redempt.redlib.commandmanager.Command
    +
    getAliases() - Method in class redempt.redlib.commandmanager.Command
     
    -
    getAll() - Method in class redempt.redlib.blockdata.BlockDataManager
    +
    getAll() - Method in class redempt.redlib.blockdata.BlockDataManager
    Loads and returns a set of all DataBlocks managed by this BlockDataManager.
    -
    getAll() - Method in class redempt.redlib.region.RegionMap
    +
    getAll() - Method in class redempt.redlib.region.RegionMap
     
    -
    getAll(Plugin) - Static method in class redempt.redlib.itemutils.CustomItem
    +
    getAll(Plugin) - Static method in class redempt.redlib.itemutils.CustomItem
    Gets an instance of every class which extends CustomItem in your plugin, and puts them in a map by name Note: Custom item classes MUST have a default constructor which takes no arguments to be loaded by this method
    -
    getAllLoaded() - Method in class redempt.redlib.blockdata.BlockDataManager
    +
    getAllLoaded() - Method in class redempt.redlib.blockdata.BlockDataManager
     
    -
    getAllManagers() - Static method in class redempt.redlib.blockdata.BlockDataManager
    +
    getAllManagers() - Static method in class redempt.redlib.blockdata.BlockDataManager
     
    -
    getAllRegistries() - Static method in class redempt.redlib.blockdata.CustomBlockRegistry
    +
    getAllRegistries() - Static method in class redempt.redlib.blockdata.CustomBlockRegistry
     
    -
    getArgType() - Method in class redempt.redlib.dev.ChainCommand
    +
    getArgType() - Method in class redempt.redlib.dev.ChainCommand
     
    -
    getArgTypes(Object...) - Static method in class redempt.redlib.nms.NMSHelper
    +
    getArgTypes(Object...) - Static method in class redempt.redlib.nms.NMSHelper
    Gets the class list of argument types for finding methods
    -
    getAt(Location) - Static method in class redempt.redlib.misc.Hologram
    +
    getAt(Location) - Static method in class redempt.redlib.misc.Hologram
    Attempts to get a Hologram at a specified location
    -
    getAt(Location) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    +
    getAt(Location) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    Gets the Structure at the given block, if it exists.
    -
    getAt(Location, int, int, int, int, boolean) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    +
    getAt(Location, int, int, int, int, boolean) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    Gets the Structure at the given block, if it exists.
    -
    getBaseItemName() - Method in class redempt.redlib.blockdata.CustomBlockType
    +
    getBaseItemName() - Method in class redempt.redlib.blockdata.CustomBlockType
     
    -
    getBefore() - Method in class redempt.redlib.enchants.EventItems
    +
    getBefore() - Method in class redempt.redlib.enchants.EventItems
     
    -
    getBlock() - Method in class redempt.redlib.blockdata.CustomBlock
    +
    getBlock() - Method in class redempt.redlib.blockdata.CustomBlock
     
    -
    getBlock() - Method in class redempt.redlib.blockdata.DataBlock
    +
    getBlock() - Method in class redempt.redlib.blockdata.DataBlock
     
    -
    getBlock() - Method in class redempt.redlib.multiblock.Structure.StructureBlock
    +
    getBlock() - Method in class redempt.redlib.multiblock.Structure.StructureBlock
    Gets the Block this StructureBlock references
    -
    getBlock(Block) - Method in class redempt.redlib.multiblock.Structure
    +
    getBlock(Block) - Method in class redempt.redlib.multiblock.Structure
    Gets a relative block in this Structure from an absolute block in the world
    -
    getBlockDimensions() - Method in class redempt.redlib.region.Region
    +
    getBlockDimensions() - Method in class redempt.redlib.region.Region
    Get the dimensions of this Region [x, y, z] in blocks
    -
    getBlockHeight(int, int) - Method in class redempt.redlib.worldgen.CustomBiome
    +
    getBlockHeight(int, int) - Method in class redempt.redlib.worldgen.CustomBiome
    -
    Deprecated.
    +
    Deprecated.
     
    -
    getBlocks() - Method in class redempt.redlib.multiblock.Structure
    +
    getBlocks() - Method in class redempt.redlib.multiblock.Structure
    Get all blocks in this Structure
    -
    getBlocks() - Method in class redempt.redlib.region.CuboidRegion.RegionState
    +
    getBlocks() - Method in class redempt.redlib.region.CuboidRegion.RegionState
    Gets all the BlockStates in this RegionState
    -
    getBlockVolume() - Method in class redempt.redlib.region.CuboidRegion
    +
    getBlockVolume() - Method in class redempt.redlib.region.CuboidRegion
     
    -
    getBlockVolume() - Method in class redempt.redlib.region.MultiRegion
    +
    getBlockVolume() - Method in class redempt.redlib.region.MultiRegion
    Sums the block volume of all the Regions that make up this MultiRegion.
    -
    getBlockVolume() - Method in class redempt.redlib.region.Region
    +
    getBlockVolume() - Method in class redempt.redlib.region.Region
     
    -
    getBlockVolume() - Method in class redempt.redlib.region.SpheroidRegion
    +
    getBlockVolume() - Method in class redempt.redlib.region.SpheroidRegion
     
    -
    getBoolean(int) - Method in class redempt.redlib.json.JSONList
    +
    getBoolean(int) - Method in class redempt.redlib.json.JSONList
     
    -
    getBoolean(String) - Method in class redempt.redlib.blockdata.DataBlock
    +
    getBoolean(String) - Method in class redempt.redlib.blockdata.DataBlock
    Gets a boolean mapped to a certain key
    -
    getBoolean(String) - Method in class redempt.redlib.json.JSONMap
    +
    getBoolean(String) - Method in class redempt.redlib.json.JSONMap
     
    -
    getBounds() - Method in class redempt.redlib.protection.ProtectionPolicy
    +
    getBounds() - Method in class redempt.redlib.protection.ProtectionPolicy
     
    -
    getButtons() - Method in class redempt.redlib.inventorygui.InventoryGUI
    +
    getButtons() - Method in class redempt.redlib.inventorygui.InventoryGUI
     
    -
    getByHookName(String) - Method in class redempt.redlib.commandmanager.CommandCollection
    +
    getByHookName(String) - Method in class redempt.redlib.commandmanager.CommandCollection
    Recurseively searches this CommandCollection for a command with a given hook name
    -
    getByName(String) - Method in class redempt.redlib.blockdata.CustomBlockRegistry
    +
    getByName(String) - Method in class redempt.redlib.blockdata.CustomBlockRegistry
    Gets a CustomBlockType by name
    -
    getByName(String) - Method in class redempt.redlib.enchants.EnchantRegistry
    +
    getByName(String) - Method in class redempt.redlib.enchants.EnchantRegistry
    Gets a CustomEnchant by its name or ID
    -
    getByType(Material) - Method in class redempt.redlib.multiblock.Structure
    +
    getByType(Material) - Method in class redempt.redlib.multiblock.Structure
    Gets all blocks of the given type in this Structure
    -
    getCaches() - Method in class redempt.redlib.sql.SQLHelper
    +
    getCaches() - Method in class redempt.redlib.sql.SQLHelper
     
    -
    getCallingPlugin() - Static method in class redempt.redlib.RedLib
    +
    getCallingPlugin() - Static method in class redempt.redlib.RedLib
    Gets the plugin that called the calling method of this method
    -
    getCause() - Method in class redempt.redlib.blockdata.events.DataBlockDestroyEvent
    +
    getCause() - Method in class redempt.redlib.blockdata.events.DataBlockDestroyEvent
     
    -
    getCause() - Method in class redempt.redlib.region.events.RegionEnterEvent
    +
    getCause() - Method in class redempt.redlib.region.events.RegionEnterEvent
     
    -
    getCause() - Method in class redempt.redlib.region.events.RegionExitEvent
    +
    getCause() - Method in class redempt.redlib.region.events.RegionExitEvent
     
    -
    getCaveHeight(int, int, int) - Method in class redempt.redlib.worldgen.CustomBiome
    +
    getCaveHeight(int, int, int) - Method in class redempt.redlib.worldgen.CustomBiome
    -
    Deprecated.
    +
    Deprecated.
     
    -
    getCenter() - Method in class redempt.redlib.region.Region
    +
    getCenter() - Method in class redempt.redlib.region.Region
     
    -
    getCenter() - Method in class redempt.redlib.region.SpheroidRegion
    +
    getCenter() - Method in class redempt.redlib.region.SpheroidRegion
     
    -
    getChildren() - Method in class redempt.redlib.dev.profiler.SampleSummary.SampleMethod
    +
    getChildren() - Method in class redempt.redlib.dev.profiler.SampleSummary.SampleMethod
     
    -
    getChunkCoordinates() - Method in class redempt.redlib.blockdata.DataBlock
    +
    getChunkCoordinates() - Method in class redempt.redlib.blockdata.DataBlock
     
    -
    getChunkCoordinates(Location) - Static method in class redempt.redlib.misc.LocationUtils
    +
    getChunkCoordinates(Location) - Static method in class redempt.redlib.misc.LocationUtils
    Gets the chunk X and Z of a location
    -
    getChunks() - Method in class redempt.redlib.region.Region
    +
    getChunks() - Method in class redempt.redlib.region.Region
     
    -
    getClass(String) - Static method in class redempt.redlib.nms.NMSHelper
    +
    getClass(String) - Static method in class redempt.redlib.nms.NMSHelper
    Gets any class and wraps it in an NMSClass
    -
    getColumnCount() - Method in class redempt.redlib.sql.SQLHelper.Results
    +
    getColumnCount() - Method in class redempt.redlib.sql.SQLHelper.Results
    Gets the column count from the returned data
    -
    getColumnName() - Method in class redempt.redlib.sql.SQLCache
    +
    getColumnName() - Method in class redempt.redlib.sql.SQLCache
     
    -
    getCommands() - Method in class redempt.redlib.commandmanager.CommandCollection
    +
    getCommands() - Method in class redempt.redlib.commandmanager.CommandCollection
     
    -
    getConfig() - Method in class redempt.redlib.configmanager.ConfigManager
    +
    getConfig() - Method in class redempt.redlib.configmanager.ConfigManager
     
    -
    getConnection() - Method in class redempt.redlib.sql.SQLHelper
    +
    getConnection() - Method in class redempt.redlib.sql.SQLHelper
     
    -
    getConstructor(Class<?>, Class<?>[]) - Static method in class redempt.redlib.nms.NMSHelper
    +
    getConstructor(Class<?>, Class<?>[]) - Static method in class redempt.redlib.nms.NMSHelper
    Gets a constructor by its parameter types, accounts for cases where the given class might not be the exact same type as the parameter the method requires, but is a subclass.
    -
    getCorners() - Method in class redempt.redlib.region.Region
    +
    getCorners() - Method in class redempt.redlib.region.Region
     
    -
    getCount() - Method in class redempt.redlib.dev.profiler.SampleSummary.SampleMethod
    +
    getCount() - Method in class redempt.redlib.dev.profiler.SampleSummary.SampleMethod
     
    -
    getCustom(DataBlock) - Method in class redempt.redlib.blockdata.CustomBlockType
    +
    getCustom(DataBlock) - Method in class redempt.redlib.blockdata.CustomBlockType
    Defines a custom return for a class extending CustomBlock
    -
    getCustomBlock(Block) - Method in class redempt.redlib.blockdata.CustomBlockRegistry
    +
    getCustomBlock(Block) - Method in class redempt.redlib.blockdata.CustomBlockRegistry
    Gets a CustomBlock instance with the correct CustomBlockType
    -
    getCustomBlockType() - Method in class redempt.redlib.blockdata.events.CustomBlockPlaceEvent
    +
    getCustomBlockType() - Method in class redempt.redlib.blockdata.events.CustomBlockPlaceEvent
     
    -
    getData() - Method in class redempt.redlib.blockdata.DataBlock
    +
    getData() - Method in class redempt.redlib.blockdata.DataBlock
     
    -
    getData(int, int, int) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    +
    getData(int, int, int) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    Gets the data of this structure at a given relative location
    -
    getData(Location, int, int, int) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    +
    getData(Location, int, int, int) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    Gets the data of this structure at a given relative location, set with a BlockState at the given location
    -
    getDataBlock() - Method in class redempt.redlib.blockdata.CustomBlock
    +
    getDataBlock() - Method in class redempt.redlib.blockdata.CustomBlock
     
    -
    getDataBlock() - Method in class redempt.redlib.blockdata.events.DataBlockDestroyEvent
    +
    getDataBlock() - Method in class redempt.redlib.blockdata.events.DataBlockDestroyEvent
     
    -
    getDataBlock() - Method in class redempt.redlib.blockdata.events.DataBlockMoveEvent
    +
    getDataBlock() - Method in class redempt.redlib.blockdata.events.DataBlockMoveEvent
     
    -
    getDataBlock(Block) - Method in class redempt.redlib.blockdata.BlockDataManager
    +
    getDataBlock(Block) - Method in class redempt.redlib.blockdata.BlockDataManager
    Gets a DataBlock from a given Block, creating a new one if that Block had no data attached to it.
    -
    getDefaultItem() - Method in class redempt.redlib.itemutils.CustomItem
    +
    getDefaultItem() - Method in class redempt.redlib.itemutils.CustomItem
     
    -
    getDepth() - Method in class redempt.redlib.dev.profiler.SampleSummary.SampleMethod
    +
    getDepth() - Method in class redempt.redlib.dev.profiler.SampleSummary.SampleMethod
     
    -
    getDimensions() - Method in class redempt.redlib.multiblock.MultiBlockStructure
    +
    getDimensions() - Method in class redempt.redlib.multiblock.MultiBlockStructure
    Gets the dimensions of this multi-block structure.
    -
    getDimensions() - Method in class redempt.redlib.region.Region
    +
    getDimensions() - Method in class redempt.redlib.region.Region
    Get the dimensions of this Region [x, y, z]
    -
    getDirect(int) - Method in class redempt.redlib.nms.NMSArray
    +
    getDirect(int) - Method in class redempt.redlib.nms.NMSArray
    Gets the object at the given index in the wrapped array
    -
    getDirection(BlockFace) - Static method in class redempt.redlib.misc.LocationUtils
    +
    getDirection(BlockFace) - Static method in class redempt.redlib.misc.LocationUtils
    Gets the Vector direction of a BlockFace.
    -
    getDisplayName() - Method in class redempt.redlib.enchants.CustomEnchant
    +
    getDisplayName() - Method in class redempt.redlib.enchants.CustomEnchant
     
    -
    getDisplayName(CustomEnchant) - Method in class redempt.redlib.enchants.EnchantRegistry
    +
    getDisplayName(CustomEnchant) - Method in class redempt.redlib.enchants.EnchantRegistry
    Gets the display name of a CustomEnchant
    -
    getDouble(int) - Method in class redempt.redlib.json.JSONList
    +
    getDouble(int) - Method in class redempt.redlib.json.JSONList
     
    -
    getDouble(String) - Method in class redempt.redlib.blockdata.DataBlock
    +
    getDouble(String) - Method in class redempt.redlib.blockdata.DataBlock
    Gets a double mapped to a certain key
    -
    getDouble(String) - Method in class redempt.redlib.json.JSONMap
    +
    getDouble(String) - Method in class redempt.redlib.json.JSONMap
     
    -
    getDouble(ItemStack, String) - Method in class redempt.redlib.itemutils.LoreStats
    +
    getDouble(ItemStack, String) - Method in class redempt.redlib.itemutils.LoreStats
    Gets a double stat from lore
    -
    getDouble(ItemStack, String, double) - Method in class redempt.redlib.itemutils.LoreStats
    +
    getDouble(ItemStack, String, double) - Method in class redempt.redlib.itemutils.LoreStats
    Gets a double stat from lore
    -
    getDrops(T) - Method in class redempt.redlib.blockdata.CustomBlockType
    +
    getDrops(T) - Method in class redempt.redlib.blockdata.CustomBlockType
     
    -
    getDuration() - Method in class redempt.redlib.dev.profiler.SampleSummary
    +
    getDuration() - Method in class redempt.redlib.dev.profiler.SampleSummary
     
    -
    getElevationMax() - Method in class redempt.redlib.worldgen.CustomBiome
    +
    getElevationMax() - Method in class redempt.redlib.worldgen.CustomBiome
    -
    Deprecated.
    +
    Deprecated.
     
    -
    getElevationMin() - Method in class redempt.redlib.worldgen.CustomBiome
    +
    getElevationMin() - Method in class redempt.redlib.worldgen.CustomBiome
    -
    Deprecated.
    +
    Deprecated.
     
    -
    getEnchant() - Method in class redempt.redlib.enchants.EnchantInfo
    +
    getEnchant() - Method in class redempt.redlib.enchants.EnchantInfo
     
    -
    getEnchantArgType(String) - Method in class redempt.redlib.enchants.EnchantRegistry
    +
    getEnchantArgType(String) - Method in class redempt.redlib.enchants.EnchantRegistry
    Gets the ArgType for CustomEnchants in this registry, with tab completion using IDs
    -
    getEnchants() - Method in class redempt.redlib.enchants.EnchantRegistry
    +
    getEnchants() - Method in class redempt.redlib.enchants.EnchantRegistry
     
    -
    getEnchants(ItemStack) - Method in class redempt.redlib.enchants.EnchantRegistry
    +
    getEnchants(ItemStack) - Method in class redempt.redlib.enchants.EnchantRegistry
    Gets all the CustomEnchants on an item
    -
    getEnd() - Method in class redempt.redlib.dev.profiler.SampleSummary
    +
    getEnd() - Method in class redempt.redlib.dev.profiler.SampleSummary
     
    -
    getEnd() - Method in class redempt.redlib.region.CuboidRegion
    +
    getEnd() - Method in class redempt.redlib.region.CuboidRegion
    Get the maximum corner of this Region
    -
    getEnd() - Method in class redempt.redlib.region.MultiRegion
    +
    getEnd() - Method in class redempt.redlib.region.MultiRegion
     
    -
    getEnd() - Method in class redempt.redlib.region.Region
    +
    getEnd() - Method in class redempt.redlib.region.Region
     
    -
    getEnd() - Method in class redempt.redlib.region.SpheroidRegion
    +
    getEnd() - Method in class redempt.redlib.region.SpheroidRegion
     
    -
    getEntities() - Method in class redempt.redlib.region.Region
    +
    getEntities() - Method in class redempt.redlib.region.Region
    Gets all entities contained in this Region in loaded chunks
    -
    getEntities(boolean) - Method in class redempt.redlib.region.Region
    +
    getEntities(boolean) - Method in class redempt.redlib.region.Region
    Gets all entities contained in this Region
    -
    getErrorMessage() - Method in class redempt.redlib.commandmanager.ContextProvider
    +
    getErrorMessage() - Method in class redempt.redlib.commandmanager.ContextProvider
     
    -
    getEvent() - Method in class redempt.redlib.enchants.EventItems
    +
    getEvent() - Method in class redempt.redlib.enchants.EventItems
     
    -
    getEvents() - Method in class redempt.redlib.enchants.trigger.EnchantTrigger
    +
    getEvents() - Method in class redempt.redlib.enchants.trigger.EnchantTrigger
    Gets the event listeners registered by this EnchantTrigger
    -
    getExisting(Block) - Method in class redempt.redlib.blockdata.BlockDataManager
    +
    getExisting(Block) - Method in class redempt.redlib.blockdata.BlockDataManager
    Gets an existing DataBlock, returning null if that Block has no data attached to it.
    -
    getExpandedName() - Method in class redempt.redlib.commandmanager.Command
    +
    getExpandedName() - Method in class redempt.redlib.commandmanager.Command
     
    -
    getExtendingClasses(Plugin, Class<T>) - Static method in class redempt.redlib.RedLib
    +
    getExtendingClasses(Plugin, Class<T>) - Static method in class redempt.redlib.RedLib
    Gets all non-abstract, non-interface classes which extend a certain class within a plugin
    -
    getFace(BlockFace) - Method in class redempt.redlib.region.CuboidRegion
    +
    getFace(BlockFace) - Method in class redempt.redlib.region.CuboidRegion
    Gets a CuboidRegion representing a 1-block thick slice on a face of this Region
    -
    getField(int, String) - Method in class redempt.redlib.nms.NMSObject
    +
    getField(int, String) - Method in class redempt.redlib.nms.NMSObject
    Gets the value stored in a field in the wrapped object
    -
    getField(String) - Method in class redempt.redlib.nms.NMSObject
    +
    getField(String) - Method in class redempt.redlib.nms.NMSObject
    Gets the value stored in a field in the wrapped object
    -
    getFullName() - Method in class redempt.redlib.commandmanager.Command
    +
    getFullName() - Method in class redempt.redlib.commandmanager.Command
     
    -
    getHandlerList() - Static method in class redempt.redlib.blockdata.events.CustomBlockPlaceEvent
    +
    getHandlerList() - Static method in class redempt.redlib.blockdata.events.CustomBlockPlaceEvent
     
    -
    getHandlerList() - Static method in class redempt.redlib.blockdata.events.DataBlockDestroyEvent
    +
    getHandlerList() - Static method in class redempt.redlib.blockdata.events.DataBlockDestroyEvent
     
    -
    getHandlerList() - Static method in class redempt.redlib.blockdata.events.DataBlockMoveEvent
    +
    getHandlerList() - Static method in class redempt.redlib.blockdata.events.DataBlockMoveEvent
     
    -
    getHandlerList() - Static method in class redempt.redlib.enchants.events.PlayerChangedArmorEvent
    +
    getHandlerList() - Static method in class redempt.redlib.enchants.events.PlayerChangedArmorEvent
     
    -
    getHandlerList() - Static method in class redempt.redlib.enchants.events.PlayerChangedHeldItemEvent
    +
    getHandlerList() - Static method in class redempt.redlib.enchants.events.PlayerChangedHeldItemEvent
     
    -
    getHandlerList() - Static method in class redempt.redlib.region.events.RegionEnterEvent
    +
    getHandlerList() - Static method in class redempt.redlib.region.events.RegionEnterEvent
     
    -
    getHandlerList() - Static method in class redempt.redlib.region.events.RegionExitEvent
    +
    getHandlerList() - Static method in class redempt.redlib.region.events.RegionExitEvent
     
    -
    getHandlers() - Method in class redempt.redlib.blockdata.events.CustomBlockPlaceEvent
    +
    getHandlers() - Method in class redempt.redlib.blockdata.events.CustomBlockPlaceEvent
     
    -
    getHandlers() - Method in class redempt.redlib.blockdata.events.DataBlockDestroyEvent
    +
    getHandlers() - Method in class redempt.redlib.blockdata.events.DataBlockDestroyEvent
     
    -
    getHandlers() - Method in class redempt.redlib.blockdata.events.DataBlockMoveEvent
    +
    getHandlers() - Method in class redempt.redlib.blockdata.events.DataBlockMoveEvent
     
    -
    getHandlers() - Method in class redempt.redlib.enchants.events.PlayerChangedArmorEvent
    +
    getHandlers() - Method in class redempt.redlib.enchants.events.PlayerChangedArmorEvent
     
    -
    getHandlers() - Method in class redempt.redlib.enchants.events.PlayerChangedHeldItemEvent
    +
    getHandlers() - Method in class redempt.redlib.enchants.events.PlayerChangedHeldItemEvent
     
    -
    getHandlers() - Method in class redempt.redlib.region.events.RegionEnterEvent
    +
    getHandlers() - Method in class redempt.redlib.region.events.RegionEnterEvent
     
    -
    getHandlers() - Method in class redempt.redlib.region.events.RegionExitEvent
    +
    getHandlers() - Method in class redempt.redlib.region.events.RegionExitEvent
     
    -
    getHelp() - Method in class redempt.redlib.commandmanager.Command
    +
    getHelp() - Method in class redempt.redlib.commandmanager.Command
     
    -
    getHelpRecursive(CommandSender, int) - Method in class redempt.redlib.commandmanager.Command
    +
    getHelpRecursive(CommandSender, int) - Method in class redempt.redlib.commandmanager.Command
     
    -
    getId() - Method in class redempt.redlib.enchants.CustomEnchant
    +
    getId() - Method in class redempt.redlib.enchants.CustomEnchant
     
    -
    getIncompatible() - Method in class redempt.redlib.enchants.CustomEnchant
    +
    getIncompatible() - Method in class redempt.redlib.enchants.CustomEnchant
     
    -
    getInstance() - Static method in class redempt.redlib.RedLib
    +
    getInstance() - Static method in class redempt.redlib.RedLib
     
    -
    getInstance(Object...) - Method in class redempt.redlib.nms.NMSClass
    +
    getInstance(Object...) - Method in class redempt.redlib.nms.NMSClass
    Calls a constructor of this class with the given arguments
    -
    getInt(int) - Method in class redempt.redlib.json.JSONList
    +
    getInt(int) - Method in class redempt.redlib.json.JSONList
     
    -
    getInt(String) - Method in class redempt.redlib.blockdata.DataBlock
    +
    getInt(String) - Method in class redempt.redlib.blockdata.DataBlock
    Gets an int mapped to a certain key
    -
    getInt(String) - Method in class redempt.redlib.json.JSONMap
    +
    getInt(String) - Method in class redempt.redlib.json.JSONMap
     
    -
    getInt(ItemStack, String) - Method in class redempt.redlib.itemutils.LoreStats
    +
    getInt(ItemStack, String) - Method in class redempt.redlib.itemutils.LoreStats
    Gets an int stat from lore
    -
    getInt(ItemStack, String, int) - Method in class redempt.redlib.itemutils.LoreStats
    +
    getInt(ItemStack, String, int) - Method in class redempt.redlib.itemutils.LoreStats
    Gets an int stat from lore
    -
    getIntersection(Overlappable) - Method in class redempt.redlib.region.CuboidRegion
    +
    getIntersection(Overlappable) - Method in class redempt.redlib.region.CuboidRegion
    Gets the cuboid intersection of this Region and another cuboid Region
    -
    getIntersection(Overlappable) - Method in class redempt.redlib.region.MultiRegion
    +
    getIntersection(Overlappable) - Method in class redempt.redlib.region.MultiRegion
    Gets a MultiRegion representing the overlap.
    -
    getIntersection(Overlappable) - Method in interface redempt.redlib.region.Overlappable
    +
    getIntersection(Overlappable) - Method in interface redempt.redlib.region.Overlappable
    Gets the intersection of this Overlappable with another
    -
    getInventory() - Method in class redempt.redlib.inventorygui.InventoryGUI
    +
    getInventory() - Method in class redempt.redlib.inventorygui.InventoryGUI
    Gets the inventory this GUI is wrapping
    -
    getInverse() - Method in class redempt.redlib.multiblock.Rotator
    +
    getInverse() - Method in class redempt.redlib.multiblock.Rotator
    Gets a Rotator which will negate the operations of this Rotator
    -
    getItem() - Method in class redempt.redlib.blockdata.events.CustomBlockPlaceEvent
    +
    getItem() - Method in class redempt.redlib.blockdata.events.CustomBlockPlaceEvent
     
    -
    getItem() - Method in class redempt.redlib.inventorygui.ItemButton
    +
    getItem() - Method in class redempt.redlib.inventorygui.ItemButton
    Get the ItemStack representing the icon for this button
    -
    getItem() - Method in class redempt.redlib.itemutils.CustomItem
    +
    getItem() - Method in class redempt.redlib.itemutils.CustomItem
     
    -
    getItem() - Method in class redempt.redlib.region.SelectionTool
    +
    getItem() - Method in class redempt.redlib.region.SelectionTool
    Gets the item used by this SelectionTool
    -
    getItem(T) - Method in class redempt.redlib.blockdata.CustomBlockType
    +
    getItem(T) - Method in class redempt.redlib.blockdata.CustomBlockType
    Gets the item to be dropped when this block is mined
    -
    getLastSpace(String) - Method in class redempt.redlib.enchants.EnchantRegistry
    +
    getLastSpace(String) - Method in class redempt.redlib.enchants.EnchantRegistry
     
    -
    getLevel() - Method in class redempt.redlib.enchants.EnchantInfo
    +
    getLevel() - Method in class redempt.redlib.enchants.EnchantInfo
     
    -
    getLevel(ItemStack) - Method in class redempt.redlib.enchants.CustomEnchant
    +
    getLevel(ItemStack) - Method in class redempt.redlib.enchants.CustomEnchant
    Gets the level of this CustomEnchant on an item
    -
    getLine(int) - Method in class redempt.redlib.misc.Hologram
    +
    getLine(int) - Method in class redempt.redlib.misc.Hologram
     
    -
    getLines() - Method in class redempt.redlib.misc.Hologram
    +
    getLines() - Method in class redempt.redlib.misc.Hologram
     
    -
    getLineSpacing() - Method in class redempt.redlib.misc.Hologram
    +
    getLineSpacing() - Method in class redempt.redlib.misc.Hologram
     
    -
    getList(int) - Method in class redempt.redlib.json.JSONList
    +
    getList(int) - Method in class redempt.redlib.json.JSONList
     
    -
    getList(String) - Method in class redempt.redlib.blockdata.DataBlock
    +
    getList(String) - Method in class redempt.redlib.blockdata.DataBlock
    Gets a JSONList mapped to a certain key
    -
    getList(String) - Method in class redempt.redlib.json.JSONMap
    +
    getList(String) - Method in class redempt.redlib.json.JSONMap
     
    -
    getListener() - Method in class redempt.redlib.commandmanager.Command.MethodHook
    +
    getListener() - Method in class redempt.redlib.commandmanager.Command.MethodHook
     
    -
    getLoaded(Chunk) - Method in class redempt.redlib.blockdata.BlockDataManager
    +
    getLoaded(Chunk) - Method in class redempt.redlib.blockdata.BlockDataManager
    Gets all the loaded DataBlocks in a chunk
    -
    getLoaded(Plugin) - Static method in class redempt.redlib.commandmanager.Messages
    +
    getLoaded(Plugin) - Static method in class redempt.redlib.commandmanager.Messages
    Gets the Messages which have been loaded for a specific plugin, if they exist
    -
    getLoaded(World, int, int) - Method in class redempt.redlib.blockdata.BlockDataManager
    +
    getLoaded(World, int, int) - Method in class redempt.redlib.blockdata.BlockDataManager
    Gets all the loaded DataBlocks in a chunk
    -
    getLoadedChunks() - Method in class redempt.redlib.region.Region
    +
    getLoadedChunks() - Method in class redempt.redlib.region.Region
     
    -
    getLocation() - Method in class redempt.redlib.misc.Hologram
    +
    getLocation() - Method in class redempt.redlib.misc.Hologram
     
    -
    getLocation() - Method in class redempt.redlib.multiblock.Structure
    +
    getLocation() - Method in class redempt.redlib.multiblock.Structure
    Gets the location of this structure (will be a corner)
    -
    getLocations(UUID) - Method in class redempt.redlib.region.SelectionTool
    +
    getLocations(UUID) - Method in class redempt.redlib.region.SelectionTool
    Get the locations selected by the given player
    -
    getLong(int) - Method in class redempt.redlib.json.JSONList
    +
    getLong(int) - Method in class redempt.redlib.json.JSONList
     
    -
    getLong(int) - Method in class redempt.redlib.sql.SQLHelper.Results
    +
    getLong(int) - Method in class redempt.redlib.sql.SQLHelper.Results
    Gets a Long in the given column in the current row
    -
    getLong(String) - Method in class redempt.redlib.blockdata.DataBlock
    +
    getLong(String) - Method in class redempt.redlib.blockdata.DataBlock
    Gets a double mapped to a certain key
    -
    getLong(String) - Method in class redempt.redlib.json.JSONMap
    +
    getLong(String) - Method in class redempt.redlib.json.JSONMap
     
    -
    getLore(int) - Method in class redempt.redlib.enchants.CustomEnchant
    +
    getLore(int) - Method in class redempt.redlib.enchants.CustomEnchant
    Gets the lore that will be added to an item if this CustomEnchant is applied at the given level
    -
    getManager() - Method in class redempt.redlib.blockdata.CustomBlockRegistry
    +
    getManager() - Method in class redempt.redlib.blockdata.CustomBlockRegistry
     
    -
    getManager() - Method in class redempt.redlib.blockdata.DataBlock
    +
    getManager() - Method in class redempt.redlib.blockdata.DataBlock
     
    -
    getMap(int) - Method in class redempt.redlib.json.JSONList
    +
    getMap(int) - Method in class redempt.redlib.json.JSONList
     
    -
    getMap(String) - Method in class redempt.redlib.blockdata.DataBlock
    +
    getMap(String) - Method in class redempt.redlib.blockdata.DataBlock
    Gets a JSONMap mapped to a certain key
    -
    getMap(String) - Method in class redempt.redlib.json.JSONMap
    +
    getMap(String) - Method in class redempt.redlib.json.JSONMap
     
    -
    getMatchingCaches(String) - Method in class redempt.redlib.sql.SQLHelper
    +
    getMatchingCaches(String) - Method in class redempt.redlib.sql.SQLHelper
    Gets the caches matching a pattern
    -
    getMaxLevel() - Method in class redempt.redlib.enchants.CustomEnchant
    +
    getMaxLevel() - Method in class redempt.redlib.enchants.CustomEnchant
     
    -
    getMethod() - Method in class redempt.redlib.commandmanager.Command.MethodHook
    +
    getMethod() - Method in class redempt.redlib.commandmanager.Command.MethodHook
     
    -
    getMethod(Class<?>, String, Class<?>[]) - Static method in class redempt.redlib.nms.NMSHelper
    +
    getMethod(Class<?>, String, Class<?>[]) - Static method in class redempt.redlib.nms.NMSHelper
    Gets a method by its name and parameter types, accounts for cases where the given class might not be the exact same type as the parameter the method requires, but is a subclass.
    -
    getMethodsByName() - Method in class redempt.redlib.dev.profiler.SampleSummary
    +
    getMethodsByName() - Method in class redempt.redlib.dev.profiler.SampleSummary
     
    -
    getName() - Method in class redempt.redlib.blockdata.CustomBlockType
    +
    getName() - Method in class redempt.redlib.blockdata.CustomBlockType
     
    -
    getName() - Method in class redempt.redlib.commandmanager.ArgType
    +
    getName() - Method in class redempt.redlib.commandmanager.ArgType
     
    -
    getName() - Method in class redempt.redlib.commandmanager.Command
    +
    getName() - Method in class redempt.redlib.commandmanager.Command
     
    -
    getName() - Method in class redempt.redlib.commandmanager.ContextProvider
    +
    getName() - Method in class redempt.redlib.commandmanager.ContextProvider
     
    -
    getName() - Method in class redempt.redlib.dev.profiler.SampleSummary.SampleMethod
    +
    getName() - Method in class redempt.redlib.dev.profiler.SampleSummary.SampleMethod
     
    -
    getName() - Method in class redempt.redlib.enchants.CustomEnchant
    +
    getName() - Method in class redempt.redlib.enchants.CustomEnchant
     
    -
    getName() - Method in class redempt.redlib.itemutils.CustomItem
    +
    getName() - Method in class redempt.redlib.itemutils.CustomItem
     
    -
    getName() - Method in class redempt.redlib.multiblock.MultiBlockStructure
    +
    getName() - Method in class redempt.redlib.multiblock.MultiBlockStructure
    Gets this multi-block structure's name.
    -
    getName() - Method in class redempt.redlib.nms.NMSClass
    +
    getName() - Method in class redempt.redlib.nms.NMSClass
     
    -
    getName() - Method in class redempt.redlib.worldgen.CustomBiome
    +
    getName() - Method in class redempt.redlib.worldgen.CustomBiome
    -
    Deprecated.
    +
    Deprecated.
     
    -
    getNearby(Location, int) - Method in class redempt.redlib.blockdata.BlockDataManager
    +
    getNearby(Location, int) - Method in class redempt.redlib.blockdata.BlockDataManager
    Gets all the DataBlocks near an approximate location
    -
    getNearby(Location, int) - Method in class redempt.redlib.region.RegionMap
    +
    getNearby(Location, int) - Method in class redempt.redlib.region.RegionMap
    Gets all objects mapped near the given location
    -
    getNearestSafeLocation(Location, int) - Static method in class redempt.redlib.misc.LocationUtils
    +
    getNearestSafeLocation(Location, int) - Static method in class redempt.redlib.misc.LocationUtils
    Gets the nearest safe location to the given location within the given distance
    -
    getNearestSafeLocation(Location, int, Predicate<Location>) - Static method in class redempt.redlib.misc.LocationUtils
    +
    getNearestSafeLocation(Location, int, Predicate<Location>) - Static method in class redempt.redlib.misc.LocationUtils
    Gets the nearest safe location to the given location within the given distance passing the given predicate check
    -
    getNewArmor() - Method in class redempt.redlib.enchants.events.PlayerChangedArmorEvent
    +
    getNewArmor() - Method in class redempt.redlib.enchants.events.PlayerChangedArmorEvent
     
    -
    getNewItem() - Method in class redempt.redlib.enchants.events.PlayerChangedHeldItemEvent
    +
    getNewItem() - Method in class redempt.redlib.enchants.events.PlayerChangedHeldItemEvent
     
    -
    getNMSClass(String) - Static method in class redempt.redlib.nms.NMSHelper
    +
    getNMSClass(String) - Static method in class redempt.redlib.nms.NMSHelper
    Gets an NMS class (a class whose package is net.minecraft.server followed by the version package) by name.
    -
    getNMSPackage() - Static method in class redempt.redlib.nms.NMSHelper
    +
    getNMSPackage() - Static method in class redempt.redlib.nms.NMSHelper
    Gets the full name of the NMS package
    -
    getNMSVersion() - Static method in class redempt.redlib.nms.NMSHelper
    +
    getNMSVersion() - Static method in class redempt.redlib.nms.NMSHelper
     
    -
    getObject() - Method in class redempt.redlib.nms.NMSObject
    +
    getObject() - Method in class redempt.redlib.nms.NMSObject
     
    -
    getOfflinePlayer(String) - Static method in class redempt.redlib.misc.UserCache
    +
    getOfflinePlayer(String) - Static method in class redempt.redlib.misc.UserCache
    Gets an OfflinePlayer by name
    -
    getOpenSlots() - Method in class redempt.redlib.inventorygui.InventoryGUI
    +
    getOpenSlots() - Method in class redempt.redlib.inventorygui.InventoryGUI
    Gets the open slots
    -
    getParent() - Method in class redempt.redlib.blockdata.events.DataBlockDestroyEvent
    +
    getParent() - Method in class redempt.redlib.blockdata.events.DataBlockDestroyEvent
     
    -
    getParent() - Method in class redempt.redlib.commandmanager.ArgType
    +
    getParent() - Method in class redempt.redlib.commandmanager.ArgType
     
    -
    getParent() - Method in class redempt.redlib.dev.profiler.SampleSummary.SampleMethod
    +
    getParent() - Method in class redempt.redlib.dev.profiler.SampleSummary.SampleMethod
     
    -
    getParent() - Method in class redempt.redlib.json.JSONList
    +
    getParent() - Method in class redempt.redlib.json.JSONList
     
    -
    getParent() - Method in class redempt.redlib.json.JSONMap
    +
    getParent() - Method in class redempt.redlib.json.JSONMap
     
    -
    getPath(UUID) - Method in class redempt.redlib.region.SelectionTool
    +
    getPath(UUID) - Method in class redempt.redlib.region.SelectionTool
    Creates a path of Locations, one block apart, based on the locations selected by the player
    -
    getPath(Location) - Static method in class redempt.redlib.misc.Path
    +
    getPath(Location) - Static method in class redempt.redlib.misc.Path
    Get the locations from the start along a vector
    -
    getPath(Location, double) - Static method in class redempt.redlib.misc.Path
    +
    getPath(Location, double) - Static method in class redempt.redlib.misc.Path
    Get the locations from the start along a vector
    -
    getPath(Location, Location) - Static method in class redempt.redlib.misc.Path
    +
    getPath(Location, Location) - Static method in class redempt.redlib.misc.Path
    Get the locations between the start and end location
    -
    getPath(Location, Location, double) - Static method in class redempt.redlib.misc.Path
    +
    getPath(Location, Location, double) - Static method in class redempt.redlib.misc.Path
    Get the locations between the start and end location
    -
    getPath(Location, Vector) - Static method in class redempt.redlib.misc.Path
    +
    getPath(Location, Vector) - Static method in class redempt.redlib.misc.Path
    Get the locations from the start along a vector
    -
    getPath(Location, Vector, double) - Static method in class redempt.redlib.misc.Path
    +
    getPath(Location, Vector, double) - Static method in class redempt.redlib.misc.Path
    Get the locations from the start along a vector
    -
    getPath(Location, Vector, double, double) - Static method in class redempt.redlib.misc.Path
    +
    getPath(Location, Vector, double, double) - Static method in class redempt.redlib.misc.Path
    Get the locations from the start along a vector
    -
    getPercentages() - Method in class redempt.redlib.misc.WeightedRandom
    +
    getPercentages() - Method in class redempt.redlib.misc.WeightedRandom
    Gets the chance each outcome has to occur in percentage (0-100)
    -
    getPermission() - Method in class redempt.redlib.commandmanager.Command
    +
    getPermission() - Method in class redempt.redlib.commandmanager.Command
     
    -
    getPlayer() - Method in class redempt.redlib.blockdata.events.CustomBlockPlaceEvent
    +
    getPlayer() - Method in class redempt.redlib.blockdata.events.CustomBlockPlaceEvent
     
    -
    getPlayer() - Method in class redempt.redlib.blockdata.events.DataBlockDestroyEvent
    +
    getPlayer() - Method in class redempt.redlib.blockdata.events.DataBlockDestroyEvent
     
    -
    getPlayer() - Method in class redempt.redlib.region.events.RegionEnterEvent
    +
    getPlayer() - Method in class redempt.redlib.region.events.RegionEnterEvent
     
    -
    getPlayer() - Method in class redempt.redlib.region.events.RegionExitEvent
    +
    getPlayer() - Method in class redempt.redlib.region.events.RegionExitEvent
     
    -
    getPlayers() - Method in class redempt.redlib.region.Region
    +
    getPlayers() - Method in class redempt.redlib.region.Region
    Gets all players contained in this Region
    -
    getPlugin() - Method in class redempt.redlib.commandmanager.Messages
    +
    getPlugin() - Method in class redempt.redlib.commandmanager.Messages
     
    -
    getPlugin() - Method in class redempt.redlib.enchants.EnchantRegistry
    +
    getPlugin() - Method in class redempt.redlib.enchants.EnchantRegistry
     
    -
    getPlugin() - Method in class redempt.redlib.misc.Task
    +
    getPlugin() - Method in class redempt.redlib.misc.Task
     
    -
    getPolicy() - Method in class redempt.redlib.protection.ProtectedRegion
    +
    getPolicy() - Method in class redempt.redlib.protection.ProtectedRegion
     
    -
    getPrevalence() - Method in class redempt.redlib.dev.profiler.SampleSummary.SampleMethod
    +
    getPrevalence() - Method in class redempt.redlib.dev.profiler.SampleSummary.SampleMethod
     
    -
    getPreviousArmor() - Method in class redempt.redlib.enchants.events.PlayerChangedArmorEvent
    +
    getPreviousArmor() - Method in class redempt.redlib.enchants.events.PlayerChangedArmorEvent
     
    -
    getPreviousItem() - Method in class redempt.redlib.enchants.events.PlayerChangedHeldItemEvent
    +
    getPreviousItem() - Method in class redempt.redlib.enchants.events.PlayerChangedHeldItemEvent
     
    -
    getPrimaryKeyNames() - Method in class redempt.redlib.sql.SQLCache
    +
    getPrimaryKeyNames() - Method in class redempt.redlib.sql.SQLCache
     
    -
    getPriority() - Method in class redempt.redlib.enchants.trigger.EnchantTrigger
    +
    getPriority() - Method in class redempt.redlib.enchants.trigger.EnchantTrigger
     
    -
    getProfiler() - Static method in class redempt.redlib.dev.profiler.ProfilerCommands
    +
    getProfiler() - Static method in class redempt.redlib.dev.profiler.ProfilerCommands
     
    -
    getRegion() - Method in class redempt.redlib.multiblock.Structure
    +
    getRegion() - Method in class redempt.redlib.multiblock.Structure
    Gets the region this Structure occupies
    -
    getRegion() - Method in class redempt.redlib.protection.ProtectedRegion
    +
    getRegion() - Method in class redempt.redlib.protection.ProtectedRegion
     
    -
    getRegion() - Method in class redempt.redlib.region.events.RegionEnterEvent
    +
    getRegion() - Method in class redempt.redlib.region.events.RegionEnterEvent
     
    -
    getRegion() - Method in class redempt.redlib.region.events.RegionExitEvent
    +
    getRegion() - Method in class redempt.redlib.region.events.RegionExitEvent
     
    -
    getRegion(UUID) - Method in class redempt.redlib.region.SelectionTool
    +
    getRegion(UUID) - Method in class redempt.redlib.region.SelectionTool
    Creates and returns a Region based on the locations selected by the player
    -
    getRegion(Location) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    +
    getRegion(Location) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    Gets the Region this multi-block structure would occupy, were it built here
    -
    getRegion(Location, int) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    +
    getRegion(Location, int) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    Gets the Region this multi-block structure would occupy, were it built here
    -
    getRegion(Location, int, boolean) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    +
    getRegion(Location, int, boolean) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    Gets the Region this multi-block structure would occupy, were it built here
    -
    getRegion(Location, int, int, int, int, boolean) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    +
    getRegion(Location, int, int, int, int, boolean) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    Gets the Region this multi-block structure would occupy, were it built here
    -
    getRegionCount() - Method in class redempt.redlib.region.MultiRegion
    +
    getRegionCount() - Method in class redempt.redlib.region.MultiRegion
    Recursively gets the number of Regions in this MultiRegion
    -
    getRegionMap() - Static method in class redempt.redlib.region.RegionEnterExitListener
    +
    getRegionMap() - Static method in class redempt.redlib.region.RegionEnterExitListener
     
    -
    getRegions() - Method in class redempt.redlib.region.MultiRegion
    +
    getRegions() - Method in class redempt.redlib.region.MultiRegion
    Gets all the cuboid Regions that form this MultiRegion
    -
    getRegistry() - Method in class redempt.redlib.enchants.CustomEnchant
    +
    getRegistry() - Method in class redempt.redlib.enchants.CustomEnchant
     
    -
    getRelative(int, int, int) - Method in class redempt.redlib.multiblock.Structure
    +
    getRelative(int, int, int) - Method in class redempt.redlib.multiblock.Structure
    Gets a relative block in this Structure
    -
    getRelativeCoordinates() - Method in class redempt.redlib.multiblock.Structure.StructureBlock
    +
    getRelativeCoordinates() - Method in class redempt.redlib.multiblock.Structure.StructureBlock
    Gets the relative coordinates of this block in the Structure.
    -
    getRelativeX() - Method in class redempt.redlib.multiblock.Structure.StructureBlock
    +
    getRelativeX() - Method in class redempt.redlib.multiblock.Structure.StructureBlock
    Gets the relative X of this block
    -
    getRelativeY() - Method in class redempt.redlib.multiblock.Structure.StructureBlock
    +
    getRelativeY() - Method in class redempt.redlib.multiblock.Structure.StructureBlock
    Gets the relative Y of this block
    -
    getRelativeZ() - Method in class redempt.redlib.multiblock.Structure.StructureBlock
    +
    getRelativeZ() - Method in class redempt.redlib.multiblock.Structure.StructureBlock
    Gets the relative Z of this block
    -
    getReports() - Static method in class redempt.redlib.dev.profiler.TickMonitorProfiler
    +
    getReports() - Static method in class redempt.redlib.dev.profiler.TickMonitorProfiler
     
    -
    getRoot() - Method in class redempt.redlib.dev.profiler.SampleSummary
    +
    getRoot() - Method in class redempt.redlib.dev.profiler.SampleSummary
     
    -
    getRotated(Rotator) - Method in class redempt.redlib.multiblock.StructureData
    +
    getRotated(Rotator) - Method in class redempt.redlib.multiblock.StructureData
     
    -
    getRotatedBlockX() - Method in class redempt.redlib.multiblock.Rotator
    +
    getRotatedBlockX() - Method in class redempt.redlib.multiblock.Rotator
     
    -
    getRotatedBlockZ() - Method in class redempt.redlib.multiblock.Rotator
    +
    getRotatedBlockZ() - Method in class redempt.redlib.multiblock.Rotator
     
    -
    getRotatedX() - Method in class redempt.redlib.multiblock.Rotator
    +
    getRotatedX() - Method in class redempt.redlib.multiblock.Rotator
     
    -
    getRotatedZ() - Method in class redempt.redlib.multiblock.Rotator
    +
    getRotatedZ() - Method in class redempt.redlib.multiblock.Rotator
     
    -
    getRotation() - Method in class redempt.redlib.multiblock.Rotator
    +
    getRotation() - Method in class redempt.redlib.multiblock.Rotator
    Gets the rotation, in number of 90-degree clockwise rotations
    -
    getRotator() - Method in class redempt.redlib.multiblock.Structure
    +
    getRotator() - Method in class redempt.redlib.multiblock.Structure
    Gets the rotation of this structure.
    -
    getRunningSummary() - Method in class redempt.redlib.dev.profiler.PassiveProfiler
    +
    getRunningSummary() - Method in class redempt.redlib.dev.profiler.PassiveProfiler
     
    -
    getScale() - Method in class redempt.redlib.region.RegionMap
    +
    getScale() - Method in class redempt.redlib.region.RegionMap
     
    -
    getScale() - Method in class redempt.redlib.worldgen.NoiseGenerator
    +
    getScale() - Method in class redempt.redlib.worldgen.NoiseGenerator
     
    -
    getServerVersion() - Static method in class redempt.redlib.RedLib
    +
    getServerVersion() - Static method in class redempt.redlib.RedLib
     
    -
    getShortName() - Method in class redempt.redlib.dev.profiler.SampleSummary.SampleMethod
    +
    getShortName() - Method in class redempt.redlib.dev.profiler.SampleSummary.SampleMethod
     
    -
    getSlot() - Method in class redempt.redlib.inventorygui.ItemButton
    +
    getSlot() - Method in class redempt.redlib.inventorygui.ItemButton
     
    -
    getStands() - Method in class redempt.redlib.misc.Hologram
    +
    getStands() - Method in class redempt.redlib.misc.Hologram
     
    -
    getStart() - Method in class redempt.redlib.dev.profiler.SampleSummary
    +
    getStart() - Method in class redempt.redlib.dev.profiler.SampleSummary
     
    -
    getStart() - Method in class redempt.redlib.region.CuboidRegion
    +
    getStart() - Method in class redempt.redlib.region.CuboidRegion
    Get the minimum corner of this Region
    -
    getStart() - Method in class redempt.redlib.region.MultiRegion
    +
    getStart() - Method in class redempt.redlib.region.MultiRegion
     
    -
    getStart() - Method in class redempt.redlib.region.Region
    +
    getStart() - Method in class redempt.redlib.region.Region
     
    -
    getStart() - Method in class redempt.redlib.region.SpheroidRegion
    +
    getStart() - Method in class redempt.redlib.region.SpheroidRegion
     
    -
    getStat(ItemStack, String) - Method in class redempt.redlib.itemutils.LoreStats
    +
    getStat(ItemStack, String) - Method in class redempt.redlib.itemutils.LoreStats
    Gets a stat in String form from the lore of an item
    -
    getState() - Method in class redempt.redlib.inventorygui.InventoryGUI
    +
    getState() - Method in class redempt.redlib.inventorygui.InventoryGUI
    Gets the state of the GUI, which can be restored later
    -
    getState() - Method in class redempt.redlib.region.CuboidRegion
    +
    getState() - Method in class redempt.redlib.region.CuboidRegion
    Gets the current state of this Region
    -
    getState(Block) - Method in class redempt.redlib.multiblock.StructureData
    +
    getState(Block) - Method in class redempt.redlib.multiblock.StructureData
    Gets the BlockState to set for a given block
    -
    getStaticField(String) - Method in class redempt.redlib.nms.NMSClass
    +
    getStaticField(String) - Method in class redempt.redlib.nms.NMSClass
    Gets the value of a static field in the wrapped class
    -
    getStrictModeExclusions() - Method in class redempt.redlib.multiblock.MultiBlockStructure
    +
    getStrictModeExclusions() - Method in class redempt.redlib.multiblock.MultiBlockStructure
     
    -
    getString(int) - Method in class redempt.redlib.json.JSONList
    +
    getString(int) - Method in class redempt.redlib.json.JSONList
     
    -
    getString(int) - Method in class redempt.redlib.sql.SQLHelper.Results
    +
    getString(int) - Method in class redempt.redlib.sql.SQLHelper.Results
    Gets a String in the given column in the current row
    -
    getString(String) - Method in class redempt.redlib.blockdata.DataBlock
    +
    getString(String) - Method in class redempt.redlib.blockdata.DataBlock
    Gets a String mapped to a certain key
    -
    getString(String) - Method in class redempt.redlib.json.JSONMap
    +
    getString(String) - Method in class redempt.redlib.json.JSONMap
     
    -
    getStructure() - Method in class redempt.redlib.multiblock.Structure.StructureBlock
    +
    getStructure() - Method in class redempt.redlib.multiblock.Structure.StructureBlock
    Gets the Structure this block is part of
    -
    getStructureData() - Method in class redempt.redlib.multiblock.Structure.StructureBlock
    +
    getStructureData() - Method in class redempt.redlib.multiblock.Structure.StructureBlock
     
    -
    getStructureData(int, int, int) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    +
    getStructureData(int, int, int) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    Gets the StructureData at a certain relative position
    -
    getStructureType() - Method in class redempt.redlib.multiblock.Structure.StructureBlock
    +
    getStructureType() - Method in class redempt.redlib.multiblock.Structure.StructureBlock
     
    -
    getSummary() - Method in class redempt.redlib.dev.profiler.BurstProfiler
    +
    getSummary() - Method in class redempt.redlib.dev.profiler.BurstProfiler
    Gets a summary of the last X milliseconds of profiling, with X being the size this BurstProfiler was initialized with
    -
    getSummary() - Method in class redempt.redlib.dev.profiler.PassiveProfiler
    +
    getSummary() - Method in class redempt.redlib.dev.profiler.PassiveProfiler
     
    -
    getSummary() - Method in class redempt.redlib.dev.profiler.Profiler
    +
    getSummary() - Method in class redempt.redlib.dev.profiler.Profiler
     
    -
    getSummary(long) - Method in class redempt.redlib.dev.profiler.BurstProfiler
    +
    getSummary(long) - Method in class redempt.redlib.dev.profiler.BurstProfiler
    Gets a summary of the profiling after the specified time.
    -
    getSuperclass() - Method in class redempt.redlib.nms.NMSClass
    +
    getSuperclass() - Method in class redempt.redlib.nms.NMSClass
     
    -
    getSurface() - Method in class redempt.redlib.region.SpheroidRegion
    +
    getSurface() - Method in class redempt.redlib.region.SpheroidRegion
     
    -
    getSurfacePoint(Vector) - Method in class redempt.redlib.region.SpheroidRegion
    +
    getSurfacePoint(Vector) - Method in class redempt.redlib.region.SpheroidRegion
    Gets a point on the surface of this SpheroidRegion in the given direction
    -
    getTableName() - Method in class redempt.redlib.sql.SQLCache
    +
    getTableName() - Method in class redempt.redlib.sql.SQLCache
     
    -
    getTemperature() - Method in class redempt.redlib.worldgen.CustomBiome
    +
    getTemperature() - Method in class redempt.redlib.worldgen.CustomBiome
    -
    Deprecated.
    +
    Deprecated.
     
    -
    getTempKey() - Method in class redempt.redlib.json.JSONList
    +
    getTempKey() - Method in class redempt.redlib.json.JSONList
     
    -
    getTempKey() - Method in class redempt.redlib.json.JSONMap
    +
    getTempKey() - Method in class redempt.redlib.json.JSONMap
     
    -
    getTo() - Method in class redempt.redlib.blockdata.events.DataBlockMoveEvent
    +
    getTo() - Method in class redempt.redlib.blockdata.events.DataBlockMoveEvent
     
    -
    getTool() - Static method in class redempt.redlib.dev.StructureTool
    +
    getTool() - Static method in class redempt.redlib.dev.StructureTool
     
    -
    getTransientProperty(String) - Method in class redempt.redlib.blockdata.DataBlock
    +
    getTransientProperty(String) - Method in class redempt.redlib.blockdata.DataBlock
    Gets a transient property associated with the given key
    -
    getTriggers() - Method in class redempt.redlib.enchants.CustomEnchant
    +
    getTriggers() - Method in class redempt.redlib.enchants.CustomEnchant
     
    -
    getType() - Method in class redempt.redlib.blockdata.CustomBlock
    +
    getType() - Method in class redempt.redlib.blockdata.CustomBlock
     
    -
    getType() - Method in class redempt.redlib.misc.Task
    +
    getType() - Method in class redempt.redlib.misc.Task
     
    -
    getType() - Method in class redempt.redlib.multiblock.Structure
    +
    getType() - Method in class redempt.redlib.multiblock.Structure
    Gets the type of this structure
    -
    getType() - Method in class redempt.redlib.multiblock.StructureData
    +
    getType() - Method in class redempt.redlib.multiblock.StructureData
     
    -
    getType() - Method in class redempt.redlib.nms.NMSObject
    +
    getType() - Method in class redempt.redlib.nms.NMSObject
     
    -
    getType(int, int, int) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    +
    getType(int, int, int) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    Gets the Material at a certain relative position
    -
    getType(String, ArgType<?>[]) - Static method in class redempt.redlib.commandmanager.Command
    +
    getType(String, ArgType<?>[]) - Static method in class redempt.redlib.commandmanager.Command
     
    -
    getTypeName() - Method in class redempt.redlib.nms.NMSObject
    +
    getTypeName() - Method in class redempt.redlib.nms.NMSObject
     
    -
    getTypes() - Method in class redempt.redlib.blockdata.CustomBlockRegistry
    +
    getTypes() - Method in class redempt.redlib.blockdata.CustomBlockRegistry
     
    -
    getVanillaBiome() - Method in class redempt.redlib.worldgen.CustomBiome
    +
    getVanillaBiome() - Method in class redempt.redlib.worldgen.CustomBiome
    -
    Deprecated.
    +
    Deprecated.
     
    -
    getVolume() - Method in class redempt.redlib.multiblock.MultiBlockStructure
    +
    getVolume() - Method in class redempt.redlib.multiblock.MultiBlockStructure
     
    -
    getVolume() - Method in class redempt.redlib.region.CuboidRegion
    +
    getVolume() - Method in class redempt.redlib.region.CuboidRegion
     
    -
    getVolume() - Method in class redempt.redlib.region.MultiRegion
    +
    getVolume() - Method in class redempt.redlib.region.MultiRegion
    Sums the volume of all the Regions that make up this MultiRegion.
    -
    getVolume() - Method in class redempt.redlib.region.Region
    +
    getVolume() - Method in class redempt.redlib.region.Region
     
    -
    getVolume() - Method in class redempt.redlib.region.SpheroidRegion
    +
    getVolume() - Method in class redempt.redlib.region.SpheroidRegion
     
    -
    getWeight() - Method in class redempt.redlib.worldgen.NoiseGenerator
    +
    getWeight() - Method in class redempt.redlib.worldgen.NoiseGenerator
     
    -
    getWeights() - Method in class redempt.redlib.misc.WeightedRandom
    +
    getWeights() - Method in class redempt.redlib.misc.WeightedRandom
    Gets the map of weights for this WeightedRandom
    -
    getWorld() - Method in class redempt.redlib.blockdata.DataBlock
    +
    getWorld() - Method in class redempt.redlib.blockdata.DataBlock
     
    -
    getWorld() - Method in class redempt.redlib.region.CuboidRegion
    +
    getWorld() - Method in class redempt.redlib.region.CuboidRegion
     
    -
    getWorld() - Method in class redempt.redlib.region.Region
    +
    getWorld() - Method in class redempt.redlib.region.Region
     
    -
    getWorld() - Method in class redempt.redlib.region.SpheroidRegion
    +
    getWorld() - Method in class redempt.redlib.region.SpheroidRegion
     
    -
    getWrappedClass() - Method in class redempt.redlib.nms.NMSClass
    +
    getWrappedClass() - Method in class redempt.redlib.nms.NMSClass
     
    -
    getXRadius() - Method in class redempt.redlib.region.SpheroidRegion
    +
    getXRadius() - Method in class redempt.redlib.region.SpheroidRegion
     
    -
    getYRadius() - Method in class redempt.redlib.region.SpheroidRegion
    +
    getYRadius() - Method in class redempt.redlib.region.SpheroidRegion
     
    -
    getZRadius() - Method in class redempt.redlib.region.SpheroidRegion
    +
    getZRadius() - Method in class redempt.redlib.region.SpheroidRegion
     
    -
    give(Player, ItemStack...) - Static method in class redempt.redlib.itemutils.ItemUtils
    +
    give(Player, ItemStack...) - Static method in class redempt.redlib.itemutils.ItemUtils
    Give the player the specified items, dropping them on the ground if there is not enough room
    -
    give(Player, ItemStack, int) - Static method in class redempt.redlib.itemutils.ItemUtils
    +
    give(Player, ItemStack, int) - Static method in class redempt.redlib.itemutils.ItemUtils
    Gives the player the specified amount of the specified item, dropping them on the ground if there is not enough room
    -
    give(Player, Material, int) - Static method in class redempt.redlib.itemutils.ItemUtils
    +
    give(Player, Material, int) - Static method in class redempt.redlib.itemutils.ItemUtils
    Gives the player the specified amount of the specified item type, dropping them on the ground if there is not enough room
    -
    giveWand(Player) - Method in class redempt.redlib.dev.StructureTool
    +
    giveWand(Player) - Method in class redempt.redlib.dev.StructureTool
     
    -
    globalPolicies - Static variable in class redempt.redlib.protection.ProtectionPolicy
    +
    globalPolicies - Static variable in class redempt.redlib.protection.ProtectionPolicy
     
    -
    GROWTH - redempt.redlib.protection.ProtectionPolicy.ProtectionType
    +
    GROWTH - redempt.redlib.protection.ProtectionPolicy.ProtectionType
    Crop growth and block spreading/formation
    - - - -

    H

    -
    -
    handleEvent(T) - Method in class redempt.redlib.misc.EventListener
    +

    H

    +
    +
    handleEvent(T) - Method in class redempt.redlib.misc.EventListener
     
    -
    hashCode() - Method in class redempt.redlib.blockdata.DataBlock
    +
    hashCode() - Method in class redempt.redlib.blockdata.DataBlock
     
    -
    hashCode() - Method in class redempt.redlib.multiblock.MultiBlockStructure
    +
    hashCode() - Method in class redempt.redlib.multiblock.MultiBlockStructure
     
    -
    help - Variable in class redempt.redlib.commandmanager.Command
    +
    help - Variable in class redempt.redlib.commandmanager.Command
     
    -
    HOLD_ITEM - Static variable in class redempt.redlib.enchants.trigger.EnchantTrigger
    +
    HOLD_ITEM - Static variable in class redempt.redlib.enchants.trigger.EnchantTrigger
    Calls activate with a PlayerChangedHeldItemEvent when a player begins holding an item that has a CustomEnchant with this trigger Also calls activate when a player joins holding an item with this trigger Calls deactivate with a PlayerChangedHeldItemEvent when a player stops holding an item that has a CustomEnchant with this trigger Also calls deactivate when a player leaves holding an item with this trigger
    -
    Hologram - Class in redempt.redlib.misc
    +
    Hologram - Class in redempt.redlib.misc
    Represents a number of floating armor stands intended to display information
    -
    hook - Variable in class redempt.redlib.commandmanager.Command
    +
    hook - Variable in class redempt.redlib.commandmanager.Command
     
    - - - -

    I

    -
    -
    ignoreAir - Variable in class redempt.redlib.multiblock.MultiBlockStructure
    +

    I

    +
    +
    ignoreAir - Variable in class redempt.redlib.multiblock.MultiBlockStructure
     
    -
    ignoresAir() - Method in class redempt.redlib.multiblock.MultiBlockStructure
    +
    ignoresAir() - Method in class redempt.redlib.multiblock.MultiBlockStructure
     
    -
    increment() - Method in class redempt.redlib.dev.profiler.SampleSummary.SampleMethod
    +
    increment() - Method in class redempt.redlib.dev.profiler.SampleSummary.SampleMethod
     
    -
    INDIRECT_PLAYERS - Static variable in enum redempt.redlib.protection.ProtectionPolicy.ProtectionType
    +
    INDIRECT_PLAYERS - Static variable in enum redempt.redlib.protection.ProtectionPolicy.ProtectionType
    All protection types relating to actions usually taken by players which indirectly affect blocks - Pistons, redstone, explosions, and falling blocks
    -
    init() - Method in class redempt.redlib.enchants.trigger.EnchantTrigger
    +
    init() - Method in class redempt.redlib.enchants.trigger.EnchantTrigger
     
    -
    init() - Static method in class redempt.redlib.misc.UserCache
    +
    init() - Static method in class redempt.redlib.misc.UserCache
    Initializes the user cache synchronously
    -
    init(ConfigManager) - Method in interface redempt.redlib.configmanager.ConfigStorage
    +
    init(ConfigManager) - Method in interface redempt.redlib.configmanager.ConfigStorage
     
    -
    initialize(Block) - Method in class redempt.redlib.blockdata.CustomBlockType
    +
    initialize(Block) - Method in class redempt.redlib.blockdata.CustomBlockType
    Initializes the placement of this CustomBlockType for the given Block.
    -
    insert(int, String) - Method in class redempt.redlib.misc.Hologram
    +
    insert(int, String) - Method in class redempt.redlib.misc.Hologram
    Inserts a line in this Hologram
    -
    INTERACT - redempt.redlib.protection.ProtectionPolicy.ProtectionType
    +
    INTERACT - redempt.redlib.protection.ProtectionPolicy.ProtectionType
    Players interacting with non-container blocks
    -
    InventoryGUI - Class in redempt.redlib.inventorygui
    +
    InventoryGUI - Class in redempt.redlib.inventorygui
     
    -
    InventoryGUI(int, String) - Constructor for class redempt.redlib.inventorygui.InventoryGUI
    +
    InventoryGUI(int, String) - Constructor for class redempt.redlib.inventorygui.InventoryGUI
    Creates a new GUI, instantiating a new inventory with the given size and name
    -
    InventoryGUI(Inventory) - Constructor for class redempt.redlib.inventorygui.InventoryGUI
    +
    InventoryGUI(Inventory) - Constructor for class redempt.redlib.inventorygui.InventoryGUI
    Creates a new GUI from an inventory
    -
    InventoryGUI.GUIState - Class in redempt.redlib.inventorygui
    +
    InventoryGUI.GUIState - Class in redempt.redlib.inventorygui
     
    -
    isAir() - Method in class redempt.redlib.multiblock.StructureData
    +
    isAir() - Method in class redempt.redlib.multiblock.StructureData
     
    -
    isAutoCommit() - Method in class redempt.redlib.sql.SQLHelper
    +
    isAutoCommit() - Method in class redempt.redlib.sql.SQLHelper
     
    -
    isCached(Object...) - Method in class redempt.redlib.sql.SQLCache
    +
    isCached(Object...) - Method in class redempt.redlib.sql.SQLCache
    Checks whether a value has been cached by its primary keys
    -
    isCancelled() - Method in class redempt.redlib.blockdata.events.CustomBlockPlaceEvent
    +
    isCancelled() - Method in class redempt.redlib.blockdata.events.CustomBlockPlaceEvent
     
    -
    isCancelled() - Method in class redempt.redlib.blockdata.events.DataBlockDestroyEvent
    +
    isCancelled() - Method in class redempt.redlib.blockdata.events.DataBlockDestroyEvent
     
    -
    isCancelled() - Method in class redempt.redlib.blockdata.events.DataBlockMoveEvent
    +
    isCancelled() - Method in class redempt.redlib.blockdata.events.DataBlockMoveEvent
    Gets the cancellation state of this event.
    -
    isCancelled() - Method in class redempt.redlib.region.events.RegionEnterEvent
    +
    isCancelled() - Method in class redempt.redlib.region.events.RegionEnterEvent
     
    -
    isCancelled() - Method in class redempt.redlib.region.events.RegionExitEvent
    +
    isCancelled() - Method in class redempt.redlib.region.events.RegionExitEvent
     
    -
    isChunkLoaded(Chunk) - Method in class redempt.redlib.blockdata.BlockDataManager
    +
    isChunkLoaded(Chunk) - Method in class redempt.redlib.blockdata.BlockDataManager
     
    -
    isChunkLoaded(World, int, int) - Method in class redempt.redlib.blockdata.BlockDataManager
    +
    isChunkLoaded(World, int, int) - Method in class redempt.redlib.blockdata.BlockDataManager
     
    -
    isClustered() - Method in class redempt.redlib.region.MultiRegion
    +
    isClustered() - Method in class redempt.redlib.region.MultiRegion
     
    -
    isCompatible(CustomEnchant) - Method in class redempt.redlib.enchants.CustomEnchant
    +
    isCompatible(CustomEnchant) - Method in class redempt.redlib.enchants.CustomEnchant
    Checks if this CustomEnchant is compatible with another CustomEnchant
    -
    isCurrentlyRunning() - Method in class redempt.redlib.misc.Task
    +
    isCurrentlyRunning() - Method in class redempt.redlib.misc.Task
     
    -
    isEmpty() - Method in class redempt.redlib.sql.SQLHelper.Results
    +
    isEmpty() - Method in class redempt.redlib.sql.SQLHelper.Results
     
    -
    isHazard(Material) - Static method in class redempt.redlib.misc.LocationUtils
    +
    isHazard(Material) - Static method in class redempt.redlib.misc.LocationUtils
    Checks if a given block type is a hazard - whether it would damage the player if they were on top of it
    -
    isIntact() - Method in class redempt.redlib.multiblock.Structure
    +
    isIntact() - Method in class redempt.redlib.multiblock.Structure
    Checks whether this Structure is intact (in the same rotation and has all the correct blocks)
    -
    isLoaded() - Method in class redempt.redlib.blockdata.DataBlock
    +
    isLoaded() - Method in class redempt.redlib.blockdata.DataBlock
     
    -
    isMirrored() - Method in class redempt.redlib.multiblock.Rotator
    +
    isMirrored() - Method in class redempt.redlib.multiblock.Rotator
    Gets whether this rotator mirrors over the X axis
    -
    isMulti() - Method in class redempt.redlib.region.CuboidRegion
    +
    isMulti() - Method in class redempt.redlib.region.CuboidRegion
     
    -
    isNull() - Method in class redempt.redlib.nms.NMSObject
    +
    isNull() - Method in class redempt.redlib.nms.NMSObject
     
    -
    isParallelCapable() - Method in class redempt.redlib.worldgen.CustomWorldGenerator
    +
    isParallelCapable() - Method in class redempt.redlib.worldgen.CustomWorldGenerator
    -
    Deprecated.
    +
    Deprecated.
     
    -
    isPostArg() - Method in class redempt.redlib.commandmanager.Command
    +
    isPostArg() - Method in class redempt.redlib.commandmanager.Command
     
    -
    isQueued() - Method in class redempt.redlib.misc.Task
    +
    isQueued() - Method in class redempt.redlib.misc.Task
     
    -
    isRegistered() - Method in class redempt.redlib.enchants.CustomEnchant
    +
    isRegistered() - Method in class redempt.redlib.enchants.CustomEnchant
     
    -
    isSafe(Location) - Static method in class redempt.redlib.misc.LocationUtils
    +
    isSafe(Location) - Static method in class redempt.redlib.misc.LocationUtils
    Checks whether the given location is safe to teleport a player to - that a player would not be damaged as a result of being moved to this location
    -
    isSphere() - Method in class redempt.redlib.region.SpheroidRegion
    +
    isSphere() - Method in class redempt.redlib.region.SpheroidRegion
     
    -
    isStrictMode() - Method in class redempt.redlib.multiblock.MultiBlockStructure
    +
    isStrictMode() - Method in class redempt.redlib.multiblock.MultiBlockStructure
     
    -
    item - Variable in class redempt.redlib.inventorygui.ItemButton
    +
    item - Variable in class redempt.redlib.inventorygui.ItemButton
     
    -
    ItemBuilder - Class in redempt.redlib.itemutils
    +
    ItemBuilder - Class in redempt.redlib.itemutils
    A utility class to easily create items
    -
    ItemBuilder(ItemStack) - Constructor for class redempt.redlib.itemutils.ItemBuilder
    +
    ItemBuilder(ItemStack) - Constructor for class redempt.redlib.itemutils.ItemBuilder
    Constructs an ItemBuilder using a pre-existing item
    -
    ItemBuilder(Material) - Constructor for class redempt.redlib.itemutils.ItemBuilder
    +
    ItemBuilder(Material) - Constructor for class redempt.redlib.itemutils.ItemBuilder
    Constructs a new ItemBuilder.
    -
    ItemBuilder(Material, int) - Constructor for class redempt.redlib.itemutils.ItemBuilder
    +
    ItemBuilder(Material, int) - Constructor for class redempt.redlib.itemutils.ItemBuilder
    Constructs a new ItemBuilder.
    -
    ItemButton - Class in redempt.redlib.inventorygui
    +
    ItemButton - Class in redempt.redlib.inventorygui
     
    -
    ItemButton(ItemStack) - Constructor for class redempt.redlib.inventorygui.ItemButton
    +
    ItemButton(ItemStack) - Constructor for class redempt.redlib.inventorygui.ItemButton
    Create a new ItemButton with the given ItemStack as the icon
    -
    itemMatches(ItemStack) - Method in class redempt.redlib.blockdata.CustomBlockType
    +
    itemMatches(ItemStack) - Method in class redempt.redlib.blockdata.CustomBlockType
    Checks whether the item given matches the item for this CustomBlockType
    -
    ItemTrait - Enum in redempt.redlib.itemutils
    +
    ItemTrait - Enum in redempt.redlib.itemutils
    A set of comparable traits items have and can be compared with ItemUtils.compare(ItemStack, ItemStack, ItemTrait...)
    -
    ItemUtils - Class in redempt.redlib.itemutils
    +
    ItemUtils - Class in redempt.redlib.itemutils
    A utility class to easily modify items
    -
    ItemUtils() - Constructor for class redempt.redlib.itemutils.ItemUtils
    +
    ItemUtils() - Constructor for class redempt.redlib.itemutils.ItemUtils
     
    - - - -

    J

    -
    -
    JOIN - redempt.redlib.region.events.RegionEnterEvent.EnterCause
    +

    J

    +
    +
    JOIN - redempt.redlib.region.events.RegionEnterEvent.EnterCause
    When a player joins into a region
    -
    JSONList - Class in redempt.redlib.json
    +
    JSONList - Class in redempt.redlib.json
    Represents a list which can be serialized to JSON and deserialized back to this form, assuming all of the values it stores are serializable
    -
    JSONList() - Constructor for class redempt.redlib.json.JSONList
    +
    JSONList() - Constructor for class redempt.redlib.json.JSONList
     
    -
    JSONMap - Class in redempt.redlib.json
    +
    JSONMap - Class in redempt.redlib.json
    Represents a map which can be serialized to JSON and deserialized back to this form, assuming all of the values it stores are serializable
    -
    JSONMap() - Constructor for class redempt.redlib.json.JSONMap
    +
    JSONMap() - Constructor for class redempt.redlib.json.JSONMap
     
    -
    JSONParser - Class in redempt.redlib.json
    +
    JSONParser - Class in redempt.redlib.json
     
    -
    JSONParser() - Constructor for class redempt.redlib.json.JSONParser
    +
    JSONParser() - Constructor for class redempt.redlib.json.JSONParser
     
    - - - -

    K

    -
    -
    key - Variable in class redempt.redlib.json.JSONList
    +

    K

    +
    +
    key - Variable in class redempt.redlib.json.JSONList
     
    -
    key - Variable in class redempt.redlib.json.JSONMap
    +
    key - Variable in class redempt.redlib.json.JSONMap
     
    -
    keyNamesMatch(String[]) - Method in class redempt.redlib.sql.SQLCache
    +
    keyNamesMatch(String[]) - Method in class redempt.redlib.sql.SQLCache
     
    -
    KILL_ENTITY - Static variable in class redempt.redlib.enchants.trigger.EnchantTrigger
    +
    KILL_ENTITY - Static variable in class redempt.redlib.enchants.trigger.EnchantTrigger
    Calls activate with an EntityDeathEvent when a player kills an entity with an item that has a CustomEnchant with this trigger
    -
    KillEntityTrigger - Class in redempt.redlib.enchants.trigger
    +
    KillEntityTrigger - Class in redempt.redlib.enchants.trigger
     
    -
    KillEntityTrigger() - Constructor for class redempt.redlib.enchants.trigger.KillEntityTrigger
    +
    KillEntityTrigger() - Constructor for class redempt.redlib.enchants.trigger.KillEntityTrigger
     
    - - - -

    L

    -
    -
    lastArgTakesAll() - Method in class redempt.redlib.commandmanager.Command
    +

    L

    +
    +
    lastArgTakesAll() - Method in class redempt.redlib.commandmanager.Command
     
    -
    length() - Method in class redempt.redlib.nms.NMSArray
    +
    length() - Method in class redempt.redlib.nms.NMSArray
     
    -
    lineWrap(String, int) - Static method in class redempt.redlib.misc.FormatUtils
    +
    lineWrap(String, int) - Static method in class redempt.redlib.misc.FormatUtils
    Splits a line of text across multiple lines, attempting to limit the length of each line
    -
    LIQUID - redempt.redlib.blockdata.events.DataBlockDestroyEvent.DestroyCause
    +
    LIQUID - redempt.redlib.blockdata.events.DataBlockDestroyEvent.DestroyCause
     
    -
    list(Class<T>, ConversionType, T...) - Static method in class redempt.redlib.configmanager.ConfigManager
    +
    list(Class<T>, ConversionType, T...) - Static method in class redempt.redlib.configmanager.ConfigManager
    Creates a ConfigList from a given type with initial elements.
    -
    list(Class<T>, T...) - Static method in class redempt.redlib.configmanager.ConfigManager
    +
    list(Class<T>, T...) - Static method in class redempt.redlib.configmanager.ConfigManager
    Creates a ConfigList from a given type with initial elements.
    -
    load() - Method in class redempt.redlib.configmanager.ConfigManager
    +
    load() - Method in class redempt.redlib.configmanager.ConfigManager
    Loads all values from config into the annotated hook fields
    -
    load(Chunk) - Method in class redempt.redlib.blockdata.BlockDataManager
    +
    load(Chunk) - Method in class redempt.redlib.blockdata.BlockDataManager
    Loads all of the DataBlocks in a given chunk, or retrieves the already-loaded set of DataBlocks
    -
    load(ConfigurationSection) - Method in interface redempt.redlib.configmanager.ConfigStorage
    +
    load(ConfigurationSection) - Method in interface redempt.redlib.configmanager.ConfigStorage
     
    -
    load(Plugin) - Static method in class redempt.redlib.commandmanager.Messages
    +
    load(Plugin) - Static method in class redempt.redlib.commandmanager.Messages
    Loads messages from a file, messages.txt, and writes missing defaults loaded from the plugin resource called messages.txt
    -
    load(Plugin, InputStream) - Static method in class redempt.redlib.commandmanager.Messages
    +
    load(Plugin, InputStream) - Static method in class redempt.redlib.commandmanager.Messages
    Loads messages from a file, messages.txt, and writes missing defaults
    -
    load(Plugin, InputStream, String) - Static method in class redempt.redlib.commandmanager.Messages
    +
    load(Plugin, InputStream, String) - Static method in class redempt.redlib.commandmanager.Messages
    Loads messages from a file and writes missing defaults
    -
    load(World, int, int) - Method in class redempt.redlib.blockdata.BlockDataManager
    +
    load(World, int, int) - Method in class redempt.redlib.blockdata.BlockDataManager
    Loads all of the DataBlocks in a given chunk, or retrieves the already-loaded set of DataBlocks
    -
    LocationUtils - Class in redempt.redlib.misc
    +
    LocationUtils - Class in redempt.redlib.misc
     
    -
    LocationUtils() - Constructor for class redempt.redlib.misc.LocationUtils
    +
    LocationUtils() - Constructor for class redempt.redlib.misc.LocationUtils
     
    -
    LORE - redempt.redlib.itemutils.ItemTrait
    +
    LORE - redempt.redlib.itemutils.ItemTrait
    For comparing the lore of two items
    -
    LoreStats - Class in redempt.redlib.itemutils
    +
    LoreStats - Class in redempt.redlib.itemutils
    Represents stats or other info stored in item lore
    -
    LoreStats(List<String>, String...) - Constructor for class redempt.redlib.itemutils.LoreStats
    +
    LoreStats(List<String>, String...) - Constructor for class redempt.redlib.itemutils.LoreStats
    Create a LoreStats from a list of lore lines and a vararg of placeholder names
    - - - -

    M

    -
    -
    mainHand - Static variable in class redempt.redlib.commandmanager.ContextProvider
    +

    M

    +
    +
    mainHand - Static variable in class redempt.redlib.commandmanager.ContextProvider
    Use "mainhand" in the command file.
    -
    map(Class<K>, Class<V>) - Static method in class redempt.redlib.configmanager.ConfigManager
    +
    map(Class<K>, Class<V>) - Static method in class redempt.redlib.configmanager.ConfigManager
    Creates a ConfigMap from a given type.
    -
    map(Class<K>, Class<V>, ConversionType) - Static method in class redempt.redlib.configmanager.ConfigManager
    +
    map(Class<K>, Class<V>, ConversionType) - Static method in class redempt.redlib.configmanager.ConfigManager
    Creates a ConfigMap from a given type.
    -
    map(Class<T>) - Static method in class redempt.redlib.configmanager.ConfigManager
    +
    map(Class<T>) - Static method in class redempt.redlib.configmanager.ConfigManager
    Creates a ConfigMap from a given type.
    -
    map(Class<T>, ConversionType) - Static method in class redempt.redlib.configmanager.ConfigManager
    +
    map(Class<T>, ConversionType) - Static method in class redempt.redlib.configmanager.ConfigManager
    Creates a ConfigMap from a given type.
    -
    map(String, String, BiFunction<Player, T, K>) - Method in class redempt.redlib.commandmanager.ContextProvider
    +
    map(String, String, BiFunction<Player, T, K>) - Method in class redempt.redlib.commandmanager.ContextProvider
    Creates a new ContextProvider based on this one which converts from this type to another
    -
    map(String, String, Function<T, K>) - Method in class redempt.redlib.commandmanager.ContextProvider
    +
    map(String, String, Function<T, K>) - Method in class redempt.redlib.commandmanager.ContextProvider
    Creates a new ContextProvider based on this one which converts from this type to another
    -
    map(String, BiFunction<CommandSender, T, K>) - Method in class redempt.redlib.commandmanager.ArgType
    +
    map(String, BiFunction<CommandSender, T, K>) - Method in class redempt.redlib.commandmanager.ArgType
    Creates a new ArgType based on this one which converts from this type to another
    -
    map(String, BiFunction<Player, T, K>) - Method in class redempt.redlib.commandmanager.ContextProvider
    +
    map(String, BiFunction<Player, T, K>) - Method in class redempt.redlib.commandmanager.ContextProvider
    Creates a new ContextProvider based on this one which converts from this type to another
    -
    map(String, Function<T, K>) - Method in class redempt.redlib.commandmanager.ArgType
    +
    map(String, Function<T, K>) - Method in class redempt.redlib.commandmanager.ArgType
    Creates a new ArgType based on this one which converts from this type to another
    -
    map(String, Function<T, K>) - Method in class redempt.redlib.commandmanager.ContextProvider
    +
    map(String, Function<T, K>) - Method in class redempt.redlib.commandmanager.ContextProvider
    Creates a new ContextProvider based on this one which converts from this type to another
    -
    MAPPED_OBJECT - redempt.redlib.configmanager.ConversionType
    +
    MAPPED_OBJECT - redempt.redlib.configmanager.ConversionType
    A config value mapped from a class annotated with ConfigMappable
    -
    measure(BlockFace) - Method in class redempt.redlib.region.Region
    +
    measure(BlockFace) - Method in class redempt.redlib.region.Region
    Gets the length of this Region along a given axis
    -
    measureBlocks(BlockFace) - Method in class redempt.redlib.region.Region
    +
    measureBlocks(BlockFace) - Method in class redempt.redlib.region.Region
    Gets the block length of this Region along a given axis
    -
    Messages - Class in redempt.redlib.commandmanager
    +
    Messages - Class in redempt.redlib.commandmanager
    Represents a list of messages loaded from a file with defaults
    -
    MethodHook(Method, Object) - Constructor for class redempt.redlib.commandmanager.Command.MethodHook
    +
    MethodHook(Method, Object) - Constructor for class redempt.redlib.commandmanager.Command.MethodHook
     
    -
    MID_VERSION - Static variable in class redempt.redlib.RedLib
    +
    MID_VERSION - Static variable in class redempt.redlib.RedLib
    The middle number of the server version - for example, if the server version is 1.15.2, this will be 15
    -
    MINE_BLOCK - Static variable in class redempt.redlib.enchants.trigger.EnchantTrigger
    +
    MINE_BLOCK - Static variable in class redempt.redlib.enchants.trigger.EnchantTrigger
    Calls activate with a BlockBreakEvent when a block is broken with an item that has a CustomEnchant with this trigger
    -
    MISCELLANEOUS - redempt.redlib.protection.ProtectionPolicy.ProtectionType
    +
    MISCELLANEOUS - redempt.redlib.protection.ProtectionPolicy.ProtectionType
    Does nothing by default, but other plugins can register their events to be protected against by this type.
    -
    MOB_SPAWN - redempt.redlib.protection.ProtectionPolicy.ProtectionType
    +
    MOB_SPAWN - redempt.redlib.protection.ProtectionPolicy.ProtectionType
    Mobs spawning
    -
    move(double, double, double) - Method in class redempt.redlib.region.CuboidRegion
    +
    move(double, double, double) - Method in class redempt.redlib.region.CuboidRegion
     
    -
    move(double, double, double) - Method in class redempt.redlib.region.MultiRegion
    +
    move(double, double, double) - Method in class redempt.redlib.region.MultiRegion
     
    -
    move(double, double, double) - Method in class redempt.redlib.region.Region
    +
    move(double, double, double) - Method in class redempt.redlib.region.Region
     
    -
    move(double, double, double) - Method in class redempt.redlib.region.SpheroidRegion
    +
    move(double, double, double) - Method in class redempt.redlib.region.SpheroidRegion
    Moves this SpheroidRegion
    -
    move(Block) - Method in class redempt.redlib.blockdata.DataBlock
    +
    move(Block) - Method in class redempt.redlib.blockdata.DataBlock
    Moves the data in this DataBlock to a new Block
    -
    move(Location) - Method in class redempt.redlib.misc.Hologram
    +
    move(Location) - Method in class redempt.redlib.misc.Hologram
    Moves this Hologram
    -
    move(Vector) - Method in class redempt.redlib.region.CuboidRegion
    +
    move(Vector) - Method in class redempt.redlib.region.CuboidRegion
    Move the region
    -
    move(Vector) - Method in class redempt.redlib.region.MultiRegion
    +
    move(Vector) - Method in class redempt.redlib.region.MultiRegion
    Moves this MultiRegion using the given vector
    -
    move(Vector) - Method in class redempt.redlib.region.Region
    +
    move(Vector) - Method in class redempt.redlib.region.Region
    Moves this Region
    -
    move(Vector) - Method in class redempt.redlib.region.SpheroidRegion
    +
    move(Vector) - Method in class redempt.redlib.region.SpheroidRegion
    Moves this SpheroidRegion according to a Vector
    -
    MOVE - redempt.redlib.region.events.RegionEnterEvent.EnterCause
    +
    MOVE - redempt.redlib.region.events.RegionEnterEvent.EnterCause
    When a player moves into a region
    -
    MOVE - redempt.redlib.region.events.RegionExitEvent.ExitCause
    +
    MOVE - redempt.redlib.region.events.RegionExitEvent.ExitCause
    When a player moves out of a region
    -
    msg(String) - Static method in class redempt.redlib.commandmanager.Messages
    +
    msg(String) - Static method in class redempt.redlib.commandmanager.Messages
    Determines which plugin is calling this method, finds its loaded messages, and returns the message with the given name.
    -
    MultiBlockStructure - Class in redempt.redlib.multiblock
    +
    MultiBlockStructure - Class in redempt.redlib.multiblock
    A utility class intended to create interactive multi-block structures.
    -
    MultiRegion - Class in redempt.redlib.region
    +
    MultiRegion - Class in redempt.redlib.region
    Represents a collection of Regions forming any shape
    -
    MultiRegion(List<Region>) - Constructor for class redempt.redlib.region.MultiRegion
    +
    MultiRegion(List<Region>) - Constructor for class redempt.redlib.region.MultiRegion
    Construct a MultiRegion using a list of Regions
    -
    MultiRegion(Region...) - Constructor for class redempt.redlib.region.MultiRegion
    +
    MultiRegion(Region...) - Constructor for class redempt.redlib.region.MultiRegion
    Construct a MultiRegion using a vararg of Regions
    - - - -

    N

    -
    -
    NAME - redempt.redlib.itemutils.ItemTrait
    +

    N

    +
    +
    NAME - redempt.redlib.itemutils.ItemTrait
    For comparing the display name of two items
    -
    nameMatches(String) - Method in class redempt.redlib.commandmanager.Command
    +
    nameMatches(String) - Method in class redempt.redlib.commandmanager.Command
    Check if a name matches any of this command's aliases
    -
    names - Variable in class redempt.redlib.commandmanager.Command
    +
    names - Variable in class redempt.redlib.commandmanager.Command
     
    -
    NATURAL - Static variable in enum redempt.redlib.protection.ProtectionPolicy.ProtectionType
    +
    NATURAL - Static variable in enum redempt.redlib.protection.ProtectionPolicy.ProtectionType
    All protection types relating to natural processes not caused by players
    -
    next() - Method in class redempt.redlib.sql.SQLHelper.Results
    +
    next() - Method in class redempt.redlib.sql.SQLHelper.Results
    Moves to the next row in the wrapped ResultSet.
    -
    NMSArray - Class in redempt.redlib.nms
    +
    NMSArray - Class in redempt.redlib.nms
    Wraps any type of Array and provides easy reflection access
    -
    NMSArray(Object) - Constructor for class redempt.redlib.nms.NMSArray
    +
    NMSArray(Object) - Constructor for class redempt.redlib.nms.NMSArray
     
    -
    NMSClass - Class in redempt.redlib.nms
    +
    NMSClass - Class in redempt.redlib.nms
    Wraps any class and provides methods for easy reflection
    -
    NMSClass(Class<?>) - Constructor for class redempt.redlib.nms.NMSClass
    +
    NMSClass(Class<?>) - Constructor for class redempt.redlib.nms.NMSClass
    Constructs an NMSClass wrapping the given class
    -
    NMSHelper - Class in redempt.redlib.nms
    +
    NMSHelper - Class in redempt.redlib.nms
    A set of utility methods useful for handling NMS
    -
    NMSHelper() - Constructor for class redempt.redlib.nms.NMSHelper
    +
    NMSHelper() - Constructor for class redempt.redlib.nms.NMSHelper
     
    -
    NMSObject - Class in redempt.redlib.nms
    +
    NMSObject - Class in redempt.redlib.nms
    Wraps any Object and provides easy access to reflection methods
    -
    NMSObject(Object) - Constructor for class redempt.redlib.nms.NMSObject
    +
    NMSObject(Object) - Constructor for class redempt.redlib.nms.NMSObject
    Constructs an NMSObject with the object it should wrap
    -
    noise(double, double) - Method in class redempt.redlib.worldgen.NoiseGenerator
    +
    noise(double, double) - Method in class redempt.redlib.worldgen.NoiseGenerator
    Gets a noise value at a specific 2D point
    -
    noise(double, double) - Method in class redempt.redlib.worldgen.NoiseOctave
    +
    noise(double, double) - Method in class redempt.redlib.worldgen.NoiseOctave
    Gets the noise value at the given point
    -
    noise(double, double, double) - Method in class redempt.redlib.worldgen.NoiseGenerator
    +
    noise(double, double, double) - Method in class redempt.redlib.worldgen.NoiseGenerator
    Gets a noise value at a specific 3D point
    -
    noise(double, double, double) - Method in class redempt.redlib.worldgen.NoiseOctave
    +
    noise(double, double, double) - Method in class redempt.redlib.worldgen.NoiseOctave
    Gets the noise value at the given point
    -
    NoiseGenerator - Class in redempt.redlib.worldgen
    +
    NoiseGenerator - Class in redempt.redlib.worldgen
    A Perlin Noise generator which can be faster than PerlinNoiseGenerator
    -
    NoiseGenerator() - Constructor for class redempt.redlib.worldgen.NoiseGenerator
    +
    NoiseGenerator() - Constructor for class redempt.redlib.worldgen.NoiseGenerator
    Creates a noise generator with a random seed
    -
    NoiseGenerator(long) - Constructor for class redempt.redlib.worldgen.NoiseGenerator
    +
    NoiseGenerator(long) - Constructor for class redempt.redlib.worldgen.NoiseGenerator
    Creates a noise generator with a seed
    -
    NoiseOctave - Class in redempt.redlib.worldgen
    +
    NoiseOctave - Class in redempt.redlib.worldgen
    Used to generate noise values for octaves of Perlin Noise
    -
    NoiseOctave(int) - Constructor for class redempt.redlib.worldgen.NoiseOctave
    +
    NoiseOctave(int) - Constructor for class redempt.redlib.worldgen.NoiseOctave
    Creates a noise octave with a random seed
    -
    NoiseOctave(long, int) - Constructor for class redempt.redlib.worldgen.NoiseOctave
    +
    NoiseOctave(long, int) - Constructor for class redempt.redlib.worldgen.NoiseOctave
    Creates a noise octave with the given seed and size.
    - - - -

    O

    -
    -
    of(String, Class<T>) - Static method in class redempt.redlib.commandmanager.ArgType
    +

    O

    +
    +
    of(String, Class<T>) - Static method in class redempt.redlib.commandmanager.ArgType
    Creates a ArgType for an enum, which will accept all of the enum's values as arguments and offer all enum values as tab completions
    -
    of(String, String...) - Static method in class redempt.redlib.commandmanager.ArgType
    +
    of(String, String...) - Static method in class redempt.redlib.commandmanager.ArgType
    Creates a ArgType for a set of possible string inputs
    -
    of(String, Map<String, T>) - Static method in class redempt.redlib.commandmanager.ArgType
    +
    of(String, Map<String, T>) - Static method in class redempt.redlib.commandmanager.ArgType
    Creates an ArgType for a map of a String to another type
    -
    onBlockExplode(BlockExplodeEvent) - Method in class redempt.redlib.blockdata.BlockDataManager
    +
    onBlockExplode(BlockExplodeEvent) - Method in class redempt.redlib.blockdata.BlockDataManager
     
    -
    onBlockPull(BlockPistonRetractEvent) - Method in class redempt.redlib.blockdata.BlockDataManager
    +
    onBlockPull(BlockPistonRetractEvent) - Method in class redempt.redlib.blockdata.BlockDataManager
     
    -
    onBlockPush(BlockPistonExtendEvent) - Method in class redempt.redlib.blockdata.BlockDataManager
    +
    onBlockPush(BlockPistonExtendEvent) - Method in class redempt.redlib.blockdata.BlockDataManager
     
    -
    onBreak(DataBlockDestroyEvent) - Method in class redempt.redlib.blockdata.CustomBlockRegistry
    +
    onBreak(DataBlockDestroyEvent) - Method in class redempt.redlib.blockdata.CustomBlockRegistry
     
    -
    onBreakBlock(BlockBreakEvent) - Method in class redempt.redlib.blockdata.BlockDataManager
    +
    onBreakBlock(BlockBreakEvent) - Method in class redempt.redlib.blockdata.BlockDataManager
     
    -
    onBucketEmpty(PlayerBucketEmptyEvent) - Method in class redempt.redlib.blockdata.BlockDataManager
    +
    onBucketEmpty(PlayerBucketEmptyEvent) - Method in class redempt.redlib.blockdata.BlockDataManager
     
    -
    onBurnBlock(BlockBurnEvent) - Method in class redempt.redlib.blockdata.BlockDataManager
    +
    onBurnBlock(BlockBurnEvent) - Method in class redempt.redlib.blockdata.BlockDataManager
     
    -
    onChat(AsyncPlayerChatEvent) - Method in class redempt.redlib.misc.ChatPrompt
    +
    onChat(AsyncPlayerChatEvent) - Method in class redempt.redlib.misc.ChatPrompt
     
    -
    onChunkUnload(ChunkUnloadEvent) - Method in class redempt.redlib.blockdata.BlockDataManager
    +
    onChunkUnload(ChunkUnloadEvent) - Method in class redempt.redlib.blockdata.BlockDataManager
     
    -
    onClick(InventoryClickEvent) - Method in class redempt.redlib.inventorygui.InventoryGUI
    +
    onClick(InventoryClickEvent) - Method in class redempt.redlib.inventorygui.InventoryGUI
     
    -
    onClick(InventoryClickEvent) - Method in class redempt.redlib.inventorygui.ItemButton
    +
    onClick(InventoryClickEvent) - Method in class redempt.redlib.inventorygui.ItemButton
     
    -
    onClick(PlayerInteractEvent) - Method in class redempt.redlib.blockdata.CustomBlockRegistry
    +
    onClick(PlayerInteractEvent) - Method in class redempt.redlib.blockdata.CustomBlockRegistry
     
    -
    onClick(PlayerInteractEvent) - Method in class redempt.redlib.region.SelectionTool
    +
    onClick(PlayerInteractEvent) - Method in class redempt.redlib.region.SelectionTool
     
    -
    onClose(InventoryCloseEvent) - Method in class redempt.redlib.inventorygui.InventoryGUI
    +
    onClose(InventoryCloseEvent) - Method in class redempt.redlib.inventorygui.InventoryGUI
     
    -
    onCreatureSpawn(CreatureSpawnEvent) - Method in class redempt.redlib.protection.ProtectionPolicy
    +
    onCreatureSpawn(CreatureSpawnEvent) - Method in class redempt.redlib.protection.ProtectionPolicy
     
    -
    onDisable() - Method in class redempt.redlib.RedLib
    +
    onDisable() - Method in class redempt.redlib.RedLib
     
    -
    onDisable(PluginDisableEvent) - Method in class redempt.redlib.blockdata.CustomBlockRegistry
    +
    onDisable(PluginDisableEvent) - Method in class redempt.redlib.blockdata.CustomBlockRegistry
     
    -
    onDrag(InventoryDragEvent) - Method in class redempt.redlib.inventorygui.InventoryGUI
    +
    onDrag(InventoryDragEvent) - Method in class redempt.redlib.inventorygui.InventoryGUI
     
    -
    onEnable() - Method in class redempt.redlib.RedLib
    +
    onEnable() - Method in class redempt.redlib.RedLib
     
    -
    onEntityExplode(EntityExplodeEvent) - Method in class redempt.redlib.blockdata.BlockDataManager
    +
    onEntityExplode(EntityExplodeEvent) - Method in class redempt.redlib.blockdata.BlockDataManager
     
    -
    onFlowBreakBlock(BlockFromToEvent) - Method in class redempt.redlib.blockdata.BlockDataManager
    +
    onFlowBreakBlock(BlockFromToEvent) - Method in class redempt.redlib.blockdata.BlockDataManager
     
    -
    onInteract(PlayerInteractEvent) - Method in class redempt.redlib.dev.StructureTool
    +
    onInteract(PlayerInteractEvent) - Method in class redempt.redlib.dev.StructureTool
     
    -
    onLeave(PlayerQuitEvent) - Method in class redempt.redlib.misc.ChatPrompt
    +
    onLeave(PlayerQuitEvent) - Method in class redempt.redlib.misc.ChatPrompt
     
    -
    onPickBlock(InventoryCreativeEvent) - Method in class redempt.redlib.blockdata.CustomBlockRegistry
    +
    onPickBlock(InventoryCreativeEvent) - Method in class redempt.redlib.blockdata.CustomBlockRegistry
     
    -
    onPlace(BlockPlaceEvent) - Method in class redempt.redlib.blockdata.CustomBlockRegistry
    +
    onPlace(BlockPlaceEvent) - Method in class redempt.redlib.blockdata.CustomBlockRegistry
     
    -
    onPluginDisable(PluginDisableEvent) - Method in class redempt.redlib.region.SelectionTool
    +
    onPluginDisable(PluginDisableEvent) - Method in class redempt.redlib.region.SelectionTool
     
    -
    open(Player) - Method in class redempt.redlib.inventorygui.InventoryGUI
    +
    open(Player) - Method in class redempt.redlib.inventorygui.InventoryGUI
    Opens this GUI for a player
    -
    openMySQL(String, int, String, String, String) - Static method in class redempt.redlib.sql.SQLHelper
    +
    openMySQL(String, int, String, String, String) - Static method in class redempt.redlib.sql.SQLHelper
    Opens a connection to a MySQL database
    -
    openMySQL(String, String, String) - Static method in class redempt.redlib.sql.SQLHelper
    +
    openMySQL(String, String, String) - Static method in class redempt.redlib.sql.SQLHelper
    Opens a connection to a MySQL database at localhost:3306
    -
    openSlot(int) - Method in class redempt.redlib.inventorygui.InventoryGUI
    +
    openSlot(int) - Method in class redempt.redlib.inventorygui.InventoryGUI
    Opens a slot so that items can be placed in it
    -
    openSlots(int, int) - Method in class redempt.redlib.inventorygui.InventoryGUI
    +
    openSlots(int, int) - Method in class redempt.redlib.inventorygui.InventoryGUI
    Opens slots so that items can be placed in them
    -
    openSQLite(Path) - Static method in class redempt.redlib.sql.SQLHelper
    +
    openSQLite(Path) - Static method in class redempt.redlib.sql.SQLHelper
    Opens a SQLite database file
    -
    Overlappable - Interface in redempt.redlib.region
    +
    Overlappable - Interface in redempt.redlib.region
    Represents a Region which supports the overlap and intersect operations
    -
    overlaps(Overlappable) - Method in class redempt.redlib.region.CuboidRegion
    +
    overlaps(Overlappable) - Method in class redempt.redlib.region.CuboidRegion
    Check if this Region overlaps with another.
    -
    overlaps(Overlappable) - Method in class redempt.redlib.region.MultiRegion
    +
    overlaps(Overlappable) - Method in class redempt.redlib.region.MultiRegion
    Check if this Region overlaps with another.
    -
    overlaps(Overlappable) - Method in interface redempt.redlib.region.Overlappable
    +
    overlaps(Overlappable) - Method in interface redempt.redlib.region.Overlappable
    Checks whether this Overlappable overlaps another Overlappable
    - - - -

    P

    -
    -
    parent - Variable in class redempt.redlib.commandmanager.Command
    +

    P

    +
    +
    parent - Variable in class redempt.redlib.commandmanager.Command
     
    -
    parent - Variable in class redempt.redlib.dev.profiler.SampleSummary.SampleMethod
    +
    parent - Variable in class redempt.redlib.dev.profiler.SampleSummary.SampleMethod
     
    -
    parse() - Method in class redempt.redlib.commandmanager.CommandParser
    +
    parse() - Method in class redempt.redlib.commandmanager.CommandParser
    Parses the command info from the stream
    -
    parseList(String) - Static method in class redempt.redlib.json.JSONParser
    +
    parseList(String) - Static method in class redempt.redlib.json.JSONParser
    Parse a JSONList from a JSON string
    -
    parseMap(String) - Static method in class redempt.redlib.json.JSONParser
    +
    parseMap(String) - Static method in class redempt.redlib.json.JSONParser
    Parse a JSONMap from a JSON string
    -
    PassiveProfiler - Class in redempt.redlib.dev.profiler
    +
    PassiveProfiler - Class in redempt.redlib.dev.profiler
    A profiler best used over long periods of time.
    -
    PassiveProfiler() - Constructor for class redempt.redlib.dev.profiler.PassiveProfiler
    +
    PassiveProfiler() - Constructor for class redempt.redlib.dev.profiler.PassiveProfiler
    Create a new PassiveProfiler with an empty summary
    -
    Path - Class in redempt.redlib.misc
    +
    Path - Class in redempt.redlib.misc
     
    -
    Path() - Constructor for class redempt.redlib.misc.Path
    +
    Path() - Constructor for class redempt.redlib.misc.Path
     
    -
    pathfind(Block, Block, int) - Static method in class redempt.redlib.misc.LocationUtils
    +
    pathfind(Block, Block, int) - Static method in class redempt.redlib.misc.LocationUtils
    Finds the fastest path between a starting and ending location using A*
    -
    pathfind(Block, Block, int, Predicate<Block>) - Static method in class redempt.redlib.misc.LocationUtils
    +
    pathfind(Block, Block, int, Predicate<Block>) - Static method in class redempt.redlib.misc.LocationUtils
    Finds the fastest path between a starting and ending location using A*
    -
    persist(T) - Static method in class redempt.redlib.misc.EntityPersistor
    +
    persist(T) - Static method in class redempt.redlib.misc.EntityPersistor
    Wraps an Entity object with a proxy which will attempt to ensure the Entity object remains valid even if the entity's chunk is unloaded, then loaded again.
    -
    PISTONS - redempt.redlib.protection.ProtectionPolicy.ProtectionType
    +
    PISTONS - redempt.redlib.protection.ProtectionPolicy.ProtectionType
    Pistons pushing and pulling blocks
    -
    place(Player, ItemStack, T) - Method in class redempt.redlib.blockdata.CustomBlockType
    +
    place(Player, ItemStack, T) - Method in class redempt.redlib.blockdata.CustomBlockType
    Called when this CustomBlockType is placed.
    -
    PLACE_BLOCK - redempt.redlib.protection.ProtectionPolicy.ProtectionType
    +
    PLACE_BLOCK - redempt.redlib.protection.ProtectionPolicy.ProtectionType
    Players placing blocks
    -
    PLACE_BUCKET - redempt.redlib.blockdata.events.DataBlockDestroyEvent.DestroyCause
    +
    PLACE_BUCKET - redempt.redlib.blockdata.events.DataBlockDestroyEvent.DestroyCause
     
    -
    PLAIN - redempt.redlib.configmanager.ConversionType
    +
    PLAIN - redempt.redlib.configmanager.ConversionType
    A config value loaded and stored directly from config
    -
    PLAYER - redempt.redlib.blockdata.events.DataBlockDestroyEvent.DestroyCause
    +
    PLAYER - redempt.redlib.blockdata.events.DataBlockDestroyEvent.DestroyCause
     
    -
    PLAYER - redempt.redlib.commandmanager.Command.SenderType
    +
    PLAYER - redempt.redlib.commandmanager.Command.SenderType
     
    -
    PLAYER_CANCELLED - redempt.redlib.misc.ChatPrompt.CancelReason
    +
    PLAYER_CANCELLED - redempt.redlib.misc.ChatPrompt.CancelReason
    Passed when the prompt was cancelled because the player typed 'cancel'.
    -
    PLAYER_LEFT - redempt.redlib.misc.ChatPrompt.CancelReason
    +
    PLAYER_LEFT - redempt.redlib.misc.ChatPrompt.CancelReason
    Passed when the prompt was cancelled because the player left the server.
    -
    PlayerChangedArmorEvent - Class in redempt.redlib.enchants.events
    +
    PlayerChangedArmorEvent - Class in redempt.redlib.enchants.events
    Called when a player changes any piece of armor
    -
    PlayerChangedArmorEvent(Player, ItemStack[], ItemStack[]) - Constructor for class redempt.redlib.enchants.events.PlayerChangedArmorEvent
    +
    PlayerChangedArmorEvent(Player, ItemStack[], ItemStack[]) - Constructor for class redempt.redlib.enchants.events.PlayerChangedArmorEvent
    Constructs a new PlayerChangedArmorEvent
    -
    PlayerChangedHeldItemEvent - Class in redempt.redlib.enchants.events
    +
    PlayerChangedHeldItemEvent - Class in redempt.redlib.enchants.events
    Called when a player changes the item they are holding, or a property of their held item changes
    -
    PlayerChangedHeldItemEvent(Player, ItemStack, ItemStack) - Constructor for class redempt.redlib.enchants.events.PlayerChangedHeldItemEvent
    +
    PlayerChangedHeldItemEvent(Player, ItemStack, ItemStack) - Constructor for class redempt.redlib.enchants.events.PlayerChangedHeldItemEvent
    Constructs a new PlayerChangedHeldItemEvent
    -
    playerType - Static variable in class redempt.redlib.commandmanager.ArgType
    +
    playerType - Static variable in class redempt.redlib.commandmanager.ArgType
    The ArgType for a Player
    -
    PlayerWrapper - Class in redempt.redlib.misc
    +
    PlayerWrapper - Class in redempt.redlib.misc
     
    -
    PlayerWrapper() - Constructor for class redempt.redlib.misc.PlayerWrapper
    +
    PlayerWrapper() - Constructor for class redempt.redlib.misc.PlayerWrapper
     
    -
    plugin - Variable in class redempt.redlib.commandmanager.Command
    +
    plugin - Variable in class redempt.redlib.commandmanager.Command
     
    -
    PORTAL_PAIRING - redempt.redlib.protection.ProtectionPolicy.ProtectionType
    +
    PORTAL_PAIRING - redempt.redlib.protection.ProtectionPolicy.ProtectionType
    Portals being created from another dimension
    -
    prefill(int, int) - Method in class redempt.redlib.worldgen.CustomBiome
    +
    prefill(int, int) - Method in class redempt.redlib.worldgen.CustomBiome
    -
    Deprecated.
    +
    Deprecated.
     
    -
    prefill(int, int, int, int) - Method in class redempt.redlib.worldgen.NoiseGenerator
    +
    prefill(int, int, int, int) - Method in class redempt.redlib.worldgen.NoiseGenerator
    Pre-fills the gradient vectors in the specified area of this noise generator.
    -
    prefill(int, int, int, int) - Method in class redempt.redlib.worldgen.NoiseOctave
    +
    prefill(int, int, int, int) - Method in class redempt.redlib.worldgen.NoiseOctave
    Pre-fills gradient vectors in the noise generators in this octave for the given region.
    -
    prefill(int, int, int, int, int, int) - Method in class redempt.redlib.worldgen.NoiseGenerator
    +
    prefill(int, int, int, int, int, int) - Method in class redempt.redlib.worldgen.NoiseGenerator
    Pre-fills the gradient vectors in the specified area of this noise generator.
    -
    prefill(int, int, int, int, int, int) - Method in class redempt.redlib.worldgen.NoiseOctave
    +
    prefill(int, int, int, int, int, int) - Method in class redempt.redlib.worldgen.NoiseOctave
    Pre-fills gradient vectors in the noise generators in this octave for the given region.
    -
    prepareStatement(String, Object...) - Method in class redempt.redlib.sql.SQLHelper
    +
    prepareStatement(String, Object...) - Method in class redempt.redlib.sql.SQLHelper
    Prepares a statement, setting its fields to the elements of the vararg passed
    -
    prepend(String) - Method in class redempt.redlib.misc.Hologram
    +
    prepend(String) - Method in class redempt.redlib.misc.Hologram
    Adds a line at the top of this Hologram
    -
    PRIMARY_BLOCK_FACES - Static variable in class redempt.redlib.misc.LocationUtils
    +
    PRIMARY_BLOCK_FACES - Static variable in class redempt.redlib.misc.LocationUtils
    An array of all the block faces which face in a single direction (positive X, negative X, etc.)
    -
    priority() - Method in annotation type redempt.redlib.configmanager.annotations.ConfigValue
    +
    priority() - Method in annotation type redempt.redlib.configmanager.annotations.ConfigValue
     
    -
    Profiler - Class in redempt.redlib.dev.profiler
    +
    Profiler - Class in redempt.redlib.dev.profiler
    A base class of a Profiler which can be used to analyze the performance of the server.
    -
    Profiler() - Constructor for class redempt.redlib.dev.profiler.Profiler
    +
    Profiler() - Constructor for class redempt.redlib.dev.profiler.Profiler
     
    -
    ProfilerCommands - Class in redempt.redlib.dev.profiler
    +
    ProfilerCommands - Class in redempt.redlib.dev.profiler
     
    -
    ProfilerCommands() - Constructor for class redempt.redlib.dev.profiler.ProfilerCommands
    +
    ProfilerCommands() - Constructor for class redempt.redlib.dev.profiler.ProfilerCommands
     
    -
    prompt(Player, String, Consumer<String>) - Static method in class redempt.redlib.misc.ChatPrompt
    +
    prompt(Player, String, Consumer<String>) - Static method in class redempt.redlib.misc.ChatPrompt
    Prompts a player with callbacks for player response and cancelling
    -
    prompt(Player, String, Consumer<String>, Consumer<ChatPrompt.CancelReason>) - Static method in class redempt.redlib.misc.ChatPrompt
    +
    prompt(Player, String, Consumer<String>, Consumer<ChatPrompt.CancelReason>) - Static method in class redempt.redlib.misc.ChatPrompt
    Prompts a player with callbacks for player response and cancelling
    -
    PROMPT_OVERRIDDEN - redempt.redlib.misc.ChatPrompt.CancelReason
    +
    PROMPT_OVERRIDDEN - redempt.redlib.misc.ChatPrompt.CancelReason
    Passed when the player was given another prompt.
    -
    protect(Plugin, ProtectionPolicy.ProtectionType...) - Method in class redempt.redlib.region.Region
    +
    protect(Plugin, ProtectionPolicy.ProtectionType...) - Method in class redempt.redlib.region.Region
    Protects this Region
    -
    protect(ProtectionPolicy.ProtectionType...) - Method in class redempt.redlib.region.Region
    +
    protect(ProtectionPolicy.ProtectionType...) - Method in class redempt.redlib.region.Region
    Protects this Region
    -
    ProtectedRegion - Class in redempt.redlib.protection
    +
    ProtectedRegion - Class in redempt.redlib.protection
    Represents a Region which has been protected using a ProtectionPolicy
    -
    ProtectedRegion(Plugin, Region, ProtectionPolicy.ProtectionType...) - Constructor for class redempt.redlib.protection.ProtectedRegion
    +
    ProtectedRegion(Plugin, Region, ProtectionPolicy.ProtectionType...) - Constructor for class redempt.redlib.protection.ProtectedRegion
    Creates a ProtectedRegion
    -
    ProtectedRegion(Region, ProtectionPolicy.ProtectionType...) - Constructor for class redempt.redlib.protection.ProtectedRegion
    +
    ProtectedRegion(Region, ProtectionPolicy.ProtectionType...) - Constructor for class redempt.redlib.protection.ProtectedRegion
    Creates a ProtectedRegion
    -
    ProtectionPolicy - Class in redempt.redlib.protection
    +
    ProtectionPolicy - Class in redempt.redlib.protection
    Represents a set of rules in the form of ProtectionPolicy.ProtectionTypes protecting a set of blocks, which can have bypasses
    -
    ProtectionPolicy(Predicate<Block>, ProtectionPolicy.ProtectionType...) - Constructor for class redempt.redlib.protection.ProtectionPolicy
    +
    ProtectionPolicy(Predicate<Block>, ProtectionPolicy.ProtectionType...) - Constructor for class redempt.redlib.protection.ProtectionPolicy
    Create a ProtectionPolicy to protect blocks.
    -
    ProtectionPolicy(Plugin, CuboidRegion, Predicate<Block>, ProtectionPolicy.ProtectionType...) - Constructor for class redempt.redlib.protection.ProtectionPolicy
    +
    ProtectionPolicy(Plugin, CuboidRegion, Predicate<Block>, ProtectionPolicy.ProtectionType...) - Constructor for class redempt.redlib.protection.ProtectionPolicy
     
    -
    ProtectionPolicy(CuboidRegion, Predicate<Block>, ProtectionPolicy.ProtectionType...) - Constructor for class redempt.redlib.protection.ProtectionPolicy
    +
    ProtectionPolicy(CuboidRegion, Predicate<Block>, ProtectionPolicy.ProtectionType...) - Constructor for class redempt.redlib.protection.ProtectionPolicy
    Create a ProtectionPolicy to protect blocks
    -
    ProtectionPolicy.ProtectionType - Enum in redempt.redlib.protection
    +
    ProtectionPolicy.ProtectionType - Enum in redempt.redlib.protection
     
    -
    provide(Player) - Method in class redempt.redlib.commandmanager.ContextProvider
    +
    provide(Player) - Method in class redempt.redlib.commandmanager.ContextProvider
     
    - - - -

    Q

    -
    -
    queryResultList(String, Object...) - Method in class redempt.redlib.sql.SQLHelper
    +

    Q

    +
    +
    queryResultList(String, Object...) - Method in class redempt.redlib.sql.SQLHelper
    Executes a SQL query as a prepared statement, setting its fields to the elements of the vararg passed, returning a list of values in the first column of each row in the results
    -
    queryResults(String, Object...) - Method in class redempt.redlib.sql.SQLHelper
    +
    queryResults(String, Object...) - Method in class redempt.redlib.sql.SQLHelper
    Executes a SQL query as a prepared statement, setting its fields to the elements of the vararg passed.
    -
    queryResultStringList(String, Object...) - Method in class redempt.redlib.sql.SQLHelper
    +
    queryResultStringList(String, Object...) - Method in class redempt.redlib.sql.SQLHelper
    Executes a SQL query as a prepared statement, setting its fields to the elements of the vararg passed, returning a String list of values in the first column of each row in the results
    -
    querySingleResult(String, Object...) - Method in class redempt.redlib.sql.SQLHelper
    +
    querySingleResult(String, Object...) - Method in class redempt.redlib.sql.SQLHelper
    Executes a SQL query as a prepared statement, setting its fields to the elements of the vararg passed, returning the value in the first column of the first row in the results
    -
    querySingleResultLong(String, Object...) - Method in class redempt.redlib.sql.SQLHelper
    +
    querySingleResultLong(String, Object...) - Method in class redempt.redlib.sql.SQLHelper
    Executes a SQL query as a prepared statement, setting its fields to the elements of the vararg passed, returning the value in the first column of the first row in the results as a Long.
    -
    querySingleResultString(String, Object...) - Method in class redempt.redlib.sql.SQLHelper
    +
    querySingleResultString(String, Object...) - Method in class redempt.redlib.sql.SQLHelper
    Executes a SQL query as a prepared statement, setting its fields to the elements of the vararg passed, returning the value in the first column of the first row in the results as a String.
    -
    QUIT - redempt.redlib.region.events.RegionExitEvent.ExitCause
    +
    QUIT - redempt.redlib.region.events.RegionExitEvent.ExitCause
    When a player leaves the game whilst in a region
    - - - -

    R

    -
    -
    recalculate() - Method in class redempt.redlib.region.MultiRegion
    +

    R

    +
    +
    recalculate() - Method in class redempt.redlib.region.MultiRegion
    Recalculates this region to ensure it is using close to the least possible number of sub-regions with no overlaps.
    -
    recalculate(boolean) - Method in class redempt.redlib.region.MultiRegion
    +
    recalculate(boolean) - Method in class redempt.redlib.region.MultiRegion
    Recalculates this region to ensure it is using close to the least possible number of sub-regions with no overlaps.
    @@ -3360,1257 +3268,1222 @@

    R

     
    redempt.redlib.worldgen - package redempt.redlib.worldgen
     
    -
    RedLib - Class in redempt.redlib
    +
    RedLib - Class in redempt.redlib
     
    -
    RedLib() - Constructor for class redempt.redlib.RedLib
    +
    RedLib() - Constructor for class redempt.redlib.RedLib
     
    -
    REDSTONE - redempt.redlib.protection.ProtectionPolicy.ProtectionType
    +
    REDSTONE - redempt.redlib.protection.ProtectionPolicy.ProtectionType
    Redstone wires and components
    -
    Region - Class in redempt.redlib.region
    +
    Region - Class in redempt.redlib.region
    Represents a region of an unspecified shape in the world
    -
    Region() - Constructor for class redempt.redlib.region.Region
    +
    Region() - Constructor for class redempt.redlib.region.Region
     
    -
    RegionEnterEvent - Class in redempt.redlib.region.events
    +
    RegionEnterEvent - Class in redempt.redlib.region.events
    Called when a player enters a region with events enabled
    -
    RegionEnterEvent(Player, Region, RegionEnterEvent.EnterCause, Cancellable) - Constructor for class redempt.redlib.region.events.RegionEnterEvent
    +
    RegionEnterEvent(Player, Region, RegionEnterEvent.EnterCause, Cancellable) - Constructor for class redempt.redlib.region.events.RegionEnterEvent
    Constructs a new RegionEnterEvent
    -
    RegionEnterEvent.EnterCause - Enum in redempt.redlib.region.events
    +
    RegionEnterEvent.EnterCause - Enum in redempt.redlib.region.events
     
    -
    RegionEnterExitListener - Class in redempt.redlib.region
    +
    RegionEnterExitListener - Class in redempt.redlib.region
     
    -
    RegionEnterExitListener() - Constructor for class redempt.redlib.region.RegionEnterExitListener
    +
    RegionEnterExitListener() - Constructor for class redempt.redlib.region.RegionEnterExitListener
     
    -
    RegionExitEvent - Class in redempt.redlib.region.events
    +
    RegionExitEvent - Class in redempt.redlib.region.events
    Called when a player exits a region with events enabled
    -
    RegionExitEvent(Player, Region, RegionExitEvent.ExitCause, Cancellable) - Constructor for class redempt.redlib.region.events.RegionExitEvent
    +
    RegionExitEvent(Player, Region, RegionExitEvent.ExitCause, Cancellable) - Constructor for class redempt.redlib.region.events.RegionExitEvent
    Constructs a new RegionExitEvent
    -
    RegionExitEvent.ExitCause - Enum in redempt.redlib.region.events
    +
    RegionExitEvent.ExitCause - Enum in redempt.redlib.region.events
     
    -
    regionMap - Static variable in class redempt.redlib.protection.ProtectionPolicy
    +
    regionMap - Static variable in class redempt.redlib.protection.ProtectionPolicy
     
    -
    RegionMap<T> - Class in redempt.redlib.region
    +
    RegionMap<T> - Class in redempt.redlib.region
    Represents a spatial mapping which can retrieve objects by approximate location in O(1)
    -
    RegionMap() - Constructor for class redempt.redlib.region.RegionMap
    +
    RegionMap() - Constructor for class redempt.redlib.region.RegionMap
    Constructs a RegionMap with scale 100
    -
    RegionMap(int) - Constructor for class redempt.redlib.region.RegionMap
    +
    RegionMap(int) - Constructor for class redempt.redlib.region.RegionMap
    Constructs a RegionMap with the specified scale
    -
    RegionUtils - Class in redempt.redlib.region
    +
    RegionUtils - Class in redempt.redlib.region
    Utilities for niche use cases of Regions
    -
    RegionUtils() - Constructor for class redempt.redlib.region.RegionUtils
    +
    RegionUtils() - Constructor for class redempt.redlib.region.RegionUtils
     
    -
    register() - Static method in class redempt.redlib.enchants.events.PlayerChangedArmorEvent
    +
    register() - Static method in class redempt.redlib.enchants.events.PlayerChangedArmorEvent
     
    -
    register() - Static method in class redempt.redlib.enchants.events.PlayerChangedHeldItemEvent
    +
    register() - Static method in class redempt.redlib.enchants.events.PlayerChangedHeldItemEvent
     
    -
    register() - Method in class redempt.redlib.enchants.trigger.EnchantTrigger
    +
    register() - Method in class redempt.redlib.enchants.trigger.EnchantTrigger
     
    -
    register() - Method in class redempt.redlib.enchants.trigger.KillEntityTrigger
    +
    register() - Method in class redempt.redlib.enchants.trigger.KillEntityTrigger
     
    -
    register() - Static method in class redempt.redlib.region.RegionEnterExitListener
    +
    register() - Static method in class redempt.redlib.region.RegionEnterExitListener
    Registers the listener which calls RegionEnterEvent and RegionExitEvent.
    -
    register(Object...) - Method in class redempt.redlib.configmanager.ConfigManager
    +
    register(Object...) - Method in class redempt.redlib.configmanager.ConfigManager
    Register all the hooks for annotated fields in the the given objects.
    -
    register(String, Object...) - Method in class redempt.redlib.commandmanager.Command
    +
    register(String, Object...) - Method in class redempt.redlib.commandmanager.Command
    Registers this command and its children
    -
    register(String, Object...) - Method in class redempt.redlib.commandmanager.CommandCollection
    +
    register(String, Object...) - Method in class redempt.redlib.commandmanager.CommandCollection
    +
    +
    Register all commands in this CommandCollection
    +
    +
    register(Plugin, String, Object...) - Method in class redempt.redlib.commandmanager.CommandCollection
    Register all commands in this CommandCollection
    -
    register(BlockDataManager) - Method in class redempt.redlib.blockdata.CustomBlockType
    +
    register(BlockDataManager) - Method in class redempt.redlib.blockdata.CustomBlockType
     
    -
    register(CustomBlockType<?>) - Method in class redempt.redlib.blockdata.CustomBlockRegistry
    +
    register(CustomBlockType<?>) - Method in class redempt.redlib.blockdata.CustomBlockRegistry
    Registers a single CustomBlockType into this CustomBlockRegistry
    -
    register(DataBlock) - Method in class redempt.redlib.blockdata.BlockDataManager
    +
    register(DataBlock) - Method in class redempt.redlib.blockdata.BlockDataManager
     
    -
    register(CustomEnchant) - Method in class redempt.redlib.enchants.EnchantRegistry
    +
    register(CustomEnchant) - Method in class redempt.redlib.enchants.EnchantRegistry
    Registers a CustomEnchant in this EnchantRegistry
    -
    register(EnchantRegistry) - Method in class redempt.redlib.enchants.CustomEnchant
    +
    register(EnchantRegistry) - Method in class redempt.redlib.enchants.CustomEnchant
     
    -
    registerAll(Plugin) - Method in class redempt.redlib.blockdata.CustomBlockRegistry
    +
    registerAll(Plugin) - Method in class redempt.redlib.blockdata.CustomBlockRegistry
    Looks through all classes in a Plugin, registering all classes which extend CustomBlockType that are not interfaces or abstract.
    -
    registerAll(Plugin) - Method in class redempt.redlib.enchants.EnchantRegistry
    +
    registerAll(Plugin) - Method in class redempt.redlib.enchants.EnchantRegistry
    Peeks inside a plugin's jar and registers all the classes which extend CustomEnchant inside it.
    -
    registerHook(Map<String, Command.MethodHook>) - Method in class redempt.redlib.commandmanager.Command
    +
    registerHook(Map<String, Command.MethodHook>, Plugin) - Method in class redempt.redlib.commandmanager.Command
     
    -
    registerProtection(Class<T>, ProtectionPolicy.ProtectionType, Function<T, Player>, Function<T, Block>...) - Static method in class redempt.redlib.protection.ProtectionPolicy
    +
    registerProtection(Class<T>, ProtectionPolicy.ProtectionType, Function<T, Player>, Function<T, Block>...) - Static method in class redempt.redlib.protection.ProtectionPolicy
    Registers a custom event to be protected using a specific ProtectionType
    -
    registerProtectionNonCancellable(Class<T>, ProtectionPolicy.ProtectionType, Function<T, Player>, Consumer<T>, Function<T, Block>...) - Static method in class redempt.redlib.protection.ProtectionPolicy
    +
    registerProtectionNonCancellable(Class<T>, ProtectionPolicy.ProtectionType, Function<T, Player>, Consumer<T>, Function<T, Block>...) - Static method in class redempt.redlib.protection.ProtectionPolicy
    Registers a custom event that cannot be cancelled using Cancellable.setCancelled(boolean) using a specific ProtectionType
    -
    registerProtections() - Static method in class redempt.redlib.protection.ProtectionPolicy
    +
    registerProtections() - Static method in class redempt.redlib.protection.ProtectionPolicy
     
    -
    remove() - Method in class redempt.redlib.blockdata.DataBlock
    +
    remove() - Method in class redempt.redlib.blockdata.DataBlock
    Removes this DataBlock and all the data associated with it
    -
    remove(int) - Method in class redempt.redlib.misc.Hologram
    +
    remove(int) - Method in class redempt.redlib.misc.Hologram
    Removes a line from this Hologram
    -
    remove(Object...) - Method in class redempt.redlib.sql.SQLCache
    +
    remove(Object...) - Method in class redempt.redlib.sql.SQLCache
    Removes a cached value, but does not affect the table
    -
    remove(String) - Method in class redempt.redlib.blockdata.DataBlock
    +
    remove(String) - Method in class redempt.redlib.blockdata.DataBlock
    Removes the object associated with a certain key.
    -
    remove(Inventory, ItemStack, int) - Static method in class redempt.redlib.itemutils.ItemUtils
    +
    remove(Inventory, ItemStack, int) - Static method in class redempt.redlib.itemutils.ItemUtils
    Removes the specified amount of the given item from the given inventory
    -
    remove(Inventory, ItemStack, int, BiPredicate<ItemStack, ItemStack>) - Static method in class redempt.redlib.itemutils.ItemUtils
    +
    remove(Inventory, ItemStack, int, BiPredicate<ItemStack, ItemStack>) - Static method in class redempt.redlib.itemutils.ItemUtils
    Removes the specified amount of the given item from the given inventory
    -
    remove(Inventory, Material, int) - Static method in class redempt.redlib.itemutils.ItemUtils
    +
    remove(Inventory, Material, int) - Static method in class redempt.redlib.itemutils.ItemUtils
    Removes the specified amount of the given item type from the given inventory
    -
    remove(ItemStack) - Method in class redempt.redlib.enchants.CustomEnchant
    +
    remove(ItemStack) - Method in class redempt.redlib.enchants.CustomEnchant
    Removes this CustomEnchant from the given item
    -
    remove(Location, T) - Method in class redempt.redlib.region.RegionMap
    +
    remove(Location, T) - Method in class redempt.redlib.region.RegionMap
    Removes a mapping by location
    -
    remove(DataBlock) - Method in class redempt.redlib.blockdata.BlockDataManager
    +
    remove(DataBlock) - Method in class redempt.redlib.blockdata.BlockDataManager
    Removes a DataBlock from this DataBlockManager
    -
    remove(CuboidRegion, T) - Method in class redempt.redlib.region.RegionMap
    +
    remove(CuboidRegion, T) - Method in class redempt.redlib.region.RegionMap
    Removes a mapping by region
    -
    remove(T) - Method in class redempt.redlib.misc.WeightedRandom
    +
    remove(T) - Method in class redempt.redlib.misc.WeightedRandom
    Removes an outcome from this WeightedRandom
    -
    removeButton(ItemButton) - Method in class redempt.redlib.inventorygui.InventoryGUI
    +
    removeButton(ItemButton) - Method in class redempt.redlib.inventorygui.InventoryGUI
    Remove a button from the inventory
    -
    removeFromMatchingCaches(String, Object...) - Method in class redempt.redlib.sql.SQLHelper
    +
    removeFromMatchingCaches(String, Object...) - Method in class redempt.redlib.sql.SQLHelper
    Finds matching caches by a pattern and removes a specific entry from them.
    -
    removeProtectionTypes(ProtectionPolicy.ProtectionType...) - Method in class redempt.redlib.protection.ProtectionPolicy
    +
    removeProtectionTypes(ProtectionPolicy.ProtectionType...) - Method in class redempt.redlib.protection.ProtectionPolicy
    Removes ProtectionTypes from this ProtectionPolicy
    -
    removeTransientProperty(String) - Method in class redempt.redlib.blockdata.DataBlock
    +
    removeTransientProperty(String) - Method in class redempt.redlib.blockdata.DataBlock
    Removes a transient property by its key
    -
    rename(ItemStack, String) - Static method in class redempt.redlib.itemutils.ItemUtils
    +
    rename(ItemStack, String) - Static method in class redempt.redlib.itemutils.ItemUtils
    Renames an ItemStack, functionally identical to ItemUtils.setName(ItemStack, String) but kept for legacy reasons
    -
    RESPAWN - redempt.redlib.region.events.RegionEnterEvent.EnterCause
    +
    RESPAWN - redempt.redlib.region.events.RegionEnterEvent.EnterCause
    When a players respawns into a region
    -
    restore() - Method in class redempt.redlib.inventorygui.InventoryGUI.GUIState
    +
    restore() - Method in class redempt.redlib.inventorygui.InventoryGUI.GUIState
    Restore the GUI to this state
    -
    restore() - Method in class redempt.redlib.region.CuboidRegion.RegionState
    +
    restore() - Method in class redempt.redlib.region.CuboidRegion.RegionState
    Restores the Region to this state
    -
    returnsItems() - Method in class redempt.redlib.inventorygui.InventoryGUI
    +
    returnsItems() - Method in class redempt.redlib.inventorygui.InventoryGUI
    Returns whether or not items in open slots are returned to the player when this inventory is destroyed
    -
    roll() - Method in class redempt.redlib.misc.WeightedRandom
    +
    roll() - Method in class redempt.redlib.misc.WeightedRandom
    Rolls and gets a weighted random outcome
    -
    roll(Map<T, Integer>) - Static method in class redempt.redlib.misc.WeightedRandom
    +
    roll(Map<T, Integer>) - Static method in class redempt.redlib.misc.WeightedRandom
    Performs a single roll given a map of outcomes to weights.
    -
    root(Player) - Method in class redempt.redlib.dev.profiler.ProfilerCommands
    +
    root(Player) - Method in class redempt.redlib.dev.profiler.ProfilerCommands
     
    -
    rotate(int) - Method in class redempt.redlib.region.CuboidRegion
    +
    rotate(int) - Method in class redempt.redlib.region.CuboidRegion
    Rotates this Region around its center
    -
    rotate(BlockData) - Method in class redempt.redlib.multiblock.Rotator
    +
    rotate(BlockData) - Method in class redempt.redlib.multiblock.Rotator
    Rotates block data.
    -
    rotate(Location, int) - Method in class redempt.redlib.region.CuboidRegion
    +
    rotate(Location, int) - Method in class redempt.redlib.region.CuboidRegion
    Rotates this Region around a point
    -
    rotate(Location, int) - Method in class redempt.redlib.region.MultiRegion
    +
    rotate(Location, int) - Method in class redempt.redlib.region.MultiRegion
    Rotates this MultiRegion and all of its sub-regions around the given point
    -
    rotate(Location, int) - Method in class redempt.redlib.region.Region
    +
    rotate(Location, int) - Method in class redempt.redlib.region.Region
    Rotates this Region around a central point
    -
    rotate(Location, int) - Method in class redempt.redlib.region.SpheroidRegion
    +
    rotate(Location, int) - Method in class redempt.redlib.region.SpheroidRegion
    Rotates this SpheroidRegion
    -
    rotateBlockFace(BlockFace) - Method in class redempt.redlib.multiblock.Rotator
    +
    rotateBlockFace(BlockFace) - Method in class redempt.redlib.multiblock.Rotator
    Rotates a BlockFace according to this Rotator
    -
    rotateBlockFace(BlockFace, int) - Static method in class redempt.redlib.multiblock.Rotator
    +
    rotateBlockFace(BlockFace, int) - Static method in class redempt.redlib.multiblock.Rotator
    Rotates a BlockFace according to given values
    -
    rotateBlockFace(BlockFace, int, boolean) - Static method in class redempt.redlib.multiblock.Rotator
    +
    rotateBlockFace(BlockFace, int, boolean) - Static method in class redempt.redlib.multiblock.Rotator
    Rotates a BlockFace according to given values
    -
    rotateVector(Vector) - Method in class redempt.redlib.multiblock.Rotator
    +
    rotateVector(Vector) - Method in class redempt.redlib.multiblock.Rotator
    Rotates a Vector according to this Rotator
    -
    Rotator - Class in redempt.redlib.multiblock
    +
    Rotator - Class in redempt.redlib.multiblock
    Used to rotate blocks and block sections when building or testing for the presence of a MultiBlockStructure
    -
    Rotator(int, boolean) - Constructor for class redempt.redlib.multiblock.Rotator
    +
    Rotator(int, boolean) - Constructor for class redempt.redlib.multiblock.Rotator
    Constructs a new Rotator
    - - - -

    S

    -
    -
    SampleMethod(SampleSummary, String) - Constructor for class redempt.redlib.dev.profiler.SampleSummary.SampleMethod
    +

    S

    +
    +
    SampleMethod(SampleSummary, String) - Constructor for class redempt.redlib.dev.profiler.SampleSummary.SampleMethod
     
    -
    SampleSummary - Class in redempt.redlib.dev.profiler
    +
    SampleSummary - Class in redempt.redlib.dev.profiler
    Represents a summary of profiler data
    -
    SampleSummary() - Constructor for class redempt.redlib.dev.profiler.SampleSummary
    +
    SampleSummary() - Constructor for class redempt.redlib.dev.profiler.SampleSummary
     
    -
    SampleSummary(Collection<Sample>) - Constructor for class redempt.redlib.dev.profiler.SampleSummary
    +
    SampleSummary(Collection<Sample>) - Constructor for class redempt.redlib.dev.profiler.SampleSummary
     
    -
    SampleSummary.SampleMethod - Class in redempt.redlib.dev.profiler
    +
    SampleSummary.SampleMethod - Class in redempt.redlib.dev.profiler
    Represents a method and its specific place in the summary tree.
    -
    save() - Method in class redempt.redlib.blockdata.BlockDataManager
    +
    save() - Method in class redempt.redlib.blockdata.BlockDataManager
    Saves all data to the save file.
    -
    save() - Method in class redempt.redlib.blockdata.DataBlock
    +
    save() - Method in class redempt.redlib.blockdata.DataBlock
     
    -
    save() - Method in class redempt.redlib.configmanager.ConfigManager
    +
    save() - Method in class redempt.redlib.configmanager.ConfigManager
    Saves all values from the annotated hook fields to config
    -
    save(ConfigurationSection) - Method in interface redempt.redlib.configmanager.ConfigStorage
    +
    save(ConfigurationSection) - Method in interface redempt.redlib.configmanager.ConfigStorage
     
    -
    saveAndClose() - Method in class redempt.redlib.blockdata.BlockDataManager
    +
    saveAndClose() - Method in class redempt.redlib.blockdata.BlockDataManager
    Saves all data to the save file, and closes the SQL connection.
    -
    saveDefaults() - Method in class redempt.redlib.configmanager.ConfigManager
    +
    saveDefaults() - Method in class redempt.redlib.configmanager.ConfigManager
    Save default values - initial values in the hook fields - where they do not already exist in the config
    -
    search(Player, int, double, int, String) - Method in class redempt.redlib.dev.profiler.ProfilerCommands
    +
    search(Player, int, double, int, String) - Method in class redempt.redlib.dev.profiler.ProfilerCommands
     
    -
    select(Object...) - Method in class redempt.redlib.sql.SQLCache
    +
    select(Object...) - Method in class redempt.redlib.sql.SQLCache
    Gets the cached value for a row, or queries it if it has not been cached yet
    -
    select(Player, String) - Method in class redempt.redlib.dev.profiler.ProfilerCommands
    +
    select(Player, String) - Method in class redempt.redlib.dev.profiler.ProfilerCommands
     
    -
    SelectionTool - Class in redempt.redlib.region
    +
    SelectionTool - Class in redempt.redlib.region
    A tool which can be given to players and used to select a Region, or just any two points
    -
    SelectionTool(ItemStack) - Constructor for class redempt.redlib.region.SelectionTool
    +
    SelectionTool(ItemStack) - Constructor for class redempt.redlib.region.SelectionTool
    Create a SelectionTool with the given item
    -
    selectLong(Object...) - Method in class redempt.redlib.sql.SQLCache
    +
    selectLong(Object...) - Method in class redempt.redlib.sql.SQLCache
    Gets the cached value for a Long row, or queries it if it has not been cached yet
    -
    selectReport(Player, int) - Method in class redempt.redlib.dev.profiler.ProfilerCommands
    +
    selectReport(Player, int) - Method in class redempt.redlib.dev.profiler.ProfilerCommands
     
    -
    selectString(Object...) - Method in class redempt.redlib.sql.SQLCache
    +
    selectString(Object...) - Method in class redempt.redlib.sql.SQLCache
    Gets the cached value for a String row, or queries it if it has not been cached yet
    -
    self - Static variable in class redempt.redlib.commandmanager.ContextProvider
    +
    self - Static variable in class redempt.redlib.commandmanager.ContextProvider
    -
    Deprecated. -
    Now included by default, there is no need to add it yourself
    +
    Deprecated. +
    Now included by default, there is no need to add it yourself
    -
    sendBlock(Player, Location) - Method in class redempt.redlib.multiblock.StructureData
    +
    sendBlock(Player, Location) - Method in class redempt.redlib.multiblock.StructureData
    Sends a fake block change to a Player
    -
    set(int, Object) - Method in class redempt.redlib.nms.NMSArray
    +
    set(int, Object) - Method in class redempt.redlib.nms.NMSArray
    Sets the object at the index of the wrapped array
    -
    set(Class<T>, ConversionType, T...) - Static method in class redempt.redlib.configmanager.ConfigManager
    +
    set(Class<T>, ConversionType, T...) - Static method in class redempt.redlib.configmanager.ConfigManager
    Creates a ConfigSet from a given type with initial elements.
    -
    set(Class<T>, T...) - Static method in class redempt.redlib.configmanager.ConfigManager
    +
    set(Class<T>, T...) - Static method in class redempt.redlib.configmanager.ConfigManager
    Creates a ConfigSet from a given type with initial elements.
    -
    set(String, Object) - Method in class redempt.redlib.blockdata.DataBlock
    +
    set(String, Object) - Method in class redempt.redlib.blockdata.DataBlock
    Sets a data value in this DataBlock.
    -
    set(ItemStack, String, Object) - Method in class redempt.redlib.itemutils.LoreStats
    +
    set(ItemStack, String, Object) - Method in class redempt.redlib.itemutils.LoreStats
    Sets the stat on the given item to the given object, which will be cast to a String
    -
    set(Location, T) - Method in class redempt.redlib.region.RegionMap
    +
    set(Location, T) - Method in class redempt.redlib.region.RegionMap
    Maps a Location to an object
    -
    set(CuboidRegion, T) - Method in class redempt.redlib.region.RegionMap
    +
    set(CuboidRegion, T) - Method in class redempt.redlib.region.RegionMap
    Maps a Region to an object
    -
    set(T, double) - Method in class redempt.redlib.misc.WeightedRandom
    +
    set(T, double) - Method in class redempt.redlib.misc.WeightedRandom
    Sets another weight in this WeightedRandom, replacing the weight of the outcome if it has already been added
    -
    set(T, int) - Method in class redempt.redlib.misc.WeightedRandom
    +
    set(T, int) - Method in class redempt.redlib.misc.WeightedRandom
    Sets another weight in this WeightedRandom, replacing the weight of the outcome if it has already been added
    -
    setArgTypes(ArgType<?>...) - Method in class redempt.redlib.commandmanager.CommandParser
    +
    setArgTypes(ArgType<?>...) - Method in class redempt.redlib.commandmanager.CommandParser
    Sets the CommandArgumentTypes to be used when building this command.
    -
    setAutoCommit(boolean) - Method in class redempt.redlib.sql.SQLHelper
    +
    setAutoCommit(boolean) - Method in class redempt.redlib.sql.SQLHelper
    Sets the wrapped connection's auto-commit property.
    -
    setAutoSave(boolean) - Method in class redempt.redlib.blockdata.BlockDataManager
    +
    setAutoSave(boolean) - Method in class redempt.redlib.blockdata.BlockDataManager
    Sets whether this BlockDataManager will automatically save every 5 minutes.
    -
    setAutoUnload(boolean) - Method in class redempt.redlib.blockdata.BlockDataManager
    +
    setAutoUnload(boolean) - Method in class redempt.redlib.blockdata.BlockDataManager
    Sets whether this BlockDataManager will automatically unload chunks of DataBlocks when a chunk is unloaded
    -
    setBiomeSize(double) - Method in class redempt.redlib.worldgen.CustomWorldGenerator
    +
    setBiomeSize(double) - Method in class redempt.redlib.worldgen.CustomWorldGenerator
    -
    Deprecated.
    +
    Deprecated.
     
    -
    setBlock(Block) - Method in class redempt.redlib.multiblock.StructureData
    +
    setBlock(Block) - Method in class redempt.redlib.multiblock.StructureData
    Sets this StructureData at the given location
    -
    setCancelled(boolean) - Method in class redempt.redlib.blockdata.events.CustomBlockPlaceEvent
    +
    setCancelled(boolean) - Method in class redempt.redlib.blockdata.events.CustomBlockPlaceEvent
     
    -
    setCancelled(boolean) - Method in class redempt.redlib.blockdata.events.DataBlockDestroyEvent
    +
    setCancelled(boolean) - Method in class redempt.redlib.blockdata.events.DataBlockDestroyEvent
    Sets the cancellation state of this event.
    -
    setCancelled(boolean) - Method in class redempt.redlib.blockdata.events.DataBlockMoveEvent
    +
    setCancelled(boolean) - Method in class redempt.redlib.blockdata.events.DataBlockMoveEvent
    Sets the cancellation state of this event.
    -
    setCancelled(boolean) - Method in class redempt.redlib.region.events.RegionEnterEvent
    +
    setCancelled(boolean) - Method in class redempt.redlib.region.events.RegionEnterEvent
    Set whether or not to cancel the player entering the Region.
    -
    setCancelled(boolean) - Method in class redempt.redlib.region.events.RegionExitEvent
    +
    setCancelled(boolean) - Method in class redempt.redlib.region.events.RegionExitEvent
    Set whether or not to cancel the player entering the Region.
    -
    setCommitInterval(int) - Method in class redempt.redlib.sql.SQLHelper
    +
    setCommitInterval(int) - Method in class redempt.redlib.sql.SQLHelper
    Starts a task to call commit() on this SQLHelper every n ticks.
    -
    setContextProviders(ContextProvider<?>...) - Method in class redempt.redlib.commandmanager.CommandParser
    +
    setContextProviders(ContextProvider<?>...) - Method in class redempt.redlib.commandmanager.CommandParser
    Sets the ContextProviders to be used when building this command.
    -
    setCount(int) - Method in class redempt.redlib.itemutils.ItemBuilder
    +
    setCount(int) - Method in class redempt.redlib.itemutils.ItemBuilder
    Sets the stack size of this ItemBuilder
    -
    setCustomModelData(int) - Method in class redempt.redlib.itemutils.ItemBuilder
    +
    setCustomModelData(int) - Method in class redempt.redlib.itemutils.ItemBuilder
    Sets the custom model data of this ItemBuilder
    -
    setCustomModelData(ItemStack, int) - Static method in class redempt.redlib.itemutils.ItemUtils
    +
    setCustomModelData(ItemStack, int) - Static method in class redempt.redlib.itemutils.ItemUtils
    Sets the custom model data of the item
    -
    setData(JSONMap) - Method in class redempt.redlib.blockdata.DataBlock
    +
    setData(JSONMap) - Method in class redempt.redlib.blockdata.DataBlock
     
    -
    setDenyMessage(Predicate<ProtectionPolicy.ProtectionType>, String) - Method in class redempt.redlib.protection.ProtectionPolicy
    +
    setDenyMessage(Predicate<ProtectionPolicy.ProtectionType>, String) - Method in class redempt.redlib.protection.ProtectionPolicy
    Sets the message to be shown to a player when they attempt to do an action which is protected again
    -
    setDenyMessage(ProtectionPolicy.ProtectionType, String) - Method in class redempt.redlib.protection.ProtectionPolicy
    +
    setDenyMessage(ProtectionPolicy.ProtectionType, String) - Method in class redempt.redlib.protection.ProtectionPolicy
    Sets the message to be shown to a player when they attempt to do an action which is protected again
    -
    setDestroyOnClose(boolean) - Method in class redempt.redlib.inventorygui.InventoryGUI
    +
    setDestroyOnClose(boolean) - Method in class redempt.redlib.inventorygui.InventoryGUI
    Sets whether this GUI is destroyed when it has been closed by all viewers
    -
    setDurability(int) - Method in class redempt.redlib.itemutils.ItemBuilder
    +
    setDurability(int) - Method in class redempt.redlib.itemutils.ItemBuilder
    Set the durability (damage) of the ItemBuilder
    -
    setField(int, String, Object) - Method in class redempt.redlib.nms.NMSObject
    +
    setField(int, String, Object) - Method in class redempt.redlib.nms.NMSObject
    Sets the value stored in a field in the wrapped object
    -
    setField(String, Object) - Method in class redempt.redlib.nms.NMSObject
    +
    setField(String, Object) - Method in class redempt.redlib.nms.NMSObject
    Sets the value stored in a field in the wrapped object
    -
    setFixedLore(boolean) - Method in class redempt.redlib.itemutils.LoreStats
    +
    setFixedLore(boolean) - Method in class redempt.redlib.itemutils.LoreStats
    True by default.
    -
    setIfAbsent(String, Object) - Method in class redempt.redlib.blockdata.DataBlock
    +
    setIfAbsent(String, Object) - Method in class redempt.redlib.blockdata.DataBlock
    Sets a data value, if absent, in this DataBlock.
    -
    setItem(ItemStack) - Method in class redempt.redlib.inventorygui.ItemButton
    +
    setItem(ItemStack) - Method in class redempt.redlib.inventorygui.ItemButton
    Update the item of this button.
    -
    setLimit(Player, int) - Method in class redempt.redlib.dev.profiler.ProfilerCommands
    +
    setLimit(Player, int) - Method in class redempt.redlib.dev.profiler.ProfilerCommands
     
    -
    setLine(int, String) - Method in class redempt.redlib.misc.Hologram
    +
    setLine(int, String) - Method in class redempt.redlib.misc.Hologram
    Sets the text for a line of this Hologram
    -
    setLineSpacing(double) - Method in class redempt.redlib.misc.Hologram
    +
    setLineSpacing(double) - Method in class redempt.redlib.misc.Hologram
    Sets the vertical distance between each line in this Hologram
    -
    setLocation(double, double) - Method in class redempt.redlib.multiblock.Rotator
    +
    setLocation(double, double) - Method in class redempt.redlib.multiblock.Rotator
    Sets the relative coordinates this Rotator will rotate
    -
    setLocations(Location, Location) - Method in class redempt.redlib.region.CuboidRegion
    +
    setLocations(Location, Location) - Method in class redempt.redlib.region.CuboidRegion
     
    -
    setLocations(Location, Location) - Method in class redempt.redlib.region.MultiRegion
    +
    setLocations(Location, Location) - Method in class redempt.redlib.region.MultiRegion
     
    -
    setLore(String...) - Method in class redempt.redlib.itemutils.ItemBuilder
    +
    setLore(String...) - Method in class redempt.redlib.itemutils.ItemBuilder
    Set the lore of this ItemBuilder
    -
    setLore(ItemStack, String) - Static method in class redempt.redlib.itemutils.ItemUtils
    +
    setLore(ItemStack, String) - Static method in class redempt.redlib.itemutils.ItemUtils
    Set a single line of lore for an ItemStack
    -
    setLore(ItemStack, String...) - Static method in class redempt.redlib.itemutils.ItemUtils
    +
    setLore(ItemStack, String...) - Static method in class redempt.redlib.itemutils.ItemUtils
    Set multiple lines of lore for an ItemStack
    -
    setLore(ItemStack, List<String>) - Static method in class redempt.redlib.itemutils.ItemUtils
    +
    setLore(ItemStack, List<String>) - Static method in class redempt.redlib.itemutils.ItemUtils
    Set multiple lines of lore for an ItemStack
    -
    setMinimum(CommandSender, int) - Method in class redempt.redlib.dev.profiler.ProfilerCommands
    +
    setMinimum(CommandSender, int) - Method in class redempt.redlib.dev.profiler.ProfilerCommands
     
    -
    setMirrored(boolean) - Method in class redempt.redlib.multiblock.Rotator
    +
    setMirrored(boolean) - Method in class redempt.redlib.multiblock.Rotator
    Sets whether this rotator mirrors over the X axis
    -
    setName(String) - Method in class redempt.redlib.itemutils.ItemBuilder
    +
    setName(String) - Method in class redempt.redlib.itemutils.ItemBuilder
    Renames this ItemBuilder
    -
    setName(ItemStack, String) - Static method in class redempt.redlib.itemutils.ItemUtils
    +
    setName(ItemStack, String) - Static method in class redempt.redlib.itemutils.ItemUtils
    Renames an ItemStack
    -
    setOnClickOpenSlot(BiConsumer<InventoryClickEvent, List<Integer>>) - Method in class redempt.redlib.inventorygui.InventoryGUI
    +
    setOnClickOpenSlot(BiConsumer<InventoryClickEvent, List<Integer>>) - Method in class redempt.redlib.inventorygui.InventoryGUI
    Sets the handler for when an open slot is clicked
    -
    setOnClickOpenSlot(Consumer<InventoryClickEvent>) - Method in class redempt.redlib.inventorygui.InventoryGUI
    +
    setOnClickOpenSlot(Consumer<InventoryClickEvent>) - Method in class redempt.redlib.inventorygui.InventoryGUI
    Sets the handler for when an open slot is clicked
    -
    setOnDestroy(Runnable) - Method in class redempt.redlib.inventorygui.InventoryGUI
    +
    setOnDestroy(Runnable) - Method in class redempt.redlib.inventorygui.InventoryGUI
    Sets a callback to be run when this GUI is destroyed
    -
    setOnDragOpenSlot(Consumer<InventoryDragEvent>) - Method in class redempt.redlib.inventorygui.InventoryGUI
    +
    setOnDragOpenSlot(Consumer<InventoryDragEvent>) - Method in class redempt.redlib.inventorygui.InventoryGUI
    Sets the handler for when items are drag-clicked into open slots
    -
    setParent(JSONStorage) - Method in class redempt.redlib.json.JSONList
    +
    setParent(JSONStorage) - Method in class redempt.redlib.json.JSONList
     
    -
    setParent(JSONStorage) - Method in class redempt.redlib.json.JSONMap
    +
    setParent(JSONStorage) - Method in class redempt.redlib.json.JSONMap
     
    -
    setProtectionTypes(ProtectionPolicy.ProtectionType...) - Method in class redempt.redlib.protection.ProtectionPolicy
    +
    setProtectionTypes(ProtectionPolicy.ProtectionType...) - Method in class redempt.redlib.protection.ProtectionPolicy
    Sets the ProtectionTypes to be used
    -
    setReturnsItems(boolean) - Method in class redempt.redlib.inventorygui.InventoryGUI
    +
    setReturnsItems(boolean) - Method in class redempt.redlib.inventorygui.InventoryGUI
    Sets whether items in open slots are returned to the player when this inventory is destroyed
    -
    setRotation(int) - Method in class redempt.redlib.multiblock.Rotator
    +
    setRotation(int) - Method in class redempt.redlib.multiblock.Rotator
    Sets the rotation
    -
    setScale(double) - Method in class redempt.redlib.worldgen.NoiseGenerator
    +
    setScale(double) - Method in class redempt.redlib.worldgen.NoiseGenerator
    Sets the scale of this noise generator.
    -
    setScales(double...) - Method in class redempt.redlib.worldgen.NoiseOctave
    +
    setScales(double...) - Method in class redempt.redlib.worldgen.NoiseOctave
    Sets the scale of every noise generator in this octave
    -
    setSeed(long) - Method in class redempt.redlib.worldgen.CustomWorldGenerator
    +
    setSeed(long) - Method in class redempt.redlib.worldgen.CustomWorldGenerator
    -
    Deprecated.
    +
    Deprecated.
     
    -
    setSeed(long) - Method in class redempt.redlib.worldgen.NoiseGenerator
    +
    setSeed(long) - Method in class redempt.redlib.worldgen.NoiseGenerator
    Set the seed of this noise generator
    -
    setSeed(long) - Method in class redempt.redlib.worldgen.NoiseOctave
    +
    setSeed(long) - Method in class redempt.redlib.worldgen.NoiseOctave
    Sets the seed of this noise octave.
    -
    setSlot(int) - Method in class redempt.redlib.inventorygui.ItemButton
    +
    setSlot(int) - Method in class redempt.redlib.inventorygui.ItemButton
     
    -
    setTab(BiFunction<CommandSender, String[], List<String>>) - Method in class redempt.redlib.commandmanager.ArgType
    +
    setTab(BiFunction<CommandSender, String[], List<String>>) - Method in class redempt.redlib.commandmanager.ArgType
    Sets the tab completer for this type
    -
    setTab(Function<CommandSender, List<String>>) - Method in class redempt.redlib.commandmanager.ArgType
    +
    setTab(Function<CommandSender, List<String>>) - Method in class redempt.redlib.commandmanager.ArgType
    Sets the tab completer for this type
    -
    setTab(ArgType.TabCompleter<?>) - Method in class redempt.redlib.commandmanager.ArgType
    +
    setTab(ArgType.TabCompleter<?>) - Method in class redempt.redlib.commandmanager.ArgType
     
    -
    setTempKey(String) - Method in class redempt.redlib.json.JSONList
    +
    setTempKey(String) - Method in class redempt.redlib.json.JSONList
     
    -
    setTempKey(String) - Method in class redempt.redlib.json.JSONMap
    +
    setTempKey(String) - Method in class redempt.redlib.json.JSONMap
     
    -
    setTickMinimum(long) - Static method in class redempt.redlib.dev.profiler.TickMonitorProfiler
    +
    setTickMinimum(long) - Static method in class redempt.redlib.dev.profiler.TickMonitorProfiler
     
    -
    setTransientProperty(String, Object) - Method in class redempt.redlib.blockdata.DataBlock
    +
    setTransientProperty(String, Object) - Method in class redempt.redlib.blockdata.DataBlock
    Attaches a transient property to this DataBlock.
    -
    setTransientPropertyIfAbsent(String, Object) - Method in class redempt.redlib.blockdata.DataBlock
    +
    setTransientPropertyIfAbsent(String, Object) - Method in class redempt.redlib.blockdata.DataBlock
    Attaches a transient property, if absent, to this DataBlock.
    -
    setUnbreakable(ItemStack) - Static method in class redempt.redlib.itemutils.ItemUtils
    +
    setUnbreakable(ItemStack) - Static method in class redempt.redlib.itemutils.ItemUtils
    Sets an item to be unbreakable
    -
    setWeight(double) - Method in class redempt.redlib.worldgen.NoiseGenerator
    +
    setWeight(double) - Method in class redempt.redlib.worldgen.NoiseGenerator
    Sets the weight of this noise generator.
    -
    setWeights(double...) - Method in class redempt.redlib.worldgen.NoiseOctave
    +
    setWeights(double...) - Method in class redempt.redlib.worldgen.NoiseOctave
    Sets the weight of every noise generator in this octave
    -
    setWorld(World) - Method in class redempt.redlib.region.CuboidRegion
    +
    setWorld(World) - Method in class redempt.redlib.region.CuboidRegion
    Set the world of this region, while keeping the coordinates the same
    -
    setWorld(World) - Method in class redempt.redlib.region.MultiRegion
    +
    setWorld(World) - Method in class redempt.redlib.region.MultiRegion
    Sets the world of this MultiRegion and all of its sub-regions, while keeping the coordinates the same
    -
    setWorld(World) - Method in class redempt.redlib.region.Region
    +
    setWorld(World) - Method in class redempt.redlib.region.Region
    Sets the World of this Region
    -
    setWorld(World) - Method in class redempt.redlib.region.SpheroidRegion
    +
    setWorld(World) - Method in class redempt.redlib.region.SpheroidRegion
    Sets the world of this SpheroidRegion
    -
    setXRadius(double) - Method in class redempt.redlib.region.SpheroidRegion
    +
    setXRadius(double) - Method in class redempt.redlib.region.SpheroidRegion
    Sets the radius of the spheroid on the X axis
    -
    setYRadius(double) - Method in class redempt.redlib.region.SpheroidRegion
    +
    setYRadius(double) - Method in class redempt.redlib.region.SpheroidRegion
    Sets the radius of the spheroid on the Y axis
    -
    setZRadius(double) - Method in class redempt.redlib.region.SpheroidRegion
    +
    setZRadius(double) - Method in class redempt.redlib.region.SpheroidRegion
    Sets the radius of the spheroid on the Z axis
    -
    SHOOT_ARROW - Static variable in class redempt.redlib.enchants.trigger.EnchantTrigger
    +
    SHOOT_ARROW - Static variable in class redempt.redlib.enchants.trigger.EnchantTrigger
    Calls activate with a ProjectileLaunchEvent when a player shoots a projectile with an item that has a CustomEnchant with this trigger
    -
    showHelp(String, CommandSender) - Method in class redempt.redlib.commandmanager.CommandCollection
    +
    showHelp(String, CommandSender) - Method in class redempt.redlib.commandmanager.CommandCollection
    Recursively searches this CommandCollection for a command by a given hook, then shows the help to the given sender
    -
    showHelp(CommandSender) - Method in class redempt.redlib.commandmanager.Command
    +
    showHelp(CommandSender) - Method in class redempt.redlib.commandmanager.Command
    Shows the help to a CommandSender
    -
    showReports(Player) - Method in class redempt.redlib.dev.profiler.ProfilerCommands
    +
    showReports(Player) - Method in class redempt.redlib.dev.profiler.ProfilerCommands
     
    -
    SILVERFISH - redempt.redlib.protection.ProtectionPolicy.ProtectionType
    +
    SILVERFISH - redempt.redlib.protection.ProtectionPolicy.ProtectionType
    Silverfish infesting or breaking blocks
    -
    size() - Method in class redempt.redlib.misc.Hologram
    +
    size() - Method in class redempt.redlib.misc.Hologram
     
    -
    size() - Method in class redempt.redlib.worldgen.NoiseOctave
    +
    size() - Method in class redempt.redlib.worldgen.NoiseOctave
     
    -
    skip(Player, Material) - Method in class redempt.redlib.dev.StructureTool
    +
    skip(Player, Material) - Method in class redempt.redlib.dev.StructureTool
     
    -
    smoothstep(double, double, double) - Static method in class redempt.redlib.worldgen.NoiseGenerator
    +
    smoothstep(double, double, double) - Static method in class redempt.redlib.worldgen.NoiseGenerator
    Smoothly interpolates between two values
    -
    SpheroidRegion - Class in redempt.redlib.region
    +
    SpheroidRegion - Class in redempt.redlib.region
    Represents a spheroid region in a world
    -
    SpheroidRegion(Location, double) - Constructor for class redempt.redlib.region.SpheroidRegion
    +
    SpheroidRegion(Location, double) - Constructor for class redempt.redlib.region.SpheroidRegion
    Creates a SpheroidRegion from a center and a radius
    -
    SpheroidRegion(Location, double, double, double) - Constructor for class redempt.redlib.region.SpheroidRegion
    +
    SpheroidRegion(Location, double, double, double) - Constructor for class redempt.redlib.region.SpheroidRegion
    Creates a SpheroidRegion from a center and a radius in each direction
    -
    SpheroidRegion(Location, Location) - Constructor for class redempt.redlib.region.SpheroidRegion
    +
    SpheroidRegion(Location, Location) - Constructor for class redempt.redlib.region.SpheroidRegion
    Creates a SpheroidRegion from two corners, using their midpoint as the center and their distance in each direction as the radius on each axis
    -
    sql - Variable in class redempt.redlib.blockdata.BlockDataManager
    +
    sql - Variable in class redempt.redlib.blockdata.BlockDataManager
     
    -
    SQLCache - Class in redempt.redlib.sql
    +
    SQLCache - Class in redempt.redlib.sql
    A cache to store the values in a single column of a single SQL table
    -
    SQLCache(SQLHelper, String, String, String...) - Constructor for class redempt.redlib.sql.SQLCache
    +
    SQLCache(SQLHelper, String, String, String...) - Constructor for class redempt.redlib.sql.SQLCache
     
    -
    SQLHelper - Class in redempt.redlib.sql
    +
    SQLHelper - Class in redempt.redlib.sql
    Wraps a Connection and offers helpful methods that don't need to be surrounded in a try/catch
    -
    SQLHelper(Connection) - Constructor for class redempt.redlib.sql.SQLHelper
    +
    SQLHelper(Connection) - Constructor for class redempt.redlib.sql.SQLHelper
    Constructs a SQLHelper from a Connection.
    -
    SQLHelper.Results - Class in redempt.redlib.sql
    +
    SQLHelper.Results - Class in redempt.redlib.sql
    Wraps a ResultSet with easier use
    -
    start - Variable in class redempt.redlib.region.CuboidRegion
    +
    start - Variable in class redempt.redlib.region.CuboidRegion
     
    -
    start() - Method in class redempt.redlib.dev.profiler.BurstProfiler
    +
    start() - Method in class redempt.redlib.dev.profiler.BurstProfiler
    Start this profiler.
    -
    start() - Method in class redempt.redlib.dev.profiler.PassiveProfiler
    +
    start() - Method in class redempt.redlib.dev.profiler.PassiveProfiler
    Start this profiler.
    -
    start() - Method in class redempt.redlib.dev.profiler.Profiler
    +
    start() - Method in class redempt.redlib.dev.profiler.Profiler
    Start this profiler.
    -
    start() - Static method in class redempt.redlib.dev.profiler.TickMonitorProfiler
    +
    start() - Static method in class redempt.redlib.dev.profiler.TickMonitorProfiler
     
    -
    start(CommandSender) - Method in class redempt.redlib.dev.profiler.ProfilerCommands
    +
    start(CommandSender) - Method in class redempt.redlib.dev.profiler.ProfilerCommands
     
    -
    startMonitor(CommandSender) - Method in class redempt.redlib.dev.profiler.ProfilerCommands
    +
    startMonitor(CommandSender) - Method in class redempt.redlib.dev.profiler.ProfilerCommands
     
    -
    stop() - Method in class redempt.redlib.dev.profiler.Profiler
    +
    stop() - Method in class redempt.redlib.dev.profiler.Profiler
    Stop this profiler
    -
    stop() - Static method in class redempt.redlib.dev.profiler.TickMonitorProfiler
    +
    stop() - Static method in class redempt.redlib.dev.profiler.TickMonitorProfiler
     
    -
    stop(CommandSender) - Method in class redempt.redlib.dev.profiler.ProfilerCommands
    +
    stop(CommandSender) - Method in class redempt.redlib.dev.profiler.ProfilerCommands
     
    -
    stopAll() - Static method in class redempt.redlib.dev.profiler.Profiler
    +
    stopAll() - Static method in class redempt.redlib.dev.profiler.Profiler
    Stop all running profilers
    -
    stream() - Method in class redempt.redlib.region.CuboidRegion
    +
    stream() - Method in class redempt.redlib.region.CuboidRegion
     
    -
    stream() - Method in class redempt.redlib.region.MultiRegion
    +
    stream() - Method in class redempt.redlib.region.MultiRegion
    A Stream of all the blocks in all of the Regions within this MultiRegion.
    -
    stream() - Method in class redempt.redlib.region.Region
    +
    stream() - Method in class redempt.redlib.region.Region
    Streams all Blocks inside this Region
    -
    stream() - Method in class redempt.redlib.region.SpheroidRegion
    +
    stream() - Method in class redempt.redlib.region.SpheroidRegion
     
    -
    strictMode - Variable in class redempt.redlib.multiblock.MultiBlockStructure
    +
    strictMode - Variable in class redempt.redlib.multiblock.MultiBlockStructure
     
    -
    strictModeExclude - Variable in class redempt.redlib.multiblock.MultiBlockStructure
    +
    strictModeExclude - Variable in class redempt.redlib.multiblock.MultiBlockStructure
     
    -
    STRING_CONVERTED - redempt.redlib.configmanager.ConversionType
    +
    STRING_CONVERTED - redempt.redlib.configmanager.ConversionType
    A config value converted to and from a string using TypeConverters
    -
    stringify(Location, Location) - Static method in class redempt.redlib.multiblock.MultiBlockStructure
    +
    stringify(Location, Location) - Static method in class redempt.redlib.multiblock.MultiBlockStructure
    Use this to get the info to construct a multi-block structure.
    -
    stringify(Location, Location, Material) - Static method in class redempt.redlib.multiblock.MultiBlockStructure
    +
    stringify(Location, Location, Material) - Static method in class redempt.redlib.multiblock.MultiBlockStructure
    Use this to get the info to construct a multi-block structure.
    -
    stringList(String...) - Static method in class redempt.redlib.configmanager.ConfigManager
    +
    stringList(String...) - Static method in class redempt.redlib.configmanager.ConfigManager
    Instantiates a List of Strings inline
    -
    Structure - Class in redempt.redlib.multiblock
    +
    Structure - Class in redempt.redlib.multiblock
    Represents an instance of a multi-block structure in the world
    -
    Structure(MultiBlockStructure, Location, Rotator) - Constructor for class redempt.redlib.multiblock.Structure
    +
    Structure(MultiBlockStructure, Location, Rotator) - Constructor for class redempt.redlib.multiblock.Structure
     
    -
    Structure.StructureBlock - Class in redempt.redlib.multiblock
    +
    Structure.StructureBlock - Class in redempt.redlib.multiblock
    Represents a block in a Structure instance
    -
    StructureData - Class in redempt.redlib.multiblock
    +
    StructureData - Class in redempt.redlib.multiblock
    Cross-version wrapper for block data - BlockData in 1.13+, MaterialData otherwise
    -
    StructureData(String) - Constructor for class redempt.redlib.multiblock.StructureData
    +
    StructureData(String) - Constructor for class redempt.redlib.multiblock.StructureData
     
    -
    StructureData(BlockData) - Constructor for class redempt.redlib.multiblock.StructureData
    +
    StructureData(BlockData) - Constructor for class redempt.redlib.multiblock.StructureData
    Creates a StructureData from a BlockData, for 1.13+
    -
    StructureData(Material) - Constructor for class redempt.redlib.multiblock.StructureData
    +
    StructureData(Material) - Constructor for class redempt.redlib.multiblock.StructureData
     
    -
    StructureData(Material, byte) - Constructor for class redempt.redlib.multiblock.StructureData
    +
    StructureData(Material, byte) - Constructor for class redempt.redlib.multiblock.StructureData
    Creates a StructureData from a Material and byte data, for 1.12 and below
    -
    StructureTool - Class in redempt.redlib.dev
    +
    StructureTool - Class in redempt.redlib.dev
     
    -
    subtract(Region) - Method in class redempt.redlib.region.MultiRegion
    +
    subtract(Region) - Method in class redempt.redlib.region.MultiRegion
    Subtracts a Region from this MultiRegion.
    -
    subType(String, BiFunction<String, T, K>) - Method in class redempt.redlib.commandmanager.ArgType
    +
    subType(String, BiFunction<String, T, K>) - Method in class redempt.redlib.commandmanager.ArgType
    Creates a new ArgSubtype with this ArgType as its parent.
    -
    subType(String, ArgType.ArgConverter<K, T>) - Method in class redempt.redlib.commandmanager.ArgType
    +
    subType(String, ArgType.ArgConverter<K, T>) - Method in class redempt.redlib.commandmanager.ArgType
    Creates a new ArgSubtype with this ArgType as its parent.
    -
    summary - Variable in class redempt.redlib.dev.profiler.SampleSummary.SampleMethod
    +
    summary - Variable in class redempt.redlib.dev.profiler.SampleSummary.SampleMethod
     
    -
    summary(Player) - Method in class redempt.redlib.dev.profiler.ProfilerCommands
    +
    summary(Player) - Method in class redempt.redlib.dev.profiler.ProfilerCommands
     
    -
    surfaceContains(Block) - Method in class redempt.redlib.region.SpheroidRegion
    +
    surfaceContains(Block) - Method in class redempt.redlib.region.SpheroidRegion
    Determines whether a block is on the surface of this SpheroidRegion
    -
    SYNC_DELAYED - redempt.redlib.misc.Task.TaskType
    +
    SYNC_DELAYED - redempt.redlib.misc.Task.TaskType
     
    -
    SYNC_REPEATING - redempt.redlib.misc.Task.TaskType
    +
    SYNC_REPEATING - redempt.redlib.misc.Task.TaskType
     
    -
    syncDelayed(Runnable) - Static method in class redempt.redlib.misc.Task
    +
    syncDelayed(Runnable) - Static method in class redempt.redlib.misc.Task
    Schedules a sync delayed task to run as soon as possible
    -
    syncDelayed(Runnable, long) - Static method in class redempt.redlib.misc.Task
    +
    syncDelayed(Runnable, long) - Static method in class redempt.redlib.misc.Task
    Schedules a sync delayed task to run after a delay
    -
    syncDelayed(Consumer<Task>) - Static method in class redempt.redlib.misc.Task
    +
    syncDelayed(Consumer<Task>) - Static method in class redempt.redlib.misc.Task
    Schedules a sync delayed task to run as soon as possible
    -
    syncDelayed(Consumer<Task>, long) - Static method in class redempt.redlib.misc.Task
    +
    syncDelayed(Consumer<Task>, long) - Static method in class redempt.redlib.misc.Task
    Schedules a sync delayed task to run after a delay
    -
    syncDelayed(Plugin, Runnable) - Static method in class redempt.redlib.misc.Task
    +
    syncDelayed(Plugin, Runnable) - Static method in class redempt.redlib.misc.Task
    Schedules a sync delayed task to run as soon as possible
    -
    syncDelayed(Plugin, Runnable, long) - Static method in class redempt.redlib.misc.Task
    +
    syncDelayed(Plugin, Runnable, long) - Static method in class redempt.redlib.misc.Task
    Schedules a sync delayed task to run after a delay
    -
    syncDelayed(Plugin, Consumer<Task>) - Static method in class redempt.redlib.misc.Task
    +
    syncDelayed(Plugin, Consumer<Task>) - Static method in class redempt.redlib.misc.Task
    Schedules a sync delayed task to run as soon as possible
    -
    syncDelayed(Plugin, Consumer<Task>, long) - Static method in class redempt.redlib.misc.Task
    +
    syncDelayed(Plugin, Consumer<Task>, long) - Static method in class redempt.redlib.misc.Task
    Schedules a sync delayed task to run after a delay
    -
    syncRepeating(Runnable, long, long) - Static method in class redempt.redlib.misc.Task
    +
    syncRepeating(Runnable, long, long) - Static method in class redempt.redlib.misc.Task
    Schedules a sync repeating task to run later
    -
    syncRepeating(Consumer<Task>, long, long) - Static method in class redempt.redlib.misc.Task
    +
    syncRepeating(Consumer<Task>, long, long) - Static method in class redempt.redlib.misc.Task
    Schedules a sync repeating task to run later
    -
    syncRepeating(Plugin, Runnable, long, long) - Static method in class redempt.redlib.misc.Task
    +
    syncRepeating(Plugin, Runnable, long, long) - Static method in class redempt.redlib.misc.Task
    Schedules a sync repeating task to run later
    -
    syncRepeating(Plugin, Consumer<Task>, long, long) - Static method in class redempt.redlib.misc.Task
    +
    syncRepeating(Plugin, Consumer<Task>, long, long) - Static method in class redempt.redlib.misc.Task
    Schedules a sync repeating task to run later
    - - - -

    T

    -
    -
    tab(CommandSender, String[]) - Method in class redempt.redlib.commandmanager.Command
    +

    T

    +
    +
    tab(CommandSender, String[]) - Method in class redempt.redlib.commandmanager.Command
     
    -
    tab(ArgType.TabCompleter<K>) - Method in class redempt.redlib.commandmanager.ArgSubtype
    +
    tab(ArgType.TabCompleter<K>) - Method in class redempt.redlib.commandmanager.ArgSubtype
    Sets the tab completer for this type
    -
    tabComplete(CommandSender, String[], Object) - Method in class redempt.redlib.commandmanager.ArgType
    +
    tabComplete(CommandSender, String[], Object) - Method in class redempt.redlib.commandmanager.ArgType
     
    -
    tabComplete(CommandSender, String[], T) - Method in interface redempt.redlib.commandmanager.ArgType.TabCompleter
    +
    tabComplete(CommandSender, String[], T) - Method in interface redempt.redlib.commandmanager.ArgType.TabCompleter
     
    -
    tabComplete(CommandSender, T, String[]) - Method in interface redempt.redlib.commandmanager.ArgType.TabStreamCompleter
    +
    tabComplete(CommandSender, T, String[]) - Method in interface redempt.redlib.commandmanager.ArgType.TabStreamCompleter
     
    -
    tabStream(BiFunction<CommandSender, String[], Stream<String>>) - Method in class redempt.redlib.commandmanager.ArgType
    +
    tabStream(BiFunction<CommandSender, String[], Stream<String>>) - Method in class redempt.redlib.commandmanager.ArgType
    Sets the tab completer for this type, can be used instead of tab
    -
    tabStream(Function<CommandSender, Stream<String>>) - Method in class redempt.redlib.commandmanager.ArgType
    +
    tabStream(Function<CommandSender, Stream<String>>) - Method in class redempt.redlib.commandmanager.ArgType
    Sets the tab completer for this type, can be used instead of tab
    -
    tabStream(ArgType.TabStreamCompleter<K>) - Method in class redempt.redlib.commandmanager.ArgSubtype
    +
    tabStream(ArgType.TabStreamCompleter<K>) - Method in class redempt.redlib.commandmanager.ArgSubtype
    Sets the tab completer for this type, can be used instead of tab
    -
    TAKE_DAMAGE - Static variable in class redempt.redlib.enchants.trigger.EnchantTrigger
    +
    TAKE_DAMAGE - Static variable in class redempt.redlib.enchants.trigger.EnchantTrigger
    Calls activate with an EntityDamageEvent when a player takes damage wearing armor that has a CustomEnchant with this trigger
    -
    Task - Class in redempt.redlib.misc
    +
    Task - Class in redempt.redlib.misc
    Simple utility for Bukkit scheduler tasks, essentially just shorthand
    -
    Task.TaskType - Enum in redempt.redlib.misc
    +
    Task.TaskType - Enum in redempt.redlib.misc
    Represents a type of task
    -
    TELEPORT - redempt.redlib.region.events.RegionEnterEvent.EnterCause
    +
    TELEPORT - redempt.redlib.region.events.RegionEnterEvent.EnterCause
    When a player teleports into a region
    -
    TELEPORT - redempt.redlib.region.events.RegionExitEvent.ExitCause
    +
    TELEPORT - redempt.redlib.region.events.RegionExitEvent.ExitCause
    When a player teleports out of a region
    -
    TickMonitorProfiler - Class in redempt.redlib.dev.profiler
    +
    TickMonitorProfiler - Class in redempt.redlib.dev.profiler
     
    -
    TickMonitorProfiler() - Constructor for class redempt.redlib.dev.profiler.TickMonitorProfiler
    +
    TickMonitorProfiler() - Constructor for class redempt.redlib.dev.profiler.TickMonitorProfiler
     
    -
    timeFormat(Player) - Method in class redempt.redlib.dev.profiler.ProfilerCommands
    +
    timeFormat(Player) - Method in class redempt.redlib.dev.profiler.ProfilerCommands
     
    -
    toBlockLocation(Location) - Static method in class redempt.redlib.misc.LocationUtils
    +
    toBlockLocation(Location) - Static method in class redempt.redlib.misc.LocationUtils
    Sets the location's coordinates to its block coordinates, then returns it
    -
    toCamelCase(String) - Static method in class redempt.redlib.misc.FormatUtils
    +
    toCamelCase(String) - Static method in class redempt.redlib.misc.FormatUtils
    Converts a string to camelCase, where every character after a space is capitalized.
    -
    toChunkPosition(Block) - Method in class redempt.redlib.blockdata.BlockDataManager
    +
    toChunkPosition(Block) - Method in class redempt.redlib.blockdata.BlockDataManager
     
    -
    toChunkPosition(Location) - Method in class redempt.redlib.blockdata.BlockDataManager
    +
    toChunkPosition(Location) - Method in class redempt.redlib.blockdata.BlockDataManager
     
    -
    toCuboid() - Method in class redempt.redlib.region.Region
    +
    toCuboid() - Method in class redempt.redlib.region.Region
     
    -
    toCuboid() - Method in class redempt.redlib.region.SpheroidRegion
    +
    toCuboid() - Method in class redempt.redlib.region.SpheroidRegion
     
    -
    toggleExpand(Player, String) - Method in class redempt.redlib.dev.profiler.ProfilerCommands
    +
    toggleExpand(Player, String) - Method in class redempt.redlib.dev.profiler.ProfilerCommands
     
    -
    topLevel - Variable in class redempt.redlib.commandmanager.Command
    +
    topLevel - Variable in class redempt.redlib.commandmanager.Command
     
    -
    toRomanNumerals(int) - Static method in class redempt.redlib.enchants.CustomEnchant
    +
    toRomanNumerals(int) - Static method in class redempt.redlib.enchants.CustomEnchant
    Converts a number to roman numerals, between 1 and 10
    -
    toString() - Method in class redempt.redlib.json.JSONList
    +
    toString() - Method in class redempt.redlib.json.JSONList
     
    -
    toString() - Method in class redempt.redlib.json.JSONMap
    +
    toString() - Method in class redempt.redlib.json.JSONMap
     
    -
    toString() - Method in class redempt.redlib.multiblock.MultiBlockStructure
    +
    toString() - Method in class redempt.redlib.multiblock.MultiBlockStructure
     
    -
    toString() - Method in class redempt.redlib.region.CuboidRegion
    +
    toString() - Method in class redempt.redlib.region.CuboidRegion
    Converts this Region to a String which can be converted back with CuboidRegion.fromString(String) later
    -
    toString() - Method in class redempt.redlib.region.MultiRegion
    +
    toString() - Method in class redempt.redlib.region.MultiRegion
    Converts this MultiRegion to a String which can be converted back to a MultiRegion using MultiRegion.fromString(String) Please use this to persist MultiRegions, as most of the operations for manipulating a MultiRegion are far more expensive than the same operations would be for a Region.
    -
    toString() - Method in class redempt.redlib.region.SpheroidRegion
    +
    toString() - Method in class redempt.redlib.region.SpheroidRegion
     
    -
    toString(Function<T, String>) - Method in class redempt.redlib.misc.WeightedRandom
    +
    toString(Function<T, String>) - Method in class redempt.redlib.misc.WeightedRandom
    Converts this WeightedRandom to a String which can be deserialized later
    -
    toString(Block) - Static method in class redempt.redlib.misc.LocationUtils
    +
    toString(Block) - Static method in class redempt.redlib.misc.LocationUtils
    Converts a Location to a String representing its location
    -
    toString(Block, String) - Static method in class redempt.redlib.misc.LocationUtils
    +
    toString(Block, String) - Static method in class redempt.redlib.misc.LocationUtils
    Converts a Location to a String representing its location
    -
    toString(ItemStack) - Static method in class redempt.redlib.itemutils.ItemUtils
    +
    toString(ItemStack) - Static method in class redempt.redlib.itemutils.ItemUtils
    Converts an ItemStack to a JSON string
    -
    toString(Location) - Static method in class redempt.redlib.misc.LocationUtils
    +
    toString(Location) - Static method in class redempt.redlib.misc.LocationUtils
    Converts a Location to a String.
    -
    toString(Location, String) - Static method in class redempt.redlib.misc.LocationUtils
    +
    toString(Location, String) - Static method in class redempt.redlib.misc.LocationUtils
    Converts a Location to a String
    -
    toTitleCase(String) - Static method in class redempt.redlib.misc.FormatUtils
    +
    toTitleCase(String) - Static method in class redempt.redlib.misc.FormatUtils
    Converts a string to Title Case, where the first character and every character after a space is capitalized.
    -
    truncateDouble(double) - Static method in class redempt.redlib.misc.FormatUtils
    +
    truncateDouble(double) - Static method in class redempt.redlib.misc.FormatUtils
    Truncates a double using a DecimalFormat with 0.00 as its format string
    -
    tryExists(World, BlockDataManager.ChunkPosition) - Method in class redempt.redlib.blockdata.BlockDataManager
    +
    tryExists(World, BlockDataManager.ChunkPosition) - Method in class redempt.redlib.blockdata.BlockDataManager
     
    -
    type() - Method in annotation type redempt.redlib.configmanager.annotations.ConfigValue
    +
    type() - Method in annotation type redempt.redlib.configmanager.annotations.ConfigValue
     
    -
    TYPE - redempt.redlib.itemutils.ItemTrait
    +
    TYPE - redempt.redlib.itemutils.ItemTrait
    For comparing the types of two items
    -
    typeMatches(Material) - Method in class redempt.redlib.blockdata.CustomBlockType
    +
    typeMatches(Material) - Method in class redempt.redlib.blockdata.CustomBlockType
    Checks whether the type of a block matches this CustomBlockType.
    - - - -

    U

    -
    -
    unbreakable() - Method in class redempt.redlib.itemutils.ItemBuilder
    +

    U

    +
    +
    unbreakable() - Method in class redempt.redlib.itemutils.ItemBuilder
    Sets this ItemBuilder to be unbreakable
    -
    unload(Chunk) - Method in class redempt.redlib.blockdata.BlockDataManager
    +
    unload(Chunk) - Method in class redempt.redlib.blockdata.BlockDataManager
    Saves and unloads all of the DataBlocks in a chunk
    -
    unload(World, int, int) - Method in class redempt.redlib.blockdata.BlockDataManager
    +
    unload(World, int, int) - Method in class redempt.redlib.blockdata.BlockDataManager
    Saves and unloads all of the DataBlocks in a chunk
    -
    unloadAll() - Method in class redempt.redlib.blockdata.BlockDataManager
    +
    unloadAll() - Method in class redempt.redlib.blockdata.BlockDataManager
    Saves and unloads all DataBlocks from this BlockDataManager
    -
    unprotect() - Method in class redempt.redlib.protection.ProtectedRegion
    +
    unprotect() - Method in class redempt.redlib.protection.ProtectedRegion
    Disables all protections for this region
    -
    unregister() - Method in class redempt.redlib.misc.EventListener
    +
    unregister() - Method in class redempt.redlib.misc.EventListener
    Unregisters this listener
    -
    unwrapArgs(Object...) - Static method in class redempt.redlib.nms.NMSHelper
    +
    unwrapArgs(Object...) - Static method in class redempt.redlib.nms.NMSHelper
    Unwraps an array of arguments, replacing NMSObjects with their wrapped values
    -
    up(Player, int) - Method in class redempt.redlib.dev.profiler.ProfilerCommands
    +
    up(Player, int) - Method in class redempt.redlib.dev.profiler.ProfilerCommands
     
    -
    update() - Method in class redempt.redlib.inventorygui.InventoryGUI
    +
    update() - Method in class redempt.redlib.inventorygui.InventoryGUI
    Refresh the inventory.
    -
    update(Object, Object...) - Method in class redempt.redlib.sql.SQLCache
    +
    update(Object, Object...) - Method in class redempt.redlib.sql.SQLCache
    Updates the cached value for a row
    -
    USE_BUCKETS - redempt.redlib.protection.ProtectionPolicy.ProtectionType
    +
    USE_BUCKETS - redempt.redlib.protection.ProtectionPolicy.ProtectionType
    Players using buckets to place or collect liquids
    -
    UserCache - Class in redempt.redlib.misc
    +
    UserCache - Class in redempt.redlib.misc
    A cache of offline users by name which can be queried without worrying about web requests
    -
    UserCache() - Constructor for class redempt.redlib.misc.UserCache
    +
    UserCache() - Constructor for class redempt.redlib.misc.UserCache
     
    - - - -

    V

    -
    -
    value() - Method in annotation type redempt.redlib.commandmanager.CommandHook
    +

    V

    +
    +
    value() - Method in annotation type redempt.redlib.commandmanager.CommandHook
     
    -
    value() - Method in annotation type redempt.redlib.configmanager.annotations.ConfigValue
    +
    value() - Method in annotation type redempt.redlib.configmanager.annotations.ConfigValue
     
    -
    valueOf(String) - Static method in enum redempt.redlib.blockdata.events.DataBlockDestroyEvent.DestroyCause
    +
    valueOf(String) - Static method in enum redempt.redlib.blockdata.events.DataBlockDestroyEvent.DestroyCause
    Returns the enum constant of this type with the specified name.
    -
    valueOf(String) - Static method in enum redempt.redlib.commandmanager.Command.SenderType
    +
    valueOf(String) - Static method in enum redempt.redlib.commandmanager.Command.SenderType
    Returns the enum constant of this type with the specified name.
    -
    valueOf(String) - Static method in enum redempt.redlib.configmanager.ConversionType
    +
    valueOf(String) - Static method in enum redempt.redlib.configmanager.ConversionType
    Returns the enum constant of this type with the specified name.
    -
    valueOf(String) - Static method in enum redempt.redlib.itemutils.ItemTrait
    +
    valueOf(String) - Static method in enum redempt.redlib.itemutils.ItemTrait
    Returns the enum constant of this type with the specified name.
    -
    valueOf(String) - Static method in enum redempt.redlib.misc.ChatPrompt.CancelReason
    +
    valueOf(String) - Static method in enum redempt.redlib.misc.ChatPrompt.CancelReason
    Returns the enum constant of this type with the specified name.
    -
    valueOf(String) - Static method in enum redempt.redlib.misc.Task.TaskType
    +
    valueOf(String) - Static method in enum redempt.redlib.misc.Task.TaskType
    Returns the enum constant of this type with the specified name.
    -
    valueOf(String) - Static method in enum redempt.redlib.protection.ProtectionPolicy.ProtectionType
    +
    valueOf(String) - Static method in enum redempt.redlib.protection.ProtectionPolicy.ProtectionType
    Returns the enum constant of this type with the specified name.
    -
    valueOf(String) - Static method in enum redempt.redlib.region.events.RegionEnterEvent.EnterCause
    +
    valueOf(String) - Static method in enum redempt.redlib.region.events.RegionEnterEvent.EnterCause
    Returns the enum constant of this type with the specified name.
    -
    valueOf(String) - Static method in enum redempt.redlib.region.events.RegionExitEvent.ExitCause
    +
    valueOf(String) - Static method in enum redempt.redlib.region.events.RegionExitEvent.ExitCause
    Returns the enum constant of this type with the specified name.
    -
    values() - Static method in enum redempt.redlib.blockdata.events.DataBlockDestroyEvent.DestroyCause
    +
    values() - Static method in enum redempt.redlib.blockdata.events.DataBlockDestroyEvent.DestroyCause
    Returns an array containing the constants of this enum type, in the order they are declared.
    -
    values() - Static method in enum redempt.redlib.commandmanager.Command.SenderType
    +
    values() - Static method in enum redempt.redlib.commandmanager.Command.SenderType
    Returns an array containing the constants of this enum type, in the order they are declared.
    -
    values() - Static method in enum redempt.redlib.configmanager.ConversionType
    +
    values() - Static method in enum redempt.redlib.configmanager.ConversionType
    Returns an array containing the constants of this enum type, in the order they are declared.
    -
    values() - Static method in enum redempt.redlib.itemutils.ItemTrait
    +
    values() - Static method in enum redempt.redlib.itemutils.ItemTrait
    Returns an array containing the constants of this enum type, in the order they are declared.
    -
    values() - Static method in enum redempt.redlib.misc.ChatPrompt.CancelReason
    +
    values() - Static method in enum redempt.redlib.misc.ChatPrompt.CancelReason
    Returns an array containing the constants of this enum type, in the order they are declared.
    -
    values() - Static method in enum redempt.redlib.misc.Task.TaskType
    +
    values() - Static method in enum redempt.redlib.misc.Task.TaskType
    Returns an array containing the constants of this enum type, in the order they are declared.
    -
    values() - Static method in enum redempt.redlib.protection.ProtectionPolicy.ProtectionType
    +
    values() - Static method in enum redempt.redlib.protection.ProtectionPolicy.ProtectionType
    Returns an array containing the constants of this enum type, in the order they are declared.
    -
    values() - Static method in enum redempt.redlib.region.events.RegionEnterEvent.EnterCause
    +
    values() - Static method in enum redempt.redlib.region.events.RegionEnterEvent.EnterCause
    Returns an array containing the constants of this enum type, in the order they are declared.
    -
    values() - Static method in enum redempt.redlib.region.events.RegionExitEvent.ExitCause
    +
    values() - Static method in enum redempt.redlib.region.events.RegionExitEvent.ExitCause
    Returns an array containing the constants of this enum type, in the order they are declared.
    -
    verbose(Player) - Method in class redempt.redlib.dev.profiler.ProfilerCommands
    +
    verbose(Player) - Method in class redempt.redlib.dev.profiler.ProfilerCommands
     
    -
    visualize(Player, Location, int, int, int) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    +
    visualize(Player, Location, int, int, int) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    Sends ghost blocks of this multi-block structure to the given player at the given location
    -
    visualize(Player, Location, int, int, int, int, boolean) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    +
    visualize(Player, Location, int, int, int, int, boolean) - Method in class redempt.redlib.multiblock.MultiBlockStructure
    Sends ghost blocks of this multi-block structure to the given player at the given location
    - - - -

    W

    -
    -
    waitForWorld(String, Consumer<World>) - Static method in class redempt.redlib.misc.LocationUtils
    +

    W

    +
    +
    waitForWorld(String, Consumer<World>) - Static method in class redempt.redlib.misc.LocationUtils
    Waits for a world with the given name to load before calling the callback
    -
    WeightedRandom<T> - Class in redempt.redlib.misc
    +
    WeightedRandom<T> - Class in redempt.redlib.misc
    Uses a map of outcomes to weights to get random values
    -
    WeightedRandom() - Constructor for class redempt.redlib.misc.WeightedRandom
    +
    WeightedRandom() - Constructor for class redempt.redlib.misc.WeightedRandom
    Create an empty WeightedRandom
    -
    WeightedRandom(Map<T, Integer>) - Constructor for class redempt.redlib.misc.WeightedRandom
    +
    WeightedRandom(Map<T, Integer>) - Constructor for class redempt.redlib.misc.WeightedRandom
    -
    Deprecated. -
    Use WeightedRandom.fromIntMap(Map)
    +
    Deprecated. +
    Use WeightedRandom.fromIntMap(Map)
    -
    WITHER - redempt.redlib.protection.ProtectionPolicy.ProtectionType
    +
    WITHER - redempt.redlib.protection.ProtectionPolicy.ProtectionType
    Wither spawning in and breaking blocks around it
    -
    withPriority(EventPriority) - Method in class redempt.redlib.enchants.trigger.EnchantTrigger
    +
    withPriority(EventPriority) - Method in class redempt.redlib.enchants.trigger.EnchantTrigger
    Creates a copy of this EnchantTrigger with a different EventPriority
    -
    wrap(Player, String...) - Static method in class redempt.redlib.misc.PlayerWrapper
    +
    wrap(Player, String...) - Static method in class redempt.redlib.misc.PlayerWrapper
    Wraps a player using a Proxy, disabling some methods from being called.
    -
    wrap(T) - Static method in class redempt.redlib.misc.EntityPersistor
    +
    wrap(T) - Static method in class redempt.redlib.misc.EntityPersistor
    Wraps an Entity in an EntityPersistor.
    -A B C D E F G H I J K L M N O P Q R S T U V W 
    All Classes All Packages
    -
    +A B C D E F G H I J K L M N O P Q R S T U V W 
    All Classes|All Packages +
    +
    diff --git a/javadoc/index.html b/javadoc/index.html index fed4acd..b186bd3 100644 --- a/javadoc/index.html +++ b/javadoc/index.html @@ -5,46 +5,29 @@ Overview (RedLib API) + + - + + - - - - - + + - - -
    +
    + +
    +

    RedLib API

    -
    -
    - - +
    +
    Packages 
    + + - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Packages
    PackageDescriptionPackageDescription
    redempt.redlib 
    redempt.redlib 
    redempt.redlib.blockdata 
    redempt.redlib.blockdata 
    redempt.redlib.blockdata.events 
    redempt.redlib.blockdata.events 
    redempt.redlib.commandmanager 
    redempt.redlib.commandmanager 
    redempt.redlib.commandmanager.exceptions 
    redempt.redlib.commandmanager.exceptions 
    redempt.redlib.configmanager 
    redempt.redlib.configmanager 
    redempt.redlib.configmanager.annotations 
    redempt.redlib.configmanager.annotations 
    redempt.redlib.configmanager.exceptions 
    redempt.redlib.configmanager.exceptions 
    redempt.redlib.dev 
    redempt.redlib.dev 
    redempt.redlib.dev.profiler 
    redempt.redlib.dev.profiler 
    redempt.redlib.enchants 
    redempt.redlib.enchants 
    redempt.redlib.enchants.events 
    redempt.redlib.enchants.events 
    redempt.redlib.enchants.trigger 
    redempt.redlib.enchants.trigger 
    redempt.redlib.inventorygui 
    redempt.redlib.inventorygui 
    redempt.redlib.itemutils 
    redempt.redlib.itemutils 
    redempt.redlib.json 
    redempt.redlib.json 
    redempt.redlib.misc 
    redempt.redlib.misc 
    redempt.redlib.multiblock 
    redempt.redlib.multiblock 
    redempt.redlib.nms 
    redempt.redlib.nms 
    redempt.redlib.protection 
    redempt.redlib.protection 
    redempt.redlib.region 
    redempt.redlib.region 
    redempt.redlib.region.events 
    redempt.redlib.region.events 
    redempt.redlib.sql 
    redempt.redlib.sql 
    redempt.redlib.worldgen 
    redempt.redlib.worldgen 
    @@ -205,15 +165,10 @@

    RedLib API

    + + +
    +
    +
    diff --git a/javadoc/jquery-ui.overrides.css b/javadoc/jquery-ui.overrides.css new file mode 100644 index 0000000..f89acb6 --- /dev/null +++ b/javadoc/jquery-ui.overrides.css @@ -0,0 +1,34 @@ +/* + * Copyright (c) 2020, 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; +} diff --git a/javadoc/jquery/external/jquery/jquery.js b/javadoc/jquery/external/jquery/jquery.js deleted file mode 100644 index 5093733..0000000 --- a/javadoc/jquery/external/jquery/jquery.js +++ /dev/null @@ -1,10872 +0,0 @@ -/*! - * 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/jquery/jszip-utils/dist/jszip-utils-ie.min.js b/javadoc/jquery/jszip-utils/dist/jszip-utils-ie.min.js deleted file mode 100644 index 93d8bc8..0000000 --- a/javadoc/jquery/jszip-utils/dist/jszip-utils-ie.min.js +++ /dev/null @@ -1,10 +0,0 @@ -/*! - -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/jquery/jszip-utils/dist/jszip-utils.js b/javadoc/jquery/jszip-utils/dist/jszip-utils.js deleted file mode 100644 index 775895e..0000000 --- a/javadoc/jquery/jszip-utils/dist/jszip-utils.js +++ /dev/null @@ -1,118 +0,0 @@ -/*! - -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 DataLengthProbe = require('./stream/DataLengthProbe'); -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 compresion. - * @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 informations 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 informations - * 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 emited 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" : {...} - // } - this.files = {}; - - 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.2.0"; - -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 utils = require('./utils'); -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; - for (filename in this.files) { - if (!this.files.hasOwnProperty(filename)) { - continue; - } - 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... - } - } - }, - - /** - * 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 prefered 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 occurence of a zip signature (4 bytes). - * @param {string} sig the signature to find. - * @return {number} the index of the last occurence, -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 informations 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 informations 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 < end) { - extraFieldId = reader.readInt(2); - extraFieldLength = reader.readInt(2); - extraFieldValue = reader.readData(extraFieldLength); - - this.extraFields[extraFieldId] = { - id: extraFieldId, - length: extraFieldLength, - value: extraFieldValue - }; - } - }, - /** - * 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 - - - +
    + + + + diff --git a/javadoc/redempt/redlib/blockdata/BlockDataManager.html b/javadoc/redempt/redlib/blockdata/BlockDataManager.html index 2d310c1..39d74b0 100644 --- a/javadoc/redempt/redlib/blockdata/BlockDataManager.html +++ b/javadoc/redempt/redlib/blockdata/BlockDataManager.html @@ -5,985 +5,797 @@ BlockDataManager (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.blockdata
    -

    Class BlockDataManager

    +
    Package redempt.redlib.blockdata
    +

    Class BlockDataManager

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.blockdata.BlockDataManager
        • -
      -
      • -
    -
    -
      -
    • -
      +
      java.lang.Object +
      redempt.redlib.blockdata.BlockDataManager
      +
      +
      +
      All Implemented Interfaces:
      org.bukkit.event.Listener
      -
      public class BlockDataManager
+
      public class BlockDataManager
 extends java.lang.Object
 implements org.bukkit.event.Listener
      
 
      Manages DataBlock instances, which allow you to attach persistent metadata to blocks,
  Keeps track of managed blocks, removing data if a block is destroyed or moving it if a block is pushed
  by a piston.
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Field Summary

          - - +
        • +
          +

          Field Summary

          +
          +
          • Fields 
          + + - - - - - - - - - + + + + + + + + + + + +
          Fields
          Modifier and TypeFieldDescription
          protected SQLHelpersql 
          Modifier and TypeFieldDescription
          protected SQLHelpersql 
          -
          • -
        +
    + -
    -
      -
    • - - -

      Constructor Summary

      - - +
    • +
      +

      Constructor Summary

      +
      +
      • Constructors 
      + + - - - - - - + + + + + + + +
      Constructors
      ConstructorDescription
      BlockDataManager​(java.nio.file.Path saveFile) +ConstructorDescription
      BlockDataManager​(java.nio.file.Path saveFile)
      Create a BlockDataManager instance with a save file location, to be saved to and loaded from.
      -
      • -
    +
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Static Methods Instance Methods Concrete Methods 
      + - - - - - - - - - - - - - + + + + + + + + + + + + + + - - - - + + + + - - - - + + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + - - - - + + + - - - - + + + +
      Modifier and TypeMethodDescription
      protected java.util.Set<DataBlock>ensureExists​(org.bukkit.World world, - redempt.redlib.blockdata.BlockDataManager.ChunkPosition pos) 
      java.util.Set<DataBlock>getAll() +Modifier and TypeMethodDescription
      protected java.util.Set<DataBlock>ensureExists​(org.bukkit.World world, +redempt.redlib.blockdata.BlockDataManager.ChunkPosition pos) 
      java.util.Set<DataBlock>getAll()
      Loads and returns a set of all DataBlocks managed by this BlockDataManager.
      java.util.Set<DataBlock>getAllLoaded() 
      java.util.Set<DataBlock>getAllLoaded() 
      static java.util.List<BlockDataManager>getAllManagers() 
      static java.util.List<BlockDataManager>getAllManagers() 
      DataBlockgetDataBlock​(org.bukkit.block.Block block) +
      DataBlockgetDataBlock​(org.bukkit.block.Block block)
      Gets a DataBlock from a given Block, creating a new one if that Block had no data attached to it.
      DataBlockgetExisting​(org.bukkit.block.Block block) +
      DataBlockgetExisting​(org.bukkit.block.Block block)
      Gets an existing DataBlock, returning null if that Block has no data attached to it.
      java.util.Set<DataBlock>getLoaded​(org.bukkit.Chunk chunk) +
      java.util.Set<DataBlock>getLoaded​(org.bukkit.Chunk chunk)
      Gets all the loaded DataBlocks in a chunk
      java.util.Set<DataBlock>getLoaded​(org.bukkit.World world, - int cx, - int cz) +
      java.util.Set<DataBlock>getLoaded​(org.bukkit.World world, +int cx, +int cz)
      Gets all the loaded DataBlocks in a chunk
      java.util.Set<DataBlock>getNearby​(org.bukkit.Location loc, - int radius) +
      java.util.Set<DataBlock>getNearby​(org.bukkit.Location loc, +int radius)
      Gets all the DataBlocks near an approximate location
      booleanisChunkLoaded​(org.bukkit.Chunk chunk) 
      booleanisChunkLoaded​(org.bukkit.World world, - int cx, - int cz) 
      java.util.Set<DataBlock>load​(org.bukkit.Chunk chunk) +
      booleanisChunkLoaded​(org.bukkit.Chunk chunk) 
      booleanisChunkLoaded​(org.bukkit.World world, +int cx, +int cz) 
      java.util.Set<DataBlock>load​(org.bukkit.Chunk chunk)
      Loads all of the DataBlocks in a given chunk, or retrieves the already-loaded set of DataBlocks
      java.util.Set<DataBlock>load​(org.bukkit.World world, - int cx, - int cz) +
      java.util.Set<DataBlock>load​(org.bukkit.World world, +int cx, +int cz)
      Loads all of the DataBlocks in a given chunk, or retrieves the already-loaded set of DataBlocks
      voidonBlockExplode​(org.bukkit.event.block.BlockExplodeEvent e) 
      voidonBlockPull​(org.bukkit.event.block.BlockPistonRetractEvent e) 
      voidonBlockPush​(org.bukkit.event.block.BlockPistonExtendEvent e) 
      voidonBreakBlock​(org.bukkit.event.block.BlockBreakEvent e) 
      voidonBucketEmpty​(org.bukkit.event.player.PlayerBucketEmptyEvent e) 
      voidonBurnBlock​(org.bukkit.event.block.BlockBurnEvent e) 
      voidonChunkUnload​(org.bukkit.event.world.ChunkUnloadEvent e) 
      voidonEntityExplode​(org.bukkit.event.entity.EntityExplodeEvent e) 
      voidonFlowBreakBlock​(org.bukkit.event.block.BlockFromToEvent e) 
      protected voidregister​(DataBlock db) 
      voidremove​(DataBlock db) +
      voidonBlockExplode​(org.bukkit.event.block.BlockExplodeEvent e) 
      voidonBlockPull​(org.bukkit.event.block.BlockPistonRetractEvent e) 
      voidonBlockPush​(org.bukkit.event.block.BlockPistonExtendEvent e) 
      voidonBreakBlock​(org.bukkit.event.block.BlockBreakEvent e) 
      voidonBucketEmpty​(org.bukkit.event.player.PlayerBucketEmptyEvent e) 
      voidonBurnBlock​(org.bukkit.event.block.BlockBurnEvent e) 
      voidonChunkUnload​(org.bukkit.event.world.ChunkUnloadEvent e) 
      voidonEntityExplode​(org.bukkit.event.entity.EntityExplodeEvent e) 
      voidonFlowBreakBlock​(org.bukkit.event.block.BlockFromToEvent e) 
      protected voidregister​(DataBlock db) 
      voidremove​(DataBlock db)
      Removes a DataBlock from this DataBlockManager
      voidsave() +
      voidsave()
      Saves all data to the save file.
      voidsaveAndClose() +
      voidsaveAndClose()
      Saves all data to the save file, and closes the SQL connection.
      voidsetAutoSave​(boolean autoSave) +
      voidsetAutoSave​(boolean autoSave)
      Sets whether this BlockDataManager will automatically save every 5 minutes.
      voidsetAutoUnload​(boolean autoUnload) +
      voidsetAutoUnload​(boolean autoUnload)
      Sets whether this BlockDataManager will automatically unload chunks of DataBlocks when a chunk is unloaded
      protected redempt.redlib.blockdata.BlockDataManager.ChunkPositiontoChunkPosition​(org.bukkit.block.Block block) 
      protected redempt.redlib.blockdata.BlockDataManager.ChunkPositiontoChunkPosition​(org.bukkit.Location loc) 
      protected java.util.Optional<java.util.Set<DataBlock>>tryExists​(org.bukkit.World world, - redempt.redlib.blockdata.BlockDataManager.ChunkPosition pos) 
      voidunload​(org.bukkit.Chunk chunk) +
      protected redempt.redlib.blockdata.BlockDataManager.ChunkPositiontoChunkPosition​(org.bukkit.block.Block block) 
      protected redempt.redlib.blockdata.BlockDataManager.ChunkPositiontoChunkPosition​(org.bukkit.Location loc) 
      protected java.util.Optional<java.util.Set<DataBlock>>tryExists​(org.bukkit.World world, +redempt.redlib.blockdata.BlockDataManager.ChunkPosition pos) 
      voidunload​(org.bukkit.Chunk chunk)
      Saves and unloads all of the DataBlocks in a chunk
      voidunload​(org.bukkit.World world, - int cx, - int cz) +
      voidunload​(org.bukkit.World world, +int cx, +int cz)
      Saves and unloads all of the DataBlocks in a chunk
      voidunloadAll() +
      voidunloadAll()
      Saves and unloads all DataBlocks from this BlockDataManager
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

    Methods inherited from class java.lang.Object

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

          Field Detail

          - - - - +
        • +
          +

          Field Details

          +
          +
          • -
          -
            -
          • - - -

            Constructor Detail

            - - - -
              -
            • -

              BlockDataManager

              -
              public BlockDataManager​(java.nio.file.Path saveFile)
              +
            • +
              +

              Constructor Details

              +
                +
              • +
                +

                BlockDataManager

                +
                public BlockDataManager​(java.nio.file.Path saveFile)
                Create a BlockDataManager instance with a save file location, to be saved to and loaded from. This constructor immediately loads from the given file.
                -
                -
                Parameters:
                +
                +
                Parameters:
                saveFile - The Path to load from immediately, and save to when save is called
                -
                • -
              +
          + -
          -
            -
          • - - -

            Method Detail

            - - - -
              -
            • -

              getAllManagers

              -
              public static java.util.List<BlockDataManager> getAllManagers()
              -
              -
              Returns:
              +
            • +
              +

              Method Details

              +
                +
              • +
                +

                getAllManagers

                +
                public static java.util.List<BlockDataManager> getAllManagers()
                +
                +
                Returns:
                The list of all active BlockDataManagers
                +
                • -
              - - - -
                -
              • -

                setAutoSave

                -
                public void setAutoSave​(boolean autoSave)
                +
              • +
                +

                setAutoSave

                +
                public void setAutoSave​(boolean autoSave)
                Sets whether this BlockDataManager will automatically save every 5 minutes. Defaults to true.
                -
                -
                Parameters:
                +
                +
                Parameters:
                autoSave - Whether to save automatically every 5 minutes
                +
                • -
              - - - -
                -
              • -

                setAutoUnload

                -
                public void setAutoUnload​(boolean autoUnload)
                +
              • +
                +

                setAutoUnload

                +
                public void setAutoUnload​(boolean autoUnload)
                Sets whether this BlockDataManager will automatically unload chunks of DataBlocks when a chunk is unloaded
                -
                -
                Parameters:
                +
                +
                Parameters:
                autoUnload - Whether to automatically unload DataBlocks
                +
                • -
              - - - -
                -
              • -

                save

                -
                public void save()
                +
              • +
                +

                save

                +
                public void save()
                Saves all data to the save file.
                +
                • -
              - - - -
                -
              • -

                saveAndClose

                -
                public void saveAndClose()
                +
              • +
                +

                saveAndClose

                +
                public void saveAndClose()
                Saves all data to the save file, and closes the SQL connection. Call this in your onDisable.
                +
                • -
              - - - -
                -
              • -

                ensureExists

                -
                protected java.util.Set<DataBlock> ensureExists​(org.bukkit.World world,
-                                                redempt.redlib.blockdata.BlockDataManager.ChunkPosition pos)
                +
              • +
                +

                ensureExists

                +
                protected java.util.Set<DataBlock> ensureExists​(org.bukkit.World world, +redempt.redlib.blockdata.BlockDataManager.ChunkPosition pos)
                +
                • -
              - - - -
                -
              • -

                tryExists

                -
                protected java.util.Optional<java.util.Set<DataBlock>> tryExists​(org.bukkit.World world,
-                                                                 redempt.redlib.blockdata.BlockDataManager.ChunkPosition pos)
                +
              • +
                +

                tryExists

                +
                protected java.util.Optional<java.util.Set<DataBlock>> tryExists​(org.bukkit.World world, +redempt.redlib.blockdata.BlockDataManager.ChunkPosition pos)
                +
                • -
              - - - -
                -
              • -

                toChunkPosition

                -
                protected redempt.redlib.blockdata.BlockDataManager.ChunkPosition toChunkPosition​(org.bukkit.Location loc)
                +
              • +
                +

                toChunkPosition

                +
                protected redempt.redlib.blockdata.BlockDataManager.ChunkPosition toChunkPosition​(org.bukkit.Location loc)
                +
                • -
              - - - -
                -
              • -

                toChunkPosition

                -
                protected redempt.redlib.blockdata.BlockDataManager.ChunkPosition toChunkPosition​(org.bukkit.block.Block block)
                +
              • +
                +

                toChunkPosition

                +
                protected redempt.redlib.blockdata.BlockDataManager.ChunkPosition toChunkPosition​(org.bukkit.block.Block block)
                +
                • -
              - - - -
                -
              • -

                getExisting

                -
                public DataBlock getExisting​(org.bukkit.block.Block block)
                +
              • +
                +

                getExisting

                +
                public DataBlock getExisting​(org.bukkit.block.Block block)
                Gets an existing DataBlock, returning null if that Block has no data attached to it.
                -
                -
                Parameters:
                +
                +
                Parameters:
                block - The block to check
                -
                Returns:
                +
                Returns:
                A DataBlock, or null
                +
                • -
              - - - -
                -
              • -

                getDataBlock

                -
                public DataBlock getDataBlock​(org.bukkit.block.Block block)
                +
              • +
                +

                getDataBlock

                +
                public DataBlock getDataBlock​(org.bukkit.block.Block block)
                Gets a DataBlock from a given Block, creating a new one if that Block had no data attached to it.
                -
                -
                Parameters:
                +
                +
                Parameters:
                block - The block to check or create a DataBlock from
                -
                Returns:
                +
                Returns:
                An existing or new DataBlock
                +
                • -
              - - - -
                -
              • -

                register

                -
                protected void register​(DataBlock db)
                +
              • +
                +

                register

                +
                protected void register​(DataBlock db)
                +
                • -
              - - - -
                -
              • -

                remove

                -
                public void remove​(DataBlock db)
                +
              • +
                +

                remove

                +
                public void remove​(DataBlock db)
                Removes a DataBlock from this DataBlockManager
                -
                -
                Parameters:
                +
                +
                Parameters:
                db - The DataBlock to remove
                +
                • -
              - - - -
                -
              • -

                getNearby

                -
                public java.util.Set<DataBlock> getNearby​(org.bukkit.Location loc,
-                                          int radius)
                +
              • +
                +

                getNearby

                +
                public java.util.Set<DataBlock> getNearby​(org.bukkit.Location loc, +int radius)
                Gets all the DataBlocks near an approximate location
                -
                -
                Parameters:
                +
                +
                Parameters:
                loc - The location to check near
                radius - The radius to check in
                -
                Returns:
                +
                Returns:
                The nearby DataBlocks
                +
                • -
              - - - -
                -
              • -

                getLoaded

                -
                public java.util.Set<DataBlock> getLoaded​(org.bukkit.Chunk chunk)
                +
              • +
                +

                getLoaded

                +
                public java.util.Set<DataBlock> getLoaded​(org.bukkit.Chunk chunk)
                Gets all the loaded DataBlocks in a chunk
                -
                -
                Parameters:
                +
                +
                Parameters:
                chunk - The chunk to get the loaded DataBlocks in
                -
                Returns:
                +
                Returns:
                A set of DataBlocks in the chunk, or null if the chunk is not loaded
                +
                • -
              - - - -
                -
              • -

                getLoaded

                -
                public java.util.Set<DataBlock> getLoaded​(org.bukkit.World world,
-                                          int cx,
-                                          int cz)
                +
              • +
                +

                getLoaded

                +
                public java.util.Set<DataBlock> getLoaded​(org.bukkit.World world, +int cx, +int cz)
                Gets all the loaded DataBlocks in a chunk
                -
                -
                Parameters:
                +
                +
                Parameters:
                world - The world the chunk is in
                cx - The chunk X
                cz - The chunk Z
                -
                Returns:
                +
                Returns:
                A set of DataBlocks in the chunk, or an empty set if the chunk is not loaded
                +
                • -
              - - - -
                -
              • -

                load

                -
                public java.util.Set<DataBlock> load​(org.bukkit.World world,
-                                     int cx,
-                                     int cz)
                +
              • +
                +

                load

                +
                public java.util.Set<DataBlock> load​(org.bukkit.World world, +int cx, +int cz)
                Loads all of the DataBlocks in a given chunk, or retrieves the already-loaded set of DataBlocks
                -
                -
                Parameters:
                +
                +
                Parameters:
                world - The world the chunk is in
                cx - The chunk X
                cz - The chunk Z
                -
                Returns:
                +
                Returns:
                The set of DataBlocks in the chunk
                +
                • -
              - - - -
                -
              • -

                load

                -
                public java.util.Set<DataBlock> load​(org.bukkit.Chunk chunk)
                +
              • +
                +

                load

                +
                public java.util.Set<DataBlock> load​(org.bukkit.Chunk chunk)
                Loads all of the DataBlocks in a given chunk, or retrieves the already-loaded set of DataBlocks
                -
                -
                Parameters:
                +
                +
                Parameters:
                chunk - The chunk to load DataBlocks in
                -
                Returns:
                +
                Returns:
                The set of DataBlocks in the chunk
                +
                • -
              - - - -
                -
              • -

                unload

                -
                public void unload​(org.bukkit.World world,
-                   int cx,
-                   int cz)
                +
              • +
                +

                unload

                +
                public void unload​(org.bukkit.World world, +int cx, +int cz)
                Saves and unloads all of the DataBlocks in a chunk
                -
                -
                Parameters:
                +
                +
                Parameters:
                world - The world the chunk is in
                cx - The chunk X
                cz - The chunk Z
                +
                • -
              - - - -
                -
              • -

                unload

                -
                public void unload​(org.bukkit.Chunk chunk)
                +
              • +
                +

                unload

                +
                public void unload​(org.bukkit.Chunk chunk)
                Saves and unloads all of the DataBlocks in a chunk
                -
                -
                Parameters:
                +
                +
                Parameters:
                chunk - The chunk to unload the DataBlocks in
                +
                • -
              - - - -
                -
              • -

                unloadAll

                -
                public void unloadAll()
                +
              • +
                +

                unloadAll

                +
                public void unloadAll()
                Saves and unloads all DataBlocks from this BlockDataManager
                +
                • -
              - - - -
                -
              • -

                isChunkLoaded

                -
                public boolean isChunkLoaded​(org.bukkit.Chunk chunk)
                -
                -
                Parameters:
                +
              • +
                +

                isChunkLoaded

                +
                public boolean isChunkLoaded​(org.bukkit.Chunk chunk)
                +
                +
                Parameters:
                chunk - The chunk to check
                -
                Returns:
                +
                Returns:
                Whether the DataBlocks in the chunk are loaded in this BlockDataManager
                +
                • -
              - - - -
                -
              • -

                isChunkLoaded

                -
                public boolean isChunkLoaded​(org.bukkit.World world,
-                             int cx,
-                             int cz)
                -
                -
                Parameters:
                +
              • +
                +

                isChunkLoaded

                +
                public boolean isChunkLoaded​(org.bukkit.World world, +int cx, +int cz)
                +
                +
                Parameters:
                world - The world the chunk is in
                cx - The X coordinate of the chunk
                cz - The Z coordinate of the chunk
                -
                Returns:
                +
                Returns:
                Whether the DataBlocks in the chunk are loaded in this BlockDataManager
                +
                • -
              - - - -
                -
              • -

                getAllLoaded

                -
                public java.util.Set<DataBlock> getAllLoaded()
                -
                -
                Returns:
                +
              • +
                +

                getAllLoaded

                +
                public java.util.Set<DataBlock> getAllLoaded()
                +
                +
                Returns:
                The set of all loaded DataBlocks
                +
                • -
              - - - -
                -
              • -

                getAll

                -
                public java.util.Set<DataBlock> getAll()
                +
              • +
                +

                getAll

                +
                public java.util.Set<DataBlock> getAll()
                Loads and returns a set of all DataBlocks managed by this BlockDataManager. Avoid calling this if possible. Will not return DataBlocks in unloaded worlds.
                -
                -
                Returns:
                +
                +
                Returns:
                The set of all DataBlocks managed by this BlockDataManager
                +
                • -
              - - - -
                -
              • -

                onBreakBlock

                -
                public void onBreakBlock​(org.bukkit.event.block.BlockBreakEvent e)
                -
                • -
              - - - -
                -
              • -

                onBucketEmpty

                -
                public void onBucketEmpty​(org.bukkit.event.player.PlayerBucketEmptyEvent e)
                +
              • +
                +

                onBreakBlock

                +
                public void onBreakBlock​(org.bukkit.event.block.BlockBreakEvent e)
                +
                • -
              - - - -
                -
              • -

                onFlowBreakBlock

                -
                public void onFlowBreakBlock​(org.bukkit.event.block.BlockFromToEvent e)
                +
              • +
                +

                onBucketEmpty

                +
                public void onBucketEmpty​(org.bukkit.event.player.PlayerBucketEmptyEvent e)
                +
                • -
              - - - -
                -
              • -

                onBurnBlock

                -
                public void onBurnBlock​(org.bukkit.event.block.BlockBurnEvent e)
                +
              • +
                +

                onFlowBreakBlock

                +
                public void onFlowBreakBlock​(org.bukkit.event.block.BlockFromToEvent e)
                +
                • -
              - - - -
                -
              • -

                onEntityExplode

                -
                public void onEntityExplode​(org.bukkit.event.entity.EntityExplodeEvent e)
                +
              • +
                +

                onBurnBlock

                +
                public void onBurnBlock​(org.bukkit.event.block.BlockBurnEvent e)
                +
                • -
              - - - -
                -
              • -

                onBlockExplode

                -
                public void onBlockExplode​(org.bukkit.event.block.BlockExplodeEvent e)
                +
              • +
                +

                onEntityExplode

                +
                public void onEntityExplode​(org.bukkit.event.entity.EntityExplodeEvent e)
                +
                • -
              - - - -
                -
              • -

                onBlockPush

                -
                public void onBlockPush​(org.bukkit.event.block.BlockPistonExtendEvent e)
                +
              • +
                +

                onBlockExplode

                +
                public void onBlockExplode​(org.bukkit.event.block.BlockExplodeEvent e)
                +
                • -
              - - - -
                -
              • -

                onBlockPull

                -
                public void onBlockPull​(org.bukkit.event.block.BlockPistonRetractEvent e)
                +
              • +
                +

                onBlockPush

                +
                public void onBlockPush​(org.bukkit.event.block.BlockPistonExtendEvent e)
                +
                • -
              - - - -
                -
              • -

                onChunkUnload

                -
                public void onChunkUnload​(org.bukkit.event.world.ChunkUnloadEvent e)
                +
              • +
                +

                onBlockPull

                +
                public void onBlockPull​(org.bukkit.event.block.BlockPistonRetractEvent e)
                +
                • -
              +
            • +
              +

              onChunkUnload

              +
              public void onChunkUnload​(org.bukkit.event.world.ChunkUnloadEvent e)
              +
        -
    - - + + + + diff --git a/javadoc/redempt/redlib/blockdata/CustomBlock.html b/javadoc/redempt/redlib/blockdata/CustomBlock.html index 441b50f..9a76adc 100644 --- a/javadoc/redempt/redlib/blockdata/CustomBlock.html +++ b/javadoc/redempt/redlib/blockdata/CustomBlock.html @@ -5,365 +5,270 @@ CustomBlock (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.blockdata
    -

    Class CustomBlock

    +
    Package redempt.redlib.blockdata
    +

    Class CustomBlock

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.blockdata.CustomBlock
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      redempt.redlib.blockdata.CustomBlock
      +
      +
      -
      public class CustomBlock
+
      public class CustomBlock
 extends java.lang.Object
      
 
      Represents an instance of a CustomBlockType. Effectively a wrapper for DataBlock.
      
-
      • -
    -
    -
    -
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Instance Methods Concrete Methods 
      + - - - + + + - - - - + + + + + - - - - + + + + - - - - + + + + - - - - + + + + +
      Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
      voidclick​(org.bukkit.event.player.PlayerInteractEvent e) +
      voidclick​(org.bukkit.event.player.PlayerInteractEvent e)
      Called when this CustomBlock is clicked.
      org.bukkit.block.BlockgetBlock() 
      org.bukkit.block.BlockgetBlock() 
      DataBlockgetDataBlock() 
      DataBlockgetDataBlock() 
      CustomBlockType<?>getType() 
      CustomBlockType<?>getType() 
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

    Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - - +
        • +
          +

          Constructor Details

          +
          +
          • -
          -
            -
          • - - -

            Method Detail

            - - - -
              -
            • -

              getDataBlock

              -
              public DataBlock getDataBlock()
              -
              -
              Returns:
              +
            • +
              +

              Method Details

              +
                +
              • +
                +

                getDataBlock

                +
                public DataBlock getDataBlock()
                +
                +
                Returns:
                The DataBlock this CustomBlock wraps
                +
                • -
              - - - -
                -
              • -

                getBlock

                -
                public org.bukkit.block.Block getBlock()
                -
                -
                Returns:
                +
              • +
                +

                getBlock

                +
                public org.bukkit.block.Block getBlock()
                +
                +
                Returns:
                The Block this CustomBlock is at
                +
                • -
              - - - -
                -
              • -

                getType

                -
                public CustomBlockType<?> getType()
                -
                -
                Returns:
                +
              • +
                +

                getType

                +
                public CustomBlockType<?> getType()
                +
                +
                Returns:
                The CustomBlockType which created this CustomBlock
                +
                • -
              - - - -
                -
              • -

                click

                -
                public void click​(org.bukkit.event.player.PlayerInteractEvent e)
                +
              • +
                +

                click

                +
                public void click​(org.bukkit.event.player.PlayerInteractEvent e)
                Called when this CustomBlock is clicked. Does nothing by default, override to define custom behavior.
                -
                -
                Parameters:
                +
                +
                Parameters:
                e - The event
                -
                • -
              +
        -
    - - + + + + diff --git a/javadoc/redempt/redlib/blockdata/CustomBlockRegistry.html b/javadoc/redempt/redlib/blockdata/CustomBlockRegistry.html index fa08c25..b802f58 100644 --- a/javadoc/redempt/redlib/blockdata/CustomBlockRegistry.html +++ b/javadoc/redempt/redlib/blockdata/CustomBlockRegistry.html @@ -5,539 +5,417 @@ CustomBlockRegistry (RedLib API) + + - + + - - - - - + + - - -
    +
    +
    + + + +
    - +
    +
    -
    Package redempt.redlib.blockdata
    -

    Class CustomBlockRegistry

    +
    Package redempt.redlib.blockdata
    +

    Class CustomBlockRegistry

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.blockdata.CustomBlockRegistry
        • -
      -
      • -
    -
    -
      -
    • -
      +
      java.lang.Object +
      redempt.redlib.blockdata.CustomBlockRegistry
      +
      +
      +
      All Implemented Interfaces:
      org.bukkit.event.Listener
      -
      public class CustomBlockRegistry
+
      public class CustomBlockRegistry
 extends java.lang.Object
 implements org.bukkit.event.Listener
      
 
      Loads and registers CustomBlockTypes
      
-
      • -
    -
    -
    -
    + -
    - +
    +
    +
    +

    Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - -
            -
          • -

            CustomBlockRegistry

            -
            public CustomBlockRegistry​(BlockDataManager manager)
            +
          • +
            +

            Constructor Details

            +
              +
            • +
              +

              CustomBlockRegistry

              +
              public CustomBlockRegistry​(BlockDataManager manager)
              Construct a CustomBlockRegistry without passing a plugin. Use this constructor if you plan to use registerAll(Plugin).
              -
              -
              Parameters:
              +
              +
              Parameters:
              manager - The BlockDataManager to use for managing block data
              +
              • -
            - - - -
              -
            • -

              CustomBlockRegistry

              -
              public CustomBlockRegistry​(BlockDataManager manager,
-                           org.bukkit.plugin.Plugin plugin)
              +
            • +
              +

              CustomBlockRegistry

              +
              public CustomBlockRegistry​(BlockDataManager manager, +org.bukkit.plugin.Plugin plugin)
              Construct a CustomBlockRegistry, passing a plugin. Use this constructor if you plan to use register(CustomBlockType)
              -
              -
              Parameters:
              +
              +
              Parameters:
              manager - The BlockDataManager to use for managing block data
              plugin - The Plugin to register events with
              -
              • -
            +
        + -
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            getAllRegistries

            -
            public static java.util.List<CustomBlockRegistry> getAllRegistries()
            -
            -
            Returns:
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              getAllRegistries

              +
              public static java.util.List<CustomBlockRegistry> getAllRegistries()
              +
              +
              Returns:
              All active CustomBlockRegistries
              +
              • -
            - - - -
              -
            • -

              getManager

              -
              public BlockDataManager getManager()
              -
              -
              Returns:
              +
            • +
              +

              getManager

              +
              public BlockDataManager getManager()
              +
              +
              Returns:
              The BlockDataManager managing block data for this CustomBlockRegistry
              +
              • -
            - - - -
              -
            • -

              registerAll

              -
              public void registerAll​(org.bukkit.plugin.Plugin plugin)
              +
            • +
              +

              registerAll

              +
              public void registerAll​(org.bukkit.plugin.Plugin plugin)
              Looks through all classes in a Plugin, registering all classes which extend CustomBlockType that are not interfaces or abstract. Each one must have a constructor that takes no arguments in order to be registered.
              -
              -
              Parameters:
              +
              +
              Parameters:
              plugin - The Plugin to register the CustomBlockTypes with
              +
              • -
            - - - -
              -
            • -

              register

              -
              public void register​(CustomBlockType<?> type)
              +
            • +
              +

              register

              +
              public void register​(CustomBlockType<?> type)
              Registers a single CustomBlockType into this CustomBlockRegistry
              -
              -
              Parameters:
              +
              +
              Parameters:
              type - The CustomBlockType to register
              +
              • -
            - - - -
              -
            • -

              getByName

              -
              public CustomBlockType<?> getByName​(java.lang.String name)
              +
            • +
              +

              getByName

              +
              public CustomBlockType<?> getByName​(java.lang.String name)
              Gets a CustomBlockType by name
              -
              -
              Parameters:
              +
              +
              Parameters:
              name - The name of the CustomBlockType
              -
              Returns:
              +
              Returns:
              The CustomBlockType with the given name
              +
              • -
            - - - -
              -
            • -

              getTypes

              -
              public java.util.Collection<CustomBlockType<?>> getTypes()
              -
              -
              Returns:
              +
            • +
              +

              getTypes

              +
              public java.util.Collection<CustomBlockType<?>> getTypes()
              +
              +
              Returns:
              A collection of all CustomBlockTypes in this registry
              +
              • -
            - - - -
              -
            • -

              getCustomBlock

              -
              public <T extends CustomBlock> T getCustomBlock​(org.bukkit.block.Block block)
              +
            • +
              +

              getCustomBlock

              +
              public <T extends CustomBlock> T getCustomBlock​(org.bukkit.block.Block block)
              Gets a CustomBlock instance with the correct CustomBlockType
              -
              -
              Type Parameters:
              +
              +
              Type Parameters:
              T - The type of the CustomBlock
              -
              Parameters:
              +
              Parameters:
              block - The Block to check
              -
              Returns:
              +
              Returns:
              The CustomBlock, or null if it was not a custom block
              +
              • -
            - - - -
              -
            • -

              onClick

              -
              public void onClick​(org.bukkit.event.player.PlayerInteractEvent e)
              -
              • -
            - - - -
              -
            • -

              onPlace

              -
              public <T extends CustomBlock> void onPlace​(org.bukkit.event.block.BlockPlaceEvent e)
              +
            • +
              +

              onClick

              +
              public void onClick​(org.bukkit.event.player.PlayerInteractEvent e)
              +
              • -
            - - - - - - - -
              -
            • -

              onPickBlock

              -
              public <T extends CustomBlock> void onPickBlock​(org.bukkit.event.inventory.InventoryCreativeEvent e)
              +
            • +
              +

              onBreak

              +
              public <T extends CustomBlock> void onBreak​(DataBlockDestroyEvent e)
              +
              • -
            - - - -
              -
            • -

              onDisable

              -
              public void onDisable​(org.bukkit.event.server.PluginDisableEvent e)
              +
            • +
              +

              onPickBlock

              +
              public <T extends CustomBlock> void onPickBlock​(org.bukkit.event.inventory.InventoryCreativeEvent e)
              +
              • -
            +
          • +
            +

            onDisable

            +
            public void onDisable​(org.bukkit.event.server.PluginDisableEvent e)
            +
      -
    - - + + + + diff --git a/javadoc/redempt/redlib/blockdata/CustomBlockType.html b/javadoc/redempt/redlib/blockdata/CustomBlockType.html index ef01904..e6a36c6 100644 --- a/javadoc/redempt/redlib/blockdata/CustomBlockType.html +++ b/javadoc/redempt/redlib/blockdata/CustomBlockType.html @@ -5,561 +5,436 @@ CustomBlockType (RedLib API) + + - + + - - - - - + + - - -
    +
    +
    + + + +
    - +
    +
    -
    Package redempt.redlib.blockdata
    -

    Class CustomBlockType<T extends CustomBlock>

    +
    Package redempt.redlib.blockdata
    +

    Class CustomBlockType<T extends CustomBlock>

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.blockdata.CustomBlockType<T>
        • -
      -
      • -
    -
    -
      -
    • -
      -
      Type Parameters:
      +
      java.lang.Object +
      redempt.redlib.blockdata.CustomBlockType<T>
      +
      +
      +
      +
      Type Parameters:
      T - The type of the CustomBlock represented by this CustomBlockType
      -
      +
      All Implemented Interfaces:
      org.bukkit.event.Listener
      -
      public abstract class CustomBlockType<T extends CustomBlock>
+
      public abstract class CustomBlockType<T extends CustomBlock>
 extends java.lang.Object
 implements org.bukkit.event.Listener
      
 
      Represents a type of a CustomBlock that can be set
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Constructor Summary

          - - +
        • +
          +

          Constructor Summary

          +
          +
          • Constructors 
          + + - - + + - - - + + + + +
          Constructors
          ConstructorDescriptionConstructorDescription
          CustomBlockType​(java.lang.String typeName) +
          CustomBlockType​(java.lang.String typeName)
          Construct a CustomBlockType with the type name.
          -
          • -
        +
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Instance Methods Abstract Methods Concrete Methods 
      + - - - + + + - - - - + + + + + - - - - + + + - - - - + + + + - - - - + + + - - - - + + + + - - - - + + + - - - - + + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + + - - - - + + + +
      Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
      Tget​(org.bukkit.block.Block block) +
      Tget​(org.bukkit.block.Block block)
      Gets a CustomBlock of this type at the given block
      Tget​(DataBlock db) +
      Tget​(DataBlock db)
      Gets a CustomBlock of this type from the given DataBlock
      abstract java.lang.StringgetBaseItemName() 
      abstract java.lang.StringgetBaseItemName() 
      TgetCustom​(DataBlock db) +
      TgetCustom​(DataBlock db)
      Defines a custom return for a class extending CustomBlock
      java.util.List<org.bukkit.inventory.ItemStack>getDrops​(T block) 
      java.util.List<org.bukkit.inventory.ItemStack>getDrops​(T block) 
      abstract org.bukkit.inventory.ItemStackgetItem​(T block) +
      abstract org.bukkit.inventory.ItemStackgetItem​(T block)
      Gets the item to be dropped when this block is mined
      java.lang.StringgetName() 
      java.lang.StringgetName() 
      Tinitialize​(org.bukkit.block.Block block) +
      Tinitialize​(org.bukkit.block.Block block)
      Initializes the placement of this CustomBlockType for the given Block.
      booleanitemMatches​(org.bukkit.inventory.ItemStack item) +
      booleanitemMatches​(org.bukkit.inventory.ItemStack item)
      Checks whether the item given matches the item for this CustomBlockType
      abstract voidplace​(org.bukkit.entity.Player player, - org.bukkit.inventory.ItemStack item, - T block) +
      abstract voidplace​(org.bukkit.entity.Player player, +org.bukkit.inventory.ItemStack item, +T block)
      Called when this CustomBlockType is placed.
      protected voidregister​(BlockDataManager manager) 
      protected voidregister​(BlockDataManager manager) 
      booleantypeMatches​(org.bukkit.Material material) +
      booleantypeMatches​(org.bukkit.Material material)
      Checks whether the type of a block matches this CustomBlockType.
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

    Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - -
            -
          • -

            CustomBlockType

            -
            public CustomBlockType​(java.lang.String typeName)
            +
          • +
            +

            Constructor Details

            +
              +
            • +
              +

              CustomBlockType

              +
              public CustomBlockType​(java.lang.String typeName)
              Construct a CustomBlockType with the type name. You should only call this if you don't use CustomBlockRegistry.registerAll(Plugin) to load custom block types.
              -
              -
              Parameters:
              +
              +
              Parameters:
              typeName - The name of this type
              -
              • -
            +
        + -
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            itemMatches

            -
            public boolean itemMatches​(org.bukkit.inventory.ItemStack item)
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              itemMatches

              +
              public boolean itemMatches​(org.bukkit.inventory.ItemStack item)
              Checks whether the item given matches the item for this CustomBlockType
              -
              -
              Parameters:
              +
              +
              Parameters:
              item - The ItemStack to check
              -
              Returns:
              +
              Returns:
              Whether the item matches
              +
              • -
            - - - - - -
              -
            • -

              place

              -
              public abstract void place​(org.bukkit.entity.Player player,
-                           org.bukkit.inventory.ItemStack item,
-                           T block)
              +
            • +
              +

              place

              +
              public abstract void place​(org.bukkit.entity.Player player, +org.bukkit.inventory.ItemStack item, +T block)
              Called when this CustomBlockType is placed. Use it to initialize any fields that are needed.
              -
              -
              Parameters:
              +
              +
              Parameters:
              player - The player who placed the CustomBlock
              item - The ItemStack in their hand when it was placed
              block - The CustomBlock storing the data
              +
              • -
            - - - - - -
              -
            • -

              getItem

              -
              public abstract org.bukkit.inventory.ItemStack getItem​(T block)
              +
            • +
              +

              getItem

              +
              public abstract org.bukkit.inventory.ItemStack getItem​(T block)
              Gets the item to be dropped when this block is mined
              -
              -
              Parameters:
              +
              +
              Parameters:
              block - The CustomBlock that was mined
              -
              Returns:
              +
              Returns:
              The ItemStack to drop
              +
              • -
            - - - - - -
              -
            • -

              getDrops

              -
              public java.util.List<org.bukkit.inventory.ItemStack> getDrops​(T block)
              +
            • +
              +

              getDrops

              +
              public java.util.List<org.bukkit.inventory.ItemStack> getDrops​(T block)
              +
              • -
            - - - -
              -
            • -

              getBaseItemName

              -
              public abstract java.lang.String getBaseItemName()
              -
              -
              Returns:
              +
            • +
              +

              getBaseItemName

              +
              public abstract java.lang.String getBaseItemName()
              +
              +
              Returns:
              A unique item name that the item for this CustomBlockType will have
              +
              • -
            - - - - - - - -
              -
            • -

              typeMatches

              -
              public boolean typeMatches​(org.bukkit.Material material)
              +
            • +
              +

              typeMatches

              +
              public boolean typeMatches​(org.bukkit.Material material)
              Checks whether the type of a block matches this CustomBlockType. Always returns true by default.
              -
              -
              Parameters:
              +
              +
              Parameters:
              material - The Material to check
              -
              Returns:
              +
              Returns:
              Whether this Material matches the type for this CustomBlockType
              +
              • -
            - - - -
              -
            • -

              getName

              -
              public java.lang.String getName()
              -
              -
              Returns:
              +
            • +
              +

              getName

              +
              public java.lang.String getName()
              +
              +
              Returns:
              The name of this CustomBlockType
              +
              • -
            - - - -
              -
            • -

              getCustom

              -
              public T getCustom​(DataBlock db)
              +
            • +
              +

              getCustom

              +
              public T getCustom​(DataBlock db)
              Defines a custom return for a class extending CustomBlock
              -
              -
              Parameters:
              +
              +
              Parameters:
              db - The DataBlock to be passed to the constructor
              -
              Returns:
              +
              Returns:
              The CustomBlock sub-class instance
              +
              • -
            - - - -
              -
            • -

              get

              -
              public final T get​(org.bukkit.block.Block block)
              +
            • +
              +

              get

              +
              public final T get​(org.bukkit.block.Block block)
              Gets a CustomBlock of this type at the given block
              -
              -
              Parameters:
              +
              +
              Parameters:
              block - The Block to get the CustomBlock at
              -
              Returns:
              +
              Returns:
              The CustomBlock of this type at this Block, or null if it is not present
              +
              • -
            - - - -
              -
            • -

              get

              -
              public final T get​(DataBlock db)
              +
            • +
              +

              get

              +
              public final T get​(DataBlock db)
              Gets a CustomBlock of this type from the given DataBlock
              -
              -
              Parameters:
              +
              +
              Parameters:
              db - The DataBlock to get the CustomBlock at
              -
              Returns:
              +
              Returns:
              The CustomBlock of this type represented by this DataBlock, or null if it is not present
              +
              • -
            - - - -
              -
            • -

              initialize

              -
              public final T initialize​(org.bukkit.block.Block block)
              +
            • +
              +

              initialize

              +
              public final T initialize​(org.bukkit.block.Block block)
              Initializes the placement of this CustomBlockType for the given Block. Does not change the block's vanilla type.
              -
              -
              Parameters:
              +
              +
              Parameters:
              block - The block to initialize
              -
              Returns:
              +
              Returns:
              The initialized CustomBlock
              -
              • -
            +
      -
    - - + + + + diff --git a/javadoc/redempt/redlib/blockdata/DataBlock.html b/javadoc/redempt/redlib/blockdata/DataBlock.html index 197a2b5..9b74115 100644 --- a/javadoc/redempt/redlib/blockdata/DataBlock.html +++ b/javadoc/redempt/redlib/blockdata/DataBlock.html @@ -5,970 +5,791 @@ DataBlock (RedLib API) + + - + + - - - - - + + - - -
    +
    +
    + + + +
    - +
    +
    -
    Package redempt.redlib.blockdata
    -

    Class DataBlock

    +
    Package redempt.redlib.blockdata
    +

    Class DataBlock

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.blockdata.DataBlock
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      redempt.redlib.blockdata.DataBlock
      +
      +
      -
      public class DataBlock
+
      public class DataBlock
 extends java.lang.Object
      
 
      Represents a Block with various data attached to it
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Field Summary

          - - +
        • +
          +

          Field Summary

          +
          +
          • Fields 
          + + - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + +
          Fields
          Modifier and TypeFieldDescription
          protected JSONMapdata 
          protected booleanexists 
          Modifier and TypeFieldDescription
          protected JSONMapdata 
          protected booleanexists 
          -
          • -
        +
    + -
    -
      -
    • - - -

      Constructor Summary

      - - +
    • +
      +

      Constructor Summary

      +
      +
      • Constructors 
      + + - - - - - - - - - + + + + + + + + + + + +
      Constructors
      ModifierConstructorDescription
      protected DataBlock​(org.bukkit.block.Block block, - BlockDataManager manager) 
      ModifierConstructorDescription
      protected DataBlock​(org.bukkit.block.Block block, +BlockDataManager manager) 
      -
      • -
    +
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Instance Methods Concrete Methods 
      + - - - - - - - - + + + + + + + + + - - - - + + + - - - - + + + - - - - + + + + - - - - + + + - - - - + + + + - - - - + + + - - - - + + + + - - - - + + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + + - - - - + + + - - - - + + + - - - - + + + - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + + - - - - + + + - - - - + + + + - - - - + + + - - - - + + + - - - - + + + +
      Modifier and TypeMethodDescription
      voidclear() +Modifier and TypeMethodDescription
      voidclear()
      Removes all of the data from this block.
      booleancontains​(java.lang.String key) +
      booleancontains​(java.lang.String key)
      Checks to see if an object is associated with the key provided.
      booleancontainsTransientProperty​(java.lang.String key) +
      booleancontainsTransientProperty​(java.lang.String key)
      Checks to see if a transient property is associated with the key provided.
      booleanequals​(java.lang.Object o) 
      booleanequals​(java.lang.Object o) 
      java.lang.Objectget​(java.lang.String key) +
      java.lang.Objectget​(java.lang.String key)
      Gets the object mapped to a certain key
      org.bukkit.block.BlockgetBlock() 
      org.bukkit.block.BlockgetBlock() 
      booleangetBoolean​(java.lang.String key) +
      booleangetBoolean​(java.lang.String key)
      Gets a boolean mapped to a certain key
      int[]getChunkCoordinates() 
      int[]getChunkCoordinates() 
      JSONMapgetData() 
      JSONMapgetData() 
      doublegetDouble​(java.lang.String key) +
      doublegetDouble​(java.lang.String key)
      Gets a double mapped to a certain key
      intgetInt​(java.lang.String key) +
      intgetInt​(java.lang.String key)
      Gets an int mapped to a certain key
      JSONListgetList​(java.lang.String key) +
      JSONListgetList​(java.lang.String key)
      Gets a JSONList mapped to a certain key
      longgetLong​(java.lang.String key) +
      longgetLong​(java.lang.String key)
      Gets a double mapped to a certain key
      BlockDataManagergetManager() 
      BlockDataManagergetManager() 
      JSONMapgetMap​(java.lang.String key) +
      JSONMapgetMap​(java.lang.String key)
      Gets a JSONMap mapped to a certain key
      java.lang.StringgetString​(java.lang.String key) +
      java.lang.StringgetString​(java.lang.String key)
      Gets a String mapped to a certain key
      java.lang.ObjectgetTransientProperty​(java.lang.String key) +
      java.lang.ObjectgetTransientProperty​(java.lang.String key)
      Gets a transient property associated with the given key
      org.bukkit.WorldgetWorld() 
      inthashCode() 
      booleanisLoaded() 
      voidmove​(org.bukkit.block.Block block) +
      org.bukkit.WorldgetWorld() 
      inthashCode() 
      booleanisLoaded() 
      voidmove​(org.bukkit.block.Block block)
      Moves the data in this DataBlock to a new Block
      voidremove() +
      voidremove()
      Removes this DataBlock and all the data associated with it
      voidremove​(java.lang.String key) +
      voidremove​(java.lang.String key)
      Removes the object associated with a certain key.
      voidremoveTransientProperty​(java.lang.String key) +
      voidremoveTransientProperty​(java.lang.String key)
      Removes a transient property by its key
      protected voidsave() 
      protected voidsave() 
      voidset​(java.lang.String key, - java.lang.Object data) +
      voidset​(java.lang.String key, +java.lang.Object data)
      Sets a data value in this DataBlock.
      protected voidsetData​(JSONMap data) 
      protected voidsetData​(JSONMap data) 
      voidsetIfAbsent​(java.lang.String key, - java.lang.Object data) +
      voidsetIfAbsent​(java.lang.String key, +java.lang.Object data)
      Sets a data value, if absent, in this DataBlock.
      voidsetTransientProperty​(java.lang.String key, - java.lang.Object o) +
      voidsetTransientProperty​(java.lang.String key, +java.lang.Object o)
      Attaches a transient property to this DataBlock.
      voidsetTransientPropertyIfAbsent​(java.lang.String key, - java.lang.Object o) +
      voidsetTransientPropertyIfAbsent​(java.lang.String key, +java.lang.Object o)
      Attaches a transient property, if absent, to this DataBlock.
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

    Methods inherited from class java.lang.Object

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

          Field Detail

          - - - -
            -
          • -

            data

            -
            protected JSONMap data
            -
            • -
          - - - -
            -
          • -

            exists

            -
            protected boolean exists
            +
          • +
            +

            Field Details

            +
              +
            • +
              +

              data

              +
              protected JSONMap data
              +
              • -
            +
          • +
            +

            exists

            +
            protected boolean exists
            +
        - -
        -
          -
        • - - -

          Constructor Detail

          - - - -
            -
          • -

            DataBlock

            -
            protected DataBlock​(org.bukkit.block.Block block,
-                    BlockDataManager manager)
            • -
          + +
        • +
          +

          Constructor Details

          +
            +
          • +
            +

            DataBlock

            +
            protected DataBlock​(org.bukkit.block.Block block, +BlockDataManager manager)
            +
          +
          • -
          -
            -
          • - - -

            Method Detail

            - - - -
              -
            • -

              getTransientProperty

              -
              public java.lang.Object getTransientProperty​(java.lang.String key)
              +
            • +
              +

              Method Details

              +
                +
              • +
                +

                getTransientProperty

                +
                public java.lang.Object getTransientProperty​(java.lang.String key)
                Gets a transient property associated with the given key
                -
                -
                Parameters:
                +
                +
                Parameters:
                key - The key
                -
                Returns:
                +
                Returns:
                The transient property
                +
                • -
              - - - -
                -
              • -

                removeTransientProperty

                -
                public void removeTransientProperty​(java.lang.String key)
                +
              • +
                +

                removeTransientProperty

                +
                public void removeTransientProperty​(java.lang.String key)
                Removes a transient property by its key
                -
                -
                Parameters:
                +
                +
                Parameters:
                key - The key of the transient property
                +
                • -
              - - - -
                -
              • -

                setTransientProperty

                -
                public void setTransientProperty​(java.lang.String key,
-                                 java.lang.Object o)
                +
              • +
                +

                setTransientProperty

                +
                public void setTransientProperty​(java.lang.String key, +java.lang.Object o)
                Attaches a transient property to this DataBlock. Transient properties are not saved and will be lost if the chunk is unloaded or the server is stopped
                -
                -
                Parameters:
                +
                +
                Parameters:
                key - The key of the transient property
                o - The value of the transient property
                +
                • -
              - - - -
                -
              • -

                setTransientPropertyIfAbsent

                -
                public void setTransientPropertyIfAbsent​(java.lang.String key,
-                                         java.lang.Object o)
                +
              • +
                +

                setTransientPropertyIfAbsent

                +
                public void setTransientPropertyIfAbsent​(java.lang.String key, +java.lang.Object o)
                Attaches a transient property, if absent, to this DataBlock. Transient properties are not saved and will be lost if the chunk is unloaded or the server is stopped
                -
                -
                Parameters:
                +
                +
                Parameters:
                key - The key of the transient property
                o - The value of the transient property
                +
                • -
              - - - -
                -
              • -

                containsTransientProperty

                -
                public boolean containsTransientProperty​(java.lang.String key)
                +
              • +
                +

                containsTransientProperty

                +
                public boolean containsTransientProperty​(java.lang.String key)
                Checks to see if a transient property is associated with the key provided.
                -
                -
                Parameters:
                +
                +
                Parameters:
                key - The key
                -
                Returns:
                +
                Returns:
                true if this DataBlock contains a transient property for the specified key
                +
                • -
              - - - -
                -
              • -

                set

                -
                public void set​(java.lang.String key,
-                java.lang.Object data)
                +
              • +
                +

                set

                +
                public void set​(java.lang.String key, +java.lang.Object data)
                Sets a data value in this DataBlock. If this is the first piece of data attached to this DataBlock, it will be added to the map of the BlockDataManager it was created by.
                -
                -
                Parameters:
                +
                +
                Parameters:
                key - The key to put the data at
                data - The data to put
                +
                • -
              - - - -
                -
              • -

                setIfAbsent

                -
                public void setIfAbsent​(java.lang.String key,
-                        java.lang.Object data)
                +
              • +
                +

                setIfAbsent

                +
                public void setIfAbsent​(java.lang.String key, +java.lang.Object data)
                Sets a data value, if absent, in this DataBlock. If this is the first piece of data attached to this DataBlock, it will be added to the map of the BlockDataManager it was created by.
                -
                -
                Parameters:
                +
                +
                Parameters:
                key - The key to put the data at
                data - The data to put
                +
                • -
              - - - -
                -
              • -

                setData

                -
                protected void setData​(JSONMap data)
                +
              • +
                +

                setData

                +
                protected void setData​(JSONMap data)
                +
                • -
              - - - -
                -
              • -

                get

                -
                public java.lang.Object get​(java.lang.String key)
                +
              • +
                +

                get

                +
                public java.lang.Object get​(java.lang.String key)
                Gets the object mapped to a certain key
                -
                -
                Parameters:
                +
                +
                Parameters:
                key - The key
                -
                Returns:
                +
                Returns:
                The object mapped to the key
                +
                • -
              - - - -
                -
              • -

                getInt

                -
                public int getInt​(java.lang.String key)
                +
              • +
                +

                getInt

                +
                public int getInt​(java.lang.String key)
                Gets an int mapped to a certain key
                -
                -
                Parameters:
                +
                +
                Parameters:
                key - The key
                -
                Returns:
                +
                Returns:
                The int mapped to the key
                +
                • -
              - - - -
                -
              • -

                getString

                -
                public java.lang.String getString​(java.lang.String key)
                +
              • +
                +

                getString

                +
                public java.lang.String getString​(java.lang.String key)
                Gets a String mapped to a certain key
                -
                -
                Parameters:
                +
                +
                Parameters:
                key - The key
                -
                Returns:
                +
                Returns:
                The String mapped to the key
                +
                • -
              - - - -
                -
              • -

                getBoolean

                -
                public boolean getBoolean​(java.lang.String key)
                +
              • +
                +

                getBoolean

                +
                public boolean getBoolean​(java.lang.String key)
                Gets a boolean mapped to a certain key
                -
                -
                Parameters:
                +
                +
                Parameters:
                key - The key
                -
                Returns:
                +
                Returns:
                The boolean mapped to the key
                +
                • -
              - - - -
                -
              • -

                getDouble

                -
                public double getDouble​(java.lang.String key)
                +
              • +
                +

                getDouble

                +
                public double getDouble​(java.lang.String key)
                Gets a double mapped to a certain key
                -
                -
                Parameters:
                +
                +
                Parameters:
                key - The key
                -
                Returns:
                +
                Returns:
                The double mapped to the key
                +
                • -
              - - - -
                -
              • -

                getLong

                -
                public long getLong​(java.lang.String key)
                +
              • +
                +

                getLong

                +
                public long getLong​(java.lang.String key)
                Gets a double mapped to a certain key
                -
                -
                Parameters:
                +
                +
                Parameters:
                key - The key
                -
                Returns:
                +
                Returns:
                The double mapped to the key
                +
                • -
              - - - -
                -
              • -

                getMap

                -
                public JSONMap getMap​(java.lang.String key)
                +
              • +
                +

                getMap

                +
                public JSONMap getMap​(java.lang.String key)
                Gets a JSONMap mapped to a certain key
                -
                -
                Parameters:
                +
                +
                Parameters:
                key - The key
                -
                Returns:
                +
                Returns:
                The JSONMap mapped to the key
                +
                • -
              - - - -
                -
              • -

                getList

                -
                public JSONList getList​(java.lang.String key)
                +
              • +
                +

                getList

                +
                public JSONList getList​(java.lang.String key)
                Gets a JSONList mapped to a certain key
                -
                -
                Parameters:
                +
                +
                Parameters:
                key - The key
                -
                Returns:
                +
                Returns:
                The JSONList mapped to the key
                +
                • -
              - - - -
                -
              • -

                remove

                -
                public void remove​(java.lang.String key)
                +
              • +
                +

                remove

                +
                public void remove​(java.lang.String key)
                Removes the object associated with a certain key. If this object is the last one stored in this DataBlock, this DataBlock will be removed from its BlockDataManager.
                -
                -
                Parameters:
                +
                +
                Parameters:
                key - The key
                +
                • -
              - - - -
                -
              • -

                contains

                -
                public boolean contains​(java.lang.String key)
                +
              • +
                +

                contains

                +
                public boolean contains​(java.lang.String key)
                Checks to see if an object is associated with the key provided.
                -
                -
                Parameters:
                +
                +
                Parameters:
                key - The key
                -
                Returns:
                +
                Returns:
                true if this DataBlock contains an object for the specified key
                +
                • -
              - - - -
                -
              • -

                clear

                -
                public void clear()
                +
              • +
                +

                clear

                +
                public void clear()
                Removes all of the data from this block.
                +
                • -
              - - - -
                -
              • -

                move

                -
                public void move​(org.bukkit.block.Block block)
                +
              • +
                +

                move

                +
                public void move​(org.bukkit.block.Block block)
                Moves the data in this DataBlock to a new Block
                -
                -
                Parameters:
                +
                +
                Parameters:
                block - The Block to move the data to
                +
                • -
              - - - -
                -
              • -

                getData

                -
                public JSONMap getData()
                -
                -
                Returns:
                +
              • +
                +

                getData

                +
                public JSONMap getData()
                +
                +
                Returns:
                All the data stored in this DataBlock
                +
                • -
              - - - -
                -
              • -

                save

                -
                protected void save()
                +
              • +
                +

                save

                +
                protected void save()
                +
                • -
              - - - -
                -
              • -

                isLoaded

                -
                public boolean isLoaded()
                -
                -
                Returns:
                +
              • +
                +

                isLoaded

                +
                public boolean isLoaded()
                +
                +
                Returns:
                Whether the chunk this DataBlock is in is loaded
                +
                • -
              - - - -
                -
              • -

                getChunkCoordinates

                -
                public int[] getChunkCoordinates()
                -
                -
                Returns:
                +
              • +
                +

                getChunkCoordinates

                +
                public int[] getChunkCoordinates()
                +
                +
                Returns:
                The chunk coordinates [x, z] of this DataBlock
                +
                • -
              - - - -
                -
              • -

                getWorld

                -
                public org.bukkit.World getWorld()
                -
                -
                Returns:
                +
              • +
                +

                getWorld

                +
                public org.bukkit.World getWorld()
                +
                +
                Returns:
                The World this DataBlock is in
                +
                • -
              - - - -
                -
              • -

                remove

                -
                public void remove()
                +
              • +
                +

                remove

                +
                public void remove()
                Removes this DataBlock and all the data associated with it
                +
                • -
              - - - -
                -
              • -

                getBlock

                -
                public org.bukkit.block.Block getBlock()
                -
                -
                Returns:
                +
              • +
                +

                getBlock

                +
                public org.bukkit.block.Block getBlock()
                +
                +
                Returns:
                The Block this DataBlock stores data for
                +
                • -
              - - - -
                -
              • -

                getManager

                -
                public BlockDataManager getManager()
                -
                -
                Returns:
                +
              • +
                +

                getManager

                +
                public BlockDataManager getManager()
                +
                +
                Returns:
                The BlockDataManager managing this DataBlock
                +
                • -
              - - - -
                -
              • -

                hashCode

                -
                public int hashCode()
                -
                -
                Overrides:
                +
              • +
                +

                hashCode

                +
                public int hashCode()
                +
                +
                Overrides:
                hashCode in class java.lang.Object
                +
                • -
              - - - -
                -
              • -

                equals

                -
                public boolean equals​(java.lang.Object o)
                -
                -
                Overrides:
                +
              • +
                +

                equals

                +
                public boolean equals​(java.lang.Object o)
                +
                +
                Overrides:
                equals in class java.lang.Object
                -
                • -
              +
        -
    - - + + + + diff --git a/javadoc/redempt/redlib/blockdata/events/CustomBlockPlaceEvent.html b/javadoc/redempt/redlib/blockdata/events/CustomBlockPlaceEvent.html index 0be213b..5b0e9cd 100644 --- a/javadoc/redempt/redlib/blockdata/events/CustomBlockPlaceEvent.html +++ b/javadoc/redempt/redlib/blockdata/events/CustomBlockPlaceEvent.html @@ -5,487 +5,353 @@ CustomBlockPlaceEvent (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.blockdata.events
    -

    Class CustomBlockPlaceEvent

    +
    Package redempt.redlib.blockdata.events
    +

    Class CustomBlockPlaceEvent

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • org.bukkit.event.Event
        • -
      • -
          -
        • org.bukkit.event.block.BlockEvent
          • -
        • -
            -
          • redempt.redlib.blockdata.events.CustomBlockPlaceEvent
            • -
          -
          • -
        -
        • -
      -
      • -
    -
    -
      -
    • -
      +
      java.lang.Object +
      org.bukkit.event.Event +
      org.bukkit.event.block.BlockEvent +
      redempt.redlib.blockdata.events.CustomBlockPlaceEvent
      +
      +
      +
      +
      +
      All Implemented Interfaces:
      org.bukkit.event.Cancellable
      -
      public class CustomBlockPlaceEvent
+
      public class CustomBlockPlaceEvent
 extends org.bukkit.event.block.BlockEvent
 implements org.bukkit.event.Cancellable
      
 
      Called when a CustomBlock is placed by a Player
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Nested Class Summary

          -
            -
          • - - -

            Nested classes/interfaces inherited from class org.bukkit.event.Event

            -org.bukkit.event.Event.Result
            • -
          -
          • -
        +
      • +
        +

        Nested Class Summary

        +
        +

        Nested classes/interfaces inherited from class org.bukkit.event.Event

        +org.bukkit.event.Event.Result
        - -
        -
          -
        • - - -

          Field Summary

          -
            -
          • - - -

            Fields inherited from class org.bukkit.event.block.BlockEvent

            -block
            • -
          • -
        + +
      • +
        +

        Field Summary

        +
        +

        Fields inherited from class org.bukkit.event.block.BlockEvent

        +block
        +
        • -
        -
          -
        • - - -

          Constructor Summary

          - - +
        • +
          +

          Constructor Summary

          +
          +
          • Constructors 
          + + - - + + - - - + + + + +
          Constructors
          ConstructorDescriptionConstructorDescription
          CustomBlockPlaceEvent​(org.bukkit.block.Block block, - org.bukkit.inventory.ItemStack item, - CustomBlockType<?> type, - org.bukkit.entity.Player player) +
          CustomBlockPlaceEvent​(org.bukkit.block.Block block, +org.bukkit.inventory.ItemStack item, +CustomBlockType<?> type, +org.bukkit.entity.Player player)
          Constructs a new CustomBlockPlaceEvent
          -
          • -
        +
    + -
    - +
    +
    +
    +

    Methods inherited from class org.bukkit.event.block.BlockEvent

    +getBlock
    +
    +

    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

          - - - -
            -
          • -

            CustomBlockPlaceEvent

            -
            public CustomBlockPlaceEvent​(org.bukkit.block.Block block,
-                             org.bukkit.inventory.ItemStack item,
-                             CustomBlockType<?> type,
-                             org.bukkit.entity.Player player)
            +
          • +
            +

            Constructor Details

            +
              +
            • +
              +

              CustomBlockPlaceEvent

              +
              public CustomBlockPlaceEvent​(org.bukkit.block.Block block, +org.bukkit.inventory.ItemStack item, +CustomBlockType<?> type, +org.bukkit.entity.Player player)
              Constructs a new CustomBlockPlaceEvent
              -
              -
              Parameters:
              +
              +
              Parameters:
              block - The block that was placed
              item - The item used to break the block
              type - The type of CustomBlock that is being placed
              player - The Player that placed the block
              -
              • -
            +
        + -
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            getHandlerList

            -
            public static org.bukkit.event.HandlerList getHandlerList()
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              getHandlerList

              +
              public static org.bukkit.event.HandlerList getHandlerList()
              +
              • -
            - - - -
              -
            • -

              getPlayer

              -
              public org.bukkit.entity.Player getPlayer()
              -
              -
              Returns:
              +
            • +
              +

              getPlayer

              +
              public org.bukkit.entity.Player getPlayer()
              +
              +
              Returns:
              The Player that placed the CustomBlock
              +
              • -
            - - - -
              -
            • -

              getItem

              -
              public org.bukkit.inventory.ItemStack getItem()
              -
              -
              Returns:
              +
            • +
              +

              getItem

              +
              public org.bukkit.inventory.ItemStack getItem()
              +
              +
              Returns:
              The item that was in the player's hand when this block was placed
              +
              • -
            - - - -
              -
            • -

              getCustomBlockType

              -
              public CustomBlockType<?> getCustomBlockType()
              -
              -
              Returns:
              +
            • +
              +

              getCustomBlockType

              +
              public CustomBlockType<?> getCustomBlockType()
              +
              +
              Returns:
              The CustomBlockType that is being placed
              +
              • -
            - - - -
              -
            • -

              isCancelled

              -
              public boolean isCancelled()
              -
              -
              Specified by:
              +
            • +
              +

              isCancelled

              +
              public boolean isCancelled()
              +
              +
              Specified by:
              isCancelled in interface org.bukkit.event.Cancellable
              +
              • -
            - - - -
              -
            • -

              setCancelled

              -
              public void setCancelled​(boolean cancel)
              -
              -
              Specified by:
              +
            • +
              +

              setCancelled

              +
              public void setCancelled​(boolean cancel)
              +
              +
              Specified by:
              setCancelled in interface org.bukkit.event.Cancellable
              +
              • -
            - - - -
              -
            • -

              getHandlers

              -
              public org.bukkit.event.HandlerList getHandlers()
              -
              -
              Specified by:
              +
            • +
              +

              getHandlers

              +
              public org.bukkit.event.HandlerList getHandlers()
              +
              +
              Specified by:
              getHandlers in class org.bukkit.event.Event
              -
              • -
            +
      -
    - - + + + + diff --git a/javadoc/redempt/redlib/blockdata/events/DataBlockDestroyEvent.DestroyCause.html b/javadoc/redempt/redlib/blockdata/events/DataBlockDestroyEvent.DestroyCause.html index 4b3ecea..5063e07 100644 --- a/javadoc/redempt/redlib/blockdata/events/DataBlockDestroyEvent.DestroyCause.html +++ b/javadoc/redempt/redlib/blockdata/events/DataBlockDestroyEvent.DestroyCause.html @@ -5,414 +5,310 @@ DataBlockDestroyEvent.DestroyCause (RedLib API) + + - + + - - - - - + + - - -
    +
    +
    + + + +
    - +
    +
    -
    Package redempt.redlib.blockdata.events
    -

    Enum DataBlockDestroyEvent.DestroyCause

    +
    Package redempt.redlib.blockdata.events
    +

    Enum DataBlockDestroyEvent.DestroyCause

    -
    - -
    -
    -
    -
    + -
    - +
    +
    +
    +

    Methods inherited from class java.lang.Enum

    +clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
    +
    +

    Methods inherited from class java.lang.Object

    +getClass, notify, notifyAll, wait, wait, wait
    - -
    -
    +
    +
    Returns:
    an array containing the constants of this enum type, in the order they are declared
    + - - - - -
      -
    • -

      valueOf

      -
      public static DataBlockDestroyEvent.DestroyCause valueOf​(java.lang.String name)
      +
    • +
      +

      valueOf

      +
      public static DataBlockDestroyEvent.DestroyCause 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:
      +
      +
      Parameters:
      name - the name of the enum constant to be returned.
      -
      Returns:
      +
      Returns:
      the enum constant with the specified name
      -
      Throws:
      +
      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/redempt/redlib/blockdata/events/DataBlockDestroyEvent.html b/javadoc/redempt/redlib/blockdata/events/DataBlockDestroyEvent.html index 97c79dc..a178d48 100644 --- a/javadoc/redempt/redlib/blockdata/events/DataBlockDestroyEvent.html +++ b/javadoc/redempt/redlib/blockdata/events/DataBlockDestroyEvent.html @@ -5,526 +5,395 @@ DataBlockDestroyEvent (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.blockdata.events
    -

    Class DataBlockDestroyEvent

    +
    Package redempt.redlib.blockdata.events
    +

    Class DataBlockDestroyEvent

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • org.bukkit.event.Event
        • -
      • -
          -
        • org.bukkit.event.block.BlockEvent
          • -
        • -
            -
          • redempt.redlib.blockdata.events.DataBlockDestroyEvent
            • -
          -
          • -
        -
        • -
      -
      • -
    -
    -
      -
    • -
      +
      java.lang.Object +
      org.bukkit.event.Event +
      org.bukkit.event.block.BlockEvent +
      redempt.redlib.blockdata.events.DataBlockDestroyEvent
      +
      +
      +
      +
      +
      All Implemented Interfaces:
      org.bukkit.event.Cancellable
      -
      public class DataBlockDestroyEvent
+
      public class DataBlockDestroyEvent
 extends org.bukkit.event.block.BlockEvent
 implements org.bukkit.event.Cancellable
      
 
      Called when a DataBlock is destroyed by something other than a player
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Nested Class Summary

          - - +
        • +
          +

          Nested Class Summary

          +
          +
          • Nested Classes 
          + + - - - + + + - - - - + + + + + + +
          Nested Classes
          Modifier and TypeClassDescriptionModifier and TypeClassDescription
          static class DataBlockDestroyEvent.DestroyCause 
          static class DataBlockDestroyEvent.DestroyCause 
          -
            -
          • - - -

            Nested classes/interfaces inherited from class org.bukkit.event.Event

            -org.bukkit.event.Event.Result
            • -
          -
          • -
        +
    +
    +

    Nested classes/interfaces inherited from class org.bukkit.event.Event

    +org.bukkit.event.Event.Result
    - -
    -
      -
    • - - -

      Field Summary

      -
        -
      • - - -

        Fields inherited from class org.bukkit.event.block.BlockEvent

        -block
        • -
      • -
    + +
  • +
    +

    Field Summary

    +
    +

    Fields inherited from class org.bukkit.event.block.BlockEvent

    +block
    +
    • -
    - +
    + -
    - +
    +
    +
    +

    Methods inherited from class org.bukkit.event.block.BlockEvent

    +getBlock
    +
    +

    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

          - - - -
            -
          • -

            DataBlockDestroyEvent

            -
            public DataBlockDestroyEvent​(DataBlock db,
-                             org.bukkit.entity.Player player,
-                             DataBlockDestroyEvent.DestroyCause cause,
-                             org.bukkit.event.Event parent)
            +
          • +
            +

            Constructor Details

            +
              +
            • +
              +

              DataBlockDestroyEvent

              +
              public DataBlockDestroyEvent​(DataBlock db, +org.bukkit.entity.Player player, +DataBlockDestroyEvent.DestroyCause cause, +org.bukkit.event.Event parent)
              Construct a DataBlockDestroyEvent
              -
              -
              Parameters:
              +
              +
              Parameters:
              db - The DataBlock that was destroyed
              player - The player that broke the block, or null
              cause - Why it was destroyed
              parent - The event that caused this event
              -
              • -
            +
        + -
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            getHandlerList

            -
            public static org.bukkit.event.HandlerList getHandlerList()
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              getHandlerList

              +
              public static org.bukkit.event.HandlerList getHandlerList()
              +
              • -
            - - - -
              -
            • -

              getParent

              -
              public org.bukkit.event.Event getParent()
              -
              -
              Returns:
              +
            • +
              +

              getParent

              +
              public org.bukkit.event.Event getParent()
              +
              +
              Returns:
              The event that caused this one
              +
              • -
            - - - -
              -
            • -

              getPlayer

              -
              public org.bukkit.entity.Player getPlayer()
              -
              -
              Returns:
              +
            • +
              +

              getPlayer

              +
              public org.bukkit.entity.Player getPlayer()
              +
              +
              Returns:
              The Player who broke the DataBlock, or null if it was not a Player.
              +
              • -
            - - - -
              -
            • -

              getDataBlock

              -
              public DataBlock getDataBlock()
              -
              -
              Returns:
              +
            • +
              +

              getDataBlock

              +
              public DataBlock getDataBlock()
              +
              +
              Returns:
              The DataBlock that was destroyed
              +
              • -
            - - - - - - - -
              -
            • -

              getHandlers

              -
              public org.bukkit.event.HandlerList getHandlers()
              -
              -
              Specified by:
              +
            • +
              +

              getHandlers

              +
              public org.bukkit.event.HandlerList getHandlers()
              +
              +
              Specified by:
              getHandlers in class org.bukkit.event.Event
              +
              • -
            - - - -
              -
            • -

              isCancelled

              -
              public boolean isCancelled()
              -
              -
              Specified by:
              +
            • +
              +

              isCancelled

              +
              public boolean isCancelled()
              +
              +
              Specified by:
              isCancelled in interface org.bukkit.event.Cancellable
              -
              Returns:
              +
              Returns:
              Whether this event is cancelled
              +
              • -
            - - - -
              -
            • -

              setCancelled

              -
              public void setCancelled​(boolean cancel)
              +
            • +
              +

              setCancelled

              +
              public void setCancelled​(boolean cancel)
              Sets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins.
              -
              -
              Specified by:
              +
              +
              Specified by:
              setCancelled in interface org.bukkit.event.Cancellable
              -
              Parameters:
              +
              Parameters:
              cancel - true if you wish to cancel this event
              -
              • -
            +
      -
    - - + + + + diff --git a/javadoc/redempt/redlib/blockdata/events/DataBlockMoveEvent.html b/javadoc/redempt/redlib/blockdata/events/DataBlockMoveEvent.html index 014aedf..c902475 100644 --- a/javadoc/redempt/redlib/blockdata/events/DataBlockMoveEvent.html +++ b/javadoc/redempt/redlib/blockdata/events/DataBlockMoveEvent.html @@ -5,475 +5,344 @@ DataBlockMoveEvent (RedLib API) + + - + + - - - - - + + - - -
    +
    +
    + + + +
    - +
    +
    -
    Package redempt.redlib.blockdata.events
    -

    Class DataBlockMoveEvent

    +
    Package redempt.redlib.blockdata.events
    +

    Class DataBlockMoveEvent

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • org.bukkit.event.Event
        • -
      • -
          -
        • org.bukkit.event.block.BlockEvent
          • -
        • -
            -
          • redempt.redlib.blockdata.events.DataBlockMoveEvent
            • -
          -
          • -
        -
        • -
      -
      • -
    -
    -
      -
    • -
      +
      java.lang.Object +
      org.bukkit.event.Event +
      org.bukkit.event.block.BlockEvent +
      redempt.redlib.blockdata.events.DataBlockMoveEvent
      +
      +
      +
      +
      +
      All Implemented Interfaces:
      org.bukkit.event.Cancellable
      -
      public class DataBlockMoveEvent
+
      public class DataBlockMoveEvent
 extends org.bukkit.event.block.BlockEvent
 implements org.bukkit.event.Cancellable
      
 
      Called when a DataBlock is moved
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Nested Class Summary

          -
            -
          • - - -

            Nested classes/interfaces inherited from class org.bukkit.event.Event

            -org.bukkit.event.Event.Result
            • -
          -
          • -
        +
      • +
        +

        Nested Class Summary

        +
        +

        Nested classes/interfaces inherited from class org.bukkit.event.Event

        +org.bukkit.event.Event.Result
        - -
        -
          -
        • - - -

          Field Summary

          -
            -
          • - - -

            Fields inherited from class org.bukkit.event.block.BlockEvent

            -block
            • -
          • -
        + +
      • +
        +

        Field Summary

        +
        +

        Fields inherited from class org.bukkit.event.block.BlockEvent

        +block
        +
        • -
        -
          -
        • - - -

          Constructor Summary

          - - +
        • +
          +

          Constructor Summary

          +
          +
          • Constructors 
          + + - - + + - - - + + + + +
          Constructors
          ConstructorDescriptionConstructorDescription
          DataBlockMoveEvent​(DataBlock db, - org.bukkit.Location loc) +
          DataBlockMoveEvent​(DataBlock db, +org.bukkit.Location loc)
          Construct a DataBlockMoveEvent
          -
          • -
        +
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Static Methods Instance Methods Concrete Methods 
      + - - - + + + - - - - + + + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + - - - - + + + +
      Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
      DataBlockgetDataBlock() 
      DataBlockgetDataBlock() 
      static org.bukkit.event.HandlerListgetHandlerList() 
      static org.bukkit.event.HandlerListgetHandlerList() 
      org.bukkit.event.HandlerListgetHandlers() 
      org.bukkit.event.HandlerListgetHandlers() 
      org.bukkit.LocationgetTo() 
      org.bukkit.LocationgetTo() 
      booleanisCancelled() +
      booleanisCancelled()
      Gets the cancellation state of this event.
      voidsetCancelled​(boolean cancel) +
      voidsetCancelled​(boolean cancel)
      Sets the cancellation state of this event.
      -
        -
      • - - -

        Methods inherited from class org.bukkit.event.block.BlockEvent

        -getBlock
        • -
      -
        -
      • - - -

        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
        • -
      -
      • -
    +
    +
    +
    +

    Methods inherited from class org.bukkit.event.block.BlockEvent

    +getBlock
    +
    +

    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

          - - - -
            -
          • -

            DataBlockMoveEvent

            -
            public DataBlockMoveEvent​(DataBlock db,
-                          org.bukkit.Location loc)
            +
          • +
            +

            Constructor Details

            +
              +
            • +
              +

              DataBlockMoveEvent

              +
              public DataBlockMoveEvent​(DataBlock db, +org.bukkit.Location loc)
              Construct a DataBlockMoveEvent
              -
              -
              Parameters:
              +
              +
              Parameters:
              db - The DataBlock
              loc - The location the DataBlock is being moved to
              -
              • -
            +
        + -
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            getHandlerList

            -
            public static org.bukkit.event.HandlerList getHandlerList()
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              getHandlerList

              +
              public static org.bukkit.event.HandlerList getHandlerList()
              +
              • -
            - - - -
              -
            • -

              getDataBlock

              -
              public DataBlock getDataBlock()
              -
              -
              Returns:
              +
            • +
              +

              getDataBlock

              +
              public DataBlock getDataBlock()
              +
              +
              Returns:
              The DataBlock that is moving
              +
              • -
            - - - -
              -
            • -

              getTo

              -
              public org.bukkit.Location getTo()
              -
              -
              Returns:
              +
            • +
              +

              getTo

              +
              public org.bukkit.Location getTo()
              +
              +
              Returns:
              The location the DataBlock will be moved to
              +
              • -
            - - - -
              -
            • -

              isCancelled

              -
              public boolean isCancelled()
              +
            • +
              +

              isCancelled

              +
              public boolean isCancelled()
              Gets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins
              -
              -
              Specified by:
              +
              +
              Specified by:
              isCancelled in interface org.bukkit.event.Cancellable
              -
              Returns:
              +
              Returns:
              true if this event is cancelled
              +
              • -
            - - - -
              -
            • -

              setCancelled

              -
              public void setCancelled​(boolean cancel)
              +
            • +
              +

              setCancelled

              +
              public void setCancelled​(boolean cancel)
              Sets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins.
              -
              -
              Specified by:
              +
              +
              Specified by:
              setCancelled in interface org.bukkit.event.Cancellable
              -
              Parameters:
              +
              Parameters:
              cancel - true if you wish to cancel this event
              +
              • -
            - - - -
              -
            • -

              getHandlers

              -
              public org.bukkit.event.HandlerList getHandlers()
              -
              -
              Specified by:
              +
            • +
              +

              getHandlers

              +
              public org.bukkit.event.HandlerList getHandlers()
              +
              +
              Specified by:
              getHandlers in class org.bukkit.event.Event
              -
              • -
            +
      -
    - - + + + + diff --git a/javadoc/redempt/redlib/blockdata/events/package-summary.html b/javadoc/redempt/redlib/blockdata/events/package-summary.html index 5274394..23a4573 100644 --- a/javadoc/redempt/redlib/blockdata/events/package-summary.html +++ b/javadoc/redempt/redlib/blockdata/events/package-summary.html @@ -5,47 +5,30 @@ redempt.redlib.blockdata.events (RedLib API) + + - + + - - - - - + + - - -
    +
    + +

    Package redempt.redlib.blockdata.events

    -
    -
    -
  • - - +
  • +
    +
    • Enum Summary 
    + + - - + + + - - - + + +
    Enum Summary
    EnumDescriptionEnumDescription
    DataBlockDestroyEvent.DestroyCause 
    DataBlockDestroyEvent.DestroyCause 
    +
    • -
    +
    + + +
    + + diff --git a/javadoc/redempt/redlib/blockdata/events/package-tree.html b/javadoc/redempt/redlib/blockdata/events/package-tree.html index 93edd6a..7f1f3b1 100644 --- a/javadoc/redempt/redlib/blockdata/events/package-tree.html +++ b/javadoc/redempt/redlib/blockdata/events/package-tree.html @@ -5,101 +5,58 @@ redempt.redlib.blockdata.events Class Hierarchy (RedLib API) + + - + + - - - - - + + - - -
    +
    + +

    Hierarchy For Package redempt.redlib.blockdata.events

    -Package Hierarchies: +Package Hierarchies:
    -
    -
    +

    Class Hierarchy

    • java.lang.Object @@ -108,9 +65,9 @@

      Class Hierarchy

      • org.bukkit.event.block.BlockEvent
      @@ -119,66 +76,42 @@

      Class Hierarchy

    -
    +

    Enum Hierarchy

    • java.lang.Object
    -
    +
    +
    diff --git a/javadoc/redempt/redlib/blockdata/package-summary.html b/javadoc/redempt/redlib/blockdata/package-summary.html index c2bbffa..28b1716 100644 --- a/javadoc/redempt/redlib/blockdata/package-summary.html +++ b/javadoc/redempt/redlib/blockdata/package-summary.html @@ -5,47 +5,30 @@ redempt.redlib.blockdata (RedLib API) + + - + + - - - - - + + - - -
    +
    + +

    Package redempt.redlib.blockdata

    -
    -
    -
    +
    + + +
    +
    + diff --git a/javadoc/redempt/redlib/blockdata/package-tree.html b/javadoc/redempt/redlib/blockdata/package-tree.html index 2e84464..56ead69 100644 --- a/javadoc/redempt/redlib/blockdata/package-tree.html +++ b/javadoc/redempt/redlib/blockdata/package-tree.html @@ -5,160 +5,93 @@ redempt.redlib.blockdata Class Hierarchy (RedLib API) + + - + + - - - - - + + - - -
    +
    + +

    Hierarchy For Package redempt.redlib.blockdata

    -Package Hierarchies: +Package Hierarchies:
    -
    -
    +

    Class Hierarchy

    -
    +
    +
    diff --git a/javadoc/redempt/redlib/commandmanager/ArgSubtype.html b/javadoc/redempt/redlib/commandmanager/ArgSubtype.html index 6332aca..e3ac4ec 100644 --- a/javadoc/redempt/redlib/commandmanager/ArgSubtype.html +++ b/javadoc/redempt/redlib/commandmanager/ArgSubtype.html @@ -5,389 +5,277 @@ ArgSubtype (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.commandmanager
    -

    Class ArgSubtype<T,​K>

    +
    Package redempt.redlib.commandmanager
    +

    Class ArgSubtype<T,​K>

    -
    - -
    -
      -
    • -
      -
      Type Parameters:
      +
      java.lang.Object +
      redempt.redlib.commandmanager.ArgType<T> +
      redempt.redlib.commandmanager.ArgSubtype<T,​K>
      +
      +
      +
      +
      +
      Type Parameters:
      T - The type this ArgType converts to
      K - The type this ArgType is dependent on
      -
      public class ArgSubtype<T,​K>
+
      public class ArgSubtype<T,​K>
 extends ArgType<T>
      
 
      An ArgType which is dependent on another type appearing before it and uses it for conversions and tab completion
      
-
      • -
    -
    -
    -
    + -
    - +
    +
    +
    +

    Methods inherited from class redempt.redlib.commandmanager.ArgType

    +convert, getName, getParent, map, map, of, of, of, setTab, setTab, setTab, subType, subType, tabComplete, tabStream, tabStream
    +
    +

    Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - - +
        • +
          +

          Constructor Details

          +
          +
          • -
          -
            -
          • - - -

            Method Detail

            - - - -
              -
            • -

              tab

              -
              public ArgSubtype<T,​K> tab​(ArgType.TabCompleter<K> tab)
              +
            • +
              +

              Method Details

              +
                +
              • +
                +

                tab

                +
                public ArgSubtype<T,​K> tab​(ArgType.TabCompleter<K> tab)
                Sets the tab completer for this type
                -
                -
                Parameters:
                +
                +
                Parameters:
                tab - The function returning a List of all completions for this sender and previous argument
                -
                Returns:
                +
                Returns:
                itself
                +
                • -
              - - - -
                -
              • -

                tabStream

                -
                public ArgSubtype<T,​K> tabStream​(ArgType.TabStreamCompleter<K> tab)
                +
              • +
                +

                tabStream

                +
                public ArgSubtype<T,​K> tabStream​(ArgType.TabStreamCompleter<K> tab)
                Sets the tab completer for this type, can be used instead of tab
                -
                -
                Parameters:
                +
                +
                Parameters:
                tab - The function returning a Stream of all completions for this sender and previous argument
                -
                Returns:
                +
                Returns:
                itself
                -
                • -
              +
        -
    - - + + + + diff --git a/javadoc/redempt/redlib/commandmanager/ArgType.ArgConverter.html b/javadoc/redempt/redlib/commandmanager/ArgType.ArgConverter.html index 05c7e36..9a2703e 100644 --- a/javadoc/redempt/redlib/commandmanager/ArgType.ArgConverter.html +++ b/javadoc/redempt/redlib/commandmanager/ArgType.ArgConverter.html @@ -5,253 +5,177 @@ ArgType.ArgConverter (RedLib API) + + - + + - - - - - + + - - -
    +
    +
    + + + +
    - +
    +
    -
    Package redempt.redlib.commandmanager
    -

    Interface ArgType.ArgConverter<T,​K>

    +
    Package redempt.redlib.commandmanager
    +

    Interface ArgType.ArgConverter<T,​K>

    -
    -
    -
      -
    • -
      +
      +
      Enclosing class:
      ArgType<T>
      -
      public static interface ArgType.ArgConverter<T,​K>
      -
      • -
    -
    -
    -
      -
    • +
      public static interface ArgType.ArgConverter<T,​K>
      + +
      +
        -
        -
          -
        • - - -

          Method Summary

          - - +
        • +
          +

          Method Summary

          +
          +
          +
          +
          • All Methods Instance Methods Abstract Methods 
          + - - - + + + - - - - + + + + + + +
          Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
          Tconvert​(org.bukkit.command.CommandSender sender, - K previous, - java.lang.String str) 
          Tconvert​(org.bukkit.command.CommandSender sender, +K previous, +java.lang.String str) 
          -
          • -
        +
    +
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Method Detail

          - - - - - -
            -
          • -

            convert

            -
            T convert​(org.bukkit.command.CommandSender sender,
-          K previous,
-          java.lang.String str)
            -
            • -
          +
        • +
          +

          Method Details

          +
            +
          • +
            +

            convert

            +
            T convert​(org.bukkit.command.CommandSender sender, +K previous, +java.lang.String str)
            +
        -
    - - + + + + diff --git a/javadoc/redempt/redlib/commandmanager/ArgType.TabCompleter.html b/javadoc/redempt/redlib/commandmanager/ArgType.TabCompleter.html index b90cacc..f96fff3 100644 --- a/javadoc/redempt/redlib/commandmanager/ArgType.TabCompleter.html +++ b/javadoc/redempt/redlib/commandmanager/ArgType.TabCompleter.html @@ -5,253 +5,177 @@ ArgType.TabCompleter (RedLib API) + + - + + - - - - - + + - - -
    +
    +
    + + + +
    - +
    +
    -
    Package redempt.redlib.commandmanager
    -

    Interface ArgType.TabCompleter<T>

    +
    Package redempt.redlib.commandmanager
    +

    Interface ArgType.TabCompleter<T>

    -
    -
    -
      -
    • -
      +
      +
      Enclosing class:
      ArgType<T>
      -
      public static interface ArgType.TabCompleter<T>
      -
      • -
    -
    -
    -
      -
    • +
      public static interface ArgType.TabCompleter<T>
      + +
      +
        -
        -
          -
        • - - -

          Method Summary

          - - +
        • +
          +

          Method Summary

          +
          +
          +
          +
          • All Methods Instance Methods Abstract Methods 
          + - - - + + + - - - - + + + + + + +
          Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
          java.util.List<java.lang.String>tabComplete​(org.bukkit.command.CommandSender sender, - java.lang.String[] prev, - T prevArg) 
          java.util.List<java.lang.String>tabComplete​(org.bukkit.command.CommandSender sender, +java.lang.String[] prev, +T prevArg) 
          -
          • -
        +
    +
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Method Detail

          - - - - - -
            -
          • -

            tabComplete

            -
            java.util.List<java.lang.String> tabComplete​(org.bukkit.command.CommandSender sender,
-                                             java.lang.String[] prev,
-                                             T prevArg)
            -
            • -
          +
        • +
          +

          Method Details

          +
            +
          • +
            +

            tabComplete

            +
            java.util.List<java.lang.String> tabComplete​(org.bukkit.command.CommandSender sender, +java.lang.String[] prev, +T prevArg)
            +
        -
    - - + + + + diff --git a/javadoc/redempt/redlib/commandmanager/ArgType.TabStreamCompleter.html b/javadoc/redempt/redlib/commandmanager/ArgType.TabStreamCompleter.html index 719f30a..3574247 100644 --- a/javadoc/redempt/redlib/commandmanager/ArgType.TabStreamCompleter.html +++ b/javadoc/redempt/redlib/commandmanager/ArgType.TabStreamCompleter.html @@ -5,253 +5,177 @@ ArgType.TabStreamCompleter (RedLib API) + + - + + - - - - - + + - - -
    +
    +
    + + + +
    - +
    +
    -
    Package redempt.redlib.commandmanager
    -

    Interface ArgType.TabStreamCompleter<T>

    +
    Package redempt.redlib.commandmanager
    +

    Interface ArgType.TabStreamCompleter<T>

    -
    -
    -
      -
    • -
      +
      +
      Enclosing class:
      ArgType<T>
      -
      public static interface ArgType.TabStreamCompleter<T>
      -
      • -
    -
    -
    -
      -
    • +
      public static interface ArgType.TabStreamCompleter<T>
      + +
      +
        -
        -
          -
        • - - -

          Method Summary

          - - +
        • +
          +

          Method Summary

          +
          +
          +
          +
          • All Methods Instance Methods Abstract Methods 
          + - - - + + + - - - - + + + + + + +
          Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
          java.util.stream.Stream<java.lang.String>tabComplete​(org.bukkit.command.CommandSender sender, - T prevArg, - java.lang.String[] prev) 
          java.util.stream.Stream<java.lang.String>tabComplete​(org.bukkit.command.CommandSender sender, +T prevArg, +java.lang.String[] prev) 
          -
          • -
        +
    +
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Method Detail

          - - - - - -
            -
          • -

            tabComplete

            -
            java.util.stream.Stream<java.lang.String> tabComplete​(org.bukkit.command.CommandSender sender,
-                                                      T prevArg,
-                                                      java.lang.String[] prev)
            -
            • -
          +
        • +
          +

          Method Details

          +
            +
          • +
            +

            tabComplete

            +
            java.util.stream.Stream<java.lang.String> tabComplete​(org.bukkit.command.CommandSender sender, +T prevArg, +java.lang.String[] prev)
            +
        -
    - - + + + + diff --git a/javadoc/redempt/redlib/commandmanager/ArgType.html b/javadoc/redempt/redlib/commandmanager/ArgType.html index b8fcc44..e6f66fa 100644 --- a/javadoc/redempt/redlib/commandmanager/ArgType.html +++ b/javadoc/redempt/redlib/commandmanager/ArgType.html @@ -5,813 +5,675 @@ ArgType (RedLib API) + + - + + - - - - - + + - - -
    +
    +
    + + + +
    - +
    +
    -
    Package redempt.redlib.commandmanager
    -

    Class ArgType<T>

    +
    Package redempt.redlib.commandmanager
    +

    Class ArgType<T>

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.commandmanager.ArgType<T>
        • -
      -
      • -
    -
    -
      -
    • -
      -
      Type Parameters:
      +
      java.lang.Object +
      redempt.redlib.commandmanager.ArgType<T>
      +
      +
      +
      +
      Type Parameters:
      T - The type this ArgType converts to
      -
      +
      Direct Known Subclasses:
      ArgSubtype
      -
      public class ArgType<T>
+
      public class ArgType<T>
 extends java.lang.Object
      
 
      A command argument type, which converts a String argument to another type
      
-
      • -
    -
    -
    -
    + -
    -
      -
    • - - -

      Field Summary

      - - +
    • +
      +

      Field Summary

      +
      +
      • Fields 
      + + - - - + + + - - - - + + + + + +
      Fields
      Modifier and TypeFieldDescriptionModifier and TypeFieldDescription
      static ArgType<org.bukkit.entity.Player>playerType +
      static ArgType<org.bukkit.entity.Player>playerType
      The ArgType for a Player
      -
      • -
    +
    + -
    -
      -
    • - - -

      Constructor Summary

      - - +
    • +
      +

      Constructor Summary

      +
      +
      • Constructors 
      + + - - - + + + - - - - + + + + + - - - - + + + - - - - + + + + +
      Constructors
      ModifierConstructorDescriptionModifierConstructorDescription
       ArgType​(java.lang.String name, - java.util.function.BiFunction<org.bukkit.command.CommandSender,​java.lang.String,​T> convert) +
       ArgType​(java.lang.String name, +java.util.function.BiFunction<org.bukkit.command.CommandSender,​java.lang.String,​T> convert)
      Create a ArgType from a name and converter
       ArgType​(java.lang.String name, - java.util.function.Function<java.lang.String,​T> convert) +
       ArgType​(java.lang.String name, +java.util.function.Function<java.lang.String,​T> convert)
      Create a ArgType from a name and converter
      protected ArgType​(java.lang.String name, - ArgType<?> parent, - ArgType.ArgConverter<T,​?> convert) 
      protected ArgType​(java.lang.String name, +ArgType<?> parent, +ArgType.ArgConverter<T,​?> convert) 
      -
      • -
    +
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Static Methods Instance Methods Concrete Methods 
      + - - - + + + - - - - + + + + + - - - - + + + + - - - - + + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + + - - - - + + + - - - - + + + - - - - + + + + - - - - + + + - - - - + + + +
      Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
      Tconvert​(org.bukkit.command.CommandSender sender, - java.lang.Object previous, - java.lang.String argument) +
      Tconvert​(org.bukkit.command.CommandSender sender, +java.lang.Object previous, +java.lang.String argument)
      Converts an argument to another type
      java.lang.StringgetName() 
      java.lang.StringgetName() 
      ArgType<?>getParent() 
      ArgType<?>getParent() 
      <K> ArgType<K>map​(java.lang.String name, - java.util.function.BiFunction<org.bukkit.command.CommandSender,​T,​K> func) +
      <K> ArgType<K>map​(java.lang.String name, +java.util.function.BiFunction<org.bukkit.command.CommandSender,​T,​K> func)
      Creates a new ArgType based on this one which converts from this type to another
      <K> ArgType<K>map​(java.lang.String name, - java.util.function.Function<T,​K> func) +
      <K> ArgType<K>map​(java.lang.String name, +java.util.function.Function<T,​K> func)
      Creates a new ArgType based on this one which converts from this type to another
      static <T extends java.lang.Enum>
      ArgType<T>      		of​(java.lang.String name, - java.lang.Class<T> clazz) +
      static <T extends java.lang.Enum>
      ArgType<T>      		of​(java.lang.String name, +java.lang.Class<T> clazz)
      Creates a ArgType for an enum, which will accept all of the enum's values as arguments and offer all enum values as tab completions
      static ArgType<java.lang.String>of​(java.lang.String name, - java.lang.String... values) +
      static ArgType<java.lang.String>of​(java.lang.String name, +java.lang.String... values)
      Creates a ArgType for a set of possible string inputs
      static <T> ArgType<T>of​(java.lang.String name, - java.util.Map<java.lang.String,​T> map) +
      static <T> ArgType<T>of​(java.lang.String name, +java.util.Map<java.lang.String,​T> map)
      Creates an ArgType for a map of a String to another type
      ArgType<T>setTab​(java.util.function.BiFunction<org.bukkit.command.CommandSender,​java.lang.String[],​java.util.List<java.lang.String>> tab) +
      ArgType<T>setTab​(java.util.function.BiFunction<org.bukkit.command.CommandSender,​java.lang.String[],​java.util.List<java.lang.String>> tab)
      Sets the tab completer for this type
      ArgType<T>setTab​(java.util.function.Function<org.bukkit.command.CommandSender,​java.util.List<java.lang.String>> tab) +
      ArgType<T>setTab​(java.util.function.Function<org.bukkit.command.CommandSender,​java.util.List<java.lang.String>> tab)
      Sets the tab completer for this type
      protected ArgType<T>setTab​(ArgType.TabCompleter<?> tab) 
      protected ArgType<T>setTab​(ArgType.TabCompleter<?> tab) 
      <K> ArgSubtype<K,​T>subType​(java.lang.String name, - java.util.function.BiFunction<java.lang.String,​T,​K> convert) +
      <K> ArgSubtype<K,​T>subType​(java.lang.String name, +java.util.function.BiFunction<java.lang.String,​T,​K> convert)
      Creates a new ArgSubtype with this ArgType as its parent.
      <K> ArgSubtype<K,​T>subType​(java.lang.String name, - ArgType.ArgConverter<K,​T> convert) +
      <K> ArgSubtype<K,​T>subType​(java.lang.String name, +ArgType.ArgConverter<K,​T> convert)
      Creates a new ArgSubtype with this ArgType as its parent.
      protected java.util.List<java.lang.String>tabComplete​(org.bukkit.command.CommandSender sender, - java.lang.String[] args, - java.lang.Object prev) 
      protected java.util.List<java.lang.String>tabComplete​(org.bukkit.command.CommandSender sender, +java.lang.String[] args, +java.lang.Object prev) 
      ArgType<T>tabStream​(java.util.function.BiFunction<org.bukkit.command.CommandSender,​java.lang.String[],​java.util.stream.Stream<java.lang.String>> tab) +
      ArgType<T>tabStream​(java.util.function.BiFunction<org.bukkit.command.CommandSender,​java.lang.String[],​java.util.stream.Stream<java.lang.String>> tab)
      Sets the tab completer for this type, can be used instead of tab
      ArgType<T>tabStream​(java.util.function.Function<org.bukkit.command.CommandSender,​java.util.stream.Stream<java.lang.String>> tab) +
      ArgType<T>tabStream​(java.util.function.Function<org.bukkit.command.CommandSender,​java.util.stream.Stream<java.lang.String>> tab)
      Sets the tab completer for this type, can be used instead of tab
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

    Methods inherited from class java.lang.Object

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

          Field Detail

          - - - -
            -
          • -

            playerType

            -
            public static ArgType<org.bukkit.entity.Player> playerType
            +
          • +
            +

            Field Details

            +
              +
            • +
              +

              playerType

              +
              public static ArgType<org.bukkit.entity.Player> playerType
              The ArgType for a Player
              -
              • -
            +
        + -
        -
          -
        • - - -

          Constructor Detail

          - - - -
            -
          • -

            ArgType

            -
            protected ArgType​(java.lang.String name,
-                  ArgType<?> parent,
-                  ArgType.ArgConverter<T,​?> convert)
            +
          • +
            +

            Constructor Details

            + - - - -
              -
            • -

              ArgType

              -
              public ArgType​(java.lang.String name,
-               java.util.function.Function<java.lang.String,​T> convert)
              +
            • +
              +

              ArgType

              +
              public ArgType​(java.lang.String name, +java.util.function.Function<java.lang.String,​T> convert)
              Create a ArgType from a name and converter
              -
              -
              Parameters:
              +
              +
              Parameters:
              name - The name of this command argument type, to be used in the command file
              convert - The Function to convert from a String to whatever type this converts to
              +
              • -
            - - - -
              -
            • -

              ArgType

              -
              public ArgType​(java.lang.String name,
-               java.util.function.BiFunction<org.bukkit.command.CommandSender,​java.lang.String,​T> convert)
              +
            • +
              +

              ArgType

              +
              public ArgType​(java.lang.String name, +java.util.function.BiFunction<org.bukkit.command.CommandSender,​java.lang.String,​T> convert)
              Create a ArgType from a name and converter
              -
              -
              Parameters:
              +
              +
              Parameters:
              name - The name of this command argument type, to be used in the command file
              convert - The BiFunction to convert from a String to whatever type this converts to
              -
              • -
            +
        + -
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            of

            -
            public static <T extends java.lang.Enum> ArgType<T> of​(java.lang.String name,
-                                                       java.lang.Class<T> clazz)
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              of

              +
              public static <T extends java.lang.Enum> ArgType<T> of​(java.lang.String name, +java.lang.Class<T> clazz)
              Creates a ArgType for an enum, which will accept all of the enum's values as arguments and offer all enum values as tab completions
              -
              -
              Type Parameters:
              +
              +
              Type Parameters:
              T - The enum type
              -
              Parameters:
              +
              Parameters:
              name - The name of the ArgType
              clazz - The enum class to make a ArgType from
              -
              Returns:
              +
              Returns:
              A ArgType for the given enum
              +
              • -
            - - - -
              -
            • -

              of

              -
              public static ArgType<java.lang.String> of​(java.lang.String name,
-                                           java.lang.String... values)
              +
            • +
              +

              of

              +
              public static ArgType<java.lang.String> of​(java.lang.String name, +java.lang.String... values)
              Creates a ArgType for a set of possible string inputs
              -
              -
              Parameters:
              +
              +
              Parameters:
              name - The name of the ArgType
              values - The list of possible inputs
              -
              Returns:
              +
              Returns:
              A ArgType for the given inputs, which will offer tab completion and accept any of the supplied strings, or return null if the given argument does not match any of them
              +
              • -
            - - - -
              -
            • -

              of

              -
              public static <T> ArgType<T> of​(java.lang.String name,
-                                java.util.Map<java.lang.String,​T> map)
              +
            • +
              +

              of

              +
              public static <T> ArgType<T> of​(java.lang.String name, +java.util.Map<java.lang.String,​T> map)
              Creates an ArgType for a map of a String to another type
              -
              -
              Type Parameters:
              +
              +
              Type Parameters:
              T - The type this ArgType will provide
              -
              Parameters:
              +
              Parameters:
              name - The name of the ArgType
              map - The map from String to the type this ArgType will provide
              -
              Returns:
              +
              Returns:
              The constructed ArgType
              +
              • -
            - - - -
              -
            • -

              getParent

              -
              public ArgType<?> getParent()
              -
              -
              Returns:
              +
            • +
              +

              getParent

              +
              public ArgType<?> getParent()
              +
              +
              Returns:
              The parent type of this ArgType, or null
              +
              • -
            - - - -
              -
            • -

              setTab

              -
              public ArgType<T> setTab​(java.util.function.Function<org.bukkit.command.CommandSender,​java.util.List<java.lang.String>> tab)
              +
            • +
              +

              setTab

              +
              public ArgType<T> setTab​(java.util.function.Function<org.bukkit.command.CommandSender,​java.util.List<java.lang.String>> tab)
              Sets the tab completer for this type
              -
              -
              Parameters:
              +
              +
              Parameters:
              tab - The function returning a List of all completions for this sender
              -
              Returns:
              +
              Returns:
              itself
              +
              • -
            - - - -
              -
            • -

              setTab

              -
              public ArgType<T> setTab​(java.util.function.BiFunction<org.bukkit.command.CommandSender,​java.lang.String[],​java.util.List<java.lang.String>> tab)
              +
            • +
              +

              setTab

              +
              public ArgType<T> setTab​(java.util.function.BiFunction<org.bukkit.command.CommandSender,​java.lang.String[],​java.util.List<java.lang.String>> tab)
              Sets the tab completer for this type
              -
              -
              Parameters:
              +
              +
              Parameters:
              tab - The function returning a List of all completions for this sender
              -
              Returns:
              +
              Returns:
              itself
              +
              • -
            - - - - - - - -
              -
            • -

              tabStream

              -
              public ArgType<T> tabStream​(java.util.function.Function<org.bukkit.command.CommandSender,​java.util.stream.Stream<java.lang.String>> tab)
              +
            • +
              +

              tabStream

              +
              public ArgType<T> tabStream​(java.util.function.Function<org.bukkit.command.CommandSender,​java.util.stream.Stream<java.lang.String>> tab)
              Sets the tab completer for this type, can be used instead of tab
              -
              -
              Parameters:
              +
              +
              Parameters:
              tab - The function returning a Stream of all completions for this sender
              -
              Returns:
              +
              Returns:
              itself
              +
              • -
            - - - -
              -
            • -

              tabStream

              -
              public ArgType<T> tabStream​(java.util.function.BiFunction<org.bukkit.command.CommandSender,​java.lang.String[],​java.util.stream.Stream<java.lang.String>> tab)
              +
            • +
              +

              tabStream

              +
              public ArgType<T> tabStream​(java.util.function.BiFunction<org.bukkit.command.CommandSender,​java.lang.String[],​java.util.stream.Stream<java.lang.String>> tab)
              Sets the tab completer for this type, can be used instead of tab
              -
              -
              Parameters:
              +
              +
              Parameters:
              tab - The function returning a Stream of all completions for this sender
              -
              Returns:
              +
              Returns:
              itself
              +
              • -
            - - - -
              -
            • -

              tabComplete

              -
              protected java.util.List<java.lang.String> tabComplete​(org.bukkit.command.CommandSender sender,
-                                                       java.lang.String[] args,
-                                                       java.lang.Object prev)
              +
            • +
              +

              tabComplete

              +
              protected java.util.List<java.lang.String> tabComplete​(org.bukkit.command.CommandSender sender, +java.lang.String[] args, +java.lang.Object prev)
              +
              • -
            - - - -
              -
            • -

              getName

              -
              public java.lang.String getName()
              -
              -
              Returns:
              +
            • +
              +

              getName

              +
              public java.lang.String getName()
              +
              +
              Returns:
              The name of this argument type
              +
              • -
            - - - -
              -
            • -

              convert

              -
              public T convert​(org.bukkit.command.CommandSender sender,
-                 java.lang.Object previous,
-                 java.lang.String argument)
              +
            • +
              +

              convert

              +
              public T convert​(org.bukkit.command.CommandSender sender, +java.lang.Object previous, +java.lang.String argument)
              Converts an argument to another type
              -
              -
              Parameters:
              +
              +
              Parameters:
              sender - The sender of the command
              previous - The value of the previous argument
              argument - The argument to be converted
              -
              Returns:
              +
              Returns:
              The converted argument for use in a method hook
              +
              • -
            - - - -
              -
            • -

              map

              -
              public <K> ArgType<K> map​(java.lang.String name,
-                          java.util.function.Function<T,​K> func)
              +
            • +
              +

              map

              +
              public <K> ArgType<K> map​(java.lang.String name, +java.util.function.Function<T,​K> func)
              Creates a new ArgType based on this one which converts from this type to another
              -
              -
              Type Parameters:
              +
              +
              Type Parameters:
              K - The type of the resulting ArgType
              -
              Parameters:
              +
              Parameters:
              name - The name of the ArgType being created
              func - The function to convert from the type this ArgType returns to the type the new one will
              -
              Returns:
              +
              Returns:
              The resulting ArgType
              +
              • -
            - - - -
              -
            • -

              map

              -
              public <K> ArgType<K> map​(java.lang.String name,
-                          java.util.function.BiFunction<org.bukkit.command.CommandSender,​T,​K> func)
              +
            • +
              +

              map

              +
              public <K> ArgType<K> map​(java.lang.String name, +java.util.function.BiFunction<org.bukkit.command.CommandSender,​T,​K> func)
              Creates a new ArgType based on this one which converts from this type to another
              -
              -
              Type Parameters:
              +
              +
              Type Parameters:
              K - The type of the resulting ArgType
              -
              Parameters:
              +
              Parameters:
              name - The name of the ArgType being created
              func - The function to convert from the type this ArgType returns to the type the new one will
              -
              Returns:
              +
              Returns:
              The resulting ArgType
              +
              • -
            - - - -
              -
            • -

              subType

              -
              public <K> ArgSubtype<K,​T> subType​(java.lang.String name,
-                                         java.util.function.BiFunction<java.lang.String,​T,​K> convert)
              +
            • +
              +

              subType

              +
              public <K> ArgSubtype<K,​T> subType​(java.lang.String name, +java.util.function.BiFunction<java.lang.String,​T,​K> convert)
              Creates a new ArgSubtype with this ArgType as its parent. ArgSubtypes are argument types which must follow another argument type, and use info from the previous argument to determine their values for conversion and tab completion.
              -
              -
              Type Parameters:
              +
              +
              Type Parameters:
              K - The type the new ArgSubtype will convert to
              -
              Parameters:
              +
              Parameters:
              name - The name of the new ArgSubtype
              convert - The function to convert using the previous argument value
              -
              Returns:
              +
              Returns:
              The created ArgSubtype
              +
              • -
            - - - -
              -
            • -

              subType

              -
              public <K> ArgSubtype<K,​T> subType​(java.lang.String name,
-                                         ArgType.ArgConverter<K,​T> convert)
              +
            • +
              +

              subType

              +
              public <K> ArgSubtype<K,​T> subType​(java.lang.String name, +ArgType.ArgConverter<K,​T> convert)
              Creates a new ArgSubtype with this ArgType as its parent. ArgSubtypes are argument types which must follow another argument type, and use info from the previous argument to determine their values for conversion and tab completion.
              -
              -
              Type Parameters:
              +
              +
              Type Parameters:
              K - The type the new ArgSubtype will convert to
              -
              Parameters:
              +
              Parameters:
              name - The name of the new ArgSubtype
              convert - The function to convert using the previous argument value
              -
              Returns:
              +
              Returns:
              The created ArgSubtype
              -
              • -
            +
      -
    - - + + + + diff --git a/javadoc/redempt/redlib/commandmanager/Command.MethodHook.html b/javadoc/redempt/redlib/commandmanager/Command.MethodHook.html index d7aab90..888c418 100644 --- a/javadoc/redempt/redlib/commandmanager/Command.MethodHook.html +++ b/javadoc/redempt/redlib/commandmanager/Command.MethodHook.html @@ -5,319 +5,230 @@ Command.MethodHook (RedLib API) + + - + + - - - - - + + - - -
    +
    +
    + + + +
    - +
    +
    -
    Package redempt.redlib.commandmanager
    -

    Class Command.MethodHook

    +
    Package redempt.redlib.commandmanager
    +

    Class Command.MethodHook

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.commandmanager.Command.MethodHook
        • -
      -
      • -
    -
    -
      -
    • -
      +
      java.lang.Object +
      redempt.redlib.commandmanager.Command.MethodHook
      +
      +
      +
      Enclosing class:
      Command
      -
      protected static class Command.MethodHook
+
      protected static class Command.MethodHook
 extends java.lang.Object
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Constructor Summary

          - - +
        • +
          +

          Constructor Summary

          +
          +
          • Constructors 
          + + - - + + - - - + + + + + +
          Constructors
          ConstructorDescriptionConstructorDescription
          MethodHook​(java.lang.reflect.Method method, - java.lang.Object listener) 
          MethodHook​(java.lang.reflect.Method method, +java.lang.Object listener) 
          -
          • -
        +
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Instance Methods Concrete Methods 
      + - - - + + + - - - - + + + + + + - - - - + + + + +
      Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
      java.lang.ObjectgetListener() 
      java.lang.ObjectgetListener() 
      java.lang.reflect.MethodgetMethod() 
      java.lang.reflect.MethodgetMethod() 
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

    Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - -
            -
          • -

            MethodHook

            -
            public MethodHook​(java.lang.reflect.Method method,
-                  java.lang.Object listener)
            -
            • -
          +
        • +
          +

          Constructor Details

          +
            +
          • +
            +

            MethodHook

            +
            public MethodHook​(java.lang.reflect.Method method, +java.lang.Object listener)
            +
          - -
          -
            -
          • - - -

            Method Detail

            - - - -
              -
            • -

              getMethod

              -
              public java.lang.reflect.Method getMethod()
              • -
            - - - -
              -
            • -

              getListener

              -
              public java.lang.Object getListener()
              + +
            • +
              +

              Method Details

              +
                +
              • +
                +

                getMethod

                +
                public java.lang.reflect.Method getMethod()
                +
                • -
              +
            • +
              +

              getListener

              +
              public java.lang.Object getListener()
              +
        -
    - - + + + + diff --git a/javadoc/redempt/redlib/commandmanager/Command.SenderType.html b/javadoc/redempt/redlib/commandmanager/Command.SenderType.html index b8a9d3d..97f756c 100644 --- a/javadoc/redempt/redlib/commandmanager/Command.SenderType.html +++ b/javadoc/redempt/redlib/commandmanager/Command.SenderType.html @@ -5,388 +5,290 @@ Command.SenderType (RedLib API) + + - + + - - - - - + + - - -
    +
    +
    + + + +
    - +
    +
    -
    Package redempt.redlib.commandmanager
    -

    Enum Command.SenderType

    +
    Package redempt.redlib.commandmanager
    +

    Enum Command.SenderType

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • java.lang.Enum<Command.SenderType>
        • -
      • -
          -
        • redempt.redlib.commandmanager.Command.SenderType
          • -
        -
        • -
      -
      • -
    -
    -
      -
    • -
      +
      java.lang.Object +
      java.lang.Enum<Command.SenderType> +
      redempt.redlib.commandmanager.Command.SenderType
      +
      +
      +
      +
      All Implemented Interfaces:
      -
      java.io.Serializable, java.lang.Comparable<Command.SenderType>
      +
      java.io.Serializable, java.lang.Comparable<Command.SenderType>, java.lang.constant.Constable
      -
      +
      Enclosing class:
      Command
      -
      public static enum Command.SenderType
+
      public static enum Command.SenderType
 extends java.lang.Enum<Command.SenderType>
      
+
      +
      +
        + +
      • +
        +

        Nested Class Summary

        +
        +

        Nested classes/interfaces inherited from class java.lang.Enum

        +java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>
        +
        • -
      -
    -
    -
      -
    • -
      -
        -
      • - - -

        Enum Constant Summary

        - - +
      • +
        +

        Enum Constant Summary

        +
        +
        • Enum Constants 
        + + - - + + - - - + + + + + - - - + + + - - - + + + +
        Enum Constants
        Enum ConstantDescriptionEnum ConstantDescription
        CONSOLE 
        CONSOLE 
        EVERYONE 
        EVERYONE 
        PLAYER 
        PLAYER 
        -
        • -
      +
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Static Methods Concrete Methods 
      + - - - + + + - - - - + + + + + - - - - + + + +
      Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
      static Command.SenderTypevalueOf​(java.lang.String name) +
      static Command.SenderTypevalueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Command.SenderType[]values() +
      static Command.SenderType[]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
        • -
      -
      • -
    +
    +
    +
    +

    Methods inherited from class java.lang.Enum

    +clone, compareTo, describeConstable, 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 Command.SenderType[] values()
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              values

              +
              public static Command.SenderType[] 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 (Command.SenderType c : Command.SenderType.values())
-    System.out.println(c);
-
              -
              -
              Returns:
              +the order they are declared.
    +
    +
    Returns:
    an array containing the constants of this enum type, in the order they are declared
    + - - - - -
      -
    • -

      valueOf

      -
      public static Command.SenderType valueOf​(java.lang.String name)
      +
    • +
      +

      valueOf

      +
      public static Command.SenderType 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:
      +
      +
      Parameters:
      name - the name of the enum constant to be returned.
      -
      Returns:
      +
      Returns:
      the enum constant with the specified name
      -
      Throws:
      +
      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/redempt/redlib/commandmanager/Command.html b/javadoc/redempt/redlib/commandmanager/Command.html index 45ce0d5..6fd8573 100644 --- a/javadoc/redempt/redlib/commandmanager/Command.html +++ b/javadoc/redempt/redlib/commandmanager/Command.html @@ -5,823 +5,666 @@ Command (RedLib API) + + - + + - - - - - + + - - -
    +
    +
    + + + +
    - +
    +
    -
    Package redempt.redlib.commandmanager
    -

    Class Command

    +
    Package redempt.redlib.commandmanager
    +

    Class Command

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.commandmanager.Command
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      redempt.redlib.commandmanager.Command
      +
      +
      -
      public class Command
+
      public class Command
 extends java.lang.Object
      
 
      Represents a command which can be registered
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Nested Class Summary

          - - +
        • +
          +

          Nested Class Summary

          +
          +
          • Nested Classes 
          + + - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + +
          Nested Classes
          Modifier and TypeClassDescription
          protected static class Command.MethodHook 
          static class Command.SenderType 
          Modifier and TypeClassDescription
          protected static class Command.MethodHook 
          static class Command.SenderType 
          -
          • -
        +
    + -
    -
      -
    • - - -

      Field Summary

      - - +
    • +
      +

      Field Summary

      +
      +
      • Fields 
      + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields
      Modifier and TypeFieldDescription
      protected java.util.List<Command>children 
      protected java.lang.Stringhelp 
      protected java.lang.Stringhook 
      protected java.lang.String[]names 
      protected Commandparent 
      protected org.bukkit.plugin.Pluginplugin 
      protected booleantopLevel 
      Modifier and TypeFieldDescription
      protected java.util.List<Command>children 
      protected java.lang.Stringhelp 
      protected java.lang.Stringhook 
      protected java.lang.String[]names 
      protected Commandparent 
      protected org.bukkit.plugin.Pluginplugin 
      protected booleantopLevel 
      -
      • -
    +
    + -
    -
      -
    • - - -

      Constructor Summary

      - - +
    • +
      +

      Constructor Summary

      +
      +
      • Constructors 
      + + - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + +
      Constructors
      ModifierConstructorDescription
      protected Command() 
      protected Command​(java.lang.String[] names, - redempt.redlib.commandmanager.CommandArgument[] args, - redempt.redlib.commandmanager.Flag[] flags, - ContextProvider<?>[] providers, - ContextProvider<?>[] asserters, - java.lang.String help, - java.lang.String permission, - Command.SenderType type, - java.lang.String hook, - java.util.List<Command> children, - boolean hideSub, - boolean noTab, - boolean noHelp, - boolean postArg) 
      ModifierConstructorDescription
      protected Command() 
      protected Command​(java.lang.String[] names, +redempt.redlib.commandmanager.CommandArgument[] args, +redempt.redlib.commandmanager.Flag[] flags, +ContextProvider<?>[] providers, +ContextProvider<?>[] asserters, +java.lang.String help, +java.lang.String permission, +Command.SenderType type, +java.lang.String hook, +java.util.List<Command> children, +boolean hideSub, +boolean noTab, +boolean noHelp, +boolean postArg) 
      -
      • -
    +
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      + - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - + + + - - - - + + + + - - - - + + + - - - - + + + + +
      Modifier and TypeMethodDescription
      protected java.util.Map<java.lang.String,​Command.MethodHook>createHookMap​(java.lang.Object... listeners) 
      protected redempt.redlib.commandmanager.Result<java.lang.Boolean,​java.lang.String>execute​(org.bukkit.command.CommandSender sender, - java.lang.String[] args, - java.lang.Object[] parentArgs) 
      static CommandCollectionfromStream​(java.io.InputStream stream, - ArgType<?>... types) -
      Deprecated. -
      Outdated.
      +
      		Modifier and TypeMethodDescription
      protected java.util.Map<java.lang.String,​Command.MethodHook>createHookMap​(java.lang.Object... listeners) 
      protected redempt.redlib.commandmanager.Result<java.lang.Boolean,​java.lang.String>execute​(org.bukkit.command.CommandSender sender, +java.lang.String[] args, +java.lang.Object[] parentArgs) 
      static CommandCollectionfromStream​(java.io.InputStream stream, +ArgType<?>... types) +
      Deprecated. +
      Outdated.
      java.lang.String[]getAliases() 
      java.lang.StringgetExpandedName() 
      java.lang.StringgetFullName() 
      java.lang.StringgetHelp() 
      protected java.lang.StringgetHelpRecursive​(org.bukkit.command.CommandSender sender, - int level) 
      java.lang.StringgetName() 
      java.lang.StringgetPermission() 
      protected static ArgType<?>getType​(java.lang.String name, - ArgType<?>[] types) 
      booleanisPostArg() 
      booleanlastArgTakesAll() 
      booleannameMatches​(java.lang.String name) +
      java.lang.String[]getAliases() 
      java.lang.StringgetExpandedName() 
      java.lang.StringgetFullName() 
      java.lang.StringgetHelp() 
      protected java.lang.StringgetHelpRecursive​(org.bukkit.command.CommandSender sender, +int level) 
      java.lang.StringgetName() 
      java.lang.StringgetPermission() 
      protected static ArgType<?>getType​(java.lang.String name, +ArgType<?>[] types) 
      booleanisPostArg() 
      booleanlastArgTakesAll() 
      booleannameMatches​(java.lang.String name)
      Check if a name matches any of this command's aliases
      voidregister​(java.lang.String prefix, - java.lang.Object... listeners) +
      voidregister​(java.lang.String prefix, +java.lang.Object... listeners)
      Registers this command and its children
      protected voidregisterHook​(java.util.Map<java.lang.String,​Command.MethodHook> hooks) 
      protected voidregisterHook​(java.util.Map<java.lang.String,​Command.MethodHook> hooks, +org.bukkit.plugin.Plugin plugin) 
      booleanshowHelp​(org.bukkit.command.CommandSender sender) +
      booleanshowHelp​(org.bukkit.command.CommandSender sender)
      Shows the help to a CommandSender
      protected java.util.List<java.lang.String>tab​(org.bukkit.command.CommandSender sender, - java.lang.String[] args) 
      protected java.util.List<java.lang.String>tab​(org.bukkit.command.CommandSender sender, +java.lang.String[] args) 
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

    Methods inherited from class java.lang.Object

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

          Field Detail

          - - - -
            -
          • -

            children

            -
            protected java.util.List<Command> children
            -
            • -
          - - - -
            -
          • -

            plugin

            -
            protected org.bukkit.plugin.Plugin plugin
            +
          • +
            +

            Field Details

            +
              +
            • +
              +

              children

              +
              protected java.util.List<Command> children
              +
              • -
            - - - -
              -
            • -

              names

              -
              protected java.lang.String[] names
              +
            • +
              +

              plugin

              +
              protected org.bukkit.plugin.Plugin plugin
              +
              • -
            - - - -
              -
            • -

              hook

              -
              protected java.lang.String hook
              +
            • +
              +

              names

              +
              protected java.lang.String[] names
              +
              • -
            - - - -
              -
            • -

              help

              -
              protected java.lang.String help
              +
            • +
              +

              hook

              +
              protected java.lang.String hook
              +
              • -
            - - - -
              -
            • -

              topLevel

              -
              protected boolean topLevel
              +
            • +
              +

              help

              +
              protected java.lang.String help
              +
              • -
            - - - -
              -
            • -

              parent

              -
              protected Command parent
              +
            • +
              +

              topLevel

              +
              protected boolean topLevel
              +
              • -
            +
          • +
            +

            parent

            +
            protected Command parent
            +
        - -
        -
          -
        • - - -

          Constructor Detail

          - - - -
            -
          • -

            Command

            -
            protected Command()
            • -
          - - - -
            -
          • -

            Command

            -
            protected Command​(java.lang.String[] names,
-                  redempt.redlib.commandmanager.CommandArgument[] args,
-                  redempt.redlib.commandmanager.Flag[] flags,
-                  ContextProvider<?>[] providers,
-                  ContextProvider<?>[] asserters,
-                  java.lang.String help,
-                  java.lang.String permission,
-                  Command.SenderType type,
-                  java.lang.String hook,
-                  java.util.List<Command> children,
-                  boolean hideSub,
-                  boolean noTab,
-                  boolean noHelp,
-                  boolean postArg)
            + +
          • +
            +

            Constructor Details

            +
              +
            • +
              +

              Command

              +
              protected Command()
              +
              • -
            +
          • +
            +

            Command

            +
            protected Command​(java.lang.String[] names, +redempt.redlib.commandmanager.CommandArgument[] args, +redempt.redlib.commandmanager.Flag[] flags, +ContextProvider<?>[] providers, +ContextProvider<?>[] asserters, +java.lang.String help, +java.lang.String permission, +Command.SenderType type, +java.lang.String hook, +java.util.List<Command> children, +boolean hideSub, +boolean noTab, +boolean noHelp, +boolean postArg)
            +
        + -
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            showHelp

            -
            public boolean showHelp​(org.bukkit.command.CommandSender sender)
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              showHelp

              +
              public boolean showHelp​(org.bukkit.command.CommandSender sender)
              Shows the help to a CommandSender
              -
              -
              Parameters:
              +
              +
              Parameters:
              sender - The sender to show the help to
              -
              Returns:
              +
              Returns:
              True if the help was shown to the user, false if the usage was shown instead
              +
              • -
            - - - -
              -
            • -

              getHelpRecursive

              -
              protected java.lang.String getHelpRecursive​(org.bukkit.command.CommandSender sender,
-                                            int level)
              +
            • +
              +

              getHelpRecursive

              +
              protected java.lang.String getHelpRecursive​(org.bukkit.command.CommandSender sender, +int level)
              +
              • -
            - - - -
              -
            • -

              getFullName

              -
              public java.lang.String getFullName()
              -
              -
              Returns:
              +
            • +
              +

              getFullName

              +
              public java.lang.String getFullName()
              +
              +
              Returns:
              The expanded name of the command, plus arguments
              +
              • -
            - - - -
              -
            • -

              getExpandedName

              -
              public java.lang.String getExpandedName()
              -
              -
              Returns:
              +
            • +
              +

              getExpandedName

              +
              public java.lang.String getExpandedName()
              +
              +
              Returns:
              The name of the command concatenated with its parents' names
              +
              • -
            - - - -
              -
            • -

              register

              -
              public void register​(java.lang.String prefix,
-                     java.lang.Object... listeners)
              +
            • +
              +

              register

              +
              public void register​(java.lang.String prefix, +java.lang.Object... listeners)
              Registers this command and its children
              -
              -
              Parameters:
              +
              +
              Parameters:
              prefix - The fallback prefix
              listeners - The listener objects containing method hooks
              +
              • -
            - - - -
              -
            • -

              createHookMap

              -
              protected java.util.Map<java.lang.String,​Command.MethodHook> createHookMap​(java.lang.Object... listeners)
              +
            • +
              +

              createHookMap

              +
              protected java.util.Map<java.lang.String,​Command.MethodHook> createHookMap​(java.lang.Object... listeners)
              +
              • -
            - - - -
              -
            • -

              registerHook

              -
              protected void registerHook​(java.util.Map<java.lang.String,​Command.MethodHook> hooks)
              +
            • +
              +

              registerHook

              +
              protected void registerHook​(java.util.Map<java.lang.String,​Command.MethodHook> hooks, +org.bukkit.plugin.Plugin plugin)
              +
              • -
            - - - -
              -
            • -

              tab

              -
              protected java.util.List<java.lang.String> tab​(org.bukkit.command.CommandSender sender,
-                                               java.lang.String[] args)
              +
            • +
              +

              tab

              +
              protected java.util.List<java.lang.String> tab​(org.bukkit.command.CommandSender sender, +java.lang.String[] args)
              +
              • -
            - - - -
              -
            • -

              execute

              -
              protected redempt.redlib.commandmanager.Result<java.lang.Boolean,​java.lang.String> execute​(org.bukkit.command.CommandSender sender,
-                                                                                                 java.lang.String[] args,
-                                                                                                 java.lang.Object[] parentArgs)
              +
            • +
              +

              execute

              +
              protected redempt.redlib.commandmanager.Result<java.lang.Boolean,​java.lang.String> execute​(org.bukkit.command.CommandSender sender, +java.lang.String[] args, +java.lang.Object[] parentArgs)
              +
              • -
            - - - -
              -
            • -

              nameMatches

              -
              public boolean nameMatches​(java.lang.String name)
              +
            • +
              +

              nameMatches

              +
              public boolean nameMatches​(java.lang.String name)
              Check if a name matches any of this command's aliases
              -
              -
              Parameters:
              +
              +
              Parameters:
              name - The name to check
              -
              Returns:
              +
              Returns:
              Whether the name matches any of this command's aliases
              +
              • -
            - - - -
              -
            • -

              getType

              -
              protected static ArgType<?> getType​(java.lang.String name,
-                                    ArgType<?>[] types)
              +
            • +
              +

              getType

              +
              protected static ArgType<?> getType​(java.lang.String name, +ArgType<?>[] types)
              +
              • -
            - - - -
              -
            • -

              getName

              -
              public java.lang.String getName()
              -
              -
              Returns:
              +
            • +
              +

              getName

              +
              public java.lang.String getName()
              +
              +
              Returns:
              The command's primary name/first alias
              +
              • -
            - - - -
              -
            • -

              lastArgTakesAll

              -
              public boolean lastArgTakesAll()
              -
              -
              Returns:
              +
            • +
              +

              lastArgTakesAll

              +
              public boolean lastArgTakesAll()
              +
              +
              Returns:
              Whether the last argument in this command is consuming or vararg
              +
              • -
            - - - -
              -
            • -

              getAliases

              -
              public java.lang.String[] getAliases()
              -
              -
              Returns:
              +
            • +
              +

              getAliases

              +
              public java.lang.String[] getAliases()
              +
              +
              Returns:
              All of the command's names/aliases
              +
              • -
            - - - -
              -
            • -

              isPostArg

              -
              public boolean isPostArg()
              -
              -
              Returns:
              +
            • +
              +

              isPostArg

              +
              public boolean isPostArg()
              +
              +
              Returns:
              Whether this subcommand comes after the arguments of its parent
              +
              • -
            - - - -
              -
            • -

              getHelp

              -
              public java.lang.String getHelp()
              -
              -
              Returns:
              +
            • +
              +

              getHelp

              +
              public java.lang.String getHelp()
              +
              +
              Returns:
              The command's help message
              +
              • -
            - - - -
              -
            • -

              getPermission

              -
              public java.lang.String getPermission()
              -
              -
              Returns:
              +
            • +
              +

              getPermission

              +
              public java.lang.String getPermission()
              +
              +
              Returns:
              Nullable. The permission required to run the command
              +
              • -
            - - - -
              -
            • -

              fromStream

              -
              public static CommandCollection fromStream​(java.io.InputStream stream,
-                                           ArgType<?>... types)
              -
              Deprecated. -
              Outdated. Use CommandParser.parse()
              +
            • +
              +

              fromStream

              +
              public static CommandCollection fromStream​(java.io.InputStream stream, +ArgType<?>... types)
              +
              Deprecated. +
              Outdated. Use CommandParser.parse()
              Loads commands from a command file in stream form. Use JavaPlugin.getResource(java.lang.String) for this
              -
              -
              Parameters:
              +
              +
              Parameters:
              stream - The InputStream to load commands from
              types - Custom argument types
              -
              Returns:
              +
              Returns:
              The commands loaded from the stream
              -
              Throws:
              +
              Throws:
              CommandParseException - if the command file cannot be parsed
              -
              • -
            +
      -
    - - + + + + diff --git a/javadoc/redempt/redlib/commandmanager/CommandCollection.html b/javadoc/redempt/redlib/commandmanager/CommandCollection.html index 04a454e..fa23492 100644 --- a/javadoc/redempt/redlib/commandmanager/CommandCollection.html +++ b/javadoc/redempt/redlib/commandmanager/CommandCollection.html @@ -5,377 +5,306 @@ CommandCollection (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.commandmanager
    -

    Class CommandCollection

    +
    Package redempt.redlib.commandmanager
    +

    Class CommandCollection

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.commandmanager.CommandCollection
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      redempt.redlib.commandmanager.CommandCollection
      +
      +
      -
      public class CommandCollection
+
      public class CommandCollection
 extends java.lang.Object
      
 
      Represents a collection of commands which can be mass-registered. Can contain any amount of commands, including 0
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Constructor Summary

          - - +
        • +
          +

          Constructor Summary

          +
          +
          • Constructors 
          + + - - + + - - - + + + + + +
          Constructors
          ConstructorDescriptionConstructorDescription
          CommandCollection​(java.util.List<Command> commands) 
          CommandCollection​(java.util.List<Command> commands) 
          -
          • -
        +
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Instance Methods Concrete Methods 
      + - - - + + + - - - - + + + + + - - - - + + + + - - - - + + + - - - - + + + + + + + + +
      Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
      CommandgetByHookName​(java.lang.String hookName) +
      CommandgetByHookName​(java.lang.String hookName)
      Recurseively searches this CommandCollection for a command with a given hook name
      java.util.List<Command>getCommands() 
      java.util.List<Command>getCommands() 
      voidregister​(java.lang.String prefix, - java.lang.Object... listeners) +
      voidregister​(java.lang.String prefix, +java.lang.Object... listeners)
      Register all commands in this CommandCollection
      voidshowHelp​(java.lang.String hookName, - org.bukkit.command.CommandSender sender) +
      voidregister​(org.bukkit.plugin.Plugin plugin, +java.lang.String prefix, +java.lang.Object... listeners) +
      Register all commands in this CommandCollection
      +
      voidshowHelp​(java.lang.String hookName, +org.bukkit.command.CommandSender sender)
      Recursively searches this CommandCollection for a command by a given hook, then shows the help to the given sender
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

    Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - -
            -
          • -

            CommandCollection

            -
            public CommandCollection​(java.util.List<Command> commands)
            -
            • -
          +
        • +
          +

          Constructor Details

          +
            +
          • +
            +

            CommandCollection

            +
            public CommandCollection​(java.util.List<Command> commands)
            +
          +
          • -
          -
            -
          • - - -

            Method Detail

            - - - -
              -
            • -

              register

              -
              public void register​(java.lang.String prefix,
-                     java.lang.Object... listeners)
              +
            • +
              +

              Method Details

              +
                +
              • +
                +

                register

                +
                public void register​(org.bukkit.plugin.Plugin plugin, +java.lang.String prefix, +java.lang.Object... listeners)
                Register all commands in this CommandCollection
                -
                -
                Parameters:
                +
                +
                Parameters:
                +
                plugin - the plugin that owns the commands
                prefix - The fallback prefix of the commands
                listeners - The list of listener objects which contain hooks for the commands in this collection
                +
                • -
              - - - -
                -
              • -

                getCommands

                -
                public java.util.List<Command> getCommands()
                -
                -
                Returns:
                +
              • +
                +

                register

                +
                public void register​(java.lang.String prefix, +java.lang.Object... listeners)
                +
                Register all commands in this CommandCollection
                +
                +
                Parameters:
                +
                prefix - The fallback prefix of the commands
                +
                listeners - The list of listener objects which contain hooks for the commands in this collection
                +
                +
                +
                • +
              • +
                +

                getCommands

                +
                public java.util.List<Command> getCommands()
                +
                +
                Returns:
                The commands in this CommandCollection
                +
                • -
              - - - -
                -
              • -

                showHelp

                -
                public void showHelp​(java.lang.String hookName,
-                     org.bukkit.command.CommandSender sender)
                +
              • +
                +

                showHelp

                +
                public void showHelp​(java.lang.String hookName, +org.bukkit.command.CommandSender sender)
                Recursively searches this CommandCollection for a command by a given hook, then shows the help to the given sender
                -
                -
                Parameters:
                +
                +
                Parameters:
                hookName - The hook name of the command
                sender - The sender to be shown the help menu for this command
                -
                Throws:
                +
                Throws:
                java.lang.IllegalArgumentException - if no command by that hook name was found
                +
                • -
              - - - -
                -
              • -

                getByHookName

                -
                public Command getByHookName​(java.lang.String hookName)
                +
              • +
                +

                getByHookName

                +
                public Command getByHookName​(java.lang.String hookName)
                Recurseively searches this CommandCollection for a command with a given hook name
                -
                -
                Parameters:
                +
                +
                Parameters:
                hookName - The hook name of the command
                -
                Returns:
                +
                Returns:
                The command in this CommandCollection by that hook name, or null if none found
                -
                • -
              +
        -
    - - + + + + diff --git a/javadoc/redempt/redlib/commandmanager/CommandHook.html b/javadoc/redempt/redlib/commandmanager/CommandHook.html index f208e92..ff86ba1 100644 --- a/javadoc/redempt/redlib/commandmanager/CommandHook.html +++ b/javadoc/redempt/redlib/commandmanager/CommandHook.html @@ -5,235 +5,159 @@ CommandHook (RedLib API) + + - + + - - - - - + + - - -
    +
    +
    + + + +
    - +
    +
    -
    Package redempt.redlib.commandmanager
    -

    Annotation Type CommandHook

    +
    Package redempt.redlib.commandmanager
    +

    Annotation Type CommandHook

    -
    -
    -
      -
    • +
      @Retention(RUNTIME)
 @Target(METHOD)
-public @interface CommandHook
      -
      • -
    -
    -
    -
      -
    • +public @interface CommandHook + +
      +
        -
        -
          -
        • - - -

          Required Element Summary

          - - +
        • +
          +

          Required Element Summary

          +
          +
          • Required Elements 
          + + - - - + + + - - - - + + + + + + +
          Required Elements
          Modifier and TypeRequired ElementDescriptionModifier and TypeRequired ElementDescription
          java.lang.Stringvalue 
          java.lang.Stringvalue 
          -
          • -
        +
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Element Detail

          - - - -
            -
          • -

            value

            -
            java.lang.String value
            -
            • -
          +
        • +
          +

          Element Details

          +
            +
          • +
            +

            value

            +
            java.lang.String value
            +
        -
    -
    - + + + + diff --git a/javadoc/redempt/redlib/commandmanager/CommandParser.html b/javadoc/redempt/redlib/commandmanager/CommandParser.html index 9abbe41..4cd40b2 100644 --- a/javadoc/redempt/redlib/commandmanager/CommandParser.html +++ b/javadoc/redempt/redlib/commandmanager/CommandParser.html @@ -5,383 +5,288 @@ CommandParser (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.commandmanager
    -

    Class CommandParser

    +
    Package redempt.redlib.commandmanager
    +

    Class CommandParser

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.commandmanager.CommandParser
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      redempt.redlib.commandmanager.CommandParser
      +
      +
      -
      public class CommandParser
+
      public class CommandParser
 extends java.lang.Object
      
 
      Used to get ContextProviders and CommandArgumentTypes for a command file, then parse it
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Constructor Summary

          - - +
        • +
          +

          Constructor Summary

          +
          +
          • Constructors 
          + + - - + + - - - + + + + - - - + + +
          Constructors
          ConstructorDescriptionConstructorDescription
          CommandParser​(java.io.InputStream stream) +
          CommandParser​(java.io.InputStream stream)
          Constructs a CommandParser to parse input from the given stream.
          CommandParser​(java.io.InputStream stream, - Messages messages) +
          CommandParser​(java.io.InputStream stream, +Messages messages)
          Constructs a CommandParser to parse input from the given stream.
          -
          • -
        +
    + -
    - +
    +
    +
    +

    Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - -
            -
          • -

            CommandParser

            -
            public CommandParser​(java.io.InputStream stream)
            +
          • +
            +

            Constructor Details

            +
              +
            • +
              +

              CommandParser

              +
              public CommandParser​(java.io.InputStream stream)
              Constructs a CommandParser to parse input from the given stream. Use JavaPlugin.getResource(java.lang.String) for this
              -
              -
              Parameters:
              +
              +
              Parameters:
              stream - The stream to read the command info from
              +
              • -
            - - - -
              -
            • -

              CommandParser

              -
              public CommandParser​(java.io.InputStream stream,
-                     Messages messages)
              +
            • +
              +

              CommandParser

              +
              public CommandParser​(java.io.InputStream stream, +Messages messages)
              Constructs a CommandParser to parse input from the given stream. Use JavaPlugin.getResource(java.lang.String) for this
              -
              -
              Parameters:
              +
              +
              Parameters:
              stream - The stream to read the command info from
              messages - The messages to be used to supply help messages with the helpmsg tag
              -
              • -
            +
        + -
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            setArgTypes

            -
            public CommandParser setArgTypes​(ArgType<?>... types)
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              setArgTypes

              +
              public CommandParser setArgTypes​(ArgType<?>... types)
              Sets the CommandArgumentTypes to be used when building this command.
              -
              -
              Parameters:
              +
              +
              Parameters:
              types - The CommandArgumentTypes to be used
              -
              Returns:
              +
              Returns:
              This CommandParser
              +
              • -
            - - - -
              -
            • -

              setContextProviders

              -
              public CommandParser setContextProviders​(ContextProvider<?>... providers)
              +
            • +
              +

              setContextProviders

              +
              public CommandParser setContextProviders​(ContextProvider<?>... providers)
              Sets the ContextProviders to be used when building this command.
              -
              -
              Parameters:
              +
              +
              Parameters:
              providers - The ContextProviders to be used
              -
              Returns:
              +
              Returns:
              This CommandParser
              +
              • -
            - - - - +
      -
    - - + + + + diff --git a/javadoc/redempt/redlib/commandmanager/ContextProvider.html b/javadoc/redempt/redlib/commandmanager/ContextProvider.html index b694f6d..86b847c 100644 --- a/javadoc/redempt/redlib/commandmanager/ContextProvider.html +++ b/javadoc/redempt/redlib/commandmanager/ContextProvider.html @@ -5,620 +5,501 @@ ContextProvider (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.commandmanager
    -

    Class ContextProvider<T>

    +
    Package redempt.redlib.commandmanager
    +

    Class ContextProvider<T>

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.commandmanager.ContextProvider<T>
        • -
      -
      • -
    -
    -
      -
    • -
      -
      Type Parameters:
      +
      java.lang.Object +
      redempt.redlib.commandmanager.ContextProvider<T>
      +
      +
      +
      +
      Type Parameters:
      T - The type this ContextProvider provides
      -
      public class ContextProvider<T>
+
      public class ContextProvider<T>
 extends java.lang.Object
      
 
      Used to provide context arguments to command method hooks
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Field Summary

          - - +
        • +
          +

          Field Summary

          +
          +
          • Fields 
          + + - - - + + + - - - - + + + + + - - - - + + + +
          Fields
          Modifier and TypeFieldDescriptionModifier and TypeFieldDescription
          static ContextProvider<org.bukkit.inventory.ItemStack>mainHand +
          static ContextProvider<org.bukkit.inventory.ItemStack>mainHand
          Use "mainhand" in the command file.
          static ContextProvider<org.bukkit.entity.Player>self -
          Deprecated. -
          Now included by default, there is no need to add it yourself
          +
          static ContextProvider<org.bukkit.entity.Player>self +
          Deprecated. +
          Now included by default, there is no need to add it yourself
          -
          • -
        +
    + -
    -
      -
    • - - -

      Constructor Summary

      - - +
    • +
      +

      Constructor Summary

      +
      +
      • Constructors 
      + + - - + + - - - + + + + - - - + + +
      Constructors
      ConstructorDescriptionConstructorDescription
      ContextProvider​(java.lang.String name, - java.lang.String error, - java.util.function.Function<org.bukkit.entity.Player,​T> provider) +
      ContextProvider​(java.lang.String name, +java.lang.String error, +java.util.function.Function<org.bukkit.entity.Player,​T> provider)
      Constructs a ContextProvider.
      ContextProvider​(java.lang.String name, - java.util.function.Function<org.bukkit.entity.Player,​T> provider) +
      ContextProvider​(java.lang.String name, +java.util.function.Function<org.bukkit.entity.Player,​T> provider)
      Constructs a ContextProvider.
      -
      • -
    +
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Static Methods Instance Methods Concrete Methods 
      + - - - + + + - - - - + + + + + - - - - + + + - - - - + + + + - - - - + + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + + +
      Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
      static ContextProvider<java.lang.Boolean>assertProvider​(java.lang.String name, - java.lang.String error, - java.util.function.Predicate<org.bukkit.entity.Player> assertion) +
      static ContextProvider<java.lang.Boolean>assertProvider​(java.lang.String name, +java.lang.String error, +java.util.function.Predicate<org.bukkit.entity.Player> assertion)
      Creates a ContextProvider which returns true if the predicate's condition is met, and null otherwise, which will cause the command to fail.
      static ContextProvider<java.lang.Boolean>assertProvider​(java.lang.String name, - java.util.function.Predicate<org.bukkit.entity.Player> assertion) +
      static ContextProvider<java.lang.Boolean>assertProvider​(java.lang.String name, +java.util.function.Predicate<org.bukkit.entity.Player> assertion)
      Creates a ContextProvider which returns true if the predicate's condition is met, and null otherwise, which will cause the command to fail.
      java.lang.StringgetErrorMessage() 
      java.lang.StringgetErrorMessage() 
      java.lang.StringgetName() 
      java.lang.StringgetName() 
      <K> ContextProvider<K>map​(java.lang.String name, - java.lang.String error, - java.util.function.BiFunction<org.bukkit.entity.Player,​T,​K> func) +
      <K> ContextProvider<K>map​(java.lang.String name, +java.lang.String error, +java.util.function.BiFunction<org.bukkit.entity.Player,​T,​K> func)
      Creates a new ContextProvider based on this one which converts from this type to another
      <K> ContextProvider<K>map​(java.lang.String name, - java.lang.String error, - java.util.function.Function<T,​K> func) +
      <K> ContextProvider<K>map​(java.lang.String name, +java.lang.String error, +java.util.function.Function<T,​K> func)
      Creates a new ContextProvider based on this one which converts from this type to another
      <K> ContextProvider<K>map​(java.lang.String name, - java.util.function.BiFunction<org.bukkit.entity.Player,​T,​K> func) +
      <K> ContextProvider<K>map​(java.lang.String name, +java.util.function.BiFunction<org.bukkit.entity.Player,​T,​K> func)
      Creates a new ContextProvider based on this one which converts from this type to another
      <K> ContextProvider<K>map​(java.lang.String name, - java.util.function.Function<T,​K> func) +
      <K> ContextProvider<K>map​(java.lang.String name, +java.util.function.Function<T,​K> func)
      Creates a new ContextProvider based on this one which converts from this type to another
      protected Tprovide​(org.bukkit.entity.Player sender) 
      protected Tprovide​(org.bukkit.entity.Player sender) 
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

    Methods inherited from class java.lang.Object

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

          Field Detail

          - - - -
            -
          • -

            mainHand

            -
            public static ContextProvider<org.bukkit.inventory.ItemStack> mainHand
            +
          • +
            +

            Field Details

            +
              +
            • +
              +

              mainHand

              +
              public static ContextProvider<org.bukkit.inventory.ItemStack> mainHand
              Use "mainhand" in the command file. Assumes the sender is a player. Returns the item in the player's main hand, or errors if it is air.
              +
              • -
            - - - -
              -
            • -

              self

              -
              public static ContextProvider<org.bukkit.entity.Player> self
              -
              Deprecated. -
              Now included by default, there is no need to add it yourself
              +
            • +
              +

              self

              +
              public static ContextProvider<org.bukkit.entity.Player> self
              +
              Deprecated. +
              Now included by default, there is no need to add it yourself
              Use "self" in the command file. Returns the player that ran the command. Useful when you need an optional argument of type player to have a default value of the sender
              -
              • -
            +
        + -
        -
          -
        • - - -

          Constructor Detail

          - - - -
            -
          • -

            ContextProvider

            -
            public ContextProvider​(java.lang.String name,
-                       java.util.function.Function<org.bukkit.entity.Player,​T> provider)
            +
          • +
            +

            Constructor Details

            +
              +
            • +
              +

              ContextProvider

              +
              public ContextProvider​(java.lang.String name, +java.util.function.Function<org.bukkit.entity.Player,​T> provider)
              Constructs a ContextProvider. If this constructor is used, the sender will be shown the help menu if the provider returns null
              -
              -
              Parameters:
              +
              +
              Parameters:
              name - The name of this ContextProvider
              provider - The function to get the needed context for the given sender
              +
              • -
            - - - -
              -
            • -

              ContextProvider

              -
              public ContextProvider​(java.lang.String name,
-                       java.lang.String error,
-                       java.util.function.Function<org.bukkit.entity.Player,​T> provider)
              +
            • +
              +

              ContextProvider

              +
              public ContextProvider​(java.lang.String name, +java.lang.String error, +java.util.function.Function<org.bukkit.entity.Player,​T> provider)
              Constructs a ContextProvider. If this constructor is used, the sender will be shown the given error message if the provider returns null
              -
              -
              Parameters:
              +
              +
              Parameters:
              name - The name of this ContextProvider
              error - The error message to be shown to the user if the provider returns null
              provider - The function to get the needed context for the given sender
              -
              • -
            +
        + -
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            assertProvider

            -
            public static ContextProvider<java.lang.Boolean> assertProvider​(java.lang.String name,
-                                                                java.lang.String error,
-                                                                java.util.function.Predicate<org.bukkit.entity.Player> assertion)
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              assertProvider

              +
              public static ContextProvider<java.lang.Boolean> assertProvider​(java.lang.String name, +java.lang.String error, +java.util.function.Predicate<org.bukkit.entity.Player> assertion)
              Creates a ContextProvider which returns true if the predicate's condition is met, and null otherwise, which will cause the command to fail.
              -
              -
              Parameters:
              +
              +
              Parameters:
              name - The name of the ContextProvider to be created
              error - The error message to be shown to the user if the predicate returns false
              assertion - The predicate which tests the assertion
              -
              Returns:
              +
              Returns:
              A ContextProvider which asserts that the given condition is met, and returns false otherwise
              +
              • -
            - - - -
              -
            • -

              assertProvider

              -
              public static ContextProvider<java.lang.Boolean> assertProvider​(java.lang.String name,
-                                                                java.util.function.Predicate<org.bukkit.entity.Player> assertion)
              +
            • +
              +

              assertProvider

              +
              public static ContextProvider<java.lang.Boolean> assertProvider​(java.lang.String name, +java.util.function.Predicate<org.bukkit.entity.Player> assertion)
              Creates a ContextProvider which returns true if the predicate's condition is met, and null otherwise, which will cause the command to fail.
              -
              -
              Parameters:
              +
              +
              Parameters:
              name - The name of the ContextProvider to be created
              assertion - The predicate which tests the assertion
              -
              Returns:
              +
              Returns:
              A ContextProvider which asserts that the given condition is met, and returns false otherwise
              +
              • -
            - - - -
              -
            • -

              getName

              -
              public java.lang.String getName()
              -
              -
              Returns:
              +
            • +
              +

              getName

              +
              public java.lang.String getName()
              +
              +
              Returns:
              The name of this sender
              +
              • -
            - - - -
              -
            • -

              getErrorMessage

              -
              public java.lang.String getErrorMessage()
              -
              -
              Returns:
              +
            • +
              +

              getErrorMessage

              +
              public java.lang.String getErrorMessage()
              +
              +
              Returns:
              The error message shown to a user if a command using this ContextProvider is run and this ContextProvider returns null
              +
              • -
            - - - -
              -
            • -

              map

              -
              public <K> ContextProvider<K> map​(java.lang.String name,
-                                  java.lang.String error,
-                                  java.util.function.Function<T,​K> func)
              +
            • +
              +

              map

              +
              public <K> ContextProvider<K> map​(java.lang.String name, +java.lang.String error, +java.util.function.Function<T,​K> func)
              Creates a new ContextProvider based on this one which converts from this type to another
              -
              -
              Type Parameters:
              +
              +
              Type Parameters:
              K - The type of the resulting ContextProvider
              -
              Parameters:
              +
              Parameters:
              name - The name of the ContextProvider being created
              error - The error message to be shown to the user if the provider returns null
              func - The function to convert from the type this ContextProvider returns to the type the new one will
              -
              Returns:
              +
              Returns:
              The resulting ContextProvider
              +
              • -
            - - - -
              -
            • -

              map

              -
              public <K> ContextProvider<K> map​(java.lang.String name,
-                                  java.lang.String error,
-                                  java.util.function.BiFunction<org.bukkit.entity.Player,​T,​K> func)
              +
            • +
              +

              map

              +
              public <K> ContextProvider<K> map​(java.lang.String name, +java.lang.String error, +java.util.function.BiFunction<org.bukkit.entity.Player,​T,​K> func)
              Creates a new ContextProvider based on this one which converts from this type to another
              -
              -
              Type Parameters:
              +
              +
              Type Parameters:
              K - The type of the resulting ContextProvider
              -
              Parameters:
              +
              Parameters:
              name - The name of the ContextProvider being created
              error - The error message to be shown to the user if the provider returns null
              func - The function to convert from the type this ContextProvider returns to the type the new one will
              -
              Returns:
              +
              Returns:
              The resulting ContextProvider
              +
              • -
            - - - -
              -
            • -

              map

              -
              public <K> ContextProvider<K> map​(java.lang.String name,
-                                  java.util.function.Function<T,​K> func)
              +
            • +
              +

              map

              +
              public <K> ContextProvider<K> map​(java.lang.String name, +java.util.function.Function<T,​K> func)
              Creates a new ContextProvider based on this one which converts from this type to another
              -
              -
              Type Parameters:
              +
              +
              Type Parameters:
              K - The type of the resulting ContextProvider
              -
              Parameters:
              +
              Parameters:
              name - The name of the ContextProvider being created
              func - The function to convert from the type this ContextProvider returns to the type the new one will
              -
              Returns:
              +
              Returns:
              The resulting ContextProvider
              +
              • -
            - - - -
              -
            • -

              map

              -
              public <K> ContextProvider<K> map​(java.lang.String name,
-                                  java.util.function.BiFunction<org.bukkit.entity.Player,​T,​K> func)
              +
            • +
              +

              map

              +
              public <K> ContextProvider<K> map​(java.lang.String name, +java.util.function.BiFunction<org.bukkit.entity.Player,​T,​K> func)
              Creates a new ContextProvider based on this one which converts from this type to another
              -
              -
              Type Parameters:
              +
              +
              Type Parameters:
              K - The type of the resulting ContextProvider
              -
              Parameters:
              +
              Parameters:
              name - The name of the ContextProvider being created
              func - The function to convert from the type this ContextProvider returns to the type the new one will
              -
              Returns:
              +
              Returns:
              The resulting ContextProvider
              +
              • -
            - - - -
              -
            • -

              provide

              -
              protected T provide​(org.bukkit.entity.Player sender)
              -
              • -
            +
          • +
            +

            provide

            +
            protected T provide​(org.bukkit.entity.Player sender)
            +
      -
    - - + + + + diff --git a/javadoc/redempt/redlib/commandmanager/Messages.html b/javadoc/redempt/redlib/commandmanager/Messages.html index bfd719f..a0aefb9 100644 --- a/javadoc/redempt/redlib/commandmanager/Messages.html +++ b/javadoc/redempt/redlib/commandmanager/Messages.html @@ -5,413 +5,312 @@ Messages (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.commandmanager
    -

    Class Messages

    +
    Package redempt.redlib.commandmanager
    +

    Class Messages

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.commandmanager.Messages
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      redempt.redlib.commandmanager.Messages
      +
      +
      -
      public class Messages
+
      public class Messages
 extends java.lang.Object
      
 
      Represents a list of messages loaded from a file with defaults
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Method Summary

          - - +
        • +
          +

          Method Summary

          +
          +
          +
          +
          • All Methods Static Methods Instance Methods Concrete Methods 
          + - - - + + + - - - - + + + + + - - - - + + + - - - - + + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + +
          Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
          java.lang.Stringget​(java.lang.String msg) +
          java.lang.Stringget​(java.lang.String msg)
          Gets a color-formatted message by name
          static MessagesgetLoaded​(org.bukkit.plugin.Plugin plugin) +
          static MessagesgetLoaded​(org.bukkit.plugin.Plugin plugin)
          Gets the Messages which have been loaded for a specific plugin, if they exist
          org.bukkit.plugin.PlugingetPlugin() 
          org.bukkit.plugin.PlugingetPlugin() 
          static Messagesload​(org.bukkit.plugin.Plugin plugin) +
          static Messagesload​(org.bukkit.plugin.Plugin plugin)
          Loads messages from a file, messages.txt, and writes missing defaults loaded from the plugin resource called messages.txt
          static Messagesload​(org.bukkit.plugin.Plugin plugin, - java.io.InputStream defaults) +
          static Messagesload​(org.bukkit.plugin.Plugin plugin, +java.io.InputStream defaults)
          Loads messages from a file, messages.txt, and writes missing defaults
          static Messagesload​(org.bukkit.plugin.Plugin plugin, - java.io.InputStream defaults, - java.lang.String filename) +
          static Messagesload​(org.bukkit.plugin.Plugin plugin, +java.io.InputStream defaults, +java.lang.String filename)
          Loads messages from a file and writes missing defaults
          static java.lang.Stringmsg​(java.lang.String message) +
          static java.lang.Stringmsg​(java.lang.String message)
          Determines which plugin is calling this method, finds its loaded messages, and returns the message with the given name.
          -
            -
          • - - -

            Methods inherited from class java.lang.Object

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

    Methods inherited from class java.lang.Object

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

          Method Detail

          - - - -
            -
          • -

            load

            -
            public static Messages load​(org.bukkit.plugin.Plugin plugin,
-                            java.io.InputStream defaults,
-                            java.lang.String filename)
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              load

              +
              public static Messages load​(org.bukkit.plugin.Plugin plugin, +java.io.InputStream defaults, +java.lang.String filename)
              Loads messages from a file and writes missing defaults
              -
              -
              Parameters:
              +
              +
              Parameters:
              plugin - The plugin loading the messages
              defaults - The InputStream for default messages. Use Plugin.getResource(String) for this.
              filename - The name of the file in the plugin folder to load messages from
              -
              Returns:
              +
              Returns:
              The Messages instance with messages loaded.
              +
              • -
            - - - -
              -
            • -

              getLoaded

              -
              public static Messages getLoaded​(org.bukkit.plugin.Plugin plugin)
              +
            • +
              +

              getLoaded

              +
              public static Messages getLoaded​(org.bukkit.plugin.Plugin plugin)
              Gets the Messages which have been loaded for a specific plugin, if they exist
              -
              -
              Parameters:
              +
              +
              Parameters:
              plugin - The plugin to get the Messages for
              -
              Returns:
              +
              Returns:
              The Messages object, or null
              +
              • -
            - - - -
              -
            • -

              load

              -
              public static Messages load​(org.bukkit.plugin.Plugin plugin,
-                            java.io.InputStream defaults)
              +
            • +
              +

              load

              +
              public static Messages load​(org.bukkit.plugin.Plugin plugin, +java.io.InputStream defaults)
              Loads messages from a file, messages.txt, and writes missing defaults
              -
              -
              Parameters:
              +
              +
              Parameters:
              plugin - The plugin loading the messages
              defaults - The InputStream for default messages. Use Plugin.getResource(String) for this.
              -
              Returns:
              +
              Returns:
              The Messages instance with messages loaded.
              +
              • -
            - - - -
              -
            • -

              load

              -
              public static Messages load​(org.bukkit.plugin.Plugin plugin)
              +
            • +
              +

              load

              +
              public static Messages load​(org.bukkit.plugin.Plugin plugin)
              Loads messages from a file, messages.txt, and writes missing defaults loaded from the plugin resource called messages.txt
              -
              -
              Parameters:
              +
              +
              Parameters:
              plugin - The plugin loading the messages
              -
              Returns:
              +
              Returns:
              The Messages instance with messages loaded.
              +
              • -
            - - - -
              -
            • -

              msg

              -
              public static java.lang.String msg​(java.lang.String message)
              +
            • +
              +

              msg

              +
              public static java.lang.String msg​(java.lang.String message)
              Determines which plugin is calling this method, finds its loaded messages, and returns the message with the given name.
              -
              -
              Parameters:
              +
              +
              Parameters:
              message - The name of the message
              -
              Returns:
              +
              Returns:
              The message, which has been formatted with & as the color character.
              -
              Throws:
              +
              Throws:
              java.lang.IllegalStateException - if your plugin has not loaded any messages
              +
              • -
            - - - -
              -
            • -

              getPlugin

              -
              public org.bukkit.plugin.Plugin getPlugin()
              -
              -
              Returns:
              +
            • +
              +

              getPlugin

              +
              public org.bukkit.plugin.Plugin getPlugin()
              +
              +
              Returns:
              The plugin these messages belong to
              +
              • -
            - - - -
              -
            • -

              get

              -
              public java.lang.String get​(java.lang.String msg)
              +
            • +
              +

              get

              +
              public java.lang.String get​(java.lang.String msg)
              Gets a color-formatted message by name
              -
              -
              Parameters:
              +
              +
              Parameters:
              msg - The name of the message
              -
              Returns:
              +
              Returns:
              The message, which has been formatted with & as the color character.
              -
              • -
            +
      -
    -
    - + + + + diff --git a/javadoc/redempt/redlib/commandmanager/exceptions/CommandHookException.html b/javadoc/redempt/redlib/commandmanager/exceptions/CommandHookException.html index 4f55fbe..dada99f 100644 --- a/javadoc/redempt/redlib/commandmanager/exceptions/CommandHookException.html +++ b/javadoc/redempt/redlib/commandmanager/exceptions/CommandHookException.html @@ -5,297 +5,192 @@ CommandHookException (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.commandmanager.exceptions
    -

    Class CommandHookException

    +
    Package redempt.redlib.commandmanager.exceptions
    +

    Class CommandHookException

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • java.lang.Throwable
        • -
      • -
          -
        • java.lang.Exception
          • -
        • -
            -
          • java.lang.RuntimeException
            • -
          • -
              -
            • java.lang.IllegalStateException
              • -
            • -
                -
              • redempt.redlib.commandmanager.exceptions.CommandHookException
                • -
              -
              • -
            -
            • -
          -
          • -
        -
        • -
      -
      • -
    -
    -
      -
    • -
      +
      java.lang.Object +
      java.lang.Throwable +
      java.lang.Exception +
      java.lang.RuntimeException +
      java.lang.IllegalStateException +
      redempt.redlib.commandmanager.exceptions.CommandHookException
      +
      +
      +
      +
      +
      +
      +
      All Implemented Interfaces:
      java.io.Serializable
      -
      public class CommandHookException
+
      public class CommandHookException
 extends java.lang.IllegalStateException
      
 
      Thrown when a command with a hook name specified does not find a method hook
      
-
      
-
      See Also:
      
+
      
+
      See Also:
      
 
      Serialized Form
      
 
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Constructor Summary

          - - +
        • +
          +

          Constructor Summary

          +
          +
          • Constructors 
          + + - - + + - - - + + + + + +
          Constructors
          ConstructorDescriptionConstructorDescription
          CommandHookException​(java.lang.String s) 
          CommandHookException​(java.lang.String s) 
          -
          • -
        +
    - -
    -
      -
    • - - -

      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
        • -
      • -
    + +
  • +
    +

    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

          - - - -
            -
          • -

            CommandHookException

            -
            public CommandHookException​(java.lang.String s)
            -
            • -
          +
        • +
          +

          Constructor Details

          +
            +
          • +
            +

            CommandHookException

            +
            public CommandHookException​(java.lang.String s)
            +
        -
    -
    - + + +
    + diff --git a/javadoc/redempt/redlib/commandmanager/exceptions/CommandParseException.html b/javadoc/redempt/redlib/commandmanager/exceptions/CommandParseException.html index 7567bea..c93577e 100644 --- a/javadoc/redempt/redlib/commandmanager/exceptions/CommandParseException.html +++ b/javadoc/redempt/redlib/commandmanager/exceptions/CommandParseException.html @@ -5,297 +5,192 @@ CommandParseException (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.commandmanager.exceptions
    -

    Class CommandParseException

    +
    Package redempt.redlib.commandmanager.exceptions
    +

    Class CommandParseException

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • java.lang.Throwable
        • -
      • -
          -
        • java.lang.Exception
          • -
        • -
            -
          • java.lang.RuntimeException
            • -
          • -
              -
            • java.lang.IllegalStateException
              • -
            • -
                -
              • redempt.redlib.commandmanager.exceptions.CommandParseException
                • -
              -
              • -
            -
            • -
          -
          • -
        -
        • -
      -
      • -
    -
    -
      -
    • -
      +
      java.lang.Object +
      java.lang.Throwable +
      java.lang.Exception +
      java.lang.RuntimeException +
      java.lang.IllegalStateException +
      redempt.redlib.commandmanager.exceptions.CommandParseException
      +
      +
      +
      +
      +
      +
      +
      All Implemented Interfaces:
      java.io.Serializable
      -
      public class CommandParseException
+
      public class CommandParseException
 extends java.lang.IllegalStateException
      
 
      Thrown when there is a problem found while parsing a command file
      
-
      
-
      See Also:
      
+
      
+
      See Also:
      
 
      Serialized Form
      
 
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Constructor Summary

          - - +
        • +
          +

          Constructor Summary

          +
          +
          • Constructors 
          + + - - + + - - - + + + + + +
          Constructors
          ConstructorDescriptionConstructorDescription
          CommandParseException​(java.lang.String s) 
          CommandParseException​(java.lang.String s) 
          -
          • -
        +
    - -
    -
      -
    • - - -

      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
        • -
      • -
    + +
  • +
    +

    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

          - - - -
            -
          • -

            CommandParseException

            -
            public CommandParseException​(java.lang.String s)
            -
            • -
          +
        • +
          +

          Constructor Details

          +
            +
          • +
            +

            CommandParseException

            +
            public CommandParseException​(java.lang.String s)
            +
        -
    -
    - + + +
    + diff --git a/javadoc/redempt/redlib/commandmanager/exceptions/package-summary.html b/javadoc/redempt/redlib/commandmanager/exceptions/package-summary.html index f4a57fc..fcfeca5 100644 --- a/javadoc/redempt/redlib/commandmanager/exceptions/package-summary.html +++ b/javadoc/redempt/redlib/commandmanager/exceptions/package-summary.html @@ -5,47 +5,30 @@ redempt.redlib.commandmanager.exceptions (RedLib API) + + - + + - - - - - + + - - -
    +
    + +

    Package redempt.redlib.commandmanager.exceptions

    -
    -
    -
    +
    + + +
    +
    + diff --git a/javadoc/redempt/redlib/commandmanager/exceptions/package-tree.html b/javadoc/redempt/redlib/commandmanager/exceptions/package-tree.html index 0dffd70..5f3ffca 100644 --- a/javadoc/redempt/redlib/commandmanager/exceptions/package-tree.html +++ b/javadoc/redempt/redlib/commandmanager/exceptions/package-tree.html @@ -5,101 +5,58 @@ redempt.redlib.commandmanager.exceptions Class Hierarchy (RedLib API) + + - + + - - - - - + + - - -
    +
    + +

    Hierarchy For Package redempt.redlib.commandmanager.exceptions

    -Package Hierarchies: +Package Hierarchies:
    -
    -
    +

    Class Hierarchy

    -
    +
    +
    diff --git a/javadoc/redempt/redlib/commandmanager/package-summary.html b/javadoc/redempt/redlib/commandmanager/package-summary.html index 4d3493a..29ac19c 100644 --- a/javadoc/redempt/redlib/commandmanager/package-summary.html +++ b/javadoc/redempt/redlib/commandmanager/package-summary.html @@ -5,47 +5,30 @@ redempt.redlib.commandmanager (RedLib API) + + - + + - - - - - + + - - -
    +
    + +

    Package redempt.redlib.commandmanager

    -
    -
    -
  • - - +
  • +
    +
    • Class Summary 
    + + - - + + + - - - + + - - - + + - - - + + - - - + + + - - - + + - - - + + - - - + + - - - + +
    Class Summary
    ClassDescriptionClassDescription
    ArgSubtype<T,​K> +
    ArgSubtype<T,​K>
    An ArgType which is dependent on another type appearing before it and uses it for conversions and tab completion
    ArgType<T> +
    ArgType<T>
    A command argument type, which converts a String argument to another type
    Command +
    Command
    Represents a command which can be registered
    Command.MethodHook 
    Command.MethodHook 
    CommandCollection +
    CommandCollection
    Represents a collection of commands which can be mass-registered.
    CommandParser +
    CommandParser
    Used to get ContextProviders and CommandArgumentTypes for a command file, then parse it
    ContextProvider<T> +
    ContextProvider<T>
    Used to provide context arguments to command method hooks
    Messages +
    Messages
    Represents a list of messages loaded from a file with defaults
    +
    • -
  • - - +
  • +
    +
    • Enum Summary 
    + + - - + + + - - - + + +
    Enum Summary
    EnumDescriptionEnumDescription
    Command.SenderType 
    Command.SenderType 
    +
    • -
  • - - +
  • +
    +
    • Annotation Types Summary 
    + + - - + + + - - - + + +
    Annotation Types Summary
    Annotation TypeDescriptionAnnotation TypeDescription
    CommandHook 
    CommandHook 
    +
    • - +
    + + +
    + + diff --git a/javadoc/redempt/redlib/commandmanager/package-tree.html b/javadoc/redempt/redlib/commandmanager/package-tree.html index 3e4cb4a..7e20c11 100644 --- a/javadoc/redempt/redlib/commandmanager/package-tree.html +++ b/javadoc/redempt/redlib/commandmanager/package-tree.html @@ -5,194 +5,127 @@ redempt.redlib.commandmanager Class Hierarchy (RedLib API) + + - + + - - - - - + + - - -
    +
    + +

    Hierarchy For Package redempt.redlib.commandmanager

    -Package Hierarchies: +Package Hierarchies:
    -
    -
    +

    Class Hierarchy

    -
    +

    Interface Hierarchy

    -
    +

    Annotation Type Hierarchy

      -
    • redempt.redlib.commandmanager.CommandHook (implements java.lang.annotation.Annotation)
      • +
    • redempt.redlib.commandmanager.CommandHook (implements java.lang.annotation.Annotation)
    -
    +

    Enum Hierarchy

    • java.lang.Object
        -
      • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) +
      • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.lang.constant.Constable, java.io.Serializable)
    -
    +
    +
    diff --git a/javadoc/redempt/redlib/configmanager/ConfigManager.html b/javadoc/redempt/redlib/configmanager/ConfigManager.html index 51886de..200b77c 100644 --- a/javadoc/redempt/redlib/configmanager/ConfigManager.html +++ b/javadoc/redempt/redlib/configmanager/ConfigManager.html @@ -5,841 +5,702 @@ ConfigManager (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.configmanager
    -

    Class ConfigManager

    +
    Package redempt.redlib.configmanager
    +

    Class ConfigManager

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.configmanager.ConfigManager
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      redempt.redlib.configmanager.ConfigManager
      +
      +
      -
      public class ConfigManager
+
      public class ConfigManager
 extends java.lang.Object
      
 
      Loads config values into variables annotated with ConfigValue
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Field Summary

          - - +
        • +
          +

          Field Summary

          +
          +
          • Fields 
          + + - - - + + + - - - - + + + + + + +
          Fields
          Modifier and TypeFieldDescriptionModifier and TypeFieldDescription
          protected java.util.Map<java.lang.Class<?>,​redempt.redlib.configmanager.TypeConverter<?>>converters 
          protected java.util.Map<java.lang.Class<?>,​redempt.redlib.configmanager.TypeConverter<?>>converters 
          -
          • -
        +
    + -
    -
      -
    • - - -

      Constructor Summary

      - - +
    • +
      +

      Constructor Summary

      +
      +
      • Constructors 
      + + - - + + - - - + + + + - - - + + - - - + + - - - + + +
      Constructors
      ConstructorDescriptionConstructorDescription
      ConfigManager​(java.io.File file) +
      ConfigManager​(java.io.File file)
      Initiates a ConfigManager using a specific file for the config
      ConfigManager​(java.nio.file.Path path) +
      ConfigManager​(java.nio.file.Path path)
      Initiates a ConfigManager using a specific path for the config
      ConfigManager​(org.bukkit.plugin.Plugin plugin) +
      ConfigManager​(org.bukkit.plugin.Plugin plugin)
      Instantiates a ConfigManager with the default config name config.yml in the plugin's data folder
      ConfigManager​(org.bukkit.plugin.Plugin plugin, - java.lang.String name) +
      ConfigManager​(org.bukkit.plugin.Plugin plugin, +java.lang.String name)
      Instantiates a ConfigManager with a specific config name in the plugin's config folder
      -
      • -
    +
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Static Methods Instance Methods Concrete Methods 
      + - - - + + + - - - - + + + + + - - - - + + + + - - - - + + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + +
      Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
      <T> ConfigManageraddConverter​(java.lang.Class<T> clazz, - java.util.function.Function<java.lang.String,​T> load, - java.util.function.Function<T,​java.lang.String> save) +
      <T> ConfigManageraddConverter​(java.lang.Class<T> clazz, +java.util.function.Function<java.lang.String,​T> load, +java.util.function.Function<T,​java.lang.String> save)
      Adds a type converter, which will attempt to convert a String from config to another type that is not usually able to be stored in config
      booleanconfigExists() 
      booleanconfigExists() 
      org.bukkit.configuration.file.YamlConfigurationgetConfig() 
      org.bukkit.configuration.file.YamlConfigurationgetConfig() 
      static <T> redempt.redlib.configmanager.ConfigList<T>list​(java.lang.Class<T> clazz, - ConversionType type, - T... elements) +
      static <T> redempt.redlib.configmanager.ConfigList<T>list​(java.lang.Class<T> clazz, +ConversionType type, +T... elements)
      Creates a ConfigList from a given type with initial elements.
      static <T> redempt.redlib.configmanager.ConfigList<T>list​(java.lang.Class<T> clazz, - T... elements) +
      static <T> redempt.redlib.configmanager.ConfigList<T>list​(java.lang.Class<T> clazz, +T... elements)
      Creates a ConfigList from a given type with initial elements.
      ConfigManagerload() +
      ConfigManagerload()
      Loads all values from config into the annotated hook fields
      static <K,​V>
      redempt.redlib.configmanager.ConfigMap<K,​V>      		map​(java.lang.Class<K> keyClass, - java.lang.Class<V> valueClass) +
      static <K,​ +V> redempt.redlib.configmanager.ConfigMap<K,​V>map​(java.lang.Class<K> keyClass, +java.lang.Class<V> valueClass)
      Creates a ConfigMap from a given type.
      static <K,​V>
      redempt.redlib.configmanager.ConfigMap<K,​V>      		map​(java.lang.Class<K> keyClass, - java.lang.Class<V> valueClass, - ConversionType type) +
      static <K,​ +V> redempt.redlib.configmanager.ConfigMap<K,​V>map​(java.lang.Class<K> keyClass, +java.lang.Class<V> valueClass, +ConversionType type)
      Creates a ConfigMap from a given type.
      static <T> redempt.redlib.configmanager.ConfigMap<java.lang.String,​T>map​(java.lang.Class<T> clazz) +
      static <T> redempt.redlib.configmanager.ConfigMap<java.lang.String,​T>map​(java.lang.Class<T> clazz)
      Creates a ConfigMap from a given type.
      static <T> redempt.redlib.configmanager.ConfigMap<java.lang.String,​T>map​(java.lang.Class<T> clazz, - ConversionType type) +
      static <T> redempt.redlib.configmanager.ConfigMap<java.lang.String,​T>map​(java.lang.Class<T> clazz, +ConversionType type)
      Creates a ConfigMap from a given type.
      ConfigManagerregister​(java.lang.Object... data) +
      ConfigManagerregister​(java.lang.Object... data)
      Register all the hooks for annotated fields in the the given objects.
      ConfigManagersave() +
      ConfigManagersave()
      Saves all values from the annotated hook fields to config
      ConfigManagersaveDefaults() +
      ConfigManagersaveDefaults()
      Save default values - initial values in the hook fields - where they do not already exist in the config
      static <T> redempt.redlib.configmanager.ConfigSet<T>set​(java.lang.Class<T> clazz, - ConversionType type, - T... elements) +
      static <T> redempt.redlib.configmanager.ConfigSet<T>set​(java.lang.Class<T> clazz, +ConversionType type, +T... elements)
      Creates a ConfigSet from a given type with initial elements.
      static <T> redempt.redlib.configmanager.ConfigSet<T>set​(java.lang.Class<T> clazz, - T... elements) +
      static <T> redempt.redlib.configmanager.ConfigSet<T>set​(java.lang.Class<T> clazz, +T... elements)
      Creates a ConfigSet from a given type with initial elements.
      static java.util.List<java.lang.String>stringList​(java.lang.String... strings) +
      static java.util.List<java.lang.String>stringList​(java.lang.String... strings)
      Instantiates a List of Strings inline
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

    Methods inherited from class java.lang.Object

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

          Field Detail

          - - - -
            -
          • -

            converters

            -
            protected java.util.Map<java.lang.Class<?>,​redempt.redlib.configmanager.TypeConverter<?>> converters
            -
            • -
          +
        • +
          +

          Field Details

          +
            +
          • +
            +

            converters

            +
            protected java.util.Map<java.lang.Class<?>,​redempt.redlib.configmanager.TypeConverter<?>> converters
            +
          +
          • -
          -
            -
          • - - -

            Constructor Detail

            - - - -
              -
            • -

              ConfigManager

              -
              public ConfigManager​(org.bukkit.plugin.Plugin plugin)
              +
            • +
              +

              Constructor Details

              +
                +
              • +
                +

                ConfigManager

                +
                public ConfigManager​(org.bukkit.plugin.Plugin plugin)
                Instantiates a ConfigManager with the default config name config.yml in the plugin's data folder
                -
                -
                Parameters:
                +
                +
                Parameters:
                plugin - The plugin
                +
                • -
              - - - -
                -
              • -

                ConfigManager

                -
                public ConfigManager​(org.bukkit.plugin.Plugin plugin,
-                     java.lang.String name)
                +
              • +
                +

                ConfigManager

                +
                public ConfigManager​(org.bukkit.plugin.Plugin plugin, +java.lang.String name)
                Instantiates a ConfigManager with a specific config name in the plugin's config folder
                -
                -
                Parameters:
                +
                +
                Parameters:
                plugin - The plugin
                name - The name of the config file to generate
                +
                • -
              - - - -
                -
              • -

                ConfigManager

                -
                public ConfigManager​(java.io.File file)
                +
              • +
                +

                ConfigManager

                +
                public ConfigManager​(java.io.File file)
                Initiates a ConfigManager using a specific file for the config
                -
                -
                Parameters:
                +
                +
                Parameters:
                file - The file
                +
                • -
              - - - -
                -
              • -

                ConfigManager

                -
                public ConfigManager​(java.nio.file.Path path)
                +
              • +
                +

                ConfigManager

                +
                public ConfigManager​(java.nio.file.Path path)
                Initiates a ConfigManager using a specific path for the config
                -
                -
                Parameters:
                +
                +
                Parameters:
                path - The path
                -
                • -
              +
          + -
          -
            -
          • - - -

            Method Detail

            - - - -
              -
            • -

              stringList

              -
              public static java.util.List<java.lang.String> stringList​(java.lang.String... strings)
              +
            • +
              +

              Method Details

              +
                +
              • +
                +

                stringList

                +
                public static java.util.List<java.lang.String> stringList​(java.lang.String... strings)
                Instantiates a List of Strings inline
                -
                -
                Parameters:
                +
                +
                Parameters:
                strings - The Strings to include in the List
                -
                Returns:
                +
                Returns:
                The List of Strings
                +
                • -
              - - - -
                -
              • -

                map

                -
                public static <T> redempt.redlib.configmanager.ConfigMap<java.lang.String,​T> map​(java.lang.Class<T> clazz)
                +
              • +
                +

                map

                +
                public static <T> +redempt.redlib.configmanager.ConfigMap<java.lang.String,​T> map​(java.lang.Class<T> clazz)
                Creates a ConfigMap from a given type. A ConfigMap extends LinkedHashMap. The class is not accessible, so store it in a HashMap variable. This method must be used to set the initial value for a variable which loads in a section from config.
                -
                -
                Type Parameters:
                +
                +
                Type Parameters:
                T - The value type
                -
                Parameters:
                +
                Parameters:
                clazz - The class of the value type
                -
                Returns:
                +
                Returns:
                An empty map of the given type, which will be populated when load() is called
                +
                • -
              - - - -
                -
              • -

                map

                -
                public static <T> redempt.redlib.configmanager.ConfigMap<java.lang.String,​T> map​(java.lang.Class<T> clazz,
-                                                                                       ConversionType type)
                +
              • +
                +

                map

                +
                public static <T> +redempt.redlib.configmanager.ConfigMap<java.lang.String,​T> map​(java.lang.Class<T> clazz, +ConversionType type)
                Creates a ConfigMap from a given type. A ConfigMap extends LinkedHashMap. The class is not accessible, so store it in a HashMap variable. This method must be used to set the initial value for a variable which loads in a section from config.
                -
                -
                Type Parameters:
                +
                +
                Type Parameters:
                T - The value type
                -
                Parameters:
                +
                Parameters:
                clazz - The class of the value type
                type - The method which will be used to convert the stored type
                -
                Returns:
                +
                Returns:
                An empty map of the given type, which will be populated when load() is called
                +
                • -
              - - - -
                -
              • -

                map

                -
                public static <K,​V> redempt.redlib.configmanager.ConfigMap<K,​V> map​(java.lang.Class<K> keyClass,
-                                                                                java.lang.Class<V> valueClass)
                +
              • +
                +

                map

                +
                public static <K,​ +V> +redempt.redlib.configmanager.ConfigMap<K,​V> map​(java.lang.Class<K> keyClass, +java.lang.Class<V> valueClass)
                Creates a ConfigMap from a given type. A ConfigMap extends LinkedHashMap. The class is not accessible, so store it in a HashMap variable. This method must be used to set the initial value for a variable which loads in a section from config. The key class may only be a type which has converter from string to another type. For obvious reasons, it cannot be a config-mappable object.
                -
                -
                Type Parameters:
                +
                +
                Type Parameters:
                K - The key type
                V - The value type
                -
                Parameters:
                +
                Parameters:
                keyClass - The class of the key type
                valueClass - The class of the value type
                -
                Returns:
                +
                Returns:
                An empty map of the given type, which will be populated when load() is called
                +
                • -
              - - - -
                -
              • -

                map

                -
                public static <K,​V> redempt.redlib.configmanager.ConfigMap<K,​V> map​(java.lang.Class<K> keyClass,
-                                                                                java.lang.Class<V> valueClass,
-                                                                                ConversionType type)
                +
              • +
                +

                map

                +
                public static <K,​ +V> +redempt.redlib.configmanager.ConfigMap<K,​V> map​(java.lang.Class<K> keyClass, +java.lang.Class<V> valueClass, +ConversionType type)
                Creates a ConfigMap from a given type. A ConfigMap extends LinkedHashMap. The class is not accessible, so store it in a HashMap variable. This method must be used to set the initial value for a variable which loads in a section from config. The key class may only be a type which has converter from string to another type. For obvious reasons, it cannot be a config-mappable object.
                -
                -
                Type Parameters:
                +
                +
                Type Parameters:
                K - The key type
                V - The value type
                -
                Parameters:
                +
                Parameters:
                keyClass - The class of the key type
                valueClass - The class of the value type
                type - The method which will be used to convert the value type
                -
                Returns:
                +
                Returns:
                An empty map of the given type, which will be populated when load() is called
                +
                • -
              - - - - - -
                -
              • -

                list

                -
                public static <T> redempt.redlib.configmanager.ConfigList<T> list​(java.lang.Class<T> clazz,
-                                                                  T... elements)
                +
              • +
                +

                list

                +
                public static <T> +redempt.redlib.configmanager.ConfigList<T> list​(java.lang.Class<T> clazz, +T... elements)
                Creates a ConfigList from a given type with initial elements. A ConfigList extends ArrayList. The class is not accessible, so store it in an ArrayList variable. This method must be used to set the initial value for a variable which loads a list from config using type converters or mapped objects.
                -
                -
                Type Parameters:
                +
                +
                Type Parameters:
                T - The type
                -
                Parameters:
                +
                Parameters:
                clazz - The class of the type of the list
                elements - The elements to initialize the list with
                -
                Returns:
                +
                Returns:
                A list of the given type which has been populated with the given elements
                +
                • -
              - - - - - -
                -
              • -

                list

                -
                public static <T> redempt.redlib.configmanager.ConfigList<T> list​(java.lang.Class<T> clazz,
-                                                                  ConversionType type,
-                                                                  T... elements)
                +
              • +
                +

                list

                +
                public static <T> +redempt.redlib.configmanager.ConfigList<T> list​(java.lang.Class<T> clazz, +ConversionType type, +T... elements)
                Creates a ConfigList from a given type with initial elements. A ConfigList extends ArrayList. The class is not accessible, so store it in an ArrayList variable. This method must be used to set the initial value for a variable which loads a list from config using type converters or mapped objects.
                -
                -
                Type Parameters:
                +
                +
                Type Parameters:
                T - The type
                -
                Parameters:
                +
                Parameters:
                clazz - The class of the type of the list
                elements - The elements to initialize the list with
                type - The method which will be used to convert the stored type
                -
                Returns:
                +
                Returns:
                A list of the given type which has been populated with the given elements
                +
                • -
              - - - - - -
                -
              • -

                set

                -
                public static <T> redempt.redlib.configmanager.ConfigSet<T> set​(java.lang.Class<T> clazz,
-                                                                T... elements)
                +
              • +
                +

                set

                +
                public static <T> +redempt.redlib.configmanager.ConfigSet<T> set​(java.lang.Class<T> clazz, +T... elements)
                Creates a ConfigSet from a given type with initial elements. A ConfigSet extends LinkedHashSet. The class is not accessible, so store it in a HashSet variable. This method must be used to set the initial value for a variable which loads a set from config using type converters or mapped objects.
                -
                -
                Type Parameters:
                +
                +
                Type Parameters:
                T - The type
                -
                Parameters:
                +
                Parameters:
                clazz - The class of the type of the list
                elements - The elements to initialize the list with
                -
                Returns:
                +
                Returns:
                A list of the given type which has been populated with the given elements
                +
                • -
              - - - - - -
                -
              • -

                set

                -
                public static <T> redempt.redlib.configmanager.ConfigSet<T> set​(java.lang.Class<T> clazz,
-                                                                ConversionType type,
-                                                                T... elements)
                +
              • +
                +

                set

                +
                public static <T> +redempt.redlib.configmanager.ConfigSet<T> set​(java.lang.Class<T> clazz, +ConversionType type, +T... elements)
                Creates a ConfigSet from a given type with initial elements. A ConfigSet extends LinkedHashSet. The class is not accessible, so store it in a HashSet variable. This method must be used to set the initial value for a variable which loads a set from config using type converters or mapped objects.
                -
                -
                Type Parameters:
                +
                +
                Type Parameters:
                T - The type
                -
                Parameters:
                +
                Parameters:
                clazz - The class of the type of the list
                elements - The elements to initialize the list with
                type - The method which will be used to convert the stored type
                -
                Returns:
                +
                Returns:
                A list of the given type which has been populated with the given elements
                +
                • -
              - - - -
                -
              • -

                addConverter

                -
                public <T> ConfigManager addConverter​(java.lang.Class<T> clazz,
-                                      java.util.function.Function<java.lang.String,​T> load,
-                                      java.util.function.Function<T,​java.lang.String> save)
                +
              • +
                +

                addConverter

                +
                public <T> ConfigManager addConverter​(java.lang.Class<T> clazz, +java.util.function.Function<java.lang.String,​T> load, +java.util.function.Function<T,​java.lang.String> save)
                Adds a type converter, which will attempt to convert a String from config to another type that is not usually able to be stored in config
                -
                -
                Type Parameters:
                +
                +
                Type Parameters:
                T - The type
                -
                Parameters:
                +
                Parameters:
                clazz - The class of the type
                load - A function to convert from a string to the type
                save - A function to convert from the type to a string
                -
                Returns:
                +
                Returns:
                This ConfigManager
                +
                • -
              - - - -
                -
              • -

                register

                -
                public ConfigManager register​(java.lang.Object... data)
                +
              • +
                +

                register

                +
                public ConfigManager register​(java.lang.Object... data)
                Register all the hooks for annotated fields in the the given objects. Pass classes instead if static fields are used.
                -
                -
                Parameters:
                +
                +
                Parameters:
                data - The object to be registered
                -
                Returns:
                +
                Returns:
                This ConfigManager
                +
                • -
              - - - -
                -
              • -

                configExists

                -
                public boolean configExists()
                -
                -
                Returns:
                +
              • +
                +

                configExists

                +
                public boolean configExists()
                +
                +
                Returns:
                Whether the config file exists
                +
                • -
              - - - -
                -
              • -

                saveDefaults

                -
                public ConfigManager saveDefaults()
                +
              • +
                +

                saveDefaults

                +
                public ConfigManager saveDefaults()
                Save default values - initial values in the hook fields - where they do not already exist in the config
                -
                -
                Returns:
                +
                +
                Returns:
                This ConfigManager
                -
                Throws:
                +
                Throws:
                java.lang.IllegalStateException - if this ConfigManager has not been registered yet
                +
                • -
              - - - -
                -
              • -

                load

                -
                public ConfigManager load()
                +
              • +
                +

                load

                +
                public ConfigManager load()
                Loads all values from config into the annotated hook fields
                -
                -
                Returns:
                +
                +
                Returns:
                This ConfigManager
                -
                Throws:
                +
                Throws:
                java.lang.IllegalStateException - if this ConfigManager has not been registered yet
                +
                • -
              - - - -
                -
              • -

                save

                -
                public ConfigManager save()
                +
              • +
                +

                save

                +
                public ConfigManager save()
                Saves all values from the annotated hook fields to config
                -
                -
                Returns:
                +
                +
                Returns:
                This ConfigManager
                -
                Throws:
                +
                Throws:
                java.lang.IllegalStateException - if this ConfigManager has not been registered yet
                +
                • -
              - - - -
                -
              • -

                getConfig

                -
                public org.bukkit.configuration.file.YamlConfiguration getConfig()
                -
                -
                Returns:
                +
              • +
                +

                getConfig

                +
                public org.bukkit.configuration.file.YamlConfiguration getConfig()
                +
                +
                Returns:
                The configuration this ConfigManager is loading from and saving to
                -
                • -
              +
        -
    - - + + + + diff --git a/javadoc/redempt/redlib/configmanager/ConfigStorage.html b/javadoc/redempt/redlib/configmanager/ConfigStorage.html index 764e102..c23071a 100644 --- a/javadoc/redempt/redlib/configmanager/ConfigStorage.html +++ b/javadoc/redempt/redlib/configmanager/ConfigStorage.html @@ -5,271 +5,191 @@ ConfigStorage (RedLib API) + + - + + - - - - - + + - - -
    +
    +
    + + + +
    - +
    +
    -
    Package redempt.redlib.configmanager
    -

    Interface ConfigStorage

    +
    Package redempt.redlib.configmanager
    +

    Interface ConfigStorage

    -
    -
    -
      -
    • +
      -
      public interface ConfigStorage
      -
      • -
    -
    -
    -
      -
    • +
      public interface ConfigStorage
      + +
      +
        -
        -
          -
        • - - -

          Method Summary

          - - +
        • +
          +

          Method Summary

          +
          +
          +
          +
          • All Methods Instance Methods Abstract Methods 
          + - - - + + + - - - - + + + + + + - - - - + + + + - - - - + + + + +
          Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
          voidinit​(ConfigManager manager) 
          voidinit​(ConfigManager manager) 
          voidload​(org.bukkit.configuration.ConfigurationSection section) 
          voidload​(org.bukkit.configuration.ConfigurationSection section) 
          voidsave​(org.bukkit.configuration.ConfigurationSection section) 
          voidsave​(org.bukkit.configuration.ConfigurationSection section) 
          -
          • -
        +
    +
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Method Detail

          - - - - - - - -
            -
          • -

            save

            -
            void save​(org.bukkit.configuration.ConfigurationSection section)
            +
          • +
            +

            Method Details

            + - - - -
              -
            • -

              load

              -
              void load​(org.bukkit.configuration.ConfigurationSection section)
              +
            • +
              +

              save

              +
              void save​(org.bukkit.configuration.ConfigurationSection section)
              +
              • -
            +
          • +
            +

            load

            +
            void load​(org.bukkit.configuration.ConfigurationSection section)
            +
      -
    - - + + + + diff --git a/javadoc/redempt/redlib/configmanager/ConversionType.html b/javadoc/redempt/redlib/configmanager/ConversionType.html index 593a00d..7b1bce0 100644 --- a/javadoc/redempt/redlib/configmanager/ConversionType.html +++ b/javadoc/redempt/redlib/configmanager/ConversionType.html @@ -5,426 +5,322 @@ ConversionType (RedLib API) + + - + + - - - - - + + - - -
    +
    +
    + + + +
    - +
    +
    -
    Package redempt.redlib.configmanager
    -

    Enum ConversionType

    +
    Package redempt.redlib.configmanager
    +

    Enum ConversionType

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • java.lang.Enum<ConversionType>
        • -
      • -
          -
        • redempt.redlib.configmanager.ConversionType
          • -
        -
        • -
      -
      • -
    -
    -
      -
    • -
      +
      java.lang.Object +
      java.lang.Enum<ConversionType> +
      redempt.redlib.configmanager.ConversionType
      +
      +
      +
      +
      All Implemented Interfaces:
      -
      java.io.Serializable, java.lang.Comparable<ConversionType>
      +
      java.io.Serializable, java.lang.Comparable<ConversionType>, java.lang.constant.Constable
      -
      public enum ConversionType
+
      public enum ConversionType
 extends java.lang.Enum<ConversionType>
      
 
      Represents ways in which objects can be mapped from config
      
+
      +
      +
        + +
      • +
        +

        Nested Class Summary

        +
        +

        Nested classes/interfaces inherited from class java.lang.Enum

        +java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>
        +
        • -
      -
    -
    -
      -
    • -
      -
        -
      • - - -

        Enum Constant Summary

        - - +
      • +
        +

        Enum Constant Summary

        +
        +
        • Enum Constants 
        + + - - + + - - - + + + + - - - + + - - - + + - - - + + +
        Enum Constants
        Enum ConstantDescriptionEnum ConstantDescription
        AUTO +
        AUTO
        Auto-detect the conversion type based on context
        MAPPED_OBJECT +
        MAPPED_OBJECT
        A config value mapped from a class annotated with ConfigMappable
        PLAIN +
        PLAIN
        A config value loaded and stored directly from config
        STRING_CONVERTED +
        STRING_CONVERTED
        A config value converted to and from a string using TypeConverters
        -
        • -
      +
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Static Methods Concrete Methods 
      + - - - + + + - - - - + + + + + + - - - - + + + - - - - + + + +
      Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
      protected static ConversionTypeauto​(java.lang.Class<?> clazz, - ConfigManager manager) 
      protected static ConversionTypeauto​(java.lang.Class<?> clazz, +ConfigManager manager) 
      static ConversionTypevalueOf​(java.lang.String name) +
      static ConversionTypevalueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static ConversionType[]values() +
      static ConversionType[]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
        • -
      -
      • -
    +
    +
    +
    +

    Methods inherited from class java.lang.Enum

    +clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
    +
    +

    Methods inherited from class java.lang.Object

    +getClass, notify, notifyAll, wait, wait, wait
    - -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Enum Constant Detail

          - - - -
            -
          • -

            MAPPED_OBJECT

            -
            public static final ConversionType MAPPED_OBJECT
            +
          • +
            +

            Enum Constant Details

            +
              +
            • +
              +

              MAPPED_OBJECT

              +
              public static final ConversionType MAPPED_OBJECT
              A config value mapped from a class annotated with ConfigMappable
              +
              • -
            - - - -
              -
            • -

              STRING_CONVERTED

              -
              public static final ConversionType STRING_CONVERTED
              +
            • +
              +

              STRING_CONVERTED

              +
              public static final ConversionType STRING_CONVERTED
              A config value converted to and from a string using TypeConverters
              +
              • -
            - - - -
              -
            • -

              PLAIN

              -
              public static final ConversionType PLAIN
              +
            • +
              +

              PLAIN

              +
              public static final ConversionType PLAIN
              A config value loaded and stored directly from config
              +
              • -
            - - - -
              -
            • -

              AUTO

              -
              public static final ConversionType AUTO
              +
            • +
              +

              AUTO

              +
              public static final ConversionType AUTO
              Auto-detect the conversion type based on context
              -
              • -
            +
        + -
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            values

            -
            public static ConversionType[] values()
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              values

              +
              public static ConversionType[] 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 (ConversionType c : ConversionType.values())
-    System.out.println(c);
-
              -
              -
              Returns:
              +the order they are declared.
    +
    +
    Returns:
    an array containing the constants of this enum type, in the order they are declared
    + - - - - -
      -
    • -

      valueOf

      -
      public static ConversionType valueOf​(java.lang.String name)
      +
    • +
      +

      valueOf

      +
      public static ConversionType 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:
      +
      +
      Parameters:
      name - the name of the enum constant to be returned.
      -
      Returns:
      +
      Returns:
      the enum constant with the specified name
      -
      Throws:
      +
      Throws:
      java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
      java.lang.NullPointerException - if the argument is null
      +
      • -
    - - - - +
  • +
    +

    auto

    +
    protected static ConversionType auto​(java.lang.Class<?> clazz, +ConfigManager manager)
    +
    • - - - + + + + diff --git a/javadoc/redempt/redlib/configmanager/annotations/ConfigMappable.html b/javadoc/redempt/redlib/configmanager/annotations/ConfigMappable.html index 3aa310a..7218e0e 100644 --- a/javadoc/redempt/redlib/configmanager/annotations/ConfigMappable.html +++ b/javadoc/redempt/redlib/configmanager/annotations/ConfigMappable.html @@ -5,182 +5,113 @@ ConfigMappable (RedLib API) + + - + + - - - - - + + - - -
    +
    +
    + + + +
    - +
    +
    -
    Package redempt.redlib.configmanager.annotations
    -

    Annotation Type ConfigMappable

    +
    Package redempt.redlib.configmanager.annotations
    +

    Annotation Type ConfigMappable

    -
    -
    -
      -
    • +
      @Retention(RUNTIME)
 @Target(TYPE)
 @Inherited
-public @interface ConfigMappable
      -
      • -
    -
    -
    -
    +public @interface ConfigMappable + + +
    + diff --git a/javadoc/redempt/redlib/configmanager/annotations/ConfigPath.html b/javadoc/redempt/redlib/configmanager/annotations/ConfigPath.html index 48396aa..232090a 100644 --- a/javadoc/redempt/redlib/configmanager/annotations/ConfigPath.html +++ b/javadoc/redempt/redlib/configmanager/annotations/ConfigPath.html @@ -5,182 +5,113 @@ ConfigPath (RedLib API) + + - + + - - - - - + + - - -
    +
    +
    + + + +
    - +
    +
    -
    Package redempt.redlib.configmanager.annotations
    -

    Annotation Type ConfigPath

    +
    Package redempt.redlib.configmanager.annotations
    +

    Annotation Type ConfigPath

    -
    -
    -
      -
    • +
      @Retention(RUNTIME)
 @Target(FIELD)
 @Inherited
-public @interface ConfigPath
      -
      • -
    -
    -
    -
    +public @interface ConfigPath + + +
    + diff --git a/javadoc/redempt/redlib/configmanager/annotations/ConfigPostInit.html b/javadoc/redempt/redlib/configmanager/annotations/ConfigPostInit.html index 3bd52f6..dc43150 100644 --- a/javadoc/redempt/redlib/configmanager/annotations/ConfigPostInit.html +++ b/javadoc/redempt/redlib/configmanager/annotations/ConfigPostInit.html @@ -5,182 +5,113 @@ ConfigPostInit (RedLib API) + + - + + - - - - - + + - - -
    +
    +
    + + + +
    - +
    +
    -
    Package redempt.redlib.configmanager.annotations
    -

    Annotation Type ConfigPostInit

    +
    Package redempt.redlib.configmanager.annotations
    +

    Annotation Type ConfigPostInit

    -
    -
    -
      -
    • +
      @Retention(RUNTIME)
 @Target(METHOD)
 @Inherited
-public @interface ConfigPostInit
      -
      • -
    -
    -
    -
    +public @interface ConfigPostInit + + +
    + diff --git a/javadoc/redempt/redlib/configmanager/annotations/ConfigValue.html b/javadoc/redempt/redlib/configmanager/annotations/ConfigValue.html index 6484d4a..fc1cbae 100644 --- a/javadoc/redempt/redlib/configmanager/annotations/ConfigValue.html +++ b/javadoc/redempt/redlib/configmanager/annotations/ConfigValue.html @@ -5,313 +5,229 @@ ConfigValue (RedLib API) + + - + + - - - - - + + - - -
    +
    +
    + + + +
    - +
    +
    -
    Package redempt.redlib.configmanager.annotations
    -

    Annotation Type ConfigValue

    +
    Package redempt.redlib.configmanager.annotations
    +

    Annotation Type ConfigValue

    -
    -
    -
      -
    • +
      @Target(FIELD)
 @Retention(RUNTIME)
 @Inherited
-public @interface ConfigValue
      -
      • -
    -
    -
    -
      -
    • +public @interface ConfigValue + +
      +
        -
        -
          -
        • - - -

          Required Element Summary

          - - +
        • +
          +

          Required Element Summary

          +
          +
          • Required Elements 
          + + - - - + + + - - - - + + + + + + +
          Required Elements
          Modifier and TypeRequired ElementDescriptionModifier and TypeRequired ElementDescription
          java.lang.Stringvalue 
          java.lang.Stringvalue 
          -
          • -
        +
    + -
    -
      -
    • - - -

      Optional Element Summary

      - - +
    • +
      +

      Optional Element Summary

      +
      +
      • Optional Elements 
      + + - - - + + + - - - - + + + + + + - - - - + + + + +
      Optional Elements
      Modifier and TypeOptional ElementDescriptionModifier and TypeOptional ElementDescription
      intpriority 
      intpriority 
      ConversionTypetype 
      ConversionTypetype 
      -
      • -
    +
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Element Detail

          - - - -
            -
          • -

            value

            -
            java.lang.String value
            -
            -
            Returns:
            +
          • +
            +

            Element Details

            +
              +
            • +
              +

              value

              +
              java.lang.String value
              +
              +
              Returns:
              The path to the config value represented by the field bearing this annotation
              -
              • -
            +
        + -
        -
          -
        • - - -
            -
          • -

            priority

            -
            int priority
            -
            -
            Returns:
            +
          • +
            +
              +
            • +
              +

              priority

              +
              int priority
              +
              +
              Returns:
              The priority of this ConfigValue, higher priority will be loaded first
              -
              +
              Default:
              1
              -
              • -
            -
            • -
        -
        -
          -
        • - - -
            -
          • -

            type

            -
            ConversionType type
            -
            -
            Returns:
            +
            • +
          • +
            +

            type

            +
            ConversionType type
            +
            +
            Returns:
            Which type of conversion this value should use
            -
            +
            Default:
            -
            redempt.redlib.configmanager.ConversionType.AUTO
            +
            AUTO
            -
            • -
          +
    -
    - - + + + + diff --git a/javadoc/redempt/redlib/configmanager/annotations/package-summary.html b/javadoc/redempt/redlib/configmanager/annotations/package-summary.html index 0d04275..3128f9e 100644 --- a/javadoc/redempt/redlib/configmanager/annotations/package-summary.html +++ b/javadoc/redempt/redlib/configmanager/annotations/package-summary.html @@ -5,47 +5,30 @@ redempt.redlib.configmanager.annotations (RedLib API) + + - + + - - - - - + + - - -
    +
    + +

    Package redempt.redlib.configmanager.annotations

    -
    -
    -
    +
    + + +
    +
    + diff --git a/javadoc/redempt/redlib/configmanager/annotations/package-tree.html b/javadoc/redempt/redlib/configmanager/annotations/package-tree.html index 91c30be..6fbd6f3 100644 --- a/javadoc/redempt/redlib/configmanager/annotations/package-tree.html +++ b/javadoc/redempt/redlib/configmanager/annotations/package-tree.html @@ -5,155 +5,88 @@ redempt.redlib.configmanager.annotations Class Hierarchy (RedLib API) + + - + + - - - - - + + - - -
    +
    + +

    Hierarchy For Package redempt.redlib.configmanager.annotations

    -Package Hierarchies: +Package Hierarchies:
    -
    -
    +

    Annotation Type Hierarchy

      -
    • redempt.redlib.configmanager.annotations.ConfigMappable (implements java.lang.annotation.Annotation)
      • -
    • redempt.redlib.configmanager.annotations.ConfigPath (implements java.lang.annotation.Annotation)
      • -
    • redempt.redlib.configmanager.annotations.ConfigPostInit (implements java.lang.annotation.Annotation)
      • -
    • redempt.redlib.configmanager.annotations.ConfigValue (implements java.lang.annotation.Annotation)
      • +
    • redempt.redlib.configmanager.annotations.ConfigMappable (implements java.lang.annotation.Annotation)
      • +
    • redempt.redlib.configmanager.annotations.ConfigPath (implements java.lang.annotation.Annotation)
      • +
    • redempt.redlib.configmanager.annotations.ConfigPostInit (implements java.lang.annotation.Annotation)
      • +
    • redempt.redlib.configmanager.annotations.ConfigValue (implements java.lang.annotation.Annotation)
    -
    +
    +
    diff --git a/javadoc/redempt/redlib/configmanager/exceptions/ConfigFieldException.html b/javadoc/redempt/redlib/configmanager/exceptions/ConfigFieldException.html index d307bfe..8f838ca 100644 --- a/javadoc/redempt/redlib/configmanager/exceptions/ConfigFieldException.html +++ b/javadoc/redempt/redlib/configmanager/exceptions/ConfigFieldException.html @@ -5,297 +5,192 @@ ConfigFieldException (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.configmanager.exceptions
    -

    Class ConfigFieldException

    +
    Package redempt.redlib.configmanager.exceptions
    +

    Class ConfigFieldException

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • java.lang.Throwable
        • -
      • -
          -
        • java.lang.Exception
          • -
        • -
            -
          • java.lang.RuntimeException
            • -
          • -
              -
            • java.lang.IllegalStateException
              • -
            • -
                -
              • redempt.redlib.configmanager.exceptions.ConfigFieldException
                • -
              -
              • -
            -
            • -
          -
          • -
        -
        • -
      -
      • -
    -
    -
      -
    • -
      +
      java.lang.Object +
      java.lang.Throwable +
      java.lang.Exception +
      java.lang.RuntimeException +
      java.lang.IllegalStateException +
      redempt.redlib.configmanager.exceptions.ConfigFieldException
      +
      +
      +
      +
      +
      +
      +
      All Implemented Interfaces:
      java.io.Serializable
      -
      public class ConfigFieldException
+
      public class ConfigFieldException
 extends java.lang.IllegalStateException
      
 
      Thrown when a field with a CommandHook is final
      
-
      
-
      See Also:
      
+
      
+
      See Also:
      
 
      Serialized Form
      
 
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Constructor Summary

          - - +
        • +
          +

          Constructor Summary

          +
          +
          • Constructors 
          + + - - + + - - - + + + + + +
          Constructors
          ConstructorDescriptionConstructorDescription
          ConfigFieldException​(java.lang.String s) 
          ConfigFieldException​(java.lang.String s) 
          -
          • -
        +
    - -
    -
      -
    • - - -

      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
        • -
      • -
    + +
  • +
    +

    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

          - - - -
            -
          • -

            ConfigFieldException

            -
            public ConfigFieldException​(java.lang.String s)
            -
            • -
          +
        • +
          +

          Constructor Details

          +
            +
          • +
            +

            ConfigFieldException

            +
            public ConfigFieldException​(java.lang.String s)
            +
        -
    -
    - + + +
    + diff --git a/javadoc/redempt/redlib/configmanager/exceptions/ConfigListException.html b/javadoc/redempt/redlib/configmanager/exceptions/ConfigListException.html index f822482..363754a 100644 --- a/javadoc/redempt/redlib/configmanager/exceptions/ConfigListException.html +++ b/javadoc/redempt/redlib/configmanager/exceptions/ConfigListException.html @@ -5,297 +5,192 @@ ConfigListException (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.configmanager.exceptions
    -

    Class ConfigListException

    +
    Package redempt.redlib.configmanager.exceptions
    +

    Class ConfigListException

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • java.lang.Throwable
        • -
      • -
          -
        • java.lang.Exception
          • -
        • -
            -
          • java.lang.RuntimeException
            • -
          • -
              -
            • java.lang.IllegalStateException
              • -
            • -
                -
              • redempt.redlib.configmanager.exceptions.ConfigListException
                • -
              -
              • -
            -
            • -
          -
          • -
        -
        • -
      -
      • -
    -
    -
      -
    • -
      +
      java.lang.Object +
      java.lang.Throwable +
      java.lang.Exception +
      java.lang.RuntimeException +
      java.lang.IllegalStateException +
      redempt.redlib.configmanager.exceptions.ConfigListException
      +
      +
      +
      +
      +
      +
      +
      All Implemented Interfaces:
      java.io.Serializable
      -
      public class ConfigListException
+
      public class ConfigListException
 extends java.lang.IllegalStateException
      
 
      Thrown when an error occurs with a ConfigList
      
-
      
-
      See Also:
      
+
      
+
      See Also:
      
 
      Serialized Form
      
 
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Constructor Summary

          - - +
        • +
          +

          Constructor Summary

          +
          +
          • Constructors 
          + + - - + + - - - + + + + + +
          Constructors
          ConstructorDescriptionConstructorDescription
          ConfigListException​(java.lang.String s) 
          ConfigListException​(java.lang.String s) 
          -
          • -
        +
    - -
    -
      -
    • - - -

      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
        • -
      • -
    + +
  • +
    +

    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

          - - - -
            -
          • -

            ConfigListException

            -
            public ConfigListException​(java.lang.String s)
            -
            • -
          +
        • +
          +

          Constructor Details

          +
            +
          • +
            +

            ConfigListException

            +
            public ConfigListException​(java.lang.String s)
            +
        -
    -
    - + + +
    + diff --git a/javadoc/redempt/redlib/configmanager/exceptions/ConfigMapException.html b/javadoc/redempt/redlib/configmanager/exceptions/ConfigMapException.html index 9c6b97a..89e4577 100644 --- a/javadoc/redempt/redlib/configmanager/exceptions/ConfigMapException.html +++ b/javadoc/redempt/redlib/configmanager/exceptions/ConfigMapException.html @@ -5,297 +5,192 @@ ConfigMapException (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.configmanager.exceptions
    -

    Class ConfigMapException

    +
    Package redempt.redlib.configmanager.exceptions
    +

    Class ConfigMapException

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • java.lang.Throwable
        • -
      • -
          -
        • java.lang.Exception
          • -
        • -
            -
          • java.lang.RuntimeException
            • -
          • -
              -
            • java.lang.IllegalStateException
              • -
            • -
                -
              • redempt.redlib.configmanager.exceptions.ConfigMapException
                • -
              -
              • -
            -
            • -
          -
          • -
        -
        • -
      -
      • -
    -
    -
      -
    • -
      +
      java.lang.Object +
      java.lang.Throwable +
      java.lang.Exception +
      java.lang.RuntimeException +
      java.lang.IllegalStateException +
      redempt.redlib.configmanager.exceptions.ConfigMapException
      +
      +
      +
      +
      +
      +
      +
      All Implemented Interfaces:
      java.io.Serializable
      -
      public class ConfigMapException
+
      public class ConfigMapException
 extends java.lang.IllegalStateException
      
 
      Thrown when there is an error mapping a ConfigurationSection to an object
      
-
      
-
      See Also:
      
+
      
+
      See Also:
      
 
      Serialized Form
      
 
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Constructor Summary

          - - +
        • +
          +

          Constructor Summary

          +
          +
          • Constructors 
          + + - - + + - - - + + + + + +
          Constructors
          ConstructorDescriptionConstructorDescription
          ConfigMapException​(java.lang.String s) 
          ConfigMapException​(java.lang.String s) 
          -
          • -
        +
    - -
    -
      -
    • - - -

      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
        • -
      • -
    + +
  • +
    +

    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

          - - - -
            -
          • -

            ConfigMapException

            -
            public ConfigMapException​(java.lang.String s)
            -
            • -
          +
        • +
          +

          Constructor Details

          +
            +
          • +
            +

            ConfigMapException

            +
            public ConfigMapException​(java.lang.String s)
            +
        -
    -
    - + + +
    + diff --git a/javadoc/redempt/redlib/configmanager/exceptions/package-summary.html b/javadoc/redempt/redlib/configmanager/exceptions/package-summary.html index 4d18f74..ca65246 100644 --- a/javadoc/redempt/redlib/configmanager/exceptions/package-summary.html +++ b/javadoc/redempt/redlib/configmanager/exceptions/package-summary.html @@ -5,47 +5,30 @@ redempt.redlib.configmanager.exceptions (RedLib API) + + - + + - - - - - + + - - -
    +
    + +

    Package redempt.redlib.configmanager.exceptions

    -
    -
    -
    +
    + + +
    +
    + diff --git a/javadoc/redempt/redlib/configmanager/exceptions/package-tree.html b/javadoc/redempt/redlib/configmanager/exceptions/package-tree.html index fb0ee8c..ca758f5 100644 --- a/javadoc/redempt/redlib/configmanager/exceptions/package-tree.html +++ b/javadoc/redempt/redlib/configmanager/exceptions/package-tree.html @@ -5,101 +5,58 @@ redempt.redlib.configmanager.exceptions Class Hierarchy (RedLib API) + + - + + - - - - - + + - - -
    +
    + +

    Hierarchy For Package redempt.redlib.configmanager.exceptions

    -Package Hierarchies: +Package Hierarchies:
    -
    -
    +

    Class Hierarchy

    -
    +
    +
    diff --git a/javadoc/redempt/redlib/configmanager/package-summary.html b/javadoc/redempt/redlib/configmanager/package-summary.html index f2c93c8..c9fcc8c 100644 --- a/javadoc/redempt/redlib/configmanager/package-summary.html +++ b/javadoc/redempt/redlib/configmanager/package-summary.html @@ -5,47 +5,30 @@ redempt.redlib.configmanager (RedLib API) + + - + + - - - - - + + - - -
    +
    + +

    Package redempt.redlib.configmanager

    -
    -
      -
    • - - +
      +
        +
      • +
        +
      Interface Summary 
      + + - - + + + - - - + + +
      Interface Summary
      InterfaceDescriptionInterfaceDescription
      ConfigStorage 
      ConfigStorage 
      +
    -
  • - - +
  • +
    +
    • Class Summary 
    + + - - + + + - - - + +
    Class Summary
    ClassDescriptionClassDescription
    ConfigManager +
    ConfigManager
    Loads config values into variables annotated with ConfigValue
    +
    • -
  • - - +
  • +
    +
    • Enum Summary 
    + + - - + + + - - - + +
    Enum Summary
    EnumDescriptionEnumDescription
    ConversionType +
    ConversionType
    Represents ways in which objects can be mapped from config
    +
    • - +
    + + +
    + + diff --git a/javadoc/redempt/redlib/configmanager/package-tree.html b/javadoc/redempt/redlib/configmanager/package-tree.html index 1d3a7ab..dc8aae4 100644 --- a/javadoc/redempt/redlib/configmanager/package-tree.html +++ b/javadoc/redempt/redlib/configmanager/package-tree.html @@ -5,176 +5,109 @@ redempt.redlib.configmanager Class Hierarchy (RedLib API) + + - + + - - - - - + + - - -
    +
    + +

    Hierarchy For Package redempt.redlib.configmanager

    -Package Hierarchies: +Package Hierarchies:
    -
    -
    +

    Class Hierarchy

    -
    +

    Interface Hierarchy

    -
    +

    Enum Hierarchy

    • java.lang.Object
        -
      • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) +
      • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.lang.constant.Constable, java.io.Serializable)
    -
    +
    +
    diff --git a/javadoc/redempt/redlib/dev/ChainCommand.html b/javadoc/redempt/redlib/dev/ChainCommand.html index c4cc53d..ce20dfc 100644 --- a/javadoc/redempt/redlib/dev/ChainCommand.html +++ b/javadoc/redempt/redlib/dev/ChainCommand.html @@ -5,315 +5,226 @@ ChainCommand (RedLib API) + + - + + - - - - - + + - - -
    +
    +
    + + + +
    - +
    +
    -
    Package redempt.redlib.dev
    -

    Class ChainCommand

    +
    Package redempt.redlib.dev
    +

    Class ChainCommand

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.dev.ChainCommand
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      redempt.redlib.dev.ChainCommand
      +
      +
      -
      public class ChainCommand
+
      public class ChainCommand
 extends java.lang.Object
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Constructor Summary

          - - +
        • +
          +

          Constructor Summary

          +
          +
          • Constructors 
          + + - - + + - - - + + + + + +
          Constructors
          ConstructorDescriptionConstructorDescription
          ChainCommand() 
          ChainCommand() 
          -
          • -
        +
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Instance Methods Concrete Methods 
      + - - - + + + - - - - + + + + + + - - - - + + + + +
      Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
      voidcommandChain​(org.bukkit.command.CommandSender sender, - java.lang.String command) 
      voidcommandChain​(org.bukkit.command.CommandSender sender, +java.lang.String command) 
      ArgType<java.lang.String>getArgType() 
      ArgType<java.lang.String>getArgType() 
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

    Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - -
            -
          • -

            ChainCommand

            -
            public ChainCommand()
            -
            • -
          +
        • +
          +

          Constructor Details

          +
            +
          • +
            +

            ChainCommand

            +
            public ChainCommand()
            +
          - -
          -
            -
          • - - -

            Method Detail

            - - - -
              -
            • -

              commandChain

              -
              public void commandChain​(org.bukkit.command.CommandSender sender,
-                         java.lang.String command)
              • -
            - - - -
              -
            • -

              getArgType

              -
              public ArgType<java.lang.String> getArgType()
              + +
            • +
              +

              Method Details

              +
                +
              • +
                +

                commandChain

                +
                public void commandChain​(org.bukkit.command.CommandSender sender, +java.lang.String command)
                +
                • -
              +
            • +
              +

              getArgType

              +
              public ArgType<java.lang.String> getArgType()
              +
        -
    - - + + + + diff --git a/javadoc/redempt/redlib/dev/StructureTool.html b/javadoc/redempt/redlib/dev/StructureTool.html index 23f157c..d3eb034 100644 --- a/javadoc/redempt/redlib/dev/StructureTool.html +++ b/javadoc/redempt/redlib/dev/StructureTool.html @@ -5,372 +5,268 @@ StructureTool (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.dev
    -

    Class StructureTool

    +
    Package redempt.redlib.dev
    +

    Class StructureTool

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.dev.StructureTool
        • -
      -
      • -
    -
    -
      -
    • -
      +
      java.lang.Object +
      redempt.redlib.dev.StructureTool
      +
      +
      +
      All Implemented Interfaces:
      org.bukkit.event.Listener
      -
      public class StructureTool
+
      public class StructureTool
 extends java.lang.Object
 implements org.bukkit.event.Listener
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Method Summary

          - - +
        • +
          +

          Method Summary

          +
          +
          +
          +
          • All Methods Static Methods Instance Methods Concrete Methods 
          + - - - + + + - - - - + + + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + +
          Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
          voidbuild​(org.bukkit.entity.Player player, - int rotation, - boolean mirror) 
          voidbuild​(org.bukkit.entity.Player player, +int rotation, +boolean mirror) 
          voidcreateStructure​(org.bukkit.entity.Player player, - java.lang.String name) 
          voidcreateStructure​(org.bukkit.entity.Player player, +java.lang.String name) 
          static StructureToolenable() 
          static StructureToolenable() 
          voidexport​(org.bukkit.entity.Player player, - java.lang.String filename) 
          voidexport​(org.bukkit.entity.Player player, +java.lang.String filename) 
          static org.bukkit.inventory.ItemStackgetTool() 
          static org.bukkit.inventory.ItemStackgetTool() 
          voidgiveWand​(org.bukkit.entity.Player player) 
          voidgiveWand​(org.bukkit.entity.Player player) 
          voidonInteract​(org.bukkit.event.player.PlayerInteractEvent e) 
          voidonInteract​(org.bukkit.event.player.PlayerInteractEvent e) 
          voidskip​(org.bukkit.entity.Player player, - org.bukkit.Material type) 
          voidskip​(org.bukkit.entity.Player player, +org.bukkit.Material type) 
          -
            -
          • - - -

            Methods inherited from class java.lang.Object

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

    Methods inherited from class java.lang.Object

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

          Method Detail

          - - - -
            -
          • -

            getTool

            -
            public static org.bukkit.inventory.ItemStack getTool()
            -
            • -
          - - - -
            -
          • -

            enable

            -
            public static StructureTool enable()
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              getTool

              +
              public static org.bukkit.inventory.ItemStack getTool()
              +
              • -
            - - - -
              -
            • -

              onInteract

              -
              public void onInteract​(org.bukkit.event.player.PlayerInteractEvent e)
              +
            • +
              +

              enable

              +
              public static StructureTool enable()
              +
              • -
            - - - -
              -
            • -

              giveWand

              -
              public void giveWand​(org.bukkit.entity.Player player)
              +
            • +
              +

              onInteract

              +
              public void onInteract​(org.bukkit.event.player.PlayerInteractEvent e)
              +
              • -
            - - - -
              -
            • -

              createStructure

              -
              public void createStructure​(org.bukkit.entity.Player player,
-                            java.lang.String name)
              +
            • +
              +

              giveWand

              +
              public void giveWand​(org.bukkit.entity.Player player)
              +
              • -
            - - - -
              -
            • -

              skip

              -
              public void skip​(org.bukkit.entity.Player player,
-                 org.bukkit.Material type)
              +
            • +
              +

              createStructure

              +
              public void createStructure​(org.bukkit.entity.Player player, +java.lang.String name)
              +
              • -
            - - - -
              -
            • -

              export

              -
              public void export​(org.bukkit.entity.Player player,
-                   java.lang.String filename)
              +
            • +
              +

              skip

              +
              public void skip​(org.bukkit.entity.Player player, +org.bukkit.Material type)
              +
              • -
            - - - -
              -
            • -

              build

              -
              public void build​(org.bukkit.entity.Player player,
-                  int rotation,
-                  boolean mirror)
              +
            • +
              +

              export

              +
              public void export​(org.bukkit.entity.Player player, +java.lang.String filename)
              +
              • -
            +
          • +
            +

            build

            +
            public void build​(org.bukkit.entity.Player player, +int rotation, +boolean mirror)
            +
      -
    -
    - + + + + diff --git a/javadoc/redempt/redlib/dev/package-summary.html b/javadoc/redempt/redlib/dev/package-summary.html index db5f696..1c66d9b 100644 --- a/javadoc/redempt/redlib/dev/package-summary.html +++ b/javadoc/redempt/redlib/dev/package-summary.html @@ -5,47 +5,30 @@ redempt.redlib.dev (RedLib API) + + - + + - - - - - + + - - -
    +
    + +

    Package redempt.redlib.dev

    -
    -
    -
    + +
    + diff --git a/javadoc/redempt/redlib/dev/package-tree.html b/javadoc/redempt/redlib/dev/package-tree.html index 98bfefa..4e899a8 100644 --- a/javadoc/redempt/redlib/dev/package-tree.html +++ b/javadoc/redempt/redlib/dev/package-tree.html @@ -5,157 +5,90 @@ redempt.redlib.dev Class Hierarchy (RedLib API) + + - + + - - - - - + + - - -
    +
    + +

    Hierarchy For Package redempt.redlib.dev

    -Package Hierarchies: +Package Hierarchies:
    -
    -
    +

    Class Hierarchy

    -
    +
    +
    diff --git a/javadoc/redempt/redlib/dev/profiler/BurstProfiler.html b/javadoc/redempt/redlib/dev/profiler/BurstProfiler.html index e2eb451..3eeb709 100644 --- a/javadoc/redempt/redlib/dev/profiler/BurstProfiler.html +++ b/javadoc/redempt/redlib/dev/profiler/BurstProfiler.html @@ -5,412 +5,307 @@ BurstProfiler (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.dev.profiler
    -

    Class BurstProfiler

    +
    Package redempt.redlib.dev.profiler
    +

    Class BurstProfiler

    -
    - -
    -
      -
    • +
      java.lang.Object +
      redempt.redlib.dev.profiler.Profiler +
      redempt.redlib.dev.profiler.BurstProfiler
      +
      +
      +
      -
      public class BurstProfiler
+
      public class BurstProfiler
 extends Profiler
      
 
      A profiler best used in bursts. Uses a lot of memory to profile even short periods of time,
  but allows you to select certain timeframes to inspect
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Constructor Summary

          - - +
        • +
          +

          Constructor Summary

          +
          +
          • Constructors 
          + + - - + + - - - + + + + - - - + + +
          Constructors
          ConstructorDescriptionConstructorDescription
          BurstProfiler() +
          BurstProfiler()
          Create a new BurstProfiler with a default size of 10,000 (10 seconds)
          BurstProfiler​(int size) +
          BurstProfiler​(int size)
          Create a new BurstProfiler with an initial size, being the number of milliseconds it will be able to record
          -
          • -
        +
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Instance Methods Concrete Methods 
      + - - - + + + - - - - + + + + + + - - - - + + + - - - - + + + - - - - + + + +
      Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
      protected voidend() 
      protected voidend() 
      SampleSummarygetSummary() +
      SampleSummarygetSummary()
      Gets a summary of the last X milliseconds of profiling, with X being the size this BurstProfiler was initialized with
      SampleSummarygetSummary​(long after) +
      SampleSummarygetSummary​(long after)
      Gets a summary of the profiling after the specified time.
      voidstart() +
      voidstart()
      Start this profiler.
      - -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

    Methods inherited from class redempt.redlib.dev.profiler.Profiler

    +stop, stopAll
    +
    +

    Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - -
            -
          • -

            BurstProfiler

            -
            public BurstProfiler​(int size)
            +
          • +
            +

            Constructor Details

            +
              +
            • +
              +

              BurstProfiler

              +
              public BurstProfiler​(int size)
              Create a new BurstProfiler with an initial size, being the number of milliseconds it will be able to record
              -
              -
              Parameters:
              +
              +
              Parameters:
              size - The size of the sample queue to create, 1ms = 1 element
              +
              • -
            - - - -
              -
            • -

              BurstProfiler

              -
              public BurstProfiler()
              +
            • +
              +

              BurstProfiler

              +
              public BurstProfiler()
              Create a new BurstProfiler with a default size of 10,000 (10 seconds)
              -
              • -
            +
        + -
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            start

            -
            public void start()
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              start

              +
              public void start()
              Start this profiler. Must be run from the thread you intend to profile.
              -
              -
              Specified by:
              +
              +
              Specified by:
              start in class Profiler
              +
              • -
            - - - -
              -
            • -

              end

              -
              protected void end()
              -
              -
              Specified by:
              +
            • +
              +

              end

              +
              protected void end()
              +
              +
              Specified by:
              end in class Profiler
              +
              • -
            - - - -
              -
            • -

              getSummary

              -
              public SampleSummary getSummary()
              +
            • +
              +

              getSummary

              +
              public SampleSummary getSummary()
              Gets a summary of the last X milliseconds of profiling, with X being the size this BurstProfiler was initialized with
              -
              -
              Specified by:
              +
              +
              Specified by:
              getSummary in class Profiler
              -
              Returns:
              +
              Returns:
              The summary
              +
              • -
            - - - -
              -
            • -

              getSummary

              -
              public SampleSummary getSummary​(long after)
              +
            • +
              +

              getSummary

              +
              public SampleSummary getSummary​(long after)
              Gets a summary of the profiling after the specified time. Cannot go back further than X milliseconds, with X being the size this BrustProfiler was initialized with
              -
              -
              Parameters:
              +
              +
              Parameters:
              after - The timestamp after which summary data should be included
              -
              Returns:
              +
              Returns:
              The summary
              -
              • -
            +
      -
    - - + + + + diff --git a/javadoc/redempt/redlib/dev/profiler/PassiveProfiler.html b/javadoc/redempt/redlib/dev/profiler/PassiveProfiler.html index 2c8869a..90d4bf2 100644 --- a/javadoc/redempt/redlib/dev/profiler/PassiveProfiler.html +++ b/javadoc/redempt/redlib/dev/profiler/PassiveProfiler.html @@ -5,382 +5,280 @@ PassiveProfiler (RedLib API) + + - + + - - - - - + + - - -
    +
    +
    + + + +
    - +
    +
    -
    Package redempt.redlib.dev.profiler
    -

    Class PassiveProfiler

    +
    Package redempt.redlib.dev.profiler
    +

    Class PassiveProfiler

    -
    - -
    -
      -
    • +
      java.lang.Object +
      redempt.redlib.dev.profiler.Profiler +
      redempt.redlib.dev.profiler.PassiveProfiler
      +
      +
      +
      -
      public class PassiveProfiler
+
      public class PassiveProfiler
 extends Profiler
      
 
      A profiler best used over long periods of time. Uses very little memory even when running
  for very long periods, but cannot retrieve data from specific timeframes - only allows
  summaries of the entire time that was profiled.
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Constructor Summary

          - - +
        • +
          +

          Constructor Summary

          +
          +
          • Constructors 
          + + - - + + - - - + + + + +
          Constructors
          ConstructorDescriptionConstructorDescription
          PassiveProfiler() +
          PassiveProfiler()
          Create a new PassiveProfiler with an empty summary
          -
          • -
        +
    + -
    - +
    +
    +
    +

    Methods inherited from class redempt.redlib.dev.profiler.Profiler

    +stop, stopAll
    +
    +

    Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - -
            -
          • -

            PassiveProfiler

            -
            public PassiveProfiler()
            +
          • +
            +

            Constructor Details

            +
              +
            • +
              +

              PassiveProfiler

              +
              public PassiveProfiler()
              Create a new PassiveProfiler with an empty summary
              -
              • -
            +
        + -
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            start

            -
            public void start()
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              start

              +
              public void start()
              Start this profiler. Must be run from the thread you intend to profile.
              -
              -
              Specified by:
              +
              +
              Specified by:
              start in class Profiler
              +
              • -
            - - - -
              -
            • -

              end

              -
              protected void end()
              -
              -
              Specified by:
              +
            • +
              +

              end

              +
              protected void end()
              +
              +
              Specified by:
              end in class Profiler
              +
              • -
            - - - -
              -
            • -

              getSummary

              -
              public SampleSummary getSummary()
              -
              -
              Specified by:
              +
            • +
              +

              getSummary

              +
              public SampleSummary getSummary()
              +
              +
              Specified by:
              getSummary in class Profiler
              -
              Returns:
              +
              Returns:
              A summary of all of the data collected by this profiler, up to the time this method was called. The returned summary will not be updated with new data after it is returned.
              +
              • -
            - - - -
              -
            • -

              getRunningSummary

              -
              public SampleSummary getRunningSummary()
              -
              -
              Returns:
              +
            • +
              +

              getRunningSummary

              +
              public SampleSummary getRunningSummary()
              +
              +
              Returns:
              A summary of all the data collected by this profiler. The returned summary will be updated with new data after it is returned if the profiler is still running.
              -
              • -
            +
      -
    - - + + + + diff --git a/javadoc/redempt/redlib/dev/profiler/Profiler.html b/javadoc/redempt/redlib/dev/profiler/Profiler.html index 80dac4e..bd59e1c 100644 --- a/javadoc/redempt/redlib/dev/profiler/Profiler.html +++ b/javadoc/redempt/redlib/dev/profiler/Profiler.html @@ -5,374 +5,276 @@ Profiler (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.dev.profiler
    -

    Class Profiler

    +
    Package redempt.redlib.dev.profiler
    +

    Class Profiler

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.dev.profiler.Profiler
        • -
      -
      • -
    -
    -
      -
    • -
      +
      java.lang.Object +
      redempt.redlib.dev.profiler.Profiler
      +
      +
      +
      Direct Known Subclasses:
      BurstProfiler, PassiveProfiler
      -
      public abstract class Profiler
+
      public abstract class Profiler
 extends java.lang.Object
      
 
      A base class of a Profiler which can be used to analyze the performance of the server. Runs asynchronously
  in its own thread.
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Constructor Summary

          - - +
        • +
          +

          Constructor Summary

          +
          +
          • Constructors 
          + + - - + + - - - + + + + + +
          Constructors
          ConstructorDescriptionConstructorDescription
          Profiler() 
          Profiler() 
          -
          • -
        +
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      + - - - + + + - - - - + + + + + + - - - - + + + + - - - - + + + - - - - + + + - - - - + + + +
      Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
      protected abstract voidend() 
      protected abstract voidend() 
      abstract SampleSummarygetSummary() 
      abstract SampleSummarygetSummary() 
      abstract voidstart() +
      abstract voidstart()
      Start this profiler.
      voidstop() +
      voidstop()
      Stop this profiler
      static voidstopAll() +
      static voidstopAll()
      Stop all running profilers
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

    Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - -
            -
          • -

            Profiler

            -
            public Profiler()
            -
            • -
          +
        • +
          +

          Constructor Details

          +
            +
          • +
            +

            Profiler

            +
            public Profiler()
            +
          +
          • -
          -
            -
          • - - -

            Method Detail

            - - - -
              -
            • -

              stopAll

              -
              public static void stopAll()
              +
            • +
              +

              Method Details

              +
                +
              • +
                +

                stopAll

                +
                public static void stopAll()
                Stop all running profilers
                +
                • -
              - - - -
                -
              • -

                start

                -
                public abstract void start()
                +
              • +
                +

                start

                +
                public abstract void start()
                Start this profiler. Must be run from the thread you intend to profile.
                +
                • -
              - - - -
                -
              • -

                end

                -
                protected abstract void end()
                +
              • +
                +

                end

                +
                protected abstract void end()
                +
                • -
              - - - -
                -
              • -

                getSummary

                -
                public abstract SampleSummary getSummary()
                -
                -
                Returns:
                +
              • +
                +

                getSummary

                +
                public abstract SampleSummary getSummary()
                +
                +
                Returns:
                A SampleSummary representing all of the data collected by this profiler
                +
                • -
              - - - -
                -
              • -

                stop

                -
                public final void stop()
                +
              • +
                +

                stop

                +
                public final void stop()
                Stop this profiler
                -
                • -
              +
        -
    - - + + + + diff --git a/javadoc/redempt/redlib/dev/profiler/ProfilerCommands.html b/javadoc/redempt/redlib/dev/profiler/ProfilerCommands.html index 259cf91..d46c806 100644 --- a/javadoc/redempt/redlib/dev/profiler/ProfilerCommands.html +++ b/javadoc/redempt/redlib/dev/profiler/ProfilerCommands.html @@ -5,557 +5,420 @@ ProfilerCommands (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.dev.profiler
    -

    Class ProfilerCommands

    +
    Package redempt.redlib.dev.profiler
    +

    Class ProfilerCommands

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.dev.profiler.ProfilerCommands
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      redempt.redlib.dev.profiler.ProfilerCommands
      +
      +
      -
      public class ProfilerCommands
+
      public class ProfilerCommands
 extends java.lang.Object
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Constructor Summary

          - - +
        • +
          +

          Constructor Summary

          +
          +
          • Constructors 
          + + - - + + - - - + + + + + +
          Constructors
          ConstructorDescriptionConstructorDescription
          ProfilerCommands() 
          ProfilerCommands() 
          -
          • -
        +
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Static Methods Instance Methods Concrete Methods 
      + - - - + + + - - - - + + + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + +
      Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
      voidclear​(org.bukkit.command.CommandSender sender) 
      voidclear​(org.bukkit.command.CommandSender sender) 
      voidcollapse​(org.bukkit.entity.Player player) 
      voidcollapse​(org.bukkit.entity.Player player) 
      static ProfilergetProfiler() 
      static ProfilergetProfiler() 
      voidroot​(org.bukkit.entity.Player player) 
      voidroot​(org.bukkit.entity.Player player) 
      voidsearch​(org.bukkit.entity.Player player, - int depth, - double overPercent, - int overMillis, - java.lang.String term) 
      voidsearch​(org.bukkit.entity.Player player, +int depth, +double overPercent, +int overMillis, +java.lang.String term) 
      voidselect​(org.bukkit.entity.Player player, - java.lang.String selector) 
      voidselect​(org.bukkit.entity.Player player, +java.lang.String selector) 
      voidselectReport​(org.bukkit.entity.Player player, - int report) 
      voidselectReport​(org.bukkit.entity.Player player, +int report) 
      voidsetLimit​(org.bukkit.entity.Player player, - int limit) 
      voidsetLimit​(org.bukkit.entity.Player player, +int limit) 
      voidsetMinimum​(org.bukkit.command.CommandSender sender, - int ticks) 
      voidsetMinimum​(org.bukkit.command.CommandSender sender, +int ticks) 
      voidshowReports​(org.bukkit.entity.Player player) 
      voidshowReports​(org.bukkit.entity.Player player) 
      voidstart​(org.bukkit.command.CommandSender sender) 
      voidstart​(org.bukkit.command.CommandSender sender) 
      voidstartMonitor​(org.bukkit.command.CommandSender sender) 
      voidstartMonitor​(org.bukkit.command.CommandSender sender) 
      voidstop​(org.bukkit.command.CommandSender sender) 
      voidstop​(org.bukkit.command.CommandSender sender) 
      voidsummary​(org.bukkit.entity.Player sender) 
      voidsummary​(org.bukkit.entity.Player sender) 
      voidtimeFormat​(org.bukkit.entity.Player sender) 
      voidtimeFormat​(org.bukkit.entity.Player sender) 
      voidtoggleExpand​(org.bukkit.entity.Player player, - java.lang.String selector) 
      voidtoggleExpand​(org.bukkit.entity.Player player, +java.lang.String selector) 
      voidup​(org.bukkit.entity.Player sender, - int count) 
      voidup​(org.bukkit.entity.Player sender, +int count) 
      voidverbose​(org.bukkit.entity.Player sender) 
      voidverbose​(org.bukkit.entity.Player sender) 
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

    Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - -
            -
          • -

            ProfilerCommands

            -
            public ProfilerCommands()
            -
            • -
          +
        • +
          +

          Constructor Details

          +
            +
          • +
            +

            ProfilerCommands

            +
            public ProfilerCommands()
            +
          - -
          -
            -
          • - - -

            Method Detail

            - - - -
              -
            • -

              getProfiler

              -
              public static Profiler getProfiler()
              • -
            - - - -
              -
            • -

              start

              -
              public void start​(org.bukkit.command.CommandSender sender)
              + +
            • +
              +

              Method Details

              +
                +
              • +
                +

                getProfiler

                +
                public static Profiler getProfiler()
                +
                • -
              - - - -
                -
              • -

                stop

                -
                public void stop​(org.bukkit.command.CommandSender sender)
                +
              • +
                +

                start

                +
                public void start​(org.bukkit.command.CommandSender sender)
                +
                • -
              - - - -
                -
              • -

                summary

                -
                public void summary​(org.bukkit.entity.Player sender)
                +
              • +
                +

                stop

                +
                public void stop​(org.bukkit.command.CommandSender sender)
                +
                • -
              - - - -
                -
              • -

                verbose

                -
                public void verbose​(org.bukkit.entity.Player sender)
                +
              • +
                +

                summary

                +
                public void summary​(org.bukkit.entity.Player sender)
                +
                • -
              - - - -
                -
              • -

                timeFormat

                -
                public void timeFormat​(org.bukkit.entity.Player sender)
                +
              • +
                +

                verbose

                +
                public void verbose​(org.bukkit.entity.Player sender)
                +
                • -
              - - - -
                -
              • -

                root

                -
                public void root​(org.bukkit.entity.Player player)
                +
              • +
                +

                timeFormat

                +
                public void timeFormat​(org.bukkit.entity.Player sender)
                +
                • -
              - - - -
                -
              • -

                select

                -
                public void select​(org.bukkit.entity.Player player,
-                   java.lang.String selector)
                +
              • +
                +

                root

                +
                public void root​(org.bukkit.entity.Player player)
                +
                • -
              - - - -
                -
              • -

                up

                -
                public void up​(org.bukkit.entity.Player sender,
-               int count)
                +
              • +
                +

                select

                +
                public void select​(org.bukkit.entity.Player player, +java.lang.String selector)
                +
                • -
              - - - -
                -
              • -

                collapse

                -
                public void collapse​(org.bukkit.entity.Player player)
                +
              • +
                +

                up

                +
                public void up​(org.bukkit.entity.Player sender, +int count)
                +
                • -
              - - - -
                -
              • -

                toggleExpand

                -
                public void toggleExpand​(org.bukkit.entity.Player player,
-                         java.lang.String selector)
                +
              • +
                +

                collapse

                +
                public void collapse​(org.bukkit.entity.Player player)
                +
                • -
              - - - -
                -
              • -

                search

                -
                public void search​(org.bukkit.entity.Player player,
-                   int depth,
-                   double overPercent,
-                   int overMillis,
-                   java.lang.String term)
                +
              • +
                +

                toggleExpand

                +
                public void toggleExpand​(org.bukkit.entity.Player player, +java.lang.String selector)
                +
                • -
              - - - -
                -
              • -

                setMinimum

                -
                public void setMinimum​(org.bukkit.command.CommandSender sender,
-                       int ticks)
                +
              • +
                +

                search

                +
                public void search​(org.bukkit.entity.Player player, +int depth, +double overPercent, +int overMillis, +java.lang.String term)
                +
                • -
              - - - -
                -
              • -

                clear

                -
                public void clear​(org.bukkit.command.CommandSender sender)
                +
              • +
                +

                setMinimum

                +
                public void setMinimum​(org.bukkit.command.CommandSender sender, +int ticks)
                +
                • -
              - - - -
                -
              • -

                startMonitor

                -
                public void startMonitor​(org.bukkit.command.CommandSender sender)
                +
              • +
                +

                clear

                +
                public void clear​(org.bukkit.command.CommandSender sender)
                +
                • -
              - - - -
                -
              • -

                showReports

                -
                public void showReports​(org.bukkit.entity.Player player)
                +
              • +
                +

                startMonitor

                +
                public void startMonitor​(org.bukkit.command.CommandSender sender)
                +
                • -
              - - - -
                -
              • -

                selectReport

                -
                public void selectReport​(org.bukkit.entity.Player player,
-                         int report)
                +
              • +
                +

                showReports

                +
                public void showReports​(org.bukkit.entity.Player player)
                +
                • -
              - - - -
                -
              • -

                setLimit

                -
                public void setLimit​(org.bukkit.entity.Player player,
-                     int limit)
                +
              • +
                +

                selectReport

                +
                public void selectReport​(org.bukkit.entity.Player player, +int report)
                +
                • -
              +
            • +
              +

              setLimit

              +
              public void setLimit​(org.bukkit.entity.Player player, +int limit)
              +
        -
    - - + + + + diff --git a/javadoc/redempt/redlib/dev/profiler/SampleSummary.SampleMethod.html b/javadoc/redempt/redlib/dev/profiler/SampleSummary.SampleMethod.html index 0327307..be5517f 100644 --- a/javadoc/redempt/redlib/dev/profiler/SampleSummary.SampleMethod.html +++ b/javadoc/redempt/redlib/dev/profiler/SampleSummary.SampleMethod.html @@ -5,521 +5,402 @@ SampleSummary.SampleMethod (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.dev.profiler
    -

    Class SampleSummary.SampleMethod

    +
    Package redempt.redlib.dev.profiler
    +

    Class SampleSummary.SampleMethod

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.dev.profiler.SampleSummary.SampleMethod
        • -
      -
      • -
    -
    -
      -
    • -
      +
      java.lang.Object +
      redempt.redlib.dev.profiler.SampleSummary.SampleMethod
      +
      +
      +
      Enclosing class:
      SampleSummary
      -
      public static class SampleSummary.SampleMethod
+
      public static class SampleSummary.SampleMethod
 extends java.lang.Object
      
 
      Represents a method and its specific place in the summary tree. Each SampleMethod can be treated
  as a node of a tree.
      
-
      • -
    -
    -
    -
    + -
    -
      -
    • - - -

      Constructor Summary

      - - +
    • +
      +

      Constructor Summary

      +
      +
      • Constructors 
      + + - - - + + + - - - - + + + + + + +
      Constructors
      ModifierConstructorDescriptionModifierConstructorDescription
      protected SampleMethod​(SampleSummary summary, - java.lang.String name) 
      protected SampleMethod​(SampleSummary summary, +java.lang.String name) 
      -
      • -
    +
    + -
    - +
    +
    +
    +

    Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - -
            -
          • -

            SampleMethod

            -
            protected SampleMethod​(SampleSummary summary,
-                       java.lang.String name)
            • -
          + +
        • +
          +

          Constructor Details

          +
            +
          • +
            +

            SampleMethod

            +
            protected SampleMethod​(SampleSummary summary, +java.lang.String name)
            +
          +
          • -
          -
            -
          • - - -

            Method Detail

            - - - -
              -
            • -

              getPrevalence

              -
              public double getPrevalence()
              -
              -
              Returns:
              +
            • +
              +

              Method Details

              +
                +
              • +
                +

                getPrevalence

                +
                public double getPrevalence()
                +
                +
                Returns:
                The percentage of samples this method was reported in - effectively, how much of the sample duration was spent running this method
                +
                • -
              - - - - - - - - - - - -
                -
              • -

                getName

                -
                public java.lang.String getName()
                -
                -
                Returns:
                +
              • +
                +

                getName

                +
                public java.lang.String getName()
                +
                +
                Returns:
                The full name of this method
                +
                • -
              - - - -
                -
              • -

                getDepth

                -
                public int getDepth()
                -
                -
                Returns:
                +
              • +
                +

                getDepth

                +
                public int getDepth()
                +
                +
                Returns:
                The depth of this SampleMethod in the tree - its distance from the root
                +
                • -
              - - - -
                -
              • -

                getShortName

                -
                public java.lang.String getShortName()
                -
                -
                Returns:
                +
              • +
                +

                getShortName

                +
                public java.lang.String getShortName()
                +
                +
                Returns:
                The shortened method name, with package name and unneeded lambda data removed
                +
                • -
              - - - - - - - -
                -
              • -

                increment

                -
                protected void increment()
                +
              • +
                +

                increment

                +
                protected void increment()
                +
                • -
              - - - -
                -
              • -

                getCount

                -
                public long getCount()
                -
                -
                Returns:
                +
              • +
                +

                getCount

                +
                public long getCount()
                +
                +
                Returns:
                The number of times this method appeared in samples - effectively, the number of milliseconds this method was being run for in total.
                +
                • -
              - - - - +
            • +
              +

              clone

              +
              protected SampleSummary.SampleMethod clone​(SampleSummary summary)
              +
        -
    - - + + + + diff --git a/javadoc/redempt/redlib/dev/profiler/SampleSummary.html b/javadoc/redempt/redlib/dev/profiler/SampleSummary.html index 9ba63e4..ee7ada5 100644 --- a/javadoc/redempt/redlib/dev/profiler/SampleSummary.html +++ b/javadoc/redempt/redlib/dev/profiler/SampleSummary.html @@ -5,453 +5,348 @@ SampleSummary (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.dev.profiler
    -

    Class SampleSummary

    +
    Package redempt.redlib.dev.profiler
    +

    Class SampleSummary

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.dev.profiler.SampleSummary
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      redempt.redlib.dev.profiler.SampleSummary
      +
      +
      -
      public class SampleSummary
+
      public class SampleSummary
 extends java.lang.Object
      
 
      Represents a summary of profiler data
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Nested Class Summary

          - - +
        • +
          +

          Nested Class Summary

          +
          +
          • Nested Classes 
          + + - - - + + + - - - - + + + + + +
          Nested Classes
          Modifier and TypeClassDescriptionModifier and TypeClassDescription
          static class SampleSummary.SampleMethod +
          static class SampleSummary.SampleMethod
          Represents a method and its specific place in the summary tree.
          -
          • -
        +
    + -
    -
      -
    • - - -

      Constructor Summary

      - - +
    • +
      +

      Constructor Summary

      +
      +
      • Constructors 
      + + - - - + + + - - - - + + + + + + - - - - + + + + +
      Constructors
      ModifierConstructorDescriptionModifierConstructorDescription
      protected SampleSummary() 
      protected SampleSummary() 
      protected SampleSummary​(java.util.Collection<redempt.redlib.dev.profiler.Sample> samples) 
      protected SampleSummary​(java.util.Collection<redempt.redlib.dev.profiler.Sample> samples) 
      -
      • -
    +
    + -
    - +
    +
    +
    +

    Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - -
            -
          • -

            SampleSummary

            -
            protected SampleSummary​(java.util.Collection<redempt.redlib.dev.profiler.Sample> samples)
            -
            • -
          - - - -
            -
          • -

            SampleSummary

            -
            protected SampleSummary()
            +
          • +
            +

            Constructor Details

            +
              +
            • +
              +

              SampleSummary

              +
              protected SampleSummary​(java.util.Collection<redempt.redlib.dev.profiler.Sample> samples)
              +
              • -
            +
          • +
            +

            SampleSummary

            +
            protected SampleSummary()
            +
        + -
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            add

            -
            protected void add​(java.lang.StackTraceElement[] stack)
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              add

              +
              protected void add​(java.lang.StackTraceElement[] stack)
              +
              • -
            - - - -
              -
            • -

              clone

              -
              public SampleSummary clone()
              -
              -
              Overrides:
              +
            • +
              +

              clone

              +
              public SampleSummary clone()
              +
              +
              Overrides:
              clone in class java.lang.Object
              -
              Returns:
              +
              Returns:
              A clone of this SampleSummary
              +
              • -
            - - - -
              -
            • -

              getStart

              -
              public long getStart()
              -
              -
              Returns:
              +
            • +
              +

              getStart

              +
              public long getStart()
              +
              +
              Returns:
              The time this SampleSummary's data starts at
              +
              • -
            - - - -
              -
            • -

              getEnd

              -
              public long getEnd()
              -
              -
              Returns:
              +
            • +
              +

              getEnd

              +
              public long getEnd()
              +
              +
              Returns:
              The time this SampleSummary's data ends at
              +
              • -
            - - - -
              -
            • -

              getDuration

              -
              public long getDuration()
              -
              -
              Returns:
              +
            • +
              +

              getDuration

              +
              public long getDuration()
              +
              +
              Returns:
              The difference between the end and start of this SampleSummary's data
              +
              • -
            - - - - - - - -
              -
            • -

              getMethodsByName

              -
              public java.util.Map<java.lang.String,​java.util.List<SampleSummary.SampleMethod>> getMethodsByName()
              -
              -
              Returns:
              +
            • +
              +

              getMethodsByName

              +
              public java.util.Map<java.lang.String,​java.util.List<SampleSummary.SampleMethod>> getMethodsByName()
              +
              +
              Returns:
              A map of method names to the SampleSummary.SampleMethods associated with them. One name can have multiple mappings because each SampleMethod represents a method and its relative position in the stack trace.
              -
              • -
            +
      -
    - - + + + + diff --git a/javadoc/redempt/redlib/dev/profiler/TickMonitorProfiler.html b/javadoc/redempt/redlib/dev/profiler/TickMonitorProfiler.html index c10ce3d..36e775f 100644 --- a/javadoc/redempt/redlib/dev/profiler/TickMonitorProfiler.html +++ b/javadoc/redempt/redlib/dev/profiler/TickMonitorProfiler.html @@ -5,355 +5,257 @@ TickMonitorProfiler (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.dev.profiler
    -

    Class TickMonitorProfiler

    +
    Package redempt.redlib.dev.profiler
    +

    Class TickMonitorProfiler

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.dev.profiler.TickMonitorProfiler
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      redempt.redlib.dev.profiler.TickMonitorProfiler
      +
      +
      -
      public class TickMonitorProfiler
+
      public class TickMonitorProfiler
 extends java.lang.Object
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Constructor Summary

          - - +
        • +
          +

          Constructor Summary

          +
          +
          • Constructors 
          + + - - + + - - - + + + + + +
          Constructors
          ConstructorDescriptionConstructorDescription
          TickMonitorProfiler() 
          TickMonitorProfiler() 
          -
          • -
        +
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Static Methods Concrete Methods 
      + - - - + + + - - - - + + + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + +
      Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
      static voidclear() 
      static voidclear() 
      static java.util.List<SampleSummary>getReports() 
      static java.util.List<SampleSummary>getReports() 
      static voidsetTickMinimum​(long tickMinimum) 
      static voidsetTickMinimum​(long tickMinimum) 
      static voidstart() 
      static voidstart() 
      static voidstop() 
      static voidstop() 
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

    Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - -
            -
          • -

            TickMonitorProfiler

            -
            public TickMonitorProfiler()
            -
            • -
          +
        • +
          +

          Constructor Details

          +
            +
          • +
            +

            TickMonitorProfiler

            +
            public TickMonitorProfiler()
            +
          - -
          -
            -
          • - - -

            Method Detail

            - - - -
              -
            • -

              setTickMinimum

              -
              public static void setTickMinimum​(long tickMinimum)
              • -
            - - - -
              -
            • -

              start

              -
              public static void start()
              + +
            • +
              +

              Method Details

              +
                +
              • +
                +

                setTickMinimum

                +
                public static void setTickMinimum​(long tickMinimum)
                +
                • -
              - - - -
                -
              • -

                stop

                -
                public static void stop()
                +
              • +
                +

                start

                +
                public static void start()
                +
                • -
              - - - -
                -
              • -

                clear

                -
                public static void clear()
                +
              • +
                +

                stop

                +
                public static void stop()
                +
                • -
              - - - -
                -
              • -

                getReports

                -
                public static java.util.List<SampleSummary> getReports()
                +
              • +
                +

                clear

                +
                public static void clear()
                +
                • -
              +
            • +
              +

              getReports

              +
              public static java.util.List<SampleSummary> getReports()
              +
        -
    - - + + + + diff --git a/javadoc/redempt/redlib/dev/profiler/package-summary.html b/javadoc/redempt/redlib/dev/profiler/package-summary.html index 699b194..128216c 100644 --- a/javadoc/redempt/redlib/dev/profiler/package-summary.html +++ b/javadoc/redempt/redlib/dev/profiler/package-summary.html @@ -5,47 +5,30 @@ redempt.redlib.dev.profiler (RedLib API) + + - + + - - - - - + + - - -
    +
    + +

    Package redempt.redlib.dev.profiler

    -
    -
    -
    +
    + + +
    +
    + diff --git a/javadoc/redempt/redlib/dev/profiler/package-tree.html b/javadoc/redempt/redlib/dev/profiler/package-tree.html index 85de3dc..9412212 100644 --- a/javadoc/redempt/redlib/dev/profiler/package-tree.html +++ b/javadoc/redempt/redlib/dev/profiler/package-tree.html @@ -5,165 +5,98 @@ redempt.redlib.dev.profiler Class Hierarchy (RedLib API) + + - + + - - - - - + + - - -
    +
    + +

    Hierarchy For Package redempt.redlib.dev.profiler

    -Package Hierarchies: +Package Hierarchies:
    -
    -
    +

    Class Hierarchy

    -
    +
    +
    diff --git a/javadoc/redempt/redlib/enchants/CustomEnchant.html b/javadoc/redempt/redlib/enchants/CustomEnchant.html index bfdebbc..a9db36c 100644 --- a/javadoc/redempt/redlib/enchants/CustomEnchant.html +++ b/javadoc/redempt/redlib/enchants/CustomEnchant.html @@ -5,742 +5,596 @@ CustomEnchant (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.enchants
    -

    Class CustomEnchant

    +
    Package redempt.redlib.enchants
    +

    Class CustomEnchant

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.enchants.CustomEnchant
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      redempt.redlib.enchants.CustomEnchant
      +
      +
      -
      public abstract class CustomEnchant
+
      public abstract class CustomEnchant
 extends java.lang.Object
      
 
      Represents a custom enchantment created by another plugin
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Constructor Summary

          - - +
        • +
          +

          Constructor Summary

          +
          +
          • Constructors 
          + + - - + + - - - + + + + +
          Constructors
          ConstructorDescriptionConstructorDescription
          CustomEnchant​(java.lang.String name, - int maxLevel) +
          CustomEnchant​(java.lang.String name, +int maxLevel)
          Constructs a new CustomEnchant
          -
          • -
        +
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Static Methods Instance Methods Concrete Methods 
      + - - - + + + - - - - + + + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + - - - - + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + - - - - + + + + - - - - + + + + - - - - + + + - - - - + + + +
      Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
      protected <T extends org.bukkit.event.Event>
      void      		addTrigger​(EnchantTrigger<T> trigger, - java.util.function.BiConsumer<T,​java.lang.Integer> activate) +
      protected <T extends org.bukkit.event.Event>
      void      		addTrigger​(EnchantTrigger<T> trigger, +java.util.function.BiConsumer<T,​java.lang.Integer> activate)
      Registers an EnchantTrigger with a listener
      protected <T extends org.bukkit.event.Event>
      void      		addTrigger​(EnchantTrigger<T> trigger, - java.util.function.BiConsumer<T,​java.lang.Integer> activate, - java.util.function.BiConsumer<T,​java.lang.Integer> deactivate) +
      protected <T extends org.bukkit.event.Event>
      void      		addTrigger​(EnchantTrigger<T> trigger, +java.util.function.BiConsumer<T,​java.lang.Integer> activate, +java.util.function.BiConsumer<T,​java.lang.Integer> deactivate)
      Registers an EnchantTrigger with a listener
      protected booleanappliesTo​(org.bukkit.Material type) +
      protected booleanappliesTo​(org.bukkit.Material type)
      Checks whether this CustomEnchant applies to a certain item type
      org.bukkit.inventory.ItemStackapply​(org.bukkit.inventory.ItemStack item, - int level) +
      org.bukkit.inventory.ItemStackapply​(org.bukkit.inventory.ItemStack item, +int level)
      Applies this CustomEnchant to an item, replacing it if it was already present.
      booleancanApply​(org.bukkit.inventory.ItemStack item) +
      booleancanApply​(org.bukkit.inventory.ItemStack item)
      Checks if this CustomEnchant can be applied to the given item
      booleancanApply​(org.bukkit.Material type) +
      booleancanApply​(org.bukkit.Material type)
      Checks whether this CustomEnchant applies to the given type
      static intfromRomanNumerals​(java.lang.String romanNumerals) +
      static intfromRomanNumerals​(java.lang.String romanNumerals)
      Converts roman numeral string, between 1 and 10, back to a number
      java.lang.StringgetDisplayName() 
      java.lang.StringgetDisplayName() 
      java.lang.StringgetId() 
      java.lang.StringgetId() 
      CustomEnchant[]getIncompatible() 
      CustomEnchant[]getIncompatible() 
      intgetLevel​(org.bukkit.inventory.ItemStack item) +
      intgetLevel​(org.bukkit.inventory.ItemStack item)
      Gets the level of this CustomEnchant on an item
      java.lang.StringgetLore​(int level) +
      java.lang.StringgetLore​(int level)
      Gets the lore that will be added to an item if this CustomEnchant is applied at the given level
      intgetMaxLevel() 
      intgetMaxLevel() 
      java.lang.StringgetName() 
      java.lang.StringgetName() 
      EnchantRegistrygetRegistry() 
      EnchantRegistrygetRegistry() 
      java.util.Map<EnchantTrigger<?>,​redempt.redlib.enchants.EnchantListener<?>>getTriggers() 
      java.util.Map<EnchantTrigger<?>,​redempt.redlib.enchants.EnchantListener<?>>getTriggers() 
      booleanisCompatible​(CustomEnchant ench) +
      booleanisCompatible​(CustomEnchant ench)
      Checks if this CustomEnchant is compatible with another CustomEnchant
      booleanisRegistered() 
      booleanisRegistered() 
      protected voidregister​(EnchantRegistry registry) 
      protected voidregister​(EnchantRegistry registry) 
      org.bukkit.inventory.ItemStackremove​(org.bukkit.inventory.ItemStack item) +
      org.bukkit.inventory.ItemStackremove​(org.bukkit.inventory.ItemStack item)
      Removes this CustomEnchant from the given item
      static java.lang.StringtoRomanNumerals​(int num) +
      static java.lang.StringtoRomanNumerals​(int num)
      Converts a number to roman numerals, between 1 and 10
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

    Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - -
            -
          • -

            CustomEnchant

            -
            public CustomEnchant​(java.lang.String name,
-                     int maxLevel)
            +
          • +
            +

            Constructor Details

            +
              +
            • +
              +

              CustomEnchant

              +
              public CustomEnchant​(java.lang.String name, +int maxLevel)
              Constructs a new CustomEnchant
              -
              -
              Parameters:
              +
              +
              Parameters:
              name - The name of this CustomEnchant
              maxLevel - The max level of this CustomEnchant
              -
              • -
            +
        + -
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            toRomanNumerals

            -
            public static java.lang.String toRomanNumerals​(int num)
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              toRomanNumerals

              +
              public static java.lang.String toRomanNumerals​(int num)
              Converts a number to roman numerals, between 1 and 10
              -
              -
              Parameters:
              +
              +
              Parameters:
              num - The number to convert
              -
              Returns:
              +
              Returns:
              The roman numerals representation of the number
              +
              • -
            - - - -
              -
            • -

              fromRomanNumerals

              -
              public static int fromRomanNumerals​(java.lang.String romanNumerals)
              +
            • +
              +

              fromRomanNumerals

              +
              public static int fromRomanNumerals​(java.lang.String romanNumerals)
              Converts roman numeral string, between 1 and 10, back to a number
              -
              -
              Parameters:
              +
              +
              Parameters:
              romanNumerals - The roman numerals string
              -
              Returns:
              +
              Returns:
              The number represented by the roman numerals
              +
              • -
            - - - - - - - -
              -
            • -

              addTrigger

              -
              protected <T extends org.bukkit.event.Event> void addTrigger​(EnchantTrigger<T> trigger,
-                                                             java.util.function.BiConsumer<T,​java.lang.Integer> activate,
-                                                             java.util.function.BiConsumer<T,​java.lang.Integer> deactivate)
              +
            • +
              +

              addTrigger

              +
              protected <T extends org.bukkit.event.Event> void addTrigger​(EnchantTrigger<T> trigger, +java.util.function.BiConsumer<T,​java.lang.Integer> activate, +java.util.function.BiConsumer<T,​java.lang.Integer> deactivate)
              Registers an EnchantTrigger with a listener
              -
              -
              Type Parameters:
              +
              +
              Type Parameters:
              T - The event type
              -
              Parameters:
              +
              Parameters:
              trigger - The EnchantTrigger to register
              activate - The callback for when this trigger is activated
              deactivate - The callback for when this trigger is deactivated
              +
              • -
            - - - -
              -
            • -

              addTrigger

              -
              protected <T extends org.bukkit.event.Event> void addTrigger​(EnchantTrigger<T> trigger,
-                                                             java.util.function.BiConsumer<T,​java.lang.Integer> activate)
              +
            • +
              +

              addTrigger

              +
              protected <T extends org.bukkit.event.Event> void addTrigger​(EnchantTrigger<T> trigger, +java.util.function.BiConsumer<T,​java.lang.Integer> activate)
              Registers an EnchantTrigger with a listener
              -
              -
              Type Parameters:
              +
              +
              Type Parameters:
              T - The event type
              -
              Parameters:
              +
              Parameters:
              trigger - The EnchantTrigger to register
              activate - The callback for when this trigger is activated
              +
              • -
            - - - -
              -
            • -

              getIncompatible

              -
              public CustomEnchant[] getIncompatible()
              -
              -
              Returns:
              +
            • +
              +

              getIncompatible

              +
              public CustomEnchant[] getIncompatible()
              +
              +
              Returns:
              An array of all other CustomEnchants that are incompatible with this one
              +
              • -
            - - - -
              -
            • -

              getTriggers

              -
              public final java.util.Map<EnchantTrigger<?>,​redempt.redlib.enchants.EnchantListener<?>> getTriggers()
              -
              -
              Returns:
              +
            • +
              +

              getTriggers

              +
              public final java.util.Map<EnchantTrigger<?>,​redempt.redlib.enchants.EnchantListener<?>> getTriggers()
              +
              +
              Returns:
              The EventTrigger for this CustomEnchant
              +
              • -
            - - - -
              -
            • -

              appliesTo

              -
              protected boolean appliesTo​(org.bukkit.Material type)
              +
            • +
              +

              appliesTo

              +
              protected boolean appliesTo​(org.bukkit.Material type)
              Checks whether this CustomEnchant applies to a certain item type
              -
              -
              Parameters:
              +
              +
              Parameters:
              type - The type to check
              -
              Returns:
              +
              Returns:
              Whether this CustomEnchant applies to the given type
              +
              • -
            - - - -
              -
            • -

              getName

              -
              public final java.lang.String getName()
              -
              -
              Returns:
              +
            • +
              +

              getName

              +
              public final java.lang.String getName()
              +
              +
              Returns:
              The name of this CustomEnchant
              +
              • -
            - - - -
              -
            • -

              getId

              -
              public final java.lang.String getId()
              -
              -
              Returns:
              +
            • +
              +

              getId

              +
              public final java.lang.String getId()
              +
              +
              Returns:
              The ID of this CustomEnchant, the same as a lowercase version of the name that has spaces replaced with underscores
              +
              • -
            - - - -
              -
            • -

              getMaxLevel

              -
              public final int getMaxLevel()
              -
              -
              Returns:
              +
            • +
              +

              getMaxLevel

              +
              public final int getMaxLevel()
              +
              +
              Returns:
              The max level of this CustomEnchant
              +
              • -
            - - - -
              -
            • -

              getRegistry

              -
              public final EnchantRegistry getRegistry()
              -
              -
              Returns:
              +
            • +
              +

              getRegistry

              +
              public final EnchantRegistry getRegistry()
              +
              +
              Returns:
              The EnchantRegistry this CustomEnchant is registered to, or null if it has not yet been registered
              +
              • -
            - - - -
              -
            • -

              isRegistered

              -
              public final boolean isRegistered()
              -
              -
              Returns:
              +
            • +
              +

              isRegistered

              +
              public final boolean isRegistered()
              +
              +
              Returns:
              Whether this CustomEnchant has been registered yet
              +
              • -
            - - - -
              -
            • -

              getDisplayName

              -
              public java.lang.String getDisplayName()
              -
              -
              Returns:
              +
            • +
              +

              getDisplayName

              +
              public java.lang.String getDisplayName()
              +
              +
              Returns:
              The display name of this CustomEnchant, generated using the namer function of its EnchantRegistry
              +
              • -
            - - - -
              -
            • -

              apply

              -
              public org.bukkit.inventory.ItemStack apply​(org.bukkit.inventory.ItemStack item,
-                                            int level)
              +
            • +
              +

              apply

              +
              public org.bukkit.inventory.ItemStack apply​(org.bukkit.inventory.ItemStack item, +int level)
              Applies this CustomEnchant to an item, replacing it if it was already present. Removes if level is 0.
              -
              -
              Parameters:
              +
              +
              Parameters:
              item - The item to apply this CustomEnchant to
              level - The level to apply
              -
              Returns:
              +
              Returns:
              The enchanted item
              +
              • -
            - - - -
              -
            • -

              remove

              -
              public org.bukkit.inventory.ItemStack remove​(org.bukkit.inventory.ItemStack item)
              +
            • +
              +

              remove

              +
              public org.bukkit.inventory.ItemStack remove​(org.bukkit.inventory.ItemStack item)
              Removes this CustomEnchant from the given item
              -
              -
              Parameters:
              +
              +
              Parameters:
              item - The item to remove this CustomEnchant from
              -
              Returns:
              +
              Returns:
              The item with the enchant removed
              +
              • -
            - - - -
              -
            • -

              getLevel

              -
              public int getLevel​(org.bukkit.inventory.ItemStack item)
              +
            • +
              +

              getLevel

              +
              public int getLevel​(org.bukkit.inventory.ItemStack item)
              Gets the level of this CustomEnchant on an item
              -
              -
              Parameters:
              +
              +
              Parameters:
              item - The item to check the level on
              -
              Returns:
              +
              Returns:
              The level on the item, 0 if it is absent or if the item is null
              +
              • -
            - - - -
              -
            • -

              canApply

              -
              public final boolean canApply​(org.bukkit.inventory.ItemStack item)
              +
            • +
              +

              canApply

              +
              public final boolean canApply​(org.bukkit.inventory.ItemStack item)
              Checks if this CustomEnchant can be applied to the given item
              -
              -
              Parameters:
              +
              +
              Parameters:
              item - The item to check
              -
              Returns:
              +
              Returns:
              False if this CustomEnchantment cannot be applied to the item's type, or one of the CustomEnchants already on the item is incompatible with this one, true otherwise
              +
              • -
            - - - -
              -
            • -

              canApply

              -
              public final boolean canApply​(org.bukkit.Material type)
              +
            • +
              +

              canApply

              +
              public final boolean canApply​(org.bukkit.Material type)
              Checks whether this CustomEnchant applies to the given type
              -
              -
              Parameters:
              +
              +
              Parameters:
              type - The type
              -
              Returns:
              +
              Returns:
              Whether this CustomEnchant applies to the type
              +
              • -
            - - - -
              -
            • -

              isCompatible

              -
              public boolean isCompatible​(CustomEnchant ench)
              +
            • +
              +

              isCompatible

              +
              public boolean isCompatible​(CustomEnchant ench)
              Checks if this CustomEnchant is compatible with another CustomEnchant
              -
              -
              Parameters:
              +
              +
              Parameters:
              ench - The CustomEnchant to check compatibility with
              -
              Returns:
              +
              Returns:
              Whether this CustomEnchant is compatible with the given enchant
              +
              • -
            - - - -
              -
            • -

              getLore

              -
              public java.lang.String getLore​(int level)
              +
            • +
              +

              getLore

              +
              public java.lang.String getLore​(int level)
              Gets the lore that will be added to an item if this CustomEnchant is applied at the given level
              -
              -
              Parameters:
              +
              +
              Parameters:
              level - The level to be specified in the lore
              -
              Returns:
              +
              Returns:
              The line of lore
              -
              • -
            +
      -
    - - + + + + diff --git a/javadoc/redempt/redlib/enchants/EnchantInfo.html b/javadoc/redempt/redlib/enchants/EnchantInfo.html index 3b78dc3..65689eb 100644 --- a/javadoc/redempt/redlib/enchants/EnchantInfo.html +++ b/javadoc/redempt/redlib/enchants/EnchantInfo.html @@ -5,332 +5,243 @@ EnchantInfo (RedLib API) + + - + + - - - - - + + - - -
    +
    +
    + + + +
    - +
    +
    -
    Package redempt.redlib.enchants
    -

    Class EnchantInfo

    +
    Package redempt.redlib.enchants
    +

    Class EnchantInfo

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.enchants.EnchantInfo
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      redempt.redlib.enchants.EnchantInfo
      +
      +
      -
      public class EnchantInfo
+
      public class EnchantInfo
 extends java.lang.Object
      
 
      Represents a CustomEnchant and level
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Constructor Summary

          - - +
        • +
          +

          Constructor Summary

          +
          +
          • Constructors 
          + + - - + + - - - + + + + +
          Constructors
          ConstructorDescriptionConstructorDescription
          EnchantInfo​(CustomEnchant ench, - int level) +
          EnchantInfo​(CustomEnchant ench, +int level)
          Constructs an EnchantInfo from a CustomEnchant and level
          -
          • -
        +
    + -
    - +
    +
    +
    +

    Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - -
            -
          • -

            EnchantInfo

            -
            public EnchantInfo​(CustomEnchant ench,
-                   int level)
            +
          • +
            +

            Constructor Details

            +
              +
            • +
              +

              EnchantInfo

              +
              public EnchantInfo​(CustomEnchant ench, +int level)
              Constructs an EnchantInfo from a CustomEnchant and level
              -
              -
              Parameters:
              +
              +
              Parameters:
              ench - The CustomEnchant
              level - The level
              -
              • -
            +
        + -
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            getLevel

            -
            public int getLevel()
            -
            -
            Returns:
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              getLevel

              +
              public int getLevel()
              +
              +
              Returns:
              The level stored in this EnchantInfo
              +
              • -
            - - - -
              -
            • -

              getEnchant

              -
              public CustomEnchant getEnchant()
              -
              -
              Returns:
              +
            • +
              +

              getEnchant

              +
              public CustomEnchant getEnchant()
              +
              +
              Returns:
              The CustomEnchant stored in this EnchantInfo
              -
              • -
            +
      -
    - - + + + + diff --git a/javadoc/redempt/redlib/enchants/EnchantRegistry.html b/javadoc/redempt/redlib/enchants/EnchantRegistry.html index e6240be..f787a5a 100644 --- a/javadoc/redempt/redlib/enchants/EnchantRegistry.html +++ b/javadoc/redempt/redlib/enchants/EnchantRegistry.html @@ -5,639 +5,508 @@ EnchantRegistry (RedLib API) + + - + + - - - - - + + - - -
    +
    +
    + + + +
    - +
    +
    -
    Package redempt.redlib.enchants
    -

    Class EnchantRegistry

    +
    Package redempt.redlib.enchants
    +

    Class EnchantRegistry

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.enchants.EnchantRegistry
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      redempt.redlib.enchants.EnchantRegistry
      +
      +
      -
      public class EnchantRegistry
+
      public class EnchantRegistry
 extends java.lang.Object
      
 
      A registry for custom enchantments owned by a single plugin
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Constructor Summary

          - - +
        • +
          +

          Constructor Summary

          +
          +
          • Constructors 
          + + - - + + - - - + + + + - - - + + - - - + + +
          Constructors
          ConstructorDescriptionConstructorDescription
          EnchantRegistry​(org.bukkit.plugin.Plugin plugin) +
          EnchantRegistry​(org.bukkit.plugin.Plugin plugin)
          Instantiates a new EnchantRegistry with a namer that prepends the gray chat color
          EnchantRegistry​(org.bukkit.plugin.Plugin plugin, - java.lang.String prefix) +
          EnchantRegistry​(org.bukkit.plugin.Plugin plugin, +java.lang.String prefix)
          Instantiates a new EnchantRegistry
          EnchantRegistry​(org.bukkit.plugin.Plugin plugin, - java.util.function.Function<CustomEnchant,​java.lang.String> namer) +
          EnchantRegistry​(org.bukkit.plugin.Plugin plugin, +java.util.function.Function<CustomEnchant,​java.lang.String> namer)
          Instantiates a new EnchantRegistry
          -
          • -
        +
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Static Methods Instance Methods Concrete Methods 
      + - - - + + + - - - - + + + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + + - - - - + + + - - - - + + + + - - - - + + + + - - - - + + + - - - - + + + +
      Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
      org.bukkit.inventory.ItemStackapplyAll​(java.util.Map<CustomEnchant,​java.lang.Integer> enchants, - org.bukkit.inventory.ItemStack item) +
      org.bukkit.inventory.ItemStackapplyAll​(java.util.Map<CustomEnchant,​java.lang.Integer> enchants, +org.bukkit.inventory.ItemStack item)
      Applies all the enchantments in a map of CustomEnchants to their levels to an item
      voidclear() +
      voidclear()
      Removes all CustomEnchants from this EnchantRegistry
      java.util.Map<CustomEnchant,​java.lang.Integer>combine​(java.util.Map<CustomEnchant,​java.lang.Integer> first, - java.util.Map<CustomEnchant,​java.lang.Integer> second) +
      java.util.Map<CustomEnchant,​java.lang.Integer>combine​(java.util.Map<CustomEnchant,​java.lang.Integer> first, +java.util.Map<CustomEnchant,​java.lang.Integer> second)
      Combines two maps of CustomEnchants to their levels, in the same way that normal enchantments would be combined at an anvil
      EnchantInfofromLoreLine​(java.lang.String line) +
      EnchantInfofromLoreLine​(java.lang.String line)
      Gets a CustomEnchant and its level from a line of lore
      static EnchantRegistryget​(org.bukkit.plugin.Plugin plugin) +
      static EnchantRegistryget​(org.bukkit.plugin.Plugin plugin)
      Gets the EnchantRegistry owned by the given plugin
      CustomEnchantgetByName​(java.lang.String name) +
      CustomEnchantgetByName​(java.lang.String name)
      Gets a CustomEnchant by its name or ID
      java.lang.StringgetDisplayName​(CustomEnchant enchant) +
      java.lang.StringgetDisplayName​(CustomEnchant enchant)
      Gets the display name of a CustomEnchant
      ArgType<? extends CustomEnchant>getEnchantArgType​(java.lang.String name) +
      ArgType<? extends CustomEnchant>getEnchantArgType​(java.lang.String name)
      Gets the ArgType for CustomEnchants in this registry, with tab completion using IDs
      java.util.Collection<CustomEnchant>getEnchants() 
      java.util.Collection<CustomEnchant>getEnchants() 
      java.util.Map<CustomEnchant,​java.lang.Integer>getEnchants​(org.bukkit.inventory.ItemStack item) +
      java.util.Map<CustomEnchant,​java.lang.Integer>getEnchants​(org.bukkit.inventory.ItemStack item)
      Gets all the CustomEnchants on an item
      protected intgetLastSpace​(java.lang.String input) 
      protected intgetLastSpace​(java.lang.String input) 
      org.bukkit.plugin.PlugingetPlugin() 
      org.bukkit.plugin.PlugingetPlugin() 
      voidregister​(CustomEnchant ench) +
      voidregister​(CustomEnchant ench)
      Registers a CustomEnchant in this EnchantRegistry
      voidregisterAll​(org.bukkit.plugin.Plugin plugin) +
      voidregisterAll​(org.bukkit.plugin.Plugin plugin)
      Peeks inside a plugin's jar and registers all the classes which extend CustomEnchant inside it.
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

    Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - -
            -
          • -

            EnchantRegistry

            -
            public EnchantRegistry​(org.bukkit.plugin.Plugin plugin,
-                       java.util.function.Function<CustomEnchant,​java.lang.String> namer)
            +
          • +
            +

            Constructor Details

            +
              +
            • +
              +

              EnchantRegistry

              +
              public EnchantRegistry​(org.bukkit.plugin.Plugin plugin, +java.util.function.Function<CustomEnchant,​java.lang.String> namer)
              Instantiates a new EnchantRegistry
              -
              -
              Parameters:
              +
              +
              Parameters:
              plugin - The plugin that owns this EnchantRegistry
              namer - A function which will generate a display name for any given CustomEnchant
              +
              • -
            - - - -
              -
            • -

              EnchantRegistry

              -
              public EnchantRegistry​(org.bukkit.plugin.Plugin plugin,
-                       java.lang.String prefix)
              +
            • +
              +

              EnchantRegistry

              +
              public EnchantRegistry​(org.bukkit.plugin.Plugin plugin, +java.lang.String prefix)
              Instantiates a new EnchantRegistry
              -
              -
              Parameters:
              +
              +
              Parameters:
              plugin - The plugin that owns this EnchantResgistry
              prefix - The prefix to be prepended to the name of any given CustomEnchant to create the display name
              +
              • -
            - - - -
              -
            • -

              EnchantRegistry

              -
              public EnchantRegistry​(org.bukkit.plugin.Plugin plugin)
              +
            • +
              +

              EnchantRegistry

              +
              public EnchantRegistry​(org.bukkit.plugin.Plugin plugin)
              Instantiates a new EnchantRegistry with a namer that prepends the gray chat color
              -
              -
              Parameters:
              +
              +
              Parameters:
              plugin - The plugin that owns this EnchantRegistry
              -
              • -
            +
        + -
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            get

            -
            public static EnchantRegistry get​(org.bukkit.plugin.Plugin plugin)
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              get

              +
              public static EnchantRegistry get​(org.bukkit.plugin.Plugin plugin)
              Gets the EnchantRegistry owned by the given plugin
              -
              -
              Parameters:
              +
              +
              Parameters:
              plugin - The plugin owning the requested EnchantRegistry
              -
              Returns:
              +
              Returns:
              The EnchantRegistry owned by the plugin
              +
              • -
            - - - -
              -
            • -

              getByName

              -
              public CustomEnchant getByName​(java.lang.String name)
              +
            • +
              +

              getByName

              +
              public CustomEnchant getByName​(java.lang.String name)
              Gets a CustomEnchant by its name or ID
              -
              -
              Parameters:
              +
              +
              Parameters:
              name - The name or ID of the enchantment
              -
              Returns:
              +
              Returns:
              The CustomEnchant
              +
              • -
            - - - -
              -
            • -

              getEnchants

              -
              public java.util.Collection<CustomEnchant> getEnchants()
              -
              -
              Returns:
              +
            • +
              +

              getEnchants

              +
              public java.util.Collection<CustomEnchant> getEnchants()
              +
              +
              Returns:
              A collection of all the CustomEnchants in this EnchantRegistry
              +
              • -
            - - - -
              -
            • -

              getLastSpace

              -
              protected int getLastSpace​(java.lang.String input)
              +
            • +
              +

              getLastSpace

              +
              protected int getLastSpace​(java.lang.String input)
              +
              • -
            - - - -
              -
            • -

              register

              -
              public void register​(CustomEnchant ench)
              +
            • +
              +

              register

              +
              public void register​(CustomEnchant ench)
              Registers a CustomEnchant in this EnchantRegistry
              -
              -
              Parameters:
              +
              +
              Parameters:
              ench - The CustomEnchant to register
              +
              • -
            - - - -
              -
            • -

              getPlugin

              -
              public org.bukkit.plugin.Plugin getPlugin()
              -
              -
              Returns:
              +
            • +
              +

              getPlugin

              +
              public org.bukkit.plugin.Plugin getPlugin()
              +
              +
              Returns:
              The plugin that owns this EnchantRegistry
              +
              • -
            - - - -
              -
            • -

              clear

              -
              public void clear()
              +
            • +
              +

              clear

              +
              public void clear()
              Removes all CustomEnchants from this EnchantRegistry
              +
              • -
            - - - -
              -
            • -

              registerAll

              -
              public void registerAll​(org.bukkit.plugin.Plugin plugin)
              +
            • +
              +

              registerAll

              +
              public void registerAll​(org.bukkit.plugin.Plugin plugin)
              Peeks inside a plugin's jar and registers all the classes which extend CustomEnchant inside it. Note: Custom enchantment classes MUST have a constructor with no arguments to be loaded by this method
              -
              -
              Parameters:
              +
              +
              Parameters:
              plugin - The plugin to load all CustomEnchants from
              +
              • -
            - - - -
              -
            • -

              getEnchants

              -
              public java.util.Map<CustomEnchant,​java.lang.Integer> getEnchants​(org.bukkit.inventory.ItemStack item)
              +
            • +
              +

              getEnchants

              +
              public java.util.Map<CustomEnchant,​java.lang.Integer> getEnchants​(org.bukkit.inventory.ItemStack item)
              Gets all the CustomEnchants on an item
              -
              -
              Parameters:
              +
              +
              Parameters:
              item - The item to get the CustomEnchants from
              -
              Returns:
              +
              Returns:
              A map of each CustomEnchant on this item to its level
              +
              • -
            - - - -
              -
            • -

              combine

              -
              public java.util.Map<CustomEnchant,​java.lang.Integer> combine​(java.util.Map<CustomEnchant,​java.lang.Integer> first,
-                                                                    java.util.Map<CustomEnchant,​java.lang.Integer> second)
              +
            • +
              +

              combine

              +
              public java.util.Map<CustomEnchant,​java.lang.Integer> combine​(java.util.Map<CustomEnchant,​java.lang.Integer> first, +java.util.Map<CustomEnchant,​java.lang.Integer> second)
              Combines two maps of CustomEnchants to their levels, in the same way that normal enchantments would be combined at an anvil
              -
              -
              Parameters:
              +
              +
              Parameters:
              first - The first map of CustomEnchants to levels
              second - The second map of CustomEnchants to levels - Incompatible enchants will be removed from this map
              -
              Returns:
              +
              Returns:
              A map of the combined CustomEnchants to their levels
              +
              • -
            - - - -
              -
            • -

              applyAll

              -
              public org.bukkit.inventory.ItemStack applyAll​(java.util.Map<CustomEnchant,​java.lang.Integer> enchants,
-                                               org.bukkit.inventory.ItemStack item)
              +
            • +
              +

              applyAll

              +
              public org.bukkit.inventory.ItemStack applyAll​(java.util.Map<CustomEnchant,​java.lang.Integer> enchants, +org.bukkit.inventory.ItemStack item)
              Applies all the enchantments in a map of CustomEnchants to their levels to an item
              -
              -
              Parameters:
              +
              +
              Parameters:
              enchants - The map of CustomEnchants to their levels
              item - The item to apply the enchants to
              -
              Returns:
              +
              Returns:
              The enchanted item
              +
              • -
            - - - -
              -
            • -

              fromLoreLine

              -
              public EnchantInfo fromLoreLine​(java.lang.String line)
              +
            • +
              +

              fromLoreLine

              +
              public EnchantInfo fromLoreLine​(java.lang.String line)
              Gets a CustomEnchant and its level from a line of lore
              -
              -
              Parameters:
              +
              +
              Parameters:
              line - The line of lore
              -
              Returns:
              +
              Returns:
              The EnchantInfo containing the enchantment type and level, or null if there was no CustomEnchant on the given line of lore
              +
              • -
            - - - -
              -
            • -

              getDisplayName

              -
              public java.lang.String getDisplayName​(CustomEnchant enchant)
              +
            • +
              +

              getDisplayName

              +
              public java.lang.String getDisplayName​(CustomEnchant enchant)
              Gets the display name of a CustomEnchant
              -
              -
              Parameters:
              +
              +
              Parameters:
              enchant - The Enchant to get the display name of
              -
              Returns:
              +
              Returns:
              The display name
              +
              • -
            - - - -
              -
            • -

              getEnchantArgType

              -
              public ArgType<? extends CustomEnchant> getEnchantArgType​(java.lang.String name)
              +
            • +
              +

              getEnchantArgType

              +
              public ArgType<? extends CustomEnchant> getEnchantArgType​(java.lang.String name)
              Gets the ArgType for CustomEnchants in this registry, with tab completion using IDs
              -
              -
              Parameters:
              +
              +
              Parameters:
              name - The name to use for the argument type
              -
              Returns:
              +
              Returns:
              A CommandArgumentType for CustomEnchants in this registry
              -
              • -
            +
      -
    - - + + + + diff --git a/javadoc/redempt/redlib/enchants/EventItems.html b/javadoc/redempt/redlib/enchants/EventItems.html index a9a2716..b4c4bd3 100644 --- a/javadoc/redempt/redlib/enchants/EventItems.html +++ b/javadoc/redempt/redlib/enchants/EventItems.html @@ -5,413 +5,312 @@ EventItems (RedLib API) + + - + + - - - - - + + - - -
    +
    +
    + + + +
    - +
    +
    -
    Package redempt.redlib.enchants
    -

    Class EventItems

    +
    Package redempt.redlib.enchants
    +

    Class EventItems

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.enchants.EventItems
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      redempt.redlib.enchants.EventItems
      +
      +
      -
      public class EventItems
+
      public class EventItems
 extends java.lang.Object
      
 
      Represents the items related to an event, for handling by enchantments
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Constructor Summary

          - - +
        • +
          +

          Constructor Summary

          +
          +
          • Constructors 
          + + - - + + - - - + + + + + - - - + + + - - - + + + - - - + + + +
          Constructors
          ConstructorDescriptionConstructorDescription
          EventItems​(org.bukkit.event.Event event, - org.bukkit.inventory.ItemStack after) 
          EventItems​(org.bukkit.event.Event event, +org.bukkit.inventory.ItemStack after) 
          EventItems​(org.bukkit.event.Event event, - org.bukkit.inventory.ItemStack[] after) 
          EventItems​(org.bukkit.event.Event event, +org.bukkit.inventory.ItemStack[] after) 
          EventItems​(org.bukkit.event.Event event, - org.bukkit.inventory.ItemStack[] before, - org.bukkit.inventory.ItemStack[] after) 
          EventItems​(org.bukkit.event.Event event, +org.bukkit.inventory.ItemStack[] before, +org.bukkit.inventory.ItemStack[] after) 
          EventItems​(org.bukkit.event.Event event, - org.bukkit.inventory.ItemStack before, - org.bukkit.inventory.ItemStack after) 
          EventItems​(org.bukkit.event.Event event, +org.bukkit.inventory.ItemStack before, +org.bukkit.inventory.ItemStack after) 
          -
          • -
        +
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Instance Methods Concrete Methods 
      + - - - + + + - - - - + + + + + + - - - - + + + + - - - - + + + + +
      Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
      org.bukkit.inventory.ItemStack[]getAfter() 
      org.bukkit.inventory.ItemStack[]getAfter() 
      org.bukkit.inventory.ItemStack[]getBefore() 
      org.bukkit.inventory.ItemStack[]getBefore() 
      org.bukkit.event.EventgetEvent() 
      org.bukkit.event.EventgetEvent() 
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

    Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - -
            -
          • -

            EventItems

            -
            public EventItems​(org.bukkit.event.Event event,
-                  org.bukkit.inventory.ItemStack[] before,
-                  org.bukkit.inventory.ItemStack[] after)
            -
            -
            Parameters:
            +
          • +
            +

            Constructor Details

            +
              +
            • +
              +

              EventItems

              +
              public EventItems​(org.bukkit.event.Event event, +org.bukkit.inventory.ItemStack[] before, +org.bukkit.inventory.ItemStack[] after)
              +
              +
              Parameters:
              event - The event
              before - The array of items before the event executes
              after - The array of items after the event executes
              +
              • -
            - - - -
              -
            • -

              EventItems

              -
              public EventItems​(org.bukkit.event.Event event,
-                  org.bukkit.inventory.ItemStack before,
-                  org.bukkit.inventory.ItemStack after)
              -
              -
              Parameters:
              +
            • +
              +

              EventItems

              +
              public EventItems​(org.bukkit.event.Event event, +org.bukkit.inventory.ItemStack before, +org.bukkit.inventory.ItemStack after)
              +
              +
              Parameters:
              event - The event
              before - The item before the event executes
              after - The item after the event executes
              +
              • -
            - - - -
              -
            • -

              EventItems

              -
              public EventItems​(org.bukkit.event.Event event,
-                  org.bukkit.inventory.ItemStack[] after)
              -
              -
              Parameters:
              +
            • +
              +

              EventItems

              +
              public EventItems​(org.bukkit.event.Event event, +org.bukkit.inventory.ItemStack[] after)
              +
              +
              Parameters:
              event - The event
              after - The array of items related to the event
              +
              • -
            - - - -
              -
            • -

              EventItems

              -
              public EventItems​(org.bukkit.event.Event event,
-                  org.bukkit.inventory.ItemStack after)
              -
              -
              Parameters:
              +
            • +
              +

              EventItems

              +
              public EventItems​(org.bukkit.event.Event event, +org.bukkit.inventory.ItemStack after)
              +
              +
              Parameters:
              event - The event
              after - The item related to the event
              -
              • -
            +
        + -
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            getBefore

            -
            public org.bukkit.inventory.ItemStack[] getBefore()
            -
            -
            Returns:
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              getBefore

              +
              public org.bukkit.inventory.ItemStack[] getBefore()
              +
              +
              Returns:
              The array of items before the event executes
              +
              • -
            - - - -
              -
            • -

              getAfter

              -
              public org.bukkit.inventory.ItemStack[] getAfter()
              -
              -
              Returns:
              +
            • +
              +

              getAfter

              +
              public org.bukkit.inventory.ItemStack[] getAfter()
              +
              +
              Returns:
              The array of items after the event executes
              +
              • -
            - - - -
              -
            • -

              getEvent

              -
              public org.bukkit.event.Event getEvent()
              -
              -
              Returns:
              +
            • +
              +

              getEvent

              +
              public org.bukkit.event.Event getEvent()
              +
              +
              Returns:
              The event
              -
              • -
            +
      -
    - - + + + + diff --git a/javadoc/redempt/redlib/enchants/events/PlayerChangedArmorEvent.html b/javadoc/redempt/redlib/enchants/events/PlayerChangedArmorEvent.html index 6476043..0657f07 100644 --- a/javadoc/redempt/redlib/enchants/events/PlayerChangedArmorEvent.html +++ b/javadoc/redempt/redlib/enchants/events/PlayerChangedArmorEvent.html @@ -5,439 +5,311 @@ PlayerChangedArmorEvent (RedLib API) + + - + + - - - - - + + - - -
    +
    +
    + + + +
    - +
    +
    -
    Package redempt.redlib.enchants.events
    -

    Class PlayerChangedArmorEvent

    +
    Package redempt.redlib.enchants.events
    +

    Class PlayerChangedArmorEvent

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • org.bukkit.event.Event
        • -
      • -
          -
        • org.bukkit.event.player.PlayerEvent
          • -
        • -
            -
          • redempt.redlib.enchants.events.PlayerChangedArmorEvent
            • -
          -
          • -
        -
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      org.bukkit.event.Event +
      org.bukkit.event.player.PlayerEvent +
      redempt.redlib.enchants.events.PlayerChangedArmorEvent
      +
      +
      +
      +
      -
      public class PlayerChangedArmorEvent
+
      public class PlayerChangedArmorEvent
 extends org.bukkit.event.player.PlayerEvent
      
 
      Called when a player changes any piece of armor
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Nested Class Summary

          -
            -
          • - - -

            Nested classes/interfaces inherited from class org.bukkit.event.Event

            -org.bukkit.event.Event.Result
            • -
          -
          • -
        +
      • +
        +

        Nested Class Summary

        +
        +

        Nested classes/interfaces inherited from class org.bukkit.event.Event

        +org.bukkit.event.Event.Result
        - -
        -
          -
        • - - -

          Field Summary

          -
            -
          • - - -

            Fields inherited from class org.bukkit.event.player.PlayerEvent

            -player
            • -
          • -
        + +
      • +
        +

        Field Summary

        +
        +

        Fields inherited from class org.bukkit.event.player.PlayerEvent

        +player
        +
        • -
        -
          -
        • - - -

          Constructor Summary

          - - +
        • +
          +

          Constructor Summary

          +
          +
          • Constructors 
          + + - - + + - - - + + + + +
          Constructors
          ConstructorDescriptionConstructorDescription
          PlayerChangedArmorEvent​(org.bukkit.entity.Player player, - org.bukkit.inventory.ItemStack[] previous, - org.bukkit.inventory.ItemStack[] current) +
          PlayerChangedArmorEvent​(org.bukkit.entity.Player player, +org.bukkit.inventory.ItemStack[] previous, +org.bukkit.inventory.ItemStack[] current)
          Constructs a new PlayerChangedArmorEvent
          -
          • -
        +
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Static Methods Instance Methods Concrete Methods 
      + - - - + + + - - - - + + + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + +
      Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
      static org.bukkit.event.HandlerListgetHandlerList() 
      static org.bukkit.event.HandlerListgetHandlerList() 
      org.bukkit.event.HandlerListgetHandlers() 
      org.bukkit.event.HandlerListgetHandlers() 
      org.bukkit.inventory.ItemStack[]getNewArmor() 
      org.bukkit.inventory.ItemStack[]getNewArmor() 
      org.bukkit.inventory.ItemStack[]getPreviousArmor() 
      org.bukkit.inventory.ItemStack[]getPreviousArmor() 
      static voidregister() 
      static voidregister() 
      -
        -
      • - - -

        Methods inherited from class org.bukkit.event.player.PlayerEvent

        -getPlayer
        • -
      -
        -
      • - - -

        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
        • -
      -
      • -
    +
    +
    +
    +

    Methods inherited from class org.bukkit.event.player.PlayerEvent

    +getPlayer
    +
    +

    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

          - - - -
            -
          • -

            PlayerChangedArmorEvent

            -
            public PlayerChangedArmorEvent​(org.bukkit.entity.Player player,
-                               org.bukkit.inventory.ItemStack[] previous,
-                               org.bukkit.inventory.ItemStack[] current)
            +
          • +
            +

            Constructor Details

            +
              +
            • +
              +

              PlayerChangedArmorEvent

              +
              public PlayerChangedArmorEvent​(org.bukkit.entity.Player player, +org.bukkit.inventory.ItemStack[] previous, +org.bukkit.inventory.ItemStack[] current)
              Constructs a new PlayerChangedArmorEvent
              -
              -
              Parameters:
              +
              +
              Parameters:
              player - The Player who changed their armor
              previous - The armor the Player was previously wearing
              current - The armor the Player is now wearing
              -
              • -
            +
        + -
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            getHandlerList

            -
            public static org.bukkit.event.HandlerList getHandlerList()
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              getHandlerList

              +
              public static org.bukkit.event.HandlerList getHandlerList()
              +
              • -
            - - - -
              -
            • -

              register

              -
              public static void register()
              +
            • +
              +

              register

              +
              public static void register()
              +
              • -
            - - - -
              -
            • -

              getPreviousArmor

              -
              public org.bukkit.inventory.ItemStack[] getPreviousArmor()
              -
              -
              Returns:
              +
            • +
              +

              getPreviousArmor

              +
              public org.bukkit.inventory.ItemStack[] getPreviousArmor()
              +
              +
              Returns:
              The armor the Player was previously wearing
              +
              • -
            - - - -
              -
            • -

              getNewArmor

              -
              public org.bukkit.inventory.ItemStack[] getNewArmor()
              -
              -
              Returns:
              +
            • +
              +

              getNewArmor

              +
              public org.bukkit.inventory.ItemStack[] getNewArmor()
              +
              +
              Returns:
              The armor the Player is now wearing
              +
              • -
            - - - -
              -
            • -

              getHandlers

              -
              public org.bukkit.event.HandlerList getHandlers()
              -
              -
              Specified by:
              +
            • +
              +

              getHandlers

              +
              public org.bukkit.event.HandlerList getHandlers()
              +
              +
              Specified by:
              getHandlers in class org.bukkit.event.Event
              -
              • -
            +
      -
    - - + + + + diff --git a/javadoc/redempt/redlib/enchants/events/PlayerChangedHeldItemEvent.html b/javadoc/redempt/redlib/enchants/events/PlayerChangedHeldItemEvent.html index 35b7c52..aa7ec65 100644 --- a/javadoc/redempt/redlib/enchants/events/PlayerChangedHeldItemEvent.html +++ b/javadoc/redempt/redlib/enchants/events/PlayerChangedHeldItemEvent.html @@ -5,441 +5,313 @@ PlayerChangedHeldItemEvent (RedLib API) + + - + + - - - - - + + - - -
    +
    +
    + + + +
    - +
    +
    -
    Package redempt.redlib.enchants.events
    -

    Class PlayerChangedHeldItemEvent

    +
    Package redempt.redlib.enchants.events
    +

    Class PlayerChangedHeldItemEvent

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • org.bukkit.event.Event
        • -
      • -
          -
        • org.bukkit.event.player.PlayerEvent
          • -
        • -
            -
          • redempt.redlib.enchants.events.PlayerChangedHeldItemEvent
            • -
          -
          • -
        -
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      org.bukkit.event.Event +
      org.bukkit.event.player.PlayerEvent +
      redempt.redlib.enchants.events.PlayerChangedHeldItemEvent
      +
      +
      +
      +
      -
      public class PlayerChangedHeldItemEvent
+
      public class PlayerChangedHeldItemEvent
 extends org.bukkit.event.player.PlayerEvent
      
 
      Called when a player changes the item they are holding, or a property of their held item changes
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Nested Class Summary

          -
            -
          • - - -

            Nested classes/interfaces inherited from class org.bukkit.event.Event

            -org.bukkit.event.Event.Result
            • -
          -
          • -
        +
      • +
        +

        Nested Class Summary

        +
        +

        Nested classes/interfaces inherited from class org.bukkit.event.Event

        +org.bukkit.event.Event.Result
        - -
        -
          -
        • - - -

          Field Summary

          -
            -
          • - - -

            Fields inherited from class org.bukkit.event.player.PlayerEvent

            -player
            • -
          • -
        + +
      • +
        +

        Field Summary

        +
        +

        Fields inherited from class org.bukkit.event.player.PlayerEvent

        +player
        +
        • -
        -
          -
        • - - -

          Constructor Summary

          - - +
        • +
          +

          Constructor Summary

          +
          +
          • Constructors 
          + + - - + + - - - + + + + +
          Constructors
          ConstructorDescriptionConstructorDescription
          PlayerChangedHeldItemEvent​(org.bukkit.entity.Player player, - org.bukkit.inventory.ItemStack oldItem, - org.bukkit.inventory.ItemStack newItem) +
          PlayerChangedHeldItemEvent​(org.bukkit.entity.Player player, +org.bukkit.inventory.ItemStack oldItem, +org.bukkit.inventory.ItemStack newItem)
          Constructs a new PlayerChangedHeldItemEvent
          -
          • -
        +
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Static Methods Instance Methods Concrete Methods 
      + - - - + + + - - - - + + + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + +
      Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
      static org.bukkit.event.HandlerListgetHandlerList() 
      static org.bukkit.event.HandlerListgetHandlerList() 
      org.bukkit.event.HandlerListgetHandlers() 
      org.bukkit.event.HandlerListgetHandlers() 
      org.bukkit.inventory.ItemStackgetNewItem() 
      org.bukkit.inventory.ItemStackgetNewItem() 
      org.bukkit.inventory.ItemStackgetPreviousItem() 
      org.bukkit.inventory.ItemStackgetPreviousItem() 
      static voidregister() 
      static voidregister() 
      -
        -
      • - - -

        Methods inherited from class org.bukkit.event.player.PlayerEvent

        -getPlayer
        • -
      -
        -
      • - - -

        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
        • -
      -
      • -
    +
    +
    +
    +

    Methods inherited from class org.bukkit.event.player.PlayerEvent

    +getPlayer
    +
    +

    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

          - - - -
            -
          • -

            PlayerChangedHeldItemEvent

            -
            public PlayerChangedHeldItemEvent​(org.bukkit.entity.Player player,
-                                  org.bukkit.inventory.ItemStack oldItem,
-                                  org.bukkit.inventory.ItemStack newItem)
            +
          • +
            +

            Constructor Details

            +
              +
            • +
              +

              PlayerChangedHeldItemEvent

              +
              public PlayerChangedHeldItemEvent​(org.bukkit.entity.Player player, +org.bukkit.inventory.ItemStack oldItem, +org.bukkit.inventory.ItemStack newItem)
              Constructs a new PlayerChangedHeldItemEvent
              -
              -
              Parameters:
              +
              +
              Parameters:
              player - The Player who changed their held item
              oldItem - The item they were previously holding
              newItem - The item they are now holding
              -
              • -
            +
        + -
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            getHandlerList

            -
            public static org.bukkit.event.HandlerList getHandlerList()
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              getHandlerList

              +
              public static org.bukkit.event.HandlerList getHandlerList()
              +
              • -
            - - - -
              -
            • -

              register

              -
              public static void register()
              +
            • +
              +

              register

              +
              public static void register()
              +
              • -
            - - - -
              -
            • -

              getPreviousItem

              -
              public org.bukkit.inventory.ItemStack getPreviousItem()
              -
              -
              Returns:
              +
            • +
              +

              getPreviousItem

              +
              public org.bukkit.inventory.ItemStack getPreviousItem()
              +
              +
              Returns:
              The item the player was holding previously
              +
              • -
            - - - -
              -
            • -

              getNewItem

              -
              public org.bukkit.inventory.ItemStack getNewItem()
              -
              -
              Returns:
              +
            • +
              +

              getNewItem

              +
              public org.bukkit.inventory.ItemStack getNewItem()
              +
              +
              Returns:
              The item the player is now holding
              +
              • -
            - - - -
              -
            • -

              getHandlers

              -
              public org.bukkit.event.HandlerList getHandlers()
              -
              -
              Specified by:
              +
            • +
              +

              getHandlers

              +
              public org.bukkit.event.HandlerList getHandlers()
              +
              +
              Specified by:
              getHandlers in class org.bukkit.event.Event
              -
              Returns:
              +
              Returns:
              The player
              -
              • -
            +
      -
    - - + + + + diff --git a/javadoc/redempt/redlib/enchants/events/package-summary.html b/javadoc/redempt/redlib/enchants/events/package-summary.html index cd6c917..c0218d7 100644 --- a/javadoc/redempt/redlib/enchants/events/package-summary.html +++ b/javadoc/redempt/redlib/enchants/events/package-summary.html @@ -5,47 +5,30 @@ redempt.redlib.enchants.events (RedLib API) + + - + + - - - - - + + - - -
    +
    + +

    Package redempt.redlib.enchants.events

    -
    -
    -
    +
    + + +
    +
    + diff --git a/javadoc/redempt/redlib/enchants/events/package-tree.html b/javadoc/redempt/redlib/enchants/events/package-tree.html index 6f25fdf..a8bb3f7 100644 --- a/javadoc/redempt/redlib/enchants/events/package-tree.html +++ b/javadoc/redempt/redlib/enchants/events/package-tree.html @@ -5,101 +5,58 @@ redempt.redlib.enchants.events Class Hierarchy (RedLib API) + + - + + - - - - - + + - - -
    +
    + +

    Hierarchy For Package redempt.redlib.enchants.events

    -Package Hierarchies: +Package Hierarchies:
    -
    -
    +

    Class Hierarchy

    -
    +
    +
    diff --git a/javadoc/redempt/redlib/enchants/package-summary.html b/javadoc/redempt/redlib/enchants/package-summary.html index dd786d0..cdb3d66 100644 --- a/javadoc/redempt/redlib/enchants/package-summary.html +++ b/javadoc/redempt/redlib/enchants/package-summary.html @@ -5,47 +5,30 @@ redempt.redlib.enchants (RedLib API) + + - + + - - - - - + + - - -
    +
    + +

    Package redempt.redlib.enchants

    -
    -
    -
    +
    + + +
    +
    + diff --git a/javadoc/redempt/redlib/enchants/package-tree.html b/javadoc/redempt/redlib/enchants/package-tree.html index bf6b4ce..1eec4a4 100644 --- a/javadoc/redempt/redlib/enchants/package-tree.html +++ b/javadoc/redempt/redlib/enchants/package-tree.html @@ -5,159 +5,92 @@ redempt.redlib.enchants Class Hierarchy (RedLib API) + + - + + - - - - - + + - - -
    +
    + +

    Hierarchy For Package redempt.redlib.enchants

    -Package Hierarchies: +Package Hierarchies:
    -
    -
    +

    Class Hierarchy

    -
    +
    +
    diff --git a/javadoc/redempt/redlib/enchants/trigger/EnchantTrigger.html b/javadoc/redempt/redlib/enchants/trigger/EnchantTrigger.html index 11ae6ef..2569dc1 100644 --- a/javadoc/redempt/redlib/enchants/trigger/EnchantTrigger.html +++ b/javadoc/redempt/redlib/enchants/trigger/EnchantTrigger.html @@ -5,606 +5,478 @@ EnchantTrigger (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.enchants.trigger
    -

    Class EnchantTrigger<T extends org.bukkit.event.Event>

    +
    Package redempt.redlib.enchants.trigger
    +

    Class EnchantTrigger<T extends org.bukkit.event.Event>

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.enchants.trigger.EnchantTrigger<T>
        • -
      -
      • -
    -
    -
      -
    • -
      -
      Type Parameters:
      +
      java.lang.Object +
      redempt.redlib.enchants.trigger.EnchantTrigger<T>
      +
      +
      +
      +
      Type Parameters:
      T - The event type this EventTrigger passes
      -
      +
      Direct Known Subclasses:
      KillEntityTrigger
      -
      public abstract class EnchantTrigger<T extends org.bukkit.event.Event>
+
      public abstract class EnchantTrigger<T extends org.bukkit.event.Event>
 extends java.lang.Object
      
 
      Represents a trigger for a CustomEnchant which will smartly pass relevant events
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Field Summary

          - - +
        • +
          +

          Field Summary

          +
          +
          • Fields 
          + + - - - + + + - - - - + + + + + - - - - + + + - - - - + + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + +
          Fields
          Modifier and TypeFieldDescriptionModifier and TypeFieldDescription
          static EnchantTrigger<org.bukkit.event.entity.EntityDamageByEntityEvent>ATTACK_ENTITY +
          static EnchantTrigger<org.bukkit.event.entity.EntityDamageByEntityEvent>ATTACK_ENTITY
          Calls activate with an EntityDamageByEntityEvent when a player attacks an entity with an item that has a CustomEnchant with this trigger
          static EnchantTrigger<PlayerChangedArmorEvent>EQUIP_ARMOR +
          static EnchantTrigger<PlayerChangedArmorEvent>EQUIP_ARMOR
          Calls activate with a PlayerChangedArmorEvent when a player equips armor that has a CustomEnchant with this trigger Also calls activate when a player joins wearing armor with this trigger Calls deactivate with a PlayerChangedArmorEvent when a player unequips armor that has a CustomEnchant with this trigger Also calls deactivate when a player leaves wearing armor with this trigger
          protected java.util.Map<java.lang.Class<? extends org.bukkit.event.Event>,​java.util.function.Function<org.bukkit.event.Event,​EventItems>>events 
          protected java.util.Map<java.lang.Class<? extends org.bukkit.event.Event>,​java.util.function.Function<org.bukkit.event.Event,​EventItems>>events 
          static EnchantTrigger<PlayerChangedHeldItemEvent>HOLD_ITEM +
          static EnchantTrigger<PlayerChangedHeldItemEvent>HOLD_ITEM
          Calls activate with a PlayerChangedHeldItemEvent when a player begins holding an item that has a CustomEnchant with this trigger Also calls activate when a player joins holding an item with this trigger Calls deactivate with a PlayerChangedHeldItemEvent when a player stops holding an item that has a CustomEnchant with this trigger Also calls deactivate when a player leaves holding an item with this trigger
          static EnchantTrigger<org.bukkit.event.entity.EntityDeathEvent>KILL_ENTITY +
          static EnchantTrigger<org.bukkit.event.entity.EntityDeathEvent>KILL_ENTITY
          Calls activate with an EntityDeathEvent when a player kills an entity with an item that has a CustomEnchant with this trigger
          static EnchantTrigger<org.bukkit.event.block.BlockBreakEvent>MINE_BLOCK +
          static EnchantTrigger<org.bukkit.event.block.BlockBreakEvent>MINE_BLOCK
          Calls activate with a BlockBreakEvent when a block is broken with an item that has a CustomEnchant with this trigger
          static EnchantTrigger<org.bukkit.event.entity.ProjectileLaunchEvent>SHOOT_ARROW +
          static EnchantTrigger<org.bukkit.event.entity.ProjectileLaunchEvent>SHOOT_ARROW
          Calls activate with a ProjectileLaunchEvent when a player shoots a projectile with an item that has a CustomEnchant with this trigger
          static EnchantTrigger<org.bukkit.event.entity.EntityDamageEvent>TAKE_DAMAGE +
          static EnchantTrigger<org.bukkit.event.entity.EntityDamageEvent>TAKE_DAMAGE
          Calls activate with an EntityDamageEvent when a player takes damage wearing armor that has a CustomEnchant with this trigger
          -
          • -
        +
    + -
    -
      -
    • - - -

      Constructor Summary

      - - +
    • +
      +

      Constructor Summary

      +
      +
      • Constructors 
      + + - - + + - - - + + + + + +
      Constructors
      ConstructorDescriptionConstructorDescription
      EnchantTrigger() 
      EnchantTrigger() 
      -
      • -
    +
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Instance Methods Abstract Methods Concrete Methods 
      + - - - + + + - - - - + + + + + - - - - + + + - - - - + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + +
      Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
      protected <T extends org.bukkit.event.Event>
      void      		addListener​(java.lang.Class<T> eventClass, - java.util.function.Function<T,​EventItems> func) +
      protected <T extends org.bukkit.event.Event>
      void      		addListener​(java.lang.Class<T> eventClass, +java.util.function.Function<T,​EventItems> func)
      Registers a listener for this EventTrigger to get the items and event for the specified event
      abstract booleandefaultAppliesTo​(org.bukkit.Material type) +
      abstract booleandefaultAppliesTo​(org.bukkit.Material type)
      Returns whether this EnchantTrigger applies to the given type by default
      java.util.Map<java.lang.Class<? extends org.bukkit.event.Event>,​java.util.function.Function<org.bukkit.event.Event,​EventItems>>getEvents() +
      java.util.Map<java.lang.Class<? extends org.bukkit.event.Event>,​java.util.function.Function<org.bukkit.event.Event,​EventItems>>getEvents()
      Gets the event listeners registered by this EnchantTrigger
      org.bukkit.event.EventPrioritygetPriority() 
      org.bukkit.event.EventPrioritygetPriority() 
      voidinit() 
      voidinit() 
      protected abstract voidregister() 
      protected abstract voidregister() 
      EnchantTrigger<T>withPriority​(org.bukkit.event.EventPriority priority) +
      EnchantTrigger<T>withPriority​(org.bukkit.event.EventPriority priority)
      Creates a copy of this EnchantTrigger with a different EventPriority
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

    Methods inherited from class java.lang.Object

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

          Field Detail

          - - - -
            -
          • -

            MINE_BLOCK

            -
            public static final EnchantTrigger<org.bukkit.event.block.BlockBreakEvent> MINE_BLOCK
            +
          • +
            +

            Field Details

            +
              +
            • +
              +

              MINE_BLOCK

              +
              public static final EnchantTrigger<org.bukkit.event.block.BlockBreakEvent> MINE_BLOCK
              Calls activate with a BlockBreakEvent when a block is broken with an item that has a CustomEnchant with this trigger
              +
              • -
            - - - -
              -
            • -

              ATTACK_ENTITY

              -
              public static final EnchantTrigger<org.bukkit.event.entity.EntityDamageByEntityEvent> ATTACK_ENTITY
              +
            • +
              +

              ATTACK_ENTITY

              +
              public static final EnchantTrigger<org.bukkit.event.entity.EntityDamageByEntityEvent> ATTACK_ENTITY
              Calls activate with an EntityDamageByEntityEvent when a player attacks an entity with an item that has a CustomEnchant with this trigger
              +
              • -
            - - - -
              -
            • -

              KILL_ENTITY

              -
              public static final EnchantTrigger<org.bukkit.event.entity.EntityDeathEvent> KILL_ENTITY
              +
            • +
              +

              KILL_ENTITY

              +
              public static final EnchantTrigger<org.bukkit.event.entity.EntityDeathEvent> KILL_ENTITY
              Calls activate with an EntityDeathEvent when a player kills an entity with an item that has a CustomEnchant with this trigger
              +
              • -
            - - - -
              -
            • -

              SHOOT_ARROW

              -
              public static final EnchantTrigger<org.bukkit.event.entity.ProjectileLaunchEvent> SHOOT_ARROW
              +
            • +
              +

              SHOOT_ARROW

              +
              public static final EnchantTrigger<org.bukkit.event.entity.ProjectileLaunchEvent> SHOOT_ARROW
              Calls activate with a ProjectileLaunchEvent when a player shoots a projectile with an item that has a CustomEnchant with this trigger
              +
              • -
            - - - -
              -
            • -

              TAKE_DAMAGE

              -
              public static final EnchantTrigger<org.bukkit.event.entity.EntityDamageEvent> TAKE_DAMAGE
              +
            • +
              +

              TAKE_DAMAGE

              +
              public static final EnchantTrigger<org.bukkit.event.entity.EntityDamageEvent> TAKE_DAMAGE
              Calls activate with an EntityDamageEvent when a player takes damage wearing armor that has a CustomEnchant with this trigger
              +
              • -
            - - - -
              -
            • -

              EQUIP_ARMOR

              -
              public static final EnchantTrigger<PlayerChangedArmorEvent> EQUIP_ARMOR
              +
            • +
              +

              EQUIP_ARMOR

              +
              public static final EnchantTrigger<PlayerChangedArmorEvent> EQUIP_ARMOR
              Calls activate with a PlayerChangedArmorEvent when a player equips armor that has a CustomEnchant with this trigger Also calls activate when a player joins wearing armor with this trigger Calls deactivate with a PlayerChangedArmorEvent when a player unequips armor that has a CustomEnchant with this trigger Also calls deactivate when a player leaves wearing armor with this trigger
              +
              • -
            - - - -
              -
            • -

              HOLD_ITEM

              -
              public static final EnchantTrigger<PlayerChangedHeldItemEvent> HOLD_ITEM
              +
            • +
              +

              HOLD_ITEM

              +
              public static final EnchantTrigger<PlayerChangedHeldItemEvent> HOLD_ITEM
              Calls activate with a PlayerChangedHeldItemEvent when a player begins holding an item that has a CustomEnchant with this trigger Also calls activate when a player joins holding an item with this trigger Calls deactivate with a PlayerChangedHeldItemEvent when a player stops holding an item that has a CustomEnchant with this trigger Also calls deactivate when a player leaves holding an item with this trigger
              +
              • -
            - - - -
              -
            • -

              events

              -
              protected java.util.Map<java.lang.Class<? extends org.bukkit.event.Event>,​java.util.function.Function<org.bukkit.event.Event,​EventItems>> events
              -
              • -
            +
          • +
            +

            events

            +
            protected java.util.Map<java.lang.Class<? extends org.bukkit.event.Event>,​java.util.function.Function<org.bukkit.event.Event,​EventItems>> events
            +
        - -
        -
          -
        • - - -

          Constructor Detail

          - - - -
            -
          • -

            EnchantTrigger

            -
            public EnchantTrigger()
            • -
          + +
        • +
          +

          Constructor Details

          +
            +
          • +
            +

            EnchantTrigger

            +
            public EnchantTrigger()
            +
          +
          • -
          -
            -
          • - - -

            Method Detail

            - - - -
              -
            • -

              register

              -
              protected abstract void register()
              +
            • +
              +

              Method Details

              +
                +
              • +
                +

                register

                +
                protected abstract void register()
                +
                • -
              - - - -
                -
              • -

                init

                -
                public final void init()
                +
              • +
                +

                init

                +
                public final void init()
                +
                • -
              - - - -
                -
              • -

                addListener

                -
                protected <T extends org.bukkit.event.Event> void addListener​(java.lang.Class<T> eventClass,
-                                                              java.util.function.Function<T,​EventItems> func)
                +
              • +
                +

                addListener

                +
                protected <T extends org.bukkit.event.Event> void addListener​(java.lang.Class<T> eventClass, +java.util.function.Function<T,​EventItems> func)
                Registers a listener for this EventTrigger to get the items and event for the specified event
                -
                -
                Type Parameters:
                +
                +
                Type Parameters:
                T - The event type
                -
                Parameters:
                +
                Parameters:
                eventClass - The class of the event
                func - The function to get the EventItems from the event
                +
                • -
              - - - -
                -
              • -

                getEvents

                -
                public java.util.Map<java.lang.Class<? extends org.bukkit.event.Event>,​java.util.function.Function<org.bukkit.event.Event,​EventItems>> getEvents()
                +
              • +
                +

                getEvents

                +
                public java.util.Map<java.lang.Class<? extends org.bukkit.event.Event>,​java.util.function.Function<org.bukkit.event.Event,​EventItems>> getEvents()
                Gets the event listeners registered by this EnchantTrigger
                -
                -
                Returns:
                +
                +
                Returns:
                The map of events to their functions which will retrieve relevant items
                +
                • -
              - - - -
                -
              • -

                getPriority

                -
                public org.bukkit.event.EventPriority getPriority()
                -
                -
                Returns:
                +
              • +
                +

                getPriority

                +
                public org.bukkit.event.EventPriority getPriority()
                +
                +
                Returns:
                The EventPriority this EnchantTrigger's listeners should be registered with
                +
                • -
              - - - -
                -
              • -

                defaultAppliesTo

                -
                public abstract boolean defaultAppliesTo​(org.bukkit.Material type)
                +
              • +
                +

                defaultAppliesTo

                +
                public abstract boolean defaultAppliesTo​(org.bukkit.Material type)
                Returns whether this EnchantTrigger applies to the given type by default
                -
                -
                Parameters:
                +
                +
                Parameters:
                type - The type to check
                -
                Returns:
                +
                Returns:
                Whether this EnchantTrigger applies to the type by default
                +
                • -
              - - - -
                -
              • -

                withPriority

                -
                public EnchantTrigger<T> withPriority​(org.bukkit.event.EventPriority priority)
                +
              • +
                +

                withPriority

                +
                public EnchantTrigger<T> withPriority​(org.bukkit.event.EventPriority priority)
                Creates a copy of this EnchantTrigger with a different EventPriority
                -
                -
                Parameters:
                +
                +
                Parameters:
                priority - The EventPriority to set on the copy
                -
                Returns:
                +
                Returns:
                A copy of this EnchantTrigger with the given priority
                -
                • -
              +
        -
    - - + + + + diff --git a/javadoc/redempt/redlib/enchants/trigger/KillEntityTrigger.html b/javadoc/redempt/redlib/enchants/trigger/KillEntityTrigger.html index b2db27c..c3ea281 100644 --- a/javadoc/redempt/redlib/enchants/trigger/KillEntityTrigger.html +++ b/javadoc/redempt/redlib/enchants/trigger/KillEntityTrigger.html @@ -5,358 +5,254 @@ KillEntityTrigger (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.enchants.trigger
    -

    Class KillEntityTrigger

    +
    Package redempt.redlib.enchants.trigger
    +

    Class KillEntityTrigger

    -
    - -
    -
      -
    • +
      java.lang.Object +
      redempt.redlib.enchants.trigger.EnchantTrigger<org.bukkit.event.entity.EntityDeathEvent> +
      redempt.redlib.enchants.trigger.KillEntityTrigger
      +
      +
      +
      -
      public class KillEntityTrigger
+
      public class KillEntityTrigger
 extends EnchantTrigger<org.bukkit.event.entity.EntityDeathEvent>
      
-
      • -
    -
    -
    -
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Instance Methods Concrete Methods 
      + - - - + + + - - - - + + + + + - - - - + + + + +
      Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
      booleandefaultAppliesTo​(org.bukkit.Material type) +
      booleandefaultAppliesTo​(org.bukkit.Material type)
      Returns whether this EnchantTrigger applies to the given type by default
      protected voidregister() 
      protected voidregister() 
      - -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

    Methods inherited from class redempt.redlib.enchants.trigger.EnchantTrigger

    +addListener, getEvents, getPriority, init, withPriority
    +
    +

    Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - -
            -
          • -

            KillEntityTrigger

            -
            public KillEntityTrigger()
            -
            • -
          +
        • +
          +

          Constructor Details

          +
            +
          • +
            +

            KillEntityTrigger

            +
            public KillEntityTrigger()
            +
          +
          • -
          -
            -
          • - - -

            Method Detail

            - - - -
              -
            • -

              register

              -
              protected void register()
              -
              -
              Specified by:
              +
            • +
              +

              Method Details

              +
                +
              • +
                +

                register

                +
                protected void register()
                +
                +
                Specified by:
                register in class EnchantTrigger<org.bukkit.event.entity.EntityDeathEvent>
                +
                • -
              - - - -
                -
              • -

                defaultAppliesTo

                -
                public boolean defaultAppliesTo​(org.bukkit.Material type)
                -
                Description copied from class: EnchantTrigger
                +
              • +
                +

                defaultAppliesTo

                +
                public boolean defaultAppliesTo​(org.bukkit.Material type)
                +
                Description copied from class: EnchantTrigger
                Returns whether this EnchantTrigger applies to the given type by default
                -
                -
                Specified by:
                +
                +
                Specified by:
                defaultAppliesTo in class EnchantTrigger<org.bukkit.event.entity.EntityDeathEvent>
                -
                Parameters:
                +
                Parameters:
                type - The type to check
                -
                Returns:
                +
                Returns:
                Whether this EnchantTrigger applies to the type by default
                -
                • -
              +
        -
    - - + + + + diff --git a/javadoc/redempt/redlib/enchants/trigger/package-summary.html b/javadoc/redempt/redlib/enchants/trigger/package-summary.html index 1fb2a53..b2c000f 100644 --- a/javadoc/redempt/redlib/enchants/trigger/package-summary.html +++ b/javadoc/redempt/redlib/enchants/trigger/package-summary.html @@ -5,47 +5,30 @@ redempt.redlib.enchants.trigger (RedLib API) + + - + + - - - - - + + - - -
    +
    + +

    Package redempt.redlib.enchants.trigger

    -
    -
      -
    • - - +
      +
        +
      • +
        +
      Class Summary 
      + + - - + + + - - - + + - - - + + +
      Class Summary
      ClassDescriptionClassDescription
      EnchantTrigger<T extends org.bukkit.event.Event> +
      EnchantTrigger<T extends org.bukkit.event.Event>
      Represents a trigger for a CustomEnchant which will smartly pass relevant events
      KillEntityTrigger 
      KillEntityTrigger 
      +
    -
    +
    + + +
    +
    + diff --git a/javadoc/redempt/redlib/enchants/trigger/package-tree.html b/javadoc/redempt/redlib/enchants/trigger/package-tree.html index 460f283..452a684 100644 --- a/javadoc/redempt/redlib/enchants/trigger/package-tree.html +++ b/javadoc/redempt/redlib/enchants/trigger/package-tree.html @@ -5,160 +5,93 @@ redempt.redlib.enchants.trigger Class Hierarchy (RedLib API) + + - + + - - - - - + + - - -
    +
    + +

    Hierarchy For Package redempt.redlib.enchants.trigger

    -Package Hierarchies: +Package Hierarchies:
    -
    -
    +

    Class Hierarchy

    -
    +
    +
    diff --git a/javadoc/redempt/redlib/inventorygui/InventoryGUI.GUIState.html b/javadoc/redempt/redlib/inventorygui/InventoryGUI.GUIState.html index 2485fc8..63294a8 100644 --- a/javadoc/redempt/redlib/inventorygui/InventoryGUI.GUIState.html +++ b/javadoc/redempt/redlib/inventorygui/InventoryGUI.GUIState.html @@ -5,266 +5,183 @@ InventoryGUI.GUIState (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.inventorygui
    -

    Class InventoryGUI.GUIState

    +
    Package redempt.redlib.inventorygui
    +

    Class InventoryGUI.GUIState

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.inventorygui.InventoryGUI.GUIState
        • -
      -
      • -
    -
    -
      -
    • -
      +
      java.lang.Object +
      redempt.redlib.inventorygui.InventoryGUI.GUIState
      +
      +
      +
      Enclosing class:
      InventoryGUI
      -
      public static class InventoryGUI.GUIState
+
      public static class InventoryGUI.GUIState
 extends java.lang.Object
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Method Summary

          - - +
        • +
          +

          Method Summary

          +
          +
          +
          +
          • All Methods Instance Methods Concrete Methods 
          + - - - + + + - - - - + + + + + +
          Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
          voidrestore() +
          voidrestore()
          Restore the GUI to this state
          -
            -
          • - - -

            Methods inherited from class java.lang.Object

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

    Methods inherited from class java.lang.Object

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

          Method Detail

          - - - -
            -
          • -

            restore

            -
            public void restore()
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              restore

              +
              public void restore()
              Restore the GUI to this state
              -
              • -
            +
      -
    -
    - + + + + diff --git a/javadoc/redempt/redlib/inventorygui/InventoryGUI.html b/javadoc/redempt/redlib/inventorygui/InventoryGUI.html index 5fad0c8..d798b21 100644 --- a/javadoc/redempt/redlib/inventorygui/InventoryGUI.html +++ b/javadoc/redempt/redlib/inventorygui/InventoryGUI.html @@ -5,1021 +5,844 @@ InventoryGUI (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.inventorygui
    -

    Class InventoryGUI

    +
    Package redempt.redlib.inventorygui
    +

    Class InventoryGUI

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.inventorygui.InventoryGUI
        • -
      -
      • -
    -
    -
      -
    • -
      +
      java.lang.Object +
      redempt.redlib.inventorygui.InventoryGUI
      +
      +
      +
      All Implemented Interfaces:
      org.bukkit.event.Listener
      -
      public class InventoryGUI
+
      public class InventoryGUI
 extends java.lang.Object
 implements org.bukkit.event.Listener
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Nested Class Summary

          - - +
        • +
          +

          Nested Class Summary

          +
          +
          • Nested Classes 
          + + - - - - - - - - - + + + + + + + + + + + +
          Nested Classes
          Modifier and TypeClassDescription
          static class InventoryGUI.GUIState 
          Modifier and TypeClassDescription
          static class InventoryGUI.GUIState 
          -
          • -
        +
    + -
    -
      -
    • - - -

      Field Summary

      - - +
    • +
      +

      Field Summary

      +
      +
      • Fields 
      + + - - - - - - - - + + + + + + + + + +
      Fields
      Modifier and TypeFieldDescription
      static org.bukkit.inventory.ItemStackFILLER +Modifier and TypeFieldDescription
      static org.bukkit.inventory.ItemStackFILLER
      A gray stained glass pane with no name.
      -
      • -
    +
    + -
    -
      -
    • - - -

      Constructor Summary

      - - +
    • +
      +

      Constructor Summary

      +
      +
      • Constructors 
      + + - - - - - - + + + + + + + - - - + + +
      Constructors
      ConstructorDescription
      InventoryGUI​(int size, - java.lang.String name) +ConstructorDescription
      InventoryGUI​(int size, +java.lang.String name)
      Creates a new GUI, instantiating a new inventory with the given size and name
      InventoryGUI​(org.bukkit.inventory.Inventory inventory) +
      InventoryGUI​(org.bukkit.inventory.Inventory inventory)
      Creates a new GUI from an inventory
      -
      • -
    +
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Instance Methods Concrete Methods 
      + - - - - - - - - + + + + + + + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + + - - - - + + + - - - - + + + - - - - + + + - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + +
      Modifier and TypeMethodDescription
      voidaddButton​(int slot, - ItemButton button) +Modifier and TypeMethodDescription
      voidaddButton​(int slot, +ItemButton button)
      Add a button to the GUI in the given slot
      voidaddButton​(ItemButton button, - int slot) +
      voidaddButton​(ItemButton button, +int slot)
      Add a button to the GUI in the given slot
      voidaddButton​(ItemButton button, - int x, - int y) +
      voidaddButton​(ItemButton button, +int x, +int y)
      Add a button at the given position in the inventory
      voidclear() +
      voidclear()
      Clears the inventory and its buttons
      voidcloseSlot​(int slot) +
      voidcloseSlot​(int slot)
      Closes a slot so that items can't be placed in it
      voidcloseSlots​(int start, - int end) +
      voidcloseSlots​(int start, +int end)
      Closes slots so that items can't be placed in them
      voiddestroy() +
      voiddestroy()
      Remove this inventory as a listener and clean everything up to prevent memory leaks.
      voiddestroy​(org.bukkit.entity.Player lastViewer) +
      voiddestroy​(org.bukkit.entity.Player lastViewer)
      Remove this inventory as a listener and clean everything up to prevent memory leaks.
      booleandestroysOnClose() +
      booleandestroysOnClose()
      Returns whether this GUI is destroyed when it has been closed by all viewers
      voidfill​(int x1, - int y1, - int x2, - int y2, - org.bukkit.inventory.ItemStack item) +
      voidfill​(int x1, +int y1, +int x2, +int y2, +org.bukkit.inventory.ItemStack item)
      Fill a section of the inventory with the given item
      voidfill​(int start, - int end, - org.bukkit.inventory.ItemStack item) +
      voidfill​(int start, +int end, +org.bukkit.inventory.ItemStack item)
      Fill a section of the inventory with the given item
      java.util.List<ItemButton>getButtons() 
      java.util.List<ItemButton>getButtons() 
      org.bukkit.inventory.InventorygetInventory() +
      org.bukkit.inventory.InventorygetInventory()
      Gets the inventory this GUI is wrapping
      java.util.Set<java.lang.Integer>getOpenSlots() +
      java.util.Set<java.lang.Integer>getOpenSlots()
      Gets the open slots
      InventoryGUI.GUIStategetState() +
      InventoryGUI.GUIStategetState()
      Gets the state of the GUI, which can be restored later
      voidonClick​(org.bukkit.event.inventory.InventoryClickEvent e) 
      voidonClose​(org.bukkit.event.inventory.InventoryCloseEvent e) 
      voidonDrag​(org.bukkit.event.inventory.InventoryDragEvent e) 
      voidopen​(org.bukkit.entity.Player player) +
      voidonClick​(org.bukkit.event.inventory.InventoryClickEvent e) 
      voidonClose​(org.bukkit.event.inventory.InventoryCloseEvent e) 
      voidonDrag​(org.bukkit.event.inventory.InventoryDragEvent e) 
      voidopen​(org.bukkit.entity.Player player)
      Opens this GUI for a player
      voidopenSlot​(int slot) +
      voidopenSlot​(int slot)
      Opens a slot so that items can be placed in it
      voidopenSlots​(int start, - int end) +
      voidopenSlots​(int start, +int end)
      Opens slots so that items can be placed in them
      voidremoveButton​(ItemButton button) +
      voidremoveButton​(ItemButton button)
      Remove a button from the inventory
      booleanreturnsItems() +
      booleanreturnsItems()
      Returns whether or not items in open slots are returned to the player when this inventory is destroyed
      voidsetDestroyOnClose​(boolean destroyOnClose) +
      voidsetDestroyOnClose​(boolean destroyOnClose)
      Sets whether this GUI is destroyed when it has been closed by all viewers
      voidsetOnClickOpenSlot​(java.util.function.BiConsumer<org.bukkit.event.inventory.InventoryClickEvent,​java.util.List<java.lang.Integer>> handler) +
      voidsetOnClickOpenSlot​(java.util.function.BiConsumer<org.bukkit.event.inventory.InventoryClickEvent,​java.util.List<java.lang.Integer>> handler)
      Sets the handler for when an open slot is clicked
      voidsetOnClickOpenSlot​(java.util.function.Consumer<org.bukkit.event.inventory.InventoryClickEvent> handler) +
      voidsetOnClickOpenSlot​(java.util.function.Consumer<org.bukkit.event.inventory.InventoryClickEvent> handler)
      Sets the handler for when an open slot is clicked
      voidsetOnDestroy​(java.lang.Runnable onDestroy) +
      voidsetOnDestroy​(java.lang.Runnable onDestroy)
      Sets a callback to be run when this GUI is destroyed
      voidsetOnDragOpenSlot​(java.util.function.Consumer<org.bukkit.event.inventory.InventoryDragEvent> onDrag) +
      voidsetOnDragOpenSlot​(java.util.function.Consumer<org.bukkit.event.inventory.InventoryDragEvent> onDrag)
      Sets the handler for when items are drag-clicked into open slots
      voidsetReturnsItems​(boolean returnItems) +
      voidsetReturnsItems​(boolean returnItems)
      Sets whether items in open slots are returned to the player when this inventory is destroyed
      voidupdate() +
      voidupdate()
      Refresh the inventory.
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

    Methods inherited from class java.lang.Object

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

          Field Detail

          - - - -
            -
          • -

            FILLER

            -
            public static final org.bukkit.inventory.ItemStack FILLER
            +
          • +
            +

            Field Details

            +
              +
            • +
              +

              FILLER

              +
              public static final org.bukkit.inventory.ItemStack FILLER
              A gray stained glass pane with no name. Good for filling empty slots in GUIs.
              -
              • -
            +
        + -
        -
          -
        • - - -

          Constructor Detail

          - - - -
            -
          • -

            InventoryGUI

            -
            public InventoryGUI​(org.bukkit.inventory.Inventory inventory)
            +
          • +
            +

            Constructor Details

            +
              +
            • +
              +

              InventoryGUI

              +
              public InventoryGUI​(org.bukkit.inventory.Inventory inventory)
              Creates a new GUI from an inventory
              -
              -
              Parameters:
              +
              +
              Parameters:
              inventory - The inventory to create a GUI from
              +
              • -
            - - - -
              -
            • -

              InventoryGUI

              -
              public InventoryGUI​(int size,
-                    java.lang.String name)
              +
            • +
              +

              InventoryGUI

              +
              public InventoryGUI​(int size, +java.lang.String name)
              Creates a new GUI, instantiating a new inventory with the given size and name
              -
              -
              Parameters:
              +
              +
              Parameters:
              size - The size of the inventory
              name - The name of the inventory
              -
              • -
            +
        + -
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            getInventory

            -
            public org.bukkit.inventory.Inventory getInventory()
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              getInventory

              +
              public org.bukkit.inventory.Inventory getInventory()
              Gets the inventory this GUI is wrapping
              -
              -
              Returns:
              +
              +
              Returns:
              The wrapped inventory
              +
              • -
            - - - -
              -
            • -

              addButton

              -
              public void addButton​(ItemButton button,
-                      int slot)
              +
            • +
              +

              addButton

              +
              public void addButton​(ItemButton button, +int slot)
              Add a button to the GUI in the given slot
              -
              -
              Parameters:
              +
              +
              Parameters:
              button - The button to be added
              slot - The slot to add the button to
              +
              • -
            - - - -
              -
            • -

              addButton

              -
              public void addButton​(int slot,
-                      ItemButton button)
              +
            • +
              +

              addButton

              +
              public void addButton​(int slot, +ItemButton button)
              Add a button to the GUI in the given slot
              -
              -
              Parameters:
              +
              +
              Parameters:
              button - The button to be added
              slot - The slot to add the button to
              +
              • -
            - - - -
              -
            • -

              addButton

              -
              public void addButton​(ItemButton button,
-                      int x,
-                      int y)
              +
            • +
              +

              addButton

              +
              public void addButton​(ItemButton button, +int x, +int y)
              Add a button at the given position in the inventory
              -
              -
              Parameters:
              +
              +
              Parameters:
              button - The button to be added
              x - The X position to add the button at
              y - The Y position to add the button at
              +
              • -
            - - - -
              -
            • -

              fill

              -
              public void fill​(int start,
-                 int end,
-                 org.bukkit.inventory.ItemStack item)
              +
            • +
              +

              fill

              +
              public void fill​(int start, +int end, +org.bukkit.inventory.ItemStack item)
              Fill a section of the inventory with the given item
              -
              -
              Parameters:
              +
              +
              Parameters:
              start - The starting index to fill from, inclusive
              end - The ending index to fill to, exclusive
              item - The item to set in these slots
              +
              • -
            - - - -
              -
            • -

              fill

              -
              public void fill​(int x1,
-                 int y1,
-                 int x2,
-                 int y2,
-                 org.bukkit.inventory.ItemStack item)
              +
            • +
              +

              fill

              +
              public void fill​(int x1, +int y1, +int x2, +int y2, +org.bukkit.inventory.ItemStack item)
              Fill a section of the inventory with the given item
              -
              -
              Parameters:
              +
              +
              Parameters:
              x1 - The X position to fill from, inclusive
              y1 - The Y position to fill from, inclusive
              x2 - The X position to fill to, exclusive
              y2 - The Y position to fill to, exclusive
              item - The item to set in these slots
              +
              • -
            - - - -
              -
            • -

              removeButton

              -
              public void removeButton​(ItemButton button)
              +
            • +
              +

              removeButton

              +
              public void removeButton​(ItemButton button)
              Remove a button from the inventory
              -
              -
              Parameters:
              +
              +
              Parameters:
              button - The button to be removed
              +
              • -
            - - - -
              -
            • -

              getButtons

              -
              public java.util.List<ItemButton> getButtons()
              -
              -
              Returns:
              +
            • +
              +

              getButtons

              +
              public java.util.List<ItemButton> getButtons()
              +
              +
              Returns:
              All the ItemButtons in this GUI
              +
              • -
            - - - -
              -
            • -

              update

              -
              public void update()
              +
            • +
              +

              update

              +
              public void update()
              Refresh the inventory.
              +
              • -
            - - - -
              -
            • -

              openSlot

              -
              public void openSlot​(int slot)
              +
            • +
              +

              openSlot

              +
              public void openSlot​(int slot)
              Opens a slot so that items can be placed in it
              -
              -
              Parameters:
              +
              +
              Parameters:
              slot - The slot to open
              +
              • -
            - - - -
              -
            • -

              openSlots

              -
              public void openSlots​(int start,
-                      int end)
              +
            • +
              +

              openSlots

              +
              public void openSlots​(int start, +int end)
              Opens slots so that items can be placed in them
              -
              -
              Parameters:
              +
              +
              Parameters:
              start - The start of the open slot section, inclusive
              end - The end of the open slot section, exclusive
              +
              • -
            - - - -
              -
            • -

              closeSlot

              -
              public void closeSlot​(int slot)
              +
            • +
              +

              closeSlot

              +
              public void closeSlot​(int slot)
              Closes a slot so that items can't be placed in it
              -
              -
              Parameters:
              +
              +
              Parameters:
              slot - The slot to open
              +
              • -
            - - - -
              -
            • -

              closeSlots

              -
              public void closeSlots​(int start,
-                       int end)
              +
            • +
              +

              closeSlots

              +
              public void closeSlots​(int start, +int end)
              Closes slots so that items can't be placed in them
              -
              -
              Parameters:
              +
              +
              Parameters:
              start - The start of the closed slot section, inclusive
              end - The end of the open closed section, exclusive
              +
              • -
            - - - -
              -
            • -

              getOpenSlots

              -
              public java.util.Set<java.lang.Integer> getOpenSlots()
              +
            • +
              +

              getOpenSlots

              +
              public java.util.Set<java.lang.Integer> getOpenSlots()
              Gets the open slots
              -
              -
              Returns:
              +
              +
              Returns:
              The set of open slots
              +
              • -
            - - - -
              -
            • -

              open

              -
              public void open​(org.bukkit.entity.Player player)
              +
            • +
              +

              open

              +
              public void open​(org.bukkit.entity.Player player)
              Opens this GUI for a player
              -
              -
              Parameters:
              +
              +
              Parameters:
              player - The player to open this GUI for
              +
              • -
            - - - -
              -
            • -

              returnsItems

              -
              public boolean returnsItems()
              +
            • +
              +

              returnsItems

              +
              public boolean returnsItems()
              Returns whether or not items in open slots are returned to the player when this inventory is destroyed
              -
              -
              Returns:
              +
              +
              Returns:
              Whether or not items in open slots are returned to the player when this inventory is destroyed
              +
              • -
            - - - -
              -
            • -

              setReturnsItems

              -
              public void setReturnsItems​(boolean returnItems)
              +
            • +
              +

              setReturnsItems

              +
              public void setReturnsItems​(boolean returnItems)
              Sets whether items in open slots are returned to the player when this inventory is destroyed
              -
              -
              Parameters:
              +
              +
              Parameters:
              returnItems - Whether items in open slots should be returned to the player when this inventory is destroyed
              +
              • -
            - - - -
              -
            • -

              destroysOnClose

              -
              public boolean destroysOnClose()
              +
            • +
              +

              destroysOnClose

              +
              public boolean destroysOnClose()
              Returns whether this GUI is destroyed when it has been closed by all viewers
              -
              -
              Returns:
              +
              +
              Returns:
              Whether this GUI is destroyed when it has been closed by all viewers
              +
              • -
            - - - -
              -
            • -

              setDestroyOnClose

              -
              public void setDestroyOnClose​(boolean destroyOnClose)
              +
            • +
              +

              setDestroyOnClose

              +
              public void setDestroyOnClose​(boolean destroyOnClose)
              Sets whether this GUI is destroyed when it has been closed by all viewers
              -
              -
              Parameters:
              +
              +
              Parameters:
              destroyOnClose - Whether this GUI is destroyed when it has been closed by all viewers
              +
              • -
            - - - -
              -
            • -

              setOnDestroy

              -
              public void setOnDestroy​(java.lang.Runnable onDestroy)
              +
            • +
              +

              setOnDestroy

              +
              public void setOnDestroy​(java.lang.Runnable onDestroy)
              Sets a callback to be run when this GUI is destroyed
              -
              -
              Parameters:
              +
              +
              Parameters:
              onDestroy - The callback
              +
              • -
            - - - -
              -
            • -

              setOnClickOpenSlot

              -
              public void setOnClickOpenSlot​(java.util.function.Consumer<org.bukkit.event.inventory.InventoryClickEvent> handler)
              +
            • +
              +

              setOnClickOpenSlot

              +
              public void setOnClickOpenSlot​(java.util.function.Consumer<org.bukkit.event.inventory.InventoryClickEvent> handler)
              Sets the handler for when an open slot is clicked
              -
              -
              Parameters:
              +
              +
              Parameters:
              handler - The handler for when an open slot is clicked
              +
              • -
            - - - -
              -
            • -

              setOnClickOpenSlot

              -
              public void setOnClickOpenSlot​(java.util.function.BiConsumer<org.bukkit.event.inventory.InventoryClickEvent,​java.util.List<java.lang.Integer>> handler)
              +
            • +
              +

              setOnClickOpenSlot

              +
              public void setOnClickOpenSlot​(java.util.function.BiConsumer<org.bukkit.event.inventory.InventoryClickEvent,​java.util.List<java.lang.Integer>> handler)
              Sets the handler for when an open slot is clicked
              -
              -
              Parameters:
              +
              +
              Parameters:
              handler - The handler for when an open slot is clicked, taking the event and list of affected slots
              +
              • -
            - - - -
              -
            • -

              destroy

              -
              public void destroy​(org.bukkit.entity.Player lastViewer)
              +
            • +
              +

              destroy

              +
              public void destroy​(org.bukkit.entity.Player lastViewer)
              Remove this inventory as a listener and clean everything up to prevent memory leaks. Call this when the GUI is no longer being used.
              -
              -
              Parameters:
              +
              +
              Parameters:
              lastViewer - The last Player who was viewing this GUI, to have the items returned to them.
              +
              • -
            - - - -
              -
            • -

              destroy

              -
              public void destroy()
              +
            • +
              +

              destroy

              +
              public void destroy()
              Remove this inventory as a listener and clean everything up to prevent memory leaks. Call this when the GUI is no longer being used.
              +
              • -
            - - - -
              -
            • -

              clear

              -
              public void clear()
              +
            • +
              +

              clear

              +
              public void clear()
              Clears the inventory and its buttons
              +
              • -
            - - - -
              -
            • -

              setOnDragOpenSlot

              -
              public void setOnDragOpenSlot​(java.util.function.Consumer<org.bukkit.event.inventory.InventoryDragEvent> onDrag)
              +
            • +
              +

              setOnDragOpenSlot

              +
              public void setOnDragOpenSlot​(java.util.function.Consumer<org.bukkit.event.inventory.InventoryDragEvent> onDrag)
              Sets the handler for when items are drag-clicked into open slots
              -
              -
              Parameters:
              +
              +
              Parameters:
              onDrag - The handler
              +
              • -
            - - - -
              -
            • -

              onDrag

              -
              public void onDrag​(org.bukkit.event.inventory.InventoryDragEvent e)
              +
            • +
              +

              onDrag

              +
              public void onDrag​(org.bukkit.event.inventory.InventoryDragEvent e)
              +
              • -
            - - - -
              -
            • -

              onClick

              -
              public void onClick​(org.bukkit.event.inventory.InventoryClickEvent e)
              +
            • +
              +

              onClick

              +
              public void onClick​(org.bukkit.event.inventory.InventoryClickEvent e)
              +
              • -
            - - - -
              -
            • -

              onClose

              -
              public void onClose​(org.bukkit.event.inventory.InventoryCloseEvent e)
              +
            • +
              +

              onClose

              +
              public void onClose​(org.bukkit.event.inventory.InventoryCloseEvent e)
              +
              • -
            - - - -
              -
            • -

              getState

              -
              public InventoryGUI.GUIState getState()
              +
            • +
              +

              getState

              +
              public InventoryGUI.GUIState getState()
              Gets the state of the GUI, which can be restored later
              -
              -
              Returns:
              +
              +
              Returns:
              The state of this GUI
              -
              • -
            +
      -
    - - + + + + diff --git a/javadoc/redempt/redlib/inventorygui/ItemButton.html b/javadoc/redempt/redlib/inventorygui/ItemButton.html index 130704a..eaa2e3e 100644 --- a/javadoc/redempt/redlib/inventorygui/ItemButton.html +++ b/javadoc/redempt/redlib/inventorygui/ItemButton.html @@ -5,445 +5,341 @@ ItemButton (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.inventorygui
    -

    Class ItemButton

    +
    Package redempt.redlib.inventorygui
    +

    Class ItemButton

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.inventorygui.ItemButton
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      redempt.redlib.inventorygui.ItemButton
      +
      +
      -
      public abstract class ItemButton
+
      public abstract class ItemButton
 extends java.lang.Object
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Field Summary

          - - +
        • +
          +

          Field Summary

          +
          +
          • Fields 
          + + - - - + + + - - - - + + + + + + +
          Fields
          Modifier and TypeFieldDescriptionModifier and TypeFieldDescription
          protected org.bukkit.inventory.ItemStackitem 
          protected org.bukkit.inventory.ItemStackitem 
          -
          • -
        +
    + -
    -
      -
    • - - -

      Constructor Summary

      - - +
    • +
      +

      Constructor Summary

      +
      +
      • Constructors 
      + + - - + + - - - + + + + +
      Constructors
      ConstructorDescriptionConstructorDescription
      ItemButton​(org.bukkit.inventory.ItemStack item) +
      ItemButton​(org.bukkit.inventory.ItemStack item)
      Create a new ItemButton with the given ItemStack as the icon
      -
      • -
    +
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      + - - - + + + - - - - + + + + + - - - - + + + - - - - + + + + - - - - + + + + - - - - + + + - - - - + + + + +
      Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
      static ItemButtoncreate​(org.bukkit.inventory.ItemStack item, - java.util.function.Consumer<org.bukkit.event.inventory.InventoryClickEvent> listener) +
      static ItemButtoncreate​(org.bukkit.inventory.ItemStack item, +java.util.function.Consumer<org.bukkit.event.inventory.InventoryClickEvent> listener)
      Create an ItemButton from the given ItemStack and listener.
      org.bukkit.inventory.ItemStackgetItem() +
      org.bukkit.inventory.ItemStackgetItem()
      Get the ItemStack representing the icon for this button
      protected intgetSlot() 
      protected intgetSlot() 
      abstract voidonClick​(org.bukkit.event.inventory.InventoryClickEvent e) 
      abstract voidonClick​(org.bukkit.event.inventory.InventoryClickEvent e) 
      voidsetItem​(org.bukkit.inventory.ItemStack item) +
      voidsetItem​(org.bukkit.inventory.ItemStack item)
      Update the item of this button.
      protected voidsetSlot​(int slot) 
      protected voidsetSlot​(int slot) 
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

    Methods inherited from class java.lang.Object

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

          Field Detail

          - - - -
            -
          • -

            item

            -
            protected org.bukkit.inventory.ItemStack item
            -
            • -
          +
        • +
          +

          Field Details

          +
            +
          • +
            +

            item

            +
            protected org.bukkit.inventory.ItemStack item
            +
          +
          • -
          -
            -
          • - - -

            Constructor Detail

            - - - -
              -
            • -

              ItemButton

              -
              public ItemButton​(org.bukkit.inventory.ItemStack item)
              +
            • +
              +

              Constructor Details

              +
                +
              • +
                +

                ItemButton

                +
                public ItemButton​(org.bukkit.inventory.ItemStack item)
                Create a new ItemButton with the given ItemStack as the icon
                -
                -
                Parameters:
                +
                +
                Parameters:
                item - The ItemStack to be used as the icon
                -
                • -
              +
          + -
          -
            -
          • - - -

            Method Detail

            - - - -
              -
            • -

              create

              -
              public static ItemButton create​(org.bukkit.inventory.ItemStack item,
-                                java.util.function.Consumer<org.bukkit.event.inventory.InventoryClickEvent> listener)
              +
            • +
              +

              Method Details

              +
                +
              • +
                +

                create

                +
                public static ItemButton create​(org.bukkit.inventory.ItemStack item, +java.util.function.Consumer<org.bukkit.event.inventory.InventoryClickEvent> listener)
                Create an ItemButton from the given ItemStack and listener. Useful if you, like most people, would rather use lambdas than the anonymous class definition.
                -
                -
                Parameters:
                +
                +
                Parameters:
                item - The ItemStack to be used as this button's icon
                listener - The listener which will be called whenever this button is clicked
                -
                Returns:
                +
                Returns:
                The ItemButton, which can be added to an InventoryGUI
                +
                • -
              - - - -
                -
              • -

                getItem

                -
                public org.bukkit.inventory.ItemStack getItem()
                +
              • +
                +

                getItem

                +
                public org.bukkit.inventory.ItemStack getItem()
                Get the ItemStack representing the icon for this button
                -
                -
                Returns:
                +
                +
                Returns:
                The ItemStack
                +
                • -
              - - - -
                -
              • -

                getSlot

                -
                protected int getSlot()
                +
              • +
                +

                getSlot

                +
                protected int getSlot()
                +
                • -
              - - - -
                -
              • -

                setSlot

                -
                protected void setSlot​(int slot)
                +
              • +
                +

                setSlot

                +
                protected void setSlot​(int slot)
                +
                • -
              - - - -
                -
              • -

                setItem

                -
                public void setItem​(org.bukkit.inventory.ItemStack item)
                +
              • +
                +

                setItem

                +
                public void setItem​(org.bukkit.inventory.ItemStack item)
                Update the item of this button. Does not refresh the InventoryGUI; you must call InventoryGUI.update() for this change to be reflected in the GUI.
                -
                -
                Parameters:
                +
                +
                Parameters:
                item - The item to become the icon for this button
                +
                • -
              - - - -
                -
              • -

                onClick

                -
                public abstract void onClick​(org.bukkit.event.inventory.InventoryClickEvent e)
                -
                • -
              +
            • +
              +

              onClick

              +
              public abstract void onClick​(org.bukkit.event.inventory.InventoryClickEvent e)
              +
        -
    - - + + + + diff --git a/javadoc/redempt/redlib/inventorygui/package-summary.html b/javadoc/redempt/redlib/inventorygui/package-summary.html index c8c663b..8810928 100644 --- a/javadoc/redempt/redlib/inventorygui/package-summary.html +++ b/javadoc/redempt/redlib/inventorygui/package-summary.html @@ -5,47 +5,30 @@ redempt.redlib.inventorygui (RedLib API) + + - + + - - - - - + + - - -
    +
    + +

    Package redempt.redlib.inventorygui

    -
    -
    -
    +
    + + +
    +
    + diff --git a/javadoc/redempt/redlib/inventorygui/package-tree.html b/javadoc/redempt/redlib/inventorygui/package-tree.html index ad90b79..7b40056 100644 --- a/javadoc/redempt/redlib/inventorygui/package-tree.html +++ b/javadoc/redempt/redlib/inventorygui/package-tree.html @@ -5,158 +5,91 @@ redempt.redlib.inventorygui Class Hierarchy (RedLib API) + + - + + - - - - - + + - - -
    +
    + +

    Hierarchy For Package redempt.redlib.inventorygui

    -Package Hierarchies: +Package Hierarchies:
    -
    -
    +

    Class Hierarchy

    -
    +
    +
    diff --git a/javadoc/redempt/redlib/itemutils/CustomItem.html b/javadoc/redempt/redlib/itemutils/CustomItem.html index d008976..54cdc56 100644 --- a/javadoc/redempt/redlib/itemutils/CustomItem.html +++ b/javadoc/redempt/redlib/itemutils/CustomItem.html @@ -5,392 +5,294 @@ CustomItem (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.itemutils
    -

    Class CustomItem

    +
    Package redempt.redlib.itemutils
    +

    Class CustomItem

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.itemutils.CustomItem
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      redempt.redlib.itemutils.CustomItem
      +
      +
      -
      public abstract class CustomItem
+
      public abstract class CustomItem
 extends java.lang.Object
      
 
      Represents a custom item with special behavior
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Constructor Summary

          - - +
        • +
          +

          Constructor Summary

          +
          +
          • Constructors 
          + + - - - + + + - - - - + + + + + +
          Constructors
          ModifierConstructorDescriptionModifierConstructorDescription
          protected CustomItem​(java.lang.String name) +
          protected CustomItem​(java.lang.String name)
          A constructor that should only be called by getAll(Plugin)
          -
          • -
        +
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      + - - - + + + - - - - + + + + + + - - - - + + + - - - - + + + + - - - - + + + + - - - - + + + + +
      Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
      protected booleancloneOnGet() 
      protected booleancloneOnGet() 
      static java.util.Map<java.lang.String,​CustomItem>getAll​(org.bukkit.plugin.Plugin plugin) +
      static java.util.Map<java.lang.String,​CustomItem>getAll​(org.bukkit.plugin.Plugin plugin)
      Gets an instance of every class which extends CustomItem in your plugin, and puts them in a map by name Note: Custom item classes MUST have a default constructor which takes no arguments to be loaded by this method
      abstract org.bukkit.inventory.ItemStackgetDefaultItem() 
      abstract org.bukkit.inventory.ItemStackgetDefaultItem() 
      org.bukkit.inventory.ItemStackgetItem() 
      org.bukkit.inventory.ItemStackgetItem() 
      java.lang.StringgetName() 
      java.lang.StringgetName() 
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

    Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - -
            -
          • -

            CustomItem

            -
            protected CustomItem​(java.lang.String name)
            +
          • +
            +

            Constructor Details

            +
              +
            • +
              +

              CustomItem

              +
              protected CustomItem​(java.lang.String name)
              A constructor that should only be called by getAll(Plugin)
              -
              -
              Parameters:
              +
              +
              Parameters:
              name - The name of the CustomItem - insert a constant when overriding this constructor, do not take it as a parameter of the overridden constructor
              -
              • -
            +
        + -
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            getAll

            -
            public static java.util.Map<java.lang.String,​CustomItem> getAll​(org.bukkit.plugin.Plugin plugin)
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              getAll

              +
              public static java.util.Map<java.lang.String,​CustomItem> getAll​(org.bukkit.plugin.Plugin plugin)
              Gets an instance of every class which extends CustomItem in your plugin, and puts them in a map by name Note: Custom item classes MUST have a default constructor which takes no arguments to be loaded by this method
              -
              -
              Parameters:
              +
              +
              Parameters:
              plugin - The plugin to get the custom items from
              -
              Returns:
              +
              Returns:
              A map of the custom items by name
              +
              • -
            - - - -
              -
            • -

              cloneOnGet

              -
              protected boolean cloneOnGet()
              -
              -
              Returns:
              +
            • +
              +

              cloneOnGet

              +
              protected boolean cloneOnGet()
              +
              +
              Returns:
              Whether the item should be cloned before being returned
              +
              • -
            - - - -
              -
            • -

              getDefaultItem

              -
              public abstract org.bukkit.inventory.ItemStack getDefaultItem()
              -
              -
              Returns:
              +
            • +
              +

              getDefaultItem

              +
              public abstract org.bukkit.inventory.ItemStack getDefaultItem()
              +
              +
              Returns:
              The default item for this CustomItem
              +
              • -
            - - - -
              -
            • -

              getName

              -
              public final java.lang.String getName()
              -
              -
              Returns:
              +
            • +
              +

              getName

              +
              public final java.lang.String getName()
              +
              +
              Returns:
              The name of this custom item
              +
              • -
            - - - -
              -
            • -

              getItem

              -
              public org.bukkit.inventory.ItemStack getItem()
              -
              -
              Returns:
              +
            • +
              +

              getItem

              +
              public org.bukkit.inventory.ItemStack getItem()
              +
              +
              Returns:
              The item
              -
              • -
            +
      -
    - - + + + + diff --git a/javadoc/redempt/redlib/itemutils/ItemBuilder.html b/javadoc/redempt/redlib/itemutils/ItemBuilder.html index 99cc272..4f131cd 100644 --- a/javadoc/redempt/redlib/itemutils/ItemBuilder.html +++ b/javadoc/redempt/redlib/itemutils/ItemBuilder.html @@ -5,727 +5,586 @@ ItemBuilder (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.itemutils
    -

    Class ItemBuilder

    +
    Package redempt.redlib.itemutils
    +

    Class ItemBuilder

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • org.bukkit.inventory.ItemStack
        • -
      • -
          -
        • redempt.redlib.itemutils.ItemBuilder
          • -
        -
        • -
      -
      • -
    -
    -
      -
    • -
      +
      java.lang.Object +
      org.bukkit.inventory.ItemStack +
      redempt.redlib.itemutils.ItemBuilder
      +
      +
      +
      +
      All Implemented Interfaces:
      java.lang.Cloneable, org.bukkit.configuration.serialization.ConfigurationSerializable
      -
      public class ItemBuilder
+
      public class ItemBuilder
 extends org.bukkit.inventory.ItemStack
      
 
      A utility class to easily create items
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Constructor Summary

          - - +
        • +
          +

          Constructor Summary

          +
          +
          • Constructors 
          + + - - + + - - - + + + + - - - + + - - - + + +
          Constructors
          ConstructorDescriptionConstructorDescription
          ItemBuilder​(org.bukkit.inventory.ItemStack item) +
          ItemBuilder​(org.bukkit.inventory.ItemStack item)
          Constructs an ItemBuilder using a pre-existing item
          ItemBuilder​(org.bukkit.Material material) +
          ItemBuilder​(org.bukkit.Material material)
          Constructs a new ItemBuilder.
          ItemBuilder​(org.bukkit.Material material, - int amount) +
          ItemBuilder​(org.bukkit.Material material, +int amount)
          Constructs a new ItemBuilder.
          -
          • -
        +
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Instance Methods Concrete Methods 
      + - - - + + + - - - - + + + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + +
      Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
      ItemBuilderaddAttribute​(org.bukkit.attribute.Attribute attribute, - double amount, - org.bukkit.attribute.AttributeModifier.Operation operation) +
      ItemBuilderaddAttribute​(org.bukkit.attribute.Attribute attribute, +double amount, +org.bukkit.attribute.AttributeModifier.Operation operation)
      Adds an attribute to this ItemBuilder
      ItemBuilderaddAttribute​(org.bukkit.attribute.Attribute attribute, - double amount, - org.bukkit.attribute.AttributeModifier.Operation operation, - org.bukkit.inventory.EquipmentSlot slot) +
      ItemBuilderaddAttribute​(org.bukkit.attribute.Attribute attribute, +double amount, +org.bukkit.attribute.AttributeModifier.Operation operation, +org.bukkit.inventory.EquipmentSlot slot)
      Adds an attribute to this ItemBuilder
      ItemBuilderaddAttribute​(org.bukkit.attribute.Attribute attribute, - org.bukkit.attribute.AttributeModifier modifier) +
      ItemBuilderaddAttribute​(org.bukkit.attribute.Attribute attribute, +org.bukkit.attribute.AttributeModifier modifier)
      Adds an attribute to this ItemBuilder
      ItemBuilderaddDamage​(int damage) +
      ItemBuilderaddDamage​(int damage)
      Adds damage to this ItemBuilder
      ItemBuilderaddEnchant​(org.bukkit.enchantments.Enchantment enchant, - int level) +
      ItemBuilderaddEnchant​(org.bukkit.enchantments.Enchantment enchant, +int level)
      Adds an enchantment to this ItemBuilder
      ItemBuilderaddItemFlags​(org.bukkit.inventory.ItemFlag... flags) +
      ItemBuilderaddItemFlags​(org.bukkit.inventory.ItemFlag... flags)
      Adds ItemFlags to this ItemBuilder
      ItemBuilderaddLore​(java.lang.Iterable<java.lang.String> lines) +
      ItemBuilderaddLore​(java.lang.Iterable<java.lang.String> lines)
      Add multiple lines of lore to this ItemBuilder
      ItemBuilderaddLore​(java.lang.String line) +
      ItemBuilderaddLore​(java.lang.String line)
      Add a line of lore to this ItemBuilder
      <T,​Z>
      ItemBuilder      		addPersistentTag​(org.bukkit.NamespacedKey key, - org.bukkit.persistence.PersistentDataType<T,​Z> type, - Z data) +
      <T,​ +Z> ItemBuilderaddPersistentTag​(org.bukkit.NamespacedKey key, +org.bukkit.persistence.PersistentDataType<T,​Z> type, +Z data)
      Add persistent tags to this ItemBuilder
      ItemBuildersetCount​(int amount) +
      ItemBuildersetCount​(int amount)
      Sets the stack size of this ItemBuilder
      ItemBuildersetCustomModelData​(int customModelData) +
      ItemBuildersetCustomModelData​(int customModelData)
      Sets the custom model data of this ItemBuilder
      ItemBuildersetDurability​(int durability) +
      ItemBuildersetDurability​(int durability)
      Set the durability (damage) of the ItemBuilder
      ItemBuildersetLore​(java.lang.String... lore) +
      ItemBuildersetLore​(java.lang.String... lore)
      Set the lore of this ItemBuilder
      ItemBuildersetName​(java.lang.String name) +
      ItemBuildersetName​(java.lang.String name)
      Renames this ItemBuilder
      ItemBuilderunbreakable() +
      ItemBuilderunbreakable()
      Sets this ItemBuilder to be unbreakable
      -
        -
      • - - -

        Methods inherited from class org.bukkit.inventory.ItemStack

        -addEnchantment, addEnchantments, addUnsafeEnchantment, addUnsafeEnchantments, clone, containsEnchantment, deserialize, equals, getAmount, getData, getDurability, getEnchantmentLevel, getEnchantments, getItemMeta, getMaxStackSize, getType, hashCode, hasItemMeta, isSimilar, removeEnchantment, serialize, setAmount, setData, setDurability, setItemMeta, setType, toString
        • -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

    Methods inherited from class org.bukkit.inventory.ItemStack

    +addEnchantment, addEnchantments, addUnsafeEnchantment, addUnsafeEnchantments, clone, containsEnchantment, deserialize, equals, getAmount, getData, getDurability, getEnchantmentLevel, getEnchantments, getItemMeta, getMaxStackSize, getType, hashCode, hasItemMeta, isSimilar, removeEnchantment, serialize, setAmount, setData, setDurability, setItemMeta, setType, toString
    +
    +

    Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - -
            -
          • -

            ItemBuilder

            -
            public ItemBuilder​(org.bukkit.Material material,
-                   int amount)
            +
          • +
            +

            Constructor Details

            +
              +
            • +
              +

              ItemBuilder

              +
              public ItemBuilder​(org.bukkit.Material material, +int amount)
              Constructs a new ItemBuilder. An ItemBuilder extends ItemStack, an can be used as such.
              -
              -
              Parameters:
              +
              +
              Parameters:
              material - The type of the item
              amount - The amount of the item
              +
              • -
            - - - -
              -
            • -

              ItemBuilder

              -
              public ItemBuilder​(org.bukkit.Material material)
              +
            • +
              +

              ItemBuilder

              +
              public ItemBuilder​(org.bukkit.Material material)
              Constructs a new ItemBuilder. An ItemBuilder extends ItemStack, an can be used as such.
              -
              -
              Parameters:
              +
              +
              Parameters:
              material - The type of the item
              +
              • -
            - - - -
              -
            • -

              ItemBuilder

              -
              public ItemBuilder​(org.bukkit.inventory.ItemStack item)
              +
            • +
              +

              ItemBuilder

              +
              public ItemBuilder​(org.bukkit.inventory.ItemStack item)
              Constructs an ItemBuilder using a pre-existing item
              -
              -
              Parameters:
              +
              +
              Parameters:
              item - The item to copy
              -
              • -
            +
        + -
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            setCount

            -
            public ItemBuilder setCount​(int amount)
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              setCount

              +
              public ItemBuilder setCount​(int amount)
              Sets the stack size of this ItemBuilder
              -
              -
              Parameters:
              +
              +
              Parameters:
              amount - The number of items in the stack
              -
              Returns:
              +
              Returns:
              The ItemBuilder with the new stack size
              +
              • -
            - - - -
              -
            • -

              addEnchant

              -
              public ItemBuilder addEnchant​(org.bukkit.enchantments.Enchantment enchant,
-                              int level)
              +
            • +
              +

              addEnchant

              +
              public ItemBuilder addEnchant​(org.bukkit.enchantments.Enchantment enchant, +int level)
              Adds an enchantment to this ItemBuilder
              -
              -
              Parameters:
              +
              +
              Parameters:
              enchant - The enchantment to add
              level - The level of the enchantment
              -
              Returns:
              +
              Returns:
              The enchanted ItemBuilder
              +
              • -
            - - - -
              -
            • -

              setLore

              -
              public ItemBuilder setLore​(java.lang.String... lore)
              +
            • +
              +

              setLore

              +
              public ItemBuilder setLore​(java.lang.String... lore)
              Set the lore of this ItemBuilder
              -
              -
              Parameters:
              +
              +
              Parameters:
              lore - The lines of lore
              -
              Returns:
              +
              Returns:
              The ItemBuilder with lore added
              +
              • -
            - - - -
              -
            • -

              addLore

              -
              public ItemBuilder addLore​(java.lang.String line)
              +
            • +
              +

              addLore

              +
              public ItemBuilder addLore​(java.lang.String line)
              Add a line of lore to this ItemBuilder
              -
              -
              Parameters:
              +
              +
              Parameters:
              line - The line of lore
              -
              Returns:
              +
              Returns:
              The ItemBuilder with lore added
              +
              • -
            - - - -
              -
            • -

              addLore

              -
              public ItemBuilder addLore​(java.lang.Iterable<java.lang.String> lines)
              +
            • +
              +

              addLore

              +
              public ItemBuilder addLore​(java.lang.Iterable<java.lang.String> lines)
              Add multiple lines of lore to this ItemBuilder
              -
              -
              Parameters:
              +
              +
              Parameters:
              lines - The lines of lore
              -
              Returns:
              +
              Returns:
              The ItemBuilder with lore added
              +
              • -
            - - - -
              -
            • -

              setName

              -
              public ItemBuilder setName​(java.lang.String name)
              +
            • +
              +

              setName

              +
              public ItemBuilder setName​(java.lang.String name)
              Renames this ItemBuilder
              -
              -
              Parameters:
              +
              +
              Parameters:
              name - The name to set
              -
              Returns:
              +
              Returns:
              The renamed ItemBuilder
              +
              • -
            - - - -
              -
            • -

              setDurability

              -
              public ItemBuilder setDurability​(int durability)
              +
            • +
              +

              setDurability

              +
              public ItemBuilder setDurability​(int durability)
              Set the durability (damage) of the ItemBuilder
              -
              -
              Parameters:
              +
              +
              Parameters:
              durability - The durability to set
              -
              Returns:
              +
              Returns:
              The ItemBuilder with its durability changed
              +
              • -
            - - - -
              -
            • -

              addAttribute

              -
              public ItemBuilder addAttribute​(org.bukkit.attribute.Attribute attribute,
-                                org.bukkit.attribute.AttributeModifier modifier)
              +
            • +
              +

              addAttribute

              +
              public ItemBuilder addAttribute​(org.bukkit.attribute.Attribute attribute, +org.bukkit.attribute.AttributeModifier modifier)
              Adds an attribute to this ItemBuilder
              -
              -
              Parameters:
              +
              +
              Parameters:
              attribute - The Attribute to be added
              modifier - The AttributeModifier to be added
              -
              Returns:
              +
              Returns:
              The ItemBuilder with the attribute added
              +
              • -
            - - - -
              -
            • -

              addAttribute

              -
              public ItemBuilder addAttribute​(org.bukkit.attribute.Attribute attribute,
-                                double amount,
-                                org.bukkit.attribute.AttributeModifier.Operation operation)
              +
            • +
              +

              addAttribute

              +
              public ItemBuilder addAttribute​(org.bukkit.attribute.Attribute attribute, +double amount, +org.bukkit.attribute.AttributeModifier.Operation operation)
              Adds an attribute to this ItemBuilder
              -
              -
              Parameters:
              +
              +
              Parameters:
              attribute - The attribute to be added
              amount - The amount of the modifier
              operation - The operation of the modifier
              -
              Returns:
              +
              Returns:
              The ItemBuilder with the attribute added
              +
              • -
            - - - -
              -
            • -

              addAttribute

              -
              public ItemBuilder addAttribute​(org.bukkit.attribute.Attribute attribute,
-                                double amount,
-                                org.bukkit.attribute.AttributeModifier.Operation operation,
-                                org.bukkit.inventory.EquipmentSlot slot)
              +
            • +
              +

              addAttribute

              +
              public ItemBuilder addAttribute​(org.bukkit.attribute.Attribute attribute, +double amount, +org.bukkit.attribute.AttributeModifier.Operation operation, +org.bukkit.inventory.EquipmentSlot slot)
              Adds an attribute to this ItemBuilder
              -
              -
              Parameters:
              +
              +
              Parameters:
              attribute - The attribute to be added
              amount - The amount of the modifier
              operation - The operation of the modifier
              slot - The slot the modifier affects
              -
              Returns:
              +
              Returns:
              The ItemBuilder with the attribute added
              +
              • -
            - - - -
              -
            • -

              addItemFlags

              -
              public ItemBuilder addItemFlags​(org.bukkit.inventory.ItemFlag... flags)
              +
            • +
              +

              addItemFlags

              +
              public ItemBuilder addItemFlags​(org.bukkit.inventory.ItemFlag... flags)
              Adds ItemFlags to this ItemBuilder
              -
              -
              Parameters:
              +
              +
              Parameters:
              flags - The ItemFlags to add
              -
              Returns:
              +
              Returns:
              The ItemBuilder with the flags added
              +
              • -
            - - - -
              -
            • -

              addDamage

              -
              public ItemBuilder addDamage​(int damage)
              +
            • +
              +

              addDamage

              +
              public ItemBuilder addDamage​(int damage)
              Adds damage to this ItemBuilder
              -
              -
              Parameters:
              +
              +
              Parameters:
              damage - The amount of damage to apply
              -
              Returns:
              +
              Returns:
              The ItemBuilder with the damage applied
              +
              • -
            - - - -
              -
            • -

              setCustomModelData

              -
              public ItemBuilder setCustomModelData​(int customModelData)
              +
            • +
              +

              setCustomModelData

              +
              public ItemBuilder setCustomModelData​(int customModelData)
              Sets the custom model data of this ItemBuilder
              -
              -
              Parameters:
              +
              +
              Parameters:
              customModelData - The custom model data to set
              -
              Returns:
              +
              Returns:
              The ItemBuilder with the custom model data set
              +
              • -
            - - - - - -
              -
            • -

              addPersistentTag

              -
              public <T,​Z> ItemBuilder addPersistentTag​(org.bukkit.NamespacedKey key,
-                                                org.bukkit.persistence.PersistentDataType<T,​Z> type,
-                                                Z data)
              +
            • +
              +

              addPersistentTag

              +
              public <T,​ +Z> ItemBuilder addPersistentTag​(org.bukkit.NamespacedKey key, +org.bukkit.persistence.PersistentDataType<T,​Z> type, +Z data)
              Add persistent tags to this ItemBuilder
              -
              -
              Type Parameters:
              +
              +
              Type Parameters:
              T - The primary object type
              Z - The retrieved object type
              -
              Parameters:
              +
              Parameters:
              key - The key to add the data under
              type - The type of the data
              data - The data to store
              -
              Returns:
              +
              Returns:
              The ItemBuilder with the persistent data added
              +
              • -
            - - - -
              -
            • -

              unbreakable

              -
              public ItemBuilder unbreakable()
              +
            • +
              +

              unbreakable

              +
              public ItemBuilder unbreakable()
              Sets this ItemBuilder to be unbreakable
              -
              -
              Returns:
              +
              +
              Returns:
              The ItemBuilder with the unbreakable tag added
              -
              • -
            +
      -
    - - + + + + diff --git a/javadoc/redempt/redlib/itemutils/ItemTrait.html b/javadoc/redempt/redlib/itemutils/ItemTrait.html index 83f7a6e..44a5389 100644 --- a/javadoc/redempt/redlib/itemutils/ItemTrait.html +++ b/javadoc/redempt/redlib/itemutils/ItemTrait.html @@ -5,468 +5,358 @@ ItemTrait (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.itemutils
    -

    Enum ItemTrait

    +
    Package redempt.redlib.itemutils
    +

    Enum ItemTrait

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • java.lang.Enum<ItemTrait>
        • -
      • -
          -
        • redempt.redlib.itemutils.ItemTrait
          • -
        -
        • -
      -
      • -
    -
    -
      -
    • -
      +
      java.lang.Object +
      java.lang.Enum<ItemTrait> +
      redempt.redlib.itemutils.ItemTrait
      +
      +
      +
      +
      All Implemented Interfaces:
      -
      java.io.Serializable, java.lang.Comparable<ItemTrait>
      +
      java.io.Serializable, java.lang.Comparable<ItemTrait>, java.lang.constant.Constable
      -
      public enum ItemTrait
+
      public enum ItemTrait
 extends java.lang.Enum<ItemTrait>
      
 
      A set of comparable traits items have and can be compared with ItemUtils.compare(ItemStack, ItemStack, ItemTrait...)
      
+
      +
      +
        + +
      • +
        +

        Nested Class Summary

        +
        +

        Nested classes/interfaces inherited from class java.lang.Enum

        +java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>
        +
        • -
      -
    -
    -
      -
    • -
      -
        -
      • - - -

        Enum Constant Summary

        - - +
      • +
        +

        Enum Constant Summary

        +
        +
        • Enum Constants 
        + + - - + + - - - + + + + - - - + + - - - + + - - - + + - - - + + - - - + + +
        Enum Constants
        Enum ConstantDescriptionEnum ConstantDescription
        AMOUNT +
        AMOUNT
        For comparing the amount of two items
        DURABILITY +
        DURABILITY
        For comparing the durability of two items
        ENCHANTMENTS +
        ENCHANTMENTS
        For comparing the enchantments of two items
        LORE +
        LORE
        For comparing the lore of two items
        NAME +
        NAME
        For comparing the display name of two items
        TYPE +
        TYPE
        For comparing the types of two items
        -
        • -
      +
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Static Methods Instance Methods Concrete Methods 
      + - - - + + + - - - - + + + + + - - - - + + + - - - - + + + +
      Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
      booleancompare​(org.bukkit.inventory.ItemStack a, - org.bukkit.inventory.ItemStack b) +
      booleancompare​(org.bukkit.inventory.ItemStack a, +org.bukkit.inventory.ItemStack b)
      Compares this trait on the two items
      static ItemTraitvalueOf​(java.lang.String name) +
      static ItemTraitvalueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static ItemTrait[]values() +
      static ItemTrait[]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
        • -
      -
      • -
    +
    +
    +
    +

    Methods inherited from class java.lang.Enum

    +clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
    +
    +

    Methods inherited from class java.lang.Object

    +getClass, notify, notifyAll, wait, wait, wait
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Enum Constant Detail

          - - - -
            -
          • -

            DURABILITY

            -
            public static final ItemTrait DURABILITY
            +
          • +
            +

            Enum Constant Details

            +
              +
            • +
              +

              DURABILITY

              +
              public static final ItemTrait DURABILITY
              For comparing the durability of two items
              +
              • -
            - - - -
              -
            • -

              AMOUNT

              -
              public static final ItemTrait AMOUNT
              +
            • +
              +

              AMOUNT

              +
              public static final ItemTrait AMOUNT
              For comparing the amount of two items
              +
              • -
            - - - -
              -
            • -

              NAME

              -
              public static final ItemTrait NAME
              +
            • +
              +

              NAME

              +
              public static final ItemTrait NAME
              For comparing the display name of two items
              +
              • -
            - - - -
              -
            • -

              LORE

              -
              public static final ItemTrait LORE
              +
            • +
              +

              LORE

              +
              public static final ItemTrait LORE
              For comparing the lore of two items
              +
              • -
            - - - -
              -
            • -

              ENCHANTMENTS

              -
              public static final ItemTrait ENCHANTMENTS
              +
            • +
              +

              ENCHANTMENTS

              +
              public static final ItemTrait ENCHANTMENTS
              For comparing the enchantments of two items
              +
              • -
            - - - -
              -
            • -

              TYPE

              -
              public static final ItemTrait TYPE
              +
            • +
              +

              TYPE

              +
              public static final ItemTrait TYPE
              For comparing the types of two items
              -
              • -
            +
        + -
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            values

            -
            public static ItemTrait[] values()
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              values

              +
              public static ItemTrait[] 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 (ItemTrait c : ItemTrait.values())
-    System.out.println(c);
-
              -
              -
              Returns:
              +the order they are declared.
    +
    +
    Returns:
    an array containing the constants of this enum type, in the order they are declared
    + - - - - -
      -
    • -

      valueOf

      -
      public static ItemTrait valueOf​(java.lang.String name)
      +
    • +
      +

      valueOf

      +
      public static ItemTrait 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:
      +
      +
      Parameters:
      name - the name of the enum constant to be returned.
      -
      Returns:
      +
      Returns:
      the enum constant with the specified name
      -
      Throws:
      +
      Throws:
      java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
      java.lang.NullPointerException - if the argument is null
      +
      • -
    - - - -
      -
    • -

      compare

      -
      public boolean compare​(org.bukkit.inventory.ItemStack a,
-                       org.bukkit.inventory.ItemStack b)
      +
    • +
      +

      compare

      +
      public boolean compare​(org.bukkit.inventory.ItemStack a, +org.bukkit.inventory.ItemStack b)
      Compares this trait on the two items
      -
      -
      Parameters:
      +
      +
      Parameters:
      a - The first item
      b - The second item
      -
      Returns:
      +
      Returns:
      True if the trait is the same on both items, false otherwise
      -
      • -
    + - - - + + + + diff --git a/javadoc/redempt/redlib/itemutils/ItemUtils.html b/javadoc/redempt/redlib/itemutils/ItemUtils.html index b1a5c25..a488041 100644 --- a/javadoc/redempt/redlib/itemutils/ItemUtils.html +++ b/javadoc/redempt/redlib/itemutils/ItemUtils.html @@ -5,1249 +5,1061 @@ ItemUtils (RedLib API) + + - + + - - - - - + + - - -
    +
    +
    + + + +
    - +
    +
    -
    Package redempt.redlib.itemutils
    -

    Class ItemUtils

    +
    Package redempt.redlib.itemutils
    +

    Class ItemUtils

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.itemutils.ItemUtils
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      redempt.redlib.itemutils.ItemUtils
      +
      +
      -
      public class ItemUtils
+
      public class ItemUtils
 extends java.lang.Object
      
 
      A utility class to easily modify items
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Constructor Summary

          - - +
        • +
          +

          Constructor Summary

          +
          +
          • Constructors 
          + + - - + + - - - + + + + + +
          Constructors
          ConstructorDescriptionConstructorDescription
          ItemUtils() 
          ItemUtils() 
          -
          • -
        +
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Static Methods Concrete Methods 
      + - - - + + + - - - - + + + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + +
      Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
      static org.bukkit.inventory.ItemStackaddAttribute​(org.bukkit.inventory.ItemStack item, - org.bukkit.attribute.Attribute attribute, - double amount, - org.bukkit.attribute.AttributeModifier.Operation operation) +
      static org.bukkit.inventory.ItemStackaddAttribute​(org.bukkit.inventory.ItemStack item, +org.bukkit.attribute.Attribute attribute, +double amount, +org.bukkit.attribute.AttributeModifier.Operation operation)
      Add an attribute to the item
      static org.bukkit.inventory.ItemStackaddAttribute​(org.bukkit.inventory.ItemStack item, - org.bukkit.attribute.Attribute attribute, - double amount, - org.bukkit.attribute.AttributeModifier.Operation operation, - org.bukkit.inventory.EquipmentSlot slot) +
      static org.bukkit.inventory.ItemStackaddAttribute​(org.bukkit.inventory.ItemStack item, +org.bukkit.attribute.Attribute attribute, +double amount, +org.bukkit.attribute.AttributeModifier.Operation operation, +org.bukkit.inventory.EquipmentSlot slot)
      Add an attribute to the item
      static org.bukkit.inventory.ItemStackaddAttribute​(org.bukkit.inventory.ItemStack item, - org.bukkit.attribute.Attribute attribute, - org.bukkit.attribute.AttributeModifier modifier) +
      static org.bukkit.inventory.ItemStackaddAttribute​(org.bukkit.inventory.ItemStack item, +org.bukkit.attribute.Attribute attribute, +org.bukkit.attribute.AttributeModifier modifier)
      Add an attribute to the item
      static org.bukkit.inventory.ItemStackaddEnchant​(org.bukkit.inventory.ItemStack item, - org.bukkit.enchantments.Enchantment enchant, - int level) +
      static org.bukkit.inventory.ItemStackaddEnchant​(org.bukkit.inventory.ItemStack item, +org.bukkit.enchantments.Enchantment enchant, +int level)
      Add an enchantment to an ItemStack
      static org.bukkit.inventory.ItemStackaddItemFlags​(org.bukkit.inventory.ItemStack item, - org.bukkit.inventory.ItemFlag... flags) +
      static org.bukkit.inventory.ItemStackaddItemFlags​(org.bukkit.inventory.ItemStack item, +org.bukkit.inventory.ItemFlag... flags)
      Adds ItemFlags to the item
      static org.bukkit.inventory.ItemStackaddLore​(org.bukkit.inventory.ItemStack item, - java.lang.Iterable<java.lang.String> lines) +
      static org.bukkit.inventory.ItemStackaddLore​(org.bukkit.inventory.ItemStack item, +java.lang.Iterable<java.lang.String> lines)
      Adds multiple lines of lore to an ItemStack
      static org.bukkit.inventory.ItemStackaddLore​(org.bukkit.inventory.ItemStack item, - java.lang.String line) +
      static org.bukkit.inventory.ItemStackaddLore​(org.bukkit.inventory.ItemStack item, +java.lang.String line)
      Add a line of lore to an ItemStack
      static <T,​Z>
      org.bukkit.inventory.ItemStack      		addPersistentTag​(org.bukkit.inventory.ItemStack item, - org.bukkit.NamespacedKey key, - org.bukkit.persistence.PersistentDataType<T,​Z> type, - Z data) +
      static <T,​ +Z> org.bukkit.inventory.ItemStackaddPersistentTag​(org.bukkit.inventory.ItemStack item, +org.bukkit.NamespacedKey key, +org.bukkit.persistence.PersistentDataType<T,​Z> type, +Z data)
      Adds persistent data to the item
      static org.bukkit.inventory.InventorycloneInventory​(org.bukkit.inventory.Inventory inv) +
      static org.bukkit.inventory.InventorycloneInventory​(org.bukkit.inventory.Inventory inv)
      Creates a mock inventory clone of the given inventory.
      static booleancompare​(org.bukkit.inventory.ItemStack first, - org.bukkit.inventory.ItemStack second) +
      static booleancompare​(org.bukkit.inventory.ItemStack first, +org.bukkit.inventory.ItemStack second)
      Compares the type, name, and lore of two items
      static booleancompare​(org.bukkit.inventory.ItemStack first, - org.bukkit.inventory.ItemStack second, - ItemTrait... traits) +
      static booleancompare​(org.bukkit.inventory.ItemStack first, +org.bukkit.inventory.ItemStack second, +ItemTrait... traits)
      Compares the traits of two items
      static intcount​(org.bukkit.inventory.Inventory inv, - org.bukkit.inventory.ItemStack item) +
      static intcount​(org.bukkit.inventory.Inventory inv, +org.bukkit.inventory.ItemStack item)
      Counts the number of the given item in the given inventory
      static intcount​(org.bukkit.inventory.Inventory inv, - org.bukkit.inventory.ItemStack item, - java.util.function.BiPredicate<org.bukkit.inventory.ItemStack,​org.bukkit.inventory.ItemStack> comparison) +
      static intcount​(org.bukkit.inventory.Inventory inv, +org.bukkit.inventory.ItemStack item, +java.util.function.BiPredicate<org.bukkit.inventory.ItemStack,​org.bukkit.inventory.ItemStack> comparison)
      Counts the number of the given item in the given inventory
      static intcount​(org.bukkit.inventory.Inventory inv, - org.bukkit.Material type) +
      static intcount​(org.bukkit.inventory.Inventory inv, +org.bukkit.Material type)
      Counts the number of items of the given type in the given inventory
      static intcountAndRemove​(org.bukkit.inventory.Inventory inv, - org.bukkit.inventory.ItemStack item) +
      static intcountAndRemove​(org.bukkit.inventory.Inventory inv, +org.bukkit.inventory.ItemStack item)
      Remove all matching items, returning the number that were removed
      static intcountAndRemove​(org.bukkit.inventory.Inventory inv, - org.bukkit.inventory.ItemStack item, - int max) +
      static intcountAndRemove​(org.bukkit.inventory.Inventory inv, +org.bukkit.inventory.ItemStack item, +int max)
      Remove all matching items up to a maximum, returning the number that were removed
      static intcountAndRemove​(org.bukkit.inventory.Inventory inv, - org.bukkit.inventory.ItemStack item, - int max, - java.util.function.BiPredicate<org.bukkit.inventory.ItemStack,​org.bukkit.inventory.ItemStack> comparison) +
      static intcountAndRemove​(org.bukkit.inventory.Inventory inv, +org.bukkit.inventory.ItemStack item, +int max, +java.util.function.BiPredicate<org.bukkit.inventory.ItemStack,​org.bukkit.inventory.ItemStack> comparison)
      Remove all matching items up to a maximum, returning the number that were removed
      static intcountAndRemove​(org.bukkit.inventory.Inventory inv, - org.bukkit.Material type) +
      static intcountAndRemove​(org.bukkit.inventory.Inventory inv, +org.bukkit.Material type)
      Remove all items of a specified type, returning the number that were removed
      static intcountAndRemove​(org.bukkit.inventory.Inventory inv, - org.bukkit.Material type, - int max) +
      static intcountAndRemove​(org.bukkit.inventory.Inventory inv, +org.bukkit.Material type, +int max)
      Remove all matching items up to a maximum, returning the number that were removed
      static org.bukkit.inventory.ItemStackdamage​(org.bukkit.inventory.ItemStack item, - int amount) +
      static org.bukkit.inventory.ItemStackdamage​(org.bukkit.inventory.ItemStack item, +int amount)
      Damages an item
      static org.bukkit.inventory.ItemStackfromString​(java.lang.String json) +
      static org.bukkit.inventory.ItemStackfromString​(java.lang.String json)
      Constructs an ItemStack from a previously-serialized JSON string
      static voidgive​(org.bukkit.entity.Player player, - org.bukkit.inventory.ItemStack... items) +
      static voidgive​(org.bukkit.entity.Player player, +org.bukkit.inventory.ItemStack... items)
      Give the player the specified items, dropping them on the ground if there is not enough room
      static voidgive​(org.bukkit.entity.Player player, - org.bukkit.inventory.ItemStack item, - int amount) +
      static voidgive​(org.bukkit.entity.Player player, +org.bukkit.inventory.ItemStack item, +int amount)
      Gives the player the specified amount of the specified item, dropping them on the ground if there is not enough room
      static voidgive​(org.bukkit.entity.Player player, - org.bukkit.Material type, - int amount) +
      static voidgive​(org.bukkit.entity.Player player, +org.bukkit.Material type, +int amount)
      Gives the player the specified amount of the specified item type, dropping them on the ground if there is not enough room
      static booleanremove​(org.bukkit.inventory.Inventory inv, - org.bukkit.inventory.ItemStack item, - int amount) +
      static booleanremove​(org.bukkit.inventory.Inventory inv, +org.bukkit.inventory.ItemStack item, +int amount)
      Removes the specified amount of the given item from the given inventory
      static booleanremove​(org.bukkit.inventory.Inventory inv, - org.bukkit.inventory.ItemStack item, - int amount, - java.util.function.BiPredicate<org.bukkit.inventory.ItemStack,​org.bukkit.inventory.ItemStack> comparison) +
      static booleanremove​(org.bukkit.inventory.Inventory inv, +org.bukkit.inventory.ItemStack item, +int amount, +java.util.function.BiPredicate<org.bukkit.inventory.ItemStack,​org.bukkit.inventory.ItemStack> comparison)
      Removes the specified amount of the given item from the given inventory
      static booleanremove​(org.bukkit.inventory.Inventory inv, - org.bukkit.Material type, - int amount) +
      static booleanremove​(org.bukkit.inventory.Inventory inv, +org.bukkit.Material type, +int amount)
      Removes the specified amount of the given item type from the given inventory
      static org.bukkit.inventory.ItemStackrename​(org.bukkit.inventory.ItemStack item, - java.lang.String name) +
      static org.bukkit.inventory.ItemStackrename​(org.bukkit.inventory.ItemStack item, +java.lang.String name)
      Renames an ItemStack, functionally identical to setName(ItemStack, String) but kept for legacy reasons
      static org.bukkit.inventory.ItemStacksetCustomModelData​(org.bukkit.inventory.ItemStack item, - int customModelData) +
      static org.bukkit.inventory.ItemStacksetCustomModelData​(org.bukkit.inventory.ItemStack item, +int customModelData)
      Sets the custom model data of the item
      static org.bukkit.inventory.ItemStacksetLore​(org.bukkit.inventory.ItemStack item, - java.lang.String line) +
      static org.bukkit.inventory.ItemStacksetLore​(org.bukkit.inventory.ItemStack item, +java.lang.String line)
      Set a single line of lore for an ItemStack
      static org.bukkit.inventory.ItemStacksetLore​(org.bukkit.inventory.ItemStack item, - java.lang.String... lore) +
      static org.bukkit.inventory.ItemStacksetLore​(org.bukkit.inventory.ItemStack item, +java.lang.String... lore)
      Set multiple lines of lore for an ItemStack
      static org.bukkit.inventory.ItemStacksetLore​(org.bukkit.inventory.ItemStack item, - java.util.List<java.lang.String> lore) +
      static org.bukkit.inventory.ItemStacksetLore​(org.bukkit.inventory.ItemStack item, +java.util.List<java.lang.String> lore)
      Set multiple lines of lore for an ItemStack
      static org.bukkit.inventory.ItemStacksetName​(org.bukkit.inventory.ItemStack item, - java.lang.String name) +
      static org.bukkit.inventory.ItemStacksetName​(org.bukkit.inventory.ItemStack item, +java.lang.String name)
      Renames an ItemStack
      static org.bukkit.inventory.ItemStacksetUnbreakable​(org.bukkit.inventory.ItemStack item) +
      static org.bukkit.inventory.ItemStacksetUnbreakable​(org.bukkit.inventory.ItemStack item)
      Sets an item to be unbreakable
      static java.lang.StringtoString​(org.bukkit.inventory.ItemStack item) +
      static java.lang.StringtoString​(org.bukkit.inventory.ItemStack item)
      Converts an ItemStack to a JSON string
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

    Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - -
            -
          • -

            ItemUtils

            -
            public ItemUtils()
            -
            • -
          +
        • +
          +

          Constructor Details

          +
            +
          • +
            +

            ItemUtils

            +
            public ItemUtils()
            +
          +
          • -
          -
            -
          • - - -

            Method Detail

            - - - -
              -
            • -

              rename

              -
              public static org.bukkit.inventory.ItemStack rename​(org.bukkit.inventory.ItemStack item,
-                                                    java.lang.String name)
              +
            • +
              +

              Method Details

              +
                +
              • +
                +

                rename

                +
                public static org.bukkit.inventory.ItemStack rename​(org.bukkit.inventory.ItemStack item, +java.lang.String name)
                Renames an ItemStack, functionally identical to setName(ItemStack, String) but kept for legacy reasons
                -
                -
                Parameters:
                +
                +
                Parameters:
                item - The ItemStack to be renamed
                name - The name to give the ItemStack
                -
                Returns:
                +
                Returns:
                The renamed ItemStack
                +
                • -
              - - - -
                -
              • -

                setName

                -
                public static org.bukkit.inventory.ItemStack setName​(org.bukkit.inventory.ItemStack item,
-                                                     java.lang.String name)
                +
              • +
                +

                setName

                +
                public static org.bukkit.inventory.ItemStack setName​(org.bukkit.inventory.ItemStack item, +java.lang.String name)
                Renames an ItemStack
                -
                -
                Parameters:
                +
                +
                Parameters:
                item - The ItemStack to be renamed
                name - The name to give the ItemStack
                -
                Returns:
                +
                Returns:
                The renamed ItemStack
                +
                • -
              - - - -
                -
              • -

                setLore

                -
                public static org.bukkit.inventory.ItemStack setLore​(org.bukkit.inventory.ItemStack item,
-                                                     java.lang.String line)
                +
              • +
                +

                setLore

                +
                public static org.bukkit.inventory.ItemStack setLore​(org.bukkit.inventory.ItemStack item, +java.lang.String line)
                Set a single line of lore for an ItemStack
                -
                -
                Parameters:
                +
                +
                Parameters:
                item - The ItemStack to be given lore
                line - The line of lore to be given
                -
                Returns:
                +
                Returns:
                The modified ItemStack
                +
                • -
              - - - -
                -
              • -

                setLore

                -
                public static org.bukkit.inventory.ItemStack setLore​(org.bukkit.inventory.ItemStack item,
-                                                     java.util.List<java.lang.String> lore)
                +
              • +
                +

                setLore

                +
                public static org.bukkit.inventory.ItemStack setLore​(org.bukkit.inventory.ItemStack item, +java.util.List<java.lang.String> lore)
                Set multiple lines of lore for an ItemStack
                -
                -
                Parameters:
                +
                +
                Parameters:
                item - The ItemStack to be given lore
                lore - The lines of lore to be given
                -
                Returns:
                +
                Returns:
                The modified ItemStack
                +
                • -
              - - - -
                -
              • -

                addLore

                -
                public static org.bukkit.inventory.ItemStack addLore​(org.bukkit.inventory.ItemStack item,
-                                                     java.lang.String line)
                +
              • +
                +

                addLore

                +
                public static org.bukkit.inventory.ItemStack addLore​(org.bukkit.inventory.ItemStack item, +java.lang.String line)
                Add a line of lore to an ItemStack
                -
                -
                Parameters:
                +
                +
                Parameters:
                item - The ItemStack to be given lore
                line - The line of lore to add
                -
                Returns:
                +
                Returns:
                The modified ItemStack
                +
                • -
              - - - -
                -
              • -

                addLore

                -
                public static org.bukkit.inventory.ItemStack addLore​(org.bukkit.inventory.ItemStack item,
-                                                     java.lang.Iterable<java.lang.String> lines)
                +
              • +
                +

                addLore

                +
                public static org.bukkit.inventory.ItemStack addLore​(org.bukkit.inventory.ItemStack item, +java.lang.Iterable<java.lang.String> lines)
                Adds multiple lines of lore to an ItemStack
                -
                -
                Parameters:
                +
                +
                Parameters:
                item - The ItemStack to be given lore
                lines - The lines or lore to add
                -
                Returns:
                +
                Returns:
                The modified ItemStack
                +
                • -
              - - - -
                -
              • -

                setLore

                -
                public static org.bukkit.inventory.ItemStack setLore​(org.bukkit.inventory.ItemStack item,
-                                                     java.lang.String... lore)
                +
              • +
                +

                setLore

                +
                public static org.bukkit.inventory.ItemStack setLore​(org.bukkit.inventory.ItemStack item, +java.lang.String... lore)
                Set multiple lines of lore for an ItemStack
                -
                -
                Parameters:
                +
                +
                Parameters:
                item - The ItemStack to be given lore
                lore - The lines of lore to be given
                -
                Returns:
                +
                Returns:
                The modified ItemStack
                +
                • -
              - - - -
                -
              • -

                setUnbreakable

                -
                public static org.bukkit.inventory.ItemStack setUnbreakable​(org.bukkit.inventory.ItemStack item)
                +
              • +
                +

                setUnbreakable

                +
                public static org.bukkit.inventory.ItemStack setUnbreakable​(org.bukkit.inventory.ItemStack item)
                Sets an item to be unbreakable
                -
                -
                Parameters:
                +
                +
                Parameters:
                item - The item to make unbreakable
                -
                Returns:
                +
                Returns:
                The unbreakable item
                +
                • -
              - - - -
                -
              • -

                addEnchant

                -
                public static org.bukkit.inventory.ItemStack addEnchant​(org.bukkit.inventory.ItemStack item,
-                                                        org.bukkit.enchantments.Enchantment enchant,
-                                                        int level)
                +
              • +
                +

                addEnchant

                +
                public static org.bukkit.inventory.ItemStack addEnchant​(org.bukkit.inventory.ItemStack item, +org.bukkit.enchantments.Enchantment enchant, +int level)
                Add an enchantment to an ItemStack
                -
                -
                Parameters:
                +
                +
                Parameters:
                item - The ItemStack to be enchanted
                enchant - The Enchantment to add to the ItemStack
                level - The level of the Enchantment
                -
                Returns:
                +
                Returns:
                The enchanted ItemStack
                +
                • -
              - - - -
                -
              • -

                addAttribute

                -
                public static org.bukkit.inventory.ItemStack addAttribute​(org.bukkit.inventory.ItemStack item,
-                                                          org.bukkit.attribute.Attribute attribute,
-                                                          org.bukkit.attribute.AttributeModifier modifier)
                +
              • +
                +

                addAttribute

                +
                public static org.bukkit.inventory.ItemStack addAttribute​(org.bukkit.inventory.ItemStack item, +org.bukkit.attribute.Attribute attribute, +org.bukkit.attribute.AttributeModifier modifier)
                Add an attribute to the item
                -
                -
                Parameters:
                +
                +
                Parameters:
                item - The item to have an attribute added
                attribute - The Attribute to be added
                modifier - The AttributeModifier to be added
                -
                Returns:
                +
                Returns:
                The modified ItemStack
                +
                • -
              - - - -
                -
              • -

                addAttribute

                -
                public static org.bukkit.inventory.ItemStack addAttribute​(org.bukkit.inventory.ItemStack item,
-                                                          org.bukkit.attribute.Attribute attribute,
-                                                          double amount,
-                                                          org.bukkit.attribute.AttributeModifier.Operation operation)
                +
              • +
                +

                addAttribute

                +
                public static org.bukkit.inventory.ItemStack addAttribute​(org.bukkit.inventory.ItemStack item, +org.bukkit.attribute.Attribute attribute, +double amount, +org.bukkit.attribute.AttributeModifier.Operation operation)
                Add an attribute to the item
                -
                -
                Parameters:
                +
                +
                Parameters:
                item - The item to have an attribute added
                attribute - The Attribute to be added
                amount - The amount to modify it by
                operation - The operation by which the value will be modified
                -
                Returns:
                +
                Returns:
                The modified item
                +
                • -
              - - - -
                -
              • -

                addItemFlags

                -
                public static org.bukkit.inventory.ItemStack addItemFlags​(org.bukkit.inventory.ItemStack item,
-                                                          org.bukkit.inventory.ItemFlag... flags)
                +
              • +
                +

                addItemFlags

                +
                public static org.bukkit.inventory.ItemStack addItemFlags​(org.bukkit.inventory.ItemStack item, +org.bukkit.inventory.ItemFlag... flags)
                Adds ItemFlags to the item
                -
                -
                Parameters:
                +
                +
                Parameters:
                item - The item to add ItemFlags to
                flags - The ItemFlags to add
                -
                Returns:
                +
                Returns:
                The modified item
                +
                • -
              - - - -
                -
              • -

                setCustomModelData

                -
                public static org.bukkit.inventory.ItemStack setCustomModelData​(org.bukkit.inventory.ItemStack item,
-                                                                int customModelData)
                +
              • +
                +

                setCustomModelData

                +
                public static org.bukkit.inventory.ItemStack setCustomModelData​(org.bukkit.inventory.ItemStack item, +int customModelData)
                Sets the custom model data of the item
                -
                -
                Parameters:
                +
                +
                Parameters:
                item - The item to set the custom model data for
                customModelData - The custom model data to set
                -
                Returns:
                +
                Returns:
                The modified item
                +
                • -
              - - - - - -
                -
              • -

                addPersistentTag

                -
                public static <T,​Z> org.bukkit.inventory.ItemStack addPersistentTag​(org.bukkit.inventory.ItemStack item,
-                                                                          org.bukkit.NamespacedKey key,
-                                                                          org.bukkit.persistence.PersistentDataType<T,​Z> type,
-                                                                          Z data)
                +
              • +
                +

                addPersistentTag

                +
                public static <T,​ +Z> org.bukkit.inventory.ItemStack addPersistentTag​(org.bukkit.inventory.ItemStack item, +org.bukkit.NamespacedKey key, +org.bukkit.persistence.PersistentDataType<T,​Z> type, +Z data)
                Adds persistent data to the item
                -
                -
                Type Parameters:
                +
                +
                Type Parameters:
                T - The primary object type
                Z - The retrieved object type
                -
                Parameters:
                +
                Parameters:
                item - The item to add persistent data to
                key - The key to add the data under
                type - The type of the data
                data - The data to store
                -
                Returns:
                +
                Returns:
                The modified item
                +
                • -
              - - - -
                -
              • -

                addAttribute

                -
                public static org.bukkit.inventory.ItemStack addAttribute​(org.bukkit.inventory.ItemStack item,
-                                                          org.bukkit.attribute.Attribute attribute,
-                                                          double amount,
-                                                          org.bukkit.attribute.AttributeModifier.Operation operation,
-                                                          org.bukkit.inventory.EquipmentSlot slot)
                +
              • +
                +

                addAttribute

                +
                public static org.bukkit.inventory.ItemStack addAttribute​(org.bukkit.inventory.ItemStack item, +org.bukkit.attribute.Attribute attribute, +double amount, +org.bukkit.attribute.AttributeModifier.Operation operation, +org.bukkit.inventory.EquipmentSlot slot)
                Add an attribute to the item
                -
                -
                Parameters:
                +
                +
                Parameters:
                item - The item to have an attribute added
                attribute - The Attribute to be added
                amount - The amount to modify it by
                operation - The operation by which the value will be modified
                slot - The slot this attribute will be effective in
                -
                Returns:
                +
                Returns:
                The modified item
                +
                • -
              - - - -
                -
              • -

                damage

                -
                public static org.bukkit.inventory.ItemStack damage​(org.bukkit.inventory.ItemStack item,
-                                                    int amount)
                +
              • +
                +

                damage

                +
                public static org.bukkit.inventory.ItemStack damage​(org.bukkit.inventory.ItemStack item, +int amount)
                Damages an item
                -
                -
                Parameters:
                +
                +
                Parameters:
                item - The item to damage
                amount - How much damage to apply
                -
                Returns:
                +
                Returns:
                The damaged item
                -
                Throws:
                +
                Throws:
                java.lang.IllegalArgumentException - if the item is not damageable
                +
                • -
              - - - -
                -
              • -

                count

                -
                public static int count​(org.bukkit.inventory.Inventory inv,
-                        org.bukkit.inventory.ItemStack item,
-                        java.util.function.BiPredicate<org.bukkit.inventory.ItemStack,​org.bukkit.inventory.ItemStack> comparison)
                +
              • +
                +

                count

                +
                public static int count​(org.bukkit.inventory.Inventory inv, +org.bukkit.inventory.ItemStack item, +java.util.function.BiPredicate<org.bukkit.inventory.ItemStack,​org.bukkit.inventory.ItemStack> comparison)
                Counts the number of the given item in the given inventory
                -
                -
                Parameters:
                +
                +
                Parameters:
                inv - The inventory to count the items in
                item - The item to count
                comparison - A filter to compare items for counting
                -
                Returns:
                +
                Returns:
                The number of items found
                +
                • -
              - - - -
                -
              • -

                count

                -
                public static int count​(org.bukkit.inventory.Inventory inv,
-                        org.bukkit.inventory.ItemStack item)
                +
              • +
                +

                count

                +
                public static int count​(org.bukkit.inventory.Inventory inv, +org.bukkit.inventory.ItemStack item)
                Counts the number of the given item in the given inventory
                -
                -
                Parameters:
                +
                +
                Parameters:
                inv - The inventory to count the items in
                item - The item to count
                -
                Returns:
                +
                Returns:
                The number of items found
                +
                • -
              - - - -
                -
              • -

                count

                -
                public static int count​(org.bukkit.inventory.Inventory inv,
-                        org.bukkit.Material type)
                +
              • +
                +

                count

                +
                public static int count​(org.bukkit.inventory.Inventory inv, +org.bukkit.Material type)
                Counts the number of items of the given type in the given inventory
                -
                -
                Parameters:
                +
                +
                Parameters:
                inv - The inventory to count the items in
                type - The type of item to count
                -
                Returns:
                +
                Returns:
                The number of items found
                +
                • -
              - - - -
                -
              • -

                remove

                -
                public static boolean remove​(org.bukkit.inventory.Inventory inv,
-                             org.bukkit.inventory.ItemStack item,
-                             int amount,
-                             java.util.function.BiPredicate<org.bukkit.inventory.ItemStack,​org.bukkit.inventory.ItemStack> comparison)
                +
              • +
                +

                remove

                +
                public static boolean remove​(org.bukkit.inventory.Inventory inv, +org.bukkit.inventory.ItemStack item, +int amount, +java.util.function.BiPredicate<org.bukkit.inventory.ItemStack,​org.bukkit.inventory.ItemStack> comparison)
                Removes the specified amount of the given item from the given inventory
                -
                -
                Parameters:
                +
                +
                Parameters:
                inv - The inventory to remove the items from
                item - The item to be removed
                amount - The amount of items to remove
                comparison - A filter to compare items for removal
                -
                Returns:
                +
                Returns:
                Whether the amount specified could be removed. False if it removed less than specified.
                +
                • -
              - - - -
                -
              • -

                remove

                -
                public static boolean remove​(org.bukkit.inventory.Inventory inv,
-                             org.bukkit.inventory.ItemStack item,
-                             int amount)
                +
              • +
                +

                remove

                +
                public static boolean remove​(org.bukkit.inventory.Inventory inv, +org.bukkit.inventory.ItemStack item, +int amount)
                Removes the specified amount of the given item from the given inventory
                -
                -
                Parameters:
                +
                +
                Parameters:
                inv - The inventory to remove the items from
                item - The item to be removed
                amount - The amount of items to remove
                -
                Returns:
                +
                Returns:
                Whether the amount specified could be removed. False if it removed less than specified.
                +
                • -
              - - - -
                -
              • -

                remove

                -
                public static boolean remove​(org.bukkit.inventory.Inventory inv,
-                             org.bukkit.Material type,
-                             int amount)
                +
              • +
                +

                remove

                +
                public static boolean remove​(org.bukkit.inventory.Inventory inv, +org.bukkit.Material type, +int amount)
                Removes the specified amount of the given item type from the given inventory
                -
                -
                Parameters:
                +
                +
                Parameters:
                inv - The inventory to remove the items from
                type - The item type to be removed
                amount - The amount of items to remove
                -
                Returns:
                +
                Returns:
                Whether the amount specified could be removed. False if it removed less than specified.
                +
                • -
              - - - -
                -
              • -

                countAndRemove

                -
                public static int countAndRemove​(org.bukkit.inventory.Inventory inv,
-                                 org.bukkit.inventory.ItemStack item,
-                                 int max,
-                                 java.util.function.BiPredicate<org.bukkit.inventory.ItemStack,​org.bukkit.inventory.ItemStack> comparison)
                +
              • +
                +

                countAndRemove

                +
                public static int countAndRemove​(org.bukkit.inventory.Inventory inv, +org.bukkit.inventory.ItemStack item, +int max, +java.util.function.BiPredicate<org.bukkit.inventory.ItemStack,​org.bukkit.inventory.ItemStack> comparison)
                Remove all matching items up to a maximum, returning the number that were removed
                -
                -
                Parameters:
                +
                +
                Parameters:
                inv - The inventory to count and remove items from
                item - The item to count and remove
                max - The maximum number of items to remove
                comparison - A filter to compare items for counting and removal
                -
                Returns:
                +
                Returns:
                How many items were removed
                +
                • -
              - - - -
                -
              • -

                countAndRemove

                -
                public static int countAndRemove​(org.bukkit.inventory.Inventory inv,
-                                 org.bukkit.inventory.ItemStack item,
-                                 int max)
                +
              • +
                +

                countAndRemove

                +
                public static int countAndRemove​(org.bukkit.inventory.Inventory inv, +org.bukkit.inventory.ItemStack item, +int max)
                Remove all matching items up to a maximum, returning the number that were removed
                -
                -
                Parameters:
                +
                +
                Parameters:
                inv - The inventory to count and remove items from
                item - The item to count and remove
                max - The maximum number of items to remove
                -
                Returns:
                +
                Returns:
                How many items were removed
                +
                • -
              - - - -
                -
              • -

                countAndRemove

                -
                public static int countAndRemove​(org.bukkit.inventory.Inventory inv,
-                                 org.bukkit.Material type,
-                                 int max)
                +
              • +
                +

                countAndRemove

                +
                public static int countAndRemove​(org.bukkit.inventory.Inventory inv, +org.bukkit.Material type, +int max)
                Remove all matching items up to a maximum, returning the number that were removed
                -
                -
                Parameters:
                +
                +
                Parameters:
                inv - The inventory to count and remove items from
                type - The item type to count and remove
                max - The maximum number of items to remove
                -
                Returns:
                +
                Returns:
                How many items were removed
                +
                • -
              - - - -
                -
              • -

                countAndRemove

                -
                public static int countAndRemove​(org.bukkit.inventory.Inventory inv,
-                                 org.bukkit.inventory.ItemStack item)
                +
              • +
                +

                countAndRemove

                +
                public static int countAndRemove​(org.bukkit.inventory.Inventory inv, +org.bukkit.inventory.ItemStack item)
                Remove all matching items, returning the number that were removed
                -
                -
                Parameters:
                +
                +
                Parameters:
                inv - The inventory to count and remove items from
                item - The item to count and remove
                -
                Returns:
                +
                Returns:
                How many items were removed
                +
                • -
              - - - -
                -
              • -

                countAndRemove

                -
                public static int countAndRemove​(org.bukkit.inventory.Inventory inv,
-                                 org.bukkit.Material type)
                +
              • +
                +

                countAndRemove

                +
                public static int countAndRemove​(org.bukkit.inventory.Inventory inv, +org.bukkit.Material type)
                Remove all items of a specified type, returning the number that were removed
                -
                -
                Parameters:
                +
                +
                Parameters:
                inv - The inventory to count and remove items from
                type - The item type to count and remove
                -
                Returns:
                +
                Returns:
                How many items were removed
                +
                • -
              - - - -
                -
              • -

                give

                -
                public static void give​(org.bukkit.entity.Player player,
-                        org.bukkit.inventory.ItemStack... items)
                +
              • +
                +

                give

                +
                public static void give​(org.bukkit.entity.Player player, +org.bukkit.inventory.ItemStack... items)
                Give the player the specified items, dropping them on the ground if there is not enough room
                -
                -
                Parameters:
                +
                +
                Parameters:
                player - The player to give the items to
                items - The items to be given
                +
                • -
              - - - -
                -
              • -

                give

                -
                public static void give​(org.bukkit.entity.Player player,
-                        org.bukkit.inventory.ItemStack item,
-                        int amount)
                +
              • +
                +

                give

                +
                public static void give​(org.bukkit.entity.Player player, +org.bukkit.inventory.ItemStack item, +int amount)
                Gives the player the specified amount of the specified item, dropping them on the ground if there is not enough room
                -
                -
                Parameters:
                +
                +
                Parameters:
                player - The player to give the items to
                item - The item to be given to the player
                amount - The amount the player should be given
                +
                • -
              - - - -
                -
              • -

                give

                -
                public static void give​(org.bukkit.entity.Player player,
-                        org.bukkit.Material type,
-                        int amount)
                +
              • +
                +

                give

                +
                public static void give​(org.bukkit.entity.Player player, +org.bukkit.Material type, +int amount)
                Gives the player the specified amount of the specified item type, dropping them on the ground if there is not enough room
                -
                -
                Parameters:
                +
                +
                Parameters:
                player - The player to give the items to
                type - The item type to be given to the player
                amount - The amount the player should be given
                +
                • -
              - - - -
                -
              • -

                compare

                -
                public static boolean compare​(org.bukkit.inventory.ItemStack first,
-                              org.bukkit.inventory.ItemStack second,
-                              ItemTrait... traits)
                +
              • +
                +

                compare

                +
                public static boolean compare​(org.bukkit.inventory.ItemStack first, +org.bukkit.inventory.ItemStack second, +ItemTrait... traits)
                Compares the traits of two items
                -
                -
                Parameters:
                +
                +
                Parameters:
                first - The first ItemStack
                second - The second ItemStack
                traits - The ItemTraits to compare
                -
                Returns:
                +
                Returns:
                Whether the two items are identical in terms of the traits provided. Returns true if both items are null, and false if only one is null.
                +
                • -
              - - - -
                -
              • -

                compare

                -
                public static boolean compare​(org.bukkit.inventory.ItemStack first,
-                              org.bukkit.inventory.ItemStack second)
                +
              • +
                +

                compare

                +
                public static boolean compare​(org.bukkit.inventory.ItemStack first, +org.bukkit.inventory.ItemStack second)
                Compares the type, name, and lore of two items
                -
                -
                Parameters:
                +
                +
                Parameters:
                first - The first ItemStack
                second - The second ItemStack
                -
                Returns:
                +
                Returns:
                Whether the two items are identical in terms of type, name, and lore. Returns true if both items are null, and false if only one is null.
                +
                • -
              - - - -
                -
              • -

                cloneInventory

                -
                public static org.bukkit.inventory.Inventory cloneInventory​(org.bukkit.inventory.Inventory inv)
                +
              • +
                +

                cloneInventory

                +
                public static org.bukkit.inventory.Inventory cloneInventory​(org.bukkit.inventory.Inventory inv)
                Creates a mock inventory clone of the given inventory. Do not try to open this inventory for players, it will throw an error.
                -
                -
                Parameters:
                +
                +
                Parameters:
                inv - The inventory to clone
                -
                Returns:
                +
                Returns:
                A mock clone inventory
                +
                • -
              - - - -
                -
              • -

                toString

                -
                public static java.lang.String toString​(org.bukkit.inventory.ItemStack item)
                +
              • +
                +

                toString

                +
                public static java.lang.String toString​(org.bukkit.inventory.ItemStack item)
                Converts an ItemStack to a JSON string
                -
                -
                Parameters:
                +
                +
                Parameters:
                item - The ItemStack to convert to a string
                -
                Returns:
                +
                Returns:
                A JSON string representing the given item
                +
                • -
              - - - -
                -
              • -

                fromString

                -
                public static org.bukkit.inventory.ItemStack fromString​(java.lang.String json)
                +
              • +
                +

                fromString

                +
                public static org.bukkit.inventory.ItemStack fromString​(java.lang.String json)
                Constructs an ItemStack from a previously-serialized JSON string
                -
                -
                Parameters:
                +
                +
                Parameters:
                json - The JSON string created using toString(ItemStack)
                -
                Returns:
                +
                Returns:
                The deserialized ItemStack
                -
                • -
              +
        -
    - - + + + + diff --git a/javadoc/redempt/redlib/itemutils/LoreStats.html b/javadoc/redempt/redlib/itemutils/LoreStats.html index d96cbc1..cbbf9e2 100644 --- a/javadoc/redempt/redlib/itemutils/LoreStats.html +++ b/javadoc/redempt/redlib/itemutils/LoreStats.html @@ -5,488 +5,384 @@ LoreStats (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.itemutils
    -

    Class LoreStats

    +
    Package redempt.redlib.itemutils
    +

    Class LoreStats

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.itemutils.LoreStats
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      redempt.redlib.itemutils.LoreStats
      +
      +
      -
      public class LoreStats
+
      public class LoreStats
 extends java.lang.Object
      
 
      Represents stats or other info stored in item lore
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Constructor Summary

          - - +
        • +
          +

          Constructor Summary

          +
          +
          • Constructors 
          + + - - + + - - - + + + + +
          Constructors
          ConstructorDescriptionConstructorDescription
          LoreStats​(java.util.List<java.lang.String> lines, - java.lang.String... placeholders) +
          LoreStats​(java.util.List<java.lang.String> lines, +java.lang.String... placeholders)
          Create a LoreStats from a list of lore lines and a vararg of placeholder names
          -
          • -
        +
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Instance Methods Concrete Methods 
      + - - - + + + - - - - + + + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + +
      Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
      doublegetDouble​(org.bukkit.inventory.ItemStack item, - java.lang.String placeholder) +
      doublegetDouble​(org.bukkit.inventory.ItemStack item, +java.lang.String placeholder)
      Gets a double stat from lore
      doublegetDouble​(org.bukkit.inventory.ItemStack item, - java.lang.String placeholder, - double defaultValue) +
      doublegetDouble​(org.bukkit.inventory.ItemStack item, +java.lang.String placeholder, +double defaultValue)
      Gets a double stat from lore
      intgetInt​(org.bukkit.inventory.ItemStack item, - java.lang.String placeholder) +
      intgetInt​(org.bukkit.inventory.ItemStack item, +java.lang.String placeholder)
      Gets an int stat from lore
      intgetInt​(org.bukkit.inventory.ItemStack item, - java.lang.String placeholder, - int defaultValue) +
      intgetInt​(org.bukkit.inventory.ItemStack item, +java.lang.String placeholder, +int defaultValue)
      Gets an int stat from lore
      java.lang.StringgetStat​(org.bukkit.inventory.ItemStack item, - java.lang.String placeholder) +
      java.lang.StringgetStat​(org.bukkit.inventory.ItemStack item, +java.lang.String placeholder)
      Gets a stat in String form from the lore of an item
      org.bukkit.inventory.ItemStackset​(org.bukkit.inventory.ItemStack item, - java.lang.String placeholder, - java.lang.Object obj) +
      org.bukkit.inventory.ItemStackset​(org.bukkit.inventory.ItemStack item, +java.lang.String placeholder, +java.lang.Object obj)
      Sets the stat on the given item to the given object, which will be cast to a String
      voidsetFixedLore​(boolean fixedLore) +
      voidsetFixedLore​(boolean fixedLore)
      True by default.
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

    Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - -
            -
          • -

            LoreStats

            -
            public LoreStats​(java.util.List<java.lang.String> lines,
-                 java.lang.String... placeholders)
            +
          • +
            +

            Constructor Details

            +
              +
            • +
              +

              LoreStats

              +
              public LoreStats​(java.util.List<java.lang.String> lines, +java.lang.String... placeholders)
              Create a LoreStats from a list of lore lines and a vararg of placeholder names
              -
              -
              Parameters:
              +
              +
              Parameters:
              lines - The lines of lore to load. Placeholders should be surrounded by percent signs.
              placeholders - Placeholder names, WITHOUT being surrounded by percent signs
              -
              • -
            +
        + -
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            setFixedLore

            -
            public void setFixedLore​(boolean fixedLore)
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              setFixedLore

              +
              public void setFixedLore​(boolean fixedLore)
              True by default. Set to true if the lore lines on the item will always show up at the same positions as what was originally passed when constructing these LoreStats, false if the lore might be on different lines.
              -
              -
              Parameters:
              +
              +
              Parameters:
              fixedLore - Whether the lines of the lore should be fixed
              +
              • -
            - - - -
              -
            • -

              getStat

              -
              public java.lang.String getStat​(org.bukkit.inventory.ItemStack item,
-                                java.lang.String placeholder)
              +
            • +
              +

              getStat

              +
              public java.lang.String getStat​(org.bukkit.inventory.ItemStack item, +java.lang.String placeholder)
              Gets a stat in String form from the lore of an item
              -
              -
              Parameters:
              +
              +
              Parameters:
              item - The item to check the stat on
              placeholder - The placeholder to use, without percent signs.
              -
              Returns:
              +
              Returns:
              The String stat found, or null if none was found
              +
              • -
            - - - -
              -
            • -

              getInt

              -
              public int getInt​(org.bukkit.inventory.ItemStack item,
-                  java.lang.String placeholder)
              +
            • +
              +

              getInt

              +
              public int getInt​(org.bukkit.inventory.ItemStack item, +java.lang.String placeholder)
              Gets an int stat from lore
              -
              -
              Parameters:
              +
              +
              Parameters:
              item - The item to check the stat on
              placeholder - The placeholder to use, without percent signs
              -
              Returns:
              +
              Returns:
              The int stat found
              -
              Throws:
              +
              Throws:
              java.lang.NullPointerException - if the stat was not found
              +
              • -
            - - - -
              -
            • -

              getInt

              -
              public int getInt​(org.bukkit.inventory.ItemStack item,
-                  java.lang.String placeholder,
-                  int defaultValue)
              +
            • +
              +

              getInt

              +
              public int getInt​(org.bukkit.inventory.ItemStack item, +java.lang.String placeholder, +int defaultValue)
              Gets an int stat from lore
              -
              -
              Parameters:
              +
              +
              Parameters:
              item - The item to check the stat on
              placeholder - The placeholder to use, without percent signs
              defaultValue - The default value to use if no value was found in the lore
              -
              Returns:
              +
              Returns:
              The int stat found, or the default value
              +
              • -
            - - - -
              -
            • -

              getDouble

              -
              public double getDouble​(org.bukkit.inventory.ItemStack item,
-                        java.lang.String placeholder)
              +
            • +
              +

              getDouble

              +
              public double getDouble​(org.bukkit.inventory.ItemStack item, +java.lang.String placeholder)
              Gets a double stat from lore
              -
              -
              Parameters:
              +
              +
              Parameters:
              item - The item to check the stat on
              placeholder - The placeholder to use, without percent signs
              -
              Returns:
              +
              Returns:
              The double stat found
              -
              Throws:
              +
              Throws:
              java.lang.NullPointerException - if the stat was not found
              +
              • -
            - - - -
              -
            • -

              getDouble

              -
              public double getDouble​(org.bukkit.inventory.ItemStack item,
-                        java.lang.String placeholder,
-                        double defaultValue)
              +
            • +
              +

              getDouble

              +
              public double getDouble​(org.bukkit.inventory.ItemStack item, +java.lang.String placeholder, +double defaultValue)
              Gets a double stat from lore
              -
              -
              Parameters:
              +
              +
              Parameters:
              item - The item to check the stat on
              placeholder - The placeholder to use, without percent signs
              defaultValue - The default value to use if no value was found in the lore
              -
              Returns:
              +
              Returns:
              The double stat found, or the default value
              +
              • -
            - - - -
              -
            • -

              set

              -
              public org.bukkit.inventory.ItemStack set​(org.bukkit.inventory.ItemStack item,
-                                          java.lang.String placeholder,
-                                          java.lang.Object obj)
              +
            • +
              +

              set

              +
              public org.bukkit.inventory.ItemStack set​(org.bukkit.inventory.ItemStack item, +java.lang.String placeholder, +java.lang.Object obj)
              Sets the stat on the given item to the given object, which will be cast to a String
              -
              -
              Parameters:
              +
              +
              Parameters:
              item - The item to set the stat on
              placeholder - The placeholder stat to set
              obj - The object to set the stat to
              -
              Returns:
              +
              Returns:
              The modified ItemStack, or null if it could not be modified
              -
              • -
            +
      -
    - - + + + + diff --git a/javadoc/redempt/redlib/itemutils/package-summary.html b/javadoc/redempt/redlib/itemutils/package-summary.html index 94de71d..774c572 100644 --- a/javadoc/redempt/redlib/itemutils/package-summary.html +++ b/javadoc/redempt/redlib/itemutils/package-summary.html @@ -5,47 +5,30 @@ redempt.redlib.itemutils (RedLib API) + + - + + - - - - - + + - - -
    +
    + +

    Package redempt.redlib.itemutils

    -
    -
      -
    • - - +
      +
        +
      • +
        +
      Class Summary 
      + + - - + + + - - - + + - - - + + - - - + + - - - + +
      Class Summary
      ClassDescriptionClassDescription
      CustomItem +
      CustomItem
      Represents a custom item with special behavior
      ItemBuilder +
      ItemBuilder
      A utility class to easily create items
      ItemUtils +
      ItemUtils
      A utility class to easily modify items
      LoreStats +
      LoreStats
      Represents stats or other info stored in item lore
      +
    -
  • - - +
  • +
    +
    • Enum Summary 
    + + - - + + + - - - + +
    Enum Summary
    EnumDescriptionEnumDescription
    ItemTrait +
    ItemTrait
    A set of comparable traits items have and can be compared with ItemUtils.compare(ItemStack, ItemStack, ItemTrait...)
    +
    • -
    +
    + + +
    + + diff --git a/javadoc/redempt/redlib/itemutils/package-tree.html b/javadoc/redempt/redlib/itemutils/package-tree.html index 7400094..ce65a46 100644 --- a/javadoc/redempt/redlib/itemutils/package-tree.html +++ b/javadoc/redempt/redlib/itemutils/package-tree.html @@ -5,177 +5,110 @@ redempt.redlib.itemutils Class Hierarchy (RedLib API) + + - + + - - - - - + + - - -
    +
    + +

    Hierarchy For Package redempt.redlib.itemutils

    -Package Hierarchies: +Package Hierarchies:
    -
    -
    +

    Class Hierarchy

    • java.lang.Object
        -
      • redempt.redlib.itemutils.CustomItem
        • +
      • redempt.redlib.itemutils.CustomItem
      • org.bukkit.inventory.ItemStack (implements java.lang.Cloneable, org.bukkit.configuration.serialization.ConfigurationSerializable)
        • -
      • redempt.redlib.itemutils.ItemUtils
        • -
      • redempt.redlib.itemutils.LoreStats
        • +
      • redempt.redlib.itemutils.ItemUtils
        • +
      • redempt.redlib.itemutils.LoreStats
    -
    +

    Enum Hierarchy

    • java.lang.Object
        -
      • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) +
      • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.lang.constant.Constable, java.io.Serializable)
    -
    +
    +
    diff --git a/javadoc/redempt/redlib/json/JSONList.html b/javadoc/redempt/redlib/json/JSONList.html index 2f88e15..ca1a867 100644 --- a/javadoc/redempt/redlib/json/JSONList.html +++ b/javadoc/redempt/redlib/json/JSONList.html @@ -5,591 +5,434 @@ JSONList (RedLib API) + + - + + - - - - - + + - - -
    +
    +
    + + + +
    - +
    +
    -
    Package redempt.redlib.json
    -

    Class JSONList

    +
    Package redempt.redlib.json
    +

    Class JSONList

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • java.util.AbstractCollection<E>
        • -
      • -
          -
        • java.util.AbstractList<E>
          • -
        • -
            -
          • java.util.ArrayList<java.lang.Object>
            • -
          • -
              -
            • redempt.redlib.json.JSONList
              • -
            -
            • -
          -
          • -
        -
        • -
      -
      • -
    -
    -
      -
    • -
      +
      java.lang.Object +
      java.util.AbstractCollection<E> +
      java.util.AbstractList<E> +
      java.util.ArrayList<java.lang.Object> +
      redempt.redlib.json.JSONList
      +
      +
      +
      +
      +
      +
      All Implemented Interfaces:
      java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<java.lang.Object>, java.util.Collection<java.lang.Object>, java.util.List<java.lang.Object>, java.util.RandomAccess
      -
      public class JSONList
+
      public class JSONList
 extends java.util.ArrayList<java.lang.Object>
      
 
      Represents a list which can be serialized to JSON and deserialized back to this form,
  assuming all of the values it stores are serializable
      
-
      
-
      See Also:
      
+
      
+
      See Also:
      
 
      Serialized Form
      
 
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Field Summary

          - - +
        • +
          +

          Field Summary

          +
          +
          • Fields 
          + + - - - + + + - - - - + + + + + + +
          Fields
          Modifier and TypeFieldDescriptionModifier and TypeFieldDescription
          protected java.lang.Stringkey 
          protected java.lang.Stringkey 
          -
            -
          • - - -

            Fields inherited from class java.util.AbstractList

            -modCount
            • -
          -
          • -
        +
    +
    +

    Fields inherited from class java.util.AbstractList

    +modCount
    + -
    -
      -
    • - - -

      Constructor Summary

      - - +
    • +
      +

      Constructor Summary

      +
      +
      • Constructors 
      + + - - + + - - - + + + + + +
      Constructors
      ConstructorDescriptionConstructorDescription
      JSONList() 
      JSONList() 
      -
      • -
    +
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Instance Methods Concrete Methods 
      + - - - + + + - - - - + + + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + +
      Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
      voidadd​(java.lang.String key, - java.lang.Object value) 
      voidadd​(java.lang.String key, +java.lang.Object value) 
      <T> java.util.List<T>cast​(java.lang.Class<T> clazz) 
      <T> java.util.List<T>cast​(java.lang.Class<T> clazz) 
      booleangetBoolean​(int key) 
      booleangetBoolean​(int key) 
      doublegetDouble​(int key) 
      doublegetDouble​(int key) 
      intgetInt​(int key) 
      intgetInt​(int key) 
      JSONListgetList​(int key) 
      JSONListgetList​(int key) 
      longgetLong​(int key) 
      longgetLong​(int key) 
      JSONMapgetMap​(int key) 
      JSONMapgetMap​(int key) 
      redempt.redlib.json.JSONStoragegetParent() 
      redempt.redlib.json.JSONStoragegetParent() 
      java.lang.StringgetString​(int key) 
      java.lang.StringgetString​(int key) 
      java.lang.StringgetTempKey() 
      java.lang.StringgetTempKey() 
      voidsetParent​(redempt.redlib.json.JSONStorage obj) 
      voidsetParent​(redempt.redlib.json.JSONStorage obj) 
      voidsetTempKey​(java.lang.String value) 
      voidsetTempKey​(java.lang.String value) 
      java.lang.StringtoString() 
      java.lang.StringtoString() 
      -
        -
      • - - -

        Methods inherited from class java.util.ArrayList

        -add, add, addAll, addAll, clear, clone, contains, ensureCapacity, equals, forEach, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, removeRange, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize
        • -
      -
        -
      • - - -

        Methods inherited from class java.util.AbstractCollection

        -containsAll
        • -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -finalize, getClass, notify, notifyAll, wait, wait, wait
        • -
      -
        -
      • - - -

        Methods inherited from interface java.util.Collection

        -parallelStream, stream, toArray
        • -
      -
        -
      • - - -

        Methods inherited from interface java.util.List

        -containsAll
        • -
      -
      • -
    +
    + +
    +

    Methods inherited from class java.util.ArrayList

    +add, add, addAll, addAll, clear, clone, contains, ensureCapacity, equals, forEach, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, removeRange, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize
    +
    +

    Methods inherited from class java.util.AbstractCollection

    +containsAll
    +
    +

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface java.util.Collection

    +parallelStream, stream, toArray
    +
    +

    Methods inherited from interface java.util.List

    +containsAll
    - -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Field Detail

          - - - -
            -
          • -

            key

            -
            protected java.lang.String key
            -
            • -
          +
        • +
          +

          Field Details

          +
            +
          • +
            +

            key

            +
            protected java.lang.String key
            +
          - -
          -
            -
          • - - -

            Constructor Detail

            - - - -
              -
            • -

              JSONList

              -
              public JSONList()
              • -
            + +
          • +
            +

            Constructor Details

            +
              +
            • +
              +

              JSONList

              +
              public JSONList()
              +
            +
            • -
            -
              -
            • - - -

              Method Detail

              - - - -
                -
              • -

                getInt

                -
                public int getInt​(int key)
                +
              • +
                +

                Method Details

                +
                  +
                • +
                  +

                  getInt

                  +
                  public int getInt​(int key)
                  +
                  • -
                - - - -
                  -
                • -

                  getBoolean

                  -
                  public boolean getBoolean​(int key)
                  +
                • +
                  +

                  getBoolean

                  +
                  public boolean getBoolean​(int key)
                  +
                  • -
                - - - -
                  -
                • -

                  getLong

                  -
                  public long getLong​(int key)
                  +
                • +
                  +

                  getLong

                  +
                  public long getLong​(int key)
                  +
                  • -
                - - - -
                  -
                • -

                  getDouble

                  -
                  public double getDouble​(int key)
                  +
                • +
                  +

                  getDouble

                  +
                  public double getDouble​(int key)
                  +
                  • -
                - - - -
                  -
                • -

                  getList

                  -
                  public JSONList getList​(int key)
                  +
                • +
                  +

                  getList

                  +
                  public JSONList getList​(int key)
                  +
                  • -
                - - - -
                  -
                • -

                  getMap

                  -
                  public JSONMap getMap​(int key)
                  +
                • +
                  +

                  getMap

                  +
                  public JSONMap getMap​(int key)
                  +
                  • -
                - - - -
                  -
                • -

                  getString

                  -
                  public java.lang.String getString​(int key)
                  +
                • +
                  +

                  getString

                  +
                  public java.lang.String getString​(int key)
                  +
                  • -
                - - - -
                  -
                • -

                  cast

                  -
                  public <T> java.util.List<T> cast​(java.lang.Class<T> clazz)
                  +
                • +
                  +

                  cast

                  +
                  public <T> java.util.List<T> cast​(java.lang.Class<T> clazz)
                  +
                  • -
                - - - -
                  -
                • -

                  toString

                  -
                  public java.lang.String toString()
                  -
                  -
                  Overrides:
                  +
                • +
                  +

                  toString

                  +
                  public java.lang.String toString()
                  +
                  +
                  Overrides:
                  toString in class java.util.AbstractCollection<java.lang.Object>
                  -
                  Returns:
                  +
                  Returns:
                  A JSON string representing this JSONList
                  +
                  • -
                - - - -
                  -
                • -

                  getParent

                  -
                  public redempt.redlib.json.JSONStorage getParent()
                  -
                  • -
                - - - -
                  -
                • -

                  setParent

                  -
                  public void setParent​(redempt.redlib.json.JSONStorage obj)
                  +
                • +
                  +

                  getParent

                  +
                  public redempt.redlib.json.JSONStorage getParent()
                  +
                  • -
                - - - -
                  -
                • -

                  add

                  -
                  public void add​(java.lang.String key,
-                java.lang.Object value)
                  +
                • +
                  +

                  setParent

                  +
                  public void setParent​(redempt.redlib.json.JSONStorage obj)
                  +
                  • -
                - - - -
                  -
                • -

                  getTempKey

                  -
                  public java.lang.String getTempKey()
                  +
                • +
                  +

                  add

                  +
                  public void add​(java.lang.String key, +java.lang.Object value)
                  +
                  • -
                - - - -
                  -
                • -

                  setTempKey

                  -
                  public void setTempKey​(java.lang.String value)
                  +
                • +
                  +

                  getTempKey

                  +
                  public java.lang.String getTempKey()
                  +
                  • -
                +
              • +
                +

                setTempKey

                +
                public void setTempKey​(java.lang.String value)
                +
          -
    - - + + + + diff --git a/javadoc/redempt/redlib/json/JSONMap.html b/javadoc/redempt/redlib/json/JSONMap.html index 4a190ac..12d38c8 100644 --- a/javadoc/redempt/redlib/json/JSONMap.html +++ b/javadoc/redempt/redlib/json/JSONMap.html @@ -5,582 +5,427 @@ JSONMap (RedLib API) + + - + + - - - - - + + - - -
    +
    +
    + + + +
    - +
    +
    -
    Package redempt.redlib.json
    -

    Class JSONMap

    +
    Package redempt.redlib.json
    +

    Class JSONMap

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • java.util.AbstractMap<K,​V>
        • -
      • -
          -
        • java.util.HashMap<java.lang.String,​java.lang.Object>
          • -
        • -
            -
          • redempt.redlib.json.JSONMap
            • -
          -
          • -
        -
        • -
      -
      • -
    -
    -
      -
    • -
      +
      java.lang.Object +
      java.util.AbstractMap<K,​V> +
      java.util.HashMap<java.lang.String,​java.lang.Object> +
      redempt.redlib.json.JSONMap
      +
      +
      +
      +
      +
      All Implemented Interfaces:
      java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.String,​java.lang.Object>
      -
      public class JSONMap
+
      public class JSONMap
 extends java.util.HashMap<java.lang.String,​java.lang.Object>
      
 
      Represents a map which can be serialized to JSON and deserialized back to this form,
  assuming all of the values it stores are serializable
      
-
      
-
      See Also:
      
+
      
+
      See Also:
      
 
      Serialized Form
      
 
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Nested Class Summary

          -
            -
          • - - -

            Nested classes/interfaces inherited from class java.util.AbstractMap

            -java.util.AbstractMap.SimpleEntry<K extends java.lang.Object,​V extends java.lang.Object>, java.util.AbstractMap.SimpleImmutableEntry<K extends java.lang.Object,​V extends java.lang.Object>
            • -
          -
            -
          • - - -

            Nested classes/interfaces inherited from interface java.util.Map

            -java.util.Map.Entry<K extends java.lang.Object,​V extends java.lang.Object>
            • -
          -
          • -
        +
      • +
        +

        Nested Class Summary

        +
        +

        Nested classes/interfaces inherited from class java.util.AbstractMap

        +java.util.AbstractMap.SimpleEntry<K extends java.lang.Object,​V extends java.lang.Object>, java.util.AbstractMap.SimpleImmutableEntry<K extends java.lang.Object,​V extends java.lang.Object>
        +
        +

        Nested classes/interfaces inherited from interface java.util.Map

        +java.util.Map.Entry<K extends java.lang.Object,​V extends java.lang.Object>
        +
        • -
        -
          -
        • - - -

          Field Summary

          - - +
        • +
          +

          Field Summary

          +
          +
          • Fields 
          + + - - - + + + - - - - + + + + + + +
          Fields
          Modifier and TypeFieldDescriptionModifier and TypeFieldDescription
          protected java.lang.Stringkey 
          protected java.lang.Stringkey 
          -
          • -
        +
    + -
    -
      -
    • - - -

      Constructor Summary

      - - +
    • +
      +

      Constructor Summary

      +
      +
      • Constructors 
      + + - - + + - - - + + + + + +
      Constructors
      ConstructorDescriptionConstructorDescription
      JSONMap() 
      JSONMap() 
      -
      • -
    +
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Instance Methods Concrete Methods 
      + - - - + + + - - - - + + + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + +
      Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
      voidadd​(java.lang.String key, - java.lang.Object value) 
      voidadd​(java.lang.String key, +java.lang.Object value) 
      booleangetBoolean​(java.lang.String key) 
      booleangetBoolean​(java.lang.String key) 
      doublegetDouble​(java.lang.String key) 
      doublegetDouble​(java.lang.String key) 
      intgetInt​(java.lang.String key) 
      intgetInt​(java.lang.String key) 
      JSONListgetList​(java.lang.String key) 
      JSONListgetList​(java.lang.String key) 
      longgetLong​(java.lang.String key) 
      longgetLong​(java.lang.String key) 
      JSONMapgetMap​(java.lang.String key) 
      JSONMapgetMap​(java.lang.String key) 
      redempt.redlib.json.JSONStoragegetParent() 
      redempt.redlib.json.JSONStoragegetParent() 
      java.lang.StringgetString​(java.lang.String key) 
      java.lang.StringgetString​(java.lang.String key) 
      java.lang.StringgetTempKey() 
      java.lang.StringgetTempKey() 
      voidsetParent​(redempt.redlib.json.JSONStorage obj) 
      voidsetParent​(redempt.redlib.json.JSONStorage obj) 
      voidsetTempKey​(java.lang.String value) 
      voidsetTempKey​(java.lang.String value) 
      java.lang.StringtoString() 
      java.lang.StringtoString() 
      -
        -
      • - - -

        Methods inherited from class java.util.HashMap

        -clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values
        • -
      -
        -
      • - - -

        Methods inherited from class java.util.AbstractMap

        -equals, hashCode
        • -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -finalize, getClass, notify, notifyAll, wait, wait, wait
        • -
      -
        -
      • - - -

        Methods inherited from interface java.util.Map

        -equals, hashCode
        • -
      -
      • -
    +
    + +
    +

    Methods inherited from class java.util.HashMap

    +clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values
    +
    +

    Methods inherited from class java.util.AbstractMap

    +equals, hashCode
    +
    +

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface java.util.Map

    +equals, hashCode
    - -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Field Detail

          - - - -
            -
          • -

            key

            -
            protected java.lang.String key
            -
            • -
          +
        • +
          +

          Field Details

          +
            +
          • +
            +

            key

            +
            protected java.lang.String key
            +
          - -
          -
            -
          • - - -

            Constructor Detail

            - - - -
              -
            • -

              JSONMap

              -
              public JSONMap()
              • -
            + +
          • +
            +

            Constructor Details

            +
              +
            • +
              +

              JSONMap

              +
              public JSONMap()
              +
            +
            • -
            -
              -
            • - - -

              Method Detail

              - - - -
                -
              • -

                getInt

                -
                public int getInt​(java.lang.String key)
                +
              • +
                +

                Method Details

                +
                  +
                • +
                  +

                  getInt

                  +
                  public int getInt​(java.lang.String key)
                  +
                  • -
                - - - -
                  -
                • -

                  getBoolean

                  -
                  public boolean getBoolean​(java.lang.String key)
                  +
                • +
                  +

                  getBoolean

                  +
                  public boolean getBoolean​(java.lang.String key)
                  +
                  • -
                - - - -
                  -
                • -

                  getDouble

                  -
                  public double getDouble​(java.lang.String key)
                  +
                • +
                  +

                  getDouble

                  +
                  public double getDouble​(java.lang.String key)
                  +
                  • -
                - - - -
                  -
                • -

                  getLong

                  -
                  public long getLong​(java.lang.String key)
                  +
                • +
                  +

                  getLong

                  +
                  public long getLong​(java.lang.String key)
                  +
                  • -
                - - - -
                  -
                • -

                  getList

                  -
                  public JSONList getList​(java.lang.String key)
                  +
                • +
                  +

                  getList

                  +
                  public JSONList getList​(java.lang.String key)
                  +
                  • -
                - - - -
                  -
                • -

                  getMap

                  -
                  public JSONMap getMap​(java.lang.String key)
                  +
                • +
                  +

                  getMap

                  +
                  public JSONMap getMap​(java.lang.String key)
                  +
                  • -
                - - - -
                  -
                • -

                  getString

                  -
                  public java.lang.String getString​(java.lang.String key)
                  +
                • +
                  +

                  getString

                  +
                  public java.lang.String getString​(java.lang.String key)
                  +
                  • -
                - - - -
                  -
                • -

                  toString

                  -
                  public java.lang.String toString()
                  -
                  -
                  Overrides:
                  +
                • +
                  +

                  toString

                  +
                  public java.lang.String toString()
                  +
                  +
                  Overrides:
                  toString in class java.util.AbstractMap<java.lang.String,​java.lang.Object>
                  -
                  Returns:
                  +
                  Returns:
                  A JSON string representing this JSONMap
                  +
                  • -
                - - - -
                  -
                • -

                  getParent

                  -
                  public redempt.redlib.json.JSONStorage getParent()
                  -
                  • -
                - - - -
                  -
                • -

                  setParent

                  -
                  public void setParent​(redempt.redlib.json.JSONStorage obj)
                  +
                • +
                  +

                  getParent

                  +
                  public redempt.redlib.json.JSONStorage getParent()
                  +
                  • -
                - - - -
                  -
                • -

                  add

                  -
                  public void add​(java.lang.String key,
-                java.lang.Object value)
                  +
                • +
                  +

                  setParent

                  +
                  public void setParent​(redempt.redlib.json.JSONStorage obj)
                  +
                  • -
                - - - -
                  -
                • -

                  getTempKey

                  -
                  public java.lang.String getTempKey()
                  +
                • +
                  +

                  add

                  +
                  public void add​(java.lang.String key, +java.lang.Object value)
                  +
                  • -
                - - - -
                  -
                • -

                  setTempKey

                  -
                  public void setTempKey​(java.lang.String value)
                  +
                • +
                  +

                  getTempKey

                  +
                  public java.lang.String getTempKey()
                  +
                  • -
                +
              • +
                +

                setTempKey

                +
                public void setTempKey​(java.lang.String value)
                +
          -
    - - + + + + diff --git a/javadoc/redempt/redlib/json/JSONParser.html b/javadoc/redempt/redlib/json/JSONParser.html index 3a53970..66de33a 100644 --- a/javadoc/redempt/redlib/json/JSONParser.html +++ b/javadoc/redempt/redlib/json/JSONParser.html @@ -5,331 +5,242 @@ JSONParser (RedLib API) + + - + + - - - - - + + - - -
    +
    +
    + + + +
    - +
    +
    -
    Package redempt.redlib.json
    -

    Class JSONParser

    +
    Package redempt.redlib.json
    +

    Class JSONParser

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.json.JSONParser
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      redempt.redlib.json.JSONParser
      +
      +
      -
      public class JSONParser
+
      public class JSONParser
 extends java.lang.Object
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Constructor Summary

          - - +
        • +
          +

          Constructor Summary

          +
          +
          • Constructors 
          + + - - + + - - - + + + + + +
          Constructors
          ConstructorDescriptionConstructorDescription
          JSONParser() 
          JSONParser() 
          -
          • -
        +
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Static Methods Concrete Methods 
      + - - - + + + - - - - + + + + + - - - - + + + +
      Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
      static JSONListparseList​(java.lang.String json) +
      static JSONListparseList​(java.lang.String json)
      Parse a JSONList from a JSON string
      static JSONMapparseMap​(java.lang.String json) +
      static JSONMapparseMap​(java.lang.String json)
      Parse a JSONMap from a JSON string
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

    Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - -
            -
          • -

            JSONParser

            -
            public JSONParser()
            -
            • -
          +
        • +
          +

          Constructor Details

          +
            +
          • +
            +

            JSONParser

            +
            public JSONParser()
            +
          +
          • -
          -
            -
          • - - -

            Method Detail

            - - - -
              -
            • -

              parseList

              -
              public static JSONList parseList​(java.lang.String json)
              +
            • +
              +

              Method Details

              +
                +
              • +
                +

                parseList

                +
                public static JSONList parseList​(java.lang.String json)
                Parse a JSONList from a JSON string
                -
                -
                Parameters:
                +
                +
                Parameters:
                json - The JSON string
                -
                Returns:
                +
                Returns:
                The JSONList parsed out of it
                +
                • -
              - - - -
                -
              • -

                parseMap

                -
                public static JSONMap parseMap​(java.lang.String json)
                +
              • +
                +

                parseMap

                +
                public static JSONMap parseMap​(java.lang.String json)
                Parse a JSONMap from a JSON string
                -
                -
                Parameters:
                +
                +
                Parameters:
                json - The JSON string
                -
                Returns:
                +
                Returns:
                TThe JSONList parsed out of it
                -
                • -
              +
        -
    - - + + + + diff --git a/javadoc/redempt/redlib/json/package-summary.html b/javadoc/redempt/redlib/json/package-summary.html index 9d8c8a3..33512d6 100644 --- a/javadoc/redempt/redlib/json/package-summary.html +++ b/javadoc/redempt/redlib/json/package-summary.html @@ -5,47 +5,30 @@ redempt.redlib.json (RedLib API) + + - + + - - - - - + + - - -
    +
    + +

    Package redempt.redlib.json

    -
    -
      -
    • - - +
      +
        +
      • +
        +
      Class Summary 
      + + - - + + + - - - + + - - - + + - - - + + +
      Class Summary
      ClassDescriptionClassDescription
      JSONList +
      JSONList
      Represents a list which can be serialized to JSON and deserialized back to this form, assuming all of the values it stores are serializable
      JSONMap +
      JSONMap
      Represents a map which can be serialized to JSON and deserialized back to this form, assuming all of the values it stores are serializable
      JSONParser 
      JSONParser 
      +
    -
    +
    + + +
    +
    + diff --git a/javadoc/redempt/redlib/json/package-tree.html b/javadoc/redempt/redlib/json/package-tree.html index c49498f..c755265 100644 --- a/javadoc/redempt/redlib/json/package-tree.html +++ b/javadoc/redempt/redlib/json/package-tree.html @@ -5,101 +5,58 @@ redempt.redlib.json Class Hierarchy (RedLib API) + + - + + - - - - - + + - - -
    +
    + +

    Hierarchy For Package redempt.redlib.json

    -Package Hierarchies: +Package Hierarchies:
    -
    -
    +

    Class Hierarchy

    • java.lang.Object @@ -110,7 +67,7 @@

      Class Hierarchy

      • java.util.ArrayList<E> (implements java.lang.Cloneable, java.util.List<E>, java.util.RandomAccess, java.io.Serializable)
      @@ -121,62 +78,38 @@

      Class Hierarchy

      • java.util.HashMap<K,​V> (implements java.lang.Cloneable, java.util.Map<K,​V>, java.io.Serializable)
      • -
    • redempt.redlib.json.JSONParser
      • +
    • redempt.redlib.json.JSONParser
    -
    +
    +
    diff --git a/javadoc/redempt/redlib/misc/ChatPrompt.CancelReason.html b/javadoc/redempt/redlib/misc/ChatPrompt.CancelReason.html index 83f0722..e845869 100644 --- a/javadoc/redempt/redlib/misc/ChatPrompt.CancelReason.html +++ b/javadoc/redempt/redlib/misc/ChatPrompt.CancelReason.html @@ -5,397 +5,299 @@ ChatPrompt.CancelReason (RedLib API) + + - + + - - - - - + + - - -
    +
    +
    + + + +
    - +
    +
    -
    Package redempt.redlib.misc
    -

    Enum ChatPrompt.CancelReason

    +
    Package redempt.redlib.misc
    +

    Enum ChatPrompt.CancelReason

    -
    -
      -
    • java.lang.Object
      • -
    • - -
      • -
    -
    -
      -
    • -
      +
      java.lang.Object +
      java.lang.Enum<ChatPrompt.CancelReason> +
      redempt.redlib.misc.ChatPrompt.CancelReason
      +
      +
      +
      +
      All Implemented Interfaces:
      -
      java.io.Serializable, java.lang.Comparable<ChatPrompt.CancelReason>
      +
      java.io.Serializable, java.lang.Comparable<ChatPrompt.CancelReason>, java.lang.constant.Constable
      -
      +
      Enclosing class:
      ChatPrompt
      -
      public static enum ChatPrompt.CancelReason
+
      public static enum ChatPrompt.CancelReason
 extends java.lang.Enum<ChatPrompt.CancelReason>
      
+
      +
      +
        + +
      • +
        +

        Nested Class Summary

        +
        +

        Nested classes/interfaces inherited from class java.lang.Enum

        +java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>
        +
        • -
      -
    -
    -
      -
    • -
      -
        -
      • - - -

        Enum Constant Summary

        - - +
      • +
        +

        Enum Constant Summary

        +
        +
        • Enum Constants 
        + + - - + + - - - + + + + - - - + + - - - + + +
        Enum Constants
        Enum ConstantDescriptionEnum ConstantDescription
        PLAYER_CANCELLED +
        PLAYER_CANCELLED
        Passed when the prompt was cancelled because the player typed 'cancel'.
        PLAYER_LEFT +
        PLAYER_LEFT
        Passed when the prompt was cancelled because the player left the server.
        PROMPT_OVERRIDDEN +
        PROMPT_OVERRIDDEN
        Passed when the player was given another prompt.
        -
        • -
      +
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Static Methods Concrete Methods 
      + - - - + + + - - - - + + + + + - - - - + + + +
      Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
      static ChatPrompt.CancelReasonvalueOf​(java.lang.String name) +
      static ChatPrompt.CancelReasonvalueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static ChatPrompt.CancelReason[]values() +
      static ChatPrompt.CancelReason[]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
        • -
      -
      • -
    +
    +
    +
    +

    Methods inherited from class java.lang.Enum

    +clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
    +
    +

    Methods inherited from class java.lang.Object

    +getClass, notify, notifyAll, wait, wait, wait
    - -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Enum Constant Detail

          - - - -
            -
          • -

            PROMPT_OVERRIDDEN

            -
            public static final ChatPrompt.CancelReason PROMPT_OVERRIDDEN
            +
          • +
            +

            Enum Constant Details

            +
              +
            • +
              +

              PROMPT_OVERRIDDEN

              +
              public static final ChatPrompt.CancelReason PROMPT_OVERRIDDEN
              Passed when the player was given another prompt. This prompt is removed and cancelled.
              +
              • -
            - - - -
              -
            • -

              PLAYER_CANCELLED

              -
              public static final ChatPrompt.CancelReason PLAYER_CANCELLED
              +
            • +
              +

              PLAYER_CANCELLED

              +
              public static final ChatPrompt.CancelReason PLAYER_CANCELLED
              Passed when the prompt was cancelled because the player typed 'cancel'.
              +
              • -
            - - - - +
        + -
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            values

            -
            public static ChatPrompt.CancelReason[] values()
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              values

              +
              public static ChatPrompt.CancelReason[] 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 (ChatPrompt.CancelReason c : ChatPrompt.CancelReason.values())
-    System.out.println(c);
-
              -
              -
              Returns:
              +the order they are declared.
    +
    +
    Returns:
    an array containing the constants of this enum type, in the order they are declared
    + - - - - -
      -
    • -

      valueOf

      -
      public static ChatPrompt.CancelReason valueOf​(java.lang.String name)
      +
    • +
      +

      valueOf

      +
      public static ChatPrompt.CancelReason 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:
      +
      +
      Parameters:
      name - the name of the enum constant to be returned.
      -
      Returns:
      +
      Returns:
      the enum constant with the specified name
      -
      Throws:
      +
      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/redempt/redlib/misc/ChatPrompt.html b/javadoc/redempt/redlib/misc/ChatPrompt.html index 51ce64b..706cbde 100644 --- a/javadoc/redempt/redlib/misc/ChatPrompt.html +++ b/javadoc/redempt/redlib/misc/ChatPrompt.html @@ -5,358 +5,268 @@ ChatPrompt (RedLib API) + + - + + - - - - - + + - - -
    +
    +
    + + + +
    - +
    +
    -
    Package redempt.redlib.misc
    -

    Class ChatPrompt

    +
    Package redempt.redlib.misc
    +

    Class ChatPrompt

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.misc.ChatPrompt
        • -
      -
      • -
    -
    -
      -
    • -
      +
      java.lang.Object +
      redempt.redlib.misc.ChatPrompt
      +
      +
      +
      All Implemented Interfaces:
      org.bukkit.event.Listener
      -
      public class ChatPrompt
+
      public class ChatPrompt
 extends java.lang.Object
 implements org.bukkit.event.Listener
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Nested Class Summary

          - - +
        • +
          +

          Nested Class Summary

          +
          +
          • Nested Classes 
          + + - - - + + + - - - - + + + + + + +
          Nested Classes
          Modifier and TypeClassDescriptionModifier and TypeClassDescription
          static class ChatPrompt.CancelReason 
          static class ChatPrompt.CancelReason 
          -
          • -
        +
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Static Methods Instance Methods Concrete Methods 
      + - - - + + + - - - - + + + + + + - - - - + + + + - - - - + + + - - - - + + + +
      Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
      voidonChat​(org.bukkit.event.player.AsyncPlayerChatEvent e) 
      voidonChat​(org.bukkit.event.player.AsyncPlayerChatEvent e) 
      voidonLeave​(org.bukkit.event.player.PlayerQuitEvent e) 
      voidonLeave​(org.bukkit.event.player.PlayerQuitEvent e) 
      static voidprompt​(org.bukkit.entity.Player player, - java.lang.String prompt, - java.util.function.Consumer<java.lang.String> onResponse) +
      static voidprompt​(org.bukkit.entity.Player player, +java.lang.String prompt, +java.util.function.Consumer<java.lang.String> onResponse)
      Prompts a player with callbacks for player response and cancelling
      static voidprompt​(org.bukkit.entity.Player player, - java.lang.String prompt, - java.util.function.Consumer<java.lang.String> onResponse, - java.util.function.Consumer<ChatPrompt.CancelReason> onCancel) +
      static voidprompt​(org.bukkit.entity.Player player, +java.lang.String prompt, +java.util.function.Consumer<java.lang.String> onResponse, +java.util.function.Consumer<ChatPrompt.CancelReason> onCancel)
      Prompts a player with callbacks for player response and cancelling
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

    Methods inherited from class java.lang.Object

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

          Method Detail

          - - - -
            -
          • -

            prompt

            -
            public static void prompt​(org.bukkit.entity.Player player,
-                          java.lang.String prompt,
-                          java.util.function.Consumer<java.lang.String> onResponse,
-                          java.util.function.Consumer<ChatPrompt.CancelReason> onCancel)
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              prompt

              +
              public static void prompt​(org.bukkit.entity.Player player, +java.lang.String prompt, +java.util.function.Consumer<java.lang.String> onResponse, +java.util.function.Consumer<ChatPrompt.CancelReason> onCancel)
              Prompts a player with callbacks for player response and cancelling
              -
              -
              Parameters:
              +
              +
              Parameters:
              player - The player to prompt
              prompt - The prompt to send to the player
              onResponse - The callback for when the player responds
              onCancel - The callback for when the prompt is cancelled
              +
              • -
            - - - -
              -
            • -

              prompt

              -
              public static void prompt​(org.bukkit.entity.Player player,
-                          java.lang.String prompt,
-                          java.util.function.Consumer<java.lang.String> onResponse)
              +
            • +
              +

              prompt

              +
              public static void prompt​(org.bukkit.entity.Player player, +java.lang.String prompt, +java.util.function.Consumer<java.lang.String> onResponse)
              Prompts a player with callbacks for player response and cancelling
              -
              -
              Parameters:
              +
              +
              Parameters:
              player - The player to prompt
              prompt - The prompt to send to the player
              onResponse - The callback for when the player responds
              +
              • -
            - - - -
              -
            • -

              onChat

              -
              public void onChat​(org.bukkit.event.player.AsyncPlayerChatEvent e)
              -
              • -
            - - - -
              -
            • -

              onLeave

              -
              public void onLeave​(org.bukkit.event.player.PlayerQuitEvent e)
              +
            • +
              +

              onChat

              +
              public void onChat​(org.bukkit.event.player.AsyncPlayerChatEvent e)
              +
              • -
            +
          • +
            +

            onLeave

            +
            public void onLeave​(org.bukkit.event.player.PlayerQuitEvent e)
            +
      -
    - - + + + + diff --git a/javadoc/redempt/redlib/misc/EntityPersistor.html b/javadoc/redempt/redlib/misc/EntityPersistor.html index 23a7169..b6070ca 100644 --- a/javadoc/redempt/redlib/misc/EntityPersistor.html +++ b/javadoc/redempt/redlib/misc/EntityPersistor.html @@ -5,213 +5,152 @@ EntityPersistor (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.misc
    -

    Class EntityPersistor<T extends org.bukkit.entity.Entity>

    +
    Package redempt.redlib.misc
    +

    Class EntityPersistor<T extends org.bukkit.entity.Entity>

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.misc.EntityPersistor<T>
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      redempt.redlib.misc.EntityPersistor<T>
      +
      +
      -
      public class EntityPersistor<T extends org.bukkit.entity.Entity>
+
      public class EntityPersistor<T extends org.bukkit.entity.Entity>
 extends java.lang.Object
      
 
      An Entity in Spigot may not persist if the entity it refers to is unloaded, then loaded again at a later time.
  This can make development very annoying, as you have to constantly check whether the Entity is still valid or not.
  EntityPersistor wraps an Entity using a proxy, and anytime a method is called on the Entity, it will check if
  the Entity instance is still valid. If it isn't, it will attempt to replace it with a valid instance by re-fetching
  the Entity from Bukkit.
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Method Summary

          - - +
        • +
          +

          Method Summary

          +
          +
          +
          +
          • All Methods Static Methods Instance Methods Concrete Methods 
          + - - - + + + - - - - + + + + + - - - - + + + - - - - + + + +
          Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
          Tget() +
          Tget()
          Gets the Entity held in this EntityPersistor.
          static <T extends org.bukkit.entity.Entity>
          T          		persist​(T entity) +
          static <T extends org.bukkit.entity.Entity>
          T          		persist​(T entity)
          Wraps an Entity object with a proxy which will attempt to ensure the Entity object remains valid even if the entity's chunk is unloaded, then loaded again.
          static <T extends org.bukkit.entity.Entity>
          EntityPersistor<T>          		wrap​(T entity) +
          static <T extends org.bukkit.entity.Entity>
          EntityPersistor<T>          		wrap​(T entity)
          Wraps an Entity in an EntityPersistor.
          -
            -
          • - - -

            Methods inherited from class java.lang.Object

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

    Methods inherited from class java.lang.Object

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

          Method Detail

          - - - - - -
            -
          • -

            persist

            -
            public static <T extends org.bukkit.entity.Entity> T persist​(T entity)
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              persist

              +
              public static <T extends org.bukkit.entity.Entity> +T persist​(T entity)
              Wraps an Entity object with a proxy which will attempt to ensure the Entity object remains valid even if the entity's chunk is unloaded, then loaded again. Helpful if you need a reference to an Entity over a long period of time which must not be broken. Note that any wrapped Entity will not @@ -219,120 +158,90 @@

              persist

              which has been wrapped, not on another Entity comparing it to this one. This could not be avoided, unfortunately, but as long as you are aware of that, it should work fine. Seems to break in 1.8 because of API fuckery. Use wrap(Entity)
              -
              -
              Type Parameters:
              +
              +
              Type Parameters:
              T - The type of the Entity
              -
              Parameters:
              +
              Parameters:
              entity - The Entity to wrap
              -
              Returns:
              +
              Returns:
              The wrapped Entity
              +
              • -
            - - - - - -
              -
            • -

              wrap

              -
              public static <T extends org.bukkit.entity.Entity> EntityPersistor<T> wrap​(T entity)
              +
            • +
              +

              wrap

              +
              public static <T extends org.bukkit.entity.Entity> +EntityPersistor<T> wrap​(T entity)
              Wraps an Entity in an EntityPersistor. Calling get() will refresh the reference if it is invalid. Use for 1.8
              -
              -
              Type Parameters:
              +
              +
              Type Parameters:
              T - The type of the Entity
              -
              Parameters:
              +
              Parameters:
              entity - The Entity to wrap
              -
              Returns:
              +
              Returns:
              An EntityPersistor wrapping the given Entity
              +
              • -
            - - - -
              -
            • -

              get

              -
              public T get()
              +
            • +
              +

              get

              +
              public T get()
              Gets the Entity held in this EntityPersistor. If the reference is invalid, the EntityPersistor will attempt to refresh it.
              -
              -
              Returns:
              +
              +
              Returns:
              The wrapped Entity
              -
              • -
            +
      -
    -
    - + + + + diff --git a/javadoc/redempt/redlib/misc/EventListener.html b/javadoc/redempt/redlib/misc/EventListener.html index aeaf2a5..10e21f6 100644 --- a/javadoc/redempt/redlib/misc/EventListener.html +++ b/javadoc/redempt/redlib/misc/EventListener.html @@ -5,523 +5,411 @@ EventListener (RedLib API) + + - + + - - - - - + + - - -
    +
    +
    + + + +
    - +
    +
    -
    Package redempt.redlib.misc
    -

    Class EventListener<T extends org.bukkit.event.Event>

    +
    Package redempt.redlib.misc
    +

    Class EventListener<T extends org.bukkit.event.Event>

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.misc.EventListener<T>
        • -
      -
      • -
    -
    -
      -
    • -
      -
      Type Parameters:
      +
      java.lang.Object +
      redempt.redlib.misc.EventListener<T>
      +
      +
      +
      +
      Type Parameters:
      T - The event being listened for
      -
      +
      All Implemented Interfaces:
      org.bukkit.event.Listener
      -
      public class EventListener<T extends org.bukkit.event.Event>
+
      public class EventListener<T extends org.bukkit.event.Event>
 extends java.lang.Object
 implements org.bukkit.event.Listener
      
 
      A compact way to define a Listener using a lambda
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Constructor Summary

          - - +
        • +
          +

          Constructor Summary

          +
          +
          • Constructors 
          + + - - + + - - - + + + + - - - + + - - - + + - - - + + - - - + + - - - + + - - - + + - - - + + +
          Constructors
          ConstructorDescriptionConstructorDescription
          EventListener​(java.lang.Class<T> eventClass, - java.util.function.BiConsumer<EventListener<T>,​T> handler) +
          EventListener​(java.lang.Class<T> eventClass, +java.util.function.BiConsumer<EventListener<T>,​T> handler)
          Creates and registers a Listener for the given event
          EventListener​(java.lang.Class<T> eventClass, - java.util.function.Consumer<T> handler) +
          EventListener​(java.lang.Class<T> eventClass, +java.util.function.Consumer<T> handler)
          Creates and registers a Listener for the given event
          EventListener​(java.lang.Class<T> eventClass, - org.bukkit.event.EventPriority priority, - java.util.function.BiConsumer<EventListener<T>,​T> handler) +
          EventListener​(java.lang.Class<T> eventClass, +org.bukkit.event.EventPriority priority, +java.util.function.BiConsumer<EventListener<T>,​T> handler)
          Creates and registers a Listener for the given event
          EventListener​(java.lang.Class<T> eventClass, - org.bukkit.event.EventPriority priority, - java.util.function.Consumer<T> handler) +
          EventListener​(java.lang.Class<T> eventClass, +org.bukkit.event.EventPriority priority, +java.util.function.Consumer<T> handler)
          Creates and registers a Listener for the given event
          EventListener​(org.bukkit.plugin.Plugin plugin, - java.lang.Class<T> eventClass, - java.util.function.BiConsumer<EventListener<T>,​T> handler) +
          EventListener​(org.bukkit.plugin.Plugin plugin, +java.lang.Class<T> eventClass, +java.util.function.BiConsumer<EventListener<T>,​T> handler)
          Creates and registers a Listener for the given event
          EventListener​(org.bukkit.plugin.Plugin plugin, - java.lang.Class<T> eventClass, - java.util.function.Consumer<T> handler) +
          EventListener​(org.bukkit.plugin.Plugin plugin, +java.lang.Class<T> eventClass, +java.util.function.Consumer<T> handler)
          Creates and registers a Listener for the given event
          EventListener​(org.bukkit.plugin.Plugin plugin, - java.lang.Class<T> eventClass, - org.bukkit.event.EventPriority priority, - java.util.function.BiConsumer<EventListener<T>,​T> handler) +
          EventListener​(org.bukkit.plugin.Plugin plugin, +java.lang.Class<T> eventClass, +org.bukkit.event.EventPriority priority, +java.util.function.BiConsumer<EventListener<T>,​T> handler)
          Creates and registers a Listener for the given event
          EventListener​(org.bukkit.plugin.Plugin plugin, - java.lang.Class<T> eventClass, - org.bukkit.event.EventPriority priority, - java.util.function.Consumer<T> handler) +
          EventListener​(org.bukkit.plugin.Plugin plugin, +java.lang.Class<T> eventClass, +org.bukkit.event.EventPriority priority, +java.util.function.Consumer<T> handler)
          Creates and registers a Listener for the given event
          -
          • -
        +
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Instance Methods Concrete Methods 
      + - - - + + + - - - - + + + + + + - - - - + + + +
      Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
      voidhandleEvent​(T event) 
      voidhandleEvent​(T event) 
      voidunregister() +
      voidunregister()
      Unregisters this listener
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

    Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - -
            -
          • -

            EventListener

            -
            public EventListener​(java.lang.Class<T> eventClass,
-                     org.bukkit.event.EventPriority priority,
-                     java.util.function.BiConsumer<EventListener<T>,​T> handler)
            +
          • +
            +

            Constructor Details

            +
              +
            • +
              +

              EventListener

              +
              public EventListener​(java.lang.Class<T> eventClass, +org.bukkit.event.EventPriority priority, +java.util.function.BiConsumer<EventListener<T>,​T> handler)
              Creates and registers a Listener for the given event
              -
              -
              Parameters:
              +
              +
              Parameters:
              eventClass - The class of the event being listened for
              priority - The EventPriority for this listener
              handler - The callback to receive the event and this EventListener
              +
              • -
            - - - -
              -
            • -

              EventListener

              -
              public EventListener​(org.bukkit.plugin.Plugin plugin,
-                     java.lang.Class<T> eventClass,
-                     org.bukkit.event.EventPriority priority,
-                     java.util.function.BiConsumer<EventListener<T>,​T> handler)
              +
            • +
              +

              EventListener

              +
              public EventListener​(org.bukkit.plugin.Plugin plugin, +java.lang.Class<T> eventClass, +org.bukkit.event.EventPriority priority, +java.util.function.BiConsumer<EventListener<T>,​T> handler)
              Creates and registers a Listener for the given event
              -
              -
              Parameters:
              +
              +
              Parameters:
              plugin - The plugin registering the listener
              eventClass - The class of the event being listened for
              priority - The EventPriority for this listener
              handler - The callback to receive the event and this EventListener
              +
              • -
            - - - -
              -
            • -

              EventListener

              -
              public EventListener​(java.lang.Class<T> eventClass,
-                     org.bukkit.event.EventPriority priority,
-                     java.util.function.Consumer<T> handler)
              +
            • +
              +

              EventListener

              +
              public EventListener​(java.lang.Class<T> eventClass, +org.bukkit.event.EventPriority priority, +java.util.function.Consumer<T> handler)
              Creates and registers a Listener for the given event
              -
              -
              Parameters:
              +
              +
              Parameters:
              eventClass - The class of the event being listened for
              priority - The EventPriority for this listener
              handler - The callback to receive the event
              +
              • -
            - - - -
              -
            • -

              EventListener

              -
              public EventListener​(org.bukkit.plugin.Plugin plugin,
-                     java.lang.Class<T> eventClass,
-                     org.bukkit.event.EventPriority priority,
-                     java.util.function.Consumer<T> handler)
              +
            • +
              +

              EventListener

              +
              public EventListener​(org.bukkit.plugin.Plugin plugin, +java.lang.Class<T> eventClass, +org.bukkit.event.EventPriority priority, +java.util.function.Consumer<T> handler)
              Creates and registers a Listener for the given event
              -
              -
              Parameters:
              +
              +
              Parameters:
              plugin - The plugin registering the listener
              eventClass - The class of the event being listened for
              priority - The EventPriority for this listener
              handler - The callback to receive the event
              +
              • -
            - - - -
              -
            • -

              EventListener

              -
              public EventListener​(java.lang.Class<T> eventClass,
-                     java.util.function.BiConsumer<EventListener<T>,​T> handler)
              +
            • +
              +

              EventListener

              +
              public EventListener​(java.lang.Class<T> eventClass, +java.util.function.BiConsumer<EventListener<T>,​T> handler)
              Creates and registers a Listener for the given event
              -
              -
              Parameters:
              +
              +
              Parameters:
              eventClass - The class of the event being listened for
              handler - The callback to receive the event and this EventListener
              +
              • -
            - - - -
              -
            • -

              EventListener

              -
              public EventListener​(org.bukkit.plugin.Plugin plugin,
-                     java.lang.Class<T> eventClass,
-                     java.util.function.BiConsumer<EventListener<T>,​T> handler)
              +
            • +
              +

              EventListener

              +
              public EventListener​(org.bukkit.plugin.Plugin plugin, +java.lang.Class<T> eventClass, +java.util.function.BiConsumer<EventListener<T>,​T> handler)
              Creates and registers a Listener for the given event
              -
              -
              Parameters:
              +
              +
              Parameters:
              plugin - The plugin registering the listener
              eventClass - The class of the event being listened for
              handler - The callback to receive the event and this EventListener
              +
              • -
            - - - -
              -
            • -

              EventListener

              -
              public EventListener​(java.lang.Class<T> eventClass,
-                     java.util.function.Consumer<T> handler)
              +
            • +
              +

              EventListener

              +
              public EventListener​(java.lang.Class<T> eventClass, +java.util.function.Consumer<T> handler)
              Creates and registers a Listener for the given event
              -
              -
              Parameters:
              +
              +
              Parameters:
              eventClass - The class of the event being listened for
              handler - The callback to receive the event
              +
              • -
            - - - -
              -
            • -

              EventListener

              -
              public EventListener​(org.bukkit.plugin.Plugin plugin,
-                     java.lang.Class<T> eventClass,
-                     java.util.function.Consumer<T> handler)
              +
            • +
              +

              EventListener

              +
              public EventListener​(org.bukkit.plugin.Plugin plugin, +java.lang.Class<T> eventClass, +java.util.function.Consumer<T> handler)
              Creates and registers a Listener for the given event
              -
              -
              Parameters:
              +
              +
              Parameters:
              plugin - The plugin registering the listener
              eventClass - The class of the event being listened for
              handler - The callback to receive the event
              -
              • -
            +
        + -
        -
          -
        • - - -

          Method Detail

          - - - - - -
            -
          • -

            handleEvent

            -
            public void handleEvent​(T event)
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              handleEvent

              +
              public void handleEvent​(T event)
              +
              • -
            - - - -
              -
            • -

              unregister

              -
              public void unregister()
              +
            • +
              +

              unregister

              +
              public void unregister()
              Unregisters this listener
              -
              • -
            +
      -
    - - + + + + diff --git a/javadoc/redempt/redlib/misc/FormatUtils.html b/javadoc/redempt/redlib/misc/FormatUtils.html index fd51389..08fd4d5 100644 --- a/javadoc/redempt/redlib/misc/FormatUtils.html +++ b/javadoc/redempt/redlib/misc/FormatUtils.html @@ -5,500 +5,390 @@ FormatUtils (RedLib API) + + - + + - - - - - + + - - -
    +
    +
    + + + +
    - +
    +
    -
    Package redempt.redlib.misc
    -

    Class FormatUtils

    +
    Package redempt.redlib.misc
    +

    Class FormatUtils

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.misc.FormatUtils
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      redempt.redlib.misc.FormatUtils
      +
      +
      -
      public class FormatUtils
+
      public class FormatUtils
 extends java.lang.Object
      
 
      Contains utilities for formatting various information
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Constructor Summary

          - - +
        • +
          +

          Constructor Summary

          +
          +
          • Constructors 
          + + - - + + - - - + + + + + +
          Constructors
          ConstructorDescriptionConstructorDescription
          FormatUtils() 
          FormatUtils() 
          -
          • -
        +
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Static Methods Concrete Methods 
      + - - - + + + - - - - + + + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + +
      Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
      static java.lang.Stringcolor​(java.lang.String input) +
      static java.lang.Stringcolor​(java.lang.String input)
      Shorthand for ChatColor.translateAlternateColorCodes(char, String)
      static java.lang.StringformatLargeInteger​(long num) +
      static java.lang.StringformatLargeInteger​(long num)
      Formats a large number with commas, like 12345 as 12,345
      static java.lang.StringformatMoney​(double money) +
      static java.lang.StringformatMoney​(double money)
      Formats money like 3.5B representing 3.5 billion
      static java.lang.StringformatTimeOffset​(long millis) +
      static java.lang.StringformatTimeOffset​(long millis)
      Formats a time offset like 1h3m8s (1 hour, 3 minutes, 8 seconds)
      static java.lang.StringformatTimeOffset​(long millis, - int truncate) +
      static java.lang.StringformatTimeOffset​(long millis, +int truncate)
      Formats a time offset like 1h3m8s (1 hour, 3 minutes, 8 seconds)
      static java.util.List<java.lang.String>lineWrap​(java.lang.String line, - int maxLength) +
      static java.util.List<java.lang.String>lineWrap​(java.lang.String line, +int maxLength)
      Splits a line of text across multiple lines, attempting to limit the length of each line
      static java.lang.StringtoCamelCase​(java.lang.String string) +
      static java.lang.StringtoCamelCase​(java.lang.String string)
      Converts a string to camelCase, where every character after a space is capitalized.
      static java.lang.StringtoTitleCase​(java.lang.String string) +
      static java.lang.StringtoTitleCase​(java.lang.String string)
      Converts a string to Title Case, where the first character and every character after a space is capitalized.
      static java.lang.StringtruncateDouble​(double input) +
      static java.lang.StringtruncateDouble​(double input)
      Truncates a double using a DecimalFormat with 0.00 as its format string
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

    Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - -
            -
          • -

            FormatUtils

            -
            public FormatUtils()
            -
            • -
          +
        • +
          +

          Constructor Details

          +
            +
          • +
            +

            FormatUtils

            +
            public FormatUtils()
            +
          +
          • -
          -
            -
          • - - -

            Method Detail

            - - - -
              -
            • -

              formatTimeOffset

              -
              public static java.lang.String formatTimeOffset​(long millis,
-                                                int truncate)
              +
            • +
              +

              Method Details

              +
                +
              • +
                +

                formatTimeOffset

                +
                public static java.lang.String formatTimeOffset​(long millis, +int truncate)
                Formats a time offset like 1h3m8s (1 hour, 3 minutes, 8 seconds)
                -
                -
                Parameters:
                +
                +
                Parameters:
                millis - The time offset, in milliseconds
                truncate - The number of units to truncate - 1 for seconds, 2 for seconds and minutes, 3 for seconds, minutes, and hours
                -
                Returns:
                +
                Returns:
                The formatted string
                +
                • -
              - - - -
                -
              • -

                formatTimeOffset

                -
                public static java.lang.String formatTimeOffset​(long millis)
                +
              • +
                +

                formatTimeOffset

                +
                public static java.lang.String formatTimeOffset​(long millis)
                Formats a time offset like 1h3m8s (1 hour, 3 minutes, 8 seconds)
                -
                -
                Parameters:
                +
                +
                Parameters:
                millis - The time offset, in milliseconds
                -
                Returns:
                +
                Returns:
                The formatted string
                +
                • -
              - - - -
                -
              • -

                truncateDouble

                -
                public static java.lang.String truncateDouble​(double input)
                +
              • +
                +

                truncateDouble

                +
                public static java.lang.String truncateDouble​(double input)
                Truncates a double using a DecimalFormat with 0.00 as its format string
                -
                -
                Parameters:
                +
                +
                Parameters:
                input - The input double
                -
                Returns:
                +
                Returns:
                The formatted double
                +
                • -
              - - - -
                -
              • -

                color

                -
                public static java.lang.String color​(java.lang.String input)
                +
              • +
                +

                color

                +
                public static java.lang.String color​(java.lang.String input)
                Shorthand for ChatColor.translateAlternateColorCodes(char, String)
                -
                -
                Parameters:
                +
                +
                Parameters:
                input - The input string
                -
                Returns:
                +
                Returns:
                The colored string, replacing color codes using ampersands with proper codes
                +
                • -
              - - - -
                -
              • -

                formatMoney

                -
                public static java.lang.String formatMoney​(double money)
                +
              • +
                +

                formatMoney

                +
                public static java.lang.String formatMoney​(double money)
                Formats money like 3.5B representing 3.5 billion
                -
                -
                Parameters:
                +
                +
                Parameters:
                money - The money
                -
                Returns:
                +
                Returns:
                The formatted output string
                +
                • -
              - - - -
                -
              • -

                formatLargeInteger

                -
                public static java.lang.String formatLargeInteger​(long num)
                +
              • +
                +

                formatLargeInteger

                +
                public static java.lang.String formatLargeInteger​(long num)
                Formats a large number with commas, like 12345 as 12,345
                -
                -
                Parameters:
                +
                +
                Parameters:
                num - The number to format
                -
                Returns:
                +
                Returns:
                The formatted String representing the number
                +
                • -
              - - - -
                -
              • -

                toTitleCase

                -
                public static java.lang.String toTitleCase​(java.lang.String string)
                +
              • +
                +

                toTitleCase

                +
                public static java.lang.String toTitleCase​(java.lang.String string)
                Converts a string to Title Case, where the first character and every character after a space is capitalized. Preserves spaces.
                -
                -
                Parameters:
                +
                +
                Parameters:
                string - The string to convert to Title Case
                -
                Returns:
                +
                Returns:
                The Title Case string
                +
                • -
              - - - -
                -
              • -

                toCamelCase

                -
                public static java.lang.String toCamelCase​(java.lang.String string)
                +
              • +
                +

                toCamelCase

                +
                public static java.lang.String toCamelCase​(java.lang.String string)
                Converts a string to camelCase, where every character after a space is capitalized. Removes spaces.
                -
                -
                Parameters:
                +
                +
                Parameters:
                string - The string to convert to camelCase
                -
                Returns:
                +
                Returns:
                The camelCase string
                +
                • -
              - - - -
                -
              • -

                lineWrap

                -
                public static java.util.List<java.lang.String> lineWrap​(java.lang.String line,
-                                                        int maxLength)
                +
              • +
                +

                lineWrap

                +
                public static java.util.List<java.lang.String> lineWrap​(java.lang.String line, +int maxLength)
                Splits a line of text across multiple lines, attempting to limit the length of each line
                -
                -
                Parameters:
                +
                +
                Parameters:
                line - The line to wrap
                maxLength - The max length to cap each line at
                -
                Returns:
                +
                Returns:
                The list of separate lines
                -
                • -
              +
        -
    - - + + + + diff --git a/javadoc/redempt/redlib/misc/Hologram.html b/javadoc/redempt/redlib/misc/Hologram.html index 5f1a91d..5ca4af9 100644 --- a/javadoc/redempt/redlib/misc/Hologram.html +++ b/javadoc/redempt/redlib/misc/Hologram.html @@ -5,588 +5,457 @@ Hologram (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.misc
    -

    Class Hologram

    +
    Package redempt.redlib.misc
    +

    Class Hologram

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.misc.Hologram
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      redempt.redlib.misc.Hologram
      +
      +
      -
      public class Hologram
+
      public class Hologram
 extends java.lang.Object
      
 
      Represents a number of floating armor stands intended to display information
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Method Summary

          - - +
        • +
          +

          Method Summary

          +
          +
          +
          +
          • All Methods Static Methods Instance Methods Concrete Methods 
          + - - - + + + - - - - + + + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + + +
          Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
          voidappend​(java.lang.String text) +
          voidappend​(java.lang.String text)
          Adds a line at the bottom of this Hologram
          voidclear() +
          voidclear()
          Clears this Hologram
          static Hologramcreate​(org.bukkit.Location loc, - java.lang.String... lines) +
          static Hologramcreate​(org.bukkit.Location loc, +java.lang.String... lines)
          Creates a Hologram
          voidfixStands() +
          voidfixStands()
          Removes and re-adds all armor stands in this Hologram
          static HologramgetAt​(org.bukkit.Location loc) +
          static HologramgetAt​(org.bukkit.Location loc)
          Attempts to get a Hologram at a specified location
          java.lang.StringgetLine​(int line) 
          java.lang.StringgetLine​(int line) 
          java.util.List<java.lang.String>getLines() 
          java.util.List<java.lang.String>getLines() 
          doublegetLineSpacing() 
          doublegetLineSpacing() 
          org.bukkit.LocationgetLocation() 
          org.bukkit.LocationgetLocation() 
          java.util.List<org.bukkit.entity.ArmorStand>getStands() 
          java.util.List<org.bukkit.entity.ArmorStand>getStands() 
          voidinsert​(int line, - java.lang.String text) +
          voidinsert​(int line, +java.lang.String text)
          Inserts a line in this Hologram
          voidmove​(org.bukkit.Location loc) +
          voidmove​(org.bukkit.Location loc)
          Moves this Hologram
          voidprepend​(java.lang.String text) +
          voidprepend​(java.lang.String text)
          Adds a line at the top of this Hologram
          voidremove​(int line) +
          voidremove​(int line)
          Removes a line from this Hologram
          voidsetLine​(int line, - java.lang.String text) +
          voidsetLine​(int line, +java.lang.String text)
          Sets the text for a line of this Hologram
          voidsetLineSpacing​(double lineSpacing) +
          voidsetLineSpacing​(double lineSpacing)
          Sets the vertical distance between each line in this Hologram
          intsize() 
          intsize() 
          -
            -
          • - - -

            Methods inherited from class java.lang.Object

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

    Methods inherited from class java.lang.Object

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

          Method Detail

          - - - -
            -
          • -

            create

            -
            public static Hologram create​(org.bukkit.Location loc,
-                              java.lang.String... lines)
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              create

              +
              public static Hologram create​(org.bukkit.Location loc, +java.lang.String... lines)
              Creates a Hologram
              -
              -
              Parameters:
              +
              +
              Parameters:
              loc - The location to create the Hologram at
              lines - The lines of text for this Hologram
              -
              Returns:
              +
              Returns:
              The Hologram that was created
              +
              • -
            - - - -
              -
            • -

              getAt

              -
              public static Hologram getAt​(org.bukkit.Location loc)
              +
            • +
              +

              getAt

              +
              public static Hologram getAt​(org.bukkit.Location loc)
              Attempts to get a Hologram at a specified location
              -
              -
              Parameters:
              +
              +
              Parameters:
              loc - The location to check at
              -
              Returns:
              +
              Returns:
              The Hologram found at the location, or null if none was found
              +
              • -
            - - - -
              -
            • -

              fixStands

              -
              public void fixStands()
              +
            • +
              +

              fixStands

              +
              public void fixStands()
              Removes and re-adds all armor stands in this Hologram
              +
              • -
            - - - -
              -
            • -

              getLine

              -
              public java.lang.String getLine​(int line)
              -
              -
              Parameters:
              +
            • +
              +

              getLine

              +
              public java.lang.String getLine​(int line)
              +
              +
              Parameters:
              line - The index of the line
              -
              Returns:
              +
              Returns:
              The line of text at the given index
              +
              • -
            - - - -
              -
            • -

              move

              -
              public void move​(org.bukkit.Location loc)
              +
            • +
              +

              move

              +
              public void move​(org.bukkit.Location loc)
              Moves this Hologram
              -
              -
              Parameters:
              +
              +
              Parameters:
              loc - The location to move this Hologram to
              +
              • -
            - - - -
              -
            • -

              getLocation

              -
              public org.bukkit.Location getLocation()
              -
              -
              Returns:
              +
            • +
              +

              getLocation

              +
              public org.bukkit.Location getLocation()
              +
              +
              Returns:
              The location of the top of this Hologram
              +
              • -
            - - - -
              -
            • -

              getStands

              -
              public java.util.List<org.bukkit.entity.ArmorStand> getStands()
              -
              -
              Returns:
              +
            • +
              +

              getStands

              +
              public java.util.List<org.bukkit.entity.ArmorStand> getStands()
              +
              +
              Returns:
              All the ArmorStands in this Hologram
              +
              • -
            - - - -
              -
            • -

              setLine

              -
              public void setLine​(int line,
-                    java.lang.String text)
              +
            • +
              +

              setLine

              +
              public void setLine​(int line, +java.lang.String text)
              Sets the text for a line of this Hologram
              -
              -
              Parameters:
              +
              +
              Parameters:
              line - The index of the line to set
              text - The text to set the line to
              +
              • -
            - - - -
              -
            • -

              remove

              -
              public void remove​(int line)
              +
            • +
              +

              remove

              +
              public void remove​(int line)
              Removes a line from this Hologram
              -
              -
              Parameters:
              +
              +
              Parameters:
              line - The line number to remove
              +
              • -
            - - - -
              -
            • -

              clear

              -
              public void clear()
              +
            • +
              +

              clear

              +
              public void clear()
              Clears this Hologram
              +
              • -
            - - - -
              -
            • -

              getLineSpacing

              -
              public double getLineSpacing()
              -
              -
              Returns:
              +
            • +
              +

              getLineSpacing

              +
              public double getLineSpacing()
              +
              +
              Returns:
              The vertical distance between each line in this Hologram
              +
              • -
            - - - -
              -
            • -

              setLineSpacing

              -
              public void setLineSpacing​(double lineSpacing)
              +
            • +
              +

              setLineSpacing

              +
              public void setLineSpacing​(double lineSpacing)
              Sets the vertical distance between each line in this Hologram
              -
              -
              Parameters:
              +
              +
              Parameters:
              lineSpacing - The line spacing to set
              +
              • -
            - - - -
              -
            • -

              append

              -
              public void append​(java.lang.String text)
              +
            • +
              +

              append

              +
              public void append​(java.lang.String text)
              Adds a line at the bottom of this Hologram
              -
              -
              Parameters:
              +
              +
              Parameters:
              text - The text to append
              +
              • -
            - - - -
              -
            • -

              prepend

              -
              public void prepend​(java.lang.String text)
              +
            • +
              +

              prepend

              +
              public void prepend​(java.lang.String text)
              Adds a line at the top of this Hologram
              -
              -
              Parameters:
              +
              +
              Parameters:
              text - The text to add
              +
              • -
            - - - -
              -
            • -

              insert

              -
              public void insert​(int line,
-                   java.lang.String text)
              +
            • +
              +

              insert

              +
              public void insert​(int line, +java.lang.String text)
              Inserts a line in this Hologram
              -
              -
              Parameters:
              +
              +
              Parameters:
              line - The position to insert at
              text - The text to insert
              +
              • -
            - - - -
              -
            • -

              size

              -
              public int size()
              -
              -
              Returns:
              +
            • +
              +

              size

              +
              public int size()
              +
              +
              Returns:
              The number of lines in this Hologram
              +
              • -
            - - - -
              -
            • -

              getLines

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

            getLines

            +
            public java.util.List<java.lang.String> getLines()
            +
      -
    -
    - + + + + diff --git a/javadoc/redempt/redlib/misc/LocationUtils.html b/javadoc/redempt/redlib/misc/LocationUtils.html index 2f2dacd..d57ed93 100644 --- a/javadoc/redempt/redlib/misc/LocationUtils.html +++ b/javadoc/redempt/redlib/misc/LocationUtils.html @@ -5,955 +5,797 @@ LocationUtils (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.misc
    -

    Class LocationUtils

    +
    Package redempt.redlib.misc
    +

    Class LocationUtils

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.misc.LocationUtils
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      redempt.redlib.misc.LocationUtils
      +
      +
      -
      public class LocationUtils
+
      public class LocationUtils
 extends java.lang.Object
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Field Summary

          - - +
        • +
          +

          Field Summary

          +
          +
          • Fields 
          + + - - - + + + - - - - + + + + + +
          Fields
          Modifier and TypeFieldDescriptionModifier and TypeFieldDescription
          static org.bukkit.block.BlockFace[]PRIMARY_BLOCK_FACES +
          static org.bukkit.block.BlockFace[]PRIMARY_BLOCK_FACES
          An array of all the block faces which face in a single direction (positive X, negative X, etc.)
          -
          • -
        +
    + -
    -
      -
    • - - -

      Constructor Summary

      - - +
    • +
      +

      Constructor Summary

      +
      +
      • Constructors 
      + + - - + + - - - + + + + + +
      Constructors
      ConstructorDescriptionConstructorDescription
      LocationUtils() 
      LocationUtils() 
      -
      • -
    +
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Static Methods Concrete Methods 
      + - - - + + + - - - - + + + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + +
      Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
      static org.bukkit.Locationcenter​(org.bukkit.block.Block block) +
      static org.bukkit.Locationcenter​(org.bukkit.block.Block block)
      Returns the Location at the center of a Block - shorthand
      static org.bukkit.Locationcenter​(org.bukkit.Location loc) +
      static org.bukkit.Locationcenter​(org.bukkit.Location loc)
      Sets the location's coordinates to the center point of its block coordinates, then returns it
      static voiddelayedTeleport​(org.bukkit.entity.Player player, - org.bukkit.Location loc, - int ticks) +
      static voiddelayedTeleport​(org.bukkit.entity.Player player, +org.bukkit.Location loc, +int ticks)
      Initiates a delayed teleport for a player which will be cancelled if the player moves.
      static voiddelayedTeleport​(org.bukkit.entity.Player player, - org.bukkit.Location loc, - int ticks, - java.util.function.Consumer<java.lang.Boolean> result) +
      static voiddelayedTeleport​(org.bukkit.entity.Player player, +org.bukkit.Location loc, +int ticks, +java.util.function.Consumer<java.lang.Boolean> result)
      Initiates a delayed teleport for a player which will be cancelled if the player moves.
      static java.util.List<org.bukkit.Location>directPathfind​(org.bukkit.block.Block start, - org.bukkit.block.Block end, - int max) +
      static java.util.List<org.bukkit.Location>directPathfind​(org.bukkit.block.Block start, +org.bukkit.block.Block end, +int max)
      Finds the fastest path between a starting and ending location using A*, then removes unneeded steps for straight
      static java.util.List<org.bukkit.Location>directPathfind​(org.bukkit.block.Block start, - org.bukkit.block.Block end, - int max, - java.util.function.Predicate<org.bukkit.block.Block> filter) +
      static java.util.List<org.bukkit.Location>directPathfind​(org.bukkit.block.Block start, +org.bukkit.block.Block end, +int max, +java.util.function.Predicate<org.bukkit.block.Block> filter)
      Finds the fastest path between a starting and ending location using A*, then removes unneeded steps for straight
      static org.bukkit.LocationfromString​(java.lang.String string) +
      static org.bukkit.LocationfromString​(java.lang.String string)
      Converts a String back to a Location.
      static org.bukkit.LocationfromString​(java.lang.String string, - java.lang.String separator) +
      static org.bukkit.LocationfromString​(java.lang.String string, +java.lang.String separator)
      Converts a String back to a Location
      static voidfromStringLater​(java.lang.String string, - java.lang.String separator, - java.util.function.Consumer<org.bukkit.Location> callback) +
      static voidfromStringLater​(java.lang.String string, +java.lang.String separator, +java.util.function.Consumer<org.bukkit.Location> callback)
      Loads a Location from a String.
      static voidfromStringLater​(java.lang.String string, - java.util.function.Consumer<org.bukkit.Location> callback) +
      static voidfromStringLater​(java.lang.String string, +java.util.function.Consumer<org.bukkit.Location> callback)
      Loads a Location from a String.
      static int[]getChunkCoordinates​(org.bukkit.Location loc) +
      static int[]getChunkCoordinates​(org.bukkit.Location loc)
      Gets the chunk X and Z of a location
      static org.bukkit.util.VectorgetDirection​(org.bukkit.block.BlockFace face) +
      static org.bukkit.util.VectorgetDirection​(org.bukkit.block.BlockFace face)
      Gets the Vector direction of a BlockFace.
      static org.bukkit.LocationgetNearestSafeLocation​(org.bukkit.Location loc, - int maxDistance) +
      static org.bukkit.LocationgetNearestSafeLocation​(org.bukkit.Location loc, +int maxDistance)
      Gets the nearest safe location to the given location within the given distance
      static org.bukkit.LocationgetNearestSafeLocation​(org.bukkit.Location loc, - int maxDistance, - java.util.function.Predicate<org.bukkit.Location> filter) +
      static org.bukkit.LocationgetNearestSafeLocation​(org.bukkit.Location loc, +int maxDistance, +java.util.function.Predicate<org.bukkit.Location> filter)
      Gets the nearest safe location to the given location within the given distance passing the given predicate check
      static booleanisHazard​(org.bukkit.Material type) +
      static booleanisHazard​(org.bukkit.Material type)
      Checks if a given block type is a hazard - whether it would damage the player if they were on top of it
      static booleanisSafe​(org.bukkit.Location loc) +
      static booleanisSafe​(org.bukkit.Location loc)
      Checks whether the given location is safe to teleport a player to - that a player would not be damaged as a result of being moved to this location
      static java.util.Deque<org.bukkit.Location>pathfind​(org.bukkit.block.Block start, - org.bukkit.block.Block end, - int max) +
      static java.util.Deque<org.bukkit.Location>pathfind​(org.bukkit.block.Block start, +org.bukkit.block.Block end, +int max)
      Finds the fastest path between a starting and ending location using A*
      static java.util.Deque<org.bukkit.Location>pathfind​(org.bukkit.block.Block start, - org.bukkit.block.Block end, - int max, - java.util.function.Predicate<org.bukkit.block.Block> filter) +
      static java.util.Deque<org.bukkit.Location>pathfind​(org.bukkit.block.Block start, +org.bukkit.block.Block end, +int max, +java.util.function.Predicate<org.bukkit.block.Block> filter)
      Finds the fastest path between a starting and ending location using A*
      static org.bukkit.LocationtoBlockLocation​(org.bukkit.Location loc) +
      static org.bukkit.LocationtoBlockLocation​(org.bukkit.Location loc)
      Sets the location's coordinates to its block coordinates, then returns it
      static java.lang.StringtoString​(org.bukkit.block.Block block) +
      static java.lang.StringtoString​(org.bukkit.block.Block block)
      Converts a Location to a String representing its location
      static java.lang.StringtoString​(org.bukkit.block.Block block, - java.lang.String separator) +
      static java.lang.StringtoString​(org.bukkit.block.Block block, +java.lang.String separator)
      Converts a Location to a String representing its location
      static java.lang.StringtoString​(org.bukkit.Location loc) +
      static java.lang.StringtoString​(org.bukkit.Location loc)
      Converts a Location to a String.
      static java.lang.StringtoString​(org.bukkit.Location loc, - java.lang.String separator) +
      static java.lang.StringtoString​(org.bukkit.Location loc, +java.lang.String separator)
      Converts a Location to a String
      static voidwaitForWorld​(java.lang.String worldname, - java.util.function.Consumer<org.bukkit.World> callback) +
      static voidwaitForWorld​(java.lang.String worldname, +java.util.function.Consumer<org.bukkit.World> callback)
      Waits for a world with the given name to load before calling the callback
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

    Methods inherited from class java.lang.Object

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

          Field Detail

          - - - -
            -
          • -

            PRIMARY_BLOCK_FACES

            -
            public static final org.bukkit.block.BlockFace[] PRIMARY_BLOCK_FACES
            +
          • +
            +

            Field Details

            +
              +
            • +
              +

              PRIMARY_BLOCK_FACES

              +
              public static final org.bukkit.block.BlockFace[] PRIMARY_BLOCK_FACES
              An array of all the block faces which face in a single direction (positive X, negative X, etc.)
              -
              • -
            +
        - -
        -
          -
        • - - -

          Constructor Detail

          - - - -
            -
          • -

            LocationUtils

            -
            public LocationUtils()
            • -
          + +
        • +
          +

          Constructor Details

          +
            +
          • +
            +

            LocationUtils

            +
            public LocationUtils()
            +
          +
          • -
          -
            -
          • - - -

            Method Detail

            - - - -
              -
            • -

              isHazard

              -
              public static boolean isHazard​(org.bukkit.Material type)
              +
            • +
              +

              Method Details

              +
                +
              • +
                +

                isHazard

                +
                public static boolean isHazard​(org.bukkit.Material type)
                Checks if a given block type is a hazard - whether it would damage the player if they were on top of it
                -
                -
                Parameters:
                +
                +
                Parameters:
                type - The type to check
                -
                Returns:
                +
                Returns:
                Whether the block type is a hazard
                +
                • -
              - - - -
                -
              • -

                isSafe

                -
                public static boolean isSafe​(org.bukkit.Location loc)
                +
              • +
                +

                isSafe

                +
                public static boolean isSafe​(org.bukkit.Location loc)
                Checks whether the given location is safe to teleport a player to - that a player would not be damaged as a result of being moved to this location
                -
                -
                Parameters:
                +
                +
                Parameters:
                loc - The location to check
                -
                Returns:
                +
                Returns:
                Whether the given location is safe
                +
                • -
              - - - -
                -
              • -

                getNearestSafeLocation

                -
                public static org.bukkit.Location getNearestSafeLocation​(org.bukkit.Location loc,
-                                                         int maxDistance,
-                                                         java.util.function.Predicate<org.bukkit.Location> filter)
                +
              • +
                +

                getNearestSafeLocation

                +
                public static org.bukkit.Location getNearestSafeLocation​(org.bukkit.Location loc, +int maxDistance, +java.util.function.Predicate<org.bukkit.Location> filter)
                Gets the nearest safe location to the given location within the given distance passing the given predicate check
                -
                -
                Parameters:
                +
                +
                Parameters:
                loc - The location to find the nearest safe location to
                maxDistance - The maximum distance to check from this location
                filter - Used to filter safe locations that you still don't want to send the player to. Any locations this returns false for will be ignored.
                -
                Returns:
                +
                Returns:
                The nearest safe location, or null if one was not found
                +
                • -
              - - - -
                -
              • -

                getNearestSafeLocation

                -
                public static org.bukkit.Location getNearestSafeLocation​(org.bukkit.Location loc,
-                                                         int maxDistance)
                +
              • +
                +

                getNearestSafeLocation

                +
                public static org.bukkit.Location getNearestSafeLocation​(org.bukkit.Location loc, +int maxDistance)
                Gets the nearest safe location to the given location within the given distance
                -
                -
                Parameters:
                +
                +
                Parameters:
                loc - The location to find the nearest safe location to
                maxDistance - The maximum distance to check from this location
                -
                Returns:
                +
                Returns:
                The nearest safe location, or null if one was not found
                +
                • -
              - - - -
                -
              • -

                getDirection

                -
                public static org.bukkit.util.Vector getDirection​(org.bukkit.block.BlockFace face)
                +
              • +
                +

                getDirection

                +
                public static org.bukkit.util.Vector getDirection​(org.bukkit.block.BlockFace face)
                Gets the Vector direction of a BlockFace. For use in versions below 1.13.
                -
                -
                Parameters:
                +
                +
                Parameters:
                face - The block face
                -
                Returns:
                +
                Returns:
                The vector representing the direction
                +
                • -
              - - - -
                -
              • -

                delayedTeleport

                -
                public static void delayedTeleport​(org.bukkit.entity.Player player,
-                                   org.bukkit.Location loc,
-                                   int ticks,
-                                   java.util.function.Consumer<java.lang.Boolean> result)
                +
              • +
                +

                delayedTeleport

                +
                public static void delayedTeleport​(org.bukkit.entity.Player player, +org.bukkit.Location loc, +int ticks, +java.util.function.Consumer<java.lang.Boolean> result)
                Initiates a delayed teleport for a player which will be cancelled if the player moves. The messages relevant to this will be sent automatically.
                -
                -
                Parameters:
                +
                +
                Parameters:
                player - The player to teleport
                loc - The location to teleport the player to after the delay
                ticks - The delay for the teleport, in ticks
                result - A lambda to handle the result, given true if the teleport succeeded, false otherwise
                +
                • -
              - - - -
                -
              • -

                delayedTeleport

                -
                public static void delayedTeleport​(org.bukkit.entity.Player player,
-                                   org.bukkit.Location loc,
-                                   int ticks)
                +
              • +
                +

                delayedTeleport

                +
                public static void delayedTeleport​(org.bukkit.entity.Player player, +org.bukkit.Location loc, +int ticks)
                Initiates a delayed teleport for a player which will be cancelled if the player moves. The messages relevant to this will be sent automatically.
                -
                -
                Parameters:
                +
                +
                Parameters:
                player - The player to teleport
                loc - The location to teleport the player to after the delay
                ticks - The delay for the teleport, in ticks
                +
                • -
              - - - -
                -
              • -

                toString

                -
                public static java.lang.String toString​(org.bukkit.Location loc,
-                                        java.lang.String separator)
                +
              • +
                +

                toString

                +
                public static java.lang.String toString​(org.bukkit.Location loc, +java.lang.String separator)
                Converts a Location to a String
                -
                -
                Parameters:
                +
                +
                Parameters:
                loc - The Location to be stringified
                separator - The separator to use between pieces of information
                -
                Returns:
                +
                Returns:
                The stringified Location
                +
                • -
              - - - -
                -
              • -

                fromString

                -
                public static org.bukkit.Location fromString​(java.lang.String string,
-                                             java.lang.String separator)
                +
              • +
                +

                fromString

                +
                public static org.bukkit.Location fromString​(java.lang.String string, +java.lang.String separator)
                Converts a String back to a Location
                -
                -
                Parameters:
                +
                +
                Parameters:
                string - The stringified Location
                separator - The separator that was used in toString
                -
                Returns:
                +
                Returns:
                The Location
                +
                • -
              - - - -
                -
              • -

                toString

                -
                public static java.lang.String toString​(org.bukkit.block.Block block,
-                                        java.lang.String separator)
                +
              • +
                +

                toString

                +
                public static java.lang.String toString​(org.bukkit.block.Block block, +java.lang.String separator)
                Converts a Location to a String representing its location
                -
                -
                Parameters:
                +
                +
                Parameters:
                block - The Block location to be stringified
                separator - The separator to use between pieces of information
                -
                Returns:
                +
                Returns:
                The stringified location
                +
                • -
              - - - -
                -
              • -

                toString

                -
                public static java.lang.String toString​(org.bukkit.block.Block block)
                +
              • +
                +

                toString

                +
                public static java.lang.String toString​(org.bukkit.block.Block block)
                Converts a Location to a String representing its location
                -
                -
                Parameters:
                +
                +
                Parameters:
                block - The Block location to be stringified
                -
                Returns:
                +
                Returns:
                The stringified location
                +
                • -
              - - - -
                -
              • -

                fromStringLater

                -
                public static void fromStringLater​(java.lang.String string,
-                                   java.lang.String separator,
-                                   java.util.function.Consumer<org.bukkit.Location> callback)
                +
              • +
                +

                fromStringLater

                +
                public static void fromStringLater​(java.lang.String string, +java.lang.String separator, +java.util.function.Consumer<org.bukkit.Location> callback)
                Loads a Location from a String. If the world this Location is in is not yet loaded, waits for it to load, then passes the Location to the callback.
                -
                -
                Parameters:
                +
                +
                Parameters:
                string - The String to be parsed into a Location
                separator - The separator used when converting this Location to a String
                callback - The callback to use the Location once it has been loaded
                +
                • -
              - - - -
                -
              • -

                center

                -
                public static org.bukkit.Location center​(org.bukkit.block.Block block)
                +
              • +
                +

                center

                +
                public static org.bukkit.Location center​(org.bukkit.block.Block block)
                Returns the Location at the center of a Block - shorthand
                -
                -
                Parameters:
                +
                +
                Parameters:
                block - The Block to get the center of
                -
                Returns:
                +
                Returns:
                The center of the Block
                +
                • -
              - - - -
                -
              • -

                toBlockLocation

                -
                public static org.bukkit.Location toBlockLocation​(org.bukkit.Location loc)
                +
              • +
                +

                toBlockLocation

                +
                public static org.bukkit.Location toBlockLocation​(org.bukkit.Location loc)
                Sets the location's coordinates to its block coordinates, then returns it
                -
                -
                Parameters:
                +
                +
                Parameters:
                loc - The location
                -
                Returns:
                +
                Returns:
                The block location
                +
                • -
              - - - -
                -
              • -

                center

                -
                public static org.bukkit.Location center​(org.bukkit.Location loc)
                +
              • +
                +

                center

                +
                public static org.bukkit.Location center​(org.bukkit.Location loc)
                Sets the location's coordinates to the center point of its block coordinates, then returns it
                -
                -
                Parameters:
                +
                +
                Parameters:
                loc - The location
                -
                Returns:
                +
                Returns:
                The block location
                +
                • -
              - - - -
                -
              • -

                fromStringLater

                -
                public static void fromStringLater​(java.lang.String string,
-                                   java.util.function.Consumer<org.bukkit.Location> callback)
                +
              • +
                +

                fromStringLater

                +
                public static void fromStringLater​(java.lang.String string, +java.util.function.Consumer<org.bukkit.Location> callback)
                Loads a Location from a String. If the world this Location is in is not yet loaded, waits for it to load, then passes the Location to the callback.
                -
                -
                Parameters:
                +
                +
                Parameters:
                string - The String to be parsed into a Location
                callback - The callback to use the Location once it has been loaded
                +
                • -
              - - - -
                -
              • -

                toString

                -
                public static java.lang.String toString​(org.bukkit.Location loc)
                +
              • +
                +

                toString

                +
                public static java.lang.String toString​(org.bukkit.Location loc)
                Converts a Location to a String. The same as calling toString(Location, " ")
                -
                -
                Parameters:
                +
                +
                Parameters:
                loc - The Location to be stringified
                -
                Returns:
                +
                Returns:
                The stringified Location
                +
                • -
              - - - -
                -
              • -

                fromString

                -
                public static org.bukkit.Location fromString​(java.lang.String string)
                +
              • +
                +

                fromString

                +
                public static org.bukkit.Location fromString​(java.lang.String string)
                Converts a String back to a Location. The same as calling fromString(String, " ")
                -
                -
                Parameters:
                +
                +
                Parameters:
                string - The stringified Location
                -
                Returns:
                +
                Returns:
                The Location
                +
                • -
              - - - -
                -
              • -

                waitForWorld

                -
                public static void waitForWorld​(java.lang.String worldname,
-                                java.util.function.Consumer<org.bukkit.World> callback)
                +
              • +
                +

                waitForWorld

                +
                public static void waitForWorld​(java.lang.String worldname, +java.util.function.Consumer<org.bukkit.World> callback)
                Waits for a world with the given name to load before calling the callback
                -
                -
                Parameters:
                +
                +
                Parameters:
                worldname - The name of the world
                callback - A callback to be passed the world when it loads
                +
                • -
              - - - -
                -
              • -

                getChunkCoordinates

                -
                public static int[] getChunkCoordinates​(org.bukkit.Location loc)
                +
              • +
                +

                getChunkCoordinates

                +
                public static int[] getChunkCoordinates​(org.bukkit.Location loc)
                Gets the chunk X and Z of a location
                -
                -
                Parameters:
                +
                +
                Parameters:
                loc - The location to get the chunk coordinates of
                -
                Returns:
                +
                Returns:
                An array containing the chunk coordinates [x, z]
                +
                • -
              - - - -
                -
              • -

                directPathfind

                -
                public static java.util.List<org.bukkit.Location> directPathfind​(org.bukkit.block.Block start,
-                                                                 org.bukkit.block.Block end,
-                                                                 int max,
-                                                                 java.util.function.Predicate<org.bukkit.block.Block> filter)
                +
              • +
                +

                directPathfind

                +
                public static java.util.List<org.bukkit.Location> directPathfind​(org.bukkit.block.Block start, +org.bukkit.block.Block end, +int max, +java.util.function.Predicate<org.bukkit.block.Block> filter)
                Finds the fastest path between a starting and ending location using A*, then removes unneeded steps for straight
                -
                -
                Parameters:
                +
                +
                Parameters:
                start - The starting block
                end - The ending block
                max - The max number of locations to be checked - use to limit runtime
                filter - A filter to determine which blocks are passable
                -
                Returns:
                +
                Returns:
                A List of locations leading from the start to the end, or the closest block if the path could not be completed
                +
                • -
              - - - -
                -
              • -

                directPathfind

                -
                public static java.util.List<org.bukkit.Location> directPathfind​(org.bukkit.block.Block start,
-                                                                 org.bukkit.block.Block end,
-                                                                 int max)
                +
              • +
                +

                directPathfind

                +
                public static java.util.List<org.bukkit.Location> directPathfind​(org.bukkit.block.Block start, +org.bukkit.block.Block end, +int max)
                Finds the fastest path between a starting and ending location using A*, then removes unneeded steps for straight
                -
                -
                Parameters:
                +
                +
                Parameters:
                start - The starting block
                end - The ending block
                max - The max number of locations to be checked - use to limit runtime
                -
                Returns:
                +
                Returns:
                A List of locations leading from the start to the end, or the closest block if the path could not be completed
                +
                • -
              - - - -
                -
              • -

                pathfind

                -
                public static java.util.Deque<org.bukkit.Location> pathfind​(org.bukkit.block.Block start,
-                                                            org.bukkit.block.Block end,
-                                                            int max)
                +
              • +
                +

                pathfind

                +
                public static java.util.Deque<org.bukkit.Location> pathfind​(org.bukkit.block.Block start, +org.bukkit.block.Block end, +int max)
                Finds the fastest path between a starting and ending location using A*
                -
                -
                Parameters:
                +
                +
                Parameters:
                start - The starting block
                end - The ending block
                max - The max number of locations to be checked - use to limit runtime
                -
                Returns:
                +
                Returns:
                A Deque of locations leading from the start to the end, or the closest block if the path could not be completed
                +
                • -
              - - - -
                -
              • -

                pathfind

                -
                public static java.util.Deque<org.bukkit.Location> pathfind​(org.bukkit.block.Block start,
-                                                            org.bukkit.block.Block end,
-                                                            int max,
-                                                            java.util.function.Predicate<org.bukkit.block.Block> filter)
                +
              • +
                +

                pathfind

                +
                public static java.util.Deque<org.bukkit.Location> pathfind​(org.bukkit.block.Block start, +org.bukkit.block.Block end, +int max, +java.util.function.Predicate<org.bukkit.block.Block> filter)
                Finds the fastest path between a starting and ending location using A*
                -
                -
                Parameters:
                +
                +
                Parameters:
                start - The starting block
                end - The ending block
                max - The max number of locations to be checked - use to limit runtime
                filter - A filter to determine which blocks are passable
                -
                Returns:
                +
                Returns:
                A Deque of locations leading from the start to the end, or the closest block if the path could not be completed
                -
                • -
              +
        -
    - - + + + + diff --git a/javadoc/redempt/redlib/misc/Path.html b/javadoc/redempt/redlib/misc/Path.html index 2f0ec6a..638df17 100644 --- a/javadoc/redempt/redlib/misc/Path.html +++ b/javadoc/redempt/redlib/misc/Path.html @@ -5,476 +5,372 @@ Path (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.misc
    -

    Class Path

    +
    Package redempt.redlib.misc
    +

    Class Path

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.misc.Path
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      redempt.redlib.misc.Path
      +
      +
      -
      public class Path
+
      public class Path
 extends java.lang.Object
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Constructor Summary

          - - +
        • +
          +

          Constructor Summary

          +
          +
          • Constructors 
          + + - - + + - - - + + + + + +
          Constructors
          ConstructorDescriptionConstructorDescription
          Path() 
          Path() 
          -
          • -
        +
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Static Methods Concrete Methods 
      + - - - + + + - - - - + + + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + +
      Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
      static java.util.List<org.bukkit.Location>getPath​(org.bukkit.Location start) +
      static java.util.List<org.bukkit.Location>getPath​(org.bukkit.Location start)
      Get the locations from the start along a vector
      static java.util.List<org.bukkit.Location>getPath​(org.bukkit.Location start, - double step) +
      static java.util.List<org.bukkit.Location>getPath​(org.bukkit.Location start, +double step)
      Get the locations from the start along a vector
      static java.util.List<org.bukkit.Location>getPath​(org.bukkit.Location start, - org.bukkit.Location end) +
      static java.util.List<org.bukkit.Location>getPath​(org.bukkit.Location start, +org.bukkit.Location end)
      Get the locations between the start and end location
      static java.util.List<org.bukkit.Location>getPath​(org.bukkit.Location start, - org.bukkit.Location end, - double step) +
      static java.util.List<org.bukkit.Location>getPath​(org.bukkit.Location start, +org.bukkit.Location end, +double step)
      Get the locations between the start and end location
      static java.util.List<org.bukkit.Location>getPath​(org.bukkit.Location start, - org.bukkit.util.Vector direction) +
      static java.util.List<org.bukkit.Location>getPath​(org.bukkit.Location start, +org.bukkit.util.Vector direction)
      Get the locations from the start along a vector
      static java.util.List<org.bukkit.Location>getPath​(org.bukkit.Location start, - org.bukkit.util.Vector direction, - double distance) +
      static java.util.List<org.bukkit.Location>getPath​(org.bukkit.Location start, +org.bukkit.util.Vector direction, +double distance)
      Get the locations from the start along a vector
      static java.util.List<org.bukkit.Location>getPath​(org.bukkit.Location start, - org.bukkit.util.Vector direction, - double distance, - double step) +
      static java.util.List<org.bukkit.Location>getPath​(org.bukkit.Location start, +org.bukkit.util.Vector direction, +double distance, +double step)
      Get the locations from the start along a vector
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

    Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - -
            -
          • -

            Path

            -
            public Path()
            -
            • -
          +
        • +
          +

          Constructor Details

          +
            +
          • +
            +

            Path

            +
            public Path()
            +
          +
          • -
          -
            -
          • - - -

            Method Detail

            - - - -
              -
            • -

              getPath

              -
              public static java.util.List<org.bukkit.Location> getPath​(org.bukkit.Location start,
-                                                          org.bukkit.Location end,
-                                                          double step)
              +
            • +
              +

              Method Details

              +
                +
              • +
                +

                getPath

                +
                public static java.util.List<org.bukkit.Location> getPath​(org.bukkit.Location start, +org.bukkit.Location end, +double step)
                Get the locations between the start and end location
                -
                -
                Parameters:
                +
                +
                Parameters:
                start - The start location
                end - The end location
                step - The step size to use
                -
                Returns:
                +
                Returns:
                A list of all the locations between the locations
                +
                • -
              - - - -
                -
              • -

                getPath

                -
                public static java.util.List<org.bukkit.Location> getPath​(org.bukkit.Location start,
-                                                          org.bukkit.Location end)
                +
              • +
                +

                getPath

                +
                public static java.util.List<org.bukkit.Location> getPath​(org.bukkit.Location start, +org.bukkit.Location end)
                Get the locations between the start and end location
                -
                -
                Parameters:
                +
                +
                Parameters:
                start - The start location
                end - The end location
                -
                Returns:
                +
                Returns:
                A list of all the locations between the locations, equidistant
                +
                • -
              - - - -
                -
              • -

                getPath

                -
                public static java.util.List<org.bukkit.Location> getPath​(org.bukkit.Location start,
-                                                          org.bukkit.util.Vector direction,
-                                                          double distance,
-                                                          double step)
                +
              • +
                +

                getPath

                +
                public static java.util.List<org.bukkit.Location> getPath​(org.bukkit.Location start, +org.bukkit.util.Vector direction, +double distance, +double step)
                Get the locations from the start along a vector
                -
                -
                Parameters:
                +
                +
                Parameters:
                start - The start location
                direction - The vector indicating direction
                distance - The length of the path
                step - The step size to use
                -
                Returns:
                +
                Returns:
                A list of all the locations between the locations, equidistant
                +
                • -
              - - - -
                -
              • -

                getPath

                -
                public static java.util.List<org.bukkit.Location> getPath​(org.bukkit.Location start,
-                                                          org.bukkit.util.Vector direction,
-                                                          double distance)
                +
              • +
                +

                getPath

                +
                public static java.util.List<org.bukkit.Location> getPath​(org.bukkit.Location start, +org.bukkit.util.Vector direction, +double distance)
                Get the locations from the start along a vector
                -
                -
                Parameters:
                +
                +
                Parameters:
                start - The start location
                direction - The vector indicating direction
                distance - The max distance to step
                -
                Returns:
                +
                Returns:
                A list of all the locations between the locations, equidistant
                +
                • -
              - - - -
                -
              • -

                getPath

                -
                public static java.util.List<org.bukkit.Location> getPath​(org.bukkit.Location start,
-                                                          org.bukkit.util.Vector direction)
                +
              • +
                +

                getPath

                +
                public static java.util.List<org.bukkit.Location> getPath​(org.bukkit.Location start, +org.bukkit.util.Vector direction)
                Get the locations from the start along a vector
                -
                -
                Parameters:
                +
                +
                Parameters:
                start - The start location
                direction - The vector indicating direction and length
                -
                Returns:
                +
                Returns:
                A list of all the locations between the locations, equidistant
                +
                • -
              - - - -
                -
              • -

                getPath

                -
                public static java.util.List<org.bukkit.Location> getPath​(org.bukkit.Location start)
                +
              • +
                +

                getPath

                +
                public static java.util.List<org.bukkit.Location> getPath​(org.bukkit.Location start)
                Get the locations from the start along a vector
                -
                -
                Parameters:
                +
                +
                Parameters:
                start - The start location whose direction vector will be used for direction and length
                -
                Returns:
                +
                Returns:
                A list of all the locations between the locations, equidistant
                +
                • -
              - - - -
                -
              • -

                getPath

                -
                public static java.util.List<org.bukkit.Location> getPath​(org.bukkit.Location start,
-                                                          double step)
                +
              • +
                +

                getPath

                +
                public static java.util.List<org.bukkit.Location> getPath​(org.bukkit.Location start, +double step)
                Get the locations from the start along a vector
                -
                -
                Parameters:
                +
                +
                Parameters:
                start - The start location whose direction vector will be used for direction and length
                step - The step size to use
                -
                Returns:
                +
                Returns:
                A list of all the locations between the locations, equidistant
                -
                • -
              +
        -
    - - + + + + diff --git a/javadoc/redempt/redlib/misc/PlayerWrapper.html b/javadoc/redempt/redlib/misc/PlayerWrapper.html index 45894fc..4087d66 100644 --- a/javadoc/redempt/redlib/misc/PlayerWrapper.html +++ b/javadoc/redempt/redlib/misc/PlayerWrapper.html @@ -5,312 +5,226 @@ PlayerWrapper (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.misc
    -

    Class PlayerWrapper

    +
    Package redempt.redlib.misc
    +

    Class PlayerWrapper

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.misc.PlayerWrapper
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      redempt.redlib.misc.PlayerWrapper
      +
      +
      -
      public class PlayerWrapper
+
      public class PlayerWrapper
 extends java.lang.Object
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Constructor Summary

          - - +
        • +
          +

          Constructor Summary

          +
          +
          • Constructors 
          + + - - + + - - - + + + + + +
          Constructors
          ConstructorDescriptionConstructorDescription
          PlayerWrapper() 
          PlayerWrapper() 
          -
          • -
        +
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Static Methods Concrete Methods 
      + - - - + + + - - - - + + + + + +
      Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
      static org.bukkit.entity.Playerwrap​(org.bukkit.entity.Player player, - java.lang.String... disable) +
      static org.bukkit.entity.Playerwrap​(org.bukkit.entity.Player player, +java.lang.String... disable)
      Wraps a player using a Proxy, disabling some methods from being called.
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

    Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - -
            -
          • -

            PlayerWrapper

            -
            public PlayerWrapper()
            -
            • -
          +
        • +
          +

          Constructor Details

          +
            +
          • +
            +

            PlayerWrapper

            +
            public PlayerWrapper()
            +
          +
          • -
          -
            -
          • - - -

            Method Detail

            - - - -
              -
            • -

              wrap

              -
              public static org.bukkit.entity.Player wrap​(org.bukkit.entity.Player player,
-                                            java.lang.String... disable)
              +
            • +
              +

              Method Details

              +
                +
              • +
                +

                wrap

                +
                public static org.bukkit.entity.Player wrap​(org.bukkit.entity.Player player, +java.lang.String... disable)
                Wraps a player using a Proxy, disabling some methods from being called. Very hacky, do not use if it can be avoided. Meant for when you want to send a fake event to test if it will be cancelled, but don't want the plugins to be able to do certain things with the player based on the event.
                -
                -
                Parameters:
                +
                +
                Parameters:
                player - The player to wrap
                disable - The names of the methods to disable
                -
                Returns:
                +
                Returns:
                The wrapped player
                -
                • -
              +
        -
    - - + + + + diff --git a/javadoc/redempt/redlib/misc/Task.TaskType.html b/javadoc/redempt/redlib/misc/Task.TaskType.html index 00cc2c5..f55303a 100644 --- a/javadoc/redempt/redlib/misc/Task.TaskType.html +++ b/javadoc/redempt/redlib/misc/Task.TaskType.html @@ -5,402 +5,301 @@ Task.TaskType (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.misc
    -

    Enum Task.TaskType

    +
    Package redempt.redlib.misc
    +

    Enum Task.TaskType

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • java.lang.Enum<Task.TaskType>
        • -
      • -
          -
        • redempt.redlib.misc.Task.TaskType
          • -
        -
        • -
      -
      • -
    -
    -
      -
    • -
      +
      java.lang.Object +
      java.lang.Enum<Task.TaskType> +
      redempt.redlib.misc.Task.TaskType
      +
      +
      +
      +
      All Implemented Interfaces:
      -
      java.io.Serializable, java.lang.Comparable<Task.TaskType>
      +
      java.io.Serializable, java.lang.Comparable<Task.TaskType>, java.lang.constant.Constable
      -
      +
      Enclosing class:
      Task
      -
      public static enum Task.TaskType
+
      public static enum Task.TaskType
 extends java.lang.Enum<Task.TaskType>
      
 
      Represents a type of task
      
+
      +
      +
        + +
      • +
        +

        Nested Class Summary

        +
        +

        Nested classes/interfaces inherited from class java.lang.Enum

        +java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>
        +
        • -
      -
    -
    -
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Static Methods Concrete Methods 
      + - - - + + + - - - - + + + + + - - - - + + + +
      Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
      static Task.TaskTypevalueOf​(java.lang.String name) +
      static Task.TaskTypevalueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Task.TaskType[]values() +
      static Task.TaskType[]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
        • -
      -
      • -
    +
    +
    +
    +

    Methods inherited from class java.lang.Enum

    +clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
    +
    +

    Methods inherited from class java.lang.Object

    +getClass, notify, notifyAll, wait, wait, wait
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Enum Constant Detail

          - - - -
            -
          • -

            SYNC_DELAYED

            -
            public static final Task.TaskType SYNC_DELAYED
            -
            • -
          - - - -
            -
          • -

            ASYNC_DELAYED

            -
            public static final Task.TaskType ASYNC_DELAYED
            +
          • +
            +

            Enum Constant Details

            +
              +
            • +
              +

              SYNC_DELAYED

              +
              public static final Task.TaskType SYNC_DELAYED
              +
              • -
            - - - -
              -
            • -

              SYNC_REPEATING

              -
              public static final Task.TaskType SYNC_REPEATING
              +
            • +
              +

              ASYNC_DELAYED

              +
              public static final Task.TaskType ASYNC_DELAYED
              +
              • -
            - - - -
              -
            • -

              ASYNC_REPEATING

              -
              public static final Task.TaskType ASYNC_REPEATING
              +
            • +
              +

              SYNC_REPEATING

              +
              public static final Task.TaskType SYNC_REPEATING
              +
              • -
            +
          • +
            +

            ASYNC_REPEATING

            +
            public static final Task.TaskType ASYNC_REPEATING
            +
        + -
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            values

            -
            public static Task.TaskType[] values()
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              values

              +
              public static Task.TaskType[] 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 (Task.TaskType c : Task.TaskType.values())
-    System.out.println(c);
-
              -
              -
              Returns:
              +the order they are declared.
    +
    +
    Returns:
    an array containing the constants of this enum type, in the order they are declared
    + - - - - -
      -
    • -

      valueOf

      -
      public static Task.TaskType valueOf​(java.lang.String name)
      +
    • +
      +

      valueOf

      +
      public static Task.TaskType 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:
      +
      +
      Parameters:
      name - the name of the enum constant to be returned.
      -
      Returns:
      +
      Returns:
      the enum constant with the specified name
      -
      Throws:
      +
      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/redempt/redlib/misc/Task.html b/javadoc/redempt/redlib/misc/Task.html index eae9ff5..ad6d02f 100644 --- a/javadoc/redempt/redlib/misc/Task.html +++ b/javadoc/redempt/redlib/misc/Task.html @@ -5,1020 +5,855 @@ Task (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.misc
    -

    Class Task

    +
    Package redempt.redlib.misc
    +

    Class Task

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.misc.Task
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      redempt.redlib.misc.Task
      +
      +
      -
      public class Task
+
      public class Task
 extends java.lang.Object
      
 
      Simple utility for Bukkit scheduler tasks, essentially just shorthand
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Nested Class Summary

          - - +
        • +
          +

          Nested Class Summary

          +
          +
          • Nested Classes 
          + + - - - - - - - - + + + + + + + + + +
          Nested Classes
          Modifier and TypeClassDescription
          static class Task.TaskType +Modifier and TypeClassDescription
          static class Task.TaskType
          Represents a type of task
          -
          • -
        +
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Static Methods Instance Methods Concrete Methods 
      + - - - - - - - - + + + + + + + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + +
      Modifier and TypeMethodDescription
      static TaskasyncDelayed​(java.lang.Runnable run) +Modifier and TypeMethodDescription
      static TaskasyncDelayed​(java.lang.Runnable run)
      Schedules an async delayed task to run as soon as possible
      static TaskasyncDelayed​(java.lang.Runnable run, - long delay) +
      static TaskasyncDelayed​(java.lang.Runnable run, +long delay)
      Schedules an async delayed task to run after a delay
      static TaskasyncDelayed​(java.util.function.Consumer<Task> run) +
      static TaskasyncDelayed​(java.util.function.Consumer<Task> run)
      Schedules an async delayed task to run as soon as possible
      static TaskasyncDelayed​(java.util.function.Consumer<Task> run, - long delay) +
      static TaskasyncDelayed​(java.util.function.Consumer<Task> run, +long delay)
      Schedules an async delayed task to run after a delay
      static TaskasyncDelayed​(org.bukkit.plugin.Plugin plugin, - java.lang.Runnable run) +
      static TaskasyncDelayed​(org.bukkit.plugin.Plugin plugin, +java.lang.Runnable run)
      Schedules an async delayed task to run as soon as possible
      static TaskasyncDelayed​(org.bukkit.plugin.Plugin plugin, - java.lang.Runnable run, - long delay) +
      static TaskasyncDelayed​(org.bukkit.plugin.Plugin plugin, +java.lang.Runnable run, +long delay)
      Schedules an async delayed task to run after a delay
      static TaskasyncDelayed​(org.bukkit.plugin.Plugin plugin, - java.util.function.Consumer<Task> run) +
      static TaskasyncDelayed​(org.bukkit.plugin.Plugin plugin, +java.util.function.Consumer<Task> run)
      Schedules an async delayed task to run as soon as possible
      static TaskasyncDelayed​(org.bukkit.plugin.Plugin plugin, - java.util.function.Consumer<Task> run, - long delay) +
      static TaskasyncDelayed​(org.bukkit.plugin.Plugin plugin, +java.util.function.Consumer<Task> run, +long delay)
      Schedules an async delayed task to run after a delay
      static TaskasyncRepeating​(java.lang.Runnable run, - long delay, - long period) +
      static TaskasyncRepeating​(java.lang.Runnable run, +long delay, +long period)
      Schedules an async repeating task to run later
      static TaskasyncRepeating​(java.util.function.Consumer<Task> run, - long delay, - long period) +
      static TaskasyncRepeating​(java.util.function.Consumer<Task> run, +long delay, +long period)
      Schedules an async repeating task to run later
      static TaskasyncRepeating​(org.bukkit.plugin.Plugin plugin, - java.lang.Runnable run, - long delay, - long period) +
      static TaskasyncRepeating​(org.bukkit.plugin.Plugin plugin, +java.lang.Runnable run, +long delay, +long period)
      Schedules an async repeating task to run later
      static TaskasyncRepeating​(org.bukkit.plugin.Plugin plugin, - java.util.function.Consumer<Task> run, - long delay, - long period) +
      static TaskasyncRepeating​(org.bukkit.plugin.Plugin plugin, +java.util.function.Consumer<Task> run, +long delay, +long period)
      Schedules an async repeating task to run later
      voidcancel() +
      voidcancel()
      Cancels this task, same as BukkitScheduler.cancelTask(int)
      org.bukkit.plugin.PlugingetPlugin() 
      Task.TaskTypegetType() 
      booleanisCurrentlyRunning() 
      booleanisQueued() 
      static TasksyncDelayed​(java.lang.Runnable run) +
      org.bukkit.plugin.PlugingetPlugin() 
      Task.TaskTypegetType() 
      booleanisCurrentlyRunning() 
      booleanisQueued() 
      static TasksyncDelayed​(java.lang.Runnable run)
      Schedules a sync delayed task to run as soon as possible
      static TasksyncDelayed​(java.lang.Runnable run, - long delay) +
      static TasksyncDelayed​(java.lang.Runnable run, +long delay)
      Schedules a sync delayed task to run after a delay
      static TasksyncDelayed​(java.util.function.Consumer<Task> run) +
      static TasksyncDelayed​(java.util.function.Consumer<Task> run)
      Schedules a sync delayed task to run as soon as possible
      static TasksyncDelayed​(java.util.function.Consumer<Task> run, - long delay) +
      static TasksyncDelayed​(java.util.function.Consumer<Task> run, +long delay)
      Schedules a sync delayed task to run after a delay
      static TasksyncDelayed​(org.bukkit.plugin.Plugin plugin, - java.lang.Runnable run) +
      static TasksyncDelayed​(org.bukkit.plugin.Plugin plugin, +java.lang.Runnable run)
      Schedules a sync delayed task to run as soon as possible
      static TasksyncDelayed​(org.bukkit.plugin.Plugin plugin, - java.lang.Runnable run, - long delay) +
      static TasksyncDelayed​(org.bukkit.plugin.Plugin plugin, +java.lang.Runnable run, +long delay)
      Schedules a sync delayed task to run after a delay
      static TasksyncDelayed​(org.bukkit.plugin.Plugin plugin, - java.util.function.Consumer<Task> run) +
      static TasksyncDelayed​(org.bukkit.plugin.Plugin plugin, +java.util.function.Consumer<Task> run)
      Schedules a sync delayed task to run as soon as possible
      static TasksyncDelayed​(org.bukkit.plugin.Plugin plugin, - java.util.function.Consumer<Task> run, - long delay) +
      static TasksyncDelayed​(org.bukkit.plugin.Plugin plugin, +java.util.function.Consumer<Task> run, +long delay)
      Schedules a sync delayed task to run after a delay
      static TasksyncRepeating​(java.lang.Runnable run, - long delay, - long period) +
      static TasksyncRepeating​(java.lang.Runnable run, +long delay, +long period)
      Schedules a sync repeating task to run later
      static TasksyncRepeating​(java.util.function.Consumer<Task> run, - long delay, - long period) +
      static TasksyncRepeating​(java.util.function.Consumer<Task> run, +long delay, +long period)
      Schedules a sync repeating task to run later
      static TasksyncRepeating​(org.bukkit.plugin.Plugin plugin, - java.lang.Runnable run, - long delay, - long period) +
      static TasksyncRepeating​(org.bukkit.plugin.Plugin plugin, +java.lang.Runnable run, +long delay, +long period)
      Schedules a sync repeating task to run later
      static TasksyncRepeating​(org.bukkit.plugin.Plugin plugin, - java.util.function.Consumer<Task> run, - long delay, - long period) +
      static TasksyncRepeating​(org.bukkit.plugin.Plugin plugin, +java.util.function.Consumer<Task> run, +long delay, +long period)
      Schedules a sync repeating task to run later
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

    Methods inherited from class java.lang.Object

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

          Method Detail

          - - - -
            -
          • -

            syncDelayed

            -
            public static Task syncDelayed​(java.lang.Runnable run)
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              syncDelayed

              +
              public static Task syncDelayed​(java.lang.Runnable run)
              Schedules a sync delayed task to run as soon as possible
              -
              -
              Parameters:
              +
              +
              Parameters:
              run - The task to run
              -
              Returns:
              +
              Returns:
              The Task that has been scheduled
              +
              • -
            - - - -
              -
            • -

              syncDelayed

              -
              public static Task syncDelayed​(org.bukkit.plugin.Plugin plugin,
-                               java.lang.Runnable run)
              +
            • +
              +

              syncDelayed

              +
              public static Task syncDelayed​(org.bukkit.plugin.Plugin plugin, +java.lang.Runnable run)
              Schedules a sync delayed task to run as soon as possible
              -
              -
              Parameters:
              +
              +
              Parameters:
              plugin - The plugin scheduling the task
              run - The task to run
              -
              Returns:
              +
              Returns:
              The Task that has been scheduled
              +
              • -
            - - - -
              -
            • -

              syncDelayed

              -
              public static Task syncDelayed​(java.util.function.Consumer<Task> run)
              +
            • +
              +

              syncDelayed

              +
              public static Task syncDelayed​(java.util.function.Consumer<Task> run)
              Schedules a sync delayed task to run as soon as possible
              -
              -
              Parameters:
              +
              +
              Parameters:
              run - The task to run
              -
              Returns:
              +
              Returns:
              The Task that has been scheduled
              +
              • -
            - - - -
              -
            • -

              syncDelayed

              -
              public static Task syncDelayed​(org.bukkit.plugin.Plugin plugin,
-                               java.util.function.Consumer<Task> run)
              +
            • +
              +

              syncDelayed

              +
              public static Task syncDelayed​(org.bukkit.plugin.Plugin plugin, +java.util.function.Consumer<Task> run)
              Schedules a sync delayed task to run as soon as possible
              -
              -
              Parameters:
              +
              +
              Parameters:
              plugin - The plugin scheduling the task
              run - The task to run
              -
              Returns:
              +
              Returns:
              The Task that has been scheduled
              +
              • -
            - - - -
              -
            • -

              syncDelayed

              -
              public static Task syncDelayed​(java.lang.Runnable run,
-                               long delay)
              +
            • +
              +

              syncDelayed

              +
              public static Task syncDelayed​(java.lang.Runnable run, +long delay)
              Schedules a sync delayed task to run after a delay
              -
              -
              Parameters:
              +
              +
              Parameters:
              run - The task to run
              delay - The delay in ticks to wait before running the task
              -
              Returns:
              +
              Returns:
              The Task that has been scheduled
              +
              • -
            - - - -
              -
            • -

              syncDelayed

              -
              public static Task syncDelayed​(org.bukkit.plugin.Plugin plugin,
-                               java.lang.Runnable run,
-                               long delay)
              +
            • +
              +

              syncDelayed

              +
              public static Task syncDelayed​(org.bukkit.plugin.Plugin plugin, +java.lang.Runnable run, +long delay)
              Schedules a sync delayed task to run after a delay
              -
              -
              Parameters:
              +
              +
              Parameters:
              plugin - The plugin scheduling the task
              run - The task to run
              delay - The delay in ticks to wait before running the task
              -
              Returns:
              +
              Returns:
              The Task that has been scheduled
              +
              • -
            - - - -
              -
            • -

              syncDelayed

              -
              public static Task syncDelayed​(java.util.function.Consumer<Task> run,
-                               long delay)
              +
            • +
              +

              syncDelayed

              +
              public static Task syncDelayed​(java.util.function.Consumer<Task> run, +long delay)
              Schedules a sync delayed task to run after a delay
              -
              -
              Parameters:
              +
              +
              Parameters:
              run - The task to run
              delay - The delay in ticks to wait before running the task
              -
              Returns:
              +
              Returns:
              The Task that has been scheduled
              +
              • -
            - - - -
              -
            • -

              syncDelayed

              -
              public static Task syncDelayed​(org.bukkit.plugin.Plugin plugin,
-                               java.util.function.Consumer<Task> run,
-                               long delay)
              +
            • +
              +

              syncDelayed

              +
              public static Task syncDelayed​(org.bukkit.plugin.Plugin plugin, +java.util.function.Consumer<Task> run, +long delay)
              Schedules a sync delayed task to run after a delay
              -
              -
              Parameters:
              +
              +
              Parameters:
              plugin - The plugin scheduling the task
              run - The task to run
              delay - The delay in ticks to wait before running the task
              -
              Returns:
              +
              Returns:
              The Task that has been scheduled
              +
              • -
            - - - -
              -
            • -

              syncRepeating

              -
              public static Task syncRepeating​(java.lang.Runnable run,
-                                 long delay,
-                                 long period)
              +
            • +
              +

              syncRepeating

              +
              public static Task syncRepeating​(java.lang.Runnable run, +long delay, +long period)
              Schedules a sync repeating task to run later
              -
              -
              Parameters:
              +
              +
              Parameters:
              run - The task to run
              delay - The delay in ticks to wait before running the task
              period - The number of ticks between executions of the task
              -
              Returns:
              +
              Returns:
              The Task that has been scheduled
              +
              • -
            - - - -
              -
            • -

              syncRepeating

              -
              public static Task syncRepeating​(org.bukkit.plugin.Plugin plugin,
-                                 java.lang.Runnable run,
-                                 long delay,
-                                 long period)
              +
            • +
              +

              syncRepeating

              +
              public static Task syncRepeating​(org.bukkit.plugin.Plugin plugin, +java.lang.Runnable run, +long delay, +long period)
              Schedules a sync repeating task to run later
              -
              -
              Parameters:
              +
              +
              Parameters:
              plugin - The plugin scheduling the task
              run - The task to run
              delay - The delay in ticks to wait before running the task
              period - The number of ticks between executions of the task
              -
              Returns:
              +
              Returns:
              The Task that has been scheduled
              +
              • -
            - - - -
              -
            • -

              syncRepeating

              -
              public static Task syncRepeating​(java.util.function.Consumer<Task> run,
-                                 long delay,
-                                 long period)
              +
            • +
              +

              syncRepeating

              +
              public static Task syncRepeating​(java.util.function.Consumer<Task> run, +long delay, +long period)
              Schedules a sync repeating task to run later
              -
              -
              Parameters:
              +
              +
              Parameters:
              run - The task to run
              delay - The delay in ticks to wait before running the task
              period - The number of ticks between executions of the task
              -
              Returns:
              +
              Returns:
              The Task that has been scheduled
              +
              • -
            - - - -
              -
            • -

              syncRepeating

              -
              public static Task syncRepeating​(org.bukkit.plugin.Plugin plugin,
-                                 java.util.function.Consumer<Task> run,
-                                 long delay,
-                                 long period)
              +
            • +
              +

              syncRepeating

              +
              public static Task syncRepeating​(org.bukkit.plugin.Plugin plugin, +java.util.function.Consumer<Task> run, +long delay, +long period)
              Schedules a sync repeating task to run later
              -
              -
              Parameters:
              +
              +
              Parameters:
              plugin - The plugin scheduling the task
              run - The task to run
              delay - The delay in ticks to wait before running the task
              period - The number of ticks between executions of the task
              -
              Returns:
              +
              Returns:
              The Task that has been scheduled
              +
              • -
            - - - -
              -
            • -

              asyncDelayed

              -
              public static Task asyncDelayed​(java.lang.Runnable run)
              +
            • +
              +

              asyncDelayed

              +
              public static Task asyncDelayed​(java.lang.Runnable run)
              Schedules an async delayed task to run as soon as possible
              -
              -
              Parameters:
              +
              +
              Parameters:
              run - The task to run
              -
              Returns:
              +
              Returns:
              The Task that has been scheduled
              +
              • -
            - - - -
              -
            • -

              asyncDelayed

              -
              public static Task asyncDelayed​(org.bukkit.plugin.Plugin plugin,
-                                java.lang.Runnable run)
              +
            • +
              +

              asyncDelayed

              +
              public static Task asyncDelayed​(org.bukkit.plugin.Plugin plugin, +java.lang.Runnable run)
              Schedules an async delayed task to run as soon as possible
              -
              -
              Parameters:
              +
              +
              Parameters:
              plugin - The plugin scheduling the task
              run - The task to run
              -
              Returns:
              +
              Returns:
              The Task that has been scheduled
              +
              • -
            - - - -
              -
            • -

              asyncDelayed

              -
              public static Task asyncDelayed​(java.util.function.Consumer<Task> run)
              +
            • +
              +

              asyncDelayed

              +
              public static Task asyncDelayed​(java.util.function.Consumer<Task> run)
              Schedules an async delayed task to run as soon as possible
              -
              -
              Parameters:
              +
              +
              Parameters:
              run - The task to run
              -
              Returns:
              +
              Returns:
              The Task that has been scheduled
              +
              • -
            - - - -
              -
            • -

              asyncDelayed

              -
              public static Task asyncDelayed​(org.bukkit.plugin.Plugin plugin,
-                                java.util.function.Consumer<Task> run)
              +
            • +
              +

              asyncDelayed

              +
              public static Task asyncDelayed​(org.bukkit.plugin.Plugin plugin, +java.util.function.Consumer<Task> run)
              Schedules an async delayed task to run as soon as possible
              -
              -
              Parameters:
              +
              +
              Parameters:
              plugin - The plugin scheduling the task
              run - The task to run
              -
              Returns:
              +
              Returns:
              The Task that has been scheduled
              +
              • -
            - - - -
              -
            • -

              asyncDelayed

              -
              public static Task asyncDelayed​(java.lang.Runnable run,
-                                long delay)
              +
            • +
              +

              asyncDelayed

              +
              public static Task asyncDelayed​(java.lang.Runnable run, +long delay)
              Schedules an async delayed task to run after a delay
              -
              -
              Parameters:
              +
              +
              Parameters:
              run - The task to run
              delay - The delay in ticks to wait before running the task
              -
              Returns:
              +
              Returns:
              The Task that has been scheduled
              +
              • -
            - - - -
              -
            • -

              asyncDelayed

              -
              public static Task asyncDelayed​(org.bukkit.plugin.Plugin plugin,
-                                java.lang.Runnable run,
-                                long delay)
              +
            • +
              +

              asyncDelayed

              +
              public static Task asyncDelayed​(org.bukkit.plugin.Plugin plugin, +java.lang.Runnable run, +long delay)
              Schedules an async delayed task to run after a delay
              -
              -
              Parameters:
              +
              +
              Parameters:
              plugin - The plugin scheduling the task
              run - The task to run
              delay - The delay in ticks to wait before running the task
              -
              Returns:
              +
              Returns:
              The Task that has been scheduled
              +
              • -
            - - - -
              -
            • -

              asyncDelayed

              -
              public static Task asyncDelayed​(java.util.function.Consumer<Task> run,
-                                long delay)
              +
            • +
              +

              asyncDelayed

              +
              public static Task asyncDelayed​(java.util.function.Consumer<Task> run, +long delay)
              Schedules an async delayed task to run after a delay
              -
              -
              Parameters:
              +
              +
              Parameters:
              run - The task to run
              delay - The delay in ticks to wait before running the task
              -
              Returns:
              +
              Returns:
              The Task that has been scheduled
              +
              • -
            - - - -
              -
            • -

              asyncDelayed

              -
              public static Task asyncDelayed​(org.bukkit.plugin.Plugin plugin,
-                                java.util.function.Consumer<Task> run,
-                                long delay)
              +
            • +
              +

              asyncDelayed

              +
              public static Task asyncDelayed​(org.bukkit.plugin.Plugin plugin, +java.util.function.Consumer<Task> run, +long delay)
              Schedules an async delayed task to run after a delay
              -
              -
              Parameters:
              +
              +
              Parameters:
              plugin - The plugin scheduling the task
              run - The task to run
              delay - The delay in ticks to wait before running the task
              -
              Returns:
              +
              Returns:
              The Task that has been scheduled
              +
              • -
            - - - -
              -
            • -

              asyncRepeating

              -
              public static Task asyncRepeating​(java.util.function.Consumer<Task> run,
-                                  long delay,
-                                  long period)
              +
            • +
              +

              asyncRepeating

              +
              public static Task asyncRepeating​(java.util.function.Consumer<Task> run, +long delay, +long period)
              Schedules an async repeating task to run later
              -
              -
              Parameters:
              +
              +
              Parameters:
              run - The task to run
              delay - The delay in ticks to wait before running the task
              period - The number of ticks between executions of the task
              -
              Returns:
              +
              Returns:
              The Task that has been scheduled
              +
              • -
            - - - -
              -
            • -

              asyncRepeating

              -
              public static Task asyncRepeating​(org.bukkit.plugin.Plugin plugin,
-                                  java.util.function.Consumer<Task> run,
-                                  long delay,
-                                  long period)
              +
            • +
              +

              asyncRepeating

              +
              public static Task asyncRepeating​(org.bukkit.plugin.Plugin plugin, +java.util.function.Consumer<Task> run, +long delay, +long period)
              Schedules an async repeating task to run later
              -
              -
              Parameters:
              +
              +
              Parameters:
              plugin - The plugin scheduling the task
              run - The task to run
              delay - The delay in ticks to wait before running the task
              period - The number of ticks between executions of the task
              -
              Returns:
              +
              Returns:
              The Task that has been scheduled
              +
              • -
            - - - -
              -
            • -

              asyncRepeating

              -
              public static Task asyncRepeating​(java.lang.Runnable run,
-                                  long delay,
-                                  long period)
              +
            • +
              +

              asyncRepeating

              +
              public static Task asyncRepeating​(java.lang.Runnable run, +long delay, +long period)
              Schedules an async repeating task to run later
              -
              -
              Parameters:
              +
              +
              Parameters:
              run - The task to run
              delay - The delay in ticks to wait before running the task
              period - The number of ticks between executions of the task
              -
              Returns:
              +
              Returns:
              The Task that has been scheduled
              +
              • -
            - - - -
              -
            • -

              asyncRepeating

              -
              public static Task asyncRepeating​(org.bukkit.plugin.Plugin plugin,
-                                  java.lang.Runnable run,
-                                  long delay,
-                                  long period)
              +
            • +
              +

              asyncRepeating

              +
              public static Task asyncRepeating​(org.bukkit.plugin.Plugin plugin, +java.lang.Runnable run, +long delay, +long period)
              Schedules an async repeating task to run later
              -
              -
              Parameters:
              +
              +
              Parameters:
              plugin - The plugin scheduling the task
              run - The task to run
              delay - The delay in ticks to wait before running the task
              period - The number of ticks between executions of the task
              -
              Returns:
              +
              Returns:
              The Task that has been scheduled
              +
              • -
            - - - -
              -
            • -

              getType

              -
              public Task.TaskType getType()
              -
              -
              Returns:
              +
            • +
              +

              getType

              +
              public Task.TaskType getType()
              +
              +
              Returns:
              The type of this Task
              +
              • -
            - - - -
              -
            • -

              isQueued

              -
              public boolean isQueued()
              -
              -
              Returns:
              +
            • +
              +

              isQueued

              +
              public boolean isQueued()
              +
              +
              Returns:
              Whether this Task is queued, same as BukkitScheduler.isQueued(int)
              +
              • -
            - - - -
              -
            • -

              isCurrentlyRunning

              -
              public boolean isCurrentlyRunning()
              -
              -
              Returns:
              +
            • +
              +

              isCurrentlyRunning

              +
              public boolean isCurrentlyRunning()
              +
              +
              Returns:
              Whether this Task is currently running, same as BukkitScheduler.isCurrentlyRunning(int)
              +
              • -
            - - - -
              -
            • -

              cancel

              -
              public void cancel()
              +
            • +
              +

              cancel

              +
              public void cancel()
              Cancels this task, same as BukkitScheduler.cancelTask(int)
              +
              • -
            - - - -
              -
            • -

              getPlugin

              -
              public org.bukkit.plugin.Plugin getPlugin()
              -
              -
              Returns:
              +
            • +
              +

              getPlugin

              +
              public org.bukkit.plugin.Plugin getPlugin()
              +
              +
              Returns:
              The Plugin which scheduled this task
              -
              • -
            +
      -
    - - + + + + diff --git a/javadoc/redempt/redlib/misc/UserCache.html b/javadoc/redempt/redlib/misc/UserCache.html index c296447..a24f44c 100644 --- a/javadoc/redempt/redlib/misc/UserCache.html +++ b/javadoc/redempt/redlib/misc/UserCache.html @@ -5,364 +5,269 @@ UserCache (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.misc
    -

    Class UserCache

    +
    Package redempt.redlib.misc
    +

    Class UserCache

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.misc.UserCache
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      redempt.redlib.misc.UserCache
      +
      +
      -
      public class UserCache
+
      public class UserCache
 extends java.lang.Object
      
 
      A cache of offline users by name which can be queried without worrying about web requests
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Constructor Summary

          - - +
        • +
          +

          Constructor Summary

          +
          +
          • Constructors 
          + + - - + + - - - + + + + + +
          Constructors
          ConstructorDescriptionConstructorDescription
          UserCache() 
          UserCache() 
          -
          • -
        +
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Static Methods Concrete Methods 
      + - - - + + + - - - - + + + + + - - - - + + + - - - - + + + - - - - + + + +
      Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
      static voidasyncInit() +
      static voidasyncInit()
      Initializes the user cache asynchronously
      static voidasyncInit​(java.lang.Runnable onComplete) +
      static voidasyncInit​(java.lang.Runnable onComplete)
      Initializes the user cache asynchronously
      static org.bukkit.OfflinePlayergetOfflinePlayer​(java.lang.String name) +
      static org.bukkit.OfflinePlayergetOfflinePlayer​(java.lang.String name)
      Gets an OfflinePlayer by name
      static voidinit() +
      static voidinit()
      Initializes the user cache synchronously
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

    Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - -
            -
          • -

            UserCache

            -
            public UserCache()
            -
            • -
          +
        • +
          +

          Constructor Details

          +
            +
          • +
            +

            UserCache

            +
            public UserCache()
            +
          +
          • -
          -
            -
          • - - -

            Method Detail

            - - - -
              -
            • -

              asyncInit

              -
              public static void asyncInit​(java.lang.Runnable onComplete)
              +
            • +
              +

              Method Details

              +
                +
              • +
                +

                asyncInit

                +
                public static void asyncInit​(java.lang.Runnable onComplete)
                Initializes the user cache asynchronously
                -
                -
                Parameters:
                +
                +
                Parameters:
                onComplete - A Runnable to be run when the initialization is complete
                +
                • -
              - - - -
                -
              • -

                asyncInit

                -
                public static void asyncInit()
                +
              • +
                +

                asyncInit

                +
                public static void asyncInit()
                Initializes the user cache asynchronously
                +
                • -
              - - - -
                -
              • -

                init

                -
                public static void init()
                +
              • +
                +

                init

                +
                public static void init()
                Initializes the user cache synchronously
                +
                • -
              - - - -
                -
              • -

                getOfflinePlayer

                -
                public static org.bukkit.OfflinePlayer getOfflinePlayer​(java.lang.String name)
                +
              • +
                +

                getOfflinePlayer

                +
                public static org.bukkit.OfflinePlayer getOfflinePlayer​(java.lang.String name)
                Gets an OfflinePlayer by name
                -
                -
                Parameters:
                +
                +
                Parameters:
                name - The name of the player, case insensitive
                -
                Returns:
                +
                Returns:
                The OfflinePlayer, or null
                -
                • -
              +
        -
    - - + + + + diff --git a/javadoc/redempt/redlib/misc/WeightedRandom.html b/javadoc/redempt/redlib/misc/WeightedRandom.html index d0993a5..123b8d4 100644 --- a/javadoc/redempt/redlib/misc/WeightedRandom.html +++ b/javadoc/redempt/redlib/misc/WeightedRandom.html @@ -5,637 +5,508 @@ WeightedRandom (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.misc
    -

    Class WeightedRandom<T>

    +
    Package redempt.redlib.misc
    +

    Class WeightedRandom<T>

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.misc.WeightedRandom<T>
        • -
      -
      • -
    -
    -
      -
    • -
      -
      Type Parameters:
      +
      java.lang.Object +
      redempt.redlib.misc.WeightedRandom<T>
      +
      +
      +
      +
      Type Parameters:
      T - The type of the value
      -
      public class WeightedRandom<T>
+
      public class WeightedRandom<T>
 extends java.lang.Object
      
 
      Uses a map of outcomes to weights to get random values
      
-
      • -
    -
    -
    -
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Static Methods Instance Methods Concrete Methods 
      + - - - + + + - - - - + + + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + +
      Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
      WeightedRandom<T>clone() +
      WeightedRandom<T>clone()
      Creates a copy of this WeightedRandom
      static <T,​K>
      WeightedRandom<T>      		fromCollection​(java.util.Collection<K> collection, - java.util.function.Function<K,​T> converter, - java.util.function.ToDoubleFunction<K> weightGetter) +
      static <T,​ +K> WeightedRandom<T>fromCollection​(java.util.Collection<K> collection, +java.util.function.Function<K,​T> converter, +java.util.function.ToDoubleFunction<K> weightGetter)
      Creates a WeightedRandom from a collection
      static <T> WeightedRandom<T>fromDoubleMap​(java.util.Map<T,​java.lang.Double> map) +
      static <T> WeightedRandom<T>fromDoubleMap​(java.util.Map<T,​java.lang.Double> map)
      Create a new WeightedRandom from a map of outcomes to their weights
      static <T> WeightedRandom<T>fromIntMap​(java.util.Map<T,​java.lang.Integer> map) +
      static <T> WeightedRandom<T>fromIntMap​(java.util.Map<T,​java.lang.Integer> map)
      Create a new WeightedRandom from a map of outcomes to their weights
      static <T> WeightedRandom<T>fromString​(java.lang.String str, - java.util.function.Function<java.lang.String,​T> converter) +
      static <T> WeightedRandom<T>fromString​(java.lang.String str, +java.util.function.Function<java.lang.String,​T> converter)
      Deserializes a string to create a WeightedRandom
      java.util.Map<T,​java.lang.Double>getPercentages() +
      java.util.Map<T,​java.lang.Double>getPercentages()
      Gets the chance each outcome has to occur in percentage (0-100)
      java.util.Map<T,​java.lang.Double>getWeights() +
      java.util.Map<T,​java.lang.Double>getWeights()
      Gets the map of weights for this WeightedRandom
      voidremove​(T outcome) +
      voidremove​(T outcome)
      Removes an outcome from this WeightedRandom
      Troll() +
      Troll()
      Rolls and gets a weighted random outcome
      static <T> Troll​(java.util.Map<T,​java.lang.Integer> map) +
      static <T> Troll​(java.util.Map<T,​java.lang.Integer> map)
      Performs a single roll given a map of outcomes to weights.
      voidset​(T outcome, - double weight) +
      voidset​(T outcome, +double weight)
      Sets another weight in this WeightedRandom, replacing the weight of the outcome if it has already been added
      voidset​(T outcome, - int weight) +
      voidset​(T outcome, +int weight)
      Sets another weight in this WeightedRandom, replacing the weight of the outcome if it has already been added
      java.lang.StringtoString​(java.util.function.Function<T,​java.lang.String> converter) +
      java.lang.StringtoString​(java.util.function.Function<T,​java.lang.String> converter)
      Converts this WeightedRandom to a String which can be deserialized later
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

    Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - -
            -
          • -

            WeightedRandom

            -
            public WeightedRandom​(java.util.Map<T,​java.lang.Integer> weights)
            -
            Deprecated. -
            Use fromIntMap(Map)
            +
          • +
            +

            Constructor Details

            +
              +
            • +
              +

              WeightedRandom

              +
              public WeightedRandom​(java.util.Map<T,​java.lang.Integer> weights)
              +
              Deprecated. +
              Use fromIntMap(Map)
              Creates a WeightedRandom using the map of weights
              -
              -
              Parameters:
              +
              +
              Parameters:
              weights - The map of outcomes to weights
              +
              • -
            - - - -
              -
            • -

              WeightedRandom

              -
              public WeightedRandom()
              +
            • +
              +

              WeightedRandom

              +
              public WeightedRandom()
              Create an empty WeightedRandom
              -
              • -
            +
        + -
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            fromIntMap

            -
            public static <T> WeightedRandom<T> fromIntMap​(java.util.Map<T,​java.lang.Integer> map)
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              fromIntMap

              +
              public static <T> WeightedRandom<T> fromIntMap​(java.util.Map<T,​java.lang.Integer> map)
              Create a new WeightedRandom from a map of outcomes to their weights
              -
              -
              Type Parameters:
              +
              +
              Type Parameters:
              T - The type of the outcomes
              -
              Parameters:
              +
              Parameters:
              map - The map of outcomes to their weights
              -
              Returns:
              +
              Returns:
              A WeightedRandom which can be used to roll for the given outcome
              +
              • -
            - - - -
              -
            • -

              fromDoubleMap

              -
              public static <T> WeightedRandom<T> fromDoubleMap​(java.util.Map<T,​java.lang.Double> map)
              +
            • +
              +

              fromDoubleMap

              +
              public static <T> WeightedRandom<T> fromDoubleMap​(java.util.Map<T,​java.lang.Double> map)
              Create a new WeightedRandom from a map of outcomes to their weights
              -
              -
              Type Parameters:
              +
              +
              Type Parameters:
              T - The type of the outcomes
              -
              Parameters:
              +
              Parameters:
              map - The map of outcomes to their weights
              -
              Returns:
              +
              Returns:
              A WeightedRandom which can be used to roll for the given outcome
              +
              • -
            - - - -
              -
            • -

              fromCollection

              -
              public static <T,​K> WeightedRandom<T> fromCollection​(java.util.Collection<K> collection,
-                                                           java.util.function.Function<K,​T> converter,
-                                                           java.util.function.ToDoubleFunction<K> weightGetter)
              +
            • +
              +

              fromCollection

              +
              public static <T,​ +K> WeightedRandom<T> fromCollection​(java.util.Collection<K> collection, +java.util.function.Function<K,​T> converter, +java.util.function.ToDoubleFunction<K> weightGetter)
              Creates a WeightedRandom from a collection
              -
              -
              Type Parameters:
              +
              +
              Type Parameters:
              T - The type the WeightedRandom will roll on
              K - The type of the elements in the Collection
              -
              Parameters:
              +
              Parameters:
              collection - The collection to convert
              converter - The function to convert from the type in the collection to the type in the WeightedRandom
              weightGetter - The function to get the weight of an element in the collection
              -
              Returns:
              +
              Returns:
              The populated WeightedRandom
              +
              • -
            - - - -
              -
            • -

              roll

              -
              public T roll()
              +
            • +
              +

              roll

              +
              public T roll()
              Rolls and gets a weighted random outcome
              -
              -
              Returns:
              +
              +
              Returns:
              A weighted random outcome, or null if there are no possible outcomes
              +
              • -
            - - - -
              -
            • -

              getPercentages

              -
              public java.util.Map<T,​java.lang.Double> getPercentages()
              +
            • +
              +

              getPercentages

              +
              public java.util.Map<T,​java.lang.Double> getPercentages()
              Gets the chance each outcome has to occur in percentage (0-100)
              -
              -
              Returns:
              +
              +
              Returns:
              A map of each outcome to its percentage chance to occur when calling roll()
              +
              • -
            - - - -
              -
            • -

              getWeights

              -
              public java.util.Map<T,​java.lang.Double> getWeights()
              +
            • +
              +

              getWeights

              +
              public java.util.Map<T,​java.lang.Double> getWeights()
              Gets the map of weights for this WeightedRandom
              -
              -
              Returns:
              +
              +
              Returns:
              The weight map
              +
              • -
            - - - - - -
              -
            • -

              set

              -
              public void set​(T outcome,
-                int weight)
              +
            • +
              +

              set

              +
              public void set​(T outcome, +int weight)
              Sets another weight in this WeightedRandom, replacing the weight of the outcome if it has already been added
              -
              -
              Parameters:
              +
              +
              Parameters:
              outcome - The weight to set
              weight - The outcome to set
              +
              • -
            - - - - - -
              -
            • -

              set

              -
              public void set​(T outcome,
-                double weight)
              +
            • +
              +

              set

              +
              public void set​(T outcome, +double weight)
              Sets another weight in this WeightedRandom, replacing the weight of the outcome if it has already been added
              -
              -
              Parameters:
              +
              +
              Parameters:
              outcome - The weight to set
              weight - The outcome to set
              +
              • -
            - - - - - -
              -
            • -

              remove

              -
              public void remove​(T outcome)
              +
            • +
              +

              remove

              +
              public void remove​(T outcome)
              Removes an outcome from this WeightedRandom
              -
              -
              Parameters:
              +
              +
              Parameters:
              outcome - The outcome to remove
              +
              • -
            - - - -
              -
            • -

              clone

              -
              public WeightedRandom<T> clone()
              +
            • +
              +

              clone

              +
              public WeightedRandom<T> clone()
              Creates a copy of this WeightedRandom
              -
              -
              Overrides:
              +
              +
              Overrides:
              clone in class java.lang.Object
              -
              Returns:
              +
              Returns:
              An identical copy of this WeightedRandom
              +
              • -
            - - - -
              -
            • -

              toString

              -
              public java.lang.String toString​(java.util.function.Function<T,​java.lang.String> converter)
              +
            • +
              +

              toString

              +
              public java.lang.String toString​(java.util.function.Function<T,​java.lang.String> converter)
              Converts this WeightedRandom to a String which can be deserialized later
              -
              -
              Parameters:
              +
              +
              Parameters:
              converter - A function to convert the outcomes of this WeightedRandom to strings which can be deserialized later
              -
              Returns:
              +
              Returns:
              The string representing this WeightedRandom
              +
              • -
            - - - -
              -
            • -

              fromString

              -
              public static <T> WeightedRandom<T> fromString​(java.lang.String str,
-                                               java.util.function.Function<java.lang.String,​T> converter)
              +
            • +
              +

              fromString

              +
              public static <T> WeightedRandom<T> fromString​(java.lang.String str, +java.util.function.Function<java.lang.String,​T> converter)
              Deserializes a string to create a WeightedRandom
              -
              -
              Type Parameters:
              +
              +
              Type Parameters:
              T - The type of the outcomes
              -
              Parameters:
              +
              Parameters:
              str - The string serialized using toString(Function)
              converter - A function to convert the serialized outcomes back to objects
              -
              Returns:
              +
              Returns:
              The deserialized WeightedRandom
              +
              • -
            - - - -
              -
            • -

              roll

              -
              public static <T> T roll​(java.util.Map<T,​java.lang.Integer> map)
              +
            • +
              +

              roll

              +
              public static <T> T roll​(java.util.Map<T,​java.lang.Integer> map)
              Performs a single roll given a map of outcomes to weights. If you need to roll multiple times, instantiate a WeightedRandom and call roll on that each time instead.
              -
              -
              Type Parameters:
              +
              +
              Type Parameters:
              T - The type being returned
              -
              Parameters:
              +
              Parameters:
              map - The map of outcomes to weights
              -
              Returns:
              +
              Returns:
              A weighted random outcome
              -
              • -
            +
      -
    - - + + + + diff --git a/javadoc/redempt/redlib/misc/package-summary.html b/javadoc/redempt/redlib/misc/package-summary.html index d68bed4..8e43ea4 100644 --- a/javadoc/redempt/redlib/misc/package-summary.html +++ b/javadoc/redempt/redlib/misc/package-summary.html @@ -5,47 +5,30 @@ redempt.redlib.misc (RedLib API) + + - + + - - - - - + + - - -
    +
    + +

    Package redempt.redlib.misc

    -
    -
    -
  • - - +
  • +
    +
    • Enum Summary 
    + + - - + + + - - - + + + - - - + +
    Enum Summary
    EnumDescriptionEnumDescription
    ChatPrompt.CancelReason 
    ChatPrompt.CancelReason 
    Task.TaskType +
    Task.TaskType
    Represents a type of task
    +
    • -
    +
    + + +
    + + diff --git a/javadoc/redempt/redlib/misc/package-tree.html b/javadoc/redempt/redlib/misc/package-tree.html index 787fb2b..26f9e81 100644 --- a/javadoc/redempt/redlib/misc/package-tree.html +++ b/javadoc/redempt/redlib/misc/package-tree.html @@ -5,181 +5,114 @@ redempt.redlib.misc Class Hierarchy (RedLib API) + + - + + - - - - - + + - - -
    +
    + +

    Hierarchy For Package redempt.redlib.misc

    -Package Hierarchies: +Package Hierarchies:
    -
    -
    +

    Class Hierarchy

    -
    +

    Enum Hierarchy

    • java.lang.Object
    -
    +
    +
    diff --git a/javadoc/redempt/redlib/multiblock/MultiBlockStructure.html b/javadoc/redempt/redlib/multiblock/MultiBlockStructure.html index c6e1a83..05eb0de 100644 --- a/javadoc/redempt/redlib/multiblock/MultiBlockStructure.html +++ b/javadoc/redempt/redlib/multiblock/MultiBlockStructure.html @@ -5,1052 +5,929 @@ MultiBlockStructure (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.multiblock
    -

    Class MultiBlockStructure

    +
    Package redempt.redlib.multiblock
    +

    Class MultiBlockStructure

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.multiblock.MultiBlockStructure
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      redempt.redlib.multiblock.MultiBlockStructure
      +
      +
      -
      public class MultiBlockStructure
+
      public class MultiBlockStructure
 extends java.lang.Object
      
 
      A utility class intended to create interactive multi-block structures.
  Can also be used to store and copy large sections of blocks.
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Field Summary

          - - +
        • +
          +

          Field Summary

          +
          +
          • Fields 
          + + - - - + + + - - - - + + + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + +
          Fields
          Modifier and TypeFieldDescriptionModifier and TypeFieldDescription
          protected StructureData[][][]data 
          protected StructureData[][][]data 
          protected intdimX 
          protected intdimX 
          protected intdimY 
          protected intdimY 
          protected intdimZ 
          protected intdimZ 
          protected booleanignoreAir 
          protected booleanignoreAir 
          protected booleanstrictMode 
          protected booleanstrictMode 
          protected java.util.EnumSet<org.bukkit.Material>strictModeExclude 
          protected java.util.EnumSet<org.bukkit.Material>strictModeExclude 
          -
          • -
        +
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Static Methods Instance Methods Concrete Methods 
      + - - - + + + - - - - + + + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + + - - - - + + + - - - - + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + - - - - + + + - - - - + + + + - - - - + + + - - - - + + + +
      Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
      voidaddStrictModeExclusions​(org.bukkit.Material... materials) +
      voidaddStrictModeExclusions​(org.bukkit.Material... materials)
      Add a list of Materials to be excluded from strict data checks rather than disabling strict mode for all blocks
      StructureassumeAt​(org.bukkit.Location loc) +
      StructureassumeAt​(org.bukkit.Location loc)
      Gets the Structure at the given block, performing no checks to ensure it exists.
      StructureassumeAt​(org.bukkit.Location loc, - int rotation) +
      StructureassumeAt​(org.bukkit.Location loc, +int rotation)
      Gets the Structure at the given block, performing no checks to ensure it exists.
      StructureassumeAt​(org.bukkit.Location loc, - int rotation, - boolean mirror) +
      StructureassumeAt​(org.bukkit.Location loc, +int rotation, +boolean mirror)
      Gets the Structure at the given block, performing no checks to ensure it exists.
      StructureassumeAt​(org.bukkit.Location loc, - int relX, - int relY, - int relZ, - int rotation, - boolean mirror) +
      StructureassumeAt​(org.bukkit.Location loc, +int relX, +int relY, +int relZ, +int rotation, +boolean mirror)
      Gets the Structure at the given block, performing no checks to ensure it exists.
      Structurebuild​(org.bukkit.Location loc) +
      Structurebuild​(org.bukkit.Location loc)
      Builds this multi-block structure at the given location
      Structurebuild​(org.bukkit.Location loc, - int rotation) +
      Structurebuild​(org.bukkit.Location loc, +int rotation)
      Builds this multi-block structure at the given location
      Structurebuild​(org.bukkit.Location loc, - int relX, - int relY, - int relZ) +
      Structurebuild​(org.bukkit.Location loc, +int relX, +int relY, +int relZ)
      Builds this multi-block structure at the given location
      Structurebuild​(org.bukkit.Location loc, - int relX, - int relY, - int relZ, - int rotation) +
      Structurebuild​(org.bukkit.Location loc, +int relX, +int relY, +int relZ, +int rotation)
      Builds this multi-block structure at the given location
      Structurebuild​(org.bukkit.Location loc, - int relX, - int relY, - int relZ, - int rotation, - boolean mirror) +
      Structurebuild​(org.bukkit.Location loc, +int relX, +int relY, +int relZ, +int rotation, +boolean mirror)
      Builds this multi-block structure at the given location
      intbuildAsync​(org.bukkit.Location loc, - int rotation, - boolean mirror, - int blocksPerTick, - java.util.function.Consumer<Structure> callback) +
      intbuildAsync​(org.bukkit.Location loc, +int rotation, +boolean mirror, +int blocksPerTick, +java.util.function.Consumer<Structure> callback)
      Build this multi-block structure over multiple ticks
      intbuildAsync​(org.bukkit.Location loc, - int relX, - int relY, - int relZ, - int rotation, - boolean mirror, - int blocksPerTick, - java.util.function.Consumer<Structure> callback) +
      intbuildAsync​(org.bukkit.Location loc, +int relX, +int relY, +int relZ, +int rotation, +boolean mirror, +int blocksPerTick, +java.util.function.Consumer<Structure> callback)
      Build this multi-block structure over multiple ticks
      intbuildAsync​(org.bukkit.Location loc, - int rotation, - int blocksPerTick, - java.util.function.Consumer<Structure> callback) +
      intbuildAsync​(org.bukkit.Location loc, +int rotation, +int blocksPerTick, +java.util.function.Consumer<Structure> callback)
      Build this multi-block structure over multiple ticks
      intbuildAsync​(org.bukkit.Location loc, - int blocksPerTick, - java.util.function.Consumer<Structure> callback) +
      intbuildAsync​(org.bukkit.Location loc, +int blocksPerTick, +java.util.function.Consumer<Structure> callback)
      Build this multi-block structure over multiple ticks
      booleancanBuild​(org.bukkit.Location loc, - int rotation, - boolean mirror, - java.util.function.Predicate<org.bukkit.Location> filter) +
      booleancanBuild​(org.bukkit.Location loc, +int rotation, +boolean mirror, +java.util.function.Predicate<org.bukkit.Location> filter)
      Uses a Predicate to test each block where this structure would be built
      booleancanBuild​(org.bukkit.Location loc, - int relX, - int relY, - int relZ, - int rotation, - boolean mirror, - java.util.function.Predicate<org.bukkit.Location> filter) +
      booleancanBuild​(org.bukkit.Location loc, +int relX, +int relY, +int relZ, +int rotation, +boolean mirror, +java.util.function.Predicate<org.bukkit.Location> filter)
      Uses a Predicate to test each block where this structure would be built
      booleancanBuild​(org.bukkit.Location loc, - int rotation, - java.util.function.Predicate<org.bukkit.Location> filter) +
      booleancanBuild​(org.bukkit.Location loc, +int rotation, +java.util.function.Predicate<org.bukkit.Location> filter)
      Uses a Predicate to test each block where this structure would be built
      booleancanBuild​(org.bukkit.Location loc, - java.util.function.Predicate<org.bukkit.Location> filter) +
      booleancanBuild​(org.bukkit.Location loc, +java.util.function.Predicate<org.bukkit.Location> filter)
      Uses a Predicate to test each block where this structure would be built
      protected booleancompare​(StructureData data, - org.bukkit.block.Block block, - Rotator rotator) 
      protected booleancompare​(StructureData data, +org.bukkit.block.Block block, +Rotator rotator) 
      static MultiBlockStructurecreate​(java.io.InputStream stream, - java.lang.String name) +
      static MultiBlockStructurecreate​(java.io.InputStream stream, +java.lang.String name)
      Creates a MultiBlockStructure instance from an input stream containing the info string
      static MultiBlockStructurecreate​(java.io.InputStream stream, - java.lang.String name, - boolean strictMode) +
      static MultiBlockStructurecreate​(java.io.InputStream stream, +java.lang.String name, +boolean strictMode)
      Creates a MultiBlockStructure instance from an input stream containing the info string
      static MultiBlockStructurecreate​(java.io.InputStream stream, - java.lang.String name, - boolean strictMode, - boolean ignoreAir) +
      static MultiBlockStructurecreate​(java.io.InputStream stream, +java.lang.String name, +boolean strictMode, +boolean ignoreAir)
      Creates a MultiBlockStructure instance from an input stream containing the info string
      static MultiBlockStructurecreate​(java.lang.String info, - java.lang.String name) +
      static MultiBlockStructurecreate​(java.lang.String info, +java.lang.String name)
      Creates a MultiBlockStructure instance from an info string
      static MultiBlockStructurecreate​(java.lang.String info, - java.lang.String name, - boolean strictMode) +
      static MultiBlockStructurecreate​(java.lang.String info, +java.lang.String name, +boolean strictMode)
      Creates a MultiBlockStructure instance from an info string
      static MultiBlockStructurecreate​(java.lang.String info, - java.lang.String name, - boolean strictMode, - boolean ignoreAir) +
      static MultiBlockStructurecreate​(java.lang.String info, +java.lang.String name, +boolean strictMode, +boolean ignoreAir)
      Creates a MultiBlockStructure instance from an info string
      booleanequals​(java.lang.Object o) 
      booleanequals​(java.lang.Object o) 
      voidforEachBlock​(org.bukkit.Location loc, - int rotation, - boolean mirror, - java.util.function.Consumer<org.bukkit.block.BlockState> callback) +
      voidforEachBlock​(org.bukkit.Location loc, +int rotation, +boolean mirror, +java.util.function.Consumer<org.bukkit.block.BlockState> callback)
      Iterates each block which would be set if this structure is built
      voidforEachBlock​(org.bukkit.Location loc, - int relX, - int relY, - int relZ, - int rotation, - boolean mirror, - java.util.function.Consumer<org.bukkit.block.BlockState> callback) +
      voidforEachBlock​(org.bukkit.Location loc, +int relX, +int relY, +int relZ, +int rotation, +boolean mirror, +java.util.function.Consumer<org.bukkit.block.BlockState> callback)
      Iterates each block which would be set if this structure is built
      voidforEachBlock​(org.bukkit.Location loc, - int rotation, - java.util.function.Consumer<org.bukkit.block.BlockState> callback) +
      voidforEachBlock​(org.bukkit.Location loc, +int rotation, +java.util.function.Consumer<org.bukkit.block.BlockState> callback)
      Iterates each block which would be set if this structure is built
      voidforEachBlock​(org.bukkit.Location loc, - java.util.function.Consumer<org.bukkit.block.BlockState> callback) +
      voidforEachBlock​(org.bukkit.Location loc, +java.util.function.Consumer<org.bukkit.block.BlockState> callback)
      Iterates each block which would be set if this structure is built
      StructuregetAt​(org.bukkit.Location loc) +
      StructuregetAt​(org.bukkit.Location loc)
      Gets the Structure at the given block, if it exists.
      StructuregetAt​(org.bukkit.Location loc, - int relX, - int relY, - int relZ, - int rotation, - boolean mirror) +
      StructuregetAt​(org.bukkit.Location loc, +int relX, +int relY, +int relZ, +int rotation, +boolean mirror)
      Gets the Structure at the given block, if it exists.
      org.bukkit.block.BlockStategetData​(int relX, - int relY, - int relZ) +
      org.bukkit.block.BlockStategetData​(int relX, +int relY, +int relZ)
      Gets the data of this structure at a given relative location
      org.bukkit.block.BlockStategetData​(org.bukkit.Location loc, - int relX, - int relY, - int relZ) +
      org.bukkit.block.BlockStategetData​(org.bukkit.Location loc, +int relX, +int relY, +int relZ)
      Gets the data of this structure at a given relative location, set with a BlockState at the given location
      int[]getDimensions() +
      int[]getDimensions()
      Gets the dimensions of this multi-block structure.
      java.lang.StringgetName() +
      java.lang.StringgetName()
      Gets this multi-block structure's name.
      CuboidRegiongetRegion​(org.bukkit.Location loc) +
      CuboidRegiongetRegion​(org.bukkit.Location loc)
      Gets the Region this multi-block structure would occupy, were it built here
      CuboidRegiongetRegion​(org.bukkit.Location loc, - int rotation) +
      CuboidRegiongetRegion​(org.bukkit.Location loc, +int rotation)
      Gets the Region this multi-block structure would occupy, were it built here
      CuboidRegiongetRegion​(org.bukkit.Location loc, - int rotation, - boolean mirror) +
      CuboidRegiongetRegion​(org.bukkit.Location loc, +int rotation, +boolean mirror)
      Gets the Region this multi-block structure would occupy, were it built here
      CuboidRegiongetRegion​(org.bukkit.Location loc, - int relX, - int relY, - int relZ, - int rotation, - boolean mirror) +
      CuboidRegiongetRegion​(org.bukkit.Location loc, +int relX, +int relY, +int relZ, +int rotation, +boolean mirror)
      Gets the Region this multi-block structure would occupy, were it built here
      java.util.Set<org.bukkit.Material>getStrictModeExclusions() 
      java.util.Set<org.bukkit.Material>getStrictModeExclusions() 
      StructureDatagetStructureData​(int relX, - int relY, - int relZ) +
      StructureDatagetStructureData​(int relX, +int relY, +int relZ)
      Gets the StructureData at a certain relative position
      org.bukkit.MaterialgetType​(int relX, - int relY, - int relZ) +
      org.bukkit.MaterialgetType​(int relX, +int relY, +int relZ)
      Gets the Material at a certain relative position
      intgetVolume() 
      intgetVolume() 
      inthashCode() 
      inthashCode() 
      booleanignoresAir() 
      booleanignoresAir() 
      booleanisStrictMode() 
      booleanisStrictMode() 
      static java.lang.Stringstringify​(org.bukkit.Location start, - org.bukkit.Location end) +
      static java.lang.Stringstringify​(org.bukkit.Location start, +org.bukkit.Location end)
      Use this to get the info to construct a multi-block structure.
      static java.lang.Stringstringify​(org.bukkit.Location start, - org.bukkit.Location end, - org.bukkit.Material skip) +
      static java.lang.Stringstringify​(org.bukkit.Location start, +org.bukkit.Location end, +org.bukkit.Material skip)
      Use this to get the info to construct a multi-block structure.
      java.lang.StringtoString() 
      java.lang.StringtoString() 
      voidvisualize​(org.bukkit.entity.Player player, - org.bukkit.Location loc, - int relX, - int relY, - int relZ) +
      voidvisualize​(org.bukkit.entity.Player player, +org.bukkit.Location loc, +int relX, +int relY, +int relZ)
      Sends ghost blocks of this multi-block structure to the given player at the given location
      voidvisualize​(org.bukkit.entity.Player player, - org.bukkit.Location loc, - int relX, - int relY, - int relZ, - int rotation, - boolean mirror) +
      voidvisualize​(org.bukkit.entity.Player player, +org.bukkit.Location loc, +int relX, +int relY, +int relZ, +int rotation, +boolean mirror)
      Sends ghost blocks of this multi-block structure to the given player at the given location
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

    Methods inherited from class java.lang.Object

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

          Field Detail

          - - - - - - - -
            -
          • -

            dimX

            -
            protected int dimX
            +
          • +
            +

            Field Details

            + - - - -
              -
            • -

              dimY

              -
              protected int dimY
              +
            • +
              +

              dimX

              +
              protected int dimX
              +
              • -
            - - - -
              -
            • -

              dimZ

              -
              protected int dimZ
              +
            • +
              +

              dimY

              +
              protected int dimY
              +
              • -
            - - - -
              -
            • -

              strictMode

              -
              protected boolean strictMode
              +
            • +
              +

              dimZ

              +
              protected int dimZ
              +
              • -
            - - - -
              -
            • -

              ignoreAir

              -
              protected boolean ignoreAir
              +
            • +
              +

              strictMode

              +
              protected boolean strictMode
              +
              • -
            - - - -
              -
            • -

              strictModeExclude

              -
              protected java.util.EnumSet<org.bukkit.Material> strictModeExclude
              +
            • +
              +

              ignoreAir

              +
              protected boolean ignoreAir
              +
              • -
            +
          • +
            +

            strictModeExclude

            +
            protected java.util.EnumSet<org.bukkit.Material> strictModeExclude
            +
        + -
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            stringify

            -
            public static java.lang.String stringify​(org.bukkit.Location start,
-                                         org.bukkit.Location end,
-                                         org.bukkit.Material skip)
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              stringify

              +
              public static java.lang.String stringify​(org.bukkit.Location start, +org.bukkit.Location end, +org.bukkit.Material skip)
              Use this to get the info to construct a multi-block structure. Should be hard-coded. You can use the multi-block structure tool (/struct wand) as long as devMode is true
              -
              -
              Parameters:
              +
              +
              Parameters:
              start - One bounding corner of the region
              end - The other bounding corner of the region
              skip - A block type to be skipped, in case it was used to select the corners
              -
              Returns:
              +
              Returns:
              A string representing all of the block data for the region
              -
              Throws:
              +
              Throws:
              java.lang.IllegalArgumentException - if the specified locations are not in the same world
              +
              • -
            - - - -
              -
            • -

              stringify

              -
              public static java.lang.String stringify​(org.bukkit.Location start,
-                                         org.bukkit.Location end)
              +
            • +
              +

              stringify

              +
              public static java.lang.String stringify​(org.bukkit.Location start, +org.bukkit.Location end)
              Use this to get the info to construct a multi-block structure. Should be hard-coded. You can use the multi-block structure tool (/struct wand) as long as devMode is true
              -
              -
              Parameters:
              +
              +
              Parameters:
              start - One bounding corner of the region
              end - The other bounding corner of the region
              -
              Returns:
              +
              Returns:
              A string representing all of the block data for the region
              -
              Throws:
              +
              Throws:
              java.lang.IllegalArgumentException - if the specified locations are not in the same world
              +
              • -
            - - - -
              -
            • -

              create

              -
              public static MultiBlockStructure create​(java.lang.String info,
-                                         java.lang.String name)
              +
            • +
              +

              create

              +
              public static MultiBlockStructure create​(java.lang.String info, +java.lang.String name)
              Creates a MultiBlockStructure instance from an info string
              -
              -
              Parameters:
              +
              +
              Parameters:
              info - The info string. Get this from stringify(Location, Location)
              name - The name of the multi-block structure
              -
              Returns:
              +
              Returns:
              The multi-block structure
              +
              • -
            - - - -
              -
            • -

              create

              -
              public static MultiBlockStructure create​(java.lang.String info,
-                                         java.lang.String name,
-                                         boolean strictMode)
              +
            • +
              +

              create

              +
              public static MultiBlockStructure create​(java.lang.String info, +java.lang.String name, +boolean strictMode)
              Creates a MultiBlockStructure instance from an info string
              -
              -
              Parameters:
              +
              +
              Parameters:
              info - The info string. Get this from stringify(Location, Location)
              name - The name of the multi-block structure
              strictMode - Whether block data is taken into account. Only checks material if false. Defaults to true.
              -
              Returns:
              +
              Returns:
              The multi-block structure
              +
              • -
            - - - -
              -
            • -

              create

              -
              public static MultiBlockStructure create​(java.lang.String info,
-                                         java.lang.String name,
-                                         boolean strictMode,
-                                         boolean ignoreAir)
              +
            • +
              +

              create

              +
              public static MultiBlockStructure create​(java.lang.String info, +java.lang.String name, +boolean strictMode, +boolean ignoreAir)
              Creates a MultiBlockStructure instance from an info string
              -
              -
              Parameters:
              +
              +
              Parameters:
              info - The info string. Get this from stringify(Location, Location)
              name - The name of the multi-block structure
              strictMode - Whether block data is taken into account. Only checks material if false. Defaults to true.
              ignoreAir - If true, air in the original structure is skipped when checking blocks. Defaults to false.
              -
              Returns:
              +
              Returns:
              The multi-block structure
              +
              • -
            - - - -
              -
            • -

              create

              -
              public static MultiBlockStructure create​(java.io.InputStream stream,
-                                         java.lang.String name,
-                                         boolean strictMode,
-                                         boolean ignoreAir)
              +
            • +
              +

              create

              +
              public static MultiBlockStructure create​(java.io.InputStream stream, +java.lang.String name, +boolean strictMode, +boolean ignoreAir)
              Creates a MultiBlockStructure instance from an input stream containing the info string
              -
              -
              Parameters:
              +
              +
              Parameters:
              stream - The input stream. Get this from JavaPlugin.getResource(String)
              name - The name of the multi-block structure
              strictMode - Whether block data is taken into account. Only checks material if false. Defaults to true.
              ignoreAir - If true, air in the original structure is skipped when checking blocks. Defaults to false.
              -
              Returns:
              +
              Returns:
              The multi-block structure
              +
              • -
            - - - -
              -
            • -

              create

              -
              public static MultiBlockStructure create​(java.io.InputStream stream,
-                                         java.lang.String name,
-                                         boolean strictMode)
              +
            • +
              +

              create

              +
              public static MultiBlockStructure create​(java.io.InputStream stream, +java.lang.String name, +boolean strictMode)
              Creates a MultiBlockStructure instance from an input stream containing the info string
              -
              -
              Parameters:
              +
              +
              Parameters:
              stream - The input stream. Get this from JavaPlugin.getResource(String)
              name - The name of the multi-block structure
              strictMode - Whether block data is taken into account. Only checks material if false. Defaults to true.
              -
              Returns:
              +
              Returns:
              The multi-block structure
              +
              • -
            - - - -
              -
            • -

              create

              -
              public static MultiBlockStructure create​(java.io.InputStream stream,
-                                         java.lang.String name)
              +
            • +
              +

              create

              +
              public static MultiBlockStructure create​(java.io.InputStream stream, +java.lang.String name)
              Creates a MultiBlockStructure instance from an input stream containing the info string
              -
              -
              Parameters:
              +
              +
              Parameters:
              stream - The input stream. Get this from JavaPlugin.getResource(String)
              name - The name of the multi-block structure
              -
              Returns:
              +
              Returns:
              The multi-block structure
              +
              • -
            - - - -
              -
            • -

              addStrictModeExclusions

              -
              public void addStrictModeExclusions​(org.bukkit.Material... materials)
              +
            • +
              +

              addStrictModeExclusions

              +
              public void addStrictModeExclusions​(org.bukkit.Material... materials)
              Add a list of Materials to be excluded from strict data checks rather than disabling strict mode for all blocks
              -
              -
              Parameters:
              +
              +
              Parameters:
              materials - The materials to exclude from strict mode checks
              +
              • -
            - - - -
              -
            • -

              getStrictModeExclusions

              -
              public java.util.Set<org.bukkit.Material> getStrictModeExclusions()
              -
              -
              Returns:
              +
            • +
              +

              getStrictModeExclusions

              +
              public java.util.Set<org.bukkit.Material> getStrictModeExclusions()
              +
              +
              Returns:
              A set of Materials to be excluded from strict data checks rather than disabling strict mode for all blocks
              +
              • -
            - - - -
              -
            • -

              getRegion

              -
              public CuboidRegion getRegion​(org.bukkit.Location loc,
-                              int relX,
-                              int relY,
-                              int relZ,
-                              int rotation,
-                              boolean mirror)
              +
            • +
              +

              getRegion

              +
              public CuboidRegion getRegion​(org.bukkit.Location loc, +int relX, +int relY, +int relZ, +int rotation, +boolean mirror)
              Gets the Region this multi-block structure would occupy, were it built here
              -
              -
              Parameters:
              +
              +
              Parameters:
              loc - The location of the multi-block structure
              relX - The relative X in the structure to center at
              relY - The relative Y in the structure to center at
              relZ - The relative Z in the structure to center at
              rotation - The number of 90-degree clockwise rotations to apply
              mirror - Whether to mirror the structure on the X axis
              -
              Returns:
              +
              Returns:
              The Region this multi-block structure would occupy
              +
              • -
            - - - -
              -
            • -

              getRegion

              -
              public CuboidRegion getRegion​(org.bukkit.Location loc,
-                              int rotation,
-                              boolean mirror)
              +
            • +
              +

              getRegion

              +
              public CuboidRegion getRegion​(org.bukkit.Location loc, +int rotation, +boolean mirror)
              Gets the Region this multi-block structure would occupy, were it built here
              -
              -
              Parameters:
              +
              +
              Parameters:
              loc - The location of the multi-block structure
              rotation - The number of 90-degree clockwise rotations to apply
              mirror - Whether to mirror the structure on the X axis
              -
              Returns:
              +
              Returns:
              The Region this multi-block structure would occupy
              +
              • -
            - - - -
              -
            • -

              getRegion

              -
              public CuboidRegion getRegion​(org.bukkit.Location loc,
-                              int rotation)
              +
            • +
              +

              getRegion

              +
              public CuboidRegion getRegion​(org.bukkit.Location loc, +int rotation)
              Gets the Region this multi-block structure would occupy, were it built here
              -
              -
              Parameters:
              +
              +
              Parameters:
              loc - The location of the multi-block structure
              rotation - The number of 90-degree clockwise rotations to apply
              -
              Returns:
              +
              Returns:
              The Region this multi-block structure would occupy
              +
              • -
            - - - -
              -
            • -

              getRegion

              -
              public CuboidRegion getRegion​(org.bukkit.Location loc)
              +
            • +
              +

              getRegion

              +
              public CuboidRegion getRegion​(org.bukkit.Location loc)
              Gets the Region this multi-block structure would occupy, were it built here
              -
              -
              Parameters:
              +
              +
              Parameters:
              loc - The location of the multi-block structure
              -
              Returns:
              +
              Returns:
              The Region this multi-block structure would occupy
              +
              • -
            - - - -
              -
            • -

              forEachBlock

              -
              public void forEachBlock​(org.bukkit.Location loc,
-                         int relX,
-                         int relY,
-                         int relZ,
-                         int rotation,
-                         boolean mirror,
-                         java.util.function.Consumer<org.bukkit.block.BlockState> callback)
              +
            • +
              +

              forEachBlock

              +
              public void forEachBlock​(org.bukkit.Location loc, +int relX, +int relY, +int relZ, +int rotation, +boolean mirror, +java.util.function.Consumer<org.bukkit.block.BlockState> callback)
              Iterates each block which would be set if this structure is built
              -
              -
              Parameters:
              +
              +
              Parameters:
              loc - The location the structure would be built at
              relX - The relative X in the structure to center at
              relY - The relative Y in the structure to center at
              @@ -1059,170 +936,146 @@

              forEachBlock

              mirror - Whether to mirror the structure on the X axis
              callback - The callback to be called, passed the BlockState which would be set if the structure is built here
              +
              • -
            - - - -
              -
            • -

              getData

              -
              public org.bukkit.block.BlockState getData​(org.bukkit.Location loc,
-                                           int relX,
-                                           int relY,
-                                           int relZ)
              +
            • +
              +

              getData

              +
              public org.bukkit.block.BlockState getData​(org.bukkit.Location loc, +int relX, +int relY, +int relZ)
              Gets the data of this structure at a given relative location, set with a BlockState at the given location
              -
              -
              Parameters:
              +
              +
              Parameters:
              loc - The location to use for the BlockState
              relX - The relative X of the block within this multi-block structure
              relY - The relative Y of the block within this multi-block structure
              relZ - The relative Z of the block within this multi-block structure
              -
              Returns:
              +
              Returns:
              A BlockState, with the Location passed, with the data at the specified relative location within this multi-block structure. This is done for compatibility reasons. For 1.8, MaterialData would make the most sense, while for 1.13+, BlockData would. BlockState can be converted to either.
              -
              Throws:
              +
              Throws:
              java.lang.ArrayIndexOutOfBoundsException - if the relative coordinates do not exist within this structure
              +
              • -
            - - - -
              -
            • -

              getData

              -
              public org.bukkit.block.BlockState getData​(int relX,
-                                           int relY,
-                                           int relZ)
              +
            • +
              +

              getData

              +
              public org.bukkit.block.BlockState getData​(int relX, +int relY, +int relZ)
              Gets the data of this structure at a given relative location
              -
              -
              Parameters:
              +
              +
              Parameters:
              relX - The relative X of the block within this multi-block structure
              relY - The relative Y of the block within this multi-block structure
              relZ - The relative Z of the block within this multi-block structure
              -
              Returns:
              +
              Returns:
              A BlockState, with the Location (0, 0, 0) in the default world, with the data at the specified relative location within this multi-block structure. This is done for compatibility reasons. For 1.8, MaterialData would make the most sense, while for 1.13+, BlockData would. BlockState can be converted to either.
              -
              Throws:
              +
              Throws:
              java.lang.ArrayIndexOutOfBoundsException - if the relative coordinates do not exist within this structure
              +
              • -
            - - - -
              -
            • -

              getStructureData

              -
              public StructureData getStructureData​(int relX,
-                                      int relY,
-                                      int relZ)
              +
            • +
              +

              getStructureData

              +
              public StructureData getStructureData​(int relX, +int relY, +int relZ)
              Gets the StructureData at a certain relative position
              -
              -
              Parameters:
              +
              +
              Parameters:
              relX - The relative X of the block within this multi-block structure
              relY - The relative Y of the block within this multi-block structure
              relZ - The relative Z of the block within this multi-block structure
              -
              Returns:
              +
              Returns:
              StructureData for the given relative position
              -
              Throws:
              +
              Throws:
              java.lang.ArrayIndexOutOfBoundsException - if the relative coordinates are out of bounds
              +
              • -
            - - - -
              -
            • -

              getType

              -
              public org.bukkit.Material getType​(int relX,
-                                   int relY,
-                                   int relZ)
              +
            • +
              +

              getType

              +
              public org.bukkit.Material getType​(int relX, +int relY, +int relZ)
              Gets the Material at a certain relative position
              -
              -
              Parameters:
              +
              +
              Parameters:
              relX - The relative X of the block within this multi-block structure
              relY - The relative Y of the block within this multi-block structure
              relZ - The relative Z of the block within this multi-block structure
              -
              Returns:
              +
              Returns:
              Material for the given relative position
              -
              Throws:
              +
              Throws:
              java.lang.ArrayIndexOutOfBoundsException - if the relative coordinates are out of bounds
              +
              • -
            - - - -
              -
            • -

              forEachBlock

              -
              public void forEachBlock​(org.bukkit.Location loc,
-                         int rotation,
-                         boolean mirror,
-                         java.util.function.Consumer<org.bukkit.block.BlockState> callback)
              +
            • +
              +

              forEachBlock

              +
              public void forEachBlock​(org.bukkit.Location loc, +int rotation, +boolean mirror, +java.util.function.Consumer<org.bukkit.block.BlockState> callback)
              Iterates each block which would be set if this structure is built
              -
              -
              Parameters:
              +
              +
              Parameters:
              loc - The location the structure would be built at
              rotation - The number of 90-degree clockwise rotations to apply
              mirror - Whether to mirror the structure on the X axis
              callback - The callback to be called, passed the BlockState which would be set if the structure is built here
              +
              • -
            - - - -
              -
            • -

              forEachBlock

              -
              public void forEachBlock​(org.bukkit.Location loc,
-                         int rotation,
-                         java.util.function.Consumer<org.bukkit.block.BlockState> callback)
              +
            • +
              +

              forEachBlock

              +
              public void forEachBlock​(org.bukkit.Location loc, +int rotation, +java.util.function.Consumer<org.bukkit.block.BlockState> callback)
              Iterates each block which would be set if this structure is built
              -
              -
              Parameters:
              +
              +
              Parameters:
              loc - The location the structure would be built at
              rotation - The number of 90-degree clockwise rotations to apply
              callback - The callback to be called, passed the BlockState which would be set if the structure is built here
              +
              • -
            - - - -
              -
            • -

              forEachBlock

              -
              public void forEachBlock​(org.bukkit.Location loc,
-                         java.util.function.Consumer<org.bukkit.block.BlockState> callback)
              +
            • +
              +

              forEachBlock

              +
              public void forEachBlock​(org.bukkit.Location loc, +java.util.function.Consumer<org.bukkit.block.BlockState> callback)
              Iterates each block which would be set if this structure is built
              -
              -
              Parameters:
              +
              +
              Parameters:
              loc - The location the structure would be built at
              callback - The callback to be called, passed the BlockState which would be set if the structure is built here
              +
              • -
            - - - -
              -
            • -

              canBuild

              -
              public boolean canBuild​(org.bukkit.Location loc,
-                        int relX,
-                        int relY,
-                        int relZ,
-                        int rotation,
-                        boolean mirror,
-                        java.util.function.Predicate<org.bukkit.Location> filter)
              +
            • +
              +

              canBuild

              +
              public boolean canBuild​(org.bukkit.Location loc, +int relX, +int relY, +int relZ, +int rotation, +boolean mirror, +java.util.function.Predicate<org.bukkit.Location> filter)
              Uses a Predicate to test each block where this structure would be built
              -
              -
              Parameters:
              +
              +
              Parameters:
              loc - The location to test the conditions at
              relX - The relative X in the structure to test centered at
              relY - The relative Y in the structure to test centered at
              @@ -1230,87 +1083,75 @@

              canBuild

              rotation - The number of 90-degree clockwise rotations to apply
              mirror - Whether to mirror the structure on the X axis
              filter - The predicate to check each location
              -
              Returns:
              +
              Returns:
              Whether every location passed the check
              +
              • -
            - - - -
              -
            • -

              canBuild

              -
              public boolean canBuild​(org.bukkit.Location loc,
-                        int rotation,
-                        boolean mirror,
-                        java.util.function.Predicate<org.bukkit.Location> filter)
              +
            • +
              +

              canBuild

              +
              public boolean canBuild​(org.bukkit.Location loc, +int rotation, +boolean mirror, +java.util.function.Predicate<org.bukkit.Location> filter)
              Uses a Predicate to test each block where this structure would be built
              -
              -
              Parameters:
              +
              +
              Parameters:
              loc - The location to test the conditions at
              rotation - The number of 90-degree clockwise rotations to apply
              mirror - Whether to mirror the structure on the X axis
              filter - The predicate to check each location
              -
              Returns:
              +
              Returns:
              Whether every location passed the check
              +
              • -
            - - - -
              -
            • -

              canBuild

              -
              public boolean canBuild​(org.bukkit.Location loc,
-                        int rotation,
-                        java.util.function.Predicate<org.bukkit.Location> filter)
              +
            • +
              +

              canBuild

              +
              public boolean canBuild​(org.bukkit.Location loc, +int rotation, +java.util.function.Predicate<org.bukkit.Location> filter)
              Uses a Predicate to test each block where this structure would be built
              -
              -
              Parameters:
              +
              +
              Parameters:
              loc - The location to test the conditions at
              rotation - The number of 90-degree clockwise rotations to apply
              filter - The predicate to check each location
              -
              Returns:
              +
              Returns:
              Whether every location passed the check
              +
              • -
            - - - -
              -
            • -

              canBuild

              -
              public boolean canBuild​(org.bukkit.Location loc,
-                        java.util.function.Predicate<org.bukkit.Location> filter)
              +
            • +
              +

              canBuild

              +
              public boolean canBuild​(org.bukkit.Location loc, +java.util.function.Predicate<org.bukkit.Location> filter)
              Uses a Predicate to test each block where this structure would be built
              -
              -
              Parameters:
              +
              +
              Parameters:
              loc - The location to test the conditions at
              filter - The predicate to check each location
              -
              Returns:
              +
              Returns:
              Whether every location passed the check
              +
              • -
            - - - -
              -
            • -

              visualize

              -
              public void visualize​(org.bukkit.entity.Player player,
-                      org.bukkit.Location loc,
-                      int relX,
-                      int relY,
-                      int relZ,
-                      int rotation,
-                      boolean mirror)
              +
            • +
              +

              visualize

              +
              public void visualize​(org.bukkit.entity.Player player, +org.bukkit.Location loc, +int relX, +int relY, +int relZ, +int rotation, +boolean mirror)
              Sends ghost blocks of this multi-block structure to the given player at the given location
              -
              -
              Parameters:
              +
              +
              Parameters:
              player - The player to visualize the structure to
              loc - The location to visualize the structure at
              relX - The relative X in the structure to visualize centered at
              @@ -1319,153 +1160,132 @@

              visualize

              rotation - The number of 90-degree clockwise rotations to apply
              mirror - Whether to mirror the structure on the X axis
              +
              • -
            - - - -
              -
            • -

              visualize

              -
              public void visualize​(org.bukkit.entity.Player player,
-                      org.bukkit.Location loc,
-                      int relX,
-                      int relY,
-                      int relZ)
              +
            • +
              +

              visualize

              +
              public void visualize​(org.bukkit.entity.Player player, +org.bukkit.Location loc, +int relX, +int relY, +int relZ)
              Sends ghost blocks of this multi-block structure to the given player at the given location
              -
              -
              Parameters:
              +
              +
              Parameters:
              player - The player to visualize the structure to
              loc - The location to visualize the structure at
              relX - The relative X in the structure to visualize centered at
              relY - The relative Y in the structure to visualize centered at
              relZ - The relative Z in the structure to visualize centered at
              +
              • -
            - - - -
              -
            • -

              build

              -
              public Structure build​(org.bukkit.Location loc,
-                       int relX,
-                       int relY,
-                       int relZ,
-                       int rotation,
-                       boolean mirror)
              +
            • +
              +

              build

              +
              public Structure build​(org.bukkit.Location loc, +int relX, +int relY, +int relZ, +int rotation, +boolean mirror)
              Builds this multi-block structure at the given location
              -
              -
              Parameters:
              +
              +
              Parameters:
              loc - The location to build the structure at
              relX - The relative X in the structure to build centered at
              relY - The relative Y in the structure to build centered at
              relZ - The relative Z in the structure to build centered at
              rotation - The number of 90-degree clockwise rotations to apply
              mirror - Whether to mirror the structure on the X axis
              -
              Returns:
              +
              Returns:
              The Structure instance that was created
              +
              • -
            - - - -
              -
            • -

              build

              -
              public Structure build​(org.bukkit.Location loc,
-                       int relX,
-                       int relY,
-                       int relZ)
              +
            • +
              +

              build

              +
              public Structure build​(org.bukkit.Location loc, +int relX, +int relY, +int relZ)
              Builds this multi-block structure at the given location
              -
              -
              Parameters:
              +
              +
              Parameters:
              loc - The location to build the structure at
              relX - The relative X in the structure to build centered at
              relY - The relative Y in the structure to build centered at
              relZ - The relative Z in the structure to build centered at
              -
              Returns:
              +
              Returns:
              The Structure instance that was created
              +
              • -
            - - - -
              -
            • -

              build

              -
              public Structure build​(org.bukkit.Location loc,
-                       int relX,
-                       int relY,
-                       int relZ,
-                       int rotation)
              +
            • +
              +

              build

              +
              public Structure build​(org.bukkit.Location loc, +int relX, +int relY, +int relZ, +int rotation)
              Builds this multi-block structure at the given location
              -
              -
              Parameters:
              +
              +
              Parameters:
              loc - The location to build the structure at
              relX - The relative X in the structure to build centered at
              relY - The relative Y in the structure to build centered at
              relZ - The relative Z in the structure to build centered at
              rotation - The number of 90-degree clockwise rotations to apply
              -
              Returns:
              +
              Returns:
              The Structure instance that was created
              +
              • -
            - - - -
              -
            • -

              build

              -
              public Structure build​(org.bukkit.Location loc)
              +
            • +
              +

              build

              +
              public Structure build​(org.bukkit.Location loc)
              Builds this multi-block structure at the given location
              -
              -
              Parameters:
              +
              +
              Parameters:
              loc - The location to build the structure at
              -
              Returns:
              +
              Returns:
              The Structure instance that was created
              +
              • -
            - - - -
              -
            • -

              build

              -
              public Structure build​(org.bukkit.Location loc,
-                       int rotation)
              +
            • +
              +

              build

              +
              public Structure build​(org.bukkit.Location loc, +int rotation)
              Builds this multi-block structure at the given location
              -
              -
              Parameters:
              +
              +
              Parameters:
              loc - The location to build the structure at
              rotation - The number of 90-degree clockwise rotations to apply
              -
              Returns:
              +
              Returns:
              The Structure instance that was created
              +
              • -
            - - - -
              -
            • -

              buildAsync

              -
              public int buildAsync​(org.bukkit.Location loc,
-                      int relX,
-                      int relY,
-                      int relZ,
-                      int rotation,
-                      boolean mirror,
-                      int blocksPerTick,
-                      java.util.function.Consumer<Structure> callback)
              +
            • +
              +

              buildAsync

              +
              public int buildAsync​(org.bukkit.Location loc, +int relX, +int relY, +int relZ, +int rotation, +boolean mirror, +int blocksPerTick, +java.util.function.Consumer<Structure> callback)
              Build this multi-block structure over multiple ticks
              -
              -
              Parameters:
              +
              +
              Parameters:
              loc - The location to build the structure at
              relX - The relative X in the structure to build centered at
              relY - The relative Y in the structure to build centered at
              @@ -1474,387 +1294,310 @@

              buildAsync

              mirror - Whether to mirror the structure on the X axis
              blocksPerTick - The number of blocks to build per tick
              callback - A callback to accept the Structure instance that was created when construction is complete
              -
              Returns:
              +
              Returns:
              The task number for the Bukkit scheduler task created by this method
              +
              • -
            - - - -
              -
            • -

              buildAsync

              -
              public int buildAsync​(org.bukkit.Location loc,
-                      int rotation,
-                      boolean mirror,
-                      int blocksPerTick,
-                      java.util.function.Consumer<Structure> callback)
              +
            • +
              +

              buildAsync

              +
              public int buildAsync​(org.bukkit.Location loc, +int rotation, +boolean mirror, +int blocksPerTick, +java.util.function.Consumer<Structure> callback)
              Build this multi-block structure over multiple ticks
              -
              -
              Parameters:
              +
              +
              Parameters:
              loc - The location to build the structure at
              rotation - The number of 90-degree clockwise rotations to apply
              mirror - Whether to mirror the structure on the X axis
              blocksPerTick - The number of blocks to build per tick
              callback - A callback to accept the Structure instance that was created when construction is complete
              -
              Returns:
              +
              Returns:
              The task number for the Bukkit scheduler task created by this method
              +
              • -
            - - - -
              -
            • -

              buildAsync

              -
              public int buildAsync​(org.bukkit.Location loc,
-                      int rotation,
-                      int blocksPerTick,
-                      java.util.function.Consumer<Structure> callback)
              +
            • +
              +

              buildAsync

              +
              public int buildAsync​(org.bukkit.Location loc, +int rotation, +int blocksPerTick, +java.util.function.Consumer<Structure> callback)
              Build this multi-block structure over multiple ticks
              -
              -
              Parameters:
              +
              +
              Parameters:
              loc - The location to build the structure at
              rotation - The number of 90-degree clockwise rotations to apply
              blocksPerTick - The number of blocks to build per tick
              callback - A callback to accept the Structure instance that was created when construction is complete
              -
              Returns:
              +
              Returns:
              The task number for the Bukkit scheduler task created by this method
              +
              • -
            - - - -
              -
            • -

              buildAsync

              -
              public int buildAsync​(org.bukkit.Location loc,
-                      int blocksPerTick,
-                      java.util.function.Consumer<Structure> callback)
              +
            • +
              +

              buildAsync

              +
              public int buildAsync​(org.bukkit.Location loc, +int blocksPerTick, +java.util.function.Consumer<Structure> callback)
              Build this multi-block structure over multiple ticks
              -
              -
              Parameters:
              +
              +
              Parameters:
              loc - The location to build the structure at
              blocksPerTick - The number of blocks to build per tick
              callback - A callback to accept the Structure instance that was created when construction is complete
              -
              Returns:
              +
              Returns:
              The task number for the Bukkit scheduler task created by this method
              +
              • -
            - - - -
              -
            • -

              getName

              -
              public java.lang.String getName()
              +
            • +
              +

              getName

              +
              public java.lang.String getName()
              Gets this multi-block structure's name. May be faster to compare this than to use .equals().
              -
              -
              Returns:
              +
              +
              Returns:
              The name of this multi-block structure
              +
              • -
            - - - -
              -
            • -

              getDimensions

              -
              public int[] getDimensions()
              +
            • +
              +

              getDimensions

              +
              public int[] getDimensions()
              Gets the dimensions of this multi-block structure. [x, y, z]
              -
              -
              Returns:
              +
              +
              Returns:
              The dimensions of this multi-block structure
              +
              • -
            - - - -
              -
            • -

              getVolume

              -
              public int getVolume()
              -
              -
              Returns:
              +
            • +
              +

              getVolume

              +
              public int getVolume()
              +
              +
              Returns:
              The volume of this multi-block structure in blocks
              +
              • -
            - - - -
              -
            • -

              ignoresAir

              -
              public boolean ignoresAir()
              -
              -
              Returns:
              +
            • +
              +

              ignoresAir

              +
              public boolean ignoresAir()
              +
              +
              Returns:
              Whether this structure ignores air in the data when building and checking for presence
              +
              • -
            - - - -
              -
            • -

              isStrictMode

              -
              public boolean isStrictMode()
              -
              -
              Returns:
              +
            • +
              +

              isStrictMode

              +
              public boolean isStrictMode()
              +
              +
              Returns:
              Whether this structure ignores data other than block type when checking for presence
              +
              • -
            - - - -
              -
            • -

              getAt

              -
              public Structure getAt​(org.bukkit.Location loc)
              +
            • +
              +

              getAt

              +
              public Structure getAt​(org.bukkit.Location loc)
              Gets the Structure at the given block, if it exists. The given location can be any part of the multi-block structure. This is very computationally expensive for larger structures, and should be avoided if possible, as it checks every possible rotation and mirroring of the structure.
              -
              -
              Parameters:
              +
              +
              Parameters:
              loc - The location to check at
              -
              Returns:
              +
              Returns:
              The structure at this block, or null if it does not exist
              +
              • -
            - - - -
              -
            • -

              getAt

              -
              public Structure getAt​(org.bukkit.Location loc,
-                       int relX,
-                       int relY,
-                       int relZ,
-                       int rotation,
-                       boolean mirror)
              +
            • +
              +

              getAt

              +
              public Structure getAt​(org.bukkit.Location loc, +int relX, +int relY, +int relZ, +int rotation, +boolean mirror)
              Gets the Structure at the given block, if it exists. All parameters must be known. Significantly faster than getAt(Location)
              -
              -
              Parameters:
              +
              +
              Parameters:
              loc - The location to check at
              relX - The relative X in the structure of the location
              relY - The relative Y in the structure of the location
              relZ - The relative Z in the structure of the location
              rotation - The number of clockwise rotations applied to the structure
              mirror - Whether the structure is mirrored
              -
              Returns:
              +
              Returns:
              The structure at this block, or null if it does not exist
              +
              • -
            - - - -
              -
            • -

              assumeAt

              -
              public Structure assumeAt​(org.bukkit.Location loc,
-                          int relX,
-                          int relY,
-                          int relZ,
-                          int rotation,
-                          boolean mirror)
              +
            • +
              +

              assumeAt

              +
              public Structure assumeAt​(org.bukkit.Location loc, +int relX, +int relY, +int relZ, +int rotation, +boolean mirror)
              Gets the Structure at the given block, performing no checks to ensure it exists.
              -
              -
              Parameters:
              +
              +
              Parameters:
              loc - The location of the Structure
              relX - The relative X of the location within the Structure
              relY - The relative Y of the location within the Structure
              relZ - The relative Z of the location within the Structure
              rotation - The number of clockwise rotations applied to the structure
              mirror - Whether the structure is mirrored
              -
              Returns:
              +
              Returns:
              The Structure instance
              +
              • -
            - - - -
              -
            • -

              assumeAt

              -
              public Structure assumeAt​(org.bukkit.Location loc,
-                          int rotation,
-                          boolean mirror)
              +
            • +
              +

              assumeAt

              +
              public Structure assumeAt​(org.bukkit.Location loc, +int rotation, +boolean mirror)
              Gets the Structure at the given block, performing no checks to ensure it exists.
              -
              -
              Parameters:
              +
              +
              Parameters:
              loc - The location of the Structure
              rotation - The number of clockwise rotations applied to the structure
              mirror - Whether the structure is mirrored
              -
              Returns:
              +
              Returns:
              The Structure instance
              +
              • -
            - - - -
              -
            • -

              assumeAt

              -
              public Structure assumeAt​(org.bukkit.Location loc,
-                          int rotation)
              +
            • +
              +

              assumeAt

              +
              public Structure assumeAt​(org.bukkit.Location loc, +int rotation)
              Gets the Structure at the given block, performing no checks to ensure it exists.
              -
              -
              Parameters:
              +
              +
              Parameters:
              loc - The location of the Structure
              rotation - The number of clockwise rotations applied to the structure
              -
              Returns:
              +
              Returns:
              The Structure instance
              +
              • -
            - - - -
              -
            • -

              assumeAt

              -
              public Structure assumeAt​(org.bukkit.Location loc)
              +
            • +
              +

              assumeAt

              +
              public Structure assumeAt​(org.bukkit.Location loc)
              Gets the Structure at the given block, performing no checks to ensure it exists.
              -
              -
              Parameters:
              +
              +
              Parameters:
              loc - The location of the Structure
              -
              Returns:
              +
              Returns:
              The Structure instance
              +
              • -
            - - - -
              -
            • -

              compare

              -
              protected boolean compare​(StructureData data,
-                          org.bukkit.block.Block block,
-                          Rotator rotator)
              +
            • +
              +

              compare

              +
              protected boolean compare​(StructureData data, +org.bukkit.block.Block block, +Rotator rotator)
              +
              • -
            - - - -
              -
            • -

              equals

              -
              public boolean equals​(java.lang.Object o)
              -
              -
              Overrides:
              +
            • +
              +

              equals

              +
              public boolean equals​(java.lang.Object o)
              +
              +
              Overrides:
              equals in class java.lang.Object
              +
              • -
            - - - -
              -
            • -

              hashCode

              -
              public int hashCode()
              -
              -
              Overrides:
              +
            • +
              +

              hashCode

              +
              public int hashCode()
              +
              +
              Overrides:
              hashCode in class java.lang.Object
              +
              • -
            - - - -
              -
            • -

              toString

              -
              public java.lang.String toString()
              -
              -
              Overrides:
              +
            • +
              +

              toString

              +
              public java.lang.String toString()
              +
              +
              Overrides:
              toString in class java.lang.Object
              -
              • -
            +
      -
    - - + + + + diff --git a/javadoc/redempt/redlib/multiblock/Rotator.html b/javadoc/redempt/redlib/multiblock/Rotator.html index 75b667a..c24ea85 100644 --- a/javadoc/redempt/redlib/multiblock/Rotator.html +++ b/javadoc/redempt/redlib/multiblock/Rotator.html @@ -5,644 +5,513 @@ Rotator (RedLib API) + + - + + - - - - - + + - - -
    +
    +
    + + + +
    - +
    +
    -
    Package redempt.redlib.multiblock
    -

    Class Rotator

    +
    Package redempt.redlib.multiblock
    +

    Class Rotator

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.multiblock.Rotator
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      redempt.redlib.multiblock.Rotator
      +
      +
      -
      public class Rotator
+
      public class Rotator
 extends java.lang.Object
      
 
      Used to rotate blocks and block sections when building or testing for the presence of a MultiBlockStructure
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Constructor Summary

          - - +
        • +
          +

          Constructor Summary

          +
          +
          • Constructors 
          + + - - + + - - - + + + + +
          Constructors
          ConstructorDescriptionConstructorDescription
          Rotator​(int rotation, - boolean mirrored) +
          Rotator​(int rotation, +boolean mirrored)
          Constructs a new Rotator
          -
          • -
        +
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Static Methods Instance Methods Concrete Methods 
      + - - - + + + - - - - + + + + + - - - - + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + +
      Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
      Rotatorclone() +
      Rotatorclone()
      Gets a clone of this Rotator
      RotatorgetInverse() +
      RotatorgetInverse()
      Gets a Rotator which will negate the operations of this Rotator
      intgetRotatedBlockX() 
      intgetRotatedBlockX() 
      intgetRotatedBlockZ() 
      intgetRotatedBlockZ() 
      doublegetRotatedX() 
      doublegetRotatedX() 
      doublegetRotatedZ() 
      doublegetRotatedZ() 
      intgetRotation() +
      intgetRotation()
      Gets the rotation, in number of 90-degree clockwise rotations
      booleanisMirrored() +
      booleanisMirrored()
      Gets whether this rotator mirrors over the X axis
      org.bukkit.block.data.BlockDatarotate​(org.bukkit.block.data.BlockData data) +
      org.bukkit.block.data.BlockDatarotate​(org.bukkit.block.data.BlockData data)
      Rotates block data.
      org.bukkit.block.BlockFacerotateBlockFace​(org.bukkit.block.BlockFace face) +
      org.bukkit.block.BlockFacerotateBlockFace​(org.bukkit.block.BlockFace face)
      Rotates a BlockFace according to this Rotator
      static org.bukkit.block.BlockFacerotateBlockFace​(org.bukkit.block.BlockFace face, - int rotation) +
      static org.bukkit.block.BlockFacerotateBlockFace​(org.bukkit.block.BlockFace face, +int rotation)
      Rotates a BlockFace according to given values
      static org.bukkit.block.BlockFacerotateBlockFace​(org.bukkit.block.BlockFace face, - int rotation, - boolean mirror) +
      static org.bukkit.block.BlockFacerotateBlockFace​(org.bukkit.block.BlockFace face, +int rotation, +boolean mirror)
      Rotates a BlockFace according to given values
      org.bukkit.util.VectorrotateVector​(org.bukkit.util.Vector vector) +
      org.bukkit.util.VectorrotateVector​(org.bukkit.util.Vector vector)
      Rotates a Vector according to this Rotator
      voidsetLocation​(double x, - double z) +
      voidsetLocation​(double x, +double z)
      Sets the relative coordinates this Rotator will rotate
      voidsetMirrored​(boolean mirrored) +
      voidsetMirrored​(boolean mirrored)
      Sets whether this rotator mirrors over the X axis
      voidsetRotation​(int rotation) +
      voidsetRotation​(int rotation)
      Sets the rotation
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

    Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - -
            -
          • -

            Rotator

            -
            public Rotator​(int rotation,
-               boolean mirrored)
            +
          • +
            +

            Constructor Details

            +
              +
            • +
              +

              Rotator

              +
              public Rotator​(int rotation, +boolean mirrored)
              Constructs a new Rotator
              -
              -
              Parameters:
              +
              +
              Parameters:
              rotation - The number of 90-degree clockwise rotations this Rotator applies
              mirrored - Whether this Rotator should mirror over the X axis
              -
              • -
            +
        + -
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            rotateBlockFace

            -
            public static org.bukkit.block.BlockFace rotateBlockFace​(org.bukkit.block.BlockFace face,
-                                                         int rotation,
-                                                         boolean mirror)
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              rotateBlockFace

              +
              public static org.bukkit.block.BlockFace rotateBlockFace​(org.bukkit.block.BlockFace face, +int rotation, +boolean mirror)
              Rotates a BlockFace according to given values
              -
              -
              Parameters:
              +
              +
              Parameters:
              face - The BlockFace to rotate
              rotation - The number of clockwise rotations to apply
              mirror - Whether or not to mirror over the X axis
              -
              Returns:
              +
              Returns:
              The rotated BlockFace
              +
              • -
            - - - -
              -
            • -

              rotateBlockFace

              -
              public static org.bukkit.block.BlockFace rotateBlockFace​(org.bukkit.block.BlockFace face,
-                                                         int rotation)
              +
            • +
              +

              rotateBlockFace

              +
              public static org.bukkit.block.BlockFace rotateBlockFace​(org.bukkit.block.BlockFace face, +int rotation)
              Rotates a BlockFace according to given values
              -
              -
              Parameters:
              +
              +
              Parameters:
              face - The BlockFace to rotate
              rotation - The number of clockwise rotations to apply
              -
              Returns:
              +
              Returns:
              The rotated BlockFace
              +
              • -
            - - - -
              -
            • -

              rotate

              -
              public org.bukkit.block.data.BlockData rotate​(org.bukkit.block.data.BlockData data)
              +
            • +
              +

              rotate

              +
              public org.bukkit.block.data.BlockData rotate​(org.bukkit.block.data.BlockData data)
              Rotates block data. NOTE: Only works for 1.13+
              -
              -
              Parameters:
              +
              +
              Parameters:
              data - The block data to rotate
              -
              Returns:
              +
              Returns:
              The rotated block data
              +
              • -
            - - - -
              -
            • -

              rotateBlockFace

              -
              public org.bukkit.block.BlockFace rotateBlockFace​(org.bukkit.block.BlockFace face)
              +
            • +
              +

              rotateBlockFace

              +
              public org.bukkit.block.BlockFace rotateBlockFace​(org.bukkit.block.BlockFace face)
              Rotates a BlockFace according to this Rotator
              -
              -
              Parameters:
              +
              +
              Parameters:
              face - The BlockFace to rotate
              -
              Returns:
              +
              Returns:
              The rotated BlockFace
              +
              • -
            - - - -
              -
            • -

              rotateVector

              -
              public org.bukkit.util.Vector rotateVector​(org.bukkit.util.Vector vector)
              +
            • +
              +

              rotateVector

              +
              public org.bukkit.util.Vector rotateVector​(org.bukkit.util.Vector vector)
              Rotates a Vector according to this Rotator
              -
              -
              Parameters:
              +
              +
              Parameters:
              vector - The Vector to rotate
              -
              Returns:
              +
              Returns:
              The rotated Vector
              +
              • -
            - - - -
              -
            • -

              setLocation

              -
              public void setLocation​(double x,
-                        double z)
              +
            • +
              +

              setLocation

              +
              public void setLocation​(double x, +double z)
              Sets the relative coordinates this Rotator will rotate
              -
              -
              Parameters:
              +
              +
              Parameters:
              x - The relative X coordinate
              z - The relative Z coordinate
              +
              • -
            - - - -
              -
            • -

              getRotatedBlockX

              -
              public int getRotatedBlockX()
              -
              -
              Returns:
              +
            • +
              +

              getRotatedBlockX

              +
              public int getRotatedBlockX()
              +
              +
              Returns:
              The rotated relative block X
              +
              • -
            - - - -
              -
            • -

              getRotatedBlockZ

              -
              public int getRotatedBlockZ()
              -
              -
              Returns:
              +
            • +
              +

              getRotatedBlockZ

              +
              public int getRotatedBlockZ()
              +
              +
              Returns:
              The rotated relative block Z
              +
              • -
            - - - -
              -
            • -

              getRotatedX

              -
              public double getRotatedX()
              -
              -
              Returns:
              +
            • +
              +

              getRotatedX

              +
              public double getRotatedX()
              +
              +
              Returns:
              The rotated relative X
              +
              • -
            - - - -
              -
            • -

              getRotatedZ

              -
              public double getRotatedZ()
              -
              -
              Returns:
              +
            • +
              +

              getRotatedZ

              +
              public double getRotatedZ()
              +
              +
              Returns:
              The rotated relative Z
              +
              • -
            - - - -
              -
            • -

              getInverse

              -
              public Rotator getInverse()
              +
            • +
              +

              getInverse

              +
              public Rotator getInverse()
              Gets a Rotator which will negate the operations of this Rotator
              -
              -
              Returns:
              +
              +
              Returns:
              The inverse Rotator
              +
              • -
            - - - -
              -
            • -

              clone

              -
              public Rotator clone()
              +
            • +
              +

              clone

              +
              public Rotator clone()
              Gets a clone of this Rotator
              -
              -
              Overrides:
              +
              +
              Overrides:
              clone in class java.lang.Object
              -
              Returns:
              +
              Returns:
              The clone of this Rotator
              +
              • -
            - - - -
              -
            • -

              getRotation

              -
              public int getRotation()
              +
            • +
              +

              getRotation

              +
              public int getRotation()
              Gets the rotation, in number of 90-degree clockwise rotations
              -
              -
              Returns:
              +
              +
              Returns:
              The rotation
              +
              • -
            - - - -
              -
            • -

              setRotation

              -
              public void setRotation​(int rotation)
              +
            • +
              +

              setRotation

              +
              public void setRotation​(int rotation)
              Sets the rotation
              -
              -
              Parameters:
              +
              +
              Parameters:
              rotation - The rotation to set
              +
              • -
            - - - -
              -
            • -

              setMirrored

              -
              public void setMirrored​(boolean mirrored)
              +
            • +
              +

              setMirrored

              +
              public void setMirrored​(boolean mirrored)
              Sets whether this rotator mirrors over the X axis
              -
              -
              Parameters:
              +
              +
              Parameters:
              mirrored - Whether this rotator mirrors over the X axis
              +
              • -
            - - - -
              -
            • -

              isMirrored

              -
              public boolean isMirrored()
              +
            • +
              +

              isMirrored

              +
              public boolean isMirrored()
              Gets whether this rotator mirrors over the X axis
              -
              -
              Returns:
              +
              +
              Returns:
              Whether this rotator mirrors over the X axis
              -
              • -
            +
      -
    - - + + + + diff --git a/javadoc/redempt/redlib/multiblock/Structure.StructureBlock.html b/javadoc/redempt/redlib/multiblock/Structure.StructureBlock.html index fe222f0..a852570 100644 --- a/javadoc/redempt/redlib/multiblock/Structure.StructureBlock.html +++ b/javadoc/redempt/redlib/multiblock/Structure.StructureBlock.html @@ -5,414 +5,310 @@ Structure.StructureBlock (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.multiblock
    -

    Class Structure.StructureBlock

    +
    Package redempt.redlib.multiblock
    +

    Class Structure.StructureBlock

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.multiblock.Structure.StructureBlock
        • -
      -
      • -
    -
    -
      -
    • -
      +
      java.lang.Object +
      redempt.redlib.multiblock.Structure.StructureBlock
      +
      +
      +
      Enclosing class:
      Structure
      -
      public static class Structure.StructureBlock
+
      public static class Structure.StructureBlock
 extends java.lang.Object
      
 
      Represents a block in a Structure instance
      
-
      • -
    -
    -
    -
    +
    +
    +

    Methods inherited from class java.lang.Object

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

          Method Detail

          - - - -
            -
          • -

            getRelativeCoordinates

            -
            public int[] getRelativeCoordinates()
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              getRelativeCoordinates

              +
              public int[] getRelativeCoordinates()
              Gets the relative coordinates of this block in the Structure. The same block will always be in the same relative location across Structures, regardless of rotation. [x, y, z]
              -
              -
              Returns:
              +
              +
              Returns:
              The relative coordiantes of this StructureBlock
              +
              • -
            - - - -
              -
            • -

              getStructureData

              -
              public org.bukkit.block.BlockState getStructureData()
              -
              -
              Returns:
              +
            • +
              +

              getStructureData

              +
              public org.bukkit.block.BlockState getStructureData()
              +
              +
              Returns:
              The BlockState that the MultiBlockStructure would set at this location if it were built here
              +
              • -
            - - - -
              -
            • -

              getStructureType

              -
              public org.bukkit.Material getStructureType()
              -
              -
              Returns:
              +
            • +
              +

              getStructureType

              +
              public org.bukkit.Material getStructureType()
              +
              +
              Returns:
              The Material that the MultiBlockStructure would set at this location if it were built here
              +
              • -
            - - - -
              -
            • -

              getRelativeX

              -
              public int getRelativeX()
              +
            • +
              +

              getRelativeX

              +
              public int getRelativeX()
              Gets the relative X of this block
              -
              -
              Returns:
              +
              +
              Returns:
              The relative X of this block
              +
              • -
            - - - -
              -
            • -

              getRelativeY

              -
              public int getRelativeY()
              +
            • +
              +

              getRelativeY

              +
              public int getRelativeY()
              Gets the relative Y of this block
              -
              -
              Returns:
              +
              +
              Returns:
              The relative Y of this block
              +
              • -
            - - - -
              -
            • -

              getRelativeZ

              -
              public int getRelativeZ()
              +
            • +
              +

              getRelativeZ

              +
              public int getRelativeZ()
              Gets the relative Z of this block
              -
              -
              Returns:
              +
              +
              Returns:
              The relative Z of this block
              +
              • -
            - - - -
              -
            • -

              getStructure

              -
              public Structure getStructure()
              +
            • +
              +

              getStructure

              +
              public Structure getStructure()
              Gets the Structure this block is part of
              -
              -
              Returns:
              +
              +
              Returns:
              The Structure
              +
              • -
            - - - -
              -
            • -

              getBlock

              -
              public org.bukkit.block.Block getBlock()
              +
            • +
              +

              getBlock

              +
              public org.bukkit.block.Block getBlock()
              Gets the Block this StructureBlock references
              -
              -
              Returns:
              +
              +
              Returns:
              The Block
              -
              • -
            +
      -
    -
    - + + + + diff --git a/javadoc/redempt/redlib/multiblock/Structure.html b/javadoc/redempt/redlib/multiblock/Structure.html index 1f7cd07..631bf46 100644 --- a/javadoc/redempt/redlib/multiblock/Structure.html +++ b/javadoc/redempt/redlib/multiblock/Structure.html @@ -5,525 +5,417 @@ Structure (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.multiblock
    -

    Class Structure

    +
    Package redempt.redlib.multiblock
    +

    Class Structure

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.multiblock.Structure
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      redempt.redlib.multiblock.Structure
      +
      +
      -
      public class Structure
+
      public class Structure
 extends java.lang.Object
      
 
      Represents an instance of a multi-block structure in the world
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Nested Class Summary

          - - +
        • +
          +

          Nested Class Summary

          +
          +
          • Nested Classes 
          + + - - - + + + - - - - + + + + + +
          Nested Classes
          Modifier and TypeClassDescriptionModifier and TypeClassDescription
          static class Structure.StructureBlock +
          static class Structure.StructureBlock
          Represents a block in a Structure instance
          -
          • -
        +
    + -
    -
      -
    • - - -

      Constructor Summary

      - - +
    • +
      +

      Constructor Summary

      +
      +
      • Constructors 
      + + - - - + + + - - - - + + + + + + +
      Constructors
      ModifierConstructorDescriptionModifierConstructorDescription
      protected Structure​(MultiBlockStructure type, - org.bukkit.Location loc, - Rotator rotator) 
      protected Structure​(MultiBlockStructure type, +org.bukkit.Location loc, +Rotator rotator) 
      -
      • -
    +
    + -
    - +
    +
    +
    +

    Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - - +
        • +
          +

          Constructor Details

          +
          +
          • -
          -
            -
          • - - -

            Method Detail

            - - - -
              -
            • -

              getType

              -
              public MultiBlockStructure getType()
              +
            • +
              +

              Method Details

              +
                +
              • +
                +

                getType

                +
                public MultiBlockStructure getType()
                Gets the type of this structure
                -
                -
                Returns:
                +
                +
                Returns:
                The type of this structure
                +
                • -
              - - - -
                -
              • -

                getLocation

                -
                public org.bukkit.Location getLocation()
                +
              • +
                +

                getLocation

                +
                public org.bukkit.Location getLocation()
                Gets the location of this structure (will be a corner)
                -
                -
                Returns:
                +
                +
                Returns:
                The location of this structure
                +
                • -
              - - - -
                -
              • -

                getRotator

                -
                public Rotator getRotator()
                +
              • +
                +

                getRotator

                +
                public Rotator getRotator()
                Gets the rotation of this structure. Will be a number between 0 and 3. Represents how many 90-degree clockwise rotations would be needed to rotate the original multi-block structure this structure is based on to get to its current rotation.
                -
                -
                Returns:
                +
                +
                Returns:
                The rotation of this structure
                +
                • -
              - - - -
                -
              • -

                getByType

                -
                public java.util.List<Structure.StructureBlock> getByType​(org.bukkit.Material type)
                +
              • +
                +

                getByType

                +
                public java.util.List<Structure.StructureBlock> getByType​(org.bukkit.Material type)
                Gets all blocks of the given type in this Structure
                -
                -
                Parameters:
                +
                +
                Parameters:
                type - The type to check for
                -
                Returns:
                +
                Returns:
                The list of blocks in this Structure of that type
                +
                • -
              - - - -
                -
              • -

                getBlocks

                -
                public java.util.List<Structure.StructureBlock> getBlocks()
                +
              • +
                +

                getBlocks

                +
                public java.util.List<Structure.StructureBlock> getBlocks()
                Get all blocks in this Structure
                -
                -
                Returns:
                +
                +
                Returns:
                The list of blocks in this Structure
                +
                • -
              - - - -
                -
              • -

                isIntact

                -
                public boolean isIntact()
                +
              • +
                +

                isIntact

                +
                public boolean isIntact()
                Checks whether this Structure is intact (in the same rotation and has all the correct blocks)
                -
                -
                Returns:
                +
                +
                Returns:
                Whether this Structure is intact
                +
                • -
              - - - -
                -
              • -

                getRegion

                -
                public CuboidRegion getRegion()
                +
              • +
                +

                getRegion

                +
                public CuboidRegion getRegion()
                Gets the region this Structure occupies
                -
                -
                Returns:
                +
                +
                Returns:
                The region this Structure occupies
                +
                • -
              - - - -
                -
              • -

                getRelative

                -
                public Structure.StructureBlock getRelative​(int x,
-                                            int y,
-                                            int z)
                +
              • +
                +

                getRelative

                +
                public Structure.StructureBlock getRelative​(int x, +int y, +int z)
                Gets a relative block in this Structure
                -
                -
                Parameters:
                +
                +
                Parameters:
                x - The relative X of the block
                y - The relative Y of the block
                z - The relative Z of the block
                -
                Returns:
                +
                Returns:
                The relative block
                -
                Throws:
                +
                Throws:
                java.lang.IndexOutOfBoundsException - if the specified coordinates are not within the bounds of this Structure
                +
                • -
              - - - -
                -
              • -

                getBlock

                -
                public Structure.StructureBlock getBlock​(org.bukkit.block.Block block)
                +
              • +
                +

                getBlock

                +
                public Structure.StructureBlock getBlock​(org.bukkit.block.Block block)
                Gets a relative block in this Structure from an absolute block in the world
                -
                -
                Parameters:
                +
                +
                Parameters:
                block - The absolute block which is part of this Structure
                -
                Returns:
                +
                Returns:
                The relative block
                -
                Throws:
                +
                Throws:
                java.lang.IllegalArgumentException - if the specified block is not within the bounds of this Structure
                -
                • -
              +
        -
    - - + + + + diff --git a/javadoc/redempt/redlib/multiblock/StructureData.html b/javadoc/redempt/redlib/multiblock/StructureData.html index 7720c78..45a5ce4 100644 --- a/javadoc/redempt/redlib/multiblock/StructureData.html +++ b/javadoc/redempt/redlib/multiblock/StructureData.html @@ -5,494 +5,381 @@ StructureData (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.multiblock
    -

    Class StructureData

    +
    Package redempt.redlib.multiblock
    +

    Class StructureData

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.multiblock.StructureData
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      redempt.redlib.multiblock.StructureData
      +
      +
      -
      public class StructureData
+
      public class StructureData
 extends java.lang.Object
      
 
      Cross-version wrapper for block data - BlockData in 1.13+, MaterialData otherwise
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Constructor Summary

          - - +
        • +
          +

          Constructor Summary

          +
          +
          • Constructors 
          + + - - - + + + - - - - + + + + + + - - - - + + + - - - - + + + + - - - - + + + +
          Constructors
          ModifierConstructorDescriptionModifierConstructorDescription
          protected StructureData​(java.lang.String string) 
          protected StructureData​(java.lang.String string) 
           StructureData​(org.bukkit.block.data.BlockData data) +
           StructureData​(org.bukkit.block.data.BlockData data)
          Creates a StructureData from a BlockData, for 1.13+
           StructureData​(org.bukkit.Material type) 
           StructureData​(org.bukkit.Material type) 
           StructureData​(org.bukkit.Material type, - byte data) +
           StructureData​(org.bukkit.Material type, +byte data)
          Creates a StructureData from a Material and byte data, for 1.12 and below
          -
          • -
        +
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Instance Methods Concrete Methods 
      + - - - + + + - - - - + + + + + - - - - + + + + - - - - + + + - - - - + + + + - - - - + + + + - - - - + + + - - - - + + + +
      Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
      booleancompare​(org.bukkit.block.Block block, - boolean strict, - boolean ignoreAir) +
      booleancompare​(org.bukkit.block.Block block, +boolean strict, +boolean ignoreAir)
      Compares this StructureData to a Block
      StructureDatagetRotated​(Rotator rotator) 
      StructureDatagetRotated​(Rotator rotator) 
      org.bukkit.block.BlockStategetState​(org.bukkit.block.Block block) +
      org.bukkit.block.BlockStategetState​(org.bukkit.block.Block block)
      Gets the BlockState to set for a given block
      org.bukkit.MaterialgetType() 
      org.bukkit.MaterialgetType() 
      booleanisAir() 
      booleanisAir() 
      voidsendBlock​(org.bukkit.entity.Player player, - org.bukkit.Location loc) +
      voidsendBlock​(org.bukkit.entity.Player player, +org.bukkit.Location loc)
      Sends a fake block change to a Player
      voidsetBlock​(org.bukkit.block.Block block) +
      voidsetBlock​(org.bukkit.block.Block block)
      Sets this StructureData at the given location
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

    Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - -
            -
          • -

            StructureData

            -
            protected StructureData​(java.lang.String string)
            +
          • +
            +

            Constructor Details

            +
              +
            • +
              +

              StructureData

              +
              protected StructureData​(java.lang.String string)
              +
              • -
            - - - -
              -
            • -

              StructureData

              -
              public StructureData​(org.bukkit.Material type)
              +
            • +
              +

              StructureData

              +
              public StructureData​(org.bukkit.Material type)
              +
              • -
            - - - -
              -
            • -

              StructureData

              -
              public StructureData​(org.bukkit.block.data.BlockData data)
              +
            • +
              +

              StructureData

              +
              public StructureData​(org.bukkit.block.data.BlockData data)
              Creates a StructureData from a BlockData, for 1.13+
              -
              -
              Parameters:
              +
              +
              Parameters:
              data - The BlockData
              +
              • -
            - - - -
              -
            • -

              StructureData

              -
              public StructureData​(org.bukkit.Material type,
-                     byte data)
              +
            • +
              +

              StructureData

              +
              public StructureData​(org.bukkit.Material type, +byte data)
              Creates a StructureData from a Material and byte data, for 1.12 and below
              -
              -
              Parameters:
              +
              +
              Parameters:
              type - The block type
              data - The data byte
              -
              • -
            +
        + -
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            getRotated

            -
            public StructureData getRotated​(Rotator rotator)
            +
          • +
            +

            Method Details

            + - - - -
              -
            • -

              setBlock

              -
              public void setBlock​(org.bukkit.block.Block block)
              +
            • +
              +

              setBlock

              +
              public void setBlock​(org.bukkit.block.Block block)
              Sets this StructureData at the given location
              -
              -
              Parameters:
              +
              +
              Parameters:
              block - The block to set
              +
              • -
            - - - -
              -
            • -

              getState

              -
              public org.bukkit.block.BlockState getState​(org.bukkit.block.Block block)
              +
            • +
              +

              getState

              +
              public org.bukkit.block.BlockState getState​(org.bukkit.block.Block block)
              Gets the BlockState to set for a given block
              -
              -
              Parameters:
              +
              +
              Parameters:
              block - The Block to get the BlockState at
              -
              Returns:
              +
              Returns:
              The BlockState that would be set
              +
              • -
            - - - -
              -
            • -

              sendBlock

              -
              public void sendBlock​(org.bukkit.entity.Player player,
-                      org.bukkit.Location loc)
              +
            • +
              +

              sendBlock

              +
              public void sendBlock​(org.bukkit.entity.Player player, +org.bukkit.Location loc)
              Sends a fake block change to a Player
              -
              -
              Parameters:
              +
              +
              Parameters:
              player - The Player to send the fake block change to
              loc - The Location of the fake block
              +
              • -
            - - - -
              -
            • -

              isAir

              -
              public boolean isAir()
              -
              -
              Returns:
              +
            • +
              +

              isAir

              +
              public boolean isAir()
              +
              +
              Returns:
              Whether the Material is air - for 1.15+, AIR, CAVE_AIR, or VOID_AIR
              +
              • -
            - - - -
              -
            • -

              getType

              -
              public org.bukkit.Material getType()
              -
              -
              Returns:
              +
            • +
              +

              getType

              +
              public org.bukkit.Material getType()
              +
              +
              Returns:
              The type of this StructureData
              +
              • -
            - - - -
              -
            • -

              compare

              -
              public boolean compare​(org.bukkit.block.Block block,
-                       boolean strict,
-                       boolean ignoreAir)
              +
            • +
              +

              compare

              +
              public boolean compare​(org.bukkit.block.Block block, +boolean strict, +boolean ignoreAir)
              Compares this StructureData to a Block
              -
              -
              Parameters:
              +
              +
              Parameters:
              block - The Block to compare with
              strict - Whether to compare strictly
              ignoreAir - Whether to return true automatically if this StructureData is air
              -
              Returns:
              +
              Returns:
              Whether the block matches this StructureData within the given parameters
              -
              • -
            +
      -
    - - + + + + diff --git a/javadoc/redempt/redlib/multiblock/package-summary.html b/javadoc/redempt/redlib/multiblock/package-summary.html index d25fee3..80bad35 100644 --- a/javadoc/redempt/redlib/multiblock/package-summary.html +++ b/javadoc/redempt/redlib/multiblock/package-summary.html @@ -5,47 +5,30 @@ redempt.redlib.multiblock (RedLib API) + + - + + - - - - - + + - - -
    +
    + +

    Package redempt.redlib.multiblock

    -
    -
    -
    +
    + + +
    +
    + diff --git a/javadoc/redempt/redlib/multiblock/package-tree.html b/javadoc/redempt/redlib/multiblock/package-tree.html index 3d21d04..77d2a7b 100644 --- a/javadoc/redempt/redlib/multiblock/package-tree.html +++ b/javadoc/redempt/redlib/multiblock/package-tree.html @@ -5,160 +5,93 @@ redempt.redlib.multiblock Class Hierarchy (RedLib API) + + - + + - - - - - + + - - -
    +
    + +

    Hierarchy For Package redempt.redlib.multiblock

    -Package Hierarchies: +Package Hierarchies:
    -
    -
    +

    Class Hierarchy

    -
    +
    +
    diff --git a/javadoc/redempt/redlib/nms/NMSArray.html b/javadoc/redempt/redlib/nms/NMSArray.html index c7407c9..43ecdcb 100644 --- a/javadoc/redempt/redlib/nms/NMSArray.html +++ b/javadoc/redempt/redlib/nms/NMSArray.html @@ -5,370 +5,275 @@ NMSArray (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.nms
    -

    Class NMSArray

    +
    Package redempt.redlib.nms
    +

    Class NMSArray

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.nms.NMSArray
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      redempt.redlib.nms.NMSArray
      +
      +
      -
      public class NMSArray
+
      public class NMSArray
 extends java.lang.Object
      
 
      Wraps any type of Array and provides easy reflection access
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Constructor Summary

          - - +
        • +
          +

          Constructor Summary

          +
          +
          • Constructors 
          + + - - + + - - - + + + + + +
          Constructors
          ConstructorDescriptionConstructorDescription
          NMSArray​(java.lang.Object array) 
          NMSArray​(java.lang.Object array) 
          -
          • -
        +
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Instance Methods Concrete Methods 
      + - - - + + + - - - - + + + + + - - - - + + + - - - - + + + + - - - - + + + +
      Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
      NMSObjectget​(int index) +
      NMSObjectget​(int index)
      Gets a wrapped NMSObject with the value at a certain index in the array
      java.lang.ObjectgetDirect​(int index) +
      java.lang.ObjectgetDirect​(int index)
      Gets the object at the given index in the wrapped array
      intlength() 
      intlength() 
      voidset​(int index, - java.lang.Object obj) +
      voidset​(int index, +java.lang.Object obj)
      Sets the object at the index of the wrapped array
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

    Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - -
            -
          • -

            NMSArray

            -
            public NMSArray​(java.lang.Object array)
            -
            • -
          +
        • +
          +

          Constructor Details

          +
            +
          • +
            +

            NMSArray

            +
            public NMSArray​(java.lang.Object array)
            +
          +
          • -
          -
            -
          • - - -

            Method Detail

            - - - -
              -
            • -

              get

              -
              public NMSObject get​(int index)
              +
            • +
              +

              Method Details

              +
                +
              • +
                +

                get

                +
                public NMSObject get​(int index)
                Gets a wrapped NMSObject with the value at a certain index in the array
                -
                -
                Parameters:
                +
                +
                Parameters:
                index - The index to get
                -
                Returns:
                +
                Returns:
                An NMSObject wrapping the object at the index
                +
                • -
              - - - -
                -
              • -

                getDirect

                -
                public java.lang.Object getDirect​(int index)
                +
              • +
                +

                getDirect

                +
                public java.lang.Object getDirect​(int index)
                Gets the object at the given index in the wrapped array
                -
                -
                Parameters:
                +
                +
                Parameters:
                index - The index to get
                -
                Returns:
                +
                Returns:
                The object at the index
                +
                • -
              - - - -
                -
              • -

                set

                -
                public void set​(int index,
-                java.lang.Object obj)
                +
              • +
                +

                set

                +
                public void set​(int index, +java.lang.Object obj)
                Sets the object at the index of the wrapped array
                -
                -
                Parameters:
                +
                +
                Parameters:
                index - The index to set
                obj - The object to set. If it is an NMSObject, it will be unwrapped automatically.
                +
                • -
              - - - -
                -
              • -

                length

                -
                public int length()
                -
                • -
              +
            • +
              +

              length

              +
              public int length()
              +
        -
    - - + + + + diff --git a/javadoc/redempt/redlib/nms/NMSClass.html b/javadoc/redempt/redlib/nms/NMSClass.html index b5bd9ca..7ab1321 100644 --- a/javadoc/redempt/redlib/nms/NMSClass.html +++ b/javadoc/redempt/redlib/nms/NMSClass.html @@ -5,442 +5,338 @@ NMSClass (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.nms
    -

    Class NMSClass

    +
    Package redempt.redlib.nms
    +

    Class NMSClass

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.nms.NMSClass
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      redempt.redlib.nms.NMSClass
      +
      +
      -
      public class NMSClass
+
      public class NMSClass
 extends java.lang.Object
      
 
      Wraps any class and provides methods for easy reflection
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Constructor Summary

          - - +
        • +
          +

          Constructor Summary

          +
          +
          • Constructors 
          + + - - + + - - - + + + + +
          Constructors
          ConstructorDescriptionConstructorDescription
          NMSClass​(java.lang.Class<?> clazz) +
          NMSClass​(java.lang.Class<?> clazz)
          Constructs an NMSClass wrapping the given class
          -
          • -
        +
    + -
    - +
    +
    +
    +

    Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - -
            -
          • -

            NMSClass

            -
            public NMSClass​(java.lang.Class<?> clazz)
            +
          • +
            +

            Constructor Details

            +
              +
            • +
              +

              NMSClass

              +
              public NMSClass​(java.lang.Class<?> clazz)
              Constructs an NMSClass wrapping the given class
              -
              -
              Parameters:
              +
              +
              Parameters:
              clazz - The class to wrap
              -
              • -
            +
        + -
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            getName

            -
            public java.lang.String getName()
            -
            -
            Returns:
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              getName

              +
              public java.lang.String getName()
              +
              +
              Returns:
              The simple name of the wrapped class
              +
              • -
            - - - -
              -
            • -

              getWrappedClass

              -
              public java.lang.Class<?> getWrappedClass()
              -
              -
              Returns:
              +
            • +
              +

              getWrappedClass

              +
              public java.lang.Class<?> getWrappedClass()
              +
              +
              Returns:
              The wrapped class
              +
              • -
            - - - -
              -
            • -

              getSuperclass

              -
              public NMSClass getSuperclass()
              -
              -
              Returns:
              +
            • +
              +

              getSuperclass

              +
              public NMSClass getSuperclass()
              +
              +
              Returns:
              The wrapped superclass
              +
              • -
            - - - -
              -
            • -

              getInstance

              -
              public NMSObject getInstance​(java.lang.Object... args)
              +
            • +
              +

              getInstance

              +
              public NMSObject getInstance​(java.lang.Object... args)
              Calls a constructor of this class with the given arguments
              -
              -
              Parameters:
              +
              +
              Parameters:
              args - The arguments to pass to the constructor
              -
              Returns:
              +
              Returns:
              An NMSObject wrapping the returned value
              +
              • -
            - - - -
              -
            • -

              createArray

              -
              public NMSArray createArray​(int size)
              +
            • +
              +

              createArray

              +
              public NMSArray createArray​(int size)
              Creates an array of this class type
              -
              -
              Parameters:
              +
              +
              Parameters:
              size - The size of the array
              -
              Returns:
              +
              Returns:
              An NMSArray wrapping the array
              +
              • -
            - - - -
              -
            • -

              callStaticMethod

              -
              public NMSObject callStaticMethod​(java.lang.String methodName,
-                                  java.lang.Object... args)
              +
            • +
              +

              callStaticMethod

              +
              public NMSObject callStaticMethod​(java.lang.String methodName, +java.lang.Object... args)
              Calls a static method of this class
              -
              -
              Parameters:
              +
              +
              Parameters:
              methodName - The name of the static method
              args - The arguments to pass to the static method
              -
              Returns:
              +
              Returns:
              An NMSObject wrapping the returned value from the method
              +
              • -
            - - - -
              -
            • -

              getStaticField

              -
              public NMSObject getStaticField​(java.lang.String name)
              +
            • +
              +

              getStaticField

              +
              public NMSObject getStaticField​(java.lang.String name)
              Gets the value of a static field in the wrapped class
              -
              -
              Parameters:
              +
              +
              Parameters:
              name - The name of the field
              -
              Returns:
              +
              Returns:
              An NMSObject wrapping the field
              -
              • -
            +
      -
    - - + + + + diff --git a/javadoc/redempt/redlib/nms/NMSHelper.html b/javadoc/redempt/redlib/nms/NMSHelper.html index 6323e21..7db2d70 100644 --- a/javadoc/redempt/redlib/nms/NMSHelper.html +++ b/javadoc/redempt/redlib/nms/NMSHelper.html @@ -5,476 +5,369 @@ NMSHelper (RedLib API) + + - + + - - - - - + + - - -
    +
    +
    + + + +
    - +
    +
    -
    Package redempt.redlib.nms
    -

    Class NMSHelper

    +
    Package redempt.redlib.nms
    +

    Class NMSHelper

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.nms.NMSHelper
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      redempt.redlib.nms.NMSHelper
      +
      +
      -
      public class NMSHelper
+
      public class NMSHelper
 extends java.lang.Object
      
 
      A set of utility methods useful for handling NMS
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Constructor Summary

          - - +
        • +
          +

          Constructor Summary

          +
          +
          • Constructors 
          + + - - + + - - - + + + + + +
          Constructors
          ConstructorDescriptionConstructorDescription
          NMSHelper() 
          NMSHelper() 
          -
          • -
        +
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Static Methods Concrete Methods 
      + - - - + + + - - - - + + + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + + - - - - + + + +
      Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
      static java.lang.Class<?>[]getArgTypes​(java.lang.Object... args) +
      static java.lang.Class<?>[]getArgTypes​(java.lang.Object... args)
      Gets the class list of argument types for finding methods
      static NMSClassgetClass​(java.lang.String name) +
      static NMSClassgetClass​(java.lang.String name)
      Gets any class and wraps it in an NMSClass
      static java.lang.reflect.ConstructorgetConstructor​(java.lang.Class<?> clazz, - java.lang.Class<?>[] argTypes) +
      static java.lang.reflect.ConstructorgetConstructor​(java.lang.Class<?> clazz, +java.lang.Class<?>[] argTypes)
      Gets a constructor by its parameter types, accounts for cases where the given class might not be the exact same type as the parameter the method requires, but is a subclass.
      static java.lang.reflect.MethodgetMethod​(java.lang.Class<?> clazz, - java.lang.String name, - java.lang.Class<?>[] argTypes) +
      static java.lang.reflect.MethodgetMethod​(java.lang.Class<?> clazz, +java.lang.String name, +java.lang.Class<?>[] argTypes)
      Gets a method by its name and parameter types, accounts for cases where the given class might not be the exact same type as the parameter the method requires, but is a subclass.
      static NMSClassgetNMSClass​(java.lang.String name) +
      static NMSClassgetNMSClass​(java.lang.String name)
      Gets an NMS class (a class whose package is net.minecraft.server followed by the version package) by name.
      static java.lang.StringgetNMSPackage() +
      static java.lang.StringgetNMSPackage()
      Gets the full name of the NMS package
      static java.lang.StringgetNMSVersion() 
      static java.lang.StringgetNMSVersion() 
      static voidunwrapArgs​(java.lang.Object... args) +
      static voidunwrapArgs​(java.lang.Object... args)
      Unwraps an array of arguments, replacing NMSObjects with their wrapped values
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

    Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - -
            -
          • -

            NMSHelper

            -
            public NMSHelper()
            -
            • -
          +
        • +
          +

          Constructor Details

          +
            +
          • +
            +

            NMSHelper

            +
            public NMSHelper()
            +
          +
          • -
          -
            -
          • - - -

            Method Detail

            - - - -
              -
            • -

              getNMSPackage

              -
              public static java.lang.String getNMSPackage()
              +
            • +
              +

              Method Details

              +
                +
              • +
                +

                getNMSPackage

                +
                public static java.lang.String getNMSPackage()
                Gets the full name of the NMS package
                -
                -
                Returns:
                +
                +
                Returns:
                The full name of the NMS package
                +
                • -
              - - - -
                -
              • -

                getNMSVersion

                -
                public static java.lang.String getNMSVersion()
                -
                -
                Returns:
                +
              • +
                +

                getNMSVersion

                +
                public static java.lang.String getNMSVersion()
                +
                +
                Returns:
                The version section of the NMS package, like v1_15_R1
                +
                • -
              - - - -
                -
              • -

                unwrapArgs

                -
                public static void unwrapArgs​(java.lang.Object... args)
                +
              • +
                +

                unwrapArgs

                +
                public static void unwrapArgs​(java.lang.Object... args)
                Unwraps an array of arguments, replacing NMSObjects with their wrapped values
                -
                -
                Parameters:
                +
                +
                Parameters:
                args - The arguments to unwrap
                +
                • -
              - - - -
                -
              • -

                getArgTypes

                -
                public static java.lang.Class<?>[] getArgTypes​(java.lang.Object... args)
                +
              • +
                +

                getArgTypes

                +
                public static java.lang.Class<?>[] getArgTypes​(java.lang.Object... args)
                Gets the class list of argument types for finding methods
                -
                -
                Parameters:
                +
                +
                Parameters:
                args - The arguments to convert to their class types
                -
                Returns:
                +
                Returns:
                The class types of each argument
                +
                • -
              - - - -
                -
              • -

                getMethod

                -
                public static java.lang.reflect.Method getMethod​(java.lang.Class<?> clazz,
-                                                 java.lang.String name,
-                                                 java.lang.Class<?>[] argTypes)
                +
              • +
                +

                getMethod

                +
                public static java.lang.reflect.Method getMethod​(java.lang.Class<?> clazz, +java.lang.String name, +java.lang.Class<?>[] argTypes)
                Gets a method by its name and parameter types, accounts for cases where the given class might not be the exact same type as the parameter the method requires, but is a subclass.
                -
                -
                Parameters:
                +
                +
                Parameters:
                clazz - The class to get the method in
                name - The name of the method
                argTypes - The class types for the method parameters
                -
                Returns:
                +
                Returns:
                The method in the class, or null if none was found
                +
                • -
              - - - -
                -
              • -

                getConstructor

                -
                public static java.lang.reflect.Constructor getConstructor​(java.lang.Class<?> clazz,
-                                                           java.lang.Class<?>[] argTypes)
                +
              • +
                +

                getConstructor

                +
                public static java.lang.reflect.Constructor getConstructor​(java.lang.Class<?> clazz, +java.lang.Class<?>[] argTypes)
                Gets a constructor by its parameter types, accounts for cases where the given class might not be the exact same type as the parameter the method requires, but is a subclass.
                -
                -
                Parameters:
                +
                +
                Parameters:
                clazz - The class to get the constructor in
                argTypes - The class types for the constructor parameters
                -
                Returns:
                +
                Returns:
                The constructor in the class, or null if none was found
                +
                • -
              - - - -
                -
              • -

                getNMSClass

                -
                public static NMSClass getNMSClass​(java.lang.String name)
                +
              • +
                +

                getNMSClass

                +
                public static NMSClass getNMSClass​(java.lang.String name)
                Gets an NMS class (a class whose package is net.minecraft.server followed by the version package) by name.
                -
                -
                Parameters:
                +
                +
                Parameters:
                name - The name of the class
                -
                Returns:
                +
                Returns:
                The NMSClass wrapping the resulting class
                +
                • -
              - - - -
                -
              • -

                getClass

                -
                public static NMSClass getClass​(java.lang.String name)
                +
              • +
                +

                getClass

                +
                public static NMSClass getClass​(java.lang.String name)
                Gets any class and wraps it in an NMSClass
                -
                -
                Parameters:
                +
                +
                Parameters:
                name - The full name of the class
                -
                Returns:
                +
                Returns:
                The wrapped NMSClass
                -
                • -
              +
        -
    - - + + + + diff --git a/javadoc/redempt/redlib/nms/NMSObject.html b/javadoc/redempt/redlib/nms/NMSObject.html index 9ffef4f..f5b5b48 100644 --- a/javadoc/redempt/redlib/nms/NMSObject.html +++ b/javadoc/redempt/redlib/nms/NMSObject.html @@ -5,520 +5,407 @@ NMSObject (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.nms
    -

    Class NMSObject

    +
    Package redempt.redlib.nms
    +

    Class NMSObject

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.nms.NMSObject
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      redempt.redlib.nms.NMSObject
      +
      +
      -
      public class NMSObject
+
      public class NMSObject
 extends java.lang.Object
      
 
      Wraps any Object and provides easy access to reflection methods
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Constructor Summary

          - - +
        • +
          +

          Constructor Summary

          +
          +
          • Constructors 
          + + - - + + - - - + + + + +
          Constructors
          ConstructorDescriptionConstructorDescription
          NMSObject​(java.lang.Object obj) +
          NMSObject​(java.lang.Object obj)
          Constructs an NMSObject with the object it should wrap
          -
          • -
        +
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Instance Methods Concrete Methods 
      + - - - + + + - - - - + + + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + - - - - + + + +
      Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
      NMSObjectcallMethod​(int supers, - java.lang.String name, - java.lang.Object... args) +
      NMSObjectcallMethod​(int supers, +java.lang.String name, +java.lang.Object... args)
      Calls a method on the wrapped object
      NMSObjectcallMethod​(java.lang.String name, - java.lang.Object... args) +
      NMSObjectcallMethod​(java.lang.String name, +java.lang.Object... args)
      Calls a method on the wrapped object
      NMSObjectgetField​(int supers, - java.lang.String name) +
      NMSObjectgetField​(int supers, +java.lang.String name)
      Gets the value stored in a field in the wrapped object
      NMSObjectgetField​(java.lang.String name) +
      NMSObjectgetField​(java.lang.String name)
      Gets the value stored in a field in the wrapped object
      java.lang.ObjectgetObject() 
      java.lang.ObjectgetObject() 
      NMSClassgetType() 
      NMSClassgetType() 
      java.lang.StringgetTypeName() 
      java.lang.StringgetTypeName() 
      booleanisNull() 
      booleanisNull() 
      voidsetField​(int supers, - java.lang.String name, - java.lang.Object obj) +
      voidsetField​(int supers, +java.lang.String name, +java.lang.Object obj)
      Sets the value stored in a field in the wrapped object
      voidsetField​(java.lang.String name, - java.lang.Object obj) +
      voidsetField​(java.lang.String name, +java.lang.Object obj)
      Sets the value stored in a field in the wrapped object
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

    Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - -
            -
          • -

            NMSObject

            -
            public NMSObject​(java.lang.Object obj)
            +
          • +
            +

            Constructor Details

            +
              +
            • +
              +

              NMSObject

              +
              public NMSObject​(java.lang.Object obj)
              Constructs an NMSObject with the object it should wrap
              -
              -
              Parameters:
              +
              +
              Parameters:
              obj - The object to wrap
              -
              • -
            +
        + -
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            getObject

            -
            public java.lang.Object getObject()
            -
            -
            Returns:
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              getObject

              +
              public java.lang.Object getObject()
              +
              +
              Returns:
              The wrapped object
              +
              • -
            - - - -
              -
            • -

              getTypeName

              -
              public java.lang.String getTypeName()
              -
              -
              Returns:
              +
            • +
              +

              getTypeName

              +
              public java.lang.String getTypeName()
              +
              +
              Returns:
              The name of the class of the wrapped object
              +
              • -
            - - - -
              -
            • -

              getType

              -
              public NMSClass getType()
              -
              -
              Returns:
              +
            • +
              +

              getType

              +
              public NMSClass getType()
              +
              +
              Returns:
              A wrapped NMSClass of the class of the wrapped object
              +
              • -
            - - - -
              -
            • -

              isNull

              -
              public boolean isNull()
              -
              -
              Returns:
              +
            • +
              +

              isNull

              +
              public boolean isNull()
              +
              +
              Returns:
              Whether this NMSObject is wrapping null
              +
              • -
            - - - -
              -
            • -

              callMethod

              -
              public NMSObject callMethod​(int supers,
-                            java.lang.String name,
-                            java.lang.Object... args)
              +
            • +
              +

              callMethod

              +
              public NMSObject callMethod​(int supers, +java.lang.String name, +java.lang.Object... args)
              Calls a method on the wrapped object
              -
              -
              Parameters:
              +
              +
              Parameters:
              name - The name of the method
              args - The arguments to pass to the method
              supers - The number of superclasses to move up before getting the declared method
              -
              Returns:
              +
              Returns:
              An NMSObject which is the returned value from the method
              +
              • -
            - - - -
              -
            • -

              callMethod

              -
              public NMSObject callMethod​(java.lang.String name,
-                            java.lang.Object... args)
              +
            • +
              +

              callMethod

              +
              public NMSObject callMethod​(java.lang.String name, +java.lang.Object... args)
              Calls a method on the wrapped object
              -
              -
              Parameters:
              +
              +
              Parameters:
              name - The name of the method
              args - The arguments to pass to the method
              -
              Returns:
              +
              Returns:
              An NMSObject which is the returned value from the method
              +
              • -
            - - - -
              -
            • -

              getField

              -
              public NMSObject getField​(int supers,
-                          java.lang.String name)
              +
            • +
              +

              getField

              +
              public NMSObject getField​(int supers, +java.lang.String name)
              Gets the value stored in a field in the wrapped object
              -
              -
              Parameters:
              +
              +
              Parameters:
              name - The name of the field
              supers - The number of superclasses to move up before getting the declared field
              -
              Returns:
              +
              Returns:
              A wrapped NMSObject with the value of the field
              +
              • -
            - - - -
              -
            • -

              getField

              -
              public NMSObject getField​(java.lang.String name)
              +
            • +
              +

              getField

              +
              public NMSObject getField​(java.lang.String name)
              Gets the value stored in a field in the wrapped object
              -
              -
              Parameters:
              +
              +
              Parameters:
              name - The name of the field
              -
              Returns:
              +
              Returns:
              A wrapped NMSObject with the value of the field
              +
              • -
            - - - -
              -
            • -

              setField

              -
              public void setField​(int supers,
-                     java.lang.String name,
-                     java.lang.Object obj)
              +
            • +
              +

              setField

              +
              public void setField​(int supers, +java.lang.String name, +java.lang.Object obj)
              Sets the value stored in a field in the wrapped object
              -
              -
              Parameters:
              +
              +
              Parameters:
              name - The name of the field
              supers - The number of superclasses to move up before getting the declared field
              obj - The object to set. Will be unwrapped if it is an NMSObject.
              +
              • -
            - - - -
              -
            • -

              setField

              -
              public void setField​(java.lang.String name,
-                     java.lang.Object obj)
              +
            • +
              +

              setField

              +
              public void setField​(java.lang.String name, +java.lang.Object obj)
              Sets the value stored in a field in the wrapped object
              -
              -
              Parameters:
              +
              +
              Parameters:
              name - The name of the field
              obj - The object to set. Will be unwrapped if it is an NMSObject.
              -
              • -
            +
      -
    - - + + + + diff --git a/javadoc/redempt/redlib/nms/package-summary.html b/javadoc/redempt/redlib/nms/package-summary.html index 1b29abc..52e0fe0 100644 --- a/javadoc/redempt/redlib/nms/package-summary.html +++ b/javadoc/redempt/redlib/nms/package-summary.html @@ -5,47 +5,30 @@ redempt.redlib.nms (RedLib API) + + - + + - - - - - + + - - -
    +
    + +

    Package redempt.redlib.nms

    -
    -
      -
    • - - +
      +
        +
      • +
        +
      Class Summary 
      + + - - + + + - - - + + - - - + + - - - + + - - - + +
      Class Summary
      ClassDescriptionClassDescription
      NMSArray +
      NMSArray
      Wraps any type of Array and provides easy reflection access
      NMSClass +
      NMSClass
      Wraps any class and provides methods for easy reflection
      NMSHelper +
      NMSHelper
      A set of utility methods useful for handling NMS
      NMSObject +
      NMSObject
      Wraps any Object and provides easy access to reflection methods
      +
    -
    +
    + + +
    +
    + diff --git a/javadoc/redempt/redlib/nms/package-tree.html b/javadoc/redempt/redlib/nms/package-tree.html index d55c24f..7e93b40 100644 --- a/javadoc/redempt/redlib/nms/package-tree.html +++ b/javadoc/redempt/redlib/nms/package-tree.html @@ -5,159 +5,92 @@ redempt.redlib.nms Class Hierarchy (RedLib API) + + - + + - - - - - + + - - -
    +
    + +

    Hierarchy For Package redempt.redlib.nms

    -Package Hierarchies: +Package Hierarchies:
    -
    -
    +

    Class Hierarchy

    -
    +
    +
    diff --git a/javadoc/redempt/redlib/package-summary.html b/javadoc/redempt/redlib/package-summary.html index 492cbb4..3f849f0 100644 --- a/javadoc/redempt/redlib/package-summary.html +++ b/javadoc/redempt/redlib/package-summary.html @@ -5,47 +5,30 @@ redempt.redlib (RedLib API) + + - + + - - - - - + + - - -
    +
    + +

    Package redempt.redlib

    -
    -
      -
    • - - +
      +
        +
      • +
        +
      Class Summary 
      + + - - + + + - - - + + +
      Class Summary
      ClassDescriptionClassDescription
      RedLib 
      RedLib 
      +
    -
    + +
    + diff --git a/javadoc/redempt/redlib/package-tree.html b/javadoc/redempt/redlib/package-tree.html index 79d5c36..493e79f 100644 --- a/javadoc/redempt/redlib/package-tree.html +++ b/javadoc/redempt/redlib/package-tree.html @@ -5,101 +5,58 @@ redempt.redlib Class Hierarchy (RedLib API) + + - + + - - - - - + + - - -
    +
    + +

    Hierarchy For Package redempt.redlib

    -Package Hierarchies: +Package Hierarchies:
    -
    -
    +

    Class Hierarchy

    • java.lang.Object @@ -108,7 +65,7 @@

      Class Hierarchy

      • org.bukkit.plugin.java.JavaPlugin
      @@ -117,52 +74,28 @@

      Class Hierarchy

    -
    +
    +
    diff --git a/javadoc/redempt/redlib/protection/BypassPolicy.html b/javadoc/redempt/redlib/protection/BypassPolicy.html index fc243c8..3afb584 100644 --- a/javadoc/redempt/redlib/protection/BypassPolicy.html +++ b/javadoc/redempt/redlib/protection/BypassPolicy.html @@ -5,259 +5,185 @@ BypassPolicy (RedLib API) + + - + + - - - - - + + - - -
    +
    +
    + + + +
    - +
    +
    -
    Package redempt.redlib.protection
    -

    Interface BypassPolicy

    +
    Package redempt.redlib.protection
    +

    Interface BypassPolicy

    -
    -
    -
      -
    • +
      -
      public interface BypassPolicy
      +
      public interface BypassPolicy
      Represents a policy that allows players to bypass certain protection types for certain blocks
      -
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Method Summary

          - - +
        • +
          +

          Method Summary

          +
          +
          +
          +
          • All Methods Instance Methods Abstract Methods 
          + - - - + + + - - - - + + + + + +
          Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
          booleancanBypass​(org.bukkit.entity.Player player, - ProtectionPolicy.ProtectionType type, - org.bukkit.block.Block block) +
          booleancanBypass​(org.bukkit.entity.Player player, +ProtectionPolicy.ProtectionType type, +org.bukkit.block.Block block)
          Checks whether a player can bypass the given protection type for the given block
          -
          • -
        +
    +
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            canBypass

            -
            boolean canBypass​(org.bukkit.entity.Player player,
-                  ProtectionPolicy.ProtectionType type,
-                  org.bukkit.block.Block block)
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              canBypass

              +
              boolean canBypass​(org.bukkit.entity.Player player, +ProtectionPolicy.ProtectionType type, +org.bukkit.block.Block block)
              Checks whether a player can bypass the given protection type for the given block
              -
              -
              Parameters:
              +
              +
              Parameters:
              player - The player attempting an action
              type - The type of action being attempted
              block - The block the action is being performed on
              -
              Returns:
              +
              Returns:
              Whether this player can bypass the protection type for the given block
              -
              • -
            +
      -
    - - + + + + diff --git a/javadoc/redempt/redlib/protection/ProtectedRegion.html b/javadoc/redempt/redlib/protection/ProtectedRegion.html index 0bd1076..e79e565 100644 --- a/javadoc/redempt/redlib/protection/ProtectedRegion.html +++ b/javadoc/redempt/redlib/protection/ProtectedRegion.html @@ -5,375 +5,280 @@ ProtectedRegion (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.protection
    -

    Class ProtectedRegion

    +
    Package redempt.redlib.protection
    +

    Class ProtectedRegion

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.protection.ProtectedRegion
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      redempt.redlib.protection.ProtectedRegion
      +
      +
      -
      public class ProtectedRegion
+
      public class ProtectedRegion
 extends java.lang.Object
      
 
      Represents a Region which has been protected using a ProtectionPolicy
      
-
      • -
    -
    -
    -
    + -
    - +
    +
    +
    +

    Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - -
            -
          • -

            ProtectedRegion

            -
            public ProtectedRegion​(org.bukkit.plugin.Plugin plugin,
-                       Region region,
-                       ProtectionPolicy.ProtectionType... types)
            +
          • +
            +

            Constructor Details

            +
              +
            • +
              +

              ProtectedRegion

              +
              public ProtectedRegion​(org.bukkit.plugin.Plugin plugin, +Region region, +ProtectionPolicy.ProtectionType... types)
              Creates a ProtectedRegion
              -
              -
              Parameters:
              +
              +
              Parameters:
              plugin - The Plugin registering the ProtectedRegion
              region - The Region to protect
              types - The ProtectionTypes to protect the Region with
              +
              • -
            - - - - +
        + -
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            getRegion

            -
            public Region getRegion()
            -
            -
            Returns:
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              getRegion

              +
              public Region getRegion()
              +
              +
              Returns:
              The region being protected
              +
              • -
            - - - - - - - -
              -
            • -

              unprotect

              -
              public void unprotect()
              +
            • +
              +

              unprotect

              +
              public void unprotect()
              Disables all protections for this region
              -
              • -
            +
      -
    - - + + + + diff --git a/javadoc/redempt/redlib/protection/ProtectionPolicy.ProtectionType.html b/javadoc/redempt/redlib/protection/ProtectionPolicy.ProtectionType.html index 5f264d1..1465ca6 100644 --- a/javadoc/redempt/redlib/protection/ProtectionPolicy.ProtectionType.html +++ b/javadoc/redempt/redlib/protection/ProtectionPolicy.ProtectionType.html @@ -5,811 +5,644 @@ ProtectionPolicy.ProtectionType (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.protection
    -

    Enum ProtectionPolicy.ProtectionType

    +
    Package redempt.redlib.protection
    +

    Enum ProtectionPolicy.ProtectionType

    -
    - -
    -
      -
    • -
      +
      java.lang.Object +
      java.lang.Enum<ProtectionPolicy.ProtectionType> +
      redempt.redlib.protection.ProtectionPolicy.ProtectionType
      +
      +
      +
      +
      All Implemented Interfaces:
      -
      java.io.Serializable, java.lang.Comparable<ProtectionPolicy.ProtectionType>
      +
      java.io.Serializable, java.lang.Comparable<ProtectionPolicy.ProtectionType>, java.lang.constant.Constable
      -
      +
      Enclosing class:
      ProtectionPolicy
      -
      public static enum ProtectionPolicy.ProtectionType
+
      public static enum ProtectionPolicy.ProtectionType
 extends java.lang.Enum<ProtectionPolicy.ProtectionType>
      
+
      +
      +
        + +
      • +
        +

        Nested Class Summary

        +
        +

        Nested classes/interfaces inherited from class java.lang.Enum

        +java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>
        +
        • -
      -
    -
    -
    + -
    - +
    + -
    - +
    +
    +
    +

    Methods inherited from class java.lang.Enum

    +clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
    +
    +

    Methods inherited from class java.lang.Object

    +getClass, notify, notifyAll, wait, wait, wait
    - -
    -
    +
    +
    Returns:
    an array containing the constants of this enum type, in the order they are declared
    + - - - - -
      -
    • -

      valueOf

      -
      public static ProtectionPolicy.ProtectionType valueOf​(java.lang.String name)
      +
    • +
      +

      valueOf

      +
      public static ProtectionPolicy.ProtectionType 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:
      +
      +
      Parameters:
      name - the name of the enum constant to be returned.
      -
      Returns:
      +
      Returns:
      the enum constant with the specified name
      -
      Throws:
      +
      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/redempt/redlib/protection/ProtectionPolicy.html b/javadoc/redempt/redlib/protection/ProtectionPolicy.html index 703738b..1da7a30 100644 --- a/javadoc/redempt/redlib/protection/ProtectionPolicy.html +++ b/javadoc/redempt/redlib/protection/ProtectionPolicy.html @@ -5,782 +5,640 @@ ProtectionPolicy (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.protection
    -

    Class ProtectionPolicy

    +
    Package redempt.redlib.protection
    +

    Class ProtectionPolicy

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.protection.ProtectionPolicy
        • -
      -
      • -
    -
    -
      -
    • -
      +
      java.lang.Object +
      redempt.redlib.protection.ProtectionPolicy
      +
      +
      +
      All Implemented Interfaces:
      org.bukkit.event.Listener
      -
      public class ProtectionPolicy
+
      public class ProtectionPolicy
 extends java.lang.Object
 implements org.bukkit.event.Listener
      
 
      Represents a set of rules in the form of ProtectionPolicy.ProtectionTypes protecting a set of blocks, which can have bypasses
      
-
      • -
    -
    -
    -
    + -
    - +
    + -
    - +
    + -
    - +
    + +
    +

    Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - -
            -
          • -

            ProtectionPolicy

            -
            protected ProtectionPolicy​(org.bukkit.plugin.Plugin plugin,
-                           CuboidRegion bounds,
-                           java.util.function.Predicate<org.bukkit.block.Block> protectionCheck,
-                           ProtectionPolicy.ProtectionType... protections)
            +
          • +
            +

            Constructor Details

            +
              +
            • +
              +

              ProtectionPolicy

              +
              protected ProtectionPolicy​(org.bukkit.plugin.Plugin plugin, +CuboidRegion bounds, +java.util.function.Predicate<org.bukkit.block.Block> protectionCheck, +ProtectionPolicy.ProtectionType... protections)
              +
              • -
            - - - -
              -
            • -

              ProtectionPolicy

              -
              public ProtectionPolicy​(CuboidRegion bounds,
-                        java.util.function.Predicate<org.bukkit.block.Block> protectionCheck,
-                        ProtectionPolicy.ProtectionType... protections)
              +
            • +
              +

              ProtectionPolicy

              +
              public ProtectionPolicy​(CuboidRegion bounds, +java.util.function.Predicate<org.bukkit.block.Block> protectionCheck, +ProtectionPolicy.ProtectionType... protections)
              Create a ProtectionPolicy to protect blocks
              -
              -
              Parameters:
              +
              +
              Parameters:
              bounds - A region that defines the bounds inside which this ProtectionPolicy protects blocks
              protectionCheck - A predicate which will be used to check whether blocks are protected by this ProtectionPolicy
              protections - The types of actions to protect against
              +
              • -
            - - - -
              -
            • -

              ProtectionPolicy

              -
              public ProtectionPolicy​(java.util.function.Predicate<org.bukkit.block.Block> protectionCheck,
-                        ProtectionPolicy.ProtectionType... protections)
              +
            • +
              +

              ProtectionPolicy

              +
              public ProtectionPolicy​(java.util.function.Predicate<org.bukkit.block.Block> protectionCheck, +ProtectionPolicy.ProtectionType... protections)
              Create a ProtectionPolicy to protect blocks. Prefer ProtectionPolicy(CuboidRegion, Predicate, ProtectionType...), as it will improve performance
              -
              -
              Parameters:
              +
              +
              Parameters:
              protectionCheck - A predicate which will be used to check whether blocks are protected by this ProtectionPolicy
              protections - The types of actions to protect against
              -
              • -
            +
        + -
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            registerProtections

            -
            public static void registerProtections()
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              registerProtections

              +
              public static void registerProtections()
              +
              • -
            - - - -
              -
            • -

              registerProtection

              -
              public static <T extends org.bukkit.event.Event & org.bukkit.event.Cancellable> void registerProtection​(java.lang.Class<T> clazz,
-                                                                                                        ProtectionPolicy.ProtectionType type,
-                                                                                                        java.util.function.Function<T,​org.bukkit.entity.Player> getPlayer,
-                                                                                                        java.util.function.Function<T,​org.bukkit.block.Block>... getBlocks)
              +
            • +
              +

              registerProtection

              +
              public static <T extends org.bukkit.event.Event & org.bukkit.event.Cancellable> +void registerProtection​(java.lang.Class<T> clazz, +ProtectionPolicy.ProtectionType type, +java.util.function.Function<T,​org.bukkit.entity.Player> getPlayer, +java.util.function.Function<T,​org.bukkit.block.Block>... getBlocks)
              Registers a custom event to be protected using a specific ProtectionType
              -
              -
              Type Parameters:
              +
              +
              Type Parameters:
              T - The event type
              -
              Parameters:
              +
              Parameters:
              clazz - The event class of an event which implements Cancellable
              type - The ProtectionType to protect against this event
              getPlayer - A function to get the player associated with the event - can return null
              getBlocks - A vararg of functions to get blocks associated with the event
              +
              • -
            - - - -
              -
            • -

              registerProtectionNonCancellable

              -
              public static <T extends org.bukkit.event.Event> void registerProtectionNonCancellable​(java.lang.Class<T> clazz,
-                                                                                       ProtectionPolicy.ProtectionType type,
-                                                                                       java.util.function.Function<T,​org.bukkit.entity.Player> getPlayer,
-                                                                                       java.util.function.Consumer<T> cancel,
-                                                                                       java.util.function.Function<T,​org.bukkit.block.Block>... getBlocks)
              +
            • +
              +

              registerProtectionNonCancellable

              +
              public static <T extends org.bukkit.event.Event> +void registerProtectionNonCancellable​(java.lang.Class<T> clazz, +ProtectionPolicy.ProtectionType type, +java.util.function.Function<T,​org.bukkit.entity.Player> getPlayer, +java.util.function.Consumer<T> cancel, +java.util.function.Function<T,​org.bukkit.block.Block>... getBlocks)
              Registers a custom event that cannot be cancelled using Cancellable.setCancelled(boolean) using a specific ProtectionType
              -
              -
              Type Parameters:
              +
              +
              Type Parameters:
              T - The event type
              -
              Parameters:
              +
              Parameters:
              clazz - The event class
              type - The ProtectionType to protect against this event
              getPlayer - A function to get the player associated with the event - can return null
              cancel - A consumer to cancel the event
              getBlocks - A vararg of functions to get the blocks associated with this event
              +
              • -
            - - - -
              -
            • -

              setProtectionTypes

              -
              public void setProtectionTypes​(ProtectionPolicy.ProtectionType... protections)
              +
            • +
              +

              setProtectionTypes

              +
              public void setProtectionTypes​(ProtectionPolicy.ProtectionType... protections)
              Sets the ProtectionTypes to be used
              -
              -
              Parameters:
              +
              +
              Parameters:
              protections - The ProtectionTypes
              +
              • -
            - - - -
              -
            • -

              addProtectionTypes

              -
              public void addProtectionTypes​(ProtectionPolicy.ProtectionType... protections)
              +
            • +
              +

              addProtectionTypes

              +
              public void addProtectionTypes​(ProtectionPolicy.ProtectionType... protections)
              Adds ProtectionTypes to this ProtectionPolicy
              -
              -
              Parameters:
              +
              +
              Parameters:
              protections - The ProtectionTypes to add
              +
              • -
            - - - -
              -
            • -

              removeProtectionTypes

              -
              public void removeProtectionTypes​(ProtectionPolicy.ProtectionType... protections)
              +
            • +
              +

              removeProtectionTypes

              +
              public void removeProtectionTypes​(ProtectionPolicy.ProtectionType... protections)
              Removes ProtectionTypes from this ProtectionPolicy
              -
              -
              Parameters:
              +
              +
              Parameters:
              protections - The ProtectionTypes to remove
              +
              • -
            - - - -
              -
            • -

              disable

              -
              public void disable()
              +
            • +
              +

              disable

              +
              public void disable()
              Disables all protections for this ProtectionPolicy
              +
              • -
            - - - -
              -
            • -

              enable

              -
              public void enable()
              +
            • +
              +

              enable

              +
              public void enable()
              Enables all protections specified for this ProtectionPolicy
              +
              • -
            - - - -
              -
            • -

              addBypassPolicy

              -
              public void addBypassPolicy​(java.util.function.BiPredicate<org.bukkit.entity.Player,​ProtectionPolicy.ProtectionType> bypassPolicy)
              +
            • +
              +

              addBypassPolicy

              +
              public void addBypassPolicy​(java.util.function.BiPredicate<org.bukkit.entity.Player,​ProtectionPolicy.ProtectionType> bypassPolicy)
              Adds a bypass policy, which allows certain players to bypass certain protection types
              -
              -
              Parameters:
              +
              +
              Parameters:
              bypassPolicy - The BiPredicate to determine bypasses by player and protection type
              +
              • -
            - - - -
              -
            • -

              addBypassPolicy

              -
              public void addBypassPolicy​(BypassPolicy bypassPolicy)
              +
            • +
              +

              addBypassPolicy

              +
              public void addBypassPolicy​(BypassPolicy bypassPolicy)
              Adds a bypass policy, which allows certain players to bypass certain protection types
              -
              -
              Parameters:
              +
              +
              Parameters:
              bypassPolicy - The BypassPolicy to determine bypasses by player and protection type
              +
              • -
            - - - -
              -
            • -

              clearBypassPolicies

              -
              public void clearBypassPolicies()
              +
            • +
              +

              clearBypassPolicies

              +
              public void clearBypassPolicies()
              Removes all bypass policies
              +
              • -
            - - - -
              -
            • -

              setDenyMessage

              -
              public void setDenyMessage​(ProtectionPolicy.ProtectionType type,
-                           java.lang.String message)
              +
            • +
              +

              setDenyMessage

              +
              public void setDenyMessage​(ProtectionPolicy.ProtectionType type, +java.lang.String message)
              Sets the message to be shown to a player when they attempt to do an action which is protected again
              -
              -
              Parameters:
              +
              +
              Parameters:
              type - The type of action the message corresponds to
              message - The message players should be shown when this type of action is denied
              +
              • -
            - - - -
              -
            • -

              setDenyMessage

              -
              public void setDenyMessage​(java.util.function.Predicate<ProtectionPolicy.ProtectionType> filter,
-                           java.lang.String message)
              +
            • +
              +

              setDenyMessage

              +
              public void setDenyMessage​(java.util.function.Predicate<ProtectionPolicy.ProtectionType> filter, +java.lang.String message)
              Sets the message to be shown to a player when they attempt to do an action which is protected again
              -
              -
              Parameters:
              +
              +
              Parameters:
              filter - A filter for which types to set the message for
              message - The message players should be shown when these types of actions are denied
              +
              • -
            - - - -
              -
            • -

              clearDenyMessages

              -
              public void clearDenyMessages()
              +
            • +
              +

              clearDenyMessages

              +
              public void clearDenyMessages()
              Clear all deny messages
              +
              • -
            - - - -
              -
            • -

              getBounds

              -
              public CuboidRegion getBounds()
              -
              -
              Returns:
              +
            • +
              +

              getBounds

              +
              public CuboidRegion getBounds()
              +
              +
              Returns:
              The cuboid bounds of this ProtectionPolicy, or null if it is a global policy
              +
              • -
            - - - - - - - -
              -
            • -

              onCreatureSpawn

              -
              public void onCreatureSpawn​(org.bukkit.event.entity.CreatureSpawnEvent e)
              +
            • +
              +

              allow

              +
              public boolean allow​(org.bukkit.block.Block block, +ProtectionPolicy.ProtectionType type, +org.bukkit.entity.Player player)
              +
              • -
            +
          • +
            +

            onCreatureSpawn

            +
            public void onCreatureSpawn​(org.bukkit.event.entity.CreatureSpawnEvent e)
            +
      -
    - - + + + + diff --git a/javadoc/redempt/redlib/protection/package-summary.html b/javadoc/redempt/redlib/protection/package-summary.html index e71b905..30bce89 100644 --- a/javadoc/redempt/redlib/protection/package-summary.html +++ b/javadoc/redempt/redlib/protection/package-summary.html @@ -5,47 +5,30 @@ redempt.redlib.protection (RedLib API) + + - + + - - - - - + + - - -
    +
    + +

    Package redempt.redlib.protection

    -
    -
      -
    • - - +
      +
        +
      • +
        +
      Interface Summary 
      + + - - + + + - - - + +
      Interface Summary
      InterfaceDescriptionInterfaceDescription
      BypassPolicy +
      BypassPolicy
      Represents a policy that allows players to bypass certain protection types for certain blocks
      +
    -
  • - - +
  • +
    +
    • Class Summary 
    + + - - + + + - - - + + - - - + +
    Class Summary
    ClassDescriptionClassDescription
    ProtectedRegion +
    ProtectedRegion
    Represents a Region which has been protected using a ProtectionPolicy
    ProtectionPolicy +
    ProtectionPolicy
    Represents a set of rules in the form of ProtectionPolicy.ProtectionTypes protecting a set of blocks, which can have bypasses
    +
    • -
  • - - +
  • +
    +
    • Enum Summary 
    + + - - + + + - - - + + +
    Enum Summary
    EnumDescriptionEnumDescription
    ProtectionPolicy.ProtectionType 
    ProtectionPolicy.ProtectionType 
    +
    • - +
    + + +
    + + diff --git a/javadoc/redempt/redlib/protection/package-tree.html b/javadoc/redempt/redlib/protection/package-tree.html index c77317e..98551dc 100644 --- a/javadoc/redempt/redlib/protection/package-tree.html +++ b/javadoc/redempt/redlib/protection/package-tree.html @@ -5,177 +5,110 @@ redempt.redlib.protection Class Hierarchy (RedLib API) + + - + + - - - - - + + - - -
    +
    + +

    Hierarchy For Package redempt.redlib.protection

    -Package Hierarchies: +Package Hierarchies:
    -
    -
    +

    Class Hierarchy

    -
    +

    Interface Hierarchy

    -
    +

    Enum Hierarchy

    • java.lang.Object
    -
    +
    +
    diff --git a/javadoc/redempt/redlib/region/CuboidRegion.RegionState.html b/javadoc/redempt/redlib/region/CuboidRegion.RegionState.html index 371d33a..0a19d07 100644 --- a/javadoc/redempt/redlib/region/CuboidRegion.RegionState.html +++ b/javadoc/redempt/redlib/region/CuboidRegion.RegionState.html @@ -5,288 +5,202 @@ CuboidRegion.RegionState (RedLib API) + + - + + - - - - - + + - - -
    +
    +
    + + + +
    - +
    +
    -
    Package redempt.redlib.region
    -

    Class CuboidRegion.RegionState

    +
    Package redempt.redlib.region
    +

    Class CuboidRegion.RegionState

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.region.CuboidRegion.RegionState
        • -
      -
      • -
    -
    -
      -
    • -
      +
      java.lang.Object +
      redempt.redlib.region.CuboidRegion.RegionState
      +
      +
      +
      Enclosing class:
      CuboidRegion
      -
      public static class CuboidRegion.RegionState
+
      public static class CuboidRegion.RegionState
 extends java.lang.Object
      
 
      Represents a state of a Region, not necessarily at the current point in time
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Method Summary

          - - +
        • +
          +

          Method Summary

          +
          +
          +
          +
          • All Methods Instance Methods Concrete Methods 
          + - - - + + + - - - - + + + + + - - - - + + + +
          Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
          org.bukkit.block.BlockState[][][]getBlocks() +
          org.bukkit.block.BlockState[][][]getBlocks()
          Gets all the BlockStates in this RegionState
          voidrestore() +
          voidrestore()
          Restores the Region to this state
          -
            -
          • - - -

            Methods inherited from class java.lang.Object

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

    Methods inherited from class java.lang.Object

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

          Method Detail

          - - - -
            -
          • -

            restore

            -
            public void restore()
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              restore

              +
              public void restore()
              Restores the Region to this state
              +
              • -
            - - - -
              -
            • -

              getBlocks

              -
              public org.bukkit.block.BlockState[][][] getBlocks()
              +
            • +
              +

              getBlocks

              +
              public org.bukkit.block.BlockState[][][] getBlocks()
              Gets all the BlockStates in this RegionState
              -
              -
              Returns:
              +
              +
              Returns:
              The 3-dimensional array of BlockStates
              -
              • -
            +
      -
    - - + + + + diff --git a/javadoc/redempt/redlib/region/CuboidRegion.html b/javadoc/redempt/redlib/region/CuboidRegion.html index 28f840a..ac3de69 100644 --- a/javadoc/redempt/redlib/region/CuboidRegion.html +++ b/javadoc/redempt/redlib/region/CuboidRegion.html @@ -5,1027 +5,852 @@ CuboidRegion (RedLib API) + + - + + - - - - - + + - - -
    +
    +
    + + + +
    - +
    +
    -
    Package redempt.redlib.region
    -

    Class CuboidRegion

    +
    Package redempt.redlib.region
    +

    Class CuboidRegion

    -
    - -
    -
      -
    • -
      +
      java.lang.Object +
      redempt.redlib.region.Region +
      redempt.redlib.region.CuboidRegion
      +
      +
      +
      +
      All Implemented Interfaces:
      java.lang.Cloneable, Overlappable
      -
      public class CuboidRegion
+
      public class CuboidRegion
 extends Region
 implements Overlappable
      
 
      Represents a cuboid region in a world
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Nested Class Summary

          - - +
        • +
          +

          Nested Class Summary

          +
          +
          • Nested Classes 
          + + - - - - - - - - + + + + + + + + + +
          Nested Classes
          Modifier and TypeClassDescription
          static class CuboidRegion.RegionState +Modifier and TypeClassDescription
          static class CuboidRegion.RegionState
          Represents a state of a Region, not necessarily at the current point in time
          -
          • -
        +
    + -
    -
      -
    • - - -

      Field Summary

      - - +
    • +
      +

      Field Summary

      +
      +
      • Fields 
      + + - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + +
      Fields
      Modifier and TypeFieldDescription
      protected org.bukkit.Locationend 
      protected org.bukkit.Locationstart 
      Modifier and TypeFieldDescription
      protected org.bukkit.Locationend 
      protected org.bukkit.Locationstart 
      -
      • -
    +
    + -
    -
      -
    • - - -

      Constructor Summary

      - - +
    • +
      +

      Constructor Summary

      +
      +
      • Constructors 
      + + - - - - - - - - - - - - - + + + + + + + + + + + + + + +
      Constructors
      ModifierConstructorDescription
      protected CuboidRegion() 
       CuboidRegion​(org.bukkit.Location start, - org.bukkit.Location end) +ModifierConstructorDescription
      protected CuboidRegion() 
       CuboidRegion​(org.bukkit.Location start, +org.bukkit.Location end)
      Construct a Region using 2 corners
      -
      • -
    +
    + -
    - + + +
    +

    Methods inherited from class redempt.redlib.region.Region

    +contains, disableEvents, enableEvents, getBlockDimensions, getCenter, getChunks, getCorners, getDimensions, getEntities, getEntities, getLoadedChunks, getPlayers, measure, measureBlocks, protect, protect, toCuboid
    +
    +

    Methods inherited from class java.lang.Object

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

          Field Detail

          - - - -
            -
          • -

            start

            -
            protected org.bukkit.Location start
            -
            • -
          - - - -
            -
          • -

            end

            -
            protected org.bukkit.Location end
            +
          • +
            +

            Field Details

            +
              +
            • +
              +

              start

              +
              protected org.bukkit.Location start
              +
              • -
            +
          • +
            +

            end

            +
            protected org.bukkit.Location end
            +
        + -
        -
          -
        • - - -

          Constructor Detail

          - - - -
            -
          • -

            CuboidRegion

            -
            public CuboidRegion​(org.bukkit.Location start,
-                    org.bukkit.Location end)
            +
          • +
            +

            Constructor Details

            +
              +
            • +
              +

              CuboidRegion

              +
              public CuboidRegion​(org.bukkit.Location start, +org.bukkit.Location end)
              Construct a Region using 2 corners
              -
              -
              Parameters:
              +
              +
              Parameters:
              start - The first corner
              end - The second corner
              +
              • -
            - - - -
              -
            • -

              CuboidRegion

              -
              protected CuboidRegion()
              -
              • -
            +
          • +
            +

            CuboidRegion

            +
            protected CuboidRegion()
            +
        + -
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            cubeRadius

            -
            public static CuboidRegion cubeRadius​(org.bukkit.Location loc,
-                                      int radius)
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              cubeRadius

              +
              public static CuboidRegion cubeRadius​(org.bukkit.Location loc, +int radius)
              Gets a Region covering a cubic radius centered around a Location
              -
              -
              Parameters:
              +
              +
              Parameters:
              loc - The center
              radius - The block radius
              -
              Returns:
              +
              Returns:
              A Region covering the specified radius
              +
              • -
            - - - -
              -
            • -

              setLocations

              -
              protected void setLocations​(org.bukkit.Location start,
-                            org.bukkit.Location end)
              +
            • +
              +

              setLocations

              +
              protected void setLocations​(org.bukkit.Location start, +org.bukkit.Location end)
              +
              • -
            - - - -
              -
            • -

              getStart

              -
              public org.bukkit.Location getStart()
              +
            • +
              +

              getStart

              +
              public org.bukkit.Location getStart()
              Get the minimum corner of this Region
              -
              -
              Specified by:
              +
              +
              Specified by:
              getStart in class Region
              -
              Returns:
              +
              Returns:
              The corner with the lowest X, Y, and Z values
              +
              • -
            - - - -
              -
            • -

              getEnd

              -
              public org.bukkit.Location getEnd()
              +
            • +
              +

              getEnd

              +
              public org.bukkit.Location getEnd()
              Get the maximum corner of this Region
              -
              -
              Specified by:
              +
              +
              Specified by:
              getEnd in class Region
              -
              Returns:
              +
              Returns:
              The corner with the highest X, Y, and Z values
              +
              • -
            - - - -
              -
            • -

              contains

              -
              public boolean contains​(org.bukkit.Location loc)
              +
            • +
              +

              contains

              +
              public boolean contains​(org.bukkit.Location loc)
              Check whether a location is inside this Region
              -
              -
              Specified by:
              +
              +
              Specified by:
              contains in class Region
              -
              Parameters:
              +
              Parameters:
              loc - The location to check
              -
              Returns:
              +
              Returns:
              Whether this Region contains the given Location
              +
              • -
            - - - -
              -
            • -

              getVolume

              -
              public double getVolume()
              -
              -
              Specified by:
              +
            • +
              +

              getVolume

              +
              public double getVolume()
              +
              +
              Specified by:
              getVolume in class Region
              -
              Returns:
              +
              Returns:
              The volume of this Region, in cubic meters
              +
              • -
            - - - -
              -
            • -

              getBlockVolume

              -
              public int getBlockVolume()
              -
              -
              Specified by:
              +
            • +
              +

              getBlockVolume

              +
              public int getBlockVolume()
              +
              +
              Specified by:
              getBlockVolume in class Region
              -
              Returns:
              +
              Returns:
              The volume of this Region, in blocks
              +
              • -
            - - - - - - - -
              -
            • -

              clone

              -
              public CuboidRegion clone()
              +
            • +
              +

              clone

              +
              public CuboidRegion clone()
              Clones this Region
              -
              -
              Specified by:
              +
              +
              Specified by:
              clone in class Region
              -
              Returns:
              +
              Returns:
              A clone of this Region
              +
              • -
            - - - -
              -
            • -

              expand

              -
              public CuboidRegion expand​(double amount)
              +
            • +
              +

              expand

              +
              public CuboidRegion expand​(double amount)
              Expands the region in all directions, or retracts if negative. If this is a MultiRegion, makes 6 calls to MultiRegion.expand(BlockFace, double), meaning it is very expensive. Check if this is a MultiRegion before expanding.
              -
              -
              Parameters:
              +
              +
              Parameters:
              amount - The amount to expand the region by
              -
              Returns:
              +
              Returns:
              Itself
              +
              • -
            - - - -
              -
            • -

              expand

              -
              public CuboidRegion expand​(double posX,
-                           double negX,
-                           double posY,
-                           double negY,
-                           double posZ,
-                           double negZ)
              +
            • +
              +

              expand

              +
              public CuboidRegion expand​(double posX, +double negX, +double posY, +double negY, +double posZ, +double negZ)
              Expands the region, or retracts where negative values are passed
              -
              -
              Specified by:
              +
              +
              Specified by:
              expand in class Region
              -
              Parameters:
              +
              Parameters:
              posX - The amount to expand the region in the positive X direction
              negX - The amount to expand the region in the negative X direction
              posY - The amount to expand the region in the positive Y direction
              negY - The amount to expand the region in the negative Y direction
              posZ - The amount to expand the region in the positive Z direction
              negZ - The amount to expand the region in the negative Z direction
              -
              Returns:
              +
              Returns:
              Itself
              +
              • -
            - - - -
              -
            • -

              expand

              -
              public CuboidRegion expand​(org.bukkit.block.BlockFace direction,
-                           double amount)
              +
            • +
              +

              expand

              +
              public CuboidRegion expand​(org.bukkit.block.BlockFace direction, +double amount)
              Expand the region in a given direction, or retracts if negative.
              -
              -
              Specified by:
              +
              +
              Specified by:
              expand in class Region
              -
              Parameters:
              +
              Parameters:
              direction - The direction to expand the region in
              amount - The amount to expand the region in the given direction
              -
              Returns:
              +
              Returns:
              Itself
              +
              • -
            - - - -
              -
            • -

              move

              -
              public CuboidRegion move​(org.bukkit.util.Vector v)
              +
            • +
              +

              move

              +
              public CuboidRegion move​(org.bukkit.util.Vector v)
              Move the region
              -
              -
              Specified by:
              +
              +
              Specified by:
              move in class Region
              -
              Parameters:
              +
              Parameters:
              v - The vector to be applied to both corners of the region
              -
              Returns:
              +
              Returns:
              Itself
              +
              • -
            - - - -
              -
            • -

              move

              -
              public CuboidRegion move​(double x,
-                         double y,
-                         double z)
              -
              -
              Specified by:
              +
            • +
              +

              move

              +
              public CuboidRegion move​(double x, +double y, +double z)
              +
              +
              Specified by:
              move in class Region
              +
              • -
            - - - -
              -
            • -

              setWorld

              -
              public CuboidRegion setWorld​(org.bukkit.World world)
              +
            • +
              +

              setWorld

              +
              public CuboidRegion setWorld​(org.bukkit.World world)
              Set the world of this region, while keeping the coordinates the same
              -
              -
              Specified by:
              +
              +
              Specified by:
              setWorld in class Region
              -
              Parameters:
              +
              Parameters:
              world - The world to set
              -
              Returns:
              +
              Returns:
              Itself
              +
              • -
            - - - -
              -
            • -

              isMulti

              -
              public boolean isMulti()
              -
              -
              Returns:
              +
            • +
              +

              isMulti

              +
              public boolean isMulti()
              +
              +
              Returns:
              Whether this Region is a non-cuboid variant
              +
              • -
            - - - -
              -
            • -

              forEachBlock

              -
              public void forEachBlock​(java.util.function.Consumer<org.bukkit.block.Block> lambda)
              +
            • +
              +

              forEachBlock

              +
              public void forEachBlock​(java.util.function.Consumer<org.bukkit.block.Block> lambda)
              Run a lambda on every Block in this Region
              -
              -
              Overrides:
              +
              +
              Overrides:
              forEachBlock in class Region
              -
              Parameters:
              +
              Parameters:
              lambda - The lambda to be run on each Block
              +
              • -
            - - - -
              -
            • -

              getWorld

              -
              public org.bukkit.World getWorld()
              -
              -
              Overrides:
              +
            • +
              +

              getWorld

              +
              public org.bukkit.World getWorld()
              +
              +
              Overrides:
              getWorld in class Region
              -
              Returns:
              +
              Returns:
              The World this Region is in
              +
              • -
            - - - -
              -
            • -

              overlaps

              -
              public boolean overlaps​(Overlappable overlap)
              +
            • +
              +

              overlaps

              +
              public boolean overlaps​(Overlappable overlap)
              Check if this Region overlaps with another.
              -
              -
              Specified by:
              +
              +
              Specified by:
              overlaps in interface Overlappable
              -
              Parameters:
              +
              Parameters:
              overlap - The Overlappable Region to check against
              -
              Returns:
              +
              Returns:
              Whether this Region overlaps with the given Region
              +
              • -
            - - - -
              -
            • -

              rotate

              -
              public CuboidRegion rotate​(org.bukkit.Location center,
-                           int rotations)
              +
            • +
              +

              rotate

              +
              public CuboidRegion rotate​(org.bukkit.Location center, +int rotations)
              Rotates this Region around a point
              -
              -
              Specified by:
              +
              +
              Specified by:
              rotate in class Region
              -
              Parameters:
              +
              Parameters:
              center - The point to rotate this Region around
              rotations - The number of clockwise rotations to apply
              -
              Returns:
              +
              Returns:
              Itself
              +
              • -
            - - - -
              -
            • -

              rotate

              -
              public CuboidRegion rotate​(int rotations)
              +
            • +
              +

              rotate

              +
              public CuboidRegion rotate​(int rotations)
              Rotates this Region around its center
              -
              -
              Parameters:
              +
              +
              Parameters:
              rotations - The number of clockwise rotations to apply
              -
              Returns:
              +
              Returns:
              Itself
              +
              • -
            - - - -
              -
            • -

              getIntersection

              -
              public Region getIntersection​(Overlappable overlap)
              +
            • +
              +

              getIntersection

              +
              public Region getIntersection​(Overlappable overlap)
              Gets the cuboid intersection of this Region and another cuboid Region
              -
              -
              Specified by:
              +
              +
              Specified by:
              getIntersection in interface Overlappable
              -
              Parameters:
              +
              Parameters:
              overlap - The Region to get the intersection with
              -
              Returns:
              +
              Returns:
              The intersection Region, or null if there is no intersection
              +
              • -
            - - - -
              -
            • -

              stream

              -
              public java.util.stream.Stream<org.bukkit.block.Block> stream()
              -
              Description copied from class: Region
              +
            • +
              +

              stream

              +
              public java.util.stream.Stream<org.bukkit.block.Block> stream()
              +
              Description copied from class: Region
              Streams all Blocks inside this Region
              -
              -
              Specified by:
              +
              +
              Specified by:
              stream in class Region
              -
              Returns:
              +
              Returns:
              A Stream of all the blocks in this Region
              +
              • -
            - - - -
              -
            • -

              getFace

              -
              public CuboidRegion getFace​(org.bukkit.block.BlockFace face)
              +
            • +
              +

              getFace

              +
              public CuboidRegion getFace​(org.bukkit.block.BlockFace face)
              Gets a CuboidRegion representing a 1-block thick slice on a face of this Region
              -
              -
              Parameters:
              +
              +
              Parameters:
              face - The face to get a slice of
              -
              Returns:
              +
              Returns:
              A CuboidRegion representing a slice of the given face
              +
              • -
            - - - -
              -
            • -

              toString

              -
              public java.lang.String toString()
              +
            • +
              +

              toString

              +
              public java.lang.String toString()
              Converts this Region to a String which can be converted back with fromString(String) later
              -
              -
              Overrides:
              +
              +
              Overrides:
              toString in class java.lang.Object
              -
              Returns:
              +
              Returns:
              The String representation of this Region
              +
              • -
            - - - -
              -
            • -

              fromString

              -
              public static CuboidRegion fromString​(java.lang.String input)
              +
            • +
              +

              fromString

              +
              public static CuboidRegion fromString​(java.lang.String input)
              Converts a String generated by toString() back to a Region
              -
              -
              Parameters:
              +
              +
              Parameters:
              input - The String representation of a Region
              -
              Returns:
              +
              Returns:
              The Region
              -
              • -
            +
      -
    - - + + + + diff --git a/javadoc/redempt/redlib/region/MultiRegion.html b/javadoc/redempt/redlib/region/MultiRegion.html index 31cd766..78815ce 100644 --- a/javadoc/redempt/redlib/region/MultiRegion.html +++ b/javadoc/redempt/redlib/region/MultiRegion.html @@ -5,992 +5,815 @@ MultiRegion (RedLib API) + + - + + - - - - - + + - - -
    +
    +
    + + + +
    - +
    +
    -
    Package redempt.redlib.region
    -

    Class MultiRegion

    +
    Package redempt.redlib.region
    +

    Class MultiRegion

    -
    - -
    -
      -
    • -
      +
      java.lang.Object +
      redempt.redlib.region.Region +
      redempt.redlib.region.MultiRegion
      +
      +
      +
      +
      All Implemented Interfaces:
      java.lang.Cloneable, Overlappable
      -
      public class MultiRegion
+
      public class MultiRegion
 extends Region
 implements Overlappable
      
 
      Represents a collection of Regions forming any shape
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Constructor Summary

          - - +
        • +
          +

          Constructor Summary

          +
          +
          • Constructors 
          + + - - - - - - + + + + + + + - - - + + +
          Constructors
          ConstructorDescription
          MultiRegion​(java.util.List<Region> regions) +ConstructorDescription
          MultiRegion​(java.util.List<Region> regions)
          Construct a MultiRegion using a list of Regions
          MultiRegion​(Region... regions) +
          MultiRegion​(Region... regions)
          Construct a MultiRegion using a vararg of Regions
          -
          • -
        +
    + -
    - +
    +
    +
    +

    Methods inherited from class redempt.redlib.region.Region

    +contains, disableEvents, enableEvents, forEachBlock, getBlockDimensions, getCenter, getChunks, getCorners, getDimensions, getEntities, getEntities, getLoadedChunks, getPlayers, getWorld, measure, measureBlocks, protect, protect, toCuboid
    +
    +

    Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - -
            -
          • -

            MultiRegion

            -
            public MultiRegion​(java.util.List<Region> regions)
            +
          • +
            +

            Constructor Details

            +
              +
            • +
              +

              MultiRegion

              +
              public MultiRegion​(java.util.List<Region> regions)
              Construct a MultiRegion using a list of Regions
              -
              -
              Parameters:
              +
              +
              Parameters:
              regions - The list of Regions
              +
              • -
            - - - -
              -
            • -

              MultiRegion

              -
              public MultiRegion​(Region... regions)
              +
            • +
              +

              MultiRegion

              +
              public MultiRegion​(Region... regions)
              Construct a MultiRegion using a vararg of Regions
              -
              -
              Parameters:
              +
              +
              Parameters:
              regions - The vararg of Regions
              -
              • -
            +
        + -
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            setLocations

            -
            protected void setLocations​(org.bukkit.Location start,
-                            org.bukkit.Location end)
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              setLocations

              +
              protected void setLocations​(org.bukkit.Location start, +org.bukkit.Location end)
              +
              • -
            - - - -
              -
            • -

              getStart

              -
              public org.bukkit.Location getStart()
              -
              -
              Specified by:
              +
            • +
              +

              getStart

              +
              public org.bukkit.Location getStart()
              +
              +
              Specified by:
              getStart in class Region
              -
              Returns:
              +
              Returns:
              The least extreme corner of the region, representing minimum X, Y, and Z coordinates
              +
              • -
            - - - -
              -
            • -

              getEnd

              -
              public org.bukkit.Location getEnd()
              -
              -
              Specified by:
              +
            • +
              +

              getEnd

              +
              public org.bukkit.Location getEnd()
              +
              +
              Specified by:
              getEnd in class Region
              -
              Returns:
              +
              Returns:
              The most extreme corner of the region, representing maximum X, Y, and Z coordinates
              +
              • -
            - - - -
              -
            • -

              add

              -
              public void add​(Region region)
              +
            • +
              +

              add

              +
              public void add​(Region region)
              Adds a Region to this MultiRegion
              -
              -
              Parameters:
              +
              +
              Parameters:
              region - The Overlappable Region to add
              -
              Throws:
              +
              Throws:
              java.lang.IllegalArgumentException - if the Region is not Overlappable or is in another world
              +
              • -
            - - - -
              -
            • -

              subtract

              -
              public void subtract​(Region region)
              +
            • +
              +

              subtract

              +
              public void subtract​(Region region)
              Subtracts a Region from this MultiRegion. A subtracted Region overrides all positive Regions, meaning adding a Region that overlaps a previously subtracted Region will not add the overlapping blocks. Calling recalculate() will coalesce into only added Regions.
              -
              -
              Parameters:
              +
              +
              Parameters:
              region - The Region to subtract
              +
              • -
            - - - -
              -
            • -

              contains

              -
              public boolean contains​(org.bukkit.Location location)
              +
            • +
              +

              contains

              +
              public boolean contains​(org.bukkit.Location location)
              Checks whether this MultiRegion contains the given Location
              -
              -
              Specified by:
              +
              +
              Specified by:
              contains in class Region
              -
              Parameters:
              +
              Parameters:
              location - The Location to check
              -
              Returns:
              +
              Returns:
              Whether the Location is contained within this MultiRegion
              +
              • -
            - - - -
              -
            • -

              getRegions

              -
              public java.util.List<Region> getRegions()
              +
            • +
              +

              getRegions

              +
              public java.util.List<Region> getRegions()
              Gets all the cuboid Regions that form this MultiRegion
              -
              -
              Returns:
              +
              +
              Returns:
              The list of Regions that form this MultiRegion
              +
              • -
            - - - -
              -
            • -

              getBlockVolume

              -
              public int getBlockVolume()
              +
            • +
              +

              getBlockVolume

              +
              public int getBlockVolume()
              Sums the block volume of all the Regions that make up this MultiRegion. Will be inaccurate if any of the Regions overlap. Call recalculate() first.
              -
              -
              Specified by:
              +
              +
              Specified by:
              getBlockVolume in class Region
              -
              Returns:
              +
              Returns:
              The volume of this MultiRegion
              +
              • -
            - - - -
              -
            • -

              getVolume

              -
              public double getVolume()
              +
            • +
              +

              getVolume

              +
              public double getVolume()
              Sums the volume of all the Regions that make up this MultiRegion. Will be inaccurate if any of the Regions overlap. Call recalculate() first.
              -
              -
              Specified by:
              +
              +
              Specified by:
              getVolume in class Region
              -
              Returns:
              +
              Returns:
              The volume of this MultiRegion
              +
              • -
            - - - -
              -
            • -

              clone

              -
              public MultiRegion clone()
              +
            • +
              +

              clone

              +
              public MultiRegion clone()
              Clones this MultiRegion
              -
              -
              Specified by:
              +
              +
              Specified by:
              clone in class Region
              -
              Returns:
              +
              Returns:
              A clone of this MultiRegion
              +
              • -
            - - - -
              -
            • -

              expand

              -
              public MultiRegion expand​(org.bukkit.block.BlockFace direction,
-                          double amount)
              +
            • +
              +

              expand

              +
              public MultiRegion expand​(org.bukkit.block.BlockFace direction, +double amount)
              Expands the MultiRegion in a given direction, or retracts if negative. Expanding takes a one-block wide slice on the face of the direction given, and duplicates it forward in that direction the given number of times. Retracting subtracts a region of n width in the direction given on the face of the direction. It is highly recommended to call recalculate() after calling this, especially if it is a retraction. This is a fairly expensive operation, so use it sparingly.
              -
              -
              Specified by:
              +
              +
              Specified by:
              expand in class Region
              -
              Parameters:
              +
              Parameters:
              direction - The direction to expand the region in
              amount - The amount to expand the region in the given direction
              -
              Returns:
              +
              Returns:
              Itself
              +
              • -
            - - - -
              -
            • -

              expand

              -
              public MultiRegion expand​(double posX,
-                          double negX,
-                          double posY,
-                          double negY,
-                          double posZ,
-                          double negZ)
              +
            • +
              +

              expand

              +
              public MultiRegion expand​(double posX, +double negX, +double posY, +double negY, +double posZ, +double negZ)
              Expands the region, or retracts if negative. This makes 6 calls to expand(BlockFace, double), meaning it is expensive. Avoid calling this method if possible.
              -
              -
              Specified by:
              +
              +
              Specified by:
              expand in class Region
              -
              Parameters:
              +
              Parameters:
              posX - The amount to expand the region in the positive X direction
              negX - The amount to expand the region in the negative X direction
              posY - The amount to expand the region in the positive Y direction
              negY - The amount to expand the region in the negative Y direction
              posZ - The amount to expand the region in the positive Z direction
              negZ - The amount to expand the region in the negative Z direction
              -
              Returns:
              +
              Returns:
              Itself
              +
              • -
            - - - -
              -
            • -

              autoCluster

              -
              public void autoCluster()
              +
            • +
              +

              autoCluster

              +
              public void autoCluster()
              automatically clusters regions in clusters of 10 until there are less than 25 top-level regions
              +
              • -
            - - - -
              -
            • -

              cluster

              -
              public void cluster​(int per)
              +
            • +
              +

              cluster

              +
              public void cluster​(int per)
              Smartly groups Regions in close proximity into clusters. Since contains(Location) first checks if the given Location is within the extreme corners of a MultiRegion, this will significantly increase the performance of contains(Location) for MultiRegions which contain many Regions by allowing it to skip having to check Region.contains(Location) on many nearby Regions. This method can be called multiple times, which will further cluster the clusters. It is recommended to use autoCluster() in most cases.
              -
              -
              Parameters:
              +
              +
              Parameters:
              per - The number of Regions that should be in each cluster
              +
              • -
            - - - -
              -
            • -

              decluster

              -
              public void decluster()
              +
            • +
              +

              decluster

              +
              public void decluster()
              Flattens any clusters in this MultiRegion so that it is composed only of cuboid Regions
              +
              • -
            - - - -
              -
            • -

              isClustered

              -
              public boolean isClustered()
              -
              -
              Returns:
              +
            • +
              +

              isClustered

              +
              public boolean isClustered()
              +
              +
              Returns:
              Whether this MultiRegion has been clustered into smaller Regions
              +
              • -
            - - - -
              -
            • -

              getRegionCount

              -
              public int getRegionCount()
              +
            • +
              +

              getRegionCount

              +
              public int getRegionCount()
              Recursively gets the number of Regions in this MultiRegion
              -
              -
              Returns:
              +
              +
              Returns:
              The total number of cuboid Regions composing this MultiRegion
              +
              • -
            - - - -
              -
            • -

              overlaps

              -
              public boolean overlaps​(Overlappable overlap)
              +
            • +
              +

              overlaps

              +
              public boolean overlaps​(Overlappable overlap)
              Check if this Region overlaps with another.
              -
              -
              Specified by:
              +
              +
              Specified by:
              overlaps in interface Overlappable
              -
              Parameters:
              +
              Parameters:
              overlap - The Region to check against
              -
              Returns:
              +
              Returns:
              Whether this Region overlaps with the given Region
              +
              • -
            - - - -
              -
            • -

              getIntersection

              -
              public MultiRegion getIntersection​(Overlappable other)
              +
            • +
              +

              getIntersection

              +
              public MultiRegion getIntersection​(Overlappable other)
              Gets a MultiRegion representing the overlap. This is somewhat expensive.
              -
              -
              Specified by:
              +
              +
              Specified by:
              getIntersection in interface Overlappable
              -
              Parameters:
              +
              Parameters:
              other - The Region to check for overlap with
              -
              Returns:
              +
              Returns:
              The overlapping portions of the Regions
              +
              • -
            - - - -
              -
            • -

              move

              -
              public MultiRegion move​(org.bukkit.util.Vector v)
              +
            • +
              +

              move

              +
              public MultiRegion move​(org.bukkit.util.Vector v)
              Moves this MultiRegion using the given vector
              -
              -
              Specified by:
              +
              +
              Specified by:
              move in class Region
              -
              Parameters:
              +
              Parameters:
              v - The vector to be applied to both corners of the region
              -
              Returns:
              +
              Returns:
              Itself
              +
              • -
            - - - -
              -
            • -

              move

              -
              public Region move​(double x,
-                   double y,
-                   double z)
              -
              -
              Specified by:
              +
            • +
              +

              move

              +
              public Region move​(double x, +double y, +double z)
              +
              +
              Specified by:
              move in class Region
              +
              • -
            - - - -
              -
            • -

              rotate

              -
              public MultiRegion rotate​(org.bukkit.Location center,
-                          int rotations)
              +
            • +
              +

              rotate

              +
              public MultiRegion rotate​(org.bukkit.Location center, +int rotations)
              Rotates this MultiRegion and all of its sub-regions around the given point
              -
              -
              Specified by:
              +
              +
              Specified by:
              rotate in class Region
              -
              Parameters:
              +
              Parameters:
              center - The point to rotate this Region around
              rotations - The number of clockwise rotations to apply
              -
              Returns:
              +
              Returns:
              Itself
              +
              • -
            - - - -
              -
            • -

              setWorld

              -
              public MultiRegion setWorld​(org.bukkit.World world)
              +
            • +
              +

              setWorld

              +
              public MultiRegion setWorld​(org.bukkit.World world)
              Sets the world of this MultiRegion and all of its sub-regions, while keeping the coordinates the same
              -
              -
              Specified by:
              +
              +
              Specified by:
              setWorld in class Region
              -
              Parameters:
              +
              Parameters:
              world - The world to set
              -
              Returns:
              +
              Returns:
              Itself
              +
              • -
            - - - -
              -
            • -

              recalculate

              -
              public void recalculate()
              +
            • +
              +

              recalculate

              +
              public void recalculate()
              Recalculates this region to ensure it is using close to the least possible number of sub-regions with no overlaps. This will coalesce the MultiRegion into only added Regions, but subtracted Regions will not be included in any of the Regions. Calling this method is somewhat expensive, but will make all other operations on this MultiRegion faster. After recalculating the regions, automatically clusters them in clusters of 10 until there are less than 25 top-level regions.
              +
              • -
            - - - -
              -
            • -

              recalculate

              -
              public void recalculate​(boolean autoCluster)
              +
            • +
              +

              recalculate

              +
              public void recalculate​(boolean autoCluster)
              Recalculates this region to ensure it is using close to the least possible number of sub-regions with no overlaps. This will coalesce the MultiRegion into only added Regions, but subtracted Regions will not be included in any of the Regions. Calling this method is somewhat expensive, but will make all other operations on this MultiRegion faster.
              -
              -
              Parameters:
              +
              +
              Parameters:
              autoCluster - Whether to automatically cluster regions in clusters of 10 until there are less than 25 top-level regions
              +
              • -
            - - - -
              -
            • -

              stream

              -
              public java.util.stream.Stream<org.bukkit.block.Block> stream()
              +
            • +
              +

              stream

              +
              public java.util.stream.Stream<org.bukkit.block.Block> stream()
              A Stream of all the blocks in all of the Regions within this MultiRegion. May iterate the same block multiple times if any of the Regions overlap. Call recalculate() first.
              -
              -
              Specified by:
              +
              +
              Specified by:
              stream in class Region
              -
              Returns:
              +
              Returns:
              A Stream of all the blocks in this MultiRegion
              +
              • -
            - - - -
              -
            • -

              toString

              -
              public java.lang.String toString()
              +
            • +
              +

              toString

              +
              public java.lang.String toString()
              Converts this MultiRegion to a String which can be converted back to a MultiRegion using fromString(String) Please use this to persist MultiRegions, as most of the operations for manipulating a MultiRegion are far more expensive than the same operations would be for a Region. If its shape is static, and it needs to be reused, save it.
              -
              -
              Overrides:
              +
              +
              Overrides:
              toString in class java.lang.Object
              -
              Returns:
              +
              Returns:
              The String representation of this MultiRegion
              +
              • -
            - - - -
              -
            • -

              fromString

              -
              public static MultiRegion fromString​(java.lang.String input)
              +
            • +
              +

              fromString

              +
              public static MultiRegion fromString​(java.lang.String input)
              Turns a String generated by toString() back into a MultiRegion
              -
              -
              Parameters:
              +
              +
              Parameters:
              input - The String representation of a MultiRegion
              -
              Returns:
              +
              Returns:
              The MultiRegion
              -
              • -
            +
      -
    - - + + + + diff --git a/javadoc/redempt/redlib/region/Overlappable.html b/javadoc/redempt/redlib/region/Overlappable.html index 28e7822..e48443b 100644 --- a/javadoc/redempt/redlib/region/Overlappable.html +++ b/javadoc/redempt/redlib/region/Overlappable.html @@ -5,280 +5,203 @@ Overlappable (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.region
    -

    Interface Overlappable

    +
    Package redempt.redlib.region
    +

    Interface Overlappable

    -
    -
    -
      -
    • -
      +
      +
      All Known Implementing Classes:
      CuboidRegion, MultiRegion
      -
      public interface Overlappable
      +
      public interface Overlappable
      Represents a Region which supports the overlap and intersect operations
      -
      • -
    -
    -
    -
    +
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            overlaps

            -
            boolean overlaps​(Overlappable other)
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              overlaps

              +
              boolean overlaps​(Overlappable other)
              Checks whether this Overlappable overlaps another Overlappable
              -
              -
              Parameters:
              +
              +
              Parameters:
              other - The Overlappable Region to check
              -
              Returns:
              +
              Returns:
              Whether this Overlappable overlaps the given Overlappable
              +
              • -
            - - - -
              -
            • -

              getIntersection

              -
              Region getIntersection​(Overlappable other)
              +
            • +
              +

              getIntersection

              +
              Region getIntersection​(Overlappable other)
              Gets the intersection of this Overlappable with another
              -
              -
              Parameters:
              +
              +
              Parameters:
              other - The Overlappable Region to check
              -
              Returns:
              +
              Returns:
              The intersection of this Region with the provided Overlappable Region
              -
              • -
            +
      -
    -
    - + + + + diff --git a/javadoc/redempt/redlib/region/Region.html b/javadoc/redempt/redlib/region/Region.html index 1fc03ef..a103955 100644 --- a/javadoc/redempt/redlib/region/Region.html +++ b/javadoc/redempt/redlib/region/Region.html @@ -5,973 +5,794 @@ Region (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.region
    -

    Class Region

    +
    Package redempt.redlib.region
    +

    Class Region

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.region.Region
        • -
      -
      • -
    -
    -
      -
    • -
      +
      java.lang.Object +
      redempt.redlib.region.Region
      +
      +
      +
      All Implemented Interfaces:
      java.lang.Cloneable
      -
      +
      Direct Known Subclasses:
      CuboidRegion, MultiRegion, SpheroidRegion
      -
      public abstract class Region
+
      public abstract class Region
 extends java.lang.Object
 implements java.lang.Cloneable
      
 
      Represents a region of an unspecified shape in the world
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Constructor Summary

          - - +
        • +
          +

          Constructor Summary

          +
          +
          • Constructors 
          + + - - + + - - - + + + + + +
          Constructors
          ConstructorDescriptionConstructorDescription
          Region() 
          Region() 
          -
          • -
        +
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Instance Methods Abstract Methods Concrete Methods 
      + - - - - - - - - - - - - - + + + + + + + + + + + + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + - - - - + + + + - - - - + + + - - - - + + + - - - - + + + + - - - - + + + - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + - - - - + + + - - - - - - - - - + + + + + + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + + +
      Modifier and TypeMethodDescription
      abstract Regionclone() 
      booleancontains​(org.bukkit.block.Block block) +Modifier and TypeMethodDescription
      abstract Regionclone() 
      booleancontains​(org.bukkit.block.Block block)
      Checks whether a Block is contained by this Region
      abstract booleancontains​(org.bukkit.Location loc) +
      abstract booleancontains​(org.bukkit.Location loc)
      Determines if this Region contains a Location
      voiddisableEvents() +
      voiddisableEvents()
      Disable RegionEnterEvent and RegionExitEvent for this region
      voidenableEvents() +
      voidenableEvents()
      Enable RegionEnterEvent and RegionExitEvent for this region
      abstract Regionexpand​(double posX, - double negX, - double posY, - double negY, - double posZ, - double negZ) +
      abstract Regionexpand​(double posX, +double negX, +double posY, +double negY, +double posZ, +double negZ)
      Expands this Region by a specified amount in each direction
      abstract Regionexpand​(org.bukkit.block.BlockFace face, - double amount) +
      abstract Regionexpand​(org.bukkit.block.BlockFace face, +double amount)
      Expands this Region in a specific direction
      voidforEachBlock​(java.util.function.Consumer<org.bukkit.block.Block> forEach) +
      voidforEachBlock​(java.util.function.Consumer<org.bukkit.block.Block> forEach)
      Streams every Block in this Region, running your lambda on it
      int[]getBlockDimensions() +
      int[]getBlockDimensions()
      Get the dimensions of this Region [x, y, z] in blocks
      abstract intgetBlockVolume() 
      org.bukkit.LocationgetCenter() 
      java.util.Set<org.bukkit.Chunk>getChunks() 
      org.bukkit.Location[]getCorners() 
      double[]getDimensions() +
      abstract intgetBlockVolume() 
      org.bukkit.LocationgetCenter() 
      java.util.Set<org.bukkit.Chunk>getChunks() 
      org.bukkit.Location[]getCorners() 
      double[]getDimensions()
      Get the dimensions of this Region [x, y, z]
      abstract org.bukkit.LocationgetEnd() 
      abstract org.bukkit.LocationgetEnd() 
      java.util.List<org.bukkit.entity.Entity>getEntities() +
      java.util.List<org.bukkit.entity.Entity>getEntities()
      Gets all entities contained in this Region in loaded chunks
      java.util.List<org.bukkit.entity.Entity>getEntities​(boolean load) +
      java.util.List<org.bukkit.entity.Entity>getEntities​(boolean load)
      Gets all entities contained in this Region
      java.util.Set<org.bukkit.Chunk>getLoadedChunks() 
      java.util.Set<org.bukkit.Chunk>getLoadedChunks() 
      java.util.List<org.bukkit.entity.Player>getPlayers() +
      java.util.List<org.bukkit.entity.Player>getPlayers()
      Gets all players contained in this Region
      abstract org.bukkit.LocationgetStart() 
      abstract doublegetVolume() 
      org.bukkit.WorldgetWorld() 
      doublemeasure​(org.bukkit.block.BlockFace direction) +
      abstract org.bukkit.LocationgetStart() 
      abstract doublegetVolume() 
      org.bukkit.WorldgetWorld() 
      doublemeasure​(org.bukkit.block.BlockFace direction)
      Gets the length of this Region along a given axis
      intmeasureBlocks​(org.bukkit.block.BlockFace direction) +
      intmeasureBlocks​(org.bukkit.block.BlockFace direction)
      Gets the block length of this Region along a given axis
      abstract Regionmove​(double x, - double y, - double z) 
      abstract Regionmove​(org.bukkit.util.Vector vec) +
      abstract Regionmove​(double x, +double y, +double z) 
      abstract Regionmove​(org.bukkit.util.Vector vec)
      Moves this Region
      ProtectedRegionprotect​(org.bukkit.plugin.Plugin plugin, - ProtectionPolicy.ProtectionType... types) +
      ProtectedRegionprotect​(org.bukkit.plugin.Plugin plugin, +ProtectionPolicy.ProtectionType... types)
      Protects this Region
      ProtectedRegionprotect​(ProtectionPolicy.ProtectionType... types) +
      ProtectedRegionprotect​(ProtectionPolicy.ProtectionType... types)
      Protects this Region
      abstract Regionrotate​(org.bukkit.Location center, - int rotations) +
      abstract Regionrotate​(org.bukkit.Location center, +int rotations)
      Rotates this Region around a central point
      abstract RegionsetWorld​(org.bukkit.World world) +
      abstract RegionsetWorld​(org.bukkit.World world)
      Sets the World of this Region
      abstract java.util.stream.Stream<org.bukkit.block.Block>stream() +
      abstract java.util.stream.Stream<org.bukkit.block.Block>stream()
      Streams all Blocks inside this Region
      CuboidRegiontoCuboid() 
      CuboidRegiontoCuboid() 
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

    Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - -
            -
          • -

            Region

            -
            public Region()
            -
            • -
          +
        • +
          +

          Constructor Details

          +
            +
          • +
            +

            Region

            +
            public Region()
            +
          +
          • -
          -
            -
          • - - -

            Method Detail

            - - - -
              -
            • -

              getStart

              -
              public abstract org.bukkit.Location getStart()
              -
              -
              Returns:
              +
            • +
              +

              Method Details

              +
                +
              • +
                +

                getStart

                +
                public abstract org.bukkit.Location getStart()
                +
                +
                Returns:
                The least extreme corner of this Region
                +
                • -
              - - - -
                -
              • -

                getEnd

                -
                public abstract org.bukkit.Location getEnd()
                -
                -
                Returns:
                +
              • +
                +

                getEnd

                +
                public abstract org.bukkit.Location getEnd()
                +
                +
                Returns:
                The most extreme corner of this Region
                +
                • -
              - - - -
                -
              • -

                getVolume

                -
                public abstract double getVolume()
                -
                -
                Returns:
                +
              • +
                +

                getVolume

                +
                public abstract double getVolume()
                +
                +
                Returns:
                The volume of this Region, in cubic meters
                +
                • -
              - - - -
                -
              • -

                getBlockVolume

                -
                public abstract int getBlockVolume()
                -
                -
                Returns:
                +
              • +
                +

                getBlockVolume

                +
                public abstract int getBlockVolume()
                +
                +
                Returns:
                The volume of this Region, in whole blocks
                +
                • -
              - - - -
                -
              • -

                expand

                -
                public abstract Region expand​(double posX,
-                              double negX,
-                              double posY,
-                              double negY,
-                              double posZ,
-                              double negZ)
                +
              • +
                +

                expand

                +
                public abstract Region expand​(double posX, +double negX, +double posY, +double negY, +double posZ, +double negZ)
                Expands this Region by a specified amount in each direction
                -
                -
                Parameters:
                +
                +
                Parameters:
                posX - The amount to increase in the positive X direction
                negX - The amount to increase in the negative X direction
                posY - The amount to increase in the positive Y direction
                negY - The amount to increase in the negative Y direction
                posZ - The amount to increase in the positive Z direction
                negZ - The amount to increase in the negative Z direction
                -
                Returns:
                +
                Returns:
                Itself
                +
                • -
              - - - -
                -
              • -

                expand

                -
                public abstract Region expand​(org.bukkit.block.BlockFace face,
-                              double amount)
                +
              • +
                +

                expand

                +
                public abstract Region expand​(org.bukkit.block.BlockFace face, +double amount)
                Expands this Region in a specific direction
                -
                -
                Parameters:
                +
                +
                Parameters:
                face - The BlockFace representing the direction to expand in
                amount - The amount to expand
                -
                Returns:
                +
                Returns:
                Itself
                +
                • -
              - - - -
                -
              • -

                move

                -
                public abstract Region move​(org.bukkit.util.Vector vec)
                +
              • +
                +

                move

                +
                public abstract Region move​(org.bukkit.util.Vector vec)
                Moves this Region
                -
                -
                Parameters:
                +
                +
                Parameters:
                vec - The vector representing the direction and amount to move
                -
                Returns:
                +
                Returns:
                Itself
                +
                • -
              - - - -
                -
              • -

                move

                -
                public abstract Region move​(double x,
-                            double y,
-                            double z)
                +
              • +
                +

                move

                +
                public abstract Region move​(double x, +double y, +double z)
                +
                • -
              - - - -
                -
              • -

                contains

                -
                public abstract boolean contains​(org.bukkit.Location loc)
                +
              • +
                +

                contains

                +
                public abstract boolean contains​(org.bukkit.Location loc)
                Determines if this Region contains a Location
                -
                -
                Parameters:
                +
                +
                Parameters:
                loc - The location to check
                -
                Returns:
                +
                Returns:
                Whether the location is contained by this Region
                +
                • -
              - - - -
                -
              • -

                clone

                -
                public abstract Region clone()
                -
                -
                Overrides:
                +
              • +
                +

                clone

                +
                public abstract Region clone()
                +
                +
                Overrides:
                clone in class java.lang.Object
                -
                Returns:
                +
                Returns:
                A clone of this Region
                +
                • -
              - - - -
                -
              • -

                rotate

                -
                public abstract Region rotate​(org.bukkit.Location center,
-                              int rotations)
                +
              • +
                +

                rotate

                +
                public abstract Region rotate​(org.bukkit.Location center, +int rotations)
                Rotates this Region around a central point
                -
                -
                Parameters:
                +
                +
                Parameters:
                center - The center of rotation
                rotations - The number of clockwise rotations
                -
                Returns:
                +
                Returns:
                Itself
                +
                • -
              - - - -
                -
              • -

                setWorld

                -
                public abstract Region setWorld​(org.bukkit.World world)
                +
              • +
                +

                setWorld

                +
                public abstract Region setWorld​(org.bukkit.World world)
                Sets the World of this Region
                -
                -
                Parameters:
                +
                +
                Parameters:
                world - The World
                -
                Returns:
                +
                Returns:
                Itself
                +
                • -
              - - - -
                -
              • -

                stream

                -
                public abstract java.util.stream.Stream<org.bukkit.block.Block> stream()
                +
              • +
                +

                stream

                +
                public abstract java.util.stream.Stream<org.bukkit.block.Block> stream()
                Streams all Blocks inside this Region
                -
                -
                Returns:
                +
                +
                Returns:
                The stream of all Blocks contained in this Region
                +
                • -
              - - - -
                -
              • -

                getChunks

                -
                public java.util.Set<org.bukkit.Chunk> getChunks()
                -
                -
                Returns:
                +
              • +
                +

                getChunks

                +
                public java.util.Set<org.bukkit.Chunk> getChunks()
                +
                +
                Returns:
                All the Chunks this Region overlaps
                +
                • -
              - - - -
                -
              • -

                contains

                -
                public boolean contains​(org.bukkit.block.Block block)
                +
              • +
                +

                contains

                +
                public boolean contains​(org.bukkit.block.Block block)
                Checks whether a Block is contained by this Region
                -
                -
                Parameters:
                +
                +
                Parameters:
                block - The Block
                -
                Returns:
                +
                Returns:
                Whether the Block is contained by this Region
                +
                • -
              - - - -
                -
              • -

                getLoadedChunks

                -
                public java.util.Set<org.bukkit.Chunk> getLoadedChunks()
                -
                -
                Returns:
                +
              • +
                +

                getLoadedChunks

                +
                public java.util.Set<org.bukkit.Chunk> getLoadedChunks()
                +
                +
                Returns:
                All the loaded Chunks this Region overlaps
                +
                • -
              - - - -
                -
              • -

                enableEvents

                -
                public void enableEvents()
                +
              • +
                +

                enableEvents

                +
                public void enableEvents()
                Enable RegionEnterEvent and RegionExitEvent for this region
                +
                • -
              - - - -
                -
              • -

                disableEvents

                -
                public void disableEvents()
                +
              • +
                +

                disableEvents

                +
                public void disableEvents()
                Disable RegionEnterEvent and RegionExitEvent for this region
                +
                • -
              - - - -
                -
              • -

                getPlayers

                -
                public java.util.List<org.bukkit.entity.Player> getPlayers()
                +
              • +
                +

                getPlayers

                +
                public java.util.List<org.bukkit.entity.Player> getPlayers()
                Gets all players contained in this Region
                -
                -
                Returns:
                +
                +
                Returns:
                The players in this Region
                +
                • -
              - - - -
                -
              • -

                getEntities

                -
                public java.util.List<org.bukkit.entity.Entity> getEntities()
                +
              • +
                +

                getEntities

                +
                public java.util.List<org.bukkit.entity.Entity> getEntities()
                Gets all entities contained in this Region in loaded chunks
                -
                -
                Returns:
                +
                +
                Returns:
                The entities in this Region
                +
                • -
              - - - -
                -
              • -

                getEntities

                -
                public java.util.List<org.bukkit.entity.Entity> getEntities​(boolean load)
                +
              • +
                +

                getEntities

                +
                public java.util.List<org.bukkit.entity.Entity> getEntities​(boolean load)
                Gets all entities contained in this Region
                -
                -
                Parameters:
                +
                +
                Parameters:
                load - Whether to load chunks to check the entities inside them
                -
                Returns:
                +
                Returns:
                The entities in this Region
                +
                • -
              - - - -
                -
              • -

                getWorld

                -
                public org.bukkit.World getWorld()
                -
                -
                Returns:
                +
              • +
                +

                getWorld

                +
                public org.bukkit.World getWorld()
                +
                +
                Returns:
                The World this Region is in
                +
                • -
              - - - -
                -
              • -

                forEachBlock

                -
                public void forEachBlock​(java.util.function.Consumer<org.bukkit.block.Block> forEach)
                +
              • +
                +

                forEachBlock

                +
                public void forEachBlock​(java.util.function.Consumer<org.bukkit.block.Block> forEach)
                Streams every Block in this Region, running your lambda on it
                -
                -
                Parameters:
                +
                +
                Parameters:
                forEach - What to run on each Block
                +
                • -
              - - - -
                -
              • -

                getBlockDimensions

                -
                public int[] getBlockDimensions()
                +
              • +
                +

                getBlockDimensions

                +
                public int[] getBlockDimensions()
                Get the dimensions of this Region [x, y, z] in blocks
                -
                -
                Returns:
                +
                +
                Returns:
                The dimensions of this Region
                +
                • -
              - - - -
                -
              • -

                getDimensions

                -
                public double[] getDimensions()
                +
              • +
                +

                getDimensions

                +
                public double[] getDimensions()
                Get the dimensions of this Region [x, y, z]
                -
                -
                Returns:
                +
                +
                Returns:
                The dimensions of this Region
                +
                • -
              - - - -
                -
              • -

                getCorners

                -
                public org.bukkit.Location[] getCorners()
                -
                -
                Returns:
                +
              • +
                +

                getCorners

                +
                public org.bukkit.Location[] getCorners()
                +
                +
                Returns:
                All 8 cuboid corners of this Region
                +
                • -
              - - - -
                -
              • -

                toCuboid

                -
                public CuboidRegion toCuboid()
                -
                -
                Returns:
                +
              • +
                +

                toCuboid

                +
                public CuboidRegion toCuboid()
                +
                +
                Returns:
                A cuboid representation of this Region using the extreme corners
                +
                • -
              - - - -
                -
              • -

                getCenter

                -
                public org.bukkit.Location getCenter()
                -
                -
                Returns:
                +
              • +
                +

                getCenter

                +
                public org.bukkit.Location getCenter()
                +
                +
                Returns:
                The center of this Region, the midpoint of the two extreme corners
                +
                • -
              - - - -
                -
              • -

                protect

                -
                public ProtectedRegion protect​(org.bukkit.plugin.Plugin plugin,
-                               ProtectionPolicy.ProtectionType... types)
                +
              • +
                +

                protect

                +
                public ProtectedRegion protect​(org.bukkit.plugin.Plugin plugin, +ProtectionPolicy.ProtectionType... types)
                Protects this Region
                -
                -
                Parameters:
                +
                +
                Parameters:
                plugin - The plugin registering the protection
                types - The ProtectionTypes to protect this Region with
                -
                Returns:
                +
                Returns:
                The ProtectedRegion using this Region and the given ProtectionTypes
                +
                • -
              - - - - - - - -
                -
              • -

                measure

                -
                public double measure​(org.bukkit.block.BlockFace direction)
                +
              • +
                +

                measure

                +
                public double measure​(org.bukkit.block.BlockFace direction)
                Gets the length of this Region along a given axis
                -
                -
                Parameters:
                +
                +
                Parameters:
                direction - The BlockFace representing the axis - opposites will act the same (i.e. UP, DOWN)
                -
                Returns:
                +
                Returns:
                The length of this Region along the given axis
                +
                • -
              - - - -
                -
              • -

                measureBlocks

                -
                public int measureBlocks​(org.bukkit.block.BlockFace direction)
                +
              • +
                +

                measureBlocks

                +
                public int measureBlocks​(org.bukkit.block.BlockFace direction)
                Gets the block length of this Region along a given axis
                -
                -
                Parameters:
                +
                +
                Parameters:
                direction - The BlockFace representing the axis - opposites will act the same (i.e. UP, DOWN)
                -
                Returns:
                +
                Returns:
                The block length of this Region along the given axis
                -
                • -
              +
        -
    - - + + + + diff --git a/javadoc/redempt/redlib/region/RegionEnterExitListener.html b/javadoc/redempt/redlib/region/RegionEnterExitListener.html index 8be87bd..c83cd8b 100644 --- a/javadoc/redempt/redlib/region/RegionEnterExitListener.html +++ b/javadoc/redempt/redlib/region/RegionEnterExitListener.html @@ -5,317 +5,228 @@ RegionEnterExitListener (RedLib API) + + - + + - - - - - + + - - -
    +
    +
    + + + +
    - +
    +
    -
    Package redempt.redlib.region
    -

    Class RegionEnterExitListener

    +
    Package redempt.redlib.region
    +

    Class RegionEnterExitListener

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.region.RegionEnterExitListener
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      redempt.redlib.region.RegionEnterExitListener
      +
      +
      -
      public class RegionEnterExitListener
+
      public class RegionEnterExitListener
 extends java.lang.Object
      
-
      • -
    -
    -
    -
    + -
    - +
    +
    +
    +

    Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - -
            -
          • -

            RegionEnterExitListener

            -
            public RegionEnterExitListener()
            -
            • -
          +
        • +
          +

          Constructor Details

          +
            +
          • +
            +

            RegionEnterExitListener

            +
            public RegionEnterExitListener()
            +
          +
          • -
          -
            -
          • - - -

            Method Detail

            - - - -
              -
            • -

              register

              -
              public static void register()
              +
            • +
              +

              Method Details

              +
                +
              • +
                +

                register

                +
                public static void register()
                Registers the listener which calls RegionEnterEvent and RegionExitEvent. Called automatically by RedLib upon enabling.
                +
                • -
              - - - - +
            • +
              +

              getRegionMap

              +
              protected static RegionMap<Region> getRegionMap()
              +
        -
    - - + + + + diff --git a/javadoc/redempt/redlib/region/RegionMap.html b/javadoc/redempt/redlib/region/RegionMap.html index 6a9c463..ed79177 100644 --- a/javadoc/redempt/redlib/region/RegionMap.html +++ b/javadoc/redempt/redlib/region/RegionMap.html @@ -5,523 +5,402 @@ RegionMap (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.region
    -

    Class RegionMap<T>

    +
    Package redempt.redlib.region
    +

    Class RegionMap<T>

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.region.RegionMap<T>
        • -
      -
      • -
    -
    -
      -
    • -
      -
      Type Parameters:
      +
      java.lang.Object +
      redempt.redlib.region.RegionMap<T>
      +
      +
      +
      +
      Type Parameters:
      T - The type mapped by this RegionMap
      -
      public class RegionMap<T>
+
      public class RegionMap<T>
 extends java.lang.Object
      
 
      Represents a spatial mapping which can retrieve objects by approximate location in O(1)
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Constructor Summary

          - - +
        • +
          +

          Constructor Summary

          +
          +
          • Constructors 
          + + - - + + - - - + + + + - - - + + +
          Constructors
          ConstructorDescriptionConstructorDescription
          RegionMap() +
          RegionMap()
          Constructs a RegionMap with scale 100
          RegionMap​(int scale) +
          RegionMap​(int scale)
          Constructs a RegionMap with the specified scale
          -
          • -
        +
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Instance Methods Concrete Methods 
      + - - - + + + - - - - + + + + + - - - - + + + - - - - + + + + - - - - + + + - - - - + + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + +
      Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
      voidclear() +
      voidclear()
      Clears all data from this RegionMap
      java.util.Set<T>get​(org.bukkit.Location location) +
      java.util.Set<T>get​(org.bukkit.Location location)
      Gets all objects mapped to an approximate location
      java.util.Set<T>getAll() 
      java.util.Set<T>getAll() 
      java.util.Set<T>getNearby​(org.bukkit.Location location, - int radius) +
      java.util.Set<T>getNearby​(org.bukkit.Location location, +int radius)
      Gets all objects mapped near the given location
      intgetScale() 
      intgetScale() 
      voidremove​(org.bukkit.Location loc, - T object) +
      voidremove​(org.bukkit.Location loc, +T object)
      Removes a mapping by location
      voidremove​(CuboidRegion region, - T object) +
      voidremove​(CuboidRegion region, +T object)
      Removes a mapping by region
      voidset​(org.bukkit.Location loc, - T object) +
      voidset​(org.bukkit.Location loc, +T object)
      Maps a Location to an object
      voidset​(CuboidRegion region, - T object) +
      voidset​(CuboidRegion region, +T object)
      Maps a Region to an object
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

    Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - -
            -
          • -

            RegionMap

            -
            public RegionMap()
            +
          • +
            +

            Constructor Details

            +
              +
            • +
              +

              RegionMap

              +
              public RegionMap()
              Constructs a RegionMap with scale 100
              +
              • -
            - - - -
              -
            • -

              RegionMap

              -
              public RegionMap​(int scale)
              +
            • +
              +

              RegionMap

              +
              public RegionMap​(int scale)
              Constructs a RegionMap with the specified scale
              -
              -
              Parameters:
              +
              +
              Parameters:
              scale - The distance between things being stored in the internal map. Higher values use less memory but more CPU time. If the regions being used to store objects in this RegionMap are especially large, use a larger scale. If they are very small and there are a lot of them, use a smaller scale.
              -
              • -
            +
        + -
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            getScale

            -
            public int getScale()
            -
            -
            Returns:
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              getScale

              +
              public int getScale()
              +
              +
              Returns:
              The scale of this RegionMap
              +
              • -
            - - - - - -
              -
            • -

              set

              -
              public void set​(CuboidRegion region,
-                T object)
              +
            • +
              +

              set

              +
              public void set​(CuboidRegion region, +T object)
              Maps a Region to an object
              -
              -
              Parameters:
              +
              +
              Parameters:
              region - The Region to map the object to
              object - The object to set
              +
              • -
            - - - - - -
              -
            • -

              set

              -
              public void set​(org.bukkit.Location loc,
-                T object)
              +
            • +
              +

              set

              +
              public void set​(org.bukkit.Location loc, +T object)
              Maps a Location to an object
              -
              -
              Parameters:
              +
              +
              Parameters:
              loc - The location to map the object to
              object - The object to put at this approximate location
              +
              • -
            - - - - - -
              -
            • -

              remove

              -
              public void remove​(CuboidRegion region,
-                   T object)
              +
            • +
              +

              remove

              +
              public void remove​(CuboidRegion region, +T object)
              Removes a mapping by region
              -
              -
              Parameters:
              +
              +
              Parameters:
              region - The region to remove the mapping from
              object - The object to remove
              +
              • -
            - - - - - -
              -
            • -

              remove

              -
              public void remove​(org.bukkit.Location loc,
-                   T object)
              +
            • +
              +

              remove

              +
              public void remove​(org.bukkit.Location loc, +T object)
              Removes a mapping by location
              -
              -
              Parameters:
              +
              +
              Parameters:
              loc - The location to remove the mapping from
              object - The object to remove
              +
              • -
            - - - -
              -
            • -

              get

              -
              public java.util.Set<T> get​(org.bukkit.Location location)
              +
            • +
              +

              get

              +
              public java.util.Set<T> get​(org.bukkit.Location location)
              Gets all objects mapped to an approximate location
              -
              -
              Parameters:
              +
              +
              Parameters:
              location - The location to check nearby objects for
              -
              Returns:
              +
              Returns:
              A set of objects mapped near the given location
              +
              • -
            - - - -
              -
            • -

              getNearby

              -
              public java.util.Set<T> getNearby​(org.bukkit.Location location,
-                                  int radius)
              +
            • +
              +

              getNearby

              +
              public java.util.Set<T> getNearby​(org.bukkit.Location location, +int radius)
              Gets all objects mapped near the given location
              -
              -
              Parameters:
              +
              +
              Parameters:
              location - The location to check centered on
              radius - The radius to check
              -
              Returns:
              +
              Returns:
              A set of all objects mapped near the given location Note: The radius is not exact, no distance checks are made. Make sure you do your own distance checks if needed.
              +
              • -
            - - - -
              -
            • -

              getAll

              -
              public java.util.Set<T> getAll()
              -
              -
              Returns:
              +
            • +
              +

              getAll

              +
              public java.util.Set<T> getAll()
              +
              +
              Returns:
              All objects mapped with this RegionMap
              +
              • -
            - - - -
              -
            • -

              clear

              -
              public void clear()
              +
            • +
              +

              clear

              +
              public void clear()
              Clears all data from this RegionMap
              -
              • -
            +
      -
    - - + + + + diff --git a/javadoc/redempt/redlib/region/RegionUtils.html b/javadoc/redempt/redlib/region/RegionUtils.html index 9518b29..86ae2e7 100644 --- a/javadoc/redempt/redlib/region/RegionUtils.html +++ b/javadoc/redempt/redlib/region/RegionUtils.html @@ -5,311 +5,225 @@ RegionUtils (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.region
    -

    Class RegionUtils

    +
    Package redempt.redlib.region
    +

    Class RegionUtils

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.region.RegionUtils
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      redempt.redlib.region.RegionUtils
      +
      +
      -
      public class RegionUtils
+
      public class RegionUtils
 extends java.lang.Object
      
 
      Utilities for niche use cases of Regions
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Constructor Summary

          - - +
        • +
          +

          Constructor Summary

          +
          +
          • Constructors 
          + + - - + + - - - + + + + + +
          Constructors
          ConstructorDescriptionConstructorDescription
          RegionUtils() 
          RegionUtils() 
          -
          • -
        +
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Static Methods Concrete Methods 
      + - - - + + + - - - - + + + + + +
      Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
      static MultiRegionfindInside​(CuboidRegion region) +
      static MultiRegionfindInside​(CuboidRegion region)
      Finds the spaces within a Region that can be considered "inside" - space that is surrounded by other blocks
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

    Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - -
            -
          • -

            RegionUtils

            -
            public RegionUtils()
            -
            • -
          +
        • +
          +

          Constructor Details

          +
            +
          • +
            +

            RegionUtils

            +
            public RegionUtils()
            +
          +
          • -
          -
            -
          • - - -

            Method Detail

            - - - -
              -
            • -

              findInside

              -
              public static MultiRegion findInside​(CuboidRegion region)
              +
            • +
              +

              Method Details

              +
                +
              • +
                +

                findInside

                +
                public static MultiRegion findInside​(CuboidRegion region)
                Finds the spaces within a Region that can be considered "inside" - space that is surrounded by other blocks
                -
                -
                Parameters:
                +
                +
                Parameters:
                region - The region to find the interior space of
                -
                Returns:
                +
                Returns:
                A MultiRegion representing all of the "inside" space within the given region
                -
                • -
              +
        -
    - - + + + + diff --git a/javadoc/redempt/redlib/region/SelectionTool.html b/javadoc/redempt/redlib/region/SelectionTool.html index 7c70c10..906c099 100644 --- a/javadoc/redempt/redlib/region/SelectionTool.html +++ b/javadoc/redempt/redlib/region/SelectionTool.html @@ -5,416 +5,315 @@ SelectionTool (RedLib API) + + - + + - - - - - + + - - -
    +
    +
    + + + +
    - +
    +
    -
    Package redempt.redlib.region
    -

    Class SelectionTool

    +
    Package redempt.redlib.region
    +

    Class SelectionTool

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.region.SelectionTool
        • -
      -
      • -
    -
    -
      -
    • -
      +
      java.lang.Object +
      redempt.redlib.region.SelectionTool
      +
      +
      +
      All Implemented Interfaces:
      org.bukkit.event.Listener
      -
      public class SelectionTool
+
      public class SelectionTool
 extends java.lang.Object
 implements org.bukkit.event.Listener
      
 
      A tool which can be given to players and used to select a Region, or just any two points
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Constructor Summary

          - - +
        • +
          +

          Constructor Summary

          +
          +
          • Constructors 
          + + - - + + - - - + + + + +
          Constructors
          ConstructorDescriptionConstructorDescription
          SelectionTool​(org.bukkit.inventory.ItemStack item) +
          SelectionTool​(org.bukkit.inventory.ItemStack item)
          Create a SelectionTool with the given item
          -
          • -
        +
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Instance Methods Concrete Methods 
      + - - - + + + - - - - + + + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + + - - - - + + + + +
      Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
      org.bukkit.inventory.ItemStackgetItem() +
      org.bukkit.inventory.ItemStackgetItem()
      Gets the item used by this SelectionTool
      org.bukkit.Location[]getLocations​(java.util.UUID uuid) +
      org.bukkit.Location[]getLocations​(java.util.UUID uuid)
      Get the locations selected by the given player
      java.util.List<org.bukkit.Location>getPath​(java.util.UUID uuid) +
      java.util.List<org.bukkit.Location>getPath​(java.util.UUID uuid)
      Creates a path of Locations, one block apart, based on the locations selected by the player
      CuboidRegiongetRegion​(java.util.UUID uuid) +
      CuboidRegiongetRegion​(java.util.UUID uuid)
      Creates and returns a Region based on the locations selected by the player
      voidonClick​(org.bukkit.event.player.PlayerInteractEvent e) 
      voidonClick​(org.bukkit.event.player.PlayerInteractEvent e) 
      voidonPluginDisable​(org.bukkit.event.server.PluginDisableEvent e) 
      voidonPluginDisable​(org.bukkit.event.server.PluginDisableEvent e) 
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

    Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - -
            -
          • -

            SelectionTool

            -
            public SelectionTool​(org.bukkit.inventory.ItemStack item)
            +
          • +
            +

            Constructor Details

            +
              +
            • +
              +

              SelectionTool

              +
              public SelectionTool​(org.bukkit.inventory.ItemStack item)
              Create a SelectionTool with the given item
              -
              -
              Parameters:
              +
              +
              Parameters:
              item - The item to use
              -
              • -
            +
        + -
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            onPluginDisable

            -
            public void onPluginDisable​(org.bukkit.event.server.PluginDisableEvent e)
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              onPluginDisable

              +
              public void onPluginDisable​(org.bukkit.event.server.PluginDisableEvent e)
              +
              • -
            - - - -
              -
            • -

              onClick

              -
              public void onClick​(org.bukkit.event.player.PlayerInteractEvent e)
              +
            • +
              +

              onClick

              +
              public void onClick​(org.bukkit.event.player.PlayerInteractEvent e)
              +
              • -
            - - - -
              -
            • -

              getItem

              -
              public org.bukkit.inventory.ItemStack getItem()
              +
            • +
              +

              getItem

              +
              public org.bukkit.inventory.ItemStack getItem()
              Gets the item used by this SelectionTool
              -
              -
              Returns:
              +
              +
              Returns:
              The item
              +
              • -
            - - - -
              -
            • -

              getLocations

              -
              public org.bukkit.Location[] getLocations​(java.util.UUID uuid)
              +
            • +
              +

              getLocations

              +
              public org.bukkit.Location[] getLocations​(java.util.UUID uuid)
              Get the locations selected by the given player
              -
              -
              Parameters:
              +
              +
              Parameters:
              uuid - The UUID of the player
              -
              Returns:
              +
              Returns:
              The locations selected by the given player
              +
              • -
            - - - -
              -
            • -

              getRegion

              -
              public CuboidRegion getRegion​(java.util.UUID uuid)
              +
            • +
              +

              getRegion

              +
              public CuboidRegion getRegion​(java.util.UUID uuid)
              Creates and returns a Region based on the locations selected by the player
              -
              -
              Parameters:
              +
              +
              Parameters:
              uuid - The UUID of the player
              -
              Returns:
              +
              Returns:
              The Region selected by the player, or null if the player has not selected 2 locations
              +
              • -
            - - - -
              -
            • -

              getPath

              -
              public java.util.List<org.bukkit.Location> getPath​(java.util.UUID uuid)
              +
            • +
              +

              getPath

              +
              public java.util.List<org.bukkit.Location> getPath​(java.util.UUID uuid)
              Creates a path of Locations, one block apart, based on the locations selected by the player
              -
              -
              Parameters:
              +
              +
              Parameters:
              uuid - The UUID of the player
              -
              Returns:
              +
              Returns:
              The Path selected by the player, or null if the player has not selected 2 locations
              -
              • -
            +
      -
    - - + + + + diff --git a/javadoc/redempt/redlib/region/SpheroidRegion.html b/javadoc/redempt/redlib/region/SpheroidRegion.html index c39154b..2ea08bd 100644 --- a/javadoc/redempt/redlib/region/SpheroidRegion.html +++ b/javadoc/redempt/redlib/region/SpheroidRegion.html @@ -5,1025 +5,842 @@ SpheroidRegion (RedLib API) + + - + + - - - - - + + - - -
    +
    +
    + + + +
    - +
    +
    -
    Package redempt.redlib.region
    -

    Class SpheroidRegion

    +
    Package redempt.redlib.region
    +

    Class SpheroidRegion

    -
    - -
    -
      -
    • -
      +
      java.lang.Object +
      redempt.redlib.region.Region +
      redempt.redlib.region.SpheroidRegion
      +
      +
      +
      +
      All Implemented Interfaces:
      java.lang.Cloneable
      -
      public class SpheroidRegion
+
      public class SpheroidRegion
 extends Region
      
 
      Represents a spheroid region in a world
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Constructor Summary

          - - +
        • +
          +

          Constructor Summary

          +
          +
          • Constructors 
          + + - - - - - - + + + + + + + - - - + + - - - + + +
          Constructors
          ConstructorDescription
          SpheroidRegion​(org.bukkit.Location center, - double radius) +ConstructorDescription
          SpheroidRegion​(org.bukkit.Location center, +double radius)
          Creates a SpheroidRegion from a center and a radius
          SpheroidRegion​(org.bukkit.Location center, - double xRad, - double yRad, - double zRad) +
          SpheroidRegion​(org.bukkit.Location center, +double xRad, +double yRad, +double zRad)
          Creates a SpheroidRegion from a center and a radius in each direction
          SpheroidRegion​(org.bukkit.Location start, - org.bukkit.Location end) +
          SpheroidRegion​(org.bukkit.Location start, +org.bukkit.Location end)
          Creates a SpheroidRegion from two corners, using their midpoint as the center and their distance in each direction as the radius on each axis
          -
          • -
        +
    + -
    - +
    +
    +
    +

    Methods inherited from class redempt.redlib.region.Region

    +contains, disableEvents, enableEvents, forEachBlock, getBlockDimensions, getChunks, getCorners, getDimensions, getEntities, getEntities, getLoadedChunks, getPlayers, measure, measureBlocks, protect, protect
    +
    +

    Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - -
            -
          • -

            SpheroidRegion

            -
            public SpheroidRegion​(org.bukkit.Location start,
-                      org.bukkit.Location end)
            +
          • +
            +

            Constructor Details

            +
              +
            • +
              +

              SpheroidRegion

              +
              public SpheroidRegion​(org.bukkit.Location start, +org.bukkit.Location end)
              Creates a SpheroidRegion from two corners, using their midpoint as the center and their distance in each direction as the radius on each axis
              -
              -
              Parameters:
              +
              +
              Parameters:
              start - The first corner
              end - The second corner
              -
              Throws:
              +
              Throws:
              java.lang.IllegalArgumentException - if the Locations are not in the same world
              +
              • -
            - - - -
              -
            • -

              SpheroidRegion

              -
              public SpheroidRegion​(org.bukkit.Location center,
-                      double xRad,
-                      double yRad,
-                      double zRad)
              +
            • +
              +

              SpheroidRegion

              +
              public SpheroidRegion​(org.bukkit.Location center, +double xRad, +double yRad, +double zRad)
              Creates a SpheroidRegion from a center and a radius in each direction
              -
              -
              Parameters:
              +
              +
              Parameters:
              center - The center
              xRad - The radius on the X axis
              yRad - The radius on the Y axis
              zRad - The radius on the Z axis
              +
              • -
            - - - -
              -
            • -

              SpheroidRegion

              -
              public SpheroidRegion​(org.bukkit.Location center,
-                      double radius)
              +
            • +
              +

              SpheroidRegion

              +
              public SpheroidRegion​(org.bukkit.Location center, +double radius)
              Creates a SpheroidRegion from a center and a radius
              -
              -
              Parameters:
              +
              +
              Parameters:
              center - The center
              radius - The radius
              -
              • -
            +
        + -
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            getVolume

            -
            public double getVolume()
            -
            -
            Specified by:
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              getVolume

              +
              public double getVolume()
              +
              +
              Specified by:
              getVolume in class Region
              -
              Returns:
              +
              Returns:
              The volume of this SpheroidRegion
              +
              • -
            - - - -
              -
            • -

              getBlockVolume

              -
              public int getBlockVolume()
              -
              -
              Specified by:
              +
            • +
              +

              getBlockVolume

              +
              public int getBlockVolume()
              +
              +
              Specified by:
              getBlockVolume in class Region
              -
              Returns:
              +
              Returns:
              The *approximate* block volume of this SpheroidRegion
              +
              • -
            - - - -
              -
            • -

              expand

              -
              public SpheroidRegion expand​(double posX,
-                             double negX,
-                             double posY,
-                             double negY,
-                             double posZ,
-                             double negZ)
              +
            • +
              +

              expand

              +
              public SpheroidRegion expand​(double posX, +double negX, +double posY, +double negY, +double posZ, +double negZ)
              Expands this SpheroidRegion in all directions
              -
              -
              Specified by:
              +
              +
              Specified by:
              expand in class Region
              -
              Parameters:
              +
              Parameters:
              posX - The amount to increase in the positive X direction
              negX - The amount to increase in the negative X direction
              posY - The amount to increase in the positive Y direction
              negY - The amount to increase in the negative Y direction
              posZ - The amount to increase in the positive Z direction
              negZ - The amount to increase in the negative Z direction
              -
              Returns:
              +
              Returns:
              Itself
              +
              • -
            - - - -
              -
            • -

              expand

              -
              public SpheroidRegion expand​(org.bukkit.block.BlockFace face,
-                             double amount)
              +
            • +
              +

              expand

              +
              public SpheroidRegion expand​(org.bukkit.block.BlockFace face, +double amount)
              Expands this SpheroidRegion in a specific direction
              -
              -
              Specified by:
              +
              +
              Specified by:
              expand in class Region
              -
              Parameters:
              +
              Parameters:
              face - The BlockFace representing the direction to expand in
              amount - The amount to expand
              -
              Returns:
              +
              Returns:
              Itself
              +
              • -
            - - - -
              -
            • -

              expand

              -
              public SpheroidRegion expand​(double amount)
              +
            • +
              +

              expand

              +
              public SpheroidRegion expand​(double amount)
              Expands this SpheroidRegion in all directions
              -
              -
              Parameters:
              +
              +
              Parameters:
              amount - The amount to expand by in all directions
              -
              Returns:
              +
              Returns:
              Itself
              +
              • -
            - - - -
              -
            • -

              move

              -
              public SpheroidRegion move​(org.bukkit.util.Vector vec)
              +
            • +
              +

              move

              +
              public SpheroidRegion move​(org.bukkit.util.Vector vec)
              Moves this SpheroidRegion according to a Vector
              -
              -
              Specified by:
              +
              +
              Specified by:
              move in class Region
              -
              Parameters:
              +
              Parameters:
              vec - The vector representing the direction and amount to move
              -
              Returns:
              +
              Returns:
              Itself
              +
              • -
            - - - -
              -
            • -

              move

              -
              public SpheroidRegion move​(double x,
-                           double y,
-                           double z)
              +
            • +
              +

              move

              +
              public SpheroidRegion move​(double x, +double y, +double z)
              Moves this SpheroidRegion
              -
              -
              Specified by:
              +
              +
              Specified by:
              move in class Region
              -
              Parameters:
              +
              Parameters:
              x - The amount to move this SpheroidRegion on the X axis
              y - The amount to move this SpheroidRegion on the Y axis
              z - The amount to move this SpheroidRegion on the Z axis
              -
              Returns:
              +
              Returns:
              Itself
              +
              • -
            - - - -
              -
            • -

              contains

              -
              public boolean contains​(org.bukkit.Location loc)
              +
            • +
              +

              contains

              +
              public boolean contains​(org.bukkit.Location loc)
              Checks if this SpheroidRegion contains a given point
              -
              -
              Specified by:
              +
              +
              Specified by:
              contains in class Region
              -
              Parameters:
              +
              Parameters:
              loc - The location to check
              -
              Returns:
              +
              Returns:
              Whether this SpheroidRegion contains the given Location
              +
              • -
            - - - -
              -
            • -

              isSphere

              -
              public boolean isSphere()
              -
              -
              Returns:
              +
            • +
              +

              isSphere

              +
              public boolean isSphere()
              +
              +
              Returns:
              True if the radius in all directions of this SpheroidRegion are the same
              +
              • -
            - - - -
              -
            • -

              clone

              -
              public SpheroidRegion clone()
              -
              -
              Specified by:
              +
            • +
              +

              clone

              +
              public SpheroidRegion clone()
              +
              +
              Specified by:
              clone in class Region
              -
              Returns:
              +
              Returns:
              A clone of this SpheroidRegion
              +
              • -
            - - - -
              -
            • -

              rotate

              -
              public SpheroidRegion rotate​(org.bukkit.Location center,
-                             int rotations)
              +
            • +
              +

              rotate

              +
              public SpheroidRegion rotate​(org.bukkit.Location center, +int rotations)
              Rotates this SpheroidRegion
              -
              -
              Specified by:
              +
              +
              Specified by:
              rotate in class Region
              -
              Parameters:
              +
              Parameters:
              center - The center of rotation
              rotations - The number of clockwise rotations
              -
              Returns:
              +
              Returns:
              Itself
              +
              • -
            - - - -
              -
            • -

              setWorld

              -
              public SpheroidRegion setWorld​(org.bukkit.World world)
              +
            • +
              +

              setWorld

              +
              public SpheroidRegion setWorld​(org.bukkit.World world)
              Sets the world of this SpheroidRegion
              -
              -
              Specified by:
              +
              +
              Specified by:
              setWorld in class Region
              -
              Parameters:
              +
              Parameters:
              world - The World
              -
              Returns:
              +
              Returns:
              Itself
              +
              • -
            - - - -
              -
            • -

              stream

              -
              public java.util.stream.Stream<org.bukkit.block.Block> stream()
              -
              Description copied from class: Region
              +
            • +
              +

              stream

              +
              public java.util.stream.Stream<org.bukkit.block.Block> stream()
              +
              Description copied from class: Region
              Streams all Blocks inside this Region
              -
              -
              Specified by:
              +
              +
              Specified by:
              stream in class Region
              -
              Returns:
              +
              Returns:
              A stream of all Blocks contained by this SpheroidRegion
              +
              • -
            - - - -
              -
            • -

              toCuboid

              -
              public CuboidRegion toCuboid()
              -
              -
              Overrides:
              +
            • +
              +

              toCuboid

              +
              public CuboidRegion toCuboid()
              +
              +
              Overrides:
              toCuboid in class Region
              -
              Returns:
              +
              Returns:
              A cuboid representation of this SpheroidRegion using the extreme corners
              +
              • -
            - - - -
              -
            • -

              getXRadius

              -
              public double getXRadius()
              -
              -
              Returns:
              +
            • +
              +

              getXRadius

              +
              public double getXRadius()
              +
              +
              Returns:
              The radius of the spheroid on the X axis
              +
              • -
            - - - -
              -
            • -

              getYRadius

              -
              public double getYRadius()
              -
              -
              Returns:
              +
            • +
              +

              getYRadius

              +
              public double getYRadius()
              +
              +
              Returns:
              The radius of the spheroid on the Y axis
              +
              • -
            - - - -
              -
            • -

              getZRadius

              -
              public double getZRadius()
              -
              -
              Returns:
              +
            • +
              +

              getZRadius

              +
              public double getZRadius()
              +
              +
              Returns:
              The radius of the spheroid on the Z axis
              +
              • -
            - - - -
              -
            • -

              setXRadius

              -
              public SpheroidRegion setXRadius​(double xRad)
              +
            • +
              +

              setXRadius

              +
              public SpheroidRegion setXRadius​(double xRad)
              Sets the radius of the spheroid on the X axis
              -
              -
              Parameters:
              +
              +
              Parameters:
              xRad - The radius on the X axis
              -
              Returns:
              +
              Returns:
              Itself
              +
              • -
            - - - -
              -
            • -

              setYRadius

              -
              public SpheroidRegion setYRadius​(double yRad)
              +
            • +
              +

              setYRadius

              +
              public SpheroidRegion setYRadius​(double yRad)
              Sets the radius of the spheroid on the Y axis
              -
              -
              Parameters:
              +
              +
              Parameters:
              yRad - The radius on the Y axis
              -
              Returns:
              +
              Returns:
              Itself
              +
              • -
            - - - -
              -
            • -

              setZRadius

              -
              public SpheroidRegion setZRadius​(double zRad)
              +
            • +
              +

              setZRadius

              +
              public SpheroidRegion setZRadius​(double zRad)
              Sets the radius of the spheroid on the Z axis
              -
              -
              Parameters:
              +
              +
              Parameters:
              zRad - The radius on the Z axis
              -
              Returns:
              +
              Returns:
              Itself
              +
              • -
            - - - -
              -
            • -

              getStart

              -
              public org.bukkit.Location getStart()
              -
              -
              Specified by:
              +
            • +
              +

              getStart

              +
              public org.bukkit.Location getStart()
              +
              +
              Specified by:
              getStart in class Region
              -
              Returns:
              +
              Returns:
              The least extreme corner of this SpheroidRegion representing the minimum X, Y, and Z coordinates
              +
              • -
            - - - -
              -
            • -

              getEnd

              -
              public org.bukkit.Location getEnd()
              -
              -
              Specified by:
              +
            • +
              +

              getEnd

              +
              public org.bukkit.Location getEnd()
              +
              +
              Specified by:
              getEnd in class Region
              -
              Returns:
              +
              Returns:
              The move extreme corner of this SpheroidRegion representing the maximum X, Y, and Z coordinates
              +
              • -
            - - - -
              -
            • -

              getWorld

              -
              public org.bukkit.World getWorld()
              -
              -
              Overrides:
              +
            • +
              +

              getWorld

              +
              public org.bukkit.World getWorld()
              +
              +
              Overrides:
              getWorld in class Region
              -
              Returns:
              +
              Returns:
              The World this SpheroidRegion is in
              +
              • -
            - - - -
              -
            • -

              getCenter

              -
              public org.bukkit.Location getCenter()
              -
              -
              Overrides:
              +
            • +
              +

              getCenter

              +
              public org.bukkit.Location getCenter()
              +
              +
              Overrides:
              getCenter in class Region
              -
              Returns:
              +
              Returns:
              The center of this SpheroidRegion
              +
              • -
            - - - -
              -
            • -

              getSurfacePoint

              -
              public org.bukkit.Location getSurfacePoint​(org.bukkit.util.Vector v)
              +
            • +
              +

              getSurfacePoint

              +
              public org.bukkit.Location getSurfacePoint​(org.bukkit.util.Vector v)
              Gets a point on the surface of this SpheroidRegion in the given direction
              -
              -
              Parameters:
              +
              +
              Parameters:
              v - The direction to get the point in
              -
              Returns:
              +
              Returns:
              The point on the surface of this SpheroidRegion
              +
              • -
            - - - -
              -
            • -

              getSurface

              -
              public java.util.Set<org.bukkit.block.Block> getSurface()
              -
              -
              Returns:
              +
            • +
              +

              getSurface

              +
              public java.util.Set<org.bukkit.block.Block> getSurface()
              +
              +
              Returns:
              A Set containing all of the blocks on the surface of this SpheroidRegion
              +
              • -
            - - - -
              -
            • -

              surfaceContains

              -
              public boolean surfaceContains​(org.bukkit.block.Block block)
              +
            • +
              +

              surfaceContains

              +
              public boolean surfaceContains​(org.bukkit.block.Block block)
              Determines whether a block is on the surface of this SpheroidRegion
              -
              -
              Parameters:
              +
              +
              Parameters:
              block - The block to check
              -
              Returns:
              +
              Returns:
              Whether the block is on the surface of this SpheroidRegion
              +
              • -
            - - - -
              -
            • -

              toString

              -
              public java.lang.String toString()
              -
              -
              Overrides:
              +
            • +
              +

              toString

              +
              public java.lang.String toString()
              +
              +
              Overrides:
              toString in class java.lang.Object
              -
              Returns:
              +
              Returns:
              A String representation of this SpheroidRegion which can later be deserialized with fromString(String)
              +
              • -
            - - - -
              -
            • -

              fromString

              -
              public static SpheroidRegion fromString​(java.lang.String string)
              +
            • +
              +

              fromString

              +
              public static SpheroidRegion fromString​(java.lang.String string)
              Deserializes a SpheroidRegion serialized with toString()
              -
              -
              Parameters:
              +
              +
              Parameters:
              string - The serialized SpheroidRegion String
              -
              Returns:
              +
              Returns:
              The deserialized SpheroidRegion
              -
              • -
            +
      -
    - - + + + + diff --git a/javadoc/redempt/redlib/region/events/RegionEnterEvent.EnterCause.html b/javadoc/redempt/redlib/region/events/RegionEnterEvent.EnterCause.html index 4397e94..9cdf2d2 100644 --- a/javadoc/redempt/redlib/region/events/RegionEnterEvent.EnterCause.html +++ b/javadoc/redempt/redlib/region/events/RegionEnterEvent.EnterCause.html @@ -5,413 +5,312 @@ RegionEnterEvent.EnterCause (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.region.events
    -

    Enum RegionEnterEvent.EnterCause

    +
    Package redempt.redlib.region.events
    +

    Enum RegionEnterEvent.EnterCause

    -
    -
      -
    • java.lang.Object
      • -
    • - -
      • -
    -
    -
      -
    • -
      +
      java.lang.Object +
      java.lang.Enum<RegionEnterEvent.EnterCause> +
      redempt.redlib.region.events.RegionEnterEvent.EnterCause
      +
      +
      +
      +
      All Implemented Interfaces:
      -
      java.io.Serializable, java.lang.Comparable<RegionEnterEvent.EnterCause>
      +
      java.io.Serializable, java.lang.Comparable<RegionEnterEvent.EnterCause>, java.lang.constant.Constable
      -
      +
      Enclosing class:
      RegionEnterEvent
      -
      public static enum RegionEnterEvent.EnterCause
+
      public static enum RegionEnterEvent.EnterCause
 extends java.lang.Enum<RegionEnterEvent.EnterCause>
      
+
      +
      +
        + +
      • +
        +

        Nested Class Summary

        +
        +

        Nested classes/interfaces inherited from class java.lang.Enum

        +java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>
        +
        • -
      -
    -
    -
      -
    • -
      -
        -
      • - - -

        Enum Constant Summary

        - - +
      • +
        +

        Enum Constant Summary

        +
        +
        • Enum Constants 
        + + - - + + - - - + + + + - - - + + - - - + + - - - + + +
        Enum Constants
        Enum ConstantDescriptionEnum ConstantDescription
        JOIN +
        JOIN
        When a player joins into a region
        MOVE +
        MOVE
        When a player moves into a region
        RESPAWN +
        RESPAWN
        When a players respawns into a region
        TELEPORT +
        TELEPORT
        When a player teleports into a region
        -
        • -
      +
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Static Methods Concrete Methods 
      + - - - + + + - - - - + + + + + - - - - + + + +
      Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
      static RegionEnterEvent.EnterCausevalueOf​(java.lang.String name) +
      static RegionEnterEvent.EnterCausevalueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static RegionEnterEvent.EnterCause[]values() +
      static RegionEnterEvent.EnterCause[]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
        • -
      -
      • -
    +
    +
    +
    +

    Methods inherited from class java.lang.Enum

    +clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
    +
    +

    Methods inherited from class java.lang.Object

    +getClass, notify, notifyAll, wait, wait, wait
    -
    -
    -
    +
    +
    Returns:
    an array containing the constants of this enum type, in the order they are declared
    + - - - - -
      -
    • -

      valueOf

      -
      public static RegionEnterEvent.EnterCause valueOf​(java.lang.String name)
      +
    • +
      +

      valueOf

      +
      public static RegionEnterEvent.EnterCause 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:
      +
      +
      Parameters:
      name - the name of the enum constant to be returned.
      -
      Returns:
      +
      Returns:
      the enum constant with the specified name
      -
      Throws:
      +
      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/redempt/redlib/region/events/RegionEnterEvent.html b/javadoc/redempt/redlib/region/events/RegionEnterEvent.html index 7d4484a..914ad59 100644 --- a/javadoc/redempt/redlib/region/events/RegionEnterEvent.html +++ b/javadoc/redempt/redlib/region/events/RegionEnterEvent.html @@ -5,480 +5,367 @@ RegionEnterEvent (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.region.events
    -

    Class RegionEnterEvent

    +
    Package redempt.redlib.region.events
    +

    Class RegionEnterEvent

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • org.bukkit.event.Event
        • -
      • -
          -
        • redempt.redlib.region.events.RegionEnterEvent
          • -
        -
        • -
      -
      • -
    -
    -
      -
    • -
      +
      java.lang.Object +
      org.bukkit.event.Event +
      redempt.redlib.region.events.RegionEnterEvent
      +
      +
      +
      +
      All Implemented Interfaces:
      org.bukkit.event.Cancellable
      -
      public class RegionEnterEvent
+
      public class RegionEnterEvent
 extends org.bukkit.event.Event
 implements org.bukkit.event.Cancellable
      
 
      Called when a player enters a region with events enabled
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Nested Class Summary

          - - +
        • +
          +

          Nested Class Summary

          +
          +
          • Nested Classes 
          + + - - - + + + - - - - + + + + + + +
          Nested Classes
          Modifier and TypeClassDescriptionModifier and TypeClassDescription
          static class RegionEnterEvent.EnterCause 
          static class RegionEnterEvent.EnterCause 
          -
            -
          • - - -

            Nested classes/interfaces inherited from class org.bukkit.event.Event

            -org.bukkit.event.Event.Result
            • -
          -
          • -
        +
    +
    +

    Nested classes/interfaces inherited from class org.bukkit.event.Event

    +org.bukkit.event.Event.Result
    + -
    - +
    + -
    - +
    +
    +
    +

    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

          - - - -
            -
          • -

            RegionEnterEvent

            -
            public RegionEnterEvent​(org.bukkit.entity.Player player,
-                        Region region,
-                        RegionEnterEvent.EnterCause cause,
-                        org.bukkit.event.Cancellable parent)
            +
          • +
            +

            Constructor Details

            +
              +
            • +
              +

              RegionEnterEvent

              +
              public RegionEnterEvent​(org.bukkit.entity.Player player, +Region region, +RegionEnterEvent.EnterCause cause, +org.bukkit.event.Cancellable parent)
              Constructs a new RegionEnterEvent
              -
              -
              Parameters:
              +
              +
              Parameters:
              player - The player who entered the region
              region - The region that was entered
              cause - What caused the player to enter the region
              parent - The event which caused this RegionEnterEvent to fire
              -
              • -
            +
        + -
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            getHandlerList

            -
            public static org.bukkit.event.HandlerList getHandlerList()
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              getHandlerList

              +
              public static org.bukkit.event.HandlerList getHandlerList()
              +
              • -
            - - - -
              -
            • -

              getHandlers

              -
              public org.bukkit.event.HandlerList getHandlers()
              -
              -
              Specified by:
              +
            • +
              +

              getHandlers

              +
              public org.bukkit.event.HandlerList getHandlers()
              +
              +
              Specified by:
              getHandlers in class org.bukkit.event.Event
              +
              • -
            - - - -
              -
            • -

              getPlayer

              -
              public org.bukkit.entity.Player getPlayer()
              -
              -
              Returns:
              +
            • +
              +

              getPlayer

              +
              public org.bukkit.entity.Player getPlayer()
              +
              +
              Returns:
              The player who entered the region
              +
              • -
            - - - -
              -
            • -

              getRegion

              -
              public Region getRegion()
              -
              -
              Returns:
              +
            • +
              +

              getRegion

              +
              public Region getRegion()
              +
              +
              Returns:
              The region that was entered
              +
              • -
            - - - - - - - -
              -
            • -

              isCancelled

              -
              public boolean isCancelled()
              -
              -
              Specified by:
              +
            • +
              +

              isCancelled

              +
              public boolean isCancelled()
              +
              +
              Specified by:
              isCancelled in interface org.bukkit.event.Cancellable
              -
              Returns:
              +
              Returns:
              Whether or not the event has been cancelled. Always false if the parent event cannot be cancelled.
              +
              • -
            - - - -
              -
            • -

              setCancelled

              -
              public void setCancelled​(boolean cancel)
              +
            • +
              +

              setCancelled

              +
              public void setCancelled​(boolean cancel)
              Set whether or not to cancel the player entering the Region. Not all causes can be cancelled - check getCause() first, you can't cancel a player joining
              -
              -
              Specified by:
              +
              +
              Specified by:
              setCancelled in interface org.bukkit.event.Cancellable
              -
              Parameters:
              +
              Parameters:
              cancel - Whether to cancel this event
              -
              • -
            +
      -
    - - + + + + diff --git a/javadoc/redempt/redlib/region/events/RegionExitEvent.ExitCause.html b/javadoc/redempt/redlib/region/events/RegionExitEvent.ExitCause.html index 403361d..5bf886f 100644 --- a/javadoc/redempt/redlib/region/events/RegionExitEvent.ExitCause.html +++ b/javadoc/redempt/redlib/region/events/RegionExitEvent.ExitCause.html @@ -5,413 +5,312 @@ RegionExitEvent.ExitCause (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.region.events
    -

    Enum RegionExitEvent.ExitCause

    +
    Package redempt.redlib.region.events
    +

    Enum RegionExitEvent.ExitCause

    -
    -
      -
    • java.lang.Object
      • -
    • - -
      • -
    -
    -
      -
    • -
      +
      java.lang.Object +
      java.lang.Enum<RegionExitEvent.ExitCause> +
      redempt.redlib.region.events.RegionExitEvent.ExitCause
      +
      +
      +
      +
      All Implemented Interfaces:
      -
      java.io.Serializable, java.lang.Comparable<RegionExitEvent.ExitCause>
      +
      java.io.Serializable, java.lang.Comparable<RegionExitEvent.ExitCause>, java.lang.constant.Constable
      -
      +
      Enclosing class:
      RegionExitEvent
      -
      public static enum RegionExitEvent.ExitCause
+
      public static enum RegionExitEvent.ExitCause
 extends java.lang.Enum<RegionExitEvent.ExitCause>
      
+
      +
      +
        + +
      • +
        +

        Nested Class Summary

        +
        +

        Nested classes/interfaces inherited from class java.lang.Enum

        +java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>
        +
        • -
      -
    -
    -
      -
    • -
      -
        -
      • - - -

        Enum Constant Summary

        - - +
      • +
        +

        Enum Constant Summary

        +
        +
        • Enum Constants 
        + + - - + + - - - + + + + - - - + + - - - + + - - - + + +
        Enum Constants
        Enum ConstantDescriptionEnum ConstantDescription
        DEATH +
        DEATH
        When a player dies in a region
        MOVE +
        MOVE
        When a player moves out of a region
        QUIT +
        QUIT
        When a player leaves the game whilst in a region
        TELEPORT +
        TELEPORT
        When a player teleports out of a region
        -
        • -
      +
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Static Methods Concrete Methods 
      + - - - + + + - - - - + + + + + - - - - + + + +
      Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
      static RegionExitEvent.ExitCausevalueOf​(java.lang.String name) +
      static RegionExitEvent.ExitCausevalueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static RegionExitEvent.ExitCause[]values() +
      static RegionExitEvent.ExitCause[]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
        • -
      -
      • -
    +
    +
    +
    +

    Methods inherited from class java.lang.Enum

    +clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
    +
    +

    Methods inherited from class java.lang.Object

    +getClass, notify, notifyAll, wait, wait, wait
    -
    -
    -
    +
    +
    Returns:
    an array containing the constants of this enum type, in the order they are declared
    + - - - - -
      -
    • -

      valueOf

      -
      public static RegionExitEvent.ExitCause valueOf​(java.lang.String name)
      +
    • +
      +

      valueOf

      +
      public static RegionExitEvent.ExitCause 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:
      +
      +
      Parameters:
      name - the name of the enum constant to be returned.
      -
      Returns:
      +
      Returns:
      the enum constant with the specified name
      -
      Throws:
      +
      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/redempt/redlib/region/events/RegionExitEvent.html b/javadoc/redempt/redlib/region/events/RegionExitEvent.html index b89185a..e539a4a 100644 --- a/javadoc/redempt/redlib/region/events/RegionExitEvent.html +++ b/javadoc/redempt/redlib/region/events/RegionExitEvent.html @@ -5,480 +5,367 @@ RegionExitEvent (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.region.events
    -

    Class RegionExitEvent

    +
    Package redempt.redlib.region.events
    +

    Class RegionExitEvent

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • org.bukkit.event.Event
        • -
      • -
          -
        • redempt.redlib.region.events.RegionExitEvent
          • -
        -
        • -
      -
      • -
    -
    -
      -
    • -
      +
      java.lang.Object +
      org.bukkit.event.Event +
      redempt.redlib.region.events.RegionExitEvent
      +
      +
      +
      +
      All Implemented Interfaces:
      org.bukkit.event.Cancellable
      -
      public class RegionExitEvent
+
      public class RegionExitEvent
 extends org.bukkit.event.Event
 implements org.bukkit.event.Cancellable
      
 
      Called when a player exits a region with events enabled
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Nested Class Summary

          - - +
        • +
          +

          Nested Class Summary

          +
          +
          • Nested Classes 
          + + - - - + + + - - - - + + + + + + +
          Nested Classes
          Modifier and TypeClassDescriptionModifier and TypeClassDescription
          static class RegionExitEvent.ExitCause 
          static class RegionExitEvent.ExitCause 
          -
            -
          • - - -

            Nested classes/interfaces inherited from class org.bukkit.event.Event

            -org.bukkit.event.Event.Result
            • -
          -
          • -
        +
    +
    +

    Nested classes/interfaces inherited from class org.bukkit.event.Event

    +org.bukkit.event.Event.Result
    + -
    -
      -
    • - - -

      Constructor Summary

      - - +
    • +
      +

      Constructor Summary

      +
      +
      • Constructors 
      + + - - + + - - - + + + + +
      Constructors
      ConstructorDescriptionConstructorDescription
      RegionExitEvent​(org.bukkit.entity.Player player, - Region region, - RegionExitEvent.ExitCause cause, - org.bukkit.event.Cancellable parent) +
      RegionExitEvent​(org.bukkit.entity.Player player, +Region region, +RegionExitEvent.ExitCause cause, +org.bukkit.event.Cancellable parent)
      Constructs a new RegionExitEvent
      -
      • -
    +
    + -
    - +
    +
    +
    +

    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

          - - - -
            -
          • -

            RegionExitEvent

            -
            public RegionExitEvent​(org.bukkit.entity.Player player,
-                       Region region,
-                       RegionExitEvent.ExitCause cause,
-                       org.bukkit.event.Cancellable parent)
            +
          • +
            +

            Constructor Details

            +
              +
            • +
              +

              RegionExitEvent

              +
              public RegionExitEvent​(org.bukkit.entity.Player player, +Region region, +RegionExitEvent.ExitCause cause, +org.bukkit.event.Cancellable parent)
              Constructs a new RegionExitEvent
              -
              -
              Parameters:
              +
              +
              Parameters:
              player - The player that exited the region
              region - The region that was exited
              cause - What caused the player to enter the region
              parent - The event that caused this RegionExitEvent to fire
              -
              • -
            +
        + -
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            getHandlerList

            -
            public static org.bukkit.event.HandlerList getHandlerList()
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              getHandlerList

              +
              public static org.bukkit.event.HandlerList getHandlerList()
              +
              • -
            - - - -
              -
            • -

              getHandlers

              -
              public org.bukkit.event.HandlerList getHandlers()
              -
              -
              Specified by:
              +
            • +
              +

              getHandlers

              +
              public org.bukkit.event.HandlerList getHandlers()
              +
              +
              Specified by:
              getHandlers in class org.bukkit.event.Event
              +
              • -
            - - - -
              -
            • -

              getPlayer

              -
              public org.bukkit.entity.Player getPlayer()
              -
              -
              Returns:
              +
            • +
              +

              getPlayer

              +
              public org.bukkit.entity.Player getPlayer()
              +
              +
              Returns:
              The player who exited the region
              +
              • -
            - - - -
              -
            • -

              getRegion

              -
              public Region getRegion()
              -
              -
              Returns:
              +
            • +
              +

              getRegion

              +
              public Region getRegion()
              +
              +
              Returns:
              The region that was exited
              +
              • -
            - - - - - - - -
              -
            • -

              isCancelled

              -
              public boolean isCancelled()
              -
              -
              Specified by:
              +
            • +
              +

              isCancelled

              +
              public boolean isCancelled()
              +
              +
              Specified by:
              isCancelled in interface org.bukkit.event.Cancellable
              -
              Returns:
              +
              Returns:
              Whether or not the event has been cancelled. Always false if the parent event cannot be cancelled.
              +
              • -
            - - - -
              -
            • -

              setCancelled

              -
              public void setCancelled​(boolean cancel)
              +
            • +
              +

              setCancelled

              +
              public void setCancelled​(boolean cancel)
              Set whether or not to cancel the player entering the Region. Not all causes can be cancelled - check getCause() first, you can't cancel a player leaving
              -
              -
              Specified by:
              +
              +
              Specified by:
              setCancelled in interface org.bukkit.event.Cancellable
              -
              Parameters:
              +
              Parameters:
              cancel - Whether to cancel this event
              -
              • -
            +
      -
    - - + + + + diff --git a/javadoc/redempt/redlib/region/events/package-summary.html b/javadoc/redempt/redlib/region/events/package-summary.html index e39968e..08e8104 100644 --- a/javadoc/redempt/redlib/region/events/package-summary.html +++ b/javadoc/redempt/redlib/region/events/package-summary.html @@ -5,47 +5,30 @@ redempt.redlib.region.events (RedLib API) + + - + + - - - - - + + - - -
    +
    + +

    Package redempt.redlib.region.events

    -
    -
    -
  • - - +
  • +
    +
    • Enum Summary 
    + + - - + + + - - - + + + - - - + + +
    Enum Summary
    EnumDescriptionEnumDescription
    RegionEnterEvent.EnterCause 
    RegionEnterEvent.EnterCause 
    RegionExitEvent.ExitCause 
    RegionExitEvent.ExitCause 
    +
    • -
    +
    + + +
    + + diff --git a/javadoc/redempt/redlib/region/events/package-tree.html b/javadoc/redempt/redlib/region/events/package-tree.html index d05c76c..8d82413 100644 --- a/javadoc/redempt/redlib/region/events/package-tree.html +++ b/javadoc/redempt/redlib/region/events/package-tree.html @@ -5,176 +5,109 @@ redempt.redlib.region.events Class Hierarchy (RedLib API) + + - + + - - - - - + + - - -
    +
    + +

    Hierarchy For Package redempt.redlib.region.events

    -Package Hierarchies: +Package Hierarchies:
    -
    -
    +

    Class Hierarchy

    • java.lang.Object
      • org.bukkit.event.Event
          -
        • redempt.redlib.region.events.RegionEnterEvent (implements org.bukkit.event.Cancellable)
          • -
        • redempt.redlib.region.events.RegionExitEvent (implements org.bukkit.event.Cancellable)
          • +
        • redempt.redlib.region.events.RegionEnterEvent (implements org.bukkit.event.Cancellable)
          • +
        • redempt.redlib.region.events.RegionExitEvent (implements org.bukkit.event.Cancellable)
    -
    +

    Enum Hierarchy

    -
    +
    +
    diff --git a/javadoc/redempt/redlib/region/package-summary.html b/javadoc/redempt/redlib/region/package-summary.html index 28042a6..051bea0 100644 --- a/javadoc/redempt/redlib/region/package-summary.html +++ b/javadoc/redempt/redlib/region/package-summary.html @@ -5,47 +5,30 @@ redempt.redlib.region (RedLib API) + + - + + - - - - - + + - - -
    +
    + +

    Package redempt.redlib.region

    -
    -
      -
    • - - +
      +
        +
      • +
        +
      Interface Summary 
      + + - - + + + - - - + +
      Interface Summary
      InterfaceDescriptionInterfaceDescription
      Overlappable +
      Overlappable
      Represents a Region which supports the overlap and intersect operations
      +
    -
  • - - +
  • +
    +
    • Class Summary 
    + + - - + + + - - - + + - - - + + - - - + + - - - + + - - - + + + - - - + + - - - + + - - - + + - - - + +
    Class Summary
    ClassDescriptionClassDescription
    CuboidRegion +
    CuboidRegion
    Represents a cuboid region in a world
    CuboidRegion.RegionState +
    CuboidRegion.RegionState
    Represents a state of a Region, not necessarily at the current point in time
    MultiRegion +
    MultiRegion
    Represents a collection of Regions forming any shape
    Region +
    Region
    Represents a region of an unspecified shape in the world
    RegionEnterExitListener 
    RegionEnterExitListener 
    RegionMap<T> +
    RegionMap<T>
    Represents a spatial mapping which can retrieve objects by approximate location in O(1)
    RegionUtils +
    RegionUtils
    Utilities for niche use cases of Regions
    SelectionTool +
    SelectionTool
    A tool which can be given to players and used to select a Region, or just any two points
    SpheroidRegion +
    SpheroidRegion
    Represents a spheroid region in a world
    +
    • -
    +
    + + +
    + + diff --git a/javadoc/redempt/redlib/region/package-tree.html b/javadoc/redempt/redlib/region/package-tree.html index 2f1ca94..048b08b 100644 --- a/javadoc/redempt/redlib/region/package-tree.html +++ b/javadoc/redempt/redlib/region/package-tree.html @@ -5,173 +5,106 @@ redempt.redlib.region Class Hierarchy (RedLib API) + + - + + - - - - - + + - - -
    +
    + +

    Hierarchy For Package redempt.redlib.region

    -Package Hierarchies: +Package Hierarchies:
    -
    -
    +

    Class Hierarchy

    -
    +

    Interface Hierarchy

    -
    +
    +
    diff --git a/javadoc/redempt/redlib/sql/SQLCache.html b/javadoc/redempt/redlib/sql/SQLCache.html index cc5338f..b57c58c 100644 --- a/javadoc/redempt/redlib/sql/SQLCache.html +++ b/javadoc/redempt/redlib/sql/SQLCache.html @@ -5,579 +5,454 @@ SQLCache (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.sql
    -

    Class SQLCache

    +
    Package redempt.redlib.sql
    +

    Class SQLCache

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.sql.SQLCache
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      redempt.redlib.sql.SQLCache
      +
      +
      -
      public class SQLCache
+
      public class SQLCache
 extends java.lang.Object
      
 
      A cache to store the values in a single column of a single SQL table
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Constructor Summary

          - - +
        • +
          +

          Constructor Summary

          +
          +
          • Constructors 
          + + - - - + + + - - - - + + + + + + +
          Constructors
          ModifierConstructorDescriptionModifierConstructorDescription
          protected SQLCache​(SQLHelper sql, - java.lang.String tableName, - java.lang.String columnName, - java.lang.String... primaryKeyNames) 
          protected SQLCache​(SQLHelper sql, +java.lang.String tableName, +java.lang.String columnName, +java.lang.String... primaryKeyNames) 
          -
          • -
        +
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Instance Methods Concrete Methods 
      + - - - + + + - - - - + + + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + - - - - + + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + +
      Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
      voidclear() +
      voidclear()
      Clears the cache.
      voiddelete​(java.lang.Object... primaryKeys) +
      voiddelete​(java.lang.Object... primaryKeys)
      Deletes a row from the table by its primary keys, and removes it from the cache.
      voidflush() +
      voidflush()
      Flushes the cache, saving all changes that were made.
      voidflush​(java.lang.Object... primaryKeys) +
      voidflush​(java.lang.Object... primaryKeys)
      Flushes a single value from the cache, saving changes that were made to it
      java.lang.StringgetColumnName() 
      java.lang.StringgetColumnName() 
      java.lang.String[]getPrimaryKeyNames() 
      java.lang.String[]getPrimaryKeyNames() 
      java.lang.StringgetTableName() 
      java.lang.StringgetTableName() 
      booleanisCached​(java.lang.Object... primaryKeys) +
      booleanisCached​(java.lang.Object... primaryKeys)
      Checks whether a value has been cached by its primary keys
      protected booleankeyNamesMatch​(java.lang.String[] matches) 
      protected booleankeyNamesMatch​(java.lang.String[] matches) 
      voidremove​(java.lang.Object... primaryKeys) +
      voidremove​(java.lang.Object... primaryKeys)
      Removes a cached value, but does not affect the table
      <T> Tselect​(java.lang.Object... primaryKeys) +
      <T> Tselect​(java.lang.Object... primaryKeys)
      Gets the cached value for a row, or queries it if it has not been cached yet
      java.lang.LongselectLong​(java.lang.Object... primaryKeys) +
      java.lang.LongselectLong​(java.lang.Object... primaryKeys)
      Gets the cached value for a Long row, or queries it if it has not been cached yet
      java.lang.StringselectString​(java.lang.Object... primaryKeys) +
      java.lang.StringselectString​(java.lang.Object... primaryKeys)
      Gets the cached value for a String row, or queries it if it has not been cached yet
      voidupdate​(java.lang.Object value, - java.lang.Object... primaryKeys) +
      voidupdate​(java.lang.Object value, +java.lang.Object... primaryKeys)
      Updates the cached value for a row
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

    Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - -
            -
          • -

            SQLCache

            -
            protected SQLCache​(SQLHelper sql,
-                   java.lang.String tableName,
-                   java.lang.String columnName,
-                   java.lang.String... primaryKeyNames)
            -
            • -
          +
        • +
          +

          Constructor Details

          +
            +
          • +
            +

            SQLCache

            +
            protected SQLCache​(SQLHelper sql, +java.lang.String tableName, +java.lang.String columnName, +java.lang.String... primaryKeyNames)
            +
          +
          • -
          -
            -
          • - - -

            Method Detail

            - - - -
              -
            • -

              getTableName

              -
              public java.lang.String getTableName()
              -
              -
              Returns:
              +
            • +
              +

              Method Details

              +
                +
              • +
                +

                getTableName

                +
                public java.lang.String getTableName()
                +
                +
                Returns:
                The name of the table this SQLCache is for
                +
                • -
              - - - -
                -
              • -

                getColumnName

                -
                public java.lang.String getColumnName()
                -
                -
                Returns:
                +
              • +
                +

                getColumnName

                +
                public java.lang.String getColumnName()
                +
                +
                Returns:
                The name of the column this SQLCache is for
                +
                • -
              - - - -
                -
              • -

                getPrimaryKeyNames

                -
                public java.lang.String[] getPrimaryKeyNames()
                -
                -
                Returns:
                +
              • +
                +

                getPrimaryKeyNames

                +
                public java.lang.String[] getPrimaryKeyNames()
                +
                +
                Returns:
                The names of the primary keys used to access and mutate the column this SQLCache is for
                +
                • -
              - - - -
                -
              • -

                keyNamesMatch

                -
                protected boolean keyNamesMatch​(java.lang.String[] matches)
                +
              • +
                +

                keyNamesMatch

                +
                protected boolean keyNamesMatch​(java.lang.String[] matches)
                +
                • -
              - - - -
                -
              • -

                delete

                -
                public void delete​(java.lang.Object... primaryKeys)
                +
              • +
                +

                delete

                +
                public void delete​(java.lang.Object... primaryKeys)
                Deletes a row from the table by its primary keys, and removes it from the cache. This operation will always use a query.
                -
                -
                Parameters:
                +
                +
                Parameters:
                primaryKeys - The keys to use to delete the row
                +
                • -
              - - - -
                -
              • -

                remove

                -
                public void remove​(java.lang.Object... primaryKeys)
                +
              • +
                +

                remove

                +
                public void remove​(java.lang.Object... primaryKeys)
                Removes a cached value, but does not affect the table
                -
                -
                Parameters:
                +
                +
                Parameters:
                primaryKeys - The keys used to access the value
                +
                • -
              - - - -
                -
              • -

                update

                -
                public void update​(java.lang.Object value,
-                   java.lang.Object... primaryKeys)
                +
              • +
                +

                update

                +
                public void update​(java.lang.Object value, +java.lang.Object... primaryKeys)
                Updates the cached value for a row
                -
                -
                Parameters:
                +
                +
                Parameters:
                value - The value to cache
                primaryKeys - The primary keys used to mutate the row
                +
                • -
              - - - -
                -
              • -

                select

                -
                public <T> T select​(java.lang.Object... primaryKeys)
                +
              • +
                +

                select

                +
                public <T> T select​(java.lang.Object... primaryKeys)
                Gets the cached value for a row, or queries it if it has not been cached yet
                -
                -
                Type Parameters:
                +
                +
                Type Parameters:
                T - The type of the value
                -
                Parameters:
                +
                Parameters:
                primaryKeys - The primary keys used to access the row
                -
                Returns:
                +
                Returns:
                The value
                +
                • -
              - - - -
                -
              • -

                selectString

                -
                public java.lang.String selectString​(java.lang.Object... primaryKeys)
                +
              • +
                +

                selectString

                +
                public java.lang.String selectString​(java.lang.Object... primaryKeys)
                Gets the cached value for a String row, or queries it if it has not been cached yet
                -
                -
                Parameters:
                +
                +
                Parameters:
                primaryKeys - The primary keys used to access the row
                -
                Returns:
                +
                Returns:
                The String value
                +
                • -
              - - - -
                -
              • -

                selectLong

                -
                public java.lang.Long selectLong​(java.lang.Object... primaryKeys)
                +
              • +
                +

                selectLong

                +
                public java.lang.Long selectLong​(java.lang.Object... primaryKeys)
                Gets the cached value for a Long row, or queries it if it has not been cached yet
                -
                -
                Parameters:
                +
                +
                Parameters:
                primaryKeys - The primary keys used to access the row
                -
                Returns:
                +
                Returns:
                The Long value
                +
                • -
              - - - -
                -
              • -

                isCached

                -
                public boolean isCached​(java.lang.Object... primaryKeys)
                +
              • +
                +

                isCached

                +
                public boolean isCached​(java.lang.Object... primaryKeys)
                Checks whether a value has been cached by its primary keys
                -
                -
                Parameters:
                +
                +
                Parameters:
                primaryKeys - The primary keys used to access the row
                -
                Returns:
                +
                Returns:
                Whether the value has been cached
                +
                • -
              - - - -
                -
              • -

                clear

                -
                public void clear()
                +
              • +
                +

                clear

                +
                public void clear()
                Clears the cache. WARNING: This will revert all changes that have not been flushed! No updates performed through update(Object, Object...) will be committed!
                +
                • -
              - - - -
                -
              • -

                flush

                -
                public void flush()
                +
              • +
                +

                flush

                +
                public void flush()
                Flushes the cache, saving all changes that were made.
                +
                • -
              - - - -
                -
              • -

                flush

                -
                public void flush​(java.lang.Object... primaryKeys)
                +
              • +
                +

                flush

                +
                public void flush​(java.lang.Object... primaryKeys)
                Flushes a single value from the cache, saving changes that were made to it
                -
                -
                Parameters:
                +
                +
                Parameters:
                primaryKeys - The primary keys used to access the row
                -
                • -
              +
        -
    - - + + + + diff --git a/javadoc/redempt/redlib/sql/SQLHelper.Results.html b/javadoc/redempt/redlib/sql/SQLHelper.Results.html index 54c38f9..77170a9 100644 --- a/javadoc/redempt/redlib/sql/SQLHelper.Results.html +++ b/javadoc/redempt/redlib/sql/SQLHelper.Results.html @@ -5,434 +5,330 @@ SQLHelper.Results (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.sql
    -

    Class SQLHelper.Results

    +
    Package redempt.redlib.sql
    +

    Class SQLHelper.Results

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.sql.SQLHelper.Results
        • -
      -
      • -
    -
    -
      -
    • -
      +
      java.lang.Object +
      redempt.redlib.sql.SQLHelper.Results
      +
      +
      +
      All Implemented Interfaces:
      java.lang.AutoCloseable
      -
      +
      Enclosing class:
      SQLHelper
      -
      public static class SQLHelper.Results
+
      public static class SQLHelper.Results
 extends java.lang.Object
 implements java.lang.AutoCloseable
      
 
      Wraps a ResultSet with easier use
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Method Summary

          - - +
        • +
          +

          Method Summary

          +
          +
          +
          +
          • All Methods Instance Methods Concrete Methods 
          + - - - + + + - - - - + + + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + + - - - - + + + +
          Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
          voidclose() +
          voidclose()
          Closes the wrapped ResultSet.
          voidforEach​(java.util.function.Consumer<SQLHelper.Results> lambda) +
          voidforEach​(java.util.function.Consumer<SQLHelper.Results> lambda)
          Performs an operation on every row in these Results, passing itself each time it iterates to a new row
          <T> Tget​(int column) +
          <T> Tget​(int column)
          Gets an Object in the given column in the current row
          intgetColumnCount() +
          intgetColumnCount()
          Gets the column count from the returned data
          java.lang.LonggetLong​(int column) +
          java.lang.LonggetLong​(int column)
          Gets a Long in the given column in the current row
          java.lang.StringgetString​(int column) +
          java.lang.StringgetString​(int column)
          Gets a String in the given column in the current row
          booleanisEmpty() 
          booleanisEmpty() 
          booleannext() +
          booleannext()
          Moves to the next row in the wrapped ResultSet.
          -
            -
          • - - -

            Methods inherited from class java.lang.Object

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

    Methods inherited from class java.lang.Object

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

          Method Detail

          - - - -
            -
          • -

            isEmpty

            -
            public boolean isEmpty()
            -
            -
            Returns:
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              isEmpty

              +
              public boolean isEmpty()
              +
              +
              Returns:
              False if the first call of ResultSet.next() on the wrapped ResultSet returned false, true otherwise
              +
              • -
            - - - -
              -
            • -

              next

              -
              public boolean next()
              +
            • +
              +

              next

              +
              public boolean next()
              Moves to the next row in the wrapped ResultSet. Note that this method is called immediately when the Results object is constructed, and does not need to be called to retrieve the items in the first row.
              -
              -
              Returns:
              +
              +
              Returns:
              True if there is another row available in the wrapped ResultSet
              +
              • -
            - - - -
              -
            • -

              forEach

              -
              public void forEach​(java.util.function.Consumer<SQLHelper.Results> lambda)
              +
            • +
              +

              forEach

              +
              public void forEach​(java.util.function.Consumer<SQLHelper.Results> lambda)
              Performs an operation on every row in these Results, passing itself each time it iterates to a new row
              -
              -
              Parameters:
              +
              +
              Parameters:
              lambda - The callback to be run on every row in these Results
              +
              • -
            - - - -
              -
            • -

              get

              -
              public <T> T get​(int column)
              +
            • +
              +

              get

              +
              public <T> T get​(int column)
              Gets an Object in the given column in the current row
              -
              -
              Type Parameters:
              +
              +
              Type Parameters:
              T - The type to cast the return value to
              -
              Parameters:
              +
              Parameters:
              column - The index of the column to get, starting at 1
              -
              Returns:
              +
              Returns:
              The value in the column
              +
              • -
            - - - -
              -
            • -

              getString

              -
              public java.lang.String getString​(int column)
              +
            • +
              +

              getString

              +
              public java.lang.String getString​(int column)
              Gets a String in the given column in the current row
              -
              -
              Parameters:
              +
              +
              Parameters:
              column - The index of the column to get, starting at 1
              -
              Returns:
              +
              Returns:
              The String in the column Note: This method exists because ResultSet.getObject(int) can return an Integer if the String in the column can be parsed into one.
              +
              • -
            - - - -
              -
            • -

              getLong

              -
              public java.lang.Long getLong​(int column)
              +
            • +
              +

              getLong

              +
              public java.lang.Long getLong​(int column)
              Gets a Long in the given column in the current row
              -
              -
              Parameters:
              +
              +
              Parameters:
              column - The index of the column to get, starting at 1
              -
              Returns:
              +
              Returns:
              The String in the column Note: This method exists because ResultSet.getObject(int) can return an Integer if the Long in the column can be parsed into one.
              +
              • -
            - - - -
              -
            • -

              getColumnCount

              -
              public int getColumnCount()
              +
            • +
              +

              getColumnCount

              +
              public int getColumnCount()
              Gets the column count from the returned data
              -
              -
              Returns:
              +
              +
              Returns:
              The column count
              +
              • -
            - - - -
              -
            • -

              close

              -
              public void close()
              +
            • +
              +

              close

              +
              public void close()
              Closes the wrapped ResultSet. Call this when you are done using these Results.
              -
              -
              Specified by:
              +
              +
              Specified by:
              close in interface java.lang.AutoCloseable
              -
              • -
            +
      -
    -
    - + + + + diff --git a/javadoc/redempt/redlib/sql/SQLHelper.html b/javadoc/redempt/redlib/sql/SQLHelper.html index f758f53..47f8918 100644 --- a/javadoc/redempt/redlib/sql/SQLHelper.html +++ b/javadoc/redempt/redlib/sql/SQLHelper.html @@ -5,937 +5,781 @@ SQLHelper (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.sql
    -

    Class SQLHelper

    +
    Package redempt.redlib.sql
    +

    Class SQLHelper

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.sql.SQLHelper
        • -
      -
      • -
    -
    -
      -
    • -
      +
      java.lang.Object +
      redempt.redlib.sql.SQLHelper
      +
      +
      +
      All Implemented Interfaces:
      java.io.Closeable, java.lang.AutoCloseable
      -
      public class SQLHelper
+
      public class SQLHelper
 extends java.lang.Object
 implements java.io.Closeable
      
 
      Wraps a Connection and offers helpful methods that don't need to be surrounded in a try/catch
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Nested Class Summary

          - - +
        • +
          +

          Nested Class Summary

          +
          +
          • Nested Classes 
          + + - - - + + + - - - - + + + + + +
          Nested Classes
          Modifier and TypeClassDescriptionModifier and TypeClassDescription
          static class SQLHelper.Results +
          static class SQLHelper.Results
          Wraps a ResultSet with easier use
          -
          • -
        +
    + -
    -
      -
    • - - -

      Constructor Summary

      - - +
    • +
      +

      Constructor Summary

      +
      +
      • Constructors 
      + + - - + + - - - + + + + +
      Constructors
      ConstructorDescriptionConstructorDescription
      SQLHelper​(java.sql.Connection connection) +
      SQLHelper​(java.sql.Connection connection)
      Constructs a SQLHelper from a Connection.
      -
      • -
    +
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Static Methods Instance Methods Concrete Methods 
      + - - - + + + - - - - + + + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + + - - - - + + + + - - - - + + + - - - - + + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + +
      Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
      voidclearAllCaches() +
      voidclearAllCaches()
      Calls SQLCache.clear() on all caches owned by this SQLHelper
      voidclose() +
      voidclose()
      Closes the underlying connection this SQLHelper wraps
      voidcommit() +
      voidcommit()
      Flushes all caches and commits the transaction
      SQLCachecreateCache​(java.lang.String tableName, - java.lang.String columnName, - java.lang.String... primaryKeyNames) +
      SQLCachecreateCache​(java.lang.String tableName, +java.lang.String columnName, +java.lang.String... primaryKeyNames)
      Creates and adds cache for a certain column
      voidexecute​(java.lang.String command, - java.lang.Object... fields) +
      voidexecute​(java.lang.String command, +java.lang.Object... fields)
      Executes a SQL query as a prepared statement, setting its fields to the elements of the vararg passed
      voidflushAllCaches() +
      voidflushAllCaches()
      Calls SQLCache.flush() on all caches owned by this SQLHelper
      voidflushAndRemoveFromMatchingCaches​(java.lang.String pattern, - java.lang.Object... primaryKeys) +
      voidflushAndRemoveFromMatchingCaches​(java.lang.String pattern, +java.lang.Object... primaryKeys)
      Finds matching caches by a pattern and flushes, then removes a specific entry from them.
      voidflushMatchingCaches​(java.lang.String pattern, - java.lang.Object... primaryKeys) +
      voidflushMatchingCaches​(java.lang.String pattern, +java.lang.Object... primaryKeys)
      Finds matching caches by a pattern and flushes a specific entry from them.
      java.util.List<SQLCache>getCaches() 
      java.util.List<SQLCache>getCaches() 
      java.sql.ConnectiongetConnection() 
      java.sql.ConnectiongetConnection() 
      java.util.List<SQLCache>getMatchingCaches​(java.lang.String pattern) +
      java.util.List<SQLCache>getMatchingCaches​(java.lang.String pattern)
      Gets the caches matching a pattern
      booleanisAutoCommit() 
      booleanisAutoCommit() 
      static java.sql.ConnectionopenMySQL​(java.lang.String ip, - int port, - java.lang.String username, - java.lang.String password, - java.lang.String database) +
      static java.sql.ConnectionopenMySQL​(java.lang.String ip, +int port, +java.lang.String username, +java.lang.String password, +java.lang.String database)
      Opens a connection to a MySQL database
      static java.sql.ConnectionopenMySQL​(java.lang.String username, - java.lang.String password, - java.lang.String database) +
      static java.sql.ConnectionopenMySQL​(java.lang.String username, +java.lang.String password, +java.lang.String database)
      Opens a connection to a MySQL database at localhost:3306
      static java.sql.ConnectionopenSQLite​(java.nio.file.Path file) +
      static java.sql.ConnectionopenSQLite​(java.nio.file.Path file)
      Opens a SQLite database file
      java.sql.PreparedStatementprepareStatement​(java.lang.String query, - java.lang.Object... fields) +
      java.sql.PreparedStatementprepareStatement​(java.lang.String query, +java.lang.Object... fields)
      Prepares a statement, setting its fields to the elements of the vararg passed
      <T> java.util.List<T>queryResultList​(java.lang.String query, - java.lang.Object... fields) +
      <T> java.util.List<T>queryResultList​(java.lang.String query, +java.lang.Object... fields)
      Executes a SQL query as a prepared statement, setting its fields to the elements of the vararg passed, returning a list of values in the first column of each row in the results
      SQLHelper.ResultsqueryResults​(java.lang.String query, - java.lang.Object... fields) +
      SQLHelper.ResultsqueryResults​(java.lang.String query, +java.lang.Object... fields)
      Executes a SQL query as a prepared statement, setting its fields to the elements of the vararg passed.
      java.util.List<java.lang.String>queryResultStringList​(java.lang.String query, - java.lang.Object... fields) +
      java.util.List<java.lang.String>queryResultStringList​(java.lang.String query, +java.lang.Object... fields)
      Executes a SQL query as a prepared statement, setting its fields to the elements of the vararg passed, returning a String list of values in the first column of each row in the results
      <T> TquerySingleResult​(java.lang.String query, - java.lang.Object... fields) +
      <T> TquerySingleResult​(java.lang.String query, +java.lang.Object... fields)
      Executes a SQL query as a prepared statement, setting its fields to the elements of the vararg passed, returning the value in the first column of the first row in the results
      java.lang.LongquerySingleResultLong​(java.lang.String query, - java.lang.Object... fields) +
      java.lang.LongquerySingleResultLong​(java.lang.String query, +java.lang.Object... fields)
      Executes a SQL query as a prepared statement, setting its fields to the elements of the vararg passed, returning the value in the first column of the first row in the results as a Long.
      java.lang.StringquerySingleResultString​(java.lang.String query, - java.lang.Object... fields) +
      java.lang.StringquerySingleResultString​(java.lang.String query, +java.lang.Object... fields)
      Executes a SQL query as a prepared statement, setting its fields to the elements of the vararg passed, returning the value in the first column of the first row in the results as a String.
      voidremoveFromMatchingCaches​(java.lang.String pattern, - java.lang.Object... primaryKeys) +
      voidremoveFromMatchingCaches​(java.lang.String pattern, +java.lang.Object... primaryKeys)
      Finds matching caches by a pattern and removes a specific entry from them.
      voidsetAutoCommit​(boolean autoCommit) +
      voidsetAutoCommit​(boolean autoCommit)
      Sets the wrapped connection's auto-commit property.
      voidsetCommitInterval​(int ticks) +
      voidsetCommitInterval​(int ticks)
      Starts a task to call commit() on this SQLHelper every n ticks.
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

    Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - -
            -
          • -

            SQLHelper

            -
            public SQLHelper​(java.sql.Connection connection)
            +
          • +
            +

            Constructor Details

            +
              +
            • +
              +

              SQLHelper

              +
              public SQLHelper​(java.sql.Connection connection)
              Constructs a SQLHelper from a Connection. Get the Connection using one of the static SQLHelper open methods.
              -
              -
              Parameters:
              +
              +
              Parameters:
              connection - The SQL Connection to wrap
              -
              • -
            +
        + -
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            openSQLite

            -
            public static java.sql.Connection openSQLite​(java.nio.file.Path file)
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              openSQLite

              +
              public static java.sql.Connection openSQLite​(java.nio.file.Path file)
              Opens a SQLite database file
              -
              -
              Parameters:
              +
              +
              Parameters:
              file - The path to the SQLite database file
              -
              Returns:
              +
              Returns:
              The Connection to this SQLite database
              +
              • -
            - - - -
              -
            • -

              openMySQL

              -
              public static java.sql.Connection openMySQL​(java.lang.String ip,
-                                            int port,
-                                            java.lang.String username,
-                                            java.lang.String password,
-                                            java.lang.String database)
              +
            • +
              +

              openMySQL

              +
              public static java.sql.Connection openMySQL​(java.lang.String ip, +int port, +java.lang.String username, +java.lang.String password, +java.lang.String database)
              Opens a connection to a MySQL database
              -
              -
              Parameters:
              +
              +
              Parameters:
              ip - The IP address to connect to
              port - The port to connect to
              username - The username to log in with
              password - The password to log in with
              database - The database to use, will be created if it doesn't exist
              -
              Returns:
              +
              Returns:
              The Connection to the MySQL database
              +
              • -
            - - - -
              -
            • -

              openMySQL

              -
              public static java.sql.Connection openMySQL​(java.lang.String username,
-                                            java.lang.String password,
-                                            java.lang.String database)
              +
            • +
              +

              openMySQL

              +
              public static java.sql.Connection openMySQL​(java.lang.String username, +java.lang.String password, +java.lang.String database)
              Opens a connection to a MySQL database at localhost:3306
              -
              -
              Parameters:
              +
              +
              Parameters:
              username - The username to log in with
              password - The password to log in with
              database - The database to use, will be created if it doesn't exist
              -
              Returns:
              +
              Returns:
              The Connection to the MySQL database
              +
              • -
            - - - -
              -
            • -

              createCache

              -
              public SQLCache createCache​(java.lang.String tableName,
-                            java.lang.String columnName,
-                            java.lang.String... primaryKeyNames)
              +
            • +
              +

              createCache

              +
              public SQLCache createCache​(java.lang.String tableName, +java.lang.String columnName, +java.lang.String... primaryKeyNames)
              Creates and adds cache for a certain column
              -
              -
              Parameters:
              +
              +
              Parameters:
              tableName - The name of the table to create the cache for
              columnName - The name of the column to create the cache for
              primaryKeyNames - The primary keys used to access and mutate the column
              -
              Returns:
              +
              Returns:
              The cache
              +
              • -
            - - - -
              -
            • -

              flushMatchingCaches

              -
              public void flushMatchingCaches​(java.lang.String pattern,
-                                java.lang.Object... primaryKeys)
              +
            • +
              +

              flushMatchingCaches

              +
              public void flushMatchingCaches​(java.lang.String pattern, +java.lang.Object... primaryKeys)
              Finds matching caches by a pattern and flushes a specific entry from them.
              -
              -
              Parameters:
              +
              +
              Parameters:
              pattern - The pattern used for getMatchingCaches(String)
              primaryKeys - The primary keys used to access the entry
              +
              • -
            - - - -
              -
            • -

              removeFromMatchingCaches

              -
              public void removeFromMatchingCaches​(java.lang.String pattern,
-                                     java.lang.Object... primaryKeys)
              +
            • +
              +

              removeFromMatchingCaches

              +
              public void removeFromMatchingCaches​(java.lang.String pattern, +java.lang.Object... primaryKeys)
              Finds matching caches by a pattern and removes a specific entry from them. Useful for saving targeted cached rows when a column in a certain table is changed
              -
              -
              Parameters:
              +
              +
              Parameters:
              pattern - The pattern used for getMatchingCaches(String)
              primaryKeys - The primary keys used to access the entry
              +
              • -
            - - - -
              -
            • -

              flushAndRemoveFromMatchingCaches

              -
              public void flushAndRemoveFromMatchingCaches​(java.lang.String pattern,
-                                             java.lang.Object... primaryKeys)
              +
            • +
              +

              flushAndRemoveFromMatchingCaches

              +
              public void flushAndRemoveFromMatchingCaches​(java.lang.String pattern, +java.lang.Object... primaryKeys)
              Finds matching caches by a pattern and flushes, then removes a specific entry from them.
              -
              -
              Parameters:
              +
              +
              Parameters:
              pattern - The pattern used for getMatchingCaches(String)
              primaryKeys - The primary keys used to access the entry
              +
              • -
            - - - -
              -
            • -

              getMatchingCaches

              -
              public java.util.List<SQLCache> getMatchingCaches​(java.lang.String pattern)
              +
            • +
              +

              getMatchingCaches

              +
              public java.util.List<SQLCache> getMatchingCaches​(java.lang.String pattern)
              Gets the caches matching a pattern
              -
              -
              Parameters:
              +
              +
              Parameters:
              pattern - The pattern to match. Should be formatted as "tableName.primaryKeyColumnName". Use * to indicate all for either tableName or columnName. Use | to indicate or. Primary key column name matches any primary key with the given column name. Useful if you are updating a value in a table and want to flush/remove targeted values from the cache. Example: *.name|team
              -
              Returns:
              +
              Returns:
              The list of matching caches
              +
              • -
            - - - -
              -
            • -

              getCaches

              -
              public java.util.List<SQLCache> getCaches()
              -
              -
              Returns:
              +
            • +
              +

              getCaches

              +
              public java.util.List<SQLCache> getCaches()
              +
              +
              Returns:
              The list of caches for this SQLHelper
              +
              • -
            - - - -
              -
            • -

              flushAllCaches

              -
              public void flushAllCaches()
              +
            • +
              +

              flushAllCaches

              +
              public void flushAllCaches()
              Calls SQLCache.flush() on all caches owned by this SQLHelper
              +
              • -
            - - - -
              -
            • -

              clearAllCaches

              -
              public void clearAllCaches()
              +
            • +
              +

              clearAllCaches

              +
              public void clearAllCaches()
              Calls SQLCache.clear() on all caches owned by this SQLHelper
              +
              • -
            - - - -
              -
            • -

              execute

              -
              public void execute​(java.lang.String command,
-                    java.lang.Object... fields)
              +
            • +
              +

              execute

              +
              public void execute​(java.lang.String command, +java.lang.Object... fields)
              Executes a SQL query as a prepared statement, setting its fields to the elements of the vararg passed
              -
              -
              Parameters:
              +
              +
              Parameters:
              command - The SQL command to execute
              fields - A vararg of the fields to set in the prepared statement
              +
              • -
            - - - -
              -
            • -

              querySingleResult

              -
              public <T> T querySingleResult​(java.lang.String query,
-                               java.lang.Object... fields)
              +
            • +
              +

              querySingleResult

              +
              public <T> T querySingleResult​(java.lang.String query, +java.lang.Object... fields)
              Executes a SQL query as a prepared statement, setting its fields to the elements of the vararg passed, returning the value in the first column of the first row in the results
              -
              -
              Type Parameters:
              +
              +
              Type Parameters:
              T - The type to cast the return value to
              -
              Parameters:
              +
              Parameters:
              query - The SQL query to execute
              fields - A vararg of the fields to set in the prepared statement
              -
              Returns:
              +
              Returns:
              The value in the first column of the first row of the returned results, or null if none is present
              +
              • -
            - - - -
              -
            • -

              querySingleResultString

              -
              public java.lang.String querySingleResultString​(java.lang.String query,
-                                                java.lang.Object... fields)
              +
            • +
              +

              querySingleResultString

              +
              public java.lang.String querySingleResultString​(java.lang.String query, +java.lang.Object... fields)
              Executes a SQL query as a prepared statement, setting its fields to the elements of the vararg passed, returning the value in the first column of the first row in the results as a String.
              -
              -
              Parameters:
              +
              +
              Parameters:
              query - The SQL query to execute
              fields - A vararg of the fields to set in the prepared statement
              -
              Returns:
              +
              Returns:
              The String in the first column of the first row of the returned results, or null if none is present Note: This method exists because ResultSet.getObject(int) can return an Integer if the String in the column can be parsed into one.
              +
              • -
            - - - -
              -
            • -

              querySingleResultLong

              -
              public java.lang.Long querySingleResultLong​(java.lang.String query,
-                                            java.lang.Object... fields)
              +
            • +
              +

              querySingleResultLong

              +
              public java.lang.Long querySingleResultLong​(java.lang.String query, +java.lang.Object... fields)
              Executes a SQL query as a prepared statement, setting its fields to the elements of the vararg passed, returning the value in the first column of the first row in the results as a Long.
              -
              -
              Parameters:
              +
              +
              Parameters:
              query - The SQL query to execute
              fields - A vararg of the fields to set in the prepared statement
              -
              Returns:
              +
              Returns:
              The String in the first column of the first row of the returned results, or null if none is present Note: This method exists because ResultSet.getObject(int) can return an Integer if the Long in the column can be parsed into one.
              +
              • -
            - - - -
              -
            • -

              queryResultList

              -
              public <T> java.util.List<T> queryResultList​(java.lang.String query,
-                                             java.lang.Object... fields)
              +
            • +
              +

              queryResultList

              +
              public <T> java.util.List<T> queryResultList​(java.lang.String query, +java.lang.Object... fields)
              Executes a SQL query as a prepared statement, setting its fields to the elements of the vararg passed, returning a list of values in the first column of each row in the results
              -
              -
              Type Parameters:
              +
              +
              Type Parameters:
              T - The type to populate the list with and return
              -
              Parameters:
              +
              Parameters:
              query - The SQL query to execute
              fields - A vararg of the fields to set in the prepared statement
              -
              Returns:
              +
              Returns:
              A list of the value in the first column of each row returned by the query
              +
              • -
            - - - -
              -
            • -

              queryResultStringList

              -
              public java.util.List<java.lang.String> queryResultStringList​(java.lang.String query,
-                                                              java.lang.Object... fields)
              +
            • +
              +

              queryResultStringList

              +
              public java.util.List<java.lang.String> queryResultStringList​(java.lang.String query, +java.lang.Object... fields)
              Executes a SQL query as a prepared statement, setting its fields to the elements of the vararg passed, returning a String list of values in the first column of each row in the results
              -
              -
              Parameters:
              +
              +
              Parameters:
              query - The SQL query to execute
              fields - A vararg of the fields to set in the prepared statement
              -
              Returns:
              +
              Returns:
              A String list of the value in the first column of each row returned by the query Note: This method exists because ResultSet.getObject(int) can return an Integer if the String in the column can be parsed into one.
              +
              • -
            - - - -
              -
            • -

              queryResults

              -
              public SQLHelper.Results queryResults​(java.lang.String query,
-                                      java.lang.Object... fields)
              +
            • +
              +

              queryResults

              +
              public SQLHelper.Results queryResults​(java.lang.String query, +java.lang.Object... fields)
              Executes a SQL query as a prepared statement, setting its fields to the elements of the vararg passed. Returns a SQLHelper.Results, which wraps a ResultSet for easier use
              -
              -
              Parameters:
              +
              +
              Parameters:
              query - The SQL query to execute
              fields - A vararg of the fields to set in the prepared statement
              -
              Returns:
              +
              Returns:
              The results of the query
              +
              • -
            - - - -
              -
            • -

              getConnection

              -
              public java.sql.Connection getConnection()
              -
              -
              Returns:
              +
            • +
              +

              getConnection

              +
              public java.sql.Connection getConnection()
              +
              +
              Returns:
              The Connection this SQLHelper wraps
              +
              • -
            - - - -
              -
            • -

              setAutoCommit

              -
              public void setAutoCommit​(boolean autoCommit)
              +
            • +
              +

              setAutoCommit

              +
              public void setAutoCommit​(boolean autoCommit)
              Sets the wrapped connection's auto-commit property. Calling this method will automatically disable the task started by setCommitInterval(int).
              -
              -
              Parameters:
              +
              +
              Parameters:
              autoCommit - The auto-commit property - whether it will commit with every command
              +
              • -
            - - - -
              -
            • -

              isAutoCommit

              -
              public boolean isAutoCommit()
              -
              -
              Returns:
              +
            • +
              +

              isAutoCommit

              +
              public boolean isAutoCommit()
              +
              +
              Returns:
              The auto-commit property of the wrapped connection
              +
              • -
            - - - -
              -
            • -

              setCommitInterval

              -
              public void setCommitInterval​(int ticks)
              +
            • +
              +

              setCommitInterval

              +
              public void setCommitInterval​(int ticks)
              Starts a task to call commit() on this SQLHelper every n ticks. Pass -1 to disable. Automatically sets autoCommit to false.
              -
              -
              Parameters:
              +
              +
              Parameters:
              ticks - The number of ticks between commits, or -1 to disable
              +
              • -
            - - - -
              -
            • -

              commit

              -
              public void commit()
              +
            • +
              +

              commit

              +
              public void commit()
              Flushes all caches and commits the transaction
              +
              • -
            - - - -
              -
            • -

              prepareStatement

              -
              public java.sql.PreparedStatement prepareStatement​(java.lang.String query,
-                                                   java.lang.Object... fields)
              +
            • +
              +

              prepareStatement

              +
              public java.sql.PreparedStatement prepareStatement​(java.lang.String query, +java.lang.Object... fields)
              Prepares a statement, setting its fields to the elements of the vararg passed
              -
              -
              Parameters:
              +
              +
              Parameters:
              query - The SQL query to prepare
              fields - A vararg of the fields to set in the prepared statement
              -
              Returns:
              +
              Returns:
              The PreparedStatement with its fields set
              +
              • -
            - - - -
              -
            • -

              close

              -
              public void close()
              +
            • +
              +

              close

              +
              public void close()
              Closes the underlying connection this SQLHelper wraps
              -
              -
              Specified by:
              +
              +
              Specified by:
              close in interface java.lang.AutoCloseable
              -
              Specified by:
              +
              Specified by:
              close in interface java.io.Closeable
              -
              • -
            +
      -
    - - + + + + diff --git a/javadoc/redempt/redlib/sql/package-summary.html b/javadoc/redempt/redlib/sql/package-summary.html index 0fe2659..b18ac94 100644 --- a/javadoc/redempt/redlib/sql/package-summary.html +++ b/javadoc/redempt/redlib/sql/package-summary.html @@ -5,47 +5,30 @@ redempt.redlib.sql (RedLib API) + + - + + - - - - - + + - - -
    +
    + +

    Package redempt.redlib.sql

    -
    -
      -
    • - - +
      +
        +
      • +
        +
      Class Summary 
      + + - - + + + - - - + + - - - + + - - - + +
      Class Summary
      ClassDescriptionClassDescription
      SQLCache +
      SQLCache
      A cache to store the values in a single column of a single SQL table
      SQLHelper +
      SQLHelper
      Wraps a Connection and offers helpful methods that don't need to be surrounded in a try/catch
      SQLHelper.Results +
      SQLHelper.Results
      Wraps a ResultSet with easier use
      +
    -
    +
    + + +
    +
    + diff --git a/javadoc/redempt/redlib/sql/package-tree.html b/javadoc/redempt/redlib/sql/package-tree.html index c120eca..61577de 100644 --- a/javadoc/redempt/redlib/sql/package-tree.html +++ b/javadoc/redempt/redlib/sql/package-tree.html @@ -5,158 +5,91 @@ redempt.redlib.sql Class Hierarchy (RedLib API) + + - + + - - - - - + + - - -
    +
    + +

    Hierarchy For Package redempt.redlib.sql

    -Package Hierarchies: +Package Hierarchies:
    -
    -
    +

    Class Hierarchy

    • java.lang.Object
    -
    +
    +
    diff --git a/javadoc/redempt/redlib/worldgen/CustomBiome.html b/javadoc/redempt/redlib/worldgen/CustomBiome.html index f457be5..7fa3b49 100644 --- a/javadoc/redempt/redlib/worldgen/CustomBiome.html +++ b/javadoc/redempt/redlib/worldgen/CustomBiome.html @@ -5,470 +5,360 @@ CustomBiome (RedLib API) + + - + + - - - - - + + - - -
    +
    +
    + + + +
    - +
    +
    -
    Package redempt.redlib.worldgen
    -

    Class CustomBiome

    +
    Package redempt.redlib.worldgen
    +

    Class CustomBiome

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.worldgen.CustomBiome
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      redempt.redlib.worldgen.CustomBiome
      +
      +
      -
      public abstract class CustomBiome
+
      public abstract class CustomBiome
 extends java.lang.Object
      
-
      Deprecated.
-
      Implementation in progress.
      
-
      
-
      • -
    +
    Deprecated. +
    Implementation in progress.
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Constructor Summary

          - - +
        • +
          +

          Constructor Summary

          +
          +
          • Constructors 
          + + - - + + - - - + + + + +
          Constructors
          ConstructorDescriptionConstructorDescription
          CustomBiome​(java.lang.String name, - int temperature, - int elevationMin, - int elevationMax, - org.bukkit.block.Biome vanillaBiome) -
          Deprecated.
          +
          CustomBiome​(java.lang.String name, +int temperature, +int elevationMin, +int elevationMax, +org.bukkit.block.Biome vanillaBiome) +
          Deprecated.
           
          -
          • -
        +
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods 
      + - - - + + + - - - - + + + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + +
      Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
      abstract voidgenerateColumn​(org.bukkit.generator.ChunkGenerator.ChunkData data, - int cx, - int cz, - int bx, - int bz, - int height) -
      Deprecated.
      +
      abstract voidgenerateColumn​(org.bukkit.generator.ChunkGenerator.ChunkData data, +int cx, +int cz, +int bx, +int bz, +int height) +
      Deprecated.
       
      abstract intgetBlockHeight​(int x, - int z) -
      Deprecated.
      +
      abstract intgetBlockHeight​(int x, +int z) +
      Deprecated.
       
      abstract intgetCaveHeight​(int x, - int z, - int blockHeight) -
      Deprecated.
      +
      abstract intgetCaveHeight​(int x, +int z, +int blockHeight) +
      Deprecated.
       
      intgetElevationMax() -
      Deprecated.
      +
      intgetElevationMax() +
      Deprecated.
       
      intgetElevationMin() -
      Deprecated.
      +
      intgetElevationMin() +
      Deprecated.
       
      java.lang.StringgetName() -
      Deprecated.
      +
      java.lang.StringgetName() +
      Deprecated.
       
      intgetTemperature() -
      Deprecated.
      +
      intgetTemperature() +
      Deprecated.
       
      org.bukkit.block.BiomegetVanillaBiome() -
      Deprecated.
      +
      org.bukkit.block.BiomegetVanillaBiome() +
      Deprecated.
       
      voidprefill​(int cx, - int cz) -
      Deprecated.
      +
      voidprefill​(int cx, +int cz) +
      Deprecated.
       
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

    Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - -
            -
          • -

            CustomBiome

            -
            public CustomBiome​(java.lang.String name,
-                   int temperature,
-                   int elevationMin,
-                   int elevationMax,
-                   org.bukkit.block.Biome vanillaBiome)
            -
            Deprecated.
            -
            • -
          +
        • +
          +

          Constructor Details

          +
            +
          • +
            +

            CustomBiome

            +
            public CustomBiome​(java.lang.String name, +int temperature, +int elevationMin, +int elevationMax, +org.bukkit.block.Biome vanillaBiome)
            +
            Deprecated.
            +
          - -
          -
            -
          • - - -

            Method Detail

            - - - -
              -
            • -

              generateColumn

              -
              public abstract void generateColumn​(org.bukkit.generator.ChunkGenerator.ChunkData data,
-                                    int cx,
-                                    int cz,
-                                    int bx,
-                                    int bz,
-                                    int height)
              -
              Deprecated.
              • -
            - - - -
              -
            • -

              getBlockHeight

              -
              public abstract int getBlockHeight​(int x,
-                                   int z)
              -
              Deprecated.
              + +
            • +
              +

              Method Details

              +
                +
              • +
                +

                generateColumn

                +
                public abstract void generateColumn​(org.bukkit.generator.ChunkGenerator.ChunkData data, +int cx, +int cz, +int bx, +int bz, +int height)
                +
                Deprecated.
                +
                • -
              - - - -
                -
              • -

                getCaveHeight

                -
                public abstract int getCaveHeight​(int x,
-                                  int z,
-                                  int blockHeight)
                -
                Deprecated.
                +
              • +
                +

                getBlockHeight

                +
                public abstract int getBlockHeight​(int x, +int z)
                +
                Deprecated.
                +
                • -
              - - - -
                -
              • -

                getName

                -
                public java.lang.String getName()
                -
                Deprecated.
                +
              • +
                +

                getCaveHeight

                +
                public abstract int getCaveHeight​(int x, +int z, +int blockHeight)
                +
                Deprecated.
                +
                • -
              - - - -
                -
              • -

                getTemperature

                -
                public int getTemperature()
                -
                Deprecated.
                +
              • +
                +

                getName

                +
                public java.lang.String getName()
                +
                Deprecated.
                +
                • -
              - - - -
                -
              • -

                getElevationMin

                -
                public int getElevationMin()
                -
                Deprecated.
                +
              • +
                +

                getTemperature

                +
                public int getTemperature()
                +
                Deprecated.
                +
                • -
              - - - -
                -
              • -

                getElevationMax

                -
                public int getElevationMax()
                -
                Deprecated.
                +
              • +
                +

                getElevationMin

                +
                public int getElevationMin()
                +
                Deprecated.
                +
                • -
              - - - -
                -
              • -

                getVanillaBiome

                -
                public org.bukkit.block.Biome getVanillaBiome()
                -
                Deprecated.
                +
              • +
                +

                getElevationMax

                +
                public int getElevationMax()
                +
                Deprecated.
                +
                • -
              - - - -
                -
              • -

                prefill

                -
                public void prefill​(int cx,
-                    int cz)
                -
                Deprecated.
                +
              • +
                +

                getVanillaBiome

                +
                public org.bukkit.block.Biome getVanillaBiome()
                +
                Deprecated.
                +
                • -
              +
            • +
              +

              prefill

              +
              public void prefill​(int cx, +int cz)
              +
              Deprecated.
              +
        -
    - - + + + + diff --git a/javadoc/redempt/redlib/worldgen/CustomWorldGenerator.html b/javadoc/redempt/redlib/worldgen/CustomWorldGenerator.html index a5700ca..5522197 100644 --- a/javadoc/redempt/redlib/worldgen/CustomWorldGenerator.html +++ b/javadoc/redempt/redlib/worldgen/CustomWorldGenerator.html @@ -5,406 +5,296 @@ CustomWorldGenerator (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.worldgen
    -

    Class CustomWorldGenerator

    +
    Package redempt.redlib.worldgen
    +

    Class CustomWorldGenerator

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • org.bukkit.generator.ChunkGenerator
        • -
      • -
          -
        • redempt.redlib.worldgen.CustomWorldGenerator
          • -
        -
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      org.bukkit.generator.ChunkGenerator +
      redempt.redlib.worldgen.CustomWorldGenerator
      +
      +
      +
      -
      public class CustomWorldGenerator
+
      public class CustomWorldGenerator
 extends org.bukkit.generator.ChunkGenerator
      
-
      Deprecated.
-
      Implementation in progress.
      
-
      
-
      • -
    +
    Deprecated. +
    Implementation in progress.
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Nested Class Summary

          -
            -
          • - - -

            Nested classes/interfaces inherited from class org.bukkit.generator.ChunkGenerator

            -org.bukkit.generator.ChunkGenerator.BiomeGrid, org.bukkit.generator.ChunkGenerator.ChunkData
            • -
          -
          • -
        +
      • +
        +

        Nested Class Summary

        +
        +

        Nested classes/interfaces inherited from class org.bukkit.generator.ChunkGenerator

        +org.bukkit.generator.ChunkGenerator.BiomeGrid, org.bukkit.generator.ChunkGenerator.ChunkData
        +
        • -
        - +
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Instance Methods Concrete Methods Deprecated Methods 
      + - - - + + + - - - - + + + + + - - - - + + + - - - - + + + - - - - + + + +
      Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
      org.bukkit.generator.ChunkGenerator.ChunkDatagenerateChunkData​(org.bukkit.World world, - java.util.Random random, - int x, - int z, - org.bukkit.generator.ChunkGenerator.BiomeGrid biome) -
      Deprecated.
      +
      org.bukkit.generator.ChunkGenerator.ChunkDatagenerateChunkData​(org.bukkit.World world, +java.util.Random random, +int x, +int z, +org.bukkit.generator.ChunkGenerator.BiomeGrid biome) +
      Deprecated.
       
      booleanisParallelCapable() -
      Deprecated.
      +
      booleanisParallelCapable() +
      Deprecated.
       
      voidsetBiomeSize​(double size) -
      Deprecated.
      +
      voidsetBiomeSize​(double size) +
      Deprecated.
       
      voidsetSeed​(long seed) -
      Deprecated.
      +
      voidsetSeed​(long seed) +
      Deprecated.
       
      -
        -
      • - - -

        Methods inherited from class org.bukkit.generator.ChunkGenerator

        -canSpawn, createChunkData, getDefaultPopulators, getFixedSpawnLocation, shouldGenerateCaves, shouldGenerateDecorations, shouldGenerateMobs, shouldGenerateStructures
        • -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

    Methods inherited from class org.bukkit.generator.ChunkGenerator

    +canSpawn, createChunkData, getDefaultPopulators, getFixedSpawnLocation, shouldGenerateCaves, shouldGenerateDecorations, shouldGenerateMobs, shouldGenerateStructures
    +
    +

    Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - -
            -
          • -

            CustomWorldGenerator

            -
            public CustomWorldGenerator​(long seed,
-                            CustomBiome... biomes)
            -
            Deprecated.
            -
            • -
          +
        • +
          +

          Constructor Details

          +
            +
          • +
            +

            CustomWorldGenerator

            +
            public CustomWorldGenerator​(long seed, +CustomBiome... biomes)
            +
            Deprecated.
            +
          +
          • -
          -
            -
          • - - -

            Method Detail

            - - - -
              -
            • -

              setBiomeSize

              -
              public void setBiomeSize​(double size)
              -
              Deprecated.
              +
            • +
              +

              Method Details

              +
                +
              • +
                +

                setBiomeSize

                +
                public void setBiomeSize​(double size)
                +
                Deprecated.
                +
                • -
              - - - -
                -
              • -

                setSeed

                -
                public void setSeed​(long seed)
                -
                Deprecated.
                +
              • +
                +

                setSeed

                +
                public void setSeed​(long seed)
                +
                Deprecated.
                +
                • -
              - - - -
                -
              • -

                isParallelCapable

                -
                public boolean isParallelCapable()
                -
                Deprecated.
                -
                -
                Overrides:
                +
              • +
                +

                isParallelCapable

                +
                public boolean isParallelCapable()
                +
                Deprecated.
                +
                +
                Overrides:
                isParallelCapable in class org.bukkit.generator.ChunkGenerator
                +
                • -
              - - - -
                -
              • -

                generateChunkData

                -
                public org.bukkit.generator.ChunkGenerator.ChunkData generateChunkData​(org.bukkit.World world,
-                                                                       java.util.Random random,
-                                                                       int x,
-                                                                       int z,
-                                                                       org.bukkit.generator.ChunkGenerator.BiomeGrid biome)
                -
                Deprecated.
                -
                -
                Overrides:
                +
              • +
                +

                generateChunkData

                +
                public org.bukkit.generator.ChunkGenerator.ChunkData generateChunkData​(org.bukkit.World world, +java.util.Random random, +int x, +int z, +org.bukkit.generator.ChunkGenerator.BiomeGrid biome)
                +
                Deprecated.
                +
                +
                Overrides:
                generateChunkData in class org.bukkit.generator.ChunkGenerator
                -
                • -
              +
        -
    -
    - + + + + diff --git a/javadoc/redempt/redlib/worldgen/NoiseGenerator.html b/javadoc/redempt/redlib/worldgen/NoiseGenerator.html index c809a17..f1c62ed 100644 --- a/javadoc/redempt/redlib/worldgen/NoiseGenerator.html +++ b/javadoc/redempt/redlib/worldgen/NoiseGenerator.html @@ -5,425 +5,341 @@ NoiseGenerator (RedLib API) + + - + + - - - - - + + - - -
    +
    + - +
    +
    -
    Package redempt.redlib.worldgen
    -

    Class NoiseGenerator

    +
    Package redempt.redlib.worldgen
    +

    Class NoiseGenerator

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.worldgen.NoiseGenerator
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      redempt.redlib.worldgen.NoiseGenerator
      +
      +
      -
      public class NoiseGenerator
+
      public class NoiseGenerator
 extends java.lang.Object
      
 
      A Perlin Noise generator which can be faster than PerlinNoiseGenerator
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Constructor Summary

          - - +
        • +
          +

          Constructor Summary

          +
          +
          • Constructors 
          + + - - + + - - - + + + + - - - + + +
          Constructors
          ConstructorDescriptionConstructorDescription
          NoiseGenerator() +
          NoiseGenerator()
          Creates a noise generator with a random seed
          NoiseGenerator​(long seed) +
          NoiseGenerator​(long seed)
          Creates a noise generator with a seed
          -
          • -
        +
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Static Methods Instance Methods Concrete Methods 
      + - - - + + + - - - - + + + + + + - - - - + + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + +
      Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
      doublegetScale() 
      doublegetScale() 
      doublegetWeight() 
      doublegetWeight() 
      doublenoise​(double x, - double z) +
      doublenoise​(double x, +double z)
      Gets a noise value at a specific 2D point
      doublenoise​(double x, - double y, - double z) +
      doublenoise​(double x, +double y, +double z)
      Gets a noise value at a specific 3D point
      voidprefill​(int x, - int z, - int width, - int length) +
      voidprefill​(int x, +int z, +int width, +int length)
      Pre-fills the gradient vectors in the specified area of this noise generator.
      voidprefill​(int x, - int y, - int z, - int width, - int height, - int length) +
      voidprefill​(int x, +int y, +int z, +int width, +int height, +int length)
      Pre-fills the gradient vectors in the specified area of this noise generator.
      voidsetScale​(double scale) +
      voidsetScale​(double scale)
      Sets the scale of this noise generator.
      voidsetSeed​(long seed) +
      voidsetSeed​(long seed)
      Set the seed of this noise generator
      voidsetWeight​(double weight) +
      voidsetWeight​(double weight)
      Sets the weight of this noise generator.
      static doublesmoothstep​(double first, - double second, - double w) +
      static doublesmoothstep​(double first, +double second, +double w)
      Smoothly interpolates between two values
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

    Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - -
            -
          • -

            NoiseGenerator

            -
            public NoiseGenerator​(long seed)
            +
          • +
            +

            Constructor Details

            +
              +
            • +
              +

              NoiseGenerator

              +
              public NoiseGenerator​(long seed)
              Creates a noise generator with a seed
              -
              -
              Parameters:
              +
              +
              Parameters:
              seed - The seed to use
              +
              • -
            - - - -
              -
            • -

              NoiseGenerator

              -
              public NoiseGenerator()
              +
            • +
              +

              NoiseGenerator

              +
              public NoiseGenerator()
              Creates a noise generator with a random seed
              -
              • -
            +
        + -
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            smoothstep

            -
            public static double smoothstep​(double first,
-                                double second,
-                                double w)
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              smoothstep

              +
              public static double smoothstep​(double first, +double second, +double w)
              Smoothly interpolates between two values
              -
              -
              Parameters:
              +
              +
              Parameters:
              first - The first value
              second - The second value
              w - The ratio
              -
              Returns:
              +
              Returns:
              The smoothly interpolated value
              +
              • -
            - - - -
              -
            • -

              setScale

              -
              public void setScale​(double scale)
              +
            • +
              +

              setScale

              +
              public void setScale​(double scale)
              Sets the scale of this noise generator. All inputs will be multiplied by the scale. Default value is 1.
              -
              -
              Parameters:
              +
              +
              Parameters:
              scale - The scale to set
              +
              • -
            - - - -
              -
            • -

              setWeight

              -
              public void setWeight​(double weight)
              +
            • +
              +

              setWeight

              +
              public void setWeight​(double weight)
              Sets the weight of this noise generator. All outputs will be multiplied by the weight. Default value is 1.
              -
              -
              Parameters:
              +
              +
              Parameters:
              weight - The weight to set
              +
              • -
            - - - -
              -
            • -

              getScale

              -
              public double getScale()
              -
              -
              Returns:
              +
            • +
              +

              getScale

              +
              public double getScale()
              +
              +
              Returns:
              The scale of this noise generator
              +
              • -
            - - - -
              -
            • -

              getWeight

              -
              public double getWeight()
              -
              -
              Returns:
              +
            • +
              +

              getWeight

              +
              public double getWeight()
              +
              +
              Returns:
              The weight of this noise generator
              +
              • -
            - - - -
              -
            • -

              setSeed

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

              setSeed

              +
              public void setSeed​(long seed)
              Set the seed of this noise generator
              -
              -
              Parameters:
              +
              +
              Parameters:
              seed - The seed to set
              +
              • -
            - - - -
              -
            • -

              prefill

              -
              public void prefill​(int x,
-                    int y,
-                    int z,
-                    int width,
-                    int height,
-                    int length)
              +
            • +
              +

              prefill

              +
              public void prefill​(int x, +int y, +int z, +int width, +int height, +int length)
              Pre-fills the gradient vectors in the specified area of this noise generator. Call this method if you know what region you are going to be repeatedly requesting noise values from, as it significantly improves performance. Inputs for this method are scaled according to the scale of this noise generator.
              -
              -
              Parameters:
              +
              +
              Parameters:
              x - The X coordinate to generate starting at
              y - The Y coordinate to generate starting at
              z - The Z coordiante to generate starting at
              @@ -431,136 +347,104 @@

              prefill

              height - The height along the Y-axis to fill
              length - The length along the Z-axis to fill
              +
              • -
            - - - -
              -
            • -

              prefill

              -
              public void prefill​(int x,
-                    int z,
-                    int width,
-                    int length)
              +
            • +
              +

              prefill

              +
              public void prefill​(int x, +int z, +int width, +int length)
              Pre-fills the gradient vectors in the specified area of this noise generator. Call this method if you know what region you are going to be repeatedly requesting noise values from, as it significantly improves performance. Inputs for this method are scaled according to the scale of this noise generator.
              -
              -
              Parameters:
              +
              +
              Parameters:
              x - The X coordinate to generate starting at
              z - The Z coordiante to generate starting at
              width - The width along the X-axis to fill
              length - The length along the Z-axis to fill
              +
              • -
            - - - -
              -
            • -

              noise

              -
              public double noise​(double x,
-                    double z)
              +
            • +
              +

              noise

              +
              public double noise​(double x, +double z)
              Gets a noise value at a specific 2D point
              -
              -
              Parameters:
              +
              +
              Parameters:
              x - The X coordinate to get the noise at
              z - The Z coordinate to get the noise at
              -
              Returns:
              +
              Returns:
              A noise value between the weight and the negative weight
              +
              • -
            - - - -
              -
            • -

              noise

              -
              public double noise​(double x,
-                    double y,
-                    double z)
              +
            • +
              +

              noise

              +
              public double noise​(double x, +double y, +double z)
              Gets a noise value at a specific 3D point
              -
              -
              Parameters:
              +
              +
              Parameters:
              x - The X coordinate to get the noise at
              y - The Y coordinate to get the noise at
              z - The Z coordinate to get the noise at
              -
              Returns:
              +
              Returns:
              A noise value between the weight and the negative weight
              -
              • -
            +
      -
    - - + + + + diff --git a/javadoc/redempt/redlib/worldgen/NoiseOctave.html b/javadoc/redempt/redlib/worldgen/NoiseOctave.html index 5968ea0..82f12bf 100644 --- a/javadoc/redempt/redlib/worldgen/NoiseOctave.html +++ b/javadoc/redempt/redlib/worldgen/NoiseOctave.html @@ -5,410 +5,329 @@ NoiseOctave (RedLib API) + + - + + - - - - - + + - - -
    +
    +
    + + + +
    - +
    +
    -
    Package redempt.redlib.worldgen
    -

    Class NoiseOctave

    +
    Package redempt.redlib.worldgen
    +

    Class NoiseOctave

    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • redempt.redlib.worldgen.NoiseOctave
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      redempt.redlib.worldgen.NoiseOctave
      +
      +
      -
      public class NoiseOctave
+
      public class NoiseOctave
 extends java.lang.Object
      
 
      Used to generate noise values for octaves of Perlin Noise
      
-
      • -
    -
    -
    -
      -
    • + +
      +
        -
        -
          -
        • - - -

          Constructor Summary

          - - +
        • +
          +

          Constructor Summary

          +
          +
          • Constructors 
          + + - - + + - - - + + + + - - - + + +
          Constructors
          ConstructorDescriptionConstructorDescription
          NoiseOctave​(int size) +
          NoiseOctave​(int size)
          Creates a noise octave with a random seed
          NoiseOctave​(long seed, - int size) +
          NoiseOctave​(long seed, +int size)
          Creates a noise octave with the given seed and size.
          -
          • -
        +
    + -
    -
      -
    • - - -

      Method Summary

      - - +
    • +
      +

      Method Summary

      +
      +
      +
      +
      • All Methods Instance Methods Concrete Methods 
      + - - - + + + - - - - + + + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + - - - - + + + + +
      Modifier and TypeMethodDescriptionModifier and TypeMethodDescription
      doublenoise​(double x, - double z) +
      doublenoise​(double x, +double z)
      Gets the noise value at the given point
      doublenoise​(double x, - double y, - double z) +
      doublenoise​(double x, +double y, +double z)
      Gets the noise value at the given point
      voidprefill​(int x, - int z, - int width, - int length) +
      voidprefill​(int x, +int z, +int width, +int length)
      Pre-fills gradient vectors in the noise generators in this octave for the given region.
      voidprefill​(int x, - int y, - int z, - int width, - int height, - int length) +
      voidprefill​(int x, +int y, +int z, +int width, +int height, +int length)
      Pre-fills gradient vectors in the noise generators in this octave for the given region.
      voidsetScales​(double... scales) +
      voidsetScales​(double... scales)
      Sets the scale of every noise generator in this octave
      voidsetSeed​(long seed) +
      voidsetSeed​(long seed)
      Sets the seed of this noise octave.
      voidsetWeights​(double... weights) +
      voidsetWeights​(double... weights)
      Sets the weight of every noise generator in this octave
      intsize() 
      intsize() 
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

    Methods inherited from class java.lang.Object

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

          Constructor Detail

          - - - -
            -
          • -

            NoiseOctave

            -
            public NoiseOctave​(long seed,
-                   int size)
            +
          • +
            +

            Constructor Details

            +
              +
            • +
              +

              NoiseOctave

              +
              public NoiseOctave​(long seed, +int size)
              Creates a noise octave with the given seed and size. All noise generators within this octave will be initialized with the seed plus their position inside this octave.
              -
              -
              Parameters:
              +
              +
              Parameters:
              seed - The seed to use
              size - The number of noise generators to use
              +
              • -
            - - - -
              -
            • -

              NoiseOctave

              -
              public NoiseOctave​(int size)
              +
            • +
              +

              NoiseOctave

              +
              public NoiseOctave​(int size)
              Creates a noise octave with a random seed
              -
              -
              Parameters:
              +
              +
              Parameters:
              size - The number of noise generators to use
              -
              • -
            +
        + -
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            setSeed

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

            Method Details

            +
              +
            • +
              +

              setSeed

              +
              public void setSeed​(long seed)
              Sets the seed of this noise octave.
              -
              -
              Parameters:
              +
              +
              Parameters:
              seed - The seed to set
              +
              • -
            - - - -
              -
            • -

              size

              -
              public int size()
              -
              -
              Returns:
              +
            • +
              +

              size

              +
              public int size()
              +
              +
              Returns:
              The size of this noise octave
              +
              • -
            - - - -
              -
            • -

              setScales

              -
              public void setScales​(double... scales)
              +
            • +
              +

              setScales

              +
              public void setScales​(double... scales)
              Sets the scale of every noise generator in this octave
              -
              -
              Parameters:
              +
              +
              Parameters:
              scales - A vararg of scales to set. The length of this vararg must be the same as the size of this noise octave.
              +
              • -
            - - - -
              -
            • -

              setWeights

              -
              public void setWeights​(double... weights)
              +
            • +
              +

              setWeights

              +
              public void setWeights​(double... weights)
              Sets the weight of every noise generator in this octave
              -
              -
              Parameters:
              +
              +
              Parameters:
              weights - A vararg of weights to set. The length of this vararg must be the same as the size of this noise octave.
              +
              • -
            - - - -
              -
            • -

              prefill

              -
              public void prefill​(int x,
-                    int z,
-                    int width,
-                    int length)
              +
            • +
              +

              prefill

              +
              public void prefill​(int x, +int z, +int width, +int length)
              Pre-fills gradient vectors in the noise generators in this octave for the given region. Call this method whenever you know a region you will be repeatedly requesting noise values from, as it significantly increases performance.
              -
              -
              Parameters:
              +
              +
              Parameters:
              x - The X coordinate to generate starting at
              z - The Z coordinate to generate starting at
              width - The width along the X-axis to fill
              length - The length along the Z-axis to fill
              +
              • -
            - - - -
              -
            • -

              prefill

              -
              public void prefill​(int x,
-                    int y,
-                    int z,
-                    int width,
-                    int height,
-                    int length)
              +
            • +
              +

              prefill

              +
              public void prefill​(int x, +int y, +int z, +int width, +int height, +int length)
              Pre-fills gradient vectors in the noise generators in this octave for the given region. Call this method whenever you know a region you will be repeatedly requesting noise values from, as it significantly increases performance.
              -
              -
              Parameters:
              +
              +
              Parameters:
              x - The X coordinate to generate starting at
              y - The Y coordinate to generate starting at
              z - The Z coordinate to generate starting at
              @@ -416,114 +335,85 @@

              prefill

              height - The height along the Y-axis to fill
              length - The length along the Z-axis to fill
              +
              • -
            - - - -
              -
            • -

              noise

              -
              public double noise​(double x,
-                    double z)
              +
            • +
              +

              noise

              +
              public double noise​(double x, +double z)
              Gets the noise value at the given point
              -
              -
              Parameters:
              +
              +
              Parameters:
              x - The X coordinate to get noise at
              z - The Z coordinate to get noise at
              -
              Returns:
              +
              Returns:
              A noise value between -1 and 1
              +
              • -
            - - - -
              -
            • -

              noise

              -
              public double noise​(double x,
-                    double y,
-                    double z)
              +
            • +
              +

              noise

              +
              public double noise​(double x, +double y, +double z)
              Gets the noise value at the given point
              -
              -
              Parameters:
              +
              +
              Parameters:
              x - The X coordinate to get noise at
              y - The Y coordinate to get noise at
              z - The Z coordinate to get noise at
              -
              Returns:
              +
              Returns:
              A noise value between -1 and 1
              -
              • -
            +
      -
    - - + + + + diff --git a/javadoc/redempt/redlib/worldgen/package-summary.html b/javadoc/redempt/redlib/worldgen/package-summary.html index 1cc08bf..7c13187 100644 --- a/javadoc/redempt/redlib/worldgen/package-summary.html +++ b/javadoc/redempt/redlib/worldgen/package-summary.html @@ -5,47 +5,30 @@ redempt.redlib.worldgen (RedLib API) + + - + + - - - - - + + - - -
    +
    + +

    Package redempt.redlib.worldgen

    -
    -
    -
    +
    + + +
    +
    + diff --git a/javadoc/redempt/redlib/worldgen/package-tree.html b/javadoc/redempt/redlib/worldgen/package-tree.html index 2331ec6..c8eec8e 100644 --- a/javadoc/redempt/redlib/worldgen/package-tree.html +++ b/javadoc/redempt/redlib/worldgen/package-tree.html @@ -5,163 +5,96 @@ redempt.redlib.worldgen Class Hierarchy (RedLib API) + + - + + - - - - - + + - - -
    +
    + +

    Hierarchy For Package redempt.redlib.worldgen

    -Package Hierarchies: +Package Hierarchies:
    -
    -
    +

    Class Hierarchy

    -
    +
    +
    diff --git a/javadoc/jquery/images/ui-bg_glass_55_fbf9ee_1x400.png b/javadoc/script-dir/images/ui-bg_glass_55_fbf9ee_1x400.png similarity index 100% rename from javadoc/jquery/images/ui-bg_glass_55_fbf9ee_1x400.png rename to javadoc/script-dir/images/ui-bg_glass_55_fbf9ee_1x400.png diff --git a/javadoc/jquery/images/ui-bg_glass_65_dadada_1x400.png b/javadoc/script-dir/images/ui-bg_glass_65_dadada_1x400.png similarity index 100% rename from javadoc/jquery/images/ui-bg_glass_65_dadada_1x400.png rename to javadoc/script-dir/images/ui-bg_glass_65_dadada_1x400.png diff --git a/javadoc/jquery/images/ui-bg_glass_75_dadada_1x400.png b/javadoc/script-dir/images/ui-bg_glass_75_dadada_1x400.png similarity index 100% rename from javadoc/jquery/images/ui-bg_glass_75_dadada_1x400.png rename to javadoc/script-dir/images/ui-bg_glass_75_dadada_1x400.png diff --git a/javadoc/jquery/images/ui-bg_glass_75_e6e6e6_1x400.png b/javadoc/script-dir/images/ui-bg_glass_75_e6e6e6_1x400.png similarity index 100% rename from javadoc/jquery/images/ui-bg_glass_75_e6e6e6_1x400.png rename to javadoc/script-dir/images/ui-bg_glass_75_e6e6e6_1x400.png diff --git a/javadoc/jquery/images/ui-bg_glass_95_fef1ec_1x400.png b/javadoc/script-dir/images/ui-bg_glass_95_fef1ec_1x400.png similarity index 100% rename from javadoc/jquery/images/ui-bg_glass_95_fef1ec_1x400.png rename to javadoc/script-dir/images/ui-bg_glass_95_fef1ec_1x400.png diff --git a/javadoc/jquery/images/ui-bg_highlight-soft_75_cccccc_1x100.png b/javadoc/script-dir/images/ui-bg_highlight-soft_75_cccccc_1x100.png similarity index 100% rename from javadoc/jquery/images/ui-bg_highlight-soft_75_cccccc_1x100.png rename to javadoc/script-dir/images/ui-bg_highlight-soft_75_cccccc_1x100.png diff --git a/javadoc/jquery/images/ui-icons_222222_256x240.png b/javadoc/script-dir/images/ui-icons_222222_256x240.png similarity index 100% rename from javadoc/jquery/images/ui-icons_222222_256x240.png rename to javadoc/script-dir/images/ui-icons_222222_256x240.png diff --git a/javadoc/jquery/images/ui-icons_2e83ff_256x240.png b/javadoc/script-dir/images/ui-icons_2e83ff_256x240.png similarity index 100% rename from javadoc/jquery/images/ui-icons_2e83ff_256x240.png rename to javadoc/script-dir/images/ui-icons_2e83ff_256x240.png diff --git a/javadoc/jquery/images/ui-icons_454545_256x240.png b/javadoc/script-dir/images/ui-icons_454545_256x240.png similarity index 100% rename from javadoc/jquery/images/ui-icons_454545_256x240.png rename to javadoc/script-dir/images/ui-icons_454545_256x240.png diff --git a/javadoc/jquery/images/ui-icons_888888_256x240.png b/javadoc/script-dir/images/ui-icons_888888_256x240.png similarity index 100% rename from javadoc/jquery/images/ui-icons_888888_256x240.png rename to javadoc/script-dir/images/ui-icons_888888_256x240.png diff --git a/javadoc/jquery/images/ui-icons_cd0a0a_256x240.png b/javadoc/script-dir/images/ui-icons_cd0a0a_256x240.png similarity index 100% rename from javadoc/jquery/images/ui-icons_cd0a0a_256x240.png rename to javadoc/script-dir/images/ui-icons_cd0a0a_256x240.png diff --git a/javadoc/script-dir/jquery-3.5.1.min.js b/javadoc/script-dir/jquery-3.5.1.min.js new file mode 100644 index 0000000..b061403 --- /dev/null +++ b/javadoc/script-dir/jquery-3.5.1.min.js @@ -0,0 +1,2 @@ +/*! jQuery v3.5.1 | (c) JS Foundation and other contributors | jquery.org/license */ +!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],r=Object.getPrototypeOf,s=t.slice,g=t.flat?function(e){return t.flat.call(e)}:function(e){return t.concat.apply([],e)},u=t.push,i=t.indexOf,n={},o=n.toString,v=n.hasOwnProperty,a=v.toString,l=a.call(Object),y={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType},x=function(e){return null!=e&&e===e.window},E=C.document,c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.5.1",S=function(e,t){return new S.fn.init(e,t)};function p(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&y(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!v||!v.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ye(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace($,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ve(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ye(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e.namespaceURI,n=(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],v=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&v.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||v.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||v.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||v.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||v.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||v.push(".#.+[+~]"),e.querySelectorAll("\\\f"),v.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&v.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&v.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&v.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),v.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),v=v.length&&new RegExp(v.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),y=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},D=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&y(p,e)?-1:t==C||t.ownerDocument==p&&y(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!v||!v.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function D(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||j,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,j=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),y.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="",y.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="",y.option=!!ce.lastChild;var ge={thead:[1,"","
    "],col:[2,"","
    "],tr:[2,"","
    "],td:[3,"","
    "],_default:[0,"",""]};function ve(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ye(e,t){for(var n=0,r=e.length;n",""]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function qe(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function Le(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function He(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Oe(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var Ut,Xt=[],Vt=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=Xt.pop()||S.expando+"_"+Ct.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Vt.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Vt.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Vt,"$1"+r):!1!==e.jsonp&&(e.url+=(Et.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,Xt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),y.createHTMLDocument=((Ut=E.implementation.createHTMLDocument("").body).innerHTML="
    ",2===Ut.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(y.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):("number"==typeof f.top&&(f.top+="px"),"number"==typeof f.left&&(f.left+="px"),c.css(f))}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return $(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=$e(y.pixelPosition,function(e,t){if(t)return t=Be(e,n),Me.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return $(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 0 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")); - }); + createElem(doc, tag, 'module-search-index.js'); + createElem(doc, tag, 'package-search-index.js'); + createElem(doc, tag, 'type-search-index.js'); + createElem(doc, tag, 'member-search-index.js'); + createElem(doc, tag, 'tag-search-index.js'); } function createElem(doc, tag, path) { @@ -129,21 +60,44 @@ function show(type) { } function updateTabs(type) { + var firstRow = document.getElementById(Object.keys(data)[0]); + var table = firstRow.closest('table'); for (var value in tabs) { - var sNode = document.getElementById(tabs[value][0]); - var spanNode = sNode.firstChild; + var tab = document.getElementById(tabs[value][0]); if (value == type) { - sNode.className = activeTableTab; - spanNode.innerHTML = tabs[value][1]; + tab.className = activeTableTab; + tab.innerHTML = tabs[value][1]; + tab.setAttribute('aria-selected', true); + tab.setAttribute('tabindex',0); + table.setAttribute('aria-labelledby', tabs[value][0]); } else { - sNode.className = tableTab; - spanNode.innerHTML = "" + tabs[value][1] + ""; + tab.className = tableTab; + tab.setAttribute('aria-selected', false); + tab.setAttribute('tabindex',-1); + tab.setAttribute('onclick', "show("+ value + ")"); + tab.innerHTML = tabs[value][1]; } } } -function updateModuleFrame(pFrame, cFrame) { - top.packageFrame.location = pFrame; - top.classFrame.location = cFrame; +function switchTab(e) { + if (e.keyCode == 37 || e.keyCode == 38) { + $("[aria-selected=true]").prev().click().focus(); + e.preventDefault(); + } + if (e.keyCode == 39 || e.keyCode == 40) { + $("[aria-selected=true]").next().click().focus(); + e.preventDefault(); + } +} + +var updateSearchResults = function() {}; + +function indexFilesLoaded() { + return moduleSearchIndex + && packageSearchIndex + && typeSearchIndex + && memberSearchIndex + && tagSearchIndex; } diff --git a/javadoc/search.js b/javadoc/search.js index b773531..9d19ba1 100644 --- a/javadoc/search.js +++ b/javadoc/search.js @@ -1,5 +1,5 @@ /* - * Copyright (c) 2015, 2018, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2015, 2020, 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 @@ -24,43 +24,73 @@ */ var noResult = {l: "No results found"}; +var loading = {l: "Loading search index..."}; 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; +var highlight = "$&"; +var searchPattern = ""; +var RANKING_THRESHOLD = 2; +var NO_MATCH = 0xffff; +var MAX_RESULTS_PER_CATEGORY = 500; +var UNNAMED = ""; +function escapeHtml(str) { + return str.replace(//g, ">"); +} +function getHighlightedText(item, matcher) { + var escapedItem = escapeHtml(item); + return escapedItem.replace(matcher, highlight); } 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) { + 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.category === catMembers) { + if (ui.item.m) { + urlPrefix = ui.item.m + slash; + } else { $.each(packageSearchIndex, function(index, item) { - if (ui.item.p == item.l) { + if (item.m && ui.item.p === item.l) { urlPrefix = item.m + slash; } }); - return urlPrefix; - } else { - return urlPrefix; } + return urlPrefix; } return urlPrefix; } +function makeCamelCaseRegex(term) { + var pattern = ""; + var isWordToken = false; + term.replace(/,\s*/g, ", ").trim().split(/\s+/).forEach(function(w, index) { + if (index > 0) { + // whitespace between identifiers is significant + pattern += (isWordToken && /^\w/.test(w)) ? "\\s+" : "\\s*"; + } + var tokens = w.split(/(?=[A-Z,.()<>[\/])/); + for (var i = 0; i < tokens.length; i++) { + var s = tokens[i]; + if (s === "") { + continue; + } + pattern += $.ui.autocomplete.escapeRegex(s); + isWordToken = /\w$/.test(s); + if (isWordToken) { + pattern += "([a-z0-9_$<>\\[\\]]*?)"; + } + } + }); + return pattern; +} +function createMatcher(pattern, flags) { + var isCamelCase = /[A-Z]/.test(pattern); + return new RegExp(pattern, flags + (isCamelCase ? "" : "i")); +} var watermark = 'Search'; $(function() { $("#search").val(''); @@ -72,7 +102,7 @@ $(function() { $(this).val(watermark).addClass('watermark'); } }); - $("#search").on('click keydown', function() { + $("#search").on('click keydown paste', function() { if ($(this).val() == watermark) { $(this).val('').removeClass('watermark'); } @@ -90,41 +120,42 @@ $.widget("custom.catcomplete", $.ui.autocomplete, { this.widget().menu("option", "items", "> :not(.ui-autocomplete-category)"); }, _renderMenu: function(ul, items) { - var rMenu = this, - currentCategory = ""; + var rMenu = this; + var currentCategory = ""; rMenu.menu.bindings = $(); $.each(items, function(index, item) { var li; - if (item.l !== noResult.l && item.category !== currentCategory) { + if (item.category && 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"); + li.attr("class", "result-item"); } else { li.attr("aria-label", item.l); - li.attr("class", "resultItem"); + li.attr("class", "result-item"); } }); }, _renderItem: function(ul, item) { var label = ""; + var matcher = createMatcher(escapeHtml(searchPattern), "g"); if (item.category === catModules) { - label = getHighlightedText(item.l); + label = getHighlightedText(item.l, matcher); } else if (item.category === catPackages) { - label = (item.m) - ? getHighlightedText(item.m + "/" + item.l) - : getHighlightedText(item.l); + label = getHighlightedText(item.l, matcher); } else if (item.category === catTypes) { - label = (item.p) - ? getHighlightedText(item.p + "." + item.l) - : getHighlightedText(item.l); + label = (item.p && item.p !== UNNAMED) + ? getHighlightedText(item.p + "." + item.l, matcher) + : getHighlightedText(item.l, matcher); } else if (item.category === catMembers) { - label = getHighlightedText(item.p + "." + (item.c + "." + item.l)); + label = (item.p && item.p !== UNNAMED) + ? getHighlightedText(item.p + "." + item.c + "." + item.l, matcher) + : getHighlightedText(item.c + "." + item.l, matcher); } else if (item.category === catSearchTags) { - label = getHighlightedText(item.l); + label = getHighlightedText(item.l, matcher); } else { label = item.l; } @@ -132,140 +163,162 @@ $.widget("custom.catcomplete", $.ui.autocomplete, { var div = $("
    ").appendTo(li); if (item.category === catSearchTags) { if (item.d) { - div.html(label + " (" + item.h + ")
    " + div.html(label + " (" + item.h + ")
    " + item.d + "
    "); } else { - div.html(label + " (" + item.h + ")"); + div.html(label + " (" + item.h + ")"); } } else { - div.html(label); + if (item.m) { + div.html(item.m + "/" + label); + } 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"); +function rankMatch(match, category) { + if (!match) { + return NO_MATCH; + } + var index = match.index; + var input = match.input; + var leftBoundaryMatch = 2; + var periferalMatch = 0; + var delta = 0; + // make sure match is anchored on a left word boundary + if (index === 0 || /\W/.test(input[index - 1]) || "_" === input[index - 1] || "_" === input[index]) { + leftBoundaryMatch = 0; + } else if (input[index] === input[index].toUpperCase() && !/^[A-Z0-9_$]+$/.test(input)) { + leftBoundaryMatch = 1; + } + var matchEnd = index + match[0].length; + var leftParen = input.indexOf("("); + // exclude peripheral matches + if (category !== catModules && category !== catSearchTags) { + var endOfName = leftParen > -1 ? leftParen : input.length; + var delim = category === catPackages ? "/" : "."; + if (leftParen > -1 && leftParen < index) { + periferalMatch += 2; + } else if (input.lastIndexOf(delim, endOfName) >= matchEnd) { + periferalMatch += 2; + } + } + for (var i = 1; i < match.length; i++) { + // lower ranking if parts of the name are missing + if (match[i]) + delta += match[i].length; + } + if (category === catTypes) { + // lower ranking if a type name contains unmatched camel-case parts + if (/[A-Z]/.test(input.substring(matchEnd))) + delta += 5; + if (/[A-Z]/.test(input.substring(0, index))) + delta += 5; + } + return leftBoundaryMatch + periferalMatch + (delta / 200); - // Return the nested innermost name from the specified object - function nestedName(e) { - return e.l.substring(e.l.lastIndexOf(".") + 1); - } +} +function doSearch(request, response) { + var result = []; + var newResults = []; - function concatResults(a1, a2) { - a1 = a1.concat(a2); - a2.length = 0; - return a1; - } + searchPattern = makeCamelCaseRegex(request.term); + if (searchPattern === "") { + return this.close(); + } + var camelCaseMatcher = createMatcher(searchPattern, ""); + var boundaryMatcher = createMatcher("\\b" + searchPattern, ""); - 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); + function concatResults(a1, a2) { + a2.sort(function(e1, e2) { + return e1.ranking - e2.ranking; + }); + a1 = a1.concat(a2.map(function(e) { return e.item; })); + a2.length = 0; + return a1; + } + + if (moduleSearchIndex) { + $.each(moduleSearchIndex, function(index, item) { + item.category = catModules; + var ranking = rankMatch(boundaryMatcher.exec(item.l), catModules); + if (ranking < RANKING_THRESHOLD) { + newResults.push({ ranking: ranking, item: item }); } - 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; + return newResults.length < MAX_RESULTS_PER_CATEGORY; + }); + result = concatResults(result, newResults); + } + if (packageSearchIndex) { + $.each(packageSearchIndex, function(index, item) { + item.category = catPackages; + var name = (item.m && request.term.indexOf("/") > -1) + ? (item.m + "/" + item.l) + : item.l; + var ranking = rankMatch(boundaryMatcher.exec(name), catPackages); + if (ranking < RANKING_THRESHOLD) { + newResults.push({ ranking: ranking, item: item }); } - 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; + return newResults.length < MAX_RESULTS_PER_CATEGORY; + }); + result = concatResults(result, newResults); + } + if (typeSearchIndex) { + $.each(typeSearchIndex, function(index, item) { + item.category = catTypes; + var name = request.term.indexOf(".") > -1 + ? item.p + "." + item.l + : item.l; + var ranking = rankMatch(camelCaseMatcher.exec(name), catTypes); + if (ranking < RANKING_THRESHOLD) { + newResults.push({ ranking: ranking, item: item }); } - 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; + return newResults.length < MAX_RESULTS_PER_CATEGORY; + }); + result = concatResults(result, newResults); + } + if (memberSearchIndex) { + $.each(memberSearchIndex, function(index, item) { + item.category = catMembers; + var name = request.term.indexOf(".") > -1 + ? item.p + "." + item.c + "." + item.l + : item.l; + var ranking = rankMatch(camelCaseMatcher.exec(name), catMembers); + if (ranking < RANKING_THRESHOLD) { + newResults.push({ ranking: ranking, item: item }); } - 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; + return newResults.length < MAX_RESULTS_PER_CATEGORY; + }); + result = concatResults(result, newResults); + } + if (tagSearchIndex) { + $.each(tagSearchIndex, function(index, item) { + item.category = catSearchTags; + var ranking = rankMatch(boundaryMatcher.exec(item.l), catSearchTags); + if (ranking < RANKING_THRESHOLD) { + newResults.push({ ranking: ranking, item: item }); } - 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)); - }, + return newResults.length < MAX_RESULTS_PER_CATEGORY; + }); + result = concatResults(result, newResults); + } + if (!indexFilesLoaded()) { + updateSearchResults = function() { + doSearch(request, response); + } + result.unshift(loading); + } else { + updateSearchResults = function() {}; + } + response(result); +} +$(function() { + $("#search").catcomplete({ + minLength: 1, + delay: 300, + source: doSearch, response: function(event, ui) { if (!ui.content.length) { ui.content.push(noResult); @@ -274,40 +327,39 @@ $(function() { } }, autoFocus: true, + focus: function(event, ui) { + return false; + }, position: { collision: "flip" }, select: function(event, ui) { - if (ui.item.l !== noResult.l) { + if (ui.item.category) { var url = getURLPrefix(ui); if (ui.item.category === catModules) { - if (useModuleDirectories) { - url += "module-summary.html"; - } else { - url = ui.item.l + "-summary.html"; - } + url += "module-summary.html"; } else if (ui.item.category === catPackages) { - if (ui.item.url) { - url = ui.item.url; + if (ui.item.u) { + url = ui.item.u; } else { - url += ui.item.l.replace(/\./g, '/') + "/package-summary.html"; + 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 === "") { + if (ui.item.u) { + url = ui.item.u; + } else if (ui.item.p === UNNAMED) { 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 === "") { + if (ui.item.p === UNNAMED) { url += ui.item.c + ".html" + "#"; } else { url += ui.item.p.replace(/\./g, '/') + "/" + ui.item.c + ".html" + "#"; } - if (ui.item.url) { - url += ui.item.url; + if (ui.item.u) { + url += ui.item.u; } else { url += ui.item.l; } diff --git a/javadoc/serialized-form.html b/javadoc/serialized-form.html index c7abde4..39c72df 100644 --- a/javadoc/serialized-form.html +++ b/javadoc/serialized-form.html @@ -5,45 +5,28 @@ Serialized Form (RedLib API) + + - + + - - - - - + + - - -
    +
    + +

    Serialized Form

    -
    -
    + + +
    +
    +
    diff --git a/javadoc/stylesheet.css b/javadoc/stylesheet.css index fa24676..79a9d97 100644 --- a/javadoc/stylesheet.css +++ b/javadoc/stylesheet.css @@ -1,4 +1,4 @@ -/* +/* * Javadoc style sheet */ @@ -40,13 +40,6 @@ a[href]:hover, a[href]:focus { 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; @@ -59,7 +52,6 @@ h2 { } h3 { font-size:16px; - font-style:italic; } h4 { font-size:13px; @@ -94,7 +86,10 @@ table tr td dt code { sup { font-size:8px; } - +button { + font-family: 'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size: 14px; +} /* * Styles for HTML generated by javadoc. * @@ -109,23 +104,16 @@ sup { height:0px; overflow:hidden; } -.aboutLanguage { +.about-language { float:right; padding:0px 21px; font-size:11px; z-index:200; margin-top:-9px; } -.legalCopy { +.legal-copy { 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; @@ -136,24 +124,23 @@ sup { /* * 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 { +@media screen { + .flex-box { + position:fixed; + display:flex; + flex-direction:column; + height: 100%; + width: 100%; + } + .flex-header { + flex: 0 0 auto; + } + .flex-content { + flex: 1 1 auto; + overflow-y: auto; + } +} +.top-nav { background-color:#4D7A97; color:#FFFFFF; float:left; @@ -163,9 +150,9 @@ sup { height:2.8em; padding-top:10px; overflow:hidden; - font-size:12px; + font-size:12px; } -.bottomNav { +.bottom-nav { margin-top:10px; background-color:#4D7A97; color:#FFFFFF; @@ -178,110 +165,91 @@ sup { overflow:hidden; font-size:12px; } -.subNav { +.sub-nav { background-color:#dee3e9; float:left; width:100%; overflow:hidden; font-size:12px; } -.subNav div { +.sub-nav div { clear:left; float:left; padding:0 0 5px 6px; text-transform:uppercase; } -ul.navList, ul.subNavList { +.sub-nav .nav-list { + padding-top:5px; +} +ul.nav-list, ul.sub-nav-list { float:left; margin:0 25px 0 0; padding:0; } -ul.navList li{ +ul.nav-list li{ list-style:none; float:left; padding: 5px 6px; text-transform:uppercase; } -ul.navListSearch { +.sub-nav .nav-list-search { float:right; margin:0 0 0 0; - padding:0; -} -ul.navListSearch li { - list-style:none; - float:right; - padding: 5px 6px; - text-transform:uppercase; + padding:5px 6px; + clear:none; } -ul.navListSearch li label { +.nav-list-search label { position:relative; right:-16px; } -ul.subNavList li { +ul.sub-nav-list li { list-style:none; float:left; + padding-top:10px; } -.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited { +.top-nav a:link, .top-nav a:active, .top-nav a:visited, .bottom-nav a:link, .bottom-nav a:active, .bottom-nav a:visited { color:#FFFFFF; text-decoration:none; text-transform:uppercase; } -.topNav a:hover, .bottomNav a:hover { +.top-nav a:hover, .bottom-nav a:hover { text-decoration:none; color:#bb7a2a; text-transform:uppercase; } -.navBarCell1Rev { +.nav-bar-cell1-rev { background-color:#F8981D; color:#253441; margin: auto 5px; } -.skipNav { +.skip-nav { position:absolute; top:auto; left:-9999px; overflow:hidden; } /* - * Styles for page header and footer. + * Hide navigation links and search box in print layout */ -.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; +@media print { + ul.nav-list, div.sub-nav { + display:none; + } } +/* + * Styles for page header and footer. + */ .title { color:#2c4557; margin:10px 0; } -.subTitle { +.sub-title { 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; @@ -289,69 +257,49 @@ ul.subNavList li { /* * 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; +body.class-declaration-page .summary h2, +body.class-declaration-page .details h2, +body.class-use-page h2, +body.module-declaration-page .block-list h2 { + font-style: italic; + padding:0; + margin:15px 0; } -ul.blockList ul.blockList ul.blockList li.blockList h3 { +body.class-declaration-page .summary h3, +body.class-declaration-page .details h3, +body.class-declaration-page .summary .inherited-list h2 { 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 { +main { 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 { +dl.notes > dt { + font-family: 'DejaVu Sans', Arial, Helvetica, sans-serif; font-size:12px; font-weight:bold; margin:10px 0 0 0; color:#4E4E4E; } -.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd { +dl.notes > dd { margin:5px 0 10px 0px; font-size:14px; font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; } -.serializedFormContainer dl.nameValue dt { +dl.name-value > dt { margin-left:1px; font-size:1.1em; display:inline; font-weight:bold; } -.serializedFormContainer dl.nameValue dd { +dl.name-value > dd { margin:0 0 0 1px; font-size:1.1em; display:inline; @@ -366,49 +314,28 @@ ul.horizontal li { display:inline; font-size:0.9em; } -ul.inheritance { +div.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; +div.inheritance div.inheritance { + margin-left:2em; } -ul.blockList, ul.blockListLast { +ul.block-list, +ul.details-list, +ul.member-list, +ul.summary-list { margin:10px 0 10px 0; padding:0; } -ul.blockList li.blockList, ul.blockListLast li.blockList { +ul.block-list > li, +ul.details-list > li, +ul.member-list > li, +ul.summary-list > li { 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; @@ -416,20 +343,22 @@ table tr td dl, table tr td dl dt, table tr td dl dd { /* * Styles for tables. */ -.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary, -.requiresSummary, .packagesSummary, .providesSummary, .usesSummary { +.overview-summary table, .member-summary table, .type-summary table, .use-summary table, .constants-summary table, .deprecated-summary table, +.requires-summary table, .packages-summary table, .provides-summary table, .uses-summary table, .system-properties-summary table { width:100%; border-spacing:0; - border-left:1px solid #EEE; - border-right:1px solid #EEE; - border-bottom:1px solid #EEE; + border-left:1px solid #EEE; + border-right:1px solid #EEE; + border-bottom:1px solid #EEE; } -.overviewSummary, .memberSummary, .requiresSummary, .packagesSummary, .providesSummary, .usesSummary { +.overview-summary table, .member-summary table, .requires-summary table, .packages-summary table, +.provides-summary table, .uses-summary table, .system-properties-summary table { padding:0px; } -.overviewSummary caption, .memberSummary caption, .typeSummary caption, -.useSummary caption, .constantsSummary caption, .deprecatedSummary caption, -.requiresSummary caption, .packagesSummary caption, .providesSummary caption, .usesSummary caption { +.overview-summary caption, .member-summary caption, .type-summary caption, +.use-summary caption, .constants-summary caption, .deprecated-summary caption, +.requires-summary caption, .packages-summary caption, .provides-summary caption, +.uses-summary caption, .system-properties-summary caption { position:relative; text-align:left; background-repeat:no-repeat; @@ -443,32 +372,32 @@ table tr td dl, table tr td dl dt, table tr td dl dd { margin:0px; white-space:pre; } -.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link, -.constantsSummary 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, -.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, -.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, -.constantsSummary 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; -} -.useSummary caption a:link, .useSummary caption a:hover, .useSummary caption a:active, -.useSummary caption a:visited { +.constants-summary caption a:link, .constants-summary caption a:visited, +.use-summary caption a:link, .use-summary caption a:visited { color:#1f389c; } -.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 { +.overview-summary caption a:link, .member-summary caption a:link, .type-summary caption a:link, +.deprecated-summary caption a:link, +.requires-summary caption a:link, .packages-summary caption a:link, .provides-summary caption a:link, +.uses-summary caption a:link, +.overview-summary caption a:hover, .member-summary caption a:hover, .type-summary caption a:hover, +.use-summary caption a:hover, .constants-summary caption a:hover, .deprecated-summary caption a:hover, +.requires-summary caption a:hover, .packages-summary caption a:hover, .provides-summary caption a:hover, +.uses-summary caption a:hover, +.overview-summary caption a:active, .member-summary caption a:active, .type-summary caption a:active, +.use-summary caption a:active, .constants-summary caption a:active, .deprecated-summary caption a:active, +.requires-summary caption a:active, .packages-summary caption a:active, .provides-summary caption a:active, +.uses-summary caption a:active, +.overview-summary caption a:visited, .member-summary caption a:visited, .type-summary caption a:visited, +.deprecated-summary caption a:visited, +.requires-summary caption a:visited, .packages-summary caption a:visited, .provides-summary caption a:visited, +.uses-summary caption a:visited { + color:#FFFFFF; +} +.overview-summary caption span, .member-summary caption span, .type-summary caption span, +.use-summary caption span, .constants-summary caption span, .deprecated-summary caption span, +.requires-summary caption span, .packages-summary caption span, .provides-summary caption span, +.uses-summary caption span, .system-properties-summary caption span { white-space:nowrap; padding-top:5px; padding-left:12px; @@ -480,136 +409,93 @@ table tr td dl, table tr td dl dt, table tr td dl dd { 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; + +div.table-tabs > button { + border: none; + cursor: pointer; + padding: 5px 12px 7px 12px; + font-weight: bold; + margin-right: 3px; } -.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; +div.table-tabs > button.active-table-tab { + background: #F8981D; + color: #253441; } -.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; +div.table-tabs > button.table-tab { + background: #4D7A97; + color: #FFFFFF; } -.rowColor th, .altColor th { + +.row-color th, +.alt-color th { font-weight:normal; } -.overviewSummary td, .memberSummary td, .typeSummary td, -.useSummary td, .constantsSummary td, .deprecatedSummary td, -.requiresSummary td, .packagesSummary td, .providesSummary td, .usesSummary td { +.overview-summary td, .member-summary td, .type-summary td, +.use-summary td, .constants-summary td, .deprecated-summary td, +.requires-summary td, .packages-summary td, .provides-summary td, +.uses-summary td, .system-properties-summary 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 { +th.col-first, th.col-second, th.col-last, th.col-constructor-name, th.col-deprecated-item-name, .use-summary th, +.constants-summary th, .packages-summary th, td.col-first, td.col-second, td.col-last, .use-summary td, +.constants-summary td, .system-properties-summary th { 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 { +th.col-first, th.col-second, th.col-last, th.col-constructor-name, th.col-deprecated-item-name, .constants-summary th, +.packages-summary th { background:#dee3e9; text-align:left; padding:8px 3px 3px 7px; } -td.colFirst, th.colFirst { +td.col-first, th.col-first { font-size:13px; } -td.colSecond, th.colSecond, td.colLast, th.colConstructorName, th.colDeprecatedItemName, th.colLast { +td.col-second, th.col-second, td.col-last, th.col-constructor-name, th.col-deprecated-item-name, th.col-last { font-size:13px; } -.constantsSummary th, .packagesSummary th { +.constants-summary th, .packages-summary th { font-size:13px; } -.providesSummary th.colFirst, .providesSummary th.colLast, .providesSummary td.colFirst, -.providesSummary td.colLast { +.provides-summary th.col-first, .provides-summary th.col-last, .provides-summary td.col-first, +.provides-summary td.col-last { 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 { +.overview-summary td.col-first, .overview-summary th.col-first, +.requires-summary td.col-first, .requires-summary th.col-first, +.packages-summary td.col-first, .packages-summary td.col-second, .packages-summary th.col-first, .packages-summary th, +.uses-summary td.col-first, .uses-summary th.col-first, +.provides-summary td.col-first, .provides-summary th.col-first, +.member-summary td.col-first, .member-summary th.col-first, +.member-summary td.col-second, .member-summary th.col-second, .member-summary th.col-constructor-name, +.type-summary td.col-first, .type-summary th.col-first { vertical-align:top; } -.packagesSummary th.colLast, .packagesSummary td.colLast { +.packages-summary th.col-last, .packages-summary td.col-last { 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 { +td.col-first a:link, td.col-first a:visited, +td.col-second a:link, td.col-second a:visited, +th.col-first a:link, th.col-first a:visited, +th.col-second a:link, th.col-second a:visited, +th.col-constructor-name a:link, th.col-constructor-name a:visited, +th.col-deprecated-item-name a:link, th.col-deprecated-item-name a:visited, +.constant-values-container td a:link, .constant-values-container td a:visited, +.all-classes-container td a:link, .all-classes-container td a:visited, +.all-packages-container td a:link, .all-packages-container td a:visited { font-weight:bold; } -.tableSubHeadingColor { +.table-sub-heading-color { background-color:#EEEEFF; } -.altColor, .altColor th { +.alt-color, .alt-color th { background-color:#FFFFFF; } -.rowColor, .rowColor th { +.row-color, .row-color th { background-color:#EEEEEF; } /* @@ -618,30 +504,43 @@ th.colDeprecatedItemName a:link, th.colDeprecatedItemName a:visited, .description pre { margin-top:0; } -.deprecatedContent { +.deprecated-content { 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 { +td.col-last div { padding-top:0px; } -td.colLast a { +td.col-last a { padding-bottom:3px; } +div.member-signature { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + margin:14px 0; + white-space: pre-wrap; +} +div.member-signature span.annotations { + white-space: pre-wrap; +} +div.member-signature span.type-parameters-long, +div.member-signature span.parameters, +div.member-signature span.exceptions { + display: inline-block; + vertical-align: top; + white-space: pre; +} +div.member-signature span.type-parameters { + white-space: normal; +} /* * Styles for formatting effect. */ -.sourceLineNo { +.source-line-no { color:green; padding:0 30px 0 0; } @@ -652,19 +551,18 @@ h1.hidden { } .block { display:block; - margin:3px 10px 2px 0px; + margin:0 10px 5px 0; color:#474747; } -.deprecatedLabel, .descfrmTypeLabel, .implementationLabel, .memberNameLabel, .memberNameLink, -.moduleLabelInPackage, .moduleLabelInType, .overrideSpecifyLabel, .packageLabelInType, -.packageHierarchyLabel, .paramLabel, .returnLabel, .seeLabel, .simpleTagLabel, -.throwsLabel, .typeNameLabel, .typeNameLink, .searchTagLink { +.deprecated-label, .descfrm-type-label, .implementation-label, .member-name-label, .member-name-link, +.module-label-in-package, .module-label-in-type, .override-specify-label, .package-label-in-type, +.package-hierarchy-label, .type-name-label, .type-name-link, .search-tag-link { font-weight:bold; } -.deprecationComment, .emphasizedPhrase, .interfaceName { +.deprecation-comment, .help-footnote, .interface-name { font-style:italic; } -.deprecationBlock { +.deprecation-block { font-size:14px; font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; border-style:solid; @@ -675,68 +573,10 @@ h1.hidden { margin-right:10px; display:inline-block; } -div.block div.deprecationComment, div.block div.block span.emphasizedPhrase, -div.block div.block span.interfaceName { +div.block div.deprecation-comment, div.block div.block span.emphasized-phrase, +div.block div.block span.interface-name { 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. */ @@ -753,7 +593,7 @@ main, nav, header, footer, section { background-color:#4D7A97; color:#FFFFFF; } -.resultItem { +.result-item { font-size:13px; } .ui-autocomplete { @@ -773,7 +613,7 @@ ul.ui-autocomplete li { clear:both; width:100%; } -.resultHighlight { +.result-highlight { font-weight:bold; } #search { @@ -784,6 +624,7 @@ ul.ui-autocomplete li { padding-left:20px; position:relative; right:-18px; + width:400px; } #reset { background-color: rgb(255,255,255); @@ -793,7 +634,7 @@ ul.ui-autocomplete li { background-size:12px; border:0 none; width:16px; - height:17px; + height:16px; position:relative; left:-4px; top:-4px; @@ -802,28 +643,73 @@ ul.ui-autocomplete li { .watermark { color:#545454; } -.searchTagDescResult { +.search-tag-desc-result { font-style:italic; font-size:11px; } -.searchTagHolderResult { +.search-tag-holder-result { font-style:italic; font-size:12px; } -.searchTagResult:before, .searchTagResult:target { - color:red; +.search-tag-result:target { + background-color:yellow; } -.moduleGraph span { +.module-graph span { display:none; position:absolute; } -.moduleGraph:hover span { +.module-graph:hover span { display:block; margin: -100px 0 0 100px; z-index: 1; } -.methodSignature { - white-space:normal; +.inherited-list { + margin: 10px 0 10px 0; +} +section.description { + line-height: 1.4; +} +.summary section[class$="-summary"], .details section[class$="-details"], +.class-uses .detail, .serialized-class-details { + padding: 0px 20px 5px 10px; + border: 1px solid #ededed; + background-color: #f8f8f8; +} +.inherited-list, section[class$="-details"] .detail { + padding:0 0 5px 8px; + background-color:#ffffff; + border:none; +} +.vertical-separator { + padding: 0 5px; +} +ul.help-section-list { + margin: 0; +} +/* + * Indicator icon for external links. + */ +main a[href*="://"]::after { + content:""; + display:inline-block; + background-image:url('data:image/svg+xml; utf8, \ + \ + \ + '); + background-size:100% 100%; + width:7px; + height:7px; + margin-left:2px; + margin-bottom:4px; +} +main a[href*="://"]:hover::after, +main a[href*="://"]:focus::after { + background-image:url('data:image/svg+xml; utf8, \ + \ + \ + '); } /* diff --git a/javadoc/tag-search-index.js b/javadoc/tag-search-index.js new file mode 100644 index 0000000..0367dae --- /dev/null +++ b/javadoc/tag-search-index.js @@ -0,0 +1 @@ +tagSearchIndex = [];updateSearchResults(); \ No newline at end of file diff --git a/javadoc/type-search-index.js b/javadoc/type-search-index.js index ef9d424..ff9096c 100644 --- a/javadoc/type-search-index.js +++ b/javadoc/type-search-index.js @@ -1 +1 @@ -typeSearchIndex = [{"l":"All Classes","url":"allclasses-index.html"},{"p":"redempt.redlib.commandmanager","l":"ArgType.ArgConverter"},{"p":"redempt.redlib.commandmanager","l":"ArgSubtype"},{"p":"redempt.redlib.commandmanager","l":"ArgType"},{"p":"redempt.redlib.blockdata","l":"BlockDataManager"},{"p":"redempt.redlib.dev.profiler","l":"BurstProfiler"},{"p":"redempt.redlib.protection","l":"BypassPolicy"},{"p":"redempt.redlib.misc","l":"ChatPrompt.CancelReason"},{"p":"redempt.redlib.dev","l":"ChainCommand"},{"p":"redempt.redlib.misc","l":"ChatPrompt"},{"p":"redempt.redlib.commandmanager","l":"Command"},{"p":"redempt.redlib.commandmanager","l":"CommandCollection"},{"p":"redempt.redlib.commandmanager","l":"CommandHook"},{"p":"redempt.redlib.commandmanager.exceptions","l":"CommandHookException"},{"p":"redempt.redlib.commandmanager.exceptions","l":"CommandParseException"},{"p":"redempt.redlib.commandmanager","l":"CommandParser"},{"p":"redempt.redlib.configmanager.exceptions","l":"ConfigFieldException"},{"p":"redempt.redlib.configmanager.exceptions","l":"ConfigListException"},{"p":"redempt.redlib.configmanager","l":"ConfigManager"},{"p":"redempt.redlib.configmanager.exceptions","l":"ConfigMapException"},{"p":"redempt.redlib.configmanager.annotations","l":"ConfigMappable"},{"p":"redempt.redlib.configmanager.annotations","l":"ConfigPath"},{"p":"redempt.redlib.configmanager.annotations","l":"ConfigPostInit"},{"p":"redempt.redlib.configmanager","l":"ConfigStorage"},{"p":"redempt.redlib.configmanager.annotations","l":"ConfigValue"},{"p":"redempt.redlib.commandmanager","l":"ContextProvider"},{"p":"redempt.redlib.configmanager","l":"ConversionType"},{"p":"redempt.redlib.region","l":"CuboidRegion"},{"p":"redempt.redlib.worldgen","l":"CustomBiome"},{"p":"redempt.redlib.blockdata","l":"CustomBlock"},{"p":"redempt.redlib.blockdata.events","l":"CustomBlockPlaceEvent"},{"p":"redempt.redlib.blockdata","l":"CustomBlockRegistry"},{"p":"redempt.redlib.blockdata","l":"CustomBlockType"},{"p":"redempt.redlib.enchants","l":"CustomEnchant"},{"p":"redempt.redlib.itemutils","l":"CustomItem"},{"p":"redempt.redlib.worldgen","l":"CustomWorldGenerator"},{"p":"redempt.redlib.blockdata","l":"DataBlock"},{"p":"redempt.redlib.blockdata.events","l":"DataBlockDestroyEvent"},{"p":"redempt.redlib.blockdata.events","l":"DataBlockMoveEvent"},{"p":"redempt.redlib.blockdata.events","l":"DataBlockDestroyEvent.DestroyCause"},{"p":"redempt.redlib.enchants","l":"EnchantInfo"},{"p":"redempt.redlib.enchants","l":"EnchantRegistry"},{"p":"redempt.redlib.enchants.trigger","l":"EnchantTrigger"},{"p":"redempt.redlib.region.events","l":"RegionEnterEvent.EnterCause"},{"p":"redempt.redlib.misc","l":"EntityPersistor"},{"p":"redempt.redlib.enchants","l":"EventItems"},{"p":"redempt.redlib.misc","l":"EventListener"},{"p":"redempt.redlib.region.events","l":"RegionExitEvent.ExitCause"},{"p":"redempt.redlib.misc","l":"FormatUtils"},{"p":"redempt.redlib.inventorygui","l":"InventoryGUI.GUIState"},{"p":"redempt.redlib.misc","l":"Hologram"},{"p":"redempt.redlib.inventorygui","l":"InventoryGUI"},{"p":"redempt.redlib.itemutils","l":"ItemBuilder"},{"p":"redempt.redlib.inventorygui","l":"ItemButton"},{"p":"redempt.redlib.itemutils","l":"ItemTrait"},{"p":"redempt.redlib.itemutils","l":"ItemUtils"},{"p":"redempt.redlib.json","l":"JSONList"},{"p":"redempt.redlib.json","l":"JSONMap"},{"p":"redempt.redlib.json","l":"JSONParser"},{"p":"redempt.redlib.enchants.trigger","l":"KillEntityTrigger"},{"p":"redempt.redlib.misc","l":"LocationUtils"},{"p":"redempt.redlib.itemutils","l":"LoreStats"},{"p":"redempt.redlib.commandmanager","l":"Messages"},{"p":"redempt.redlib.commandmanager","l":"Command.MethodHook"},{"p":"redempt.redlib.multiblock","l":"MultiBlockStructure"},{"p":"redempt.redlib.region","l":"MultiRegion"},{"p":"redempt.redlib.nms","l":"NMSArray"},{"p":"redempt.redlib.nms","l":"NMSClass"},{"p":"redempt.redlib.nms","l":"NMSHelper"},{"p":"redempt.redlib.nms","l":"NMSObject"},{"p":"redempt.redlib.worldgen","l":"NoiseGenerator"},{"p":"redempt.redlib.worldgen","l":"NoiseOctave"},{"p":"redempt.redlib.region","l":"Overlappable"},{"p":"redempt.redlib.dev.profiler","l":"PassiveProfiler"},{"p":"redempt.redlib.misc","l":"Path"},{"p":"redempt.redlib.enchants.events","l":"PlayerChangedArmorEvent"},{"p":"redempt.redlib.enchants.events","l":"PlayerChangedHeldItemEvent"},{"p":"redempt.redlib.misc","l":"PlayerWrapper"},{"p":"redempt.redlib.dev.profiler","l":"Profiler"},{"p":"redempt.redlib.dev.profiler","l":"ProfilerCommands"},{"p":"redempt.redlib.protection","l":"ProtectedRegion"},{"p":"redempt.redlib.protection","l":"ProtectionPolicy"},{"p":"redempt.redlib.protection","l":"ProtectionPolicy.ProtectionType"},{"p":"redempt.redlib","l":"RedLib"},{"p":"redempt.redlib.region","l":"Region"},{"p":"redempt.redlib.region.events","l":"RegionEnterEvent"},{"p":"redempt.redlib.region","l":"RegionEnterExitListener"},{"p":"redempt.redlib.region.events","l":"RegionExitEvent"},{"p":"redempt.redlib.region","l":"RegionMap"},{"p":"redempt.redlib.region","l":"CuboidRegion.RegionState"},{"p":"redempt.redlib.region","l":"RegionUtils"},{"p":"redempt.redlib.sql","l":"SQLHelper.Results"},{"p":"redempt.redlib.multiblock","l":"Rotator"},{"p":"redempt.redlib.dev.profiler","l":"SampleSummary.SampleMethod"},{"p":"redempt.redlib.dev.profiler","l":"SampleSummary"},{"p":"redempt.redlib.region","l":"SelectionTool"},{"p":"redempt.redlib.commandmanager","l":"Command.SenderType"},{"p":"redempt.redlib.region","l":"SpheroidRegion"},{"p":"redempt.redlib.sql","l":"SQLCache"},{"p":"redempt.redlib.sql","l":"SQLHelper"},{"p":"redempt.redlib.multiblock","l":"Structure"},{"p":"redempt.redlib.multiblock","l":"Structure.StructureBlock"},{"p":"redempt.redlib.multiblock","l":"StructureData"},{"p":"redempt.redlib.dev","l":"StructureTool"},{"p":"redempt.redlib.commandmanager","l":"ArgType.TabCompleter"},{"p":"redempt.redlib.commandmanager","l":"ArgType.TabStreamCompleter"},{"p":"redempt.redlib.misc","l":"Task"},{"p":"redempt.redlib.misc","l":"Task.TaskType"},{"p":"redempt.redlib.dev.profiler","l":"TickMonitorProfiler"},{"p":"redempt.redlib.misc","l":"UserCache"},{"p":"redempt.redlib.misc","l":"WeightedRandom"}] \ No newline at end of file +typeSearchIndex = [{"l":"All Classes","u":"allclasses-index.html"},{"p":"redempt.redlib.commandmanager","l":"ArgType.ArgConverter"},{"p":"redempt.redlib.commandmanager","l":"ArgSubtype"},{"p":"redempt.redlib.commandmanager","l":"ArgType"},{"p":"redempt.redlib.blockdata","l":"BlockDataManager"},{"p":"redempt.redlib.dev.profiler","l":"BurstProfiler"},{"p":"redempt.redlib.protection","l":"BypassPolicy"},{"p":"redempt.redlib.misc","l":"ChatPrompt.CancelReason"},{"p":"redempt.redlib.dev","l":"ChainCommand"},{"p":"redempt.redlib.misc","l":"ChatPrompt"},{"p":"redempt.redlib.commandmanager","l":"Command"},{"p":"redempt.redlib.commandmanager","l":"CommandCollection"},{"p":"redempt.redlib.commandmanager","l":"CommandHook"},{"p":"redempt.redlib.commandmanager.exceptions","l":"CommandHookException"},{"p":"redempt.redlib.commandmanager.exceptions","l":"CommandParseException"},{"p":"redempt.redlib.commandmanager","l":"CommandParser"},{"p":"redempt.redlib.configmanager.exceptions","l":"ConfigFieldException"},{"p":"redempt.redlib.configmanager.exceptions","l":"ConfigListException"},{"p":"redempt.redlib.configmanager","l":"ConfigManager"},{"p":"redempt.redlib.configmanager.exceptions","l":"ConfigMapException"},{"p":"redempt.redlib.configmanager.annotations","l":"ConfigMappable"},{"p":"redempt.redlib.configmanager.annotations","l":"ConfigPath"},{"p":"redempt.redlib.configmanager.annotations","l":"ConfigPostInit"},{"p":"redempt.redlib.configmanager","l":"ConfigStorage"},{"p":"redempt.redlib.configmanager.annotations","l":"ConfigValue"},{"p":"redempt.redlib.commandmanager","l":"ContextProvider"},{"p":"redempt.redlib.configmanager","l":"ConversionType"},{"p":"redempt.redlib.region","l":"CuboidRegion"},{"p":"redempt.redlib.worldgen","l":"CustomBiome"},{"p":"redempt.redlib.blockdata","l":"CustomBlock"},{"p":"redempt.redlib.blockdata.events","l":"CustomBlockPlaceEvent"},{"p":"redempt.redlib.blockdata","l":"CustomBlockRegistry"},{"p":"redempt.redlib.blockdata","l":"CustomBlockType"},{"p":"redempt.redlib.enchants","l":"CustomEnchant"},{"p":"redempt.redlib.itemutils","l":"CustomItem"},{"p":"redempt.redlib.worldgen","l":"CustomWorldGenerator"},{"p":"redempt.redlib.blockdata","l":"DataBlock"},{"p":"redempt.redlib.blockdata.events","l":"DataBlockDestroyEvent"},{"p":"redempt.redlib.blockdata.events","l":"DataBlockMoveEvent"},{"p":"redempt.redlib.blockdata.events","l":"DataBlockDestroyEvent.DestroyCause"},{"p":"redempt.redlib.enchants","l":"EnchantInfo"},{"p":"redempt.redlib.enchants","l":"EnchantRegistry"},{"p":"redempt.redlib.enchants.trigger","l":"EnchantTrigger"},{"p":"redempt.redlib.region.events","l":"RegionEnterEvent.EnterCause"},{"p":"redempt.redlib.misc","l":"EntityPersistor"},{"p":"redempt.redlib.enchants","l":"EventItems"},{"p":"redempt.redlib.misc","l":"EventListener"},{"p":"redempt.redlib.region.events","l":"RegionExitEvent.ExitCause"},{"p":"redempt.redlib.misc","l":"FormatUtils"},{"p":"redempt.redlib.inventorygui","l":"InventoryGUI.GUIState"},{"p":"redempt.redlib.misc","l":"Hologram"},{"p":"redempt.redlib.inventorygui","l":"InventoryGUI"},{"p":"redempt.redlib.itemutils","l":"ItemBuilder"},{"p":"redempt.redlib.inventorygui","l":"ItemButton"},{"p":"redempt.redlib.itemutils","l":"ItemTrait"},{"p":"redempt.redlib.itemutils","l":"ItemUtils"},{"p":"redempt.redlib.json","l":"JSONList"},{"p":"redempt.redlib.json","l":"JSONMap"},{"p":"redempt.redlib.json","l":"JSONParser"},{"p":"redempt.redlib.enchants.trigger","l":"KillEntityTrigger"},{"p":"redempt.redlib.misc","l":"LocationUtils"},{"p":"redempt.redlib.itemutils","l":"LoreStats"},{"p":"redempt.redlib.commandmanager","l":"Messages"},{"p":"redempt.redlib.commandmanager","l":"Command.MethodHook"},{"p":"redempt.redlib.multiblock","l":"MultiBlockStructure"},{"p":"redempt.redlib.region","l":"MultiRegion"},{"p":"redempt.redlib.nms","l":"NMSArray"},{"p":"redempt.redlib.nms","l":"NMSClass"},{"p":"redempt.redlib.nms","l":"NMSHelper"},{"p":"redempt.redlib.nms","l":"NMSObject"},{"p":"redempt.redlib.worldgen","l":"NoiseGenerator"},{"p":"redempt.redlib.worldgen","l":"NoiseOctave"},{"p":"redempt.redlib.region","l":"Overlappable"},{"p":"redempt.redlib.dev.profiler","l":"PassiveProfiler"},{"p":"redempt.redlib.misc","l":"Path"},{"p":"redempt.redlib.enchants.events","l":"PlayerChangedArmorEvent"},{"p":"redempt.redlib.enchants.events","l":"PlayerChangedHeldItemEvent"},{"p":"redempt.redlib.misc","l":"PlayerWrapper"},{"p":"redempt.redlib.dev.profiler","l":"Profiler"},{"p":"redempt.redlib.dev.profiler","l":"ProfilerCommands"},{"p":"redempt.redlib.protection","l":"ProtectedRegion"},{"p":"redempt.redlib.protection","l":"ProtectionPolicy"},{"p":"redempt.redlib.protection","l":"ProtectionPolicy.ProtectionType"},{"p":"redempt.redlib","l":"RedLib"},{"p":"redempt.redlib.region","l":"Region"},{"p":"redempt.redlib.region.events","l":"RegionEnterEvent"},{"p":"redempt.redlib.region","l":"RegionEnterExitListener"},{"p":"redempt.redlib.region.events","l":"RegionExitEvent"},{"p":"redempt.redlib.region","l":"RegionMap"},{"p":"redempt.redlib.region","l":"CuboidRegion.RegionState"},{"p":"redempt.redlib.region","l":"RegionUtils"},{"p":"redempt.redlib.sql","l":"SQLHelper.Results"},{"p":"redempt.redlib.multiblock","l":"Rotator"},{"p":"redempt.redlib.dev.profiler","l":"SampleSummary.SampleMethod"},{"p":"redempt.redlib.dev.profiler","l":"SampleSummary"},{"p":"redempt.redlib.region","l":"SelectionTool"},{"p":"redempt.redlib.commandmanager","l":"Command.SenderType"},{"p":"redempt.redlib.region","l":"SpheroidRegion"},{"p":"redempt.redlib.sql","l":"SQLCache"},{"p":"redempt.redlib.sql","l":"SQLHelper"},{"p":"redempt.redlib.multiblock","l":"Structure"},{"p":"redempt.redlib.multiblock","l":"Structure.StructureBlock"},{"p":"redempt.redlib.multiblock","l":"StructureData"},{"p":"redempt.redlib.dev","l":"StructureTool"},{"p":"redempt.redlib.commandmanager","l":"ArgType.TabCompleter"},{"p":"redempt.redlib.commandmanager","l":"ArgType.TabStreamCompleter"},{"p":"redempt.redlib.misc","l":"Task"},{"p":"redempt.redlib.misc","l":"Task.TaskType"},{"p":"redempt.redlib.dev.profiler","l":"TickMonitorProfiler"},{"p":"redempt.redlib.misc","l":"UserCache"},{"p":"redempt.redlib.misc","l":"WeightedRandom"}];updateSearchResults(); \ No newline at end of file diff --git a/src/redempt/redlib/commandmanager/Command.java b/src/redempt/redlib/commandmanager/Command.java index 756cb04..b2e60b1 100644 --- a/src/redempt/redlib/commandmanager/Command.java +++ b/src/redempt/redlib/commandmanager/Command.java @@ -524,7 +524,7 @@ public List tabComplete(CommandSender sender, String alias, String[] arg } } }); - registerHook(createHookMap(listeners)); + registerHook(createHookMap(listeners), plugin); } private void unregister() { @@ -547,10 +547,11 @@ protected Map createHookMap(Object... listeners) { return hooks; } - protected void registerHook(Map hooks) { + protected void registerHook(Map hooks, Plugin plugin) { for (Command child : children) { - child.registerHook(hooks); + child.registerHook(hooks, plugin); } + this.plugin = plugin; if (hook == null) { return; } @@ -559,7 +560,6 @@ protected void registerHook(Map hooks) { throw new CommandHookException("Command with hook name " + hook + " has no method hook"); } methodHook = mh.getMethod(); - plugin = JavaPlugin.getProvidingPlugin(methodHook.getDeclaringClass()); Class[] params = methodHook.getParameterTypes(); int expectedLength = args.length + contextProviders.length + flags.length + 1; Command current = this; diff --git a/src/redempt/redlib/commandmanager/CommandCollection.java b/src/redempt/redlib/commandmanager/CommandCollection.java index e8521eb..c42a8da 100644 --- a/src/redempt/redlib/commandmanager/CommandCollection.java +++ b/src/redempt/redlib/commandmanager/CommandCollection.java @@ -156,7 +156,7 @@ public void register(String prefix, Object... listeners) { super.register(prefix, listeners); Map hooks = createHookMap(listeners); for (Command command : children) { - command.registerHook(hooks); + command.registerHook(hooks, this.plugin); } }