Filter
Phaser . Physics . Arcade . StaticBody
Phaser . Physics . Arcade . StaticBody
A Static Arcade Physics Body.
A Static Body never moves, and isn't automatically synchronized with its parent Game Object. That means if you make any change to the parent's origin, position, or scale after creating or adding the body, you'll need to update the Static Body manually.
A Static Body can collide with other Bodies, but is never moved by collisions.
Its dynamic counterpart is Phaser.Physics.Arcade.Body.
Constructor:
new StaticBody(world, [gameObject])
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| world | Phaser.Physics.Arcade.World |
The Arcade Physics simulation this Static Body belongs to. |
|
| gameObject | Phaser.GameObjects.GameObject | <optional> |
The Game Object this Body belongs to. As of Phaser 3.60 this is now optional. |
Extends
Members
Description:
A constant false value expected by the Arcade Physics simulation.
Type:
Description:
This property is kept for compatibility with Dynamic Bodies. Avoid using it.
Description:
The lowest y coordinate of the area of the StaticBody. (y + height)
Type:
Description:
Rebound, or restitution, following a collision, relative to 1. Always zero for a Static Body.
Type:
Description:
The center of the Static Body's boundary.
This is the midpoint of its position (top-left corner) and its bottom-right corner.
Type:
Description:
Whether this StaticBody is checked for collisions and for which directions. You can set checkCollision.none = false to disable collision checks.
Description:
Whether this StaticBody interacts with the world boundary. Always false for a Static Body. (Static Bodies never collide with the world boundary.)
Type:
Description:
The Arcade Physics Body Collision Category.
This can be set to any valid collision bitfield value.
See the setCollisionCategory method for more details.
Type:
Description:
The Arcade Physics Body Collision Mask.
See the setCollidesWith method for more details.
Type:
Description:
A flag disabling the default horizontal separation of colliding bodies. Pass your own collideHandler to the collider.
Type:
Description:
A flag disabling the default vertical separation of colliding bodies. Pass your own collideHandler to the collider.
Type:
Description:
The color of this Static Body on the debug display.
Type:
Description:
Whether the Static Body's boundary is drawn to the debug display.
Type:
Description:
Whether this StaticBody has ever overlapped with another while both were not moving.
Type:
Description:
Whether this Static Body is updated by the physics simulation.
Type:
Description:
The Game Object this Static Body belongs to.
As of Phaser 3.60 this is now optional and can be undefined.
Description:
Gravitational force applied specifically to this Body. Values are in pixels per second squared. Always zero for a Static Body.
Type:
Description:
Half the Static Body's height, in pixels. If the Static Body is circular, this is also the Static Body's radius.
Type:
Description:
Half the Static Body's width, in pixels. If the Static Body is circular, this is also the Static Body's radius.
Type:
Description:
The height of the Static Body's boundary, in pixels. If the Static Body is circular, this is also the Static Body's diameter.
Type:
Description:
Whether this object can be moved by collisions with another body.
Type:
Description:
A quick-test flag that signifies this is a Body, used in the World collision handler.
Type:
Description:
Whether this Static Body's boundary is circular (true) or rectangular (false).
Type:
Description:
Returns the left-most x coordinate of the area of the StaticBody.
Type:
Description:
The StaticBody's inertia, relative to a default unit (1). With bounce, this affects the exchange of momentum (velocities) during collisions.
Type:
Description:
The offset set by Phaser.Physics.Arcade.StaticBody#setCircle or Phaser.Physics.Arcade.StaticBody#setSize.
This doesn't affect the Static Body's position, because a Static Body does not follow its Game Object.
Type:
Description:
Whether the simulation emits a collide event when this StaticBody collides with another.
Type:
Description:
Whether the simulation emits an overlap event when this StaticBody overlaps with another.
Type:
Description:
Whether the simulation emits a worldbounds event when this StaticBody collides with the world boundary.
Always false for a Static Body. (Static Bodies never collide with the world boundary and never trigger a worldbounds event.)
Type:
Description:
The amount of overlap (before separation), if this StaticBody is circular and colliding with another circular body.
Type:
Description:
The amount of horizontal overlap (before separation), if this Body is colliding with another.
Type:
Description:
The amount of vertical overlap (before separation), if this Body is colliding with another.
Type:
Description:
The StaticBody's physics type (static by default).
Type:
Description:
The position of this Static Body within the simulation.
Type:
Description:
Sets if this Body can be pushed by another Body.
A body that cannot be pushed will reflect back all of the velocity it is given to the colliding body. If that body is also not pushable, then the separation will be split between them evenly.
If you want your body to never move or seperate at all, see the setImmovable method.
By default, Static Bodies are not pushable.
Type:
Description:
If this Static Body is circular, this is the radius of the boundary, as set by Phaser.Physics.Arcade.StaticBody#setCircle, in pixels.
Equal to halfWidth.
Type:
Description:
The right-most x coordinate of the area of the StaticBody.
Type:
Description:
The highest y coordinate of the area of the StaticBody.
Type:
Description:
This property is kept for compatibility with Dynamic Bodies. Avoid using it.
Description:
A constant zero velocity used by the Arcade Physics simulation for calculations.
Type:
Description:
This property is kept for compatibility with Dynamic Bodies. Avoid using it. The values are always false for a Static Body.
Description:
The width of the Static Body's boundary, in pixels. If the Static Body is circular, this is also the Static Body's diameter.
Type:
Description:
The Arcade Physics simulation this Static Body belongs to.
Description:
The x coordinate of the StaticBody.
Type:
Description:
The y coordinate of the StaticBody.
Type:
Methods
Description:
Adds the given Collision Category to the list of those that this Arcade Physics Body will collide with.
Parameters:
| name | type | description |
|---|---|---|
| category | number |
The collision category to add. |
Returns:
Description:
This Game Object.
Description:
The absolute (non-negative) change in this StaticBody's horizontal position from the previous step. Always zero.
Returns:
Description:
Always zero for a Static Body.
Type:
- number
Description:
The absolute (non-negative) change in this StaticBody's vertical position from the previous step. Always zero.
Returns:
Description:
Always zero for a Static Body.
Type:
- number
Description:
The change in this StaticBody's horizontal position from the previous step. Always zero.
Returns:
Description:
The change in this StaticBody's velocity from the previous step. Always zero.
Type:
- number
Description:
The change in this StaticBody's vertical position from the previous step. Always zero.
Returns:
Description:
The change in this StaticBody's velocity from the previous step. Always zero.
Type:
- number
Description:
The change in this StaticBody's rotation from the previous step. Always zero.
Returns:
Description:
The change in this StaticBody's rotation from the previous step. Always zero.
Type:
- number
Description:
Disables this Body and marks it for destruction during the next step.
Description:
Draws a graphical representation of the StaticBody for visual debugging purposes.
Parameters:
| name | type | description |
|---|---|---|
| graphic | Phaser.GameObjects.Graphics |
The Graphics object to use for the debug drawing of the StaticBody. |
Description:
Returns the x and y coordinates of the top left and bottom right points of the StaticBody.
Parameters:
| name | type | description |
|---|---|---|
| obj | Phaser.Types.Physics.Arcade.ArcadeBodyBounds |
The object which will hold the coordinates of the bounds. |
Returns:
Description:
The same object that was passed with x, y, right and bottom values matching the respective values of the StaticBody.
Description:
Checks to see if a given x,y coordinate is colliding with this Static Body.
Parameters:
| name | type | description |
|---|---|---|
| x | number |
The x coordinate to check against this body. |
| y | number |
The y coordinate to check against this body. |
Returns:
Description:
true if the given coordinate lies within this body, otherwise false.
Type:
- boolean
Description:
Removes the given Collision Category from the list of those that this Arcade Physics Body will collide with.
Parameters:
| name | type | description |
|---|---|---|
| category | number |
The collision category to add. |
Returns:
Description:
This Game Object.
Description:
Resets this Static Body to its parent Game Object's position.
If x and y are given, the parent Game Object is placed there and this Static Body is centered on it.
Otherwise this Static Body is centered on the Game Object's current position.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| x | number | <optional> |
The x coordinate to reset the body to. If not given will use the parent Game Object's coordinate. |
| y | number | <optional> |
The y coordinate to reset the body to. If not given will use the parent Game Object's coordinate. |
Description:
Resets the Collision Category and Mask back to the defaults, which is to collide with everything.
Returns:
Description:
This Game Object.
Description:
Sets this Static Body to have a circular body and sets its size and position.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| radius | number |
The radius of the StaticBody, in pixels. |
|
| offsetX | number | <optional> |
The horizontal offset of the StaticBody from its Game Object, in pixels. |
| offsetY | number | <optional> |
The vertical offset of the StaticBody from its Game Object, in pixels. |
Returns:
Description:
This Static Body object.
Description:
Sets all of the Collision Categories that this Arcade Physics Body will collide with. You can either pass a single category value, or an array of them.
Calling this method will reset all of the collision categories, so only those passed to this method are enabled.
If you wish to add a new category to the existing mask, call
the addCollisionCategory method.
If you wish to reset the collision category and mask, call
the resetCollisionCategory method.
Parameters:
| name | type | description |
|---|---|---|
| categories | number | Array.<number> |
The collision category to collide with, or an array of them. |
Returns:
Description:
This Game Object.
Description:
Sets the Collision Category that this Arcade Physics Body will use in order to determine what it can collide with.
It can only have one single category assigned to it.
If you wish to reset the collision category and mask, call
the resetCollisionCategory method.
Parameters:
| name | type | description |
|---|---|---|
| category | number |
The collision category. |
Returns:
Description:
This Game Object.
Description:
Changes the Game Object this Body is bound to. First it removes its reference from the old Game Object, then sets the new one. You can optionally update the position and dimensions of this Body to reflect that of the new Game Object.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| gameObject | Phaser.GameObjects.GameObject |
The new Game Object that will own this Body. |
||
| update | boolean | <optional> | true |
Reposition and resize this Body to match the new Game Object? |
Returns:
Description:
This Static Body object.
Description:
Sets the Mass of the StaticBody. Will set the Mass to 0.1 if the value passed is less than or equal to zero.
Parameters:
| name | type | description |
|---|---|---|
| value | number |
The value to set the Mass to. Values of zero or less are changed to 0.1. |
Returns:
Description:
This Static Body object.
Description:
Positions the Static Body at an offset from its Game Object.
Parameters:
| name | type | description |
|---|---|---|
| x | number |
The horizontal offset of the Static Body from the Game Object's |
| y | number |
The vertical offset of the Static Body from the Game Object's |
Returns:
Description:
This Static Body object.
Description:
Sets the size of the Static Body.
When center is true, also repositions it.
Resets the width and height to match current frame, if no width and height provided and a frame is found.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| width | number | <optional> |
The width of the Static Body in pixels. Cannot be zero. If not given, and the parent Game Object has a frame, it will use the frame width. |
|
| height | number | <optional> |
The height of the Static Body in pixels. Cannot be zero. If not given, and the parent Game Object has a frame, it will use the frame height. |
|
| center | boolean | <optional> | true |
Place the Static Body's center on its Game Object's center. Only works if the Game Object has the |
Returns:
Description:
This Static Body object.
Description:
NOOP function. A Static Body cannot be stopped.
Returns:
Description:
This Static Body object.
Description:
Updates the StaticBody's center from its position and dimensions.
Description:
Syncs the Static Body's position and size with its parent Game Object.
Returns:
Description:
This Static Body object.
Description:
Checks to see if the given Collision Category will collide with this Arcade Physics object or not.
Parameters:
| name | type | description |
|---|---|---|
| category | number |
Collision category value to test. |
Returns:
Description:
true if the given category will collide with this object, otherwise false.
Type:
- boolean
Description:
Indicates whether the StaticBody is going to be showing a debug visualization during postUpdate.
Returns:
Description:
Whether or not the StaticBody is going to show the debug visualization during postUpdate.
Type:
- boolean