# Turn Portrait Transition On/Off

Grammar — Turn Portrait transition Fullscreen
Flags — Native | Action

Turns a portrait’s transition to on or off.

# Arguments

int<portrait> — Portrait
bool<preset::OnOffOption> — On/Off

Returns — void

native void PortraitUseTransition(
	int p,
	bool useTransition,
);

Category: Portrait / Advanced

Destroy All Portraits — void — PortraitDestroyAll
Destroy Portrait — void — PortraitDestroy
Play Portrait Animation — void — libNtve_gf_PortraitSetAnim
Set Portrait Camera — void — PortraitSetCamera
Set Portrait Border Texture — void — PortraitSetBorderTexture
Set Portrait Light — void — PortraitSetLight
Set Portrait Model — void — PortraitSetModel
Set Portrait Model And Play Animation — void — PortraitSetModelAnim
Set Portrait Position — void — PortraitSetPosition
Set Portrait Size — void — PortraitSetSize
Set Portrait Transition Model — void — PortraitSetTransitionModel
Set Portrait Mouse Target — void — PortraitSetMouseTarget
Set Portrait Channel — void — PortraitSetChannel
Set Portrait Render Type — void — PortraitSetRenderType
Mute/Unmute Portrait — void — PortraitSetMuted
Pause/Unpause Portrait — void — PortraitSetPaused
Set Portrait Tint Color — void — PortraitSetTintColor
Set Portrait Team Color — void — PortraitSetTeamColor
Set Portrait Actor — void — PortraitSetActor
Turn Portrait Border On/Off — void — PortraitSetBorderVisible
Turn Portrait Background On/Off — void — PortraitSetBackgroundVisible
Turn Portrait Fullscreen On/Off — void — PortraitSetFullscreen
Turn Portrait Offscreen On/Off — void — PortraitSetOffscreen
Turn Portrait Transition On/Off — void — PortraitUseTransition
Force Portrait Transition On/Off — void — PortraitForceTransition
Clear Portrait Animation — void — libNtve_gf_ClearPortraitAnimation
Wait For Portrait To Load — void — PortraitWaitForLoad

# Examples

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

    libNtve_gf_SetDialogItemStyle(DialogControlLastCreated(), "StoryModeNewItemTooltip", PlayerGroupAll());
    PortraitCreate(0, 0, c_anchorTopLeft, FixedToInt(gv_c_NEWITEMINFO_FLASHWIDTH), FixedToInt(gv_c_NEWITEMINFO_FLASHHEIGHT), gv_newItems[lv_newItemIndex].lv_modelFlash, "CameraPortrait", "Default", false, false);
    PortraitUseTransition(PortraitLastCreated(), false);
    gv_newItems[lv_newItemIndex].lv_flash = PortraitLastCreated();
    PortraitSetBackgroundVisible(PortraitLastCreated(), false);

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

    libNtve_gf_SetDialogItemStyle(DialogControlLastCreated(), "StoryModeNewItemTooltip", PlayerGroupAll());
    PortraitCreate(0, 0, c_anchorTopLeft, FixedToInt(gv_c_NEWITEMINFO_FLASHWIDTH), FixedToInt(gv_c_NEWITEMINFO_FLASHHEIGHT), gv_newItems[lv_newItemIndex].lv_modelFlash, "CameraPortrait", "Default", false, false);
    PortraitUseTransition(PortraitLastCreated(), false);
    gv_newItems[lv_newItemIndex].lv_flash = PortraitLastCreated();
    PortraitSetBackgroundVisible(PortraitLastCreated(), false);

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

        PortraitSetBackgroundVisible(libSwaC_gv_zS_PlanetPortrait, false);
        PortraitSetBorderVisible(libSwaC_gv_zS_PlanetPortrait, false);
        PortraitUseTransition(PortraitLastCreated(), false);
        PortraitWaitForLoad(libSwaC_gv_zS_PlanetPortrait);
    }

campaigns/voidstory.sc2campaign — base.sc2data/TriggerLibs/VoidCampaignMissionLib.galaxy:2012

        PortraitSetBackgroundVisible(libVCMI_gv_pM_PlanetPortrait, false);
        PortraitSetBorderVisible(libVCMI_gv_pM_PlanetPortrait, false);
        PortraitUseTransition(PortraitLastCreated(), false);
        PortraitWaitForLoad(libVCMI_gv_pM_PlanetPortrait);
    }

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

    DialogSetImageVisible(DialogLastCreated(), false);
    DialogControlCreateFromTemplate(DialogLastCreated(), c_triggerControlTypePortrait, "LotV_GameUI/SoAOverlayTemplate");
    PortraitUseTransition(PortraitGetTriggerControl(DialogControlLastCreated()), false);
    libNtve_gf_SetDialogItemModel(DialogControlLastCreated(), "SOA_Calldown_UI", PlayerGroupAll());
    libVCUI_gv_pU_TargetingOverlayPortrait = DialogControlLastCreated();

mods/core.sc2mod — base.sc2data/TriggerLibs/NativeLib.galaxy:4100

    libNtve_gv_cinematicPortraits[lv_index] = PortraitLastCreated();
    PortraitSetBorderVisible(libNtve_gv_cinematicPortraits[lv_index], true);
    PortraitUseTransition(libNtve_gv_cinematicPortraits[lv_index], true);
    PortraitSetVisible(libNtve_gv_cinematicPortraits[lv_index], PlayerGroupAll(), false, false);
    return libNtve_gv_cinematicPortraits[lv_index];

mods/core.sc2mod — base.sc2data/TriggerLibs/NativeLib.galaxy:4151

    PortraitSetFullscreen(libNtve_gv_cinematicPortraits[lv_index], true);
    PortraitSetBorderVisible(libNtve_gv_cinematicPortraits[lv_index], false);
    PortraitUseTransition(libNtve_gv_cinematicPortraits[lv_index], false);
    PortraitSetVisible(libNtve_gv_cinematicPortraits[lv_index], PlayerGroupAll(), false, false);
    return libNtve_gv_cinematicPortraits[lv_index];

mods/core.stormmod — base.stormdata/TriggerLibs/NativeLib.galaxy:3399

    libNtve_gv_cinematicPortraits[lv_index] = PortraitLastCreated();
    PortraitSetBorderVisible(libNtve_gv_cinematicPortraits[lv_index], true);
    PortraitUseTransition(libNtve_gv_cinematicPortraits[lv_index], true);
    PortraitSetVisible(libNtve_gv_cinematicPortraits[lv_index], PlayerGroupAll(), false, false);
    return libNtve_gv_cinematicPortraits[lv_index];

mods/core.stormmod — base.stormdata/TriggerLibs/NativeLib.galaxy:3450

    PortraitSetFullscreen(libNtve_gv_cinematicPortraits[lv_index], true);
    PortraitSetBorderVisible(libNtve_gv_cinematicPortraits[lv_index], false);
    PortraitUseTransition(libNtve_gv_cinematicPortraits[lv_index], false);
    PortraitSetVisible(libNtve_gv_cinematicPortraits[lv_index], PlayerGroupAll(), false, false);
    return libNtve_gv_cinematicPortraits[lv_index];

mods/missionpacks/novacampaign.sc2mod — base.sc2data/LibNCMI.galaxy:2692

        PortraitSetBackgroundVisible(libNCMI_gv_NM_PlanetPortrait, false);
        PortraitSetBorderVisible(libNCMI_gv_NM_PlanetPortrait, false);
        PortraitUseTransition(PortraitLastCreated(), false);
        PortraitWaitForLoad(libNCMI_gv_NM_PlanetPortrait);
    }

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

        DialogSetImageVisible(DialogLastCreated(), false);
        DialogControlCreateFromTemplate(DialogLastCreated(), c_triggerControlTypePortrait, "LotV_GameUI/SoAOverlayTemplate");
        PortraitUseTransition(PortraitGetTriggerControl(DialogControlLastCreated()), false);
        libNtve_gf_SetDialogItemModel(DialogControlLastCreated(), "SOA_Calldown_UI", PlayerGroupAll());
        libCOUI_gv_cU_TargetingOverlayPortrait[lp_player] = DialogControlLastCreated();

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

        PortraitSetBackgroundVisible(libA3DDD02B_gv_pP_PlanetPortrait, false);
        PortraitSetBorderVisible(libA3DDD02B_gv_pP_PlanetPortrait, false);
        PortraitUseTransition(PortraitLastCreated(), false);
        PortraitWaitForLoad(libA3DDD02B_gv_pP_PlanetPortrait);
    }

# Turn Portrait Transition On/Off

# Arguments

# Related

# Examples