01a085d05f
Merge pull request #38320 from lawnjelly/kessel_pr_light_join
...
GLES2 2D batching - item reordering, light joining and light modulate fix
2020-05-01 15:03:03 +02:00
6a7d50403a
Add set_frame, pause, and oneshot to AnimatedTexture
...
Add API documentation for said changes.
(cherry picked from commit f5029e18ca
2020-05-01 11:00:10 +02:00
be56ec9e65
Document the formats supported by `Image.load()`
...
This partially addresses #32166 .
(cherry picked from commit a26649de42
2020-05-01 10:56:58 +02:00
6fb6107e6a
Warn when trying to open `res://` or `user://` with `OS.shell_open()`
...
`OS.shell_open()` will pass on the path directly to the OS' shell
handler (which can handle file paths or URLs). It can't handle
Godot-specific paths, so these need to be converted with
`ProjectSettings.globalize_path()` first.
(cherry picked from commit d46e411b44
2020-05-01 10:56:58 +02:00
4b58d453d4
Expose the cell_size affecting VisibilityNotifier2D precision
...
Refs: #4803
(cherry picked from commit d49ff7aff7
2020-05-01 10:56:58 +02:00
782d9536f3
Improve the compression project settings documentation
...
(cherry picked from commit b2b8db7897
2020-05-01 10:56:58 +02:00
6bb87d7d23
Mention how to remove TreeItem from a Tree
...
(cherry picked from commit f6aec99d27
2020-05-01 10:56:58 +02:00
e88cde0415
Clarify Transform scaled Method description.
...
(cherry picked from commit 19c8b0be45
2020-05-01 10:56:58 +02:00
fd6424aa04
doc: Improve Node2D to_local/to_global description
...
(cherry picked from commit 5c6f824e71
2020-05-01 10:56:57 +02:00
451c3fc0fb
GLES2 2D batching - item reordering, light joining and light modulate fix
...
Although 2D draws in painters order with strict ordering, in certain circumstances items can be reordered to increase batching / decrease state changes, without affecting the end result. This can be determined by an overlap test.
In situation with item:
A-B-A
providing the third item does not overlap the second, they can be reordered:
A-A-B
Items already contain an AABB which can be used for this overlap test.
1)
To utilise this, I have implemented item reordering (only for single rects for now), with the lookahead adjustable in project settings. This can increase performance in situations where items may not be grouped in the scene tree by texture. It can also be switched off (by setting lookahead to 0).
2)
This same trick can be used to help join items that are lit. Lit items previously would prevent joining completely, thus missing out on performance gains other than multi-command items such as tilemaps.
In this PR, lights are assigned as bits in a bitfield (up to 64, the optimization is disabled above this), and on each try_item (for joining), the bitfield for lights and shadows is constructed and compared with the previous items. If these match the 2 items can potentially be joined. However, this can only be done without changing the rendered result if an overlap test is successful.
This overlap test can be adjusted to join items up to a specific number of item references, selectable in project settings, or turned off.
3)
The legacy uniform single rect drawing routine seems to have been identified as the source of flicker, particularly on nvidia. However, it can also be up to 2x as fast. Because of the speed the batching contains a fallback where it can use the legacy single rect method, but I have now added a project setting to make this switchable. In most cases with batching it should not be necessary (as single rects are drawn less frequently) and thus the flickering can be totally avoided.
4)
This PR also fixes a color modulate bug when drawing light passes, in certain situations (particularly custom _draw routines with multiple rects).
5)
This PR also fixes #38291 , a bug in the legacy renderer where light passes could draw rects in wrong position.
2020-05-01 07:47:33 +01:00
9b9f70bd20
Update the documentation for `ExternalTexture` to match the restriction on Android platforms
2020-04-28 08:04:41 -07:00
ae0bc06eba
Improve `pitch_scale` descriptions in AudioStreamPlayer documentation
...
This closes #29439 .
Co-authored-by: Cheeseness <contact@jbushproductions.com>
(cherry picked from commit 4751dee7f4
2020-04-27 10:18:41 +02:00
24265c498b
Improve the procedural geometry class documentations
...
This references Godot's winding order at the top of every
procedural geometry class, as well as referencing other classes
within a given geometry class.
A warning about ImmediateGeometry3D performance was also added.
(cherry picked from commit ed7347d73d
2020-04-27 10:14:42 +02:00
bbd381c987
Add an easing/transition type cheatsheet to the Tween documentation
...
Related to https://github.com/godotengine/godot-docs/pull/3403 .
(cherry picked from commit 5972a9138e
2020-04-27 10:12:11 +02:00
f3cd7e3808
Document how some editor classes should be accessed as singletons only
...
This closes #37687 .
(cherry picked from commit a225265b0a
2020-04-27 10:11:53 +02:00
253fc093b8
DocData: Skip unexposed classes
...
Properly expose classes that we actually want accessible.
(cherry picked from commit 0ef8bcac4d
2020-04-21 14:15:34 +02:00
469f398e70
Document how to workaround UI anchor issues when using BackBufferCopy
...
This closes #6880 .
(cherry picked from commit f8a413bb1f
2020-04-21 14:11:29 +02:00
e8ead37725
Check for errors when saving in the ResourceSaver example documentation
...
This also replaces a non-breaking space that was accidentally added in
the EditorFeatureProfile documentation.
This closes #31393 .
(cherry picked from commit 2f46f1e7b1
2020-04-21 14:11:15 +02:00
3a2cdf7d5b
Improve the VisibilityEnabler and VisibilityNotifier documentations
...
This closes #4803 .
(cherry picked from commit 7f2d602106
2020-04-21 14:10:50 +02:00
faf858fe41
Revert "Made possible to specify where to dump the contents when loading a ".pck" file"
...
This reverts commit ffcfd9c8ea
2020-04-20 13:48:02 +02:00
ac0a55ce75
Update TextEdit docs - explaining 'override_selected_font_color' role
...
(cherry picked from commit 6a0e6c2852
2020-04-20 11:55:47 +02:00
339c10889d
Correct the addition of a key and the duplication of a variable name
...
in Dictionary class documentation.
(cherry picked from commit 4d41535fa3
2020-04-20 11:55:31 +02:00
4e73fcc959
Document DynamicFont limitations and a possible workaround
...
This closes #30014 .
(cherry picked from commit 46b8e108e2
2020-04-20 11:55:04 +02:00
4f7296a869
Document image size limits
...
This closes #30238 .
(cherry picked from commit 5497cec7a1
2020-04-20 11:54:47 +02:00
bb753aaf17
Clarify that angles must be specified as radians in the documentation
...
This closes #36356 .
(cherry picked from commit cae5260dab
2020-04-20 11:53:40 +02:00
50582446ad
Sync classref with current source
2020-04-17 13:43:43 +02:00
ffcfd9c8ea
Made possible to specify where to dump the contents when loading a ".pck" file
...
(cherry picked from commit 3c261e0dfa
2020-04-17 13:00:52 +02:00
008e0748c1
Merge pull request #37349 from lawnjelly/kessel32_1
...
GLES2 2d Batch rendering (across items)
2020-04-17 12:55:33 +02:00
72adefa5cf
Add frame diagnostics for GLES2 Batch renderer
...
Added project setting to enable / disable print frame diagnostics every 10 seconds. This prints out a list of batches and info, which is useful to optimize games and identify performance problems.
2020-04-17 08:54:33 +01:00
07aa524a42
doc: Sync classref with current source
2020-04-16 13:02:36 +02:00
b4429c325a
Fix incorrect TabContainer documentation for 'get_tab_control()'
...
(cherry picked from commit 8f925b1970
2020-04-16 12:57:22 +02:00
26614a37b8
Mention `keep_pressed_outside` caveat in the BaseButton documentation
...
This closes #37790 .
(cherry picked from commit e799dc954e
2020-04-16 12:57:22 +02:00
6c4a0ec75a
Improve the Dictionary class documentation
...
This closes https://github.com/godotengine/godot-docs/issues/3376 .
(cherry picked from commit 88da90f2bf
2020-04-16 12:57:22 +02:00
eab7342321
More details in Rigid Body add_force documentation
...
(cherry picked from commit 219c5712f0
2020-04-16 12:57:22 +02:00
edd5d9c78e
Improve Camera2D documentation
...
(cherry picked from commit 630096fa74
2020-04-16 12:57:22 +02:00
ab4ea9379c
Improve the AudioStreamSample class documentation
...
This closes #37915 .
(cherry picked from commit 52786b54ef
2020-04-16 12:57:22 +02:00
7607fafda1
Clarify documentation and indicate that rect_clip_content affects only CanvasItem based nodes.
...
Resolves #37683
(cherry picked from commit 3f19b5e0b3
2020-04-16 12:47:18 +02:00
27989ae8f8
Add reference of Color8 function to Color class documentation
...
(cherry picked from commit 06aeff3044
2020-04-16 12:47:18 +02:00
cd10966652
clarify autotile_coord in docs
...
I had no idea what 'coordinate' meant in the context of autotiles, so just adding some clarification for future people who have the same problem.
(cherry picked from commit cbe73766e3
2020-04-16 12:47:18 +02:00
294008015e
Clarify Dictionary duplicate params godotengine#37162
...
* Added additional clarification for the function of the 'deep'
parameter in the Dictionary's `duplicate` method.
(cherry picked from commit 469b7c948f
2020-04-16 12:02:18 +02:00
22ebdd72d9
Add more verbosity for property overrides in RST documentation
...
(cherry picked from commit 38821dc6d7
2020-04-16 11:57:50 +02:00
5d9108c9c6
Fix OptionButton docs godotengine#36803
...
* item_selected and item_focused docs incorrectly had 'id' as the parameter. Changed to
'index'.
* Fix parameter name in ADD_SIGNAL callin code.
(cherry picked from commit a8de034f78
2020-04-16 11:45:19 +02:00
2ef1ee9da7
Improve the `File.store_{8,16,32,64}()` documentation
...
Added information about the intervals of values that the functions
`store_{8,16,32,64}()` can correctly write to the file.
(cherry picked from commit 97e20b2f30
2020-04-16 11:44:58 +02:00
5914fdc067
Implements estimate/compute_cost for AStar2D
...
(cherry picked from commit bad77bcb52
2020-04-16 11:35:52 +02:00
e88cfedf0e
Document the EditorFeatureProfile class
...
(cherry picked from commit 7ab279403d
2020-04-06 20:58:21 +02:00
011602447c
Clarify docs for Thread.start() godotengine#36032
...
* Updated docs for Thread.start() to specify that the method argument
must accept one parameter.
(cherry picked from commit d09644dff3
2020-04-06 18:17:43 +02:00
d4c77e60c0
Fixed errors in makerst pre-commit hook
...
(cherry picked from commit 619354fb2c
2020-04-06 18:16:11 +02:00
679708aa8f
Make note of 16 probe limit
...
Godot by default has a limit of 16 reflection probes in a scene. this can be increased by increasing atlas subdiv. For 3.2 and possibly 4.0. This also fixes a spelling mistake
Update doc/classes/ReflectionProbe.xml
Fix from clayjohn, Directly link to settings
Co-Authored-By: Clay John <claynjohn@gmail.com>
2020-04-05 04:41:00 -04:00
45b0b8bff8
GLES2 2d Batch rendering (across items)
...
2d rendering is currently bottlenecked by drawing primitives one at a time, limiting OpenGL efficiency. This PR batches primitives and renders in fewer drawcalls, resulting in significant performance improvements. This also speeds up text rendering.
This PR batches across canvas items as well as within items.
The code dynamically chooses between a vertex format with and without color, depending on the input data for a frame, in order to optimize throughput and maximize batch size. It also adds an option to use glScissor to reduce fillrate in light passes.
2020-04-04 17:13:58 +01:00
fdd85311c3
Sync classref with current source
2020-03-25 11:42:15 +01:00
e30a0a30b6
Added new method to replace an already added node to the animation state machine
...
(cherry picked from commit 422926cfc6
2020-03-25 11:38:54 +01:00
d7c6a42cbf
Doc edit at InputEventMouseMotion
...
Doc edit
(cherry picked from commit 052424c76d
2020-03-25 11:38:53 +01:00
8fd7efef84
Fix visibility enabler flag toggling
...
(cherry picked from commit 2ccd1a7805
2020-03-25 11:38:53 +01:00
b5f1f7dfde
Improve the `Input.set_use_accumulated_input()` documentation
...
(cherry picked from commit 30961c60ab
2020-03-25 11:38:53 +01:00
f3d2c672e9
Document known performance issues with Sprite3D
...
See https://github.com/godotengine/godot/issues/20855 .
(cherry picked from commit 92fa3e076f
2020-03-25 09:40:09 +01:00
82bee3f993
Added has_signal method for Object
...
(cherry picked from commit 258d91f883
2020-03-25 09:36:41 +01:00
cc70b2fa0a
Merge pull request #36342 from m4gr3d/external_texture_support_for_godot_3_2
...
Add support for opengl external textures
2020-03-17 16:29:14 +01:00
3739f03d98
Add LOTS of missing docs
...
(cherry picked from commit e103f21a40
2020-03-13 17:26:30 +01:00
df2a2ae0fc
DocData: Fix serialization of Variant default values
...
Co-authored-by: Bojidar Marinov <bojidar.marinov.bg@gmail.com>
(cherry picked from commit 788765709d
2020-03-09 11:36:57 +01:00
398de05dd6
doc: Sync classref with current source
2020-03-09 10:07:59 +01:00
f9dcc30566
Edited the KinematicBody and KinematicBody2D docs
...
Explained the reason why move_and_slide should be used in _physics_process
(cherry picked from commit b7dbf41aa5
2020-03-06 23:54:56 +01:00
d4e6eff2de
ConfigFile: Improve error messages and complete docs
...
(cherry picked from commit f7c87ed3dd
2020-03-06 23:51:26 +01:00
bd2a2a7e40
Turn Rect2's 'intersects_touch()' into an extra argument of 'intersects()'
...
(cherry picked from commit 8c8c48a7ad
2020-03-06 23:51:26 +01:00
41e385cfac
Document EditorPlugin get_plugin_icon and get_plugin_name
...
The return value's type hint is now accurate.
(cherry picked from commit 68d73ecf60
2020-03-06 23:51:25 +01:00
30d738eda7
Add support for opengl external textures as defined by https://www.khronos.org/registry/OpenGL/extensions/OES/OES_EGL_image_external.txt
2020-03-05 13:09:49 -08:00
1350c1371e
add a precision about the intended use of the ConcavePolygonShape
...
(cherry picked from commit 222a934e60
2020-03-04 14:12:19 +01:00
0ab8889c0d
Exposing get_tracker_id for ARVRPositionalTracker to GDScript
...
(cherry picked from commit f0b1edef8b
2020-03-04 12:52:47 +01:00
fa60e77964
Document that SpringArm exclusions only work with PhysicsBody objects
...
(cherry picked from commit d961663707
2020-03-04 12:40:15 +01:00
4bf0c52a30
Minor fix in Node class documentation
...
The name of the property responsible for physics fps is fixed:
this is `Engine.iterations_per_second`, not `Engine.target_fps`.
(cherry picked from commit 6e5cd36b12
2020-03-04 12:40:15 +01:00
1191766609
doc: Mention concatenation using the `+` operator in Array
...
This closes https://github.com/godotengine/godot-docs/issues/2452 .
(cherry picked from commit 8d53562954
2020-03-04 12:40:15 +01:00
4e879ed803
Improve documentation related to fixed physics processing
...
(cherry picked from commit b89a37269b
2020-03-04 12:40:14 +01:00
e13324a889
Core: Change _Marshall class inherit from Reference to Object
...
(cherry picked from commit 9e8e5ebdc7
2020-03-04 12:40:14 +01:00
b80190721b
Allow using `MeshLibrary.get_item_preview()` in non-editor builds again
...
This closes #36268 .
(cherry picked from commit 64fac9dd5d
2020-03-04 12:40:13 +01:00
3a73c3f260
Add documentation for new DTLS features.
2020-02-25 11:40:17 +01:00
1bc1939c63
Improve the PanoramaSky class documentation
...
See https://github.com/godotengine/godot/issues/27835 .
(cherry picked from commit 72ac757ad5
2020-02-20 08:01:18 +01:00
74738806f3
i18n: Sync translations with Weblate
2020-02-14 17:51:56 +01:00
50727d7b22
Allow per pixel transparency in javascript platform
...
(cherry picked from commit e51c6a0d28
2020-02-14 16:07:03 +01:00
541251dff7
Add ConfigFile::parse()
...
(cherry picked from commit e5bd3b707f
2020-02-14 16:06:36 +01:00
31506ebe85
updated description of metallic in SpatialMaterial
2020-02-12 15:05:49 +01:00
f433c3656b
Update EditorSceneImporterAssimp description to reflect current status
...
(cherry picked from commit 95f6be365a
2020-02-12 15:05:16 +01:00
7cfcf1824b
Completes doc for ItemList and Tree
...
(cherry picked from commit 7a41c44be2
2020-02-12 15:05:02 +01:00
20d0034039
Add documentation for Skeleton2D
...
Signal bone_setup_changed remains undocumented. I took a quick look at
the cpp code, but its purpose remained unclear to me. If anyone can
steer me in the right direction, I'm happy to flesh this out.
(cherry picked from commit 9151992432
2020-02-12 15:04:49 +01:00
4657daff05
doc: Add description for EditorInspector
...
(cherry-picked from #35858 )
2020-02-12 15:04:19 +01:00
23e08b0fad
Improve the `doc_status.py` console output
...
- Duplicate the header when the `-a` flag is enabled. Since lots of
items are displayed in this case, this helps the user remember
which column is which without having to scroll back to the top.
- Bolden the overall percentages for easier visual grepping.
(cherry picked from commit 7c3f6b2870
2020-02-12 14:59:21 +01:00
453babc60d
Finish documenting BakedLightmap and TextureLayered
...
(cherry picked from commit 5643bc71f7
2020-02-06 13:02:08 +01:00
11f012d2db
Completes doc for button classes
...
(cherry picked from commit db42d5ddff
2020-02-06 13:02:08 +01:00
47368f2b7c
doc: Add an example for `Array.sort()`
...
This may help people understand the difference between alphabetical
and natural order more quickly.
(cherry picked from commit 1de9118c5f
2020-02-06 13:02:08 +01:00
3410dd3a9e
doc: Add a short AnimationPlayer versus Tween comparison
...
Many newcomers are confused about which one to choose for animating
properties. This should help clarify the situation with regards
to AnimationPlayer versus Tween.
(cherry picked from commit 810b1341ce
2020-02-06 13:02:08 +01:00
cbd4784d14
Improve the CheckBox and CheckButton class documentations
...
This makes the CheckBox and CheckButton classes 100% documented.
(cherry picked from commit c9946bc87e
2020-02-06 13:02:08 +01:00
68eae6b6e9
Fix some URLs to use HTTPS when available
2020-01-29 02:48:10 +01:00
8ea77b96b2
Mention 2D polygon limits and how to increase them in the documentation
...
This closes #21793 .
2020-01-28 22:04:29 +01:00
658e44ee01
doc: Sync classref with current source
...
Fix a few typos.
2020-01-28 10:58:48 +01:00
766d1ef276
Docs for some nodes in visual shader(part 2)
2020-01-28 12:16:09 +03:00
9705d5587e
Hide "control" methods from VisualShaderNodeGroupBase
2020-01-28 10:24:59 +03:00
274f1d8610
Hide "editable" property from VisualShaderNodeGroupBase public interface
2020-01-28 09:43:07 +03:00
796484d761
Added missing property "size" to VisualShaderNodeGroupBase
2020-01-27 19:18:48 +03:00
3479cf4b42
Removed unused method "build" from VisualShaderNodeExpression
2020-01-27 18:24:39 +03:00
21dd35b611
Document theme_items of multiple classes
2020-01-27 02:15:37 +01:00
75185f87a3
doc: Remove mention of nonexistent StaticBody simulated motion mode
...
The StaticBody2D documentation doesn't mention it, so it doesn't need
to be touched.
This closes #30560 .
2020-01-26 20:18:22 +01:00
4cee1cda5e
Merge pull request #35589 from akien-mga/doc-drop-category-property
...
doc: Drop unused 'category' property from header
2020-01-26 16:34:13 +01:00
09ced94dd4
doc: Do not expose Variant::NIL as a type in the class reference
...
Fix signals Variant arguments incorrectly listed as Nil.
Fixes #12520 .
2020-01-26 16:08:11 +01:00
2d20fc39aa
doc: Drop unused 'category' property from header
...
We already removed it from the online docs with #35132 .
Currently it can only be "Built-In Types" (Variant types) or "Core"
(everything else), which is of limited use.
We might also want to consider dropping it from `ClassDB` altogether
in Godot 4.0.
2020-01-26 16:02:39 +01:00
3697ea799c
doc: Document all remaining ProjectSettings
2020-01-26 13:37:21 +01:00
fe26e53065
Merge pull request #35581 from akien-mga/doc-color-constants
...
doc: Document named color constants
2020-01-26 13:36:44 +01:00
cbdbfb00ca
doc: Document named color constants
...
Busywork but it's good for our completion rate :)
2020-01-26 12:08:16 +01:00
bb6c0d3e8b
doc: Complete documentation for VideoStreams
...
Also quick clean up of the matching C++ files.
2020-01-26 11:29:07 +01:00
bd605a5701
Merge pull request #35566 from Xrayez/doc-parse-property-return
...
Document the return value of `EditorInspectorPlugin.parse_property`
2020-01-26 10:17:57 +01:00
6a5c8c8672
Merge pull request #35574 from clayjohn/DOCS-odds-n-ends
...
Complete various class references
2020-01-26 10:08:55 +01:00
c5700f7464
Complete various class references
2020-01-26 00:27:51 -08:00
1b3eb41622
Merge pull request #35561 from clayjohn/GLES3-irradiance-max
...
Add project setting for max irradiance size
2020-01-26 09:16:21 +01:00
06933f5d80
Document the return value of `EditorInspectorPlugin.parse_property`
2020-01-26 02:04:33 +02:00
be1bc53d42
Merge pull request #35560 from clayjohn/DOCS-sky-radiance
...
Add warning for radiance_size
2020-01-25 23:01:58 +01:00
7215019020
Add warning for radiance_size
2020-01-25 13:28:32 -08:00
eb5cb5d016
Add project setting for max irradiance size
2020-01-25 13:27:13 -08:00
8896ce1c0a
Merge pull request #35559 from Calinou/doc-inputeventkey-string
...
Document how to get a human-readable string from an InputEventKey
2020-01-25 21:52:35 +01:00
7a0c37c3f5
Document how to get a human-readable string from an InputEventKey
2020-01-25 20:13:18 +01:00
33f37cfd19
Document how to get chamfered corners with StyleBoxFlat
2020-01-25 20:04:23 +01:00
a61f5a7520
Merge pull request #35535 from Calinou/doc-projectsettings-runtime-physics
...
Document how to change the default gravity at runtime
2020-01-25 18:16:34 +01:00
1b9b07e658
Document how to change the default gravity at runtime
...
Changing the default gravity at runtime isn't exactly obvious,
so it makes sense to add a code sample.
2020-01-25 16:28:28 +01:00
e61edd69ea
Merge pull request #35523 from searetseltev/master
...
Update ScrollContainer.xml
2020-01-24 21:53:57 +01:00
4f0401d05d
Update ScrollContainer.xml
...
Add missing descriptions to ScrollContainer documentation
2020-01-24 17:21:53 +01:00
25ea912d96
Count theme items in doc_status.py
2020-01-24 14:23:58 +01:00
97cc2e53f6
makerst: Escape reST markup after enums
...
Fixes #35501 .
2020-01-24 13:08:36 +01:00
ce43c92208
Docs for some nodes in visual shader
...
Fix typo in `VisualShaderNodeCompare.ComparisonType` name.
2020-01-23 22:39:00 +01:00
c66144738b
Merge pull request #35483 from YeldhamDev/doc_comment_spaces_removal
...
Remove unnecessary extra spaces before comments in code examples.
2020-01-23 21:58:12 +01:00
c4745c96d7
Remove unnecessary extra spaces before comments in code examples.
2020-01-23 14:41:49 -03:00
e1a9a3328d
Remove unnecessary parenthesis from code examples
2020-01-23 14:15:39 -03:00
6b66957b85
Finish documenting CSG* and *probes
2020-01-23 13:54:17 +01:00
ba177ccaec
doc: Misc updates for AnimationNode* and others
...
- Add some missing descriptions.
- Add links to tutorials for ARVR and AnimationTree.
- Style fixes.
- Engine changes:
* Make `AnimationNodeTransition.input_<number>` properties internal
so that they don't appear in the docs. They still appear in the
inspector based on the actual number of inputs requested.
* Drop unimplemented `CPUParticles.flatness`. It's only used for 3D
particles in `ParticlesMaterial`, and thus only relevant for
`CPUParticles3D`.
2020-01-23 12:37:33 +01:00
90a1f8d8a7
Make `OS.execute()` blocking by default if not specified
...
This makes `OS.execute()` calls quicker to set up when calling programs
in a blocking fashion.
2020-01-23 01:26:32 +01:00
b4770c0a27
Add settings from SceneTree in the documentation
...
Fixes #35439
2020-01-22 22:37:56 +02:00
387ee7d763
Get real default values for project settings in documentation
...
Also, ignore custom project settings and values for input/ entries
Fixes #34154
2020-01-22 15:57:10 +02:00
829d21f1c2
Merge pull request #35352 from Feniks-Gaming/BetterDictionary
...
Improve dictionary description
2020-01-22 13:20:41 +01:00
de543d18e8
Merge pull request #35389 from clayjohn/DOCS-materials
...
Finish up docs for materials
2020-01-22 07:41:33 +01:00
f2ece82480
Finish up docs for materials
2020-01-21 19:28:32 -08:00
1508cc4051
Merge pull request #35363 from ericrybick/33106-importing-textureAtlas-cuts-out-the-sprites
...
Fix AtlasPacker ignoring semi-transparent pixels
2020-01-21 00:13:12 +01:00
439e0027ec
Fix AtlasPacker ignoring semi-transparent pixels
...
Fixes #33106
2020-01-20 22:43:38 +01:00
6e24933115
Improve dictionary description
...
I improved dictionary description to ad some real life examples and expand on it a little bit so person who never seen dictionary can understand it better seeing them for a first time here.
I also added note about the way to compare dictionaries as it can catch people of guard because common assumption is that it works the same as comparing Arrays when it does not.
2020-01-20 20:36:59 +00:00
837adb30fd
Revert "Exposes capture methods to AudioServer + documentation" #30468
...
Reverts the following commits:
- c81ec6f26d40b70283958a4ef3e216fb32cbaf14:
"Exposes capture methods to AudioServer, variable renames for
consistency, added documentation."
- 47c558b98abf842910c780294314326662410cdf:
"Expose audio callbacks as signals."
- dabaa11b3c451e9b8f2cca7e563bd9ec51edb169:
"Fix to make sure the capture buffers are deallocated at shutdown.
Silences warnings."
Some documentation improvements were kept for pre-existing methods.
See rationale for reverting these changes in #30468 .
2020-01-20 13:18:01 +01:00
c0595206dd
makerst: Use code markup for default values/overrides
...
Fixes godotengine/godot-docs#3071 .
2020-01-20 12:38:08 +01:00
adb6734b49
doc: Sync classref with current source
2020-01-19 23:19:29 +01:00
62d656ea06
Merge pull request #35327 from KoBeWi/globalization
...
Mention that KinematicCollisions use global coords
2020-01-19 22:25:10 +01:00
cb088e391e
Merge pull request #35300 from Feniks-Gaming/GraphNodeDesc
...
Improve Description of GraphNode
2020-01-19 22:19:41 +01:00
5a75c4a840
Mention that KinematicCollisions use global coords
2020-01-19 20:22:31 +01:00
1ebf4c7fdc
Improve Description of GraphNode
...
It mostly fixes issues I have listed in https://github.com/godotengine/godot-docs/issues/3065 where GraphNode description was rather lacking clarity. It was near impossible how to use the them or how to create new slots etc.
I improved it quite a bit if anyone has idea how to reword original "A tuple of input and output slots is defined for each GUI element included in the GraphNode." I would love to hear it. I am unsure how to word it in more understandable way.
2020-01-19 19:21:30 +00:00
05c8654390
doc: Timer.autostart resets to false on start
...
Fixes #35289 .
2020-01-19 10:18:11 +01:00
d4a222cd9d
Merge pull request #35281 from timothyqiu/video-player-doc
...
Improves VideoPlayer's documentation
2020-01-18 15:27:28 +01:00
ecf3d3fd84
Improves VideoPlayer's documentation
2020-01-18 21:51:17 +08:00
9914b6fc62
doc: Mention the limited comment support in ConfigFile
2020-01-18 13:58:36 +01:00
ea1da40d79
Merge pull request #35223 from Feniks-Gaming/MenueButtonDescription
...
Improved MenuButton Description
2020-01-18 09:25:49 +01:00
156f5b7ce2
Improved MenuButton Description
...
I expanded description of MenueButton to explain how to create the items inside of the pop up as this is initially a mystery to many new people.
2020-01-18 07:22:19 +00:00
9882cbf8cd
Improves LineEdit documentation
...
* Recently supported macOS shortcuts are added
* Makes it clear than `set_text` won't trigger `text_changed`
* `minimum_spaces` is the number of space characters that can be shown
without scrolling
2020-01-17 11:02:43 +08:00
1de633205f
Validate input in (CPU)Particles set_emission_shape()
...
Fixes #29777 .
Co-authored-by: Cameron Reikes <cameronreikes@gmail.com>
2020-01-16 11:08:51 +01:00
7c624949b5
Merge pull request #35147 from madmiraal/fix-34992
...
Fixes get_floor_normal() returning the user defined floor_normal.
2020-01-15 14:17:15 +01:00
907adb37ce
Fixes get_floor_normal() returning the user defined floor_normal.
...
When there is no collision with a floor the get_floor_normal() function
should return the zero vector to be consistent with get_floor_velocity().
Renames floor_normal to up_direction in all bindings.
Updates the documentation of get_floor_normal() and get_floor_velocity()
to make it clear when the values are valid. Updates the documentation for
move_and_slide() and move_and_slide_with_snap() to use the new up_direction
parameter name.
2020-01-15 10:13:35 +01:00
6e8eb0d98d
Merge pull request #35134 from clayjohn/DOCS-update-multiple
...
Completed documentation for many visual nodes
2020-01-15 08:10:15 +01:00
46b5742159
Completed documentation for many visual nodes
2020-01-14 18:28:36 -08:00
40f0649e5b
Fix typos with codespell
...
Using codespell 1.16.0.
See ab3bccdb78
2020-01-15 00:49:52 +01:00
8d60f5a349
Merge pull request #35132 from Calinou/doc-description-below-brief
...
doc: Move the class description to be just below the brief description
2020-01-15 00:49:31 +01:00
3c8abbc4bf
doc: Move the class description to be just below the brief description
...
- Drop the "Brief description" header as it became redundant
with this change.
- Fix a bug in the editor help where an extraneous newline was added
after the header if the class isn't inherited by any others.
- Remove the Category line in the rST markup as it's not useful
for API users.
2020-01-15 00:05:34 +01:00
083f68ebf4
Merge pull request #35077 from Feniks-Gaming/master
...
Expanded bool class description with examples
2020-01-14 23:11:20 +01:00
636f003f8c
Expanded class_bool Description with examples
...
I expanded boolean long description with example of when booleans could be use practice because
Boolean
Description:
Boolean built-in type.
was pretty vague. As new to programming person it took me longer than it should have to understand what those are and why I would want to use them. Hopefully this will make it clearer to new users reading documentation
Update bool.xml
2020-01-14 21:45:47 +00:00
42567bffb9
Document `Engine.get_idle/physics_frames` methods
2020-01-14 22:32:32 +02:00
1bafd2d2c8
Merge pull request #35120 from Faless/docs/html5_restrictions
...
Update documentation to reflect HTML5 limitations.
2020-01-14 17:23:54 +01:00
aa744aee7d
Update documentation to reflect HTML5 limitations.
2020-01-14 15:42:47 +01:00
c09b9c488f
Complete documentation of some more classes
2020-01-14 13:19:39 +01:00
ab97f78fa5
Revert "Enable Vsync via Compositor by default"
...
This reverts commit 9600fd5ddeFixes #35038 .
2020-01-13 09:33:27 +01:00
7f9bf5472c
doc: Sync classref with current source
2020-01-12 14:30:21 +01:00
478ab8b45b
Merge pull request #34960 from johannesgunnar/spin_box-apply-method
...
Spinbox apply input method
2020-01-12 14:16:14 +01:00
083637a901
Add apply method to SpinBox
2020-01-11 10:47:51 +00:00
d842557afe
Merge pull request #35001 from KoBeWi/nope
...
Add signal for LineEdit overflow event
2020-01-10 23:46:02 +01:00
f39f62954e
Merge pull request #34999 from cajallen/master
...
Updated Array's sort_custom method documentation
2020-01-10 21:57:28 +01:00
60cd3df337
Add signal for LineEdit overflow event
2020-01-10 21:07:00 +01:00
378c4895ae
[DOCS] Corrections and clarifications to classref
2020-01-10 10:46:41 -08:00
05bbbb1225
sort_custom description and example updated
2020-01-10 12:24:49 -06:00
a24aa591af
Merge pull request #34991 from Calinou/doc-os-is-debug-build
...
Improve the `OS.is_debug_build()` documentation
2020-01-10 15:51:16 +01:00
74ae1ca616
Improve the `OS.is_debug_build()` documentation
2020-01-10 15:26:47 +01:00
673f4fabd8
Merge pull request #34962 from KoBeWi/randocs
...
Complete documentation of various classes
2020-01-10 14:41:30 +01:00
508e624b87
Complete documentation of various classes
2020-01-10 14:14:07 +01:00
83d950b58e
Merge pull request #34968 from Calinou/enable-vsync-via-compositor
...
Enable Vsync via Compositor by default
2020-01-10 10:04:55 +01:00
9600fd5dde
Enable Vsync via Compositor by default
...
This feature was added in #33414 but it was disabled by default.
Now that it got some testing, it's probably safe to enable it
by default.
2020-01-09 22:22:11 +01:00
8708d44a50
Add option to disable loading scripts in ScriptCreateDialog
2020-01-09 13:09:23 -03:00
c6b6731857
Doc: Mention that Directory pre-opens res:// by default
...
This may be considered a bug, so we might change that in the future.
See #24149 .
2020-01-09 10:18:48 +01:00
afe39525fd
Improve the Environment class documentation
...
Co-authored-by: Clay John <claynjohn@gmail.com>
2020-01-08 20:34:57 +01:00
033fb72c03
Merge pull request #34871 from lentsius-bark/textEdit-vertical-horizontal-scroll-expose
...
expose scroll_vertical and scroll_horizontal in TextEdit
2020-01-08 08:18:12 +01:00
1b26205b25
Merge pull request #34901 from YeldhamDev/multiple_doc_completions
...
Complete docs for GraphEdit/Node and PopupMenu
2020-01-08 07:36:36 +01:00
8b5992f665
Make possible to edit the GraphEdit's selection rect colors
2020-01-07 23:20:48 -03:00
b81843ee6c
Complete docs for GraphEdit/Node and PopupMenu
2020-01-07 22:05:32 -03:00
4fbcc19853
Complete the Environment class documentation
...
This closes #34846 .
2020-01-07 17:41:17 +01:00
c475f11018
expose scroll_vertical and scroll_horizontal in TextEdit + documentation
2020-01-07 15:16:07 +01:00
5fc0a068d0
Rewording RichTextLabel::remove_line documentation
2020-01-07 08:29:10 +08:00
0a965300e7
doc: Document what happens to old script with Object.set_script()
2020-01-06 13:57:35 +01:00
8454804972
Merge pull request #33967 from Calinou/add-os-is-window-focused
...
Add an `OS.is_window_focused()` getter
2020-01-06 11:39:18 +01:00
7c3543380f
Merge pull request #34848 from clayjohn/DOCS-VisualServer
...
Finish documenting VisualServer
2020-01-06 08:38:32 +01:00
1905fdfbca
Finish documenting VisualServer
2020-01-05 23:10:44 -08:00
e85604e541
Merge pull request #34847 from YeldhamDev/splitcontainer_tabs_docs
...
Complete the SplitContainer and Tabs documentations
2020-01-06 08:05:04 +01:00
109f025d83
Merge pull request #34852 from timothyqiu/rtl-doc
...
Completes the RichTextLabel documentation
2020-01-06 08:04:29 +01:00
cab97f4b50
Merge pull request #32126 from Calinou/expose-video-adapter-name-vendor
...
Add VisualServer methods to get the video adapter name and vendor
2020-01-06 07:35:12 +01:00
3deb209105
Completes the RichTextLabel documentation
2020-01-06 13:41:39 +08:00
0cad2c0cd1
Add VisualServer methods to get the video adapter name and vendor
...
These methods can be used in scripts to retrieve the OpenGL
`GL_RENDERER` and `GL_VENDOR` strings (respectively).
This closes #28404 .
2020-01-06 00:37:56 +01:00
538baea208
Complete the SplitContainer and Tabs documentations
2020-01-05 20:03:08 -03:00
d968d032e9
Merge pull request #34833 from clayjohn/DOCS-VisualServer
...
Document most VisualServer functions
2020-01-05 22:16:15 +01:00
566ffc2695
Document most VisualServer functions
2020-01-05 12:14:57 -08:00
482fdfb7f0
Merge pull request #34812 from clayjohn/DOCS-VisualServer
...
Updated many VisualServer functions
2020-01-05 09:28:47 +01:00
35d288b2ef
Updated many VisualServer functions
2020-01-04 16:59:38 -08:00
8662b74bd6
Merge pull request #34820 from timothyqiu/doc-tree
...
Improves Tree documentation
2020-01-05 00:04:17 +01:00
6e79d683fa
Document the return value of `Object.get()` with a nonexistent property
2020-01-04 20:16:10 +01:00
8a4104acb8
Improves Tree documentation
2020-01-04 20:25:40 +08:00
7e6bfe6a8b
Document TabContainer's "use_hidden_tabs_for_min_size"
2020-01-03 16:48:27 -03:00
a18909f945
doc: Sync classref with current source
2020-01-03 15:09:09 +01:00
fa82664419
Merge pull request #34726 from nekomatata/polygon2d-antialiasing-fix
...
Fixed antialiasing option for Polygon2D with concave/hollow shapes
2020-01-03 14:17:05 +01:00
cc626acf45
Add a shorthand for setting the exit code using `SceneTree::quit()`
...
This reduces the amount of code required to exit a process with a
non-zero exit code. This pattern is also found in most other
programming languages.
2020-01-03 11:41:46 +01:00
32fd350254
Merge pull request #34747 from rcorre/add_child_owner
...
Add note about add_child and owner.
2020-01-03 09:08:13 +01:00
98bbee3008
Add note about add_child and owner.
...
Resolves #34739 .
2020-01-02 21:50:31 -05:00
dc2e4cc804
Merge pull request #34736 from cbscribe/kcc_doc_fixes
...
[DOCS] Class reference typos and fixes.
2020-01-02 20:22:38 +01:00
ab11916822
[DOCS] Class reference typos and fixes.
2020-01-02 10:31:16 -08:00
4d727f1ee6
Allows to doc vararg method return type as void
2020-01-02 21:37:26 +08:00
1591677eb8
Fixed antialiasing option for Polygon2D
...
Some cases were not handled properly for Polygon2D after making changes in common code to fix Line2D antialiasing. Added an option for drawing polygons to differentiate the two use cases.
Fixes #34568
2020-01-01 11:40:14 +01:00
7a752215ba
Improves ItemList
...
* Adds range hint for integer properties
* Adds missing descriptions in documentation
* Updates some method descriptions to match the actual behavior
* Fixes second param name of `set_item_icon_transposed` from `rect` to `transposed`
2019-12-31 08:44:55 +08:00
97ebde45d5
Merge pull request #34572 from KoBeWi/I_give_up
...
Make new ScrollContainer focus behavior optional
2019-12-30 19:00:57 +01:00
33b560a5cf
Merge pull request #34700 from Calinou/doc-input-device-touchscreen-id
...
Document how to distinguish emulated mouse events from physical ones
2019-12-30 18:16:10 +01:00
9c6863e74b
Merge pull request #34692 from bluenote10/bluenote10-shadow_item_cull_mask-docs
...
shadow_item_cull_mask should reference light mask
2019-12-30 18:12:20 +01:00
ccedda9c71
Merge pull request #34682 from Calinou/os-exit-code-nonportable-warning
...
Print a warning message if `OS.exit_code` is set to a non-portable value
2019-12-30 18:09:32 +01:00
fdfb7e5fc4
Merge pull request #34621 from cbscribe/kcc_misc_doc_fixes
...
[Docs] Description updates for Node2D & Object
2019-12-30 17:23:23 +01:00
e9696628f1
Merge pull request #34615 from lakshay-angrish/area_shape_entered-docs
...
add area_shape_entered usage
2019-12-30 17:14:08 +01:00
cc72885107
Make new ScrollContainer focus behavior optional
2019-12-30 16:40:02 +01:00
ae9716cf78
Merge pull request #34611 from lakshay-angrish/33841_bitmapfont_doc
...
add AngelCode format in BitmapFont doc's description
2019-12-30 16:35:53 +01:00
d595a5e9c3
Merge pull request #34593 from Calinou/doc-httprequest-json-example
...
Add an example of using HTTPRequest to contact a REST API
2019-12-30 16:34:09 +01:00
1da9a60cd8
Merge pull request #34590 from willnationsdev/kc
...
Fix KinematicCollision docs mislabeling an ObjectID as an RID.
2019-12-30 16:33:34 +01:00
46bc05c5ac
Merge pull request #34576 from rcorre/imgeo-coords
...
Clarify ImmediateGeometry.add_vertex.
2019-12-30 16:25:21 +01:00
df2968de26
Merge pull request #34571 from rcorre/array_returns
...
Be more specific about array return values.
2019-12-30 16:22:30 +01:00
9ae73f7bb5
Document how to distinguish emulated mouse events from physical ones
...
Mouse events emulated from a touchscreen will always have a device ID
of -1.
2019-12-30 15:30:34 +01:00
d2690b37fd
shadow_item_cull_mask should reference light mask
2019-12-29 19:06:18 +01:00
d441a6aefa
Print a warning message if `OS.exit_code` is set to a non-portable value
...
This also improves the related documentation.
2019-12-29 16:56:22 +01:00
bc234ce0ae
[Docs] Description updates for Node2D & Object
2019-12-26 10:24:29 -08:00
fe9a4ff818
add area_shape_entered usage
2019-12-26 17:30:48 +05:30
c37429b281
add AngelCode format in BitmapFont doc's description
2019-12-26 11:12:02 +05:30
c719cea116
Add an example of using HTTPRequest to contact a REST API
...
We already had an example to download and display an image,
but having another example dedicated to REST APIs doesn't hurt.
2019-12-24 23:24:16 +01:00
e182aa0d32
Fix KinematicCollision docs mislabeling an ObjectID as an RID.
2019-12-24 15:35:58 -06:00
67f441a09d
Clarify ImmediateGeometry.add_vertex.
...
It isn't obvious whether you should add vertices in global coordinates,
or local to the ImmediateGeometry Node.
2019-12-23 23:20:32 -05:00
e002044761
Be more specific about array return values.
...
The prior docs weren't clear if {pop_,}{front,back} would fail or return
`null` on an empty array.
2019-12-22 14:38:10 -05:00
56d44aaac9
Merge pull request #34090 from Calinou/doc-improve-basis
...
Improve the Basis class documentation
2019-12-22 20:37:48 +01:00
bb62c07fce
Improve the Basis class documentation
2019-12-22 18:04:51 +01:00
0bab51ab55
Fix the Node `process_priority` description to match actual behavior
...
This closes #34531 .
2019-12-22 17:01:56 +01:00
4bec32a11e
Merge pull request #34400 from alexchond/alexchon
...
Document DUPLICATE_USE_INSTANCING #2770
2019-12-22 12:36:42 +01:00
18e4fb3548
Merge pull request #34413 from Zacxalot/vehiclewheel-tooltip
...
Update VehicleWheel.xml
2019-12-22 12:34:34 +01:00
0b776ebbe4
Merge pull request #34498 from KoBeWi/bad_idea
...
Mention that bbcode_text += string is a bad idea
2019-12-21 14:38:54 +01:00
abbff65dc8
Mention that bbcode_text += string is a bad idea
2019-12-21 10:45:26 +01:00
2b1fb0375d
Mention how to handle cancel in ConfirmationDialog
2019-12-21 00:19:16 +01:00
b3a70f0b80
Merge pull request #34357 from clayjohn/DOCS-VisualServer
...
Updated docs for many VisualServer methods
2019-12-20 09:20:29 +01:00
Rémi Verschelde
Revan Ji
Hugo Locurcio
Bojidar Marinov
Tomasz Chabora
Markus Sauermann
Avantir-Chaosfire
lawnjelly
Fredia Huya-Kouadio
Dominik 'dreamsComeTrue' Jasiński
Marcel Admiraal
Michael Alexsander
PouleyKetchoupp
Nannaquin
lucaslcode
Zak Grumbles
Yuri Sizov
Danil Alexeev
Yuri Roubinsky
Nathan
Andrea Catania
Umang Kalra
Aaron Franke
fhuya
Pierre Caye
Bastiaan Olij
Mateo Dev .59
Fabio Alessandrelli
muiroc
Pedro J. Estébanez
clayjohn
Haoyu Qiu
seenloitering
Andrii Doroshenko (Xrayez)
Roi Valcárcel
Eric Rybicki
Feniks
Jóhannes Gunnar Þorsteinsson
Chris Bradfield
cajallen
Krystof Klestil
rainlizard
Ryan Roden-Corrent
Fabian Keller
Lakshay Angrish
willnationsdev