Skip to content

Commit 87c8e75

Browse files
committed
Updated JSDocs
1 parent 951457c commit 87c8e75

1 file changed

Lines changed: 4 additions & 3 deletions

File tree

src/gameobjects/rope/Rope.js

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -948,9 +948,10 @@ var Rope = new Class({
948948
/**
949949
* This method enables rendering of the Rope vertices to the given Graphics instance.
950950
*
951-
* If you enable this feature, you must call `Graphics.clear()` in your Scene `update`,
952-
* otherwise the Graphics instance will fill-in with draw calls. This is not done automatically
953-
* to allow for you to debug render multiple Rope objects to a single Graphics instance.
951+
* If you enable this feature, you **must** call `Graphics.clear()` in your Scene `update`,
952+
* otherwise the Graphics instance you provide to debug will fill-up with draw calls,
953+
* eventually crashing the browser. This is not done automatically to allow you to debug
954+
* draw multiple Rope objects to a single Graphics instance.
954955
*
955956
* The Rope class has a built-in debug rendering callback `Rope.renderDebugVerts`, however
956957
* you can also provide your own callback to be used instead. Do this by setting the `callback` parameter.

0 commit comments

Comments
 (0)