Browse Source

doc: drop refs to registry::version (close #992)

Michele Caini 3 years ago
parent
commit
1d85414dc2
1 changed files with 9 additions and 4 deletions
  1. 9 4
      docs/md/entity.md

+ 9 - 4
docs/md/entity.md

@@ -203,19 +203,24 @@ and it's possible to force a _version_.
 In both cases, when an identifier is released, the registry can freely reuse it
 In both cases, when an identifier is released, the registry can freely reuse it
 internally. In particular, the version of an entity is increased (unless the
 internally. In particular, the version of an entity is increased (unless the
 overload that forces a version is used instead of the default one).<br/>
 overload that forces a version is used instead of the default one).<br/>
-Users can then _inspect_ the identifiers by means of a registry:
+Users can then _test_ identifiers by means of a registry:
 
 
 ```cpp
 ```cpp
 // returns true if the entity is still valid, false otherwise
 // returns true if the entity is still valid, false otherwise
 bool b = registry.valid(entity);
 bool b = registry.valid(entity);
 
 
-// gets the version contained in the entity identifier
-auto version = registry.version(entity);
-
 // gets the actual version for the given entity
 // gets the actual version for the given entity
 auto curr = registry.current(entity);
 auto curr = registry.current(entity);
 ```
 ```
 
 
+Or _inspect_ them using some functions meant for parsing an identifier as-is,
+such as:
+
+```cpp
+// gets the version contained in the entity identifier
+auto version = entt::to_version(entity);
+```
+
 Components are assigned to or removed from entities at any time.<br/>
 Components are assigned to or removed from entities at any time.<br/>
 The `emplace` member function template creates, initializes and assigns to an
 The `emplace` member function template creates, initializes and assigns to an
 entity the given component. It accepts a variable number of arguments to use to
 entity the given component. It accepts a variable number of arguments to use to