> For the complete documentation index, see [llms.txt](https://plugins.phbot.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://plugins.phbot.org/phbot-api/paths.md).

# Paths

## generate\_path(x, y)

#### Usage

`generate_path(-1207, 2332)`

#### Returns

`None` if the path could not be found, `False` if 5s have not passed / the character is not in game, or a `list` of `tuples` containing the walk path. Cave paths will have an extra field at position `0` in the tuple for the region. Teleporting is not supported.

```
[(-1183, 2299), (-1193, 2309), (-1202, 2320), (-1205, 2328)]
```

### generate\_script(region, x, y, z)

**Usage**

`generate_script(25000, 6432, 1095, 0)`

**Returns**

`None` if the path could not be found, `False` if 5s have not passed / the character is not in game, or a `list` of `strings` with the walk path including teleports and wait commands.

`['walk,3548,2068,0', 'walk,3543,2064,0', 'walk,3535,2076,0', 'walk,3540,2085,0', 'wait,5000', 'teleport,GATE_WC,GATE_CH', 'wait,5000', 'walk,6432,1096,0', 'walk,6432,1077,0', 'walk,6444,1062,0', 'walk,6453,1045,0', 'walk,6453,1026,0', 'walk,6442,1011,0', 'walk,6440,992,0', 'walk,6440,973,0', 'walk,6439,969,0', 'walk,6435,965,0', 'walk,6435,915,0', 'walk,6435,914,0', 'walk,6435,895,0', 'walk,6431,876,0', 'walk,6424,858,0', 'walk,6413,842,0', 'walk,6405,827,0', 'walk,6403,808,0', 'walk,6400,800,0']`


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://plugins.phbot.org/phbot-api/paths.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

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.