Difference between revisions of "BIS fnc VRDrawGrid"

Latest revision as of 01:15, 30 April 2023

1.00

Hover & click on the images for description

Description

Description:: Visualizes surface grid (used primarily for VR missions).

ⓘ

Only one instance of grid visualisation can run at any given time. Calling this function multiple times will only move the grid center.
Execution:: call
Groups:: VR

Syntax

Syntax:

[location, colour] call BIS_fnc_VRDrawGrid

Parameters:

location: Boolean or Array format Position:

Boolean: use false to disable grid visualisation
Position: center position (should be multiple of 4 in both axis to correspond with the tiles on the ground, like [1000,1000] or [2400,2400])

colour: Array - (Optional, default [0,0,0,1]) to format [R,G,B,A]

Return Value:

Nothing

Examples

Example 1:: [getPosATL player, [0.078, 0.3647, 0.0]] call BIS_fnc_VRDrawGrid;
Example 2:: [false] call BIS_fnc_VRDrawGrid;

Additional Information

See also:: BIS_fnc_VRDrawBorder

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 1: / Line 1: @@
+{{RV|type=function
-{{Function|= Comments
+|game1= arma3
-____________________________________________________________________________________________
+|version1= 1.00
-| arma3 |= Game name
+|gr1= VR
-|1.00|= Game version
+|descr= Visualizes surface grid (used primarily for VR missions).<br>
-____________________________________________________________________________________________
+{{Feature|Informative|Only one instance of grid visualisation can run at any given time. Calling this function multiple times will only move the grid center.}}
-| <pre>/*
+|s1= [location, colour] call [[BIS_fnc_VRDrawGrid]]
-	Description:
+|p1= location: [[Boolean]] or [[Array]] format [[Position]]:
-	Visualizes surface grid (used primarily for VR missions).
+* [[Boolean]]: use [[false]] to disable grid visualisation
-	NOTE: Only one instance of grid visualisation can run at any given time. Calling this function multiple times will only move the grid center
+* [[Position]]: center position (should be multiple of 4 in both axis to correspond with the tiles on the ground, like [1000,1000] or [2400,2400])
-	Parameter(s):
+|p2= colour: [[Array]] - (Optional, default [0,0,0,1]) to format [{{Color|red|R}},{{Color|green|G}},{{Color|blue|B}},{{Color|grey|A}}]
-:	ARRAY - center position (should be multiple of 4 in both axis to correspond with the tiles on the ground, like [1000,1000] or [2400,2400])
-			or
-			BOOL - use FALSE to disable grid visualisation
-:	(Optional) ARRAY - grid color [R,G,B,A], default black [0,0,0,1];
+|r1= [[Nothing]]
-	Returns:
+|x1= <sqf>[getPosATL player, [0.078, 0.3647, 0.0]] call BIS_fnc_VRDrawGrid;</sqf>
-	Nothing
-*/
-</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
+|x2= <sqf>[false] call BIS_fnc_VRDrawGrid;</sqf>
-____________________________________________________________________________________________
-| <!-- [] call [[BIS_fnc_VRDrawGrid]]; --> |= Syntax
-|p1= |= Parameter 1
-| |= Return value
-____________________________________________________________________________________________
-|x1= <code></code> |=
-____________________________________________________________________________________________
-| |= See also
+|seealso= [[BIS_fnc_VRDrawBorder]]
 }}
-<h3 style="display:none">Notes</h3>
-<dl class="command_description">
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
-</dl>
-<h3 style="display:none">Bottom Section</h3>
-[[Category:Function Group: VR|{{uc:VRDrawGrid}}]]
-[[Category:Functions|{{uc:VRDrawGrid}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:VRDrawGrid}}]]