# StarterPlayer 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) - Tags: Not creatable, Service - Memory category: Instances - HTML page: https://rapi.sleaze.dev/classes/StarterPlayer/ - Roblox documentation: https://create.roblox.com/docs/reference/engine/classes/StarterPlayer A service which allows the defaults of properties in the [`Player`](https://rapi.sleaze.dev/classes/Player.md) object to be set. ## Properties ### CameraMaxZoomDistance ```luau StarterPlayer.CameraMaxZoomDistance: number = 400 ``` - Tags: Read capabilities: Players The maximum distance the player's default camera is allowed to zoom out in studs. ### CameraMinZoomDistance ```luau StarterPlayer.CameraMinZoomDistance: number = 0.5 ``` - Tags: Read capabilities: Players The minimum distance in studs the player's default camera is allowed to zoom in. ### CameraMode ```luau StarterPlayer.CameraMode: Enum.CameraMode = Enum.CameraMode.Classic ``` - Tags: Read capabilities: Players Changes the default camera's mode to either first or third person. ### DevCameraOcclusionMode ```luau StarterPlayer.DevCameraOcclusionMode: Enum.DevCameraOcclusionMode = Enum.DevCameraOcclusionMode.Zoom ``` - Tags: Read capabilities: Players Sets how the default camera handles objects between the camera and the player. ### DevComputerCameraMovementMode ```luau StarterPlayer.DevComputerCameraMovementMode: Enum.DevComputerCameraMovementMode = Enum.DevComputerCameraMovementMode.UserChoice ``` - Tags: Read capabilities: Players Lets you overwrite the player's camera mode on a computer. ### DevTouchCameraMovementMode ```luau StarterPlayer.DevTouchCameraMovementMode: Enum.DevTouchCameraMovementMode = Enum.DevTouchCameraMovementMode.UserChoice ``` - Tags: Read capabilities: Players Lets you overwrite the player's camera mode on a touch-enabled device. ### AllowCustomAnimations ```luau StarterPlayer.AllowCustomAnimations: boolean = true ``` - Tags: Hidden, Write: Roblox script security, Read capabilities: Players Describes the current game's permission levels regarding custom avatar animations from the website. ### AvatarJointUpgrade ```luau StarterPlayer.AvatarJointUpgrade: Enum.RolloutState = Enum.RolloutState.Default ``` - Tags: Not replicated, Roblox script security, Read capabilities: Players Controls whether avatars spawn with [`AnimationConstraint`](https://rapi.sleaze.dev/classes/AnimationConstraint.md) joints for physical simulation. ### AvatarJointUpgrade_SerializedRollout ```luau StarterPlayer.AvatarJointUpgrade_SerializedRollout: Enum.RolloutState = Enum.RolloutState.Default ``` - Tags: Hidden, Not scriptable, Read capabilities: Players ### CharacterBreakJointsOnDeath ```luau StarterPlayer.CharacterBreakJointsOnDeath: boolean = true ``` - Tags: Read capabilities: Players Determines the starting value of [`Humanoid.BreakJointsOnDeath`](https://rapi.sleaze.dev/classes/Humanoid.md) for [`Player.Character`](https://rapi.sleaze.dev/classes/Player.md). ### CharacterMaxSlopeAngle ```luau StarterPlayer.CharacterMaxSlopeAngle: number = 89 ``` - Tags: Read capabilities: Players Determines the starting value of [`Humanoid.MaxSlopeAngle`](https://rapi.sleaze.dev/classes/Humanoid.md) for [`Player.Character`](https://rapi.sleaze.dev/classes/Player.md). ### CharacterWalkSpeed ```luau StarterPlayer.CharacterWalkSpeed: number = 16 ``` - Tags: Read capabilities: Players Determines the starting value of [`Humanoid.WalkSpeed`](https://rapi.sleaze.dev/classes/Humanoid.md) for [`Player.Character`](https://rapi.sleaze.dev/classes/Player.md). ### ClassicDeath ```luau StarterPlayer.ClassicDeath: boolean = true ``` - Tags: Read capabilities: Players Controls whether the character uses the classic death behavior when the Humanoid's health reaches zero. ### EnableDynamicHeads ```luau StarterPlayer.EnableDynamicHeads: Enum.LoadDynamicHeads = Enum.LoadDynamicHeads.Default ``` - Tags: Not scriptable, Read capabilities: Players Sets the use of dynamic heads. When true, enables the use of avatar heads with facial animation data. ### GameSettingsAvatar ```luau StarterPlayer.GameSettingsAvatar: Enum.GameAvatarType = Enum.GameAvatarType.R15 ``` - Tags: Hidden, Roblox script security, Read capabilities: Players ### GameSettingsR15Collision ```luau StarterPlayer.GameSettingsR15Collision: Enum.R15CollisionType = Enum.R15CollisionType.OuterBox ``` - Tags: Hidden, Not replicated, Roblox script security, Read capabilities: Players ### LoadCharacterAppearance ```luau StarterPlayer.LoadCharacterAppearance: boolean = true ``` - Tags: Read capabilities: Players Whether or not the appearance of a player's character should be loaded. ### LoadCharacterLayeredClothing ```luau StarterPlayer.LoadCharacterLayeredClothing: Enum.LoadCharacterLayeredClothing = Enum.LoadCharacterLayeredClothing.Default ``` - Tags: Hidden, Not scriptable, Read capabilities: Players ### LoadCharacterLayeredClothing ```luau StarterPlayer.LoadCharacterLayeredClothing : Enum.LoadCharacterLayeredClothing = Enum.LoadCharacterLayeredClothing.Default ``` - Tags: Not replicated, Not scriptable, Read capabilities: Players Indicates whether characters spawning into an experience will have layered clothing accessories equipped on them. ### PlaceAvatarRules ```luau StarterPlayer.PlaceAvatarRules: Instance ``` - Tags: Read capabilities: AvatarAppearance + Players, Write capabilities: AvatarAppearance ### UseImprovedCharacterEvents ```luau StarterPlayer.UseImprovedCharacterEvents: Enum.RolloutState = Enum.RolloutState.Default ``` - Tags: Not scriptable, Roblox script security, Read capabilities: Players ### UserEmotesEnabled ```luau StarterPlayer.UserEmotesEnabled: boolean = true ``` - Tags: Read capabilities: Players Determines if user-owned emotes are loaded when loading avatars. ### CharacterJumpHeight ```luau StarterPlayer.CharacterJumpHeight: number = 7.19999981 ``` - Tags: Read capabilities: Players Determines the starting value of [`Humanoid.JumpHeight`](https://rapi.sleaze.dev/classes/Humanoid.md) for [`Player.Character`](https://rapi.sleaze.dev/classes/Player.md). ### CharacterJumpPower ```luau StarterPlayer.CharacterJumpPower: number = 50 ``` - Tags: Read capabilities: Players Determines the starting value of [`Humanoid.JumpPower`](https://rapi.sleaze.dev/classes/Humanoid.md) for [`Player.Character`](https://rapi.sleaze.dev/classes/Player.md). ### CharacterUseJumpPower ```luau StarterPlayer.CharacterUseJumpPower: boolean = true ``` - Tags: Read capabilities: Players Determines the starting state of [`Humanoid.UseJumpPower`](https://rapi.sleaze.dev/classes/Humanoid.md) for [`Player.Character`](https://rapi.sleaze.dev/classes/Player.md). ### CreateDefaultPlayerModule ```luau StarterPlayer.CreateDefaultPlayerModule: boolean = true ``` - Tags: Roblox script security, Read capabilities: Players Controls how the default player module and related scripts are handled. ### DevComputerMovementMode ```luau StarterPlayer.DevComputerMovementMode: Enum.DevComputerMovementMode = Enum.DevComputerMovementMode.UserChoice ``` - Tags: Read capabilities: Players Lets you overwrite the player's movement mode on a computer. ### DevTouchMovementMode ```luau StarterPlayer.DevTouchMovementMode: Enum.DevTouchMovementMode = Enum.DevTouchMovementMode.UserChoice ``` - Tags: Read capabilities: Players Lets you overwrite the player's movement mode on a touch-enabled device. ### EnableMouseLockOption ```luau StarterPlayer.EnableMouseLockOption: boolean = true ``` - Tags: Read capabilities: Players Determines if a player can toggle mouse lock by default. ### LuaCharacterController ```luau StarterPlayer.LuaCharacterController: Enum.CharacterControlMode = Enum.CharacterControlMode.Default ``` - Tags: Read capabilities: Players Sets the character controller mode used by the player's character. ### HealthDisplayDistance ```luau StarterPlayer.HealthDisplayDistance: number = 100 ``` - Tags: Read capabilities: Players Sets the distance at which this player will see other [`Humanoid`](https://rapi.sleaze.dev/classes/Humanoid.md) health bars. If set to 0, the health bars will not be displayed. ### NameDisplayDistance ```luau StarterPlayer.NameDisplayDistance: number = 100 ``` - Tags: Read capabilities: Players Sets the distance at which this player will see other [`Humanoid`](https://rapi.sleaze.dev/classes/Humanoid.md) names. ### PlayerModuleStatus ```luau StarterPlayer.PlayerModuleStatus: number = 0 ``` - Tags: Hidden, Roblox script security, Read capabilities: Players ### AutoJumpEnabled ```luau StarterPlayer.AutoJumpEnabled: boolean = true ``` - Tags: Read capabilities: Players Sets whether the character will automatically jump when hitting an obstacle on a mobile device. ## Methods ### ClearDefaults ```luau StarterPlayer:ClearDefaults() ``` - Tags: Roblox script 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`