# Set Portrait Light

Grammar — Set Portrait light to Light
Flags — Native | Action

Sets the light for a portrait.

# Arguments

• int<portrait> — Portrait
• string<gamelink::Light> — Light

Returns — void

native void PortraitSetLight(int p, string lightLink);

# Related

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/tzeratul02.sc2map/MapScript.galaxy:7134

    PortraitWaitForLoad(PortraitLastCreated());
    PortraitSetFullscreen(PortraitLastCreated(), true);
    PortraitSetLight(PortraitLastCreated(), "VC_Zeratul2_Planet");
    libNtve_gf_PortraitSetAnim(PortraitLastCreated(), "Stand A", "TriggerPortraitAnim", c_animFlagPlayForever, c_animTimeDefault);
    PortraitSetBorderVisible(PortraitLastCreated(), false);

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

    PortraitCreate(0, 0, c_anchorCenter, 237, 360, "VC_Zeratul4_Fade", "", "", false, true);
    gv_victoryPortrait = PortraitLastCreated();
    PortraitSetLight(gv_victoryPortrait, "PlanetViewUlnar");
    PortraitSetBorderVisible(gv_victoryPortrait, false);
    PortraitSetFullscreen(gv_victoryPortrait, true);

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

    PortraitWaitForLoad(PortraitLastCreated());
    PortraitSetFullscreen(PortraitLastCreated(), true);
    PortraitSetLight(PortraitLastCreated(), "VC_Zeratul2_Planet");
    libNtve_gf_PortraitSetAnim(PortraitLastCreated(), "Stand A", "TriggerPortraitAnim", c_animFlagPlayForever, c_animTimeDefault);
    PortraitSetBorderVisible(PortraitLastCreated(), false);

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

    PortraitCreate(0, 0, c_anchorCenter, 237, 360, "VC_Zeratul4_Fade", "", "", false, true);
    gv_victoryPortrait = PortraitLastCreated();
    PortraitSetLight(gv_victoryPortrait, "PlanetViewUlnar");
    PortraitSetBorderVisible(gv_victoryPortrait, false);
    PortraitSetFullscreen(gv_victoryPortrait, true);

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

    else {
    }
    PortraitSetLight(libSwaC_gv_zS_PlanetPortrait, lv_light);
    GameSetLighting(lv_light, 0.0);
    libSwaC_gv_zS_PlanetPortraitEvoMissionLight = lp_light;

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

    {
    }
    PortraitSetLight(libVCMI_gv_pM_PlanetPortrait, lp_light);
    GameSetLighting(lp_light, 0.0);
    PortraitSetPosition(libVCMI_gv_pM_PlanetPortrait, c_anchorTopLeft, 0, 0);

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

    {
    }
    PortraitSetLight(libNCMI_gv_NM_PlanetPortrait, lp_light);
    GameSetLighting(lp_light, 0.0);
    PortraitSetPosition(libNCMI_gv_NM_PlanetPortrait, c_anchorTopLeft, 0, 0);

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

    else {
    }
    PortraitSetLight(libA3DDD02B_gv_pP_PlanetPortrait, lv_light);
    GameSetLighting(lv_light, 0.0);
    libA3DDD02B_gv_pP_PlanetPortraitEvoMissionLight = lp_light;