This article's documentation is for anything that uses the Source engine. Click here for more information.

EF_NODRAW

From Valve Developer Community
Jump to: navigation, search
Underlinked - Logo.png
This article needs more links to other articles to help integrate it into the encyclopedia. Please help improve this article by adding links that are relevant to the context within the existing text.
January 2024
English (en)
... Icon-Important.png

EF_NODRAW prevents any data about an entity from being transmitted to the client, without affecting it on the server. In other words, it makes the entity disappear from the player's view without deleting it.

It is defined as 0x020, or 32.

Note.pngNote:Since the client doesn't draw entities with this at all, collisions may be strange in multiplayer games.

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( EF NODRAW ), RemoveEffects( EF NODRAW ), and SetEffects( EF NODRAW ). This effect can be obtained with GetEffects() & EF NODRAW or IsEffectActive( EF NODRAW ).

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

Starting with Portal 2 Portal 2, this effect can be toggled via the Enable/DisableDraw inputs.

In earlier titles, you must turn off SmartEdit mode and add the following keyvalue pair to the entity: effects 32.

Note.pngNote: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.pngWarning:Using AddOutput to change an entity's effects may interfere with an entity's simulation functionality.