Squirrel/Server/Events/Player/onPlayerKeyStateChange

Revision as of 17:09, 10 November 2013

This is called when a player presses or stops pressing a certain key.

Syntax

function onPlayerKeyStateChange ( player, key, pressedDown )

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

Returns

This event does not handle return values.

Example

The following example will annoy the player by noticing them every time they press the 'fire' key.

 
function onPlayerKeyStateChange ( pPlayer, key, down ) {
 
     if ( ( key == KEY_ONFOOT_FIRE ) && ( down ) ) MessagePlayer ( "You just pressed <FIRE>.", pPlayer );
 
     return;
}
 

Notes

The function MessagePlayer was used in in this example. More info about it in the corresponding page.

Related Events

• onPlayerAction
• onPlayerArmourChange
• onPlayerCashChange
• onPlayerChat
• onPlayerCommand
• onPlayerConnect
• onPlayerDeath
• onPlayerFall
• onPlayerHealthChange
• onPlayerIslandChange
• onPlayerJoin
• onPlayerKeyStateChange
• onPlayerKill
• onPlayerPart
• onPlayerScoreChange
• onPlayerSkinChange
• onPlayerSpawn
• onPlayerUpdate
• onPlayerTeamChange
• onPlayerUseDetonator
• onPlayerVirtualWorldChange
• onPlayerWeaponChange