### start(Location) - io.papermc.paper.raytracing.PositionedRayTraceConfigurationBuilder Source: https://jd.papermc.io/paper/26.2/index-all.html Sets the starting location for ray tracing configuration. ```APIDOC ## start(Location) ### Description Sets the starting location. ### Method start(Location) ### Parameters - **Location** - The starting location. ``` -------------------------------- ### JavaPlugin.init(Server, PluginDescriptionFile, File, File, ClassLoader, PluginMeta, Logger) Source: https://jd.papermc.io/paper/26.2/io/papermc/paper/plugin/configuration/class-use/PluginMeta.html Initializes the plugin with the given server, description, data folder, file, class loader, configuration, and logger. ```APIDOC ## JavaPlugin.init(Server, PluginDescriptionFile, File, File, ClassLoader, PluginMeta, Logger) ### Description Initializes the plugin with the given server, description, data folder, file, class loader, configuration, and logger. ### Method `final void init(Server server, PluginDescriptionFile description, File dataFolder, File file, ClassLoader classLoader, @Nullable PluginMeta configuration, Logger logger)` ### Parameters - **server** (Server) - Required - The server instance. - **description** (PluginDescriptionFile) - Required - The plugin description file. - **dataFolder** (File) - Required - The data folder. - **file** (File) - Required - The plugin file. - **classLoader** (ClassLoader) - Required - The class loader. - **configuration** (PluginMeta) - Optional - The plugin configuration. - **logger** (Logger) - Required - The logger. ``` -------------------------------- ### getTreasureLocation Source: https://jd.papermc.io/paper/26.2/org/bukkit/entity/Dolphin.html Gets the treasure location this dolphin tries to guide players to. This value is calculated if the player has fed the dolphin a fish, and it tries to start the VanillaGoal.DOLPHIN_SWIM_TO_TREASURE goal. ```APIDOC ## getTreasureLocation ### Description Gets the treasure location this dolphin tries to guide players to. This value is calculated if the player has fed the dolphin a fish, and it tries to start the VanillaGoal.DOLPHIN_SWIM_TO_TREASURE goal. ### Method `@Nullable Location getTreasureLocation()` ### Returns - **Location** - The calculated closest treasure location, or null if not available. ``` -------------------------------- ### PluginDescriptionFile.getLoad() Source: https://jd.papermc.io/paper/26.2/org/bukkit/plugin/class-use/PluginLoadOrder.html Gives the phase of server startup that the plugin should be loaded. ```APIDOC ## PluginDescriptionFile.getLoad() ### Description Gives the phase of server startup that the plugin should be loaded. ### Method GET ### Endpoint PluginDescriptionFile.getLoad() ### Parameters None ### Response #### Success Response (200) - **@NotNull PluginLoadOrder** - The load order. #### Response Example ```java PluginLoadOrder load = pluginDescriptionFile.getLoad(); ``` ``` -------------------------------- ### getStartLevel() Source: https://jd.papermc.io/paper/26.2/org/bukkit/enchantments/Enchantment.html Gets the level that this Enchantment should start at. ```APIDOC ## getStartLevel() ### Description Gets the level that this Enchantment should start at. ### Method `public abstract int getStartLevel()` ### Returns - **int** - Start level of the Enchantment ``` -------------------------------- ### getLoad() Source: https://jd.papermc.io/paper/26.2/org/bukkit/plugin/PluginDescriptionFile.html Gives the phase of server startup that the plugin should be loaded. Possible values are in PluginLoadOrder. Defaults to PluginLoadOrder.POSTWORLD. ```APIDOC ## [GET] /getLoad ### Description Gives the phase of server startup that the plugin should be loaded. Possible values are in PluginLoadOrder. Defaults to PluginLoadOrder.POSTWORLD. ### Method GET ### Endpoint /load ### Parameters None ### Request Example N/A ### Response #### Success Response (200) - **load** (PluginLoadOrder) - The phase when the plugin should be loaded. #### Response Example { "load": "POSTWORLD" } ``` -------------------------------- ### getStartLevel() Source: https://jd.papermc.io/paper/26.2/org/bukkit/enchantments/Enchantment.html Gets the level that this Enchantment should start at. ```APIDOC ## getStartLevel() ### Description Gets the level that this Enchantment should start at. ### Method `abstract int getStartLevel()` ### Returns - `int` - the start level. ``` -------------------------------- ### startWobble(DecoratedPot.WobbleStyle) Source: https://jd.papermc.io/paper/26.2/org/bukkit/block/DecoratedPot.html Runs the specified animation on the decorated pot. ```APIDOC ## startWobble ### Description Runs the specified animation on the decorated pot. ### Method void ### Signature void startWobble(@NotNull DecoratedPot.WobbleStyle style) ### Parameters - **style** (DecoratedPot.WobbleStyle) - Required - The animation style. ### Throws - **IllegalStateException** - if this block state is not placed. ``` -------------------------------- ### Get relative block and set type Source: https://jd.papermc.io/paper/26.2/org/bukkit/block/Block.html Shows how to get a block two blocks above a given block and set its type to water. The example places water at 100,102,100. ```java Block block = world.getBlockAt(100, 100, 100); Block shower = block.getRelative(BlockFace.UP, 2); shower.setType(Material.WATER); ``` -------------------------------- ### getResonatingTicks() Source: https://jd.papermc.io/paper/26.2/org/bukkit/block/Bell.html Gets the number of ticks since the bell started resonating, or 0 if not resonating. ```APIDOC ## getResonatingTicks() ### Description Gets the amount of ticks since this bell has been resonating, or 0 if the bell is not currently resonating. A bell will typically resonate for 40 ticks. ### Method getResonatingTicks ### Signature `int getResonatingTicks()` ### Returns - `int` - the time in ticks since the bell has been resonating, or 0 if not resonating ``` -------------------------------- ### PluginMeta.getLoadOrder() Source: https://jd.papermc.io/paper/26.2/org/bukkit/plugin/class-use/PluginLoadOrder.html Returns the phase of the server startup logic that the plugin should be loaded. ```APIDOC ## PluginMeta.getLoadOrder() ### Description Returns the phase of the server startup logic that the plugin should be loaded. ### Method GET ### Endpoint PluginMeta.getLoadOrder() ### Parameters None ### Response #### Success Response (200) - **PluginLoadOrder** - The load order phase. #### Response Example ```java PluginLoadOrder order = pluginMeta.getLoadOrder(); ``` ``` -------------------------------- ### PositionedRayTraceConfigurationBuilder.start(Location) Source: https://jd.papermc.io/paper/26.2/io/papermc/paper/raytracing/class-use/PositionedRayTraceConfigurationBuilder.html Sets the starting location. Returns the builder for chaining. ```APIDOC ## PositionedRayTraceConfigurationBuilder.start(Location) ### Description Sets the starting location. ### Method start ### Parameters - **start** (Location) - Required - The starting location. ### Returns PositionedRayTraceConfigurationBuilder - This builder for chaining. ``` -------------------------------- ### getShakingTicks() Source: https://jd.papermc.io/paper/26.2/org/bukkit/block/Bell.html Gets the number of ticks since the bell started shaking, or 0 if not shaking. ```APIDOC ## getShakingTicks() ### Description Gets the amount of ticks since this bell has been shaking, or 0 if the bell is not currently shaking. A bell will typically shake for 50 ticks. ### Method getShakingTicks ### Signature `int getShakingTicks()` ### Returns - `int` - the time in ticks since the bell was rung, or 0 if not shaking ``` -------------------------------- ### getVoidDamageMinBuildHeightOffset() Source: https://jd.papermc.io/paper/26.2/org/bukkit/World.html Gets the offset applied to WorldInfo.getMinHeight() to determine the height at which void damage starts to apply. ```APIDOC ## getVoidDamageMinBuildHeightOffset ### Description Gets the offset applied to `WorldInfo.getMinHeight()` to determine the height at which void damage starts to apply. ### Method `double getVoidDamageMinBuildHeightOffset()` ### Returns - **double** - The offset. ``` -------------------------------- ### startUsingItem(EquipmentSlot hand) Source: https://jd.papermc.io/paper/26.2/org/bukkit/entity/LivingEntity.html Starts using the item in the specified hand, making it the currently active item. ```APIDOC ## startUsingItem(EquipmentSlot hand) ### Description Starts using the item in the specified hand, making it the currently active item. ### Method startUsingItem ### Parameters - **hand** (EquipmentSlot) - Required - The hand. ### Returns void ``` -------------------------------- ### begin() Source: https://jd.papermc.io/paper/26.2/org/bukkit/conversations/Conversation.html Displays the first prompt of this conversation and begins redirecting the user's chat responses. ```APIDOC ## begin ### Description Displays the first prompt of this conversation and begins redirecting the user's chat responses. ### Method public void begin() ### Deprecated This API element is subject to removal in a future version. ``` -------------------------------- ### getExample() Source: https://jd.papermc.io/paper/26.2/org/bukkit/inventory/EquipmentSlotGroup.html Gets an EquipmentSlot that is an example of a slot in this group. This method is deprecated and intended for internal compatibility only. ```APIDOC ## getExample() ### Description Gets an EquipmentSlot which is an example of a slot in this group. Deprecated for internal compatibility use only. ### Method `@Deprecated(since="1.20.5") @Internal public @NotNull EquipmentSlot getExample()` ### Returns - **EquipmentSlot** - an example slot ### Deprecation Deprecated since 1.20.5. For internal compatibility use only. ### Usage Example ```java EquipmentSlotGroup group = EquipmentSlotGroup.HEAD; EquipmentSlot example = group.getExample(); // e.g., EquipmentSlot.HEAD ``` ``` -------------------------------- ### getType() Source: https://jd.papermc.io/paper/26.2/org/bukkit/event/server/ServerLoadEvent.html Gets the context in which the server was loaded. Returns the LoadType enum value indicating whether the server was started or reloaded. ```APIDOC ## getType() ### Description Gets the context in which the server was loaded. ### Method `@NotNull public @NotNull ServerLoadEvent.LoadType getType()` ### Returns - **ServerLoadEvent.LoadType** - the context in which the server was loaded ``` -------------------------------- ### getServer() Source: https://jd.papermc.io/paper/26.2/org/bukkit/Bukkit.html Gets the current Server singleton ```APIDOC ## [GET] getServer() ### Description Gets the current `Server` singleton ### Method GET ### Endpoint `static @NotNull Server getServer()` ### Response #### Success Response (200) - **return** (Server) - The server instance. #### Response Example ```json { "server": {} } ``` ``` -------------------------------- ### Get face relation between blocks with getFace() Source: https://jd.papermc.io/paper/26.2/org/bukkit/block/Block.html Shows how to compare the face relation between two blocks using getFace(). The example creates two adjacent blocks and checks that the face of the current block relative to the target is BlockFace.Up. ```java Block current = world.getBlockAt(100, 100, 100); Block target = world.getBlockAt(100, 101, 100); current.getFace(target) == BlockFace.Up; ``` -------------------------------- ### JavaPlugin.init(PluginLoader loader, Server server, PluginDescriptionFile description, File dataFolder, File file, ClassLoader classLoader) Source: https://jd.papermc.io/paper/26.2/org/bukkit/plugin/class-use/PluginDescriptionFile.html Initializes a Java plugin with the given parameters. ```APIDOC ## JavaPlugin.init(PluginLoader loader, Server server, PluginDescriptionFile description, File dataFolder, File file, ClassLoader classLoader) ### Description Initializes the Java plugin with the given parameters. ### Method final void ### Parameters - **loader** (PluginLoader) - Required - The plugin loader. - **server** (Server) - Required - The server instance. - **description** (PluginDescriptionFile) - Required - The plugin description. - **dataFolder** (File) - Required - The data folder. - **file** (File) - Required - The plugin file. - **classLoader** (ClassLoader) - Required - The class loader. ### Returns - **void** - No return value. ``` -------------------------------- ### startPlaying() - org.bukkit.block.Jukebox Source: https://jd.papermc.io/paper/26.2/index-all.html Starts the jukebox playing if there is a record. ```APIDOC ## startPlaying() ### Description Starts the jukebox playing if there is a record. ### Method startPlaying() ``` -------------------------------- ### FallingBlock.getBlockState() Source: https://jd.papermc.io/paper/26.2/org/bukkit/block/class-use/BlockState.html Get the data of the falling block represented as a BlockState which includes potential NBT data that gets applied when the block gets placed on landing. ```APIDOC ## FallingBlock.getBlockState() ### Description Get the data of the falling block represented as a BlockState which includes potential NBT data that gets applied when the block gets placed on landing. ### Method getBlockState() ### Returns - `BlockState` - The BlockState of the falling block. ``` -------------------------------- ### startCooking (no index) Source: https://jd.papermc.io/paper/26.2/org/bukkit/block/Campfire.html Re-enables cooking in all slots. ```APIDOC ## startCooking (no index) ### Description Re-enables cooking in all slots. ### Method void startCooking() ``` -------------------------------- ### width() - YamlConfigurationOptions Source: https://jd.papermc.io/paper/26.2/index-all.html Gets how long a line can be, before it gets split. ```APIDOC ## width() ### Description Gets how long a line can be, before it gets split. ### Method width() ### Class org.bukkit.configuration.file.YamlConfigurationOptions ``` -------------------------------- ### getModZ() Source: https://jd.papermc.io/paper/26.2/org/bukkit/block/BlockFace.html Get the amount of Z-coordinates to modify to get the represented block. ```APIDOC ## getModZ() ### Description Get the amount of Z-coordinates to modify to get the represented block. ### Method getModZ() ### Returns - **int** - Amount of Z-coordinates to modify ``` -------------------------------- ### startUsingItem(EquipmentSlot) - org.bukkit.entity.LivingEntity Source: https://jd.papermc.io/paper/26.2/index-all.html Starts using the item in the specified hand, making it the currently active item. ```APIDOC ## startUsingItem(EquipmentSlot) ### Description Starts using the item in the specified hand, making it the currently active item. ### Method startUsingItem(EquipmentSlot) ### Parameters - **EquipmentSlot** - The hand to use. ``` -------------------------------- ### getModY() Source: https://jd.papermc.io/paper/26.2/org/bukkit/block/BlockFace.html Get the amount of Y-coordinates to modify to get the represented block. ```APIDOC ## getModY() ### Description Get the amount of Y-coordinates to modify to get the represented block. ### Method getModY() ### Returns - **int** - Amount of Y-coordinates to modify ``` -------------------------------- ### ServerBuildInfo.buildInfo() Source: https://jd.papermc.io/paper/26.2/io/papermc/paper/class-use/ServerBuildInfo.html Gets the ServerBuildInfo instance. This static method is the only explicitly documented way to obtain a ServerBuildInfo object. ```APIDOC ## ServerBuildInfo.buildInfo() ### Description Gets the `ServerBuildInfo`. ### Method STATIC ### Signature `static ServerBuildInfo buildInfo()` ### Returns - **ServerBuildInfo** - The server build information. ``` -------------------------------- ### getModX() Source: https://jd.papermc.io/paper/26.2/org/bukkit/block/BlockFace.html Get the amount of X-coordinates to modify to get the represented block. ```APIDOC ## getModX() ### Description Get the amount of X-coordinates to modify to get the represented block. ### Method getModX() ### Returns - **int** - Amount of X-coordinates to modify ``` -------------------------------- ### startUsingItem Source: https://jd.papermc.io/paper/26.2/org/bukkit/entity/LivingEntity.html Starts using the item in the specified hand, making it the currently active item. ```APIDOC ## void startUsingItem(@NotNull EquipmentSlot hand) ### Description Starts using the item in the specified hand, making it the currently active item. When, for example, called on a skeleton, this will cause it to start drawing its bow. Only HAND or OFF_HAND may be used for the hand parameter. When used on a player, the client will stop using the item if right click is held down. This method does not make any guarantees about the effect of this method as such depends on the entity and its state. ### Method POST ### Endpoint `void startUsingItem(@NotNull EquipmentSlot hand)` ### Parameters - **hand** (EquipmentSlot) - Required - The hand that contains the item to be used. ``` -------------------------------- ### get(Class, String) Source: https://jd.papermc.io/paper/26.2/org/bukkit/UnsafeValues.html Deprecated method to get an element by class and value. ```APIDOC ## get(Class, String) ### Description Deprecated. This method is deprecated. ### Method get ### Parameters - `elementClass` (Class) - Required - The class of the element - `value` (String) - Required - The value ### Deprecated This method is deprecated. ``` -------------------------------- ### open() Source: https://jd.papermc.io/paper/26.2/index-all.html Method in interface org.bukkit.inventory.InventoryView that opens the inventory view. ```APIDOC ## open() ### Description Opens the inventory view. ### Method open ### Signature `void open()` ``` -------------------------------- ### Player.spigot() Source: https://jd.papermc.io/paper/26.2/org/bukkit/entity/class-use/Player.Spigot.html Documentation for the Player.spigot() method that returns the Player.Spigot API. ```APIDOC ## Player.Spigot ### Description Returns the Spigot-specific API for this player. ### Method spigot() ### Return Type Player.Spigot ### Usage Player player = ...; Player.Spigot spigot = player.spigot(); ``` -------------------------------- ### start() - io.papermc.paper.registry.data.dialog.input.NumberRangeDialogInput Source: https://jd.papermc.io/paper/26.2/index-all.html Returns the start of the range for a number range dialog input. ```APIDOC ## start() ### Description Returns the start of the range. ### Method start() ### Return Type Not specified in source. ``` -------------------------------- ### SimpleCommandMap(Server server, Map backing) Source: https://jd.papermc.io/paper/26.2/org/bukkit/command/class-use/Command.html Constructs a simple command map with the given server and backing map. ```APIDOC ## SimpleCommandMap(Server server, Map backing) ### Description Constructs a simple command map. ### Constructor `SimpleCommandMap(@NotNull Server server, Map backing)` ### Parameters - **server** (Server) - Required - The server instance. - **backing** (Map) - Required - The backing map of commands. ``` -------------------------------- ### allow() Source: https://jd.papermc.io/paper/26.2/org/bukkit/event/player/PlayerPreLoginEvent.html Allows the player to log in. ```APIDOC ## Method: allow() ### Description Allows the player to log in. ### Signature `void allow()` ### Return Type void ### Deprecated Deprecated. ``` -------------------------------- ### get(RegistryKey, NamespacedKey) Source: https://jd.papermc.io/paper/26.2/org/bukkit/UnsafeValues.html Deprecated method to get a keyed value from a registry. ```APIDOC ## get(RegistryKey, NamespacedKey) ### Description Deprecated. This method is deprecated. ### Method get ### Parameters - `registry` (RegistryKey) - Required - The registry key - `key` (NamespacedKey) - Required - The namespaced key ### Returns - The value of type `B` or `null` ### Deprecated This method is deprecated. ``` -------------------------------- ### allow() Source: https://jd.papermc.io/paper/26.2/org/bukkit/event/player/PlayerPreLoginEvent.html Allows the player to log in. ```APIDOC ### Method ACTION ### Endpoint `PlayerPreLoginEvent.allow()` ### Description Allows the player to log in. ### Deprecated This method is deprecated. ``` -------------------------------- ### getEnabledPacks() Source: https://jd.papermc.io/paper/26.2/io/papermc/paper/datapack/DatapackManager.html Gets the enabled datapacks. May require calling `refreshPacks()` before to get the latest pack information. ```APIDOC ## getEnabledPacks() ### Description Gets the enabled datapacks. May require calling `refreshPacks()` before to get the latest pack information. ### Method `@Unmodifiable Collection getEnabledPacks()` ### Parameters None. ### Returns - `@Unmodifiable Collection` - All the packs which are currently enabled. ``` -------------------------------- ### getPacks() Source: https://jd.papermc.io/paper/26.2/io/papermc/paper/datapack/DatapackManager.html Gets the available datapacks. May require calling `refreshPacks()` before to get the latest pack information. ```APIDOC ## getPacks() ### Description Gets the available datapacks. May require calling `refreshPacks()` before to get the latest pack information. ### Method `@Unmodifiable Collection getPacks()` ### Parameters None. ### Returns - `@Unmodifiable Collection` - All the packs known to the server. ``` -------------------------------- ### create Source: https://jd.papermc.io/paper/26.2/org/bukkit/MusicInstrument.html Creates an inlined music instrument using a builder factory consumer. ```APIDOC ## create ### Description Creates an inlined music instrument. ### Method public static MusicInstrument create(Consumer> value) ### Parameters - `value` (Consumer>) - Required - A consumer for the builder factory. ### Returns - MusicInstrument - The created music instrument. ``` -------------------------------- ### setLocked(boolean) - org.bukkit.map.MapView Source: https://jd.papermc.io/paper/26.2/index-all.html Gets whether the map is locked or not. (Note: The description says 'Gets', but the method is 'set'.) ```APIDOC ## setLocked(boolean) ### Description Gets whether the map is locked or not. (Note: The description says 'Gets', but the method is 'set'.) ### Method setLocked ### Parameters - **boolean** - The locked state. ``` -------------------------------- ### getPack(String name) Source: https://jd.papermc.io/paper/26.2/io/papermc/paper/datapack/DatapackManager.html Gets a datapack by name. May require calling `refreshPacks()` before to get the latest pack information. ```APIDOC ## getPack(String name) ### Description Gets a datapack by name. May require calling `refreshPacks()` before to get the latest pack information. ### Method `@Nullable Datapack getPack(String name)` ### Parameters - `name` (String) - Required - The name/id of the datapack. ### Returns - `@Nullable Datapack` - The datapack, or null if not found. ``` -------------------------------- ### startTrackingPlayer(Player player) Source: https://jd.papermc.io/paper/26.2/org/bukkit/block/TrialSpawner.html Force this spawner to start tracking the provided player. ```APIDOC ## startTrackingPlayer(Player player) ### Description Force this spawner to start tracking the provided player. ### Method POST ### Endpoint TrialSpawner.startTrackingPlayer(Player player) ### Parameters - **player** (Player) - Required - the player to start tracking ``` -------------------------------- ### Vine() Source: https://jd.papermc.io/paper/26.2/org/bukkit/material/Vine.html Constructs a new Vine instance with default data. ```APIDOC ## [CONSTRUCTOR] Vine() ### Description Creates a new Vine instance with default data. ### Method CONSTRUCTOR ### Endpoint Vine() ### Parameters None ### Response #### Success Response - **vine** (Vine) - The newly created Vine instance. #### Response Example ```java Vine vine = new Vine(); ``` ``` -------------------------------- ### Farmland Interface Methods Source: https://jd.papermc.io/paper/26.2/org/bukkit/block/data/type/Farmland.html Methods to get and set the moisture level of a farmland block, and to get the maximum allowed moisture value. ```APIDOC ## getMoisture() ### Description Gets the value of the 'moisture' property of the farmland block. ### Method `int getMoisture()` ### Returns - `int` - the 'moisture' value ``` ```APIDOC ## setMoisture(int moisture) ### Description Sets the value of the 'moisture' property of the farmland block. ### Method `void setMoisture(int moisture)` ### Parameters - `moisture` (int) - the new 'moisture' value ``` ```APIDOC ## getMaximumMoisture() ### Description Gets the maximum allowed value of the 'moisture' property of the farmland block. ### Method `int getMaximumMoisture()` ### Returns - `int` - the maximum 'moisture' value ``` -------------------------------- ### autoEnableOnServerStart(boolean autoEnableOnServerStart) Source: https://jd.papermc.io/paper/26.2/io/papermc/paper/datapack/DatapackRegistrar.Configurer.html Sets whether this pack is going to be automatically enabled on server starts even if previously disabled. Defaults to false. Returns the configurer for chaining. ```APIDOC ## autoEnableOnServerStart(boolean autoEnableOnServerStart) ### Description Sets whether this pack is going to be automatically enabled on server starts even if previously disabled. Defaults to false. ### Method `DatapackRegistrar.Configurer autoEnableOnServerStart(boolean autoEnableOnServerStart)` ### Parameters - `autoEnableOnServerStart` (boolean) - Required - true to ensure the pack is enabled on server starts. ### Returns - `DatapackRegistrar.Configurer` - The configurer for chaining. ``` -------------------------------- ### lore() Source: https://jd.papermc.io/paper/26.2/org/bukkit/inventory/meta/ItemMeta.html Gets the lore. ```APIDOC ## lore() ### Description Gets the lore. ### Method `@Nullable List lore()` ### Returns - `@Nullable List` - The lore components, or null if not set. ``` -------------------------------- ### y() Source: https://jd.papermc.io/paper/26.2/org/bukkit/Location.html Gets the y value for this position. ```APIDOC ## y() ### Description Gets the y value for this position. ### Method double ### Parameters None ### Returns - **double** - The y value ``` -------------------------------- ### Set load phase to STARTUP in plugin.yml Source: https://jd.papermc.io/paper/26.2/org/bukkit/plugin/PluginDescriptionFile.html Sets the plugin load phase to STARTUP in plugin.yml. Defaults to POSTWORLD if not specified. ```yaml load: STARTUP ``` -------------------------------- ### WrittenBookContent.title() Source: https://jd.papermc.io/paper/26.2/index-all.html Gets the title of this book. ```APIDOC ## Method: title() ### Description Title of this book. ### Interface io.papermc.paper.datacomponent.item.WrittenBookContent ``` -------------------------------- ### ServerBuildInfo.asString(ServerBuildInfo.StringRepresentation representation) Source: https://jd.papermc.io/paper/26.2/io/papermc/paper/class-use/ServerBuildInfo.StringRepresentation.html Creates a string representation of the server build information. ```APIDOC ## ServerBuildInfo.asString(ServerBuildInfo.StringRepresentation representation) ### Description Creates a string representation of the server build information. ### Method asString ### Signature `String asString(ServerBuildInfo.StringRepresentation representation)` ### Parameters - **representation** (ServerBuildInfo.StringRepresentation) - Required - The string representation type to use. ### Returns - **String** - A string representation of the server build information. ``` -------------------------------- ### AdvancementDisplay.title() Source: https://jd.papermc.io/paper/26.2/index-all.html Gets the advancement title. ```APIDOC ## Method: title() ### Description Gets the advancement title. ### Interface io.papermc.paper.advancement.AdvancementDisplay ``` -------------------------------- ### HelpMap.registerHelpTopicFactory Source: https://jd.papermc.io/paper/26.2/org/bukkit/help/class-use/HelpTopicFactory.html Registers a HelpTopicFactory for a command class to customize help topics. ```APIDOC ## HelpMap.registerHelpTopicFactory ### Description Associates a `HelpTopicFactory` object with a given command base class. This allows custom help topics to be generated for commands of the specified class. ### Method registerHelpTopicFactory ### Parameters - **commandClass** (Class) - Required - The command base class to associate with the factory. - **factory** (HelpTopicFactory) - Required - The factory that will create help topics for the command class. ### Returns void ``` -------------------------------- ### getFullText(CommandSender sender) Source: https://jd.papermc.io/paper/26.2/org/bukkit/help/IndexHelpTopic.html Returns the full description of this help topic that is displayed when the user requests this topic's details. The result will be paginated to properly fit the user's client. ```APIDOC ## [METHOD] getFullText(CommandSender sender) ### Description Returns the full description of this help topic that is displayed when the user requests this topic's details. The result will be paginated to properly fit the user's client. ### Method METHOD ### Endpoint public String getFullText(CommandSender sender) ### Parameters #### Parameters - **sender** (CommandSender) - Required - The player or console requesting the full text. ### Request Example ```java String fullText = helpTopic.getFullText(sender); ``` ### Response #### Success Response (String) - **String** - A full topic description. #### Response Example ```java "Index of topics:\n- Topic1\n- Topic2" ``` ``` -------------------------------- ### registry() Source: https://jd.papermc.io/paper/26.2/index-all.html Get the writable registry. ```APIDOC ## registry() ### Description Get the writable registry. ### Method registry ### Signature registry() ### Returns WritableRegistry - The writable registry. ### Interface io.papermc.paper.registry.event.RegistryComposeEvent ``` -------------------------------- ### getTimeZone() Source: https://jd.papermc.io/paper/26.2/index-all.html Gets the time zone. ```APIDOC ## getTimeZone() ### Description Gets the time zone. ### Method GET ### Endpoint `YamlRepresenter.getTimeZone()` ### Parameters None ### Response #### Success Response - **TimeZone** - The time zone. ``` -------------------------------- ### HelpTopic Source: https://jd.papermc.io/paper/26.2/org/bukkit/help/HelpTopic.html Documentation for the HelpTopic class, including its constructor, methods, and field details. ```APIDOC ## HelpTopic ### Description Represents a topic of help content that can be displayed to a player or console. This class provides methods to determine visibility, retrieve topic information, and allow server administrators to amend the topic's content and permissions. ### Constructor `public HelpTopic()` ### Methods #### canSee `public abstract boolean canSee(@NotNull CommandSender player)` Determines if a `Player` is allowed to see this help topic. HelpTopic implementations should take server administrator wishes into account as set by the `amendCanSee(String)` function. **Parameters:** - `player` (CommandSender) - The Player in question. **Returns:** - `boolean` - True if the Player can see this help topic, false otherwise. #### amendCanSee `public void amendCanSee(@Nullable String amendedPermission)` Allows the server administrator to override the permission required to see a help topic. HelpTopic implementations should take this into account when determining topic visibility on the `canSee(org.bukkit.command.CommandSender)` function. **Parameters:** - `amendedPermission` (String) - The permission node the server administrator wishes to apply to this topic. #### getName `@NotNull public @NotNull String getName()` Returns the name of this help topic. **Returns:** - `String` - The topic name. #### getShortText `@NotNull public @NotNull String getShortText()` Returns a brief description that will be displayed in the topic index. **Returns:** - `String` - A brief topic description. #### getFullText `@NotNull public @NotNull String getFullText(@NotNull CommandSender forWho)` Returns the full description of this help topic that is displayed when the user requests this topic's details. The result will be paginated to properly fit the user's client. **Parameters:** - `forWho` (CommandSender) - The player or console requesting the full text. Useful for further security trimming the command's full text based on sub-permissions in custom implementations. **Returns:** - `String` - A full topic description. #### amendTopic `public void amendTopic(@Nullable String amendedShortText, @Nullable String amendedFullText)` Allows the server admin (or another plugin) to add or replace the contents of a help topic. A null in either parameter will leave that part of the topic unchanged. In either amending parameter, the string `` is replaced with the existing contents in the help topic. Use this to append or prepend additional content into an automatically generated help topic. **Parameters:** - `amendedShortText` (String) - The new topic short text to use, or null to leave alone. - `amendedFullText` (String) - The new topic full text to use, or null to leave alone. #### applyAmendment `@NotNull protected @NotNull String applyAmendment(@NotNull String baseText, @Nullable String amendment)` Developers implementing their own custom HelpTopic implementations can use this utility method to ensure their implementations comply with the expected behavior of the `amendTopic(String, String)` method. **Parameters:** - `baseText` (String) - The existing text of the help topic. - `amendment` (String) - The amending text from the amendTopic() method. **Returns:** - `String` - The application of the amending text to the existing text, according to the expected rules of amendTopic(). ``` -------------------------------- ### options() Source: https://jd.papermc.io/paper/26.2/org/bukkit/configuration/file/FileConfiguration.html Gets the FileConfigurationOptions for this FileConfiguration. All setters through this method are chainable. ```APIDOC ## options() ### Description Gets the `ConfigurationOptions` for this `Configuration`. All setters through this method are chainable. ### Method options ### Signature @NotNull public @NotNull FileConfigurationOptions options() ### Returns - **FileConfigurationOptions** - The FileConfigurationOptions for this configuration. ``` -------------------------------- ### getTextOpacity() Source: https://jd.papermc.io/paper/26.2/index-all.html Gets the text opacity. ```APIDOC ## getTextOpacity() ### Description Gets the text opacity. ### Method GET ### Endpoint org.bukkit.entity.TextDisplay#getTextOpacity() ### Response #### Success Response - **byte** - The text opacity. ``` -------------------------------- ### startCooking (with index) Source: https://jd.papermc.io/paper/26.2/org/bukkit/block/Campfire.html Re-enables cooking in the specified slot index. ```APIDOC ## startCooking (with index) ### Description Re-enables cooking in the specified slot index. ### Method boolean startCooking(int index) ### Parameters - **index** (int) - item slot index ### Returns - **boolean** - whether the slot couldn't cook before this call ``` -------------------------------- ### getTemperature() Source: https://jd.papermc.io/paper/26.2/index-all.html Gets the temperature of this block. ```APIDOC ## getTemperature() ### Description Gets the temperature of this block. ### Method GET ### Endpoint org.bukkit.block.Block#getTemperature() ### Response #### Success Response - **double** - The temperature. ``` -------------------------------- ### getStructureName() Source: https://jd.papermc.io/paper/26.2/index-all.html Gets the name of this structure. ```APIDOC ## getStructureName() - Method in interface org.bukkit.block.Structure ### Description The name of this structure. ### Method GET ### Endpoint org.bukkit.block.Structure.getStructureName() ### Response #### Success Response (200) - **String** - The name of this structure. #### Response Example ``` "structure_name" ``` ``` -------------------------------- ### open() Source: https://jd.papermc.io/paper/26.2/org/bukkit/inventory/InventoryView.html Opens the inventory view. ```APIDOC ## open() ### Description Opens the inventory view. ### Method `void open()` ``` -------------------------------- ### getRepairCost() Source: https://jd.papermc.io/paper/26.2/index-all.html Gets the repair penalty ```APIDOC ## getRepairCost() ### Description Gets the repair penalty ### Return Type int ``` -------------------------------- ### open() Source: https://jd.papermc.io/paper/26.2/org/bukkit/inventory/InventoryView.html Opens the inventory view. ```APIDOC ## open() ### Description Opens the inventory view. ### Method `void open()` ### Parameters None ### Returns void ``` -------------------------------- ### createTopic(TCommand command) Source: https://jd.papermc.io/paper/26.2/org/bukkit/help/HelpTopicFactory.html Creates a custom HelpTopic for the given command. This method is called by the help system when a factory is registered for the command's base class. It should return a new HelpTopic instance or null to intentionally skip creating a topic. ```APIDOC ## createTopic(TCommand command) ### Description This method accepts a command deriving from a custom command base class and constructs a custom HelpTopic for it. ### Method createTopic ### Signature @Nullable HelpTopic createTopic(@NotNull TCommand command) ### Parameters - **command** (TCommand) - Required - The custom command to build a help topic for. ### Returns - **HelpTopic** - A new custom help topic or `null` to intentionally NOT create a topic. ### Usage Notes - This method is part of the HelpTopicFactory interface. - Implement this method to provide custom help topics for commands that extend a common base class. - Return `null` to skip creating a help topic for the command. ``` -------------------------------- ### getCriteria() Source: https://jd.papermc.io/paper/26.2/index-all.html Gets all criteria for an advancement. ```APIDOC ## getCriteria() ### Description Get all the criteria present in this advancement. ### Method GET ### Endpoint org.bukkit.advancement.Advancement#getCriteria() ### Parameters None ### Response #### Success Response (200) - **criteria** (Collection) - All criteria. ``` -------------------------------- ### FurnaceStartSmeltEvent Constructor (with cookingTime) Source: https://jd.papermc.io/paper/26.2/org/bukkit/event/inventory/FurnaceStartSmeltEvent.html Creates a new FurnaceStartSmeltEvent with the specified furnace block, source item, recipe, and total cook time. ```APIDOC ## [CONSTRUCTOR] FurnaceStartSmeltEvent ### Description Creates a new FurnaceStartSmeltEvent with the specified furnace block, source item, recipe, and total cook time. ### Method Constructor ### Parameters - **furnace** (Block) - Required - The furnace block involved in the event. - **source** (ItemStack) - Required - The source item being smelted. - **recipe** (CookingRecipe) - Required - The recipe being used for smelting. - **cookingTime** (int) - Required - The total cook time in ticks. ### Example ```java FurnaceStartSmeltEvent event = new FurnaceStartSmeltEvent(furnace, source, recipe, cookingTime); ``` ``` -------------------------------- ### getSize() Source: https://jd.papermc.io/paper/26.2/org/bukkit/scoreboard/Team.html Gets the size of the team. ```APIDOC ## getSize() ### Description Gets the size of the team. ### Method GET ### Endpoint Team#getSize() ### Parameters None ### Returns - **int** - number of entries on the team ### Throws - **IllegalStateException** - if this team has been unregistered ``` -------------------------------- ### getName() Source: https://jd.papermc.io/paper/26.2/org/bukkit/scoreboard/Team.html Gets the name of this Team. ```APIDOC ## getName() ### Description Gets the name of this Team. ### Method `@NotNull String getName()` ### Returns - **String** - Objective name ### Throws - `IllegalStateException` - if this team has been unregistered ``` -------------------------------- ### create() Source: https://jd.papermc.io/paper/26.2/io/papermc/paper/inventory/tooltip/TooltipContext.html Creates a new context that is neither advanced nor creative. ```APIDOC ## create() ### Description Creates a new context that is neither advanced nor creative. ### Method static TooltipContext create() ### Parameters None ### Returns - a new context ``` -------------------------------- ### SpawnEggMeta Interface Source: https://jd.papermc.io/paper/26.2/org/bukkit/inventory/meta/SpawnEggMeta.html Documentation for the SpawnEggMeta interface, including all its methods with parameters, return types, and deprecation notes. ```APIDOC ## SpawnEggMeta Interface ### Description Represents a spawn egg and its spawned type. This interface extends ItemMeta and provides methods to get and set the entity type or EntitySnapshot that the spawn egg will spawn. ### Methods #### clone() - **Return Type**: `@NotNull SpawnEggMeta` - **Description**: Creates a copy of this spawn egg meta. #### getCustomSpawnedType() - **Return Type**: `@Nullable EntityType` - **Description**: Gets the custom type of entity this egg will spawn. #### getSpawnedEntity() - **Return Type**: `@Nullable EntitySnapshot` - **Description**: Gets the `EntitySnapshot` that will be spawned by this spawn egg or null if no entity has been set. #### getSpawnedType() - **Return Type**: `EntityType` - **Deprecated**: This API element is subject to removal in a future version. Different types are different items. - **Description**: Gets the type of entity this egg will spawn. #### setCustomSpawnedType(@Nullable EntityType type) - **Parameters**: - `type` (`@Nullable EntityType`) - The custom entity type to set. - **Return Type**: `void` - **Description**: Sets the custom type of entity this egg will spawn. #### setSpawnedEntity(@NotNull EntitySnapshot snapshot) - **Parameters**: - `snapshot` (`@NotNull EntitySnapshot`) - The entity snapshot to set. - **Return Type**: `void` - **Description**: Sets the `EntitySnapshot` that will be spawned by this spawn egg. #### setSpawnedType(EntityType type) - **Parameters**: - `type` (`EntityType`) - The entity type to set. - **Return Type**: `void` - **Deprecated**: This API element is subject to removal in a future version. Different types are different items. - **Description**: Sets the type of entity this egg will spawn. ``` -------------------------------- ### getScore() Source: https://jd.papermc.io/paper/26.2/org/bukkit/scoreboard/Score.html Gets the current score. ```APIDOC ## getScore() ### Description Gets the current score. ### Method GET ### Endpoint Score.getScore() ### Returns - **int** - the current score ### Throws - **IllegalStateException** - if the associated objective has been unregistered ``` -------------------------------- ### getTextures() Source: https://jd.papermc.io/paper/26.2/org/bukkit/profile/PlayerProfile.html Gets the PlayerTextures of this profile. ```APIDOC ## getTextures() ### Description Gets the `PlayerTextures` of this profile. ### Method `@NotNull PlayerTextures getTextures()` ### Returns - `@NotNull PlayerTextures` - the textures ``` -------------------------------- ### createWorld() Source: https://jd.papermc.io/paper/26.2/org/bukkit/WorldCreator.html Creates a world with the specified options. If the world already exists, it will be loaded from disk and some options may be ignored. ```APIDOC ## [METHOD] createWorld() ### Description Creates a world with the specified options. If the world already exists, it will be loaded from disk and some options may be ignored. ### Method createWorld ### Returns Newly created or loaded world ``` -------------------------------- ### startTrackingPlayer Source: https://jd.papermc.io/paper/26.2/org/bukkit/block/TrialSpawner.html Force this spawner to start tracking the provided player. The spawner may decide to stop tracking this player at any given time. ```APIDOC ## startTrackingPlayer ### Description Force this spawner to start tracking the provided player. The spawner may decide to stop tracking this player at any given time. ### Method POST ### Endpoint TrialSpawner.startTrackingPlayer(Player player) ### Parameters #### Path Parameters - **player** (Player) - Required - the player ### Returns void ``` -------------------------------- ### getPlugin() Source: https://jd.papermc.io/paper/26.2/org/bukkit/plugin/messaging/PluginMessageListenerRegistration.html Gets the plugin that this registration is for. ```APIDOC ## Method: getPlugin ### Signature ```java @NotNull public @NotNull Plugin getPlugin() ``` ### Description Gets the plugin that this registration is for. ### Returns - **Plugin** - The registered plugin. ``` -------------------------------- ### getChildren() Source: https://jd.papermc.io/paper/26.2/org/bukkit/permissions/Permission.html Gets the children of this permission. ```APIDOC ## Method: getChildren() ### Description Gets the children of this permission. If you change this map in any form, you must call `recalculatePermissibles()` to recalculate all `Permissible`s. ### Returns - **Map** - The children of this permission. ### Example ```java Permission perm = new Permission("example.permission"); Map children = perm.getChildren(); ``` ``` -------------------------------- ### ExperienceOrb.SpawnReason Source: https://jd.papermc.io/paper/26.2/org/bukkit/entity/ExperienceOrb.SpawnReason.html Documentation for the ExperienceOrb.SpawnReason enum, including its constants and static methods. ```APIDOC ## ExperienceOrb.SpawnReason Enum ### Description Reasons for why this Experience Orb was spawned. ### Enum Constants - `BLOCK_BREAK` - Spawned by player breaking a block that gives experience points such as Diamond Ore - `BREED` - Spawned by player breeding animals - `CUSTOM` - Spawned by Bukkit API - `ENTITY_DEATH` - Spawned by an entity dying after being damaged by a player - `EXP_BOTTLE` - Spawned by a player throwing an experience points bottle - `FISHING` - Spawned by player fishing - `FURNACE` - Spawned by player using a furnace - `GRINDSTONE` - Spawned by a player using a grindstone - `PLAYER_DEATH` - Spawned by a player dying - `UNKNOWN` - We do not know why it was spawned - `VILLAGER_TRADE` - Spawned by player trading with a villager ### Methods #### values Returns an array containing the constants of this enum class, in the order they are declared. **Returns:** - `ExperienceOrb.SpawnReason[]` - an array containing the constants of this enum class, in the order they are declared #### valueOf Returns the enum constant of this class with the specified name. The string must match _exactly_ an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.) **Parameters:** - `name` (String) - the name of the enum constant to be returned. **Returns:** - `ExperienceOrb.SpawnReason` - the enum constant with the specified name **Throws:** - `IllegalArgumentException` - if this enum class has no constant with the specified name - `NullPointerException` - if the argument is null ``` -------------------------------- ### getValue() Source: https://jd.papermc.io/paper/26.2/org/bukkit/permissions/PermissionAttachmentInfo.html Gets the value of this permission. ```APIDOC ## Method: getValue() ### Description Gets the value of this permission. ### Signature `public boolean getValue()` ### Returns - **boolean** - The value of the permission. ``` -------------------------------- ### Sandstone() Source: https://jd.papermc.io/paper/26.2/org/bukkit/material/Sandstone.html Creates a new Sandstone instance with default settings. ```APIDOC ## Sandstone() ### Description Creates a new Sandstone instance with default settings. ### Constructor `public Sandstone()` ### Deprecation Deprecated, for removal: This API element is subject to removal in a future version. ``` -------------------------------- ### Timings.ofStart(Plugin, String) Source: https://jd.papermc.io/paper/26.2/co/aikar/timings/class-use/Timing.html Returns a Timing object after starting it, useful for Java7 try-with-resources. This method is deprecated and will be removed in a future version. ```APIDOC ## Timings.ofStart(Plugin, String) ### Description Returns a Timing object after starting it, useful for Java7 try-with-resources. This method is deprecated and will be removed in a future version. ### Method `static @NotNull Timing ofStart(@NotNull Plugin plugin, @NotNull String name)` ### Parameters - `plugin` (Plugin) - Required - The plugin for which the timing is created. - `name` (String) - Required - The name of the timing. ### Returns - `@NotNull Timing` - The Timing instance that has already been started. ### Deprecation Deprecated, for removal: This API element is subject to removal in a future version. ``` -------------------------------- ### getPaintedFaces() Source: https://jd.papermc.io/paper/26.2/org/bukkit/material/Mushroom.html Gets all painted faces. ```APIDOC ## getPaintedFaces() ### Description Returns a set of all faces that are currently painted. ### Method getPaintedFaces ### Returns - `Set` - A set of all faces that are currently painted (an empty set if it is a stem). ``` -------------------------------- ### RayTraceResult.getHitEntity() Source: https://jd.papermc.io/paper/26.2/org/bukkit/entity/class-use/Entity.html Gets the hit entity. ```APIDOC ## RayTraceResult.getHitEntity() ### Description Gets the hit entity. ### Method `RayTraceResult.getHitEntity()` ### Returns - **Entity** - The hit entity, or null if no entity was hit. ```