MovementPlanner
in package
FinalYes
Builds timeless movement plans via a pluggable solver.
Tags
Table of Contents
Properties
Methods
- __construct() : mixed
- Create one movement planner around the provided plan solver.
- plan() : MovementPlan
- Build one timeless plan to the requested target.
Properties
$solver read-only
private
PlanSolverInterface
$solver
= new GreedyPlanSolver()
Methods
__construct()
Create one movement planner around the provided plan solver.
public
__construct([PlanSolverInterface $solver = new GreedyPlanSolver() ]) : mixed
Parameters
- $solver : PlanSolverInterface = new GreedyPlanSolver()
plan()
Build one timeless plan to the requested target.
public
plan(QuantityState $inventory, SlotSpace $space, Flow|non-empty-string $flow, int|float $quantity, Slot|non-empty-string $target[, array<string, scalar|null> $params = [] ]) : MovementPlan
Parameters
- $inventory : QuantityState
- $space : SlotSpace
- $flow : Flow|non-empty-string
- $quantity : int|float
- $target : Slot|non-empty-string
- $params : array<string, scalar|null> = []