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

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)

AllowCustomAnimations

number

Currently not supported.

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

Methods

Events