StarterPlayer

StarterPlayer
Not creatableThis class cannot be instantiated. ServiceThis class is a service.
Icon
Legacy IconsThese icon(s) are only a part of legacy Roblox Studio versions, or are unused as of the studio icons update.
Added in	172 (October 2014)
Memory category	Instances
Inheritance
Instance StarterPlayer

The StarterPlayer class, added on October 16, 2014, inherits from Instance. This class contains properties that can be edited, that will occur for all players in the place. A cool trick to know is that you can override a player's appearance by setting “LoadCharacterAppearance” to false and customize the model to make it how you want it to look like. Make a dummy and modify it, or make a model of a player or yourself with a plug-in. Next, name the model “StarterCharacter” and place it in StarterPlayer. Play, and voilà! Your appearance has been overridden! Great if you want it for like outfits.

Properties

AllowCustomAnimations: bool

• HiddenThis property is not shown in the object browser and properties window.

This class member is missing documentation. Create or add to its subpage at Class:StarterPlayer/AllowCustomAnimations.

• Category: Character.
• Write security: RobloxScriptSecurity.
• Serialization: can save and load.
• Thread safety: read safe

AnimationCompositorMode: AnimationCompositorMode

• Not browsableThis member is not visible in documentation for end-users.

This class member is missing documentation. Create or add to its subpage at Class:StarterPlayer/AnimationCompositorMode.

• Category: Character.
• Serialization: can save and load.
• Thread safety: read safe

AutoJumpEnabled: bool

Determines the default Player.AutoJumpEnabled value for Players that join the game. Changing this value during runtime will only affect Players that join after the change.

• Category: Mobile.
• Serialization: can save and load.
• Thread safety: read safe

AvatarJointUpgrade: AvatarJointUpgrade

• Not replicatedThis member is not replicated across the network boundary.
• Not browsableThis member is not visible in documentation for end-users.

This class member is missing documentation. Create or add to its subpage at Class:StarterPlayer/AvatarJointUpgrade.

• Category: Character.
• Serialization: cannot load or save.
• Thread safety: read safe

CameraMaxZoomDistance: float

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:StarterPlayer/CameraMaxZoomDistance.

• Category: Camera.
• Serialization: can save and load.
• Thread safety: read safe

CameraMinZoomDistance: float

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:StarterPlayer/CameraMinZoomDistance.

• Category: Camera.
• Serialization: can save and load.
• Thread safety: read safe

CameraMode: CameraMode

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:StarterPlayer/CameraMode.

• Category: Camera.
• Serialization: can save and load.
• Thread safety: read safe

CharacterJumpHeight: float

Determines the default Humanoid.JumpHeight value for Humanoids that are created for a Player Character. Defaults to 7.2. Changing this value during runtime will only affect Humanoids created after the change.

• Category: Character Jump Settings.
• Serialization: can save and load.
• Thread safety: read safe

CharacterJumpPower: float

Determines the default Humanoid.JumpPower value for Humanoids that are created for a Player Character. Defaults to 50 and is clamped between 0 and 1,000. Changing this value during runtime will only affect Humanoids created after the change.

• Category: Character Jump Settings.
• Serialization: can save and load.
• Thread safety: read safe

CharacterMaxSlopeAngle: float

This class member is missing documentation. Create or add to its subpage at Class:StarterPlayer/CharacterMaxSlopeAngle.

• Category: Character.
• Serialization: can save and load.
• Thread safety: read safe

CharacterUseJumpPower: bool

This class member is missing documentation. Create or add to its subpage at Class:StarterPlayer/CharacterUseJumpPower.

• Category: Character Jump Settings.
• Serialization: can save and load.
• Thread safety: read safe

CharacterWalkSpeed: float

Determines the default Humanoid.WalkSpeed value for Humanoids that are created for a Player Character. Defaults to 16. Changing this value during runtime will only affect Humanoids created after the change.

• Category: Character.
• Serialization: can save and load.
• Thread safety: read safe

DeathStyle: DeathStyle

• Not browsableThis member is not visible in documentation for end-users.

This class member is missing documentation. Create or add to its subpage at Class:StarterPlayer/DeathStyle.

• Category: Character.
• Serialization: can save and load.
• Thread safety: read safe

DevCameraOcclusionMode: DevCameraOcclusionMode

This class member is missing documentation. Create or add to its subpage at Class:StarterPlayer/DevCameraOcclusionMode.

• Category: Camera.
• Serialization: can save and load.
• Thread safety: read safe

DevComputerCameraMovementMode: DevComputerCameraMovementMode

This class member is missing documentation. Create or add to its subpage at Class:StarterPlayer/DevComputerCameraMovementMode.

• Category: Camera.
• Serialization: can save and load.
• Thread safety: read safe

DevComputerMovementMode: DevComputerMovementMode

This class member is missing documentation. Create or add to its subpage at Class:StarterPlayer/DevComputerMovementMode.

• Category: Controls.
• Serialization: can save and load.
• Thread safety: read safe

DevTouchCameraMovementMode: DevTouchCameraMovementMode

This class member is missing documentation. Create or add to its subpage at Class:StarterPlayer/DevTouchCameraMovementMode.

• Category: Camera.
• Serialization: can save and load.
• Thread safety: read safe

DevTouchMovementMode: DevTouchMovementMode

This class member is missing documentation. Create or add to its subpage at Class:StarterPlayer/DevTouchMovementMode.

• Category: Controls.
• Serialization: can save and load.
• Thread safety: read safe

EnableDynamicHeads: LoadDynamicHeads

• Not scriptableThis member cannot be accessed by Lua code.

This class member is missing documentation. Create or add to its subpage at Class:StarterPlayer/EnableDynamicHeads.

• Category: Character.
• Serialization: can save and load.
• Thread safety: read safe

EnableMouseLockOption: bool

Determines the default Player.DevEnableMouseLock value for Players that join the game. Changing this value during runtime will only affect Players that join after the change.

• Category: Controls.
• Serialization: can save and load.
• Thread safety: read safe

GameSettingsAssetIDFace: int64

• HiddenThis property is not shown in the object browser and properties window.
• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:StarterPlayer/GameSettingsAssetIDFace.

• Category: Character.
• Read security: RobloxScriptSecurity.
• Write security: RobloxScriptSecurity.
• Serialization: can save and load.
• Thread safety: read safe

GameSettingsAssetIDHead: int64

• HiddenThis property is not shown in the object browser and properties window.
• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:StarterPlayer/GameSettingsAssetIDHead.

• Category: Character.
• Read security: RobloxScriptSecurity.
• Write security: RobloxScriptSecurity.
• Serialization: can save and load.
• Thread safety: read safe

GameSettingsAssetIDLeftArm: int64

• HiddenThis property is not shown in the object browser and properties window.
• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:StarterPlayer/GameSettingsAssetIDLeftArm.

• Category: Character.
• Read security: RobloxScriptSecurity.
• Write security: RobloxScriptSecurity.
• Serialization: can save and load.
• Thread safety: read safe

GameSettingsAssetIDLeftLeg: int64

• HiddenThis property is not shown in the object browser and properties window.
• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:StarterPlayer/GameSettingsAssetIDLeftLeg.

• Category: Character.
• Read security: RobloxScriptSecurity.
• Write security: RobloxScriptSecurity.
• Serialization: can save and load.
• Thread safety: read safe

GameSettingsAssetIDPants: int64

• HiddenThis property is not shown in the object browser and properties window.
• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:StarterPlayer/GameSettingsAssetIDPants.

• Category: Character.
• Read security: RobloxScriptSecurity.
• Write security: RobloxScriptSecurity.
• Serialization: can save and load.
• Thread safety: read safe

GameSettingsAssetIDRightArm: int64

• HiddenThis property is not shown in the object browser and properties window.
• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:StarterPlayer/GameSettingsAssetIDRightArm.

• Category: Character.
• Read security: RobloxScriptSecurity.
• Write security: RobloxScriptSecurity.
• Serialization: can save and load.
• Thread safety: read safe

GameSettingsAssetIDRightLeg: int64

• HiddenThis property is not shown in the object browser and properties window.
• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:StarterPlayer/GameSettingsAssetIDRightLeg.

• Category: Character.
• Read security: RobloxScriptSecurity.
• Write security: RobloxScriptSecurity.
• Serialization: can save and load.
• Thread safety: read safe

GameSettingsAssetIDShirt: int64

• HiddenThis property is not shown in the object browser and properties window.
• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:StarterPlayer/GameSettingsAssetIDShirt.

• Category: Character.
• Read security: RobloxScriptSecurity.
• Write security: RobloxScriptSecurity.
• Serialization: can save and load.
• Thread safety: read safe

GameSettingsAssetIDTeeShirt: int64

• HiddenThis property is not shown in the object browser and properties window.
• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:StarterPlayer/GameSettingsAssetIDTeeShirt.

• Category: Character.
• Read security: RobloxScriptSecurity.
• Write security: RobloxScriptSecurity.
• Serialization: can save and load.
• Thread safety: read safe

GameSettingsAssetIDTorso: int64

• HiddenThis property is not shown in the object browser and properties window.
• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:StarterPlayer/GameSettingsAssetIDTorso.

• Category: Character.
• Read security: RobloxScriptSecurity.
• Write security: RobloxScriptSecurity.
• Serialization: can save and load.
• Thread safety: read safe

GameSettingsAvatar: GameAvatarType

• HiddenThis property is not shown in the object browser and properties window.
• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:StarterPlayer/GameSettingsAvatar.

• Category: Character.
• Read security: RobloxScriptSecurity.
• Write security: RobloxScriptSecurity.
• Serialization: can save and load.
• Thread safety: read safe

GameSettingsR15Collision: R15CollisionType

• HiddenThis property is not shown in the object browser and properties window.
• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:StarterPlayer/GameSettingsR15Collision.

• Category: Character.
• Read security: RobloxScriptSecurity.
• Write security: RobloxScriptSecurity.
• Serialization: can save and load.
• Thread safety: read safe

GameSettingsScaleRangeBodyType: NumberRange

• HiddenThis property is not shown in the object browser and properties window.
• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:StarterPlayer/GameSettingsScaleRangeBodyType.

• Category: Character.
• Read security: RobloxScriptSecurity.
• Write security: RobloxScriptSecurity.
• Serialization: can save and load.
• Thread safety: read safe

GameSettingsScaleRangeHead: NumberRange

• HiddenThis property is not shown in the object browser and properties window.
• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:StarterPlayer/GameSettingsScaleRangeHead.

• Category: Character.
• Read security: RobloxScriptSecurity.
• Write security: RobloxScriptSecurity.
• Serialization: can save and load.
• Thread safety: read safe

GameSettingsScaleRangeHeight: NumberRange

• HiddenThis property is not shown in the object browser and properties window.
• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:StarterPlayer/GameSettingsScaleRangeHeight.

• Category: Character.
• Read security: RobloxScriptSecurity.
• Write security: RobloxScriptSecurity.
• Serialization: can save and load.
• Thread safety: read safe

GameSettingsScaleRangeProportion: NumberRange

• HiddenThis property is not shown in the object browser and properties window.
• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:StarterPlayer/GameSettingsScaleRangeProportion.

• Category: Character.
• Read security: RobloxScriptSecurity.
• Write security: RobloxScriptSecurity.
• Serialization: can save and load.
• Thread safety: read safe

GameSettingsScaleRangeWidth: NumberRange

• HiddenThis property is not shown in the object browser and properties window.
• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:StarterPlayer/GameSettingsScaleRangeWidth.

• Category: Character.
• Read security: RobloxScriptSecurity.
• Write security: RobloxScriptSecurity.
• Serialization: can save and load.
• Thread safety: read safe

HealthDisplayDistance: float

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:StarterPlayer/HealthDisplayDistance.

• Category: Data.
• Serialization: can save and load.
• Thread safety: read safe

HumanoidStateMachineMode: HumanoidStateMachineMode

• Not browsableThis member is not visible in documentation for end-users.

This class member is missing documentation. Create or add to its subpage at Class:StarterPlayer/HumanoidStateMachineMode.

• Category: Controls.
• Serialization: can save and load.
• Thread safety: read safe

LoadCharacterAppearance: bool

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:StarterPlayer/LoadCharacterAppearance.

• Category: Character.
• Serialization: can save and load.
• Thread safety: read safe

LoadCharacterLayeredClothing : LoadCharacterLayeredClothing

• Not replicatedThis member is not replicated across the network boundary.
• Not scriptableThis member cannot be accessed by Lua code.

This class member is missing documentation. Create or add to its subpage at Class:StarterPlayer/LoadCharacterLayeredClothing .

• Category: Character.
• Serialization: cannot load or save.
• Thread safety: read safe

LuaCharacterController: CharacterControlMode

• Not browsableThis member is not visible in documentation for end-users.

This class member is missing documentation. Create or add to its subpage at Class:StarterPlayer/LuaCharacterController.

• Category: Controls.
• Serialization: can save and load.
• Thread safety: read safe

NameDisplayDistance: float

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:StarterPlayer/NameDisplayDistance.

• Category: Data.
• Serialization: can save and load.
• Thread safety: read safe

UserEmotesEnabled: bool

This class member is missing documentation. Create or add to its subpage at Class:StarterPlayer/UserEmotesEnabled.

• Category: Character.
• Serialization: can save and load.
• Thread safety: read safe

Methods

ClearDefaults(): null

This class member is missing documentation. Create or add to its subpage at Class:StarterPlayer/ClearDefaults.

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

Removed members

Properties

• GameSettingsAvatarType
• GameSettingsR15CollisionType
• GameSettingsScaleBodyType
• GameSettingsScaleHead
• GameSettingsScaleHeight
• GameSettingsScaleProportion
• GameSettingsScaleWidth
• LoadCharacterLayeredClothing
• ScreenOrientation

Events

• ScreenOrientationChanged

External links

• StarterPlayer in the Roblox Creator Documentation
• StarterPlayer in the Roblox API Reference