<RetVar/IF><RefObj> install<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

Locked
mark_a_condren
Posts: 1385
Joined: Wed, 3. Aug 05, 05:05
x3tc

<RetVar/IF><RefObj> install<Var/Number> units of <Var/Ware>

Post by mark_a_condren » Wed, 8. Dec 10, 15:30

[skip|else] if [not]|while [not]| <RetVar/IF> = <RefObj> install <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> = If the command is to 'return' information. If a variable is used, This command will return TRUE on success, FALSE on failure.
<RefObj> = The 'Object' that the command is to be run on. 'Valid' objects can be a 'Ship or Station'.
<Var/Number> = The quantity of the ware to be installed as an integer.
<Var/Ware> = The ware that is to be installed.


Installs the specified units of <Var/Ware> onto the <RefObj> as long as there is enough room to hold it. Wares are not loaded into the cargo hold, but rather installed onto the <RefObj>.
This command is primarily used for the installation of shields, lasers, engine tunnings, rudder optimisations and cargo bay extensions among other things.


Example:

= $ship -> install 1 units of 5MJ Shield

This will install 1 unit of 5MJ Shield to the specified ship $ship
By using the = (No return value) a variable is not set and there is no way to determine if the command was successful or not. This must be then dertermined via an alternative method if required.


Command Location:

User avatar
X2-Illuminatus
Moderator (Deutsch)
Moderator (Deutsch)
Posts: 21611
Joined: Sun, 2. Apr 06, 16:38
x4

[TiP][49] 292831

Post by X2-Illuminatus » Fri, 17. Dec 10, 13:16

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


[skip|else] if [not]|while [not]| = Die möglichen bedingten Anweisungen, die mit diesem Befehl genutzt werden können.
<RetVar/IF> = Wird benötigt, wenn der Befehl eine Information zurückgeben soll. Wenn eine Varaible genutzt wird, wird dieser Befehl im Erfolgsfall TRUE (wahr), im Fehlerfall FALSE (falsch) zurückgeben.
<RefObj> = Das Objekt, auf dem der Befehl ausgeführt werden soll. Zulässige Objekte sind Schiffe oder Stationen.
<Var/Number> = Die Anzahl der zu installierenden Ware als ganze Zahl.
<Var/Ware> = Die Ware, die installiert werden soll.


Installiert die gewählten Einheiten von <Var/Ware> auf dem <RefObj>, solange genügend Platz vorhanden ist. Waren werden nicht in den Frachtraum geladen, sondern im <RefObj> installiert.
Dieser Befehl wird hauptsächlich für die Installation von Schilden, Lasern, Triebwerkstunnings, Ruder-Optimierung und Laderaumerweiterungen genutzt.


Beispiel:

= $ship -> install 1 units of 5MJ Schild

Dies wird einen 5MJ Schild in das gewählte Schiff $ship installieren.
Indem man = (kein Rückgabewert) nutzt, wird keine Variable gesetzt und es gibt keine Möglichkeit herauszufinden, ob der Befehl erfolgreich war oder nicht. Dies müsste dann auf andere Weise ermittelt werden, falls die Information benötigt wird.


Zu finden unter:

Locked

Return to “MSCI Reference”