Snippet Unit States

[Romek]

Unit States
By Romek​

Introduction:
A short, simple little library of method operators to make setting a units life, mana, strength, agility, intelligence and UserData much easier.
All the functions are inlined by JassHelper, so this doesn't add any code to your final script. It just makes it much easier to code in the first place.

How to Use:
Make a trigger (name doesn't matter), and go to Edit -> Convert to Custom Text.
Then paste the entire library into the trigger.

To utilize the system while making a map, simply use:

set WhichUnit:WhichState = Value

And

set <var> = WhichUnit:WhichState

You can also use WhichState[WhichUnit] everywhere. Although using the colon looks cleaner.

You can change the following:

• Life (Health, HP)
• Mana (MP)
• Strength (Str)
• Agility (Agi)
• Intelligence (Intel, Int)
• User Data (Value, Data)
• X Position
• Y Position
• Z Position (Height)
• Unit Facing
• Animation (Returns "")
• Owner
• Move Speed

Examples:

set GetTriggerUnit():Life = 600.
set someUnit:Str = 666
local integer val = Unit<img src="data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7" class="smilie smilie--sprite smilie--sprite8" alt=":D" title="Big Grin    :D" loading="lazy" data-shortname=":D" />ata
set WhichUnit:Owner = Player(6)

The Code:

//           +------------------------------------------+
//           |     -=  U N I T   S T A T E S  =-        |
//           |             By Romek (v1.5)              |
// +---------+------------------------------------------+---------+
// | A simple library which makes setting unit states much easier |
// | than it has ever been, in a simple efficient manner.         |
// +--------------------------------------------------------------+
// | Instead of using GetUnitState(..) or SetUnitState(..) use:   |
// | set unit:State = value or State[unit] = value                |
// | For example:                                                 |
// |  - set GetTriggerUnit():Life = 700.                          |
// |  - set whichUnit:Mana = 300.                                 |
// |  - local integer i = Unit:Strength                           |
// |  - set SomeUnit:Owner = Player(5)                            |
// +--------------------------------------------------------------+
// | You can use the following 'States':  (Name | Alt. Name)      |
// |  - Life              - Health        - HP                    |
// |  - Mana              - MP                                    |
// |  - Strength          - Str                                   |
// |  - Agility           - Agi                                   |
// |  - Intelligence      - Intel         - Int                   |
// |  - Data              - Value         (UnitUserData)          |
// |  - X                                 (X Position)            |
// |  - Y                                 (Y Position)            |
// |  - Loc               - Location                              |
// |  - Z                 - Height        (Z Position)            |
// |  - Face              - Facing        - Degrees               |
// |  - Radians                           (Facing in Radians)     |
// |  - Animation         - Anim          (Returns "")            |
// |  - Owner                                                     |
// |  - MoveSpeed         - Speed                                 |
// +--------------------------------------------------------------+
// |       All functions are inlined by JassHelper.               |
// +--------------------------------------------------------------+

library UnitStates
    //! textmacro State__UState takes name, type, in, out
    struct $name$ extends array        
        static method operator []= takes unit u, $type$ val returns nothing
            call $in$
        endmethod
        static method operator [] takes unit u returns $type$
            return $out$
        endmethod
    endstruct
    //! endtextmacro
    //! runtextmacro State__UState("Life", "real", "SetWidgetLife(u, val)", "GetWidgetLife(u)")
    //! runtextmacro State__UState("Health", "real", "SetWidgetLife(u, val)", "GetWidgetLife(u)")
    //! runtextmacro State__UState("HP", "real", "SetWidgetLife(u, val)", "GetWidgetLife(u)")
    //! runtextmacro State__UState("Mana", "real", "SetUnitState(u, UNIT_STATE_MANA, val)", "GetUnitState(u, UNIT_STATE_MANA)")
    //! runtextmacro State__UState("MP", "real", "SetUnitState(u, UNIT_STATE_MANA, val)", "GetUnitState(u, UNIT_STATE_MANA)")
    //! runtextmacro State__UState("Strength", "integer", "SetHeroStr(u, val, false)", "GetHeroStr(u, true)")
    //! runtextmacro State__UState("Str", "integer", "SetHeroStr(u, val, false)", "GetHeroStr(u, true)")
    //! runtextmacro State__UState("Agilty", "integer", "SetHeroAgi(u, val, false)", "GetHeroAgi(u, true)")
    //! runtextmacro State__UState("Agi", "integer", "SetHeroAgi(u, val, false)", "GetHeroAgi(u, true)")
    //! runtextmacro State__UState("Intelligence", "integer", "SetHeroInt(u, val, false)", "GetHeroInt(u, true)")
    //! runtextmacro State__UState("Intel", "integer", "SetHeroInt(u, val, false)", "GetHeroInt(u, true)")
    //! runtextmacro State__UState("Int", "integer", "SetHeroInt(u, val, false)", "GetHeroInt(u, true)")
    //! runtextmacro State__UState("Data", "integer", "SetUnitUserData(u, val)", "GetUnitUserData(u)")
    //! runtextmacro State__UState("Value", "integer", "SetUnitUserData(u, val)", "GetUnitUserData(u)")
    //! runtextmacro State__UState("X", "real", "SetUnitX(u, val)", "GetUnitX(u)")
    //! runtextmacro State__UState("Y", "real", "SetUnitY(u, val)", "GetUnitY(u)")
    //! runtextmacro State__UState("Location", "location", "SetUnitPositionLoc(u, val)", "GetUnitLoc(u)")
    //! runtextmacro State__UState("Loc", "location", "SetUnitPositionLoc(u, val)", "GetUnitLoc(u)")
    //! runtextmacro State__UState("Z", "real", "SetUnitFlyHeight(u, val, 0.)", "GetUnitFlyHeight(u)")
    //! runtextmacro State__UState("Height", "real", "SetUnitFlyHeight(u, val, 0.)", "GetUnitFlyHeight(u)")
    //! runtextmacro State__UState("Face", "real", "SetUnitFacing(u, val)", "GetUnitFacing(u)")
    //! runtextmacro State__UState("Facing", "real", "SetUnitFacing(u, val)", "GetUnitFacing(u)")
    //! runtextmacro State__UState("Degrees", "real", "SetUnitFacing(u, val)", "GetUnitFacing(u)")
    //! runtextmacro State__UState("Radians", "real", "SetUnitFacing(u, val)", "GetUnitFacing(u)*bj_DEGTORAD")
    //! runtextmacro State__UState("Anim", "string", "SetUnitAnimation(u, val)", "\"\"")
    //! runtextmacro State__UState("Animation", "string", "SetUnitAnimation(u, val)", "\"\"")
    //! runtextmacro State__UState("Owner", "player", "SetUnitOwner(u, val, true)", "GetOwningPlayer(u)")
    //! runtextmacro State__UState("Speed", "real", "SetUnitMoveSpeed(u, val)", "GetUnitMoveSpeed(u)")
    //! runtextmacro State__UState("MoveSpeed", "real", "SetUnitMoveSpeed(u, val)", "GetUnitMoveSpeed(u)")
endlibrary

Capital Names Edition:

//           +------------------------------------------+
//           |     -=  U N I T   S T A T E S  =-        |
//           |             By Romek (v1.5)              |
//           |        ->  CAPITAL Edition  <-           |
// +---------+------------------------------------------+---------+
// | A simple library which makes setting unit states much easier |
// | than it has ever been, in a simple efficient manner.         |
// +--------------------------------------------------------------+
// | Instead of using GetUnitState(..) or SetUnitState(..) use:   |
// | set unit:State = value or State[unit] = value                |
// | For example:                                                 |
// |  - set GetTriggerUnit():LIFE = 700.                          |
// |  - set whichUnit:MANA = 300.                                 |
// |  - local integer i = Unit:STRENGTH                           |
// |  - set SomeUnit:OWNER = Player(5)                            |
// +--------------------------------------------------------------+
// | You can use the following 'States':  (Name | Alt. Name)      |
// |  - LIFE              - HEALTH        - HP                    |
// |  - MANA              - MP                                    |
// |  - STRENGTH          - STR                                   |
// |  - AGILITY           - AGI                                   |
// |  - INTELLIGENCE      - INTEL         - INT                   |
// |  - DATA              - VALUE         (UnitUserData)          |
// |  - X                                 (X Position)            |
// |  - Y                                 (Y Position)            |
// |  - LOC               - LOCATION                              |
// |  - Z                 - HEIGHT        (Z Position)            |
// |  - FACE              - FACING        - DEGREES               |
// |  - RADIANS                           (Facing in Radians)     |
// |  - ANIMATION         - ANIM          (Returns "")            |
// |  - OWNER                                                     |
// |  - MOVESPEED         - SPEED                                 |
// +--------------------------------------------------------------+
// |       All functions are inlined by JassHelper.               |
// +--------------------------------------------------------------+

library UnitStatesCaps
    //! textmacro State__UCState takes name, type, in, out
    struct $name$ extends array    
        static method operator []= takes unit u, $type$ val returns nothing
            call $in$
        endmethod
        static method operator [] takes unit u returns $type$
            return $out$
        endmethod
    endstruct
    //! endtextmacro
    //! runtextmacro State__UCState("LIFE", "real", "SetWidgetLife(u, val)", "GetWidgetLife(u)")
    //! runtextmacro State__UCState("HEALTH", "real", "SetWidgetLife(u, val)", "GetWidgetLife(u)")
    //! runtextmacro State__UCState("HP", "real", "SetWidgetLife(u, val)", "GetWidgetLife(u)")
    //! runtextmacro State__UCState("MANA", "real", "SetUnitState(u, UNIT_STATE_MANA, val)", "GetUnitState(u, UNIT_STATE_MANA)")
    //! runtextmacro State__UCState("MP", "real", "SetUnitState(u, UNIT_STATE_MANA, val)", "GetUnitState(u, UNIT_STATE_MANA)")
    //! runtextmacro State__UCState("STRENGTH", "integer", "SetHeroStr(u, val, false)", "GetHeroStr(u, true)")
    //! runtextmacro State__UCState("STR", "integer", "SetHeroStr(u, val, false)", "GetHeroStr(u, true)")
    //! runtextmacro State__UCState("AGILITY", "integer", "SetHeroAgi(u, val, false)", "GetHeroAgi(u, true)")
    //! runtextmacro State__UCState("AGI", "integer", "SetHeroAgi(u, val, false)", "GetHeroAgi(u, true)")
    //! runtextmacro State__UCState("INTELLIGENCE", "integer", "SetHeroInt(u, val, false)", "GetHeroInt(u, true)")
    //! runtextmacro State__UCState("INTEL", "integer", "SetHeroInt(u, val, false)", "GetHeroInt(u, true)")
    //! runtextmacro State__UCState("INT", "integer", "SetHeroInt(u, val, false)", "GetHeroInt(u, true)")
    //! runtextmacro State__UCState("DATA", "integer", "SetUnitUserData(u, val)", "GetUnitUserData(u)")
    //! runtextmacro State__UCState("VALUE", "integer", "SetUnitUserData(u, val)", "GetUnitUserData(u)")
    //! runtextmacro State__UCState("X", "real", "SetUnitX(u, val)", "GetUnitX(u)")
    //! runtextmacro State__UCState("Y", "real", "SetUnitY(u, val)", "GetUnitY(u)")
    //! runtextmacro State__UCState("LOCATION", "location", "SetUnitPositionLoc(u, val)", "GetUnitLoc(u)")
    //! runtextmacro State__UCState("LOC", "location", "SetUnitPositionLoc(u, val)", "GetUnitLoc(u)")
    //! runtextmacro State__UCState("Z", "real", "SetUnitFlyHeight(u, val, 0.)", "GetUnitFlyHeight(u)")
    //! runtextmacro State__UCState("HEIGHT", "real", "SetUnitFlyHeight(u, val, 0.)", "GetUnitFlyHeight(u)")
    //! runtextmacro State__UCState("FACE", "real", "SetUnitFacing(u, val)", "GetUnitFacing(u)")
    //! runtextmacro State__UCState("FACING", "real", "SetUnitFacing(u, val)", "GetUnitFacing(u)")
    //! runtextmacro State__UCState("DEGREES", "real", "SetUnitFacing(u, val)", "GetUnitFacing(u)")
    //! runtextmacro State__UCState("RADIANS", "real", "SetUnitFacing(u, val)", "GetUnitFacing(u)*bj_DEGTORAD")
    //! runtextmacro State__UCState("ANIM", "string", "SetUnitAnimation(u, val)", "\"\"")
    //! runtextmacro State__UCState("ANIMATION", "string", "SetUnitAnimation(u, val)", "\"\"")
    //! runtextmacro State__UCState("OWNER", "player", "SetUnitOwner(u, val, true)", "GetOwningPlayer(u)")
    //! runtextmacro State__UCState("SPEED", "real", "SetUnitMoveSpeed(u, val)", "GetUnitMoveSpeed(u)")
    //! runtextmacro State__UCState("MOVESPEED", "real", "SetUnitMoveSpeed(u, val)", "GetUnitMoveSpeed(u)")
endlibrary

 

[Prometheus]

I think this is a great little snippit. +rep man!

 

[Waaaaagh]

Dude OMG best thing ever where did you get the idea!?? IT"S SOO AWESOME!!!!

 

[Romek]

> Dude OMG best thing ever where did you get the idea!?? IT"S SOO AWESOME!!!!
..Oh. I didn't know that even existed.
I had a quick glance at the code. That's a long system. This is a 50-lined snippet.

(All the best ideas just have to be taken, don't they? ¬_¬")

 

[Waaaaagh]

Yeah. Actually your systems are different, in that his is actually a system, and yours is a bunch of wrappers. Thus, it seems to make sense that this one not be... alive, because people here will see it and say 'COOL it's ON TEH HELPRER!!!', and this will become sort of widespread, and then, when people see <unit>:AttackSpeed, they'll think of Litany's, not yours, and freak out when the two aren't working with each other. In the very least, provide a link to that thread and state that yours is a direct wrapper and his is a system with wrappers (his = better, yours = faster, but not of any importance).

 

[UndeadDragon]

Very useful :thup:

 

[Kenny]

Very cool little snippet from what i have read so far. One question. It can be used like that as well right?

set GetTriggerUnit():Life = GetWidgetLife(GetTriggerUnit())+500.00

What i mean is, it can use function calls and stuff too ayy.

Anyways I've got a few ideas to put this to use. Good work. + rep.

 

[Romek]

@ Waaaaaaaaaaa[etc]gh
I agree. This one is completely inlined by JassHelper.
I won't post a link though >.<

> Very useful
Thanks

> It can be used like that as well right?
Yes. Actually, I might change the Life method to use GetWidgetLife, and allow items and desctructables.

 

[Vestras]

You know, you don't have to do the :, you can also just do the normal [].

 

[Romek]

You know, you don't have to do the :, you can also just do the normal [].

Genius! Congratulations for finding that out. It's actually in the first post though.

 

[Vestras]

Didn't see that, sorry...

 

[Andrewgosu]

It's just a thing of preference, but I suggest using capital letters for the stats you can change.

I mean,

set unit:STR = value
set unit:INT = value
set unit:AGI = value

etc.

It would just look more Blizzard-styled, where unit states, etc. are all in capital letters.

More convenient for those who are familiar with that naming convention (e.g me...).

 

[GoGo-Boy]

So is it possible to add a certain % extra hp permanently to a unit when it enters the map?
In case, that would be nice, because I'm planning to have a different difficulties to be selected in my map. And one part of that is to increase all units life by a certain percent amount, and that isn't possible with upgrades (or is it?).

 

[Romek]

Hmm.. Fine.
Did a quick find+replace.

"Capital Edition" put into first post. ^_^

So is it possible to add a certain % extra hp permanently to a unit when it enters the map?
In case, that would be nice, because I'm planning to have a different difficulties to be selected in my map. And one part of that is to increase all units life by a certain percent amount, and that isn't possible with upgrades (or is it?).

Yeah, that's possible. Though this doesn't help much with it. These are just wrappers.

Hmm. I'll add MaxMana and MaxLife in the future.

 

[Romek]

Bump.

 

[Prometheus]

// | - MoveSpeed - Speed |
Missing ms.

 

[Flare]

// | - MoveSpeed - Speed |
Missing ms.

Uhm... it's not missing?

 //! runtextmacro State__UState("MoveSpeed", "real", "SetUnitMoveSpeed(u, val)", "GetUnitMoveSpeed(u)")

//! runtextmacro State__UCState("MOVESPEED", "real", "SetUnitMoveSpeed(u, val)", "GetUnitMoveSpeed(u)")

 

[WolfieeifloW]

I'm pretty sure he meant it's missing the 'alt name'?
Which in the code posted, it doesn't seem to have ms as an alt name.

 

[Romek]

Yeah, he meant an alternate name.

I'll probably add it soon.
This 'snippet' is getting quite lengthy.

 

[WolfieeifloW]

Also;
Sometimes people call Mana "Energy".
And couldn't Radians have "rad(i)" or something ?