Package dev.prozilla.pine.core.component.audio

Class AudioEffectPlayer

java.lang.Object

dev.prozilla.pine.core.component.Component

dev.prozilla.pine.core.component.audio.AudioEffectPlayer

All Implemented Interfaces:

Destructible, Initializable, Printable, ApplicationContext, ApplicationProvider, ComponentsContext, ComponentsProvider, EntityContext, EntityProvider, SceneContext, SceneProvider

public class AudioEffectPlayer
extends Component
implements Initializable

Field Summary

Fields

Modifier and Type	Field	Description
boolean	autoplay
static final int	DEFAULT_MAX_SOURCE_CLONES	Determines how many clones can exist per source by default.
int	maxSources
final List<AudioSource>	sources

Fields inherited from class dev.prozilla.pine.core.component.Component

entity, id, isActive

Constructor Summary

Constructors

Constructor	Description
AudioEffectPlayer(List<AudioSource> sources)
AudioEffectPlayer(List<AudioSource> sources, float volume)

Method Summary

Modifier and Type	Method	Description
void	destroy()	Removes this component from its entity.
void	init()	Initializes this object to prepare its usage.
boolean	isMuted()
void	mute()
void	play(int index)
void	playRandom()
void	playRandom(int minIndex, int maxIndex)
void	prepareSources(int count)
void	setGain(float gain)
void	setGain(VariableProperty<Float> gain)
void	setGlobalGain(float gain)
void	setGlobalGain(VariableProperty<Float> gain)
void	setGlobalPitch(float pitch)
void	setGlobalPitch(VariableProperty<Float> pitch)
void	setGlobalVolume(float volume)
void	setGlobalVolume(VariableProperty<Float> volume)
void	setMaxSources(int maxSources)
void	setPitch(float pitch)
void	setPitch(VariableProperty<Float> pitch)
void	setVolume(float volume)
void	setVolume(VariableProperty<Float> volume)
void	unmute()

Methods inherited from class dev.prozilla.pine.core.component.Component

equals, getApplication, getEntity, getName, getScene, hashCode, onEntityChange, setActive, setEntity, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.prozilla.pine.core.ApplicationProvider

getAudioDevice, getConfig, getInput, getLocalStorage, getLogger, getModManager, getRenderer, getTimer, getTracker, getWindow

Methods inherited from interface dev.prozilla.pine.core.component.ComponentsProvider

getComponent, getComponentInParent, getComponentInParent, getComponents, getComponentsInChildren

Methods inherited from interface dev.prozilla.pine.core.entity.EntityContext

isDescendantOf

Methods inherited from interface dev.prozilla.pine.core.entity.EntityProvider

getChild, getChildWithTag, getFirstChild, getLastChild, getParentWithTag, getTransform, isDescendantOf

Methods inherited from interface dev.prozilla.pine.common.Printable

print, print

Methods inherited from interface dev.prozilla.pine.core.scene.SceneProvider

getCameraData, getWorld

Field Details

sources

public final List<AudioSource> sources

maxSources

public int maxSources

autoplay

public boolean autoplay

DEFAULT_MAX_SOURCE_CLONES

public static final int DEFAULT_MAX_SOURCE_CLONES

Determines how many clones can exist per source by default. The default maximum amount of sources is calculated by multiplying the amount of unique sources by this value plus one.

See Also:

• Constant Field Values

Constructor Details

AudioEffectPlayer

public AudioEffectPlayer(List<AudioSource> sources)

AudioEffectPlayer

public AudioEffectPlayer(List<AudioSource> sources,
 float volume)

Method Details

init

public void init()

Description copied from interface: Initializable

Initializes this object to prepare its usage.

Specified by:

init in interface Initializable

playRandom

public void playRandom()

playRandom

public void playRandom(int minIndex,
 int maxIndex)

play

public void play(int index)

mute

public void mute()

unmute

public void unmute()

isMuted

public boolean isMuted()

setGlobalVolume

public void setGlobalVolume(float volume)

setGlobalVolume

public void setGlobalVolume(VariableProperty<Float> volume)

setVolume

public void setVolume(float volume)

setVolume

public void setVolume(VariableProperty<Float> volume)

setGlobalPitch

public void setGlobalPitch(float pitch)

setGlobalPitch

public void setGlobalPitch(VariableProperty<Float> pitch)

setPitch

public void setPitch(float pitch)

setPitch

public void setPitch(VariableProperty<Float> pitch)

setGlobalGain

public void setGlobalGain(float gain)

setGlobalGain

public void setGlobalGain(VariableProperty<Float> gain)

setGain

public void setGain(float gain)

setGain

public void setGain(VariableProperty<Float> gain)

setMaxSources

public void setMaxSources(int maxSources)

prepareSources

public void prepareSources(int count)

destroy

public void destroy()

Description copied from class: Component

Removes this component from its entity.

Specified by:

destroy in interface Destructible

Overrides:

destroy in class Component