Storage.Level
Description
A class that represents a storage level within a bay.
A Level is defined as the area of a Bay above the floor or above a horizontal support.Properties
| slots | Accesses the level's slots as an array of Storage.Slots. |
Methods
| areSlotLabelsEqual | Returns whether a label value is the same for all slots within a level. |
| setSlotLabels | Sets a label on all slots of the level to the given value. |
Details
Do no remove, this fixes the anchor on doc.flexsim.com
Storage.Level.slots
readonly slots
Description
Accesses the level's slots as an array of Storage.Slots.
Do no remove, this fixes the anchor on doc.flexsim.com
Storage.Level.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 | alse if a label value is not the same for all slots within the level, 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 within a level.
The specified label value is checked for each slot of the level. 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.Level.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 of the level 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.