prop_door_rotating_checkpoint

From Valve Developer Community
Jump to: navigation, search
English (en)
... Icon-Important.png

prop_door_rotating_checkpoint is a point entity available in the Left 4 Dead series Left 4 Dead series. It is a special variant of prop_door_rotating for checkpoint doors in the world.

Note.pngNote:From Left 4 Dead onwards (and in Garry's Mod), rotating doors can be destroyed if the model used was compiled with $collisiontext.
Icon-Bug.pngBug:Using raw door sounds will cause the sound to play everywhere in the map, despite the distance. This can be ignored in singleplayer games, but may be a problem in multiplayer games, because all players will hear the door throughout the whole map. This can be fixed by using a soundscript.
Icon-Bug.pngBug:Specifying a Custom Hinge Axis in Hammer is broken. A workaround is to simply modify the model and set the origin to the hinge location.

Supported Models

Most newer games such as Left 4 Dead 2 have a model folder called props_doors, which feature various door models (including static props that will not work for prop_door_rotating). For a door model to be compatible, it must be a physics prop and its model origin must be on the hinge side of the door, as doors rotate around its origin.

Example of a compatible door (Green) and an incompatible door (Red)
Note the origin of the red door being in the bottom middle. That is where the door would rotate along.

Keyvalues

Slave name (slavename) <targetname>
Name of any door(s) that should open and close at the same time as this one. You could also give them all the same name.
Hardware Type (hardware) <choices>
The type of mechanism used to open the door (handle, push bar, keypad). The mechanism only appears in the game, not in Hammer.
  • None
  • Lever (i.e. door handle)
  • Push bar
  • Keypad
    Note.pngNote: Keypad hardware only has a model in Half Life 2 EP1 & EP2.
Spawn Position (spawnpos) <choices>
State the door should begin in. Check the door's angles to see forward/backward orientation.
  • Closed
  • Open forward
  • Open back
  • Ajar
Ajar Angles (ajarangles) <angle>
If "Spawn Position" is "ajar", these are the angles to spawn at instead of being open or closed.
Hinge Axis (axis) <axis>
Blank image.pngTodo:

Note.pngNote:Despite Hinge Axis values, the door can only rotate on the Z Axis
Rotation Distance (distance) <float>
Number of degrees that the door should open, both forward and backward.
Speed (speed) <integer>
In degrees/second.
Fully Open Sound (soundopenoverride) <string>
Sound played when the door has finished opening.
Fully Closed Sound (soundcloseoverride) <string>
Sound played when the door has finished closing.
Moving Sound (soundmoveoverride) <string>
Sound played when the door starts to move.
Locked Sound (soundlockedoverride) <string>
Optional overrides to the sounds played by the door. Sound played when the player tries to open the door, and fails because it's locked.
Unlocked Sound (soundunlockedoverride) <string>
Optional overrides to the sounds played by the door. Sound played when the door is unlocked.
Delay Before close (returndelay) <integer>
Number of seconds the door waits until closing by itself. -1 means never auto-close.
Damage Inflicted When Blocked (dmg) <integer>
If an entity is blocking the door from moving, inflict this much damage per frame.
Can Damage Player (candamageplayer) <boolean> (only in INFRA)
If set, this door will kill the player blocking it. Used for the large blast doors in infra_c7_m2_bunker.
Note.pngNote:This replaces the "Damage Inflicted When Blocked" keyvalue in INFRA INFRA .
Force Closed (forceclosed) <boolean>
If set, this door will close no matter what. Useful for doors that have to close even if the player tries to block them with objects.
Open Direction (opendir) <choices>
Force the door to open only forwards or only backwards. It will normally try to swing away from the entity that opened it, unless it is being blocked on the other side.
  • Both directions
  • Forward only
  • Backward only
Health <integer> Obsolete
Deprecated. Health for the door.
Glow Distance (glowdist) <integer> (in all games since Counter-Strike: Global Offensive)
Default is 1024.
Blank image.pngTodo: Same as L4D2's Glow Range?
Does the prop glow by default? (glowenabled) <boolean> (in all games since Counter-Strike: Global Offensive)
Enables the door to glow. Default is set to off.
Glow Color (glowcolor) <color255> (in all games since Counter-Strike: Global Offensive)
The color of the glow (if enabled).

Glow:
Glow State (glowstate) <choices> (only in Left 4 Dead 2)
  • OFF
  • +use
  • look-at
  • ON
Glow Range (glowrange) <integer> (only in Left 4 Dead 2)
Range at which the glow becomes visible. 0 means always visible.
Glow Range Min (glowrangemin) <integer> (only in Left 4 Dead 2)
Range at which the glow stops being visible. 0 means always visible.
Glow Color Override (R G B) (glowcolor) <color255> (only in Left 4 Dead 2)
Change the render color of the glow.

Studiomodel:
World Model (model) <string>
The model this entity should appear as. 128-character limit.
Skin (skin) <integer>
Some models have multiple skins. This value selects from the index, starting with 0.
Tip.pngTip:Hammer's model browser automatically updates this value if you use it to view different skins.
Model Scale (modelscale) <float> (in all games since Source 2013)
A multiplier for the size of the model.

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 Portal 2)
Used to disable rendering into shadow depth (for projected textures) for this entity.
Disable flashlight (disableflashlight) <boolean> (in all games since Portal 2)
Used to disable projected texture lighting and shadows on this entity.
Projected Texture Cache (shadowdepthnocache) <choices> (in all games since Portal 2)
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

Reflection:
Render in Fast Reflections (drawinfastreflection) <boolean> (in all games since Portal 2)
If enabled, this entity will render in fast water reflections (i.e. when a water material specifies $reflectonlymarkedentities) and in the world impostor pass.

}}


BaseFadeProp:
Note.pngNote:These keyvalues may not be available in some FGDs. When used in a game before L4D, there is an abrupt render cut-off rather than an actual fade.
Start Fade Dist (fademindist) <float> (in all games since Left 4 Dead)
Distance at which the prop starts to fade.
End Fade Dist (fademaxdist) <float> (in all games since Left 4 Dead)
Max fade distance at which the prop is visible.
  • If start fade is <0, the prop will disappear instantly when end fade is hit.
  • If end fade is <0, the prop won't disappear at all. (This is the default behaviour.)
The values will scale appropriately if the prop is in a 3D Skybox.
Fade Scale (fadescale) <float> (in all games since Left 4 Dead)
If you specify so in worldspawn, or if the engine is running below DirectX 8 (DX7 in Ep1), props will fade out even if the fade distances above aren't specified. This value gives you some control over when this happens: numbers smaller than 1 cause the prop 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 the QC command $noforcedfade.

Base:
Name (targetname) <string>
The name that other entities use to refer to this entity.
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.pngTip:Entities transition to the next map with their parents
Tip.pngTip:phys_constraint can 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.pngNote: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.pngNote: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.pngTip:Changing this on runtime still has use, like making matching an entry in S_PreserveEnts will persist the entity on new rounds!
Flags (spawnflags) <integer> !FGD
Toggles exclusive features of an entity, its specific number is determined by the combination of flags added.
Effects (effects) <integer> !FGD
Combination of effect flags to use.
Entity Scripts (vscripts) <scriptlist> (in all games since Left 4 Dead 2) (also in Team Fortress 2)
Space delimited list of VScript files (without file extension) that are executed after all entities have spawned. The scripts are all executed in the same script scope, later ones overwriting any identical variables and functions. Scripts executed on the worldspawn entity will be placed in root scope.
Think function (thinkfunction) <string> (in all games since Left 4 Dead 2) (also in Team Fortress 2)
Name of the function within this entity's script that'll be called automatically every 100 milliseconds, or a user-defined interval if the function returns a number. Avoid expensive operations in this function, as it may cause performance problems.
Lag Compensation (LagCompensate) <boolean> (in all games since Left 4 Dead 2) !FGD
Set to Yes to lag compensate this entity. Should be used very sparingly!
Is Automatic-Aim Target (is_autoaim_target) <boolean> (in all games since Counter-Strike: Global Offensive) !FGD
If set to 1, this entity will slow down aiming movement for consoles and joystick controllers when the entity is under the crosshairs.

Flags

  •  [1] : Starts Open
  •  [2048] : Starts locked
  •  [4096] : Door silent (No sound, and does not alert NPCs)
  •  [8192] : Use closes
  •  [16384] : Door silent to NPCs (Does not alert NPCs)
  •  [32768] : Ignore player +USE
  •  [524288] : Start Unbreakable (in all games since Left 4 Dead)
  •  [524288] : Start Breakable (in all games since Counter-Strike: Global Offensive) (also in Garry's Mod)

Inputs

Open
Open the door.
Close
Close the door.
Toggle
Toggle the door between open and closed.
OpenAwayFrom <targetname>
Open the door away from the specified entity.
Lock
Lock the door.
Note.pngNote:In Left 4 Dead, if spawnflag 8192 is active, you can lock the safe room door only after survivors open it.
Unlock
Unlock the door.
SetRotationDistance <float>
Degrees of rotation that the door will open.
MoveToRotationDistance <float> (in all games since Portal 2) (also in Garry's Mod)
Sets the open distance (in degrees) and moves there.
SetSpeed <float>
Set the speed at which the door rotates.
Note.pngNote:Default is 200 in L4D.
SetUnbreakable  (in all games since Left 4 Dead)
The door can't be broken.
SetBreakable  (in all games since Left 4 Dead)
The door can be broken.
SetAnimation <string> (only in INFRA)
Force the door to play an animation. The parameter should be the name of the animation.
SetAnimationNoReset <string> (only in INFRA)
Force the door to play an animation unless the door is already playing the animation. The parameter should be the name of the animation.
SetGlowEnabled  (in all games since Counter-Strike: Global Offensive)
Starts the glow.
SetGlowDisabled  (in all games since Counter-Strike: Global Offensive)
Stops the glow.

Glow:
StartGlowing  (only in Left 4 Dead 2)
Turn on a permanent glow effect for this prop.
StopGlowing  (only in Left 4 Dead 2)
Turn off this prop's glow effect.

Model:
skin <integer>
Selects a skin from the model's index, starting with 0.
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 Left 4 Dead 2)
Makes the entity catch on fire with a given number of hitbox fire particles. Does not function correctly in Left 4 Dead 2 onward.
IgniteHitboxFireScale <float> (removed since Left 4 Dead 2)
Makes the entity catch on fire with a given scale for hitbox fire particles. Does not function correctly in Left 4 Dead 2 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_convert can be used instead.
SetLightingOrigin <targetname>
Sets the entity's lighting origin to use this entity's position.
SetLightingOriginHack <targetname> (removed since Left 4 Dead) Obsolete
Deprecated. Offsets the entity's lighting origin by their distance from an info_lighting_relative. Use SetLightingOrigin instead.
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 Source 2013)
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.pngTip:The modelscale keyvalue can be AddOutputed as a workaround for other games with this input missing.
Warning.pngWarning:Negative or extremely high values can cause crashes!
SetCycle <float> (only in Team Fortress 2)
Skip to a specific point in the current animation.
SetModel <string> (only in Team Fortress 2)
Changes the model to the specified path. Form of models/ammo/ammo_us.mdl.
Icon-Important.pngImportant: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 Team Fortress 2)
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 Portal 2)
Turns off rendering of this entity in reflections when using $reflectonlymarkedentities in water material.
EnableDrawInFastReflection  (in all games since Portal 2)
Turn on rendering of this entity in reflections when using $reflectonlymarkedentities in 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 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.
Icon-Bug.pngBug:The RenderField properties do not show up in hammer, but can be manually added by turning off SmartEdit and entering the key and appropriate values.

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.
FireUser1 to FireUser4
Fires the respectiveOnUseroutputs; 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.
Use  !FGD
Same as a player invoking +use; no effect in most cases.
DispatchResponse <string> !FGD
Dispatches a response to the entity. See Response and Concept.
DispatchEffect <string> (removed since Left 4 Dead) !FGD
Dispatches a special effect from the entity's origin; See also List of Client Effects. Replaced by the particle system since Left 4 Dead.
RunScriptFile <script> (in all games since Left 4 Dead 2) (also in Team Fortress 2)
Execute a VScript file from disk, without file extension. The script contents are merged with the script scope of the receiving entity.
RunScriptCode <string> (in all games since Left 4 Dead 2) (also in Team Fortress 2)
Execute a string of VScript source code in the scope of the entity receiving the input. String quotation may be needed when fired via console.
Icon-Bug.pngBug:In Hammer, using string arguments will corrupt the VMF file's structure, making the file unviewable for the next Hammer session.
Note.pngFix:Remove the string argument manually with a text editor.
Note.pngNote:Team Fortress 2 Backtick characters ` are replaced with quotation marks at runtime, allowing quotation marks to be used when normally not possible.
CallScriptFunction <string> (in all games since Left 4 Dead 2) (also in Team Fortress 2) !FGD
Calls a VScript function defined in the scope of the receiving entity.
TerminateScriptScope  (only in Team Fortress 2) !FGD
Destroys the script scope of the receving entity.
SetLocalOrigin <coordinates> (in all games since Alien Swarm) !FGD
Send this entity to a spot in the map. If the entity is parented to something, it will be offset from the parent by this amount.
SetLocalAngles <angles> (in all games since Alien Swarm) !FGD
Set this entity's angles.

Outputs

OnRotationDone  (in all games since Portal 2) (also in Garry's Mod)
Fired when the door arrives at its goal angle.

BaseDoor:

OnClose
Fired when the door starts to close.
OnOpen
Fired when the door starts to open.
OnFullyClosed
Fired when the door finishes closing. Reversed if Start Open flag is set.
OnFullyOpen
Fired when the door finishes opening. Reversed if Start Open flag is set.
OnBlockedClosing
Fired when the door has been blocked from closing. !activator is whatever blocks the door.
OnBlockedOpening
Fired when the door has been blocked from opening. !activator is whatever blocks the door.
OnUnblockedClosing
Fired when the door is no longer blocked from closing.
OnUnblockedOpening
Fired when the door is no longer blocked from opening.
OnLockedUse
Fired when the player tries to open the door but fails because it is locked.

Studiomodel:
OnIgnite
Fired when this object catches fire.

Base:

OnUser1 to OnUser4
These outputs each fire in response to the firing of the like-numbered FireUser1 to FireUser4 Input; see User Inputs and Outputs.
OnKilled  (only in Left 4 Dead)
This output fires when the entity is killed and removed from the game.

Custom Door Models

  1. Create ACT_IDLE, ACT_DOOR_LOCKED and ACT_DOOR_OPEN activities.
  2. Add a door_options $keyvalues block:
$keyvalues
{
	prop_data
	{
		blocklos 1
	}
	door_options
	{
		default // Fallbacks if something is missing elsewhere
		{
			open	Doors.FullOpen1
			close	Doors.FullClose1
			move	Doors.Move1
			locked		DoorHandles.Locked1
			unlocked	DoorHandles.Unlocked1
		}
		hardware0 // First hardware type, by default a handle
		{
			locked		DoorSound.Null
			unlocked	DoorSound.Null
		}
		hardware1 // Push bar
		{
			locked		DoorHandles.Locked1
			unlocked	DoorHandles.Unlocked1
		}
		hardware2 // Keypad
		{
			locked		DoorHandles.Locked2
			unlocked	DoorHandles.Unlocked2
		}

		skin0  // Skin-specific sounds, including a custom surfaceprop.
		{
			open	Doors.FullOpen4
			close	Doors.FullClose4
			move	Doors.Move4
			surfaceprop	wood  // If no skin is specified, surfaceprop is always wood, no matter what's written elsewhere
		}
	}
}

Left 4 Dead series L4D Series Doors

The Left 4 Dead series introduced a new set of doors that can be broken down by Infected.
Those new doors make use of $collisiontext and new "Pound" and "Damage" listings in door_options, highlighted below.
Some doors in L4D2, which were ported from L4D, also have the following activities, although they do not seem to work: ACT_DOOR_ANIMTOLOCK, ACT_DOOR_ANIMTOUNLOCK, ACT_DOOR_OPENFAIL.

Note.pngNote:Animations with the activity ACT_DOOR_LOCKED do not seem to work. Only workaround seems to be manually adding I/O connections to the door in hammer, or play a specific sequence when used while locked.
$collisiontext
{
	break 
	{
		"model"		"Props_downtown\door_interior_128_01_dm01_02" //Spawns a debris model.
		"health"		"100"
		"fadetime"		"10"
	}
}

$keyvalues
{
	prop_data 
	{
		"base"			"Door.Standard"
		"allowstatic"	"1"
		"blocklos"		"1"
		"dmg.bullets"	"0"  //Bullets will no longer damage this door. In L4D2 this is only used on the last damage model.

	}
	door_options 
	{
		"defaults"		 
		{
			"open"			"Doors.FullOpen1"
			"close"			"Doors.FullClose1"
			"move"			"Doors.Move1"
			"locked"		"DoorHandles.Locked1"
			"unlocked"		"DoorHandles.Unlocked1"

			"pound"			"Doors.Wood.Pound1"								//Sound that plays when infected attack the door to break it down.
			"surfaceprop"	"wood"											//Overwrites Surfaceprop.
			"damage1"		"props_downtown\door_interior_128_01_DM01_01"	//What the first damage model is.
			"damage2"		"props_downtown\door_interior_128_01_DM02_01" 	//What the second damage model is.
			"damage3"		"props_downtown\door_interior_128_01_DM03_01" 	//What the third damage model is.
		}
	}
}

The "Damage1", "Damage2" and "Damage3" lines determine what models will be used for the broken stages of this door model.

Note.pngNote:The sound that plays for the metal bar being removed is hardcoded. It can only be changed by editing the level_sound script for each map. More info on how to do so can be found here
Warning.pngWarning:All damage models need their own set of door options. Not having door options for the damaged models will cause those doors to be silent if you decide to immediately use a damaged door.

See also