StarterPlayer

Mostrar obsoleto

*Este conteúdo é traduzido por IA (Beta) e pode conter erros. Para ver a página em inglês, clique aqui.

Não criável
Serviço

Um serviço que permite que os padrões de propriedades no objeto Player sejam configurar.Quando um jogador entra no servidor, cada propriedade do objeto do jogador é definida para o valor atual da propriedade correspondente em StarterPlayer .

Além disso, você pode adicionar quatro objetos a este serviço:

  • Uma instância StarterPlayerScripts com scripts que executam uma vez para cada jogador.
  • Uma instância StarterCharacterScripts com scripts para adicionar ao personagem de cada jogador sempre que eles Gerar.
  • Uma instância Humanoid chamada StarterHumanoid que será usada como o humanoide padrão para o personagem de cada jogador.
  • Uma instância Model chamada StarterCharacter que será usada como modelo de personagem para todos os jogadores.

Resumo

Propriedades

Propriedades

AllowCustomAnimations

Oculto
Segurança do script Roblox
Ler Parallel

Essa propriedade descreve os níveis de permissão do jogo atual em relação ao avatar personalizado Animations.

Como tal, esse valor não pode ser alterado dentro do jogo.Só pode ser alterado alterando os níveis de permissão do jogo dentro da página de configuração do jogo no site.

Essa propriedade não é destinada para uso no jogo.

AutoJumpEnabled

Ler Parallel

Essa propriedade define se o personagem vai pular automaticamente ao atingir um obstáculo em um dispositivo móvel.

Essa propriedade é copiada do StarterPlayer para um Player quando eles se juntam ao jogo.Depois disso.o valor desta propriedade é copiado para a propriedade Humanoid.AutoJumpEnabled da propriedade do personagem Humanoid no momento do Gerar.Em outras palavras, é possível definir o comportamento de pulo automático em uma base por personagem, por jogador e por jogo usando essas três propriedades.

Amostras de código

Este exemplo de código é destinado a um TextButton. Ele permite que o jogador alterne o comportamento de pulo automático enquanto estiver em um dispositivo móvel.

Alternar Pulo Automático

local Players = game:GetService("Players")
local player = Players.LocalPlayer
local button = script.Parent
local function update()
-- Atualizar texto do botão
if player.AutoJumpEnabled then
button.Text = "Auto-Jump is ON"
else
button.Text = "Auto-Jump is OFF"
end
-- Reflete a propriedade no personagem do jogador, se ele tiver uma
if player.Character then
local human = player.Character:FindFirstChild("Humanoid")
if human then
human.AutoJumpEnabled = player.AutoJumpEnabled
end
end
end
local function onActivated()
-- Alternar pulo automático
player.AutoJumpEnabled = not player.AutoJumpEnabled
-- Atualize tudo o mais
update()
end
button.Activated:Connect(onActivated)
update()

AvatarJointUpgrade

Não replicado
Não scriptável
Não navegável
Ler Parallel

CameraMaxZoomDistance

Ler Parallel

Essa propriedade define a distância máxima em studs que a câmera pode estar do personagem com as câmeras padrão.

Essa propriedade define o valor padrão de Player.CameraMaxZoomDistance para cada jogador que se junta ao jogo.Se esse valor for definido para um valor inferior a StarterPlayer.CameraMinZoomDistance , ele será aumentado para CameraMinZoomDistance.

Amostras de código

The example demonstrates how to set a player's camera minimum and maximum zoom distance.

In this example, we set the Player.CameraMinZoomDistance and Player.CameraMaxZoomDistance to set the min and max distance in studs a player's camera can be from their character.

Note that since the example attempts to set the CameraMinZoomDistance to be greater than the CameraMaxZoomDistance, the CameraMinZoomDistance value will be decreased and set to the value of the max zoom distance.

To change the default min and max zoom distance values for a player when they first enter the game, you can change the StarterClass.Player.CameraMinZoomDistance and StarterClass.Player.CameraMaxZoomDistance properties.

Setting Camera Zoom Distance

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

CameraMinZoomDistance

Ler Parallel

Essa propriedade define a distância mínima em studs que a câmera pode estar do personagem com as câmeras padrão.

Essa propriedade define o valor padrão de Player.CameraMinZoomDistance para cada jogador que se junta ao jogo.Se esse valor for definido para um valor maior que StarterPlayer.CameraMaxZoomDistance , ele será reduzido para CameraMaxZoomDistance.

Amostras de código

The example demonstrates how to set a player's camera minimum and maximum zoom distance.

In this example, we set the Player.CameraMinZoomDistance and Player.CameraMaxZoomDistance to set the min and max distance in studs a player's camera can be from their character.

Note that since the example attempts to set the CameraMinZoomDistance to be greater than the CameraMaxZoomDistance, the CameraMinZoomDistance value will be decreased and set to the value of the max zoom distance.

To change the default min and max zoom distance values for a player when they first enter the game, you can change the StarterClass.Player.CameraMinZoomDistance and StarterClass.Player.CameraMaxZoomDistance properties.

Setting Camera Zoom Distance

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

CameraMode

Ler Parallel

Define o valor padrão para Player.CameraMode para cada jogador no jogo. A câmera tem dois modos:

Primeira Pessoa

No modo de primeira pessoa, a câmera do jogador é ampliada até o fim.A menos que haja uma GUI visível presente com o conjunto de propriedades GuiButton.Modal definido para true, o mouse será bloqueado e a câmera do usuário girará à medida que o mouse se move.

Terceira Pessoa

No modo de terceira pessoa (padrão), o personagem pode ser visto na Câmera. Enquanto no modo de terceira pessoa no Roblox:

  • Você pode clicar com o botão direito e arrastar para girar sua Câmera, ou usar as setas nas teclas no canto inferior direito da tela.
  • Quando você move o mouse, sua câmera não muda (a menos que você mova o mouse para o fim da tela).
  • Quando você pressiona qualquer uma das setas de direção, o personagem do usuário vai se enfrentar na direção da chavede direção correspondente.
  • Você pode ampliar e reduzir livremente.

Amostras de código

This example demonstrates how to change the character's CameraMode to first person using the LockFirstPerson value of the Enum.CameraMode enum.

Playing in First Person

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

CharacterJumpHeight

Ler Parallel

Essa propriedade determina o valor inicial de Humanoid.JumpHeight para um jogador de Player.Character. O valor dessa propriedade padrão é de 7,2 metros.

Essa propriedade só é visível na janela Propriedades se StarterPlayer.CharacterUseJumpPower for definida como false, pois não seria relevante de outra forma.

Como essa propriedade só é relevante para personagens sendo gerados no futuro, alterá-la não alterará nenhum personagem de jogador existente.As alterações nesta propriedade só terão efeito quando um jogador respawnar.

CharacterJumpPower

Ler Parallel

Essa propriedade determina o valor inicial de Humanoid.JumpPower para o Player.Character de um jogador.O valor desta propriedade padrão é 50 e, quando aplicado ao Humanoid do jogador, será limitado entre 0 e 1000.

Essa propriedade só é visível na janela Propriedades se StarterPlayer.CharacterUseJumpPower for definida como true, pois não seria relevante de outra forma.

Como essa propriedade só é relevante para personagens sendo gerados no futuro, alterá-la não alterará nenhum personagem de jogador existente.As alterações nesta propriedade só terão efeito quando um jogador respawnar.

CharacterMaxSlopeAngle

Ler Parallel

Essa propriedade determina o valor inicial de Humanoid.MaxSlopeAngle para o Player.Character de um jogador.Ele padrãoiza para 89°, então humanóides podem escalar praticamente qualquer declive que desejem por padrão.Quando aplicado ao Humanoid do jogador, ele será limitado entre 0 e 89.

Como essa propriedade só é relevante para personagens sendo gerados no futuro, alterá-la não alterará nenhum personagem de jogador existente.As alterações nesta propriedade só terão efeito quando um jogador respawnar.

CharacterUseJumpPower

Ler Parallel

CharacterUseJumpPower determina o valor inicial de Humanoid.UseJumpPower para um jogador Player.Character .Alterná-lo mudará qual propriedade é visível na janela de propriedades: CharacterJumpHeight (falso) ou StarterPlayer.CharacterJumpPower (verdadeiro).Padrão para verdadeiro.

Como essa propriedade só é relevante para personagens sendo gerados no futuro, alterá-la não alterará nenhum personagem de jogador existente.As alterações nesta propriedade só terão efeito quando um jogador respawnar.

CharacterWalkSpeed

Ler Parallel

Essa propriedade determina o valor inicial de Humanoid.WalkSpeed para um jogador de Player.Character. Essa propriedade padrão é 16.

Como essa propriedade só é relevante para personagens sendo gerados no futuro, alterá-la não alterará nenhum personagem de jogador existente.As alterações nesta propriedade só terão efeito quando um jogador respawnar.

ClassicDeath

Não navegável
Ler Parallel

DevCameraOcclusionMode

Ler Parallel

Define como os scripts de câmera padrão lidam com objetos entre a câmera e o assunto da câmera.Aplica-se a todos os jogadores ao entrarem na experiência e não pode ser alterado para jogadores individuais.

O valor padrão é Zoom (0). Veja Enum.DevCameraOcclusionMode para uma lista de modos disponíveis.

DevComputerCameraMovementMode

Ler Parallel

Essa propriedade permite que o desenvolvedor substitua o modo de câmera do jogador se o jogador estiver em um computador.

Esta é a propriedade padrão para os jogadores que se juntam ao jogo. Pode ser alterada para jogadores individuais por meio da configuração do Player.DevComputerCameraMode.

Se definido para UserChoice então o modo de movimento da câmera do jogador será determinado pelo que o jogador definir nas configurações do jogo.Caso contrário, o modo será definido com base nesta propriedade.

Veja Enum.DevComputerCameraMovementMode para os diferentes modos de câmera disponíveis.

Essa propriedade não tem efeito em jogadores não em um computador.

Amostras de código

The example demonstrates how to set a player's camera movement mode for players on a computer.

In this example, we set the camera movement mode to Classic via the Enum.DevComputerCameraMovementMode enum. This means that the camera of players on touch enabled devices will track the player but will not automatically rotate if the player walks left or right.

Setting a Player's Camera Movement Mode (Desktop)

local Players = game:GetService("Players")
local player = Players.LocalPlayer
-- Set the player's camera movement mode on computers to classic
player.DevComputerCameraMode = Enum.DevComputerCameraMovementMode.Classic

DevComputerMovementMode

Ler Parallel

Essa propriedade permite que o desenvolvedor substitua o modo de movimento do jogador se o jogador estiver em um computador.

Esta é a propriedade padrão para os jogadores que se juntam ao jogo. Pode ser alterada para jogadores individuais por meio da configuração do Player.DevComputerMovementMode.

Se definido para UserChoice então o modo de movimento do jogador será determinado por qualquer coisa que o jogador defina nas configurações do jogo.Caso contrário, o modo será definido com base nesta propriedade.

Veja Enum.DevComputerMovementMode para os diferentes modos de movimento disponíveis. Permita que o desenvolvedor substitua o modo de movimento do jogador se o jogador estiver em um computador.

Essa propriedade não tem efeito em jogadores não em um computador.

Amostras de código

Demonstrates how to set the movement mode for players on computers using the Player.DevComputerMovementMode property.

Setting a Player's Movement Mode (Desktop)

local Players = game:GetService("Players")
local function onPlayerAdded(player: Player)
-- Set the player's movement mode on desktop devices to click-to-move
-- Once set, the player can right click in the game world and the character will move there.
player.DevComputerMovementMode = Enum.DevComputerMovementMode.ClickToMove
end
Players.PlayerAdded:Connect(onPlayerAdded)

DevTouchCameraMovementMode

Ler Parallel

Essa propriedade permite que o desenvolvedor substitua o modo de câmera do jogador se o jogador estiver em um dispositivo de toque.

Esta é a propriedade padrão para os jogadores que se juntam ao jogo. Pode ser alterada para jogadores individuais por meio da configuração do Player.DevTouchCameraMode.

Se definido para UserChoice então o modo de movimento da câmera do jogador será determinado pelo que o jogador definir nas configurações do jogo.Caso contrário, o modo será definido com base nesta propriedade.

Veja Enum.DevTouchCameraMovementMode para os diferentes modos de câmera disponíveis.

Essa propriedade não afeta jogadores não em um dispositivo móvel.

Amostras de código

The example demonstrates how to set a player's camera movement mode.

In this example, we set the camera movement mode to Classic via the Enum.DevTouchCameraMovementMode enum. This means that the camera of players on touch enabled devices will track the player but will not automatically rotate if the player walks left or right.

Setting a Player's Camera Movement Mode (Touch)

local Players = game:GetService("Players")
local player = Players.LocalPlayer
-- Set the player's camera movement mode on mobile devices to classic
player.DevTouchCameraMovementMode = Enum.DevTouchCameraMovementMode.Classic

DevTouchMovementMode

Ler Parallel

Essa propriedade permite que o desenvolvedor substitua o modo de movimento do jogador se o jogador estiver em um dispositivo de toque.

Esta é a propriedade padrão para os jogadores que se juntam ao jogo. Pode ser alterada para jogadores individuais por meio da configuração do Player.DevTouchMovementMode.

Se definido para UserChoice então o modo de movimento do jogador será determinado por qualquer coisa que o jogador defina nas configurações do jogo.Caso contrário, o modo será definido com base nesta propriedade.

Veja Enum.DevTouchMovementMode para os diferentes modos de movimento disponíveis. Permita que o desenvolvedor substitua o modo de movimento do jogador se o jogador estiver em um dispositivo de toque.

Essa propriedade não afeta jogadores que não estão em um dispositivo com suporte ao toque.

Amostras de código

The example demonstrates how to set the movement mode for players on touch enabled devices.

In this example, we set the movement mode to Thumbstick via the Enum.DevTouchMovementMode enum. This means that players on touch enabled devices are able to move via a virtual thumbstick on their screen.

Setting a Player's Movement Mode (Touch)

local Players = game:GetService("Players")
game.Players.PlayerAdded:Connect(function(player)
-- Set the player's movement mode on mobile devices to a dynamic thumbstick
player.DevTouchMovementMode = Enum.DevTouchMovementMode.DynamicThumbstick
end)

EnableDynamicHeads

Não scriptável
Ler Parallel

EnableMouseLockOption

Ler Parallel

Essa propriedade determina se um jogador pode ativar o bloqueio do mouse por padrão.

O Mouse Lock bloqueará o cursor do jogador no centro da tela.Mover o mouse girará o Camera e Player se moverá em relação à rotação atual da Câmera.

Essa propriedade define o valor de Player.DevEnableMouseLock .

Observe que as APIs relacionadas ao shift-lock estão em processo de serem descontinuar, portanto, é recomendado usar UserInputService.MouseBehavior em vez disso para bloquear o mouse.

Amostras de código

The example demonstrates how to enable and disabled whether a player can lock their mouse.

In this example, we set the use a while true loop to toggle the state of the DevEnabledMouseLock property between true and false every 5 seconds. While this example has little practical use, it demos how to change the property via a LocalScript.

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

Ler Parallel

Essa propriedade define a distância em studs em que esse jogador verá outras barras de saúde Humanoid.Se definido como 0, as barras de saúde não serão exibidas.Essa propriedade é definida como 100 studs por padrão.

Para alterar a distância de exibição para um jogador assim que ele se juntar ao jogo, você pode definir a propriedade Player.HealthDisplayDistance.

Se uma barra de saúde Humanoid for visível, você pode definir o tipo de exibição usando Humanoid.DisplayDistanceType.

Amostras de código

This example demonstrates how to hide other Humanoid's (Player and NPC) health bars and names.

This is done by setting the player's Player.HealthDisplayDistance and Player.NameDisplayDistance properties to 0.

If you would like to display health bars and names, you set the properties to a value greater than 0. For instance, setting the properties to 100 means that the player will see other player's health and names up to 100 studs away.

To modify the default values for players, you can change the values of the StarterClass.Player.HealthDisplayDistance and StarterClass.Player.NameDisplayDistance properties.

Hiding Player Health and Names

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

LoadCharacterAppearance

Ler Parallel

Essa propriedade define se a aparência do personagem de um jogador deve ser carregada ou não.

Definir isso para false resulta no jogador não ter roupas (incluindo chapéus), cores do corpo, pacotes de corpo ou qualquer outra coisa relacionada à aparência do avatar do jogador.Por padrão, esta propriedade é definida como true .

Definir isso para resulta na carga do jogador da aparência correspondente ao jogador de .

Se Player:LoadCharacterWithHumanoidDescription() for usado, pode ser vantajoso definir StarterPlayer.LoadCharacterAppearance como falso, pois o avatar do jogador não é necessário, pois todas as IDs de recursos para equipar no personagem virão do HumanoidDescription passado.

Amostras de código

This example demonstrates how to disable loading a player's character appearance. Instead, the player loads as a grey model without any hats, shirts, pants, etc.

This is useful for games using custom clothing and accessories.

Note that if the character has already spawned, this change will not take affect until the player respawns or the Player:LoadCharacter() function is called.

Disabling a Player's Appearance

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

LoadCharacterLayeredClothing

Não replicado
Não scriptável
Ler Parallel

Indica se os personagens que aparecem em uma experiência terão acessórios de roupas em camadas equipados neles (embora também precise ser ativado no ).

LuaCharacterController

Não navegável
Ler Parallel

NameDisplayDistance

Ler Parallel

Define a distância em que este jogador verá outros nomes Humanoid .Se definido para 0, os nomes são ocultados.Essa propriedade é definida como 100 studs por padrão.

Para alterar a distância de exibição para um jogador assim que ele se juntar ao jogo, você pode definir a propriedade Player.NameDisplayDistance.

Se um nome Humanoid visível, você pode definir o tipo de exibição usando Humanoid.DisplayDistanceType.

Amostras de código

This example demonstrates how to hide other Humanoid's (Player and NPC) health bars and names.

This is done by setting the player's Player.HealthDisplayDistance and Player.NameDisplayDistance properties to 0.

If you would like to display health bars and names, you set the properties to a value greater than 0. For instance, setting the properties to 100 means that the player will see other player's health and names up to 100 studs away.

To modify the default values for players, you can change the values of the StarterClass.Player.HealthDisplayDistance and StarterClass.Player.NameDisplayDistance properties.

Hiding Player Health and Names

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

RagdollDeath

Não navegável
Ler Parallel

UserEmotesEnabled

Ler Parallel

Essa propriedade determina se emotes de propriedade do usuário são carregados ao carregar avatares.Definir esta propriedade como falsa desabilita o carregamento.Os desenvolvedores podem definir a propriedade no Studio diretamente ou através do menu Configurações do Jogo.

Quando a carga de emotes for desativada, a interface de emotes ainda funcionará enquanto os desenvolvedores optarem por usar o recurso de emotes adicionando emotes dentro de seu jogo.

Veja também Emotes de Avatar, um artigo que detalha como controlar, personalizar e jogar emotes de avatar.

Métodos

Eventos