### getUsage() Source: https://jd.papermc.io/paper/26.1.2/index-all.html Gets an example usage of this command. ```APIDOC ## getUsage() ### Description Gets an example usage of this command. ### Method N/A (Method Signature) ### Response An example usage string. ``` -------------------------------- ### getExamples() Source: https://jd.papermc.io/paper/26.1.2/io/papermc/paper/command/brigadier/argument/CustomArgumentType.html Provides a collection of example strings for the argument. This cannot be controlled by the server and is returned when multiple arguments are in the same node to help differentiate possible inputs. ```APIDOC ## Method: getExamples() default Collection getExamples() Cannot be controlled by the server. Returned in cases where there are multiple arguments in the same node. This helps differentiate and tell the player what the possible inputs are. **Returns:** client set examples (`Collection`) ``` -------------------------------- ### getStartLevel Source: https://jd.papermc.io/paper/26.1.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. ### Returns - `int` - The starting level. ``` -------------------------------- ### Plugin.yml Example Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/plugin/PluginDescriptionFile.html An example of a plugin.yml file, demonstrating the structure and common keys such as name, provides, version, and description. ```yaml name: Inferno provides: [Hell] version: 1.4.1 description: This plugin is so 31337. You can set yourself on fire. # We could place every author in the authors list, but chose not to for illustrative purposes # Also, having an author distinguishes that person as the project lead, and ensures their ``` -------------------------------- ### Raid isStarted() Source: https://jd.papermc.io/paper/26.1.2/index-all.html Get whether this raid started. ```APIDOC ## isStarted() ### Description Get whether this raid started. ### Method `isStarted()` ### Interface `org.bukkit.Raid` ``` -------------------------------- ### JavaPlugin.init() (overload 2) Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/class-use/Server.html Initializes the JavaPlugin with server, description, and file details. ```APIDOC ## JavaPlugin.init(Server server, PluginDescriptionFile description, File dataFolder, File file, ClassLoader classLoader, @Nullable PluginMeta configuration, Logger logger) ### Description Initializes the `JavaPlugin`. ### Method `final void` ### Endpoint N/A (Method on JavaPlugin object) ### Parameters - **server** (`Server`) - The server instance. - **description** (`PluginDescriptionFile`) - The plugin description file. - **dataFolder** (`File`) - The plugin's data folder. - **file** (`File`) - The plugin file. - **classLoader** (`ClassLoader`) - The class loader for the plugin. - **configuration** (`@Nullable PluginMeta`) - Optional plugin metadata. - **logger** (`Logger`) - The logger for the plugin. ### Response None ``` -------------------------------- ### EquipmentSlotGroup Methods Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/inventory/class-use/EquipmentSlot.html Methods for interacting with EquipmentSlotGroup, including getting an example slot and testing against a slot. ```APIDOC ## EquipmentSlotGroup.getExample() ### Description Deprecated. for internal compatibility use only. Gets an example EquipmentSlot from the group. ### Method @NotNull EquipmentSlot ### Returns @NotNull EquipmentSlot - An example EquipmentSlot. ``` ```APIDOC ## EquipmentSlotGroup.test(EquipmentSlot test) ### Description Tests if the given EquipmentSlot is part of this group. ### Method boolean ### Parameters #### Path Parameters - **test** (EquipmentSlot) - Required - The EquipmentSlot to test. ``` -------------------------------- ### Full Command Definition Example Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/plugin/PluginDescriptionFile.html An example demonstrating the structure and properties for defining multiple commands within a plugin. ```yaml commands: flagrate: description: Set yourself on fire. aliases: [combust_me, combustMe] permission: inferno.flagrate permission-message: You do not have / usage: Syntax error! Perhaps you meant / PlayerName? burningdeaths: description: List how many times you have died by fire. aliases: - burning_deaths - burningDeaths permission: inferno.burningdeaths usage: | / [player] Example: / - see how many times you have burned to death Example: / CaptainIce - see how many times CaptainIce has burned to death # The next command has no description, aliases, etc. defined, but is still valid # Having an empty declaration is useful for defining the description, permission, and messages from a configuration dynamically apocalypse: ``` -------------------------------- ### getDeathAnimationTicks Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/entity/EnderDragon.html Gets the current time in ticks relative to the start of the EnderDragon's death animation. ```APIDOC ## getDeathAnimationTicks ### Description Get the current time in ticks relative to the start of this dragon's death animation. If this dragon is alive, 0 will be returned. This value will never exceed 200 (the length of the animation). ### Returns - int: this dragon's death animation ticks ``` -------------------------------- ### Registering a BasicCommand Source: https://jd.papermc.io/paper/26.1.2/io/papermc/paper/command/brigadier/Commands.html This example shows how to register a command using a `BasicCommand` implementation, which simplifies command registration for simpler commands. ```APIDOC ## Registering a BasicCommand ### Description Registers a command using a `BasicCommand` implementation, allowing for simpler command definitions. ### Method `register` ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **label** (`String`) - Required - The main label for the command. - **basicCommand** (`BasicCommand`) - Required - The implementation of the command logic. - **description** (`String`) - Optional - A description for the command. - **aliases** (`Collection`) - Optional - A collection of aliases for the command. ### Request Example ```java commands.register("my-basic-command", "A simple command", List.of("mbc"), basicCommandImpl); ``` ### Response - **Set** - A set of registered command labels. ``` -------------------------------- ### getVoidDamageMinBuildHeightOffset() - World Source: https://jd.papermc.io/paper/26.1.2/index-all.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 Method in interface org.bukkit.World ``` -------------------------------- ### getLoad() Source: https://jd.papermc.io/paper/26.1.2/index-all.html Gives the phase of server startup that the plugin should be loaded. ```APIDOC ## getLoad() ### Description Gives the phase of server startup that the plugin should be loaded. ### Method N/A (Method Signature) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` -------------------------------- ### Constructor Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/plugin/SimpleServicesManager.html Initializes a new instance of the SimpleServicesManager. ```APIDOC ## Constructor ### Description Initializes a new instance of the SimpleServicesManager. ### Method `SimpleServicesManager()` ``` -------------------------------- ### getLimitedLifetimeTicks() Source: https://jd.papermc.io/paper/26.1.2/index-all.html Gets the number of ticks remaining until the vex will start to take damage. This method is part of the `Vex` interface. ```APIDOC ## getLimitedLifetimeTicks() ### Description Gets the number of ticks remaining until the vex will start to take damage. ### Method N/A (Method Signature) ### Endpoint N/A ### Parameters None ### Request Example N/A ### Response N/A (Returns the number of ticks) ``` -------------------------------- ### Trial Spawner Entity Tracking Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/entity/class-use/Entity.html Methods for managing entity tracking within a Trial Spawner, including getting tracked entities, checking if an entity is tracked, and manually starting or stopping tracking for an entity. ```APIDOC ## TrialSpawner.getTrackedEntities ### Description Gets a list of entities this spawner is currently tracking. ### Parameters #### Path Parameters - None #### Query Parameters - None #### Request Body - None ### Method Signature `getTrackedEntities()` ### Return Type `Collection` --- ## TrialSpawner.isTrackingEntity ### Description Checks if this spawner is currently tracking the provided entity. ### Parameters #### Path Parameters - None #### Query Parameters - None #### Request Body - None ### Method Signature `isTrackingEntity(Entity entity)` ### Return Type `boolean` --- ## TrialSpawner.startTrackingEntity ### Description Force this spawner to start tracking the provided entity. ### Parameters #### Path Parameters - None #### Query Parameters - None #### Request Body - None ### Method Signature `startTrackingEntity(Entity entity)` ### Return Type `void` --- ## TrialSpawner.stopTrackingEntity ### Description Force this spawner to stop tracking the provided entity. ### Parameters #### Path Parameters - None #### Query Parameters - None #### Request Body - None ### Method Signature `stopTrackingEntity(Entity entity)` ### Return Type `void` ``` -------------------------------- ### HelpCommand Constructor Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/command/defaults/HelpCommand.html Initializes a new instance of the HelpCommand class. ```APIDOC ## HelpCommand() ### Description Initializes a new instance of the HelpCommand class. ### Constructor HelpCommand() ``` -------------------------------- ### ActionButton Creation and Usage Source: https://jd.papermc.io/paper/26.1.2/io/papermc/paper/registry/data/dialog/class-use/ActionButton.html Demonstrates how to build and create ActionButton instances, and how they are used in various dialog types. ```APIDOC ## ActionButton ### Description Represents a clickable button within a dialog. ### Methods #### `ActionButton.Builder.build()` Builds the ActionButton instance with the configured values. #### `static ActionButton create(Component label, @Nullable Component tooltip, @Range(from=1L,to=1024L) int width, @Nullable DialogAction action)` Creates a new action button with the specified label, tooltip, width, and action. ### Uses in Dialog Types #### `ConfirmationType` - `confirmation(ActionButton yesButton, ActionButton noButton)`: Creates a confirmation dialog. - `yesButton()`: Gets the button for confirming the action. - `noButton()`: Gets the button for denying the action. #### `NoticeType` - `action()`: Returns the action button associated with this notice type. - `notice(ActionButton action)`: Creates a notice dialog. #### `ServerLinksType` - `serverLinks(@Nullable ActionButton exitAction, int columns, int buttonWidth)`: Creates a server links dialog. - `exitAction()`: Returns the action button to exit the dialog. #### `DialogListType` - `dialogList(RegistrySet dialogs, @Nullable ActionButton exitAction, @Positive int columns, @Range(from=1L,to=1024L) int buttonWidth)`: Creates a dialog list dialog. - `exitAction()`: Returns the action button to exit the dialog. #### `MultiActionType` - `multiAction(List actions, @Nullable ActionButton exitAction, @Positive int columns)`: Creates a multi-action dialog. - `actions()`: Returns the list of action buttons. - `exitAction()`: Returns the action button to exit the dialog. - `multiAction(List actions)`: Creates a multi-action dialog builder. - `multiAction(ActionButton yesButton, ActionButton noButton)`: Creates a multi-action dialog. ``` -------------------------------- ### Get Dispatcher Source: https://jd.papermc.io/paper/26.1.2/io/papermc/paper/command/brigadier/Commands.html Gets the underlying CommandDispatcher. ```APIDOC ## getDispatcher @Experimental com.mojang.brigadier.CommandDispatcher getDispatcher() ### Description Gets the underlying `CommandDispatcher`. **Note:** This is a delicate API that must be used with care to ensure a consistent user experience. When registering commands, it should be preferred to use the `register methods` over directly registering to the dispatcher wherever possible. `Register methods` automatically handle command namespacing, command help, plugin association with commands, and more. Example use cases for this method **may** include: Implementing integration between an external command framework and Paper (although `register methods` should still be preferred where possible), Registering new child nodes to an existing plugin command (for example an "addon" plugin to another plugin may want to do this), Retrieving existing command nodes to build redirects. ### Returns the dispatcher instance ``` -------------------------------- ### Get Name Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/entity/Player.html Gets the player's username. ```APIDOC ## getName ### Description Returns the name of this player. ### Method `getName()` ### Returns (String) - The player's name. ``` -------------------------------- ### HelpTopic Constructor Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/help/HelpTopic.html Initializes a new HelpTopic instance. This is typically used by plugins to create custom help topics. ```APIDOC ## HelpTopic() ### Description Constructs a new HelpTopic. ### Constructor `public HelpTopic()` ``` -------------------------------- ### Get Permission Message Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/Server.html Gets the permission message. ```APIDOC ## getPermissionMessage ### Description Deprecated. use `permissionMessage()` Gets the permission message. ### Returns - `@NotNull String` - The permission message. ``` -------------------------------- ### getExample Source: https://jd.papermc.io/paper/26.1.2/index-all.html Deprecated method for internal compatibility use only. ```APIDOC ## getExample() ### Description Deprecated. for internal compatibility use only ### Method GET ### Endpoint N/A (Method in class org.bukkit.inventory.EquipmentSlotGroup) ``` -------------------------------- ### Get Name Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/Server.html Gets the name of this server implementation. ```APIDOC ## getName ### Description Gets the name of this server implementation. ### Returns - `@NotNull String` - The server's name. ``` -------------------------------- ### Bukkit.getHelpMap() Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/help/class-use/HelpMap.html Retrieves the HelpMap instance from the Bukkit class. This map contains all registered help topics for the server. ```APIDOC ## Bukkit.getHelpMap() ### Description Gets the `HelpMap` providing help topics for this server. ### Method `static @NotNull HelpMap` ### Endpoint N/A (Static method call) ### Parameters None ### Request Example ```java HelpMap helpMap = Bukkit.getHelpMap(); ``` ### Response #### Success Response - **HelpMap** (`@NotNull HelpMap`) - The HelpMap instance containing server help topics. ``` -------------------------------- ### Get IP Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/Server.html Gets the IP that this server is bound to. ```APIDOC ## getIp ### Description Get the IP that this server is bound to, or empty string if not specified. ### Returns - `@NotNull String` - The server's bound IP address. ``` -------------------------------- ### getExamples Source: https://jd.papermc.io/paper/26.1.2/index-all.html Cannot be controlled by the server; used for custom argument types. ```APIDOC ## getExamples() ### Description Cannot be controlled by the server. ### Method GET ### Endpoint N/A (Method in interface io.papermc.paper.command.brigadier.argument.CustomArgumentType) ``` -------------------------------- ### getFullText(CommandSender) Source: https://jd.papermc.io/paper/26.1.2/index-all.html Returns the full description of this help topic that is displayed when the user requests this topic's details. ```APIDOC ## getFullText(CommandSender) ### Description Returns the full description of this help topic that is displayed when the user requests this topic's details. ### Method Method ### Parameters * **sender** (CommandSender) - Required - The sender requesting the help topic details. ``` -------------------------------- ### Get Generate Structures Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/Server.html Gets the generate-structures setting. ```APIDOC ## getGenerateStructures ### Description Get generate-structures setting. ### Returns - `boolean` - True if structures are generated, false otherwise. ``` -------------------------------- ### HelpTopic Class Overview Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/help/HelpTopic.html HelpTopic implementations are displayed to the user when the user uses the /help command. Custom implementations of this class can work at two levels. A simple implementation only needs to set the value of `name`, `shortText`, and `fullText` in the constructor. This base class will take care of the rest. Complex implementations can be created by overriding the behavior of all the methods in this class. ```APIDOC ## Class: HelpTopic ### Description Represents a help topic displayed to users via the /help command. Allows for simple or complex custom implementations. ### Fields - `amendedPermission` (protected String) - `fullText` (protected String) - `name` (protected String) - `shortText` (protected String) ### Constructor - `HelpTopic()`: Initializes a new HelpTopic. ### Methods - `amendCanSee(@Nullable String amendedPermission)`: Overrides the permission required to see a help topic. - `amendTopic(@Nullable String amendedShortText, @Nullable String amendedFullText)`: Adds or replaces the contents of a help topic. - `applyAmendment(@NotNull String baseText, @Nullable String amendment)`: Utility method for custom implementations to apply amendments. - `canSee(@NotNull CommandSender player)`: Determines if a player can see this help topic. - `getFullText(@NotNull CommandSender forWho)`: Returns the full description of the help topic. - `getName()`: Returns the name of the help topic. - `getShortText()`: Returns a brief description for the topic index. ``` -------------------------------- ### getBlockState (FallingBlock) Source: https://jd.papermc.io/paper/26.1.2/index-all.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 ## 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 Method in interface org.bukkit.entity.FallingBlock ``` -------------------------------- ### Get Helmet Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/inventory/EntityEquipment.html Gets the helmet currently being worn by the entity. ```java @NotNull @NotNull ItemStack getHelmet() ``` -------------------------------- ### getLoadOrder() Source: https://jd.papermc.io/paper/26.1.2/index-all.html Returns the phase of the server startup logic that the plugin should be loaded. ```APIDOC ## getLoadOrder() ### Description Returns the phase of the server startup logic that the plugin should be loaded. ### Method N/A (Method Signature) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` -------------------------------- ### Creating a SingleOptionDialogInput.OptionEntry Source: https://jd.papermc.io/paper/26.1.2/io/papermc/paper/registry/data/dialog/input/class-use/SingleOptionDialogInput.OptionEntry.html Demonstrates how to create a new option entry for a single-option dialog input using the static `create` method. ```APIDOC ## `SingleOptionDialogInput.OptionEntry.create(String id, @Nullable Component display, boolean initial)` ### Description Creates a new option entry. ### Method Signature `static SingleOptionDialogInput.OptionEntry create(String id, @Nullable Component display, boolean initial)` ### Parameters * **id** (String) - The unique identifier for the option. * **display** (@Nullable Component) - The component to display for this option (can be null). * **initial** (boolean) - Whether this option is the initially selected one. ``` -------------------------------- ### Get Idle Duration Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/entity/Player.html Gets the duration the player has been idle. ```APIDOC ## getIdleDuration ### Description The idle duration is reset when the player sends specific action packets. ### Method `getIdleDuration()` ### Returns (Duration) - The player's idle duration. ``` -------------------------------- ### Get Connection Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/entity/Player.html Gets the player's game connection. ```APIDOC ## getConnection ### Description Gets the game connection for this player. ### Method `getConnection()` ### Returns (PlayerGameConnection) - The player's game connection. ``` -------------------------------- ### Constructor Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/plugin/SimpleServicesManager.html Initializes a new instance of the SimpleServicesManager class. ```APIDOC ## Constructor Details ### SimpleServicesManager public SimpleServicesManager() ``` -------------------------------- ### Bukkit.getServer() Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/class-use/Server.html Retrieves the singleton Server instance for the Bukkit API. ```APIDOC ## Bukkit.getServer() ### Description Gets the current `Server` singleton. ### Method `static @NotNull Server` ### Endpoint N/A (Static method call) ### Parameters None ### Response - **Server** (`@NotNull Server`) - The current Server instance. ``` -------------------------------- ### Get Address Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/entity/Player.html Gets the player's network address. ```APIDOC ## getAddress ### Description Gets the socket address of this player. ### Method `getAddress()` ### Returns (@Nullable InetSocketAddress) - The player's socket address. ``` -------------------------------- ### Get Rabbit Type Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/entity/Rabbit.html Gets the current type of the rabbit. ```APIDOC ## @NotNull Rabbit.Type getRabbitType() Gets the current type of the rabbit. ``` -------------------------------- ### Get Coordinate Scale Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/World.html Gets the coordinate scaling of this world. ```APIDOC ## getCoordinateScale ### Description Gets the coordinate scaling of this world. ### Returns the coordinate scale ``` -------------------------------- ### ExpBottleEvent.getExperience() Source: https://jd.papermc.io/paper/26.1.2/index-all.html This method retrieves the amount of experience to be created. ```APIDOC ## getExperience() ### Description This method retrieves the amount of experience to be created. ### Method N/A (Java Method) ### Endpoint N/A ### Parameters None ### Request Example N/A ### Response #### Success Response (200) - **Integer** (int) - The amount of experience to be created. ``` -------------------------------- ### init Source: https://jd.papermc.io/paper/26.1.2/io/papermc/paper/plugin/provider/classloader/ConfiguredPluginClassLoader.html Initializes the configured plugin class loader and links it to a JavaPlugin. ```APIDOC ## init ### Description Initializes both this configured plugin class loader and the java plugin passed to link to each other. This logic is to be called exactly once when the initial setup between the class loader and the instantiated `JavaPlugin` is loaded. ### Method `init(JavaPlugin plugin)` ### Parameters #### Path Parameters - **plugin** (`JavaPlugin`) - Required - The `JavaPlugin` that should be interlinked with this class loader. ``` -------------------------------- ### Get Block Sound Group Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/block/Block.html Gets the `SoundGroup` for this block. ```APIDOC ## getBlockSoundGroup @NotNull SoundGroup getBlockSoundGroup() ### Description Gets the `SoundGroup` for this block. ### Returns - SoundGroup: the sound group for this block ``` -------------------------------- ### CookingRecipe.getExperience() Source: https://jd.papermc.io/paper/26.1.2/index-all.html Get the experience given by this recipe. ```APIDOC ## getExperience() ### Description Get the experience given by this recipe. ### Method N/A (Java Method) ### Endpoint N/A ### Parameters None ### Request Example N/A ### Response #### Success Response (200) - **Float** (float) - The experience given by the recipe. ``` -------------------------------- ### Get Version Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/Server.html Gets the version string of this server implementation. ```APIDOC ## getVersion ### Description Gets the version string of this server implementation. ### Method `@NotNull String getVersion()` ### Returns - `@NotNull String`: The server version string. ``` -------------------------------- ### Get Update Folder Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/Server.html Gets the name of the update folder. ```APIDOC ## getUpdateFolder ### Description Gets the name of the update folder. ### Method `@NotNull String getUpdateFolder()` ### Returns - `@NotNull String`: The name of the update folder. ``` -------------------------------- ### SimpleCommandMap Constructor Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/class-use/Server.html Constructs a SimpleCommandMap with the given server instance and backing map. ```APIDOC ## SimpleCommandMap(Server server, Map backing) ### Description Constructs a `SimpleCommandMap`. ### Method `Constructor` ### Endpoint N/A (Constructor) ### Parameters - **server** (`@NotNull Server`) - The server instance. - **backing** (`Map`) - The backing map for commands. ### Response None ``` -------------------------------- ### hasReceivers Source: https://jd.papermc.io/paper/26.1.2/index-all.html Example use: ```APIDOC ## hasReceivers() ### Description Example use: ### Method N/A (Method Signature) ### Endpoint N/A ### Parameters #### Path Parameters N/A #### Query Parameters N/A #### Request Body N/A ### Request Example N/A ### Response #### Success Response (N/A) N/A #### Response Example N/A ``` -------------------------------- ### Get Scoreboard Criteria Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/Server.html Gets or creates a Criteria by its name. ```APIDOC ## getScoreboardCriteria ### Description Get (or create) a new `Criteria` by its name. ### Method `@NotNull Criteria getScoreboardCriteria(@NotNull String name)` ### Parameters #### Path Parameters - `name` (String) - Required - The name of the criteria. ### Returns - `@NotNull Criteria`: The Criteria instance. ``` -------------------------------- ### create Source: https://jd.papermc.io/paper/26.1.2/io/papermc/paper/registry/keys/PaintingVariantKeys.html Creates a typed key for `Art` in the registry `minecraft:painting_variant`. ```APIDOC ## Method ### `create(Key key)` Creates a typed key for `Art` in the registry `minecraft:painting_variant`. #### Parameters - **key** (Key) - The key to create the typed key from. #### Returns - `TypedKey` - The created typed key. ``` -------------------------------- ### getDefaults() Source: https://jd.papermc.io/paper/26.1.2/index-all.html Gets the source Configuration for this configuration. ```APIDOC ## getDefaults() ### Description Gets the source `Configuration` for this configuration. ### Method Signature `org.bukkit.configuration.Configuration.getDefaults()` `org.bukkit.configuration.MemoryConfiguration.getDefaults()` ``` -------------------------------- ### BlockPopulator Constructor Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/generator/BlockPopulator.html Initializes a new BlockPopulator instance. ```APIDOC ## BlockPopulator Constructor ### Description Initializes a new BlockPopulator instance. ### Constructor `BlockPopulator()` ``` -------------------------------- ### Get Respawn World Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/Server.html Gets the world where players respawn. ```APIDOC ## getRespawnWorld ### Description Gets the world that players respawn in. ### Method `@NotNull World getRespawnWorld()` ### Returns - `@NotNull World`: The world where players respawn. ``` -------------------------------- ### Bukkit.getCommandMap() Source: https://jd.papermc.io/paper/26.1.2/index-all.html Gets the active CommandMap. ```APIDOC ## getCommandMap() ### Description Gets the active `CommandMap`. ### Method Static Method ### Endpoint N/A ### Parameters None ### Request Example None ### Response None ``` -------------------------------- ### Get Player by UUID Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/Server.html Gets the player with the given UUID. ```APIDOC ## getPlayer ### Description Gets the player with the given UUID. ### Parameters #### Path Parameters - `id` (@NotNull UUID) - The UUID of the player. ### Returns - `@Nullable Player` - The player, or null if not found. ``` -------------------------------- ### Server.getHelpMap() Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/help/class-use/HelpMap.html Retrieves the HelpMap instance from the Server interface. This map contains all registered help topics for the server. ```APIDOC ## Server.getHelpMap() ### Description Gets the `HelpMap` providing help topics for this server. ### Method `@NotNull HelpMap` ### Endpoint N/A (Method call on Server instance) ### Parameters None ### Request Example ```java Server server = Bukkit.getServer(); HelpMap helpMap = server.getHelpMap(); ``` ### Response #### Success Response - **HelpMap** (`@NotNull HelpMap`) - The HelpMap instance containing server help topics. ``` -------------------------------- ### Get Player Time Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/entity/Player.html Gets the player's current timestamp. ```APIDOC ## getPlayerTime ### Description Returns the player's current timestamp. ### Method `getPlayerTime()` ### Returns (long) - The player's current timestamp. ``` -------------------------------- ### JavaPlugin.init() (overload 1) Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/class-use/Server.html Initializes the JavaPlugin with various server and plugin-related components. ```APIDOC ## JavaPlugin.init(PluginLoader loader, Server server, PluginDescriptionFile description, File dataFolder, File file, ClassLoader classLoader) ### Description Initializes the `JavaPlugin`. ### Method `final void` ### Endpoint N/A (Method on JavaPlugin object) ### Parameters - **loader** (`PluginLoader`) - The plugin loader. - **server** (`Server`) - The server instance. - **description** (`PluginDescriptionFile`) - The plugin description file. - **dataFolder** (`File`) - The plugin's data folder. - **file** (`File`) - The plugin file. - **classLoader** (`ClassLoader`) - The class loader for the plugin. ### Response None ``` -------------------------------- ### Get Player Profile Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/entity/Player.html Gets a copy of the player's profile. ```APIDOC ## getPlayerProfile ### Description Gets a copy of this players profile. ### Method `getPlayerProfile()` ### Returns (PlayerProfile) - A copy of the player's profile. ``` -------------------------------- ### setServer Source: https://jd.papermc.io/paper/26.1.2/index-all.html Attempts to set the `Server` singleton. ```APIDOC ## setServer(Server) ### Description Attempts to set the `Server` singleton. ### Method Static method ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) None #### Response Example None ``` -------------------------------- ### Get Ping Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/entity/Player.html Gets the player's estimated ping in milliseconds. ```APIDOC ## getPing ### Description Gets the player's estimated ping in milliseconds. ### Method `getPing()` ### Returns (int) - The player's ping in milliseconds. ``` -------------------------------- ### getPrompt Source: https://jd.papermc.io/paper/26.1.2/index-all.html Gets the prompt to show of the resource pack. ```APIDOC ## getPrompt ### Description Gets the prompt to show of the resource pack. ### Method N/A (Method Signature) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` -------------------------------- ### Get Level Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/entity/Player.html Gets the player's current experience level. ```APIDOC ## getLevel ### Description Gets the players current experience level. ### Method `getLevel()` ### Returns (int) - The player's current experience level. ``` -------------------------------- ### TooltipDisplay.tooltipDisplay() Source: https://jd.papermc.io/paper/26.1.2/io/papermc/paper/datacomponent/item/class-use/TooltipDisplay.Builder.html Factory method to create a new instance of TooltipDisplay.Builder. ```APIDOC ## TooltipDisplay.tooltipDisplay() ### Description Returns a new builder for creating a TooltipDisplay. ### Method `static tooltipDisplay` ### Returns - `TooltipDisplay.Builder` - A new builder instance. ``` -------------------------------- ### Get Intersecting Chunks Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/World.html Gets all chunks that intersect with the given BoundingBox. ```APIDOC ## getIntersectingChunks ### Description Gets all Chunks intersecting the given BoundingBox. ### Parameters - `box` (BoundingBox) - BoundingBox to check ### Returns A collection of Chunks intersecting the given BoundingBox ``` -------------------------------- ### Command Description and Usage Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/command/Command.html Methods for retrieving and setting the description and usage examples for a command. ```APIDOC ## getDescription ### Description Gets a brief description of this command. ### Method `@NotNull public @NotNull String getDescription()` ### Returns Description of this command ## getUsage ### Description Gets an example usage of this command. ### Method `@NotNull public @NotNull String getUsage()` ### Returns One or more example usages ## setDescription ### Description Sets a brief description of this command. Defining a description in the `PluginDescriptionFile.getCommands()` (under the ``description`' node) is equivalent to this method. ### Method `@NotNull public @NotNull Command setDescription(@NotNull @NotNull String description)` ### Parameters * `description` - new command description ### Returns this command object, for chaining ## setUsage ### Description Sets the example usage of this command. ### Method `@NotNull public @NotNull Command setUsage(@NotNull @NotNull String usage)` ### Parameters * `usage` - new example usage ### Returns this command object, for chaining ``` -------------------------------- ### Get Warning State Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/Server.html Gets the current warning state for the server. ```APIDOC ## getWarningState ### Description Gets the current warning state for the server. ### Method `@NotNull Warning.WarningState getWarningState()` ### Returns - `@NotNull Warning.WarningState`: The current warning state. ``` -------------------------------- ### create Source: https://jd.papermc.io/paper/26.1.2/io/papermc/paper/registry/keys/PaintingVariantKeys.html Creates a typed key for `Art` in the `minecraft:painting_variant` registry. ```APIDOC ## create public static TypedKey create(Key key) ### Description Creates a typed key for `Art` in the registry `minecraft:painting_variant`. ### Parameters #### Path Parameters - **key** (Key) - Required - the value's key in the registry ### Returns - a new typed key ``` -------------------------------- ### Get View Distance Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/Server.html Gets the view distance setting of the server. ```APIDOC ## getViewDistance ### Description Get the view distance from this server. ### Method `int getViewDistance()` ### Returns - `int`: The view distance in chunks. ``` -------------------------------- ### Creating Typed Keys for Registry Entries Source: https://jd.papermc.io/paper/26.1.2/io/papermc/paper/registry/class-use/TypedKey.html Demonstrates how to create TypedKey instances for different registry types using static factory methods. ```APIDOC ## Creating Typed Keys This section shows how to create `TypedKey` instances for various registry types. These methods are typically used to obtain a typed reference to a registry entry. ### `BannerPatternKeys.create(Key key)` Creates a typed key for `PatternType` in the registry `minecraft:banner_pattern`. ### `BiomeKeys.create(Key key)` Creates a typed key for `Biome` in the registry `minecraft:worldgen/biome`. ### `CatSoundVariantKeys.create(Key key)` Creates a typed key for `Cat.SoundVariant` in the registry `minecraft:cat_sound_variant`. ### `CatVariantKeys.create(Key key)` Creates a typed key for `Cat.Type` in the registry `minecraft:cat_variant`. ### `ChickenSoundVariantKeys.create(Key key)` Creates a typed key for `Chicken.SoundVariant` in the registry `minecraft:chicken_sound_variant`. ### `ChickenVariantKeys.create(Key key)` Creates a typed key for `Chicken.Variant` in the registry `minecraft:chicken_variant`. ### `CowSoundVariantKeys.create(Key key)` Creates a typed key for `Cow.SoundVariant` in the registry `minecraft:cow_sound_variant`. ### `CowVariantKeys.create(Key key)` Creates a typed key for `Cow.Variant` in the registry `minecraft:cow_variant`. ### `DamageTypeKeys.create(Key key)` Creates a typed key for `DamageType` in the registry `minecraft:damage_type`. ### `DialogKeys.create(Key key)` Creates a typed key for `Dialog` in the registry `minecraft:dialog`. ### `EnchantmentKeys.create(Key key)` Creates a typed key for `Enchantment` in the registry `minecraft:enchantment`. ### `FrogVariantKeys.create(Key key)` Creates a typed key for `Frog.Variant` in the registry `minecraft:frog_variant`. ### `GameEventKeys.create(Key key)` Creates a typed key for `GameEvent` in the registry `minecraft:game_event`. ### `InstrumentKeys.create(Key key)` Creates a typed key for `MusicInstrument` in the registry `minecraft:instrument`. ### `JukeboxSongKeys.create(Key key)` Creates a typed key for `JukeboxSong` in the registry `minecraft:jukebox_song`. ### `PaintingVariantKeys.create(Key key)` Creates a typed key for `Art` in the registry `minecraft:painting_variant`. ### `PigSoundVariantKeys.create(Key key)` Creates a typed key for `Pig.SoundVariant` in the registry `minecraft:pig_sound_variant`. ### `PigVariantKeys.create(Key key)` Creates a typed key for `Pig.Variant` in the registry `minecraft:pig_variant`. ### `StructureKeys.create(Key key)` Creates a typed key for `Structure` in the registry `minecraft:worldgen/structure`. ### `TrimMaterialKeys.create(Key key)` Creates a typed key for `TrimMaterial` in the registry `minecraft:trim_material`. ### `TrimPatternKeys.create(Key key)` Creates a typed key for `TrimPattern` in the registry `minecraft:trim_pattern`. ### `WolfSoundVariantKeys.create(Key key)` Creates a typed key for `Wolf.SoundVariant` in the registry `minecraft:wolf_sound_variant`. ### `WolfVariantKeys.create(Key key)` Creates a typed key for `Wolf.Variant` in the registry `minecraft:wolf_variant`. ### `ZombieNautilusVariantKeys.create(Key key)` Creates a typed key for `ZombieNautilus.Variant` in the registry `minecraft:zombie_nautilus_variant`. ``` -------------------------------- ### Get Structure Manager Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/Server.html Gets the StructureManager for loading and saving structures. ```APIDOC ## getStructureManager ### Description Gets the structure manager for loading and saving structures. ### Method `@NotNull StructureManager getStructureManager()` ### Returns - `@NotNull StructureManager`: The StructureManager instance. ``` -------------------------------- ### createTopic Method Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/help/HelpTopicFactory.html This method is responsible for creating a custom HelpTopic for a given command. It accepts a command object that derives from a custom command base class and returns a new custom HelpTopic instance. If no topic should be created for the command, it can return null. ```APIDOC ## createTopic ### Description This method accepts a command deriving from a custom command base class and constructs a custom HelpTopic for it. ### Method Signature `@Nullable HelpTopic createTopic(@NotNull TCommand command)` ### Parameters * `command` - The custom command to build a help topic for. ### Returns A new custom help topic or `null` to intentionally NOT create a topic. ``` -------------------------------- ### Dialog List Creation with Options Source: https://jd.papermc.io/paper/26.1.2/io/papermc/paper/dialog/class-use/Dialog.html Demonstrates creating a `DialogListType` with additional options for layout and actions. ```APIDOC ## DialogType.dialogList (Full Options) ### Description Creates a dialog list dialog with the specified dialogs, exit action, columns, and button width. ### Method Signature `static DialogListType dialogList(RegistrySet dialogs, @Nullable ActionButton exitAction, @Positive int columns, @Range(from=1L,to=1024L) int buttonWidth)` ### Parameters * `dialogs` (RegistrySet) - The set of dialogs to display. * `exitAction` (@Nullable ActionButton) - An optional action button for exiting. * `columns` (@Positive int) - The number of columns for the dialog list. * `buttonWidth` (@Range(from=1L,to=1024L) int) - The width of the buttons in the dialog list. ``` -------------------------------- ### Get Simulation Distance Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/Server.html Gets the simulation distance setting of the server. ```APIDOC ## getSimulationDistance ### Description Get the simulation distance from this server. ### Method `int getSimulationDistance()` ### Returns - `int`: The simulation distance in chunks. ``` -------------------------------- ### Get Services Manager Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/Server.html Gets the ServicesManager for accessing Bukkit services. ```APIDOC ## getServicesManager ### Description Gets a services manager. ### Method `@NotNull ServicesManager getServicesManager()` ### Returns - `@NotNull ServicesManager`: The ServicesManager instance. ``` -------------------------------- ### Creating BlocksAttacks Source: https://jd.papermc.io/paper/26.1.2/io/papermc/paper/datacomponent/item/class-use/BlocksAttacks.Builder.html Demonstrates how to obtain a BlocksAttacks.Builder instance to start configuring block attack properties. ```APIDOC ## BlocksAttacks.blocksAttacks() ### Description Static factory method to create a new instance of `BlocksAttacks.Builder`. ### Method `static BlocksAttacks.Builder` ### Usage ```java BlocksAttacks.Builder builder = BlocksAttacks.blocksAttacks(); ``` ```