GetUserThumbnailAsync

Yields

This is a yielding function. When called, it will pause the Lua thread that called the function until a result is ready to be returned, without interrupting other scripts.

Unsafe

For thread safety, this property is not safe to read in an unsynchronized thread.

Function of:

Players

Description:

This function fetches a Articles/Content|content URL of an image of a player’s avatar given their Player/UserId|UserId, the image size (as an enum) and type (also an enum: avatar, bust, headshot). It also returns a bool describing if the image is ready to be used.

Most often, this method is used with ImageLabel/Image to display player pictures next to their username in-game. It is also appropriate for Decal/Texture as well.

Available Sizes

Enum.ThumbnailSize: Size48x48, Size60x60, Size100x100, Size150x150, Size180x180, Size353x353, Size420x420

Types of User Thumbnails

Enum.ThumbnailType	Description	Example (60px)
`AvatarBust`	Upper chest and head
`AvatarThumbnail`	Entire avatar
`HeadShot`	Just the head and face

Parameters

Name	Type	Default	Description
Name userId	Type int64	Default	Summary The `Player/UserId` of the player being specified
Name thumbnailType	Type ThumbnailType	Default	Summary A `Enum/ThumbnailType` describing the type of thumbnail
Name thumbnailSize	Type ThumbnailSize	Default	Summary A `Enum/ThumbnailSize` specifying the size of the thumbnail

Returns

Return Type	Summary
Return Type Tuple	Summary A tuple containing the content URL of a user thumbnail based on the specified parameters, and a bool describing if the image is ready to be used or not

Code Samples

Display Player Thumbnail

This code sample displays the current player’s thumbnail in a parent ImageLabel by using Players/GetUserThumbnailAsync and setting the ImageLabel/Image|Image property as well as its GuiObject/Size|Size.

			
				Display Player Thumbnail

				Expected Output
			
				Expand
				
			local Players = game:GetService("Players")

local player = Players.LocalPlayer

-- Fetch the thumbnail
local userId = player.UserId
local thumbType = Enum.ThumbnailType.HeadShot
local thumbSize = Enum.ThumbnailSize.Size420x420
local content, isReady = Players:GetUserThumbnailAsync(userId, thumbType, thumbSize)

-- Set the ImageLabel's content to the user thumbnail
local imageLabel = script.Parent
imageLabel.Image = content
imageLabel.Size = UDim2.new(0, 420, 0, 420)
		
			When run, the parent `ImageLabel` should have its `ImageLabel/Image|Image` and `GuiObject/Size|Size` set accordingly.
		
				Copy Code
			
				Light Theme

GetUserThumbnailAsync

Available Sizes

Types of User Thumbnails

Parameters

userId

thumbnailType

thumbnailSize

Returns

Tuple

Code Samples

Display Player Thumbnail