Lua Game Objects/Game: Difference between revisions
mNo edit summary |
|||
| (2 intermediate revisions by the same user not shown) | |||
| Line 3,299: | Line 3,299: | ||
==IsOption== | ==IsOption== | ||
''< | ''Retrieves the state of a specified Game Option<br>Use with [[Lua_Game_Objects/Game#SetOption|Game.SetOption]]'' | ||
'''Usage''' | '''Usage''' | ||
| Line 3,317: | Line 3,317: | ||
<pre> | <pre> | ||
Game.IsOption(GameOptionTypes.GAMEOPTION_NO_GOODY_HUTS); | |||
</pre> | </pre> | ||
| Line 4,300: | Line 4,300: | ||
==SetOption== | ==SetOption== | ||
''< | ''Sets the state of a specified Game Option<br>Can use with [[Lua_Game_Objects/Game#IsOption|Game.IsOption]] to get the state of a Game Option'' | ||
'''Usage''' | '''Usage''' | ||
| Line 4,309: | Line 4,309: | ||
:eIndex | :eIndex | ||
:: | ::[[Lua Game Objects/GameOptionTypes|GameOptionTypes]] ID | ||
:bEnabled | :bEnabled | ||
:: | ::Set Game Option on (true) or off (false) | ||
''' Returns''' | ''' Returns''' | ||
| Line 4,320: | Line 4,320: | ||
<pre> | <pre> | ||
Game.SetOption(GameOptionTypes.GAMEOPTION_NO_GOODY_HUTS, true); | |||
</pre> | </pre> | ||
Latest revision as of 14:04, 26 October 2011
The Game namespace represents the currently active CvGame instance.
Back to Lua Game Objects
Static Methods
AddPlayer
<summary>
Usage
void Game.addPlayer(PlayerTypes eNewPlayer, LeaderHeadTypes eLeader, CivilizationTypes eCiv);
Parameters
- eNewPlayer
- No Description Available
- eLeader
- No Description Available
- eCiv
- No Description Available
Returns
No Description Available.
Example
No Example Available
CalculateOptionsChecksum
<summary>
Usage
int Game.calculateOptionsChecksum();
Parameters
None
Returns
No Description Available.
Example
No Example Available
CalculateSyncChecksum
<summary>
Usage
int Game.calculateSyncChecksum();
Parameters
None
Returns
No Description Available.
Example
No Example Available
CanHandleAction
<summary>
Usage
boolean Game.CanHandleAction(int iAction, <Plot> pPlot, boolean bTestVisible);
Parameters
- iAction
- No Description Available
- pPlot
- No Description Available
- bTestVisible
- No Description Available
Returns
No Description Available.
Example
No Example Available
CanHaveSecretaryGeneral
<summary>
Usage
boolean Game.canHaveSecretaryGeneral(VoteSourceTypes eVoteSource);
Parameters
- eVoteSource
- No Description Available
Returns
No Description Available.
Example
No Example Available
CanTrainNukes
<summary>
Usage
boolean Game.canTrainNukes();
Parameters
None
Returns
No Description Available.
Example
No Example Available
ChangeDiploVote
<summary>
Usage
void Game.changeDiploVote(VoteSourceTypes eVoteSource, int iChange);
Parameters
- eVoteSource
- No Description Available
- iChange
- No Description Available
Returns
No Description Available.
Example
No Example Available
ChangeMaxTurns
<summary>
Usage
void Game.changeMaxTurns(int iChange);
Parameters
- iChange
- No Description Available
Returns
No Description Available.
Example
No Example Available
ChangeNoNukesCount
<summary>
Usage
void Game.changeNoNukesCount(int iChange);
Parameters
- iChange
- No Description Available
Returns
No Description Available.
Example
No Example Available
ChangeNukesExploded
<summary>
Usage
void Game.changeNukesExploded(int iChange);
Parameters
- iChange
- No Description Available
Returns
No Description Available.
Example
No Example Available
ChangePlotExtraCost
<summary>
Usage
void Game.changePlotExtraCost(int iX, int iY, int iExtraCost);
Parameters
- iX
- No Description Available
- iY
- No Description Available
- iExtraCost
- No Description Available
Returns
No Description Available.
Example
No Example Available
CityPurchaseBuilding
<summary>
Usage
void Game.cityPurchase(<City> pCity, UnitTypes eUnitType, BuildingTypes eBuildingType, ProjectTypes eProjectTypes);
Parameters
- pCity
- No Description Available
- eUnitType
- No Description Available
- eBuildingType
- No Description Available
- eProjectTypes
- No Description Available
Returns
No Description Available.
Example
No Example Available
CityPurchaseProject
<summary>
Usage
void Game.cityPurchase(<City> pCity, UnitTypes eUnitType, BuildingTypes eBuildingType, ProjectTypes eProjectTypes);
Parameters
- pCity
- No Description Available
- eUnitType
- No Description Available
- eBuildingType
- No Description Available
- eProjectTypes
- No Description Available
Returns
No Description Available.
Example
No Example Available
CityPurchaseUnit
<summary>
Usage
void Game.cityPurchase(<City> pCity, UnitTypes eUnitType, BuildingTypes eBuildingType, ProjectTypes eProjectTypes);
Parameters
- pCity
- No Description Available
- eUnitType
- No Description Available
- eBuildingType
- No Description Available
- eProjectTypes
- No Description Available
Returns
No Description Available.
Example
No Example Available
CityPushOrder
<summary>
Usage
void Game.cityPushOrder(<City> pCity, OrderTypes eOrder, int iData, boolean bAlt, boolean bShift, boolean bCtrl);
Parameters
- pCity
- No Description Available
- eOrder
- No Description Available
- iData
- No Description Available
- bAlt
- No Description Available
- bShift
- No Description Available
- bCtrl
- No Description Available
Returns
No Description Available.
Example
No Example Available
CountCivPlayersAlive
<summary>
Usage
int Game.CountCivPlayersAlive();
Parameters
None
Returns
No Description Available.
Example
No Example Available
CountCivPlayersEverAlive
<summary>
Usage
int Game.CountCivPlayersEverAlive();
Parameters
None
Returns
No Description Available.
Example
No Example Available
CountCivTeamsAlive
<summary>
Usage
int Game.CountCivTeamsAlive();
Parameters
None
Returns
No Description Available.
Example
No Example Available
CountCivTeamsEverAlive
<summary>
Usage
int Game.CountCivTeamsEverAlive();
Parameters
None
Returns
No Description Available.
Example
No Example Available
CountHumanPlayersAlive
<summary>
Usage
int Game.countHumanPlayersAlive();
Parameters
None
Returns
No Description Available.
Example
No Example Available
CountHumanPlayersEverAlive
<summary>
Usage
int Game.countHumanPlayersEverAlive();
Parameters
None
Returns
No Description Available.
Example
No Example Available
CountKnownTechNumTeams
<summary>
Usage
int Game.countKnownTechNumTeams(TechTypes eTech);
Parameters
- eTech
- No Description Available
Returns
No Description Available.
Example
No Example Available
CountNumHumanGameTurnActive
<summary>
Usage
int Game.countNumHumanGameTurnActive();
Parameters
None
Returns
No Description Available.
Example
No Example Available
CountPossibleVote
<summary>
Usage
int Game.countPossibleVote(VoteTypes eVote, VoteSourceTypes eVoteSource);
Parameters
- eVote
- No Description Available
- eVoteSource
- No Description Available
Returns
No Description Available.
Example
No Example Available
CountTotalCivPower
<summary>
Usage
int Game.countTotalCivPower();
Parameters
None
Returns
No Description Available.
Example
No Example Available
CountTotalNukeUnits
<summary>
Usage
int Game.countTotalNukeUnits();
Parameters
None
Returns
No Description Available.
Example
No Example Available
CycleCities
<summary>
Usage
void Game.cycleCities(boolean bForward, boolean bAdd);
Parameters
- bForward
- No Description Available
- bAdd
- No Description Available
Returns
No Description Available.
Example
No Example Available
CyclePlotUnits
<summary>
Usage
boolean Game.cyclePlotUnits(<Plot> pPlot, boolean bForward, boolean bAuto, int iCount);
Parameters
- pPlot
- No Description Available
- bForward
- No Description Available
- bAuto
- No Description Available
- iCount
- No Description Available
Returns
No Description Available.
Example
No Example Available
CycleUnits
<summary>
Usage
void Game.cycleUnits(boolean bClear, boolean bForward, boolean bWorkers);
Parameters
- bClear
- No Description Available
- bForward
- No Description Available
- bWorkers
- No Description Available
Returns
No Description Available.
Example
No Example Available
DoControl
<summary>
Usage
void Game.DoControl(ControlTypes eControl);
Parameters
- eControl
- No Description Available
Returns
No Description Available.
Example
No Example Available
DoFromUIDiploEvent
<summary>
Usage
void Game.DoFromUIDiploEvent(FromUIDiploEventTypes eEvent, PlayerTypes eAIPlayer, int iArg1, int iArg2, int iArg3);
Parameters
- eEvent
- No Description Available
- eAIPlayer
- No Description Available
- iArg1
- No Description Available
- iArg2
- No Description Available
- iArg3
- No Description Available
Returns
No Description Available.
Example
No Example Available
DoMinorGoldGift
<summary>
Usage
void Game.DoMinorGoldGift(int iGold);
Parameters
- iGold
- No Description Available
Returns
No Description Available.
Example
No Example Available
func) RegisterMethod(L, l##func, #func
<summary>
Usage
void Game.DoMinorGoldGift(int iGold);
Parameters
- iGold
- No Description Available
Returns
No Description Available.
Example
No Example Available
GameplayDiplomacyAILeaderMessage
<summary>
Usage
Game.();
Parameters
-
- No Description Available
Returns
No Description Available.
Example
No Example Available
GetActiveCivilizationType
<summary>
Usage
CivilizationTypes Game.getActiveCivilizationType();
Parameters
None
Returns
No Description Available.
Example
No Example Available
GetActivePlayer
<summary>
Usage
PlayerTypes Game.getActivePlayer();
Parameters
None
Returns
No Description Available.
Example
No Example Available
GetActiveTeam
<summary>
Usage
int Game.getActiveTeam();
Parameters
None
Returns
No Description Available.
Example
No Example Available
GetAdjustedLandPercent
<summary>
Usage
int Game.getAdjustedLandPercent(VictoryTypes eVictory);
Parameters
- eVictory
- No Description Available
Returns
No Description Available.
Example
No Example Available
GetAdjustedPopulationPercent
<summary>
Usage
int Game.getAdjustedPopulationPercent(VictoryTypes eVictory);
Parameters
- eVictory
- No Description Available
Returns
No Description Available.
Example
No Example Available
GetAdvisorCheckFlags
<summary>
Usage
Game.();
Parameters
-
- No Description Available
Returns
No Description Available.
Example
No Example Available
GetAdvisorCounsel
<summary>
Usage
Game.();
Parameters
-
- No Description Available
Returns
No Description Available.
Example
No Example Available
GetAIAutoPlay
<summary>
Usage
int Game.getAIAutoPlay();
Parameters
None
Returns
No Description Available.
Example
No Example Available
GetAllowRClickMovementWhileScrolling
<summary>
Usage
Game.();
Parameters
-
- No Description Available
Returns
No Description Available.
Example
No Example Available
GetBestGreatPeoplePlayer
<summary>
Usage
void Game.GetBestGreatPeoplePlayer();
Parameters
None
Returns
No Description Available.
Example
No Example Available
GetBestLandUnit
<summary>
Usage
UnitTypes Game.getBestLandUnit();
Parameters
None
Returns
No Description Available.
Example
No Example Available
GetBestLandUnitCombat
<summary>
Usage
int Game.getBestLandUnitCombat();
Parameters
None
Returns
No Description Available.
Example
No Example Available
GetBestPoliciesPlayer
<summary>
Usage
void Game.GetBestPoliciesPlayer();
Parameters
None
Returns
No Description Available.
Example
No Example Available
GetBestWondersPlayer
<summary>
Usage
void Game.GetBestWondersPlayer();
Parameters
None
Returns
No Description Available.
Example
No Example Available
GetBuildingClassCreatedCount
<summary>
Usage
int Game.getBuildingClassCreatedCount(BuildingClassTypes eIndex);
Parameters
- eIndex
- No Description Available
Returns
No Description Available.
Example
No Example Available
GetCalendar
<summary>
Usage
CalendarTypes Game.getCalendar();
Parameters
None
Returns
No Description Available.
Example
No Example Available
GetCurrentEra
<summary>
Usage
EraTypes Game.getCurrentEra();
Parameters
None
Returns
No Description Available.
Example
No Example Available
GetCustomOption
<summary>
Usage
Game.();
Parameters
-
- No Description Available
Returns
No Description Available.
Example
No Example Available
GetDiploResponse
<summary>
Usage
string Game.GetDiploResponse( leaderType, responseType);
Parameters
- leaderType
- No Description Available
- responseType
- No Description Available
Returns
No Description Available.
Example
No Example Available
GetElapsedGameTurns
<summary>
Usage
int Game.getElapsedGameTurns();
Parameters
None
Returns
No Description Available.
Example
No Example Available
GetEstimateEndTurn
<summary>
Usage
int Game.getEstimateEndTurn();
Parameters
None
Returns
No Description Available.
Example
No Example Available
GetGameSpeedType
<summary>
Usage
GameSpeedTypes Game.getGameSpeedType();
Parameters
None
Returns
No Description Available.
Example
No Example Available
GetGameState
<summary>
Usage
GameStateTypes Game.getGameState();
Parameters
None
Returns
No Description Available.
Example
No Example Available
GetGameTurn
<summary>
Usage
int Game.getGameTurn();
Parameters
None
Returns
No Description Available.
Example
No Example Available
GetGameTurnYear
<summary>
Usage
int Game.getGameTurnYear();
Parameters
None
Returns
No Description Available.
Example
No Example Available
GetHandicapType
<summary>
Usage
HandicapTypes Game.getHandicapType();
Parameters
None
Returns
No Description Available.
Example
No Example Available
GetImprovementUpgradeTime
<summary>
Usage
int Game.getImprovementUpgradeTime(ImprovementTypes eImprovement, <Plot> pPlot);
Parameters
- eImprovement
- No Description Available
- pPlot
- No Description Available
Returns
No Description Available.
Example
No Example Available
GetInitLand
<summary>
Usage
int Game.getInitLand();
Parameters
None
Returns
No Description Available.
Example
No Example Available
GetInitPopulation
<summary>
Usage
int Game.getInitPopulation();
Parameters
None
Returns
No Description Available.
Example
No Example Available
GetInitTech
<summary>
Usage
int Game.getInitTech();
Parameters
None
Returns
No Description Available.
Example
No Example Available
GetInitWonders
<summary>
Usage
int Game.getInitWonders();
Parameters
None
Returns
No Description Available.
Example
No Example Available
GetMaxCityElimination
<summary>
Usage
int Game.getMaxCityElimination();
Parameters
None
Returns
No Description Available.
Example
No Example Available
GetMaxLand
<summary>
Usage
int Game.getMaxLand();
Parameters
None
Returns
No Description Available.
Example
No Example Available
GetMaxPopulation
<summary>
Usage
int Game.getMaxPopulation();
Parameters
None
Returns
No Description Available.
Example
No Example Available
GetMaxTech
<summary>
Usage
int Game.getMaxTech();
Parameters
None
Returns
No Description Available.
Example
No Example Available
GetMaxTurns
<summary>
Usage
int Game.getMaxTurns();
Parameters
None
Returns
No Description Available.
Example
No Example Available
GetMaxWonders
<summary>
Usage
int Game.getMaxWonders();
Parameters
None
Returns
No Description Available.
Example
No Example Available
GetMinutesPlayed
<summary>
Usage
int Game.getMinutesPlayed();
Parameters
None
Returns
No Description Available.
Example
No Example Available
GetName
<summary>
Usage
wstring Game.getName();
Parameters
None
Returns
No Description Available.
Example
No Example Available
GetNoNukesCount
<summary>
Usage
int Game.getNoNukesCount();
Parameters
None
Returns
No Description Available.
Example
No Example Available
GetNukesExploded
<summary>
Usage
int Game.getNukesExploded();
Parameters
None
Returns
No Description Available.
Example
No Example Available
GetNumAdvancedStartPoints
<summary>
Usage
int Game.getNumAdvancedStartPoints();
Parameters
None
Returns
No Description Available.
Example
No Example Available
GetNumCities
<summary>
Usage
int Game.getNumCities();
Parameters
None
Returns
No Description Available.
Example
No Example Available
GetNumCivCities
<summary>
Usage
int Game.getNumCivCities();
Parameters
None
Returns
No Description Available.
Example
No Example Available
GetNumGameTurnActive
<summary>
Usage
int Game.getNumGameTurnActive();
Parameters
None
Returns
No Description Available.
Example
No Example Available
GetNumHumanPlayers
<summary>
Usage
int Game.getNumHumanPlayers();
Parameters
None
Returns
No Description Available.
Example
No Example Available
GetNumReplayMessages
<summary>
Usage
uint Game.getNumReplayMessages();
Parameters
None
Returns
No Description Available.
Example
No Example Available
GetNumResourceRequiredForBuilding
<summary>
Usage
Game.();
Parameters
-
- No Description Available
Returns
No Description Available.
Example
No Example Available
GetNumResourceRequiredForUnit
<summary>
Usage
Game.();
Parameters
-
- No Description Available
Returns
No Description Available.
Example
No Example Available
GetNumVictoryVotesTallied
<summary>
Usage
int Game.GetNumVictoryVotesTallied();
Parameters
None
Returns
No Description Available.
Example
No Example Available
GetNumVotesForTeam
<summary>
Usage
int Game.GetNumVotesForTeam();
Parameters
None
Returns
No Description Available.
Example
No Example Available
GetNumWorldWonders
<summary>
Usage
int Game.GetNumWorldWonders();
Parameters
None
Returns
No Description Available.
Example
No Example Available
GetPausePlayer
<summary>
Usage
int Game.getPausePlayer();
Parameters
None
Returns
No Description Available.
Example
No Example Available
GetPitbossTurnTime
<summary>
Usage
int Game.getPitbossTurnTime();
Parameters
None
Returns
No Description Available.
Example
No Example Available
GetPlayerRank
<summary>
Usage
int Game.getPlayerRank(PlayerTypes iIndex);
Parameters
- iIndex
- No Description Available
Returns
No Description Available.
Example
No Example Available
GetPlayerScore
<summary>
Usage
int Game.getPlayerScore(PlayerTypes iIndex);
Parameters
- iIndex
- No Description Available
Returns
No Description Available.
Example
No Example Available
GetPlayerVote
<summary>
Usage
int Game.getPlayerVote(PlayerTypes eOwnerIndex, int iVoteId);
Parameters
- eOwnerIndex
- No Description Available
- iVoteId
- No Description Available
Returns
No Description Available.
Example
No Example Available
GetProductionPerPopulation
<summary>
Usage
int Game.getProductionPerPopulation(HurryTypes eHurry);
Parameters
- eHurry
- No Description Available
Returns
No Description Available.
Example
No Example Available
GetProjectCreatedCount
<summary>
Usage
int Game.getProjectCreatedCount(ProjectTypes eIndex);
Parameters
- eIndex
- No Description Available
Returns
No Description Available.
Example
No Example Available
GetRankPlayer
<summary>
Usage
PlayerTypes Game.getRankPlayer(int iRank);
Parameters
- iRank
- No Description Available
Returns
No Description Available.
Example
No Example Available
GetRankTeam
<summary>
Usage
TeamTypes Game.getRankTeam(int iRank);
Parameters
- iRank
- No Description Available
Returns
No Description Available.
Example
No Example Available
GetReplayInfo
<summary>
Usage
Game.getReplayInfo();
Parameters
None
Returns
No Description Available.
Example
No Example Available
GetReplayMessageColor
<summary>
Usage
ColorTypes Game.getReplayMessageColor(int i);
Parameters
- i
- No Description Available
Returns
No Description Available.
Example
No Example Available
GetReplayMessagePlayer
<summary>
Usage
int Game.getReplayMessagePlayer(int i);
Parameters
- i
- No Description Available
Returns
No Description Available.
Example
No Example Available
GetReplayMessagePlotX
<summary>
Usage
int Game.getReplayMessagePlotX(int i);
Parameters
- i
- No Description Available
Returns
No Description Available.
Example
No Example Available
GetReplayMessagePlotY
<summary>
Usage
int Game.getReplayMessagePlotY(int i);
Parameters
- i
- No Description Available
Returns
No Description Available.
Example
No Example Available
GetReplayMessageText
<summary>
Usage
wstring Game.getReplayMessageText(int i);
Parameters
- i
- No Description Available
Returns
No Description Available.
Example
No Example Available
GetReplayMessageTurn
<summary>
Usage
int Game.getReplayMessageTurn(int i);
Parameters
- i
- No Description Available
Returns
No Description Available.
Example
No Example Available
GetReplayMessageType
<summary>
Usage
ReplayMessageTypes Game.getReplayMessageType(int i);
Parameters
- i
- No Description Available
Returns
No Description Available.
Example
No Example Available
GetResourceUsageType
<summary>
Usage
Game.();
Parameters
-
- No Description Available
Returns
No Description Available.
Example
No Example Available
GetScriptData
<summary>
Usage
string Game.getScriptData();
Parameters
None
Returns
No Description Available.
Example
No Example Available
GetSecretaryGeneral
<summary>
Usage
int Game.getSecretaryGeneral(VoteSourceTypes eVoteSource);
Parameters
- eVoteSource
- No Description Available
Returns
No Description Available.
Example
No Example Available
GetSecretaryGeneralTimer
<summary>
Usage
int Game.getSecretaryGeneralTimer(int iVoteSource);
Parameters
- iVoteSource
- No Description Available
Returns
No Description Available.
Example
No Example Available
GetStartEra
<summary>
Usage
EraTypes Game.getStartEra();
Parameters
None
Returns
No Description Available.
Example
No Example Available
GetStartTurn
<summary>
Usage
int Game.getStartTurn();
Parameters
None
Returns
No Description Available.
Example
No Example Available
GetStartYear
<summary>
Usage
int Game.getStartYear();
Parameters
None
Returns
No Description Available.
Example
No Example Available
GetTargetScore
<summary>
Usage
int Game.getTargetScore();
Parameters
None
Returns
No Description Available.
Example
No Example Available
GetTeamRank
<summary>
Usage
int Game.getTeamRank(TeamTypes iIndex);
Parameters
- iIndex
- No Description Available
Returns
No Description Available.
Example
No Example Available
GetTeamScore
<summary>
Usage
int Game.getTeamScore(TeamTypes iIndex);
Parameters
- iIndex
- No Description Available
Returns
No Description Available.
Example
No Example Available
GetTotalPopulation
<summary>
Usage
int Game.getTotalPopulation();
Parameters
None
Returns
No Description Available.
Example
No Example Available
GetTurnSlice
<summary>
Usage
int Game.getTurnSlice();
Parameters
None
Returns
No Description Available.
Example
No Example Available
GetTurnYear
<summary>
Usage
int Game.getTurnYear(int iGameTurn);
Parameters
- iGameTurn
- No Description Available
Returns
No Description Available.
Example
No Example Available
GetTutorialLevel
<summary>
Usage
Game.();
Parameters
-
- No Description Available
Returns
No Description Available.
Example
No Example Available
GetUnitClassCreatedCount
<summary>
Usage
int Game.getUnitClassCreatedCount(UnitClassTypes eIndex);
Parameters
- eIndex
- No Description Available
Returns
No Description Available.
Example
No Example Available
GetUnitCreatedCount
<summary>
Usage
int Game.getUnitCreatedCount(UnitTypes eIndex);
Parameters
- eIndex
- No Description Available
Returns
No Description Available.
Example
No Example Available
GetUnitedNationsCountdown
<summary>
Usage
boolean Game.GetUnitedNationsCountdown();
Parameters
None
Returns
No Description Available.
Example
No Example Available
GetVictory
<summary>
Usage
VictoryTypes Game.getVictory();
Parameters
None
Returns
No Description Available.
Example
No Example Available
GetVoteCast
<summary>
Usage
TeamTypes Game.GetVoteCast();
Parameters
None
Returns
No Description Available.
Example
No Example Available
GetVoteOutcome
<summary>
Usage
int Game.getVoteOutcome(VoteTypes eIndex);
Parameters
- eIndex
- No Description Available
Returns
No Description Available.
Example
No Example Available
GetVoteRequired
<summary>
Usage
int Game.getVoteRequired(VoteTypes eVote, VoteSourceTypes eVoteSource);
Parameters
- eVote
- No Description Available
- eVoteSource
- No Description Available
Returns
No Description Available.
Example
No Example Available
GetVotesNeededForDiploVictory
<summary>
Usage
int Game.GetVotesNeededForDiploVictory();
Parameters
None
Returns
No Description Available.
Example
No Example Available
GetVoteTimer
<summary>
Usage
int Game.getVoteTimer(int iVoteSource);
Parameters
- iVoteSource
- No Description Available
Returns
No Description Available.
Example
No Example Available
GetWinner
<summary>
Usage
TeamTypes Game.getWinner();
Parameters
None
Returns
No Description Available.
Example
No Example Available
GetWinningTurn
<summary>
Usage
int Game.GetWinningTurn();
Parameters
None
Returns
No Description Available.
Example
No Example Available
GoldenAgeLength
<summary>
Usage
int Game.goldenAgeLength();
Parameters
None
Returns
No Description Available.
Example
No Example Available
HandleAction
<summary>
Usage
void Game.HandleAction( iAction);
Parameters
- iAction
- No Description Available
Returns
No Description Available.
Example
No Example Available
IsBuildingClassMaxedOut
<summary>
Usage
boolean Game.isBuildingClassMaxedOut(BuildingClassTypes eIndex, int iExtra);
Parameters
- eIndex
- No Description Available
- iExtra
- No Description Available
Returns
No Description Available.
Example
No Example Available
IsBuildingEverActive
<summary>
Usage
boolean Game.isBuildingEverActive(BuildingTypes eBuilding);
Parameters
- eBuilding
- No Description Available
Returns
No Description Available.
Example
No Example Available
IsBuildingRecommended
<summary>
Usage
Game.();
Parameters
-
- No Description Available
Returns
No Description Available.
Example
No Example Available
IsChooseElection
<summary>
Usage
boolean Game.isChooseElection(VoteTypes eVote);
Parameters
- eVote
- No Description Available
Returns
No Description Available.
Example
No Example Available
<summary>
Usage
boolean Game.isCircumnavigated();
Parameters
None
Returns
No Description Available.
Example
No Example Available
IsCivEverActive
<summary>
Usage
boolean Game.isCivEverActive(CivilizationTypes eCivilization);
Parameters
- eCivilization
- No Description Available
Returns
No Description Available.
Example
No Example Available
IsCombatWarned
<summary>
Usage
Game.();
Parameters
-
- No Description Available
Returns
No Description Available.
Example
No Example Available
IsDebugMode
<summary>
Usage
boolean Game.isDebugMode();
Parameters
None
Returns
No Description Available.
Example
No Example Available
IsDiploVote
<summary>
Usage
boolean Game.isDiploVote(VoteSourceTypes eVoteSource);
Parameters
- eVoteSource
- No Description Available
Returns
No Description Available.
Example
No Example Available
IsEverAttackedTutorial
<summary>
Usage
Game.();
Parameters
-
- No Description Available
Returns
No Description Available.
Example
No Example Available
IsEverRightClickMoved
<summary>
Usage
Game.();
Parameters
-
- No Description Available
Returns
No Description Available.
Example
No Example Available
IsFinalInitialized
<summary>
Usage
boolean Game.isFinalInitialized();
Parameters
None
Returns
No Description Available.
Example
No Example Available
IsGameMultiPlayer
<summary>
Usage
boolean Game.isGameMultiPlayer();
Parameters
None
Returns
No Description Available.
Example
No Example Available
IsHotSeat
<summary>
Usage
boolean Game.isHotSeat();
Parameters
None
Returns
No Description Available.
Example
No Example Available
IsInAdvancedStart
<summary>
Usage
boolean Game.isInAdvancedStart();
Parameters
None
Returns
No Description Available.
Example
No Example Available
IsLeaderEverActive
<summary>
Usage
boolean Game.isLeaderEverActive(LeaderHeadTypes eLeader);
Parameters
- eLeader
- No Description Available
Returns
No Description Available.
Example
No Example Available
IsMPOption
<summary>
Usage
boolean Game.isMPOption(MultiplayerOptionTypes eIndex);
Parameters
- eIndex
- No Description Available
Returns
No Description Available.
Example
No Example Available
IsNetworkMultiPlayer
<summary>
Usage
boolean Game.isNetworkMultiPlayer();
Parameters
None
Returns
No Description Available.
Example
No Example Available
IsNoNukes
<summary>
Usage
boolean Game.isNoNukes();
Parameters
None
Returns
No Description Available.
Example
No Example Available
IsNukesValid
<summary>
Usage
boolean Game.isNukesValid();
Parameters
None
Returns
No Description Available.
Example
No Example Available
IsOption
Retrieves the state of a specified Game Option
Use with Game.SetOption
Usage
boolean Game.isOption(GameOptionTypes eIndex);
Parameters
- eIndex
- No Description Available
Returns
No Description Available.
Example
Game.IsOption(GameOptionTypes.GAMEOPTION_NO_GOODY_HUTS);
IsPaused
<summary>
Usage
boolean Game.isPaused();
Parameters
None
Returns
No Description Available.
Example
No Example Available
IsPbem
<summary>
Usage
boolean Game.isPbem();
Parameters
None
Returns
No Description Available.
Example
No Example Available
IsPitboss
<summary>
Usage
boolean Game.isPitboss();
Parameters
None
Returns
No Description Available.
Example
No Example Available
IsProjectMaxedOut
<summary>
Usage
boolean Game.isProjectMaxedOut(ProjectTypes eIndex, int iExtra);
Parameters
- eIndex
- No Description Available
- iExtra
- No Description Available
Returns
No Description Available.
Example
No Example Available
IsProjectRecommended
<summary>
Usage
Game.();
Parameters
-
- No Description Available
Returns
No Description Available.
Example
No Example Available
IsScoreDirty
<summary>
Usage
boolean Game.isScoreDirty();
Parameters
None
Returns
No Description Available.
Example
No Example Available
IsSimultaneousTeamTurns
<summary>
Usage
boolean Game.isSimultaneousTeamTurns();
Parameters
None
Returns
No Description Available.
Example
No Example Available
IsSpecialUnitValid
<summary>
Usage
boolean Game.isSpecialUnitValid(SpecialUnitTypes eSpecialUnitType);
Parameters
- eSpecialUnitType
- No Description Available
Returns
No Description Available.
Example
No Example Available
IsStaticTutorialActive
<summary>
Usage
Game.();
Parameters
-
- No Description Available
Returns
No Description Available.
Example
No Example Available
IsTeamGame
<summary>
Usage
boolean Game.isTeamGame();
Parameters
None
Returns
No Description Available.
Example
No Example Available
IsTeamVote
<summary>
Usage
boolean Game.isTeamVote(VoteTypes eVote);
Parameters
- eVote
- No Description Available
Returns
No Description Available.
Example
No Example Available
IsTeamVoteEligible
<summary>
Usage
boolean Game.isTeamVoteEligible(TeamTypes eTeam, VoteSourceTypes eVoteSource);
Parameters
- eTeam
- No Description Available
- eVoteSource
- No Description Available
Returns
No Description Available.
Example
No Example Available
IsTechRecommended
<summary>
Usage
Game.();
Parameters
-
- No Description Available
Returns
No Description Available.
Example
No Example Available
IsTutorialDebugging
<summary>
Usage
Game.();
Parameters
-
- No Description Available
Returns
No Description Available.
Example
No Example Available
IsTutorialLogging
<summary>
Usage
Game.();
Parameters
-
- No Description Available
Returns
No Description Available.
Example
No Example Available
IsUnitClassMaxedOut
<summary>
Usage
boolean Game.isUnitClassMaxedOut(UnitClassTypes eIndex, int iExtra);
Parameters
- eIndex
- No Description Available
- iExtra
- No Description Available
Returns
No Description Available.
Example
No Example Available
IsUnitEverActive
<summary>
Usage
boolean Game.isUnitEverActive(UnitTypes eUnit);
Parameters
- eUnit
- No Description Available
Returns
No Description Available.
Example
No Example Available
IsUnitRecommended
<summary>
Usage
Game.();
Parameters
-
- No Description Available
Returns
No Description Available.
Example
No Example Available
IsVictoryValid
<summary>
Usage
boolean Game.isVictoryValid(VictoryTypes eIndex);
Parameters
- eIndex
- No Description Available
Returns
No Description Available.
Example
No Example Available
IsVotePassed
<summary>
Usage
boolean Game.isVotePassed(VoteTypes eIndex);
Parameters
- eIndex
- No Description Available
Returns
No Description Available.
Example
No Example Available
<summary>
Usage
void Game.makeCircumnavigated();
Parameters
None
Returns
No Description Available.
Example
No Example Available
MakeNukesValid
<summary>
Usage
void Game.makeNukesValid(boolean bValid);
Parameters
- bValid
- No Description Available
Returns
No Description Available.
Example
No Example Available
MakeSpecialUnitValid
<summary>
Usage
void Game.makeSpecialUnitValid(SpecialUnitTypes eSpecialUnitType);
Parameters
- eSpecialUnitType
- No Description Available
Returns
No Description Available.
Example
No Example Available
Rand
<summary>
Usage
int Game.Rand( max_num, log);
Parameters
- max_num
- No Description Available
- log
- No Description Available
Returns
No Description Available.
Example
No Example Available
ReviveActivePlayer
<summary>
Usage
void Game.ReviveActivePlayer();
Parameters
None
Returns
No Description Available.
Example
No Example Available
SaveReplay
<summary>
Usage
void Game.saveReplay(int iPlayer);
Parameters
- iPlayer
- No Description Available
Returns
No Description Available.
Example
No Example Available
SelectedCitiesGameNetMessage
<summary>
Usage
void Game.selectedCitiesGameNetMessage(int eMessage, int iData2, int iData3, int iData4, boolean bOption, boolean bAlt, boolean bShift, boolean bCtrl);
Parameters
- eMessage
- No Description Available
- iData2
- No Description Available
- iData3
- No Description Available
- iData4
- No Description Available
- bOption
- No Description Available
- bAlt
- No Description Available
- bShift
- No Description Available
- bCtrl
- No Description Available
Returns
No Description Available.
Example
No Example Available
SelectionListGameNetMessage
<summary>
Usage
void Game.selectionListGameNetMessage(int eMessage, int iData2 = -1, int iData3 = -1, int iData4 = -1, int iFlags = 0, boolean bAlt = false, boolean bShift = false);
Parameters
- eMessage
- No Description Available
- iData2
- No Description Available
- iData3
- No Description Available
- iData4
- No Description Available
- iFlags
- No Description Available
- bAlt
- No Description Available
- bShift
- No Description Available
Returns
No Description Available.
Example
No Example Available
SelectionListMove
<summary>
Usage
void Game.selectionListMove(<Plot> pPlot, boolean bAlt, boolean bShift, boolean bCtrl);
Parameters
- pPlot
- No Description Available
- bAlt
- No Description Available
- bShift
- No Description Available
- bCtrl
- No Description Available
Returns
No Description Available.
Example
No Example Available
SetActivePlayer
<summary>
Usage
void Game.setActivePlayer(PlayerTypes eNewValue, boolean bForceHotSeat);
Parameters
- eNewValue
- No Description Available
- bForceHotSeat
- No Description Available
Returns
No Description Available.
Example
No Example Available
SetAdvisorCheckFlags
<summary>
Usage
Game.();
Parameters
-
- No Description Available
Returns
No Description Available.
Example
No Example Available
SetAdvisorRecommenderCity
<summary>
Usage
Game.();
Parameters
-
- No Description Available
Returns
No Description Available.
Example
No Example Available
SetAdvisorRecommenderTech
<summary>
Usage
Game.();
Parameters
-
- No Description Available
Returns
No Description Available.
Example
No Example Available
SetAIAutoPlay
<summary>
Usage
void Game.setAIAutoPlay(int iNewValue);
Parameters
- iNewValue
- No Description Available
Returns
No Description Available.
Example
No Example Available
SetCombatWarned
<summary>
Usage
Game.();
Parameters
-
- No Description Available
Returns
No Description Available.
Example
No Example Available
SetDebugMode
<summary>
Usage
boolean Game.setDebugMode();
Parameters
None
Returns
No Description Available.
Example
No Example Available
SetEstimateEndTurn
<summary>
Usage
void Game.setEstimateEndTurn(int iNewValue);
Parameters
- iNewValue
- No Description Available
Returns
No Description Available.
Example
No Example Available
SetEverRightClickMoved
<summary>
Usage
Game.();
Parameters
-
- No Description Available
Returns
No Description Available.
Example
No Example Available
SetGameTurn
<summary>
Usage
void Game.setGameTurn(int iNewValue);
Parameters
- iNewValue
- No Description Available
Returns
No Description Available.
Example
No Example Available
SetMaxCityElimination
<summary>
Usage
void Game.setMaxCityElimination(int iNewValue);
Parameters
- iNewValue
- No Description Available
Returns
No Description Available.
Example
No Example Available
SetMaxTurns
<summary>
Usage
void Game.setMaxTurns(int iNewValue);
Parameters
- iNewValue
- No Description Available
Returns
No Description Available.
Example
No Example Available
SetName
<summary>
Usage
void Game.setName( szName);
Parameters
- szName
- No Description Available
Returns
No Description Available.
Example
No Example Available
SetNumAdvancedStartPoints
<summary>
Usage
void Game.setNumAdvancedStartPoints(int iNewValue);
Parameters
- iNewValue
- No Description Available
Returns
No Description Available.
Example
No Example Available
SetOption
Sets the state of a specified Game Option
Can use with Game.IsOption to get the state of a Game Option
Usage
void Game.setOption(GameOptionTypes eIndex, boolean bEnabled);
Parameters
- eIndex
- bEnabled
- Set Game Option on (true) or off (false)
Returns
No Description Available.
Example
Game.SetOption(GameOptionTypes.GAMEOPTION_NO_GOODY_HUTS, true);
SetPausePlayer
<summary>
Usage
Game.();
Parameters
-
- No Description Available
Returns
No Description Available.
Example
No Example Available
SetPitbossTurnTime
<summary>
Usage
void Game.setPitbossTurnTime(int iHours);
Parameters
- iHours
- No Description Available
Returns
No Description Available.
Example
No Example Available
SetPlotExtraYield
<summary>
Usage
void Game.setPlotExtraYield(int iX, int iY, YieldTypes eYield, int iExtraYield);
Parameters
- iX
- No Description Available
- iY
- No Description Available
- eYield
- No Description Available
- iExtraYield
- No Description Available
Returns
No Description Available.
Example
No Example Available
SetScoreDirty
<summary>
Usage
void Game.setScoreDirty(boolean bNewValue);
Parameters
- bNewValue
- No Description Available
Returns
No Description Available.
Example
No Example Available
SetScriptData
<summary>
Usage
void Game.setScriptData(string szNewValue);
Parameters
- szNewValue
- No Description Available
Returns
No Description Available.
Example
No Example Available
SetStartYear
<summary>
Usage
void Game.setStartYear(int iNewValue);
Parameters
- iNewValue
- No Description Available
Returns
No Description Available.
Example
No Example Available
SetStaticTutorialActive
<summary>
Usage
Game.();
Parameters
-
- No Description Available
Returns
No Description Available.
Example
No Example Available
SetTargetScore
<summary>
Usage
void Game.setTargetScore(int iNewValue);
Parameters
- iNewValue
- No Description Available
Returns
No Description Available.
Example
No Example Available
SetWinner
<summary>
Usage
void Game.setWinner(TeamTypes eNewWinner, VictoryTypes eNewVictory);
Parameters
- eNewWinner
- No Description Available
- eNewVictory
- No Description Available
Returns
No Description Available.
Example
No Example Available
ToggleDebugMode
<summary>
Usage
void Game.toggleDebugMode();
Parameters
None
Returns
No Description Available.
Example
No Example Available
UpdateFOW
<summary>
Usage
void Game.UpdateFOW();
Parameters
None
Returns
No Description Available.
Example
No Example Available
UpdateScore
<summary>
Usage
void Game.updateScore(boolean bForce);
Parameters
- bForce
- No Description Available
Returns
No Description Available.
Example
No Example Available
VictoryDelay
<summary>
Usage
int Game.victoryDelay(VictoryTypes eVictory);
Parameters
- eVictory
- No Description Available
Returns
No Description Available.
Example
No Example Available
