c0d0bdc160
Clarify bounce and reflect docs and update param names
2024-04-10 14:07:08 +02:00
2ae6343533
Merge pull request #90310 from mhilbrunner/OutdatedDemos
...
Update links to outdated asset library demos
2024-04-08 11:21:38 +02:00
c83718624f
Update links to outdated asset library demos
...
Update links to outdated asset library demos
Co-authored-by: Max Hilbrunner <m.hilbrunner@gmail.com>
2024-04-07 16:59:43 +02:00
47a8033698
[Doc] Clarify the behavior of `Vector2/3.cross` and mention parallel vectors
2024-04-06 19:10:41 +02:00
c54e09a5a3
Overhaul some "uncommon" wording in class reference
2024-03-01 15:32:38 +01:00
9509a9e8dd
Merge pull request #83691 from theraot/slidedocs
...
Expanded documentation for vector slide and project
2024-02-26 10:48:37 +01:00
f781571d07
Add keywords to improve search in the class reference
2024-02-22 16:16:49 +01:00
8777c05817
Expanded documentation for vector slide and project
2023-10-23 06:16:07 -05:00
a8c62c5928
Clarify docs for operators performing `xform_inv`
2023-10-16 21:52:02 +02:00
cc0eebd9d8
Validate `code` tags for class and member references
...
This commit also adds means to manually disable warnings
in `code` tags where it's a false positive with the new
`skip-lint` attribute.
Warnings are now enabled on CI to prevent future errors.
2023-10-03 15:48:31 +02:00
81064cc239
Doctool: Remove version attribute from XML header
...
We don't use that info for anything, and it generates unnecessary diffs
every time we bump the minor version (and CI failures if we forget to
sync some files from opt-in modules (mono, text_server_fb).
2023-07-06 10:08:21 +02:00
346f1ab86b
Bump version to 4.2-dev
...
Keep on waitin'
2023-07-05 22:07:03 +02:00
5e3c625e24
Add more info on the nature of NAN
2023-05-30 15:38:10 +02:00
04562662d3
Overhaul the top sections of the class reference (Core classes)
2023-05-19 07:04:48 +02:00
6cd8e706fa
Unify descriptions of vector methods
...
* is_equal_approx
* normalize
* length_squared
* posmod
* posmodv
2023-04-14 23:31:33 +08:00
ff97c481d3
Fix typos and inconsistencies in classref
...
* Typo fixes.
* Navigation agent's `velocity_computed` signal is not emitted by
`set_velocity`, but at the end of that frame if `set_velocity` is
called.
* Simplify link in navigation agent's `avoidance_enabled` description.
* Unify `navigation_layers` description across `NavigationAgent{2,3}D`.
* Unify `is_normalized()` description across `Vector2`, `Vector3`, and
`Vector4`
2023-03-27 22:26:56 +08:00
cca01afd82
Improve Vector2 / 3 / 4 normalized() classref.
...
Mention that the results will be unreliable with initial vector near zero.
2023-03-16 11:20:30 +00:00
57d4272984
Fix typos and inconsistencies in classref
2023-03-16 14:10:20 +08:00
1c1524a651
Bump version to 4.1-dev
...
Can't stop, won't stop, they said, huh?
2023-03-01 01:44:37 +01:00
063637ec77
Rename `float=64` SCons option to `precision=double`
...
This avoids confusion with the old `bits=64` option and building
for 64-bit CPUs in general.
2022-12-10 16:43:45 +01:00
91e9ad92f5
Refactor baking code for Curve2D
...
The main change is to caculate tangent directly from bezier curve, without going
through discretized polyline, avoiding pitfalls of discretization. A similar refacor
had been applied to Curve3D.
The test cases for Curve2D is updated, comparing floating point with is_equal_approxmiate()
instead of `==`, in order to avoid float precision problem.
2022-12-05 21:22:05 +08:00
4a8b725bc9
Merge pull request #68386 from MewPurPur/snappedi-snappedf
...
Implement snappedi, snappedf, and Vector[2/3/4]i.snapped
2022-11-24 18:54:49 +01:00
f9fa182abc
Refactor Curve3D::_bake() method
...
The main change is to caculate tangent directly from bezier curve, without going
through discretized polyline, avoiding pitfalls of discretization.
Other changes are:
1. Add an bezier_derivative() method for Vector3, Vector2, and Math;
2. Add an tesselate_even_length() method to Curve3D, which tesselate bezier curve to even length segments adaptively;
3. Cache the tangent vectors in baked_tangent_vector_cache;
2022-11-24 10:52:06 +08:00
e26f0906f2
Implement snappedi, snappedf, and Vector[2/3/4]i.snapped
2022-11-19 06:18:55 +01:00
edfb504efe
Document that Vector classes are 32-bit
2022-11-12 15:51:11 -05:00
5da515773d
Add `is_finite` method for checking built-in types
2022-10-08 13:25:08 +08:00
15d057c521
Add `is_zero_approx` methods to `Vector2`, `3`, and `4`
2022-09-02 00:29:50 -04:00
59e11934d8
Rename `str2var` to `str_to_var` and similar
...
Affects the Math class, a good chunk of the audio code, and a lot of other miscellaneous classes, too.
- `var2str` -> `var_to_str`
- `str2var` -> `str_to_var`
- `bytes2var` -> `bytes_to_var`
- `bytes2var_with_objects` -> `bytes_to_var_with_objects`
- `var2bytes` -> `var_to_bytes`
- `var2bytes_with_objects` -> `var_to_bytes_with_objects`
- `linear2db` -> `linear_to_db`
- `db2linear` -> `db_to_linear`
- `deg2rad` -> `deg_to_rad`
- `rad2deg` -> `rad_to_deg`
- `dict2inst` -> `dict_to_inst`
- `inst2dict` -> `inst_to_dict`
2022-08-26 14:58:22 +02:00
dded7c72c1
Make `cubic_interpolate()` consider key time in animation
2022-08-19 14:48:37 +09:00
5361585832
[doc] Use "param" instead of "code" to refer to parameters
...
Co-authored-by: Yuri Sizov <11782833+YuriSizov@users.noreply.github.com>
2022-08-09 10:09:07 -04:00
c5d7115038
Rename the argument tag to param in XML documentation
2022-08-08 22:34:31 +03:00
99ce0df3b1
Refactor bezier interpolation functions
2022-06-27 19:42:43 +02:00
e7a58a7eb6
Core: Rename math 'phi' arguments to 'angle'
2022-05-05 14:17:39 +02:00
32f2c47356
Remove generating of null comparison operators from documentation
2022-03-14 22:35:23 +03:00
b68dd2e189
Add an XML schema for documentation
...
This makes it easier to spot syntax errors when editing the
class reference. The schema is referenced locally so validation
can still work offline.
Each class XML's schema conformance is also checked on GitHub Actions.
2022-02-15 00:03:31 +01:00
d54586a8e6
Explain what 2D cross product means
2022-01-11 11:48:45 +08:00
50225a0f32
i18n: Sync classref translations with current 3.x codebase
...
(cherry picked from commit defb801120
2022-01-07 13:39:06 +01:00
064036d786
Allow Vector2/3 slerp values to have any length
2022-01-06 11:12:59 -08:00
3d08becd06
Unify similar method descriptions
...
Notably:
* `Packed*Array.size()` and `Array.size()`.
* Shared methods of `Transform2D` and `Transform3D`.
* Shared methods of `Vector2`, `Vector3`, and `Vector2i`.
This reduces the Deja Vu when translating the class reference :)
2022-01-06 19:50:57 +08:00
937fb63a23
Merge pull request #53020 from Lertsenem/doc/fix_vector2_reflect
...
Fix error in Vector2.reflect() description
2022-01-02 14:28:46 +01:00
78fd56a596
Merge pull request #55500 from KoBeWi/just_doc_things
...
Misc improvements to various docs
2021-12-06 15:34:21 +01:00
24f57886d0
Expose max_axis_index and max_axis_index for Vector2(i)
...
Some cleanup with Vector3(i)'s methods so that it is consistent with Vector2, for example it returns enums internally (GDScript still gets ints).
2021-12-02 23:45:41 -06:00
a367378f9e
Rename Vector parameters to be consistent
...
Renames parameters that were named differently across different
scripting languages or their documentation to use the same name
everywhere.
2021-12-01 21:14:46 +01:00
244c5ecc64
Misc improvements to various docs
2021-11-30 23:53:58 +01:00
272b3c3728
Enable sorting of operator methods in class documentation.
2021-11-29 14:51:44 +00:00
471e7cbfc7
Merge pull request #54581 from aaronfranke/operator-docs
2021-11-16 14:10:09 +01:00
6c1bd4d227
Replace Godot docs URL with `$DOCS_URL` in XML class reference
2021-11-15 13:02:21 +01:00
606cfa9a47
Fix Vector2.angle_to_point() being reversed
2021-11-09 16:59:58 +01:00
813466b3c8
Add documentation to operators for math types
...
Co-authored-by: Raul Santos <raulsntos@gmail.com>
2021-11-04 14:44:55 -05:00
6772ebcea0
Move the docs for constructors and operators out of methods section
2021-10-29 12:34:57 -05:00
clayjohn
Rémi Verschelde
skyace65
A Thousand Ships
Micky
Hugo Locurcio
Theraot
kleonc
Yuri Sizov
Ninni Pipping
VolTer
Haoyu Qiu
lawnjelly
Yaohua Xiong
Jonathan Nicholl
Silc Renew
Andy Maloney
Hendrik Brucker
Yuri Roubinsky
Aaron Franke
Max Hilbrunner
Raul Santos
kobewi
Marcel Admiraal
Rémi Verschelde