[General] Libraries - Accessing Outside Variables & Functions

[Radicool]

I'm creating a library that needs to access external functions and variables but I get compile errors. Here are some specific examples.

Accessing External Variables

globals
    private timer array musicTimers[udg_MAXNUMBERPLAYERS]
endglobals

This throws a compile error. As a workaround I think I could create another "GetGameData" library and use it as a requirement. This library could have functions to get various pieces of game data and I could call these functions on map init. Is this the right way to go about it?

Accessing External Functions

I need a library to call a function outside of it's scope. Only problem is the function it's trying to use is NOT from a library. It's just normal Jass. Is there any way to use these functions without converting the whole Jass to a VJass library and using it as a requirement?

 

[TriggerHappy]

I'm creating a library that needs to access external functions and variables but I get compile errors. Here are some specific examples.

Accessing External Variables

What syntax error are you getting? There's no need to define a size for globals unless they are struct members. You should also be able to use udg variables from your globals blocks.

Accessing External Functions

I need a library to call a function outside of it's scope. Only problem is the function it's trying to use is NOT from a library. It's just normal Jass. Is there any way to use these functions without converting the whole Jass to a VJass library and using it as a requirement?

If you mean that the function is declared below your library then you can use ExecuteFunc or .execute or .evaluate.

function A takes nothing returns nothing
    call ExecuteFunc("B")
    call C.execute(15)
    if (D.evaluate()) then
       
    endif
endfunction

function B takes nothing returns nothing
    // below A
endfunction

function C takes takes integer param returns nothing
    // below A
endfunction

function D takes nothing returns boolean
    return true
endfunction

It would be more efficient to wrap the functions in a library through, as the above will generate code.

 

[Radicool]

What syntax error are you getting? There's no need to define a size for globals unless they are struct members. You should also be able to use udg variables from your globals blocks.

See below for a screenshot.

Hidden

udg_MaxPlayers is defined as an integer with value of 8 in the variable editor. Not sure why it isn't working, but you're saying I can omit the array size in the global block for musicTimers?

If you mean that the function is declared below your library then you can use
ExecuteFunc
or
.execute
or
.evaluate
.

I need to use functions from InventorySystem which is normal Jass for my PartySystem. Hopefully the screenshot below helps explain what I'm trying to achieve. If I call a InventorySystem function from my PartySystem library, I get a syntax error: "Undeclared function GetUnitBagNumber maybe you meant............"

Hidden

Edit: Here is one of the function calls I'm making from PartySystem. I'm calling a function from InventorySystem. The below function call with throw a syntax error "Undeclared function..."

local integer currentBag = GetUnitBagNumber(trainer)

 

[Pyrogasm]

You should also be able to use udg variables from your globals blocks.

I was under the impression array size definitions could only accept literal input (like [16]) or integers declared as constant.

@Radicool Based on what I see in the screenshot all you need to do is put a library definition around the entirety of your inventory system and then make your PartySystem require it.

library InventorySystem
//Put code here
endlibrary

...

library PartySystem requires InventorySystem

The only time you need to manually define array size is if the array is a member of a struct or if the array is 2-dimensional or if you want an array bigger than the default maximum of 16384 32,768 (used to be 8192).

 

[Radicool]

I was under the impression array size definitions could only accept literal input (like [16]) or integers declared as constant.

Based on what I see in the screenshot all you need to do is put a library definition around the entirety of your inventory system and then make your PartySystem require it.

Sure I can do this. I assume I can reference udg_ global variables from libraries in general? My Inventory system uses a few globals, so I don't want a library declaration breaking the system.

The only time you need to manually define array size is if the array is a member of a struct or if the array is 2-dimensional or if you want an array bigger than the default maximum of 16384 (used to be 8192).

Ok good to know. I've remove the size definition for simplicity.

 

[Pyrogasm]

As long as they aren't private, any global can be accessed by any other library even without listing the source library as a requirement. All globals are merged into a single block in the war3map.j that comes before every function definition.

udg_ globals are no different, though as Bo shows below they do come last in the globals block so library globals cannot reference udg_ globals.

 

[Radicool]

Nice thanks for the response!

 

[IcemanBo]

Yeh, size is without impact for usage if you are under array limit. It just always creates 1 string array variable:

globals
    constant integer i = 1
    string array text [1]
endglobals

->

also pJass won't bother, and something like this normals work (with array size "1"!):

scope Test initializer test
    function test takes nothing returns nothing
        local integer i = 0
        loop
            exitwhen i > 10
            set text[i] = I2S(i)
            set i = i + 1
        endloop
       
        set i = 0
        loop
            exitwhen i > 10
            call BJDebugMsg((text[i]))
            set i = i + 1
        endloop
       
    endfunction
endscope

So like @Pyrogasm said array size becomes useful as vjass feature when wanting higher arrays, then it internally creates multiple string array variables:

globals
    string array text [200000]
endglobals

->

..or when needing to split the array internally for a struct.. as a struct is just a normal array, too, which then would need to be devided.


for udg_ usage in libs:

library MyLib initializer Init
    globals
        private integer number = 2
    endglobals

+

becomes
->

so when my global got defined, udg_i is not even known yet -> can't use.

also, when the Init function from library or struct runs, then the value for the udg_ is still not assigned, yet:

so the udg_ is useable in the init funcs, but has just the initial value (0/null).

The new array limit is btw 32,768. ^^