# Turn Portrait Border On/Off

Grammar — Turn Portrait border BorderVisible
Flags — Native | Action

Turns a portrait’s border on or off.

# Arguments

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

Returns — void

native void PortraitSetBorderVisible(
	int p,
	bool isBorderVisible,
);

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:10375

    gv_zPlanetPanel_PortraitPlanet = PortraitLastCreated();
    PortraitSetBackgroundVisible(PortraitLastCreated(), false);
    PortraitSetBorderVisible(PortraitLastCreated(), false);
    PortraitSetFullscreen(PortraitLastCreated(), true);
    PortraitCreate(0, 0, c_anchorCenter, 237, 360, "SMZeratulMissionSelectBorder", "", "Stand", false, true);

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

    gv_zPlanetPanel_PortraitBorder = PortraitLastCreated();
    PortraitSetBackgroundVisible(PortraitLastCreated(), false);
    PortraitSetBorderVisible(PortraitLastCreated(), false);
    PortraitSetFullscreen(PortraitLastCreated(), true);
    DialogCreate(1400, 400, c_anchorBottom, 0, 400, false);

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

    PortraitSetFullscreen(PortraitLastCreated(), true);
    PortraitSetBackgroundVisible(PortraitLastCreated(), false);
    PortraitSetBorderVisible(PortraitLastCreated(), false);
    PortraitWaitForLoad(PortraitLastCreated());
    PortraitSetVisible(PortraitLastCreated(), PlayerGroupAll(), true, true);

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

    gv_newItems[lv_newItemIndex].lv_flash = PortraitLastCreated();
    PortraitSetBackgroundVisible(PortraitLastCreated(), false);
    PortraitSetBorderVisible(PortraitLastCreated(), false);
    gf_MoveNewItem(lv_newItemIndex, lv_offset, 0.0);
    Wait(0.5, c_timeReal);

campaigns/liberty.sc2campaign — base.sc2maps/maps/campaign/ttutorial01.sc2map/MapScript.galaxy:1273

    PortraitCreate(-324, -131, c_anchorCenter, 260, 365, null, "", "", false, true);
    gv_cinematicWindow = PortraitLastCreated();
    PortraitSetBorderVisible(PortraitLastCreated(), false);
    PortraitSetModel(gv_cinematicWindow, "AdjutantPortrait_L", false);
    PortraitSetVisible(gv_cinematicWindow, PlayerGroupAll(), true, false);

campaigns/liberty.sc2campaign — base.sc2maps/maps/campaign/tzeratul02.sc2map/MapScript.galaxy:7136

    PortraitSetLight(PortraitLastCreated(), "VC_Zeratul2_Planet");
    libNtve_gf_PortraitSetAnim(PortraitLastCreated(), "Stand A", "TriggerPortraitAnim", c_animFlagPlayForever, c_animTimeDefault);
    PortraitSetBorderVisible(PortraitLastCreated(), false);
    Wait(1.0, c_timeGame);
    PortraitSetVisible(PortraitLastCreated(), PlayerGroupAll(), true, false);

campaigns/liberty.sc2campaign — base.sc2maps/maps/campaign/tzeratul04.sc2map/MapScript.galaxy:6720

    gv_victoryPortrait = PortraitLastCreated();
    PortraitSetLight(gv_victoryPortrait, "PlanetViewUlnar");
    PortraitSetBorderVisible(gv_victoryPortrait, false);
    PortraitSetFullscreen(gv_victoryPortrait, true);
    CinematicFade(true, 1.0, c_fadeStyleNormal, ColorWithAlpha(0.00, 0.00, 0.00, 0.00), 0.0, false);

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

    gv_zPlanetPanel_PortraitPlanet = PortraitLastCreated();
    PortraitSetBackgroundVisible(PortraitLastCreated(), false);
    PortraitSetBorderVisible(PortraitLastCreated(), false);
    PortraitSetFullscreen(PortraitLastCreated(), true);
    PortraitCreate(0, 0, c_anchorCenter, 237, 360, "SMZeratulMissionSelectBorder", "", "Stand", false, true);

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

    gv_zPlanetPanel_PortraitBorder = PortraitLastCreated();
    PortraitSetBackgroundVisible(PortraitLastCreated(), false);
    PortraitSetBorderVisible(PortraitLastCreated(), false);
    PortraitSetFullscreen(PortraitLastCreated(), true);
    DialogCreate(1400, 400, c_anchorBottom, 0, 400, false);

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

    PortraitSetFullscreen(PortraitLastCreated(), true);
    PortraitSetBackgroundVisible(PortraitLastCreated(), false);
    PortraitSetBorderVisible(PortraitLastCreated(), false);
    PortraitWaitForLoad(PortraitLastCreated());
    PortraitSetVisible(PortraitLastCreated(), PlayerGroupAll(), true, true);

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

    gv_newItems[lv_newItemIndex].lv_flash = PortraitLastCreated();
    PortraitSetBackgroundVisible(PortraitLastCreated(), false);
    PortraitSetBorderVisible(PortraitLastCreated(), false);
    gf_MoveNewItem(lv_newItemIndex, lv_offset, 0.0);
    Wait(0.5, c_timeReal);

campaigns/liberty.sc2campaign/base.sc2maps/maps/campaign/ttutorial01.sc2map — MapScript.galaxy:1273

    PortraitCreate(-324, -131, c_anchorCenter, 260, 365, null, "", "", false, true);
    gv_cinematicWindow = PortraitLastCreated();
    PortraitSetBorderVisible(PortraitLastCreated(), false);
    PortraitSetModel(gv_cinematicWindow, "AdjutantPortrait_L", false);
    PortraitSetVisible(gv_cinematicWindow, PlayerGroupAll(), true, false);

campaigns/liberty.sc2campaign/base.sc2maps/maps/campaign/tzeratul02.sc2map — MapScript.galaxy:7136

    PortraitSetLight(PortraitLastCreated(), "VC_Zeratul2_Planet");
    libNtve_gf_PortraitSetAnim(PortraitLastCreated(), "Stand A", "TriggerPortraitAnim", c_animFlagPlayForever, c_animTimeDefault);
    PortraitSetBorderVisible(PortraitLastCreated(), false);
    Wait(1.0, c_timeGame);
    PortraitSetVisible(PortraitLastCreated(), PlayerGroupAll(), true, false);

campaigns/liberty.sc2campaign/base.sc2maps/maps/campaign/tzeratul04.sc2map — MapScript.galaxy:6720

    gv_victoryPortrait = PortraitLastCreated();
    PortraitSetLight(gv_victoryPortrait, "PlanetViewUlnar");
    PortraitSetBorderVisible(gv_victoryPortrait, false);
    PortraitSetFullscreen(gv_victoryPortrait, true);
    CinematicFade(true, 1.0, c_fadeStyleNormal, ColorWithAlpha(0.00, 0.00, 0.00, 0.00), 0.0, false);

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

        PortraitSetOffscreen(libSwaC_gv_zS_PlanetPortrait, true);
        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:2011

        PortraitSetOffscreen(libVCMI_gv_pM_PlanetPortrait, true);
        PortraitSetBackgroundVisible(libVCMI_gv_pM_PlanetPortrait, false);
        PortraitSetBorderVisible(libVCMI_gv_pM_PlanetPortrait, false);
        PortraitUseTransition(PortraitLastCreated(), false);
        PortraitWaitForLoad(libVCMI_gv_pM_PlanetPortrait);

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

    PortraitCreate(lv_offsetX, lv_offsetY, lv_anchor, lv_width, lv_height, null, "Dflt", "", true, true);
    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);

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

    libNtve_gv_cinematicPortraits[lv_index] = PortraitLastCreated();
    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);

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

    PortraitCreate(lv_offsetX, lv_offsetY, lv_anchor, lv_width, lv_height, null, "Dflt", "", true, true);
    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);

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

    libNtve_gv_cinematicPortraits[lv_index] = PortraitLastCreated();
    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);

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

        PortraitSetOffscreen(libNCMI_gv_NM_PlanetPortrait, true);
        PortraitSetBackgroundVisible(libNCMI_gv_NM_PlanetPortrait, false);
        PortraitSetBorderVisible(libNCMI_gv_NM_PlanetPortrait, false);
        PortraitUseTransition(PortraitLastCreated(), false);
        PortraitWaitForLoad(libNCMI_gv_NM_PlanetPortrait);

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

        PortraitSetOffscreen(libA3DDD02B_gv_pP_PlanetPortrait, true);
        PortraitSetBackgroundVisible(libA3DDD02B_gv_pP_PlanetPortrait, false);
        PortraitSetBorderVisible(libA3DDD02B_gv_pP_PlanetPortrait, false);
        PortraitUseTransition(PortraitLastCreated(), false);
        PortraitWaitForLoad(libA3DDD02B_gv_pP_PlanetPortrait);

# Turn Portrait Border On/Off

# Arguments

# Related

# Examples