AddEffect

Kategorie: Effekte
Ab Engineversion: 4.9.5.0 CE

Beschreibung

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

Syntax

int AddEffect (string szEffectName, object pTarget, int iPrio, int iTimerIntervall, object pCmdTarget, id  idCmdTarget, any var1, any var2, any var3, any var4);

Parameter

szEffectName:
Name des Effektes ohne vorangestelltes Fx.
pTarget:
[opt] Zielobjekt für den Effekt. Bei 0 wird der Effekt global erzeugt.
iPrio:
Priorität für den Effekt. Achtung: Die Priorität darf nicht 0 sein; ansonsten wird der Effekt nicht erzeugt!
iTimerIntervall:
[opt] Intervall, in dem Timer-Aufrufe getätigt werden. Bei 0 werden keine Timer-Aufrufe durchgeführt, und der Effekt bleibt permanent bis er durch anderwertige Aufrufe entfernt wird.
pCmdTarget:
[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 ChangeEffect ihre Funktionen neu zuweisen lassen.
idCmdTarget:
[opt] Definition, in der bei nicht angegebenem Befehlsziel-Objekt Callbacks ausgeführt werden. Sind sowohl pCmdTarget als auch idCmdTarget 0, 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: ChangeEffect, CheckEffect, EffectCall, EffectVar, Effekte-Dokumentation, GetEffect, GetEffectCount, RemoveEffect
Sven2, März 2004