GridWorld.get_area_index

GridWorld.get_area_index(area_name)

Get the index of an area with its alias name.

Parameters:

area_name (str) – Name of the area to get index.

Returns:

index – Index of the area with alias name area_name.

Return type:

int

Examples

>>> W = GridWorld()
>>> W.add_area((2, 2), name="Up")
>>> W.get_area_index("Up")
1