7adf4cc9b5
For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
30 lines
1.3 KiB
XML
30 lines
1.3 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="SkeletonModification2DStackHolder" inherits="SkeletonModification2D" version="4.0">
|
|
<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" />
|
|
<argument 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>
|
|
<constants>
|
|
</constants>
|
|
</class>
|