API reference (preview)

This reference is generated from the current package sources. It is a candidate inventory of the public surface, not a promise that every listed type is supported in 1.0. The compatibility policy lists the decisions still open.

For a released 0.1 package, use its versioned API reference, built from the release tag. This page tracks current source and can be ahead of the packages on NuGet.org.

Find a package's types

Package Types Package page
Valheim.Testing Pure terrain types Valheim.Testing
Valheim.Testing.Doubles Toolkit doubles; the game-name stand-ins have no reviewed inventory yet Valheim.Testing.Doubles
Valheim.Testing.Cli No generated reference yet; built from the pinned ValheimCLI fork Valheim.Testing.Cli
Valheim.Testing.Game Native runner types; the namespace also holds the Valheim.Testing.GameSessions types Valheim.Testing.Game
Valheim.Testing.GameSessions Game sessions, the pinned runner and hosts Valheim.Testing.GameSessions
Valheim.Testing.NativeSmoke Command-line tool; no public library API Valheim.Testing.NativeSmoke
Valheim.Testing.Adapter Game-side helper types Valheim.Testing.Adapter
Valheim.Testing.Bindings Binding-check types Valheim.Testing.Bindings
Valheim.Testing.Bindings.Tool Console entry point; delegates to BindingCheckCommand Valheim.Testing.Bindings.Tool

Two gaps are deliberate. The source-included game-name doubles sit outside the namespace filter, and the Valheim.Testing.Cli transport is built from another repository. Its source and a transport guide at the pinned commit are in the ValheimCLI fork; the commit is in cli-dependency.json.

Pages with examples

Page Shows
CompositeTerrain Declaring synthetic terrain
WorldFixture Copying a pinned world
DisposableCharacterStore Registering a disposable character, from a game-created local save
GameActor Verifying pins and observing a game process
PinnedServerRun Owning the server lifecycle

An API page excerpts one call. For a complete scenario, follow the guides.

Edit this page