BitSet128
Type Aliases
Section titled “Type Aliases”SerializedBitSet128
Section titled “SerializedBitSet128”SerializedBitSet128 =
Readonly<LuaMap<string,unknown>> &object
Defined in: packages/isaacscript-common/src/functions/bitSet128.ts:12
Type Declaration
Section titled “Type Declaration”__serializedBitSet128Brand
Section titled “__serializedBitSet128Brand”
readonly__serializedBitSet128Brand:symbol
__kind
Section titled “__kind”
readonly__kind:CopyableIsaacAPIClassType.BIT_SET_128
Functions
Section titled “Functions”copyBitSet128()
Section titled “copyBitSet128()”copyBitSet128(
bitSet128):BitSet128
Defined in: packages/isaacscript-common/src/functions/bitSet128.ts:21
Helper function to copy a BitSet128 Isaac API class.
Parameters
Section titled “Parameters”bitSet128
Section titled “bitSet128”BitSet128
Returns
Section titled “Returns”BitSet128
deserializeBitSet128()
Section titled “deserializeBitSet128()”deserializeBitSet128(
bitSet128):BitSet128
Defined in: packages/isaacscript-common/src/functions/bitSet128.ts:38
Helper function to convert a SerializedBitSet128 object to a normal BitSet128 object. (This
is used by the save data manager when reading data from the “save#.dat” file.)
Parameters
Section titled “Parameters”bitSet128
Section titled “bitSet128”Returns
Section titled “Returns”BitSet128
isBitSet128()
Section titled “isBitSet128()”isBitSet128(
object):object is BitSet128
Defined in: packages/isaacscript-common/src/functions/bitSet128.ts:62
Helper function to check if something is an instantiated BitSet128 object.
Parameters
Section titled “Parameters”object
Section titled “object”unknown
Returns
Section titled “Returns”object is BitSet128
isSerializedBitSet128()
Section titled “isSerializedBitSet128()”isSerializedBitSet128(
object):object is SerializedBitSet128
Defined in: packages/isaacscript-common/src/functions/bitSet128.ts:70
Used to determine is the given table is a serialized BitSet128 object created by the deepCopy
function.
Parameters
Section titled “Parameters”object
Section titled “object”unknown
Returns
Section titled “Returns”object is SerializedBitSet128
serializeBitSet128()
Section titled “serializeBitSet128()”serializeBitSet128(
bitSet128):SerializedBitSet128
Defined in: packages/isaacscript-common/src/functions/bitSet128.ts:86
Helper function to convert a BitSet128 object to a SerializedBitSet128 object. (This is used
by the save data manager when writing data from the “save#.dat” file.)
Parameters
Section titled “Parameters”bitSet128
Section titled “bitSet128”BitSet128