FinishCommand

Kategorie: Objekte / Commands
Ab Engineversion: 4.9.5.0 CE

Beschreibung

Beendet ein Kommado in der Kommandoliste eines Objekts.

Syntax

bool FinishCommand (object pObj, bool fSuccess, int iCommandNum);

Parameter

pObj:
Objekt, dessen Kommando beendet wird.
fSuccess:
Ob das Kommando als erfolgreich gewertet werden soll.
iCommandNum:
[opt] Index des Kommandos. 0 für das aktuelle, 1 für das als nächstes auszuführende usw.

Beispiel

public func Production(object clonk)
{
  // Baum suchen
  var pTree;
  if (!(pTree = FindWorkTree(clonk)))
  // Kein geeigneter Baum (fertig)
  {
	Message("$TxtNomoresuitabletrees$",this());
	FinishCommand(clonk, 0, 1);
	return(0);
  }
[...]
}
Auszug aus dem Sägewerk-Script. Finishcommand wird benutzt, um nachfolgende Kommandos darüber zu informieren, dass die automatische Holzproduktion fehlgeschlagen ist. Produktion() wurde dabei durch ein Call-Kommando aufgerufen, welches immer erfolgreich ist, wenn es die Funktion aufrufen kann. Deshalb muss FinishCommand verwendet werden.
Siehe auch: AddCommand, AppendCommand, GetCommand, PlayerObjectCommand, SetCommand
Günther, April 2004