PlayerService

Getting it

local PlayerService = Engine:GetService("PlayerService")

Overview

Information about a player is spread across a dozen Roblox services, many of them slow web calls that fail now and then. PlayerService puts it behind one API:

• Identity: user ids, usernames, display names, formatted name tags with Roblox's verified, Premium and Plus marks, developer and video-star roles.
• Client info: device class, platform, input methods, screen size and safe area, graphics, audio, camera and accessibility settings, locale, FPS and ping. Each client measures this itself and sends it to the server.
• Session and policy: join data, session time, country, and Roblox's PolicyService rules (ads, paid random items, trading...).
• Character and gameplay: health, movement, seat, team, camera settings.
• Avatar and social: thumbnails, worn items, friends, groups, badges, game passes, subscriptions.

Web lookups are cached (per kind, see configuration) and retried with backoff. Methods ending in Async return a Promise; the synchronous versions answer from what is already known and return nil when it is not.

Anywhere a method takes a target, you can pass a Player or a user id.

local PlayerService = Engine:GetService("PlayerService")

PlayerService.PlayerReady:Connect(function(player, info)
	print(PlayerService:FormatName(player), "joined on", info.Platform.DeviceClass)

	if PlayerService:IsOnMobile(player) then
		giveMobileControls(player)
	end

	if not PlayerService:IsAllowed(player, "PaidRandomItems") then
		hideLootBoxes(player)
	end
end)

Events

Identity

local tag = PlayerService:GetNameTag(player)
nameLabel.Text = tag.Text -- e.g. "Builderman (@builderman) " plus Roblox's marks

Badge glyphs come from Roblox's own private-use characters. Engine checks at startup whether the font can draw them (ProbeGlyphs) and falls back to text such as (verified) when it cannot.

Device and client

These need the client info the player's client sends. The first report arrives about a second after joining (PlayerReady); until then they return nil.

Roblox does not let scripts ask which platform a player is on, so device detection works it out from the client build, the screen and input signals; GetDetectionSignals lists what it used. Accessibility settings such as ReducedMotion and PreferredTransparency let you respect what players chose.

Session and policy

Policy names (also in PlayerService.Policies): "Ads", "PaidRandomItems", "ContentSharing", "CommerceProducts", "Subscriptions", "PaidItemTrading", "PhotoToAvatar", "EndlessContentLoad", "EndlessContentAutoplay".

Character and gameplay

Avatar

Friends, groups and ownership

A user can hold several roles in one group. GetGroupRankAsync and GetGroupRoleAsync only tell you about the highest one, so check for a specific role, such as your moderators, with HasGroupRoleAsync or GetGroupRolesAsync.

Profiles

GetProfileAsync

PlayerService:GetProfileAsync(target, config: { Sections?, ThumbnailTypes?, ThumbnailSize?, Force? }?): Promise<Profile>

Collects many of the above in one call: sections Identity, Session, Client, Character, Gameplay, Avatar and Social (default from configuration). Sections that fail are listed in Errors instead of failing the whole profile, and the result is cached; Force rebuilds it, :InvalidateProfile(target) forgets it. Ideal for a player card or an admin panel.

Properties

Privacy

Client info is collected by your game's client and sent to your game server only. Engine does not send it anywhere else. Turn it off with TelemetryEnabled = false, or leave out settings and performance with CollectPreferences and CollectPerformance.

Configuration

Types

export type Target = Player | number
export type NameStyle = "DisplayName" | "Username" | "Both" | "BothIfDifferent"
export type Membership = "Plus" | "Premium" | "None"
export type Role = "Developer" | "VideoStar"
export type NameTag
export type ClientInfo
export type PlatformInfo
export type DeviceClass
export type InputInfo
export type ScreenInfo
export type PreferencesInfo
export type SessionInfo
export type JoinData
export type PolicyInfo
export type Policy
export type CharacterInfo
export type GameplayInfo
export type Thumbnail
export type AppearanceInfo
export type FriendInfo
export type GroupInfo
export type GroupRole = { Id: number, Name: string, Rank: number }
export type GroupMembership = { GroupId: number, IsMember: boolean, Roles: { GroupRole } }
export type BadgeInfo
export type SubscriptionInfo
export type Profile
export type ProfileConfig