Struct bevy_landmass::Archipelago

pub struct Archipelago<CS: CoordinateSystem> { /* private fields */ }

An archipelago, holding the internal state of landmass.

Implementations

impl<CS: CoordinateSystem> Archipelago<CS>

pub fn new() -> Self

Creates an empty archipelago.

pub fn get_agent_options(&self) -> &AgentOptions

Gets the agent options.

pub fn get_agent_options_mut(&mut self) -> &mut AgentOptions

Gets a mutable borrow to the agent options.

pub fn add_node_type(&mut self, cost: f32) -> Result<NodeType, NewNodeTypeError>

Creates a new node type with the specified cost. The cost is a multiplier on the distance travelled along this node (essentially the cost per meter). Agents will prefer to travel along low-cost terrain. The returned node type is distinct from all other node types (for this archipelago).

pub fn set_node_type_cost( &mut self, node_type: NodeType, cost: f32, ) -> Result<(), SetNodeTypeCostError>

Sets the cost of node_type to cost. See Archipelago::add_node_type for the meaning of cost.

pub fn get_node_type_cost(&self, node_type: NodeType) -> Option<f32>

Gets the cost of node_type. Returns None if node_type is not in this archipelago.

pub fn remove_node_type(&mut self, node_type: NodeType) -> bool

Removes the node type from the archipelago. Returns false if this archipelago does not contain node_type or any islands still use this node type (so the node type cannot be removed). Otherwise, returns true.

pub fn sample_point( &self, point: CS::Coordinate, distance_to_node: f32, ) -> Result<SampledPoint<'_, CS>, SamplePointError>

Finds the nearest point on the navigation meshes to (and within distance_to_node of) point.

pub fn find_path( &self, start_point: &SampledPoint<'_, CS>, end_point: &SampledPoint<'_, CS>, override_node_type_costs: &HashMap<NodeType, f32>, ) -> Result<Vec<CS::Coordinate>, FindPathError>

Finds a path from start_point and end_point along the navigation meshes. Only SampledPoints from this archipelago are supported. This should only be used for querying (e.g., finding the walking distance to an object), not for controlling movement. For controlling movement, use agents.

Trait Implementations

impl<CS: CoordinateSystem> Component for Archipelago<CS>

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy::ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

fn register_component_hooks(_hooks: &mut ComponentHooks)

Called when registering this component, allowing mutable access to its ComponentHooks.

impl<CS: CoordinateSystem> Default for Archipelago<CS>

fn default() -> Self

Returns the “default value” for a type.