Events.UnitSelectionChanged (Civ5 API)

From Civilization Modding Wiki
Revision as of 18:53, 19 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 Events.

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


Usage

void Events.UnitSelectionChanged(PlayerID player, UnitID u, float hexX, float hexY, int k, bool isSelected, bool arg6)


Event Type

Regular event: you can subscribe to it through Events.UnitSelectionChanged.Add(<function handler>) or invoke it directly through Events.UnitSelectionChanged(<arguments list>).

Parameters

player: No description available.
u: No description available.
hexX: No description available.
hexY: No description available.
k: No description available.
isSelected: No description available.
arg6: No description available.


Source code samples

Redundant occurences have been removed.

ChoosePantheonPopup.lua (G&K)

DLC/Expansion/UI/InGame/Popups/ChoosePantheonPopup.lua
0216
Events.UnitSelectionChanged.Add( OnDirty );


DebugMode.lua

UI/InGame/DebugMode.lua
0436
Events.UnitSelectionChanged(playerID, -1, 0, 0, 0, false, false);         -- Does this even work?  We want to essentially deselect the currently selected unit.  cvUnitSimSystem::OnUnitSelected does not seem to handle unitID == -1
0437
Events.UnitSelectionChanged(-1, -1, iHexX, iHexY, 0, true, true);         -- cvUnitSimSystem::OnUnitSelected checks for a -1 in the PlayerID field to determine if it should use the plot location.


InGame.lua

UI/InGame/InGame.lua
0760
Events.UnitSelectionChanged.Add( OnUnitSelectionChange );


UnitFlagManager.lua

UI/InGame/UnitFlagManager.lua
1204
Events.UnitSelectionChanged.Add( OnUnitSelect );


UnitList.lua

UI/InGame/UnitList.lua
0082
Events.UnitSelectionChanged.Add( OnChangeEvent );


UnitPanel.lua

UI/InGame/WorldView/UnitPanel.lua
0750
Events.UnitSelectionChanged(playerID, g_lastUnitID, 0, 0, 0, false, false);
0754
Events.UnitSelectionChanged(playerID, unitID, hexPosition.x, hexPosition.y, 0, true, false);



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.