Modding (Civ5 Type)

From Civilization Modding Wiki
Jump to: navigation, 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 ___________________________
Check.png Check.png Star.png Speech.png ActivateAllowedDLC()
Check.png Check.png Star.png Speech.png ActivateDLC()
Check.png Check.png Star.png Speech.png ActivateEnabledMods()
Check.png Check.png Star.png Speech.png ActivateModsAndDLCForReplay(unknown replayFile)
Check.png Check.png Star.png Speech.png ActivateSpecificMod(string tutorialModId, unknown tutorialModVersion)
Check.png Check.png Star.png Speech.png bool AllEnabledModsContainPropertyValue(string arg0, int arg1)
Check.png Check.png Star.png Speech.png int AnyActivatedModsContainPropertyValue(string arg0, string arg1)
Check.png Check.png Star.png Speech.png int AnyEnabledModsContainPropertyValue(string arg0, int arg1)

C

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

D

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

E

Base game Gods & Kings ___________________________
Check.png Check.png Star.png Speech.png EnableMod(Button modID, Button version)

G

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

H

Base game Gods & Kings ___________________________
Check.png Check.png Star.png Speech.png bool HasPendingInstalls()
Check.png Check.png Star.png Speech.png bool HasUserData(unknown arg0, int arg1)

I

Base game Gods & Kings ___________________________
Check.png Check.png Star.png Speech.png unknown InstallMods()

O

Base game Gods & Kings ___________________________
Check.png Check.png Star.png Speech.png Slider OpenSaveData()
Check.png Check.png Star.png Speech.png Slider OpenUserData(string TutorialID, unknown latestTutorialVersion)

P

Base game Gods & Kings ___________________________
Check.png Check.png Star.png Speech.png PerformActions(string arg0)
Check.png Check.png Star.png Speech.png bool PublishedFileIdsMatch(unknown arg0, unknown arg1)

S

Base game Gods & Kings ___________________________
Check.png Check.png Star.png Speech.png SetSystemProperty(string arg0, string arg1)

U

Base game Gods & Kings ___________________________
Check.png Check.png Star.png Speech.png UnsubscribeMod(unknown arg0, int arg1)
Check.png Check.png Star.png Speech.png UpdateMod(Button arg0, Button arg1)
Check.png Check.png Star.png Speech.png 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.