Category: Effects
Since engine version: 1.0 OC
RemoveEffect
Description
Deletes an effect.
Syntax
bool RemoveEffect(string name, object target, proplist effect, bool no_calls);
Parameters
- name:
- [opt] Name of the effect without preceding 'Fx'. You can use '*' and '?' wildcards.
- target:
- [opt] Target object from which to remove an effect. If
nil, the global effects list will be searched. - effect:
- [opt] The effect. Instead to search by name, the effect can be directly removed if this parameter is given.
- no_calls:
- [opt] If not
false, no Stop calls will be made.
Remark
See GetEffect for an example. Warning: if an effect is meant to delete itself using this function, only use effect, not name!