LightSpriteBase Class |
Namespace: (Default Namespace)
public abstract class LightSpriteBase : SpriteBase
The LightSpriteBase type exposes the following members.
Name | Description | |
---|---|---|
LightSpriteBase |
Construct a new light source sprite providing all the properties of the light source and the base sprite.
|
Name | Description | |
---|---|---|
AccelerateByInputs |
Accelerate this sprite according to which directional inputs are on/pressed.
(Inherited from SpriteBase.) | |
AddSpriteHere |
Create a new (dynamic) instance of the specified sprite positioned such that HotSpot on the created sprite overlaps Location on this sprite.
(Inherited from SpriteBase.) | |
AlterXVelocity |
Increment or decrement horizontal velocity
(Inherited from SpriteBase.) | |
AlterYVelocity |
Increment or decrement vertical velocity
(Inherited from SpriteBase.) | |
Animate |
Advance the animation frame of this sprite according to its velocity or a constant rate.
(Inherited from SpriteBase.) | |
ApplyLights |
Use properties of the sprites in the specified category to configure real-time lighting on the display
for the current frame.
(Inherited from GeneralRules.) | |
Blocked |
Determines if the sprite is blocked from moving freely in a particular direction by solidity on the layer.
(Inherited from SpriteBase.) | |
CalculateRotatedState |
Return a state that is in the same group of states as the sprite's current state,
but possibly pointing a different direction.
(Inherited from SpriteBase.) | |
CanReturnToPreviousMap |
Determines if there is a previous map to return to.
(Inherited from GeneralRules.) | |
ChangeCounter |
Change a counter's value with a pre-defined operation.
(Inherited from GeneralRules.) | |
ClearAllMessages |
Clears all active messages from the display.
(Inherited from GeneralRules.) | |
ClearInputs |
Turns off all current inputs on this sprite.
(Inherited from SpriteBase.) | |
ClearOverlay |
Turn off the overlay map.
(Inherited from GeneralRules.) | |
ClearParameters |
Resets all parameter values defined on the specific sprite definition to 0.
(Inherited from SpriteBase.) | |
Clicked |
Determines if the specified mouse button is pressed.
(Inherited from GeneralRules.) | |
Deactivate |
Deactivate this sprite.
(Inherited from SpriteBase.) | |
DeactivateTargetSpriteFor |
Deactivate the sprite currently selected as the target for the specified name and clear the sprite selected for that target name.
(Inherited from GeneralRules.) | |
DeleteSave |
Empties the specified save slot.
(Inherited from GeneralRules.) | |
DragMap |
When the mouse drags over the display, scroll the map along with it.
(Inherited from GeneralRules.) | |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
ExcludeCounterFromSaveUnit |
Exclude the specified counter from the SaveUnit that will be saved with the next call to SaveGame(Int32, Boolean).
(Inherited from GeneralRules.) | |
ExcludeMapFromSaveUnit |
Remove the specified map in from the SaveUnit that will be saved with the next call to SaveGame(Int32, Boolean).
(Inherited from GeneralRules.) | |
GenerateWalls |
Calculate based on this sprite's solidity where light walls should appear within a specified radius.
| |
GetBounds |
Returns information about the visual boundaries of the sprite's currently displayed frame(s).
(Inherited from SpriteBase.) | |
GetCurrentFramesetFrames |
Get a list of frameset frames that the sprite is currently displaying
(Inherited from SpriteBase.) | |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetNearestSpriteIndex |
Compute the index of the nearest active sprite from the specified category and return it.
(Inherited from SpriteBase.) | |
GetPolarStateByVector |
Calculate the state that a rotating sprite should use in order to point in the direction it is currently traveling
(Inherited from SpriteBase.) | |
GetRandomNumber |
Return a random number within a specified range.
(Inherited from GeneralRules.) | |
GetRelativePosition |
Calculate the absolute position of a specified RelativePosition value with respect to this sprite.
(Inherited from SpriteBase.) | |
GetSelectedTargetFor |
Returns the sprite currently selected for the specified target name.
(Inherited from GeneralRules.) | |
GetTargetParameterFor |
Get the value of a numeric property or parameter on a sprite selected with SelectTargetSpriteFor(SpriteCollection, Int32, String).
(Inherited from GeneralRules.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
IncludeCounterInSaveUnit |
Include the specified counter in the SaveUnit that will be saved with the next call to SaveGame(Int32, Boolean).
(Inherited from GeneralRules.) | |
IncludeInSaveUnit |
Includes a specified set of objects in the SaveUnit that will be saved with the next call to SaveGame(Int32, Boolean).
(Inherited from GeneralRules.) | |
IncludeMapInSaveUnit |
Include the specified map in the SaveUnit that will be saved with the next call to SaveGame(Int32, Boolean).
(Inherited from GeneralRules.) | |
IsInputPressed |
Determine if the specified input is being pressed for this sprite.
(Inherited from SpriteBase.) | |
IsInState |
Determines if the sprite is in the specified range of states.
(Inherited from SpriteBase.) | |
IsKeyPressed |
Determines if a specified key is being pressed.
(Inherited from GeneralRules.) | |
IsMapFlagOn |
Determine if the specified map-specific flag on the current map is on.
(Inherited from GeneralRules.) | |
IsMouseButtonPressed |
Determines if the specified mouse button is pressed.
(Inherited from GeneralRules.) | |
IsMoving |
Determines if the sprite is moving in the specified direction at all.
(Inherited from SpriteBase.) | |
IsOnTile |
Determines if a tile at the sprite's current position is a member of the specified category.
(Inherited from SpriteBase.) | |
IsPointBlocked |
Determines if the specified point within a sprite is blocked from moving in a particular direction by the specified number of pixels.
(Inherited from SpriteBase.) | |
IsRidingPlatform |
Determine if the sprite is riding another sprite
(Inherited from SpriteBase.) | |
IsSpriteForTargetOfType |
Determine if the sprite selected for the specified target (selected with SelectTargetSpriteFor)
is of the specified type.
(Inherited from GeneralRules.) | |
IsTargetSpriteSelectedFor |
Determine if a sprite has been selected with SelectLastCreatedSpriteFor(String)
or SelectTargetSpriteFor(SpriteCollection, Int32, String).
(Inherited from GeneralRules.) | |
LandDownOnPlatform |
Tests to see if this sprite is landing on a platform (from above), and if so,
make the sprite ride the platform.
(Inherited from SpriteBase.) | |
LimitFrameRate |
Limit the frame rate of the game to the specified number of frames per second. Call this only once per frame.
(Inherited from GeneralRules.) | |
LimitVelocity |
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.
(Inherited from SpriteBase.) | |
LoadGame |
Restore the state of the objects contained in the specified save slot.
(Inherited from GeneralRules.) | |
LogDebugLabel |
Write a string to the debug output without moving to the next line.
(Inherited from GeneralRules.) | |
LogDebugValue |
Write a number to the debug output and move to the next line.
(Inherited from GeneralRules.) | |
MapKeyToInput |
Associates the state of the specified keyboard key with the specified input on this sprite.
(Inherited from SpriteBase.) | |
MapMouseToSprite |
Move the sprite to the position of the mouse cursor and set the sprite's button inputs based on mouse button states.
(Inherited from SpriteBase.) | |
MapPlayerToInputs |
Associate the state of the input device for the specified player with the inputs on this sprite.
(Inherited from SpriteBase.) | |
MoveByVelocity |
Move this sprite according to its current velocity
(Inherited from SpriteBase.) | |
PolarAccelerate |
Accelerate a rotating sprite in the direction that it is aiming.
(Inherited from SpriteBase.) | |
ProcessRules |
Execute the rules for this sprite if they have not already been executed this frame
(Inherited from SpriteBase.) | |
PushSprite |
Alter the velocity of TargetSprite to plan to move out of the way of this sprite
if TargetSprite is obstructing this sprite.
(Inherited from SpriteBase.) | |
PushSpriteIntoView |
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.
(Inherited from SpriteBase.) | |
PushTowardCategory |
Push this sprite toward a sprite in the specified category.
(Inherited from SpriteBase.) | |
PushTowardSprite |
Push this sprite toward a specified sprite.
(Inherited from SpriteBase.) | |
QuitGame |
Quit the game by closing the main window.
(Inherited from GeneralRules.) | |
ReactToInertia |
Reduces the sprite's velocity to simulate friction.
(Inherited from SpriteBase.) | |
ReactToPlatform |
Adjust this sprite's velocity according to the motion of the platform it is riding
(Inherited from SpriteBase.) | |
ReactToPush |
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.
(Inherited from SpriteBase.) | |
ReactToPushback |
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).
(Inherited from SpriteBase.) | |
ReactToSolid |
Alter the sprite's velocity to react to solid areas on the map.
(Inherited from SpriteBase.) | |
RemoveFromCategories |
Remove the sprite from its designated categories.
USE ONLY on dynamically added sprites.
(Inherited from SpriteBase.) | |
ResetLights |
Reset all light sources to initial default behavior.
(Inherited from GeneralRules.) | |
ReturnToPreviousMap |
Return to the map that was active before the last SwitchToMap(Type, Boolean).
(Inherited from GeneralRules.) | |
RotateLight |
Rotates the AimX and AimY of this light clockwise (+) or counterclockwise (-).
| |
RotateVelocity |
Redirect this sprite's velocity to be 100% in the direction that it is facing.
(Inherited from SpriteBase.) | |
SaveExists |
Determines if saved game data exists in the specified slot.
(Inherited from GeneralRules.) | |
SaveGame |
Save the current SaveUnit into the specified save slot.
(Inherited from GeneralRules.) | |
ScrollSpriteIntoView |
Scroll all layers on this sprite's layer's map so that the sprite is within visible area of the map.
(Inherited from SpriteBase.) | |
SelectLastCreatedSprite |
Select the most recently created sprite to be the target of SetTargetParameter(String, Int32).
(Inherited from GeneralRules.) | |
SelectLastCreatedSpriteFor |
Selects the most recently created sprite to be the target of SetTargetParameterFor(String, Int32, String)
or GetTargetParameterFor(String, String).
(Inherited from GeneralRules.) | |
SelectTargetSprite |
Selects a sprite within a collection, using a 0-based index, to be the target of SetTargetParameter(String, Int32).
(Inherited from GeneralRules.) | |
SelectTargetSpriteFor |
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.
(Inherited from GeneralRules.) | |
SetCategorySpriteState |
Sets the current state of a sprite based on a category and index into the category.
(Inherited from GeneralRules.) | |
SetInputState |
Turns on or off the specified input on this sprite.
(Inherited from SpriteBase.) | |
SetInputsTowardCategory |
Set the state of the directional inputs on this sprite to move toward the specified sprite in a category.
(Inherited from SpriteBase.) | |
SetInputsTowardSprite |
Set the state of the directional inputs on this sprite to move toward the specified sprite.
(Inherited from SpriteBase.) | |
SetMapFlag |
Turn on or off a flag associated with the current map.
(Inherited from GeneralRules.) | |
SetMessageBackground |
Sets the background for new messages added with ShowMessage(String).
(Inherited from GeneralRules.) | |
SetMessageDismissal |
Determines which player and which button will dismiss newly created messages.
(Inherited from GeneralRules.) | |
SetMessageFont |
Set the tileset used as the source for characters in messages.
(Inherited from GeneralRules.) | |
SetMessagePosition |
Determines where newly created messages appear.
(Inherited from GeneralRules.) | |
SetOverlay |
Set the overlay map.
(Inherited from GeneralRules.) | |
SetSolidity |
Set the solidity rules to which the sprite is currently reacting.
(Inherited from SpriteBase.) | |
SetTargetMapFlag |
Turn on or off a flag associated with the specified map.
(Inherited from GeneralRules.) | |
SetTargetParameter |
Set the value of a numeric property or parameter on a sprite selected with SelectTargetSprite(SpriteCollection, Int32) to the specified value.
(Inherited from GeneralRules.) | |
SetTargetParameterFor |
Set the value of a numeric property or parameter on a sprite selected with SelectTargetSpriteFor(SpriteCollection, Int32, String) to the specified value.
(Inherited from GeneralRules.) | |
SetViewLayout |
Sets the layout of multiple views for the current map.
(Inherited from GeneralRules.) | |
ShowMessage |
Adds a message to the display.
(Inherited from GeneralRules.) | |
SnapToGround |
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.
(Inherited from SpriteBase.) | |
StopRiding |
Stop riding the sprite that this sprite is currently riding, if any.
(Inherited from SpriteBase.) | |
SwitchToMap |
Sets a different map as the one to be drawn on the game display.
(Inherited from GeneralRules.) | |
SwitchToState |
Switch the sprite to the the specified state, ensuring that the sprite doesn't hit a solid.
(Inherited from SpriteBase.) | |
TestCollisionMask |
Determine whether the sprite's collision mask is overlapping part of any sprite in the specified category.
(Inherited from SpriteBase.) | |
TestCollisionRect(SpriteBase) |
Determine if this sprite is planning to overlap the target sprite.
(Inherited from SpriteBase.) | |
TestCollisionRect(SpriteCollection) |
Determine whether the solidity rectangle of the sprite overlaps that of any sprite in the specified category.
(Inherited from SpriteBase.) | |
TileActivateSprite |
Activate the next inactive sprite from a category at the coordinates of a tile being touched by the sprite.
(Inherited from SpriteBase.) | |
TileAddSprite |
Create a new (dynamic) instance of the specified sprite type at the coordinates
of a tile being touched by the player.
(Inherited from SpriteBase.) | |
TileCategoryTouched |
Determine if the sprite is touching a tile in the specified category (requires TouchTiles(TileCategoryName)).
(Inherited from SpriteBase.) | |
TileChange |
Change tiles of the specified type that the sprite is touching to another tile (requires TouchTiles(TileCategoryName)).
(Inherited from SpriteBase.) | |
TileChangeTouched |
Change the tile specified by TouchingIndex that is being touched by the sprite to another tile (requires TouchTiles(TileCategoryName)).
(Inherited from SpriteBase.) | |
TileTake |
Determine if the sprite is touching the specified tile, and if so,
"take" it and increment a counter (requires TouchTiles(TileCategoryName)).
(Inherited from SpriteBase.) | |
TileTouchingIndex |
Find the next unprocessed tile of the specified type (requires TouchTiles(TileCategoryName)).
(Inherited from SpriteBase.) | |
TileUseUp |
Make the specified tile behave like it is "using up" one of the items tracked by the specified counter (requires TouchTiles(TileCategoryName)).
(Inherited from SpriteBase.) | |
ToString | Returns a string that represents the current object. (Inherited from Object.) | |
TouchTiles |
Collects information about tiles the sprite is currently touching.
(Inherited from SpriteBase.) | |
UnloadBackgroundMaps |
Unload all maps that aren't currently visible.
(Inherited from GeneralRules.) | |
UnloadMap |
Unloads the specified map.
(Inherited from GeneralRules.) |
Name | Description | |
---|---|---|
aimX |
Horizontal offset relative to this sprite's location at which this light source points.
| |
aimY |
Vertical offset relative to this sprite's location at which this light source points.
| |
aimZ |
Depth offset relative to this sprite's location at which this light source points.
| |
apertureFocus |
Determines whether and how light is focused in a particular direction.
| |
apertureSoftness |
Determines how crisp the edges of the light cone are for lights directed by apertureFocus.
| |
color | (Inherited from SpriteBase.) | |
constantFalloff |
Constant falloff works in conjunction with linearFalloff and quadraticFalloff
to determine how this light source extends over distance.
| |
dx |
Horizontal velocity of the sprite in pixels per frame
(Inherited from SpriteBase.) | |
dy |
Vertical velocity of the sprite in pixels per frame
(Inherited from SpriteBase.) | |
frame |
Numeric value corresponding to the sprite's current frame.
(Inherited from SpriteBase.) | |
inputs |
Stores the inputs that are currently being "pressed" on this sprite.
(Inherited from SpriteBase.) | |
isActive |
Determines if this sprite is currently active.
(Inherited from SpriteBase.) | |
lightZ |
Depth position of this light source relative to the layer where the sprite resides.
| |
linearFalloff |
Linear falloff works in conjunction with constantFalloff and quadraticFalloff
to determine how this light source extends over distance.
| |
LocalDX |
Horizontal velocity relative to the sprite's environment (like a platform)
(Inherited from SpriteBase.) | |
LocalDY |
Vertical velocity relative to the sprite's environment
(Inherited from SpriteBase.) | |
oldinputs |
Remembers the inputs that were active on this sprite in the previous frame
(Inherited from SpriteBase.) | |
oldX |
The value of this sprite's x coordinate on the previous frame.
(Inherited from SpriteBase.) | |
oldY |
The value of this sprite's y coordinate on the previous frame.
(Inherited from SpriteBase.) | |
Processed |
Determines if this sprite's definition's rules have been processed yet this frame
(Inherited from SpriteBase.) | |
quadraticFalloff |
Quadratic falloff works in conjunction with constantFalloff and linearFalloff
to determine how this light source extends over distance.
| |
RidingOn |
Stores the platform sprite (the sprite that this sprite rides on).
If not set, then the sprite is not riding anything.
(Inherited from SpriteBase.) | |
state |
Numeric value corresponding to the sprite's current state.
(Inherited from SpriteBase.) | |
TouchedTiles |
A collection of tiles being processed by TouchTiles(TileCategoryName) and other rules
related to tile interactions.
(Inherited from SpriteBase.) | |
x |
Horizontal coordinate of the sprite within its layer.
(Inherited from SpriteBase.) | |
y |
Vertical coordinage of the sprite within its layer.
(Inherited from SpriteBase.) |
Name | Description | |
---|---|---|
CurrentState |
Retrieves information about the state that the sprite is currently in.
(Inherited from SpriteBase.) | |
CurrentView |
If multiple views are visible, this determines which view is currently active.
(Inherited from GeneralRules.) | |
Item |
Returns information about a specified state of this sprite
(Inherited from SpriteBase.) | |
ModulateAlpha |
Affects the sprite's visibility.
(Inherited from SpriteBase.) | |
ModulateBlue |
Affects the output of blue when this sprite is drawn.
(Inherited from SpriteBase.) | |
ModulateGreen |
Affects the output of green when this sprite is drawn.
(Inherited from SpriteBase.) | |
ModulateRed |
Affects the output of red when this sprite is drawn.
(Inherited from SpriteBase.) | |
OldPixelX |
The horizontal pixel coordinate that the sprite was at on the previous frame
(Inherited from SpriteBase.) | |
OldPixelY |
The vertical pixel coordinate that the sprite was at on the previous frame
(Inherited from SpriteBase.) | |
ParentLayer |
Retrieves information about the layer in which the sprite resides.
(Inherited from SpriteBase.) | |
PixelX |
Horizontal position of the sprite within the layer rounded toward zero to yield an integer.
(Inherited from SpriteBase.) | |
PixelY |
Vertical position of the sprite within the layer rounded toward zero to yield an integer.
(Inherited from SpriteBase.) | |
ProposedPixelX |
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.
(Inherited from SpriteBase.) | |
ProposedPixelY |
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.
(Inherited from SpriteBase.) | |
SolidHeight |
How many pixels high is the solid area of this sprite.
(Inherited from SpriteBase.) | |
SolidWidth |
How many pixels wide is the solid area of this sprite.
(Inherited from SpriteBase.) | |
WallCoordinateCount |
Returns how many coordinates were generated by the last call to GenerateWalls(Int32).
| |
WallCoordinates |
Provides access to the current set of light walls generated by GenerateWalls(Int32).
|