Add: [Script] Optional filter parameter to more ScriptXXXList constructors (#11698)

This commit is contained in:
Loïc Guilloux
2024-01-09 09:39:13 +01:00
committed by GitHub
parent f1e999ec59
commit c86d918921
17 changed files with 283 additions and 120 deletions

View File

@@ -20,10 +20,35 @@
*/
class ScriptGroupList : public ScriptList {
public:
#ifdef DOXYGEN_API
/**
* @game @pre ScriptCompanyMode::IsValid().
*/
ScriptGroupList();
/**
* 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,
* 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:
* function IsType(group_id, type)
* {
* return ScriptGroup.GetVehicleType(group_id) == type;
* }
* ScriptGroupList(IsType, ScriptVehicle.VT_ROAD);
*/
ScriptGroupList(void *filter_function, int params, ...);
#else
/**
* The constructor wrapper from Squirrel.
*/
ScriptGroupList(HSQUIRRELVM vm);
#endif /* DOXYGEN_API */
};
#endif /* SCRIPT_GROUPLIST_HPP */