BIS fnc moduleCoverMap: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "BIS fnc " to "BIS_fnc_")
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *O([a-z ])" to "$1 - o$2")
Line 21: Line 21:
|s1= [centerUnit,units,init] call [[BIS_fnc_moduleCoverMap]]
|s1= [centerUnit,units,init] call [[BIS_fnc_moduleCoverMap]]


|p1= centerUnit: [[Object]] - Object which is used as center
|p1= centerUnit: [[Object]] - object which is used as center


|p2= units: [[Array]] - '''Not used inside the function'''
|p2= units: [[Array]] - '''Not used inside the function'''

Revision as of 15:44, 8 November 2023

Hover & click on the images for description

Description

Description:
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 variable objectArea 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 - Rotation of the rectangle in degree
BIS fnc moduleCoverMap.jpg
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, false, 0]]; [_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