Entity.CallOnRemove
From GMod Wiki
| Function | |
| Syntax | Entity:CallOnRemove( String name, Function removeFunc, Var argument, ... ) |
| Description: | |
| Whenever the entity is removed by any means, this function will be called. | |
| Returns: | nil |
| In Object: | Entity |
| Realm: |
 |
| BBCode Link: | [b][url=http://wiki.garrysmod.com/?title=Entity.CallOnRemove]Entity.CallOnRemove [img]http://wiki.garrysmod.com/favicon.ico[/img][/url][/b] |
Examples
| Description | Each time a prop is removed it screams. |
|---|---|
| Used on |  |
| Code | local function OhNo(prop,n) -- The first argument is the entity, the rest is the arguments local sound if n <10 then sound = "vo/npc/male01/pain0"..n..".wav" else n = n-9 sound = "vo/npc/male01/ow0"..n..".wav" end prop:EmitSound(sound,100,170) -- Emitting the sound with a high pitch because it's funnier! end local LastSound hook.Add("OnEntityCreated","ScreamingProps", function( prop ) if ( prop:GetClass() == "prop_physics" ) then --If it's a prop then... local n n = math.random(1,11) while n == LastSound do n = math.random(1,11) --Select a random sound end LastSound = n prop:CallOnRemove("ScreamingProps",OhNo,n) --Call the OhNo function with the sound as an argument when removed end end) |
| Output | Ow! |
Additional Notes
- Name is a unique label to stop the same function from being added several times.
- removeFunc needs to be the name of a function. This function will be run with the given arguments whenever the entity is removed.
- The arguments of removeFunc will be the entity, then the supplied arguments. For example, if you wrote Entity:CallOnRemove("x",Msg,"Hello\n"), then whenever the entity is removed it would do Msg(Entity,"Hello\n")
- This function can take any number of arguments.
- Returning false in this function doesn't do anything.
