Virtual Keys

(Done on my end, just needs edits.)

Virtual Keys

Virtual keys acts as an intermediary between physical controls and controls registered in the game. Keyboard, mouse, and game controllers can all be mapped to a single "virtual key" and perform the same action.

(Placeholder for image.)

Properties

System

Name Explanation Type
Name The name of the virtual key. String
ID The ID of the virtual key. Number

Details

Name Explanation Type
Cooldown The duration before the virtual key is registered again in milliseconds. Number
Ignore Input Blocks Whether or not the virtual key ignores input blockers and works even if controls are considered frozen. Toggle
Require Key Release Whether or not the virtual key requires a key release before registering again. Toggle

Scripts

Name Explanation Type
Pressed Script The script to execute when the virtual key is pressed. Script
Ongoing Script The script to execute when the virtual key is held. Script
Released Script The script to execute when the virtual key is no longer pressed. Script

Mapping

Mappings contain all of the physical controls and their sources. When a mapping is selected, it can be remapped by clicking the button under the Key and physically pressing the button or key you wish to map.

Mutually Exclusive Keys

Mutually exclusive virtual keys are other keys that cannot run at the same time as the current key. This prevents overlaps in behavior.