Snippet TimedEffects

XeNiM666 · May 25, 2009

Timed Effects

What does this do?
- This does exactly what the names states. It creates a special effect with a duration. This also creates special effects with height and scale.

Pros:
- Its easy to use
- Its very useful
- Leakless
- Lagless
- GUI friendly

Cons:
- Requires Vexorian's dummy.mdx ( attached at the bottom of post )
- Requires very little knowledge of JASS

Functions:

JASS:

//      1. AddTimedSpecialEffect                                                       //
//         - takes string modelName, real duration, real x, real y, real z             //
//         - This function creates a timed effect for the duration of choice           //
//      1. AddTimedSpecialEffectLoc                                                    //
//         - takes string modelName, real duration, location whichLoc, real z          //
//         - This function creates a timed effect for the duration of choice           //
//         - This is used for GUI. Because GUI uses locations instead of reals         //
//      1. AddTimedSpecialEffectEx                                                     //
//         - takes string modelName, real duration, real scale, real x, real y, real z //
//         - This function creates a timed effect for the duration of choice           //
//         - This one creates a special effect with a desired size                     //

The Code:

JASS:

//****************************************************************************************//
//****************************************************************************************//
//                                                                                        //
//                        TIMED EFFECTS SYSTEM                                            //
//                            by XeNiM666                                                 //
//                                                                                        //
//****************************************************************************************//
//****************************************************************************************//
//                                                                                        //
//     REQUIRES:                                                                          //
//         1. A vJASS preprocessor ( Jass NewGen Pack )                                   //
//         2. Vexorian&#039;s dummy.mdx model                                                  //
//                                                                                        //
//****************************************************************************************//
//****************************************************************************************//
//                                                                                        //
//     THIS SYSTEM HAS 3 FUNCTIONS:                                                       //
//         1. AddTimedSpecialEffect                                                       //
//            - takes string modelName, real duration, real x, real y, real z             //
//            - This function creates a timed effect for the duration of choice           //
//         1. AddTimedSpecialEffectLoc                                                    //
//            - takes string modelName, real duration, location whichLoc, real z          //
//            - This function creates a timed effect for the duration of choice           //
//            - This is used for GUI. Because GUI uses locations instead of reals         //
//         1. AddTimedSpecialEffectEx                                                     //
//            - takes string modelName, real duration, real scale, real x, real y, real z //
//            - This function creates a timed effect for the duration of choice           //
//            - This one creates a special effect with a desired size                     //
//                                                                                        //
//****************************************************************************************//
//****************************************************************************************//
//                                                                                        //
//     HOW TO IMPLEMENT:                                                                  //
//         1. Create a trigger named TE                                                   //
//         2. Convert it to custom text                                                   //
//         3. Delete the text inside                                                      //
//         4. Copy all the text here and copy it to the trigger you created               //
//         5. Copy the dummy unit in this map                                             //
//                                                                                        //
//****************************************************************************************//
//****************************************************************************************//

library TE initializer onInit

    globals
        // THE RAW CODE OF THE DUMMY UNIT USED AS EFFECTS
        // THE DUMMY MUST HAVE THE MODEL &quot;dummy.mdx&quot; BY &quot;Vexorian&quot;
        private constant integer DUMMY_EFFECT = &#039;u001&#039;
    endglobals
    
     //**************************************************************************************//
    //**************************************************************************************//
   //                DO NOT TOUCH UNLESS YOU KNOW WHAT YOU&#039;RE DOING                        //
  //**************************************************************************************//
 //**************************************************************************************//
    
    private function Destroy takes effect e, real dur returns nothing
        call TriggerSleepAction( dur )
        call DestroyEffect( e )
        set e = null
    endfunction
    
    function AddTimedSpecialEffectEx takes string modelName, real duration, real scale, real x, real y, real z returns nothing
        local unit model = CreateUnit( Player( 15 ), DUMMY_EFFECT, x, y, 270.00 )        
        local effect e = AddSpecialEffectTarget( modelName, model, &quot;origin&quot; )
        call SetUnitScale( model, scale * 0.01, scale * 0.01, scale * 0.01 )
        call UnitApplyTimedLife( model, &#039;BTLF&#039;, duration )
            
        if z != 0.00 then
            call UnitAddAbility( model, &#039;Amrf&#039; )
            call SetUnitFlyHeight( model, z, 0.00 )
            call UnitRemoveAbility( model, &#039;Amrf&#039; )
        endif
            
        set model = null
        call Destroy( e, duration )
    endfunction

    function AddTimedSpecialEffect takes string modelName, real duration, real x, real y, real z returns nothing
        local unit model = CreateUnit( Player( 15 ), DUMMY_EFFECT, x, y, 270.00 )        
        local effect e = AddSpecialEffectTarget( modelName, model, &quot;origin&quot; )
        call UnitApplyTimedLife( model, &#039;BTLF&#039;, duration )
            
        if z != 0.00 then
            call UnitAddAbility( model, &#039;Amrf&#039; )
            call SetUnitFlyHeight( model, z, 0.00 )
            call UnitRemoveAbility( model, &#039;Amrf&#039; )
        endif
            
        set model = null
        call Destroy( e, duration )
    endfunction
    
    // FOR THOSE WHO LIKE USING LOCATIONS...
    
    function AddTimedSpecialEffectLoc takes string modelName, real duration, location whichLoc, real z returns nothing
        local unit model = CreateUnit( Player( 15 ), DUMMY_EFFECT, GetLocationX( whichLoc ), GetLocationY( whichLoc ), 270.00 )        
        local effect e = AddSpecialEffectTarget( modelName, model, &quot;origin&quot; )
        call UnitApplyTimedLife( model, &#039;BTLF&#039;, duration )
            
        if z != 0.00 then
            call UnitAddAbility( model, &#039;Amrf&#039; )
            call SetUnitFlyHeight( model, z, 0.00 )
            call UnitRemoveAbility( model, &#039;Amrf&#039; )
        endif
            
        set model = null
        call Destroy( e, duration )
    endfunction
    
    private function onInit takes nothing returns nothing
        call RemoveUnit( CreateUnit( Player( 15 ), DUMMY_EFFECT, 0.00, 0.00, 0.00 ) )
    endfunction
    
endlibrary

There is a sample spell inside the map. Also please note that THE SPELL DOES NOTHING. Just shows a sample of the snippet.

Special Thanks:
- Vexorian for his dummy.mdx model
- Tinki3 for his Spell Map Template

Map:

Romek · May 25, 2009

What advantages does this have over something like this:

JASS:

function Timed...
local effect e = AddSpecialEffect...
call TriggerSleepAction(duration)
call DestroyEffect(e)
set e = null
endfunction

Both of these use TSA, just your one is much more complicated.

I hear you say effects with Z.

XeNiM666 · May 25, 2009

Well this has an advantage in GUI-ers. Since they try hard to make spells MUI and this avoid using waits. Also an advantage is using only 1 unit instead of making other dummy units with effects for models.

I hear you say effects with Z.

Just thought it would be a great feature.

Also, fast reply

EDIT:

What advantages does this have over something like this:

What if that is used for callbacks in timers?

Romek · May 25, 2009

> Also an advantage is using only 1 unit instead of making other dummy units with effects for models.
They can do that without this system.

> Just thought it would be a great feature.
It is. But this by no means needs any units whatsoever.

> What if that is used for callbacks in timers?

JASS:

function BlahdyBlah takes... .. ... 
  call MakeSomeTimedEffect.execute(...)
endfunction

TriggerHappy · May 26, 2009

This has been done many times before, and even more simple.

What makes yours better than these;

Timed Effects - by Berbanog

Timed Effects - By moyak

Timed Handles - By me

Azlier · May 26, 2009

>- Leakless
Lies. You never null 'e'.

TriggerHappy · May 26, 2009

Azlier said:
>- Leakless
Lies. You never null 'e'.

He nulls it in the destroy function.

I'm not sure if that just nulls the pointer or what.

Azlier · May 26, 2009

Nulling it in the destroy function does nothing.

Why even have the destroy function, in fact

TriggerHappy · May 26, 2009

He was probably under the impression that nulling locals passed through functions counted.

Anyways, I doubt anyone would use this over an accurate timer removal.

I mean, TSA's are off by what .30 seconds?

Jesus4Lyf · May 26, 2009

No, this is much worse than that. TSA's do horrible things.

Replace the line in the sample spell with this:

JASS:

call BJDebugMsg(&quot;Before&quot;)
call AddTimedSpecialEffect( &quot;Abilities\\Weapons\\FireBallMissile\\FireBallMissile.mdl&quot;, 0.50, x, y, 0.00 )
call BJDebugMsg(&quot;After&quot;)

"After" never displays. If you put a call AddTimedSpecialEffect( "Abilities\\Weapons\\FireBallMissile\\FireBallMissile.mdl", 0.50, 0, 0, 0.00 ) before the return true, you'll find the spell never ends. (Remember, TT internally uses conditions.)

101 reasons I ban TSA (Trigger Sleep Action).

As for the pro's:
Its easy to use - It doesn't document the situations in which it fails.
Its very useful - It can terminate threads.
Leakless - Wrong.
Lagless - This statement is no doubt relative considering how many times this has been written, so supply benchmarks or this is unfounded.
GUI friendly - This system probably causes a delay in GUI threads (a wait until the effect is removed).

My personal vote: Graveyard. <_< Sorry.

Romek · May 26, 2009

I'm shocked I didn't notice all these problems.

GY'ed.

Snippet TimedEffects

XeNiM666

I lurk for pizza

Attachments

Romek

Super Moderator

XeNiM666

I lurk for pizza

Romek

Super Moderator

TriggerHappy

...

Azlier

Old World Ghost

TriggerHappy

...

Azlier

Old World Ghost

TriggerHappy

...

Jesus4Lyf

Good Idea™

Romek

Super Moderator

Settings Notifications

Options

The Helper Discord

Members online

Share this page

Affiliates

Network Sponsors

Snippet TimedEffects

I lurk for pizza

Attachments

Super Moderator

I lurk for pizza

Super Moderator

...

Old World Ghost

...

Old World Ghost

...

Good Idea™

Super Moderator

Log in

The Helper Discord

Share this page

Affiliates

Network Sponsors