sound

package
v0.8.9 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 29, 2022 License: MIT Imports: 2 Imported by: 27

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AnvilBreak added in v0.7.3

type AnvilBreak struct {
	// contains filtered or unexported fields
}

AnvilBreak is played when an anvil is broken.

func (AnvilBreak) Play added in v0.7.3

func (AnvilBreak) Play(*world.World, mgl64.Vec3)

Play ...

type AnvilLand added in v0.7.3

type AnvilLand struct {
	// contains filtered or unexported fields
}

AnvilLand is played when an anvil lands on the ground.

func (AnvilLand) Play added in v0.7.3

func (AnvilLand) Play(*world.World, mgl64.Vec3)

Play ...

type AnvilUse added in v0.7.3

type AnvilUse struct {
	// contains filtered or unexported fields
}

AnvilUse is played when an anvil is used.

func (AnvilUse) Play added in v0.7.3

func (AnvilUse) Play(*world.World, mgl64.Vec3)

Play ...

type ArrowHit added in v0.6.0

type ArrowHit struct {
	// contains filtered or unexported fields
}

ArrowHit is a sound played when an arrow hits ground.

func (ArrowHit) Play added in v0.6.0

func (ArrowHit) Play(*world.World, mgl64.Vec3)

Play ...

type Attack

type Attack struct {
	// Damage specifies if the attack actually dealt damage to the other entity. If set to false, the sound
	// will be different from when set to true.
	Damage bool
	// contains filtered or unexported fields
}

Attack is a sound played when an entity, most notably a player, attacks another entity.

func (Attack) Play

func (Attack) Play(*world.World, mgl64.Vec3)

Play ...

type BarrelClose added in v0.1.0

type BarrelClose struct {
	// contains filtered or unexported fields
}

BarrelClose is played when a barrel is closed.

func (BarrelClose) Play added in v0.1.0

func (BarrelClose) Play(*world.World, mgl64.Vec3)

Play ...

type BarrelOpen added in v0.1.0

type BarrelOpen struct {
	// contains filtered or unexported fields
}

BarrelOpen is played when a barrel is opened.

func (BarrelOpen) Play added in v0.1.0

func (BarrelOpen) Play(*world.World, mgl64.Vec3)

Play ...

type BlastFurnaceCrackle added in v0.8.0

type BlastFurnaceCrackle struct {
	// contains filtered or unexported fields
}

BlastFurnaceCrackle is a sound played every one to five seconds from a blast furnace.

func (BlastFurnaceCrackle) Play added in v0.8.0

func (BlastFurnaceCrackle) Play(*world.World, mgl64.Vec3)

Play ...

type BlockBreaking

type BlockBreaking struct {
	// Block is the block which is being broken, for which a sound should be played. The sound played depends
	// on the block type.
	Block world.Block
	// contains filtered or unexported fields
}

BlockBreaking is a sound sent continuously while a player is breaking a block.

func (BlockBreaking) Play

func (BlockBreaking) Play(*world.World, mgl64.Vec3)

Play ...

type BlockPlace

type BlockPlace struct {
	// Block is the block which is placed, for which a sound should be played. The sound played depends on
	// the block type.
	Block world.Block
	// contains filtered or unexported fields
}

BlockPlace is a sound sent when a block is placed.

func (BlockPlace) Play

func (BlockPlace) Play(*world.World, mgl64.Vec3)

Play ...

type BowShoot added in v0.6.0

type BowShoot struct {
	// contains filtered or unexported fields
}

BowShoot is a sound played when a bow is shot.

func (BowShoot) Play added in v0.6.0

func (BowShoot) Play(*world.World, mgl64.Vec3)

Play ...

type BucketEmpty

type BucketEmpty struct {
	// Liquid is the liquid that the bucket places into the world.
	Liquid world.Liquid
	// contains filtered or unexported fields
}

BucketEmpty is a sound played when a bucket with a liquid in it is placed into the world.

func (BucketEmpty) Play

func (BucketEmpty) Play(*world.World, mgl64.Vec3)

Play ...

type BucketFill

type BucketFill struct {
	// Liquid is the liquid that the bucket is filled up with.
	Liquid world.Liquid
	// contains filtered or unexported fields
}

BucketFill is a sound played when a bucket is filled using a liquid source block from the world.

func (BucketFill) Play

func (BucketFill) Play(*world.World, mgl64.Vec3)

Play ...

type Burning added in v0.7.3

type Burning struct {
	// contains filtered or unexported fields
}

Burning is a sound played when an entity is on fire.

func (Burning) Play added in v0.7.3

func (Burning) Play(*world.World, mgl64.Vec3)

Play ...

type Burp

type Burp struct {
	// contains filtered or unexported fields
}

Burp is a sound played when a player finishes eating an item.

func (Burp) Play

func (Burp) Play(*world.World, mgl64.Vec3)

Play ...

type ChestClose

type ChestClose struct {
	// contains filtered or unexported fields
}

ChestClose is played when a chest is closed.

func (ChestClose) Play

func (ChestClose) Play(*world.World, mgl64.Vec3)

Play ...

type ChestOpen

type ChestOpen struct {
	// contains filtered or unexported fields
}

ChestOpen is played when a chest is opened.

func (ChestOpen) Play

func (ChestOpen) Play(*world.World, mgl64.Vec3)

Play ...

type Click

type Click struct {
	// contains filtered or unexported fields
}

Click is a clicking sound.

func (Click) Play

func (Click) Play(*world.World, mgl64.Vec3)

Play ...

type ComposterEmpty added in v0.8.2

type ComposterEmpty struct {
	// contains filtered or unexported fields
}

ComposterEmpty is a sound played when a composter has been emptied.

func (ComposterEmpty) Play added in v0.8.2

func (ComposterEmpty) Play(*world.World, mgl64.Vec3)

Play ...

type ComposterFill added in v0.8.2

type ComposterFill struct {
	// contains filtered or unexported fields
}

ComposterFill is a sound played when a composter has been filled, but not gone up a layer.

func (ComposterFill) Play added in v0.8.2

func (ComposterFill) Play(*world.World, mgl64.Vec3)

Play ...

type ComposterFillLayer added in v0.8.2

type ComposterFillLayer struct {
	// contains filtered or unexported fields
}

ComposterFillLayer is a sound played when a composter has been filled and gone up a layer.

func (ComposterFillLayer) Play added in v0.8.2

func (ComposterFillLayer) Play(*world.World, mgl64.Vec3)

Play ...

type ComposterReady added in v0.8.2

type ComposterReady struct {
	// contains filtered or unexported fields
}

ComposterReady is a sound played when a composter has produced bone meal and is ready to be collected.

func (ComposterReady) Play added in v0.8.2

func (ComposterReady) Play(*world.World, mgl64.Vec3)

Play ...

type Deny

type Deny struct {
	// contains filtered or unexported fields
}

Deny is a sound played when a block is placed or broken above a 'Deny' block from Education edition.

func (Deny) Play

func (Deny) Play(*world.World, mgl64.Vec3)

Play ...

type DiscType added in v0.8.0

type DiscType struct {
	// contains filtered or unexported fields
}

DiscType represents the type of music disc. Typically, Minecraft has a total of 15 music discs.

func Disc11 added in v0.8.0

func Disc11() DiscType

Disc11 returns the music disc "11".

func Disc13 added in v0.8.0

func Disc13() DiscType

Disc13 returns the music disc "13".

func Disc5 added in v0.8.0

func Disc5() DiscType

Disc5 returns the music disc "5".

func DiscBlocks added in v0.8.0

func DiscBlocks() DiscType

DiscBlocks returns the music disc "blocks".

func DiscCat added in v0.8.0

func DiscCat() DiscType

DiscCat returns the music disc "cat".

func DiscChirp added in v0.8.0

func DiscChirp() DiscType

DiscChirp returns the music disc "chirp".

func DiscFar added in v0.8.0

func DiscFar() DiscType

DiscFar returns the music disc "far".

func DiscMall added in v0.8.0

func DiscMall() DiscType

DiscMall returns the music disc "mall".

func DiscMellohi added in v0.8.0

func DiscMellohi() DiscType

DiscMellohi returns the music disc "mellohi".

func DiscOtherside added in v0.8.0

func DiscOtherside() DiscType

DiscOtherside returns the music disc "otherside".

func DiscPigstep added in v0.8.0

func DiscPigstep() DiscType

DiscPigstep returns the music disc "Pigstep".

func DiscStal added in v0.8.0

func DiscStal() DiscType

DiscStal returns the music disc "stal".

func DiscStrad added in v0.8.0

func DiscStrad() DiscType

DiscStrad returns the music disc "strad".

func DiscWait added in v0.8.0

func DiscWait() DiscType

DiscWait returns the music disc "wait".

func DiscWard added in v0.8.0

func DiscWard() DiscType

DiscWard returns the music disc "ward".

func MusicDiscs added in v0.8.0

func MusicDiscs() []DiscType

MusicDiscs returns a list of all existing music discs.

func (DiscType) Author added in v0.8.0

func (d DiscType) Author() string

Author ...

func (DiscType) DisplayName added in v0.8.0

func (d DiscType) DisplayName() string

DisplayName ...

func (DiscType) String added in v0.8.0

func (d DiscType) String() string

String ...

func (DiscType) Uint8 added in v0.8.0

func (d DiscType) Uint8() uint8

Uint8 converts the disc to an integer that uniquely identifies its type.

type Door

type Door struct {
	// contains filtered or unexported fields
}

Door is a sound played when a (trap)door is opened or closed.

func (Door) Play

func (Door) Play(*world.World, mgl64.Vec3)

Play ...

type DoorCrash

type DoorCrash struct {
	// contains filtered or unexported fields
}

DoorCrash is a sound played when a door is forced open.

func (DoorCrash) Play

func (DoorCrash) Play(*world.World, mgl64.Vec3)

Play ...

type Drowning added in v0.7.3

type Drowning struct {
	// contains filtered or unexported fields
}

Drowning is a sound played when an entity is drowning in water.

func (Drowning) Play added in v0.7.3

func (Drowning) Play(*world.World, mgl64.Vec3)

Play ...

type EquipItem added in v0.8.0

type EquipItem struct {
	// Item is the item that was equipped. The sound played differs depending on this field.
	Item world.Item
	// contains filtered or unexported fields
}

EquipItem is a sound played when the player fast equips an item by using it.

func (EquipItem) Play added in v0.8.0

func (EquipItem) Play(*world.World, mgl64.Vec3)

Play ...

type Experience added in v0.6.0

type Experience struct {
	// contains filtered or unexported fields
}

Experience is a sound played whenever a player picks up an XP orb.

func (Experience) Play added in v0.6.0

func (Experience) Play(*world.World, mgl64.Vec3)

Play ...

type Explosion

type Explosion struct {
	// contains filtered or unexported fields
}

Explosion is a sound played when an explosion happens, such as from a creeper or TNT.

func (Explosion) Play

func (Explosion) Play(*world.World, mgl64.Vec3)

Play ...

type Fall added in v0.8.0

type Fall struct {
	// Distance is the distance the entity has fallen.
	Distance float64
	// contains filtered or unexported fields
}

Fall is a sound played when an entity falls and hits ground.

func (Fall) Play added in v0.8.0

func (Fall) Play(*world.World, mgl64.Vec3)

Play ...

type FireCharge added in v0.8.0

type FireCharge struct {
	// contains filtered or unexported fields
}

FireCharge is a sound played when a player lights a block on fire with a fire charge, or when a dispenser or a blaze shoots a fireball.

func (FireCharge) Play added in v0.8.0

func (FireCharge) Play(*world.World, mgl64.Vec3)

Play ...

type FireExtinguish

type FireExtinguish struct {
	// contains filtered or unexported fields
}

FireExtinguish is a sound played when a fire is extinguished.

func (FireExtinguish) Play

func (FireExtinguish) Play(*world.World, mgl64.Vec3)

Play ...

type FireworkBlast added in v0.8.0

type FireworkBlast struct {
	// contains filtered or unexported fields
}

FireworkBlast is a sound played when a small sphere firework explodes.

func (FireworkBlast) Play added in v0.8.0

func (FireworkBlast) Play(*world.World, mgl64.Vec3)

Play ...

type FireworkHugeBlast added in v0.8.0

type FireworkHugeBlast struct {
	// contains filtered or unexported fields
}

FireworkHugeBlast is a sound played when a huge sphere firework explodes.

func (FireworkHugeBlast) Play added in v0.8.0

func (FireworkHugeBlast) Play(*world.World, mgl64.Vec3)

Play ...

type FireworkLaunch added in v0.8.0

type FireworkLaunch struct {
	// contains filtered or unexported fields
}

FireworkLaunch is a sound played when a firework is launched.

func (FireworkLaunch) Play added in v0.8.0

func (FireworkLaunch) Play(*world.World, mgl64.Vec3)

Play ...

type FireworkTwinkle added in v0.8.0

type FireworkTwinkle struct {
	// contains filtered or unexported fields
}

FireworkTwinkle is a sound played when a firework explodes and should twinkle.

func (FireworkTwinkle) Play added in v0.8.0

func (FireworkTwinkle) Play(*world.World, mgl64.Vec3)

Play ...

type Fizz

type Fizz struct {
	// contains filtered or unexported fields
}

Fizz is a sound sent when a lava block and a water block interact with each other in a way that one of them turns into a solid block.

func (Fizz) Play

func (Fizz) Play(*world.World, mgl64.Vec3)

Play ...

type FurnaceCrackle added in v0.8.0

type FurnaceCrackle struct {
	// contains filtered or unexported fields
}

FurnaceCrackle is a sound played every one to five seconds from a furnace.

func (FurnaceCrackle) Play added in v0.8.0

func (FurnaceCrackle) Play(*world.World, mgl64.Vec3)

Play ...

type GhastShoot added in v0.7.3

type GhastShoot struct {
	// contains filtered or unexported fields
}

GhastShoot is a sound played when a ghast shoots a fire charge.

func (GhastShoot) Play added in v0.7.3

func (GhastShoot) Play(*world.World, mgl64.Vec3)

Play ...

type GhastWarning added in v0.7.3

type GhastWarning struct {
	// contains filtered or unexported fields
}

GhastWarning is a sound played when a ghast is ready to attack.

func (GhastWarning) Play added in v0.7.3

func (GhastWarning) Play(*world.World, mgl64.Vec3)

Play ...

type GlassBreak added in v0.5.0

type GlassBreak struct {
	// contains filtered or unexported fields
}

GlassBreak is a sound played when a glass block or item is broken.

func (GlassBreak) Play added in v0.5.0

func (GlassBreak) Play(*world.World, mgl64.Vec3)

Play ...

type GoatHorn added in v0.8.0

type GoatHorn struct {
	// Horn is the type of the goat horn.
	Horn Horn
	// contains filtered or unexported fields
}

GoatHorn is a sound played when a player uses a goat horn.

func (GoatHorn) Play added in v0.8.0

func (GoatHorn) Play(*world.World, mgl64.Vec3)

Play ...

type Horn added in v0.8.0

type Horn struct {
	// contains filtered or unexported fields
}

Horn represents a variant of a goat horn.

func Admire added in v0.8.0

func Admire() Horn

Admire returns the 'Admire' goat horn type.

func Call added in v0.8.0

func Call() Horn

Call returns the 'Call' goat horn type.

func Dream added in v0.8.0

func Dream() Horn

Dream returns the 'Dream' goat horn type.

func Feel added in v0.8.0

func Feel() Horn

Feel returns the 'Feel' goat horn type.

func GoatHorns added in v0.8.0

func GoatHorns() []Horn

GoatHorns ...

func Ponder added in v0.8.0

func Ponder() Horn

Ponder returns the 'Ponder' goat horn type.

func Seek added in v0.8.0

func Seek() Horn

Seek returns the 'Seek' goat horn type.

func Sing added in v0.8.0

func Sing() Horn

Sing returns the 'Sing' goat horn type.

func Yearn added in v0.8.0

func Yearn() Horn

Yearn returns the 'Yearn' goat horn type.

func (Horn) Name added in v0.8.0

func (g Horn) Name() string

Name returns the goat horn type's name.

func (Horn) Uint8 added in v0.8.0

func (g Horn) Uint8() uint8

Uint8 returns the goat horn type as a uint8.

type Ignite

type Ignite struct {
	// contains filtered or unexported fields
}

Ignite is a sound played when using a flint & steel.

func (Ignite) Play

func (Ignite) Play(*world.World, mgl64.Vec3)

Play ...

type Instrument added in v0.6.0

type Instrument struct {
	// contains filtered or unexported fields
}

Instrument represents a note block instrument.

func Banjo added in v0.6.0

func Banjo() Instrument

Banjo is an instrument type for the note block.

func Bass added in v0.6.0

func Bass() Instrument

Bass is an instrument type for the note block.

func BassDrum added in v0.6.0

func BassDrum() Instrument

BassDrum is an instrument type for the note block.

func Bell added in v0.6.0

func Bell() Instrument

Bell is an instrument type for the note block.

func Bit added in v0.6.0

func Bit() Instrument

Bit is an instrument type for the note block.

func Chimes added in v0.6.0

func Chimes() Instrument

Chimes is an instrument type for the note block.

func ClicksAndSticks added in v0.6.0

func ClicksAndSticks() Instrument

ClicksAndSticks is an instrument type for the note block.

func CowBell added in v0.6.0

func CowBell() Instrument

CowBell is an instrument type for the note block.

func Didgeridoo added in v0.6.0

func Didgeridoo() Instrument

Didgeridoo is an instrument type for the note block.

func Flute added in v0.6.0

func Flute() Instrument

Flute is an instrument type for the note block.

func Guitar added in v0.6.0

func Guitar() Instrument

Guitar is an instrument type for the note block.

func IronXylophone added in v0.6.0

func IronXylophone() Instrument

IronXylophone is an instrument type for the note block.

func Piano added in v0.6.0

func Piano() Instrument

Piano is an instrument type for the note block.

func Pling added in v0.6.0

func Pling() Instrument

Pling is an instrument type for the note block.

func Snare added in v0.6.0

func Snare() Instrument

Snare is an instrument type for the note block.

func Xylophone added in v0.6.0

func Xylophone() Instrument

Xylophone is an instrument type for the note block.

func (Instrument) Int32 added in v0.6.0

func (i Instrument) Int32() int32

Int32 ...

type ItemBreak

type ItemBreak struct {
	// contains filtered or unexported fields
}

ItemBreak is a sound played when an item in the inventory is broken, such as when a tool reaches 0 durability and breaks.

func (ItemBreak) Play

func (ItemBreak) Play(*world.World, mgl64.Vec3)

Play ...

type ItemFrameAdd added in v0.5.0

type ItemFrameAdd struct {
	// contains filtered or unexported fields
}

ItemFrameAdd is a sound played when an item is added to an item frame.

func (ItemFrameAdd) Play added in v0.5.0

func (ItemFrameAdd) Play(*world.World, mgl64.Vec3)

Play ...

type ItemFrameRemove added in v0.5.0

type ItemFrameRemove struct {
	// contains filtered or unexported fields
}

ItemFrameRemove is a sound played when an item is removed from an item frame.

func (ItemFrameRemove) Play added in v0.5.0

func (ItemFrameRemove) Play(*world.World, mgl64.Vec3)

Play ...

type ItemFrameRotate added in v0.5.0

type ItemFrameRotate struct {
	// contains filtered or unexported fields
}

ItemFrameRotate is a sound played when an item frame's item is rotated.

func (ItemFrameRotate) Play added in v0.5.0

func (ItemFrameRotate) Play(*world.World, mgl64.Vec3)

Play ...

type ItemThrow added in v0.4.0

type ItemThrow struct {
	// contains filtered or unexported fields
}

ItemThrow is a sound played when a player throws an item, such as a snowball.

func (ItemThrow) Play added in v0.4.0

func (ItemThrow) Play(*world.World, mgl64.Vec3)

Play ...

type ItemUseOn

type ItemUseOn struct {
	// Block is generally the block that was created by using the item on a block. The sound played differs
	// depending on this field.
	Block world.Block
	// contains filtered or unexported fields
}

ItemUseOn is a sound played when a player uses its item on a block. An example of this is when a player uses a shovel to turn grass into dirt path. Note that in these cases, the Block is actually the new block, not the old one.

func (ItemUseOn) Play

func (ItemUseOn) Play(*world.World, mgl64.Vec3)

Play ...

type LevelUp added in v0.6.0

type LevelUp struct {
	// contains filtered or unexported fields
}

LevelUp is a sound played for a player whenever they level up.

func (LevelUp) Play added in v0.6.0

func (LevelUp) Play(*world.World, mgl64.Vec3)

Play ...

type MusicDiscEnd added in v0.8.0

type MusicDiscEnd struct {
	// contains filtered or unexported fields
}

MusicDiscEnd is a sound played when a music disc has stopped playing in a jukebox.

func (MusicDiscEnd) Play added in v0.8.0

func (MusicDiscEnd) Play(*world.World, mgl64.Vec3)

Play ...

type MusicDiscPlay added in v0.8.0

type MusicDiscPlay struct {

	// DiscType is the disc type of the music disc.
	DiscType DiscType
	// contains filtered or unexported fields
}

MusicDiscPlay is a sound played when a music disc has started playing in a jukebox.

func (MusicDiscPlay) Play added in v0.8.0

func (MusicDiscPlay) Play(*world.World, mgl64.Vec3)

Play ...

type Note

type Note struct {

	// Instrument is the instrument of the note block.
	Instrument Instrument
	// Pitch is the pitch of the note.
	Pitch int
	// contains filtered or unexported fields
}

Note is a sound played by note blocks.

func (Note) Play

func (Note) Play(*world.World, mgl64.Vec3)

Play ...

type Pop

type Pop struct {
	// contains filtered or unexported fields
}

Pop is a sound played when a chicken lays an egg.

func (Pop) Play

func (Pop) Play(*world.World, mgl64.Vec3)

Play ...

type SmokerCrackle added in v0.8.0

type SmokerCrackle struct {
	// contains filtered or unexported fields
}

SmokerCrackle is a sound played every one to five seconds from a smoker.

func (SmokerCrackle) Play added in v0.8.0

func (SmokerCrackle) Play(*world.World, mgl64.Vec3)

Play ...

type StopUsingSpyglass added in v0.6.0

type StopUsingSpyglass struct {
	// contains filtered or unexported fields
}

StopUsingSpyglass is a sound played when a player stops using a spyglass.

func (StopUsingSpyglass) Play added in v0.6.0

func (StopUsingSpyglass) Play(*world.World, mgl64.Vec3)

Play ...

type TNT added in v0.8.0

type TNT struct {
	// contains filtered or unexported fields
}

TNT is a sound played when TNT is ignited.

func (TNT) Play added in v0.8.0

func (TNT) Play(*world.World, mgl64.Vec3)

Play ...

type Teleport added in v0.7.0

type Teleport struct {
	// contains filtered or unexported fields
}

Teleport is a sound played upon teleportation of an enderman, or teleportation of a player by an ender pearl or a chorus fruit.

func (Teleport) Play added in v0.7.0

func (Teleport) Play(*world.World, mgl64.Vec3)

Play ...

type Thunder added in v0.3.0

type Thunder struct {
	// contains filtered or unexported fields
}

Thunder is a sound played when lightning strikes the ground.

func (Thunder) Play added in v0.3.0

func (Thunder) Play(*world.World, mgl64.Vec3)

Play ...

type UseSpyglass added in v0.6.0

type UseSpyglass struct {
	// contains filtered or unexported fields
}

UseSpyglass is a sound played when a player uses a spyglass.

func (UseSpyglass) Play added in v0.6.0

func (UseSpyglass) Play(*world.World, mgl64.Vec3)

Play ...

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL