mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
113 lines
7.3 KiB
ReStructuredText
113 lines
7.3 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the SkeletonModification2DPhysicalBones.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
.. _class_SkeletonModification2DPhysicalBones:
|
|
|
|
SkeletonModification2DPhysicalBones
|
|
===================================
|
|
|
|
**Inherits:** :ref:`SkeletonModification2D<class_SkeletonModification2D>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
|
|
|
|
A modification that applies the transforms of :ref:`PhysicalBone2D<class_PhysicalBone2D>` nodes to :ref:`Bone2D<class_Bone2D>` nodes.
|
|
|
|
Description
|
|
-----------
|
|
|
|
This modification takes the transforms of :ref:`PhysicalBone2D<class_PhysicalBone2D>` nodes and applies them to :ref:`Bone2D<class_Bone2D>` nodes. This allows the :ref:`Bone2D<class_Bone2D>` nodes to react to physics thanks to the linked :ref:`PhysicalBone2D<class_PhysicalBone2D>` nodes.
|
|
|
|
Properties
|
|
----------
|
|
|
|
+-----------------------+------------------------------------------------------------------------------------------------------------------+-------+
|
|
| :ref:`int<class_int>` | :ref:`physical_bone_chain_length<class_SkeletonModification2DPhysicalBones_property_physical_bone_chain_length>` | ``0`` |
|
|
+-----------------------+------------------------------------------------------------------------------------------------------------------+-------+
|
|
|
|
Methods
|
|
-------
|
|
|
|
+---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`fetch_physical_bones<class_SkeletonModification2DPhysicalBones_method_fetch_physical_bones>` **(** **)** |
|
|
+---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`NodePath<class_NodePath>` | :ref:`get_physical_bone_node<class_SkeletonModification2DPhysicalBones_method_get_physical_bone_node>` **(** :ref:`int<class_int>` joint_idx **)** |const| |
|
|
+---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_physical_bone_node<class_SkeletonModification2DPhysicalBones_method_set_physical_bone_node>` **(** :ref:`int<class_int>` joint_idx, :ref:`NodePath<class_NodePath>` physicalbone2d_node **)** |
|
|
+---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`start_simulation<class_SkeletonModification2DPhysicalBones_method_start_simulation>` **(** :ref:`StringName[]<class_StringName>` bones=[] **)** |
|
|
+---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`stop_simulation<class_SkeletonModification2DPhysicalBones_method_stop_simulation>` **(** :ref:`StringName[]<class_StringName>` bones=[] **)** |
|
|
+---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_SkeletonModification2DPhysicalBones_property_physical_bone_chain_length:
|
|
|
|
- :ref:`int<class_int>` **physical_bone_chain_length**
|
|
|
|
+-----------+---------------------------------------+
|
|
| *Default* | ``0`` |
|
|
+-----------+---------------------------------------+
|
|
| *Setter* | set_physical_bone_chain_length(value) |
|
|
+-----------+---------------------------------------+
|
|
| *Getter* | get_physical_bone_chain_length() |
|
|
+-----------+---------------------------------------+
|
|
|
|
The amount of :ref:`PhysicalBone2D<class_PhysicalBone2D>` nodes linked in this modification.
|
|
|
|
Method Descriptions
|
|
-------------------
|
|
|
|
.. _class_SkeletonModification2DPhysicalBones_method_fetch_physical_bones:
|
|
|
|
- void **fetch_physical_bones** **(** **)**
|
|
|
|
Empties the list of :ref:`PhysicalBone2D<class_PhysicalBone2D>` nodes and populates it will all :ref:`PhysicalBone2D<class_PhysicalBone2D>` nodes that are children of the :ref:`Skeleton2D<class_Skeleton2D>`.
|
|
|
|
----
|
|
|
|
.. _class_SkeletonModification2DPhysicalBones_method_get_physical_bone_node:
|
|
|
|
- :ref:`NodePath<class_NodePath>` **get_physical_bone_node** **(** :ref:`int<class_int>` joint_idx **)** |const|
|
|
|
|
Returns the :ref:`PhysicalBone2D<class_PhysicalBone2D>` node at ``joint_idx``.
|
|
|
|
----
|
|
|
|
.. _class_SkeletonModification2DPhysicalBones_method_set_physical_bone_node:
|
|
|
|
- void **set_physical_bone_node** **(** :ref:`int<class_int>` joint_idx, :ref:`NodePath<class_NodePath>` physicalbone2d_node **)**
|
|
|
|
Sets the :ref:`PhysicalBone2D<class_PhysicalBone2D>` node at ``joint_idx``.
|
|
|
|
\ **Note:** This is just the index used for this modification, not the bone index used in the :ref:`Skeleton2D<class_Skeleton2D>`.
|
|
|
|
----
|
|
|
|
.. _class_SkeletonModification2DPhysicalBones_method_start_simulation:
|
|
|
|
- void **start_simulation** **(** :ref:`StringName[]<class_StringName>` bones=[] **)**
|
|
|
|
Tell the :ref:`PhysicalBone2D<class_PhysicalBone2D>` nodes to start simulating and interacting with the physics world.
|
|
|
|
Optionally, an array of bone names can be passed to this function, and that will cause only :ref:`PhysicalBone2D<class_PhysicalBone2D>` nodes with those names to start simulating.
|
|
|
|
----
|
|
|
|
.. _class_SkeletonModification2DPhysicalBones_method_stop_simulation:
|
|
|
|
- void **stop_simulation** **(** :ref:`StringName[]<class_StringName>` bones=[] **)**
|
|
|
|
Tell the :ref:`PhysicalBone2D<class_PhysicalBone2D>` nodes to stop simulating and interacting with the physics world.
|
|
|
|
Optionally, an array of bone names can be passed to this function, and that will cause only :ref:`PhysicalBone2D<class_PhysicalBone2D>` nodes with those names to stop simulating.
|
|
|
|
.. |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.)`
|
|
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
|
|
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
|
|
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
|