bitburner-src/markdown/bitburner.singularity.getcompanyfavor.md
Olivier Gagnon 43fc5dfd48 work on doc
2021-10-30 12:34:14 -04:00

33 lines
928 B
Markdown

<!-- 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; [getCompanyFavor](./bitburner.singularity.getcompanyfavor.md)
## Singularity.getCompanyFavor() method
If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.
This function will return the amount of favor you have at the specified company. If the company passed in as an argument is invalid, -1 will be returned.
<b>Signature:</b>
```typescript
getCompanyFavor(companyName: CompanyName): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| companyName | [CompanyName](./bitburner.companyname.md) | Name of the company. |
<b>Returns:</b>
number
Amount of favor you have at the specified company.
## Remarks
1 GB Level 2