Home › Engine Lua tables › Challenges

Engine executable. Settings and tools of the game program (CivilizationVI.exe), usable without a mod. Mostly undocumented debug and configuration functionality; descriptions come from analysis of the executable and have not all been tried in the running game.

Challenges

Static table with 26 methods. named from how the game scripts call it (24 of 26 methods matched). Registering function 0xb74a0.

Methods are called with a dot (Challenges.Method(...)).

Method	Returns	In game scripts	Example	Status
`Challenges.BindCarouselEntryImageToButtonControl(arg1: integer, arg2, …) -> boolean, boolean, boolean`	boolean, boolean, boolean	1 calls, 1 files	`Challenges.BindCarouselEntryImageToButtonControl(entryIndex, instance.CarouselEntryButton)`	inferred
`Challenges.BindChallengeCarouselImageToControl(arg1: string, …) -> boolean, boolean, boolean`	boolean, boolean, boolean	not called	—	inferred
`Challenges.BindClickoutCarouselImageToControl(arg1: string, …) -> boolean, boolean, boolean`	boolean, boolean, boolean	not called	—	inferred
`Challenges.BindCustomChallengeBadgeImageToControl(arg1: string, arg2, …) -> boolean, boolean, boolean`	boolean, boolean, boolean	1 calls, 1 files	`Challenges.BindCustomChallengeBadgeImageToControl(challengeId, instance.Icon)`	inferred
`Challenges.ChallengeHasCustomBadge(arg1: string) -> boolean`	boolean	1 calls, 1 files	`if (g_CurrentRuleset.ChallengeIds and Challenges.ChallengeHasCustomBadge(g_CurrentRuleset.ChallengeIds)`	inferred
`Challenges.GetCarouselAnimationDurationMS() -> number`	number	1 calls, 1 files	`m_carouselAnimationDurationMS = Challenges.GetCarouselAnimationDurationMS()`	inferred
`Challenges.GetCarouselDisplayDurationMS() -> number`	number	1 calls, 1 files	`m_carouselDisplayDurationMS = Challenges.GetCarouselDisplayDurationMS()`	inferred
`Challenges.GetCarouselEntryCount() -> number`	number	3 calls, 1 files	`local entryCount = Challenges.GetCarouselEntryCount()`	inferred
`Challenges.GetCarouselEntryType(arg1: integer, …) -> 1 value`	1 value	1 calls, 1 files	`local carouselEntryType = Challenges.GetCarouselEntryType(selected)`	inferred
`Challenges.GetChallengeBadgeDisplayInfo(arg1: string, …) -> table`	table	1 calls, 1 files	`local badgeDisplayInfo = Challenges.GetChallengeBadgeDisplayInfo(challengeId)`	inferred
`Challenges.GetChallengeLeaderProgress(arg1: string, …) -> table, table, number, number`	table, table, number, number	1 calls, 1 files	`leaderProgress = Challenges.GetChallengeLeaderProgress(g_CurrentRuleset.ChallengeIds)`	inferred
`Challenges.GetChallengeVictoryProgress(arg1: string, …) -> table, table, number, boolean`	table, table, number, boolean	1 calls, 1 files	`victoryProgress = Challenges.GetChallengeVictoryProgress(g_CurrentRuleset.ChallengeIds)`	inferred
`Challenges.GetGames(arg1: string, …) -> table`	table	1 calls, 1 files	`games = Challenges.GetGames(g_CurrentRuleset.ChallengeIds)`	inferred
`Challenges.GetHasOnlyOneWinForActiveChallenge() -> boolean, boolean`	boolean, boolean	1 calls, 1 files	`if (Challenges.GetHasOnlyOneWinForActiveChallenge()`	inferred
`Challenges.GetLocalizedChallengeLoadingScreenDescriptionText(…) -> 1 value`	1 value	1 calls, 1 files	`challengeInfoText = Challenges.GetLocalizedChallengeLoadingScreenDescriptionText()`	inferred
`Challenges.GetLocalizedChallengeNameText(…) -> 1 value`	1 value	1 calls, 1 files	`challengeName = Challenges.GetLocalizedChallengeNameText()`	inferred
`Challenges.GetLocalizedNewChallengePackagePopupText(…) -> 1 value`	1 value	1 calls, 1 files	`local popupText = Challenges.GetLocalizedNewChallengePackagePopupText()`	inferred
`Challenges.GetLocalizedTextForBadgeEarnedPopup(…) -> 1 value`	1 value	1 calls, 1 files	`local badgeEarnedPopupText = Challenges.GetLocalizedTextForBadgeEarnedPopup()`	inferred
`Challenges.IsChallengeActive() -> boolean`	boolean	2 calls, 1 files	`if (Challenges.IsChallengeActive()`	inferred
`Challenges.IsNullChallengeUuid(arg1: string) -> boolean`	boolean	2 calls, 2 files	`not Challenges.IsNullChallengeUuid(m_thisLoadFile.GameChallengeUuid)`	inferred
`Challenges.LoadCarouselEntry(arg1: integer)`	—	2 calls, 1 files	`Challenges.LoadCarouselEntry(selected)`	inferred
`Challenges.PublishCarouselEntryClick(arg1: integer)`	—	1 calls, 1 files	`Challenges.PublishCarouselEntryClick(selected)`	inferred
`Challenges.PublishCarouselEntryImpression(arg1: integer, arg2: string)`	—	1 calls, 1 files	`Challenges.PublishCarouselEntryImpression(m_currentCarouselEntry - 1, scrollType)`	inferred
`Challenges.PublishHallOfFameBadgeEarned(arg1: string)`	—	1 calls, 1 files	`Challenges.PublishHallOfFameBadgeEarned(GameInfo.Victories[victoryType].Name)`	inferred
`Challenges.ShouldShowNewPackageAvailablePopup() -> boolean, boolean`	boolean, boolean	1 calls, 1 files	`if (Challenges.ShouldShowNewPackageAvailablePopup()`	inferred
`Challenges.ShouldShowRestartToGetNewPackagePopup(arg1) -> boolean, boolean`	boolean, boolean	1 calls, 1 files	`if (Challenges.ShouldShowRestartToGetNewPackagePopup(g_PopupDialog:IsOpen())`	inferred