S9SourceNine Labs / CMAPI Docs 1.0
CMAPI / API reference

IModHelper

Provides the CMAPI services available to one mod.

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

Provides the CMAPI services available to one mod.

Members

MonitorGets the logger whose source name is the current mod.propertyStorageGets paths and JSON storage isolated to the current mod.propertySchedulerGets main-thread and delayed scheduling scoped to the current mod.propertyModRegistryGets loaded-mod and runtime-feature discovery.propertyEventsGets the events to which the current mod can subscribe.propertyPlayersGets read-only information about players in the current session.propertyPlayerPlacementGets host-safe, same-planet local-player placement.propertyItemsGets item discovery and host-safe backpack actions.propertyRecipesGets read-only recipes and their crafting requirements.propertyUnlocksGets read-only content unlock rules and live state.propertyPlayerInventoryGets read-only local backpack/equipment snapshots and events.propertyTerraTokensGets the shared Terra Token balance and host-safe additions.propertyWeatherGets current-planet weather discovery and host-safe starts.propertyWorldStateGets read-only terraformation values, rates, and stages.propertyEnvironmentGets day/night, water queries, and host-safe environment actions.propertyPlanetsGets current and installed planet definitions.propertyNotificationsGets the native in-game HUD notification service.propertyConsoleCommandsGets the console-command registry scoped to the current mod.property

Monitor

property
IMonitor Monitor

Gets the logger whose source name is the current mod.

Storage

property
IModStorage Storage

Gets paths and JSON storage isolated to the current mod.

Scheduler

property
IModScheduler Scheduler

Gets main-thread and delayed scheduling scoped to the current mod.

ModRegistry

property
IModRegistry ModRegistry

Gets loaded-mod and runtime-feature discovery.

Events

property
IModEvents Events

Gets the events to which the current mod can subscribe.

Players

property
IPlayerManager Players

Gets read-only information about players in the current session.

PlayerPlacement

property
IPlayerPlacementManager PlayerPlacement

Gets host-safe, same-planet local-player placement.

Items

property
IItemManager Items

Gets item discovery and host-safe backpack actions.

Recipes

property
IRecipeManager Recipes

Gets read-only recipes and their crafting requirements.

Unlocks

property
IUnlockManager Unlocks

Gets read-only content unlock rules and live state.

PlayerInventory

property
IPlayerInventoryManager PlayerInventory

Gets read-only local backpack/equipment snapshots and events.

TerraTokens

property
ITerraTokenManager TerraTokens

Gets the shared Terra Token balance and host-safe additions.

Weather

property
IWeatherManager Weather

Gets current-planet weather discovery and host-safe starts.

WorldState

property
IWorldStateManager WorldState

Gets read-only terraformation values, rates, and stages.

Environment

property
IEnvironmentManager Environment

Gets day/night, water queries, and host-safe environment actions.

Planets

property
IPlanetManager Planets

Gets current and installed planet definitions.

Notifications

property
INotificationManager Notifications

Gets the native in-game HUD notification service.

ConsoleCommands

property
IConsoleCommandManager ConsoleCommands

Gets the console-command registry scoped to the current mod.