pidebug

Documentation

Overview

Package pidebug provides an API for pausing the game for debugging purposes. It is essential for building developer tools.

Index

• func Paused() bool
• func SetPaused(p bool) bool
• func Target() pievent.Target[Event]
• type Event

Functions

func Paused

func Paused() bool

func SetPaused

func SetPaused(p bool) bool

SetPaused pauses or resumes the game.

The game does not pause immediately, but only at the end of the current game loop iteration.

When the game is paused, most targets stop processing events (for example, piloop.Target or pikey.Target). Developer tools should use their debug-mode equivalents instead, such as piloop.DebugTarget or pikey.DebugTarget.

func Target

func Target() pievent.Target[Event]

Types

type Event

type Event string

const (
	EventPause  Event = "pause"
	EventResume Event = "resume"
)