Actions

Disables the given Deck Slot.

TutorialDeckSlotEnable
alert This function has not been verified yet! It may not be acurate

Enables the given Deck Slot.

TutorialMarkerAdd
alert This function has not been verified yet! It may not be acurate

Adds a new tutorial marker or moves an existing one with the same tag.

 Widget
 MarkerFileName
 Position

TutorialDetailMarkerAdd
alert This function has not been verified yet! It may not be acurate

Adds a new tutorial marker or moves an existing one with the same tag, with detail info.

 Widget
 MarkerFileName
 DetailFileName
 Position

TutorialMarkerRemove
alert This function has not been verified yet! It may not be acurate

Removes a tutorial marker.

TutorialEffectStart
alert This function has not been verified yet! It may not be acurate

Starts the effect on all Squads with that PvE Type.

 PvEType
 Effect

TutorialEffectStopAll
alert This function has not been verified yet! It may not be acurate

Stops all effects started with the TutorialEffect command.

### AudioVisual

AudioAmbientPlay
alert This function has not been verified yet! It may not be acurate

Plays the specified AmbientStream at the TargetTag position.

 TargetTag

AudioSoundFXStop
alert This function has not been verified yet! It may not be acurate

Stops the Audio if it is playing.

CameraCenterOnTarget
alert This function has not been verified yet! It may not be acurate

Centers the Camera on the Tag's position.

AudioMusicPlay
alert This function has not been verified yet! It may not be acurate

Plays the specified Music Track.

EffectEnable
alert This function has not been verified yet! It may not be acurate

Enables (starts) the editor-placed effect.

EffectDisable
alert This function has not been verified yet! It may not be acurate

Disables (stops) the editor-placed effect.

EffectToggle
alert This function has not been verified yet! It may not be acurate

Toggles the editor-placed effect.

EffectPowerSet
alert This function has not been verified yet! It may not be acurate

Sets the Effect's 'power' to the specified percentage.

 Percent

EffectPowerAdd
alert This function has not been verified yet! It may not be acurate

Adds this percentage to the Effect's 'power'. Will never go over 100%.

 Percent

EffectPowerSubtract
alert This function has not been verified yet! It may not be acurate

Subtracts this percentage from the Effect's 'power'. Will never go below 5%.

 Percent

EffectStart
alert This function has not been verified yet! It may not be acurate

Starts the effect on the TargetTag entities.

 Effect
 Percent

EffectStartTargeted
alert This function has not been verified yet! It may not be acurate

Starts the effect from the Tag entities to the TargetTag entities.

 TargetTag
 Effect
 Percent

EffectStopAll
alert This function has not been verified yet! It may not be acurate

Stops all effects on the entities.

EffectVanish
alert This function has not been verified yet! It may not be acurate

Removes the effect entity (editor placed effects) from the map.

FogOfWarObserve
alert This function has not been verified yet! It may not be acurate

Starts observing TargetTag position(s), thus completely removing both Unexplored AND Fog of War indefinetely.

 Team
 Range

FogOfWarGlanceAt
alert This function has not been verified yet! It may not be acurate

Takes a glance (quick look) at the TargetTag(s), thus removing only the Unexplored (targets remain shrouded in Fog of War).

 Team
 Range

WeatherSet
alert This function has not been verified yet! It may not be acurate

Changes the weather. Similar to performing a raindance in real life.

 FadeDuration

AudioSoundFXPlay
alert This function has not been verified yet! It may not be acurate

Plays the specified Sound FX at the TargetTag position.

 TargetTag

AudioSoundUIPlay
alert This function has not been verified yet! It may not be acurate

Plays the specified UI Sound at the TargetTag position.

AudioVoicePlay
alert This function has not been verified yet! It may not be acurate

Plays the specified Voice Stream.

 Volume

### Building

BuildingSpawn
alert This function has not been verified yet! It may not be acurate

Spawns (creates) an entity on the map.

 Team
 BuildingId
 Direction

BuildingSpawnWithTag
alert This function has not been verified yet! It may not be acurate

Spawns (creates) an entity on the map.

 TargetTag
 Team
 BuildingId
 Direction

PlayerBuildingSpawn
alert This function has not been verified yet! It may not be acurate

Spawns (creates) an entity on the map.

 Player
 BuildingId
 Direction

PlayerBuildingSpawnWithTag
alert This function has not been verified yet! It may not be acurate

Spawns (creates) an entity on the map.

 TargetTag
 Player
 BuildingId
 Direction

BuildingTypeChange
alert This function has not been verified yet! It may not be acurate

Changes the type of an entity.

 BuildingId

BuildingModeChange
alert This function has not been verified yet! It may not be acurate

Changes the Building's Mode. Does NOT consume Power from the owning Player.

 ModeId

BuildingModeSetEnabled
alert This function has not been verified yet! It may not be acurate

Changes the Building's Mode to the 'enabled' mode. Does NOT consume Power from the owning Player.

BuildingModeSetDisabled
alert This function has not been verified yet! It may not be acurate

Changes the Building's Mode to the 'disabled' mode. Does NOT consume Power from the owning Player.

BuildingModeToggle
alert This function has not been verified yet! It may not be acurate

Toggles the Building's Mode to 'enabled' or 'disabled'. Does NOT consume Power from the owning Player.

BuildingVanish
alert This function has not been verified yet! It may not be acurate

Removes the Building from the map.

BuildingDestroy
alert This function has not been verified yet! It may not be acurate

Destroys the Building.

BuildingKillInRange
alert This function has not been verified yet! It may not be acurate

Kills all Buildings in range.

 Range

BuildingAnimPlay
alert This function has not been verified yet! It may not be acurate

Plays the Building animation once.

 Anim

BuildingAnimPlayLooped
alert This function has not been verified yet! It may not be acurate

Plays the Building animation in a loop.

 Anim

### Special

MapReset
alert This function has not been verified yet! It may not be acurate

Resets the map, all Scripts and Variables (Sandbox restart).

### Cutscene

CutsceneCameraPlay
alert This function has not been verified yet! It may not be acurate

Plays the specified Camera Track. TargetTag is optional, it overwrites TargetTag in Cutscene if used.

 Camera
 TargetTag

CutsceneCameraPlayFullScreen
alert This function has not been verified yet! It may not be acurate

Plays the specified Camera Track in fullscreen mode.

 Camera
 TargetTag

CutsceneBegin
alert This function has not been verified yet! It may not be acurate

Starts a Cutscene.

 RenderOnly

CutsceneEnd
alert This function has not been verified yet! It may not be acurate

Ends a running Cutscene.

CutsceneRenderOnly
alert This function has not been verified yet! It may not be acurate

Renders only the entities from the ScriptTag group. Affects only Figures.

CutsceneRenderAll
alert This function has not been verified yet! It may not be acurate

Resets render flags after using CutsceneRenderOnly so all entities are rendered again.

CutsceneRewardCardShowOff
alert This function has not been verified yet! It may not be acurate

Plays the Reward Card ShowOff Animation & Effects on the specified TargetTag.

 CardSquadId

CutsceneSay
alert This function has not been verified yet! It may not be acurate

Displays text during a Cutscene.

 TextTag
 Text

CutsceneEntityTeleport
alert This function has not been verified yet! It may not be acurate

Instantly teleports entity(s) to TargetTag location, no questions asked. Skips 'free position' & blocking checks, allows Figure penetration.

 TargetTag

CutsceneSquadGoto
alert This function has not been verified yet! It may not be acurate

Squad goes to target in straight line (stops when blocked, walks through other figures). Use only for Cutscenes!

 TargetTag
 Run
 Direction

### Squad

SquadSpawn
alert This function has not been verified yet! It may not be acurate

Spawns (creates) an entity on the map.

 Team
 SquadId
 Direction

SquadSpawnWithTag
alert This function has not been verified yet! It may not be acurate

Spawns (creates) an entity on the map.

 TargetTag
 Team
 SquadId
 Direction

SquadSpawnIntoGroup
alert This function has not been verified yet! It may not be acurate

Spawns (creates) an entity on the map.

PlayerSquadSpawn
alert This function has not been verified yet! It may not be acurate

Spawns (creates) an entity on the map.

 Player
 SquadId
 Direction

PlayerSquadSpawnWithTag
alert This function has not been verified yet! It may not be acurate

Spawns (creates) an entity on the map.

 TargetTag
 Player
 SquadId
 Direction

PlayerSquadSpawnIntoGroup
alert This function has not been verified yet! It may not be acurate

Spawns (creates) an entity on the map.

SquadTypeChange
alert This function has not been verified yet! It may not be acurate

Changes the type of an entity.

 SquadId

SquadModeChange
alert This function has not been verified yet! It may not be acurate

Changes the Squad's Mode. Does NOT consume Power from the owning Player.

 ModeId

SquadModeSetEnabled
alert This function has not been verified yet! It may not be acurate

Changes the Squad's Mode to the 'enabled' mode. Does NOT consume Power from the owning Player.

SquadModeSetDisabled
alert This function has not been verified yet! It may not be acurate

Changes the Squad's Mode to the 'disabled' mode. Does NOT consume Power from the owning Player.

SquadModeToggle
alert This function has not been verified yet! It may not be acurate

Toggles the Squad's Mode to 'enabled' or 'disabled'. Does NOT consume Power from the owning Player.

SquadVanish
alert This function has not been verified yet! It may not be acurate

Removes the Squad from the map. Squad figures will simply disappear (no 'dying' animation).

SquadKill
alert This function has not been verified yet! It may not be acurate

Kills the Squad by damaging each Figure so they will die and play their death animation.

SquadKillInRange
alert This function has not been verified yet! It may not be acurate

Kills all Squads in range.

 Range

SquadRespawn
alert This function has not been verified yet! It may not be acurate

Respawns (recreates) an entity. Entity must be dead and it must have existed before!

 TargetTag
 HealthPercent

ObjectRespawn
alert This function has not been verified yet! It may not be acurate

Respawns (recreates) an entity. Entity must be dead and it must have existed before!

 TargetTag
 HealthPercent

BuildingRespawn
alert This function has not been verified yet! It may not be acurate

Respawns (recreates) an entity. Entity must be dead and it must have existed before!

 TargetTag
 HealthPercent

SquadTeleportInRange
alert This function has not been verified yet! It may not be acurate

Instantly teleports the Squads in range to TargetTag location.

 Range

SquadAttack
alert This function has not been verified yet! It may not be acurate

Squad attacks the specified TargetTag entity (even if it is a friendly entity). TargetTag must be alive and attackable!

 TargetTag
 AttackGroupSize

SquadAttackForced
alert This function has not been verified yet! It may not be acurate

Squad attacks the specified TargetTag entity (even if it is a friendly entity). Uses Forced Goto to get to Target.

 TargetTag
 AttackGroupSize

SquadBarrierMount
alert This function has not been verified yet! It may not be acurate

Squad tries to mount TargetTag barrier (module, set or scriptgroup containing modules).

 TargetTag

SquadBarrierDismount
alert This function has not been verified yet! It may not be acurate

Squad dismounts barrier.

SquadFlee
alert This function has not been verified yet! It may not be acurate

Squads flee from nearest enemy entity by using forced Goto in the opposite Direction.

 Distance
 SearchRadius

SquadPatrol
alert This function has not been verified yet! It may not be acurate

Squad walks waypoints back and forth continously. Continues patrol after being attacked.

 TargetTag

SquadGoto
alert This function has not been verified yet! It may not be acurate

Squad goes towards TargetTag or along TargetTag-ScriptGroup waypoints. Continues goto after being attacked.

 TargetTag
 Run
 Direction

SquadGotoForced
alert This function has not been verified yet! It may not be acurate

Same as SquadGoto but Squad does not attack or follow attackers until it has reached its destination. Use with care!

 TargetTag
 Run
 Direction

SquadGotoFight
alert This function has not been verified yet! It may not be acurate

Squad goes to any TargetTag Squad that is in a fight.

 TargetTag
 Run
 Direction

SquadGotoRandom
alert This function has not been verified yet! It may not be acurate

Squad goes randomly towards ONE of the TargetTags.

 TargetTag
 Run

SquadGotoClosestMonumentOrGenerator
alert This function has not been verified yet! It may not be acurate

Squad(s) go towards closest Monument or Generator. Continues goto after being attacked.

 Run
 SearchRadius

SquadGotoClosestSquad
alert This function has not been verified yet! It may not be acurate

Squad(s) go towards closest Squad. Continues goto after being attacked.

 Run
 SearchRadius

SquadGotoClosestBuilding
alert This function has not been verified yet! It may not be acurate

Squad(s) go towards closest Building. Continues goto after being attacked.

 Run
 SearchRadius

SquadGotoClosestBarrier
alert This function has not been verified yet! It may not be acurate

Squad(s) go towards closest Barrier. Continues goto after being attacked.

 Run
 SearchRadius

SquadGotoClosestTarget
alert This function has not been verified yet! It may not be acurate

Squad(s) go towards closest attackable Target. Continues goto after being attacked.

 Run
 SearchRadius

SquadHoldPosition
alert This function has not been verified yet! It may not be acurate

Squad holds position, will attack if enemies are in attack range but will not pursue enemies.

SquadGotoMapBorder
alert This function has not been verified yet! It may not be acurate

Squad walks to Target from outside map border. Target must be a ScriptMarker and close to MapBorder.

 TargetTag

SquadAnimPlay
alert This function has not been verified yet! It may not be acurate

Plays the animation once for all figures in the Squad.

 Unit
 Anim

SquadAnimPlayLooped
alert This function has not been verified yet! It may not be acurate

Plays the animation continuously for all figures in the Squad.

 Unit
 Anim

SquadInRangePushBack
alert This function has not been verified yet! It may not be acurate

Squad figures are getting pushed back, the epicentre of the pushback is at the TargetTag location.

 Range

SquadStop
alert This function has not been verified yet! It may not be acurate

Squad stops movement.

SquadGroupCheckpointGoto
alert This function has not been verified yet! It may not be acurate

SquadGroup goes to next Checkpoint (direct line of sight to Checkpoint is recommended).

 TargetTag
 Run

SquadCheckpointGoto
alert This function has not been verified yet! It may not be acurate

Squad goes to next Checkpoint (direct line of sight to Checkpoint is recommended).

 TargetTag
 Run

SquadGroupCheckpointGotoStop
alert This function has not been verified yet! It may not be acurate

Stops a SquadGroup that is currently on a CheckpointGoto. Group will stop at the next checkpoint they reach.

SquadGridGoto
alert This function has not been verified yet! It may not be acurate

Standard Goto that uses the GotoGrid.

 TargetTag
 Direction
 IgnoreGridIfAllSquadsFly

SquadGridPatrol
alert This function has not been verified yet! It may not be acurate

Patrol mode on path given by TargetTag (start & end point), uses GotoGrid.

 TargetTag
 Direction

SquadSpawnRandomSelection
alert This function has not been verified yet! It may not be acurate

Spawns a random selection of Squads, depending on the SpawnTable (see description for table syntax).

PlayerSquadSpawnRandomSelection
alert This function has not been verified yet! It may not be acurate

Spawns a random selection of Squads, depending on the SpawnTable (see description for table syntax).

### OctoberVersionOnly

OctoberVersionOnly\_DoDamageToTeamSquadInRange
alert This function has not been verified yet! It may not be acurate

Does damage to Squads in Range.

 TargetTag
 Range
 Amount

OctoberVersionOnly\_DoDamageToTeamSquadInRect
alert This function has not been verified yet! It may not be acurate

Does damage to Squads in Range.

 Tag
 TargetTag
 Amount

OctoberVersionOnly\_DoDamageToTeamSquadInRay
alert This function has not been verified yet! It may not be acurate

Does damage to Squads in Range.

 Tag
 TargetTag
 Amount

### Debug

DebugInfoMessage
alert This function has not been verified yet! It may not be acurate

Shows a MessageBox to the user (ignored in release builds).

 Popup

DebugWarningMessage
alert This function has not been verified yet! It may not be acurate

Shows a MessageBox to the user (ignored in release builds).

 Popup

DebugErrorMessage
alert This function has not been verified yet! It may not be acurate

Shows a MessageBox to the user (ignored in release builds).

 Popup

### Ability

AbilitySpawn
alert This function has not been verified yet! It may not be acurate

Spawns (creates) an entity on the map.

 Team
 AbilityId

AbilitySpawnWithTag
alert This function has not been verified yet! It may not be acurate

Spawns (creates) an entity on the map.

 TargetTag
 Team
 AbilityId

AbilitySpawnIntoGroup
alert This function has not been verified yet! It may not be acurate

Spawns (creates) an entity on the map.

 Group
 TargetTag
 Team
 AbilityId

AbilityVanish
alert This function has not been verified yet! It may not be acurate

Removes the Ability from the map. Works with all supported entity types.

AbilityDestroy
alert This function has not been verified yet! It may not be acurate

Kills or destroys the Ability regularly.

### Generator & Monument

MonumentVanish
alert This function has not been verified yet! It may not be acurate

Removes the Monument from the map.

GeneratorVanish
alert This function has not been verified yet! It may not be acurate

Removes the Generator from the map.

### ScriptGroup

ScriptGroupClear
alert This function has not been verified yet! It may not be acurate

Removes all tags from the ScriptGroup.

ScriptGroupTagAdd
alert This function has not been verified yet! It may not be acurate

Adds the tag to the ScriptGroup.

 Tag

ScriptGroupTagRemove
alert This function has not been verified yet! It may not be acurate

Removes the tag from the ScriptGroup.

 Tag

ScriptGroupSquadSpawnCounterReset
alert This function has not been verified yet! It may not be acurate

Resets the ScriptGroup's SquadSpawnCounter value (set to 0).

ScriptGroupSquadDeathCounterReset
alert This function has not been verified yet! It may not be acurate

Resets the ScriptGroup's SquadDeathCounter value (set to 0).

### !Functions

GetScriptTag
alert This function has not been verified yet! It may not be acurate

Returns the ScriptTag of the entity currently executing this script.

GetScriptPath
alert This function has not been verified yet! It may not be acurate

Returns the path to the current map's 'script' folder, for use in: dofile(GetScriptPath()..'myscript.lua')

GetNumPlayers
alert This function has not been verified yet! It may not be acurate

Returns the number of Players that are starting the map.

GetCurrentWaveNumber
alert This function has not been verified yet! It may not be acurate

Returns the current wave number in a SpawnWave 'sp\_' script.

GetTotalWaveNumber
alert This function has not been verified yet! It may not be acurate

Returns the total number of waves executing this SpawnWave 'sp\_' script.

ArenaDummyRandom
alert This function has not been verified yet! It may not be acurate

'Real' random for 1p Arena Map. MUST NOT BE USED FOR PRODUCTION!!! WILL CAUSE DESYNCH IN MULTIPLAYER!!!

GdsGetConfigBoolean
alert This function has not been verified yet! It may not be acurate

Tries to read a Boolean value from config.xml. If value does not exist, value is added to config.xml and 'false' is returned. Key is Case-insensitive.

GdsGetConfigInteger
alert This function has not been verified yet! It may not be acurate

Tries to read an Integer value from config.xml. If value does not exist, value is added to config.xml and '0' is returned. Key is Case-insensitive.

GdsGetConfigFloat
alert This function has not been verified yet! It may not be acurate

Tries to read a Float value from config.xml. If value does not exist, value is added to config.xml and '0.0' is returned. Key is Case-insensitive.

GdsGetConfigString
alert This function has not been verified yet! It may not be acurate

Tries to read a String value from config.xml. If value does not exist, value is added to config.xml and empty string is returned. Key is Case-insensitive.

GetDifficulty
alert This function has not been verified yet! It may not be acurate

Returns the current difficulty (a number).

SetDifficulty
alert This function has not been verified yet! It may not be acurate

Sets the game's difficulty (a number).

SpawnWaveTemplate
alert This function has not been verified yet! It may not be acurate

Creates templates of SpawnWaves for later Spawning.

SpawnWaveEmitter
alert This function has not been verified yet! It may not be acurate

Defines a group of spawn waves that can be emitted at a certain location.

RegisterSquadSpawnCounter
alert This function has not been verified yet! It may not be acurate

Counts all Squad spawns in this ScriptGroup. Must be used outside of any State!

RegisterSquadDeathCounter
alert This function has not been verified yet! It may not be acurate

Counts all Squad deaths in this ScriptGroup. Must be used outside of any State!

UpgradeLevel0
alert This function has not been verified yet! It may not be acurate

Changes the base (Upgrade2) ID of an entity to the corresponding UpgradeLevel ID.

UpgradeLevel1
alert This function has not been verified yet! It may not be acurate

Changes the base (Upgrade2) ID of an entity to the corresponding UpgradeLevel ID.

UpgradeLevel2
alert This function has not been verified yet! It may not be acurate

Changes the base (Upgrade2) ID of an entity to the corresponding UpgradeLevel ID.

UpgradeLevel3
alert This function has not been verified yet! It may not be acurate

Changes the base (Upgrade2) ID of an entity to the corresponding UpgradeLevel ID.

### Player

PlayerCardSpellFakePlay
alert This function has not been verified yet! It may not be acurate

Emulates the playing of a CardSpell but without Power consumption and for any Player.

 AimTag
 Player
 CardSpellId

PlayerCardSquadFakePlay
alert This function has not been verified yet! It may not be acurate

Emulates the playing of a CardSquad but without Power consumption and for any Player.

PlayerCardSquadFakePlayWithTag
alert This function has not been verified yet! It may not be acurate

Emulates the playing of a CardSquad but without Power consumption and for any Player.

PlayerGameOver
alert This function has not been verified yet! It may not be acurate

GameOver man, GameOver!

 TargetTag
 Message

PlayerGameWon
alert This function has not been verified yet! It may not be acurate

GameOver man, GameOver!

PlayerGameOverCheckEnabled
alert This function has not been verified yet! It may not be acurate

Enables the GameOver check.

PlayerGameOverCheckDisabled
alert This function has not been verified yet! It may not be acurate

Disables the GameOver check.

PlayerPowerGive
alert This function has not been verified yet! It may not be acurate

Gives Power to or takes Power from a Player.

 Amount

PlayerPowerTake
alert This function has not been verified yet! It may not be acurate

Gives Power to or takes Power from a Player.

 Amount

PlayerGeneratorActivate
alert This function has not been verified yet! It may not be acurate

Builds a Generator so it generates energy for that Player.

 Player

PlayerMonumentActivate
alert This function has not been verified yet! It may not be acurate

Builds an Orb on a Monument for that Player.

 Player
 Power

PlayerGeneratorRefresh
alert This function has not been verified yet! It may not be acurate

Refreshes capacity of the Generator, so it can be rebuild if depleted.

PlayerGeneratorDeactivate
alert This function has not been verified yet! It may not be acurate

Crushes Generator so it stops producing Energy.

PlayerMonumentDeactivate
alert This function has not been verified yet! It may not be acurate

Destroys the Orb of a Monument.

PlayerSquadCheer
alert This function has not been verified yet! It may not be acurate

Squads in range play their Cheer Anim/FX!

 TargetTag
 Range

### Object

ObjectSpawn
alert This function has not been verified yet! It may not be acurate

Spawns (creates) an entity on the map.

 ObjectId
 Direction
 Height
 Scaling

ObjectSpawnWithTag
alert This function has not been verified yet! It may not be acurate

Spawns (creates) an entity on the map.

ObjectTypeChange
alert This function has not been verified yet! It may not be acurate

Changes the type of an entity.

 ObjectId

ObjectVanish
alert This function has not been verified yet! It may not be acurate

Removes the Object from the map.

ObjectDestroy
alert This function has not been verified yet! It may not be acurate

Destroys the Object, Object MUST be destructible!

ObjectAnimPlay
alert This function has not been verified yet! It may not be acurate

Plays the animation once on the Object.

 Anim

ObjectAnimPlayLooped
alert This function has not been verified yet! It may not be acurate

Plays the animation continuously on the Object.

 Anim

### Entity

EntityAbilityAdd
alert This function has not been verified yet! It may not be acurate

Adds or removes Abilities of an entity.

 AbilityId
 ApplyToFigures

EntityAbilityRemove
alert This function has not been verified yet! It may not be acurate

Adds or removes Abilities of an entity.

 AbilityId
 ApplyToFigures

EntitySpellCast
alert This function has not been verified yet! It may not be acurate

Lets the Entity(s) cast the given Spell on the TargetEntity. Target must be valid for the given Spell.

 TargetTag
 SpellId

EntitySpellCastOnClosestSquad
alert This function has not been verified yet! It may not be acurate

Lets the Entity(s) cast the given Spell on the closest Squad. Target must be valid for the given Spell.

 SpellId

EntitySpellCastOnClosestBuilding
alert This function has not been verified yet! It may not be acurate

Lets the Entity(s) cast the given Spell on the closest Building. Target must be valid for the given Spell.

 SpellId

EntitySpellCastOnClosestGenerator
alert This function has not been verified yet! It may not be acurate

Lets the Entity(s) cast the given Spell on the closest Power Generator. Target must be valid for the given Spell.

 SpellId
 IgnoreEmpty

EntitySpellCastOnClosestTarget
alert This function has not been verified yet! It may not be acurate

Lets the Entity(s) cast the given Spell on the closest attackable Target. Target must be valid for the given Spell.

 SpellId

EntityPlayerSet
alert This function has not been verified yet! It may not be acurate

Sets the Player (Owner) the entity belongs to, changing who can select & control the entity.

 Player

EntityTeamSet
alert This function has not been verified yet! It may not be acurate

Sets the Team the entity belongs to, possibly changing it's friend-foe relationships.

 Team

EntityDirectionSet
alert This function has not been verified yet! It may not be acurate

Changes Direction of an Entity.

 Direction
 Variation

EntityDirectionSetRelative
alert This function has not been verified yet! It may not be acurate

Changes Direction of an Entity.

 Direction
 Variation

EntityDirectionLookAtTarget
alert This function has not been verified yet! It may not be acurate

Changes Direction of an Entity.

 TargetTag
 Variation

EntityHealthSet
alert This function has not been verified yet! It may not be acurate

Modifies the health (lifepoints) of the entity in percentage of its max. health.

 Percent

EntityHealthAdd
alert This function has not been verified yet! It may not be acurate

Modifies the health (lifepoints) of the entity in percentage of its max. health.

 Percent

EntityHealthSubtract
alert This function has not been verified yet! It may not be acurate

Modifies the health (lifepoints) of the entity in percentage of its max. health.

 Percent
 DoDamage

EntitySetMaxHealthAbsolute
alert This function has not been verified yet! It may not be acurate

Set the max health (lifepoints) of the entity.

 MaxHealthAbsolute

EntityVanish
alert This function has not been verified yet! It may not be acurate

Removes the Entity from the map. Works with all supported entity types.

EntityKill
alert This function has not been verified yet! It may not be acurate

Kills or destroys the Entity, entity MUST be destructible! Works with all supported entity types.

EntityKillInRange
alert This function has not been verified yet! It may not be acurate

Kills all entities in range. Should not be used! Basis for filtered Actions.

 Range

EntitySpellAdd
alert This function has not been verified yet! It may not be acurate

Adds the Spell to the Entity unless it already exists.

 SpellId

EntitySpellRemove
alert This function has not been verified yet! It may not be acurate

Removes the Spell from the Entity if it exists (otherwise command is ignored).

 SpellId

EntityTeleport
alert This function has not been verified yet! It may not be acurate

Instantly teleports entity(s) to TargetTag location, no questions asked.

 TargetTag

### Variable

NetworkFlagSetTrue
alert This function has not been verified yet! It may not be acurate

Changes the flag accordingly.

NetworkFlagSetFalse
alert This function has not been verified yet! It may not be acurate

Changes the flag accordingly.

NetworkFlagToggle
alert This function has not been verified yet! It may not be acurate

Toggles the flag, eg if it is true it will be set to false and vice versa.

NetworkValueSet
alert This function has not been verified yet! It may not be acurate

Changes the value accordingly.

 Value

NetworkValueAdd
alert This function has not been verified yet! It may not be acurate

Changes the value accordingly.

 Value

NetworkValueSubtract
alert This function has not been verified yet! It may not be acurate

Changes the value accordingly.

 Value

NetworkValueIncrease
alert This function has not been verified yet! It may not be acurate

Increases the value by one, shorthand for Add with Value 1.

NetworkValueDecrease
alert This function has not been verified yet! It may not be acurate

Decreases the value by one, shorthand for Subtract with Value 1.

PlayerFlagSetTrue
alert This function has not been verified yet! It may not be acurate

Changes the flag accordingly.

 Name

PlayerFlagSetFalse
alert This function has not been verified yet! It may not be acurate

Changes the flag accordingly.

 Name

PlayerFlagToggle
alert This function has not been verified yet! It may not be acurate

Toggles the flag, eg if it is true it will be set to false and vice versa.

 Name

PlayerValueSet
alert This function has not been verified yet! It may not be acurate

Changes the value accordingly.

 Name
 Value

PlayerValueAdd
alert This function has not been verified yet! It may not be acurate

Changes the value accordingly.

 Name
 Value

PlayerValueSubtract
alert This function has not been verified yet! It may not be acurate

Changes the value accordingly.

 Name
 Value

PlayerValueIncrease
alert This function has not been verified yet! It may not be acurate

Increases the value by one, shorthand for Add with Value 1.

 Name

PlayerValueDecrease
alert This function has not been verified yet! It may not be acurate

Decreases the value by one, shorthand for Subtract with Value 1.

 Name

PlayerValueRandomize
alert This function has not been verified yet! It may not be acurate

Changes the value accordingly.

 Name
 MaxValue

PlayerTimerStart
alert This function has not been verified yet! It may not be acurate

Starts/Stops a Timer.

 Name

PlayerTimerStop
alert This function has not been verified yet! It may not be acurate

Starts/Stops a Timer.

 Name

MapFlagSetTrue
alert This function has not been verified yet! It may not be acurate

Changes the flag accordingly.

MapFlagSetFalse
alert This function has not been verified yet! It may not be acurate

Changes the flag accordingly.

MapFlagToggle
alert This function has not been verified yet! It may not be acurate

Toggles the flag, eg if it is true it will be set to false and vice versa.

EntityFlagSetTrue
alert This function has not been verified yet! It may not be acurate

Changes the flag accordingly.

EntityFlagSetFalse
alert This function has not been verified yet! It may not be acurate

Changes the flag accordingly.

EntityFlagToggle
alert This function has not been verified yet! It may not be acurate

Toggles the flag, eg if it is true it will be set to false and vice versa.

MapValueSet
alert This function has not been verified yet! It may not be acurate

Changes the value accordingly.

 Value

MapValueAdd
alert This function has not been verified yet! It may not be acurate

Changes the value accordingly.

 Value

MapValueSubtract
alert This function has not been verified yet! It may not be acurate

Changes the value accordingly.

 Value

MapValueIncrease
alert This function has not been verified yet! It may not be acurate

Increases the value by one, shorthand for Add with Value 1.

MapValueDecrease
alert This function has not been verified yet! It may not be acurate

Decreases the value by one, shorthand for Subtract with Value 1.

MapValueRandomize
alert This function has not been verified yet! It may not be acurate

Changes the value accordingly.

 MaxValue

EntityValueSet
alert This function has not been verified yet! It may not be acurate

Changes the value accordingly.

 Value

EntityValueAdd
alert This function has not been verified yet! It may not be acurate

Changes the value accordingly.

 Value

EntityValueSubtract
alert This function has not been verified yet! It may not be acurate

Changes the value accordingly.

 Value

EntityValueIncrease
alert This function has not been verified yet! It may not be acurate

Increases the value by one, shorthand for Add with Value 1.

EntityValueDecrease
alert This function has not been verified yet! It may not be acurate

Decreases the value by one, shorthand for Subtract with Value 1.

EntityValueRandomize
alert This function has not been verified yet! It may not be acurate

Changes the value accordingly.

 MaxValue

MapTimerStart
alert This function has not been verified yet! It may not be acurate

Starts/Stops a Timer.

MapTimerStop
alert This function has not been verified yet! It may not be acurate

Starts/Stops a Timer.

EntityTimerStart
alert This function has not been verified yet! It may not be acurate

Starts/Stops a Timer.

EntityTimerStop
alert This function has not been verified yet! It may not be acurate

Starts/Stops a Timer.

MapValueSetToVarValue
alert This function has not been verified yet! It may not be acurate

Changes the value accordingly.

 VarName

MapValueAddVarValue
alert This function has not been verified yet! It may not be acurate

Changes the value accordingly.

 VarName

MapValueSubtractVarValue
alert This function has not been verified yet! It may not be acurate

Changes the value accordingly.

 VarName

MapValueMultiplyByVarValue
alert This function has not been verified yet! It may not be acurate

Changes the value accordingly.

 VarName

MapValueDivideByVarValue
alert This function has not been verified yet! It may not be acurate

Changes the value accordingly.

 VarName

EntityValueSetToVarValue
alert This function has not been verified yet! It may not be acurate

Changes the value accordingly.

 VarName

EntityValueAddVarValue
alert This function has not been verified yet! It may not be acurate

Changes the value accordingly.

 VarName

EntityValueSubtractVarValue
alert This function has not been verified yet! It may not be acurate

Changes the value accordingly.

 VarName

EntityValueMultiplyByVarValue
alert This function has not been verified yet! It may not be acurate

Changes the value accordingly.

 VarName

EntityValueDivideByVarValue
alert This function has not been verified yet! It may not be acurate

Changes the value accordingly.

 VarName

### Barrier

BarrierBuildOrRepair
alert This function has not been verified yet! It may not be acurate

Builds the specified BarrierSet and gives it to the Player, or repairs it if the Player owns that BarrierSet.

 Player

BarrierGateToggle
alert This function has not been verified yet! It may not be acurate

Opens or closes all Gates of the BarrierSet, depending on their current state.

BarrierGateOpen
alert This function has not been verified yet! It may not be acurate

Opens all Gates of the BarrierSet.

BarrierGateClose
alert This function has not been verified yet! It may not be acurate

Closes all Gates of the BarrierSet.

BarrierVanish
alert This function has not been verified yet! It may not be acurate

Removes the Barrier from the map.

BarrierDestroy
alert This function has not been verified yet! It may not be acurate

Destroys the Barrier.

### Mission

MissionEventInfo
alert This function has not been verified yet! It may not be acurate

Puts a message into the EventQueue.

 TargetTag
 Summary
 Description

MissionEventWarning
alert This function has not been verified yet! It may not be acurate

Puts a message into the EventQueue.

 TargetTag
 Summary
 Description

MissionEventSuccess
alert This function has not been verified yet! It may not be acurate

Puts a message into the EventQueue.

 TargetTag
 Summary
 Description

MissionEventFailure
alert This function has not been verified yet! It may not be acurate

Puts a message into the EventQueue.

 TargetTag
 Summary
 Description

MiniMapAlert
alert This function has not been verified yet! It may not be acurate

Show an Alert on MiniMap at the specified TargetTag location.

 AlertType

MissionOutcry
alert This function has not been verified yet! It may not be acurate

Displays a voiced text outside a Cutscene. Several Outcries can be queued as a conversation. (As opposed to MissionOutcry, which relies on the chat, Log directly logs to the log files in Documents/BattleForge/Diag.

MissionTaskSetActive
alert This function has not been verified yet! It may not be acurate

Adds, removes or modifies a Mission Task.

 TaskTag
 TargetTag
 Summary
 Description

MissionTaskSetSolved
alert This function has not been verified yet! It may not be acurate

Adds, removes or modifies a Mission Task.

 TaskTag
 TargetTag
 Summary
 Description

MissionTaskSetFailed
alert This function has not been verified yet! It may not be acurate

Adds, removes or modifies a Mission Task.

 TaskTag
 TargetTag
 Summary
 Description

MissionTaskRemove
alert This function has not been verified yet! It may not be acurate

Adds, removes or modifies a Mission Task.

 TaskTag

MissionTaskOnlyTransferXP
alert This function has not been verified yet! It may not be acurate

Adds, removes or modifies a Mission Task.

MissionCounterShow
alert This function has not been verified yet! It may not be acurate

Shows a Mission Counter onscreen (eg 'Bosses Killed: 0/3').

 CounterTag
 LocaTag
 MaxValue

MissionCounterHide
alert This function has not been verified yet! It may not be acurate

Hides the Mission Counter from display (the counter's value itself can still be queried/modified).

 CounterTag

MissionTimerStart
alert This function has not been verified yet! It may not be acurate

Adds a Mission Timer displayed onscreen.

 TimerTag
 LocaTag
 Seconds
 Minutes

MissionTimerChange
alert This function has not been verified yet! It may not be acurate

Changes the text of an existing Mission Timer without changing the timer.

 TimerTag
 TimerTagOld
 LocaTag

MissionTimerStop
alert This function has not been verified yet! It may not be acurate

Removes the Mission Timer from onscreen display and stops it.

 TimerTag

MissionTimerPause
alert This function has not been verified yet! It may not be acurate

Pauses the Mission Timer if not already paused. NOT YET IMPLEMENTED - please ask if needed!

 TimerTag

MissionTimerResume
alert This function has not been verified yet! It may not be acurate

Resumes a Mission Timer if it is currently paused. NOT YET IMPLEMENTED - please ask if needed!

 TimerTag

MissionCounterSet
alert This function has not been verified yet! It may not be acurate

Changes the value accordingly.

 CounterTag
 Value

MissionCounterIncrease
alert This function has not been verified yet! It may not be acurate

Increases the value by one, shorthand for Add with Value 1.

 CounterTag

MissionCounterDecrease
alert This function has not been verified yet! It may not be acurate

Decreases the value by one, shorthand for Subtract with Value 1.

 CounterTag

MissionCounterSetToHealthPercent
alert This function has not been verified yet! It may not be acurate

Sets the Mission Counter to the entity's health percent.

 Tag
 CounterTag