diff --git a/Docs/python_api.md b/Docs/python_api.md index 1fcdfab3f..f109e6d66 100644 --- a/Docs/python_api.md +++ b/Docs/python_api.md @@ -368,16 +368,16 @@ Returns the world object currently active in the simulation. This world will be Creates a new world with default settings using `map_name` map. All actors in the current world will be destroyed. - **Parameters:** - `map_name` (_str_) – Name of the map to be used in this world. Accepts both full paths and map names, e.g. '/Game/Carla/Maps/Town01' or 'Town01'. Remember that these paths are dynamic. -- **GetTrafficManager**(**self**, **client_connection**=8000) +- **get_trafficmanager**(**self**, **client_connection**=8000) Returns an instance of the traffic manager related to the specified port. If it does not exist, this will be created. - **Parameters:** - `client_connection` (_int_) – Port that will be used by the traffic manager. Default is `8000`. - **Return:** _[carla.TrafficManager](#carla.TrafficManager)_ - **reload_world**(**self**) -Deletes the current world and creates a new one using the same map and default settings. Every actor in the previous world will be destroyed. +Reload the current world, note that a new world is created with default settings using the same map. All actors present in the world will be destroyed, __but__ traffic manager instances will stay alive. - **Raises:** RuntimeError when corresponding. - **replay_file**(**self**, **name**, **start**, **duration**, **follow_id**) -The server will start running the simulation `name` previously recorded. The time to start and stop can be stated and if the recreation finishes, the vehicles will continue their behaviour as usual, managed by the server. During the simulation we can follow a specific actor using its ID. +Load a new world with default settings using `map_name` map. All actors present in the current world will be destroyed, __but__ traffic manager instances will stay alive. - **Parameters:** - `name` (_str_) – Name of the file containing the information of the simulation. - `start` (_float_) – Time in seconds where to start playing the simulation. Negative is read as beginning from the end, being -10 just 10 seconds before the recording finished. diff --git a/PythonAPI/docs/client.yml b/PythonAPI/docs/client.yml index 79aab25c1..481098ec4 100644 --- a/PythonAPI/docs/client.yml +++ b/PythonAPI/docs/client.yml @@ -110,7 +110,7 @@ doc: > Creates a new world with default settings using `map_name` map. All actors in the current world will be destroyed. # -------------------------------------- - - def_name: GetTrafficManager + - def_name: get_trafficmanager params: - param_name: client_connection type: int @@ -125,8 +125,9 @@ params: raises: RuntimeError when corresponding. doc: > - Deletes the current world and creates a new one using the same map and default settings. Every actor in the previous world will be - destroyed. + Reload the current world, note that a new world is created with default + settings using the same map. All actors present in the world will be + destroyed, __but__ traffic manager instances will stay alive. # -------------------------------------- - def_name: replay_file params: @@ -147,7 +148,8 @@ doc: > ID of the actor to follow. If this is 0 then camera is disabled. doc: > - The server will start running the simulation `name` previously recorded. The time to start and stop can be stated and if the recreation finishes, the vehicles will continue their behaviour as usual, managed by the server. During the simulation we can follow a specific actor using its ID. + Load a new world with default settings using `map_name` map. All actors + present in the current world will be destroyed, __but__ traffic manager instances will stay alive. # -------------------------------------- - def_name: generate_opendrive_world params: