modParams: Difference between revisions
Jump to navigation
Jump to search
m (format) |
Killzone Kid (talk | contribs) No edit summary |
||
Line 6: | Line 6: | ||
|eff= |= Multiplayer Effects | |eff= |= Multiplayer Effects | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Returns list of mod | | Returns list of mod parameters according to given options, values are in same order as the given options. Available options: | ||
* <tt>"name"</tt>: [[String]] - name to be shown (Arma 3 instead of A3, etc.) | |||
* <tt>"picture"</tt>: [[String]] - picture shown in Mod Launcher | |||
* <tt>"logo"</tt>: [[String]] - logo to be shown in Main Menu | |||
* <tt>"logoOver":</tt> [[String]] - logo to be shown in Main Menu when mouse is over | |||
* <tt>"logoSmall"</tt>: [[String]] - small version of logo, prepared for drawing small icons | |||
* <tt>"tooltip"</tt>: [[String]] - tooltip to be shown on mouse over | |||
* <tt>"tooltipOwned"</tt>: [[String]] - tooltip to be shown on mouse over the icon when DLC is owned by player | |||
* <tt>"action"</tt>: [[String]] - url to be triggered when mod button is clicked | |||
* <tt>"actionName"</tt>: [[String]] - what to put on Action Button | |||
* <tt>"overview"</tt>: [[String]] - overview text visible in expansion menu | |||
* <tt>"hidePicture"</tt>: [[Boolean]] - do not show mod picture icon in the main menu mod list | |||
* <tt>"hideName"</tt>: [[Boolean]] - do not show mod name in the main menu mod list | |||
* <tt>"defaultMod"</tt>: [[Boolean]] - default mods cannot be moved or disabled by Mod Launcher | |||
* <tt>"serverOnly"</tt>: [[Boolean]] - mod doesn't have to be installed on client in order to play on server with this mod running | |||
* <tt>"active"</tt>: [[Boolean]] - active mod (activated through command line or stored in profile by mod launcher) |= Description | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [[modParams]] [modClass, options] |= Syntax | | [[modParams]] [modClass, options] |= Syntax | ||
|p1= modClass: [[String]] - class name of the mod |= Parameter 1 | |p1= [modClass, options]: [[Array]]|= | ||
| | |p2= modClass: [[String]] - class name of the mod |= Parameter 1 | ||
|p3= options: [[Array]] - see description |= Parameter 2 | |||
| [[Array]] - retrieved requested data on success or empty array [] |= Return Value | |||
| [[Array]] - | |||
|x1= <code>_data = [[modParams]] ["Kart", ["name", "logo", "picture"]];</code> |= Example 1 | |x1= <code>_data = [[modParams]] ["Kart", ["name", "logo", "picture"]];</code> |= Example 1 | ||
| - |= See Also | | - |= See Also |
Revision as of 18:56, 19 April 2017
Description
- Description:
- Returns list of mod parameters according to given options, values are in same order as the given options. Available options:
- "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 doesn't 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)
- Groups:
- Uncategorised
Syntax
- Syntax:
- modParams [modClass, options]
- Parameters:
- [modClass, options]: Array
- modClass: String - class name of the mod
- options: Array - see description
- Return Value:
- Array - retrieved requested data on success or empty array []
Examples
- Example 1:
_data = modParams ["Kart", ["name", "logo", "picture"]];
Additional Information
- See also:
- -
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