Commit Graph

2708 Commits

Author SHA1 Message Date
Hugo Locurcio
2f46f1e7b1
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.
2020-04-17 22:29:05 +02:00
Hugo Locurcio
7f2d602106
Improve the VisibilityEnabler and VisibilityNotifier documentations
This closes #4803.
2020-04-17 22:04:19 +02:00
clayjohn
b50d954cb0 Update many docs with recent rendering changes 2020-04-17 09:47:59 -07:00
Rémi Verschelde
d817be92c2
Merge pull request #37963 from Calinou/doc-dynamicfont-limitations
Document DynamicFont limitations and a possible workaround
2020-04-17 18:43:05 +02:00
Rémi Verschelde
cfda0e3770
Merge pull request #37953 from clayjohn/VULKAN-sky-sun-size
Add light size to Sky Shaders
2020-04-17 18:35:45 +02:00
Rémi Verschelde
364cb2ce92
Merge pull request #37962 from Calinou/doc-image-size-limits
Document image size limits
2020-04-17 18:35:27 +02:00
clayjohn
7cd2ff309c Add light size to Sky Shaders 2020-04-17 09:32:24 -07:00
Hugo Locurcio
46b8e108e2 Document DynamicFont limitations and a possible workaround
This closes #30014.
2020-04-17 16:11:14 +02:00
Hugo Locurcio
5497cec7a1 Document image size limits
This closes #30238.
2020-04-17 16:04:32 +02:00
Hugo Locurcio
cae5260dab Clarify that angles must be specified as radians in the documentation
This closes #36356.
2020-04-17 15:26:07 +02:00
Michael Alexsander
3c261e0dfa Made possible to specify where to dump the contents when loading a ".pck" file 2020-04-16 22:52:26 -03:00
Rémi Verschelde
51d86c9112
Merge pull request #37047 from YeldhamDev/tabcontainer_doc_control_fix
Fix incorrect TabContainer documentation for 'get_tab_control()'
2020-04-16 12:36:42 +02:00
Rémi Verschelde
a29d475e67
Merge pull request #37747 from KoBeWi/cam2center
Improve Camera2D documentation
2020-04-16 12:28:35 +02:00
Rémi Verschelde
2ebfd69196
Merge pull request #37856 from Calinou/doc-basebutton-keep-pressed-outside
Mention `keep_pressed_outside` caveat in the BaseButton documentation
2020-04-16 12:27:28 +02:00
Rémi Verschelde
cd908c3cef
Merge pull request #37832 from Calinou/doc-improve-dictionary
Improve the Dictionary class documentation
2020-04-16 12:27:15 +02:00
Rémi Verschelde
d0a10215ae
Merge pull request #37824 from nekomatata/rigid-body-force-doc
More details in Rigid Body add_force documentation
2020-04-16 12:26:58 +02:00
Hugo Locurcio
52786b54ef
Improve the AudioStreamSample class documentation
This closes #37915.
2020-04-15 23:40:01 +02:00
Rémi Verschelde
59a8af2106
Merge pull request #37316 from nekomatata/physical-bone-settings
Add PhysicalBone rotation, damping, axis lock & can sleep
2020-04-14 18:33:43 +02:00
PouleyKetchoupp
5c1c03f29a Add PhysicalBone rotation, damping, axis lock & can sleep 2020-04-14 11:55:46 +02:00
Hugo Locurcio
e799dc954e
Mention keep_pressed_outside caveat in the BaseButton documentation
This closes #37790.
2020-04-13 21:56:47 +02:00
Rémi Verschelde
06748a2b5f
Merge pull request #37749 from clayjohn/Vulkan-improved-ss
Add vogel filter and settings to soft shadows
2020-04-13 00:39:37 +02:00
Hugo Locurcio
88da90f2bf
Improve the Dictionary class documentation
This closes https://github.com/godotengine/godot-docs/issues/3376.
2020-04-12 22:48:02 +02:00
PouleyKetchoupp
219c5712f0 More details in Rigid Body add_force documentation 2020-04-12 11:27:29 +02:00
clayjohn
621f6f09a8 Add proper quality settings to soft shadows 2020-04-10 23:09:17 -07:00
Zak Grumbles
a8de034f78 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.
2020-04-10 20:35:40 -05:00
Markus Sauermann
19c8b0be45 Clarify Transform scaled Method description. 2020-04-10 22:36:09 +02:00
Yuri Sizov
1ea7295bd2 Improve shortcut formatting in docs 2020-04-10 18:42:11 +03:00
Rémi Verschelde
c52beb6adb
Merge pull request #37297 from dalexeev/doc_file
Improve the `File.store_{8,16,32,64}()` documentation
2020-04-10 13:27:29 +02:00
Rémi Verschelde
1e5f0d402b
Merge pull request #37383 from WARIO-MDMA/godotphysics-rename
Rename "GodotPhysics" to "GodotPhysics{2D,3D}"
2020-04-10 12:39:26 +02:00
Rémi Verschelde
f33bba15b1
Merge pull request #37426 from pycbouh/docs-override-properties
Add more verbosity for property overrides in RST documentation
2020-04-10 12:25:47 +02:00
Rémi Verschelde
feeef52feb
Merge pull request #37482 from zak-grumbles/fix_dict_duplicate_docs
Clarify Dictionary duplicate parameters in docs
2020-04-10 12:14:39 +02:00
Tomasz Chabora
630096fa74 Improve Camera2D documentation 2020-04-10 12:13:26 +02:00
Rémi Verschelde
82e12a0f3e
Merge pull request #37566 from lucaslcode/clarify_autotile
clarify autotile_coord in docs
2020-04-10 12:02:01 +02:00
Rémi Verschelde
95db658672
Merge pull request #37699 from lupoDharkael/committing-typo
Replace is_commiting_action with is_committing_action
2020-04-10 11:47:19 +02:00
Markus Sauermann
3f19b5e0b3 Clarify documentation and indicate that rect_clip_content affects only CanvasItem based nodes.
Resolves #37683
2020-04-09 22:09:05 +02:00
Bastiaan Olij
afc8c6391c Renaming all ARVR nodes to XR 2020-04-09 15:33:01 +10:00
WARIO-MDMA
6d5c6ffbe0 Rename "GodotPhysics" to "GodotPhysics{2D,3D}" 2020-04-09 03:13:33 +10:00
lupoDharkael
406c2790e3 Replace is_commiting_action with is_committing_action 2020-04-08 18:52:04 +02:00
Hugo Locurcio
ea668a5db8 Improve the CameraServer and CameraFeed class documentations
This closes https://github.com/godotengine/godot-docs/issues/3255.
2020-04-08 14:26:21 +02:00
Rémi Verschelde
1222541c95 i18n: Sync translate template for class reference
Adds initial fr.po translation for initialization on Weblate.
2020-04-07 09:57:51 +02:00
Rémi Verschelde
2267877ee6
Merge pull request #37589 from Nannaquin/updatecolordoc
Add reference of Color8 function to Color class documentation
2020-04-07 09:16:51 +02:00
Rémi Verschelde
6b07c72d76
Merge pull request #37556 from KoBeWi/kill_get_index
Remove Node.get_position_in_parent()
2020-04-06 09:44:38 +02:00
Tomasz Chabora
c1023157eb Remove Node.get_position_in_parent() 2020-04-06 01:19:20 +02:00
Nannaquin
06aeff3044 Add reference of Color8 function to Color class documentation 2020-04-05 11:34:47 -04:00
Rémi Verschelde
9abb415d92
Merge pull request #37391 from dreamsComeTrue/embedded-windows-mode
Expose 'Embedded Windows Mode' as Editor and Project Settings
2020-04-04 07:58:53 +02:00
lucaslcode
cbe73766e3
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.
2020-04-03 23:40:31 +01:00
Dominik 'dreamsComeTrue' Jasiński
7af84d7213 Expose 'Embedded Windows Mode' as Editor and Project Settings 2020-04-03 21:15:22 +02:00
Michael Alexsander
a9e43ac73c Re-expose a simplified version of the stretch properties in SubViewport 2020-04-03 14:11:22 -03:00
Rémi Verschelde
59d44ee872
Merge pull request #37505 from YeldhamDev/viewcont_rename
Rename ViewportContainer to SubViewportContainer
2020-04-03 15:53:35 +02:00
Rémi Verschelde
d9a560d783 doc: Sync classref with current source 2020-04-03 10:11:23 +02:00
Zak Grumbles
469b7c948f Clarify Dictionary duplicate params godotengine#37162
* Added additional clarification for the function of the 'deep'
parameter in the Dictionary's `duplicate` method.
2020-04-02 10:02:02 -05:00
Michael Alexsander
0c6851ae53 Rename ViewportContainer to SubViewportContainer 2020-04-01 16:11:44 -03:00
Rémi Verschelde
a30bfe5176
Merge pull request #35765 from clayjohn/master
Add a method to retrieve active material from MeshInstance
2020-03-31 18:03:11 +02:00
Rémi Verschelde
3a996faeed
Merge pull request #37442 from YeldhamDev/subviewport_register
Register SubViewport class
2020-03-31 16:29:41 +02:00
Rémi Verschelde
e5033d3952 doc: Sync classref with DisplayServer/Window changes 2020-03-31 11:56:58 +02:00
Zak Grumbles
d09644dff3
Clarify docs for Thread.start() godotengine#36032
* Updated docs for Thread.start() to specify that the method argument
must accept one parameter.
2020-03-30 21:53:39 -05:00
clayjohn
3362e81674 Add a method to retrieve active material from MeshInstance 2020-03-30 16:53:07 -07:00
Rémi Verschelde
dfed5efea3
Merge pull request #37445 from nekomatata/hook-makerst-fix
Fixed errors in makerst pre-commit hook
2020-03-31 00:17:51 +02:00
PouleyKetchoupp
619354fb2c Fixed errors in makerst pre-commit hook 2020-03-31 00:02:11 +02:00
Michael Alexsander
46a6751302 Register SubViewport class 2020-03-30 16:43:55 -03:00
Rémi Verschelde
f3c74afd28
Merge pull request #37436 from akien-mga/doc-node-renames
doc: Update classref with node renames
2020-03-30 20:32:11 +02:00
Rémi Verschelde
eaaee63b62 doc: Update classref with node renames
A few extra renames for classes which were missed in last week's PRs.
2020-03-30 18:23:02 +02:00
Yuri Sizov
38821dc6d7 Add more verbosity for property overrides in RST documentation 2020-03-30 14:18:43 +03:00
Rémi Verschelde
cd4e46ee65 SCons: Format buildsystem files with psf/black
Configured for a max line length of 120 characters.

psf/black is very opinionated and purposely doesn't leave much room for
configuration. The output is mostly OK so that should be fine for us,
but some things worth noting:

- Manually wrapped strings will be reflowed, so by using a line length
  of 120 for the sake of preserving readability for our long command
  calls, it also means that some manually wrapped strings are back on
  the same line and should be manually merged again.

- Code generators using string concatenation extensively look awful,
  since black puts each operand on a single line. We need to refactor
  these generators to use more pythonic string formatting, for which
  many options are available (`%`, `format` or f-strings).

- CI checks and a pre-commit hook will be added to ensure that future
  buildsystem changes are well-formatted.
2020-03-30 09:05:53 +02:00
Rémi Verschelde
a2da99f40c
Merge pull request #37259 from Calinou/doc-editorfeatureprofile
Document the EditorFeatureProfile class
2020-03-26 09:29:42 +01:00
Danil Alexeev
97e20b2f30 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.
2020-03-25 18:02:04 +03:00
Rémi Verschelde
3d2dd79ecd SCons: Drop support for Python 2
We now require SCons 3.0+ (first version with Python 3 support),
and we set min required Python 3 version to 3.5 (3.4 and earlier are
EOL).
2020-03-25 15:25:37 +01:00
Hugo Locurcio
7ab279403d
Document the EditorFeatureProfile class 2020-03-23 21:54:26 +01:00
Rémi Verschelde
20edf69f96
Merge pull request #33508 from nekomatata/object-has-signal
Added has_signal method for Object
2020-03-23 16:16:25 +01:00
PouleyKetchoupp
258d91f883 Added has_signal method for Object 2020-03-23 11:27:17 +01:00
Rémi Verschelde
ed9a0d0484
Merge pull request #37179 from clayjohn/VULKAN-sky-shader
Implement Sky Shaders
2020-03-22 20:03:35 +01:00
clayjohn
61a74739ca Working sky shader implementation 2020-03-21 20:43:44 -07:00
Rémi Verschelde
36baa0247e i18n: Generate translation template for class reference 2020-03-20 12:58:38 +01:00
Rémi Verschelde
87d23bf85a i18n: Add Makefile to extract classref strings
Change extract script `path` argument to support specifying multiple
paths, like `makerst.py`. This prevents parsing invalid XML files while
scanning the whole repository.
2020-03-20 12:56:36 +01:00
Rémi Verschelde
aca1971a12 i18n: Add header strings to translation catalog 2020-03-20 12:35:22 +01:00
Rémi Verschelde
63f77efdc6
Merge pull request #37114 from ThakeeNathees/translation-catalog-maker
Add script to generate translation catalog for the class reference
2020-03-20 09:03:31 +01:00
Rémi Verschelde
3b1c04550f
Merge pull request #37133 from theoway/DocEdit
Doc edit at InputEventMouseMotion
2020-03-19 10:05:04 +01:00
Rémi Verschelde
256ac9a51d
Merge pull request #37039 from Chaosus/astar2d_cost
Implements estimate/compute_cost for AStar2D
2020-03-19 08:19:59 +01:00
Thakee Nathees
e817792c0a Add script to generate translation catalog for the class reference
Fixes #37109.
2020-03-19 03:32:47 +05:30
Rémi Verschelde
87118ac39e
Merge pull request #37113 from KoBeWi/to_enable_or_not_to_enable
Fix visibility enabler flag toggling
2020-03-18 20:27:30 +01:00
Umang Kalra
052424c76d Doc edit at InputEventMouseMotion
Doc edit
2020-03-19 00:04:13 +05:30
Rémi Verschelde
a2d3ba3372 doc: Sync classref with current source
Fix wrong binding after #37111.
2020-03-18 09:14:57 +01:00
Tomasz Chabora
2ccd1a7805 Fix visibility enabler flag toggling 2020-03-17 17:46:18 +01:00
Rémi Verschelde
0159787864
Merge pull request #37111 from RandomShaper/imvu/unexpose_include_drive
Remove meaningless parameter from bindings
2020-03-17 14:52:43 +01:00
Pedro J. Estébanez
a69e88e467 Remove meaningless parameter from bindings 2020-03-17 14:32:03 +01:00
Rémi Verschelde
cb282c6ef0 Style: Set clang-format Standard to Cpp11
For us, it practically only changes the fact that `A<A<int>>` is now
used instead of the C++03 compatible `A<A<int> >`.

Note: clang-format 10+ changed the `Standard` arguments to fully
specified `c++11`, `c++14`, etc. versions, but we can't use `c++17`
now if we want to preserve compatibility with clang-format 8 and 9.
`Cpp11` is still supported as deprecated alias for `Latest`.
2020-03-17 07:36:24 +01:00
Rémi Verschelde
f9decec1bc
Merge pull request #36491 from AndreaCatania/edit_node_anim_state_mac
Added new method to edit an already added node to anim state machine
2020-03-16 19:29:38 +01:00
Andrea Catania
422926cfc6 Added new method to replace an already added node to the animation state machine 2020-03-16 17:42:29 +01:00
Yuri Roubinsky
bad77bcb52 Implements estimate/compute_cost for AStar2D 2020-03-14 18:01:06 +03:00
Michael Alexsander
8f925b1970 Fix incorrect TabContainer documentation for 'get_tab_control()' 2020-03-14 10:53:21 -03:00
Rémi Verschelde
f65781fe7f doc: Sync classref with current source 2020-03-13 17:16:44 +01:00
Tomasz Chabora
e103f21a40 Add LOTS of missing docs 2020-03-13 16:35:03 +01:00
Hugo Locurcio
30961c60ab Improve the Input.set_use_accumulated_input() documentation 2020-03-12 14:10:10 +01:00
luz.paz
7bf6e5f773 Fix various typos
Found via `codespell`
2020-03-11 13:59:18 -04:00
Rémi Verschelde
478337c412
Merge pull request #36751 from Faless/debugger/threads_and_profilers
ScriptDebugger refactor, threading, profilers.
2020-03-09 19:08:07 +01:00
Rémi Verschelde
159ed359f0
Merge pull request #36286 from Calinou/doc-sprite3d-performance-caveats
Document known performance issues with Sprite3D
2020-03-09 11:42:27 +01:00
Rémi Verschelde
788765709d DocData: Fix serialization of Variant default values
Co-authored-by: Bojidar Marinov <bojidar.marinov.bg@gmail.com>
2020-03-09 10:52:44 +01:00
Rémi Verschelde
471271b727 doc: Sync classref with current source 2020-03-09 10:13:45 +01:00
Hugo Locurcio
92fa3e076f Document known performance issues with Sprite3D
See https://github.com/godotengine/godot/issues/20855.
2020-03-09 10:13:09 +01:00
Fabio Alessandrelli
b8ddaf9c33 Refactor ScriptDebugger.
EngineDebugger is the new interface to access the debugger.
It tries to be as agnostic as possible on the data that various
subsystems can expose.

It allows 2 types of interactions:

- Profilers:
  A subsystem can register a profiler, assigning it a unique name.
  That name can be used to activate the profiler or add data to it.
  The registered profiler can be composed of up to 3 functions:
    - Toggle: called when the profiler is activated/deactivated.
    - Add: called whenever data is added to the debugger
      (via `EngineDebugger::profiler_add_frame_data`)
    - Tick: called every frame (during idle), receives frame times.

- Captures: (Only relevant in remote debugger for now)
  A subsystem can register a capture, assigning it a unique name.
  When receiving a message, the remote debugger will check if it starts
  with `[prefix]:` and call the associated capture with name `prefix`.

Port MultiplayerAPI, Servers, Scripts, Visual, Performance to the new
profiler system.

Port SceneDebugger and RemoteDebugger to the new capture system.
The LocalDebugger also uses the new profiler system for scripts
profiling.
2020-03-08 12:36:39 +01:00