Andrii Doroshenko (Xrayez)
0ff0fdef5c
Document shape metadata for TileMap
...
(cherry picked from commit 0c2dbd01dc
)
2021-01-26 17:24:39 +01:00
Hugo Locurcio
9a3c5033f7
Document the expected low performance of VideoPlayer on HTML5
...
(cherry picked from commit b98540dd9d
)
2021-01-26 17:00:17 +01:00
Hugo Locurcio
e2a2005a48
Document low performance of Array.push_front()
and Array.pop_front()
...
(cherry picked from commit 7ce3cc0478
)
2021-01-26 17:00:16 +01:00
Hugo Locurcio
af891cebe4
Document that the high-level multiplayer API is only for Godot servers
...
(cherry picked from commit 1b03f3f72b
)
2021-01-26 17:00:16 +01:00
Nils Reid
349f25429b
Exposed find_next_valid_focus and find_prev_valid_focus.
...
(cherry picked from commit 3e94c23fa5
)
2021-01-26 17:00:16 +01:00
Hugo Locurcio
22bb9fcd82
Document a built-in use of Resource.resource_name
...
(cherry picked from commit 1a606b1a04
)
2021-01-26 17:00:16 +01:00
Ryan Roden-Corrent
c31bb02a3e
Clarify that create_timer does not require cleanup.
...
This is how I would expect it to work, but the docs didn't clarify, so I
had to check the source just to make sure I wasn't responsible for
freeing the timer:
d39f6386ce/scene/main/scene_tree.cpp (L473)
(cherry picked from commit 6e7e4f82ec
)
2021-01-26 17:00:16 +01:00
Andrii Doroshenko (Xrayez)
ee73e4aa24
Document GPU particles visibility rect/aabb behavior
...
(cherry picked from commit b4675973fd
)
2021-01-26 17:00:15 +01:00
Hugo Locurcio
86ca5ff5f0
Document that ShaderMaterial doesn't support GIProbe emission
2021-01-25 18:19:10 +01:00
Hugo Locurcio
9dbdec7e33
Document workaround for storing 64-bit floats in PoolRealArray
2021-01-16 21:46:01 +01:00
Hugo Locurcio
e2c13c00f7
Document that PoolRealArray stores 32-bit floats
...
This closes #45230 .
2021-01-16 16:48:09 +01:00
Phischermen
708f690b50
Add info about how gizmos affect transform notifications
...
(cherry picked from commit 72d1d7e948
)
2021-01-15 16:49:46 +01:00
Andrii Doroshenko (Xrayez)
b124c0c466
Expose Resource.emit_changed()
to script
...
Also known as `emit_signal("changed")`.
(cherry picked from commit e94f46dcdb
)
2021-01-15 16:49:46 +01:00
Alexander Pech
d73281a350
Keep RichTextLabel visible character properties in sync
...
The RichTextLabel class is inconsistent in how it updates the
visible_characters and percent_visible properties when either is changed.
To keep both properties consistent, update percent_visible when setting the
visible_characters property.
For both properties, when setting one, notify change for the other.
Docs updated for member set_visible_characters on RichTextLabel class.
(cherry picked from commit 463e2002ab
)
2021-01-15 16:49:46 +01:00
Rémi Verschelde
497653ab53
Merge pull request #44628 from JFonS/new_cpu_lightmapper_3.2
...
[3.2] New CPU lightmapper
2021-01-15 13:25:46 +01:00
JFonS
b1ca82c43a
CPU lightmapper fixes.
...
- Fix Embree runtime when using MinGW (patch by @RandomShaper).
- Fix baking of lightmaps on GridMaps.
- Fix some GLSL errors.
- Fix overflow in the number of shader variants (GLES2).
2021-01-15 12:32:54 +01:00
JFonS
d909592fc5
Add documentation for new CPU lightmapper.
2021-01-15 12:31:46 +01:00
Marcel Admiraal
253b1c22da
Rename the final parameter of area_shape_entered-exited local_shape.
2021-01-15 09:46:19 +00:00
Marcel Admiraal
cdcd425432
Update area-body_shape_entered-exited signal documentation.
2021-01-15 09:46:17 +00:00
Rémi Verschelde
d298949513
Merge pull request #42882 from madmiraal/fix-39767-3.2
...
[3.2] Set Bullet collision shape index to zero when using a single shape or ConcavePolygonShape
2021-01-14 20:46:06 +01:00
Rémi Verschelde
152415a006
Merge pull request #43924 from madmiraal/fix-43588-3.2
...
[3.2] Fix cast_motion sometimes failing
2021-01-14 20:44:40 +01:00
Rémi Verschelde
b9c5e2f9eb
doc: Sync classref with current source
...
And fix copyright headers in new code.
2021-01-13 16:55:27 +01:00
TechnoPorg
d824efda75
Fix incorrect parameter in audio_track_set_key_stream.
...
The description for audio_track_set_key_stream referenced a parameter called offset, which is not a parameter for that method. The description now references the correct parameter, stream.
(cherry picked from commit 81dc9be973
)
2021-01-13 16:17:10 +01:00
skyace65
45cdb8aab3
Remove the implication that references and resources are not objected from their description
...
(cherry picked from commit dca298d22b
)
2021-01-13 16:17:10 +01:00
Andrii Doroshenko (Xrayez)
9c9ac159e9
Clarify lstrip()/rstrip()
methods in String
for removed characters
...
(cherry picked from commit a2c82bbf5f
)
2021-01-13 16:17:09 +01:00
kobewi
d16f2bddee
Clarify class_get_method_list() in release exports
...
(cherry picked from commit 84acafb2ce
)
2021-01-13 16:17:07 +01:00
Andrii Doroshenko (Xrayez)
acd9abe507
Add AspectRatioContainer
class
...
Backported from ba68383706
.
Co-authored-by: Ugis Brekis <ugis.brekis@productmadness.com>
2021-01-12 16:25:26 +02:00
lawnjelly
690e07b509
Dynamic BVH for rendering and godot physics
...
Complete rewrite of spatial partitioning using a bounding volume hierarchy rather than octree.
Switchable in project settings between using octree or BVH for rendering and physics.
2021-01-12 12:12:10 +00:00
Andrii Doroshenko (Xrayez)
47899e67c5
Add ability to restore RandomNumberGenerator
state
...
3.2 version of b5107715f1
.
`get_seed()` still returns the previous state and not the initial seed,
because users may rely on this behavior for resetting the state in 3.2.
Documented this is going to be fixed in 4.0.
Co-authored-by: MidZik <matt.idzik1@gmail.com>
2021-01-08 15:02:02 +02:00
Rémi Verschelde
3d31433229
doc: Remove links to RNG tutorial, not yet in 3.2 branch
2021-01-07 14:33:36 +01:00
Hugo Locurcio
cec16357ef
Document the requirement to update GPU particle visibility
...
This also updates some option names in the editor for consistency
and accuracy.
See #44955 .
2021-01-06 19:17:57 +01:00
Rémi Verschelde
d7102ac78f
doc: Sync classref with current source
2021-01-05 21:33:34 +01:00
Hugo Locurcio
7fb212fdb6
Mention that the delta
argument is in seconds in Node documentation
...
(cherry picked from commit fcb6ecaf21
)
2021-01-05 21:33:34 +01:00
Maganty Rushyendra
90d1d580af
Explain A Star pathfinding algorithm cost calcuation
...
(cherry picked from commit f6634648ce
)
2021-01-05 21:33:33 +01:00
Rémi Verschelde
66bfe855a8
Revert "Add a project setting to enable stdout flushing in release builds"
...
This reverts commit 341b9cf15a
.
This makes the logger crash when used during cleanup: #44850 .
2021-01-05 21:33:33 +01:00
Maganty Rushyendra
d2241a2b5f
Specify order of drawing of Nodes in raise() description
...
(cherry picked from commit a67ef5999d
)
2021-01-05 21:33:32 +01:00
Hugo Locurcio
58efe5f313
Document the desktop-only file logging setting override
...
This closes https://github.com/godotengine/godot-docs/issues/4505 .
(cherry picked from commit bd0b7003e0
)
2021-01-05 20:49:00 +01:00
Eoin O'Neill
650f7c6f35
StateMachinePlayback: Added missing bindings to get_current_play_pos
and get_current_length
.
...
This allows the user to query the AnimationNodeStateMachinePlayback's current
play position and total length of current animation state. These methods are currently
used in the editor plugin, but can also be useful for querying general playback state
information.
Added documentation for AnimationNodeStateMachinePlayback's `get_current_play_position`
(cherry picked from commit 674fb52f52
)
2021-01-05 20:48:57 +01:00
Yuri Roubinsky
adfc646f8c
Added optional id parameter to PopupMenu::add_separator
...
(cherry picked from commit ca8c794d04
)
2020-12-30 09:57:01 +01:00
Hugo Locurcio
e2ff3ab88f
Document RichTextLabel not supporting entangled BBCode tags
...
See #44634 .
(cherry picked from commit 3b6612e48e
)
2020-12-30 09:56:17 +01:00
Rémi Verschelde
a24a6d510f
doc: Sync classref with current source
2020-12-29 16:02:45 +01:00
kobewi
151fa897fb
Complete documentation of EditorExportPlugin
...
(cherry picked from commit 8b231aff28
)
2020-12-29 16:02:03 +01:00
kobewi
a227eefd2d
Rename offset to point in remove_point()
...
(cherry picked from commit 4f72a07eaa
)
2020-12-29 16:02:03 +01:00
Jummit
27bfacd425
fix missing "s" in Viewport docs
...
(cherry picked from commit 63456bdd8a
)
2020-12-29 16:02:03 +01:00
kobewi
9150d35699
Mention that change_scene is deferred
...
(cherry picked from commit 86aa9b1233
)
2020-12-29 16:02:02 +01:00
Hugo Locurcio
f50c0d9503
Fix confusing SliderJoint3D brief description
...
(cherry picked from commit 27f964d538
)
2020-12-29 16:02:02 +01:00
Hugo Locurcio
76b5cde0b2
Document how to solve UV jittering when using large procedural meshes
...
(cherry picked from commit a86ed339a4
)
2020-12-29 16:02:01 +01:00
Yuri Roubinsky
bafbb238af
Added a note describing a code behind Vector2/3.direction_to
...
(cherry picked from commit fa0683ed30
)
2020-12-29 16:02:00 +01:00
Hugo Locurcio
f5f04a10f5
Add a project setting to enable stdout flushing in release builds
...
This can be used in server builds for journalctl compatibility.
(cherry picked from commit 341b9cf15a
)
2020-12-29 16:02:00 +01:00
Fabio Alessandrelli
53988c7de3
Add important note about OS.get_unixtime.
...
Should NEVER be used for precise time computations since its return
values are not guaranteed to be monotonic.
(cherry picked from commit 49741d9464
)
2020-12-29 16:01:59 +01:00
Marcus Brummer
d3d34dc73b
Fixed Geometry2D::get_closest_points_between_segments docs
...
(cherry picked from commit 56e5ca38d7
)
2020-12-29 16:01:59 +01:00
Rémi Verschelde
1a64f5d2ec
ProximityGroup: Fix access modifiers, rename private methods for clarity
...
See #36285 which mistakenly added documentation for the whole C++ API, while
some of it is meant to be and stay private as it's not exposed to scripts.
The access modifiers and method prefix were not used properly.
Cleanup code, and rename wrong `group_name` parameters to `method`, as it's a
method name which is being broadcast.
This is a very old class from pre-open source days, chances are that it was
just forgotten and not meant to be kept as is and undocumented.
(cherry picked from commit 79ba70f7ee
)
2020-12-29 16:01:58 +01:00
Rémi Verschelde
a4d25a115e
Merge pull request #44460 from theogen-ratkin/3.2
...
[3.2] Add interpolation parameter to resize_to_po2()
2020-12-19 09:36:01 +01:00
Theogen Ratkin
8f6a6ac8d0
Add interpolation parameter to resize_to_po2()
...
Image::resize_to_po2() now takes an optional p_interpolation parameter
that it passes directly to resize() with default value INTERPOLATE_BILINEAR.
GLES2: call resize_to_po2() with interpolate argument
Call resize_to_po2() in GLES2 rasterizer storage with either
INTERPOLATE_BILINEAR or INTERPOLATE_NEAREST depending on TEXTURE_FLAG_FILTER.
This avoids filtering issues with non power of two pixel art textures.
See #44379
2020-12-18 14:02:38 -04:00
Yuri Sizov
816fef21f9
Add a minimap to the GraphEdit
2020-12-18 01:31:17 +03:00
Rémi Verschelde
9710a38637
Merge pull request #44435 from Calinou/fix-max-renderable-elements-hint
...
Fix invalid property hint for `max_renderable_elements` project setting
2020-12-16 21:59:29 +01:00
Hugo Locurcio
680312b95a
Fix invalid property hint for max_renderable_elements
project setting
...
This closes #36240 .
2020-12-16 19:33:15 +01:00
skyace65
04926adb8a
[3.2] Document what can be used as a type hint
2020-12-15 22:34:25 -05:00
Marcel Admiraal
825ad65fc4
Remove Generic6DOFJoint precision property
2020-12-15 10:15:42 +00:00
Hugo Locurcio
9c234abdc9
Document the argument count limit in SceneTree.call_group()
...
This limitation should be lifted in 4.0 thanks to the new method
binding system, but it's still present in 3.2.x.
2020-12-15 00:53:40 +01:00
Hugo Locurcio
f2b04e8865
Document that changing the particle amount resets emission
...
See #16352 .
2020-12-11 15:38:55 +01:00
Rémi Verschelde
0c7a9bd283
doc: Sync classref with current source
...
And fix broken doctool after #43948 .
2020-12-10 14:22:31 +01:00
volzhs
c904cf612a
Add option to draw all tabs in front
...
(cherry picked from commit 814f9015f8
)
2020-12-10 13:07:49 +01:00
Michael Alexsander
32da9dc1e9
Add "font_color_separator" theme property to 'PopupMenu'
...
(cherry picked from commit 383e8919e0
)
2020-12-10 13:06:15 +01:00
Tomasz Chabora
99a6cf77dd
Mention that 'changed' signal needs manual emit
...
(cherry picked from commit b552c26c68
)
2020-12-10 13:03:25 +01:00
Hugo Locurcio
b1919a3ed0
Document the lack of localization remapping support in VideoPlayer
...
See #43917 .
(cherry picked from commit 1636fb8856
)
2020-12-10 13:03:05 +01:00
Danil Alexeev
6c3a0e3a5a
Several edits to the GDScript docs
...
(cherry picked from commit bf96056ad0
)
2020-12-09 11:22:03 +01:00
Hugo Locurcio
eda04c6b6c
Fix incorrect Curve3D.interpolate_baked()
description
...
The offset is in 3D units, not pixels.
This closes https://github.com/godotengine/godot-docs/issues/4339 .
(cherry picked from commit 5a9600cd24
)
2020-12-02 16:03:06 +01:00
Jummit
deda90bad7
add root_node as property of MultiplayerAPI
...
(cherry picked from commit d4c4d2db4c
)
2020-12-01 09:00:54 +01:00
Hugo Locurcio
d8c90f5f1e
Improve the ProjectSettings.globalize_path()
documentation
...
This closes https://github.com/godotengine/godot-docs/issues/4409 .
(cherry picked from commit f415db5b75
)
2020-12-01 09:00:52 +01:00
Rémi Verschelde
dbb69f8f49
doc: Mention iOS support for Input gravity/gyroscope sensors
...
It has been implemented for iOS a long time ago already with #7127 .
(cherry picked from commit 2d0fda3ca2
)
2020-12-01 09:00:48 +01:00
Marcel Admiraal
2e99b5b137
Fix cast_motion sometimes failing
...
- Fixes Godot physics failing when the cast Shape is inside of, or
already colliding with another Shape.
- Fixes Bullet physics failing when there is no motion.
- Ensures Godot and Bullet physics behave the same.
- Updates the documentation to exclude the caveats for the failures and
differences.
2020-11-27 15:32:25 +00:00
jfons
bdc6f2fd95
Fix binding of default value in EditorSpatialGizmoPlugin::get_material()
...
It was commented for some reason I can't remember.
(cherry picked from commit e6949dae72
)
2020-11-26 09:38:47 +01:00
Hugo Locurcio
9706b78a3f
Document C# garbage collection caveats in Reference and Resource
...
(cherry picked from commit 0565c76e8b
)
2020-11-26 09:38:47 +01:00
Hugo Locurcio
b2b5d9a7a3
Improve the AudioStreamPlayer3D class documentation
...
(cherry picked from commit 95618e2937
)
2020-11-26 09:38:47 +01:00
Rémi Verschelde
ac8dedd532
doc: Warn about using Node internal processing
...
See #43689 .
Also 'fixed' some spelling for behavior in publicly visible strings.
(Sorry en_GB, en_CA, en_AU, and more... Silicon Valley won the tech spelling
war.)
(cherry picked from commit a655de89e3
)
2020-11-26 09:38:45 +01:00
Hugo Locurcio
8adaf603d1
Update the number of lights supported in OmniLight and SpotLight docs
...
Follow-up to #43606 .
2020-11-20 14:07:33 +01:00
Phischermen
776faa5c92
Clarify that SceneTree::quit() does not immediately end the application.
...
(cherry picked from commit 371d12a2f0
)
2020-11-19 17:15:27 +01:00
Andrii Doroshenko (Xrayez)
2edd489f83
Describe ImageTexture
, Image
creation and usage
...
Ported from commit 0ee88d6705
.
2020-11-17 18:06:52 +02:00
Rémi Verschelde
d099b6cf60
Merge pull request #43606 from NHodgesVFX/3.2
...
Make lights_per_object configurable
2020-11-17 16:20:38 +01:00
Unknown
5965fbd9fa
Make lights_per_object configurable
2020-11-17 10:03:44 -05:00
Rémi Verschelde
fc718d87a6
doc: Add description for rendering/quality/2d/use_transform_snap
...
Co-authored-by: lawnjelly <lawnjelly@gmail.com>
2020-11-17 12:23:58 +01:00
Ryan Roden-Corrent
07c8e25078
Clarify Curve3D.get_point_{in,out} position in doc.
...
I verified this experimentally. I added a point at roughly (1,0,0), and
dragged a handle back to the origin. The result was:
```
get_point_position: (0.991079, 0, -0.000069)
get_point_in: (0.993409, 0, 0)
get_point_out: (-0.993409, 0, 0)
```
(cherry picked from commit c6093ae612
)
2020-11-17 12:07:02 +01:00
Tomasz Chabora
17af75953f
Correct the doc about Tree.get_edited
...
(cherry picked from commit b8145c182b
)
2020-11-17 12:07:02 +01:00
Hugo Locurcio
e53a5f6be5
Improve the Dictionary class documentation
...
- Mention Lua-style syntax.
- Make the code samples self-contained.
- Mention caveat with `const` (also in Array).
- Clarify the description of `size()`.
This closes https://github.com/godotengine/godot-docs/issues/4272 .
(cherry picked from commit 5325de4e6b
)
2020-11-17 12:07:02 +01:00
Hugo Locurcio
92f81ff782
Clarify packet peer max_buffer_po2
in ProjectSettings documentation
...
This closes https://github.com/godotengine/godot-docs/issues/4364 .
(cherry picked from commit c475b1fd0b
)
2020-11-17 12:07:02 +01:00
Feniks
c58b5c5df4
Changed mouse cursor to the caret (text cursor) location.
...
(cherry picked from commit 59ed3c1aaf
)
2020-11-17 12:01:58 +01:00
Wilson E. Alvarez
aa6406874e
Document InstancePlaceholder.create_instance not being thread-safe.
...
(cherry picked from commit a6f3ef3ac7
)
2020-11-17 12:01:58 +01:00
HaSa1002
18d65673af
Docs: MeshDataTool: showcase tool in code example
...
(cherry picked from commit 4f9b993423
)
2020-11-17 12:01:58 +01:00
Rémi Verschelde
fc5b106369
Merge pull request #42168 from madmiraal/fix-42108-3.2
...
[3.2] Remove the unnecessary sync() and the restrictions it imposes on 3D Physics.
2020-11-16 09:33:17 +01:00
Aaron Franke
9c83b8ed70
[3.2] Improve comments in Color documentation
2020-11-14 04:56:18 -05:00
Rémi Verschelde
a57b6eb211
doc: Sync classref with current source
...
Move EditorSceneImporterFBX doc to its module folder.
2020-11-11 17:00:41 +01:00
PouleyKetchoupp
9b64646bc3
Expose LineEdit scroll offset to scripts
...
(cherry picked from commit 4775db1600
)
2020-11-11 15:44:18 +01:00
Tomasz Chabora
98774000e2
Add append_array() method to Array class
...
(cherry picked from commit 9f23a94b8a
)
2020-11-11 15:44:14 +01:00
Tomasz Chabora
dc05beca80
Register methods for drawing 3D editor overlays
...
(cherry picked from commit cbfbb4538b
)
2020-11-11 15:30:57 +01:00
Tomasz Chabora
da2ac44d77
Add docs for editor viewport drawing methods
...
(cherry picked from commit 5d8b60ac3d
)
2020-11-11 15:30:57 +01:00
Rémi Verschelde
2652f6fc69
doc: Override default value for RandomNumberGenerator.seed
...
It's non-deterministic so it's better to show a fixed value like 0 instead of
having it potentially change whenever `randomize()` is called.
Fixes #43317 .
(cherry picked from commit 35e6070a35
)
2020-11-11 15:30:56 +01:00
Ryan Roden-Corrent
b472d5366c
Fix typo in Tabs doc.
...
I don't know enough about grammar to say why the "ing" suffix is
correct, but I'm reasonably sure it is :)
(cherry picked from commit 3826f3348f
)
2020-11-11 15:30:56 +01:00
Rémi Verschelde
05143ca39a
Tooltips: Improve code clarity and docs
...
The return type for `_make_custom_tooltip` is clarified as Control, and users
should make sure to return a visible node for proper size calculations.
Moreover in the current master branch, a PopupPanel will be added as parent
to the provided tooltip to make it a sub-window.
Clarifies documentation for `Control._make_custom_tooltip`, and shows how to
use the (until now undocumented) "TooltipPanel" and "TooltipLabel" theme types
to style tooltips.
Fixes #39677 .
(cherry picked from commit c5d8dafec4
)
2020-11-11 15:30:56 +01:00
Hugo Locurcio
de96b29c58
Correct documentation about NinePatchRect stretch modes
...
This closes https://github.com/godotengine/godot-docs/issues/4333 .
(cherry picked from commit 82bfb6273b
)
2020-11-11 15:30:56 +01:00