From Valve Developer Community
npc_wheatley_boss
is a point entity available in Portal 2. It is Wheatley's NPC stub used in the final chapters of the game.
the Entity in-Game (with the model "glados_wheatley_boss.mdl" assigned)
Note:If spawned using the Developer Console, this entity will not render or function as it does not have a model specified.
Keyvalues
BaseNPC keyvalues
- Relationship
(???) <string> !FGD
- Changes whether this NPC likes or dislikes certain others. Used like the
ai_relationship entity, with this NPC as the subject. Format: <string|targetname or classname> <string|disposition> <int|rank> .
- Values for
disposition are:
D_HT : Hate
D_FR : Fear
D_LI : Like
D_NU : Neutral
- Target Path Corner
(target) <targetname>
- The
path_corner that this NPC will move to after spawning.
- Squad Name
(squadname) <string>
- NPCs that are in the same squad (i.e., have matching squad names) will share information about enemies and will take turns attacking and covering each other.
- Hint Group
(hintgroup) <string>
- Hint groups are used by NPCs to restrict their hint-node searching to a subset of the map's hint nodes. Only hint nodes with matching hint group names will be considered by this NPC.
- Hint Limit Nav
(hintlimiting) <boolean>
- Limits NPC to using specified hint group for navigation requests. Does not limit local navigation.
- Sleep State
(sleepstate) <choices>
- Holds the NPC in stasis until specified condition. See also Wake Radius and Wake Squad.
- 0: None
- 1: Waiting for threat
- 2: Waiting for PVS
- 3: Waiting for input, ignore PVS
- 4: Auto PVS
- 5: Auto PVS after PVS
- Wake Radius
(wakeradius) <float>
- Auto-wake if player comes within this distance.
- Wake Squad
(wakesquad) <boolean>
- Wake all of the NPCs squadmates if the NPC is woken.
- Enemy Filter
(enemyfilter) <targetname>
- Filter entity to test targets against.
- Ignore unseen enemies
(ignoreunseenenemies) <boolean>
- Prefers visible enemies, regardless of distance or relationship priority.
- Physics Impact Damage Scale
(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:
- Damage Filter
(damagefilter) <targetname>
- Name of the
filter_damage_type entity that controls which entities can damage us.
|
Parentname:
- Parent
(parentname)
<targetname>
- Specifies a movement parent. An entity will maintain its initial offset from its parent. An attachment point can be added to the end of the name, separated by a comma.
RenderFields:
- Render Mode
(rendermode)
<choices>
- Set a non-standard rendering mode on this entity.
Render Modes
- 0: Normal
- 1: Color
- 2: Texture
- 3: Glow
- 4: Solid/Alphatest
- 5: Additive
- 6: Removed, does nothing
- 7: Additive Fractional Frame
- 8: Alpha Add
- 9: World Space Glow
- 10: Don't Render
|
- Render FX
(renderfx)
<choices>
- Various somewhat legacy alpha effects.
Render Effects
- 0: None
- 1: Slow Pulse (varies alpha by ±16 over a period of 1.5 s)
- 2: Fast Pulse (varies alpha by ±16 over a period of 0.4 s)
- 3: Slow Wide Pulse (varies alpha by ±64 over a period of 1.5 s)
- 4: Fast Wide Pulse (varies alpha by ±64 over a period of 0.4 s)
- 5: Slow Fade Away (decreases alpha by -1 per frame/(in all games since ) Fades out over 4 s)
- 6: Fast Fade Away (decreases alpha by -4 per frame/(in all games since ) Fades out over 1 s)
- 7: Slow Become Solid (increases alpha by +1 per frame/(in all games since ) Fades in over 4 s)
- 8: Fast Become Solid (increases alpha by +4 per frame/(in all games since ) Fades in over 1 s)
- 9: Slow Strobe (transparent 0.8 s, visible 0.8 s, repeat)
- 10: Fast Strobe (transparent 0.2 s, visible 0.2 s, repeat)
- 11: Faster Strobe (transparent 0.09 s, visible 0.09 s, repeat)
- 12: Slow Flicker (transparent 0.18 s, visible 1.5 s, repeat)
- 13: Fast Flicker (transparent 0.14 s, visible 0.2 s, repeat)
- 14: Constant Glow ("NoDissipation;" purpose uncertain—for sprites?) (not in )
- 15: Distort (causes unnatural flickering and position shifting)/(in all games since ) Fade Out (instant; not very useful outside of code)
- 16: Hologram (Distort + "distance fade")/(in all games since ) Fade In (instant; not very useful outside of code)
- 17: Scale Up ("Explode"/"scale up really big!" causes wild stretching of model parts) (in )/Fade Wider Pulse (varies alpha by ±255 over a period over a period of 0.26 s) (in all games since )
Confirm:which branches/games is it available in, and where does it do what?
- 18: Glow Shell (purpose unclear) (in all games since ) (not in )
Confirm:what does this do? and which games is it in?
- 19: Clamp Minimum Scale ("keep this sprite from getting very small (SPRITES only!)") (not in )
- 20: Environmental Rain ("for environmental rendermode, make rain") (in ) (not in )
Confirm:which games? may be nonfunctional.
- 21: Environmental Snow ("for environmental rendermode, make snow") (in ) (not in )
Confirm:which games? may be nonfunctional.
- 22: Spotlight FX ("TEST CODE for experimental spotlight") (in ) (not in )
- 23: Ragdoll ("HACKHACK: TEST CODE for signalling death of a ragdoll character;" ragdolls an entity but doesn't kill it) (in ) (not in )
Confirm:which games? may be nonfunctional?
- 24: Fade Wider Pulse (varies alpha by ±255 over a period over a period of 0.26 s) (in ) (not in )
- 25:
kRenderFXMax /Fade Near (removed since ) (not in )
Todo: what does this do? may be nonfunctional
|
- Render FX / Transparency (0 - 255)
(renderamt)
<integer>
- Transparency amount, requires a Render Mode other than Normal. 0 is invisible, 255 is fully visible.
- Render Color (R G B)
(rendercolor)
<color255>
- Color tint.
- Disable Receiving Shadows
(disablereceiveshadows)
<boolean>
- Prevent the entity from receiving shadows on itself.
Shadow:
- Disable Shadows
(disableshadows)
<boolean>
- Prevents the entity from creating cheap render-to-texture shadows, or lightmap shadows if the entity is a
prop_static
. Does not affect shadow mapping.
- Disable Receiving Shadows
(disablereceiveshadows)
<boolean>
- Prevent the entity from receiving dynamic shadows on itself.
- Shadow Cast Distance
(shadowcastdist)
<integer> !FGD
- Sets how far the entity casts dynamic shadows. 0 means default distance from the
shadow_control
entity.
- Disable ShadowDepth
(disableshadowdepth)
<boolean> (in all games since )
- Used to disable rendering into shadow depth (for projected textures) for this entity.
- Disable flashlight
(disableflashlight)
<boolean> (in all games since )
- Used to disable projected texture lighting and shadows on this entity.
- Projected Texture Cache
(shadowdepthnocache)
<choices> (in all games since )
- Used to hint projected texture system whether it is sufficient to cache shadow volume of this entity or to force render it every frame instead.
Choices
- 0 : Default
- 1 : No cache - render every frame
- 2 : Cache it - render only once
|
Flags
BaseNPC flags
- [
1 ] : Wait Till Seen Prevents this NPC from seeing (or being seen) until it enters a player's viewcone.
- [
2 ] : Gag Won't make IDLE sounds until it's angry.
- [
4 ] : Fall to ground (unchecked means teleport to ground)
- [
8 ] : Drop Healthkit Causes this NPC to drop an item_healthvial upon dying.
- [
16 ] : Efficient Don't acquire enemies or avoid obstacles
- [
128 ] : Wait For Script Forces this NPC to "wait" in an idle state until it finishes playing a scripted_sequence .
- [
256 ] : Long Visibility/Shoot By default, increases a NPC's sight range to 6,000 units and allows it to attack from anywhere within that distance.
- [
512 ] : Fade Corpse
- [
1024 ] : Think outside PVS Allows this NPC to run its regular AI outside of any player's PVS.
- [
2048 ] : Template NPC Marks this NPC as a template for entities like npc_template_maker . The NPC will not spawn on its own. This is not needed for point_template .
- [
4096 ] : Do Alternate collision for this NPC (player avoidance)Note:This flag is disabled in episodic for player companions, because the StartScripting input does this.
- [
8192 ] : Don't drop weapons
- [
16384 ] : Ignore player push (in all games since ) Entity won't give way to player.
|
Inputs
BaseNPC inputs
AddHealth <integer> (in all games since )
RemoveHealth <integer> (in all games since )
- Add to or remove from the NPC's health.
SetHealth <integer>
- Set the NPC's health.
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.
physdamagescale <float>
- Scales the damage taken when this character is hit by a physics object. 0 means this feature is disabled for backwards compatibility.
SetBodyGroup <integer>
- HACK: Sets this NPC's body group (from 0–n).
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.
DamageFilter:
SetDamageFilter <string>
- Sets the entity to use as damage filter. Pass in an empty string (no parameter) to clear the damage filter.
|
Parentname:
SetParent
<string>
- Move with this entity. See Entity Hierarchy (parenting).
SetParentAttachment
<string>
- Change this entity to attach to a specific attachment point on its parent. The entity will teleport so that the position of its root bone matches that of the attachment. Entities must be parented before being sent this input.
SetParentAttachmentMaintainOffset
<string>
- As above, but without teleporting. The entity retains its position relative to the attachment at the time of the input being received.
ClearParent
- Removes this entity from the the movement hierarchy, leaving it free to move independently.
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.
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 )
- This object will not receive light or shadows from projected textures.
EnableReceivingFlashlight
(in all games since )
- This object may receive light or shadows from projected textures.
Outputs
BaseNPC Outputs
OnDamaged
- Fired when this NPC takes damage (
!activator is the damage inflictor).
OnDamagedByPlayer
- Fired when this NPC is hurt by a player (
!activator is the attacker or vehicle driver [if friendly fire]).
OnDamagedByPlayerSquad
- Fired when this NPC is hurt by a player OR by one of the player's squadmates (
!activator is the attacker or vehicle driver [if friendly fire]).
OnDeath
- Fired when this NPC is killed (
!activator is the killer).
OnDenyCommanderUse
- Fired when this NPC has refused to join the player's squad.
OnForcedInteractionAborted
- Fired when the NPC aborts a forced interaction for some reason (target NPC died, couldn't be pathed to, etc.).
OnForcedInteractionStarted
- Fired when the NPC starts a forced interaction.
OnForcedInteractionFinished
- "NPCs in actbusies can no longer perform dynamic interactions."
Todo: What does this mean?
OnHalfHealth
- Fired when this NPC reaches half of its maximum health.
OnHearCombat
- Fired when this NPC hears combat sounds.
OnHearPlayer
- Fired when this NPC hears the player.
OnHearWorld
- Fired when this NPC hears a sound (other than combat or the player).
OnFoundEnemy <targetname>
- Fired when this NPC establishes line of sight to its enemy.
OnLostEnemy
- Fired when this NPC loses its enemy. Usually due to the enemy being killed/removed, or because this NPC has selected a newer, more dangerous enemy.
OnLostEnemyLOS
- Fired when this NPC loses line of sight to its enemy.
OnFoundPlayer <targetname>
- Fired when this NPC establishes line of sight to its enemy, and that enemy is a player.
OnLostPlayer
- Fired when this NPC loses its enemy, and that enemy was a player. Usually due to the enemy being killed/removed, or because this NPC has selected a newer, more dangerous enemy.
OnLostPlayerLOS
- Fired when this NPC loses line of sight to its enemy, and that enemy is a player.
OnSleep
- Fired when this NPC enters a sleep state.
OnWake
- Fired when this NPC comes out of a sleep state.
|