rojo/.cursor/rules/roblox/reference/engine/enums/UIFlexMode.yaml
2026-02-02 12:08:47 -06:00

58 lines
2 KiB
YAML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# This file is automatically generated. Please don't edit it manually.
# To submit a bug report on the content, see
# https://devforum.roblox.com/c/bug-reports/documentation-issues/72
name: UIFlexMode
type: enum
summary: |
Used with `Class.UIFlexItem.FlexMode` to define how the parent
`Class.GuiObject` grows or shrinks.
description: |
Used with `Class.UIFlexItem.FlexMode` to define how the parent
`Class.GuiObject` grows or shrinks with available space in the container.
code_samples: []
tags: []
deprecation_message: ''
items:
- name: None
summary: |
The parent `Class.GuiObject` is unaffected and neither shrinks nor grows.
value: 0
tags: []
deprecation_message: ''
- name: Grow
summary: |
Sets an effective `1:0` grow‑shrink ratio on the parent `Class.GuiObject`.
Objects set to `Grow` never shrink below their basis size, so overflow may
occur if the container becomes smaller than the flex line's combined basis
size.
value: 1
tags: []
deprecation_message: ''
- name: Shrink
summary: |
Sets an effective `0:1` grow‑shrink ratio on the parent `Class.GuiObject`.
Objects set to `Shrink` never grow above their basis size, so underflow
may occur if the container becomes larger than the flex line's combined
basis size.
value: 2
tags: []
deprecation_message: ''
- name: Fill
summary: |
Sets an effective `1:1` grow‑shrink ratio on the parent `Class.GuiObject`.
This setting ensures the flex line always fills the container, even if the
container size changes.
value: 3
tags: []
deprecation_message: ''
- name: Custom
summary: |
Enables the `Class.UIFlexItem.GrowRatio|GrowRatio` and
`Class.UIFlexItem.ShrinkRatio|ShrinkRatio` properties for the
`Class.UIFlexItem`, allowing for relative growth or shrinking of the
parent `Class.GuiObject` in a ratio compared to other flex objects also
under control of a `Class.UIFlexItem`.
value: 4
tags: []
deprecation_message: ''