StarterPlayer

StarterPlayer : Instance

Overview

This service lets you configure the initial properties of player Objects

Each time a player joins the game, a Player instance is created, and its properties are automatically set based on the values defined in StarterPlayer.

This service includes several containers, each with a specific purpose:

• StarterPlayerScripts: Stores client-side scripts that run when the player joins the game.

• StarterCharacterScripts: Stores client-side scripts that run each time the player's character is spawned.

Properties

AirControl

number

Defines how much control the player character has while in the air. A value closer to 0 makes it difficult to change direction mid-jump or fall, while a value closer to 1 allows smoother air control similar to ground movement.

Code Samples

AllowCustomAnimations

number

Currently not supported.

Code Samples

CameraMaxZoomDistance

number

Sets the maximum distance the default camera can move away from the player's character.

This limits how far the user can zoom out in third-person view.

Code Samples

local StarterPlayer = game:GetService("StarterPlayer")

print(StarterPlayer.CameraMaxZoomDistance)

CameraMinZoomDistance

number

Sets the minimum distance the default camera can move toward the player's character.

This limits how close the camera can get in first-person or close-up views.

Code Samples

local StarterPlayer = game:GetService("StarterPlayer")

print(StarterPlayer.CameraMinZoomDistance)

CapsuleHeight

number

Specifies the vertical height of the collision capsule used for the player character. This affects only the collision boundaries, not the visual mesh. Increasing the value makes the collision capsule taller.

Code Samples

CapsuleRadius

number

Specifies the radius of the player character’s collision capsule. A smaller value allows movement through narrow spaces, while a larger value increases the overall collision area.

Code Samples

CharacterMeshPos

Vector3

Determines how far to offset the player character’s mesh from its base position. This is mainly used to align the mesh with the collision capsule or adjust the position for custom rigs.

Code Samples

FallingDeceleration

number

Controls how much the player character slows down while falling. A value of 0 applies no deceleration, while higher values create a smoother landing effect.

Code Samples

FallingLateralFriction

number

Defines the friction applied when the character moves sideways in the air. Lower values make movement feel smoother and floatier, while higher values make control more immediate and responsive.

Code Samples

GravityScale

number

Sets the gravity multiplier applied to the player character. Higher values make the character fall faster and jump lower.

Code Samples

GroundFriction

number

Defines the amount of friction applied while moving on the ground. Lower values create a slippery feel, while higher values make turns and stops more immediate.

Code Samples

IgnoreBaseRotation

bool

Determines whether the rotation of the ground affects the player’s movement and camera. When set to true (default), the base rotation is ignored. When false, both the character and camera will rotate with the ground surface.

Code Samples

JumpHeight

number

Specifies the maximum height the player character can reach when jumping. A value of 0 disables jumping. The default value is 135.

Code Samples

JumpPower

number

Defines the upward force applied when the character jumps. The actual jump height is affected by the value of Workspace.Gravity.

Code Samples

LoadCharacterAppearance

bool

Determines whether the appearance set by the user in the OVERDARE App should be applied to the player's character.

If you're using a HumanoidDescription for a custom appearance, it's recommended to set this property to false, as there's no need to load the appearance.

Code Samples

MaxAcceleration

number

Defines the maximum acceleration speed of the player character. Higher values make movement feel more responsive, while lower values create a heavier, slower feel.

Code Samples

MaxJumpCount

number

Specifies the maximum number of consecutive jumps the player character can perform. The default is 1, and values of 2 or higher enable double-jumping.

Code Samples

MaxSlopeAngle

number

The property that sets the maximum slope angle a character can climb.

This property cannot be changed dynamically. To configure it, go to the Game Settings window in Studio, navigate to the World tab, and adjust the Max Slope Angle option.

Code Samples

RotationSpeed

number

Specifies how fast the player character can rotate per second, measured in degrees. Lower values make turning slower, while higher values allow instant direction changes.

Code Samples

StompJumpMultiplier

number

Defines the jump multiplier applied when the player character stomps on another character. The default value is 0. Setting it to 1 or higher enables an extra jump on contact.

Code Samples

UseJumpPower

bool

Determines whether to calculate jump height using the JumpPower property. When set to false (default), jump height is calculated using JumpHeight. When true, it is calculated using both JumpPower and the current gravity value.

Code Samples

WalkSpeed

number

Defines the walking speed of the player character, measured in units per second. The default is 500. Setting it to 0 prevents movement.

Code Samples

WalkingDeceleration

number

Defines how quickly the player character slows down when movement input stops. Higher values make the character stop immediately, while lower values simulate momentum or sliding.

Code Samples

Methods

Events