Table of Contents

Class Waypoint

Namespace
FrameOfReference.World.Positionables
Assembly
FrameOfReference.World.dll

A marker used to control automated Entity movement.

public class Waypoint : Positionable<Vector2>, ICloneable, IChangeNotify<Positionable<Vector2>>
Inheritance
object
Positionable<Vector2>
Waypoint
Implements
Inherited Members

Properties

ActivationTime

The GameTime when Entitys start walking towards this waypoint.

public double ActivationTime { get; set; }

Property Value

double

ArrivalTime

The GameTime when Entitys reach this waypoint. Set automatically by HandleWaypoints(Entity, double).

public double ArrivalTime { get; set; }

Property Value

double

ArrivalTimeSpecified

Indicates whether ArrivalTime has been set.

[Browsable(false)]
public bool ArrivalTimeSpecified { get; set; }

Property Value

bool

OriginPosition

The position where an Entity walking towards this waypoint started off. Set automatically by HandleWaypoints(Entity, double).

public Vector2 OriginPosition { get; set; }

Property Value

Vector2

OriginPositionSpecified

Indicates whether OriginPosition has been set.

[Browsable(false)]
public bool OriginPositionSpecified { get; set; }

Property Value

bool

TargetEntity

The name of the Entity this waypoint is for.

public string? TargetEntity { get; set; }

Property Value

string

Methods

Clone()

Creates a deep copy of this instance.

public override Positionable<Vector2> Clone()

Returns

Positionable<Vector2>

CloneFromTo(Waypoint, Waypoint)

Copies all members declared by Waypoint from one instance to another.

protected static void CloneFromTo(Waypoint from, Waypoint to)

Parameters

from Waypoint
to Waypoint

CloneWaypoint()

Creates a deep copy of this Waypoint instance.

public Waypoint CloneWaypoint()

Returns

Waypoint

The new copy of the Waypoint.

OnChanged()

To be called when a property relevant for rendering has changed.

protected override void OnChanged()