Entity.AddEffects

Revision as of 20:08, 12 February 2011 by JohnnyThunders (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Jump to: navigation, search

Function
Syntax	Entity:AddEffects( Enum effect )
Description:
Gives an entity the given engine-based effect(s).
Returns:	nil
In Object:	Entity
Realm:
BBCode Link:	[b][url=http://wiki.garrysmod.com/?title=Entity.AddEffects]Entity.AddEffects [img]http://wiki.garrysmod.com/favicon.ico[/img][/url][/b]

Examples

Description	Adds a blinking effect to an entity.
Used on
Code	Entity:AddEffects( EF_ITEM_BLINK );
Output	N/A

Description	Adds a blinking effect and a bright light effect.
Used on
Code	Entity:AddEffects( EF_ITEM_BLINK \| EF_BRIGHTLIGHT );
Output	N/A

Description	Makes a human ragdoll act like the zombie NPC
Used on
Code	if SERVER then local npc = ents.Create("npc_zombie") npc:SetPos(vector_origin) npc:Spawn() else local zombie = ents.FindByClass("npc_zombie")[1] zombie.mdl = ClientsideModel("models/Kleiner.mdl") zombie.mdl:SetParent(zombie) zombie.mdl:AddEffects(EF_BONEMERGE) zombie:SetColor(0, 0, 0, 0) end
Output	N/A

These effects are different from Scripted Effects. These effects specifically modify entities. For instance, applying the EF_BONEMERGE effect to an entity causes that entity's bones to merge (move to the same position/angles as) that entity's parent. The Bone Merge effect is used by the Source Engine on Weapons to make a player or NPC hold them correctly. This works because weapon world models contain an invisible right-hand bone that then merges with the right-hand bone of the Player/NPC holding the weapon.
Beware! Once these effects are added to an entity they are often permanent. You will have to remove the entity to get rid of them.