API Reference¶
Complete API documentation for the Lands.io Mod SDK.
Auto-Generated
This documentation is automatically generated from TypeScript source code using TypeDoc.
Core Classes¶
| Class | Description |
|---|---|
Mod |
Base class for all mods - extend this |
BaseAction |
Base class for custom player actions |
NoOpExecution |
No-operation execution |
ModActionButton |
Base class for UI buttons |
SchedulerJob |
Base class for scheduled background tasks |
DefaultConfig |
Default game configuration implementation |
Key Interfaces¶
| Interface | Description |
|---|---|
Config |
Game configuration - implement Partial<Config> to override |
Game |
Game state and methods |
Player |
Player state and methods |
Executor |
Action and intent registration |
ModState |
In-game state management |
IModStorage |
Persistent cross-game storage |
Execution |
Base interface for executions |
Action System¶
| Interface | Description |
|---|---|
Action |
Action interface |
ActionContext |
Context passed to action methods |
ActionTarget |
Action target type |
ActionHooksRegistry |
Registry for action hooks |
UI System¶
| Interface | Description |
|---|---|
ModButtonContext |
Context for UI button methods |
ModIntent |
Intent from UI actions |
Game Entities¶
| Interface | Description |
|---|---|
TerraNullius |
Unclaimed territory |
Unit |
Game unit |
Alliance |
Alliance between players |
Attack |
Attack state |
GameMap |
Game map |
Configuration¶
| Interface | Description |
|---|---|
GameConfig |
Game configuration |
PlayerInfo |
Player information |
UnitInfo |
Unit information |
Scheduler¶
| Interface | Description |
|---|---|
SchedulerJobContext |
Context for scheduler jobs |
Enums¶
| Enum | Values |
|---|---|
PlayerType |
Human, Bot, FakeHuman |
Difficulty |
Easy, Medium, Hard, Impossible |
GameType |
Singleplayer, Multiplayer |
GamePhase |
Game phases |
UnitType |
Unit types |
TerrainType |
Terrain types |
Relation |
Player relations |
MessageType |
Message types |