Logo FSBarV1_Archived

UnitDefCache Module

Functions for loading and querying unit definitions.

Functions and values

Function or value Description

all cache

Full Usage: all cache

Parameters:
Returns: UnitDefInfo seq

Returns all cached unit definitions.

cache : UnitDefCache
Returns: UnitDefInfo seq

empty

Full Usage: empty

Returns: UnitDefCache

Creates an empty cache with no definitions.

Returns: UnitDefCache

loadFromEngine stream

Full Usage: loadFromEngine stream

Parameters:
Returns: UnitDefCache

Loads all unit definitions from the engine via callbacks. One-time operation.

stream : NetworkStream
Returns: UnitDefCache

ofSeq defs

Full Usage: ofSeq defs

Parameters:
Returns: UnitDefCache

Creates a cache from a sequence of UnitDefInfo values.

defs : UnitDefInfo seq
Returns: UnitDefCache

tryFindById cache defId

Full Usage: tryFindById cache defId

Parameters:
Returns: UnitDefInfo option

Looks up a unit definition by its ID. Returns None if not found.

cache : UnitDefCache
defId : int
Returns: UnitDefInfo option

tryFindByName cache name

Full Usage: tryFindByName cache name

Parameters:
Returns: UnitDefInfo option

Looks up a unit definition by name. Returns None if not found.

cache : UnitDefCache
name : string
Returns: UnitDefInfo option

Type something to start searching.