# Preload Sound Object

Grammar — Preload id|Sound Object queue|Immediately/For Next Map
Flags — Action

Preloads a sound data entry and its associated assets. The sound must be explicitly identified (it won’t work if you plug in a variable to that parameter). Preloading will force an asset or data entry to be loaded into memory before the map starts, rather than be loaded on demand as the map runs.

# Arguments

• string<gamelink::Sound> — Sound
• bool<preset::PreloadQueue> — Queue

Returns — void

void libNtve_gf_PreloadSoundObject(
	string lp_id,
	bool lp_queue,
);

# Related

Category: Game / Preloading

• Preload Asset — void — PreloadAsset
• Preload Image — void — PreloadImage
• Preload Layout — void — PreloadLayout
• Preload Model — void — PreloadModel
• Preload Model Animation — void — libNtve_gf_PreloadModelAnimation
• Preload Model Object — void — libNtve_gf_PreloadModelObject
• Preload Movie — void — PreloadMovie
• Preload Object — void — PreloadObject
• Preload Scene — void — PreloadScene
• Preload Script — void — PreloadScript
• Preload Sound — void — PreloadSound
• Preload Sound Object — void — libNtve_gf_PreloadSoundObject
• Preload Soundtrack — void — libNtve_gf_PreloadSoundtrack
• Preload Unit — void — libNtve_gf_PreloadUnit

# Examples

campaigns/liberty.sc2campaign — base.sc2maps/maps/campaign/tstory01.sc2map/MapScript.galaxy:12308

        if ((gv_sceneMESound[(lp_sceneID)][lv_index] != null)) {
            libNtve_gf_PreloadSoundObject(SoundLinkId(gv_sceneMESound[(lp_sceneID)][lv_index]), false);
        }

campaigns/liberty.sc2campaign — base.sc2maps/maps/campaign/tstory01.sc2map/MapScript.galaxy:32251

    PreloadMovie("Assets\\Textures\\briefing_video_ttychus05_00.ogv", false);
    ConversationDataPreloadLines("TTychus05Briefing");
    libNtve_gf_PreloadSoundObject("Tychus05Briefing_GreenReticle1", false);
    libNtve_gf_PreloadSoundObject("Tychus05Briefing_GreenReticle2", false);
    return true;

campaigns/liberty.sc2campaign — base.sc2maps/maps/campaign/tstory01.sc2map/MapScript.galaxy:32252

    ConversationDataPreloadLines("TTychus05Briefing");
    libNtve_gf_PreloadSoundObject("Tychus05Briefing_GreenReticle1", false);
    libNtve_gf_PreloadSoundObject("Tychus05Briefing_GreenReticle2", false);
    return true;
}

campaigns/liberty.sc2campaign — base.sc2maps/maps/campaign/tstory01.sc2map/MapScript.galaxy:37559

    PreloadMovie("Assets\\Textures\\video_newsreport_traynor01_00.ogv", false);
    libNtve_gf_PreloadSoundObject("TVTRaynor01Raynor00005", false);
    return true;
}

campaigns/liberty.sc2campaign — base.sc2maps/maps/campaign/tstory01.sc2map/MapScript.galaxy:37682

    PreloadMovie("Assets\\Textures\\video_newsreport_traynor02_00.ogv", false);
    libNtve_gf_PreloadSoundObject("TVTRaynor02Raynor00003", false);
    libNtve_gf_PreloadSoundObject("TVTRaynor02Tychus00002", false);
    return true;

campaigns/liberty.sc2campaign — base.sc2maps/maps/campaign/tstory01.sc2map/MapScript.galaxy:37683

    PreloadMovie("Assets\\Textures\\video_newsreport_traynor02_00.ogv", false);
    libNtve_gf_PreloadSoundObject("TVTRaynor02Raynor00003", false);
    libNtve_gf_PreloadSoundObject("TVTRaynor02Tychus00002", false);
    return true;
}

campaigns/liberty.sc2campaign — base.sc2maps/maps/campaign/tstory01.sc2map/MapScript.galaxy:38173

    }

    libNtve_gf_PreloadSoundObject("TVTHanson03BRaynor00014", false);
    return true;
}

campaigns/liberty.sc2campaign — base.sc2maps/maps/campaign/tvalerian02a.sc2map/MapScript.galaxy:905

    }

    libNtve_gf_PreloadSoundObject("Swann_PlaceTurretVO", false);
    libNtve_gf_PreloadSoundObject("Raynor_SnipeVO", false);
    libNtve_gf_PreloadSoundObject("Tychus_TossGrenadeVO", false);

campaigns/liberty.sc2campaign — base.sc2maps/maps/campaign/tvalerian02a.sc2map/MapScript.galaxy:906

    libNtve_gf_PreloadSoundObject("Swann_PlaceTurretVO", false);
    libNtve_gf_PreloadSoundObject("Raynor_SnipeVO", false);
    libNtve_gf_PreloadSoundObject("Tychus_TossGrenadeVO", false);
    libNtve_gf_CreateUnitsAtPoint2(1, "RaynorCommando", 0, gv_p1_USER, PointFromId(220));

campaigns/liberty.sc2campaign — base.sc2maps/maps/campaign/tvalerian02a.sc2map/MapScript.galaxy:907

    libNtve_gf_PreloadSoundObject("Swann_PlaceTurretVO", false);
    libNtve_gf_PreloadSoundObject("Raynor_SnipeVO", false);
    libNtve_gf_PreloadSoundObject("Tychus_TossGrenadeVO", false);
    libNtve_gf_CreateUnitsAtPoint2(1, "RaynorCommando", 0, gv_p1_USER, PointFromId(220));
    gv_tHEONERAYNOR = UnitLastCreated();

campaigns/liberty.sc2campaign/base.sc2maps/maps/campaign/tstory01.sc2map — MapScript.galaxy:12308

        if ((gv_sceneMESound[(lp_sceneID)][lv_index] != null)) {
            libNtve_gf_PreloadSoundObject(SoundLinkId(gv_sceneMESound[(lp_sceneID)][lv_index]), false);
        }

campaigns/liberty.sc2campaign/base.sc2maps/maps/campaign/tstory01.sc2map — MapScript.galaxy:32251

    PreloadMovie("Assets\\Textures\\briefing_video_ttychus05_00.ogv", false);
    ConversationDataPreloadLines("TTychus05Briefing");
    libNtve_gf_PreloadSoundObject("Tychus05Briefing_GreenReticle1", false);
    libNtve_gf_PreloadSoundObject("Tychus05Briefing_GreenReticle2", false);
    return true;

campaigns/liberty.sc2campaign/base.sc2maps/maps/campaign/tstory01.sc2map — MapScript.galaxy:32252

    ConversationDataPreloadLines("TTychus05Briefing");
    libNtve_gf_PreloadSoundObject("Tychus05Briefing_GreenReticle1", false);
    libNtve_gf_PreloadSoundObject("Tychus05Briefing_GreenReticle2", false);
    return true;
}

campaigns/liberty.sc2campaign/base.sc2maps/maps/campaign/tstory01.sc2map — MapScript.galaxy:37559

    PreloadMovie("Assets\\Textures\\video_newsreport_traynor01_00.ogv", false);
    libNtve_gf_PreloadSoundObject("TVTRaynor01Raynor00005", false);
    return true;
}

campaigns/liberty.sc2campaign/base.sc2maps/maps/campaign/tstory01.sc2map — MapScript.galaxy:37682

    PreloadMovie("Assets\\Textures\\video_newsreport_traynor02_00.ogv", false);
    libNtve_gf_PreloadSoundObject("TVTRaynor02Raynor00003", false);
    libNtve_gf_PreloadSoundObject("TVTRaynor02Tychus00002", false);
    return true;

campaigns/liberty.sc2campaign/base.sc2maps/maps/campaign/tstory01.sc2map — MapScript.galaxy:37683

    PreloadMovie("Assets\\Textures\\video_newsreport_traynor02_00.ogv", false);
    libNtve_gf_PreloadSoundObject("TVTRaynor02Raynor00003", false);
    libNtve_gf_PreloadSoundObject("TVTRaynor02Tychus00002", false);
    return true;
}

campaigns/liberty.sc2campaign/base.sc2maps/maps/campaign/tstory01.sc2map — MapScript.galaxy:38173

    }

    libNtve_gf_PreloadSoundObject("TVTHanson03BRaynor00014", false);
    return true;
}

campaigns/liberty.sc2campaign/base.sc2maps/maps/campaign/tvalerian02a.sc2map — MapScript.galaxy:905

    }

    libNtve_gf_PreloadSoundObject("Swann_PlaceTurretVO", false);
    libNtve_gf_PreloadSoundObject("Raynor_SnipeVO", false);
    libNtve_gf_PreloadSoundObject("Tychus_TossGrenadeVO", false);

campaigns/liberty.sc2campaign/base.sc2maps/maps/campaign/tvalerian02a.sc2map — MapScript.galaxy:906

    libNtve_gf_PreloadSoundObject("Swann_PlaceTurretVO", false);
    libNtve_gf_PreloadSoundObject("Raynor_SnipeVO", false);
    libNtve_gf_PreloadSoundObject("Tychus_TossGrenadeVO", false);
    libNtve_gf_CreateUnitsAtPoint2(1, "RaynorCommando", 0, gv_p1_USER, PointFromId(220));

campaigns/liberty.sc2campaign/base.sc2maps/maps/campaign/tvalerian02a.sc2map — MapScript.galaxy:907

    libNtve_gf_PreloadSoundObject("Swann_PlaceTurretVO", false);
    libNtve_gf_PreloadSoundObject("Raynor_SnipeVO", false);
    libNtve_gf_PreloadSoundObject("Tychus_TossGrenadeVO", false);
    libNtve_gf_CreateUnitsAtPoint2(1, "RaynorCommando", 0, gv_p1_USER, PointFromId(220));
    gv_tHEONERAYNOR = UnitLastCreated();

campaigns/swarmstory.sc2campaign — base.sc2data/TriggerLibs/SwarmCampaignLib.galaxy:13302

    // Implementation
    if ((libSwaC_gf_StoryMapTypeCheck(libSwaC_gf_CurrentMap(), c_mapKindMission) == true)) {
        libNtve_gf_PreloadSoundObject("UI_LowHealthWarning_Start", false);
        libNtve_gf_PreloadSoundObject("UI_LowHealthWarning_BreathLoop", false);
        libNtve_gf_PreloadSoundObject("UI_LowHealthWarning_HeartBeatLoop", false);

campaigns/swarmstory.sc2campaign — base.sc2data/TriggerLibs/SwarmCampaignLib.galaxy:13303

    if ((libSwaC_gf_StoryMapTypeCheck(libSwaC_gf_CurrentMap(), c_mapKindMission) == true)) {
        libNtve_gf_PreloadSoundObject("UI_LowHealthWarning_Start", false);
        libNtve_gf_PreloadSoundObject("UI_LowHealthWarning_BreathLoop", false);
        libNtve_gf_PreloadSoundObject("UI_LowHealthWarning_HeartBeatLoop", false);
        SoundLengthQuery(SoundLink("UI_LowHealthWarning_BreathLoop", -1));

campaigns/swarmstory.sc2campaign — base.sc2data/TriggerLibs/SwarmCampaignLib.galaxy:13304

        libNtve_gf_PreloadSoundObject("UI_LowHealthWarning_Start", false);
        libNtve_gf_PreloadSoundObject("UI_LowHealthWarning_BreathLoop", false);
        libNtve_gf_PreloadSoundObject("UI_LowHealthWarning_HeartBeatLoop", false);
        SoundLengthQuery(SoundLink("UI_LowHealthWarning_BreathLoop", -1));
        SoundLengthQuery(SoundLink("UI_LowHealthWarning_HeartBeatLoop", -1));

campaigns/voidstory.sc2campaign — base.sc2data/TriggerLibs/VoidCampaignLib.galaxy:6642

    // Implementation
    if ((libVoiC_gf_PC_CampaignMapTypeCheck(libVoiC_gf_CurrentMap(), c_mapKindMission) == true)) {
        libNtve_gf_PreloadSoundObject("UI_LowHealthWarning_Start", false);
        libNtve_gf_PreloadSoundObject("UI_LowHealthWarning_BreathLoop", false);
        libNtve_gf_PreloadSoundObject("UI_LowHealthWarning_HeartBeatLoop", false);

campaigns/voidstory.sc2campaign — base.sc2data/TriggerLibs/VoidCampaignLib.galaxy:6643

    if ((libVoiC_gf_PC_CampaignMapTypeCheck(libVoiC_gf_CurrentMap(), c_mapKindMission) == true)) {
        libNtve_gf_PreloadSoundObject("UI_LowHealthWarning_Start", false);
        libNtve_gf_PreloadSoundObject("UI_LowHealthWarning_BreathLoop", false);
        libNtve_gf_PreloadSoundObject("UI_LowHealthWarning_HeartBeatLoop", false);
        SoundLengthQuery(SoundLink("UI_LowHealthWarning_BreathLoop", -1));

campaigns/voidstory.sc2campaign — base.sc2data/TriggerLibs/VoidCampaignLib.galaxy:6644

        libNtve_gf_PreloadSoundObject("UI_LowHealthWarning_Start", false);
        libNtve_gf_PreloadSoundObject("UI_LowHealthWarning_BreathLoop", false);
        libNtve_gf_PreloadSoundObject("UI_LowHealthWarning_HeartBeatLoop", false);
        SoundLengthQuery(SoundLink("UI_LowHealthWarning_BreathLoop", -1));
        SoundLengthQuery(SoundLink("UI_LowHealthWarning_HeartBeatLoop", -1));

mods/missionpacks/novacampaign.sc2mod — base.sc2data/LibNovC.galaxy:2313

    // Implementation
    if ((libComC_gf_CampaignMapTypeCheck(libComC_gf_CurrentMap(), c_mapKindMission) == true)) {
        libNtve_gf_PreloadSoundObject("UI_LowHealthWarning_Start", false);
        libNtve_gf_PreloadSoundObject("UI_LowHealthWarning_BreathLoop", false);
        libNtve_gf_PreloadSoundObject("UI_LowHealthWarning_HeartBeatLoop", false);

mods/missionpacks/novacampaign.sc2mod — base.sc2data/LibNovC.galaxy:2314

    if ((libComC_gf_CampaignMapTypeCheck(libComC_gf_CurrentMap(), c_mapKindMission) == true)) {
        libNtve_gf_PreloadSoundObject("UI_LowHealthWarning_Start", false);
        libNtve_gf_PreloadSoundObject("UI_LowHealthWarning_BreathLoop", false);
        libNtve_gf_PreloadSoundObject("UI_LowHealthWarning_HeartBeatLoop", false);
        SoundLengthQuery(SoundLink("UI_LowHealthWarning_BreathLoop", -1));

mods/missionpacks/novacampaign.sc2mod — base.sc2data/LibNovC.galaxy:2315

        libNtve_gf_PreloadSoundObject("UI_LowHealthWarning_Start", false);
        libNtve_gf_PreloadSoundObject("UI_LowHealthWarning_BreathLoop", false);
        libNtve_gf_PreloadSoundObject("UI_LowHealthWarning_HeartBeatLoop", false);
        SoundLengthQuery(SoundLink("UI_LowHealthWarning_BreathLoop", -1));
        SoundLengthQuery(SoundLink("UI_LowHealthWarning_HeartBeatLoop", -1));

mods/starcoop/starcoop.sc2mod — base.sc2data/LibCOOC.galaxy:4447

    // Implementation
    if ((libCOOC_gf_CC_CampaignMapTypeCheck(libCOOC_gf_CC_CurrentMap(), c_mapKindMission) == true)) {
        libNtve_gf_PreloadSoundObject("UI_LowHealthWarning_Start", false);
        libNtve_gf_PreloadSoundObject("UI_LowHealthWarning_BreathLoop", false);
        libNtve_gf_PreloadSoundObject("UI_LowHealthWarning_HeartBeatLoop", false);

mods/starcoop/starcoop.sc2mod — base.sc2data/LibCOOC.galaxy:4448

    if ((libCOOC_gf_CC_CampaignMapTypeCheck(libCOOC_gf_CC_CurrentMap(), c_mapKindMission) == true)) {
        libNtve_gf_PreloadSoundObject("UI_LowHealthWarning_Start", false);
        libNtve_gf_PreloadSoundObject("UI_LowHealthWarning_BreathLoop", false);
        libNtve_gf_PreloadSoundObject("UI_LowHealthWarning_HeartBeatLoop", false);
        SoundLengthQuery(SoundLink("UI_LowHealthWarning_BreathLoop", -1));

mods/starcoop/starcoop.sc2mod — base.sc2data/LibCOOC.galaxy:4449

        libNtve_gf_PreloadSoundObject("UI_LowHealthWarning_Start", false);
        libNtve_gf_PreloadSoundObject("UI_LowHealthWarning_BreathLoop", false);
        libNtve_gf_PreloadSoundObject("UI_LowHealthWarning_HeartBeatLoop", false);
        SoundLengthQuery(SoundLink("UI_LowHealthWarning_BreathLoop", -1));
        SoundLengthQuery(SoundLink("UI_LowHealthWarning_HeartBeatLoop", -1));

mods/voidprologue.sc2mod — base.sc2data/LibA3DDD02B.galaxy:6411

    // Implementation
    if ((libA3DDD02B_gf_StoryMapTypeCheck(libA3DDD02B_gf_CurrentMap(), c_mapKindMission) == true)) {
        libNtve_gf_PreloadSoundObject("UI_LowHealthWarning_Start", false);
        libNtve_gf_PreloadSoundObject("UI_LowHealthWarning_BreathLoop", false);
        libNtve_gf_PreloadSoundObject("UI_LowHealthWarning_HeartBeatLoop", false);

mods/voidprologue.sc2mod — base.sc2data/LibA3DDD02B.galaxy:6412

    if ((libA3DDD02B_gf_StoryMapTypeCheck(libA3DDD02B_gf_CurrentMap(), c_mapKindMission) == true)) {
        libNtve_gf_PreloadSoundObject("UI_LowHealthWarning_Start", false);
        libNtve_gf_PreloadSoundObject("UI_LowHealthWarning_BreathLoop", false);
        libNtve_gf_PreloadSoundObject("UI_LowHealthWarning_HeartBeatLoop", false);
        SoundLengthQuery(SoundLink("UI_LowHealthWarning_BreathLoop", -1));

mods/voidprologue.sc2mod — base.sc2data/LibA3DDD02B.galaxy:6413

        libNtve_gf_PreloadSoundObject("UI_LowHealthWarning_Start", false);
        libNtve_gf_PreloadSoundObject("UI_LowHealthWarning_BreathLoop", false);
        libNtve_gf_PreloadSoundObject("UI_LowHealthWarning_HeartBeatLoop", false);
        SoundLengthQuery(SoundLink("UI_LowHealthWarning_BreathLoop", -1));
        SoundLengthQuery(SoundLink("UI_LowHealthWarning_HeartBeatLoop", -1));