get_locations_list()
  • 1 Minute to read

get_locations_list()


Article summary

get_locations_list()

Retrieve the name of all saved locations in a specific map.

Reference

Arguments

ArgumentsTypeDefault value
map_namestrThe requested map.

Return

List with zone names.
[ $location_name_0, $location_name_1, . . .$location_name_n]

Exceptions

  • RayaNavNotLocated
  • RayaNavLocationsNotFound
  • RayaNavUnkownError

See the complete list of navigation exceptions.

Usage Example

Code:

...
class RayaApplication(RayaApplicationBase):

    async def setup(self):
        self.nav = await self.enable_controller('navigation')
        ...

    async def loop(self):
        ...
        locations_list = await self.nav.get_locations_list(map_name='unity_apartment')
        self.log.info(locations_list)
        ...

See the nav_all_unity_apartment, nav_get_info to check some valid uses.


Was this article helpful?