Commit Graph
107 Commits
Author SHA1 Message Date
Max Hilbrunner 02f5982938 Merge pull request #10243 from tetrapod00/update-comments
Add UPDATE comments to perishable information
2024-11-18 13:05:07 +01:00
Max Hilbrunner 5fe7cb2922 Merge pull request #10280 from ntlblpm/patch-3
Fix grammar in Matrices and transforms
2024-11-18 13:00:11 +01:00
ntlblpm bcce532773 Update matrices_and_transforms.rst 2024-11-17 18:54:28 -05:00
ntlblpm e766d7972b Update vectors_advanced.rst 2024-11-17 18:30:24 -05:00
tetrapod00 09156f2ee9 Add UPDATE comments to perishable information 2024-11-17 13:50:42 -08:00
Hugo Locurcio 2d9aeb9740 Update Random number generation for Godot 4.2+ (#9822)
- Document `Array.pick_random()` as a shorthand.
- Use global scope random methods as they are all available in global scope now.
- Remove calls to `randomize()` that are not needed for code samples
  to be functional, as the engine now calls `randomize()` on startup
  once automatically.
2024-11-13 13:59:04 +01:00
tetrapod00andaXu-AP 012f0b8a19 Improve interpolation smoothing example
Improves explanation of interpolation ("lerp") smoothing.
Adds a note about framerate-independent version, with off-site links to
full explanations.

Co-Authored-By: aXu-AP <1621768+aXu-AP@users.noreply.github.com>
2024-11-05 11:36:45 -08:00
Kleidon bfdc74009f Add missing word, "is"
The phrase, "This useful for smoothing camera movement..." appears to be missing a word. It should be, "This is useful for smoothing camera movement..." instead.
2024-09-30 18:35:45 -06:00
Kleidon 8033ac1d4d Remove "°" symbol redundancy.
The phrase, "90° degrees", is redundant because the "°" already means "degrees". It should instead be "90 degrees".
2024-09-27 20:42:37 -06:00
A Thousand Ships afb22f1bb7 Fix mixup between translated and translated_local 2024-05-27 21:43:52 +02:00
Dan Brook e1e3e4b157 Change call from empty to is_empty in RNG tutorial
The `empty` method was renamed to `is_empty` somewhere between 3.x and
4.x so the code in the tutorial just needed to be brought up to date.

This was brought to light by someone in the Godot server on the #beginner-2
channel noticing an error when running that code:

  https://discord.com/channels/212250894228652034/762480166248513577/1218050947385786438
2024-03-15 11:30:48 +07:00
Hugo Locurcio 95fb178429 Add support for user-provided comments with Giscus
This allows users to leave comments on pages that don't have
`:allow_comments: False` somewhere in the page's source.
Both manual and class reference pages can receive comments.
Index pages cannot have comments, as discussion should occur on "leaf" pages.

GitHub Discussions is used as a backend on the same repository. This means
that Discussions *must* be enabled on godotengine/godot-docs before this
commit is merged to `master`. Users can choose to use the "Custom" watch
mode if they don't want to get notifications for discussion updates,
but still get notifications for issue and pull request updates.

User comments are intended to be used for the following purposes:

- Add a clarification or correct something in the documentation,
  without having to open a pull request. Contributors are encouraged to
  take a look at discussions from time to time, and see if there's information
  worth incorporating in the pages themselves. Don't forget to reply to
  the comment when doing so :)
- Mention a workaround for a common issue.
- Link to useful third-party resources that are relevant to the current page,
  such as tutorials or add-ons.

User comments should *not* be used for technical support. Other community
platforms should be used for that.

Page-to-discussion matching is done using the `pagename` Sphinx variable,
which is independent of the Godot version and documentation language.
Being independent of the Godot version allows keeping old comments
when the Godot version changes, while also allowing users from `/stable`
and `/4.1` to "see" each other in discussions.

See https://giscus.app for more information.
2024-01-11 17:51:53 +01:00
Yuri Sizov cd92be066d Update references to private class methods across the docs 2023-11-10 16:06:36 +01:00
Hugo Locurcio ca3c2e9e8d Document cryptographically secure random number generation
- Mention which PRNG Godot internally uses.
2023-10-28 02:32:08 +02:00
Paul Joannon a60ab49aac Fix some forgotten lowercase x/y/z 2023-10-21 21:23:01 +02:00
Yuri Roubinski 8377137565 Simplify code for retrieving direction vectors 2023-09-12 11:04:55 +03:00
Max Hilbrunner fa01e18ae3 Merge pull request #7655 from Calinou/fix-backticks 2023-07-18 13:21:11 +02:00
Markus Sauermann 2eafb5c591 Fix wording for scalar multiplication of vectors (#7631)
Also add an example for multiplication with a negative scalar
2023-07-17 17:16:09 +02:00
Hugo Locurcio df904137db Fix incorrect usage of backticks in various pages 2023-07-14 19:31:01 +02:00
Matthew bf3954ef84 Merge pull request #7463 from nanodeath/interpolate_baked
Replace references to interpolate_baked with sample_baked.
2023-06-18 21:52:50 -04:00
Rémi Verschelde c0761647f4 Tweak Vector math page (style, links, more notes)
Also cleanup style issues in the docs image guidelines.
2023-06-12 14:51:16 +02:00
Max 7d4f53ef28 Replace references to interpolate_baked with sample_baked.
It looks like this method was renamed in v4, but not fully updated in beziers_and_curves.rst.
2023-06-03 20:14:23 -07:00
Anthony Good a54fffd60a Access NoiseType on FastNoiseLite class
Fixes 'Identifier "NoiseType" not declared in the current scope' when following example.
2023-06-01 20:44:17 +01:00
yashmistri e6cd08fa79 Fix vector math tutorial 2023-05-20 15:06:56 -04:00
Raul Santos c457ab79ec Update some C# examples
- Rename members that have been renamed in Godot's C# API for 4.0.
- Change `delta` parameter type to `double`.
- Ensure parameters match base declaration.
- Follow our code style more closely.
- Other minor code fixes.
2023-05-18 13:14:05 +02:00
Arpit Srivastava 258a980fb1 Update matrices_and_transforms.rst (#6922)
Remove mention of Spatial matrix being transposed in Godot 3.2. Keep note being unable to edit Node2D's matrix in the Inspector.
2023-03-14 17:57:43 -05:00
Clemens Tolboom 36c87b3400 Make more explicit there are noise_types. (#6802)
* Make more explicit there are noise_types.

It helped me to convert https://docs.godotengine.org/en/stable/classes/class_opensimplexnoise.html to know of types in this example.
2023-02-24 15:09:02 +01:00
Clemens Tolboom 34712bb919 There is no 4D noise in base Noise 2023-02-22 16:00:54 +01:00
Raul SantosandPaul Joannon b319da3f07 Update some C# examples for 4.0 (#6693)
* Update some C# examples

- Rename members that have been renamed in Godot's C# API for 4.0.
- Change `delta` parameter type to `double`.
- Ensure parameters match base declaration.
- Other minor code fixes.

---------

Co-authored-by: Paul Joannon <437025+paulloz@users.noreply.github.com>
2023-02-04 17:03:03 +01:00
Yuri Rubinsky d85afb42f5 Remove incorrect sentence in tutorial of random_number_generation 2022-12-15 15:05:07 +03:00
Max Hilbrunner 99d3d0be12 Renames / fixes for Godot 4 2022-10-17 00:35:07 +02:00
Max Hilbrunner 198393eec7 More Godot 4 rename fixes (#6315)
* Spatial -> 3D, Transform, Quaternion

* File -> FileAccess

* Camera -> Camera3D

* Update references to MeshInstance and MultiMeshInstance

* ImmediateGeometry -> ImmediateMesh, misc renames
2022-10-15 20:54:47 +02:00
Max Hilbrunner b82cd0690d A bunch of renames for Godot 4.0 2022-10-15 18:19:12 +02:00
Max Hilbrunner 024fedb0f3 Kinematic -> Character 2022-10-15 17:55:24 +02:00
Saarg 5f53d1d03d Update references to OpenSimplexNoise to use FastNoiseLite 2022-08-16 17:50:48 -04:00
Aaron Franke 503511ce30 Improve wording in Matrices and Transforms article, update for Godot 4 2022-07-02 11:25:23 -05:00
Aaron Franke da14b8000d Add C# code examples (salvage of VinnNo's PRs) 2022-04-29 08:08:09 -05:00
Arpit Srivastava bee17514c9 Fix missing word in Beziers, curves and paths (#5654) 2022-02-27 19:18:53 +01:00
Rémi Verschelde 9a05eef561 4.0: Convert Sprite references to Sprite2D
Some screenshots will need to be updated so that the scene structures shown
in screenshot fit what the code blocks are referring to.
2021-10-06 14:29:55 +02:00
Aaron Franke 5c7f653347 Optimize PNG and SVG images using oxipng and svgcleaner (#5254) 2021-09-14 17:50:17 +02:00
Selgesel 8f4fbffaf7 Fix cubic interpolation method reference links (#5221) 2021-09-02 12:54:32 +02:00
bd19917ea0 Draft: Remove "simple", "simply", "easy", and "just" from the docs (#4496)
* Various style edits

* Edit out "simple" when possible

Co-authored-by: Max Hilbrunner <mhilbrunner@users.noreply.github.com>
Co-authored-by: Clay John <claynjohn@gmail.com>
2021-07-11 14:38:53 +02:00
soringherghisan 94ff2dde80 Random number generation: Fix comment for randi_range() example (#4998) 2021-06-15 19:09:20 +02:00
Rémi Verschelde 044b6a74f8 Cleanup uses of double spaces between words or after punctuation 2021-06-07 10:44:02 +02:00
BlueStag 4cfe07b696 Fixed "GetNode" inconsistency
See #4794
2021-04-27 17:07:52 +01:00
zacryol 1fc21c57ec Fix description of randfn() in Random number generation (#4759) 2021-03-16 22:05:06 +01:00
Samuel Laferriere 9458eec42b Fix GDScript code sample in Matrices and transforms (#4731) 2021-03-09 02:51:29 +01:00
Hugo Locurcio 54c83c3e4a Add a background to math formulas to make them readable on dark theme (#4288)
This closes #4286.
2020-10-22 20:02:17 +02:00
Nathan Lovato 06353e8635 Fix indentation in vector_math.rst, fill at 80 characters 2020-10-11 11:23:29 -06:00
Nathan Lovato b56d20d3a6 Update tutorials/math/vector_math.rst 2020-10-11 10:25:26 -06:00