nova/xyz.xenondevs.nova.util/CubeFaceSet

CubeFaceSet

An immutable set of BlockFace values (of the cube faces BlockFace.NORTH, BlockFace.EAST, BlockFace.SOUTH, BlockFace.WEST, BlockFace.UP, BlockFace.DOWN) stored as a bitmask in a single Byte.

Constructors

CubeFaceSet

constructor(data: Int)

Creates a new CubeFaceSet from the lowest six bits of data.

constructor(north: Boolean = false, east: Boolean = false, south: Boolean = false, west: Boolean = false, up: Boolean = false, down: Boolean = false)

Creates a new CubeFaceSet with the faces that are set to true.

Types

Companion

object Companion

Properties

data

val data: Byte

Functions

and

infix fun and(other: CubeFaceSet): CubeFaceSet

Returns a new CubeFaceSet that is the intersection of this set and other.

associateWith

inline fun <V> associateWith(valueSelector: (BlockFace) -> V): CubeFaceMap<V?>

Returns a CubeFaceMap where each face in this set is associated with the value produced by valueSelector, and all other faces are null.

contains

operator fun contains(face: BlockFace): Boolean

Checks whether face is contained in this set.

forEach

inline fun forEach(action: (BlockFace) -> Unit)

Runs action for each BlockFace contained in this set.

isEmpty

fun isEmpty(): Boolean

Checks whether this set contains no faces.

isNotEmpty

fun isNotEmpty(): Boolean

Checks whether this set contains at least one face.

map

inline fun <V> map(transform: (BlockFace) -> V): List<V>

Returns a list of results from applying transform to each BlockFace in this set.

minus

operator fun minus(face: BlockFace): CubeFaceSet

Returns a new CubeFaceSet with face removed.

operator fun minus(other: CubeFaceSet): CubeFaceSet

Returns a new CubeFaceSet with all faces in other removed.

plus

operator fun plus(face: BlockFace): CubeFaceSet

Returns a new CubeFaceSet with face added.

operator fun plus(other: CubeFaceSet): CubeFaceSet

Returns a new CubeFaceSet that is the union of this set and other.

toBlockSideSet

fun toBlockSideSet(front: BlockFace): BlockSideSet

Converts this CubeFaceSet to a BlockSideSet given the front direction.