item_item_crate
... 
item_item_crate is a point entity available in the Half-Life 2 series. It's the standard supply crate that creates specified content when broken.
By default, it contains item_dynamic_resupply, an entity that spawns whatever item the player needs most (health, armor, ammo). By changing the crate's Item Type, you can make it drop specific items.
In code, it is represented by theCItem_ItemCrateclass, defined in theitem_itemcrate.cppfile.
Note:This is not a CItem however.Contents
Flags
BasePropPhysics:
- [
1] : Start Asleep
- [
2] : Don't take physics damage
- [
4] : Debris
Don't collide with the player or other debris.
- [
8] : Motion Disabled
Starts with motion disabled until sent EnableMotion.
- [
64] : Enable motion when grabbed by gravity gun
- [
128] : Not affected by rotor wash
- [
256] : Generate output on+use
- [
512] : Prevent pickup
- [
1024] : Prevent motion enable on player bump.
- [
2048] : Has Attached Ragdolls !FGD
Set by the game when ragdolls are attached, destroys them when prop moves
- [
4096] : Debris with trigger interaction.
- [
8192] : Force server-side
Multiplayer only; seesv_pushaway_clientside_size.
- [
16384] : Radius Pickup !FGD
Makes objects easier to grab
- [
1048576] : Gravity gun can ALWAYS pick up. No matter what.
- [
2097152] : No Collisions !FGD
Disable collisions on spawn
- [
4194304] : Gib !FGD
If debris, remove when stuck in a collision
BreakableProp:
- [
16] : Break on Touch
- [
32] : Break on Pressure
Keyvalues
Crate Contains (CrateType) <integer>
- Deprecated. Do not alter. Numbers other than 0 will cause the crate to spawn nothing after being broken. (If that's desired, try to use a
prop_physicsinstead as it's not as memory-intensive.)
- Item Type (ItemClass) <pointentityclass>
- Classname of the entity to spawn when the crate is broken. Suggested point entity:
item_dynamic_resupply
- Item Count (ItemCount) <integer>
- Number of items to drop upon breakage.
BreakableProp:
- Explosion Damage
(ExplodeDamage)<float> - If non-zero, when this entity breaks it will create an explosion that causes the specified amount of damage. See also Explosion Radius.
- Explosion Radius
(ExplodeRadius)<float> - If non-zero, when this entity breaks it will create an explosion with a radius of the specified amount. See also Explosion Damage.
- Sound to make when punted
(puntsound)<sound> (in all games since
) - Sound to make when punted by gravity gun.
- Break Model Message
(BreakModelMessage)<string> - "If set, will use this break model message instead of the normal break behavior."
Confirm:Is this new with Source SDK 2013...? It isn't in Alien Swarm or 2007 code but is in 2013. New with L4D?
Breakable (common):
- Performance Mode
(PerformanceMode)<choices> - Used to limit the amount of gibs produced when this entity breaks, for performance reasons.
- 0: Normal
- 1: No Gibs
- 2: Full Gibs on All Platforms (Xbox 360, PS3, etc)
- 3: Reduced gibs
- Min Damage to Hurt
(minhealthdmg)<integer> - If a single hit to the object doesn't do at least this much damage, the prop won't take any of the damage it attempted to give.
- Pressure Delay
(pressuredelay)<float> - Seconds to delay breaking from pressure. Allows creaking/groaning sounds to play.
- Health
(health)<integer> - How close to breaking the object is.
- Maximum Health
(max_health)<integer> - Health cannot exceed this amount.
- Physics Impact Damage Scale
(physdamagescale)<float> - Multiplier for damage amount when this entity is hit by a physics object. With a value of 0 the entity will take no damage from physics.
- Breakable By
(BreakableType)<choices> (only in
) - Who can break this?
- 0: Everyone
- 1: All Infected
- 2: Only Tanks
BasePropPhysics:
- Physics Impact Damage Scale
(physdamagescale)<float> - Multiplies damage received from physics impacts. 0 means the feature is disabled for backwards compatibility.
- Impact damage type
(Damagetype)<boolean> - If true (1), damage type is sharp and the object can slice others.
- Damaging it Doesn't Push It
(nodamageforces)<boolean> - Whether damaging the entity applies force to it.
- Scale Factor For Inertia
(inertiascale)<float> - Scales the angular mass of an object. Used to hack angular damage and collision response. Confirm:Doesn't actually affect inertia?
- Mass Scale
(massscale)<float> - Multiplier for the object's mass.
- Override Parameters
(overridescript)<string> - A list of physics keyvalues that are usually embedded in the model. Format is
key,value,key,value,….
- Health Level to Override Motion
(damagetoenablemotion)<integer> - If specified, this object will start with motion disabled. Once its health has dropped below this specified amount, it will enable motion.
- Physics Impact Force to Override Motion
(forcetoenablemotion)<float> - If specified, this object will start motion disabled. Any impact that imparts a force greater than this value will enable motion.
GMODSandbox:
- Allow Physics Gun
(gmod_allowphysgun)<boolean> (only in
) - If set, players cannot use Physics Gun on this entity.
- Sandbox Tool Whitelist
(gmod_allowtools)<string> (only in) - If set, only given tools can be used on this entity. You need to supply the tool class names, the names of the
.luafiles of those tools. This also includes the context menu properties!
BaseAnimating:
- Skin
(skin or ModelSkin<integer>
) - Some models have multiple skins. This value selects from the index, starting with 0.
- Collisions
(solid)<choices> - Method of collision for this entity.
- Body Group
(body or SetBodyGroup)<integer> !FGD - Sets the the active
$bodygroup.
- Model Index
(modelindex)<short> !FGD - Given the number index from dumping the
cl_precacheinfo modelprecachetable, sets entity model to the index.
Warning:If an entity has animations that will be played, then the set model also must have its own sequences, else the game crashes. - Model Scale
(modelscale)<float> (in all games since
) - A multiplier for the size of the model. Negative values are accepted. Does not alter the physics collisions in most cases, however.Warning:Negative or extremely high values can cause crashes!Note:Scale may not appear in
Hammer 4.x, but will appear in-game (tested in 
). This is fixed in 
Hammer++.
Animating
- Sequence
(sequence)<integer> !FGD - Default animation sequence for the model to be playing after spawning.
- Playback Rate
(playbackrate)<float> !FGD - A multiplier of the framerate at which animations are played, negative values are accepted. Default is 1.0.
- Texture Frame
(texframeindex)<integer> !FGD - The initial frame number for all animated textures on this entity.
Effects - Render
- Start Fade Distance
(fademindist)<float> - Distance at which the entity starts fading. If 0 or less, the entity will disappear instantly when end fade is hit. The value will scale appropriately if the entity is in a 3D Skybox.
- End Fade Distance
(fademaxdist)<float> - Distance at which the entity ends fading. If 0 or less, the entity won't disappear at all. The value will scale appropriately if the entity is in a 3D Skybox.
- Fade Scale
(fadescale)<float> - If specified in the
worldspawn, or if the engine is running below DirectX 8, entities will fade out even if the fade distances above aren't specified. This value gives more control over when this happens: numbers smaller than 1 cause the entity to fade out at further distances, and greater than 1 cause it to fade out at closer distances. Using 0 turns off the forced fade altogether. See also$noforcedfade.
- FX Amount/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.
- Render FX
(renderfx)<choices> - Various somewhat legacy alpha effects.
 Bug:Alpha effects from 0 to 10 are unavailable due to the bug in code in  Counter-Strike: Global Offensive
|
- Render Mode
(rendermode)<choices> - Set a non-standard rendering mode on this entity.
|
Effects - Environment
- Disable Shadows
(disableshadows)<boolean> - Prevent the entity from creating cheap render-to-texture shadows. Does not affect shadow mapping.
- Disable Receiving Shadows
(disablereceiveshadows)<boolean> - Prevent the entity from receiving shadows on itself.
- Shadow Cast Distance
(shadowcastdist)<integer> - Sets how far the entity casts dynamic shadows. 0 means default distance from the
shadow_controlentity.
- Lighting Origin
(LightingOrigin)<targetname> - Select an entity (not
info_lighting!) from which to sample lighting instead of the entity's origin. Lighting Origin Offset(not in(LightingOriginHack)<targetname>) !FGD - Deprecated. The
info_lighting_relativefrom which to sample lighting instead of the entity's origin. Use Lighting Origin instead. - Disable Flashlight
(disableflashlight)<boolean> (in all games since
) - Used to disable projected texture lighting and shadows on this entity. Identical to EF_NOFLASHLIGHT.
- Disable ShadowDepth
(disableshadowdepth)<boolean> (in all games since) - Makes this entity not cast a shadow from
env_projectedtextureentities. Identical to EF_NOSHADOWDEPTH.
- 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. Identical to
EF_SHADOWDEPTH_NOCACHE.- 0: Default
- 1: No cache—render every frame
- 2: Cache it—render only once
Miscellaneous
- Glow Backface Multiple
(glowbackfacemult)<float> (only in
) !FGD - If this object has a glow effect, multiply the effect by this much on the sides of the object that are facing away from the viewer.
- Move Type
(MoveType)<choices> (in all games since) !FGD - Sets a movetype for this entity, which changes its movement behavior.
|
- Collision Group
(CollisionGroup)<choices> (in all games since) !FGD - Sets a collision group for this entity, which changes its collision behavior.
|
- No Animation Sounds
(SuppressAnimSounds)<boolean> (in all games since) !FGD - Silences sounds linked to animations.DXLevelChoice:
- Minimum / Maximum DX Level
(mindxlevel / maxdxlevel)<choices> (removed since
) - The entity will not exist if the engine is running outside the given range of DirectX Versions.
Warning:If these are used, the object may break when the user switches their DirectX settings.
|
- Minimum / Maximum Effect Details Level
(mincpulevel / maxcpulevel)<choices> (in all games since) - Don't render for players with Effect Details levels that exceed the minimum or maximum.[Key names are related to
cpu_levelcvar used by Effect Details.]
|
- Minimum / Maximum Shader Details Level
(mingpulevel / maxgpulevel)<choices> (in all games since) - Don't render for players with Shader Details levels that exceed the minimum or maximum.[Key names are related to
gpu_levelcvar used by Shader Details.]
|
BaseAnimating:
- Skin
(skin or ModelSkin<integer>) - Some models have multiple skins. This value selects from the index, starting with 0.
- Collisions
(solid)<choices> - Method of collision for this entity.
- Body Group
(body or SetBodyGroup)<integer> !FGD - Sets the the active
$bodygroup.
- Model Index
(modelindex)<short> !FGD - Given the number index from dumping the
cl_precacheinfo modelprecachetable, sets entity model to the index.Warning:If an entity has animations that will be played, then the set model also must have its own sequences, else the game crashes. - Model Scale
(modelscale)<float> (in all games since) - A multiplier for the size of the model. Negative values are accepted. Does not alter the physics collisions in most cases, however.Warning:Negative or extremely high values can cause crashes!Note:Scale may not appear in Hammer 4.x, but will appear in-game (tested in ). This is fixed in Hammer++.
DXLevelChoice:
- Minimum / Maximum DX Level
(mindxlevel / maxdxlevel)<choices> (removed since) - The entity will not exist if the engine is running outside the given range of DirectX Versions.
Warning:If these are used, the object may break when the user switches their DirectX settings.
|
Animating
- Sequence
(sequence)<integer> !FGD - Default animation sequence for the model to be playing after spawning.
- Playback Rate
(playbackrate)<float> !FGD - A multiplier of the framerate at which animations are played, negative values are accepted. Default is 1.0.
- Texture Frame
(texframeindex)<integer> !FGD - The initial frame number for all animated textures on this entity.
Effects - Render
- Start Fade Distance
(fademindist)<float> - Distance at which the entity starts fading. If 0 or less, the entity will disappear instantly when end fade is hit. The value will scale appropriately if the entity is in a 3D Skybox.
- End Fade Distance
(fademaxdist)<float> - Distance at which the entity ends fading. If 0 or less, the entity won't disappear at all. The value will scale appropriately if the entity is in a 3D Skybox.
- Fade Scale
(fadescale)<float> - If specified in the
worldspawn, or if the engine is running below DirectX 8, entities will fade out even if the fade distances above aren't specified. This value gives more control over when this happens: numbers smaller than 1 cause the entity to fade out at further distances, and greater than 1 cause it to fade out at closer distances. Using 0 turns off the forced fade altogether. See also$noforcedfade.
- FX Amount/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.
- Render FX
(renderfx)<choices> - Various somewhat legacy alpha effects.
Bug:Alpha effects from 0 to 10 are unavailable due to the bug in code in Counter-Strike: Global Offensive
|
- Render Mode
(rendermode)<choices> - Set a non-standard rendering mode on this entity.
|
Effects - Environment
- Disable Shadows
(disableshadows)<boolean> - Prevent the entity from creating cheap render-to-texture shadows. Does not affect shadow mapping.
- Disable Receiving Shadows
(disablereceiveshadows)<boolean> - Prevent the entity from receiving shadows on itself.
- Shadow Cast Distance
(shadowcastdist)<integer> - Sets how far the entity casts dynamic shadows. 0 means default distance from the
shadow_controlentity.
- Lighting Origin
(LightingOrigin)<targetname> - Select an entity (not
info_lighting!) from which to sample lighting instead of the entity's origin. Lighting Origin Offset(not in(LightingOriginHack)<targetname>) !FGD - Deprecated. The
info_lighting_relativefrom which to sample lighting instead of the entity's origin. Use Lighting Origin instead.
Base:
- Parent
(parentname)<targetname> - Maintain the same initial offset to this entity. An attachment point can also be used if separated by a comma at the end. (
parentname [targetname],[attachment])
Tip:Entities transition to the next map with their parentsTip:phys_constraintcan be used as a workaround if parenting fails.
- Origin (X Y Z)
(origin)<coordinates> - The position of this entity's center in the world. Rotating entities typically rotate around their origin.Note:Hammer does not move the entities accordingly only in the editor.
- Pitch Yaw Roll (X Y Z)
(angles)<angle> - This entity's orientation in the world. Pitch is rotation around the Y axis, yaw is the rotation around the Z axis, roll is the rotation around the X axis.Note:This works on brush entities, although Hammer doesn't show the new angles.
- Classname
(classname)<string> !FGD - Determines the characteristics of the entity before it spawns. Tip:Changing this on runtime still has use, like making matching an entry in S_PreserveEnts will persist the entity on new rounds!
Inputs
BasePropPhysics:
Sleep- Tell the prop to quit moving. Any physics forces (excluding gravity and water buoyancy) will cause the object to resume moving as usual. Sleeping also occurs automatically when the object has no physics forces to keep it awake, and when it is no longer moving a noticeable amount.
Wake- If the object was told to sleep, tell it to start moving again.
DisableMotion- Tell the object to stop moving completely. No physics forces will re-enable motion, not even
Wake.
EnableMotion- If the object's motion has been disabled entirely, tell it to resume movement as usual. This will also
Wakethe object, if it isSleeping.
DisableFloating- If the object would normally float when in water, tell it not to float. There seems to be no way to re-enable floating behavior, but programming a method to do this should be fairly simple (
CALLBACK_DO_FLUID_SIMULATION).
BreakableProp:
Break- Breaks the breakable.
SetHealth<integer>- Sets a new value for the breakable's health. If the breakable's health reaches zero it will break.
AddHealth<integer>- Adds health to the breakable.
RemoveHealth<integer>- Removes health from the breakable.
physdamagescale<float>- Sets Physics Impact Damage Scale. 0 means this feature is disabled for backwards compatibility.
EnablePhyscannonPickup- Makes the breakable able to picked up by the gravity gun.
DisablePhyscannonPickup- Makes the breakable not able to picked up by the gravity gun.
EnablePuntSound(in all games since)- Allow this prop from playing its Punt Sound sound when punted by the gravity gun.
DisablePuntSound(in all games since)- Prevent this prop from playing its Punt Sound sound when punted by the gravity gun.
Model:
SetBodyGroup<integer>- Sets the the active
$bodygroup.
Ignite- Makes the entity catch on fire indefinitely.
IgniteLifetime<float>- Makes the entity catch on fire for a given amount of time.
IgniteNumHitboxFires<integer> (removed since)- Makes the entity catch on fire with a given number of hitbox fire particles. Does not function correctly in onward.
IgniteHitboxFireScale<float> (removed since)- Makes the entity catch on fire with a given scale for hitbox fire particles. Does not function correctly in onward.
BecomeRagdoll- Kills the entity and creates a client-side ragdoll from the model. Input is only passed if the model contains
$collisionjoints. For other models,phys_convertcan be used instead.
SetLightingOrigin<targetname>- Sets the entity's lighting origin to use this entity's position.
SetLightingOriginHack<targetname>) - Deprecated. Offsets the entity's lighting origin by their distance from an
info_lighting_relative. UseSetLightingOrigininstead.
fademindist<float>- Sets distance at which the entity starts fading. If <0, the entity will disappear instantly when end fade is hit. The value will scale appropriately if the entity is in a 3D Skybox.
fademaxdist<float>- Sets distance at which the entity ends fading. If <0, the entity won't disappear at all. The value will scale appropriately if the entity is in a 3D Skybox.
SetModelScale<vector> (only in
)- Multiplies the size of the model. Does not alter the physics collisions in most cases. Can take two values separated by a space, in which case the first value would be the target model scale and the second value would be the number of seconds the change in scale will be spread over. If there is no second value, the model will scale instantly.Tip:The
modelscalekeyvalue can be AddOutputed as a workaround for other games with this input missing.
Warning:Negative or extremely high values can cause crashes!SetCycle<float> (only in
)- Skip to a specific point in the current animation.
SetModel<string> (only in)- Changes the model to the specified path. Form of models/ammo/ammo_us.mdl.
Important:Absolutely NO quotes! Make sure you use the forward slash '/'. Merasmus says to heed this advice, else thou shalt corrupt the VMF.
SetPlayBackRate<float> (only in)- Change the animation speed multiplier.
Alpha<integer>- Sets the entity's transparency to a number from 0 (invisible) to 255 (fully visible). Requires the entity to have its Render Mode (rendermode) set to a number other than 0.
AlternativeSorting<boolean>- Swaps the rendering order of the entity. Used to attempt to fix sorting problems when rendering, for example an object rendering in front of translucent materials.
Color<color255>- Sets an RGB color for the entity.
SetDamageFilter<targetname>- Sets a filter for this entity for when it receives damage.
EnableDamageForces- Allows the entity to be pushed by damage done to it (usually force amount correlates with the damage done).
DisableDamageForces- Prevents the entity from being pushed by damage done to it.
Reflection:
DisableDrawInFastReflection(in all games since)- Turns off rendering of this entity in reflections when using
$reflectonlymarkedentitiesin water material.
EnableDrawInFastReflection(in all games since)- Turn on rendering of this entity in reflections when using
$reflectonlymarkedentitiesin water material.
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.
Base:
AddContext<string>- Adds to the entity's list of response contexts. See Context.
AddOutput<string>- Assigns a new keyvalue/output on this entity. For keyvalues, some rely on extra necessary code to be ran and won't work if its simply just changed through this input. There is a strict format that must be followed:
// Format of changing KeyValues: "AddOutput [key] [value]"
//// Raw text:
"OnUser1" "!self,AddOutput,targetname new_name"
// Format of adding an Output: "AddOutput {targetname}:{inputname}:{parameter}:{delay}:{max times to fire, -1 means infinite}"
//// Raw text:
"OnUser1" "!self,AddOutput,OnUser1:SetParent:!activator:0.0:-1"
// Arguments can be left blank, but the empty blank should still be contained.
//// Raw text:
"OnUser1" "!self,AddOutput,OnUser1:ClearParent::0.0:-1"
|
ClearContext- Removes all contexts from this entity's list.
ClearParent- Removes this entity from the the movement hierarchy, leaving it free to move independently.
FireUser1toFireUser4- Fires the respective
OnUseroutputs; see User Inputs and Outputs.
Kill- Removes this entity and any entities parented to it from the world.
KillHierarchy- Functions the same as
Kill, although this entity and any entities parented to it are killed on the same frame, being marginally faster thanKillinput.
RemoveContext<string>- Remove a context from this entity's list. The name should match the key of an existing context.
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.
Outputs
OnCacheInteraction- This output fires when the player proves they have "found" this item.
- Fires on:
- Player Touch (whether or not player actually acquires the item).
- Picked up by
+use. - Picked up by gravity gun.
- Punted by gravity gun.
BasePropPhysics:
OnMotionEnabled- Fired when motion has been enabled on the prop, either via the Health Level to Override Motion keyvalue or from the
EnableMotioninput.
OnAwakened- Fired when the prop has woken (force has been applied to it while it was asleep, or the
Wakeinput has been called).
OnOutOfWorld- Fired whenever the object is detected to be outside the world. Specifically, it checks if the object is outside of the world's bounding box or if the object is traveling at over 2000 units per second in any cardinal direction.
OnPlayerUse- Fired when the player has
+used the prop.
Note:This output (but not any of the other pickup-related ones) will fire only if the Generate output on +USE spawnflag is set.OnPhysGunDrop- Fired when the player has dropped the prop (from either
+useor the gravity gun).!activatoris the player.
OnPlayerPickup- Fired when the player has picked the prop up with
+useor the gravity gun (in Half-Life 2). OnPhysGunOnlyPickup- Fired when the player has picked the prop up with the gravity gun specifically.Model:
OnIgnite!FGD- Fired when the entity catches fire, such as from an
env_entity_igniteror theIgniteinputs.
BreakableProp:
OnBreak- Fired when this object breaks.
!activatoris whatever breaks the object.
OnHealthChanged<float>- Fired whenever the health of the breakable has increased or decreased. This output automatically puts the new health amount as a decimal percent (e.g. 45% = 0.45) into the parameter box for inputs, if the mapper does not override the parameter with something else.
OnTakeDamage- Fired when damage is taken.
OnPhysCannonAnimatePreStarted- Fired when prop starts its
ACT_PHYSCANNON_ANIMATE_PREactivity. Caused by the object being picked up by the gravity gun.
OnPhysCannonAnimatePullStarted- Fired when prop has started its
ACT_PHYSCANNON_ANIMATEactivity.ACT_PHYSCANNON_ANIMATE_PREplays once, thenACT_PHYSCANNON_ANIMATEstarts looping.
OnPhysCannonDetach- Fired when prop has started its
ACT_PHYSCANNON_DETACHactivity (caused by the gravity gun ripping it from a wall).
OnPhysCannonAnimatePostStarted- Fired when prop has started its
ACT_PHYSCANNON_ANIMATE_POSTactivity (caused by the player letting the prop go from the gravity gun).
OnPhysCannonPullAnimFinished- Fired when prop has finished all gravity gun-related animations.
Model:
OnIgnite!FGD- Fired when the entity catches fire, such as from an
env_entity_igniteror theIgniteinputs.
Base:
OnUser1toOnUser4- These outputs each fire in response to the firing of the like-numbered
FireUser1toFireUser4Input; see User Inputs and Outputs.
See also
- Crates for basic crates
item_ammo_cratefor the infinite-ammo binsinfo_radar_targetfor Episode Two radar blips
