gaia::ecs::EntityIdOptions Struct Reference

Options for World::ids / World::ids_if. Defaults visit the complete direct type: every storage source and both id kinds. Chain helpers to narrow or combine: the first storage or kind helper restricts, later ones accumulate. Match helpers use the same names as QueryTermOptions: direct() and in(). Unlike queries, the default is QueryMatchKind::Direct because this API lists assigned ids rather than testing presence of a known term. More...

#include <id.h>

Public Member Functions
EntityIdOptions &	archetype ()
	Selects archetype-resident ids.
EntityIdOptions &	dont_fragment ()
	Selects DontFragment component membership.
EntityIdOptions &	relation ()
	Selects exclusive non-fragmenting pairs.
EntityIdOptions &	components ()
	Selects non-pair ids.
EntityIdOptions &	pairs ()
	Selects relationship pair ids.
EntityIdOptions &	direct ()
	Restricts visitation to ids stored on the entity.
EntityIdOptions &	in ()
	Allows direct and inherited matches. After the direct type, appends OnInstantiate(Inherit) ids from Is bases that are not already stored on the entity. Does not enumerate inferred semantic Pair(Is, ...) ids; use World::has / World::is for those.

Friends
class	World

Detailed Description

Options for World::ids / World::ids_if. Defaults visit the complete direct type: every storage source and both id kinds. Chain helpers to narrow or combine: the first storage or kind helper restricts, later ones accumulate. Match helpers use the same names as QueryTermOptions: direct() and in(). Unlike queries, the default is QueryMatchKind::Direct because this API lists assigned ids rather than testing presence of a known term.

Member Function Documentation

archetype()

EntityIdOptions & gaia::ecs::EntityIdOptions::archetype ( )

inline

Selects archetype-resident ids.

Returns

This options object.

components()

EntityIdOptions & gaia::ecs::EntityIdOptions::components ( )

inline

Selects non-pair ids.

Returns

This options object.

direct()

EntityIdOptions & gaia::ecs::EntityIdOptions::direct ( )

inline

Restricts visitation to ids stored on the entity.

Returns

This options object.

dont_fragment()

EntityIdOptions & gaia::ecs::EntityIdOptions::dont_fragment ( )

inline

Selects DontFragment component membership.

Returns

This options object.

in()

EntityIdOptions & gaia::ecs::EntityIdOptions::in ( )

inline

Allows direct and inherited matches. After the direct type, appends OnInstantiate(Inherit) ids from Is bases that are not already stored on the entity. Does not enumerate inferred semantic Pair(Is, ...) ids; use World::has / World::is for those.

Returns

This options object.

pairs()

EntityIdOptions & gaia::ecs::EntityIdOptions::pairs ( )

inline

Selects relationship pair ids.

Returns

This options object.

relation()

EntityIdOptions & gaia::ecs::EntityIdOptions::relation ( )

inline

Selects exclusive non-fragmenting pairs.

Returns

This options object.

---

The documentation for this struct was generated from the following file:

• /home/runner/work/gaia-ecs/gaia-ecs/include/gaia/ecs/id.h