Snippet Timed Resources.

[GetTriggerUnit-]

This is a very simple snippet that allows you to periodicly add resources to a player.

/* 

    TimedResources v1.0

    This is a very simple snippet that allows you to periodicly add
    resources to a player.
    
    -How to import:
    
        * You first need to get TimerUtils
        * Create a new trigger and convert it to custom script.
        * Label you trigger to "TimedResources"
        * Delete all the text within it and replace it by this text.
        
    -How to use:
    
        * Create a new instance -> TimedResources d = TimedResources.create().
        * Set all the struct memeber to a value. -> d.mainPlayer = whichPlayer.
        * Use the Start() method to start Resources incomes.
        * Use the Stop() method to stop Resources incomes.
        
*/

library TimedResources requires TimerUtils

    struct TimedResources
    
        player mainPlayer
        real gainPeriod
        integer gainGold
        integer gainWood
        private timer periodTimer
        
        private static method periodic takes nothing returns nothing
            local thistype d = GetTimerData(GetExpiredTimer())
            call SetPlayerState(d.mainPlayer, PLAYER_STATE_RESOURCE_GOLD, GetPlayerState(d.mainPlayer, PLAYER_STATE_RESOURCE_GOLD) + d.gainGold)
            call SetPlayerState(d.mainPlayer, PLAYER_STATE_RESOURCE_LUMBER, GetPlayerState(d.mainPlayer, PLAYER_STATE_RESOURCE_LUMBER) + d.gainWood)
        endmethod
        
        method Start takes nothing returns nothing
            local thistype d = this
            set d.periodTimer = NewTimer()
            call SetTimerData(d.periodTimer, d)
            call TimerStart(d.periodTimer, d.gainPeriod, true, function thistype.periodic)
        endmethod
        
        method Stop takes nothing returns nothing
            call ReleaseTimer(this.periodTimer)
            set this.mainPlayer = null
            set this.gainPeriod = 0.00
            set this.gainGold = 0
            set this.gainWood = 0
        endmethod
        
    endstruct

endlibrary

Testmap:

 

[kingkingyyk3]

lol? I don't think this is useful, :banghead:

 

[GetTriggerUnit-]

Why isn't it?

It's useful for AoS maps like Dota and such.
It could also be used to do a Time system with Wood and Food such as in Dota.

 

[Tru_Power22]

What wrong with a periodic event in GUI?

Really this serves little purpose.

Oh it's AoS maps, not AoE.

AoS - Aeion of Strife

AoE - Area of effect

 

[kingkingyyk3]

It could also be used to do a Time system with Wood and Food such as in Dota.
Where the set food thingy in your library? lol

 

[GetTriggerUnit-]

This is more useful than a simple periodic GUI trigger, since it's simplier, more efficient and it can be instanced sereval times.

Where the set food thingy in your library? lol

No comments for stupid remarks.

 

[Nestharus]

This needs to be on T32...

 

[GetTriggerUnit-]

Can't modify Timer's period on T32.

 

[Sevion]

Can't modify Timer's period on T32.

Why do you need to?

 

[Narks]

this is kind of useless, since GUI can do exactly the same thing

 

[Lyerae]

If you need this, you can make it yourself.

 

[Jesus4Lyf]

>This needs to be on T32...
??

I would write this in GUI. It is easier to implement. :nuts:

Edit: This is actually difficult to use in comparison. The interface is sloppy.

 

[Executor]

Why TimerUtils?

I think you will have a maximum amount of ~12 instances and it's rubbish to destroy one of these structs, so just create one timer per struct ?!
You should also add a reference between player and struct instance.

Otherwise, if you want more than ~12 instances per map (for ex. for every single wood providing building) you should link all structs with a linked list together and through all in a constant interval.

BTW. I don't see the point of this snippet.

 

[TriggerHappy]

Fail.

function callback takes nothing returns nothing
    call SetPlayerState(....)
endfunction

function main takes nothing returns nothing
    call TimerStart(CreateTimer(), 5, true, function callback)
endfunction

It doesn't even require data transfer.

 

[Romek]

This seems like one of those "I felt like submitting something, so I submitted anything" resources. Sure, it does more than the code in Post #14, though will you ever need those additional 'features'?
Giving players resources periodically is a simple task that most certainly doesn't require something like this.

Also, the name "Timed Resources" is misleading, and sounds as though the resources expire or something.

GY'd.

Also, you don't need to 'null' reals. Only agents.

 

[Jesus4Lyf]

There is a good reason for him to set them to 0 in this snippet, actually. It's so the values don't leak over into the next instance.

 

[Sevion]

I love how he doesn't have T32x implemented in this.

 

[TriggerHappy]

I love how he doesn't have T32x implemented in this.

So everyone must use T32 :nuts:

People have different preferences, you know.

 

[Sevion]

When you look at it, T32x is the best way to go.

With it, he can use a single T32x instance, and pause it when the stack is empty.

 

[Nestharus]

Otherwise, if you want more than ~12 instances per map (for ex. for every single wood providing building) you should link all structs with a linked list together and through all in a constant interval.

that = T32, which is why I suggested it, but you could do it by scratch as you suggested ^_-


I agree with Romek though... a script of this nature doesn't really give anything new and interesting and only takes 5 seconds to make ><. It's not general enough to be used in like every map either.

I could see something like this in a dota template or something, or a framework like the RPG Framework (and we all know how much people love frameworks, lol).

But by itself it's kind of ... it's not a shared resource, it runs itself :\. It requires no research... I mean, maybe if we had like a super small snippet section like THW snippet thread I could see this.


On a side note, this doesn't follow JASS conventions ;p.

method Stop takes nothing returns nothing

Then again I see people doing whatever they want here (sometimes upper start, sometimes lower start) : o


Even Vexorian goes all over the place in his vjass manual ;p. From what I've seen though, the common practice is method start lower and functions start upper. Oh well, guess it doesn't really matter since nobody really follows it anyways : D. Variables are pretty chaotic too ;o.