diff options
author | rubidium <rubidium@openttd.org> | 2014-08-16 10:05:57 +0000 |
---|---|---|
committer | rubidium <rubidium@openttd.org> | 2014-08-16 10:05:57 +0000 |
commit | c25b0a0ad4e3dedf2b1c8652536ad1a1e07a8e0e (patch) | |
tree | 62314f9ccd27a90e8d6540f9d6400bb1055298ec /src/script/api | |
parent | 53e7138a2e7fe80a2925171550576ad7eb60715d (diff) | |
download | openttd-c25b0a0ad4e3dedf2b1c8652536ad1a1e07a8e0e.tar.xz |
(svn r26734) -Fix-ish: make clear the AI/GS List's Begin and Next return the item, not the value
Diffstat (limited to 'src/script/api')
-rw-r--r-- | src/script/api/script_list.hpp | 8 |
1 files changed, 4 insertions, 4 deletions
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(); |