Skip to main content

ScreenshotHudModel

Functions​

SetCloseButtonVisible​

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

Sets whether the close button is visible

ObserveCloseButtonVisible​

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

Observes close button visiblity

SetCameraButtonVisible​

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

Sets whether the camera button is visible

ObserveCameraButtonVisible​

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

Observes camera button visiblity

SetKeepOpen​

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

Sets whether we should try to keep the UI open

GetKeepOpen​

</>
ScreenshotHudModel.GetKeepOpen(self: ScreenshotHudModel) → 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(self: ScreenshotHudModel) → Observable<UDim2>

Observes the close button's position

SetCameraButtonPosition​

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

Sets the camera button's position

ObserveCameraButtonPosition​

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

Observes the camera button's position

SetOverlayFont​

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

Sets the overlay font

ObserveOverlayFont​

</>
ScreenshotHudModel.ObserveOverlayFont(self: ScreenshotHudModel) → Observable<Enum.Font>

Observes the overlay font

SetCameraButtonIcon​

</>
ScreenshotHudModel.SetCameraButtonIcon(
icon: string?
) → ()

Sets the camera button's icon.

ObserveCameraButtonIcon​

</>
ScreenshotHudModel.ObserveCameraButtonIcon(self: ScreenshotHudModel) → 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(self: ScreenshotHudModel) → boolean

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

ObserveCloseWhenScreenshotTaken​

</>
ScreenshotHudModel.ObserveCloseWhenScreenshotTaken(self: ScreenshotHudModel) → 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(self: ScreenshotHudModel) → 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(self: ScreenshotHudModel) → Observable<boolean>

Observes whether the username name overlay is enabled

ObserveVisible​

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

Observes whilet he model is visible

Show raw api
{
    "functions": [
        {
            "name": "SetCloseButtonVisible",
            "desc": "Sets whether the close button is visible",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "ScreenshotHudModel"
                },
                {
                    "name": "closeButtonVisible",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 63,
                "path": "src/screenshothudservice/src/Client/ScreenshotHudModel.lua"
            }
        },
        {
            "name": "ObserveCloseButtonVisible",
            "desc": "Observes close button visiblity",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "ScreenshotHudModel"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<boolean>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 73,
                "path": "src/screenshothudservice/src/Client/ScreenshotHudModel.lua"
            }
        },
        {
            "name": "SetCameraButtonVisible",
            "desc": "Sets whether the camera button is visible",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "ScreenshotHudModel"
                },
                {
                    "name": "cameraButtonVisible",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 81,
                "path": "src/screenshothudservice/src/Client/ScreenshotHudModel.lua"
            }
        },
        {
            "name": "ObserveCameraButtonVisible",
            "desc": "Observes camera button visiblity",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "ScreenshotHudModel"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<boolean>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 91,
                "path": "src/screenshothudservice/src/Client/ScreenshotHudModel.lua"
            }
        },
        {
            "name": "SetKeepOpen",
            "desc": "Sets whether we should try to keep the UI open",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "ScreenshotHudModel"
                },
                {
                    "name": "keepOpen",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 99,
                "path": "src/screenshothudservice/src/Client/ScreenshotHudModel.lua"
            }
        },
        {
            "name": "GetKeepOpen",
            "desc": "Gets whether we should try to keep the UI open",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "ScreenshotHudModel"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 109,
                "path": "src/screenshothudservice/src/Client/ScreenshotHudModel.lua"
            }
        },
        {
            "name": "SetVisible",
            "desc": "Sets whether we are visible or not",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "ScreenshotHudModel"
                },
                {
                    "name": "visible",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 118,
                "path": "src/screenshothudservice/src/Client/ScreenshotHudModel.lua"
            }
        },
        {
            "name": "SetCloseButtonPosition",
            "desc": "Sets the close button's position",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "ScreenshotHudModel"
                },
                {
                    "name": "position",
                    "desc": "",
                    "lua_type": "UDim2 | nil"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 128,
                "path": "src/screenshothudservice/src/Client/ScreenshotHudModel.lua"
            }
        },
        {
            "name": "ObserveCloseButtonPosition",
            "desc": "Observes the close button's position",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "ScreenshotHudModel"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<UDim2>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 138,
                "path": "src/screenshothudservice/src/Client/ScreenshotHudModel.lua"
            }
        },
        {
            "name": "SetCameraButtonPosition",
            "desc": "Sets the camera button's position",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "ScreenshotHudModel"
                },
                {
                    "name": "position",
                    "desc": "",
                    "lua_type": "UDim2 | nil"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 146,
                "path": "src/screenshothudservice/src/Client/ScreenshotHudModel.lua"
            }
        },
        {
            "name": "ObserveCameraButtonPosition",
            "desc": "Observes the camera button's position",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "ScreenshotHudModel"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<UDim2>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 156,
                "path": "src/screenshothudservice/src/Client/ScreenshotHudModel.lua"
            }
        },
        {
            "name": "SetOverlayFont",
            "desc": "Sets the overlay font",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "ScreenshotHudModel"
                },
                {
                    "name": "overlayFont",
                    "desc": "",
                    "lua_type": "Enum.Font"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 164,
                "path": "src/screenshothudservice/src/Client/ScreenshotHudModel.lua"
            }
        },
        {
            "name": "ObserveOverlayFont",
            "desc": "Observes the overlay font",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "ScreenshotHudModel"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<Enum.Font>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 174,
                "path": "src/screenshothudservice/src/Client/ScreenshotHudModel.lua"
            }
        },
        {
            "name": "SetCameraButtonIcon",
            "desc": "Sets the camera button's icon.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "ScreenshotHudModel"
                },
                {
                    "name": "icon",
                    "desc": "",
                    "lua_type": "string?"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 183,
                "path": "src/screenshothudservice/src/Client/ScreenshotHudModel.lua"
            }
        },
        {
            "name": "ObserveCameraButtonIcon",
            "desc": "Observes the camera button's icon",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "ScreenshotHudModel"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<string>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 194,
                "path": "src/screenshothudservice/src/Client/ScreenshotHudModel.lua"
            }
        },
        {
            "name": "SetCloseWhenScreenshotTaken",
            "desc": "Sets whether to close after a screenshot if taken",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "ScreenshotHudModel"
                },
                {
                    "name": "closeWhenScreenshotTaken",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 203,
                "path": "src/screenshothudservice/src/Client/ScreenshotHudModel.lua"
            }
        },
        {
            "name": "GetCloseWhenScreenshotTaken",
            "desc": "Returns whether the model will try to close if a screenshot is taken",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "ScreenshotHudModel"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 213,
                "path": "src/screenshothudservice/src/Client/ScreenshotHudModel.lua"
            }
        },
        {
            "name": "ObserveCloseWhenScreenshotTaken",
            "desc": "Observes whether a screenshot is taken",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "ScreenshotHudModel"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<boolean>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 221,
                "path": "src/screenshothudservice/src/Client/ScreenshotHudModel.lua"
            }
        },
        {
            "name": "SetExperienceNameOverlayEnabled",
            "desc": "Sets whether to experience name overlay should be enabled",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "ScreenshotHudModel"
                },
                {
                    "name": "experienceNameOverlayEnabled",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 229,
                "path": "src/screenshothudservice/src/Client/ScreenshotHudModel.lua"
            }
        },
        {
            "name": "ObserveExperienceNameOverlayEnabled",
            "desc": "Observes whether the experience name overlay is enabled",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "ScreenshotHudModel\n"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<boolean>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 242,
                "path": "src/screenshothudservice/src/Client/ScreenshotHudModel.lua"
            }
        },
        {
            "name": "SetUsernameOverlayEnabled",
            "desc": "Sets whether to username overlay should be enabled",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "ScreenshotHudModel"
                },
                {
                    "name": "usernameOverlayEnabled",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 252,
                "path": "src/screenshothudservice/src/Client/ScreenshotHudModel.lua"
            }
        },
        {
            "name": "ObserveUsernameOverlayEnabled",
            "desc": "Observes whether the username name overlay is enabled",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "ScreenshotHudModel"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<boolean>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 262,
                "path": "src/screenshothudservice/src/Client/ScreenshotHudModel.lua"
            }
        },
        {
            "name": "ObserveVisible",
            "desc": "Observes whilet he model is visible",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "ScreenshotHudModel"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<boolean>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 270,
                "path": "src/screenshothudservice/src/Client/ScreenshotHudModel.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "ScreenshotHudModel",
    "desc": "",
    "source": {
        "line": 5,
        "path": "src/screenshothudservice/src/Client/ScreenshotHudModel.lua"
    }
}