Abilities
Returns the triggering ability. Used in response to "Unit Uses Ability".
Returns the triggering ability stage. Used in response to "Unit Uses Ability".
Returns the ability that created the unit. Used in response to "Unit Is Created".
Returns the behavior that created the unit. Used in response to "Unit Is Created".
Returns the unit that was created. Used in response to "Unit Is Created".
Returns the triggering ability target point. Used in response to "Unit Uses Ability".
Returns the triggering ability targeted unit. Used in response to "Unit Uses Ability".
Sets the level for the specified ability on the specified unit.
Returns true if the specified ability is enabled/disabled for the specified unit.
Returns the number of abilities on a unit.
Enables or disables an ability on a unit.
Returns true if a unit has a specified ability.
Returns the ability in the specified unit's ability array at the specified index.
Returns the current level of the specified ability on the specified unit.
Returns the maximum level for the specified ability on the specified unit.
Shows or hides the specified ability on the specified unit.
Returns true if a unit's ability command is at a certain state.
Attributes And Experience
Returns the triggering attribute points. Used in response to "Unit Attribute Change".
Returns the triggering behavior. Used in response to "Unit Attribute Change", "Unit Gains Experience", or "Unit Gains Experience Level".
Returns the triggering experience gained. Used in response to "Unit Gains Experience".
Returns the experience value of a unit.
Enables or disables experience gain for the specified unit.
Returns the total experience a unit possesses.
Basic
Creates units using the facing angle of a point. Use the "Last Created Unit" and "Last Created Units" functions to refer to the created units.
Creates units using the default facing angle of the unit. Use the "Last Created Unit" and "Last Created Units" functions to refer to the created units.
Returns the triggering unit.
Returns the new owner of a unit, when used in response to "Unit Owner Changes".
Returns the previous owner of a unit, when used in response to "Unit Owner Changes".
Returns the triggering region. Use in response to "Unit Enters/Leaves Region".
Returns the last replacement unit created via "Replace Unit". This function is not thread safe, so don't call it after a "Wait" action.
Makes a unit face a specified point.
Pauses or unpauses the specified unit.
Use "Last Replaced Unit" to refer to the replacement unit. Note that any variables referring to the old unit will need to be updated.
Causes a unit to be rescued, changing ownership and changing or retaining its color.
Causes the units in a unit group to be rescued, changing ownership and changing or retaining color.
Shares vision of a unit with another player.
Returns the unit that is currently assigned as the specified player's purchasing agent for the specified shop unit.
Creates units facing a specified angle. Use the "Last Created Unit" and "Last Created Units" functions to refer to the created units.
Creates units facing a specified point. Use the "Last Created Unit" and "Last Created Units" functions to refer to the created units.
Returns a custom value of a unit.
Returns the facing angle of the unit.
Returns the owner of a unit.
Returns the position of a unit.
Returns true if all units in the unit group are dead. An empty unit group is considered to be dead.
Returns true if a unit is in the specified region.
Returns true if a unit is alive.
Returns true if a unit is hidden.
Returns true if a unit is paused.
Returns true if a unit is valid.
Returns true if the specified unit is visible to the specified player.
Kills the specified unit.
Returns the last unit created via a "Create Units" action. This function ignores units created by other triggers.
Returns the last group of units created via a "Create Units" action. This function ignores units created by other triggers.
Pauses or unpauses all units on the map.
Removes a unit from the game.
Revives the specified unit.
Sets a unit's custom value. This is an arbitrary property that can be recalled using "Custom Value Of Unit".
Makes a unit face a specified angle.
Changes the ownership of a unit to another player.
Moves a unit instantly to the specified point. The Blend parameter causes the unit art to be interpolated between its old position and the new position over the duration of the next game loop. Without blending, the unit art will instantly pop to the new location.
Behaviors
Adds a behavior to the specified unit setting the casting unit to the specified caster.
Adds a behavior to the specified unit setting the casting player to the specified player.
Returns the stack count of a behavior on a unit.
Returns the number of behaviors on a unit.
Returns true if the specified unit has the specified behavior enabled.
Returns the behavior at the specified index on the specified unit.
Returns true if the behavior has a specified flag.
Removes a behavior from a unit.
Removes all behaviors that belong to the specified category from the specified unit.
Removes a behavior from the specified unit, setting the casting player to the specified player.
Sets a behavior duration on a unit.
Transfers a behavior from a source unit to a destination unit.
Returns true if the specified unit has the specified behavior.
Cargo
Returns the triggering cargo unit. Used in response to a "Unit Loads/Unloads Cargo" event.
Returns the unit at the specified index in the specified unit's cargo hold.
Creates cargo units inside a unit's cargo bay. Use the "Last Created Cargo Unit" and "Last Created Cargo Units" functions to refer to the created units.
Returns a unit group with all the units in the specified unit's cargo hold.
Returns the last unit created via the "Create Cargo Units" action. This function ignores units created by other triggers.
Returns the last group of units created via the "Create Cargo Units" action. This function ignores units created by other triggers.
Returns the specified property for the specified unit.
Returns true if the specified unit is considered a cargo unit.
Returns the transport a unit is in.
Charges And Cooldowns
Adds to the amount of time it takes to regenerate the specified ability charge link.
Consumes the specified number of charges for the specified ability charge link.
Adds time to the specified ability cooldown link.
Returns the specified charge information for the specified ability on the specified unit.
Returns the charge regen time for the specified ability charge link.
Returns the number of charges used for the specified ability charge link.
Returns the cooldown time for the specified ability cooldown link.
Clears the amount of time it takes to regenerate the specified ability charge link.
Clears the number of used charges for the specified ability charge link.
Clears the specified ability cooldown link.
Resets the specified cooldowns on the specified ability on the specified unit.
Activates the specified cooldowns on the specified ability on the specified unit. In most cases, this will cause the ability to act as if it had just been used.
Adds to the amount of time it takes to regenerate the specified unit charge link.
Consumes the specified number of charges for the specified unit charge link.
Adds time to the specified unit cooldown link.
Adds to the amount of time it takes to regenerate the specified behavior charge link.
Consumes the specified number of charges for the specified behavior charge link.
Adds time to the specified behavior cooldown link.
Returns the charge regen time for the specified behavior charge link.
Returns the number of charges used for the specified behavior charge link.
Returns the cooldown time for the specified behavior cooldown link.
Clears the amount of time it takes to regenerate the specified behavior charge link.
Clears the number of used charges for the specified behavior charge link.
Clears the specified behavior cooldown link.
Returns the charge regen time for the specified unit charge link.
Returns the number of charges used for the specified unit charge link.
Returns the cooldown time for the specified unit cooldown link.
Clears the amount of time it takes to regenerate the specified unit charge link.
Clears the number of used charges for the specified unit charge link.
Clears the specified unit cooldown link.
Combat
Returns the triggering damage amount.
Returns true if a unit is dying from a given type/cause of death. Use this in response to a "Unit Dies" event.
Returns the damaging effect.
Returns the killing player.
Returns the damaging player.
Returns the damage source position or where the unit who is dealing damage is standing at.
Returns the killing unit.
Returns the damaging unit.
When called in response to a "Unit Is Attacked" event, this refers to the unit performing the attack.
Returns the acquired target of a unit.
Filters
Takes a target filter string (obtained from the catalog) and returns a unit filter.
Returns the state of the specified index of the specified unit filter.
Returns true if the specified unit matches the specified filter criteria from the perspective of the specified player.
Sets a state on the specified unit filter.
Items
Returns the triggering inventory item. Used in response to "Unit Manipulates Inventory".
Returns the triggering inventory item's container. Used in response to "Unit Manipulates Inventory".
Returns the triggering inventory item's slot. Used in response to "Unit Manipulates Inventory".
Returns the point targeted by the action that caused the "Unit Manipulates Inventory" event to fire.
Returns the unit targeted by the action that caused the "Unit Manipulates Inventory" event to fire.
Returns the triggering powerup. Used in response to "Unit Acquires Powerup".
Returns the container index that the specified inventory item is stored in.
Returns the inventory item count for the specified unit.
Creaters an item in a unit's inventory. Use the "Last Created Inventory Item" function to refer to the created item.
Returns a unit group containing all items carried by the specified unit.
Returns the internal index for the specified inventory item.
Returns a specific inventory item carried by the unit.
Returns the last item created via the "Create Inventory Item" action. This function ignores items created by other triggers.
Moves an inventory to the specified slot in the specified container.
Removes an item from inventory
Returns the slot index for the specified inventory item.
Returns the unit that is currently carrying the specified inventory item.
Orders
Returns the triggering order.
Issues an order to all the units in the specified unit group.
Waits until all the units in a unit group either becomes idle or discontinues being idle, depending on the Idle parameter.
Issues an order to a unit.
Returns an order for a unit.
Returns the count of orders on a unit.
Returns a unit rally point.
Returns the number of rally points a unit has.
Returns the rally point target count of a unit.
Returns the the target point of a rally point.
Returns the target unit of a rally point.
Waits until a unit either becomes idle or discontinues being idle, depending on the Idle parameter.
Progress And Queues
Returns the triggering progress effect. Use in response to "Unit Specialization Progress".
Returns the triggering progress unit type. Used in response to "Unit Arming Progress", "Unit Construction Progress", or "Unit Training Progress".
Returns the triggering progress upgrade. Used in response to "Unit Research Progress".
Returns the triggering progress unit. Used in response to "Unit Arming Progress", "Unit Construction Progress", "Unit Research Progress", "Unit Specialization Progress", or "Unit Training Progress".
Returns true if a unit progress bar is at a certain state.
Returns the unit progress in a training slot.
Returns true if a unit is under construction. This function does not work for dead units.
Returns the training queue property of a unit.
Returns the number of items in the specified training queue slot.
Returns the behavior type of a unit in a specific training slot.
Returns the unit type of a unit in a specific training slot.
Returns the type of a unit in a specific training slot.
Returns the training queue time for the unit in the specified training slot.
Returns true if a unit in training is training in the specified slot.
Sets a unit's build/train/etc. progress to a percentage of total completion. This works for training, research, magazine ammo, building construction, add-on construction, and warp-in. This does not work for morphs or specializations.
Stops the construction progress bar of a unit.
Properties
Modifies the amount of damage a unit deals or takes. Minimal means 10% damage. Mega means 300% damage.
Returns the triggering unit property in response to "Unit Property Changes" events.
Returns the triggering unit property change in response to "Unit Property Changes" events.
Returns the triggering unit property change in response to "Unit Property Changes" events.
Makes a unit vulnerable or invulnerable.
Makes a unit commandable or uncommandable.
Clears the info text for the specified unit.
Forces the status bar on or off for the specified unit.
Returns the current position of a unit attachment point.
Returns the height of the specified unit.
Returns the amount of kills a unit possesses.
Returns the amount of resources a unit has.
Returns the unit type for the specified unit.
Returns true if a unit is invulnerable.
Returns true if a unit uses the specified mover.
Returns true if a unit type uses the specified mover.
Resets the maximum speed value for a unit.
Sets the highlight cursor for the specified unit.
Changes the specified unit's height.
Sets the info text for the specified unit.
Sets a unit's team color.
Changes a unit's model to the specified model with the specified variation and can alter the textures with the specified texture props string.
Returns true if a unit is targetable.
Returns true if a unit is a specific class type.
Converts a string to a unit type. If the string does not match a valid unit type, the result will be empty.
Returns the cost of a unit type.
Returns the name of a unit type.
Returns a unit type property.
Returns true if the specified unit type is listed in the specified upgrade's affected unit array.
Returns true if the unit has the specified attribute.
Returns true if the specified unit type has the specified flag.
Weapons
Returns true if the specified unit is currently able to attack the specified target unit.
Adds rounds of ammo to a magazine. (Example: Adds x Interceptors to a Carrier's bay.)
Returns the number of rounds in an ability magazine for a unit.
Adds the specified weapon to the specified unit using the specified turret.
Returns true if a unit weapon can target a specific target.
Returns the number of weapons on a unit.
Returns the weapon at the specified index on the specified unit.
Returns true if a weapon is enabled for a unit.
Returns a unit's weapon cooldown.
Removes the specified weapon from the specified unit.
You must login to post a comment. Don't have an account? Register to get one!
Facts
Date created
Sep 19, 2010
Last updated
Jan 24, 2011
StarCraft and Blizzard Entertainment are both trademarks or registered trademarks of Blizzard Entertainment in the United States and/or other countries. These terms and all related materials, logos, and images are copyright © Blizzard Entertainment. This site is in no way associated with or endorsed by Blizzard Entertainment.