PreGame (Civ5 Type)

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

				___________________________
				bool	CanReadyLocalPlayer()
					ClearDLCAllowed

G

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

H

				___________________________
				bool	HasPassword(PlayerID player)

I

				___________________________
				bool	IsCivilizationKeyAvailable(PlayerID player)
				bool	IsDLCAllowed(unknown arg0)
				bool	IsEarthMap()
				int	IsHotSeatGame()
				int	IsInternetGame()
					IsLeaderKeyAvailable
				int	IsMultiplayerGame()
					IsPrivateGame
				bool	IsRandomMapScript()
				bool	IsRandomWorldSize()
				int	IsReady(PlayerID player)
				bool	IsVictory(string arg0)

L

				___________________________
					LoadPreGameSettings()

R

				___________________________
					RandomizeMapSeed()
				int	ReadActiveSlotCountFromSaveGame()
					Reset()
					ResetGameOptions()
					ResetMapOptions()
					ResetSlots()

S

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

T

				___________________________
				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.