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
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
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
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
a69541da4c
Implement Animation Compression
...
Roughly based on https://github.com/godotengine/godot-proposals/issues/3375 (used format is slightly different).
* Implement bitwidth based animation compression (see animation.h for format).
* Can compress imported animations up to 10 times.
* Compression format opens the door to streaming.
* Works transparently (happens all inside animation.h)
2021-10-21 18:27:34 -03:00
862994a8ef
doc: Update links to latest documentation after content reorganization
2021-10-06 13:48:48 +02:00
220b69ab56
Merge pull request #52450 from aaronfranke/they-came-from-scale
...
Replace Vector3.to_diagonal_matrix with Basis.from_scale
2021-09-17 19:38:36 +02:00
455e142d37
Allow comparing equality between builtin types and null
2021-09-17 12:33:52 -03:00
bf0213470c
Replace Vector3.to_diagonal_matrix with Basis.from_scale
2021-09-17 10:30:30 -05:00
7adf4cc9b5
doc: Use self-closing tags for `return` and `argument`
...
For the time being we don't support writing a description for those, preferring
having all details in the method's description.
Using self-closing tags saves half the lines, and prevents contributors from
thinking that they should write the argument or return documentation there.
2021-07-30 15:29:52 +02:00
b1d15c51bc
Implement native extension system
...
* Deprecates GDNative in favor of a simpler, lower level interface.
* New extension system allows registering core engine classes.
* Simple header interface in gdnative_interace.h
2021-06-25 17:32:45 -03:00
0ff4095b36
Better format arguments in variant parser
2021-06-18 00:06:40 -03:00
8acd13a456
Rename Quat to Quaternion
2021-06-04 18:14:32 +01:00
5d9cab3aeb
Merge pull request #38430 from aaronfranke/transform3d
2021-06-03 23:07:21 +02:00
2e13e3ed4a
Allow clamping vectors and colors
2021-06-03 12:05:20 -04:00
94bc0bd919
Rename Vector2 clamped to limit_length and add limit_length to Vector3
2021-06-03 12:04:57 -04:00
0ac4051c00
Update documentation for Transform3D
2021-06-03 07:30:01 -04:00
d13cfc8d62
Docs: Minor argument names fix
2021-04-23 15:46:51 +02:00
4ca1e73ff9
doc: Sync classref with current source
...
And move GLTF docs to its module folder.
2021-03-18 16:37:43 +01:00
2c71ff1119
Added signed_angle_to for Vector3
2021-02-16 05:07:33 -05:00
215d18814e
doc: Sync classref with current source
2021-01-04 14:33:44 +01:00
b743a2ef3c
Rename Math::stepify to snapped
2020-12-28 13:01:30 +00:00
fa0683ed30
Added a note describing a code behind Vector2/3.direction_to
2020-12-15 22:36:26 +03:00
5465e604bb
Improve argument names for core types
2020-12-07 05:01:33 -05:00
64e893deac
doc: Sync classref to add operators after #43419
2020-11-10 15:00:50 +01:00
0f249f5c0a
Variant: Sync docs with new constructors, fixups after #43403
...
Change DocData comparators for MethodDoc and ArgumentDoc to get a better
ordering of constructors.
2020-11-09 23:39:53 +01:00
424cd00f8b
doc: Sync classref with current source + fixup some bindings
...
Includes various changes triggered by the refactoring of method bindings.
2020-11-04 15:38:26 +01:00
439be614f4
Link to demos from within the class reference
2020-10-01 23:57:21 -04:00
aa7ce12bee
Surrounds boolean false with code tag
2020-09-25 00:00:22 +08:00
c4903a603b
Add link titles for all links in the class reference
...
This makes them display in a nicer way in the editor help.
(The title will display instead of the full URL.)
2020-08-31 14:22:07 +02:00
83e324d670
Update core documentation to match recent C# changes
...
Also a few minor API changes like adding AABB.abs()
Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
2020-07-21 14:44:53 -04:00
1554fce23c
Document `Vector2.dot()` and `Vector3.dot()` more extensively
...
These methods are commonly used in games. It's time to make the
documentation more explicit about them :)
2020-07-20 14:20:17 +02:00
227f12478d
Document how Vector2, Vector3 and Color behave in a boolean context
...
See #39731 .
2020-06-21 17:16:10 +02:00
975ed93794
[DOCS] minor description changes
2020-05-09 18:56:14 -07:00
540156b387
[Core] Rename linear_interpolate to lerp
2020-04-29 04:02:49 -04:00
6c8f2ae53a
Update docs and bindings for new integer vector types
2020-02-25 15:27:29 +01:00
57e27683ba
Update docs to version 4.0
2020-01-31 17:15:41 -08:00
2d20fc39aa
doc: Drop unused 'category' property from header
...
We already removed it from the online docs with #35132 .
Currently it can only be "Built-In Types" (Variant types) or "Core"
(everything else), which is of limited use.
We might also want to consider dropping it from `ClassDB` altogether
in Godot 4.0.
2020-01-26 16:02:39 +01:00
3231fca934
Add docs for is_equal_approx on structures
2019-11-30 16:52:27 -05:00
1f76229378
doc: Sync classref with current source
2019-11-08 08:33:48 +01:00
65d61d0360
doc: Sync classref with current source
2019-08-29 15:33:52 +02:00
092346d82b
Add Vector2/3 sign and posmod functions, misc additions
...
Also make the docs more consistent, add Axis enum to Vector2, add > and >=. and C# also gets % and an override for vector-vector mod.
2019-08-17 18:31:55 -04:00
Hugo Locurcio
Aaron Franke
Haoyu Qiu
Max Hilbrunner
Raul Santos
kobewi
Marcel Admiraal
Rémi Verschelde
Rémi Verschelde
reduz
George Marques
Michael Alexsander Silva Dias
kleonc
JestemStefan
Yuri Roubinsky
Chris Bradfield
clayjohn