TopDown Engine  v4.1
MoreMountains.Tools.MMOnMouse Class Reference

Attach this class to a collider and it'll let you trigger events when the user clicks/drags/enters/etc that collider More...

Inheritance diagram for MoreMountains.Tools.MMOnMouse:

Public Attributes

UnityEvent OnMouseDownEvent
 OnMouseDown is called when the user has pressed the mouse button while over the Collider. More...
 
UnityEvent OnMouseDragEvent
 OnMouseDrag is called when the user has clicked on a Collider and is still holding down the mouse. More...
 
UnityEvent OnMouseEnterEvent
 Called when the mouse enters the Collider. More...
 
UnityEvent OnMouseExitEvent
 Called when the mouse is not any longer over the Collider. More...
 
UnityEvent OnMouseOverEvent
 Called every frame while the mouse is over the Collider. More...
 
UnityEvent OnMouseUpEvent
 OnMouseUp is called when the user has released the mouse button. More...
 
UnityEvent OnMouseUpAsButtonEvent
 OnMouseUpAsButton is only called when the mouse is released over the same Collider as it was pressed. More...
 

Protected Member Functions

virtual void OnMouseDown ()
 
virtual void OnMouseDrag ()
 
virtual void OnMouseEnter ()
 
virtual void OnMouseExit ()
 
virtual void OnMouseOver ()
 
virtual void OnMouseUp ()
 
virtual void OnMouseUpAsButton ()
 

Detailed Description

Attach this class to a collider and it'll let you trigger events when the user clicks/drags/enters/etc that collider

Member Function Documentation

◆ OnMouseDown()

virtual void MoreMountains.Tools.MMOnMouse.OnMouseDown ( )
protectedvirtual

◆ OnMouseDrag()

virtual void MoreMountains.Tools.MMOnMouse.OnMouseDrag ( )
protectedvirtual

◆ OnMouseEnter()

virtual void MoreMountains.Tools.MMOnMouse.OnMouseEnter ( )
protectedvirtual

◆ OnMouseExit()

virtual void MoreMountains.Tools.MMOnMouse.OnMouseExit ( )
protectedvirtual

◆ OnMouseOver()

virtual void MoreMountains.Tools.MMOnMouse.OnMouseOver ( )
protectedvirtual

◆ OnMouseUp()

virtual void MoreMountains.Tools.MMOnMouse.OnMouseUp ( )
protectedvirtual

◆ OnMouseUpAsButton()

virtual void MoreMountains.Tools.MMOnMouse.OnMouseUpAsButton ( )
protectedvirtual

Member Data Documentation

◆ OnMouseDownEvent

UnityEvent MoreMountains.Tools.MMOnMouse.OnMouseDownEvent

OnMouseDown is called when the user has pressed the mouse button while over the Collider.

◆ OnMouseDragEvent

UnityEvent MoreMountains.Tools.MMOnMouse.OnMouseDragEvent

OnMouseDrag is called when the user has clicked on a Collider and is still holding down the mouse.

◆ OnMouseEnterEvent

UnityEvent MoreMountains.Tools.MMOnMouse.OnMouseEnterEvent

Called when the mouse enters the Collider.

◆ OnMouseExitEvent

UnityEvent MoreMountains.Tools.MMOnMouse.OnMouseExitEvent

Called when the mouse is not any longer over the Collider.

◆ OnMouseOverEvent

UnityEvent MoreMountains.Tools.MMOnMouse.OnMouseOverEvent

Called every frame while the mouse is over the Collider.

◆ OnMouseUpAsButtonEvent

UnityEvent MoreMountains.Tools.MMOnMouse.OnMouseUpAsButtonEvent

OnMouseUpAsButton is only called when the mouse is released over the same Collider as it was pressed.

◆ OnMouseUpEvent

UnityEvent MoreMountains.Tools.MMOnMouse.OnMouseUpEvent

OnMouseUp is called when the user has released the mouse button.


The documentation for this class was generated from the following file: