ScreenshotHud¶
Not yet Class NotCreatable NotReplicated
A 2D user interface that allows users to capture and save screenshots to their local device.
Not implemented yet
This class exists in the current Roblox API but is not implemented in Nova yet. Scripts that reference it will fail at runtime.
0 Nova members · 14 modern Roblox members not implemented yet
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.
Inheritance¶
Object → Instance → ScreenshotHud
Properties¶
| Member | Signature | Summary |
|---|---|---|
CameraButtonIcon |
CameraButtonIcon: ContentId |
Asset ID of the icon used for the camera button. |
CameraButtonIconContent |
CameraButtonIconContent: Content |
The image content used as the icon for the camera button. |
CameraButtonPosition |
CameraButtonPosition: UDim2 |
Screen location of the camera button. |
CloseButtonPosition |
CloseButtonPosition: UDim2 |
Screen location of the close button. |
CloseWhenScreenshotTaken |
CloseWhenScreenshotTaken: bool |
Whether the ScreenshotHud closes automatically when a screenshot is taken. |
ExperienceNameOverlayEnabled |
ExperienceNameOverlayEnabled: bool |
Whether the experience name in the overlay is enabled. |
HideCoreGuiForCaptures |
HideCoreGuiForCaptures: bool |
Whether Roblox's core GUI is hidden while a screenshot is captured. |
HidePlayerGuiForCaptures |
HidePlayerGuiForCaptures: bool |
Whether the local player's GUI is hidden while a screenshot is captured. |
OverlayFont |
OverlayFont: Font |
Font used for the experience name in the overlay. |
UsernameOverlayEnabled |
UsernameOverlayEnabled: bool |
Has no effect. |
Visible |
Visible: bool |
Determines whether the ScreenshotHud is visible. |
Roblox reference: ScreenshotHud
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.