{"name":"BIS_fnc_GUIhint","operator":null,"title":"BIS fnc GUIhint","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_GUIhint","revid":364353,"updated":"2024-05-06T10:37:04Z","groups":["GUI"],"status":"ok","replaced_by":[],"games":[{"game":"tkoh","name":"Take On Helicopters","version":"1.00"},{"game":"arma3","name":"Arma 3","version":"0.50"}],"since":{"game":"tkoh","name":"Take On Helicopters","version":"1.00"},"arma3_since":"0.50","branch":null,"locality":{"argument":null,"effect":null,"server_exec":false},"exec":null,"description":"Creates advanced hintC dialog","syntaxes":[{"syntax":"[param0] call BIS_fnc_GUIhint","since":null,"effect":null,"exec":null,"params":[{"name":"param0","type":"Array","types":["Array"],"optional":true,"default":null,"description":"[text,picture]\n         text: STRING - hint text\n         picture: STRING - picture\n    [item1,item2...] - Listbox item ARRAYs in format\n        [itemText,itemDescription,picture,icon]\n             itemText: STRING - Text displayed in listbox\n             itemDescription (Optional): STRING - text displayed after clicking on item\n             picture (Optional): STRING - picture displayed after clicking on item\n             icon (Optional): STRING - icon displayed in listbox left from text\n_this select 1 (Optional): STRING - hint header\n_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.\n_this select 3 (Optional): ARRAY - [STRING,CODE,NUMBER] - STRING - text on right button and code executed upon clicking\n_this select 4 (Optional): ARRAY - [STRING,CODE,NUMBER] - STRING - text on middle button and code executed upon clicking\n_this select 5 (Optional): NUMBER or ARRAY - width or [width,height] of picture (in grid coordinates). Width > 17 means only picture is used.","since":null,"text":"0: ARRAY in format\n    [text,picture]\n         text: STRING - hint text\n         picture: STRING - picture\n    [item1,item2...] - Listbox item ARRAYs in format\n        [itemText,itemDescription,picture,icon]\n             itemText: STRING - Text displayed in listbox\n             itemDescription (Optional): STRING - text displayed after clicking on item\n             picture (Optional): STRING - picture displayed after clicking on item\n             icon (Optional): STRING - icon displayed in listbox left from text\n_this select 1 (Optional): STRING - hint header\n_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.\n_this select 3 (Optional): ARRAY - [STRING,CODE,NUMBER] - STRING - text on right button and code executed upon clicking\n_this select 4 (Optional): ARRAY - [STRING,CODE,NUMBER] - STRING - text on middle button and code executed upon clicking\n_this select 5 (Optional): NUMBER or ARRAY - width or [width,height] of picture (in grid coordinates). Width > 17 means only picture is used.","source":"docblock"}],"returns":{"type":"Array","types":["Array"],"description":null,"text":"ARRAY - [endState(,lbId)]\n     endState: NUMBER - 1 when clicked on right button, -1 when clicked on left button, 0 when escaped\n     lbId: NUMBER - selected listbox item (when listbox was used)","source":"docblock"},"inferred":true}],"examples":[],"multiplayer":null,"problems":null,"aliases":[],"see_also":["BIS_fnc_GUImessage"],"notes":[],"categories":["Arma 3: Functions","Function Group: GUI","Functions","Introduced with Take On Helicopters version 1.00","Take On Helicopters: Functions","Take On Helicopters: New Functions"],"docblock":{"author":null,"description":"Creates advanced hintC dialog","params":[{"index":0,"name":null,"types":["Array"],"optional":true,"default":null,"description":"[text,picture]\n         text: STRING - hint text\n         picture: STRING - picture\n    [item1,item2...] - Listbox item ARRAYs in format\n        [itemText,itemDescription,picture,icon]\n             itemText: STRING - Text displayed in listbox\n             itemDescription (Optional): STRING - text displayed after clicking on item\n             picture (Optional): STRING - picture displayed after clicking on item\n             icon (Optional): STRING - icon displayed in listbox left from text\n_this select 1 (Optional): STRING - hint header\n_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.\n_this select 3 (Optional): ARRAY - [STRING,CODE,NUMBER] - STRING - text on right button and code executed upon clicking\n_this select 4 (Optional): ARRAY - [STRING,CODE,NUMBER] - STRING - text on middle button and code executed upon clicking\n_this select 5 (Optional): NUMBER or ARRAY - width or [width,height] of picture (in grid coordinates). Width > 17 means only picture is used.","text":"ARRAY in format\n    [text,picture]\n         text: STRING - hint text\n         picture: STRING - picture\n    [item1,item2...] - Listbox item ARRAYs in format\n        [itemText,itemDescription,picture,icon]\n             itemText: STRING - Text displayed in listbox\n             itemDescription (Optional): STRING - text displayed after clicking on item\n             picture (Optional): STRING - picture displayed after clicking on item\n             icon (Optional): STRING - icon displayed in listbox left from text\n_this select 1 (Optional): STRING - hint header\n_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.\n_this select 3 (Optional): ARRAY - [STRING,CODE,NUMBER] - STRING - text on right button and code executed upon clicking\n_this select 4 (Optional): ARRAY - [STRING,CODE,NUMBER] - STRING - text on middle button and code executed upon clicking\n_this select 5 (Optional): NUMBER or ARRAY - width or [width,height] of picture (in grid coordinates). Width > 17 means only picture is used."}],"returns":{"types":["Array"],"text":"ARRAY - [endState(,lbId)]\n     endState: NUMBER - 1 when clicked on right button, -1 when clicked on left button, 0 when escaped\n     lbId: NUMBER - selected listbox item (when listbox was used)"},"examples":[],"syntax":null,"execution":null,"notes":null,"requirements":null,"meta":{},"text":"Description:\nCreates advanced hintC dialog\n\nParameter(s):\n_this select 0: ARRAY in format\n    [text,picture]\n         text: STRING - hint text\n         picture: STRING - picture\n    [item1,item2...] - Listbox item ARRAYs in format\n        [itemText,itemDescription,picture,icon]\n             itemText: STRING - Text displayed in listbox\n             itemDescription (Optional): STRING - text displayed after clicking on item\n             picture (Optional): STRING - picture displayed after clicking on item\n             icon (Optional): STRING - icon displayed in listbox left from text\n_this select 1 (Optional): STRING - hint header\n_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.\n_this select 3 (Optional): ARRAY - [STRING,CODE,NUMBER] - STRING - text on right button and code executed upon clicking\n_this select 4 (Optional): ARRAY - [STRING,CODE,NUMBER] - STRING - text on middle button and code executed upon clicking\n_this select 5 (Optional): NUMBER or ARRAY - width or [width,height] of picture (in grid coordinates). Width > 17 means only picture is used.\n\nReturns:\nARRAY - [endState(,lbId)]\n     endState: NUMBER - 1 when clicked on right button, -1 when clicked on left button, 0 when escaped\n     lbId: NUMBER - selected listbox item (when listbox was used)"},"filled_from_docblock":["description","params","syntax","returns"]}