Template:I BaseNPC/doc

This is a documentation subpage for Template:I BaseNPC.
Don't forget to purge the contents of the base page upon creating or editing this subpage.  

Purge base's cache

Usage

Has a parameter {{{branch}}} that can be set to base, l4d, as, or portal2 to exclude certain inputs.

There's also a parameter {{{noscroll}}} to stop it from being a scrollbox. {{I BaseNPC|noscroll=1}} yields as many inputs as possible, in a non-scrolling box:

BaseNPC inputs

CAI_BaseNPC: ActivateSpeedModifier  !FGD DisableSpeedModifier  !FGD Break Smash into pieces. If this is not possible, disappear. BecomeRagdoll  (in all games since ) Remove itself and instantly become a ragdoll with zero force (just go limp). OnDeath, etc. outputs will NOT be fired. ForceInteractionWithNPC <string> <string>  (in all games since ) Force the NPC to use a dynamic interaction with another NPC. Syntax is <targetname> <dynamic interaction>. ForgetEntity <targetname> Clears out the NPC's knowledge of a named entity. UpdateEnemyMemory  (in all games since ) Update (or create) this NPC's memory of of the given entity. GagEnable GagDisable Gagged NPCs won't speak (or moan, caw, etc.) unless made to be a choreographed scene. HolsterWeapon  (in all games since ) UnholsterWeapon  (in all games since ) Force the NPC to holster or unholster their weapon. Ignored if the NPC is scripting or if the NPC doesn't use weapons. HolsterAndDestroyWeapon  (in all games since ) Same as HolsterWeapon, except the weapon is destroyed once it has been concealed. IgnoreDangerSounds <float> Ignore danger sounds for the specified number of seconds. InsideTransition  !FGD OutsideTransition  !FGD SetBodyGroup <integer> HACK: Sets this NPC's body group (from 0–n). SetEnemyFilter <string> SetHealth <integer> Set the NPC's health. SetMaxLookDistance <float> (only in ) Sets the maximum look distance for the NPC. Defaults are 2048 and 6000 for long range NPCs. SetRelationship <string|targetname or classname> <string|disposition> <int|rank> Changes whether this NPC likes or dislikes certain others. Used like the ai_relationship entity, with this NPC as the subject. Values for disposition are: D_HT: Hate D_FR: Fear D_LI: Like D_NU: Neutral SetSquad <string> Change the name of this NPC's squad. Leaving the parameter blank will remove the NPC from any existing squad. StartScripting StopScripting Enter/exit scripting state, where NPCs ignore a variety of stimulus that would make them break out of their scripts. They ignore danger sounds, ignore +Use, don't idle speak or respond to other NPCs' idle speech, and so on. Wake Wakes up the NPC if it is sleeping. CBaseCombatCharacter: KilledNPC  !FGD Tells the entity it killed something. Despite the name, this can include a player. This input will be automatically sent by the victim when they die. physdamagescale <float> Scales damage energy when this character is hit by a physics object. With a value of 0 the NPC will take no damage from physics. DamageFilter: SetDamageFilter <string> Sets the entity to use as damage filter. Pass in an empty string (no parameter) to clear the damage filter.

{{I BaseNPC|branch=base}} hides as much as possible after Source 2013, as well as showing inputs specific games in that branch and earlier:

BaseNPC inputs

CAI_BaseNPC: ActivateSpeedModifier  !FGD DisableSpeedModifier  !FGD Break Smash into pieces. If this is not possible, disappear. BecomeRagdoll  (in all games since ) Remove itself and instantly become a ragdoll with zero force (just go limp). OnDeath, etc. outputs will NOT be fired. ForceInteractionWithNPC <string> <string>  (in all games since ) Force the NPC to use a dynamic interaction with another NPC. Syntax is <targetname> <dynamic interaction>. ForgetEntity <targetname> Clears out the NPC's knowledge of a named entity. UpdateEnemyMemory  (in all games since ) Update (or create) this NPC's memory of of the given entity. GagEnable GagDisable Gagged NPCs won't speak (or moan, caw, etc.) unless made to be a choreographed scene. HolsterWeapon  (in all games since ) UnholsterWeapon  (in all games since ) Force the NPC to holster or unholster their weapon. Ignored if the NPC is scripting or if the NPC doesn't use weapons. HolsterAndDestroyWeapon  (in all games since ) Same as HolsterWeapon, except the weapon is destroyed once it has been concealed. IgnoreDangerSounds <float> Ignore danger sounds for the specified number of seconds. InsideTransition  !FGD OutsideTransition  !FGD SetBodyGroup <integer> HACK: Sets this NPC's body group (from 0–n). SetEnemyFilter <string> SetHealth <integer> Set the NPC's health. SetMaxLookDistance <float> (only in ) Sets the maximum look distance for the NPC. Defaults are 2048 and 6000 for long range NPCs. SetRelationship <string|targetname or classname> <string|disposition> <int|rank> Changes whether this NPC likes or dislikes certain others. Used like the ai_relationship entity, with this NPC as the subject. Values for disposition are: D_HT: Hate D_FR: Fear D_LI: Like D_NU: Neutral SetSquad <string> Change the name of this NPC's squad. Leaving the parameter blank will remove the NPC from any existing squad. StartScripting StopScripting Enter/exit scripting state, where NPCs ignore a variety of stimulus that would make them break out of their scripts. They ignore danger sounds, ignore +Use, don't idle speak or respond to other NPCs' idle speech, and so on. Wake Wakes up the NPC if it is sleeping. CBaseCombatCharacter: KilledNPC  !FGD Tells the entity it killed something. Despite the name, this can include a player. This input will be automatically sent by the victim when they die. physdamagescale <float> Scales damage energy when this character is hit by a physics object. With a value of 0 the NPC will take no damage from physics. DamageFilter: SetDamageFilter <string> Sets the entity to use as damage filter. Pass in an empty string (no parameter) to clear the damage filter.

{{I BaseNPC|branch=l4d}} hides some inputs removed by Left 4 Dead and shows the Left 4 Dead 2 version of {{I BaseEntity}}:

BaseNPC inputs

CAI_BaseNPC: ActivateSpeedModifier  !FGD DisableSpeedModifier  !FGD Break Smash into pieces. If this is not possible, disappear. BecomeRagdoll  (in all games since ) Remove itself and instantly become a ragdoll with zero force (just go limp). OnDeath, etc. outputs will NOT be fired. ForceInteractionWithNPC <string> <string>  (in all games since ) Force the NPC to use a dynamic interaction with another NPC. Syntax is <targetname> <dynamic interaction>. ForgetEntity <targetname> Clears out the NPC's knowledge of a named entity. UpdateEnemyMemory  (in all games since ) Update (or create) this NPC's memory of of the given entity. GagEnable GagDisable Gagged NPCs won't speak (or moan, caw, etc.) unless made to be a choreographed scene. HolsterWeapon  (in all games since ) UnholsterWeapon  (in all games since ) Force the NPC to holster or unholster their weapon. Ignored if the NPC is scripting or if the NPC doesn't use weapons. HolsterAndDestroyWeapon  (in all games since ) Same as HolsterWeapon, except the weapon is destroyed once it has been concealed. IgnoreDangerSounds <float> Ignore danger sounds for the specified number of seconds. InsideTransition  !FGD OutsideTransition  !FGD SetBodyGroup <integer> HACK: Sets this NPC's body group (from 0–n). SetEnemyFilter <string> SetHealth <integer> Set the NPC's health. SetRelationship <string|targetname or classname> <string|disposition> <int|rank> Changes whether this NPC likes or dislikes certain others. Used like the ai_relationship entity, with this NPC as the subject. Values for disposition are: D_HT: Hate D_FR: Fear D_LI: Like D_NU: Neutral SetSquad <string> Change the name of this NPC's squad. Leaving the parameter blank will remove the NPC from any existing squad. StartScripting StopScripting Enter/exit scripting state, where NPCs ignore a variety of stimulus that would make them break out of their scripts. They ignore danger sounds, ignore +Use, don't idle speak or respond to other NPCs' idle speech, and so on. Wake Wakes up the NPC if it is sleeping. CBaseCombatCharacter: KilledNPC  !FGD Tells the entity it killed something. Despite the name, this can include a player. This input will be automatically sent by the victim when they die. physdamagescale <float> Scales damage energy when this character is hit by a physics object. With a value of 0 the NPC will take no damage from physics. DamageFilter: SetDamageFilter <string> Sets the entity to use as damage filter. Pass in an empty string (no parameter) to clear the damage filter.

{{I BaseNPC|branch=as}} hides some inputs removed by Left 4 Dead 2 and shows the Alien Swarm version of {{I BaseEntity}}:

BaseNPC inputs

CAI_BaseNPC: ActivateSpeedModifier  !FGD DisableSpeedModifier  !FGD Break Smash into pieces. If this is not possible, disappear. BecomeRagdoll  (in all games since ) Remove itself and instantly become a ragdoll with zero force (just go limp). OnDeath, etc. outputs will NOT be fired. ForceInteractionWithNPC <string> <string>  (in all games since ) Force the NPC to use a dynamic interaction with another NPC. Syntax is <targetname> <dynamic interaction>. ForgetEntity <targetname> Clears out the NPC's knowledge of a named entity. UpdateEnemyMemory  (in all games since ) Update (or create) this NPC's memory of of the given entity. GagEnable GagDisable Gagged NPCs won't speak (or moan, caw, etc.) unless made to be a choreographed scene. HolsterWeapon  (in all games since ) UnholsterWeapon  (in all games since ) Force the NPC to holster or unholster their weapon. Ignored if the NPC is scripting or if the NPC doesn't use weapons. HolsterAndDestroyWeapon  (in all games since ) Same as HolsterWeapon, except the weapon is destroyed once it has been concealed. IgnoreDangerSounds <float> Ignore danger sounds for the specified number of seconds. InsideTransition  !FGD OutsideTransition  !FGD SetBodyGroup <integer> HACK: Sets this NPC's body group (from 0–n). SetEnemyFilter <string> SetHealth <integer> Set the NPC's health. SetRelationship <string|targetname or classname> <string|disposition> <int|rank> Changes whether this NPC likes or dislikes certain others. Used like the ai_relationship entity, with this NPC as the subject. Values for disposition are: D_HT: Hate D_FR: Fear D_LI: Like D_NU: Neutral SetSquad <string> Change the name of this NPC's squad. Leaving the parameter blank will remove the NPC from any existing squad. StartScripting StopScripting Enter/exit scripting state, where NPCs ignore a variety of stimulus that would make them break out of their scripts. They ignore danger sounds, ignore +Use, don't idle speak or respond to other NPCs' idle speech, and so on. Wake Wakes up the NPC if it is sleeping. CBaseCombatCharacter: KilledNPC  !FGD Tells the entity it killed something. Despite the name, this can include a player. This input will be automatically sent by the victim when they die. physdamagescale <float> Scales damage energy when this character is hit by a physics object. With a value of 0 the NPC will take no damage from physics. DamageFilter: SetDamageFilter <string> Sets the entity to use as damage filter. Pass in an empty string (no parameter) to clear the damage filter.

{{I BaseNPC|branch=portal2}} shows {{I Reflection}} and the full version of {{I Shadow}}:

BaseNPC inputs

CAI_BaseNPC: ActivateSpeedModifier  !FGD DisableSpeedModifier  !FGD Break Smash into pieces. If this is not possible, disappear. BecomeRagdoll  (in all games since ) Remove itself and instantly become a ragdoll with zero force (just go limp). OnDeath, etc. outputs will NOT be fired. ForceInteractionWithNPC <string> <string>  (in all games since ) Force the NPC to use a dynamic interaction with another NPC. Syntax is <targetname> <dynamic interaction>. ForgetEntity <targetname> Clears out the NPC's knowledge of a named entity. UpdateEnemyMemory  (in all games since ) Update (or create) this NPC's memory of of the given entity. GagEnable GagDisable Gagged NPCs won't speak (or moan, caw, etc.) unless made to be a choreographed scene. HolsterWeapon  (in all games since ) UnholsterWeapon  (in all games since ) Force the NPC to holster or unholster their weapon. Ignored if the NPC is scripting or if the NPC doesn't use weapons. HolsterAndDestroyWeapon  (in all games since ) Same as HolsterWeapon, except the weapon is destroyed once it has been concealed. IgnoreDangerSounds <float> Ignore danger sounds for the specified number of seconds. InsideTransition  !FGD OutsideTransition  !FGD SetBodyGroup <integer> HACK: Sets this NPC's body group (from 0–n). SetEnemyFilter <string> SetHealth <integer> Set the NPC's health. SetRelationship <string|targetname or classname> <string|disposition> <int|rank> Changes whether this NPC likes or dislikes certain others. Used like the ai_relationship entity, with this NPC as the subject. Values for disposition are: D_HT: Hate D_FR: Fear D_LI: Like D_NU: Neutral SetSquad <string> Change the name of this NPC's squad. Leaving the parameter blank will remove the NPC from any existing squad. StartScripting StopScripting Enter/exit scripting state, where NPCs ignore a variety of stimulus that would make them break out of their scripts. They ignore danger sounds, ignore +Use, don't idle speak or respond to other NPCs' idle speech, and so on. Wake Wakes up the NPC if it is sleeping. CBaseCombatCharacter: KilledNPC  !FGD Tells the entity it killed something. Despite the name, this can include a player. This input will be automatically sent by the victim when they die. physdamagescale <float> Scales damage energy when this character is hit by a physics object. With a value of 0 the NPC will take no damage from physics. DamageFilter: SetDamageFilter <string> Sets the entity to use as damage filter. Pass in an empty string (no parameter) to clear the damage filter.

See also

• {{I BaseEntity}}
• {{KV BaseNPC}}