Namespace: TFX

File Manifest

File Manifest

File	Language	Author(s)	Copyright
chitEngine.js	Javascript	Kenneth F. Guerin	Copyright © 2020-2024 Brick Mill Games, LLC, All rights reserved.
chitGeometry.js	Javascript	Kenneth F. Guerin	Copyright © 2020-2024 Brick Mill Games, LLC, All rights reserved.
counterGrid.js	Javascript	Kenneth F. Guerin	Copyright © 2020-2024 Brick Mill Games, LLC, All rights reserved.
counterStack.js	Javascript	Kenneth F. Guerin	Copyright © 2020-2024 Brick Mill Games, LLC, All rights reserved.
gameSessionManager.js	Javascript	Kenneth F. Guerin	Copyright © 2024 Brick Mill Games, LLC, All rights reserved.
gameSessionPane.js	Javascript	Kenneth F. Guerin	Copyright © 2023-2024 Brick Mill Games, LLC, All rights reserved.
hexGroup.js	Javascript	Kenneth F. Guerin	Copyright © 2024 Brick Mill Games, LLC, All rights reserved.
hexMapInfo.js	Javascript	Kenneth F. Guerin	Copyright © 2018-2024, Brick Mill Games, LLC, all rights reserved.
hexRegionHighlight.js	Javascript	Kenneth F. Guerin	Copyright © 2024 Brick Mill Games, LLC, All rights reserved.
nato.js	Javascript	Kenneth F. Guerin	Copyright © 2020-2024 Brick Mill Games, LLC, All rights reserved.
oobTableauPane.js	Javascript	Kenneth F. Guerin	Copyright © 2023-2024 Brick Mill Games, LLC, All rights reserved.
oobTableauUnitLayout.js	Javascript	Kenneth F. Guerin	Copyright © 2023-2024 Brick Mill Games, LLC, All rights reserved.
svgIcons.js	Javascript	Kenneth F. Guerin	Copyright © 2023-2024 Brick Mill Games, LLC, All rights reserved.
tableauPane.js	Javascript	Kenneth F. Guerin	Copyright © 2020-2024 Brick Mill Games, LLC, All rights reserved.
tfx.js	Javascript	Kenneth F. Guerin	Copyright © 2020-2024 Brick Mill Games, LLC, All rights reserved.
tiledMap.js	Javascript	Kenneth F. Guerin	Copyright © 2020-2024 Brick Mill Games, LLC, All rights reserved.
trex.js	Javascript	Kenneth F. Guerin	Copyright © 2020-2024 Brick Mill Games, LLC, All rights reserved.
unitCounter.js	Javascript	Kenneth F. Guerin	Copyright © 2023-2024 Brick Mill Games, LLC, All rights reserved.
ww2tac.js	Javascript	Kenneth F. Guerin	Copyright © 2020-2024 Brick Mill Games, LLC, All rights reserved.

Overview

Constant Registry

Function Registry

Constant Details

CTAB   <read-only>

RECT   <read-only>

RRECT   <read-only>

Function Details

TFX.crossIconFactory() → String

This function builds the cross icon using a path element.

Returns:

• [String] — the SVG paths comprising the cross icon

---

TFX.headstoneIconFactory() → String

This function builds the headstone icon using a path element.

Returns:

• [String] — the SVG paths comprising the headstone icon

---

TFX.oobIconFactory() → String

This function builds the oob icon using a path element.

Returns:

• [String] — the SVG paths comprising the oob icon

---

TFX.redCrossIconFactory() → String

This function builds the red cross icon using a path element.

Returns:

• [String] — the SVG paths comprising the red cross icon

---

Class: TFX.ChitEngine

File Manifest

File Manifest

File	Language	Author(s)	Copyright
chitEngine.js	Javascript	Kenneth F. Guerin	Copyright © 2020-2024 Brick Mill Games, LLC, All rights reserved.

Overview

Class: TFX.ChitGeometry

File Manifest

File Manifest

File	Language	Author(s)	Copyright
chitGeometry.js	Javascript	Kenneth F. Guerin	Copyright © 2020-2024 Brick Mill Games, LLC, All rights reserved.

Overview

Class: TFX.CounterGrid ⟼ <counter-grid>

File Manifest

File Manifest

File	Language	Author(s)	Copyright
counterGrid.js	Javascript	Kenneth F. Guerin	Copyright © 2020-2024 Brick Mill Games, LLC, All rights reserved.

Overview

Class: TFX.CounterStack ⟼ <counter-stack>

File Manifest

File Manifest

File	Language	Author(s)	Copyright
counterStack.js	Javascript	Kenneth F. Guerin	Copyright © 2020-2024 Brick Mill Games, LLC, All rights reserved.

Overview

Method Registry

Method Details

$manageChildren()   <private>

This private method is used to manage the stack's children based on its current mode and offset parameters.

---

Class: TFX.GameSessionManager

File Manifest

File Manifest

File	Language	Author(s)	Copyright
gameSessionManager.js	Javascript	Kenneth F. Guerin	Copyright © 2024 Brick Mill Games, LLC, All rights reserved.

Overview

Class: TFX.GameSessionPane ⟼ <game-session-pane>

File Manifest

File Manifest

File	Language	Author(s)	Copyright
gameSessionPane.js	Javascript	Kenneth F. Guerin	Copyright © 2023-2024 Brick Mill Games, LLC, All rights reserved.

Overview

Class: TFX.HexGroup

File Manifest

File Manifest

File	Language	Author(s)	Copyright
hexGroup.js	Javascript	Kenneth F. Guerin	Copyright © 2024 Brick Mill Games, LLC, All rights reserved.

Overview

Class: TFX.HexMapInfo

File Manifest

File Manifest

File	Language	Author(s)	Copyright
hexMapInfo.js	Javascript	Kenneth F. Guerin	Copyright © 2018-2024, Brick Mill Games, LLC, all rights reserved.

Overview

Constructor Registry

Method Registry

Constructor Details

new TFX.HexMapInfo(cols, rows, hborder, vborder) ⇏ ArgumentError

Parameters:

• cols [Number] — the number of hexagon columns in the map
• rows [Number] — the number of hexagon rows in the map
• hborder [Number] — the size of the horizontal borders (top & bottom)
• vborder [Number] — the size of the vertical borders (left & right)

Throws:

• [ArgumentError] — if the orientation is invalid or unrecognizable

---

Method Details

$directionToInteger(direction) → Integer   <private>

This private method converts a valid wide hex edge direction string to an integer.

Parameters:

• direction [String] — the direction string descriptions

Returns:

• [Integer] — an integer ranging from 0 to 5, if valid, where 0 is north and proceeding clockwise, -1 if direction is invalid

---

buildHexPathDescriptor(params) → Array<Hash>

This method returns an array of hex path segment information.

Parameters:

• params [Hash] — the hex path parameters

Returns:

• [Array<Hash>] — an array of hashes, each containing information required to create one segment of the hex path

---

calcHexPathBounds(params) → Hash

This method hexcol-based bounds information to aid in hex-in-region detection logic

Parameters:

• params [Hash] — the hex region parameters

Returns:

• [Hash] — a hash containing bounds values by hexcol

---

coordAt(hexcol, hexrow) → Object

This method returns the center point of the specified hex tile

Parameters:

• hexcol [Number] — the hex column of the hex tile
• hexrow [Number] — the hex row of the hex tile

Returns:

• [Object] — the center point of the hex tile with an x property and a y property

---

draw(callback)

This method uses a callback function to draw the hex map for each hex.

Parameters:

• callback [Function] — the function to call initialization and hex drawing operations

---

formatHexPathDescriptor(desc, formatter, needs_bbox) → Hash ⇏ ArgumentError

This method converts a hex path descriptor to a different type of data set.

Parameters:

• desc [Array<Hash>] — the hex path descriptor
• formatter [Hash] — a hash containing keyed functions to handle conversion functions
• needs_bbox [Boolean] — true, if the caller wants bounding box information calculated and returned <default: false>

Returns:

• [Hash] — a hash containing the type of data returned as well as a path description in the format defined by the type

Throws:

• [ArgumentError] — if the descriptor is invalid, or the type is invalid

---

getAdjacentTiles(hexcol, hexrow) → Array<Hash or Null>] the coordinates of the six adjacent hex tiles, in order of [ col,row-1

This method returns an array of hex tile coordinates of the six adjacent hex tiles.

Parameters:

• hexcol [Number] — the hex column of the hex tile
• hexrow [Number] — the hex row of the hex tile

Returns:

• [Array<Hash or Null>] the coordinates of the six adjacent hex tiles, in order of [ col,row-1 ] — and progressing clockwise

---

getAlignment(hexcol, hexrow, hexcol2, hexrow2) → Hash or Null

This method determines if two hexes are aligned with each other along the six hexrow directions

Parameters:

• hexcol [Number] — the hex column of the hex tile
• hexrow [Number] — the hex row of the hex tile
• hexcol2 [Number] — the hex column of the second hex tile
• hexrow2 [Number] — the hex row of the second hex tile

Returns:

• [Hash or Null] — the direction and distance of the aligned hex from the first to the second hex, or Null if not aligned

---

getSpineAlignment(hexcol, hexrow, hexcol2, hexrow2, extended) → Hash or Null

This method determines if two hexes are aligned with each other along the two horizontal or six hex-spine directions

Parameters:

• hexcol [Number] — the hex column of the hex tile
• hexrow [Number] — the hex row of the hex tile
• hexcol2 [Number] — the hex column of the second hex tile
• hexrow2 [Number] — the hex row of the second hex tile
• extended [Boolean] — if true, calculates alignment along the non-horizontal hex-spine directions

Returns:

• [Hash or Null] — the direction and distance of the aligned hex from the first to the second hex, or Null if not aligned

---

hcsFor(hexcol, hexrow, granularity) → Cartesia.HexCoordinateSystem

This method returns a hex coordinate system tied to a specific hex map tile.

Parameters:

• hexcol [Number] — the hex column of the map tile
• hexrow [Number] — the hex row of the map tile
• granularity [Integer] — the granularity of the coordinate system

Returns:

• [Cartesia.HexCoordinateSystem] — a CoordinateSystem tied to that specific hex map tile

---

hexesAway(hexcol, hexrow, to_hexcol, to_hexrow) → Number

This method returns the number of hexes away one hex tile is from another

Parameters:

• hexcol [Number] — the hex column of the origin hex tile
• hexrow [Number] — the hex row of the origin hex tile
• to_hexcol [Number] — the hex column of the distant hex tile
• to_hexrow [Number] — the hex row of the distant hex tile

Returns:

• [Number] — the number of hexes the distant hex tile is from the origin tile

---

hextantsAway(hexcol, hexrow, to_hexcol, to_hexrow) → Array<String>] the hextant locations of the distant hex tile from the origin: [ 'nw','w','sw','ne','e','se'

This method returns the hextants where one hex tile is from another

Parameters:

• hexcol [Number] — the hex column of the origin hex tile
• hexrow [Number] — the hex row of the origin hex tile
• to_hexcol [Number] — the hex column of the distant hex tile
• to_hexrow [Number] — the hex row of the distant hex tile

Returns:

• [Array<String>] the hextant locations of the distant hex tile from the origin: [ 'nw','w','sw','ne','e','se' ] —

---

isAdjacent(hexcol, hexrow, hexcol2, hexrow2) → Integer

This method determines if two hexes are adjacent to each other

Parameters:

• hexcol [Number] — the hex column of the hex tile
• hexrow [Number] — the hex row of the hex tile
• hexcol2 [Number] — the hex column of the second hex tile
• hexrow2 [Number] — the hex row of the second hex tile

Returns:

• [Integer] — the direction of the adjacent from the first to the second hex, or -1 if not adjacent

---

makeCirclePath(params, needs_bbox) → Hash

This method returns a circular path description based on the incoming single-hex hex region parameters.

Parameters:

• params [Hash] — the hex region parameters
• needs_bbox [Boolean] — true, if the caller wants bounding box information calculated and returned <default: false>

Returns:

• [Hash] — a hash containing the center coordinate of the hex and the path descriptor relative to that point.

---

makeHexPath(params, needs_bbox) → Hash

This method returns a hex path description based on the incoming hex region parameters.

Parameters:

• params [Hash] — the hex region parameters
• needs_bbox [Boolean] — true, if the caller wants bounding box information calculated and returned <default: false>

Returns:

• [Hash] — a hash containing the center coordinate of the hex and the path descriptor relative to that point.

---

makeHexPathCoords(params, needs_bbox) → Hash

This method returns a hex path description based on the incoming hex region parameters.

Parameters:

• params [Hash] — the hex region parameters
• needs_bbox [Boolean] — true, if the caller wants bounding box information calculated and returned <default: false>

Returns:

• [Hash] — a hash containing the center coordinate of the hex and the path descriptor relative to that point.

---

makePathInHex(params, needs_bbox) → Hash

This method returns a circular path description based on the incoming single-hex hex region parameters.

Parameters:

• params [Hash] — the hex region parameters
• needs_bbox [Boolean] — true, if the caller wants bounding box information calculated and returned <default: false>

Returns:

• [Hash] — a hash containing the center coordinate of the hex and the path descriptor relative to that point.

---

mapdims() → Array<Number>

This method returns the map dimensions.

Returns:

• [Array<Number>] — the width and height of the map returned as a 2-element array

---

nearestHexTo(point) → Object

This method returns the nearest hex tile to a given point

Parameters:

• point [Variadic] — the specified point

Returns:

• [Object] — the nearest hex tile as a JS object with row, column and dir properties

---

traceHexPathDescriptor(params, debug) → Array<Hash>

This method returns an array of hex path segment information.

Parameters:

• params [Hash] — the hex path parameters
• debug [Number] — debug level <default: 0>

Returns:

• [Array<Hash>] — an array of hashes, each containing information required to create one segment of the hex path

---

visitNextTile(hexcol, hexrow, direction, unclipped) → Array<Hash> or Null

This method returns the next tile in a given direction.

Parameters:

• hexcol [Number] — the hex column of the hex tile
• hexrow [Number] — the hex row of the hex tile
• direction [String or Number] — the direction to visit
• unclipped [Boolean] — allow off-map visiting of virtual tiles, if true <default: false>

Returns:

• [Array<Hash> or Null] — an array of hex tile coordinates, or null if a callback function was specified

---

visitTiles(hexcol, hexrow, n, direction, callback) → Array<Hash> or Null

This method returns an array of hex tile coordinates ranging n hexes out in a given direction and including the target tile.

Parameters:

• hexcol [Number] — the hex column of the hex tile
• hexrow [Number] — the hex row of the hex tile
• n [Number] — the number of tiles to visit, limited by the map edges
• direction [String or Number] — the direction to visit
• callback [Function or Null] — the callback function to call for each hex tile visited

Returns:

• [Array<Hash> or Null] — an array of hex tile coordinates, or null if a callback function was specified

---

Class: TFX.HexRegionHighlight

File Manifest

File Manifest

File	Language	Author(s)	Copyright
hexRegionHighlight.js	Javascript	Kenneth F. Guerin	Copyright © 2024 Brick Mill Games, LLC, All rights reserved.

Overview

Class: TFX.NATO

File Manifest

File Manifest

File	Language	Author(s)	Copyright
nato.js	Javascript	Kenneth F. Guerin	Copyright © 2020-2024 Brick Mill Games, LLC, All rights reserved.

Overview

Class: TFX.OOBTableauPane

File Manifest

File Manifest

File	Language	Author(s)	Copyright
oobTableauPane.js	Javascript	Kenneth F. Guerin	Copyright © 2023-2024 Brick Mill Games, LLC, All rights reserved.

Overview

Class: TFX.OOBTableauUnitLayout

File Manifest

File Manifest

File	Language	Author(s)	Copyright
oobTableauUnitLayout.js	Javascript	Kenneth F. Guerin	Copyright © 2023-2024 Brick Mill Games, LLC, All rights reserved.

Overview

Class: TFX.TRex

File Manifest

File Manifest

File	Language	Author(s)	Copyright
trex.js	Javascript	Kenneth F. Guerin	Copyright © 2020-2024 Brick Mill Games, LLC, All rights reserved.

Overview

Class: TFX.TableauPane ⟼ <tableau-pane>

File Manifest

File Manifest

File	Language	Author(s)	Copyright
tableauPane.js	Javascript	Kenneth F. Guerin	Copyright © 2020-2024 Brick Mill Games, LLC, All rights reserved.

Overview

Class: TFX.TiledMap ⟼ <tiled-map>

File Manifest

File Manifest

File	Language	Author(s)	Copyright
tiledMap.js	Javascript	Kenneth F. Guerin	Copyright © 2020-2024 Brick Mill Games, LLC, All rights reserved.

Overview

Class: TFX.UnitCounter

File Manifest

File Manifest

File	Language	Author(s)	Copyright
unitCounter.js	Javascript	Kenneth F. Guerin	Copyright © 2023-2024 Brick Mill Games, LLC, All rights reserved.

Overview

Namespace: TFX.WW2TacticalContext

File Manifest

File Manifest

File	Language	Author(s)	Copyright
ww2tac.js	Javascript	Kenneth F. Guerin	Copyright © 2020-2024 Brick Mill Games, LLC, All rights reserved.

Overview

Constant Registry

Function Registry

Constant Details

gtab   <read-only>

Function Details

drawAARof(state, chit)

This function is used to draw a unit onto a given chit.

Parameters:

• state [Object] — the unit state
• chit [TFX.Chit] — the chit object to draw onto

---

drawArmDots(state, chit)

This function is used to draw a unit onto a given chit.

Parameters:

• state [Object] — the unit state
• chit [TFX.Chit] — the chit object to draw onto

---

drawGrade(state, chit)

This function is used to draw a unit onto a given chit.

Parameters:

• state [Object] — the unit state
• chit [TFX.Chit] — the chit object to draw onto

---

drawPatch(state, chit)

This function is used to draw a unit onto a given chit.

Parameters:

• state [Object] — the unit state
• chit [TFX.Chit] — the chit object to draw onto

---

drawRating(state, chit)

This function is used to draw a unit onto a given chit.

Parameters:

• state [Object] — the unit state
• chit [TFX.Chit] — the chit object to draw onto

---

drawStepDiamonds(state, chit)

This function is used to draw a unit onto a given chit.

Parameters:

• state [Object] — the unit state
• chit [TFX.Chit] — the chit object to draw onto

---

drawUnit(state, chit)

This function is used to draw a unit onto a given chit.

Parameters:

• state [Object] — the unit state
• chit [TFX.Chit] — the chit object to draw onto

---

getCounterProperties(state) → Object

This function is used to get the unit's counter properties.

Parameters:

• state [Object] — the unit state

Returns:

• [Object] — the unit's counter properties object
• gtab [Object] — the TFX.WW2TacticalContext.gtab constant
• indent [Integer] — the size of the chit indentation
• outline [Integer] — the size of the chit outline
• type [String] — the type of chit: hq,pic,nato
• cmdFont [String] — the font to use for the unit's command
• natoIdFont [String] — the font to use for a NATO-type unit's ID
• minNatoIdFont [String] — the miniumum-sized font to use for a NATO-type unit's ID
• splitNatoIdFont [String] — the font to use for a NATO-type unit's ID
• picIdFont [String] — the font to use for a pic-type unit's ID
• picLabelFont [String] — the font to use for a pic-type unit's vehicular label
• ratingFont [String] — the font to use for the unit's rating
• hqRangeFont [String] — the font to use for the unit's HQ range
• artRangeFont [String] — the font to use for the unit's artillery range
• aaRofFont [String] — the font to use for the unit's AA ROF
• armAtFont [String] — the font to use for the unit's Arm/AT ratings

---

getEquipmentInfo(state) → Object or Null

This function is used to get the unit's equipment information based on its unit state.

Parameters:

• state [Object] — the unit state

Returns:

• [Object or Null] — the equipment information necessary for resource downloads
• category [String] — the type of wargame graphic resource to get (usually 'Vehicles')
• nationality [String] — the unit's nationality
• name [String] — the name of the piece of equipment to get
• options [String] — the equipment's options to apply, such as 'dozer' for M4 Tankdozer <default: none>
• label [String] — the optional name of the piece of equipment to label the unit's chit with <default: name>

---

getNatoSize(size) → String

This function is used to convert a NATO size from one format to another. It is usually used to convert capitalized spreadsheet-formatted information into a non-capitalized internal format, such as 'Division' to 'division'. It also handles useful short-hand notations, such as 'Div' to 'division'.

Parameters:

• size [String] — the size of the NATO formation

Returns:

• [String] — the size of the NATO formation

---

getNatoSubtype(subtype) → String

This function is used to convert a NATO subtype from one format to another. It is usually used to convert capitalized spreadsheet-formatted information into a non-capitalized internal format, such as 'Mechanized' to 'mechanized'. It also handles useful short-hand notations, such as 'Mech' to 'mechanized'.

Parameters:

• subtype [String] — the subtype of the NATO formation

Returns:

• [String] — the subtype of the NATO formation

---

getNatoType(type) → String

This function is used to convert a NATO type from one format to another. It is usually used to convert capitalized spreadsheet-formatted information into a non-capitalized internal format, such as 'Infantry' to 'infantry'. It also handles useful short-hand notations, such as 'Inf' to 'infantry'.

Parameters:

• type [String] — the type of the NATO formation

Returns:

• [String] — the type of the NATO formation

---

parseNato(state, isHQ) → Object

This function is used to parse a unit's state to gain NATO information.

Parameters:

• state [Object] — the unit state
• isHQ [Boolean] — true if the unit is an HQ unit

Returns:

• [Object] — the NATO object
• size [String] — the unit's NATO size
• type [String] — the unit's NATO type
• subtypes [Array<String>] — the unit's NATO subtypes, if any

---