BIS fnc dirIndicator: Difference between revisions

Latest revision as of 19:17, 9 August 2022

1.56

1.00

0.50

GAGlobal LELocal

Hover & click on the images for description

Description

Description:: Show a 4-directions indicator.
Indicator GUI layer is 17, its Display is accessible with uiNamespace getVariable "BIS_RscMissionScreen_dirIndicator".
Can be reexecuted to change its colour, but once executed this function cannot be halted until origin's death.
Execution:: call
Groups:: GUI

Syntax

Syntax:

[origin, target, color, sizeCoef] call BIS_fnc_dirIndicator

Parameters:

origin: Object - origin, usually player

target: Code, String, Object or Array format Position - to which indicator points to:

Code - code result must be Object or Position
String - missionNamespace variable name
Object - any object
Array format Position - any position

color: Array format Color (RGBA) - (Optional, default [0.424,0.651,0.247,1] (Arma 2 green))

sizeCoef: Number - (Optional, default 0.1045752 (command bar height)) size coefficient

Return Value:

Script Handle

Examples

Example 1:: [player, TheBoss, [0.706, 0.0745, 0.0196, 1]] call BIS_fnc_dirIndicator;

Additional Information

See also:: getRelDir

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: @@
-{{Function|=
+{{RV|type=function
-____________________________________________________________________________________________
-| arma2oa |=
+|game1= arma2oa
+|version1= 1.56
-|1.56|=
+|game2= tkoh
+|version2= 1.00
-|arg= glob |=
+|game3= arma3
+|version3= 0.50
-|eff= local |=
+|gr1= GUI
-____________________________________________________________________________________________
-| Show a 4-directions indicator.<br />
+|arg= global
-Indicator GUI layer is 17, its [[Display]] is accessible with {{Inline code|[[uiNamespace]] [[getVariable]] "BIS_RscMissionScreen_dirIndicator"}}.<br />
-Can be reexecuted to change its colour, but once executed this function '''cannot''' be halted until ''origin''<nowiki>'</nowiki>s death. |= Description
-____________________________________________________________________________________________
-| [origin, target, color, sizeCoef] call [[BIS_fnc_dirIndicator]]  |= Syntax
+|eff= local
-|p1= origin: [[Object]] - origin, usually [[player]] |= Parameter 1
+|descr= Show a 4-directions indicator.<br>
+Indicator GUI layer is 17, its [[Display]] is accessible with <sqf inline>uiNamespace getVariable "BIS_RscMissionScreen_dirIndicator"</sqf>.<br>
+Can be reexecuted to change its colour, but once executed this function '''cannot''' be halted  until ''origin''<nowiki/>'s death.
-|p2= target: [[Code]], [[String]], [[Object]] or [[Position]] - to which indicator points to:
+|s1= [origin, target, color, sizeCoef] call [[BIS_fnc_dirIndicator]]
+|p1= origin: [[Object]] - origin, usually [[player]]
+|p2= target: [[Code]], [[String]], [[Object]] or [[Array]] format [[Position]] - to which indicator points to:
 * [[Code]] - code result must be [[Object]] or [[Position]]
 * [[String]] - [[missionNamespace]] variable name
 * [[Object]] - any object
-* [[Position]] - any position |= Parameter 2
+* [[Array]] format [[Position]] - any position
-|p3= color: [[Color]] - (Optional, default [0.424,0.651,0.247,1] ({{arma2}} green)) |= Parameter 3
+|p3= color: [[Array]] format [[Color|Color (RGBA)]] - (Optional, default [0.424,0.651,0.247,1] ({{arma2}} green))
-|p4= sizeCoef: [[Number]] - (Optional, default 0.1045752 (command bar height)) size coefficient |= Parameter 4
+|p4= sizeCoef: [[Number]] - (Optional, default 0.1045752 (command bar height)) size coefficient
-| [[Script_(Handle)|Script handle]] |= Return value
+|r1= [[Script Handle]]
-|x1= <code><nowiki>[</nowiki>[[player]], TheBoss, [0.706, 0.0745, 0.0196, 1]] [[call]] [[BIS_fnc_dirIndicator]];</code>|= Example 1
+|x1= <sqf>[player, TheBoss, [0.706, 0.0745, 0.0196, 1]] call BIS_fnc_dirIndicator;</sqf>
-____________________________________________________________________________________________
-| |= See also
+|seealso= [[getRelDir]]
 }}
-<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:dirIndicator}}]]
-[[Category:Functions|{{uc:dirIndicator}}]]
-[[Category:{{Name|arma2oa}}: Functions|{{uc:dirIndicator}}]]
-[[Category:{{Name|tkoh}}: Functions|{{uc:dirIndicator}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:dirIndicator}}]]