Skip to content
Flecs v4.1
world.hpp File Reference

World class. More...

Go to the source code of this file.

Classes

struct  flecs::world
 The world. More...

Namespaces

namespace  flecs::_
 Int to enum.

Functions

template<auto Write, typename T>
void flecs::_::write_component (world_t *world, flecs::entity_t entity, T &&value, flecs::id_t id)
template<typename T>
void flecs::set (world_t *world, flecs::entity_t entity, T &&value, flecs::id_t id)
template<typename T>
void flecs::set (world_t *world, flecs::entity_t entity, const T &value, flecs::id_t id)
template<typename T, typename A>
void flecs::set (world_t *world, entity_t entity, A &&value)
template<typename T, typename A>
void flecs::set (world_t *world, entity_t entity, const A &value)
template<typename T>
void flecs::assign (world_t *world, flecs::entity_t entity, T &&value, flecs::id_t id)
template<typename T>
void flecs::assign (world_t *world, flecs::entity_t entity, const T &value, flecs::id_t id)
template<typename T, typename A>
void flecs::assign (world_t *world, entity_t entity, A &&value)
template<typename T, typename A>
void flecs::assign (world_t *world, entity_t entity, const A &value)
template<typename T, typename ... Args, if_t< std::is_constructible< actual_type_t< T >, Args... >::value||std::is_default_constructible< actual_type_t< T > >::value > = 0>
void flecs::emplace (world_t *world, flecs::entity_t entity, flecs::id_t id, Args &&... args)
 Emplace a component value, constructing it in place.
flecs::id_t flecs::strip_generation (flecs::entity_t e)
 Return the ID without generation.
uint32_t flecs::get_generation (flecs::entity_t e)
 Return the entity generation.

Detailed Description

World class.

Definition in file world.hpp.

Function Documentation

◆ assign() [1/4]

template<typename T, typename A>
void flecs::assign ( world_t * world,
entity_t entity,
A && value )
inline

Definition at line 66 of file world.hpp.

◆ assign() [2/4]

template<typename T, typename A>
void flecs::assign ( world_t * world,
entity_t entity,
const A & value )
inline

Definition at line 71 of file world.hpp.

◆ assign() [3/4]

template<typename T>
void flecs::assign ( world_t * world,
flecs::entity_t entity,
const T & value,
flecs::id_t id )
inline

Definition at line 61 of file world.hpp.

◆ assign() [4/4]

template<typename T>
void flecs::assign ( world_t * world,
flecs::entity_t entity,
T && value,
flecs::id_t id )
inline

Definition at line 56 of file world.hpp.

◆ emplace()

template<typename T, typename ... Args, if_t< std::is_constructible< actual_type_t< T >, Args... >::value||std::is_default_constructible< actual_type_t< T > >::value > = 0>
void flecs::emplace ( world_t * world,
flecs::entity_t entity,
flecs::id_t id,
Args &&... args )
inline

Emplace a component value, constructing it in place.

Template Parameters
TThe component type.
ArgsConstructor argument types.
Parameters
worldThe world.
entityThe entity.
idThe component ID.
argsConstructor arguments.

Definition at line 87 of file world.hpp.

◆ get_generation()

uint32_t flecs::get_generation ( flecs::entity_t e)
inline

Return the entity generation.

Parameters
eThe entity ID.
Returns
The generation of the entity.

Definition at line 113 of file world.hpp.

◆ set() [1/4]

template<typename T, typename A>
void flecs::set ( world_t * world,
entity_t entity,
A && value )
inline

Definition at line 46 of file world.hpp.

◆ set() [2/4]

template<typename T, typename A>
void flecs::set ( world_t * world,
entity_t entity,
const A & value )
inline

Definition at line 51 of file world.hpp.

◆ set() [3/4]

template<typename T>
void flecs::set ( world_t * world,
flecs::entity_t entity,
const T & value,
flecs::id_t id )
inline

Definition at line 41 of file world.hpp.

◆ set() [4/4]

template<typename T>
void flecs::set ( world_t * world,
flecs::entity_t entity,
T && value,
flecs::id_t id )
inline

Definition at line 36 of file world.hpp.

◆ strip_generation()

flecs::id_t flecs::strip_generation ( flecs::entity_t e)
inline

Return the ID without generation.

Parameters
eThe entity ID.
Returns
The entity ID without generation.
See also
ecs_strip_generation()

Definition at line 104 of file world.hpp.