# Add Cutscene Filter

Grammar — Add the filter inFilter to inCutscene.
Flags — Native | Action

Adds a new filter for a cutscene. Any nodes with a non-empty filter property that does not match any filter value will be filtered out of your cutscene.

# Arguments

  • int<preset::Cutscene> — Cutscene
  • string — Filter

Returns — void

native void CutsceneAddFilter(
	int inCutscene,
	string inFilter,
);

Category: Cutscene / Cutscenes / Filters

# Examples

campaigns/voidstory.sc2campaign — base.sc2data/TriggerLibs/VoidCampaignStoryLib.galaxy:2409

            if ((libVCST_gf_ClickableInRoom(lv_indexClickable, libVCST_gf_CurrentRoom()) == true) && (UnitGroupHasUnit(libVCST_gv_pS_VisibleUnits, libVCST_gf_ClickableUnit(lv_indexClickable)) == true)) {
                if ((libVCST_gf_NextAvailableMission(libVoiC_gf_CurrentLocation()) == "PUlnar03") && (lv_indexClickable == "DTLeader")) {
                    CutsceneAddFilter(libVCST_gv_pS_RoomUICutscene, "DTLeaderSpecial");
                }
                else {

campaigns/voidstory.sc2campaign — base.sc2data/TriggerLibs/VoidCampaignStoryLib.galaxy:2412

                }
                else {
                    CutsceneAddFilter(libVCST_gv_pS_RoomUICutscene, libVCST_gf_PS_ClickableSceneNameToken(lv_indexClickable));
                }
            }

campaigns/voidstory.sc2campaign — base.sc2data/TriggerLibs/VoidCampaignStoryLib.galaxy:2605

    if ((libVCST_gv_pS_ActiveBackground != c_cutsceneNone)) {
        if ((lp_enabled == true)) {
            CutsceneAddFilter(libVCST_gv_pS_ActiveBackground, "UIView");
        }
        else {

campaigns/voidstory.sc2campaign — base.sc2data/TriggerLibs/VoidCampaignStoryLib.galaxy:2619

    if ((libVCST_gv_pS_ActiveBackground != c_cutsceneNone)) {
        if ((lp_enabled == true)) {
            CutsceneAddFilter(libVCST_gv_pS_ActiveBackground, "ConversationView");
        }
        else {

campaigns/voidstory.sc2campaign — base.sc2data/TriggerLibs/VoidCampaignUILib.galaxy:836

        DialogControlSetVisible(libVCUI_gv_pU_ArmyFactionPrompt, PlayerGroupAll(), false);
        DialogControlSetVisible(libVCUI_gv_pU_ArmyInfoPanel, PlayerGroupAll(), false);
        CutsceneAddFilter(libVCUI_gv_pU_ArmyCutscene, "Noselect");
        return ;
    }

campaigns/voidstory.sc2campaign — base.sc2data/TriggerLibs/VoidCampaignUILib.galaxy:903

        DialogControlSetVisible(libVCUI_gv_pU_ArmyInfoPanel, PlayerGroupAll(), false);
        DialogControlSetVisible(libVCUI_gv_pU_ArmyFactionPrompt, PlayerGroupAll(), true);
        CutsceneAddFilter(libVCUI_gv_pU_ArmyCutscene, libVoiC_gf_PC_ArmyCategoryCutsceneFilter(libVCUI_gv_pU_ArmyCategories[libVCUI_gv_pU_ArmyCategorySelectedIndex]));
        CutsceneAddFilter(libVCUI_gv_pU_ArmyCutscene, "Noselect");
        libVCUI_gv_pU_ArmyUnitRotateFinderTag = "NONE";

campaigns/voidstory.sc2campaign — base.sc2data/TriggerLibs/VoidCampaignUILib.galaxy:904

        DialogControlSetVisible(libVCUI_gv_pU_ArmyFactionPrompt, PlayerGroupAll(), true);
        CutsceneAddFilter(libVCUI_gv_pU_ArmyCutscene, libVoiC_gf_PC_ArmyCategoryCutsceneFilter(libVCUI_gv_pU_ArmyCategories[libVCUI_gv_pU_ArmyCategorySelectedIndex]));
        CutsceneAddFilter(libVCUI_gv_pU_ArmyCutscene, "Noselect");
        libVCUI_gv_pU_ArmyUnitRotateFinderTag = "NONE";
    }

campaigns/voidstory.sc2campaign — base.sc2data/TriggerLibs/VoidCampaignUILib.galaxy:911

        DialogControlSetVisible(libVCUI_gv_pU_ArmyInfoPanel, PlayerGroupAll(), true);
        DialogControlSetVisible(libVCUI_gv_pU_ArmyInfoMovie, PlayerGroupAll(), true);
        CutsceneAddFilter(libVCUI_gv_pU_ArmyCutscene, libVoiC_gf_PC_ArmyUnitCutsceneFilter(libVCUI_gv_pU_ArmyUnits[libVCUI_gv_pU_ArmyCategorySelectedIndex][libVCUI_gv_pU_ArmyUnitSelectedIndex[libVCUI_gv_pU_ArmyCategorySelectedIndex]]));
        CutsceneAddFilter(libVCUI_gv_pU_ArmyCutscene, libVoiC_gf_PC_ArmyCategoryCutsceneFilter(libVCUI_gv_pU_ArmyCategories[libVCUI_gv_pU_ArmyCategorySelectedIndex]));
        libVCUI_gv_pU_ArmyUnitRotateFinderTag = ("UnitRotate" + libVoiC_gf_PC_ArmyCategoryCutsceneFilter(libVCUI_gv_pU_ArmyCategories[libVCUI_gv_pU_ArmyCategorySelectedIndex]) + libVoiC_gf_PC_ArmyUnitCutsceneFilter(libVCUI_gv_pU_ArmyUnits[libVCUI_gv_pU_ArmyCategorySelectedIndex][libVCUI_gv_pU_ArmyUnitSelectedIndex[libVCUI_gv_pU_ArmyCategorySelectedIndex]]));

campaigns/voidstory.sc2campaign — base.sc2data/TriggerLibs/VoidCampaignUILib.galaxy:912

        DialogControlSetVisible(libVCUI_gv_pU_ArmyInfoMovie, PlayerGroupAll(), true);
        CutsceneAddFilter(libVCUI_gv_pU_ArmyCutscene, libVoiC_gf_PC_ArmyUnitCutsceneFilter(libVCUI_gv_pU_ArmyUnits[libVCUI_gv_pU_ArmyCategorySelectedIndex][libVCUI_gv_pU_ArmyUnitSelectedIndex[libVCUI_gv_pU_ArmyCategorySelectedIndex]]));
        CutsceneAddFilter(libVCUI_gv_pU_ArmyCutscene, libVoiC_gf_PC_ArmyCategoryCutsceneFilter(libVCUI_gv_pU_ArmyCategories[libVCUI_gv_pU_ArmyCategorySelectedIndex]));
        libVCUI_gv_pU_ArmyUnitRotateFinderTag = ("UnitRotate" + libVoiC_gf_PC_ArmyCategoryCutsceneFilter(libVCUI_gv_pU_ArmyCategories[libVCUI_gv_pU_ArmyCategorySelectedIndex]) + libVoiC_gf_PC_ArmyUnitCutsceneFilter(libVCUI_gv_pU_ArmyUnits[libVCUI_gv_pU_ArmyCategorySelectedIndex][libVCUI_gv_pU_ArmyUnitSelectedIndex[libVCUI_gv_pU_ArmyCategorySelectedIndex]]));
        ActorSend(ActorFrom(("::external." + libVCUI_gv_pU_ArmyUnitRotateFinderTag)), "SetRotationYPR -17.000000");

campaigns/voidstory.sc2campaign — base.sc2data/TriggerLibs/VoidCampaignUILib.galaxy:1797

    autoA5F88546_val = lp_mission;
    if (autoA5F88546_val == "PUlnar03") {
        CutsceneAddFilter(libVCUI_gv_pU_MissionCutscene, "Vorazun");
    }
    else if (autoA5F88546_val == "PMoebius01") {

campaigns/voidstory.sc2campaign — base.sc2data/TriggerLibs/VoidCampaignUILib.galaxy:1800

    }
    else if (autoA5F88546_val == "PMoebius01") {
        CutsceneAddFilter(libVCUI_gv_pU_MissionCutscene, "Karax");
    }
    else {

campaigns/voidstory.sc2campaign — base.sc2data/TriggerLibs/VoidCampaignUILib.galaxy:1803

    }
    else {
        CutsceneAddFilter(libVCUI_gv_pU_MissionCutscene, "Artanis");
    }
    if ((libVCUI_gf_PU_MissionUIFilter(lp_mission) != null)) {

campaigns/voidstory.sc2campaign — base.sc2data/TriggerLibs/VoidCampaignUILib.galaxy:1806

    }
    if ((libVCUI_gf_PU_MissionUIFilter(lp_mission) != null)) {
        CutsceneAddFilter(libVCUI_gv_pU_MissionCutscene, libVCUI_gf_PU_MissionUIFilter(lp_mission));
    }

campaigns/voidstory.sc2campaign — base.sc2data/TriggerLibs/VoidCampaignUILib.galaxy:2890

    else if ((libVCUI_gv_pU_StarmapSelection == 1)) {
        CutsceneGoToBookmark(libVCUI_gv_pU_StarmapCutscene, "ASelected");
        CutsceneAddFilter(libVCUI_gv_pU_StarmapCutscene, ("Starmap" + libVoiC_gf_PC_LocationCutsceneFilter(libVCUI_gv_pU_StarmapLocations[1])));
    }
    else if ((libVCUI_gv_pU_StarmapSelection == 2)) {

mods/heroesdata.stormmod — base.stormdata/TriggerLibs/MapMechanicsLib.galaxy:2309

    libMapM_gv_mMIntroCutscene[lp_player] = CutsceneLastCreated();
    if ((StringLength(lp_filter) > 0)) {
        CutsceneAddFilter(CutsceneLastCreated(), lp_filter);
    }

mods/missionpacks/novacampaign.sc2mod — base.sc2data/LibNCST.galaxy:2082

        if ((libNCST_gf_NS_ClickableSceneNameToken(lv_indexClickable) != null)) {
            if ((libNCST_gf_ClickableInRoom(lv_indexClickable, libNCST_gf_CurrentRoom()) == true) && (UnitGroupHasUnit(libNCST_gv_nS_VisibleUnits, libNCST_gf_ClickableUnit(lv_indexClickable)) == true)) {
                CutsceneAddFilter(libNCST_gv_nS_RoomUICutscene, libNCST_gf_NS_ClickableSceneNameToken(lv_indexClickable));
            }
            else {

mods/missionpacks/novacampaign.sc2mod — base.sc2data/LibNCST.galaxy:2242

    if ((libNCST_gv_NS_ActiveBackground != c_cutsceneNone)) {
        if ((lp_enabled == true)) {
            CutsceneAddFilter(libNCST_gv_NS_ActiveBackground, "UIView");
        }
        else {

mods/missionpacks/novacampaign.sc2mod — base.sc2data/LibNCST.galaxy:2255

    if ((libNCST_gv_NS_ActiveBackground != c_cutsceneNone)) {
        if ((lp_enabled == true)) {
            CutsceneAddFilter(libNCST_gv_NS_ActiveBackground, "ConversationView");
        }
        else {

mods/starcoop/starcoop.sc2mod — base.sc2data/LibCOUI.galaxy:4838


    if ((libCOUI_gv_cU_GPCutsceneFilter[lp_player] != "")) {
        CutsceneAddFilter(CutsceneGetTriggerControl(libCOUI_gv_cU_GPCutscene[lp_player]), libCOUI_gv_cU_GPCutsceneFilter[lp_player]);
    }