BIS fnc holdKey: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Some wiki formatting) |
m (linked BIS_fnc_keyHold for convenience) |
||
| (3 intermediate revisions by one other user not shown) | |||
| Line 6: | Line 6: | ||
|gr1= Interaction | |gr1= Interaction | ||
|descr= Function that executes | |descr= Function that executes code when a key has been held down for a long enough time - "Hold X to Advance" text is displayed when any key is pressed.<br> | ||
All other keys (but {{Controls|Esc}}) are deactivated until the conditions are met - only mouse controls work (character rotation and fire). | |||
|exec= spawn | |||
|s1= [display, key, time, code, control] call [[BIS_fnc_holdKey]] | |s1= [display, key, time, code, control] call [[BIS_fnc_holdKey]] | ||
|p1= display: [[Display]] - display the event is attached to. By default it is the map display | |p1= display: [[Display]] - (Optional, default <sqf inline>findDisplay 12</sqf> for map display) display the event is attached to. By default it is the map display | ||
|p2= key: [[Number]] - what key to press | |p2= key: [[Number]] - (Optional, default 57 for {{Controls|Space}}) what key to press - see [[DIK KeyCodes]] | ||
|p3= time: [[Number]] - how long the key has to be held down in seconds | |p3= time: [[Number]] - (Optional, default 3) how long the key has to be held down in seconds | ||
|p4= code: [[Code]] - code to be executed when key is held down for long enough | |p4= code: [[Code]] - (Optional, default <sqf inline>{}</sqf>) [[Scheduler#Scheduled Environment|scheduled]] code to be executed when key is held down for long enough | ||
|p5= control: [[Control]] - (Optional, default [[controlNull]]) text control to be used in place of the default "Press X to skip" control. | |p5= control: [[Control]] - (Optional, default [[controlNull]]) text control to be used in place of the default "Press X to skip" control. | ||
| Line 22: | Line 25: | ||
|r1= [[Nothing]] | |r1= [[Nothing]] | ||
|x1= <sqf>[findDisplay 46, 36, 5, { hint "Key 'J' pressed for 5 seconds" }] | |x1= <sqf>[findDisplay 46, 36, 5, { hint "Key 'J' pressed for 5 seconds" }] spawn BIS_fnc_holdKey; // action is added to the mission display</sqf> | ||
|seealso= [[BIS_fnc_holdActionAdd]] [[addAction]] | |seealso= [[BIS_fnc_holdActionAdd]] [[addAction]] [[BIS_fnc_keyHold]] | ||
}} | }} | ||
Latest revision as of 21:02, 5 June 2023
Description
- Description:
- Function that executes code when a key has been held down for a long enough time - "Hold X to Advance" text is displayed when any key is pressed.
All other keys (but Esc) are deactivated until the conditions are met - only mouse controls work (character rotation and fire). - Execution:
- spawn
- Groups:
- Interaction
Syntax
- Syntax:
- [display, key, time, code, control] call BIS_fnc_holdKey
- Parameters:
- display: Display - (Optional, default findDisplay 12 for map display) display the event is attached to. By default it is the map display
- key: Number - (Optional, default 57 for Space) what key to press - see DIK KeyCodes
- time: Number - (Optional, default 3) how long the key has to be held down in seconds
- code: Code - (Optional, default {}) scheduled code to be executed when key is held down for long enough
- control: Control - (Optional, default controlNull) text control to be used in place of the default "Press X to skip" control.
- Return Value:
- Nothing
Examples
- Example 1:
- [findDisplay 46, 36, 5, { hint "Key 'J' pressed for 5 seconds" }] spawn BIS_fnc_holdKey; // action is added to the mission display
Additional Information
- See also:
- BIS_fnc_holdActionAdd addAction BIS_fnc_keyHold
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