Interface IUpgradeRequirement

Defines a cost required to upgrade an IUpgradeable Entity such as a ICurrency or IUpgradeableCurrency

Namespace: IdleKit.Gameplay

Assembly: cs.temp.dll.dll

Syntax

public interface IUpgradeRequirement

Properties

RequiredAmount

The amount that is required for the upgrade to be performed

Declaration

double RequiredAmount { get; }

Property Value

Type	Description
Double

RequirementId

The id of the IUpgradeable Entity associated with the IUpgradeRequirement

Declaration

string RequirementId { get; }

Property Value

Type	Description
String

Methods

CanUpgrade(Double)

Returns true if the player has enough resources to meet these requirements

Declaration

bool CanUpgrade(double playerCurrencyAmount)

Parameters

Type	Name	Description
Double	playerCurrencyAmount

Returns

Type	Description
Boolean

GetUpgradeProgression(Double)

Returns the current progression towards being able to afford the requirement as a normalized value (0 - 1)

Declaration

float GetUpgradeProgression(double playerCurrencyAmount)

Parameters

Type	Name	Description
Double	playerCurrencyAmount

Returns

Type	Description
Single