modParams

From Bohemia Interactive Community
Jump to: navigation, search
Hover & click on the images for description

Description

Description:
Returns list of mod parameters according to given options, values are in same order as the given options.
Groups:
Mods and Addons

Syntax

Syntax:
modParams [modClass, options]
Parameters:
modClass: String - mod classname
options: Array of Strings - can be:
Return Value:
Array - retrieved requested data on success or empty array []

Examples

Example 1:
Copy
_data = modParams ["Kart", ["name", "logo", "picture"]];

Additional Information

See also:
configSourceModList configSourceMod

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note
Killzone_Kid - c
Posted on Apr 24, 2017 - 21:25 (UTC)
This command used to spam .rpt when queried mod didn't exist, making it little awkward to use for testing if mod is active. For example:
Copy
_superDuperModEnabled = modParams ["super_duper", ["active"]] param [0, false];
Since v1.69 the command would fail silently if mod didn't exist, but would still log .rpt error if the mod name passed to the command was empty or there was an error processing one of the passed options.
heyoxe - c
Posted on Feb 26, 2021 - 16:42 (UTC)
For each value, it will first read the value from the mod.cpp file, if the value is not in it (or the files does not exist), it will try to read it from the CfgMods entry as long as it has the exact same name. If you try to get "name" and the command cannot find it in either of those locations, it will return the same value as the modClass input.
In practice, this means that content from user mods will always be read from mod.cpp and never from the CfgMods.
mikero - c
Posted on Oct 07, 2021 - 16:21 (UTC)
Later versions of PboProject and its friends with arma as the intended engine, will never allow a cfgmods to appear in a pbo. Instead, it will scribble it out to a mod.cpp in the mods\ folder that this pbo was intended for.