Difference between revisions of "VN fnc module UI gestureMenu KeyHandler"

From Savage Game Design Wiki
Jump to navigation Jump to search
m (Text replacement - "]]; |p1n=" to "]] |p1n=")
(Page filling)
Line 1: Line 1:
−
[[Category:TODO]]
 
 
{{Function
 
{{Function
  
 
|v= 1.00
 
|v= 1.00
  
−
|author=  
+
|author= Dscha
  
 
|a=
 
|a=
  
−
|e=
+
|e= local
  
 
|g1= gesture_menu
 
|g1= gesture_menu
  
−
|d= <pre>/* ----------------------------------------------------------------------------
+
|d= {{Biki|User_Interface_Event_Handlers#onKeyUp|"keyUp" UI Eventhandler}} function, runs code and blocks standard key. Default key: Y (on a QWERTY keyboard).
−
Function: vn_fnc_module_UI_gestureMenu_KeyHandler
+
Uses [[VN_fnc_kbm_getKey]].
  
−
Description:
+
|s= [display, key, shift, ctrl, alt] call [[VN_fnc_module_UI_gestureMenu_KeyHandler]]
−
- Eventhandler Function!
 
−
- Checks Z/Y (The one between "T" and "U"...) and executes (+blocks) it
 
  
−
Parameters:
+
|p1n= display
−
["_displayorcontrol", "_key", "_shift", "_ctrl", "_alt"];
+
|p1t= {{Biki|Display}} or {{Biki|Control}}
−
0 - DISPLAY - NOT USED - The Display (or control) it was executed on
+
|p1d= EH display or control, unused
−
1 - INTEGER - Pressed Button
+
|p1v= {{Biki|nil}}
−
2 - BOOL - NOT USED - SHIFT pressed?
 
−
3 - BOOL - NOT USED - CTRL pressed?
 
−
4 - BOOL - NOT USED - ALT pressed?
 
  
−
Example:
+
|p2n= key
−
(findDisplay 46) displayAddEventHandler ["KeyUp", {call vn_fnc_module_UI_gestureMenu_KeyHandler;}];
+
|p2t= number
−
 
+
|p2d= pressed key
−
Returns:
+
|p2v=
−
- Nothing
 
−
 
 
−
Author:
 
−
Dscha
 
−
---------------------------------------------------------------------------- */
 
−
</pre><small>''(Placeholder description extracted from the function header by '''LM_exportFunctionsToWiki.sqf''')''</small>
 
  
−
|s= [] call [[VN_fnc_module_UI_gestureMenu_KeyHandler]]
+
|p3n= shift
 +
|p3t= boolean
 +
|p3d= is shift key pressed
 +
|p3v=
  
−
|p1n=
+
|p4n= ctrl
−
|p1t=
+
|p4t= boolean
−
|p1d=
+
|p4d= is ctrl key pressed
−
|p1v=
+
|p4v=
  
−
|p2n=
+
|p5n= alt
−
|p2t=
+
|p5t= boolean
−
|p2d=
+
|p5d= is alt key pressed
−
|p2v=
+
|p5v=
  
 
|r1t=
 
|r1t=
 
|r1d=
 
|r1d=
  
−
|x1= <code>-</code>
+
|x1= <code>(findDisplay 46) displayAddEventHandler ["KeyUp", { call VN_fnc_module_UI_gestureMenu_KeyHandler; }];</code>
 
}}
 
}}

Revision as of 19:07, 21 January 2021

← back to Functions Introduced in S.O.G. Prairie Fire v1.00
by Dscha
Argument(s): n/a
Effect(s): local

Description

"keyUp" UI Eventhandler function, runs code and blocks standard key. Default key: Y (on a QWERTY keyboard). Uses VN_fnc_kbm_getKey.

Syntax

Syntax
[display, key, shift, ctrl, alt] call VN_fnc_module_UI_gestureMenu_KeyHandler
Parameters
display: Display or Control - (Optional, default nil) EH display or control, unused
key: Number - pressed key
shift: Boolean - is shift key pressed
ctrl: Boolean - is ctrl key pressed
alt: Boolean - is alt key pressed
Return value
Nothing

Examples

Example 1
(findDisplay 46) displayAddEventHandler ["KeyUp", { call VN_fnc_module_UI_gestureMenu_KeyHandler; }];
Retrieved from "https://wiki.sogpf.com/index.php?title=VN_fnc_module_UI_gestureMenu_KeyHandler&oldid=3994"