miguel.horta/openttd-cmclient
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Codefix: broken links and syntax issues in script API documentation

Browse Source
This commit is contained in:
frosch
2024-03-24 19:00:06 +01:00
committed by Peter Nelson
parent 64e1f1d4d9
commit e436e2ef40
12 changed files with 54 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -29,20 +29,22 @@ public:
/**
* Apply a filter when building the list.
* @param filter_function The function which will be doing the filtering.
* @param params The params to give to the filters (minus the first param,
* @param ... The params to give to the filters (minus the first param,
* which is always the index-value).
* @game @pre ScriptCompanyMode::IsValid().
* @note You can write your own filters and use them. Just remember that
* the first parameter should be the index-value, and it should return
* a bool.
* @note Example:
* @code
* function IsType(group_id, type)
* {
* return ScriptGroup.GetVehicleType(group_id) == type;
* }
* ScriptGroupList(IsType, ScriptVehicle.VT_ROAD);
* local rv_groups = ScriptGroupList(IsType, ScriptVehicle.VT_ROAD);
* @endcode
*/
ScriptGroupList(void *filter_function, int params, ...);
ScriptGroupList(function filter_function, ...);
#else
/**
* The constructor wrapper from Squirrel.