mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2024-11-22 23:53:48 +01:00
34 lines
846 B
Markdown
34 lines
846 B
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
|
|
[Home](./index.md) > [bitburner](./bitburner.md) > [Sleeve](./bitburner.sleeve.md) > [travel](./bitburner.sleeve.travel.md)
|
|
|
|
## Sleeve.travel() method
|
|
|
|
Make a sleeve travel to another city.
|
|
|
|
<b>Signature:</b>
|
|
|
|
```typescript
|
|
travel(sleeveNumber: number, city: CityName | `${CityName}`): boolean;
|
|
```
|
|
|
|
## Parameters
|
|
|
|
| Parameter | Type | Description |
|
|
| --- | --- | --- |
|
|
| sleeveNumber | number | Index of the sleeve to travel. |
|
|
| city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)<!-- -->}\` | Name of the destination city. |
|
|
|
|
<b>Returns:</b>
|
|
|
|
boolean
|
|
|
|
True if the sleeve reached destination, false otherwise.
|
|
|
|
## Remarks
|
|
|
|
RAM cost: 4 GB
|
|
|
|
Return a boolean indicating whether or not the sleeve reached destination.
|
|
|