Olzie Development Projects

https://docs.olziedev.com/
Admin
Olzie Development Projects provides documentation, frequently asked questions, and features for...
Tokens:136,334
Snippets:1,398
Trust Score:6.3
Update:3 months ago
Show doc for...
Tokens:
Raw
### Querying Documentation

Source: https://docs.olziedev.com/projects/playerwarps/plugins.md

Example of how to query the documentation dynamically using HTTP GET requests with 'ask' and 'goal' parameters.

```http
GET https://docs.olziedev.com/projects/playerwarps/plugins.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Querying Documentation with GET Request

Source: https://docs.olziedev.com/projects/playerauctions/restapi/endpoints/get/getauctioncategorybyname.md

This example demonstrates how to query the documentation dynamically using an HTTP GET request with 'ask' and optional 'goal' query parameters. This is useful for retrieving specific information or context not explicitly present on the page.

```http
GET https://docs.olziedev.com/projects/playerauctions/restapi/endpoints/get/getauctioncategorybyname.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### API Query Example

Source: https://docs.olziedev.com/projects/playereconomy/api/commands.md

Demonstrates how to query the documentation dynamically using an HTTP GET request with 'ask' and optional 'goal' parameters. This is useful for retrieving information not explicitly present on the current page.

```http
GET https://docs.olziedev.com/projects/playereconomy/api/commands.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation Endpoint

Source: https://docs.olziedev.com/projects/playerwarps/restapi/endpoints/delete/deleteplayerwarpbyname.md

This example shows how to query the documentation dynamically using an HTTP GET request with 'ask' and optional 'goal' query parameters. This is useful for retrieving information not explicitly present on the current page.

```http
GET https://docs.olziedev.com/projects/playerwarps/restapi/endpoints/delete/deleteplayerwarpbyname.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### HTTP GET Request Example

Source: https://docs.olziedev.com/projects/playereconomy/features.md

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter.

```http
GET https://docs.olziedev.com/projects/playereconomy/features.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation with GET Request

Source: https://docs.olziedev.com/projects/playerauctions/commands.md

Use this GET request to query the documentation dynamically. Include your specific question in the `ask` parameter and an optional broader goal in the `goal` parameter.

```http
GET https://docs.olziedev.com/projects/playerauctions/commands.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation with GET Request

Source: https://docs.olziedev.com/projects/playertreasury/restapi/errors.md

To get information not explicitly on the page, perform an HTTP GET request to the page URL with 'ask' and optional 'goal' query parameters. This is useful for dynamic querying and clarification.

```http
GET https://docs.olziedev.com/projects/playertreasury/restapi/errors.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.olziedev.com/projects/playertrade/configuration/item.md

Use this endpoint to ask questions about the documentation. Provide a specific question in the 'ask' parameter and an optional 'goal' parameter to guide the AI's response. The response includes a direct answer, relevant excerpts, and sources.

```http
GET https://docs.olziedev.com/projects/playertrade/configuration/item.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation with GET Request

Source: https://docs.olziedev.com/projects/playerwarps/restapi/events/playerwarpsponsorevent.md

Use this GET request to query the documentation dynamically with specific questions and optional end goals. The response includes direct answers and relevant documentation excerpts.

```http
GET https://docs.olziedev.com/projects/playerwarps/restapi/events/playerwarpsponsorevent.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.olziedev.com/projects/playerwarps/restapi/errors.md

To get information not explicitly on this page, make an HTTP GET request to the page URL with 'ask' and optional 'goal' query parameters.

```http
GET https://docs.olziedev.com/projects/playerwarps/restapi/errors.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.olziedev.com/projects/playertrade/configuration.md

Perform an HTTP GET request on the current page URL with the `ask` query parameter for specific questions and the optional `goal` query parameter for broader objectives. Use this when information is not explicitly present or clarification is needed.

```http
GET https://docs.olziedev.com/projects/playertrade/configuration.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Create Player Auction Example

Source: https://docs.olziedev.com/projects/playerauctions/api.md

Provides an example of how to create a player auction. This includes obtaining the API instance, retrieving an auction player, setting up a product provider, and creating the auction with specified details.

```APIDOC
## Create Player Auction

### Description
An example demonstrating how to create a player auction. This involves getting the API instance, retrieving an auction player by UUID, setting up a product provider (e.g., for ItemStacks), and then creating the auction with a price, seller, product, and a callback for the created auction.

### Method
`PlayerAuctionsAPI.createPlayerAuction(double price, APlayer seller, AProduct product, boolean isUnstackable, Consumer<Auction> callback)`

### Usage
```java
PlayerAuctionsAPI.getInstance(api -> {
    APlayer seller = api.getAuctionPlayer(UUID.randomUUID());
    AProductProvider<ItemStack> provider = (AProductProvider<ItemStack>) api.getDefaultProductProvider();
    ItemStack itemStack = new ItemStack(Material.DIAMOND, 1);
    api.createPlayerAuction(1000d,
                            seller,
                            provider.setupProduct(1L, itemStack),
                            false,
                            auction -> {
                            // The auction instance is available here
                            });
});
```
```

--------------------------------

### Example Command Class

Source: https://docs.olziedev.com/projects/playerwarps/api/commands.md

An example of a custom command class that extends `WCommand`. This class demonstrates how to define a command with a specific name, executor type, and implement the `execute` and `onTabComplete` methods.

```APIDOC
## Example Command Class

This is an example of a sub-command class that allows you to create sub-commands.

### Class Definition
```java
import com.olziedev.playerwarps.api.warp.command.WCommand;
import org.bukkit.command.CommandSender;

import java.util.List;

public class ExampleCommand extends WCommand {

    public ExampleCommand() {
        super("example");
        this.executorType = ExecutorType.PLAYER_ONLY;
    }

    @Override
    public void execute(CommandSender sender, String[] arguments) {
        
    }

    @Override
    public List<String> onTabComplete(CommandSender sender, String[] arguments) {
        return super.onTabComplete(sender, arguments);
    }
}
```

### Executor Types

The `executorType` can be set to `PLAYER_ONLY`, `CONSOLE_ONLY`, or `null` (for both).

### Tab Completion

The `onTabComplete` method is optional and provides a list of strings for tab completion.
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.olziedev.com/projects/nightmarket/configuration/menu.md

To get additional information not directly on the page, perform an HTTP GET request to the page URL with the `ask` query parameter and an optional `goal` parameter.

```http
GET https://docs.olziedev.com/projects/nightmarket/configuration/menu.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation with GET Request

Source: https://docs.olziedev.com/projects/playerbusinesses/restapi/endpoints.md

To get information not explicitly on a page, perform an HTTP GET request to the page URL with 'ask' and optional 'goal' query parameters. The 'ask' parameter should contain a specific, natural language question, and 'goal' can describe the broader objective.

```http
GET https://docs.olziedev.com/projects/playerbusinesses/restapi/endpoints.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Example Warp Addon Class

Source: https://docs.olziedev.com/projects/playerwarps/api/expansions/warp.md

Demonstrates how to create a custom warp addon by extending the `WAddon` class. This example checks player Y-coordinate to authorize warp placement.

```java
import com.olziedev.playerwarps.api.expansion.WAddon;
import org.bukkit.entity.Player;

public class ExampleWarpExpansion extends WAddon {

    @Override
    public boolean isEnabled() {
        return true;
    }

    @Override
    public String getName() {
        return "Example Expansion";
    }

    @Override
    public void onLoad() {

    }

    @Override
    public Runnable isAuthorized(Player player) {
        if (player.getLocation().getY() < 5) {
            return () -> player.sendMessage("You are not authorized to use this command!");
        }
        return null;
    }
}
```

--------------------------------

### Querying Documentation via HTTP GET

Source: https://docs.olziedev.com/projects/playerauctions/restapi/events/auctionexpireupdateevent.md

To get more information not directly on the page, make an HTTP GET request to the page URL with the `ask` query parameter. An optional `goal` parameter can be included to tailor the response.

```http
GET https://docs.olziedev.com/projects/playerauctions/restapi/events/auctionexpireupdateevent.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Example Command Class

Source: https://docs.olziedev.com/projects/nightmarket/api/commands.md

An example of a custom command class extending MCommand. This class defines the command name and executor type, and provides methods for execution and tab completion.

```java
import com.olziedev.nightmarket.api.market.command.MCommand;
import org.bukkit.command.CommandSender;

import java.util.List;

public class ExampleCommand extends MCommand {

    public ExampleCommand() {
        super("example");
        this.executorType = ExecutorType.PLAYER_ONLY;
    }

    @Override
    public void execute(CommandSender sender, String[] arguments) {

    }

    @Override
    public List<String> onTabComplete(CommandSender sender, String[] arguments) {
        return super.onTabComplete(sender, arguments);
    }
}
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.olziedev.com/projects/playereconomy/restapi/errors.md

To get information not explicitly on the page, make an HTTP GET request to the page URL with 'ask' and optional 'goal' query parameters. This is useful for clarifying details or retrieving related documentation.

```http
GET https://docs.olziedev.com/projects/playereconomy/restapi/errors.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation with 'ask' Parameter

Source: https://docs.olziedev.com/projects/playerwarps/restapi/endpoints/get/getplayerwarpbyname.md

To get information not directly on the page, make an HTTP GET request to the current page URL with the `ask` query parameter. The `goal` parameter is optional and helps tailor the response to your broader objective.

```http
GET https://docs.olziedev.com/projects/playerwarps/restapi/endpoints/get/getplayerwarpbyname.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation with Agent Instructions

Source: https://docs.olziedev.com/projects/playerauctions/configuration/item.md

Perform an HTTP GET request to query the documentation dynamically. Use the 'ask' parameter for specific questions and the optional 'goal' parameter to tailor the response.

```http
GET https://docs.olziedev.com/projects/playerauctions/configuration/item.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Create a Player Auction

Source: https://docs.olziedev.com/projects/playerauctions/api.md

Example of creating a player auction with a specified price, seller, product, and whether it's a starting bid. The product setup might throw an error if the default provider is not an ItemStack provider.

```java
PlayerAuctionsAPI.getInstance(api -> {
    APlayer seller = api.getAuctionPlayer(UUID.randomUUID());
    // now this could possibly throw an error if the default product provider is not an ItemStack provider.
    // By default player auctions does use an ItemStack provider, but another plugin might integrate and change it.
    AProductProvider<ItemStack> provider = (AProductProvider<ItemStack>) api.getDefaultProductProvider();
    ItemStack itemStack = new ItemStack(Material.DIAMOND, 1);
    // you can either create your own itemstack object, it grab the item safely from their hand using provider#setupProduct(long, Player)
    api.createPlayerAuction(1000d,
                            seller,
                            provider.setupProduct(1L, itemStack),
                            false,
                            auction -> {
                            // the auction instance.
                            });
});
```

--------------------------------

### Accessing Economy Player and Balance

Source: https://docs.olziedev.com/projects/playereconomy/api.md

Example of retrieving an economy player by UUID and getting their balance using the PlayerEconomy API.

```java
PlayerEconomy.getInstance(api -> {
    EPlayer player = api.getEcoPlayer(UUID.randomUUID());
    // get their balance
    player.getBalance();    
});
```

--------------------------------

### Query Agent Instructions Documentation

Source: https://docs.olziedev.com/projects/playerbusinesses/commands.md

Perform an HTTP GET request to query the documentation dynamically. Use the 'ask' parameter for specific questions and the optional 'goal' parameter to define the broader objective.

```bash
GET https://docs.olziedev.com/projects/playerbusinesses/commands.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Get Sponsor Warp by ID Response Example

Source: https://docs.olziedev.com/projects/playerwarps/restapi/endpoints/get/getsponsorwarpbyid.md

This JSON object represents the successful response when retrieving a sponsor warp by its ID. It includes all warp properties and sponsor-specific data.

```json
{
  "id": 1,
  "warpName": "testing",
  "warpLocation": {
    "world": "world",
    "x": -1846.9302338464981,
    "y": 69.0,
    "z": 83.01201806289632,
    "yaw": 112.37841,
    "pitch": 17.999645,
    "locationSafe": true,
    "warpServer": "N/A",
    "properLocation": {
      "world": "world",
      "x": -1846.9302338464981,
      "y": 69.0,
      "z": 83.01201806289632,
      "yaw": 112.37841,
      "pitch": 17.999645
    },
    "worldType": "world"
  },
  "warpRate": {
    "earnedRateRewards": [],
    "rates": {},
    "rateAverage": 0.0,
    "totalRates": 0,
    "playersRatedAmount": 0
  },
  "warpCategory": [
    {
      "name": "other",
      "teleportPrice": -1.0,
      "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}"]
        }
      },
      "displayName": "Other"
    }
  ],
  "warpIcon": {
    "warpIcon": null
  },
  "warpRent": {
    "warpLastRent": 1735075589283,
    "warpNewRent": 1735161989283
  },
  "warpVisit": {
    "warpVisits": 0,
    "purgedWarpVisits": 0,
    "warpVisitedBoosted": [],
    "warpVisited": []
  },
  "warpDate": 1735075589283,
  "warpType": "NORMAL",
  "warpCost": null,
  "paid": [],
  "banned": [],
  "whitelisted": [],
  "managers": [],
  "whitelistEnabled": false,
  "warpLocked": false,
  "warpPassword": null,
  "sponsorWarp" :
    {
      "id" : "1",
      "time" : 1735767860362,
      "lastRepeatingTime" : 1735595060362,
      "timeLeft" : 172690918,
      "repeatingTime" : 86400000,
      "automatic" : false
    },
  "sponsorCooldown": null,
  "randomSort": 3,
  "warpPlayer": {
    "uuid": "5ca251ab-589d-4f04-8f0c-28404d0686b0",
    "name": "ForgotUrPassword",
    "language": "en_gb"
  },
  "favoriteCount": 0,
  "warpDisplayName": "testing"
}
```

--------------------------------

### FactionsX Addon Configuration for Player Warps

Source: https://docs.olziedev.com/projects/playerwarps/plugins.md

Configure Player Warps to integrate with FactionsX. Ensure FactionsX is installed. This setup allows for warp management within player claims.

```yaml
factionsx:
    # Do you want to enable factionsx support?
    # You need factionsx installed for this to work!
    enabled: false
    # What version of this expansion do you want to download/use?
    version: latest
    # Should the warp get deleted once the faction is deleted?
    delete: true
    # Should they only be able to set warps in claims? If disabled, they can set warps in their claim or wilderness.
    only-land: true
    lang:
      not-in-claim: "%prefix% &cSorry you can't set a warp here, &cYou aren't in a claim!"
      dont-own-claim: "%prefix% &cSorry you can't set a warp here, because you don't own this claim."
```

--------------------------------

### Query Documentation with Ask and Goal Parameters

Source: https://docs.olziedev.com/projects/playerauctions/faq.md

Use GET requests with 'ask' and optional 'goal' parameters to query documentation dynamically. This is useful when information is not explicitly present or requires clarification.

```http
GET https://docs.olziedev.com/projects/playerauctions/faq.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Get Warp Categories Response Example

Source: https://docs.olziedev.com/projects/playerwarps/restapi/endpoints/get/getwarpcategories.md

This JSON structure represents the response from the `/api/playerwarps/getWarpCategories/{page}` endpoint. It includes a list of warp categories, each with details about its icon, display name, and other properties.

```json
{
    "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}"
                    ]
                }
            },
            "name": "pvp",
            "permission": "",
            "displayName": "PvP"
        }
    ]
}
```

--------------------------------

### Java Product Addon Example

Source: https://docs.olziedev.com/projects/playerauctions/api/expansions/product.md

Implement this class to create a new product type. It extends AProductProvider and requires overriding methods for product management like giving, taking, and validation.

```java
public class ProductExample extends AProductProvider<String> {
    
    @Override
    public void giveProduct(AProduct<String> aProduct, Player player) {
        
    }

    @Override
    public boolean isInvalidProduct(AProduct<String> product, Player player) {
        return false;
    }

    @Override
    public boolean isDamagedProduct(AProduct<String> product, Player player) {
        return false;
    }

    @Override
    public boolean isCorrect(AProduct<String> product, Player player) {
        return false;
    }

    @Override
    public boolean isSimilarProduct(ASerializableProduct<?> product, ASerializableProduct<?> other) {
        return false;
    }

    @Override
    public void takeProduct(AProduct<String> product, Player player) {

    }

    @Override
    public AProduct<String> setupProduct(Long amount, Player player) {
        return null;
    }

    @Override
    public AProduct<String> setupProduct(Long amount, String s) {
        return null;
    }

    @Override
    public ASerializableProduct<String> getSerializableProduct(byte[] bytes) {
        return null;
    }

    @Override
    public ItemStack getIcon(AProduct<String> product) {
        return null;
    }

    @Override
    public List<ACategory> getCategories(AProduct<String> product) {
        return null;
    }

    @Override
    public List<ACategory> getCategories(String product) {
        return null;
    }

    @Override
    public String getProductName(AProduct<String> product, FileConfiguration configuration, FileConfiguration lang, boolean showDisplayName) {
        return null;
    }

    @Override
    public List<String> getItemLore(Auction auction, ConfigurationSection section) {
        return null;
    }

    @Override
    public boolean isEnabled() {
        return true;
    }

    @Override
    public String getName() {
        return "Example Expansion";
    }

    @Override
    public void onLoad() {

    }
}
```

--------------------------------

### Query Documentation with `ask` and `goal` Parameters

Source: https://docs.olziedev.com/projects/playertreasury/restapi/events.md

Perform an HTTP GET request to query the documentation. Use the `ask` parameter for specific questions and the optional `goal` parameter for broader context.

```HTTP
GET https://docs.olziedev.com/projects/playertreasury/restapi/events.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Querying Documentation Dynamically

Source: https://docs.olziedev.com/projects/playerauctions/restapi/errors.md

Demonstrates how to query the documentation dynamically using an HTTP GET request with 'ask' and optional 'goal' query parameters.

```http
GET https://docs.olziedev.com/projects/playerauctions/restapi/errors.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### GriefPrevention Addon Configuration for Player Warps

Source: https://docs.olziedev.com/projects/playerwarps/plugins.md

Configure Player Warps to integrate with GriefPrevention. Ensure GriefPrevention is installed. This setup allows for warp management within player claims and automatic warp creation/deletion.

```yaml
griefprevention:
    # Do you want to enable griefprevention support?
    # You need griefprevention installed for this to work!
    enabled: false
    # What version of this expansion do you want to download/use?
    version: latest
    # Should the warp be created when a claim is created?
    create: false
    # What should the warp name be called when its created? Only as of right now you can use %player%
    warp-name-creation: "%player%"
    # Should the warp get deleted once the claim is deleted?
    delete: true
    # Should they only be able to set warps in claim? If disabled, they can set warps in their claim or wilderness.
    only-land: true
    lang:
      not-in-claim: "%prefix% &cSorry you can't set a warp here, &cYou aren't in a claim!"
      dont-own-claim: "%prefix% &cSorry you can't set a warp here, because you don't own this claim."
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.olziedev.com/projects/playertreasury/faq.md

Use this mechanism to ask questions about the documentation dynamically. The `ask` parameter is for the immediate question, and the optional `goal` parameter helps tailor the answer to your end goal.

```http
GET https://docs.olziedev.com/projects/playertreasury/faq.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Get Auction Categories (JSON Response)

Source: https://docs.olziedev.com/projects/playerauctions/restapi/endpoints/get/getauctioncategories.md

Example of a successful JSON response when fetching auction categories. It details total pages, categories available, and individual category information including icons and display names.

```json
{
    "totalPages" : 1,
    "totalCategories" : 6,
    "categories" : [ { 
      "minPrice" : -1.0,
      "maxPrice" : -1.0,
      "all" : true,
      "icon" : {
        "type" : "BOOK",
        "meta" : {
          "display-name" : "{\"text\":\"\",\"extra\":[{\"text\":\"All Auctions\",\"obfuscated\":false,\"italic\":false,\"underlined\":false,\"strikethrough\":false,\"color\":\"aqua\",\"bold\":false}]}",
          "lore" : [ "{\"text\":\"\",\"extra\":[{\"text\":\"Click\",\"color\":\"yellow\"},{\"text\":\" to view all the auctions.\",\"color\":\"aqua\"}],\"italic\":false}" ],
          "PublicBukkitValues" : "{\n    \"playerauctions:itemtag_item\": \"1\"\n}"
        }
      },
      "name" : "all",
      "displayName" : "All"
    }, { 
      "minPrice" : -1.0,
      "maxPrice" : -1.0,
      "all" : false,
      "icon" : {
        "type" : "CAKE",
        "meta" : {
          "display-name" : "{\"text\":\"\",\"extra\":[{\"text\":\"Food\",\"obfuscated\":false,\"italic\":false,\"underlined\":false,\"strikethrough\":false,\"color\":\"aqua\",\"bold\":false}]}",
          "lore" : [ "{\"text\":\"\",\"extra\":[{\"text\":\"Click\",\"color\":\"yellow\"},{\"text\":\" to view all the food.\",\"color\":\"aqua\"}],\"italic\":false}" ],
          "PublicBukkitValues" : "{\n    \"playerauctions:itemtag_item\": \"1\"\n}"
        }
      },
      "name" : "food",
      "displayName" : "Food"
    }, { 
      "minPrice" : -1.0,
      "maxPrice" : -1.0,
      "all" : false,
      "icon" : {
        "type" : "DIAMOND_PICKAXE",
        "meta" : {
          "display-name" : "{\"text\":\"\",\"extra\":[{\"text\":\"Tools\",\"obfuscated\":false,\"italic\":false,\"underlined\":false,\"strikethrough\":false,\"color\":\"aqua\",\"bold\":false}]}",
          "lore" : [ "{\"text\":\"\",\"extra\":[{\"text\":\"Click\",\"color\":\"yellow\"},{\"text\":\" to view all the tools.\",\"color\":\"aqua\"}],\"italic\":false}" ],
          "attribute-modifiers" : { },
          "ItemFlags" : [ "HIDE_ATTRIBUTES" ],
          "PublicBukkitValues" : "{\n    \"playerauctions:itemtag_item\": \"1\"\n}"
        }
      },
      "name" : "tools",
      "displayName" : "Tools"
    }, { 
      "minPrice" : -1.0,
      "maxPrice" : -1.0,
      "all" : false,
      "icon" : {
        "type" : "DIAMOND_HELMET",
        "meta" : {
          "display-name" : "{\"text\":\"\",\"extra\":[{\"text\":\"Armor\",\"obfuscated\":false,\"italic\":false,\"underlined\":false,\"strikethrough\":false,\"color\":\"aqua\",\"bold\":false}]}",
          "lore" : [ "{\"text\":\"\",\"extra\":[{\"text\":\"Click\",\"color\":\"yellow\"},{\"text\":\" to view all the armor.\",\"color\":\"aqua\"}],\"italic\":false}" ],
          "attribute-modifiers" : { },
          "ItemFlags" : [ "HIDE_ATTRIBUTES" ],
          "PublicBukkitValues" : "{\n    \"playerauctions:itemtag_item\": \"1\"\n}"
        }
      },
      "name" : "armor",
      "displayName" : "Armor"
    }, { 
      "minPrice" : -1.0,
      "maxPrice" : -1.0,
      "all" : false,
      "icon" : {
        "type" : "ENCHANTED_BOOK",
        "meta" : {
          "display-name" : "{\"text\":\"\",\"extra\":[{\"text\":\"Items\",\"obfuscated\":false,\"italic\":false,\"underlined\":false,\"strikethrough\":false,\"color\":\"aqua\",\"bold\":false}]}",
          "lore" : [ "{\"text\":\"\",\"extra\":[{\"text\":\"Click\",\"color\":\"yellow\"},{\"text\":\" to view all the items.\",\"color\":\"aqua\"}],\"italic\":false}" ],
          "PublicBukkitValues" : "{\n    \"playerauctions:itemtag_item\": \"1\"\n}"
        }
      },
      "name" : "items",
      "displayName" : "Items"
    }, { 
      "minPrice" : -1.0,
      "maxPrice" : -1.0,
      "all" : false,
      "icon" : {
        "type" : "DIRT",
        "meta" : {
          "display-name" : "{\"text\":\"\",\"extra\":[{\"text\":\"Blocks\",\"obfuscated\":false,\"italic\":false,\"underlined\":false,\"strikethrough\":false,\"color\":\"aqua\",\"bold\":false}]}",
          "lore" : [ "{\"text\":\"\",\"extra\":[{\"text\":\"Click\",\"color\":\"yellow\"},{\"text\":\" to view all the blocks.\",\"color\":\"aqua\"}],\"italic\":false}" ],
          "PublicBukkitValues" : "{\n    \"playerauctions:itemtag_item\": \"1\"\n}"
        }
      },
      "name" : "blocks",
      "displayName" : "Blocks"
    } ],
    "currentPage" : 1
  }
```

--------------------------------

### Query Documentation with GET Request

Source: https://docs.olziedev.com/projects/nightmarket/api/expansions/currency.md

Use this endpoint to dynamically query the documentation. Include your question in the `ask` parameter and optionally specify a broader `goal` to tailor the response.

```http
GET https://docs.olziedev.com/projects/nightmarket/api/expansions/currency.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation with GET Request

Source: https://docs.olziedev.com/projects/nightmarket/restapi/endpoints/delete.md

Use this method to ask questions about the documentation or retrieve additional context. The 'ask' parameter contains the specific question, and 'goal' is optional for tailoring the answer.

```http
GET https://docs.olziedev.com/projects/nightmarket/restapi/endpoints/delete.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Get Player Warps (Page 1)

Source: https://docs.olziedev.com/projects/playerwarps/restapi/endpoints/get/getplayerwarps.md

Retrieves the first page of player warps. This is a basic GET request to the endpoint.

```http
GET /api/playerwarps/getPlayerWarps/1 HTTP/1.1
Host: localhost:8080
Accept: */*
```

--------------------------------

### Example Currency Addon Class

Source: https://docs.olziedev.com/projects/playerwarps/api/expansions/currency.md

Implement this class to define a new currency type. Override methods to specify currency name, balance retrieval, deposits, withdrawals, and enable/disable states. Ensure all abstract methods are implemented.

```java
import com.olzied.playerwarps.api.expansion.WCurrency;
import com.olzied.playerwarps.api.player.WPlayer;

import java.util.function.Consumer;

public class CurrencyExample extends WCurrency {

    @Override
    public String getCurrencyName() {
        return "";
    }

    @Override
    public String getCurrencyPrefix(String internalCurrency) {
        return "";
    }

    @Override
    public void getBalance(WPlayer wPlayer, String internalCurrency, Consumer<Double> balanceConsumer) {

    }

    @Override
    public void deposit(WPlayer wPlayer, double amount, String internalCurrency, Consumer<Boolean> response) {

    }

    @Override
    public void withdraw(WPlayer wPlayer, double amount, String internalCurrency, Consumer<Boolean> response) {

    }

    @Override
    public boolean isEnabled() {
        return true;
    }

    @Override
    public String getName() {
        return "Example Currency";
    }

    @Override
    public void onLoad() {

    }
}
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.olziedev.com/projects/nightmarket/faq.md

Use this endpoint to ask questions about the documentation dynamically. Provide your question in the 'ask' parameter and an optional broader goal in the 'goal' parameter.

```http
GET https://docs.olziedev.com/projects/nightmarket/faq.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.olziedev.com/projects/nightmarket/restapi.md

Perform an HTTP GET request to query the documentation dynamically. Use the 'ask' parameter for your question and optionally the 'goal' parameter for broader context.

```http
GET https://docs.olziedev.com/projects/nightmarket/restapi.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Action Tag Examples

Source: https://docs.olziedev.com/projects/playereconomy/configuration.md

Examples of using action tags to modify command execution. Tags like 'delay', 'permission', 'condition', and 'vanished' can be appended to actions.

```plaintext
[broadcast<delay=20>] &aHello World
```

```plaintext
[add_money<permission=pa.donator>] 1000
```

```plaintext
[add_money<condition=%player_name%=Notch>] 1000
[add_money<condition=%player_name%!=Notch>] 1000
```

```plaintext
[broadcast<vanished=false>] This player is not in vanish!
```

--------------------------------

### Query GitBook Documentation

Source: https://docs.olziedev.com/projects/playerelections/configuration.md

Use this GET request to query documentation dynamically. Include an `ask` parameter for your specific question and an optional `goal` parameter for the broader objective.

```http
GET https://docs.olziedev.com/projects/playerelections/configuration.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Authentication Example

Source: https://docs.olziedev.com/projects/playertrade/restapi.md

Example of how to include authentication credentials in the request header using Basic Authentication. The Authorization header should contain a Base64 encoded string of 'UUID:API_KEY'.

```APIDOC
## Example API Request

Here’s how to authenticate API requests using your Minecraft UUID and API token:

**Request Header**:

```http
Authorization: Basic {Base64 encoded string of 'UUID:API_KEY'}
```

In this case, the base64 encoded string would be a combination of your Minecraft UUID and API Key (separated by a colon). You can use your program to easily generate the base64 encoding.
```
Tokens:
Raw