PlanBase.PushSpriteTowardCoordinate Method

PlanBasePushSpriteTowardCoordinate Method

Alter the velocity of the specified sprite to go toward a coordinate associated with the current plan.

Namespace: (Default Namespace)
Assembly: Default (in Default.exe) Version: 1.0.0.0

Syntax

public virtual void PushSpriteTowardCoordinate(
	SpriteBase Sprite,
	int CoordinateIndex,
	int Force
)

Sprite: Type: (Default Namespace)SpriteBase
Sprite whose velocity will be affected
CoordinateIndex: Type: SystemInt32
Indicates the 0-based index of the coordinate in the current plan toward which the sprite will be pushed
Force: Type: SystemInt32
How hard to push the sprite in tenths of a pixel per frame per frame

Remarks

Use this in combination with CheckNextCoordinate(SpriteBase, Int32, Int32) to make a sprite follow a series of coordinates in a path. This function is identical to PushSpriteTowardPoint(SpriteBase, Point, Int32) except that it is designed only to operate on coordinates within the current plan (designated by coordinate index).

Examples

See StopSprite(SpriteBase) for an example.