S9SourceNine Labs / CMAPI Docs 1.0
CMAPI / API reference

IUnlockDefinition

Describes the live unlock state and rules for one game group.

View source ↗
CMAPI 1.0.0Standalone runtimeWindows x64Tested with Planet Crafter 2.008
Namespace CMAPIInterfaceAssembly CMAPI.API.dll
public interface IUnlockDefinition

Describes the live unlock state and rules for one game group.

Members

Id

property
string Id

Gets the content's stable game group ID.

DisplayName

property
string DisplayName

Gets the content's localized display name.

Kind

property
ContentKind Kind

Gets the broad kind of content represented.

IsStateAvailable

property
bool IsStateAvailable

Gets whether live progression state was ready when this snapshot was created. Static requirements remain usable when this is false.

IsUnlocked

property
bool IsUnlocked

Gets whether the content is currently unlocked.

IsAvailableOnCurrentPlanet

property
bool IsAvailableOnCurrentPlanet

Gets whether the content can be used on the current planet.

IsGloballyUnlocked

property
bool IsGloballyUnlocked

Gets whether the save has globally unlocked this content.

IsBlueprintRequired

property
bool IsBlueprintRequired

Gets whether this content must be learned from a blueprint.

RequiredWorldUnit

property
WorldUnitKind? RequiredWorldUnit

Gets the progression measurement required, or null when no supported terraformation requirement is defined.

RequiredValue

property
double RequiredValue

Gets the required progression value.

PlanetIds

property
IReadOnlyList<string> PlanetIds

Gets planet IDs explicitly associated with this rule. An empty list means the game applies its default starting-planet behavior.