[skip|else] if [not]|while [not]| = The possible 'Conditional' statements that can be used with this command.
<RetVar/IF> = Use a variable, if the command should return information. If a variable is used, the command will return 1 on success and 0 on failure.
<RefObj> = The object you want to send the <Var/Passenger> to board. 'Valid' objects are ships.
<Var/Passenger> = The passenger, marine or astronaut you want to send to board the <RefObj>.
This command will send the as <Var/Passenger> selected person to board the as <RefObj> selected ship.
In contrast to the vanilla boarding methods the <Var/Passenger> will immediately start to board the ship. He doesn't have to fly to it or break through its hull. The target ship must be enemy to the player and boardable.
With this command it's possible to send even one marine more to a ship than the maximum number of marines that can be stored on it. The maximum number of marines you can send to board a ship with this command is the return value of the <RetVar/IF><RefObj> get number of marines can board-command.
Examples:
$target = get player tracking aim
$marines.arr = [PLAYERSHIP] -> get marines array
$marine = $marines.arr[0]
$success = $target -> add marine $marine to attack group on ship
if $success == 1
|$message = sprintf: fmt='%s was sent to board %s', $marine, $target, null, null, null
|display subtitle text: text=$message duration=5000 ms
else
|$message2 = sprintf: fmt='%s wasn't sent to board %s', $marine, $target, null, null, null
|display subtitle text: text=$message2 duration=5000 ms
end
return null
This sends a marine from the [PLAYERSHIP] to board the player's target and will display a message as subtitle, if it was possible to send the marine or not.
-----------------------------------
$target = get player tracking aim
$number = $target -> get number of marines can board
$marines.arr = [PLAYERSHIP] -> get marines array
$size.marine.arr = size of array $marines.arr
if $size.marine.arr > $number
|$counter = $number
else
|$counter = $size.marine.arr
end
while $counter
|dec $counter =
|$marine = $marines.arr[$counter]
|$success = $target -> add marine $marine to attack group on ship
end
return null
This will send the maximum number of marines to board the player's target from the [PLAYERSHIP]. The number of marines that will be sent depends on the number of marines that are stored on the [PLAYERSHIP] and on the maximum number of marines that can be used to board the target.
Note:
In the unmodified game and with the normal boarding methods it's only possible to board ships of the classes TM, TL, M1, M2, M6 and M7. With this command it's also possible to board ships of the M8 class.
Related Commands:
<RetVar/IF><RefObj> get number of marines can board
Command Location:
- »» Trade Commands
- »» Passengers
<RetVar/IF><RefObj> add marine <Var/Passenger> to attack group on ship
- »» Passengers