GearBlocks
The GearBlocks Lua scripting API
Properties | List of all members
SmashHammer.Scripting.JoystickAxisProxy Struct Reference

A joystick axis. More...

Properties

readonly string AxisName [get, set]
 Name of the bound joystick axis, if any.
 
readonly float Deadzone [get, set]
 The joystick axis's deadzone.
 
readonly float Gamma [get, set]
 The joystick axis's gamma.
 
readonly float Centre [get, set]
 The joystick axis's centre.
 
readonly bool InvertAxis [get, set]
 Is the joystick axis inverted?
 
readonly bool IsBound [get]
 Is the joystick axis bound?
 
readonly float Value [get]
 The joystick axis's value.
 

Detailed Description

A joystick axis.

Property Documentation

◆ AxisName

readonly string SmashHammer.Scripting.JoystickAxisProxy.AxisName
getset

Name of the bound joystick axis, if any.

The joystick axis name, "None" if not bound.

◆ Deadzone

readonly float SmashHammer.Scripting.JoystickAxisProxy.Deadzone
getset

The joystick axis's deadzone.

The deadzone of this joystick axis.

◆ Gamma

readonly float SmashHammer.Scripting.JoystickAxisProxy.Gamma
getset

The joystick axis's gamma.

The gamma of this joystick axis.

◆ Centre

readonly float SmashHammer.Scripting.JoystickAxisProxy.Centre
getset

The joystick axis's centre.

The centre of this joystick axis.

◆ InvertAxis

readonly bool SmashHammer.Scripting.JoystickAxisProxy.InvertAxis
getset

Is the joystick axis inverted?

true if this joystick axis is inverted; otherwise, false.

◆ IsBound

readonly bool SmashHammer.Scripting.JoystickAxisProxy.IsBound
get

Is the joystick axis bound?

true if a joystick axis is bound; otherwise, false.

◆ Value

readonly float SmashHammer.Scripting.JoystickAxisProxy.Value
get

The joystick axis's value.

The current value of this joystick axis.