CreateMapEffect
Places one of the game’s particle effects on the level - a fire, smoke, a candle’s flame - for every player.
Syntax
Section titled “Syntax”CreateMapEffect(effect, x, y, z [, opts])| Parameter | Type | |
|---|---|---|
effect |
string | the effect’s name in the game’s files ("WH_Particels.fires.candle", "WH_Particels.smokes.chimney"): letters, digits, _ and . |
x |
number | metres |
y |
number | metres |
z |
number | metres; below 0 = on the ground |
opts |
table | size (0.05 .. 20; 1), and CreateMapObject’s yaw, layer, group, persist, use (optional) |
Returns
Section titled “Returns”number - the effect’s id; nil and the reason (a name that is no effect’s shows nothing in the game)
Example
Section titled “Example”local fire = CreateMapEffect("WH_Particels.fires.exterior_fireplace", 1288, 1098, -1, {layer = "camp"})See also
Section titled “See also”CreateMapLight · CreateMapSound · the The server’s map group of the index