BIS fnc moduleCoverMap: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) |
Lou Montana (talk | contribs) m (Text replacement - "_{10,} " to "") |
||
| Line 1: | Line 1: | ||
{{Function|Comments= | {{Function|Comments= | ||
| arma3 |Game name= | | arma3 |Game name= | ||
| Line 9: | Line 8: | ||
|eff= global |Effects in MP= | |eff= global |Effects in MP= | ||
|Covers the map except a defined area to highlight the area of operation. Works on dedicated server. 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> | |Covers the map except a defined area to highlight the area of operation. Works on dedicated server. 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> | ||
| Line 18: | Line 16: | ||
*roation: [[Number]] - Rotation of the rectangle in degree | *roation: [[Number]] - Rotation of the rectangle in degree | ||
[[File:BIS fnc moduleCoverMap.jpg|500px]]|DESCRIPTION= | [[File:BIS fnc moduleCoverMap.jpg|500px]]|DESCRIPTION= | ||
| [centerUnit,units,init] call [[BIS_fnc_moduleCoverMap]]|SYNTAX= | | [centerUnit,units,init] call [[BIS_fnc_moduleCoverMap]]|SYNTAX= | ||
| Line 27: | Line 24: | ||
|[[Nothing]]|RETURNVALUE= | |[[Nothing]]|RETURNVALUE= | ||
|x1= <code>centerObject [[setVariable]] ["objectArea",[1000,1000,0,[[false]],0]]; | |x1= <code>centerObject [[setVariable]] ["objectArea",[1000,1000,0,[[false]],0]]; | ||
[_centerObject,[],[[true]]<noWiki>]</noWiki> [[call]] [[BIS_fnc_moduleCoverMap]];</code> | [_centerObject,[],[[true]]<noWiki>]</noWiki> [[call]] [[BIS_fnc_moduleCoverMap]];</code> | ||
//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|= | //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|= | ||
|[[showMap]]|SEEALSO= | |[[showMap]]|SEEALSO= | ||
Revision as of 23:27, 16 January 2021
Description
- Description:
- Covers the map except a defined area to highlight the area of operation. Works on dedicated server. 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
- roation: Number - Rotation of the rectangle in degree
- Execution:
- call
- Groups:
- Modules
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:
centerObject setVariable ["objectArea",[1000,1000,0,false,0]]; [_centerObject,[],true] 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
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