Gopher2600/emulation/doc.go
JetSetIlly 7629caf89d corrected how rewind package detects frames that don't exist yet
clarfied that the use of the Emulation type is for passive monitoring of
the underlying emulation. rewind package now monitors the emulation
passively.
2021-10-26 09:01:42 +01:00

26 lines
1.2 KiB
Go

// This file is part of Gopher2600.
//
// Gopher2600 is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Gopher2600 is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Gopher2600. If not, see <https://www.gnu.org/licenses/>.
// Package emulation is an abstraction of the various modes Gopher2600 can
// operate in, principally play-mode and the debugger.
//
// It is useful when linking packages/types that require a *passive* knowledge
// of the emulation. For example, a GUI might want to know what the current
// state of the emulation is.
//
// Some package types might still need an active knowledge of the emulation
// however. In which case, simply relying on the Emulation interface is
// probably not enough.
package emulation