Storage.Bay

Description

A class that represents a storage bay.

A Bay is defined as the area between to vertical supports, and includes all levels between those two supports.

Properties

levels

Accesses the bay's levels as an array of Storage.Levels.

Methods

areSlotLabelsEqual	Returns whether a label value is the same for all slots on all levels within a bay.
setSlotLabels	Sets a label on all slots on all levels of the bay to the given value.

Details

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

Storage.Bay.levels

readonly levels

Description

Accesses the bay's levels as an array of Storage.Levels.

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

Storage.Bay.areSlotLabelsEqual()

int areSlotLabelsEqual( string labelName )

int areSlotLabelsEqual( string labelName , Variant matchValue )

Parameters

labelName	The name of the label to check
matchValue	The value to compare with each slot label

Returns

int

False if a label value is not the same for all slots within the bay, or if any of those values do not match the matchValue. Returns true otherwise.

Description

Returns whether a label value is the same for all slots on all levels within a bay.

The specified label value is checked for each slot of the bay. If all label values do not match, then this method returns false. If a matchValue is provided, all label values must match the matchValue, or this function will still return false.

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

Storage.Bay.setSlotLabels()

void setSlotLabels( string labelName , Variant value )

Parameters

labelName	The name of the label to set.
value	The value to give the label on each slot.

Description

Sets a label on all slots on all levels of the bay to the given value.

If the label does not exist on any of the slots, this method will add the label and set the value.