Fast and reliable entity-component system. More...

#include <registry.hpp>

Public Types
using	traits_type = typename base_type::traits_type
	Entity traits.

using	allocator_type = Allocator
	Allocator type.

using	entity_type = typename traits_type::value_type
	Underlying entity identifier.

using	version_type = typename traits_type::version_type
	Underlying version type.

using	size_type = std::size_t
	Unsigned integer type.

using	common_type = base_type
	Common type among all storage types.

using	context = internal::registry_context< allocator_type >
	Context type.

using	iterable = iterable_adaptor< internal::registry_storage_iterator< typename pool_container_type::iterator > >
	Iterable registry type.

using	const_iterable = iterable_adaptor< internal::registry_storage_iterator< typename pool_container_type::const_iterator > >
	Constant iterable registry type.

template<typename Type >
using	storage_for_type = typename storage_for< Type, Entity, typename alloc_traits::template rebind_alloc< std::remove_const_t< Type > > >::type

Public Member Functions
	basic_registry ()
	Default constructor.

	basic_registry (const allocator_type &allocator)
	Constructs an empty registry with a given allocator.

	basic_registry (const size_type count, const allocator_type &allocator=allocator_type{})
	Allocates enough memory upon construction to store `count` pools.

	basic_registry (basic_registry &&other) noexcept
	Move constructor.

basic_registry &	operator= (basic_registry &&other) noexcept
	Move assignment operator.

void	swap (basic_registry &other)
	Exchanges the contents with those of a given registry.

constexpr allocator_type	get_allocator () const noexcept
	Returns the associated allocator.

iterable	storage () noexcept
	Returns an iterable object to use to visit a registry.

const_iterable	storage () const noexcept
	Returns an iterable object to use to visit a registry.

common_type *	storage (const id_type id)
	Finds the storage associated with a given name, if any.

const common_type *	storage (const id_type id) const
	Finds the storage associated with a given name, if any.

template<typename Type >
storage_for_type< Type > &	storage (const id_type id=type_hash< Type >::value())
	Returns the storage for a given component type.

template<typename Type >
const storage_for_type< Type > *	storage (const id_type id=type_hash< Type >::value()) const
	Returns the storage for a given component type, if any.

bool	valid (const entity_type entt) const
	Checks if an identifier refers to a valid entity.

version_type	current (const entity_type entt) const
	Returns the actual version for an identifier.

entity_type	create ()
	Creates a new entity or recycles a destroyed one.

entity_type	create (const entity_type hint)
	Creates a new entity or recycles a destroyed one.

template<typename It >
void	create (It first, It last)
	Assigns each element in a range an identifier.

version_type	destroy (const entity_type entt)
	Destroys an entity and releases its identifier.

version_type	destroy (const entity_type entt, const version_type version)
	Destroys an entity and releases its identifier.

template<typename It >
void	destroy (It first, It last)
	Destroys all entities in a range and releases their identifiers.

template<typename Type , typename... Args>
decltype(auto)	emplace (const entity_type entt, Args &&...args)
	Assigns the given component to an entity.

template<typename Type , typename It >
void	insert (It first, It last, const Type &value={})
	Assigns each entity in a range the given component.

template<typename Type , typename EIt , typename CIt , typename = std::enable_if_t<std::is_same_v<typename std::iterator_traits<CIt>::value_type, Type>>>
void	insert (EIt first, EIt last, CIt from)
	Assigns each entity in a range the given components.

template<typename Type , typename... Args>
decltype(auto)	emplace_or_replace (const entity_type entt, Args &&...args)
	Assigns or replaces the given component for an entity.

template<typename Type , typename... Func>
decltype(auto)	patch (const entity_type entt, Func &&...func)
	Patches the given component for an entity.

template<typename Type , typename... Args>
decltype(auto)	replace (const entity_type entt, Args &&...args)
	Replaces the given component for an entity.

template<typename Type , typename... Other>
size_type	remove (const entity_type entt)
	Removes the given components from an entity.

template<typename Type , typename... Other, typename It >
size_type	remove (It first, It last)
	Removes the given components from all the entities in a range.

template<typename Type , typename... Other>
void	erase (const entity_type entt)
	Erases the given components from an entity.

template<typename Type , typename... Other, typename It >
void	erase (It first, It last)
	Erases the given components from all the entities in a range.

template<typename Func >
void	erase_if (const entity_type entt, Func func)
	Erases components satisfying specific criteria from an entity.

template<typename... Type>
void	compact ()
	Removes all tombstones from a registry or only the pools for the given components.

template<typename... Type>
bool	all_of (const entity_type entt) const
	Check if an entity is part of all the given storage.

template<typename... Type>
bool	any_of (const entity_type entt) const
	Check if an entity is part of at least one given storage.

template<typename... Type>
decltype(auto)	get (const entity_type entt) const
	Returns references to the given components for an entity.

template<typename... Type>
decltype(auto)	get (const entity_type entt)
	Returns references to the given components for an entity.

template<typename Type , typename... Args>
decltype(auto)	get_or_emplace (const entity_type entt, Args &&...args)
	Returns a reference to the given component for an entity.

template<typename... Type>
auto	try_get (const entity_type entt) const
	Returns pointers to the given components for an entity.

template<typename... Type>
auto	try_get (const entity_type entt)
	Returns pointers to the given components for an entity.

template<typename... Type>
void	clear ()
	Clears a whole registry or the pools for the given components.

bool	orphan (const entity_type entt) const
	Checks if an entity has components assigned.

template<typename Type >
auto	on_construct (const id_type id=type_hash< Type >::value())
	Returns a sink object for the given component.

template<typename Type >
auto	on_update (const id_type id=type_hash< Type >::value())
	Returns a sink object for the given component.

template<typename Type >
auto	on_destroy (const id_type id=type_hash< Type >::value())
	Returns a sink object for the given component.

template<typename Type , typename... Other, typename... Exclude>
basic_view< get_t< storage_for_type< const Type >, storage_for_type< const Other >... >, exclude_t< storage_for_type< const Exclude >... > >	view (exclude_t< Exclude... >=exclude_t{}) const
	Returns a view for the given components.

template<typename Type , typename... Other, typename... Exclude>
basic_view< get_t< storage_for_type< Type >, storage_for_type< Other >... >, exclude_t< storage_for_type< Exclude >... > >	view (exclude_t< Exclude... >=exclude_t{})
	Returns a view for the given components.

template<typename... Owned, typename... Get, typename... Exclude>
basic_group< owned_t< storage_for_type< Owned >... >, get_t< storage_for_type< Get >... >, exclude_t< storage_for_type< Exclude >... > >	group (get_t< Get... >=get_t{}, exclude_t< Exclude... >=exclude_t{})
	Returns a group for the given components.

template<typename... Owned, typename... Get, typename... Exclude>
basic_group< owned_t< storage_for_type< const Owned >... >, get_t< storage_for_type< const Get >... >, exclude_t< storage_for_type< const Exclude >... > >	group_if_exists (get_t< Get... >=get_t{}, exclude_t< Exclude... >=exclude_t{}) const
	Returns a group for the given components.

template<typename Type , typename... Other>
bool	owned () const
	Checks whether the given components belong to any group.

template<typename Type , typename Compare , typename Sort = std_sort, typename... Args>
void	sort (Compare compare, Sort algo=Sort{}, Args &&...args)
	Sorts the elements of a given component.

template<typename To , typename From >
void	sort ()
	Sorts two pools of components in the same way.

context &	ctx () noexcept
	Returns the context object, that is, a general purpose container.

const context &	ctx () const noexcept
	Returns the context object, that is, a general purpose container.

Detailed Description

template<typename Entity, typename Allocator>
class entt::basic_registry< Entity, Allocator >

Fast and reliable entity-component system.

Template Parameters

Entity	A valid entity type.
Allocator	Type of allocator used to manage memory and elements.

Definition at line 233 of file registry.hpp.

Member Typedef Documentation

◆ allocator_type

template<typename Entity , typename Allocator >

using entt::basic_registry< Entity, Allocator >::allocator_type = Allocator

Allocator type.

Definition at line 299 of file registry.hpp.

◆ common_type

template<typename Entity , typename Allocator >

using entt::basic_registry< Entity, Allocator >::common_type = base_type

Common type among all storage types.

Definition at line 307 of file registry.hpp.

◆ const_iterable

template<typename Entity , typename Allocator >

using entt::basic_registry< Entity, Allocator >::const_iterable = iterable_adaptor<internal::registry_storage_iterator<typename pool_container_type::const_iterator> >

Constant iterable registry type.

Definition at line 313 of file registry.hpp.

◆ context

template<typename Entity , typename Allocator >

using entt::basic_registry< Entity, Allocator >::context = internal::registry_context<allocator_type>

Context type.

Definition at line 309 of file registry.hpp.

◆ entity_type

template<typename Entity , typename Allocator >

using entt::basic_registry< Entity, Allocator >::entity_type = typename traits_type::value_type

Underlying entity identifier.

Definition at line 301 of file registry.hpp.

◆ iterable

template<typename Entity , typename Allocator >

using entt::basic_registry< Entity, Allocator >::iterable = iterable_adaptor<internal::registry_storage_iterator<typename pool_container_type::iterator> >

Iterable registry type.

Definition at line 311 of file registry.hpp.

◆ size_type

template<typename Entity , typename Allocator >

using entt::basic_registry< Entity, Allocator >::size_type = std::size_t

Unsigned integer type.

Definition at line 305 of file registry.hpp.

◆ storage_for_type

template<typename Entity , typename Allocator >

template<typename Type >

using entt::basic_registry< Entity, Allocator >::storage_for_type = typename storage_for<Type, Entity, typename alloc_traits::template rebind_alloc<std::remove_const_t<Type> >>::type

Template Parameters

Type	Storage value type, eventually const.

Definition at line 320 of file registry.hpp.

◆ traits_type

template<typename Entity , typename Allocator >

using entt::basic_registry< Entity, Allocator >::traits_type = typename base_type::traits_type

Entity traits.

Definition at line 297 of file registry.hpp.

◆ version_type

template<typename Entity , typename Allocator >

using entt::basic_registry< Entity, Allocator >::version_type = typename traits_type::version_type

Underlying version type.

Definition at line 303 of file registry.hpp.

Constructor & Destructor Documentation

◆ basic_registry() [1/4]

template<typename Entity , typename Allocator >

entt::basic_registry< Entity, Allocator >::basic_registry ( )

inline

Default constructor.

Definition at line 323 of file registry.hpp.

◆ basic_registry() [2/4]

template<typename Entity , typename Allocator >

entt::basic_registry< Entity, Allocator >::basic_registry ( const allocator_type & allocator )

inlineexplicit

Constructs an empty registry with a given allocator.

Parameters

allocator The allocator to use.

Definition at line 330 of file registry.hpp.

◆ basic_registry() [3/4]

template<typename Entity , typename Allocator >

entt::basic_registry< Entity, Allocator >::basic_registry	(	const size_type	count,
		const allocator_type &	allocator = `allocator_type{}`
	)

inline

Allocates enough memory upon construction to store count pools.

Parameters

count	The number of pools to allocate memory for.
allocator	The allocator to use.

Definition at line 338 of file registry.hpp.

◆ basic_registry() [4/4]

template<typename Entity , typename Allocator >

entt::basic_registry< Entity, Allocator >::basic_registry ( basic_registry< Entity, Allocator > && other )

inlinenoexcept

Move constructor.

Parameters

other The instance to move from.

Definition at line 351 of file registry.hpp.

Member Function Documentation

◆ all_of()

template<typename Entity , typename Allocator >

template<typename... Type>

bool entt::basic_registry< Entity, Allocator >::all_of ( const entity_type entt ) const

inline

Check if an entity is part of all the given storage.

Template Parameters

Type	Type of storage to check for.

Parameters

entt	A valid identifier.

Returns: True if the entity is part of all the storage, false otherwise.

Definition at line 833 of file registry.hpp.

◆ any_of()

template<typename Entity , typename Allocator >

template<typename... Type>

bool entt::basic_registry< Entity, Allocator >::any_of ( const entity_type entt ) const

inline

Check if an entity is part of at least one given storage.

Template Parameters

Type	Type of storage to check for.

Parameters

entt	A valid identifier.

Returns: True if the entity is part of at least one storage, false otherwise.

Definition at line 850 of file registry.hpp.

◆ clear()

template<typename Entity , typename Allocator >

template<typename... Type>

void entt::basic_registry< Entity, Allocator >::clear ( )

inline

Clears a whole registry or the pools for the given components.

Template Parameters

Type	Types of components to remove from their entities.

Definition at line 943 of file registry.hpp.

◆ compact()

template<typename Entity , typename Allocator >

template<typename... Type>

void entt::basic_registry< Entity, Allocator >::compact ( )

inline

Removes all tombstones from a registry or only the pools for the given components.

Template Parameters

Type	Types of components for which to clear all tombstones.

Definition at line 816 of file registry.hpp.

◆ create() [1/3]

template<typename Entity , typename Allocator >

entity_type entt::basic_registry< Entity, Allocator >::create ( )

inline

Creates a new entity or recycles a destroyed one.

Returns: A valid identifier.

Definition at line 480 of file registry.hpp.

◆ create() [2/3]

template<typename Entity , typename Allocator >

entity_type entt::basic_registry< Entity, Allocator >::create ( const entity_type hint )

inline

Creates a new entity or recycles a destroyed one.

If the requested entity isn't in use, the suggested identifier is used. Otherwise, a new identifier is generated.

Parameters

hint	Required identifier.

Returns: A valid identifier.

Definition at line 493 of file registry.hpp.

◆ create() [3/3]

template<typename Entity , typename Allocator >

template<typename It >

void entt::basic_registry< Entity, Allocator >::create	(	It	first,
		It	last
	)

inline

Assigns each element in a range an identifier.

See also: create

Template Parameters

It	Type of forward iterator.

Parameters

first	An iterator to the first element of the range to generate.
last	An iterator past the last element of the range to generate.

Definition at line 507 of file registry.hpp.

◆ ctx() [1/2]

template<typename Entity , typename Allocator >

const context & entt::basic_registry< Entity, Allocator >::ctx ( ) const

inlinenoexcept

Returns the context object, that is, a general purpose container.

Returns: The context object, that is, a general purpose container.

Definition at line 1191 of file registry.hpp.

◆ ctx() [2/2]

template<typename Entity , typename Allocator >

context & entt::basic_registry< Entity, Allocator >::ctx ( )

inlinenoexcept

Returns the context object, that is, a general purpose container.

Returns: The context object, that is, a general purpose container.

Definition at line 1186 of file registry.hpp.

◆ current()

template<typename Entity , typename Allocator >

version_type entt::basic_registry< Entity, Allocator >::current ( const entity_type entt ) const

inline

Returns the actual version for an identifier.

Parameters

entt	A valid identifier.

Returns: The version for the given identifier if valid, the tombstone version otherwise.

Definition at line 472 of file registry.hpp.

◆ destroy() [1/3]

template<typename Entity , typename Allocator >

version_type entt::basic_registry< Entity, Allocator >::destroy ( const entity_type entt )

inline

Destroys an entity and releases its identifier.

Warning: Adding or removing components to an entity that is being destroyed can result in undefined behavior.

Parameters

entt	A valid identifier.

Returns: The version of the recycled entity.

Definition at line 521 of file registry.hpp.

◆ destroy() [2/3]

template<typename Entity , typename Allocator >

version_type entt::basic_registry< Entity, Allocator >::destroy	(	const entity_type	entt,
		const version_type	version
	)

inline

Destroys an entity and releases its identifier.

The suggested version or the valid version closest to the suggested one is used instead of the implicitly generated version.

See also: destroy

Parameters

entt	A valid identifier.
version	A desired version upon destruction.

Returns: The version actually assigned to the entity.

Definition at line 542 of file registry.hpp.

◆ destroy() [3/3]

template<typename Entity , typename Allocator >

template<typename It >

void entt::basic_registry< Entity, Allocator >::destroy	(	It	first,
		It	last
	)

inline

Destroys all entities in a range and releases their identifiers.

See also: destroy

Template Parameters

It	Type of input iterator.

Parameters

first	An iterator to the first element of the range of entities.
last	An iterator past the last element of the range of entities.

Definition at line 558 of file registry.hpp.

◆ emplace()

template<typename Entity , typename Allocator >

template<typename Type , typename... Args>

decltype(auto) entt::basic_registry< Entity, Allocator >::emplace	(	const entity_type	entt,
		Args &&...	args
	)

inline

Assigns the given component to an entity.

The component must have a proper constructor or be of aggregate type.

Warning: Attempting to assign a component to an entity that already owns it results in undefined behavior.

Template Parameters

Type	Type of component to create.
Args	Types of arguments to use to construct the component.

Parameters

entt	A valid identifier.
args	Parameters to use to initialize the component.

Returns: A reference to the newly created component.

Definition at line 587 of file registry.hpp.

◆ emplace_or_replace()

template<typename Entity , typename Allocator >

template<typename Type , typename... Args>

decltype(auto) entt::basic_registry< Entity, Allocator >::emplace_or_replace	(	const entity_type	entt,
		Args &&...	args
	)

inline

Assigns or replaces the given component for an entity.

See also: emplace; replace

Template Parameters

Type	Type of component to assign or replace.
Args	Types of arguments to use to construct the component.

Parameters

entt	A valid identifier.
args	Parameters to use to initialize the component.

Returns: A reference to the newly created component.

Definition at line 637 of file registry.hpp.

◆ erase() [1/2]

template<typename Entity , typename Allocator >

template<typename Type , typename... Other>

void entt::basic_registry< Entity, Allocator >::erase ( const entity_type entt )

inline

Erases the given components from an entity.

Warning: Attempting to erase a component from an entity that doesn't own it results in undefined behavior.

Template Parameters

Type	Types of components to erase.
Other	Other types of components to erase.

Parameters

entt	A valid identifier.

Definition at line 750 of file registry.hpp.

◆ erase() [2/2]

template<typename Entity , typename Allocator >

template<typename Type , typename... Other, typename It >

void entt::basic_registry< Entity, Allocator >::erase	(	It	first,
		It	last
	)

inline

Erases the given components from all the entities in a range.

See also: erase

Template Parameters

Type	Types of components to erase.
Other	Other types of components to erase.
It	Type of input iterator.

Parameters

first	An iterator to the first element of the range of entities.
last	An iterator past the last element of the range of entities.

Definition at line 766 of file registry.hpp.

◆ erase_if()

template<typename Entity , typename Allocator >

template<typename Func >

void entt::basic_registry< Entity, Allocator >::erase_if	(	const entity_type	entt,
		Func	func
	)

inline

Erases components satisfying specific criteria from an entity.

The function type is equivalent to:

void(const id_type, typename basic_registry<Entity>::base_type &);

entt::basic_sparse_set

Basic sparse set implementation.

Definition sparse_set.hpp:158

entt::id_type

std::uint32_t id_type

Alias declaration for type identifiers.

Definition fwd.hpp:13

Only storage where the entity exists are passed to the function.

Template Parameters

Func	Type of the function object to invoke.

Parameters

entt	A valid identifier.
func	A valid function object.

Definition at line 802 of file registry.hpp.

◆ get() [1/2]

template<typename Entity , typename Allocator >

template<typename... Type>

decltype(auto) entt::basic_registry< Entity, Allocator >::get ( const entity_type entt )

inline

Returns references to the given components for an entity.

Warning: Attempting to get a component from an entity that doesn't own it results in undefined behavior.

Template Parameters

Type	Types of components to get.

Parameters

entt	A valid identifier.

Returns: References to the components owned by the entity.

Definition at line 876 of file registry.hpp.

◆ get() [2/2]

template<typename Entity , typename Allocator >

template<typename... Type>

decltype(auto) entt::basic_registry< Entity, Allocator >::get ( const entity_type entt ) const

inline

Returns references to the given components for an entity.

Warning: Attempting to get a component from an entity that doesn't own it results in undefined behavior.

Template Parameters

Type	Types of components to get.

Parameters

entt	A valid identifier.

Returns: References to the components owned by the entity.

Definition at line 866 of file registry.hpp.

◆ get_allocator()

template<typename Entity , typename Allocator >

constexpr allocator_type entt::basic_registry< Entity, Allocator >::get_allocator ( ) const

inlineconstexprnoexcept

Returns the associated allocator.

Returns: The associated allocator.

Definition at line 395 of file registry.hpp.

◆ get_or_emplace()

template<typename Entity , typename Allocator >

template<typename Type , typename... Args>

decltype(auto) entt::basic_registry< Entity, Allocator >::get_or_emplace	(	const entity_type	entt,
		Args &&...	args
	)

inline

Returns a reference to the given component for an entity.

In case the entity doesn't own the component, the parameters provided are used to construct it.

See also: get; emplace

Template Parameters

Type	Type of component to get.
Args	Types of arguments to use to construct the component.

Parameters

entt	A valid identifier.
args	Parameters to use to initialize the component.

Returns: Reference to the component owned by the entity.

Definition at line 900 of file registry.hpp.

◆ group()

template<typename Entity , typename Allocator >

template<typename... Owned, typename... Get, typename... Exclude>

basic_group< owned_t< storage_for_type< Owned >... >, get_t< storage_for_type< Get >... >, exclude_t< storage_for_type< Exclude >... > > entt::basic_registry< Entity, Allocator >::group	(	get_t< Get... >	= `get_t{}`,
		exclude_t< Exclude... >	= `exclude_t{}`
	)

inline

Returns a group for the given components.

Template Parameters

Owned	Types of storage owned by the group.
Get	Types of storage observed by the group, if any.
Exclude	Types of storage used to filter the group, if any.

Returns: A newly created group.

Definition at line 1069 of file registry.hpp.

◆ group_if_exists()

template<typename Entity , typename Allocator >

template<typename... Owned, typename... Get, typename... Exclude>

basic_group< owned_t< storage_for_type< const Owned >... >, get_t< storage_for_type< const Get >... >, exclude_t< storage_for_type< const Exclude >... > > entt::basic_registry< Entity, Allocator >::group_if_exists	(	get_t< Get... >	= `get_t{}`,
		exclude_t< Exclude... >	= `exclude_t{}`
	)		const

inline

Returns a group for the given components.

Template Parameters

Owned	Types of storage owned by the group.
Get	Types of storage observed by the group, if any.
Exclude	Types of storage used to filter the group, if any.

Returns: A newly created group.

Definition at line 1093 of file registry.hpp.

◆ insert() [1/2]

template<typename Entity , typename Allocator >

template<typename Type , typename EIt , typename CIt , typename = std::enable_if_t<std::is_same_v<typename std::iterator_traits<CIt>::value_type, Type>>>

void entt::basic_registry< Entity, Allocator >::insert	(	EIt	first,
		EIt	last,
		CIt	from
	)

inline

Assigns each entity in a range the given components.

See also: emplace

Template Parameters

Type	Type of component to create.
EIt	Type of input iterator.
CIt	Type of input iterator.

Parameters

first	An iterator to the first element of the range of entities.
last	An iterator past the last element of the range of entities.
from	An iterator to the first element of the range of components.

Definition at line 620 of file registry.hpp.

◆ insert() [2/2]

template<typename Entity , typename Allocator >

template<typename Type , typename It >

void entt::basic_registry< Entity, Allocator >::insert	(	It	first,
		It	last,
		const Type &	value = `{}`
	)

inline

Assigns each entity in a range the given component.

See also: emplace

Template Parameters

Type	Type of component to create.
It	Type of input iterator.

Parameters

first	An iterator to the first element of the range of entities.
last	An iterator past the last element of the range of entities.
value	An instance of the component to assign.

Definition at line 603 of file registry.hpp.

◆ on_construct()

template<typename Entity , typename Allocator >

template<typename Type >

auto entt::basic_registry< Entity, Allocator >::on_construct ( const id_type id = type_hash<Type>::value() )

inline

Returns a sink object for the given component.

Use this function to receive notifications whenever a new instance of the given component is created and assigned to an entity.
The function type for a listener is equivalent to:

void(basic_registry<Entity> &, Entity);

entt::basic_registry

Fast and reliable entity-component system.

Definition registry.hpp:233

Listeners are invoked after assigning the component to the entity.

See also: sink

Template Parameters

Type	Type of component of which to get the sink.

Parameters

id	Optional name used to map the storage within the registry.

Returns: A temporary sink object.

Definition at line 985 of file registry.hpp.

◆ on_destroy()

template<typename Entity , typename Allocator >

template<typename Type >

auto entt::basic_registry< Entity, Allocator >::on_destroy ( const id_type id = type_hash<Type>::value() )

inline

Returns a sink object for the given component.

Use this function to receive notifications whenever an instance of the given component is removed from an entity and thus destroyed.
The function type for a listener is equivalent to:

void(basic_registry<Entity> &, Entity);

Listeners are invoked before removing the component from the entity.

See also: sink

Template Parameters

Type	Type of component of which to get the sink.

Parameters

id	Optional name used to map the storage within the registry.

Returns: A temporary sink object.

Definition at line 1033 of file registry.hpp.

◆ on_update()

template<typename Entity , typename Allocator >

template<typename Type >

auto entt::basic_registry< Entity, Allocator >::on_update ( const id_type id = type_hash<Type>::value() )

inline

Returns a sink object for the given component.

Use this function to receive notifications whenever an instance of the given component is explicitly updated.
The function type for a listener is equivalent to:

void(basic_registry<Entity> &, Entity);

Listeners are invoked after updating the component.

See also: sink

Template Parameters

Type	Type of component of which to get the sink.

Parameters

id	Optional name used to map the storage within the registry.

Returns: A temporary sink object.

Definition at line 1009 of file registry.hpp.

◆ operator=()

template<typename Entity , typename Allocator >

basic_registry & entt::basic_registry< Entity, Allocator >::operator= ( basic_registry< Entity, Allocator > && other )

inlinenoexcept

Move assignment operator.

Parameters

other The instance to move from.

Returns: This registry.

Definition at line 364 of file registry.hpp.

◆ orphan()

template<typename Entity , typename Allocator >

bool entt::basic_registry< Entity, Allocator >::orphan ( const entity_type entt ) const

inline

Checks if an entity has components assigned.

Parameters

entt	A valid identifier.

Returns: True if the entity has no components assigned, false otherwise.

Definition at line 961 of file registry.hpp.

◆ owned()

template<typename Entity , typename Allocator >

template<typename Type , typename... Other>

bool entt::basic_registry< Entity, Allocator >::owned ( ) const

inline

Checks whether the given components belong to any group.

Template Parameters

Type	Type of component in which one is interested.
Other	Other types of components in which one is interested.

Returns: True if the pools of the given components are free, false otherwise.

Definition at line 1111 of file registry.hpp.

◆ patch()

template<typename Entity , typename Allocator >

template<typename Type , typename... Func>

decltype(auto) entt::basic_registry< Entity, Allocator >::patch	(	const entity_type	entt,
		Func &&...	func
	)

inline

Patches the given component for an entity.

The signature of the function should be equivalent to the following:

void(Type &);

Warning: Attempting to patch a component of an entity that doesn't own it results in undefined behavior.

Template Parameters

Type	Type of component to patch.
Func	Types of the function objects to invoke.

Parameters

entt	A valid identifier.
func	Valid function objects.

Returns: A reference to the patched component.

Definition at line 665 of file registry.hpp.

◆ remove() [1/2]

template<typename Entity , typename Allocator >

template<typename Type , typename... Other>

size_type entt::basic_registry< Entity, Allocator >::remove ( const entity_type entt )

inline

Removes the given components from an entity.

Template Parameters

Type	Type of component to remove.
Other	Other types of components to remove.

Parameters

entt	A valid identifier.

Returns: The number of components actually removed.

Definition at line 697 of file registry.hpp.

◆ remove() [2/2]

template<typename Entity , typename Allocator >

template<typename Type , typename... Other, typename It >

size_type entt::basic_registry< Entity, Allocator >::remove	(	It	first,
		It	last
	)

inline

Removes the given components from all the entities in a range.

See also: remove

Template Parameters

Type	Type of component to remove.
Other	Other types of components to remove.
It	Type of input iterator.

Parameters

first	An iterator to the first element of the range of entities.
last	An iterator past the last element of the range of entities.

Returns: The number of components actually removed.

Definition at line 714 of file registry.hpp.

◆ replace()

template<typename Entity , typename Allocator >

template<typename Type , typename... Args>

decltype(auto) entt::basic_registry< Entity, Allocator >::replace	(	const entity_type	entt,
		Args &&...	args
	)

inline

Replaces the given component for an entity.

The component must have a proper constructor or be of aggregate type.

Warning: Attempting to replace a component of an entity that doesn't own it results in undefined behavior.

Template Parameters

Type	Type of component to replace.
Args	Types of arguments to use to construct the component.

Parameters

entt	A valid identifier.
args	Parameters to use to initialize the component.

Returns: A reference to the component being replaced.

Definition at line 685 of file registry.hpp.

◆ sort() [1/2]

template<typename Entity , typename Allocator >

template<typename To , typename From >

void entt::basic_registry< Entity, Allocator >::sort ( )

inline

Sorts two pools of components in the same way.

Entities and components in To which are part of both storage are sorted internally with the order they have in From. The others follow in no particular order.

Warning: Pools of components owned by a group cannot be sorted.

Template Parameters

To	Type of components to sort.
From	Type of components to use to sort.

Definition at line 1176 of file registry.hpp.

◆ sort() [2/2]

template<typename Entity , typename Allocator >

template<typename Type , typename Compare , typename Sort = std_sort, typename... Args>

void entt::basic_registry< Entity, Allocator >::sort	(	Compare	compare,
		Sort	algo = `Sort{}`,
		Args &&...	args
	)

inline

Sorts the elements of a given component.

The comparison function object returns true if the first element is less than the second one, false otherwise. Its signature is also equivalent to one of the following:

bool(const Entity, const Entity);

bool(const Type &, const Type &);

Moreover, it shall induce a strict weak ordering on the values.
The sort function object offers an operator() that accepts:

An iterator to the first element of the range to sort.
An iterator past the last element of the range to sort.
A comparison function object to use to compare the elements.

The comparison function object hasn't necessarily the type of the one passed along with the other parameters to this member function.

Warning: Pools of components owned by a group cannot be sorted.

Template Parameters

Type	Type of components to sort.
Compare	Type of comparison function object.
Sort	Type of sort function object.
Args	Types of arguments to forward to the sort function object.

Parameters

compare	A valid comparison function object.
algo	A valid sort function object.
args	Arguments to forward to the sort function object, if any.

Definition at line 1150 of file registry.hpp.

◆ storage() [1/6]

template<typename Entity , typename Allocator >

const_iterable entt::basic_registry< Entity, Allocator >::storage ( ) const

inlinenoexcept

Returns an iterable object to use to visit a registry.

The iterable object returns a pair that contains the name and a reference to the current storage.

Returns: An iterable object to use to visit the registry.

Definition at line 412 of file registry.hpp.

◆ storage() [2/6]

template<typename Entity , typename Allocator >

iterable entt::basic_registry< Entity, Allocator >::storage ( )

inlinenoexcept

Returns an iterable object to use to visit a registry.

The iterable object returns a pair that contains the name and a reference to the current storage.

Returns: An iterable object to use to visit the registry.

Definition at line 407 of file registry.hpp.

◆ storage() [3/6]

template<typename Entity , typename Allocator >

common_type * entt::basic_registry< Entity, Allocator >::storage ( const id_type id )

inline

Finds the storage associated with a given name, if any.

Parameters

id	Name used to map the storage within the registry.

Returns: A pointer to the storage if it exists, a null pointer otherwise.

Definition at line 421 of file registry.hpp.

◆ storage() [4/6]

template<typename Entity , typename Allocator >

const common_type * entt::basic_registry< Entity, Allocator >::storage ( const id_type id ) const

inline

Finds the storage associated with a given name, if any.

Parameters

id	Name used to map the storage within the registry.

Returns: A pointer to the storage if it exists, a null pointer otherwise.

Definition at line 430 of file registry.hpp.

◆ storage() [5/6]

template<typename Entity , typename Allocator >

template<typename Type >

storage_for_type< Type > & entt::basic_registry< Entity, Allocator >::storage ( const id_type id = type_hash<Type>::value() )

inline

Returns the storage for a given component type.

Template Parameters

Type	Type of component of which to return the storage.

Parameters

id	Optional name used to map the storage within the registry.

Returns: The storage for the given component type.

Definition at line 442 of file registry.hpp.

◆ storage() [6/6]

template<typename Entity , typename Allocator >

template<typename Type >

const storage_for_type< Type > * entt::basic_registry< Entity, Allocator >::storage ( const id_type id = type_hash<Type>::value() ) const

inline

Returns the storage for a given component type, if any.

Template Parameters

Type	Type of component of which to return the storage.

Parameters

id	Optional name used to map the storage within the registry.

Returns: The storage for the given component type.

Definition at line 453 of file registry.hpp.

◆ swap()

template<typename Entity , typename Allocator >

void entt::basic_registry< Entity, Allocator >::swap ( basic_registry< Entity, Allocator > & other )

inline

Exchanges the contents with those of a given registry.

Parameters

other Registry to exchange the content with.

Definition at line 379 of file registry.hpp.

◆ try_get() [1/2]

template<typename Entity , typename Allocator >

template<typename... Type>

auto entt::basic_registry< Entity, Allocator >::try_get ( const entity_type entt )

inline

Returns pointers to the given components for an entity.

Note: The registry retains ownership of the pointed-to components.

Template Parameters

Type	Types of components to get.

Parameters

entt	A valid identifier.

Returns: Pointers to the components owned by the entity.

Definition at line 930 of file registry.hpp.

◆ try_get() [2/2]

template<typename Entity , typename Allocator >

template<typename... Type>

auto entt::basic_registry< Entity, Allocator >::try_get ( const entity_type entt ) const

inline

Returns pointers to the given components for an entity.

Note: The registry retains ownership of the pointed-to components.

Template Parameters

Type	Types of components to get.

Parameters

entt	A valid identifier.

Returns: Pointers to the components owned by the entity.

Definition at line 919 of file registry.hpp.

◆ valid()

template<typename Entity , typename Allocator >

bool entt::basic_registry< Entity, Allocator >::valid ( const entity_type entt ) const

inline

Checks if an identifier refers to a valid entity.

Parameters

entt	An identifier, either valid or not.

Returns: True if the identifier is valid, false otherwise.

Definition at line 462 of file registry.hpp.

◆ view() [1/2]

template<typename Entity , typename Allocator >

template<typename Type , typename... Other, typename... Exclude>

basic_view< get_t< storage_for_type< Type >, storage_for_type< Other >... >, exclude_t< storage_for_type< Exclude >... > > entt::basic_registry< Entity, Allocator >::view ( exclude_t< Exclude... > = exclude_t{} )

inline

Returns a view for the given components.

Template Parameters

Type	Type of component used to construct the view.
Other	Other types of components used to construct the view.
Exclude	Types of components used to filter the view.

Returns: A newly created view.

Definition at line 1056 of file registry.hpp.

◆ view() [2/2]

template<typename Entity , typename Allocator >

template<typename Type , typename... Other, typename... Exclude>

basic_view< get_t< storage_for_type< const Type >, storage_for_type< const Other >... >, exclude_t< storage_for_type< const Exclude >... > > entt::basic_registry< Entity, Allocator >::view ( exclude_t< Exclude... > = exclude_t{} ) const

inline

Returns a view for the given components.

Template Parameters

Type	Type of component used to construct the view.
Other	Other types of components used to construct the view.
Exclude	Types of components used to filter the view.

Returns: A newly created view.

Definition at line 1046 of file registry.hpp.

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

src/entt/entity/fwd.hpp
src/entt/entity/registry.hpp

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ allocator_type

◆ common_type

◆ const_iterable

◆ context

◆ entity_type

◆ iterable

◆ size_type

◆ storage_for_type

◆ traits_type

◆ version_type

Constructor & Destructor Documentation

◆ basic_registry() [1/4]

◆ basic_registry() [2/4]

◆ basic_registry() [3/4]

◆ basic_registry() [4/4]

Member Function Documentation

◆ all_of()

◆ any_of()

◆ clear()

◆ compact()

◆ create() [1/3]

◆ create() [2/3]

◆ create() [3/3]

◆ ctx() [1/2]

◆ ctx() [2/2]

◆ current()

◆ destroy() [1/3]

◆ destroy() [2/3]

◆ destroy() [3/3]

◆ emplace()

◆ emplace_or_replace()

◆ erase() [1/2]

◆ erase() [2/2]

◆ erase_if()

◆ get() [1/2]

◆ get() [2/2]

◆ get_allocator()

◆ get_or_emplace()

◆ group()

◆ group_if_exists()

◆ insert() [1/2]

◆ insert() [2/2]

◆ on_construct()

◆ on_destroy()

◆ on_update()

◆ operator=()

◆ orphan()

◆ owned()

◆ patch()

◆ remove() [1/2]

◆ remove() [2/2]

◆ replace()

◆ sort() [1/2]

◆ sort() [2/2]

◆ storage() [1/6]

◆ storage() [2/6]

◆ storage() [3/6]

◆ storage() [4/6]

◆ storage() [5/6]

◆ storage() [6/6]

◆ swap()

◆ try_get() [1/2]

◆ try_get() [2/2]

◆ valid()

◆ view() [1/2]

◆ view() [2/2]