/api/playerwarps/getWarpCategories/{page}
Retrieve a paginated list of warp categories.
Parameters:
page
: The page number to retrieve (for pagination).
Response:
The response will return a JSON object with the following structure:
{ "categories": [ { "teleportPrice": -1.0, "purgeTime": -1, "removeDaysTime": -1, "all": true, "icon": { "type": "BOOK", "meta": { "display-name": "{\"text\":\"\",\"extra\":[{\"text\":\"All 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 warps.\",\"color\":\"aqua\"}],\"italic\":false}" ], "PublicBukkitValues": "{\n \"playerwarps:itemtag_item\": \"1\"\n}" } }, "name": "all", "permission": "", "displayName": "All" }, { "teleportPrice": -1.0, "purgeTime": -1, "removeDaysTime": -1, "all": false, "icon": { "type": "OAK_PLANKS", "meta": { "display-name": "{\"text\":\"\",\"extra\":[{\"text\":\"House 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 house warps.\",\"color\":\"aqua\"}],\"italic\":false}" ], "PublicBukkitValues": "{\n \"playerwarps:itemtag_item\": \"1\"\n}" } }, "name": "houses", "permission": "", "displayName": "Houses" }, { "teleportPrice": -1.0, "purgeTime": 40, "removeDaysTime": 40, "all": false, "icon": { "type": "CHEST", "meta": { "display-name": "{\"text\":\"\",\"extra\":[{\"text\":\"Shop 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 shop warps.\",\"color\":\"aqua\"}],\"italic\":false}" ], "PublicBukkitValues": "{\n \"playerwarps:itemtag_item\": \"1\"\n}", "blockMaterial": "CHEST" } }, "name": "shops", "permission": "pw.view.shop", "displayName": "Shops" }, { "teleportPrice": -1.0, "purgeTime": -1, "removeDaysTime": -1, "all": false, "icon": { "type": "DIAMOND_HOE", "meta": { "display-name": "{\"text\":\"\",\"extra\":[{\"text\":\"Farm 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 farm warps.\",\"color\":\"aqua\"}],\"italic\":false}" ], "PublicBukkitValues": "{\n \"playerwarps:itemtag_item\": \"1\"\n}" } }, "name": "farms", "permission": "", "displayName": "Farms" }, { "teleportPrice": -1.0, "purgeTime": -1, "removeDaysTime": -1, "all": false, "icon": { "type": "DIAMOND_SWORD", "meta": { "display-name": "{\"text\":\"\",\"extra\":[{\"text\":\"PvP 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 pvp warps.\",\"color\":\"aqua\"}],\"italic\":false}" ], "PublicBukkitValues": "{\n \"playerwarps:itemtag_item\": \"1\"\n}" } }, "name": "pvp", "permission": "", "displayName": "PvP" }, { "teleportPrice": -1.0, "purgeTime": -1, "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}" } }, "name": "other", "permission": "", "displayName": "Other" } ], "totalPages": 1, "currentPage": 1, "totalCategories": 6 }
Fields:
categories (Array of Warp objects):
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.
totalPages (Number): Number of pages.
currentPage (Number): Current page.
totalCategories (Number): Total amount of categories on the server.
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?