BIS fnc moduleCoverMap: Difference between revisions

Revision as of 17:39, 13 July 2022

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

Execution:

call

Groups:

Modules Map 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

@@ Line 10: / Line 10: @@
 |eff= global
-|descr= Covers the map except for a defined area. This function was designed to be used by the [[Modules|Modules framework]], but it can also be used without the module. The effect does not move with the centerObject.<br><br>It is essential for the function to work that '''centerObject''' has the variable '''objectArea''' defined.<br>
+|descr= Covers the map except for a defined area. This function was designed to be used by the [[Modules|Modules framework]], but it can also be used without the module. The effect does not move with the centerObject.<br><br>
-{{ic|centerObject [[setVariable]] ["objectArea", [sizeX, sizeY, rotation]]}}
+It is essential for the function to work that '''centerObject''' has the variable '''objectArea''' defined.<br>
-*centerObject [[Object]] - Object which is used as center
+<sqf inline>centerObject setVariable ["objectArea", [sizeX, sizeY, rotation]]</sqf>
-*sizeX: [[Number]] -  Length in x in meters
+* centerObject [[Object]] - Object which is used as center
-*sizeY: [[Number]] - Length in y in meters
+* sizeX: [[Number]] -  Length in x in meters
-*roation: [[Number]] - Rotation of the rectangle in degree
+* sizeY: [[Number]] - Length in y in meters
+* rotation: [[Number]] - Rotation of the rectangle in degree
 [[File:BIS fnc moduleCoverMap.jpg|500px]]
@@ Line 28: / Line 29: @@
 |r1= [[Nothing]]
-|x1= <code>centerObject [[setVariable]] ["objectArea",[1000, 1000, 0, [[false]], 0]];
+|x1= <sqf>
-[_centerObject,[],[[true]]<noWiki>]</noWiki> [[call]] [[BIS_fnc_moduleCoverMap]]; // Covers the whole map except an area of 1000 m by 1000 m, can be used to dynamically change size of the area during mission</code>
+// 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;
+</sqf>
 |seealso= [[showMap]]
 }}