Interface IUIEvents

The UI events component adds the ability to subscribe to multiple events which are needed by GUIs \ (like mouse click, enter, leave).

Inherited Members

IComponent.Name

IComponent.Entity

IComponent.RegistrationType

IComponent.Init(IEntity, Type)

IComponent.AfterInit()

System.IDisposable.Dispose()

System.ComponentModel.INotifyPropertyChanged.PropertyChanged

Namespace: AGS.API

Assembly: AGS.API.dll

Syntax

[RequiredComponent(typeof(IEnabledComponent), true)]
[RequiredComponent(typeof(IVisibleComponent), true)]
[RequiredComponent(typeof(IColliderComponent), true)]
public interface IUIEvents : IComponent, IDisposable, INotifyPropertyChanged

Properties

| Improve this Doc View Source

IsMouseIn

Gets a value indicating whether the mouse cursor is within the entity's boundaries.

Declaration

bool IsMouseIn { get; }

Property Value

Type	Description
System.Boolean	`true` if is mouse in; otherwise, `false`.

| Improve this Doc View Source

LostFocus

An event which is triggered whenever the entity loses focus (a mouse button was clicked outside the boundaries of the entity).

Declaration

IEvent<MouseButtonEventArgs> LostFocus { get; }

Property Value

Type	Description
IEvent<MouseButtonEventArgs>	The lost focus.

| Improve this Doc View Source

MouseClicked

An event which is triggered whenever the mouse is clicked within the boundaries of the entity. Note that a mouse click is mouse button pressed down, swiftly followed by button release.

Declaration

IEvent<MouseClickEventArgs> MouseClicked { get; }

Property Value

Type	Description
IEvent<MouseClickEventArgs>	The event.

| Improve this Doc View Source

MouseDoubleClicked

An event which is triggered whenever the mouse is double clicked within the boundaries of the entity. Note that a mouse double click is 2 swift mouse button clicks in a row (of the same button).

Declaration

IEvent<MouseClickEventArgs> MouseDoubleClicked { get; }

Property Value

Type	Description
IEvent<MouseClickEventArgs>	The event.

| Improve this Doc View Source

MouseDown

An event which is triggered whenever a mouse button is pressed down within the boundaries of the entity.

Declaration

IEvent<MouseButtonEventArgs> MouseDown { get; }

Property Value

Type	Description
IEvent<MouseButtonEventArgs>	The event.

| Improve this Doc View Source

MouseEnter

An event which is triggered whenever the mouse enters the boundaries of the entity.

Declaration

IEvent<MousePositionEventArgs> MouseEnter { get; }

Property Value

Type	Description
IEvent<MousePositionEventArgs>	The event.

| Improve this Doc View Source

MouseLeave

An event which is triggered whenever the mouse leaves the boundaries of the entity.

Declaration

IEvent<MousePositionEventArgs> MouseLeave { get; }

Property Value

Type	Description
IEvent<MousePositionEventArgs>	The event.

| Improve this Doc View Source

MouseMove

An event which is triggered whenever the mouse moves within the boundaries of the entity.

Declaration

IEvent<MousePositionEventArgs> MouseMove { get; }

Property Value

Type	Description
IEvent<MousePositionEventArgs>	The event.

| Improve this Doc View Source

MouseUp

An event which is triggered whenever a mouse button is released, if the button was pressed down within the boundaries of the entity.

Declaration

IEvent<MouseButtonEventArgs> MouseUp { get; }

Property Value

Type	Description
IEvent<MouseButtonEventArgs>	The event.