VirtualInputManager
CreatorHub

An internal service that offers no functionality to developers.

It is a singleton that may be acquired with GetService.

Memory category	Instances

Tags: [Service]

Member index 28

History		Member
486		AdditionalLuaState: string
573		Dump(): null
573		HandleGamepadAxisInput(objectId: int, keyCode: KeyCode, x: float, y: float, z: float): null
573		HandleGamepadButtonInput(deviceId: int, keyCode: KeyCode, buttonState: int): null
573		HandleGamepadConnect(deviceId: int): null
573		HandleGamepadDisconnect(deviceId: int): null
573		SendAccelerometerEvent(x: float, y: float, z: float): null
573		SendGravityEvent(x: float, y: float, z: float): null
573		SendGyroscopeEvent(quatX: float, quatY: float, quatZ: float, quatW: float): null
573		SendKeyEvent(isPressed: bool, keyCode: KeyCode, isRepeatedKey: bool, layerCollector: Instance): null
573		SendMouseButtonEvent(x: int, y: int, mouseButton: int, isDown: bool, layerCollector: Instance, repeatCount: int): null
663		SendMouseMoveDeltaEvent(deltaX: float, deltaY: float, layerCollector: Instance): null
573		SendMouseMoveEvent(x: float, y: float, layerCollector: Instance): null
573		SendMouseWheelEvent(x: float, y: float, isForwardScroll: bool, layerCollector: Instance): null
662		SendScroll(x: float, y: float, deltaX: float, deltaY: float, options: Dictionary, layerCollector: Instance): null
573		SendTextInputCharacterEvent(str: string, layerCollector: Instance): null
573		SendTouchEvent(touchId: int64, state: int, x: float, y: float): null
573		SetInputTypesToIgnore(inputTypesToIgnore: Variant): null
573		StartPlaying(fileName: string): null
573		StartPlayingJSON(string: string): null
573		StartRecording(): null
573		StopPlaying(): null
573		StopRecording(): null
573		WaitForInputEventsProcessed(): null
573		sendRobloxEvent(namespace: string, detail: string, detailType: string): null
573		sendThemeChangeEvent(themeName: string): null
462		PlaybackCompleted(additionalLuaState: string)
462		RecordingCompleted(result: string)
65 members inherited from Instance
553		Archivable: bool
553		Attributes: string
553		AttributesReplicate: string
553		AttributesSerialize: BinaryString
670		Capabilities: SecurityCapabilities
553		DataCost: int
619		DefinesCapabilities: bool
553		HistoryId: UniqueId
553		Name: string
553		Parent: Instance
553		PropertyStatusStudio: PropertyStatus
553		RobloxLocked: bool
670		Sandboxed: bool
616		SourceAssetId: int64
553		Tags: BinaryString
680		UniqueId: UniqueId
553		archivable: bool
553		numExpectedDirectChildren: int
576		AddTag(tag: string): null
573		ClearAllChildren(): null
462		Clone(): Instance
573		Destroy(): null
486		FindFirstAncestor(name: string): Instance
486		FindFirstAncestorOfClass(className: string): Instance
486		FindFirstAncestorWhichIsA(className: string): Instance
486		FindFirstChild(name: string, recursive: bool = false): Instance
486		FindFirstChildOfClass(className: string): Instance
486		FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486		FindFirstDescendant(name: string): Instance
563		GetActor(): Actor
486		GetAttribute(attribute: string): Variant
462		GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631		GetAttributes(): Dictionary
648		GetChildren(): Instances
462		GetDebugId(scopeLength: int = 4): string
486		GetDescendants(): Array
486		GetFullName(): string
641		GetStyled(name: string): Variant
657		GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576		GetTags(): Array
576		HasTag(tag: string): bool
486		IsAncestorOf(descendant: Instance): bool
486		IsDescendantOf(ancestor: Instance): bool
664		IsPropertyModified(property: string): bool
573		Remove(): null
576		RemoveTag(tag: string): null
664		ResetPropertyToDefault(property: string): null
573		SetAttribute(attribute: string, value: Variant): null
462		WaitForChild(childName: string, timeOut: double): Instance
648		children(): Instances
553		clone(): Instance
573		destroy(): null
553		findFirstChild(name: string, recursive: bool = false): Instance
648		getChildren(): Instances
553		isDescendantOf(ancestor: Instance): bool
573		remove(): null
462		AncestryChanged(child: Instance, parent: Instance)
462		AttributeChanged(attribute: string)
462		ChildAdded(child: Instance)
462		ChildRemoved(child: Instance)
462		DescendantAdded(descendant: Instance)
462		DescendantRemoving(descendant: Instance)
500		Destroying()
657		StyledPropertiesChanged()
553		childAdded(child: Instance)
6 members inherited from Object
647		ClassName: string
647		className: string
647		GetPropertyChangedSignal(property: string): RBXScriptSignal
647		IsA(className: string): bool
650		isA(className: string): bool
647		Changed(property: string)

Removed member index 1

History		Member
491		SetViewportSize(sizePx: Vector2): void

Description

VirtualInputManager is an internal service used by Roblox to record inputs and play them back during performance benchmarking tests.

History 90
Hide member changes

663 Add SendMouseMoveDeltaEvent
662 Add SendScroll
573 Change ReturnType of sendThemeChangeEvent from void to null
573 Change ReturnType of sendRobloxEvent from void to null
573 Change ReturnType of WaitForInputEventsProcessed from void to null
573 Change ReturnType of StopRecording from void to null
573 Change ReturnType of StopPlaying from void to null
573 Change ReturnType of StartRecording from void to null
573 Change ReturnType of StartPlayingJSON from void to null
573 Change ReturnType of StartPlaying from void to null
573 Change ReturnType of SetInputTypesToIgnore from void to null
573 Change ReturnType of SendTouchEvent from void to null
573 Change ReturnType of SendTextInputCharacterEvent from void to null
573 Change ReturnType of SendMouseWheelEvent from void to null
573 Change ReturnType of SendMouseMoveEvent from void to null
573 Change ReturnType of SendMouseButtonEvent from void to null
573 Change ReturnType of SendKeyEvent from void to null
573 Change ReturnType of SendGyroscopeEvent from void to null
573 Change ReturnType of SendGravityEvent from void to null
573 Change ReturnType of SendAccelerometerEvent from void to null
573 Change ReturnType of HandleGamepadDisconnect from void to null
573 Change ReturnType of HandleGamepadConnect from void to null
573 Change ReturnType of HandleGamepadButtonInput from void to null
573 Change ReturnType of HandleGamepadAxisInput from void to null
573 Change ReturnType of Dump from void to null
499 Add WaitForInputEventsProcessed
491 Remove SetViewportSize
486 Change ThreadSafety of AdditionalLuaState from ReadOnly to ReadSafe
479 Add StopPlaying
479 Add StartPlayingJSON
479 Add SetViewportSize
479 Add SetInputTypesToIgnore
469 Change Tags of AdditionalLuaState from [NotReplicated] to [Hidden, NotReplicated]
469 Change CanLoad of AdditionalLuaState from true to false
462 Change ThreadSafety of RecordingCompleted from to Unsafe
462 Change ThreadSafety of PlaybackCompleted from to Unsafe
462 Change ThreadSafety of sendThemeChangeEvent from to Unsafe
462 Change ThreadSafety of sendRobloxEvent from to Unsafe
462 Change ThreadSafety of StopRecording from to Unsafe
462 Change ThreadSafety of StartRecording from to Unsafe
462 Change ThreadSafety of StartPlaying from to Unsafe
462 Change ThreadSafety of SendTouchEvent from to Unsafe
462 Change ThreadSafety of SendTextInputCharacterEvent from to Unsafe
462 Change ThreadSafety of SendMouseWheelEvent from to Unsafe
462 Change ThreadSafety of SendMouseMoveEvent from to Unsafe
462 Change ThreadSafety of SendMouseButtonEvent from to Unsafe
462 Change ThreadSafety of SendKeyEvent from to Unsafe
462 Change ThreadSafety of SendGyroscopeEvent from to Unsafe
462 Change ThreadSafety of SendGravityEvent from to Unsafe
462 Change ThreadSafety of SendAccelerometerEvent from to Unsafe
462 Change ThreadSafety of HandleGamepadDisconnect from to Unsafe
462 Change ThreadSafety of HandleGamepadConnect from to Unsafe
462 Change ThreadSafety of HandleGamepadButtonInput from to Unsafe
462 Change ThreadSafety of HandleGamepadAxisInput from to Unsafe
462 Change ThreadSafety of Dump from to Unsafe
462 Change ThreadSafety of AdditionalLuaState from to ReadOnly
454 Change Parameters of SendTextInputCharacterEvent from (str: string, pluginGui: Instance) to (str: string, layerCollector: Instance)
454 Change Parameters of SendMouseWheelEvent from (x: float, y: float, isForwardScroll: bool, pluginGui: Instance) to (x: float, y: float, isForwardScroll: bool, layerCollector: Instance)
454 Change Parameters of SendMouseMoveEvent from (x: float, y: float, pluginGui: Instance) to (x: float, y: float, layerCollector: Instance)
454 Change Parameters of SendMouseButtonEvent from (x: int, y: int, mouseButton: int, isDown: bool, pluginGui: Instance, repeatCount: int) to (x: int, y: int, mouseButton: int, isDown: bool, layerCollector: Instance, repeatCount: int)
454 Change Parameters of SendKeyEvent from (isPressed: bool, keyCode: KeyCode, isRepeatedKey: bool, pluginGui: Instance) to (isPressed: bool, keyCode: KeyCode, isRepeatedKey: bool, layerCollector: Instance)
438 Add sendThemeChangeEvent
423 Change Parameters of SendMouseButtonEvent from (x: int, y: int, mouseButton: int, isDown: bool, pluginGui: Instance) to (x: int, y: int, mouseButton: int, isDown: bool, pluginGui: Instance, repeatCount: int)
355 Add sendRobloxEvent
355 Change Parameters of SendTextInputCharacterEvent from (str: string) to (str: string, pluginGui: Instance)
355 Change Parameters of SendMouseWheelEvent from (x: float, y: float, isForwardScroll: bool) to (x: float, y: float, isForwardScroll: bool, pluginGui: Instance)
355 Change Parameters of SendMouseMoveEvent from (x: float, y: float) to (x: float, y: float, pluginGui: Instance)
355 Change Parameters of SendMouseButtonEvent from (x: int, y: int, mouseButton: int, isDown: bool) to (x: int, y: int, mouseButton: int, isDown: bool, pluginGui: Instance)
355 Change Parameters of SendKeyEvent from (isPressed: bool, keyCode: KeyCode, isRepeatedKey: bool) to (isPressed: bool, keyCode: KeyCode, isRepeatedKey: bool, pluginGui: Instance)
348 Add SendTouchEvent
348 Add SendTextInputCharacterEvent
348 Add SendMouseWheelEvent
348 Add SendMouseMoveEvent
348 Add SendMouseButtonEvent
348 Add SendKeyEvent
348 Add SendGyroscopeEvent
348 Add SendGravityEvent
348 Add SendAccelerometerEvent
348 Add HandleGamepadDisconnect
348 Add HandleGamepadConnect
348 Add HandleGamepadButtonInput
348 Add HandleGamepadAxisInput
322 Add RecordingCompleted
322 Add PlaybackCompleted
322 Add StopRecording
322 Add StartRecording
322 Add StartPlaying
322 Add Dump
322 Add AdditionalLuaState
322 Add VirtualInputManager

Members 28

AdditionalLuaState
CreatorHub

Type		Default
string

Its interface does not cross the network boundary.

It is not meant to be used, and may have unresolved issues.

Security	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Data
Loaded/Saved	false

History 5

486 Change ThreadSafety of AdditionalLuaState from ReadOnly to ReadSafe
469 Change Tags of AdditionalLuaState from [NotReplicated] to [Hidden, NotReplicated]
469 Change CanLoad of AdditionalLuaState from true to false
462 Change ThreadSafety of AdditionalLuaState from to ReadOnly
322 Add AdditionalLuaState

Tags: [Hidden, NotReplicated]

Dump
CreatorHub

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

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 3

573 Change ReturnType of Dump from void to null
462 Change ThreadSafety of Dump from to Unsafe
322 Add Dump

HandleGamepadAxisInput
CreatorHub

Parameters (5)
objectId	int
keyCode	KeyCode
x	float
y	float
z	float
Returns (1)
null

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 3

573 Change ReturnType of HandleGamepadAxisInput from void to null
462 Change ThreadSafety of HandleGamepadAxisInput from to Unsafe
348 Add HandleGamepadAxisInput

HandleGamepadButtonInput
CreatorHub

Parameters (3)
deviceId	int
keyCode	KeyCode
buttonState	int
Returns (1)
null

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 3

573 Change ReturnType of HandleGamepadButtonInput from void to null
462 Change ThreadSafety of HandleGamepadButtonInput from to Unsafe
348 Add HandleGamepadButtonInput

HandleGamepadConnect
CreatorHub

Parameters (1)
deviceId	int
Returns (1)
null

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 3

573 Change ReturnType of HandleGamepadConnect from void to null
462 Change ThreadSafety of HandleGamepadConnect from to Unsafe
348 Add HandleGamepadConnect

HandleGamepadDisconnect
CreatorHub

Parameters (1)
deviceId	int
Returns (1)
null

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 3

573 Change ReturnType of HandleGamepadDisconnect from void to null
462 Change ThreadSafety of HandleGamepadDisconnect from to Unsafe
348 Add HandleGamepadDisconnect

PlaybackCompleted
CreatorHub

Parameters (1)
additionalLuaState	string

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 2

462 Change ThreadSafety of PlaybackCompleted from to Unsafe
322 Add PlaybackCompleted

RecordingCompleted
CreatorHub

Parameters (1)
result	string

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 2

462 Change ThreadSafety of RecordingCompleted from to Unsafe
322 Add RecordingCompleted

SendAccelerometerEvent
CreatorHub

Parameters (3)
x	float
y	float
z	float
Returns (1)
null

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 3

573 Change ReturnType of SendAccelerometerEvent from void to null
462 Change ThreadSafety of SendAccelerometerEvent from to Unsafe
348 Add SendAccelerometerEvent

SendGravityEvent
CreatorHub

Parameters (3)
x	float
y	float
z	float
Returns (1)
null

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 3

573 Change ReturnType of SendGravityEvent from void to null
462 Change ThreadSafety of SendGravityEvent from to Unsafe
348 Add SendGravityEvent

SendGyroscopeEvent
CreatorHub

Parameters (4)
quatX	float
quatY	float
quatZ	float
quatW	float
Returns (1)
null

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 3

573 Change ReturnType of SendGyroscopeEvent from void to null
462 Change ThreadSafety of SendGyroscopeEvent from to Unsafe
348 Add SendGyroscopeEvent

SendKeyEvent
CreatorHub

Parameters (4)
isPressed	bool
keyCode	KeyCode
isRepeatedKey	bool
layerCollector	Instance
Returns (1)
null

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 5

573 Change ReturnType of SendKeyEvent from void to null
462 Change ThreadSafety of SendKeyEvent from to Unsafe
454 Change Parameters of SendKeyEvent from (isPressed: bool, keyCode: KeyCode, isRepeatedKey: bool, pluginGui: Instance) to (isPressed: bool, keyCode: KeyCode, isRepeatedKey: bool, layerCollector: Instance)
355 Change Parameters of SendKeyEvent from (isPressed: bool, keyCode: KeyCode, isRepeatedKey: bool) to (isPressed: bool, keyCode: KeyCode, isRepeatedKey: bool, pluginGui: Instance)
348 Add SendKeyEvent

SendMouseButtonEvent
CreatorHub

Parameters (6)
x	int
y	int
mouseButton	int
isDown	bool
layerCollector	Instance
repeatCount	int
Returns (1)
null

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 6

573 Change ReturnType of SendMouseButtonEvent from void to null
462 Change ThreadSafety of SendMouseButtonEvent from to Unsafe
454 Change Parameters of SendMouseButtonEvent from (x: int, y: int, mouseButton: int, isDown: bool, pluginGui: Instance, repeatCount: int) to (x: int, y: int, mouseButton: int, isDown: bool, layerCollector: Instance, repeatCount: int)
423 Change Parameters of SendMouseButtonEvent from (x: int, y: int, mouseButton: int, isDown: bool, pluginGui: Instance) to (x: int, y: int, mouseButton: int, isDown: bool, pluginGui: Instance, repeatCount: int)
355 Change Parameters of SendMouseButtonEvent from (x: int, y: int, mouseButton: int, isDown: bool) to (x: int, y: int, mouseButton: int, isDown: bool, pluginGui: Instance)
348 Add SendMouseButtonEvent

SendMouseMoveDeltaEvent
CreatorHub

Parameters (3)
deltaX	float
deltaY	float
layerCollector	Instance
Returns (1)
null

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 1

663 Add SendMouseMoveDeltaEvent

SendMouseMoveEvent
CreatorHub

Parameters (3)
x	float
y	float
layerCollector	Instance
Returns (1)
null

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 5

573 Change ReturnType of SendMouseMoveEvent from void to null
462 Change ThreadSafety of SendMouseMoveEvent from to Unsafe
454 Change Parameters of SendMouseMoveEvent from (x: float, y: float, pluginGui: Instance) to (x: float, y: float, layerCollector: Instance)
355 Change Parameters of SendMouseMoveEvent from (x: float, y: float) to (x: float, y: float, pluginGui: Instance)
348 Add SendMouseMoveEvent

SendMouseWheelEvent
CreatorHub

Parameters (4)
x	float
y	float
isForwardScroll	bool
layerCollector	Instance
Returns (1)
null

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 5

573 Change ReturnType of SendMouseWheelEvent from void to null
462 Change ThreadSafety of SendMouseWheelEvent from to Unsafe
454 Change Parameters of SendMouseWheelEvent from (x: float, y: float, isForwardScroll: bool, pluginGui: Instance) to (x: float, y: float, isForwardScroll: bool, layerCollector: Instance)
355 Change Parameters of SendMouseWheelEvent from (x: float, y: float, isForwardScroll: bool) to (x: float, y: float, isForwardScroll: bool, pluginGui: Instance)
348 Add SendMouseWheelEvent

SendScroll
CreatorHub

Parameters (6)
x	float
y	float
deltaX	float
deltaY	float
options	Dictionary
layerCollector	Instance
Returns (1)
null

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 1

662 Add SendScroll

SendTextInputCharacterEvent
CreatorHub

Parameters (2)
str	string
layerCollector	Instance
Returns (1)
null

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 5

573 Change ReturnType of SendTextInputCharacterEvent from void to null
462 Change ThreadSafety of SendTextInputCharacterEvent from to Unsafe
454 Change Parameters of SendTextInputCharacterEvent from (str: string, pluginGui: Instance) to (str: string, layerCollector: Instance)
355 Change Parameters of SendTextInputCharacterEvent from (str: string) to (str: string, pluginGui: Instance)
348 Add SendTextInputCharacterEvent

SendTouchEvent
CreatorHub

Parameters (4)
touchId	int64
state	int
x	float
y	float
Returns (1)
null

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 3

573 Change ReturnType of SendTouchEvent from void to null
462 Change ThreadSafety of SendTouchEvent from to Unsafe
348 Add SendTouchEvent

SetInputTypesToIgnore
CreatorHub

Parameters (1)
inputTypesToIgnore	Variant
Returns (1)
null

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 2

573 Change ReturnType of SetInputTypesToIgnore from void to null
479 Add SetInputTypesToIgnore

StartPlaying
CreatorHub

Parameters (1)
fileName	string
Returns (1)
null

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 3

573 Change ReturnType of StartPlaying from void to null
462 Change ThreadSafety of StartPlaying from to Unsafe
322 Add StartPlaying

StartPlayingJSON
CreatorHub

Parameters (1)
string	string
Returns (1)
null

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 2

573 Change ReturnType of StartPlayingJSON from void to null
479 Add StartPlayingJSON

StartRecording
CreatorHub

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

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 3

573 Change ReturnType of StartRecording from void to null
462 Change ThreadSafety of StartRecording from to Unsafe
322 Add StartRecording

StopPlaying
CreatorHub

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

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 2

573 Change ReturnType of StopPlaying from void to null
479 Add StopPlaying

StopRecording
CreatorHub

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

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 3

573 Change ReturnType of StopRecording from void to null
462 Change ThreadSafety of StopRecording from to Unsafe
322 Add StopRecording

WaitForInputEventsProcessed
CreatorHub

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

It will block the calling thread until completion.

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 2

573 Change ReturnType of WaitForInputEventsProcessed from void to null
499 Add WaitForInputEventsProcessed

Tags: [Yields]

sendRobloxEvent
CreatorHub

Parameters (3)
namespace	string
detail	string
detailType	string
Returns (1)
null

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 3

573 Change ReturnType of sendRobloxEvent from void to null
462 Change ThreadSafety of sendRobloxEvent from to Unsafe
355 Add sendRobloxEvent

sendThemeChangeEvent
CreatorHub

Parameters (1)
themeName	string
Returns (1)
null

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 3

573 Change ReturnType of sendThemeChangeEvent from void to null
462 Change ThreadSafety of sendThemeChangeEvent from to Unsafe
438 Add sendThemeChangeEvent

Removed members 1

SetViewportSize
CreatorHub

Parameters (1)
sizePx	Vector2
Returns (1)
void

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 2

491 Remove SetViewportSize
479 Add SetViewportSize

Engine API

Website

Related

History 5

History 3

History 3

History 3

History 3

History 3

History 2

History 2

History 3

History 3

History 3

History 5

History 6

History 1

History 5

History 5

History 1

History 5

History 3

History 2

History 3

History 2

History 3

History 2

History 3

History 2

History 3

History 3

History 2