From c25b0a0ad4e3dedf2b1c8652536ad1a1e07a8e0e Mon Sep 17 00:00:00 2001 From: rubidium Date: Sat, 16 Aug 2014 10:05:57 +0000 Subject: (svn r26734) -Fix-ish: make clear the AI/GS List's Begin and Next return the item, not the value --- src/script/api/script_list.hpp | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'src') diff --git a/src/script/api/script_list.hpp b/src/script/api/script_list.hpp index 2117f959d..e6f4d137d 100644 --- a/src/script/api/script_list.hpp +++ b/src/script/api/script_list.hpp @@ -84,15 +84,15 @@ public: bool HasItem(int32 item); /** - * Go to the beginning of the list. - * @return the item value of the first item. + * Go to the beginning of the list and return the item. To get the value use list.GetValue(list.Begin()). + * @return the first item. * @note returns 0 if beyond end-of-list. Use IsEnd() to check for end-of-list. */ int32 Begin(); /** - * Go to the next item in the list. - * @return the item value of the next item. + * Go to the next item in the list and return the item. To get the value use list.GetValue(list.Next()). + * @return the next item. * @note returns 0 if beyond end-of-list. Use IsEnd() to check for end-of-list. */ int32 Next(); -- cgit v1.2.3-54-g00ecf