endstone.util

Multi and single purpose classes.

Classes

Name	Description
`SocketAddress`	Represents an IP Socket Address (hostname + port number).
`Vector`	Represents a 3-dimensional vector.

`class`SocketAddress

SocketAddress()

Represents an IP Socket Address (hostname + port number).

Attributes

Name	Type	Description
`hostname`	`str`	Gets the hostname.
`port`	`int`	Gets the port number.

`attr`hostnameproperty

hostname: str

Gets the hostname.

`attr`portproperty

port: int

Gets the port number.

`class`Vector

Vector()

Represents a 3-dimensional vector.

Methods

Name	Description
`angle`	Gets the angle between this vector and another in radians.
`cross_product`	Calculates the cross-product of this vector with another.
`distance`	The distance between this Vector and another
`distance_squared`	The squared distance between this Vector and another
`dot`	Calculates the dot product of this vector with another.
`is_in_aabb`	Returns whether this vector is in an axis-aligned bounding box.
`is_in_sphere`	Returns whether this vector is within a sphere.
`midpoint`	Gets a new midpoint vector between this vector and another.
`normalize`	Converts this vector to a unit vector (a vector with length of 1).
`normalize_zero`	Converts each component of value `-0.0` to `0.0`
`rotate_around_axis`	Rotates the vector around a given arbitrary axis in 3-dimensional space.
`rotate_around_x`	Rotates the vector around the x-axis.
`rotate_around_y`	Rotates the vector around the y-axis.
`rotate_around_z`	Rotates the vector around the z-axis.
`zero`	Zero this vector's components.

Attributes

Name	Type	Description
`block_x`	`int`	Gets the floored value of the X component, indicating the block that this vector is contained with.
`block_y`	`int`	Gets the floored value of the Y component, indicating the block that this vector is contained with.
`block_z`	`int`	Gets the floored value of the Z component, indicating the block that this vector is contained with.
`is_normalized`	`bool`	Returns if a vector is normalized.
`is_zero`	`bool`	Check whether or not each component of this vector is equal to 0.
`length`	`float`	The magnitude of the Vector
`length_squared`	`float`	The squared magnitude of the Vector
`x`	`float`	The X component of the vector
`y`	`float`	The Y component of the vector
`z`	`float`	The Z component of the vector

`attr`block_xproperty

block_x: int

Gets the floored value of the X component, indicating the block that this vector is contained with.

`attr`block_yproperty

block_y: int

Gets the floored value of the Y component, indicating the block that this vector is contained with.

`attr`block_zproperty

block_z: int

Gets the floored value of the Z component, indicating the block that this vector is contained with.

`attr`is_normalizedproperty

is_normalized: bool

Returns if a vector is normalized.

`attr`is_zeroproperty

is_zero: bool

Check whether or not each component of this vector is equal to 0.

`attr`lengthproperty

length: float

The magnitude of the Vector

`attr`length_squaredproperty

length_squared: float

The squared magnitude of the Vector

`attr`xproperty

x: float

The X component of the vector

`attr`yproperty

y: float

The Y component of the vector

`attr`zproperty

z: float

The Z component of the vector

`meth`angle

angle(other: Vector) -> float

Gets the angle between this vector and another in radians.

`meth`cross_product

cross_product(other: Vector) -> Vector

Calculates the cross-product of this vector with another.

`meth`distance

distance(other: Vector) -> float

The distance between this Vector and another

`meth`distance_squared

distance_squared(other: Vector) -> float

The squared distance between this Vector and another

`meth`dot

dot(other: Vector) -> float

Calculates the dot product of this vector with another.

`meth`is_in_aabb

is_in_aabb(min: Vector, max: Vector) -> bool

Returns whether this vector is in an axis-aligned bounding box.

`meth`is_in_sphere

is_in_sphere(origin: Vector, radius: float) -> bool

Returns whether this vector is within a sphere.

`meth`midpoint

midpoint(other: Vector) -> Vector

Gets a new midpoint vector between this vector and another.

`meth`normalize

normalize() -> Vector

Converts this vector to a unit vector (a vector with length of 1).

`meth`normalize_zero

normalize_zero() -> Vector

Converts each component of value -0.0 to 0.0

`meth`rotate_around_axis

rotate_around_axis(axis: Vector, angle: float, normalize: bool = True) -> Vector

Rotates the vector around a given arbitrary axis in 3-dimensional space.

`meth`rotate_around_x

rotate_around_x(angle: float) -> Vector

Rotates the vector around the x-axis.

`meth`rotate_around_y

rotate_around_y(angle: float) -> Vector

Rotates the vector around the y-axis.

`meth`rotate_around_z

rotate_around_z(angle: float) -> Vector

Rotates the vector around the z-axis.

`meth`zero

zero() -> Vector

Zero this vector's components.

classSocketAddress

attrhostnameproperty

attrportproperty

classVector

attrblock_xproperty

attrblock_yproperty

attrblock_zproperty

attris_normalizedproperty

attris_zeroproperty

attrlengthproperty

attrlength_squaredproperty

attrxproperty

attryproperty

attrzproperty

methangle

methcross_product

methdistance

methdistance_squared

methdot

methis_in_aabb

methis_in_sphere

methmidpoint

methnormalize

methnormalize_zero

methrotate_around_axis

methrotate_around_x

methrotate_around_y

methrotate_around_z

methzero

On this page