AbstractLocation (MythicMobs 4.11.0-SNAPSHOT API)

java.lang.Object
- io.lumine.xikage.mythicmobs.adapters.AbstractLocation

All Implemented Interfaces:: Cloneable

public class AbstractLocation
extends Object
implements Cloneable

Constructor Summary

Constructors
Constructor and Description
`AbstractLocation()`
`AbstractLocation(AbstractWorld world, double x, double y, double z)`
`AbstractLocation(AbstractWorld world, double x, double y, double z, float yaw, float pitch)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AbstractLocation`	`add(AbstractLocation vec)` Adds the location by another.
`AbstractLocation`	`add(AbstractVector vec)` Adds the location by a vector.
`AbstractLocation`	`add(double xA, double yA, double zA)`
`AbstractLocation`	`clone()`
`double`	`distance(AbstractLocation t)`
`double`	`distance2D(AbstractLocation t)`
`double`	`distance2DSquared(AbstractLocation t)`
`double`	`distanceSquared(AbstractLocation t)`
`boolean`	`equals(Object obj)`
`AbstractBiome`	`getBiome()`
`int`	`getBlockX()`
`int`	`getBlockY()`
`int`	`getBlockZ()`
`int`	`getChunkX()`
`int`	`getChunkZ()`
`AbstractVector`	`getDirection()` Gets a unit-vector pointing in the direction that this Location is facing.
`float`	`getPitch()` Gets the pitch of this location, measured in degrees.
`AbstractWorld`	`getWorld()`
`double`	`getX()` Gets the x-coordinate of this location
`double`	`getY()` Gets the y-coordinate of this location
`float`	`getYaw()` Gets the yaw of this location, measured in degrees.
`double`	`getZ()` Gets the z-coordinate of this location
`int`	`hashCode()`
`boolean`	`isLoaded()`
`AbstractLocation`	`multiply(double m)` Performs scalar multiplication, multiplying all components with a scalar.
`void`	`setPitch(float pitch)` Sets the pitch of this location, measured in degrees.
`void`	`setX(double x)` Sets the x-coordinate of this location
`void`	`setY(double y)` Sets the y-coordinate of this location
`void`	`setYaw(float yaw)` Sets the yaw of this location, measured in degrees.
`void`	`setZ(double z)` Sets the z-coordinate of this location
`AbstractLocation`	`subtract(AbstractLocation vec)` Subtracts the location by another.
`AbstractLocation`	`subtract(AbstractVector vec)` Subtracts the location by a vector.
`AbstractLocation`	`subtract(double x, double y, double z)` Subtracts the location by another.
`io.lumine.utils.serialize.Locus`	`toLocus()`
`io.lumine.utils.serialize.Position`	`toPosition()`
`String`	`toString()`
`AbstractVector`	`toVector()` Constructs a new `AbstractVector` based on this Location
`AbstractLocation`	`zero()` Zero this location's components.

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

- Constructor Detail
  - AbstractLocation
```
public AbstractLocation()
```
  - AbstractLocation
```
public AbstractLocation(AbstractWorld world,
                        double x,
                        double y,
                        double z)
```
  - AbstractLocation
```
public AbstractLocation(AbstractWorld world,
                        double x,
                        double y,
                        double z,
                        float yaw,
                        float pitch)
```
- Method Detail
  - toPosition
```
public io.lumine.utils.serialize.Position toPosition()
```
  - toLocus
```
public io.lumine.utils.serialize.Locus toLocus()
```
  - setX
```
public void setX(double x)
```
    Sets the x-coordinate of this location
    
    Parameters:
    
    x - X-coordinate
  - getX
```
public double getX()
```
    Gets the x-coordinate of this location
    
    Returns:
    
    x-coordinate
  - setY
```
public void setY(double y)
```
    Sets the y-coordinate of this location
    
    Parameters:
    
    y - y-coordinate
  - getY
```
public double getY()
```
    Gets the y-coordinate of this location
    
    Returns:
    
    y-coordinate
  - setZ
```
public void setZ(double z)
```
    Sets the z-coordinate of this location
    
    Parameters:
    
    z - z-coordinate
  - getZ
```
public double getZ()
```
    Gets the z-coordinate of this location
    
    Returns:
    
    z-coordinate
  - getBlockX
```
public int getBlockX()
```
  - getBlockY
```
public int getBlockY()
```
  - getBlockZ
```
public int getBlockZ()
```
  - getChunkX
```
public int getChunkX()
```
  - getChunkZ
```
public int getChunkZ()
```
  - getYaw
```
public float getYaw()
```
    Gets the yaw of this location, measured in degrees.
    - A yaw of 0 or 360 represents the positive z direction.
    - A yaw of 180 represents the negative z direction.
    - A yaw of 90 represents the negative x direction.
    - A yaw of 270 represents the positive x direction.
    Increasing yaw values are the equivalent of turning to your right-facing, increasing the scale of the next respective axis, and decreasing the scale of the previous axis.
    Returns:
    
    the rotation's yaw
  - setYaw
```
public void setYaw(float yaw)
```
    Sets the yaw of this location, measured in degrees.
    - A yaw of 0 or 360 represents the positive z direction.
    - A yaw of 180 represents the negative z direction.
    - A yaw of 90 represents the negative x direction.
    - A yaw of 270 represents the positive x direction.
    Increasing yaw values are the equivalent of turning to your right-facing, increasing the scale of the next respective axis, and decreasing the scale of the previous axis.
    Parameters:
    
    yaw - new rotation's yaw
  - getPitch
```
public float getPitch()
```
    Gets the pitch of this location, measured in degrees.
    - A pitch of 0 represents level forward facing.
    - A pitch of 90 represents downward facing, or negative y direction.
    - A pitch of -90 represents upward facing, or positive y direction.
    Increasing pitch values the equivalent of looking down.
    Returns:
    
    the incline's pitch
  - setPitch
```
public void setPitch(float pitch)
```
    Sets the pitch of this location, measured in degrees.
    - A pitch of 0 represents level forward facing.
    - A pitch of 90 represents downward facing, or negative y direction.
    - A pitch of -90 represents upward facing, or positive y direction.
    Increasing pitch values the equivalent of looking down.
    Parameters:
    
    pitch - new incline's pitch
  - getWorld
```
public AbstractWorld getWorld()
```
  - distance
```
public double distance(AbstractLocation t)
                throws IllegalArgumentException
```
    Throws:
    
    IllegalArgumentException
  - distanceSquared
```
public double distanceSquared(AbstractLocation t)
                       throws IllegalArgumentException
```
    Throws:
    
    IllegalArgumentException
  - distance2D
```
public double distance2D(AbstractLocation t)
```
  - distance2DSquared
```
public double distance2DSquared(AbstractLocation t)
```
  - add
```
public AbstractLocation add(double xA,
                            double yA,
                            double zA)
```
  - getDirection
```
public AbstractVector getDirection()
```
    Gets a unit-vector pointing in the direction that this Location is facing.
    
    Returns:
    
    a vector pointing the direction of this location's pitch and yaw
  - add
```
public AbstractLocation add(AbstractLocation vec)
```
    Adds the location by another.
    
    Parameters:
    
    vec - The other location
    
    Returns:
    
    the same location
    
    Throws:
    
    IllegalArgumentException - for differing worlds
    
    See Also:
    
    AbstractVector
  - add
```
public AbstractLocation add(AbstractVector vec)
```
    Adds the location by a vector.
    
    Parameters:
    
    vec - Vector to use
    
    Returns:
    
    the same location
    
    See Also:
    
    AbstractVector
  - subtract
```
public AbstractLocation subtract(double x,
                                 double y,
                                 double z)
```
    Subtracts the location by another. Not world-aware and orientation independent.
    
    Parameters:
    
    x - X coordinate
    
    y - Y coordinate
    
    z - Z coordinate
    
    Returns:
    
    the same location
    
    See Also:
    
    AbstractVector
  - subtract
```
public AbstractLocation subtract(AbstractLocation vec)
```
    Subtracts the location by another.
    
    Parameters:
    
    vec - The other location
    
    Returns:
    
    the same location
    
    Throws:
    
    IllegalArgumentException - for differing worlds
    
    See Also:
    
    AbstractVector
  - subtract
```
public AbstractLocation subtract(AbstractVector vec)
```
    Subtracts the location by a vector.
    
    Parameters:
    
    vec - The vector to use
    
    Returns:
    
    the same location
    
    See Also:
    
    AbstractVector
  - multiply
```
public AbstractLocation multiply(double m)
```
    Performs scalar multiplication, multiplying all components with a scalar. Not world-aware.
    
    Parameters:
    
    m - The factor
    
    Returns:
    
    the same location
    
    See Also:
    
    AbstractVector
  - zero
```
public AbstractLocation zero()
```
    Zero this location's components. Not world-aware.
    
    Returns:
    
    the same location
    
    See Also:
    
    AbstractVector
  - toVector
```
public AbstractVector toVector()
```
    Constructs a new AbstractVector based on this Location
    
    Returns:
    
    New Vector containing the coordinates represented by this Location
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public AbstractLocation clone()
```
    Overrides:
    
    clone in class Object
  - isLoaded
```
public boolean isLoaded()
```
  - getBiome
```
public AbstractBiome getBiome()
```

Class AbstractLocation

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractLocation

AbstractLocation

AbstractLocation

Method Detail

toPosition

toLocus

setX

getX

setY

getY

setZ

getZ

getBlockX

getBlockY

getBlockZ

getChunkX

getChunkZ

getYaw

setYaw

getPitch

setPitch

getWorld

distance

distanceSquared

distance2D

distance2DSquared

add

getDirection

add

add

subtract

subtract

subtract

multiply

zero

toVector

equals

toString

hashCode

clone

isLoaded

getBiome