The Battle for Wesnoth  1.15.1+dev
Public Member Functions | List of all members
pathfind::jamming_path Struct Reference

A refinement of paths for use when calculating jamming. More...

#include <pathfind.hpp>

Inheritance diagram for pathfind::jamming_path:
Inheritance graph

Public Member Functions

 jamming_path (const unit &jammer, const map_location &loc)
 Construct a list of jammed hexes for a unit. More...
 
virtual ~jamming_path ()
 Default destructor. More...
 
- Public Member Functions inherited from pathfind::paths
 paths ()
 
 paths (const unit &u, bool force_ignore_zocs, bool allow_teleport, const team &viewing_team, int additional_turns=0, bool see_all=false, bool ignore_units=false)
 Construct a list of paths for the specified unit. More...
 
virtual ~paths ()
 Virtual destructor (default processing). More...
 

Additional Inherited Members

- Public Attributes inherited from pathfind::paths
dest_vect destinations
 

Detailed Description

A refinement of paths for use when calculating jamming.

Definition at line 122 of file pathfind.hpp.

Constructor & Destructor Documentation

◆ jamming_path()

pathfind::jamming_path::jamming_path ( const unit jammer,
const map_location loc 
)

Construct a list of jammed hexes for a unit.

Constructs a list of jamming paths for a unit.

This is used to construct a list of hexes that the indicated unit can jam. It differs from pathfinding in that it will only ever go out one turn.

Parameters
jammerThe unit doing the jamming.
locThe location from which the jamming occurs (does not have to be the unit's location).

Definition at line 634 of file pathfind.cpp.

References pathfind::paths::destinations, pathfind::find_routes(), movetype::get_jamming(), unit::get_state(), unit::jamming(), unit::movement_type(), and unit::STATE_SLOWED.

◆ ~jamming_path()

pathfind::jamming_path::~jamming_path ( )
virtual

Default destructor.

Definition at line 647 of file pathfind.cpp.


The documentation for this struct was generated from the following files: