Package ch.njol.skript.util

Class Direction

java.lang.Object

ch.njol.skript.util.Direction

All Implemented Interfaces:

YggdrasilSerializable, YggdrasilSerializable.YggdrasilRobustSerializable

public class Direction
extends Object
implements YggdrasilSerializable.YggdrasilRobustSerializable

Nested Class Summary

Nested classes/interfaces inherited from interface ch.njol.yggdrasil.YggdrasilSerializable

YggdrasilSerializable.YggdrasilExtendedSerializable, YggdrasilSerializable.YggdrasilRobustEnum, YggdrasilSerializable.YggdrasilRobustSerializable

Field Summary

Fields

Modifier and Type	Field	Description
static final BlockFace	BF_X
static final BlockFace	BF_Y
static final BlockFace	BF_Z
static final Direction	IDENTITY	A direction that points in the direction of the object(s) passed to the various getDirection methods.
static final double	IGNORE_PITCH	Use this as pitch to force a horizontal direction
static final Noun	m_meter
static final Direction	ZERO	A direction that doesn't point anywhere, i.e.

Constructor Summary

Constructors

Constructor	Description
Direction()
Direction(double[] mod)
Direction(double pitch, double yaw, double length)
Direction(BlockFace f, double length)
Direction(Vector v)

Method Summary

Modifier and Type	Method	Description
static Expression<Location>	combine(Expression<? extends Direction> dirs, Expression<? extends Location> locs)
static @Nullable Direction	deserialize(String s)	Deprecated.
boolean	equals(@Nullable Object obj)
boolean	excessiveField(@NotNull Fields.FieldContext field)	Called if a field was read from stream which does not exist in this class.
Vector	getDirection()
Vector	getDirection(Block b)
Vector	getDirection(Entity e)
Vector	getDirection(Location l)
static BlockFace	getFacing(double yaw, double pitch)
static BlockFace	getFacing(Block b)
static BlockFace	getFacing(Location l, boolean horizontal)
static BlockFace	getFacing(Vector v, boolean horizontal)
static float	getPitch(double pitch)
Location	getRelative(Block b)
Location	getRelative(Entity e)
Location	getRelative(Location l)
static Location[]	getRelatives(Block[] blocks, Direction[] directions)
static Location[]	getRelatives(Location[] locations, Direction[] directions)
static float	getYaw(double yaw)
int	hashCode()
boolean	incompatibleField(@NotNull Field f, @NotNull Fields.FieldContext value)	Called if a field that was read from stream is of an incompatible type to the existing field in this class.
boolean	isRelative()
boolean	missingField(@NotNull Field field)	Called if a field was not found in the stream.
static double	pitchToRadians(float pitch)
String	toString()
static String	toString(double[] mod)
static String	toString(double pitch, double yaw, double length)
static String	toString(Vector dir)
static double	yawToRadians(float yaw)

Methods inherited from class java.lang.Object

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

Field Details

ZERO

public static final Direction ZERO

A direction that doesn't point anywhere, i.e. equal to 'at'.

IDENTITY

public static final Direction IDENTITY

A direction that points in the direction of the object(s) passed to the various getDirection methods.

BF_X

public static final BlockFace BF_X

BF_Y

public static final BlockFace BF_Y

BF_Z

public static final BlockFace BF_Z

m_meter

public static final Noun m_meter

IGNORE_PITCH

public static final double IGNORE_PITCH

Use this as pitch to force a horizontal direction

See Also:

• Constant Field Values

Constructor Details

Direction

public Direction(double[] mod)

Direction

public Direction()

Direction

public Direction(double pitch,
 double yaw,
 double length)

Direction

public Direction(BlockFace f,
 double length)

Direction

public Direction(Vector v)

Method Details

getRelative

public Location getRelative(Location l)

getRelative

public Location getRelative(Entity e)

getRelative

public Location getRelative(Block b)

getDirection

public Vector getDirection()

getDirection

public Vector getDirection(Location l)

getDirection

public Vector getDirection(Entity e)

getDirection

public Vector getDirection(Block b)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(@Nullable
 @Nullable Object obj)

Overrides:

equals in class Object

isRelative

public boolean isRelative()

Returns:

Whether this Direction rotates the direction of a given object or only translates it.

pitchToRadians

public static double pitchToRadians(float pitch)

Parameters:

pitch - Notch-pitch

Returns:

Mathematical pitch oriented from x/z to y axis (with the origin in the x/z plane)

getPitch

public static float getPitch(double pitch)

Parameters:

pitch - Mathematical pitch oriented from x/z to y axis (with the origin in the x/z plane)

Returns:

Notch-pitch

yawToRadians

public static double yawToRadians(float yaw)

Parameters:

yaw - Notch-yaw

Returns:

Mathematical yaw oriented from x to z axis (with the origin at the x axis)

getYaw

public static float getYaw(double yaw)

Parameters:

yaw - Mathematical yaw oriented from x to z axis (with the origin at the x axis)

Returns:

Notch-yaw

getFacing

public static BlockFace getFacing(Block b)

Parameters:

b -

Returns:

The facing of the block or BlockFace.SELF if the block doesn't have a facing.

getFacing

public static BlockFace getFacing(double yaw,
 double pitch)

getFacing

public static BlockFace getFacing(Location l,
 boolean horizontal)

getFacing

public static BlockFace getFacing(Vector v,
 boolean horizontal)

getRelatives

public static Location[] getRelatives(Block[] blocks,
 Direction[] directions)

getRelatives

public static Location[] getRelatives(Location[] locations,
 Direction[] directions)

toString

public String toString()

Overrides:

toString in class Object

toString

public static String toString(double pitch,
 double yaw,
 double length)

toString

public static String toString(double[] mod)

toString

public static String toString(Vector dir)

deserialize

@Deprecated
@Nullable
public static @Nullable Direction deserialize(String s)

Deprecated.

combine

public static Expression<Location> combine(Expression<? extends Direction> dirs,
 Expression<? extends Location> locs)

incompatibleField

public boolean incompatibleField(@NotNull
 @NotNull Field f,
 @NotNull
 @NotNull Fields.FieldContext value)
                          throws StreamCorruptedException

Description copied from interface: YggdrasilSerializable.YggdrasilRobustSerializable

Called if a field that was read from stream is of an incompatible type to the existing field in this class.

Specified by:

incompatibleField in interface YggdrasilSerializable.YggdrasilRobustSerializable

Parameters:

f - The Java field

value - The field read from stream

Returns:

Whether the field was handled. If false, yggdrasil.incompatibleField(this, field, value) will be called.

Throws:

StreamCorruptedException

excessiveField

public boolean excessiveField(@NotNull
 @NotNull Fields.FieldContext field)
                       throws StreamCorruptedException

Description copied from interface: YggdrasilSerializable.YggdrasilRobustSerializable

Called if a field was read from stream which does not exist in this class.

Specified by:

excessiveField in interface YggdrasilSerializable.YggdrasilRobustSerializable

Parameters:

field - The field read from stream

Returns:

Whether the field was handled. If false, yggdrasil.excessiveField(this, field) will be called.

Throws:

StreamCorruptedException

missingField

public boolean missingField(@NotNull
 @NotNull Field field)
                     throws StreamCorruptedException

Description copied from interface: YggdrasilSerializable.YggdrasilRobustSerializable

Called if a field was not found in the stream.

Specified by:

missingField in interface YggdrasilSerializable.YggdrasilRobustSerializable

Parameters:

field - The field that did not occur in the stream

Returns:

Whether the field was handled (e.g. true if the default value is fine). If false, yggdrasil.missingField(this, field) will be called.

Throws:

StreamCorruptedException