InputObject
*Este conteúdo é traduzido por IA (Beta) e pode conter erros. Para ver a página em inglês, clique aqui.
Um Objeto de Entrada representa uma única entrada do usuário, como movimento do mouse, toques, pressionamentos de tecla e muito mais. Ele é criado quando uma entrada começa.
As propriedades deste objeto variam de acordo com o UserInputType.Cada tipo de entrada passará por várias mudanças em seu UserInputState.Durante a vida de uma entrada, outras propriedades que descrevem a entrada podem mudar, como Position e Delta.Pressões de teclado e botões de gamepad terão o configurarde propriedades KeyCode.
Uma vez criado no início de uma entrada, o mesmo objeto persiste e é atualizado até que a entrada termine.Como resultado, você pode rastrear as alterações do Objetousando o evento Changed quando o usuário muda a entrada em questão.Você também pode colocar esses objetos em uma lista de entradas ativas e interagir com o objeto após sua criação por um evento como UserInputService.InputBegan.Isso é principalmente útil para eventos de toque, pois cada ponto de toque terá um objeto de entrada separado.
Veja também:
- ContextActionService , que passa um objeto de entrada para bound funções de manipulação de ação
- UserInputService , cujos eventos e funções muitas vezes usam InputObject
- GuiObject , cujos eventos relacionados à entrada do usuário usam o InputObject
Amostras de código
O seguinte exemplo demonstra um dos muitos exemplos de uso de lidar com a entrada do usuário a partir de InputBegan dependendo de seu tipo.
-- Para usar o evento InputBegan, o serviço UserInputService deve ser usado
local UserInputService = game:GetService("UserInputService")
-- Uma função de amostra que fornece vários casos de uso para vários tipos de entrada do usuário
UserInputService.InputBegan:Connect(function(input, gameProcessed)
if input.UserInputType == Enum.UserInputType.Keyboard then
print("A key is being pushed down! Key:", input.KeyCode)
elseif input.UserInputType == Enum.UserInputType.MouseButton1 then
print("The left mouse button has been pressed down at", input.Position)
elseif input.UserInputType == Enum.UserInputType.MouseButton2 then
print("The right mouse button has been pressed down at", input.Position)
elseif input.UserInputType == Enum.UserInputType.Touch then
print("A touchscreen input has started at", input.Position)
elseif input.UserInputType == Enum.UserInputType.Gamepad1 then
print("A button is being pressed on a gamepad! Button:", input.KeyCode)
end
if gameProcessed then
print("The game engine internally observed this input!")
else
print("The game engine did not internally observe this input!")
end
end)Resumo
Propriedades
Um Vector3 que descreve o Delta entre os movimentos do mouse/joystick.
Contém um Enum que descreve o tipo de entrada usada.
Descreve um valor posicional desta entrada.
Descreve o estado de uma entrada sendo executada, após um fluxo específico dependendo do UserInputType.
Descreve o tipo de entrada que está sendo realizada (mouse, teclado, controle / controle de jogo, toque, etc).
Métodos
Propriedades
Delta
Um Vector3 descrevendo o Delta (mudança) entre os movimentos do mouse/joystick.
Isso é útil quando usado com o input's position para rastrear a posição e o movimento do mouse/joystick do usuário, como quando você está criando scripts de movimento personalizados ou câmera.Considere alterações de entrada de objetos de rastreamento usando o evento Object.Changed ou quando as alterações de entrada do usuário via eventos, como UserInputService.InputChanged e GuiObject.InputChanged , ocorrem.
Observe que um InputObject correspondente a Enum.UserInputType.MouseButton1 (clique à esquerda) e Enum.UserInputType.MouseButton2 (clique à direita) fornecido por um InputBegan callback não terá seu Delta ou Position atualizado uma vez criado, exceto quando a entrada do mouse termina.Para obter deltas atualizados para entradas de mouse, você deve, em vez disso, referenciar um InputObject de um InputChanged de retorno de chamada ou chamar GetMouseDelta() .No entanto, qualquer InputObjects correspondente a entradas de toque terá seu delta e posição atualizados a cada quadro durante toda a vida útil.
Veja também:
Amostras de código
Este exemplo cria um script de binóculos que diminui os cliques do mouse do jogador FieldOfView() e MouseDeltaSensitivity() quando um jogador com um MouseEnabled() esquerda os cliques do mouse.O script também aponta a posição do jogador Camera para a posição mundial do clique do mouse Vector3.
Quando o jogador deixou os cliques do mouse novamente, a câmera do jogador reverte de volta para o a personalizado Enum.CameraType com o mesmo campo de visão e CFrame() como antes do jogador se aproximar com o script.
Enquanto o jogador usa os binóculos, o script bloqueia o mouse do jogador no centro da tela, definindo o mouse do jogador para BloquearCentro.A câmera do jogador se move quando o jogador move o mouse de acordo com a propriedade que passa por indicando a mudança de posição na tela do mouse.
Para que este exemplo funcione como esperado, ele deve ser colocado em um LocalScript .
local UserInputService = game:GetService("UserInputService")
local Players = game:GetService("Players")
local player = Players.LocalPlayer
local character = player.CharacterAdded:Wait()
local head = character:WaitForChild("Head", false)
local mouse = player:GetMouse()
local zoomed = false
local camera = game.Workspace.CurrentCamera
local target = nil
local originalProperties = {
FieldOfView = nil,
_CFrame = nil,
MouseBehavior = nil,
MouseDeltaSensitivity = nil,
}
local AngleX, TargetAngleX = 0, 0
local AngleY, TargetAngleY = 0, 0
-- Redefina a câmera de volta para CFrame e FieldOfView antes do zoom
local function ResetCamera()
target = nil
camera.CameraType = Enum.CameraType.Custom
camera.CFrame = originalProperties._CFrame
camera.FieldOfView = originalProperties.FieldOfView
UserInputService.MouseBehavior = originalProperties.MouseBehavior
UserInputService.MouseDeltaSensitivity = originalProperties.MouseDeltaSensitivity
end
local function ZoomCamera()
-- Permitir que a câmera seja alterada por script
camera.CameraType = Enum.CameraType.Scriptable
-- Armazenar propriedades da câmera antes do zoom
originalProperties._CFrame = camera.CFrame
originalProperties.FieldOfView = camera.FieldOfView
originalProperties.MouseBehavior = UserInputService.MouseBehavior
originalProperties.MouseDeltaSensitivity = UserInputService.MouseDeltaSensitivity
-- Aproxime a câmera
target = mouse.Hit.Position
local eyesight = head.Position
camera.CFrame = CFrame.new(eyesight, target)
camera.Focus = CFrame.new(target)
camera.FieldOfView = 10
-- Tranclar e desacelerar o mouse
UserInputService.MouseBehavior = Enum.MouseBehavior.LockCenter
UserInputService.MouseDeltaSensitivity = 1
-- Redefinir ângulos de zoom
AngleX, TargetAngleX = 0, 0
AngleY, TargetAngleY = 0, 0
end
-- Alternar zoom/desZoom da câmera
local function MouseClick()
if zoomed then
-- Desfocar a câmera
ResetCamera()
else
-- Ampliar na câmera
ZoomCamera()
end
zoomed = not zoomed
end
local function MouseMoved(input)
if zoomed then
local sensitivity = 0.6 -- qualquer coisa acima tornaria a busca para cima e para baixo mais difícil; recomende qualquer coisa entre 0~1
local smoothness = 0.05 -- recomendar qualquer coisa entre 0~1
local delta = Vector2.new(input.Delta.x / sensitivity, input.Delta.y / sensitivity) * smoothness
local X = TargetAngleX - delta.y
local Y = TargetAngleY - delta.x
TargetAngleX = (X >= 80 and 80) or (X <= -80 and -80) or X
TargetAngleY = (Y >= 80 and 80) or (Y <= -80 and -80) or Y
AngleX = AngleX + (TargetAngleX - AngleX) * 0.35
AngleY = AngleY + (TargetAngleY - AngleY) * 0.15
camera.CFrame = CFrame.new(head.Position, target)
* CFrame.Angles(0, math.rad(AngleY), 0)
* CFrame.Angles(math.rad(AngleX), 0, 0)
end
end
local function InputBegan(input, _gameProcessedEvent)
if input.UserInputType == Enum.UserInputType.MouseButton1 then
MouseClick()
end
end
local function InputChanged(input, _gameProcessedEvent)
if input.UserInputType == Enum.UserInputType.MouseMovement then
MouseMoved(input)
end
end
if UserInputService.MouseEnabled then
UserInputService.InputBegan:Connect(InputBegan)
UserInputService.InputChanged:Connect(InputChanged)
endKeyCode
Contém um Enum.KeyCode enum que descreve que tipo de entrada foi usada.Para tipos de entrada como teclado, isso descreve qual tecla foi pressionada.Para entradas como o mouse, isso não fornece informações adicionais.
Enumas
| Qual o nome |
|---|
Veja também:
Amostras de código
Este exemplo obtém uma lista de gamepads de navegação e uma lista de seus suportados Enum.KeyCodes.Então, ele itera através da lista de Códigos de Chave suportada e vincula os botões ButtonX e X às funções se forem suportados por um gamepad usando o ContextActionService.
local UserInputService = game:GetService("UserInputService")
local ContextActionService = game:GetService("ContextActionService")
local function actionHandler(actionName, inputState, inputObject)
if inputState == Enum.UserInputState.Begin then
print("Action Handler: " .. actionName)
print(inputObject)
end
-- Como essa função não retorna nada, esse manipulador vai
-- “larvar” a entrada e nenhum outro manipulador de ação será chamado após
-- essa aqui
end
local navGamepads = UserInputService:GetNavigationGamepads()
for _, gamepad in pairs(navGamepads) do
local supportedKeyCodes = UserInputService:GetSupportedGamepadKeyCodes(gamepad)
for _, keycode in pairs(supportedKeyCodes) do
if keycode == Enum.KeyCode.ButtonX then
ContextActionService:BindAction("SampleAction", actionHandler, false, Enum.KeyCode.ButtonX)
end
if keycode == Enum.KeyCode.X then
ContextActionService:BindAction("SampleAction", actionHandler, false, Enum.KeyCode.X)
end
end
endPosition
Essa propriedade descreve um valor posicional de Vector3 desta entrada.
Para entrada de mouse e toque, esta é a posição da tela do mouse/toque, descrita nos componentes X e Y.O inseto aplicado a elementos de GUI (como da barra superior) é contado na posição.
Para a entrada da roda do mouse, o componente Z descreve se a roda foi movida para a frente (1), para trás (-1) ou não em tudo (0).
Para Enum.KeyCode, isso indica a posição do Mouse.
Observe que um InputObject correspondente a Enum.UserInputType.MouseButton1 (clique à esquerda) e Enum.UserInputType.MouseButton2 (clique à direita) fornecido por um InputBegan callback não terá seu Delta ou Position atualizado uma vez criado, exceto quando a entrada do mouse termina.Para obter posições atualizadas para entradas de mouse, você deve, em vez disso, referenciar um InputObject de um InputChanged de retorno de chamada ou chamar GetMouseLocation() .No entanto, qualquer InputObjects correspondente a entradas de toque terá seu delta e posição atualizados a cada quadro durante toda a vida útil.
Veja também
Amostras de código
O seguinte exemplo demonstra um dos muitos exemplos de uso de lidar com a entrada do usuário a partir de InputBegan dependendo de seu tipo.
-- Para usar o evento InputBegan, o serviço UserInputService deve ser usado
local UserInputService = game:GetService("UserInputService")
-- Uma função de amostra que fornece vários casos de uso para vários tipos de entrada do usuário
UserInputService.InputBegan:Connect(function(input, gameProcessed)
if input.UserInputType == Enum.UserInputType.Keyboard then
print("A key is being pushed down! Key:", input.KeyCode)
elseif input.UserInputType == Enum.UserInputType.MouseButton1 then
print("The left mouse button has been pressed down at", input.Position)
elseif input.UserInputType == Enum.UserInputType.MouseButton2 then
print("The right mouse button has been pressed down at", input.Position)
elseif input.UserInputType == Enum.UserInputType.Touch then
print("A touchscreen input has started at", input.Position)
elseif input.UserInputType == Enum.UserInputType.Gamepad1 then
print("A button is being pressed on a gamepad! Button:", input.KeyCode)
end
if gameProcessed then
print("The game engine internally observed this input!")
else
print("The game engine did not internally observe this input!")
end
end)UserInputState
Estado de entrada do usuário descreve o estado de uma entrada sendo realizada, após um fluxo específico dependendo do UserInputType.Ela usa o enum do mesmo nome, Enum.UserInputState .Veja a página de enumeração para uma lista de todos os valores possíveis para essa propriedade.
Veja também:
Amostras de código
Este exemplo obtém uma lista de gamepads de navegação e uma lista de seus suportados Enum.KeyCodes.Então, ele itera através da lista de Códigos de Chave suportada e vincula os botões ButtonX e X às funções se forem suportados por um gamepad usando o ContextActionService.
local UserInputService = game:GetService("UserInputService")
local ContextActionService = game:GetService("ContextActionService")
local function actionHandler(actionName, inputState, inputObject)
if inputState == Enum.UserInputState.Begin then
print("Action Handler: " .. actionName)
print(inputObject)
end
-- Como essa função não retorna nada, esse manipulador vai
-- “larvar” a entrada e nenhum outro manipulador de ação será chamado após
-- essa aqui
end
local navGamepads = UserInputService:GetNavigationGamepads()
for _, gamepad in pairs(navGamepads) do
local supportedKeyCodes = UserInputService:GetSupportedGamepadKeyCodes(gamepad)
for _, keycode in pairs(supportedKeyCodes) do
if keycode == Enum.KeyCode.ButtonX then
ContextActionService:BindAction("SampleAction", actionHandler, false, Enum.KeyCode.ButtonX)
end
if keycode == Enum.KeyCode.X then
ContextActionService:BindAction("SampleAction", actionHandler, false, Enum.KeyCode.X)
end
end
endUserInputType
Tipo de entrada do usuário é uma propriedade que descreve para que tipo de entrada este InputObject representa, como mouse, teclado, toque ou entrada de gamepad.Ela usa o enum do mesmo nome, Enum.UserInputType .Veja a página de enumeração para uma lista de todos os valores possíveis para essa propriedade.
Veja também:
Amostras de código
O seguinte exemplo demonstra um dos muitos exemplos de uso de lidar com a entrada do usuário a partir de InputBegan dependendo de seu tipo.
-- Para usar o evento InputBegan, o serviço UserInputService deve ser usado
local UserInputService = game:GetService("UserInputService")
-- Uma função de amostra que fornece vários casos de uso para vários tipos de entrada do usuário
UserInputService.InputBegan:Connect(function(input, gameProcessed)
if input.UserInputType == Enum.UserInputType.Keyboard then
print("A key is being pushed down! Key:", input.KeyCode)
elseif input.UserInputType == Enum.UserInputType.MouseButton1 then
print("The left mouse button has been pressed down at", input.Position)
elseif input.UserInputType == Enum.UserInputType.MouseButton2 then
print("The right mouse button has been pressed down at", input.Position)
elseif input.UserInputType == Enum.UserInputType.Touch then
print("A touchscreen input has started at", input.Position)
elseif input.UserInputType == Enum.UserInputType.Gamepad1 then
print("A button is being pressed on a gamepad! Button:", input.KeyCode)
end
if gameProcessed then
print("The game engine internally observed this input!")
else
print("The game engine did not internally observe this input!")
end
end)