add a remark to script_array_size

HerculesWS · Oct 15, 2023 · 3c508c4 · 3c508c4
1 parent 8178f1a
commit 3c508c4
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/map/script.c b/src/map/script.c
@@ -3450,6 +3450,9 @@ static void script_array_ensure_zero(struct script_state *st, struct map_session
 }
 /**
  * Returns array size by ID
+ * @remarks
+ *   "size" here refers to allocated indexes, where non-zero values are set.
+ *   For the highest used index, see script_array_highest_key
  **/
 static unsigned int script_array_size(struct script_state *st, struct map_session_data *sd, const char *name, struct reg_db *ref)
 {