InputObject
*Este contenido se traduce usando la IA (Beta) y puede contener errores. Para ver esta página en inglés, haz clic en aquí.
Un objeto de entrada representa una sola entrada de un usuario, como el movimiento del mouse, los toques, la presión de teclas y más. Se crea cuando comienza una entrada.
Las propiedades de este objeto varían según el UserInputType.Cada tipo de entrada pasará por varios cambios a su UserInputState .Durante la vida útil de una entrada, otras propiedades que describan más a la entrada pueden cambiar, como Position y Delta.Los presionamientos de teclado y botón del gamepad tendrán el establecerde propiedades KeyCode.
Una vez creado al comienzo de una entrada, el mismo objeto persiste y se actualiza hasta que termina la entrada.Como resultado, puedes rastrear los cambios del objeto utilizando el evento Changed cuando el usuario cambia la entrada en cuestión.También puedes colocar estos objetos en una lista de pistas de entrada activas e interactuar con el objeto después de su creación por un evento como UserInputService.InputBegan .Esto es principalmente útil para eventos táctiles, ya que cada punto de toque tendrá un objeto de entrada separado.
Vea también:
- ContextActionService , que pasa un objeto de entrada a bound funciones de manejo de acciones
- UserInputService , cuyos eventos y funciones a menudo usan InputObject
- GuiObject , cuyos eventos relacionados con la entrada del usuario usan InputObject
Muestras de código
El siguiente ejemplo muestra uno de los muchos ejemplos de uso de manejar la entrada del usuario desde InputBegan dependiendo de su tipo.
-- Para utilizar el evento InputBegan, se debe utilizar el servicio UserInputService
local UserInputService = game:GetService("UserInputService")
-- Una función de muestra que proporciona múltiples casos de uso para varios tipos de entrada de usuario
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)Resumen
Propiedades
Un Vector3 que describe el Delta entre los movimientos del ratón/joystick.
Contiene un Enum que describe el tipo de entrada utilizada.
Describe un valor posicional de esta entrada.
Describe el estado de una entrada que se está realizando, siguiendo un flujo específico dependiendo del UserInputType.
Describe el tipo de entrada que se está realizando (ratón, teclado, controlador para juego, toque, etc.).
Métodos
Propiedades
Delta
Un Vector3 que describe el Delta (cambio) entre los movimientos del ratón/joystick.
Esto es útil cuando se usa con el input's position para rastrear la posición y el movimiento del mouse/joystick del usuario, como cuando estás creando movimientos personalizados o guiones de cámara.Considera realizar cambios de seguimiento en el objeto de entrada utilizando el evento Object.Changed o cuando el usuario cambia la entrada a través de eventos como UserInputService.InputChanged y GuiObject.InputChanged .
Tenga en cuenta que un InputObject correspondiente a Enum.UserInputType.MouseButton1 (hcer clicizquierdo) y Enum.UserInputType.MouseButton2 (hcer clicderecho) suministrado desde un InputBegan llamada de devolución no tendrá su Delta o Position actualizado una vez creado, excepto cuando la entrada del mouse termina.Para obtener deltas actualizados para las entradas del mouse, debes referenciar un InputObject desde una llamada de devolución InputChanged o llamar GetMouseDelta() .Sin embargo, cualquier InputObjects correspondiente a las entradas de toque tendrá su delta y posición actualizados en cada marco a lo largo de su vida útil.
Vea también:
Muestras de código
Este ejemplo crea un guión de binoculares que reduce los clics del jugador FieldOfView() y MouseDeltaSensitivity() cuando un jugador con un MouseEnabled() deja clics del mouse.El script también apunta la posición del jugador Camera hacia la posición mundial del clic del mouse Vector3.
Cuando el jugador vuelve a hacer clic con el ratón, la cámara del jugador se revertirá al campo de visión personalizado Enum.CameraType con el mismo campo de visión y CFrame() como antes de que el jugador se acercara con el script.
Mientras el jugador usa los binoculares, el script bloquea el mouse del jugador en el centro de la pantalla al establecer el mouse del jugador en MouseBehavior().La cámara del jugador se mueve cuando el jugador mueve el mouse de acuerdo con la propiedad que pasa por indicando el cambio de posición en la pantalla del mouse.
Para que este ejemplo funcione como se esperaba, debe colocarse en un 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
-- Restablecer la cámara de vuelta a CFrame y FieldOfView antes de 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 la cámara sea cambiada por el script
camera.CameraType = Enum.CameraType.Scriptable
-- Almacenar las propiedades de la cámara antes de hacer zoom
originalProperties._CFrame = camera.CFrame
originalProperties.FieldOfView = camera.FieldOfView
originalProperties.MouseBehavior = UserInputService.MouseBehavior
originalProperties.MouseDeltaSensitivity = UserInputService.MouseDeltaSensitivity
-- Cámara de zoom
target = mouse.Hit.Position
local eyesight = head.Position
camera.CFrame = CFrame.new(eyesight, target)
camera.Focus = CFrame.new(target)
camera.FieldOfView = 10
-- Bloquear y ralentizar el mouse
UserInputService.MouseBehavior = Enum.MouseBehavior.LockCenter
UserInputService.MouseDeltaSensitivity = 1
-- Restablecer ángulos de zoom
AngleX, TargetAngleX = 0, 0
AngleY, TargetAngleY = 0, 0
end
-- Alternar zoom de la cámara/des zoom
local function MouseClick()
if zoomed then
-- Desenfoquear cámara
ResetCamera()
else
-- Zoom en la cámara
ZoomCamera()
end
zoomed = not zoomed
end
local function MouseMoved(input)
if zoomed then
local sensitivity = 0.6 -- cualquier cosa más alta haría que buscar hacia arriba y hacia abajo fuera más difícil; recomiende cualquier cosa entre 0~1
local smoothness = 0.05 -- recomendar cualquier cosa 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
Contiene un Enum.KeyCode enumerado que describe qué tipo de entrada se utilizó.Para tipos de entrada como el teclado, esto describe qué tecla se presionó.Para las entradas como el ratón, esto no proporciona información adicional.
Enumeraciones
| Nombre |
|---|
Vea también:
Muestras de código
Este ejemplo obtiene una lista de gamepads de navegación y una lista de sus soportados Enum.KeyCodes.Entonces, itera a través de la lista de códigos de clave admitidos y vincula las teclas ButtonX y X a funciones si son admitidas por un gamepad usando el 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
-- Dado que esta función no devuelve nada, este manipulador devolverá
-- ""drenar'' la entrada y no se llamarán a otros manipuladores de acción después
-- esta.
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
Esta propiedad describe un valor posicional de Vector3 de esta entrada.
Para la entrada del ratón y el toque, esta es la posición de la pantalla del ratón/toque, descrita en los componentes X y Y.El inserto aplicado a los elementos de la interfaz de usuario (como de la barra superior) se tiene en cuenta en la posición.
Para la entrada del ratón, el componente Z describe si la rueda se movió hacia adelante (1), hacia atrás (-1) o no en absoluto (0).
Para la entrada Enum.KeyCode , esto indica la posición del jugador Mouse .
Tenga en cuenta que un InputObject correspondiente a Enum.UserInputType.MouseButton1 (hcer clicizquierdo) y Enum.UserInputType.MouseButton2 (hcer clicderecho) suministrado desde un InputBegan llamada de devolución no tendrá su Delta o Position actualizado una vez creado, excepto cuando la entrada del mouse termina.Para obtener posiciones actualizadas para las entradas del mouse, debes referenciar un InputObject desde una llamada de devolución InputChanged o llamar GetMouseLocation() .Sin embargo, cualquier InputObjects correspondiente a las entradas de toque tendrá su delta y posición actualizados en cada marco a lo largo de su vida útil.
Véase también
Muestras de código
El siguiente ejemplo muestra uno de los muchos ejemplos de uso de manejar la entrada del usuario desde InputBegan dependiendo de su tipo.
-- Para utilizar el evento InputBegan, se debe utilizar el servicio UserInputService
local UserInputService = game:GetService("UserInputService")
-- Una función de muestra que proporciona múltiples casos de uso para varios tipos de entrada de usuario
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 de usuario describe el estado de una entrada que se está realizando, después de un flujo específico dependiendo del >.Utiliza el enumerado del mismo nombre, Enum.UserInputState .Vea la página de enumeración para obtener una lista de todos los valores posibles para esta propiedad.
Vea también:
Muestras de código
Este ejemplo obtiene una lista de gamepads de navegación y una lista de sus soportados Enum.KeyCodes.Entonces, itera a través de la lista de códigos de clave admitidos y vincula las teclas ButtonX y X a funciones si son admitidas por un gamepad usando el 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
-- Dado que esta función no devuelve nada, este manipulador devolverá
-- ""drenar'' la entrada y no se llamarán a otros manipuladores de acción después
-- esta.
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 de usuario es una propiedad que describe para qué tipo de entrada representa este InputObject, como entrada de ratón, teclado, toque o gamepad.Utiliza el enumerado del mismo nombre, Enum.UserInputType .Vea la página de enumeración para obtener una lista de todos los valores posibles para esta propiedad.
Vea también:
Muestras de código
El siguiente ejemplo muestra uno de los muchos ejemplos de uso de manejar la entrada del usuario desde InputBegan dependiendo de su tipo.
-- Para utilizar el evento InputBegan, se debe utilizar el servicio UserInputService
local UserInputService = game:GetService("UserInputService")
-- Una función de muestra que proporciona múltiples casos de uso para varios tipos de entrada de usuario
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)