S9SourceNine Labs / CMAPI Docs 1.0
CMAPI / API reference

CMAPIFeatures

Stable feature identifiers exposed by IModRegistry .

View source ↗
CMAPI 1.0.0Standalone runtimeWindows x64Tested with Planet Crafter 2.008
Namespace CMAPIClassAssembly CMAPI.API.dll
public static class CMAPIFeatures

Stable feature identifiers exposed by IModRegistry.

Members

StandaloneRuntimeCMAPI owns the Planet Crafter bootstrap and runtime lifecycle.fieldModStoragePer-mod typed configuration and private JSON data are available.fieldModSchedulingOwner-scoped main-thread and delayed scheduling are available.fieldGameLoopEventsOwner-scoped update and one-second events are available.fieldPlayerApiThe current game build passed CMAPI player API checks.fieldEnvironmentApiThe current game build passed environment API checks.fieldContentApiThe current game build passed content API checks.fieldTrainerThe optional trainer is compatible with this game build.fieldModMenuBetaThe separately versioned experimental Mod Menu is available.field

StandaloneRuntime

field
public const string StandaloneRuntime = "CMAPI.StandaloneRuntime"

CMAPI owns the Planet Crafter bootstrap and runtime lifecycle.

ModStorage

field
public const string ModStorage = "CMAPI.ModStorage"

Per-mod typed configuration and private JSON data are available.

ModScheduling

field
public const string ModScheduling = "CMAPI.ModScheduling"

Owner-scoped main-thread and delayed scheduling are available.

GameLoopEvents

field
public const string GameLoopEvents = "CMAPI.GameLoopEvents"

Owner-scoped update and one-second events are available.

PlayerApi

field
public const string PlayerApi = "CMAPI.PlayerApi"

The current game build passed CMAPI player API checks.

EnvironmentApi

field
public const string EnvironmentApi = "CMAPI.EnvironmentApi"

The current game build passed environment API checks.

ContentApi

field
public const string ContentApi = "CMAPI.ContentApi"

The current game build passed content API checks.

Trainer

field
public const string Trainer = "CMAPI.Trainer"

The optional trainer is compatible with this game build.

ModMenuBeta

field
public const string ModMenuBeta = "CMAPI.ModMenuBeta"

The separately versioned experimental Mod Menu is available.