Skip to content

Class PositioningOverlay.ControlScheme

Definition

Namespace: StardewUI.Widgets
Assembly: StardewUI.dll

Configures the mapping of buttons to positioning actions in a PositioningOverlay.

public class PositioningOverlay.ControlScheme

Inheritance
Object ⇦ ControlScheme

Remarks

For all IReadOnlyList<T> properties, any of the buttons can be pressed in order to perform that function; it is primarily intended to support left-stick/d-pad equivalency and WASD/arrow-key equivalency. Button combinations are not supported.

Keyboard control schemes only specify the fine movements; alignments are always controlled using number/numpad keys for each of the 9 possibilities.

Members

Constructors

Name Description
ControlScheme()

Properties

Name Description
FineDown Buttons to shift the content down one pixel by modifying the Offset of the ContentPlacement.
FineLeft Buttons to shift the content left one pixel by modifying the Offset of the ContentPlacement.
FineRight Buttons to shift the content right one pixel by modifying the Offset of the ContentPlacement.
FineUp Buttons to shift the content up one pixel by modifying the Offset of the ContentPlacement.

Details

Constructors

ControlScheme()

public ControlScheme();

Properties

FineDown

Buttons to shift the content down one pixel by modifying the Offset of the ContentPlacement.

public System.Collections.Generic.IReadOnlyList<StardewModdingAPI.SButton> FineDown { get; set; }
Property Value

IReadOnlyList


FineLeft

Buttons to shift the content left one pixel by modifying the Offset of the ContentPlacement.

public System.Collections.Generic.IReadOnlyList<StardewModdingAPI.SButton> FineLeft { get; set; }
Property Value

IReadOnlyList


FineRight

Buttons to shift the content right one pixel by modifying the Offset of the ContentPlacement.

public System.Collections.Generic.IReadOnlyList<StardewModdingAPI.SButton> FineRight { get; set; }
Property Value

IReadOnlyList


FineUp

Buttons to shift the content up one pixel by modifying the Offset of the ContentPlacement.

public System.Collections.Generic.IReadOnlyList<StardewModdingAPI.SButton> FineUp { get; set; }
Property Value

IReadOnlyList