Game player equip

GoldSrc

Source Engine

Class hierarchy
CGamePlayerEquip ↳CRulePointEntity ↳CRuleEntity ↳CBaseEntity
maprules.cpp

game_player_equip is a logical entity available in all Source games.

Entity description

It spawns one or more entities at the location of the player. Used in multiplayer games to automatically equip the players with standard gear on map spawn, including a multitude of things like weapons, ammo and items. In Half-Life 2 single player, this entity must instead be triggered to spawn its contents with the Use input. This entity requires a few steps to use properly; first you have to tell it what to equip, and then how.

Important:In multiplayer of Black Mesa player will spawn with no ammo if this entity is placed on a map.

What to equip

To properly use the entity, turn SmartEdit off and add new keyvalues manually. The key name should be the item; the value should be the number of that item to equip. For example, a key-value pair of "weapon_ar2" and "1" will make the game_player_equip equip the player with a pulse rifle.

Bug:Number in value doesn't work in Black Mesa via I/O. It works only with player spawn in multiplayer.

Activation

In multiplayer, simply having this entity anywhere in a map will automatically activate it every time a player is spawned into the map, for the spawning player. This is not supported in singleplayer.

You can also trigger this entity to spawn with the Use input, making it spawn at the location of the activating player only. (To prevent a triggerable game_player_equip from also being activated at player spawn in multiplayer, set the Use Only flag.) The default .fgd does not contain this input, so you must manually enter Use into the Input field instead. Hammer won't register this as a correct input, displaying it in red, but it is correct.

Note:Singleplayer games only support the Use activation method. This makes it only able to be used with entities activated by the player (i.e. the player is the !activator of the I/O chain), such as a trigger_once or func_button. Otherwise, the game_player_equip will do nothing.

Bug:The Use input has a bug which causes a crash if the activator is NULL. One such situation is when using a logic_auto to activate the game_player_equip.

Workaround:Using a trigger_once on the player's spawn position activated by the logic_auto entity negates this issue.

  [todo tested in ?]

Keyvalues

Name (targetname) <string>[ Edit ]

The name that other entities refer to this entity by, via Inputs/Outputs or other keyvalues (e.g. parentname or target).
Also displayed in Hammer's 2D views and Entity Report.

See also:  Generic Keyvalues, Inputs and Outputs available to all entities

Team Master (Obsolete) (master) <string>

Legacy support: The name of a master entity. If the master hasn't been activated, this entity will not activate.

Flags

Use Only : [1]

Strip All Weapons First : [2] (in all games since ) (also in )

In Counter-Strike: Global Offensive also removes armor and heavyarmor. It doesn't in Black Mesa.

Strip the player's suit : [4] (only in )

Only Strip Same Weapon Type : [4] (in all games since )

Inputs

TriggerForAllPlayers  (in all games since ) (also in )

Equips all players with weapons specified in keyvalues.

TriggerForActivatedPlayer <classname> (in all games since )

This will force the player who activated to equip the specified weapon.

Bug:Spawns the weapon 32x, this can lead to edict crash if used on multiple players at once.  [todo tested in ?]

Note:In , this input is missing from the entity's code; may have been intentionally removed or not added for some reason.

See also

• Weapons
• Items