4rpl:commands:getpointerterraincoords
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| 4rpl:commands:getpointerterraincoords [2021/02/13 17:05] – virgilw | 4rpl:commands:getpointerterraincoords [2025/06/10 06:04] (current) – Failure case mentioned Vertu | ||
|---|---|---|---|
| Line 6: | Line 6: | ||
| ===== Description ===== | ===== Description ===== | ||
| - | Gets the map cell coordinates current pointed at by the game pointer (the mouse). A ray projection is done from the pointer through the 3D world and | + | Gets the map cell coordinates current pointed at by the game pointer (the mouse). A ray projection is done from the pointer through the 3D world and a collision is checked at each terrain height level. So this API will return the location on the map surface that the pointer is pointing towards. |
| - | a collision is checked at each terrain height level. So this API will return the location on the map surface that the pointer is pointing towards. | + | |
| + | :NOTE: The returned coordinates are floats, not integers. If you wish to use this API to obtain cell coordinates rather than world-space, | ||
| + | This API also works outside the map boundaries. | ||
| + | |||
| + | Should the API fail to find a result, such as the mouse being pointed into the sky, the resulting cells are -1. | ||
| ===== Examples ===== | ===== Examples ===== | ||
4rpl/commands/getpointerterraincoords.1613235950.txt.gz · Last modified: 2025/02/14 14:56 (external edit)
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
