OverrideNextRetaliationDisplay

Tracking Issue: #667

Tags: events

The Dark Events Screen (UIAdventOperations) by default shows a string like: "Next Retaliation: 6 Weeks (Estimated)". This event allows mods to override whether to show that text, and customize the actual displayed text.

OverrideNextRetaliationDisplay event

Param Value
EventID OverrideNextRetaliationDisplay
EventData XComLWTuple
EventSource UIAdventOperations
NewGameState none

Tuple contents

Index Name Type Direction
0 bShow bool inout
1 strHeader string inout
2 strValue string inout
3 strFooter string inout

Listener template

static function EventListenerReturn OnOverrideNextRetaliationDisplay(Object EventData, Object EventSource, XComGameState GameState, Name EventID, Object CallbackObject)
{
    local UIAdventOperations Screen;
    local XComLWTuple Tuple;
    local bool bShow;
    local string strHeader;
    local string strValue;
    local string strFooter;

    Screen = UIAdventOperations(EventSource);
    Tuple = XComLWTuple(EventData);

    bShow = Tuple.Data[0].b;
    strHeader = Tuple.Data[1].s;
    strValue = Tuple.Data[2].s;
    strFooter = Tuple.Data[3].s;

    // Your code here

    Tuple.Data[0].b = bShow;
    Tuple.Data[1].s = strHeader;
    Tuple.Data[2].s = strValue;
    Tuple.Data[3].s = strFooter;

    return ELR_NoInterrupt;
}

Source code references