> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# GetFlightStickState

> IGameInputReading::GetFlightStickState

Retrieve a view of the input reading that describes the state of a flight stick.

## Syntax

```cpp theme={null}
bool GetFlightStickState(
    GameInputFlightStickState* state
);
```

### Parameters

*state*   \_Out\_\
Type: [GameInputFlightStickState\*](https://docs.xbox.com/reference/input/gameinput/structs/gameinputflightstickstate.md)

Interpretation of the input as a flight stick input.

### Return value

Type: bool

Returns true on successful interpretation of a flight stick. Returns false when attempting to read an input that is not recognized as a flight stick.

[Input API Overview](https://docs.xbox.com/build/core-features/common/input/overviews/input-overview.md)\
[IGameInputReading](https://docs.xbox.com/reference/input/gameinput/interfaces/igameinputreading/igameinputreading.md)

## Version History

| Version | Changes |
| - | - |
| **v0** | Introduced. |


## Related topics

- [GameInputFlightStickState](https://docs.xbox.com/reference/input/gameinput/structs/gameinputflightstickstate.md)
- [IGameInputReading (Interface contents)](https://docs.xbox.com/reference/input/gameinput/interfaces/igameinputreading/igameinputreading.md)
- [GetFlightStickButtonMappingInfo](https://docs.xbox.com/reference/input/gameinput/interfaces/igameinputmapper/methods/igameinputmapper_getflightstickbuttonmappinginfo.md)
- [GetFlightStickAxisMappingInfo](https://docs.xbox.com/reference/input/gameinput/interfaces/igameinputmapper/methods/igameinputmapper_getflightstickaxismappinginfo.md)
- [GetArcadeStickState](https://docs.xbox.com/reference/input/gameinput/interfaces/igameinputreading/methods/igameinputreading_getarcadestickstate.md)