Difference between revisions of "Sprite:contains"

From GiderosMobile
m (Text replacement - "</source>" to "</syntaxhighlight>")
 
(11 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 
'''Available since:''' Gideros 2011.6<br/>
 
'''Available since:''' Gideros 2011.6<br/>
 +
'''Class:''' [[Sprite]]<br/>
 +
 
=== Description ===
 
=== Description ===
<br />
+
Determines whether the specified sprite is contained in the subtree of this '''Sprite''' instance.
Determines whether the specified sprite is contained in the subtree of<br />
+
<syntaxhighlight lang="lua">
this `Sprite` instance.<br />
 
<br />
 
<source lang="lua">
 
 
(bool) = Sprite:contains(child)
 
(bool) = Sprite:contains(child)
</source>
+
</syntaxhighlight>
 +
 
 
=== Parameters ===
 
=== Parameters ===
'''child''': (Sprite) The child object to test. <br/>
+
'''child''': (Sprite) the child object to test<br/>
 +
 
 
=== Return values ===
 
=== Return values ===
'''Returns''' (bool) `true` if the child object is contained in the subtree of this `Sprite` instance, otherwise `false`.<br/>
+
'''Returns''' (bool) ''true'' if the child object is contained in the subtree of this '''Sprite''' instance, otherwise ''false''<br/>
 +
 
 +
{{Sprite}}

Latest revision as of 14:33, 13 July 2023

Available since: Gideros 2011.6
Class: Sprite

Description

Determines whether the specified sprite is contained in the subtree of this Sprite instance.

(bool) = Sprite:contains(child)

Parameters

child: (Sprite) the child object to test

Return values

Returns (bool) true if the child object is contained in the subtree of this Sprite instance, otherwise false