Package com.cryptomorin.xseries

Class XSound.Record

java.lang.Object

com.cryptomorin.xseries.XSound.Record

All Implemented Interfaces:

Cloneable

Enclosing class:

XSound

public static class XSound.Record
extends Object
implements Cloneable

A class to help caching and playing sound properties parsed from config.

Since:

3.0.0

Constructor Summary

Constructors

Constructor	Description
Record()

Method Summary

Modifier and Type	Method	Description
XSound.Record	clone()
long	generateSeed()
XSound.Category	getCategory()
float	getPitch()
Long	getSeed()
Object	getSound()
float	getVolume()
XSound.Record	inCategory(XSound.Category category)
XSound.Record	publicSound(boolean publicSound)	Whether to play this sound to all nearby players or just the players specified in the XSound.SoundPlayer.players list.
String	rebuild()
XSound.SoundPlayer	soundPlayer()
String	toString()
XSound.Record	withPitch(float pitch)
XSound.Record	withSeed(Long seed)	Some sounds have different variations.
XSound.Record	withSound(XSound sound)
XSound.Record	withSound(String sound)	The sound including the namespace and the key.
XSound.Record	withVolume(float volume)

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

Record

public Record()

Method Details

getSeed

@Nullable
public Long getSeed()

getSound

public Object getSound()

getCategory

@Nonnull
public XSound.Category getCategory()

getVolume

public float getVolume()

getPitch

public float getPitch()

inCategory

public XSound.Record inCategory(XSound.Category category)

soundPlayer

public XSound.SoundPlayer soundPlayer()

Returns:

a new XSound.SoundPlayer object.

withSound

public XSound.Record withSound(@Nonnull
 XSound sound)

withSound

public XSound.Record withSound(@Nonnull
 String sound)

The sound including the namespace and the key. E.g. for XSound.ENTITY_PLAYER_HURT it'd be minecraft:entity_player_hurt you can use other namespaces instead of "minecraft" to use sounds from resource packs.

generateSeed

public long generateSeed()

withVolume

public XSound.Record withVolume(float volume)

publicSound

public XSound.Record publicSound(boolean publicSound)

Whether to play this sound to all nearby players or just the players specified in the XSound.SoundPlayer.players list.

withPitch

public XSound.Record withPitch(float pitch)

withSeed

public XSound.Record withSeed(Long seed)

Some sounds have different variations. Using a static seed will always play the same variation for that sound.

Parameters:

seed - Randomizes the variation of null.

rebuild

public String rebuild()

toString

public String toString()

Overrides:

toString in class Object

clone

public XSound.Record clone()

Overrides:

clone in class Object