Path follower

Introduction

Set position of game object on a path.

  • Author: Rex
  • Behavior of game object

Live demos

Usage

Sample code

Install plugin

Load minify file

  • Load plugin (minify file) in preload stage
    scene.load.plugin('rexpathfollowerplugin', 'https://raw.githubusercontent.com/rexrainbow/phaser3-rex-notes/master/dist/rexpathfollowerplugin.min.js', true);
    
  • Add path-follower behavior
    var pathFollower = scene.plugins.get('rexpathfollowerplugin').add(gameObject, config);
    

Import plugin

  • Install rex plugins from npm
    npm i phaser3-rex-plugins
    
  • Install plugin in configuration of game
    import PathFollowerPlugin from 'phaser3-rex-plugins/plugins/pathfollower-plugin.js';
    var config = {
        // ...
        plugins: {
            global: [{
                key: 'rexPathFollower',
                plugin: PathFollowerPlugin,
                start: true
            },
            // ...
            ]
        }
        // ...
    };
    var game = new Phaser.Game(config);
    
  • Add path-follower behavior
    var pathFollower = scene.plugins.get('rexPathFollower').add(gameObject, config);
    

Import class

  • Install rex plugins from npm
    npm i phaser3-rex-plugins
    
  • Import class
    import PathFollower from 'phaser3-rex-plugins/plugins/pathfollower.js';
    
  • Add path-follower behavior
    var pathFollower = new PathFollower(gameObject, config);
    

Create instance

// var path = scene.add.path();
var pathFollower = scene.plugins.get('rexPathFollower').add(gameObject, {
    // path: path,          // path object
    // t: 0,                // t: 0~1
    // rotateToPath: false,
    // rotationOffset: 0,
    // angleOffset: 0
});
  • path : Path object
  • t : Initial value of property t (0~1)
  • rotateToPath: Set true to change angle towards path
  • rotationOffset : Rotation offset in radian, or angleOffset in degrees

Move along path

Set pathFollower.t (0~1) to move along path

pathFollower.t = t;  // t: 0~1
// pathFollower.setT(t);

or tween pathFollower.t

var tween = scene.tweens.add({
    targets: pathFollower,
    t: 1,
    ease: 'Linear', // 'Cubic', 'Elastic', 'Bounce', 'Back'
    duration: 1000,
    repeat: 0,
    yoyo: false
});

Set path

pathFollower.setPath(path);

Set rotate-to-path

pathFollower.setRotateToPath(rotateToPath, rotationOffset);
  • rotateToPath : Set true to change angle towards path
  • rotationOffset : Rotation offset in radian