Commit Graph

99 Commits

Author SHA1 Message Date
62bcb5c315 Docs: Fix typo and spacing in vector coordinates
Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
2025-06-16 15:44:20 +02:00
13f642d959 Replace XML codeblock spaces with tabs 2025-06-06 14:35:38 +02:00
1e82bafa3a Remove redundant info on the enum types used 2025-06-04 08:21:47 +08:00
8367e6243c Use float instead of integers for durations 2025-02-07 11:02:12 +01:00
be266138d7 Add tween_subtween method for nesting Tweens
No actual functionality yet

Actual subtween functionality implemented

Added documentation for Tween.tween_subtween and SubtweenTweener

Implemented some additional functions

`set_ease`, `set_trans`, and `set_delay`
Documentation only for `set_delay` so far, since I have tested it

Removed set_ease and set_trans

Upon further investigation, the way they are implemented for Tween doesn't appear to work here

Fixed indentation in documentation

Reset subtween when parent loops

Fix return type of `SubtweenTweener.set_delay`

Add notes to documentation

Apply suggestions from code review

Co-authored-by: Tomasz Chabora <kobewi4e@gmail.com>

Apply some suggested changes

- Remove excessive documentation
- Add Tween constructor that takes in SceneTree
- Make `SubtweenTweener::subtween` public so that `Tween` doesn't have to be a friend class

Remove unneeded friend class SceneTree

Remove superfluous documentation describing subtween behavior

Apply suggestions from code review

Co-authored-by: Tomasz Chabora <kobewi4e@gmail.com>

Apply suggestions from code review

Co-authored-by: Thaddeus Crews <repiteo@outlook.com>

Apply suggestions from code review

Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>

Early return from `tween_subtween` if the subtween is `null`
2025-01-03 14:28:48 -08:00
dbc0cc1437 Add Tween::ignore_time_scale 2024-12-22 18:39:54 +02:00
88e81ee730 Fix various typos and code style issues 2024-11-28 17:40:42 +01:00
a5c5504dc2 Merge pull request #98689 from Meorge/tween-docs
Improve `Tween.set_ease` and `Tween.set_trans` documentation
2024-11-12 12:12:59 -06:00
0f95061092 Merge pull request #98787 from Meorge/tween-docs-stop
Update docs for `Tween.stop` to clarify behavior
2024-11-12 09:28:06 -06:00
0304f8fd57 Update docs for Tween.stop to clarify behavior
Apply suggestions from code review

Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>
Co-authored-by: Micky <66727710+Mickeon@users.noreply.github.com>

Updated wording in comments to be more concise
2024-11-11 16:34:45 -08:00
47be06b6ea Update Tween.set_ease and Tween.set_trans to reflect that they only apply to later Tweeners
Update doc/classes/Tween.xml

Co-authored-by: Micky <66727710+Mickeon@users.noreply.github.com>

Update doc/classes/Tween.xml

Co-authored-by: Micky <66727710+Mickeon@users.noreply.github.com>

Fix whitespace issue

Remove an unnecessary linebreak

Update doc/classes/Tween.xml

Co-authored-by: Micky <66727710+Mickeon@users.noreply.github.com>

Fixed `set_trans` wording to match `set_ease` and removed static typing from examples
2024-11-11 11:43:45 -08:00
4ce5856384 Remove empty [b]Example:[/b] lines from the class reference 2024-08-19 01:00:52 +02:00
739cb2d9e1 Merge pull request #79758 from KoBeWi/understandment
Clarify `Tween.set_parallel()`
2024-02-19 00:07:16 +01:00
61bdbdd9ee Replace some "uncommon" words in class reference 2024-01-15 18:51:52 +01:00
d026b37abd Fix various typos in classref 2023-08-22 18:05:50 +08:00
45b757e5df Update C# example of tween_method in Tween class with a parameter to the lambda method 2023-07-28 13:46:33 +02:00
dbecf8bd1a Improve and clarify paused Tweens 2023-07-25 13:29:30 +02:00
207bd34aa5 Clarify Tween.set_parallel() 2023-07-21 20:17:32 +02: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
01f887ee4f Clarify when things with _IDLE and _PHYSICS enums will run 2023-06-20 13:25:26 -03:00
f53589b277 doc: Update Tween cheatsheet URL 2023-06-08 16:14:29 +02:00
780e21bcac Add TRANS_SPRING to Tween 2023-05-17 17:54:37 -04:00
4cb2085543 Add get_loops_left() function to Tween
Implements godotengine/godot-proposals#5141.

Adds a new get_loops_left() function to Tween, allowing developers to
reason about how many times a tweening sequence will repeat and whether
to expect finished or loop_finished as the next signal.

Co-authored-by: Tomek <kobewi4e@gmail.com>
2023-03-20 20:49:31 -07:00
9785b23a0a Discourage reusing Tweens 2023-03-04 19:51:52 +01:00
1c1524a651 Bump version to 4.1-dev
Can't stop, won't stop, they said, huh?
2023-03-01 01:44:37 +01:00
c4de2d433a Document default values for transition type and ease type. 2023-02-26 21:42:49 -08:00
7eb8325180 Fix C# examples in documentation
- Fix documentation after C# renames.
- Add missing `partial` in C# class declarations.
- Change `delta` parameter type to `double` in C#.
- Ensure parameters match base declaration.
- Use `$` string interpolation in C#.
- Fix invalid or outdated C# code.
- Changed some examples to follow our style guide more closely.
2023-01-31 19:04:07 +01:00
92e4b4e888 Update C# signal documentation and remove bind array
- Updates C# signal documentation and code examples to the new API in 4.0
- Replace all `nameof` usages with the exposed `StringName`
2023-01-23 16:45:37 +01:00
ddab3976fe Uppercase references to color constants in documentation 2023-01-13 22:56:22 +00:00
f7c611ab71 Style: Misc docs and comment style and language fixes
- Removed empty paragraphs in XML.
- Consistently use bold style for "Example:", on a new line.
- Fix usage of `[code]` when hyperlinks could be used (`[member]`, `[constant]`).
- Fix invalid usage of backticks for inline code in BBCode.
- Fix some American/British English spelling inconsistencies.
- Other minor fixes spotted along the way, including typo fixes with codespell.
- Don't specify `@GlobalScope` for `enum` and `constant`.
2022-11-02 19:01:18 +01:00
2316c3a3a9 Add new C# code blocks to class ref pages
- AStarGrid2D
- Engine
- Font
- Node
- OS
- Tweens
2022-09-19 19:38:29 +02:00
038cb677cb Add more clarifications about Tween processing 2022-09-11 17:39:35 +02:00
5361585832 [doc] Use "param" instead of "code" to refer to parameters
Co-authored-by: Yuri Sizov <11782833+YuriSizov@users.noreply.github.com>
2022-08-09 10:09:07 -04:00
c5d7115038 Rename the argument tag to param in XML documentation 2022-08-08 22:34:31 +03:00
aff30b649e Fix typos and improve clarity in Tween docs 2022-06-28 16:04:44 +02:00
6c01ef8f4c Miscellaneous Tween fixes 2022-04-28 21:19:01 +08:00
3017530e26 Make Tween.interpolate_value() static 2022-04-17 23:13:39 +02:00
e04ae8c8bc Add get_total_elapsed_time() to Tween 2022-03-29 13:34:05 +02:00
b68dd2e189 Add an XML schema for documentation
This makes it easier to spot syntax errors when editing the
class reference. The schema is referenced locally so validation
can still work offline.

Each class XML's schema conformance is also checked on GitHub Actions.
2022-02-15 00:03:31 +01:00
038977a985 Better handle infinite Tween loops 2022-01-29 00:36:39 +01:00
a095c4bf65 Merge pull request #56648 from KoBeWi/tween_pause() 2022-01-10 12:34:30 +01:00
205f56f226 Fix Tween pause behavior 2022-01-09 19:38:18 +01:00
cc5dac1e50 Restore Tween easing descriptions 2022-01-09 19:35:03 +01:00
b9c7c52a29 Fixed Tween::interpolate_value argument order. 2021-10-29 17:29:28 +02:00
8937fffc5e Add a warning about infinite Tween loops 2021-10-16 16:11:38 +02:00
5c1195e456 Add a special case for 0-time interpolations 2021-09-24 13:02:49 +02:00
266955d15f Improvements to Tweens' Variant types 2021-09-16 02:08:26 +02:00
7adf4cc9b5 doc: Use self-closing tags for return and argument
For the time being we don't support writing a description for those, preferring
having all details in the method's description.

Using self-closing tags saves half the lines, and prevents contributors from
thinking that they should write the argument or return documentation there.
2021-07-30 15:29:52 +02:00
3564c16cb8 Fix various typos with codespell
Found via `codespell -q 3 -S ./thirdparty,*.po,./DONORS.md -L ackward,ang,ans,ba,beng,cas,childs,childrens,dof,doubleclick,fave,findn,hist,inout,leapyear,lod,nd,numer,ois,ony,paket,seeked,sinc,switchs,te,uint`
2021-07-25 11:21:51 +02:00