OverridePatrolBehavior

Tracking Issue: #507

Tags: events

The OverridePatrolBehavior event allows mods to override pods' patrol behavior. The bOverridePatrolBehavior component of the tuple should be set to true if the mod is overriding the patrol behavior and wants to bypass the default base game patrol logic.

OverridePatrolBehavior event

Param Value
EventID OverridePatrolBehavior
EventData XComLWTuple
EventSource XComGameState_AIGroup
NewGameState none

Tuple contents

Index Name Type Direction
0 bOverridePatrolBehavior bool out

Listener template

static function EventListenerReturn OnOverridePatrolBehavior(Object EventData, Object EventSource, XComGameState GameState, Name EventID, Object CallbackObject)
{
    local XComGameState_AIGroup AIGroup;
    local XComLWTuple Tuple;
    local bool bOverridePatrolBehavior;

    AIGroup = XComGameState_AIGroup(EventSource);
    Tuple = XComLWTuple(EventData);

    // Your code here

    Tuple.Data[0].b = bOverridePatrolBehavior;

    return ELR_NoInterrupt;
}

Source code references