Interface IWalkComponent

Gives an entity the ability to walk around the room.

Inherited Members

IComponent.Name

IComponent.Entity

IComponent.RegistrationType

IComponent.Init(IEntity, Type)

IComponent.AfterInit()

System.IDisposable.Dispose()

System.ComponentModel.INotifyPropertyChanged.PropertyChanged

Namespace: AGS.API

Assembly: AGS.API.dll

Syntax

[RequiredComponent(typeof(ITranslateComponent), true)]
[RequiredComponent(typeof(IFaceDirectionComponent), true)]
[RequiredComponent(typeof(IOutfitComponent), true)]
[RequiredComponent(typeof(IHasRoomComponent), true)]
[RequiredComponent(typeof(IDrawableInfoComponent), true)]
[RequiredComponent(typeof(IAnimationComponent), false)]
public interface IWalkComponent : IComponent, IDisposable, INotifyPropertyChanged

Properties

AdjustWalkSpeedToScaleArea

Gets or sets a value indicating whether this IWalkComponent adjust the walk speed to the scaling area (i.e for a scaling area that shrinks the character to simulate a far away place, you'll want the character to walk slower).

Declaration

bool AdjustWalkSpeedToScaleArea { get; set; }

Property Value

Type	Description
System.Boolean	true if adjust walk speed to scale area; otherwise, false.

DebugDrawWalkPath

If set to true, lines will be drawn to mark the selected paths to walk by the path finder. This can be useful for debugging issues with the path finder algorithm.

Declaration

bool DebugDrawWalkPath { get; set; }

Property Value

Type	Description
System.Boolean	true if debug draw walk path; otherwise, false.

IsWalking

Gets a value indicating whether the character is walking.

Declaration

bool IsWalking { get; }

Property Value

Type	Description
System.Boolean	true if is walking; otherwise, false.

MovementLinkedToAnimation

Gets or sets a value indicating whether this IWalkComponent movement is linked to the animation. This is on by default, meaning that the walk step would only be performed when the walk animation frame changes. For the walk to look right, the images need to be drawn so that a foot touching the ground moves back a constant amount of pixels in between frames. This amount should then be entered as the WalkStep, and not touched any further. Any speed adjustment should only done by changing the animation speed (the animation's DelayBetweenFrames property and an optional additional delay for the actual running frame).

If this is turned off, then the walk step would be performed on each frame making for a smooth movement. Note that if the walk animation only has a single frame, then the engine will ignore the configuration and will treat it as false.

How to decide if this should be on or off?

As a rule of thumb, if the character has legs you would want this on. If you turn this off (for a character which has legs) while the movement will look smoother, it will also cause a gliding effect, caused by the fact that the movement is not in sync with the animation of the moving feet. If your character doesn't have legs (a robot, a floating ghost, etc), turning this off would make for a smoother looking walk.

Declaration

bool MovementLinkedToAnimation { get; set; }

Property Value

Type	Description
System.Boolean	true if movement linked to animation; otherwise, false.

WalkDestination

Gets the destination the character is currently walking to (if currently walking), or the last destination the character was walking to (if currently not walking).

Declaration

Position WalkDestination { get; }

Property Value

Type	Description
Position	The walk destination.

WalkStep

Gets or sets the walk step. The walk speed is actually the number of pixels the character moves each time he/she/it moves. If MovementLinkedToAnimation is turned off, the step would be made on each frame, making for a smooth movement. This means that for this state, the walk step is the sole 'decision maker' for the walking speed of the character. If MovementLinkedToAnimation is turned on (the default), the step would be made each time the animation frame changes. This means that for this state, the walk step should be setup once (it needs to match exactly the amount of pixels the leg moves in the drawings) when the actual controller of the walk speed is the animation's speed (the animation's DelayBetweenFrames property and an optional additional delay for the actual running frame).

Declaration

PointF WalkStep { get; set; }

Property Value

Type	Description
PointF	The walk speed.

Methods

PlaceOnWalkableArea()

If the character is already standing in a walkable area, does nothing. Otherwise it would try to place it on a walkable area close by.

Declaration

void PlaceOnWalkableArea()

StopWalkingAsync()

Asynchronosly stops the current walk (if there is a walk to stop).

Declaration

Task StopWalkingAsync()

Returns

Type	Description
System.Threading.Tasks.Task	The walking async.

WalkAsync(Position, Boolean)

Walks asynchronously to the specified location. Let's start walking to the chair, say something about it while we're walking, and then properly respond if the user decided they want to walk somewhere else before we got to the chair.

Task<bool> walkSuccessful = cHero.WalkAsync(oChair.Location);
await cHero.SayAsync("I'm walking to the chair!");
if (await walkSuccessful)
{
    await cHero.SayAsync("And now I'm sitting!");
    sitOnChair();
}
else
{
    await cHero.SayAsync("You know what, that the chair doesn't look too comfortable, I think I'll pass.");
}

Declaration

Task<bool> WalkAsync(Position position, bool walkAnywhere = false)

Parameters

Type	Name	Description
Position	position	The position.
System.Boolean	walkAnywhere	If set to true, the character will simply walk directly to the destination, ignoring walkable areas and treat the entire room as walkable.

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>	Returns true if the walk was completed successfully, or false if the walk was cancelled (if the user clicked on something else) or the character failed to reach the destination.

WalkStraightAsync(Position)

Walk asynchronously to the specified position in a straight line as far as is possible before hitting a non-walkable area. This is useful for use with the arrow keys for character movement, since it guarantees that the character will move in a straight line in the direction specified.

Declaration

Task<bool> WalkStraightAsync(Position position)

Parameters

Type	Name	Description
Position	position	Position.

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>	Returns true if the walk was completed successfully, or false if the walk was cancelled (if the user clicked on something else) or the character failed to reach the destination.