This site is inactive!

This site is no longer kept up to date. It has been superseded by the Roblox API Reference. Please update your bookmarks.

Tags: notCreatable

Members

Functions

Returns Function History
bool GamepadSupports ( UserInputType gamepadNum, KeyCode gamepadKeyCode ) (+0.185)
Array GetConnectedGamepads ( ) (+0.217)
Instance GetDeviceAcceleration ( ) (+0.168)
Instance GetDeviceGravity ( ) (+0.168)
Tuple GetDeviceRotation ( ) (+0.168)
Instance GetFocusedTextBox ( ) (+0.213)
bool GetGamepadConnected ( UserInputType gamepadNum ) (+0.185)
Array GetGamepadState ( UserInputType gamepadNum ) (+0.185)
Array GetKeysPressed ( ) (+0.189)
UserInputType GetLastInputType ( ) (+0.208)
Array GetMouseButtonsPressed ( ) (+0.297)
Vector2 GetMouseDelta ( ) (+0.297)
Vector2 GetMouseLocation ( ) (+0.297)
Array GetNavigationGamepads ( ) (+0.217)
Platform GetPlatform ( ) (+0.156)
Array GetSupportedGamepadKeyCodes ( UserInputType gamepadNum ) (+0.185)
CoordinateFrame GetUserCFrame ( UserCFrame type ) (+0.236)
bool IsGamepadButtonDown ( UserInputType gamepadNum, KeyCode gamepadKeyCode ) (+0.330)
bool IsKeyDown ( KeyCode keyCode ) (+0.189)
bool IsLuaTouchControls ( ) (+0.131, −0.230)
bool IsMouseButtonPressed ( UserInputType mouseButton ) (+0.297)
bool IsNavigationGamepad ( UserInputType gamepadEnum ) (+0.207)
bool IsStudioTouchEmulationEnabled ( ) (+0.171, −0.230)
void RecenterUserHeadCFrame ( ) (+0.234)
void RotateCamera ( Vector2 positionDelta ) (+0.131, −0.230)
void SendAppUISizes ( Vector2 statusBarSize, Vector2 navBarSize, Vector2 bottomBarSize ) (+0.315)
void SetNavigationGamepad ( UserInputType gamepadEnum, bool enabled ) (+0.207)
void ZoomCamera ( float zoomDelta ) (+0.131, −0.230)

YieldFunctions

  • 1 yieldfunction inherited from Instance

Events

Event History
DeviceAccelerationChanged ( Instance acceleration ) (+0.168)
DeviceGravityChanged ( Instance gravity ) (+0.168)
DeviceRotationChanged ( Instance rotation, CoordinateFrame cframe ) (+0.168)
GamepadConnected ( UserInputType gamepadNum ) (+0.185)
GamepadDisconnected ( UserInputType gamepadNum ) (+0.185)
InputBegan ( Instance input, bool gameProcessedEvent ) (+0.128)
InputChanged ( Instance input, bool gameProcessedEvent ) (+0.128)
InputEnded ( Instance input, bool gameProcessedEvent ) (+0.128)
JumpRequest ( ) (+0.113)
LastInputTypeChanged ( UserInputType lastInputType ) (+0.208)
ProcessedEvent ( Instance inputObject, bool processed ) (+0.143, −0.230)
StatusBarTapped ( Vector2 position ) (+0.322)
TextBoxFocusReleased ( Instance textboxReleased ) (+0.161)
TextBoxFocused ( Instance textboxFocused ) (+0.161)
TouchEnded ( Instance touch, bool gameProcessedEvent ) (+0.113)
TouchLongPress ( Array touchPositions, UserInputState state, bool gameProcessedEvent ) (+0.113)
TouchMoved ( Instance touch, bool gameProcessedEvent ) (+0.113)
TouchPan ( Array touchPositions, Vector2 totalTranslation, Vector2 velocity, UserInputState state, bool gameProcessedEvent ) (+0.130)
TouchPinch ( Array touchPositions, float scale, float velocity, UserInputState state, bool gameProcessedEvent ) (+0.113)
TouchRotate ( Array touchPositions, float rotation, float velocity, UserInputState state, bool gameProcessedEvent ) (+0.113)
TouchStarted ( Instance touch, bool gameProcessedEvent ) (+0.113)
TouchSwipe ( SwipeDirection swipeDirection, int numberOfTouches, bool gameProcessedEvent ) (+0.113)
TouchTap ( Array touchPositions, bool gameProcessedEvent ) (+0.113)
TouchTapInWorld ( Vector2 position, bool processedByUI ) (+0.297)
UserCFrameChanged ( UserCFrame type, CoordinateFrame value ) (+0.236)
WindowFocusReleased ( ) (+0.189)
WindowFocused ( ) (+0.189)

Property Descriptions

bool UserInputService.AccelerometerEnabled

Version History:(+0.168)

Tags: readonly

Vector2 UserInputService.BottomBarSize

Version History:(+0.314)

Tags: RobloxScriptSecurity, readonly

bool UserInputService.GamepadEnabled

Tags: readonly

bool UserInputService.GazeSelectionEnabled

Version History:(+0.262)

Tags: RobloxScriptSecurity, hidden

bool UserInputService.GyroscopeEnabled

Version History:(+0.168)

Tags: readonly

bool UserInputService.InCameraGesture

Version History:(+0.150, −0.220)

Tags: RobloxScriptSecurity

bool UserInputService.KeyboardEnabled

Tags: readonly

bool UserInputService.LegacyInputEventsEnabled

Version History:(+0.334)

Tags: RobloxScriptSecurity

bool UserInputService.ModalEnabled

Version History:(+0.118)

MouseBehavior UserInputService.MouseBehavior

Version History:(+0.158)

float UserInputService.MouseDeltaSensitivity

Version History:(+0.246)

bool UserInputService.MouseEnabled

Tags: readonly

bool UserInputService.MouseIconEnabled

Version History:(+0.158)

Vector2 UserInputService.NavBarSize

Version History:(+0.314)

Tags: RobloxScriptSecurity, readonly

double UserInputService.OnScreenKeyboardAnimationDuration

Version History:(+0.308)

Tags: RobloxScriptSecurity, readonly

Vector2 UserInputService.OnScreenKeyboardPosition

Version History:(+0.281)

Tags: readonly

Vector2 UserInputService.OnScreenKeyboardSize

Version History:(+0.281)

Tags: readonly

bool UserInputService.OnScreenKeyboardVisible

Version History:(+0.281)

Tags: readonly

OverrideMouseIconBehavior UserInputService.OverrideMouseIconBehavior

Version History:(+0.208)

Tags: RobloxScriptSecurity

bool UserInputService.OverrideMouseIconEnabled

Version History:(+0.168, −0.220)

Tags: RobloxScriptSecurity

Vector2 UserInputService.StatusBarSize

Version History:(+0.314)

Tags: RobloxScriptSecurity, readonly

bool UserInputService.TouchControlsEnabled

Version History:(+0.115, −0.118)

Tags: RobloxPlaceSecurity

bool UserInputService.TouchEnabled

Tags: readonly

bool UserInputService.VREnabled

Version History:(+0.230)

Tags: readonly

bool UserInputService.IsVREnabled

Version History:(+0.229, −0.240)

Deprecated: This member is deprecated.

Tags: readonly

CoordinateFrame UserInputService.UserHeadCFrame

Version History:(+0.229)

Deprecated: This member is deprecated.

Tags: readonly

Function Descriptions

boolUserInputService.GamepadSupports ( UserInputType gamepadNum, KeyCode gamepadKeyCode )

Version History:(+0.185)

ArrayUserInputService.GetConnectedGamepads ( )

Version History:(+0.217)

InstanceUserInputService.GetDeviceAcceleration ( )

Version History:(+0.168)

InstanceUserInputService.GetDeviceGravity ( )

Version History:(+0.168)

TupleUserInputService.GetDeviceRotation ( )

Version History:(+0.168)

InstanceUserInputService.GetFocusedTextBox ( )

Version History:(+0.213)

boolUserInputService.GetGamepadConnected ( UserInputType gamepadNum )

Version History:(+0.185)

ArrayUserInputService.GetGamepadState ( UserInputType gamepadNum )

Version History:(+0.185)

ArrayUserInputService.GetKeysPressed ( )

Version History:(+0.189)

UserInputTypeUserInputService.GetLastInputType ( )

Version History:(+0.208)

ArrayUserInputService.GetMouseButtonsPressed ( )

Version History:(+0.297)

Vector2UserInputService.GetMouseDelta ( )

Version History:(+0.297)

Vector2UserInputService.GetMouseLocation ( )

Version History:(+0.297)

ArrayUserInputService.GetNavigationGamepads ( )

Version History:(+0.217)

PlatformUserInputService.GetPlatform ( )

Version History:(+0.156)

Tags: RobloxScriptSecurity

ArrayUserInputService.GetSupportedGamepadKeyCodes ( UserInputType gamepadNum )

Version History:(+0.185)

CoordinateFrameUserInputService.GetUserCFrame ( UserCFrame type )

Version History:(+0.236)

boolUserInputService.IsGamepadButtonDown ( UserInputType gamepadNum, KeyCode gamepadKeyCode )

Version History:(+0.330)

boolUserInputService.IsKeyDown ( KeyCode keyCode )

Version History:(+0.189)

boolUserInputService.IsLuaTouchControls ( )

Version History:(+0.131, −0.230)

Tags: RobloxScriptSecurity

boolUserInputService.IsMouseButtonPressed ( UserInputType mouseButton )

Version History:(+0.297)

boolUserInputService.IsNavigationGamepad ( UserInputType gamepadEnum )

Version History:(+0.207)

boolUserInputService.IsStudioTouchEmulationEnabled ( )

Version History:(+0.171, −0.230)

Tags: RobloxScriptSecurity

voidUserInputService.RecenterUserHeadCFrame ( )

Version History:(+0.234)

voidUserInputService.RotateCamera ( Vector2 positionDelta )

Version History:(+0.131, −0.230)

Tags: RobloxScriptSecurity

voidUserInputService.SendAppUISizes ( Vector2 statusBarSize, Vector2 navBarSize, Vector2 bottomBarSize )

Version History:(+0.315)

Tags: RobloxScriptSecurity

voidUserInputService.SetNavigationGamepad ( UserInputType gamepadEnum, bool enabled )

Version History:(+0.207)

voidUserInputService.ZoomCamera ( float zoomDelta )

Version History:(+0.131, −0.230)

Tags: RobloxScriptSecurity

Event Descriptions

UserInputService.DeviceAccelerationChanged ( Instance acceleration )

Version History:(+0.168)

UserInputService.DeviceGravityChanged ( Instance gravity )

Version History:(+0.168)

UserInputService.DeviceRotationChanged ( Instance rotation, CoordinateFrame cframe )

Version History:(+0.168)

UserInputService.GamepadConnected ( UserInputType gamepadNum )

Version History:(+0.185)

UserInputService.GamepadDisconnected ( UserInputType gamepadNum )

Version History:(+0.185)

UserInputService.InputBegan ( Instance input, bool gameProcessedEvent )

Version History:(+0.128)

UserInputService.InputChanged ( Instance input, bool gameProcessedEvent )

Version History:(+0.128)

UserInputService.InputEnded ( Instance input, bool gameProcessedEvent )

Version History:(+0.128)

UserInputService.JumpRequest ( )

Version History:(+0.113)

UserInputService.LastInputTypeChanged ( UserInputType lastInputType )

Version History:(+0.208)

UserInputService.ProcessedEvent ( Instance inputObject, bool processed )

Version History:(+0.143, −0.230)

Tags: RobloxScriptSecurity

UserInputService.StatusBarTapped ( Vector2 position )

Version History:(+0.322)

Tags: RobloxScriptSecurity

UserInputService.TextBoxFocusReleased ( Instance textboxReleased )

Version History:(+0.161)

UserInputService.TextBoxFocused ( Instance textboxFocused )

Version History:(+0.161)

UserInputService.TouchEnded ( Instance touch, bool gameProcessedEvent )

Version History:(+0.113)

UserInputService.TouchLongPress ( Array touchPositions, UserInputState state, bool gameProcessedEvent )

Version History:(+0.113)

UserInputService.TouchMoved ( Instance touch, bool gameProcessedEvent )

Version History:(+0.113)

UserInputService.TouchPan ( Array touchPositions, Vector2 totalTranslation, Vector2 velocity, UserInputState state, bool gameProcessedEvent )

Version History:(+0.130)

UserInputService.TouchPinch ( Array touchPositions, float scale, float velocity, UserInputState state, bool gameProcessedEvent )

Version History:(+0.113)

UserInputService.TouchRotate ( Array touchPositions, float rotation, float velocity, UserInputState state, bool gameProcessedEvent )

Version History:(+0.113)

UserInputService.TouchStarted ( Instance touch, bool gameProcessedEvent )

Version History:(+0.113)

UserInputService.TouchSwipe ( SwipeDirection swipeDirection, int numberOfTouches, bool gameProcessedEvent )

Version History:(+0.113)

UserInputService.TouchTap ( Array touchPositions, bool gameProcessedEvent )

Version History:(+0.113)

UserInputService.TouchTapInWorld ( Vector2 position, bool processedByUI )

Version History:(+0.297)

UserInputService.UserCFrameChanged ( UserCFrame type, CoordinateFrame value )

Version History:(+0.236)

UserInputService.WindowFocusReleased ( )

Version History:(+0.189)

UserInputService.WindowFocused ( )

Version History:(+0.189)

Inherits: