/api/playerwarps/getWarpCategoryByName/{categoryname}

Retrieve warp category information by the category name.

  • Parameters:

    • categoryname: The name of the category to retrieve.

  • Response:

    The response will return a JSON object with the following structure:

    {
      "name": "other",
      "teleportPrice": -1,
      "purgeTime": -1,
      "permission": "",
      "removeDaysTime": -1,
      "all": false,
      "icon": {
        "type": "PAPER",
        "meta": {
          "display-name": "{\"text\":\"\",\"extra\":[{\"text\":\"Other Warps\",\"obfuscated\":false,\"italic\":false,\"underlined\":false,\"strikethrough\":false,\"color\":\"aqua\",\"bold\":false}]}",
          "lore": [
            "{\"text\":\"\",\"extra\":[{\"text\":\"Click\",\"color\":\"light_purple\"},{\"text\":\" to view all the other warps.\",\"color\":\"aqua\"}],\"italic\":false}"
          ],
          "PublicBukkitValues": "{\n    \"playerwarps:itemtag_item\": \"1\"\n}"
        }
      },
      "displayName": "Other"
    }

Fields:

  • name (String): Category name.

  • teleportPrice (Number): Price to teleport.

  • purgeTime (Number): Time until purge.

  • permission (String): Required permission.

  • removeDaysTime (Number): Time until removal.

  • all (Boolean): Whether it includes all warps.

  • icon (Object):

    • type (String): The type of the icon.

    • meta (Object):

    • display-name (String): The display name of the icon.

    • lore (Array of Strings): Lore description.

    • PublicBukkitValues (String): Custom Bukkit metadata.

  • displayName (String): Display name of the category.

Note:

  • Authentication is required to access this endpoint.

  • Based on server settings, you may not be able to access warp information if you do not own the warp.

Last updated

Was this helpful?