Function ecs_field_is_self

Synopsis

#include <include/flecs.h>

FLECS_API bool ecs_field_is_self(const ecs_iter_t *it, int32_t index)

Description

Test whether the field is matched on self. This operation returns whether the field is matched on the currently iterated entity. This function will return false when the field is owned by another entity, such as a parent or a prefab.

When this operation returns false, the field must be accessed as a single value instead of an array. Fields for which this operation returns true return arrays with it->count values.

Parameters

it - The iterator.

index - The index of the field in the iterator.

Returns
Whether the field is matched on self.

Mentioned in

Source

Line 4048 in include/flecs.h.