PreGame (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 PreGame.SomeMethod(<args>). When a dot is used the caller object is not implicitly provided as the first argument.

C

Base game Gods & Kings ___________________________
Check.png Check.png Star.png Speech.png bool CanReadyLocalPlayer()
CheckButZero.png CheckButZero.png Star.png Speech.png Question-blue.png ClearDLCAllowed

G

Base game Gods & Kings ___________________________
Check.png Check.png Star.png Speech.png CivilizationType GetCivilization(PlayerID i = nil)
Check.png Check.png Star.png Speech.png string GetCivilizationAdjective(int EditSlot)
Check.png Check.png Star.png Speech.png int GetCivilizationColor(PlayerID player)
Check.png Check.png Star.png Speech.png string GetCivilizationDescription(PlayerID player)
CheckButZero.png CheckButZero.png Star.png Speech.png Question-blue.png GetCivilizationKey
CheckButZero.png CheckButZero.png Star.png Speech.png Question-blue.png GetCivilizationPackageID
Check.png Check.png Star.png Speech.png unknown GetCivilizationPackageTextKey(PlayerID player)
Check.png Check.png Star.png Speech.png string GetCivilizationShortDescription(PlayerID player)
Check.png Check.png Star.png Speech.png EraType GetEra()
Check.png Check.png Star.png Speech.png FileHeader GetFileHeader(string path)
Check.png Check.png Star.png Speech.png int GetGameOption(string arg0)
Check.png Check.png Star.png Speech.png GameSpeedType GetGameSpeed()
Check.png Check.png Star.png Speech.png GameType GetGameType()
Check.png Check.png Star.png Speech.png HandicapType GetHandicap(PlayerID player = nil)
CheckButZero.png CheckButZero.png Star.png Speech.png Question-blue.png GetLeaderKey
Check.png Check.png Star.png Speech.png string GetLeaderName(PlayerID player)
CheckButZero.png CheckButZero.png Star.png Speech.png Question-blue.png GetLeaderPackageID
CheckButZero.png CheckButZero.png Star.png Speech.png Question-blue.png GetLeaderPackageTextKey
CheckButZero.png CheckButZero.png Star.png Speech.png Question-blue.png GetLeaderType
Check.png Check.png Star.png Speech.png string GetLoadFileName()
Check.png Check.png Star.png Speech.png int GetLoadWBScenario()
Check.png Check.png Star.png Speech.png int GetMapOption(MapOptionID arg0)
Check.png Check.png Star.png Speech.png string GetMapScript()
Check.png Check.png Star.png Speech.png int GetMaxTurns()
Check.png Check.png Star.png Speech.png bool GetMultiplayerAIEnabled()
Check.png Check.png Star.png Speech.png string GetNickName(PlayerID activePlayer)
Check.png Check.png Star.png Speech.png int GetNumMinorCivs()
CheckButZero.png CheckButZero.png Star.png Speech.png Question-blue.png GetOverrideScenarioHandicap
Check.png Check.png Star.png Speech.png string GetPassword(int EditSlot)
CheckButZero.png CheckButZero.png Star.png Speech.png Question-blue.png GetPersistSettings
Check.png Check.png Star.png Speech.png bool GetQuickCombat()
Check.png Check.png Star.png Speech.png bool GetQuickMovement()
Check.png Check.png Star.png Speech.png SlotClaim GetSlotClaim(PlayerID player)
Check.png Check.png Star.png Speech.png SlotStatus GetSlotStatus(PlayerID player)
Check.png Check.png Star.png Speech.png TeamID GetTeam(PlayerID player)
Check.png Check.png Star.png Speech.png HandicapType GetWorldSize()

H

Base game Gods & Kings ___________________________
Check.png Check.png Star.png Speech.png bool HasPassword(PlayerID player)

I

Base game Gods & Kings ___________________________
Check.png Check.png Star.png Speech.png bool IsCivilizationKeyAvailable(PlayerID player)
Check.png Check.png Star.png Speech.png bool IsDLCAllowed(unknown arg0)
Check.png Check.png Star.png Speech.png bool IsEarthMap()
Check.png Check.png Star.png Speech.png int IsHotSeatGame()
Check.png Check.png Star.png Speech.png int IsInternetGame()
CheckButZero.png CheckButZero.png Star.png Speech.png Question-blue.png IsLeaderKeyAvailable
Check.png Check.png Star.png Speech.png int IsMultiplayerGame()
CheckButZero.png CheckButZero.png Star.png Speech.png Question-blue.png IsPrivateGame
Check.png Check.png Star.png Speech.png bool IsRandomMapScript()
Check.png Check.png Star.png Speech.png bool IsRandomWorldSize()
Check.png Check.png Star.png Speech.png int IsReady(PlayerID player)
Check.png Check.png Star.png Speech.png bool IsVictory(string arg0)

L

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

R

Base game Gods & Kings ___________________________
Check.png Check.png Star.png Speech.png RandomizeMapSeed()
Check.png Check.png Star.png Speech.png int ReadActiveSlotCountFromSaveGame()
Check.png Check.png Star.png Speech.png Reset()
Check.png Check.png Star.png Speech.png ResetGameOptions()
Check.png Check.png Star.png Speech.png ResetMapOptions()
Check.png Check.png Star.png Speech.png ResetSlots()

S

Base game Gods & Kings ___________________________
Check.png Check.png Star.png Speech.png SetCivilization(PlayerID player, CivilizationType civ = nil)
Check.png Check.png Star.png Speech.png SetCivilizationAdjective(PlayerID EditSlot, string arg1)
Check.png Check.png Star.png Speech.png SetCivilizationDescription(PlayerID EditSlot, string arg1)
CheckButZero.png CheckButZero.png Star.png Speech.png Question-blue.png SetCivilizationKey
CheckButZero.png CheckButZero.png Star.png Speech.png Question-blue.png SetCivilizationPackageID
Check.png Check.png Star.png Speech.png SetCivilizationShortDescription(PlayerID EditSlot, string arg1)
Check.png Check.png Star.png Speech.png SetDLCAllowed(unknown arg0, bool check)
Check.png Check.png Star.png Speech.png SetEarthMap(bool arg0)
Check.png Check.png Star.png Speech.png SetEra(EraType id)
Check.png Check.png Star.png Speech.png SetGameOption(string arg0, bool check)
Check.png Check.png Star.png Speech.png SetGameSpeed(GameSpeedType id)
Check.png Check.png Star.png Speech.png SetGameType(GameType gameType)
Check.png Check.png Star.png Speech.png SetHandicap(PlayerID player, HandicapType id)
Check.png Check.png Star.png Speech.png SetInternetGame(int isInternet)
CheckButZero.png CheckButZero.png Star.png Speech.png Question-blue.png SetLeaderKey
Check.png Check.png Star.png Speech.png SetLeaderName(PlayerID EditSlot, string arg1)
CheckButZero.png CheckButZero.png Star.png Speech.png Question-blue.png SetLeaderPackageID
Check.png Check.png Star.png Speech.png SetLeaderType(int arg0, int arg1)
Check.png Check.png Star.png Speech.png SetLoadFileName(string thisLoadFile, bool arg1 = nil)
Check.png Check.png Star.png Speech.png SetLoadWBScenario(int arg0)
Check.png Check.png Star.png Speech.png SetMapOption(unknown arg0, bool check)
Check.png Check.png Star.png Speech.png SetMapScript(string CurrentMap)
Check.png Check.png Star.png Speech.png SetMaxTurns(string arg0)
CheckButZero.png CheckButZero.png Star.png Speech.png Question-blue.png SetMultiplayerAIEnabled
CheckButZero.png CheckButZero.png Star.png Speech.png Question-blue.png SetMultiplayerGame
Check.png Check.png Star.png Speech.png SetNickName(PlayerID EditSlot, string arg1)
Check.png Check.png Star.png Speech.png SetNumMinorCivs(int numMinorCivsWanted)
Check.png Check.png Star.png Speech.png SetOverrideScenarioHandicap(bool arg0)
Check.png Check.png Star.png Speech.png SetPassword(PlayerID player, string arg1, string arg2 = nil)
Check.png Check.png Star.png Speech.png SetPersistSettings(bool arg0)
Check.png Check.png Star.png Speech.png SetPlayerColor(int arg0, int arg1)
Check.png Check.png Star.png Speech.png SetPrivateGame(int checked)
Check.png Check.png Star.png Speech.png SetQuickCombat(unknown arg0)
Check.png Check.png Star.png Speech.png SetQuickMovement(unknown arg0)
Check.png Check.png Star.png Speech.png SetRandomMapScript(bool arg0)
Check.png Check.png Star.png Speech.png SetRandomWorldSize(bool arg0)
Check.png Check.png Star.png Speech.png SetReady(PlayerID arg0, bool checked = nil)
Check.png Check.png Star.png Speech.png SetSlotClaim(PlayerID player, SlotClaim arg1)
Check.png Check.png Star.png Speech.png SetSlotStatus(PlayerID i, SlotStatus arg1)
Check.png Check.png Star.png Speech.png SetTeam(PlayerID player, PlayerID playerChoice)
Check.png Check.png Star.png Speech.png SetVictory(VictoryType arg0, bool check)
Check.png Check.png Star.png Speech.png SetWorldSize(HandicapType id)

T

Base game Gods & Kings ___________________________
Check.png Check.png Star.png Speech.png int TestPassword(PlayerID player, string arg1)



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.