screen
Finds where things are on the game’s screen, for driving the real mouse. Always returns the view size and the game window. Pass any of:
target: returnsaim, a pixel to click it at, well inside the object and with nothing in front (null if it is out of view or hidden;cameracan bring it into view).clearis how many of the eight pixels 10 away also hit it; 8 means well inside.positionis where its feet are.point: returns the pixel where that world point appears.pixel: returnshits, what lies under that pixel, nearest first. The first object is what a click there would act on.
Each place is given as x, y (the game’s pixels from the top left), fx, fy (fractions of the picture) and desktop (the desktop pixel to send a real mouse to). coveredBy names another window covering the game there, if any: a click there would hit that window, so move it or the game first. After moving the mouse, cursor says what the game has under it.
Read-only: it changes nothing in the game.
Arguments
| Name | Type | Required | What |
|---|---|---|---|
target | any | A creature or object to find, by id. | |
point | any | A world point to find: {x, y, z} or [x, y, z]. | |
pixel | any | A pixel to look under: [x, y] in the game’s pixels. |
Call it as screen over MCP, or POST /api/tool/screen with the arguments as JSON.