GetUserIdFromNameAsync

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 will send a query to the Roblox website asking what the Player/UserId is of the account with the given Player name.

This method errors if no account exists with the given username. If you aren’t certain such an account exists, it’s recommended to wrap calls to this function with pcall. In addition, you can manually cache results to quickly make future calls with the same username. See the code samples to learn how to do this.

Parameters

Name	Type	Default	Description
Name userName	Type string	Default	Summary The username of the player being specified

Returns

Return Type	Summary
Return Type int64	Summary The `Player/UserId` of a user whose name is specified

Code Samples

Fast User ID Lookup

This code sample demonstrates memoization (not memorization!) of the Players/GetUserIdFromNameAsync method. It uses a table to cache the results of the function. It also uses pcall in case the username doesn’t exist.

			
				Fast User ID Lookup

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

-- Memoization: since these results are rarely (if ever) going to change
-- all we have to do is check a cache table for the name.
-- If we find the name, then we have no work to do! Just return the user id (fast).
-- If we don't find the name (cache miss), go look it up (takes time).
local cache = {}
function getUserIdFromUsername(name)
	-- First, check if the cache contains the name
	if cache[name] then return cache[name] end
	-- Second, check if the user is already connected to the server
	local player = Players:FindFirstChild(name)
	if player then
		cache[name] = player.UserId
		return player.UserId
	end 
	-- If all else fails, send a request
	local id
	pcall(function ()
		id = Players:GetUserIdFromNameAsync(name)
	end)
	cache[name] = id
	return id
end

print(getUserIdFromUsername("Ozzypig")) --> 269323
print(getUserIdFromUsername("Ozzypig")) --> 269323, but this one returns much quicker
print(getUserIdFromUsername("Shedletsky")) --> 261
		
				Copy Code
			
				Light Theme

GetUserIdFromNameAsync

Parameters

userName

Returns

int64

Code Samples

Fast User ID Lookup