Modding (Civ5 Type)

From Civilization Modding Wiki
Jump to navigationJump to search

This page is a part of the Lua and UI Reference (Civ5).


Static Methods

Methods are functions that belong to an object. Static methods are invoked through a dot, as in Modding.SomeMethod(<args>). When a dot is used the caller object is not implicitly provided as the first argument.

A

Base game Gods & Kings ___________________________
ActivateAllowedDLC()
ActivateDLC()
ActivateEnabledMods()
ActivateModsAndDLCForReplay(unknown replayFile)
ActivateSpecificMod(string tutorialModId, unknown tutorialModVersion)
bool AllEnabledModsContainPropertyValue(string arg0, int arg1)
int AnyActivatedModsContainPropertyValue(string arg0, string arg1)
int AnyEnabledModsContainPropertyValue(string arg0, int arg1)

C

Base game Gods & Kings ___________________________
bool CanDeleteMod(unknown modId, int modVersion)
table(int => int) CanEnableMod(table(int => table) modsToTestCanEnable)
bool CanLoadCloudSave(SpecialistType selected)
int CanLoadReplay(unknown arg0)
int CanLoadSavedGame(bool arg0)
bool CanUnsubscribeMod(unknown modId, int modVersion)

D

Base game Gods & Kings ___________________________
DeactivateMods()
DeleteMod(unknown arg0, int arg1)
DeleteUserData(unknown arg0, int arg1)
DisableMod(Button modID, Button version)

E

Base game Gods & Kings ___________________________
EnableMod(Button modID, Button version)

G

Base game Gods & Kings ___________________________
unknown GetActivatedModEntryPoints(string arg0)
table(unknown => unknown) GetActivatedMods()
unknown GetActivatedModVersion(string myModId)
unknown, unknown GetCloudSaveRequirements(SpecialistType selected)
table(int => ModDependency) GetDlcAssociations(string modId, int modVersion)
unknown, unknown GetDlcNameDescriptionKeys(int packageId)
int, int GetDownloadProgress(unknown arg0)
table(unknown => unknown) GetEnabledModsByActivationOrder()
unknown GetEvaluatedFilePath(string myModId, unknown myModVersion, string customImage)
table(int => ModDependency) GetGameVersionAssociations(string modId, int modVersion)
iterator(ScenarioInfo) GetInstalledFiraxisScenarios()
unknown GetInstalledModDetails(unknown modId, int modVersion)
unknown GetInstallProgress()
unknown GetLatestInstalledModVersion(string tutorialModId)
table(int => MapFileInfo) GetMapFiles()
table(int => ModDependency) GetModAssociations(string modId, int modVersion)
table(int => ModInfo) GetModBrowserDownloadingListings()
table(string => ModInfo) GetModBrowserInstalledListings()
unknown GetModProperty(unknown arg0, unknown arg1, string arg2)
unknown GetModsBrowserInstalledListingsState()
int GetModsRequiredToDisableMod(Button modID, Button version)
unknown, unknown GetReplayRequirements(unknown arg0)
unknown, unknown GetSavedGameRequirements(bool arg0)
string GetSystemProperty(string arg0)

H

Base game Gods & Kings ___________________________
bool HasPendingInstalls()
bool HasUserData(unknown arg0, int arg1)

I

Base game Gods & Kings ___________________________
unknown InstallMods()

O

Base game Gods & Kings ___________________________
Slider OpenSaveData()
Slider OpenUserData(string TutorialID, unknown latestTutorialVersion)

P

Base game Gods & Kings ___________________________
PerformActions(string arg0)
bool PublishedFileIdsMatch(unknown arg0, unknown arg1)

S

Base game Gods & Kings ___________________________
SetSystemProperty(string arg0, string arg1)

U

Base game Gods & Kings ___________________________
UnsubscribeMod(unknown arg0, int arg1)
UpdateMod(Button arg0, Button arg1)
UpdateModdingSystem()



The initial version of this page was created by the Civ5 API Bot, see the Civ5 API Reference FAQ. Some of the texts come from the 2kgames' wiki and most of code samples are copyrighted to Firaxis.
Functions' signatures were either copied from the 2kgames' wiki, or infered from the Lua source files and the binaries. Errors are possible.
Contributors may find help in the Contributors guide to the Civ5 API.