Targetname

Targetname is a base Keyvalue available in all Source games. A targetname (also known simply as Name) is the name of an entity. A targetname is not required for an entity to exist, but generally must be present for an entity to play a part in the I/O System.

Notes

• Entities may also be targeted by their classname (e.g. prop_dynamic).
• Targetnames do not need to be unique, they can be shared (and inputs will be sent to each one). Duplicated targetnames are displayed in bold font.
• Targetnames cannot contain ! or * characters (see below).
• Targetnames also cannot contain , characters if you intend to use the entity as a parent, as this is used to set an attachment point.

Instances

• Instances may use prefix or postfix name fixups, and will auto-generate a prefix if no parameters are specified.
• Prefixes and Postfixes are separated by a single dash e.g. hall_a3-door_02.
• Placing an @ symbol at the beginning of a targetname (e.g. @exit_door) will bypass a naming fixup for that particular entity. If @exit_door and exit_door_relay were part of an instance prefixed as Door_01, the names of the entities would be @exit_door and Door_01-exit_door_relay.

Player Events

In most multiplayer games, any entity with the following targetnames will have a Use input sent to them when that event occurs.

• game_playerdie - Fires every time a player dies. The player who died is the !activator.
• game_playerkill - Fires every time a player kills another player, the killer is the !activator.
• game_playerjoin - Fires every time a player joins the game, the joining player is the !activator.
  Bug:game_playerjoin is not fired by bots.  [todo tested in?]
• game_playerspawn - Fires every time a player spawns, with the spawning player as the !activator.
  Bug:game_playerspawn does not function in .  [todo tested in?]
• game_playerleave - Fires every time a player leaves the game. !activator will not work in this case, as the player entity no longer exists.

Confirm:In what games do game_playerjoin and game_playerspawn actually work?

Tip:In , use VScript event hooks which also offer extra information with each event (such as the attacker on death etc). Equivalent event names are player_spawn, player_death and player_disconnect.

Name Matching

While searching for an entity, Source can use a few extended matching features that are useful in a variety of situations. They are used to target an entity with an unknown or partially known name, and they are most commonly used in I/O chains, but they can also be used in KeyValues which target entities, like the filter KV in filter_activator_name/class or an entity's parent field. The extended features are:

• Wildcards

Source supports * wildcards to a limited extent. This means searching for area1* will match any targetnames that start with area1, like area1_portal or area1_door, but not area2_door. These wildcards are also limited to trailing *, which means more complex wildcards like *_door or area*_door will not function.

Note: Mapbase has support for complex wildcard matching like *_door, area*_door, ar*a*_d*r, ? wildcards, etc.

Note:Hammer does not recognize most of these forms of matching and will see them as errors in the editor, but they will work in-game.

The I/O System also supports classname matching, which matches by an entity's classname rather than its targetname. This uses all of the same extended matching features listed above. Some other parts of Source support classname matching, but this usually isn't the case unless stated otherwise.

Tip:Although not feasible for some situations, most implementations of VScript support standalone entity iteration and contain string comparison tools, regex, etc., allowing for virtually any type of name matching.

Keywords

The following special targetnames can be used to dynamically select an entity.

Note:Not all entity parameters can evaluate these targetnames. For example SetParent input can evaluate !activator parameter but player's SetFogController input is not able to evaluate !activator/!caller and needs to use the desired env_fog_controller's targetname.

!activator

The entity that began the current I/O chain.

  If a player walks into a trigger that fires a logic_relay, the player is the !activator of the relay's output(s).

!self

The entity from which the current input originates.

  If a player walks into a trigger that fires a logic_relay, the relay is the !self of its output(s).

Special case: 

• If a logic_relay fires ForceSpawnAtEntityOrigin !self to an env_entity_maker with OnTrigger, the !self entity is the env_entity_maker itself.

!caller

The entity from which the current output originates.

If a player walks into a trigger that fires a logic_relay, the trigger is the !caller of the relay's output(s).

Special case: 

• If a logic_relay fires ForceSpawnAtEntityOrigin !caller to an env_entity_maker with OnTrigger, the !caller entity is the relay itself.
• For entities such as filter_activator_[xxxx] or logic_case, the !caller of a TestActivator or PickRandom/PickRandomShuffle is the filter_activator_[xxxx]/logic_case itself, not the entity that fired the input.

Note:Individual inputs can override the entity targeted by !caller! This is done by point_entity_finder, math_counter, logic_case, and filter entities.

!player

Targets the player.

  In multiplayer games, it targets the first player that joined the server.

Note:When testing an entity's name, this behaves as expected, matching if the entity is a player.

Tip:To target all players in a server, use the player classname.

Bug:In Portal 2, entities parented using the parentname parameter fail to parent on map startup.  [todo tested in?]

Workaround:Use a logic auto and a SetParent input instead.

!player_blue(only in )

In Portal 2 Coop, this targets ATLAS (player 1).

!player_orange(only in )

In Portal 2 Coop, this targets P-Body (player 2).

!pvsplayer

The first player found in the entity's Potential Visibility Set. The PVS used is taken from the entity doing the searching, or the activator if no searching entity exists. If no activator exists either, the first player in the game is returned (i.e. !player).

!picker

The first entity under the player's crosshair; mostly only for debugging. Entities without collision can only be selected by aiming at their origin.

  In multiplayer games, it uses the first player that joined the server.

FindNamedEntity Keywords

These keywords are only available in FindNamedEntity, a method specific to NPCs which is only searched by specific systems (e.g. choreographed scenes) and not by things like the I/O System.

Todo:  Mapbase makes this available to I/O searches. Is this the case in any other branch?

!speechtarget

The entity at which the !caller is looking due to a Look At Actor or Face Actor choreography event.

!friend

The !caller's nearest friendly NPC. This returns the player on NPCs which don't descend from CAI_PlayerAlly.

!enemy

The current enemy of the !caller.

Keyword Notes

• Both !activator and !caller can be different for specific inputs, which depends on each input's implementation. In most cases this is in an undesired manner, like GetValue for math_counter.
• When an output's "Target Entity" is empty, !self is not set to the !caller value.
• Targetnames used in an output's parameter override field are evaluated by the entity that receives the output, not the one that sends it.

See also

• User Inputs and Outputs
• GetDebugName(), for accessing an entity's targetname in C++.

Stub

This article or section is a stub. You can help by adding to it.