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

34 lines
819 B
Markdown

<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Sleeve](./bitburner.sleeve.md) &gt; [travel](./bitburner.sleeve.travel.md)
## Sleeve.travel() method
If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.
Return a boolean indicating whether or not the sleeve reached destination.
<b>Signature:</b>
```typescript
travel(sleeveNumber: number, cityName: City): boolean;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| sleeveNumber | number | Index of the sleeve to travel. |
| cityName | [City](./bitburner.city.md) | Name of the destination city. |
<b>Returns:</b>
boolean
True if the sleeve reached destination, false otherwise.
## Remarks
4 GB