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.
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.
Types of User Thumbnails
|Upper chest and head|
|Just the head and face|
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
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
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)