Skip to main content

ScreenshotHudModel

Functions​

SetCloseButtonVisible​

</>
ScreenshotHudModel:SetCloseButtonVisible(closeButtonVisible: boolean) → ()

Sets whether the close button is visible

ObserveCloseButtonVisible​

</>
ScreenshotHudModel:ObserveCloseButtonVisible() → Observable<boolean>

Observes close button visiblity

SetCameraButtonVisible​

</>
ScreenshotHudModel:SetCameraButtonVisible(cameraButtonVisible: boolean) → ()

Sets whether the camera button is visible

ObserveCameraButtonVisible​

</>
ScreenshotHudModel:ObserveCameraButtonVisible() → Observable<boolean>

Observes camera button visiblity

SetKeepOpen​

</>
ScreenshotHudModel:SetKeepOpen(keepOpen: boolean) → ()

Sets whether we should try to keep the UI open

GetKeepOpen​

</>
ScreenshotHudModel:GetKeepOpen() → boolean

Gets whether we should try to keep the UI open

SetVisible​

</>
ScreenshotHudModel:SetVisible(visible: boolean) → ()

Sets whether we are visible or not

SetCloseButtonPosition​

</>
ScreenshotHudModel:SetCloseButtonPosition(position: UDim2 | nil) → ()

Sets the close button's position

ObserveCloseButtonPosition​

</>
ScreenshotHudModel:ObserveCloseButtonPosition() → Observable<UDim2>

Observes the close button's position

SetCameraButtonPosition​

</>
ScreenshotHudModel:SetCameraButtonPosition(position: UDim2 | nil) → ()

Sets the camera button's position

ObserveCameraButtonPosition​

</>
ScreenshotHudModel:ObserveCameraButtonPosition() → Observable<UDim2>

Observes the camera button's position

SetOverlayFont​

</>
ScreenshotHudModel:SetOverlayFont(overlayFont: Font) → ()

Sets the overlay font

ObserveOverlayFont​

</>
ScreenshotHudModel:ObserveOverlayFont() → Observable<Font>

Observes the overlay font

SetCameraButtonIcon​

</>
ScreenshotHudModel:SetCameraButtonIcon(icon: string | nil) → ()

Sets the camera button's icon.

ObserveCameraButtonIcon​

</>
ScreenshotHudModel:ObserveCameraButtonIcon() → Observable<string>

Observes the camera button's icon

SetCloseWhenScreenshotTaken​

</>
ScreenshotHudModel:SetCloseWhenScreenshotTaken(closeWhenScreenshotTaken: boolean) → ()

Sets whether to close after a screenshot if taken

GetCloseWhenScreenshotTaken​

</>
ScreenshotHudModel:GetCloseWhenScreenshotTaken() → boolean

Returns whether the model will try to close if a screenshot is taken

ObserveCloseWhenScreenshotTaken​

</>
ScreenshotHudModel:ObserveCloseWhenScreenshotTaken() → Observable<boolean>

Observes whether a screenshot is taken

SetExperienceNameOverlayEnabled​

</>
ScreenshotHudModel:SetExperienceNameOverlayEnabled(experienceNameOverlayEnabled: boolean) → ()

Sets whether to experience name overlay should be enabled

ObserveExperienceNameOverlayEnabled​

</>
ScreenshotHudModel:ObserveExperienceNameOverlayEnabled() → Observable<boolean>

Observes whether the experience name overlay is enabled

SetUsernameOverlayEnabled​

</>
ScreenshotHudModel:SetUsernameOverlayEnabled(usernameOverlayEnabled: boolean) → ()

Sets whether to username overlay should be enabled

ObserveUsernameOverlayEnabled​

</>
ScreenshotHudModel:ObserveUsernameOverlayEnabled() → Observable<boolean>

Observes whether the username name overlay is enabled

ObserveVisible​

</>
ScreenshotHudModel:ObserveVisible() → Observable<boolean>

Observes whilet he model is visible

Show raw api
{
    "functions": [
        {
            "name": "SetCloseButtonVisible",
            "desc": "Sets whether the close button is visible",
            "params": [
                {
                    "name": "closeButtonVisible",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 51,
                "path": "src/screenshothudservice/src/Client/ScreenshotHudModel.lua"
            }
        },
        {
            "name": "ObserveCloseButtonVisible",
            "desc": "Observes close button visiblity",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<boolean>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 61,
                "path": "src/screenshothudservice/src/Client/ScreenshotHudModel.lua"
            }
        },
        {
            "name": "SetCameraButtonVisible",
            "desc": "Sets whether the camera button is visible",
            "params": [
                {
                    "name": "cameraButtonVisible",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 69,
                "path": "src/screenshothudservice/src/Client/ScreenshotHudModel.lua"
            }
        },
        {
            "name": "ObserveCameraButtonVisible",
            "desc": "Observes camera button visiblity",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<boolean>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 79,
                "path": "src/screenshothudservice/src/Client/ScreenshotHudModel.lua"
            }
        },
        {
            "name": "SetKeepOpen",
            "desc": "Sets whether we should try to keep the UI open",
            "params": [
                {
                    "name": "keepOpen",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 87,
                "path": "src/screenshothudservice/src/Client/ScreenshotHudModel.lua"
            }
        },
        {
            "name": "GetKeepOpen",
            "desc": "Gets whether we should try to keep the UI open",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 97,
                "path": "src/screenshothudservice/src/Client/ScreenshotHudModel.lua"
            }
        },
        {
            "name": "SetVisible",
            "desc": "Sets whether we are visible or not",
            "params": [
                {
                    "name": "visible",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 106,
                "path": "src/screenshothudservice/src/Client/ScreenshotHudModel.lua"
            }
        },
        {
            "name": "SetCloseButtonPosition",
            "desc": "Sets the close button's position",
            "params": [
                {
                    "name": "position",
                    "desc": "",
                    "lua_type": "UDim2 | nil"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 117,
                "path": "src/screenshothudservice/src/Client/ScreenshotHudModel.lua"
            }
        },
        {
            "name": "ObserveCloseButtonPosition",
            "desc": "Observes the close button's position",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<UDim2>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 127,
                "path": "src/screenshothudservice/src/Client/ScreenshotHudModel.lua"
            }
        },
        {
            "name": "SetCameraButtonPosition",
            "desc": "Sets the camera button's position",
            "params": [
                {
                    "name": "position",
                    "desc": "",
                    "lua_type": "UDim2 | nil"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 135,
                "path": "src/screenshothudservice/src/Client/ScreenshotHudModel.lua"
            }
        },
        {
            "name": "ObserveCameraButtonPosition",
            "desc": "Observes the camera button's position",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<UDim2>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 145,
                "path": "src/screenshothudservice/src/Client/ScreenshotHudModel.lua"
            }
        },
        {
            "name": "SetOverlayFont",
            "desc": "Sets the overlay font",
            "params": [
                {
                    "name": "overlayFont",
                    "desc": "",
                    "lua_type": "Font"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 153,
                "path": "src/screenshothudservice/src/Client/ScreenshotHudModel.lua"
            }
        },
        {
            "name": "ObserveOverlayFont",
            "desc": "Observes the overlay font",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<Font>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 163,
                "path": "src/screenshothudservice/src/Client/ScreenshotHudModel.lua"
            }
        },
        {
            "name": "SetCameraButtonIcon",
            "desc": "Sets the camera button's icon.",
            "params": [
                {
                    "name": "icon",
                    "desc": "",
                    "lua_type": "string | nil"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 172,
                "path": "src/screenshothudservice/src/Client/ScreenshotHudModel.lua"
            }
        },
        {
            "name": "ObserveCameraButtonIcon",
            "desc": "Observes the camera button's icon",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<string>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 183,
                "path": "src/screenshothudservice/src/Client/ScreenshotHudModel.lua"
            }
        },
        {
            "name": "SetCloseWhenScreenshotTaken",
            "desc": "Sets whether to close after a screenshot if taken",
            "params": [
                {
                    "name": "closeWhenScreenshotTaken",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 192,
                "path": "src/screenshothudservice/src/Client/ScreenshotHudModel.lua"
            }
        },
        {
            "name": "GetCloseWhenScreenshotTaken",
            "desc": "Returns whether the model will try to close if a screenshot is taken",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 202,
                "path": "src/screenshothudservice/src/Client/ScreenshotHudModel.lua"
            }
        },
        {
            "name": "ObserveCloseWhenScreenshotTaken",
            "desc": "Observes whether a screenshot is taken",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<boolean>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 210,
                "path": "src/screenshothudservice/src/Client/ScreenshotHudModel.lua"
            }
        },
        {
            "name": "SetExperienceNameOverlayEnabled",
            "desc": "Sets whether to experience name overlay should be enabled",
            "params": [
                {
                    "name": "experienceNameOverlayEnabled",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 218,
                "path": "src/screenshothudservice/src/Client/ScreenshotHudModel.lua"
            }
        },
        {
            "name": "ObserveExperienceNameOverlayEnabled",
            "desc": "Observes whether the experience name overlay is enabled",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<boolean>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 228,
                "path": "src/screenshothudservice/src/Client/ScreenshotHudModel.lua"
            }
        },
        {
            "name": "SetUsernameOverlayEnabled",
            "desc": "Sets whether to username overlay should be enabled",
            "params": [
                {
                    "name": "usernameOverlayEnabled",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 236,
                "path": "src/screenshothudservice/src/Client/ScreenshotHudModel.lua"
            }
        },
        {
            "name": "ObserveUsernameOverlayEnabled",
            "desc": "Observes whether the username name overlay is enabled",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<boolean>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 246,
                "path": "src/screenshothudservice/src/Client/ScreenshotHudModel.lua"
            }
        },
        {
            "name": "ObserveVisible",
            "desc": "Observes whilet he model is visible",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<boolean>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 254,
                "path": "src/screenshothudservice/src/Client/ScreenshotHudModel.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "ScreenshotHudModel",
    "desc": "",
    "source": {
        "line": 4,
        "path": "src/screenshothudservice/src/Client/ScreenshotHudModel.lua"
    }
}