Events.ClearHexHighlightStyle (Civ5 API)

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

This function is a member of Events. This is a static method, invoke it with a dot.

Triggers when a highlighting style that was activated by SerialEventHexHighlight is cleared. Can be invoked from Lua, which is the common usage.

Usage

void Events.ClearHexHighlightStyle(string highlightStyle)

Event Type

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

Parameters

highlightStyle:

Highlighting style to clear. Known highlighting styles are: "MovementRangeBorder", "AMRBorder", "FireRangeBorder", "ValidFireTargetBorder"

Source code samples

Redundant occurences have been removed.

InGame.lua

UI/InGame/InGame.lua

0501	Events.ClearHexHighlightStyle(pathBorderStyle);
0502	Events.ClearHexHighlightStyle(attackPathBorderStyle);
0503	Events.ClearHexHighlightStyle(genericUnitHexBorder);
0504	Events.ClearHexHighlightStyle("FireRangeBorder");
0505	Events.ClearHexHighlightStyle("GroupBorder");
0506	Events.ClearHexHighlightStyle("ValidFireTargetBorder");

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.