delete_location()
  • 1 Minute to read

delete_location()


Article summary

delete_location()

Permanently deletes a saved location.

Reference

Arguments

ArgumentsTypeDefault value
map_namestrThe requested map. If map_name is empty the current map will assumed.
location_namestrThe requested name of the location on the map.

Return

True if the whole function finished with no errors and the location was deleted.

Exceptions

  • RayaNavNotLocated
  • RayaNavLocationNotFound
  • RayaNavUnkownError

See the complete list of navigation exceptions.

Usage Example

Code:

class RayaApplication(RayaApplicationBase):

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

    async def loop(self):
        await self.navigation.delete_location( 
                    location_name='new_location01', 
                    map_name='unity_apartment'
                )
        self.log.info(f'Location deleted')
        ...

    async def finish(self):
         ...

See the nav_all_unity_apartment, nav_get_info to check some valid uses.


Was this article helpful?

What's Next