BIS fnc createTooltip: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
(Page overhaul. Added examples)
Line 7: Line 7:
|descr= Shows group tooltip. Adapted for Tac Ops DLC for use in the animated briefings.  
|descr= Shows group tooltip. Adapted for Tac Ops DLC for use in the animated briefings.  


|s1= [input, ctrl, mousePos] call [[BIS_fnc_createTooltip]]
|s1= [input, display, mousePos] call [[BIS_fnc_createTooltip]]


|p1= input: [[Array]] -  
|p1= input: [[Array]] -  
Line 13: Line 13:
* 1: [[Array]] - Group params returned by [[BIS_fnc_ORBATGetGroupParams]]
* 1: [[Array]] - Group params returned by [[BIS_fnc_ORBATGetGroupParams]]


|p2= ctrl: [[Display]] - Display where tooltip controls group is created
|p2= display: [[Display]] - Display where tooltip controls group is created


|p3= mousePos: [[Array]] - Mouse position in format [x,y]
|p3= mousePos: [[Array]] - Mouse position in format [x, y]


|r1= [[Boolean]]
|r1= [[Boolean]]
|x1= <sqf>// enable icons in 2D and 3D
setGroupIconsVisible [true, true];
setGroupIconsSelectable true;
// add the icon for all existing groups
private _group = group player;
private _color = [side _group, false] call BIS_fnc_sideColor;
_group addGroupIcon ["o_inf", [0, 0]];
_group setGroupIconParams [_color, groupID _group, 1, true];
// show tooltip when hovering over group icon of player group
addMissionEventHandler ["GroupIconOverEnter",
{
params
[
  "_is3D", "_group", "_waypointId",
  "_posX", "_posY",
  "_shift", "_control", "_alt"
];
[configFile >> "CfgORBAT" >> "BIS" >> "I_AAF", findDisplay 12, getMousePosition] call BIS_fnc_createTooltip;
}];
// remove tooltip when leaving group icon area
addMissionEventHandler ["GroupIconOverLeave",
{
params
[
  "_is3D", "_group", "_waypointId",
  "_posX", "_posY",
  "_shift", "_control", "_alt"
];
[nil, findDisplay 12, getMousePosition] call BIS_fnc_createTooltip;
}];</sqf>
|x2= <sqf>_marker = createMarker ["marker_0", [worldSize / 2, worldSize / 2]];
_marker setMarkerType "flag_Germany";
_marker setMarkerText "GERMANY";
_marker = createMarker ["marker_1", [worldSize / 1.5, worldSize / 1.5]];
_marker setMarkerType "flag_Altis";
_marker setMarkerText "ALTIS";
findDisplay 12 displayCtrl 51 ctrlAddEventHandler
[
  "draw",
  {
    params ["_ctrlMap"];
    ctrlMapMouseOver _ctrlMap params [["_type", ""], ["_markerName", ""]];
    if (_type == "marker") then
    {
      private _markerTexture = getText (configFile >> "CfgMarkers" >> markerType _markerName >> "icon");
      private _markerText = markerText _markerName;
      [[nil, nil, _markerName, nil, _markerTexture, nil, nil, nil, _markerText, nil, nil, "Some Description"], findDisplay 12, getMousePosition] call BIS_fnc_createTooltip;
    }
    else
    {
      [nil, findDisplay 12, getMousePosition] call BIS_fnc_createTooltip;
    };
  }
];</sqf>


|seealso= [[BIS_fnc_ORBATGetGroupParams]]  
|seealso= [[BIS_fnc_ORBATGetGroupParams]]  
}}
}}

Revision as of 15:57, 27 December 2023

Hover & click on the images for description

Description

Description:
Shows group tooltip. Adapted for Tac Ops DLC for use in the animated briefings.
Execution:
call
Groups:
GUI

Syntax

Syntax:
[input, display, mousePos] call BIS_fnc_createTooltip
Parameters:
input: Array -
display: Display - Display where tooltip controls group is created
mousePos: Array - Mouse position in format [x, y]
Return Value:
Boolean

Examples

Example 1:
// enable icons in 2D and 3D setGroupIconsVisible [true, true]; setGroupIconsSelectable true; // add the icon for all existing groups private _group = group player; private _color = [side _group, false] call BIS_fnc_sideColor; _group addGroupIcon ["o_inf", [0, 0]]; _group setGroupIconParams [_color, groupID _group, 1, true]; // show tooltip when hovering over group icon of player group addMissionEventHandler ["GroupIconOverEnter", { params [ "_is3D", "_group", "_waypointId", "_posX", "_posY", "_shift", "_control", "_alt" ]; [configFile >> "CfgORBAT" >> "BIS" >> "I_AAF", findDisplay 12, getMousePosition] call BIS_fnc_createTooltip; }]; // remove tooltip when leaving group icon area addMissionEventHandler ["GroupIconOverLeave", { params [ "_is3D", "_group", "_waypointId", "_posX", "_posY", "_shift", "_control", "_alt" ]; [nil, findDisplay 12, getMousePosition] call BIS_fnc_createTooltip; }];
Example 2:
_marker = createMarker ["marker_0", [worldSize / 2, worldSize / 2]]; _marker setMarkerType "flag_Germany"; _marker setMarkerText "GERMANY"; _marker = createMarker ["marker_1", [worldSize / 1.5, worldSize / 1.5]]; _marker setMarkerType "flag_Altis"; _marker setMarkerText "ALTIS"; findDisplay 12 displayCtrl 51 ctrlAddEventHandler [ "draw", { params ["_ctrlMap"]; ctrlMapMouseOver _ctrlMap params [["_type", ""], ["_markerName", ""]]; if (_type == "marker") then { private _markerTexture = getText (configFile >> "CfgMarkers" >> markerType _markerName >> "icon"); private _markerText = markerText _markerName; [[nil, nil, _markerName, nil, _markerTexture, nil, nil, nil, _markerText, nil, nil, "Some Description"], findDisplay 12, getMousePosition] call BIS_fnc_createTooltip; } else { [nil, findDisplay 12, getMousePosition] call BIS_fnc_createTooltip; }; } ];

Additional Information

See also:
BIS_fnc_ORBATGetGroupParams

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