Interface SulfurCubeArchetypeRegistryEntry.SoundSettings

Enclosing interface:

SulfurCubeArchetypeRegistryEntry

@NonExtendable
public static interface SulfurCubeArchetypeRegistryEntry.SoundSettings

The sound settings of a sulfur cube of this archetype.

Since:

26.2

Method Summary

Modifier and Type	Method	Description
TypedKey<Sound>	hitSound()	Returns the sound played once the sulfur cube is knocked.
static SulfurCubeArchetypeRegistryEntry.SoundSettings	of(TypedKey<Sound> hitSound, TypedKey<Sound> pushSound, float pushSoundImpulseThreshold, float pushSoundCooldown)	Creates a new sound settings instance based on the passed values.
TypedKey<Sound>	pushSound()	Returns the sound played once the sulfur cube is pushed.
float	pushSoundCooldown()	Returns the amount of seconds before the push sound can be played again.
float	pushSoundImpulseThreshold()	Returns the smallest impulse required to play the push sound.

Method Details

hitSound

@Experimental
TypedKey<Sound> hitSound()

Returns the sound played once the sulfur cube is knocked.

Returns:

the sound played once the sulfur cube is knocked

Since:

26.2

pushSound

@Experimental
TypedKey<Sound> pushSound()

Returns the sound played once the sulfur cube is pushed.

Returns:

the sound played once the sulfur cube is pushed

Since:

26.2

pushSoundImpulseThreshold

float pushSoundImpulseThreshold()

Returns the smallest impulse required to play the push sound.

Returns:

the smallest impulse required to play the push sound

Since:

26.2

pushSoundCooldown

float pushSoundCooldown()

Returns the amount of seconds before the push sound can be played again.

Returns:

the amount of seconds before the push sound can be played again

Since:

26.2

of

@Contract(value="_, _, _, _ -> new",
          pure=true)
@Experimental
static SulfurCubeArchetypeRegistryEntry.SoundSettings of(TypedKey<Sound> hitSound,
 TypedKey<Sound> pushSound,
 float pushSoundImpulseThreshold,
 float pushSoundCooldown)

Creates a new sound settings instance based on the passed values.

Parameters:

hitSound - the sound played once the sulfur cube is knocked, as returned by hitSound()

pushSound - the sound played once the sulfur cube is pushed, as returned by pushSound()

pushSoundImpulseThreshold - the smallest impulse required to play the push sound, as returned by pushSoundImpulseThreshold()

pushSoundCooldown - the amount of seconds before the push sound can be played again, as returned by pushSoundCooldown()

Returns:

the created instance

Since:

26.2