Service allowing you to control Studio's Device Simulator.
Its interface does not cross the network boundary.
Instances of this class cannot be created with Instance.new.
It is a singleton that may be acquired with GetService.
Tags: [NotCreatable, Service, NotReplicated]
History Member 717 CreateDeviceAsync ( config: Dictionary ) : string 717 GetDeviceAsync ( ) : string 717 GetDeviceInfoAsync ( deviceId: string ) : Dictionary 717 GetDeviceListAsync ( ) : Array 717 GetOrientationAsync ( ) : ScreenOrientation 717 GetPixelDensityAsync ( ) : float 731 GetRegisteredSimulators ( ) : Array 717 GetResolutionAsync ( ) : Vector2 717 GetScalingModeAsync ( ) : DeviceSimulatorScalingMode 731 RegisterSimulator ( name: string , config: Dictionary ) : Dictionary 717 RemoveDeviceAsync ( deviceId: string ) : null 717 SetDeviceAsync ( deviceId: string ) : null 717 SetOrientationAsync ( orientation: ScreenOrientation ) : null 717 SetPixelDensityAsync ( density: float ) : null 717 SetResolutionAsync ( width: int , height: int ) : null 717 SetScalingModeAsync ( mode: DeviceSimulatorScalingMode ) : null 717 StopSimulationAsync ( ) : null 731 UnregisterSimulator ( handle: Dictionary ) : null 717 UpdateDeviceAsync ( deviceId: string , config: Dictionary ) : null 717 ConfigurationChanged ( ) 731 SimulatorRegistryChanged ( ) 68 members731 Archivable : bool 731 Attributes : string 731 AttributesReplicate : string 731 AttributesSerialize : BinaryString 731 Capabilities : SecurityCapabilities 731 DataCost : int 731 DefinesCapabilities : bool 731 HistoryId : UniqueId 731 IsInSandbox : bool 731 Name : string 731 Parent : Instance 731 PredictionMode : PredictionMode 731 PropertyStatusStudio : PropertyStatus 731 RobloxLocked : bool 731 Sandboxed : bool 731 SourceAssetId : int64 731 Tags : SharedString 731 UniqueId : UniqueId 731 archivable : bool 731 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 707 GetDescendants ( ) : Instances 486 GetFullName ( ) : string 706 GetStyled ( name: string , selector: 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 698 QueryDescendants ( selector: string ) : Instances 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 731 children ( ) : Instances 731 clone ( ) : Instance 731 destroy ( ) : null 731 findFirstChild ( name: string , recursive: bool = false ) : Instance 731 getChildren ( ) : Instances 731 isDescendantOf ( ancestor: Instance ) : bool 731 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 ( ) 731 childAdded ( child: Instance ) 6 members731 ClassName : string 731 className : string 647 GetPropertyChangedSignal ( property: string ) : RBXScriptSignal 647 IsA ( className: string ) : bool 731 isA ( className: string ) : bool 647 Changed ( property: string )
Provides programmatic control over Studio's Device Simulator. Use this service
to switch between device presets, override resolution and pixel density,
control orientation and scaling, and manage custom device profiles from a
plugin or from an external tool connected through the MCP server.
All methods are asynchronous and yield the calling coroutine. The service is
available in Edit mode and Play Client . Methods that modify the active
simulation state are blocked in PlayServer mode.
Limitations All methods are asynchronous and yield the calling coroutine. Methods that modify the active simulation state (SetDeviceAsync,
StopSimulationAsync, SetOrientationAsync, SetResolutionAsync,
SetPixelDensityAsync, SetScalingModeAsync) error in PlayServer mode.
They work in Edit mode and Play Client. UpdateDeviceAsync and RemoveDeviceAsync error when called on built-in
presets.Resolution, DPI, and scaling mode methods require an active device and error
when GetDeviceAsync() returns "default". Resolution and DPI overrides are session-level. They are not persisted and
are cleared on SetDeviceAsync. Built-in presets are immutable. Parameters (0 ) No parameters.
Fires when the active simulation state changes: device switch,
orientation, resolution, pixel density, scaling mode, or user interaction
with the Device Simulator UI. Does not fire for catalog-only operations
such as CreateDeviceAsync, UpdateDeviceAsync on a non-active device,
RemoveDeviceAsync on a non-active device, or GetDeviceInfoAsync.
Getter calls inside the handler are async and will yield.
History 1 Creates a custom device and returns its newly assigned ID. Custom devices
are persisted to disk and appear in the Device Simulator UI.
Errors if any required field is missing or out of range.
It will block the calling thread until completion.
History 1 Tags: [Yields]
Parameters (0 ) No parameters. Returns (1 )
Returns the ID of the currently active device, or "default" if no device
is active.
It will block the calling thread until completion.
History 1 Tags: [Yields]
Returns a DeviceConfiguration for the specified device without
activating it. Useful for inspecting presets before choosing one to switch
to.
The returned dictionary contains the following fields:
Field Type Create/Update Description DeviceIdstring Read-only Unique identifier assigned by the service. Namestring Required Display name. 1 to 200 characters. Cannot be "default". Widthnumber Required Screen width in pixels. Range: 1 to 7680. Heightnumber Required Screen height in pixels. Range: 1 to 4320. PixelDensitynumber Required Pixel density in DPI. Range: 72 to 10000. DeviceFormDeviceForm Optional (default: Phone) One of Phone, Tablet, Desktop, Console, VR. IsCustomboolean Read-only true if the device was user-created.ResolutionScalenumber Optional (default: 1.0) Resolution scaling factor. Must be greater than 0, max 10.0. PortraitKeyboardHeightnumber Optional (default: 0) Virtual keyboard height in portrait mode. LandscapeKeyboardHeightnumber Optional (default: 0) Virtual keyboard height in landscape mode.
It will block the calling thread until completion.
History 1 Tags: [Yields]
Parameters (0 ) No parameters. Returns (1 )
Returns an array of device IDs for all available presets, including
built-in and custom devices.
It will block the calling thread until completion.
History 1 Tags: [Yields]
Returns the current simulated orientation.
It will block the calling thread until completion.
History 1 Tags: [Yields]
Parameters (0 ) No parameters. Returns (1 )
Returns the current simulated pixel density.
It will block the calling thread until completion.
History 1 Tags: [Yields]
Parameters (0 ) No parameters. Returns (1 )
History 1 Parameters (0 ) No parameters. Returns (1 )
Returns the current simulated resolution.
It will block the calling thread until completion.
History 1 Tags: [Yields]
Returns the current scaling mode.
It will block the calling thread until completion.
History 1 Tags: [Yields]
Removes a custom device.
Errors if the target is a built-in preset.
It will block the calling thread until completion.
History 1 Tags: [Yields]
Activates the specified device. Passing "default" stops simulation and
is equivalent to calling StopSimulationAsync.
Errors in PlayServer mode. Errors if the device ID does not exist.
It will block the calling thread until completion.
History 1 Tags: [Yields]
Sets or gets the simulated screen orientation. Accepts Portrait,
LandscapeLeft, or LandscapeRight. Other values will error.
Errors in PlayServer mode.
It will block the calling thread until completion.
History 1 Tags: [Yields]
Overrides or returns the simulated pixel density in DPI. Session-level;
cleared on device switch.
This method requires an active device. SetPixelDensityAsync also errors
in PlayServer mode.
It will block the calling thread until completion.
History 1 Tags: [Yields]
Overrides the simulated viewport resolution or returns the current
resolution as a Vector2. Overrides are session-level and cleared when you
switch devices.
Coordinates are in landscape space: the first parameter maps to the
horizontal axis in landscape, the second to the vertical axis. In
portrait, axes are swapped automatically.
Both methods require an active device. They error if GetDeviceAsync()
returns "default". SetResolutionAsync also errors in PlayServer mode.
It will block the calling thread until completion.
History 1 Tags: [Yields]
Controls how the simulated resolution maps to the Studio viewport.
ScaleToPhysicalSize scales the viewport to approximate physical device
size.ActualResolution renders at exact pixel resolution.FitToWindow scales to fill the viewport.Both methods require an active device. SetScalingModeAsync also errors
in PlayServer mode.
It will block the calling thread until completion.
History 1 Tags: [Yields]
Parameters (0 ) No parameters.
History 1 Parameters (0 ) No parameters. Returns (1 )
Stops the active simulation. Prefer this over SetDeviceAsync("default")
for clarity.
Errors in PlayServer mode.
It will block the calling thread until completion.
History 1 Tags: [Yields]
Updates a custom device's configuration.
Errors if the target is a built-in preset.
It will block the calling thread until completion.
History 1 Tags: [Yields]