API wiki overview
Every hand-written header of the public SDK, with its comments, plus the build layout and short recipes.
The API wiki lists every hand-written header of the public repository. The comments in a header say what is proven and what is not. Every call that talks to the game fails closed: it returns false or nullptr when the game does not match.
- SDK layout and build system
- Recipes: seven complete patterns
- Generated tables
Headers#
| Header | What it gives |
|---|---|
audio.hpp | OpenAL by name, the audio engine, a hook on playing a sound. |
camera.hpp | The editor camera and the view camera of a world. |
console.hpp | The console window and the log file. |
discord.hpp | Discord Rich Presence through the local pipe. |
events.hpp | Game events by name. |
flags.hpp | Flag designs and new flags in the atlas. |
game.hpp | Every game function by name. |
game_state.hpp | Application states (menu, game, editors) and their changes. |
hook.hpp | The hook mechanics: install, replace, remove, plan, arguments of the hooked function. |
input.hpp | Key, char and mouse callbacks, key names and key actions. |
instances.hpp | Live objects of a class (track, list, count). |
mapicons.hpp | The map icon slots and new marker types. |
mesh.hpp | Read, change and write .mesh files. |
mod.hpp | The skeleton of a mod: SW_MOD, sw_mod_start / sw_mod_stop, log, sleep, running, rt(). |
network.hpp | The network messages and internal queues by name and id. |
obj.hpp | Checked handles to living objects. |
overlay.hpp | Physical overlay of mod folders with restore. |
physics.hpp | The Bullet world: gravity, solver iterations, step time. |
render.hpp | Frame end, OpenGL entry points, shaders, uniforms, render targets, the deferred pipeline. |
runtime.hpp | The connection to the game: checks, reading and writing memory, hooks by name, classes and vtables. |
settings.hpp | The game settings. |
signature.hpp | Byte signatures and the check of the game build. |
start_tiles.hpp | Your own start card (base) in the menu. |
textures.hpp | Read, change and write .txtr files. |
tiles.hpp | The tile system: definitions, cells, queueing, events. |
trees.hpp | The kind of tree per tile or chunk. |
ui.hpp | Text and buttons in the main menu by name. |
vehicle.hpp | Spawned vehicles and their components (read only). |
vfs.hpp | Virtual file system: mod folders appear in rom without writing anything. |
views.hpp | Named fields of game objects. |
weather.hpp | Weather, wind, time of day and the wave event. |
world.hpp | Islands and ocean. |
sw/api.hpp includes the friendly headers; each header is also self-contained.