Name 

Description 

 

Active 

Whether this sprite updates its animation and physics every frame. 

 

Alpha 

The alpha component of the sprite color, ranging from 0 (fully transparent) to 255 (fully opaque) 

 

Angle 

The current rotation angle of the sprite in degrees, 0 degrees being the direction x=0 y=-1 (12 o'clock) and proceeding clockwise. 

 

AngleRad 

The current rotation angle of the sprite in radians, 0 radians being the direction x=0 y=-1 (12 o'clock) and proceeding clockwise. 

 

CategoryBits 

Assigns the sprite to zero or more categories for collision filtering (physics and non physics). 

 

CollideBits 

Uses a bitwise mask to determine which sprites this sprite can collide with. 

 

Color 

The color of the sprite 

 

CurrentFrame 

The current frame in the sprite animation. 

 

Depth 

The current depth of the sprite in the range 0-10000, with 0 being the front of the screen and 10000 being the back. 

 

FixedToScreen 

Whether the sprite is fixed to the screen. 

 

FrameCount 

The total number of frames the sprite managed to get from its image. 

 

Group 

Assigns this sprite to a group for filtering collisions (physics or non physics). 

 

Height 

The current height of the sprite as a floating point value. 

 

Image 

The image currently assigned to the sprite. 

 

PhysicsAngularDamping 

Sets some damping on the sprite's angular movement which may simulate something like wind resistance. 

 

PhysicsAngularImpulse 

Similar to a torque force, but applied only once. 

 

PhysicsAngularVelocity 

The angular velocity of the sprite in radians per second. This is the speed at which the sprite is currently rotating. 

 

PhysicsCanRotate 

Sets whether the physics simulation is allowed to rotate the sprite in response to collisions. 

 

PhysicsDamping 

Sets some damping on the sprite's linear movement which may simulate something like wind resistance. 

 

PhysicsEnabled 

Whether physics is enabled for this sprite. 

 

PhysicsFriction 

Sets the friction value to use for this sprite during physics calculations. Should be in the range 0-1. 

 

PhysicsIsBullet 

Set this to True if the sprite is likely to be moving very fast, like a bullet, as it will then be checked more thoroughly for collision with other dynamic sprites, using this unnecessarily will affect performance. 

 

PhysicsIsSensor 

Set this to True to make the sprite a sensor object. 

 

PhysicsMass 

The mass of the sprite in kilograms currently being used. This was either generated automatically when its shape was created or a shape was added, or was set manually. 

 

PhysicsMode 

Sets the sprite up for automatic collision using the built physics system. Sets the mode to use for physics. Once you have set a sprite to be controlled by physics you should use SetPosition and Angle sparingly as these will interrupt the physics motion of the sprite. You can also use the SetPhysicsVelocity and PhysicsAngularVelocity to change the speed and direction of a sprite, but again these will interfere with the physics motion of the sprite. If you wish to influence the position or rotation of a physics sprite you should use the force and torque (rotational force) functions where possible, these will maintain... more 

 

PhysicsRestitution 

Sets the restitution (bounciness) value to use for this sprite during physics calculations. Should be in the range 0-1. 

 

PhysicsTorque 

Applies a torque to the rotation of the sprite, similar to applying a force to its movement. 

 

PhysicsVelocity 

Returns the linear velocity of the sprite. 

 

PhysicsVelocityX 

Returns the linear velocity of the sprite in the X direction. 

 

PhysicsVelocityY 

Returns the linear velocity of the sprite in the Y direction. 

 

Playing 

Whether the sprite is currently playing an animation. 

 

Pos 

The current position of the sprite's top left corner in world coordinates. 

 

PosByOffset 

The current position of the sprite's current offset point in the world. 

 

Shape 

Sets the current shape for use in collision detection, hit testing, and physics. A shape can be set without turning physics on, and by default all sprites are set to use the box shape, which is the fastest to setup. If you select no shape (psNone) then hit tests and collision will return False, and physics will move but not collide the sprite, resulting in it passing through everything. 

 

Snap 

A special render mode that keeps the sprite on whole pixels only so it does not draw itself across pixel boundaries which may cause flickering as the sprite moves across the screen. 

 

Speed 

The sprite animation speed in Frames Per Second. 

 

TransparencyMode 

Set the sprite transparency to a particular setting, with a choice of no transparency (tmNone), alpha transparency (tmAlphaTransparency), and alpha masking (on/off transparency, tmAlphaMasking), although alpha masking tends to be slower than full alpha on most devices. 

 

UVBorder 

Controls how the sprite handles UVs that might extend beyond the bounds of the image during sampling, for example when the edge of the sprite is halfway across a pixel. 

 

Visible 

Whether this sprite is visible during drawing. 

 

Width 

The current width of the sprite as a floating point value. 

 

X 

The current X coordinate of the sprite's top left corner as a floating point value in world coordinates. When setting this property, it will immediately take effect. 

 

XByOffset 

The current X coordinate of the sprite's current offset point in the world. 

 

Y 

The current Y coordinate of the sprite's top left corner as a floating point value in world coordinates. When setting this property, it will immediately take effect. 

 

YByOffset 

The current Y coordinate of the sprite's current offset point in the world.