BIS fnc dirIndicator: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " *\|= " to " ")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)
Line 1: Line 1:
{{Function|Comments=
{{Function


| arma2oa |Game name=
| arma2oa


|1.56|Game version=
|1.56


|gr1= GUI |GROUP1=
|gr1= GUI


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


| [origin, target, color, sizeCoef] call [[BIS_fnc_dirIndicator]] |SYNTAX=
| [origin, target, color, sizeCoef] call [[BIS_fnc_dirIndicator]]


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


|p2= target: [[Code]], [[String]], [[Object]] or [[Position]] - to which indicator points to:
|p2= target: [[Code]], [[String]], [[Object]] or [[Position]] - to which indicator points to:
Line 23: Line 23:
* [[String]] - [[missionNamespace]] variable name
* [[String]] - [[missionNamespace]] variable name
* [[Object]] - any object
* [[Object]] - any object
* [[Position]] - any position |PARAMETER2=
* [[Position]] - any position


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


| [[Script_(Handle)|Script handle]] |RETURNVALUE=
| [[Script_(Handle)|Script handle]]


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


| |SEEALSO=
|
}}
}}



Revision as of 00:02, 18 January 2021

-wrong parameter ("globargument") defined!-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 Position - to which indicator points to:
color: 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:
See also needed

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