AddSpecialEffect

Parameters

modelName	string
x	real
y	real

comment

Creates the special effect in point with coordinates (x;y) using the model file with a path modelName. The altitude (Z) of the newly spawned effect is at the ground level, be it terrain, some pathable destructable or on top of water. In other words, the effect's Z coordinate does not have to be 0.

note

In older patches to create an effect with a Z-position other than zero see https://www.hiveworkshop.com/threads/function-to-create-effect-at-z.165250/#post-1561722. In 1.29.2.9231 and newer use BlzSetSpecialEffectPosition or BlzSetSpecialEffectZ.

note

To create an effect only visible to one player see https://www.hiveworkshop.com/threads/gs.300430/#post-3209073

note

An effect is only visible if its center is within draw distance and is not hidden by fog of war.

note

If effect emits light: There is a limit to how many lights can be rendered in an area at once. HD mode is unlimited since v3.0.0; before HD had a lower limit than SD.

patch

1.00

Source

common.j (raise an issue to discuss on Github or submit a PR)

return type

effect

Source code

native AddSpecialEffect             takes string modelName, real x, real y returns effect