[WOTC] Cost-Based Ability Colors
Last revision: 9 Feb at 06:02 UTC
This is an updated version of Cost-Based Ability Colors for WOTC. All credit for the original mod and concept goes to infectedm and you should go rate it if you haven’t already.
Overrides UITacticalHUD_Ability and is incompatible with any other mod doing the same (unsubscribe from the original).
For the most part, the original Cost-Based Ability Colors works fine in WOTC, but there were a few situations where it needed an update, especially with regards to improving support for mod-added abilities. Here are the big changes from the original version:
- Updated Free Reload Handling: The handling of Free Reloads has been updated to take bonus charges into account and has been set to an ini toggle so that it may be disabled entirely by users when using other mods that handle free reloads (like [WOTC] Free Reload Anytime , for example).
- Better Override Support: The mod has been re-written to provide more robust, conditional color overrides for mod authors. The cost category can be changed or a completely custom color can be assigned to an ability and it can be conditional to the presence of an another ability or an activated effect on the unit.
- Updated Cost Check Logic: The cost-checking logic has been updated, primarily to support action point altering effects from mods utilizing XModBase. The mod will now recognize actions with a cost of 0 as free (was previously only considering the bFreeCost variable). A check for valid action point types has also been added and when a unit does not have a valid action point type for an ability (for example, when a unit only has Movement-only action points, etc.) the Unavailable color will be used.
If you have an ability that needs an override entry to display correctly, you can include a copy of XComWOTC_CostBasedAbilityColors.ini with your mod that contains the following:
Some examples of when you might want to use an override include abilities that only return actions via PostAbilityCostPaid(), abilities that are bFreeCost = true, but will remove action points through further processing, or when you want an ability to use a different border color than any of the preset categories under certain conditions.
The overrides are entered using a struct and the members and their usage are detailed below. Only include the OPTIONAL members that you need. See the ini file included in this mod for more information and examples:
REQUIRED – The name of the ability being modified
OPTIONAL – The name of the ability that the unit must have to validate the modify
OPTIONAL – The name of the effect that the unit must have to validate the modify
OPTIONAL – If a color string is entered, the ability being modified will use that color instead
OPTIONAL – If true, the ability being modified will be considered a free action
OPTIONAL – If true, the ability being modified will be considered a turn ending action
OPTIONAL – If true, the ability being modified will be considered a non-turn ending action
More than one entry for a single ability can be entered when there are more than one ModifyingAbilityName or ModifyingEffectName that may modify that ability. When a ModifyingAbilityName AND a ModifyingEffectName are present in the same AbilityCostColorOverride entry, they will be treated as an OR statement.
The OverrideColor, if defined, will take first priority – use this to give an ability a border color outside the preset categories. The bIsFreeAction bool will be evaluated next and, if true, will use the FreeAction border color. If neither an OverrideColor or the bIsFreeAction bool are defined, then the TurnEnding bools will be evaluated for their preset colors.
bIsFreeAction and bIsTurnEnding are immediate overrides – when either one is found in an override, their preset color is used and no other override entries are evaluated. bNotTurnEnding, however, is not immediate – the value is stored and continues evaluating other override entries, primarily to allow any potential bIsFreeAction overrides to supercede it.
(See Change Notes for full history)
- Added Full Color Mode toggle in the config file (defaults to Off/False). Colors the Icon border AND inner symbol based on the action cost.
- Added a check for valid action point types. If the unit does not have a valid action point type for an ability, it will display the Unavailable color (for example, when a unit has a movement-only action point, normal actions will be colored as unavailable).
- Fixed error in override logic causing bIsTurnEnding = true overrides not to process.
- Added a few more overrides to the config file.
- Initial Release!.