Commit Graph

6930 Commits

Author SHA1 Message Date
Max Hilbrunner
69e5ad7f09
Merge pull request #67098 from Calinou/doc-light-no-scale
Document (Omni/Spot)Light3D ignoring Node3D's `scale` property
2022-10-25 14:31:07 +02:00
Max Hilbrunner
035b5b76a0
Merge pull request #67833 from Calinou/doc-animation
Document the Animation class
2022-10-25 14:29:12 +02:00
Max Hilbrunner
1425b4ee09
Merge pull request #67841 from Calinou/doc-basematerial3d
Document the BaseMaterial3D class
2022-10-25 14:23:36 +02:00
Max Hilbrunner
d49ef5fea8
Merge pull request #67768 from Calinou/doc-debanding
Document debanding only affecting 3D rendering by default
2022-10-25 14:15:47 +02:00
Hugo Locurcio
d5ded67458
Document the CanvasTexture class 2022-10-24 21:57:58 +02:00
Hugo Locurcio
185695dda9
Document (Omni/Spot)Light3D ignoring Node3D's scale property 2022-10-24 18:49:15 +02:00
Hugo Locurcio
fb742cb16f
Document the BaseMaterial3D class
This makes the class 100% documented again.
2022-10-24 18:40:01 +02:00
Hugo Locurcio
9e7ec78c6b
Document the Animation class 2022-10-24 17:06:32 +02:00
Hugo Locurcio
8777f38089
Document debanding only affecting 3D rendering by default 2022-10-24 16:18:59 +02:00
Fredia Huya-Kouadio
8b37511364
Merge pull request #67755 from m4gr3d/input_event_screen_touch_double_tap_main
Add double_tap attribute to InputEventScreenTouch
2022-10-23 08:11:49 -07:00
Max Hilbrunner
09f4ec7988
Merge pull request #67677 from rsubtil/doc_popupmenu
Document PopupMenu "id_pressed" behavior
2022-10-23 15:00:06 +02:00
Max Hilbrunner
0b627c4133
Merge pull request #67718 from Mickeon/doc-peeves-the-constant-burden
Tweak `@GlobalScope` constants documentation overall
2022-10-22 21:30:56 +02:00
Fredia Huya-Kouadio
13e4770b97 Add double_tap attribute to InputEventScreenTouch
This provides parity with the `InputEventMouseButton` allowing for proper conversion between the two events.
2022-10-22 07:30:46 -07:00
smix8
79d0cde64b Fix class doc for TileMap navigation visibility mode
fix small copy&paste error
2022-10-22 02:46:16 +02:00
Max Hilbrunner
efd2a8ac23
Merge pull request #67725 from TokageItLab/add-tuts-link-retarget
Add a tutorial link to `BoneMap` and `SkeletonProfile`
2022-10-22 01:06:08 +02:00
Silc Renew
e7d0a2198b Add a tutorial link to Retarget Classes 2022-10-22 02:56:16 +09:00
Micky
965f6e40ef Tweak @GlobalScope constants documentation overall
General:
- Replace most type names with strong references (such as "integer" to "[int]");
- Made the writing style closer to how the rest of the documentation is formatted.
- Use uppercase Inspector when referring to the Inspector dock.
- Describe missing MethodFlags, Variant.Type constants.

Key:
- Add " key." to the `KEY_0` to `KEY_9` constants;
- Reword some MouseButton constants;
	- In a programming context, it's kind of odd hearing about the plural of "mouse".

Error:
- Reword OK constant to flow better, use `printerr()` over `print()`;
- Describe where `ERR_HELP` is used by the engine;
- Point to the Github Issues Page in ERR_BUG.

PropertyHint:
- Mention that PROPERTY_HINT_IMAGE_COMPRESS_LOSSY and PROPERTY_HINT_IMAGE_COMPRESS_LOSSLESS are unused;
- Mention that PROPERTY_HINT_PASSWORD allows a placeholder string.
- Describe PROPERTY_HINT_OBJECT_TOO_BIG, PROPERTY_HINT_MAX.

PropertyUsageFlags:
- Describe PROPERTY_USAGE_HIGH_END_GFX, PROPERTY_USAGE_ARRAY.
2022-10-21 19:52:09 +02:00
Max Hilbrunner
f77f7d4ba9
Merge pull request #67072 from Mickeon/uh-oh-stinky
Rewrite most of Resource's documentation
2022-10-21 18:42:44 +02:00
Max Hilbrunner
5b84583b95
Merge pull request #67254 from TechnoPorg/doc-projection-class
Fully document the Projection class.
2022-10-21 18:38:32 +02:00
Max Hilbrunner
05e68196c3
Merge pull request #67648 from Calinou/doc-cylindershape3d-bugs
Document known issues with CylinderShape3D
2022-10-21 18:35:06 +02:00
Max Hilbrunner
13138b307b
Merge pull request #67656 from MewPurPur/instance🧹
Fix minor mistakes throughout the documentation
2022-10-21 18:19:32 +02:00
Max Hilbrunner
d145c9b1a7
Merge pull request #67684 from patchfx/fix-typo-in-draw-rect-region
Fix tp_canvas_item typo in _draw_rect_region
2022-10-21 18:13:45 +02:00
Max Hilbrunner
5cefc07d90
Merge pull request #67444 from nonunknown/array_pick_random
Add ability to pick random value from array
2022-10-21 16:25:52 +02:00
VolTer
05a9637d5d Fix small mistakes throughout much of the documentation 2022-10-21 00:20:59 +02:00
Clay John
72b845b287
Merge pull request #67506 from squashiv/master
Expose Shape2D::get_rect to scripting
2022-10-20 13:26:40 -07:00
Richard Patching
5de65bb2d7 Fix tp_canvas_item typo in _draw_rect_region 2022-10-20 20:04:45 +01:00
Nonunknown
9f4dbf415d add ability to pick random value from array 2022-10-20 08:39:47 -03:00
squash
247a93845d Expose Shape2D::get_rect to scripting 2022-10-20 11:26:49 +03:00
TechnoPorg
678eec7530 Fully document the Projection class.
Projection is a 4x4 matrix that applies a projective transformation.
2022-10-19 18:30:37 -06:00
Hugo Locurcio
e7d72eedc6
Document known issues with CylinderShape3D 2022-10-19 23:43:18 +02:00
Clay John
f63b2a9c05
Merge pull request #66950 from Calinou/doc-surfacetool-generate-normals-smooth-groups
Document `SurfaceTool.generate_normals()` interaction with smooth groups
2022-10-19 13:51:58 -07:00
Max Hilbrunner
d148613bb1
Merge pull request #66279 from aaronfranke/control-min-size
Revert `custom_minimum_size` type back to `Vector2` instead of `Vector2i`
2022-10-19 22:40:52 +02:00
Max Hilbrunner
f066f2c0de
Merge pull request #66940 from aaronfranke/doc-get-tr-aabb
Remove the global space `get_transformed_aabb` helper method
2022-10-19 22:40:02 +02:00
Max Hilbrunner
23dec5c54f
Merge pull request #65613 from Commander-Firestrike/audiostreamgeneratorplayback_docs_fix_0
Update AudioStreamGeneratorPlayback.xml
2022-10-19 22:15:23 +02:00
Max Hilbrunner
847cef99bf
Merge pull request #66134 from MewPurPur/fix-outdated-editor-settings
Improve some Text Editor editor settings
2022-10-19 22:11:01 +02:00
Max Hilbrunner
c660cc4adc
Merge pull request #66410 from RedMser/patch-1
Fix `Control.get_global_rect` documentation
2022-10-19 22:06:43 +02:00
Max Hilbrunner
ee772f109f
Merge pull request #66326 from zak-grumbles/editor_script_reference_docs
Add note regarding RefCounted to EditorScript docs
2022-10-19 22:02:46 +02:00
Max Hilbrunner
e6311c8e5e
Merge pull request #67001 from KoBeWi/🎲
Fill random docs
2022-10-19 21:58:03 +02:00
Max Hilbrunner
431012e148
Merge pull request #67208 from Mickeon/doc-peeves-the-peevening
Tweak `@GlobalScope` functions documentation overall
2022-10-19 21:12:38 +02:00
Ev1lbl0w
b8aa5ebfeb
Document PopupMenu id behavior 2022-10-19 11:46:28 +01:00
Micky
34804a68e8 Rewrite most of Resource's documentation 2022-10-18 21:03:29 +02:00
Micky
474edca100 Tweak @GlobalScope functions documentation overall
Generally:
- Made use of [param] more frequently;
- Link to other classes' documentation more often;
- Improve and add more examples;
- Ensure that multiple comments of an codeblock example are spaced out equally for better readability;
- Made the writing style closer to how the rest of the documentation is formatted;
- Ensure these are called "functions", not "methods".
- Fixed a few typos.
- Touched up a few cases of zero being written as "zero" or "0" where "0" or "0.0" would be more appropriate.
- Removed mentions of "(real)". In 3.x, this was associated with floats, because TYPE_FLOAT was called TYPE_REAL.

More specifically:
- Every type-safe version of a function (such as `ceili` has a consistent final note ("A type-safe version of [method ceil], returning a [int]").
- Added more details to `randomize`, `seed`.
- Corrected `floori()`'s description. It's not the same as `int()`. This was not correct behavior and has been fixed.
2022-10-18 15:36:18 +02:00
Aaron Franke
9ebd8c5bb5
Remove the global space get_transformed_aabb helper method 2022-10-18 07:30:31 -05:00
Rémi Verschelde
6fb3a14263 Merge pull request #67458 from Sauermann/fix-expose-viewport-get-screen-transform
Expose Viewport::get_screen_transform to GDScript
2022-10-17 17:31:01 +02:00
Rémi Verschelde
235c5c60f8 Merge pull request #67322 from ztc0611/add-ios-ui-options
Add iOS UI Options
2022-10-17 17:30:55 +02:00
Dominus Iniquitatis
0743e33407
Fix missing parenthesis in the documentation 2022-10-16 15:36:32 +03:00
Markus Sauermann
39e49a8bdd Expose Viewport::get_screen_transform to GDScript 2022-10-15 23:37:59 +02:00
Rémi Verschelde
dc4b616596 Merge pull request #63332 from KoBeWi/static_images_aka_photos
Make some Image methods static
2022-10-15 12:56:57 +02:00
Rémi Verschelde
2942951a29 Merge pull request #67403 from bitbrain/rename-to-position
Rename `pos` to `index` on Node
2022-10-15 12:56:48 +02:00
Miguel Gonzalez Sanchez
a97a00bf02
Rename pos -> index on Node 2022-10-14 19:56:34 +01:00