godotengine/godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
33,279 Commits 15 Branches 59 Tags 2.2 GiB
b0bcbcc094
Commit Graph

64 Commits

Author SHA1 Message Date
Hugo Locurcio
b087538119
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-03-16 23:01:02 +01:00
lawnjelly
522bce1159 Fixed Timestep Interpolation (3D) 
Adds fixed timestep interpolation to the visual server.
Switchable on and off with project setting.

This version does not add new API for set_transform etc, when nodes have the interpolated flag set they will always use interpolation.
 2022-02-16 09:41:23 +00:00
SnailRhymer
83298da9b8 Backport improved look_at docs and errors 
Take extra constraint info and function description from Node3D.look_at to improve Spatial.look_at docs.
Add an explicit error for up == 0
 2022-01-31 11:52:15 +00:00
Rémi Verschelde
3ac2999f22
Replace Godot docs URL with $DOCS_URL in XML class reference 2021-11-15 17:22:47 +01:00
Rémi Verschelde
14c366ddd7
Bump version to 3.5-beta 2021-11-05 16:10:17 +01:00
Rémi Verschelde
f0b37b1519
doc: Point URLs to 3.4 version of the online docs 2021-08-12 17:08:10 +02:00
Rémi Verschelde
f5836b40d4
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.

(cherry picked from commit 7adf4cc9b5)
 2021-08-03 10:20:19 +02:00
lawnjelly
eb6f98ec55 Portal occlusion culling 
Adds support for occlusion culling via rooms and portals.
 2021-07-14 11:43:23 +01:00
Rémi Verschelde
c3272997cd
doc: Update classref headers with 3.4 version 2021-04-26 13:15:29 +02:00
Rémi Verschelde
015973df04
doc: Make all tutorial links point to 3.3 branch of docs 2021-03-26 10:43:43 +01:00
Rémi Verschelde
1aba997d75
doc: Sync classref with 3.3 version bump 2021-03-23 13:40:34 +01:00
Phischermen
708f690b50
Add info about how gizmos affect transform notifications 
(cherry picked from commit 72d1d7e948)
 2021-01-15 16:49:46 +01:00
Rémi Verschelde
4028414e0e
Revert "Made toplevel a property for Node3D and CanvasItem" 
This reverts commit a726d011d5.
 2020-10-19 16:58:56 +02:00
Rémi Verschelde
4287af5148
doc: Make docs.godotengine.org links point to 3.2 branch 2020-10-19 16:10:01 +02:00
Aaron Franke
069ed4ec63
Link to demos from within the class reference 
(cherry picked from commit 439be614f4)
 2020-10-19 16:10:01 +02:00
Duroxxigar
a726d011d5
Made toplevel a property for Node3D and CanvasItem 
(cherry picked from commit 85a8dbb7b6)
 2020-10-01 16:00:47 +02:00
Hugo Locurcio
451648c34d Improve visibility documentation for CanvasItem and Node3D 
This closes https://github.com/godotengine/godot-docs/issues/3840.

(cherry picked from commit 27b09dfc44)
 2020-07-28 00:53:16 +02:00
Hugo Locurcio
bb753aaf17 Clarify that angles must be specified as radians in the documentation 
This closes #36356.

(cherry picked from commit cae5260dab)
 2020-04-20 11:53:40 +02:00
Rémi Verschelde
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
clayjohn
c5700f7464 Complete various class references 2020-01-26 00:27:51 -08:00
Rémi Verschelde
d93201b27f
Merge pull request #33229 from Jummit/document-force_update_transform 
Document force_update_transform
 2019-11-01 14:03:01 +01:00
Jummit
2166437869 document force_update_transform 2019-11-01 10:37:39 +01:00
conankzhang
29844a5862 Add descriptions to scale functions. 2019-10-30 03:19:08 -07:00
Randall Fulton
bdf51e8e49 Call out scaling in Spatial.translate docstring 
This fixes issue #26938.
 2019-07-04 11:56:17 +02:00
Rémi Verschelde
a78373ddc2 doc: Remove null default values that can't be determined 
Applying #30187.
 2019-06-30 13:58:07 +02:00
Rémi Verschelde
b9aa13e591 doc: Remove hardcoded default values from descriptions 
They are now generated automatically by doctool.
 2019-06-30 13:58:07 +02:00
Rémi Verschelde
c6cea6e9b3 doc: Add default values to all properties 
Thanks to @bojidar-bg's impressive work in #29380.
 2019-06-30 13:58:07 +02:00
Hugo Locurcio
f7f6115f76
Proofread and improve the whole class reference 
- Document a few more properties and methods
- Add more information to many classes
- Fix lots of typos and gramar mistakes
- Use [code] tags for parameters consistently
- Use [b] and [i] tags consistently
- Put "Warning:" and "Note:" on their own line to be more visible,
  and make them always bold
- Tweak formatting in code examples to be more readable
- Use double quotes consistently
- Add more links to third-party technologies
 2019-06-27 22:30:19 +02:00
Rémi Verschelde
bc82781f7d doc: Replace all [code]CONSTANT[/code] by new [constant CONSTANT] hyperlinks 2019-06-27 13:49:36 +02:00
Rémi Verschelde
6af69f851a doc: Drop unused <demos> tag 2019-04-19 11:03:46 +02:00
Rémi Verschelde
09e94aa087 doc: Sync classref with current source 2019-04-15 14:49:41 +02:00
Rémi Verschelde
63d3a42f82
Merge pull request #27465 from neikeq/road-to-lang-agnostic-docs-is-going-to-be-tough 
EditorHelp: Improve enum ref resolving and add constant ref support
 2019-04-05 15:19:21 +02:00
Rémi Verschelde
39c868171e doc: Bump version to 3.2 2019-04-01 12:33:56 +02:00
Ignacio Etcheverry
d80bc5cbba ClassRef: Replace [code]CurrentClass[/code] with [CurrentClass] 
Modified makerst to generate code tags for these to avoid hyperlinks to the same class.
 2019-03-29 23:47:35 +01:00
Rémi Verschelde
26fddb77be doc: Fix wrong references found by new makerst.py 
Thanks @PJB3005
 2019-01-07 10:06:12 +01:00
Rémi Verschelde
6cdcde7114 doc: Add missing commas after "If true/false" 2018-12-20 13:47:12 +01:00
Rémi Verschelde
5f8af252e8 doc: Use HTTPS for docs.godotengine.org and point to latest branch 
Fixes #23509.
 2018-11-05 08:46:27 +01:00
Rémi Verschelde
c320d9394d doc: Sync classref with current source 2018-09-11 00:18:21 +02:00
Chris Bradfield
c049c8fbb9 [DOCS] Classref additions and corrections 2018-09-01 11:07:51 -07:00
Rémi Verschelde
391e46830f doc: Sync classref with current source 
Fix various missing arguments in bindings.
 2018-07-26 11:56:21 +02:00
Rémi Verschelde
7927eb6013 doc: Remove extraneous empty lines in descriptions 2018-06-15 08:54:06 +02:00
robojumper
98b59cf2a3 Add support for tutorial links to makerst.py 
Also change the <tutorials> structure to make use of individual <link> tags
 2018-06-12 17:40:24 +02:00
Mel Collins
b431264f77 [DOCS] Clarify look_at and looking_at 2018-04-29 15:44:07 +02:00
Rémi Verschelde
3fa77b3172 doc: Remove status from hardcoded version string 
It has no practical use case and just generates noise for each alpha, beta, etc.
 2018-02-27 13:40:49 +01:00
Rémi Verschelde
3c7a39b40c doc: Update version string in header 2018-02-19 10:46:33 +01:00
Rémi Verschelde
f2e3825616 doc: Fix references to online tutorials after godotengine/godot-docs#1015 2018-01-25 09:03:59 +01:00
Rémi Verschelde
d516aab8fa doc: Sync with current source 
Also enhance RigidBody docs as per https://github.com/godotengine/godot-docs/pull/1018
and fix the version tag in all files (not really stable yet, but it makes no sense
to hardcode rc3 at this stage).
 2018-01-25 08:50:56 +01:00
Rémi Verschelde
6c46787749 doc: Replace some more "val" with "value" + sync 2018-01-17 10:43:23 +01:00
Juan Linietsky
03475ba197 Filled tutorial field in most relevent classes. 
Added tutorial display in doc.
 2018-01-15 18:41:13 -03:00
Rémi Verschelde
e28cdc4654 doc: Update version string in XML 2018-01-13 11:43:42 +01:00