Snippet TimedLeaks

[TriggerHappy]

Introduction

This is a simple script that will remove leaks after a certain period of time.

Requires

• TimerUtils (also included in the demo map)
• JassHelper (included with JassNewGen Pack)

Usage

Simply remove a leak as your normally would, except add the Timed suffix to it.

RemoveLocationTimed,DestroyGroupTimed,DestroyEffectTimed


ect..

Script

//*********************************************************************
//* Timed Leaks
//* ----------
//* 
//* ClanMapz.com / wc3c.net / thehelper.net
//*
//* Implementaion
//*     Simply copy the TimerUtils and TimedLeaks triggers into your map
//*
//* Requirements
//*     This requires JassHelper vJASS Preprocessor and TimerUtils
//********************************************************************
library TimedLeaks requires TimerUtils

    private struct data
        location l
        group g
        effect e
        force f
        lightning light
        texttag text
        timer time
        boolexpr b
        weathereffect w
        
        timer timer
        real timeout
        
        static method remove takes nothing returns nothing
            local data index = GetTimerData(GetExpiredTimer())
            
            
            call RemoveLocation(index.l)
            call DestroyGroup(index.g)
            call DestroyEffect(index.e)
            call DestroyForce(index.f)
            call DestroyLightning(index.light)
            call DestroyTextTag(index.text)
            call DestroyTimer(index.time)
            call DestroyBoolExpr(index.b)
            call RemoveWeatherEffect(index.w)
            
            call ReleaseTimer(index.timer)
            
            call index.destroy()
        endmethod
        
        //! textmacro TimedLeaks takes LEAKS
        static method create takes $LEAKS$ real t returns data
            local data d = data.allocate()
            
            set d.l = l
            set d.g = g
            set d.e = e
            set d.f = f
            set d.light = light
            set d.text = text
            set d.time = time
            set d.b = b
            set d.w = w
            
            set d.timer = NewTimer()
            call SetTimerData(d.timer, d)
            call TimerStart(d.timer, t, false, function data.remove)
            
            return d
        endmethod
        //! endtextmacro
        //! runtextmacro TimedLeaks("location l, group g, effect e, force f, lightning light, texttag text, timer time, boolexpr b, weathereffect w,")
        
    endstruct
    
    function RemoveLocationTimed takes location loc, real timeout returns nothing
        local data d = data.create(loc, null,null,null,null,null,null,null,null,timeout)
    endfunction
  
    function DestroyGroupTimed takes group g, real timeout returns nothing
        local data d = data.create(null,g,null,null,null,null,null,null,null,timeout)
    endfunction
    
    function DestroyEffectTimed takes effect e, real timeout returns nothing
        local data d = data.create(null,null,e,null,null,null,null,null,null,timeout)
    endfunction
    
    function DestroyForceTimed takes force f, real timeout returns nothing
        local data d = data.create(null,null,null,f,null,null,null,null,null,timeout)
    endfunction
    
    function DestroyLightningTimed takes lightning l, real timeout returns nothing
        local data d = data.create(null,null,null,null,l,null,null,null,null,timeout)
    endfunction
    
    function DestroyTextTagTimed takes lightning l, real timeout returns nothing
        local data d = data.create(null,null,null,null,l,null,null,null,null,timeout)
    endfunction
    
    function DestroyTimerTimed takes timer t, real timeout returns nothing
        local data d = data.create(null,null,null,null,null,null,t,null,null,timeout)
    endfunction
    
    function DestroyBoolExprTimed takes boolexpr b, real timeout returns nothing
        local data d = data.create(null,null,null,null,null,null,null,b,null,timeout)
    endfunction
    
    function RemoveWeatherEffectTimed takes weathereffect w, real timeout returns nothing
        local data d = data.create(null,null,null,null,null,null,null,null,w,timeout)
    endfunction
    
endlibrary

Side notes

I haven't added in everything that leaks, only the most used things that leak, Though I probably missed a few popular ones.

I have also never used TimerUtils before so, correct anything wrong with it's usage.

 

[Romek]

This is pretty useless.
I don't know how often someone would want to do:

call RemoveLocationTimed(loc, bj_PI)

The only 3 handles this'd be useful for is effect, lightning, and weathereffect.

Also, the name makes it sound as though you create leaks periodically.

> local data d = data.create...
call data.create...
No idea why you're storing it into a variable there.

> local integer index...
Congratulations on discovering typecasting, but it'd be simpler to make that, "local data index" so you don't need to keep typecasting.

Also, if the user is going to import TimerUtils, they might as well use it directly to make their own simple, efficient destroytimed function.

 

[TriggerHappy]

This is pretty useless.
I don't know how often someone would want to do:

call RemoveLocationTimed(loc, bj_PI)

The only 3 handles this'd be useful for is effect, lightning, and weathereffect.

Also, the name makes it sound as though you create leaks periodically.

> local data d = data.create...
call data.create...
No idea why you're storing it into a variable there.

> local integer index...
Congratulations on discovering typecasting, but it'd be simpler to make that, "local data index" so you don't need to keep typecasting.

Also, if the user is going to import TimerUtils, they might as well use it directly to make their own simple, efficient destroytimed function.

Check the script again....

 

[Romek]

Congratulations on discovering what a Textmacro is, but making a textmacro and using it once is pretty useless.

Updating the code doesn't make this any more useful by the way.

 

[TriggerHappy]

Congratulations on discovering what a Textmacro is, but making a textmacro and using it once is pretty useless.

Updating the code doesn't make this any more useful by the way.

It's just a cleaner look...

You yourself even said that 3 (?) of the functions were useful, someone can find uses for the others.

 

[Romek]

> It's just a cleaner look...
No it's not...

> You yourself even said that 3 (?) of the functions were useful, someone can find uses for the others.
"Also, if the user is going to import TimerUtils, they might as well use it directly to make their own simple, efficient destroytimed function."

 

[TriggerHappy]

> It's just a cleaner look...
No it's not...

> You yourself even said that 3 (?) of the functions were useful, someone can find uses for the others.
"Also, if the user is going to import TimerUtils, they might as well use it directly to make their own simple, efficient destroytimed function."

Then whats the point of scripts?

Of course everyone can do it themselves...but why make it hard on yourself.

 

[Flare]

As Romek said, the name... for everyone's sake, it'd be a fantastic idea to find a new name. When I first saw the thread, I immediately thought "WTF, why would I want to create leaks after a period of time, that's just stupid >_>"

timer timer

Should you really be using type names as variable names? I'm beginning to think you didn't even do a syntax check before submitting (would be highly unusual if syntax check didn't spot that...)

Also, bar lightning and effect as Romek already said (I never use weathereffects so I won't say anything about them), it's of limited use. Everything else should be removed the moment they are no longer needed, not after a pre-designated time period. If your spell/system has an unknown or variable duration/length of active time, the destruction of groups, locations, timers and such is bound to fail at some point

Also, you've got alot of double-frees, why not

if d.typeName != null then
  call DestroyType (d.typeName)
endif

As regards your textmacro, what you have it fairly pointless. How does that make it any cleaner? You've still got a long string of arguments in the //!runtextmacro - IMO, would be far smarter to have

//!textmacro LeakFunction takes FUNCNAME, TYPE, STRUCTVAR
function $FUNCNAME$Timed takes $TYPE$ x, real time returns nothing
  local data d = data.create ()
  set d.$STRUCTVAR$ = x
//and start timer, all that stuff
endfunction
//!endtextmacro

//and run the macro for each type you need

rather than declaring a macro for the sake of using it once

 

[Romek]

> Of course everyone can do it themselves...but why make it hard on yourself.
Because you can make a timed destroy function in about 5 lines...
And this is just inefficient and ugly code...

 

[TriggerHappy]

Should you really be using type names as variable names?

It's a struct variable... so it gets renamed...

I will edit this post later.

 

[Darthfett]

        static method remove takes nothing returns nothing
            local data index = GetTimerData(GetExpiredTimer())
            
            
            call RemoveLocation(index.l)
            call DestroyGroup(index.g)
            call DestroyEffect(index.e)
            call DestroyForce(index.f)
            call DestroyLightning(index.light)
            call DestroyTextTag(index.text)
            call DestroyTimer(index.time)
            call DestroyBoolExpr(index.b)
            call RemoveWeatherEffect(index.w)
            
            call ReleaseTimer(index.timer)
            
            call index.destroy()
        endmethod

function ...
        local data d = data.create(null,g,null,null,null,null,null,null,null,timeout)
    endfunction

I also don't think too many people are going to be happy with a system that tries to destroy 8 null handles every time, when it only needs to destroy one. With Grimoire, you have to check to make sure a handle is null before destroying it, otherwise you get an error message. This makes it terrible if you're trying to debug anything.