S9SourceNine Labs / CMAPI Docs 1.0
CMAPI / API reference

IUnlockManager

Provides read-only content unlock rules and live state.

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

Provides read-only content unlock rules and live state.

Members

AllUnlocksGets unlock information for every loaded game group.propertyTryGetUnlockFinds unlock information by exact game group ID.methodFindUnlocksFinds entries whose ID or localized name contains text.method

AllUnlocks

property
IReadOnlyList<IUnlockDefinition> AllUnlocks

Gets unlock information for every loaded game group.

TryGetUnlock

method
bool TryGetUnlock(string id, out IUnlockDefinition? unlock)

Finds unlock information by exact game group ID.

FindUnlocks

method
IReadOnlyList<IUnlockDefinition> FindUnlocks(string search)

Finds entries whose ID or localized name contains text.