Returns list of mod parameters according to given options, values are in same order as the given options.
modParams [modClass, options]
Parameters:
modClass: String - mod classname
options: Array of Strings - can be:
| Option | Data Type | Description |
|---|---|---|
"name" |
String | Name to be shown (Arma 3 instead of A3, etc.) |
"picture" |
String | Picture shown in Mod Launcher |
"logo" |
String | Logo to be shown in Main Menu |
"logoOver" |
String | Logo to be shown in Main Menu when mouse is over |
"logoSmall" |
String | Small version of logo, prepared for drawing small icons |
"tooltip" |
String | Tooltip to be shown on mouse over |
"tooltipOwned" |
String | Tooltip to be shown on mouse over the icon when DLC is owned by player |
"action" |
String | URL to be triggered when mod button is clicked |
"actionName" |
String | What to put on Action Button |
"overview" |
String | Overview text visible in expansion menu |
"hidePicture" |
Boolean | Do not show mod picture icon in the main menu mod list |
"hideName" |
Boolean | Do not show mod name in the main menu mod list |
"defaultMod" |
Boolean | Default mods cannot be moved or disabled by Mod Launcher |
"serverOnly" |
Boolean | Mod does not have to be installed on client in order to play on server with this mod running |
"active" |
Boolean | Active mod (activated through command line or stored in profile by mod launcher) > [!IMPORTANT] > Note that "active" does not actually tell if a mod is actually running. |
Returns: Array - retrieved requested data on success or empty array []
_data = modParams ["Kart", ["name", "logo", "picture"]];
configSourceModList · configSourceMod
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:
_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.
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.
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.