Reference API Roblox

Engine API

Website

Related

Reference API Roblox

VirtualInputManager

Summary

This class is a service. It is a singleton that may be acquired with GetService.
Tags: [Service]

Member index 26

HistoryMember
573Dump(): null
573HandleGamepadAxisInput(objectId: int, keyCode: KeyCode, x: float, y: float, z: float): null
573HandleGamepadButtonInput(deviceId: int, keyCode: KeyCode, buttonState: int): null
573HandleGamepadConnect(deviceId: int): null
573HandleGamepadDisconnect(deviceId: int): null
573SendAccelerometerEvent(x: float, y: float, z: float): null
573SendGravityEvent(x: float, y: float, z: float): null
573SendGyroscopeEvent(quatX: float, quatY: float, quatZ: float, quatW: float): null
573SendKeyEvent(isPressed: bool, keyCode: KeyCode, isRepeatedKey: bool, layerCollector: Instance): null
573SendMouseButtonEvent(x: int, y: int, mouseButton: int, isDown: bool, layerCollector: Instance, repeatCount: int): null
573SendMouseMoveEvent(x: float, y: float, layerCollector: Instance): null
573SendMouseWheelEvent(x: float, y: float, isForwardScroll: bool, layerCollector: Instance): null
573SendTextInputCharacterEvent(str: string, layerCollector: Instance): null
573SendTouchEvent(touchId: int64, state: int, x: float, y: float): null
573SetInputTypesToIgnore(inputTypesToIgnore: Variant): null
573StartPlaying(fileName: string): null
573StartPlayingJSON(string: string): null
573StartRecording(): null
573StopPlaying(): null
573StopRecording(): null
573WaitForInputEventsProcessed(): null
573sendRobloxEvent(namespace: string, detail: string, detailType: string): null
573sendThemeChangeEvent(themeName: string): null
462PlaybackCompleted(additionalLuaState: string)
462RecordingCompleted(result: string)
inherited from Instance
553Archivable: bool
619Capabilities: SecurityCapabilities
553ClassName: string
553Name: string
553Parent: Instance
619Sandboxed: bool
616UniqueId: UniqueId
553className: string
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
486GetAttributes(): Dictionary
486GetChildren(): Objects
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
462GetPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsA(className: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
553children(): Objects
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
553getChildren(): Objects
462isA(className: string): bool
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462Changed(property: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)

Removed member index 1

HistoryMember
491SetViewportSize(sizePx: Vector2): void

History 88

Members 26

Dump

Parameters (0)
No parameters.
Returns (1)
null

History 3

HandleGamepadAxisInput

Parameters (5)
objectIdint
keyCodeKeyCode
xfloat
yfloat
zfloat
Returns (1)
null

History 3

HandleGamepadButtonInput

Parameters (3)
deviceIdint
keyCodeKeyCode
buttonStateint
Returns (1)
null

History 3

HandleGamepadConnect

Parameters (1)
deviceIdint
Returns (1)
null

History 3

HandleGamepadDisconnect

Parameters (1)
deviceIdint
Returns (1)
null

History 3

PlaybackCompleted

Parameters (1)
additionalLuaStatestring

History 2

RecordingCompleted

Parameters (1)
resultstring

History 2

SendAccelerometerEvent

Parameters (3)
xfloat
yfloat
zfloat
Returns (1)
null

History 3

SendGravityEvent

Parameters (3)
xfloat
yfloat
zfloat
Returns (1)
null

History 3

SendGyroscopeEvent

Parameters (4)
quatXfloat
quatYfloat
quatZfloat
quatWfloat
Returns (1)
null

History 3

SendKeyEvent

Parameters (4)
isPressedbool
keyCodeKeyCode
isRepeatedKeybool
layerCollectorInstance
Returns (1)
null

History 5

SendMouseButtonEvent

Parameters (6)
xint
yint
mouseButtonint
isDownbool
layerCollectorInstance
repeatCountint
Returns (1)
null

History 6

SendMouseMoveEvent

Parameters (3)
xfloat
yfloat
layerCollectorInstance
Returns (1)
null

History 5

SendMouseWheelEvent

Parameters (4)
xfloat
yfloat
isForwardScrollbool
layerCollectorInstance
Returns (1)
null

History 5

SendTextInputCharacterEvent

Parameters (2)
strstring
layerCollectorInstance
Returns (1)
null

History 5

SendTouchEvent

Parameters (4)
touchIdint64
stateint
xfloat
yfloat
Returns (1)
null

History 3

SetInputTypesToIgnore

Parameters (1)
inputTypesToIgnoreVariant
Returns (1)
null

History 2

StartPlaying

Parameters (1)
fileNamestring
Returns (1)
null

History 3

StartPlayingJSON

Parameters (1)
stringstring
Returns (1)
null

History 2

StartRecording

Parameters (0)
No parameters.
Returns (1)
null

History 3

StopPlaying

Parameters (0)
No parameters.
Returns (1)
null

History 2

StopRecording

Parameters (0)
No parameters.
Returns (1)
null

History 3

WaitForInputEventsProcessed

Parameters (0)
No parameters.
Returns (1)
null
This function yields. It will block the calling thread until completion.

History 2

Tags: [Yields]

sendRobloxEvent

Parameters (3)
namespacestring
detailstring
detailTypestring
Returns (1)
null

History 3

sendThemeChangeEvent

Parameters (1)
themeNamestring
Returns (1)
null

History 3

Removed members 1

SetViewportSize

Parameters (1)
sizePxVector2
Returns (1)
void

History 2

Settings