Reference API Roblox

Engine API

Website

Related

Reference API Roblox

ScreenshotHud

A 2D user interface that allows users to capture and save screenshots to their local device.

This class is not replicated. Its interface does not cross the network boundary.
This class is not creatable. Instances of this class cannot be created with Instance.new.
Memory categoryInstances
Tags: [NotCreatable, NotReplicated]

Member index 11

HistoryMember
645CameraButtonIcon: ContentId
725CameraButtonIconContent: Content
553CameraButtonPosition: UDim2
553CloseButtonPosition: UDim2
553CloseWhenScreenshotTaken: bool
605HideCoreGuiForCaptures: bool
605HidePlayerGuiForCaptures: bool
553Visible: bool
inherited from Instance
553Archivable: bool
670Capabilities: SecurityCapabilities
723IsInSandbox: bool
553Name: string
553Parent: Instance
702PredictionMode: PredictionMode
670Sandboxed: bool
680UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
707GetDescendants(): Instances
486GetFullName(): string
706GetStyled(name: string, selector: string?): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
698QueryDescendants(selector: string): Instances
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

Description

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.

History 24

Members 11

CameraButtonIcon

TypeDefault
ContentId

Asset ID of the icon used for the camera button.

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 3

CameraButtonIconContent

TypeDefault
Content

The image Content used as the icon for the camera button on the ScreenshotHud. This is the Content-type equivalent of the legacy ScreenshotHud.CameraButtonIcon property and supports asset URIs. When set, the camera button displays the specified image instead of the default icon.

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 1

CameraButtonPosition

TypeDefault
UDim2

Screen location of the camera button.

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 2

CloseButtonPosition

TypeDefault
UDim2

Screen location of the close button.

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 2

CloseWhenScreenshotTaken

TypeDefault
bool

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

Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 2

HideCoreGuiForCaptures

TypeDefault
bool

Determines whether Roblox's core GUI is hidden while a screenshot is captured through the ScreenshotHud. Defaults to true, so any enabled CoreGuiType elements are hidden for the duration of the capture and restored afterward. A saved capture is only flagged as GUI-free when both this property and ScreenshotHud.HidePlayerGuiForCaptures are enabled.

Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 1

HidePlayerGuiForCaptures

TypeDefault
bool

Determines whether the local player's GUI is hidden while a screenshot is captured through the ScreenshotHud. Defaults to true, so any enabled ScreenGui instances under the Players.LocalPlayer's PlayerGui are hidden for the duration of the capture and restored afterward. A saved capture is only flagged as GUI-free when both this property and ScreenshotHud.HideCoreGuiForCaptures are enabled.

Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 1

Visible

TypeDefault
bool

Determines whether the ScreenshotHud is visible.

Thread safetyReadSafe
CategoryState
Loaded/Savedtrue

History 2

Settings