- 1 Effects
- 2 Effect: Sub Types (Classes)
- 3 Common Fields
- 3.1 (None) - Can Be Blocked
- 3.2 (None) - Caster History
- 3.3 (None) - Debug Trace
- 3.4 (None) - Owning Player
- 3.5 (None) - Preloard Validators
- 3.6 Effect - AI Notify Effect
- 3.7 Effect - AI Notify Flags
- 3.8 Effect - Alert
- 3.9 Effect - Chance
- 3.10 Effect - Kill Hallucination
- 3.11 Effect - Response Flags
- 3.12 Effect - Tech Aliases
- 3.13 Effect - Validators
- 3.14 Target - Impact Location / Effect - Unit / Impact Unit / Which Location / Which Unit
- 3.15 Target - Marker
Effects[edit | edit source]
Description[edit | edit source]
Effects are one of the Data Types used when making custom abilities or weapons. Damage, picking the units to hit, adding behaviors, "interactions in general" between units are achieved through effects. Individual effect types are listed below and are linked to their own pages in which each field is explained in detail.
Hints[edit | edit source]
- Not all effects directly do something. Some are for the purpose of executing other effects (Switch and Set are examples of this)
- Some effects cannot be placed first in an ability. For example, you cannot put an Issue Order effect for start, since it cannot relate to a launch point.
- Further on the same topic, the first effect put in an ability usually determines how the targeting will occur. For example, if you put a Set effect with a Unit Location, you will never be able to target the ground, even if the child effects create an aoe.
- There is a way to bug/glitch an auto-cast with effects. If you use a set effect on a point location as a first effect of an Effect - Target ability, which possess an apply behavior effect inside it (from which the effect's location is "Target") , it will not do anything for manual cast since the point location resolves to no unit (the ground). However for an auto-cast ability, it will be considered as the ability targeted a unit for basis (even if targeting the ground) and will mark the triggering target of the auto-cast as the Target location of the apply behavior.
Effect: Sub Types (Classes)[edit | edit source]
- Add Tracked Unit
- Add Tracked Units
- Apply Behavior
- Apply Force
- Apply Kinetic
- Cancel Order
- Clear Tracked Units
- Create Healer
- Create Persistent
- Create Unit
- Destroy Healer
- Destroy Persistent
- Enum Tracked Units
- Issue Order
- Iterate Inventory
- Iterate Magazine
- Iterate Transport
- Last Target
- Launch Missile
- Load Container
- Modify Player
- Modify Unit
- Random Point In Circle
- Redirect Missile
- Release Magazine
- Remove Behavior
- Remove Kinetic
- Remove Tracked Unit
- Return Magazine
- Search Area
- Transfer Behavior
- Use Calldown
- Use Magazine
- User Data
Common Fields[edit | edit source]
The following fields are ones found on most if not all effect types, and have the same functionality among them. This is to provide a common reference point for those shared fields as to not have conflicting definitions within each effect type
(None) - Can Be Blocked[edit | edit source]
Determines whether the effect can be blocked. By default, set to off.
- When an effect is executed, the game will query the response structure on the impact unit and check its Block Chance and any validators.
- If blocked, the effect will be canceled and won’t execute. The effect will then send an actor Effect event with Blocked as its sub name so that users can set appropriate actors.
- This feature is useful for creating spell blocking behaviors.
(None) - Caster History[edit | edit source]
(None) - Debug Trace[edit | edit source]
Used for testing in the editor
(None) - Owning Player[edit | edit source]
(None) - Preloard Validators[edit | edit source]
Effect - AI Notify Effect[edit | edit source]
Interpellates (awares) the AI that a follow up child effect of "this" effect should be evaluated upon its "AI Notify Flag" field.
- It goes without saying the "Response Flags" field is also connected.
Ex: The liberator Defender mode creates a Persistent in the circle, and uses this field by indicating the search effect that will occur in the child effects.
Effect - AI Notify Flags[edit | edit source]
These flags are used by the Tactical AI to determine how to assess and react to this effect vs others occuring around it. It is also used to generate the danger maps that are used by the AI for navigation purposes (in order to avoid AoE attacks like Nukes).
Ex: The Liberator Defender Mode search area effect (that applies a behavior on ememies to be potential target for the Concord cannon) was previously announced by a previous effect using the AI Notify Effect. Now, the flags here represents how the AI will behave.
- Help Friend: This effect helps the friend (of the casting unit)
- Hurt Enemy: This effect hurts the enemy (of the casting unit)
- Hurt Friend: This effect hurts the friends (of the casting unit)
- Major Danger: This effect will cause major damage
- Minor Danger: This effect will cause some damage
- Workers Only: (Unknown)
Effect - Alert[edit | edit source]
The Alert that is run when this effect is run.
Effect - Chance[edit | edit source]
This field controls the probability the effect will be executed. Values range from 0 (0%) to 1 (100%). Normally we always want the effect to be executed so by default every effect has this set to 1.
Effect - Kill Hallucination[edit | edit source]
- This flag, when enabled, will destroy any unit marked as a hallucination that is targeted by this effect (this will only work when the target is a unit, and not a point).
Effect - Response Flags[edit | edit source]
How a unit reacts to this effect being executed on it.
- Acquire: causes the targeted unit to acquire the casting unit if possible.
- Flee: causes the target unit to flee from the casting unit.
Effect - Tech Aliases[edit | edit source]
Gives an alias to the effect that it can be refered in requirements in bulk.
- Requirement are not customized to check effects, which makes this field plainly useless for the moment.
Effect - Validators[edit | edit source]
The set of validators that must return true for the effect to execute. Putting a list in this field is by default verified as logic "AND" (all must be true to pass).
- If an effect is prevented, so is the actor linked to that effect.
- To understand how they work between effect, always think that a validator comes first before the effect. In that sense, a validator always validates the result of the PREVIOUS effect. Then the effect runs. It does not validate the effect in which it's imputed. Ex: Using a search effect, you can use filters. Then, the next effect which is an Apply behavior, can have a behavior unit type that requires a Marine. This means that the search will end up passing the condition that it searched for a marine to continue with the apply behavior.
- Do not confuse with the Create Persistent effect that uses a "Periodic Validator". This one validates its own effect. (in fact it has both fields).
Target - Impact Location / Effect - Unit / Impact Unit / Which Location / Which Unit[edit | edit source]
This field has multiple names, field categories (new effects since latest patch are (None):) and all are the main field to designate the epicenter of where the effect will be generated at.
- Sets the effect that is used as the reference for targeting. Can be used to refer to units utilized further back in an effect tree. The best way to use this, is to keep in mind that "Launch Point" of the effect is the location of the target. For example, if setting "Target Unit" of a Search Effect as a referal in this case, it is not the result of the search that will be the "Target Unit", but rather, the target unit which preceded the effect. Sometimes, to change the focus of what is the target unit, one can use a "Create Persistent" effect to aim at a particular target. This is useful in some cases such as preceding Issue Orders effect that are badly configured when attempting to identify the target, the caster, etc (Random Point In Circle Effect has a bug that prevents it from launching an Issue Order from within the Caster has the "Unit", and while this is an unfortunate bug, this is a situation where you need to fix it).
- The target of the effect. Not to be mistaken with the target of the ability/behavior/effect that leads to the execution of this effect. All of these are relative to the Effect: Unit - Effect
- Target: The target of the ability or effect that caused this effect to be executed.
- Caster: The unit that started the chain of effects that included this effect.
- Source: The unit the current effect originates from, for example if a behavior is applied to some unit, and that behavior then uses another effect, the **Source** of the second effect will be the target unit of the behavior, and not the caster. Note that the behavior cannot use itself as a source ofr its own validation. Putting a validator "Source" in it will check who applied that behavior in the first place. Be advised that it is possible to bug out a source within a certain logic: example => if you add a behavior on a unit, and that behavior leads to a Create Persistent effect that periodically creates Launch Missile effect, with a Launch location based on source unit, the launch effect will fail (or fallback to the Caster unit) if the behavior is disabled or removed, if that launch effect is created periodically after the behavior was removed/disabled. Summary, a source unit is valid for as long as it exists, and that includes the behavior that designates it.
- Outer: The unit that is the containing unit for the target. This is used in conjunction with effects that target units inside a unit with a transport, inventory or magazine (Iterate Transport, Iterate Inventory or Iterate Magazine) or with Redirect Abilities which allow the caster to be inside the hangar of a Transport, Inventory or Arm Magazine ability. Does not trace the owning magazine unit from "External Magazine units", they really must be inside it.
- Unit Origin: The original unit which created this effect chain.
Target - Marker[edit | edit source]
Used by some effects and abilities to mark if the effect tree has already targeted that unit using the Unit Compare Marker Count validator, eg. the mutalisk glaive attack not being able to hit the same unit twice per use. Also can be used by Marker Target Sorts for target prioritisation.
- The game is very fussy as to what effect trees can apply markers so using a stacking Buff behaviour with a caster history is preferable in most situations.
- Testing shows that a marker is usually limited to 1 effect tree (1 weapon shot, 1 ability casting, etc. The second cast, weapon fire is considered as a different effect tree, so not the same marker). For example, Colossus attack has periodic damage, but that will only hit once because of it's "No Marker" state. Note that in some cases you need to indicate the Match Flags, in others not. For example, you can't put match flags on a Create Healer effect, because the effect is periodic on its own and will cancel over itself. Using the Match flags also indicates, that in the very same effect tree, the effect cannot occur again.
- An effect keep the marker for as long it is "channelling". However, a duration for a longer marker imput can used on this field. Otherwise, any effect that creates directly its purpose is considered as done and the marker is already gone.
- The number of markers added by this effect
- The ID string allowing several effects to share the same pool of markers (used by Marker type Target Sorts)
- Determines how markers are shared. Match means that if the effect in question has the validator "No Markers", this effect will match and be prevented.
- Casting Player: The marker is shared between all units of the same player
- Casting Unit: The marker is shared only by effects from the same unit
- Id: The marker is shared only by effects from the same effect tree
- Link: The marker is shared only by effects with the same link
- Determines how markers are not shared. Mismatch means that if the effect in question has the validator "No Markers", this effect will not be matched and will persue.
- Casting Player: The marker is not shared between all units of the same player
- Casting Unit: The marker is not shared by effects from the same unit
- Id: The marker is not shared by effects from the same effect tree
- Link: The marker is not shared by effects with the same link