Called when another entity fires an event to this entity.

A helper function for creating Scripted Entities. Similar to ENTITY:AddOutputFromKeyValue, call it from ENTITY:AcceptInput and it'll return true if it successfully added an output from the passed input data.

A helper function for creating Scripted Entities. Call it from ENTITY:KeyValue and it'll return true if it successfully added an output from the passed KV pair.

Called whenever the entity's position changes. A callback for when an entity's angle changes is available via Entity:AddCallback. Like ENTITY:RenderOverride, this hook works on any entity (scripted or not) it is applied on. If EFL_DIRTY_ABSTRANSFORM is set on the entity, this will be called serverside only; otherwise, this will be called clientside only. This means serverside calls of Entity:SetPos without the EFL_DIRTY_ABSTRANSFORM flag enabled (most cases) will be called clientside only. The give concommand will call this hook serverside only upon entity spawn.

Controls if a property can be used on this entity or not. This hook will only work in Sandbox derived gamemodes that do not have SANDBOX:CanProperty overridden. This hook will work on ALL entities, not just the scripted ones (SENTs)

Controls if a tool can be used on this entity or not. This hook will only work in Sandbox derived gamemodes that do not have SANDBOX:CanTool overridden. This hook will work on ALL entities, not just the scripted ones (SENTs)

This is used internally - although you're able to use it you probably shouldn't. Called just before ENTITY:Initialize for "ai" type entities only.

Called so the entity can override the bullet impact effects it makes. This is called when the entity itself fires bullets via Entity:FireBullets, not when it gets hit. This hook only works for the "anim" type entities. Despite the hook being shared, this hook will be triggered only on the realm which fires the bullet.

Called by the default base_ai SNPC, checking whether ENT. bDoingEngineSchedule is set by ENTITY:StartEngineSchedule. . This is a helper function only available if your SENT is based on base_ai

Runs a Lua schedule. Runs tasks inside the schedule.

Called if and when the entity should be drawn opaquely, based on the Entity:GetRenderGroup of the entity. See ENT structure and RENDERGROUP enum for more information. See also ENTITY:DrawTranslucent. This function is not called by the game whenever the player looks away from the entity due to optimizations. To change that, you must define an empty Entity:Think method client-side!

Called when the entity should be drawn translucently. If your scripted entity has a translucent model, it will be invisible unless it is drawn here.

Called when the entity stops touching another entity. This only works for brush entities and for entities that have Entity:SetTrigger set to true.

Called whenever an engine schedule is finished; either the last task within the engine schedule has been finished or the schedule has been interrupted by an interrupt condition. This hook only exists for ai type SENTs. This hook isn't called when the engine schedule is failed, the schedule is cleared with NPC:ClearSchedule or NPC:SetSchedule has been called.

Called when an NPC's expression has finished. This hook only exists for ai type SENTs.

Called before firing clientside animation events, such as muzzle flashes or shell ejections. See ENTITY:HandleAnimEvent for the serverside version. This hook only works on "anim", "nextbot" and "ai" type entities.

Called to determine how good an NPC is at using a particular weapon. "ai" base only

Called when scripted NPC needs to check how he "feels" against another entity, such as when NPC:Disposition is called.

Specify a mesh that should be rendered instead of this SENT's model.

Called when the shadow needs to be recomputed. Allows shadow angles to be customized. This only works for anim type entities.

Called every second to poll the sound hint interests of this SNPC. This is used in conjunction with other sound hint functions, such as sound. EmitHint and NPC:GetBestSoundHint. This hook only exists for ai type SENTs

Called by GM:GravGunPickupAllowed on ALL entites in Sandbox-derived gamemodes and acts as an override.

Called when this entity is about to be punted with the gravity gun (primary fire). Only works in Sandbox derived gamemodes and only if GM:GravGunPunt is not overridden.

Called before firing serverside animation events, such as weapon reload, drawing and holstering for NPCs, scripted sequences, etc. See ENTITY:FireAnimationEvent for the clientside version. This hook only works on "anim", "ai" and "nextbot" type entities.

Called when a bullet trace hits this entity and allows you to override the default behavior by returning true.

Called when the entity is created. This is called when you Entity:Spawn the custom entity. This is called after ENTITY:SetupDataTables and GM:OnEntityCreated.

Called when deciding if the Scripted NPC should be able to perform a certain jump or not. This is only called for "ai" type entities

Called when the engine sets a value for this scripted entity. This hook is called before ENTITY:Initialize when the key-values are set by the map. Otherwise this hook will be called whenever Entity:SetKeyValue is called on the entity. See GM:EntityKeyValue for a hook that works for all entities. See WEAPON:KeyValue for a hook that works for scripted weapons.

Start the next task in specific schedule. This hook only exists for ai type SENTs.

Called when the currently active weapon of the SNPC changes. This hook only works on ai type entities.

Called when the NPC has changed its activity. This hook only works for ai type entities.

Called each time the NPC updates its condition. This hook only exists for ai type SENTs.

Called on any entity after it has been created by the duplicator and before any bone/entity modifiers have been applied. This hook is called after ENTITY:Initialize and before ENTITY:PostEntityPaste.

Called after duplicator finishes saving the entity, allowing you to modify the save data. This is called after ENTITY:PostEntityCopy.

Called when the SNPC completes its movement to its destination. This hook only works on ai type entities.

Called when the SNPC failed to move to its destination. This hook only works on ai type entities.

Called when the entity is reloaded by the lua auto-refresh system, i. e. when the developer edits the lua file for the entity while the game is running.

Called when the entity is about to be removed. See also Entity:CallOnRemove, which can even be used on engine (non-Lua) entities. 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

Called when the entity is reloaded from a Source Engine save (not the Sandbox saves or dupes) or on a changelevel (for example Half-Life 2 campaign level transitions). For the duplicator callbacks, see ENTITY:OnDuplicated.

Called by the engine when NPC's state changes. This hook only exists for ai type SENTs.

Called when the entity is taking damage. Calling Entity:TakeDamage, Entity:TakeDamageInfo, Entity:DispatchTraceAttack, or Player:TraceHullAttack (if the entity is hit) in this hook on the victim entity can cause infinite loops since the hook will be called again. Make sure to setup recursion safeguards like the example below. This hook is only called for ai, nextbot and anim type entities.

Called from the engine when TaskComplete is called. This allows us to move onto the next task - even when TaskComplete was called from an engine side task. This hook only exists for ai type SENTs.

Called when a task this NPC was running has failed for whatever reason. This hook only exists for ai type SENTs.

Called to completely override NPC movement. This can be used for example for flying NPCs. This hook only exists for ai type SENTs.

Called to completely override the direction NPC will be facing during navigation. This hook only exists for ai type SENTs. This hook is called by the default movement hook. Returning true inside ENTITY:OverrideMove will prevent engine from calling this hook.

Polls whenever the entity should trigger the brush. This hook is broken and will not work without code below

Called when the entity collides with anything. The move type and solid type must be VPHYSICS for the hook to be called. If you want to use this hook on default/engine/non-Lua entites ( like prop_physics ), use Entity:AddCallback instead! This page describes a hook for Lua entities

Called from the Entity's motion controller to simulate physics. This will only be called after using Entity:StartMotionController on a scripted entity of anim type. This hook can work on the CLIENT if you call Entity:StartMotionController and use Entity:AddToMotionController on the physics objects you want to controlDo not use functions such as PhysObj:EnableCollisions or PhysObj:EnableGravity in this hook as they're very likely to crash your game. You may want to use ENTITY:PhysicsUpdate instead.

Called whenever the physics of the entity are updated. This hook won't be called if the Entity's PhysObj goes asleep

Called after the duplicator finished copying the entity. See also ENTITY:PreEntityCopy, ENTITY:PostEntityPaste and ENTITY:OnEntityCopyTableFinish.

Called after the duplicator pastes the entity, after the bone/entity modifiers have been applied to the entity. This hook is called after ENTITY:OnDuplicated. See also ENTITY:PreEntityCopy.

Called before the duplicator copies the entity. If you are looking for a way to make the duplicator spawn another entity when duplicated. (For example, you duplicate a prop_physics, but you want the duplicator to spawn prop_physics_my), you should add prop_physics. ClassOverride = "prop_physics_my". The duplication table should be also stored on that prop_physics, not on prop_physics_my. See also ENTITY:PostEntityCopy.

Called instead of the engine drawing function of the entity. This hook works on any entity (scripted or not) it is applied on. This does not work on "physgun_beam", use GM:DrawPhysgunBeam instead. As a downside of this implementation, only one RenderOverride may be applied at a time. Drawing a viewmodel in this function will cause GM:PreDrawViewModel, WEAPON:PreDrawViewModel, WEAPON:ViewModelDrawn, GM:PostDrawViewModel, and WEAPON:PostDrawViewModel to be called twice. Issue Tracker: 3292This is called before PrePlayerDraw for players. If this function exists at all on a player, their worldmodel will always be rendered regardless of PrePlayerDraw's return. Issue Tracker: 3299

Called from the engine every 0. 1 seconds. Returning true inside this hook will allow CAI_BaseNPC::MaintainSchedule to also be called. This hook only exists for ai type SENTs.

Called when an engine task is ran on the entity. This hook only exists for ai type SENTs.

Called every think on running task. The actual task function should tell us when the task is finished. This hook only exists for ai type SENTs.

Called whenever a Lua schedule is finished or ENTITY:StartEngineSchedule is called. Clears out schedule and task data stored within NPC's table. This is a helper function only available if your SENT is based on base_ai

Set the schedule we should be playing right now. Allows the NPC to start either a Lua schedule or an engine schedule. Despite sharing the same name as CAI_BaseNPC::SelectSchedule(), this isn't hooked to that function; this is called by Lua's ENTITY:RunAI, doesn't return an engine function, returning an engine function doesn't help and doesn't make the NPC start an engine schedule. To alter initial engine schedule, it is recommended to use ENTITY:TranslateSchedule. This is a helper function only available if your SENT is based on base_ai

Toggles automatic frame advancing for animated sequences on an entity. This has the same effect as setting the ENT. AutomaticFrameAdvance property. (See ENT structure)

Sets the current task. This hook only exists for ai type SENTs.

Called when the entity should set up its Data Tables. This is a much better option than using Set/Get Networked Values. This hook is called after GM:OnEntityCreated and GM:NetworkEntityCreated.

This is the spawn function. It's called when a player spawns the entity from the spawnmenu. If you want to make your SENT spawnable you need this function to properly create the entity. Unlike other ENTITY functions, the "self" parameter of this function is not an entity but rather the table used to generate the SENT. This table is equivalent to scripted_ents. GetStored("ent_name").

Called by the engine only whenever NPC:SetSchedule is called. This hook only exists for ai type SENTs.

Called when an engine task has been started on the entity. This hook only exists for ai type SENTs.

Starts a schedule previously created by ai_schedule. New. Not to be confused with ENTITY:StartEngineSchedule or NPC:SetSchedule which start an Engine-based schedule. This hook only exists for ai type SENTs.

Called once on starting task. This hook only exists for ai type SENTs.

Called when the entity starts touching another entity. This only works for brush entities and for entities that have Entity:SetTrigger set to true.

Used to store an output so it can be triggered with ENTITY:TriggerOutput. Outputs compiled into a map are passed to entities as key/value pairs through ENTITY:KeyValue. TriggerOutput will do nothing if this function has not been called first.

Returns true if the current running Task is finished. Tasks finish whenever NPC:TaskComplete is called, which sets TASKSTATUS_COMPLETE for all NPCs, also sets self. bTaskComplete for ai type SENTs. This hook only exists for ai type SENTs.

Returns how many seconds we've been doing this current task This hook only exists for ai type SENTs.

Allows you to override trace result when a trace hits the entity. Your entity must have Entity:EnableCustomCollisions enabled for this hook to work. Your entity must also be otherwise "hit-able" with a trace, so it should have SOLID_OBB or SOLID_VPHYSICS be set (as an example), and it must have its collision bounds be set accordingly. This hook is called for anim type only.

Called every frame on the client. Called about 5-6 times per second on the server. You may need to call Entity:Spawn to get this hook to run server side. You can force it to run at servers tickrate using the example below.

Called every tick for every entity being "touched". See also ENTITY:StartTouch and ENTITY:EndTouch. For physics enabled entities, this hook will not be ran while the entity's physics is asleep. See PhysObj:Wake.

Called by the engine to alter NPC activities, if desired by the NPC. This hook only exists for ai type SENTs.

Called by the engine to alter NPC's final position to reach its enemy or target. This hook only exists for ai type SENTs.

Called by the engine to alter NPC schedules, if desired by the NPC. This hook only exists for ai type SENTs.

Triggers all outputs stored using ENTITY:StoreOutput.

Called whenever the transmit state should be updated.

Called when an entity "uses" this entity, for example a player pressing their +use key (default e) on this entity. To change how often the hook is called, see Entity:SetUseType. This hook only works for nextbot, ai and anim scripted entity types.

Gets the NPC classification. Internally gets the m_iClass variable which is polled by the engine. This will be equivalent to NPC:Classify. This is a helper function only available if your SENT is based on base_ai

Sets the NPC max yaw speed. Internally sets the m_fMaxYawSpeed variable which is polled by the engine. This is a helper function only available if your SENT is based on base_ai

Sets the NPC classification. Internally sets the m_iClass variable which is polled by the engine. This is a helper function only available if your SENT is based on base_ai