Skip to content
Roblox API Reference

StudioService

Provides access to configuration of Roblox Studio and allows importing files from the user's file system.
  • Not creatable
  • Not replicated
  • Service
Memory category
Instances
Own members
47
Inherited members
75
Subclasses
0
Siblings
608

Properties37

Inherited fromObject2

Property categoryData

Inherited fromInstance21

Property categoryBehavior

Property categoryData

Property categoryPermissions

Defined byStudioService14

Property categoryData

  • StudioService.AlignDraggedObjects: boolean
    • Hidden
    • Not replicated
    • Roblox script security
  • StudioService.DraggerSolveConstraints: boolean
    Reflects whether Studio's draggers solve constraints while moving objects.
    • Read only
  • StudioService.GridSize: number
    Determines the distance in studs by which Studio's drag and move tools move objects each tick.
    • Read only
  • StudioService.HoverInstance: Instance
    • Hidden
    • Not replicated
    • Roblox script security
  • StudioService.InstalledPluginData: string
    • Hidden
    • Read only
    • Roblox script security
  • StudioService.PivotSnapToGeometry: boolean
    • Hidden
    • Read only
    • Roblox script security
  • StudioService.RotateIncrement: number
    Determines the degrees by which Studio's rotation tool will rotate selected objects each tick.
    • Read only
  • StudioService.Secrets: string
    A JSON string storing the local secrets for the current experience, used by Studio to support HttpService:GetSecret().
    • Roblox script security
  • StudioService.ShowConstraintDetails: boolean
    Reflects whether constraint details are drawn in the 3D viewport.
    • Read only
  • StudioService.ShowWeldDetails: boolean
    Reflects whether weld details are drawn in the 3D viewport.
    • Read only
    • Roblox script security
  • StudioService.UseLocalSpace: boolean
    Determines whether Studio tools will use local space of an object or global space.
    • Not replicated
    • Load only
  • StudioService.DrawConstraintsOnTop: boolean
    Deprecated: This property is deprecated; constraints can no longer be drawn "on top" of other objects.
    Deprecated property that previously controlled whether constraints were drawn on top of other objects in the viewport.
    • Deprecated
    • Read only

Property categoryState

  • StudioService.ActiveScript: Instance
    Reflects the LuaSourceContainer currently being edited (if any).
    • Read only
  • StudioService.StudioLocaleId: string
    The locale currently in-use by Studio, e.g. en_US.
    • Read only

Methods66

Inherited fromObject3
  • Get an event that fires when a given property of the object changes.
    Parameters
    ParameterDescription
    property: string
    The property to connect to.
    Returns
    TypeDescription
    RBXScriptSignal
    A signal that fires whenever the property changes.
  • Object:IsA(className: string): boolean
    Returns true if an object's class matches or inherits from a given class.
    • Custom Lua state
    • Thread safe
    Parameters
    ParameterDescription
    className: string
    The class against which the Object's class will be checked. Case-sensitive.
    Returns
    TypeDescription
    boolean
    Describes whether the Object's class matched or is a subclass of the given class.
  • Object:isA(className: string): boolean
    Deprecated: This deprecated function is a variant of Object:IsA() which should be used instead.
    • Deprecated
    • Custom Lua state
    Parameters
    Parameter
    className: string
    Returns
    Type
    boolean

    Use IsA instead.

Inherited fromInstance39
Defined byStudioService24
  • StudioService:AnimationIdSelected(id: number)
    • Roblox script security
    Parameters
    Parameter
    id: number
  • StudioService:CopyToClipboard(stringToCopy: string)
    • Roblox script security
    Parameters
    Parameter
    stringToCopy: string
  • StudioService:GetBadgeConfigureUrl(badgeId: number): string
    • Roblox script security
    Parameters
    Parameter
    badgeId: number
    Returns
    Type
    string
  • StudioService:GetBadgeUploadUrl(): string
    • Roblox script security
    Returns
    Type
    string
  • StudioService:GetClassIcon(className: string): { [string]: any }
    Provides a dictionary that allows the display of a class' Explorer window icon.
    • Plugin security
    Parameters
    ParameterDescription
    className: string
    The name of the Roblox class to retrieve the Explorer window icon for.
    Returns
    TypeDescription
    { [string]: any }
    A dictionary containing Image, ImageRectOffset, and ImageRectSize fields that can be applied to an ImageLabel to display the class icon.
  • StudioService:GetResourceByCategory(category: string): { [string]: any }
    • Roblox script security
    Parameters
    Parameter
    category: string
  • StudioService:GetStartupAssetId(): string
    • Roblox script security
    Returns
    Type
    string
  • StudioService:GetStartupPluginId(): string
    • Roblox script security
    Returns
    Type
    string
  • StudioService:GetTermsOfUseUrl(): string
    • Roblox script security
    Returns
    Type
    string
  • StudioService:GetUserId(): number
    Returns the Studio user's userId if they're logged in, otherwise returns 0.
    • Plugin security
    Returns
    TypeDescription
    number
    The UserId of the logged-in Studio user, or 0 if the user is not logged in.
  • StudioService:GizmoRaycast(origin: Vector3,direction: Vector3,raycastParams: RaycastParams? = RaycastParams{IgnoreWater=false, BruteForceAllSlow=false, RespectCanCollide=false, CollisionGroup=Default, FilterDescendantsInstances={}},): RaycastResult?
    • Plugin security
    Parameters
    Parameter
    origin: Vector3
    direction: Vector3
    raycastParams: RaycastParams? = RaycastParams{IgnoreWater=false, BruteForceAllSlow=false, RespectCanCollide=false, CollisionGroup=Default, FilterDescendantsInstances={}}
    Returns
    Type
    RaycastResult?
  • StudioService:HasInternalPermission(): boolean
    • Roblox script security
    Returns
    Type
    boolean
  • StudioService:IsPluginInstalled(assetId: number): boolean
    • Roblox script security
    Parameters
    Parameter
    assetId: number
    Returns
    Type
    boolean
  • StudioService:IsPluginUpToDate(assetId: number,currentAssetVersion: number,): boolean
    • Roblox script security
    Parameters
    Parameter
    assetId: number
    currentAssetVersion: number
    Returns
    Type
    boolean
  • StudioService:OpenInBrowser_DONOTUSE(url: string)
    • Roblox script security
    Parameters
    Parameter
    url: string
  • StudioService:PromptImportFileAsync(fileTypeFilter: { any }? = {}): Instance
    Prompts the current Studio user to select one file to add as a File.
    • Yields
    • Plugin security
    Parameters
    ParameterDescription
    fileTypeFilter: { any }? = {}
    A list of file types that the user is allowed to select. File types are formatted without a period. For example, {"jpg", "png"} would allow only a JPG or PNG file to be selected. If no filter is provided, the filter is nil and allows the user to select any file type.
    Returns
    TypeDescription
    Instance
    The imported File. Returns nil if no files were selected, or if the selected file was too large (FileSize greater than 100 megabytes).
  • StudioService:PromptImportFilesAsync(fileTypeFilter: { any }? = {}): { Instance }
    Prompts the current Studio user to select files to add as Files.
    • Yields
    • Plugin security
    Parameters
    ParameterDescription
    fileTypeFilter: { any }? = {}
    A list of file types that the user is allowed to select. File types are formatted without a period. For example, {"jpg", "png"} would allow only JPG and PNG files to be selected. If no filter is provided, the filter is nil and allows the user to select any file type.
    Returns
    TypeDescription
    { Instance }
    The imported Files. Returns an empty list if no files were selected. Returns nil if the user selected one or more files that were too large (FileSize greater than 100 megabytes).
  • StudioService:SetPluginEnabled(assetId: number, state: boolean)
    • Roblox script security
    Parameters
    Parameter
    assetId: number
    state: boolean
  • StudioService:ShowPublishToRoblox()
    • Roblox script security
  • StudioService:TryInstallPlugin(assetId: number, assetVersionId: number)
    • Yields
    • Roblox script security
    Parameters
    Parameter
    assetId: number
    assetVersionId: number
  • StudioService:UninstallPlugin(assetId: number)
    • Roblox script security
    Parameters
    Parameter
    assetId: number
  • StudioService:UpdatePluginManagement()
    • Roblox script security
  • StudioService:PromptImportFile(fileTypeFilter: { any }? = {}): Instance
    Deprecated:
    Prompts the current Studio user to select one file to add as a File.
    • Deprecated
    • Yields
    • Plugin security
    Parameters
    ParameterDescription
    fileTypeFilter: { any }? = {}
    A list of file types that the user is allowed to select. File types are formatted without a period. For example, {"jpg", "png"} would allow only a JPG or PNG file to be selected. If no filter is provided, the filter is nil and allows the user to select any file type.
    Returns
    TypeDescription
    Instance
    The imported File. Returns nil if no files were selected, or if the selected file was too large (FileSize greater than 100 megabytes).

    Use PromptImportFileAsync instead.

  • StudioService:PromptImportFiles(fileTypeFilter: { any }? = {}): { Instance }
    Deprecated:
    Prompts the current Studio user to select files to add as Files.
    • Deprecated
    • Yields
    • Plugin security
    Parameters
    ParameterDescription
    fileTypeFilter: { any }? = {}
    A list of file types that the user is allowed to select. File types are formatted without a period. For example, {"jpg", "png"} would allow only JPG and PNG files to be selected. If no filter is provided, the filter is nil and allows the user to select any file type.
    Returns
    TypeDescription
    { Instance }
    The imported Files. Returns an empty list if no files were selected. Returns nil if the user selected one or more files that were too large (FileSize greater than 100 megabytes).

    Use PromptImportFilesAsync instead.

Events19

Inherited fromObject1
Inherited fromInstance9
Defined byStudioService9