IsKeyBound: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
Line 14: | Line 14: | ||
**'''"down":''' when the key is pressed | **'''"down":''' when the key is pressed | ||
*'''function:''' The function you're checking against | *'''function:''' The function you're checking against | ||
Note: If you do not specify a ''keyState'' or ''function'', any instances of ''key'' being bound will | Note: If you do not specify a ''keyState'' or ''function'', any instances of ''key'' being bound will cause ''isKeyBound'' to return ''true''. | ||
==Example== | ==Example== |
Revision as of 15:16, 11 October 2006
This function can be used to find out if a key has already been bound.
Syntax
bool isKeyBound ( player thePlayer, string key, [ string keyState, string function ] )
Required Arguments
- thePlayer: The player you're checking.
- key: The key you're checking. See Key names for a list of valid key names.
Optional Arguments
- keyState: Is the state of the key when it calls the function, Can be either:
- "up": when the key is released
- "down": when the key is pressed
- function: The function you're checking against
Note: If you do not specify a keyState or function, any instances of key being bound will cause isKeyBound to return true.
Example
See Also
- addCommandHandler
- bindKey
- executeCommandHandler
- getCommandHandlers
- getFunctionsBoundToKey
- getKeyBoundToFunction
- isControlEnabled
- removeCommandHandler
- toggleAllControls
- toggleControl
- unbindKey