ACSUtils Wiki

An ACS library for ZDoom-based ports

User Tools

Site Tools


input_functions

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revisionBoth sides next revision
input_functions [2017/04/15 18:23] korshuninput_functions [2017/04/15 18:24] korshun
Line 1: Line 1:
 ====== Input functions ====== ====== Input functions ======
-===== Introduction =====+
 ACSUtils provides a simplified interface to [[zdoom>GetPlayerInput]]. ACSUtils provides a simplified interface to [[zdoom>GetPlayerInput]].
 +
 +===== Function list =====
 +
 +A full list of new input functions:
 +
 +^ ^ Key ^ KeyAny ^ PlayerKey ^ PlayerKeyAny ^
 +^ up|[[functions:KeyUp]]|[[functions:KeyUpAny]]|[[functions:PlayerKeyUp]]|[[functions:PlayerKeyUpAny]]|
 +^ down|[[functions:KeyDown]]|[[functions:KeyDownAny]]|[[functions:PlayerKeyDown]]|[[functions:PlayerKeyDownAny]]|
 +^ pressed|[[functions:KeyPressed]]|[[functions:KeyPressedAny]]|[[functions:PlayerKeyPressed]]|[[functions:PlayerKeyPressedAny]]|
 +^ released|[[functions:KeyReleased]]|[[functions:KeyReleasedAny]]|[[functions:PlayerKeyReleased]]|[[functions:PlayerKeyReleasedAny]]|
 +
 +===== Introduction =====
  
 Each key can be Each key can be
Line 34: Line 46:
 will move the menu cursor down as many times as the key was hit. will move the menu cursor down as many times as the key was hit.
  
-===== Functions =====+===== Conventions =====
  
 ACSUtils provides a set of functions using the following convention: ACSUtils provides a set of functions using the following convention:
Line 47: Line 59:
   - If multiple keys are passed in (e.g. ''BT_ATTACK | BT_ALTATTACK''), then functions with the **Any** suffix return true if any of them are in the needed state, while functions without the suffix return true only if all of them are.   - If multiple keys are passed in (e.g. ''BT_ATTACK | BT_ALTATTACK''), then functions with the **Any** suffix return true if any of them are in the needed state, while functions without the suffix return true only if all of them are.
   - If the **Player** prefix is present, the function checks the keys of the specified player. Functions without the prefix check the activator's keys (equivalent to passing -1 to [[zdoom>GetPlayerInput]].   - If the **Player** prefix is present, the function checks the keys of the specified player. Functions without the prefix check the activator's keys (equivalent to passing -1 to [[zdoom>GetPlayerInput]].
- 
-===== Function list ===== 
- 
-A full list of new input functions: 
- 
-^ ^ Key ^ KeyAny ^ PlayerKey^ PlayerKeyAny ^ 
-^ up|[[functions:KeyUp]]|[[functions:KeyUpAny]]|[[functions:PlayerKeyUp]]|[[functions:PlayerKeyUpAny]]| 
-^ down|[[functions:KeyDown]]|[[functions:KeyDownAny]]|[[functions:PlayerKeyDown]]|[[functions:PlayerKeyDownAny]]| 
-^ pressed|[[functions:KeyPressed]]|[[functions:KeyPressedAny]]|[[functions:PlayerKeyPressed]]|[[functions:PlayerKeyPressedAny]]| 
-^ released|[[functions:KeyReleased]]|[[functions:KeyReleasedAny]]|[[functions:PlayerKeyReleased]]|[[functions:PlayerKeyReleasedAny]]| 
  
  
input_functions.txt · Last modified: 2017/07/09 15:47 by korshun