Click or drag to resize
LayerBase Class
Defines the basic operation of a layer of tiles and sprites within a map.
Inheritance Hierarchy

Namespace: (Default Namespace)
Assembly: Default (in Default.exe) Version: 1.0.0.0
Syntax
C#
[SerializableAttribute]
public abstract class LayerBase : IEnumerable

The LayerBase type exposes the following members.

Methods
  NameDescription
Public methodAppendFrames
Injects a series of Frame objects into this layer, to be drawn behind the layer or in front of it, specifying a color modulation value.
Public methodClearInjections
Remove all injected frames from the layer.
Public methodDraw
Draw the layer according to the currently active view defined by CurrentView.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodExecuteRules
Public methodExecuteRulesInternal
Executes the rules for all the plans on this layer
Public methodGetBottomSolidPixel
Determine the vertical offset of the bottom-most solid pixel within the specified rectangle.
Public methodGetEnumerator
Enumerates active sprites on the layer.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetLeftSolidPixel
Determine the horizontal offset of the left-most solid pixel within the specified rectangle.
Public methodGetMousePosition
Retrieve the current mouse position
Public methodGetRightSolidPixel
Determine the horizontal offset of the right-most solid pixel within the specified rectangle.
Public methodGetTile
Retrieves information about the tile at the specified tile coordinate
Public methodGetTopSolidPixel
Determine the vertical offset of the top-most solid pixel within the specified rectangle.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodInjectFrames(Int32, Int32, Frame)
Injects a series of Frame objects into this layer, to be interleaved with the tiles on the layer.
Public methodInjectFrames(Int32, Int32, Frame, Int32)
Injects a series of Frame objects into this layer, to be interleaved with the tiles on the layer, specifying a color modulation value.
Public methodInjectSprites
Inject frames into the layer to represent the current images and positions of the sprites contained in this layer for this loop iteration.
Public methodIsSpriteVisible
Determines if any part of the specified sprite is visible in the current view.
Public methodMove
Move/Scroll the layer to a new position based on the current map position. The layer's current position is offset by its position on the map and scaled by the layer's scroll rate.
Public methodProcessSprites
Execute the rules of all active sprites on this layer.
Public methodPushSpriteIntoView
Push the specified sprite into the currently active view.
Public methodScrollSpriteIntoView
Scroll the currently active view on the map so the specified sprite is visible.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Fields
  NameDescription
Public fieldm_SpriteCategories
Provides access to all sprite categories as they relate to this layer.
Public fieldm_Sprites
A "Category" or collection of all sprites contained by the layer.
Top
Properties
  NameDescription
Public propertyAbsolutePosition
Get or set the position of the layer within the map. (Does not affect current position until Move(Point) is called)
Public propertyActualColumns
Get the number of columns of tiles in the layer's tile data
Public propertyActualRows
Get the number of rows of tiles in the layer's tile data
Public propertyCurrentPosition
Gets/Sets the current pixel position of the layer relative to the screen. (Setting this directly ignores ScrollRate and AbsolutePosition.)
Public propertyItem
Retrieves or sets the value of a tile at the specified tile coordinate
Public propertyLighting
Determines whether lighing effect are enabled for this layer.
Public propertyParentMap
Returns the map that owns this layer
Public propertyScrollRate
Gets the scroll rate that is applied to Move(Point) operations.
Public propertyTileset
Public propertyVirtualColumns
Get the number of columns of tiles in the layer's displayed virtual scroll space (data is wrapped)
Public propertyVirtualRows
Get the number of rows of tiles in the layer's displayed virtual scroll space (data is wrapped)
Public propertyVisibleArea
Returns a rectangle within this layer that represents the currently visible portion.
Top
See Also