aboutsummaryrefslogtreecommitdiff
path: root/V3/Objects/Movement/IMovable.cs
blob: 659708b628c7c6e6aeb84682f3bb67a296cb1195 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
using Microsoft.Xna.Framework;
using V3.Data;
using V3.Map;

namespace V3.Objects.Movement
{
    public interface IMovable
    {
        /// <summary>
        /// Calculates a path without collisions to desired destination.
        /// </summary>
        /// <param name="pathfinder">Pathfinder to use.</param>
        /// <param name="position">Current position in pixel.</param>
        /// <param name="destination">Destination in pixel.</param>
        void FindPath(Pathfinder pathfinder, Vector2 position, Vector2 destination);

        /// <summary>
        /// Uses pathfinder to for steady movement to new transition.
        /// </summary>
        /// <param name="currentPosition">Current position in pixel.</param>
        /// <param name="speed">Movement speed of the creature.</param>
        /// <returns>Normalized vector * speed which represents a small step in the direction of desired destination.(</returns>
        Vector2 GiveNewPosition(Vector2 currentPosition, int speed);

        /// <summary>
        /// Calculates the direction the creature is looking when moving.
        /// </summary>
        MovementDirection GiveMovementDirection();
        bool IsMoving { get; }

        /// <summary>
        /// Save the movement data to a MovementData object.
        /// </summary>
        /// <returns>the MovementData object with the current status</returns>
        MovementData SaveData();

        /// <summary>
        /// Restore the movement state from the given data.
        /// </summary>
        /// <param name="movementData">the state of the movement to restore</param>
        void LoadData(MovementData movementData);
    }
}