GetEffect

Kategorie: Effekte
Ab Engineversion: 1.0 OC

Beschreibung

Gibt einen bestimmten Effekt zurück. Wurde der Effekt nicht gefunden, wird nil zurückgegeben.

Syntax

any GetEffect(string name, object target, int index, int max_priority);

Parameter

name:
[opt] Name des Effektes ohne vorangestelltes Fx. Es können '*' und '?' als Suchmaske verwendet werden.
target:
[opt] Zielobjekt, in dem Effekte abgefragt werden sollen. Bei nil wird die globale Effektliste durchsucht.
index:
[opt] Effektindex. Bei angegebenem name gibt dies bei mehreren, der Suchmaske entsprechenden Effekten den indizierten Effekt in der Liste der passenden Effekte an.
max_priority:
[opt] Wenn ungleich 0, werden nur Effekte zurückgegeben, die höchstens die angegebene Priorität haben.

Beispiel

var i, effect;
// Search all objects
for (var obj in FindObjects(Find_And()))
{
  // Count down from the effect count because effects are being removed
  i = GetEffectCount(0, obj);
  while (i--)
    if (effect = GetEffect("*Spell", obj, i))
      RemoveEffect(0, obj, effect);
}
// remove global effects
i = GetEffectCount();
while (i--)
  if (effect = GetEffect("*Spell", nil, i))
    RemoveEffect(0, nil, effect);
Entfernt alle Zaubereffekte von allen Objekten und global.
Siehe auch: CheckEffect, CreateEffect, EffectCall, Effekte-Dokumentation, GetEffectCount, RemoveEffect
Sven2, 2004-03