Difference between revisions of "Sprite:hitTestPoint"

From GiderosMobile
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 
'''<translate>Available since</translate>:''' Gideros 2011.6<br/>
 
'''<translate>Available since</translate>:''' Gideros 2011.6<br/>
 +
'''<translate>Class</translate>:''' [[Special:MyLanguage/Sprite|Sprite]]<br/>
 
=== <translate>Description</translate> ===
 
=== <translate>Description</translate> ===
 
<translate><br />
 
<translate><br />
Line 14: Line 15:
 
'''shapeFlag''': (bool) <translate>Take clipping/masking into consideration when testing hit point</translate> '''optional'''<br/>
 
'''shapeFlag''': (bool) <translate>Take clipping/masking into consideration when testing hit point</translate> '''optional'''<br/>
 
=== <translate>Return values</translate> ===
 
=== <translate>Return values</translate> ===
'''<translate>Returns</translate>''' (bool) <translate>[[Special:MyLanguage/true|true]] if the given global coordinates are in bounds of the sprite, [[Special:MyLanguage/false|false]] otherwise.</translate><br/>
+
'''<translate>Returns</translate>''' (bool) <translate>`true` if the given global coordinates are in bounds of the sprite, `false` otherwise.</translate><br/>

Revision as of 09:28, 24 August 2018

Available since: Gideros 2011.6
Class: Sprite

Description


Checks whether the given coordinates (in global coordinate system) is in bounds of the sprite.


(bool) = Sprite:hitTestPoint(x,y,shapeFlag)

Parameters

x: (number)
y: (number)
shapeFlag: (bool) Take clipping/masking into consideration when testing hit point optional

Return values

Returns (bool) `true` if the given global coordinates are in bounds of the sprite, `false` otherwise.