BIS fnc ORBATTooltip: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision)
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *T([a-z ])" to "$1 - t$2")
 
(35 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma3
____________________________________________________________________________________________
|version1= 1.00


| arma3 |= Game name
|gr1= Strategic


|1.00|= Game version
|descr= Animates an ORBAT viewer.
____________________________________________________________________________________________


| <pre>/*
|s1= [target, control, position] call [[BIS_fnc_ORBATTooltip]]


Description:
|p1= target: [[Config]] or [[Array]] - path to group in CfgORBAT or group params returned by [[BIS_fnc_ORBATGetGroupParams]]
Show group tooltip.
|p2= control: [[Control]] - tooltip control
|p3= position: [[Array]] - mouse position in format '''[x,y]'''


Parameter(s):
|r1= [[Boolean]]
0:
CONFIG - group from CfgORBAT
ARRAY - group params returned by BIS_fnc_ORBATGetGroupParams
1: CONTROL - tooltip control
2: ARRAY - mouse position in format [x,y]


Returns:
|x1=
BOOL
*/
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________
 
| <!-- [] call [[BIS_fnc_ORBATTooltip]]; --> |= Syntax
 
|p1= |= Parameter 1
 
| |= Return value
____________________________________________________________________________________________
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| |= See also


|seealso= [[ORBAT Viewer]] [[BIS_fnc_ORBATAddGroupOverlay]] [[BIS_fnc_ORBATAnimate]] [[BIS_fnc_ORBATConfigPreview]] [[BIS_fnc_ORBATGetGroupParams]] [[BIS_fnc_ORBATOpen]] [[BIS_fnc_ORBATRemoveGroupOverlay]] [[BIS_fnc_ORBATSetGroupFade]] [[BIS_fnc_ORBATSetGroupParams]]
}}
}}
<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: Strategic|{{uc:ORBATTooltip}}]]
[[Category:Functions|{{uc:ORBATTooltip}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:ORBATTooltip}}]]

Latest revision as of 15:51, 8 November 2023

Hover & click on the images for description

Description

Description:
Animates an ORBAT viewer.
Execution:
call
Groups:
Strategic

Syntax

Syntax:
[target, control, position] call BIS_fnc_ORBATTooltip
Parameters:
target: Config or Array - path to group in CfgORBAT or group params returned by BIS_fnc_ORBATGetGroupParams
control: Control - tooltip control
position: Array - mouse position in format [x,y]
Return Value:
Boolean

Examples

Examples:
Example needed

Additional Information

See also:
ORBAT Viewer BIS_fnc_ORBATAddGroupOverlay BIS_fnc_ORBATAnimate BIS_fnc_ORBATConfigPreview BIS_fnc_ORBATGetGroupParams BIS_fnc_ORBATOpen BIS_fnc_ORBATRemoveGroupOverlay BIS_fnc_ORBATSetGroupFade BIS_fnc_ORBATSetGroupParams

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