class Encounter

class Encounter
GetActive()

Gets whether an encounter has spawned as is active.

GetDifficulty()

Get the difficulty level of the encounter.

Return type:ENCOUNTER_DIFFICULTY_*
GetNumberSpawned()

Get number of creatures spawned

GetSpawnsCurrent()

Get the number of times that the encounter has spawned so far.

GetSpawnsMax()

Get the maximum number of times that an encounter will spawn.

GetSpawnPointCount()

Gets the number of spawn points

GetSpawnPointByIndex(idx)

Gets a spawn point location.

Parameters:
  • idx (int) – Index in the spawn poing list.
Return type:

Location

SetActive(value)

Sets an encounter to active or inactive.

Parameters:
  • value (boolean) – new value
SetDifficulty(value)

Sets the difficulty level of an encounter.

Parameters:
  • value (int) – ENCOUNTER_DIFFICULTY_*
SetSpawnsMax(value)

Sets the maximum number of times that an encounter can spawn.

Parameters:
  • value (int) – The new maximum spawn value.
SetSpawnsCurrent(value)

Sets the number of times that an encounter has spawned.

Parameters:
  • value (int) – The new number of times the encounter has spawned.