S9SourceNine Labs / CMAPI Docs 1.0
CMAPI / API reference

IWorldEvents

Provides loaded-world, planet, save, and weather lifecycle events.

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

Provides loaded-world, planet, save, and weather lifecycle events.

Members

WorldEnteredRaised once a local player and planet are both ready.eventWorldExitedRaised when the current local world session ends.eventPlanetChangedRaised after travel finishes loading a different planet.eventSavedRaised after Planet Crafter confirms a save completed.eventWeatherStartedRaised when an active synchronized weather event is observed.eventWeatherEndedRaised when the previously observed synchronized weather event ends, changes, or is left during world/planet teardown.event

WorldEntered

event
event Action<WorldContext> WorldEntered

Raised once a local player and planet are both ready.

WorldExited

event
event Action<WorldContext> WorldExited

Raised when the current local world session ends.

PlanetChanged

event
event Action<PlanetChangedEvent> PlanetChanged

Raised after travel finishes loading a different planet.

Saved

event
event Action<WorldContext> Saved

Raised after Planet Crafter confirms a save completed.

WeatherStarted

event
event Action<WeatherSnapshot> WeatherStarted

Raised when an active synchronized weather event is observed.

WeatherEnded

event
event Action<WeatherSnapshot> WeatherEnded

Raised when the previously observed synchronized weather event ends, changes, or is left during world/planet teardown.