Extensions Npc

scripts/vscripts/alyxlib/extensions/npc.lua

Methods

StartSchedule

Create and start a new schedule for this NPC.

CAI_BaseNPC:StartSchedule(state, type, interruptability, reacquire, goal)

Parameters

• state
ScheduleState
  The NPC state that should be set.
• type
ScheduleType
  The type of schedule to perform.
• interruptability
ScheduleInterruptability
  What should interrupt the NPC from the schedule.
• reacquire
boolean
  If the NPC should reacquire the schedule after being interrupted.
• goal
EntityHandle, Vector
  Worldspace position or entity goal (entity origin will be used).

Returns - EntityHandle The schedule entity.

StopSchedule

Stops the given schedule for this NPC.

CAI_BaseNPC:StopSchedule(schedule, dontKill)

Parameters

• schedule
EntityHandle
  The previously created schedule.
• dontKill (optional)
  boolean
  If true the schedule will not be killed at the same time.

SetState

Set state of the NPC.

CAI_BaseNPC:SetState(state)

Parameters

• state
ScheduleState

HasEnemyTarget

Get if this NPC has an enemy target.

This function only works with entities that have enemy or distancetoenemy criteria.

CAI_BaseNPC:HasEnemyTarget()

Returns - boolean True if the NPC has an enemy target.

EstimateEnemyTarget

Estimate the enemy that this NPC is fighting using its criteria values.

This function only works with entities that have enemy criteria; "npc_combine_s", "npc_zombine", "npc_zombie_blind".

CAI_BaseNPC:EstimateEnemyTarget(distanceTolerance)

Parameters

• distanceTolerance (optional)
  number
  Discrepancy allowed when comparing distance to enemy. Default 1

Returns - EntityHandle? Estimated enemy target.

SetRelationship

Set the relationship of this NPC with a targetname or classname.

CAI_BaseNPC:SetRelationship(target, disposition, priority)

Parameters

• target
string, EntityHandle
  Targetname, classname or entity.
• disposition
RelationshipDisposition
  Type of relationship with target.
• priority (optional)
  number
  How much the Subject(s) should Like/Hate/Fear the Target(s). Higher priority = stronger feeling. Default is 0.

IsCreature

Get if this NPC is a creature, e.g. combine, headcrab, player

Will return false for all other class types, such as npc_turret and npc_manhack.

CAI_BaseNPC:IsCreature()

Returns - boolean

IsCombine

Get if this NPC is a combine creature.

CAI_BaseNPC:IsCombine()

Returns - boolean

IsXen

Get if this NPC is a Xen creature.

CAI_BaseNPC:IsXen()

Returns - boolean

GetSquadMembers

Get all members of the same squad as this NPC, including this NPC.

CAI_BaseNPC:GetSquadMembers()

Returns - CAI_BaseNPC[]

Aliases

RelationshipDisposition

Value	Description
"D_HT"	Hate
"D_FR"	Fear
"D_LI"	Like
"D_NU"	Neutral