Add test for using pair type with world::id, fix code example in quic…

…kstart
SanderMertens · May 11, 2023 · f786277 · f786277
1 parent 66dca4e
commit f786277
Show file tree

Hide file tree

Showing 8 changed files with 30 additions and 31 deletions.
diff --git a/docs/Quickstart.md b/docs/Quickstart.md
@@ -238,7 +238,7 @@ printf("Name: %s\n", ecs_get_name(world, pos_e)); // outputs 'Name: Position'
 ecs_add(world, pos_e, Serializable);
 ```
 ```cpp
-flecs::entity pos_e = world.id<Position>();
+flecs::entity pos_e = world.entity<Position>();
 std::cout << "Name: " << pos_e.name() << std::endl; // outputs 'Name: Position'
 
 // It's possible to add components like you would for any entity
@@ -256,7 +256,7 @@ const EcsComponent *c = ecs_get(world, pos_e, EcsComponent);
 printf("Component size: %u\n", c->size);
 ```
 ```cpp
-flecs::entity pos_e = world.id<Position>();
+flecs::entity pos_e = world.entity<Position>();
 
 const EcsComponent *c = pos_e.get<flecs::Component>();
 std::cout << "Component size: " << c->size << std::endl;
@@ -548,7 +548,7 @@ e.each([&](flecs:id id) {
  if (id == world.id<Position>()) {
   // Found Position component!
  }
-}
+});
 ```
 
 ### Singleton
@@ -577,7 +577,7 @@ ecs_set(world, ecs_id(Gravity), Gravity, {10, 20});
 const Gravity *g = ecs_get(world, ecs_id(Gravity), Gravity);
 ```
 ```cpp
-flecs::entity grav_e = world.id<Gravity>();
+flecs::entity grav_e = world.entity<Gravity>();
 
 grav_e.set<Gravity>({10, 20});
 

diff --git a/flecs.h b/flecs.h
@@ -19189,7 +19189,7 @@ struct world {
  * \memberof flecs::world
  */
 template <typename T>
-flecs::entity id() const;
+flecs::id id() const;
 
 /** Id factory.
  * 
@@ -23319,7 +23319,7 @@ struct iterable {
  * The "each" iterator accepts a function that is invoked for each matching
  * entity. The following function signatures are valid:
  * - func(flecs::entity e, Components& ...)
- * - func(flecs::iter& it, int32_t index, Components& ....)
+ * - func(flecs::iter& it, size_t index, Components& ....)
  * - func(Components& ...)
  * 
  * Each iterators are automatically instanced.
@@ -24810,8 +24810,8 @@ inline flecs::entity id::type_id() const {
 // Id mixin implementation
 
 template <typename T>
-inline flecs::entity world::id() const {
- return flecs::entity(m_world, _::cpp_type<T>::id(m_world));
+inline flecs::id world::id() const {
+ return flecs::id(m_world, _::cpp_type<T>::id(m_world));
 }
 
 template <typename ... Args>

diff --git a/include/flecs/addons/cpp/mixins/id/impl.hpp b/include/flecs/addons/cpp/mixins/id/impl.hpp
@@ -67,8 +67,8 @@ inline flecs::entity id::type_id() const {
 // Id mixin implementation
 
 template <typename T>
-inline flecs::entity world::id() const {
- return flecs::entity(m_world, _::cpp_type<T>::id(m_world));
+inline flecs::id world::id() const {
+ return flecs::id(m_world, _::cpp_type<T>::id(m_world));
 }
 
 template <typename ... Args>

diff --git a/include/flecs/addons/cpp/mixins/id/mixin.inl b/include/flecs/addons/cpp/mixins/id/mixin.inl
@@ -8,7 +8,7 @@
  * \memberof flecs::world
  */
 template <typename T>
-flecs::entity id() const;
+flecs::id id() const;
 
 /** Id factory.
  * 

diff --git a/test/cpp_api/project.json b/test/cpp_api/project.json
@@ -259,8 +259,7 @@
  "to_view",
  "to_view_from_stage",
  "set_alias",
- "emplace_w_observer",
- "world_id_to_entity"
+ "emplace_w_observer"
  ]
  }, {
  "id": "Pairs",
@@ -1129,7 +1128,8 @@
  "run_post_frame",
  "component_w_low_id",
  "get_set_log_level",
- "reset_world"
+ "reset_world",
+ "id_from_pair_type"
  ]
  }, {
  "id": "Singleton",

diff --git a/test/cpp_api/src/Entity.cpp b/test/cpp_api/src/Entity.cpp
@@ -4305,13 +4305,3 @@ void Entity_emplace_w_observer() {
  test_int(e.get<Position>()->x, 10);
  test_int(e.get<Position>()->y, 20);
 }
-
-void Entity_world_id_to_entity() {
- flecs::world ecs;
-
- flecs::entity e1 = ecs.component<Position>();
- flecs::entity e2 = ecs.id<Position>();
- test_assert(e1 == e2);
- flecs::id id = ecs.id<Position>();
- test_assert(e1 == id);
-}
diff --git a/test/cpp_api/src/World.cpp b/test/cpp_api/src/World.cpp
@@ -1694,3 +1694,12 @@ void World_reset_world() {
  ecs.reset();
  test_assert(!ecs.exists(e));
 }
+
+void World_id_from_pair_type() {
+ flecs::world ecs;
+
+ flecs::id id = ecs.id<flecs::pair<Position, Velocity>>();
+ test_assert(id.is_pair());
+ test_assert(id.first() == ecs.id<Position>());
+ test_assert(id.second() == ecs.id<Velocity>());
+}
diff --git a/test/cpp_api/src/main.cpp b/test/cpp_api/src/main.cpp
@@ -252,7 +252,6 @@ void Entity_to_view(void);
 void Entity_to_view_from_stage(void);
 void Entity_set_alias(void);
 void Entity_emplace_w_observer(void);
-void Entity_world_id_to_entity(void);
 
 // Testsuite 'Pairs'
 void Pairs_add_component_pair(void);
@@ -1080,6 +1079,7 @@ void World_run_post_frame(void);
 void World_component_w_low_id(void);
 void World_get_set_log_level(void);
 void World_reset_world(void);
+void World_id_from_pair_type(void);
 
 // Testsuite 'Singleton'
 void Singleton_set_get_singleton(void);
@@ -2180,10 +2180,6 @@ bake_test_case Entity_testcases[] = {
  {
  "emplace_w_observer",
  Entity_emplace_w_observer
- },
- {
- "world_id_to_entity",
- Entity_world_id_to_entity
  }
 };
 
@@ -5387,6 +5383,10 @@ bake_test_case World_testcases[] = {
  {
  "reset_world",
  World_reset_world
+ },
+ {
+ "id_from_pair_type",
+ World_id_from_pair_type
  }
 };
 
@@ -5901,7 +5901,7 @@ static bake_test_suite suites[] = {
  "Entity",
  NULL,
  NULL,
- 240,
+ 239,
  Entity_testcases
  },
  {
@@ -6048,7 +6048,7 @@ static bake_test_suite suites[] = {
  "World",
  NULL,
  NULL,
- 95,
+ 96,
  World_testcases
  },
  {