kitejs/io.github.yuroyami.kitejs/SlotMap

SlotMap

The property table behind a ScriptableObject. It is iterable but is not a Map, because a real map brings overhead this does not need.

The shape of this interface is odd and its dealings with ScriptableObject are involved. Upstream says plainly that tidier versions of it cost real performance, so it stays as it is.

Inheritors

CompoundOperationMap

EmbeddedSlotMap

HashSlotMap

Types

SlotComputer

fun interface SlotComputer<S : Slot>

Decides what a key maps to, given whatever is already there. Returning null removes it.

Functions

add

abstract fun add(owner: SlotMapOwner?, newSlot: Slot)

Puts a slot straight in. Both its name and its index hash have to be set already. ScriptableObject normally goes through modify instead.

compute

open fun <S : Slot> compute(owner: SlotMapOwner, key: Any?, index: Int, compute: SlotMap.SlotComputer<S>): S?

Replaces what key maps to with whatever compute returns: null removes the mapping, and anything else replaces or creates it. If compute throws, nothing changes.