Squirrel/Server/Events/Player/onPlayerKeyStateChange
From Liberty Unleashed Wiki
(Difference between revisions)
| (3 intermediate revisions by one user not shown) | |||
| Line 1: | Line 1: | ||
| − | {{Squirrel/Title| | + | {{Squirrel/Title|onPlayerKeyStateChange}} |
| − | This is called when a player | + | |
| + | This is called when a player presses or stops pressing a certain key. | ||
== Syntax == | == Syntax == | ||
| − | <code>function onPlayerKeyStateChange ( | + | <code>function onPlayerKeyStateChange ( player, key, pressedDown )</code> |
| − | + | == Arguments == | |
* '''player''' - The pointer of the player | * '''player''' - The pointer of the player | ||
| − | * ''' | + | * '''key''' - [[Squirrel/Server/Constants#GTA_Keys|The ID of the key]] in question |
| − | * ''' | + | * '''pressedDown''' - A boolean representing whether the key was just pressed down or released |
=== Returns === | === Returns === | ||
| Line 18: | Line 19: | ||
== Example == | == Example == | ||
| − | + | The following example will annoy the player by noticing them every time they press the 'fire' key. | |
<code lang="squirrel"> | <code lang="squirrel"> | ||
| − | function onPlayerKeyStateChange ( pPlayer, | + | function onPlayerKeyStateChange ( pPlayer, key, down ) { |
| − | + | if ( ( key == KEY_ONFOOT_FIRE ) && ( down ) ) MessagePlayer ( "You just pressed <FIRE>.", pPlayer ); | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | return; | |
} | } | ||
</code> | </code> | ||
| Line 34: | Line 32: | ||
=== Notes === | === Notes === | ||
| − | The | + | The function [[Squirrel/Server/Functions/Messages/MessagePlayer|MessagePlayer]] was used in in this example. More info about it in the corresponding page. |
== Related Events == | == Related Events == | ||
{{Squirrel/Server/Events/Player}} | {{Squirrel/Server/Events/Player}} | ||
Latest revision as of 17:55, 10 November 2013
This is called when a player presses or stops pressing a certain key.
[edit] Syntax
[edit] Arguments
- player - The pointer of the player
- key - The ID of the key in question
- pressedDown - A boolean representing whether the key was just pressed down or released
[edit] Returns
This event does not handle return values.
[edit] Example
The following example will annoy the player by noticing them every time they press the 'fire' key.
[edit] Notes
The function MessagePlayer was used in in this example. More info about it in the corresponding page.
[edit] Related Events
- onPlayerAction
- onPlayerArmourChange
- onPlayerCashChange
- onPlayerChat
- onPlayerCommand
- onPlayerConnect
- onPlayerDeath
- onPlayerFall
- onPlayerHealthChange
- onPlayerIslandChange
- onPlayerJoin
- onPlayerKeyStateChange
- onPlayerKill
- onPlayerPart
- onPlayerScoreChange
- onPlayerSkinChange
- onPlayerSpawn
- onPlayerUpdate
- onPlayerTeamChange
- onPlayerUseDetonator
- onPlayerVirtualWorldChange
- onPlayerWeaponChange
