core.engine.get_entity_types

Syntax

local result = core.engine.get_entity_types()

Parameters

No parameters are accepted by this function

Returns

Type	Name	Description
`table`	result	An array of available entity category names Each entry is usable as the `category` argument to `core.engine.get_entities`

Entity Types

Category	Availability	Streamable	Dimension	Notes
`core.model`	`client` \| `server`	✓	✓	Frustum-culled
`core.camera`	`client`	—	✓	Selects the dimension it renders
`core.webview`	`client`	—	—
`core.font`	`client`	—	—
`core.image`	`client`	—	—
`core.svg`	`client`	—	—
`core.rendertarget`	`client`	—	—
`core.display`	`client`	—	—
`core.shader`	`client`	—	—
`core.audio_2d`	`client`	—	—
`core.audio_3d`	`client`	✓	✓	Frustum-culled positional audio
`core.database`	`server`	—	—
`core.db_query`	`server`	—	—
`util.timer`	`client` \| `server`	—	—
`util.promise`	`client` \| `server`	—	—
`util.thread`	`client` \| `server`	—	—
`light.directional`	`client`	✓	✓	Always streamed
`light.point`	`client`	✓	✓	Frustum-culled
`light.spot`	`client`	✓	✓	Frustum-culled
`light.area`	`client`	✓	✓	Frustum-culled
`particle.gpu`	`client`	✓	✓	Frustum-culled
`particle.trail`	`client`	✓	✓	Frustum-culled
`physics.rigid`	`client` \| `server`	✓	✓	Frustum-culled
`physics.static`	`client` \| `server`	✓	✓	Frustum-culled
`physics.character`	`client` \| `server`	✓	✓	Frustum-culled
`physics.animatable`	`client` \| `server`	✓	✓	Frustum-culled
`physics.vehicle`	`client` \| `server`	✓	✓	Frustum-culled
`physics.vehicle_wheel`	`client` \| `server`	✓	✓	Frustum-culled, follows its parent's dimension
`physics.area`	`client` \| `server`	—	✓
`physics.collision_shape`	`client` \| `server`	✓	✓	Frustum-culled, follows its parent's dimension

Examples

Prints all registered entity categories

core.engine.iprint(core.engine.get_entity_types())

Counts entities across every category

for _, category in ipairs(core.engine.get_entity_types()) do
    core.engine.print("info", category, "count:", #core.engine.get_entities(category))
end

Registers a monitor for every entity category

for _, category in ipairs(core.engine.get_entity_types()) do
    util.monitor.register(category .. "_count", util.string.upper(category) .. "_COUNT", function() 
        return #core.engine.get_entities(category)
    end, util.monitor.stat_format.QUANTITY)
end

core.engine.get_entity_types

Syntax

Parameters

Returns

Entity Types

Examples

On this page