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
Ryan Roden-Corrent
98bbee3008
Add note about add_child and owner.
...
Resolves #34739 .
2020-01-02 21:50:31 -05:00
Hugo Locurcio
0bab51ab55
Fix the Node process_priority
description to match actual behavior
...
This closes #34531 .
2019-12-22 17:01:56 +01:00
alexchond
e26b066871
DUPlICATE_USING_INSTANCE documentation update
2019-12-19 17:17:57 +02:00
alexchond
be3fc17603
Document DUPLICATE_USE_INSTANCING #2770
2019-12-17 13:41:36 +02:00
Rémi Verschelde
934f6f2529
Merge pull request #33867 from rcorre/get_node_docs
...
Clarify get_node vs get_node_or_null.
2019-11-25 14:35:45 +01:00
Hugo Locurcio
ae76c62601
Implement Node::get_process_priority()
and its associated property
...
This closes #33660 .
2019-11-17 17:48:50 +01:00
PouleyKetchoupp
139c0a4afe
Expose Node::update_configuration_warning() to scripts
...
This method can be used to generate custom node warnings by script.
Node::_get_configuration_warning was already exposed to generate custom warnings, but it wasn't fully usable without being able to notify the scene tree when the warning needs to appear or change.
2019-10-17 12:20:35 +02:00
Rémi Verschelde
2e065d8ad0
Merge pull request #32064 from m4gr3d/propagate_gl_surface_events
...
Notify for app pause and resume events on Android
2019-09-20 23:18:40 +02:00
fhuya
a7712cc9e4
Add new events and accompanying logic to notify when the app is paused and resumed on Android devices.
2019-09-19 13:29:49 -07:00
Ryan Roden-Corrent
38fc09e669
Clarify get_node vs get_node_or_null.
...
Fixes #2771 . It is confusing to say get_node will "raise an error" if
the node does not exist, as this phrase is used elsewhere in the godot
docs (e.g. at several points in the GDScript overview) to indicate
something that will completely stop execution. Saying it logs an error
is more accurate.
2019-09-19 07:10:18 -04:00
Tomasz Chabora
7e8dd867da
Mention constructor arguments in duplicate() doc
2019-09-13 13:05:13 +02:00
zzwx
d4d03e5de9
Documentation note that Node::add_child() fails if child already has a parent
2019-08-14 10:41:30 -04:00
Tomasz Chabora
a26f52db33
Clarify better what Node.raise does
2019-07-06 17:58:57 +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
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
Tomasz Chabora
b71a339160
Clarify docs for _ready and request_ready
2019-06-28 19:18:43 +02:00