ENTITY:OnRemove
ENTITY:OnRemove()
Description
Called when the entity is about to be removed.
See also Entity:CallOnRemove, which can even be used on engine (non-Lua) entities.
Clientside behaviour remarks
This hook may be called at odd times (when entity has actually not yet been removed from the server). This happens during fullupdate with the ENTITY:Initialize function not being called even when the entity reappears. You can debug this behaviour by enabling cheats and running cl_fullupdate on the client.
GM:NotifyShouldTransmit can be used to circumvent this problem. ENTITY:Think can also be used to detect that the entity has reappeared. You may reinitialize any necessary data in these hooks.
Example
Create an explosion when the entity will be removed. To create an entity, you can read ents.Create.
function ENT:OnRemove()
local explosion = ents.Create( "env_explosion" ) -- The explosion entity
explosion:SetPos( self:GetPos() ) -- Put the position of the explosion at the position of the entity
explosion:Spawn() -- Spawn the explosion
explosion:SetKeyValue( "iMagnitude", "50" ) -- the magnitude of the explosion
explosion:Fire( "Explode", 0, 0 ) -- explode
end
Rust
Steamworks
Wiki Help