bevy_flowfield_tiles_plugin 0.15.0

An implementation of FlowField (vector field) pathfinding as a plugin to the Bevy game engine
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

//! When an actor requests a path and the floe fields are net yet ready they
//! are given temporary simpler path based on portal-to-portal pathing
//!
//! The [RouteStep] describes the portal location within a particular sector
//!

use crate::flowfields::{portal::PortalWindow, sectors::SectorID};

/// Describes and keys into a pathable segment of FlowFields
#[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
pub struct RouteStep {
	/// The sector the step refers to
	sector: SectorID,
	/// Goal [crate::flowfields::fields::FieldCell] as an index
	goal: usize,
	/// If Some then the actual goal is a [PortalWindow]. If None then the sector is the end goal sector
	portal: Option<PortalWindow>,
}

impl RouteStep {
	/// Init [RouteStep]
	pub fn new(sector: &SectorID, goal: usize, portal: Option<PortalWindow>) -> Self {
		RouteStep {
			sector: *sector,
			goal,
			portal,
		}
	}
	/// Get a reference to the sector
	pub fn get_sector(&self) -> &SectorID {
		&self.sector
	}
	/// Get the goal of the step
	pub fn get_goal(&self) -> usize {
		self.goal
	}
	/// Get the portal of the step
	pub fn portal(&self) -> &Option<PortalWindow> {
		&self.portal
	}
}