Flecs: include/flecs/addons/cpp/mixins/doc/entity_builder.inl Source File
Description: A fast entity component system (ECS) for C & C++

| Flecs v4.1 A fast entity component system (ECS) for C & C++

Loading...
Searching...
No Matches
entity_builder.inl
Go to the documentation of this file.
1
5
16 const Self& set_doc_name(const char *name) const {
17 ecs_doc_set_name(world_, id_, name);
18 return to_base();
19}
20
31 const Self& set_doc_brief(const char *brief) const {
32 ecs_doc_set_brief(world_, id_, brief);
33 return to_base();
34}
35
46 const Self& set_doc_detail(const char *detail) const {
47 ecs_doc_set_detail(world_, id_, detail);
48 return to_base();
49}
50
61 const Self& set_doc_link(const char *link) const {
62 ecs_doc_set_link(world_, id_, link);
63 return to_base();
64}
65
76 const Self& set_doc_color(const char *color) const {
77 ecs_doc_set_color(world_, id_, color);
78 return to_base();
79}
80
91 const Self& set_doc_uuid(const char *uuid) const {
92 ecs_doc_set_uuid(world_, id_, uuid);
93 return to_base();
94}
ecs_doc_set_uuid
FLECS_API void ecs_doc_set_uuid(ecs_world_t *world, ecs_entity_t entity, const char *uuid)
Add UUID to entity.
ecs_doc_set_brief
FLECS_API void ecs_doc_set_brief(ecs_world_t *world, ecs_entity_t entity, const char *description)
Add brief description to entity.
ecs_doc_set_detail
FLECS_API void ecs_doc_set_detail(ecs_world_t *world, ecs_entity_t entity, const char *description)
Add detailed description to entity.
ecs_doc_set_link
FLECS_API void ecs_doc_set_link(ecs_world_t *world, ecs_entity_t entity, const char *link)
Add link to external documentation to entity.
ecs_doc_set_color
FLECS_API void ecs_doc_set_color(ecs_world_t *world, ecs_entity_t entity, const char *color)
Add color to entity.
ecs_doc_set_name
FLECS_API void ecs_doc_set_name(ecs_world_t *world, ecs_entity_t entity, const char *name)
Add human-readable name to entity.
flecs::entity_builder::set_doc_uuid
const Self & set_doc_uuid(const char *uuid) const
Set doc UUID.
Definition entity_builder.inl:91
flecs::entity_builder::set_doc_name
const Self & set_doc_name(const char *name) const
Set human-readable name.
Definition entity_builder.inl:16
flecs::entity_builder::set_doc_brief
const Self & set_doc_brief(const char *brief) const
Set brief description.
Definition entity_builder.inl:31
flecs::entity_builder::set_doc_link
const Self & set_doc_link(const char *link) const
Set link to external documentation.
Definition entity_builder.inl:61
flecs::entity_builder::set_doc_color
const Self & set_doc_color(const char *color) const
Set doc color.
Definition entity_builder.inl:76
flecs::entity_builder::set_doc_detail
const Self & set_doc_detail(const char *detail) const
Set detailed description.
Definition entity_builder.inl:46
flecs::entity_view::name
flecs::string_view name() const
Return the entity name.
Definition entity_view.hpp:88
flecs::id::id_
flecs::id_t id_
The raw ID value.
Definition decl.hpp:149
flecs::id::world_
flecs::world_t * world_
World is optional, but guarantees that entity identifiers extracted from the ID are valid.
Definition decl.hpp:147