Class KeybindView

Framework View

The tag name of this view is <keybind>.

Definition

Namespace: StardewUI.Widgets.Keybinding
Assembly: StardewUI.dll

Display widget for a single Keybind showing all required keys.

[StardewUI.GenerateDescriptor]
public class KeybindView : StardewUI.Widgets.ComponentView<T>

Inheritance
Object ⇦ DecoratorView<T> ⇦ ComponentView<T> ⇦ KeybindView

Members

Constructors

Name	Description
KeybindView()

Fields

Name	Description
DEFAULT_BUTTON_HEIGHT	Default setting for ButtonHeight.

Properties

Name	Description
ActualBounds `actual-bounds`	The bounds of this view relative to the origin (0, 0). (Inherited from DecoratorView<T>)
ButtonHeight `button-height`	The height for button images/sprites. Images are scaled uniformly, preserving source aspect ratio.
ButtonMinWidth `button-min-width`	Minimum width for button images/sprites, used if the layout width would be less than that implied by the ButtonHeight and placeholder content (if any).
ClipOrigin `clip-origin`	Origin position for the ClipSize. (Inherited from DecoratorView<T>)
ClipSize `clip-size`	Size of the clipping rectangle, outside which content will not be displayed. (Inherited from DecoratorView<T>)
ContentBounds `content-bounds`	The true bounds of this view's content; i.e. ActualBounds excluding margins. (Inherited from DecoratorView<T>)
EmptyText `empty-text`	Placeholder text to display when the current keybind is empty.
FloatingBounds `floating-bounds`	Contains the bounds of all floating elements in this view tree, including the current view and all descendants. (Inherited from DecoratorView<T>)
Font `font`	Font used to display text in button/key placeholders.
HoveredSubject `hovered-subject`	When Lookup Anything (Pathoschild.LookupAnything) is loaded, this Object or NPC subject is given to lookup anything for it's menu. `(unofficial-mushymato)` (Inherited from DecoratorView<T>)
IsFocusable `is-focusable`	Whether or not the view can receive controller focus, i.e. the stick/d-pad controlled cursor can move to this view. Not generally applicable for mouse controls. (Inherited from DecoratorView<T>)
Keybind `keybind`	The current keybind.
Layout `layout`	The current layout parameters, which determine how Measure(Vector2) will behave. (Inherited from DecoratorView<T>)
Margin `margin`	Margins (whitespace outside border) for this view.
Name `name`	Simple name for this view, used in log/debug output; does not affect behavior. (Inherited from DecoratorView<T>)
Opacity `opacity`	Opacity (alpha level) of the view. (Inherited from DecoratorView<T>)
OuterSize `outer-size`	The true computed layout size resulting from a single Measure(Vector2) pass. (Inherited from DecoratorView<T>)
PointerEventsEnabled `pointer-events-enabled`	Whether this view should receive pointer events like Click or Drag. (Inherited from DecoratorView<T>)
PointerStyle `pointer-style`	Pointer style to use when this view is hovered. (Inherited from DecoratorView<T>)
ScreenRead `screen-read`	When a screen reader mod (shoaib.stardewaccess) is loaded, this element will be announced by the screen reader using this value. `(unofficial-mushymato)` (Inherited from DecoratorView<T>)
ScrollWithChildren `scroll-with-children`	If set to an axis, specifies that when any child of the view is scrolled into view (using ScrollIntoView(IEnumerable<ViewChild>, Vector2)), then this entire view should be scrolled along with it. (Inherited from DecoratorView<T>)
Spacing `spacing`	Extra spacing between displayed button sprites, if the sprites do not have implicit wide margins.
SpriteMap `sprite-map`	Map of bindable buttons to sprite representations.
Tags `tags`	The user-defined tags for this view. (Inherited from DecoratorView<T>)
TextColor `text-color`	Text color for the button text inside any placeholder sprites.
TintColor `tint-color`	Color to tint the background/sprite of each key.
Tooltip `tooltip`	Tooltip data to display on hover, if any. (Inherited from DecoratorView<T>)
Transform `transform`	Local transformation to apply to this view, including any children and floating elements. (Inherited from DecoratorView<T>)
TransformOrigin `transform-origin`	Relative origin position for any Transform on this view. (Inherited from DecoratorView<T>)
View `view`	(Inherited from ComponentView<T>)
Visibility `visibility`	Drawing visibility for this view. (Inherited from DecoratorView<T>)
ZIndex `z-index`	Z order for this view within its direct parent. Higher indices draw later (on top). (Inherited from DecoratorView<T>)

Methods

Name	Description
ContainsPoint(Vector2)	Checks if a given point, relative to the view's origin, is within its bounds. (Inherited from DecoratorView<T>)
CreateView()	Creates and returns the root view. (Overrides ComponentView<T>.CreateView())
Dispose()	(Inherited from DecoratorView<T>)
Draw(ISpriteBatch)	Draws the content for this view. (Inherited from DecoratorView<T>)
FocusSearch(Vector2, Direction)	Finds the next focusable component in a given direction that does not overlap with a current position. (Inherited from DecoratorView<T>)
GetChildAt(Vector2, Boolean, Boolean)	Finds the child at a given position. (Inherited from DecoratorView<T>)
GetChildPosition(IView)	Computes or retrieves the position of a given direct child. (Inherited from DecoratorView<T>)
GetChildren(Boolean)	Gets the current children of this view. (Inherited from DecoratorView<T>)
GetChildrenAt(Vector2)	Finds all children at a given position. (Inherited from DecoratorView<T>)
GetDefaultFocusChild()	Gets the direct child that should contain cursor focus when a menu or overlay containing this view is first opened. (Inherited from DecoratorView<T>)
HasOutOfBoundsContent()	Checks if the view has content or elements that are all or partially outside the ActualBounds. (Inherited from DecoratorView<T>)
IsDirty()	Checks whether or not the view is dirty - i.e. requires a new layout with a full Measure(Vector2). (Inherited from DecoratorView<T>)
IsVisible(Vector2?)	Checks if the view is effectively visible, i.e. if it has anything to draw. (Inherited from DecoratorView<T>)
Measure(Vector2)	Performs layout on this view, updating its OuterSize, ActualBounds and ContentBounds, and arranging any children in their respective positions. (Inherited from DecoratorView<T>)
OnButtonPress(ButtonEventArgs)	Called when a button press is received while this view is in the focus path. (Inherited from DecoratorView<T>)
OnButtonRepeat(ButtonEventArgs)	Called when a button press is first received, and at recurring intervals thereafter, for as long as the button is held and this view remains in the focus path. (Inherited from DecoratorView<T>)
OnClick(ClickEventArgs)	Called when a click is received within this view's bounds. (Inherited from DecoratorView<T>)
OnDrag(PointerEventArgs)	Called when the view is being dragged (mouse moved while left button held). (Inherited from DecoratorView<T>)
OnDrop(PointerEventArgs)	Called when the mouse button is released after at least one OnDrag(PointerEventArgs). (Inherited from DecoratorView<T>)
OnLayout()	Runs whenever layout occurs as a result of the UI elements changing. (Inherited from DecoratorView<T>)
OnPointerMove(PointerMoveEventArgs)	Called when a pointer movement related to this view occurs. (Inherited from DecoratorView<T>)
OnPropertyChanged(PropertyChangedEventArgs)	Raises the PropertyChanged event. (Inherited from DecoratorView<T>)
OnPropertyChanged(string)	Raises the PropertyChanged event. (Inherited from DecoratorView<T>)
OnUpdate(TimeSpan)	Runs on every update tick. (Inherited from DecoratorView<T>)
OnWheel(WheelEventArgs)	Called when a wheel event is received within this view's bounds. (Inherited from DecoratorView<T>)
RegisterDecoratedProperty<TValue>(DecoratedProperty<T, TValue>)	Registers a DecoratedProperty<T, TValue>. (Inherited from DecoratorView<T>)
ScrollIntoView(IEnumerable<ViewChild>, Vector2)	Attempts to scroll the specified target into view, including all of its ancestors, if not fully in view. (Inherited from DecoratorView<T>)

Events

Name	Description
ButtonPress	Event raised when any button on any input device is pressed. (Inherited from DecoratorView<T>)
ButtonRepeat	Event raised when a button is being held while the view is in focus, and has been held long enough since the initial ButtonPress or the previous `ButtonRepeat` to trigger a repeated press. (Inherited from DecoratorView<T>)
Click	Event raised when the view receives a click initiated from any button. (Inherited from DecoratorView<T>)
Drag	Event raised when the view is being dragged using the mouse. (Inherited from DecoratorView<T>)
DragEnd	Event raised when mouse dragging is stopped, i.e. when the button is released. Always raised after the last Drag, and only once per drag operation. (Inherited from DecoratorView<T>)
DragStart	Event raised when mouse dragging is first activated. Always raised before the first Drag, and only once per drag operation. (Inherited from DecoratorView<T>)
LeftClick	Event raised when the view receives a click initiated from the left mouse button, or the controller's action button (A). (Inherited from DecoratorView<T>)
PointerEnter	Event raised when the pointer enters the view. (Inherited from DecoratorView<T>)
PointerLeave	Event raised when the pointer exits the view. (Inherited from DecoratorView<T>)
PointerMove	Event raised when the pointer moves within the view. (Inherited from DecoratorView<T>)
PropertyChanged	(Inherited from DecoratorView<T>)
RightClick	Event raised when the view receives a click initiated from the right mouse button, or the controller's tool-use button (X). (Inherited from DecoratorView<T>)
Wheel	Event raised when the scroll wheel moves. (Inherited from DecoratorView<T>)

Details

Constructors

KeybindView()

public KeybindView();

Fields

DEFAULT_BUTTON_HEIGHT

Default setting for ButtonHeight.

public static const int DEFAULT_BUTTON_HEIGHT;

Field Value

Int32

Properties

ButtonHeight

The height for button images/sprites. Images are scaled uniformly, preserving source aspect ratio.

public int ButtonHeight { get; set; }

Property Value

Int32

ButtonMinWidth

Minimum width for button images/sprites, used if the layout width would be less than that implied by the ButtonHeight and placeholder content (if any).

public int? ButtonMinWidth { get; set; }

Property Value

Nullable<Int32>

EmptyText

Placeholder text to display when the current keybind is empty.

public string EmptyText { get; set; }

Property Value

string

Font

Font used to display text in button/key placeholders.

public Microsoft.Xna.Framework.Graphics.SpriteFont Font { get; set; }

Property Value

SpriteFont

Remarks

Only applies for buttons that use a placeholder sprite (i.e. set the isPlaceholder output of Get(T, Boolean) to true). In these cases, the actual button text drawn inside the sprite will be drawn using the specified font.

Keybind

The current keybind.

public StardewModdingAPI.Utilities.Keybind Keybind { get; set; }

Property Value

Keybind

Margin

Margins (whitespace outside border) for this view.

public StardewUI.Layout.Edges Margin { get; set; }

Property Value

Edges

Spacing

Extra spacing between displayed button sprites, if the sprites do not have implicit wide margins.

public float Spacing { get; set; }

Property Value

Single

SpriteMap

Map of bindable buttons to sprite representations.

public StardewUI.Graphics.ISpriteMap<StardewModdingAPI.SButton> SpriteMap { get; set; }

Property Value

ISpriteMap

TextColor

Text color for the button text inside any placeholder sprites.

public Microsoft.Xna.Framework.Color TextColor { get; set; }

Property Value

Color

TintColor

Color to tint the background/sprite of each key.

public Microsoft.Xna.Framework.Color TintColor { get; set; }

Property Value

Color

Methods

CreateView()

Creates and returns the root view.

protected override StardewUI.Widgets.Lane CreateView();

Returns

Lane