ScreenshotHud
Show Deprecated
not creatable
not replicated
The ScreenshotHud is a 2D user interface that allows users to capture and save screenshots to their local device. It consists of the following UI elements:
- An overlay containing the experience name and Roblox branding. These remain on screen when a screenshot is taken, although the experience name can be disabled through the ScreenshotHud.ExperienceNameOverlayEnabled property.
- A camera button that hides all UI except for the overlay and takes a screenshot.
- A close button that closes the ScreenshotHud.
Code Samples
LocalScript
local GuiService = game:GetService("GuiService")
local screenshotHud = GuiService:WaitForChild("ScreenshotHud")
screenshotHud.ExperienceNameOverlayEnabled = true
screenshotHud.OverlayFont = Enum.Font.GothamMedium
screenshotHud.Visible = true
Summary
Properties
- read parallel
Asset ID of the icon used for the camera button.
- read parallel
Screen location of the camera button.
- read parallel
Screen location of the close button.
- read parallel
Whether the ScreenshotHud closes automatically when a screenshot is taken.
- read parallel
Whether the experience name in the overlay is enabled.
- read parallel
- read parallel
- read parallel
Font used for the experience name in the overlay.
- read parallel
Currently disabled with no effect.
Determines whether the ScreenshotHud is visible.
Properties
CloseWhenScreenshotTaken
read parallel
Determines whether the ScreenshotHud closes automatically when a screenshot is taken.
ExperienceNameOverlayEnabled
read parallel
Determines whether the experience name in the overlay is enabled.
HideCoreGuiForCaptures
read parallel
HidePlayerGuiForCaptures
read parallel