Move raid system to globalevents

[ranisalt]

This effectively nukes the raid system in favor of global events, which permit better management for raids. It's easier to define raids on interval, on exact times, force execution, force scheduling, add monsters on different delays and randomized amounts and positions... and also gets rid of a command.

I added a lib with helper functions to add monsters to a raid. The event is called onRaid and there is an example bundled pretty equivalent to the previous XML raid example. keep reading

[PrinterLUA]

Great job, but is it even necessary to have a seprate event for raid? We could just use onThink or onTime. If they wish and just create a raid library in lua.

It should be possible?

[ranisalt]

onRaid falls between onTime and onInterval here, it works as both. Yes it is possible to completely ditch onRaid and use just those two.

[TheSumm]

testraid.lua should use Position() constructor instead of the table constructor with x,y,z-fields.
I think it would be cleaner if you could pass the amount of creatures to the addSpawn function.

[ranisalt]

True that, I will fix it to use the Position constructor later.

I will also patch the addSpawn function to allow another parameter, but I see it as removing clutter from the raid (explicit) to move to a lib function (implicit).

[EvilHero90]

actually this entire thing should be handled completly in lua by coroutines and a simple addEvent timer at startup, could get rid of all c code then and we wouldn't hit server performence.

[ranisalt]

@EvilHero90 I agree with handling completely on Lua, but I couldn't figure how to use coroutines. Could you give me sample code for how you see raids?

[EvilHero90]

I can do that on monday, I'm busy with work the entire weekend

[conde2]

Missing monster name ?

[ranisalt]

Yes, my eyes failed me. Fixed

[ranisalt]

This PR is (almost) on it's final form. I added a generic interface to search and force execute global events. I couldn't find an use to force execute startup, shutdown or record events, so they are ignored.

Also, it means it's possible to force trigger a server save on the Lua side.

Edit: actually I'll just reuse the previous Game.startRaid function, just renamed to Game.startEvent.

[wgrr]

@ranisalt since seems he doesn't got time yet i made an example with coroutines.

addEvent(checkRaids, 15000)
local inProgress = false
function ratPlague()
    local pos = Position(146, 388, 7)
    broadcastMessage("Rat plague in city!", MESSAGE_STATUS_WARNING)
    Game.createMonster("Rat", pos)
    coroutine.yield()
    inProgress = false
end

function checkRaids()
    print(coroutine.status(start))
    if not inProgress then
        if math.random(1, 1) == 1 then
            inProgress = true
            coroutine.resume(start)
        end
    end
    addEvent(checkRaids, 15000)
end

start = coroutine.create(ratPlague)

to make this a real raid system with coroutines would needed a lib as big as npcs is, i personally don't know performence impact with this tho, in my opinion coroutines are just a complicated way to call functions.

[ranisalt]

If that is, I don't know how much better this is than addEvent.

[wgrr]

i don't see the point also, if is needed to call a addEvent it becomes a complicated way to call functions, tho im curious to see how he would do that.

[ranisalt]

Rebased against master.

[ranisalt]

I still intend to keep it up to date and merge when possible. This alone shaves 20 seconds off the build time 😄 besides -800 line delta.

[WibbenZ]

Only thing I can think you should "add" is a converter XML -> Lua
Maybe this should wait for the next stable release, but looks good to me 👍

[ranisalt]

@WibbenZ working on it! Check the new stuff under tools/ 😄

[ghost]

let's go?!

[ranisalt]

@MillhioreBT your change request is blocking this PR

[ramon-bernardo]

Ready to merge, right?

[omarcopires]

Ready to merge, right?

This should have been added years ago, we really need this! 🥹

[ranisalt]

I can't believe what my eyes are looking at

[ramon-bernardo]

2023/12/12, a milestone! OMG 🎉 🎉 🎉