Snippet Trackable2

[wraithseeker]

//* Table library by Vexorian

library Table initializer init
//***************************************************************
//* Table object
//* ------------
//*
//*   set t=Table.create() - instanceates a new table object
//*   call t.destroy()     - destroys it
//*   t[1234567]           - Get value for key 1234567
//*                          (zero if not assigned previously)
//*   set t[12341]=32      - Assigning it.
//*   call t.flush(12341)  - Flushes the stored value, so it
//*                          doesn't use any more memory
//*   t.exists(32)         - Was key 32 assigned? Notice
//*                          that flush() unassigns values.
//*   call t.reset()       - Flushes the whole contents of the
//*                          Table.
//*
//*   call t.destroy()     - Does reset() and also recycles the id.
//*
//*   If you use HandleTable instead of Table, it is the same
//* but it uses handles as keys, the same with StringTable.
//*
//***************************************************************

//=============================================================
    globals
        private constant integer MAX_INSTANCES=8100 //400000

    //=========================================================
        private gamecache gc
    endglobals

    private struct GTable[MAX_INSTANCES]
        method reset takes nothing returns nothing
            call FlushStoredMission(gc,I2S(this))
        endmethod

        private method onDestroy takes nothing returns nothing
            call FlushStoredMission(gc,I2S(this))
        endmethod
    endstruct

    //Hey: Don't instanciate other people's textmacros that you are not supposed to, thanks.
    //! textmacro Table__make takes name, type, key
    struct $name$ extends GTable

        method operator [] takes $type$ key returns integer
            return GetStoredInteger(gc,I2S(this),$key$)
        endmethod

        method operator []= takes $type$ key, integer value returns nothing
            call StoreInteger(gc,I2S(this),$key$, value)
        endmethod

        method flush takes $type$ key returns nothing
            call FlushStoredInteger(gc,I2S(this),$key$)
        endmethod

        method exists takes $type$ key returns boolean
            return HaveStoredInteger(gc,I2S(this),$key$)
        endmethod

    endstruct
    //! endtextmacro



    private function H2I takes handle h returns integer
        return h
        return 0
    endfunction
    
    //! runtextmacro Table__make("Table","integer","I2S(key)" )
    //! runtextmacro Table__make("StringTable","string","key" )
    //! runtextmacro Table__make("HandleTable","handle","I2S(H2I(key))" )

    //=============================================================
    // initialize it all.
    //
    private function init takes nothing returns nothing
        call FlushGameCache(InitGameCache("libtable.gc"))
        set gc=InitGameCache("libtable.gc")
    endfunction
endlibrary

Here is table and it works cool as it is so I don't get why you want to modify it at all.

 

[Jesus4Lyf]

I'm sorry, but I MUST experiment. I think I can make it work exactly the same, but faster. :thup:

I may be wrong, but at this point, I'm sure hopeful. Off to the lab!

 

[Azlier]

While Jesus works, I announce that the Table version is up. Safer, but slower.

 

[wraithseeker]

Why is table slow? I heard that gamecaches are quite fast too.

 

[Azlier]

Unless you need MAAAAAXXXX EFFFFIIICCCCIIIENNNCCCYYY, game cache is just fine. Oh, and you probably would like a standardized cache like what Table uses because the limit on game caches is 256. Otherwise, I hear game cache is miserably slow.

 

[Jesus4Lyf]

http://www.thehelper.net/forums/showthread.php?t=124016
I'm not making any claims yet, as I haven't tested anything except that it seems to work. Give it a shot. Attaching to strings with O(1) complexity and no gamecache.

This is the problem when I get excited... XD

 

[Sim]

Nice Table X Jesus, but please guys discuss the trackables system in this thread, thanks.

 

[Jesus4Lyf]

We got a little excited there, excuse us.

Azlier! Start realising you don't need to attach to trackables! Before I re-realise your snippet!

You said you need to realise things faster, right?

Investigate!

 

[Azlier]

I know H2I and only H2I. I do want to use Table X, though. Was a great idea you had that I realized too late .

The things you gave me about attaching to triggers limits the amount of events on a trigger. I can't have that. I still don't see the problem with attaching the trackables.

Oh, and very minor update. GetTrackedPlayer() no longer requires an argument (I thought it looked silly).

 

[Jesus4Lyf]

>The things you gave me about attaching to triggers limits the amount of events on a trigger. I can't have that.

Linked-lists gets around that. But you probably don't know how to use those.

Table-X actually already works. You may use it, as long as you don't have to flush a whole table. Besides, you should always be able to just copy the latest version of Table-X in because it's meant to support Table's original interface as if it WAS Table. So by all means, give it a shot!

I still reckon GetTrackedPlayer() should be GetTrackingPlayer(). What do you think?

 

[Azlier]

I'll try Table X when it's complete. For now, I'll use the wonderful string tactic it uses.

Speaking of which, another minor update. No longer requires MIN_HANDLE_ID setting.

And for Tracking player, I thought about that. The way I see it, trackables track the mouse actions of a player. Thus, the player is being tracked. TrackedPlayer.

 

[Azlier]

Bump, and documented the functions (I knew I forgot something!)

 

[Azlier]

Added UserData for trackables, because someone actually wanted such a crazy thing :nuts:.

Table version is most recommended. The old one is slower than game cache, and much less safe.

 

[Sevion]

Oh, sure. When I'm in the process of making changes for EGUI with the "new" versions, you update it again... -_-'

 

[Azlier]

No worries. GUI users have no need for trackable UserData.

The real thing I'm trying to fix is a small O(n) search. Tiny, but unacceptable! Must find way to fix without bloating code substantially, yes.

 

[Sevion]

Well, after debating much with myself, I decided to port EGUI to using the struct in T2 instead of trying to make a bunch of EGUI wrappers for the Trackables since you have 12 in each set anyways.

 

[Azlier]

Why would you want to use raw trackables over the structs themselves? Those functions I have essentially are EGUI wrappers.

 

[Sevion]

Because GUI users would think it easier to use Trackables over integers (what structs ultimately parse into) and that Create Trackable, Set T = Last Created Trackable is easier than Set I = Create Trackable.

They wouldn't understand it much unless they knew some kind of programming language in which case they should be using (v)JASS.

 

[Azlier]

You want a lastCreatedTrackable variable? Simple. Hold on for a few seconds...

Spoiler

library Trackable2 initializer Init requires Table

private keyword Data

globals
    private HandleTable table
    private Data array Trackables
    private trackable TriggerTrackable
    private boolexpr SetLastBool
    private Data TriggerTrackable2
    Data lastCreatedTrackable2
endglobals

private function SetLast takes nothing returns boolean
    set TriggerTrackable = GetTriggeringTrackable()
    set TriggerTrackable2 = table[TriggerTrackable]
    //Make this return false if your trackable triggers are running on conditions only.
    return true
endfunction

private struct Data
    trackable array Trackers [12]
    real X
    real Y
    real Z
    real Facing
    string Model
    player ForPlayer = null
    integer UserData = 0
endstruct

function CreateTrackable2 takes string modelPath, real x, real y, real z, real facing returns Data
    local Data d = Data.create()
    local string s = ""
    local destructable platform = CreateDestructableZ('OTip',x,y,z,0.00,1,0)
    local integer i = 11
    loop
        exitwhen i < 0
        if GetLocalPlayer() == Player(i) then
            set s = modelPath
        else
            set s = ""
        endif
        set d.Trackers<i> = CreateTrackable(s, x, y, facing)
        set table[d.Trackers<i>] = d
        set i = i - 1
    endloop
    set d.X = x
    set d.Y = y
    set d.Z = z
    set d.Facing = facing
    set d.Model = modelPath
    call RemoveDestructable(platform)
    set platform = null
    set lastCreatedTrackable2 = d
    return d
endfunction

function CreateTrackable2ForPlayer takes string modelPath, real x, real y, real z, real facing, player forPlayer returns Data
    local Data d = Data.create()
    local string s = modelPath
    local destructable platform = CreateDestructableZ(&#039;OTip&#039;,x,y,z,0.00,1,0)
    if GetLocalPlayer() != forPlayer then
        set s = &quot;&quot;
    endif
    set d.Trackers[1] = CreateTrackable(s, x, y, facing)
    set table[d.Trackers[1]] = d
    set d.ForPlayer = forPlayer
    set d.X = x
    set d.Y = y
    set d.Z = z
    set d.Facing = facing
    set d.Model = modelPath
    call RemoveDestructable(platform)
    set platform = null
    set lastCreatedTrackable2 = d
    return d
endfunction

function TriggerRegisterTrackable2HitEvent takes trigger whichTrigger, Data d returns nothing
    local integer i
    if d.ForPlayer == null then
        set i = 11
        loop
            exitwhen i &lt; 0
            call TriggerRegisterTrackableHitEvent(whichTrigger, d.Trackers<i>)
            set i = i - 1
        endloop
    else
        call TriggerRegisterTrackableHitEvent(whichTrigger, d.Trackers[1])
    endif
    call TriggerAddCondition(whichTrigger, SetLastBool)
endfunction

function TriggerRegisterTrackable2TrackEvent takes trigger whichTrigger, Data d returns nothing
    local integer i
    if d.ForPlayer == null then
        set i = 11
        loop
            exitwhen i &lt; 0
            call TriggerRegisterTrackableTrackEvent(whichTrigger, d.Trackers<i>)
            set i = i - 1
        endloop
    else
        call TriggerRegisterTrackableTrackEvent(whichTrigger, d.Trackers[1])
    endif
    call TriggerAddCondition(whichTrigger, SetLastBool)
endfunction

function GetTriggeringTrackable2 takes nothing returns Data
    return TriggerTrackable2
endfunction

function GetTrackedPlayer takes nothing returns player
    local integer i
    //So very sorry about this O(n) search. Trying to remedy this.
    if TriggerTrackable2.ForPlayer == null then
        set i = 11
        loop
            exitwhen i &lt; 0
            if TriggerTrackable == TriggerTrackable2.Trackers<i> then
                return Player(i)
            endif
            set i = i - 1
        endloop
    else
        return TriggerTrackable2.ForPlayer
    endif
    return null
endfunction

function SetTrackable2Data takes Data whichTrackable, integer whatData returns nothing
    set whichTrackable.UserData = whatData
endfunction

function GetTrackable2Data takes Data whichTrackable returns integer
    return whichTrackable.UserData
endfunction

//! textmacro Trackable2_Macro takes NAME, TYPE
function GetTrackable2$NAME$ takes Data which returns $TYPE$
    return which.$NAME$
endfunction
//! endtextmacro

//! runtextmacro Trackable2_Macro (&quot;X&quot;, &quot;real&quot;)
//! runtextmacro Trackable2_Macro (&quot;Y&quot;, &quot;real&quot;)
//! runtextmacro Trackable2_Macro (&quot;Z&quot;, &quot;real&quot;)
//! runtextmacro Trackable2_Macro (&quot;Facing&quot;, &quot;real&quot;)
//! runtextmacro Trackable2_Macro (&quot;Model&quot;, &quot;string&quot;)
//! runtextmacro Trackable2_Macro (&quot;ForPlayer&quot;, &quot;player&quot;)

private function Init takes nothing returns nothing
    set table = HandleTable.create()
    set SetLastBool = Condition(function SetLast)
endfunction
endlibrary</i></i></i></i></i>

Besides, you never have to let the EGUIers know that Trackable2's are integers. It'sa secret.

EDIT: Could someone change the thread prefix to [System]? Doesn't seem to be a snippet.

 

[Sevion]

Hmm. I believe I've finally "finished" implementing T2.

Anyone want to double check?

library Trackable2 initializer Init requires Table

private keyword Data

globals
    private HandleTable table
    private Data array Trackables
    private trackable TriggerTrackable
    private boolexpr SetLastBool
    private Data TriggerTrackable2
    Data bj_lastCreatedTrackable2
endglobals

private function SetLast takes nothing returns boolean
    set TriggerTrackable = GetTriggeringTrackable()
    set TriggerTrackable2 = table[TriggerTrackable]
    //Make this return false if your trackable triggers are running on conditions only.
    return true
endfunction

private struct Data
    trackable array Trackers [12]
    real X
    real Y
    real Z
    real Facing
    location Loc
    string Model
    player ForPlayer = null
    integer UserData = 0
endstruct

function CreateTrackable2 takes string modelPath, real x, real y, real z, real facing returns Data
    local Data d = Data.create()
    local string s = ""
    local destructable platform = CreateDestructableZ('OTip',x,y,z,0.00,1,0)
    local integer i = 11
    loop
        exitwhen i < 0
        if GetLocalPlayer() == Player(i) then
            set s = modelPath
        else
            set s = ""
        endif
        set d.Trackers<i> = CreateTrackable(s, x, y, facing)
        set table[d.Trackers<i>] = d
        set i = i - 1
    endloop
    set d.X = x
    set d.Y = y
    set d.Z = z
    set d.Loc = Location(x,y)
    set d.Facing = facing
    set d.Model = modelPath
    set bj_lastCreatedTrackable2 = d
    call RemoveDestructable(platform)
    set platform = null
    return d
endfunction

function CreateTrackableEGUI takes string modelPath, location loc, real facing returns Data
    return CreateTrackable2(modelPath, GetLocationX(loc), GetLocationY(loc), GetLocationZ(loc), facing)
endfunction

function CreateTrackable2ForPlayer takes string modelPath, real x, real y, real z, real facing, player forPlayer returns Data
    local Data d = Data.create()
    local string s = modelPath
    local destructable platform = CreateDestructableZ(&#039;OTip&#039;,x,y,z,0.00,1,0)
    if GetLocalPlayer() != forPlayer then
        set s = &quot;&quot;
    endif
    set d.Trackers[1] = CreateTrackable(s, x, y, facing)
    set table[d.Trackers[1]] = d
    set d.ForPlayer = forPlayer
    set d.X = x
    set d.Y = y
    set d.Z = z
    set d.Loc = Location(x,y)
    set d.Facing = facing
    set d.Model = modelPath
    set bj_lastCreatedTrackable2 = d
    call RemoveDestructable(platform)
    set platform = null
    return d
endfunction

function TriggerRegisterTrackable2HitEvent takes trigger whichTrigger, Data d returns nothing
    local integer i
    if d.ForPlayer == null then
        set i = 11
        loop
            exitwhen i &lt; 0
            call TriggerRegisterTrackableHitEvent(whichTrigger, d.Trackers<i>)
            set i = i - 1
        endloop
    else
        call TriggerRegisterTrackableHitEvent(whichTrigger, d.Trackers[1])
    endif
    call TriggerAddCondition(whichTrigger, SetLastBool)
endfunction

function TriggerRegisterTrackable2TrackEvent takes trigger whichTrigger, Data d returns nothing
    local integer i
    if d.ForPlayer == null then
        set i = 11
        loop
            exitwhen i &lt; 0
            call TriggerRegisterTrackableTrackEvent(whichTrigger, d.Trackers<i>)
            set i = i - 1
        endloop
    else
        call TriggerRegisterTrackableTrackEvent(whichTrigger, d.Trackers[1])
    endif
    call TriggerAddCondition(whichTrigger, SetLastBool)
endfunction

function GetTriggeringTrackable2 takes nothing returns Data
    return TriggerTrackable2
endfunction

function IsTriggerTrackable takes Data d returns boolean
    return d == TriggerTrackable2
endfunction

function GetTrackedPlayer takes nothing returns player
    local integer i
    //So very sorry about this O(n) search. Trying to remedy this.
    if TriggerTrackable2.ForPlayer == null then
        set i = 11
        loop
            exitwhen i &lt; 0
            if TriggerTrackable == TriggerTrackable2.Trackers<i> then
                return Player(i)
            endif
            set i = i - 1
        endloop
    else
        return TriggerTrackable2.ForPlayer
    endif
    return null
endfunction

function GetLastCreatedTrackable2 takes nothing returns integer
    return bj_lastCreatedTrackable2
endfunction

function SetTrackable2Data takes Data whichTrackable, integer whatData returns nothing
    set whichTrackable.UserData = whatData
endfunction

function GetTrackable2Data takes Data whichTrackable returns integer
    return whichTrackable.UserData
endfunction

//! textmacro Trackable2_Macro takes NAME, TYPE
function GetTrackable2$NAME$ takes Data which returns $TYPE$
    return which.$NAME$
endfunction
//! endtextmacro

//! runtextmacro Trackable2_Macro (&quot;X&quot;, &quot;real&quot;)
//! runtextmacro Trackable2_Macro (&quot;Y&quot;, &quot;real&quot;)
//! runtextmacro Trackable2_Macro (&quot;Z&quot;, &quot;real&quot;)
//! runtextmacro Trackable2_Macro (&quot;Loc&quot;, &quot;location&quot;)
//! runtextmacro Trackable2_Macro (&quot;Facing&quot;, &quot;real&quot;)
//! runtextmacro Trackable2_Macro (&quot;Model&quot;, &quot;string&quot;)
//! runtextmacro Trackable2_Macro (&quot;ForPlayer&quot;, &quot;player&quot;)

private function Init takes nothing returns nothing
    set table = HandleTable.create()
    set SetLastBool = Condition(function SetLast)
endfunction
endlibrary
</i></i></i></i></i>