Home Explore Help
Sign In
Godot
/
godot-docs
mirror of https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: 2be4e9b938
Branches Tags
godot-docs
/
classes
/
class_skeletonmodification3dstackholder.rst

class_skeletonmodification3dstackholder.rst 4.1 KB
History Raw

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455 
  1. :github_url: hide
    2. 

  2. 

  3. .. DO NOT EDIT THIS FILE!!!
    4. 

  4. .. Generated automatically from Godot engine sources.
    5. 

  5. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
    6. 

  6. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SkeletonModification3DStackHolder.xml.
    7. 

  7. 

  8. .. _class_SkeletonModification3DStackHolder:
    9. 

  9. 

  10. SkeletonModification3DStackHolder
    11. 

  11. =================================
    12. 

  12. 

  13. **Inherits:** :ref:`SkeletonModification3D<class_SkeletonModification3D>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
    14. 

  14. 

  15. A modification that holds and executes a :ref:`SkeletonModificationStack3D<class_SkeletonModificationStack3D>`.
    16. 

  16. 

  17. Description
    18. 

  18. -----------
    19. 

  19. 

  20. This :ref:`SkeletonModification3D<class_SkeletonModification3D>` holds a reference to a :ref:`SkeletonModificationStack3D<class_SkeletonModificationStack3D>`, allowing you to use multiple modification stacks on a single :ref:`Skeleton3D<class_Skeleton3D>`.
    21. 

  21. 

  22. \ **Note:** The modifications in the held :ref:`SkeletonModificationStack3D<class_SkeletonModificationStack3D>` will only be executed if their execution mode matches the execution mode of the SkeletonModification3DStackHolder.
    23. 

  23. 

  24. Methods
    25. 

  25. -------
    26. 

  26. 

  27. +-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    28. 

  28. | :ref:`SkeletonModificationStack3D<class_SkeletonModificationStack3D>` | :ref:`get_held_modification_stack<class_SkeletonModification3DStackHolder_method_get_held_modification_stack>` **(** **)** |const|                                                                                       |
    29. 

  29. +-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    30. 

  30. | void                                                                  | :ref:`set_held_modification_stack<class_SkeletonModification3DStackHolder_method_set_held_modification_stack>` **(** :ref:`SkeletonModificationStack3D<class_SkeletonModificationStack3D>` held_modification_stack **)** |
    31. 

  31. +-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    32. 

  32. 

  33. Method Descriptions
    34. 

  34. -------------------
    35. 

  35. 

  36. .. _class_SkeletonModification3DStackHolder_method_get_held_modification_stack:
    37. 

  37. 

  38. - :ref:`SkeletonModificationStack3D<class_SkeletonModificationStack3D>` **get_held_modification_stack** **(** **)** |const|
    39. 

  39. 

  40. Returns the :ref:`SkeletonModificationStack3D<class_SkeletonModificationStack3D>` that this modification is holding.
    41. 

  41. 

  42. ----
    43. 

  43. 

  44. .. _class_SkeletonModification3DStackHolder_method_set_held_modification_stack:
    45. 

  45. 

  46. - void **set_held_modification_stack** **(** :ref:`SkeletonModificationStack3D<class_SkeletonModificationStack3D>` held_modification_stack **)**
    47. 

  47. 

  48. Sets the :ref:`SkeletonModificationStack3D<class_SkeletonModificationStack3D>` that this modification is holding. This modification stack will then be executed when this modification is executed.
    49. 

  49. 

  50. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
    51. 

  51. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
    52. 

  52. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
    53. 

  53. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
    54. 

  54. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
    55. 

  55. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
    56.