BIS fnc moduleCoverMap: Difference between revisions
Jump to navigation
Jump to search
m (fixed example) |
m (further formatting) |
||
| Line 8: | Line 8: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| | |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 with module.<br><br>It's essential for the function to work that '''centerUnit''' has the variable '''objectArea''' defined.<br> | ||
<code> | <code>centerObject [[setVariable]] ["objectArea",[sizeX,sizeY,rotation]]</code> | ||
*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 | |||
[[File:BIS fnc moduleCoverMap.jpg|500px]]|DESCRIPTION= | [[File:BIS fnc moduleCoverMap.jpg|500px]]|DESCRIPTION= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Line 15: | Line 19: | ||
| [centerUnit,units,init] call [[BIS_fnc_moduleCoverMap]]|SYNTAX= | | [centerUnit,units,init] call [[BIS_fnc_moduleCoverMap]]|SYNTAX= | ||
|p1= centerUnit: [[Object]] - | |p1= centerUnit: [[Object]] - Object which is used as center|Parameter 1= | ||
|p2= units: [[Array]] - '''Not used inside the function'''|Parameter 2= | |p2= units: [[Array]] - '''Not used inside the function'''|Parameter 2= | ||
|p3= init: [[Boolean]] - [[True]] to create cover map effect, [[false]] to remove all markers and destroy the effect|Parameter 3= | |p3= init: [[Boolean]] - [[True]] to create cover map effect, [[false]] to remove all markers and destroy the effect|Parameter 3= | ||
| |RETURNVALUE= | |[[Nothing]]|RETURNVALUE= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
|x1= <code> | |x1= <code>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</code> |= | [_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</code> |= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| |SEEALSO= | |[[showMap]]|SEEALSO= | ||
}} | }} | ||
Revision as of 22:16, 7 August 2019
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 with module.
It's essential for the function to work that centerUnit 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:
- Uncategorised
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