Skip to content

Docs Improvement Suggestion: Tween.follow_property() #5693

@metcalf-putnam

Description

@metcalf-putnam

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    area:class referenceIssues and PRs about the class reference, which should be addressed on the Godot engine repositoryenhancement

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions