OnKeyPress: Difference between revisions

From Onset Developer Wiki
Created page with "{{Info|Event|Client|1.0}} {{FuncDescription|Called when the player presses a key. You can use IsCtrlPressed and IsShiftPressed to check if it is a key combination.}}..."
 
Chloe (talk | contribs)
mNo edit summary
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
{{Info|Event|Client|1.0}}
{{Info|Event|Client|1.0}}


{{FuncDescription|Called when the player presses a key. You can use [[IsCtrlPressed]] and [[IsShiftPressed]] to check if it is a key combination.}}
{{FuncDescription|Called when the player presses a key. You can use [[IsCtrlPressed]] and [[IsShiftPressed]] to check if it is a key combination.<br>Use [[OnKeyRelease]] to detect when they release the key.}}


{{FuncSyntax|OnKeyPress(key)}}
{{FuncSyntax|OnKeyPress(key)}}
Line 21: Line 21:


{{RelatedFunctions}}
{{RelatedFunctions}}
{{ClientEvents}}
{{KeyClientEvents}}

Latest revision as of 08:48, 16 January 2020

OnKeyPress

Type: Event
Context: Client
Introduced: v1.0

Description

Called when the player presses a key. You can use IsCtrlPressed and IsShiftPressed to check if it is a key combination.
Use OnKeyRelease to detect when they release the key.

Syntax

OnKeyPress(key)

Parameters

  • key
    The name of the key as a string.

Example

function OnKeyPress(key)
	AddPlayerChat(key)
	if key == "Tab" then
		AddPlayerChat("You have pressed TAB!")
	end
end
AddEvent("OnKeyPress", OnKeyPress)

See also