Category: Effects
Since engine version: 1.0 OC
CheckEffect
Description
Makes Fx*Effect (and in cases Fx*Add) callbacks to the specified list of effects, without actually creating any effect. The return value is -1 if another effect has rejected the call. If an effect accepts the call, the return value is the effect number of that effect.
Syntax
int CheckEffect(string name, object target, int priority, int timer, any var1, any var2, any var3, any var4);
Parameters
- name:
- Name of the effect without prepended 'Fx'.
- target:
- [opt] Target object of the effects to be notified. If
nil, the global effects are notified. - priority:
- [opt] Effect priority. Calls are made to all effects of equal or higher priority. If unspecified or 0, all effects are notified.
- timer:
- [opt] Interval for the timer calls. With
nil, no timer calls are made and the effect stays on permanently until it is deleted by other calls. - var1:
- [opt] First extra parameter to be passed to the effect callback.
- var2:
- [opt] Second extra parameter to be passed to the effect callback.
- var3:
- [opt] Third extra parameter to be passed to the effect callback.
- var4:
- [opt] Fourth extra parameter to be passed to the effect callback.
Remark
For examples and more information see the effects documentation.