punkfuncgames/formula-module

FormulaModule Reference

Package: com.punkfuncgames.formula | Define: PUNKFUNC_FORMULA Location: Packages/com.punkfuncgames.formula/Runtime/PunkFuncGames.Formula/ Namespace: PunkFuncGames.Formula

FormulaBaseConfig (abstract ScriptableObject)

• abstract BigDouble Calculate(BigDouble level) — compute value at level
• abstract string GetDescription() — human-readable formula description
• abstract string GetFormulaType() — type name
• Editor: test level input with auto-updating result preview

Built-in Formulas

SimplePolynomialConfig

Formula: Base + (Level * Multiplier) or Base + (Level ^ Multiplier) if UseLevelAsExponent

Fields:

• SerializableBigDouble BaseValue
• SerializableBigDouble MultiplierValue
• bool UseLevelAsExponent

Use cases: Linear stat growth, simple level scaling

SimpleExponentialConfig

Formula: Base * (Multiplier ^ Level)

Fields:

• SerializableBigDouble Base
• double Multiplier
• bool CapAtMaxValue, SerializableBigDouble MaxValue

Returns Base for level <= 0. Respects optional cap.

Use cases: Standard idle game cost curves (e.g., cost = 10 * 1.15^level)

MilestoneExponentialConfig

Formula: Base * (DynamicMultiplier ^ Level) with soft cap

Dynamic multiplier increases at milestone intervals.

Fields:

• SerializableBigDouble BaseValue
• double BaseMultiplier — starting multiplier
• int MilestoneInterval — levels between milestones
• double MilestoneMultiplierBonus — bonus per milestone
• bool MultiplyInsteadOfAdd — multiply vs add milestone bonus
• bool EnableSoftCap, int SoftCapStartLevel, double SoftCapPower

Methods:

• double GetEffectiveMultiplier(BigDouble level) — multiplier at given level
• int GetMilestoneCount(BigDouble level) — number of milestones reached

Nested: MilestoneConfig(int level, double multiplierOverride, string description) for custom overrides

Use cases: Progressive difficulty curves, prestige cost scaling, milestone-based progression

Usage Pattern

// Create formulas as ScriptableObjects in editor, reference in code:
[SerializeField] private FormulaBaseConfig _upgradeCostFormula;
[SerializeField] private FormulaBaseConfig _upgradeEffectFormula;

// In IUpgradeDefinition implementation:
public sealed class MineUpgrade : IUpgradeDefinition
{
    private readonly FormulaBaseConfig _costFormula;
    private readonly FormulaBaseConfig _effectFormula;

    public string Id => "Mine";
    public string CurrencyId => "Gold";
    public int MaxLevel => 0;

    public MineUpgrade(FormulaBaseConfig costFormula, FormulaBaseConfig effectFormula)
    {
        _costFormula = costFormula;
        _effectFormula = effectFormula;
    }

    public BigDouble GetCost(int level) => _costFormula.Calculate(new BigDouble(level));
    public BigDouble GetEffect(int level) => _effectFormula.Calculate(new BigDouble(level));
    public bool IsUnlocked() => true;
}

Typical Formula Values

| Upgrade Type | Formula | Base | Multiplier | |-------------|---------|------|-----------| | Cheap clicker | SimpleExponential | 10 | 1.07 | | Standard generator | SimpleExponential | 100 | 1.15 | | Expensive unlock | SimpleExponential | 10000 | 1.5 | | Linear stat bonus | SimplePolynomial | 1 | 0.5 | | Prestige cost | MilestoneExponential | 1e6 | 1.2 (milestone every 10) |