Game state

Group state · 10 exports · from forks/gamexueren/scripthook.h (framework 1.0-beta7-wildm1, SH_API_VERSION 2)

The engine's GameFlow machine, tracked by the hook.

Export	Summary
`ShGetUiState`	—
`ShInDrone`	—
`ShInLoadout`	—
`ShInMap`	—
`ShInBinocular`	—
`ShInPauseMenu`	The game flow stays in Playing while paused, so this is read off the camera: the pause menu renders through a template pose no steered camera ever holds.
`ShGetGameState`	Game flow state.
`ShIsInGame`	Stays true while paused: the world is loaded and every read keeps working, so callers keep their state on Esc.
`ShGetGameStateName`	See `ShIsInGame`.
`ShInputContext`	The active input context index, or -1 when it cannot be read (not in game, engine objects not up).

ShGetUiState

c

SH_API uint32_t ShGetUiState(void);

No doc comment in the header.

scripthook.h, line 518

ShInDrone

c

SH_API int      ShInDrone(void);

No doc comment in the header.

scripthook.h, line 519

ShInLoadout

c

SH_API int      ShInLoadout(void);

No doc comment in the header.

scripthook.h, line 520

ShInMap

c

SH_API int      ShInMap(void);

No doc comment in the header.

scripthook.h, line 521

ShInBinocular

c

SH_API int      ShInBinocular(void);

No doc comment in the header.

scripthook.h, line 522

ShInPauseMenu

c

SH_API int  ShInPauseMenu(void);

The game flow stays in Playing while paused, so this is read off the camera: the pause menu renders through a template pose no steered camera ever holds.

scripthook.h, line 1932

ShGetGameState

c

SH_API int  ShGetGameState(void);

Game flow state. The hook installs on first use and tracks the engine's own state transitions.

scripthook.h, line 2769

ShIsInGame

c

SH_API int  ShIsInGame(void);

Stays true while paused: the world is loaded and every read keeps working, so callers keep their state on Esc.

scripthook.h, line 2773

ShGetGameStateName

c

SH_API int  ShGetGameStateName(char *buf, int len);

Documented together with ShIsInGame just above.

scripthook.h, line 2774

ShInputContext

c

SH_API int  ShInputContext(void);

The active input context index, or -1 when it cannot be read (not in game, engine objects not up). A consumer that changes behaviour per stance or per vehicle reads this: OnFoot for walking, Vehicle for ground vehicles, Helicopter/Airplane while flying, VehiclePassenger while riding along, Menu for the pause screens.

scripthook.h, line 2806