TFS 1.2 - Simple Magic Effects Function

[Lava Titan]

Hey there, I created this simple function, it's nothing special but I guess it may save some lines for some people

Some people may find it useless I guess, but like I said it's nothing special, it's just a simple function

How to add?

It's very simple, you can start by browsing "server\data\lib\compat\compat.lua" and add this code in last line.

function Player.sendMagicEffect(self, effect)
    self:getPosition():sendMagicEffect(effect)
    return true
end

How to use?

After you got this added in compat.lua you can use it on any Lua script you want, for example:

function onUse(player, item, fromPosition, target, toPosition, isHotkey)
    player:sendMagicEffect(CONST_ME_GIFT_WRAPS)
    return true
end

Instead of using the first one, you can always use this which is more simple and can also be used in addEvent

function sendMagicEffect(playerId, effect)
    local player = Player(playerId)
    if not player then
        return
    end
    player:getPosition():sendMagicEffect(effect)
    return true
end

After you can simply use like:

addEvent(sendMagicEffect, 1000, CONST_ME_GIFT_WRAPS)

For those who use Sublime Text 3 TFS AutoComplete, here's the code:

    {
      "trigger": "Player:sendMagicEffect",
      "contents": "${1:player}:sendMagicEffect(${2:effect})"
    },

or

    {
      "trigger": "sendMagicEffect",
      "contents": "sendMagicEffect(${1:effect})"
    },

 

[silveralol]

for me is usefull, I hate write "getPosition()"

 

[Lava Titan]

Updated first post

 

[Printer]

The addEvent function has a dangling pointer.

 

[Lava Titan]

What do you mean?

 

[Printer]

You should always check if the creature exsist, if you going to use addEvent.

Try it yourself, use the addEvent and logout before the event get executed. It will cause error.

 

[silveralol]

agree with @Printer when you try use addEvent with no existent "object" causes crash in tfs

 

[Lava Titan]

fixed I guess

 

[Ninja]

fixed I guess

Nope! The function(s) will not even execute now due to a non-existent userdata object (player is not defined anywhere, and you shouldn't use isPlayer).

When you use addEvent, pass player ID as an argument, and construct the Player userdata object inside the function, e.g:

local function sendMagicEffect(playerId, effect)
    local player = Player(playerId)
    if not player then
        return
    end

    player:getPosition():sendMagicEffect(effect)
end

 

[forgee]

fixed I guess

Now you're checking if "player" is a player, but you named the function argument "self". Also Player:isPlayer() would cause the same null pointer issue. You should pass the creature id and not the object.

Screw it, @Ninja was quicker.

 

[Call Me Taffy]

Screw it, @Ninja was quicker.

You don't say?

 

[Summ]

This is quite useful.

However with Position.sendMagicEffect you can actually use addEvent safely by retrieving the position and passing it as the argument.

local position = player:getPosition()
addEvent(Position.sendMagicEffect, 1000, position, CONST_ME_MAGIC_RED)