Skip to content

API > UserInput

UserInput⚓︎

This is an object that holds the value of user input.

Members⚓︎

Properties⚓︎

Name Description
UserInput.ALTPropertyReadonly Property Desktop mode only, associated with button [Left Alt] in keyboard.
UserInput.CrouchPropertyReadonly Property Desktop mode only, associated with button [C] in keyboard.
UserInput.CTRLPropertyReadonly Property Desktop mode only, associated with button [Left Ctrl] in keyboard.
UserInput.JumpPropertyReadonly Property Desktop mode jump [Space] button is pressed.
UserInput.KeyboardArrowsPropertyReadonly Property Arrow inputs from keyboard [up, down, left, right] when in Desktop Mode.
UserInput.KeyboardMovePropertyReadonly Property Move Inputs from keyboard [W,S,A,D] when in desktop mode.
UserInput.LeftControlPropertyReadonly Property The left primary control vector2. In some controllers this is accomplished by trackpad, in others by a joystick. Returns values from keyboard buttons [W,S,A,D] while the client is in desktop mode.
UserInput.LeftGrabPropertyReadonly Property The left controller grab button. It returns a value between 0 and 1, 1 being fully pressed. Associates to [q] button in desktop mode.
UserInput.LeftPrimaryPropertyReadonly Property Left controller primary button. Associated with [Space] button in keyboard while in desktop mode.
UserInput.LeftSecondaryPropertyReadonly Property Left controller secondary button.
UserInput.LeftSprintPropertyReadonly Property The left sprint action. This action triggered differently in different controller types. In joystick-based controller this is accomplished by clicking the joystick. In trackpad-based controllers, this is accomplished by double taping the trackpad. Associated with [Left Shift] button in keyboard while in desktop mode.
UserInput.LeftTriggerPropertyReadonly Property Left trigger button. The trigger button is the button pressed by index finger. It returns a value between 0 and 1, 1 being fully pressed. Associates to [Left Mouse Button] while in desktop mode.
UserInput.RightControlPropertyReadonly Property The right primary control vector2. In some controllers this is accomplished by trackpad, in others by a joystick. Returns values from keyboard buttons [W,S,A,D] while the client is in desktop mode.
UserInput.RightGrabPropertyReadonly Property The right controller grab button. It returns a value between 0 and 1, 1 being fully pressed. Associates to [e] button in desktop mode.
UserInput.RightPrimaryPropertyReadonly Property Right controller primary button. Associated with [Space] button in keyboard while in desktop mode.
UserInput.RightSecondaryPropertyReadonly Property Right controller secondary button.
UserInput.RightSprintPropertyReadonly Property The right sprint action. This action triggered differently in different controller types. In joystick-based controller this is accomplished by clicking the joystick. In trackpad-based controllers, this is accomplished by double taping the trackpad. Associated with [Left Shift] button in keyboard while in desktop mode.
UserInput.RightTriggerPropertyReadonly Property Right trigger button. The trigger button is the button pressed by index finger. It returns a value between 0 and 1, 1 being fully pressed. Associates to [Right Mouse Button] while in desktop mode.