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

GetAxis

PreviousForbidKeyNextGetAxisDeadzone

Last updated 5 years ago

Was this helpful?

float GetAxis(string description) float GetAxis(int descriptionHash)

Parameters

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

Returns

float: A value between -1 and 1 inclusive.

Description

Returns the value of the axis.

Example

SetAxis()
SetAxis()