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

GetKeyUp

PreviousGetKeyDownNextGetText

Last updated 5 years ago

Was this helpful?

bool GetKeyUp(string description) bool GetKeyUp(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 only once each time the key is released.

Description

Use this to determine if a key has been released during this frame. GetKeyUp() returns true only once when the key is first released.

The use of is recommended if you want to trigger an event repeatedly while the key is being held down, e.g., for continuous movement.

Example

SetKey()
SetKey()
GetKey()