Template:Effect

From Valve Developer Community
Revision as of 22:50, 8 May 2020 by Blixibon (talk | contribs) (Overhauled article to cover more bases)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Usage

In code

Inside of the codebase, effects are defined as a bit-based enum and are stored in m_fEffects. This effect can be manipulated with AddEffects( Effect ), RemoveEffects( Effect ), and SetEffects( Effect ). This effect can be obtained with GetEffects() & Effect or IsEffectActive( Effect ).

In scripting

The functions mentioned above are supported in VScript starting with <Dota 2> Dota 2. They can also be found in <Garry's Mod> Garry's Mod.

In a map

To use this effect in a map, turn off SmartEdit mode and add the following keyvalue pair to the entity: effects {{{1}}}.

Note:If it is desired to use this with other effects, you should add the integer value of each effect to the value.

You can set the effects keyvalue during runtime using AddOutput with the input value effects x (x being any summation of effects flags to enable).

Warning: Using AddOutput to change an entity's effects may interfere with an entity's simulation functionality.