# Set Help Item Darkened When Viewed
Grammar — Set the Darkened When Viewed Flag of helpItem to darkened
Flags —Native
|Action
Flags the specified help item to darken when it’s marked as having been viewed by the player.
# Arguments
int
<preset::HelpItem> — HelpItembool
— Darkened
Returns — void
native void HelpPanelSetHelpItemDarkenedWhenViewed(
int inHelpItemId,
bool inDarkened,
);
# Related
Category: UI / Help Panel
- Help Item — preset —
int
- Destroy HelpItem —
void
— HelpPanelDestroyHelpItem - Last Created HelpItem —
int
<preset::HelpItem> — HelpPanelLastCreatedHelpItem - Display Help Page —
void
— HelpPanelDisplayPage - Create Tip —
void
— HelpPanelAddTip - Destroy All Tips —
void
— HelpPanelDestroyAllTips - Destroy All Tutorials —
void
— HelpPanelDestroyAllTutorials - Format Tip Title —
text
— libNtve_gf_FormatTipTitle - Clear All Tip Alerts —
void
— TipAlertPanelClear - Create Cheat —
void
— HelpPanelAddHint - Create Tutorial —
void
— HelpPanelAddTutorial - Create Message Log Entry —
void
— HelpPanelAddMessage - Enable/Disable Help Panel Tech Tree Button —
void
— HelpPanelEnableTechTreeButton - Enable/Disable Help Panel Tech Glossary Button —
void
— HelpPanelEnableTechGlossaryButton - Show/Hide Help Panel Tech Tree Race —
void
— HelpPanelShowTechTreeRace - Show/Hide Help For Unit —
void
— TechTreeUnitHelp - Set Help Panel Default Visibility —
void
— TechTreeUnitHelpDefault - Set Help Item Darkened When Viewed —
void
— HelpPanelSetHelpItemDarkenedWhenViewed
# Examples
campaigns/swarmstory.sc2campaign — base.sc2data/TriggerLibs/SwarmCampaignLib.galaxy:2200
for ( ; ( (auto01EE6C5A_ai >= 0 && lv_index <= auto01EE6C5A_ae) || (auto01EE6C5A_ai < 0 && lv_index >= auto01EE6C5A_ae) ) ; lv_index += auto01EE6C5A_ai ) {
HelpPanelAddTip(PlayerGroupAll(), libNtve_gf_FormatTipTitle(UserDataGetText("CampaignTips", libSwaC_gv_zS_MissionTip[lv_index], "Name", 1), libNtve_ge_TipType_NormalTip), UserDataGetText("CampaignTips", libSwaC_gv_zS_MissionTip[lv_index], "Description", 1), UserDataGetText("CampaignTips", libSwaC_gv_zS_MissionTip[lv_index], "Name", 1), UserDataGetImagePath("CampaignTips", libSwaC_gv_zS_MissionTip[lv_index], "Icon", 1));
HelpPanelSetHelpItemDarkenedWhenViewed(HelpPanelLastCreatedHelpItem(), false);
}
}
campaigns/swarmstory.sc2campaign — base.sc2data/TriggerLibs/SwarmCampaignLib.galaxy:16710
TriggerEnable(libSwaC_gt_ZS_ResourcePickup, true);
HelpPanelAddTip(PlayerGroupAll(), libNtve_gf_FormatTipTitle(UserDataGetText("CampaignTips", "MineralPickup", "Name", 1), libNtve_ge_TipType_NormalTip), UserDataGetText("CampaignTips", "MineralPickup", "Description", 1), UserDataGetText("CampaignTips", "MineralPickup", "Name", 1), UserDataGetImagePath("CampaignTips", "MineralPickup", "Icon", 1));
HelpPanelSetHelpItemDarkenedWhenViewed(HelpPanelLastCreatedHelpItem(), false);
return true;
}
campaigns/swarmstoryutil.sc2mod — base.sc2data/Lib281DEC45.galaxy:2165
}
HelpPanelAddTip(PlayerGroupAll(), libNtve_gf_FormatTipTitle(UserDataGetText("CampaignTips", lp_tip, "Name", 1), libNtve_ge_TipType_NormalTip), UserDataGetText("CampaignTips", lp_tip, "Description", 1), UserDataGetText("CampaignTips", lp_tip, "Name", 1), UserDataGetImagePath("CampaignTips", lp_tip, "Icon", 1));
HelpPanelSetHelpItemDarkenedWhenViewed(HelpPanelLastCreatedHelpItem(), false);
}
campaigns/voidstory.sc2campaign — base.sc2data/TriggerLibs/VoidCampaignStoryLib.galaxy:1367
HelpPanelAddTip(PlayerGroupAll(), libNtve_gf_FormatTipTitle(UserDataGetText("CampaignTips", lp_tip, "Name", 1), libNtve_ge_TipType_NormalTip), UserDataGetText("CampaignTips", lp_tip, "Description", 1), UserDataGetText("CampaignTips", lp_tip, "Name", 1), UserDataGetImagePath("CampaignTips", lp_tip, "Icon", 1));
HelpPanelSetHelpItemDarkenedWhenViewed(HelpPanelLastCreatedHelpItem(), false);
}
mods/missionpacks/novacampaign.sc2mod — base.sc2data/LibNCST.galaxy:1248
HelpPanelAddTip(PlayerGroupAll(), libNtve_gf_FormatTipTitle(UserDataGetText("CampaignTips", lp_tip, "Name", 1), libNtve_ge_TipType_NormalTip), UserDataGetText("CampaignTips", lp_tip, "Description", 1), UserDataGetText("CampaignTips", lp_tip, "Name", 1), UserDataGetImagePath("CampaignTips", lp_tip, "Icon", 1));
HelpPanelSetHelpItemDarkenedWhenViewed(HelpPanelLastCreatedHelpItem(), false);
}
mods/voidprologue.sc2mod — base.sc2data/LibA3DDD02B.galaxy:1498
for ( ; ( (auto01EE6C5A_ai >= 0 && lv_index <= auto01EE6C5A_ae) || (auto01EE6C5A_ai < 0 && lv_index >= auto01EE6C5A_ae) ) ; lv_index += auto01EE6C5A_ai ) {
HelpPanelAddTip(PlayerGroupAll(), libNtve_gf_FormatTipTitle(UserDataGetText("CampaignTips", libA3DDD02B_gv_pP_MissionTip[lv_index], "Name", 1), libNtve_ge_TipType_NormalTip), UserDataGetText("CampaignTips", libA3DDD02B_gv_pP_MissionTip[lv_index], "Description", 1), UserDataGetText("CampaignTips", libA3DDD02B_gv_pP_MissionTip[lv_index], "Name", 1), UserDataGetImagePath("CampaignTips", libA3DDD02B_gv_pP_MissionTip[lv_index], "Icon", 1));
HelpPanelSetHelpItemDarkenedWhenViewed(HelpPanelLastCreatedHelpItem(), false);
}
}
mods/voidprologue.sc2mod — base.sc2data/LibA3DDD02B.galaxy:8026
TriggerEnable(libA3DDD02B_gt_PP_ResourcePickup, true);
HelpPanelAddTip(PlayerGroupAll(), libNtve_gf_FormatTipTitle(UserDataGetText("CampaignTips", "Zealot", "Name", 1), libNtve_ge_TipType_NormalTip), UserDataGetText("CampaignTips", "Zealot", "Description", 1), UserDataGetText("CampaignTips", "Zealot", "Name", 1), UserDataGetImagePath("CampaignTips", "Zealot", "Icon", 1));
HelpPanelSetHelpItemDarkenedWhenViewed(HelpPanelLastCreatedHelpItem(), false);
return true;
}
mods/warcoop/warmeleeai.sc2mod — base.sc2data/LibW3AI.galaxy:106
TextExpressionSetToken("Param/Expression/lib_W3AI_E3E15860", "title", UserDataGetText(lv_type, lv_entry, "Title", 1));
HelpPanelAddTip(PlayerGroupAll(), TextExpressionAssemble("Param/Expression/lib_W3AI_E3E15860"), UserDataGetText(lv_type, lv_entry, "Patch Notes", 1), StringToText(""), UserDataGetImagePath(lv_type, lv_entry, "Icon", 1));
HelpPanelSetHelpItemDarkenedWhenViewed(HelpPanelLastCreatedHelpItem(), false);
}
TipAlertPanelClear(PlayerGroupAll());
mods/warcoop/warmeleeai.sc2mod — base.sc2data/LibW3AI.galaxy:132
TextExpressionSetToken("Param/Expression/lib_W3AI_665882ED", "title", UserDataGetText(lv_type, lv_entry, "Title", 1));
HelpPanelAddTip(PlayerGroupAll(), TextExpressionAssemble("Param/Expression/lib_W3AI_665882ED"), UserDataGetText(lv_type, lv_entry, "Patch Notes", 1), StringToText(""), "Assets\\Textures\\BTN\\war3_btnengineeringupgrade.dds");
HelpPanelSetHelpItemDarkenedWhenViewed(HelpPanelLastCreatedHelpItem(), false);
}
TipAlertPanelClear(PlayerGroupAll());