Commit graph

1849 commits

Author SHA1 Message Date
Zak
1a397f46e6 Improved documentation of rsplit Method for String class.
Improved documentation of rsplit Method for String class.

Removed "divisor" (i will also change variants_call.cpp) and added "delimiter" in its place. Also moved the example at the bottom of the description.
2019-06-11 13:39:18 +03:00
Rémi Verschelde
ec3617c8ac
Merge pull request #29669 from akien-mga/doc-url-format
makerst: Fix format of [url] links in reST
2019-06-11 11:18:40 +02:00
Rémi Verschelde
c7246d8e1e makerst: Fix format of [url] links in reST
Moved some logic to make_url in an attempt to reuse it in the parser,
but it proved too complex so I ended up not using it. I kept it as a
separate method nevertheless.
2019-06-11 10:51:10 +02:00
Ertain
7a397d6976
Corrected spelling error 2019-06-11 03:19:16 -05:00
tree786
e9b8ff273d
Update VehicleWheel.xml
It seems (please correct me if you understand it otherwise) that the description for the `get_skidinfo()` function is the inverse of what actually happens. I have run some simple tests, and it looks like setting low `Friction Slip` (e.g. try `1` or `2`) causes more skidding and returns smaller values for `get_skidinfo()`, while when the `Friction Slip` is increased, the car skids less and values printed to the console increase (get closer to `1.0`). So it seems that a value of `0.0` means skidding, while a value of `1.0` means no skidding (the description says the exact opposite to this, from what I understood).
2019-06-10 03:36:29 +01:00
Maxime Leroy
f1e2324605
Adding details about Image.lock() function 2019-06-08 16:03:50 +02:00
Nils ANDRÉ-CHANG
e4f90337f2 Treat hiding_enabled as bool throughout 2019-06-08 12:37:57 +01:00
Maxime Leroy
024d595850
Fixing returned alpha component for inverted method
See `core/color.cpp:217`, alpha channel is not changed.
2019-06-08 01:44:25 +02:00
Rémi Verschelde
197b65f32a
Merge pull request #29411 from clayjohn/multimesh_instance_2d
Added MultiMeshInstance2D node for using MultiMesh in 2D
2019-06-04 22:40:13 +02:00
Rémi Verschelde
d0dc42f80c
Merge pull request #29464 from bruvzg/macos_fix_non_ime_unicode_input
[macOS] Fixes unicode input with IME input mode inactive.
2019-06-04 18:49:53 +02:00
bruvzg
8ff72987c0
[macOS] Fixes unicode input with IME mode inactive, Improves IME mode documentation. 2019-06-04 11:29:00 +03:00
bruvzg
54863b20e6
Removes redundant "display/window/per_pixel_transparency/splash" setting, improves per pixel transparency documentation. 2019-06-04 11:21:29 +03:00
Rémi Verschelde
e13d470034
Merge pull request #29427 from GDquest/doc-gdscript-assert
Improve @GDScript.assert documentation
2019-06-04 09:23:33 +02:00
Maxime Leroy
77b6f3e812 Adding missing description for method and fixing typo 2019-06-04 03:20:58 +02:00
Nathan Lovato
6f1f887078 Improve @GDScript.assert documentation
Mention that assert only runs in debug builds, closes #29154
2019-06-04 10:00:17 +09:00
clayjohn
2b8b1d7c46 added MultiMeshInstance2D node for using MultiMesh in 2D 2019-06-03 12:11:54 -07:00
Rémi Verschelde
0dac4d6db6
Merge pull request #25522 from aqnuep/MeshLibrary_improvements
MeshLibrary export improvements
2019-06-03 13:59:43 +02:00
Rémi Verschelde
d1999048e9
Merge pull request #29428 from akien-mga/docdata-merge-properties
doc: Fix DocData.merge_from copying old setters and getters
2019-06-03 13:54:53 +02:00
Rémi Verschelde
1abca62697
Merge pull request #29426 from GDquest/object-docs-improvements
Improve the documentation of the Object class
2019-06-03 13:11:58 +02:00
Rémi Verschelde
e1e3fcc908 doc: Fix DocData.merge_from copying old setters and getters
This is not necessary and means that some setters and getters
can end up wrong if they are changed in the bindings but DocData
does not update them when running --doctool.

Fixes #29425.

Co-authored-by: Bojidar Marinov <bojidar.marinov.bg@gmail.com>
2019-06-03 13:03:05 +02:00
Nathan Lovato
21a0dad58a Improve the documentation of the Object class
I edited the main description to remove parentheses and split long sentences.

Closes #29382
Closes #29384
2019-06-03 19:10:59 +09:00
Rémi Verschelde
a3462c97ad Bind missing FLAG_DISABLE_Z enum value in ParticlesMaterial
Fixes #29419.
2019-06-03 11:18:13 +02:00
Gilles Roudiere
f247832832 Add configurable strength value to InputEventAction 2019-06-02 14:31:34 +02:00
Rémi Verschelde
449395716f
Merge pull request #28390 from KoBeWi/smaller_bigger_gizmo
Allow to change Position2D gizmo size
2019-06-02 00:06:28 +02:00
Rémi Verschelde
cfb9709c10 doc: Sync classref with current source 2019-06-01 12:34:29 +02:00
Tomasz Chabora
662c8f95ec Allow to change Position2D gizmo size 2019-06-01 12:33:24 +02:00
Rémi Verschelde
93845572d5
Merge pull request #29372 from akien-mga/docs-tutorials-track-latest
doc: Make all tutorial links track "latest" in master branch
2019-06-01 12:05:41 +02:00
Rémi Verschelde
3c4fab295b
Merge pull request #27789 from Giacom/move_towards
Added move_toward functions for float, Vector2 and Vector3
2019-06-01 12:05:18 +02:00
Rémi Verschelde
64a88e8ef3
Merge pull request #28841 from KoBeWi/option_button_options
Improvements to incremental search
2019-06-01 11:47:06 +02:00
Rémi Verschelde
e92c09ba4e doc: Make all tutorial links track "latest" in master branch
While the master branch is in development state for the next stable branch,
its links should point to the "latest" docs branch, to ensure that users of
the unstable builds are linked to the relevant documentation.

Those links could be switched to stable branch subdomains before branching
off for a new major or minor release, to start tracking the frozen stable
docs branches.

See discussion in #29104.
2019-06-01 11:33:34 +02:00
Rémi Verschelde
af2c742f53 Fix and expose String::strip_escapes(), use it in LineEdit paste
Supersedes #27736.
2019-05-31 15:49:14 +02:00
Tomasz Chabora
9de912caf5 Improvements to incremental search 2019-05-31 14:56:49 +02:00
Rémi Verschelde
7770f8cb7e
Merge pull request #29331 from KoBeWi/animation_time_machine
Add track_set_key_time() to Animation
2019-05-31 10:12:37 +02:00
Cheeseness
b06dc6ba8c Correct typos in RigidBody axis lock documentation 2019-05-31 13:28:30 +10:00
Tomasz Chabora
adcbcf87dd Add track_set_key_time() to Animation 2019-05-31 00:40:29 +02:00
Rémi Verschelde
c6b96050d0
Merge pull request #29311 from AspenBlack/patch-1
More accurate description of valid Parents
2019-05-30 16:43:28 +02:00
Aspin
a9ddf2a449
More accurate description of valid Parents
I hope this is the right place to edit now.
2019-05-30 20:41:55 +08:00
follower
a3aa98cb88
Improve AudioStreamSample documentation.
"Squash" of #27928.

Wording based on suggestions by @LikeLakers2.
2019-05-31 00:20:33 +12:00
Chaosus
0bc37de744 Added 2D functions to AStar 2019-05-30 07:10:07 +03:00
Rémi Verschelde
e9ca1a1299
Merge pull request #25520 from Zylann/expose_node_custom_aabb
Exposed custom AABB setter on GeometryInstance
2019-05-29 17:18:17 +02:00
Hugo Locurcio
30474b8215
Improve the PrimitiveMesh-derived class documentations 2019-05-28 20:37:05 +02:00
Rémi Verschelde
0e441e9a1a
Merge pull request #29248 from Cheeseness/camera_project_fix
Add a depth parameter to Camera::project_position()
2019-05-28 19:25:37 +02:00
Rémi Verschelde
3a365c1fc0 doc: Sync classref with current source 2019-05-28 18:08:13 +02:00
Cheeseness
6fe957de63 Add a depth parameter to Camera::project_position() 2019-05-29 02:04:50 +10:00
Tomasz Chabora
86e4677fb4 Add HSV mode to color picker 2019-05-28 18:00:52 +02:00
Giacom
c00427add3 Added move_toward functions for float, Vector2 and Vector3 2019-05-28 11:39:35 +01:00
Rémi Verschelde
47f00925dc
Merge pull request #28454 from homer666/popup-centered-maxsize
Add `popup_centered_clamped()` method to Popup
2019-05-28 11:36:41 +02:00
Michael Alexsander Silva Dias
fad0338beb Make animation editor change tracks positions instead of swapping them 2019-05-27 22:03:26 -03:00
Jummit
ce2c45bde7 add get_camera_rid method 2019-05-27 16:05:27 +02:00
Rémi Verschelde
e8fbb28e20
Merge pull request #29119 from bruvzg/native_icon_support
Add native window/taskbar icon support for Windows and macOS.
2019-05-27 12:09:42 +02:00
Tomasz Chabora
fbf4135fc1 Add example usage for get_rect() 2019-05-26 15:51:27 +02:00
Michael Alexsander Silva Dias
b3c2305160 Add "GUI skinning" tutorial link to the 'Theme' doc 2019-05-24 17:19:24 -03:00
Rémi Verschelde
01c41c782b
Merge pull request #28796 from clayjohn/GLES2-optimization
GLES2: Allow Viewports to render directly to screen
2019-05-24 17:31:44 +02:00
Rémi Verschelde
5785b9ae1d
Merge pull request #29055 from cbscribe/kcc_docs_animstate
[DOCS] Add descriptions to AnimationNodeStateMachine[Playback]
2019-05-24 14:51:06 +02:00
Rémi Verschelde
33239a5ada
Merge pull request #29127 from Xrayez/geometry-delaunay-bind
Expose 2D Delaunay triangulation in Geometry singleton
2019-05-24 13:27:11 +02:00
bruvzg
2b9ed68d6a
Add native window/taskbar icon support for Windows and macOS.
Co-authored-by: Markus Törnqvist <mjt@nysv.org>
2019-05-24 14:23:57 +03:00
Chris Bradfield
47b8615a2e [DOCS] Add descriptions to AnimationNodeStateMachine[Playback] 2019-05-24 12:44:15 +02:00
Rémi Verschelde
c8957295a6
Merge pull request #29146 from seandheffernan/returnFix2
Change "Return" to "Returns" where necessary in XML documentation
2019-05-24 12:21:12 +02:00
Andrii Doroshenko (Xrayez)
24e9a881c0 Expose 2D Delaunay triangulation in Geometry singleton
Can be used via scripting as `Geometry.triangulate_delaunay_2d(points)`

The interface is the same as in `Triangulate` library, returning indices
into triangulated points.
2019-05-24 13:10:13 +03:00
Sean Heffernan
426bcc9941 Change "Return" to "Returns" where necessary in XML documentation
In many of the XML files it had been noted that when the documentation
refers to a return value, both "Return" and "Returns" are used. This
has now been fixed to only say "Returns".

Fixes #28867
2019-05-23 21:11:24 -07:00
WiggleWizard
aebca30c43 Fixed virtual method not showing up in autocomplete and docs 2019-05-23 22:31:02 +01:00
Andrii Doroshenko (Xrayez)
883ef8570a Expose 2D polygon boolean operations in Geometry singleton
Clipper 6.4.2 is used internally to perform polypaths clipping, as well
as inflating/deflating polypaths. The following methods were added:

```
Geometry.merge_polygons_2d(poly_a, poly_b) # union
Geometry.clip_polygons_2d(poly_a, poly_b) # difference
Geometry.intersect_polygons_2d(poly_a, poly_b) # intersection
Geometry.exclude_polygons_2d(poly_a, poly_b) # xor

Geometry.clip_polyline_with_polygon_2d(poly_a, poly_b)
Geometry.intersect_polyline_with_polygon_2d(poly_a, poly_b)

Geometry.offset_polygon_2d(polygon, delta) # inflate/deflate
Geometry.offset_polyline_2d(polyline, delta) # returns polygons

// This one helps to implement CSG-like behaviour:
Geometry.transform_points_2d(points, transform)
```

All the methods return an array of polygons/polylines. The resulting
polygons could possibly be holes which could be checked with
`Geometry.is_polygon_clockwise()` which was exposed to scripting as well.
2019-05-22 17:12:39 +03:00
Rémi Verschelde
02bc82f9be
Merge pull request #29022 from mrcdk/preview_generator_fixes
Add some extra functions to EditorResourcePreviewGenerator
2019-05-22 12:16:32 +02:00
Rémi Verschelde
86f6d08923 doc: Sync classref with current source 2019-05-21 13:27:03 +02:00
Rémi Verschelde
defd960276
Merge pull request #27886 from LeonardMeagher2/obj_to_string
Allow overriding how scripted objects are converted to strings
2019-05-20 22:37:01 +02:00
Rémi Verschelde
5cc1c7d642
Merge pull request #28985 from rcorre/advance_condition_docs
Clarify auto_advance.
2019-05-20 18:00:14 +02:00
Rémi Verschelde
f3b8fe47b0 doc: Document default value for PhysicsBody collision layers
Supersedes #28971.

Co-authored-by: Mitch Curtis <mitch.curtis@qt.io>
2019-05-20 12:12:27 +02:00
MrCdK
f8a9844d80 Renamed EditorResourcePreviewGenerator.should_generate_small_preview() to generate_small_preview_automatically()
Added can_generate_small_preview() so the generator uses generate() or generate_from_path() if it returns true
Added can_generate_small_preview() and generate_small_preview_automatically() to the scripting languages
2019-05-20 11:08:39 +02:00
Ryan Roden-Corrent
20168b5fbf
Clarify auto_advance.
Make the docs more clear about how you can use auto_advance. Calling it
a "variable" is vague, so I updated the docs to clearly state that it
becomes a boolean parameter on the AnimationTree.
Fixes godotengine/godot-docs#2439.
2019-05-19 17:51:35 -04:00
Rémi Verschelde
e0574e1d98 Fix typos with codespell
Using codespell 1.15.0.

Method:
```
$ cat > ../godot-word-whitelist.txt << EOF
ang
curvelinear
doubleclick
leapyear
lod
merchantibility
nd
numer
ois
ony
que
seeked
synching
te
uint
unselect
webp
EOF

$ codespell -w -q 3 -I ../godot-word-whitelist.txt --skip="./thirdparty,*.po"
$ git diff // undo unwanted changes
```
2019-05-19 13:10:35 +02:00
Max Hilbrunner
ee5ba3e097
Merge pull request #28366 from iwek7/feature/issue28355/showSpacesInEditor
Add feature to show spaces in code editor
2019-05-17 20:38:40 +02:00
Max Hilbrunner
c2df3189fa
Merge pull request #28959 from volzhs/doc-editor-plugin-update_overlays
Add description for EditorPlugin.update_overlays
2019-05-17 17:18:17 +02:00
volzhs
5fe2bf125a Add description for EditorPlugin.update_overlays 2019-05-17 22:36:40 +09:00
Julian Murgia
b72ba99939
Merge pull request #28950 from YeldhamDev/doc_string_format_link
Add "String Formatting" tutorial link to the 'String' doc
2019-05-17 09:27:47 +02:00
Michael Alexsander Silva Dias
3197898c88 Add "String Formatting" tutorial link to the 'String' doc 2019-05-16 23:07:52 -03:00
Max Hilbrunner
05cb337f2d
Merge pull request #28587 from Daw11/lanczos
Implement Lanczos image filter
2019-05-16 23:25:48 +02:00
Stanislav
102f73b88a Add support for [url=] tag to makerst.py
Fixes #28904
2019-05-16 16:13:42 +03:00
Rémi Verschelde
996abb83e3 doc: Fix issues found by the parser 2019-05-15 13:00:45 +02:00
Rémi Verschelde
30da18c01a doc: Sync classref with current source 2019-05-15 12:51:58 +02:00
Hugo Locurcio
1cfa74bf92
Improve the CanvasItem documentation
This makes it clear that line width and antialiasing in
`draw_multiline()` aren't implemented yet (see #16448).
2019-05-14 09:10:00 +02:00
clayjohn
65c211d303 Implement ability to render viewports directly to screen 2019-05-13 15:20:15 -07:00
Rémi Verschelde
647021e864
Merge pull request #28326 from BastiaanOlij/center_heightmap
Center shape according to logic Bullet applies
2019-05-13 12:58:00 +02:00
hbina085
d02ecd5a18 updated description of Array.shuffle to properly describe that it uses the same common seed at every runtime, thus being reproducible in general 2019-05-11 18:04:47 -04:00
Guilherme Felipe
36e9af4812 Docs: Add tutorials for KinematicBody2D 2019-05-08 13:45:40 -03:00
Ken Paulson
ece6d37eef Improved the AnimatedSprite docs; added description to speed_scale. 2019-05-07 22:48:39 -04:00
Bastiaan Olij
e4dea0595a Add transform support to deal with Bullets centering of shapes 2019-05-07 22:43:10 +10:00
Bastiaan Olij
4bb0df7060 Center shape according to logic Bullet applies 2019-05-07 20:44:09 +10:00
Rémi Verschelde
9123db748e
Merge pull request #28330 from BastiaanOlij/improve_multimesh
Added set_as_bulk_array, fixed transform2D saving and documentation
2019-05-06 09:57:48 +02:00
Daw11
28bff3d1ad Implement Lanczos image filter 2019-05-05 14:03:56 +02:00
Max Hilbrunner
d8617f237a
Merge pull request #28643 from t-karcher/patch-1
Update of RigidBody2D class description
2019-05-05 08:36:45 +02:00
lopho
5ce9bfcb4f Document dictionary erase return value 2019-05-04 21:10:18 +02:00
Leonard Meagher
f7eb426e2e Allow overriding how scripted objects are converted to strings
solves #26796

- ADD `String to_string()` method to Object which can be overriden by `String _to_string()` in scripts
- ADD `String to_string(r_valid)` method to ScriptInstance to allow langauges to control how scripted objects are converted to strings
- IMPLEMENT to_string for GDScriptInstance, VisualScriptInstance, and NativeScriptInstance
- ADD Documentation about `Object.to_string` and `Object._to_string`
- Changed `Variant::operator String` to use `obj->to_string()`
2019-05-03 15:06:05 -07:00
Tomasz Chabora
0b8a785539 Make second parameter of substr optional 2019-05-03 19:46:56 +02:00
Thomas Karcher
1170b78e28
Update of RigidBody2D class description
Added a hint in the RigidBody2D class description regarding the transformation issue mentioned in https://github.com/godotengine/godot/issues/5734
2019-05-03 10:49:54 +02:00
Rémi Verschelde
f1e39e1fc8
Merge pull request #28636 from bojidar-bg/d2426-panel-styles
Remove unused panelf and panelnc styles
2019-05-03 09:40:11 +02:00
Bojidar Marinov
3d47dad2b1
Remove unused panelf and panelnc styles
Fixes godotengine/godot-docs#2426
2019-05-03 09:44:46 +03:00
lopho
da73bcca6f
Document CollisionObject2D pickable requires collision_layer
Documents CollisionObject2D mouse_entered, mouse_exited and input_event requiring at least one collision_layer to be set.
2019-05-02 15:43:28 +02:00
Max Hilbrunner
46b6fb83ef
Merge pull request #28542 from Anchakor/master
Small documentation improvements
2019-05-01 21:45:56 +02:00
miwanczuk
c86b03abd8 Expose TextEdit's drawSpaces feature to GDScript 2019-05-01 11:32:54 +02:00
Jiří Procházka
04b49264f2 Small documentation improvements 2019-05-01 11:11:09 +02:00