World / Server
paper/get_nearby_entities
Get Nearby Entities
Returns all entities within a radius of a location.
Inputs
| Name | Type | Optional | Description |
|---|---|---|---|
location |
location | Centre location. | |
radius |
number | ✓ | Search radius. |
Outputs
| Name | Type | Description |
|---|---|---|
entities |
list | List of nearby entities. |
count |
number | Number of entities found. |
Properties
| Key | Type | Default | Description |
|---|---|---|---|
radius |
number | 10 |
Radius |
typeFilter |
string | "" |
Filter by entity type name, e.g. ZOMBIE. |