CheckEffect

Category: Effects
Since engine version: 4.9.5.0 CE

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

Parameters

szEffectName:: Name of the effect without prepended 'Fx'.
pTarget:: [optional] Target object of the effects to be notified. If 0, the global effects are notified.
iPrio:: [optional] Effect priority. Calls are made to all effects of equal or higher priority. With 0, all effects are notified.
iTimerIntervall:: [optional] Interval for the timer calls. With 0, no timer calls are made and the effect stays on permanently until it is deleted by other calls.
var1:: [optional] First extra parameter to be passed to the effect callback
var2:: [optional] Second extra parameter to be passed to the effect callback
var3:: [optional] Third extra parameter to be passed to the effect callback
var4:: [optional] Fourth extra parameter to be passed to the effect callback

Remark

For examples and more information see the effects documentation.

Sven2, March 2004

Clonk Developer Mode Documentation
Introduction
Contents
Search
Engine
Command Line
Game Data
Script