RemoveEffect

Kategorie: Effekte
Ab Engineversion: 4.9.5.0 CE

Beschreibung

Löscht einen Effekt

Syntax

bool RemoveEffect (string szEffectName, object pTarget, int iIndex, bool fDoNoCalls, int iNewTimer);

Parameter

szEffectName:
[opt] Name des Effektes ohne vorangestelltes Fx. Es können '*' und '?' als Suchmaske verwendet werden.
pTarget:
[opt] Zielobjekt, in dem ein Effekt gelöscht werden sollen. Bei 0 wird die globale Effektliste durchsucht.
iIndex:
[opt] Effektindex. Bei angegebenem szEffectName gibt dies bei mehreren, der Suchmaske entsprechenden Effekten den indizierten Effekt in der Liste der passenden Effekte an. Ist szEffectName nicht angegeben, wird dagegen der Effekt mit der entsprechenden Effektnummer geändert. Im Gegensatz zu Effektnummern ist bei Indizes stets sichergestellt, dass beim Hochzählen von 0 bis zur Effektzahl alle Effekte erfasst werden.
fDoNoCalls:
[opt] Wenn ungleich 0, werden keine Stop-Aufrufe durchgeführt.
iNewTimer:
[opt] Neues Timer-Intervall. Bei -1 wird der alte Wert beibehalten; ansonsten wird bei diesem Aufruf auch die Effektzeit zurückgesetzt.

Anmerkung

Beispiel siehe GetEffect. Achtung: Wenn sich ein Effekt mit dieser Funktion selbst löschen soll, wird nur pTarget und iIndex angegeben, nicht szEffectName!
Siehe auch: AddEffect, ChangeEffect, CheckEffect, EffectCall, EffectVar, Effekte-Dokumentation, GetEffect, GetEffectCount
Sven2, März 2004