# Members

#### # inner JOYSTICK_AVAILABLE

##### Properties:

Name | Type | Description
--- | --- | ---
`JOYSTICK_AVAILABLE` | boolean | true if joystick support is available.

#### # inner NUM_JOYSTICKS

##### Properties:

Name | Type | Description
--- | --- | ---
`NUM_JOYSTICKS` | number | number of available joysticks.

# Methods

#### # inner JoystickCalibrate(num)

Most joysticks need to be calibrated before they can provide full analogue input. This function performs the next operation in the calibration series for the specified stick, assuming that the joystick has been positioned in the manner described by a previous call to calibrate_joystick_name().

##### Parameters:

Name | Type | Description
--- | --- | ---
`num` | number | joystick index (starting with 0).

#### # inner JoystickCalibrateName(num) → {string}

Pass the number of the joystick you want to calibrate as the parameter.

##### Parameters:

Name | Type | Description
--- | --- | ---
`num` | number | joystick index (starting with 0).

Returns:

Returns a text description for the next type of calibration that will be done on the specified joystick, or null if no more calibration is required.

Type: string

#### # inner JoystickLoadData(file)

load joystick calibration info from file.

##### Parameters:

Name | Type | Description
--- | --- | ---
`file` | string | the file to load from.

#### # inner JoystickPoll(num) → {JoyInfo}

The joystick handler is not interrupt driven, so you need to call this function every now and again to update the global position values.

##### Parameters:

Name | Type | Description
--- | --- | ---
`num` | number | joystick index (starting with 0).

Returns:

Information about the joystick state.

Type: JoyInfo

#### # inner JoystickSaveData(file)

save joystick calibration info to file.

##### Parameters:

Name | Type | Description
--- | --- | ---
`file` | string | the file to save to.