Commit Graph

332 Commits

Author SHA1 Message Date
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
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
6f7eccc758 Add a type conversion method to Variant Utility and expose to scripting 2023-09-08 10:12:48 -05:00
528a76486c Add inverse hyperbolic functions asinh(), acosh() & atanh()
GDScript has the following built-in trigonometry functions:

- `sin()`
- `cos()`
- `tan()`
- `asin()`
- `acos()`
- `atan()`
- `atan()`
- `sinh()`
- `cosh()`
- `tanh()`

However, it lacks the hyperbolic arc (also known as inverse
hyperbolic) functions:

- `asinh()`
- `acosh()`
- `atanh()`

Implement them by just exposing the C++ Math library, but clamping
its values to the closest real defined value.
For the cosine, clamp input values lower than 1 to 1.
In the case of the tangent, where the limit value is infinite,
clamp it to -inf or +inf.

References #78377
Fixes godotengine/godot-proposals#7110
2023-09-01 01:27:56 +02:00
8908ac4e6e Add missing YEN, SECTION and OPENURL names to keycode mappings 2023-08-28 03:37:22 -03:00
951ea2415b Make EditorInterface accessible as a singleton
- EditorPlugin.get_editor_interface() is removed as redundant.
2023-08-09 16:01:31 +02:00
3fa5a15a2c Merge pull request #72091 from MewPurPur/fix-nearest-po2
Improve documentation of `nearest_po2()`
2023-08-07 14:42:49 +02:00
c4b5161ed1 Fix invalid use of markdown syntax in classref
Also:
* changed `[b]true[/b]` to `[code]true[/code]`
* use `[i]` for mathematical constant "e"
* use `[b]` for button text & menu item text
* improve markups about "tap1" and "tap2" in AudioEffectDelay
2023-08-01 22:44:31 +08:00
81064cc239 Doctool: Remove version attribute from XML header
We don't use that info for anything, and it generates unnecessary diffs
every time we bump the minor version (and CI failures if we forget to
sync some files from opt-in modules (mono, text_server_fb).
2023-07-06 10:08:21 +02:00
346f1ab86b Bump version to 4.2-dev
Keep on waitin'
2023-07-05 22:07:03 +02:00
8e31d986c3 Fix GlobalScope doc link for NavigationServer3D
Fixes GlobalScope doc link for NavigationServer3D.
2023-06-25 19:04:56 +02:00
9159208ed1 Ensure RID, Callable, and Signal are stored as strings
Prevents parser errors in `.tscn` and `.tres` files where the assignment
would otherwise be empty.
2023-06-22 17:01:08 +02:00
b06b00eb44 Merge pull request #77734 from dalexeev/doc-property-hint-type-string
Update `PROPERTY_HINT_TYPE_STRING` docs
2023-06-20 00:03:37 +02:00
09767d5749 Clarify move_towards does not go past final value 2023-06-14 11:36:20 +08:00
d5ad7bf23c Update PROPERTY_HINT_TYPE_STRING docs 2023-06-02 09:08:04 +03:00
379f28d7dc Merge pull request #77226 from aaronfranke/clamp
Document that clamp works with any type that supports greater/less than
2023-05-30 16:12:01 +02:00
17fb77223c Minor grammar fixes to documentation 2023-05-28 18:27:56 +02:00
d209857ea7 Document that clamp works with any type that supports greater/less than 2023-05-18 20:18:08 -05:00
06d02928b7 Document MIDI zero velocity quirk 2023-05-17 12:19:25 -07:00
fc92ee6bf4 Fix property usage docs referring to removed network flag 2023-05-14 12:18:26 +02:00