Show / Hide Table of Contents

    Class MouseButtonEventArgs

    Mouse button down/up event arguments.

    Inheritance
    System.Object
    MouseButtonEventArgs
    MouseClickEventArgs
    Inherited Members
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.ToString()
    Namespace: AGS.API
    Assembly: AGS.API.dll
    Syntax
    public class MouseButtonEventArgs

    Constructors

    | Improve this Doc View Source

    MouseButtonEventArgs(IEntity, MouseButton, MousePosition)

    Initializes a new instance of the MouseButtonEventArgs class.

    Declaration
    public MouseButtonEventArgs(IEntity clickedEntity, MouseButton button, MousePosition mousePosition)
    Parameters
    Type Name Description
    IEntity clickedEntity

    The entity which was clicked on.

    MouseButton button

    Button.

    MousePosition mousePosition

    The mouse position.

    Properties

    | Improve this Doc View Source

    Button

    Which mouse button is this event relates to.

    Declaration
    public MouseButton Button { get; }
    Property Value
    Type Description
    MouseButton

    The button.

    | Improve this Doc View Source

    ClickedEntity

    The entity which was clicked on.

    Declaration
    public IEntity ClickedEntity { get; }
    Property Value
    Type Description
    IEntity

    The clicked entity.

    | Improve this Doc View Source

    MousePosition

    The position of the mouse on the screen at the time the button was clicked.

    Declaration
    public MousePosition MousePosition { get; }
    Property Value
    Type Description
    MousePosition

    The mouse position.

    • Improve this Doc
    • View Source
    Back to top Generated by DocFX