nova/xyz.xenondevs.nova.util/BlockSideMap

BlockSideMap

data class BlockSideMap<out V>(val front: V, val left: V, val back: V, val right: V, val top: V, val bottom: V)

An immutable map from each BlockSide to a value of type V. Keys cannot be absent, use null to model absence instead.

Constructors

BlockSideMap

constructor(front: V, left: V, back: V, right: V, top: V, bottom: V)

constructor(all: V)

Types

Companion

object Companion

Properties

val back: V

val bottom: V

val front: V

val left: V

val right: V

val top: V

val values: Collection<V & Any>

A list of all non-null values in this map.

Functions

filter

inline fun filter(filter: (value: V & Any) -> Boolean): BlockSideMap<V?>

Returns a new BlockSideMap where values not matching filter are replaced with null.

inline fun filter(filter: (side: BlockSide, value: V & Any) -> Boolean): BlockSideMap<V?>

Returns a new BlockSideMap where values not matching filter are replaced with null. The filter also receives the BlockSide.

forEach

inline fun forEach(run: (value: V) -> Unit)

Runs run for each value in this map.

inline fun forEach(run: (side: BlockSide, value: V) -> Unit)

Runs run for each side-value pair in this map.

forEachNonNull

inline fun <V : Any> BlockSideMap<V?>.forEachNonNull(run: (value: V) -> Unit)

Runs run for each non-null value in this BlockSideMap.

inline fun <V : Any> BlockSideMap<V?>.forEachNonNull(run: (side: BlockSide, value: V) -> Unit)

Runs run for each non-null value in this BlockSideMap, providing both the BlockSide and value.

get

operator fun get(side: BlockSide): V

Gets the value for the given side.

map

inline fun <R> map(map: (value: V) -> R): BlockSideMap<R>

Returns a new BlockSideMap with each value transformed by map.

inline fun <R> map(map: (side: BlockSide, value: V) -> R): BlockSideMap<R>

Returns a new BlockSideMap with each value transformed by map, which also receives the BlockSide.

mapToBlockSideSet

inline fun mapToBlockSideSet(map: (value: V) -> Boolean): BlockSideSet

Returns a BlockSideSet containing all sides for which map returns true.

toCubeFaceMap

fun toCubeFaceMap(front: BlockFace): CubeFaceMap<V>

Converts this BlockSideMap to a CubeFaceMap given the front direction.

with

fun with(side: BlockSide, value: V): BlockSideMap<V>

Returns a copy of this map with the value for side replaced by value.