# Step

# Step

Artifact:[androidx.car.app:app](https://developer.android.com/jetpack/androidx/releases/car-app)  
[View Source](https://cs.android.com/search?q=file:androidx/car/app/navigation/model/Step.java+class:androidx.car.app.navigation.model.Step)  
Added in[1.0.0](https://developer.android.com/jetpack/androidx/releases/car-app#1.0.0)

*** ** * ** ***

Kotlin\|[Java](https://developer.android.com/reference/androidx/car/app/navigation/model/Step "View this page in Java")

<br />

```
@CarProtocol
class Step
```

<br />

*** ** * ** ***

Represents a step that the driver should take in order to remain on the current navigation route.

Example of steps are turning onto a street, taking a highway exit and merging onto a different highway, or continuing straight through a roundabout.

## Summary

|                                                                                                         ### Nested types                                                                                                         |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `class `[Step.Builder](https://developer.android.com/reference/kotlin/androidx/car/app/navigation/model/Step.Builder) A builder of[Step](https://developer.android.com/reference/kotlin/androidx/car/app/navigation/model/Step). |

|                                                                                                                                          ### Public functions                                                                                                                                           |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)                                                                                                                                                                                                                     | [equals](https://developer.android.com/reference/kotlin/androidx/car/app/navigation/model/Step#equals(java.lang.Object))`(other: `[Any](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html)`?)`                                                                                                                  |
| [CarText](https://developer.android.com/reference/kotlin/androidx/car/app/model/CarText)`?`                                                                                                                                                                                                             | [getCue](https://developer.android.com/reference/kotlin/androidx/car/app/navigation/model/Step#getCue())`()` Returns the text description of this maneuver or`null`if not set.                                                                                                                                                     |
| `(`[Mutable](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-mutable-list/index.html)`)`[List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)`<`[Lane](https://developer.android.com/reference/kotlin/androidx/car/app/navigation/model/Lane)`!>` | [getLanes](https://developer.android.com/reference/kotlin/androidx/car/app/navigation/model/Step#getLanes())`()` Returns a list of[Lane](https://developer.android.com/reference/kotlin/androidx/car/app/navigation/model/Lane)that contains information of the road lanes at the point where the driver should execute this step. |
| [CarIcon](https://developer.android.com/reference/kotlin/androidx/car/app/model/CarIcon)`?`                                                                                                                                                                                                             | [getLanesImage](https://developer.android.com/reference/kotlin/androidx/car/app/navigation/model/Step#getLanesImage())`()` Returns the image representing all the lanes or`null`if not set.                                                                                                                                        |
| [Maneuver](https://developer.android.com/reference/kotlin/androidx/car/app/navigation/model/Maneuver)`?`                                                                                                                                                                                                | [getManeuver](https://developer.android.com/reference/kotlin/androidx/car/app/navigation/model/Step#getManeuver())`()` Returns the maneuver to be performed on this step or`null`if this step doesn't involve a maneuver.                                                                                                          |
| [CarText](https://developer.android.com/reference/kotlin/androidx/car/app/model/CarText)`?`                                                                                                                                                                                                             | [getRoad](https://developer.android.com/reference/kotlin/androidx/car/app/navigation/model/Step#getRoad())`()` Returns the text description of the road for the step or`null`if unknown.                                                                                                                                           |
| [Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)                                                                                                                                                                                                                             | [hashCode](https://developer.android.com/reference/kotlin/androidx/car/app/navigation/model/Step#hashCode())`()`                                                                                                                                                                                                                   |
| [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)                                                                                                                                                                                                                       | [toString](https://developer.android.com/reference/kotlin/androidx/car/app/navigation/model/Step#toString())`()`                                                                                                                                                                                                                   |

## Public functions

### equals

```
fun equals(other: Any?): Boolean
```  

### getCue

Added in[1.0.0](https://developer.android.com/jetpack/androidx/releases/car-app#1.0.0)  

```
fun getCue(): CarText?
```

Returns the text description of this maneuver or`null`if not set.  

|                                                                See also                                                                |
|----------------------------------------------------------------------------------------------------------------------------------------|---|
| [setCue](https://developer.android.com/reference/kotlin/androidx/car/app/navigation/model/Step.Builder#setCue(java.lang.CharSequence)) |   |

### getLanes

Added in[1.0.0](https://developer.android.com/jetpack/androidx/releases/car-app#1.0.0)  

```
fun getLanes(): (Mutable)List<Lane!>
```

Returns a list of[Lane](https://developer.android.com/reference/kotlin/androidx/car/app/navigation/model/Lane)that contains information of the road lanes at the point where the driver should execute this step.  

|                                                                         See also                                                                         |
|----------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| [addLane](https://developer.android.com/reference/kotlin/androidx/car/app/navigation/model/Step.Builder#addLane(androidx.car.app.navigation.model.Lane)) |   |

### getLanesImage

Added in[1.0.0](https://developer.android.com/jetpack/androidx/releases/car-app#1.0.0)  

```
fun getLanesImage(): CarIcon?
```

Returns the image representing all the lanes or`null`if not set.  

|                                                                           See also                                                                           |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| [setLanesImage](https://developer.android.com/reference/kotlin/androidx/car/app/navigation/model/Step.Builder#setLanesImage(androidx.car.app.model.CarIcon)) |   |

### getManeuver

Added in[1.0.0](https://developer.android.com/jetpack/androidx/releases/car-app#1.0.0)  

```
fun getManeuver(): Maneuver?
```

Returns the maneuver to be performed on this step or`null`if this step doesn't involve a maneuver.  

|                                                                               See also                                                                               |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| [setManeuver](https://developer.android.com/reference/kotlin/androidx/car/app/navigation/model/Step.Builder#setManeuver(androidx.car.app.navigation.model.Maneuver)) |   |

### getRoad

Added in[1.0.0](https://developer.android.com/jetpack/androidx/releases/car-app#1.0.0)  

```
fun getRoad(): CarText?
```

Returns the text description of the road for the step or`null`if unknown.  

|                                                                 See also                                                                 |
|------------------------------------------------------------------------------------------------------------------------------------------|---|
| [setRoad](https://developer.android.com/reference/kotlin/androidx/car/app/navigation/model/Step.Builder#setRoad(java.lang.CharSequence)) |   |

### hashCode

```
fun hashCode(): Int
```  

### toString

```
fun toString(): String
```