Class ReviewCapture

Namespace

Valheim.Testing.GameSessions

Assembly

Valheim.Testing.GameSessions.dll

Makes a reproducible still view with a protected, arrived player. It restores the client's exact starting safety, weather, debug time, mist and camera mode on success or failure. A failed restore fails the capture even if a complete PNG was written. The default ValheimCLI plugin also restores on unload when the client is still alive.

public static class ReviewCapture

Inheritance

object

ReviewCapture

Methods

Capture(GameActor, GameActor, IGameHost, ReviewCapturePlan, TimeSpan, TimeSpan, CancellationToken)

Capture from a joined client, fetching only this run's image directory from its owned host. Synchronous like the arrival and commands it issues, so it runs directly inside a ClientRound.Step; it waits for the host fetch.

public static ReviewCaptureReceipt Capture(GameActor server, GameActor client, IGameHost clientHost, ReviewCapturePlan plan, TimeSpan arrivalTimeout, TimeSpan fetchTimeout, CancellationToken cancellation = default)

Parameters

server GameActor

client GameActor

clientHost IGameHost

plan ReviewCapturePlan

arrivalTimeout TimeSpan

fetchTimeout TimeSpan

cancellation CancellationToken

Returns

ReviewCaptureReceipt

Validate(ReviewCapturePlan, HostShellKind)

The one rule for a capture plan: id, weather, time, camera distance, height, azimuth, supersize, host and evidence directories and provenance. Capture(GameActor, GameActor, IGameHost, ReviewCapturePlan, TimeSpan, TimeSpan, CancellationToken) applies it first; call it to refuse a plan before launch.

public static void Validate(ReviewCapturePlan plan, HostShellKind shell)

Parameters

plan ReviewCapturePlan

shell HostShellKind