Table of Contents

Table of Contents

FlexScript Class - Storage.QueryFlags

Storage.QueryFlags

Description

Enumerates possible flags that can be passed as the flags parameter into Storage.System.findSlot(), Storage.System.querySlots(), Storage.System.findItem(), or Storage.System.queryItems().

By default Storage.System.findSlot(), and Storage.System.querySlots() will only look at storable slots. Similarly, Storage.System.findItem(), and Storage.System.queryItems() will exclude all inbound and outbound items by default. These flags allow you to better customize which slots/items should be queried.

Each flag is a bit field, meaning different flags can be bitwise-ORed together to include/exclude the desired slots/items.

Static Properties

AllItems Valid only in findItem() and queryItems(). Signifies that all items should be included in the query. This value is a the same as
QueryFlags.InboundItems | QueryFlags.OutboundItems
.
AllSlots Valid only in findSlot() and querySlots(). Signifies that all slots should be included in the query. This flag is the same as UnstorableSlots.
ExcludeStorableSlots Valid only in findSlot() and querySlots(). Signifies that storable slots should be excluded from the query.
ExcludeStoredItems Valid only in findItem() and queryItems(). Signifies that stored items (items that are neither inbound nor outbound) should be excluded from the query.
InboundItems Valid only in findItem() and queryItems(). Signifies that inbound items should be included in the query.
Limit1 Limits the results of querySlots() and queryItems() to a single result. findSlot() and findItem() forward to querySlots() and queryItems() respectively, automatically asserting this flag. As such, generally you do not need to use this flag, because you can just call findSlot() or findItem().
OutboundItems Valid only in findItem() and queryItems(). Signifies that outbound items should be included in the query.
UnstorableSlots Valid only in findSlot() and querySlots(). Signifies that unstorable slots should be included in the query.

Details

Do no remove, this fixes the anchor on doc.flexsim.com

Storage.QueryFlags.AllItems

static readonly int AllItems

Description

Valid only in findItem() and queryItems(). Signifies that all items should be included in the query. This value is a the same as

QueryFlags.InboundItems | QueryFlags.OutboundItems
.

Do no remove, this fixes the anchor on doc.flexsim.com

Storage.QueryFlags.AllSlots

static readonly int AllSlots

Description

Valid only in findSlot() and querySlots(). Signifies that all slots should be included in the query. This flag is the same as UnstorableSlots.

Do no remove, this fixes the anchor on doc.flexsim.com

Storage.QueryFlags.ExcludeStorableSlots

static readonly int ExcludeStorableSlots

Description

Valid only in findSlot() and querySlots(). Signifies that storable slots should be excluded from the query.

Do no remove, this fixes the anchor on doc.flexsim.com

Storage.QueryFlags.ExcludeStoredItems

static readonly int ExcludeStoredItems

Description

Valid only in findItem() and queryItems(). Signifies that stored items (items that are neither inbound nor outbound) should be excluded from the query.

Do no remove, this fixes the anchor on doc.flexsim.com

Storage.QueryFlags.InboundItems

static readonly int InboundItems

Description

Valid only in findItem() and queryItems(). Signifies that inbound items should be included in the query.

Do no remove, this fixes the anchor on doc.flexsim.com

Storage.QueryFlags.Limit1

static readonly int Limit1

Description

Limits the results of querySlots() and queryItems() to a single result. findSlot() and findItem() forward to querySlots() and queryItems() respectively, automatically asserting this flag. As such, generally you do not need to use this flag, because you can just call findSlot() or findItem().

Do no remove, this fixes the anchor on doc.flexsim.com

Storage.QueryFlags.OutboundItems

static readonly int OutboundItems

Description

Valid only in findItem() and queryItems(). Signifies that outbound items should be included in the query.

Do no remove, this fixes the anchor on doc.flexsim.com

Storage.QueryFlags.UnstorableSlots

static readonly int UnstorableSlots

Description

Valid only in findSlot() and querySlots(). Signifies that unstorable slots should be included in the query.