summaryrefslogtreecommitdiff
path: root/doc/classes/SkeletonModification2DStackHolder.xml
blob: 791dea2fb1203c69fdb97b9dab0120a29d2d555d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
<?xml version="1.0" encoding="UTF-8" ?>
<class name="SkeletonModification2DStackHolder" inherits="SkeletonModification2D" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		A modification that holds and executes a [SkeletonModificationStack2D].
	</brief_description>
	<description>
		This [SkeletonModification2D] holds a reference to a [SkeletonModificationStack2D], allowing you to use multiple modification stacks on a single [Skeleton2D].
		[b]Note:[/b] The modifications in the held [SkeletonModificationStack2D] will only be executed if their execution mode matches the execution mode of the SkeletonModification2DStackHolder.
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="get_held_modification_stack" qualifiers="const">
			<return type="SkeletonModificationStack2D" />
			<description>
				Returns the [SkeletonModificationStack2D] that this modification is holding.
			</description>
		</method>
		<method name="set_held_modification_stack">
			<return type="void" />
			<param index="0" name="held_modification_stack" type="SkeletonModificationStack2D" />
			<description>
				Sets the [SkeletonModificationStack2D] that this modification is holding. This modification stack will then be executed when this modification is executed.
			</description>
		</method>
	</methods>
</class>