SpriteLibrary

PutBaseImageLocation Method (Point)

PutBaseImageLocation Method (Double, Double)

SpritePutBaseImageLocation Method (Double, Double)

+ Put the Sprite at a specified location, using the dimentions of the BackgroundImage. + Unless you are using coordinates you have gotten from a mouse-click, this is how you want + to place a Sprite somewhere. It is the easiest way to track things. But, if you are + doing something using mouse-click coordinates, you want to use PutPictureBoxLocation +

+ Namespace: + SpriteLibrary
+ Assembly: + SpriteLibrary (in SpriteLibrary.dll) Version: 1.0.0.5 (1.0.0.5)

Syntax

public void PutBaseImageLocation(
+	double X,
+	double Y
+)

Parameters

X: Type: SystemDouble
The X location on the background image
Y: Type: SystemDouble
the Y location on the background image

See Also

Reference

PutBaseImageLocation Overload

Sprite.Click Event

SpriteLibrary

SpriteClick Event

+ This event happens when someone clicks on the sprite (on the rectangle in which the sprite is). + If you want the event to fire off only when someone clicks on the visible part of the sprite, + use ClickTransparent instead. +

+ Namespace: + SpriteLibrary
+ Assembly: + SpriteLibrary (in SpriteLibrary.dll) Version: 1.0.0.5 (1.0.0.5)

Syntax

public event SpriteSpriteEventHandler Click

Value

See Also

Reference

SpriteController Class

SpriteLibrary

SpriteController Constructor

SpriteController Properties

SpriteController Events

SpriteController Fields

SpriteController Class

+ A sprite controller is the main heart of the sprite class. Each SpriteController manages one picturebox. + If at all possible, try to keep each game in one picturebox, and try to avoid making and destroying + new forms with SpriteController/pictureboxes in them. It is hard to destroy them completely. +

Inheritance Hierarchy

SystemObject
SpriteLibrarySpriteController

+ Namespace: + SpriteLibrary
+ Assembly: + SpriteLibrary (in SpriteLibrary.dll) Version: 1.0.0.5 (1.0.0.5)

Syntax

public class SpriteController

The SpriteController type exposes the following members.

Constructors

+ +	Name	Description
	SpriteController(PictureBox)	+ Create a sprite controller, specifying the picturebox on which the sprites + will be displayed. You want to have the PictureBox already defined, and a background image + already set for the PictureBox. +
	SpriteController(PictureBox, EventHandler)	+ Create a sprite controller, specifying the picturebox on which the sprites + will be displayed. +

Properties

+ +	Name	Description
	BackgroundImage	+ The Background Image on which the sprites are drawn. This image ends up having + sprite parts on it. The OriginalImage is the version that is clean. Use + ReplaceOriginalImage to replace the background Image. +
	OriginalImage	+ The Image from which the background is taken when we erase sprites. The BackgroundImage + is the image that contains images of the sprites as well as the background image. Use + ReplaceOriginalImage to replace this and the BackgroundImage. +
	SpriteCount	+ The count of all the sprites the controller knows about. This includes named + sprites, which may not be visible. +

Methods

+ +	Name	Description
	AddSprite	+ Add the specified sprite to the list of sprites we know about. You usually do not need to do this. + Sprites add themselves to the controller when you create a new sprite. +
	AdjustPoint	+ Adjust an image point so that it conforms to the picturebox. +
	AdjustRectangle	+ Adjust a rectangle that is based on the image, according to the stretch of the picturebox +
	AllSprites	+ Return a list of all sprites +
	ChangeTickInterval	+ Change the Tick Interval. By default, the spritecontroller does a tick every 10ms, which + is very fast. Some people may prefer it to happen less regularly. Must be > 5, and less than 1001 +
	CountSpritesBasedOff	+ Count the number of sprites that were duplicated from the sprite with the specified name. When you use a + SpriteController.DuplicateSprite(string) + command, it creates a new sprite that is based off the named sprite. This function will count those duplicated sprites. +
	DestroyAllSprites	+ Remove all sprites (even named sprites that have not yet been displayed) +
	DestroySprite	+ Tell a sprite to destroy itself. The sprite will have Destroying property set to true from + the time you destroy it until it vanishes. Whe you destroy a sprite, it will erase itself + and remove itself from the controller. After it is destroyed, it is completely gone. +
	DuplicateSprite(String)	+ Find a sprite that has been named with the specified name. Then duplicate that sprite +
	DuplicateSprite(Sprite)	+ Make a duplicate of the specified sprite. The duplicate does not yet have a location. +
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Invalidate(Boolean)	+ Invalidate the entire image on which the sprites are drawn +
	Invalidate(Rectangle, Boolean)	+ Invalidate a rectangle that is specified in image coordinates +
	IsKeyPressed	+ Check to see if any keys are pressed. There is a small glitch with the + key-pressed system. If the form loses focus, and someone releases a key, the key-up is never + triggered. It is a good thing to ResetKeypressState() occasionally if you think your form may have + lost focus. +
	IsKeyPressed(Keys)	+ Check to see if the given key is pressed. There is a small glitch with the + key-pressed system. If the form loses focus, and someone releases a key, the key-up is never + triggered. It is a good thing to ResetKeypressState() occasionally if you think your form may have + lost focus. +
	KeysPressed	+ Return a list of all the keys that are currently pressed. There is a small glitch with the + key-pressed system. If the form loses focus, and someone releases a key, the key-up is never + triggered. It is a good thing to ResetKeypressState() occasionally if you think your form may have + lost focus. +
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	NameSprite	+ Find the specified Sprite in the controller and change its name to the specified string. + You can do the same thing with Sprite.SetName(Name)
	Pause	+ Pause everything. It loops through all the sprites in the SpriteController and sends the specified + SpritePauseType to each one. Look at the documentation for SpritePauseType to determine which pause + type to use. +
	PlaceSpriteBehind	+ Change the display order of the sprites such that the specified sprite appears behind the other sprite. +
	PlaceSpriteInFrontOf	+ Make the sprite go in front of the specified sprite. +
	RegisterKeyDownFunction	+ If you want to have a KeyDown function that is triggered by a keypress function, add the event here. + The event should have the parameters (object sender, KeyEventArgs e) +
	RegisterKeyUpFunction	+ If you want to have a KeyUp function that is triggered by a keypress function, add the event here. + The event should have the parameters (object sender, KeyEventArgs e) +
	ReplaceOriginalImage	+ Notify the sprite controller that you have changed the background image on the + PictureBox. Whatever background is on the picturebox is now used to draw all the sprites on. +
	ReplaceOriginalImage(Image)	+ Replace the image on which the sprites are drawn. Use this when you move to a new playing field, + or want to have a different background + Examples + Replacing the background image is actually a lot more complex than you might imagine. Once you use the + below code, it can be done without any problem. But you need to do it this way, or it just goofs up in + a number of small ways. + You need to tell the sprite controller that you are replacing the background image, + and you need to change the image to that image as well.Because the Images are actually + pointers to memory where the image sets, changes to one image will affect the other image.This goofs + things up, so what we do is duplicate the image twice, and tell the sprite controller to use one of the + copies and then set the background to be the other one of the two copies.Finally, we tell the picturebox + to invalidate itself.That does everything that is needed. + C# Copy void ReplaceBackground(Image NewBackground) +{ + if (MyController == null) return; + if (NewBackground == null) return; + + Image OneImage = new Bitmap(NewBackground); + MyController.ReplaceOriginalImage(OneImage); + + Image TwoImage = new Bitmap(NewBackground); + pb_map.BackgroundImage = TwoImage; + pb_map.Invalidate(); +}
	ResetKeypressState	+ Reset the keypress status. Sometimes the sprite controller misses a key being released (usually + because a window has taken priority, or something has changed). Calling this function will reset + the stored memory of whether a key has been pressed. +
	ReturnAdjustmentRatio	+ Return an adjustment ratio. This is the image-size to picture-box ratio. + It is used for calculating precise pixels or picture-box locations. +
	ReturnPictureBoxAdjustedHeight	+ Return the height of an object in picture-box terms. It is basically the virtual height + of the sprite or other item. +
	ReturnPictureBoxAdjustedPoint	+ This does the reverse of an adjusted point. It takes a point on the image and + transforms it to one on the PictureBox +
	ReturnPictureBoxAdjustedWidth	+ Return the width of an object in picture-box terms. It takes the width of a sprite or other + item that is being displayed on the screen, and calculates the width as displayed in the + picture-box (taking into consideration stretching or shrinking) +
	ReturnPointAdjustedForImage	+ This takes a point, the location on a picturebox, and returns the corresponding point on the BackgroundImage. + Picturebox locations are "sloppy"; the background image locations are very precise. Since this takes a "sloppy" + number and returns a precise number, it does some rounding to figure out where the specified location is. +
	SoundIsFinished	+ Check to see if the specified sound has finished playing +
	SoundPlay	+ Play a sound that we can check to see if it has completed. +
	SpriteBackwards	+ Change the display order of the specified sprite so it is more likely to go behind all other sprites. +
	SpriteForwards	+ Change the display order of the specified sprite so it is more likely to go in front of other sprites +
	SpriteFromName	+ Find a sprite that has a specified name. This returns the actual sprite with that name. + You usually want to use DuplicateSprite(Name) to clone the sprite and get one you can + destroy. If you destroy a named sprite without duplicating it, you may end up losing + it for the remainder of the program. +
	SpritesAtImagePoint	+ This takes a point, as as specified on the image, and returns the sprites at that point. Different + functions use different coordinates, whether based off the background image, or based off the picturebox. + This one uses the background image coordinates. Use SpritesAdPoint() if you are doing something based off + a MouseUp or MouseDown function. This is used for functions based on sprite location or based off the absoloute + location (using the background image location is much more precise than the visible location in the picturebox) +
	SpritesAtPoint	+ This takes a point, as given by the mouse-click args, and returns the sprites at that point. Different + functions use different coordinates, whether based off the background image, or based off the picturebox. + This one uses the picturebox coordinates. So you can use this directly from a MouseDown or MouseUp function. +
	SpritesBasedOff	+ Return all sprites that were based off a particular sprite name. + When you use a + SpriteController.DuplicateSprite(string) + command, it creates a new sprite that is based off the named sprite. This function returns a list of those + duplicated sprites. +
	SpritesBasedOffAnything	+ Return a list of all sprites which are not master sprites (which are duplicates of something) +
	SpritesInImageRectangle	+ Return a list of all the sprites that intersect with the given background-image-based rectangle +
	SpritesThatHaveBeenDrawn	+ Return a list of all sprites which have been drawn on the image +
	SpriteToBack	+ Change the display order of the specified sprite so it goes behind all other sprites. +
	SpriteToFront	+ Change the display order of the specified sprite so it goes in front of all other sprites. +
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	UnPause	+ un-Pause everything. This will send the specified SpritePauseType unpause command + to all sprites. +

Events

+ +	Name	Description
	DoTick	+ The function called by the timer every 10 millisecods This is usually where you will do the majority of the work. + You can define this manually, or when you instantiate the SpriteController

Fields

+ +	Name	Description
	OptimizeForLargeSpriteImages	+ If your sprite images need substantial growing or shrinking when displayed, you can try setting this to "true" + to see if it makes it run any faster. What it does is to resize the image once, and keep a cached copy of that + image at that size. If you use the same sprite, but with different sizes, setting this to "True" may actually slow + down the game instead of speeding it up. +
	RandomNumberGenerator	+ Since everything needs a random number generator, we make one that should be accessible throughout your program. +
	SpriteComparisonDelegate	+ Allow the sprite sort-method to be overridden. +

Examples

+ A sprite controller controls animations and + can help you check for key-presses. To make a sprite controller, + you need to have one defined for your main form: +

SpriteController MySpriteController;

+ And then, when the form is created, after the InitializeComponents() function, you + need to configure the drawing area and create the sprite controller: +

MainDrawingArea.BackgroundImage = Properties.Resources.Background;
+MainDrawingArea.BackgroundImageLayout = ImageLayout.Stretch;
+MySpriteController = new SpriteController(MainDrawingArea);

+ In this case, MainDrawingArea is the picturebox where all the sprites will be displayed. +

See Also

Reference

SpriteController.SoundPlay Method

SpriteLibrary

SpriteControllerSoundPlay Method

+ Play a sound that we can check to see if it has completed. +

+ Namespace: + SpriteLibrary
+ Assembly: + SpriteLibrary (in SpriteLibrary.dll) Version: 1.0.0.5 (1.0.0.5)

Syntax

public void SoundPlay(
+	Stream ToPlay,
+	string Name
+)

Parameters

ToPlay: Type: System.IOStream
The sound to play
Name: Type: SystemString
The name, which we can use to determine if it has finished.

See Also

Reference

SpriteController.PlaceSpriteBehind Method

SpriteLibrary

SpriteControllerPlaceSpriteBehind Method

+ Change the display order of the sprites such that the specified sprite appears behind the other sprite. +

+ Namespace: + SpriteLibrary
+ Assembly: + SpriteLibrary (in SpriteLibrary.dll) Version: 1.0.0.5 (1.0.0.5)

Syntax

public void PlaceSpriteBehind(
+	Sprite WhatToSend,
+	Sprite ToGoBehind
+)

Parameters

WhatToSend: Type: SpriteLibrarySprite
The sprite we are changing the display order of
ToGoBehind: Type: SpriteLibrarySprite
The sprite we want to go behind

See Also

Reference

Sprite.SpriteAdjustedPoint Method

SpriteLibrary

SpriteSpriteAdjustedPoint Method

+ Because sprites are scaled (shrunk or stretched), this function finds the point + within the sprite that is specified by the location. this function is used by + a number of internal processes, but may be useful to you. But probably not. +

+ Namespace: + SpriteLibrary
+ Assembly: + SpriteLibrary (in SpriteLibrary.dll) Version: 1.0.0.5 (1.0.0.5)

Syntax

public Point SpriteAdjustedPoint(
+	Point location
+)

Parameters

location: Type: System.DrawingPoint
A point given in Image coordinates

Return Value

Type: Point
A point within the pixel that can be used to find a particular pixel in a sprite.

See Also

Reference

Sprite.ReplaceImage Method

SpriteLibrary

SpriteReplaceImage Method

+ Replace a sprite image. It will replace the current frame unless you specify both an animation + and the frame within the animation you wish to replace. Warning: This replaces the image_frame + for every sprite that uses that is based off the same image. +

+ Namespace: + SpriteLibrary
+ Assembly: + SpriteLibrary (in SpriteLibrary.dll) Version: 1.0.0.5 (1.0.0.5)

Syntax

public void ReplaceImage(
+	Image newimage,
+	int animation = -1,
+	int frame = -1
+)

Parameters

newimage: Type: System.DrawingImage
The new image to use
animation (Optional): Type: SystemInt32
The animation you want to change
frame (Optional): Type: SystemInt32
The frame within the animation you want to change

See Also

Reference

Sprite.SpriteAnimationComplete Event

SpriteLibrary

SpriteSpriteAnimationComplete Event

+ Only used when you tell an animation to animate once. At the end of the animation, + this function fires off. +

+ Namespace: + SpriteLibrary
+ Assembly: + SpriteLibrary (in SpriteLibrary.dll) Version: 1.0.0.5 (1.0.0.5)

Syntax

public event SpriteSpriteEventHandler SpriteAnimationComplete

Value

See Also

Reference

Sprite.SetSpriteDirectionDegrees Method

SpriteLibrary

SpriteSetSpriteDirectionDegrees Method

+ Given a "degree" (from 0 to 360, set the direction + that the sprite moves automatically. 0 is right, 90 is up, 180 is left + and 270 is down. +

+ Namespace: + SpriteLibrary
+ Assembly: + SpriteLibrary (in SpriteLibrary.dll) Version: 1.0.0.5 (1.0.0.5)

Syntax

public void SetSpriteDirectionDegrees(
+	double AngleInDegrees
+)

Parameters

AngleInDegrees: Type: SystemDouble
the degrees to use

See Also

Reference

Sprite.Destroying Property

SpriteLibrary

SpriteDestroying Property

+ If the Sprite is in the middle of being Destroyed, this is set to true. When a Sprite is + Destroyed, it needs to erase itself and do some house-cleaning before it actually vanishes. + During this time, you may not want to use it. It is always a good thing to verify a Sprite + is not in the middle of being destroyed before you do something important with it. To Destroy + a Sprite, use the Sprite.Destroy() function. +

+ Namespace: + SpriteLibrary
+ Assembly: + SpriteLibrary (in SpriteLibrary.dll) Version: 1.0.0.5 (1.0.0.5)

Syntax

public bool Destroying { get; }

Property Value

Type: Boolean

See Also

Reference

Sprite.MovingToPoint Property

SpriteLibrary

SpriteMovingToPoint Property

+ Tells us if we are in the process of doing a MoveTo operation. This boolean should be the + opposite of SpriteReachedEndpoint, but that boolean is poorly named. This is usually the easier + one to use. +

+ Namespace: + SpriteLibrary
+ Assembly: + SpriteLibrary (in SpriteLibrary.dll) Version: 1.0.0.5 (1.0.0.5)

Syntax

public bool MovingToPoint { get; }

Property Value

Type: Boolean

See Also

Reference

Sprite.AddAnimation Method

SpriteLibrary

AddAnimation Method (Point, Image, Int32, Int32, Int32, Int32)

SpriteAddAnimation Method

Overload List

+ +	Name	Description
	AddAnimation(Image)	+ Add another animation to an existing Sprite. After you add animations, you can use + ChangeAnimation to select which animation you want the specified sprite to show. + For example, you may want to have Animation 0 be a guy walking left, and animation 1 is + that same guy walking right. Because we do not specify the number of frames, it starts + at the top-left corner and grabs as many frames as it can from the image. +
	AddAnimation(Image, Size)	+ Add another animation to an existing Sprite. After you add animations, you can use + ChangeAnimation to select which animation you want the specified sprite to show. + For example, you may want to have Animation 0 be a guy walking left, and animation 1 is + that same guy walking right. Because we do not specify the number of frames, it starts + at the top-left corner and grabs as many frames as it can from the image. +
	AddAnimation(Image, Int32)	+ Add another animation to an existing Sprite. After you add animations, you can use + ChangeAnimation to select which animation you want the specified sprite to show. + For example, you may want to have Animation 0 be a guy walking left, and animation 1 is + that same guy walking right. Because we do not specify the number of frames, it starts + at the top-left corner and grabs as many frames as it can from the image. +
	AddAnimation(Int32, Int32)	+ Duplicate an animation, except rotated by the specified number of degrees. For example, if you have + a single animation (0), and you want to rotate it by 90 degrees, it will create animation 1 with that + rotation to it. In the long haul, generating a few rotated animations is less memory intensive than + rotating it on demand. +
	AddAnimation(Image, Int32, Int32)	+ Add another animation to an existing Sprite. After you add animations, you can use + ChangeAnimation to select which animation you want the specified sprite to show. + For example, you may want to have Animation 0 be a guy walking left, and animation 1 is + that same guy walking right. Because we do not specify the number of frames, it starts + at the top-left corner and grabs as many frames as it can from the image. +
	AddAnimation(Int32, Boolean, Boolean)	+ Duplicate an animation, except rotated by the specified number of degrees. For example, if you have + a single animation (0), and you want to rotate it by 90 degrees, it will create animation 1 with that + rotation to it. In the long haul, generating a few rotated animations is less memory intensive than + rotating it on demand using the MirrorHorizontally or MirrorVertically booleans. +
	AddAnimation(Image, Int32, Int32, Int32)	+ Add another animation to an existing Sprite. After you add animations, you can use + ChangeAnimation to select which animation you want the specified sprite to show. + For example, you may want to have Animation 0 be a guy walking left, and animation 1 is + that same guy walking right. Because we do not specify the number of frames, it starts + at the top-left corner and grabs as many frames as it can from the image. +
	AddAnimation(Point, Image, Int32, Int32, Int32, Int32)	+ Add another animation to an existing Sprite. After you add animations, you can use + ChangeAnimation to select which animation you want the specified sprite to show. + For example, you may want to have Animation 0 be a guy walking left, and animation 1 is + that same guy walking right. Because we do not specify the number of frames, it starts + at the top-left corner and grabs as many frames as it can from the image. +

See Also

Reference

Sprite.MoveTo Method (List(Point))

SpriteLibrary

MoveTo Method (List(Point))

MoveTo Method

MoveTo Method (Point)

MoveTo Method (Sprite)

SpriteMoveTo Method (ListPoint)

+ Tell the sprite to move towards each point in turn. The sprite will move in a straight line until the first point. + From there it moves to the next point, until it has reached the last point. Every time it reaches a point, the + SpriteArrivedAtWaypoint event is triggered. When it reaches the final point in the list, the SpriteArrivedAtEndPoint + event is triggered. While the sprite is moving, the SpriteReachedEndPoint attribute is set to false. When it has + arrived, it is set to true. +

+ Namespace: + SpriteLibrary
+ Assembly: + SpriteLibrary (in SpriteLibrary.dll) Version: 1.0.0.5 (1.0.0.5)

Syntax

public void MoveTo(
+	List<Point> DestinationList
+)

Parameters

DestinationList: Type: System.Collections.GenericListPoint
A list of Image-Points that the sprite will follow, one after the other

See Also

Reference

MoveTo Overload

Sprite.MouseEnter Event

SpriteLibrary

SpriteMouseEnter Event

+ When the mouse moves over the sprite. Use this for a menu, when you want the menu item to glow when the + mouse is over the menu item sprite. +

+ Namespace: + SpriteLibrary
+ Assembly: + SpriteLibrary (in SpriteLibrary.dll) Version: 1.0.0.5 (1.0.0.5)

Syntax

public event SpriteSpriteEventHandler MouseEnter

Value

See Also

Reference

Sprite.AddAnimation Method (Int32, Boolean, Boolean)

SpriteLibrary

AddAnimation Method (Point, Image, Int32, Int32, Int32, Int32)

SpriteAddAnimation Method (Int32, Boolean, Boolean)

+ Duplicate an animation, except rotated by the specified number of degrees. For example, if you have + a single animation (0), and you want to rotate it by 90 degrees, it will create animation 1 with that + rotation to it. In the long haul, generating a few rotated animations is less memory intensive than + rotating it on demand using the MirrorHorizontally or MirrorVertically booleans. +

+ Namespace: + SpriteLibrary
+ Assembly: + SpriteLibrary (in SpriteLibrary.dll) Version: 1.0.0.5 (1.0.0.5)

Syntax

public void AddAnimation(
+	int AnimationToCopy,
+	bool MirrorHorizontal,
+	bool MirrorVertical
+)

Parameters

AnimationToCopy: Type: SystemInt32
An integer value specifying the animation to duplicate
MirrorHorizontal: Type: SystemBoolean
A boolean, stating if we should mirror horizontally
MirrorVertical: Type: SystemBoolean
A boolean, stating if we should mirror vertically

See Also

Reference

AddAnimation Overload

Sprite.SpriteArrivedAtWaypoint Event

SpriteLibrary

SpriteSpriteArrivedAtWaypoint Event

+ When you tell a sprite to MoveTo(list of points), this fires off every time it gets to + one of the points. When it gets to the final point, only the SpriteAtEndPoint event fires off. +

+ Namespace: + SpriteLibrary
+ Assembly: + SpriteLibrary (in SpriteLibrary.dll) Version: 1.0.0.5 (1.0.0.5)

Syntax

public event SpriteSpriteEventHandler SpriteArrivedAtWaypoint

Value

See Also

Reference

SpriteEventArgs.CollisionMethod Field

SpriteLibrary

SpriteEventArgs Fields

Cancel Field

CollisionMethod Field

NewLocation Field

TargetSprite Field

SpriteEventArgsCollisionMethod Field

+ The CollisionMethod used in the event. Currently, only rectangle collisions are used +

+ Namespace: + SpriteLibrary
+ Assembly: + SpriteLibrary (in SpriteLibrary.dll) Version: 1.0.0.5 (1.0.0.5)

Syntax

public SpriteCollisionMethod CollisionMethod

Field Value

Type: SpriteCollisionMethod

See Also

Reference

Sprite Constructor (SpriteController, Image, Int32, Int32)

SpriteLibrary

Sprite Constructor (Sprite, Boolean)

Sprite Constructor

Sprite Constructor (SpriteController, Image)

Sprite Constructor (SpriteController, Image, Size)

Sprite Constructor (SpriteController, Image, Int32, Int32)

Sprite Constructor (SpriteController, Image, Int32, Int32, Int32)

Sprite Constructor (Point, SpriteController, Image, Int32, Int32, Int32, Int32)

Sprite Constructor (SpriteController, Image, Int32, Int32)

+ Generate a new sprite. It takes the image and the width and height. If there are multiple images of that width + and height in the image, an animation is created. +

+ Namespace: + SpriteLibrary
+ Assembly: + SpriteLibrary (in SpriteLibrary.dll) Version: 1.0.0.5 (1.0.0.5)

Syntax

public Sprite(
+	SpriteController Controller,
+	Image SpriteImage,
+	int width,
+	int height
+)

Parameters

Controller: Type: SpriteLibrarySpriteController
The sprite controller that manages this sprite
SpriteImage: Type: System.DrawingImage
The image we pull the animation from
width: Type: SystemInt32
The width of one animation frame
height: Type: SystemInt32
The height of one animation frame

See Also

Reference

Sprite Overload

Sprite.SpriteEventHandler Delegate

SpriteLibrary

Sprite.SpriteEventHandler Delegate

SpriteCollisionMethod Enumeration

SpriteKeyEventHandler Delegate

SpritePauseType Enumeration

SpriteSpriteEventHandler Delegate

+ A delegate that has a SpriteEventArgs instead of EventArgs. Used for most + of the Sprite events. This allows us to pass more information from sprite events than + a basic EventArgs allows for +

+ Namespace: + SpriteLibrary
+ Assembly: + SpriteLibrary (in SpriteLibrary.dll) Version: 1.0.0.5 (1.0.0.5)

Syntax

public delegate void SpriteEventHandler(
+	Object sender,
+	SpriteEventArgs e
+)

Parameters

sender: Type: SystemObject
The Sprite that triggers the event
e: Type: SpriteLibrarySpriteEventArgs
A SpriteEventArgs class which contains Sprite Event values

See Also

Reference

Sprite.MoveTo Method

SpriteLibrary

MoveTo Method (List(Point))

MoveTo Method

MoveTo Method (Point)

MoveTo Method (Sprite)

SpriteMoveTo Method

Overload List

+ +	Name	Description
	MoveTo(ListPoint)	+ Tell the sprite to move towards each point in turn. The sprite will move in a straight line until the first point. + From there it moves to the next point, until it has reached the last point. Every time it reaches a point, the + SpriteArrivedAtWaypoint event is triggered. When it reaches the final point in the list, the SpriteArrivedAtEndPoint + event is triggered. While the sprite is moving, the SpriteReachedEndPoint attribute is set to false. When it has + arrived, it is set to true. +
	MoveTo(Point)	+ Tell the Sprite to move towards a destination. You need to give the sprite a MovementSpeed + and tell the sprite that it can automatically move. But the sprite will begin a journey towards + that point at the MovementSpeed you have set. When it gets to the point, the SpriteArrivedAtEndPoint event + will fire off. Also, the SpriteReachedEnd bool will be true. +
	MoveTo(Sprite)	+ Move to where the destination sprite currently is at. This is a dumb move. It does not take into + consideration the movement direction of the destination sprite. So the moving sprite does need to be + moving a bit faster than the sprite you are trying to hit for it to do so. +

See Also

Reference

Sprite.Rotation Property

SpriteLibrary

SpriteRotation Property

+ Change the rotation of the sprite, using degrees. 0 degrees is to the right. 90 is up. + 180 left, 270 down. But, if your sprite was drawn facing up, then rotating it 90 degrees + will have it pointing left. The angle goes counter-clockwise. The image will be scaled + such that it continues to fit within the rectangle that it was originally in. This results + in a little bit of shrinking at times, but you should rarely notice that. +

+ Namespace: + SpriteLibrary
+ Assembly: + SpriteLibrary (in SpriteLibrary.dll) Version: 1.0.0.5 (1.0.0.5)

Syntax

public int Rotation { get; set; }

Property Value

Type: Int32

See Also

Reference

Sprite.AnimationCount Property

SpriteLibrary

SpriteAnimationCount Property

+ The number of animations this sprite has +

+ Namespace: + SpriteLibrary
+ Assembly: + SpriteLibrary (in SpriteLibrary.dll) Version: 1.0.0.5 (1.0.0.5)

Syntax

public int AnimationCount { get; }

Property Value

Type: Int32

See Also

Reference

Sprite.ChangeAnimation Method

SpriteLibrary

SpriteChangeAnimation Method

+ Start a new animation index from scratch +

+ Namespace: + SpriteLibrary
+ Assembly: + SpriteLibrary (in SpriteLibrary.dll) Version: 1.0.0.5 (1.0.0.5)

Syntax

public void ChangeAnimation(
+	int WhichAnimation,
+	int StartFrame = 0
+)

Parameters

WhichAnimation: Type: SystemInt32
The animation index you want to use
StartFrame (Optional): Type: SystemInt32
The first frame you want to start the animation at.

See Also

Reference

Sprite.ConvertRadiansToDegrees Method

SpriteLibrary

SpriteConvertRadiansToDegrees Method

+ Convert a number from radians to degrees. +

+ Namespace: + SpriteLibrary
+ Assembly: + SpriteLibrary (in SpriteLibrary.dll) Version: 1.0.0.5 (1.0.0.5)

Syntax

public double ConvertRadiansToDegrees(
+	double Radians
+)

Parameters

Radians: Type: SystemDouble
The number of radians

Return Value

Type: Double
The corresponding number in degrees

See Also

Reference

Sprite.MoveTo Method (Sprite)

SpriteLibrary

MoveTo Method (List(Point))

MoveTo Method

MoveTo Method (Point)

MoveTo Method (Sprite)

SpriteMoveTo Method (Sprite)

+ Move to where the destination sprite currently is at. This is a dumb move. It does not take into + consideration the movement direction of the destination sprite. So the moving sprite does need to be + moving a bit faster than the sprite you are trying to hit for it to do so. +

+ Namespace: + SpriteLibrary
+ Assembly: + SpriteLibrary (in SpriteLibrary.dll) Version: 1.0.0.5 (1.0.0.5)

Syntax

public void MoveTo(
+	Sprite Destination
+)

Parameters

Destination: Type: SpriteLibrarySprite
The sprite we are trying to hit

See Also

Reference

MoveTo Overload

SpriteController Methods

SpriteLibrary

SpriteController Methods

The SpriteController type exposes the following members.

Methods

+ +	Name	Description
	AddSprite	+ Add the specified sprite to the list of sprites we know about. You usually do not need to do this. + Sprites add themselves to the controller when you create a new sprite. +
	AdjustPoint	+ Adjust an image point so that it conforms to the picturebox. +
	AdjustRectangle	+ Adjust a rectangle that is based on the image, according to the stretch of the picturebox +
	AllSprites	+ Return a list of all sprites +
	ChangeTickInterval	+ Change the Tick Interval. By default, the spritecontroller does a tick every 10ms, which + is very fast. Some people may prefer it to happen less regularly. Must be > 5, and less than 1001 +
	CountSpritesBasedOff	+ Count the number of sprites that were duplicated from the sprite with the specified name. When you use a + SpriteController.DuplicateSprite(string) + command, it creates a new sprite that is based off the named sprite. This function will count those duplicated sprites. +
	DestroyAllSprites	+ Remove all sprites (even named sprites that have not yet been displayed) +
	DestroySprite	+ Tell a sprite to destroy itself. The sprite will have Destroying property set to true from + the time you destroy it until it vanishes. Whe you destroy a sprite, it will erase itself + and remove itself from the controller. After it is destroyed, it is completely gone. +
	DuplicateSprite(String)	+ Find a sprite that has been named with the specified name. Then duplicate that sprite +
	DuplicateSprite(Sprite)	+ Make a duplicate of the specified sprite. The duplicate does not yet have a location. +
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Invalidate(Boolean)	+ Invalidate the entire image on which the sprites are drawn +
	Invalidate(Rectangle, Boolean)	+ Invalidate a rectangle that is specified in image coordinates +
	IsKeyPressed	+ Check to see if any keys are pressed. There is a small glitch with the + key-pressed system. If the form loses focus, and someone releases a key, the key-up is never + triggered. It is a good thing to ResetKeypressState() occasionally if you think your form may have + lost focus. +
	IsKeyPressed(Keys)	+ Check to see if the given key is pressed. There is a small glitch with the + key-pressed system. If the form loses focus, and someone releases a key, the key-up is never + triggered. It is a good thing to ResetKeypressState() occasionally if you think your form may have + lost focus. +
	KeysPressed	+ Return a list of all the keys that are currently pressed. There is a small glitch with the + key-pressed system. If the form loses focus, and someone releases a key, the key-up is never + triggered. It is a good thing to ResetKeypressState() occasionally if you think your form may have + lost focus. +
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	NameSprite	+ Find the specified Sprite in the controller and change its name to the specified string. + You can do the same thing with Sprite.SetName(Name)
	Pause	+ Pause everything. It loops through all the sprites in the SpriteController and sends the specified + SpritePauseType to each one. Look at the documentation for SpritePauseType to determine which pause + type to use. +
	PlaceSpriteBehind	+ Change the display order of the sprites such that the specified sprite appears behind the other sprite. +
	PlaceSpriteInFrontOf	+ Make the sprite go in front of the specified sprite. +
	RegisterKeyDownFunction	+ If you want to have a KeyDown function that is triggered by a keypress function, add the event here. + The event should have the parameters (object sender, KeyEventArgs e) +
	RegisterKeyUpFunction	+ If you want to have a KeyUp function that is triggered by a keypress function, add the event here. + The event should have the parameters (object sender, KeyEventArgs e) +
	ReplaceOriginalImage	+ Notify the sprite controller that you have changed the background image on the + PictureBox. Whatever background is on the picturebox is now used to draw all the sprites on. +
	ReplaceOriginalImage(Image)	+ Replace the image on which the sprites are drawn. Use this when you move to a new playing field, + or want to have a different background + Examples + Replacing the background image is actually a lot more complex than you might imagine. Once you use the + below code, it can be done without any problem. But you need to do it this way, or it just goofs up in + a number of small ways. + You need to tell the sprite controller that you are replacing the background image, + and you need to change the image to that image as well.Because the Images are actually + pointers to memory where the image sets, changes to one image will affect the other image.This goofs + things up, so what we do is duplicate the image twice, and tell the sprite controller to use one of the + copies and then set the background to be the other one of the two copies.Finally, we tell the picturebox + to invalidate itself.That does everything that is needed. + C# Copy void ReplaceBackground(Image NewBackground) +{ + if (MyController == null) return; + if (NewBackground == null) return; + + Image OneImage = new Bitmap(NewBackground); + MyController.ReplaceOriginalImage(OneImage); + + Image TwoImage = new Bitmap(NewBackground); + pb_map.BackgroundImage = TwoImage; + pb_map.Invalidate(); +}
	ResetKeypressState	+ Reset the keypress status. Sometimes the sprite controller misses a key being released (usually + because a window has taken priority, or something has changed). Calling this function will reset + the stored memory of whether a key has been pressed. +
	ReturnAdjustmentRatio	+ Return an adjustment ratio. This is the image-size to picture-box ratio. + It is used for calculating precise pixels or picture-box locations. +
	ReturnPictureBoxAdjustedHeight	+ Return the height of an object in picture-box terms. It is basically the virtual height + of the sprite or other item. +
	ReturnPictureBoxAdjustedPoint	+ This does the reverse of an adjusted point. It takes a point on the image and + transforms it to one on the PictureBox +
	ReturnPictureBoxAdjustedWidth	+ Return the width of an object in picture-box terms. It takes the width of a sprite or other + item that is being displayed on the screen, and calculates the width as displayed in the + picture-box (taking into consideration stretching or shrinking) +
	ReturnPointAdjustedForImage	+ This takes a point, the location on a picturebox, and returns the corresponding point on the BackgroundImage. + Picturebox locations are "sloppy"; the background image locations are very precise. Since this takes a "sloppy" + number and returns a precise number, it does some rounding to figure out where the specified location is. +
	SoundIsFinished	+ Check to see if the specified sound has finished playing +
	SoundPlay	+ Play a sound that we can check to see if it has completed. +
	SpriteBackwards	+ Change the display order of the specified sprite so it is more likely to go behind all other sprites. +
	SpriteForwards	+ Change the display order of the specified sprite so it is more likely to go in front of other sprites +
	SpriteFromName	+ Find a sprite that has a specified name. This returns the actual sprite with that name. + You usually want to use DuplicateSprite(Name) to clone the sprite and get one you can + destroy. If you destroy a named sprite without duplicating it, you may end up losing + it for the remainder of the program. +
	SpritesAtImagePoint	+ This takes a point, as as specified on the image, and returns the sprites at that point. Different + functions use different coordinates, whether based off the background image, or based off the picturebox. + This one uses the background image coordinates. Use SpritesAdPoint() if you are doing something based off + a MouseUp or MouseDown function. This is used for functions based on sprite location or based off the absoloute + location (using the background image location is much more precise than the visible location in the picturebox) +
	SpritesAtPoint	+ This takes a point, as given by the mouse-click args, and returns the sprites at that point. Different + functions use different coordinates, whether based off the background image, or based off the picturebox. + This one uses the picturebox coordinates. So you can use this directly from a MouseDown or MouseUp function. +
	SpritesBasedOff	+ Return all sprites that were based off a particular sprite name. + When you use a + SpriteController.DuplicateSprite(string) + command, it creates a new sprite that is based off the named sprite. This function returns a list of those + duplicated sprites. +
	SpritesBasedOffAnything	+ Return a list of all sprites which are not master sprites (which are duplicates of something) +
	SpritesInImageRectangle	+ Return a list of all the sprites that intersect with the given background-image-based rectangle +
	SpritesThatHaveBeenDrawn	+ Return a list of all sprites which have been drawn on the image +
	SpriteToBack	+ Change the display order of the specified sprite so it goes behind all other sprites. +
	SpriteToFront	+ Change the display order of the specified sprite so it goes in front of all other sprites. +
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	UnPause	+ un-Pause everything. This will send the specified SpritePauseType unpause command + to all sprites. +

See Also

Reference

Sprite.BaseImageLocation Property

SpriteLibrary

SpriteBaseImageLocation Property

+ The sprite location as found on the base image. This is usually the easiest location to use. +

+ Namespace: + SpriteLibrary
+ Assembly: + SpriteLibrary (in SpriteLibrary.dll) Version: 1.0.0.5 (1.0.0.5)

Syntax

public Point BaseImageLocation { get; }

Property Value

Type: Point

See Also

Reference

Sprite.SpriteInitializes Event

SpriteLibrary

SpriteSpriteInitializes Event

+ This event happens right after the sprite is created. Use this to immediately set a + sprite to animate once or something like that. +

+ Namespace: + SpriteLibrary
+ Assembly: + SpriteLibrary (in SpriteLibrary.dll) Version: 1.0.0.5 (1.0.0.5)

Syntax

public event SpriteSpriteEventHandler SpriteInitializes

Value

See Also

Reference

SpriteController.SpritesThatHaveBeenDrawn Method

SpriteLibrary

SpriteControllerSpritesThatHaveBeenDrawn Method

+ Return a list of all sprites which have been drawn on the image +

+ Namespace: + SpriteLibrary
+ Assembly: + SpriteLibrary (in SpriteLibrary.dll) Version: 1.0.0.5 (1.0.0.5)

Syntax

public List<Sprite> SpritesThatHaveBeenDrawn()

Return Value

Type: ListSprite
A list of sprites that have been drawn

See Also

Reference

SpriteController.ReplaceOriginalImage Method

SpriteLibrary

ReplaceOriginalImage Method (Image)

SpriteControllerReplaceOriginalImage Method

Overload List

+ +	Name	Description
	ReplaceOriginalImage	+ Notify the sprite controller that you have changed the background image on the + PictureBox. Whatever background is on the picturebox is now used to draw all the sprites on. +
	ReplaceOriginalImage(Image)	+ Replace the image on which the sprites are drawn. Use this when you move to a new playing field, + or want to have a different background + Examples + Replacing the background image is actually a lot more complex than you might imagine. Once you use the + below code, it can be done without any problem. But you need to do it this way, or it just goofs up in + a number of small ways. + You need to tell the sprite controller that you are replacing the background image, + and you need to change the image to that image as well.Because the Images are actually + pointers to memory where the image sets, changes to one image will affect the other image.This goofs + things up, so what we do is duplicate the image twice, and tell the sprite controller to use one of the + copies and then set the background to be the other one of the two copies.Finally, we tell the picturebox + to invalidate itself.That does everything that is needed. + C# Copy void ReplaceBackground(Image NewBackground) +{ + if (MyController == null) return; + if (NewBackground == null) return; + + Image OneImage = new Bitmap(NewBackground); + MyController.ReplaceOriginalImage(OneImage); + + Image TwoImage = new Bitmap(NewBackground); + pb_map.BackgroundImage = TwoImage; + pb_map.Invalidate(); +}

See Also

Reference

SpriteController Constructor

SpriteLibrary

SpriteController Constructor

SpriteController Constructor (PictureBox)

SpriteController Constructor (PictureBox, EventHandler)

SpriteController Constructor

Overload List

+ +	Name	Description
	SpriteController(PictureBox)	+ Create a sprite controller, specifying the picturebox on which the sprites + will be displayed. You want to have the PictureBox already defined, and a background image + already set for the PictureBox. +
	SpriteController(PictureBox, EventHandler)	+ Create a sprite controller, specifying the picturebox on which the sprites + will be displayed. +

See Also

Reference

SpriteController.OptimizeForLargeSpriteImages Field

SpriteLibrary

OptimizeForLargeSpriteImages Field

SpriteController Fields

RandomNumberGenerator Field

SpriteComparisonDelegate Field

SpriteControllerOptimizeForLargeSpriteImages Field

+ If your sprite images need substantial growing or shrinking when displayed, you can try setting this to "true" + to see if it makes it run any faster. What it does is to resize the image once, and keep a cached copy of that + image at that size. If you use the same sprite, but with different sizes, setting this to "True" may actually slow + down the game instead of speeding it up. +

+ Namespace: + SpriteLibrary
+ Assembly: + SpriteLibrary (in SpriteLibrary.dll) Version: 1.0.0.5 (1.0.0.5)

Syntax

public bool OptimizeForLargeSpriteImages

Field Value

Type: Boolean

See Also

Reference

Sprite.SetName Method

SpriteLibrary

SpriteSetName Method

+ Give this sprite a name. This way we can make a duplicate of it by specifying the name +

+ Namespace: + SpriteLibrary
+ Assembly: + SpriteLibrary (in SpriteLibrary.dll) Version: 1.0.0.5 (1.0.0.5)

Syntax

public void SetName(
+	string Name
+)

Parameters

Name: Type: SystemString
A string that represents the new name of the sprite

See Also

Reference

Sprite.SpriteExitsPictureBox Event

SpriteLibrary

SpriteSpriteExitsPictureBox Event

+ This happens when the sprite has exited the picture box. Useful when you want to + keep sprites from traveling on forever after exiting. +

+ Namespace: + SpriteLibrary
+ Assembly: + SpriteLibrary (in SpriteLibrary.dll) Version: 1.0.0.5 (1.0.0.5)

Syntax

public event SpriteSpriteEventHandler SpriteExitsPictureBox

Value

See Also

Reference

SpriteKeyEventHandler Delegate

SpriteLibrary

Sprite.SpriteEventHandler Delegate

SpriteCollisionMethod Enumeration

SpriteKeyEventHandler Delegate

SpritePauseType Enumeration

SpriteKeyEventHandler Delegate

+ This is a delegate for a keypress event. +

+ Namespace: + SpriteLibrary
+ Assembly: + SpriteLibrary (in SpriteLibrary.dll) Version: 1.0.0.5 (1.0.0.5)

Syntax

public delegate void SpriteKeyEventHandler(
+	Object sender,
+	KeyEventArgs e
+)

Parameters

sender: Type: SystemObject
e: Type: System.Windows.FormsKeyEventArgs

See Also

Reference

Sprite.payload Field

SpriteLibrary

CannotMoveOutsideBox Field

Sprite Fields

MirrorHorizontally Field

MirrorVertically Field

MovementSpeed Field

payload Field

Spritepayload Field

+ A Sprite can hold a payload. Use this to store extra information about the various Sprites. Health, Armor, + Shoot time, etc. But, to store information in the payload, you need to make a new class of SpritePayload. The syntax + for doing so is: +

public class TankPayload : SpritePayload {  public int Armor; public int Speed; }

+ You can access the payload and retrieve the various values. +

+ Namespace: + SpriteLibrary
+ Assembly: + SpriteLibrary (in SpriteLibrary.dll) Version: 1.0.0.5 (1.0.0.5)

Syntax

public SpritePayload payload

Field Value

Type: SpritePayload

See Also

Reference

Sprite.SpriteHitsPictureBox Event

SpriteLibrary

SpriteSpriteHitsPictureBox Event

+ This happens when the sprite hits the border of the picture-box. + Useful for when you want to have shots explode when they hit the side. +

+ Namespace: + SpriteLibrary
+ Assembly: + SpriteLibrary (in SpriteLibrary.dll) Version: 1.0.0.5 (1.0.0.5)

Syntax

public event SpriteSpriteEventHandler SpriteHitsPictureBox

Value

See Also

Reference

Sprite.AnimateJustAFewTimes Method

SpriteLibrary

SpriteAnimateJustAFewTimes Method

+ Start a new animation. It will complete the animation the number of times you specify. + For example, if your sprite is walking, and one animation is one step, specifying 4 here + will result in your sprite taking 4 steps and then the animation stops. You will want + to make sure you are checking for when the animation stops, using the SpriteAnimationComplete event, + checking the Sprite.AnimationDone flag. +

+ Namespace: + SpriteLibrary
+ Assembly: + SpriteLibrary (in SpriteLibrary.dll) Version: 1.0.0.5 (1.0.0.5)

Syntax

public void AnimateJustAFewTimes(
+	int WhichAnimation,
+	int HowManyAnimations,
+	int AnimationFrameToEndOn = -1
+)

Parameters

WhichAnimation: Type: SystemInt32
The animation index you want to use
HowManyAnimations: Type: SystemInt32
The number of animations to do before it stops
AnimationFrameToEndOn (Optional): Type: SystemInt32
Once the animation has finished, display this animation frame. + -1, or any number that is not an actual frame, will show the last frame of the animation.

See Also

Reference

SpriteController.SpritesAtPoint Method

SpriteLibrary

SpriteControllerSpritesAtPoint Method

+ This takes a point, as given by the mouse-click args, and returns the sprites at that point. Different + functions use different coordinates, whether based off the background image, or based off the picturebox. + This one uses the picturebox coordinates. So you can use this directly from a MouseDown or MouseUp function. +

+ Namespace: + SpriteLibrary
+ Assembly: + SpriteLibrary (in SpriteLibrary.dll) Version: 1.0.0.5 (1.0.0.5)

Syntax

public List<Sprite> SpritesAtPoint(
+	Point Location
+)

Parameters

Location: Type: System.DrawingPoint
The picture-box point being clicked on

Return Value

Type: ListSprite
A list of sprites that are all at the specified point.

See Also

Reference

Sprite.GetImage Method (Int32, Int32)

SpriteLibrary

GetImage Method (Int32, Int32)

SpriteGetImage Method (Int32, Int32)

+ return the frame for the given index. Warning: If you write to this image, it will + affect all sprites using this frame. +

+ Namespace: + SpriteLibrary
+ Assembly: + SpriteLibrary (in SpriteLibrary.dll) Version: 1.0.0.5 (1.0.0.5)

Syntax

public Image GetImage(
+	int Animation_Index,
+	int Frame_Index
+)

Parameters

Animation_Index: Type: SystemInt32
The Animation index we are trying to find
Frame_Index: Type: SystemInt32
The Frame index we are trying to find

Return Value

Type: Image
An image that is the current sprite frame for the current animation

See Also

Reference

GetImage Overload

SpriteController Events

SpriteLibrary

SpriteController Events

DoTick Event

SpriteController Events

The SpriteController type exposes the following members.

Events

+ +	Name	Description
	DoTick	+ The function called by the timer every 10 millisecods This is usually where you will do the majority of the work. + You can define this manually, or when you instantiate the SpriteController

See Also

Reference

SpriteController.ReturnAdjustmentRatio Method

SpriteLibrary

SpriteControllerReturnAdjustmentRatio Method

+ Return an adjustment ratio. This is the image-size to picture-box ratio. + It is used for calculating precise pixels or picture-box locations. +

+ Namespace: + SpriteLibrary
+ Assembly: + SpriteLibrary (in SpriteLibrary.dll) Version: 1.0.0.5 (1.0.0.5)

Syntax

public SpriteAdjustmentRatio ReturnAdjustmentRatio()

Return Value

Type: SpriteAdjustmentRatio
A SpriteAdjustmentRatio containing the current ratio of picture-box pixels to image-box pixels

See Also

Reference

SpriteController.ReturnPictureBoxAdjustedHeight Method

SpriteLibrary

SpriteControllerReturnPictureBoxAdjustedHeight Method

+ Return the height of an object in picture-box terms. It is basically the virtual height + of the sprite or other item. +

+ Namespace: + SpriteLibrary
+ Assembly: + SpriteLibrary (in SpriteLibrary.dll) Version: 1.0.0.5 (1.0.0.5)

Syntax

public int ReturnPictureBoxAdjustedHeight(
+	int Height
+)

Parameters

Height: Type: SystemInt32
The image-box heigh (or sprite height)

Return Value

Type: Int32
An integer that corresponds to the hight as displayed in the picturebox

See Also

Reference

SpriteController.Invalidate Method (Boolean)

SpriteLibrary

Invalidate Method (Boolean)

Invalidate Method

Invalidate Method (Rectangle, Boolean)

SpriteControllerInvalidate Method (Boolean)

+ Invalidate the entire image on which the sprites are drawn +

+ Namespace: + SpriteLibrary
+ Assembly: + SpriteLibrary (in SpriteLibrary.dll) Version: 1.0.0.5 (1.0.0.5)

Syntax

public void Invalidate(
+	bool QueueUpInvalidation = true
+)

Parameters

QueueUpInvalidation (Optional): Type: SystemBoolean
Whether to do it now, or to queue it up for another time.

See Also

Reference

Invalidate Overload

SpriteEventArgs Methods

SpriteLibrary

SpriteEventArgs Constructor

SpriteEventArgs Methods

SpriteEventArgs Fields

SpriteEventArgs Methods

The SpriteEventArgs type exposes the following members.

Methods

+ +	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

See Also

Reference

SpriteController.ResetKeypressState Method

SpriteLibrary

SpriteControllerResetKeypressState Method

+ Reset the keypress status. Sometimes the sprite controller misses a key being released (usually + because a window has taken priority, or something has changed). Calling this function will reset + the stored memory of whether a key has been pressed. +

+ Namespace: + SpriteLibrary
+ Assembly: + SpriteLibrary (in SpriteLibrary.dll) Version: 1.0.0.5 (1.0.0.5)

Syntax

public void ResetKeypressState()

See Also

Reference

SpriteController.ReplaceOriginalImage Method

SpriteLibrary

ReplaceOriginalImage Method (Image)

SpriteControllerReplaceOriginalImage Method

+ Notify the sprite controller that you have changed the background image on the + PictureBox. Whatever background is on the picturebox is now used to draw all the sprites on. +

+ Namespace: + SpriteLibrary
+ Assembly: + SpriteLibrary (in SpriteLibrary.dll) Version: 1.0.0.5 (1.0.0.5)

Syntax

public void ReplaceOriginalImage()

See Also

Reference

ReplaceOriginalImage Overload

Sprite.AddAnimation Method (Image, Size)

SpriteLibrary

AddAnimation Method (Point, Image, Int32, Int32, Int32, Int32)

SpriteAddAnimation Method (Image, Size)

+ Add another animation to an existing Sprite. After you add animations, you can use + ChangeAnimation to select which animation you want the specified sprite to show. + For example, you may want to have Animation 0 be a guy walking left, and animation 1 is + that same guy walking right. Because we do not specify the number of frames, it starts + at the top-left corner and grabs as many frames as it can from the image. +

+ Namespace: + SpriteLibrary
+ Assembly: + SpriteLibrary (in SpriteLibrary.dll) Version: 1.0.0.5 (1.0.0.5)

Syntax

public void AddAnimation(
+	Image SpriteImage,
+	Size SpriteSize
+)

Parameters

SpriteImage: Type: System.DrawingImage
The animation image to grab the frames from
SpriteSize: Type: System.DrawingSize
The size of each frame

See Also

Reference

AddAnimation Overload

SpritePayload Class

SpriteLibrary

SpritePayload Constructor

SpritePayload Methods

SpritePayload Class

+ The SpritePayload is a stub of a class, for storing user-defined data and functions along with a sprite. +

Inheritance Hierarchy

SystemObject
SpriteLibrarySpritePayload

+ Namespace: + SpriteLibrary
+ Assembly: + SpriteLibrary (in SpriteLibrary.dll) Version: 1.0.0.5 (1.0.0.5)

Syntax

public class SpritePayload

The SpritePayload type exposes the following members.

Constructors

+ +	Name	Description
	SpritePayload	Initializes a new instance of the SpritePayload class

Methods

+ +	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Examples

+ Basically, you want to "override" this class. You do this by making your + own class that looks something like: +

public class TankPayload : SpritePayload 
+{ 
+    public int Armor = 20; 
+    public int FireTime = 100; 
+}

+ And then you add that to your sprite: +

TankSprite.Payload = new TankPayload();

+ If there is no payload, then the payload + property is null. If you have multiple types of SpritePayloads, you may need to do something like: +

if(TankSprite.payload != null and TankSprite.payload is TankPayload) 
+{ 
+    TankPayload tPayload = (TankPayload)TankSprite.payload; tPayload.Armor--; 
+}

See Also

Reference

SpriteController.AdjustRectangle Method

SpriteLibrary

SpriteControllerAdjustRectangle Method

+ Adjust a rectangle that is based on the image, according to the stretch of the picturebox +

+ Namespace: + SpriteLibrary
+ Assembly: + SpriteLibrary (in SpriteLibrary.dll) Version: 1.0.0.5 (1.0.0.5)

Syntax

public Rectangle AdjustRectangle(
+	Rectangle ImageRectangle
+)

Parameters

ImageRectangle: Type: System.DrawingRectangle
A rectangle using coordinates from the image

Return Value

Type: Rectangle
a rectangle that is adjusted for the PictureBox

See Also

Reference

Sprite.SpriteAtImagePoint Method

SpriteLibrary

SpriteSpriteAtImagePoint Method

+ Check to see if the sprite exists at the point specified. The point given is + in coordinates used by the image (not the PictureBox, use SpriteAtPictureBox for that) +

+ Namespace: + SpriteLibrary
+ Assembly: + SpriteLibrary (in SpriteLibrary.dll) Version: 1.0.0.5 (1.0.0.5)

Syntax

public bool SpriteAtImagePoint(
+	Point location,
+	SpriteCollisionMethod method = SpriteCollisionMethod.rectangle
+)

Parameters

location: Type: System.DrawingPoint
An imagebox location
method (Optional): Type: SpriteLibrarySpriteCollisionMethod
the method to use to determine if the image is there

Return Value

Type: Boolean
true if the sprite is at that position, false if it is not

See Also

Reference

SpriteController.IsKeyPressed Method

SpriteLibrary

IsKeyPressed Method (Keys)

IsKeyPressed Method

SpriteControllerIsKeyPressed Method

Overload List

+ +	Name	Description
	IsKeyPressed	+ Check to see if any keys are pressed. There is a small glitch with the + key-pressed system. If the form loses focus, and someone releases a key, the key-up is never + triggered. It is a good thing to ResetKeypressState() occasionally if you think your form may have + lost focus. +
	IsKeyPressed(Keys)	+ Check to see if the given key is pressed. There is a small glitch with the + key-pressed system. If the form loses focus, and someone releases a key, the key-up is never + triggered. It is a good thing to ResetKeypressState() occasionally if you think your form may have + lost focus. +

See Also

Reference

Sprite.ClickTransparent Event

SpriteLibrary

SpriteClickTransparent Event

+ This event happens when someone clicks on the sprite (on the sprite image itself). + If the sprite is sometimes hidden, but you want the click to work even if it is not + visible at that instant, use Click instead. +

+ Namespace: + SpriteLibrary
+ Assembly: + SpriteLibrary (in SpriteLibrary.dll) Version: 1.0.0.5 (1.0.0.5)

Syntax

public event SpriteSpriteEventHandler ClickTransparent

Value

See Also

Reference

Sprite.AddAnimation Method (Image, Int32)

SpriteLibrary

AddAnimation Method (Point, Image, Int32, Int32, Int32, Int32)

SpriteAddAnimation Method (Image, Int32)

+ Namespace: + SpriteLibrary
+ Assembly: + SpriteLibrary (in SpriteLibrary.dll) Version: 1.0.0.5 (1.0.0.5)

Syntax

public void AddAnimation(
+	Image SpriteImage,
+	int duration
+)

Parameters

SpriteImage: Type: System.DrawingImage
The animation image to grab the frames from
duration: Type: SystemInt32
The duration the single frame uses before refreshing. 1000 is a good number.

See Also

Reference

AddAnimation Overload

SpriteController.DestroySprite Method

SpriteLibrary

SpriteControllerDestroySprite Method

+ Tell a sprite to destroy itself. The sprite will have Destroying property set to true from + the time you destroy it until it vanishes. Whe you destroy a sprite, it will erase itself + and remove itself from the controller. After it is destroyed, it is completely gone. +

+ Namespace: + SpriteLibrary
+ Assembly: + SpriteLibrary (in SpriteLibrary.dll) Version: 1.0.0.5 (1.0.0.5)

Syntax

public void DestroySprite(
+	Sprite what
+)

Parameters

what: Type: SpriteLibrarySprite
The Sprite to destroy

See Also

Reference

Sprite.ReturnAdjustmentRatio Method

SpriteLibrary

SpriteReturnAdjustmentRatio Method

+ Taking into consideration how the sprite is stretched or shrunk, it + returns a SpriteAdjustmentRatio that can be used to work with the sprite + itself. +

+ Namespace: + SpriteLibrary
+ Assembly: + SpriteLibrary (in SpriteLibrary.dll) Version: 1.0.0.5 (1.0.0.5)

Syntax

public SpriteAdjustmentRatio ReturnAdjustmentRatio()

Return Value

Type: SpriteAdjustmentRatio
The current SpriteAdjustmentRatio used to display this sprite

See Also

Reference

SpriteAdjustmentRatio Methods

SpriteLibrary

SpriteAdjustmentRatio Methods

SpriteAdjustmentRatio Fields

SpriteAdjustmentRatio Methods

The SpriteAdjustmentRatio type exposes the following members.

Methods

+ +	Name	Description
	Equals	Indicates whether this instance and a specified object are equal. (Inherited from ValueType.)
	GetHashCode	Returns the hash code for this instance. (Inherited from ValueType.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ToString	Returns the fully qualified type name of this instance. (Inherited from ValueType.)

See Also

Reference

SpritePayload Methods

SpriteLibrary

SpritePayload Constructor

SpritePayload Methods

The SpritePayload type exposes the following members.

Methods

+ +	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

See Also

Reference

Sprite.PutBaseImageLocation Method (Point)

SpriteLibrary

PutBaseImageLocation Method (Point)

PutBaseImageLocation Method (Double, Double)

SpritePutBaseImageLocation Method (Point)

+ Namespace: + SpriteLibrary
+ Assembly: + SpriteLibrary (in SpriteLibrary.dll) Version: 1.0.0.5 (1.0.0.5)

Syntax

public void PutBaseImageLocation(
+	Point NewLocationOnImage
+)

Parameters

NewLocationOnImage: Type: System.DrawingPoint
The new point on the Image

See Also

Reference

PutBaseImageLocation Overload

Sprite.VisibleHeight Property

SpriteLibrary

SpriteVisibleHeight Property

+ The visible Height as seen in the PictureBox. It may be stretched, or shrunk from the actual + image size. +

+ Namespace: + SpriteLibrary
+ Assembly: + SpriteLibrary (in SpriteLibrary.dll) Version: 1.0.0.5 (1.0.0.5)

Syntax

public int VisibleHeight { get; }

Property Value

Type: Int32

See Also

Reference

SpriteController.SpriteToBack Method

SpriteLibrary

SpriteControllerSpriteToBack Method

+ Change the display order of the specified sprite so it goes behind all other sprites. +

+ Namespace: + SpriteLibrary
+ Assembly: + SpriteLibrary (in SpriteLibrary.dll) Version: 1.0.0.5 (1.0.0.5)

Syntax

public void SpriteToBack(
+	Sprite What
+)

Parameters

What: Type: SpriteLibrarySprite
The sprite to send behind all other sprites

See Also

Reference