Hello there! We are conducting a survey to better understand the user experience in making a first edit. If you have ever made an edit on Gamepedia, please fill out the survey. Thank you!

Triggers/Category Unit

From SC2Mapster Wiki
Jump to: navigation, search
Bot.png
Don't create new Links from this page Discuss
All Links here are being Corrected to match with the ones in Triggers/Functions Triggers/Actions

Contents

Abilities

Triggering Ability

  • Function. Returns the triggering ability. Used in response to "Unit Uses Ability".

Triggering Ability Stage

  • Function. Returns the triggering ability stage. Used in response to "Unit Uses Ability".

Ability That Created Unit

  • Function. Returns the ability that created the unit. Used in response to "Unit Is Created".

Behavior That Created Unit

  • Function. Returns the behavior that created the unit. Used in response to "Unit Is Created".

Created Unit

  • Function. Returns the unit that was created. Used in response to "Unit Is Created".

Triggering Ability Target Point

  • Function. Returns the triggering ability target point. Used in response to "Unit Uses Ability".

Triggering Ability Target Unit

  • Function. Returns the triggering ability targeted unit. Used in response to "Unit Uses Ability".

Change Level For Unit Ability

  • Action. Sets the level for the specified ability on the specified unit.

Ability Enabled For Unit

  • Function. Returns true if the specified ability is enabled/disabled for the specified unit.

Number Of Abilities On Unit

  • Function. Returns the number of abilities on a unit.

Enable/Disable Ability For Unit

  • Action. Enables or disables an ability on a unit.

Unit Has Ability

  • Function. Returns true if a unit has a specified ability.

Unit Ability

  • Function. Returns the ability in the specified unit's ability array at the specified index.

Current Level For Unit Ability

  • Function. Returns the current level of the specified ability on the specified unit.

Maximum Level For Unit Ability

  • Function. Returns the maximum level for the specified ability on the specified unit.

Show/Hide Ability For Unit

  • Function. Shows or hides the specified ability on the specified unit.

Unit Ability Command State

  • Function. Returns true if a unit's ability command is at a certain state.

Attributes And Experience

Triggering Attribute Points

  • Function. Returns the triggering attribute points. Used in response to "Unit Attribute Change".

Triggering Behavior

  • Function. Returns the triggering behavior. Used in response to "Unit Attribute Change", "Unit Gains Experience", or "Unit Gains Experience Level".

Triggering Experience Gained

  • Function. Returns the triggering experience gained. Used in response to "Unit Gains Experience".

Experience Level Of Unit

  • Function. Returns the experience value of a unit.

Enable/Disable Experience Gain For Unit

  • Function. Enables or disables experience gain for the specified unit.

Total Experience Of Unit

  • Function. Returns the total experience a unit possesses.

Basic

Create Units With Point Facing

  • Action. 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.

Create Units With Default Facing

  • Action. 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.

Triggering Unit

  • Function. Returns the triggering unit.

New Unit Owner

  • Function. Returns the new owner of a unit, when used in response to "Unit Owner Changes".

Old Unit Owner

  • Function. Returns the previous owner of a unit, when used in response to "Unit Owner Changes".

Triggering Region

  • Function. Returns the triggering region. Use in response to "Unit Enters/Leaves Region".

Last Replaced Unit

  • Function. Returns the last replacement unit created via "Replace Unit". This function is not thread safe, so don't call it after a "Wait" action.

Make Unit Face Point

  • Action. Makes a unit face a specified point.

Pause/Unpause Unit

  • Action. Pauses or unpauses the specified unit.

Replace Unit

  • Action. Use "Last Replaced Unit" to refer to the replacement unit. Note that any variables referring to the old unit will need to be updated.

Rescue Unit

  • Action. Causes a unit to be rescued, changing ownership and changing or retaining its color.

Rescue Unit Group

  • Action. Causes the units in a unit group to be rescued, changing ownership and changing or retaining color.

Share Vision of Unit

  • Action. Shares vision of a unit with another player.

Show/Hide Unit

  • Action. Shows or hides a unit.

Agent Of Player For Unit

  • Function. Returns the unit that is currently assigned as the specified player's purchasing agent for the specified shop unit.

Create Units Facing Angle

  • Action. Creates units facing a specified angle. Use the "Last Created Unit" and "Last Created Units" functions to refer to the created units.

Create Units Facing Point

  • Action. Creates units facing a specified point. Use the "Last Created Unit" and "Last Created Units" functions to refer to the created units.

Custom Value Of Unit

  • Function. Returns a custom value of a unit.

Facing Angle Of Unit

  • Function. Returns the facing angle of the unit.

Owner Of Unit

  • Function. Returns the owner of a unit.

Position Of Unit

  • Function. Returns the position of a unit.

Unit Group Is Dead

  • Function. Returns true if all units in the unit group are dead. An empty unit group is considered to be dead.

Unit In Region

  • Function. Returns true if a unit is in the specified region.

Unit Is Alive

  • Function. Returns true if a unit is alive.

Unit Is Hidden

  • Function. Returns true if a unit is hidden.

Unit Is Paused

  • Function. Returns true if a unit is paused.

Unit Is Valid

  • Function. Returns true if a unit is valid.

Unit Is Visible To Player

  • Function. Returns true if the specified unit is visible to the specified player.

Kill Unit

  • Action. Kills the specified unit.

Last Created Unit

  • Function. Returns the last unit created via a "Create Units" action. This function ignores units created by other triggers.

Last Created Units

  • Function. Returns the last group of units created via a "Create Units" action. This function ignores units created by other triggers.

Load Unit Model

  • Action. Loads a unit model.

Pause/Unpause All Units

  • Action. Pauses or unpauses all units on the map.

Remove Unit

  • Action. Removes a unit from the game.

Revive Unit

  • Action. Revives the specified unit.

Set Unit Custom Value

  • Action. Sets a unit's custom value. This is an arbitrary property that can be recalled using "Custom Value Of Unit".

Make Unit Face Angle

  • Action. Makes a unit face a specified angle.

Change Owner

  • Action. Changes the ownership of a unit to another player.

Move Unit Instantly

  • Action. 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.

Unload Unit Model

  • Action. Unloads a unit model.

Behaviors

Add Behavior

  • Action. Adds a behavior to the specified unit setting the casting unit to the specified caster.

Add Behavior (Player)

  • Action. Adds a behavior to the specified unit setting the casting player to the specified player.

Stack Count Of Behavior On Unit

  • Function. Returns the stack count of a behavior on a unit.

Number Of Behaviors On Unit

  • Function. Returns the number of behaviors on a unit.

Unit Behavior Enabled

  • Function. Returns true if the specified unit has the specified behavior enabled.

Unit Behavior

  • Function. Returns the behavior at the specified index on the specified unit.

Behavior Has Flag

  • Function. Returns true if the behavior has a specified flag.

Remove Behavior

  • Action. Removes a behavior from a unit.

Remove Behaviors By Category

  • Action. Removes all behaviors that belong to the specified category from the specified unit.

Remove Behavior (Player)

  • Action. Removes a behavior from the specified unit, setting the casting player to the specified player.

Set Unit Behavior Duration

  • Action. Sets a behavior duration on a unit.

Transfer Behavior

  • Action. Transfers a behavior from a source unit to a destination unit.

Unit Has Behavior

  • Function. Returns true if the specified unit has the specified behavior.

Cargo

Triggering Cargo Unit

  • Function. Returns the triggering cargo unit. Used in response to a "Unit Loads/Unloads Cargo" event.

Cargo Unit In Transport

  • Function. Returns the unit at the specified index in the specified unit's cargo hold.

Create Cargo Units

  • Action. 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.

Cargo Units In Transport

  • Function. Returns a unit group with all the units in the specified unit's cargo hold.

Last Created Cargo Unit

  • Function. Returns the last unit created via the "Create Cargo Units" action. This function ignores units created by other triggers.

Last Created Cargo Units

  • Function. Returns the last group of units created via the "Create Cargo Units" action. This function ignores units created by other triggers.

Transport Property Of Unit

  • Function. Returns the specified property for the specified unit.

Unit Is Cargo

  • Function. Returns true if the specified unit is considered a cargo unit.

Transport Of Unit

  • Function. Returns the transport a unit is in.

Charges And Cooldowns

Add Charge Regen Time For Unit Ability

  • Action. Adds to the amount of time it takes to regenerate the specified ability charge link.

Add Charge Used For Unit Ability

  • Action. Consumes the specified number of charges for the specified ability charge link.

Add Cooldown For Unit Ability

  • Action. Adds time to the specified ability cooldown link.

Ability Charge Info For Unit

  • Function. Returns the specified charge information for the specified ability on the specified unit.

Charge Regen For Unit Ability

  • Function. Returns the charge regen time for the specified ability charge link.

Charge Used For Unit Ability

  • Function. Returns the number of charges used for the specified ability charge link.

Cooldown For Unit Abilty

  • Function. Returns the cooldown time for the specified ability cooldown link.

Remove Charge Regen Time For Unit Ability

  • Action. Clears the amount of time it takes to regenerate the specified ability charge link.

Remove Charge Used For Unit Ability

  • Action. Clears the number of used charges for the specified ability charge link.

Remove Cooldown For Unit Ability

  • Action. Clears the specified ability cooldown link.

Reset Ability Cooldowns

  • Action. Resets the specified cooldowns on the specified ability on the specified unit.

Activate Ability Cooldowns

  • Action. 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.

Add Charge Regen Time For Unit

  • Action. Adds to the amount of time it takes to regenerate the specified unit charge link.

Add Charge Used For Unit

  • Action. Consumes the specified number of charges for the specified unit charge link.

Add Cooldown For Unit

  • Action. Adds time to the specified unit cooldown link.

Add Charge Regen Time For Unit Behavior

  • Action. Adds to the amount of time it takes to regenerate the specified behavior charge link.

Add Charge Used For Unit Behavior

  • Action. Consumes the specified number of charges for the specified behavior charge link.

Add Cooldown For Unit Behavior

  • Action. Adds time to the specified behavior cooldown link.

Charge Regen For Unit Behavior

  • Function. Returns the charge regen time for the specified behavior charge link.

Charge Used For Unit Behavior

  • Function. Returns the number of charges used for the specified behavior charge link.

Cooldown For Unit Behavior

  • Function. Returns the cooldown time for the specified behavior cooldown link.

Remove Charge Regen Time For Unit Behavior

  • Action. Clears the amount of time it takes to regenerate the specified behavior charge link.

Remove Charge Used For Unit Behavior

  • Action. Clears the number of used charges for the specified behavior charge link.

Remove Cooldown For Unit Behavior

  • Action. Clears the specified behavior cooldown link.

Charge Regen For Unit

  • Function. Returns the charge regen time for the specified unit charge link.

Charge Used For Unit

  • Function. Returns the number of charges used for the specified unit charge link.

Cooldown For Unit

  • Function. Returns the cooldown time for the specified unit cooldown link.

Remove Charge Regen Time For Unit

  • Action. Clears the amount of time it takes to regenerate the specified unit charge link.

Remove Charge Used For Unit

  • Action. Clears the number of used charges for the specified unit charge link.

Remove Cooldown For Unit

  • Action. Clears the specified unit cooldown link.

Combat

Triggering Damage Amount

  • Function. Returns the triggering damage amount.

Triggering Death Type Check

  • Function. Returns true if a unit is dying from a given type/cause of death. Use this in response to a "Unit Dies" event.

Damaging Effect

  • Function. Returns the damaging effect.

Killing Player

  • Function. Returns the killing player.

Damaging Player

  • Function. Returns the damaging player.

Damage Source Position

  • Function. Returns the damage source position or where the unit who is dealing damage is standing at.

Killing Unit

  • Function. Returns the killing unit.

Damaging Unit

  • Function. Returns the damaging unit.

Attacking Unit

  • Action. When called in response to a "Unit Is Attacked" event, this refers to the unit performing the attack.

Acquired Target

  • Function. Returns the acquired target of a unit.

Filters

Convert Target Filter String To Unit Filter

  • Action. Takes a target filter string (obtained from the catalog) and returns a unit filter.

State Of Unit Filter

  • Function. Returns the state of the specified index of the specified unit filter.

Unit Filter Match

  • Function. Returns true if the specified unit matches the specified filter criteria from the perspective of the specified player.

Set State Of Unit Filter

  • Action. Sets a state on the specified unit filter.

Items

Triggering Inventory Item

  • Function. Returns the triggering inventory item. Used in response to "Unit Manipulates Inventory".

Triggering Inventory Item Container

  • Function. Returns the triggering inventory item's container. Used in response to "Unit Manipulates Inventory".

Triggering Inventory Item Slot

  • Function. Returns the triggering inventory item's slot. Used in response to "Unit Manipulates Inventory".

Triggering Inventory Item Target Point

  • Function. Returns the point targeted by the action that caused the "Unit Manipulates Inventory" event to fire.

Triggering Inventory Item Target Unit

  • Function. Returns the unit targeted by the action that caused the "Unit Manipulates Inventory" event to fire.

Triggering Powerup

  • Function. Returns the triggering powerup. Used in response to "Unit Acquires Powerup".

Inventory Item Container

  • Function. Returns the container index that the specified inventory item is stored in.

Inventory Item Count

  • Function. Returns the inventory item count for the specified unit.

Create Inventory Item

  • Action. Creaters an item in a unit's inventory. Use the "Last Created Inventory Item" function to refer to the created item.

Inventory Items Carried

  • Function. Returns a unit group containing all items carried by the specified unit.

Inventory Item Index

  • Function. Returns the internal index for the specified inventory item.

Inventory Item Carried

  • Function. Returns a specific inventory item carried by the unit.

Last Created Inventory Item

  • Function. Returns the last item created via the "Create Inventory Item" action. This function ignores items created by other triggers.

Move Inventory Item

  • Action. Moves an inventory to the specified slot in the specified container.

Remove Inventory Item

  • Action. Removes an item from inventory

Inventory Item Slot

  • Function. Returns the slot index for the specified inventory item.

Inventory Item Carrier

  • Function. Returns the unit that is currently carrying the specified inventory item.

Orders

Triggering Order

  • Function. Returns the triggering order.

Issue Order To Unit Group

  • Action. Issues an order to all the units in the specified unit group.

Wait Until Unit Group Becomes Idle

  • Action. Waits until all the units in a unit group either becomes idle or discontinues being idle, depending on the Idle parameter.

Issue Order

  • Action. Issues an order to a unit.

Unit Order

  • Function. Returns an order for a unit.

Unit Order Count

  • Function. Returns the count of orders on a unit.

Unit Rally Point

  • Function. Returns a unit rally point.

Unit Rally Point Count

  • Function. Returns the number of rally points a unit has.

Unit Rally Point Target Count

  • Function. Returns the rally point target count of a unit.

Unit Rally Point Target Point

  • Function. Returns the the target point of a rally point.

Unit Rally Point Target Unit

  • Function. Returns the target unit of a rally point.

Wait Until Unit Becomes Idle

  • Action. Waits until a unit either becomes idle or discontinues being idle, depending on the Idle parameter.

Progress And Queues

Triggering Progress Effect

  • Function. Returns the triggering progress effect. Use in response to "Unit Specialization Progress".

Triggering Progress Unit Type

  • Function. Returns the triggering progress unit type. Used in response to "Unit Arming Progress", "Unit Construction Progress", or "Unit Training Progress".

Triggering Progress Upgrade

  • Function. Returns the triggering progress upgrade. Used in response to "Unit Research Progress".

Triggering Progress Unit

  • Function. 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".

Unit Progress Bar Check

  • Function. Returns true if a unit progress bar is at a certain state.

Unit Progress (Percent)

  • Function. Returns the unit progress in a training slot.

Unit Is Under Construction

  • Function. Returns true if a unit is under construction. This function does not work for dead units.

Training Queue Property Of Unit

  • Function. Returns the training queue property of a unit.

Number Of Items In Training Queue Slot

  • Function. Returns the number of items in the specified training queue slot.

Queued Behavior Type In Training Queue Slot

  • Function. Returns the behavior type of a unit in a specific training slot.

Queued Unit Type In Training Queue Slot

  • Function. Returns the unit type of a unit in a specific training slot.

Queued Upgrade Type In Training Queue Slot

  • Function. Returns the type of a unit in a specific training slot.

Training Queue Time

  • Function. Returns the training queue time for the unit in the specified training slot.

Training Queue Slot Type Check

  • Function. Returns true if a unit in training is training in the specified slot.

Set Unit Progress

  • Action. 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.

Pause/Resume/Cancel Unit Progress Bar

  • Action. Stops the construction progress bar of a unit.

Properties

Change Unit Damage

  • Action. Modifies the amount of damage a unit deals or takes. Minimal means 10% damage. Mega means 300% damage.

Triggering Unit Property

  • Function. Returns the triggering unit property in response to "Unit Property Changes" events.

Triggering Unit Property Change (Real)

  • Function. Returns the triggering unit property change in response to "Unit Property Changes" events.

Triggering Unit Property Change (Integer)

  • Function. Returns the triggering unit property change in response to "Unit Property Changes" events.

Make Unit Invulnerable

  • Action. Makes a unit vulnerable or invulnerable.

Make Unit Uncommandable

  • Action. Makes a unit commandable or uncommandable.

Clear Unit Info Text

  • Action. Clears the info text for the specified unit.

Set Unit Status Bar State

  • Action. Forces the status bar on or off for the specified unit.

Unit Attachment Point

  • Function. Returns the current position of a unit attachment point.

Height Of Unit

  • Function. Returns the height of the specified unit.

Unit Property

  • Function. Returns a unit property.

Unit Kills

  • Function. Returns the amount of kills a unit possesses.

Unit Resources

  • Function. Returns the amount of resources a unit has.

Unit Type Of Unit

  • Function. Returns the unit type for the specified unit.

Unit Is Invulnerable

  • Function. Returns true if a unit is invulnerable.

Unit Uses Mover

  • Function. Returns true if a unit uses the specified mover.

Unit Type Uses Mover

  • Function. Returns true if a unit type uses the specified mover.

Reset Movement Speed

  • Action. Resets the maximum speed value for a unit.

Set Unit Highlight Cursor

  • Action. Sets the highlight cursor for the specified unit.

Change Unit Height

  • Action. Changes the specified unit's height.

Set Unit Info Text

  • Action. Sets the info text for the specified unit.

Set Unit Property

  • Action. Sets a unit's property.

Set Unit Scale

  • Action. Sets a unit's scale.

Set Unit State

  • Action. Sets a unit's state.

Set Unit Color

  • Action. Sets a unit's team color.

Set Unit Model Variation

  • Action. Changes a unit's model to the specified model with the specified variation and can alter the textures with the specified texture props string.

Unit Targetable Check

  • Function. Returns true if a unit is targetable.

Unit Classification Check

  • Function. Returns true if a unit is a specific class type.

Unit Type From String

  • Action. Converts a string to a unit type. If the string does not match a valid unit type, the result will be empty.

Unit Type Cost

  • Function. Returns the cost of a unit type.

Name Of Unit Type

  • Function. Returns the name of a unit type.

Unit Type Property

  • Function. Returns a unit type property.

Unit Type Is Affected By Upgrade

  • Function. Returns true if the specified unit type is listed in the specified upgrade's affected unit array.

Unit Type Attribute Check

  • Function. Returns true if the unit has the specified attribute.

Unit Type Classification Check

  • Function. Returns true if the specified unit type has the specified flag.

Weapons

Unit Can Attack Unit

  • Function. Returns true if the specified unit is currently able to attack the specified target unit.

Add Ammo To Magazine

  • Action. Adds rounds of ammo to a magazine. (Example: Adds x Interceptors to a Carrier's bay.)

Magazine Count Of Unit

  • Function. Returns the number of rounds in an ability magazine for a unit.

Add Weapon To Unit

  • Action. Adds the specified weapon to the specified unit using the specified turret.

Weapon Target Check

  • Function. Returns true if a unit weapon can target a specific target.

Number Of Weapons On Unit

  • Function. Returns the number of weapons on a unit.

Unit Weapon

  • Function. Returns the weapon at the specified index on the specified unit.

Weapon Is Enabled

  • Function. Returns true if a weapon is enabled for a unit.

Weapon Cooldown

  • Function. Returns a unit's weapon cooldown.

Remove Weapon From Unit

  • Action. Removes the specified weapon from the specified unit.