Interface ICaptureTarget

Definition

Namespace: StardewUI.Input
Assembly: StardewUI.dll

Denotes a view or other UI element that can be the active IKeyboardSubscriber. Allows view hosts to provide deterministic release, e.g. when the mouse is clicked outside the target.

public interface ICaptureTarget

Remarks

This is primarily intended to work by checking if the Subscriber implements this interface, and if it's CapturingView belongs to the current click/focus tree. To work correctly, both of these conditions must be met.

Members

Properties

Name	Description
CapturingView	The view that initiated the capturing. May be the same object as the ICaptureTarget, or may be the "owner" of a hidden TextBox or other IKeyboardSubscriber.

Methods

Name	Description
ReleaseCapture()	Stops input capturing from this target.
Update(TimeSpan)	Runs on every game update tick while capturing.

Details

Properties

CapturingView

The view that initiated the capturing. May be the same object as the ICaptureTarget, or may be the "owner" of a hidden TextBox or other IKeyboardSubscriber.

StardewUI.IView CapturingView { get; }

Property Value

IView

---

Methods

ReleaseCapture()

Stops input capturing from this target.

void ReleaseCapture();

---

Update(TimeSpan)

Runs on every game update tick while capturing.

void Update(System.TimeSpan elapsed);

Parameters

elapsed   TimeSpan
The amount of real time elapsed since the last tick.

---