Commit Graph

350 Commits

Author SHA1 Message Date
37305e40bc Merge pull request #95711 from TokageItLab/warn-oneshot-prop
Add hint for oneshot property & warning when it will be updated continuously by Force Continuous in `AnimationMixer`
2024-11-22 14:54:30 -06:00
af76a896ef Improve documentation on @GlobalScope.PROPERTY_USAGE_SCRIPT_VARIABLE 2024-11-14 00:05:06 +01:00
eaebb3f864 Fix more miscellaneous oddities around the class reference 2024-11-12 17:44:45 +01:00
761a20f7a7 Add hint for oneshot & warning when it will be updated continuously 2024-11-11 01:12:45 +09:00
360b84bad5 Clarification to the description of Global scope in regards to GDScript
Previous wording said that @GDScript referred to entries that could be accessed in any script. Although with common sense we could imagine that it is only refering to GDScript specific pieces of code, the wording is a little unclear.

In general there are small changes to the wording which makes it more clear and concise.
Wording change

Tried to match the wording up with my last change which should make it a bit easier to parse at a glance what the docs mean by "from any script"

Changed language from "not specific to" to "which work in any language"

After consulting multiple people the new wording seems easier to parse, even for non coders

Update doc/classes/@GlobalScope.xml

Update modules/gdscript/doc_classes/@GDScript.xml

Update modules/gdscript/doc_classes/@GDScript.xml

Co-Authored-By: Micky <66727710+Mickeon@users.noreply.github.com>
2024-10-23 02:10:03 -04:00
a6997d37cc Docs: remove duplicate words 2024-09-30 12:21:30 +02:00
85dfd89653 Add @export_tool_button annotation for easily creating inspector buttons
Co-authored-by: jordi <creptthrust@gmail.com>
Co-authored-by: K. S. Ernest (iFire) Lee <ernest.lee@chibifire.com>
Co-authored-by: Mack <86566939+Macksaur@users.noreply.github.com>
2024-09-27 22:24:15 +01:00
d49ec39d63 [Core] Add Engine.print_to_stout setting to control printing
Also added notes to the related project settings pointing to the
`Engine` properties.
2024-09-22 12:09:01 +02:00
0b4ae20156 Merge pull request #78656 from Repiteo/typed-dictionary
Implement typed dictionaries
2024-09-06 22:38:13 +02:00
4629f7d040 Merge pull request #96496 from aXu-AP/lerp-transform
Add support for Transform2D/3D in `lerp()`
2024-09-05 17:44:11 +02:00
9853a69144 Implement typed dictionaries 2024-09-04 10:27:26 -05:00
7218dd6a3a Add support for Transform2D/3D in lerp()
Implements godotengine/godot-proposals#10579
2024-09-03 16:59:15 +03:00
fffed28f9a Fix ambiguity in angle_difference function documentation
Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>
2024-09-03 11:03:30 +02:00
4ce5856384 Remove empty [b]Example:[/b] lines from the class reference 2024-08-19 01:00:52 +02:00
23fc704cbc This PR handles the smoothstep degenerate case where the range is empty.
It also updates the documentation to describe positive and negative ranges.

Co-Authored-By: Hugo Locurcio <hugo.locurcio@hugo.pro>
Co-Authored-By: kleonc <9283098+kleonc@users.noreply.github.com>
2024-08-15 19:08:05 -04:00
6651a511c8 Fix unclear PROPERTY_USAGE_STORAGE/EDITOR description 2024-07-17 11:30:13 +02:00
c0eb347946 Merge pull request #91557 from AThousandShips/dotnet_doc_fix
[C#] Unexpose `GodotSharp`
2024-05-21 11:22:40 +02:00
26feefa91c Add notes for remap's return when istart and istop are the same
Co-Authored-By: Rémi Verschelde <rverschelde@gmail.com>
Co-Authored-By: kleonc <9283098+kleonc@users.noreply.github.com>
2024-05-07 19:37:29 -03:00
aff2e47bff [C#] Unexpose GodotSharp
This class seems to have been exposed accidentally, and breaks
documentation on non-mono builds, requiring hacks
2024-05-04 14:09:42 +02:00
f9b488508c Add PackedVector4Array Variant type
Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>
Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
2024-05-03 00:58:27 +02:00
0f5e0d1637 Expose Vector* component-wise and scalar min/max to scripting 2024-05-02 13:02:40 +02:00
85fb4439e3 doc: Clarify where printraw() output can be seen in the OS terminal
Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
2024-04-12 10:52:18 +02:00
328b00774b Use [codeblock lang=text] more often in class ref 2024-04-08 16:17:50 +02:00
24c9d442e9 [Doc] Fix some incorrect uses of a/an 2024-03-13 21:20:28 +01:00
da02ca7e75 [NativeMenu] Add checks to avoid unnecessary warnings.
Added by Rémi: Add dummy NativeMenu to DisplayServerHeadless,
fixing crashes when using `--headless`.

Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
2024-03-07 00:23:26 +01:00
c54e09a5a3 Overhaul some "uncommon" wording in class reference 2024-03-01 15:32:38 +01:00
f781571d07 Add keywords to improve search in the class reference 2024-02-22 16:16:49 +01:00
f9a758772a Update many Deprecated/Experimental descriptions for consistency 2024-02-17 21:33:12 +01:00
af28f87791 Documentation: Add support for deprecated/experimental messages 2024-02-15 15:59:50 +03:00
5911a12db1 Update class reference to include some keywords
More should be added in future PRs, wherever there is demand.
2024-02-09 18:13:23 +01:00
c2968e497d Merge pull request #86693 from Mickeon/doc-peeves-midiiiiii
Improve all documentation about MIDI support
2024-01-29 13:16:37 +01:00
8723d116c4 Overhaul documentation about MIDI support 2024-01-26 22:28:47 +01:00
8406e60522 Add InputEventKey.location to tell left from right
This adds a new enum `KeyLocation` and associated property
`InputEventKey.location`, which indicates the left/right location of key
events which may come from one of two physical keys, eg. Shift, Ctrl.

It also adds simulation of missing Shift KEYUP events for Windows.
When multiple Shifts are held down at the same time, Windows natively
only sends a KEYUP for the last one to be released.
2024-01-26 14:42:28 +01:00
79d818478f Merge pull request #79813 from AThousandShips/callable_doc
Clarify that `Callable` will not be encoded with `var_to_bytes`
2024-01-24 14:07:36 +01:00
4a11d48420 Handle clickable [url] tags in print_rich() editor output log
Since this uses `OS.shell_open()`, this allows the use of any standard URL
including `file://` paths, `mailto:`, custom protocols set up by the user, etc.
2024-01-15 14:54:13 +01:00
c909354396 Clarify that Callable will not be encoded with var_to_bytes 2024-01-07 14:10:36 +01:00
e7dbb7a267 Clarify that @GlobalScope.clamp does not do component-wise clamping 2023-12-26 22:16:34 +01:00
714e27393a Merge pull request #84652 from timothyqiu/enum-pun
Avoid punning enum names in documentation
2023-12-19 13:01:10 +01:00
4296f0a771 Fill remaining global scope constant descriptions 2023-11-13 15:17:10 +01:00
b2dcef4928 Explain circular references and how to break them
Also improves the documentation of `weakref`.
2023-11-11 10:07:48 +08:00
cc3984f359 Avoid punning enum names in documentation 2023-11-09 17:16:30 +08:00
0c2202c56e GDScript: Fix incorrect error message for utility functions 2023-10-16 14:09:57 +03:00
5da63c5358 Add documentation on which buttons JOY_BUTTON_START corresponds to 2023-10-08 21:33:22 +01:00
1e544505be Merge pull request #82691 from YuriSizov/rst-validate-with-exceptions
Validate `code` tags for class and member references
2023-10-04 15:42:42 +02:00
cc0eebd9d8 Validate code tags for class and member references
This commit also adds means to manually disable warnings
in `code` tags where it's a false positive with the new
`skip-lint` attribute.

Warnings are now enabled on CI to prevent future errors.
2023-10-03 15:48:31 +02:00
74c937079c Add type_string() utility 2023-10-02 17:41:20 +02:00
3a39de4e2f Add rotate_toward and angle_difference to GDScript and C# 2023-10-01 22:19:42 +02:00
e45927b2f2 Replace radians range hint with radians_as_degrees 2023-09-25 08:50:19 +02:00
38ca83e16f Merge pull request #81464 from AcatXIo/fix-sign-nan
Fix `SIGN(NAN)` returning 1
2023-09-12 12:01:39 +02:00
7d69a5ba50 Fix sign(NAN) returning 1.
Fixes #79036. sign(NAN) now returns 0.
This should not impact performance much in any way.
Adds a test for the NAN case. Updates the documentation to clarify the new behavior.
2023-09-09 11:30:11 +02:00