pyrobosim.core.world.World.add_room

World.add_room(**room_config: Any) → Room | None

Adds a room to the world.

If the room does not have a specified name, it will be given an automatic name of the form "room0", "room1", etc.

If the room has an empty footprint or would cause a collision with another entity in the world, it will not be added to the world model.

Parameters:

**room_config –

Keyword arguments describing the room.

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

Returns:

room object if successfully created, else None.