Phaser API Documentation

curve([x], [y], [curve], [fillColor], [fillAlpha])


Creates a new Curve Shape Game Object and adds it to the Scene.

Note: This method will only be available if the Curve Game Object has been built into Phaser.

The Curve Shape is a Game Object that can be added to a Scene, Group or Container. You can treat it like any other Game Object in your game, such as tweening it, scaling it, or enabling it for input or physics. It provides a quick and easy way for you to render this shape in your game without using a texture, while still taking advantage of being fully batched in WebGL.

This shape supports both fill and stroke colors.

To render a Curve Shape you must first create a Phaser.Curves.Curve object, then pass it to the Curve Shape in the constructor.

The Curve shape also has a smoothness property and corresponding setSmoothness method. This allows you to control how smooth the shape renders in WebGL, by controlling the number of iterations that take place during construction. Increase and decrease the default value for smoother, or more jagged, shapes.


name type arguments description
x number <optional>

The horizontal position of this Game Object in the world.

y number <optional>

The vertical position of this Game Object in the world.

curve Phaser.Curves.Curve <optional>

The Curve object to use to create the Shape.

fillColor number <optional>

The color the curve will be filled with, i.e. 0xff0000 for red.

fillAlpha number <optional>

The alpha the curve will be filled with. You can also set the alpha of the overall Shape using its alpha property.


The Game Object that was created.

Since: 3.13.0