Swarm.Game.Step.Path.Type

Types for shortest-path-finding and logging path-cache invalidation events.

By convention, a [Location] does not include the starting location, whereas a NonEmpty Location does.

Consequentially, an empty [Location] implies that the robot's current location is already at the goal location.

A gratuitous number of sum types are defined here to facilitate explainability of caching behavior via logs.

Documentation

maxLogEntries :: Int

data PathfindingParameters a

This is parameterized on the starting location, as we may either want to:

1. provide the planar start location (when first computing the path), or
2. suppress it and only propagate the subworld name (when retrieving from cache), which precludes the downstream possibility of accidentally mixing up the planar location of the target with the current robot location.

Constructors

PathfindingParameters

Fields

• distanceLimit :: Maybe Integer

  Manhattan distance limit on cells to explore (NOTE: this is not a "path length" limit)

• startingLoc :: a

  Starting location

• searchGoal :: PathfindingTarget

  Search goal

Instances

Functor PathfindingParameters

Defined in Swarm.Game.Step.Path.Type

Methods

fmap :: (a -> b) -> PathfindingParameters a -> PathfindingParameters b

(<$) :: a -> PathfindingParameters b -> PathfindingParameters a

ToJSON a => ToJSON (PathfindingParameters a)

Defined in Swarm.Game.Step.Path.Type

Methods

toJSON :: PathfindingParameters a -> Value

toEncoding :: PathfindingParameters a -> Encoding

toJSONList :: [PathfindingParameters a] -> Value

toEncodingList :: [PathfindingParameters a] -> Encoding

omitField :: PathfindingParameters a -> Bool

Generic (PathfindingParameters a)

Defined in Swarm.Game.Step.Path.Type

Associated Types

type Rep (PathfindingParameters a) :: Type -> Type

Methods

from :: PathfindingParameters a -> Rep (PathfindingParameters a) x

to :: Rep (PathfindingParameters a) x -> PathfindingParameters a

Show a => Show (PathfindingParameters a)

Defined in Swarm.Game.Step.Path.Type

Methods

showsPrec :: Int -> PathfindingParameters a -> ShowS

show :: PathfindingParameters a -> String

showList :: [PathfindingParameters a] -> ShowS

Eq a => Eq (PathfindingParameters a)

Defined in Swarm.Game.Step.Path.Type

Methods

(==) :: PathfindingParameters a -> PathfindingParameters a -> Bool

(/=) :: PathfindingParameters a -> PathfindingParameters a -> Bool

type Rep (PathfindingParameters a)

Defined in Swarm.Game.Step.Path.Type

type Rep (PathfindingParameters a) = D1 ('MetaData "PathfindingParameters" "Swarm.Game.Step.Path.Type" "swarm-0.6.0.0-ERx1HMcRMba59aI2b6aNrS-swarm-engine" 'False) (C1 ('MetaCons "PathfindingParameters" 'PrefixI 'True) (S1 ('MetaSel ('Just "distanceLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: (S1 ('MetaSel ('Just "startingLoc") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 a) :*: S1 ('MetaSel ('Just "searchGoal") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PathfindingTarget))))

data CachePreservationMode

It is possible for the cache to be unaffected by certain events, or the cache may modified without fully recomputing the shortest path.

Constructors

Unmodified

PathTruncated

Instances

ToJSON CachePreservationMode

Defined in Swarm.Game.Step.Path.Type

Methods

toJSON :: CachePreservationMode -> Value

toEncoding :: CachePreservationMode -> Encoding

toJSONList :: [CachePreservationMode] -> Value

toEncodingList :: [CachePreservationMode] -> Encoding

omitField :: CachePreservationMode -> Bool

Generic CachePreservationMode

Defined in Swarm.Game.Step.Path.Type

Associated Types

type Rep CachePreservationMode :: Type -> Type

Methods

from :: CachePreservationMode -> Rep CachePreservationMode x

to :: Rep CachePreservationMode x -> CachePreservationMode

Show CachePreservationMode

Defined in Swarm.Game.Step.Path.Type

Methods

showsPrec :: Int -> CachePreservationMode -> ShowS

show :: CachePreservationMode -> String

showList :: [CachePreservationMode] -> ShowS

Eq CachePreservationMode

Defined in Swarm.Game.Step.Path.Type

Methods

(==) :: CachePreservationMode -> CachePreservationMode -> Bool

(/=) :: CachePreservationMode -> CachePreservationMode -> Bool

type Rep CachePreservationMode

Defined in Swarm.Game.Step.Path.Type

type Rep CachePreservationMode = D1 ('MetaData "CachePreservationMode" "Swarm.Game.Step.Path.Type" "swarm-0.6.0.0-ERx1HMcRMba59aI2b6aNrS-swarm-engine" 'False) (C1 ('MetaCons "Unmodified" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PathTruncated" 'PrefixI 'False) (U1 :: Type -> Type))

data CacheLogEntry

Constructors

CacheLogEntry

Fields

• robot :: RID
• event :: CacheEvent

Instances

ToJSON CacheLogEntry

Defined in Swarm.Game.Step.Path.Type

Methods

toJSON :: CacheLogEntry -> Value

toEncoding :: CacheLogEntry -> Encoding

toJSONList :: [CacheLogEntry] -> Value

toEncodingList :: [CacheLogEntry] -> Encoding

omitField :: CacheLogEntry -> Bool

Generic CacheLogEntry

Defined in Swarm.Game.Step.Path.Type

Associated Types

type Rep CacheLogEntry :: Type -> Type

Methods

from :: CacheLogEntry -> Rep CacheLogEntry x

to :: Rep CacheLogEntry x -> CacheLogEntry

Show CacheLogEntry

Defined in Swarm.Game.Step.Path.Type

Methods

showsPrec :: Int -> CacheLogEntry -> ShowS

show :: CacheLogEntry -> String

showList :: [CacheLogEntry] -> ShowS

Eq CacheLogEntry

Defined in Swarm.Game.Step.Path.Type

Methods

(==) :: CacheLogEntry -> CacheLogEntry -> Bool

(/=) :: CacheLogEntry -> CacheLogEntry -> Bool

type Rep CacheLogEntry

Defined in Swarm.Game.Step.Path.Type

type Rep CacheLogEntry = D1 ('MetaData "CacheLogEntry" "Swarm.Game.Step.Path.Type" "swarm-0.6.0.0-ERx1HMcRMba59aI2b6aNrS-swarm-engine" 'False) (C1 ('MetaCons "CacheLogEntry" 'PrefixI 'True) (S1 ('MetaSel ('Just "robot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RID) :*: S1 ('MetaSel ('Just "event") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CacheEvent)))

data CacheRetrievalAttempt

Constructors

Success

RecomputationRequired CacheRetreivalInapplicability

Instances

ToJSON CacheRetrievalAttempt

Defined in Swarm.Game.Step.Path.Type

Methods

toJSON :: CacheRetrievalAttempt -> Value

toEncoding :: CacheRetrievalAttempt -> Encoding

toJSONList :: [CacheRetrievalAttempt] -> Value

toEncodingList :: [CacheRetrievalAttempt] -> Encoding

omitField :: CacheRetrievalAttempt -> Bool

Generic CacheRetrievalAttempt

Defined in Swarm.Game.Step.Path.Type

Associated Types

type Rep CacheRetrievalAttempt :: Type -> Type

Methods

from :: CacheRetrievalAttempt -> Rep CacheRetrievalAttempt x

to :: Rep CacheRetrievalAttempt x -> CacheRetrievalAttempt

Show CacheRetrievalAttempt

Defined in Swarm.Game.Step.Path.Type

Methods

showsPrec :: Int -> CacheRetrievalAttempt -> ShowS

show :: CacheRetrievalAttempt -> String

showList :: [CacheRetrievalAttempt] -> ShowS

Eq CacheRetrievalAttempt

Defined in Swarm.Game.Step.Path.Type

Methods

(==) :: CacheRetrievalAttempt -> CacheRetrievalAttempt -> Bool

(/=) :: CacheRetrievalAttempt -> CacheRetrievalAttempt -> Bool

type Rep CacheRetrievalAttempt

Defined in Swarm.Game.Step.Path.Type

type Rep CacheRetrievalAttempt = D1 ('MetaData "CacheRetrievalAttempt" "Swarm.Game.Step.Path.Type" "swarm-0.6.0.0-ERx1HMcRMba59aI2b6aNrS-swarm-engine" 'False) (C1 ('MetaCons "Success" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "RecomputationRequired" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CacheRetreivalInapplicability)))

data CacheEvent

Certain events can obligate the cache to be completely invalidated, or partially or fully preserved.

Constructors

Invalidate InvalidationReason

Preserve CachePreservationMode

RetrievalAttempt CacheRetrievalAttempt

Instances

ToJSON CacheEvent

Defined in Swarm.Game.Step.Path.Type

Methods

toJSON :: CacheEvent -> Value

toEncoding :: CacheEvent -> Encoding

toJSONList :: [CacheEvent] -> Value

toEncodingList :: [CacheEvent] -> Encoding

omitField :: CacheEvent -> Bool

Generic CacheEvent

Defined in Swarm.Game.Step.Path.Type

Associated Types

type Rep CacheEvent :: Type -> Type

Methods

from :: CacheEvent -> Rep CacheEvent x

to :: Rep CacheEvent x -> CacheEvent

Show CacheEvent

Defined in Swarm.Game.Step.Path.Type

Methods

showsPrec :: Int -> CacheEvent -> ShowS

show :: CacheEvent -> String

showList :: [CacheEvent] -> ShowS

Eq CacheEvent

Defined in Swarm.Game.Step.Path.Type

Methods

(==) :: CacheEvent -> CacheEvent -> Bool

(/=) :: CacheEvent -> CacheEvent -> Bool

type Rep CacheEvent

Defined in Swarm.Game.Step.Path.Type

type Rep CacheEvent = D1 ('MetaData "CacheEvent" "Swarm.Game.Step.Path.Type" "swarm-0.6.0.0-ERx1HMcRMba59aI2b6aNrS-swarm-engine" 'False) (C1 ('MetaCons "Invalidate" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 InvalidationReason)) :+: (C1 ('MetaCons "Preserve" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CachePreservationMode)) :+: C1 ('MetaCons "RetrievalAttempt" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CacheRetrievalAttempt))))

data DistanceLimitChange

Constructors

LimitIncreased

PathExceededLimit

Instances

ToJSON DistanceLimitChange

Defined in Swarm.Game.Step.Path.Type

Methods

toJSON :: DistanceLimitChange -> Value

toEncoding :: DistanceLimitChange -> Encoding

toJSONList :: [DistanceLimitChange] -> Value

toEncodingList :: [DistanceLimitChange] -> Encoding

omitField :: DistanceLimitChange -> Bool

Generic DistanceLimitChange

Defined in Swarm.Game.Step.Path.Type

Associated Types

type Rep DistanceLimitChange :: Type -> Type

Methods

from :: DistanceLimitChange -> Rep DistanceLimitChange x

to :: Rep DistanceLimitChange x -> DistanceLimitChange

Show DistanceLimitChange

Defined in Swarm.Game.Step.Path.Type

Methods

showsPrec :: Int -> DistanceLimitChange -> ShowS

show :: DistanceLimitChange -> String

showList :: [DistanceLimitChange] -> ShowS

Eq DistanceLimitChange

Defined in Swarm.Game.Step.Path.Type

Methods

(==) :: DistanceLimitChange -> DistanceLimitChange -> Bool

(/=) :: DistanceLimitChange -> DistanceLimitChange -> Bool

type Rep DistanceLimitChange

Defined in Swarm.Game.Step.Path.Type

type Rep DistanceLimitChange = D1 ('MetaData "DistanceLimitChange" "Swarm.Game.Step.Path.Type" "swarm-0.6.0.0-ERx1HMcRMba59aI2b6aNrS-swarm-engine" 'False) (C1 ('MetaCons "LimitIncreased" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PathExceededLimit" 'PrefixI 'False) (U1 :: Type -> Type))

data DifferentArgument

Constructors

NewSubworld

NewTargetType

NewWalkabilityContext

NewDistanceLimit DistanceLimitChange

Instances

ToJSON DifferentArgument

Defined in Swarm.Game.Step.Path.Type

Methods

toJSON :: DifferentArgument -> Value

toEncoding :: DifferentArgument -> Encoding

toJSONList :: [DifferentArgument] -> Value

toEncodingList :: [DifferentArgument] -> Encoding

omitField :: DifferentArgument -> Bool

Generic DifferentArgument

Defined in Swarm.Game.Step.Path.Type

Associated Types

type Rep DifferentArgument :: Type -> Type

Methods

from :: DifferentArgument -> Rep DifferentArgument x

to :: Rep DifferentArgument x -> DifferentArgument

Show DifferentArgument

Defined in Swarm.Game.Step.Path.Type

Methods

showsPrec :: Int -> DifferentArgument -> ShowS

show :: DifferentArgument -> String

showList :: [DifferentArgument] -> ShowS

Eq DifferentArgument

Defined in Swarm.Game.Step.Path.Type

Methods

(==) :: DifferentArgument -> DifferentArgument -> Bool

(/=) :: DifferentArgument -> DifferentArgument -> Bool

type Rep DifferentArgument

Defined in Swarm.Game.Step.Path.Type

type Rep DifferentArgument = D1 ('MetaData "DifferentArgument" "Swarm.Game.Step.Path.Type" "swarm-0.6.0.0-ERx1HMcRMba59aI2b6aNrS-swarm-engine" 'False) ((C1 ('MetaCons "NewSubworld" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NewTargetType" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "NewWalkabilityContext" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NewDistanceLimit" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DistanceLimitChange))))

data CacheRetreivalInapplicability

Reasons why we cannot re-use a precomputed path from the cache upon re-invoking the Path command

Constructors

NotCached

DifferentArg DifferentArgument

PositionOutsidePath

Instances

ToJSON CacheRetreivalInapplicability

Defined in Swarm.Game.Step.Path.Type

Methods

toJSON :: CacheRetreivalInapplicability -> Value

toEncoding :: CacheRetreivalInapplicability -> Encoding

toJSONList :: [CacheRetreivalInapplicability] -> Value

toEncodingList :: [CacheRetreivalInapplicability] -> Encoding

omitField :: CacheRetreivalInapplicability -> Bool

Generic CacheRetreivalInapplicability

Defined in Swarm.Game.Step.Path.Type

Associated Types

type Rep CacheRetreivalInapplicability :: Type -> Type

Methods

from :: CacheRetreivalInapplicability -> Rep CacheRetreivalInapplicability x

to :: Rep CacheRetreivalInapplicability x -> CacheRetreivalInapplicability

Show CacheRetreivalInapplicability

Defined in Swarm.Game.Step.Path.Type

Methods

showsPrec :: Int -> CacheRetreivalInapplicability -> ShowS

show :: CacheRetreivalInapplicability -> String

showList :: [CacheRetreivalInapplicability] -> ShowS

Eq CacheRetreivalInapplicability

Defined in Swarm.Game.Step.Path.Type

Methods

(==) :: CacheRetreivalInapplicability -> CacheRetreivalInapplicability -> Bool

(/=) :: CacheRetreivalInapplicability -> CacheRetreivalInapplicability -> Bool

type Rep CacheRetreivalInapplicability

Defined in Swarm.Game.Step.Path.Type

type Rep CacheRetreivalInapplicability = D1 ('MetaData "CacheRetreivalInapplicability" "Swarm.Game.Step.Path.Type" "swarm-0.6.0.0-ERx1HMcRMba59aI2b6aNrS-swarm-engine" 'False) (C1 ('MetaCons "NotCached" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "DifferentArg" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DifferentArgument)) :+: C1 ('MetaCons "PositionOutsidePath" 'PrefixI 'False) (U1 :: Type -> Type)))

data InvalidationReason

Reasons for cache being invalidated

Constructors

TargetEntityAddedOutsidePath

TargetEntityRemoved

UnwalkableRemoved

UnwalkableOntoPath

NonexistentRobot

Instances

ToJSON InvalidationReason

Defined in Swarm.Game.Step.Path.Type

Methods

toJSON :: InvalidationReason -> Value

toEncoding :: InvalidationReason -> Encoding

toJSONList :: [InvalidationReason] -> Value

toEncodingList :: [InvalidationReason] -> Encoding

omitField :: InvalidationReason -> Bool

Generic InvalidationReason

Defined in Swarm.Game.Step.Path.Type

Associated Types

type Rep InvalidationReason :: Type -> Type

Methods

from :: InvalidationReason -> Rep InvalidationReason x

to :: Rep InvalidationReason x -> InvalidationReason

Show InvalidationReason

Defined in Swarm.Game.Step.Path.Type

Methods

showsPrec :: Int -> InvalidationReason -> ShowS

show :: InvalidationReason -> String

showList :: [InvalidationReason] -> ShowS

Eq InvalidationReason

Defined in Swarm.Game.Step.Path.Type

Methods

(==) :: InvalidationReason -> InvalidationReason -> Bool

(/=) :: InvalidationReason -> InvalidationReason -> Bool

type Rep InvalidationReason

Defined in Swarm.Game.Step.Path.Type

type Rep InvalidationReason = D1 ('MetaData "InvalidationReason" "Swarm.Game.Step.Path.Type" "swarm-0.6.0.0-ERx1HMcRMba59aI2b6aNrS-swarm-engine" 'False) ((C1 ('MetaCons "TargetEntityAddedOutsidePath" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "TargetEntityRemoved" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "UnwalkableRemoved" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "UnwalkableOntoPath" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NonexistentRobot" 'PrefixI 'False) (U1 :: Type -> Type))))

emptyPathCache :: PathCaching

data PathfindingTarget

Shortest paths can either be computed to the nearest entity of a given type or to a specific location.

Constructors

LocationTarget Location

EntityTarget EntityName

Note: navigation to entities does not benefit from the distance heuristic optimization of the A* algorithm (but see #1568)

Instances

ToJSON PathfindingTarget

Defined in Swarm.Game.Step.Path.Type

Methods

toJSON :: PathfindingTarget -> Value

toEncoding :: PathfindingTarget -> Encoding

toJSONList :: [PathfindingTarget] -> Value

toEncodingList :: [PathfindingTarget] -> Encoding

omitField :: PathfindingTarget -> Bool

Generic PathfindingTarget

Defined in Swarm.Game.Step.Path.Type

Associated Types

type Rep PathfindingTarget :: Type -> Type

Methods

from :: PathfindingTarget -> Rep PathfindingTarget x

to :: Rep PathfindingTarget x -> PathfindingTarget

Show PathfindingTarget

Defined in Swarm.Game.Step.Path.Type

Methods

showsPrec :: Int -> PathfindingTarget -> ShowS

show :: PathfindingTarget -> String

showList :: [PathfindingTarget] -> ShowS

Eq PathfindingTarget

Defined in Swarm.Game.Step.Path.Type

Methods

(==) :: PathfindingTarget -> PathfindingTarget -> Bool

(/=) :: PathfindingTarget -> PathfindingTarget -> Bool

type Rep PathfindingTarget

Defined in Swarm.Game.Step.Path.Type

type Rep PathfindingTarget = D1 ('MetaData "PathfindingTarget" "Swarm.Game.Step.Path.Type" "swarm-0.6.0.0-ERx1HMcRMba59aI2b6aNrS-swarm-engine" 'False) (C1 ('MetaCons "LocationTarget" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Location)) :+: C1 ('MetaCons "EntityTarget" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 EntityName)))

newtype TailMap

Facilitates lookup of any shortest path to a particular goal cell, given a location that already lies on a shortest path.

Constructors

TailMap (Map Location [Location])

Instances

ToJSON TailMap

Defined in Swarm.Game.Step.Path.Type

Methods

toJSON :: TailMap -> Value

toEncoding :: TailMap -> Encoding

toJSONList :: [TailMap] -> Value

toEncodingList :: [TailMap] -> Encoding

omitField :: TailMap -> Bool

Generic TailMap

Defined in Swarm.Game.Step.Path.Type

Associated Types

type Rep TailMap :: Type -> Type

Methods

from :: TailMap -> Rep TailMap x

to :: Rep TailMap x -> TailMap

Show TailMap

Defined in Swarm.Game.Step.Path.Type

Methods

showsPrec :: Int -> TailMap -> ShowS

show :: TailMap -> String

showList :: [TailMap] -> ShowS

Eq TailMap

Defined in Swarm.Game.Step.Path.Type

Methods

(==) :: TailMap -> TailMap -> Bool

(/=) :: TailMap -> TailMap -> Bool

type Rep TailMap

Defined in Swarm.Game.Step.Path.Type

type Rep TailMap = D1 ('MetaData "TailMap" "Swarm.Game.Step.Path.Type" "swarm-0.6.0.0-ERx1HMcRMba59aI2b6aNrS-swarm-engine" 'True) (C1 ('MetaCons "TailMap" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map Location [Location]))))

data CachedPath

Constructors

CachedPath

Fields

• originalPath :: NonEmpty Location
• locations :: TailMap

  Fast lookup map of path suffix by current location

Instances

ToJSON CachedPath

Defined in Swarm.Game.Step.Path.Type

Methods

toJSON :: CachedPath -> Value

toEncoding :: CachedPath -> Encoding

toJSONList :: [CachedPath] -> Value

toEncodingList :: [CachedPath] -> Encoding

omitField :: CachedPath -> Bool

Generic CachedPath

Defined in Swarm.Game.Step.Path.Type

Associated Types

type Rep CachedPath :: Type -> Type

Methods

from :: CachedPath -> Rep CachedPath x

to :: Rep CachedPath x -> CachedPath

Show CachedPath

Defined in Swarm.Game.Step.Path.Type

Methods

showsPrec :: Int -> CachedPath -> ShowS

show :: CachedPath -> String

showList :: [CachedPath] -> ShowS

Eq CachedPath

Defined in Swarm.Game.Step.Path.Type

Methods

(==) :: CachedPath -> CachedPath -> Bool

(/=) :: CachedPath -> CachedPath -> Bool

type Rep CachedPath

Defined in Swarm.Game.Step.Path.Type

type Rep CachedPath = D1 ('MetaData "CachedPath" "Swarm.Game.Step.Path.Type" "swarm-0.6.0.0-ERx1HMcRMba59aI2b6aNrS-swarm-engine" 'False) (C1 ('MetaCons "CachedPath" 'PrefixI 'True) (S1 ('MetaSel ('Just "originalPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Location)) :*: S1 ('MetaSel ('Just "locations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TailMap)))

data PathfindingCache

A per-robot cache for the path command.

Constructors

PathfindingCache

Fields

• invocationParms :: PathfindingParameters SubworldName
• walkabilityInfo :: WalkabilityContext
• targetLoc :: Location
• cachedPath :: CachedPath

Instances

ToJSON PathfindingCache

Defined in Swarm.Game.Step.Path.Type

Methods

toJSON :: PathfindingCache -> Value

toEncoding :: PathfindingCache -> Encoding

toJSONList :: [PathfindingCache] -> Value

toEncodingList :: [PathfindingCache] -> Encoding

omitField :: PathfindingCache -> Bool

Generic PathfindingCache

Defined in Swarm.Game.Step.Path.Type

Associated Types

type Rep PathfindingCache :: Type -> Type

Methods

from :: PathfindingCache -> Rep PathfindingCache x

to :: Rep PathfindingCache x -> PathfindingCache

Show PathfindingCache

Defined in Swarm.Game.Step.Path.Type

Methods

showsPrec :: Int -> PathfindingCache -> ShowS

show :: PathfindingCache -> String

showList :: [PathfindingCache] -> ShowS

Eq PathfindingCache

Defined in Swarm.Game.Step.Path.Type

Methods

(==) :: PathfindingCache -> PathfindingCache -> Bool

(/=) :: PathfindingCache -> PathfindingCache -> Bool

type Rep PathfindingCache

Defined in Swarm.Game.Step.Path.Type

type Rep PathfindingCache = D1 ('MetaData "PathfindingCache" "Swarm.Game.Step.Path.Type" "swarm-0.6.0.0-ERx1HMcRMba59aI2b6aNrS-swarm-engine" 'False) (C1 ('MetaCons "PathfindingCache" 'PrefixI 'True) ((S1 ('MetaSel ('Just "invocationParms") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (PathfindingParameters SubworldName)) :*: S1 ('MetaSel ('Just "walkabilityInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 WalkabilityContext)) :*: (S1 ('MetaSel ('Just "targetLoc") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Location) :*: S1 ('MetaSel ('Just "cachedPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CachedPath))))

data PathCaching

Constructors

PathCaching

Fields

• _pathCachingRobots :: IntMap PathfindingCache

  Keyed by RID

• _pathCachingLog :: RingBuffer CacheLogEntry

  For diagnosticstestingdebugging

pathCachingRobots :: Lens' PathCaching (IntMap PathfindingCache)

All the RIDs of robots that are storing a cached path that may require invalidation.

pathCachingLog :: Lens' PathCaching (RingBuffer CacheLogEntry)

Event log for cache invalidation