Constructs a new sprite instance given all its base properties.

Accelerate this sprite according to which directional inputs are on/pressed.

Create a new (dynamic) instance of the specified sprite positioned such that HotSpot on the created sprite overlaps Location on this sprite.

Increment or decrement horizontal velocity

Increment or decrement vertical velocity

Advance the animation frame of this sprite according to its velocity or a constant rate.

Use properties of the sprites in the specified category to configure real-time lighting on the display for the current frame.

Determines if the sprite is blocked from moving freely in a particular direction by solidity on the layer.

Return a state that is in the same group of states as the sprite's current state, but possibly pointing a different direction.

Determines if there is a previous map to return to.

Change a counter's value with a pre-defined operation.

Clears all active messages from the display.

Turns off all current inputs on this sprite.

Turn off the overlay map.

Resets all parameter values defined on the specific sprite definition to 0.

Determines if the specified mouse button is pressed.

Deactivate this sprite.

Deactivate the sprite currently selected as the target for the specified name and clear the sprite selected for that target name.

Empties the specified save slot.

When the mouse drags over the display, scroll the map along with it.

Determines whether the specified object is equal to the current object.

Exclude the specified counter from the SaveUnit that will be saved with the next call to SaveGame(Int32, Boolean).

Remove the specified map in from the SaveUnit that will be saved with the next call to SaveGame(Int32, Boolean).

Returns information about the visual boundaries of the sprite's currently displayed frame(s).

Get a list of frameset frames that the sprite is currently displaying

Serves as the default hash function.

Compute the index of the nearest active sprite from the specified category and return it.

Calculate the state that a rotating sprite should use in order to point in the direction it is currently traveling

Return a random number within a specified range.

Calculate the absolute position of a specified RelativePosition value with respect to this sprite.

Returns the sprite currently selected for the specified target name.

Get the value of a numeric property or parameter on a sprite selected with SelectTargetSpriteFor(SpriteCollection, Int32, String).

Gets the Type of the current instance.

Include the specified counter in the SaveUnit that will be saved with the next call to SaveGame(Int32, Boolean).

Includes a specified set of objects in the SaveUnit that will be saved with the next call to SaveGame(Int32, Boolean).

Include the specified map in the SaveUnit that will be saved with the next call to SaveGame(Int32, Boolean).

Determine if the specified input is being pressed for this sprite.

Determines if the sprite is in the specified range of states.

Determines if a specified key is being pressed.

Determine if the specified map-specific flag on the current map is on.

Determines if the specified mouse button is pressed.

Determines if the sprite is moving in the specified direction at all.

Determines if a tile at the sprite's current position is a member of the specified category.

Determines if the specified point within a sprite is blocked from moving in a particular direction by the specified number of pixels.

Determine if the sprite is riding another sprite

Determine if the sprite selected for the specified target (selected with SelectTargetSpriteFor) is of the specified type.

Determine if a sprite has been selected with SelectLastCreatedSpriteFor(String) or SelectTargetSpriteFor(SpriteCollection, Int32, String).

Tests to see if this sprite is landing on a platform (from above), and if so, make the sprite ride the platform.

Limit the frame rate of the game to the specified number of frames per second. Call this only once per frame.

If the velocity of the sprite is more than the specified maximum, normalize it so that it's going the same direction, but at no more that the specified maximum speed.

Restore the state of the objects contained in the specified save slot.

Write a string to the debug output without moving to the next line.

Write a number to the debug output and move to the next line.

Associates the state of the specified keyboard key with the specified input on this sprite.

Move the sprite to the position of the mouse cursor and set the sprite's button inputs based on mouse button states.

Associate the state of the input device for the specified player with the inputs on this sprite.

Move this sprite according to its current velocity

Accelerate a rotating sprite in the direction that it is aiming.

Execute the rules for this sprite if they have not already been executed this frame

Alter the velocity of TargetSprite to plan to move out of the way of this sprite if TargetSprite is obstructing this sprite.

Alter this sprite's velocity so that it remains within the map's visible area or within the scroll margins, according to this sprite's layer's position within the map.

Push this sprite toward a sprite in the specified category.

Push this sprite toward a specified sprite.

Quit the game by closing the main window.

Reduces the sprite's velocity to simulate friction.

Adjust this sprite's velocity according to the motion of the platform it is riding

Alter the velocity of this sprite to plan to move out of the way of sprites in Pushers if this sprite is obstructing sprites in Pushers.

Alter the velocity of this sprite to plan to move out of the way of sprites in Pushers but if this sprite is planning to overlap a sprite in Pushers, only after those sprites have processed their rules (usually to react to this sprite's pushing first).

Alter the sprite's velocity to react to solid areas on the map.

Remove the sprite from its designated categories. USE ONLY on dynamically added sprites.

Reset all light sources to initial default behavior.

Return to the map that was active before the last SwitchToMap(Type, Boolean).

Redirect this sprite's velocity to be 100% in the direction that it is facing.

Determines if saved game data exists in the specified slot.

Save the current SaveUnit into the specified save slot.

Scroll all layers on this sprite's layer's map so that the sprite is within visible area of the map.

Select the most recently created sprite to be the target of SetTargetParameter(String, Int32).

Selects the most recently created sprite to be the target of SetTargetParameterFor(String, Int32, String) or GetTargetParameterFor(String, String).

Selects a sprite within a collection, using a 0-based index, to be the target of SetTargetParameter(String, Int32).

Selects a sprite within a collection, using a 0-based index, to be the target of SetTargetParameterFor(String, Int32, String). TargetName allows any number of unique targets to be selected by assigning unique names.

Sets the current state of a sprite based on a category and index into the category.

Turns on or off the specified input on this sprite.

Set the state of the directional inputs on this sprite to move toward the specified sprite in a category.

Set the state of the directional inputs on this sprite to move toward the specified sprite.

Turn on or off a flag associated with the current map.

Sets the background for new messages added with ShowMessage(String).

Determines which player and which button will dismiss newly created messages.

Set the tileset used as the source for characters in messages.

Determines where newly created messages appear.

Set the overlay map.

Set the solidity rules to which the sprite is currently reacting.

Turn on or off a flag associated with the specified map.

Set the value of a numeric property or parameter on a sprite selected with SelectTargetSprite(SpriteCollection, Int32) to the specified value.

Set the value of a numeric property or parameter on a sprite selected with SelectTargetSpriteFor(SpriteCollection, Int32, String) to the specified value.

Sets the layout of multiple views for the current map.

Adds a message to the display.

Ensure the sprite stays in contact with the ground by altering its velocity to snap down onto the ground when it is close to the ground.

Stop riding the sprite that this sprite is currently riding, if any.

Sets a different map as the one to be drawn on the game display.

Switch the sprite to the the specified state, ensuring that the sprite doesn't hit a solid.

Determine whether the sprite's collision mask is overlapping part of any sprite in the specified category.

Determine if this sprite is planning to overlap the target sprite.

Determine whether the solidity rectangle of the sprite overlaps that of any sprite in the specified category.

Activate the next inactive sprite from a category at the coordinates of a tile being touched by the sprite.

Create a new (dynamic) instance of the specified sprite type at the coordinates of a tile being touched by the player.

Determine if the sprite is touching a tile in the specified category (requires TouchTiles(TileCategoryName)).

Change tiles of the specified type that the sprite is touching to another tile (requires TouchTiles(TileCategoryName)).

Change the tile specified by TouchingIndex that is being touched by the sprite to another tile (requires TouchTiles(TileCategoryName)).

Determine if the sprite is touching the specified tile, and if so, "take" it and increment a counter (requires TouchTiles(TileCategoryName)).

Find the next unprocessed tile of the specified type (requires TouchTiles(TileCategoryName)).

Make the specified tile behave like it is "using up" one of the items tracked by the specified counter (requires TouchTiles(TileCategoryName)).

Returns a string that represents the current object.

Collects information about tiles the sprite is currently touching.

Unload all maps that aren't currently visible.

Unloads the specified map.

A combination of ModulateRed, ModulateGreen, ModulateBlue and ModulateAlpha.

Horizontal velocity of the sprite in pixels per frame

Vertical velocity of the sprite in pixels per frame

Numeric value corresponding to the sprite's current frame.

Stores the inputs that are currently being "pressed" on this sprite.

Determines if this sprite is currently active.

Horizontal velocity relative to the sprite's environment (like a platform)

Vertical velocity relative to the sprite's environment

Remembers the inputs that were active on this sprite in the previous frame

The value of this sprite's x coordinate on the previous frame.

The value of this sprite's y coordinate on the previous frame.

Determines if this sprite's definition's rules have been processed yet this frame

Stores the platform sprite (the sprite that this sprite rides on). If not set, then the sprite is not riding anything.

Numeric value corresponding to the sprite's current state.

A collection of tiles being processed by TouchTiles(TileCategoryName) and other rules related to tile interactions.

Horizontal coordinate of the sprite within its layer.

Vertical coordinage of the sprite within its layer.

Retrieves information about the state that the sprite is currently in.

If multiple views are visible, this determines which view is currently active.

Returns information about a specified state of this sprite

Affects the sprite's visibility.

Affects the output of blue when this sprite is drawn.

Affects the output of green when this sprite is drawn.

Affects the output of red when this sprite is drawn.

The horizontal pixel coordinate that the sprite was at on the previous frame

The vertical pixel coordinate that the sprite was at on the previous frame

Retrieves information about the layer in which the sprite resides.

Horizontal position of the sprite within the layer rounded toward zero to yield an integer.

Vertical position of the sprite within the layer rounded toward zero to yield an integer.

The horizontal coordinate that the sprite is expected to be at on the next frame based on its current position and velocity, rounded toward zero to yield an integer pixel coordinate.

The vertical coordinate that the sprite is expected to be at on the next frame based on its current position and velocity, rounded toward zero to yield an integer pixel coordinate.

How many pixels high is the solid area of this sprite.

How many pixels wide is the solid area of this sprite.