StarterPlayer¶
A service which allows the defaults of properties in the Player object to be set.
Description¶
A service which allows the defaults of properties in the Player object to be set. When a player enters the server, each property of the player object is set to the current value of the corresponding property in StarterPlayer.
Additionally, you may add four objects to this service:
- A StarterPlayerScripts instance with scripts that run once for each player.
- A StarterCharacterScripts instance with scripts to add to each player's character every time they spawn.
- A Humanoid instance named
StarterHumanoidwhich will be used as the default humanoid for each player's character. - A Model instance named
StarterCharacterwhich will be used as the character model for all players.
Inheritance¶
Object → Instance → StarterPlayer
Nova inheritance: Instance → StarterPlayer
Properties¶
AutoJumpEnabled Supported Property Sets whether the character will automatically jump when hitting an obstacle on a mobile device.
This property sets whether the character will automatically jump when hitting an obstacle on a mobile device.
This property is copied from the StarterPlayer to a Player when they join the game. Following that. the value of this property is copied to Humanoid.AutoJumpEnabled property of the character's Humanoid on spawn. In other words, it is possible to set the auto-jump behavior on a per-character, per-player and per-game basis using these three properties.
CameraMaxZoomDistance Supported Property The maximum distance the player's default camera is allowed to zoom out in studs.
The maximum distance the player's default camera is allowed to zoom out in studs.
This property sets the maximum distance in studs the camera can be from the character with the default cameras.
This property sets the default value of Player.CameraMaxZoomDistance for each player who joins the game. If this value is set to a lower value than StarterPlayer.CameraMinZoomDistance it will be increased to CameraMinZoomDistance.
CameraMinZoomDistance Supported Property The minimum distance in studs the player's default camera is allowed to zoom in.
The minimum distance in studs the player's default camera is allowed to zoom in.
This property sets the minimum distance in studs the camera can be from the character with the default cameras.
This property sets the default value of Player.CameraMinZoomDistance for each player who joins the game. If this value is set to a higher value than StarterPlayer.CameraMaxZoomDistance it will be decreased to CameraMaxZoomDistance.
CameraMode Supported Property Changes the default camera's mode to either first or third person.
Changes the default camera's mode to either first or third person.
Sets the default value for Player.CameraMode for each player in the game. The camera has two modes:
First Person¶
In first person mode, the player's camera is zoomed all the way in. Unless
there is a visible GUI present with the GuiButton.Modal property
set to true, the mouse will be locked and the user's camera will turn as
the mouse moves.
Third Person¶
In third person mode (default), the character can be seen in the camera. While in third person mode on Roblox:
- You may right-click and drag to rotate your camera, or use the arrow keys at the bottom right-hand corner of the screen.
- When you move your mouse, your camera does not change (unless you move the mouse to the end of the screen).
- When you press any of the arrow keys, the user's character will face in the corresponding arrow key's direction.
- You can zoom in and out freely.
DevCameraOcclusionMode Supported Property Sets how the default camera handles objects between the camera and the player.
Sets how the default camera handles objects between the camera and the player.
Defines how the default camera scripts handle objects between the camera and the camera subject. Applies to all players as they join the experience and can't be changed for individual players.
The default value is Zoom (0). See DevCameraOcclusionMode for a list of available modes.
DevComputerCameraMovementMode Supported Property Lets you overwrite the player's camera mode on a computer.
This property lets you overwrite the player's camera mode on a computer.
If set to UserChoice, the player's camera movement mode will be determined by whatever they set in the experience's settings. Otherwise, the mode will be set based on this property.
This property does not affect players who are not on a computer.
DevComputerMovementMode Supported Property Lets you overwrite the player's movement mode on a computer.
This property lets you overwrite the player's movement mode on a computer.
If set to UserChoice, the player's movement mode will be determined by whatever they set in the experience's settings. Otherwise, the mode will be set based on this property.
This property does not affect players who are not on a computer.
DevTouchCameraMovementMode Supported Property Lets you overwrite the player's camera mode on a touch-enabled device.
This property lets you overwrite the player's camera mode on a touch-enabled device.
If set to UserChoice, the player's camera movement mode will be determined by whatever they set in the experience's settings. Otherwise, the mode will be set based on this property.
This property does not affect players who are not on a touch-enabled device.
DevTouchMovementMode Supported Property Lets you overwrite the player's movement mode on a touch-enabled device.
Lets you overwrite the player's movement mode on a touch-enabled device.
If set to UserChoice, the player's movement mode will be determined by whatever they set in the experience's settings. Otherwise, the mode will be set based on this property.
This property does not affect players who are not on a touch-enabled device.
EnableMouseLockOption Supported Property Determines if a player can toggle mouse lock by default.
This property determines if a player can toggle mouse lock by default.
Mouselock will lock the player's cursor to the center of the screen. Moving the mouse will rotate the Camera and Player will move relative to the current rotation of the camera.
This property sets the value of Player.DevEnableMouseLock.
Note that shift-lock related APIs are in the process of being deprecated, so it's recommended to use UserInputService.MouseBehavior instead to lock the mouse.
HealthDisplayDistance Supported Property Sets the distance at which this player will see other Humanoid health bars. If set to 0, the health bars will not be displayed.
Sets the distance at which this player will see other Humanoid health bars. If set to 0, the health bars will not be displayed.
This property sets the distance in studs at which this player will see other Humanoid health bars. If set to 0, the health bars will not be displayed. This property is set to 100 studs by default.
To change the display distance for a player once they join the game, you can set the Player.HealthDisplayDistance property.
If a Humanoid health bar is visible, you can set the display type using Humanoid.DisplayDistanceType.
LoadCharacterAppearance Supported Property Whether or not the appearance of a player's character should be loaded.
This property sets whether or not the appearance of a player's character should be loaded.
Setting this to false results in the player having no clothes (including
hats), body colors, body packages or anything else related to the
appearance of the player's avatar. By default, this property is set to
true.
Setting this to true results in the player loading the appearance
corresponding to the player's Player.CharacterAppearanceId.
If Player.LoadCharacterWithHumanoidDescriptionAsync() is used, it can be advantageous to set StarterPlayer.LoadCharacterAppearance to false as the player's avatar is not required as all asset IDs to equip on the character will come from the passed in HumanoidDescription.
MaxVirtualVersion Supported Property
MinVirtualVersion Supported Property
NameDisplayDistance Supported Property Sets the distance at which this player will see other Humanoid names.
Sets the distance at which this player will see other Humanoid
names. If set to 0, names are hidden. This property is set to 100
studs by default.
To change the display distance for a player once they join the game, you can set the Player.NameDisplayDistance property.
If a Humanoid name is visible, you can set the display type using Humanoid.DisplayDistanceType.
Inherited members¶
Inherited from Instance: 8 properties, 36 methods, 7 events. They are documented on the base class page.
11 modern Roblox member(s) are not implemented yet — expand to inspect
Members declared by Roblox's StarterPlayer class (or by a missing base class) that Nova does not expose. Use this list to scope a migration; the compatibility guide has the recommended workaround.
Properties¶
| Member | Signature | Status | Notes | Flags |
|---|---|---|---|---|
AvatarJointUpgrade |
AvatarJointUpgrade: RolloutState |
Not yet | Controls whether avatars spawn with AnimationConstraint joints for physical simulation. | NotReplicated, RobloxScriptSecurity |
CharacterBreakJointsOnDeath |
CharacterBreakJointsOnDeath: bool |
Not yet | Determines the starting value of Humanoid.BreakJointsOnDeath for Player.Character. | — |
CharacterJumpHeight |
CharacterJumpHeight: float |
Not yet | Determines the starting value of Humanoid.JumpHeight for Player.Character. | — |
CharacterJumpPower |
CharacterJumpPower: float |
Not yet | Determines the starting value of Humanoid.JumpPower for Player.Character. | — |
CharacterMaxSlopeAngle |
CharacterMaxSlopeAngle: float |
Not yet | Determines the starting value of Humanoid.MaxSlopeAngle for Player.Character. | — |
CharacterUseJumpPower |
CharacterUseJumpPower: bool |
Not yet | Determines the starting state of Humanoid.UseJumpPower for Player.Character. | — |
CharacterWalkSpeed |
CharacterWalkSpeed: float |
Not yet | Determines the starting value of Humanoid.WalkSpeed for Player.Character. | — |
ClassicDeath |
ClassicDeath: bool |
Not yet | Controls whether the character uses the classic death behavior when the Humanoid's health reaches zero. | — |
LuaCharacterController |
LuaCharacterController: CharacterControlMode |
Not yet | Sets the character controller mode used by the player's character. | — |
UserEmotesEnabled |
UserEmotesEnabled: bool |
Not yet | Determines if user-owned emotes are loaded when loading avatars. | — |
Methods¶
| Member | Signature | Status | Notes | Flags |
|---|---|---|---|---|
ClearDefaults |
StarterPlayer:ClearDefaults(): null |
Not yet | — | RobloxScriptSecurity |
Roblox reference: StarterPlayer
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.