Clarify documentation of HyperjumpTo vs. InitiateHyperjumpTo

wowwows · Aug 17, 2016 · 657b9fe · 657b9fe
1 parent b9cfe0f
commit 657b9fe
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/src/LuaShip.cpp b/src/LuaShip.cpp
@@ -520,7 +520,10 @@ static int l_ship_use_ecm(lua_State *l)
 /*
  * Method: InitiateHyperjumpTo
  *
- *   Ready the ship to jump to the given system.
+ *   Ready the ship to jump to the given system. This does not perform
+ *   any check regarding hyperdrive class, range, fuel. Nor does it
+ *   respect minimum legal distance for hyperjump. For those features use
+ *   <Ship.HyperjumpTo> instead.
  *
  * > status = ship:InitiateHyperjumpTo(path, warmup, duration, checks)
  *