Skip to content

ModifierInput

export type ModifierInput = {
    Enabled: CanBeState<boolean>?,
    Hovering: CanBeState<boolean>?,
    Selected: CanBeState<boolean>?,
    Pressed: CanBeState<boolean>?,
    Otherwise: CanBeState<Enum.StudioStyleGuideModifier>?,
}

The ModifierInput table that is given to the getModifier() function that contains data about the desired value from the utility function.


Properties

Enabled : CanBeState<boolean>?

Sets whether or not the component for the modifier is enabled.


Hovering : CanBeState<boolean>?

Sets whether or not the component for the modifier is hovering.


Selected : CanBeState<boolean>?

Sets whether or not the component for the modifier is selected.


Pressed : CanBeState<boolean>?

Sets whether or not the component for the modifier is pressed.


Otherwise : CanBeState<Enum.StudioStyleGuideModifier>?

If none of the above properties are satisfied, then this property will be used.
For example: * If the component is enabled, but not hovered, selected, or pressed.

If this property is not set, then the default modifier will be applied.