Mouse
*Este conteúdo é traduzido por IA (Beta) e pode conter erros. Para ver a página em inglês, clique aqui.
Ratón ha sido superado por UserInputService y ContextActionService, que cubren un alcance más amplio, son más ricos en características y soportan mejor los patrones de 0>plataforma cruzada0>. Se mantiene soportado debido a su amplio uso, pero deberías considerar fuertemente usar estas alternativas.
El objeto Ratón alberga varias API para apuntadores, principalmente para botones y intersección rayo-superficie, emisión de rayos. Se puede acceder a través de Player:GetMouse() llamado en el Players.LocalPlayer en un 1> Class.LocalScript1> . También se pasa por el evento 4> Class.Tool.Equipped4> .
- Es más notorio por la propiedad Icon , que cambia la aspecto, lookdel cursor.
- Raycastiza continuamente la posición del mouse de la pantalla en el mundo 3D usando la propiedad TargetFilter, que almacena los resultados del raycast en el Hit, Class.Mouse.Target|Target</
- Plugins puede usar Plugin:GetMouse() para obtener un PluginMouse , que se comporta de manera similar.
Nota:
Este objeto no controla/restringe el movimiento del puntero. Para esto, see UserInputService.MouseBehavior y UserInputService.MouseDeltaSensitivity .
Si dos funciones están conectadas a un mismo evento de entrada, como Button1Down, ambas funciones se ejecutarán cuando se activa el evento. No hay concepto de hundimiento/paso de entrada, ya que los eventos no soportan este comportamiento. Sin embargo, ContextActionService tiene este comportamiento a través de
Si bien no puede haber un mouse disponible en todas las plataformas, Mouse seguirá funcionando en móvil (toque) y consola (controlador para juego), que no tienen normalmente mouse o hardware de puntero. Para comportamientos explícitos de plataforma cruzada, use UserInputService y ContextActionService .
Vea Entrada y cámara para obtener más información sobre la personalización de las entradas en su experiencia.
Resumo
Propriedades
El CFrame de la posición del ratónen el espacio 3D.
El ID de contenido de la imagen usada como el íconode Mouse
Un CFrame colocado en el Workspace.CurrentCamera y orientado hacia la posición 3D del ratón.
El objeto en el espacio 3D al que apunta el mouse está apuntando a.
Determina un objeto (y sus descendientes) para ser ignorado al determinar Mouse.Hit y Mouse.Target .
Indica el Enum.NormalId de la superficie en la que se encuentra el mouse.
Un Ray dirigido hacia la posición mundial del ratón, que se origina desde la posición mundial del Workspace.CurrentCamera .
Describe el ancho de la ventana del juego en píxeles.
Describe la altura de la ventana del juego en píxeles.
Describe la X ( horizontal ) componente de la posición del ratónen la pantalla.
Describe el componente de Y (vertical) de la posición de la pantalla del ratón.
Eventos
Se activa cuando se presiona el botón izquierdo del ratón.
Dispara cuando el botón izquierdo del ratón se libera.
Dispara cuando se presiona el botón derecho del ratón.
Se activa cuando se libera el botón derecho del ratón.
Se activa durante cada latido del corazón que el mouse no se está pasando a otro evento del mouse.
Se activa cuando el mouse se mueve.
Dispara cuando la rueda del mouse se desplaza hacia atrás.
Dispara cuando la rueda del mouse se desplaza hacia adelante.
Propriedades
Hit
Esta propiedad indica CFrame de la posición del ratónen el espacio 3D. Nota que Mouse.TargetFilter y sus descendientes serán ignorados.
Los desarrolladores pueden obtener la posición de Hit como sigue:
El golpe a menudo se usa por Tools para disparar un arma hacia el mouse en tercera persona.
Los desarrolladores que buscan el BasePart el mouse está apuntando a deber usar Mouse.Target .
¿Cómo se calcula Mouse.Hit?
La posición de la cámara de golpe se calcula como el punto de intersección entre el ratón's internal Ray (una extensión de Mouse.UnitRay ) y un objeto en el espacio 3D (como una parte).
La orientación de la Hit CFrame coincide con la dirección de la Mouse.UnitRay .
Nota, el giro de la Workspace.CurrentCamera no se usa al calcular la orientación del Hit CFrame .
El rayo interno del ratónse extiende por 1,000 studs. Si el mouse no apunta a un objeto en el espacio 3D (por ejemplo, al apuntar al cielo), esta propiedad estará 1,000 studs lejos de la Workspace.CurrentCamera .
Amostras de código
local Players = game:GetService("Players")
local RunService = game:GetService("RunService")
local player = Players.LocalPlayer
local mouse = player:GetMouse()
local beam = Instance.new("Beam")
beam.Segments = 1
beam.Width0 = 0.2
beam.Width1 = 0.2
beam.Color = ColorSequence.new(Color3.new(1, 0, 0))
beam.FaceCamera = true
local attachment0 = Instance.new("Attachment")
local attachment1 = Instance.new("Attachment")
beam.Attachment0 = attachment0
beam.Attachment1 = attachment1
beam.Parent = workspace.Terrain
attachment0.Parent = workspace.Terrain
attachment1.Parent = workspace.Terrain
local function onRenderStep()
local character = player.Character
if not character then
beam.Enabled = false
return
end
local head = character:FindFirstChild("Head")
if not head then
beam.Enabled = false
return
end
beam.Enabled = true
local origin = head.Position
local finish = mouse.Hit.Position
attachment0.Position = origin
attachment1.Position = finish
end
RunService.RenderStepped:Connect(onRenderStep)local Players = game:GetService("Players")
local Workspace = game:GetService("Workspace")
local player = Players.LocalPlayer
local camera = Workspace.CurrentCamera
local mouse = player:GetMouse()
local camPos = camera.CFrame.Position
local function onButton1Down()
print("Mouse.Hit:", mouse.Hit.Position)
print("camPos:", camPos)
print("Mouse.Origin:", mouse.Origin.Position)
print("Magnitude:", (mouse.Origin.Position - camPos).Magnitude)
end
mouse.Button1Down:Connect(onButton1Down)
Icon
Icono es una propiedad que determina la imagen utilizada como puntero. Si no hay espacio, se usa una flecha predeterminada. Mientras el cursor se posiciona sobre un GuiButton , esta propiedad se ignora temporalmente.
Para ocultar el cursor por completo, no use una imagen transparente – en cambio, establezca Class.UserInputService.MouseIconEnabled a falso.
Para obtener/ajustar el icono de usuario en las experiencias, deberías usar UserInputService.MouseIcon . Mouse.Icon se desactivará después de que se lance la nueva API para que los plugin establezcan el cursor del mouse.
Diseñando un Cursor
Las siguientes pautas pueden ser útiles al crear sus propios cursores de mouse:
- Las dimensiones de la imagen utilizada determinan el tamaño del cursor.
- El centro de la imagen es donde se emiten los ingresos del mouse.
- La imagen de mouse predeterminada es 64x64 píxeles, con el mouse ocupando 17x24 píxeles de espacio.
System Cursors for PluginMouse
Cuando se usa un PluginMouse recuperado desde Plugin:GetMouse(),
| Mira\* | Activo | Uso recomendado |
|---|
Estas apariencias son aproximaciones; el aspecto real depende de su sistema operativo.
Amostras de código
local Players = game:GetService("Players")
local mouse = Players.LocalPlayer:GetMouse()
mouse.Icon = "http://www.roblox.com/asset?id=163023520"Origin
La propiedad de origen Mouse es una CFrame que indica de dónde se originó el mouse. Está posicionado en el Workspace.CurrentCamera y se orienta hacia la posición 3D del ratón.
Mouse.UnitRay comienza en la misma posición que el origen, y se extiende por un stud en la misma dirección.
Para la posición del Mouse en el espacio 3D, see Mouse.Hit .
Amostras de código
local Players = game:GetService("Players")
local Workspace = game:GetService("Workspace")
local player = Players.LocalPlayer
local camera = Workspace.CurrentCamera
local mouse = player:GetMouse()
local camPos = camera.CFrame.Position
local function onButton1Down()
print("Mouse.Hit:", mouse.Hit.Position)
print("camPos:", camPos)
print("Mouse.Origin:", mouse.Origin.Position)
print("Magnitude:", (mouse.Origin.Position - camPos).Magnitude)
end
mouse.Button1Down:Connect(onButton1Down)
Target
El objeto en el espacio 3D al que apunta el mouse está apuntando a.
Nota:
- Si Mouse.TargetFilter se ha establecer, el filtro de objetivo y sus descendientes se ignorarán.
- Cuando el mouse no esté apuntando a un BasePart, por ejemplo cuando esté apuntando al cielo, Target será nulo.
- Los desarrolladores que buscan la posición del mouse en el espacio 3D deberían usar Mouse.Hit .
Amostras de código
local Players = game:GetService("Players")
local localPlayer = Players.LocalPlayer
local backpack = localPlayer:WaitForChild("Backpack")
local tool = Instance.new("Tool")
tool.RequiresHandle = false
tool.CanBeDropped = false
tool.Parent = backpack
tool.Equipped:Connect(function(mouse)
mouse.Button1Down:Connect(function()
if mouse.Target and mouse.Target.Parent then
mouse.Target.BrickColor = BrickColor.random()
end
end)
end)TargetFilter
Esta propiedad determina un objeto para ser ignorado por el mouse cuando se calcula Mouse.Hit y Mouse.Target . Los descendientes del objeto también se ignoran, por lo que es posible ignorar múltiples objetos siempre que sean descendientes del objeto a cui esta propiedad está establecer. Esta propiedad es
Esta propiedad se puede establecer a cualquier Instance o nulo, por ejemplo:
Nota que el Character del Players.LocalPlayer es ignorado por el mouse automáticamente.
TargetSurface
Esta propiedad indica el Enum.NormalId de la superficie de BasePart a la que apunta el mouse. Esta propiedad se deriva de la posición mundial del mouse ( Mouse.Hit ) y la parte hacia la que apunta el mouse ( 2>Class.Mouse.Target2> ).
Esta propiedad no tiene sentido cuando el mouse no apunta a una parte, por ejemplo cuando el mouse apunta al cielo. En este momento, esta propiedad está configurada como "Derecha" bajo estas condiciones. Antes de usar esta propiedad, asegúrese de que el objetivo del ratónno es nulo.
Amostras de código
local Players = game:GetService("Players")
local player = Players.LocalPlayer
local mouse = player:GetMouse()
local surfaceTypes = {
Enum.SurfaceType.Smooth,
Enum.SurfaceType.Glue,
Enum.SurfaceType.Weld,
Enum.SurfaceType.Studs,
Enum.SurfaceType.Inlet,
Enum.SurfaceType.Universal,
Enum.SurfaceType.Hinge,
Enum.SurfaceType.Motor,
}
local function onMouseClick()
-- make sure the mouse is pointing at a part
local target = mouse.Target
if not target then
return
end
local surfaceType = surfaceTypes[math.random(1, #surfaceTypes)]
local surface = mouse.TargetSurface
local propertyName = surface.Name .. "Surface"
mouse.Target[propertyName] = surfaceType
end
mouse.Button1Down:Connect(onMouseClick)UnitRay
La propiedad UnitRay es una Ray dirigida hacia la posición del ratónen el espacio 3D (descripción de Mouse.Hit). Procede del CFrame del 2>Class.Workspace.CurrentCamera2> . Como todos los rayos de unidad, tiene una distancia de 1.
ViewSizeX
La propiedad ViewSizeX describe el componente horizontal del tamaño de la ventana del juego en píxeles.
Amostras de código
local Players = game:GetService("Players")
-- Note: You should use ContextActionService or UserInputService instead of
-- the Mouse object for accomplishing this task.
local player = Players.LocalPlayer
local mouse = player:GetMouse()
local function onMouseMove()
-- Construct Vector2 objects for the mouse's position and screen size
local position = Vector2.new(mouse.X, mouse.Y)
local size = Vector2.new(mouse.ViewSizeX, mouse.ViewSizeY)
-- A normalized position will map the top left (just under the topbar)
-- to (0, 0) the bottom right to (1, 1), and the center to (0.5, 0.5).
-- This is calculated by dividing the position by the total size.
local normalizedPosition = position / size
print(normalizedPosition)
end
mouse.Move:Connect(onMouseMove)ViewSizeY
La propiedad ViewSizeY describe el componente vertical del tamaño de la ventana del juego en píxeles. Esta longitud incluye el espacio usado por la barra superior.
Amostras de código
local Players = game:GetService("Players")
-- Note: You should use ContextActionService or UserInputService instead of
-- the Mouse object for accomplishing this task.
local player = Players.LocalPlayer
local mouse = player:GetMouse()
local function onMouseMove()
-- Construct Vector2 objects for the mouse's position and screen size
local position = Vector2.new(mouse.X, mouse.Y)
local size = Vector2.new(mouse.ViewSizeX, mouse.ViewSizeY)
-- A normalized position will map the top left (just under the topbar)
-- to (0, 0) the bottom right to (1, 1), and the center to (0.5, 0.5).
-- This is calculated by dividing the position by the total size.
local normalizedPosition = position / size
print(normalizedPosition)
end
mouse.Move:Connect(onMouseMove)Cuando se detectan cambios en la posición de la ratónen la pantalla, se recomienda que uses ContextActionService:BindAction() con Enum.UserInputType.MouseMovement o Class.UserInputService.InputChanged</
La propiedad X describe el componente horizontal de la posición del ratónen la pantalla. La posición se mide en píxeles relativo a la esquina superior izquierda, debajo de la barra superior. Esta propiedad se puede utilizar en conjunción con Mouse.Y para producir un Vector2 representando la posición del ratón:
Esta propiedad no dispara Changed o el señal que se devuelve de GetPropertyChangedSignal . Usa el evento Mouse.Move en su lugar.
Amostras de código
local Players = game:GetService("Players")
-- Note: You should use ContextActionService or UserInputService instead of
-- the Mouse object for accomplishing this task.
local player = Players.LocalPlayer
local mouse = player:GetMouse()
local function onMouseMove()
-- Construct Vector2 objects for the mouse's position and screen size
local position = Vector2.new(mouse.X, mouse.Y)
local size = Vector2.new(mouse.ViewSizeX, mouse.ViewSizeY)
-- A normalized position will map the top left (just under the topbar)
-- to (0, 0) the bottom right to (1, 1), and the center to (0.5, 0.5).
-- This is calculated by dividing the position by the total size.
local normalizedPosition = position / size
print(normalizedPosition)
end
mouse.Move:Connect(onMouseMove)Cuando se detectan cambios en la posición de la ratónen la pantalla, se recomienda que uses ContextActionService:BindAction() con Enum.UserInputType.MouseMovement o Class.UserInputService.InputChanged</
La propiedad Y describe el componente vertical de la posición del ratónen la pantalla. La posición se mide en píxeles relativa al esquina superior izquierda, debajo de la barra superior. Esta propiedad se puede utilizar en conjunción con Mouse.X para producir un Vector2 representando la posición del ratón:
Esta propiedad no dispara Changed o el señal que se devuelve de GetPropertyChangedSignal . Usa el evento Mouse.Move en su lugar.
Amostras de código
local Players = game:GetService("Players")
-- Note: You should use ContextActionService or UserInputService instead of
-- the Mouse object for accomplishing this task.
local player = Players.LocalPlayer
local mouse = player:GetMouse()
local function onMouseMove()
-- Construct Vector2 objects for the mouse's position and screen size
local position = Vector2.new(mouse.X, mouse.Y)
local size = Vector2.new(mouse.ViewSizeX, mouse.ViewSizeY)
-- A normalized position will map the top left (just under the topbar)
-- to (0, 0) the bottom right to (1, 1), and the center to (0.5, 0.5).
-- This is calculated by dividing the position by the total size.
local normalizedPosition = position / size
print(normalizedPosition)
end
mouse.Move:Connect(onMouseMove)Métodos
Eventos
Button1Down
El Botón1Down incluso se activa cuando el jugador presiona su botón izquierdo del ratón.
Esto también se puede acceder desde un Tool. Por ejemplo, cuando se coloca en un LocalScript, el código de abajo imprime Button1Down cada vez que se presiona el botón izquierdo del ratón:
local Tool = script.Parent --asegúrese de que se trate de un objeto de herramienta
Tool.Equipped:Connect(function(Mouse)
Mouse.Button1Down:Connect(function()
print("Button1Down")
end)
end)
Los desarrolladores pueden encontrar la posición del mouse en el espacio del mundo, y si está apuntando a cualquier BasePart , utilizando las propiedades de Mouse.Hit y Mouse.Target.
Para obtener información sobre cómo obtener el objeto del mouse, consulte la página Mouse.
Nota, se recomienda a los desarrolladores usar UserInputService en lugar del objeto Mouse en el nuevo trabajo.
Amostras de código
local Players = game:GetService("Players")
local localPlayer = Players.LocalPlayer
local backpack = localPlayer:WaitForChild("Backpack")
local tool = Instance.new("Tool")
tool.RequiresHandle = false
tool.CanBeDropped = false
tool.Parent = backpack
tool.Equipped:Connect(function(mouse)
mouse.Button1Down:Connect(function()
if mouse.Target and mouse.Target.Parent then
mouse.Target.BrickColor = BrickColor.random()
end
end)
end)Button1Up
Dispara cuando el botón izquierdo del ratón se libera.
Para obtener la información sobre cómo obtener el objeto Mouse, consulte la página Mouse.
Los desarrolladores pueden encontrar la posición del mouse en el espacio del mundo, y si está apuntando a cualquier BasePart usando las propiedades Mouse.Hit y Mouse.Target.
Nota, se recomienda a los desarrolladores usar UserInputService en lugar del objeto Mouse en el nuevo trabajo.
Amostras de código
local Players = game:GetService("Players")
local player = Players.LocalPlayer
local mouse = player:GetMouse()
local target = nil
local function button1Down()
target = mouse.Target
end
local function button1Up()
if target == mouse.Target then
target.BrickColor = BrickColor.random()
end
end
mouse.Button1Down:Connect(button1Down)
mouse.Button1Up:Connect(button1Up)Button2Down
El Botón2Down incluso se activa cuando el jugador presiona su botón derecho del ratón.
Esto también se puede acceder a partir de un Tool. Por ejemplo, cuando se coloca en un LocalScript, el código de abajo imprime Button2Down cada vez que se presiona el botón derecho del ratón:
local Tool = script.Parent --asegúrese de que se trate de un objeto de herramienta
Tool.Equipped:Connect(function(Mouse)
Mouse.Button2Down:Connect(function()
print("Button2Down")
end)
end).
Los desarrolladores pueden encontrar la posición del mouse en el espacio del mundo, y si está apuntando a cualquier BasePart , utilizando las propiedades de Mouse.Hit y Mouse.Target.
Para obtener información sobre cómo obtener el objeto del mouse, consulte la página Mouse.
Nota, se recomienda a los desarrolladores usar UserInputService en lugar del objeto Mouse en el nuevo trabajo.
Amostras de código
local Players = game:GetService("Players")
local localPlayer = Players.LocalPlayer
local backpack = localPlayer:WaitForChild("Backpack")
local tool = Instance.new("Tool")
tool.RequiresHandle = false
tool.CanBeDropped = false
tool.Parent = backpack
tool.Equipped:Connect(function(mouse)
mouse.Button2Down:Connect(function()
if mouse.Target and mouse.Target.Parent then
mouse.Target.BrickColor = BrickColor.random()
end
end)
end)Button2Up
Se activa cuando se libera el botón derecho del ratón.
mouse.Button2Up:Connect(function()
print("button 2 up!")
end
Para obtener la información sobre cómo obtener el objeto Mouse, consulte la página Mouse.
Los desarrolladores pueden encontrar la posición del mouse en el espacio del mundo, y si está apuntando a cualquier BasePart usando las propiedades Mouse.Hit y Mouse.Target.
Nota, se recomienda a los desarrolladores usar UserInputService en lugar del objeto Mouse en el nuevo trabajo.
Amostras de código
local Players = game:GetService("Players")
local mouse = Players.LocalPlayer:GetMouse()
local target = nil
mouse.Button2Down:Connect(function()
target = mouse.Target
end)
mouse.Button2Up:Connect(function()
if target == mouse.Target then
target.BrickColor = BrickColor.random()
end
end)Idle
Se activa durante cada latido del corazón que el mouse no se está pasando a otro evento del mouse.
Nota, este evento no debe utilizarse para determinar cuando el mouse aún está. Como se activa cada latido del corazón, se activará entre los eventos Mouse.Move .
Para obtener la información sobre cómo obtener el objeto Mouse, consulte la página Mouse.
Los desarrolladores pueden encontrar la posición del mouse en el espacio del mundo, y si está apuntando a cualquier BasePart usando las propiedades Mouse.Hit y Mouse.Target.
Nota, se recomienda a los desarrolladores usar UserInputService en lugar del objeto Mouse en el nuevo trabajo.
Amostras de código
local Players = game:GetService("Players")
local RunService = game:GetService("RunService")
local player = Players.LocalPlayer
local mouse = player:GetMouse()
local events = {
"Button1Down",
"Button1Up",
"Button2Down",
"Button2Up",
"Idle",
"Move",
"WheelBackward",
"WheelForward",
"KeyDown",
"KeyUp",
}
local currentEvent
local frame = 0
local function processInput()
frame = frame + 1
print("Frame", frame, "- mouse event was passed to", currentEvent)
end
for _, event in pairs(events) do
mouse[event]:Connect(function()
currentEvent = event
end)
end
RunService:BindToRenderStep("ProcessInput", Enum.RenderPriority.Input.Value, processInput)Move
Se activa cuando el mouse se mueve.
Nota, este evento se activa cuando se actualiza la posición del ratón, por lo tanto, se activará repetidamente mientras se mueve.
Para obtener la información sobre cómo obtener el objeto Mouse, consulte la página Mouse.
Los desarrolladores pueden encontrar la posición del mouse en el espacio del mundo, y si está apuntando a cualquier BasePart usando las propiedades Mouse.Hit y Mouse.Target.
mouse.Move:Connect(function()
local position = mouse.Hit.p
local target = mouse.Target
print(target, position)
end)
Nota, se recomienda a los desarrolladores usar UserInputService en lugar del objeto Mouse en el nuevo trabajo.
Amostras de código
local Players = game:GetService("Players")
local player = Players.LocalPlayer
local mouse = player:GetMouse()
local point
local down
local function selectPart()
if mouse.Target and not mouse.Target.Locked then
point = mouse.Target
mouse.TargetFilter = point
down = true
end
end
local function movePart()
if down and point then
local posX, posY, posZ = mouse.Hit.X, mouse.Hit.Y, mouse.Hit.Z
point.Position = Vector3.new(posX, posY, posZ)
end
end
local function deselectPart()
down = false
point = nil
mouse.TargetFilter = nil
end
mouse.Button1Down:Connect(selectPart)
mouse.Button1Up:Connect(deselectPart)
mouse.Move:Connect(movePart)WheelBackward
El evento WheelBackward se activa cuando la rueda del mouse se desplaza hacia atrás. Las posibles usos para este evento incluyen alternar el enfoque de un rifle de asalto en primera persona (FPS) o acercar la cámara del jugador.
Esto se puede utilizar junto con el evento de desplazamiento hacia adelante, Mouse.WheelForward .
Para obtener la información sobre cómo obtener el objeto Mouse, consulte la página Mouse.
Nota, se recomienda a los desarrolladores usar UserInputService en lugar del objeto Mouse en el nuevo trabajo.
Amostras de código
local Players = game:GetService("Players")
local player = Players.LocalPlayer
local mouse = player:GetMouse()
local function onWheelBackward()
print("Wheel went backwards!")
end
mouse.WheelBackward:Connect(onWheelBackward)WheelForward
El evento WheelForward se activa cuando la rueda del mouse se desplaza hacia adelante. Las posibles usos para este evento incluyen alternar el enfoque de un rifle de asalto en un tirador de primera persona (FPS) o acercar la cámara del jugador.
Esto se puede utilizar junto con el evento de desplazamiento hacia atrás, Mouse.WheelBackward .
Para obtener la información sobre cómo obtener el objeto Mouse, consulte la página Mouse.
Nota, se recomienda a los desarrolladores usar UserInputService en lugar del objeto Mouse en el nuevo trabajo.
Amostras de código
local Players = game:GetService("Players")
local player = Players.LocalPlayer
local mouse = player:GetMouse()
local function onWheelBackward()
print("Wheel went forward!")
end
mouse.WheelForward:Connect(onWheelBackward)