Skip to main content

ItemPropertiesGetBundleProperties

Callable

  • Copy and extract all ItemBundle.Property keys from the passed item, returning them in addition to all extended item options associated with the item's current state

    Parameters

    • item: Item

      The item whose properties are to be extracted

    • optionaloptions: { allowLocks: boolean; omit: Iterable<keyof ItemProperties, any, any> } = undefined
      • allowLocks: boolean

        Whether to return lock-specific options and properties if present

      • omit: Iterable<keyof ItemProperties, any, any>

        Properties that should always be omitted

    Returns { extendedOptions: ExtendedItemOptionUnion[]; properties: Set<keyof ItemProperties> }

    The filtered item property names and the matching extended item options