mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2026-04-16 06:18:42 +02:00
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>
118 lines
1.2 KiB
Markdown
118 lines
1.2 KiB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
|
|
[Home](./index.md) > [bitburner](./bitburner.md) > [GameInfo](./bitburner.gameinfo.md)
|
|
|
|
## GameInfo interface
|
|
|
|
Game Information
|
|
|
|
**Signature:**
|
|
|
|
```typescript
|
|
interface GameInfo
|
|
```
|
|
|
|
## Properties
|
|
|
|
<table><thead><tr><th>
|
|
|
|
Property
|
|
|
|
|
|
</th><th>
|
|
|
|
Modifiers
|
|
|
|
|
|
</th><th>
|
|
|
|
Type
|
|
|
|
|
|
</th><th>
|
|
|
|
Description
|
|
|
|
|
|
</th></tr></thead>
|
|
<tbody><tr><td>
|
|
|
|
[commit](./bitburner.gameinfo.commit.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
</td><td>
|
|
|
|
string
|
|
|
|
|
|
</td><td>
|
|
|
|
Git commit hash that the release was built from. E.g.: "d0d776700"
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[platform](./bitburner.gameinfo.platform.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
</td><td>
|
|
|
|
"Browser" \| "Steam"
|
|
|
|
|
|
</td><td>
|
|
|
|
Platform that the game is running on
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[version](./bitburner.gameinfo.version.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
</td><td>
|
|
|
|
string
|
|
|
|
|
|
</td><td>
|
|
|
|
Version as shown in release notes and in the UI. E.g.: "2.8.1"
|
|
|
|
Note that this property does not have the prefix "v". For example, with v2.8.1, this property is "2.8.1".
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[versionNumber](./bitburner.gameinfo.versionnumber.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
</td><td>
|
|
|
|
number
|
|
|
|
|
|
</td><td>
|
|
|
|
Internal version number that increments during releases. E.g.: 43
|
|
|
|
|
|
</td></tr>
|
|
</tbody></table>
|
|
|