GM/KeyPress

From Garry's Mod
Jump to: navigation, search
 GM:KeyPress( )

Contents

Description

Called whenever a player pressed a key included within the IN keys.

For a more general purpose function that handles all kinds of input, see GM:PlayerButtonDown

WARNING Due to this being a predicted hook, ParticleEffects created only serverside from this hook will not be networked to the client, so make sure to do that on both realms
NOTE This hook is predicted. This means that in singleplayer, it will not be called in the Client realm.

Arguments

Player ply

The player pressing the key. If running client-side, this will always be LocalPlayer

Arguments

number key

The key that the player pressed using IN_ Enums.

Examples

Example

"hi" will be printed to the console when the player presses the IN_USE (E) key.

hook.Add( "KeyPress", "keypress_use_hi", function( ply, key )
	if ( key == IN_USE ) then
		print( "hi" )
	end
end )

Output:

hi

Examples

Example

When a player tries to jump, they will be shot straight up in the air.

hook.Add( "KeyPress", "keypress_jump_super", function( ply, key )
    if ( key == IN_JUMP ) then
        ply:SetVelocity( ply:GetVelocity() + Vector( 0, 0, 1000 ) )
    end
end )


Personal tools
Navigation