unreal.ButtonStyle

class unreal.ButtonStyle(normal: SlateBrush = Ellipsis, hovered: SlateBrush = Ellipsis, pressed: SlateBrush = Ellipsis, disabled: SlateBrush = Ellipsis, normal_foreground: SlateColor = Ellipsis, hovered_foreground: SlateColor = Ellipsis, pressed_foreground: SlateColor = Ellipsis, disabled_foreground: SlateColor = Ellipsis, normal_padding: Margin = Ellipsis, pressed_padding: Margin = Ellipsis, pressed_slate_sound: SlateSound = Ellipsis, hovered_slate_sound: SlateSound = Ellipsis)

Bases: SlateWidgetStyle

Represents the appearance of an SButton

C++ Source:

  • Module: SlateCore

  • File: SlateTypes.h

Editor Properties: (see get_editor_property/set_editor_property)

  • disabled (SlateBrush): [Read-Write] Disabled: Button appearance when disabled, by default this is set to an invalid resource when that is the case default disabled drawing is used.

  • disabled_foreground (SlateColor): [Read-Write] Disabled Foreground: Foreground Color when disabled

  • hovered (SlateBrush): [Read-Write] Hovered: Button appearance when hovered

  • hovered_foreground (SlateColor): [Read-Write] Hovered Foreground: Foreground Color when hovered

  • hovered_slate_sound (SlateSound): [Read-Write] Hovered Slate Sound: The sound the button should play when initially hovered over

  • normal (SlateBrush): [Read-Write] Normal: Button appearance when the button is not hovered or pressed

  • normal_foreground (SlateColor): [Read-Write] Normal Foreground: Foreground Color when the button is not hovered or pressed

  • normal_padding (Margin): [Read-Write] Normal Padding: Padding that accounts for the border in the button’s background image. When this is applied, the content of the button should appear flush with the button’s border. Use this padding when the button is not pressed.

  • pressed (SlateBrush): [Read-Write] Pressed: Button appearance when pressed

  • pressed_foreground (SlateColor): [Read-Write] Pressed Foreground: Foreground Color when pressed

  • pressed_padding (Margin): [Read-Write] Pressed Padding: Same as NormalPadding but used when the button is pressed. Allows for moving the content to match any “movement” in the button’s border image.

  • pressed_slate_sound (SlateSound): [Read-Write] Pressed Slate Sound: The sound the button should play when pressed

property disabled: SlateBrush

[Read-Write] Disabled: Button appearance when disabled, by default this is set to an invalid resource when that is the case default disabled drawing is used.

Type:

(SlateBrush)

property disabled_foreground: SlateColor

[Read-Write] Disabled Foreground: Foreground Color when disabled

Type:

(SlateColor)

property hovered: SlateBrush

[Read-Write] Hovered: Button appearance when hovered

Type:

(SlateBrush)

property hovered_foreground: SlateColor

[Read-Write] Hovered Foreground: Foreground Color when hovered

Type:

(SlateColor)

property hovered_slate_sound: SlateSound

[Read-Write] Hovered Slate Sound: The sound the button should play when initially hovered over

Type:

(SlateSound)

property normal: SlateBrush

[Read-Write] Normal: Button appearance when the button is not hovered or pressed

Type:

(SlateBrush)

property normal_foreground: SlateColor

[Read-Write] Normal Foreground: Foreground Color when the button is not hovered or pressed

Type:

(SlateColor)

property normal_padding: Margin

[Read-Write] Normal Padding: Padding that accounts for the border in the button’s background image. When this is applied, the content of the button should appear flush with the button’s border. Use this padding when the button is not pressed.

Type:

(Margin)

property pressed: SlateBrush

[Read-Write] Pressed: Button appearance when pressed

Type:

(SlateBrush)

property pressed_foreground: SlateColor

[Read-Write] Pressed Foreground: Foreground Color when pressed

Type:

(SlateColor)

property pressed_padding: Margin

[Read-Write] Pressed Padding: Same as NormalPadding but used when the button is pressed. Allows for moving the content to match any “movement” in the button’s border image.

Type:

(Margin)

property pressed_slate_sound: SlateSound

[Read-Write] Pressed Slate Sound: The sound the button should play when pressed

Type:

(SlateSound)