程序包 net.minecraftforge.common.data

类 SoundDefinition

java.lang.Object

net.minecraftforge.common.data.SoundDefinition

public final class SoundDefinition
extends Object

Contains all the data to completely define a sound event.

嵌套类概要

嵌套类

修饰符和类型	类	说明
static final class	SoundDefinition.Sound	Identifies a specific sound that has to be played in a sound event, along with all the necessary parameters.
static enum	SoundDefinition.SoundType	Represents the type of sound that the SoundDefinition.Sound object represents.

字段概要

字段

修饰符和类型	字段	说明
private boolean	replace
private final List<SoundDefinition.Sound>	sounds
private String	subtitle

构造器概要

构造器

限定符	构造器	说明
private	SoundDefinition()

方法概要

修饰符和类型	方法	说明
static SoundDefinition	definition()	Creates a new SoundDefinition, which will host a set of SoundDefinition.Sounds and the necessary parameters.
SoundDefinition	replace(boolean replace)	Sets whether this definition should replace any other definition for the same sound event previously applied, rather than overwriting it.
(专用程序包) com.google.gson.JsonObject	serialize()
(专用程序包) List<SoundDefinition.Sound>	soundList()
SoundDefinition	subtitle(@Nullable String subtitle)	Sets the language key for the subtitle that will be displayed whenever this sound is being played.
SoundDefinition	with(SoundDefinition.Sound sound)	Adds the given sound to this sound definition.
SoundDefinition	with(SoundDefinition.Sound... sounds)	Adds the given sounds to this sound definition.

从类继承的方法 java.lang.Object

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

字段详细资料

sounds

private final List<SoundDefinition.Sound> sounds

replace

private boolean replace

subtitle

private String subtitle

构造器详细资料

SoundDefinition

private SoundDefinition()

方法详细资料

definition

public static SoundDefinition definition()

Creates a new SoundDefinition, which will host a set of SoundDefinition.Sounds and the necessary parameters.

replace

public SoundDefinition replace(boolean replace)

Sets whether this definition should replace any other definition for the same sound event previously applied, rather than overwriting it.

参数:

replace - Whether this definition replaces or not.

返回:

This definition for chaining.

subtitle

public SoundDefinition subtitle(@Nullable
 @Nullable String subtitle)

Sets the language key for the subtitle that will be displayed whenever this sound is being played.

The subtitle is optional and the game will skip displaying it if it isn't present.

参数:

subtitle - The subtitle to display, or null to disable.

返回:

This definition for chaining.

with

public SoundDefinition with(SoundDefinition.Sound sound)

Adds the given sound to this sound definition.

参数:

sound - The sound to add.

返回:

This definition for chaining.

with

public SoundDefinition with(SoundDefinition.Sound... sounds)

Adds the given sounds to this sound definition.

参数:

sounds - The sounds to add.

返回:

This definition for chaining.

soundList

List<SoundDefinition.Sound> soundList()

serialize

com.google.gson.JsonObject serialize()