doc: added a note on registry::assign

This commit is contained in:
Michele Caini
2020-03-08 15:54:07 +01:00
parent 71d86c44e0
commit 5746df4d74

View File

@@ -631,6 +631,11 @@ public:
/**
* @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
* An assertion will abort the execution at runtime in debug mode if all
* pools aren't empty. Groups and context variables are ignored.