Commit Graph

314 Commits

Author SHA1 Message Date
Micky 90871bc800
Overhaul documentation about MIDI support
(cherry picked from commit 8723d116c4)
2024-03-11 15:03:28 +01:00
A Thousand Ships b6d78d8eb7 Clarify that `Callable` will not be encoded with `var_to_bytes`
(cherry picked from commit c909354396)
2024-01-25 17:40:45 +01:00
A Thousand Ships cc90979f35 Clarify that `@GlobalScope.clamp` does not do component-wise clamping
(cherry picked from commit e7dbb7a267)
2024-01-25 17:38:15 +01:00
kobewi 4296f0a771 Fill remaining global scope constant descriptions 2023-11-13 15:17:10 +01:00
Haoyu Qiu b2dcef4928 Explain circular references and how to break them
Also improves the documentation of `weakref`.
2023-11-11 10:07:48 +08:00
Danil Alexeev 0c2202c56e
GDScript: Fix incorrect error message for utility functions 2023-10-16 14:09:57 +03:00
RobTheFiveNine 5da63c5358
Add documentation on which buttons JOY_BUTTON_START corresponds to 2023-10-08 21:33:22 +01:00
Rémi Verschelde 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
Yuri Sizov 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
Jakub Janšta 74c937079c Add type_string() utility 2023-10-02 17:41:20 +02:00
etti 3a39de4e2f Add rotate_toward and angle_difference to GDScript and C# 2023-10-01 22:19:42 +02:00
A Thousand Ships e45927b2f2 Replace `radians` range hint with `radians_as_degrees` 2023-09-25 08:50:19 +02:00
Rémi Verschelde 38ca83e16f
Merge pull request #81464 from AcatXIo/fix-sign-nan
Fix `SIGN(NAN)` returning 1
2023-09-12 12:01:39 +02:00
AcatXIo 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
Aaron Franke 6f7eccc758
Add a type conversion method to Variant Utility and expose to scripting 2023-09-08 10:12:48 -05:00
Jcrespo 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
AttackButton 8908ac4e6e Add missing YEN, SECTION and OPENURL names to keycode mappings 2023-08-28 03:37:22 -03:00
Yuri Sizov 951ea2415b Make EditorInterface accessible as a singleton
- EditorPlugin.get_editor_interface() is removed as redundant.
2023-08-09 16:01:31 +02:00
Rémi Verschelde 3fa5a15a2c
Merge pull request #72091 from MewPurPur/fix-nearest-po2
Improve documentation of `nearest_po2()`
2023-08-07 14:42:49 +02:00
Haoyu Qiu 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
Rémi Verschelde 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
Rémi Verschelde 346f1ab86b
Bump version to 4.2-dev
Keep on waitin'
2023-07-05 22:07:03 +02:00
smix8 8e31d986c3 Fix GlobalScope doc link for NavigationServer3D
Fixes GlobalScope doc link for NavigationServer3D.
2023-06-25 19:04:56 +02:00
Ninni Pipping 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
Rémi Verschelde 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
Haoyu Qiu 09767d5749 Clarify move_towards does not go past final value 2023-06-14 11:36:20 +08:00
Danil Alexeev d5ad7bf23c
Update `PROPERTY_HINT_TYPE_STRING` docs 2023-06-02 09:08:04 +03:00
Yuri Sizov 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
Ninni Pipping 17fb77223c Minor grammar fixes to documentation 2023-05-28 18:27:56 +02:00
Aaron Franke d209857ea7
Document that clamp works with any type that supports greater/less than 2023-05-18 20:18:08 -05:00
voidshine 06d02928b7 Document MIDI zero velocity quirk 2023-05-17 12:19:25 -07:00
kleonc fc92ee6bf4 Fix property usage docs referring to removed network flag 2023-05-14 12:18:26 +02:00
Raul Santos a34207b812
Reorder PropertyHint enum to avoid breaking compat
Also syncs the Core enum with the C# enum for the source generators.
2023-05-12 01:48:07 +02:00
Rémi Verschelde fd4a06c515
Merge pull request #76906 from lawnjelly/safe_acos4_2
Make acos and asin safe
2023-05-11 13:33:37 +02:00
lawnjelly 50c5ed4876 Make acos and asin safe
A common bug with using acos and asin is that input outside -1 to 1 range will result in Nan output. This can occur due to floating point error in the input.

The standard solution is to provide safe_acos function with clamped input. For Godot it may make more sense to make the standard functions safe.
2023-05-11 08:34:34 +01:00
Rémi Verschelde 74e5ad5c60
Merge pull request #76165 from and-rad/safe-credentials
Store sensitive export options in dedicated credentials file
2023-05-10 12:47:07 +02:00
Andreas Raddau fab160ce70 Store sensitive export options in dedicated credentials file 2023-05-10 11:40:17 +02:00
smix8 a6ac305f96 Rework Navigation Avoidance
Rework Navigation Avoidance.
2023-05-10 05:01:58 +02:00
VolTer fb5cb735a2 Fixed edge cases of nearest_po2 function 2023-05-01 02:32:46 +02:00
Hugo Locurcio ec277d804e
Improve `print_rich()` documentation
- List all supported colors.
- Mention URL tag support limitations.
- Fix and tweak code example to do what it says.
- Remove outdated notice about lack of Windows support (but mention
  that only Windows 10 and later support ANSI code conversion).
2023-04-16 16:34:28 +02:00
Hugo Locurcio 3c4f0ca9c6
Document how to use logarithm of base 10 with `log()` 2023-03-26 22:23:13 +02:00
Dipal Zambare 8901986d56 Fix typo in the type-safe examples
Fix type in the type-safe examples of snapped, lerp and sign function.
2023-03-19 18:23:13 +01:00
Haoyu Qiu 1e0b8d6240 Hide internal settings from the classref
Default actions are no longer internal since we want to document them.
They are still hidden from the Project Setting dialog because we hid the
whole `input/` group manually.
2023-03-02 17:52:37 +08:00
Rémi Verschelde 1c1524a651
Bump version to 4.1-dev
Can't stop, won't stop, they said, huh?
2023-03-01 01:44:37 +01:00
George Marques ed81b165eb
Make max() and min() global functions only accept numbers
The behavior for those are not well defined for non-numeric arguments.
To avoid confusion the other types are forbidden.
2023-02-24 14:06:11 -03:00
Rémi Verschelde b2584629c8
Merge pull request #73195 from timothyqiu/weblate-comments
Improvements and fixes based on Weblate comments
2023-02-17 09:55:39 +01:00
Micky 436bbfebe2 Tweak `@GlobalScope` & `GDScript`'s documentation 2023-02-14 13:26:18 +01:00
Hugo Locurcio 42b7739321
Document unsupported features in Mobile and Compatibility rendering methods 2023-02-13 22:17:02 +01:00
Haoyu Qiu 84aee17901 Improvements and fixes based on Weblate comments
* Description of `ui_text_submit` action should be "Submit Text" instead of "Text Submitted".
* Spell out "Animation" instead of using "Anim.".
* Treat "Max" as regular word instead of writing "Max.".
* Use generic "Set %s" for action name instead of a dedicated "Set target_position".
* Add translator comment for:
    * "Inclusive" and "Self" in the profiler.
    * Places where it needs the context about being an editor progress label.
    * "Duplicated Animation Name" since it's refering to the new name of a duplicated animation.
    * Disambiguation of "View Plane Transform", "Paste Selects" and "Display Normal".
* Fix wrong undo action name for renaming an input action.
* Fix missing end quote in a shader error message.
* In class reference:
    * Fix duplicated "if" in the description of `signf()`.
    * Fix mismatched example output in `String.operator %()`.
    * Fix typo in the description of `Decal.texture_emission`.
    * Unify description of `String.match()` and `StringName.match()`.
2023-02-13 15:22:18 +08:00
Danil Alexeev c8e3d8b5d5
GDScript: Improve validation and documentation of `@export_flags` 2023-02-07 19:32:08 +03:00