summaryrefslogtreecommitdiff
path: root/doc/classes/YSort.xml
blob: 4ef6a4b4ec540e5b613334ffc39fec40cfc6fe85 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
<?xml version="1.0" encoding="UTF-8" ?>
<class name="YSort" inherits="Node2D" version="4.0">
	<brief_description>
		Sort all child nodes based on their Y positions.
	</brief_description>
	<description>
		Sort all child nodes based on their Y positions. The child node must inherit from [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.
	</description>
	<tutorials>
	</tutorials>
	<methods>
	</methods>
	<members>
		<member name="sort_enabled" type="bool" setter="set_sort_enabled" getter="is_sort_enabled" default="true">
			If [code]true[/code], child nodes are sorted, otherwise sorting is disabled.
		</member>
	</members>
	<constants>
	</constants>
</class>