GridWorld.get_area_name

GridWorld.get_area_name(area_idx)

Get the alias name of an area using area index.

Parameters:

area_idx (int) – Index of the area to get name.

Returns:

name – Name of the area with index area_idx.

Return type:

str

Examples

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