diff --git a/configuration/packages/bt-plugins/actions/ClearCostmapAroundPose.rst b/configuration/packages/bt-plugins/actions/ClearCostmapAroundPose.rst index f6fb638b8..78c835964 100644 --- a/configuration/packages/bt-plugins/actions/ClearCostmapAroundPose.rst +++ b/configuration/packages/bt-plugins/actions/ClearCostmapAroundPose.rst @@ -53,6 +53,18 @@ Input Ports Description Action server timeout (ms). +:plugins: + + ============== ======= + Type Default + -------------- ------- + string N/A + ============== ======= + + Description + If you provide a list, only those layers and the master costmap will be cleared (e.g., "keepout_filter,obstacle_layer"). + If you leave this empty, all clearable layers and the master costmap will be cleared. + Example ------- diff --git a/configuration/packages/bt-plugins/actions/ClearCostmapAroundRobot.rst b/configuration/packages/bt-plugins/actions/ClearCostmapAroundRobot.rst index 3254acca8..5719a2a82 100644 --- a/configuration/packages/bt-plugins/actions/ClearCostmapAroundRobot.rst +++ b/configuration/packages/bt-plugins/actions/ClearCostmapAroundRobot.rst @@ -42,6 +42,18 @@ Input Ports Description Action server timeout (ms). +:plugins: + + ============== ======= + Type Default + -------------- ------- + string N/A + ============== ======= + + Description + If you provide a list, only those layers and the master costmap will be cleared (e.g., "keepout_filter,obstacle_layer"). + If you leave this empty, all clearable layers and the master costmap will be cleared. + Example ------- diff --git a/configuration/packages/bt-plugins/actions/ClearCostmapExceptRegion.rst b/configuration/packages/bt-plugins/actions/ClearCostmapExceptRegion.rst index bc76f9752..56543416c 100644 --- a/configuration/packages/bt-plugins/actions/ClearCostmapExceptRegion.rst +++ b/configuration/packages/bt-plugins/actions/ClearCostmapExceptRegion.rst @@ -42,6 +42,18 @@ Input Ports Description Action server timeout (ms). +:plugins: + + ============== ======= + Type Default + -------------- ------- + string N/A + ============== ======= + + Description + If you provide a list, only those layers and the master costmap will be cleared (e.g., "keepout_filter,obstacle_layer"). + If you leave this empty, all clearable layers and the master costmap will be cleared. + Example ------- diff --git a/configuration/packages/bt-plugins/actions/ClearEntireCostmap.rst b/configuration/packages/bt-plugins/actions/ClearEntireCostmap.rst index f59164814..51a7d3f59 100644 --- a/configuration/packages/bt-plugins/actions/ClearEntireCostmap.rst +++ b/configuration/packages/bt-plugins/actions/ClearEntireCostmap.rst @@ -31,6 +31,18 @@ Input Ports Description Action server timeout (ms). +:plugins: + + ============== ======= + Type Default + -------------- ------- + string N/A + ============== ======= + + Description + If you provide a list, only those layers and the master costmap will be cleared (e.g., "keepout_filter,obstacle_layer"). + If you leave this empty, all clearable layers and the master costmap will be cleared. + Example -------