Func breakable surf/en

Language subpage

This subpage is used on the Func breakable surf page to display content in English.

If you have edited the language subpage, do not forget to purge the base page by clicking on the button on the right. Otherwise, its contents will not be updated.

Purge the base

It defines a breakable surface, for partially breakable glass/tile/etc. All faces that are not ever visible to the player should use nodraw. Faces that will be broken must have exactly four sides. The material applied to the visible face must be set up to be breakable. This entity is functionally similar to real-life tempered glass.

In code, it is represented by theCBreakableSurfaceclass, defined in thefunc_breakablesurf.cppfile.

Bug:This entity is available and functional in

, although without the ability to break the glass with bullets (unlike in

,

and other source games).

Workaround: Assign this VScript code as an Entity Script on the entity to fix bullet damage not functioning.

self.ConnectOutput("OnBreak", "OnBreak");

function OnBreak()
{
	self.RemoveSolidFlags(Constants.FSolid.FSOLID_NOT_SOLID);
	self.SetCollisionGroup(24); // TFCOLLISION_GROUP_ROCKETS
}

The following standard textures are meant to work with this entity (using any other may crash the game on startup!):

glass/glasswindowbreak070a (but not glass/glasswindowbreak070b!)
tile/tilebreak001c (using this will stretch the texture if broken)
glass/urban_glass_3 (in all games since )

Info for creating a material compatible with func_breakable_surf can be found here

Bug:The entity must have its origin at 0 0 0, otherwise the surface will disappear or become misplaced when damaged. With default FGDs this is a non-issue as the entity lacks an origin keyvalue entirely, but some custom FGDs add one, likely being unaware of this bug. If the entity appears with an origin keyvalue in Hammer, make sure to always set it to 0 0 0 after moving, rotating, or scaling the entity in order for it to behave correctly.

Confirm:By extension, the entity probably also breaks if parented.

Bug:Using Tile as the Surface Type in Half-Life 2 will show missing textures and make the whole surface non-solid when damaged.

Bug:The break sound will play from both the entity and the origin of the map (0,0,0), if this entity is placed on the boundary of the default visleaf cuts (indicated by blue lines in Hammer 2D view).

Flags

[1] : Physics damage decals

[2] : Take damage from held objects

[4] : Break on Pressure

[512] : Break immediately on Physics

[1024] : Don't take physics damage

[2048] : Don't allow bullet penetration

Keyvalues

Fragility (fragility) <integer>: If the 'Surface Type' is set to Glass, this value sets how fragile the glass pieces are after the surface has been broken.

Surface Type (surfacetype) <choices>

Surface material type

0: Glass
1: Tile

error (???) <choices> !FGD

Set automatically by Hammer to indicate an invalid glass/tile surface, when non-zero the entity will be removed when spawned, and a error message will be thrown in the console. This keyvalue is not included in Valve's FGDs, but is still fully functional.

0: No Error
1: Multiple Textured Faces

Note:You must use tools/toolsnodraw to no draw the 5 remaining sides, or otherwise this error will be thrown!

2: Non-Square Face

Breakable (brush):

Prop Data (propdata) <choices>: Set to the best approximation of the size and material of this entity's brushes. If set, this will override Strength and Material Type. If set, it will override this entity's health and damage taken from various weapons. See prop_data base types for what each entry specifies.

Note:Some settings can make the brush unbreakable.

0: None
1: Wooden.Tiny
2: Wooden.Small
3: Wooden.Medium
4: Wooden.Large
5: Wooden.Huge
6: Metal.Small
7: Metal.Medium
8: Metal.Large
9: Cardboard.Small
10: Cardboard.Medium
11: Cardboard.Large
12: Stone.Small
13: Stone.Medium
14: Stone.Large
15: Stone.Huge
16: Glass.Small
17: Plastic.Small
18: Plastic.Medium
19: Plastic.Large
20: Pottery.Small
21: Pottery.Medium
22: Pottery.Large
23: Pottery.Huge
24: Glass.Window

Strength/Health (health) <integer>: The damage to take before breaking. The brush will not break from damage if this is 0.

Material Type (material) <choices>: Set to the material type of the brush. Decides what sounds to make when damaged, and what gibs to produce when broken.

0: Glass - As stated, uses glass gibs and sounds. Gibs may not match with material used.
1: Wood - As stated, uses wood gibs and sounds. Gibs may not match with material used, and may be too big for certain brushes.
2: Metal - As stated, uses metal gibs and sounds. Gibs are very small, and evidently made for vents. May not match material.
3: Flesh - Uses HL1 gib death sounds and wood gibs. Not much practicality for this type unless one is making a meat slab (With proper gibs, of course).
4: CinderBlock - Uses concrete gibs and sounds. Gibs may not match with material and be too big for the brush.
5: Ceiling Tile - Uses tile sounds, wood gibs and HL1 plaster gib death sound.
6: Computer - Uses spark sounds and wood gibs, coupled with an HL1 gib death sound.
7: Unbreakable Glass - Uses glass sounds. Using this material type overrides any Strength value previously set to 0, making it unbreakable.
8: Rocks - Uses concrete gibs and sounds. Gibs may not match with material, and don't even look like rocks to begin with.
9: Web !FGD - Only functional in Half Life Source.
10: None

Gibs Direction (explosion) <choices>

Used to decide which direction to throw gibs when broken.

0: Random
1: Relative to Attack
2: Use Precise Gib Dir (see below)

Precise Gib Direction (gibdir) <angle>: An exact direction in which to throw gibs when breaking. Be sure to select "Use Precise Gib Dir" in Gibs Direction!

Damaging it Doesn't Push It (nodamageforces) <boolean>: When enabled the brush will move in response to damage.

Gib Model (gibmodel) <string>: Used by HL1Port to specify a custom gib model to break into, overriding the Material Type.

Spawn On Break (spawnobject) <choices>: When broken, an entity of the selected type will be created.
Note:Only these entities may be spawned. This can be fixed by modifying func_break.cpp.

Explode Magnitude (explodemagnitude) <integer>: If non-zero, when this entity breaks it will create an explosion that causes the specified amount of damage.
Confirm:Damage radius is proportional to magnitude.

~~Dead model (deadmodel) <model path>~~ !FGD: Deprecated. Purpose unknown. Does absolutely nothing inside code.

~~Shards (shards)~~ !FGD: Deprecated. Purpose unknown. Does absolutely nothing inside code.

~~Lip (lip)~~ !FGD: Deprecated. Purpose unknown. Does absolutely nothing inside code.

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

Internal keyvalues used by VRAD:

Minimum Light Level (_minlight) <float>: Multiplier of minimum amount of light to hit this brush.

Shadows (vrad_brush_cast_shadows) <choices>

Determines if this entity will cast lightmap shadows.

0: No shadows
1: Cast shadows

VisibleBrush:

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
Bug:Alpha effects from 0 to 10 are unavailable due to the bug in code in Counter-Strike: Global Offensive 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 0–255>: 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.

Texture Frame (texframeindex) <integer> !FGD: The frame number for any animated textures on this entity.

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

SystemLevelChoice:

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_level cvar used by Effect Details.]}

Choices
0: Default ("Low" for`mincpulevel`, "High" for`maxcpulevel`) 1: Low 2: Medium 3: High

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_level cvar used by Shader Details.]}

Choices
0: Default ("Low" for`mingpulevel`, "Very High" for`maxgpulevel`) 1: Low 2: Medium 3: High 4: Very High

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.

Choices
Warning:If these are used, the object may break when the user switches their DirectX settings. 0 - Default (no bounding) 60 - DirectX 6 (!FGD for mindxlevel) 70 - DirectX 7 80 - DirectX 8 (Geforce4 Ti 4600) 81 - DirectX 8.1 (GeForce FX 5200) 90 - DirectX 9 Shader Model 2 92 - OpenGL equivalent to DirectX 9 Shader Model 2 (using ToGL; only) !FGD 95 - DirectX 9 Shader Model 3 97 - OpenGL equivalent to DirectX 9 Shader Model 3 (using ToGL; only) !FGD

Base:

Collisions (solid) <choices>: Method of collision for this entity.

Values:

0: None
1: BSP (QPhysics) !FGD
Bug:In , if an entity using QPhysics collisions is hit by Gel, the game will crash!
2: Bounding Box
3: Oriented Bounding Box (Use for runtime spawned brush entities meant to be rotated) !FGD
4: Oriented Bounding Box but constrained to Yaw only !FGD
5: Custom/Test (Usually no collision with anything) !FGD
6: VPhysics

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:Entities transition to the next map with their parents
Tip: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: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!

Spawnflags (spawnflags) <flags> !FGD: Toggles exclusive features of an entity, its specific number is determined by the combination of flags added.

Effects (effects) <flags> !FGD: Combination of effect flags to use.
Entity Scripts (vscripts) <scriptlist> (in all games since ) (also in ): 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 ) (also in ): 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 ) !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 ) !FGD: If set to 1, this entity will slow down aiming movement for consoles and joystick controllers when the entity is under the crosshairs.

Inputs

Shatter <vector>: Shatter the window. Input a vector. First two coordinates are the X,Y center of the shattering (as values from 0-1). The third coordinate is the radius of the shatter, in hammer units.

BreakableBrush:

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.
SetMass <float>: Damaging the entity applies physics forces to it.

Visible Brush:

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 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.
EnableDraw (in all games since ): Removes EF_NODRAW from the entity.

DisableDraw (in all games since ): Applies EF_NODRAW to the entity. Note that this is different from rendermode 10.

EnableReceivingFlashlight (in all games since ): Makes it so that the entity is lit by env_projectedtextures.

DisableReceivingFlashlight (in all games since ): Prevents the entity from being lit by env_projectedtextures. The shadow made by the texture will still cast.

Reflection:

DisableDrawInFastReflection (in all games since ): Turns off rendering of this entity in reflections when using $reflectonlymarkedentities in water material.

EnableDrawInFastReflection (in all games since ): 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 ): 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.

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 ) !FGD: Dispatches a special effect from the entity's origin; See also List of Client Effects. Replaced by the particle system since .

RunScriptFile <script> (in all games since ) (also in ): 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 ) (also in ): 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.
Bug:In Hammer, using string arguments will corrupt the VMF file's structure, making the file unviewable for the next Hammer session.
Fix:Remove the string argument manually with a text editor.
Note: 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 ) (also in ) !FGD: Calls a VScript function defined in the scope of the receiving entity.

TerminateScriptScope (only in ) !FGD: Destroys the script scope of the receving entity.

SetLocalOrigin <coordinates> (in all games since ) !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 ) !FGD: Set this entity's angles.

Outputs

BreakableBrush:

OnBreak: Fired when this object breaks. !activator is 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.

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 ): This output fires when the entity is killed and removed from the game.

Func breakable surf/en

Contents

Flags

Keyvalues

Inputs

Outputs

See also

Navigation menu

Personal tools

Namespaces

Variants

Views

More

Search

Navigation

Support

Steam Community

Tools