Commit Graph

131 Commits

Author SHA1 Message Date
Micky 6102f3cfc2 [3.x] Rename `set_indexed` & `get_child`'s params to be clearer
3.x backport of #67300 and #64463.
2022-10-12 20:55:41 +02:00
Hugo Locurcio ed380cc0fa
Add a `[kbd]` tag for highlighting keyboard shortcuts in the editor help
This allows backporting documentation from the `master` branch more easily,
as it already features the `[kbd]` tag.

Co-authored-by: Yuri Sizov <11782833+YuriSizov@users.noreply.github.com>
2022-08-25 19:53:49 +02:00
Rémi Verschelde 0a8d5d7098 Bump version to 3.6-beta 2022-08-05 18:51:38 +02:00
Rémi Verschelde 0cb897421a Node: Rename `child_exited_tree` to `child_exiting_tree`
The name was confusing as this signal is emitted around the same time as
`tree_exiting` and `NOTIFICATION_EXIT_TREE`, i.e. while the child node is
still in tree.

Fixes #59210.

(cherry picked from commit 3e6de687b8)
2022-06-20 15:00:09 +02:00
Hugo Locurcio 109f968171
Change instances of "returns an empty Variant" to "returns null" in docs
While "returns an empty Variant" technically valid (it's constructed
as `Variant()` in C++), "returns null" is more intuitive to users.
2022-05-29 20:20:08 +02:00
Haoyu Qiu 067e738cb8 Fix various typos 2022-05-19 19:07:45 +08:00
lawnjelly 0ab077fcef Physics Interpolation - add interpolation mode property to node
Exposes the "interpolated" flag on nodes via a property, physics_interpolation_mode.

Mode can be INHERIT, OFF and ON. This makes it easy to turn off interpolation for nodes in the editor, versus via code.
2022-05-07 13:51:49 +01:00
Rémi Verschelde 6ee64331db
Merge pull request #60527 from KoBeWi/unique_names_demastered 2022-05-02 10:48:27 +02:00
Rémi Verschelde 8ee69a88c1 doc: Fix a couple broken links to a moved page 2022-04-29 14:16:34 +02:00
Haoyu Qiu 153dc4d57e Backport the new Tween system as SceneTreeTween
Co-authored-by: Tomasz Chabora <kobewi4e@gmail.com>
2022-04-29 20:01:12 +08:00
kobewi 6891d719f6 Improve descriptions for drag methods
(cherry picked from commit 31a23ab33f)
2022-04-27 12:27:20 +02:00
kobewi e1c74ae83f Implement Scene Unique Nodes 2022-04-26 13:55:48 +02:00
Hugo Locurcio 0e25cd0788 Mention that Node's `owner` must be set for persistence to work
This is already done in `Node.add_child()` documentation, but
this copies the note in `Node.owner` for good measure.

(cherry picked from commit be1acf3b92)
2022-03-22 08:55:07 +01:00
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
reduz e4e3f7d157
Add a signal to notify when children nodes enter or exit tree
-Allows more fine grained notifications (hence better performance) than using the global scene tree signals (node added and removed).
-Required for #55950

(cherry picked from commit fbd9599b04)
2022-02-11 09:50:58 +01:00
Marcel Admiraal a4f0e02798 Update definitions of get_mouse_position methods 2022-02-06 09:32:46 +00:00
cdemirer 8e29a37800
Clarify that replace_by keeps child nodes in tree
(cherry picked from commit 98a3948bf9)
2021-12-21 12:11:14 +01:00
kobewi bf99f09e14
Mention what happens if find_node() fails
(cherry picked from commit e7722a9a7b)
2021-12-17 00:14:50 +01:00
Haoyu Qiu b1153f8829 Fix broken links in Class Reference 2021-12-10 21:07:21 +08:00
Haoyu Qiu 144e3cd31f
Fix various misused code tag in classref
(cherry picked from commit 85c136bd07)
2021-12-02 17:31:16 +01:00
Hugo Locurcio f6725f8089
Document the engine's use of internal groups in Node
(cherry picked from commit f8d9e4afdb)
2021-11-25 22:24:12 +01:00
kobewi a7d950ab8e
Mention that replace_by doesn't free the node
(cherry picked from commit 58a3ea5453)
2021-11-25 22:20:27 +01: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
zacryol df1eebd8d8
Mention remove_node() side effect of potentially setting owner to null
(cherry picked from commit 6941ab9ae5)
2021-10-11 12:50:04 +02:00
Hugo Locurcio deeeabc2ba
Clarify what the `Node.filename` property contains
(cherry picked from commit f23b917007)
2021-10-01 08:01:47 +02:00
Hugo Locurcio e1330418ab
Document that node groups don't have a guaranteed order
(cherry picked from commit 0adf1a6683)
2021-09-20 12:31:56 +02: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
Rémi Verschelde c3272997cd
doc: Update classref headers with 3.4 version 2021-04-26 13:15:29 +02:00
Rémi Verschelde 1c9203ad68
Object: Make deleted object access raise errors, not warnings
Clarify doc about not decaying to `null` for `free` and `queue_free`.

Part of #45639.
2021-04-20 11:37:39 +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
Paul Joannon 596169d7df
class reference proofreading
(cherry picked from commit 8455e901f3)
2021-03-26 09:49:07 +01:00
Rémi Verschelde 1aba997d75
doc: Sync classref with 3.3 version bump 2021-03-23 13:40:34 +01:00
Hugo Locurcio 7fb212fdb6
Mention that the `delta` argument is in seconds in Node documentation
(cherry picked from commit fcb6ecaf21)
2021-01-05 21:33:34 +01:00
Maganty Rushyendra d2241a2b5f
Specify order of drawing of Nodes in raise() description
(cherry picked from commit a67ef5999d)
2021-01-05 21:33:32 +01:00
Rémi Verschelde ac8dedd532
doc: Warn about using Node internal processing
See #43689.

Also 'fixed' some spelling for behavior in publicly visible strings.
(Sorry en_GB, en_CA, en_AU, and more... Silicon Valley won the tech spelling
war.)

(cherry picked from commit a655de89e3)
2020-11-26 09:38:45 +01: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
Tomasz Chabora d9bd61508b
Document that setting node name will remove @s
(cherry picked from commit 02ce2f4bb9)
2020-10-19 16:10:01 +02:00
Danil Alexeev 06f3cd8bd8
Several documentation improvements
(cherry picked from commit a4c5790350)
2020-09-15 19:26:40 +02:00
Hugo Locurcio b76aa91402
Mention performance caveats about `find_node()` and `find_parent()`
See https://github.com/godotengine/godot-proposals/issues/1303.

(cherry picked from commit ab2f41f598)
2020-08-31 15:29:31 +02:00
Tomasz Chabora 7ce476c425 Expose NOTIFICATION_POST_ENTER_TREE
(cherry picked from commit 677796a2c3)
2020-08-14 00:32:05 +02:00
Hugo Locurcio fb736018c5
Clarify the node parameters in `Node.add_child_below_node()` docs
This closes https://github.com/godotengine/godot-docs/issues/3769.
2020-07-11 12:23:41 +02:00
Hugo Locurcio 4c289058ed Clarify Node virtual methdods not being called if node is orphan
This closes #39489.

(cherry picked from commit b2ba78ff0f)
2020-06-15 14:34:35 +02:00
Chris Bradfield 752f61d4fe [DOCS] minor description changes
(cherry picked from commit 975ed93794)
2020-05-11 11:01:13 +02:00
Danil Alexeev 4bf0c52a30 Minor fix in Node class documentation
The name of the property responsible for physics fps is fixed:
this is `Engine.iterations_per_second`, not `Engine.target_fps`.

(cherry picked from commit 6e5cd36b12)
2020-03-04 12:40:15 +01: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
Rémi Verschelde ba177ccaec doc: Misc updates for AnimationNode* and others
- Add some missing descriptions.
- Add links to tutorials for ARVR and AnimationTree.
- Style fixes.
- Engine changes:
  * Make `AnimationNodeTransition.input_<number>` properties internal
    so that they don't appear in the docs. They still appear in the
    inspector based on the actual number of inputs requested.
  * Drop unimplemented `CPUParticles.flatness`. It's only used for 3D
    particles in `ParticlesMaterial`, and thus only relevant for
    `CPUParticles3D`.
2020-01-23 12:37:33 +01:00