/** * @author Richard Davey * @copyright 2018 Photon Storm Ltd. * @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License} */ declare var Class: any; declare var DegToRad: any; declare var GetBoolean: any; declare var GetValue: any; declare var Sprite: any; declare var TWEEN_CONST: any; declare var Vector2: any; /** * Settings for a PathFollower. * * @typedef {object} PathConfig * * @property {number} duration - The duration of the path follow. * @property {number} from - The start position of the path follow, between 0 and 1. * @property {number} to - The end position of the path follow, between 0 and 1. * @property {boolean} [positionOnPath=false] - Whether to position the PathFollower on the Path using its path offset. * @property {boolean} [rotateToPath=false] - Should the PathFollower automatically rotate to point in the direction of the Path? * @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. * @property {boolean} [verticalAdjust=false] - [description] */ /** * @classdesc * A PathFollower Game Object. * * A PathFollower is a Sprite Game Object with some extra helpers to allow it to follow a Path automatically. * * Anything you can do with a standard Sprite can be done with this PathFollower, such as animate it, tint it, * scale it and so on. * * PathFollowers are bound to a single Path at any one time and can traverse the length of the Path, from start * to finish, forwards or backwards, or from any given point on the Path to its end. They can optionally rotate * to face the direction of the path, be offset from the path coordinates or rotate independently of the Path. * * @class PathFollower * @extends Phaser.GameObjects.Sprite * @memberOf Phaser.GameObjects * @constructor * @since 3.0.0 * * @param {Phaser.Scene} scene - The Scene to which this PathFollower belongs. * @param {Phaser.Curves.Path} path - The Path this PathFollower is following. It can only follow one Path at a time. * @param {number} x - The horizontal position of this Game Object in the world. * @param {number} y - The vertical position of this Game Object in the world. * @param {string} texture - The key of the Texture this Game Object will use to render with, as stored in the Texture Manager. * @param {(string|integer)} [frame] - An optional frame from the Texture this Game Object is rendering with. */ declare var PathFollower: any;