OverrideDisableReinforcementsFlare

Tracking Issue: #448

Tags: events

The OverrideDisableReinforcementsFlare event allows mods to disable the visuals for the particle effects (red flare or purple psionic gate in base game) that indicate the location of incoming enemy reinforcements, as well as other visualization associated with it, such as camera panning.

Returns true if the reinforcements flare should be disabled.

OverrideDisableReinforcementsFlare event

Param Value
EventID OverrideDisableReinforcementsFlare
EventData XComLWTuple
EventSource XComGameState_AIReinforcementSpawner
NewGameState none

Tuple contents

Index Name Type Direction
0 bDisableFlare bool inout

Listener template

static function EventListenerReturn OnOverrideDisableReinforcementsFlare(Object EventData, Object EventSource, XComGameState GameState, Name EventID, Object CallbackObject)
{
    local XComGameState_AIReinforcementSpawner AISpawnerState;
    local XComLWTuple Tuple;
    local bool bDisableFlare;

    AISpawnerState = XComGameState_AIReinforcementSpawner(EventSource);
    Tuple = XComLWTuple(EventData);

    bDisableFlare = Tuple.Data[0].b;

    // Your code here

    Tuple.Data[0].b = bDisableFlare;

    return ELR_NoInterrupt;
}

Source code references