Interface IUnlockable
Marks an IEntity as an IUnlockable so that the entity can be disabled during some in-game functions, such as a ICurrency that cannot be granted until it is Available or forcefully Obtained through a tutorial.
Namespace: IdleKit.Gameplay
Assembly: cs.temp.dll.dll
Syntax
public interface IUnlockableExamples
See ICurrency.
Properties
Available
Returns whether the entity can be granted to the player or not. This is used to gate entity so they do not appear in any IReward.
Declaration
bool Available { get; }Property Value
| Type | Description |
|---|---|
| Boolean |
Obtained
Returns whether the entity has ever been acquired by the player.
Declaration
bool Obtained { get; }Property Value
| Type | Description |
|---|---|
| Boolean |
Examples
A ICurrency would be Obtained once Add(Double) or Set(Double) is called.
UnlockableSavedData
Returns the IUnlockableSavedData associated with this IUnlockable.
Declaration
IUnlockableSavedData UnlockableSavedData { get; }Property Value
| Type | Description |
|---|---|
| IUnlockableSavedData |
Methods
SetAvailability(Boolean)
Sets the Available flag of the IUnlockable.
Declaration
void SetAvailability(bool isAvailable)Parameters
| Type | Name | Description |
|---|---|---|
| Boolean | isAvailable |
SetObtained(Boolean)
Sets the Obtained flag of the IUnlockable.
Declaration
void SetObtained(bool isObtained)Parameters
| Type | Name | Description |
|---|---|---|
| Boolean | isObtained |