Function shallowMapProperty

shallowMapProperty<K, V extends ShallowObject>(
    initialEntries?: Map<K, V>,
    isUnreliable?: boolean,
    meta?: Many<
        [
            "tuple",
            [
                payload: [
                    "object_raw",
                    (
                        | ["full", ["boolean"]]
                        | [
                            "changes",
                            [
                                "array",
                                ((...) extends (...) ? (...) : (...)) extends true
                                    ? [(...), (...), (...), (...)]
                                    : [(...), (...)],
                            ],
                        ]
                    )[],
                ],
            ],
            undefined,
        ],
    >,
    name?: Caller<"text">,
    uuid?: Caller<"uuid">,
): ShallowMapPropertyPacket<K, V>
Create a ShallowMapPropertyPacket, where updates are diff-based and only the first level of object values are checked for changes with strict equality (===). Metadata can be provided to specify how the data should be serialized.
Type Parameters
- K
- V extends ShallowObject
Parameters
- OptionalinitialEntries: Map<K, V>
  Initial map entries to populate the property with
- OptionalisUnreliable: boolean
  Whether the property should be unreliable. Default is false.
- Optionalmeta: Many<
      [
          "tuple",
          [
              payload: [
                  "object_raw",
                  (
                      | ["full", ["boolean"]]
                      | [
                          "changes",
                          [
                              "array",
                              ((...) extends (...) ? (...) : (...)) extends true
                                  ? [(...), (...), (...), (...)]
                                  : [(...), (...)],
                          ],
                      ]
                  )[],
              ],
          ],
          undefined,
      ],
  >
  Metadata for serialization
- Optionalname: Caller<"text">
- Optionaluuid: Caller<"uuid">
Returns ShallowMapPropertyPacket<K, V>
Metadata
macro
- Defined in PacketMacro.ts:149

Function shallowMapProperty

Type Parameters

Parameters

Returns ShallowMapPropertyPacket<K, V>

Metadata

Settings