bitburner-src/markdown/bitburner.ns.scp_1.md

55 lines
1.7 KiB
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; [NS](./bitburner.ns.md) &gt; [scp](./bitburner.ns.scp_1.md)
## NS.scp() method
Copies a script or literature (.lit) file(s) to another server. The files argument can be either a string specifying a single file to copy, or an array of strings specifying multiple files to copy.
<b>Signature:</b>
```typescript
scp(
files: string | ReadonlyArray<string>,
2021-10-30 21:46:34 +02:00
source: string,
2021-10-30 18:34:14 +02:00
// tslint:disable-next-line:unified-signatures
2021-10-30 21:46:34 +02:00
destination: string,
2021-10-30 18:34:14 +02:00
): boolean;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| files | string \| ReadonlyArray&lt;string&gt; | Filename or an array of filenames of script/literature files to copy. |
2021-10-30 21:46:34 +02:00
| source | string | Host or IP of the source server, which is the server from which the file will be copied. This argument is optional and if its omitted the source will be the current server. |
| destination | string | Host or IP of the destination server, which is the server to which the file will be copied. |
2021-10-30 18:34:14 +02:00
<b>Returns:</b>
boolean
True if the script/literature file is successfully copied over and false otherwise. If the files argument is an array then this function will return true if at least one of the files in the array is successfully copied.
## Remarks
2021-10-30 21:46:34 +02:00
RAM cost: 0.6 GB
2021-10-30 18:34:14 +02:00
## Example 1
2021-10-30 21:46:34 +02:00
```ts
2021-10-30 18:34:14 +02:00
//Copies foo.lit from the helios server to the home computer:
scp("foo.lit", "helios", "home");
```
## Example 2
2021-10-30 21:46:34 +02:00
```ts
2021-10-30 18:34:14 +02:00
//Tries to copy three files from rothman-uni to home computer:
files = ["foo1.lit", "foo2.script", "foo3.script"];
scp(files, "rothman-uni", "home");
```