View source for Mapbase/Entities/NPCs

This page lists {{mb|4.1}}'s changes to {{ent|CAI_BaseNPC}}, which every NPC derives from. This means every NPC in the game technically possesses these changes, although some changes might only be relevant to a specific group of them.

Some I/O were ported from other games or were already possible through other, more complicated means (e.g. keyvalues changed with AddOutput).

See [[Mapbase/Entities/NPCs/Custom Animations|Custom Animations]] for more information on Mapbase's new NPC animations.

{{toc}}

= I/O/KV =

{{important|I/O/KV which were added to both players and NPCs can be found in [[Mapbase/Entities/Base Combat Characters|Base Combat Character]].}}

== Inputs ==
{{I|SetHealthFraction|param=float|Sets a NPC's health as a ratio in between 0 and 1. This input already existed on {{ent|npc_helicopter}}, but it was expanded to be used on any NPC.}}
<hr>
{{I|GiveWeaponHolstered|param=string|Gives a NPC the specified weapon, but make it start holstered (meaning the NPC has to get it out on their own).}}
{{I|ChangeWeapon|param=string|Holsters a NPC's current weapon, and then unholsters the specified weapon.}}
{{I|PickupWeapon|param=target_destination|Makes a NPC look for and pick up the specified weapon, which should be an entity in the world.}}
{{I|PickupItem|param=target_destination|Makes a NPC look for and pick up the specified weapon, which should be an entity in the world.}}
<hr>
{{I|PickupItem|param=integer|Overrides how the game should treat friendly fire towards a specific NPC. 0 = No friendly fire, 1 = Friendly fire, 2 = Use NPC settings/no override}}
{{I|SetDynamicInteractions|param=integer|Sets a NPC's ability to use dynamic interactions. 0 = No interactions allowed, 1 = All interactions allowed, 2 = Non-Mapbase interactions only}}
<hr>
{{I|AddCapabilities|param=flags|Adds the specified {{code|Capability_t}} capabilities to a NPC.}}
{{I|RemoveCapabilities|param=flags|Removes the specified {{code|Capability_t}} capabilities from a NPC.}}
<hr>
{{I|SetCondition|param=string|Adds the specified condition to a NPC. Can be the name or integer ID of the condition.}}
{{I|RemoveCondition|param=string|Removes the specified condition from a NPC. Can be the name or integer ID of the condition.}}
<hr>
{{I|SetHintGroup|param=string|Sets a NPC's hint group.}}
<hr>
{{I|SetThinkNPC|param=float|Sets an entity's general think function to {{code|CallNPCThink}}. A float can be passed to delay this by a specific time.}}
<hr>
{{I|SetDistLook|param=float|Manually sets this NPC's sight distance. Pass '0' to reset.}}
{{I|SetDistTooFar|param=float|Manually sets the distance in which NPCs will consider a target too far to attack. Pass '0' to reset.}}
<hr>
{{I|SetSpeedModifier|param=float|Set a float value to multiply movement animation speed.}}

== Outputs ==
{{O|OnStateChange|param=integer|Fires whenever a NPC changes state, passing the NPC's new state.}}
<hr>
{{O|OnItemPickup|param=target_destination|Fires when a NPC picks up an item (e.g. a health vial), passing the item entity.}}
<hr>
{{O|OnHolsterWeapon|param=target_destination|Fires when a NPC holsters their current weapon, passing the weapon entity.}}
{{O|OnUnholsterWeapon|param=target_destination|Fires when a NPC unholsters their current weapon, passing the weapon entity.}}

== KeyValues ==
{{KV|Friendly fire override|intn=FriendlyFireOverride|choices|Overrides how the game should treat friendly fire towards a specific NPC. 0 = No friendly fire, 1 = Friendly fire, 2 = Use NPC settings/no override}}
{{KV|Dynamic interactions enabled|intn=SetDynamicInteractions|choices|Sets a NPC's ability to use dynamic interactions. 0 = No interactions allowed, 1 = All interactions allowed, 2 = Non-Mapbase interactions only}}
{{KV|Spawn with StartScripting|intn=SpawnWithStartScripting|choices|Spawns a NPC in the StartScripting state.}}
{{KV|Speed Modifier|intn=BaseSpeedModifier|float|Multiplies how far a NPC travels while moving. Does not affect the animation itself.}}

<br>

= Increased weapon portability =

Mapbase greatly expands the capabilities for NPCs using weapons in {{hl2|4}} through additional programming as well as new or restored NPC animations.

The following table shows which HL2 NPCs were capable of using various weapons in vanilla Source 2013:

{| class="standard-table"
! style="background-color: #303030; color: lightgray;" | Weapon
! style="background-color: #303030; color: lightgray;" | Male {{ent|npc_citizen}} and allies
! style="background-color: #303030; color: lightgray;" | Female {{ent|npc_citizen}} and allies
! style="background-color: #303030; color: lightgray;" | {{ent|npc_metropolice}}
! style="background-color: #303030; color: lightgray;" | {{ent|npc_combine_s}}
|-
| {{ent|weapon_pistol}}
| {{N/A|Partially}}
| {{N/A|Partially}}
| {{Yes}}
| {{No}}
|-
| {{ent|weapon_smg1}}
| {{Yes}}
| {{Yes}}
| {{Yes}}
| {{Yes}}
|-
| {{ent|weapon_ar2}}
| {{Yes}}
| {{Yes}}
| {{No}}
| {{Yes}}
|-
| {{ent|weapon_shotgun}}
| {{Yes}}
| {{Yes}}
| {{No}}
| {{Yes}}
|-
| {{ent|weapon_357}}
| {{No}}
| {{No}}
| {{No}}
| {{No}}
|-
| {{ent|weapon_crossbow}}
| {{No}}
| {{No}}
| {{No}}
| {{No}}
|-
| {{ent|weapon_rpg}}
| {{Yes}}
| {{Yes}}
| {{No}}
| {{No}}
|-
| {{ent|weapon_crowbar}}
| {{N/A|Partially}}
| {{N/A|Partially}}
| {{Yes}}
| {{No}}
|-
| {{ent|weapon_stunstick}}
| {{N/A|Partially}}
| {{N/A|Partially}}
| {{Yes}}
| {{No}}
|-
| {{ent|weapon_citizenpackage}}
| {{Yes}}
| {{Yes}}
| {{No}}
| {{No}}
|-
| {{ent|weapon_citizensuitcase}}
| {{Yes}}
| {{No}}
| {{No}}
| {{No}}
|}

By contrast, this table shows which HL2 NPCs are capable of using those weapons in Mapbase:

{| class="standard-table"
! style="background-color: #303030; color: lightgray;" | Weapon
! style="background-color: #303030; color: lightgray;" | Male {{ent|npc_citizen}} and allies
! style="background-color: #303030; color: lightgray;" | Female {{ent|npc_citizen}} and allies
! style="background-color: #303030; color: lightgray;" | {{ent|npc_metropolice}}
! style="background-color: #303030; color: lightgray;" | {{ent|npc_combine_s}}
|-
| {{ent|weapon_pistol}}
| {{Yes}}
| {{Yes}}
| {{Yes}}
| {{Yes}}
|-
| {{ent|weapon_smg1}}
| {{Yes}}
| {{Yes}}
| {{Yes}}
| {{Yes}}
|-
| {{ent|weapon_ar2}}
| {{Yes}}
| {{Yes}}
| {{Yes}}
| {{Yes}}
|-
| {{ent|weapon_shotgun}}
| {{Yes}}
| {{Yes}}
| {{Yes}}
| {{Yes}}
|-
| {{ent|weapon_357}}
| {{Yes}}
| {{Yes}}
| {{Yes}}
| {{Yes}}
|-
| {{ent|weapon_crossbow}}
| {{Yes}}
| {{Yes}}
| {{Yes}}
| {{Yes}}
|-
| {{ent|weapon_rpg}}
| {{Yes}}
| {{Yes}}
| {{N/A|Partially}}
| {{N/A|Partially}}
|-
| {{ent|weapon_crowbar}}
| {{N/A|Partially}}
| {{N/A|Partially}}
| {{Yes}}
| {{Yes}}
|-
| {{ent|weapon_stunstick}}
| {{N/A|Partially}}
| {{N/A|Partially}}
| {{Yes}}
| {{Yes}}
|-
| {{ent|weapon_citizenpackage}}
| {{Yes}}
| {{Yes}}
| {{Yes}}
| {{Yes}}
|-
| {{ent|weapon_citizensuitcase}}
| {{Yes}}
| {{Yes}}
| {{Yes}}
| {{Yes}}
|}

Many of these weapons include completely new animations which are detailed in [[Mapbase/Entities/NPCs/Custom Animations|Custom Animations]].

=== Weapon alt-fire capabilities ===
In vanilla Source 2013, only {{ent|npc_combine_s}} is capable of using a weapon's secondary attack, and {{ent|weapon_ar2}} is the only weapon it can use the secondary attack with. Mapbase expands this capability to almost all human NPCs and also gives them the ability to use {{ent|weapon_smg1}}'s secondary attack.

= Remapped activities =
{{Main|Mapbase/Entities/NPCs/Custom Animations|Custom Animations}}

Mapbase changes the activities of many {{hl2|4}} NPCs to be more consistent with each other and the standards expected from the base activity definitions. See the article linked above for more information.