LocationBuilder (petblocks-bukkit-plugin 6.2.3 API)

java.lang.Object
- com.github.shynixn.petblocks.bukkit.logic.persistence.entity.LocationBuilder

All Implemented Interfaces:

com.github.shynixn.petblocks.api.persistence.entity.IPosition, com.github.shynixn.petblocks.api.persistence.entity.Persistenceable, org.bukkit.configuration.serialization.ConfigurationSerializable
```
public class LocationBuilder
extends Object
implements org.bukkit.configuration.serialization.ConfigurationSerializable, com.github.shynixn.petblocks.api.persistence.entity.IPosition
```
Copyright 2017 Shynixn
Do not remove this header!
Version 1.0
MIT License
Copyright (c) 2016
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.

Nested Class Summary
- Nested classes/interfaces inherited from interface com.github.shynixn.petblocks.api.persistence.entity.IPosition
  com.github.shynixn.petblocks.api.persistence.entity.IPosition.Direction

Constructor Summary

Constructors
Constructor and Description
`LocationBuilder()` Initializes a new LocationBuilder
`LocationBuilder(Map<String,Object> items)` Parses the location out of the map
`LocationBuilder(String worldName, double x, double y, double z, double yaw, double pitch)` Initializes a new LocationBuilder with the given params
`LocationBuilder(String worldName, double x, double y, double z, float yaw, float pitch)` Initializes a new LocationBuilder with the given params

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`LocationBuilder`	`addCoordinates(double x, double y, double z)` Adds or Subs the given coordinates x, y, z to or from the builder
`LocationBuilder`	`copy()` Copies the current builder
`boolean`	`equals(Object arg0)` Checks if 2 builders are equal
`int`	`getBlockX()` Returns the x coordinate as int of the builder
`int`	`getBlockY()` Returns the y coordinate as int of the builder
`int`	`getBlockZ()` Returns the z coordinate as int of the builder
`long`	`getId()` Returns the id of the object
`double`	`getPitch()` Returns the pitch of the builder
`org.bukkit.World`	`getWorld()` Returns the BukkitWorld of the builder
`String`	`getWorldName()` Returns the worldname of the builder
`double`	`getX()` Returns the x coordinate of the builder
`double`	`getY()` Returns the y coordinate of the builder
`double`	`getYaw()` Returns the yaw of the builder
`double`	`getZ()` Returns the z coordinate of the builder
`LocationBuilder`	`relativePosition(double distance, com.github.shynixn.petblocks.api.persistence.entity.IPosition.Direction direction)` Returns the relativePosition to a given direction
`Map<String,Object>`	`serialize()` Serializes the location data to be stored to the filesystem
`LocationBuilder`	`setCoordinates(double x, double y, double z)` Sets the coordinates x, y, z
`LocationBuilder`	`setPitch(double pitch)` Sets the pitch of the builder
`LocationBuilder`	`setRotation(double yaw, double pitch)` Sets the rotation yaw, pitch
`LocationBuilder`	`setWorld(org.bukkit.World world)` Sets the world of the builder
`LocationBuilder`	`setWorldName(String worldName)` Sets the worldName of the builder
`LocationBuilder`	`setX(double x)` Sets the x coordinate of the builder
`LocationBuilder`	`setY(double y)` Sets the y coordinate of the builder
`LocationBuilder`	`setYaw(double yaw)` Sets the yaw of the builder
`LocationBuilder`	`setZ(double z)` Sets the z coordinate of the builder
`org.bukkit.util.EulerAngle`	`toAngle()` Converts the builder to a bukkitEulerAngle
`org.bukkit.Location`	`toLocation()` Converts the builder to a bukkitLocation
`String`	`toString()` Displays the builder as string
`org.bukkit.util.Vector`	`toVector()` Converts the builder to a bukkitVector

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - LocationBuilder
```
public LocationBuilder()
```
    Initializes a new LocationBuilder
  - LocationBuilder
```
public LocationBuilder(String worldName,
                       double x,
                       double y,
                       double z,
                       float yaw,
                       float pitch)
```
    Initializes a new LocationBuilder with the given params
    
    Parameters:
    
    worldName - worldName
    
    x - x
    
    y - y
    
    z - z
    
    yaw - yaw
    
    pitch - pitch
  - LocationBuilder
```
public LocationBuilder(String worldName,
                       double x,
                       double y,
                       double z,
                       double yaw,
                       double pitch)
```
    Initializes a new LocationBuilder with the given params
    
    Parameters:
    
    worldName - worldName
    
    x - x
    
    y - y
    
    z - z
    
    yaw - yaw
    
    pitch - pitch
  - LocationBuilder
```
public LocationBuilder(Map<String,Object> items)
                throws Exception
```
    Parses the location out of the map
    
    Parameters:
    
    items - items
    
    Throws:
    
    Exception - mapParseException
- Method Detail
  - setCoordinates
```
public LocationBuilder setCoordinates(double x,
                                      double y,
                                      double z)
```
    Sets the coordinates x, y, z
    
    Specified by:
    
    setCoordinates in interface com.github.shynixn.petblocks.api.persistence.entity.IPosition
    
    Parameters:
    
    x - x
    
    y - y
    
    z - z
    
    Returns:
    
    builder
  - setRotation
```
public LocationBuilder setRotation(double yaw,
                                   double pitch)
```
    Sets the rotation yaw, pitch
    
    Specified by:
    
    setRotation in interface com.github.shynixn.petblocks.api.persistence.entity.IPosition
    
    Parameters:
    
    yaw - yaw
    
    pitch - pitch
    
    Returns:
    
    builder
  - addCoordinates
```
public LocationBuilder addCoordinates(double x,
                                      double y,
                                      double z)
```
    Adds or Subs the given coordinates x, y, z to or from the builder
    
    Specified by:
    
    addCoordinates in interface com.github.shynixn.petblocks.api.persistence.entity.IPosition
    
    Parameters:
    
    x - x
    
    y - y
    
    z - z
    
    Returns:
    
    builder
  - setWorld
```
public LocationBuilder setWorld(org.bukkit.World world)
```
    Sets the world of the builder
    
    Parameters:
    
    world - world
    
    Returns:
    
    builder
  - setWorldName
```
public LocationBuilder setWorldName(String worldName)
```
    Sets the worldName of the builder
    
    Specified by:
    
    setWorldName in interface com.github.shynixn.petblocks.api.persistence.entity.IPosition
    
    Parameters:
    
    worldName - worldName
    
    Returns:
    
    builder
  - setYaw
```
public LocationBuilder setYaw(double yaw)
```
    Sets the yaw of the builder
    
    Specified by:
    
    setYaw in interface com.github.shynixn.petblocks.api.persistence.entity.IPosition
    
    Parameters:
    
    yaw - yaw
    
    Returns:
    
    builder
  - setPitch
```
public LocationBuilder setPitch(double pitch)
```
    Sets the pitch of the builder
    
    Specified by:
    
    setPitch in interface com.github.shynixn.petblocks.api.persistence.entity.IPosition
    
    Parameters:
    
    pitch - pitch
    
    Returns:
    
    builder
  - setX
```
public LocationBuilder setX(double x)
```
    Sets the x coordinate of the builder
    
    Specified by:
    
    setX in interface com.github.shynixn.petblocks.api.persistence.entity.IPosition
    
    Parameters:
    
    x - x
    
    Returns:
    
    builder
  - setY
```
public LocationBuilder setY(double y)
```
    Sets the y coordinate of the builder
    
    Specified by:
    
    setY in interface com.github.shynixn.petblocks.api.persistence.entity.IPosition
    
    Parameters:
    
    y - y
    
    Returns:
    
    builder
  - setZ
```
public LocationBuilder setZ(double z)
```
    Sets the z coordinate of the builder
    
    Specified by:
    
    setZ in interface com.github.shynixn.petblocks.api.persistence.entity.IPosition
    
    Parameters:
    
    z - z
    
    Returns:
    
    builder
  - getYaw
```
public double getYaw()
```
    Returns the yaw of the builder
    
    Specified by:
    
    getYaw in interface com.github.shynixn.petblocks.api.persistence.entity.IPosition
    
    Returns:
    
    yaw
  - getPitch
```
public double getPitch()
```
    Returns the pitch of the builder
    
    Specified by:
    
    getPitch in interface com.github.shynixn.petblocks.api.persistence.entity.IPosition
    
    Returns:
    
    pitch
  - getWorld
```
public org.bukkit.World getWorld()
```
    Returns the BukkitWorld of the builder
    
    Returns:
    
    world
  - getX
```
public double getX()
```
    Returns the x coordinate of the builder
    
    Specified by:
    
    getX in interface com.github.shynixn.petblocks.api.persistence.entity.IPosition
    
    Returns:
    
    x
  - getY
```
public double getY()
```
    Returns the y coordinate of the builder
    
    Specified by:
    
    getY in interface com.github.shynixn.petblocks.api.persistence.entity.IPosition
    
    Returns:
    
    y
  - getZ
```
public double getZ()
```
    Returns the z coordinate of the builder
    
    Specified by:
    
    getZ in interface com.github.shynixn.petblocks.api.persistence.entity.IPosition
    
    Returns:
    
    z
  - getBlockX
```
public int getBlockX()
```
    Returns the x coordinate as int of the builder
    
    Specified by:
    
    getBlockX in interface com.github.shynixn.petblocks.api.persistence.entity.IPosition
    
    Returns:
    
    x
  - getBlockY
```
public int getBlockY()
```
    Returns the y coordinate as int of the builder
    
    Specified by:
    
    getBlockY in interface com.github.shynixn.petblocks.api.persistence.entity.IPosition
    
    Returns:
    
    y
  - getBlockZ
```
public int getBlockZ()
```
    Returns the z coordinate as int of the builder
    
    Specified by:
    
    getBlockZ in interface com.github.shynixn.petblocks.api.persistence.entity.IPosition
    
    Returns:
    
    z
  - getWorldName
```
public String getWorldName()
```
    Returns the worldname of the builder
    
    Specified by:
    
    getWorldName in interface com.github.shynixn.petblocks.api.persistence.entity.IPosition
    
    Returns:
    
    worldName
  - copy
```
public LocationBuilder copy()
```
    Copies the current builder
    
    Returns:
    
    copyOfBuilder
  - toLocation
```
public org.bukkit.Location toLocation()
```
    Converts the builder to a bukkitLocation
    
    Returns:
    
    bukkitLocation
  - toVector
```
public org.bukkit.util.Vector toVector()
```
    Converts the builder to a bukkitVector
    
    Returns:
    
    bukkitVector
  - toAngle
```
public org.bukkit.util.EulerAngle toAngle()
```
    Converts the builder to a bukkitEulerAngle
    
    Returns:
    
    eulerAngle
  - relativePosition
```
public LocationBuilder relativePosition(double distance,
                                        com.github.shynixn.petblocks.api.persistence.entity.IPosition.Direction direction)
```
    Returns the relativePosition to a given direction
    
    Specified by:
    
    relativePosition in interface com.github.shynixn.petblocks.api.persistence.entity.IPosition
    
    Parameters:
    
    distance - distance
    
    direction - direction
    
    Returns:
    
    builder
  - equals
```
public boolean equals(Object arg0)
```
    Checks if 2 builders are equal
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    arg0 - secondBuilder
    
    Returns:
    
    isSame
  - toString
```
public String toString()
```
    Displays the builder as string
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    string
  - serialize
```
public Map<String,Object> serialize()
```
    Serializes the location data to be stored to the filesystem
    
    Specified by:
    
    serialize in interface org.bukkit.configuration.serialization.ConfigurationSerializable
    
    Returns:
    
    serializedContent
  - 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

Class LocationBuilder

Nested Class Summary

Nested classes/interfaces inherited from interface com.github.shynixn.petblocks.api.persistence.entity.IPosition

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LocationBuilder

LocationBuilder

LocationBuilder

LocationBuilder

Method Detail

setCoordinates

setRotation

addCoordinates

setWorld

setWorldName

setYaw

setPitch

setX

setY

setZ

getYaw

getPitch

getWorld

getX

getY

getZ

getBlockX

getBlockY

getBlockZ

getWorldName

copy

toLocation

toVector

toAngle

relativePosition

equals

toString

serialize

getId