BIS fnc moduleCoverMap: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " *\|= * " to " ")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)
Line 1: Line 1:
{{Function|Comments=
{{Function


| arma3 |Game name=
| arma3


|1.00|Game version=
|1.00


|gr1= Modules |GROUP1=
|gr1= Modules


|eff= global |Effects in MP=
|eff= global |Effects in MP=
Line 15: Line 15:
*sizeY: [[Number]] - Length in y in meters
*sizeY: [[Number]] - Length in y in meters
*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]]


| [centerUnit,units,init] call [[BIS_fnc_moduleCoverMap]]|SYNTAX=
| [centerUnit,units,init] call [[BIS_fnc_moduleCoverMap]]


|p1= centerUnit: [[Object]] - Object which is used as center|Parameter 1=
|p1= centerUnit: [[Object]] - Object which is used as center
|p2= units: [[Array]] - '''Not used inside the function'''|Parameter 2=
|p2= units: [[Array]] - '''Not used inside the function'''
|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


|[[Nothing]]|RETURNVALUE=
|[[Nothing]]


|x1= <code>centerObject [[setVariable]] ["objectArea",[1000,1000,0,[[false]],0]];   
|x1= <code>centerObject [[setVariable]] ["objectArea",[1000,1000,0,[[false]],0]];   
Line 29: Line 29:
//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]]


}}
}}

Revision as of 23:12, 17 January 2021

Hover & click on the images for description

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
BIS fnc moduleCoverMap.jpg
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

Bottom Section