API ‐ Enums

Enumerations

CollisionType

• The different modes for RigidBody.CollisionType

Name	Description	Value
Cube	A cube collision model	0
Sphere	A sphere collision model	1
Hulls	Load a set of convex hulls from RigidBody.HullsFile	2
MeshComponent	Use the mesh of the Mesh component attached to the same object as the RigidBody. Usually a bad idea unless the mesh is convex	3

Cursor

• The specific icon of the mouse cursor

Name	Description	Value
Arrow	The default system Arrow cursor	221185
TextInput	A text-entry I-beam	221186
Crosshair	A crosshair	221187
PointingHand	As the name describes	221188
ResizeHorizontal	2 horizontal arrows	221189
ResizeVertical	2 vertical arrows	221190
ResizeNWSE	2 diagonal arrows, going from the North-West to the South-East corner of the icon	221191
ResizeNESW	2 diagonal arrows, going from the North-East to the South-West corner of the icon	221192
ResizeAll	4 arrows in all directions	221193
NotAllowed	A 'No Entry' icon	221194

CursorMode

• The behaviour of the mouse cursor

Name	Description	Value
Normal	Normal behavior	212993
Hidden	Invisible	212994
Disabled	Invisible, locked to the bounds of the window	212995
Captured	Visible, locked to the bounds of the window	212996

FaceCulling

• Culling modes for Mesh.FaceCulling

Name	Description	Value
None	Faces are not culled	0
Back	Cull 'back' faces based on vertex winding order	1
Front	Cull 'front' faces based on vertex winding order	2

FileSystemEvent

• Events that may invoke the fs.watch callback

Name	Description	Value
Added	When a file or folder is added	0
Removed	When a file or folder is removed	1
Modified	When a file is modified	2
Renamed_Old	When a file or folder is renamed, passing its old path to callback	3
Renamed_New	When a file or folder is renamed, passing its new path to callback	4

ImGuiColor

• Dear ImGui color tokens, which can be passed to imgui.pushstylecolor or imgui.setstylecolor

Name	Description	Value
Text		0
TextDisabled		1
WindowBg	Background of normal windows	2
ChildBg	Background of child windows	3
PopupBg	Background of popups, menus, tooltips windows	4
Border		5
BorderShadow		6
FrameBg	Background of checkbox, radio button, plot, slider, text input	7
FrameBgHovered		8
FrameBgActive		9
TitleBg	Title bar	10
TitleBgActive	Title bar when focused	11
TitleBgCollapsed	Title bar when collapsed	12
MenuBarBg		13
ScrollbarBg		14
ScrollbarGrab		15
ScrollbarGrabHovered		16
ScrollbarGrabActive		17
CheckMark	Checkbox tick and radiobutton circle	18
CheckboxSelectedBg	Checkbox background when Selected, otherwise use FrameBg	19
SliderGrab		20
SliderGrabActive		21
Button		22
ButtonHovered		23
ButtonActive		24
Header	// Header* colors are used for collapsingheader, treenode, menuitem	25
HeaderHovered		26
HeaderActive		27
Separator		28
SeparatorHovered		29
SeparatorActive		30
ResizeGrip	Resize grip in lower-right and lower-left corners of windows	31
ResizeGripHovered		32
ResizeGripActive		33
InputTextCursor	inputstring cursor/caret	34
TabHovered	Tab background, when hovered	35
Tab	Tab background, when tab-bar is focused & tab is unselected	36
TabSelected	Tab background, when tab-bar is focused & tab is selected	37
TabSelectedOverline	Tab horizontal overline, when tab-bar is focused & tab is selected	38
TabDimmed	Tab background, when tab-bar is unfocused & tab is unselected	39
TabDimmedSelected	Tab background, when tab-bar is unfocused & tab is selected	40
TabDimmedSelectedOverline	Horizontal overline, when tab-bar is unfocused & tab is selected	41
DockingPreview	Preview overlay color when about to docking something	42
DockingEmptyBg	Background color for empty node (e.g. CentralNode with no window docked into it)	43
PlotLines		44
PlotLinesHovered		45
PlotHistogram		46
PlotHistogramHovered		47
TableHeaderBg	Table header background	48
TableBorderStrong	Table outer and header borders (prefer using Alpha=1.0 here)	49
TableBorderLight	Table inner borders (prefer using Alpha=1.0 here)	50
TableRowBg	Table row background (even rows)	51
TableRowBgAlt	Table row background (odd rows)	52
TextLink	Hyperlink color	53
TextSelectedBg	Selected text inside an inputstring	54
TreeLines	Tree node hierarchy outlines when using dl/dlf	55
DragDropTarget	Rectangle border highlighting a drop target	56
DragDropTargetBg	Rectangle background highlighting a drop target	57
UnsavedMarker	Unsaved Document marker (in window title and tabs)	58
NavCursor	Color of keyboard/gamepad navigation cursor/rectangle, when visible	59
NavWindowingHighlight	ighlight window when using Ctrl+Tab	60
NavWindowingDimBg	Darken/colorize entire screen behind the Ctrl+Tab window list, when active	61
ModalWindowDimBg	Darken/colorize entire screen behind a modal window, when one is active	62

InputAction

• The action that caused an Input Event (such as PlayerInput.KeyEvent) to fire

Name	Description	Value
Released	The key or mouse button was released	0
Pressed	The key or mouse button was pressed	1
Repeated	The key was held down until it repeated	2

Key

• Keys, which may be passed to PlayerInput:IsKeyPressed

Name	Description	Value
Space	The Space key	32
Apostrophe	The Apostrophe key	39
Comma	The Comma key	44
Minus	The Minus key	45
Period	The Period key	46
Slash	The Slash key	47
Zero	The Zero key	48
One	The One key	49
Two	The Two key	50
Three	The Three key	51
Four	The Four key	52
Five	The Five key	53
Six	The Six key	54
Seven	The Seven key	55
Eight	The Eight key	56
Nine	The Nine key	57
Semicolon	The Semicolon key	59
Equal	The Equal sign key	61
A	The A key	65
B	The B key	66
C	The C key	67
D	The D key	68
E	The E key	69
F	The F key	70
G	The G key	71
H	The H key	72
I	The I key	73
J	The J key	74
K	The K key	75
L	The L key	76
M	The M key	77
N	The N key	78
O	The O key	79
P	The P key	80
Q	The Q key	81
R	The R key	82
S	The S key	83
T	The T key	84
U	The U key	85
V	The V key	86
W	The W key	87
X	The X key	88
Y	The Y key	89
Z	The Z key	90
LeftBracket	The Left Bracket key	91
Backslash	The Backslash key	92
RightBracket	The Right Bracket key	93
GraveAccent	The Grave Accent key	96
World1	The World1 key	161
World2	The World2 key	162
Escape	The Escape key	256
Enter	The Enter key	257
Tab	The Tab key	258
Backspace	The Backspace key	259
Insert	The Insert key	260
Delete	The Delete key	261
Right	The Right arrow key	262
Left	The Left arrow key	263
Down	The Down arrow key	264
Up	The Up arrow key	265
PageUp	The Page Up key	266
PageDown	The Page Down key	267
Home	The Home key	268
End	The End key	269
CapsLock	The Caps Lock key	280
ScrollLock	The Scroll Lock key	281
NumLock	The Number Lock key	282
PrintScreen	The Print Screen key	283
Pause	The Pause key	284
F1	The F1 key	290
F2	The F2 key	291
F3	The F3 key	292
F4	The F4 key	293
F5	The F5 key	294
F6	The F6 key	295
F7	The F7 key	296
F8	The F8 key	297
F9	The F9 key	298
F10	The F10 key	299
F11	The F11 key	300
F12	The F12 key	301
F13	The F13 key	302
F14	The F14 key	303
F15	The F15 key	304
F16	The F16 key	305
F17	The F17 key	306
F18	The F18 key	307
F19	The F19 key	308
F20	The F20 key	309
F21	The F21 key	310
F22	The F22 key	311
F23	The F23 key	312
F24	The F24 key	313
F25	The F25 key	314
Numpad0	The Numpad 0 key	320
Numpad1	The Numpad 1 key	321
Numpad2	The Numpad 2 key	322
Numpad3	The Numpad 3 key	323
Numpad4	The Numpad 4 key	324
Numpad5	The Numpad 5 key	325
Numpad6	The Numpad 6 key	326
Numpad7	The Numpad 7 key	327
Numpad8	The Numpad 8 key	328
Numpad9	The Numpad 9 key	329
NumpadDecimal	The Numpad Decimal key	330
NumpadDivide	The Numpad Divide key	331
NumpadMultiply	The Numpad Multiply key	332
NumpadSubtract	The Numpad Subtract key	333
NumpadAdd	The Numpad Add key	334
NumpadEnter	The Numpad Enter key	335
NumpadEqual	The Numpad Equal key	336
LeftShift	The Left Shift key	340
LeftControl	The Left Control key	341
LeftAlt	The Left Alt key	342
LeftSuper	The Left Super key	343
RightShift	The Right Shift key	344
RightControl	The Right Control key	345
RightAlt	The Right Alt key	346
RightSuper	The Right Super key	347

LogType

• The different types of log messages

Name	Description	Value
None	No specified type	0
Info	This is an information log message, like from print	1
Warning	This is a warning, like from warn	2
Error	This is an error, like from error	3

MouseButton

• Mouse buttons, which may be passed to PlayerInput:IsMouseButtonPressed

Name	Description	Value
Left	The left mouse button	0
Right	The right mouse button	1
Middle	The middle mouse button (scroll wheel)	2

ValueType

• The types of value variants the Engine internally recognizes

Name	Description	Value
Boolean	Equivalent to boolean. true or false	1
Integer	A whole number. Will be represented as number to Scripts	2
Double	The number type	3
String	string	4
Buffer	Luau buffers	5
Color	The Color datatype	6
Vector2	A vector with 0 as the Z-component	7
Vector3	vector	8
Matrix	The Matrix datatype	9
GameObject	The GameObject datatype	10
Function	A function, equivalent to (...unknown) -> (...unknown)	11
Array	Equivalent to { unknown }. An Array of anything	12
Map	Equivalent to { [unknown]: unknown }	13
EventSignal	The EventSignal datatype	14
InputEvent	A union of KeyInputEvent, MouseInputEvent and ScrollInputEvent	15
NumberGradient	Number gradient (not implemented)	16
VectorGradient	Vector3 gradient (not implemented)	17
ColorGradient	Color gradient (not implemented)	18
Null	nil	64
Any	Equivalent to unknown. Can be any type	128