BIS fnc customGPS: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Text replacement - "\|+$" to "")
(35 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma2oa
____________________________________________________________________________________________
|version1= 1.56


| arma2oa |= Game name
|game2= tkoh
|version2= 1.00


|1.00|= Game version
|game3= arma3
____________________________________________________________________________________________
|version3= 0.50


| <pre>
|gr1= GUI
/*


Description:
|eff= local
Replaces GPS frame.
Following line have to be defined in mission Description.ext:
onMinimapScript[] = {"BIS_fnc_customGPS_Spawn"};


Parameter(s):
|descr= Replaces GPS frame.<br>
_this select 0: STRING - Image path
The following line '''must''' be defined in mission [[Description.ext]]:
_this select 1 (Optional): NUMBER - Delta X
<syntaxhighlight lang="cpp">onMinimapScript[] = {"BIS_fnc_customGPS_Spawn"};
_this select 2 (Optional): NUMBER - Delta Y
</syntaxhighlight>


Returns:
|s1=[path, ''deltaX'', ''deltaY''] call [[BIS_fnc_customGPS]]
True
*/
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_customGPS]]; --> |= Syntax
|p1= path: [[String]] - full path to image file


|p1= |= Parameter 1
|p2= deltaX ''(Optional)'': [[Number]]


| |= Return value
|p3= deltaY ''(Optional)'': [[Number]]
____________________________________________________________________________________________


|x1= <code></code> |=
|r1= [[Boolean]]
____________________________________________________________________________________________


| |= See also
|x1= <code>["ca\missions_pmc\data\ui_gps_ca.paa", -0.05, 0.16] [[call]] [[BIS_fnc_customGPS]];</code>


|seealso= [[Functions Library]]
}}
}}
<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: GUI|{{uc:customGPS}}]]
[[Category:Functions|{{uc:customGPS}}]]
[[Category:{{Name|arma2oa}}: Functions|{{uc:customGPS}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:customGPS}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:customGPS}}]]

Revision as of 00:10, 17 June 2021

A2 OA Logo.png1.56tkoh logo small.png1.00Arma 3 logo black.png0.50
LELocal
Hover & click on the images for description

Description

Description:
Replaces GPS frame.
The following line must be defined in mission Description.ext: 
onMinimapScript[] = {"BIS_fnc_customGPS_Spawn"};
Execution:
call
Groups:
GUI

Syntax

Syntax:
[path, deltaX, deltaY] call BIS_fnc_customGPS
Parameters:
path: String - full path to image file
deltaX (Optional): Number
deltaY (Optional): Number
Return Value:
Boolean

Examples

Example 1:
["ca\missions_pmc\data\ui_gps_ca.paa", -0.05, 0.16] call BIS_fnc_customGPS;

Additional Information

See also:
Functions Library

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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_customGPS&oldid=282949"