Module

Screeps.Path

Package: purescript-screeps-classy
Repository: purescript/purescript-screeps

This module implements PathFinder API.

WARNING: While PathFinder accepts any number of target objects, excessive GC may occur if there are too many. API author advises to sort targets by uniform distance [Screeps.Coord], and use only first 10 or so.

#TileCost Source

type TileCost = Int

#defaultTerrainCost Source

defaultTerrainCost :: TileCost

#unwalkable Source

unwalkable :: TileCost

Indicates an unwalkable tile.

#PATH Source

data PATH :: Effect

#PathFinderResult Source

newtype PathFinderResult

Constructors

PathFinderResult { cost :: Int, incomplete :: Boolean, opts :: Int, path :: Array RoomPosition }

#PathFinderTarget Source

newtype PathFinderTarget

Constructors

PathFinderTarget { pos :: RoomPosition, range :: Int }

#target Source

target :: RoomPosition -> PathFinderTarget

#inRange Source

inRange :: Int -> RoomPosition -> PathFinderTarget

#usePathFinder Source

usePathFinder :: forall e. Eff (path :: PATH | e) Unit

#CostMatrix Source

data CostMatrix :: Type

Instances

#search Source

search :: forall e. RoomPosition -> Array PathFinderTarget -> (PathFinderOpts e) -> Eff (path :: PATH | e) PathFinderResult

#newCostMatrix Source

newCostMatrix :: forall e. Eff (path :: PATH | e) CostMatrix

#infinity Source

infinity :: Number

#defaultPathFinderOpts Source

defaultPathFinderOpts :: forall a. PathFinderOpts a

#RoomCallback Source

type RoomCallback e = RoomName -> Eff (path :: PATH | e) CostMatrix

#allDefaultCosts Source

allDefaultCosts :: forall e. RoomCallback e

Empty callback - just use default terrain cost.

#PathFinderOpts Source

newtype PathFinderOpts e

Constructors

PathFinderOpts { flee :: Boolean, heuristicWeight :: Number, maxCost :: Number, maxOps :: Int, maxRooms :: Int, plainCost :: TileCost, roomCallback :: RoomCallback e, swampCost :: TileCost }

#set Source

set :: forall e. CostMatrix -> Int -> Int -> TileCost -> Eff (path :: PATH | e) Unit

Set a given coordinate to any cost.

#get Source

get :: forall e. CostMatrix -> Int -> Int -> Eff (path :: PATH | e) TileCost

Get current cost of any coordinate. Zero indicates default terrain cost.

#clone Source

clone :: forall e. CostMatrix -> Eff (path :: PATH | e) CostMatrix

Clone cost matrix.

#SerializedCostMatrix Source

newtype SerializedCostMatrix

Serialized cost matrix, suitable for JSON.stringify.

Constructors

SerializedCostMatrix Json

Instances

Show SerializedCostMatrix

#serialize Source

serialize :: CostMatrix -> SerializedCostMatrix

Serialize cost matrix for storage in Memory.

#deserialize Source

deserialize :: forall e. SerializedCostMatrix -> Eff (err :: EXCEPTION | e) CostMatrix

Modules: Screeps; Screeps.BodyPartType; Screeps.Color; Screeps.Constants; Screeps.ConstructionSite; Screeps.Container; Screeps.Controller; Screeps.Coolsdown; Screeps.Coord; Screeps.Creep; Screeps.Decays; Screeps.Deposit; Screeps.Destructible; Screeps.Direction; Screeps.Effects; Screeps.Extension; Screeps.Extractor; Screeps.FFI; Screeps.FindType; Screeps.Flag; Screeps.Game; Screeps.Id; Screeps.IntMap; Screeps.KeeperLair; Screeps.Lab; Screeps.Link; Screeps.Map; Screeps.Market; Screeps.Memory; Screeps.Mineral; Screeps.Names; Screeps.Nuke; Screeps.Nuker; Screeps.Observer; Screeps.Owned; Screeps.Path; Screeps.Path.Cache; Screeps.Portal; Screeps.PowerBank; Screeps.PowerSpawn; Screeps.Progress; Screeps.Rampart; Screeps.Refillable; Screeps.Regenerates; Screeps.Resource; Screeps.ReturnCode; Screeps.Road; Screeps.Room; Screeps.RoomObject; Screeps.RoomPosition; Screeps.RoomPosition.Type; Screeps.Source; Screeps.Spawn; Screeps.Storage; Screeps.Stores; Screeps.Structure; Screeps.Terminal; Screeps.Tower; Screeps.Types; Screeps.Wall