From 86b04e36b528fea9a585a4234b19aa0828b76bdb Mon Sep 17 00:00:00 2001 From: Ryan Stecker <ryan@stecker.email> Date: Mon, 20 Jul 2015 15:03:57 -0500 Subject: [PATCH] Clarify the Get/SetPackPosition documentation. --- plugins/include/datapack.inc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/plugins/include/datapack.inc b/plugins/include/datapack.inc index ecdd5cd3..e623b77a 100644 --- a/plugins/include/datapack.inc +++ b/plugins/include/datapack.inc @@ -141,7 +141,7 @@ native void ResetPack(Handle pack, bool clear=false); * Returns the read or write position in a data pack. * * @param pack Handle to the data pack. - * @return Numerical position in the data pack. + * @return Position in the data pack, only usable with calls to SetPackPosition. * @error Invalid handle. */ native DataPackPos GetPackPosition(Handle pack); @@ -150,7 +150,7 @@ native DataPackPos GetPackPosition(Handle pack); * Sets the read/write position in a data pack. * * @param pack Handle to the data pack. - * @param position New position to set. + * @param position New position to set. Must have been previously retrieved from a call to GetPackPosition. * @noreturn * @error Invalid handle, or position is beyond the pack bounds. */