-Added a more descriptive comment for prvm_edict_t::p

[xonotic/darkplaces.git] / progsvm.h

diff --git a/progsvm.h b/progsvm.h
index 12c85cd1d99e2eac96e8abf3ccc33939beb71cd4..f9c1666a803a2139a77ef20c3c6b6ceff26aa1de 100644 (file)
--- a/progsvm.h
+++ b/progsvm.h
@@ -174,7 +174,22 @@ typedef struct prvm_edict_s
        {
                prvm_edict_private_t *e;
                void                             *vp;
-               //add other types as you desire
+               // add other private structs as you desire
+               // new structs have to start with the elements of prvm_edit_private_t
+               // e.g. a new struct has to either look like this:
+               //      typedef struct server_edict_private_s {
+               //              prvm_edict_private_t base;
+               //              vec3_t moved_from;
+               //      vec3_t moved_fromangles;
+               //              ... } server_edict_private_t;
+               // or:
+               //      typedef struct server_edict_private_s {
+               //              qboolean free;
+               //              float freetime;
+               //              vec3_t moved_from;
+               //      vec3_t moved_fromangles;
+               //              ... } server_edict_private_t;
+               // However, the first one should be preferred.
        } p;
        // QuakeC fields (stored in dynamically resized array)
        //entvars_t *v;