Skip to content

Commit 18ec8cb

Browse files
authored
Merge pull request #11453 from godotengine/classref/sync-6fd949a
classref: Sync with current master branch (6fd949a)
2 parents 4541167 + 5e8c99c commit 18ec8cb

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+2421
-342
lines changed

classes/[email protected]

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3485,17 +3485,17 @@ Additionally, other keywords can be included: ``"exp"`` for exponential range ed
34853485

34863486
:ref:`PropertyHint<enum_@GlobalScope_PropertyHint>` **PROPERTY_HINT_ENUM** = ``2``
34873487

3488-
Hints that an :ref:`int<class_int>` or :ref:`String<class_String>` property is an enumerated value to pick in a list specified via a hint string.
3488+
Hints that an :ref:`int<class_int>`, :ref:`String<class_String>`, or :ref:`StringName<class_StringName>` property is an enumerated value to pick in a list specified via a hint string.
34893489

3490-
The hint string is a comma separated list of names such as ``"Hello,Something,Else"``. Whitespaces are **not** removed from either end of a name. For integer properties, the first name in the list has value 0, the next 1, and so on. Explicit values can also be specified by appending ``:integer`` to the name, e.g. ``"Zero,One,Three:3,Four,Six:6"``.
3490+
The hint string is a comma separated list of names such as ``"Hello,Something,Else"``. Whitespace is **not** removed from either end of a name. For integer properties, the first name in the list has value 0, the next 1, and so on. Explicit values can also be specified by appending ``:integer`` to the name, e.g. ``"Zero,One,Three:3,Four,Six:6"``.
34913491

34923492
.. _class_@GlobalScope_constant_PROPERTY_HINT_ENUM_SUGGESTION:
34933493

34943494
.. rst-class:: classref-enumeration-constant
34953495

34963496
:ref:`PropertyHint<enum_@GlobalScope_PropertyHint>` **PROPERTY_HINT_ENUM_SUGGESTION** = ``3``
34973497

3498-
Hints that a :ref:`String<class_String>` property can be an enumerated value to pick in a list specified via a hint string such as ``"Hello,Something,Else"``.
3498+
Hints that a :ref:`String<class_String>` or :ref:`StringName<class_StringName>` property can be an enumerated value to pick in a list specified via a hint string such as ``"Hello,Something,Else"``. See :ref:`PROPERTY_HINT_ENUM<class_@GlobalScope_constant_PROPERTY_HINT_ENUM>` for details.
34993499

35003500
Unlike :ref:`PROPERTY_HINT_ENUM<class_@GlobalScope_constant_PROPERTY_HINT_ENUM>`, a property with this hint still accepts arbitrary values and can be empty. The list of values serves to suggest possible values.
35013501

@@ -3523,7 +3523,7 @@ Hints that a vector property should allow its components to be linked. For examp
35233523

35243524
Hints that an :ref:`int<class_int>` property is a bitmask with named bit flags.
35253525

3526-
The hint string is a comma separated list of names such as ``"Bit0,Bit1,Bit2,Bit3"``. Whitespaces are **not** removed from either end of a name. The first name in the list has value 1, the next 2, then 4, 8, 16 and so on. Explicit values can also be specified by appending ``:integer`` to the name, e.g. ``"A:4,B:8,C:16"``. You can also combine several flags (``"A:4,B:8,AB:12,C:16"``).
3526+
The hint string is a comma separated list of names such as ``"Bit0,Bit1,Bit2,Bit3"``. Whitespace is **not** removed from either end of a name. The first name in the list has value 1, the next 2, then 4, 8, 16 and so on. Explicit values can also be specified by appending ``:integer`` to the name, e.g. ``"A:4,B:8,C:16"``. You can also combine several flags (``"A:4,B:8,AB:12,C:16"``).
35273527

35283528
\ **Note:** A flag value must be at least ``1`` and at most ``2 ** 32 - 1``.
35293529

@@ -4085,7 +4085,23 @@ If property has ``nil`` as default value, its type will be :ref:`Variant<class_V
40854085

40864086
:ref:`PropertyUsageFlags<enum_@GlobalScope_PropertyUsageFlags>` **PROPERTY_USAGE_ARRAY** = ``262144``
40874087

4088-
The property is an array.
4088+
The property is the element count of a property array, i.e. a list of groups of related properties. Properties defined with this usage also need a specific ``class_name`` field in the form of ``label,prefix``. The field may also include additional comma-separated options:
4089+
4090+
- ``page_size=N``: Overrides :ref:`EditorSettings.interface/inspector/max_array_dictionary_items_per_page<class_EditorSettings_property_interface/inspector/max_array_dictionary_items_per_page>` for this array.
4091+
4092+
- ``add_button_text=text``: The text displayed by the "Add Element" button.
4093+
4094+
- ``static``: The elements can't be re-arranged.
4095+
4096+
- ``const``: New elements can't be added.
4097+
4098+
- ``numbered``: An index will appear next to each element.
4099+
4100+
- ``unfoldable``: The array can't be folded.
4101+
4102+
- ``swap_method=method_name``: The method that will be called when two elements switch places. The method should take 2 :ref:`int<class_int>` parameters, which will be indices of the elements being swapped.
4103+
4104+
Note that making a full-fledged property array requires boilerplate code involving :ref:`Object._get_property_list()<class_Object_private_method__get_property_list>`.
40894105

40904106
.. _class_@GlobalScope_constant_PROPERTY_USAGE_ALWAYS_DUPLICATE:
40914107

classes/class_ccdik3d.rst

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
:github_url: hide
2+
3+
.. DO NOT EDIT THIS FILE!!!
4+
.. Generated automatically from Godot engine sources.
5+
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
6+
.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CCDIK3D.xml.
7+
8+
.. _class_CCDIK3D:
9+
10+
CCDIK3D
11+
=======
12+
13+
**Inherits:** :ref:`IterateIK3D<class_IterateIK3D>` **<** :ref:`ChainIK3D<class_ChainIK3D>` **<** :ref:`IKModifier3D<class_IKModifier3D>` **<** :ref:`SkeletonModifier3D<class_SkeletonModifier3D>` **<** :ref:`Node3D<class_Node3D>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
14+
15+
Rotation based cyclic coordinate descent inverse kinematics solver.
16+
17+
.. rst-class:: classref-introduction-group
18+
19+
Description
20+
-----------
21+
22+
**CCDIK3D** is rotation based IK, enabling fast and effective tracking even with large joint rotations. It's especially suitable for chains with limitations, providing smoother and more stable target tracking compared to :ref:`FABRIK3D<class_FABRIK3D>`.
23+
24+
The resulting twist around the forward vector will always be kept from the previous pose.
25+
26+
\ **Note:** When the target is close to the root, it can cause unnatural movement, including joint flips and oscillations.
27+
28+
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
29+
.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
30+
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
31+
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
32+
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
33+
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
34+
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
35+
.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
36+
.. |void| replace:: :abbr:`void (No return value.)`

0 commit comments

Comments
 (0)