Flecs v3.2
A fast entity component system (ECS) for C & C++
Loading...
Searching...
No Matches
impl.hpp
Go to the documentation of this file.
1
6#pragma once
7
8namespace flecs {
9namespace doc {
10
11inline const char* get_name(const flecs::entity_view& e) {
12 return ecs_doc_get_name(e.world(), e);
13}
14
15inline const char* get_brief(const flecs::entity_view& e) {
16 return ecs_doc_get_brief(e.world(), e);
17}
18
19inline const char* get_detail(const flecs::entity_view& e) {
20 return ecs_doc_get_detail(e.world(), e);
21}
22
23inline const char* get_link(const flecs::entity_view& e) {
24 return ecs_doc_get_link(e.world(), e);
25}
26
27inline void set_name(flecs::entity& e, const char *name) {
28 ecs_doc_set_name(e.world(), e, name);
29}
30
31inline void set_brief(flecs::entity& e, const char *description) {
32 ecs_doc_set_brief(e.world(), e, description);
33}
34
35inline void set_detail(flecs::entity& e, const char *description) {
36 ecs_doc_set_detail(e.world(), e, description);
37}
38
39inline void set_link(flecs::entity& e, const char *description) {
40 ecs_doc_set_link(e.world(), e, description);
41}
42
43namespace _ {
44
45inline void init(flecs::world& world) {
46 world.component<doc::Description>("flecs::doc::Description");
47}
48
49} // namespace _
50} // namespace doc
51} // namespace flecs
FLECS_API const char * ecs_doc_get_name(const ecs_world_t *world, ecs_entity_t entity)
Get human readable name from entity.
FLECS_API void ecs_doc_set_brief(ecs_world_t *world, ecs_entity_t entity, const char *description)
Add brief description to entity.
FLECS_API const char * ecs_doc_get_link(const ecs_world_t *world, ecs_entity_t entity)
Get link to external documentation from entity.
FLECS_API const char * ecs_doc_get_detail(const ecs_world_t *world, ecs_entity_t entity)
Get detailed description from entity.
FLECS_API const char * ecs_doc_get_brief(const ecs_world_t *world, ecs_entity_t entity)
Get brief description from entity.
FLECS_API void ecs_doc_set_detail(ecs_world_t *world, ecs_entity_t entity, const char *description)
Add detailed description to entity.
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.
FLECS_API void ecs_doc_set_name(ecs_world_t *world, ecs_entity_t entity, const char *name)
Add human-readable name to entity.
EcsDocDescription Description
flecs.doc.Description component
Definition: decl.hpp:20
flecs::component< T > component(Args &&... args) const
Find or register component.
Entity view.
Definition: entity_view.hpp:28
Entity.
Definition: entity.hpp:30
The world.
Definition: world.hpp:113