BIS_fnc_moduleCoverMap

From Bohemia Interactive Community
Revision as of 09:51, 20 January 2024 by POLPOX (talk | contribs) (triggerArea note and example tweak)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
Hover & click on the images for description

Description

Description:
BIS fnc moduleCoverMap.jpg

Covers the map except for a defined area. This function was designed to be used by the Modules framework, but it can also be used without the module. The effect does not move with the centerObject.

It is essential for the function to work that centerObject has the objectArea variable defined.

centerObject setVariable ["objectArea", [sizeX, sizeY, rotation]]

  • centerObject: Object - object which is used as center
  • sizeX: Number - length in x in meters
  • sizeY: Number - length in y in meters
  • rotation: Number - shape's rotation in degree
Execution:
call
Groups:
ModulesMap and Markers

Syntax

Syntax:
[centerUnit, units, init] call BIS_fnc_moduleCoverMap
Parameters:
centerUnit: Object - object which is used as center
units: Array - Not used inside the function
init: Boolean - true to create cover map effect, false to remove all markers and destroy the effect
Return Value:
Nothing

Examples

Example 1:
// covers the whole map except an area of 1000m by 1000m // can be used to dynamically change size of the area during mission centerObject setVariable ["objectArea",[1000, 1000, 0]]; // same format with triggerArea, except the function only needs first three [centerObject, [], true] call BIS_fnc_moduleCoverMap;

Additional Information

See also:
showMap

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