[Lua] PreloadUtils

[AGD]

A handy script for preloading abilities, special effects, and other things that needs to be preloaded.


preloadutils.lua

--[[ PreloadUtils.lua v1.0.0.1 https://www.hiveworkshop.com/threads/lua-preloadutils.325644/

    uses:
        - Global Initialization: https://www.hiveworkshop.com/threads/lua-global-initialization.317099/

    API:

        function PreloadUnit(arg)
        function PreloadItem(arg)
        function PreloadAbility(arg)
            - Args: rawcode(s) enclosed in FourCC()

        function PreloadEffect(arg)
        function PreloadSound(arg)
            - Args: string path(s)


    Sample Usage:

        PreloadUnit(FourCC('hfoo'))
        PreloadAbility{ FourCC('A000'), FourCC('A001'), FourCC('A002') }
        PreloadEffect{ path_1, {path_2, path_3}, path_4 }

]]--
do
    local t = {}
    local dummy

    local function OnPreload(callback, arg)
        if type(arg) == 'table' then
            for k, v in pairs(arg) do
                OnPreload(callback, v)
            end
        elseif t[arg] == nil then
            t[arg] = 1 -- prevents redundant preloading
            callback(arg)
        end
    end

    local function UnitPreloader(id)
        RemoveUnit(CreateUnit(Player(PLAYER_NEUTRAL_PASSIVE), id, 0, 0, 0))
    end
    local function ItemPreloader(id)
        RemoveItem(UnitAddItemById(dummy, id))
    end
    local function AbilityPreloader(id)
        if UnitAddAbility(dummy, id) then UnitRemoveAbility(dummy, id) end
    end
    local function EffectPreloader(path)
        DestroyEffect(AddSpecialEffectTarget(path, dummy, "origin"))
    end
    -- Credits to Silvenon for sound preloading method
    local function SoundPreloader(path)
        local s = CreateSound(path, false, false, false, 10, 10, "")
        SetSoundVolume(s, 0)
        StartSound(s)
        KillSoundWhenDone(s)
    end

    function PreloadUnit(arg)
        OnPreload(UnitPreloader, arg)
    end
    function PreloadItem(arg)
        OnPreload(ItemPreloader, arg)
    end
    function PreloadAbility(arg)
        OnPreload(AbilityPreloader, arg)
    end
    function PreloadEffect(arg)
        OnPreload(EffectPreloader, arg)
    end
    function PreloadSound(arg)
        OnPreload(SoundPreloader, arg)
    end

    -- init
    OnGlobalInit(function ()
        local world = GetWorldBounds()
        dummy = CreateUnit(Player(PLAYER_NEUTRAL_PASSIVE), FourCC('hpea'), 0, 0, 0)
        SetUnitY(dummy, GetRectMaxY(world) + 1000)
        UnitAddAbility(dummy, FourCC('AInv'))
        UnitAddAbility(dummy, FourCC('Avul'))
        UnitRemoveAbility(dummy, FourCC('Amov'))
        RemoveRect(world)
    end)
end

Version History

v1.0.0
- Initial release
v1.0.0.1
- Updated to use newer Global Initialization API

 

[Eikonium]

Hey AGD,

a closing square bracket seems to be missing in the line below the elseif:

            t[arg = 1 -- prevents redundant preloading

Best regards
Eikonium

 

[AGD]

Edited, Thanks

 

[Eikonium]

Another thing:
Where is the world variable being declared?

Best regards

 

[Bribe]

I've done a minor update to use the capital O in OnGlobalInit. This is now Approved.

 

[Wrda]

Why is it needed to remove the rect of GetWorldBounds()? Won't this break other scripts that use the same rect?

 

[Bribe]

Why is it needed to remove the rect of GetWorldBounds()? Won't this break other scripts that use the same rect?

GetWorldBounds, oddly, returns a new rect handle each time the native is called (at least, that's how it's worked in JASS). It's not like GetPlayableMapRect. So, it should be safe.