StudioCaptureService

Inherits from: Instance → Object

StudioCaptureService is a Studio-only service that lets plugins capture screenshots of the active place's 3D viewport. Use RequestScreenshotPermissionAsync() to obtain the user's permission, CanCaptureScreenshot() to check whether a capture is currently possible, and CaptureScreenshot() to request an image of the current view. All members require plugin security and are only available within Studio.

Inherits from: Instance

Memory category: Instances

Tags: NotCreatable, Service, NotReplicated

Methods

Name	Type / Returns	Description
StudioCaptureService:CanCaptureScreenshot	boolean	Returns whether a screenshot can currently be captured.
StudioCaptureService:CaptureScreenshot	StudioScreenshotCapture	Captures a screenshot of the active place according to the provided options.
StudioCaptureService:RequestScreenshotPermissionAsync	boolean	Requests the user's permission for the plugin to capture screenshots from the Studio 3D view.

Inherited from Instance

Name	Type / Returns	Description
Instance:AddTag	()	Applies a tag to the instance.
Instance:children	Instances	Returns an array of the object's children.
Instance:ClearAllChildren	()	This method destroys all of an instance's children.
Instance:Clone	Instance	Create a copy of an instance and all its descendants, ignoring instances that are not `Archivable`.
Instance:clone	Instance
Instance:Destroy	()	Sets the `Instance.Parent` property to `nil`, locks the `Instance.Parent` property, disconnects all connections, and calls `Destroy()` on all children.
Instance:destroy	()
Instance:FindFirstAncestor	Instance?	Returns the first ancestor of the `Instance` whose `Instance.Name` is equal to the given name.
Instance:FindFirstAncestorOfClass	Instance?	Returns the first ancestor of the `Instance` whose `Object.ClassName` is equal to the given className.
Instance:FindFirstAncestorWhichIsA	Instance?	Returns the first ancestor of the `Instance` for whom `Object:IsA()` returns true for the given className.
Instance:FindFirstChild	Instance?	Returns the first child of the `Instance` found with the given name.
Instance:findFirstChild	Instance
Instance:FindFirstChildOfClass	Instance?	Returns the first child of the `Instance` whose `ClassName` is equal to the given class name.
Instance:FindFirstChildWhichIsA	Instance?	Returns the first child of the `Instance` for whom `Object:IsA()` returns true for the given className.
Instance:FindFirstDescendant	Instance?	Returns the first descendant found with the given `Instance.Name`.
Instance:GetActor	Actor?	Returns the `Actor` associated with the Instance, if any.
Instance:GetAttribute	Variant	Returns the value which has been assigned to the given attribute name.
Instance:GetAttributeChangedSignal	RBXScriptSignal	Returns an event that fires when the given attribute changes.
Instance:GetAttributes	Dictionary	Returns a dictionary of the instance's attributes.
Instance:GetChildren	Instances	Returns an array containing all of the instance's children.
Instance:getChildren	Instances
Instance:GetDebugId	string	Returns a coded string of the debug ID used internally by Roblox.
Instance:GetDescendants	Instances	Returns an array containing all of the descendants of the instance.
Instance:GetFullName	string	Returns a string describing the instance's ancestry.
Instance:GetStyled	Variant	Returns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified.
Instance:GetStyledPropertyChangedSignal	RBXScriptSignal	Returns an event that fires when the given style property changes on the instance.
Instance:GetTags	Array	Gets an array of all tags applied to the instance.
Instance:HasTag	boolean	Check whether the instance has a given tag.
Instance:IsAncestorOf	boolean	Returns true if an `Instance` is an ancestor of the given descendant.
Instance:IsDescendantOf	boolean	Returns `true` if an `Instance` is a descendant of the given ancestor.
Instance:isDescendantOf	boolean
Instance:IsPropertyModified	boolean	Returns `true` if the value stored in the specified property is not equal to the code-instantiated default.
Instance:QueryDescendants	Instances	Returns an array containing all descendants of the instance that match the `selector` string.
Instance:Remove	()	Sets the object's `Parent` to `nil`, and does the same for all its descendants.
Instance:remove	()
Instance:RemoveTag	()	Removes a tag from the instance.
Instance:ResetPropertyToDefault	()	Resets a property to its default value.
Instance:SetAttribute	()	Sets the attribute with the given name to the given value.
Instance:WaitForChild	Instance	Returns the child of the `Instance` with the given name. If the child does not exist, it will yield the current thread until it does.

Inherited from Object

Name	Type / Returns	Description
Object:GetPropertyChangedSignal	RBXScriptSignal	Get an event that fires when a given property of the object changes.
Object:IsA	boolean	Returns true if an object's class matches or inherits from a given class.
Object:isA	boolean

StudioCaptureService:CanCaptureScreenshot

Returns false when there is a known reason a screenshot cannot be captured — for example, when this is not the active DataModel or the plugin does not have permission — and true otherwise. A return value of true does not guarantee that CaptureScreenshot() will succeed, because conditions can change between the two calls.

Returns

Type	Description
boolean	A boolean that is `false` when a screenshot is known to be uncapturable, or `true` otherwise.

Field	Value
security	PluginSecurity
thread safety	Unsafe

StudioCaptureService:CaptureScreenshot

Captures a screenshot of the active DataModel according to screenshotOptions and returns a StudioScreenshotCapture in the requested format. If an image of the requested size cannot be captured at the requested position, the capture fails rather than clipping the image.

The screenshotOptions dictionary accepts the following keys:

Position — a Vector2 top-left offset of the captured region. Must be non-negative and defaults to (0, 0).
CaptureSize — a Vector2 size of the region to capture. Both components must be positive.
OutputSize — a Vector2 size of the returned image. Both components must be positive; when it differs from CaptureSize, ResampleMode must also be provided.
ResampleMode — the resampling filter used when OutputSize differs from CaptureSize.
Format — an StudioCaptureScreenshotFormat for the returned buffer. Defaults to StudioCaptureScreenshotFormat.RGBA8.
UICaptureMode — an UICaptureMode controlling whether UI is included in the capture. Defaults to UICaptureMode.All.

The returned StudioScreenshotCapture is populated asynchronously: its image buffer becomes available only after the capture and encoding complete, and any errors are reported on the capture object.

Parameters

Name	Type	Default	Description
screenshotOptions	Dictionary		A dictionary of options controlling the capture, such as `Position`, `CaptureSize`, `OutputSize`, `ResampleMode`, `Format`, and `UICaptureMode`.

Returns

Type	Description
StudioScreenshotCapture	A `StudioScreenshotCapture` that holds the requested image in the requested format.

Field	Value
security	PluginSecurity
thread safety	Unsafe

StudioCaptureService:RequestScreenshotPermissionAsync

This yielding function asks the user to grant the plugin permission to capture screenshots from their Studio 3D view, returning true if permission is granted and false otherwise. It can return immediately without prompting when the plugin's permission is already known from an earlier session, and it returns false without prompting when the global screenshot setting is disabled.

Returns

Type	Description
boolean	A boolean that is `true` if the user granted permission and `false` otherwise.

Field	Value
tags	["Yields"]
security	PluginSecurity
thread safety	Unsafe

Properties

Inherited from Instance

Name	Type / Returns	Description
Instance.Archivable	boolean	Determines if an `Instance` and its descendants can be cloned using `Instance:Clone()`, and can be saved/published.
Instance.archivable	boolean
Instance.Capabilities	SecurityCapabilities	The set of capabilities allowed to be used for scripts inside this container.
Instance.IsInSandbox	boolean	Indicates whether the instance is inside a sandboxed container.
Instance.Name	string	A non-unique identifier of the `Instance`.
Instance.Parent	Instance	Determines the hierarchical parent of the `Instance`.
Instance.PredictionMode	PredictionMode	Reflects the client-side prediction mode applied to the instance under server-authoritative physics.
Instance.RobloxLocked	boolean	A deprecated property that used to protect `CoreGui` objects.
Instance.Sandboxed	boolean	When enabled, the instance can only access abilities in its `Capabilities` list.
Instance.UniqueId	UniqueId	A unique identifier for the instance.

Inherited from Object

Name	Type / Returns	Description
Object.ClassName	string	A read-only string representing the class this `Object` belongs to.
Object.className	string

Events

Inherited from Instance

Name	Type / Returns	Description
Instance.AncestryChanged		Fires when the `Instance.Parent` property of this object or one of its ancestors is changed.
Instance.AttributeChanged		Fires whenever an attribute is changed on the `Instance`.
Instance.ChildAdded		Fires after an object is parented to this `Instance`.
Instance.childAdded
Instance.ChildRemoved		Fires after a child is removed from this `Instance`.
Instance.DescendantAdded		Fires after a descendant is added to the `Instance`.
Instance.DescendantRemoving		Fires immediately before a descendant of the `Instance` is removed.
Instance.Destroying		Fires immediately before (or is deferred until after) the instance is destroyed via `Instance:Destroy()`.
Instance.StyledPropertiesChanged		Fires whenever any style property is changed on the instance, including when a property is set to `nil`.

Inherited from Object

Name	Type / Returns	Description
Object.Changed		Fires immediately after a property of the object changes, with some limitations.