mirror of
https://github.com/Relintai/pandemonium_engine_docs.git
synced 2025-01-23 15:17:21 +01:00
51 lines
2.1 KiB
ReStructuredText
51 lines
2.1 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. DO NOT EDIT THIS FILE!!!
|
|
.. Generated automatically from Godot engine sources.
|
|
.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py.
|
|
.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/YSort.xml.
|
|
|
|
.. _class_YSort:
|
|
|
|
YSort
|
|
=====
|
|
|
|
**Inherits:** :ref:`Node2D<class_Node2D>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
|
|
|
|
Sort all child nodes based on their Y positions.
|
|
|
|
Description
|
|
-----------
|
|
|
|
Sort all child nodes based on their Y positions. The child node must inherit from :ref:`CanvasItem<class_CanvasItem>` for it to be sorted. Nodes that have a higher Y position will be drawn later, so they will appear on top of nodes that have a lower Y position.
|
|
|
|
Nesting of YSort nodes is possible. Children YSort nodes will be sorted in the same space as the parent YSort, allowing to better organize a scene or divide it in multiple ones, yet keep the unique sorting.
|
|
|
|
Properties
|
|
----------
|
|
|
|
+-------------------------+--------------------------------------------------------+----------+
|
|
| :ref:`bool<class_bool>` | :ref:`sort_enabled<class_YSort_property_sort_enabled>` | ``true`` |
|
|
+-------------------------+--------------------------------------------------------+----------+
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_YSort_property_sort_enabled:
|
|
|
|
- :ref:`bool<class_bool>` **sort_enabled**
|
|
|
|
+-----------+-------------------------+
|
|
| *Default* | ``true`` |
|
|
+-----------+-------------------------+
|
|
| *Setter* | set_sort_enabled(value) |
|
|
+-----------+-------------------------+
|
|
| *Getter* | is_sort_enabled() |
|
|
+-----------+-------------------------+
|
|
|
|
If ``true``, child nodes are sorted, otherwise sorting is disabled.
|
|
|
|
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
|
|
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
|
|
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
|