Skip to main content

PlayerThumbnailUtils

Reimplementation of Player:GetUserThumbnailAsync but as a promise with retry logic.

Functions​

promiseUserThumbnail​

</>
PlayerThumbnailUtils.promiseUserThumbnail(
userId: number,
thumbnailType: ThumbnailType?,
thumbnailSize: ThumbnailSize?
) → Promise<string>

Promises a user thumbnail with retry enabled.

PlayerThumbnailUtils.promiseUserThumbnail(4397833):Then(function(image)
	imageLabel.Image = image
end)

promiseUserName​

</>
PlayerThumbnailUtils.promiseUserName(userId: number) → Promise<string>

Promises a player userName with retries enabled.

See UserServiceUtils for display name and a more up-to-date API.

Show raw api
{
    "functions": [
        {
            "name": "promiseUserThumbnail",
            "desc": "Promises a user thumbnail with retry enabled.\n\n```lua\nPlayerThumbnailUtils.promiseUserThumbnail(4397833):Then(function(image)\n\timageLabel.Image = image\nend)\n```",
            "params": [
                {
                    "name": "userId",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "thumbnailType",
                    "desc": "",
                    "lua_type": "ThumbnailType?"
                },
                {
                    "name": "thumbnailSize",
                    "desc": "",
                    "lua_type": "ThumbnailSize?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<string>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 31,
                "path": "src/playerthumbnailutils/src/Shared/PlayerThumbnailUtils.lua"
            }
        },
        {
            "name": "promiseUserName",
            "desc": "Promises a player userName with retries enabled.\n\nSee UserServiceUtils for display name and a more up-to-date API.",
            "params": [
                {
                    "name": "userId",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<string>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 71,
                "path": "src/playerthumbnailutils/src/Shared/PlayerThumbnailUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "PlayerThumbnailUtils",
    "desc": "Reimplementation of Player:GetUserThumbnailAsync but as a promise with\nretry logic.",
    "source": {
        "line": 7,
        "path": "src/playerthumbnailutils/src/Shared/PlayerThumbnailUtils.lua"
    }
}