forked from julianperrott/WowClassicGrindBot
-
-
Notifications
You must be signed in to change notification settings - Fork 191
Expand file tree
/
Copy pathPathingAPI.xml
More file actions
181 lines (162 loc) · 12.8 KB
/
PathingAPI.xml
File metadata and controls
181 lines (162 loc) · 12.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
<?xml version="1.0"?>
<doc>
<assembly>
<name>PathingAPI</name>
</assembly>
<members>
<member name="M:PathingAPI.Controllers.PPatherController.MapRoute(System.Int32,System.Single,System.Single,System.Int32,System.Single,System.Single)">
<summary>
Allows a route to be calculated from one point to another using only minimap coords.
</summary>
<remarks>
uimap1 and uimap2 are the map ids. See [GetBestMapForUnit](https://wow.gamepedia.com/API_C_Map.GetBestMapForUnit)
/dump C_Map.GetBestMapForUnit("player")
Dump: value=_Map.GetBestMapForUnit("player")
[1]=1451
x and y are the map coordinates for the zone (same as the mini map). See [GetPlayerMapPosition](https://wowwiki.fandom.com/wiki/API_GetPlayerMapPosition)
local posx, posY = GetPlayerMapPosition("player");
</remarks>
<param name="uimap1" example="1451">from Silithus [uimap id](https://wago.tools/db2/UiMap)</param>
<param name="x1" example="46.8">from x</param>
<param name="y1" example="54.2">from Y</param>
<param name="uimap2" example="1451">to Silithus [uimap id](https://wago.tools/db2/UiMap)</param>
<param name="x2" example="51.2">to x</param>
<param name="y2" example="38.9">to Y</param>
<response code="200">List of <see cref="T:System.Numerics.Vector3"/> minimap coordinates.</response>
</member>
<member name="M:PathingAPI.Controllers.PPatherController.WorldRoute(System.Single,System.Single,System.Single,System.Single,System.Single,System.Single,System.Single,System.Boolean)">
<summary>
Allows a route to be calculated from one point to another using world coordinates.
</summary>
<remarks>
Example
-896, -3770, 11, (Barrens, Rachet) to -441, -2596, 96, (Barrens, Crossroads, Barrens)
</remarks>
<param name="x1" example="-896">from x</param>
<param name="y1" example="-3770">from Y</param>
<param name="z1" example="11">from Z</param>
<param name="x2" example="-441">to x</param>
<param name="y2" example="-2596">to Y</param>
<param name="z2" example="96">to Z</param>
<param name="mapid" example="1">ContientID ["Azeroth=0", "Kalimdor=1", "Outland/Expansion01=530", "Northrend=571"]</param>
<param name="reverse" example="true">Reverse the start and end points</param>
<response code="200">List of <see cref="T:System.Numerics.Vector3"/> world coordinates.</response>
</member>
<member name="M:PathingAPI.Controllers.PPatherController.WorldRoute2(System.Single,System.Single,System.Single,System.Single,System.Single,System.Single,System.Int32,System.Nullable{System.Boolean})">
<summary>
Allows a route to be calculated from one point to another using world coords.
</summary>
<remarks>
Example
-896, -3770, 11, (Barrens, Rachet) to -441, -2596, 96, (Barrens, Crossroads, Barrens)
</remarks>
<param name="x1" example="-896">from x</param>
<param name="y1" example="-3770">from Y</param>
<param name="z1" example="11">from Z</param>
<param name="x2" example="-441">to x</param>
<param name="y2" example="-2596">to Y</param>
<param name="z2" example="96">to Z</param>
<param name="uimap" example="1413">The Barrens [uimap ID](https://wago.tools/db2/UiMap)</param>
<param name="startindoors" example="false">If true, the search will prefer lower - underground values - otherwise the higher ones.</param>
<response code="200">List of <see cref="T:System.Numerics.Vector3"/> world coordinates.</response>
</member>
<member name="M:PathingAPI.Controllers.PPatherController.MapToWorldRoute(System.Single,System.Single,System.Single,System.Single,System.Single,System.Single,System.Int32)">
<summary>
Allows a route to be calculated from one point to another using world coords.
</summary>
<remarks>
Example
-896, -3770, 11, (Barrens, Rachet) to -441, -2596, 96, (Barrens, Crossroads, Barrens)
</remarks>
<param name="x1" example="30">from x</param>
<param name="y1" example="73">from Y</param>
<param name="z1" example="0">from Z</param>
<param name="x2" example="42">to x</param>
<param name="y2" example="59">to Y</param>
<param name="z2" example="0">to Z</param>
<param name="uimap" example="1426">The Barrens [uimap ID](https://wago.tools/db2/UiMap)</param>
<response code="200">List of <see cref="T:System.Numerics.Vector3"/> world coordinates.</response>
</member>
<member name="M:PathingAPI.Controllers.PPatherController.Drawlines(System.Collections.Generic.List{PPather.Data.LineArgs})">
<summary>
Draws lines on the landscape.
This endpoint is used by the client to render grind paths on the landscape.
</summary>
<remarks>
This endpoint takes a list of <see cref="T:PPather.Data.LineArgs"/> objects, each representing a line to be drawn.
<see cref="P:PPather.Data.LineArgs.Spots"/> Holds Map coordinates. Not World coordinates!
For each line specified in the request, the server creates corresponding locations
which notifies browser UI to add the lines to the landscape.
If the server is currently rate-limited, a <see cref="T:Microsoft.AspNetCore.Mvc.StatusCodeResult"/> with status code 429 (Too Many Requests) will be returned.
</remarks>
<param name="lineArgs">A list of <see cref="T:PPather.Data.LineArgs"/> objects representing the lines to be drawn.</param>
<returns>
An <see cref="T:Microsoft.AspNetCore.Mvc.IActionResult"/> representing the result of the operation.
If successful, returns a <see cref="T:Microsoft.AspNetCore.Mvc.StatusCodeResult"/> with status code 202 (Accepted), indicating that the request has been accepted for processing.
</returns>
</member>
<member name="M:PathingAPI.Controllers.PPatherController.DrawSphere(PPather.Data.SphereArgs)">
<summary>
Draws a sphere on the landscape to indicate a player's location.
This endpoint is utilized by the client to visually represent the player's position on the landscape.
</summary>
<remarks>
This endpoint receives a <see cref="T:PPather.Data.SphereArgs"/> object containing information about the sphere to be drawn.
<see cref="P:PPather.Data.SphereArgs.Spot"/> Holds Map coordinates. Not World coordinates!
If the server is not initialized and ready to handle requests, it returns a <see cref="T:Microsoft.AspNetCore.Mvc.ProblemDetails"/> response with status code 503 (Service Unavailable).
The server then translates the sphere's coordinates into world coordinates using the provided uiMapID and spot coordinates.
Once the location is determined, the server invokes an event to notify the client to render the sphere.
If the server is currently rate-limited, a <see cref="T:Microsoft.AspNetCore.Mvc.StatusCodeResult"/> with status code 429 (Too Many Requests) will be returned.
</remarks>
<param name="sphere">A <see cref="T:PPather.Data.SphereArgs"/> object representing the sphere to be drawn.</param>
<returns>
An <see cref="T:Microsoft.AspNetCore.Mvc.IActionResult"/> representing the result of the operation.
If successful, returns a <see cref="T:Microsoft.AspNetCore.Mvc.StatusCodeResult"/> with status code 202 (Accepted), indicating that the request has been accepted for processing.
</returns>
</member>
<member name="M:PathingAPI.Controllers.PPatherController.SelfTest">
<summary>
Returns true to indicate that the server is listening.
</summary>
<returns></returns>
</member>
<member name="M:PathingAPI.Controllers.PPatherController.DrawPath(PPather.DrawWorldPathRequest)">
<summary>
Draws a path based on continentID and world coordinates.
</summary>
<remarks>
This endpoint allows drawing a path on the map specified by <paramref name="r.mapId.mapId"/>.
The path is specified by an array of <see cref="T:System.Numerics.Vector3"/> world coordinates.
If the server is currently rate limited, a <see cref="T:Microsoft.AspNetCore.Mvc.StatusCodeResult"/> with status code 429 (Too Many Requests) will be returned.
</remarks>
<param name="r" example="{"mapId":0, "path":[{"x":-6220.71,"y":347.44037,"z":384.21396},{"x":-6214.267,"y":372.179,"z":385.83997},{"x":-6207.5337,"y":393.90826,"z":387.28632},{"x":-6200.808,"y":415.13522,"z":388.36853},{"x":-6194.393,"y":438.36694,"z":388.9026},{"x":-6188.587,"y":466.1103,"z":388.70398},{"x":-6183.6895,"y":500.87225,"z":387.58856},{"x":-6180,"y":545.1599,"z":385.372}]}"></param>
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.IActionResult"/> representing the result of the operation. If successful, returns a <see cref="T:Microsoft.AspNetCore.Mvc.StatusCodeResult"/> with status code 202 (Accepted).</returns>
</member>
<member name="M:PathingAPI.Controllers.PPatherController.DrawPath(PPather.DrawMapPathRequest)">
<summary>
Draws a path on the uiMapId and map coordinates.
</summary>
<remarks>
This endpoint allows drawing a path on the map specified by <paramref name="r.uiMapId.uiMapId"/>.
The path is specified by an array of <see cref="T:System.Numerics.Vector3"/> map coordinates.
If the server is currently rate limited, a <see cref="T:Microsoft.AspNetCore.Mvc.StatusCodeResult"/> with status code 429 (Too Many Requests) will be returned.
</remarks>
<param name="r" example="{"uiMapId":1426, "path":[{"x":42.30905,"y":59.866},{"x":42.802,"y":59.483},{"x":43.40704,"y":59.327},{"x":43.69,"y":58.779},{"x":43.994,"y":58.245999999999995},{"x":44.596999999999994,"y":58.038999999999994},{"x":43.96,"y":58.150999999999996},{"x":43.585,"y":58.6861},{"x":43.04,"y":58.958999999999996},{"x":42.561,"y":59.434},{"x":41.961,"y":59.54704},{"x":41.46,"y":59.156},{"x":40.91004,"y":58.8691},{"x":40.271,"y":58.958999999999996},{"x":39.824,"y":59.409},{"x":39.42,"y":59.915},{"x":38.999,"y":60.405},{"x":38.949,"y":61.025},{"x":39.512,"y":61.27},{"x":40.11,"y":61.196},{"x":40.694,"y":61.05004},{"x":41.152,"y":60.633}]}"></param>
<returns>An <see cref="T:Microsoft.AspNetCore.Mvc.IActionResult"/> representing the result of the operation. If successful, returns a <see cref="T:Microsoft.AspNetCore.Mvc.StatusCodeResult"/> with status code 202 (Accepted).</returns>
</member>
<member name="M:PathingAPI.Controllers.PPatherController.Reset">
<summary>
Resets the ppather service, clearing any cached data or state.
</summary>
</member>
<member name="M:PathingAPI.Pages.Index.WR(System.Double,System.Double,System.Double,System.Double,System.Double,System.Double,System.Int32,System.Boolean)">
<summary>WorldRoute: coordinates + mapId</summary>
</member>
<member name="M:PathingAPI.Pages.Index.WR2(System.Double,System.Double,System.Double,System.Double,System.Double,System.Double,System.Int32,System.Nullable{System.Int32},System.Boolean)">
<summary>WorldRoute2: coordinates + uiMap</summary>
</member>
<member name="M:PathingAPI.Pages.Index.MR(System.Int32,System.Double,System.Double,System.Int32,System.Double,System.Double)">
<summary>MapRoute: uiMap coordinates</summary>
</member>
</members>
</doc>