punkfuncgames/unlock-condition-module

UnlockConditionModule Reference

Package: com.punkfuncgames.unlock-condition | Define: PUNKFUNC_UNLOCK_CONDITION Location: Packages/com.punkfuncgames.unlock-condition/Runtime/PunkFuncGames.UnlockCondition/ Namespace: PunkFuncGames.UnlockCondition

Base Class

UnlockConditionConfig (abstract ScriptableObject):

• abstract bool IsMet(IObjectResolver resolver) — check if condition is satisfied
• virtual string GetEditorDescription() — inspector preview text
• virtual string GetTestResult(IObjectResolver resolver) — detailed pass/fail feedback
• virtual float GetProgress(IObjectResolver resolver) — progress 0.0-1.0
• Context menu: "Test Condition" for editor/play mode testing

Utility

ComparisonHelper (Utility/ComparisonHelper.cs):

• static bool Evaluate(ComparisonOperator, BigDouble current, BigDouble target) — evaluate comparison
• static string GetSymbol(ComparisonOperator) — get display symbol (>, <, =, >=, <=)
• static float CalculateProgress(ComparisonOperator, BigDouble current, BigDouble target) — calculate progress

Atomic Conditions

CurrencyThresholdConditionConfig — check a currency amount

• Fields: CurrencyDefinition Currency, ComparisonOperator Operator, SerializableBigDouble Threshold
• Resolves IWalletService from VContainer at runtime
• Menu: GameTemplate/Unlock Conditions/Currency Threshold

StatRequirementConditionConfig — check a stat value

• Fields: StatsDefinition Stat, ComparisonOperator Operator, SerializableBigDouble RequiredValue
• Resolves IStatsService from VContainer at runtime
• Menu: GameTemplate/Unlock Conditions/Stat Requirement

UpgradeLevelConditionConfig — check an upgrade level

• Fields: string UpgradeId, ComparisonOperator Operator, int RequiredLevel
• Resolves IUpgradeService from VContainer at runtime
• Menu: GameTemplate/Unlock Conditions/Upgrade Level

PrestigeCountConditionConfig — check prestige count

• Fields: ComparisonOperator Operator, int RequiredCount
• Resolves IPrestigeService from VContainer at runtime
• Menu: GameTemplate/Unlock Conditions/Prestige Count

GameStateConditionConfig — check current game state

• Fields: GameState RequiredState, bool Invert
• Resolves IGameStateService from VContainer at runtime
• Menu: GameTemplate/Unlock Conditions/Game State

BooleanConditionConfig — check a boolean flag in save data

• Fields: string Key, bool ExpectedValue
• Resolves ISaveService from VContainer at runtime
• Menu: GameTemplate/Unlock Conditions/Boolean Flag

ComparisonOperator enum: GreaterThan, LessThan, EqualTo, GreaterOrEqual, LessOrEqual

Composite Conditions

AndConditionConfig — ALL child conditions must be met

• Field: List<UnlockConditionConfig> Conditions
• Progress: average of children
• Dynamic asset naming from child composition

OrConditionConfig — ANY child condition must be met

• Field: List<UnlockConditionConfig> Conditions
• Progress: max of children

NotConditionConfig — inverts a single child condition

• Field: UnlockConditionConfig Condition
• Progress: 1 - child progress

Service Layer

IUnlockConditionService (Service/IUnlockConditionService.cs):

• void Register(string id, UnlockConditionConfig condition) — track a condition
• void Unregister(string id) — stop tracking
• bool IsUnlocked(string id) — cached evaluation result
• ReadOnlyReactiveProperty<bool> ObserveUnlocked(string id) — reactive unlock state
• float GetProgress(string id) — current progress 0.0-1.0
• void EvaluateAll() — force re-evaluation, fires events on state changes
• IReadOnlyList<string> GetAllIds() — all registered condition IDs
• IReadOnlyList<string> GetUnlockedIds() — currently unlocked IDs
• IReadOnlyList<string> GetLockedIds() — currently locked IDs
• bool IsRegistered(string id) — check if condition is tracked

Events (MessagePipe):

• ConditionUnlockedEvent { string ConditionId, UnlockConditionConfig Config } — fired when condition becomes met
• ConditionLockedEvent { string ConditionId, UnlockConditionConfig Config } — fired when condition becomes unmet

Installer: UnlockConditionInstaller.Install(builder, options) — registered in ProjectLifetimeScope

Usage Patterns

Direct Condition Check

[SerializeField] private UnlockConditionConfig _unlockCondition;
private readonly IObjectResolver _resolver;

public bool IsFeatureUnlocked() => _unlockCondition.IsMet(_resolver);
public float UnlockProgress() => _unlockCondition.GetProgress(_resolver);

Service-Based Tracking

private readonly IUnlockConditionService _unlockService;

// Register conditions at startup
_unlockService.Register("shop_tier2", shopTier2Condition);
_unlockService.Register("prestige_shop", prestigeShopCondition);

// Check state
bool isUnlocked = _unlockService.IsUnlocked("shop_tier2");
float progress = _unlockService.GetProgress("shop_tier2");

// React to changes
_unlockService.ObserveUnlocked("shop_tier2").Subscribe(unlocked => { ... });

// Periodic evaluation (call from game loop)
_unlockService.EvaluateAll();

Listening to Unlock Events

private readonly ISubscriber<ConditionUnlockedEvent> _onUnlocked;

_onUnlocked.Subscribe(e =>
{
    Debug.Log($"Unlocked: {e.ConditionId}");
}).AddTo(_disposables);

Creating Custom Conditions

[CreateAssetMenu(menuName = "GameTemplate/Unlock Conditions/Custom")]
public sealed class CustomConditionConfig : UnlockConditionConfig
{
    [SerializeField] private int _requiredLevel;

    public override bool IsMet(IObjectResolver resolver)
    {
        IMyService service = resolver.Resolve<IMyService>();
        return service.Level >= _requiredLevel;
    }

    public override string GetEditorDescription() => $"Level >= {_requiredLevel}";

    public override float GetProgress(IObjectResolver resolver)
    {
        IMyService service = resolver.Resolve<IMyService>();
        return Mathf.Clamp01((float)service.Level / _requiredLevel);
    }
}

Composing Conditions

AndCondition (all must be true)
+-- CurrencyThreshold: Gold >= 1000
+-- StatRequirement: TotalKills >= 50
+-- NotCondition (inverts child)
|   +-- GameState = GameOver
+-- OrCondition (any must be true)
    +-- UpgradeLevel: Factory Lv >= 5
    +-- PrestigeCount >= 2
    +-- BooleanFlag: premium_user = True