xsge.physics

Contents

• xsge.physics
  • xsge.physics Classes
    • xsge.physics.Collider
      • xsge.physics.Collider Methods
      • xsge.physics.Collider Event Methods
    • xsge.physics.SolidLeft
      • xsge.physics.SolidLeft Event Methods
    • xsge.physics.SolidRight
      • xsge.physics.SolidRight Event Methods
    • xsge.physics.SolidTop
      • xsge.physics.SolidTop Event Methods
    • xsge.physics.SolidBottom
      • xsge.physics.SolidBottom Event Methods
    • xsge.physics.Solid
      • xsge.physics.Solid Event Methods
    • xsge.physics.SlopeTopLeft
      • xsge.physics.SlopeTopLeft Event Methods
    • xsge.physics.SlopeTopRight
      • xsge.physics.SlopeTopRight Event Methods
    • xsge.physics.SlopeBottomLeft
      • xsge.physics.SlopeBottomLeft Event Methods
    • xsge.physics.SlopeBottomRight
      • xsge.physics.SlopeBottomRight Event Methods
    • xsge.physics.MobileWall
      • xsge.physics.MobileWall methods

This module provides an easy-to-use framework for collision physics. This is especially useful for platformers, though it can also be useful for other types of games.

Note

This collision system supports plain rectangle-based collision detection ONLY. Attempting to use precise or ellipse collision detection will not work as you expect, and may often not even work at all. This is because implementing support for such mask-based collision detection would be guaranteed to be slow, unreliable, and needlessly complicated; it’s not worth it.

If you must use precise collision detection, consider doing so with a separate object that follows the appropriate Collider object.

xsge.physics Classes

xsge.physics.Collider

class xsge.physics.Collider(x, y, z=0, sprite=None, visible=True, active=True, checks_collisions=True, tangible=True, bbox_x=None, bbox_y=None, bbox_width=None, bbox_height=None, regulate_origin=False, collision_ellipse=False, collision_precise=False, xvelocity=0, yvelocity=0, xacceleration=0, yacceleration=0, xdeceleration=0, ydeceleration=0, image_index=0, image_origin_x=None, image_origin_y=None, image_fps=None, image_xscale=1, image_yscale=1, image_rotation=0, image_alpha=255, image_blend=None)

Class for objects which have physics interactions.

Note

This class depends on use of Collider.move_x() and Collider.move_y() to handle physics interactions. event_update_position() uses these methods, so speed attributes will work properly, but changing x and y manually will not cause any physics to occur.

xsge.physics.Collider Methods

Collider.move_x(move, absolute=False)

Move the object horizontally, handling physics.

Arguments:

• move – The amount to add to x.
• absolute – If set to True, the distance moved horizontally is absolute, i.e. will not be reduced as a result of vertical movement caused by slopes. Otherwise, any vertical movement caused by slopes will result in a reduction of horizontal movement.

Collider.move_y(move, absolute=False)

Move the object vertically, handling physics.

Arguments:

• move – The amount to add to y.
• absolute – If set to True, the distance moved vertically is absolute, i.e. will not be reduced as a result of horizontal movement caused by slopes. Otherwise, any horizontal movement caused by slopes will result in a reduction of vertical movement.

Collider.get_left_touching_wall()

Return a list of SolidRight objects whose right sides are touching the left side of this object.

Collider.get_right_touching_wall()

Return a list of SolidLeft objects whose left sides are touching the right side of this object.

Collider.get_top_touching_wall()

Return a list of SolidTop objects whose top sides are touching the bottom side of this object.

Collider.get_bottom_touching_wall()

Return a list of SolidBottom objects whose bottom sides are touching the top side of this object.

Collider.get_left_touching_slope()

Return a list of SlopeTopRight and SlopeBottomRight objects whose right sides are touching the left side of this object.

Collider.get_right_touching_slope()

Return a list of SlopeTopLeft and SlopeBottomLeft objects whose left sides are touching the right side of this object.

Collider.get_top_touching_slope()

Return a list of SlopeBottomLeft and SlopeBottomRight objects whose bottom sides are touching the top side of this object.

Collider.get_bottom_touching_slope()

Return a list of SlopeTopLeft and SlopeTopRight objects whose top sides are touching the bottom side of this object.

xsge.physics.Collider Event Methods

Collider.event_physics_collision_left(other, move_loss)

Called when the left side of the collider collides with a wall or slope in the sense of the physics system, rather than in the sense of SGE collision detection.

Arguments:

• move_loss – The amount of movement that was prevented by the collision in pixels. For example, if the object would have moved 6 pixels, but only moved 2 pixels as a result of this collision, this value will be 4. This can be used to undo such a reduction in movement.

See the documentation for sge.Object.event_collision() for more information.

Collider.event_physics_collision_right(other, move_loss)

Called when the right side of the collider collides with a wall or slope in the sense of the physics system, rather than in the sense of SGE collision detection. See the documentation for xsge.physics.Collider.event_physics_collision_left() for more information.

Collider.event_physics_collision_top(other, move_loss)

Called when the top side of the collider collides with a wall or slope in the sense of the physics system, rather than in the sense of SGE collision detection. See the documentation for xsge.physics.Collider.event_physics_collision_left() for more information.

Collider.event_physics_collision_bottom(other, move_loss)

Called when the bottom side of the collider collides with a wall or slope in the sense of the physics system, rather than in the sense of SGE collision detection. See the documentation for xsge.physics.Collider.event_physics_collision_left() for more information.

xsge.physics.SolidLeft

class xsge.physics.SolidLeft(x, y, z=0, sprite=None, visible=True, active=True, checks_collisions=True, tangible=True, bbox_x=None, bbox_y=None, bbox_width=None, bbox_height=None, regulate_origin=False, collision_ellipse=False, collision_precise=False, xvelocity=0, yvelocity=0, xacceleration=0, yacceleration=0, xdeceleration=0, ydeceleration=0, image_index=0, image_origin_x=None, image_origin_y=None, image_fps=None, image_xscale=1, image_yscale=1, image_rotation=0, image_alpha=255, image_blend=None)

Class for walls which stop movement of Collider objects from the top.

xsge.physics.SolidLeft Event Methods

SolidLeft.event_physics_collision_left(other)

Called when the left side of the wall collides with a collider in the sense of the physics system, rather than in the sense of SGE collision detection. See the documentation for sge.Object.event_collision() for more information.

xsge.physics.SolidRight

class xsge.physics.SolidRight(x, y, z=0, sprite=None, visible=True, active=True, checks_collisions=True, tangible=True, bbox_x=None, bbox_y=None, bbox_width=None, bbox_height=None, regulate_origin=False, collision_ellipse=False, collision_precise=False, xvelocity=0, yvelocity=0, xacceleration=0, yacceleration=0, xdeceleration=0, ydeceleration=0, image_index=0, image_origin_x=None, image_origin_y=None, image_fps=None, image_xscale=1, image_yscale=1, image_rotation=0, image_alpha=255, image_blend=None)

Class for walls which stop movement of Collider objects from the right.

xsge.physics.SolidRight Event Methods

SolidRight.event_physics_collision_right(other)

Called when the right side of the wall collides with a collider in the sense of the physics system, rather than in the sense of SGE collision detection. See the documentation for sge.Object.event_collision() for more information.

xsge.physics.SolidTop

class xsge.physics.SolidTop(x, y, z=0, sprite=None, visible=True, active=True, checks_collisions=True, tangible=True, bbox_x=None, bbox_y=None, bbox_width=None, bbox_height=None, regulate_origin=False, collision_ellipse=False, collision_precise=False, xvelocity=0, yvelocity=0, xacceleration=0, yacceleration=0, xdeceleration=0, ydeceleration=0, image_index=0, image_origin_x=None, image_origin_y=None, image_fps=None, image_xscale=1, image_yscale=1, image_rotation=0, image_alpha=255, image_blend=None)

Class for walls which stop movement of Collider objects from the top.

xsge.physics.SolidTop Event Methods

SolidTop.event_physics_collision_top(other)

Called when the top side of the wall collides with a collider in the sense of the physics system, rather than in the sense of SGE collision detection. See the documentation for sge.Object.event_collision() for more information.

xsge.physics.SolidBottom

class xsge.physics.SolidBottom(x, y, z=0, sprite=None, visible=True, active=True, checks_collisions=True, tangible=True, bbox_x=None, bbox_y=None, bbox_width=None, bbox_height=None, regulate_origin=False, collision_ellipse=False, collision_precise=False, xvelocity=0, yvelocity=0, xacceleration=0, yacceleration=0, xdeceleration=0, ydeceleration=0, image_index=0, image_origin_x=None, image_origin_y=None, image_fps=None, image_xscale=1, image_yscale=1, image_rotation=0, image_alpha=255, image_blend=None)

Class for walls which stop movement of Collider objects from the bottom.

xsge.physics.SolidBottom Event Methods

SolidBottom.event_physics_collision_bottom(other)

Called when the bottom side of the wall collides with a collider in the sense of the physics system, rather than in the sense of SGE collision detection. See the documentation for sge.Object.event_collision() for more information.

xsge.physics.Solid

class xsge.physics.Solid(x, y, z=0, sprite=None, visible=True, active=True, checks_collisions=True, tangible=True, bbox_x=None, bbox_y=None, bbox_width=None, bbox_height=None, regulate_origin=False, collision_ellipse=False, collision_precise=False, xvelocity=0, yvelocity=0, xacceleration=0, yacceleration=0, xdeceleration=0, ydeceleration=0, image_index=0, image_origin_x=None, image_origin_y=None, image_fps=None, image_xscale=1, image_yscale=1, image_rotation=0, image_alpha=255, image_blend=None)

Inherits SolidLeft, SolidRight, SolidTop, and SolidBottom. Meant to be a convenient parent class for walls that should stop movement in all directions.

xsge.physics.Solid Event Methods

Solid.event_physics_collision_left(other)

Called when the left side of the wall collides with a collider in the sense of the physics system, rather than in the sense of SGE collision detection. See the documentation for sge.Object.event_collision() for more information.

Solid.event_physics_collision_right(other)

Called when the right side of the wall collides with a collider in the sense of the physics system, rather than in the sense of SGE collision detection. See the documentation for sge.Object.event_collision() for more information.

Solid.event_physics_collision_top(other)

Called when the top side of the wall collides with a collider in the sense of the physics system, rather than in the sense of SGE collision detection. See the documentation for sge.Object.event_collision() for more information.

Solid.event_physics_collision_bottom(other)

Called when the bottom side of the wall collides with a collider in the sense of the physics system, rather than in the sense of SGE collision detection. See the documentation for sge.Object.event_collision() for more information.

xsge.physics.SlopeTopLeft

class xsge.physics.SlopeTopLeft(x, y, z=0, sprite=None, visible=True, active=True, checks_collisions=True, tangible=True, bbox_x=None, bbox_y=None, bbox_width=None, bbox_height=None, regulate_origin=False, collision_ellipse=False, collision_precise=False, xvelocity=0, yvelocity=0, xacceleration=0, yacceleration=0, xdeceleration=0, ydeceleration=0, image_index=0, image_origin_x=None, image_origin_y=None, image_fps=None, image_xscale=1, image_yscale=1, image_rotation=0, image_alpha=255, image_blend=None)

A parent class for slopes which point in some direction upwards and to the left.

Slopes of this type go from the bottom-left corner to the top-right corner of the bounding box.

xsticky_top

If set to True, a collider that moves to the left while touching the top side of the slope will attempt to keep touching the top side of the slope by moving downward.

ysticky_left

If set to True, a collider that moves upward while touching the left side of the slope will attempt to keep touching the left side of the slope by moving to the right.

xsge.physics.SlopeTopLeft Event Methods

SlopeTopLeft.event_physics_collision_left(other)

Called when the left side of the slope collides with a collider in the sense of the physics system, rather than in the sense of SGE collision detection. See the documentation for sge.Object.event_collision() for more information.

SlopeTopLeft.event_physics_collision_top(other)

Called when the top side of the slope collides with a collider in the sense of the physics system, rather than in the sense of SGE collision detection. See the documentation for sge.Object.event_collision() for more information.

xsge.physics.SlopeTopRight

class xsge.physics.SlopeTopRight(x, y, z=0, sprite=None, visible=True, active=True, checks_collisions=True, tangible=True, bbox_x=None, bbox_y=None, bbox_width=None, bbox_height=None, regulate_origin=False, collision_ellipse=False, collision_precise=False, xvelocity=0, yvelocity=0, xacceleration=0, yacceleration=0, xdeceleration=0, ydeceleration=0, image_index=0, image_origin_x=None, image_origin_y=None, image_fps=None, image_xscale=1, image_yscale=1, image_rotation=0, image_alpha=255, image_blend=None)

A parent class for slopes which point in some direction upwards and to the right.

Slopes of this type go from the top-left corner to the bottom-right corner of the bounding box.

xsticky_top

If set to True, a collider that moves to the right while touching the top side of the slope will attempt to keep touching the top side of the slope by moving downward.

ysticky_right

If set to True, a collider that moves upward while touching the right side of the slope will attempt to keep touching the right side of the slope by moving to the left.

xsge.physics.SlopeTopRight Event Methods

SlopeTopRight.event_physics_collision_right(other)

Called when the right side of the slope collides with a collider in the sense of the physics system, rather than in the sense of SGE collision detection. See the documentation for sge.Object.event_collision() for more information.

SlopeTopRight.event_physics_collision_top(other)

Called when the top side of the slope collides with a collider in the sense of the physics system, rather than in the sense of SGE collision detection. See the documentation for sge.Object.event_collision() for more information.

xsge.physics.SlopeBottomLeft

class xsge.physics.SlopeBottomLeft(x, y, z=0, sprite=None, visible=True, active=True, checks_collisions=True, tangible=True, bbox_x=None, bbox_y=None, bbox_width=None, bbox_height=None, regulate_origin=False, collision_ellipse=False, collision_precise=False, xvelocity=0, yvelocity=0, xacceleration=0, yacceleration=0, xdeceleration=0, ydeceleration=0, image_index=0, image_origin_x=None, image_origin_y=None, image_fps=None, image_xscale=1, image_yscale=1, image_rotation=0, image_alpha=255, image_blend=None)

A parent class for slopes which point in some direction upwards and to the left.

Slopes of this type go from the top-left corner to the bottom-right corner of the bounding box.

xsticky_bottom

If set to True, a collider that moves to the left while touching the bottom side of the slope will attempt to keep touching the bottom side of the slope by moving upward.

ysticky_left

If set to True, a collider that moves downward while touching the left side of the slope will attempt to keep touching the left side of the slope by moving to the right.

xsge.physics.SlopeBottomLeft Event Methods

SlopeBottomLeft.event_physics_collision_left(other)

Called when the left side of the slope collides with a collider in the sense of the physics system, rather than in the sense of SGE collision detection. See the documentation for sge.Object.event_collision() for more information.

SlopeBottomLeft.event_physics_collision_bottom(other)

Called when the bottom side of the slope collides with a collider in the sense of the physics system, rather than in the sense of SGE collision detection. See the documentation for sge.Object.event_collision() for more information.

xsge.physics.SlopeBottomRight

class xsge.physics.SlopeBottomRight(x, y, z=0, sprite=None, visible=True, active=True, checks_collisions=True, tangible=True, bbox_x=None, bbox_y=None, bbox_width=None, bbox_height=None, regulate_origin=False, collision_ellipse=False, collision_precise=False, xvelocity=0, yvelocity=0, xacceleration=0, yacceleration=0, xdeceleration=0, ydeceleration=0, image_index=0, image_origin_x=None, image_origin_y=None, image_fps=None, image_xscale=1, image_yscale=1, image_rotation=0, image_alpha=255, image_blend=None)

A parent class for slopes which point in some direction upwards and to the right.

Slopes of this type go from the bottom-left corner to the top-right corner of the bounding box.

xsticky_bottom

If set to True, a collider that moves to the right while touching the bottom side of the slope will attempt to keep touching the bottom side of the slope by moving upward.

ysticky_right

If set to True, a collider that moves downward while touching the right side of the slope will attempt to keep touching the right side of the slope by moving to the right.

xsge.physics.SlopeBottomRight Event Methods

SlopeBottomRight.event_physics_collision_right(other)

Called when the right side of the slope collides with a collider in the sense of the physics system, rather than in the sense of SGE collision detection. See the documentation for sge.Object.event_collision() for more information.

SlopeBottomRight.event_physics_collision_bottom(other)

Called when the bottom side of the slope collides with a collider in the sense of the physics system, rather than in the sense of SGE collision detection. See the documentation for sge.Object.event_collision() for more information.

xsge.physics.MobileWall

class xsge.physics.MobileWall(x, y, z=0, sprite=None, visible=True, active=True, checks_collisions=True, tangible=True, bbox_x=None, bbox_y=None, bbox_width=None, bbox_height=None, regulate_origin=False, collision_ellipse=False, collision_precise=False, xvelocity=0, yvelocity=0, xacceleration=0, yacceleration=0, xdeceleration=0, ydeceleration=0, image_index=0, image_origin_x=None, image_origin_y=None, image_fps=None, image_xscale=1, image_yscale=1, image_rotation=0, image_alpha=255, image_blend=None)

A parent class for walls and slopes that can move. When an object of this class moves, it “pushes” any appropriate colliders, as a real wall might be expected to do.

Note

For classes derived from this class to be useful, they also need to inherit one or more of the other wall classes. Objects of this class that are not also objects of other classes will naturally not collide.

Note

This class depends on use of MobileWall.move_x() and MobileWall.move_y() to handle physics interactions. event_update_position() uses these methods, so speed attributes will work properly, but changing x and y manually will not cause any physics to occur.

sticky_left

If set to True, any colliders touching the left side of the wall will move along with it, regardless of the direction of movement.

sticky_right

If set to True, any colliders touching the right side of the wall will move along with it, regardless of the direction of movement.

sticky_top

If set to True, any colliders touching the top side of the wall will move along with it, regardless of the direction of movement.

sticky_left

If set to True, any colliders touching the bottom side of the wall will move along with it, regardless of the direction of movement.

xsge.physics.MobileWall methods

MobileWall.get_stuck_colliders()

Return a list of Collider objects which are “stuck” to this wall (i.e. will move along with the wall regardless of direction).

MobileWall.move_x(move)

Move the wall horizontally, handling physics.

Arguments:

• move – The amount to add to x.

MobileWall.move_y(move)

Move the wall vertically, handling physics.

Arguments:

• move – The amount to add to y.