From 21618a6909efb649dd6630c84a8167f4da020070 Mon Sep 17 00:00:00 2001 From: Brandon Tilley Date: Sat, 13 Dec 2014 12:05:35 -0800 Subject: [PATCH] Update docs --- documentation/planet.html | 1 + 1 file changed, 1 insertion(+) diff --git a/documentation/planet.html b/documentation/planet.html index 2be7023..2d0c7cc 100644 --- a/documentation/planet.html +++ b/documentation/planet.html @@ -197,6 +197,7 @@ planet.onStop(function() { 
var canvas = document.getElementById('myCanvas');
 planet.draw(canvas);

+

Once you've called draw() on a planet, you should not call it again unless you first call stop().

planet.stop()

Stop drawing the planet to the canvas. This disables the internal draw loop. You can register functions to call when the planet is stopped using the onStop method; if you don't plan on reusing the planet, be sure to clean up timers and references to internal properties, if necessary, so that it can be garbage collected.

You can draw the planet to a new (or the same) canvas using the draw method as normal. All your plugins' onInit functions will fire, although the plugin function itself will not be called again.