This is a list of all methods only available for NPCs. It is also possible to call Entity functions on NPCs.
NPC:AddEntityRelationship( Entity target, number disposition, number priority = 0 )
Makes the NPC like, hate, feel neutral towards, or fear the entity in question. If you want to setup relationship towards a certain entity class, use NPC:AddRelationship. NPCs do not see NextBots by default. This can be fixed by adding the FL_OBJECT flag to the NextBot.
NPC:AddRelationship( string relationstring )
Changes how an NPC feels towards another NPC. If you want to setup relationship towards a certain entity, use NPC:AddEntityRelationship. Avoid using this in GM:OnEntityCreated to prevent crashing due to infinite loops. This function may create an entity with given class and delete it immediately after.
Force an NPC to play their Alert sound.
boolean NPC:AutoMovement( number interval, Entity target = NULL )
Executes any movement the current sequence may have.
Removes all of Capabilities the NPC has.
Resets the NPC:GetBlockingEntity.
NPC:ClearEnemyMemory( Entity enemy = GetEnemy() )
Clears the Enemy from the NPC's memory, effectively forgetting it until met again with either the NPC vision or with NPC:UpdateEnemyMemory.
Clears the NPC's current expression which can be set with NPC:SetExpression.
Clears the current NPC goal or target.
Stops the current schedule that the NPC is doing.
NPC:DropWeapon( Weapon weapon = nil, Vector target = nil, Vector velocity = nil )
Forces the NPC to drop the specified weapon.
Makes an NPC exit a scripted sequence, if one is playing.
Force an NPC to play its Fear sound.
Force an NPC to play its FoundEnemy sound.
table NPC:GetBestSoundHint( number types )
Returns the most dangerous/closest sound hint based on the NPCs location and the types of sounds it can sense.
Returns how proficient (skilled) an NPC is with its current weapon.
Gets the NPC's current waypoint position (where NPC is currently moving towards), if any is available.
Returns the entity that this NPC is trying to fight. This returns nil if the NPC has no enemy. You should use IsValid (which accounts for nil and NULL) on the return to verify validity of the enemy.Issue Tracker: 3132
number NPC:GetEnemyFirstTimeSeen( Entity enemy = GetEnemy() )
Returns the first time an NPC's enemy was seen by the NPC.
Vector NPC:GetEnemyLastKnownPos( Entity enemy = GetEnemy() )
Returns the last known position of an NPC's enemy. Similar to NPC:GetEnemyLastSeenPos, but the known position will be a few seconds ahead of the last seen position.
Vector NPC:GetEnemyLastSeenPos( Entity enemy = GetEnemy() )
Returns the last seen position of an NPC's enemy. Similar to NPC:GetEnemyLastKnownPos, but the known position will be a few seconds ahead of the last seen position.
number NPC:GetEnemyLastTimeSeen( Entity enemy = GetEnemy() )
Returns the last time an NPC's enemy was seen by the NPC.
number NPC:GetLastTimeTookDamageFromEnemy( Entity enemy = nil )
Returns CurTime based time since this NPC last received damage from given enemy.
Returns NPCs max view distance. An NPC will not be able to see enemies outside of this distance.
number NPC:GetMinMoveStopDist( number minResult = 10 )
Returns how far before the NPC can come to a complete stop.
Gets the NPC's next waypoint position, where NPC will be moving after reaching current waypoint, if any is available.
Returns the amount of time it will take for the NPC to get to its Target Goal.
Returns the shooting position of the NPC. This only works properly when called on an NPC that can hold weapons, otherwise it will return the same value as Entity:GetPos.
Returns the NPC's current target set by NPC:SetTarget. This returns nil if the NPC has no target. You should use IsValid (which accounts for nil and NULL) on the return to verify validity of the target. Issue Tracker: 3132
number NPC:GetTimeEnemyLastReacquired( Entity enemy = nil )
Returns CurTime based time since the enemy was reacquired, meaning it is currently in Line of Sight of the NPC.
boolean NPC:HasEnemyEluded( Entity enemy = GetEnemy() )
Polls the enemy memory to check if the given entity has eluded us or not.
boolean NPC:HasEnemyMemory( Entity enemy = GetEnemy() )
Polls the enemy memory to check if the NPC has any memory of given enemy.
Returns true if the current navigation has a obstacle, this is different from NPC:GetBlockingEntity, this includes obstacles that it can steer around.
Force an NPC to play their Idle sound.
NPC:IgnoreEnemyUntil( Entity enemy, number until )
Makes the NPC ignore given entity/enemy until given time.
boolean NPC:IsCurrentSchedule( number schedule )
Returns whether or not the NPC is performing the given schedule.
Checks if the NPC is running an ai_goal. ( e.g. An npc_citizen NPC following the Player. )
boolean NPC:IsUnreachable( Entity testEntity )
Returns true if the entity was remembered as unreachable. The memory is updated automatically from following engine tasks if they failed: TASK_GET_CHASE_PATH_TO_ENEMY TASK_GET_PATH_TO_ENEMY_LKP TASK_GET_PATH_TO_INTERACTION_PARTNER TASK_ANTLIONGUARD_GET_CHASE_PATH_ENEMY_TOLERANCE SCHED_FAIL_ESTABLISH_LINE_OF_FIRE - Combine NPCs, also when failing to change their enemy
Force an NPC to play their LostEnemy sound.
Tries to achieve our ideal animation state, playing any transition sequences that we need to play to get there.
NPC:MarkEnemyAsEluded( Entity enemy = GetEnemy() )
Causes the NPC to temporarily forget the current enemy and switch on to a better one.
NPC:MarkTookDamageFromEnemy( Entity enemy = nil )
Marks the NPC as took damage from given entity. See also NPC:GetLastTimeTookDamageFromEnemy.
number NPC:MoveClimbExec( Vector destination, Vector dir, number distance, number yaw, number left )
Executes a climb move. Related functions are NPC:MoveClimbStart and NPC:MoveClimbStop.
NPC:MoveClimbStart( Vector destination, Vector dir, number distance, number yaw )
Starts a climb move. Related functions are NPC:MoveClimbExec and NPC:MoveClimbStop.
Stops a climb move. Related functions are NPC:MoveClimbExec and NPC:MoveClimbStart.
Executes a jump move. Related functions are NPC:MoveJumpStart and NPC:MoveJumpStop.
NPC:MoveJumpStart( Vector vel )
Starts a jump move. Related functions are NPC:MoveJumpExec and NPC:MoveJumpStop.
Stops a jump move. Related functions are NPC:MoveJumpExec and NPC:MoveJumpStart.
NPC:MoveOrder( Vector position )
Makes the NPC walk toward the given position. The NPC will return to the player after amount of time set by player_squad_autosummon_time ConVar. Only works on Citizens (npc_citizen) and is a part of the Half-Life 2 squad system. The NPC must be in the player's squad for this to work.
Pauses the NPC movement? Related functions are NPC:MoveStart, NPC:MoveStop and NPC:ResetMoveCalc.
Starts NPC movement? Related functions are NPC:MoveStop, NPC:MovePause and NPC:ResetMoveCalc.
Stops the NPC movement? Related functions are NPC:MoveStart, NPC:MovePause and NPC:ResetMoveCalc.
boolean NPC:NavSetGoal( Vector pos, number length, Vector dir )
Works similarly to NPC:NavSetRandomGoal.
boolean NPC:NavSetGoalPos( Vector pos )
Creates a path to closest node at given position. This won't actually force the NPC to move. See also NPC:NavSetRandomGoal.
boolean NPC:NavSetGoalTarget( Entity target, Vector offset = Vector( 0, 0, 0 ) )
Set the goal target for an NPC.
boolean NPC:NavSetRandomGoal( number minPathLength, Vector dir )
Creates a random path of specified minimum length between a closest start node and random node in the specified direction. This won't actually force the NPC to move.
boolean NPC:NavSetWanderGoal( number xOffset, number yOffset )
Sets a goal in x, y offsets for the NPC to wander to
boolean NPC:PickupWeapon( Weapon wep )
Forces the NPC to pickup an existing weapon entity. The NPC will not pick up the weapon if they already own a weapon of given type, or if the NPC could not normally have this weapon in their inventory.
number NPC:PlaySentence( string sentence, number delay, number volume )
Forces the NPC to play a sentence from scripts/sentences.txt
NPC:RememberUnreachable( Entity ent, number time = 3 )
Makes the NPC remember an entity or an enemy as unreachable, for a specified amount of time. Use NPC:IsUnreachable to check if an entity is still unreachable.
We advise against using this. It may be changed or removed in a future update. This function crashes the game no matter how it is used and will be removed in a future update. Use NPC:ClearEnemyMemory instead.
NPC:ResetIdealActivity( number act )
Resets the ideal activity of the NPC. See also NPC:SetIdealActivity.
Resets all the movement calculations. Related functions are NPC:MoveStart, NPC:MovePause and NPC:MoveStop.
NPC:RunEngineTask( number taskID, number taskData )
Starts an engine task. Used internally by the ai_task.
NPC:SelectWeapon( string class )
Forces the NPC to switch to a specific weapon the NPC owns. See NPC:GetWeapons.
Stops any sounds (speech) the NPC is currently palying. Equivalent to Entity:EmitSound( "AI_BaseNPC.SentenceStop" )
NPC:SetArrivalDistance( number dist )
Sets the distance to goal at which the NPC should stop moving and continue to other business such as doing the rest of their tasks in a schedule.
NPC:SetCurrentWeaponProficiency( number proficiency )
Sets the weapon proficiency of an NPC (how skilled an NPC is with its current weapon).
number NPC:SetExpression( string expression )
Sets the NPC's .vcd expression. Similar to Entity:PlayScene except the scene is looped until it's interrupted by default NPC behavior or NPC:ClearExpression.
Updates the NPC's hull and physics hull in order to match its model scale. Entity:SetModelScale seems to take care of this regardless.
NPC:SetIdealActivity( number )
Sets the ideal activity the NPC currently wants to achieve. This is most useful for custom SNPCs.
NPC:SetIdealYawAndUpdate( number angle, number speed = -1 )
Sets the ideal yaw angle (left-right rotation) for the NPC and forces them to turn to that angle.
NPC:SetLastPosition( Vector Position )
Sets the last registered or memorized position for an npc. When using scheduling, the NPC will focus on navigating to the last position via nodes. The navigation requires ground nodes to function properly, otherwise the NPC could only navigate in a small area. (https://developer.valvesoftware.com/wiki/Info_node)
NPC:SetMaxLookDistance( number dist )
Sets NPC's max view distance. An NPC will not be able to see enemies outside of this distance.
NPC:SetMovementSequence( number sequenceId )
Sets the sequence the NPC navigation path uses for speed calculation. Doesn't seem to have any visible effect on NPC movement.
NPC:SetMoveYawLocked( boolean lock )
Sets whether the current movement should locked on the Yaw axis or not.
NPC:SetSquad( string name )
Assigns the NPC to a new squad. A squad can have up to 16 NPCs. NPCs in a single squad should be friendly to each other.
NPC:StartEngineTask( number task, number taskData )
Forces the NPC to start an engine task, this has different results for every NPC.
Resets the NPC's movement animation and velocity. Does not actually stop the NPC from moving.
NPC:TargetOrder( Entity target )
Cancels NPC:MoveOrder basically. Only works on Citizens (npc_citizen) and is a part of the Half-Life 2 squad system. The NPC must be in the player's squad for this to work.
Marks the current NPC task as completed. This is meant to be used alongside NPC:TaskFail to complete or fail custom Lua defined tasks. (Schedule:AddTask)
NPC:TaskFail( string task )
Marks the current NPC task as failed. This is meant to be used alongside NPC:TaskComplete to complete or fail custom Lua defined tasks. (Schedule:AddTask)
NPC:UpdateEnemyMemory( Entity enemy, Vector pos )
Force the NPC to update information on the supplied enemy, as if it had line of sight to it.
Updates the turn activity. Basically applies the turn animations depending on the current turn yaw.
Undoes the other Use*Behavior functions. Only usable on "ai" base entities.