punkfuncgames/scene-module

SceneModule Reference

Package: com.punkfuncgames.scene | Define: PUNKFUNC_SCENE Location: Packages/com.punkfuncgames.scene/Runtime/PunkFuncGames.Scene/ Namespace: PunkFuncGames.Scene

ISceneService

Properties:

• string CurrentSceneName
• ReadOnlyReactiveProperty<float> LoadingProgress — 0 to 1
• ReadOnlyReactiveProperty<bool> IsLoading

Scene Operations:

• UniTask LoadSceneAsync(string sceneName, SceneTransition transition = Fade, float transitionDuration = 0.5f, ct)
• UniTask LoadSceneAdditiveAsync(string sceneName, ct)
• UniTask UnloadSceneAsync(string sceneName, ct)
• UniTask ReloadCurrentSceneAsync(SceneTransition transition = Fade, ct)
• bool IsSceneLoaded(string sceneName)

Convenience Navigation:

• UniTask GoToMainMenuAsync(SceneTransition transition = Fade) — changes state to Loading → MainMenu
• UniTask GoToGameplayAsync(SceneTransition transition = Fade) — changes state to Loading → Playing

SceneTransition Enum

None, Fade, Instant, Crossfade, SlideLeft, SlideRight, Custom

Implementation: SceneService

Dependencies: GameSettings (nullable), IGameStateService

• Uses SceneManager.LoadSceneAsync with manual activation control
• Progress tracks to 0.9 (standard Unity), then activates scene
• Prevents concurrent loads (early return if already loading)
• Transition animations are placeholder stubs (Fade delays half-duration)
• Scene names default from GameSettings: MainMenu → "MainMenu", Gameplay → "Gameplay"

Installer

SceneInstaller.Install(builder);
// Registers: SceneService (Singleton) as ISceneService

Usage Pattern

// Navigate to gameplay
await _sceneService.GoToGameplayAsync(SceneTransition.Fade);

// Load additive scene (e.g., for overlays)
await _sceneService.LoadSceneAdditiveAsync("HUDScene");

// Track loading progress
_sceneService.LoadingProgress
    .Subscribe(p => _progressBar.value = p)
    .AddTo(_disposables);

// Check if scene loaded
if (_sceneService.IsSceneLoaded("Level2"))
    await _sceneService.UnloadSceneAsync("Level2");