GetEncounterActive(object)

Gets a TRUE or FALSE value depending on whether the encounter has spawned and is active.

int GetEncounterActive(
    object oEncounter = OBJECT_SELF
);

Parameters

oEncounter

The encounter object you wish to compare or examine. (Default: OBJECT_SELF)


Description

Returns TRUE or FALSE, whether oEncounter has spawned and is currently active.



Remarks

You can set the active property of an encounter using the SetEncounterActive() function. Some comments in the Bioware include files allude to this not working with the current implementation of the encounter trigger.


Version

1.22

See Also

functions: GetEncounterDifficulty | GetEncounterSpawnsCurrent | GetEncounterSpawnsMax | SetEncounterActive
categories: Encounter Functions


 author: John Shuell