entity.scan_objects

Overview

• Scans nearby game objects (furniture, doors, fixtures, etc.) relative to camera/pawn direction.

Metadata

Field	Value
Display	Scan Objects
Category	entity
Access	Public
Scope	B1Standalone
Tags	—
Aliases	—

Parameters

Name	Type	Required	Default	Description
radius	float	no	—	Search radius in meters (default 100, max 1000)
direction	string	no	—	Direction filter: front/behind/left/right/all (default all)
cone	float	no	—	Cone half-angle in degrees (default 90)
sort	string	no	—	Sort by: distance/angle (default distance)
ref	string	no	—	Reference direction: camera/pawn (default camera)
limit	int	no	—	Max results (default 20, max 100)

Returns

Returns a JSON object with the following fields:

Field	Type	Required	Description
ref	string	yes	Reference direction used (camera/pawn)
radius	float	yes	Search radius in meters
count	int	yes	Number of objects returned
objects	array	yes	Nearby game objects
objects[].entity_id	entityId	yes	Object entity id
objects[].name	string	yes	Object name
objects[].floor_level	int	yes	Floor level
objects[].distance	float	yes	Distance in meters
objects[].angle	float	yes	Signed angle in degrees (-left/+right)
objects[].direction	string	yes	Direction label (front/behind/left/right)

Usage

await inzoi.cli.execute('entity.scan_objects', {
  radius: 0.0, // optional
  direction: '', // optional
  cone: 0.0, // optional
  sort: '', // optional
  ref: '', // optional
  limit: 0, // optional
});