OnlyBot

https://onlybot.store/doc/
Admin
OnlyBot is an automated bot for playing Dofus, utilizing a MITM version to manage multiple accounts...
Tokens:55,714
Snippets:325
Trust Score:5.5
Update:10 months ago
Show doc for...
Tokens:
Raw
### Open All Bags - Lua Example

Source: https://onlybot.store/doc/inventory/inventory_OpenBags

Demonstrates how to use the inventory_OpenBags() function in Lua. This example opens all special bags, waits for 2 seconds, and then logs the amount of inventory space freed. It requires the global_Delay and global_SendLogs functions.

```lua
function example_inventoryopenbags() 
     -- Ouvrir tous les sacs
     inventory_OpenBags() 
     global_Delay(2000) 

     -- Vérifier l'espace libéré
     local pods = inventory_Pods() 
     global_SendLogs("Pods après ouverture : " .. pods .. "%", "Cyan") 
end 

-- Appeler la fonction example_inventoryopenbags()
```

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

### Open HDV Buy NPC with buy_NPC() - Lua Example

Source: https://onlybot.store/doc/buy/buy_NPC

This Lua code snippet demonstrates how to use the buy_NPC() function to automatically open the HDV buy NPC. It includes a delay and an example of checking item price before purchasing. No parameters are required for buy_NPC().

```lua
function example_buynpc() 
    -- Ouvrir le NPC d'achat 
    buy_NPC() 
    global_Delay(2000) 
    -- Rechercher un objet 
    local price = buy_GetPriceItem(12345, 10)
    if price then 
        buy_BuyItem(12345, 10)
    end 
end 

-- Appeler la fonction
example_buynpc()
```

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

### sale_GetSellsInfo() Example - Lua

Source: https://onlybot.store/doc/sale/sale_GetSellsInfo

This example demonstrates how to use the sale_GetSellsInfo() function in Lua. It retrieves the sales information string and then logs it to the console. The output string contains details about items for sale in the format 'Gid: [gid] | Lot: [lot] | Prix: [price]' for each item, separated by newlines. Parsing of this string is also suggested for further processing.

```lua
function example_salegetsellsinfo()
    -- Obtenir les informations de vente
    local info = sale_GetSellsInfo()
    global_SendLogs("Objets en vente :", "Cyan")
    global_SendLogs(info, "White")

    -- Parser les informations si nécessaire
    -- Le format est : "Gid: 123 | Lot: 10 | Prix: 100\nGid: 456 | Lot: 5 | Prix: 50"
end

-- Appeler la fonction example_salegetsellsinfo()
```

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

### Get All Enemy Fighters

Source: https://onlybot.store/doc/fight/fight_PlacementGetAllEnnemyFighter

Retrieves all enemy fighters present during the placement phase.

```APIDOC
## GET /websites/onlybot_store_doc/fight_PlacementGetAllEnnemyFighter

### Description
Retrieves all enemy fighters present during the placement phase.

### Method
GET

### Endpoint
/websites/onlybot_store_doc/fight_PlacementGetAllEnnemyFighter

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **table** - Dictionary of all enemy fighters (placement phase)
```

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

### Initiate Exchange

Source: https://onlybot.store/doc/exchange/index

Starts an exchange request with another player by sending a request to the server to initiate the trade.

```APIDOC
## POST /api/exchange/start

### Description
Initiates an exchange request with a target player.

### Method
POST

### Endpoint
/api/exchange/start

### Parameters
#### Query Parameters
- **targetCharacterId** (integer) - Required - The ID of the character to initiate the exchange with.

### Request Example
```json
{
  "targetCharacterId": 12345
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the exchange initiation was successful.

#### Response Example
```json
{
  "success": true
}
```
```

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

### POST /exchange/start

Source: https://onlybot.store/doc/exchange/exchange_Start

Initiates an exchange request with another player. Sends a request to the server to start the exchange.

```APIDOC
## POST /exchange/start

### Description
Initiates an exchange request with another player. Sends a request to the server to start the exchange.

### Method
POST

### Endpoint
/exchange/start

### Parameters
#### Query Parameters
- **targetCharacterId** (string) - Required - The ID of the character to start the exchange with.

### Request Example
```json
{
  "targetCharacterId": "123456789"
}
```

### Response
#### Success Response (200)
This endpoint does not return a value upon success.

#### Response Example
```json
{}
```
```

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

### Get Challenge Target Information (Lua)

Source: https://onlybot.store/doc/fight/fight_GetChallengeTarget

Retrieves target information for a specific challenge. Requires a challenge ID as input and returns a table containing target details such as targetId, targetCell, state, challengeId, targets, and targetCount. The example demonstrates fetching and logging target information.

```lua
function example_fightgetchallengetarget()     -- Obtenir les informations de cible d'un challenge local challengeId = 123 local targetInfo = fight_GetChallengeTarget(challengeId)     if targetInfo then local targetCell = fight_GetProperty(targetInfo, "targetCell")     local targetCount = fight_GetProperty(targetInfo, "targetCount")     fight_SendLogs("Challenge " .. challengeId .. " - Cible: cellule " .. targetCell .. " (" .. targetCount .. " cibles)", "Cyan")     end end -- Appeler la fonction example_fightgetchallengetarget()
```

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

### Buy Item from NPC (Lua Example)

Source: https://onlybot.store/doc/buy/buy_ItemFromNpc

This Lua code snippet demonstrates how to open an NPC vendor and then use the buy_ItemFromNpc function to purchase an item. It includes necessary delays to ensure the NPC is ready before the purchase attempt.

```lua
function example_buyitemfromnpc() 
    -- Open an NPC and buy 
    npc_OpenVendor(12345, 987654, 3)
    global_Delay(2000)
    buy_ItemFromNpc(67890, 10)
    global_Delay(1000)
end
-- Call the function example_buyitemfromnpc()
```

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

### Get Challenges

Source: https://onlybot.store/doc/fight/fight_GetChallenges

Retrieves all available challenges in the current combat.

```APIDOC
## GET /websites/onlybot_store_doc/fight/challenges

### Description
Retrieves all available challenges in the current combat.

### Method
GET

### Endpoint
/websites/onlybot_store_doc/fight/challenges

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **challenges** (table) - A dictionary of available challenges, indexed by challengeId.

#### Response Example
```json
{
  "challenges": {
    "challenge1": {
      "name": "Challenge Name 1",
      "xpBonus": 10
    },
    "challenge2": {
      "name": "Challenge Name 2",
      "xpBonus": 15
    }
  }
}
```
```

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

### Get Sells Info

Source: https://onlybot.store/doc/sale/index

Retrieves a formatted string containing all information about items currently listed for sale, including GID, lot, and price.

```APIDOC
## sale_GetSellsInfo(())

### Description
Retrieves a formatted string containing all information about items currently on sale (GID, lot, price).

### Method
N/A (Function Call)

### Endpoint
N/A (Function Call)

### Parameters
None

### Request Example
```
call sale_GetSellsInfo()
```

### Response
#### Success Response (200)
- **sellsInfo** (string) - A formatted string with details of all active sales.

#### Response Example
```json
{
  "sellsInfo": "GID: 1001, Lot: 1, Price: 5000; GID: 1002, Lot: 5, Price: 1000"
}
```
```

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

### storage_GetItem

Source: https://onlybot.store/doc/storage/storage_GetItem

Retrieves an item from storage to the inventory. If quantity is 0, retrieves the entire available quantity.

```APIDOC
## POST /storage/get_item

### Description
Retrieves an item from storage to the inventory. If quantity is 0, retrieves the entire available quantity.

### Method
POST

### Endpoint
/storage/get_item

### Parameters
#### Request Body
- **gid** (int) - Required - The GID of the item to retrieve
- **quantity** (int) - Required - The quantity to retrieve (0 = retrieve all)

### Request Example
```json
{
  "gid": 12345,
  "quantity": 10
}
```

### Response
#### Success Response (200)
This endpoint does not return a value.

#### Response Example
```json
null
```
```

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

### Open Crafting Interface - Lua

Source: https://onlybot.store/doc/craft/craft_Open

Opens the crafting interface for a specific resource using its cell ID. The character will automatically move to the resource if needed. This example also shows how to put items into the crafting grid and specifies a delay between actions.

```lua
function example_craftopen()
    -- Ouvrir l'interface de craft
    craft_Open(456)
    global_Delay(2000) -- Mettre des objets dans le craft
    craft_PutItem(12345, 10)
    craft_PutItem(67890, 5)
    global_Delay(1000)
end
-- Appeler la fonction example_craftopen()
```

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

### Set Crafting Quantity

Source: https://onlybot.store/doc/craft/index

Defines the number of times the craft should be performed. For example, if number = 5, the craft will be performed 5 times.

```APIDOC
## craft_Quantity(number)

### Description
Defines the number of times the craft should be performed. For example, if number = 5, the craft will be performed 5 times.

### Method
CALL (or a relevant method for function calls)

### Endpoint
N/A (Function Call)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **number** (number) - Required - The number of times to perform the craft.

### Request Example
```json
{
  "function": "craft_Quantity",
  "arguments": {
    "number": 5
  }
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the operation was successful.

#### Response Example
```json
{
  "success": true
}
```
```

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

### Lua Function Definition and Usage in OnlyBot

Source: https://onlybot.store/doc/structure-de-base

Demonstrates the basic syntax for defining a function in Lua, including parameters and arguments. It also provides an example of a custom function 'envoyerMessage' used within OnlyBot for sending logs with specified colors.

```lua
function leNomDeMaFonction(argument1, argument2, argument3)     -- Le contenu de notre fonction end
```

```lua
function envoyerMessage(argument)     global_SendLogs("message a print", "green") end
```

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

### Setting Exchange Readiness (Lua)

Source: https://onlybot.store/doc/exchange/exchange_SetReady

Sets or cancels the readiness status for an exchange step. The exchange can only be completed when both parties are ready. This example demonstrates how to set readiness and then cancel it.

```Lua
function example_exchangesetready()     -- Se mettre prêt pour finaliser l'échange exchange_AddItem(12345, 1)     global_Delay(500)     exchange_AddKamas(1000)     global_Delay(500)     exchange_SetReady(0, true) -- Se mettre prêt à l'étape 0 global_Delay(1000)      -- Annuler le statut prêt exchange_SetReady(0, false) -- Annuler le statut prêt end -- Appeler la fonction example_exchangesetready()
```

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

### Drop All Inventory to Storage - Lua Example

Source: https://onlybot.store/doc/storage/storage_DropAll

Demonstrates how to use the storage_DropAll() function to empty the inventory into storage. It assumes the exchange is open and verifies the result by checking and logging the freed inventory space. No specific dependencies are mentioned beyond the function itself.

```lua
function example_storagedropall()     -- Déposer tout l'inventaire dans le stockage storage_DropAll()     global_Delay(2000)      -- Vérifier l'espace libéré local pods = inventory_Pods()     global_SendLogs("Pods après dépôt : " .. pods .. "%", "Green") end -- Appeler la fonction example_storagedropall()
```

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

### Get All Enemy Fighters During Placement Phase (Lua)

Source: https://onlybot.store/doc/fight/fight_PlacementGetAllEnnemyFighter

Retrieves all enemy fighters present during the placement phase. This function takes no parameters and returns a dictionary containing all enemy fighters. It is useful for identifying and interacting with enemies before the main fight begins.

```lua
function example_fightplacementgetallennemyfighter()     -- Obtenir les ennemis en placement local enemies = fight_PlacementGetAllEnnemyFighter()     for enemyId, enemy in pairs(enemies) do     local cellId = fight_GetProperty(enemy, "cellId")     fight_SendLogs("Ennemi " .. enemyId .. " sur cellule " .. cellId, "Red")     end end -- Appeler la fonction example_fightplacementgetallennemyfighter()
```

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

### Get Job XP Percentage

Source: https://onlybot.store/doc/job/job_XP

Retrieves the experience percentage for a given job ID. The percentage returned is between 0 and 100.

```APIDOC
## GET /job_XP(jobId)

### Description
Retrieves the experience percentage of the current level for a job. Returns a number between 0 and 100.

### Method
GET

### Endpoint
`/job_XP(jobId)`

### Parameters
#### Path Parameters
- **jobId** (int) - Required - The ID of the job

### Response
#### Success Response (200)
- **double** - The experience percentage of the current level (0-100)

### Request Example
```lua
function example_jobxp()     -- Vérifier le pourcentage d'XP local xp = job_XP(36) -- Bûcheron global_SendLogs("XP Bûcheron : " .. xp .. "%", "Cyan")      -- Vérifier si on est proche du niveau supérieur if xp >= 90 then global_SendLogs("Presque niveau supérieur !", "Green")     end end -- Appeler la fonction example_jobxp()
```
```

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

### Get Available HDV Slots

Source: https://onlybot.store/doc/sale/index

Retrieves the number of HDV slots that are still available (total slots minus used slots).

```APIDOC
## sale_SlotsAvailable(())

### Description
Retrieves the number of HDV slots still available (total - used).

### Method
N/A (Function Call)

### Endpoint
N/A (Function Call)

### Parameters
None

### Request Example
```
call sale_SlotsAvailable()
```

### Response
#### Success Response (200)
- **availableSlots** (integer) - The number of available HDV slots.

#### Response Example
```json
{
  "availableSlots": 15
}
```
```

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

### Get Player Movement Points (PM)

Source: https://onlybot.store/doc/fight/fight_GetPM

Retrieves the current number of Movement Points (PM) for the character in a fight.

```APIDOC
## GET /fight/pm

### Description
Retrieves the current number of Movement Points (PM) for the character.

### Method
GET

### Endpoint
/fight/pm

### Parameters
#### Path Parameters
None

#### Query Parameters
None

### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **pm** (int) - The number of remaining movement points.

#### Response Example
```json
{
  "pm": 10
}
```

### Example Usage
```lua
local current_pm = fight_GetPM()
if current_pm >= 3 then
  local enemy_cell = fight_GetClosestEnemyCell()
  fight_MoveToCell(enemy_cell)
end
```
```

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

### Open Guild Chest Example - Lua

Source: https://onlybot.store/doc/guilde/guilde_OpenChest

This Lua code demonstrates how to use the guilde_OpenChest() function to open the guild chest, followed by dropping items. It includes delays to ensure proper execution order. Ensure the global_Delay and guilde_DropItem functions are available in your environment.

```lua
function example_guildeopenchest()     -- Ouvrir le coffre de guilde     guilde_OpenChest()     global_Delay(2000)      -- Déposer des objets     guilde_DropItem(12345, 50)     global_Delay(1000) end -- Appeler la fonction example_guildeopenchest()
```

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

### Get Item Price

Source: https://onlybot.store/doc/sale/index

Retrieves the average price of an item in the HDV for a specific lot. This operation may take up to 10 seconds to complete.

```APIDOC
## sale_GetPriceItem(gid, lot)

### Description
Retrieves the average price of an item in the HDV for a specific lot. This function can take up to 10 seconds.

### Method
N/A (Function Call)

### Endpoint
N/A (Function Call)

### Parameters
#### Path Parameters
- **gid** (integer) - Required - The unique identifier for the item.
- **lot** (integer) - Required - The lot number for which to get the price.

### Request Example
```
call sale_GetPriceItem(1001, 1)
```

### Response
#### Success Response (200)
- **price** (integer) - The average price of the item in kamas per unit.

#### Response Example
```json
{
  "price": 5000
}
```
```

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

### Get Inventory Pod Percentage (Lua)

Source: https://onlybot.store/doc/inventory/inventory_Pods

Retrieves the percentage of pods (weight) currently used in the inventory. Returns an integer between 0 and 100, or -1 if an error occurs. This function takes no parameters.

```Lua
function example_inventorypods() 
    -- Vérifier le pourcentage de pods local
    local pods = inventory_Pods()
    global_SendLogs("Pods utilisés : " .. pods .. "%", "Cyan")

    -- Aller au stockage si l'inventaire est presque plein
    if pods >= 90 then 
        global_SendLogs("Inventaire presque plein, aller au stockage", "Orange")
        map_ChangeMap("goto:123456") -- Aller à la banque
    end 
end 

-- Appeler la fonction example_inventorypods()
```

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

### Execute Crafting Sequence with craft_Ready()

Source: https://onlybot.store/doc/craft/craft_Ready

This Lua example demonstrates a complete crafting sequence using craft_Ready(). It includes opening the craft interface, placing items, setting the quantity, initiating the craft with craft_Ready(), waiting for completion, and closing the interface. Ensure the interface is open and items are correctly placed before calling craft_Ready().

```lua
function example_craftready() -- Séquence complète de craft
    craft_Open(456)
    global_Delay(2000)
    craft_PutItem(12345, 10)
    craft_PutItem(67890, 5)
    global_Delay(1000)
    craft_Quantity(5)
    global_Delay(1000)
    craft_Ready() -- Lance le craft
    global_Delay(5000) -- Attendre la fin du craft
    craft_Close()
end

-- Appeler la fonction example_craftready()
```

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

### Get Current Time with global_Time()

Source: https://onlybot.store/doc/global/global_Time

Retrieves the current local time formatted as HH:MM:SS. This function takes no parameters and returns a string representing the time. The example demonstrates how to get the time and use it for conditional logic within a script.

```lua
function example_globaltime()
     -- Obtenir l'heure locale
     local time = global_Time()
     global_SendLogs("Heure : " .. time, "Cyan")

     -- Vérifier si c'est une heure spécifique
     if time >= "22:00:00" then
         global_SendLogs("Il est tard, arrêt du script", "Orange")
         global_StopScript()
     end
end

-- Appeler la fonction
example_globaltime()
```

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

### Initiate Crafting

Source: https://onlybot.store/doc/craft/index

Launches the craft with the specified items and quantity. The interface must be open and items must be placed.

```APIDOC
## craft_Ready(())

### Description
Launches the craft with the specified items and quantity. The interface must be open and items must be placed.

### Method
CALL (or a relevant method for function calls)

### Endpoint
N/A (Function Call)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{
  "function": "craft_Ready"
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the operation was successful.

#### Response Example
```json
{
  "success": true
}
```
```

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

### Get Character Health Percentage

Source: https://onlybot.store/doc/character/character_Life

Retrieves the current health percentage of the character. Returns an integer between 0 and 100, or -1 in case of an error. No parameters are required. The example shows how to check health and use a potion if health is low.

```Lua
function example_characterlife()     -- Vérifier le pourcentage de vie local lifePercent = character_Life()     global_SendLogs("Vie : " .. lifePercent .. "%", "Cyan")      -- Utiliser un soin si la vie est faible if lifePercent < 30 then global_SendLogs("Vie faible, utilisation d'un soin", "Red")     inventory_UseItem(12345)     end end -- Appeler la fonction example_characterlife()
```

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

### Initiate Crafting Process

Source: https://onlybot.store/doc/craft/craft_Ready

The craft_Ready() function launches the crafting process using items and quantities that have already been placed in the interface. The interface must be open and items must be positioned correctly before calling this function.

```APIDOC
## craft_Ready()

### Description
Launches the craft with the defined items and quantity. The interface must be open and the items must be placed.

### Method
POST

### Endpoint
/websites/onlybot_store_doc/craft_ready

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{
  "message": "Initiate crafting process"
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation.
- **message** (string) - A confirmation message.

#### Response Example
```json
{
  "status": "success",
  "message": "Crafting process initiated successfully."
}
```

### Example Usage (Lua)
```lua
-- Complete crafting sequence
craft_Open(456)
global_Delay(2000)
craft_PutItem(12345, 10)
craft_PutItem(67890, 5)
global_Delay(1000)
craft_Quantity(5)
global_Delay(1000)
craft_Ready()
global_Delay(5000) -- Wait for craft completion
craft_Close()
```
```

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

### Lua: Deprecated character_Fight() Function Example

Source: https://onlybot.store/doc/character/character_Fight

This Lua code demonstrates the usage of the deprecated character_Fight() function. It also shows how to use the recommended global_CountFight() to get the fight count and log it. This function is marked as deprecated and should not be used in new code.

```Lua
function example_characterfight()     -- Ne pas utiliser, utiliser global_CountFight() à la place local fightCount = global_CountFight()     global_SendLogs("Combats : " .. fightCount, "Cyan") end -- Appeler la fonction example_characterfight()
```

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

### Get Fight Turn Count using Lua

Source: https://onlybot.store/doc/fight/fight_GetTurnCount

Retrieves the number of turns elapsed since the start of a fight. This function returns an integer representing the current turn count. It is useful for implementing logic based on the duration of a fight.

```lua
function example_fightgetturncount() -- Vérifier le nombre de tours local turnCount = fight_GetTurnCount() if turnCount > 10 then fight_SendLogs("Le combat dure depuis trop longtemps", "Orange") end end -- Appeler la fonction example_fightgetturncount()
```

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

### Initiate Exchange with Player - Lua

Source: https://onlybot.store/doc/exchange/exchange_Start

La fonction `exchange_Start` lance une demande d'échange avec un autre joueur spécifié par son ID. Elle envoie une requête au serveur pour initier le processus d'échange. Cette fonction ne retourne aucune valeur.

```lua
function example_exchangestart()
    -- Démarrer un échange avec un joueur
    exchange_Start("123456789")
    global_Delay(2000) -- Attendre la réponse
end
-- Appeler la fonction example_exchangestart()
```

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

### Get Total HDV Slots - Lua

Source: https://onlybot.store/doc/sale/sale_SlotsTotal

Retrieves the total number of available Auction House (HDV) slots. This function returns an integer representing the maximum capacity and takes no parameters. Example demonstrates calling the function and logging the result.

```lua
function example_saleslotstotal()     -- Vérifier la capacité totale local total = sale_SlotsTotal()     global_SendLogs("Capacité totale : " .. total, "Cyan") end -- Appeler la fonction example_saleslotstotal()
```

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

### Get Current Date in French Format (DD/MM/YYYY)

Source: https://onlybot.store/doc/global/global_Date

This function retrieves the current date formatted as DD/MM/YYYY, suitable for French locale. It takes no arguments and returns a string. The example shows how to call the function, send logs with the date, and perform conditional checks based on the date.

```lua
function example_globaldate()     -- Obtenir la date local date = global_Date()     global_SendLogs("Date : " .. date, "Cyan")      -- Vérifier si c'est un jour spécifique if date == "25/12/2024" then global_SendLogs("Joyeux Noël !", "Green")     end end -- Appeler la fonction example_globaldate()
```

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

### Get Strongest Enemy Cell ID - Lua Example

Source: https://onlybot.store/doc/fight/fight_GetStrongestEnemyCell

This Lua code snippet demonstrates how to use the fight_GetStrongestEnemyCell() function to identify the strongest enemy cell and cast a spell on it. It checks if an enemy is found before attempting to cast the spell. The function returns an integer representing the enemy cell ID, or 0 if no enemy is present.

```lua
function example_fightgetstrongestenemycell() 
    -- Cibler l'ennemi le plus fort en priorité 
    local strongestEnemy = fight_GetStrongestEnemyCell()
    if strongestEnemy > 0 then 
        fight_CastSpell("Sort Puissant", strongestEnemy)
    end 
end 

-- Appeler la fonction example_fightgetstrongestenemycell()
```

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

### Get Farthest Enemy Cell ID (Lua)

Source: https://onlybot.store/doc/fight/fight_GetFarthestEnemyCell

Retrieves the ID of the farthest enemy cell. Returns 0 if no enemies are found. This function is useful for strategic movement, such as moving towards the farthest enemy.

```lua
function example_fightgetfarthestenemycell()     -- S'éloigner de l'ennemi le plus proche en se rapprochant du plus loin local farthestEnemy = fight_GetFarthestEnemyCell()     if farthestEnemy > 0 then fight_MoveToCell(farthestEnemy)     end end -- Appeler la fonction example_fightgetfarthestenemycell()
```

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

### OnlyBot Core Configuration Structure

Source: https://onlybot.store/doc/structure-de-base

Illustrates the essential configuration structure for OnlyBot, defining constants for resource gathering, pod limits, monster aggregation, and specific monster lists. It also outlines the structure for the 'move' and 'bank' functions.

```lua
ELEMENTS_TO_GATHER = {254} -- Id des ressources que tu va récolter
MAX_PODS = 90 -- Pourcentage de pods maximal avant le dépôt en banque
MIN_MONSTERS = 1 -- Définis le nombre minimal de mobs à aggro
MAX_MONSTERS = 8 -- Définis le nombre maximal de mobs à aggro
OK_MONSTER = {651} -- Liste des monstres obligatoire pour lancer le combat
NO_MONSTER = {652} -- Liste des monstres à éviter pour lancer le combat

function move() 
    return { 
        -- Les déplacements, récoltes, combats 
    }
end 

function bank()
    return {
        -- Le retour en banque lorsque le personnage est en surpoids
    }
end
```

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

### Open Crafting Interface

Source: https://onlybot.store/doc/craft/index

Opens the crafting interface using a specific resource. The character will automatically move to the resource if needed.

```APIDOC
## craft_Open(cellid)

### Description
Opens the crafting interface using a specific resource. The character will automatically move to the resource if needed.

### Method
CALL (or a relevant method for function calls)

### Endpoint
N/A (Function Call)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **cellid** (number) - Required - The identifier of the crafting resource cell.

### Request Example
```json
{
  "function": "craft_Open",
  "arguments": {
    "cellid": 123
  }
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the operation was successful.

#### Response Example
```json
{
  "success": true
}
```
```

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

### 🛒 buy_BuyItem(gid, lots)

Source: https://onlybot.store/doc/buy/buy_BuyItem

Purchases a specified quantity of an item from the in-game market (HDV) by automatically finding the best available price and confirming the transaction.

```APIDOC
## POST /api/buy/buyitem

### Description
Buys an item from the in-game market (HDV). The function automatically searches for the best available price and completes the purchase. The purchase is automatically confirmed.

### Method
POST

### Endpoint
/api/buy/buyitem

### Parameters
#### Query Parameters
- **gid** (int) - Required - The GID (Game Item ID) of the item to buy.
- **lots** (int) - Required - The lot (quantity) of the item to buy.

### Request Example
```json
{
  "gid": 12345,
  "lots": 10
}
```

### Response
#### Success Response (200)
This endpoint does not return a value upon successful execution.

#### Response Example
```json
{
  "message": "Item purchased successfully"
}
```
```

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

### Map - Get Current Map ID

Source: https://onlybot.store/doc/map/index

Retrieves the ID of the map the character is currently on.

```APIDOC
## map_CurrentMapId ()

### Description
Retrieves the ID of the map the character is currently on.

### Method
GET

### Endpoint
/map/currentMapId

### Parameters
None

### Request Example
```json
{
  "function": "map_CurrentMapId"
}
```

### Response
#### Success Response (200)
- **mapId** (integer) - The ID of the current map.

#### Response Example
```json
{
  "mapId": 12345
}
```
```

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

### Get Used HDV Slots

Source: https://onlybot.store/doc/sale/index

Retrieves the number of HDV slots currently being used by the player.

```APIDOC
## sale_SlotsUsed(())

### Description
Retrieves the number of HDV slots currently used.

### Method
N/A (Function Call)

### Endpoint
N/A (Function Call)

### Parameters
None

### Request Example
```
call sale_SlotsUsed()
```

### Response
#### Success Response (200)
- **usedSlots** (integer) - The number of used HDV slots.

#### Response Example
```json
{
  "usedSlots": 5
}
```
```

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

### Get Current Inventory Pods

Source: https://onlybot.store/doc/inventory/inventory_CurrentPods

Retrieves the current weight of the inventory in pods.

```APIDOC
## GET /inventory/current_pods

### Description
Retrieves the current weight of the inventory in pods.

### Method
GET

### Endpoint
/inventory/current_pods

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **weight** (int) - The current weight of the inventory in pods. Returns -1 in case of an error.

#### Response Example
```json
{
  "weight": 150
}
```
```

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

### fight_GetLife() - Get Character Life

Source: https://onlybot.store/doc/fight/fight_GetLife

Retrieves the current life points of the character.

```APIDOC
## fight_GetLife()

### Description
Retrieves the current life points of the character.

### Method
GET

### Endpoint
/fight/life

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **life** (int) - The current life points of the character.

#### Response Example
{
  "life": 100
}

### Example Usage (Lua)
```lua
function example_fightgetlife()
    -- Vérifier la vie
    local life = fight_GetLife()
    local maxLife = fight_GetMaxLife()
    local percentLife = (life / maxLife) * 100

    if percentLife < 30 then
        fight_SendLogs("Je suis en danger ! (" .. life .. "/" .. maxLife .. ")", "Red")
        -- Utiliser un sort de soin
        fight_CastSpell("Soin", fight_GetMyCell())
    end
end

-- Appeler la fonction example_fightgetlife()
```
```

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

### GET /fight/fighter/pa

Source: https://onlybot.store/doc/fight/fight_GetFighterPA

Retrieves the current Action Points (PA) for a specific fighter.

```APIDOC
## GET /fight/fighter/pa

### Description
Retrieves the current Action Points (PA) for a specific fighter.

### Method
GET

### Endpoint
`/fight/fighter/pa`

### Parameters
#### Query Parameters
- **fighterId** (string) - Required - The ID of the fighter whose PA you want to retrieve.

### Request Example
```json
{
  "fighterId": "11111"
}
```

### Response
#### Success Response (200)
- **PA** (integer) - The number of PA the fighter has (0 if the fighter is not found).

#### Response Example
```json
{
  "PA": 10
}
```
```

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

### Récupérer le nombre de kamas stockés avec storage_CountKamas()

Source: https://onlybot.store/doc/storage/storage_CountKamas

La fonction storage_CountKamas() récupère le nombre total de kamas actuellement stockés dans la banque. Elle ne prend aucun paramètre et retourne un entier représentant le nombre de kamas. L'exemple montre comment vérifier et éventuellement récupérer des kamas en fonction de la quantité stockée.

```lua
function example_storagecountkamas()     -- Vérifier les kamas en stockage local kamas = storage_CountKamas()     global_SendLogs("Kamas en stockage : " .. kamas, "Cyan")      -- Récupérer les kamas si nécessaire if kamas > 10000 then storage_GetKamas(5000) -- Récupérer 5000 kamas end end -- Appeler la fonction example_storagecountkamas()
```

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

### Get Total HDV Slots

Source: https://onlybot.store/doc/sale/index

Retrieves the maximum total number of HDV slots available to the player.

```APIDOC
## sale_SlotsTotal(())

### Description
Retrieves the total number of HDV slots available (maximum capacity).

### Method
N/A (Function Call)

### Endpoint
N/A (Function Call)

### Parameters
None

### Request Example
```
call sale_SlotsTotal()
```

### Response
#### Success Response (200)
- **totalSlots** (integer) - The total number of available HDV slots.

#### Response Example
```json
{
  "totalSlots": 20
}
```
```

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

### 🛒 buy_ItemFromNpc

Source: https://onlybot.store/doc/buy/index

Buys an item from a vendor NPC. The NPC must be open before calling this function.

```APIDOC
## buy_ItemFromNpc(gid, quantity)

### Description
Buys an item from a vendor NPC. The NPC must be open before calling this function.

### Method
Buy

### Endpoint
N/A (Client-side function)

### Parameters
#### Path Parameters
- **gid** (number) - Required - The global ID of the item to buy.
- **quantity** (number) - Required - The number of items to buy.

### Request Example
```
call buy_ItemFromNpc(9876, 2)
```

### Response
#### Success Response
Item purchased successfully from the NPC.

#### Response Example
N/A
```

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

### Map - Get Current Position

Source: https://onlybot.store/doc/map/index

Retrieves the character's current position on the map in 'x,y' format.

```APIDOC
## map_CurrentPos ()

### Description
Retrieves the character's current position on the map in 'x,y' format.

### Method
GET

### Endpoint
/map/currentPos

### Parameters
None

### Request Example
```json
{
  "function": "map_CurrentPos"
}
```

### Response
#### Success Response (200)
- **position** (string) - The character's current position in 'x,y' format.

#### Response Example
```json
{
  "position": "10,25"
}
```
```

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

### Place Item in Crafting Interface

Source: https://onlybot.store/doc/craft/index

Places an item into the crafting interface. The interface must be open before calling this function.

```APIDOC
## craft_PutItem(gid, quantity)

### Description
Places an item into the crafting interface. The interface must be open before calling this function.

### Method
CALL (or a relevant method for function calls)

### Endpoint
N/A (Function Call)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **gid** (number) - Required - The unique identifier of the item to place.
- **quantity** (number) - Required - The quantity of the item to place.

### Request Example
```json
{
  "function": "craft_PutItem",
  "arguments": {
    "gid": 456,
    "quantity": 2
  }
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the operation was successful.

#### Response Example
```json
{
  "success": true
}
```
```

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

### fight_GetPO() - Get Player Order

Source: https://onlybot.store/doc/fight/fight_GetPO

Retrieves the current Player Order (PO) of the character.

```APIDOC
## fight_GetPO()

### Description
Retrieves the current Player Order (PO) of the character.

### Method
GET

### Endpoint
/websites/onlybot_store_doc/fight/GetPO

### Parameters
#### Path Parameters
None

#### Query Parameters
None

### Request Example
```json
{
  "description": "No request body needed for this operation."
}
```

### Response
#### Success Response (200)
- **PO** (int) - The current Player Order.

#### Response Example
```json
{
  "PO": 5
}
```
```

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

### Open House with map_OpenHouse (Lua)

Source: https://onlybot.store/doc/map/map_OpenHouse

Demonstrates how to use the map_OpenHouse function to open a house. This function requires the cell ID of the door, the specific instance ID of the house, the element ID of the door, and the UID of the skill instance. A delay is included after opening the house.

```lua
function example_mapopenhouse()     -- Ouvrir une maison map_OpenHouse(456, 12345, 67890, 11111)     global_Delay(2000) end -- Appeler la fonction example_mapopenhouse()
```

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

### fight_GetTurnCount()

Source: https://onlybot.store/doc/fight/fight_GetTurnCount

Retrieves the number of turns elapsed since the start of the combat.

```APIDOC
## fight_GetTurnCount()

### Description
Retrieves the number of turns elapsed since the start of the combat.

### Method
GET

### Endpoint
/websites/onlybot_store_doc/fight/GetTurnCount

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **turnCount** (int) - The number of turns elapsed.

#### Response Example
```json
{
  "turnCount": 5
}
```
```

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

### 🛒 buy_ItemFromNpc

Source: https://onlybot.store/doc/buy/buy_ItemFromNpc

Buys an item from an NPC vendor. The NPC must be opened before calling this function.

```APIDOC
## POST /websites/onlybot_store_doc/buy_ItemFromNpc

### Description
Buys an item from an NPC vendor. The NPC must be opened before calling this function.

### Method
POST

### Endpoint
/websites/onlybot_store_doc/buy_ItemFromNpc

### Parameters
#### Query Parameters
- **gid** (int) - Required - The GID of the item to buy
- **quantity** (int) - Required - The quantity to buy

### Request Body
This endpoint does not require a request body.

### Response
#### Success Response (200)
This endpoint does not return any specific data upon success.

#### Response Example
(No specific response body is defined for success.)

### Example
```lua
function example_buyitemfromnpc()     -- Open an NPC and buy
    npc_OpenVendor(12345, 987654, 3)
    global_Delay(2000)
    buy_ItemFromNpc(67890, 10)
    global_Delay(1000)
end
-- Call the function example_buyitemfromnpc()
```
```

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

### Craft Open

Source: https://onlybot.store/doc/craft/craft_Open

Opens the crafting interface using a specific resource. The character will automatically move to the resource if needed.

```APIDOC
## POST /craft/open

### Description
Opens the crafting interface using a specific resource. The character will automatically move to the resource if needed.

### Method
POST

### Endpoint
/craft/open

### Parameters
#### Query Parameters
- **cellid** (int) - Required - The ID of the cell where the crafting resource is located.

### Request Body
None

### Response
#### Success Response (200)
- **status** (string) - Indicates success or failure of the operation.

#### Response Example
```json
{
  "status": "success"
}
```

### Example Usage
```lua
function example_craftopen()
  -- Open the crafting interface
  craft_Open(456)
  global_Delay(2000) 

  -- Place items in the craft
  craft_PutItem(12345, 10)
  craft_PutItem(67890, 5)
  global_Delay(1000)
end

-- Call the example function
example_craftopen()
```
```

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

### Get Stored Kamas Count

Source: https://onlybot.store/doc/storage/storage_CountKamas

Retrieves the current number of kamas stored in the bank.

```APIDOC
## GET /storage/kamas/count

### Description
Retrieves the current number of kamas stored in the bank.

### Method
GET

### Endpoint
/storage/kamas/count

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **kamas_count** (integer) - The number of kamas currently in storage.

#### Response Example
```json
{
  "kamas_count": 15000
}
```
```

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

### Sélectionner une réponse de PNJ (NPC)

Source: https://onlybot.store/doc/npc/index

Choisit une réponse parmi les options disponibles dans un dialogue de PNJ. Cette fonction doit impérativement être appelée après `npc_Speak()` lorsque le dialogue est actif.

```NPC
npc_Reply(reply)
```

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

### Get Spell AP Cost

Source: https://onlybot.store/doc/fight/fight_GetSpellAPCost

Retrieves the Action Point cost of a spell. This is an alias for fight_GetSpellCost.

```APIDOC
## GET /fight/spells/{spellName}/apcost

### Description
Retrieves the Action Point cost of a spell.

### Method
GET

### Endpoint
`/fight/spells/{spellName}/apcost`

### Parameters
#### Path Parameters
- **spellName** (string) - Required - The name of the spell

### Response
#### Success Response (200)
- **apCost** (integer) - The AP cost of the spell (0 if the spell is not found)

#### Response Example
```json
{
  "apCost": 10
}
```

### Example Usage
```lua
-- Check the AP cost of a spell
local cost = fight_GetSpellAPCost("Météore")
if fight_GetPA() >= cost then
  fight_CastSpell("Météore", enemyCell)
end
```
```

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

### Map - Get Current Position

Source: https://onlybot.store/doc/map/map_CurrentPos

Retrieves the current character's position on the map in 'x,y' format.

```APIDOC
## GET /map/current_position

### Description
Retrieves the current character's position on the map.

### Method
GET

### Endpoint
/map/current_position

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **position** (string) - The current position in 'x,y' format.

#### Response Example
{
  "position": "123,456"
}
```

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

### GET /character/energyPoints

Source: https://onlybot.store/doc/character/character_EnergyPoints

Retrieves the current energy points for the character. The value is an absolute number, with a maximum of 10000.

```APIDOC
## GET /character/energyPoints

### Description
Retrieves the current energy points for the character. The value is an absolute number, with a maximum of 10000.

### Method
GET

### Endpoint
/character/energyPoints

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **energyPoints** (integer) - The current energy points of the character. Returns -1 in case of an error.

#### Response Example
```json
{
  "energyPoints": 5000
}
```
```

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

### 🛒 buy_NPC

Source: https://onlybot.store/doc/buy/index

Automatically opens the auction house NPC for the current map. The function automatically detects the map and opens the correct NPC.

```APIDOC
## buy_NPC

### Description
Automatically opens the auction house NPC for the current map. The function automatically detects the map and opens the correct NPC.

### Method
Buy

### Endpoint
N/A (Client-side function)

### Parameters
None

### Request Example
```
call buy_NPC()
```

### Response
#### Success Response
Opens the relevant NPC interface.

#### Response Example
N/A
```
Tokens:
Raw