GameEvents.UnitGetSpecialExploreTarget (Civ5 API)

From Civilization Modding Wiki
Revision as of 20:29, 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 GameEvents.

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


Appears to be triggered when the 'explore' order is given, or some subset thereof. The unit structure for the relevant unit is manipulated to set the explore target.

Listener Prototype

listener(iPlayerID, iUnitID)

  • iPlayerID The ID of the player who issued the explore order.
  • iUnitID The ID of the unit the order was issued to.


Usage

void GameEvents.UnitGetSpecialExploreTarget(PlayerID player, UnitID unitID)


Event Type

Unknown

Parameters

player: No description available.
unitID: No description available.


Source code samples

TurnsRemaining.lua - DLC_02 DLC

DLC/DLC_02/Scenarios/NewWorldScenario/TurnsRemaining.lua
0576
GameEvents.UnitGetSpecialExploreTarget.Add(OnSpecialExploreRequest);



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.