bitburner-src/markdown/bitburner.singularity.getstats.md
Olivier Gagnon feb0430aff work on doc
2021-10-30 15:46:34 -04:00

34 lines
733 B
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Singularity](./bitburner.singularity.md) &gt; [getStats](./bitburner.singularity.getstats.md)
## Singularity.getStats() method
If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled.
Returns an object with the Players stats.
<b>Signature:</b>
```typescript
getStats(): PlayerSkills;
```
<b>Returns:</b>
[PlayerSkills](./bitburner.playerskills.md)
Object with the Players stats.
## Remarks
Singularity - Level 1
## Example
```ts
res = getStats();
print('My charisma level is: ' + res.charisma);
```