probe

package

v0.16.9 Latest Latest Go to latest Published: Sep 24, 2026 License: LGPL-3.0 Imports: 1 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/argus-labs/world-engine

Links

Open Source Insights

Documentation ¶

Overview ¶

Package probe holds the ECS components this test game adds on top of the physics2d plugin's own Transform2D / Velocity2D / PhysicsBody2D.

Index ¶

type Probe

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Probe ¶

type Probe struct {
	Scenario string `json:"scenario"`
	Label    string `json:"label"`
}

Probe tags every entity the test harness spawns. Scenario is the owning scenario's name and Label identifies the body inside that scenario, so failure messages can name the exact body that misbehaved instead of a bare entity ID.

Wire methods are hand-written rather than generated: this project intentionally does not run `world sdk generate`, so nothing here depends on Docker/protoc.

func (Probe) AppendWire ¶ added in v0.16.9

func (p Probe) AppendWire(b []byte) []byte

func (Probe) MarshalWire ¶

func (p Probe) MarshalWire() []byte

MarshalWire encodes the probe for snapshots and debug introspection. It panics on a marshal error, the same contract as the generated wire code.

func (Probe) Name ¶

func (Probe) Name() string

Name returns the ECS component name.

func (Probe) SizeWire ¶ added in v0.16.9

func (p Probe) SizeWire() int

SizeWire and AppendWire are the snapshot's encoding path (see ecs.Component). Generated components compute a size without encoding; this one has to encode to know, so both go through MarshalWire. That costs an allocation per row per snapshot, which is the right trade for a test fixture that exists to avoid a protoc dependency — the bytes still match MarshalWire exactly, which is the whole contract.

func (Probe) UnmarshalWire ¶

func (Probe) UnmarshalWire(b []byte) (any, error)

UnmarshalWire decodes a probe produced by MarshalWire.

Source Files ¶

View all Source files

probe.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL