scene

Documentation

Index

• Constants
• Variables
• func Face(size int) font.Face
• func IsEnterJustPressed() bool
• func IsEscapeJustPressed() bool
• func NewBackgroundBrightnessKeyHandler(cfg *Config, asset *Asset) func() bool
• func NewBackgroundDrawer(cfg *Config, asset *Asset, fsys fs.FS, name string) func(draws.Image)
• func NewDebugPrintKeyHandler(cfg *Config, asset *Asset) func() bool
• func NewModeKeyHandler(cfg *Config, asset *Asset) func() bool
• func NewMusicOffsetKeyHandler(cfg *Config, asset *Asset) func() bool
• func NewMusicVolumeKeyHandler(cfg *Config, asset *Asset) func() bool
• func NewSoundVolumeKeyHandler(cfg *Config, asset *Asset) func() bool
• func NewSpeedScaleKeyHandler(cfg *Config, asset *Asset, _mode int) func() bool
• func NewSubModeKeyHandler(cfg *Config, asset *Asset) func() bool
• func SetTPS(tps float64)
• type Asset
  • func NewAsset(cfg *Config, fsys fs.FS) *Asset
• type Config
  • func NewConfig() *Config
  • func (cfg Config) ChartTreeNodeCount() int
  • func (cfg Config) DebugString() string
  • func (c *Config) NormalizeMusicRoots()
• type PlayArgs
• type Scene

Constants

const (
	CursorBase = iota
	CursorAdditive
	CursorTrail
)

Variables

var Faces = make(map[int]font.Face)

var LeftRightKeys = [2]input.Key{input.KeyArrowLeft, input.KeyArrowRight}

var UpDownKeys = [2]input.Key{input.KeyArrowUp, input.KeyArrowDown}

Functions

func Face

func Face(size int) font.Face

func IsEnterJustPressed

func IsEnterJustPressed() bool

func IsEscapeJustPressed

func IsEscapeJustPressed() bool

func NewBackgroundBrightnessKeyHandler

func NewBackgroundBrightnessKeyHandler(cfg *Config, asset *Asset) func() bool

func NewBackgroundDrawer

func NewBackgroundDrawer(cfg *Config, asset *Asset, fsys fs.FS, name string) func(draws.Image)

asset.go: functions that load assets from fs.FS. draw.go: functions that draw.

func NewDebugPrintKeyHandler

func NewDebugPrintKeyHandler(cfg *Config, asset *Asset) func() bool

func NewModeKeyHandler

func NewModeKeyHandler(cfg *Config, asset *Asset) func() bool

func NewMusicOffsetKeyHandler

func NewMusicOffsetKeyHandler(cfg *Config, asset *Asset) func() bool

func NewMusicVolumeKeyHandler

func NewMusicVolumeKeyHandler(cfg *Config, asset *Asset) func() bool

func NewSoundVolumeKeyHandler

func NewSoundVolumeKeyHandler(cfg *Config, asset *Asset) func() bool

func NewSpeedScaleKeyHandler

func NewSpeedScaleKeyHandler(cfg *Config, asset *Asset, _mode int) func() bool

func NewSubModeKeyHandler

func NewSubModeKeyHandler(cfg *Config, asset *Asset) func() bool

func SetTPS

func SetTPS(tps float64)

Types

type Asset

type Asset struct {
	CursorSprites           [3]draws.Sprite
	DefaultBackgroundSprite draws.Sprite
	BoxMaskSprite           draws.Sprite
	ClearSprite             draws.Sprite
	IntroSprite             draws.Sprite
	LoadingSprite           draws.Sprite
	SearchBoxSprite         draws.Sprite

	EnterSound       audios.SoundPlayer
	SwipeSoundPod    audios.SoundPlayer
	TapSoundPod      audios.SoundPlayer
	ToggleSounds     [2]audios.SoundPlayer
	TransitionSounds [2]audios.SoundPlayer

	// Each key count has different asset in piano mode.
	PianoAssets map[int]*piano.Asset
}

Asset is previously known as Skin.

func NewAsset

func NewAsset(cfg *Config, fsys fs.FS) *Asset

type Config

type Config struct {
	MusicRoots []string
	ScreenSize draws.Vector2

	MusicVolume          float64
	SoundVolume          float64
	MusicOffset          int32
	BackgroundBrightness float64
	DebugPrint           bool
	Replay               bool

	CursorSpriteScale   float64
	ChartTreeNodeWidth  float64
	ChartTreeNodeHeight float64
	ChartTreeNodeShrink float64 // Nodes are not focused will be shrinked.
	SearchBoxWidth      float64
	SearchBoxHeight     float64
	ClearSpriteScale    float64

	Mode        int
	SubMode     int
	PianoConfig *piano.Config
}

scene.Config and scene.Asset contains all the configuration and assets that are used in the game. They are passed to other scenes. There should not be any additional configuration or assets in other scenes.

func NewConfig

func NewConfig() *Config

func (Config) ChartTreeNodeCount

func (cfg Config) ChartTreeNodeCount() int

func (Config) DebugString

func (cfg Config) DebugString() string

func (*Config) NormalizeMusicRoots

func (c *Config) NormalizeMusicRoots()

type PlayArgs

type PlayArgs struct {
	MusicFS       fs.FS
	ChartFilename string
	Replay        *osr.Format
}

type Scene

type Scene interface {
	Update() any
	Draw(screen draws.Image)
}