diff --git a/TODO b/TODO index bbc2dcb15..0ecdecd6c 100644 --- a/TODO +++ b/TODO @@ -38,4 +38,3 @@ TODO: * fwd meta_ctx (and update testbed) * avoid copying meta_type/data/func nodes * doc for labels on meta elements -* doc auto-bind mechanism for basic_sigh_mixin \ No newline at end of file diff --git a/docs/md/entity.md b/docs/md/entity.md index 036cf508c..501cb29a7 100644 --- a/docs/md/entity.md +++ b/docs/md/entity.md @@ -11,6 +11,7 @@ * [Vademecum](#vademecum) * [The Registry, the Entity and the Component](#the-registry-the-entity-and-the-component) * [Observe changes](#observe-changes) + * [Auto-binding](#auto-binding) * [Entity lifecycle](#entity-lifecycle) * [Listeners disconnection](#listeners-disconnection) * [They call me reactive storage](#they-call-me-reactive-storage) @@ -409,6 +410,27 @@ There are many useful but less known functionalities that are not described here, such as the connection objects or the possibility to attach listeners with a list of parameters that is shorter than that of the signal itself. +### Auto-binding + +Users don't need to create bindings manually each and every time. For managed +types, they can have `EnTT` setup listeners automatically.
+The library searches the types for functions with specific names and signatures, +as in the following example: + +```cpp +struct my_type { + static void on_construct(entt::registry ®istry, const entt::entity entt); + static void on_update(entt::registry ®istry, const entt::entity entt); + static void on_destroy(entt::registry ®istry, const entt::entity entt); + + // ... +}; +``` + +As soon as a storage is created for such a defined type, these functions are +associated with the respective signals. The function name is self-explanatory of +the target signal. + ### Entity lifecycle Observing entities is also possible. In this case, the user must use the entity