PreGame.SetHandicap (Civ5 API)

From Civilization Modding Wiki
Revision as of 10:48, 20 September 2012 by DonQuich (talk | contribs) (Bot update)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigationJump to search

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


Function.png This function is a member of PreGame.

This is a static method, invoke it with a dot.


Usage

void PreGame.SetHandicap(PlayerID player, HandicapType id)


Parameters

player: No description available.
id: No description available.


Source code samples

Redundant occurences have been removed.

AdvancedSetup.lua

UI/FrontEnd/GameSetup/AdvancedSetup.lua
0563
PreGame.SetHandicap( 0, id );
1243
PreGame.SetHandicap( 0, handicap.ID );


FoRScenarioLoadScreen.lua (G&K)

DLC/Expansion/Scenarios/FallOfRomeScenario/FoRScenarioLoadScreen.lua
0058
PreGame.SetHandicap(0, g_CurrentDifficulty);


GameSetupScreen.lua

UI/FrontEnd/GameSetup/GameSetupScreen.lua
0409
PreGame.SetHandicap(0, v.DefaultHandicap);


LoadTutorial.lua

UI/FrontEnd/LoadTutorial.lua
0105
PreGame.SetHandicap(0, 0);


MPGameOptions.lua

UI/FrontEnd/Multiplayer/GameSetup/MPGameOptions.lua
0381
PreGame.SetHandicap(0, civList[1].DefaultHandicap);


SelectCivilization.lua

UI/FrontEnd/GameSetup/SelectCivilization.lua
0073
PreGame.SetHandicap(0, player.DefaultHandicap);


StagingRoom.lua

UI/FrontEnd/Multiplayer/StagingRoom.lua
0248
PreGame.SetHandicap(playerID, handicap);
0258
PreGame.SetHandicap( playerID, 1 );



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.