rojo/.cursor/rules/roblox/reference/engine/classes/ScreenshotHud.yaml

# This file is automatically generated. Please don't edit it manually.
# To submit a bug report on the content, see
# https://devforum.roblox.com/c/bug-reports/documentation-issues/72

name: ScreenshotHud
type: class
memory_category: Instances
summary: |
  A 2D user interface that allows users to capture and save screenshots to their
  local device.
description: |
  The `Class.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 `Class.ScreenshotHud.ExperienceNameOverlayEnabled`
    property.
  - A camera button that hides all UI except for the overlay and takes a
    screenshot.
  - A close button that closes the `Class.ScreenshotHud`.

  <img src="../../../assets/engine-api/classes/ScreenshotHud/Diagram.jpg" width="100%" />
code_samples:
  - ScreenshotHud
inherits:
  - Instance
descendants: []
tags:
  - NotCreatable
  - NotReplicated
deprecation_message: ''
properties:
  - name: ScreenshotHud.CameraButtonIcon
    summary: |
      Asset ID of the icon used for the camera button.
    description: |
      Asset ID of the icon used for the camera button.
    code_samples: []
    type: ContentId
    tags: []
    deprecation_message: ''
    security:
      read: None
      write: None
    thread_safety: ReadSafe
    category: Appearance
    serialization:
      can_load: true
      can_save: true
    capabilities:
      - UI
  - name: ScreenshotHud.CameraButtonPosition
    summary: |
      Screen location of the camera button.
    description: |
      Screen location of the camera button.
    code_samples: []
    type: UDim2
    tags: []
    deprecation_message: ''
    security:
      read: None
      write: None
    thread_safety: ReadSafe
    category: Appearance
    serialization:
      can_load: true
      can_save: true
    capabilities:
      - UI
  - name: ScreenshotHud.CloseButtonPosition
    summary: |
      Screen location of the close button.
    description: |
      Screen location of the close button.
    code_samples: []
    type: UDim2
    tags: []
    deprecation_message: ''
    security:
      read: None
      write: None
    thread_safety: ReadSafe
    category: Appearance
    serialization:
      can_load: true
      can_save: true
    capabilities:
      - UI
  - name: ScreenshotHud.CloseWhenScreenshotTaken
    summary: |
      Whether the `Class.ScreenshotHud` closes automatically when a screenshot
      is taken.
    description: |
      Determines whether the `Class.ScreenshotHud` closes automatically when a
      screenshot is taken.
    code_samples: []
    type: boolean
    tags: []
    deprecation_message: ''
    security:
      read: None
      write: None
    thread_safety: ReadSafe
    category: Data
    serialization:
      can_load: true
      can_save: true
    capabilities:
      - UI
  - name: ScreenshotHud.ExperienceNameOverlayEnabled
    summary: |
      Whether the experience name in the overlay is enabled.
    description: |
      Determines whether the experience name in the overlay is enabled.
    code_samples: []
    type: boolean
    tags:
      - Hidden
      - Deprecated
    deprecation_message: ''
    security:
      read: None
      write: None
    thread_safety: ReadSafe
    category: Appearance
    serialization:
      can_load: true
      can_save: true
    capabilities:
      - UI
  - name: ScreenshotHud.HideCoreGuiForCaptures
    summary: ''
    description: ''
    code_samples: []
    type: boolean
    tags: []
    deprecation_message: ''
    security:
      read: None
      write: None
    thread_safety: ReadSafe
    category: Data
    serialization:
      can_load: true
      can_save: true
    capabilities:
      - UI
  - name: ScreenshotHud.HidePlayerGuiForCaptures
    summary: ''
    description: ''
    code_samples: []
    type: boolean
    tags: []
    deprecation_message: ''
    security:
      read: None
      write: None
    thread_safety: ReadSafe
    category: Data
    serialization:
      can_load: true
      can_save: true
    capabilities:
      - UI
  - name: ScreenshotHud.OverlayFont
    summary: |
      `Datatype.Font` used for the experience name in the overlay.
    description: |
      The `Datatype.Font` used for the experience name in the overlay.
    code_samples: []
    type: Enum.Font
    tags:
      - Hidden
      - Deprecated
    deprecation_message: ''
    security:
      read: None
      write: None
    thread_safety: ReadSafe
    category: Appearance
    serialization:
      can_load: true
      can_save: true
    capabilities:
      - UI
  - name: ScreenshotHud.UsernameOverlayEnabled
    summary: |
      Currently disabled with no effect.
    description: |
      Currently disabled with no effect.
    code_samples: []
    type: boolean
    tags:
      - Hidden
      - Deprecated
    deprecation_message: ''
    security:
      read: None
      write: None
    thread_safety: ReadSafe
    category: Appearance
    serialization:
      can_load: true
      can_save: true
    capabilities:
      - UI
  - name: ScreenshotHud.Visible
    summary: |
      Determines whether the `Class.ScreenshotHud` is visible.
    description: |
      Determines whether the `Class.ScreenshotHud` is visible.
    code_samples: []
    type: boolean
    tags: []
    deprecation_message: ''
    security:
      read: None
      write: None
    thread_safety: ReadSafe
    category: State
    serialization:
      can_load: true
      can_save: true
    capabilities:
      - UI
methods: []
events: []
callbacks: []