add a comment about AddIncrementally to explain why it works for hook but virtually...

[xonotic/xonotic-data.pk3dir.git] / qcsrc / warpzonelib / common.qh

diff --git a/qcsrc/warpzonelib/common.qh b/qcsrc/warpzonelib/common.qh
index 81a04e312372851843a9f8e19b0b403a82df66c1..e7cf23908eda0198025a0c5ebaf437b1eb890757 100644 (file)
--- a/qcsrc/warpzonelib/common.qh
+++ b/qcsrc/warpzonelib/common.qh
@@ -69,6 +69,9 @@ void WarpZone_RefSys_AddTransform(entity me, vector t, vector s); // me.R := [t
 void WarpZone_RefSys_AddInverseTransform(entity me, vector t, vector s); // me.R := [t s]^-1 me.R
 
 // makes this reference system track ref's changes
+// NOTE: this is ONLY sensible if WarpZone_RefSys_Add is no longer called on "me" while doing this
+// To achieve this, make sure no touch events on warpzone are raised by this entity
+// or set a movetype that causes no warpzoning (e.g. MOVETYPE_NONE, MOVETYPE_FOLLOW)
 void WarpZone_RefSys_AddIncrementally(entity me, entity ref); // me.R := ref.R me.Rref^-1 me.R; me.Rref := ref.R
 void WarpZone_RefSys_BeginAddingIncrementally(entity me, entity ref); // me.Rref := ref.R