InputObject
*Ce contenu est traduit en utilisant l'IA (Beta) et peut contenir des erreurs. Pour consulter cette page en anglais, clique ici.
Un objet d'entrée représente une seule entrée d'un utilisateur, comme le mouvement de la souris, les touches, les presses de clé et plus encore. Il est créé lorsqu'une entrée commence.
Les propriétés de cet objet varient selon le UserInputType.Chaque type d'entrée subira diverses modifications de son UserInputState .Pendant la durée de vie d'une entrée, d'autres propriétés qui décrivent davantage l'entrée peuvent changer, telles que Position et Delta .Les presses de boutons de clavier et de manette de jeu auront la propriété KeyCode configurer.
Une fois créé au début d'une entrée, le même objet persiste et est mis à jour jusqu'à la fin de l'entrée.Par resultats, vous pouvez suivre les modifications de l'objet en utilisant l'événement Changed lorsque l'utilisateur modifie l'entrée en question.Vous pouvez également placer ces objets dans une liste de pistes d'entrée actives et interagir avec l'objet après sa création par un événement tel que UserInputService.InputBegan .Cela est principalement utile pour les événements tactiles, car chaque point de contact aura un objet d'entrée séparé.
Voir aussi :
- ContextActionService , qui transmet un objet d'entrée à bound fonctions de traitement d'action
- UserInputService , dont les événements et les fonctions utilisent souvent InputObject
- GuiObject , dont les événements liés à l'entrée de l'utilisateur utilisent InputObject
Échantillons de code
L'exemple suivant montre l'un des nombreux exemples d'utilisation de la gestion de l'entrée utilisateur à partir de InputBegan en fonction de son type.
-- Pour utiliser l'événement InputBegan, le service UserInputService doit être utilisé
local UserInputService = game:GetService("UserInputService")
-- Une fonction d'échantillon fournissant plusieurs cas d'utilisation pour différents types d'entrée utilisateur
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)Résumé
Propriétés
Un Vector3 décrivant le delta entre les mouvements de la souris/joystick.
Contient un Enum qui décrit le type d'entrée utilisé.
Définit une valeur positionnelle de cette entrée.
Décrit l'état d'une entrée effectuée, suivant un flux spécifique en fonction du UserInputType.
Décrit le type d'entrée effectuée (souris, clavier, manette de jeu, toucher, etc.).
Méthodes
Propriétés
Delta
A Vector3 décrivant le Delta (changement) entre les mouvements de la souris/joystick.
Cela est utile lorsqu'il est utilisé avec l'entrée position de la souris/joystick de l'utilisateur pour suivre la position et le mouvement de la souris/joystick de l'utilisateur, comme lorsque vous créez des scripts de mouvement ou de caméra personnalisés.Considérez le suivi des modifications d'objets d'entrée en utilisant l'événement Object.Changed ou lorsque l'utilisateur modifie les entrées via des événements tels que UserInputService.InputChanged et GuiObject.InputChanged .
Notez qu'un correspondant à (cliquergauche) et (cliquerdroit) fourni à partir d'un rappel ou mis à jour une fois créé, sauf lorsque l'entrée de la souris se termine.Pour obtenir des délestages mis à jour pour les entrées de souris, vous devez plutôt faire référence à un InputObject à partir d'un rappel InputChanged ou appeler GetMouseDelta() .Cependant, tout InputObjects correspondant aux entrées de toucher aura son delta et sa position mises à jour à chaque cadre tout au long de sa vie.
Voir aussi :
Échantillons de code
Cet exemple crée un script de binocules qui diminue les clics de souris du joueur FieldOfView() et MouseDeltaSensitivity() lorsqu'un joueur avec un MouseEnabled() a quitté les clics de souris.Le script pointe également la position du monde de la souris vers la position du clic de la souris.
Lorsque le joueur quitte à nouveau les clics de souris, la caméra du joueur revient à la valeur par défaut Enum.CameraType avec le même champ de vision et CFrame() comme avant que le joueur n'ait zoomé avec le script.
Pendant que le joueur utilise les binocules, le script verrouille la souris du joueur au centre de l'écran en définissant la souris du joueur sur MouseBehavior() pour verrouiller le centre.La caméra du joueur se déplace lorsque le joueur déplace sa souris selon la propriété indiquant le changement de position de l'écran de la souris.
Pour que cet exemple fonctionne comme prévu, il doit être placé dans 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
-- Réinitialiser la caméra à CFrame et FieldOfView avant le 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()
-- Permettre à la caméra d'être modifiée par le script
camera.CameraType = Enum.CameraType.Scriptable
-- Stocker les propriétés de la caméra avant le zoom
originalProperties._CFrame = camera.CFrame
originalProperties.FieldOfView = camera.FieldOfView
originalProperties.MouseBehavior = UserInputService.MouseBehavior
originalProperties.MouseDeltaSensitivity = UserInputService.MouseDeltaSensitivity
-- Caméra de zoom
target = mouse.Hit.Position
local eyesight = head.Position
camera.CFrame = CFrame.new(eyesight, target)
camera.Focus = CFrame.new(target)
camera.FieldOfView = 10
-- Verrouiller et ralentir la souris
UserInputService.MouseBehavior = Enum.MouseBehavior.LockCenter
UserInputService.MouseDeltaSensitivity = 1
-- Réinitialiser les angles de zoom
AngleX, TargetAngleX = 0, 0
AngleY, TargetAngleY = 0, 0
end
-- Basculer le zoom/dézoomer de la caméra
local function MouseClick()
if zoomed then
-- Dézoomer la caméra
ResetCamera()
else
-- Zoomer dans la caméra
ZoomCamera()
end
zoomed = not zoomed
end
local function MouseMoved(input)
if zoomed then
local sensitivity = 0.6 -- tout ce qui est supérieur rendrait la recherche vers le haut et le bas plus difficile ; recommandez tout entre 0~1
local smoothness = 0.05 -- recommander n'importe quoi 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
Contient un Enum.KeyCode enum qui décrit le type d'entrée utilisé.Pour les types d'entrée comme le clavier, cela décrit quelle touche a été pressée.Pour les entrées comme la souris, cela ne fournit pas d'informations supplémentaires.
Enums
| Nom |
|---|
Voir aussi :
Échantillons de code
Cet exemple obtient une liste de manettes de navigation et une liste de leurs supports Enum.KeyCodes.Ensuite, il itère à travers la liste de code clé soutenue et lie les touches ButtonX et X aux fonctions si elles sont prises en charge par une manette de jeu en utilisant le 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
-- Puisque cette fonction ne renvoie rien, ce gestionnaire va
-- « couler » l'entrée et aucun autre gestionnaire d'action ne sera appelé après
-- celui-ci.
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
Cette propriété décrit une valeur positionnelle Vector3 de cette entrée.
Pour l'entrée souris et tactile, c'est la position de l'écran de la souris/du toucher, décrite dans les composants X et Y.L'insertion appliquée aux éléments GUI (tels que de la barre supérieure) est prise en compte dans la position.
Pour l'entrée de la molette de la souris, la composante Z décrit si la roue a été déplacée vers l'avant (1), vers l'arrière (-1) ou pas du tout (0).
Pour l'entrée Enum.KeyCode, cela indique la position du joueur Mouse.
Notez qu'un correspondant à (cliquergauche) et (cliquerdroit) fourni à partir d'un rappel ou mis à jour une fois créé, sauf lorsque l'entrée de la souris se termine.Pour obtenir des positions mises à jour pour les entrées de souris, vous devez plutôt faire référence à un InputObject à partir d'un rappel InputChanged ou appeler GetMouseLocation() .Cependant, tout InputObjects correspondant aux entrées de toucher aura son delta et sa position mises à jour à chaque cadre tout au long de sa vie.
Voir aussi
Échantillons de code
L'exemple suivant montre l'un des nombreux exemples d'utilisation de la gestion de l'entrée utilisateur à partir de InputBegan en fonction de son type.
-- Pour utiliser l'événement InputBegan, le service UserInputService doit être utilisé
local UserInputService = game:GetService("UserInputService")
-- Une fonction d'échantillon fournissant plusieurs cas d'utilisation pour différents types d'entrée utilisateur
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
État d'entrée de l'utilisateur décrit l'état d'une entrée effectuée, suivant un flux spécifique en fonction du UserInputType.Il utilise l'enum du même nom, Enum.UserInputState .Voir la page enum pour une liste de toutes les valeurs possibles pour cette propriété.
Voir aussi :
Échantillons de code
Cet exemple obtient une liste de manettes de navigation et une liste de leurs supports Enum.KeyCodes.Ensuite, il itère à travers la liste de code clé soutenue et lie les touches ButtonX et X aux fonctions si elles sont prises en charge par une manette de jeu en utilisant le 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
-- Puisque cette fonction ne renvoie rien, ce gestionnaire va
-- « couler » l'entrée et aucun autre gestionnaire d'action ne sera appelé après
-- celui-ci.
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 est une propriété qui décrit le type d'entrée que représente cette InputObject telle que la souris, le clavier, l'entrée tactile ou le gamepad.Il utilise l'enum du même nom, Enum.UserInputType .Voir la page enum pour une liste de toutes les valeurs possibles pour cette propriété.
Voir aussi :
Échantillons de code
L'exemple suivant montre l'un des nombreux exemples d'utilisation de la gestion de l'entrée utilisateur à partir de InputBegan en fonction de son type.
-- Pour utiliser l'événement InputBegan, le service UserInputService doit être utilisé
local UserInputService = game:GetService("UserInputService")
-- Une fonction d'échantillon fournissant plusieurs cas d'utilisation pour différents types d'entrée utilisateur
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)