Packagealternativa.utils
Classpublic class MouseUtils

Mouse utilities. It is necessary to call MouseUtils.init() method before using this class methods.

See also

init()

Public Methods
 MethodDefined by
  
globalCoords(stageLimit:Boolean = true):Point
[static]Get global mouse coordinates.
MouseUtils
  
init(stage:Stage):void
[static]Class initialization.
MouseUtils
  
localCoords(object:DisplayObject):Point
[static]Get local mouse coordinates on a specified object.
MouseUtils
Method detail
globalCoords()method
public static function globalCoords(stageLimit:Boolean = true):Point

Get global mouse coordinates.

Parameters
stageLimit:Boolean (default = true) — to limit couse coordinates by stage size, or not

Returns
Point — global mouse coordinates

Throws
Error — if MouseUtility.init() was not called before
init()method 
public static function init(stage:Stage):void

Class initialization. It is necessary to call this method before using class methods.

Parameters
stage:Stage — stage
localCoords()method 
public static function localCoords(object:DisplayObject):Point

Get local mouse coordinates on a specified object.

Parameters
object:DisplayObject — object that is being used to get local mouse coordinates

Returns
Point — local mouse coordinates on a specified object.