Name 

Description 

 

FID 

 

 

Name 

Description 

 

AddAnimationFrame 

Adds an image to the sprite as a new animation frame. 

 

AddShapeBox 

Adds a new box shape to the sprite, in addition to any it already has. These additional shapes only apply to physics sprites and must be added after a sprite has been set to use physics. 

 

AddShapeCircle 

Adds a new circle shape to the sprite, in addition to any it already has. These additional shapes only apply to physics sprites and must be added after a sprite has been set to use physics. 

 

AddShapePolygon 

Adds a new polygon shape to the sprite, in addition to any it already has. These additional shapes only apply to physics sprites and must be added after a sprite has been set to use physics. 

 

AfterConstruction 

 

 

CalculatePhysicsCenterOfMass 

Recalculates the center of mass (COM) based on the shapes attached to the sprite, if you have overriden the COM this will set it back to a location decided by the AGK. 

 

ClearAnimationFrames 

Removes all animation frames from a sprite returning it to a single image sprite. 

 

ClearShapes 

Removes all additional shapes applied to the sprite and keeps only the base shape, set using the Shape property or SetShape* method. 

 

Clone 

This is the overview for the Clone method overload. 

 

CollidesWith 

Checks two sprites for collision, if they overlap then it returns True. Otherwise it returns False. No other information can be returned about this type of collision. 

 

Collision 

Checks two sprites for collision, if they overlap then it returns True. Otherwise it returns False. No other information can be returned about this type of collision. 

 

Create 

This is the overview for the Create constructor overload. 

 

CreateBlank 

Creates a blank sprite. 

 

CreateDummy 

Creates a dummy sprite. Dummy sprites behave as normal sprites but have no image or other visual aspect to them. They will not be drawn even if an image is assigned to them. 

 

Destroy 

All sprites are automatically destroyed when their owner (such as the scene in which it is used) is destroyed. However, if you don't need the sprite anymore, you can save memory (especially on mobile devices) by destroying it earlier. Also, when the sprite has no owner, you need to destroy it yourself when you are done with it. 

 

Distance 

This is the overview for the Distance method overload. 

 

Draw 

Immediately draws the sprite to the backbuffer at its current position, size, and rotation. 

 

GetSpriteByID 

If you only have an internal AGK sprite ID, then you can use this function to get the sprite object for this ID. 

 

Hit 

This is the overview for the Hit method overload. 

 

HitCategory 

This is the overview for the HitCategory method overload. 

 

HitGroup 

This is the overview for the HitGroup method overload. 

 

HitTest 

This is the overview for the HitTest method overload. 

 

InBox 

This is the overview for the InBox method overload. 

 

InCircle 

This is the overview for the InCircle method overload. 

 

PhysicsCollidesWith 

Checks two sprites for a physics sprites. 

 

PhysicsCollision 

Checks two sprites for a physics sprites. 

 

PhysicsDelete 

Turns off physics for this sprite and deletes all associated physics settings for this sprite. 

 

PixelFromPoint 

This is the overview for the PixelFromPoint method overload. 

 

Play 

Begins the animation of a sprite based on the given values. 

 

PointFromPixel 

This is the overview for the PointFromPixel method overload. 

 

ResetUV 

This command reinstates the normal functionality of UV coordinates after a call to SetUV. 

 

Resume 

Continues the animation of the sprite using the values used to set it up. 

 

SetAnimation 

Initialises the sprite animation with frames from its assigned image, based on a frame width and frame height. 

 

SetCategoryBit 

Assigns or removes a sprite from a particlar category. 

 

SetCollideBit 

Sets or removes a category that this sprite can collide with. 

 

SetColor 

This is the overview for the SetColor method overload. 

 

SetFlip 

Flips the sprite either horizontally or vertically, (or both). 

 

SetImageAndUpdateShape 

Change the sprite image to a new image, and update the collision shape accordingly. 

 

SetOffset 

This is the overview for the SetOffset method overload. 

 

SetPhysicsCenterOfMass 

This is the overview for the SetPhysicsCenterOfMass method overload. 

 

SetPhysicsForce 

Applies a force to the sprite that will last for this frame only, to continue applying this force you must keep calling this function. 

 

SetPhysicsImpulse 

Similar to a force but applied only once. 

 

SetPhysicsVelocity 

This is the overview for the SetPhysicsVelocity method overload. 

 

SetPosition 

This is the overview for the SetPosition method overload. 

 

SetPositionByOffset 

This is the overview for the SetPositionByOffset method overload. 

 

SetScale 

Sets the sprite scale as an absolute multiple of its original size. For example a scale value of 2 would double the sprite's size whilst a value of 1 will return it to its original size. 

 

SetScaleByOffset 

Sets the sprite scale as an absolute multiple of its original size. For example a scale value of 2 would double the sprite's size whilst a value of 1 will return it to its original size. 

 

SetScissor 

This is the overview for the SetScissor method overload. 

 

SetShapeBox 

Overrides the current auto generated shape for use in collision detection, hit testing, and physics. Sets the shape to a box. 

 

SetShapeCircle 

Overrides the current auto generated shape for use in collision detection, hit testing, and physics. Sets the shape to a circle. 

 

SetShapePolygon 

Overrides the current auto generated shape for use in collision detection, hit testing, and physics. Set the shape to a polygon. 

 

SetSize 

Sets the sprite to a new width and height. In the default coordinate system a width and height of 100,100 would fill the entire drawable screen (this can be changed using TAgkApplication.SetVirtualResolution). 

 

SetUV 

This command overrides the normal UV calculations of the sprites and allows you to set them directly for each vertex. 

 

SetUVOffset 

Offsets the sprites UV coordinates by the given amount. For example, offsetting by 0.5 in the U direction will make the sprite begin sampling the texture halfway across the top of the texture instead of the top left corner as normal. 

 

SetUVScale 

Scales the sprites UV coordinates by the given amount. A sprite with UV scaled by 2 will make its texture look twice as big as normal. 

 

Stop 

Stops the animation of a sprite, maintaining the values used to set it up. 

 

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. 

 

ID 

The internal ID of the object. 

 

Image 

The image currently assigned to the sprite. 

 

OwnedObjectCount 

The number of objects that this object owns. 

 

OwnedObjects 

The objects that this object owns. 

 

Owner 

The owner of this object. 

 

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.