Skip to main content
POST
/
foliage
/
scatter
scatter instanced foliage across an area
curl --request POST \
  --url http://localhost:3917/foliage/scatter \
  --header 'Content-Type: application/json' \
  --data '
{
  "area_max": [
    123
  ],
  "area_min": [
    123
  ],
  "density": 123,
  "max_distance": 123,
  "max_scale": 123,
  "mesh_name": "<string>",
  "min_scale": 123
}
'
{
  "density": 0.5,
  "instance_count": 200,
  "mesh": "cube",
  "ok": true
}

Body

application/json
​
area_max
number<float>[]
​
area_min
number<float>[]
​
density
number<float>
​
max_distance
number<float>
​
max_scale
number<float>
​
mesh_name
string
​
min_scale
number<float>

Response

200 - application/json

A new instanced foliage layer with the placed instance_count; returns an error field if the mesh name or DefaultAssets are missing.