Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2024-11-23 05:03:37 +00:00
Code Issues Projects Releases Packages Wiki Activity

Updated JSDocs

Browse source
This commit is contained in:
Richard Davey 2020-09-14 15:02:21 +01:00
parent 951457c881
commit 87c8e75ece
1 changed files with 4 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
src/gameobjects/rope/Rope.js
View file

@ -948,9 +948,10 @@ var Rope = new Class({
/** /**
* This method enables rendering of the Rope vertices to the given Graphics instance. * This method enables rendering of the Rope vertices to the given Graphics instance.
* *
* If you enable this feature, you must call `Graphics.clear()` in your Scene `update`, * If you enable this feature, you **must** call `Graphics.clear()` in your Scene `update`,
* otherwise the Graphics instance will fill-in with draw calls. This is not done automatically * otherwise the Graphics instance you provide to debug will fill-up with draw calls,
* to allow for you to debug render multiple Rope objects to a single Graphics instance. * eventually crashing the browser. This is not done automatically to allow you to debug
* draw multiple Rope objects to a single Graphics instance.
* *
* The Rope class has a built-in debug rendering callback `Rope.renderDebugVerts`, however * The Rope class has a built-in debug rendering callback `Rope.renderDebugVerts`, however
* you can also provide your own callback to be used instead. Do this by setting the `callback` parameter. * you can also provide your own callback to be used instead. Do this by setting the `callback` parameter.