pyrobosim.core.world.World.add_location

World.add_location(show: bool = True, **location_config: Any) → Location | None

Adds a location at the specified parent entity, usually a room.

If the location does not have a specified name, it will be given an automatic name using its category, e.g., "table0".

Parameters:

  • show – If True (default), causes the GUI to be updated. This is mostly for internal usage to speed up reloading.

  • **location_config –

    Keyword arguments describing the location.

    You can use location=Location(...) to directly pass in a pyrobosim.core.location.Location object, or alternatively use the same keyword arguments you would use to create a Location object.

    You can also pass in the room name as the parent argument, and it will be resolved to an actual room object, if it exists in the world.

Returns:

Location object if successfully created, else None.