Search
Preparing search index...
The search index is not available
@aoemods/aoetypes
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
@aoemods/aoetypes
TEncounter
Interface TEncounter
Hierarchy
TEncounter
Index
Methods
AddSGroup
Add
Units
Clear
Goal
Complete
Deploy
Immediately
ConvertSGroup
Create
Create
Ability
Create
Attack
Create
Basic
Create
Defend
Create
Formation
Attack
Create
Formation
Defend
Area
Create
Move
Create
Patrol
Create
Town
Life
Disable
Enable
Get
Egroup
Nearby
Allies
Get
Goal
Data
GetSGroup
Has
Goal
Reboot
If
Needed
Remove
On
Death
Remove
Unit
By
Squad
Remove
Units
BySGroup
Reset
Goal
Relocation
Restart
Goal
Set
Goal
Set
Goal
On
Failure
Set
Goal
On
Success
Set
On
Death
Trigger
Goal
Update
Goal
Methods
AddSGroup
AddSGroup
(
squadgroup
:
any
, name
:
any
, onDeath
:
any
)
:
void
Parameters
squadgroup:
any
name:
any
onDeath:
any
Returns
void
Add
Units
Add
Units
(
unitData
:
any
, spawnType
:
SPAWN
)
:
void
Parameters
unitData:
any
spawnType:
SPAWN
Returns
void
Clear
Goal
Clear
Goal
(
)
:
void
Returns
void
Complete
Deploy
Immediately
Complete
Deploy
Immediately
(
)
:
void
Returns
void
ConvertSGroup
ConvertSGroup
(
squadgroup
:
SGROUP
)
:
Encounter
Parameters
squadgroup:
SGROUP
Returns
Encounter
Create
Create
(
data
:
EncounterData
, spawnNow
?:
boolean
, spawnStaggered
?:
number
|
boolean
)
:
Encounter
Parameters
data:
EncounterData
Optional
spawnNow:
boolean
Optional
spawnStaggered:
number
|
boolean
Returns
Encounter
Create
Ability
Create
Ability
(
name
:
string
, encUnits
:
any
, spawnLoc
:
Position
|
MARKER
, encTarget
:
Position
|
MARKER
|
EGroup
|
SGroup
, dynamicSpawn
?:
Position
|
MARKER
, moveRange
?:
number
)
:
Encounter
Parameters
name:
string
encUnits:
any
spawnLoc:
Position
|
MARKER
encTarget:
Position
|
MARKER
|
EGroup
|
SGroup
Optional
dynamicSpawn:
Position
|
MARKER
Optional
moveRange:
number
Returns
Encounter
Create
Attack
Create
Attack
(
name
:
string
, encUnits
:
any
, spawnLoc
:
Position
|
MARKER
, encTarget
:
Position
|
MARKER
|
EGroup
|
SGroup
, dynamicSpawn
?:
Position
|
MARKER
, encRange
?:
number
|
MARKER
, encLeash
?:
number
|
MARKER
)
:
Encounter
Parameters
name:
string
encUnits:
any
spawnLoc:
Position
|
MARKER
encTarget:
Position
|
MARKER
|
EGroup
|
SGroup
Optional
dynamicSpawn:
Position
|
MARKER
Optional
encRange:
number
|
MARKER
Optional
encLeash:
number
|
MARKER
Returns
Encounter
Create
Basic
Create
Basic
(
name
:
string
, spawnLoc
:
Position
|
MARKER
, encUnits
:
any
, dynamicSpawn
?:
Position
|
MARKER
)
:
Encounter
Parameters
name:
string
spawnLoc:
Position
|
MARKER
encUnits:
any
Optional
dynamicSpawn:
Position
|
MARKER
Returns
Encounter
Create
Defend
Create
Defend
(
name
:
string
, encUnits
:
any
, spawnLoc
:
Position
|
MARKER
, encTarget
:
Position
|
MARKER
|
EGroup
|
SGroup
, dynamicSpawn
?:
Position
|
MARKER
, encRange
?:
number
|
MARKER
, encLeash
?:
number
|
MARKER
)
:
Encounter
Parameters
name:
string
encUnits:
any
spawnLoc:
Position
|
MARKER
encTarget:
Position
|
MARKER
|
EGroup
|
SGroup
Optional
dynamicSpawn:
Position
|
MARKER
Optional
encRange:
number
|
MARKER
Optional
encLeash:
number
|
MARKER
Returns
Encounter
Create
Formation
Attack
Create
Formation
Attack
(
name
:
string
, encUnits
:
any
, spawnLoc
:
Position
|
MARKER
, encTarget
:
Position
|
MARKER
|
EGroup
|
SGroup
, dynamicSpawn
?:
Position
|
MARKER
, encRange
?:
number
|
MARKER
, encLeash
?:
number
|
MARKER
)
:
Encounter
Parameters
name:
string
encUnits:
any
spawnLoc:
Position
|
MARKER
encTarget:
Position
|
MARKER
|
EGroup
|
SGroup
Optional
dynamicSpawn:
Position
|
MARKER
Optional
encRange:
number
|
MARKER
Optional
encLeash:
number
|
MARKER
Returns
Encounter
Create
Formation
Defend
Area
Create
Formation
Defend
Area
(
name
:
string
, encUnits
:
any
, spawnLoc
:
Position
|
MARKER
, encTarget
:
Position
|
MARKER
|
EGroup
|
SGroup
, dynamicSpawn
?:
Position
|
MARKER
, encRange
?:
number
|
MARKER
, encLeash
?:
number
|
MARKER
)
:
Encounter
Parameters
name:
string
encUnits:
any
spawnLoc:
Position
|
MARKER
encTarget:
Position
|
MARKER
|
EGroup
|
SGroup
Optional
dynamicSpawn:
Position
|
MARKER
Optional
encRange:
number
|
MARKER
Optional
encLeash:
number
|
MARKER
Returns
Encounter
Create
Move
Create
Move
(
name
:
string
, encUnits
:
any
, spawnLoc
:
Position
|
MARKER
, encTarget
:
Position
|
MARKER
|
EGroup
|
SGroup
, dynamicSpawn
?:
Position
|
MARKER
, moveRange
?:
number
)
:
Encounter
Parameters
name:
string
encUnits:
any
spawnLoc:
Position
|
MARKER
encTarget:
Position
|
MARKER
|
EGroup
|
SGroup
Optional
dynamicSpawn:
Position
|
MARKER
Optional
moveRange:
number
Returns
Encounter
Create
Patrol
Create
Patrol
(
name
:
string
, encUnits
:
any
, spawnLoc
:
Position
|
MARKER
, encPath
:
string
|
MARKER
, dynamicSpawn
?:
Position
|
MARKER
, pathWait
?:
number
, pathLoop
?:
number
)
:
Encounter
Parameters
name:
string
encUnits:
any
spawnLoc:
Position
|
MARKER
encPath:
string
|
MARKER
Optional
dynamicSpawn:
Position
|
MARKER
Optional
pathWait:
number
Optional
pathLoop:
number
Returns
Encounter
Create
Town
Life
Create
Town
Life
(
name
:
string
, encUnits
:
any
, spawnLoc
:
Position
|
MARKER
, encTarget
:
Position
|
MARKER
|
EGroup
|
SGroup
, dynamicSpawn
?:
Position
|
MARKER
, townLifeRange
?:
number
)
:
Encounter
Parameters
name:
string
encUnits:
any
spawnLoc:
Position
|
MARKER
encTarget:
Position
|
MARKER
|
EGroup
|
SGroup
Optional
dynamicSpawn:
Position
|
MARKER
Optional
townLifeRange:
number
Returns
Encounter
Disable
Disable
(
)
:
void
Returns
void
Enable
Enable
(
)
:
void
Returns
void
Get
Egroup
Nearby
Allies
Get
Egroup
Nearby
Allies
(
)
:
EGroup
Returns
EGroup
Get
Goal
Data
Get
Goal
Data
(
)
:
GoalData
Returns
GoalData
GetSGroup
GetSGroup
(
)
:
SGROUP
Returns
SGROUP
Has
Goal
Has
Goal
(
)
:
boolean
Returns
boolean
Reboot
If
Needed
Reboot
If
Needed
(
)
:
void
Returns
void
Remove
On
Death
Remove
On
Death
(
includeUnits
:
boolean
)
:
void
Parameters
includeUnits:
boolean
Returns
void
Remove
Unit
By
Squad
Remove
Unit
By
Squad
(
squad
:
any
)
:
void
Parameters
squad:
any
Returns
void
Remove
Units
BySGroup
Remove
Units
BySGroup
(
squadgroup
:
any
)
:
void
Parameters
squadgroup:
any
Returns
void
Reset
Goal
Relocation
Reset
Goal
Relocation
(
)
:
void
Returns
void
Restart
Goal
Restart
Goal
(
previousEncounterID
:
any
, wasAlreadyTriggered
:
any
)
:
boolean
Parameters
previousEncounterID:
any
wasAlreadyTriggered:
any
Returns
boolean
Set
Goal
Set
Goal
(
goalData
:
GoalData
, triggerGoal
:
boolean
, previousEncounterID
?:
HandleID
)
:
void
Parameters
goalData:
GoalData
triggerGoal:
boolean
Optional
previousEncounterID:
HandleID
Returns
void
Set
Goal
On
Failure
Set
Goal
On
Failure
(
func
:
any
)
:
void
Parameters
func:
any
Returns
void
Set
Goal
On
Success
Set
Goal
On
Success
(
func
:
any
)
:
void
Parameters
func:
any
Returns
void
Set
On
Death
Set
On
Death
(
func
:
any
)
:
void
Parameters
func:
any
Returns
void
Trigger
Goal
Trigger
Goal
(
data
:
any
, relocationData
:
any
)
:
void
Parameters
data:
any
relocationData:
any
Returns
void
Update
Goal
Update
Goal
(
goalData
:
GoalData
)
:
void
Parameters
goalData:
GoalData
Returns
void
Exports
TEncounter
AddSGroup
Add
Units
Clear
Goal
Complete
Deploy
Immediately
ConvertSGroup
Create
Create
Ability
Create
Attack
Create
Basic
Create
Defend
Create
Formation
Attack
Create
Formation
Defend
Area
Create
Move
Create
Patrol
Create
Town
Life
Disable
Enable
Get
Egroup
Nearby
Allies
Get
Goal
Data
GetSGroup
Has
Goal
Reboot
If
Needed
Remove
On
Death
Remove
Unit
By
Squad
Remove
Units
BySGroup
Reset
Goal
Relocation
Restart
Goal
Set
Goal
Set
Goal
On
Failure
Set
Goal
On
Success
Set
On
Death
Trigger
Goal
Update
Goal
Generated using
TypeDoc