mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2026-04-20 00:04:22 +02:00
Michael Taylor
dcd2f33f7c
* Update api-documentor and api-extractor. #1566 follow-up.
I have verified that the HTML/markdown table generation bug in
[#4878](https://github.com/microsoft/rushstack/issues/4878) in rushstack
for api-documentor has been fixed as per rushstack#5256. The testcase
[repro](https://github.com/catloversg/api-documenter-bug-pr-4578) now
produces the correct expected output.
I have confirmed that the generated output in bitburner from
`npm run doc` now generated HTML tables, and correctly inserts
a blank line between the </table> and the follow line (e.g. Returns).
Stylisticly it could use some whitespace, but it is correctly rendered.
This commit is only the updated packages, not the updated generated
documentation. I assume that is automatically generated by the GitHub
workflow.
* Follow up to 5f732a6f35, include `npm run doc` changed docs.
* Add missing license info
* Fix React warning
---------
Co-authored-by: CatLover <152669316+catloversg@users.noreply.github.com>
67 lines
1.6 KiB
Markdown
67 lines
1.6 KiB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
|
|
[Home](./index.md) > [bitburner](./bitburner.md) > [GoAnalysis](./bitburner.goanalysis.md) > [getChains](./bitburner.goanalysis.getchains.md)
|
|
|
|
## GoAnalysis.getChains() method
|
|
|
|
Returns an ID for each point. All points that share an ID are part of the same network (or "chain"). Empty points are also given chain IDs to represent continuous empty space. Dead nodes are given the value `null.`
|
|
|
|
Takes an optional boardState argument; by default uses the current board state.
|
|
|
|
The data from getChains() can be used with the data from getBoardState() to see which player (or empty) each chain is
|
|
|
|
For example, a 5x5 board might look like this. There is a large chain \#1 on the left side, smaller chains 2 and 3 on the right, and a large chain 0 taking up the center of the board. <pre lang="javascript"> \[ \[ 0,0,0,3,4\], \[ 1,0,0,3,3\], \[ 1,1,0,0,0\], \[null,1,0,2,2\], \[null,1,0,2,5\], \] </pre>
|
|
|
|
**Signature:**
|
|
|
|
```typescript
|
|
getChains(boardState?: string[]): (number | null)[][];
|
|
```
|
|
|
|
## Parameters
|
|
|
|
<table><thead><tr><th>
|
|
|
|
Parameter
|
|
|
|
|
|
</th><th>
|
|
|
|
Type
|
|
|
|
|
|
</th><th>
|
|
|
|
Description
|
|
|
|
|
|
</th></tr></thead>
|
|
<tbody><tr><td>
|
|
|
|
boardState
|
|
|
|
|
|
</td><td>
|
|
|
|
string\[\]
|
|
|
|
|
|
</td><td>
|
|
|
|
_(Optional)_ Optional. The current board state, as an array of strings. Defaults to the current board state.
|
|
|
|
|
|
</td></tr>
|
|
</tbody></table>
|
|
|
|
**Returns:**
|
|
|
|
(number \| null)\[\]\[\]
|
|
|
|
A 2D array of numbers identifying the chain ID of each point.
|
|
|
|
## Remarks
|
|
|
|
RAM cost: 16 GB (This is intentionally expensive; you can derive this info from just getBoardState() )
|
|
|