get_zones_list()
  • 1 Minute to read

get_zones_list()


Article summary

get_zones_list()

Retrieve all saved zone areas in a specific map. The function returns the zones name.

Reference

Arguments

ArgumentsTypeDefault value
map_namestrThe requested map.

Return

List with zone names.
[ $zone_name_0, $zone_name_1, . . .$zone_name_n]

Exceptions

  • RayaNavNotLocated
  • RayaNavZonesNotFound
  • 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):
        ...
        zones_list = await self.nav.get_zones_list(map_name='unity_apartment')
        self.log.info(zones_list)
        ...

See the nav_all_unity_apartment, nav_get_info to check some valid uses.


Was this article helpful?

What's Next