Controls Input

scripts/vscripts/alyxlib/controls/input.lua

Global variables

Hand
InputHandBoth	-1
InputHandLeft	0
InputHandRight	1
InputHandPrimary	2
InputHandSecondary	3

Properties

version

Input.version = value

Default value "v4.1.0"

AutoStart

Input.AutoStart = value

Default value true

MultiplePressInterval

Input.MultiplePressInterval = value

Default value 0.35

Methods

GetButtonDescription

Get the description of a given button. Useful for debugging or hint display.

Input:GetButtonDescription(button)

Parameters

• button
DigitalInputAction
  The button to get the description of

Returns - string The description string

GetAnalogDescription

Get the description of a given analog action. Useful for debugging or hint display.

Input:GetAnalogDescription(analog)

Parameters

• analog
DigitalInputAction
  The analog action to get the description of

Returns - string The description string

GetControllerTypeDescription

Get the description of a given controller type.

Input:GetControllerTypeDescription(controllerType)

Parameters

• controllerType
ControllerType
  The controller type

Returns - string The description string

GetHandName

Get the name of a hand.

Input:GetHandName(hand, use_operant)

Parameters

• hand
CPropVRHand, 0, 1
  The hand entity or ID
• use_operant (optional)
  boolean
  If true, name will use primary/secondary instead of right/left

ListenToButton

Listens to a specific digital input press/release.

Input:ListenToButton(kind, hand, button, presses, callback, context)

Parameters

• kind
string, '"press"', '"release"'
  The kind of button interaction
• hand
CPropVRHand, InputHandBoth, InputHandKind, -1
  The type of hand to listen on, or the hand itself
• button
NamedDigitalInputAction, DigitalInputAction
  The button to listen to
• presses
integer, nil
  Number of times the button must be pressed in quick succession. E.g. 2 for double click. Only applicable for kind press
• callback
function, function
  The function that will be called when the button is pressed
• context (optional)
  T
  Optional context passed into the callback as the first value

Returns

• integer

The callback ID

• integer|nil

The second callback ID, if hand is InputHandBoth

ListenToAnalog

Listens to a specific analog action reaching a certain value.

Input:ListenToAnalog(kind, hand, analogAction, analogValue, callback, context)

Parameters

• kind
"up", "down"
up means listen for the value moving above analogValue, down means listen for it moving below
• hand
CPropVRHand, InputHandKind
  The hand entity or kind of hand to listen on
• analogAction
AnalogInputAction
  The specific analog action to listen for
• analogValue
AnalogValueType
  The value(s) to listen for
• callback
function
  The function that will be called when conditions are met
• context (optional)
  any
  Optional context passed into the callback as the first value

Returns

• integer

The callback ID

• integer|nil

The second callback ID, if hand is InputHandBoth

ModifyAnalogCallback

Changes some data which was defined in ListenToAnalog for a specific ID.

Input:ModifyAnalogCallback(id, analogAction, analogValue)

Parameters

• id
integer
  The ID of the analog event you want to modify
• analogAction (optional)
  AnalogInputAction
  The new action to listen for, or nil to leave unchanged
• analogValue
AnalogValueType
  The new value to listen for, or nil to leave unchanged

Returns - boolean True if the ID was found, false otherwise

StopListening

Unregisters a listener with a specific ID.

Input:StopListening(id)

Parameters

• id
number
  The ID of the listener

StopListeningCallbackContext

Unregisters any listeners with a specific callback/context pair.

Input:StopListeningCallbackContext(callback, context)

Parameters

• callback
function
  The callback function
• context (optional)
  any
  The context that was given

StopListeningByContext

Unregisters any listeners which have a specific context.

Input:StopListeningByContext(context)

Parameters

• context
any
  The context that was given

Start

Starts the input system.

Input:Start(on)

Parameters

• on
EntityHandle?
  Optional entity to do the tracking on. This is the player by default

Stop

Stops the input system.

Input:Stop()

Types

InputPressCallback

A callback for when a button is pressed.

Field	Type	Description
kind	"press"	The kind of action event
press_time	number	The server time at which the button was pressed
hand	CPropVRHand	EntityHandle for the hand that pressed the button
button	DigitalInputAction	The ID of the button that was pressed

InputReleaseCallback

A callback for when a button is released.

Field	Type	Description
kind	"release"	The kind of action event
release_time	number	The server time at which the button was released
hand	CPropVRHand	EntityHandle for the hand that released the button
button	DigitalInputAction	The ID of the button that was pressed
held_time	number	Seconds the button was held for prior to being released

InputAnalogCallback

A callback for when an analog action is moved.

Field	Type	Description
kind	"up"|"down"	The kind of analog event
value	Vector	The vector value of the analog action at the time of detection
hand	CPropVRHand	EntityHandle for the hand that moved the analog action
analog	AnalogInputAction	The ID of the analog action that was moved

Aliases

NamedDigitalInputAction

Value	Description
DIGITAL_INPUT_TOGGLE_MENU
DIGITAL_INPUT_MENU_INTERACT
DIGITAL_INPUT_MENU_DISMISS
DIGITAL_INPUT_USE
DIGITAL_INPUT_USE_GRIP
DIGITAL_INPUT_SHOW_INVENTORY
DIGITAL_INPUT_GRAV_GLOVE_LOCK
DIGITAL_INPUT_FIRE
DIGITAL_INPUT_ALT_FIRE
DIGITAL_INPUT_RELOAD
DIGITAL_INPUT_EJECT_MAGAZINE
DIGITAL_INPUT_SLIDE_RELEASE
DIGITAL_INPUT_OPEN_CHAMBER
DIGITAL_INPUT_TOGGLE_LASER_SIGHT	= 13
DIGITAL_INPUT_TOGGLE_BURST_FIRE
DIGITAL_INPUT_TOGGLE_HEALTH_PEN
DIGITAL_INPUT_ARM_GRENADE
DIGITAL_INPUT_ARM_XEN_GRENADE
DIGITAL_INPUT_TELEPORT
DIGITAL_INPUT_TURN_LEFT
DIGITAL_INPUT_TURN_RIGHT
DIGITAL_INPUT_MOVE_BACK
DIGITAL_INPUT_WALK
DIGITAL_INPUT_JUMP
DIGITAL_INPUT_MANTLE
DIGITAL_INPUT_CROUCH_TOGGLE
DIGITAL_INPUT_STAND_TOGGLE
DIGITAL_INPUT_ADJUST_HEIGHT

InputHandKind

Value	Description
InputHandLeft
InputHandRight
InputHandPrimary
InputHandSecondary
0	Left Hand.
1	Right Hand.
2	Primary Hand.
3	Secondary Hand.

AnalogValueType

Value	Description
Vector
{ x:number?, y:number? }
{[1]:number?,[2]:number?}
number