godotengine / godotengine/godot-docs

Docs Improvement Suggestion: Tween.follow_property()

Open
#5,693 2 comments 3 reactions 0 assignees View on GitHub
area:class reference enhancement
Dominant language
reStructuredText
Stars
5.7k
Forks
3.8k
Avg merge
1d 20h
Merged PRs (30d)
25

Description

**Your Godot version:**
3.4.3

**Issue description:**
Docs clarification needed for Tween's follow_property() method. As described, it seems to imply target and object functionalities are swapped from actual implementation. Similar treatment may be needed for follow_method().

_Current:_
`Follows property of object and applies it on target_property of target, beginning from initial_val for duration seconds, delay seconds later.`

Current wording implies that the object's property is applied to the target, that is, that we are animating the target instead of the object. The implementation of the method animates the object based on the target, not the other way around.

_Suggested:_
`Animates property of object, beginning from initial_val, and follows target_property of target as its ending value, for duration seconds, delay seconds later.`

**URL to the documentation page (if already existing):**
https://docs.godotengine.org/en/stable/classes/class_tween.html#class-tween-method-follow-property

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.