Skip to content

Class PositioningOverlay.GamepadControlScheme

Definition

Namespace: StardewUI.Widgets
Assembly: StardewUI.dll

Configures the mapping of buttons to positioning actions in a PositioningOverlay. Includes the generic ControlScheme settings as well as grid-movement settings specific to gamepads.

public class PositioningOverlay.GamepadControlScheme : 
    StardewUI.Widgets.PositioningOverlay.ControlScheme

Inheritance
ObjectControlScheme ⇦ GamepadControlScheme

Members

Constructors

Name Description
GamepadControlScheme()

Properties

Name Description
FineDown Buttons to shift the content down one pixel by modifying the Offset of the ContentPlacement.
(Inherited from ControlScheme)
FineLeft Buttons to shift the content left one pixel by modifying the Offset of the ContentPlacement.
(Inherited from ControlScheme)
FineRight Buttons to shift the content right one pixel by modifying the Offset of the ContentPlacement.
(Inherited from ControlScheme)
FineUp Buttons to shift the content up one pixel by modifying the Offset of the ContentPlacement.
(Inherited from ControlScheme)
GridDown Buttons to shift the content down by one grid cell by changing the VerticalAlignment of the ContentPlacement. Start becomes Middle and Middle becomes End.
GridLeft Buttons to shift the content left by one grid cell by changing the HorizontalAlignment of the ContentPlacement. End becomes Middle and Middle becomes Start.
GridRight Buttons to shift the content right by one grid cell by changing the HorizontalAlignment of the ContentPlacement. Start becomes Middle and Middle becomes End.
GridUp Buttons to shift the content up by one grid cell by changing the VerticalAlignment of the ContentPlacement. End becomes Middle and Middle becomes Start.
Modifier Modifier key to switch between grid- and fine-positioning modes.

Details

Constructors

GamepadControlScheme()

public GamepadControlScheme();

Properties

GridDown

Buttons to shift the content down by one grid cell by changing the VerticalAlignment of the ContentPlacement. Start becomes Middle and Middle becomes End.

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

IReadOnlyList


GridLeft

Buttons to shift the content left by one grid cell by changing the HorizontalAlignment of the ContentPlacement. End becomes Middle and Middle becomes Start.

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

IReadOnlyList


GridRight

Buttons to shift the content right by one grid cell by changing the HorizontalAlignment of the ContentPlacement. Start becomes Middle and Middle becomes End.

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

IReadOnlyList


GridUp

Buttons to shift the content up by one grid cell by changing the VerticalAlignment of the ContentPlacement. End becomes Middle and Middle becomes Start.

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

IReadOnlyList


Modifier

Modifier key to switch between grid- and fine-positioning modes.

public StardewModdingAPI.SButton Modifier { get; set; }
Property Value

SButton

Remarks

If specified, the default motion will be fine, and the modifier key must be held in order to move accross the grid.