CheckEffect

Kategorie: Effekte
Ab Engineversion: 1.0 OC

Beschreibung

Führt Fx*Effect (und ggf. auch Fx*Add)-Callbacks in der entsprechenden Effektliste aus, ohne einen Effekt selber zu erstellen. Rückgabewert ist -1, wenn ein anderer Effekt den Effekt abgelehnt hat, und die Effektnummer des aufnehmenden Effektes, wenn der Effekt aufgenommen wurde.

Syntax

int CheckEffect(string name, object target, int priority, int timer, any var1, any var2, any var3, any var4);

Parameter

name:: Name des Effektes ohne vorangestelltes Fx.
target:: [opt] Zielobjekt, dessen Effekte benachrichtigt werden. Bei nil wird die globale Effektliste benachrichtigt.
priority:: [opt] Priorität für den Effekt. Es werden Fx*Effect-Callbacks bei allen Effekten mit gleicher und höherer Priorität durchgeführt. Wenn nicht angegeben oder bei 0 werden daher alle Effekte benachrichtigt.
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.
var1:: [opt] Erster Zusatzparameter, der an Effect-Callbacks übergeben wird
var2:: [opt] Zweiter Zusatzparameter, der an Fx*Effect-Callbacks übergeben wird
var3:: [opt] Dritter Zusatzparameter, der an Fx*Effect-Callbacks übergeben wird
var4:: [opt] Vierter Zusatzparameter, der an Fx*Effect-Callbacks übergeben wird

Anmerkung

Für Beispiele und weitere Hinweise siehe Effekte-Dokumentation.

Siehe auch: CreateEffect, EffectCall, Effekte-Dokumentation, GetEffect, GetEffectCount, RemoveEffect

Sven2, 2004-03