pke: add comment for ECS_CreateEV

1 files changed, 7 insertions, 0 deletions

diff --git a/src/ecs.hpp b/src/ecs.hpp
index edc1c37..60fce3f 100644
--- a/src/ecs.hpp
+++ b/src/ecs.hpp
@@ -34,6 +34,13 @@ void ECS_GetInstances(Entity_Base *entity, pk_arr_t<CompInstance *> &arr);
 void ECS_UpdateInstance(CompInstance *instance, const InstPos &instPos, bool overridePhysics = false);
 pk_bkt_arr *ECS_GetInstances();
 
+/* Callbacks
+ * user_event_data: entity
+ * user_cb_data: user-defined when cb is registered
+ * user_ev_data: user-defined when ev is emitted
+ *
+ * note: user_ev_data is null for static_ui buttons.
+ */
 pke_component_event *ECS_CreateEv(Entity_Base *entity, pk_uuid uuid);
 pke_component_event *ECS_GetEv(PkeEventHandle handle);
 void ECS_GetEvs(Entity_Base *entity, pk_arr_t<pke_component_event *> &arr);