Difference between revisions of "VN fnc versioningHudToggle"

Latest revision as of 12:21, 22 February 2021

Introduced in S.O.G. Prairie Fire v1.00
by Pieter 'Stickie' De Stickere

Argument(s):	local
Effect(s):	local

Toggles the ingame revision overlay.

Syntax: [display] call VN_fnc_versioningHudToggle
Parameters: display: Display - display on which to create the overlay enable/disable button.
Return value: Boolean - true

@@ Line 1: / Line 1: @@
 {{Function
@@ Line 6: / Line 5: @@
 |author= Pieter 'Stickie' De Stickere
-|a=
+|a= local
-|e=
+|e= local
 |g1= GUI
-|d= <pre>/*
+|d= Toggles the ingame revision overlay.
-	File: fn_versioningHudToggle.sqf
-	Author: Pieter 'Stickie' De Stickere
-	Creation date: 2020-03-25 23:25:33
-	Description:
-		Toggles the ingame revision overlay.
-	Return:
-		Function reached the end [BOOL]
-*/
-</pre><small>''(Placeholder description extracted from the function header by '''LM_exportFunctionsToWiki.sqf''')''</small>
-|s= [] call [[VN_fnc_versioningHudToggle]];
+|s= [display] call [[VN_fnc_versioningHudToggle]]
-|p1n=
+|p1n= display
-|p1t=
+|p1t= display
-|p1d=
+|p1d= display on which to create the overlay enable/disable button.
 |p1v=
@@ Line 36: / Line 25: @@
 |p2v=
-|r1t=
+|r1t= boolean
-|r1d=
+|r1d= true
-|x1= <code>-</code>
+|x1= <code>[sogDisplay] call [[VN_fnc_versioningHudToggle]];</code>
 }}