Skip to content
Roblox API Reference

Player

An object that represents a presently connected client to the experience.
Memory category
Instances
Own members
202
Inherited members
75
Subclasses
0
Siblings
608

Properties96

Inherited fromObject2

Property categoryData

Inherited fromInstance21

Property categoryBehavior

Property categoryData

Property categoryPermissions

Defined byPlayer73

Property categoryBehavior

  • Player.CanLoadCharacterAppearance: boolean
    Determines whether the character's appearance will be loaded when the player spawns. If false, the player will spawn with a default appearance.
    • Read capabilities: Players
  • Player.GameplayPaused: boolean
    Whether player client-side gameplay is currently paused.
    • Hidden
    • Write: Not accessible
    • Read capabilities: Players

Property categoryCamera

  • Player.CameraMaxZoomDistance: number
    The maximum distance the player's camera is allowed to zoom out.
    • Read capabilities: Players
  • Player.CameraMinZoomDistance: number
    The minimum distance the player's camera is allowed to zoom in.
    • Read capabilities: Players
  • Player.CameraMode: Enum.CameraMode
    Changes the camera's mode to either first or third person.
    • Read capabilities: Players
  • Player.DevCameraOcclusionMode: Enum.DevCameraOcclusionMode
    Sets how the default camera handles objects between the camera and the player.
    • Read capabilities: Players
  • Player.DevComputerCameraMode: Enum.DevComputerCameraMovementMode
    Determines player's camera movement mode when using a device with a mouse and keyboard.
    • Read capabilities: Players
  • Player.DevEnableMouseLock: boolean
    Determines if the player can toggle mouse lock.
    • Read capabilities: Players
  • Player.DevTouchCameraMode: Enum.DevTouchCameraMovementMode
    Determines player's camera movement mode when using a touch-enabled device.
    • Read capabilities: Players
  • Player.HealthDisplayDistance: number
    Sets the distance at which this player will see other players' health bars.
    • Read capabilities: Players
  • Player.NameDisplayDistance: number
    Sets the distance at which this player will see other players' names.
    • Read capabilities: Players

Property categoryControl

  • Player.DevComputerMovementMode: Enum.DevComputerMovementMode
    Determines player's character movement mode when using a device with a mouse and keyboard.
    • Read capabilities: Players
  • Player.DevTouchMovementMode: Enum.DevTouchMovementMode
    Determines player's character movement mode when using a touch-enabled device.
    • Read capabilities: Players

Property categoryData

  • Player.AccountAge: number
    Describes the player's account age in days.
    • Read only
    • Read capabilities: Players
  • Player.AccountAgeReplicate: number
    • Hidden
    • Not scriptable
    • Read capabilities: Players
  • Player.AgeChecked: Enum.AgeCheckStatus
    Indicates whether the player has completed an age verification check.
    • Write: Roblox engine security
    • Read capabilities: Players
  • Player.AutoJumpEnabled: boolean
    Determines whether the character of a player using a mobile device will automatically jump upon hitting an obstacle.
    • Read capabilities: Players
  • Player.CameraFieldOfView: number
    • Hidden
    • Not scriptable
    • Roblox engine security
    • Read capabilities: Players
  • Player.CameraFrustumRequested: boolean
    • Hidden
    • Not scriptable
    • Roblox engine security
    • Read capabilities: Players
  • Player.CameraViewportSize: Vector2
    • Hidden
    • Not scriptable
    • Roblox engine security
    • Read capabilities: Players
  • Player.Character: Model
    A Model controlled by the player that contains a Humanoid, body parts, scripts, and other objects.
    • Read capabilities: Players
  • Player.CharacterAppearanceId: number
    Determines the user ID of the account whose character appearance is used for a player's Character.
    • Read capabilities: Players
  • Player.ChararacterRegionId: Vector3
    • Hidden
    • Not scriptable
    • Roblox engine security
    • Read capabilities: Players
  • Player.ChatAvailabilityStatus: string
    • Hidden
    • Not replicated
    • Roblox script security
    • Read capabilities: Players
  • Player.ChatMode: Enum.ChatMode
    • Hidden
    • Read only
    • Roblox script security
    • Read capabilities: Players
  • Player.ChatPrivacyMode: Enum.ChatPrivacyMode
    • Hidden
    • Not scriptable
    • Roblox script security
    • Read capabilities: Players
  • Player.CloudEditCameraCoordinateFrame: CFrame
    • Hidden
    • Not scriptable
    • Read capabilities: Players
  • Player.CloudEditPlayerActive: boolean
    • Hidden
    • Not scriptable
    • Read capabilities: Players
  • Player.CountryRegionCodeReplicate: string
    • Hidden
    • Not scriptable
    • Read capabilities: Players
  • Player.DisplayName: string
    The display name of the authenticated user associated with the Player.
    • Read capabilities: Players
  • Player.FollowUserId: number
    Describes the user ID of the player who was followed into an experience by a player.
    • Read only
    • Read capabilities: Players
    • Save only
  • Player.FollowUserIdReplicated: number
    • Hidden
    • Not scriptable
    • Read capabilities: Players
  • Player.FrustumStreaming: Enum.FrustumStreamingMode
    Controls the engine's instance streaming behavior for the player's camera view.
    • Read capabilities: Players
  • Player.Guest: boolean
    • Hidden
    • Read only
    • Roblox script security
    • Read capabilities: Players
  • Player.HasRobloxSubscription: boolean
    Indicates whether the player has an active Roblox subscription.
    • Write: Roblox engine security
    • Read capabilities: Players
  • Player.HasVerifiedBadge: boolean
    Indicates if a player has a Verified badge.
    • Read capabilities: Players
  • Player.InputLatency: number
    Latency used by the Server Authority netcode system.
    • Roblox engine security
    • Read capabilities: Players
  • Player.InternalCharacterAppearanceLoaded: boolean
    • Hidden
    • Not scriptable
    • Read capabilities: Players
  • Player.LocaleId: string
    This property shows the locale ID that the local player has set for their Roblox account.
    • Hidden
    • Read only
    • Read capabilities: Players
  • Player.MaximumSimulationRadius: number
    • Hidden
    • Not replicated
    • Local user security
    • Read capabilities: Players
  • Player.MaxSimulationRadius: number
    • Hidden
    • Not scriptable
    • Local user security
    • Read capabilities: Players
  • Player.MembershipType: Enum.MembershipType
    Describes the account's membership type.
    • Read only
    • Read capabilities: Players
  • Player.MembershipTypeReplicate: Enum.MembershipType
    • Hidden
    • Not scriptable
    • Read capabilities: Players
  • Player.NeedRegionalFallback: boolean
    • Hidden
    • Not scriptable
    • Roblox engine security
    • Read capabilities: Players
  • Player.OsPlatform: string
    • Hidden
    • Not replicated
    • Roblox script security
    • Read capabilities: Players
  • Player.PartyId: string
    A unique identifier of the party a Player belongs to.
    • Hidden
    • Not replicated
    • Write: Roblox engine security
    • Read capabilities: Players
  • Player.PendingRequestedTool: Instance
    • Hidden
    • Not scriptable
    • Roblox engine security
    • Read capabilities: Players
  • Player.PlatformName: string
    • Hidden
    • Roblox script security
    • Read capabilities: Players
  • Player.RawJoinData: string
    • Hidden
    • Not scriptable
    • Roblox engine security
    • Read capabilities: Players
  • Player.ReplicationFocus: Instance
    Sets the part to focus replication around.
    • Read capabilities: Players
  • Player.RespawnLocation: SpawnLocation
    If set, the player will respawn at the given SpawnLocation.
    • Read capabilities: Players
  • Player.SimulationRadius: number
    • Hidden
    • Local user security
    • Read capabilities: Players
  • Player.StepIdOffset: number
    Offset between client and server used by the Server Authority system.
    • Roblox engine security
    • Read capabilities: Players
  • Player.SuperSafeChatReplicate: boolean
    • Hidden
    • Not scriptable
    • Local user security
    • Read capabilities: Players
  • Player.Teleported: boolean
    • Hidden
    • Read only
    • Roblox script security
    • Read capabilities: Players
  • Player.TeleportedIn: boolean
    • Hidden
    • Roblox script security
    • Read capabilities: Players
  • Player.ThirdPartyTextChatRestrictionStatus: Enum.ChatRestrictionStatus
    A read-only value reflecting the player's text-chat restriction status as reported by a third-party platform.
    • Read only
    • Roblox script security
    • Read capabilities: Players
    • Save only
  • Player.UnfilteredChat: boolean
    • Hidden
    • Read only
    • Roblox script security
    • Read capabilities: Players
  • Player.User: User
    The User representing this player's domain-scoped identity within the current experience.
    • Write: Roblox engine security
    • Read capabilities: Players
  • Player.UserId: number
    A unique identifying integer assigned to all user accounts.
    • Read capabilities: Players
  • Player.UserIdModeReplicate: Enum.UserIdMode
    • Hidden
    • Not scriptable
    • Roblox engine security
    • Read capabilities: Players
  • Player.VoiceChatVolume: number
    • Hidden
    • Not replicated
    • Roblox script security
    • Read capabilities: Players
  • Player.VRDevice: string
    • Hidden
    • Roblox script security
    • Read capabilities: Players
  • Player.VREnabled: boolean
    • Hidden
    • Not replicated
    • Roblox script security
    • Read capabilities: Players
  • Player.AppearanceDidLoad: boolean
    • Deprecated
    • Hidden
    • Read only
    • Roblox script security
    • Read capabilities: Players
  • Player.CharacterAppearance: string
    Deprecated: This item is deprecated. Do not use it for new work.
    The URL of the asset containing the character's appearance, clothing, and gear.
    • Deprecated
    • Not browsable
    • Read capabilities: Players

    Use CharacterAppearanceId instead.

  • Player.DataComplexity: number
    Deprecated: This item is deprecated, as it may have been used for a now obsolete data persistence method. Please save and load player data using DataStoreService for new work.
    The total amount of data currently being stored in the player's cache on the current place.
    • Deprecated
    • Hidden
    • Read only
    • Read capabilities: Players
  • Player.DataComplexityLimit: number
    • Deprecated
    • Hidden
    • Not replicated
    • Local user security
    • Read capabilities: Players
  • Player.DataReady: boolean
    Deprecated: This item is deprecated, as it may have been used for a now obsolete data persistence method. Please save and load player data using DataStoreService for new work.
    Indicates when the player's data is available to load.
    • Deprecated
    • Hidden
    • Read only
    • Read capabilities: Players
  • Player.userId: number
    Deprecated: This property is a deprecated variant of Player.UserId which should be used instead.
    • Deprecated
    • Read capabilities: Players

    Use UserId instead.

Property categoryTeam

  • Player.Neutral: boolean
    Determines whether the player is on a specific team.
    • Read capabilities: Players
  • Player.Team: Team
    Determines the Team with which the player is associated.
    • Not replicated
    • Read capabilities: Players
  • Player.TeamColor: BrickColor
    Determines the Team with which the player is associated with according to that team's Team.TeamColor.
    • Read capabilities: Players

Methods134

Inherited fromObject3
  • Object:GetPropertyChangedSignal(property: string): RBXScriptSignal
    Get an event that fires when a given property of the object changes.
    Parameters
    ParameterDescription
    property: string
    The property to connect to.
    Returns
    TypeDescription
    RBXScriptSignal
    A signal that fires whenever the property changes.
  • Object:IsA(className: string): boolean
    Returns true if an object's class matches or inherits from a given class.
    • Custom Lua state
    • Thread safe
    Parameters
    ParameterDescription
    className: string
    The class against which the Object's class will be checked. Case-sensitive.
    Returns
    TypeDescription
    boolean
    Describes whether the Object's class matched or is a subclass of the given class.
  • Object:isA(className: string): boolean
    Deprecated: This deprecated function is a variant of Object:IsA() which should be used instead.
    • Deprecated
    • Custom Lua state
    Parameters
    Parameter
    className: string
    Returns
    Type
    boolean

    Use IsA instead.

Inherited fromInstance39
Defined byPlayer92
  • Player:AddReplicationFocus(part: BasePart)
    Adds an additional replication focus for the player.
    • Capabilities: Players
    Parameters
    ParameterDescription
    part: BasePart
    The BasePart to use as a new replication focus.
  • Player:AddReplicationFocusPosition(center: Vector3, radius: number)
    • Roblox engine security
    • Capabilities: Players
    Parameters
    Parameter
    center: Vector3
    radius: number
  • Player:AddToBlockList(userIds: { any })
    • Roblox script security
    • Capabilities: Players
    Parameters
    Parameter
    userIds: { any }
  • Player:ClearCachedAvatarAppearance()
    Clears the cached avatar appearance for the player, forcing a fresh fetch from the backend on the next respawn.
    • Capabilities: AvatarAppearance + Players
  • Player:ClearCharacterAppearance()
    Removes all accessories and other character appearance objects from a player's Character.
    • Capabilities: Players
  • Player:DistanceFromCharacter(point: Vector3): number
    Returns the distance between the character's head and the given Vector3, or 0 if the player has no character.
    • Capabilities: Players
    Parameters
    ParameterDescription
    point: Vector3
    The location from which player's distance to is being measured.
    Returns
    TypeDescription
    number
    The distance in studs between the player and the location.
  • Player:GetBlockListInitialized(): boolean
    • Roblox script security
    • Capabilities: Players
    Returns
    Type
    boolean
  • Player:GetCameraState(): { [string]: any }
    Returns a dictionary containing the player's current camera state.
    • Custom Lua state
    • Thread safe
    • Capabilities: Players
    • Simulation access
    Returns
    TypeDescription
    { [string]: any }
    A dictionary containing CFrame, FieldOfView, and ViewportSize values.
  • Player:GetCanManageAsync(): boolean
    • Yields
    • Roblox script security
    • Capabilities: Players
    Returns
    Type
    boolean
  • Player:GetData(): PlayerData
    • Capabilities: Players
    Returns
    Type
    PlayerData
  • Player:GetFriendsInServerAsync(): { any }
    • Yields
    • Capabilities: Players + Social
    Returns
    Type
    { any }
  • Player:GetFriendsInUniverseAsync(): { any }
    • Yields
    • Capabilities: Players + Social
    Returns
    Type
    { any }
  • Player:GetFriendsOnlineAsync(maxFriends: number? = 200): { any }
    Returns a dictionary of online friends.
    • Yields
    • Capabilities: Players + Social
    Parameters
    ParameterDescription
    maxFriends: number? = 200
    The maximum number of online friends to return.
    Returns
    TypeDescription
    { any }
    A dictionary of online friends (see the table above).
  • Player:GetFriendStatus(player: Player): Enum.FriendStatus
    • Roblox script security
    • Capabilities: Players
    Parameters
    Parameter
    player: Player
    Returns
    Type
    Enum.FriendStatus
  • Player:GetFriendsWhoPlayedAsync(): { any }
    Returns the user IDs of friends who have previously joined this experience.
    • Yields
    • Capabilities: Players + Social
    Returns
    TypeDescription
    { any }
    An array of user IDs.
  • Player:GetGameSessionID(): string
    • Roblox engine security
    • Capabilities: Players
    Returns
    Type
    string
  • Player:GetGlobalUserId(): number
    • Roblox script security
    • Capabilities: Players
    Returns
    Type
    number
  • Player:GetJoinData(): { [string]: any }
    Returns a dictionary containing information describing how the player joins the experience.
    • Custom Lua state
    • Capabilities: Players
    Returns
    TypeDescription
    { [string]: any }
    A dictionary containing PlaceId and UserId values (see table in description).
  • Player:GetMouse(): Mouse
    Returns the mouse being used by the client.
    • Capabilities: Input + Players
    Returns
    TypeDescription
    Mouse
    The player's Mouse instance.
  • Player:GetNetworkPing(): number
    Returns the round-trip, isolated network latency in seconds.
    • Thread safe
    • Capabilities: Players
    Returns
    TypeDescription
    number
    The round-trip network latency of the player in seconds.
  • Player:GetSeatRequested(): Instance
    • Roblox script security
    • Thread safe
    • Capabilities: Players
    • Simulation access
    Returns
    Type
    Instance
  • Player:GetToolRequested(): Instance
    • Roblox script security
    • Thread safe
    • Capabilities: Players
    • Simulation access
    Returns
    Type
    Instance
  • Player:GetUnder13(): boolean
    • Roblox script security
    • Capabilities: Players
    Returns
    Type
    boolean
  • Player:HasAppearanceLoaded(): boolean
    Returns whether or not the appearance of the player's character has loaded.
    • Capabilities: Players
    Returns
    TypeDescription
    boolean
    A boolean indicating whether or not the appearance of the player's character has loaded.
  • Player:HasBlockedPlayer(fromPlayer: number): boolean
    • Roblox script security
    • Capabilities: Players
    Parameters
    Parameter
    fromPlayer: number
    Returns
    Type
    boolean
  • Player:IsFriendsWithAsync(userId: User): boolean
    Checks whether a player is a friend of the user with the given Player.UserId.
    • Yields
    • Capabilities: Players + Social
    Parameters
    ParameterDescription
    userId: User
    The Player.UserId of the specified player.
    Returns
    TypeDescription
    boolean
    A boolean indicating whether a player is a friend of the specified user.
  • Player:IsInGroupAsync(groupId: number): boolean
    Checks whether a player is a member of a group with the given ID.
    • Yields
    • Capabilities: Groups + Players
    Parameters
    ParameterDescription
    groupId: number
    The group ID of the specified group.
    Returns
    TypeDescription
    boolean
    A boolean indicating whether the player is in the specified group.
  • Player:IsVerified(level: Enum.VerifiedLevel? = Enum.VerifiedLevel.Low): boolean
    Returns whether the player meets the specified verification level.
    • Capabilities: Players
    Parameters
    ParameterDescription
    level: Enum.VerifiedLevel? = Enum.VerifiedLevel.Low
    The verification level to check. Defaults to VerifiedLevel.Low.
    Returns
    TypeDescription
    boolean
    A boolean indicating whether the player meets the specified verification level.
  • Player:Kick(message: string? = "")
    Forcibly disconnect a player from the experience, optionally providing a message.
    • Capabilities: Consequences + Players
    Parameters
    ParameterDescription
    message: string? = ""
    The message to show the user upon kicking.
  • Player:LoadCharacterAsync()
    Creates a new character for the player, removing the old one. Also clears the player's Backpack and PlayerGui.
    • Yields
    • Capabilities: Players
  • Player:LoadCharacterBlocking()
    • Yields
    • Local user security
    • Capabilities: Players
  • Player:LoadCharacterWithAvatarRulesAsync(avatarRules: any)
    • Yields
    • Capabilities: AvatarAppearance + Players
    Parameters
    Parameter
    avatarRules: any
  • Player:LoadCharacterWithHumanoidDescriptionAsync(humanoidDescription: HumanoidDescription,assetTypeVerification: Enum.AssetTypeVerification? = Enum.AssetTypeVerification.Default,)
    Spawns a player character with everything equipped in the passed in HumanoidDescription.
    • Yields
    • Capabilities: Players
    Parameters
    ParameterDescription
    humanoidDescription: HumanoidDescription
    A HumanoidDescription containing traits like body parts/colors, body scaling, accessories, clothing, and animations that will be equipped to the loaded character.
    assetTypeVerification: Enum.AssetTypeVerification? = Enum.AssetTypeVerification.Default
    The asset type verification mode.
  • Player:Move(walkDirection: Vector3, relativeToCamera: boolean? = false)
    Causes the player's character to walk in the given direction until stopped, or interrupted by the player (by using their controls).
    • Capabilities: Players
    Parameters
    ParameterDescription
    walkDirection: Vector3
    The Vector3 direction that the player should move.
    relativeToCamera: boolean? = false
    A boolean indicating whether the player should move relative to the player's camera.
  • Player:NotifyAgeCheckPassed()
    • Roblox script security
    • Capabilities: Players
  • Player:OverrideStreamingRadii(minRadius: number, targetRadius: number)
    • Roblox engine security
    • Capabilities: Players
    Parameters
    Parameter
    minRadius: number
    targetRadius: number
  • Player:PinStreamingForInstance(instance: Instance, depth: number)
    • Roblox script security
    • Capabilities: Players
    Parameters
    Parameter
    instance: Instance
    depth: number
  • Player:PinStreamingForInstanceByUniqueId(uniqueIdString: string, depth: number)
    • Roblox script security
    • Capabilities: Players
    Parameters
    Parameter
    uniqueIdString: string
    depth: number
  • Player:PromptAgeCheck()
    Prompts the player to complete age verification.
    • Capabilities: Players
  • Player:PromptSecurityChallengeAsync(): boolean
    • Yields
    • Roblox engine security
    • Capabilities: Players
    Returns
    Type
    boolean
  • Player:RemoveCharacter()
    • Local user security
    • Capabilities: Players
  • Player:RemoveReplicationFocus(part: BasePart)
    Removes a previously added replication focus.
    • Capabilities: Players
    Parameters
    ParameterDescription
    part: BasePart
    The BasePart to remove as a replication focus.
  • Player:RemoveReplicationFocusPosition(center: Vector3, radius: number)
    • Roblox engine security
    • Capabilities: Players
    Parameters
    Parameter
    center: Vector3
    radius: number
  • Player:RequestFriendship(player: Player)
    • Roblox script security
    • Capabilities: Players
    Parameters
    Parameter
    player: Player
  • Player:RequestSeat(instance: Instance)
    • Roblox script security
    • Thread safe
    • Capabilities: Players
    • Simulation access
    Parameters
    Parameter
    instance: Instance
  • Player:RequestStreamAroundAsync(position: Vector3, timeOut: number? = 0)
    Requests that the server stream to the player around the specified location.
    • Yields
    • Capabilities: Players
    Parameters
    ParameterDescription
    position: Vector3
    World location where streaming is requested.
    timeOut: number? = 0
    Optional timeout for the request, the maximum duration that the engine attempts to stream regions around the position parameter before abandoning the request. If you don't specify a value, the timeout is effectively infinite. However, if the client is low on memory, the engine abandons all streaming requests, even those that are still within the timeout duration.
  • Player:RequestTool(instance: Instance)
    • Roblox script security
    • Thread safe
    • Capabilities: Players
    • Simulation access
    Parameters
    Parameter
    instance: Instance
  • Player:RevokeFriendship(player: Player)
    • Roblox script security
    • Capabilities: Players
    Parameters
    Parameter
    player: Player
  • Player:SetAccountAge(accountAge: number)
    Sets the AccountAge of the player.
    • Plugin security
    • Capabilities: Players
    Parameters
    ParameterDescription
    accountAge: number
    The age of the account in days.
  • Player:SetBlockListInitialized()
    • Roblox script security
    • Capabilities: Players
  • Player:SetCharacterAppearanceJson(jsonBlob: string)
    • Roblox script security
    • Capabilities: Players
    Parameters
    Parameter
    jsonBlob: string
  • Player:SetChatTranslationSettingsLocaleId(locale: string)
    • Roblox script security
    • Capabilities: Players
    Parameters
    Parameter
    locale: string
  • Player:SetExperienceSettingsLocaleId(locale: string)
    • Roblox script security
    • Capabilities: Players
    Parameters
    Parameter
    locale: string
  • Player:SetHasRobloxSubscription(hasRobloxSubscription: boolean)
    • Roblox script security
    • Capabilities: Players
    Parameters
    Parameter
    hasRobloxSubscription: boolean
  • Player:SetMembershipType(membershipType: Enum.MembershipType)
    • Roblox script security
    • Capabilities: Players
    Parameters
    Parameter
    membershipType: Enum.MembershipType
  • Player:SetModerationAccessKey(moderationAccessKey: string)
    • Roblox script security
    • Capabilities: Players
    Parameters
    Parameter
    moderationAccessKey: string
  • Player:SetSuperSafeChat(value: boolean)
    Sets whether or not the player sees filtered chats, rather than normal chats.
    • Plugin security
    • Capabilities: Players
    Parameters
    ParameterDescription
    value: boolean
    A boolean indicating whether or not the player sees filtered chat.
  • Player:UnpinStreamingForInstance(instance: Instance, depth: number)
    • Roblox script security
    • Capabilities: Players
    Parameters
    Parameter
    instance: Instance
    depth: number
  • Player:UpdatePlayerBlocked(userId: number, blocked: boolean)
    • Roblox script security
    • Capabilities: Players
    Parameters
    Parameter
    userId: number
    blocked: boolean
  • Player:GetFriendsOnline(maxFriends: number? = 200): { any }
    Deprecated: This method has been superseded by GetFriendsOnlineAsync().
    Returns a dictionary of online friends.
    • Deprecated
    • Yields
    • Capabilities: Players + Social
    Parameters
    ParameterDescription
    maxFriends: number? = 200
    The maximum number of online friends to return.
    Returns
    TypeDescription
    { any }
    A dictionary of online friends (see the table above).

    Use GetFriendsOnlineAsync instead.

  • Player:GetRankInGroup(groupId: number): number
    Deprecated: This method has been superseded by GetRankInGroupAsync().
    Returns the player's rank in the group as an integer.
    • Deprecated
    • Yields
    • Capabilities: Groups + Players
    Parameters
    ParameterDescription
    groupId: number
    The groupId of the specified group.
    Returns
    TypeDescription
    number
    The player's rank in the group.

    Use GetRankInGroupAsync instead.

  • Player:GetRankInGroupAsync(groupId: number): number
    Deprecated: This method returns only the rank value of the member's highest public role. Use GroupService:GetRolesInGroupAsync() instead, which returns all public roles.
    Returns the player's rank in the group as an integer.
    • Deprecated
    • Yields
    • Capabilities: Groups + Players
    Parameters
    ParameterDescription
    groupId: number
    The groupId of the specified group.
    Returns
    TypeDescription
    number
    The player's rank in the group.

    Use GetRolesInGroupAsync instead.

  • Player:GetRoleInGroup(groupId: number): string
    Deprecated: This method has been superseded by GetRoleInGroup().
    Returns the player's role in the group as a string, or Guest if the player isn't part of the group.
    • Deprecated
    • Yields
    • Capabilities: Groups + Players
    Parameters
    ParameterDescription
    groupId: number
    The group ID of the specified group.
    Returns
    TypeDescription
    string
    The player's role in the specified group, or Guest if the player is not a member.

    Use GetRoleInGroupAsync instead.

  • Player:GetRoleInGroupAsync(groupId: number): string
    Deprecated: This method returns only the member's highest public role. Use GroupService:GetRolesInGroupAsync() instead, which returns all public roles.
    Returns the player's role in the group as a string, or Guest if the player isn't part of the group.
    • Deprecated
    • Yields
    • Capabilities: Groups + Players
    Parameters
    ParameterDescription
    groupId: number
    The group ID of the specified group.
    Returns
    TypeDescription
    string
    The player's role in the specified group, or Guest if the player is not a member.

    Use GetRolesInGroupAsync instead.

  • Player:IsBestFriendsWith(userId: User): boolean
    Deprecated: This function is obsolete because the "best friends" feature was removed. Use Player:IsFriendsWithAsync() instead.
    Returns whether a player is friends with the specified user.
    • Deprecated
    • Yields
    • Capabilities: Players
    Parameters
    ParameterDescription
    userId: User
    The Player.UserId of the user to check friendship with.
    Returns
    TypeDescription
    boolean
    A boolean indicating whether the player is friends with the specified user.
  • Player:IsFriendsWith(userId: User): boolean
    Deprecated: This method has been superseded by the Player:IsFriendsWithAsync() method which should be used for new work.
    Checks whether a player is a friend of the user with the given
    • Deprecated
    • Yields
    • Capabilities: Players + Social
    Parameters
    ParameterDescription
    userId: User
    The Player.UserId of the specified player.
    Returns
    TypeDescription
    boolean
    A boolean indicating whether a player is a friend of the specified user.

    Use IsFriendsWithAsync instead.

  • Player:IsInGroup(groupId: number): boolean
    Deprecated: This method has been superseded by IsInGroupAsync().
    Checks whether a player is a member of a group with the given ID.
    • Deprecated
    • Yields
    • Capabilities: Groups + Players
    Parameters
    ParameterDescription
    groupId: number
    The group ID of the specified group.
    Returns
    TypeDescription
    boolean
    A boolean indicating whether the player is in the specified group.

    Use IsInGroupAsync instead.

  • Player:LoadBoolean(key: string): boolean
    Deprecated: This item is deprecated, as it may have been used for a now obsolete data persistence method. Please save and load player data using DataStoreService for new work.
    Returns a boolean value that was previously saved to the player with Player:SaveBoolean() with the same key.
    • Deprecated
    • Capabilities: Players
    Parameters
    ParameterDescription
    key: string
    The string key under which the boolean was previously saved.
    Returns
    TypeDescription
    boolean
    The saved boolean value, or false if the key does not exist.
  • Player:LoadCharacter()
    Deprecated: This method has been superseded by LoadCharacterAsync().
    Creates a new character for the player, removing the old one. Also clears the player's Backpack and PlayerGui.
    • Deprecated
    • Yields
    • Capabilities: Players

    Use LoadCharacterAsync instead.

  • Player:LoadCharacterAppearance(assetInstance: Instance)
    Deprecated: This method is deprecated. Do not use it for new work.
    Places the given instance either in the player's character, head, or StarterGear based on the instance's class.
    • Deprecated
    • Capabilities: AvatarAppearance + Players
    Parameters
    ParameterDescription
    assetInstance: Instance
    An instance of the asset being loaded, which can be obtained using the InsertService:LoadAsset() function.
  • Player:LoadCharacterWithHumanoidDescription(humanoidDescription: HumanoidDescription,assetTypeVerification: Enum.AssetTypeVerification? = Enum.AssetTypeVerification.Default,)
    Deprecated: This method has been superseded by LoadCharacterWithHumanoidDescriptionAsync().
    Spawns a player character with everything equipped in the passed in HumanoidDescription.
    • Deprecated
    • Yields
    • Capabilities: Players
    Parameters
    ParameterDescription
    humanoidDescription: HumanoidDescription
    A HumanoidDescription containing traits like body parts/colors, body scaling, accessories, clothing, and animations that will be equipped to the loaded character.
    assetTypeVerification: Enum.AssetTypeVerification? = Enum.AssetTypeVerification.Default
    The asset type verification mode.

    Use LoadCharacterWithHumanoidDescriptionAsync instead.

  • Player:LoadData()
    • Deprecated
    • Local user security
    • Capabilities: Players
  • Player:LoadInstance(key: string): Instance
    Deprecated: This item is deprecated, as it may have been used for a now obsolete data persistence method. Please save and load player data using DataStoreService for new work.
    Returns an instance that was previously saved to the player with Player:SaveInstance() with the same key.
    • Deprecated
    • Capabilities: Players
    Parameters
    ParameterDescription
    key: string
    The string key under which the instance was previously saved.
    Returns
    TypeDescription
    Instance
    The saved Instance, or nil if the key does not exist.
  • Player:LoadNumber(key: string): number
    Deprecated: This item is deprecated, as it may have been used for a now obsolete data persistence method. Please save and load player data using DataStoreService for new work.
    Returns a number value that was previously saved to the player.
    • Deprecated
    • Capabilities: Players
    Parameters
    ParameterDescription
    key: string
    The string key under which the number was previously saved.
    Returns
    TypeDescription
    number
    The saved number value, or 0 if the key does not exist.
  • Player:LoadString(key: string): string
    Deprecated: This item is deprecated, as it may have been used for a now obsolete data persistence method. Please save and load player data using DataStoreService for new work.
    Returns a string value that was previously saved to the player.
    • Deprecated
    • Capabilities: Players
    Parameters
    ParameterDescription
    key: string
    The string key under which the string was previously saved.
    Returns
    TypeDescription
    string
    The saved string value, or an empty string if the key does not exist.
  • Player:SaveBoolean(key: string, value: boolean)
    Deprecated: This item is deprecated, as it may have been used for a now obsolete data persistence method. Please save and load player data using DataStoreService for new work.
    Used to save a boolean value that can be loaded again at a later time using Player:LoadBoolean().
    • Deprecated
    • Capabilities: Players
    Parameters
    ParameterDescription
    key: string
    The string key to associate with the saved boolean value.
    value: boolean
    The boolean value to save.
  • Player:SaveData()
    • Deprecated
    • Local user security
    • Capabilities: Players
  • Player:SaveInstance(key: string, value: Instance)
    Deprecated: This item is deprecated, as it may have been used for a now obsolete data persistence method. Please save and load player data using DataStoreService for new work.
    Saves an instance which can be loaded again at a later time.
    • Deprecated
    • Capabilities: Players
    Parameters
    ParameterDescription
    key: string
    The string key to associate with the saved instance.
    value: Instance
    The Instance to save.
  • Player:SaveNumber(key: string, value: number)
    Deprecated: This item is deprecated, as it may have been used for a now obsolete data persistence method. Please save and load player data using DataStoreService for new work.
    Saves a number value that can be loaded again at a later time using.
    • Deprecated
    • Capabilities: Players
    Parameters
    ParameterDescription
    key: string
    The string key to associate with the saved number value.
    value: number
    The number value to save.
  • Player:SaveString(key: string, value: string)
    Deprecated: This item is deprecated, as it may have been used for a now obsolete data persistence method. Please save and load player data using DataStoreService for new work.
    Saves a string value that can be loaded again at a later time.
    • Deprecated
    • Capabilities: Players
    Parameters
    ParameterDescription
    key: string
    The string key to associate with the saved string value.
    value: string
    The string value to save.
  • Player:SetUnder13(value: boolean)
    • Deprecated
    • Roblox engine security
    • Capabilities: Players
    Parameters
    Parameter
    value: boolean
  • Player:WaitForDataReady(): boolean
    Deprecated: This item is deprecated, as it may have been used for a now obsolete data persistence method. Please save and load player data using DataStoreService for new work.
    Used to pause the script until the player's data is available to manipulate, or until a certain amount of time has elapsed without fetching the player's data.
    • Deprecated
    • Yields
    • Capabilities: Players
    Returns
    TypeDescription
    boolean
    A boolean indicating whether the player's data loaded successfully.
  • Player:isFriendsWith(userId: User): boolean
    Deprecated: This method has been superseded by the Player:IsFriendsWithAsync() method which should be used for new work.
    • Deprecated
    • Yields
    • Capabilities: Players
    Parameters
    Parameter
    userId: User
    Returns
    Type
    boolean

    Use IsFriendsWith instead.

  • Player:loadBoolean(key: string): boolean
    Deprecated: This deprecated function is a variant of Player:LoadBoolean() which has also been deprecated. Neither function should be used in new work.
    • Deprecated
    • Capabilities: Players
    Parameters
    Parameter
    key: string
    Returns
    Type
    boolean

    Use LoadBoolean instead.

  • Player:loadInstance(key: string): Instance
    Deprecated: This deprecated function is a variant of Player:LoadInstance() which has also been deprecated. Neither function should be used in new work.
    • Deprecated
    • Capabilities: Players
    Parameters
    Parameter
    key: string
    Returns
    Type
    Instance

    Use LoadInstance instead.

  • Player:loadNumber(key: string): number
    Deprecated: This deprecated function is a variant of Player:LoadNumber() which has also been deprecated. Neither function should be used in new work.
    • Deprecated
    • Capabilities: Players
    Parameters
    Parameter
    key: string
    Returns
    Type
    number

    Use LoadNumber instead.

  • Player:loadString(key: string): string
    Deprecated: This function is a deprecated variant of Player:LoadString() which has also been deprecated. Neither function should be used in new work.
    • Deprecated
    • Capabilities: Players
    Parameters
    Parameter
    key: string
    Returns
    Type
    string

    Use LoadString instead.

  • Player:saveBoolean(key: string, value: boolean)
    Deprecated: This function is a deprecated variant of Player:SaveBoolean() which has also been deprecated. Neither function should be used in new work.
    • Deprecated
    • Capabilities: Players
    Parameters
    Parameter
    key: string
    value: boolean

    Use SaveBoolean instead.

  • Player:saveInstance(key: string, value: Instance)
    Deprecated: This function is a deprecated variant of Player:SaveInstance() which has also been deprecated. Neither function should be used in new work.
    • Deprecated
    • Capabilities: Players
    Parameters
    Parameter
    key: string
    value: Instance

    Use SaveInstance instead.

  • Player:saveNumber(key: string, value: number)
    Deprecated: This function is a deprecated variant of Player:SaveNumber() which has also been deprecated. Neither function should be used in new work.
    • Deprecated
    • Capabilities: Players
    Parameters
    Parameter
    key: string
    value: number

    Use SaveNumber instead.

  • Player:saveString(key: string, value: string)
    Deprecated: This function is a deprecated variant of Player:SaveString() which has also been deprecated. Neither function should be used in new work.
    • Deprecated
    • Capabilities: Players
    Parameters
    Parameter
    key: string
    value: string

    Use SaveString instead.

  • Player:waitForDataReady(): boolean
    Deprecated: This function is a deprecated variant of Player:WaitForDataReady() which has also been deprecated. Neither function should be used in new work.
    • Deprecated
    • Yields
    • Capabilities: Players
    Returns
    Type
    boolean

    Use WaitForDataReady instead.

Events47

Inherited fromObject1
Inherited fromInstance9
Defined byPlayer37