MovementPlan
in package
FinalYes
Immutable summary of one timeless movement plan.
Table of Contents
Properties
- $remaining : int|float
- $steps : array<string|int, mixed>
Methods
- __construct() : mixed
- Create one timeless movement plan result.
- deltas() : array<int, QuantityStateDelta>
- Aggregate per-slot quantity-state deltas for this plan.
- isComplete() : bool
- Return true when the requested quantity is fully planned.
- step() : PlannedStep|null
- Find one planned step by id.
Properties
$remaining read-only
public
int|float
$remaining
$steps read-only
public
array<string|int, mixed>
$steps
Methods
__construct()
Create one timeless movement plan result.
public
__construct(array<int, PlannedStep> $steps, int|float $remaining) : mixed
Parameters
- $steps : array<int, PlannedStep>
- $remaining : int|float
deltas()
Aggregate per-slot quantity-state deltas for this plan.
public
deltas() : array<int, QuantityStateDelta>
Return values
array<int, QuantityStateDelta>isComplete()
Return true when the requested quantity is fully planned.
public
isComplete() : bool
Return values
boolstep()
Find one planned step by id.
public
step(string $id) : PlannedStep|null
Parameters
- $id : string