Input Events

Input events contain an input (a user input that will be listened for) and an event (code logic that will be invoked) that will be run when that input is invoked by the user.

Parameters to a function should be represented using a single "?".

---

VEML v1.0+

Input Event Fields

• input - Input to monitor

  Type: String

  Minimum: 1

  Maximum: 1

  See Input types.

• event - Code to invoke when input received.

  Type: String

  Minimum: 1

  Maximum: 1

Examples

<inputevent input="move" event="MoveCharacter(?);"></inputevent>

<inputevent input="endmove" event="EndMoveCharacter();"></inputevent>

<inputevent input="look" event="LookCharacter(?);"></inputevent>

<inputevent input="endlook" event="EndLookCharacter();"></inputevent>

Input types

This section outlines the inputs defined by the VEML specification.

Input Name	Description	Required Arguments	Callback Arguments
move	Invoked when a move is performed. On a desktop platform, this is triggered by the WASD/Arrow keys.	None.	x: float - X axis of the move. y: float - Y axis of the move. z: float - Z axis of the move.
endmove	Invoked when a move is completed.	None.	None.
look	Invoked when a look is performed. On a desktop platform, this is triggered by a mouse move.	None.	x: float - X axis of the look. y: float - Y axis of the look. z: float - Z axis of the look.
endlook	Invoked when a look is completed.	None.	None.
key	Invoked when the specified key is pressed.	key: string - The key to listen for.	key: string - The key that was pressed.
endkey	Invoked when the specified key press is completed.	key: string - The key to listen for.	key: string - The key that was released.
keycode	Invoked when the specified key code is pressed.	keycode: string - The key code to listen for.	keycode: string - The key code that was pressed.
endkeycode	Invoked when the specified key code press is completed.	keycode: string - The key code to listen for.	keycode: string - The key code that was released.
left	Invoked when the left key is pressed. On a desktop platform, this is triggered by the left mouse button.	None.	None.
endleft	Invoked when the left key is released.	None.	None.
middle	Invoked when the middle key is pressed. On a desktop platform, this is triggered by the middle mouse button.	None.	None.
endmiddle	Invoked when the middle key is released.	None.	None.
right	Invoked when the right key is pressed. On a desktop platform, this is triggered by the right mouse button.	None.	None.
endright	Invoked when the right key is released.	None.	None.
leftmenu	Invoked when the left menu button is pressed.	None.	None.
endleftmenu	Invoked when the left menu button is released.	None.	None.
rightmenu	Invoked when the right menu button is pressed.	None.	None.
endrightmenu	Invoked when the right menu button is released.	None.	None.
menu	Invoked when any menu button is pressed.	None.	None.
endmenu	Invoked when the last menu button is released.	None.	None.
lefttriggertouch	Invoked when the left trigger button is touched.	None.	None.
endlefttriggertouch	Invoked when the left trigger button is untouched.	None.	None.
righttriggertouch	Invoked when the right trigger button is touched.	None.	None.
endrighttriggertouch	Invoked when the right trigger button is untouched.	None.	None.
triggertouch	Invoked when any trigger button is touched.	None.	None.
endtriggertouch	Invoked when the last trigger button is untouched.	None.	None.
lefttriggerpress	Invoked when the left trigger button is pressed.	None.	None.
endlefttriggerpress	Invoked when the left trigger button is released.	None.	None.
righttriggerpress	Invoked when the right trigger button is pressed.	None.	None.
endrighttriggerpress	Invoked when the right trigger button is released.	None.	None.
triggerpress	Invoked when any trigger button is pressed.	None.	None.
endtriggerpress	Invoked when the last trigger button is released.	None.	None.
leftgrippress	Invoked when the left grip button is pressed.	None.	None.
endleftgrippress	Invoked when the left grip button is released.	None.	None.
rightgrippress	Invoked when the right grip button is pressed.	None.	None.
endrightgrippress	Invoked when the right grip button is released.	None.	None.
grippress	Invoked when any grip button is pressed.	None.	None.
endgrippress	Invoked when the last grip button is released.	None.	None.
lefttouchpadtouch	Invoked when the left touchpad is touched.	None.	None.
endlefttouchpadtouch	Invoked when the left touchpad is untouched.	None.	None.
lefttouchpadvaluechange	Invoked when the left touchpad value changes.	None.	x: float - The X component of the left touchpad value. y: float - The Y component of the left touchpad value.
righttouchpadtouch	Invoked when the right touchpad is touched.	None.	None.
endrighttouchpadtouch	Invoked when the right touchpad is untouched.	None.	None.
righttouchpadvaluechange	Invoked when the right touchpad value changes.	None.	x: float - The X component of the right touchpad value. y: float - The Y component of the right touchpad value.
touchpadtouch	Invoked when any touchpad is touched.	None.	None.
endtouchpadtouch	Invoked when the last touchpad is untouched.	None.	None.
lefttouchpadpress	Invoked when the left touchpad button is pressed.	None.	None.
endlefttouchpadpress	Invoked when the left touchpad button is released.	None.	None.
righttouchpadpress	Invoked when the right touchpad button is pressed.	None.	None.
endrighttouchpadpress	Invoked when the right touchpad button is released.	None.	None.
touchpadpress	Invoked when any touchpad button is pressed.	None.	None.
endtouchpadpress	Invoked when the last touchpad button is released.	None.	None.
leftprimarytouch	Invoked when the left primary button is touched.	None.	None.
endleftprimarytouch	Invoked when the left primary button is untouched.	None.	None.
rightprimarytouch	Invoked when the right primary button is touched.	None.	None.
endrightprimarytouch	Invoked when the right primary button is untouched.	None.	None.
primarytouch	Invoked when any primary button is touched.	None.	None.
endprimarytouch	Invoked when the last primary button is untouched.	None.	None.
leftprimarypress	Invoked when the left primary button is pressed.	None.	None.
endleftprimarypress	Invoked when the left primary button is released.	None.	None.
rightprimarypress	Invoked when the right primary button is pressed.	None.	None.
endrightprimarypress	Invoked when the right primary button is released.	None.	None.
primarypress	Invoked when any primary button is pressed.	None.	None.
endprimarypress	Invoked when the last primary button is released.	None.	None.
leftsecondarytouch	Invoked when the left secondary button is touched.	None.	None.
endleftsecondarytouch	Invoked when the left secondary button is untouched.	None.	None.
rightsecondarytouch	Invoked when the right secondary button is touched.	None.	None.
endrightsecondarytouch	Invoked when the right secondary button is untouched.	None.	None.
secondarytouch	Invoked when any secondary button is touched.	None.	None.
endsecondarytouch	Invoked when the last secondary button is untouched.	None.	None.
leftsecondarypress	Invoked when the left secondary button is pressed.	None.	None.
endleftsecondarypress	Invoked when the left secondary button is released.	None.	None.
rightsecondarypress	Invoked when the right secondary button is pressed.	None.	None.
endrightsecondarypress	Invoked when the right secondary button is released.	None.	None.
secondarypress	Invoked when any secondary button is pressed.	None.	None.
endsecondarypress	Invoked when the last secondary button is released.	None.	None.
leftstick	Invoked when the left stick is engaged.	None.	None.
endleftstick	Invoked when the left stick is disengaged.	None.	None.
rightstick	Invoked when the right stick is engaged.	None.	None.
endrightstick	Invoked when the right stick is disengaged.	None.	None.