cInput Reference Manual
  • Introduction
  • Using cInput
    • Initial Setup
    • A Brief Explanation of cInput
    • Setting Up the Default Inputs
      • The Keys Class
      • A Note About Xbox Controllers
      • Using Modifier Keys
    • Using cInput to Control Your Game
    • Changing Inputs from the Defaults
      • The OnKeyChanged Event
    • General Tips and Tricks
  • Script Reference
    • Variables and Properties
      • allowDuplicates
      • anyKey
      • anyKeyDown
      • deadzone
      • externalInputs
      • gravity
      • length
      • scanning
      • sensitivity
      • usePlayerPrefs
    • Methods
      • AddModifier
      • AxisInverted
      • Calibrate
      • ChangeKey
      • Clear
      • ForbidAxis
      • ForbidKey
      • GetAxis
      • GetAxisDeadzone
      • GetAxisGravity
      • GetAxisRaw
      • GetAxisSensitivity
      • GetButton
      • GetButtonDown
      • GetButtonUp
      • GetKey
      • GetKeyDown
      • GetKeyUp
      • GetText
      • Init
      • IsAxisDefined
      • IsKeyDefined
      • LoadExternal
      • RemoveModifier
      • ResetInputs
      • SetAxis
      • SetAxisDeadzone
      • SetAxisGravity
      • SetAxisSensitivity
      • SetKey
    • Valid Inputs
  • Changelog
Powered by GitBook
On this page
  • Parameters
  • Returns
  • Description
  • Example

Was this helpful?

  1. Script Reference
  2. Methods

GetKey

PreviousGetButtonUpNextGetKeyDown

Last updated 5 years ago

Was this helpful?

bool GetKey(string description) bool GetKey(int descriptionHash)

Parameters

description: The name of the key, as defined in . descriptionHash: The hashcode of the name of the key, as defined in .

Returns

bool: Returns true if the key is being held down.

Description

Use this to determine if a key is being held down. GetKey() returns true repeatedly while the user holds down the key, and returns false if the key is not being pressed.

The use of or is recommended if you want to trigger an event only once per keypress, e.g., for jumping.

Example

SetKey()
SetKey()
GetKeyDown()
GetKeyUp()