BIS fnc dirIndicator: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "[[Script_(Handle)|" to "[[Script Handle|")
m (Text replacement - "Script handle" to "Script Handle")
 
(One intermediate revision by the same user not shown)
Line 17: Line 17:


|descr= Show a 4-directions indicator.<br>
|descr= Show a 4-directions indicator.<br>
Indicator GUI layer is 17, its [[Display]] is accessible with {{ic|[[uiNamespace]] [[getVariable]] "BIS_RscMissionScreen_dirIndicator"}}.<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.
Can be reexecuted to change its colour, but once executed this function '''cannot''' be halted  until ''origin''<nowiki/>'s death.


Line 24: Line 24:
|p1= origin: [[Object]] - origin, usually [[player]]
|p1= origin: [[Object]] - origin, usually [[player]]


|p2= target: [[Code]], [[String]], [[Object]] or [[Position]] - to which indicator points to:
|p2= target: [[Code]], [[String]], [[Object]] or [[Array]] format [[Position]] - to which indicator points to:
* [[Code]] - code result must be [[Object]] or [[Position]]
* [[Code]] - code result must be [[Object]] or [[Position]]
* [[String]] - [[missionNamespace]] variable name
* [[String]] - [[missionNamespace]] variable name
* [[Object]] - any object
* [[Object]] - any object
* [[Position]] - any position
* [[Array]] format [[Position]] - any position


|p3= color: [[Color|Color (RGBA)]] - (Optional, default [0.424,0.651,0.247,1] ({{arma2}} green))
|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
|p4= sizeCoef: [[Number]] - (Optional, default 0.1045752 (command bar height)) size coefficient


|r1= [[Script Handle|Script handle]]
|r1= [[Script Handle]]


|x1= <code>[<nowiki/>[[player]], TheBoss, [0.706, 0.0745, 0.0196, 1]] [[call]] [[BIS_fnc_dirIndicator]];</code>
|x1= <sqf>[player, TheBoss, [0.706, 0.0745, 0.0196, 1]] call BIS_fnc_dirIndicator;</sqf>


|seealso=
|seealso= [[getRelDir]]
}}
}}

Latest revision as of 18:17, 9 August 2022

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:
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