GameViz (FSBarV1_Archived)

GameViz Module

Namespace: FSBar.Viz
Assembly: FSBar.Viz.dll

Live REPL visualization API. Thread-safe, single viewer instance.

Functions and values

Function or value	Description
`attachToClient client` Full Usage: `attachToClient client` Parameters: client : `BarClient`	client : `BarClient`
`attachWithState mapGrid metalSpots teamId` Full Usage: `attachWithState mapGrid metalSpots teamId` Parameters: mapGrid : `MapGrid` metalSpots : `(float32 * float32 * float32 * float32) array` teamId : `int`	mapGrid : `MapGrid` metalSpots : `(float32 * float32 * float32 * float32) array` teamId : `int`
`disableOverlay overlay` Full Usage: `disableOverlay overlay` Parameters: overlay : `OverlayKind`	overlay : `OverlayKind`
`enableOverlay overlay` Full Usage: `enableOverlay overlay` Parameters: overlay : `OverlayKind`	overlay : `OverlayKind`
`getActiveOverlays ()` Full Usage: `getActiveOverlays ()` Parameters: () : `unit` Returns: `Set<OverlayKind>`	Returns the current set of active overlays. Thread-safe; takes a snapshot under the same lock the `toggleOverlay` / `enableOverlay` / `disableOverlay` mutators hold. Added for feature 035-central-gui-hub (FR-017): hub chrome reads this each frame to reflect the in-viewer hotkey state in its own toolbar. () : `unit` Returns: `Set<OverlayKind>`
`isConfigPanelOpen ()` Full Usage: `isConfigPanelOpen ()` Parameters: () : `unit` Returns: `bool`	True if the configurator panel is currently open. () : `unit` Returns: `bool`
`onFrame frame` Full Usage: `onFrame frame` Parameters: frame : `GameFrame`	frame : `GameFrame`
`onFrameWithState gameState mapGrid` Full Usage: `onFrameWithState gameState mapGrid` Parameters: gameState : `GameState` mapGrid : `MapGrid`	gameState : `GameState` mapGrid : `MapGrid`
`pan dx dy` Full Usage: `pan dx dy` Parameters: dx : `float32` dy : `float32`	dx : `float32` dy : `float32`
`resetView ()` Full Usage: `resetView ()` Parameters: () : `unit`	() : `unit`
`screenshot folder` Full Usage: `screenshot folder` Parameters: folder : `string` Returns: `Result<string, string>`	folder : `string` Returns: `Result<string, string>`
`seedUnits unitStates` Full Usage: `seedUnits unitStates` Parameters: unitStates : `UnitState list`	unitStates : `UnitState list`
`setActiveOverlays overlays` Full Usage: `setActiveOverlays overlays` Parameters: overlays : `Set<OverlayKind>`	Replaces the current overlay set wholesale. Use this when the hub chrome's toolbar is the authoritative input, so a single click updates many overlays atomically rather than through a series of toggle calls. Thread-safe. overlays : `Set<OverlayKind>`
`setBaseLayer layer` Full Usage: `setBaseLayer layer` Parameters: layer : `LayerKind`	layer : `LayerKind`
`setColorScheme layer scheme` Full Usage: `setColorScheme layer scheme` Parameters: layer : `LayerKind` scheme : `ColorScheme`	layer : `LayerKind` scheme : `ColorScheme`
`setConfig cfg` Full Usage: `setConfig cfg` Parameters: cfg : `VizConfig`	cfg : `VizConfig`
`setDisconnected ()` Full Usage: `setDisconnected ()` Parameters: () : `unit`	() : `unit`
`setMarkerSize size` Full Usage: `setMarkerSize size` Parameters: size : `float32`	size : `float32`
`setOverlayOpacity opacity` Full Usage: `setOverlayOpacity opacity` Parameters: opacity : `float32`	opacity : `float32`
`start cfg` Full Usage: `start cfg` Parameters: cfg : `VizConfig option`	cfg : `VizConfig option`
`stop ()` Full Usage: `stop ()` Parameters: () : `unit`	() : `unit`
`toggleConfigPanel ()` Full Usage: `toggleConfigPanel ()` Parameters: () : `unit`	Toggle the style configurator side panel open/closed. () : `unit`
`toggleGridLines ()` Full Usage: `toggleGridLines ()` Parameters: () : `unit`	() : `unit`
`toggleOverlay overlay` Full Usage: `toggleOverlay overlay` Parameters: overlay : `OverlayKind`	overlay : `OverlayKind`
`updateConfig f` Full Usage: `updateConfig f` Parameters: f : `VizConfig -> VizConfig`	f : `VizConfig -> VizConfig`
`zoom factor centerX centerY` Full Usage: `zoom factor centerX centerY` Parameters: factor : `float32` centerX : `float32` centerY : `float32`	factor : `float32` centerX : `float32` centerY : `float32`