foxhole-warapi
- combineDynamicWithStaticData
- determineEventStatusType
- diffCombinedMapData
- findNearestTextItem
- getMapFlags
- hasMapFlag
Ƭ MapMarkerType: "Major" | "Minor"
Ƭ TeamId: "WARDENS" | "COLONIALS" | "NONE"
▸ combineDynamicWithStaticData(mapItems, mapTextItems): CombinedMapData[]
Matches each MapItem with the closest MapTextItem.
| Name | Type |
|---|---|
mapItems |
MapItem[] |
mapTextItems |
MapTextItem[] |
▸ determineEventStatusType(data): Event | undefined
| Name | Type |
|---|---|
data |
DiffedMapData |
Event | undefined
▸ diffCombinedMapData(data1, data2): DiffedMapData[]
Returns a list of CombinedMapData where the map flags or team id from the two arguments is different. Assumes that the order of the two lists is the same.
| Name | Type |
|---|---|
data1 |
CombinedMapData[] |
data2 |
CombinedMapData[] |
▸ findNearestTextItem(mapItem, mapTextItems): MapTextItem
Given a MapItem and a list of MapTextItems, finds the nearest MapTextItem. This is useful for determining which town a MapItem belongs to.
| Name | Type |
|---|---|
mapItem |
MapItem |
mapTextItems |
MapTextItem[] |
▸ getMapFlags(flags): MapFlags[]
Returns a list of each MapFlag that the flags contain.
| Name | Type |
|---|---|
flags |
number |
MapFlags[]
▸ hasMapFlag(flags, flag): boolean
Returns true if the flags number contains the given MapFlag.
| Name | Type |
|---|---|
flags |
number |
flag |
MapFlags |
boolean