sim

Documentation

Overview

The sim package defines the life cycle and interaction protocol used to interact with a game world simulation.

Index

• type HaltedSimulation
• type RunningSimulation
• type UnstartedSimulation

Types

type HaltedSimulation

type HaltedSimulation interface {
}

A simulation that has been halted.

type RunningSimulation

type RunningSimulation interface {
	// A Running simulation can be halted
	Halt() (HaltedSimulation, error)
}

A simulation that is currently simulating a world.

type UnstartedSimulation

type UnstartedSimulation interface {
	Begin() (RunningSimulation, error)
}

A simulation that is prepared to begin simulating a world.