InputObject
*Questo contenuto è tradotto usando AI (Beta) e potrebbe contenere errori. Per visualizzare questa pagina in inglese, clicca qui.
Un InputObject rappresenta un singolo input dell'utente, come il movimento del mouse, i tocchi, la pressione delle chiavi e altro ancora. Viene creato quando un input inizia.
Le proprietà di questo oggetto variano a seconda del UserInputType.Ogni tipo di input subirà vari cambiamenti al suo UserInputState .Durante la vita di un input, altre proprietà che descrivono ulteriormente l'input possono cambiare, come Position e Delta .I pulsanti della tastiera e del gamepad avranno la proprietà KeyCode Impostare.
Una volta creato all'inizio di un input, lo stesso oggetto persiste e viene aggiornato fino alla fine dell'input.Come Risultato, puoi monitorare i cambiamenti dell'oggetto utilizzando l'evento Changed quando l'utente modifica l'input in questione.Puoi anche posizionare questi oggetti in una lista di input attivi e interagire con l'oggetto dopo la sua creazione da parte di un evento come UserInputService.InputBegan .Questo è principalmente utile per gli eventi di tocco, poiché ogni punto di tocco avrà un InputObject separato.
Vedi anche:
- ContextActionService , che passa un InputObject a bound funzioni di gestione delle azioni
- UserInputService , i cui eventi e funzioni spesso utilizzano InputObject
- GuiObject , i cui eventi relativi all'uso dell'input dell'utente utilizzano InputObject
Campioni di codice
L'esempio seguente mostra uno dei molti esempi di utilizzo del trattamento dell'input dell'utente da InputBegan a seconda del suo tipo.
-- Per utilizzare l'evento InputBegan, il servizio UserInputService deve essere utilizzato
local UserInputService = game:GetService("UserInputService")
-- Una funzione di esempio che fornisce diversi casi d'uso per vari tipi di input dell'utente
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)Sommario
Proprietà
Un Vector3 che descrive il Delta tra i movimenti del mouse/joystick.
Contiene un Enum che descrive il tipo di input utilizzato.
Descrive un valore posizionale di questo input.
Descrive lo stato di un input in esecuzione, a seguito di un flusso specifico a seconda del UserInputType.
Descrive il tipo di input eseguito (鼠, Topo, or mouse as computer mouse, tastiera, gamepad, touch, ecc.).
Metodi
Proprietà
Delta
A Vector3 descrivendo il Delta (cambio) tra i movimenti del mouse/joystick.
Questo è utile quando viene utilizzato con l'input di position per tracciare la posizione e il movimento del mouse/joystick dell'utente, come quando crei script di movimento personalizzati o della fotocamera.Considera il monitoraggio dei cambiamenti dell'oggetto di input utilizzando l'evento Object.Changed o quando l'utente modifica l'input attraverso eventi come UserInputService.InputChanged e GuiObject.InputChanged .
Nota che un InputObject corrispondente a Enum.UserInputType.MouseButton1 (clic sinistro) e Enum.UserInputType.MouseButton2 (clic destro) fornito da un InputBegan callback non avrà il suo Delta o Position aggiornato una volta creato, tranne quando l'input del mouse termina.Per ottenere deltas aggiornati per gli input del mouse, devi invece fare riferimento a un InputObject da un InputChanged Richiama, o chiamare GetMouseDelta() .Tuttavia, qualsiasi InputObjects corrispondente agli input di tocco avrà il loro delta e la posizione aggiornati ogni frame durante tutta la loro vita.
Vedi anche:
Campioni di codice
Questo esempio crea uno script binocolare che diminuisce il mouse clic del giocatore FieldOfView() e MouseDeltaSensitivity() quando un giocatore con un MouseEnabled() ha lasciato i mouse clic.Lo script indica anche la posizione del mondo del mouse del giocatore Camera verso la posizione Vector3 del mouse clic.
Quando il giocatore lascia di nuovo i clic del mouse, la fotocamera del giocatore torna alla normalità con lo stesso campo visivo e come prima che il giocatore si sia zoomato con lo script.
Mentre il giocatore usa il binocolo, lo script blocca il mouse del giocatore al centro dello schermo impostando il giocatore di MouseBehavior() a BloccaCentro.La fotocamera del giocatore si muove quando il giocatore muove il mouse secondo la proprietà indicando il cambio della posizione dello schermo del mouse.
Perché questo esempio funzioni come previsto, deve essere posizionato in 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
-- Ripristina la fotocamera prima di CFrame e FieldOfView prima dello 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()
-- Permetti alla fotocamera di essere cambiata da uno script
camera.CameraType = Enum.CameraType.Scriptable
-- Memorizza le proprietà della fotocamera prima dello zoom
originalProperties._CFrame = camera.CFrame
originalProperties.FieldOfView = camera.FieldOfView
originalProperties.MouseBehavior = UserInputService.MouseBehavior
originalProperties.MouseDeltaSensitivity = UserInputService.MouseDeltaSensitivity
-- Zoom della fotocamera
target = mouse.Hit.Position
local eyesight = head.Position
camera.CFrame = CFrame.new(eyesight, target)
camera.Focus = CFrame.new(target)
camera.FieldOfView = 10
-- Blocca e rallenta il mouse
UserInputService.MouseBehavior = Enum.MouseBehavior.LockCenter
UserInputService.MouseDeltaSensitivity = 1
-- Ripristina gli angoli di zoom
AngleX, TargetAngleX = 0, 0
AngleY, TargetAngleY = 0, 0
end
-- Attiva/disattiva lo zoom della fotocamera/unzoom
local function MouseClick()
if zoomed then
-- Dismettere la fotocamera
ResetCamera()
else
-- Zoom in fotocamera
ZoomCamera()
end
zoomed = not zoomed
end
local function MouseMoved(input)
if zoomed then
local sensitivity = 0.6 -- qualcosa di più alto renderebbe più difficile cercare su e giù; raccomanda qualsiasi cosa tra 0~1
local smoothness = 0.05 -- consigliare qualsiasi cosa tra 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 enum che descrive quale tipo di input è stato utilizzato.Per i tipi di input come la tastiera, questo descrive quale tasto è stato premuto.Per gli input come il Topo, or mouse as computer mouse, questo non fornisce informazioni aggiuntive.
Enumi
| Nome |
|---|
Vedi anche:
Campioni di codice
Questo esempio ottiene un elenco di gamepad di navigazione e un elenco dei loro supportati Enum.KeyCodes.Quindi, esegue un ciclo attraverso l'elenco KeyCode supportato e lega i pulsanti ButtonX e X alle funzioni se sono supportati da un gamepad utilizzando il 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
-- Poiché questa funzione non restituisce nulla, questo handler restituirà
-- "" lavello "l'input e nessun altro gestore di azione verrà chiamato dopo
-- questo.
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
Questa proprietà descrive un valore posizionale di Vector3 di questo input.
Per l'input del mouse e del tocco, questa è la posizione dello schermo del mouse/touch, descritta nei componenti X e Y.L'inserto applicato agli elementi GUI (come dalla barra superiore) viene contato nella posizione.
Per l'input della ruota del mouse, la componente Z descrive se la ruota è stata spostata in avanti (1), indietro (-1) o non affatto (0).
Per l'input Enum.KeyCode , questo indica la posizione del GiocatoreMouse .
Nota che un InputObject corrispondente a Enum.UserInputType.MouseButton1 (clic sinistro) e Enum.UserInputType.MouseButton2 (clic destro) fornito da un InputBegan callback non avrà il suo Delta o Position aggiornato una volta creato, tranne quando l'input del mouse termina.Per ottenere posizioni aggiornate per gli input del mouse, devi invece fare riferimento a un InputObject da un InputChanged Richiama, o chiamare GetMouseLocation() .Tuttavia, qualsiasi InputObjects corrispondente agli input di tocco avrà il loro delta e la posizione aggiornati ogni frame durante tutta la loro vita.
Vedi anche
Campioni di codice
L'esempio seguente mostra uno dei molti esempi di utilizzo del trattamento dell'input dell'utente da InputBegan a seconda del suo tipo.
-- Per utilizzare l'evento InputBegan, il servizio UserInputService deve essere utilizzato
local UserInputService = game:GetService("UserInputService")
-- Una funzione di esempio che fornisce diversi casi d'uso per vari tipi di input dell'utente
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
UserInputState descrive lo stato di un input in esecuzione, a seguito di un flusso specifico a seconda del UserInputType.Usa l'enum con lo stesso nome, Enum.UserInputState .Vedi la pagina enum per una lista di tutti i valori possibili per questa Proprietà.
Vedi anche:
Campioni di codice
Questo esempio ottiene un elenco di gamepad di navigazione e un elenco dei loro supportati Enum.KeyCodes.Quindi, esegue un ciclo attraverso l'elenco KeyCode supportato e lega i pulsanti ButtonX e X alle funzioni se sono supportati da un gamepad utilizzando il 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
-- Poiché questa funzione non restituisce nulla, questo handler restituirà
-- "" lavello "l'input e nessun altro gestore di azione verrà chiamato dopo
-- questo.
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
UserInputType è una proprietà che descrive per quale tipo di input questo InputObject rappresenta, come ad esempio Topo, or mouse as computer mouse, tastiera, touch o gamepad.Usa l'enum con lo stesso nome, Enum.UserInputType .Vedi la pagina enum per una lista di tutti i valori possibili per questa Proprietà.
Vedi anche:
Campioni di codice
L'esempio seguente mostra uno dei molti esempi di utilizzo del trattamento dell'input dell'utente da InputBegan a seconda del suo tipo.
-- Per utilizzare l'evento InputBegan, il servizio UserInputService deve essere utilizzato
local UserInputService = game:GetService("UserInputService")
-- Una funzione di esempio che fornisce diversi casi d'uso per vari tipi di input dell'utente
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)