Unit Naming System 1.2

[Chaosy]

What. The. actual. fuck

How have I missed this native O_O
Honestly, this is a must have in any RPG map.

I think the init could be improved greatly however.
Instead of making copy pasted function calls after every variable, use an array of names and loop through them at the end. This will make the trigger considerably shorter

 

[Pinzu]

What. The. actual. fuck

How have I missed this native O_O
Honestly, this is a must have in any RPG map.

I think the init could be improved greatly however.
Instead of making copy pasted function calls after every variable, use an array of names and loop through them at the end. This will make the trigger considerably shorter

Good catch. Will add that as well as more documentation I suppose, either later today or more likely tomorrow.

It's a bit bare bones at the moment but I'm not sure what more configurable or use cases that are needed. I'd appreciate any ideas.

Update: 0.03

Added support for Unit Indexer event, as well as different ways to set a random name of a unit. You can now also give a specific name to any unit, and keep track of the default name or the rp name of a unit using two variables.

I'm considering adding show/hide unit name functionality as a final thing, which made me wonder if local unit name changes would work or cause a desync. Something like this:

if (p == GetLocalPlayer()) then
     call BlzSetUnitName(u, name)
endif

Update: 0.06

I consider it somewhat finished now, don't have any pressing changes that I wish to add other than enabling prioritization of unused names over used ones, but that's something I'm not looking to start on any time soon.

 

[Chaosy]

I still think you're complicating the setup.

I'd imagine the following:
unit = paladin
name[1] = "something"
name[2] = "something else"
call setupUnit()

setupUnit would loop through the name variable and store the names with the unit id as primary key.

number of custom scripts (that the user have to use) should be limited for GUI systems

 

[Pinzu]

I still think you're complicating the setup.

I'd imagine the following:
unit = paladin
name[1] = "something"
name[2] = "something else"
call setupUnit()

setupUnit would loop through the name variable and store the names with the unit id as primary key.

number of custom scripts (that the user have to use) should be limited for GUI systems

The biggest argument for this would be to reduce the number of function calls (which if the setup is long might be a problem). But the downside would be that you'd have to edit 2 things instead of 1 (name and number) if you want something changed. You'd also need a array list for the unit-types in case you want multiple units with similar names. Can't really decide which optimization I prefer.

 

[Pyrogasm]

What about a //! call that allows you to load an external .txt file with unit types and names in like a csv format? I'm not all about that but there has to be a way to parse the file into arrays of unit names. Maybe even a few proper user-end textmacroes would help here.

 

[Chaosy]

It is just that I'd never used this, thinking back to when I was a filthy GUI user.
Editing custom scripts was a huge turnoff and was something I only would consider if I was really desperate.

So, I think you should decide on your target audience here.
If you target jass users this is a bothersome way of doing it, and for pure GUIers it is also not ideal.
So it is kinda inconvenient for both instead of good for one and bad for the other.

 

[Pinzu]

What about a //! call that allows you to load an external .txt file with unit types and names in like a csv format? I'm not all about that but there has to be a way to parse the file into arrays of unit names. Maybe even a few proper user-end textmacroes would help here.

I would love to see something like that and can think of many use cases for it, but I'm afraid I won't be the one able to implement it.

It is just that I'd never used this, thinking back to when I was a filthy GUI user.
Editing custom scripts was a huge turnoff and was something I only would consider if I was really desperate.

So, I think you should decide on your target audience here.
If you target jass users this is a bothersome way of doing it, and for pure GUIers it is also not ideal.
So it is kinda inconvenient for both instead of good for one and bad for the other.

The options are the following each with pros and cons, perhaps the left and right ones being the clearer options. I can see why a jasser would prefer the left one as text editing isnt as annoying but I would probably just add parameters to the existing functions or lifting out the HashSaving entierly rather than storing them in temporary variables.

What about this one then?

 

[MyPad]

I'd think of having them just run a trigger that ends up calling said function. The drawback is that the function must be moved to the map header.
It's something I learned while making GUI Friendly systems.

 

[Pinzu]

Could I get any feedback on the vJass version i made? I attached a test map to it and code below temporarily until I decide what to do with the two versions.

1) Index/deindex event. Currently there is no such thing but there are API-functions to easily configure that to whatever the user has.

2) How to manage units that are not touched by the system. For example if the player uses "GetUnitNormalName" should it return null or say, GetUnitName() if not yet recorded...?

3) Is it necessary to have first name and last name as separate strings, perhaps just assume that the first name is always one word?

4) How to configure the customizeable parts

5) Would adding the possibility of picking name by frequency be a valuable addition or mostly bloat?

vJass version

/*
    UnitNaming v 0.12
        by Pinzu
    Giving units proper hero names and other naming utilities.
  
    Requirements:
        Table by Bribe
          https://hiveworkshop.com/threads/snippet-new-table.188084/
        WorldBounds by Nestharus
          https://github.com/nestharus/JASS/blob/master/jass/Systems/WorldBounds/script.j
      
        Fantasy Name Generators by nerds all over
          http://www.fantasynamegenerators.com/
        
    Configuraton
  
        1)  After copying the library to your map you can change public globals to your chosing.
        2)  At the bottom of the code there is the Setup function, you may chose to exclude a few of
            the textmacros in case you don't wish to include things as destroy name onDeath, name
            unit onEnterMap or name all preplaced units.
    API
    ------------
    struct NamePool
    |
    | static method create takes nothing returns NamePool
    |     create a new NamePool
    |  
    | method destroy takes nothing returns nothing
    |     destroy it
    |  
    | method getRandomName takes nothing returns FullName
    |     returns a random struct containing the proper name that was configured
    |  
    | method addType takes integer unitTypeId returns thistype
    |     Adds a unit-type to this name pool, used for identification by the system
    |  
    | method removeType takes integer unitTypeId returns boolean
    |     Removes a unit-type by index from the name pool
    |  
    | method addName takes string name returns thistype
    |     Simple add (hero) name to pool, does not have any configured last name
    |  
    | method addProperName takes string firstName, string lastName returns thistype
    |     Adds a (hero) name to pool where the first name is separated from the last
    |
    | method getName takes integer index returns string
    |     Returns a proper (hero) name saved at a specific index
    |
    | method removeName takes integer index returns boolean
    |     Removes a name at a specific index
    |
    ----------------
    |
    | function SetUnitNormalName takes unit u, string normalname returns nothing
    |     Basically the same as 'BlzSetUnitName' except that it keeps the proper name if any such is set
    |
    | function GetUnitNormalName takes unit u returns string
    |     Basically the same as 'GetUnitName', excludes the proper names if such exist
    |     Note that it only works for units that have been configured by the system
    |
    | function SetUnitProperName takes unit u, string firstname, string lastname returns nothing
    |     Same as setting a heroes name, devided in first and last names
    |
    | function GetUnitProperName takes unit u returns string
    |     Returns the units proper name with both first and last name if such exist
    |
    | function GetUnitFirstName takes unit u returns string
    |     Returns the first name of the unit
    |
    | function SetUnitFirstName takes unit u, string firstname returns nothing
    |     Changes the units first name
    |
    | function GetUnitLastName takes unit u returns string
    |     Returns the last name of the unit
    |
    | function SetUnitLastName takes unit u, string lastname returns nothing
    |     Changes the units last name
    |
    | function SetUnitRandomName takes unit u returns boolean
    |     Gives a unit a random name based on the unit-type
    |     Note that if the unit-type is not configured to any unit pool the unit wont be affected
    |
    | function HasUnitName takes unit u returns boolean
    |     If the unit exists in the systems records it will return true
    |
    | function DestroyUnitName takes unit u returns nothing
    |     Used to deallocate unit names from units. Should be used on deindex event.
    |
    | function UnitTypeIsInPool takes integer unitTypeId returns boolean
    |     If the unit type has been configured to any unit pool it will return true
    ----------------
*/
library UnitNaming initializer Init uses Table, WorldBounds
    globals
        // Configuration
        public boolean keepNormalNames     = true        // considering moving this to each pool
        public boolean colorHeroes         = true         // considering moving this to each pool
        public string color                = "|cffffcc00" // considering  moving this to each pool
      
        private Table uTable  
        private integer MAX_STR_LEN        = 1000
    endglobals
  
    private struct FullName
        string first
        string last
    endstruct
  
    struct NamePool
        private Table names
        private integer namesIndex
        private Table types
        private integer typesIndex
      
        method getRandomName takes nothing returns FullName
            local integer rdm = GetRandomInt(0, .namesIndex - 1)
            return .names[rdm]
        endmethod
        private method indexOfType takes integer unitTypeId returns integer
            local integer i = 0
            loop
                exitwhen i == .typesIndex
                if (.types[i] == unitTypeId) then
                    return i
                endif
                set i = i + 1
            endloop
            return -1
        endmethod
      
        method removeType takes integer unitTypeId returns boolean
            if (uTable[unitTypeId] == this) then
                call uTable.remove(unitTypeId)
                set .typesIndex = .typesIndex - 1
                set .types[.indexOfType(unitTypeId)] = .types[.typesIndex]
                call .types.remove(.typesIndex)
                return true
            endif
            return false
        endmethod
      
        method addType takes integer unitTypeId returns thistype
            local NamePool prev = uTable[unitTypeId]
            if (uTable[unitTypeId] != null) then
                call prev.removeType(unitTypeId)
            endif
            set uTable[unitTypeId] = this
            set .types[.typesIndex] = unitTypeId
            set .typesIndex = .typesIndex + 1
            return this
        endmethod
  
        method getName takes integer index returns string
            local FullName name
            if (index >= namesIndex or index < 0) then
                return null
            endif
            set name = .names[index]
            return name.first + " " + name.last
        endmethod
      
        method addProperName takes string firstName, string lastName returns thistype
            local FullName fullName = FullName.create()
            set fullName.first =  firstName
            set fullName.last = lastName
            set .names[.namesIndex] = fullName
            set .namesIndex = .namesIndex + 1
            return this
        endmethod
      
        method addName takes string name returns thistype
            call .addProperName(name, "")
            return this
        endmethod
      
        method removeName takes integer index returns boolean
            local integer i
            local FullName fullName
            if (index >= .namesIndex or index < 0) then
                return false
            endif
            set fullName = .names[index]
            call fullName.destroy()
            loop
                exitwhen index == .namesIndex
                set .names[index] = .names[index + 1]
                set index = index + 1
            endloop
            set .namesIndex = .namesIndex - 1
            call .names.remove(.namesIndex)
            return true
        endmethod
      
        static method create takes nothing returns thistype
            local thistype this = .allocate()
            set this.names = Table.create()
            set this.namesIndex = 0
            set this.types = Table.create()
            set this.typesIndex = 0
            return this
        endmethod
      
        method onDestroy takes nothing returns nothing
            call .names.destroy()
            call .types.destroy()
        endmethod
    endstruct
  
    private struct UnitName
        string nfirst
        string nlast
        string normal
      
        method onDestroy takes nothing returns nothing
            set .nfirst = null
            set .nlast = null
            set .normal = null
        endmethod
      
        static method create takes unit u, string first, string last returns thistype
            local thistype this = .allocate()
            set this.nfirst = first
            set this.nlast = last
            if (keepNormalNames) then
                set this.normal = GetUnitName(u)
            else
                set this.normal = ""
            endif
            set uTable[GetHandleId(u)] = this
            return this
        endmethod
      
        static method get takes unit u returns thistype
            local integer id = GetHandleId(u)
            if (uTable.has(id)) then
                return uTable[id]
            endif
            return 0
        endmethod
        method setFirst takes string name returns thistype
            set .nfirst = name
            return this
        endmethod
      
        method setLast takes string name returns thistype
            set .nlast = name
            return this
        endmethod
      
        method setNormal takes string name returns thistype
            set .normal = name
            return this
        endmethod
      
        method apply takes unit u returns nothing
            if (IsUnitType(u, UNIT_TYPE_HERO)) then
                call BlzSetUnitName(u, .normal)
                if (colorHeroes) then
                    call BlzSetHeroProperName(u, color + .nfirst +  " " + .nlast + "|r")
                else
                    call BlzSetHeroProperName(u, .nfirst +  " " + .nlast)
                endif
            else
                if (StringLength(.nfirst) > 0 or StringLength(.nlast) > 0) then
                    call BlzSetUnitName(u, color + .nfirst + " " + .nlast + "|r" + "|n" + .normal)
                else
                    call BlzSetUnitName(u, .normal)
                endif
            endif
        endmethod
    endstruct
  
    function SetUnitNormalName takes unit u, string normalname returns nothing
        local UnitName uname
        local integer id = GetHandleId(u)
        if (not(uTable.has(id))) then
            if (IsUnitType(u, UNIT_TYPE_HERO)) then
                set uname = UnitName.create(u, GetHeroProperName(u), "")
            else
                set uname = UnitName.create(u, "", "")
            endif
        else
            set uname = uTable[id]
        endif
        call uname.setNormal(normalname).apply(u)
    endfunction
  
    function SetUnitProperName takes unit u, string firstname, string lastname returns nothing
        local UnitName uname
        local integer id = GetHandleId(u)
        if (not(uTable.has(id))) then
            set uname = UnitName.create(u, firstname, lastname)
        else
            set uname = uTable[id]
        endif
        call uname.setFirst(firstname).setLast(lastname).apply(u)
    endfunction
  
    function UnitTypeIsInPool takes integer unitTypeId returns boolean
        return uTable.has(unitTypeId)
    endfunction
  
    function HasUnitName takes unit u returns boolean
        return uTable.has(GetHandleId(u))
    endfunction
  
    function SetUnitRandomName takes unit u returns boolean
        local UnitName uname
        local FullName name
        local NamePool np
        local integer id = GetUnitTypeId(u)
        if (not(UnitTypeIsInPool(id))) then
            return false
        endif
        set np = uTable[id]
        set name = np.getRandomName()
        if (HasUnitName(u)) then
            set uname = uTable[GetHandleId(u)]
            call BlzSetUnitName(u, uname.normal)
            call uname.setFirst(name.first).setLast(name.last).apply(u)
        else
            set uname = UnitName.create(u, name.first, name.last)
            call uname.apply(u)
        endif
        return true
    endfunction
 
    function GetUnitProperName takes unit u returns string
        local integer id = GetHandleId(u)
        local UnitName uname
        if (not(HasUnitName(u))) then
            if (IsUnitType(u, UNIT_TYPE_HERO)) then
                return GetHeroProperName(u) // The unit doesn't have a record
            endif
            return null
        endif
        set uname = uTable[id]
        return uname.nfirst + " " + uname.nlast
    endfunction
  
    function SetUnitFirstName takes unit u, string firstname returns nothing
        local UnitName uname
        if (not(HasUnitName(u))) then
            set uname = UnitName.create(u, firstname, "")
        else
            set uname = uTable[GetHandleId(u)]
            set uname.nfirst = firstname
        endif
        call uname.apply(u)
    endfunction
  
    function SetUnitLastName takes unit u, string lastname returns nothing
        local UnitName uname
        if (not(HasUnitName(u))) then
            set uname = UnitName.create(u, "", lastname)
        else
            set uname = uTable[GetHandleId(u)]
            set uname.nlast = lastname
        endif
        call uname.apply(u)
    endfunction
  
    function GetUnitFirstName takes unit u returns string
        local UnitName uname
        if (not(HasUnitName(u))) then
            return null
        endif
        set uname = uTable[GetHandleId(u)]
        return uname.nfirst
    endfunction
  
    function GetUnitLastName takes unit u returns string
        local UnitName uname
        if (not(HasUnitName(u))) then
            return null
        endif
        set uname = uTable[GetHandleId(u)]
        return uname.nlast
    endfunction
  
    function GetUnitNormalName takes unit u returns string
        local integer id = GetHandleId(u)
        local UnitName uname
        if (not(HasUnitName(u))) then
            return GetUnitName(u) // The unit doesn't have a record
        endif
        set uname = uTable[id]
        return uname.normal
    endfunction
  
    function DestroyUnitName takes unit u returns nothing
        local integer id = GetHandleId(u)
        local UnitName uname = uTable[id]
        call uname.destroy()
        call uTable.remove(id)
    endfunction
  
    private function Init takes nothing returns nothing
        set uTable = Table.create()
    endfunction
endlibrary

New Setup

scope UnigNamingSetup initializer Init
    globals
        NamePool array np[10]
    endglobals
 
    private function Main takes nothing returns nothing
        local trigger t = GetTriggeringTrigger()
        local integer i
 
        // Allocating the name pool
        set i = 0
        set np[i] = NamePool.create()
 
        // Here we are adding which unit-types will be attached to this name pool
        call np[i].addType('hfoo').addType('hkni').addType('Hpal')
 
        // We can either set up names like this,
        // which will set the proper name to only consit of a first name
        call np[i].addName("Pinzu, Just Pinzu")
 
        // Or like, which sets up names as first and last names respectivly.
        // This can then be used to address units by their first name or last name.
        // However, if you don't need this feature I'd recommend you stick to the first option.
        call np[i].addProperName("Pinzu", "San")
        set i = 1
        set np[i] = NamePool.create()
        call np[i].addType('nvil').addType('nvl2')
        call np[i].addName("Kendall Werner").addName("Raul Tindall").addName("Rodhlann Brent")
        call np[i].addName("Rodhlann Brent").addName("Quinten Reed").addName ("Wingate Burlingame")
        call np[i].addName("Jefrem Swett").addName("Hayo Dryden").addName("Tyeson Harley")
        call np[i].addName("Jan Lee").addName("Ogden Acton")
        set i = 2
        set np[i] = NamePool.create()
        call np[i].addType('nvlw').addType('nhef').addType('hsor')
        call np[i].addName("Cher Whitney").addName("Merry Sue").addName("Ashli Cooper").addName("Joanna Smythe")
        call np[i].addName("Marquise Kendall").addName("Sahra Astley").addName("Lisbeth Salander")
 
        set i = 3
        set np[i] = NamePool.create()
        call np[i].addType('nvlk').addType('nvk2')
        call np[i].addName("Dinbush Quietneedle").addName("Teendic Mekkamix").addName("Fucuzz Puddleheart").addName("Henidu Battlebrake")
 
        // deallocating the name pool
        call np[9].destroy()
 
        // Read the full API list for more functions and methods to use
 
        call DisableTrigger(t)
        call DestroyTrigger(t)
        set t = null
    endfunction
 
    private function Init takes nothing returns nothing
        local trigger t = CreateTrigger()
        call TriggerRegisterTimerEvent(t, 0.01, false)
        call TriggerAddAction(t, function Main)
        set t = null
    endfunction
endscope

Sample Usage

scope UnitNamingTest initializer Init
 
    globals
        private string array commands
        private integer array len
        private group g = CreateGroup()
        private integer max
    endglobals
 
    function GetOneSelectedPlayerUnit takes player p returns unit
        local integer count = 0
        local unit u
        local unit found
        call SyncSelections()
        call GroupEnumUnitsSelected(g, p, null)
        loop
            set u = FirstOfGroup(g)
            exitwhen u == null
            call GroupRemoveUnit(g, u)
            if GetOwningPlayer(u) == p then
                set count = count + 1
                if count == 1 then
                    set found = u
                else
                    set found = null
                endif
            endif
        endloop
        return found
    endfunction
 
    /* Changes first name */
    private function cmd0 takes string s returns nothing
        local unit u = GetOneSelectedPlayerUnit(GetTriggerPlayer())
        call SetUnitFirstName(u, s)
        set u = null
    endfunction
 
    /* Changes last name */
    private function cmd1 takes string s returns nothing
        local unit u = GetOneSelectedPlayerUnit(GetTriggerPlayer())
        call SetUnitLastName(u, s)
        set u = null
    endfunction
 
    /* Changes unit name */
    private function cmd2 takes string s returns nothing
        local unit u = GetOneSelectedPlayerUnit(GetTriggerPlayer())
        call SetUnitNormalName(u,s)
        set u = null
    endfunction
 
    /* Changes unit proper name  */
    private function cmd3 takes string s returns nothing
        local unit u = GetOneSelectedPlayerUnit(GetTriggerPlayer())
        call SetUnitProperName(u, "Proper firstname", "Proper lastname")
        set u = null
    endfunction
 
    /* Set new random name */
    private function cmd4 takes nothing returns nothing
        local unit u = GetOneSelectedPlayerUnit(GetTriggerPlayer())
        local boolean success = SetUnitRandomName(u)
        if (not(success)) then
            call BJDebugMsg("This unit cannot be renamed")
        else
            call BJDebugMsg("Renaming unit from " + GetUnitNormalName(u))
        endif
        set u = null
    endfunction
 
    /* Retrieves first name */
    private function cmd5 takes nothing returns nothing
        local unit u = GetOneSelectedPlayerUnit(GetTriggerPlayer())
        call BJDebugMsg("First name: " + GetUnitFirstName(u))
        set u = null
    endfunction
 
    /* Retrieves first name */
    private function cmd6 takes nothing returns nothing
        local unit u = GetOneSelectedPlayerUnit(GetTriggerPlayer())
        call BJDebugMsg("Last name: " + GetUnitLastName(u))
        set u = null
    endfunction
 
    /* Retrieves unit name */
    private function cmd7 takes nothing returns nothing
        local unit u = GetOneSelectedPlayerUnit(GetTriggerPlayer())
        call BJDebugMsg("Unit name: " + GetUnitNormalName(u))
        set u = null
    endfunction
 
    /* Retrieves unit name */
    private function cmd8 takes nothing returns nothing
        local unit u = GetOneSelectedPlayerUnit(GetTriggerPlayer())
        call BJDebugMsg("Proper name: " + GetUnitNormalName(u))
        set u = null
    endfunction
 
    /* Checkes the unit state as it relates to the system */
    private function cmd9 takes nothing returns nothing
        local unit u = GetOneSelectedPlayerUnit(GetTriggerPlayer())
        if (HasUnitName(u)) then
            call BJDebugMsg("Has name")
        else
            call BJDebugMsg("No name")
        endif
        if (UnitTypeIsInPool(GetUnitTypeId(u))) then
            call BJDebugMsg("Unit type exists")
        else
            call BJDebugMsg("Unit type doesn't exist")
        endif
        set u = null
    endfunction
 
    /* Destroys UnitName (does not affect the current unit name though) */
    private function cmd10 takes nothing returns nothing
        local unit u = GetOneSelectedPlayerUnit(GetTriggerPlayer())
        call BJDebugMsg("Proper name: " + GetUnitNormalName(u))
        set u = null
    endfunction
 
    private function Main takes nothing returns nothing
        local string s = GetEventPlayerChatString()
        local integer i = 0
        loop
            exitwhen i == max + 1
            if (SubString(s, 0, len[i]) == commands[i]) then
                if (i == 0) then
                    call cmd0(SubString(s, len[i] + 1, 33))
                elseif (i == 1) then
                    call cmd1(SubString(s, len[i] + 1, 33))
                elseif (i == 2) then
                    call cmd2(SubString(s, len[i] + 1, 33))
                elseif (i == 3) then
                    call cmd3(SubString(s, len[i] + 1, 33))
                elseif(i == 4) then
                    call cmd4()
                elseif(i == 5) then
                    call cmd5()
                elseif(i == 6) then
                    call cmd6()
                elseif(i == 7) then
                    call cmd7()
                elseif(i == 8) then
                    call cmd8()
                elseif(i == 9) then
                    call cmd9()
                elseif(i == 10) then
                    call cmd10()
                endif
            endif
            set i = i + 1
        endloop
    endfunction
    private function Init takes nothing returns nothing
        local trigger t = CreateTrigger()
        call TriggerRegisterPlayerChatEvent(t, Player(0), "-", false)
        call TriggerAddAction(t, function Main)
 
        set commands[0] = "-setfirst"
        set len[0] = StringLength(commands[0])
        set commands[1] = "-setlast"
        set len[1] = StringLength(commands[1])
        set commands[2] = "-setuname"
        set len[2] = StringLength(commands[2])
        set commands[3] = "-setproper"
        set len[3] = StringLength(commands[3])
        set commands[4] = "-random"
        set len[4] = StringLength(commands[4])
        set commands[5] = "-getfirst"
        set len[5] = StringLength(commands[5])
        set commands[6] = "-getlast"
        set len[6] = StringLength(commands[6])
        set commands[7] = "-getuname"
        set len[7] = StringLength(commands[7])
        set commands[8] = "-getproper"
        set len[8] = StringLength(commands[8])
        set commands[9] = "-check"
        set len[9] = StringLength(commands[9])
        set commands[10] = "-destroy"
        set len[10] = StringLength(commands[10])
        set max = 10
 
    endfunction
endscope

 

[Pyrogasm]

This would help you load unit names from an external .txt file without having to use lua objectmerger calls: [vJASS] - FileIO

 

[MyPad]

1.) I think such a feature, if wanted, should be introduced in another library or trigger.
2.) If not yet recorded, default to the unit's name.
3.) That is a design feature, which is up to you to manage.
4 and 5.) I'm not sure I understand.

I will test this later..

 

[Pinzu]

This would help you load unit names from an external .txt file without having to use lua objectmerger calls: [vJASS] - FileIO

I didn't manage to run it, also i question if that would work outside a single player realm since everyone must have the file. However, imported files could work.

A solution I could offer is a solution like this:

        local NamePool namepool = NamePool.create()
        local string names = "
        Kendall Werner
        Raul Tindall
        Rodhlann Brent
        Jefrem Swett
        Hayo Dryden
        ...
        Wingate Burlingame
        Jefrem Swett
        Hayo Dryden
        Tyeson Harley
        Jan Lee
        Ogden Acton
        "
        call BJDebugMsg(names)
        call namepool.addAllNames(names)

But this solution is capped to 1024 or so characters per batch and would be a bit volatile since some special characters are longer than 1 byte.

 

[Pyrogasm]

i question if that would work outside a single player realm since everyone must have the file

The only computer that needs to have access to the name file is the computer that saves the map. If you save it and give it to a friend they will have unit names set up properly, but if they open it and try to save it again they will disappear. If you need to share the map with someone you could either import the file or save its text into a disabled trigger. This FileIO functionality I suggest helps the map developer who has many names they may want to change or edit on the fly, and they only must edit the .txt file before saving the map to push changes.

 

[Chaosy]

Yikes, that is a lot of code. That HAS to be inefficient somehow O-o

 

[Pinzu]

Yikes, that is a lot of code. That HAS to be inefficient somehow O-o

Depends on what you want to do, If you only want to give NPC names at start then yes, most of the code would be useless, and you could probably get away by only using the methods provided by NamePool (struct)

There is also lot of boiler plate code in the functions used to get/set firstname, lastname, unitname and stuff like that. All this could be done directly through the struct UnitName probably, but since units are not indexed i chose to use wrapper functions that the user can utilize rather than doing something like:

set unitname[unitIndex].firstname = entered substring call unitname[unitIndex].apply()

A option would be to add a static method to find UnitName struct based on a unit and then just put all the wrappers in there directly but it makes for uglier use. Example:

    private function OnSetLastName takes nothing returns nothing
        local player p = GetTriggerPlayer()
        local unit u = GetOneSelectedPlayerUnit(p)
        local string substr = GetLastPlayerChat(GetPlayerId(p)).subStr
 
        // This
        call SetUnitLastName(u, substr)
        // Becomes this and then it's not even checking if UnitName is null or not to allocate a new one.
        call UnitName.get(u).setLast(substr).apply(u)
 
        call BJDebugMsg("Setting Last Name: " + substr)
        set p = null
    endfunction

Finally you have the 80 lines of code which I've now lifted out.

hmm

  // Optional Code Below
    private function OnUnitEntersMap takes nothing returns nothing
        call SetUnitRandomName(GetTriggerUnit())
    endfunction
    private function OnDeath takes nothing returns nothing
        local unit u = GetTriggerUnit()
        if (HasUnitName(u)) then
            call DestroyUnitName(u)
        endif
        set u = null
    endfunction
    private function FilterUnits takes nothing returns boolean
        return systemEnabled and uTable.has(GetUnitTypeId(GetFilterUnit()))
    endfunction
    private function Setup takes nothing returns nothing
        local timer tmr = GetExpiredTimer()
        local unit u
        local group g
        local trigger t
        local integer i
        /*
        *   Optional 1 - Allocate a unit name for all preplaced and configured units. Remove the
        *   textmacro below if you do  not wiish to include this feature.
        */
        set t = CreateTrigger()
        call TriggerRegisterEnterRegion(t, WorldBounds.worldRegion, Filter(function FilterUnits))
        call TriggerAddAction(t, function OnUnitEntersMap)
        /*
         *  Optional 2 - Allocates a unit name on entering to the world.
         *  If this does not suit your sensibilities you only have to remove this and call
         *  "SetUnitRandomName" for each and every unit you want named later.
         *  Remove the textmacro below if you have your own unit index events or for some other
         *  reason do not wish to include this feature.
         */
        set g = CreateGroup()
        call GroupEnumUnitsInRect(g, WorldBounds.world,  Filter(function FilterUnits))
        loop
            set u = FirstOfGroup(g)
            exitwhen u == null
            /* Insert your filter here */
            if (true) then
                call SetUnitRandomName(u)
            endif
            call GroupRemoveUnit(g, u)
        endloop
        call DestroyGroup(g)
        /*
         *  Optional 3 - Deallocates unit names on death
         *  if this does not suit your needs simply call "DestroyUnitName" when you wish to
         *  deallocate the unit, on deindex event as an example. And again remove the textmacro
         *  below.
         */
        set g = CreateGroup()
        call GroupEnumUnitsInRect(g, WorldBounds.world,  Filter(function FilterUnits))
        call PauseTimer(tmr)
        call DestroyTimer(tmr)
        set t = null
        set g = null
        set u = null
        set tmr = null
    endfunction
 
    private function Init takes nothing returns nothing
        local timer tmr = CreateTimer()
        set uTable = Table.create()
        call TimerStart(tmr, 0.03   , false, function Setup)
        set tmr = null
    endfunction

A possible solution could be to devide the system in 2, one for the random NPC names, the other for a extended version of unit name manipulation. But that's not something I would look forward to do now that they are so closely interlinked... ^^

Updated: 0.14
Implemented some of MyPads suggested changes and attempted to optimize a few things.

 

[MyPad]

vJASS version

Notes:

• The global table uTable is not initialized within a module. This could cause unintended behavior with systems that use it within either a struct or a library initialization.
• Using uTable as both the unit instance mapper (to UnitName instances) and unit type instance mapper (NamePool instances) is not likely to be at risk to the possibility of collisions within entries, but using two separate instances ensures safety of the user. (Assume a unit with the rawcode within the range of 1049072, not very likely but can be messy)
• With the current setup of the unit type instance mapper, it seems that one cannot add it to at least two instances without causing it to be removed on one instance. Is this intended?
• The boundary checks for the integer parameter in method NamePool(1).getName could print out a debug message in debug mode, since the returned value without it is likely going to be " ".
• Method NamePool(1).addName could just use the returned result from addProperName. (This saves a line)
• On a onDestroy method in struct NamePool, it is unlikely for the unit type instances stored therein to be unmapped from the global variable uTable. This means that certain unit types mapped to that instance will not be removed as well. (Assume instance 1 mapped out unit types hfoo, and hpea. If instance 1 is destroyed, hfoo and hpea stay in the global table uTable.)
• More on the onDestroy method, you can just directly declare it as destroy. The downside is the manual declaration of deallocation, which shouldn't be too much. (Applies to both UnitName and NamePool)
• Using a doubly-linked list may benefit the system in the long run. (It makes removal and insertion a breeze and is a possible solution to the problem in the onDestroy method). See [Containers] List<T> by Bannar.
• Oddly enough, the recommended libraries aren't optional nor mandatory. Documentation on those particular libraries, if not optional or mandatory, should be moved to another library which uses said libraries.

Nitpicks:

• I suggest renaming UnitTypeIsInPool to IsUnitTypeInPool. It seems more intuitive that way.

Both GUI and vJASS version:

I think UnitEvent (for GUI by Bribe) or UnitDex (by TriggerHappy) are good replacements for the UnitIndexer requirement (unless its' by Nestharus, that is basically good enough on what it does, and maybe a bit better.)

 

[Pinzu]

vJASS version

Notes:

...

1) Okay added onInit to NamePool.

2) Okidoks.

3) It's intended. If you could add your unit-type to two pools there becomes a problem of determining which pool to draw the name from. So I figured best keep it to the last pool assigned.

4) It would return "" (null) But i can add debug call BJDebugMsg("error - NamePool.getName:IndexOutOfBounds") if you like.

5) I made it return thistype so that you can write like this: call namepool.addName(...).addName(...).addName() and so on.

6) Ah good catch with UnitPool;onDestroy, fixed.

solution

method onDestroy takes nothing returns nothing
            local integer i = 0
            loop
                exitwhen i == .typesIndex
                call uTable.remove(.types[i])
                set i = i + 1
            endloop
            call .names.destroy()
            call .types.destroy()
        endmethod

7)

8) I've seen ListT by banner and it didn't have IndexOf (or whatever my qualms were) and I figured it would just add another dependency for little benefit at this point. I'll consider it in the future if I find another scenario where it would be needed.

On UnitIndexer, I have thought about using a UnitIndexer for storing the UnitNames rather than Table. But that argument is old, and I am rather lazy, so I prefer not to include any UnitIndexers in the vJass version unless people think that it would be a huge negative. As for the GUI one I'll be sticking to Bribe there I reckon, or in any case as much as possible decouple the unit indexer from the system code. A option would be to put most of the functions inside the UnitName struct thus the unit.id could be used to modify the unit. But I'm not a fan of this solution.

Thanks for your long and rather extensive review! I appreciate it a lot.

 

[MyPad]

Looks like I had inadvertently changed the name from NamePool to UnitPool when reviewing . Sorry for the confusion.

 

[Pinzu]

Looks like I changed the name from NamePool to UnitPool when reviewing . Sorry for the confusion.

It was funny at first, but then I started writing it everywhere. I curse you and your shenanigans!

Posted 0.15. I'm not completely done though as I'm still working on splitting the system in 2 and perhaps implementing ListT for preventing randomization of same unit name twice (and reducing code base I hope). However I'm still not sure I want this dependency :d

 

[Pinzu]

I finished a spread sheet script for name to code conversion. If anyone could re-submit it for me on google sheet and provide a link it would be great (Message me).

To use it the user would have to clone it to their google drive and just modify the relevant cells and then copy the generated code into their map.

Also, I've decided to remove all the getters and setters (for different name-types) from the core of the system. It will be in a secondary library which then would be optional.

Update: v 1.0
- The GUI version has made a comeback with patch 1.30 so they now share the same library.
- Divided the system into two parts to please Chaosy.
- Removed alot of useless code.

 

[MyPad]

Test Environment:

As the test map started, 6 error messages popped up. An error message popping up on startup could cast some doubt on the reliability of the resource, so I had managed to trace it down to the footmen and the Blademaster. It turns out they were not added into the setup trigger.

I am reporting this part as something that needs to be addressed.

Notes:

• Destroying the unit's name does not actually reset the given name. Is this intended? (Tested on units. Link to the video footage: Here) {Needs fix}
• The logic of adding of names to units on map initialization could be outsourced to an existing library that catches unit creation. (See [System] UnitDex - Unit Indexer)
  {Not so urgent fix}

Nitpicks:

• None

Status:

• Awaiting Update

 

[Pinzu]

*cough* The double naming is due to having multiple events fiering for indexing in the test map. Seem to have forgotten to disable the GUI OnUnitIndexEvent, my bad.

As for the debug messages I could add a check function for if the unit type exists in a pool. It's not really an error though as it simply returns false if it failed to find a name pool.

I'm not sure if the destroy method should reset the name to whatever, it's just to free the associated memory from that unit, though it would be logical use that destroy resets the name I question the utility of such an implementation. I suppose I could save unit-type names in a table as they are first managed by the system, hero names would also have to be saved.

And on the setup/configuration part well Im unsure. There are currently 2 types of setups either one calls ChangeToRandomName or SetUnitRandomName it's not the same thing. The first simply will change the name and the latter will also configure it with the extended version. So if you use ChangeUnitFullName and then use a command like -setfirst Timmy, you will get double names and it won't work properly, but if you instead use SetUnitRandomName and then use the command it will work.

 

[MyPad]

When testing the commands, the one on top is the proper name, while the one in the bottom is the unit name, although that is not what I had intended to report.

 

[Pinzu]

When testing the commands, the one on top is the proper name, while the one in the bottom is the unit name, although that is not what I had intended to report.

You accuse me of false advertising? ^^

Startup changes

scope NamingUnits initializer Init
 
    /* Caution:
    ChangeToRandomName does not work exactly the same as SetUnitRandomName. The former
    will simply rename the unit WITHOUT saving the unit name data. Using any of the extended
    functions AFTER using ChangeToRandomName will NOT work together properly, so keep that in mind
    when you chose how you want ur units to be named.
 
    The reason for the separation, is if you don't want to allocate memory that you won't need and
    simply want to rename the unit once.
    */
 
    function onIndex takes nothing returns boolean
    local unit u = GetIndexedUnit()
    // EX 1
    //if UnitHasNamePool(u) then
    //    call ChangeToRandomName(u)
    //endif
    // EX 2
    //if not ChangeToRandomName(u) then
        // Failed to rename the unit due to it not having a name pool
    //endif
 
    // EX 3 (Recomended)
    //call ChangeToRandomName(u)
 
    // Extremly optional but will save the units current name the first time it's called.
    call SaveDefaultName(u)
    if UnitHasNamePool(u) then
        call SetUnitRandomName(u)
    endif
        set u = null
        return false
    endfunction
    function onDeindex takes nothing returns boolean
    local unit u = GetIndexedUnit()
    call DestroyUnitName(u)        // Only necessary if using any of the extended features.
        set u = null
        return false
    endfunction
    private function Init takes nothing returns nothing
        call RegisterUnitIndexEvent(Filter(function onIndex)  , EVENT_UNIT_INDEX)
        call RegisterUnitIndexEvent(Filter(function onDeindex), EVENT_UNIT_DEINDEX)
    endfunction
endscope

Changes 1.1.2

- Changed example setup to use UnitDex
- If the unit has a saved default name it will be reset when destroy is called.
- Removed the debug message, if one wants to catch errors they just have to use the boolean that is returned.
- Added: function UnitHasNamePool takes unit u returns boolean
- Added: function SaveDefaultName takes unit u returns nothing
- Made the extended version be the default for the test map
- Removed Bribe's Unit Indexer from the GUI version.
- Removed all none configured units from the test map (except for MK)
- Added GUI trigger for changing unit names manually.
- Modifed the GUI setup slightly.
- Fixed a bug where using the random command would only change firstname after the setproper command had been used.
- Fixed so that you can now enter longer last names than one word.
- Added constant to UnitnamingExtended to toggle if the default name should be saved automatically whenver a set-function is used (default is false).

Updated: v 1.1

Note 1: if the indention looks bad I blame the vanilla editor and having to copy code over from notepad.

 

[MyPad]

Tested the demo map again. This time, the system works with no issues that I have had previously encountered.

Notes:

• Destroying the unit's name does not actually reset the given name. Is this intended? (Tested on units. Link to the video footage: Here) {Needs fix}
• The logic of adding of names to units on map initialization could be outsourced to an existing library that catches unit creation. (See [System] UnitDex - Unit Indexer)
  {Not so urgent fix}

These issues are now resolved, and everything seems to be in order, from the code itself, to the documentation. There is no reason not to approve this any longer. However, any improvements to the system are welcome.

Status:

• Approved

 

[Pinzu]

Updated to 1.2b

Removed most of the vjass examples of how to use and instead created a GUI compatible command use so both can learn how to use it.

Added automatic setup for handling Unit Enter Map and Name Preplaced Units. It works for the following scenarios:

1) Library used UnitIndexerGUI (bribe)
2) Library used UnitDex
3) No UnitIndexer and no ExtendedFeatures

The only scenario that won't automatically setup properly is if you have extended features enabled but it didn't find any UnitIndexer. The reason for this is that Extended Features require data to be deallocated from units (i.e deindex events) this must then be handled manually by the user.

Spoiler: v1.2

v 1.2
- Merged tables defaultUnitName and defaultHeroName into 1
- Merged library into same file with a static if to enable extended features
- Made the GUI and Jass version work together without any major conflicts
- Removed most vJass example use and instead created a GUI version
- Included optional UnitDex
- Automatically handles preplaced units and enter map event
- Can be configured to automatically setup simple unit names
- Can be configured to automatically save default names (not recomended)

Update fixed a few minor bugs

Spoiler: v.12b

- Fixed a bug with hiding unit type names causing a crash.
- Hiding unit names (config) now also work without extended features.
- Hiding unit names but changing unit-type name will now work when using extended features.
- Fixed a bug with names not being configured properly due to order of onInit

I have an idea for including a third slot for unit kill count or rank display in the naming but I'm not sure if it fits in this library. Also, it probably would be possible to encode the different names inside the unit like so:

FirstName|r|rLastName|nUnit Name

Thus removing the need to store them inside a hashtabl, but I'm not sure if I have considered all the cases in which this can break. To retrieve the name one would simply loop through the string.