Commit Graph

1501 Commits

Author SHA1 Message Date
Rémi Verschelde 0db138a621 doc: Enforce default values for OS properties
Otherwise we end up fetching values from the current OS instance
when running doctool, so they would change based on the system or
even simply due to changes to the system clipboard.
2019-06-30 13:58:07 +02:00
Rémi Verschelde 1fbca7ed88 doc: Mark PhysicsBody bounce/friction as deprecated 2019-06-30 13:58:07 +02:00
Rémi Verschelde 850a54a2a5 Fix uninitialized variables in Line2D, JSONParseResult and TileMap 2019-06-30 13:58:07 +02:00
Rémi Verschelde 26f99beac3 CPUParticles2D: Fix gravity to be the same as in Particles2D and Area2D
This was likely a typo, 10 times the standard gravity is 98.0665
(ca. 98), not 98.8.
2019-06-30 13:58:07 +02:00
Rémi Verschelde a78373ddc2 doc: Remove null default values that can't be determined
Applying #30187.
2019-06-30 13:58:07 +02:00
Rémi Verschelde b9aa13e591 doc: Remove hardcoded default values from descriptions
They are now generated automatically by doctool.
2019-06-30 13:58:07 +02:00
Rémi Verschelde c6cea6e9b3 doc: Add default values to all properties
Thanks to @bojidar-bg's impressive work in #29380.
2019-06-30 13:58:07 +02:00
Rémi Verschelde 82604195b4
Merge pull request #30062 from zaksnet/fix-referencerect-node
Adds ReferenceRect an option to be visible inside the game
2019-06-30 13:41:45 +02:00
unknown f2fd5dfb91 Added descriptions to OS.get_splash_tick_msec() and OS.get_window_safe_area() 2019-06-29 17:21:25 +05:30
Rémi Verschelde e222e31fe6 doc: Sync classref with current source 2019-06-29 12:24:18 +02:00
Rémi Verschelde 1bbad8c469
Merge pull request #29923 from zaksnet/Document-Spinbox
Document SpinBox Node
2019-06-29 11:41:14 +02:00
Rémi Verschelde 9adc158097
Merge pull request #30162 from KoBeWi/doc-ready
Clarify docs for _ready and request_ready
2019-06-29 11:27:27 +02:00
Zak f9cbd34fe0 Document SpinBox node 2019-06-29 11:13:02 +02:00
Tomasz Chabora b71a339160 Clarify docs for _ready and request_ready 2019-06-28 19:18:43 +02:00
Zak 316931998c Document PopupMenu node. 2019-06-28 12:57:52 +02:00
Zak d29b1b7917 Fix ReferenceRect node
ReferenceRect node by default was only displaying in the editor and not when the game is running.
2019-06-28 12:42:42 +03:00
Hugo Locurcio f7f6115f76
Proofread and improve the whole class reference
- Document a few more properties and methods
- Add more information to many classes
- Fix lots of typos and gramar mistakes
- Use [code] tags for parameters consistently
- Use [b] and [i] tags consistently
- Put "Warning:" and "Note:" on their own line to be more visible,
  and make them always bold
- Tweak formatting in code examples to be more readable
- Use double quotes consistently
- Add more links to third-party technologies
2019-06-27 22:30:19 +02:00
Rémi Verschelde f35fd681ac
Merge pull request #30114 from Chaosus/vs_context_menu
Shows menu when dragging connection on empty space in visual shader
2019-06-27 15:14:54 +02:00
Rémi Verschelde 528c4722d6 doc: Don't use `GlobalScope` scope in hyperlinks, it's automatically inferred 2019-06-27 14:43:37 +02:00
Rémi Verschelde bc82781f7d doc: Replace all [code]CONSTANT[/code] by new [constant CONSTANT] hyperlinks 2019-06-27 13:49:36 +02:00
Rémi Verschelde 1bf448dd87 Properly expose all Error constants to scripting languages 2019-06-27 12:48:26 +02:00
Rémi Verschelde 71d53637b5 doc: Fix scoped hyperlinks to same-class enums/methods
The class name does not need to be specified when it is the current class.
2019-06-27 11:44:37 +02:00
Rémi Verschelde 86ed7a9884 doc: Complete and harmonize all _MAX constant descriptions 2019-06-27 11:10:53 +02:00
Chaosus 0aec3c3113 Shows menu when dragging connection on empty space in visual shader graph 2019-06-27 10:48:18 +03:00
Rémi Verschelde 755b589384
Merge pull request #30096 from akien-mga/doc-misc-updates
doc: Proofread and complete various nodes
2019-06-27 08:12:34 +02:00
Rémi Verschelde d8c9646118
Merge pull request #30105 from Xrayez/bind-pip-geometry
Bind is_point_in_polygon in Geometry singleton
2019-06-27 01:03:51 +02:00
Rémi Verschelde caf8e20f2a
Merge pull request #30078 from Zylann/document_vs_cull_ray
Document VisualServer.instances_cull_ray
2019-06-26 23:28:56 +02:00
Andrii Doroshenko (Xrayez) 6f2233d13a Bind is_point_in_polygon in Geometry singleton 2019-06-27 00:20:22 +03:00
Rémi Verschelde 867dda1124 doc: Proofread and complete various nodes
All 100% completed: MainLoop, Node, Object, Path, Performance,
Reference, Resource, SceneState, SceneTree, UndoRedo.

Also fixed some en_GB occurrences as the reference spelling is en_US.
2019-06-26 23:05:51 +02:00
Rémi Verschelde 43a6969470
Merge pull request #25863 from AlexHolly/undo-redo-version-signal
UndoRedo add version changed signal
2019-06-26 22:56:51 +02:00
Marc Gilleron cb5233ee12 Document VisualServer.instances_cull_ray 2019-06-26 19:53:22 +01:00
Rémi Verschelde 2c96942df9
Merge pull request #30088 from akien-mga/node-get_node_and_resource
Node: Fix logic of has/get_node_and_resource and document it
2019-06-26 16:48:21 +02:00
Alexander Holland 8f23f4b44e UndoRedo add version changed signal
added some functions to manage undo buttons
2019-06-26 16:32:34 +02:00
Rémi Verschelde 261bdfa14d doc: Sync classref with current source 2019-06-26 16:03:04 +02:00
Rémi Verschelde 6e9272eea8 Node: Fix logic of has/get_node_and_resource and document it
Also document NodePath.
2019-06-26 15:46:32 +02:00
Rémi Verschelde a9cff880d6 doc: Document EncodedObjectAsID, expose its property 2019-06-26 10:50:45 +02:00
Rémi Verschelde 615ffb3507 doctool: Fix writing theme_item descriptions
We already had support for parsing and saving theme_item descriptions
in DocData, and displaying it in the editor, but doctool would drop the
changes as it was not writing them back to the XML.

Part of #29868.
2019-06-25 13:08:15 +02:00
Rémi Verschelde 230eb262e2
Merge pull request #30030 from zaksnet/document-margincontainer
Document MarginContainer node
2019-06-25 12:20:49 +02:00
austinried 9eeead4be3
Remove references to mouse stuff from OS
There is nothing in `OS` about mouse grabbing or mouse cursors, that's in `Input`, so I'm cleaning up those references.
2019-06-24 19:28:49 -07:00
Rémi Verschelde 8c483886d2
Merge pull request #30016 from randall-fulton/docs/object-set-deferred
Add docstring for Object.set_deferred
2019-06-24 22:09:15 +02:00
Rémi Verschelde f34c8015cb Area2D: Fix argument type of body_* signals
Those signals receive either a PhysicsBody2D or a TileMap object,
and what the emitting method checks internally is only that the
object is a Node. In theory any Node could go through these signals
if they talk directly to the PhysicsServer2D.

Also updated docs.

Fixes #27076.

Might need further (compat breaking) improvement as this API is a
bit confusing, cf. #24739.
2019-06-24 21:40:31 +02:00
Randall Fulton 6843ad87a4 Add docstring for Object.set_deferred 2019-06-24 12:57:14 -05:00
Zak 9f582a7c3e Document MarginContainer Node 2019-06-24 16:39:35 +03:00
Rémi Verschelde 5e21310343 doc: Sync classref with current source 2019-06-24 10:39:59 +02:00
Hugo Locurcio 03335e5250
Improve the `Engine.get_version_info()` documentation
This documents some keys that were missing and improves formatting.
2019-06-21 15:15:55 +02:00
Rémi Verschelde 1e833cadbc
Merge pull request #29935 from Faless/net/get_if_multicast_pr
Multicast, more network interfaces info
2019-06-21 10:21:01 +02:00
Fabio Alessandrelli e5e3f86648 Multicast support in NetSocket/PacketPeerUDP 2019-06-21 00:14:42 +02:00
Fabio Alessandrelli b574e476ec Implement IP.get_local_interfaces.
Allow getting interfaces names and assigned names.

On UWP this is not supported, and the function will return one interface
for each local address (with interface name the local address itself).
2019-06-21 00:14:42 +02:00
Zak 5d0040e340 Document ReferenceRect Node
Added missing documentation for ReferenceRect Node
2019-06-20 17:35:08 +03:00
Rémi Verschelde 8591691b9b
Merge pull request #24249 from zorbathut/zorbathut/animimmediate
Implement AnimationPlayer call modes as per #23498.
2019-06-20 13:04:34 +02:00
Rémi Verschelde 922a4f5413
Merge pull request #29901 from BastiaanOlij/fix_cameraserver_const
Made constants fully upper case in camera server
2019-06-19 20:20:47 +02:00
Michael Alexsander Silva Dias 1c2ba35074 Add 'global_rate_scale' to the AudioServer
Closes #28953.
2019-06-19 11:36:46 -03:00
Tristan Grespinet 14f8ed3317 Added a Width Curve to Line2D + UVs fix 2019-06-19 15:44:07 +02:00
Rémi Verschelde 43a9b8c76c
Merge pull request #27237 from Chaosus/astar_2d
Added 2D functions to AStar
2019-06-19 15:07:59 +02:00
Rémi Verschelde d7af08aa95
Merge pull request #27389 from YeldhamDev/acceptdiag_label_wrap
Add option to enable autowrapping for label inside 'AcceptDialog'
2019-06-19 14:46:32 +02:00
Bastiaan Olij 4ebedb5f11 Made constants fully upper case in camera server 2019-06-19 22:24:54 +10:00
Rémi Verschelde 2b52cd3e5c
Merge pull request #28648 from KoBeWi/substr-1
Make second parameter of substr optional
2019-06-19 12:43:46 +02:00
Rémi Verschelde bb0aeb4874
Merge pull request #28659 from KoBeWi/rainbow_mode
Add HSV mode to color picker
2019-06-19 12:41:51 +02:00
Rémi Verschelde c39bf80a08
Merge pull request #29851 from akien-mga/doc-resource
doc: Improve docs for Resource* classes
2019-06-19 00:10:56 +02:00
Rémi Verschelde 3345c03122
Merge pull request #29870 from Anutrix/docup1
Added description to is_pixel_opaque() in Sprite.xml
2019-06-18 20:56:38 +02:00
Rémi Verschelde 0764451dc5 doc: Improve docs for Resource* classes
Also move module-specific classes to their own module's `doc_classes`
folder.
2019-06-18 20:07:26 +02:00
Rémi Verschelde d6176db271 Unexpose subclasses of ResourceFormatLoader and -Saver
ResourceFormatLoader and ResourceFormatSaver are meant to be overridden
to add support for different formats in ResourceLoader and ResourceSaver.
Those should be exposed as they can be overridden in plugins.

On the other hand, all predefined subclasses of those two base classes
are only meant to register support for new file and resource types, but
should not and cannot be used directly from script, so they should not
be exposed.

Also unexposed ResourceImporterOGGVorbis (and thus its base class
ResourceImporter) which are editor-only.
2019-06-18 17:56:23 +02:00
unknown 44a20a0f61 Added description to is_pixel_opaque() in Sprite.xml 2019-06-18 20:57:42 +05:30
Rémi Verschelde 054ac5c8f5 doc: Sync classref with current source
Fix a few bugs.
2019-06-18 15:07:31 +02:00
Rémi Verschelde 08ebeee0e1
Merge pull request #29840 from Anutrix/master
Added description in TranslationServer and OpenSimplexNoise
2019-06-18 15:01:42 +02:00
Rémi Verschelde 8b83e6d580
Merge pull request #29676 from zaksnet/ItemList-Imrovements
Document ItemList control
2019-06-18 15:01:11 +02:00
Zak 49df253627 Document ItemList control 2019-06-18 08:36:32 +03:00
clayjohn 7d1ee6d3c3 change emit shape circle to sphere in CPUParticles2D 2019-06-17 11:59:31 -07:00
Rémi Verschelde 0d61fc2c0f
Merge pull request #29752 from bruvzg/window_size_limits
Add ability to limit maximum/minimum window size.
2019-06-17 11:58:00 +02:00
Rémi Verschelde fc4b93e161
Merge pull request #29743 from zaksnet/document-textedit
Document TextEdit node
2019-06-17 11:30:26 +02:00
unknown 3cdd701a14 Added description to get_loaded_locales() in TranslationServer 2019-06-17 12:12:04 +05:30
Zak 1f81981b3d Document TextEdit node 2019-06-16 12:32:25 +03:00
Rémi Verschelde 9c7cce3c9b doc: Sync classref with current source, fix formatting issues 2019-06-16 11:22:38 +02:00
Rémi Verschelde 6ba1b4e371
Merge pull request #29764 from Calinou/boot-splash-no-filter-option
Add an option to disable boot splash filtering
2019-06-16 10:39:53 +02:00
Rémi Verschelde baab976d0f
Merge pull request #10643 from BastiaanOlij/camera_server
CameraServer class
2019-06-16 10:22:26 +02:00
Hugo Locurcio 786a7341a7
Add an option to disable boot splash filtering
Disabling filtering is usually desired in projects using a pixel art style.

This closes #19415.
2019-06-15 23:53:39 +02:00
Rémi Verschelde ce8e541339
Merge pull request #29643 from GDquest/doc-animation-nodes
Add documentation for AnimationNode* resources
2019-06-15 23:12:49 +02:00
BastiaanOlij 02ea99129e Adding a new Camera Server implementation to Godot.
This is a new singleton where camera sources such as webcams or cameras on a mobile phone can register themselves with the Server.
Other parts of Godot can interact with this to obtain images from the camera as textures.
This work includes additions to the Visual Server to use this functionality to present the camera image in the background. This is specifically targetted at AR applications.
2019-06-15 21:30:32 +10:00
bruvzg b924fb97d6
Add ability to limit maximum/minimum window size. 2019-06-15 09:49:11 +03:00
Nathan Lovato d0eb99f970 Add documentation for AnimationNode* resources
I haven't put [code] bbcode around the amount of the AnimationNodeAdd* classes
because it's not exposed to GDScript.
Same for the +add, -add, etc. labels: they're just labels you can find in the
AnimationTree bottom panel.
2019-06-15 10:35:02 +09:00
Rémi Verschelde 9a173e5814 doc: Fix formatting, typos and some descriptions in new docstrings 2019-06-15 00:11:41 +02:00
Rémi Verschelde 1e5dc9115c
Merge pull request #29768 from cbscribe/kcc_particles_doc
[DOCS] Update CPUParticles[2D] classref
2019-06-14 22:28:46 +02:00
Chris Bradfield 9f7713d98b [DOCS] Update CPUParticles[2D] classref 2019-06-14 10:39:54 -07:00
Ken Paulson 349e924cad Changes to OS.has_feature() docs:
- Added link to the Feature Tags documentation
 - Added note that tag names are case-sensitive
2019-06-14 16:35:54 +02:00
Rémi Verschelde dfbca13eec
Merge pull request #29712 from GDquest/doc-bone2d
Add documentation for Bone2D
2019-06-14 15:37:51 +02:00
Rémi Verschelde 48fb3debf6
Merge pull request #29754 from BastiaanOlij/vr_button_mapping
Added constants for the main buttons and axis used in VR
2019-06-13 17:41:33 +02:00
Bastiaan Olij a9581d2b3f Added constants for the main buttons and axis used in VR 2019-06-13 22:54:08 +10:00
Rémi Verschelde 52dd0f8751 Implement missing orbit velocity for CPUParticles and CPUParticles2D
The relevant code was copied from (GPU) ParticlesMaterial but commented
out initially, and never ported.

Closes #29580.
2019-06-13 11:35:07 +02:00
Nathan Lovato c12fc1ade1 Add documentation for Bone2D 2019-06-13 08:47:46 +09:00
Rémi Verschelde 1c35973b83
Merge pull request #29592 from Lisapple/patch-3
Fixing returned alpha component for inverted method
2019-06-12 22:57:10 +02:00
Rémi Verschelde 51ed803a11
Merge pull request #29658 from clayjohn/docs_mesh
Filled out docs for various mesh types
2019-06-12 22:52:54 +02:00
clayjohn ef45f5ce75 filled out docs for various mesh types 2019-06-12 09:49:47 -07:00
Rémi Verschelde 4073da7ddd
Merge pull request #29605 from Lisapple/patch-4
Adding details about `Image.lock()` function
2019-06-12 15:33:27 +02:00
Rémi Verschelde df25679235
Merge pull request #29601 from NilsIrl/hiding_enabled
Treat hiding_enabled as bool throughout
2019-06-12 14:23:27 +02:00
Rémi Verschelde 902212d8d4
Merge pull request #29646 from tree786/patch-2
'get_skidinfo()' misleading description
2019-06-12 13:30:52 +02:00
Rémi Verschelde 0e6cac8ab8
Merge pull request #29465 from bruvzg/per_pixel_transp_impr
Removes redundant "splash" setting, improves per pixel transparency documentation.
2019-06-12 12:50:17 +02:00
Rémi Verschelde f0bacf360d
Merge pull request #29467 from zaksnet/patch-1
replaced "divisor" with "delimiter" for methods split,rsplit and split_floats.
2019-06-11 13:31:41 +02:00
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
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
Rémi Verschelde a72552367e
Merge pull request #25453 from nekomatata/button-keep-pressed-option
Add option to keep button pressed when moving cursor outside while pressing
2019-05-01 10:30:40 +02:00
Aaron Franke 620ec4703f
Make "decimal" functions more consistent
In GDScript, rename "decimals" to "step_decimals". In C#, add "StepDecimals", but keep the old functionality in a method called "DecimalCount".
2019-04-30 13:49:17 -04:00
Rémi Verschelde dd2cd06165
Merge pull request #25670 from aqnuep/bake_mode_affect_gi_prove
Disable GI probe capturing lights with bake mode disabled
2019-04-30 18:33:34 +02:00
Rémi Verschelde c991379b81 doc: Sync classref with current source 2019-04-30 14:23:59 +02:00
Rémi Verschelde 7e0c97e73b
Merge pull request #27656 from Calinou/doc-lineedit-keybindings
Document built-in LineEdit keybindings
2019-04-30 11:14:03 +02:00
Rémi Verschelde 6e1b8b07b9
Merge pull request #27805 from Kanabenki/line2d-add-point-idx
Add optional position argument for add_point in Line2D
2019-04-30 11:02:47 +02:00
Rémi Verschelde 5313ce232d
Merge pull request #27870 from mawenzy/pr_gotoline
Bind goto_line function for Script Editor
2019-04-30 10:53:23 +02:00
homer666 80e9e93e27 Add Popup::popup_centered_clamped method
- Also replace redundant duplicate code in editor dialogs with calls to popup_centered_clamped()
2019-04-30 05:35:43 +10:00
Rémi Verschelde 1af18ab235
Merge pull request #28399 from YeldhamDev/textedit_expose_tab_fold
Expose 'TextEdit's tab drawing and folding to GDScript
2019-04-29 17:04:46 +02:00
Rémi Verschelde 18e88c8563
Merge pull request #18992 from aaronfranke/mono-equal-approx
[Core] [Mono] Improve and use approximate equality methods
2019-04-29 10:16:46 +02:00
clayjohn e8858a9a44 changed references to array types in arraymesh doc 2019-04-27 10:45:04 -07:00
Juan Linietsky 11fb4ffbf8 Added docs to AudioStreamPlayer for get_mix_time 2019-04-27 14:11:39 -03:00
Bastiaan Olij b652fcd241 Added set_as_bulk_array, fixed transform2D saving and documentation to MultiMesh 2019-04-26 20:30:16 +10:00
Aaron Franke 7f7d97f536
[Core] Expose approximate equality methods to GDScript 2019-04-25 13:20:29 -04:00
Max Hilbrunner 4ad22f8148
Merge pull request #28359 from Calinou/doc-improve-projectsettings
Improve the ProjectSettings documentation
2019-04-25 13:19:32 +02:00
Michael Alexsander Silva Dias 350bcce041 Expose 'TextEdit's tab drawing and folding to GDScript 2019-04-24 12:42:12 -03:00
Hugo Locurcio 436d000066
Improve the ProjectSettings documentation 2019-04-24 13:37:14 +02:00
Rémi Verschelde ea56d18256 doc: Sync classref with current source 2019-04-24 07:50:14 +02:00
Juan Linietsky 325f6c6581 Added inspector plugin documentation.
Fixed plugin bindings.
2019-04-23 16:39:09 -03:00
Daniel Rakos de33ef2d1b Disable GI probe capturing lights with bake mode disabled
The bake mode property of lights previously didn't affect GI probes.
This change makes the GI probe ignore lights that have their bake mode
set to disabled.
2019-04-23 11:36:36 +02:00
Hein-Pieter van Braam f2d3d3e679
Merge pull request #24269 from xsellier/feature/master-add-sha256
Add SHA256 for PoolByteArray
2019-04-23 06:38:03 +03:00
Hein-Pieter van Braam 2779bdf557
Merge pull request #27724 from follower/patch-2
Add example of loading a font from .ttf file
2019-04-23 06:04:25 +03:00
Rémi Verschelde 886afa9b76
Merge pull request #26868 from NilsIrl/master
Add Attenuation Model "NO" for AudioStreamPlayer3D
2019-04-22 13:36:07 +02:00
Rémi Verschelde ab4705a807
Merge pull request #28125 from KoBeWi/code_true_code
Consistently wrap booleans in [code]
2019-04-22 11:59:16 +02:00
Rémi Verschelde 201cdd358a
Merge pull request #28140 from Daw11/orphan-nodes
Add a monitor for the orphan nodes
2019-04-22 11:55:15 +02:00
Nils ANDRÉ-CHANG a1fc73e6d3 Add Attenuation Model "DISABLED" for AudioStreamPlayer3D 2019-04-22 10:34:28 +01:00
Hasan Yusuf Ahmed 8e652a1400 Added minimal documentation for _get_configuration_warning method
(cherry picked from commit 0eeb1a7d0d)
2019-04-19 13:01:17 +02:00
Rémi Verschelde b29df348e2
Merge pull request #28192 from akien-mga/doc-unused-demos
doc: Drop unused <demos> tag, sync classref
2019-04-19 12:50:42 +02:00
Rémi Verschelde 268b520703 doc: Sync classref with current source 2019-04-19 11:21:09 +02:00
Rémi Verschelde 6af69f851a doc: Drop unused <demos> tag 2019-04-19 11:03:46 +02:00
Daw11 04d0371648 Add a monitor for the orphan nodes
- Allow the user to keep track of the nodes that might leak
- Possible fix for #27103
2019-04-17 23:13:16 +02:00
Soham Kar aa8b2f4448
Fixed copy&paste error #28117
Changed "left to right" in VSplitContainer to "top to bottom".
2019-04-17 22:51:51 +05:30
Tomasz Chabora b0846f60c9 Consistently wrap booleans in [code] 2019-04-17 17:13:00 +02:00
mawenzy d87021de93 Bind goto_line function for Script Editor #9153
- added doc for ScriptEditor:goto_line
2019-04-16 17:32:10 +02:00
Max Hilbrunner 7a0c086e45
Merge pull request #27762 from rcorre/anim_docs
AnimationNode* docs
2019-04-16 15:47:47 +02:00
Max Hilbrunner 73713b6d3f
Merge pull request #27937 from KoBeWi/sliderdocs
Added some documentation for Slider
2019-04-16 15:31:50 +02:00
Max Hilbrunner 93fcde8388
Merge pull request #27953 from siddharth952/v_scroll_speed
Fixes documentation of v_scroll_speed and wrap_enabled
2019-04-16 15:27:49 +02:00
Rémi Verschelde 3fc1f7dfbe doc: Add note about VisibilityNotifier.is_on_screen after instantiation
Fixes #9430.
2019-04-15 17:10:33 +02:00
Rémi Verschelde 09e94aa087 doc: Sync classref with current source 2019-04-15 14:49:41 +02:00
Siddharth 3f2aac5e0a fixes #25707 documentation of v_scroll_speed
Fixes #25707

Update TextEdit.xml
2019-04-12 20:20:20 +05:30
Michael Alexsander Silva Dias 70499faff8 Document String's 'is_valid_filename()' 2019-04-11 21:48:40 -03:00
Tomasz Chabora de4877e1fc Added some documentation for Slider 2019-04-11 22:17:26 +02:00
Ryan Roden-Corrent 584288a32c
Fill out some of the AnimationNode docs.
The API docs for various animation nodes are pretty empty, yet the
tutorial at
https://docs.godotengine.org/en/latest/tutorials/animation/animation_tree.html
contains some details.

These details should be included in the API docs so looking up a
particular class actually provides some information rather than
requiring the user to hunt for a different tutorial.

This also links the AnimationTree tutorial and demo in the docs.
I've found the TPS demo to be the best resource so far for learning
how to use the AnimationTree. This should be easy to find if someone
looks up the AnimationTree API docs.

Finally, this fixes a param typo in AnimationNodeStateMachine.
2019-04-09 10:49:21 -04:00
Rémi Verschelde 70a009833b
Merge pull request #27561 from KoBeWi/get_frame_doc
Document SceneTree.get_frame() and persistent in add_to_group()
2019-04-09 12:10:48 +02:00
Rémi Verschelde e3b26b0d68
Merge pull request #27591 from toasteater/doc/rng-impl-notes
Improve RandomNumberGenerator docs.
2019-04-09 10:28:44 +02:00
Rémi Verschelde 3cf2bdbd84
Merge pull request #27506 from Chaosus/astar
Added functions to AStar for disable/enable points to effectivly create obstacles
2019-04-08 12:19:51 +02:00
Rémi Verschelde 7f3373d79f
Merge pull request #27452 from Chaosus/direction_to
Added method to retrieve a direction vector from one point to another
2019-04-08 12:00:54 +02:00
Kanabenki 714953b3ac Add optional position argument for add_point in Line2D 2019-04-08 11:29:13 +02:00
Yuri Roubinsky 136fec72d4
Merge pull request #27802 from Chaosus/fix_smoothstep_docs
Fix smooth_step to smoothstep in docs
2019-04-08 11:26:35 +03:00
Chaosus d725e4e6c0 Fix smooth_step to smoothstep docs 2019-04-08 11:24:30 +03:00
Rémi Verschelde 4c10b1da7d
Merge pull request #27698 from YeldhamDev/doc_tilemap_setcell_override
Document TileMap's new 'set_cell' internal override capability
2019-04-08 10:15:14 +02:00
Rémi Verschelde d211aff777
Merge pull request #27231 from Chaosus/smoothstep
Added smoothstep built-in function
2019-04-08 10:03:42 +02:00
Chaosus cc71fb2308 Added functions to AStar for disable/enable points 2019-04-08 09:28:03 +03:00
Chaosus 514a3fb96a Added smoothstep built-in function 2019-04-07 14:11:26 +03:00