Template:I BaseNPC: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(The BecomeRagdoll input DOES remove the original entity.)
(Forwards compatability(via Template:IO) and minor changes.)
Line 1: Line 1:
{{ScrollBox|title=BaseNPC|
{{ScrollBox|title=BaseNPC|
; <code>SetRelationship <[[string]]&#124;[[targetname]] or [[classname]]> <string&#124;disposition> <[[int]]&#124;rank></code>
{{IO|SetRelationship <[[string]]&#124;[[targetname]] or [[classname]]> <[[string]]&#124;disposition> <[[int]]&#124;rank>|Changes whether this NPC likes or dislikes certain others. Used like the [[ai_relationship]] entity, with this NPC as the subject.
: Changes whether this NPC likes or dislikes certain others. Used like the [[ai_relationship]] entity, with this NPC as the subject.
: Values for <code>disposition</code> are:
: Values for <code>disposition</code> are:
:* <code>D_HT</code>: Hate
:* <code>D_HT</code>: Hate
:* <code>D_FR</code>: Fear
:* <code>D_FR</code>: Fear
:* <code>D_LI</code>: Like
:* <code>D_LI</code>: Like
:* <code>D_NU</code>: Neutral
:* <code>D_NU</code>: Neutral}}
; <code>SetHealth <[[int]]></code>
{{IO|SetHealth <[[int]]>|Set the NPC's health.}}
: Set the NPC's health.
; {{EP2 add|<code>AddHealth <[[int]]></code>}}
; {{EP2 add|<code>AddHealth <[[int]]></code>}}
; {{EP2 add|<code>RemoveHealth <[[int]]></code>}}
; {{EP2 add|<code>RemoveHealth <[[int]]></code>}}
: Add to or remove from the NPC's health.
: Add to or remove from the NPC's health.
; <code>SetBodyGroup <[[int]]></code>
{{IO|SetBodyGroup|HACK: Sets this NPC's body group (from 0 - n).|param=int}}
: Sets this NPC's body group (from 0 - n).
{{IO|physdamagescale |Scales the damage taken when this character is hit by a physics object. 0 means this feature is disabled for backwards compatibility.|param=float}}
; <code>physdamagescale <[[float]]></code>
{{IO|Ignite|Burst into flames.}}
: Scales the damage taken when this character is hit by a physics object. 0 means this feature is disabled for backwards compatibility.
{{IO|IgniteLifetime|Ignite for the given number of seconds.|param=float}}
; <code>Ignite</code>
{{IO|IgniteNumHitboxFires|Ignite with the given number of [[hitbox]] fires.|param=int}}
: Burst into flames.
{{IO|IgniteHitboxFireScale|Ignite with the given hitbox fire scale.|param=float}}
; <code>IgniteLifetime <[[float]]></code>
{{IO|Break|Smash into pieces. If this is not possible, disappear.}}
: Ignite for the given number of seconds.
{{IO|{{EP2 add|BecomeRagdoll}}|Remove itself and instantly become a [[ragdoll]] with zero force (just go limp). OnDeath, etc. Outputs will <strong>NOT</strong> be fired.}}
; <code>IgniteNumHitboxFires <[[int]]></code>
;<code> StartScripting</code>
: Ignite with the given number of [[hitbox]] fires.
;<code>StopScripting</code>
; <code>IgniteHitboxFireScale <[[float]]></code>
: Ignite with the given hitbox fire scale.
; <code>Break</code>
: Smash into pieces. If this is not possible, disappear.
; {{EP2 add|<code>BecomeRagdoll</code>}}
: Remove itself and become a [[ragdoll]].
; <code>StartScripting</code>
; <code>StopScripting</code>
: 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 NPC's idle speech, and so on.
: 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 NPC's idle speech, and so on.
; <code>Assault <[[targetname]]></code>
{{IO|Assault|Start an [[assault]] at the given rally point.|param=targetname}}
: Start an [[assault]] at the given rally point.
{{IO|SetSquad|Change the name of this NPC's [[Squads|squad]].  Leaving the parameter blank will remove the NPC from any existing squad.|param=string}}
; <code>SetSquad <[[string]]></code>
{{IO|Wake|Wakes up the NPC if it is sleeping.}}
: Change the name of this NPC's [[Squads|squad]].  Leaving the parameter blank will remove the NPC from any existing squad.
{{IO|ForgetEntity|Clears out the NPC's knowledge of a named entity.|param=targetname}}
; <code>Wake</code>
: Wakes up the NPC if it is sleeping.
; <code>ForgetEntity <[[targetname]]></code>
: Clears out the NPC's knowledge of a named entity.
; <code>GagEnable</code>
; <code>GagEnable</code>
; <code>GagDisable</code>
; <code>GagDisable</code>
: Gagged NPCs won't speak (or moan, caw, etc.) unless made to be a choreographed scene.
: Gagged NPCs won't speak (or moan, caw, etc.) unless made to be a choreographed scene.
; <code>IgnoreDangerSounds <[[float]]></code>
{{IO|IgnoreDangerSounds|Ignore danger sounds for the specified number of seconds.|param=float}}
: Ignore danger sounds for the specified number of seconds.
; {{EP1 add|<code>HolsterWeapon</code>}}
; {{EP1 add|<code>HolsterWeapon</code>}}
; {{EP1 add|<code>UnholsterWeapon</code>}}
; {{EP1 add|<code>UnholsterWeapon</code>}}
: Force the NPC to holster or unholster their weapon. Ignored if the NPC is scripting or if the NPC doesn't use weapons.
: Force the NPC to holster or unholster their weapon. Ignored if the NPC is scripting or if the NPC doesn't use weapons.
; {{EP1 add|<code>HolsterAndDestroyWeapon</code>}}
{{IO|{{EP1 add|HolsterAndDestroyWeapon}}|As <code>HolsterWeapon</code>, except the weapon is destroyed once it has been concealed.}}
: As <code>HolsterWeapon</code>, except the weapon is destroyed once it has been concealed.
{{IO|{{EP1 add|ForceInteractionWithNPC <[[string]]>}}|Force the NPC to use a dynamic interaction with another NPC. Syntax is <code><[[targetname]]> <dynamic interaction></code>.|param=string}}
; {{EP1 add|<code>ForceInteractionWithNPC <[[string]]></code>}}
{{IO|{{EP1 add|UpdateEnemyMemory}}|Update (or create) this NPC's memory of of the given entity.}}
: Force the NPC to use a dynamic interaction with another NPC. Syntax is <code><[[targetname]]> <dynamic interaction></code>.
; {{EP1 add|<code>UpdateEnemyMemory <[[targetname]]></code>}}
: Update (or create) this NPC's memory of of the given entity.
{{I RenderFields}}
{{I RenderFields}}
{{I DamageFilter}}
{{I DamageFilter}}

Revision as of 05:45, 18 June 2016

BaseNPC:
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
SetHealth <int>
Set the NPC's health.
Template:EP2 add
Template:EP2 add
Add to or remove from the NPC's health.
SetBodyGroup <integer>
HACK: Sets this NPC's body group (from 0 - n).
physdamagescale <float>
Scales the damage taken when this character is hit by a physics object. 0 means this feature is disabled for backwards compatibility.
Ignite
Burst into flames.
IgniteLifetime <float>
Ignite for the given number of seconds.
IgniteNumHitboxFires <integer>
Ignite with the given number of hitbox fires.
IgniteHitboxFireScale <float>
Ignite with the given hitbox fire scale.
Break
Smash into pieces. If this is not possible, disappear.
Template:EP2 add
Remove itself and instantly become a ragdoll with zero force (just go limp). OnDeath, etc. Outputs will NOT be fired.
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 NPC's idle speech, and so on.
Assault <targetname>
Start an assault at the given rally point.
SetSquad <string>
Change the name of this NPC's squad. Leaving the parameter blank will remove the NPC from any existing squad.
Wake
Wakes up the NPC if it is sleeping.
ForgetEntity <targetname>
Clears out the NPC's knowledge of a named entity.
GagEnable
GagDisable
Gagged NPCs won't speak (or moan, caw, etc.) unless made to be a choreographed scene.
IgnoreDangerSounds <float>
Ignore danger sounds for the specified number of seconds.
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)
As HolsterWeapon, except the weapon is destroyed once it has been concealed.
ForceInteractionWithNPC <string> (in all games since Half-Life 2: Episode One) <string>
Force the NPC to use a dynamic interaction with another NPC. Syntax is <targetname> <dynamic interaction>.
UpdateEnemyMemory (in all games since Half-Life 2: Episode One)
Update (or create) this NPC's memory of of the given entity.

RenderFields:

Alpha <integer 0–255>
Sets the entity's transparency to a number from 0 (invisible) to 255 (fully visible). Requires the entity to have its rendermode set to a number other than 0.
Color <color255>
Sets an RGB color for the entity.

DamageFilter:

SetDamageFilter <string>
Sets the entity to use as damage filter. Pass in an empty string (no parameter) to clear the damage filter.
ResponseContext:
AddContext <string>
Adds to the entity's list of response contexts. Format is <key>:<value>.
RemoveContext <string>
Remove a context from this entity's list. The name should match the key of an existing context.
ClearContext
Removes all contexts from this entity's list.

Shadow:

DisableShadow
Turn dynamic shadows off for this entity. Identical to applying  EF_NOSHADOW.
EnableShadow
Turn dynamic shadows on for this entity.
DisableReceivingFlashlight  (in all games since Portal 2)
This object will not receive light or shadows from projected textures.
EnableReceivingFlashlight  (in all games since Portal 2)
This object may receive light or shadows from projected textures.
Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Template:I_BaseNPC&oldid=204113"