Skip to content

Commit 7d8302e

Browse files
committed
Added mention about masks to docs
1 parent 87791be commit 7d8302e

1 file changed

Lines changed: 6 additions & 2 deletions

File tree

plugins/spine/src/container/SpineContainer.js

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ var SpineContainerRender = require('./SpineContainerRender');
1313
* A Spine Container is a special kind of Container created specifically for Spine Game Objects.
1414
*
1515
* You have all of the same features of a standard Container, but the rendering functions are optimized specifically
16-
* for Spine Game Objects. You must only add ever Spine Game Objects to this type of Container. Although Phaser will
17-
* not prevent you from adding other types, they will not render and are likely to throw runtime errors.
16+
* for Spine Game Objects. You must only add ever Spine Game Objects, or other Spine Containers, to this type of Container.
17+
* Although Phaser will not prevent you from adding other types, they will not render and are likely to throw runtime errors.
1818
*
1919
* To create one in a Scene, use the factory methods:
2020
*
@@ -28,6 +28,10 @@ var SpineContainerRender = require('./SpineContainerRender');
2828
* this.make.spinecontainer();
2929
* ```
3030
*
31+
* Note that you should not nest Spine Containers inside regular Containers if you wish to use masks on the
32+
* container children. You can, however, mask children of Spine Containers if they are embedded within other
33+
* Spine Containers. In short, if you need masking, don't mix and match the types.
34+
*
3135
* See the Container documentation for further details about what Containers can do.
3236
*
3337
* @class SpineContainer

0 commit comments

Comments
 (0)