Răsfoiți Sursa

doc: updated entity.md and README files

Michele Caini 3 ani în urmă
părinte
comite
85ca2f3562
2 a modificat fișierele cu 11 adăugiri și 8 ștergeri
  1. 4 3
      README.md
  2. 7 5
      docs/md/entity.md

+ 4 - 3
README.md

@@ -81,12 +81,13 @@ Here is a brief, yet incomplete list of what it offers today:
 * A `constexpr` utility for human readable **resource names**.
 * A `constexpr` utility for human readable **resource names**.
 * Minimal **configuration system** built using the monostate pattern.
 * Minimal **configuration system** built using the monostate pattern.
 * Incredibly fast **entity-component system** with its own _pay for what you
 * Incredibly fast **entity-component system** with its own _pay for what you
-  use_ policy.
+  use_ policy, unconstrained component types with optional pointer stability and
+  hooks for storage customization.
 * Views and groups to iterate entities and components and allow different access
 * Views and groups to iterate entities and components and allow different access
   patterns, from **perfect SoA** to fully random.
   patterns, from **perfect SoA** to fully random.
 * A lot of **facilities** built on top of the entity-component system to help
 * A lot of **facilities** built on top of the entity-component system to help
   the users and avoid reinventing the wheel.
   the users and avoid reinventing the wheel.
-* General purpose execution graph builder for optimal scheduling.
+* General purpose **execution graph builder** for optimal scheduling.
 * The smallest and most basic implementation of a **service locator** ever seen.
 * The smallest and most basic implementation of a **service locator** ever seen.
 * A built-in, non-intrusive and macro-free runtime **reflection system**.
 * A built-in, non-intrusive and macro-free runtime **reflection system**.
 * **Static polymorphism** made simple and within everyone's reach.
 * **Static polymorphism** made simple and within everyone's reach.
@@ -98,7 +99,7 @@ Here is a brief, yet incomplete list of what it offers today:
 * And **much more**! Check out the
 * And **much more**! Check out the
   [**wiki**](https://github.com/skypjack/entt/wiki).
   [**wiki**](https://github.com/skypjack/entt/wiki).
 
 
-Consider these lists a work in progress as well as the project. The whole API is
+Consider this list a work in progress as well as the project. The whole API is
 fully documented in-code for those who are brave enough to read it.<br/>
 fully documented in-code for those who are brave enough to read it.<br/>
 Please, do note that all tools are also DLL-friendly now and run smoothly across
 Please, do note that all tools are also DLL-friendly now and run smoothly across
 boundaries.
 boundaries.

+ 7 - 5
docs/md/entity.md

@@ -139,8 +139,8 @@ The registry to store, the views and the groups to iterate. That's all.
 The `entt::entity` type implements the concept of _entity identifier_. An entity
 The `entt::entity` type implements the concept of _entity identifier_. An entity
 (the _E_ of an _ECS_) is an opaque element to use as-is. Inspecting it isn't
 (the _E_ of an _ECS_) is an opaque element to use as-is. Inspecting it isn't
 recommended since its format can change in future.<br/>
 recommended since its format can change in future.<br/>
-Components (the _C_ of an _ECS_) are both move constructible and move assignable
-types. No need to register them nor their types.<br/>
+Components (the _C_ of an _ECS_) are of any type, without any constraints, not
+even that of being movable. No need to register them nor their types.<br/>
 Systems (the _S_ of an _ECS_) can be plain functions, functors, lambdas and so
 Systems (the _S_ of an _ECS_) can be plain functions, functors, lambdas and so
 on. It's not required to announce them in any case and have no requirements.
 on. It's not required to announce them in any case and have no requirements.
 
 
@@ -965,9 +965,11 @@ makes it possible to use any type as a component, as long as its specialization
 of `component_traits` implements all the required functionalities.<br/>
 of `component_traits` implements all the required functionalities.<br/>
 The non-specialized version of this class contains the following members:
 The non-specialized version of this class contains the following members:
 
 
-* `in_place_delete`: `Type::in_place_delete` if present, false otherwise.
-* `page_size`: `Type::page_size` if present, `ENTT_PACKED_PAGE` (for non-empty
-  types) or 0 (for empty types) otherwise.
+* `in_place_delete`: `Type::in_place_delete` if present, true for non-movable
+  types and false otherwise.
+
+* `page_size`: `Type::page_size` if present, `ENTT_PACKED_PAGE` for non-empty
+  types and 0 otherwise.
 
 
 Where `Type` is any type of component. All properties can be customized by
 Where `Type` is any type of component. All properties can be customized by
 specializing the above class and defining all its members, or by adding only
 specializing the above class and defining all its members, or by adding only