keyImage: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " |game1= arma1 |version1= 1.00 |gr1" to " |game1= ofpe |version1= 1.00 |game2= arma1 |version2= 1.00 |game3= arma2 |version3= 1.00 |game4= arma2oa |version4= 1.50 |game5= tkoh |version5= 1.00 |game6= arma3 |version6= 0.50 |gr1")
m (Fiiix)
 
(14 intermediate revisions by 2 users not shown)
Line 23: Line 23:
|descr= Returns a structured text, containing an image or name (if no image is found) of the button, on the keyboard, mouse or joystick, with the given code.
|descr= Returns a structured text, containing an image or name (if no image is found) of the button, on the keyboard, mouse or joystick, with the given code.


|s1= [[keyImage]]  dikCode
|s1= [[keyImage]]  dikCode


|p1= dikCode: [[Number]]
|p1= dikCode: [[Number]] or {{GVI|arma3|2.08|size= 0.75}} [[String]]


|r1= [[Structured Text]]
|r1= [[Structured Text]]


|x1= <code>_name = [[keyImage]] 28; {{cc|result is "Enter"}}</code>
|x1= <sqf>_image = keyImage 28; // result is "Enter"</sqf>


|seealso= [[keyName]], [[actionKeys]], [[actionKeysImages]], [[actionKeysNames]], [[actionKeysNamesArray]], [[DIK KeyCodes]]
|x2= From Arma 3 v2.08:
<sqf>_image = keyImage "-1660944350"; // result is "Right Ctrl+G"</sqf>
 
|seealso= [[keyName]] [[actionKeys]] [[actionKeysImages]] [[actionKeysNames]] [[actionKeysNamesArray]] [[DIK KeyCodes]]
}}
}}
{{GameCategory|ofpe|Scripting Commands}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}

Latest revision as of 15:33, 17 April 2023

Hover & click on the images for description

Description

Description:
Returns a structured text, containing an image or name (if no image is found) of the button, on the keyboard, mouse or joystick, with the given code.
Groups:
System

Syntax

Syntax:
keyImage dikCode
Parameters:
dikCode: Number or Arma 3 logo black.png2.08 String
Return Value:
Structured Text

Examples

Example 1:
_image = keyImage 28; // result is "Enter"
Example 2:
From Arma 3 v2.08:
_image = keyImage "-1660944350"; // result is "Right Ctrl+G"

Additional Information

See also:
keyName actionKeys actionKeysImages actionKeysNames actionKeysNamesArray DIK KeyCodes

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