punkfuncgames/core-module

Core Module Reference

Package: com.punkfuncgames.core | Define: PUNKFUNC_CORE Location: Packages/com.punkfuncgames.core/Runtime/PunkFuncGames.Core/

MVC Pattern (Core/MVC/)

Interfaces

IModel : IDisposable — string Id, bool IsInitialized, Initialize(), Reset() IModel<TData> : IModel (TData : struct) — TData Data, SetData(TData)

IController : IDisposable — bool IsActive, Activate(), Deactivate() IController<TModel, TView> — TModel Model, TView View, Initialize(TModel, TView)

IView : IDisposable — ReadOnlyReactiveProperty<bool> IsVisible, bool IsInteractable, ShowAsync(ct), HideAsync(ct), SetVisibleImmediate(bool) IView<TData> : IView — Bind(TData), Unbind()

Base Classes

ModelBase : IModel

• Protected: CompositeDisposable Disposables
• Virtual: OnInitialize(), OnReset(), OnDispose()

ModelBase<TData> : ModelBase (TData : struct)

• TData Data (read-only), ReadOnlyReactiveProperty<TData> DataChanged
• SetData(TData) → triggers OnDataChanged(TData)

ControllerBase : IController

• Protected: CompositeDisposable Disposables
• Virtual: OnActivate(), OnDeactivate(), OnDispose()

ControllerBase<TModel, TView> — adds Model, View properties

• Virtual: OnInitialize(), BindModelToView(), BindViewToModel()
• OnActivate() calls both Bind methods automatically

ViewBase : MonoBehaviour, IView — requires CanvasGroup

• SerializedFields: ViewAnimatorAsset _showAnimator, ViewAnimatorAsset _hideAnimator
• Properties: ILifecycleComponent Lifecycle, CompositeDisposable Disposables, CancellationToken DestroyCancellationToken, CanvasGroup CanvasGroup
• Virtual: OnAwake(), OnInjected(), OnShown(), OnHidden()
• Default fade: 0.3s in, 0.2s out

ViewBase<TData> — adds TData BoundData, bool IsBound

• Abstract: OnBind(TData) — must implement
• Virtual: OnUnbind()

MVCBinder (Static Helper)

• builder.RegisterMVC<TModel, TView, TController>(lifetime)
• builder.RegisterMVCWithView<TModel, TView, TController>(view, lifetime)
• MVCBinder.InitializeAndActivate(controller, model, view)

MVCEntryPoint<TModel, TView, TController> : IStartable, IDisposable — auto-wires MVC on Start()

Composition System (Core/Composition/)

ILifecycleComponent : IDisposableComponent, ICancellableComponent — combines disposal + cancellation

IDisposableComponent — CompositeDisposable Disposables, bool IsDisposed, AddDisposable(IDisposable) ICancellableComponent — CancellationToken CancellationToken, Cancel(), CreateLinkedToken(CancellationToken) IInjectableComponent — bool IsInjected, event Action OnInjected, NotifyInjected()

ComposableBehaviour : MonoBehaviour (abstract base for DI-aware MonoBehaviours)

• Protected: ILifecycleComponent Lifecycle, IInjectableComponent Injectable, CompositeDisposable Disposables, CancellationToken DestroyCancellationToken, bool IsInjected
• Virtual: CreateLifecycleComponent(), CreateInjectableComponent(), OnInjected(), OnDestroy()
• Pattern: Composition over inheritance for lifecycle management

Service Interfaces (Core/Interface/)

IService                          — marker interface
IAsyncInitializable               — InitializeAsync(ct), IsInitialized
IResettable                       — Reset()
IDisposableService : IService     — IDisposable
IAnalyticsService : IService      — TrackLevelStart/Complete/Fail, TrackItemAcquired/Used,
                                    TrackAchievementUnlocked, TrackPurchase, SetUserId, FlushAsync

Extension Helpers (Core/Extension/)

R3Helper (static extensions):

• SubscribeAndAddTo(source, onNext, disposables) — subscribe + auto-dispose
• WhereTrue() / WhereFalse() — bool filtering
• AsUnitObservable(), Log(tag), DelayFrames(count), ThrottleFrames(count)

MessagePipeR3Helper:

• subscriber.Subscribe(handler, disposables) — MessagePipe → CompositeDisposable
• subscriber.AsObservable() — convert ISubscriber<T> to Observable<T>

UnityR3Helper:

• EveryUpdate(), EveryFixedUpdate(), EveryLateUpdate() — frame observables
• TimerUnscaled(delay), IntervalUnscaled(period) — unscaled time

Animation System (Core/Animation/)

IViewAnimator — float Duration, AnimateAsync(CanvasGroup, ct) IReversibleAnimator — adds AnimateReverseAsync(CanvasGroup, ct)

ViewAnimatorAsset (ScriptableObject base) — _duration = 0.3f

Built-in animators (all support unscaled time):

• FadeAnimator — from/to alpha, easing curve
• ScaleAnimator — from/to scale, optional fade, easing curve
• SlideAnimator — direction (L/R/U/D), pixel or % distance, optional fade
• PunchScaleAnimator — punch scale, vibrato, elasticity
• CompositeAnimator — list of child animators, Parallel or Sequential mode

Attributes (Core/Attributes/)

DrawIfAttribute — conditionally show/hide inspector fields based on other field values

• Usage: [DrawIf("_myBool", true)] or [DrawIf("_myEnum", MyEnum.Value, DisablingType.ReadOnly)]

Creating New MVC Components

// 1. Define data struct
public struct PlayerData { public int Health; public int Score; }

// 2. Create Model
public sealed class PlayerModel : ModelBase<PlayerData>
{
    public override string Id => "Player";
}

// 3. Create View
public sealed class PlayerView : ViewBase<PlayerData>
{
    [SerializeField] private TMP_Text _healthText;
    protected override void OnBind(PlayerData data) => _healthText.text = data.Health.ToString();
}

// 4. Create Controller
public sealed class PlayerController : ControllerBase<PlayerModel, PlayerView>
{
    protected override void BindModelToView()
    {
        Model.DataChanged.Subscribe(data => View.Bind(data)).AddTo(Disposables);
    }
}

// 5. Register in Installer
builder.RegisterMVC<PlayerModel, PlayerView, PlayerController>();