Class PointUtil`Abstract`

Index

Constructors

Methods

randomPointOnCircle randomPointInCircle rangeCheck getPointsOnCircle

Constructors

constructor

new PointUtil(): PointUtil
Returns PointUtil

Methods

`Static`randomPointOnCircle

randomPointOnCircle(origin: Vec3 | Player, radius: number): Vec3
Returns a random point on the edge of a circle around a player's or Vec3 location.
Parameters
- origin: Vec3 | Player
  The center point, either a Vec3 or Player
- radius: number
  The radius of the circle
Returns Vec3
A Vec3 on the edge of the circle
- Defined in src/utils/point_util.ts:14

`Static`randomPointInCircle

randomPointInCircle(origin: Vec3, radius: number): Vec3
Returns a random point within a circle radius around an origin Vec3.
Parameters
- origin: Vec3
  The center of the circle
- radius: number
  The radius within which to generate the point
Returns Vec3
A Vec3 randomly positioned within the circle
- Defined in src/utils/point_util.ts:34

`Static`rangeCheck

rangeCheck(loc: Vec3, dimension: Dimension): number
Returns the distance to the closest player from a given location in the dimension.
Parameters
- loc: Vec3
  The location to check from
- dimension: Dimension
  The dimension in which to perform the search
Returns number
Distance to the nearest player
- Defined in src/utils/point_util.ts:54

`Static`getPointsOnCircle

getPointsOnCircle(origin: Vec3, radius: number, count: number): Vec3[]
Returns an array of evenly spaced points around a center in a circle.
Parameters
- origin: Vec3
  The center of the circle
- radius: number
  The radius of the circle
- count: number
  The number of points to return
Returns Vec3[]
An array of Vec3 points on the circle
- Defined in src/utils/point_util.ts:71