Keyboard Sensor

Keyboard Sensor

• When the selected key is pressed, it sends one positive pulse to the connected controller(s)
   
• When the selected key is released, it sends one negative pulse to the connected controller(s)

Key:

• Keyboard Key that you want to trigger the sensor

All Keys:

• Select this if you want every keyboard key to trigger the sensor
   
• Use with a Python Script/Module

First Modifier:

• A keyboard key which needs to be pressed while pressing the main key
   
• Leave blank for none

Second Modifier:

• A keyboard key which needs to be pressed while pressing the main key
   
• Leave blank for none

Log Toggle:

• Log toggle turns on/off saving of all keystrokes entered to a string property
   
• Name of a Boolean Property
   
• Boolean = True:
  • All keystrokes will be saved as a string to the Target (string property)
• Boolean = False:
  • Keystrokes won't be saved
• Key, First Modifier, Second Modifier and All keys can be left blank

Target:

• Name of the String Property the keystrokes will be saved to
   
• When the Log Toggle = True, all the keystrokes will be saved to Target string property
   
• Saves all the keystrokes.  Not just the key(s) selected
   
• Key, First Modifier, Second Modifier and All keys can be left blank

Keyboard:

• The type of Sensor

Name:

• Sensor name

Pin:

• Enabled: 
  • Always display the Sensor
• Disabled: 
  • Only display when the State Mask group the Sensor is linked to is being displayed

Checkbox:

• Enabled:
  • Sensor is turned on
• Disabled:
  • Sensor is turned off

True Level Trigger:

• Enabled:
  • Selected key(s) pressed:
    • Sends a positive pulse to the connected controller(s) with each logic tic
  • Selected key(s) released:
    • Sends one negative pulse to connected controller(s)
  • Selected key(s) not pressed:
    • No pulse sent
• Disabled:
  • Selected key(s) pressed:
    • Sends one positive pulse to the connected controller(s)
  • Selected key(s) released:
    • Sends one negative pulse to the connected controller(s)
  • Selected key(s) not pressed:
    • No pulse sent
• The default logic tic rate is 60 per second

False Level Trigger:

• Enabled:
  • Selected key(s) pressed:
    • Sends one positive pulse to the connected controller(s)
  • Selected key(s) released:
    • Sends a negative pulse to the connected controller(s) with each logic tic
  • Selected key(s) not pressed:
    • Sends a negative pulse to the connected controller(s) with each logic tic
• Disabled:
  • Selected key(s) pressed:
    • Sends one positive pulse to the connected controller(s)
  • Selected key(s) released:
    • Sends one negative pulse to connected controller(s)
  • Selected key(s) not pressed:
    • No pulse sent
• The default logic tic rate is 60 per second

Skip:

• Used with True Level Trigger and False Level Trigger
   
• Skips the number of logic tics entered before sending the next pulse

Level:

• Enabled:
  • Switching from a State Mask group the sensor belongs to to a State Mask group it doesn't belong to:
    • Sensor is deactivated
  • Switching from a State Mask group the sensor doesn't belong to to a State Mask group it belongs to:
    • Sensor is activated. Uses last input before being deactivated
• Disabled:
  • Switching from a State Mask group the sensor belongs to to a State Mask group it doesn't belong to:
    • Sensor is deactivated
  • Switching from a State Mask group the sensor doesn't belong to to a State Mask group it belongs to:
    • Sensor is activated

Tap:

• Enabled:
  • Keyboard key pressed:
    • A positive pulse is immediately followed by a negative pulse (next frame)
  • Keyboard key released:
    • No pulse sent
• Disabled:
  • Keyboard key pressed:
    • A positive pulse is sent to the connected controller(s)
  • Keyboard key released:
    • A negative pulse is sent to the connected controller(s)
• True Level Trigger enabled and Skip = 0: 
  • Never has a chance to send a negative pulse

Invert:

• Inverts the output of the triggers.
   
• A positive trigger event sends a negative pulse.
   
• A negative trigger event sends a positive pulse.

Note:

• Sensors can be connected to more than one controller
   
• Sensors connected to a controller(s) belong to the same State Mask group(s) as the controller(s)