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
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
71d53637b5
doc: Fix scoped hyperlinks to same-class enums/methods
...
The class name does not need to be specified when it is the current class.
2019-06-27 11:44:37 +02:00
Rémi Verschelde
867dda1124
doc: Proofread and complete various nodes
...
All 100% completed: MainLoop, Node, Object, Path, Performance,
Reference, Resource, SceneState, SceneTree, UndoRedo.
Also fixed some en_GB occurrences as the reference spelling is en_US.
2019-06-26 23:05:51 +02:00
Rémi Verschelde
6e9272eea8
Node: Fix logic of has/get_node_and_resource and document it
...
Also document NodePath.
2019-06-26 15:46:32 +02:00
Hasan Yusuf Ahmed
8e652a1400
Added minimal documentation for _get_configuration_warning method
...
(cherry picked from commit 0eeb1a7d0d
)
2019-04-19 13:01:17 +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
70a009833b
Merge pull request #27561 from KoBeWi/get_frame_doc
...
Document SceneTree.get_frame() and persistent in add_to_group()
2019-04-09 12:10:48 +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
Tomasz Chabora
1e9128238e
Document SceneTree.get_frame() and persistent in add_to_group
2019-03-31 21:17:50 +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
74932b905e
doc: Sync classref with current source
2019-02-10 13:01:03 +01:00
Rémi Verschelde
ee6f1fa3f8
doc: Fix references to setters and misc formatting
2018-12-29 00:17:09 +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
7a42df3626
doc: Sync with current source
2018-10-25 15:14:47 +02:00
Kelly Thomas
b1ab7b4acf
[Docs] Fix some broken links
2018-10-06 04:20:16 +08:00
florian
c14e034f06
Document find_node()'s owner argument behaviour
2018-10-03 18:16:27 +02:00
Unknown
0fdbf6b2ef
Added find_parent method to node class
2018-09-15 18:22:29 +02:00
Fabio Alessandrelli
1e9b46d687
Clearly deprecate sync too in favor of remotesync.
...
NOTE: This changes the RPC_MODE_* enum values.
Games should be re-exported. GDNative rebuilt.
2018-09-15 00:06:03 +02:00
Fabio Alessandrelli
d6b31daec6
Rename slave keyword to puppet
...
The slave keyword will still be available as deprecated in 3.1 but will
be dropped from future releases.
2018-09-15 00:06:03 +02:00
Rémi Verschelde
ebc07ad5a2
doc: Mention get_node in Node.get_child documentation
...
See #22052 .
2018-09-14 11:11:38 +02:00
Mel Collins
2d0a55c86c
Clarify direction of input event propagation
2018-08-26 15:14:55 +02:00
Rémi Verschelde
4ea3e4f551
doc: Sync classref with current source
2018-08-21 00:35:46 +02:00
Michael Alexsander Silva Dias
79ab43299a
Small doc formating changes and Linux cursor theme note
2018-08-05 04:07:04 -03: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
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
Fabio Alessandrelli
1400f6fdc4
Refactor RPCMode enum and checks
2018-05-29 20:26:41 +02:00
Max Hilbrunner
4c69a495c9
Revert "RPCMode refactor, more sync modes"
2018-05-29 11:47:52 +02:00