audio

Documentation

Overview

Package audio handles music and sound effects for Spy Cards Online.

Index

• Variables
• func StopMusic()
• func UnsuspendContext()
• type Sound
  • func (s *Sound) PlayMusic(delay float64, restart bool)
  • func (s *Sound) PlaySound(delay, overridePitch, overrideVolume float64)
  • func (s *Sound) Preload() error

Variables

var (
	// SoundsVolume is the user-set volume (0..1) of sound effects.
	SoundsVolume float64 = 0.6
	// MusicVolume is the user-set volume (0..1) of music.
	MusicVolume float64 = 0.6

	// IgnoreAudio causes calls to audio functions to be ignored
	// if it is nonzero.
	IgnoreAudio uint64
)

var (
	AtkFail = &Sound{
		Name: "AtkFail",
	}
	AtkSuccess = &Sound{
		Name: "AtkSuccess",
	}
	BattleStart0 = &Sound{
		Name: "BattleStart0",
	}
	Buzzer = &Sound{
		Name: "Buzzer",
	}
	CardSound2 = &Sound{
		Name:   "CardSound2",
		Pitch:  1.2,
		Volume: 0.5,
	}
	Charge = &Sound{
		Name: "Charge",
	}
	Coin = &Sound{
		Name: "Coin",
	}
	Confirm = &Sound{
		Name: "Confirm",
	}
	Confirm1 = &Sound{
		Name:   "Confirm1",
		Pitch:  0.4,
		Volume: 0.5,
	}
	CrowdCheer2 = &Sound{
		Name:  "CrowdCheer2",
		Pitch: 1.2,
	}
	CrowdClap = &Sound{
		Name: "CrowdClap",
	}
	CrowdGasp = &Sound{
		Name: "CrowdGasp",
	}
	CrowdGaspSlow = &Sound{
		Name:  "CrowdGasp",
		Pitch: 0.75,
	}
	Damage0 = &Sound{
		Name: "Damage0",
	}
	Death3 = &Sound{
		Name: "Death3",
	}
	Fail = &Sound{
		Name: "Fail",
	}
	Heal = &Sound{
		Name: "Heal",
	}
	Lazer = &Sound{
		Name: "Lazer",
	}
	PageFlip = &Sound{
		Name: "PageFlip",
	}
	PageFlipCancel = &Sound{
		Name:  "PageFlip",
		Pitch: 0.7,
	}
	Toss11 = &Sound{
		Name: "Toss11",
	}
	FBCountdown = &Sound{
		Name: "FBCountdown",
	}
	FBDeath = &Sound{
		Name: "FBDeath",
	}
	FBFlower = &Sound{
		Name: "FBFlower",
	}
	FBGameOver = &Sound{
		Name: "FBGameOver",
	}
	FBPoint = &Sound{
		Name: "FBPoint",
	}
	FBStart = &Sound{
		Name: "FBStart",
	}
	MiteKnightIntro = &Sound{
		Name: "MiteKnightIntro",
	}
	MKDeath = &Sound{
		Name: "MKDeath",
	}
	MKGameOver = &Sound{
		Name: "MKGameOver",
	}
	MKHit = &Sound{
		Name: "MKHit",
	}
	MKHit2 = &Sound{
		Name: "MKHit2",
	}
	MKKey = &Sound{
		Name: "MKKey",
	}
	MKOpen = &Sound{
		Name: "MKOpen",
	}
	MKPotion = &Sound{
		Name: "MKPotion",
	}
	MKShield = &Sound{
		Name: "MKShield",
	}
	MKStairs = &Sound{
		Name: "MKStairs",
	}
	MKWalk = &Sound{
		Name: "MKWalk",
	}
	PeacockSpiderNPCSummonSuccess = &Sound{
		Name: "PeacockSpiderNPCSummonSuccess",
	}
	Shot2 = &Sound{
		Name: "Shot2",
	}
)

Sound effects.

var (
	Miniboss = &Sound{
		Name:  "Miniboss",
		Loop:  true,
		Start: 20.55,
		End:   87,
	}
	Bounty = &Sound{
		Name:  "Bounty",
		Loop:  true,
		Start: 6.7,
		End:   52.5,
	}
	Inside2 = &Sound{
		Name:  "Inside2",
		Loop:  true,
		Start: 10.3,
		End:   72,
	}
	FlyingBee = &Sound{
		Name:  "FlyingBee",
		Loop:  true,
		Start: 999,
		End:   999,
	}
	MiteKnight = &Sound{
		Name:  "MiteKnight",
		Loop:  true,
		Start: 999,
		End:   999,
	}
	TermiteLoop = &Sound{
		Name:  "TermiteLoop",
		Loop:  true,
		Start: 999,
		End:   999,
	}
)

Music tracks.

Functions

func StopMusic

func StopMusic()

StopMusic stops the current music track.

func UnsuspendContext

func UnsuspendContext()

Types

type Sound

type Sound struct {
	Name   string
	Pitch  float64
	Volume float64

	Loop  bool
	Start float64
	End   float64
	// contains filtered or unexported fields
}

Sound is an audio clip.

func (*Sound) PlayMusic

func (s *Sound) PlayMusic(delay float64, restart bool)

PlayMusic plays a sound as the current music track.

func (*Sound) PlaySound

func (s *Sound) PlaySound(delay, overridePitch, overrideVolume float64)

PlaySound plays a sound, optionally modifying its pitch and volume.

func (*Sound) Preload

func (s *Sound) Preload() error

Preload loads the Sound and returns the error encountered, if any.