BIS_fnc_GUIhint

From Bohemia Interactive Community
Jump to navigation Jump to search
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.
Hover & click on the images for description

Description

Description:
/*

	Description:
	Creates advanced hintC dialog

	Parameter(s):
	_this select 0: ARRAY in format
		[text,picture]
			* text: STRING - hint text
			* picture: STRING - picture
		[item1,item2...] - Listbox item ARRAYs in format
			[itemText,itemDescription,picture,icon]
				* itemText: STRING - Text displayed in listbox
				* itemDescription (Optional): STRING - text displayed after clicking on item
				* picture (Optional): STRING - picture displayed after clicking on item
				* icon (Optional): STRING - icon displayed in listbox left from text
	_this select 1 (Optional): STRING - hint header
	_this select 2 (Optional): ARRAY - [STRING,CODE,NUMBER] - text on left button (when "", button is hidden), code executed upon clicking and fade out delay. If only text is present, button is disabled.
	_this select 3 (Optional): ARRAY - [STRING,CODE,NUMBER] - STRING - text on right button and code executed upon clicking
	_this select 4 (Optional): ARRAY - [STRING,CODE,NUMBER] - STRING - text on middle button and code executed upon clicking
	_this select 5 (Optional): NUMBER or ARRAY - width or [width,height] of picture (in grid coordinates). Width > 17 means only picture is used.

	Returns:
	ARRAY - [endState(,lbId)]
		* endState: NUMBER - 1 when clicked on right button, -1 when clicked on left button, 0 when escaped
		* lbId: NUMBER - selected listbox item (when listbox was used)
*/

#define DISPLAY_CLASS	'Hsim_RscDisplayCommonHint_guiHint'
#define DISPLAY_CONFIG	(configfile >> "RscDisplayCommonHint")
#define DISPLAY		(uinamespace getvariable DISPLAY_CLASS)
#define CONTROL		(DISPLAY displayctrl _idc)

#define CONTROL_FADEINTIME	0.3
#define CONTROL_FADEIN \
	CONTROL ctrlsetfade 1; \
	CONTROL ctrlcommit 0; \
	CONTROL ctrlsetfade 0; \
	CONTROL ctrlcommit CONTROL_FADEINTIME;

🏗
Placeholder description extracted from the function header by BIS_fnc_exportFunctionsToWiki.
Execution:
call
Groups:
GUI

Syntax

Syntax:
Syntax needed
Return Value:
Return value needed

Examples

Examples:
Example needed

Additional Information

See also:
BIS_fnc_GUImessage

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