Template:I BaseNPC: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(It's probably not just the player.)
mNo edit summary
 
(46 intermediate revisions by 19 users not shown)
Line 1: Line 1:
{{i targetname}}
{{LanguageBar}}[[Category:Input_Templates|BaseNPC]]
 
<onlyinclude>{{expandBox|title=BaseNPC inputs|
* {{i renderfields}}
{{minititle|CAI_BaseNPC}}
 
{{I|ActivateSpeedModifier|nofgd=1}}
* {{i damagefilter}}
{{I|DisableSpeedModifier|nofgd=1}}
 
{{I|Break|Smash into pieces. If this is not possible, disappear.}}
* {{i responsecontext}}
{{I|BecomeRagdoll|Remove itself and instantly become a [[ragdoll]] with zero force (just go limp). OnDeath, etc. outputs will <strong>NOT</strong> be fired.|since={{ep2}}}}
 
{{I|ForceInteractionWithNPC  <[[string]]> <[[string]]>|Force the NPC to use a dynamic interaction with another NPC. Syntax is <tt><[[targetname]]> <dynamic interaction></tt>.|since={{ep1}}}}
* {{i shadow}}
{{I|ForgetEntity|Clears out the NPC's knowledge of a named entity.|param=targetname}}
 
{{I|UpdateEnemyMemory|Update (or create) this NPC's memory of of the given entity.|since={{ep1}}}}
* '''SetRelationship <string>'''
{{I|GagEnable}}
: Changes this entity's relationship with another entity or class.
{{I|GagDisable|Gagged NPCs won't speak (or moan, caw, etc.) unless made to be a choreographed scene.}}
: Format: <code><NPC name or classname> <new relationship> <priority></code>
{{I|HolsterWeapon|since={{ep1}}}}
: You can set <NPC name or classname> to <code>!player</code> to make this relation be against the player.
{{I|UnholsterWeapon|Force the NPC to holster or unholster their weapon. Ignored if the NPC is scripting or if the NPC doesn't use weapons.|since={{ep1}}}}
: New relationships:
{{I|HolsterAndDestroyWeapon|Same as <code>HolsterWeapon</code>, except the weapon is destroyed once it has been concealed.|since={{ep1}}}}
:<code>D_NU</code> - Nice (Will not attack. Rebels avoid excusingly, and can not be commanded.)
{{I|IgnoreDangerSounds|Ignore danger sounds for the specified number of seconds.|param=float}}
:<code>D_HT</code> - Hate (Considers the target NPC(s) an enemy/enemies and will attack.)
{{I|InsideTransition|nofgd=1}}
:<code>D_LI</code> - Ally (Will not attack. Rebels follow automatically, and can be commanded.)
{{I|OutsideTransition|nofgd=1}}
:<code>D_FR</code> - Afraid (Headcrabs runs away without attacking, metropolice attacks, rebels avoids without attacking.)
{{I|SetBodyGroup|HACK: Sets this NPC's body group (from 0–n).|param=int}}
: Priority
{{I|SetEnemyFilter|param=string}}
: {{todo|Write a description about what priorities are.}}
{{I|SetHealth|Set the NPC's health.|param=int}}{{#ifeq: base | {{{branch|base}}} |
 
{{I|SetMaxLookDistance|Sets the maximum look distance for the NPC. Defaults are 2048 and 6000 for long range NPCs.|param=float|only={{GMOD}}}} }}
* '''SetHealth <integer>'''
{{I|SetRelationship <[[string]]{{!}}[[targetname]] or [[classname]]> <[[string]]{{!}}disposition> <[[int]]{{!}}rank>|Changes whether this NPC likes or dislikes certain others. Used like the {{ent|ai_relationship}} entity, with this NPC as the subject.
: Set this NPC's health.
: Values for <code>disposition</code> are:
 
:* <code>D_HT</code>: Hate
* '''SetBodyGroup <integer>'''
:* <code>D_FR</code>: Fear
: HACK: Sets this NPC's body group (from 0 - n). You'd better know what you are doing!
:* <code>D_LI</code>: Like
 
:* <code>D_NU</code>: Neutral}}
* '''physdamagescale <float>'''
{{I|SetSquad|Change the name of this NPC's [[Squads|squad]]. Leaving the parameter blank will remove the NPC from any existing squad.|param=string}}
: Sets the value that scales damage energy when this character is hit by a physics object. NOTE: 0 means this feature is disabled for backwards compatibility.
{{I|StartScripting}}
 
{{I|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 {{ent|use|alt=+Use}}, don't idle speak or respond to other NPCs' idle speech, and so on.}}
* '''Ignite'''
{{I|Wake|Wakes up the NPC if it is sleeping.}}
: Ignite, burst into flames
{{I BaseCombatCharacter}}
 
{{I DamageFilter}} }}</onlyinclude>
* '''Break'''
: Break, smash into pieces
 
* '''StartScripting'''
: Enter scripting state. In this state, 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 NPC's idle speech, and so on.
 
* '''StopScripting'''
: Exit scripting state.
 
* '''Assault <target_destination>'''
: Start an assault. Parameter passed in should be the name of the rally point.
 
* '''SetSquad <string>'''
: Set the name of this NPC's squad. It will be removed from any existing squad automatically. Leaving the parameter blank will remove the NPC from any existing squad.
 
* '''Wake'''
: Wakes up the NPC if it is sleeping.
 
* '''ForgetEntity <target_destination>'''
: Clears out the NPC's knowledge of a named entity.
 
* '''GagEnable'''
: Turn on the NPC Gag flag. NPC won't speak outside of choreographed scenes.
 
* '''GagDisable'''
: Turn off the NPC Gag flag.
 
* '''IgnoreDangerSounds <float>'''
: Ignore danger sounds for the specified number of seconds.

Latest revision as of 10:37, 19 March 2025

Flag-white.pngEnglish (en)
BaseNPC inputs 

CAI_BaseNPC:

ActivateSpeedModifier  !FGD
DisableSpeedModifier  !FGD
Break
Smash into pieces. If this is not possible, disappear.
BecomeRagdoll  (in all games since Half-Life 2: Episode Two)
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 Half-Life 2: Episode One)
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 Half-Life 2: Episode One)
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 Half-Life 2: Episode One)
UnholsterWeapon  (in all games since Half-Life 2: Episode One)
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 Half-Life 2: Episode One)
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 Garry's Mod)
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.
Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Template:I_BaseNPC&oldid=467306"