Rémi Verschelde
ccf3c2d0e1
Merge pull request #41077 from Calinou/doc-find-node-find-parent
...
Mention performance caveats about `find_node()` and `find_parent()`
2020-08-31 12:52:36 +02:00
Hugo Locurcio
ab2f41f598
Mention performance caveats about `find_node()` and `find_parent()`
...
See https://github.com/godotengine/godot-proposals/issues/1303 .
2020-08-29 21:36:57 +02:00
Tomasz Chabora
677796a2c3
Expose NOTIFICATION_POST_ENTER_TREE
2020-08-12 13:31:32 +02:00
Rémi Verschelde
372136fe75
Environment: Refactor code for readability + more
...
- Makes all boolean setters/getters consistent.
- Fixes bug where `glow_hdr_bleed_scale` was not used.
- Split CameraEffects to their own source file.
- Reorder all Environment method and properties declarations,
definitions and bindings to be consistent with each other
and with the order of property bindings.
- Bind missing enum values added with SDFGI.
- Remove unused SDFGI enhance_ssr boolean.
- Sync doc changes after SDFGI merge and other misc changes.
2020-07-01 14:44:45 +02:00
Hugo Locurcio
b2ba78ff0f
Clarify Node virtual methdods not being called if node is orphan
...
This closes #39489 .
2020-06-12 23:43:34 +02:00
Dominik 'dreamsComeTrue' Jasiński
7f5c81c32f
Replace 'add_child_below_node' with 'add_sibling' in Node
...
Fixes : #19642
2020-05-15 22:02:00 +02:00
Chris Bradfield
975ed93794
[DOCS] minor description changes
2020-05-09 18:56:14 -07:00
Rémi Verschelde
41af228b76
Merge pull request #36960 from pycbouh/docs-improve-shortcuts
...
Improve shortcut formatting in docs
2020-04-29 09:40:52 +02:00
Rémi Verschelde
d567c15aed
doc: Fix parsing typed arrays in makerst.py
...
`Type[]` typed arrays will link to `Type`, as it's likely the most
interesting information for the user.
And sync classref with current source.
2020-04-24 17:50:20 +02:00
Yuri Sizov
1ea7295bd2
Improve shortcut formatting in docs
2020-04-10 18:42:11 +03:00
Tomasz Chabora
c1023157eb
Remove Node.get_position_in_parent()
2020-04-06 01:19:20 +02:00
Rémi Verschelde
e5033d3952
doc: Sync classref with DisplayServer/Window changes
2020-03-31 11:56:58 +02:00
Rémi Verschelde
c0f9b52aef
Merge pull request #36509 from dalexeev/doc_node_fps
...
Minor fix in Node class documentation
2020-03-04 10:11:09 +01:00
Hugo Locurcio
393a3c3122
Improve the `Node.add_child_below_node()` documentation
...
This closes https://github.com/godotengine/godot-docs/issues/2730 .
2020-02-27 18:41:18 +01:00
Danil Alexeev
6e5cd36b12
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`.
2020-02-24 18:37:46 +03:00
Rémi Verschelde
fea37cfb52
doc: Sync classref with StringName/Callable changes
2020-02-22 14:59:09 +01:00
Rémi Verschelde
386968ea97
Remove obsolete GLES3 backend
...
Due to the port to Vulkan and complete redesign of the rendering backend,
the `drivers/gles3` code is no longer usable in this state and is not
planned to be ported to the new architecture.
The GLES2 backend is kept (while still disabled and non-working) as it
will eventually be ported to serve as the low-end renderer for Godot 4.0.
Some GLES3 features might be selectively ported to the updated GLES2
backend if there's a need for them, and extensions we can use for that.
So long, OpenGL driver bugs!
2020-02-13 10:36:44 +01:00
clayjohn
57e27683ba
Update docs to version 4.0
2020-01-31 17:15:41 -08: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
Fabio Alessandrelli
9de4ffde61
Refactor RPCMode enum and checks
2018-05-26 10:43:43 +02:00
Fabio Alessandrelli
0ad07a823c
Fix and improve docs, adds send_bytes
2018-05-12 23:22:09 +02:00
Fabio Alessandrelli
cbb744c4e0
Document MultiplayerAPI class
2018-05-08 21:15:50 +02:00
Juan Linietsky
7b065a59fa
Merge pull request #15911 from Zephilinox/ready_signal
...
Add ready signal to Node
2018-05-07 17:56:10 -03:00
Rémi Verschelde
cb7fe2c793
doc: Sync classref with current source
2018-04-10 10:12:42 +02:00
Geoffrey
8362ce4769
Made print_tree_pretty() function which displays scene tree graphically
2018-04-09 15:01:37 +02:00
Max Hilbrunner
13d5ee01f9
[DOCS] Node & PackedScene ( #17833 )
...
* [DOCS] Node: SceneSaver -> PackedScene
* [DOCS] PackedScene: Code example, resolve TODO
2018-03-28 23:07:03 +02:00
Max Hilbrunner
7275fb6170
[DOCS] Node: Remove duplicate information
2018-03-16 11:48:45 +01:00
mhilbrunner
5a3e841c60
[DOCS] Node: Networking updates, fix outdated and missing docs
2018-03-15 20:00:34 +01: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
Zephilinox
a826fb8d8b
Add ready signal to Node
...
Closes #15889
2018-01-20 21:57:59 +00:00
Rémi Verschelde
9f479f096c
Fix typos in code and docs with codespell
...
Using v1.11.0 from https://github.com/lucasdemarchi/codespell
2018-01-18 22:01:42 +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
c01575b312
doc: Sync with current source
2018-01-13 11:43:49 +01:00
Rémi Verschelde
e28cdc4654
doc: Update version string in XML
2018-01-13 11:43:42 +01:00
Juan Linietsky
a26e6c8215
Renamed tree_exited to tree_exiting. tree_exited is now used for actual out of tree notification.
...
Updated doc accordingly.
2018-01-12 08:29:24 -03:00
Bojidar Marinov
ad79c70300
Update docs
...
[ci skip]
2018-01-12 00:58:22 +02:00
Rémi Verschelde
aa6772d7ab
Revert property changes in "[DOCS] AnimationPlayer new props, members/methods"
...
This partially reverts commits e79456519d
and 2d07fe2920
, which introduced API changes
needing more in-depth review at this stage.
Kept the removal of "get_position" binding, redundant with
"get_current_animation_position". Kept docs changes where applicable.
Also removed the obsolete "stop_all" method which does the same as "stop".
Fixes #14602 .
2017-12-14 00:36:41 +01:00
Chris Bradfield
6264a52999
[DOC] Update Node class ref
2017-12-11 10:17:09 -08:00
Andrew Silver
ccd0599501
Fixed a typo in the Node docs
...
Fixed a typo in `remove_and_skip`
[ci skip]
2017-12-10 12:29:36 +01:00
Rémi Verschelde
624a2b08f3
doc: Sync classref after a496dd4d
, removing NOEDITOR properties from doc
2017-12-07 08:29:38 +01:00
Rémi Verschelde
2ab7a0f64c
doc: Fix misplaced constant description
...
[ci skip]
2017-11-29 09:52:06 +01:00
Max Hilbrunner
f28bb07dec
[DOCS] Node: Document _process()/_set_process()
2017-11-28 18:18:40 +01:00
Rémi Verschelde
7dfba3cda9
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
Rémi Verschelde
92f07fefcd
doc: Remove setters and getters now exposed via properties/members
2017-11-24 18:10:32 +01:00
Rémi Verschelde
bc75fae579
doc: Update header version for 3.0-beta
2017-11-24 09:16:52 +01:00
Rémi Verschelde
967bfb0c4a
doc: Remove revision.module_config from version string
...
It is now "3.0-alpha" instead of "3.0.alpha.custom_build{,.mono}",
limits unnecessary diffs.
2017-11-15 20:41:16 +01:00
Rémi Verschelde
fc09e14366
classref: Sync with current source
...
Also fix hyperlink references to same class as per the guidelines.
[ci skip]
2017-10-22 12:56:17 +02:00
Rémi Verschelde
b1f2c31a36
doc: Sync classref with current source
...
Ensure that s/fixed_process/physics_process/ is handled properly.
[ci skip]
2017-10-11 23:55:04 +02:00
letheed
5ad9be4c24
Rename pos to position in user facing methods and variables
...
Rename user facing methods and variables as well as the corresponding
C++ methods according to the folloming changes:
* pos -> position
* rot -> rotation
* loc -> location
C++ variables are left as is.
2017-09-20 13:11:10 +02:00
Rémi Verschelde
a4005221f5
doc: Sync classref with current source
...
[ci skip]
2017-09-13 08:53:01 +02:00