[vJASS] [Snippet] RealEvent

[Bribe]

Bannar contacted me in regards to the Event library being remade into Trigger, moved offsite, having 15 requirements and not even having a standard API across resources anymore thanks to syntax changes over the years.

I wrote this small function for my DamageEngine GUI/vJass hybrid project which is still in the lab. But the standalone function is ready as there isn't much to it, despite that it conforms to all necessary capabilities of an event library.

library RealEvent
/*
    Made by Bribe

    This is a unification of the real variable event in wc3 and clean vJass syntax.
    It is made to fill the void created by resources that need an event but want an API
    that works without requiring a bunch of libraries.

    Tiny API:
    
    CreateRealEventTrigger(string whichVariable, real whichValue, code whichFunction) -> trigger

    If you specify a code value, it automatically adds that as a condition,
    making this a nice one-liner that also returns the trigger in case you need it.

    Since JASS doesn't support pointers but values, the user will need to fire the
    event manually, via: 

    set realVariable = 0.00
    set realVariable = eventValue
*/

globals
    private trigger tempTrig
endglobals

//You do not need the return value of this function if you have no intention of
//disabling/destroying this trigger from outside of it being run.
function CreateRealEventTrigger takes string variable, real value, code run returns trigger
    set tempTrig = CreateTrigger()
    call TriggerRegisterVariableEvent(tempTrig, variable, EQUAL, value)
    if run != null then
        call TriggerAddCondition(tempTrig, Filter(run))
    endif
    return tempTrig
endfunction

endlibrary

 

[Flux]

Useful for cleaner code but isn't it too simple?
Why make the trigger global instead of locals?

 

[Bannar]

@Shadow Flux: You end up declaring that local everytime function is called. It's better to use static instead.

Vote for insta approve. As stated, many resources have been using old Event which has been drastically changed throughout the years. If one doesn't own his own copy of previous Event, there is no way for him to include that crucial for many systems library anymore. This means many resources available on hive actually do not work or require manual ingerention of user. New Event is not an option since it's not fully compatibile and most users are unlikely to implement so many custom resources just to achieve such a simple functionality.

However, old Event didnt allow user to access the trigger handle. All in all, Event was a simple, small wrapper around TriggerRegisterVariableEvent with trigger array addition. Let's be honest, calling events is not hard and most users have been adding "fire" method within their structs anyway.

 

[Bribe]

@Shadow Flux: You end up declaring that local everytime function is called. It's better to use static instead.

I only used it to avoid handle pointer leakage.

 

[Bannar]

Heh, you are right : )

 

[Bribe]

Useful for cleaner code but isn't it too simple?
Why make the trigger global instead of locals?

It's pretty easy to library_once this thing.

 

[Flux]

Right, I forgot. because when it is local, you need to null it, but you can't because 'return' immediately ends the function.

 

[edo494]

I feel this is way too inline-able to be resource of its own, since it is one trivial function.

 

[Bribe]

I agree that the benefits are minimal. The advantages it brings are:

- Save typing out the trigger creation
- Can "return nothing" instead of boolean in the code callback

 

[edo494]

the thing is, anyone could write this exact thing in like 2 minutes in their map, so imo it is just way too trivial to be resource on its own

 

[Bribe]

Right-o, I agree. I created it as a request to fill the void left in the wake of Event's disappearance. I'll update the script for the GUI Unit Indexer plugin soon.

 

[Bannar]

Precisely - anyone could. Problem is, the best, simplest Event has been removed by Nes. It's good to have similar snippet around on hive - allows users to google it more easily.
Of course some additional functionality could be added, but most people which require such thing will probably know what to do next/write their own thing.

Just add this to 'Small snippets' subforum if you think it doesn't belong here.

 

[Almia]

sooo

 

[Troll-Brain]

Imho a such resource doesn't belong there.
It's wayyyyyyy to simple and for what, just less typing ?
The requirement is more annoying than the benefit.

I asked to graveyard LocalHelper and that was more complex.

So small code and snippets if you want but seriously that shouldn't be a requirement in any resource, optional if you want.

 

[IcemanBo]

I don't know. This doesn't really fit in the jass submissions, but might still be used by some. Should we move this "Small Code Snippets" like Bannar suggested? I support this idea.

Edit: Gy'ed due too simple. Though I think it can be a nice addition to small code snippets maybe.