bitburner-src/markdown/bitburner.codingcontract.getdescription.md

34 lines
825 B
Markdown
Raw Normal View History

2021-10-30 18:34:14 +02:00
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CodingContract](./bitburner.codingcontract.md) &gt; [getDescription](./bitburner.codingcontract.getdescription.md)
## CodingContract.getDescription() method
2021-11-03 05:27:21 +01:00
Get the description.
2021-10-30 18:34:14 +02:00
<b>Signature:</b>
```typescript
2021-11-22 17:36:13 +01:00
getDescription(filename: string, host?: string): string;
2021-10-30 18:34:14 +02:00
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
2022-05-24 14:12:49 +02:00
| filename | string | Filename of the contract. |
2022-09-23 21:03:38 +02:00
| host | string | Hostname of the server containing the contract. Optional. Defaults to current server if not provided. |
2021-10-30 18:34:14 +02:00
<b>Returns:</b>
string
Contracts text description.
## Remarks
2021-10-30 21:46:34 +02:00
RAM cost: 5 GB
2021-10-30 18:34:14 +02:00
2021-11-03 05:27:21 +01:00
Get the full text description for the problem posed by the Coding Contract.