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

1local GuiService = game:GetService("GuiService")
2
3local screenshotHud = GuiService:WaitForChild("ScreenshotHud")
4screenshotHud.ExperienceNameOverlayEnabled = true
5screenshotHud.OverlayFont = Enum.Font.GothamMedium
6screenshotHud.Visible = true

Summary

Properties

Asset ID of the icon used for the camera button.

Screen location of the camera button.

Screen location of the close button.

Whether the ScreenshotHud closes automatically when a screenshot is taken.

Whether the experience name in the overlay is enabled.

Font used for the experience name in the overlay.

Currently disabled with no effect.

Determines whether the ScreenshotHud is visible.

Events

Methods

Properties

CameraButtonIcon

Asset ID of the icon used for the camera button.

CameraButtonPosition

Screen location of the camera button.

CloseButtonPosition

Screen location of the close button.

CloseWhenScreenshotTaken

Determines whether the ScreenshotHud closes automatically when a screenshot is taken.

ExperienceNameOverlayEnabled

Determines whether the experience name in the overlay is enabled.

OverlayFont

The Font used for the experience name in the overlay.

UsernameOverlayEnabled

Currently disabled with no effect.

Visible

Determines whether the ScreenshotHud is visible.

Events

Methods