Key (event) - Revision history

Bomb Bloke: An assuredly futile attempt to get people to use the keys API!

2015-06-30T12:19:26Z

An assuredly futile attempt to get people to use the keys API!

MKlegoman357 at 11:32, 28 June 2015

2015-06-28T11:32:19Z

MKlegoman357: Updated to ComputerCraft 1.74

2015-06-28T11:07:27Z

Updated to ComputerCraft 1.74

TheOriginalBIT: better coding habits

2013-10-28T09:31:15Z

better coding habits

Hawk777: Add note about scan codes; note escape is not seen; remove needswork banner as an example has, in fact, been added earlier

2013-05-05T23:18:47Z

Add note about scan codes; note escape is not seen; remove needswork banner as an example has, in fact, been added earlier

Keeree: Codefix.

2013-01-08T01:05:27Z

Codefix.

Keeree: Added example code, and copied key scan codes from Raw_key_events

2013-01-08T00:42:34Z

Added example code, and copied key scan codes from Raw_key_events

AfterLifeLochie: Created event page

2012-11-30T12:10:08Z

Created event page

New page

{{NeedsWork|A demonstration on the use and handling of this event would be beneficial. ''[[User:AfterLifeLochie|AfterLifeLochie]] 16:10, 30 November 2012 (MSK)''}}

{{Event
|name=key
|desc=Fired when any key is pressed while the terminal is focused.
|return1=The numerical key value of the key pressed.
}}

@@ Line 2: / Line 2: @@
 {{Event
 |name=key
-|desc=Fired when any key except Escape is pressed while the terminal is focused.
+|desc=Fired when any key (except Escape) is pressed while the terminal is focused. You can compare the values it gives you to the constants in the [[Keys (API)|keys API]] (eg, keys.up, keys.down, etc).<br><br>
 |return1=The numerical key value of the key pressed
 |return2=A boolean indicating whether the key event was generated while holding the key (<var>true</var>), rather than pressing it the first time (<var>false</var>).
@@ Line 16: / Line 18: @@
   end
 |output=Any key that is pressed.
 }}

← Older revision		Revision as of 11:32, 28 June 2015
Line 1:		Line 1:
		+	{{Lowercase}}
	{{Event		{{Event
	\|name=key		\|name=key

@@ Line 3: / Line 3: @@
 |desc=Fired when any key except Escape is pressed while the terminal is focused.
 |return1=The numerical key value of the key pressed
 }}
 {{Example
-|desc=Print each key pressed on the keyboard whenever a ''key'' event is fired. Use Ctrl+T (Windows)<!--- or ???+T (Mac)---> to terminate the loop.
+|desc=Print each key pressed on the keyboard whenever a ''"key"'' event is fired. Use Ctrl+T (Windows)<!--- or ???+T (Mac)---> to terminate the loop.
 |code=
   while true do
-    local event, scancode = os.pullEvent("key")
+    local event, key, isHeld = '''[[os.pullEvent]]("key")'''
-    print(tostring(scancode).." was pressed.")
   end
 |output=Any key that is pressed.
@@ Line 15: / Line 18: @@
 ==Key scan codes ==
 These scan codes are also available as constants in the [[Keys (API)|keys API]], and can be translated from numerical codes to strings using [[keys.getName]].

@@ Line 8: / Line 8: @@
 |code=
   while true do
-    event, scancode = os.pullEvent("key")
+    local event, scancode = os.pullEvent("key")
     print(tostring(scancode).." was pressed.")
   end

@@ Line 1: / Line 1: @@
 {{Event
 |name=key
-|desc=Fired when any key is pressed while the terminal is focused.
+|desc=Fired when any key except Escape is pressed while the terminal is focused.
-|return1=The numerical key value of the key pressed.
+|return1=The numerical key value of the key pressed
 }}
 {{Example
@@ Line 15: / Line 13: @@
 |output=Any key that is pressed.
 }}
 ==Key scan codes ==
 [[File:CC-Keyboard-Charcodes.png|center|frame|250x250px|Click for a larger copy of this image - contains keys and their event numbers.]]

← Older revision		Revision as of 00:42, 8 January 2013
Line 6:		Line 6:
	\|return1=The numerical key value of the key pressed.		\|return1=The numerical key value of the key pressed.
	}}		}}
		+	{{Example
		+	\|desc=Print each key pressed on the keyboard whenever a ''key'' event is fired. Use Ctrl+T (Windows)<!--- or ???+T (Mac)---> to terminate the loop.
		+	\|code=
		+	while true do
		+	event, scancode = os.pullEvent()
		+	print(tostring(scancode).." was pressed.")
		+	end
		+	\|output=Any key that is pressed.
		+	}}
		+	==Key scan codes ==
		+	[[File:CC-Keyboard-Charcodes.png\|center\|frame\|250x250px\|Click for a larger copy of this image - contains keys and their event numbers.]]