summaryrefslogtreecommitdiff
path: root/src/script/api
diff options
context:
space:
mode:
authorSamu <dj_samu@hotmail.com>2019-02-19 14:15:17 +0000
committerNiels Martin Hansen <nielsm@indvikleren.dk>2019-02-19 15:25:53 +0100
commitba55f93f4159e9b8f47aaab1d7f322033f4bb9cc (patch)
tree756fed48e2d7942701201abe51c63d67051b72ee /src/script/api
parentc4fe46a475d141938b75784044e2e6e2ec634d72 (diff)
downloadopenttd-ba55f93f4159e9b8f47aaab1d7f322033f4bb9cc.tar.xz
Doc: [AI] UnshareOrders empties the orders list of the vehicle.
Diffstat (limited to 'src/script/api')
-rw-r--r--src/script/api/script_order.hpp1
1 files changed, 1 insertions, 0 deletions
diff --git a/src/script/api/script_order.hpp b/src/script/api/script_order.hpp
index a4f945511..916147886 100644
--- a/src/script/api/script_order.hpp
+++ b/src/script/api/script_order.hpp
@@ -578,6 +578,7 @@ public:
/**
* Removes the given vehicle from a shared orders list.
+ * After unsharing orders, the orders list of the vehicle is empty.
* @param vehicle_id The vehicle to remove from the shared order list.
* @pre ScriptVehicle::IsValidVehicle(vehicle_id).
* @return True if and only if the unsharing succeeded.