bettermodel-mod-api/kr.toxicity.model.api.mod.platform/ModLocation

ModLocation

class ModLocation : Record, PlatformLocation

Represents a Mod location wrapped as a PlatformLocation.

Since

2.0.0

Parameters

level

the NMS level

the x coordinate

the y coordinate

the z coordinate

pitch

the pitch

yaw

the yaw

Constructors

ModLocation

@ApiStatus.Internal

constructor(@Nullable level: @Nullable Level, x: Double, y: Double, z: Double, pitch: Float, yaw: Float)

Functions

add

@NotNull

open fun add(x: Double, y: Double, z: Double): @NotNull PlatformLocation

distance

open fun distance(other: @NotNull PlatformLocation): Double

distanceSquared

open fun distanceSquared(other: @NotNull PlatformLocation): Double

equals

abstract fun equals(p: Any): Boolean

hashCode

abstract fun hashCode(): Int

@NotNull

open fun of(@NotNull entity: @NotNull Entity): @NotNull ModLocation

Creates a ModLocation from an entity's position.

@NotNull

open fun of(@Nullable level: @Nullable Level, position: Vec3): @NotNull ModLocation

Creates a ModLocation from the position vector with zero pitch and yaw.

@NotNull

open fun of(@Nullable level: @Nullable Level, x: Double, y: Double, z: Double): @NotNull ModLocation

Creates a ModLocation from the coordinates with zero pitch and yaw.

@NotNull

open fun of(@Nullable level: @Nullable Level, position: Vec3, pitch: Float, yaw: Float): @NotNull ModLocation

Creates a ModLocation from the position vector.

@NotNull

open fun of(@Nullable level: @Nullable Level, x: Double, y: Double, z: Double, pitch: Float, yaw: Float): @NotNull ModLocation

Creates a ModLocation from the coordinates.

ofEye

@NotNull

open fun ofEye(@NotNull entity: @NotNull Entity): @NotNull ModLocation

Creates a ModLocation from an entity's eye position.

pitch

abstract fun pitch(): Float

task

@Nullable

open fun task(@NotNull runnable: @NotNull Runnable): @Nullable ModelTask

taskLater

@Nullable

open fun taskLater(delay: Long, @NotNull runnable: @NotNull Runnable): @Nullable ModelTask

toString

abstract fun toString(): String

world

@NotNull

open fun world(): @NotNull PlatformWorld

abstract fun x(): Double

abstract fun y(): Double

yaw

abstract fun yaw(): Float

abstract fun z(): Double