mirror
/
OpenTTD
mirror of https://github.com/OpenTTD/OpenTTD
1
0
Fork 0
Code Issues

(svn r26734) -Fix-ish: make clear the AI/GS List's Begin and Next return the item, not the value

release/1.5
rubidium 2014-08-16 10:05:57 +00:00
parent 53e7138a2e
commit c25b0a0ad4
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/script/api/script_list.hpp
View File

@ -84,15 +84,15 @@ public:
bool HasItem(int32 item); bool HasItem(int32 item);
/** /**
* Go to the beginning of the list. * Go to the beginning of the list and return the item. To get the value use list.GetValue(list.Begin()).
* @return the item value of the first item. * @return the first item.
* @note returns 0 if beyond end-of-list. Use IsEnd() to check for end-of-list. * @note returns 0 if beyond end-of-list. Use IsEnd() to check for end-of-list.
*/ */
int32 Begin(); int32 Begin();
/** /**
* Go to the next item in the list. * Go to the next item in the list and return the item. To get the value use list.GetValue(list.Next()).
* @return the item value of the next item. * @return the next item.
* @note returns 0 if beyond end-of-list. Use IsEnd() to check for end-of-list. * @note returns 0 if beyond end-of-list. Use IsEnd() to check for end-of-list.
*/ */
int32 Next(); int32 Next();