com.github.shynixn.petblocks.bukkit.logic.persistence.entity

Class SoundBuilder

java.lang.Object

com.github.shynixn.petblocks.bukkit.logic.persistence.entity.SoundBuilder

All Implemented Interfaces:

com.github.shynixn.petblocks.api.persistence.entity.Persistenceable, com.github.shynixn.petblocks.api.persistence.entity.SoundMeta

public class SoundBuilder
extends Object
implements com.github.shynixn.petblocks.api.persistence.entity.SoundMeta

Copyright 2017 Shynixn

Do not remove this header!

Version 1.0

MIT License

Copyright (c) 2017

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.

Constructor Summary

Constructors

Constructor and Description
SoundBuilder() Initializes a new soundBuilder
SoundBuilder(Map<String,Object> items) Initializes a new soundBuilder from serialized Content
SoundBuilder(String text) Initializes a new soundBuilder
SoundBuilder(String text, double volume, double pitch) Initializes a new soundBuilder

Method Summary

Modifier and Type	Method and Description
void	apply(Collection<org.bukkit.entity.Player> players) Plays the sound to all given players at their location
void	apply(org.bukkit.Location location) Plays the sound to all players in the world at the given location.
void	apply(org.bukkit.Location location, Collection<org.bukkit.entity.Player> players) Plays the sound to the given players at the given location.
void	apply(org.bukkit.Location location, org.bukkit.entity.Player... players) Plays the sound to the given players at the given location.
void	apply(org.bukkit.entity.Player... players) Plays the sound to all given players at their location
void	applyToLocation(Object location) Applies the sound at the given location
void	applyToPlayers(Object... players) Applies the sound to the given player
static String	getAvailableSounds() Returns all available sound names
long	getId() Returns the id of the object
String	getName() Returns the name of the sound
double	getPitch() Returns the pitch of the sound
org.bukkit.Sound	getSound() Returns the sound and throws exception if the sound does not exist
static org.bukkit.Sound	getSoundFromName(String name) Returns the sound from the given name
double	getVolume() Returns the volume of the sound
Map<String,Object>	serialize() Serializes the builder
SoundBuilder	setName(String name) Sets the name of the sound
SoundBuilder	setPitch(double pitch) Sets the pitch of the sound
SoundBuilder	setSound(org.bukkit.Sound sound) Sets the bukkit sound of the sound
SoundBuilder	setVolume(double volume) Sets the volume of the sound

Methods inherited from class java.lang.Object

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

Constructor Detail

SoundBuilder

public SoundBuilder()

Initializes a new soundBuilder

SoundBuilder

public SoundBuilder(String text)

Initializes a new soundBuilder

Parameters:

text - text

SoundBuilder

public SoundBuilder(String text,
                    double volume,
                    double pitch)

Initializes a new soundBuilder

Parameters:

text - text

volume - volume

pitch - pitch

SoundBuilder

public SoundBuilder(Map<String,Object> items)
             throws Exception

Initializes a new soundBuilder from serialized Content

Parameters:

items - items

Throws:

Exception - exception

Method Detail

apply

public void apply(Collection<org.bukkit.entity.Player> players)
           throws Exception

Plays the sound to all given players at their location

Parameters:

players - players

Throws:

Exception - exception

apply

public void apply(org.bukkit.entity.Player... players)
           throws Exception

Plays the sound to all given players at their location

Parameters:

players - players

Throws:

Exception - exception

apply

public void apply(org.bukkit.Location location)
           throws Exception

Plays the sound to all players in the world at the given location. Players to far away cannot hear the sound.

Parameters:

location - location

Throws:

Exception - exception

apply

public void apply(org.bukkit.Location location,
                  Collection<org.bukkit.entity.Player> players)
           throws Exception

Plays the sound to the given players at the given location. Given players to far away cannot hear the sound.

Parameters:

location - location

players - players

Throws:

Exception - exception

apply

public void apply(org.bukkit.Location location,
                  org.bukkit.entity.Player... players)
           throws Exception

Plays the sound to the given players at the given location. Given players to far away cannot hear the sound.

Parameters:

location - location

players - players

Throws:

Exception - exception

applyToLocation

public void applyToLocation(Object location)
                     throws Exception

Applies the sound at the given location

Specified by:

applyToLocation in interface com.github.shynixn.petblocks.api.persistence.entity.SoundMeta

Parameters:

location - location

Throws:

Exception

applyToPlayers

public void applyToPlayers(Object... players)
                    throws Exception

Applies the sound to the given player

Specified by:

applyToPlayers in interface com.github.shynixn.petblocks.api.persistence.entity.SoundMeta

Parameters:

players - players

Throws:

Exception

getName

public String getName()

Returns the name of the sound

Specified by:

getName in interface com.github.shynixn.petblocks.api.persistence.entity.SoundMeta

Returns:

name

setName

public SoundBuilder setName(String name)

Sets the name of the sound

Specified by:

setName in interface com.github.shynixn.petblocks.api.persistence.entity.SoundMeta

Parameters:

name - name

Returns:

builder

getSound

public org.bukkit.Sound getSound()
                          throws Exception

Returns the sound and throws exception if the sound does not exist

Returns:

sound

Throws:

Exception - exception

setSound

public SoundBuilder setSound(org.bukkit.Sound sound)

Sets the bukkit sound of the sound

Parameters:

sound - sound

Returns:

builder

getVolume

public double getVolume()

Returns the volume of the sound

Specified by:

getVolume in interface com.github.shynixn.petblocks.api.persistence.entity.SoundMeta

Returns:

volume

setVolume

public SoundBuilder setVolume(double volume)

Sets the volume of the sound

Specified by:

setVolume in interface com.github.shynixn.petblocks.api.persistence.entity.SoundMeta

Parameters:

volume - volume

Returns:

builder

getPitch

public double getPitch()

Returns the pitch of the sound

Specified by:

getPitch in interface com.github.shynixn.petblocks.api.persistence.entity.SoundMeta

Returns:

pitch

setPitch

public SoundBuilder setPitch(double pitch)

Sets the pitch of the sound

Specified by:

setPitch in interface com.github.shynixn.petblocks.api.persistence.entity.SoundMeta

Parameters:

pitch - pitch

Returns:

builder

serialize

public Map<String,Object> serialize()

Serializes the builder

Returns:

serializedContent

getSoundFromName

public static org.bukkit.Sound getSoundFromName(String name)

Returns the sound from the given name

Parameters:

name - name

Returns:

sounds

getAvailableSounds

public static String getAvailableSounds()

Returns all available sound names

Returns:

text

getId

public long getId()

Returns the id of the object

Specified by:

getId in interface com.github.shynixn.petblocks.api.persistence.entity.Persistenceable

Returns:

id