StudioService On DevHub

Summary

This class is not creatable. An object of this class cannot be created with Instance.new.

This class is a service. It is a singleton that may be acquired with GetService.

This item is not replicated. Its interface does not cross the network boundary.

Memory Category	Instances

Tags: [NotCreatable, Service, NotReplicated]

Inherits (1)

Instance

Member index (47)

Type	Member	History
Instance	ActiveScript
bool	AlignDraggedObjects	440 469
bool	DraggerSolveConstraints	422
bool	DrawConstraintsOnTop	425
float	GridSize	400
Instance	HoverInstance	431 469 469
string	InstalledPluginData	404 469
bool	PivotSnapToGeometry	470
float	RotateIncrement	400
bool	ShowActiveInstanceHighlight	438 469 469
bool	ShowConstraintDetails	422
string	StudioLocaleId	387
bool	UseLocalSpace	400
void	AnimationIdSelected (int64 id)	428
void	CopyToClipboard (string stringToCopy)	364
string	GetBadgeConfigureUrl (int64 badgeId)	472
string	GetBadgeUploadUrl ()	472
Dictionary	GetClassIcon (string className)	375
bool	GetPlaceIsPersistedToCloud ()	506
Dictionary	GetResourceByCategory (string category)	396
string	GetStartupAssetId ()	446
string	GetStartupPluginId ()	404
string	GetTermsOfUseUrl ()	437
int64	GetUserId ()	379 418
RaycastResult	GizmoRaycast (Vector3 origin, Vector3 direction, RaycastParams raycastParams = RaycastParams{IgnoreWater=false, BruteForceAllSlow=false, RespectCanCollide=false, CollisionGroup=Default, FilterDescendantsInstances={}})	420 422 438 509 549
bool	HasInternalPermission ()	440
bool	IsPluginInstalled (int64 assetId)	398
bool	IsPluginUpToDate (int64 assetId, int64 currentAssetVersion)	398
void	OpenInBrowser_DONOTUSE (string url)	409
Instance	PromptImportFile (Array fileTypeFilter = {})	372
Objects	PromptImportFiles (Array fileTypeFilter = {})	372
void	RequestClose (StudioCloseMode closeMode)	479
void	SetPluginEnabled (int64 assetId, bool state)	399
void	ShowPlaceVersionHistoryDialog (int64 placeId)	433 447
void	ShowPublishToRoblox ()	370
void	TryInstallPlugin (int64 assetId, int64 assetVersionId)	398
void	UninstallPlugin (int64 assetId)	399
void	UpdatePluginManagement ()	399
	OnImportFromRoblox ()	428
	OnOpenGameSettings (string pageIdentifier)	443 442 443
	OnOpenManagePackagePlugin (int64 userId, int64 assetId)	396
	OnPluginInstalledFromToolbox ()	399
	OnPluginInstalledFromWeb (string pluginId)	404
	OnPublishAsPlugin (Objects instances)	406
	OnSaveToRoblox (Objects instances)	382
	PromptTransformPluginCheckEnable ()	451
	SaveLocallyAsComplete (bool success)	478
51 members inherited from Instance

Removed member index (42)

Type	Member	History
bool	BaseURLHasChineseHost ()	441 493
void	ConvertToPackageUpload (string uploadUrl)	401 416 520
void	DEPRECATED_EmitPlacePublishedSignal ()	530 535
void	DEPRECATED_RefreshDocumentDisplayName ()	530 535
void	DEPRECATED_SetDocumentDisplayName (string newName)	505 519
void	DEPRECATED_SetTurnOnTeamCreateOnPublish (bool turnOn)	513 521
void	DEPRECATED_SetUniverseDisplayName (string newName)	530 535
void	DEPRECATED_ShowPlaceVersionHistoryDialog ()	447 464
void	DEPRECATED_ShowSaveOrPublishPlaceToRoblox (bool showGameSelect, bool isPublish, StudioCloseMode closeMode)	530 535
void	DEPRECATED_publishAs (int64 universeId, int64 placeId, int64 groupId)	530 535
void	EmitPlacePublishedSignal ()	402 530
string	GetInstalledPluginData ()	399 404
bool	GetUserIsInTeamCreateToggleRamp ()	506 528
void	LaunchBulkImport (int assetTypeToImport)	417 419 419 424
void	OpenPluginInsertPage (int64 assetId)	364 458
void	PromptForLocalSave ()	477 505
Instance	PromptImportLocalAsset (string prompt, Array fileTypeFilter = {})	369 372 492
Objects	PromptImportLocalAssets (string prompt, Array fileTypeFilter = {})	369 372 492
void	PublishAs (int64 universeId, int64 placeId, int64 groupId)	396 423 530
void	RefreshDocumentDisplayName ()	506 530
void	RequestCloseStudio ()	475 479
string	SerializeInstances (Objects instances)	390 524
void	SetDocumentDisplayName (string newName)	436 505
void	SetTurnOnTeamCreateOnPublish (bool turnOn)	506 513
void	SetUniverseDisplayName (string newName)	364 530
void	ShowBulkImportView ()	418 424
void	ShowSaveOrPublishPlaceToRoblox (bool showGameSelect, bool isPublish, StudioCloseMode closeMode)	478 479 530
void	emitPlacePublishedSignal ()	396 402
	BulkImportFinished (int state)	419 424
	DEPRECATED_GameNameUpdated (string name)	530 535
	DEPRECATED_GamePublishFinished (bool success, int64 gameId)	530 535
	DEPRECATED_OnPublishPlaceToRoblox (bool isOverwritePublish)	441 470 530 535
	DEPRECATED_OnSaveOrPublishPlaceToRoblox (bool showGameSelect, bool isPublish, StudioCloseMode closeMode)	530 535
	FirstPublishOfCloudPlace (int64 universeId, int64 placeId)	477 505
	GameNameUpdated (string name)	457 530
	GamePublishFinished (bool success, int64 gameId)	402 426 530
	GamePublishedToRoblox ()	396 402
	OnConvertToPackageResult (bool isSuccessful, string errorMessage)	401 402 520
	OnOpenConvertToPackagePlugin (Objects instances, string name)	396 401 520
	OnPublishPlaceToRoblox (bool isOverwritePublish)	393 441 530
	OnSaveOrPublishPlaceToRoblox (bool showGameSelect, bool isPublish, StudioCloseMode closeMode)	471 475 479 530
	PlacePublishedToRoblox ()	400 402

549 Change Parameters of StudioService.GizmoRaycast from (Vector3 origin, Vector3 direction, RaycastParams raycastParams = RaycastParams{IgnoreWater=false, BruteForceAllSlow=false, CollisionGroup=Default, FilterDescendantsInstances={}}) to (Vector3 origin, Vector3 direction, RaycastParams raycastParams = RaycastParams{IgnoreWater=false, BruteForceAllSlow=false, RespectCanCollide=false, CollisionGroup=Default, FilterDescendantsInstances={}})
535 Remove StudioService.DEPRECATED_EmitPlacePublishedSignal
535 Remove StudioService.DEPRECATED_RefreshDocumentDisplayName
535 Remove StudioService.DEPRECATED_SetUniverseDisplayName
535 Remove StudioService.DEPRECATED_ShowSaveOrPublishPlaceToRoblox
535 Remove StudioService.DEPRECATED_publishAs
535 Remove StudioService.DEPRECATED_GameNameUpdated
535 Remove StudioService.DEPRECATED_GamePublishFinished
535 Remove StudioService.DEPRECATED_OnPublishPlaceToRoblox
535 Remove StudioService.DEPRECATED_OnSaveOrPublishPlaceToRoblox
530 Add StudioService.DEPRECATED_EmitPlacePublishedSignal
530 Add StudioService.DEPRECATED_RefreshDocumentDisplayName
530 Add StudioService.DEPRECATED_SetUniverseDisplayName
530 Add StudioService.DEPRECATED_ShowSaveOrPublishPlaceToRoblox
530 Add StudioService.DEPRECATED_publishAs
530 Remove StudioService.EmitPlacePublishedSignal
530 Remove StudioService.PublishAs
530 Remove StudioService.RefreshDocumentDisplayName
530 Remove StudioService.SetUniverseDisplayName
530 Remove StudioService.ShowSaveOrPublishPlaceToRoblox
530 Add StudioService.DEPRECATED_GameNameUpdated
530 Add StudioService.DEPRECATED_GamePublishFinished
530 Add StudioService.DEPRECATED_OnPublishPlaceToRoblox
530 Add StudioService.DEPRECATED_OnSaveOrPublishPlaceToRoblox
530 Remove StudioService.GameNameUpdated
530 Remove StudioService.GamePublishFinished
530 Remove StudioService.OnPublishPlaceToRoblox
530 Remove StudioService.OnSaveOrPublishPlaceToRoblox
528 Remove StudioService.GetUserIsInTeamCreateToggleRamp
524 Remove StudioService.SerializeInstances
521 Remove StudioService.DEPRECATED_SetTurnOnTeamCreateOnPublish
520 Remove StudioService.ConvertToPackageUpload
520 Remove StudioService.OnConvertToPackageResult
520 Remove StudioService.OnOpenConvertToPackagePlugin
519 Remove StudioService.DEPRECATED_SetDocumentDisplayName
513 Add StudioService.DEPRECATED_SetTurnOnTeamCreateOnPublish
513 Remove StudioService.SetTurnOnTeamCreateOnPublish
509 Change Parameters of StudioService.GizmoRaycast from (Vector3 origin, Vector3 direction, RaycastParams raycastParams = RaycastParams{IgnoreWater=false, CollisionGroup=Default, FilterDescendantsInstances={}}) to (Vector3 origin, Vector3 direction, RaycastParams raycastParams = RaycastParams{IgnoreWater=false, BruteForceAllSlow=false, CollisionGroup=Default, FilterDescendantsInstances={}})
506 Add StudioService.GetPlaceIsPersistedToCloud
506 Add StudioService.GetUserIsInTeamCreateToggleRamp
506 Add StudioService.RefreshDocumentDisplayName
506 Add StudioService.SetTurnOnTeamCreateOnPublish
505 Add StudioService.DEPRECATED_SetDocumentDisplayName
505 Remove StudioService.PromptForLocalSave
505 Remove StudioService.SetDocumentDisplayName
505 Remove StudioService.FirstPublishOfCloudPlace
493 Remove StudioService.BaseURLHasChineseHost
492 Remove StudioService.PromptImportLocalAsset
492 Remove StudioService.PromptImportLocalAssets
479 Add StudioService.RequestClose
479 Remove StudioService.RequestCloseStudio
479 Change Parameters of StudioService.ShowSaveOrPublishPlaceToRoblox from (bool showGameSelect, bool isPublish, bool closeAfterSave) to (bool showGameSelect, bool isPublish, StudioCloseMode closeMode)
479 Change Parameters of StudioService.OnSaveOrPublishPlaceToRoblox from (bool showGameSelect, bool isPublish, bool closeAfterSave) to (bool showGameSelect, bool isPublish, StudioCloseMode closeMode)
478 Add StudioService.ShowSaveOrPublishPlaceToRoblox
478 Add StudioService.SaveLocallyAsComplete
477 Add StudioService.PromptForLocalSave
477 Add StudioService.FirstPublishOfCloudPlace
475 Add StudioService.RequestCloseStudio
475 Change Parameters of StudioService.OnSaveOrPublishPlaceToRoblox from (bool showGameSelect, bool isPublish) to (bool showGameSelect, bool isPublish, bool closeAfterSave)
472 Add StudioService.GetBadgeConfigureUrl
472 Add StudioService.GetBadgeUploadUrl
471 Add StudioService.OnSaveOrPublishPlaceToRoblox
470 Add StudioService.PivotSnapToGeometry
470 Remove StudioService.DEPRECATED_OnPublishPlaceToRoblox
469 Change Tags of StudioService.AlignDraggedObjects from [ReadOnly, NotReplicated] to [Hidden, ReadOnly, NotReplicated]
469 Change CanLoad of StudioService.HoverInstance from true to false
469 Change Tags of StudioService.HoverInstance from [NotReplicated] to [Hidden, NotReplicated]
469 Change Tags of StudioService.InstalledPluginData from [ReadOnly, NotReplicated] to [Hidden, ReadOnly, NotReplicated]
469 Change CanLoad of StudioService.ShowActiveInstanceHighlight from true to false
469 Change Tags of StudioService.ShowActiveInstanceHighlight from [NotReplicated] to [Hidden, NotReplicated]
464 Remove StudioService.DEPRECATED_ShowPlaceVersionHistoryDialog
458 Remove StudioService.OpenPluginInsertPage
457 Add StudioService.GameNameUpdated
451 Add StudioService.PromptTransformPluginCheckEnable
447 Add StudioService.DEPRECATED_ShowPlaceVersionHistoryDialog
447 Change Parameters of StudioService.ShowPlaceVersionHistoryDialog from () to (int64 placeId)
446 Add StudioService.GetStartupAssetId
443 Add StudioService.OnOpenGameSettings
442 Remove StudioService.OnOpenGameSettings
443 Add StudioService.OnOpenGameSettings
441 Add StudioService.BaseURLHasChineseHost
441 Add StudioService.DEPRECATED_OnPublishPlaceToRoblox
441 Change Parameters of StudioService.OnPublishPlaceToRoblox from () to (bool isOverwritePublish)
440 Add StudioService.AlignDraggedObjects
440 Add StudioService.HasInternalPermission
438 Add StudioService.ShowActiveInstanceHighlight
438 Change Parameters of StudioService.GizmoRaycast from (Vector3 origin, Vector3 direction, RaycastParams raycastParams = RaycastParams{IgnoreWater=false, FilterDescendantsInstances={}}) to (Vector3 origin, Vector3 direction, RaycastParams raycastParams = RaycastParams{IgnoreWater=false, CollisionGroup=Default, FilterDescendantsInstances={}})
437 Add StudioService.GetTermsOfUseUrl
436 Add StudioService.SetDocumentDisplayName
433 Add StudioService.ShowPlaceVersionHistoryDialog
431 Add StudioService.HoverInstance
428 Add StudioService.AnimationIdSelected
428 Add StudioService.OnImportFromRoblox
426 Change Parameters of StudioService.GamePublishFinished from (bool success) to (bool success, int64 gameId)
425 Add StudioService.DrawConstraintsOnTop
424 Remove StudioService.LaunchBulkImport
424 Remove StudioService.ShowBulkImportView
424 Remove StudioService.BulkImportFinished
423 Change Parameters of StudioService.PublishAs from (int64 universeId, int64 placeId) to (int64 universeId, int64 placeId, int64 groupId)
422 Add StudioService.DraggerSolveConstraints
422 Add StudioService.ShowConstraintDetails
422 Change ReturnType of StudioService.GizmoRaycast from Tuple to RaycastResult
420 Add StudioService.GizmoRaycast
419 Change ReturnType of StudioService.LaunchBulkImport from int to void
419 Change Tags of StudioService.LaunchBulkImport from [Yields] to []
419 Add StudioService.BulkImportFinished
418 Change Security of StudioService.GetUserId from RobloxScriptSecurity to PluginSecurity
418 Add StudioService.ShowBulkImportView
417 Add StudioService.LaunchBulkImport
416 Change Security of StudioService.ConvertToPackageUpload from PluginSecurity to RobloxScriptSecurity
409 Add StudioService.OpenInBrowser_DONOTUSE
406 Add StudioService.OnPublishAsPlugin
404 Add StudioService.InstalledPluginData
404 Remove StudioService.GetInstalledPluginData
404 Add StudioService.GetStartupPluginId
404 Add StudioService.OnPluginInstalledFromWeb
402 Add StudioService.EmitPlacePublishedSignal
402 Remove StudioService.emitPlacePublishedSignal
402 Add StudioService.GamePublishFinished
402 Remove StudioService.GamePublishedToRoblox
402 Change Parameters of StudioService.OnConvertToPackageResult from (bool result) to (bool isSuccessful, string errorMessage)
402 Remove StudioService.PlacePublishedToRoblox
401 Add StudioService.ConvertToPackageUpload
401 Add StudioService.OnConvertToPackageResult
401 Change Parameters of StudioService.OnOpenConvertToPackagePlugin from () to (Objects instances, string name)
400 Add StudioService.GridSize
400 Add StudioService.RotateIncrement
400 Add StudioService.UseLocalSpace
400 Add StudioService.PlacePublishedToRoblox
399 Add StudioService.GetInstalledPluginData
399 Add StudioService.SetPluginEnabled
399 Add StudioService.UninstallPlugin
399 Add StudioService.UpdatePluginManagement
399 Add StudioService.OnPluginInstalledFromToolbox
398 Add StudioService.IsPluginInstalled
398 Add StudioService.IsPluginUpToDate
398 Add StudioService.TryInstallPlugin
396 Add StudioService.GetResourceByCategory
396 Add StudioService.PublishAs
396 Add StudioService.emitPlacePublishedSignal
396 Add StudioService.GamePublishedToRoblox
396 Add StudioService.OnOpenConvertToPackagePlugin
396 Add StudioService.OnOpenManagePackagePlugin
393 Add StudioService.OnPublishPlaceToRoblox
390 Add StudioService.SerializeInstances
387 Add StudioService.StudioLocaleId
382 Add StudioService.OnSaveToRoblox
379 Add StudioService.GetUserId
375 Add StudioService.GetClassIcon
372 Add StudioService.PromptImportFile
372 Add StudioService.PromptImportFiles
372 Change Tags of StudioService.PromptImportLocalAsset from [Yields] to [Yields, Deprecated]
372 Change Tags of StudioService.PromptImportLocalAssets from [Yields] to [Yields, Deprecated]
370 Add StudioService.ShowPublishToRoblox
369 Add StudioService.PromptImportLocalAsset
369 Add StudioService.PromptImportLocalAssets
364 Add StudioService.CopyToClipboard
364 Add StudioService.OpenPluginInsertPage
364 Add StudioService.SetUniverseDisplayName
357 Add StudioService

Members

ActiveScript On DevHub

This property is read-only. Its value can be read, but it cannot be modified.

This item is not replicated. Its interface does not cross the network boundary.

Value Type	Instance
Category	State
Can Load	false
Can Save	false

Tags: [ReadOnly, NotReplicated]

AlignDraggedObjects On DevHub

This property is read-only. Its value can be read, but it cannot be modified.

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

This item is not replicated. Its interface does not cross the network boundary.

Value Type	bool
Security	RobloxScriptSecurity
Category	Data
Can Load	false
Can Save	false

History

469 Change Tags of StudioService.AlignDraggedObjects from [ReadOnly, NotReplicated] to [Hidden, ReadOnly, NotReplicated]
440 Add StudioService.AlignDraggedObjects

Tags: [Hidden, ReadOnly, NotReplicated]

AnimationIdSelected On DevHub

Parameters	1

Name	Type	Default
id	int64	none

Return Type	void
Security	RobloxScriptSecurity

History

428 Add StudioService.AnimationIdSelected

CopyToClipboard On DevHub

Parameters	1

Name	Type	Default
stringToCopy	string	none

Return Type	void
Security	RobloxScriptSecurity

History

364 Add StudioService.CopyToClipboard

DraggerSolveConstraints On DevHub

This property is read-only. Its value can be read, but it cannot be modified.

This item is not replicated. Its interface does not cross the network boundary.

Value Type	bool
Category	Data
Can Load	false
Can Save	false

History

422 Add StudioService.DraggerSolveConstraints

Tags: [ReadOnly, NotReplicated]

DrawConstraintsOnTop On DevHub

This property is read-only. Its value can be read, but it cannot be modified.

This item is not replicated. Its interface does not cross the network boundary.

Value Type	bool
Category	Data
Can Load	false
Can Save	false

History

425 Add StudioService.DrawConstraintsOnTop

Tags: [ReadOnly, NotReplicated]

GetBadgeConfigureUrl On DevHub

Parameters	1

Name	Type	Default
badgeId	int64	none

Return Type	string
Security	RobloxScriptSecurity

History

472 Add StudioService.GetBadgeConfigureUrl

GetBadgeUploadUrl On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	string
Security	RobloxScriptSecurity

History

472 Add StudioService.GetBadgeUploadUrl

GetClassIcon On DevHub

Gets the explorer icon for a given class.

Parameters	1

Name	Type	Default
className	string	none

Return Type	Dictionary
Security	PluginSecurity

GetClassIcon returns the icon for a class as displayed in Studio's explorer panel. className is the name of an existing Roblox class. If successful, a table with the following fields is returned:

Image: string
ImageRectOffset: Vector2
ImageRectSize: Vector2

These correspond to the Image, ImageRectOffset, and ImageRectSize properties of an ImageLabel or ImageButton. The values of each fields can be set directly to its corresponding property to display the icon correctly.

If the given class does not exist, then following error is thrown:

GetClassIcon: CLASS is not a Roblox class.

Where CLASS is the value of the given className.

Examples

Generate a GUI displaying the entire game tree.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70


local StudioService = game:GetService("StudioService")
local TextService = game:GetService("TextService")
local StarterGui = game:GetService("StarterGui")

-- Get base size of icon, assuming all icons have the same size.
local iconSize = StudioService:GetClassIcon("Instance").ImageRectSize
local font = Enum.Font.SourceSans
local fontSize = iconSize.Y
local labelTextOffset = 2

-- Create label template.
local labelTemplate = Instance.new("Frame")
labelTemplate.Name = "ClassLabel"
labelTemplate.BackgroundTransparency = 1

local iconTemplate = Instance.new("ImageLabel", labelTemplate)
iconTemplate.Name = "IconLabel"
iconTemplate.Size = UDim2.new(0, iconSize.X, 0, iconSize.Y)
iconTemplate.BackgroundTransparency = 1

local textTemplate = Instance.new("TextLabel", labelTemplate)
textTemplate.Name = "TextLabel"
textTemplate.Position = UDim2.new(0, iconSize.X + labelTextOffset, 0, 0)
textTemplate.TextXAlignment = Enum.TextXAlignment.Left
textTemplate.BackgroundTransparency = 1
textTemplate.TextColor3 = Color3.new(1, 1, 1)

-- Generate labels.
local maxWidth = 0
local labels = {}
local function createLabels(objects, depth)
	for i, object in pairs(objects) do
		-- Some objects are not friendly to being indexed.
		local ok, name = pcall(function() return object.Name end)
		if ok and object.ClassName ~= "" then
			local icon = StudioService:GetClassIcon(object.ClassName)
			local textSize = TextService:GetTextSize(name, fontSize, font, Vector2.new(0, 0))
			local label = labelTemplate:Clone()
			label.Position = UDim2.new(0, depth * iconSize.X, 0, #labels * iconSize.Y)
			label.Size = UDim2.new(0, iconSize.X + textSize.X + labelTextOffset, 0, iconSize.Y)
			label.IconLabel.Image = icon.Image
			label.IconLabel.ImageRectOffset = icon.ImageRectOffset
			label.IconLabel.ImageRectSize = icon.ImageRectSize
			label.TextLabel.Text = name
			label.TextLabel.Size = UDim2.new(0, textSize.X, 0, iconSize.Y)
			local width = label.Position.X.Offset + label.Size.X.Offset
			if width > maxWidth then
				maxWidth = width
			end
			labels[#labels + 1] = label
			createLabels(object:GetChildren(), depth + 1)
		end
	end
end
createLabels(game:GetChildren(), 0)

-- Generate GUI.
local screen = Instance.new("ScreenGui")
local container = Instance.new("ScrollingFrame", screen)
local width = maxWidth + container.ScrollBarThickness
container.Position = UDim2.new(0, 10, 0, 10)
container.Size = UDim2.new(0, width, 1, -20)
container.CanvasSize = UDim2.new(0, width, 0, #labels * iconSize.Y)
container.BackgroundColor3 = Color3.new(0, 0, 0)
container.BackgroundTransparency = 0.3
container.BorderSizePixel = 0
for _, label in pairs(labels) do
	label.Parent = container
end
screen.Parent = game.StarterGui

History

375 Add StudioService.GetClassIcon

GetPlaceIsPersistedToCloud On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	bool
Security	RobloxScriptSecurity

History

506 Add StudioService.GetPlaceIsPersistedToCloud

GetResourceByCategory On DevHub

Parameters	1

Name	Type	Default
category	string	none

Return Type	Dictionary
Security	RobloxScriptSecurity

History

396 Add StudioService.GetResourceByCategory

GetStartupAssetId On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	string
Security	RobloxScriptSecurity

History

446 Add StudioService.GetStartupAssetId

GetStartupPluginId On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	string
Security	RobloxScriptSecurity

History

404 Add StudioService.GetStartupPluginId

GetTermsOfUseUrl On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	string
Security	RobloxScriptSecurity

History

437 Add StudioService.GetTermsOfUseUrl

GetUserId On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	int64
Security	PluginSecurity

History

418 Change Security of StudioService.GetUserId from RobloxScriptSecurity to PluginSecurity
379 Add StudioService.GetUserId

GizmoRaycast On DevHub

Parameters	3

Name	Type	Default
origin	Vector3	none
direction	Vector3	none
raycastParams	RaycastParams	RaycastParams{IgnoreWater=false, BruteForceAllSlow=false, RespectCanCollide=false, CollisionGroup=Default, FilterDescendantsInstances={}}

Return Type	RaycastResult
Security	PluginSecurity

History

549 Change Parameters of StudioService.GizmoRaycast from (Vector3 origin, Vector3 direction, RaycastParams raycastParams = RaycastParams{IgnoreWater=false, BruteForceAllSlow=false, CollisionGroup=Default, FilterDescendantsInstances={}}) to (Vector3 origin, Vector3 direction, RaycastParams raycastParams = RaycastParams{IgnoreWater=false, BruteForceAllSlow=false, RespectCanCollide=false, CollisionGroup=Default, FilterDescendantsInstances={}})
509 Change Parameters of StudioService.GizmoRaycast from (Vector3 origin, Vector3 direction, RaycastParams raycastParams = RaycastParams{IgnoreWater=false, CollisionGroup=Default, FilterDescendantsInstances={}}) to (Vector3 origin, Vector3 direction, RaycastParams raycastParams = RaycastParams{IgnoreWater=false, BruteForceAllSlow=false, CollisionGroup=Default, FilterDescendantsInstances={}})
438 Change Parameters of StudioService.GizmoRaycast from (Vector3 origin, Vector3 direction, RaycastParams raycastParams = RaycastParams{IgnoreWater=false, FilterDescendantsInstances={}}) to (Vector3 origin, Vector3 direction, RaycastParams raycastParams = RaycastParams{IgnoreWater=false, CollisionGroup=Default, FilterDescendantsInstances={}})
422 Change ReturnType of StudioService.GizmoRaycast from Tuple to RaycastResult
420 Add StudioService.GizmoRaycast

GridSize On DevHub

This property is read-only. Its value can be read, but it cannot be modified.

This item is not replicated. Its interface does not cross the network boundary.

Value Type	float
Category	Data
Can Load	false
Can Save	false

History

400 Add StudioService.GridSize

Tags: [ReadOnly, NotReplicated]

HasInternalPermission On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	bool
Security	RobloxScriptSecurity

History

440 Add StudioService.HasInternalPermission

HoverInstance On DevHub

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

This item is not replicated. Its interface does not cross the network boundary.

Value Type	Instance
Security	RobloxScriptSecurity
Category	Data
Can Load	false
Can Save	false

History

469 Change CanLoad of StudioService.HoverInstance from true to false
469 Change Tags of StudioService.HoverInstance from [NotReplicated] to [Hidden, NotReplicated]
431 Add StudioService.HoverInstance

Tags: [Hidden, NotReplicated]

InstalledPluginData On DevHub

This property is read-only. Its value can be read, but it cannot be modified.

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

This item is not replicated. Its interface does not cross the network boundary.

Value Type	string
Security	RobloxScriptSecurity
Category	Data
Can Load	false
Can Save	false

History

469 Change Tags of StudioService.InstalledPluginData from [ReadOnly, NotReplicated] to [Hidden, ReadOnly, NotReplicated]
404 Add StudioService.InstalledPluginData

Tags: [Hidden, ReadOnly, NotReplicated]

IsPluginInstalled On DevHub

Parameters	1

Name	Type	Default
assetId	int64	none

Return Type	bool
Security	RobloxScriptSecurity

History

398 Add StudioService.IsPluginInstalled

IsPluginUpToDate On DevHub

Parameters	2

Name	Type	Default
assetId	int64	none
currentAssetVersion	int64	none

Return Type	bool
Security	RobloxScriptSecurity

History

398 Add StudioService.IsPluginUpToDate

OnImportFromRoblox On DevHub

Parameters	0

Name	Type	Default
No parameters.

Security	RobloxScriptSecurity

History

428 Add StudioService.OnImportFromRoblox

OnOpenGameSettings On DevHub

Parameters	1

Name	Type	Default
pageIdentifier	string	none

Security	RobloxScriptSecurity

History

443 Add StudioService.OnOpenGameSettings
442 Remove StudioService.OnOpenGameSettings
443 Add StudioService.OnOpenGameSettings

OnOpenManagePackagePlugin On DevHub

Parameters	2

Name	Type	Default
userId	int64	none
assetId	int64	none

Security	RobloxScriptSecurity

History

396 Add StudioService.OnOpenManagePackagePlugin

OnPluginInstalledFromToolbox On DevHub

Parameters	0

Name	Type	Default
No parameters.

Security	RobloxScriptSecurity

History

399 Add StudioService.OnPluginInstalledFromToolbox

OnPluginInstalledFromWeb On DevHub

Parameters	1

Name	Type	Default
pluginId	string	none

Security	RobloxScriptSecurity

History

404 Add StudioService.OnPluginInstalledFromWeb

OnPublishAsPlugin On DevHub

Parameters	1

Name	Type	Default
instances	Objects	none

Security	RobloxScriptSecurity

History

406 Add StudioService.OnPublishAsPlugin

OnSaveToRoblox On DevHub

Parameters	1

Name	Type	Default
instances	Objects	none

Security	RobloxScriptSecurity

History

382 Add StudioService.OnSaveToRoblox

OpenInBrowser_DONOTUSE On DevHub

Parameters	1

Name	Type	Default
url	string	none

Return Type	void
Security	RobloxScriptSecurity

History

409 Add StudioService.OpenInBrowser_DONOTUSE

PivotSnapToGeometry On DevHub

This property is read-only. Its value can be read, but it cannot be modified.

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

This item is not replicated. Its interface does not cross the network boundary.

Value Type	bool
Security	RobloxScriptSecurity
Category	Data
Can Load	false
Can Save	false

History

470 Add StudioService.PivotSnapToGeometry

Tags: [Hidden, ReadOnly, NotReplicated]

PromptImportFile On DevHub

This function yields. It will block the calling thread until completion.

Parameters	1

Name	Type	Default
fileTypeFilter	Array	{}

Return Type	Instance
Security	PluginSecurity

History

372 Add StudioService.PromptImportFile

Tags: [Yields]

PromptImportFiles On DevHub

This function yields. It will block the calling thread until completion.

Parameters	1

Name	Type	Default
fileTypeFilter	Array	{}

Return Type	Objects
Security	PluginSecurity

History

372 Add StudioService.PromptImportFiles

Tags: [Yields]

PromptTransformPluginCheckEnable On DevHub

Parameters	0

Name	Type	Default
No parameters.

Security	RobloxScriptSecurity

History

451 Add StudioService.PromptTransformPluginCheckEnable

RequestClose On DevHub

Parameters	1

Name	Type	Default
closeMode	StudioCloseMode	none

Return Type	void
Security	RobloxScriptSecurity

History

479 Add StudioService.RequestClose

RotateIncrement On DevHub

This property is read-only. Its value can be read, but it cannot be modified.

This item is not replicated. Its interface does not cross the network boundary.

Value Type	float
Category	Data
Can Load	false
Can Save	false

History

400 Add StudioService.RotateIncrement

Tags: [ReadOnly, NotReplicated]

SaveLocallyAsComplete On DevHub

Parameters	1

Name	Type	Default
success	bool	none

Security	RobloxScriptSecurity

History

478 Add StudioService.SaveLocallyAsComplete

SetPluginEnabled On DevHub

Parameters	2

Name	Type	Default
assetId	int64	none
state	bool	none

Return Type	void
Security	RobloxScriptSecurity

History

399 Add StudioService.SetPluginEnabled

ShowActiveInstanceHighlight On DevHub

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

This item is not replicated. Its interface does not cross the network boundary.

Value Type	bool
Security	RobloxScriptSecurity
Category	Data
Can Load	false
Can Save	false

History

469 Change CanLoad of StudioService.ShowActiveInstanceHighlight from true to false
469 Change Tags of StudioService.ShowActiveInstanceHighlight from [NotReplicated] to [Hidden, NotReplicated]
438 Add StudioService.ShowActiveInstanceHighlight

Tags: [Hidden, NotReplicated]

ShowConstraintDetails On DevHub

This property is read-only. Its value can be read, but it cannot be modified.

This item is not replicated. Its interface does not cross the network boundary.

Value Type	bool
Category	Data
Can Load	false
Can Save	false

History

422 Add StudioService.ShowConstraintDetails

Tags: [ReadOnly, NotReplicated]

ShowPlaceVersionHistoryDialog On DevHub

Parameters	1

Name	Type	Default
placeId	int64	none

Return Type	void
Security	RobloxScriptSecurity

History

447 Change Parameters of StudioService.ShowPlaceVersionHistoryDialog from () to (int64 placeId)
433 Add StudioService.ShowPlaceVersionHistoryDialog

ShowPublishToRoblox On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	void
Security	RobloxScriptSecurity

History

370 Add StudioService.ShowPublishToRoblox

StudioLocaleId On DevHub

This property is read-only. Its value can be read, but it cannot be modified.

This item is not replicated. Its interface does not cross the network boundary.

Value Type	string
Category	State
Can Load	false
Can Save	false

History

387 Add StudioService.StudioLocaleId

Tags: [ReadOnly, NotReplicated]

TryInstallPlugin On DevHub

This function yields. It will block the calling thread until completion.

Parameters	2

Name	Type	Default
assetId	int64	none
assetVersionId	int64	none

Return Type	void
Security	RobloxScriptSecurity

History

398 Add StudioService.TryInstallPlugin

Tags: [Yields]

UninstallPlugin On DevHub

Parameters	1

Name	Type	Default
assetId	int64	none

Return Type	void
Security	RobloxScriptSecurity

History

399 Add StudioService.UninstallPlugin

UpdatePluginManagement On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	void
Security	RobloxScriptSecurity

History

399 Add StudioService.UpdatePluginManagement

UseLocalSpace On DevHub

This item is not replicated. Its interface does not cross the network boundary.

Value Type	bool
Category	Data
Can Load	true
Can Save	false

History

400 Add StudioService.UseLocalSpace

Tags: [NotReplicated]

Removed members

BaseURLHasChineseHost

Parameters	0

Name	Type	Default
No parameters.

Return Type	bool
Security	RobloxScriptSecurity

History

493 Remove StudioService.BaseURLHasChineseHost
441 Add StudioService.BaseURLHasChineseHost

BulkImportFinished

Parameters	1

Name	Type	Default
state	int	none

Security	RobloxScriptSecurity

History

424 Remove StudioService.BulkImportFinished
419 Add StudioService.BulkImportFinished

ConvertToPackageUpload

Parameters	1

Name	Type	Default
uploadUrl	string	none

Return Type	void
Security	RobloxScriptSecurity

History

520 Remove StudioService.ConvertToPackageUpload
416 Change Security of StudioService.ConvertToPackageUpload from PluginSecurity to RobloxScriptSecurity
401 Add StudioService.ConvertToPackageUpload

DEPRECATED_EmitPlacePublishedSignal

Parameters	0

Name	Type	Default
No parameters.

Return Type	void
Security	RobloxScriptSecurity

History

DEPRECATED_GameNameUpdated

Parameters	1

Name	Type	Default
name	string	none

Security	RobloxScriptSecurity

History

DEPRECATED_GamePublishFinished

Parameters	2

Name	Type	Default
success	bool	none
gameId	int64	none

Security	RobloxScriptSecurity

History

DEPRECATED_OnPublishPlaceToRoblox

Parameters	1

Name	Type	Default
isOverwritePublish	bool	none

Security	RobloxScriptSecurity

History

DEPRECATED_OnSaveOrPublishPlaceToRoblox

Parameters	3

Name	Type	Default
showGameSelect	bool	none
isPublish	bool	none
closeMode	StudioCloseMode	none

Security	RobloxScriptSecurity

History

DEPRECATED_RefreshDocumentDisplayName

Parameters	0

Name	Type	Default
No parameters.

Return Type	void
Security	RobloxScriptSecurity

History

DEPRECATED_SetDocumentDisplayName

Parameters	1

Name	Type	Default
newName	string	none

Return Type	void
Security	RobloxScriptSecurity

History

DEPRECATED_SetTurnOnTeamCreateOnPublish

Parameters	1

Name	Type	Default
turnOn	bool	none

Return Type	void
Security	RobloxScriptSecurity

History

DEPRECATED_SetUniverseDisplayName

Parameters	1

Name	Type	Default
newName	string	none

Return Type	void
Security	RobloxScriptSecurity

History

DEPRECATED_ShowPlaceVersionHistoryDialog

Parameters	0

Name	Type	Default
No parameters.

Return Type	void
Security	RobloxScriptSecurity

History

DEPRECATED_ShowSaveOrPublishPlaceToRoblox

Parameters	3

Name	Type	Default
showGameSelect	bool	none
isPublish	bool	none
closeMode	StudioCloseMode	none

Return Type	void
Security	RobloxScriptSecurity

History

DEPRECATED_publishAs

Parameters	3

Name	Type	Default
universeId	int64	none
placeId	int64	none
groupId	int64	none

Return Type	void
Security	RobloxScriptSecurity

History

535 Remove StudioService.DEPRECATED_publishAs
530 Add StudioService.DEPRECATED_publishAs

EmitPlacePublishedSignal

Parameters	0

Name	Type	Default
No parameters.

Return Type	void
Security	RobloxScriptSecurity

History

530 Remove StudioService.EmitPlacePublishedSignal
402 Add StudioService.EmitPlacePublishedSignal

FirstPublishOfCloudPlace

Parameters	2

Name	Type	Default
universeId	int64	none
placeId	int64	none

Security	RobloxScriptSecurity

History

505 Remove StudioService.FirstPublishOfCloudPlace
477 Add StudioService.FirstPublishOfCloudPlace

GameNameUpdated

Parameters	1

Name	Type	Default
name	string	none

Security	RobloxScriptSecurity

History

530 Remove StudioService.GameNameUpdated
457 Add StudioService.GameNameUpdated

GamePublishFinished

Parameters	2

Name	Type	Default
success	bool	none
gameId	int64	none

Security	RobloxScriptSecurity

History

530 Remove StudioService.GamePublishFinished
426 Change Parameters of StudioService.GamePublishFinished from (bool success) to (bool success, int64 gameId)
402 Add StudioService.GamePublishFinished

GamePublishedToRoblox

Parameters	0

Name	Type	Default
No parameters.

Security	RobloxScriptSecurity

History

402 Remove StudioService.GamePublishedToRoblox
396 Add StudioService.GamePublishedToRoblox

GetInstalledPluginData

This function yields. It will block the calling thread until completion.

Parameters	0

Name	Type	Default
No parameters.

Return Type	string
Security	RobloxScriptSecurity

History

404 Remove StudioService.GetInstalledPluginData
399 Add StudioService.GetInstalledPluginData

Tags: [Yields]

GetUserIsInTeamCreateToggleRamp

Parameters	0

Name	Type	Default
No parameters.

Return Type	bool
Security	RobloxScriptSecurity

History

LaunchBulkImport

Parameters	1

Name	Type	Default
assetTypeToImport	int	none

Return Type	void
Security	RobloxScriptSecurity

History

424 Remove StudioService.LaunchBulkImport
419 Change ReturnType of StudioService.LaunchBulkImport from int to void
419 Change Tags of StudioService.LaunchBulkImport from [Yields] to []
417 Add StudioService.LaunchBulkImport

OnConvertToPackageResult

Parameters	2

Name	Type	Default
isSuccessful	bool	none
errorMessage	string	none

Security	RobloxScriptSecurity

History

520 Remove StudioService.OnConvertToPackageResult
402 Change Parameters of StudioService.OnConvertToPackageResult from (bool result) to (bool isSuccessful, string errorMessage)
401 Add StudioService.OnConvertToPackageResult

OnOpenConvertToPackagePlugin

Parameters	2

Name	Type	Default
instances	Objects	none
name	string	none

Security	RobloxScriptSecurity

History

520 Remove StudioService.OnOpenConvertToPackagePlugin
401 Change Parameters of StudioService.OnOpenConvertToPackagePlugin from () to (Objects instances, string name)
396 Add StudioService.OnOpenConvertToPackagePlugin

OnPublishPlaceToRoblox

Parameters	1

Name	Type	Default
isOverwritePublish	bool	none

Security	RobloxScriptSecurity

History

530 Remove StudioService.OnPublishPlaceToRoblox
441 Change Parameters of StudioService.OnPublishPlaceToRoblox from () to (bool isOverwritePublish)
393 Add StudioService.OnPublishPlaceToRoblox

OnSaveOrPublishPlaceToRoblox

Parameters	3

Name	Type	Default
showGameSelect	bool	none
isPublish	bool	none
closeMode	StudioCloseMode	none

Security	RobloxScriptSecurity

History

530 Remove StudioService.OnSaveOrPublishPlaceToRoblox
479 Change Parameters of StudioService.OnSaveOrPublishPlaceToRoblox from (bool showGameSelect, bool isPublish, bool closeAfterSave) to (bool showGameSelect, bool isPublish, StudioCloseMode closeMode)
475 Change Parameters of StudioService.OnSaveOrPublishPlaceToRoblox from (bool showGameSelect, bool isPublish) to (bool showGameSelect, bool isPublish, bool closeAfterSave)
471 Add StudioService.OnSaveOrPublishPlaceToRoblox

OpenPluginInsertPage

Parameters	1

Name	Type	Default
assetId	int64	none

Return Type	void
Security	RobloxScriptSecurity

History

458 Remove StudioService.OpenPluginInsertPage
364 Add StudioService.OpenPluginInsertPage

PlacePublishedToRoblox

Parameters	0

Name	Type	Default
No parameters.

Security	RobloxScriptSecurity

History

402 Remove StudioService.PlacePublishedToRoblox
400 Add StudioService.PlacePublishedToRoblox

PromptForLocalSave

Parameters	0

Name	Type	Default
No parameters.

Return Type	void
Security	RobloxScriptSecurity

History

505 Remove StudioService.PromptForLocalSave
477 Add StudioService.PromptForLocalSave

PromptImportLocalAsset

This function yields. It will block the calling thread until completion.

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Parameters	2

Name	Type	Default
prompt	string	none
fileTypeFilter	Array	{}

Return Type	Instance
Security	PluginSecurity

History

492 Remove StudioService.PromptImportLocalAsset
372 Change Tags of StudioService.PromptImportLocalAsset from [Yields] to [Yields, Deprecated]
369 Add StudioService.PromptImportLocalAsset

Tags: [Yields, Deprecated]

PromptImportLocalAssets

This function yields. It will block the calling thread until completion.

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Parameters	2

Name	Type	Default
prompt	string	none
fileTypeFilter	Array	{}

Return Type	Objects
Security	PluginSecurity

History

492 Remove StudioService.PromptImportLocalAssets
372 Change Tags of StudioService.PromptImportLocalAssets from [Yields] to [Yields, Deprecated]
369 Add StudioService.PromptImportLocalAssets

Tags: [Yields, Deprecated]

PublishAs

Parameters	3

Name	Type	Default
universeId	int64	none
placeId	int64	none
groupId	int64	none

Return Type	void
Security	RobloxScriptSecurity

History

530 Remove StudioService.PublishAs
423 Change Parameters of StudioService.PublishAs from (int64 universeId, int64 placeId) to (int64 universeId, int64 placeId, int64 groupId)
396 Add StudioService.PublishAs

RefreshDocumentDisplayName

Parameters	0

Name	Type	Default
No parameters.

Return Type	void
Security	RobloxScriptSecurity

History

RequestCloseStudio

Parameters	0

Name	Type	Default
No parameters.

Return Type	void
Security	RobloxScriptSecurity

History

479 Remove StudioService.RequestCloseStudio
475 Add StudioService.RequestCloseStudio

SerializeInstances

Parameters	1

Name	Type	Default
instances	Objects	none

Return Type	string
Security	RobloxScriptSecurity

History

524 Remove StudioService.SerializeInstances
390 Add StudioService.SerializeInstances

SetDocumentDisplayName

Parameters	1

Name	Type	Default
newName	string	none

Return Type	void
Security	RobloxScriptSecurity

History

505 Remove StudioService.SetDocumentDisplayName
436 Add StudioService.SetDocumentDisplayName

SetTurnOnTeamCreateOnPublish

Parameters	1

Name	Type	Default
turnOn	bool	none

Return Type	void
Security	RobloxScriptSecurity

History

SetUniverseDisplayName

Parameters	1

Name	Type	Default
newName	string	none

Return Type	void
Security	RobloxScriptSecurity

History

530 Remove StudioService.SetUniverseDisplayName
364 Add StudioService.SetUniverseDisplayName

ShowBulkImportView

Parameters	0

Name	Type	Default
No parameters.

Return Type	void
Security	RobloxScriptSecurity

History

424 Remove StudioService.ShowBulkImportView
418 Add StudioService.ShowBulkImportView

ShowSaveOrPublishPlaceToRoblox

Parameters	3

Name	Type	Default
showGameSelect	bool	none
isPublish	bool	none
closeMode	StudioCloseMode	none

Return Type	void
Security	RobloxScriptSecurity

History

530 Remove StudioService.ShowSaveOrPublishPlaceToRoblox
479 Change Parameters of StudioService.ShowSaveOrPublishPlaceToRoblox from (bool showGameSelect, bool isPublish, bool closeAfterSave) to (bool showGameSelect, bool isPublish, StudioCloseMode closeMode)
478 Add StudioService.ShowSaveOrPublishPlaceToRoblox

emitPlacePublishedSignal

Parameters	0

Name	Type	Default
No parameters.

Return Type	void
Security	RobloxScriptSecurity

History

402 Remove StudioService.emitPlacePublishedSignal
396 Add StudioService.emitPlacePublishedSignal

Relevant classes (1)

Instance

Relevant enums (1)

StudioCloseMode