deprecate Engine.run alias replaced by Runner.run

liabru · Apr 14, 2021 · 5817046 · 5817046
1 parent 9303119
commit 5817046
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/src/core/Engine.js b/src/core/Engine.js
@@ -305,7 +305,8 @@ var Body = require('../body/Body');
     };
 
     /**
-     * An alias for `Runner.run`, see `Matter.Runner` for more information.
+     * A deprecated alias for `Runner.run`, use `Matter.Runner.run(engine)` instead and see `Matter.Runner` for more information.
+     * @deprecated use Matter.Runner.run(engine) instead
      * @method run
      * @param {engine} engine
      */

diff --git a/src/module/main.js b/src/module/main.js
@@ -28,3 +28,7 @@ Matter.Svg = require('../geometry/Svg');
 Matter.Vector = require('../geometry/Vector');
 Matter.Vertices = require('../geometry/Vertices');
 Matter.World = require('../body/World');
+
+// temporary back compatibility
+Matter.Engine.run = Matter.Runner.run;
+Matter.Common.deprecated(Matter.Engine, 'run', 'Engine.run ➤ use Matter.Runner.run(engine) instead');