Skip to content

Commit 340df7a

Browse files
committed
jsdocs update
1 parent 00638ae commit 340df7a

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

src/gameobjects/pathfollower/typedefs/PathConfig.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@
44
* @typedef {object} Phaser.GameObjects.PathFollower.Types.PathConfig
55
* @since 3.0.0
66
*
7-
* @property {number} duration - The duration of the path follow.
8-
* @property {number} from - The start position of the path follow, between 0 and 1.
9-
* @property {number} to - The end position of the path follow, between 0 and 1.
7+
* @property {number} duration - The duration of the path follow in ms. Must be `> 0`.
8+
* @property {number} [from=0] - The start position of the path follow, between 0 and 1. Must be less than `to`.
9+
* @property {number} [to=1] - The end position of the path follow, between 0 and 1. Must be more than `from`.
1010
* @property {boolean} [positionOnPath=false] - Whether to position the PathFollower on the Path using its path offset.
1111
* @property {boolean} [rotateToPath=false] - Should the PathFollower automatically rotate to point in the direction of the Path?
1212
* @property {number} [rotationOffset=0] - If the PathFollower is rotating to match the Path, this value is added to the rotation value. This allows you to rotate objects to a path but control the angle of the rotation as well.
13-
* @property {number} [startAt=0] - Current start position of the path follow, between 0 and 1.
13+
* @property {number} [startAt=0] - Current start position of the path follow, must be between `from` and `to`.
1414
*/

0 commit comments

Comments
 (0)