Simple Timed SFX System v1.3 [GUI]

[Moderator]

12th Dec 2015
IcemanBo: Too long as NeedsFix. Rejected.

12:28, 17th Jul 2012
Magtheridon96: I see what you did there.
The dummy unit method is still not a good idea. :/
Timers bro, timers. <;

 

[KnnO]

Nice, simple and useful system.

local effect udg_SFX ?
local and udg (user-defined global) ?

Suggestions:

• Make the functions' prefix letter uppercased: (sfxGround -> SfxGround)
• Or even make the name EffectGround (because it comes in mind first to users)
• Make alternate function names such as:
  

  function SpecialEffectGround takes nothing returns nothing
  call sfxGround()
  endfunction
  
  function EffectGround takes nothing returns nothing
  call sfxGround()
  endfunction

 

[defskull]

Nice, simple and useful system.

Thanks

local and udg (user-defined global) ?

Yes, you can turn a global variable into local variable
Actually, in the start, I'm planning to make my work easier by making global variable into local, I can still use GUI function to refer to that SFX variable, but since I'm using scripting all the way, I forgot to change it pure local variable, I had uploaded a new version, fixed that.

Make the functions' prefix letter uppercased: (sfxGround -> SfxGround)

I used a camel-casing, it's one of the style of writing in programming language, don't know for you, for me, it's easy to read.

Or even make the name EffectGround (because it comes in mind better)
Make alternate functions names such as:

sfxGround and sfxUnit is pretty understandable to me
Will consider of changing the functions' name to a more appropriate one

 

[KnnO]

Yes, you can turn a global variable into...

Oh, I was testing that, yes until if you used it in GUI, so that is why I though why not use another var name.

I used a camel-casing...

It doesn't matter, but just to be the same style for Jass writing.

sfxGround and sfxUnit is pretty...

Yes for me too but it is used in Jass as effect, however adding alternatives is enough.

 

[coolyoshi1]

This is a great idea but I think you should also add option of changing size of the sfx

 

[defskull]

SFX size can't be changed, people use Units to act as "SFX", because basically unit's size can be changed either in Object Editor or via triggers.

 

[Magtheridon96]

Camel-case should be used for variables names and struct members only. (There could be some other cases that I'm forgetting)

FunctionNamesShouldBeWrittenLikeThis :3

 

[KnnO]

Camel-case should be used for variables names and struct members only. (There could be some other cases that I'm forgetting)

FunctionNamesShouldBeWrittenLikeThis :3

Exactly, that is how you do it. besides GUIers would use

DestroyGroup ()
DestroyForce ()
RemoveLocation ()
and then...
sfxGround

 

[zv27]

1.
I do not understand why do you use TriggerSleppAction and not a timer.

2. The most important thing:
This system does not support stacking,non-stacking effect.

 

[mckill2009]

Since you're using jass, better is;

function sfxGround takes string sfx, location loc, real dur returns nothing
   local effect SFX = AddSpecialEffectLoc(sfx, loc)
   call TriggerSleepAction(dur)
   call DestroyEffect(SFX)
   call RemoveLocation(loc)
   set SFX = null
endfunction

function sfxUnit takes string sfx, unit u, string ap, real dur returns nothing
   local effect SFX = AddSpecialEffectTarget(sfx, u, ap)
   call TriggerSleepAction(dur)
   call DestroyEffect(SFX)
   set SFX = null
endfunction

How to call?

• Custom script: call sfxGround(What SFX would you like ?, Where do you want to spawn ?, How long you want it ?)

Why so many arguments?
- Coz some users would preffer direct creation than storing it to a global/locals first...

your call RemoveLocation(udg_SFX_Loc) should be in the sfxGround btw...

 

[defskull]

@Mag and KnnO
Alright, alright I change the function name

I do not understand why do you use TriggerSleppAction and not a timer.

It is MUI enough to me, also, I'm not used to JASS and stuffs, I'll try to learn to use timers in later future.

This system does not support stacking,non-stacking effect.

What do you mean it does not support stacking ?
Try cast it multiple times on a single unit, all those SFX gets removed with their own duration.

Since you're using jass, better is;
Jass:

function sfxGround takes string sfx, location loc, real dur returns nothing
   local effect SFX = AddSpecialEffectLoc(sfx, loc)
   call TriggerSleepAction(dur)
   call DestroyEffect(SFX)
   call RemoveLocation(loc)
   set SFX = null
endfunction

function sfxUnit takes string sfx, unit u, string ap, real dur returns nothing
   local effect SFX = AddSpecialEffectTarget(sfx, u, ap)
   call TriggerSleepAction(dur)
   call DestroyEffect(SFX)
   set SFX = null
endfunction

Are you telling me that some user prefer to use local variable instead, creating a global variable ?
That would make his variable list, not grows ?
Yes I agree with that, but that will make it harder for those people who don't know to call native function such GetSpellTargetLoc() or even GetTriggerUnit().

Plus, it will make the user's job easier by setting the variable via GUI function (this system is in favor of GUI user since I used some kind of unefficient method of JASS)

But I will take your consideration, I'll try to put a list for all native function they should call in the documentations.

your call RemoveLocation(udg_SFX_Loc) should be in the sfxGround btw...

Haha fixed that

New version uploaded with some minor changes.

 

[mckill2009]

no, I said direct creation such as;

• Custom script: call sfxGround("string", Loc, "5.0")

OR

• Set udg_SFX_String = What SFX would you like ?
• Set udg_SFX_Duration = How long you want it ?
• Set udg_SFX_Loc = Where do you want to spawn ?
• Custom script: call sfxGround(udg_SFX_String,udg_SFX_Loc, udg_SFX_Duration)

so the option for them not to create those globals/locals...

I forgot to tell you but correct me if Im wrong that TriggerSleepAction doesnt stop if Game is paused
so your SFX may end prematurely coz of that...better to use a Timer...

 

[defskull]

no, I said direct creation such as;

• Custom script: call sfxGround("string", Loc, "5.0")

That's why I said the user must know native function in order to call either Location or Unit.
You see, the Loc is definitely a local variable, right ? Since it has no prefix of udg_.
Okay now, where does Loc comes from ?
Surely we must set it first, right ?
In GUI, it's easy just;

• Set udg_Loc = (Target point of ability being cast)

But everything in JASS is different (the user must memorize the syntax);

• Custom script: local location Loc = GetSpellTargetLoc()

You see ?
The user has to memorize the GetSpellTargetLoc and many other native function.
It's both same thing but the execution to set the variable is totally different, I just make it easy for GUI user (just because they have to memorize the syntax, it's hard for them)

But then again, I might have change this to local variable and will include a full list of all possible native functions that they want to call.

Btw;

no, I said direct creation such as;

• Custom script: call sfxGround("string", Loc, "5.0")

Haha duration is not string dude >.>" (I know you must have mistyped it)

I forgot to tell you but correct me if Im wrong that TriggerSleepAction doesnt stop if Game is paused
so your SFX may end prematurely coz of that...better to use a Timer...

I have tested it in LAN game where you have the ability to Pause a game;
1. I casted in on Ground
2. Directly pause the game (for 10 seconds)
3. Unpause the game and SFX seems not to be destroyed and wait for another 5 seconds (SFX_Duration) to destroy

TriggerSleepAction does obey the Game Pause.

 

[KnnO]

Ok, so best solution is to make more alternative functions for advanced users
EffectGroundExt ( string , loc , duration )
(Ext = Extended)

 

[mckill2009]

Okay now, where does Loc comes from ?

from this "Set udg_Loc = (Target point of ability being cast)"...I forgot the udg_ as well ...
anyway its just my suggestion to make your function more dynamic...

@KnnO
that will confuse the new user even more so no need for that...

 

[defskull]

from this "Set udg_Loc = (Target point of ability being cast)"...I forgot the udg_ as well ...
anyway its just my suggestion to make your function more dynamic...

You see;

• Actions
  • Set SFX_String = Abilities\Spells\Other\AcidBomb\BottleImpact.mdl
  • Set SFX_Loc = (Target point of ability being cast)
  • Set SFX_Duration = 5.00
  • Custom script: call SfxGround()

function SfxGround takes nothing returns nothing
   local effect SFX = AddSpecialEffectLoc(udg_SFX_String, udg_SFX_Loc)
   call RemoveLocation(udg_SFX_Loc)
   call TriggerSleepAction(udg_SFX_Duration)
   call DestroyEffect(SFX)
   set SFX = null
endfunction

• Actions
  • Set SFX_String = Abilities\Spells\Other\AcidBomb\BottleImpact.mdl
  • Set SFX_Loc = (Target point of ability being cast)
  • Set SFX_Duration = 5.00
  • Custom script: call SfxGround(udg_SFX_String, udg_SFX_Loc, udg_SFX_Duration)

function SfxGround takes string whichString, location whichLocation, real whichDuration returns nothing
   local effect SFX = AddSpecialEffectLoc(udg_SFX_String, udg_SFX_Loc)
   call RemoveLocation(udg_SFX_Loc)
   call TriggerSleepAction(udg_SFX_Duration)
   call DestroyEffect(SFX)
   set SFX = null
endfunction

Both of these method works the same, even if you don't include the parameters inside the function, it still execute the right action because all the action is considered inside the function itself, not depends on parameters.

Because, the value in the custom function will refer to global/local variable that we have set, so basically, adding/removing parameter(s) to a custom function does not really affect anything.

@KnnO
that will confuse the new user even more so no need for that...

But then again, this will reduce the amount of global variable ?
But then again (one more time...), will be hard for new user, that's why he propose to make an advance function but I think I'll stick to this my current method first.

 

[Magtheridon96]

Keywords: timed, sfx, special effect, defskull, system, duration, ground, unit, magtheridon96.

You know you're awesome when people start using your username as a Keyword

 

[defskull]

You know you're awesome when people start using your username as a Keyword

I've put my name there because some people, wants to just find out what resources that I have created so that when they go to Spells Section, they just type out my name and there you go, list of my resources.
Also, I've usually put others' username in keywords/tags for credits.

 

[Magtheridon96]

I usually just put Nestharus and Bribe's names in there so I could get more downloads

 

[defskull]

Simple Timed SFX System v1.3 is here.
Please if you can Mag, re-moderate them.