Difference between revisions of "Sprite:getLayoutInfo"

From GiderosMobile
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
<languages />
+
'''Available since:''' Gideros 2018.9<br/>
'''<translate>Available since</translate>:''' Gideros 2018.9<br/>
+
'''Class:''' [[Sprite]]<br/>
'''<translate>Class</translate>:''' [[Special:MyLanguage/Sprite|Sprite]]<br/>
+
 
=== <translate>Description</translate> ===
+
=== Description ===
<translate><br />
 
<br />
 
 
Returns computed placement value according to Gideros layout system.
 
Returns computed placement value according to Gideros layout system.
The returned table can contain the following fields:
 
* '''startx''': The 0-based index of the column the child was placed into<br/>
 
* '''starty''': The 0-based index of the row the child was placed into<br/>
 
* '''width''': The width of the child<br/>
 
* '''height''': The height of the child<br/>
 
* '''weightx''': The horizontal weight of the child<br/>
 
* '''weighty''': The vertical weight of the child<br/>
 
* '''minWidth''' (table): Minimum width<br/>
 
* '''minHeight''' (table): Minimum height<br/></translate>
 
 
<source lang="lua">
 
<source lang="lua">
 
(table) = Sprite:getLayoutInfo()
 
(table) = Sprite:getLayoutInfo()
 
</source>
 
</source>
  
=== <translate>Return values</translate> ===
+
The returned table can contain the following fields:
'''<translate>Returns</translate>''' (table) <translate>Table of layout information.</translate><br/>
+
* '''startx''': the 0-based index of the column the child was placed into
 +
* '''starty''': the 0-based index of the row the child was placed into
 +
* '''width''': the width of the child
 +
* '''height''': the height of the child
 +
* '''weightx''': the horizontal weight of the child
 +
* '''weighty''': the vertical weight of the child
 +
* '''minWidth''' (table): minimum width
 +
* '''minHeight''' (table): minimum height
 +
 
 +
=== Return values ===
 +
'''Returns''' (table) table of layout information<br/>
  
 
{{Sprite}}
 
{{Sprite}}

Revision as of 18:02, 7 February 2023

Available since: Gideros 2018.9
Class: Sprite

Description

Returns computed placement value according to Gideros layout system.

(table) = Sprite:getLayoutInfo()

The returned table can contain the following fields:

  • startx: the 0-based index of the column the child was placed into
  • starty: the 0-based index of the row the child was placed into
  • width: the width of the child
  • height: the height of the child
  • weightx: the horizontal weight of the child
  • weighty: the vertical weight of the child
  • minWidth (table): minimum width
  • minHeight (table): minimum height

Return values

Returns (table) table of layout information