[WIP] <RetVar/IF><RefObj> unload <Var/Number> units of <Var/Ware>

This forum serves as MSCI Reference at EGOSOFT. It's Read-Only for non MSCI Group members.

Moderators: Scripting / Modding Moderators, MSCI Moderators

User avatar
s9ilent
Posts: 2033
Joined: Wed, 29. Jun 05, 01:45
x4

[WIP] <RetVar/IF><RefObj> unload <Var/Number> units of <Var/Ware>

Post by s9ilent » Fri, 5. Nov 10, 12:14

@ [START|[skip|else] if [not]|while [not]| <RetVar> = <RefObj> unload <Var/Number> units of <Var/Ware>

@ [START|[skip|else] if [not]|while [not]| <RetVar> = (Integer) Returns the actual number of goods unloaded. It will only fail conditional operators when the resulting number of units unloaded is 0
<RefObj> = (Ship) The ship unloading the goods
<Var/Number> = (Integer) The number of goods to try and unloaded
<Var/Ware> = (WareType) The ware to be unloaded


Orders the <RefObj> ship to try and unloaded up to and including <Var/Number> of <Var/Ware>. If for what ever reason, it can not unload the full amount (or any) wares, it will try to unload as many as it can. The <RetVar> will return the exact number unloaded. There are no credits exchanged in this process.


This command is to transfer goods between a docked ship and it's carrier, or a docked ship and a station (of the same owner).


This command is bound by the same rules as unloading manually:
  • Dock must have enough free cargo volume
    Dock must have enough free space
    Ship must have ware on board
Unknown Outcomes:
  • Running the commands on a ship, docked at a difference races station

Related Links Trade Commands
  • For Ships
Last edited by s9ilent on Sat, 6. Nov 10, 23:00, edited 4 times in total.

mark_a_condren
Posts: 1468
Joined: Wed, 3. Aug 05, 05:05
x3tc

Re: [WIP] <RetVar/IF><RefObj> unload <Var/Number> units of <Var/Ware>

Post by mark_a_condren » Fri, 5. Nov 10, 15:38

[skip|else] if [not]|while [not]| <RetVar> = <RefObj> unload <Var/Number> units of <Var/Ware>


[skip|else] if [not]|while [not]| = The possible 'Conditional' statements that can be used with this command.
<RetVar/IF> = (Integer) Returns the actual number of goods unloaded. It will only fail conditional operators when the resulting number of units unloaded is 0.
<RefObj> = (Ship) The ship unloading the goods.
<Var/Number> = (Integer) The number of goods to try and unloaded.
<Var/Ware> = (WareType) The ware to be unloaded.


Orders the <RefObj> ship to try and unloaded up to and including <Var/Number> of <Var/Ware> . If for what ever reason, it can not unload the full amount (or any) wares, it will try to unload as many as it can. The <RetVar/IF> will return the exact number unloaded. There are no credits exchanged in this process.


This command is to transfer goods between a docked ship and it's carrier, or a docked ship and a station (of the same owner).


This command is bound by the same rules as unloading manually:
  • Dock must have enough free cargo volume
    Dock must have enough free space

Unknown Outcomes:
  • Running the commands on a ship, docked at a difference races station

Related Links
Command Location:
  • »»Trade Commands
    • »»For Ships
      <RetVar/IF><RefObj> unload <Var/Number> units of <Var/Ware>

Return to “MSCI Reference”