This event fires right before a new screenshot capture is taken. It can be used to customize the capture experience, for example by hiding certain GUI elements.

This event fires after a new screenshot capture completes. It can be used to restore any changes made when the CaptureBegan event fired.

This method captures a screenshot for the user but does not immediately save it to their Captures gallery within the experience's main menu. Instead, a temporary contentId is created to identify the new capture.

The onCaptureReady callback can be used to prompt the user to save or share the screenshot:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

local CaptureService = game:GetService("CaptureService")

-- Reference to an ImageLabel parent of the script containing this code
local imageLabel = script.Parent

local function onCaptureReady(contentId)
	imageLabel.Image = contentId
end

CaptureService:CaptureScreenshot(onCaptureReady)

This method prompts the user to save the screenshots identified by the provided contentIds to their Captures gallery within the experience's main menu.

This method prompts the user to share the screenshot identified by the provided contentId using the native share sheet on their device.

The capture image is shared along with an invite link to the experience when supported. Not all devices support including both a screenshot and invite link.

The launchData will be available in the launchData field for users who join through the invite link.

To avoid an error when calling this method, first call PolicyService:GetPolicyInfoForPlayerAsync() and check that IsContentSharingAllowed is true in the returned dictionary.

This event fires when the user saves a screenshot using the Roblox screenshot capture UI. It can be used for analytics or to prompt the user to share their capture.