CheckEffect

Kategorie: Effekte
Ab Engineversion: 4.9.5.0 CE

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 szEffectName, object pTarget, int iPrio, int iTimerIntervall, any var1, any var2, any var3, any var4);

Parameter

szEffectName:
Name des Effektes ohne vorangestelltes Fx.
pTarget:
[opt] Zielobjekt, dessen Effekte benachrichtigt werden. Bei 0 wird die globale Effektliste benachrichtigt.
iPrio:
[opt] Priorität für den Effekt. Es werden Fx*Effect-Callbacks bei allen Effekten mit gleicher und höherer Priorität durchgeführt. Bei 0 werden alle Effekte benachrichtigt.
iTimerIntervall:
[opt] Intervall, in dem Timer-Aufrufe getätigt würden. Bei 0 würden keine Timer-Aufrufe durchgeführt, und der Effekt bliebe permanent bis er durch anderwertige Aufrufe entfernt würde.
var1:
[opt] Erster Zusatzparameter, der an Fx*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: AddEffect, ChangeEffect, EffectCall, EffectVar, Effekte-Dokumentation, GetEffect, GetEffectCount, RemoveEffect
Sven2, März 2004