@ [skip|else] if [not]|while [not]| = The possible 'Conditional' statements that can be used with this command.
<RetVar/IF> = If the command is to 'return' information it will store the information here.
<RefObj> = The ship you wish to send to the position.
<Var/Number> = The location on the 'X' axis.
<Var/Number> = The location on the 'Y' axis.
<Var/Number> = The location on the 'Z' axis.
<Var/Number> = The precision you wish to be inforced by this command.
Causes a ship to move to within 'precision <Var/Number>' metres of the specified position.
The position coordinates are in metres from the centre of a sector's trade grid. It is advisable to be more liberal with the precision as the size of the ship increases, especially if the position might be around other objects.
This command will only move a ship around in its current sector. It can not be used to move a ship to a position in a different sector. The ship would have to be moved by other means if a sector change is required.
Unlike the escort ship and follow object instructions, this one can be overridden by a "fly command" instruction in another process. However, like the escort ship and follow object instructions, if this is done then the move to position instruction will never return - it does not return a FLRET_BREAK in that circumstance.
Returns;
FLRET_NOCOMMAND when <RefObj> reaches its destination coordinates.
FLRET_INTERRUPTED if the script executing this instruction is interrupted.
FLRET_INVALIDPARMS if <RefObj> is invalid.
Example:
@ = $ship -> move to position: x= 500 y= 1000 z= 1500 with precision 2000 m
The $ship will move to within 2000 meters of the set position.
Due to the '=' the script sending this command to the $ship will wait until the ship reaches the set position before continuing.
Command Location:
- »» Fly Commands
<RetVar/IF><RefObj> move to position x = <Var/Number> y = <Var/Number> z = <Var/Number> with precision <Var/Number> m