452e10ba7b
Remove clips_input() method and use clip_content
2021-06-25 15:46:37 +02:00
e28fd07b2b
Rename `instance()`->`instantiate()` when it's a verb
2021-06-19 20:49:18 -06:00
0ff4095b36
Better format arguments in variant parser
2021-06-18 00:06:40 -03:00
7ff135b015
Consistently prefix bound virtual methods with _
2021-06-12 00:55:52 +02:00
6710ad1737
Let var2str display StringName with correct sigil
2021-06-10 16:30:28 -05:00
c1c76850cb
Style: Cleanup uses of double spaces between words
...
Or after punctuation. Tried to leave third-party stuff alone, unless it has
been heavily modified for Godot.
2021-06-07 11:03:08 +02:00
9eaa139c1f
Add theme_custom_type property to Control and Window
2021-05-17 17:20:42 +03:00
5d0cc7c15f
Merge pull request #47252 from KoBeWi/themecide
...
Add methods to remove theme overrides
2021-03-31 20:52:19 +02:00
10d7fccb54
Rename ButtonList enum and members to MouseButton
2021-03-23 07:13:23 -04:00
5950482b86
Remove the clearing behavior from add_override
2021-03-23 00:55:02 +01:00
ecff5bc42f
Add methods to remove theme overrides
2021-03-23 00:51:16 +01:00
eaa04c1a22
Fix crash during drag if user freed the drag preview
2021-02-24 20:59:17 +01:00
13c0e48791
Merge pull request #45137 from Calinou/doc-control-gallery
...
Reference the control gallery image in the Control class documentation
2021-02-01 20:49:30 +01:00
200f1cf015
Reference the control gallery image in the Control class documentation
...
Like the Tween cheatsheet or Color constants cheatsheet, this references
a "cheatsheet" image from the documentation repository.
2021-01-29 18:05:04 +01:00
3e94c23fa5
Exposed find_next_valid_focus and find_prev_valid_focus.
2021-01-26 08:19:20 +01:00
215d18814e
doc: Sync classref with current source
2021-01-04 14:33:44 +01:00
9addcb7603
Merge pull request #44751 from madmiraal/rename-rect-grow_margin
...
Rename Rect2 and Rect2i grow_margin() to grow_side()
2020-12-28 15:56:14 +01:00
891b1cdf28
Merge pull request #44607 from madmiraal/rename-control-rotation
...
Rename Control rotation to rotation_degrees
2020-12-28 14:42:06 +01:00
b628912af0
Rename Rect2 and Rect2i grow_margin() to grow_side()
2020-12-28 12:47:33 +00:00
b832003c6b
Rename Control rotation to rotation_degrees
2020-12-23 07:06:30 +00:00
4b8b803931
Rename Control margin to offset
2020-12-23 06:25:56 +00:00
aea7fde241
Rename neighbour in Control to neighbor
...
This keeps things consistent with the rest of Godot, which uses the
American English spelling of Color.
2020-12-15 16:42:21 -06:00
7e2c0ffd1a
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-11-26 14:25:52 +02:00
fc70f986b9
Merge pull request #42008 from Calinou/theme-rename-node-type
...
Rename the `type` parameter to `node_type` in Theme and Control
2020-11-16 13:20:24 +01:00
c5d8dafec4
Tooltips: Improve code clarity and docs
...
The return type for `_make_custom_tooltip` is clarified as Control, and users
should make sure to return a visible node for proper size calculations.
Moreover in the current master branch, a PopupPanel will be added as parent
to the provided tooltip to make it a sub-window.
Clarifies documentation for `Control._make_custom_tooltip`, and shows how to
use the (until now undocumented) "TooltipPanel" and "TooltipLabel" theme types
to style tooltips.
Fixes #39677 .
2020-11-03 09:19:03 +01:00
c3b246e6af
Rename the `type` parameter to `node_type` in Theme and Control
...
This makes it clearer that it expects a node type as a string
(such as "Label") instead of a type like "TYPE_ARRAY".
This is backwards-compatible since only the name of the parameter
is changed, not its order.
2020-10-27 14:58:52 +01:00
4834e14493
Updated getters and setters names for toplevel
2020-10-02 19:09:01 -04:00
439be614f4
Link to demos from within the class reference
2020-10-01 23:57:21 -04:00
ae873ab822
Translate GDScript Code Examples to C# (C)
...
Translates Code Examples in classes beginning with `C`.
Includes:
* Callable
* CanvasItem
* CharFXTransform
* Color
* ColorRect
* ConfigFile
* ConfirmationDialog
* Control
* Crypto
2020-09-26 11:48:37 +02:00
c4903a603b
Add link titles for all links in the class reference
...
This makes them display in a nicer way in the editor help.
(The title will display instead of the full URL.)
2020-08-31 14:22:07 +02:00
2a8bbda2a7
Improve the documentation related to overriding GUI theme items
...
Overriding theme items is a common point of confusion.
Hopefully, these code samples should clear things up.
2020-08-04 12:57:53 +02:00
a36912b3cb
Document caveats related to Control scaling
...
This is a common topic of confusion. Clarifying its intended scope
should make things easier to understand.
2020-07-15 10:36:29 +02:00
1ea7295bd2
Improve shortcut formatting in docs
2020-04-10 18:42:11 +03:00
3f19b5e0b3
Clarify documentation and indicate that rect_clip_content affects only CanvasItem based nodes.
...
Resolves #37683
2020-04-09 22:09:05 +02:00
e5033d3952
doc: Sync classref with DisplayServer/Window changes
2020-03-31 11:56:58 +02:00
fea37cfb52
doc: Sync classref with StringName/Callable changes
2020-02-22 14:59:09 +01:00
0e3d625737
doc: Sync classref with current source
...
Lots of internal API changes and some docstrings were lost in the conversion.
I manually salvaged many of them but for all the rendering-related ones, an
additional pass is needed.
Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 12:37:13 +01:00
57e27683ba
Update docs to version 4.0
2020-01-31 17:15:41 -08:00
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
378c4895ae
[DOCS] Corrections and clarifications to classref
2020-01-10 10:46:41 -08:00
e4b97b4614
[Doc] Added more details for set_drag_preview()
2019-11-07 12:43:04 +01:00
52e799b6d4
Code format for true/false/null to make documentation consistent
2019-11-02 12:14:15 +01:00
91ecd7b6a6
Fix misc. source comment typos
...
Found using `codespell -q 3 -S ./thirdparty,*.po -L ang,ba,cas,dof,doubleclick,fave,hist,leapyear,lod,nd,numer,ois,paket,seeked,sinc,switchs,te,uint -D ~/Projects/codespell/codespell_lib/data/dictionary.txt `
2019-09-19 14:36:52 -04:00
65d61d0360
doc: Sync classref with current source
2019-08-29 15:33:52 +02:00
1349e0e585
doc: Sync classref with current source
...
Fix wrong hyperlinks in Control and Tree.
2019-08-22 14:49:30 +02:00
592909db16
doc: Sync classref with current source
2019-08-13 12:35:50 +02:00
2dbc817b93
Complete the Control class documentation
2019-08-07 15:31:47 +02:00
efd55631e2
doc: Sync classref with current source
2019-07-15 20:45:30 +02:00
542489a866
DocData: Re-expose parametric setters and getters
...
Setters and getters have been hidden from the documentation when the matching
properties have been exposed, but some of them are parametric and require the
name or index of a given parameter to be used. So they need to be properly
documented with the type and name of the arguments they take.
For example, CPUParticles' `set_param(Parameter param, float value)`.
2019-07-04 14:08:16 +02:00
a78373ddc2
doc: Remove null default values that can't be determined
...
Applying #30187 .
2019-06-30 13:58:07 +02:00
b9aa13e591
doc: Remove hardcoded default values from descriptions
...
They are now generated automatically by doctool.
2019-06-30 13:58:07 +02:00
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
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
bc82781f7d
doc: Replace all [code]CONSTANT[/code] by new [constant CONSTANT] hyperlinks
2019-06-27 13:49:36 +02:00
e1e3fcc908
doc: Fix DocData.merge_from copying old setters and getters
...
This is not necessary and means that some setters and getters
can end up wrong if they are changed in the bindings but DocData
does not update them when running --doctool.
Fixes #29425 .
Co-authored-by: Bojidar Marinov <bojidar.marinov.bg@gmail.com>
2019-06-03 13:03:05 +02:00
a9ddf2a449
More accurate description of valid Parents
...
I hope this is the right place to edit now.
2019-05-30 20:41:55 +08:00
426bcc9941
Change "Return" to "Returns" where necessary in XML documentation
...
In many of the XML files it had been noted that when the documentation
refers to a return value, both "Return" and "Returns" are used. This
has now been fixed to only say "Returns".
Fixes #28867
2019-05-23 21:11:24 -07:00
86f6d08923
doc: Sync classref with current source
2019-05-21 13:27:03 +02:00
ab4705a807
Merge pull request #28125 from KoBeWi/code_true_code
...
Consistently wrap booleans in [code]
2019-04-22 11:59:16 +02:00
6af69f851a
doc: Drop unused <demos> tag
2019-04-19 11:03:46 +02:00
b0846f60c9
Consistently wrap booleans in [code]
2019-04-17 17:13:00 +02:00
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
39c868171e
doc: Bump version to 3.2
2019-04-01 12:33:56 +02:00
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
d1f68e2eaf
Add tooltip for in-editor FPS display in 3D viewport
...
Also enhance Control/Label documentation about tooltips and mouse filter,
as it took me a while to understand why Labels didn't show tooltips.
Closes #26082 .
2019-02-20 12:16:22 +01:00
5fc86026ca
Fix typos with codespell
...
Using codespell 1.14.0.
Method:
```
$ cat > ../godot-word-whitelist.txt << EOF
ang
doubleclick
lod
nd
numer
que
te
unselect
EOF
$ codespell -w -q 3 -I ../godot-word-whitelist.txt --skip="./thirdparty,*.po"
$ git diff // undo unwanted changes
```
2019-02-13 09:23:29 +01:00
aca6e5f4b7
Update Control.xml
...
The mouse_filter documentation was biased towards button click events, so add more mention of its impact on mouse_entered and mouse_exited signals as well.
2019-01-21 21:39:06 -09:00
a15620c83e
doc: Fix wrong references found by Sphinx and new makerst.py
2019-01-07 12:15:01 +01:00
26fddb77be
doc: Fix wrong references found by new makerst.py
...
Thanks @PJB3005
2019-01-07 10:06:12 +01:00
53516d7a9e
Merge pull request #24608 from PJB3005/18-12-26-control-docs
...
Improve documentation of Control.
2019-01-06 13:15:15 +01:00
c93c279867
Improve documentation of Control.
2019-01-04 18:12:24 +01:00
ee6f1fa3f8
doc: Fix references to setters and misc formatting
2018-12-29 00:17:09 +01:00
5f8af252e8
doc: Use HTTPS for docs.godotengine.org and point to latest branch
...
Fixes #23509 .
2018-11-05 08:46:27 +01:00
b1ab7b4acf
[Docs] Fix some broken links
2018-10-06 04:20:16 +08:00
eaac1e3b81
[Docs] Remove double-spaces from descriptions, as well a couple other small fixes
2018-09-23 16:13:30 -04:00
c320d9394d
doc: Sync classref with current source
2018-09-11 00:18:21 +02:00
29f2571662
update class docs
2018-08-31 22:35:15 +02:00
2d0a55c86c
Clarify direction of input event propagation
2018-08-26 15:14:55 +02:00
4ea3e4f551
doc: Sync classref with current source
2018-08-21 00:35:46 +02:00
23b7edb214
[DOCS] Updates to assorted class descriptions.
2018-08-17 14:55:19 -07:00
79ab43299a
Small doc formating changes and Linux cursor theme note
2018-08-05 04:07:04 -03:00
391e46830f
doc: Sync classref with current source
...
Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
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
c6ed46891d
[docs] fix links in class docs
2018-05-17 00:15:30 +08:00
cb7fe2c793
doc: Sync classref with current source
2018-04-10 10:12:42 +02:00
a88ee7d920
[Docs] fix typos
2018-03-29 12:46:21 +07:00
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
7154a96d3f
added docs on Control's drag and drop api
2018-02-26 15:54:08 -08:00
3c7a39b40c
doc: Update version string in header
2018-02-19 10:46:33 +01:00
5e0821e867
Small fixes for the Control description in the docs.
2018-02-01 19:43:44 -02:00
f2e3825616
doc: Fix references to online tutorials after godotengine/godot-docs#1015
2018-01-25 09:03:59 +01:00
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
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
6c46787749
doc: Replace some more "val" with "value" + sync
2018-01-17 10:43:23 +01:00
03475ba197
Filled tutorial field in most relevent classes.
...
Added tutorial display in doc.
2018-01-15 18:41:13 -03:00
e28cdc4654
doc: Update version string in XML
2018-01-13 11:43:42 +01:00
524ee14054
Small fix for Control bindings
2018-01-13 09:40:42 +01:00
ad79c70300
Update docs
...
[ci skip]
2018-01-12 00:58:22 +02:00
7251c5b582
Improve Control and Label documentation about mouse filtering
...
Fixes #9657 .
2018-01-09 17:40:19 +01:00
305ab94431
Document Control.mouse_filter and its constants.
2018-01-04 18:20:19 +01:00
kobewi
Lightning_A
Michael Alexsander Silva Dias
Jonathan Gollnick
Rémi Verschelde
Yuri Sizov
Rémi Verschelde
Aaron Franke
Delf Neumärker
Hugo Locurcio
Nils Reid
Marcel Admiraal
Daniel Ting
bruvzg
Duroxxigar
HaSa1002
Markus Sauermann
clayjohn
Chris Bradfield
Anthony Rey
PouleyKetchoupp
luz.paz
Aspin
Sean Heffernan
Ignacio Etcheverry
danboo
Pieter-Jan Briers
Kelly Thomas
LikeLakers2
Mel Collins
robojumper
Poommetee Ketson
indicainkwell
Juan Linietsky
letheed
Bojidar Marinov
PJB3005