# Set Time of Day Lighting

Grammar — Change the light used for time of day lighting to light
Flags — Native | Action

Sets the lighting used by the time of day.

# Arguments

• string<gamelink::Light> — Light

Returns — void

native void GameSetToDLighting(string inId);

# Related

Category: Environment / Lighting

• Game Day/Night State Change — void — TriggerAddEventGameTimeEvent
• Set Lighting — void — GameSetLighting
• Set Lighting For Player — void — PlayerSetLighting
• Set Time Of Day — void — GameTimeOfDaySet
• Set Time Of Day (Seconds) — void — GameTimeOfDayValueSet
• Set Time Of Day (Hours, Minutes, Seconds) — void — GameTimeOfDayTimeValueSet
• Set Time of Day Lighting — void — GameSetToDLighting
• Set Time of Day Lighting For Player — void — PlayerSetToDLighting
• Set Day Length — void — GameTimeOfDaySetLength
• Pause/Unpause Time Of Day — void — GameTimeOfDayPause
• Triggering Day/Night State — int<preset::DayNightEventType> — EventGameTimeEvent
• Current Time Of Day — string<timeofday> — GameTimeOfDayGet
• Current Time Of Day (Seconds) — int — GameTimeOfDayValueGet
• Current Day/Night State — int<preset::DayNightEventType> — GameTimeOfDayCurrentTimeEvent
• Day Length — fixed — GameTimeOfDayGetLength
• Time Of Day Is Paused — bool — GameTimeOfDayIsPaused

# Examples

campaigns/liberty.sc2campaign — base.sc2maps/maps/campaign/thanson02.sc2map/MapScript.galaxy:679

    }

    GameSetToDLighting("MeinhoffCampaignDay");
    GameTimeOfDaySet("12:00:00");
    GameTimeOfDayPause(true);

campaigns/liberty.sc2campaign — base.sc2maps/maps/campaign/thanson02.sc2map/MapScript.galaxy:4705

    gv_inCinematic = true;
    gv_gameOver = true;
    GameSetToDLighting("MeinhoffCampaignDay");
    GameTimeOfDaySet("12:00:00");
    libNtve_gf_SetAlliance(gv_pLAYER_03_INFESTED_REFUGEES, gv_pLAYER_02_REFUGEES, libNtve_ge_AllianceSetting_Enemy);

campaigns/liberty.sc2campaign — base.sc2maps/maps/campaign/thanson03a.sc2map/MapScript.galaxy:802

    }

    GameSetToDLighting("Haven");
    GameTimeOfDayPause(true);
    VisRevealerCreate(gv_pLAYER01_USER, RegionCircle(RegionGetCenter(RegionFromId(9)), 10.0));

campaigns/liberty.sc2campaign — base.sc2maps/maps/campaign/thanson03a.sc2map/MapScript.galaxy:6531

    UnitClearSelection(gv_pLAYER01_USER);
    PlayerSetState(gv_pLAYER01_USER, c_playerStateXPGain, false);
    GameSetToDLighting("Haven");
    GameTimeOfDaySet("12:00:00");
    UnitPauseAll(true);

campaigns/liberty.sc2campaign — base.sc2maps/maps/campaign/traynor03.sc2map/MapScript.galaxy:728

    }

    GameSetToDLighting("MarSaraCampaignNight");
    GameTimeOfDaySet("18:00:00");
    GameTimeOfDayPause(true);

campaigns/liberty.sc2campaign — base.sc2maps/maps/campaign/traynor03.sc2map/MapScript.galaxy:5081

    UnitClearSelection(gv_pLAYER01_USER);
    PlayerSetState(gv_pLAYER01_USER, c_playerStateXPGain, false);
    GameSetToDLighting("MarSaraCampaignDay");
    GameTimeOfDaySet("12:00:00");
    libNtve_gf_PlayAnimationOnDoodadsInRegion(RegionPlayableMap(), "RainEmitterMedium", c_animNameDefault, "Death", c_animFlagPlayForever, c_animTimeDefault);

campaigns/liberty.sc2campaign — base.sc2maps/maps/campaign/ttychus04.sc2map/MapScript.galaxy:566

    GameTimeOfDaySet("08:00:00");
    GameSetToDLighting("Typhon");
    RegionPlayableMapSet(RegionFromId(17));
    return true;

campaigns/liberty.sc2campaign — base.sc2maps/maps/campaign/ttychus04.sc2map/MapScript.galaxy:3332

    }

    GameSetToDLighting("MeinhoffCampaign");
    GameTimeOfDaySet("12:00:00");
    CameraApplyInfo(gv_pLAYER01_USER, CameraInfoFromId(1051), 0.0, -1, 10, true);

campaigns/liberty.sc2campaign — base.sc2maps/maps/campaign/ttychus04.sc2map/MapScript.galaxy:3366

    }

    GameSetToDLighting("MeinhoffCampaign");
    GameTimeOfDaySet("08:00:00");
    libNtve_gf_CreateUnitsAtPoint2(1, "WallOfFire", 0, gv_pLAYER08_DEATHSUN, PointFromId(419));

campaigns/liberty.sc2campaign — base.sc2maps/maps/campaign/tzeratul03.sc2map/MapScript.galaxy:4441

    libNtve_gf_CreateUnitsAtPoint2(1, "Ultralisk", 0, gv_p05_ZERG_LOW_GROUND_NOAI, PointFromId(680));
    gv_briefingUltra3 = UnitLastCreated();
    GameSetToDLighting("AiurFlashbackStart");
    CreepModify(RegionGetCenter(RegionFromId(20)), 25.0, true, false);
    libNtve_gf_PlayAnimationOnDoodadsInRegion(RegionEntireMap(), "RainEmitterMedium", c_animNameDefault, "Death", c_animFlagNonLooping, c_animTimeDefault);

campaigns/liberty.sc2campaign — base.sc2maps/maps/campaign/tzeratul03.sc2map/MapScript.galaxy:5182

    GameSetBackground(c_backgroundFixed, "AiurSkybox", 100.0);
    GameSetToDLighting("Aiur");
    CameraApplyInfo(gv_p01_USER, CameraInfoFromId(167), 0.0, -1, 10, true);
    SoundtrackPlay(PlayerGroupAll(), c_soundtrackCategoryMusic, "TZeratul03MusicOutro", c_soundtrackCueAny, c_soundtrackIndexAny, false);

campaigns/liberty.sc2campaign — base.sc2maps/maps/campaign/tzeratul03.sc2map/MapScript.galaxy:5246

    CreepModify(PointFromId(230), 25.0, true, false);
    CreepModify(PointFromId(230), 5.0, false, false);
    GameSetToDLighting("AiurFlashback");
    SoundtrackPlay(PlayerGroupAll(), c_soundtrackCategoryAmbience, "Ambience_Char", c_soundtrackCueAny, c_soundtrackIndexAny, false);
    SoundtrackSetContinuous(PlayerGroupAll(), c_soundtrackCategoryAmbience, true);

campaigns/liberty.sc2campaign — base.sc2maps/maps/campaign/tzeratul03.sc2map/MapScript.galaxy:5317

    GameSetBackground(c_backgroundFixed, "AiurSkybox", 100.0);
    CreepModify(RegionGetCenter(RegionFromId(20)), 25.0, true, false);
    GameSetToDLighting("AiurFlashback");
    CameraApplyInfo(gv_p01_USER, CameraInfoFromId(563), 0.0, -1, 10, true);
    auto1EA24EA5_g = UnitGroup(null, gv_p05_ZERG_LOW_GROUND_NOAI, RegionFromId(20), UnitFilter(0, 0, (1 << c_targetFilterMissile), (1 << (c_targetFilterDead - 32)) | (1 << (c_targetFilterHidden - 32))), 0);

campaigns/liberty.sc2campaign — base.sc2maps/maps/campaign/tzeratul03.sc2map/MapScript.galaxy:5497

    libNtve_gf_PlayAnimationOnDoodadsInRegion(RegionEntireMap(), "RainEmitterMedium", c_animNameDefault, "Stand", 0, c_animTimeDefault);
    GameSetBackground(c_backgroundTerrain, "AvernusSkybox", 100.0);
    GameSetToDLighting("Aiur");
    CameraApplyInfo(gv_p01_USER, CameraInfoFromId(112), 0.0, -1, 10, true);
    CameraApplyInfo(gv_p01_USER, CameraInfoFromId(193), 12.0, -1, 10, true);

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

    CameraSetBounds(PlayerGroupAll(), RegionFromId(19), true);
    GameSetToDLighting("Shakuras");
    GameTimeOfDaySet("08:00:00");
    libNtve_gf_PlayAnimationOnDoodadsInRegion(RegionEntireMap(), "ProtossEnergyLine", c_animNameDefault, "Stand Work", c_animFlagPlayForever, c_animTimeDefault);

campaigns/liberty.sc2campaign/base.sc2maps/maps/campaign/thanson02.sc2map — MapScript.galaxy:679

    }

    GameSetToDLighting("MeinhoffCampaignDay");
    GameTimeOfDaySet("12:00:00");
    GameTimeOfDayPause(true);

campaigns/liberty.sc2campaign/base.sc2maps/maps/campaign/thanson02.sc2map — MapScript.galaxy:4705

    gv_inCinematic = true;
    gv_gameOver = true;
    GameSetToDLighting("MeinhoffCampaignDay");
    GameTimeOfDaySet("12:00:00");
    libNtve_gf_SetAlliance(gv_pLAYER_03_INFESTED_REFUGEES, gv_pLAYER_02_REFUGEES, libNtve_ge_AllianceSetting_Enemy);

campaigns/liberty.sc2campaign/base.sc2maps/maps/campaign/thanson03a.sc2map — MapScript.galaxy:802

    }

    GameSetToDLighting("Haven");
    GameTimeOfDayPause(true);
    VisRevealerCreate(gv_pLAYER01_USER, RegionCircle(RegionGetCenter(RegionFromId(9)), 10.0));

campaigns/liberty.sc2campaign/base.sc2maps/maps/campaign/thanson03a.sc2map — MapScript.galaxy:6531

    UnitClearSelection(gv_pLAYER01_USER);
    PlayerSetState(gv_pLAYER01_USER, c_playerStateXPGain, false);
    GameSetToDLighting("Haven");
    GameTimeOfDaySet("12:00:00");
    UnitPauseAll(true);

campaigns/liberty.sc2campaign/base.sc2maps/maps/campaign/traynor03.sc2map — MapScript.galaxy:728

    }

    GameSetToDLighting("MarSaraCampaignNight");
    GameTimeOfDaySet("18:00:00");
    GameTimeOfDayPause(true);

campaigns/liberty.sc2campaign/base.sc2maps/maps/campaign/traynor03.sc2map — MapScript.galaxy:5081

    UnitClearSelection(gv_pLAYER01_USER);
    PlayerSetState(gv_pLAYER01_USER, c_playerStateXPGain, false);
    GameSetToDLighting("MarSaraCampaignDay");
    GameTimeOfDaySet("12:00:00");
    libNtve_gf_PlayAnimationOnDoodadsInRegion(RegionPlayableMap(), "RainEmitterMedium", c_animNameDefault, "Death", c_animFlagPlayForever, c_animTimeDefault);

campaigns/liberty.sc2campaign/base.sc2maps/maps/campaign/ttychus04.sc2map — MapScript.galaxy:566

    GameTimeOfDaySet("08:00:00");
    GameSetToDLighting("Typhon");
    RegionPlayableMapSet(RegionFromId(17));
    return true;

campaigns/liberty.sc2campaign/base.sc2maps/maps/campaign/ttychus04.sc2map — MapScript.galaxy:3332

    }

    GameSetToDLighting("MeinhoffCampaign");
    GameTimeOfDaySet("12:00:00");
    CameraApplyInfo(gv_pLAYER01_USER, CameraInfoFromId(1051), 0.0, -1, 10, true);

campaigns/liberty.sc2campaign/base.sc2maps/maps/campaign/ttychus04.sc2map — MapScript.galaxy:3366

    }

    GameSetToDLighting("MeinhoffCampaign");
    GameTimeOfDaySet("08:00:00");
    libNtve_gf_CreateUnitsAtPoint2(1, "WallOfFire", 0, gv_pLAYER08_DEATHSUN, PointFromId(419));

campaigns/liberty.sc2campaign/base.sc2maps/maps/campaign/tzeratul03.sc2map — MapScript.galaxy:4441

    libNtve_gf_CreateUnitsAtPoint2(1, "Ultralisk", 0, gv_p05_ZERG_LOW_GROUND_NOAI, PointFromId(680));
    gv_briefingUltra3 = UnitLastCreated();
    GameSetToDLighting("AiurFlashbackStart");
    CreepModify(RegionGetCenter(RegionFromId(20)), 25.0, true, false);
    libNtve_gf_PlayAnimationOnDoodadsInRegion(RegionEntireMap(), "RainEmitterMedium", c_animNameDefault, "Death", c_animFlagNonLooping, c_animTimeDefault);

campaigns/liberty.sc2campaign/base.sc2maps/maps/campaign/tzeratul03.sc2map — MapScript.galaxy:5182

    GameSetBackground(c_backgroundFixed, "AiurSkybox", 100.0);
    GameSetToDLighting("Aiur");
    CameraApplyInfo(gv_p01_USER, CameraInfoFromId(167), 0.0, -1, 10, true);
    SoundtrackPlay(PlayerGroupAll(), c_soundtrackCategoryMusic, "TZeratul03MusicOutro", c_soundtrackCueAny, c_soundtrackIndexAny, false);

campaigns/liberty.sc2campaign/base.sc2maps/maps/campaign/tzeratul03.sc2map — MapScript.galaxy:5246

    CreepModify(PointFromId(230), 25.0, true, false);
    CreepModify(PointFromId(230), 5.0, false, false);
    GameSetToDLighting("AiurFlashback");
    SoundtrackPlay(PlayerGroupAll(), c_soundtrackCategoryAmbience, "Ambience_Char", c_soundtrackCueAny, c_soundtrackIndexAny, false);
    SoundtrackSetContinuous(PlayerGroupAll(), c_soundtrackCategoryAmbience, true);

campaigns/liberty.sc2campaign/base.sc2maps/maps/campaign/tzeratul03.sc2map — MapScript.galaxy:5317

    GameSetBackground(c_backgroundFixed, "AiurSkybox", 100.0);
    CreepModify(RegionGetCenter(RegionFromId(20)), 25.0, true, false);
    GameSetToDLighting("AiurFlashback");
    CameraApplyInfo(gv_p01_USER, CameraInfoFromId(563), 0.0, -1, 10, true);
    auto1EA24EA5_g = UnitGroup(null, gv_p05_ZERG_LOW_GROUND_NOAI, RegionFromId(20), UnitFilter(0, 0, (1 << c_targetFilterMissile), (1 << (c_targetFilterDead - 32)) | (1 << (c_targetFilterHidden - 32))), 0);

campaigns/liberty.sc2campaign/base.sc2maps/maps/campaign/tzeratul03.sc2map — MapScript.galaxy:5497

    libNtve_gf_PlayAnimationOnDoodadsInRegion(RegionEntireMap(), "RainEmitterMedium", c_animNameDefault, "Stand", 0, c_animTimeDefault);
    GameSetBackground(c_backgroundTerrain, "AvernusSkybox", 100.0);
    GameSetToDLighting("Aiur");
    CameraApplyInfo(gv_p01_USER, CameraInfoFromId(112), 0.0, -1, 10, true);
    CameraApplyInfo(gv_p01_USER, CameraInfoFromId(193), 12.0, -1, 10, true);

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

    CameraSetBounds(PlayerGroupAll(), RegionFromId(19), true);
    GameSetToDLighting("Shakuras");
    GameTimeOfDaySet("08:00:00");
    libNtve_gf_PlayAnimationOnDoodadsInRegion(RegionEntireMap(), "ProtossEnergyLine", c_animNameDefault, "Stand Work", c_animFlagPlayForever, c_animTimeDefault);

mods/novastoryassets.sc2mod — base2.sc2maps/maps/campaign/nova/nova05.sc2map/MapScript.galaxy:3648

    GameTimeOfDaySet("08:00:00");
    GameSetToDLighting("JarbanMinor_Jungle");
    libLbty_gf_AutoRevealRegion(RegionFromId(65), RegionFromId(65), gv_pLAYER_01_USER);
    libLbty_gf_AutoRevealRegion(RegionFromId(74), RegionFromId(74), gv_pLAYER_01_USER);

mods/novastoryassets.sc2mod/base2.sc2maps/maps/campaign/nova/nova05.sc2map — MapScript.galaxy:3648

    GameTimeOfDaySet("08:00:00");
    GameSetToDLighting("JarbanMinor_Jungle");
    libLbty_gf_AutoRevealRegion(RegionFromId(65), RegionFromId(65), gv_pLAYER_01_USER);
    libLbty_gf_AutoRevealRegion(RegionFromId(74), RegionFromId(74), gv_pLAYER_01_USER);