Logo FSBarV1_Archived

BasePlan Module

Declarative building layout: resolves named slot lists into placement decisions that honour terrain, clearance, builder reach, and wall-in constraints.

Functions and values

Function or value Description

defaultArmadaOpening

Full Usage: defaultArmadaOpening

Returns: BasePlan

Built-in plan matching feature 023's iter 026 opening sequence: 2 armmex (nearest metal spots) + 2 armsolar (NearBaseCentre ±200, 0) + 1 armlab (NearBaseCentre 0, 350).

Returns: BasePlan

emptyPlanProgress

Full Usage: emptyPlanProgress

Returns: PlanProgress

Empty progress — use at match start.

Returns: PlanProgress

markConsumed progress slotName

Full Usage: markConsumed progress slotName

Parameters:
Returns: PlanProgress

Mark a slot as consumed (structure built or under construction).

progress : PlanProgress
slotName : string
Returns: PlanProgress

markInFlight progress slotName

Full Usage: markInFlight progress slotName

Parameters:
Returns: PlanProgress

Mark a slot as in-flight (BuildCommand issued, awaiting UnitFinished).

progress : PlanProgress
slotName : string
Returns: PlanProgress

markUnfulfillable progress slotName reason

Full Usage: markUnfulfillable progress slotName reason

Parameters:
Returns: PlanProgress

Mark a slot as permanently unfulfillable with the given reason.

progress : PlanProgress
slotName : string
reason : SlotFailure
Returns: PlanProgress

resolvePlan plan context

Full Usage: resolvePlan plan context

Parameters:
Returns: ResolvedSlot list

Resolve every slot in plan against context. Returns one ResolvedSlot per PlanSlot in input order. Pure; does not mutate inputs.

plan : BasePlan
context : ResolveContext
Returns: ResolvedSlot list

Type something to start searching.