TazUO Legion

https://tazuo.org/legion/
Admin
TazUO Legion is a scripting system for Ultima Online that provides a Python API for automation,...
Tokens:58,579
Snippets:349
Trust Score:4.7
Update:1 year ago
Show doc for...
Tokens:
Raw
### Automatic Targeting Setup (Python)

Source: https://context7.com/context7/tazuo_legion/llms.txt

This example shows how to set up pre-targeting for automatic application of spells or item uses. It demonstrates pre-targeting the player for a beneficial effect using bandages and pre-targeting an enemy for a harmful spell like 'Lightning'.

```python
# Set up pre-target for automatic application
bandage = API.FindType(0x0E21, API.Backpack)
if bandage:
    API.PreTarget(API.Player.Serial, "beneficial")
    API.UseObject(bandage)  # Automatically targets self
    API.Pause(8)

# Pre-target enemy for offensive spell
enemy = API.NearestMobile([API.Notoriety.Criminal], 10)
if enemy:
    API.PreTarget(enemy.Serial, "harmful")
    API.CastSpell("Lightning")  # Automatically targets enemy
```

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

### Pathfinding to Location (Python)

Source: https://context7.com/context7/tazuo_legion/llms.txt

This script shows how to use the `Pathfind` function to navigate the character to specific coordinates. It includes an example of pathfinding with waiting for arrival and another example where pathfinding is initiated without waiting, requiring a loop to check the `Pathfinding` status.

```python
# Pathfind to specific coordinates
success = API.Pathfind(1443, 1700, distance=1, wait=True, timeout=30)
if success:
    API.SysMsg("Arrived at destination")
else:
    API.SysMsg("Pathfinding failed")

# Pathfind without waiting
API.Pathfind(1500, 1500, wait=False)
while API.Pathfinding():
    API.Pause(0.25)
```

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

### Basic Movement Commands (Python)

Source: https://context7.com/context7/tazuo_legion/llms.txt

This section provides examples of basic character movement. It demonstrates using `Walk` for standard movement in cardinal directions, `Run` for faster diagonal movement, and `Turn` to change facing direction without moving.

```python
# Basic movement
API.Walk("north")
API.Pause(0.5)
API.Run("northeast")

# Turn without moving
API.Turn("south")
```

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

### Game State and Information API

Source: https://tazuo.org/legion/api

Functions to check game state, retrieve map information, and get item details.

```APIDOC
## GET /api/HasTarget

### Description
Checks if the player currently has a target cursor active.

### Method
GET

### Endpoint
/api/HasTarget

### Parameters
#### Path Parameters
- None

#### Query Parameters
- `targetType` (string) - Optional - Specifies the type of target to check for (e.g., "neutral", "harmful", "beneficial", "any", "harm", "ben").

#### Request Body
- None

### Request Example
```python
if API.HasTarget():
    API.CancelTarget()
```

### Response
#### Success Response (200)
- **result** (bool) - Returns `true` if the player has a target cursor, `false` otherwise.
```

```APIDOC
## GET /api/GetMap

### Description
Retrieves the index of the current map the player is on.

### Method
GET

### Endpoint
/api/GetMap

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- None

### Request Example
```python
current_map = API.GetMap()
# Standard maps are: 0 = Fel, 1 = Tram, 2 = Ilshenar, 3 = Malas, 4 = Tokuno, 5 = TerMur
```

### Response
#### Success Response (200)
- **result** (int) - The index of the current map. (0 = Fel, 1 = Tram, 2 = Ilshenar, 3 = Malas, 4 = Tokuno, 5 = TerMur)
```

```APIDOC
## GET /api/ItemNameAndProps

### Description
Retrieves the name and properties of an item, returning them as a single string.

### Method
GET

### Endpoint
/api/ItemNameAndProps

### Parameters
#### Path Parameters
- None

#### Query Parameters
- `serial` (uint) - Required - The serial number of the item.
- `wait` (bool) - Optional - If `true`, waits for the name and properties to be available.
- `timeout` (int) - Optional - The timeout duration in seconds.

#### Request Body
- None

### Request Example
```python
data = API.ItemNameAndProps(0x12345678, True)
if data:
  API.SysMsg("Item data: " + data)
  if "An Exotic Fish" in data:
    API.SysMsg("Found an exotic fish!")
```

### Response
#### Success Response (200)
- **result** (string) - A string containing the item's name and properties, separated by newlines. Returns an empty string if the item is not found or data is unavailable.
```

```APIDOC
## POST /api/RequestOPLData

### Description
Requests Object Property List (OPL) data for specified item serials. If the data doesn't exist, it will be requested from the server.

### Method
POST

### Endpoint
/api/RequestOPLData

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- `serials` (IList<uint>) - Required - A list of object serials to request OPL data for.

### Request Example
```python
items_to_request = [0x12345678, 0x87654321]
API.RequestOPLData(items_to_request)
```

### Response
#### Success Response (200)
- **None** (void) - This function does not return any value.
```

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

### Get Tile and Statics API

Source: https://tazuo.org/legion/api

Retrieve information about tiles and static objects at specific map coordinates.

```APIDOC
## GET /api/map/tile

### Description
Get the tile at a specific location (x, y coordinates).

### Method
GET

### Endpoint
`/api/map/tile`

### Parameters
#### Query Parameters
- **x** (int) - Required - The X coordinate.
- **y** (int) - Required - The Y coordinate.

### Request Example
```
GET /api/map/tile?x=1414&y=1515
```

### Response
#### Success Response (200)
- **graphic** (ushort) - The graphic ID of the tile.
- **x** (int) - The X coordinate of the tile.
- **y** (int) - The Y coordinate of the tile.

#### Response Example
```json
{
  "graphic": 1234,
  "x": 1414,
  "y": 1515
}
```
```

```APIDOC
## GET /api/map/statics

### Description
Gets all static objects at a specific position (x, y coordinates). This includes trees, vegetation, buildings, and other non-movable scenery.

### Method
GET

### Endpoint
`/api/map/statics`

### Parameters
#### Query Parameters
- **x** (int) - Required - The X coordinate.
- **y** (int) - Required - The Y coordinate.

### Request Example
```
GET /api/map/statics?x=1000&y=1000
```

### Response
#### Success Response (200)
- **statics** (array) - A list of static objects found at the location.
  - Each static object contains:
    - **graphic** (ushort) - The graphic ID of the static object.
    - **x** (int) - The X coordinate of the static object.
    - **y** (int) - The Y coordinate of the static object.
    - **z** (int) - The Z coordinate (height) of the static object.

#### Response Example
```json
{
  "statics": [
    {
      "graphic": 5678,
      "x": 1000,
      "y": 1000,
      "z": 10
    },
    {
      "graphic": 9012,
      "x": 1000,
      "y": 1000,
      "z": 12
    }
  ]
}
```
```

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

### Use Object using API.UseObject

Source: https://tazuo.org/legion/api

Attempts to use (double-click) an object. It takes the object's serial and an optional `skipQueue` boolean parameter. Returns void. The example shows using the backpack.

```python
API.UseObject(API.Backpack)
```

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

### Click Object using API.ClickObject

Source: https://tazuo.org/legion/api

Performs a single click action on a specified object. It requires the object's serial as input and returns void. The example demonstrates clicking on the player object itself.

```python
API.ClickObject(API.Player)
```

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

### Cast Spell with Targeting (Python)

Source: https://context7.com/context7/tazuo_legion/llms.txt

This example illustrates casting a spell ('Lightning') and then targeting an enemy found nearby. It includes `WaitForTarget` to ensure the targeting system is ready and `Target` to select the enemy. It also shows targeting a specific tile coordinate with 'Earthquake'.

```python
# Cast spell with targeting
API.CastSpell("Lightning")
if API.WaitForTarget(timeout=5):
    enemy = API.NearestMobile([API.Notoriety.Criminal], 10)
    if enemy:
        API.Target(enemy)
    else:
        API.CancelTarget()

# Target specific location
API.CastSpell("Earthquake")
if API.WaitForTarget():
    API.Target(1443, 1700, 0)
```

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

### Equip Item using API.EquipItem

Source: https://tazuo.org/legion/api

Attempts to equip an item, automatically detecting the correct layer (e.g., left hand, right hand). It requires the item's serial and returns void. The example first clears the left hand and then attempts to equip the item.

```python
lefthand = API.ClearLeftHand()
API.Pause(2)
API.EquipItem(lefthand)
```

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

### Advanced Mobile Filtering (Python)

Source: https://context7.com/context7/tazuo_legion/llms.txt

This example demonstrates advanced filtering of mobiles using `GetAllMobiles`. It shows how to retrieve all mobiles, filter by graphic ID and distance, and filter by notoriety types within a specified range.

```python
# Get all mobiles
all_mobs = API.GetAllMobiles()
API.SysMsg(f"Total mobiles: {len(all_mobs)}")

# Filter by graphic (400 = human male)
humans = API.GetAllMobiles(graphic=400, distance=20)

# Filter by notoriety
enemies = API.GetAllMobiles(
    distance=15,
    notoriety=[API.Notoriety.Murderer, API.Notoriety.Criminal]
)
```

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

### Send Context Menu Response using API.ContextMenu

Source: https://tazuo.org/legion/api

Sends a response to an object's context menu (right-click menu). It takes the object's serial and the menu entry index. This function handles both opening and responding to the menu in one action and returns void. The example shows interacting with the player's context menu.

```python
API.ContextMenu(API.Player, 1)
```

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

### Queue Item Movement using API.QueueMoveItem

Source: https://tazuo.org/legion/api

Queues an item to be moved from one container to another. It requires the item's serial and destination serial, with optional parameters for amount, x, and y coordinates. Returns void. The example shows moving specific fish items to a targeted barrel.

```python
items = API.ItemsInContainer(API.Backpack)

API.SysMsg("Target your fish barrel", 32)
barrel = API.RequestTarget()


if len(items) > 0 and barrel:
    for item in items:
        data = API.ItemNameAndProps(item)
        if data and "An Exotic Fish" in data:
            API.QueueMoveItem(item, barrel)
```

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

### Python API Usage

Source: https://tazuo.org/legion/api

Explains how to use the Python API, including the need to preface commands with 'API.' and how to import the API.py file for autocomplete.

```APIDOC
## Python API Usage

### Description
All methods, properties, enums, etc., need to be prefaced with `API.` For example: `API.Msg("An example")`.

If you download the `API.py` file, put it in the same folder as your Python scripts and add `import API` to your script. This will enable some mild form of autocomplete in an editor like VS Code.
You can now type `-updateapi` in-game to download the latest `API.py` file.

_This was generated on `10/13/25`._
```

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

### Get Container Contents Count using API.Contents

Source: https://tazuo.org/legion/api

Retrieves the count of items within a container. It requires the container's serial and returns an integer representing the item count. The example displays the number of items in the backpack.

```python
count = API.Contents(API.Backpack)
if count > 0:
  API.SysMsg(f"You have {count} items in your backpack")
```

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

### Get All Mobiles API

Source: https://tazuo.org/legion/api

Retrieve a list of all mobiles known to the client, with optional filtering by graphic, distance, and notoriety.

```APIDOC
## GET /api/mobiles

### Description
Return a list of all mobiles the client is aware of, optionally filtered by graphic, distance, and/or notoriety.

### Method
GET

### Endpoint
`/api/mobiles`

### Parameters
#### Query Parameters
- **graphic** (ushort) - Optional - The graphic ID to filter by.
- **distance** (int) - Optional - The maximum distance from the player.
- **notoriety** (IList<Notoriety>) - Optional - A list of notoriety flags to filter by.

### Request Example
```
GET /api/mobiles?graphic=400&distance=5
GET /api/mobiles?distance=15&notoriety=Murderer,Criminal
```

### Response
#### Success Response (200)
- **mobiles** (array) - A list of mobile objects matching the criteria.
  - Each mobile object contains:
    - **serial** (uint) - The serial number of the mobile.
    - **name** (string) - The name of the mobile.
    - **distance** (int) - The distance to the mobile.

#### Response Example
```json
{
  "mobiles": [
    {
      "serial": "0x12345678",
      "name": "Orc",
      "distance": 4
    },
    {
      "serial": "0x87654321",
      "name": "Goblin",
      "distance": 6
    }
  ]
}
```
```

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

### Create and Display a Basic Gump in Python

Source: https://context7.com/context7/tazuo_legion/llms.txt

Demonstrates the creation of a basic graphical user interface (Gump) element. This includes setting its dimensions and position, adding a colored background, and placing a text label. The Gump is configured to accept mouse input and can be moved.

```python
# Create a basic gump
gump = API.CreateGump(acceptMouseInput=True, canMove=True)
gump.SetRect(100, 100, 300, 200)

# Center in viewport
gump.CenterXInViewPort()
gump.CenterYInViewPort()

# Add background
bg = API.CreateGumpColorBox(0.8, "#000000")
bg.SetRect(0, 0, 300, 200)
gump.Add(bg)

# Add label
label = API.CreateGumpLabel("Hello World!", hue=53)
label.SetPos(10, 10)
gump.Add(label)

# Display gump
API.AddGump(gump)
```

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

### CreateSimpleButton

Source: https://tazuo.org/legion/api

Creates a simple button for Gumps without using graphics.

```APIDOC
## CreateSimpleButton

### Description
Creates a simple button, does not use graphics.

### Method
(Implicitly a function call in the context of the API)

### Endpoint
N/A (Function within a script)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
*   **text** (string) - Required - The text displayed on the button.
*   **width** (int) - Required - The width of the button.
*   **height** (int) - Required - The height of the button.

### Request Example
```python
g = API.CreateGump()
g.SetRect(100, 100, 200, 200)
button = API.CreateSimpleButton("Click Me!", 100, 20)
g.Add(button)
API.AddGump(g)
```

### Response
#### Success Response (200)
*   **NiceButton** (Object) - The created simple button object.

#### Response Example
```json
{
  "type": "NiceButton",
  "text": "Click Me!",
  "width": 100,
  "height": 20
}
```
```

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

### ToggleScript API

Source: https://tazuo.org/legion/api

Toggles the execution state of another script. This function can be used to start or stop other scripts dynamically.

```APIDOC
## ToggleScript

### Description
Toggle another script on or off. This function allows for dynamic control over the execution of other scripts.

### Method
ToggleScript

### Parameters
#### Path Parameters
- **scriptName** (string) - Required - The full name of the script to toggle, including its extension (.py or .lscript).

### Request Example
```python
API.ToggleScript("MyScript.py")
```

### Response
#### Success Response (200)
- **void** - Does not return any value.
```

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

### Create and Display a Basic Gump (Python)

Source: https://tazuo.org/legion/api

Creates a basic graphical user interface (Gump) window. You can set its dimensions and add elements like text labels. The gump can be configured to accept mouse input, be movable, and control its persistence. It returns a PyBaseGump object.

```python
g = API.CreateGump()
g.SetRect(100, 100, 200, 200)
g.Add(API.CreateGumpLabel("Hello World!"))
API.AddGump(g)
```

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

### Play Legion Script (Python)

Source: https://tazuo.org/legion/api

Initiates the execution of a specified Legion script. The scriptName parameter must be the exact file name, including its extension.

```Python
API.PlayScript("MyScript.py")
```

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

### Get All Open Gumps - Python

Source: https://tazuo.org/legion/api

Retrieves a list of all currently open server-side gumps. The function returns a PythonList containing Gump objects.

```python
API.GetAllGumps()
```

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

### PyBaseControl Methods

Source: https://tazuo.org/legion/pybasecontrol

This section details the various methods available in the PyBaseControl class for managing UI elements.

```APIDOC
## PyBaseControl - Add Method

### Description
Adds a child control to this control. This method can also be used with gumps (e.g., `gump.Add(control)`).

### Method
`Add`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **childControl** (object) - Required - The control to add as a child.

### Request Example
```json
{
  "childControl": { /* control object */ }
}
```

### Response
#### Success Response (200)
- **None** (void) - This method does not return any value.

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

---

## PyBaseControl - GetX Method

### Description
Returns the control's X position.

### Method
`GetX`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
null
```

### Response
#### Success Response (200)
- **X position** (int) - The current X coordinate of the control.

#### Response Example
```json
{
  "x": 100
}
```

---

## PyBaseControl - GetY Method

### Description
Returns the control's Y position.

### Method
`GetY`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
null
```

### Response
#### Success Response (200)
- **Y position** (int) - The current Y coordinate of the control.

#### Response Example
```json
{
  "y": 50
}
```

---

## PyBaseControl - SetX Method

### Description
Sets the control's X position.

### Method
`SetX`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **x** (int) - Required - The new X coordinate.

### Request Example
```json
{
  "x": 120
}
```

### Response
#### Success Response (200)
- **None** (void) - This method does not return any value.

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

---

## PyBaseControl - SetY Method

### Description
Sets the control's Y position.

### Method
`SetY`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **y** (int) - Required - The new Y coordinate.

### Request Example
```json
{
  "y": 75
}
```

### Response
#### Success Response (200)
- **None** (void) - This method does not return any value.

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

---

## PyBaseControl - SetPos Method

### Description
Sets the control's X and Y positions.

### Method
`SetPos`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **x** (int) - Required - The new X coordinate.
- **y** (int) - Required - The new Y coordinate.

### Request Example
```json
{
  "x": 150,
  "y": 100
}
```

### Response
#### Success Response (200)
- **None** (void) - This method does not return any value.

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

---

## PyBaseControl - SetWidth Method

### Description
Sets the control's width.

### Method
`SetWidth`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **width** (int) - Required - The new width in pixels.

### Request Example
```json
{
  "width": 200
}
```

### Response
#### Success Response (200)
- **None** (void) - This method does not return any value.

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

---

## PyBaseControl - SetHeight Method

### Description
Sets the control's height.

### Method
`SetHeight`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **height** (int) - Required - The new height in pixels.

### Request Example
```json
{
  "height": 150
}
```

### Response
#### Success Response (200)
- **None** (void) - This method does not return any value.

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

---

## PyBaseControl - SetRect Method

### Description
Sets the control's position and size in one operation.

### Method
`SetRect`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **x** (int) - Required - The new X coordinate.
- **y** (int) - Required - The new Y coordinate.
- **width** (int) - Required - The new width in pixels.
- **height** (int) - Required - The new height in pixels.

### Request Example
```json
{
  "x": 100,
  "y": 50,
  "width": 250,
  "height": 180
}
```

### Response
#### Success Response (200)
- **None** (void) - This method does not return any value.

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

---

## PyBaseControl - CenterXInViewPort Method

### Description
Centers a GUMP horizontally in the viewport. This method only works on Gump instances.

### Method
`CenterXInViewPort`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
null
```

### Response
#### Success Response (200)
- **None** (void) - This method does not return any value.

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

---

## PyBaseControl - CenterYInViewPort Method

### Description
Centers a GUMP vertically in the viewport. This method only works on Gump instances.

### Method
`CenterYInViewPort`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
null
```

### Response
#### Success Response (200)
- **None** (void) - This method does not return any value.

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

---

## PyBaseControl - Dispose Method

### Description
Closes or destroys the control.

### Method
`Dispose`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
null
```

### Response
#### Success Response (200)
- **None** (void) - This method does not return any value.

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

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

### Get All Friend Serials (Python)

Source: https://tazuo.org/legion/api

Retrieves a list containing the serial numbers of all players currently in the friend list. This is useful for iterating through friends or performing actions on all of them.

```python
friends = API.GetAllFriends()
for friend in friends:
    API.FindMobile(friend)
```

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

### Check for Active Target

Source: https://tazuo.org/legion/api

Checks if the player currently has a target cursor active. The function API.HasTarget() returns a boolean. An example shows canceling the target if one exists.

```API
if API.HasTarget():
    API.CancelTarget()
```

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

### API Methods

Source: https://tazuo.org/legion/api

Describes the various methods available in the Python API.

```APIDOC
## Methods

### `ProcessCallbacks`
Use this when you need to wait for players to click buttons.

```python
while True:
  API.ProcessCallbacks()
  API.Pause(0.1)
```

**Return Type:** `void` _(Does not return anything)_

* * *

### `Dispose`
**Return Type:** `void` _(Does not return anything)_

* * * 

### `OnHotKey`
`(key, callback)` Register or unregister a Python callback for a hotkey.

#### Register:
```python
def on_shift_a():
    API.SysMsg("SHIFT+A pressed!")
API.OnHotKey("SHIFT+A", on_shift_a)
while True:
  API.ProcessCallbacks()
  API.Pause(0.1)
```

#### Unregister:
```python
API.OnHotKey("SHIFT+A")
```

The key can include modifiers (CTRL, SHIFT, ALT), for example: “CTRL+SHIFT+F1” or “ALT+A”.

**Parameters:**
| Name | Type | Optional | Description |
|---|---|---|---|
| `key` | `string` | ❌ No | Key combination to listen for, e.g. “CTRL+SHIFT+F1”. |
| `callback` | `object` | ✅ Yes | Python function to invoke when the hotkey is pressed. If <c>null</c> , the hotkey will be unregistered. |

**Return Type:** `void` _(Does not return anything)_

* * *

### `SetSharedVar`
`(name, value)` Set a variable that is shared between scripts.

```python
API.SetSharedVar("myVar", 10)
```

**Parameters:**
| Name | Type | Optional | Description |
|---|---|---|---|
| `name` | `string` | ❌ No | Name of the var |
| `value` | `object` | ❌ No | Value, can be a number, text, or _most_ other objects too. |

**Return Type:** `void` _(Does not return anything)_

* * *

### `GetSharedVar`
`(name)` Get the value of a shared variable.

```python
myVar = API.GetSharedVar("myVar")
if myVar:
 API.SysMsg(f"myVar is {myVar}")
```

**Parameters:**
| Name | Type | Optional | Description |
|---|---|---|---|
| `name` | `string` | ❌ No | Name of the var |

**Return Type:** `object`

* * *

### `RemoveSharedVar`
`(name)` Try to remove a shared variable.

```python
API.RemoveSharedVar("myVar")
```

**Parameters:**
| Name | Type | Optional | Description |
|---|---|---|---|
| `name` | `string` | ❌ No | Name of the var |

**Return Type:** `void` _(Does not return anything)_
```

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

### CreateGumpTextBox

Source: https://tazuo.org/legion/api

Creates a text area control for Gumps.

```APIDOC
## CreateGumpTextBox

### Description
Creates a text area control.

### Method
(Implicitly a function call in the context of the API)

### Endpoint
N/A (Function within a script)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
*   **text** (string) - Optional - The initial text in the text box.
*   **width** (int) - Optional - The width of the text box.
*   **height** (int) - Optional - The height of the text box.
*   **multiline** (bool) - Optional - Indicates if the text box supports multiple lines.

### Request Example
```python
w = 500
h = 600

gump = API.CreateGump(True, True)
gump.SetWidth(w)
gump.SetHeight(h)
gump.CenterXInViewPort()
gump.CenterYInViewPort()

bg = API.CreateGumpColorBox(0.7, "#D4202020")
bg.SetWidth(w)
bg.SetHeight(h)

gump.Add(bg)

textbox = API.CreateGumpTextBox("Text example", w, h, True)

gump.Add(textbox)

API.AddGump(gump)
```

### Response
#### Success Response (200)
*   **TTFTextInputField** (Object) - The created text box object.

#### Response Example
```json
{
  "type": "TTFTextInputField",
  "text": "Text example",
  "width": 500,
  "height": 600,
  "multiline": true
}
```
```

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

### Get Items on Ground - Python

Source: https://tazuo.org/legion/api

Retrieves all items present on the ground within a specified distance. Can optionally filter by item graphic type. Returns a list of items.

```python
items = API.GetItemsOnGround(10)  # All items within 10 tiles
if items:
  API.SysMsg("Found " + str(len(items)) + " items on ground!")
```

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

### Get Gump Object - Python

Source: https://tazuo.org/legion/api

Fetches a Gump object by its ID. If no ID is provided, it defaults to the last gump opened from the server. The function returns a Gump object, which can then be disposed of.

```python
gump = API.GetGump()
if gump:
  API.SysMsg("Found the gump!")
  gump.Dispose() #Close it
```

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

### ClientCommand API

Source: https://tazuo.org/legion/api

Executes a client command as if it were typed into the game console.

```APIDOC
## POST /api/client/command

### Description
Executes a client command as if typed in the game console.

### Method
POST

### Endpoint
/api/client/command

### Parameters
#### Request Body
- **command** (string) - Required - The command to execute, including any arguments.

### Request Example
```json
{
  "command": "stats"
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates if the command was executed.

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

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

### Get Item Name and Properties

Source: https://tazuo.org/legion/api

Retrieves the name and properties of an item based on its serial. It can optionally wait for the data and has a timeout. The result is a string that can be parsed. The function API.ItemNameAndProps() is used.

```API
data = API.ItemNameAndProps(0x12345678, True)
if data:
  API.SysMsg("Item data: " + data)
  if "An Exotic Fish" in data:
    API.SysMsg("Found an exotic fish!")
```

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

### GetAvailableDressOutfits API

Source: https://tazuo.org/legion/api

Retrieves a list of all available dress configurations that can be applied.

```APIDOC
## GET /api/player/available-dress-outfits

### Description
Get all available dress configurations.

### Method
GET

### Endpoint
/api/player/available-dress-outfits

### Parameters
None

### Request Example
```
GET /api/player/available-dress-outfits
```

### Response
#### Success Response (200)
- **outfits** (list[string]) - A list of names for available dress configurations.

#### Response Example
```json
{
  "outfits": ["PvP Gear", "Magic Set", "Training Clothes"]
}
```
```

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

### Get Items in Container - Python

Source: https://tazuo.org/legion/api

Fetches all items contained within a specified container. Can recursively search sub-containers if the 'recursive' parameter is set to true. Returns a list of PyItem objects.

```python
items = API.ItemsInContainer(API.Backpack)
if items:
  API.SysMsg("Found " + str(len(items)) + " items!")
  for item in items:
    API.SysMsg(item.Name)
    API.Pause(0.5)
```

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

### API Properties

Source: https://tazuo.org/legion/api

Lists and describes the available properties in the Python API.

```APIDOC
## Properties

### `JournalEntries`
**Type:** `ConcurrentQueue<PyJournalEntry>`

### `Backpack`
**Type:** `uint`
Get the player’s backpack serial.

### `Player`
**Type:** `PlayerMobile`
Returns the player character object.

### `Bank`
**Type:** `uint`
Return the player’s bank container serial if open, otherwise 0.

### `Random`
**Type:** `Random`
Can be used for random numbers. `API.Random.Next(1, 100)` will return a number between 1 and 100. `API.Random.Next(100)` will return a number between 0 and 100.

### `LastTargetSerial`
**Type:** `uint`
The serial of the last target, if it has a serial.

### `LastTargetPos`
**Type:** `Vector3Int`
The last target’s position.

### `LastTargetGraphic`
**Type:** `ushort`
The graphic of the last targeting object.

### `Found`
**Type:** `uint`
The serial of the last item or mobile from the various findtype/mobile methods.

### `PyProfile`
**Type:** `PyProfile`
Access useful player settings.

### `Events`
**Type:** `Events`

### `StopRequested`
**Type:** `bool`
Check if the script has been requested to stop.

```python
while not API.StopRequested:
  DoSomeStuff()
```

### `CancellationToken`
**Type:** `CancellationTokenSource`
```

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

### Create Simple Button in Python

Source: https://tazuo.org/legion/api

Creates a basic button for Gumps that does not rely on graphics. It requires text, width, and height. Returns a NiceButton object.

```python
g = API.CreateGump()
g.SetRect(100, 100, 200, 200)
button = API.CreateSimpleButton("Click Me!", 100, 20)
g.Add(button)
API.AddGump(g)
```

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

### Player Ability and Action API

Source: https://tazuo.org/legion/api

Endpoints for toggling player abilities, checking status, and performing basic actions.

```APIDOC
## POST /ToggleFly

### Description
Toggles the flying ability for gargoyles.

### Method
POST

### Endpoint
/ToggleFly

### Response
#### Success Response (200)
- **return_value** (void) - Does not return any value.

#### Response Example
```json
// No response body for void return type.
```

## POST /ToggleAbility

### Description
Toggles a specified player ability.

### Method
POST

### Endpoint
/ToggleAbility

### Parameters
#### Query Parameters
- **ability** (string) - Required - The ability to toggle. Accepts 'primary', 'secondary', 'stun', or 'disarm'.

### Response
#### Success Response (200)
- **return_value** (void) - Does not return any value.

#### Response Example
```json
// No response body for void return type.
```

## GET /PrimaryAbilityActive

### Description
Checks if the player's primary ability is currently active.

### Method
GET

### Endpoint
/PrimaryAbilityActive

### Response
#### Success Response (200)
- **return_value** (bool) - True if the primary ability is active, false otherwise.

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

## GET /SecondaryAbilityActive

### Description
Checks if the player's secondary ability is currently active.

### Method
GET

### Endpoint
/SecondaryAbilityActive

### Response
#### Success Response (200)
- **return_value** (bool) - True if the secondary ability is active, false otherwise.

#### Response Example
```json
{
  "return_value": false
}
```

## POST /Pause

### Description
Pauses the execution of the current script for a specified duration.

### Method
POST

### Endpoint
/Pause

### Parameters
#### Query Parameters
- **seconds** (double) - Required - The duration in seconds to pause (0-30).

### Response
#### Success Response (200)
- **return_value** (void) - Does not return any value.

#### Response Example
```json
// No response body for void return type.
```

## POST /Stop

### Description
Stops the execution of the current script.

### Method
POST

### Endpoint
/Stop

### Response
#### Success Response (200)
- **return_value** (void) - Does not return any value.

#### Response Example
```json
// No response body for void return type.
```

## POST /ToggleAutoLoot

### Description
Toggles the autolooting functionality on or off.

### Method
POST

### Endpoint
/ToggleAutoLoot

### Response
#### Success Response (200)
- **return_value** (void) - Does not return any value.

#### Response Example
```json
// No response body for void return type.
```

## POST /AutoLootContainer

### Description
Applies the autoloot functionality to a specific container.

### Method
POST

### Endpoint
/AutoLootContainer

### Parameters
#### Query Parameters
- **container** (uint) - Required - The identifier of the container to autoloot.

### Response
#### Success Response (200)
- **return_value** (void) - Does not return any value.

#### Response Example
```json
// No response body for void return type.
```
```

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

### Attack Mobile using API.Attack

Source: https://tazuo.org/legion/api

Initiates an attack on a specified mobile. It requires the serial of the target mobile as input and returns void. The example shows targeting the nearest gray or criminal mobile.

```python
enemy = API.NearestMobile([API.Notoriety.Gray, API.Notoriety.Criminal], 7)
if enemy:
  API.Attack(enemy)
```

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

### Create and Interact with Action Buttons

Source: https://context7.com/context7/tazuo_legion/llms.txt

Demonstrates how to create a simple save button, set its position, add it to a gump, and process click events. It also shows how to display messages based on button clicks and checkbox/radio button states. This requires the API and gump objects to be available.

```lua
save_btn = API.CreateSimpleButton("Save", 100, 30)
save_btn.SetPos(10, 180)
gump.Add(save_btn)

API.AddGump(gump)

while not API.StopRequested:
    API.ProcessCallbacks()
    if save_btn.HasBeenClicked():
        API.SysMsg(f"Settings saved. Text: {textbox.Text}")
        API.SysMsg(f"Checkbox: {cb.IsChecked}, Radio: {rb1.IsChecked}")
    API.Pause(0.1)
```

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

### Get Shared Variable - Python

Source: https://tazuo.org/legion/api

Retrieves the value of a shared variable previously set by SetSharedVar. If the variable exists, its value is returned; otherwise, it might return a falsy value (e.g., None).

```python
myVar = API.GetSharedVar("myVar")
if myVar:
 API.SysMsg(f"myVar is {myVar}")
```

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

### Create Modern Gump Window

Source: https://tazuo.org/legion/api

Initializes a modern nine-slice Gump window with customizable position, dimensions, and resizing behavior. It uses ModernUIConstants for styling and accepts optional minimum dimensions and a resize callback.

```lua
# Example usage:
# modernGump = API.CreateModernGump(50, 50, 300, 200, true, 100, 100)
# gump.Add(modernGump)

```

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

### ContextMenu API

Source: https://tazuo.org/legion/api

Sends a response to a context menu (right-click menu) for a given object. This function handles opening and selecting an entry in one action.

```APIDOC
## ContextMenu API

### Description
Sends a context menu response for an object and a specific entry.

### Method
API.ContextMenu(serial, entry)

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

### Parameters
#### Path Parameters
- **serial** (uint) - Required - The serial number of the object.
- **entry** (ushort) - Required - The index of the context menu entry to select (starts at 0 for the top entry).

### Request Example
```javascript
API.ContextMenu(API.Player, 1)
```

### Response
#### Success Response (void)
This function does not return any value.
```

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

### CreateGump

Source: https://tazuo.org/legion/api

Creates a new, blank gump object. Optional parameters control mouse input, movement, and persistence.

```APIDOC
## POST /websites/tazuo_legion/CreateGump

### Description
Get a blank gump.

### Method
POST

### Endpoint
/websites/tazuo_legion/CreateGump

### Parameters
#### Query Parameters
- **acceptMouseInput** (bool) - Optional - Allow clicking the gump
- **canMove** (bool) - Optional - Allow the player to move this gump
- **keepOpen** (bool) - Optional - If true, the gump won’t be closed if the script stops. Defaults to false.

### Request Example
```python
g = API.CreateGump()
g.SetRect(100, 100, 200, 200)
g.Add(API.CreateGumpLabel("Hello World!"))
API.AddGump(g)
```

### Response
#### Success Response (200)
- **gump** (PyBaseGump) - The newly created gump object.

#### Response Example
```json
{
  "id": "gump_123",
  "type": "PyBaseGump",
  "rect": {"x1": 100, "y1": 100, "x2": 200, "y2": 200}
}
```
```

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

### Get Multis at Specific Coordinates (Python)

Source: https://tazuo.org/legion/api

Fetches all multi-objects present at a precise (x, y) coordinate. This is commonly used for retrieving server-side house data or other multi-part objects. It returns a list of PyMulti objects.

```python
multis = API.GetMultisAt(1000, 1000)
for m in multis:
    API.SysMsg(f"Multi Graphic: {m.Graphic}, Z: {m.Z}")
```

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

### CreateGumpButton

Source: https://tazuo.org/legion/api

Creates a button for Gumps with customizable text, hue, and graphics.

```APIDOC
## CreateGumpButton

### Description
Creates a button for gumps.

### Method
(Implicitly a function call in the context of the API)

### Endpoint
N/A (Function within a script)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
*   **text** (string) - Optional - The text displayed on the button.
*   **hue** (ushort) - Optional - The hue of the button text.
*   **normal** (ushort) - Optional - The graphic ID for the button when not clicked or hovered.
*   **pressed** (ushort) - Optional - The graphic ID for the button when pressed.
*   **hover** (ushort) - Optional - The graphic ID for the button when hovered.

### Request Example
```python
g = API.CreateGump()
g.SetRect(100, 100, 200, 200)
button = API.CreateGumpButton("Click Me!")
g.Add(button)
API.AddGump(g)

while True:
  API.SysMsg("Button currently clicked?: " + str(button.IsClicked))
  API.SysMsg("Button clicked since last check?: " + str(button.HasBeenClicked()))
  API.Pause(0.2)
```

### Response
#### Success Response (200)
*   **Button** (Object) - The created button object.

#### Response Example
```json
{
  "type": "Button",
  "text": "Click Me!"
}
```
```
Tokens:
Raw