Skip to content

Commit cb80512

Browse files
mhilbrunnermhilbrunner
authored
Merge pull request #10517 from godotengine/classref/sync-7b1ed52
classref: Sync with current master branch (7b1ed52)
2 parents 2062dff + a840bd2 commit cb80512

37 files changed

+2335
-86
lines changed

‎classes/class_audiostreamgenerator.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -31,14 +31,14 @@ Here's a sample on how to use it to generate a sine wave:
3131
var playback # Will hold the AudioStreamGeneratorPlayback.
3232
@onready var sample_hz = $AudioStreamPlayer.stream.mix_rate
3333
var pulse_hz = 440.0 # The frequency of the sound wave.
34+
var phase = 0.0
3435

3536
func _ready():
3637
$AudioStreamPlayer.play()
3738
playback = $AudioStreamPlayer.get_stream_playback()
3839
fill_buffer()
3940

4041
func fill_buffer():
41-
var phase = 0.0
4242
var increment = pulse_hz / sample_hz
4343
var frames_available = playback.get_frames_available()
4444

@@ -53,6 +53,7 @@ Here's a sample on how to use it to generate a sine wave:
5353
private AudioStreamGeneratorPlayback _playback; // Will hold the AudioStreamGeneratorPlayback.
5454
private float _sampleHz;
5555
private float _pulseHz = 440.0f; // The frequency of the sound wave.
56+
private double phase = 0.0;
5657

5758
public override void _Ready()
5859
{
@@ -67,7 +68,6 @@ Here's a sample on how to use it to generate a sine wave:
6768

6869
public void FillBuffer()
6970
{
70-
double phase = 0.0;
7171
float increment = _pulseHz / _sampleHz;
7272
int framesAvailable = _playback.GetFramesAvailable();
7373

‎classes/class_audiostreamsynchronized.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Stream that can be fitted with sub-streams, which will be played in-sync.
1919
Description
2020
-----------
2121

22-
This is a stream that can be fitted with sub-streams, which will be played in-sync. The streams being at exactly the same time when play is pressed, and will end when the last of them ends. If one of the sub-streams loops, then playback will continue.
22+
This is a stream that can be fitted with sub-streams, which will be played in-sync. The streams begin at exactly the same time when play is pressed, and will end when the last of them ends. If one of the sub-streams loops, then playback will continue.
2323

2424
.. rst-class:: classref-reftable-group
2525

‎classes/class_colorpicker.rst

+14
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,8 @@ Theme Properties
121121
+-----------------------------------+----------------------------------------------------------------------------------------+---------+
122122
| :ref:`Texture2D<class_Texture2D>` | :ref:`picker_cursor<class_ColorPicker_theme_icon_picker_cursor>` | |
123123
+-----------------------------------+----------------------------------------------------------------------------------------+---------+
124+
| :ref:`Texture2D<class_Texture2D>` | :ref:`picker_cursor_bg<class_ColorPicker_theme_icon_picker_cursor_bg>` | |
125+
+-----------------------------------+----------------------------------------------------------------------------------------+---------+
124126
| :ref:`Texture2D<class_Texture2D>` | :ref:`sample_bg<class_ColorPicker_theme_icon_sample_bg>` | |
125127
+-----------------------------------+----------------------------------------------------------------------------------------+---------+
126128
| :ref:`Texture2D<class_Texture2D>` | :ref:`sample_revert<class_ColorPicker_theme_icon_sample_revert>` | |
@@ -726,6 +728,18 @@ The image displayed over the color box/circle (depending on the :ref:`picker_sha
726728

727729
----
728730

731+
.. _class_ColorPicker_theme_icon_picker_cursor_bg:
732+
733+
.. rst-class:: classref-themeproperty
734+
735+
:ref:`Texture2D<class_Texture2D>` **picker_cursor_bg** :ref:`🔗<class_ColorPicker_theme_icon_picker_cursor_bg>`
736+
737+
The fill image displayed behind the picker cursor.
738+
739+
.. rst-class:: classref-item-separator
740+
741+
----
742+
729743
.. _class_ColorPicker_theme_icon_sample_bg:
730744

731745
.. rst-class:: classref-themeproperty

‎classes/class_cpuparticles2d.rst

+58-2
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,8 @@ Properties
155155
+---------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
156156
| :ref:`Curve<class_Curve>` | :ref:`scale_curve_y<class_CPUParticles2D_property_scale_curve_y>` | |
157157
+---------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
158+
| :ref:`int<class_int>` | :ref:`seed<class_CPUParticles2D_property_seed>` | ``0`` |
159+
+---------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
158160
| :ref:`float<class_float>` | :ref:`speed_scale<class_CPUParticles2D_property_speed_scale>` | ``1.0`` |
159161
+---------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
160162
| :ref:`bool<class_bool>` | :ref:`split_scale<class_CPUParticles2D_property_split_scale>` | ``false`` |
@@ -169,6 +171,8 @@ Properties
169171
+---------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
170172
| :ref:`Texture2D<class_Texture2D>` | :ref:`texture<class_CPUParticles2D_property_texture>` | |
171173
+---------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
174+
| :ref:`bool<class_bool>` | :ref:`use_fixed_seed<class_CPUParticles2D_property_use_fixed_seed>` | ``false`` |
175+
+---------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
172176

173177
.. rst-class:: classref-reftable-group
174178

@@ -189,7 +193,9 @@ Methods
189193
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
190194
| :ref:`bool<class_bool>` | :ref:`get_particle_flag<class_CPUParticles2D_method_get_particle_flag>`\ (\ particle_flag\: :ref:`ParticleFlags<enum_CPUParticles2D_ParticleFlags>`\ ) |const| |
191195
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
192-
| |void| | :ref:`restart<class_CPUParticles2D_method_restart>`\ (\ ) |
196+
| |void| | :ref:`request_particles_process<class_CPUParticles2D_method_request_particles_process>`\ (\ process_time\: :ref:`float<class_float>`\ ) |
197+
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
198+
| |void| | :ref:`restart<class_CPUParticles2D_method_restart>`\ (\ keep_seed\: :ref:`bool<class_bool>` = false\ ) |
193199
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
194200
| |void| | :ref:`set_param_curve<class_CPUParticles2D_method_set_param_curve>`\ (\ param\: :ref:`Parameter<enum_CPUParticles2D_Parameter>`, curve\: :ref:`Curve<class_Curve>`\ ) |
195201
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -1477,6 +1483,23 @@ Each particle's vertical scale will vary along this :ref:`Curve<class_Curve>`. S
14771483

14781484
----
14791485

1486+
.. _class_CPUParticles2D_property_seed:
1487+
1488+
.. rst-class:: classref-property
1489+
1490+
:ref:`int<class_int>` **seed** = ``0`` :ref:`🔗<class_CPUParticles2D_property_seed>`
1491+
1492+
.. rst-class:: classref-property-setget
1493+
1494+
- |void| **set_seed**\ (\ value\: :ref:`int<class_int>`\ )
1495+
- :ref:`int<class_int>` **get_seed**\ (\ )
1496+
1497+
Sets the random seed used by the particle system. Only effective if :ref:`use_fixed_seed<class_CPUParticles2D_property_use_fixed_seed>` is ``true``.
1498+
1499+
.. rst-class:: classref-item-separator
1500+
1501+
----
1502+
14801503
.. _class_CPUParticles2D_property_speed_scale:
14811504

14821505
.. rst-class:: classref-property
@@ -1592,6 +1615,23 @@ Minimum equivalent of :ref:`tangential_accel_max<class_CPUParticles2D_property_t
15921615

15931616
Particle texture. If ``null``, particles will be squares.
15941617

1618+
.. rst-class:: classref-item-separator
1619+
1620+
----
1621+
1622+
.. _class_CPUParticles2D_property_use_fixed_seed:
1623+
1624+
.. rst-class:: classref-property
1625+
1626+
:ref:`bool<class_bool>` **use_fixed_seed** = ``false`` :ref:`🔗<class_CPUParticles2D_property_use_fixed_seed>`
1627+
1628+
.. rst-class:: classref-property-setget
1629+
1630+
- |void| **set_use_fixed_seed**\ (\ value\: :ref:`bool<class_bool>`\ )
1631+
- :ref:`bool<class_bool>` **get_use_fixed_seed**\ (\ )
1632+
1633+
If ``true``, particles will use the same seed for every simulation using the seed defined in :ref:`seed<class_CPUParticles2D_property_seed>`. This is useful for situations where the visual outcome should be consistent across replays, for example when using Movie Maker mode.
1634+
15951635
.. rst-class:: classref-section-separator
15961636

15971637
----
@@ -1661,14 +1701,30 @@ Returns the enabled state of the given particle flag (see :ref:`ParticleFlags<en
16611701

16621702
----
16631703

1704+
.. _class_CPUParticles2D_method_request_particles_process:
1705+
1706+
.. rst-class:: classref-method
1707+
1708+
|void| **request_particles_process**\ (\ process_time\: :ref:`float<class_float>`\ ) :ref:`🔗<class_CPUParticles2D_method_request_particles_process>`
1709+
1710+
Requests the particles to process for extra process time during a single frame.
1711+
1712+
Useful for particle playback, if used in combination with :ref:`use_fixed_seed<class_CPUParticles2D_property_use_fixed_seed>` or by calling :ref:`restart<class_CPUParticles2D_method_restart>` with parameter ``keep_seed`` set to ``true``.
1713+
1714+
.. rst-class:: classref-item-separator
1715+
1716+
----
1717+
16641718
.. _class_CPUParticles2D_method_restart:
16651719

16661720
.. rst-class:: classref-method
16671721

1668-
|void| **restart**\ (\ ) :ref:`🔗<class_CPUParticles2D_method_restart>`
1722+
|void| **restart**\ (\ keep_seed\: :ref:`bool<class_bool>` = false\ ) :ref:`🔗<class_CPUParticles2D_method_restart>`
16691723

16701724
Restarts the particle emitter.
16711725

1726+
If ``keep_seed`` is ``true``, the current random seed will be preserved. Useful for seeking and playback.
1727+
16721728
.. rst-class:: classref-item-separator
16731729

16741730
----

‎classes/class_cpuparticles3d.rst

+58-2
Original file line numberDiff line numberDiff line change
@@ -175,6 +175,8 @@ Properties
175175
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
176176
| :ref:`Curve<class_Curve>` | :ref:`scale_curve_z<class_CPUParticles3D_property_scale_curve_z>` | |
177177
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
178+
| :ref:`int<class_int>` | :ref:`seed<class_CPUParticles3D_property_seed>` | ``0`` |
179+
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
178180
| :ref:`float<class_float>` | :ref:`speed_scale<class_CPUParticles3D_property_speed_scale>` | ``1.0`` |
179181
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
180182
| :ref:`bool<class_bool>` | :ref:`split_scale<class_CPUParticles3D_property_split_scale>` | ``false`` |
@@ -187,6 +189,8 @@ Properties
187189
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
188190
| :ref:`float<class_float>` | :ref:`tangential_accel_min<class_CPUParticles3D_property_tangential_accel_min>` | ``0.0`` |
189191
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
192+
| :ref:`bool<class_bool>` | :ref:`use_fixed_seed<class_CPUParticles3D_property_use_fixed_seed>` | ``false`` |
193+
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
190194
| :ref:`AABB<class_AABB>` | :ref:`visibility_aabb<class_CPUParticles3D_property_visibility_aabb>` | ``AABB(0, 0, 0, 0, 0, 0)`` |
191195
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
192196

@@ -211,7 +215,9 @@ Methods
211215
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
212216
| :ref:`bool<class_bool>` | :ref:`get_particle_flag<class_CPUParticles3D_method_get_particle_flag>`\ (\ particle_flag\: :ref:`ParticleFlags<enum_CPUParticles3D_ParticleFlags>`\ ) |const| |
213217
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
214-
| |void| | :ref:`restart<class_CPUParticles3D_method_restart>`\ (\ ) |
218+
| |void| | :ref:`request_particles_process<class_CPUParticles3D_method_request_particles_process>`\ (\ process_time\: :ref:`float<class_float>`\ ) |
219+
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
220+
| |void| | :ref:`restart<class_CPUParticles3D_method_restart>`\ (\ keep_seed\: :ref:`bool<class_bool>` = false\ ) |
215221
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
216222
| |void| | :ref:`set_param_curve<class_CPUParticles3D_method_set_param_curve>`\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`, curve\: :ref:`Curve<class_Curve>`\ ) |
217223
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -1689,6 +1695,23 @@ Curve for the scale over life, along the z axis.
16891695

16901696
----
16911697

1698+
.. _class_CPUParticles3D_property_seed:
1699+
1700+
.. rst-class:: classref-property
1701+
1702+
:ref:`int<class_int>` **seed** = ``0`` :ref:`🔗<class_CPUParticles3D_property_seed>`
1703+
1704+
.. rst-class:: classref-property-setget
1705+
1706+
- |void| **set_seed**\ (\ value\: :ref:`int<class_int>`\ )
1707+
- :ref:`int<class_int>` **get_seed**\ (\ )
1708+
1709+
Sets the random seed used by the particle system. Only effective if :ref:`use_fixed_seed<class_CPUParticles3D_property_use_fixed_seed>` is ``true``.
1710+
1711+
.. rst-class:: classref-item-separator
1712+
1713+
----
1714+
16921715
.. _class_CPUParticles3D_property_speed_scale:
16931716

16941717
.. rst-class:: classref-property
@@ -1791,6 +1814,23 @@ Minimum tangent acceleration.
17911814

17921815
----
17931816

1817+
.. _class_CPUParticles3D_property_use_fixed_seed:
1818+
1819+
.. rst-class:: classref-property
1820+
1821+
:ref:`bool<class_bool>` **use_fixed_seed** = ``false`` :ref:`🔗<class_CPUParticles3D_property_use_fixed_seed>`
1822+
1823+
.. rst-class:: classref-property-setget
1824+
1825+
- |void| **set_use_fixed_seed**\ (\ value\: :ref:`bool<class_bool>`\ )
1826+
- :ref:`bool<class_bool>` **get_use_fixed_seed**\ (\ )
1827+
1828+
If ``true``, particles will use the same seed for every simulation using the seed defined in :ref:`seed<class_CPUParticles3D_property_seed>`. This is useful for situations where the visual outcome should be consistent across replays, for example when using Movie Maker mode.
1829+
1830+
.. rst-class:: classref-item-separator
1831+
1832+
----
1833+
17941834
.. _class_CPUParticles3D_property_visibility_aabb:
17951835

17961836
.. rst-class:: classref-property
@@ -1887,14 +1927,30 @@ Returns the enabled state of the given particle flag (see :ref:`ParticleFlags<en
18871927

18881928
----
18891929

1930+
.. _class_CPUParticles3D_method_request_particles_process:
1931+
1932+
.. rst-class:: classref-method
1933+
1934+
|void| **request_particles_process**\ (\ process_time\: :ref:`float<class_float>`\ ) :ref:`🔗<class_CPUParticles3D_method_request_particles_process>`
1935+
1936+
Requests the particles to process for extra process time during a single frame.
1937+
1938+
Useful for particle playback, if used in combination with :ref:`use_fixed_seed<class_CPUParticles3D_property_use_fixed_seed>` or by calling :ref:`restart<class_CPUParticles3D_method_restart>` with parameter ``keep_seed`` set to ``true``.
1939+
1940+
.. rst-class:: classref-item-separator
1941+
1942+
----
1943+
18901944
.. _class_CPUParticles3D_method_restart:
18911945

18921946
.. rst-class:: classref-method
18931947

1894-
|void| **restart**\ (\ ) :ref:`🔗<class_CPUParticles3D_method_restart>`
1948+
|void| **restart**\ (\ keep_seed\: :ref:`bool<class_bool>` = false\ ) :ref:`🔗<class_CPUParticles3D_method_restart>`
18951949

18961950
Restarts the particle emitter.
18971951

1952+
If ``keep_seed`` is ``true``, the current random seed will be preserved. Useful for seeking and playback.
1953+
18981954
.. rst-class:: classref-item-separator
18991955

19001956
----

0 commit comments

Comments
 (0)