PUI 6.0

//==============================================================================
//  PUI -- Perfect Unit Indexing by Cohadar -- v6.1
//==============================================================================
//
//  PURPOUSE:
//       * Extending UnitUserData()
//       * This is basically perfect hashing algorithm for units
//
//  HOW TO USE:
//       * You have two functions at your disposal: 
//           GetUnitIndex(unit) -> index
//           GetIndexUnit(index) -> unit
//
//       * Put you custom unit properties in struct that extends arrays.
//         Use unit index as id of that struct.
//         There is an example of this in demo map.
//         
//  PROS:
//       * Unit indexes are assigned only to units that actually need them.
//       * Unit index will be automatically recycled when unit is removed from the game.
//       * Automatically detects null unit handles and removed unit handles (in debug mode)
//
//  CONS:
//       * This system needs exclusive access to UnitUserData
//
//  DETAILS:
//       * Uses internal vJass struct index allocation/deallocation algorithm.
//       * Periodically checks and recycles unit indexes
//
//  HOW TO IMPORT:
//       * Just create a trigger named PUI
//       * convert it to text and replace the whole trigger text with this one
//
//==============================================================================


library PUI initializer Init

//==============================================================================
globals    
    // maximum number of indexed units on your map at a single moment of time
    private constant integer MAX_INDEXES = 1024  // up to 8192
    
    // period of recycling, 32 indexes per second
    private constant real PERIOD = 0.03125   
    
    // current check index
    private integer C = 0 
endglobals

//==============================================================================
// Using internal struct algorithm for index allocation/dealocation
// This way I don't have to write messy code of my own
//==============================================================================
private struct UnitIndex
    unit u
    
    //----------------------------------------------------------
    static method create takes unit whichUnit returns UnitIndex
        local UnitIndex index 
        
        // check for null unit handle
        debug if whichUnit == null then
        debug     call BJDebugMsg("|c00FF0000ERROR: PUI - Index requested for null unit")
        debug     return 0
        debug endif
        
        set index = UnitIndex.allocate()
        set index.u = whichUnit
        call SetUnitUserData(whichUnit, index)
        
        // check for removed unit handle
        debug if GetUnitUserData(whichUnit) == 0 then
        debug     call BJDebugMsg("|c00FFCC00WARNING: PUI - Bad unit handle")
        debug     return 0
        debug endif        
        
        return index
    endmethod
    
    //----------------------------------------------------------
    static method Recycler takes nothing returns boolean
        local UnitIndex index = C
        set C = C + 1
        if C == MAX_INDEXES then
            set C = 0
        endif
        if index.u != null then
            if (GetUnitUserData(index.u) == 0) then
                set index.u = null
                call index.destroy()
            endif
        endif
        return false
    endmethod
endstruct

//==============================================================================
//  Returns index of some unit, if unit has no index it gets a new one.
//==============================================================================
function GetUnitIndex takes unit whichUnit returns integer
    local UnitIndex index = GetUnitUserData(whichUnit)
    if index == 0 then
        set index = UnitIndex.create(whichUnit)
    endif
    return index
endfunction

//==============================================================================
//  Return unit that has specified index, or null in no such unit exists.
//==============================================================================
function GetIndexUnit takes integer index returns unit
    local UnitIndex i = index
    if i.u != null then
        if GetUnitUserData(i.u) == index then
            return i.u
        endif
    endif
    return null
endfunction

//==============================================================================
private function Init takes nothing returns nothing
    local trigger trig = CreateTrigger()
    call TriggerRegisterTimerEvent(trig, PERIOD, true)
    call TriggerAddCondition(trig, Condition(function UnitIndex.Recycler))
endfunction

endlibrary

//===========================================================================
//  We define 2 integer properties for any unit,
//  number of deaths and number of kills.
//===========================================================================
scope Example initializer Init

//===========================================================================
private struct Data extends array
    unit whichUnit
    integer deaths
    integer kills
    
    // reset instead of create because array structs are never created
    method reset takes unit whichUnit returns nothing
        set .whichUnit = whichUnit
        set .deaths = 0
        set .kills = 0
    endmethod
    
    // In case unit handle gets recycled we need to reset the data
    static method Get takes unit whichUnit returns Data
        local Data data = GetUnitIndex(whichUnit)
        if data.whichUnit != whichUnit then
            call data.reset(whichUnit)
        endif
        return data
    endmethod
endstruct

//===========================================================================
private function Actions takes nothing returns nothing
    local unit victim = GetDyingUnit()
    local unit killer = GetKillingUnit()
    
    local Data data = Data.Get(victim)
    set data.deaths = data.deaths + 1
    
    if killer != null then
        set data = Data.Get(killer)
        set data.kills = data.kills + 1
        call TextTag_Unit(killer,I2S(data.kills), "|c00FFFFFF")
    endif
    
    set victim = null
    set killer = null
endfunction

//===========================================================================
private function Conditions takes nothing returns boolean
    return true
endfunction

//===========================================================================
private function Init takes nothing returns nothing
    local trigger trig = CreateTrigger()
    call TriggerRegisterAnyUnitEventBJ( trig, EVENT_PLAYER_UNIT_DEATH )
    call TriggerAddCondition( trig, Condition( function Conditions ) )
    call TriggerAddAction( trig, function Actions )
endfunction

endscope

    static method create takes unit whichUnit returns UnitIndex
        local UnitIndex index 
        
        // check for invalid unit handle
        debug if GetUnitTypeId(whichUnit) == 0 then
        debug     call BJDebugMsg("|c00FF0000ERROR: PUI - Index requested for invalid unit")
        debug     return 0
        debug endif
        
        set index = UnitIndex.allocate()
        set index.u = whichUnit
        call SetUnitUserData(whichUnit, index)
        
        return index
    endmethod

//===========================================================================
//  We define 2 integer properties for any unit,
//  number of deaths and number of kills.
//===========================================================================
scope Example initializer Init

//===========================================================================
private struct Data extends array
    unit whichUnit
    integer deaths
    integer kills
    
    method reset takes unit whichUnit returns nothing
        set .whichUnit = whichUnit
        set .deaths = 0
        set .kills = 0
    endmethod
    
    static method Get takes unit whichUnit returns Data
        local Data data = GetUnitIndex(whichUnit)
        if data.whichUnit != whichUnit then
            call data.reset(whichUnit)
        endif
        return data
    endmethod
endstruct

//===========================================================================
private function Actions takes nothing returns nothing
    local unit victim = GetDyingUnit()
    local unit killer = GetKillingUnit()
    
    local Data data = Data.Get(victim)
    set data.deaths = data.deaths + 1
    
    if killer != null then
        set data = Data.Get(killer)
        set data.kills = data.kills + 1
        call TextTag_Unit(killer,I2S(data.kills), "|c00FFFFFF")
    endif
endfunction

//===========================================================================
private function Conditions takes nothing returns boolean
    return true
endfunction

//===========================================================================
private function Init takes nothing returns nothing
    local trigger trig = CreateTrigger()
    call TriggerRegisterAnyUnitEventBJ( trig, EVENT_PLAYER_UNIT_DEATH )
    call TriggerAddCondition( trig, Condition( function Conditions ) )
    call TriggerAddAction( trig, function Actions )
endfunction

endscope

//===========================================================================
//  We define 2 integer properties for any unit,
//  number of deaths and number of kills.
//===========================================================================
scope Example initializer Init

//===========================================================================
private struct Data
    integer deaths=0
    integer kills=0

    implement AutoCreate
    implement AutoDestroy
endstruct

//===========================================================================
private function Actions takes nothing returns nothing
    local unit victim = GetDyingUnit()
    local unit killer = GetKillingUnit()
    
    local Data data = Data[victim]
    set data.deaths = data.deaths + 1

    if killer != null then
        set data = Data[killer]
        set data.kills = data.kills + 1
        call TextTag_Unit(killer,I2S(data.kills), "|c00FFFFFF")
    endif
endfunction

//===========================================================================
private function Conditions takes nothing returns boolean
    return true
endfunction

//===========================================================================
private function Init takes nothing returns nothing
    local trigger trig = CreateTrigger()
    call TriggerRegisterAnyUnitEventBJ( trig, EVENT_PLAYER_UNIT_DEATH )
    call TriggerAddCondition( trig, Condition( function Conditions ) )
    call TriggerAddAction( trig, function Actions )
endfunction

endscope