> ## 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.

# GetArcadeStickState

> IGameInputReading::GetArcadeStickState

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

## Syntax

```cpp theme={null}
bool GetArcadeStickState(
    GameInputArcadeStickState* state
)
```

### Parameters

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

Interpretation of the input as an arcade stick input.

### Return value

Type: bool

Returns true on successful interpretation of an arcade stick. Returns false when attempting to read an input that is not recognized as an arcade 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

- [GameInputArcadeStickState](https://docs.xbox.com/reference/input/gameinput/structs/gameinputarcadestickstate.md)
- [IGameInputReading (Interface contents)](https://docs.xbox.com/reference/input/gameinput/interfaces/igameinputreading/igameinputreading.md)
- [GetArcadeStickButtonMappingInfo](https://docs.xbox.com/reference/input/gameinput/interfaces/igameinputmapper/methods/igameinputmapper_getarcadestickbuttonmappinginfo.md)
- [GetFlightStickState](https://docs.xbox.com/reference/input/gameinput/interfaces/igameinputreading/methods/igameinputreading_getflightstickstate.md)
- [GameInputArcadeStickButtons](https://docs.xbox.com/reference/input/gameinput/enums/gameinputarcadestickbuttons.md)