From 80ef60d6cfcf23a051a7ce6f1a30587694ea5567 Mon Sep 17 00:00:00 2001 From: Brandon Tilley Date: Sat, 13 Dec 2014 12:04:48 -0800 Subject: [PATCH] Update planet#draw docs --- site/public/documentation/planet.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/site/public/documentation/planet.md b/site/public/documentation/planet.md index d856cbe..64eee54 100644 --- a/site/public/documentation/planet.md +++ b/site/public/documentation/planet.md @@ -157,6 +157,8 @@ 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.