View source for Template:Effect

== Usage ==

=== In code ===

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

=== In scripting ===

The functions mentioned above are supported in [[VScript]] starting with {{Game link|Dota 2}}. They can also be found in {{Game link|Garry's Mod}}.

=== In a map ===

{{#if:{{{mapcfg|}}} | {{{mapcfg}}} |
To use this effect in a map, {{#if:{{{2|}}}|{{{2}}}}} turn off SmartEdit mode and add the following keyvalue pair to the entity: <code>effects {{{1}}}</code>.

{{note|If it is desired to use this with other [[effects enum|effects]], you should add the integer value of each effect to the value.}}

You can set the <code>effects</code> keyvalue during runtime using {{ent|AddOutput}} with the input value <code>effects x</code> (x being any summation of effects flags to enable).

{{warning|Using <code>AddOutput</code> to change an entity's effects may interfere with an entity's simulation functionality.}}
}}