punkfuncgames/gamestate-module

GameStateModule Reference

Package: com.punkfuncgames.gamestate | Define: PUNKFUNC_GAME_STATE Location: Packages/com.punkfuncgames.gamestate/Runtime/PunkFuncGames.GameState/ Namespace: PunkFuncGames.GameState

GameState Enum

None, Initializing, MainMenu, Loading, Playing, Paused, GameOver, Victory

IGameStateService

• ReadOnlyReactiveProperty<GameState> CurrentState
• GameState PreviousState
• ReadOnlyReactiveProperty<bool> IsPlayable — true only when Playing
• Observable<(GameState previous, GameState current)> OnStateChanged
• ChangeState(GameState newState)
• RevertToPreviousState()

Implementation: GameStateService

Dependencies: IPublisher<GameStateChangedEvent>, IPublisher<GamePausedEvent>, IPublisher<GameResumedEvent>

ChangeState() behavior:

1. Early return if already in target state
2. Stores previous state
3. Updates CurrentState and IsPlayable reactive properties
4. Updates Time.timeScale: Paused/GameOver → 0f, everything else → 1f
5. Publishes to R3 Subject (local) AND MessagePipe broker (global)
6. If entering Paused → publishes GamePausedEvent
7. If leaving Paused to Playing → publishes GameResumedEvent

Events

| Event | Key Fields | |-------|------------| | GameStateChangedEvent | PreviousState, NewState | | GamePausedEvent | (empty marker) | | GameResumedEvent | (empty marker) | | GameStartedEvent | IsNewGame, StartLevel | | GameEndedEvent | IsVictory, FinalScore, PlayTime |

Installer

GameStateInstaller.Install(builder, options);
// Registers: GameStateService (Singleton) as IGameStateService
// Events: all 5 event brokers

Usage Pattern

// Toggle pause
if (_gameState.CurrentState.CurrentValue == GameState.Playing)
    _gameState.ChangeState(GameState.Paused);
else
    _gameState.RevertToPreviousState();

// React to state changes
_gameState.OnStateChanged
    .Subscribe(change => HandleStateChange(change.previous, change.current))
    .AddTo(_disposables);

// Only execute when playing
_gameState.IsPlayable
    .Where(playable => playable)
    .Subscribe(_ => EnableGameplay())
    .AddTo(_disposables);