Przeglądaj źródła

doc: added a note on registry::assign

Michele Caini 6 lat temu
rodzic
commit
5746df4d74
1 zmienionych plików z 5 dodań i 0 usunięć
  1. 5 0
      src/entt/entity/registry.hpp

+ 5 - 0
src/entt/entity/registry.hpp

@@ -631,6 +631,11 @@ public:
     /**
     /**
      * @brief Assigns entities to an empty registry.
      * @brief Assigns entities to an empty registry.
      *
      *
+     * This function is intended for use in conjunction with `raw`.<br/>
+     * Don't try to inject ranges of randomly generated entities because there
+     * is no guarantee that the registry will continue to function properly in
+     * this case.
+     *
      * @warning
      * @warning
      * An assertion will abort the execution at runtime in debug mode if all
      * An assertion will abort the execution at runtime in debug mode if all
      * pools aren't empty. Groups and context variables are ignored.
      * pools aren't empty. Groups and context variables are ignored.