Close
    Search Search

    UserInputService

    A UserInputService classe, adicionada na versão 0.80, herda de Instância. Não pode ser instanciado.



    Conteúdo

    • 1 Propriedades
      • 1.1 bool AccelerometerEnabled [ReadOnly] [NotReplicated]
      • 1.2 Vector 2 BottomBarSize [Hidden] [ReadOnly] [NotReplicated]
      • 1.3 bool GamepadEnabled [ReadOnly] [NotReplicated]
      • 1.4 bool GazeSelectionEnabled [Hidden] [NotReplicated]
      • 1.5 bool GyroscopeEnabled [ReadOnly] [NotReplicated]
      • 1.6 bool KeyboardEnabled [ReadOnly] [NotReplicated]
      • 1.7 bool LegacyInputEventsEnabled [Escondido]
      • 1.8 bool ModalEnabled
      • 1.9 MouseBehavior MouseBehavior
      • 1.10 flutuação MouseDeltaSensitivity [NotReplicated]
      • 1.11 bool MouseEnabled [ReadOnly] [NotReplicated]
      • 1.12 bool MouseIconEnabled
      • 1.13 Vector 2 NavBarSize [Hidden] [ReadOnly] [NotReplicated]
      • 1.14 duplo OnScreenKeyboardAnimationDuration [Hidden] [ReadOnly] [NotReplicated]
      • 1.15 Vector 2 OnScreenKeyboardPosition [ReadOnly] [NotReplicated]
      • 1.16 Vector 2 OnScreenKeyboardSize [ReadOnly] [NotReplicated]
      • 1.17 bool OnScreenKeyboardVisible [ReadOnly] [NotReplicated]
      • 1.18 OverrideMouseIconBehavior OverrideMouseIconBehavior [Escondido]
      • 1.19 Vector 2 RightBarSize [Hidden] [ReadOnly] [NotReplicated]
      • 1.20 Vector 2 StatusBarSize [Hidden] [ReadOnly] [NotReplicated]
      • 1.21 bool TouchEnabled [ReadOnly] [NotReplicated]
      • 1.22 CFrame UserHeadCFrame [ReadOnly] [NotReplicated] [Obsoleto]
      • 1.23 bool VREnabled [ReadOnly] [NotReplicated]
    • Funções 2
      • 2.1 bool GamepadSupports(UserInputType gamepadNum, KeyCode gamepadKeyCode)
      • 2.2 Array GetConnectedGamepads()
      • 2.3 InputObject GetDeviceAcceleration()
      • 2.4 InputObject GetDeviceGravity()
      • 2.5 Tupla GetDeviceRotation()
      • 2.6 DeviceType GetDeviceType()
      • 2.7 TextBox GetFocusedTextBox()
      • 2.8 bool GetGamepadConnected(UserInputType gamepadNum)
      • 2.9 Array GetGamepadState(UserInputType gamepadNum)
      • 2.10 Array GetKeysPressed()
      • 2.11 UserInputType GetLastInputType()
      • 2.12 Array GetMouseButtonsPressed()
      • 2.13 Vector 2 GetMouseDelta()
      • 2.14 Vector 2 GetMouseLocation()
      • 2.15 Array GetNavigationGamepads()
      • 2.16 Plataforma GetPlatform()
      • 2.17 string GetStringForKeyCode(KeyCode keyCode)
      • 2.18 Array GetSupportedGamepadKeyCodes(UserInputType gamepadNum)
      • 2.19 CFrame GetUserCFrame(Tipo UserCFrame)
      • 2.20 bool IsGamepadButtonDown(UserInputType gamepadNum, KeyCode gamepadKeyCode)
      • 2.21 bool IsKeyDown(KeyCode keyCode)
      • 2.22 bool IsMouseButtonPressed(UserInputType mouseButton)
      • 2.23 bool IsNavigationGamepad(UserInputType gamepadEnum)
      • 2.24 vazio RecenterUserHeadCFrame()
      • 2.25 vazio SendAppUISizes(Vector2 statusBarSize, Vector2 navBarSize, Vector2 bottomBarSize, Vector2 rightBarSize)
      • 2.26 vazio SetNavigationGamepad(UserInputType gamepadEnum, bool habilitado)
    • 3 Eventos
      • 3.1  DeviceAccelerationChanged(Aceleração InputObject)
      • 3.2  DeviceGravityChanged(Gravidade do objeto de entrada)
      • 3.3  DeviceRotationChanged(Rotação InputObject, CFrame cframe)
      • 3.4  GamepadConnected(UserInputType gamepadNum)
      • 3.5  GamepadDisconnected(UserInputType gamepadNum)
      • 3.6  InputBegan(Entrada InputObject, bool gameProcessedEvent)
      • 3.7  InputChanged(Entrada InputObject, bool gameProcessedEvent)
      • 3.8  InputEnded(Entrada InputObject, bool gameProcessedEvent)
      • 3.9  JumpRequest()
      • 3.10  LastInputTypeChanged(UserInputType lastInputType)
      • 3.11  PointerAction(roda de flutuação, pan Vector2, pinça de flutuação, bool gameProcessedEvent)
      • 3.12  StatusBarTapped(Posição Vector2)
      • 3.13  TextBoxFocusReleased(TextBox textboxReleased)
      • 3.14  TextBoxFocused(TextBox textboxFocused)
      • 3.15  TouchEnded(InputObject touch, bool gameProcessedEvent)
      • 3.16  TouchLongPress(Array touchPositions, estado UserInputState, bool gameProcessedEvent)
      • 3.17  TouchMoved(InputObject touch, bool gameProcessedEvent)
      • 3.18  TouchPan(Array touchPositions, Vector2 totalTranslation, Vector2 velocidade, estado UserInputState, bool gameProcessedEvent)
      • 3.19  TouchPinch(Array touchPositions, escala flutuante, velocidade flutuante, estado UserInputState, bool gameProcessedEvent)
      • 3.20  TouchRotate(Array touchPositions, rotação de flutuação, velocidade de flutuação, estado UserInputState, bool gameProcessedEvent)
      • 3.21  TouchStarted(InputObject touch, bool gameProcessedEvent)
      • 3.22  TouchSwipe(SwipeDirection swipeDirection, int numberOfTouches, bool gameProcessedEvent)
      • 3.23  TouchTap(Array touchPositions, bool gameProcessedEvent)
      • 3.24  TouchTapInWorld(Posição Vector2, bool processingByUI)
      • 3.25  UserCFrameChanged(Tipo UserCFrame, valor CFrame)
      • 3.26  WindowFocusReleased()
      • 3.27  WindowFocused()
    • 4 links externos

    Propriedades

    UserInputService bool AccelerometerEnabled [ReadOnly] [NotReplicated]

    Retorna verdadeiro se o dispositivo local tiver um acelerômetro, falso caso contrário.



    • Categoria: Dados.
    • Serialização: pode apenas salvar.

    UserInputService Vector2 BottomBarSize [Hidden] [ReadOnly] [NotReplicated]

    • Categoria: Dados.
    • Segurança de leitura: RobloxScriptSecurity.
    • Segurança de gravação: RobloxScriptSecurity.
    • Serialização: não é possível carregar ou salvar.

    UserInputService bool GamepadEnabled [ReadOnly] [NotReplicated]

    • Categoria: Dados.
    • Serialização: pode apenas salvar.

    UserInputService bool GazeSelectionEnabled [Hidden] [NotReplicated]

    • Categoria: Dados.
    • Segurança de leitura: RobloxScriptSecurity.
    • Segurança de gravação: RobloxScriptSecurity.
    • Serialização: não é possível carregar ou salvar.

    UserInputService bool GyroscopeEnabled [ReadOnly] [NotReplicated]

    Retorna verdadeiro se o dispositivo local tiver um giroscópio, falso caso contrário.

    • Categoria: Dados.
    • Serialização: pode apenas salvar.

    UserInputService bool KeyboardEnabled [ReadOnly] [NotReplicated]

    Retorna verdadeiro se o dispositivo local aceita entrada do teclado, falso caso contrário.

    • Categoria: Dados.
    • Serialização: pode apenas salvar.

    UserInputService bool LegacyInputEventsEnabled [Escondido]

    • Categoria: Comportamento.
    • Segurança de leitura: RobloxScriptSecurity.
    • Segurança de gravação: RobloxScriptSecurity.
    • Serialização: pode salvar e carregar.

    UserInputService bool ModalEnabled

    Se definido como verdadeiro, os controles móveis ficarão visíveis no dispositivo de um player móvel. Caso contrário, falso.



    • Categoria: Comportamento.
    • Serialização: não é possível carregar ou salvar.

    UserInputService MouseBehavior MouseBehavior

    • Categoria: Dados.
    • Serialização: pode salvar e carregar.

    UserInputService flutuar MouseDeltaSensitivity [NotReplicated]

    • Categoria: Dados.
    • Serialização: pode carregar apenas.

    UserInputService bool MouseEnabled [ReadOnly] [NotReplicated]

    Retorna verdadeiro se o dispositivo local aceita entrada do mouse, caso contrário retorna falso.

    • Categoria: Dados.
    • Serialização: pode apenas salvar.

    UserInputService bool MouseIconEnabled

    Se definido como verdadeiro, o ícone do mouse ficará visível. Caso contrário, falso.

    • Categoria: Dados.
    • Serialização: pode salvar e carregar.

    UserInputService Vector2 NavBarSize [Hidden] [ReadOnly] [NotReplicated]

    • Categoria: Dados.
    • Segurança de leitura: RobloxScriptSecurity.
    • Segurança de gravação: RobloxScriptSecurity.
    • Serialização: não é possível carregar ou salvar.

    UserInputService duplo OnScreenKeyboardAnimationDuration [Hidden] [ReadOnly] [NotReplicated]

    • Categoria: Dados.
    • Segurança de leitura: RobloxScriptSecurity.
    • Segurança de gravação: RobloxScriptSecurity.
    • Serialização: não é possível carregar ou salvar.

    UserInputService Vector2 OnScreenKeyboardPosition [ReadOnly] [NotReplicated]

    • Categoria: Dados.
    • Serialização: não é possível carregar ou salvar.

    UserInputService Vector2 OnScreenKeyboardSize [ReadOnly] [NotReplicated]

    • Categoria: Dados.
    • Serialização: não é possível carregar ou salvar.

    UserInputService bool OnScreenKeyboardVisible [ReadOnly] [NotReplicated]

    • Categoria: Dados.
    • Serialização: não é possível carregar ou salvar.

    UserInputService OverrideMouseIconBehavior OverrideMouseIconBehavior [Escondido]

    • Categoria: Dados.
    • Segurança de leitura: RobloxScriptSecurity.
    • Segurança de gravação: RobloxScriptSecurity.
    • Serialização: não é possível carregar ou salvar.

    UserInputService Vector2 RightBarSize [Hidden] [ReadOnly] [NotReplicated]

    • Categoria: Dados.
    • Segurança de leitura: RobloxScriptSecurity.
    • Segurança de gravação: RobloxScriptSecurity.
    • Serialização: não é possível carregar ou salvar.

    UserInputService Vector2 StatusBarSize [Hidden] [ReadOnly] [NotReplicated]

    • Categoria: Dados.
    • Segurança de leitura: RobloxScriptSecurity.
    • Segurança de gravação: RobloxScriptSecurity.
    • Serialização: não é possível carregar ou salvar.

    UserInputService bool TouchEnabled [ReadOnly] [NotReplicated]

    Retorna verdadeiro se o dispositivo local aceitar entrada por toque, falso caso contrário.



    • Categoria: Dados.
    • Serialização: pode apenas salvar.

    UserInputService CFrame UserHeadCFrame [ReadOnly] [NotReplicated] [Obsoleto]

    • Categoria: Dados.
    • Serialização: não é possível carregar ou salvar.

    UserInputService bool VREnabled [ReadOnly] [NotReplicated]

    Se os fones de ouvido de realidade virtual estão ou não ligados.

    • Categoria: Dados.
    • Serialização: pode apenas salvar.

    Funções

    UserInputService bool GamepadSupports(UserInputType gamepadNum, KeyCode gamepadKeyCode)

    UserInputService Ordem GetConnectedGamepads()

    UserInputService InputObject GetDeviceAcceleration()

    Retorna um InputObject que descreve a aceleração atual do dispositivo. Isso é disparado com um InputObject, que tem o tipo Enum.InputType.Accelerometer, e a posição que mostra a força g em cada eixo do dispositivo local. A propriedade delta descreve a quantidade de rotação que aconteceu pela última vez. Este evento só dispara localmente.

    UserInputService InputObject GetDeviceGravity()

    Retorna um InputObject que descreve o vetor de gravidade atual do dispositivo. Isso é disparado com um InputObject, que tem o tipo Enum.InputType.Accelerometer, e a posição que mostra a força g em cada eixo do dispositivo local. A propriedade delta descreve a quantidade de rotação que aconteceu pela última vez. Este evento só dispara localmente.

    UserInputService Tupla GetDeviceRotation()

    Retorna um InputObject e um Vector4 que descreve o vetor de rotação atual do dispositivo. Isso é disparado com um InputObject, que tem o tipo Enum.InputType.Gyroscope, e uma posição que mostra a rotação total em cada eixo do dispositivo local. A propriedade delta descreve a quantidade de rotação que aconteceu pela última vez. O Vector4 é a rotação de quatérnio atual do dispositivo em referência ao seu quadro de referência padrão. Este evento só dispara localmente.

    UserInputService Tipo de dispositivo GetDeviceType()

    • Segurança: RobloxScriptSecurity.

    UserInputService Caixa de texto GetFocusedTextBox()

    Retorna a caixa de texto em que o Player local está focado no momento.

    UserInputService bool GetGamepadConnected(UserInputType gamepadNum)

    UserInputService Ordem GetGamepadState(UserInputType gamepadNum)

    UserInputService Ordem GetKeysPressed()

    UserInputService UserInputType GetLastInputType()

    UserInputService Ordem GetMouseButtonsPressed()

    UserInputService Vector2 GetMouseDelta()

    UserInputService Vector2 GetMouseLocation()

    UserInputService Ordem GetNavigationGamepads()

    UserInputService Plataforma GetPlatform()

    • Segurança: RobloxScriptSecurity.

    UserInputService corda GetStringForKeyCode(KeyCode keyCode)

    UserInputService Ordem GetSupportedGamepadKeyCodes(UserInputType gamepadNum)

    UserInputService CFrame GetUserCFrame(Tipo UserCFrame)

    UserInputService bool IsGamepadButtonDown(UserInputType gamepadNum, KeyCode gamepadKeyCode)

    UserInputService bool IsKeyDown(KeyCode keyCode)

    Retorna verdadeiro se o KeyCode fornecido estiver sendo pressionado no teclado do jogador. Caso contrário, falso.

    UserInputService bool IsMouseButtonPressed(UserInputType mouseButton)

    UserInputService bool IsNavigationGamepad(UserInputType gamepadEnum)

    UserInputService anular RecenterUserHeadCFrame()

    UserInputService anular SendAppUISizes(Vector2 statusBarSize, Vector2 navBarSize, Vector2 bottomBarSize, Vector2 rightBarSize)

    • Segurança: RobloxScriptSecurity.

    UserInputService anular SetNavigationGamepad(UserInputType gamepadEnum, bool habilitado)

    Eventos

    UserInputService DeviceAccelerationChanged(Aceleração InputObject)

    Disparado quando um usuário move um dispositivo que possui um acelerômetro. Isso é disparado com um InputObject, que tem o tipo Enum.InputType.Accelerometer, e a posição que mostra a força g em cada eixo do dispositivo local. Este evento só dispara localmente.

    UserInputService DeviceGravityChanged(Gravidade do objeto de entrada)

    Disparado quando a força da gravidade muda em um dispositivo que possui um acelerômetro. Isso é disparado com um InputObject, que tem o tipo Enum.InputType.Accelerometer, e a posição que mostra a força g em cada eixo do dispositivo local. Este evento só dispara localmente.

    UserInputService DeviceRotationChanged(Rotação InputObject, CFrame cframe)

    Disparado quando um usuário gira um dispositivo que tem um giroscópio. Isso é disparado com um InputObject, que tem o tipo Enum.InputType.Gyroscope, e uma posição que mostra a rotação total em cada eixo do dispositivo local. A propriedade delta descreve a quantidade de rotação que aconteceu pela última vez. Um segundo argumento do Vector4 é a rotação do quatérnio atual do dispositivo em referência ao seu quadro de referência padrão. Este evento só dispara localmente.

    UserInputService GamepadConnected(UserInputType gamepadNum)

    UserInputService GamepadDisconnected(UserInputType gamepadNum)

    UserInputService InputBegan(Entrada InputObject, bool gameProcessedEvent)

    Disparado quando um usuário começa a interagir por meio de um dispositivo de interface homem-computador (botão do mouse pressionado, início do toque, botão do teclado pressionado etc.). 'inputObject' é um UserInputServiceInputObject, que contém dados úteis para consultar a entrada do usuário. Este evento só dispara localmente. Este evento sempre será disparado independentemente do estado do jogo.

    UserInputService InputChanged(Entrada InputObject, bool gameProcessedEvent)

    Disparado quando um usuário muda ao interagir por meio de um dispositivo de interface homem-computador (movimento do mouse, movimento de toque, roda do mouse, etc.). 'inputObject' é um InputObject, que contém dados úteis para consultar a entrada do usuário. Este evento só dispara localmente. Este evento sempre será disparado independentemente do estado do jogo.

    UserInputService InputEnded(Entrada InputObject, bool gameProcessedEvent)

    Disparado quando um usuário para de interagir por meio de um dispositivo de Interface Homem-Computador (botão do mouse para cima, touch end, botão do teclado para cima, etc.). 'inputObject' é um InputObject, que contém dados úteis para consultar a entrada do usuário. Este evento só dispara localmente. Este evento sempre será disparado independentemente do estado do jogo.

    UserInputService JumpRequest()

    Dispara quando o jogador local pede para saltar.

    UserInputService LastInputTypeChanged(UserInputType lastInputType)

    UserInputService PointerAction(roda de flutuação, pan Vector2, pinça de flutuação, bool gameProcessedEvent)

    UserInputService StatusBarTapped(Posição Vector2)

    • Segurança: RobloxScriptSecurity.

    UserInputService TextBoxFocusReleased(TextBox textboxReleased)

    Disparado quando um usuário interrompe a entrada de texto em uma caixa de texto (geralmente pressionando Enter ou clicando / tocando em qualquer outro lugar da tela). O argumento é a caixa de texto que foi tirada do foco. Este evento só dispara localmente.

    UserInputService TextBoxFocused(TextBox textboxFocused)

    Disparado quando um usuário clica / toca em uma caixa de texto para iniciar a entrada de texto. O argumento é a caixa de texto que foi colocada em foco. Isso também é acionado se uma caixa de texto forçar o foco no usuário. Este evento só dispara localmente.

    UserInputService TouchEnded(InputObject touch, bool gameProcessedEvent)

    Disparado quando um usuário move o dedo em um dispositivo TouchEnabled. 'touch' é um InputObject, que contém dados úteis para consultar a entrada do usuário. Este evento só dispara localmente. Este evento sempre será disparado independentemente do estado do jogo.

    UserInputService TouchLongPress(Array touchPositions, estado UserInputState, bool gameProcessedEvent)

    Disparado quando um usuário mantém pelo menos um dedo por um curto período de tempo na mesma posição da tela em um dispositivo TouchEnabled. 'touchPositions' é um array Lua de Vector2, cada um indicando a posição de todos os dedos envolvidos no gesto. 'state' indica o Enum.UserInputState do gesto. Este evento só dispara localmente. Este evento sempre será disparado independentemente do estado do jogo.

    UserInputService TouchMoved(InputObject touch, bool gameProcessedEvent)

    Disparado quando um usuário move o dedo em um dispositivo TouchEnabled. 'touch' é um InputObject, que contém dados úteis para consultar a entrada do usuário. Este evento só dispara localmente. Este evento sempre será disparado independentemente do estado do jogo.

    UserInputService TouchPan(Array touchPositions, Vector2 totalTranslation, Vector2 velocidade, estado UserInputState, bool gameProcessedEvent)

    Disparado quando um usuário arrasta pelo menos um dedo em um dispositivo TouchEnabled. 'touchPositions' é um array Lua de Vector2, cada um indicando a posição de todos os dedos envolvidos no gesto. 'totalTranslation' é um Vector2, indicando o quão longe o gesto de panorâmica foi desde seu ponto inicial. 'velocidade' é um Vector2 que indica a rapidez com que o gesto está sendo realizado em cada dimensão. 'state' indica o Enum.UserInputState do gesto. Este evento só dispara localmente. Este evento sempre será disparado independentemente do estado do jogo.

    UserInputService TouchPinch(Array touchPositions, escala flutuante, velocidade flutuante, estado UserInputState, bool gameProcessedEvent)

    Disparado quando um usuário aperta os dedos em um dispositivo TouchEnabled. 'touchPositions' é um array Lua de Vector2, cada um indicando a posição de todos os dedos envolvidos no gesto de pinça. 'escala' é um flutuador que indica a diferença desde o início do gesto de pinça. 'velocidade' é um flutuador que indica a rapidez com que o gesto de pinça está acontecendo. 'state' indica o Enum.UserInputState do gesto. Este evento só dispara localmente. Este evento sempre será disparado independentemente do estado do jogo.

    UserInputService TouchRotate(Array touchPositions, rotação de flutuação, velocidade de flutuação, estado UserInputState, bool gameProcessedEvent)

    Disparado quando um usuário gira dois dedos em um dispositivo TouchEnabled. 'touchPositions' é um array Lua de Vector2, cada um indicando a posição de todos os dedos envolvidos no gesto. 'rotação' é um flutuador que indica o quanto a rotação passou desde o início do gesto. 'velocidade' é um flutuador que indica a rapidez com que o gesto está sendo executado. 'state' indica o Enum.UserInputState do gesto. Este evento só dispara localmente. Este evento sempre será disparado independentemente do estado do jogo.

    UserInputService TouchStarted(InputObject touch, bool gameProcessedEvent)

    Disparado quando um usuário coloca o dedo em um dispositivo TouchEnabled. 'touch' é um InputObject, que contém dados úteis para consultar a entrada do usuário. Este evento só dispara localmente. Este evento sempre será disparado independentemente do estado do jogo.

    UserInputService TouchSwipe(SwipeDirection swipeDirection, int numberOfTouches, bool gameProcessedEvent)

    Disparado quando um usuário passa os dedos em um dispositivo TouchEnabled. 'swipeDirection' é um Enum.SwipeDirection, indicando a direção em que o usuário deslizou. 'numberOfTouches' é um int que indica quantos toques foram envolvidos com o gesto. Este evento só dispara localmente. Este evento sempre será disparado independentemente do estado do jogo.

    UserInputService TouchTap(Array touchPositions, bool gameProcessedEvent)

    Disparado quando um usuário toca o dedo em um dispositivo TouchEnabled. 'touchPositions' é um array Lua de Vector2, cada um indicando a posição de todos os dedos envolvidos no gesto de toque. Este evento só dispara localmente. Este evento sempre será disparado independentemente do estado do jogo.

    UserInputService TouchTapInWorld(Posição Vector2, bool processingByUI)

    UserInputService UserCFrameChanged(Tipo UserCFrame, valor CFrame)

    UserInputService WindowFocusReleased()

    UserInputService WindowFocused()

    Links externos

    Adicione um comentário do UserInputService
    Comentário enviado com sucesso! Vamos analisá-lo nas próximas horas.