The world. More...

#include <world.hpp>

Inheritance diagram for flecs::world:

Public Member Functions
	world ()
	Create a world.

	world (int argc, char *argv[])
	Create a world with command-line arguments.

	world (world_t *w)
	Create a world from a C world.

	world (const world &obj)
	Copy constructor.

world &	operator= (const world &obj) noexcept
	Copy assignment operator.

	world (world &&obj) noexcept
	Move constructor.

world &	operator= (world &&obj) noexcept
	Move assignment operator.

void	release ()
	Release the underlying world object.

	~world ()
	Destructor.

	operator world_t * () const
	Implicit conversion to world_t*.

void	make_owner ()
	Make the current world object the owner of the world.

void	reset ()
	Delete and recreate the world.

world_t *	c_ptr () const
	Obtain a pointer to the C world object.

void	quit () const
	Signal application should quit.

void	atfini (ecs_fini_action_t action, void *ctx=nullptr) const
	Register action to be executed when world is destroyed.

bool	should_quit () const
	Test if quit() has been called.

ecs_ftime_t	frame_begin (float delta_time=0) const
	Begin frame.

void	frame_end () const
	End frame.

bool	readonly_begin (bool multi_threaded=false) const
	Begin readonly mode.

void	readonly_end () const
	End readonly mode.

bool	defer_begin () const
	Defer operations until end of frame.

bool	defer_end () const
	End block of operations to defer.

bool	is_deferred () const
	Test whether deferring is enabled.

bool	is_defer_suspended () const
	Test whether deferring is suspended.

void	set_stage_count (int32_t stages) const
	Configure world to have N stages.

int32_t	get_stage_count () const
	Get the number of configured stages.

int32_t	get_stage_id () const
	Get current stage ID.

bool	is_stage () const
	Test if this is a stage.

void	merge () const
	Merge world or stage.

flecs::world	get_stage (int32_t stage_id) const
	Get stage-specific world pointer.

flecs::world	async_stage () const
	Create an asynchronous stage.

flecs::world	get_world () const
	Get actual world.

bool	is_readonly () const
	Test whether the current world object is readonly.

void	set_ctx (void *ctx, ecs_ctx_free_t ctx_free=nullptr) const
	Set world context.

void *	get_ctx () const
	Get world context.

void	set_binding_ctx (void *ctx, ecs_ctx_free_t ctx_free=nullptr) const
	Set world binding context.

void *	get_binding_ctx () const
	Get world binding context.

void	dim (int32_t entity_count) const
	Preallocate memory for a number of entities.

void	set_entity_range (entity_t min, entity_t max) const
	Set entity range.

void	enable_range_check (bool enabled=true) const
	Enforce that operations cannot modify entities outside of range.

flecs::entity	set_scope (const flecs::entity_t scope) const
	Set current scope.

flecs::entity	get_scope () const
	Get current scope.

template<typename T >
flecs::entity	set_scope () const
	Same as set_scope(), but with type.

flecs::entity_t *	set_lookup_path (const flecs::entity_t *search_path) const
	Set search path.

flecs::entity	lookup (const char name, const char sep="::", const char *root_sep="::", bool recursive=true) const
	Lookup entity by name.

template<typename T , if_t< !is_callable< T >::value > = 0>
void	set (const T &value) const
	Set singleton component.

template<typename T , if_t< !is_callable< T >::value > = 0>
void	set (T &&value) const
	Set singleton component.

template<typename First , typename Second , typename P = flecs::pair<First, Second>, typename A = actual_type_t<P>, if_not_t< flecs::is_pair< First >::value > = 0>
void	set (const A &value) const
	Set singleton pair.

template<typename First , typename Second , typename P = flecs::pair<First, Second>, typename A = actual_type_t<P>, if_not_t< flecs::is_pair< First >::value > = 0>
void	set (A &&value) const
	Set singleton pair.

template<typename First , typename Second >
void	set (Second second, const First &value) const
	Set singleton pair.

template<typename First , typename Second >
void	set (Second second, First &&value) const
	Set singleton pair.

template<typename Func , if_t< is_callable< Func >::value > = 0>
void	set (const Func &func) const
	Set singleton component inside a callback.

template<typename T , typename ... Args>
void	emplace (Args &&... args) const

template<typename T >
T &	ensure () const
	Ensure singleton component.

template<typename T >
void	modified () const
	Mark singleton component as modified.

template<typename T >
ref< T >	get_ref () const
	Get ref singleton component.

const void *	try_get (flecs::id_t id) const
	Get singleton component.

const void *	try_get (flecs::entity_t r, flecs::entity_t t) const
	Get singleton pair.

template<typename T >
const T *	try_get () const
	Get singleton component.

template<typename First , typename Second , typename P = flecs::pair<First, Second>, typename A = actual_type_t<P>>
const A *	try_get () const
	Get singleton pair.

template<typename First , typename Second >
const First *	try_get (Second second) const
	Get singleton pair.

const void *	get (flecs::id_t id) const
	Get singleton component.

const void *	get (flecs::entity_t r, flecs::entity_t t) const
	Get singleton component.

template<typename T >
const T &	get () const
	Get a singleton component.

template<typename First , typename Second , typename P = flecs::pair<First, Second>, typename A = actual_type_t<P>>
const A &	get () const
	Get singleton pair.

template<typename First , typename Second >
const First &	get (Second second) const
	Get singleton pair.

template<typename Func , if_t< is_callable< Func >::value > = 0>
void	get (const Func &func) const
	Get singleton component inside a callback.

void *	try_get_mut (flecs::id_t id) const
	Get mutable singleton component.

void *	try_get_mut (flecs::entity_t r, flecs::entity_t t) const
	Get mutable singleton pair.

template<typename T >
T *	try_get_mut () const
	Try to get a mutable singleton component (returns nullptr if not found).

template<typename First , typename Second , typename P = flecs::pair<First, Second>, typename A = actual_type_t<P>>
A *	try_get_mut () const
	Get mutable singleton pair.

template<typename First , typename Second >
First *	try_get_mut (Second second) const
	Get mutable singleton pair.

void *	get_mut (flecs::id_t id) const
	Get mutable singleton component.

void *	get_mut (flecs::entity_t r, flecs::entity_t t) const
	Get mutable singleton pair.

template<typename T >
T &	get_mut () const
	Get a mutable singleton component.

template<typename First , typename Second , typename P = flecs::pair<First, Second>, typename A = actual_type_t<P>>
A &	get_mut () const
	Get mutable singleton pair.

template<typename First , typename Second >
First &	get_mut (Second second) const
	Get mutable singleton pair.

template<typename T >
bool	has () const
	Test if world has singleton component.

template<typename First , typename Second >
bool	has () const
	Test if world has the provided pair.

template<typename First >
bool	has (flecs::id_t second) const
	Test if world has the provided pair.

bool	has (flecs::id_t first, flecs::id_t second) const
	Test if world has the provided pair.

template<typename E , if_t< is_enum< E >::value > = 0>
bool	has (E value) const
	Check for enum singleton constant.

template<typename T >
void	add () const
	Add singleton component.

template<typename First , typename Second >
void	add () const
	Add a pair to the singleton component.

template<typename First >
void	add (flecs::entity_t second) const
	Add a pair to the singleton component.

void	add (flecs::entity_t first, flecs::entity_t second) const
	Add a pair to the singleton entity.

template<typename E , if_t< is_enum< E >::value > = 0>
void	add (E value) const
	Add enum singleton constant.

template<typename T >
void	remove () const
	Remove singleton component.

template<typename First , typename Second >
void	remove () const
	Remove the pair singleton component.

template<typename First >
void	remove (flecs::entity_t second) const
	Remove the pair singleton component.

void	remove (flecs::entity_t first, flecs::entity_t second) const
	Remove the pair singleton component.

template<typename Func >
void	children (Func &&f) const
	Iterate entities in root of world.

template<typename T >
flecs::entity	singleton () const
	Get singleton entity for type.

template<typename First >
flecs::entity	target (int32_t index=0) const
	Get target for a given pair from a singleton entity.

template<typename T >
flecs::entity	target (flecs::entity_t first, int32_t index=0) const
	Get target for a given pair from a singleton entity.

flecs::entity	target (flecs::entity_t first, int32_t index=0) const
	Get target for a given pair from a singleton entity.

template<typename T >
flecs::entity	use (const char *alias=nullptr) const
	Create an alias for a component.

flecs::entity	use (const char name, const char alias=nullptr) const
	Create an alias for an entity.

void	use (flecs::entity entity, const char *alias=nullptr) const
	Create an alias for an entity.

int	count (flecs::id_t component_id) const
	Count entities matching a component.

int	count (flecs::entity_t first, flecs::entity_t second) const
	Count entities matching a pair.

template<typename T >
int	count () const
	Count entities matching a component.

template<typename First >
int	count (flecs::entity_t second) const
	Count entities matching a pair.

template<typename First , typename Second >
int	count () const
	Count entities matching a pair.

template<typename Func >
void	with (id_t with_id, const Func &func) const
	All entities created in the function are created with the ID.

template<typename T , typename Func >
void	with (const Func &func) const
	All entities created in the function are created with the type.

template<typename First , typename Second , typename Func >
void	with (const Func &func) const
	All entities created in the function are created with the pair.

template<typename First , typename Func >
void	with (id_t second, const Func &func) const
	All entities created in the function are created with the pair.

template<typename Func >
void	with (id_t first, id_t second, const Func &func) const
	All entities created in the function are created with the pair.

template<typename Func >
void	scope (id_t parent, const Func &func) const
	All entities created in the function are created in the scope.

template<typename T , typename Func >
void	scope (const Func &func) const
	Same as scope(parent, func), but with T as parent.

flecs::scoped_world	scope (id_t parent) const
	Use the provided scope for operations run on the returned world.

template<typename T >
flecs::scoped_world	scope () const
	Use the provided scope (by type) for operations run on the returned world.

flecs::scoped_world	scope (const char *name) const
	Use the provided scope (by name) for operations run on the returned world.

void	delete_with (id_t the_id) const
	Delete all entities with specified id.

void	delete_with (entity_t first, entity_t second) const
	Delete all entities with specified pair.

template<typename T >
void	delete_with () const
	Delete all entities with specified component.

template<typename First , typename Second >
void	delete_with () const
	Delete all entities with specified pair.

template<typename First >
void	delete_with (entity_t second) const
	Delete all entities with specified pair.

void	remove_all (id_t the_id) const
	Remove all instances of specified id.

void	remove_all (entity_t first, entity_t second) const
	Remove all instances of specified pair.

template<typename T >
void	remove_all () const
	Remove all instances of specified component.

template<typename First , typename Second >
void	remove_all () const
	Remove all instances of specified pair.

template<typename First >
void	remove_all (entity_t second) const
	Remove all instances of specified pair.

template<typename Func >
void	defer (const Func &func) const
	Defer all operations called in function.

void	defer_suspend () const
	Suspend deferring operations.

void	defer_resume () const
	Resume deferring operations.

bool	exists (flecs::entity_t e) const
	Check if entity ID exists in the world.

bool	is_alive (flecs::entity_t e) const
	Check if entity is alive.

bool	is_valid (flecs::entity_t e) const
	Check if entity ID is valid.

flecs::entity	get_alive (flecs::entity_t e) const
	Get alive entity for ID.

flecs::entity	make_alive (flecs::entity_t e) const
	Ensure an entity ID is alive.

void	set_version (flecs::entity_t e) const
	Set the version of an entity to the provided value.

uint32_t	get_version (flecs::entity_t e) const
	Get the version of the provided entity.

void	run_post_frame (ecs_fini_action_t action, void *ctx) const
	Run callback after completing the frame.

const flecs::world_info_t *	get_info () const
	Get the world info.

ecs_ftime_t	delta_time () const
	Get delta_time.

void	shrink () const
	Free unused memory.

void	exclusive_access_begin (const char *thread_name=nullptr)
	Begin exclusive access.

void	exclusive_access_end (bool lock_world=false)
	End exclusive access.

template<typename T >
flecs::id_t	id_if_registered ()
	Return the component ID if it has been registered.

const flecs::type_info_t *	type_info (flecs::id_t component)
	Return the type info.

const flecs::type_info_t *	type_info (flecs::entity_t r, flecs::entity_t t)
	Return the type info.

template<typename T >
const flecs::type_info_t *	type_info ()
	Return the type info.

template<typename R >
const flecs::type_info_t *	type_info (flecs::entity_t t)
	Return the type info.

template<typename R , typename T >
const flecs::type_info_t *	type_info ()
	Return the type info.

void	init_builtin_components ()
	Initialize built-in components.

template<typename... Comps, typename... Args>
flecs::alert_builder< Comps... >	alert (Args &&... args) const
	Create an alert.

template<typename T , typename... Args>
flecs::component< T >	component (Args &&... args) const
	Find or register a component.

template<typename... Args>
flecs::untyped_component	component (Args &&... args) const
	Find or register an untyped component.

template<typename... Args>
flecs::entity	entity (Args &&... args) const
	Create an entity.

template<typename E , if_t< is_enum< E >::value > = 0>
flecs::id	id (E value) const
	Convert an enum constant to an entity.

template<typename E , if_t< is_enum< E >::value > = 0>
flecs::entity	entity (E value) const
	Convert an enum constant to an entity.

template<typename... Args>
flecs::entity	prefab (Args &&... args) const
	Create a prefab.

template<typename T >
flecs::entity	entity (const char *name=nullptr) const
	Create an entity that's associated with a type.

template<typename T >
flecs::entity	prefab (const char *name=nullptr) const
	Create a prefab that's associated with a type.

template<typename E , if_t< is_enum< E >::value > = 0>
flecs::entity	to_entity (E constant) const
	Convert an enum constant to an entity.

flecs::event_builder	event (flecs::entity_t evt) const
	Create a new event.

template<typename E >
flecs::event_builder_typed< E >	event () const
	Create a new event.

template<typename T >
flecs::id	id () const

template<typename ... Args>
flecs::id	id (Args &&... args) const

template<typename T >
flecs::id	id () const
	Get ID from a type.

template<typename ... Args>
flecs::id	id (Args &&... args) const
	ID factory.

template<typename First , typename Second >
flecs::id	pair () const
	Get pair ID from relationship and object.

template<typename First >
flecs::id	pair (entity_t o) const
	Get pair ID from relationship and object.

flecs::id	pair (entity_t r, entity_t o) const
	Get pair ID from relationship and object.

flecs::string	to_json (flecs::entity_t tid, const void *value) const
	Serialize an untyped value to JSON.

template<typename T >
flecs::string	to_json (const T *value) const
	Serialize a value to JSON.

flecs::string	to_json () const
	Serialize the world to JSON.

const char *	from_json (flecs::entity_t tid, void value, const char json, flecs::from_json_desc_t *desc=nullptr)
	Deserialize a value from JSON.

template<typename T >
const char *	from_json (T value, const char json, flecs::from_json_desc_t *desc=nullptr)
	Deserialize a value from JSON.

const char *	from_json (const char json, flecs::from_json_desc_t desc=nullptr)
	Deserialize JSON into the world.

const char *	from_json_file (const char json, flecs::from_json_desc_t desc=nullptr)
	Deserialize a JSON file into the world.

template<typename... Args>
flecs::metric_builder	metric (Args &&... args) const
	Create a metric.

template<typename T >
flecs::timer	timer () const
	Find or register a singleton timer.


flecs::app_builder	app ()
	Return an app builder.

Public Attributes
world_t *	world_
	Pointer to the underlying C world.

flecs::cursor	cursor (flecs::entity_t tid, void *ptr)
	Return a meta cursor to a value.

template<typename T >
flecs::cursor	cursor (void *ptr)
	Return a meta cursor to a value.

flecs::entity	primitive (flecs::meta::primitive_kind_t kind)
	Create a primitive type.

flecs::entity	array (flecs::entity_t elem_id, int32_t array_count)
	Create an array type.

template<typename T >
flecs::entity	array (int32_t array_count)
	Create an array type.

flecs::entity	vector (flecs::entity_t elem_id)
	Create a vector type.

template<typename T >
flecs::entity	vector ()
	Create a vector type.

template<typename Module >
flecs::entity	module (const char *name=nullptr) const
	Define a module.

template<typename Module >
flecs::entity	import ()
	Import a module.

flecs::observer	observer (flecs::entity e) const
	Observer world mixin.

template<typename... Components, typename... Args>
flecs::observer_builder< Components... >	observer (Args &&... args) const
	Create a new observer.

flecs::pipeline_builder	pipeline () const
	Create a new pipeline.

template<typename Pipeline , if_not_t< is_enum< Pipeline >::value > = 0>
flecs::pipeline_builder	pipeline () const
	Create a new pipeline.

void	set_pipeline (const flecs::entity pip) const
	Set the pipeline.

template<typename Pipeline >
void	set_pipeline () const
	Set the pipeline.

flecs::entity	get_pipeline () const
	Get the pipeline.

bool	progress (ecs_ftime_t delta_time=0.0) const
	Progress the world one tick.

void	run_pipeline (const flecs::entity_t pip, ecs_ftime_t delta_time=0.0) const
	Run a pipeline.

template<typename Pipeline , if_not_t< is_enum< Pipeline >::value > = 0>
void	run_pipeline (ecs_ftime_t delta_time=0.0) const
	Run a pipeline.

void	set_time_scale (ecs_ftime_t mul) const
	Set the time scale.

void	set_target_fps (ecs_ftime_t target_fps) const
	Set the target FPS.

void	reset_clock () const
	Reset the simulation clock.

void	set_threads (int32_t threads) const
	Set the number of threads.

int32_t	get_threads () const
	Get the number of threads.

void	set_task_threads (int32_t task_threads) const
	Set the number of task threads.

bool	using_task_threads () const
	Return true if task thread use has been requested.

template<typename... Comps, typename... Args>
flecs::query< Comps... >	query (Args &&... args) const
	Create a query.

flecs::query	query (flecs::entity query_entity) const
	Create a query from an entity.

template<typename... Comps, typename... Args>
flecs::query_builder< Comps... >	query_builder (Args &&... args) const
	Create a query builder.

template<typename Func >
void	each (Func &&func) const
	Iterate over all entities with components in the argument list of the function.

template<typename T , typename Func >
void	each (Func &&func) const
	Iterate over all entities with the provided component.

template<typename Func >
void	each (flecs::id_t term_id, Func &&func) const
	Iterate over all entities with the provided (component) ID.

flecs::system	system (flecs::entity e) const
	Upcast an entity to a system.

template<typename... Components, typename... Args>
flecs::system_builder< Components... >	system (Args &&... args) const
	Create a new system.

template<typename... Args>
flecs::term	term (Args &&... args) const
	Create a term.

template<typename T >
flecs::term	term () const
	Create a term for a (component) type.

template<typename First , typename Second >
flecs::term	term () const
	Create a term for a pair.

Detailed Description

The world.

The world is the container of all ECS data and systems. If the world is deleted, all data in the world will be deleted as well.

Definition at line 246 of file world.hpp.

Constructor & Destructor Documentation

◆ world() [1/5]

flecs::world::world ( )

inlineexplicit

Create a world.

Definition at line 249 of file world.hpp.

◆ world() [2/5]

flecs::world::world	(	int	argc,
		char *	argv[] )

inlineexplicit

Create a world with command-line arguments.

Currently, command-line arguments are not interpreted, but they may be used in the future to configure Flecs parameters.

Definition at line 258 of file world.hpp.

◆ world() [3/5]

flecs::world::world ( world_t * w )

inlineexplicit

Create a world from a C world.

Definition at line 265 of file world.hpp.

◆ world() [4/5]

flecs::world::world ( const world & obj )

inline

Copy constructor.

Increases reference count on the world.

Definition at line 274 of file world.hpp.

◆ world() [5/5]

flecs::world::world ( world && obj )

inlinenoexcept

Move constructor.

Transfers world ownership.

Definition at line 288 of file world.hpp.

◆ ~world()

flecs::world::~world ( )

inline

Destructor.

Releases the world reference.

Definition at line 322 of file world.hpp.

Member Function Documentation

◆ add() [1/5]

template<typename T >

void flecs::world::add ( ) const

inline

Add singleton component.

Add a singleton component.

Definition at line 312 of file world.hpp.

◆ add() [2/5]

template<typename First , typename Second >

void flecs::world::add ( ) const

inline

Add a pair to the singleton component.

Add a singleton pair component.

Template Parameters

First	The first element of the pair.
Second	The second element of the pair.

Definition at line 319 of file world.hpp.

◆ add() [3/5]

template<typename E , if_t< is_enum< E >::value > >

void flecs::world::add ( E value ) const

inline

Add enum singleton constant.

Add a singleton enum constant value.

Template Parameters

E	The enum type.

Parameters

value The enum constant.

Definition at line 339 of file world.hpp.

◆ add() [4/5]

void flecs::world::add	(	flecs::entity_t	first,
		flecs::entity_t	second ) const

inline

Add a pair to the singleton entity.

Add a singleton pair by entity IDs.

Parameters

first	The first element of the pair.
second	The second element of the pair.

Definition at line 332 of file world.hpp.

◆ add() [5/5]

template<typename First >

void flecs::world::add ( flecs::entity_t second ) const

inline

Add a pair to the singleton component.

Add a singleton pair component.

Template Parameters

First The first element of the pair.

Parameters

second The second element of the pair.

Definition at line 326 of file world.hpp.

◆ async_stage()

flecs::world flecs::world::async_stage ( ) const

inline

Create an asynchronous stage.

An asynchronous stage can be used to asynchronously queue operations for later merging with the world. An asynchronous stage is similar to a regular stage, except that it does not allow reading from the world.

Asynchronous stages are never merged automatically, and must therefore be manually merged with the ecs_merge() function. It is not necessary to call defer_begin() or defer_end() before and after enqueuing commands, as an asynchronous stage unconditionally defers operations.

The application must ensure that no commands are added to the stage while the stage is being merged.

Returns: The stage.

Definition at line 611 of file world.hpp.

◆ atfini()

void flecs::world::atfini	(	ecs_fini_action_t	action,
		void *	ctx = nullptr ) const

inline

Register action to be executed when world is destroyed.

Definition at line 365 of file world.hpp.

◆ c_ptr()

world_t * flecs::world::c_ptr ( ) const

inline

Obtain a pointer to the C world object.

Definition at line 352 of file world.hpp.

◆ children()

template<typename Func >

void flecs::world::children ( Func && f ) const

inline

Iterate entities in root of world.

Iterate over children of the root entity.

Accepts a callback with the following signature:

void(*)(flecs::entity e);

flecs::entity

Entity.

Definition entity.hpp:30

Definition at line 373 of file world.hpp.

◆ count() [1/5]

template<typename T >

int flecs::world::count ( ) const

inline

Count entities matching a component.

Template Parameters

T	The component type.

Returns: The number of entities matching the component.

Definition at line 1164 of file world.hpp.

◆ count() [2/5]

template<typename First , typename Second >

int flecs::world::count ( ) const

inline

Count entities matching a pair.

Template Parameters

First	The first element of the pair.
Second	The second element of the pair.

Returns: The number of entities matching the pair.

Definition at line 1186 of file world.hpp.

◆ count() [3/5]

int flecs::world::count	(	flecs::entity_t	first,
		flecs::entity_t	second ) const

inline

Count entities matching a pair.

Parameters

first	The first element of the pair.
second	The second element of the pair.

Returns: The number of entities matching the pair.

Definition at line 1154 of file world.hpp.

◆ count() [4/5]

template<typename First >

int flecs::world::count ( flecs::entity_t second ) const

inline

Count entities matching a pair.

Template Parameters

First The first element of the pair.

Parameters

second The second element of the pair.

Returns: The number of entities matching the pair.

Definition at line 1175 of file world.hpp.

◆ count() [5/5]

int flecs::world::count ( flecs::id_t component_id ) const

inline

Count entities matching a component.

Parameters

component_id The component ID.

Returns: The number of entities matching the component.

Definition at line 1144 of file world.hpp.

◆ defer()

template<typename Func >

void flecs::world::defer ( const Func & func ) const

inline

Defer all operations called in function.

See also: flecs::world::defer_begin(); flecs::world::defer_end(); flecs::world::is_deferred(); flecs::world::defer_resume(); flecs::world::defer_suspend()

Definition at line 1322 of file world.hpp.

◆ defer_begin()

bool flecs::world::defer_begin ( ) const

inline

Defer operations until end of frame.

When this operation is invoked while iterating, operations in between the defer_begin() and defer_end() operations are executed at the end of the frame.

This operation is thread-safe.

Returns: true if world changed from non-deferred mode to deferred mode.

See also: ecs_defer_begin(); flecs::world::defer(); flecs::world::defer_end(); flecs::world::is_deferred(); flecs::world::defer_resume(); flecs::world::defer_suspend(); flecs::world::is_defer_suspended()

Definition at line 453 of file world.hpp.

◆ defer_end()

bool flecs::world::defer_end ( ) const

inline

End block of operations to defer.

See defer_begin().

This operation is thread-safe.

Returns: true if world changed from deferred mode to non-deferred mode.

See also: ecs_defer_end(); flecs::world::defer(); flecs::world::defer_begin(); flecs::world::is_deferred(); flecs::world::defer_resume(); flecs::world::defer_suspend(); flecs::world::is_defer_suspended()

Definition at line 472 of file world.hpp.

◆ defer_resume()

void flecs::world::defer_resume ( ) const

inline

Resume deferring operations.

See also: ecs_defer_resume(); flecs::world::defer(); flecs::world::defer_begin(); flecs::world::defer_end(); flecs::world::is_deferred(); flecs::world::defer_suspend()

Definition at line 1350 of file world.hpp.

◆ defer_suspend()

void flecs::world::defer_suspend ( ) const

inline

Suspend deferring operations.

See also: ecs_defer_suspend(); flecs::world::defer(); flecs::world::defer_begin(); flecs::world::defer_end(); flecs::world::is_deferred(); flecs::world::defer_resume()

Definition at line 1337 of file world.hpp.

◆ delete_with() [1/5]

template<typename T >

void flecs::world::delete_with ( ) const

inline

Delete all entities with specified component.

Definition at line 1269 of file world.hpp.

◆ delete_with() [2/5]

template<typename First , typename Second >

void flecs::world::delete_with ( ) const

inline

Delete all entities with specified pair.

Definition at line 1275 of file world.hpp.

◆ delete_with() [3/5]

void flecs::world::delete_with	(	entity_t	first,
		entity_t	second ) const

inline

Delete all entities with specified pair.

Definition at line 1263 of file world.hpp.

◆ delete_with() [4/5]

template<typename First >

void flecs::world::delete_with ( entity_t second ) const

inline

Delete all entities with specified pair.

Definition at line 1281 of file world.hpp.

◆ delete_with() [5/5]

void flecs::world::delete_with ( id_t the_id ) const

inline

Delete all entities with specified id.

Definition at line 1258 of file world.hpp.

◆ delta_time()

ecs_ftime_t flecs::world::delta_time ( ) const

inline

Get delta_time.

Definition at line 1427 of file world.hpp.

◆ dim()

void flecs::world::dim ( int32_t entity_count ) const

inline

Preallocate memory for a number of entities.

This function preallocates memory for the entity index.

Parameters

entity_count Number of entities to preallocate memory for.

See also: ecs_dim()

Definition at line 705 of file world.hpp.

◆ emplace()

template<typename T , typename ... Args>

void flecs::world::emplace ( Args &&... args ) const

inline

Definition at line 828 of file world.hpp.

◆ enable_range_check()

void flecs::world::enable_range_check ( bool enabled = true ) const

inline

Enforce that operations cannot modify entities outside of range.

This function ensures that only entities within the specified range can be modified. Use this function if specific parts of the code only are allowed to modify a certain set of entities, as could be the case for networked applications.

Parameters

enabled True if range check should be enabled, false if not.

See also: ecs_enable_range_check()

Definition at line 731 of file world.hpp.

◆ ensure()

template<typename T >

T & flecs::world::ensure ( ) const

inline

Ensure singleton component.

Ensure a singleton component exists and return a mutable reference.

Definition at line 110 of file world.hpp.

◆ exclusive_access_begin()

void flecs::world::exclusive_access_begin ( const char * thread_name = nullptr )

inline

Begin exclusive access.

Parameters

thread_name Optional thread name for improved debug messages.

See also: ecs_exclusive_access_begin()

Definition at line 1444 of file world.hpp.

◆ exclusive_access_end()

void flecs::world::exclusive_access_end ( bool lock_world = false )

inline

End exclusive access.

Parameters

lock_world Lock world for all threads, allow readonly operations.

See also: ecs_exclusive_access_end()

Definition at line 1453 of file world.hpp.

◆ exists()

bool flecs::world::exists ( flecs::entity_t e ) const

inline

Check if entity ID exists in the world.

See also: ecs_exists(); flecs::world::is_alive(); flecs::world::is_valid()

Definition at line 1360 of file world.hpp.

◆ frame_begin()

ecs_ftime_t flecs::world::frame_begin ( float delta_time = 0 ) const

inline

Begin frame.

When an application does not use progress() to control the main loop, it can still use Flecs features such as FPS limiting and time measurements. This operation needs to be invoked whenever a new frame is about to get processed.

Calls to frame_begin() must always be followed by frame_end().

The function accepts a delta_time parameter, which will get passed to systems. This value is also used to compute the amount of time the function needs to sleep to ensure it does not exceed the target_fps, when it is set. When 0 is provided for delta_time, the time will be measured.

This function should only be run from the main thread.

Parameters

delta_time Time elapsed since the last frame.

Returns: The provided delta_time, or measured time if 0 was provided.

See also: ecs_frame_begin(); flecs::world::frame_end()

Definition at line 396 of file world.hpp.

◆ frame_end()

void flecs::world::frame_end ( ) const

inline

End frame.

This operation must be called at the end of the frame, and always after frame_begin().

This function should only be run from the main thread.

See also: ecs_frame_end(); flecs::world::frame_begin()

Definition at line 409 of file world.hpp.

◆ get() [1/6]

template<typename T >

const T & flecs::world::get ( ) const

inline

Get a singleton component.

Definition at line 191 of file world.hpp.

◆ get() [2/6]

template<typename First , typename Second , typename P , typename A >

const A & flecs::world::get ( ) const

inline

Get singleton pair.

Get a singleton pair component.

Definition at line 198 of file world.hpp.

◆ get() [3/6]

template<typename Func , if_t< is_callable< Func >::value > >

void flecs::world::get ( const Func & func ) const

inline

Get singleton component inside a callback.

Get a singleton component using a callback.

Definition at line 412 of file world.hpp.

◆ get() [4/6]

const void * flecs::world::get	(	flecs::entity_t	r,
		flecs::entity_t	t ) const

inline

Get singleton component.

Get a singleton pair component value by first and second IDs.

Definition at line 184 of file world.hpp.

◆ get() [5/6]

const void * flecs::world::get ( flecs::id_t id ) const

inline

Get singleton component.

Get a singleton component value by component ID.

Definition at line 178 of file world.hpp.

◆ get() [6/6]

template<typename First , typename Second >

const First & flecs::world::get ( Second second ) const

Get singleton pair.

Get a singleton pair component by second entity.

Definition at line 205 of file world.hpp.

◆ get_alive()

flecs::entity flecs::world::get_alive ( flecs::entity_t e ) const

inline

Get alive entity for ID.

Get an alive entity from an ID.

Return the entity with the current generation.

See also: ecs_get_alive()

Definition at line 427 of file world.hpp.

◆ get_binding_ctx()

void * flecs::world::get_binding_ctx ( ) const

inline

Get world binding context.

This operation retrieves a previously set world binding context.

Returns: The context set with set_binding_ctx(). If no context was set, the function returns NULL.

See also: ecs_get_binding_ctx(); flecs::world::set_binding_ctx()

Definition at line 694 of file world.hpp.

◆ get_ctx()

void * flecs::world::get_ctx ( ) const

inline

Get world context.

This operation retrieves a previously set world context.

Returns: The context set with set_ctx(). If no context was set, the function returns NULL.

See also: ecs_get_ctx(); flecs::world::set_ctx()

Definition at line 666 of file world.hpp.

◆ get_info()

const flecs::world_info_t * flecs::world::get_info ( ) const

inline

Get the world info.

See also: ecs_get_world_info()

Definition at line 1422 of file world.hpp.

◆ get_mut() [1/5]

template<typename T >

T & flecs::world::get_mut ( ) const

inline

Get a mutable singleton component.

Definition at line 257 of file world.hpp.

◆ get_mut() [2/5]

template<typename First , typename Second , typename P , typename A >

A & flecs::world::get_mut ( ) const

inline

Get mutable singleton pair.

Get a mutable singleton pair component.

Definition at line 264 of file world.hpp.

◆ get_mut() [3/5]

void * flecs::world::get_mut	(	flecs::entity_t	r,
		flecs::entity_t	t ) const

inline

Get mutable singleton pair.

Get a mutable singleton pair component by first and second IDs.

Definition at line 250 of file world.hpp.

◆ get_mut() [4/5]

void * flecs::world::get_mut ( flecs::id_t id ) const

inline

Get mutable singleton component.

Get a mutable singleton component by ID.

Definition at line 244 of file world.hpp.

◆ get_mut() [5/5]

template<typename First , typename Second >

First & flecs::world::get_mut ( Second second ) const

inline

Get mutable singleton pair.

Get a mutable singleton pair component by second entity.

Definition at line 271 of file world.hpp.

◆ get_ref()

template<typename T >

ref< T > flecs::world::get_ref ( ) const

inline

Get ref singleton component.

Get a ref for a singleton component.

Definition at line 139 of file world.hpp.

◆ get_scope()

flecs::entity flecs::world::get_scope ( ) const

inline

Get current scope.

Get the current scope.

Returns: The current scope.

See also: ecs_get_scope(); flecs::world::set_scope()

Definition at line 91 of file world.hpp.

◆ get_stage()

flecs::world flecs::world::get_stage ( int32_t stage_id ) const

inline

Get stage-specific world pointer.

Flecs threads can safely invoke the API as long as they have a private context to write to, also referred to as the stage. This function returns a pointer to a stage, disguised as a world pointer.

Note that this function does not(!) create a new world. It simply wraps the existing world in a thread-specific context, which the API knows how to unwrap. The reason the stage is returned as an ecs_world_t is so that it can be passed transparently to the existing API functions, vs. having to create a dedicated API for threading.

Parameters

stage_id The index of the stage to retrieve.

Returns: A thread-specific pointer to the world.

Definition at line 592 of file world.hpp.

◆ get_stage_count()

int32_t flecs::world::get_stage_count ( ) const

inline

Get the number of configured stages.

Return the number of stages set by set_stage_count().

Returns: The number of stages used for threading.

See also: ecs_get_stage_count(); flecs::world::set_stage_count()

Definition at line 535 of file world.hpp.

◆ get_stage_id()

int32_t flecs::world::get_stage_id ( ) const

inline

Get current stage ID.

The stage ID can be used by an application to learn about which stage it is using, which typically corresponds with the worker thread ID.

Returns: The stage ID.

Definition at line 545 of file world.hpp.

◆ get_version()

uint32_t flecs::world::get_version ( flecs::entity_t e ) const

inline

Get the version of the provided entity.

See also: ecs_get_version()

Definition at line 1409 of file world.hpp.

◆ get_world()

flecs::world flecs::world::get_world ( ) const

inline

Get actual world.

If the current object points to a stage, this operation will return the actual world.

Returns: The actual world.

Definition at line 623 of file world.hpp.

◆ has() [1/5]

template<typename T >

bool flecs::world::has ( ) const

inline

Test if world has singleton component.

Check for singleton component.

Template Parameters

T	The component to check.

Returns: Whether the world has the singleton component.

Definition at line 278 of file world.hpp.

◆ has() [2/5]

template<typename First , typename Second >

bool flecs::world::has ( ) const

inline

Test if world has the provided pair.

Check for singleton pair component.

Template Parameters

First	The first element of the pair.
Second	The second element of the pair.

Returns: Whether the world has the singleton pair.

Definition at line 285 of file world.hpp.

◆ has() [3/5]

template<typename E , if_t< is_enum< E >::value > >

bool flecs::world::has ( E value ) const

inline

Check for enum singleton constant.

Check for singleton enum constant.

Template Parameters

E	The enum type.

Parameters

value The enum constant to check.

Returns: Whether the world has the specified enum constant.

Definition at line 305 of file world.hpp.

◆ has() [4/5]

bool flecs::world::has	(	flecs::id_t	first,
		flecs::id_t	second ) const

inline

Test if world has the provided pair.

Check for singleton pair by entity IDs.

Parameters

first	The first element of the pair.
second	The second element of the pair.

Returns: Whether the world has the singleton pair.

Definition at line 298 of file world.hpp.

◆ has() [5/5]

template<typename First >

bool flecs::world::has ( flecs::id_t second ) const

inline

Test if world has the provided pair.

Check for singleton pair component.

Template Parameters

First The first element of the pair.

Parameters

second The second element of the pair.

Returns: Whether the world has the singleton pair.

Definition at line 292 of file world.hpp.

◆ id() [1/2]

template<typename T >

flecs::id flecs::world::id ( ) const

inline

Definition at line 70 of file impl.hpp.

◆ id() [2/2]

template<typename ... Args>

flecs::id flecs::world::id ( Args &&... args ) const

inline

Definition at line 75 of file impl.hpp.

◆ id_if_registered()

template<typename T >

flecs::id_t flecs::world::id_if_registered ( )

inline

Return the component ID if it has been registered.

This operation is similar to world::id(), but will never automatically register the component.

Template Parameters

T	The type for which to obtain the ID.

Definition at line 1464 of file world.hpp.

◆ init_builtin_components()

void flecs::world::init_builtin_components ( )

inline

Initialize built-in components.

Definition at line 12 of file world.hpp.

◆ is_alive()

bool flecs::world::is_alive ( flecs::entity_t e ) const

inline

Check if entity is alive.

See also: ecs_is_alive(); flecs::world::exists(); flecs::world::is_valid()

Definition at line 1370 of file world.hpp.

◆ is_defer_suspended()

bool flecs::world::is_defer_suspended ( ) const

inline

Test whether deferring is suspended.

Returns: True if defer is suspended, false if not.

See also: ecs_is_defer_suspended(); flecs::world::defer(); flecs::world::defer_begin(); flecs::world::defer_end(); flecs::world::is_deferred(); flecs::world::defer_resume(); flecs::world::defer_suspend()

Definition at line 504 of file world.hpp.

◆ is_deferred()

bool flecs::world::is_deferred ( ) const

inline

Test whether deferring is enabled.

Returns: True if deferred, false if not.

See also: ecs_is_deferred(); flecs::world::defer(); flecs::world::defer_begin(); flecs::world::defer_end(); flecs::world::defer_resume(); flecs::world::defer_suspend(); flecs::world::is_defer_suspended()

Definition at line 488 of file world.hpp.

◆ is_readonly()

bool flecs::world::is_readonly ( ) const

inline

Test whether the current world object is readonly.

This function allows the code to test whether the currently used world object is readonly or whether it allows for writing.

Returns: True if the world or stage is readonly.

See also: ecs_stage_is_readonly(); flecs::world::readonly_begin(); flecs::world::readonly_end()

Definition at line 639 of file world.hpp.

◆ is_stage()

bool flecs::world::is_stage ( ) const

inline

Test if this is a stage.

If this function returns false, it is guaranteed that this is a valid world object.

Returns: True if the world is a stage, false if not.

Definition at line 555 of file world.hpp.

◆ is_valid()

bool flecs::world::is_valid ( flecs::entity_t e ) const

inline

Check if entity ID is valid.

Invalid entities cannot be used with API functions.

See also: ecs_is_valid(); flecs::world::exists(); flecs::world::is_alive()

Definition at line 1381 of file world.hpp.

◆ lookup()

entity flecs::world::lookup	(	const char *	name,
		const char *	sep = "::",
		const char *	root_sep = "::",
		bool	recursive = true ) const

inline

Lookup entity by name.

Look up an entity by name.

Parameters

name	Entity name.
sep	The scope separator.
root_sep	The root scope separator.
recursive	When false, only the current scope is searched.

Returns: The entity if found, or 0 if not found.

Definition at line 102 of file world.hpp.

◆ make_alive()

flecs::entity flecs::world::make_alive ( flecs::entity_t e ) const

inline

Ensure an entity ID is alive.

See also: ecs_make_alive()

Definition at line 433 of file world.hpp.

◆ make_owner()

void flecs::world::make_owner ( )

inline

Make the current world object the owner of the world.

This may only be called on one flecs::world object, and may only be called once. Failing to do so will result in undefined behavior.

This operation allows a custom (C) world to be wrapped by a C++ object, and transfer ownership so that the world is automatically cleaned up.

Definition at line 336 of file world.hpp.

◆ merge()

void flecs::world::merge ( ) const

inline

Merge world or stage.

When automatic merging is disabled, an application can call this operation on either an individual stage, or on the world which will merge all stages. This operation may only be called when staging is not enabled (either after progress() or after readonly_end()).

This operation may be called on an already merged stage or world.

See also: ecs_merge()

Definition at line 574 of file world.hpp.

◆ modified()

template<typename T >

void flecs::world::modified ( ) const

inline

Mark singleton component as modified.

Mark a singleton component as modified.

Definition at line 118 of file world.hpp.

◆ operator world_t *()

flecs::world::operator world_t * ( ) const

inline

Implicit conversion to world_t*.

Definition at line 327 of file world.hpp.

◆ operator=() [1/2]

world & flecs::world::operator= ( const world & obj )

inlinenoexcept

Copy assignment operator.

Increases reference count on the world.

Definition at line 280 of file world.hpp.

◆ operator=() [2/2]

world & flecs::world::operator= ( world && obj )

inlinenoexcept

Move assignment operator.

Transfers world ownership.

Definition at line 294 of file world.hpp.

◆ quit()

void flecs::world::quit ( ) const

inline

Signal application should quit.

After calling this operation, the next call to progress() returns false.

Definition at line 359 of file world.hpp.

◆ readonly_begin()

bool flecs::world::readonly_begin ( bool multi_threaded = false ) const

inline

Begin readonly mode.

Parameters

multi_threaded Whether to enable readonly/multi-threaded mode.

Returns: Whether world is currently readonly.

See also: ecs_readonly_begin(); flecs::world::is_readonly(); flecs::world::readonly_end()

Definition at line 423 of file world.hpp.

◆ readonly_end()

void flecs::world::readonly_end ( ) const

inline

End readonly mode.

See also: ecs_readonly_end(); flecs::world::is_readonly(); flecs::world::readonly_begin()

Definition at line 433 of file world.hpp.

◆ release()

void flecs::world::release ( )

inline

Release the underlying world object.

If this is the last handle, the world will be finalized.

Definition at line 304 of file world.hpp.

◆ remove() [1/4]

template<typename T >

void flecs::world::remove ( ) const

inline

Remove singleton component.

Remove a singleton component.

Definition at line 346 of file world.hpp.

◆ remove() [2/4]

template<typename First , typename Second >

void flecs::world::remove ( ) const

inline

Remove the pair singleton component.

Remove a singleton pair component.

Template Parameters

First	The first element of the pair.
Second	The second element of the pair.

Definition at line 353 of file world.hpp.

◆ remove() [3/4]

void flecs::world::remove	(	flecs::entity_t	first,
		flecs::entity_t	second ) const

inline

Remove the pair singleton component.

Remove a singleton pair by entity IDs.

Parameters

first	The first element of the pair.
second	The second element of the pair.

Definition at line 366 of file world.hpp.

◆ remove() [4/4]

template<typename First >

void flecs::world::remove ( flecs::entity_t second ) const

inline

Remove the pair singleton component.

Remove a singleton pair component by second entity.

Template Parameters

First The first element of the pair.

Parameters

second The second element of the pair.

Definition at line 360 of file world.hpp.

◆ remove_all() [1/5]

template<typename T >

void flecs::world::remove_all ( ) const

inline

Remove all instances of specified component.

Definition at line 1297 of file world.hpp.

◆ remove_all() [2/5]

template<typename First , typename Second >

void flecs::world::remove_all ( ) const

inline

Remove all instances of specified pair.

Definition at line 1303 of file world.hpp.

◆ remove_all() [3/5]

void flecs::world::remove_all	(	entity_t	first,
		entity_t	second ) const

inline

Remove all instances of specified pair.

Definition at line 1291 of file world.hpp.

◆ remove_all() [4/5]

template<typename First >

void flecs::world::remove_all ( entity_t second ) const

inline

Remove all instances of specified pair.

Definition at line 1309 of file world.hpp.

◆ remove_all() [5/5]

void flecs::world::remove_all ( id_t the_id ) const

inline

Remove all instances of specified id.

Definition at line 1286 of file world.hpp.

◆ reset()

void flecs::world::reset ( )

inline

Delete and recreate the world.

Definition at line 341 of file world.hpp.

◆ run_post_frame()

void flecs::world::run_post_frame	(	ecs_fini_action_t	action,
		void *	ctx ) const

inline

Run callback after completing the frame.

Definition at line 1414 of file world.hpp.

◆ scope() [1/5]

template<typename T >

flecs::scoped_world flecs::world::scope ( ) const

inline

Use the provided scope (by type) for operations run on the returned world.

Definition at line 484 of file world.hpp.

◆ scope() [2/5]

flecs::scoped_world flecs::world::scope ( const char * name ) const

inline

Use the provided scope (by name) for operations run on the returned world.

Definition at line 490 of file world.hpp.

◆ scope() [3/5]

template<typename T , typename Func >

void flecs::world::scope ( const Func & func ) const

inline

Same as scope(parent, func), but with T as parent.

Definition at line 1242 of file world.hpp.

◆ scope() [4/5]

flecs::scoped_world flecs::world::scope ( id_t parent ) const

inline

Use the provided scope for operations run on the returned world.

Operations need to be run in a single statement.

Definition at line 478 of file world.hpp.

◆ scope() [5/5]

template<typename Func >

void flecs::world::scope	(	id_t	parent,
		const Func &	func ) const

inline

All entities created in the function are created in the scope.

All operations called in the function (such as lookup()) are relative to the scope.

Definition at line 1233 of file world.hpp.

◆ set() [1/7]

template<typename First , typename Second , typename P = flecs::pair<First, Second>, typename A = actual_type_t<P>, if_not_t< flecs::is_pair< First >::value > = 0>

void flecs::world::set ( A && value ) const

inline

Set singleton pair.

Definition at line 808 of file world.hpp.

◆ set() [2/7]

template<typename First , typename Second , typename P = flecs::pair<First, Second>, typename A = actual_type_t<P>, if_not_t< flecs::is_pair< First >::value > = 0>

void flecs::world::set ( const A & value ) const

inline

Set singleton pair.

Definition at line 800 of file world.hpp.

◆ set() [3/7]

template<typename Func , if_t< is_callable< Func >::value > >

void flecs::world::set ( const Func & func ) const

inline

Set singleton component inside a callback.

Set a singleton component using a callback.

Definition at line 420 of file world.hpp.

◆ set() [4/7]

template<typename T , if_t< !is_callable< T >::value > = 0>

void flecs::world::set ( const T & value ) const

inline

Set singleton component.

Definition at line 784 of file world.hpp.

◆ set() [5/7]

template<typename First , typename Second >

void flecs::world::set	(	Second	second,
		const First &	value ) const

inline

Set singleton pair.

Set a pair component value on a singleton.

Definition at line 125 of file world.hpp.

◆ set() [6/7]

template<typename First , typename Second >

void flecs::world::set	(	Second	second,
		First &&	value ) const

inline

Set singleton pair.

Set a pair component value on a singleton (move).

Definition at line 132 of file world.hpp.

◆ set() [7/7]

template<typename T , if_t< !is_callable< T >::value > = 0>

void flecs::world::set ( T && value ) const

inline

Set singleton component.

Definition at line 791 of file world.hpp.

◆ set_binding_ctx()

void flecs::world::set_binding_ctx	(	void *	ctx,
		ecs_ctx_free_t	ctx_free = nullptr ) const

inline

Set world binding context.

Same as set_ctx() but for binding context. A binding context is intended specifically for language bindings to store binding-specific data.

Parameters

ctx	A pointer to a user-defined structure.
ctx_free	A function that is invoked with ctx when the world is freed.

See also: ecs_set_binding_ctx(); flecs::world::get_binding_ctx()

Definition at line 681 of file world.hpp.

◆ set_ctx()

void flecs::world::set_ctx	(	void *	ctx,
		ecs_ctx_free_t	ctx_free = nullptr ) const

inline

Set world context.

Set a context value that can be accessed by anyone that has a reference to the world.

Parameters

ctx	A pointer to a user-defined structure.
ctx_free	A function that is invoked with ctx when the world is freed.

See also: ecs_set_ctx(); flecs::world::get_ctx()

Definition at line 653 of file world.hpp.

◆ set_entity_range()

void flecs::world::set_entity_range	(	entity_t	min,
		entity_t	max ) const

inline

Set entity range.

This function limits the range of issued entity IDs between min and max.

Parameters

min	Minimum entity ID issued.
max	Maximum entity ID issued.

See also: ecs_set_entity_range()

Definition at line 717 of file world.hpp.

◆ set_lookup_path()

flecs::entity_t * flecs::world::set_lookup_path ( const flecs::entity_t * search_path ) const

inline

Set search path.

See also: ecs_set_lookup_path(); flecs::world::lookup()

Definition at line 767 of file world.hpp.

◆ set_scope() [1/2]

template<typename T >

flecs::entity flecs::world::set_scope ( ) const

inline

Same as set_scope(), but with type.

Set the current scope to a type.

See also: ecs_set_scope(); flecs::world::get_scope()

Definition at line 97 of file world.hpp.

◆ set_scope() [2/2]

flecs::entity flecs::world::set_scope ( const flecs::entity_t scope ) const

inline

Set current scope.

Set the current scope.

Parameters

scope The scope to set.

Returns: The previous scope.

See also: ecs_set_scope(); flecs::world::get_scope()

Definition at line 86 of file world.hpp.

◆ set_stage_count()

void flecs::world::set_stage_count ( int32_t stages ) const

inline

Configure world to have N stages.

This initializes N stages, which allows applications to defer operations to multiple isolated defer queues. This is typically used for applications with multiple threads, where each thread gets its own queue, and commands are merged when threads are synchronized.

Note that set_threads() already creates the appropriate number of stages. The set_stage_count() operation is useful for applications that want to manage their own stages and/or threads.

Parameters

stages The number of stages.

See also: ecs_set_stage_count(); flecs::world::get_stage_count()

Definition at line 523 of file world.hpp.

◆ set_version()

void flecs::world::set_version ( flecs::entity_t e ) const

inline

Set the version of an entity to the provided value.

See also: ecs_set_version()

Definition at line 1401 of file world.hpp.

◆ should_quit()

bool flecs::world::should_quit ( ) const

inline

Test if quit() has been called.

Definition at line 371 of file world.hpp.

◆ shrink()

void flecs::world::shrink ( ) const

inline

Free unused memory.

See also: ecs_shrink()

Definition at line 1435 of file world.hpp.

◆ singleton()

template<typename T >

flecs::entity flecs::world::singleton ( ) const

inline

Get singleton entity for type.

Get the singleton entity for a component type.

Definition at line 379 of file world.hpp.

◆ target() [1/3]

template<typename T >

flecs::entity flecs::world::target	(	flecs::entity_t	first,
		int32_t	index = 0 ) const

inline

Get target for a given pair from a singleton entity.

Get the target entity for a relationship on a component entity.

This operation returns the target for a given pair. The optional index can be used to iterate through targets, in case the entity has multiple instances for the same relationship.

Template Parameters

T	The singleton type.

Parameters

first	The first element of the pair for which to retrieve the target.
index	The index (0 for the first instance of the relationship).

Returns: The target entity.

Definition at line 393 of file world.hpp.

◆ target() [2/3]

flecs::entity flecs::world::target	(	flecs::entity_t	first,
		int32_t	index = 0 ) const

inline

Get target for a given pair from a singleton entity.

Get the target entity for a relationship.

This operation returns the target for a given pair. The optional index can be used to iterate through targets, in case the entity has multiple instances for the same relationship.

Parameters

first	The first element of the pair for which to retrieve the target.
index	The index (0 for the first instance of the relationship).

Returns: The target entity.

Definition at line 402 of file world.hpp.

◆ target() [3/3]

template<typename First >

flecs::entity flecs::world::target ( int32_t index = 0 ) const

inline

Get target for a given pair from a singleton entity.

Get the target entity for a relationship on a singleton.

This operation returns the target for a given pair. The optional index can be used to iterate through targets, in case the entity has multiple instances for the same relationship.

Template Parameters

First The first element of the pair.

Parameters

index The index (0 for the first instance of the relationship).

Returns: The target entity.

Definition at line 385 of file world.hpp.

◆ try_get() [1/5]

template<typename T >

const T * flecs::world::try_get ( ) const

inline

Get singleton component.

Try to get a singleton component (returns nullptr if not found).

Definition at line 158 of file world.hpp.

◆ try_get() [2/5]

template<typename First , typename Second , typename P , typename A >

const A * flecs::world::try_get ( ) const

inline

Get singleton pair.

Try to get a singleton pair component (returns nullptr if not found).

Definition at line 165 of file world.hpp.

◆ try_get() [3/5]

const void * flecs::world::try_get	(	flecs::entity_t	r,
		flecs::entity_t	t ) const

inline

Get singleton pair.

Try to get a singleton pair value by first and second IDs (returns nullptr if not found).

Definition at line 151 of file world.hpp.

◆ try_get() [4/5]

const void * flecs::world::try_get ( flecs::id_t id ) const

inline

Get singleton component.

Try to get a singleton value by component ID (returns nullptr if not found).

Definition at line 145 of file world.hpp.

◆ try_get() [5/5]

template<typename First , typename Second >

const First * flecs::world::try_get ( Second second ) const

inline

Get singleton pair.

Try to get a singleton pair component by second entity (returns nullptr if not found).

Definition at line 172 of file world.hpp.

◆ try_get_mut() [1/5]

template<typename T >

T * flecs::world::try_get_mut ( ) const

inline

Try to get a mutable singleton component (returns nullptr if not found).

Definition at line 224 of file world.hpp.

◆ try_get_mut() [2/5]

template<typename First , typename Second , typename P , typename A >

A * flecs::world::try_get_mut ( ) const

inline

Get mutable singleton pair.

Try to get a mutable singleton pair component (returns nullptr if not found).

Definition at line 231 of file world.hpp.

◆ try_get_mut() [3/5]

void * flecs::world::try_get_mut	(	flecs::entity_t	r,
		flecs::entity_t	t ) const

inline

Get mutable singleton pair.

Try to get a mutable singleton pair component by first and second IDs (returns nullptr if not found).

Definition at line 217 of file world.hpp.

◆ try_get_mut() [4/5]

void * flecs::world::try_get_mut ( flecs::id_t id ) const

inline

Get mutable singleton component.

Try to get a mutable singleton component by ID (returns nullptr if not found).

Definition at line 211 of file world.hpp.

◆ try_get_mut() [5/5]

template<typename First , typename Second >

First * flecs::world::try_get_mut ( Second second ) const

inline

Get mutable singleton pair.

Try to get a mutable singleton pair component by second entity (returns nullptr if not found).

Definition at line 238 of file world.hpp.

◆ type_info() [1/5]

template<typename T >

const flecs::type_info_t * flecs::world::type_info ( )

inline

Return the type info.

Definition at line 1485 of file world.hpp.

◆ type_info() [2/5]

template<typename R , typename T >

const flecs::type_info_t * flecs::world::type_info ( )

inline

Return the type info.

Definition at line 1497 of file world.hpp.

◆ type_info() [3/5]

const flecs::type_info_t * flecs::world::type_info	(	flecs::entity_t	r,
		flecs::entity_t	t )

inline

Return the type info.

Definition at line 1479 of file world.hpp.

◆ type_info() [4/5]

template<typename R >

const flecs::type_info_t * flecs::world::type_info ( flecs::entity_t t )

inline

Return the type info.

Definition at line 1491 of file world.hpp.

◆ type_info() [5/5]

const flecs::type_info_t * flecs::world::type_info ( flecs::id_t component )

inline

Return the type info.

Definition at line 1474 of file world.hpp.

◆ use() [1/3]

template<typename T >

flecs::entity flecs::world::use ( const char * alias = nullptr ) const

inline

Create an alias for a component.

Import a type (entity/component) as an alias.

Template Parameters

T	The type to create an alias for.

Parameters

alias Alias for the component.

Returns: Entity representing the component.

Definition at line 54 of file world.hpp.

◆ use() [2/3]

flecs::entity flecs::world::use	(	const char *	name,
		const char *	alias = nullptr ) const

inline

Create an alias for an entity.

Import an entity by name as an alias.

Parameters

name	Name of the entity.
alias	Alias for the entity.

Definition at line 66 of file world.hpp.

◆ use() [3/3]

void flecs::world::use	(	flecs::entity	entity,
		const char *	alias = nullptr ) const

inline

Create an alias for an entity.

Import an entity as an alias.

Parameters

entity	Entity for which to create the alias.
alias	Alias for the entity.

Definition at line 75 of file world.hpp.

◆ with() [1/5]

template<typename T , typename Func >

void flecs::world::with ( const Func & func ) const

inline

All entities created in the function are created with the type.

Definition at line 1204 of file world.hpp.

◆ with() [2/5]

template<typename First , typename Second , typename Func >

void flecs::world::with ( const Func & func ) const

inline

All entities created in the function are created with the pair.

Definition at line 1211 of file world.hpp.

◆ with() [3/5]

template<typename Func >

void flecs::world::with	(	id_t	first,
		id_t	second,
		const Func &	func ) const

inline

All entities created in the function are created with the pair.

Definition at line 1225 of file world.hpp.

◆ with() [4/5]

template<typename First , typename Func >

void flecs::world::with	(	id_t	second,
		const Func &	func ) const

inline

All entities created in the function are created with the pair.

Definition at line 1218 of file world.hpp.

◆ with() [5/5]

template<typename Func >

void flecs::world::with	(	id_t	with_id,
		const Func &	func ) const

inline

All entities created in the function are created with the ID.

Definition at line 1195 of file world.hpp.

Member Data Documentation

◆ world_

world_t* flecs::world::world_

Pointer to the underlying C world.

Definition at line 1545 of file world.hpp.

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

include/flecs/addons/cpp/world.hpp
include/flecs/addons/cpp/impl/world.hpp
include/flecs/addons/cpp/mixins/alerts/mixin.inl
include/flecs/addons/cpp/mixins/app/mixin.inl
include/flecs/addons/cpp/mixins/component/mixin.inl
include/flecs/addons/cpp/mixins/entity/mixin.inl
include/flecs/addons/cpp/mixins/enum/mixin.inl
include/flecs/addons/cpp/mixins/event/mixin.inl
include/flecs/addons/cpp/mixins/id/impl.hpp
include/flecs/addons/cpp/mixins/id/mixin.inl
include/flecs/addons/cpp/mixins/json/world.inl
include/flecs/addons/cpp/mixins/meta/world.inl
include/flecs/addons/cpp/mixins/metrics/mixin.inl
include/flecs/addons/cpp/mixins/module/mixin.inl
include/flecs/addons/cpp/mixins/observer/mixin.inl
include/flecs/addons/cpp/mixins/pipeline/mixin.inl
include/flecs/addons/cpp/mixins/query/mixin.inl
include/flecs/addons/cpp/mixins/system/mixin.inl
include/flecs/addons/cpp/mixins/term/mixin.inl
include/flecs/addons/cpp/mixins/timer/mixin.inl

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ world() [1/5]

◆ world() [2/5]

◆ world() [3/5]

◆ world() [4/5]

◆ world() [5/5]

◆ ~world()

Member Function Documentation

◆ add() [1/5]

◆ add() [2/5]

◆ add() [3/5]

◆ add() [4/5]

◆ add() [5/5]

◆ async_stage()

◆ atfini()

◆ c_ptr()

◆ children()

◆ count() [1/5]

◆ count() [2/5]

◆ count() [3/5]

◆ count() [4/5]

◆ count() [5/5]

◆ defer()

◆ defer_begin()

◆ defer_end()

◆ defer_resume()

◆ defer_suspend()

◆ delete_with() [1/5]

◆ delete_with() [2/5]

◆ delete_with() [3/5]

◆ delete_with() [4/5]

◆ delete_with() [5/5]

◆ delta_time()

◆ dim()

◆ emplace()

◆ enable_range_check()

◆ ensure()

◆ exclusive_access_begin()

◆ exclusive_access_end()

◆ exists()

◆ frame_begin()

◆ frame_end()

◆ get() [1/6]

◆ get() [2/6]

◆ get() [3/6]

◆ get() [4/6]

◆ get() [5/6]

◆ get() [6/6]

◆ get_alive()

◆ get_binding_ctx()

◆ get_ctx()

◆ get_info()

◆ get_mut() [1/5]

◆ get_mut() [2/5]

◆ get_mut() [3/5]

◆ get_mut() [4/5]

◆ get_mut() [5/5]

◆ get_ref()

◆ get_scope()

◆ get_stage()

◆ get_stage_count()

◆ get_stage_id()

◆ get_version()

◆ get_world()

◆ has() [1/5]

◆ has() [2/5]

◆ has() [3/5]

◆ has() [4/5]

◆ has() [5/5]

◆ id() [1/2]

◆ id() [2/2]

◆ id_if_registered()

◆ init_builtin_components()

◆ is_alive()

◆ is_defer_suspended()

◆ is_deferred()

◆ is_readonly()