punkfuncgames/ui-module

UIModule Reference

Package: com.punkfuncgames.ui | Define: PUNKFUNC_UI Location: Packages/com.punkfuncgames.ui/Runtime/PunkFuncGames.UI/ Namespace: PunkFuncGames.UI

Services

IPanelService — Panel lifecycle management

• ReadOnlyReactiveProperty<string> ActivePanel
• UniTask<T> ShowPanelAsync<T>(string panelId, UILayer layer, object data, ct) where T : class
• UniTask HidePanelAsync(string panelId, ct)
• UniTask HideAllInLayerAsync(UILayer layer, ct)
• bool IsPanelVisible(string panelId)

IDialogService — Modal dialogs

• ReadOnlyReactiveProperty<bool> IsModalOpen
• UniTask<bool> ShowConfirmAsync(title, message, confirmText, cancelText, ct)
• UniTask ShowAlertAsync(title, message, okText, ct)

INotificationService — Toast notifications

• ShowNotification(message, duration), ShowSuccess(message, duration)
• ShowWarning(message, duration), ShowError(message, duration)

ILoadingService — Loading screen

• UniTask ShowLoadingAsync(message, ct), UniTask HideLoadingAsync(ct)
• SetLoadingProgress(float progress, message)

UILayer Enum (rendering order)

Background(0), Default(1), Popup(2), Modal(3), Overlay(4), Loading(5)

Implementation: UIService

Single service implements all 4 interfaces. Dependencies: IAssetService

• Creates [UIService] root GameObject (DontDestroyOnLoad) with layer containers
• Panels instantiated via IAssetService and cached in _loadedPanels
• Supports IDataReceiver interface for passing data to panels on show

IDataReceiver — implement on panels: void ReceiveData(object data)

Events

| Event | Key Fields | |-------|------------| | UIPanelOpenedEvent | PanelId, Layer | | UIPanelClosedEvent | PanelId |

Localized UI Components

LocalizedText : MonoBehaviour (inject ILocalizationService)

• SerializedFields: _key, _formatArgs, _uppercase, _lowercase
• Auto-updates when language changes via reactive subscription
• SetTextWithArgs(params object[] args)

LocalizedImage : MonoBehaviour (inject ILocalizationService)

• SerializedFields: _basePath, _useAddressables, _fallbackSprite
• Loads language-specific sprites, auto-reloads on language change

LocalizedAudio : MonoBehaviour (inject ILocalizationService)

• SerializedFields: _basePath, _autoPlay, _fallbackClip
• Play(), Stop(), Refresh()

View Components (Existing)

MainMenuPanel : ViewBase — Play, Settings, Quit buttons. Uses ISceneService, IPanelService. GameplayPanel : ViewBase — Return to menu button. Uses ISceneService, IPanelService. SettingsPanel : ViewBase — Stub (todo). UndoHistoryPanel : ViewBase — Undo/Redo/Clear buttons with reactive label bindings.

Installer

UIInstaller.Install(builder, options);
// Registers: UIService as EntryPoint (IPanelService, IDialogService, INotificationService, ILoadingService)
// Events: UIPanelOpenedEvent, UIPanelClosedEvent

Usage Pattern

// Show a panel
MyPanel panel = await _panelService.ShowPanelAsync<MyPanel>("MyPanel", UILayer.Popup);

// Show a confirmation dialog
bool confirmed = await _dialogService.ShowConfirmAsync("Delete?", "Are you sure?");

// Create a panel that receives data
public sealed class ShopPanel : ViewBase, IDataReceiver
{
    public void ReceiveData(object data)
    {
        if (data is ShopConfig config) Initialize(config);
    }
}

// Show with data
await _panelService.ShowPanelAsync<ShopPanel>("ShopPanel", UILayer.Default, myShopConfig);