PcoWSkbVqDnWTu_dm2ix
We use cookies on this site to enhance your user experience
Collapse Sidebar

StarterPlayer

Show deprecated

StarterPlayer

Show deprecated

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 StarterHumanoid, which will be used as the default humanoid for each player’s character.
  • A Model instance named StarterCharacter, which will be used as the character model for all players

A typical structure may look something like this:
StarterPlayer Tree

Properties

bool

AllowCustomAnimations

[Hidden]

Describes the current game’s permission levels regarding custom avatar animations from the website

bool

AutoJumpEnabled

Sets whether the character will automatically jump when hitting an obstacle on a mobile device.

float

CameraMaxZoomDistance

The maximum distance the player’s default camera is allowed to zoom out in studs.

float

CameraMinZoomDistance

The minimum distance in studs the player’s default camera is allowed to zoom in.

CameraMode

CameraMode

Changes the default camera’s mode to either first or third person.

float

CharacterJumpHeight

float

CharacterJumpPower

float

CharacterMaxSlopeAngle

bool

CharacterUseJumpPower

float

CharacterWalkSpeed

DevCameraOcclusionMode

DevCameraOcclusionMode

Sets how the default camera handles objects between the camera and the player.

DevComputerCameraMovementMode

DevComputerCameraMovementMode

Lets developer overwrite the default camera mode for each player if the player is on a computer.

DevComputerMovementMode

DevComputerMovementMode

Lets developer overwrite the player’s movement mode if the player is on a computer.

DevTouchCameraMovementMode

DevTouchCameraMovementMode

Lets developer overwrite the default camera movement mode for each player if the player is on a mobile device.

DevTouchMovementMode

DevTouchMovementMode

Lets developer overwrite the player’s movement mode if the player is on a touch device.

bool

EnableMouseLockOption

Determines if a player can toggle mouse lock by default.

float

HealthDisplayDistance

Sets the distance at which this player will see other Humanoid’s health bars. If set to 0, the health bars will not be displayed.

bool

LoadCharacterAppearance

Whether or not the appearance of a player’s character should be loaded.

float

NameDisplayDistance

Sets the distance at which this player will see other Humanoid’s names. If set to 0, names are hidden.

bool

UserEmotesEnabled

Functions

Events