spatial_query
Run spatial queries in Roblox Studio to raycast, find ground, detect flat areas, locate spawn positions, and analyze walkability.
Instructions
Spatial queries in workspace. Actions: raycast (filterList/filterType/ignoreWater), multi_raycast (rays[], max 50), in_radius, in_box, ground_height/find_ground (position or x/z), check_placement (is a box placeable at position), scan_area (heightmap grid), find_flat (flat build spots), find_spawn (clear spawn positions), analyze_walkable (walkability grid), spatial_map (all BasePart/Model positions), find_space (empty spot for a box), bounds (one path or paths[]), snap_grid (snap an instance pivot to a grid), collision. Areas: searchArea/area/region are {min:[x,y,z], max:[x,y,z]}.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| x | No | ||
| z | No | ||
| area | No | Alias for searchArea | |
| axes | No | snap_grid axes (default all) | |
| path | No | Instance path for bounds / collision / snap_grid / spatial_map root. Alias: rootPath | |
| rays | No | Ray list for multi_raycast (max 50) | |
| size | No | [x,y,z] box size for in_box / check_placement / find_space / scan_area (x,z used) | |
| count | No | find_spawn result count (default 10) | |
| paths | No | Multiple paths for bounds | |
| action | Yes | ||
| center | No | ||
| offset | No | find_ground vertical offset added to result (default 0) | |
| origin | No | ||
| radius | No | ||
| minSize | No | find_flat minimum flat area size [x,z] (default [8,8]) | |
| padding | No | find_space clearance around the box (default 1) | |
| gridSize | No | snap_grid / find_space grid size (default 4). Alias: gridSnap | |
| gridSnap | No | Alias for gridSize | |
| maxSlope | No | Max slope degrees for find_flat (default 10) / analyze_walkable (default 45) | |
| position | No | [x,y,z] for find_ground / check_placement / collision / find_space result bias | |
| rootPath | No | Alias for path (spatial_map) | |
| rotation | No | [rx,ry,rz] degrees for check_placement | |
| direction | No | ||
| otherPath | No | Second instance for collision | |
| spawnSize | No | find_spawn entity size (default [4,5,4]) | |
| tolerance | No | find_flat height variation tolerance in studs (default 2) | |
| filterList | No | Instance paths to exclude/include in raycasts. Alias: filterInstances | |
| filterType | No | Raycast filter type (default Exclude) | |
| maxResults | No | ||
| minSpacing | No | find_spawn min distance between results (default 10) | |
| resolution | No | Grid resolution in studs for scan_area/analyze_walkable/find_flat (default 4) | |
| searchArea | No | World AABB for find_flat / find_spawn / find_space / analyze_walkable. Alias: area | |
| checkGround | No | check_placement: also require ground support (default true) | |
| ignoreWater | No | ||
| maxDistance | No | find_ground max cast distance (default 1000) | |
| includeModels | No | spatial_map: include Model bounding boxes (default true) | |
| maxStepHeight | No | analyze_walkable max step between cells (default 2) | |
| preferOutdoor | No | find_spawn: require open sky (default false) | |
| characterHeight | No | analyze_walkable clearance height (default 5) | |
| filterInstances | No | Alias for filterList |