Scaleform Studio Lua API Reference: scaleform.Keys enumeration reference

scaleform.Keys enumeration reference
Enumeration values
expand all | collapse all

Description

The possible keyboard keys.

scaleform.Stage.find_focus()
scaleform.Stage.move_focus()

Enumeration values

A
The key code when A is pressed on a US English keyboard.
Alt
The key code when Alt is pressed on a US English keyboard.
B
The key code when B is pressed on a US English keyboard.
Backslash
The key code when Backslash is pressed on a US English keyboard.
Backspace
The key code when Backspace is pressed on a US English keyboard.
Bar
The key code when Bar is pressed on a US English keyboard.
BracketLeft
The key code when BracketLeft is pressed on a US English keyboard.
BracketRight
The key code when BracketRight is pressed on a US English keyboard.
C
The key code when C is pressed on a US English keyboard.
CapsLock
The key code when CapsLock is pressed on a US English keyboard.
Clear
The key code when Clear is pressed on a US English keyboard.
Comma
The key code when Comma is pressed on a US English keyboard.
Control
The key code when Control is pressed on a US English keyboard.
D
The key code when D is pressed on a US English keyboard.
Delete
The key code when Delete is pressed on a US English keyboard.
Down
The key code when Down is pressed on a US English keyboard.
E
The key code when E is pressed on a US English keyboard.
End
The key code when End is pressed on a US English keyboard.
Equal
The key code when Equal is pressed on a US English keyboard.
Escape
The key code when Escape is pressed on a US English keyboard.
F
The key code when F is pressed on a US English keyboard.
F1
The key code when F1 is pressed on a US English keyboard.
F10
The key code when F10 is pressed on a US English keyboard.
F11
The key code when F11 is pressed on a US English keyboard.
F12
The key code when F12 is pressed on a US English keyboard.
F13
The key code when F13 is pressed on a US English keyboard.
F14
The key code when F14 is pressed on a US English keyboard.
F15
The key code when F15 is pressed on a US English keyboard.
F2
The key code when F2 is pressed on a US English keyboard.
F3
The key code when F3 is pressed on a US English keyboard.
F4
The key code when F4 is pressed on a US English keyboard.
F5
The key code when F5 is pressed on a US English keyboard.
F6
The key code when F6 is pressed on a US English keyboard.
F7
The key code when F7 is pressed on a US English keyboard.
F8
The key code when F8 is pressed on a US English keyboard.
F9
The key code when F9 is pressed on a US English keyboard.
G
The key code when G is pressed on a US English keyboard.
H
The key code when H is pressed on a US English keyboard.
Help
The key code when Help is pressed on a US English keyboard.
Home
The key code when Home is pressed on a US English keyboard.
I
The key code when I is pressed on a US English keyboard.
ICO_00
The key code when ICO_00 is pressed on a US English keyboard.
ICO_HELP
The key code when ICO_HELP is pressed on a US English keyboard.
Insert
The key code when Insert is pressed on a US English keyboard.
J
The key code when J is pressed on a US English keyboard.
K
The key code when K is pressed on a US English keyboard.
KeyPad0
The key code when KeyPad0 is pressed on a US English keyboard.
KeyPad1
The key code when KeyPad1 is pressed on a US English keyboard.
KeyPad2
The key code when KeyPad2 is pressed on a US English keyboard.
KeyPad3
The key code when KeyPad3 is pressed on a US English keyboard.
KeyPad4
The key code when KeyPad4 is pressed on a US English keyboard.
KeyPad5
The key code when KeyPad5 is pressed on a US English keyboard.
KeyPad6
The key code when KeyPad6 is pressed on a US English keyboard.
KeyPad7
The key code when KeyPad7 is pressed on a US English keyboard.
KeyPad8
The key code when KeyPad8 is pressed on a US English keyboard.
KeyPad9
The key code when KeyPad9 is pressed on a US English keyboard.
KeyPadAdd
The key code when KeyPadAdd is pressed on a US English keyboard.
KeyPadDecimal
The key code when KeyPadDecimal is pressed on a US English keyboard.
KeyPadDivide
The key code when KeyPadDivide is pressed on a US English keyboard.
KeyPadEnter
The key code when KeyPadEnter is pressed on a US English keyboard.
KeyPadMultiply
The key code when KeyPadMultiply is pressed on a US English keyboard.
KeyPadSubtract
The key code when KeyPadSubtract is pressed on a US English keyboard.
L
The key code when L is pressed on a US English keyboard.
Left
The key code when Left is pressed on a US English keyboard.
LeftAlt
The key code when LeftAlt is pressed on a US English keyboard.
LeftControl
The key code when LeftControl is pressed on a US English keyboard.
LeftShift
The key code when LeftShift is pressed on a US English keyboard.
M
The key code when M is pressed on a US English keyboard.
Minus
The key code when Minus is pressed on a US English keyboard.
N
The key code when N is pressed on a US English keyboard.
None
An unknown key
Num0
The key code when Num0 is pressed on a US English keyboard.
Num1
The key code when Num1 is pressed on a US English keyboard.
Num2
The key code when Num2 is pressed on a US English keyboard.
Num3
The key code when Num3 is pressed on a US English keyboard.
Num4
The key code when Num4 is pressed on a US English keyboard.
Num5
The key code when Num5 is pressed on a US English keyboard.
Num6
The key code when Num6 is pressed on a US English keyboard.
Num7
The key code when Num7 is pressed on a US English keyboard.
Num8
The key code when Num8 is pressed on a US English keyboard.
Num9
The key code when Num9 is pressed on a US English keyboard.
NumLock
The key code when NumLock is pressed on a US English keyboard.
O
The key code when O is pressed on a US English keyboard.
OEM_102
The key code when OEM_102 is pressed on a US English keyboard.
OEM_AX
The key code when OEM_AX is pressed on a US English keyboard.
P
The key code when P is pressed on a US English keyboard.
PageDown
The key code when PageDown is pressed on a US English keyboard.
PageUp
The key code when PageUp is pressed on a US English keyboard.
Pause
The key code when Pause is pressed on a US English keyboard.
Period
The key code when Period is pressed on a US English keyboard.
PrintScreen
The key code when PrintScreen is pressed on a US English keyboard.
Q
The key code when Q is pressed on a US English keyboard.
Quote
The key code when Quote is pressed on a US English keyboard.
R
The key code when R is pressed on a US English keyboard.
Return
The key code when Return is pressed on a US English keyboard.
Right
The key code when Right is pressed on a US English keyboard.
RightAlt
The key code when RightAlt is pressed on a US English keyboard.
RightControl
The key code when RightControl is pressed on a US English keyboard.
RightShift
The key code when RightShift is pressed on a US English keyboard.
S
The key code when S is pressed on a US English keyboard.
ScrollLock
The key code when ScrollLock is pressed on a US English keyboard.
Semicolon
The key code when Semicolon is pressed on a US English keyboard.
Shift
The key code when Shift is pressed on a US English keyboard.
Slash
The key code when Slash is pressed on a US English keyboard.
Space
The key code when Space is pressed on a US English keyboard.
T
The key code when T is pressed on a US English keyboard.
Tab
The key code when Tab is pressed on a US English keyboard.
U
The key code when U is pressed on a US English keyboard.
Up
The key code when Up is pressed on a US English keyboard.
V
The key code when V is pressed on a US English keyboard.
W
The key code when W is pressed on a US English keyboard.
X
The key code when X is pressed on a US English keyboard.
Y
The key code when Y is pressed on a US English keyboard.
Z
The key code when Z is pressed on a US English keyboard.
 scaleform.Stage.find_focus (keyCodeStr, parentActor, loop, startFromActor, focusEnabledChars, controllerIdx) : scaleform.Actor?
Finds the next focus item.  scaleform.Stage.move_focus (keyCodeStr, startFromActor, focusEnabledChars, controllerIdx) : scaleform.Actor
Moves a focus rectangle by simulating key pressing of one of focus keys: TAB, Shift-TAB or arrow keys.  scaleform.Keys.A
The key code when A is pressed on a US English keyboard.  scaleform.Keys.Alt
The key code when Alt is pressed on a US English keyboard.  scaleform.Keys.B
The key code when B is pressed on a US English keyboard.  scaleform.Keys.Backslash
The key code when Backslash is pressed on a US English keyboard.  scaleform.Keys.Backspace
The key code when Backspace is pressed on a US English keyboard.  scaleform.Keys.Bar
The key code when Bar is pressed on a US English keyboard.  scaleform.Keys.BracketLeft
The key code when BracketLeft is pressed on a US English keyboard.  scaleform.Keys.BracketRight
The key code when BracketRight is pressed on a US English keyboard.  scaleform.Keys.C
The key code when C is pressed on a US English keyboard.  scaleform.Keys.CapsLock
The key code when CapsLock is pressed on a US English keyboard.  scaleform.Keys.Clear
The key code when Clear is pressed on a US English keyboard.  scaleform.Keys.Comma
The key code when Comma is pressed on a US English keyboard.  scaleform.Keys.Control
The key code when Control is pressed on a US English keyboard.  scaleform.Keys.D
The key code when D is pressed on a US English keyboard.  scaleform.Keys.Delete
The key code when Delete is pressed on a US English keyboard.  scaleform.Keys.Down
The key code when Down is pressed on a US English keyboard.  scaleform.Keys.E
The key code when E is pressed on a US English keyboard.  scaleform.Keys.End
The key code when End is pressed on a US English keyboard.  scaleform.Keys.Equal
The key code when Equal is pressed on a US English keyboard.  scaleform.Keys.Escape
The key code when Escape is pressed on a US English keyboard.  scaleform.Keys.F
The key code when F is pressed on a US English keyboard.  scaleform.Keys.F1
The key code when F1 is pressed on a US English keyboard.  scaleform.Keys.F10
The key code when F10 is pressed on a US English keyboard.  scaleform.Keys.F11
The key code when F11 is pressed on a US English keyboard.  scaleform.Keys.F12
The key code when F12 is pressed on a US English keyboard.  scaleform.Keys.F13
The key code when F13 is pressed on a US English keyboard.  scaleform.Keys.F14
The key code when F14 is pressed on a US English keyboard.  scaleform.Keys.F15
The key code when F15 is pressed on a US English keyboard.  scaleform.Keys.F2
The key code when F2 is pressed on a US English keyboard.  scaleform.Keys.F3
The key code when F3 is pressed on a US English keyboard.  scaleform.Keys.F4
The key code when F4 is pressed on a US English keyboard.  scaleform.Keys.F5
The key code when F5 is pressed on a US English keyboard.  scaleform.Keys.F6
The key code when F6 is pressed on a US English keyboard.  scaleform.Keys.F7
The key code when F7 is pressed on a US English keyboard.  scaleform.Keys.F8
The key code when F8 is pressed on a US English keyboard.  scaleform.Keys.F9
The key code when F9 is pressed on a US English keyboard.  scaleform.Keys.G
The key code when G is pressed on a US English keyboard.  scaleform.Keys.H
The key code when H is pressed on a US English keyboard.  scaleform.Keys.Help
The key code when Help is pressed on a US English keyboard.  scaleform.Keys.Home
The key code when Home is pressed on a US English keyboard.  scaleform.Keys.I
The key code when I is pressed on a US English keyboard.  scaleform.Keys.ICO_00
The key code when ICO_00 is pressed on a US English keyboard.  scaleform.Keys.ICO_HELP
The key code when ICO_HELP is pressed on a US English keyboard.  scaleform.Keys.Insert
The key code when Insert is pressed on a US English keyboard.  scaleform.Keys.J
The key code when J is pressed on a US English keyboard.  scaleform.Keys.K
The key code when K is pressed on a US English keyboard.  scaleform.Keys.KeyPad0
The key code when KeyPad0 is pressed on a US English keyboard.  scaleform.Keys.KeyPad1
The key code when KeyPad1 is pressed on a US English keyboard.  scaleform.Keys.KeyPad2
The key code when KeyPad2 is pressed on a US English keyboard.  scaleform.Keys.KeyPad3
The key code when KeyPad3 is pressed on a US English keyboard.  scaleform.Keys.KeyPad4
The key code when KeyPad4 is pressed on a US English keyboard.  scaleform.Keys.KeyPad5
The key code when KeyPad5 is pressed on a US English keyboard.  scaleform.Keys.KeyPad6
The key code when KeyPad6 is pressed on a US English keyboard.  scaleform.Keys.KeyPad7
The key code when KeyPad7 is pressed on a US English keyboard.  scaleform.Keys.KeyPad8
The key code when KeyPad8 is pressed on a US English keyboard.  scaleform.Keys.KeyPad9
The key code when KeyPad9 is pressed on a US English keyboard.  scaleform.Keys.KeyPadAdd
The key code when KeyPadAdd is pressed on a US English keyboard.  scaleform.Keys.KeyPadDecimal
The key code when KeyPadDecimal is pressed on a US English keyboard.  scaleform.Keys.KeyPadDivide
The key code when KeyPadDivide is pressed on a US English keyboard.  scaleform.Keys.KeyPadEnter
The key code when KeyPadEnter is pressed on a US English keyboard.  scaleform.Keys.KeyPadMultiply
The key code when KeyPadMultiply is pressed on a US English keyboard.  scaleform.Keys.KeyPadSubtract
The key code when KeyPadSubtract is pressed on a US English keyboard.  scaleform.Keys.L
The key code when L is pressed on a US English keyboard.  scaleform.Keys.Left
The key code when Left is pressed on a US English keyboard.  scaleform.Keys.LeftAlt
The key code when LeftAlt is pressed on a US English keyboard.  scaleform.Keys.LeftControl
The key code when LeftControl is pressed on a US English keyboard.  scaleform.Keys.LeftShift
The key code when LeftShift is pressed on a US English keyboard.  scaleform.Keys.M
The key code when M is pressed on a US English keyboard.  scaleform.Keys.Minus
The key code when Minus is pressed on a US English keyboard.  scaleform.Keys.N
The key code when N is pressed on a US English keyboard.  scaleform.Keys.None
An unknown key  scaleform.Keys.Num0
The key code when Num0 is pressed on a US English keyboard.  scaleform.Keys.Num1
The key code when Num1 is pressed on a US English keyboard.  scaleform.Keys.Num2
The key code when Num2 is pressed on a US English keyboard.  scaleform.Keys.Num3
The key code when Num3 is pressed on a US English keyboard.  scaleform.Keys.Num4
The key code when Num4 is pressed on a US English keyboard.  scaleform.Keys.Num5
The key code when Num5 is pressed on a US English keyboard.  scaleform.Keys.Num6
The key code when Num6 is pressed on a US English keyboard.  scaleform.Keys.Num7
The key code when Num7 is pressed on a US English keyboard.  scaleform.Keys.Num8
The key code when Num8 is pressed on a US English keyboard.  scaleform.Keys.Num9
The key code when Num9 is pressed on a US English keyboard.  scaleform.Keys.NumLock
The key code when NumLock is pressed on a US English keyboard.  scaleform.Keys.O
The key code when O is pressed on a US English keyboard.  scaleform.Keys.OEM_102
The key code when OEM_102 is pressed on a US English keyboard.  scaleform.Keys.OEM_AX
The key code when OEM_AX is pressed on a US English keyboard.  scaleform.Keys.P
The key code when P is pressed on a US English keyboard.  scaleform.Keys.PageDown
The key code when PageDown is pressed on a US English keyboard.  scaleform.Keys.PageUp
The key code when PageUp is pressed on a US English keyboard.  scaleform.Keys.Pause
The key code when Pause is pressed on a US English keyboard.  scaleform.Keys.Period
The key code when Period is pressed on a US English keyboard.  scaleform.Keys.PrintScreen
The key code when PrintScreen is pressed on a US English keyboard.  scaleform.Keys.Q
The key code when Q is pressed on a US English keyboard.  scaleform.Keys.Quote
The key code when Quote is pressed on a US English keyboard.  scaleform.Keys.R
The key code when R is pressed on a US English keyboard.  scaleform.Keys.Return
The key code when Return is pressed on a US English keyboard.  scaleform.Keys.Right
The key code when Right is pressed on a US English keyboard.  scaleform.Keys.RightAlt
The key code when RightAlt is pressed on a US English keyboard.  scaleform.Keys.RightControl
The key code when RightControl is pressed on a US English keyboard.  scaleform.Keys.RightShift
The key code when RightShift is pressed on a US English keyboard.  scaleform.Keys.S
The key code when S is pressed on a US English keyboard.  scaleform.Keys.ScrollLock
The key code when ScrollLock is pressed on a US English keyboard.  scaleform.Keys.Semicolon
The key code when Semicolon is pressed on a US English keyboard.  scaleform.Keys.Shift
The key code when Shift is pressed on a US English keyboard.  scaleform.Keys.Slash
The key code when Slash is pressed on a US English keyboard.  scaleform.Keys.Space
The key code when Space is pressed on a US English keyboard.  scaleform.Keys.T
The key code when T is pressed on a US English keyboard.  scaleform.Keys.Tab
The key code when Tab is pressed on a US English keyboard.  scaleform.Keys.U
The key code when U is pressed on a US English keyboard.  scaleform.Keys.Up
The key code when Up is pressed on a US English keyboard.  scaleform.Keys.V
The key code when V is pressed on a US English keyboard.  scaleform.Keys.W
The key code when W is pressed on a US English keyboard.  scaleform.Keys.X
The key code when X is pressed on a US English keyboard.  scaleform.Keys.Y
The key code when Y is pressed on a US English keyboard.  scaleform.Keys.Z
The key code when Z is pressed on a US English keyboard.  keyCodeStr : scaleform.Keys
A key to simulate.  parentActor : scaleform.Actor?
The actor container that is used as a modal focus. [more...]
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  loop : boolean?
Boolean flag to loop focus. [more...]
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  startFromActor : scaleform.Actor?
Use this actor as the starting point instead of currently focused one. [more...]
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  focusEnabledChars : boolean?
A flag that allows to move focus onto only focus-enabled, tab-enabled/tab-indexed actors. [more...]
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  controllerIdx : integer?
Index of the controller used for the operation. [more...]
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  scaleform.Actor?
Returns next actor to be focused or nil if the actor cannot be found.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  keyCodeStr : scaleform.Keys
A key to simulate.  startFromActor : scaleform.Actor?
Use this as the starting point instead of currently focused one. [more...]
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  focusEnabledChars : boolean?
A flag that allows to move focus onto only focus-enabled, tab-enabled/tab-indexed actors. [more...]
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  controllerIdx : integer?
Index of the controller used for the operation. [more...]
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  scaleform.Actor
Returns next actor to be focused or NULL if the actor cannot be found.  scaleform.Keys
The possible keyboard keys.  scaleform.Actor
Generic objects located in a scene. true or false.A strictly integral numeric value, with no decimal component.Indicates a table.
This documentation uses the term table to mean an anonymous, temporary Lua table that contains named data values. You typically use these tables to pass data or settings to a function, or to hold data returned by a function.Indicates an object.
This documentation uses the term object to mean a named Lua table or userdata value that maintains a state. Some object types may have multiple instances existing at the same time, each with its own state; these objects typically have creation functions or accessors that you must call in order to get an instance. Some object types have only one instance, which you always access through the object's name.Indicates a named variable within a namespace, object or table; or an element within an enumeration.Indicates a code sample.Indicates an enumeration.
This documentation uses the term enumeration to mean a named Lua table that contains only a set of constant values. These values typically identify a predefined set of options for some setting or behavior. You might pass an enumeration value to a function, or test the value returned by a function against the items in the enumeration to see which option is currently set.Indicates a named variable within a namespace or object that has a pre-set constant value.Indicates a category: a semantic grouping of related API elements.Indicates a namespace.
This documentation uses the term namespace to mean a named Lua table that exists in only one single instance, intended as a container for an interface of related objects, functions and data variables.Indicates an output value returned by a function.Indicates a named function within a namespace or object.Indicates an input parameter for a function.
Please send us your comment about this page