com.github.shynixn.ball.api.persistence.effect

Interface SoundEffectMeta<Location,Player>

All Superinterfaces:

EffectMeta

All Known Implementing Classes:

SoundBuilder

public SoundEffectMeta<Location,Player>
extends EffectMeta

Handles soundEffects for players.

Version 1.1

MIT License

Copyright (c) 2017 by Shynixn

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Method Summary

Modifier and Type	Method and Description
void	apply() Plays the effect at the given location to the given players.
void	apply() Plays the effect to the given players.
void	apply() Plays the effect at the given location to the given players.
SoundEffectMeta<Location,Player>	copy() Clones the current object.
java.lang.String	getName() Returns the name of the sound.
double	getPitch() Returns the pitch of the sound.
double	getVolume() Returns the volume of the sound.
<T extends SoundEffectMeta<Location,Player>> T	setName() Sets the name of the sound.
<T extends SoundEffectMeta<Location,Player>> T	setPitch() Sets the pitch of the sound.
<T extends SoundEffectMeta<Location,Player>> T	setVolume() Sets the volume of the sound.

Methods inherited from interface com.github.shynixn.ball.api.persistence.effect.EffectMeta

getEffectingType, setEffectingType

Method Detail

apply

void apply()

Plays the effect at the given location to the given players.

apply

void apply()

Plays the effect to the given players.

apply

void apply()

Plays the effect at the given location to the given players.

getName

java.lang.String getName()

Returns the name of the sound.

Returns:

name

setName

<T extends SoundEffectMeta<Location,Player>> T setName()

Sets the name of the sound.

Returns:

builder

getVolume

double getVolume()

Returns the volume of the sound.

Returns:

volume

setVolume

<T extends SoundEffectMeta<Location,Player>> T setVolume()

Sets the volume of the sound.

Returns:

builder

getPitch

double getPitch()

Returns the pitch of the sound.

Returns:

pitch

setPitch

<T extends SoundEffectMeta<Location,Player>> T setPitch()

Sets the pitch of the sound.

Returns:

builder

copy

SoundEffectMeta<Location,Player> copy()

Clones the current object.

Returns:

clone