S9SourceNine Labs / CMAPI Docs 1.0
CMAPI / API reference

ITerraTokenManager

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

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

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

Members

IsAvailableGets whether the Terra Token system is available in the current scene.propertyCountGets the current shared Terra Token balance, or zero when unavailable.propertyAddAsyncAdds shared Terra Tokens to the current host world through the game's server RPC.method

IsAvailable

property
bool IsAvailable

Gets whether the Terra Token system is available in the current scene.

Count

property
int Count

Gets the current shared Terra Token balance, or zero when unavailable.

AddAsync

method
Task<GameplayActionResult> AddAsync(int amount)

Adds shared Terra Tokens to the current host world through the game's server RPC.

Terra Tokens belong to the world, not one player's private wallet. This request is host-only, checks overflow, runs on the main thread, and shows the game's native Terra Token popup when accepted.