xsge.path¶
Contents
This module provides paths for the SGE. Paths are used to make objects move in a certain way.
xsge.path Classes¶
xsge.path.Path¶
- class xsge.path.Path(x, y, points=(), z=0, sprite=None, visible=False, active=True, checks_collisions=False, tangible=False, 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, 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)[source]¶
Class for paths: objects which define movement patterns for other objects. Paths are defined as a series of points for an object to follow.
This class is derived from sge.Object and inherits all of that class’s attributes and methods.
Note
event_step() is used to implement path-following behavior. Keep this in mind if you derive a class from this one.
- points¶
A list of the points that make up the path relative to the position of the path in the room, excluding the first point. Each point should be a tuple in the form (x, y), where x is the horizontal location and y is the vertical location. The first point is always (0, 0), which is why it is not included in this list.
xsge.path.Path Methods¶
- Path.follow_start(obj, speed, accel=None, decel=None, loop=0)[source]¶
Cause obj to start following this path at the speed indicated by speed.
While path objects have a location within the room, this location has no bearing on how objects following the path move. Movement is determined relative to the location of the object following the path when it started, not the location of the path.
By default, the object follows the path at a constant speed. If accel or decel is set to a value other than None, the object will instead accelerate or decelerate, respectively, by that amount each frame on each segment of the path.
loop indicates the number of times the object should follow the path after it does so the first time. For example, if set to 2, the object will follow the path a total of 3 times. Set to None to loop indefinitely.
Note
Acceleration and deceleration does not work with delta timing. This is a simple consequence of the way delta timing works; it is not possible to perfectly predict how much to accelerate or decelerate to achieve the desired effect, and to predict this even decently requires control over the actual movement, which paths don’t have.
