ToxicMushroom/Dalamud
1
0
Fork 0
mirror of https://github.com/goatcorp/Dalamud.git synced 2025-12-22 00:19:18 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

Documentation fixing

Browse source
This commit is contained in:
MidoriKami 2025-07-26 13:30:15 -07:00
parent 57476701bc
commit e5d4d0ed1b
1 changed files with 10 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

20
Dalamud/Game/Addon/Events/EventDataTypes/AddonMouseEventData.cs
View file

@ -27,52 +27,52 @@ public unsafe class AddonMouseEventData : AddonEventData
} }
/// <summary> /// <summary>
/// Gets a value indicating whether the event was a Left Mouse Click /// Gets a value indicating whether the event was a Left Mouse Click.
/// </summary> /// </summary>
public bool IsLeftClick => this.MouseData.ButtonId is 0; public bool IsLeftClick => this.MouseData.ButtonId is 0;
/// <summary> /// <summary>
/// Gets a value indicating whether the event was a Right Mouse Click /// Gets a value indicating whether the event was a Right Mouse Click.
/// </summary> /// </summary>
public bool IsRightClick => this.MouseData.ButtonId is 1; public bool IsRightClick => this.MouseData.ButtonId is 1;
/// <summary> /// <summary>
/// Gets a value indicating whether there are any modifiers set such as alt, control, shift, or dragging /// Gets a value indicating whether there are any modifiers set such as alt, control, shift, or dragging.
/// </summary> /// </summary>
public bool IsNoModifier => this.MouseData.Modifier is 0; public bool IsNoModifier => this.MouseData.Modifier is 0;
/// <summary> /// <summary>
/// Gets a value indicating whether alt was being held when this event triggered /// Gets a value indicating whether alt was being held when this event triggered.
/// </summary> /// </summary>
public bool IsAltHeld => this.MouseData.Modifier.HasFlag(ModifierFlag.Alt); public bool IsAltHeld => this.MouseData.Modifier.HasFlag(ModifierFlag.Alt);
/// <summary> /// <summary>
/// Gets a value indicating whether control was being held when this event triggered /// Gets a value indicating whether control was being held when this event triggered.
/// </summary> /// </summary>
public bool IsControlHeld => this.MouseData.Modifier.HasFlag(ModifierFlag.Ctrl); public bool IsControlHeld => this.MouseData.Modifier.HasFlag(ModifierFlag.Ctrl);
/// <summary> /// <summary>
/// Gets a value indicating whether shift was being held when this event triggered /// Gets a value indicating whether shift was being held when this event triggered.
/// </summary> /// </summary>
public bool IsShiftHeld => this.MouseData.Modifier.HasFlag(ModifierFlag.Shift); public bool IsShiftHeld => this.MouseData.Modifier.HasFlag(ModifierFlag.Shift);
/// <summary> /// <summary>
/// Gets a value indicating whether this event is a mouse drag or not /// Gets a value indicating whether this event is a mouse drag or not.
/// </summary> /// </summary>
public bool IsDragging => this.MouseData.Modifier.HasFlag(ModifierFlag.Dragging); public bool IsDragging => this.MouseData.Modifier.HasFlag(ModifierFlag.Dragging);
/// <summary> /// <summary>
/// Gets a value indicating whether the event was a scroll up /// Gets a value indicating whether the event was a scroll up.
/// </summary> /// </summary>
public bool IsScrollUp => this.MouseData.WheelDirection is 1; public bool IsScrollUp => this.MouseData.WheelDirection is 1;
/// <summary> /// <summary>
/// Gets a value indicating whether the event was a scroll down /// Gets a value indicating whether the event was a scroll down.
/// </summary> /// </summary>
public bool IsScrollDown => this.MouseData.WheelDirection is -1; public bool IsScrollDown => this.MouseData.WheelDirection is -1;
/// <summary> /// <summary>
/// Gets the position of the mouse when this event was triggered /// Gets the position of the mouse when this event was triggered.
/// </summary> /// </summary>
public Vector2 Position => new(this.MouseData.PosX, this.MouseData.PosY); public Vector2 Position => new(this.MouseData.PosX, this.MouseData.PosY);