Class WheelEventArgs
Definition
Namespace: StardewUI.Events
Assembly: StardewUI.dll
Event arguments for mouse wheel/scroll wheel actions.
public class WheelEventArgs : StardewUI.Events.PointerEventArgs,
StardewUI.Layout.IOffsettable<StardewUI.Events.WheelEventArgs>
Inheritance
Object ⇦ EventArgs ⇦ BubbleEventArgs ⇦ PointerEventArgs ⇦ WheelEventArgs
Implements
IOffsettable<WheelEventArgs>
Members
Constructors
Name | Description |
---|---|
WheelEventArgs(Vector2, Direction) | Event arguments for mouse wheel/scroll wheel actions. |
Properties
Name | Description |
---|---|
Direction | Direction of the wheel movement. |
Handled | Whether or not the view receiving the event handled the event. Set to true to prevent bubbling.(Inherited from BubbleEventArgs) |
Position | The position, relative to the view receiving the event, of the pointer when the event occurred. (Inherited from PointerEventArgs) |
Methods
Name | Description |
---|---|
Offset(Vector2) | Creates a clone of this instance with an offset applied to its position. |
Details
Constructors
WheelEventArgs(Vector2, Direction)
Event arguments for mouse wheel/scroll wheel actions.
Parameters
position
Vector2
direction
Direction
Direction of the wheel movement.
Properties
Direction
Direction of the wheel movement.
Property Value
Methods
Offset(Vector2)
Creates a clone of this instance with an offset applied to its position.
Parameters
distance
Vector2
The offset distance.