AddEffect (veraltet)

Kategorie: Effekte
Ab Engineversion: 1.0 OC

Beschreibung

Erzeugt einen Effekt. Rückgabewert ist der Effekt bei Erfolg, oder nil bei Fehlschlag (weil der Effekt beispielsweise abgelehnt wurde). Wenn der Effekt von einem anderen Effekt aufgenommen wurde, der sich in demselben Aufruf entfernt, wird wahrscheinlich nil zurückgegeben.

Syntax

proplist AddEffect(string name, object target, int priority, int timer, object command_target, id  command_target_id, any var1, any var2, any var3, any var4);

Parameter

name:
Name des Effektes ohne vorangestelltes Fx.
target:
[opt] Target object for the effect. If nil, Global is used, but the target parameter of the callbacks will get nil.
priority:
Priorität für den Effekt. Achtung: Die Priorität darf nicht 0 sein; ansonsten wird der Effekt nicht erzeugt!
timer:
[opt] Intervall, in dem Timer-Aufrufe getätigt werden. Bei nil werden keine Timer-Aufrufe durchgeführt, und der Effekt bleibt permanent bis er durch anderwertige Aufrufe entfernt wird.
command_target:
[opt] Befehlsziel. Wenn angegeben, werden alle Callbacks in diesem Objekt ausgeführt. Ansonsten finden diese Callbacks grundsätzlich ohne Objektkontext statt. Wenn das Befehlszielobjekt gelöscht wird, werden alle verbundenen Effekte ohne weitere Callbacks ebenfalls gelöscht. Falls das Befehlsziel seine Definition ändert, sollten verbundene Effekte mit effect.Name = effect.Name ihre Funktionen neu zuweisen lassen.
command_target_id:
[opt] Definition, in der bei nicht angegebenem Befehlsziel-Objekt Callbacks ausgeführt werden. Sind sowohl command_target als auch command_target_id nil, werden die Aufrufe global durchgeführt. Das heißt, die Fx*-Funktionen müssen als global deklariert sein, oder Enginefunktionen sein.
var1:
[opt] Erster Zusatzparameter, der an Fx*Start- und Fx*Effect-Callbacks übergeben wird
var2:
[opt] Zweiter Zusatzparameter, der an Fx*Start- und Fx*Effect-Callbacks übergeben wird
var3:
[opt] Dritter Zusatzparameter, der an Fx*Start- und Fx*Effect-Callbacks übergeben wird
var4:
[opt] Vierter Zusatzparameter, der an Fx*Start- und Fx*Effect-Callbacks übergeben wird

Anmerkung

Für Beispiele und weitere Hinweise siehe Effekte-Dokumentation.
Siehe auch: CheckEffect, CreateEffect, EffectCall, Effekte-Dokumentation, GetEffect, GetEffectCount, RemoveEffect
Sven2, 2004-03