Added setMaxWidth docs. Fix phaserjs#4997

photonstorm · photonstorm · commit 6bf36083a88d · 2020-09-22T16:48:38.000+01:00
diff --git a/src/gameobjects/bitmaptext/static/BitmapText.js b/src/gameobjects/bitmaptext/static/BitmapText.js
@@ -771,6 +771,8 @@ var BitmapText = new Class({
     /**
      * Sets the maximum display width of this BitmapText in pixels.
      *
+     * Note: This has no effect for Dynamic BitmapText. You should enforce max widths via your display callback.
+     *
      * If `BitmapText.text` is longer than `maxWidth` then the lines will be automatically wrapped
      * based on the previous whitespace character found in the line.
      *

Original file line number	Diff line number	Diff line change
`@@ -771,6 +771,8 @@ var BitmapText = new Class({`
`771`	`771`	`/**`
`772`	`772`	`* Sets the maximum display width of this BitmapText in pixels.`
`773`	`773`	`*`
	`774`	`+ * Note: This has no effect for Dynamic BitmapText. You should enforce max widths via your display callback.`
	`775`	`+ *`
`774`	`776`	* If `BitmapText.text` is longer than `maxWidth` then the lines will be automatically wrapped
`775`	`777`	`* based on the previous whitespace character found in the line.`
`776`	`778`	`*`