StarterPlayer

Show Deprecated
Not Creatable
Service

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.

Summary

Properties

Properties

AllowCustomAnimations

Hidden
Roblox Script Security
Read Parallel

AutoJumpEnabled

Read Parallel

Code Samples

Auto-Jump Toggle

local Players = game:GetService("Players")
local player = Players.LocalPlayer
local button = script.Parent
local function update()
-- Update button text
if player.AutoJumpEnabled then
button.Text = "Auto-Jump is ON"
else
button.Text = "Auto-Jump is OFF"
end
-- Reflect the property in the player's character, if they have one
if player.Character then
local human = player.Character:FindFirstChild("Humanoid")
if human then
human.AutoJumpEnabled = player.AutoJumpEnabled
end
end
end
local function onActivated()
-- Toggle auto-jump
player.AutoJumpEnabled = not player.AutoJumpEnabled
-- Update everything else
update()
end
button.Activated:Connect(onActivated)
update()

AvatarJointUpgrade

Not Replicated
Not Scriptable
Not Browsable
Read Parallel

CameraMaxZoomDistance

Read Parallel

Code Samples

Setting Camera Zoom Distance

local Players = game:GetService("Players")
local player = Players.LocalPlayer
player.CameraMaxZoomDistance = 50
player.CameraMinZoomDistance = 75

CameraMinZoomDistance

Read Parallel

Code Samples

Setting Camera Zoom Distance

local Players = game:GetService("Players")
local player = Players.LocalPlayer
player.CameraMaxZoomDistance = 50
player.CameraMinZoomDistance = 75

CameraMode

Read Parallel

Code Samples

Playing in First Person

local Players = game:GetService("Players")
local player = Players.LocalPlayer
player.CameraMode = Enum.CameraMode.LockFirstPerson

CharacterJumpHeight

Read Parallel

CharacterJumpPower

Read Parallel

CharacterMaxSlopeAngle

Read Parallel

CharacterUseJumpPower

Read Parallel

CharacterWalkSpeed

Read Parallel

ClassicDeath

Not Browsable
Read Parallel

DevCameraOcclusionMode

Read Parallel

DevComputerCameraMovementMode

Read Parallel

DevComputerMovementMode

Read Parallel

DevTouchCameraMovementMode

Read Parallel

DevTouchMovementMode

Read Parallel

EnableDynamicHeads

Not Scriptable
Read Parallel

EnableMouseLockOption

Read Parallel

Code Samples

Enabling a Player's Mouse Lock

local Players = game:GetService("Players")
local player = Players.LocalPlayer
while true do
player.DevEnableMouseLock = not player.DevEnableMouseLock
task.wait(5)
end

HealthDisplayDistance

Read Parallel

Code Samples

Hiding Player Health and Names

local Players = game:GetService("Players")
local player = Players.LocalPlayer
player.HealthDisplayDistance = 0
player.NameDisplayDistance = 0

LoadCharacterAppearance

Read Parallel

Code Samples

Disabling a Player's Appearance

local Players = game:GetService("Players")
local player = Players.LocalPlayer
player.CanLoadCharacterAppearance = false

LoadCharacterLayeredClothing

Not Replicated
Not Scriptable
Read Parallel

LuaCharacterController

Not Browsable
Read Parallel

NameDisplayDistance

Read Parallel

Code Samples

Hiding Player Health and Names

local Players = game:GetService("Players")
local player = Players.LocalPlayer
player.HealthDisplayDistance = 0
player.NameDisplayDistance = 0

RagdollDeath

Not Browsable
Read Parallel

UserEmotesEnabled

Read Parallel

Methods

Events