VoteSourceType (Civ5 Type)

From Civilization Modding Wiki
Jump to navigationJump to search
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

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


ID.png The VoteSourceType pseudo-type is actually a regular integer. Pseudo-types do not exist in Lua, they only serve a documentation purpose on the wiki!
  • DB.png Integers labeled as VoteSourceType corresponds to the ID column of the VoteSources XML table.


XML: the VoteSources table

Here are the ID and Type columns found in this table.

ID Type
0 DIPLOVOTE_UN
1 DIPLOVOTE_POPE


Examples

Here are different ways to query the database to retrieve the ID from the type. Those examples will return and assign the integer value 0. See also GameInfo.

local id = GameInfo.VoteSources.DIPLOVOTE_UN.ID
local id = GameInfo["VoteSources"].["DIPLOVOTE_UN"].ID
local id = GameInfo.VoteSources{Type="DIPLOVOTE_UN"}().ID

Alternatively you could use the ID or the type to retrieve the value of the Description column. Those examples will return and assign the value TXT_KEY_BUILDING_UNITED_NATIONS.

local description = GameInfo.VoteSources[0].Description
local description = GameInfo["VoteSources"][0]["Description"]
local description = GameInfo.VoteSources{ID=0}().Description


Used by

bool Game.CanHaveSecretaryGeneral(VoteSourceType voteSource)
Game.ChangeDiploVote(VoteSourceType voteSource, int change)
int Game.CountPossibleVote(VoteType vote, VoteSourceType voteSource)
int Game.GetSecretaryGeneral(VoteSourceType voteSource)
int Game.GetVoteRequired(VoteType vote, VoteSourceType voteSource)
bool Game.IsDiploVote(VoteSourceType voteSource)
bool Game.IsTeamVoteEligible(TeamID team, VoteSourceType voteSource)
int Player:GetVotes(VoteType vote, VoteSourceType voteSource)
bool Player:IsFullMember(VoteSourceType voteSource)
bool Player:IsVotingMember(VoteSourceType voteSource)
Team:ChangeForceTeamVoteEligibilityCount(VoteSourceType voteSource, int change)
int Team:GetForceTeamVoteEligibilityCount(VoteSourceType voteSource)
bool Team:IsForceTeamVoteEligible(VoteSourceType voteSource)



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.