StarterPlayer
A service which allows the defaults of properties in the Player object to be set.
| Memory category | Instances |
|---|
Member index 46
Removed member index 16
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.
History 298
- 727 Add
- 726 Change Default of UserEmotesEnabled from true to
- 726 Change Default of NameDisplayDistance from 100 to
- 726 Change Default of LuaCharacterController from Default to
- 726 Change Default of LoadCharacterLayeredClothing from Default to
- 726 Remove
- 726 Change Default of LoadCharacterAppearance from true to
- 726 Change Default of HealthDisplayDistance from 100 to
- 726 Change Default of from NumberRange(0.7 1 ) to
- 726 Change Default of from NumberRange(0 1 ) to
- 726 Change Default of from NumberRange(0.9 1.05 ) to
- 726 Change Default of from NumberRange(0.95 1 ) to
- 726 Change Default of from NumberRange(0 1 ) to
- 726 Change Default of from OuterBox to
- 726 Change Default of from R15 to
- 726 Change Default of from 0 to
- 726 Change Default of from 0 to
- 726 Change Default of from 0 to
- 726 Change Default of from 0 to
- 726 Change Default of from 0 to
- 726 Change Default of from 0 to
- 726 Change Default of from 0 to
- 726 Change Default of from 0 to
- 726 Change Default of from 0 to
- 726 Change Default of from 0 to
- 726 Change Default of EnableMouseLockOption from true to
- 726 Change Default of EnableDynamicHeads from Default to
- 726 Change Default of DevTouchMovementMode from UserChoice to
- 726 Change Default of DevTouchCameraMovementMode from UserChoice to
- 726 Change Default of DevComputerMovementMode from UserChoice to
- 726 Change Default of DevComputerCameraMovementMode from UserChoice to
- 726 Change Default of DevCameraOcclusionMode from Zoom to
- 726 Change Default of CreateDefaultPlayerModule from true to
- 726 Change Default of ClassicDeath from true to
- 726 Change Default of CharacterWalkSpeed from 16 to
- 726 Change Default of CharacterUseJumpPower from true to
- 726 Change Default of CharacterMaxSlopeAngle from 89 to
- 726 Change Default of CharacterJumpPower from 50 to
- 726 Change Default of CharacterJumpHeight from 7.19999981 to
- 726 Change Default of CharacterBreakJointsOnDeath from true to
- 726 Change Default of CameraMode from Classic to
- 726 Change Default of CameraMinZoomDistance from 0.5 to
- 726 Change Default of CameraMaxZoomDistance from 400 to
- 726 Remove
- 726 Change Default of AvatarJointUpgrade from Default to
- 726 Change Default of AutoJumpEnabled from true to
- 726 Change Default of from true to
- 715 Change ReadSecurity of AvatarJointUpgrade from None to RobloxScriptSecurity
- 715 Change WriteSecurity of AvatarJointUpgrade from None to RobloxScriptSecurity
- 715 Change Tags of AvatarJointUpgrade from [NotReplicated, NotScriptable] to [NotReplicated]
- 707 Change Tags of ClassicDeath from [NotBrowsable] to []
- 707 Change Tags of AvatarJointUpgrade from [NotReplicated, NotScriptable, NotBrowsable] to [NotReplicated, NotScriptable]
- 700 Remove RagdollDeath
- 700 Change Tags of LuaCharacterController from [NotBrowsable] to []
- 700 Add CharacterBreakJointsOnDeath
- 699 Add CreateDefaultPlayerModule
- 671 Add ClassicDeath
- 670 Add RagdollDeath
- 658 Change Tags of from [Hidden, NotReplicated] to [Hidden]
- 650 Add
- 650 Remove
- 650 Change ValueType of AvatarJointUpgrade from AvatarJointUpgrade to RolloutState
- 650 Change Tags of AvatarJointUpgrade from [NotReplicated, NotBrowsable] to [NotReplicated, NotScriptable, NotBrowsable]
- 620 Remove DeathStyle
- 608 Remove HumanoidStateMachineMode
- 608 Remove AnimationCompositorMode
- 603 Add LuaCharacterController
- 594 Add AnimationCompositorMode
- 589 Add
- 589 Change CanSave of AvatarJointUpgrade from true to false
- 589 Change Tags of AvatarJointUpgrade from [NotBrowsable] to [NotReplicated, NotBrowsable]
- 589 Change CanLoad of AvatarJointUpgrade from true to false
- 588 Change Default of AvatarJointUpgrade from to Default
- 587 Add DeathStyle
- 587 Add AvatarJointUpgrade
- 578 Change Tags of EnableMouseLockOption from [Deprecated] to []
- 576 Change Tags of EnableMouseLockOption from [] to [Deprecated]
- 573 Change ReturnType of ClearDefaults from void to null
- 553 Change Default of UserEmotesEnabled from to true
- 553 Change Default of NameDisplayDistance from to 100
- 553 Change Default of LoadCharacterLayeredClothing from to Default
- 553 Add
- 553 Change Default of LoadCharacterAppearance from to true
- 553 Change Default of HumanoidStateMachineMode from to Default
- 553 Change Default of HealthDisplayDistance from to 100
- 553 Change Default of from to NumberRange(0.7 1 )
- 553 Change Default of from to NumberRange(0 1 )
- 553 Change Default of from to NumberRange(0.9 1.05 )
- 553 Change Default of from to NumberRange(0.95 1 )
- 553 Change Default of from to NumberRange(0 1 )
- 553 Change Default of from to OuterBox
- 553 Change Default of from to R15
- 553 Change Default of from to 0
- 553 Change Default of from to 0
- 553 Change Default of from to 0
- 553 Change Default of from to 0
- 553 Change Default of from to 0
- 553 Change Default of from to 0
- 553 Change Default of from to 0
- 553 Change Default of from to 0
- 553 Change Default of from to 0
- 553 Change Default of from to 0
- 553 Change Default of EnableMouseLockOption from to true
- 553 Change Default of EnableDynamicHeads from to Default
- 553 Change Default of DevTouchMovementMode from to UserChoice
- 553 Change Default of DevTouchCameraMovementMode from to UserChoice
- 553 Change Default of DevComputerMovementMode from to UserChoice
- 553 Change Default of DevComputerCameraMovementMode from to UserChoice
- 553 Change Default of DevCameraOcclusionMode from to Zoom
- 553 Change Default of CharacterWalkSpeed from to 16
- 553 Change Default of CharacterUseJumpPower from to true
- 553 Change Default of CharacterMaxSlopeAngle from to 89
- 553 Change Default of CharacterJumpPower from to 50
- 553 Change Default of CharacterJumpHeight from to 7.19999981
- 553 Change Default of CameraMode from to Classic
- 553 Change Default of CameraMinZoomDistance from to 0.5
- 553 Change Default of CameraMaxZoomDistance from to 400
- 553 Change Default of AutoJumpEnabled from to true
- 553 Change Default of from to true
- 549 Add HumanoidStateMachineMode
- 540 Add EnableDynamicHeads
- 499 Add LoadCharacterLayeredClothing
- 499 Remove
- 486 Change ThreadSafety of UserEmotesEnabled from ReadOnly to ReadSafe
- 486 Change ThreadSafety of NameDisplayDistance from ReadOnly to ReadSafe
- 486 Change ThreadSafety of from ReadOnly to ReadSafe
- 486 Change ThreadSafety of LoadCharacterAppearance from ReadOnly to ReadSafe
- 486 Change ThreadSafety of HealthDisplayDistance from ReadOnly to ReadSafe
- 486 Change ThreadSafety of from ReadOnly to ReadSafe
- 486 Change ThreadSafety of from ReadOnly to ReadSafe
- 486 Change ThreadSafety of from ReadOnly to ReadSafe
- 486 Change ThreadSafety of from ReadOnly to ReadSafe
- 486 Change ThreadSafety of from ReadOnly to ReadSafe
- 486 Change ThreadSafety of from ReadOnly to ReadSafe
- 486 Change ThreadSafety of from ReadOnly to ReadSafe
- 486 Change ThreadSafety of from ReadOnly to ReadSafe
- 486 Change ThreadSafety of from ReadOnly to ReadSafe
- 486 Change ThreadSafety of from ReadOnly to ReadSafe
- 486 Change ThreadSafety of from ReadOnly to ReadSafe
- 486 Change ThreadSafety of from ReadOnly to ReadSafe
- 486 Change ThreadSafety of from ReadOnly to ReadSafe
- 486 Change ThreadSafety of from ReadOnly to ReadSafe
- 486 Change ThreadSafety of from ReadOnly to ReadSafe
- 486 Change ThreadSafety of from ReadOnly to ReadSafe
- 486 Change ThreadSafety of from ReadOnly to ReadSafe
- 486 Change ThreadSafety of EnableMouseLockOption from ReadOnly to ReadSafe
- 486 Change ThreadSafety of DevTouchMovementMode from ReadOnly to ReadSafe
- 486 Change ThreadSafety of DevTouchCameraMovementMode from ReadOnly to ReadSafe
- 486 Change ThreadSafety of DevComputerMovementMode from ReadOnly to ReadSafe
- 486 Change ThreadSafety of DevComputerCameraMovementMode from ReadOnly to ReadSafe
- 486 Change ThreadSafety of DevCameraOcclusionMode from ReadOnly to ReadSafe
- 486 Change ThreadSafety of CharacterWalkSpeed from ReadOnly to ReadSafe
- 486 Change ThreadSafety of CharacterUseJumpPower from ReadOnly to ReadSafe
- 486 Change ThreadSafety of CharacterMaxSlopeAngle from ReadOnly to ReadSafe
- 486 Change ThreadSafety of CharacterJumpPower from ReadOnly to ReadSafe
- 486 Change ThreadSafety of CharacterJumpHeight from ReadOnly to ReadSafe
- 486 Change ThreadSafety of CameraMode from ReadOnly to ReadSafe
- 486 Change ThreadSafety of CameraMinZoomDistance from ReadOnly to ReadSafe
- 486 Change ThreadSafety of CameraMaxZoomDistance from ReadOnly to ReadSafe
- 486 Change ThreadSafety of AutoJumpEnabled from ReadOnly to ReadSafe
- 486 Change ThreadSafety of from ReadOnly to ReadSafe
- 477 Add
- 462 Change ThreadSafety of ClearDefaults from to Unsafe
- 462 Change ThreadSafety of UserEmotesEnabled from to ReadOnly
- 462 Change ThreadSafety of NameDisplayDistance from to ReadOnly
- 462 Change ThreadSafety of LoadCharacterAppearance from to ReadOnly
- 462 Change ThreadSafety of HealthDisplayDistance from to ReadOnly
- 462 Change ThreadSafety of from to ReadOnly
- 462 Change ThreadSafety of from to ReadOnly
- 462 Change ThreadSafety of from to ReadOnly
- 462 Change ThreadSafety of from to ReadOnly
- 462 Change ThreadSafety of from to ReadOnly
- 462 Change ThreadSafety of from to ReadOnly
- 462 Change ThreadSafety of from to ReadOnly
- 462 Change ThreadSafety of from to ReadOnly
- 462 Change ThreadSafety of from to ReadOnly
- 462 Change ThreadSafety of from to ReadOnly
- 462 Change ThreadSafety of from to ReadOnly
- 462 Change ThreadSafety of from to ReadOnly
- 462 Change ThreadSafety of from to ReadOnly
- 462 Change ThreadSafety of from to ReadOnly
- 462 Change ThreadSafety of from to ReadOnly
- 462 Change ThreadSafety of from to ReadOnly
- 462 Change ThreadSafety of from to ReadOnly
- 462 Change ThreadSafety of EnableMouseLockOption from to ReadOnly
- 462 Change ThreadSafety of DevTouchMovementMode from to ReadOnly
- 462 Change ThreadSafety of DevTouchCameraMovementMode from to ReadOnly
- 462 Change ThreadSafety of DevComputerMovementMode from to ReadOnly
- 462 Change ThreadSafety of DevComputerCameraMovementMode from to ReadOnly
- 462 Change ThreadSafety of DevCameraOcclusionMode from to ReadOnly
- 462 Change ThreadSafety of CharacterWalkSpeed from to ReadOnly
- 462 Change ThreadSafety of CharacterUseJumpPower from to ReadOnly
- 462 Change ThreadSafety of CharacterMaxSlopeAngle from to ReadOnly
- 462 Change ThreadSafety of CharacterJumpPower from to ReadOnly
- 462 Change ThreadSafety of CharacterJumpHeight from to ReadOnly
- 462 Change ThreadSafety of CameraMode from to ReadOnly
- 462 Change ThreadSafety of CameraMinZoomDistance from to ReadOnly
- 462 Change ThreadSafety of CameraMaxZoomDistance from to ReadOnly
- 462 Change ThreadSafety of AutoJumpEnabled from to ReadOnly
- 462 Change ThreadSafety of from to ReadOnly
- 402 Change WriteSecurity of UserEmotesEnabled from RobloxScriptSecurity to None
- 384 Add UserEmotesEnabled
- 381 Remove
- 381 Add
- 381 Add
- 381 Add
- 381 Add
- 381 Add
- 381 Remove
- 381 Remove
- 381 Remove
- 381 Remove
- 381 Remove
- 381 Add
- 381 Remove
- 381 Add
- 379 Change WriteSecurity of CharacterWalkSpeed from RobloxScriptSecurity to None
- 379 Change Tags of CharacterWalkSpeed from [Hidden] to []
- 379 Change ReadSecurity of CharacterWalkSpeed from RobloxScriptSecurity to None
- 379 Change WriteSecurity of CharacterUseJumpPower from RobloxScriptSecurity to None
- 379 Change Tags of CharacterUseJumpPower from [Hidden] to []
- 379 Change ReadSecurity of CharacterUseJumpPower from RobloxScriptSecurity to None
- 379 Change Category of CharacterUseJumpPower from Character to Character Jump Settings
- 379 Change WriteSecurity of CharacterMaxSlopeAngle from RobloxScriptSecurity to None
- 379 Change Tags of CharacterMaxSlopeAngle from [Hidden] to []
- 379 Change ReadSecurity of CharacterMaxSlopeAngle from RobloxScriptSecurity to None
- 379 Change WriteSecurity of CharacterJumpPower from RobloxScriptSecurity to None
- 379 Change Tags of CharacterJumpPower from [Hidden] to []
- 379 Change ReadSecurity of CharacterJumpPower from RobloxScriptSecurity to None
- 379 Change Category of CharacterJumpPower from Character to Character Jump Settings
- 379 Change WriteSecurity of CharacterJumpHeight from RobloxScriptSecurity to None
- 379 Change Tags of CharacterJumpHeight from [Hidden] to []
- 379 Change ReadSecurity of CharacterJumpHeight from RobloxScriptSecurity to None
- 379 Change Category of CharacterJumpHeight from Character to Character Jump Settings
- 377 Change ReadSecurity of CharacterWalkSpeed from None to RobloxScriptSecurity
- 377 Change Tags of CharacterWalkSpeed from [] to [Hidden]
- 377 Change WriteSecurity of CharacterWalkSpeed from None to RobloxScriptSecurity
- 377 Change ReadSecurity of CharacterUseJumpPower from None to RobloxScriptSecurity
- 377 Change WriteSecurity of CharacterUseJumpPower from None to RobloxScriptSecurity
- 377 Change Tags of CharacterUseJumpPower from [] to [Hidden]
- 377 Change WriteSecurity of CharacterMaxSlopeAngle from None to RobloxScriptSecurity
- 377 Change ReadSecurity of CharacterMaxSlopeAngle from None to RobloxScriptSecurity
- 377 Change Tags of CharacterMaxSlopeAngle from [] to [Hidden]
- 377 Change ReadSecurity of CharacterJumpPower from None to RobloxScriptSecurity
- 377 Change WriteSecurity of CharacterJumpPower from None to RobloxScriptSecurity
- 377 Change Tags of CharacterJumpPower from [] to [Hidden]
- 377 Change ReadSecurity of CharacterJumpHeight from None to RobloxScriptSecurity
- 377 Change Tags of CharacterJumpHeight from [] to [Hidden]
- 377 Change WriteSecurity of CharacterJumpHeight from None to RobloxScriptSecurity
- 375 Add CharacterWalkSpeed
- 375 Add CharacterUseJumpPower
- 375 Add CharacterMaxSlopeAngle
- 375 Add CharacterJumpPower
- 375 Add CharacterJumpHeight
- 373 Add
- 373 Add
- 373 Add
- 373 Add
- 373 Add
- 373 Add
- 373 Add
- 373 Add
- 373 Add
- 373 Add
- 373 Add
- 373 Add
- 373 Add
- 373 Add
- 373 Add
- 373 Add
- 373 Add
- 373 Change WriteSecurity of from NotAccessibleSecurity to RobloxScriptSecurity
- 373 Change CanSave of from false to true
- 373 Change CanLoad of from false to true
- 366 Add ClearDefaults
- 303 Add
- 290 Remove ScreenOrientationChanged
- 290 Remove ScreenOrientation
- 285 Add ScreenOrientationChanged
- 285 Add ScreenOrientation
- 284 Remove ScreenOrientationChanged
- 284 Remove ScreenOrientation
- 285 Add ScreenOrientationChanged
- 285 Add ScreenOrientation
- 218 Add LoadCharacterAppearance
- 206 Add AutoJumpEnabled
- 176 Add EnableMouseLockOption
- 176 Add DevTouchMovementMode
- 176 Add DevTouchCameraMovementMode
- 176 Add DevComputerMovementMode
- 176 Add DevComputerCameraMovementMode
- 176 Add DevCameraOcclusionMode
- 172 Add NameDisplayDistance
- 172 Add HealthDisplayDistance
- 172 Add CameraMode
- 172 Add CameraMinZoomDistance
- 172 Add CameraMaxZoomDistance
- 172 Add StarterPlayer
Members 46
AutoJumpEnabled
| Type | Default | |
|---|---|---|
| bool | ||
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.
| Thread safety | ReadSafe |
|---|---|
| Category | Mobile |
| Loaded/Saved | true |
History 5
- 726 Change Default of AutoJumpEnabled from true to
- 553 Change Default of AutoJumpEnabled from to true
- 486 Change ThreadSafety of AutoJumpEnabled from ReadOnly to ReadSafe
- 462 Change ThreadSafety of AutoJumpEnabled from to ReadOnly
- 206 Add AutoJumpEnabled
AvatarJointUpgrade
| Type | Default | |
|---|---|---|
| RolloutState | ||
This property controls the rollout state of new AnimationConstraint joints in avatars. When disabled, avatars spawn with legacy Motor6Ds connecting their limbs. When enabled, avatars spawn with AnimationConstraints and BallSocketConstraints connecting their limbs. This makes it easier to write scripts that enable physical simulation, like arm strength and ragdoll falling down.
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Character |
| Loaded/Saved | false |
History 12
- 726 Change Default of AvatarJointUpgrade from Default to
- 715 Change ReadSecurity of AvatarJointUpgrade from None to RobloxScriptSecurity
- 715 Change WriteSecurity of AvatarJointUpgrade from None to RobloxScriptSecurity
- 715 Change Tags of AvatarJointUpgrade from [NotReplicated, NotScriptable] to [NotReplicated]
- 707 Change Tags of AvatarJointUpgrade from [NotReplicated, NotScriptable, NotBrowsable] to [NotReplicated, NotScriptable]
- 650 Change ValueType of AvatarJointUpgrade from AvatarJointUpgrade to RolloutState
- 650 Change Tags of AvatarJointUpgrade from [NotReplicated, NotBrowsable] to [NotReplicated, NotScriptable, NotBrowsable]
- 589 Change CanSave of AvatarJointUpgrade from true to false
- 589 Change Tags of AvatarJointUpgrade from [NotBrowsable] to [NotReplicated, NotBrowsable]
- 589 Change CanLoad of AvatarJointUpgrade from true to false
- 588 Change Default of AvatarJointUpgrade from to Default
- 587 Add AvatarJointUpgrade
CameraMaxZoomDistance
| Type | Default | |
|---|---|---|
| float | ||
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.
| Thread safety | ReadSafe |
|---|---|
| Category | Camera |
| Loaded/Saved | true |
History 5
- 726 Change Default of CameraMaxZoomDistance from 400 to
- 553 Change Default of CameraMaxZoomDistance from to 400
- 486 Change ThreadSafety of CameraMaxZoomDistance from ReadOnly to ReadSafe
- 462 Change ThreadSafety of CameraMaxZoomDistance from to ReadOnly
- 172 Add CameraMaxZoomDistance
CameraMinZoomDistance
| Type | Default | |
|---|---|---|
| float | ||
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.
| Thread safety | ReadSafe |
|---|---|
| Category | Camera |
| Loaded/Saved | true |
History 5
- 726 Change Default of CameraMinZoomDistance from 0.5 to
- 553 Change Default of CameraMinZoomDistance from to 0.5
- 486 Change ThreadSafety of CameraMinZoomDistance from ReadOnly to ReadSafe
- 462 Change ThreadSafety of CameraMinZoomDistance from to ReadOnly
- 172 Add CameraMinZoomDistance
CameraMode
| Type | Default | |
|---|---|---|
| CameraMode | ||
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.
| Thread safety | ReadSafe |
|---|---|
| Category | Camera |
| Loaded/Saved | true |
History 5
- 726 Change Default of CameraMode from Classic to
- 553 Change Default of CameraMode from to Classic
- 486 Change ThreadSafety of CameraMode from ReadOnly to ReadSafe
- 462 Change ThreadSafety of CameraMode from to ReadOnly
- 172 Add CameraMode
CharacterBreakJointsOnDeath
| Type | Default | |
|---|---|---|
| bool | ||
This property determines the starting value of Humanoid.BreakJointsOnDeath for a player's Player.Character.
Note that AvatarJointUpgrade must be enabled for this property to take effect.
| Thread safety | ReadSafe |
|---|---|
| Category | Character |
| Loaded/Saved | true |
History 2
- 726 Change Default of CharacterBreakJointsOnDeath from true to
- 700 Add CharacterBreakJointsOnDeath
CharacterJumpHeight
| Type | Default | |
|---|---|---|
| float | ||
This property determines the starting value of Humanoid.JumpHeight
for a player's Player.Character in studs, with a default of 7.2.
This property is only visible in the Properties window If
CharacterUseJumpPower is set
to false, as it would not be relevant otherwise.
Since this property is only relevant for characters being spawned in the future, changing it will not change any existing player characters. Changes to this property will only take effect when a player respawns.
| Thread safety | ReadSafe |
|---|---|
| Category | Character Jump Settings |
| Loaded/Saved | true |
History 12
- 726 Change Default of CharacterJumpHeight from 7.19999981 to
- 553 Change Default of CharacterJumpHeight from to 7.19999981
- 486 Change ThreadSafety of CharacterJumpHeight from ReadOnly to ReadSafe
- 462 Change ThreadSafety of CharacterJumpHeight from to ReadOnly
- 379 Change WriteSecurity of CharacterJumpHeight from RobloxScriptSecurity to None
- 379 Change Tags of CharacterJumpHeight from [Hidden] to []
- 379 Change ReadSecurity of CharacterJumpHeight from RobloxScriptSecurity to None
- 379 Change Category of CharacterJumpHeight from Character to Character Jump Settings
- 377 Change ReadSecurity of CharacterJumpHeight from None to RobloxScriptSecurity
- 377 Change Tags of CharacterJumpHeight from [] to [Hidden]
- 377 Change WriteSecurity of CharacterJumpHeight from None to RobloxScriptSecurity
- 375 Add CharacterJumpHeight
CharacterJumpPower
| Type | Default | |
|---|---|---|
| float | ||
This property determines the starting value of Humanoid.JumpPower
for a player's Player.Character, with a default of 50, minimum
of 0, and maximum of 1000.
This property is only visible in the Properties window If
CharacterUseJumpPower is set
to true, as it would not be relevant otherwise.
Since this property is only relevant for characters being spawned in the future, changing it will not change any existing player characters. Changes to this property will only take effect when a player respawns.
| Thread safety | ReadSafe |
|---|---|
| Category | Character Jump Settings |
| Loaded/Saved | true |
History 12
- 726 Change Default of CharacterJumpPower from 50 to
- 553 Change Default of CharacterJumpPower from to 50
- 486 Change ThreadSafety of CharacterJumpPower from ReadOnly to ReadSafe
- 462 Change ThreadSafety of CharacterJumpPower from to ReadOnly
- 379 Change WriteSecurity of CharacterJumpPower from RobloxScriptSecurity to None
- 379 Change Tags of CharacterJumpPower from [Hidden] to []
- 379 Change ReadSecurity of CharacterJumpPower from RobloxScriptSecurity to None
- 379 Change Category of CharacterJumpPower from Character to Character Jump Settings
- 377 Change ReadSecurity of CharacterJumpPower from None to RobloxScriptSecurity
- 377 Change WriteSecurity of CharacterJumpPower from None to RobloxScriptSecurity
- 377 Change Tags of CharacterJumpPower from [] to [Hidden]
- 375 Add CharacterJumpPower
CharacterMaxSlopeAngle
| Type | Default | |
|---|---|---|
| float | ||
This property determines the starting value of
Humanoid.MaxSlopeAngle for a player's Player.Character in
degrees. It defaults to 89, so humanoids can climb pretty much any slope
they want by default.
Since this property is only relevant for characters being spawned in the future, changing it will not change any existing player characters. Changes to this property will only take effect when a player respawns.
| Thread safety | ReadSafe |
|---|---|
| Category | Character |
| Loaded/Saved | true |
History 11
- 726 Change Default of CharacterMaxSlopeAngle from 89 to
- 553 Change Default of CharacterMaxSlopeAngle from to 89
- 486 Change ThreadSafety of CharacterMaxSlopeAngle from ReadOnly to ReadSafe
- 462 Change ThreadSafety of CharacterMaxSlopeAngle from to ReadOnly
- 379 Change WriteSecurity of CharacterMaxSlopeAngle from RobloxScriptSecurity to None
- 379 Change Tags of CharacterMaxSlopeAngle from [Hidden] to []
- 379 Change ReadSecurity of CharacterMaxSlopeAngle from RobloxScriptSecurity to None
- 377 Change WriteSecurity of CharacterMaxSlopeAngle from None to RobloxScriptSecurity
- 377 Change ReadSecurity of CharacterMaxSlopeAngle from None to RobloxScriptSecurity
- 377 Change Tags of CharacterMaxSlopeAngle from [] to [Hidden]
- 375 Add CharacterMaxSlopeAngle
CharacterUseJumpPower
| Type | Default | |
|---|---|---|
| bool | ||
This property determines the starting value of
Humanoid.UseJumpPower for a player's Player.Character.
Toggling it will change which property is visible in the Properties
window (CharacterJumpHeight if
false or CharacterJumpPower if
true). Defaults to true.
Since this property is only relevant for characters being spawned in the future, changing it will not change any existing player characters. Changes to this property will only take effect when a player respawns.
| Thread safety | ReadSafe |
|---|---|
| Category | Character Jump Settings |
| Loaded/Saved | true |
History 12
- 726 Change Default of CharacterUseJumpPower from true to
- 553 Change Default of CharacterUseJumpPower from to true
- 486 Change ThreadSafety of CharacterUseJumpPower from ReadOnly to ReadSafe
- 462 Change ThreadSafety of CharacterUseJumpPower from to ReadOnly
- 379 Change WriteSecurity of CharacterUseJumpPower from RobloxScriptSecurity to None
- 379 Change Tags of CharacterUseJumpPower from [Hidden] to []
- 379 Change ReadSecurity of CharacterUseJumpPower from RobloxScriptSecurity to None
- 379 Change Category of CharacterUseJumpPower from Character to Character Jump Settings
- 377 Change ReadSecurity of CharacterUseJumpPower from None to RobloxScriptSecurity
- 377 Change WriteSecurity of CharacterUseJumpPower from None to RobloxScriptSecurity
- 377 Change Tags of CharacterUseJumpPower from [] to [Hidden]
- 375 Add CharacterUseJumpPower
CharacterWalkSpeed
| Type | Default | |
|---|---|---|
| float | ||
This property determines the starting value of Humanoid.WalkSpeed
for a player's Player.Character with a default of 16.
Since this property is only relevant for characters being spawned in the future, changing it will not change any existing player characters. Changes to this property will only take effect when a player respawns.
| Thread safety | ReadSafe |
|---|---|
| Category | Character |
| Loaded/Saved | true |
History 11
- 726 Change Default of CharacterWalkSpeed from 16 to
- 553 Change Default of CharacterWalkSpeed from to 16
- 486 Change ThreadSafety of CharacterWalkSpeed from ReadOnly to ReadSafe
- 462 Change ThreadSafety of CharacterWalkSpeed from to ReadOnly
- 379 Change WriteSecurity of CharacterWalkSpeed from RobloxScriptSecurity to None
- 379 Change Tags of CharacterWalkSpeed from [Hidden] to []
- 379 Change ReadSecurity of CharacterWalkSpeed from RobloxScriptSecurity to None
- 377 Change ReadSecurity of CharacterWalkSpeed from None to RobloxScriptSecurity
- 377 Change Tags of CharacterWalkSpeed from [] to [Hidden]
- 377 Change WriteSecurity of CharacterWalkSpeed from None to RobloxScriptSecurity
- 375 Add CharacterWalkSpeed
ClassicDeath
| Type | Default | |
|---|---|---|
| bool | ||
When enabled, the character uses the classic death behavior (joints break
apart and parts scatter). When disabled, characters spawn with
Humanoid.BreakJointsOnDeath = false, and will ragdoll when they
die.
| Thread safety | ReadSafe |
|---|---|
| Category | Character |
| Loaded/Saved | true |
History 3
- 726 Change Default of ClassicDeath from true to
- 707 Change Tags of ClassicDeath from [NotBrowsable] to []
- 671 Add ClassicDeath
ClearDefaults
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| null | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 3
- 573 Change ReturnType of ClearDefaults from void to null
- 462 Change ThreadSafety of ClearDefaults from to Unsafe
- 366 Add ClearDefaults
CreateDefaultPlayerModule
| Type | Default | |
|---|---|---|
| bool | ||
This property is only visible when
Workspace.PlayerScriptsUseInputActionSystem is enabled. When set
to true (default), the PlayerModule injection point occurs at
StarterPlayer. When set to false, the default camera and control
scripts will not be added to the place.
| Thread safety | ReadSafe |
|---|---|
| Category | Controls |
| Loaded/Saved | true |
History 2
- 726 Change Default of CreateDefaultPlayerModule from true to
- 699 Add CreateDefaultPlayerModule
DevCameraOcclusionMode
| Type | Default | |
|---|---|---|
| DevCameraOcclusionMode | ||
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.
| Thread safety | ReadSafe |
|---|---|
| Category | Camera |
| Loaded/Saved | true |
History 5
- 726 Change Default of DevCameraOcclusionMode from Zoom to
- 553 Change Default of DevCameraOcclusionMode from to Zoom
- 486 Change ThreadSafety of DevCameraOcclusionMode from ReadOnly to ReadSafe
- 462 Change ThreadSafety of DevCameraOcclusionMode from to ReadOnly
- 176 Add DevCameraOcclusionMode
DevComputerCameraMovementMode
| Type | Default | |
|---|---|---|
| DevComputerCameraMovementMode | ||
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.
| Thread safety | ReadSafe |
|---|---|
| Category | Camera |
| Loaded/Saved | true |
History 5
- 726 Change Default of DevComputerCameraMovementMode from UserChoice to
- 553 Change Default of DevComputerCameraMovementMode from to UserChoice
- 486 Change ThreadSafety of DevComputerCameraMovementMode from ReadOnly to ReadSafe
- 462 Change ThreadSafety of DevComputerCameraMovementMode from to ReadOnly
- 176 Add DevComputerCameraMovementMode
DevComputerMovementMode
| Type | Default | |
|---|---|---|
| DevComputerMovementMode | ||
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.
| Thread safety | ReadSafe |
|---|---|
| Category | Controls |
| Loaded/Saved | true |
History 5
- 726 Change Default of DevComputerMovementMode from UserChoice to
- 553 Change Default of DevComputerMovementMode from to UserChoice
- 486 Change ThreadSafety of DevComputerMovementMode from ReadOnly to ReadSafe
- 462 Change ThreadSafety of DevComputerMovementMode from to ReadOnly
- 176 Add DevComputerMovementMode
DevTouchCameraMovementMode
| Type | Default | |
|---|---|---|
| DevTouchCameraMovementMode | ||
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.
| Thread safety | ReadSafe |
|---|---|
| Category | Camera |
| Loaded/Saved | true |
History 5
- 726 Change Default of DevTouchCameraMovementMode from UserChoice to
- 553 Change Default of DevTouchCameraMovementMode from to UserChoice
- 486 Change ThreadSafety of DevTouchCameraMovementMode from ReadOnly to ReadSafe
- 462 Change ThreadSafety of DevTouchCameraMovementMode from to ReadOnly
- 176 Add DevTouchCameraMovementMode
DevTouchMovementMode
| Type | Default | |
|---|---|---|
| DevTouchMovementMode | ||
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.
| Thread safety | ReadSafe |
|---|---|
| Category | Controls |
| Loaded/Saved | true |
History 5
- 726 Change Default of DevTouchMovementMode from UserChoice to
- 553 Change Default of DevTouchMovementMode from to UserChoice
- 486 Change ThreadSafety of DevTouchMovementMode from ReadOnly to ReadSafe
- 462 Change ThreadSafety of DevTouchMovementMode from to ReadOnly
- 176 Add DevTouchMovementMode
EnableDynamicHeads
| Type | Default | |
|---|---|---|
| LoadDynamicHeads | ||
Sets the use of dynamic heads. When true, enables the use of avatar heads with facial animation data.
| Thread safety | ReadSafe |
|---|---|
| Category | Character |
| Loaded/Saved | true |
History 3
- 726 Change Default of EnableDynamicHeads from Default to
- 553 Change Default of EnableDynamicHeads from to Default
- 540 Add EnableDynamicHeads
EnableMouseLockOption
| Type | Default | |
|---|---|---|
| bool | ||
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.
| Thread safety | ReadSafe |
|---|---|
| Category | Controls |
| Loaded/Saved | true |
History 7
- 726 Change Default of EnableMouseLockOption from true to
- 578 Change Tags of EnableMouseLockOption from [Deprecated] to []
- 576 Change Tags of EnableMouseLockOption from [] to [Deprecated]
- 553 Change Default of EnableMouseLockOption from to true
- 486 Change ThreadSafety of EnableMouseLockOption from ReadOnly to ReadSafe
- 462 Change ThreadSafety of EnableMouseLockOption from to ReadOnly
- 176 Add EnableMouseLockOption
HealthDisplayDistance
| Type | Default | |
|---|---|---|
| float | ||
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.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | true |
History 5
- 726 Change Default of HealthDisplayDistance from 100 to
- 553 Change Default of HealthDisplayDistance from to 100
- 486 Change ThreadSafety of HealthDisplayDistance from ReadOnly to ReadSafe
- 462 Change ThreadSafety of HealthDisplayDistance from to ReadOnly
- 172 Add HealthDisplayDistance
LoadCharacterAppearance
| Type | Default | |
|---|---|---|
| bool | ||
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.
| Thread safety | ReadSafe |
|---|---|
| Category | Character |
| Loaded/Saved | true |
History 5
- 726 Change Default of LoadCharacterAppearance from true to
- 553 Change Default of LoadCharacterAppearance from to true
- 486 Change ThreadSafety of LoadCharacterAppearance from ReadOnly to ReadSafe
- 462 Change ThreadSafety of LoadCharacterAppearance from to ReadOnly
- 218 Add LoadCharacterAppearance
LoadCharacterLayeredClothing
| Type | Default | |
|---|---|---|
| LoadCharacterLayeredClothing | ||
Indicates whether characters spawning into an experience will have layered clothing accessories equipped on them (Although Workspace.MeshPartHeadsAndAccessories also need to be enabled in the Workspace).
| Thread safety | ReadSafe |
|---|---|
| Category | Character |
| Loaded/Saved | false |
History 3
- 726 Change Default of LoadCharacterLayeredClothing from Default to
- 553 Change Default of LoadCharacterLayeredClothing from to Default
- 499 Add LoadCharacterLayeredClothing
LuaCharacterController
| Type | Default | |
|---|---|---|
| CharacterControlMode | ||
Determines which character controller implementation drives the player's
character movement. Accepts a value from CharacterControlMode:
Default, Legacy, NoCharacterController, or LuaCharacterController.
| Thread safety | ReadSafe |
|---|---|
| Category | Controls |
| Loaded/Saved | true |
History 3
- 726 Change Default of LuaCharacterController from Default to
- 700 Change Tags of LuaCharacterController from [NotBrowsable] to []
- 603 Add LuaCharacterController
NameDisplayDistance
| Type | Default | |
|---|---|---|
| float | ||
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.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | true |
History 5
- 726 Change Default of NameDisplayDistance from 100 to
- 553 Change Default of NameDisplayDistance from to 100
- 486 Change ThreadSafety of NameDisplayDistance from ReadOnly to ReadSafe
- 462 Change ThreadSafety of NameDisplayDistance from to ReadOnly
- 172 Add NameDisplayDistance
UserEmotesEnabled
| Type | Default | |
|---|---|---|
| bool | ||
This property determines if user-owned emotes are loaded when loading
avatars. Setting this property to false disables loading. Developers can
set the property in Studio directly.
When emote loading is disabled, the emotes UI will still work as long as developers choose to use the emotes feature by adding emotes within their game.
See also Avatar Emotes, an article detailing how to control, customize, and play avatar emotes.
| Thread safety | ReadSafe |
|---|---|
| Category | Character |
| Loaded/Saved | true |
History 6
- 726 Change Default of UserEmotesEnabled from true to
- 553 Change Default of UserEmotesEnabled from to true
- 486 Change ThreadSafety of UserEmotesEnabled from ReadOnly to ReadSafe
- 462 Change ThreadSafety of UserEmotesEnabled from to ReadOnly
- 402 Change WriteSecurity of UserEmotesEnabled from RobloxScriptSecurity to None
- 384 Add UserEmotesEnabled
Removed members 16
AnimationCompositorMode
| Type | Default | |
|---|---|---|
| AnimationCompositorMode | Default | |
| Thread safety | ReadSafe |
|---|---|
| Category | Character |
| Loaded/Saved | true |
History 2
- 608 Remove AnimationCompositorMode
- 594 Add AnimationCompositorMode
DeathStyle
| Type | Default | |
|---|---|---|
| DeathStyle | Default | |
| Thread safety | ReadSafe |
|---|---|
| Category | Character |
| Loaded/Saved | true |
History 2
- 620 Remove DeathStyle
- 587 Add DeathStyle
HumanoidStateMachineMode
| Type | Default | |
|---|---|---|
| HumanoidStateMachineMode | Default | |
| Thread safety | ReadSafe |
|---|---|
| Category | Controls |
| Loaded/Saved | true |
History 3
- 608 Remove HumanoidStateMachineMode
- 553 Change Default of HumanoidStateMachineMode from to Default
- 549 Add HumanoidStateMachineMode
RagdollDeath
| Type | Default | |
|---|---|---|
| bool | true | |
| Thread safety | ReadSafe |
|---|---|
| Category | Character |
| Loaded/Saved | true |
History 2
- 700 Remove RagdollDeath
- 670 Add RagdollDeath
ScreenOrientation
| Type | Default | |
|---|---|---|
| ScreenOrientation | ||
| Category | |
|---|---|
| Loaded/Saved | false |
History 4
- 290 Remove ScreenOrientation
- 285 Add ScreenOrientation
- 284 Remove ScreenOrientation
- 285 Add ScreenOrientation
ScreenOrientationChanged
| Parameters (2) | |
|---|---|
| newOrientation | ScreenOrientation |
| fromSensor | bool |