# Player Roblox Engine API class from Roblox Studio 0.744.0.7441077 (version-7aaa6838d36c4448). - Inherits from, nearest first: [Instance](https://rapi.sleaze.dev/classes/Instance.md), [Object](https://rapi.sleaze.dev/classes/Object.md) - Memory category: Instances - HTML page: https://rapi.sleaze.dev/classes/Player/ - Roblox documentation: https://create.roblox.com/docs/reference/engine/classes/Player An object that represents a presently connected client to the experience. ## Properties ### CanLoadCharacterAppearance ```luau Player.CanLoadCharacterAppearance: boolean ``` - Tags: Read capabilities: Players Determines whether the character's appearance will be loaded when the player spawns. If `false`, the player will spawn with a default appearance. ### GameplayPaused ```luau Player.GameplayPaused: boolean ``` - Tags: Hidden, Write: Not accessible, Read capabilities: Players Whether player client-side gameplay is currently paused. ### CameraMaxZoomDistance ```luau Player.CameraMaxZoomDistance: number ``` - Tags: Read capabilities: Players The maximum distance the player's camera is allowed to zoom out. ### CameraMinZoomDistance ```luau Player.CameraMinZoomDistance: number ``` - Tags: Read capabilities: Players The minimum distance the player's camera is allowed to zoom in. ### CameraMode ```luau Player.CameraMode: Enum.CameraMode ``` - Tags: Read capabilities: Players Changes the camera's mode to either first or third person. ### DevCameraOcclusionMode ```luau Player.DevCameraOcclusionMode: Enum.DevCameraOcclusionMode ``` - Tags: Read capabilities: Players Sets how the default camera handles objects between the camera and the player. ### DevComputerCameraMode ```luau Player.DevComputerCameraMode: Enum.DevComputerCameraMovementMode ``` - Tags: Read capabilities: Players Determines player's camera movement mode when using a device with a mouse and keyboard. ### DevEnableMouseLock ```luau Player.DevEnableMouseLock: boolean ``` - Tags: Read capabilities: Players Determines if the player can toggle mouse lock. ### DevTouchCameraMode ```luau Player.DevTouchCameraMode: Enum.DevTouchCameraMovementMode ``` - Tags: Read capabilities: Players Determines player's camera movement mode when using a touch-enabled device. ### HealthDisplayDistance ```luau Player.HealthDisplayDistance: number ``` - Tags: Read capabilities: Players Sets the distance at which this player will see other players' health bars. ### NameDisplayDistance ```luau Player.NameDisplayDistance: number ``` - Tags: Read capabilities: Players Sets the distance at which this player will see other players' names. ### DevComputerMovementMode ```luau Player.DevComputerMovementMode: Enum.DevComputerMovementMode ``` - Tags: Read capabilities: Players Determines player's character movement mode when using a device with a mouse and keyboard. ### DevTouchMovementMode ```luau Player.DevTouchMovementMode: Enum.DevTouchMovementMode ``` - Tags: Read capabilities: Players Determines player's character movement mode when using a touch-enabled device. ### AccountAge ```luau Player.AccountAge: number ``` - Tags: Read only, Read capabilities: Players Describes the player's account age in days. ### AccountAgeReplicate ```luau Player.AccountAgeReplicate: number ``` - Tags: Hidden, Not scriptable, Read capabilities: Players ### AgeChecked ```luau Player.AgeChecked: Enum.AgeCheckStatus ``` - Tags: Write: Roblox engine security, Read capabilities: Players Indicates whether the player has completed an age verification check. ### AutoJumpEnabled ```luau Player.AutoJumpEnabled: boolean ``` - Tags: Read capabilities: Players Determines whether the character of a player using a mobile device will automatically jump upon hitting an obstacle. ### CameraFieldOfView ```luau Player.CameraFieldOfView: number ``` - Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Players ### CameraFrustumRequested ```luau Player.CameraFrustumRequested: boolean ``` - Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Players ### CameraViewportSize ```luau Player.CameraViewportSize: Vector2 ``` - Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Players ### Character ```luau Player.Character: Model ``` - Tags: Read capabilities: Players A [`Model`](https://rapi.sleaze.dev/classes/Model.md) controlled by the player that contains a [`Humanoid`](https://rapi.sleaze.dev/classes/Humanoid.md), body parts, scripts, and other objects. ### CharacterAppearanceId ```luau Player.CharacterAppearanceId: number ``` - Tags: Read capabilities: Players Determines the user ID of the account whose character appearance is used for a player's [`Character`](https://rapi.sleaze.dev/classes/Player.md). ### ChararacterRegionId ```luau Player.ChararacterRegionId: Vector3 ``` - Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Players ### ChatAvailabilityStatus ```luau Player.ChatAvailabilityStatus: string ``` - Tags: Hidden, Not replicated, Roblox script security, Read capabilities: Players ### ChatMode ```luau Player.ChatMode: Enum.ChatMode ``` - Tags: Hidden, Read only, Roblox script security, Read capabilities: Players ### ChatPrivacyMode ```luau Player.ChatPrivacyMode: Enum.ChatPrivacyMode ``` - Tags: Hidden, Not scriptable, Roblox script security, Read capabilities: Players ### CloudEditCameraCoordinateFrame ```luau Player.CloudEditCameraCoordinateFrame: CFrame ``` - Tags: Hidden, Not scriptable, Read capabilities: Players ### CloudEditPlayerActive ```luau Player.CloudEditPlayerActive: boolean ``` - Tags: Hidden, Not scriptable, Read capabilities: Players ### CountryRegionCodeReplicate ```luau Player.CountryRegionCodeReplicate: string ``` - Tags: Hidden, Not scriptable, Read capabilities: Players ### DisplayName ```luau Player.DisplayName: string ``` - Tags: Read capabilities: Players The display name of the authenticated user associated with the [`Player`](https://rapi.sleaze.dev/classes/Player.md). ### FollowUserId ```luau Player.FollowUserId: number ``` - Tags: Read only, Read capabilities: Players, Save only Describes the user ID of the player who was followed into an experience by a player. ### FollowUserIdReplicated ```luau Player.FollowUserIdReplicated: number ``` - Tags: Hidden, Not scriptable, Read capabilities: Players ### FrustumStreaming ```luau Player.FrustumStreaming: Enum.FrustumStreamingMode ``` - Tags: Read capabilities: Players Controls the engine's instance streaming behavior for the player's camera view. ### Guest ```luau Player.Guest: boolean ``` - Tags: Hidden, Read only, Roblox script security, Read capabilities: Players ### HasRobloxSubscription ```luau Player.HasRobloxSubscription: boolean ``` - Tags: Write: Roblox engine security, Read capabilities: Players Indicates whether the player has an active Roblox subscription. ### HasVerifiedBadge ```luau Player.HasVerifiedBadge: boolean ``` - Tags: Read capabilities: Players Indicates if a player has a **Verified** badge. ### InputLatency ```luau Player.InputLatency: number ``` - Tags: Roblox engine security, Read capabilities: Players Latency used by the Server Authority netcode system. ### InternalCharacterAppearanceLoaded ```luau Player.InternalCharacterAppearanceLoaded: boolean ``` - Tags: Hidden, Not scriptable, Read capabilities: Players ### LocaleId ```luau Player.LocaleId: string ``` - Tags: Hidden, Read only, Read capabilities: Players This property shows the locale ID that the local player has set for their Roblox account. ### MaximumSimulationRadius ```luau Player.MaximumSimulationRadius: number ``` - Tags: Hidden, Not replicated, Local user security, Read capabilities: Players ### MaxSimulationRadius ```luau Player.MaxSimulationRadius: number ``` - Tags: Hidden, Not scriptable, Local user security, Read capabilities: Players ### MembershipType ```luau Player.MembershipType: Enum.MembershipType ``` - Tags: Read only, Read capabilities: Players Describes the account's membership type. ### MembershipTypeReplicate ```luau Player.MembershipTypeReplicate: Enum.MembershipType ``` - Tags: Hidden, Not scriptable, Read capabilities: Players ### NeedRegionalFallback ```luau Player.NeedRegionalFallback: boolean ``` - Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Players ### OsPlatform ```luau Player.OsPlatform: string ``` - Tags: Hidden, Not replicated, Roblox script security, Read capabilities: Players ### PartyId ```luau Player.PartyId: string ``` - Tags: Hidden, Not replicated, Write: Roblox engine security, Read capabilities: Players A unique identifier of the party a [`Player`](https://rapi.sleaze.dev/classes/Player.md) belongs to. ### PendingRequestedTool ```luau Player.PendingRequestedTool: Instance ``` - Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Players ### PlatformName ```luau Player.PlatformName: string ``` - Tags: Hidden, Roblox script security, Read capabilities: Players ### RawJoinData ```luau Player.RawJoinData: string ``` - Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Players ### ReplicationFocus ```luau Player.ReplicationFocus: Instance ``` - Tags: Read capabilities: Players Sets the part to focus replication around. ### RespawnLocation ```luau Player.RespawnLocation: SpawnLocation ``` - Tags: Read capabilities: Players If set, the player will respawn at the given [`SpawnLocation`](https://rapi.sleaze.dev/classes/SpawnLocation.md). ### SimulationRadius ```luau Player.SimulationRadius: number ``` - Tags: Hidden, Local user security, Read capabilities: Players ### StepIdOffset ```luau Player.StepIdOffset: number ``` - Tags: Roblox engine security, Read capabilities: Players Offset between client and server used by the Server Authority system. ### SuperSafeChatReplicate ```luau Player.SuperSafeChatReplicate: boolean ``` - Tags: Hidden, Not scriptable, Local user security, Read capabilities: Players ### Teleported ```luau Player.Teleported: boolean ``` - Tags: Hidden, Read only, Roblox script security, Read capabilities: Players ### TeleportedIn ```luau Player.TeleportedIn: boolean ``` - Tags: Hidden, Roblox script security, Read capabilities: Players ### ThirdPartyTextChatRestrictionStatus ```luau Player.ThirdPartyTextChatRestrictionStatus: Enum.ChatRestrictionStatus ``` - Tags: Read only, Roblox script security, Read capabilities: Players, Save only A read-only value reflecting the player's text-chat restriction status as reported by a third-party platform. ### UnfilteredChat ```luau Player.UnfilteredChat: boolean ``` - Tags: Hidden, Read only, Roblox script security, Read capabilities: Players ### User ```luau Player.User: User ``` - Tags: Write: Roblox engine security, Read capabilities: Players The [`User`](https://rapi.sleaze.dev/index/types/User.md) representing this player's domain-scoped identity within the current experience. ### UserId ```luau Player.UserId: number ``` - Tags: Read capabilities: Players A unique identifying integer assigned to all user accounts. ### UserIdModeReplicate ```luau Player.UserIdModeReplicate: Enum.UserIdMode ``` - Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Players ### VoiceChatVolume ```luau Player.VoiceChatVolume: number ``` - Tags: Hidden, Not replicated, Roblox script security, Read capabilities: Players ### VRDevice ```luau Player.VRDevice: string ``` - Tags: Hidden, Roblox script security, Read capabilities: Players ### VREnabled ```luau Player.VREnabled: boolean ``` - Tags: Hidden, Not replicated, Roblox script security, Read capabilities: Players ### AppearanceDidLoad ```luau Player.AppearanceDidLoad: boolean ``` - Tags: Deprecated, Hidden, Read only, Roblox script security, Read capabilities: Players ### CharacterAppearance ```luau Player.CharacterAppearance: string ``` - Tags: Deprecated, Not browsable, Read capabilities: Players - Use instead: [`Player.CharacterAppearanceId`](https://rapi.sleaze.dev/classes/Player.md) **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. ### DataComplexity ```luau Player.DataComplexity: number ``` - Tags: Deprecated, Hidden, Read only, Read capabilities: Players **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`](https://rapi.sleaze.dev/classes/DataStoreService.md) for new work. The total amount of data currently being stored in the player's cache on the current place. ### DataComplexityLimit ```luau Player.DataComplexityLimit: number ``` - Tags: Deprecated, Hidden, Not replicated, Local user security, Read capabilities: Players ### DataReady ```luau Player.DataReady: boolean ``` - Tags: Deprecated, Hidden, Read only, Read capabilities: Players **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`](https://rapi.sleaze.dev/classes/DataStoreService.md) for new work. Indicates when the player's data is available to load. ### userId ```luau Player.userId: number ``` - Tags: Deprecated, Read capabilities: Players - Use instead: [`Player.UserId`](https://rapi.sleaze.dev/classes/Player.md) **Deprecated:** This property is a deprecated variant of [`Player.UserId`](https://rapi.sleaze.dev/classes/Player.md) which should be used instead. ### Neutral ```luau Player.Neutral: boolean ``` - Tags: Read capabilities: Players Determines whether the player is on a specific team. ### Team ```luau Player.Team: Team ``` - Tags: Not replicated, Read capabilities: Players Determines the [`Team`](https://rapi.sleaze.dev/classes/Team.md) with which the player is associated. ### TeamColor ```luau Player.TeamColor: BrickColor ``` - Tags: Read capabilities: Players Determines the [`Team`](https://rapi.sleaze.dev/classes/Team.md) with which the player is associated with according to that team's [`Team.TeamColor`](https://rapi.sleaze.dev/classes/Team.md). ## Methods ### AddReplicationFocus ```luau Player:AddReplicationFocus(part: BasePart) ``` - Tags: Capabilities: Players Adds an additional replication focus for the player. Parameters: - `part`: The [`BasePart`](https://rapi.sleaze.dev/classes/BasePart.md) to use as a new replication focus. ### AddReplicationFocusPosition ```luau Player:AddReplicationFocusPosition(center: Vector3, radius: number) ``` - Tags: Roblox engine security, Capabilities: Players ### AddToBlockList ```luau Player:AddToBlockList(userIds: { any }) ``` - Tags: Roblox script security, Capabilities: Players ### ClearCachedAvatarAppearance ```luau Player:ClearCachedAvatarAppearance() ``` - Tags: Capabilities: AvatarAppearance + Players Clears the cached avatar appearance for the player, forcing a fresh fetch from the backend on the next respawn. ### ClearCharacterAppearance ```luau Player:ClearCharacterAppearance() ``` - Tags: Capabilities: Players Removes all accessories and other character appearance objects from a player's [`Character`](https://rapi.sleaze.dev/classes/Player.md). ### DistanceFromCharacter ```luau Player:DistanceFromCharacter(point: Vector3): number ``` - Tags: Capabilities: Players Returns the distance between the character's head and the given [`Vector3`](https://rapi.sleaze.dev/index/types/Vector3.md), or `0` if the player has no character. Parameters: - `point`: The location from which player's distance to is being measured. Returns: The distance in studs between the player and the location. ### GetBlockListInitialized ```luau Player:GetBlockListInitialized(): boolean ``` - Tags: Roblox script security, Capabilities: Players ### GetCameraState ```luau Player:GetCameraState(): { [string]: any } ``` - Tags: Custom Lua state, Thread safe, Capabilities: Players, Simulation access Returns a dictionary containing the player's current camera state. Returns: A dictionary containing [`CFrame`](https://rapi.sleaze.dev/index/types/CFrame.md), `FieldOfView`, and `ViewportSize` values. ### GetCanManageAsync ```luau Player:GetCanManageAsync(): boolean ``` - Tags: Yields, Roblox script security, Capabilities: Players ### GetData ```luau Player:GetData(): PlayerData ``` - Tags: Capabilities: Players ### GetFriendsInServerAsync ```luau Player:GetFriendsInServerAsync(): { any } ``` - Tags: Yields, Capabilities: Players + Social ### GetFriendsInUniverseAsync ```luau Player:GetFriendsInUniverseAsync(): { any } ``` - Tags: Yields, Capabilities: Players + Social ### GetFriendsOnlineAsync ```luau Player:GetFriendsOnlineAsync(maxFriends: number? = 200): { any } ``` - Tags: Yields, Capabilities: Players + Social Returns a dictionary of online friends. Parameters: - `maxFriends`: The maximum number of online friends to return. Returns: A dictionary of online friends (see the table above). ### GetFriendStatus ```luau Player:GetFriendStatus(player: Player): Enum.FriendStatus ``` - Tags: Roblox script security, Capabilities: Players ### GetFriendsWhoPlayedAsync ```luau Player:GetFriendsWhoPlayedAsync(): { any } ``` - Tags: Yields, Capabilities: Players + Social Returns the user IDs of friends who have previously joined this experience. Returns: An array of user IDs. ### GetGameSessionID ```luau Player:GetGameSessionID(): string ``` - Tags: Roblox engine security, Capabilities: Players ### GetGlobalUserId ```luau Player:GetGlobalUserId(): number ``` - Tags: Roblox script security, Capabilities: Players ### GetJoinData ```luau Player:GetJoinData(): { [string]: any } ``` - Tags: Custom Lua state, Capabilities: Players Returns a dictionary containing information describing how the player joins the experience. Returns: A dictionary containing PlaceId and UserId values (see table in description). ### GetMouse ```luau Player:GetMouse(): Mouse ``` - Tags: Capabilities: Input + Players Returns the mouse being used by the client. Returns: The player's [`Mouse`](https://rapi.sleaze.dev/classes/Mouse.md) instance. ### GetNetworkPing ```luau Player:GetNetworkPing(): number ``` - Tags: Thread safe, Capabilities: Players Returns the round-trip, isolated network latency in seconds. Returns: The round-trip network latency of the player in seconds. ### GetSeatRequested ```luau Player:GetSeatRequested(): Instance ``` - Tags: Roblox script security, Thread safe, Capabilities: Players, Simulation access ### GetToolRequested ```luau Player:GetToolRequested(): Instance ``` - Tags: Roblox script security, Thread safe, Capabilities: Players, Simulation access ### GetUnder13 ```luau Player:GetUnder13(): boolean ``` - Tags: Roblox script security, Capabilities: Players ### HasAppearanceLoaded ```luau Player:HasAppearanceLoaded(): boolean ``` - Tags: Capabilities: Players Returns whether or not the appearance of the player's character has loaded. Returns: A boolean indicating whether or not the appearance of the player's character has loaded. ### HasBlockedPlayer ```luau Player:HasBlockedPlayer(fromPlayer: number): boolean ``` - Tags: Roblox script security, Capabilities: Players ### IsFriendsWithAsync ```luau Player:IsFriendsWithAsync(userId: User): boolean ``` - Tags: Yields, Capabilities: Players + Social Checks whether a player is a friend of the user with the given [`Player.UserId`](https://rapi.sleaze.dev/classes/Player.md). Parameters: - `userId`: The [`Player.UserId`](https://rapi.sleaze.dev/classes/Player.md) of the specified player. Returns: A boolean indicating whether a player is a friend of the specified user. ### IsInGroupAsync ```luau Player:IsInGroupAsync(groupId: number): boolean ``` - Tags: Yields, Capabilities: Groups + Players Checks whether a player is a member of a group with the given ID. Parameters: - `groupId`: The group ID of the specified group. Returns: A boolean indicating whether the player is in the specified group. ### IsVerified ```luau Player:IsVerified(level: Enum.VerifiedLevel? = Enum.VerifiedLevel.Low): boolean ``` - Tags: Capabilities: Players Returns whether the player meets the specified verification level. Parameters: - `level`: The verification level to check. Defaults to `VerifiedLevel.Low`. Returns: A boolean indicating whether the player meets the specified verification level. ### Kick ```luau Player:Kick(message: string? = "") ``` - Tags: Capabilities: Consequences + Players Forcibly disconnect a player from the experience, optionally providing a message. Parameters: - `message`: The message to show the user upon kicking. ### LoadCharacterAsync ```luau Player:LoadCharacterAsync() ``` - Tags: Yields, Capabilities: Players Creates a new character for the player, removing the old one. Also clears the player's [`Backpack`](https://rapi.sleaze.dev/classes/Backpack.md) and [`PlayerGui`](https://rapi.sleaze.dev/classes/PlayerGui.md). ### LoadCharacterBlocking ```luau Player:LoadCharacterBlocking() ``` - Tags: Yields, Local user security, Capabilities: Players ### LoadCharacterWithAvatarRulesAsync ```luau Player:LoadCharacterWithAvatarRulesAsync(avatarRules: any) ``` - Tags: Yields, Capabilities: AvatarAppearance + Players ### LoadCharacterWithHumanoidDescriptionAsync ```luau Player:LoadCharacterWithHumanoidDescriptionAsync(humanoidDescription: HumanoidDescription, assetTypeVerification: Enum.AssetTypeVerification? = Enum.AssetTypeVerification.Default) ``` - Tags: Yields, Capabilities: Players Spawns a player character with everything equipped in the passed in [`HumanoidDescription`](https://rapi.sleaze.dev/classes/HumanoidDescription.md). Parameters: - `humanoidDescription`: A [`HumanoidDescription`](https://rapi.sleaze.dev/classes/HumanoidDescription.md) containing traits like body parts/colors, body scaling, accessories, clothing, and animations that will be equipped to the loaded character. - `assetTypeVerification`: The asset type verification mode. ### Move ```luau Player:Move(walkDirection: Vector3, relativeToCamera: boolean? = false) ``` - Tags: Capabilities: Players Causes the player's character to walk in the given direction until stopped, or interrupted by the player (by using their controls). Parameters: - `walkDirection`: The Vector3 direction that the player should move. - `relativeToCamera`: A boolean indicating whether the player should move relative to the player's camera. ### NotifyAgeCheckPassed ```luau Player:NotifyAgeCheckPassed() ``` - Tags: Roblox script security, Capabilities: Players ### OverrideStreamingRadii ```luau Player:OverrideStreamingRadii(minRadius: number, targetRadius: number) ``` - Tags: Roblox engine security, Capabilities: Players ### PinStreamingForInstance ```luau Player:PinStreamingForInstance(instance: Instance, depth: number) ``` - Tags: Roblox script security, Capabilities: Players ### PinStreamingForInstanceByUniqueId ```luau Player:PinStreamingForInstanceByUniqueId(uniqueIdString: string, depth: number) ``` - Tags: Roblox script security, Capabilities: Players ### PromptAgeCheck ```luau Player:PromptAgeCheck() ``` - Tags: Capabilities: Players Prompts the player to complete age verification. ### PromptSecurityChallengeAsync ```luau Player:PromptSecurityChallengeAsync(): boolean ``` - Tags: Yields, Roblox engine security, Capabilities: Players ### RemoveCharacter ```luau Player:RemoveCharacter() ``` - Tags: Local user security, Capabilities: Players ### RemoveReplicationFocus ```luau Player:RemoveReplicationFocus(part: BasePart) ``` - Tags: Capabilities: Players Removes a previously added replication focus. Parameters: - `part`: The [`BasePart`](https://rapi.sleaze.dev/classes/BasePart.md) to remove as a replication focus. ### RemoveReplicationFocusPosition ```luau Player:RemoveReplicationFocusPosition(center: Vector3, radius: number) ``` - Tags: Roblox engine security, Capabilities: Players ### RequestFriendship ```luau Player:RequestFriendship(player: Player) ``` - Tags: Roblox script security, Capabilities: Players ### RequestSeat ```luau Player:RequestSeat(instance: Instance) ``` - Tags: Roblox script security, Thread safe, Capabilities: Players, Simulation access ### RequestStreamAroundAsync ```luau Player:RequestStreamAroundAsync(position: Vector3, timeOut: number? = 0) ``` - Tags: Yields, Capabilities: Players Requests that the server stream to the player around the specified location. Parameters: - `position`: World location where streaming is requested. - `timeOut`: 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. ### RequestTool ```luau Player:RequestTool(instance: Instance) ``` - Tags: Roblox script security, Thread safe, Capabilities: Players, Simulation access ### RevokeFriendship ```luau Player:RevokeFriendship(player: Player) ``` - Tags: Roblox script security, Capabilities: Players ### SetAccountAge ```luau Player:SetAccountAge(accountAge: number) ``` - Tags: Plugin security, Capabilities: Players Sets the [`AccountAge`](https://rapi.sleaze.dev/classes/Player.md) of the player. Parameters: - `accountAge`: The age of the account in days. ### SetBlockListInitialized ```luau Player:SetBlockListInitialized() ``` - Tags: Roblox script security, Capabilities: Players ### SetCharacterAppearanceJson ```luau Player:SetCharacterAppearanceJson(jsonBlob: string) ``` - Tags: Roblox script security, Capabilities: Players ### SetChatTranslationSettingsLocaleId ```luau Player:SetChatTranslationSettingsLocaleId(locale: string) ``` - Tags: Roblox script security, Capabilities: Players ### SetExperienceSettingsLocaleId ```luau Player:SetExperienceSettingsLocaleId(locale: string) ``` - Tags: Roblox script security, Capabilities: Players ### SetHasRobloxSubscription ```luau Player:SetHasRobloxSubscription(hasRobloxSubscription: boolean) ``` - Tags: Roblox script security, Capabilities: Players ### SetMembershipType ```luau Player:SetMembershipType(membershipType: Enum.MembershipType) ``` - Tags: Roblox script security, Capabilities: Players ### SetModerationAccessKey ```luau Player:SetModerationAccessKey(moderationAccessKey: string) ``` - Tags: Roblox script security, Capabilities: Players ### SetSuperSafeChat ```luau Player:SetSuperSafeChat(value: boolean) ``` - Tags: Plugin security, Capabilities: Players Sets whether or not the player sees filtered chats, rather than normal chats. Parameters: - `value`: A boolean indicating whether or not the player sees filtered chat. ### UnpinStreamingForInstance ```luau Player:UnpinStreamingForInstance(instance: Instance, depth: number) ``` - Tags: Roblox script security, Capabilities: Players ### UpdatePlayerBlocked ```luau Player:UpdatePlayerBlocked(userId: number, blocked: boolean) ``` - Tags: Roblox script security, Capabilities: Players ### GetFriendsOnline ```luau Player:GetFriendsOnline(maxFriends: number? = 200): { any } ``` - Tags: Deprecated, Yields, Capabilities: Players + Social - Use instead: [`Player.GetFriendsOnlineAsync`](https://rapi.sleaze.dev/classes/Player.md) **Deprecated:** This method has been superseded by [`GetFriendsOnlineAsync()`](https://rapi.sleaze.dev/classes/Player.md). Returns a dictionary of online friends. Parameters: - `maxFriends`: The maximum number of online friends to return. Returns: A dictionary of online friends (see the table above). ### GetRankInGroup ```luau Player:GetRankInGroup(groupId: number): number ``` - Tags: Deprecated, Yields, Capabilities: Groups + Players - Use instead: [`Player.GetRankInGroupAsync`](https://rapi.sleaze.dev/classes/Player.md) **Deprecated:** This method has been superseded by [`GetRankInGroupAsync()`](https://rapi.sleaze.dev/classes/Player.md). Returns the player's rank in the group as an integer. Parameters: - `groupId`: The `groupId` of the specified group. Returns: The player's rank in the group. ### GetRankInGroupAsync ```luau Player:GetRankInGroupAsync(groupId: number): number ``` - Tags: Deprecated, Yields, Capabilities: Groups + Players **Deprecated:** This method returns only the rank value of the member's highest public role. Use [`GroupService:GetRolesInGroupAsync()`](https://rapi.sleaze.dev/classes/GroupService.md) instead, which returns all public roles. Returns the player's rank in the group as an integer. Parameters: - `groupId`: The `groupId` of the specified group. Returns: The player's rank in the group. ### GetRoleInGroup ```luau Player:GetRoleInGroup(groupId: number): string ``` - Tags: Deprecated, Yields, Capabilities: Groups + Players - Use instead: [`Player.GetRoleInGroupAsync`](https://rapi.sleaze.dev/classes/Player.md) **Deprecated:** This method has been superseded by [`GetRoleInGroup()`](https://rapi.sleaze.dev/classes/Player.md). Returns the player's role in the group as a string, or [`Guest`](https://rapi.sleaze.dev/classes/Player.md) if the player isn't part of the group. Parameters: - `groupId`: The group ID of the specified group. Returns: The player's role in the specified group, or [`Guest`](https://rapi.sleaze.dev/classes/Player.md) if the player is not a member. ### GetRoleInGroupAsync ```luau Player:GetRoleInGroupAsync(groupId: number): string ``` - Tags: Deprecated, Yields, Capabilities: Groups + Players **Deprecated:** This method returns only the member's highest public role. Use [`GroupService:GetRolesInGroupAsync()`](https://rapi.sleaze.dev/classes/GroupService.md) instead, which returns all public roles. Returns the player's role in the group as a string, or [`Guest`](https://rapi.sleaze.dev/classes/Player.md) if the player isn't part of the group. Parameters: - `groupId`: The group ID of the specified group. Returns: The player's role in the specified group, or [`Guest`](https://rapi.sleaze.dev/classes/Player.md) if the player is not a member. ### IsBestFriendsWith ```luau Player:IsBestFriendsWith(userId: User): boolean ``` - Tags: Deprecated, Yields, Capabilities: Players **Deprecated:** This function is obsolete because the "best friends" feature was removed. Use [`Player:IsFriendsWithAsync()`](https://rapi.sleaze.dev/classes/Player.md) instead. Returns whether a player is friends with the specified user. Parameters: - `userId`: The [`Player.UserId`](https://rapi.sleaze.dev/classes/Player.md) of the user to check friendship with. Returns: A boolean indicating whether the player is friends with the specified user. ### IsFriendsWith ```luau Player:IsFriendsWith(userId: User): boolean ``` - Tags: Deprecated, Yields, Capabilities: Players + Social - Use instead: [`Player.IsFriendsWithAsync`](https://rapi.sleaze.dev/classes/Player.md) **Deprecated:** This method has been superseded by the [`Player:IsFriendsWithAsync()`](https://rapi.sleaze.dev/classes/Player.md) method which should be used for new work. Checks whether a player is a friend of the user with the given Parameters: - `userId`: The [`Player.UserId`](https://rapi.sleaze.dev/classes/Player.md) of the specified player. Returns: A boolean indicating whether a player is a friend of the specified user. ### IsInGroup ```luau Player:IsInGroup(groupId: number): boolean ``` - Tags: Deprecated, Yields, Capabilities: Groups + Players - Use instead: [`Player.IsInGroupAsync`](https://rapi.sleaze.dev/classes/Player.md) **Deprecated:** This method has been superseded by [`IsInGroupAsync()`](https://rapi.sleaze.dev/classes/Player.md). Checks whether a player is a member of a group with the given ID. Parameters: - `groupId`: The group ID of the specified group. Returns: A boolean indicating whether the player is in the specified group. ### LoadBoolean ```luau Player:LoadBoolean(key: string): boolean ``` - Tags: Deprecated, Capabilities: Players **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`](https://rapi.sleaze.dev/classes/DataStoreService.md) for new work. Returns a boolean value that was previously saved to the player with [`Player:SaveBoolean()`](https://rapi.sleaze.dev/classes/Player.md) with the same key. Parameters: - `key`: The string key under which the boolean was previously saved. Returns: The saved boolean value, or `false` if the key does not exist. ### LoadCharacter ```luau Player:LoadCharacter() ``` - Tags: Deprecated, Yields, Capabilities: Players - Use instead: [`Player.LoadCharacterAsync`](https://rapi.sleaze.dev/classes/Player.md) **Deprecated:** This method has been superseded by [`LoadCharacterAsync()`](https://rapi.sleaze.dev/classes/Player.md). Creates a new character for the player, removing the old one. Also clears the player's [`Backpack`](https://rapi.sleaze.dev/classes/Backpack.md) and [`PlayerGui`](https://rapi.sleaze.dev/classes/PlayerGui.md). ### LoadCharacterAppearance ```luau Player:LoadCharacterAppearance(assetInstance: Instance) ``` - Tags: Deprecated, Capabilities: AvatarAppearance + Players **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. Parameters: - `assetInstance`: An instance of the asset being loaded, which can be obtained using the [`InsertService:LoadAsset()`](https://rapi.sleaze.dev/classes/InsertService.md) function. ### LoadCharacterWithHumanoidDescription ```luau Player:LoadCharacterWithHumanoidDescription(humanoidDescription: HumanoidDescription, assetTypeVerification: Enum.AssetTypeVerification? = Enum.AssetTypeVerification.Default) ``` - Tags: Deprecated, Yields, Capabilities: Players - Use instead: [`Player.LoadCharacterWithHumanoidDescriptionAsync`](https://rapi.sleaze.dev/classes/Player.md) **Deprecated:** This method has been superseded by [`LoadCharacterWithHumanoidDescriptionAsync()`](https://rapi.sleaze.dev/classes/Player.md). Spawns a player character with everything equipped in the passed in [`HumanoidDescription`](https://rapi.sleaze.dev/classes/HumanoidDescription.md). Parameters: - `humanoidDescription`: A [`HumanoidDescription`](https://rapi.sleaze.dev/classes/HumanoidDescription.md) containing traits like body parts/colors, body scaling, accessories, clothing, and animations that will be equipped to the loaded character. - `assetTypeVerification`: The asset type verification mode. ### LoadData ```luau Player:LoadData() ``` - Tags: Deprecated, Local user security, Capabilities: Players ### LoadInstance ```luau Player:LoadInstance(key: string): Instance ``` - Tags: Deprecated, Capabilities: Players **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`](https://rapi.sleaze.dev/classes/DataStoreService.md) for new work. Returns an instance that was previously saved to the player with [`Player:SaveInstance()`](https://rapi.sleaze.dev/classes/Player.md) with the same key. Parameters: - `key`: The string key under which the instance was previously saved. Returns: The saved [`Instance`](https://rapi.sleaze.dev/classes/Instance.md), or `nil` if the key does not exist. ### LoadNumber ```luau Player:LoadNumber(key: string): number ``` - Tags: Deprecated, Capabilities: Players **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`](https://rapi.sleaze.dev/classes/DataStoreService.md) for new work. Returns a number value that was previously saved to the player. Parameters: - `key`: The string key under which the number was previously saved. Returns: The saved number value, or `0` if the key does not exist. ### LoadString ```luau Player:LoadString(key: string): string ``` - Tags: Deprecated, Capabilities: Players **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`](https://rapi.sleaze.dev/classes/DataStoreService.md) for new work. Returns a string value that was previously saved to the player. Parameters: - `key`: The string key under which the string was previously saved. Returns: The saved string value, or an empty string if the key does not exist. ### SaveBoolean ```luau Player:SaveBoolean(key: string, value: boolean) ``` - Tags: Deprecated, Capabilities: Players **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`](https://rapi.sleaze.dev/classes/DataStoreService.md) for new work. Used to save a boolean value that can be loaded again at a later time using [`Player:LoadBoolean()`](https://rapi.sleaze.dev/classes/Player.md). Parameters: - `key`: The string key to associate with the saved boolean value. - `value`: The boolean value to save. ### SaveData ```luau Player:SaveData() ``` - Tags: Deprecated, Local user security, Capabilities: Players ### SaveInstance ```luau Player:SaveInstance(key: string, value: Instance) ``` - Tags: Deprecated, Capabilities: Players **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`](https://rapi.sleaze.dev/classes/DataStoreService.md) for new work. Saves an instance which can be loaded again at a later time. Parameters: - `key`: The string key to associate with the saved instance. - `value`: The [`Instance`](https://rapi.sleaze.dev/classes/Instance.md) to save. ### SaveNumber ```luau Player:SaveNumber(key: string, value: number) ``` - Tags: Deprecated, Capabilities: Players **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`](https://rapi.sleaze.dev/classes/DataStoreService.md) for new work. Saves a number value that can be loaded again at a later time using. Parameters: - `key`: The string key to associate with the saved number value. - `value`: The number value to save. ### SaveString ```luau Player:SaveString(key: string, value: string) ``` - Tags: Deprecated, Capabilities: Players **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`](https://rapi.sleaze.dev/classes/DataStoreService.md) for new work. Saves a string value that can be loaded again at a later time. Parameters: - `key`: The string key to associate with the saved string value. - `value`: The string value to save. ### SetUnder13 ```luau Player:SetUnder13(value: boolean) ``` - Tags: Deprecated, Roblox engine security, Capabilities: Players ### WaitForDataReady ```luau Player:WaitForDataReady(): boolean ``` - Tags: Deprecated, Yields, Capabilities: Players **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`](https://rapi.sleaze.dev/classes/DataStoreService.md) 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. Returns: A boolean indicating whether the player's data loaded successfully. ### isFriendsWith ```luau Player:isFriendsWith(userId: User): boolean ``` - Tags: Deprecated, Yields, Capabilities: Players - Use instead: [`Player.IsFriendsWith`](https://rapi.sleaze.dev/classes/Player.md) **Deprecated:** This method has been superseded by the [`Player:IsFriendsWithAsync()`](https://rapi.sleaze.dev/classes/Player.md) method which should be used for new work. ### loadBoolean ```luau Player:loadBoolean(key: string): boolean ``` - Tags: Deprecated, Capabilities: Players - Use instead: [`Player.LoadBoolean`](https://rapi.sleaze.dev/classes/Player.md) **Deprecated:** This deprecated function is a variant of [`Player:LoadBoolean()`](https://rapi.sleaze.dev/classes/Player.md) which has also been deprecated. Neither function should be used in new work. ### loadInstance ```luau Player:loadInstance(key: string): Instance ``` - Tags: Deprecated, Capabilities: Players - Use instead: [`Player.LoadInstance`](https://rapi.sleaze.dev/classes/Player.md) **Deprecated:** This deprecated function is a variant of [`Player:LoadInstance()`](https://rapi.sleaze.dev/classes/Player.md) which has also been deprecated. Neither function should be used in new work. ### loadNumber ```luau Player:loadNumber(key: string): number ``` - Tags: Deprecated, Capabilities: Players - Use instead: [`Player.LoadNumber`](https://rapi.sleaze.dev/classes/Player.md) **Deprecated:** This deprecated function is a variant of [`Player:LoadNumber()`](https://rapi.sleaze.dev/classes/Player.md) which has also been deprecated. Neither function should be used in new work. ### loadString ```luau Player:loadString(key: string): string ``` - Tags: Deprecated, Capabilities: Players - Use instead: [`Player.LoadString`](https://rapi.sleaze.dev/classes/Player.md) **Deprecated:** This function is a deprecated variant of [`Player:LoadString()`](https://rapi.sleaze.dev/classes/Player.md) which has also been deprecated. Neither function should be used in new work. ### saveBoolean ```luau Player:saveBoolean(key: string, value: boolean) ``` - Tags: Deprecated, Capabilities: Players - Use instead: [`Player.SaveBoolean`](https://rapi.sleaze.dev/classes/Player.md) **Deprecated:** This function is a deprecated variant of [`Player:SaveBoolean()`](https://rapi.sleaze.dev/classes/Player.md) which has also been deprecated. Neither function should be used in new work. ### saveInstance ```luau Player:saveInstance(key: string, value: Instance) ``` - Tags: Deprecated, Capabilities: Players - Use instead: [`Player.SaveInstance`](https://rapi.sleaze.dev/classes/Player.md) **Deprecated:** This function is a deprecated variant of [`Player:SaveInstance()`](https://rapi.sleaze.dev/classes/Player.md) which has also been deprecated. Neither function should be used in new work. ### saveNumber ```luau Player:saveNumber(key: string, value: number) ``` - Tags: Deprecated, Capabilities: Players - Use instead: [`Player.SaveNumber`](https://rapi.sleaze.dev/classes/Player.md) **Deprecated:** This function is a deprecated variant of [`Player:SaveNumber()`](https://rapi.sleaze.dev/classes/Player.md) which has also been deprecated. Neither function should be used in new work. ### saveString ```luau Player:saveString(key: string, value: string) ``` - Tags: Deprecated, Capabilities: Players - Use instead: [`Player.SaveString`](https://rapi.sleaze.dev/classes/Player.md) **Deprecated:** This function is a deprecated variant of [`Player:SaveString()`](https://rapi.sleaze.dev/classes/Player.md) which has also been deprecated. Neither function should be used in new work. ### waitForDataReady ```luau Player:waitForDataReady(): boolean ``` - Tags: Deprecated, Yields, Capabilities: Players - Use instead: [`Player.WaitForDataReady`](https://rapi.sleaze.dev/classes/Player.md) **Deprecated:** This function is a deprecated variant of [`Player:WaitForDataReady()`](https://rapi.sleaze.dev/classes/Player.md) which has also been deprecated. Neither function should be used in new work. ## Events ### BlockListChanged ```luau Player.BlockListChanged: RBXScriptSignal<()> ``` - Tags: Roblox script security, Capabilities: Players ### CharacterAdded ```luau Player.CharacterAdded: RBXScriptSignal<(character: Model)> ``` - Tags: Capabilities: Players Fires when a player's character spawns or respawns. ### CharacterAppearanceLoaded ```luau Player.CharacterAppearanceLoaded: RBXScriptSignal<(character: Model)> ``` - Tags: Capabilities: Players Fires when the full appearance of a [`Character`](https://rapi.sleaze.dev/classes/Player.md) has been inserted. ### CharacterRemoving ```luau Player.CharacterRemoving: RBXScriptSignal<(character: Model)> ``` - Tags: Capabilities: Players Fires right before a player's character is removed. ### Chatted ```luau Player.Chatted: RBXScriptSignal<(message: string, recipient: Player)> ``` - Tags: Capabilities: Chat + Players Fires when a player chats in experience using Roblox's provided chat bar. ### CloudEditSelectionChanged ```luau Player.CloudEditSelectionChanged: RBXScriptSignal<(newSelection: { any })> ``` - Tags: Roblox script security, Capabilities: Players ### EmotesLoaded ```luau Player.EmotesLoaded: RBXScriptSignal<()> ``` - Tags: Capabilities: Players ### FriendStatusChanged ```luau Player.FriendStatusChanged: RBXScriptSignal<(player: Player, friendStatus: Enum.FriendStatus)> ``` - Tags: Roblox script security, Capabilities: Players ### Idled ```luau Player.Idled: RBXScriptSignal<(time: number)> ``` - Tags: Capabilities: Players This event fires approximately two minutes after the engine classifies the player as idle. Time is the number of seconds that have elapsed since that point. ### InstancePinned ```luau Player.InstancePinned: RBXScriptSignal<(uniqueIdString: string, depth: number)> ``` - Tags: Roblox script security, Capabilities: Players ### InstanceUnpinned ```luau Player.InstanceUnpinned: RBXScriptSignal<(uniqueIdString: string, depth: number)> ``` - Tags: Roblox script security, Capabilities: Players ### Kill ```luau Player.Kill: RBXScriptSignal<()> ``` - Tags: Hidden, Local user security, Capabilities: Players ### NotifyAgeCheckPassedReplicated ```luau Player.NotifyAgeCheckPassedReplicated: RBXScriptSignal<()> ``` - Tags: Hidden, Roblox engine security, Capabilities: Players ### NotifyStreamingUnpinned ```luau Player.NotifyStreamingUnpinned: RBXScriptSignal<(instance: Instance, depth: number)> ``` - Tags: Hidden, Roblox engine security, Capabilities: Players ### OnTeleport ```luau Player.OnTeleport: RBXScriptSignal<(teleportState: Enum.TeleportState, placeId: number, spawnName: string)> ``` - Tags: Capabilities: Players + Teleport Fires when the teleport state of a player changes. ### OnTeleportInternal ```luau Player.OnTeleportInternal: RBXScriptSignal<(teleportState: Enum.TeleportState, teleportInfo: { [string]: any }, customLoadingScreen: Instance)> ``` - Tags: Hidden, Roblox engine security, Capabilities: Players ### OverrideStreamRadii ```luau Player.OverrideStreamRadii: RBXScriptSignal<(minRadius: number, targetRadius: number)> ``` - Tags: Hidden, Roblox engine security, Capabilities: Players ### PauseTeleports ```luau Player.PauseTeleports: RBXScriptSignal<()> ``` - Tags: Hidden, Roblox engine security, Capabilities: Players ### PlayerCharacterLoaded ```luau Player.PlayerCharacterLoaded: RBXScriptSignal<(metrics: { [string]: any })> ``` - Tags: Hidden, Roblox engine security, Capabilities: Players ### PlayerChatTranslationSettingsLocaleSetFromLua ```luau Player.PlayerChatTranslationSettingsLocaleSetFromLua: RBXScriptSignal<(newLocaleId: string)> ``` - Tags: Hidden, Roblox engine security, Capabilities: Players ### PlayerExperienceSettingsLocaleSetFromLua ```luau Player.PlayerExperienceSettingsLocaleSetFromLua: RBXScriptSignal<(newLocaleId: string)> ``` - Tags: Hidden, Roblox engine security, Capabilities: Players ### RemoteFriendRequestSignal ```luau Player.RemoteFriendRequestSignal: RBXScriptSignal<(otherUserId: number, eventType: Enum.FriendRequestEvent)> ``` - Tags: Hidden, Roblox script security, Capabilities: Players ### RemoteInsert ```luau Player.RemoteInsert: RBXScriptSignal<(url: string, position: Vector3)> ``` - Tags: Hidden, Local user security, Capabilities: Players ### RequestStreamingPin ```luau Player.RequestStreamingPin: RBXScriptSignal<(instance: Instance, depth: number)> ``` - Tags: Hidden, Roblox engine security, Capabilities: Players ### RequestStreamingPinByUniqueId ```luau Player.RequestStreamingPinByUniqueId: RBXScriptSignal<(uniqueIdString: string, depth: number)> ``` - Tags: Hidden, Roblox engine security, Capabilities: Players ### ScopeCheckInitiated ```luau Player.ScopeCheckInitiated: RBXScriptSignal<(guid: string, serializedScopes: { any }, metadata: { [string]: any })> ``` - Tags: Hidden, Roblox engine security, Capabilities: Players ### ScriptSecurityError ```luau Player.ScriptSecurityError: RBXScriptSignal<(hash: string, error: string, stack: string)> ``` - Tags: Hidden, Local user security, Capabilities: Players ### SendCameraFrustum ```luau Player.SendCameraFrustum: RBXScriptSignal<(pv: ReplicationPV)> ``` - Tags: Hidden, Roblox engine security, Capabilities: Players ### SendMaxClientBandwidthBps ```luau Player.SendMaxClientBandwidthBps: RBXScriptSignal<(bandwidthBps: number)> ``` - Tags: Hidden, Roblox engine security, Capabilities: Players ### ServerToClientUnfilteredChatReplicate ```luau Player.ServerToClientUnfilteredChatReplicate: RBXScriptSignal<(value: boolean)> ``` - Tags: Hidden, Roblox engine security, Capabilities: Players ### ServerUpdatedHead ```luau Player.ServerUpdatedHead: RBXScriptSignal<(assetType: Enum.AssetType, assetId: number)> ``` - Tags: Hidden, Roblox engine security, Capabilities: Players ### SetShutdownMessage ```luau Player.SetShutdownMessage: RBXScriptSignal<(message: string, metadata: { [string]: any })> ``` - Tags: Hidden, Roblox engine security, Capabilities: Players ### SimulationRadiusChanged ```luau Player.SimulationRadiusChanged: RBXScriptSignal<(radius: number)> ``` - Tags: Local user security, Capabilities: Players ### StatsAvailable ```luau Player.StatsAvailable: RBXScriptSignal<(info: string)> ``` - Tags: Hidden, Local user security, Capabilities: Players ### StreamingPinComplete ```luau Player.StreamingPinComplete: RBXScriptSignal<(instance: Instance)> ``` - Tags: Roblox script security, Capabilities: Players ### UnpinStreaming ```luau Player.UnpinStreaming: RBXScriptSignal<(instance: Instance, depth: number)> ``` - Tags: Hidden, Roblox engine security, Capabilities: Players ### iradDebugServerReceivedIradRequest ```luau Player.iradDebugServerReceivedIradRequest: RBXScriptSignal<(minRadius: number, targetRadius: number, interfaceExists: boolean)> ``` - Tags: Hidden, Roblox engine security, Capabilities: Players ## Inherited members - From [Instance](https://rapi.sleaze.dev/classes/Instance.md): `Archivable`, `archivable`, `Attributes`, `AttributesReplicate`, `AttributesSerialize`, `HistoryId`, `Name`, `Parent`, `PredictionMode`, `PropertyStatusStudio`, `RobloxLocked`, `SerializedOverrides`, `SourceAssetId`, `Tags`, `UniqueId`, `numExpectedDirectChildren`, `DataCost`, `Capabilities`, `DefinesCapabilities`, `IsInSandbox`, `Sandboxed`, `AddTag`, `ClearAllChildren`, `Clone`, `Destroy`, `FindFirstAncestor`, `FindFirstAncestorOfClass`, `FindFirstAncestorWhichIsA`, `FindFirstChild`, `FindFirstChildOfClass`, `FindFirstChildWhichIsA`, `FindFirstDescendant`, `GetActor`, `GetAttribute`, `GetAttributeChangedSignal`, `GetAttributes`, `GetChildren`, `GetDebugId`, `GetDescendants`, `GetFullName`, `GetStyled`, `GetStyledPropertyChangedSignal`, `GetTags`, `HasTag`, `IsAncestorOf`, `IsDescendantOf`, `IsPropertyModified`, `QueryDescendants`, `RemoveTag`, `ResetPropertyToDefault`, `SetAttribute`, `WaitForChild`, `Remove`, `children`, `clone`, `destroy`, `findFirstChild`, `getChildren`, `isDescendantOf`, `remove`, `AncestryChanged`, `AttributeChanged`, `ChildAdded`, `ChildRemoved`, `DescendantAdded`, `DescendantRemoving`, `Destroying`, `StyledPropertiesChanged`, `childAdded` - From [Object](https://rapi.sleaze.dev/classes/Object.md): `ClassName`, `className`, `GetPropertyChangedSignal`, `IsA`, `isA`, `Changed`