BIS fnc customGPS: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
mNo edit summary
Line 1: Line 1:
{{Command|=
____________________________________________________________________________________________


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


| arma2oa |= Game name
|arg= |= MPARGUMENTS


|1.00|= Game version
|eff= local |= Effects in MP
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>
| Replaces GPS frame.<br /><br />Following line have to be defined in mission Description.ext:<br /><code>onMinimapScript[] <nowiki>=</nowiki> {"BIS_fnc_customGPS_Spawn"};</code>|=
/*
____________________________________________________________________________________________


Description:
| [path,''deltaX'',''deltaY''] call '''BIS_fnc_customGPS'''  |=
Replaces GPS frame.
Following line have to be defined in mission Description.ext:
onMinimapScript[] = {"BIS_fnc_customGPS_Spawn"};


Parameter(s):
|p1= path: [[String]] - full path to image file |= PARAMETER1
_this select 0: STRING - Image path
_this select 1 (Optional): NUMBER - Delta X
_this select 2 (Optional): NUMBER - Delta Y


Returns:
|p2= deltaX ''(Optional)'': [[Number]] |= PARAMETER2
True
*/
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_customGPS]]; --> |= Syntax
|p3= deltaY ''(Optional)'': [[Number]] |= PARAMETER3


|p1= |= Parameter 1
| [[Boolean]] |= RETURNVALUE


| |= Return value
|x1= <code>["ca\missions_pmc\data\ui_gps_ca.paa",-0.05,0.16] [[call]] bis_fnc_customGPS;</code>|= EXAMPLE1
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code></code> |=  
| [[Functions Library]] |= SEEALSO
 
|= MPBEHAVIOUR
____________________________________________________________________________________________
____________________________________________________________________________________________
| |= See also
}}
}}


<h3 style="display:none">Notes</h3>
<h3 style='display:none'>Notes</h3>
<dl class="command_description">
<dl class='command_description'>
<!-- Note Section BEGIN -->
<!-- Note Section BEGIN -->


Line 48: Line 40:
</dl>
</dl>


<h3 style="display:none">Bottom Section</h3>
<h3 style='display:none'>Bottom Section</h3>
[[Category:Function Group: GUI|{{uc:customGPS}}]]
 
[[Category:Functions|{{uc:customGPS}}]]
[[Category:ArmA 2: Functions|CUSTOMGPS}}]]
[[Category:{{Name|arma2oa}}: Functions|{{uc:customGPS}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:customGPS}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:customGPS}}]]

Revision as of 11:54, 29 November 2010

Hover & click on the images for description

Description

Description:
Replaces GPS frame.

Following line have to be defined in mission Description.ext:
onMinimapScript[] = {"BIS_fnc_customGPS_Spawn"};
Groups:
Uncategorised

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

Notes

Bottom Section