StudioDeviceSimulatorService | Documentation

local id = Simulator:CreateDeviceAsync({
    Name = "My Custom Tablet",
    Width = 2560,
    Height = 1600,
    PixelDensity = 300,
    DeviceForm = Enum.DeviceForm.Tablet,
})

GetDeviceAsync

Yields

Plugin Security

StudioDeviceSimulatorService:GetDeviceAsync():string

Returns

string

GetDeviceInfoAsync

Yields

Plugin Security

StudioDeviceSimulatorService:GetDeviceInfoAsync(deviceId:string):Dictionary

Parameters

deviceId:string

Returns

Dictionary

GetDeviceListAsync

Yields

Plugin Security

StudioDeviceSimulatorService:GetDeviceListAsync():{any}

Returns

{any}

Code Samples

Get device list example

local Simulator = game:GetService("StudioDeviceSimulatorService")
local devices = Simulator:GetDeviceListAsync()

for _, deviceId in devices do
    print(deviceId)
end

GetOrientationAsync

Yields

Plugin Security

StudioDeviceSimulatorService:GetOrientationAsync():Enum.ScreenOrientation

Returns

Enum.ScreenOrientation

GetPixelDensityAsync

Yields

Plugin Security

StudioDeviceSimulatorService:GetPixelDensityAsync():number

Returns

number

GetResolutionAsync

Yields

Plugin Security

StudioDeviceSimulatorService:GetResolutionAsync():Vector2

Returns

Vector2

GetScalingModeAsync

Yields

Plugin Security

StudioDeviceSimulatorService:GetScalingModeAsync():Enum.DeviceSimulatorScalingMode

Returns

Enum.DeviceSimulatorScalingMode

RemoveDeviceAsync

Yields

Plugin Security

StudioDeviceSimulatorService:RemoveDeviceAsync(deviceId:string):()

Parameters

deviceId:string

Returns

()

SetDeviceAsync

Yields

Plugin Security

StudioDeviceSimulatorService:SetDeviceAsync(deviceId:string):()

Parameters

deviceId:string

Returns

()

SetOrientationAsync

Yields

Plugin Security

StudioDeviceSimulatorService:SetOrientationAsync(orientation:Enum.ScreenOrientation):()

Parameters

orientation:Enum.ScreenOrientation

Returns

()

SetPixelDensityAsync

Yields

Plugin Security

StudioDeviceSimulatorService:SetPixelDensityAsync(density:number):()

Parameters

density:number

Returns

()

SetResolutionAsync

Yields

Plugin Security

StudioDeviceSimulatorService:SetResolutionAsync(

width:number, height:number

):()

Parameters

width:number

height:number

Returns

()

SetScalingModeAsync

Yields

Plugin Security

StudioDeviceSimulatorService:SetScalingModeAsync(mode:Enum.DeviceSimulatorScalingMode):()

Parameters

mode:Enum.DeviceSimulatorScalingMode

Returns

()

StopSimulationAsync

Yields

Plugin Security

StudioDeviceSimulatorService:StopSimulationAsync():()

Returns

()

UpdateDeviceAsync

Yields

Plugin Security

StudioDeviceSimulatorService:UpdateDeviceAsync(

deviceId:string, config:Dictionary

):()

Parameters

deviceId:string

config:Dictionary

Returns

()

Code Samples

Update Device example

Simulator:UpdateDeviceAsync(id, {
    Name = "My Custom Tablet",
    Width = 2732,
    Height = 2048,
    PixelDensity = 264,
    DeviceForm = Enum.DeviceForm.Tablet,
})

Events

ConfigurationChanged

Plugin Security

StudioDeviceSimulatorService.ConfigurationChanged():RBXScriptSignal

Code Samples

Configuration changed example

Simulator.ConfigurationChanged:Connect(function()
    local deviceId = Simulator:GetDeviceAsync()
    if deviceId ~= "default" then
        local res = Simulator:GetResolutionAsync()
        print(string.format("Active: %s @ %dx%d", deviceId, res.X, res.Y))
    end
end)