package.base

Scale of the gravity for this entity's physics bodies.

Whether gravity is enabled or not for this entity's physics bodies.

Allows access to certain physics options from Entity Prefabs.

The colour of the glow outline

The colour of the glow when the mesh is obscured by something closer.

The water entity we're inside of

How submerged we are in the water. 0 is none, 1 is over our head.

The source entity to constrain from. Leave empty to constrain from the world entity.

The entity we constrain to.

A sound played when the constraint is broken.

The internal joint of this constraint entity.

Breaks the constraint.

A constraint that keeps the position of two objects fixed, relative to the constraint's origin. It does not affect rotation.

A physically simulated hinge. Use the helper to define the axis of rotation.

Position used to determine hinge axis, the axis being between this position and the position of the constraint entity. Use the helper to set the axis.

A constraint that preserves the distance between two entities. If the 'Keep Rigid' flag is set, think of it as a rod. If not, think off it as a virtual rope.

The position the rope attaches to object 2

If give, will spawn given particle as the rope. Particle's Control Point 1 will be set to the target entity, and will be removed if the constraint breaks.

A constraint that is essentially two length constraints and two points. Imagine it as a virtual rope connected to two objects, each suspended from a pulley above them. The constraint keeps the sum of the distances between the pulley points and their suspended objects constant.

The position of the pulley for Entity 2. The pulley for Entity 1 is the origin of this constraint entity. Entity 1 is always suspended from pulley point 1, and Entity 2 is always suspended from pulley point 2.

A constraint that constrains an entity along a line segment.

Position used to determine sliding axis, the axis being between this position and the position of the constraint entity. Use the helper to set the axis.

A physically simulated spring. 'Length' is what's known as the 'natural spring length'. This is how long the spring would be if it was at rest (nothing hanging on it or attached). When you attach something to the spring, it will stretch longer than its 'natural length'. The amount of stretch is determined by the 'Spring Frequency'. The larger the spring frequency the less stretch the spring.

Use the helper. Drag it out to match the virtual spring.

A generic multi-purpose path that compiles all nodes as a single entity.
This entity can be used with entities like ent_path_platform.

A base entity that will appear in Hammer's Path Tool and automatically parse data from Hammer into a ready-to-use format in C#.

The class to deserialize node data into.

This is generated this automatically during map compile time

Used as both BasePathNode and BasePathNodeEntity so both can be used interchangeably

A basic node description for the BasePathEntity. Please note that BasePathNodes are NOT actual entities, therefore cannot support inputs and outputs. See BasePathNodeEntity.

Position of the node relative to the path entity.

Position of the incoming tangent relative to the node's position. Includes rotation/scale of the node.

Position of the outgoing tangent relative to the node's position. Includes rotation/scale of the node.

The entity associated with this path node, if they were set to spawn via [Path] This will be set as soon as the node entity spawns, which will be after Path entity's Spawn() function.

The path entity this node is associated with.

Used to set the Entity property. Couldn't find a way to hide it. Do not use.

A basic node entity for the BasePathEntity. These can be used as alternatives to BasePathNode data structures with [Path]'s 2nd argument.

Position of the incoming tangent relative to node's own position. Does NOT include node's rotation/scale.

Position of the outgoing tangent relative to node's own position. Does NOT include node's rotation/scale.

The Path entity this node belongs to.

Base entity with physical properties, enables impact damage and the like

Entities with these tags can activate this trigger.

Enables this trigger

Disables this trigger

Toggles this trigger between enabled and disabled states

A common base we can use for weapons so we don't have to implement the logic over and over again.

All active view models.

Position your view model here.

A procedurally shattering glass shard.

A procedurally shattering glass panel.

Material to use for the glass when it is broken. If not set, the material will not change on break.

If set, the glass will shatter at the position of this entity on spawn.

Cleans up broken shards and creates a new primary shard

Breaks the glass at its center.

A procedurally breakable voxel surface.

Handles water level and buoyancy.

Handles water ripples and rendering.

Generic water volume. Make sure to have light probe volume envelop the volume of the water for the water to gain proper lighting.

How far is the simulation radius of the splash from camera view

Controller used for planar reflections

Controller used for water ripples using compute shaders

A static prop that can play animations. If a door is wanted, please use the door entity.

The name of the idle animation that this prop will revert to whenever it finishes a random or forced animation.

Causes this prop to break, regardless if it is actually breakable or not. (i.e. ignores health and whether the model has gibs)

Play a specific animation (sequence) on the entity. The parameter should be the name of the animation.

Sets the default animation. This is the animation will auto repeat if looping is enabled.

Sets the animation playback rate. 1 is normal, 0.5 is half speed, etc.

Set an animation graph parameter. Format: "name=value"

Deletes this prop.

Sets the scale of the prop, affecting physics and visual scale.

Sets the material group of the props' model by name, as set in ModelDoc.

Sets the body group of the props' model by name, as set in ModelDoc. Format is "name,option"

Enables or disables collisions on this prop.

Dynamic cable from Hammer's Path Tool. This is just so it at least spawns in-game.

A generic brush/mesh that can toggle its visibility and collisions, and can be broken.

Whether this func_brush is visible/active at all

Whether this func_brush has collisions

Causes this prop to break, regardless if it is actually breakable or not. (i.e. ignores health and whether the model has gibs)

Make this func_brush non solid

Make this func_brush solid

Toggle solidity of this func_brush

Enable this func_brush, making it visible

Disable this func_brush, making it invisible and non solid

Toggle this func_brush

A generic button that is useful to control other map entities via inputs/outputs.

Specifies the direction to move in when the button is used, or axis of rotation for rotating buttons.

Sound played when the button is pressed and is unlocked

Sound played when the button is pressed and is locked

Settings that are only relevant on spawn

Become locked

Become unlocked

Simulates the button being pressed

Camera for use with monitor entity.

A basic door entity that can move or rotate. It can be a model or a mesh entity. The door will rotate around the model's origin. For Hammer meshes the mesh origin can be set via the Pivot Tool.

The direction the door will move, when it opens.

If set, opening this door will open all doors with given entity name. You can also simply name all doors the same for this to work.

Used to override the open/close animation of moving and rotating doors. X axis (input, left to right) is the animation, Y axis (output, bottom to top) is how open the door is at that point in the animation.

Whether this door is locked or not.

Sets the door's position to given percentage. The expected input range is 0..1

Causes this prop to break, regardless if it is actually breakable or not. (i.e. ignores health and whether the model has gibs)

Toggle the open state of the door. Obeys locked state.

Open the door. Obeys locked state.

Close the door. Obeys locked state.

Locks the door so it cannot be opened or closed.

Unlocks the door.

Sounds to be used by ent_door if it does not override sounds.

Sound to play when the door reaches it's fully open position.

Sound to play when the door reaches it's fully closed position.

Sound to play when the door starts to open.

Sound to play when the door starts to close.

Sound to play while the door is moving. Typically this should be looping or very long.

Sound to play when the door is attempted to be opened, but is locked.

An entity that creates an explosion at its center.

If set, will override the default explosion particle effect.

If set, will override the default explosion sound.

Perform the explosion.

The entity to be responsible for the damage.

Specifies fog based on a color gradient

Set the gradient fog color.

Update fog values on client.

Set Fog Start Distance

Set Fog End Distance

Set Fog Start Height

Set Fog End Height

Set Fog Max Opacity

Set Fog Falloff Exponent

Set Fog Vertical Exponent

Set Fog Color

Set Fog Strength

Update fog values on client.

A entity that represents and allows control of a single particle system.

The name of the particle system.

A particle snapshot file) to be loaded and used by this particle system. Set to Control Point 0.

ID of a mesh in the map to be used to generate a particle snapshot, overriding Snapshot File property.
Meshes tied to an entity cannot be used.

Data Control Point Value to set.

Set the Tint of the Particle.

Data to set for the Named Vector.

If set, control point 0 of the effect will be at this entity's location. (Otherwise it is at the info_particle_system origin)

If set, control point 1 of the effect will be at this entity's location.

If set, control point 2 of the effect will be at this entity's location. If control point 1 is not set, this will be ignored.

If set, control point 3 of the effect will be at this entity's location. If control point 2 is not set, this will be ignored.

If set, control point 4 of the effect will be at this entity's location. If control point 3 is not set, this will be ignored.

If set, control point 5 of the effect will be at this entity's location. If control point 4 is not set, this will be ignored.

Whether this particle system is active or not.

Tell the particle system to start emitting.

Tell the particle system to stop emitting.

Tell the particle system to stop emitting and play its End Cap Effect.

Destroy the particle system and remove all particles immediately.

Set a Control Point via format - CP: X Y Z

Applies given post processing effect to all players. Only the last activated entity will have an effect. (works like a stack) Overridden by post processing volume.

The post process resource file to use

Enable this post processing effect.

Disable this post processing effect.

Who to send the message to. Who to send the message to.

Applies given post processing effect to players inside this volume. Takes priority over post_processing_entity for all players inside. For instances of overlapping volumes, last entered volume will take priority.

A solid entity that creates rain and snow inside its volume.

Particle effect to be placed at "Inner Near Distance" away from the view

Particle effect to be placed at "Inner Far Distance" away from the view

Particle effect to be placed at the current view's position

Set the Tint of the Particle, which will set control point 4 on the particle system.

Particle density scale for all precipitation entities.

Turn the volume on or off.

Change the particle density.

Start the particles.

Stop the particles.

Freezes particles in current state.

UnFreezes particles if they were previously frozen.

Slow or speed up particles. 1 = normal, 0.5 = half speed, 2 = twice the speed.

Enable or disable the particle simulation, i.e. allows pausing the particles.

Sets particle time scale.

Turn the volume on or off.

Enable or disable the particle simulation, i.e. allows pausing the particles.

Sets particle time scale.

Plays a sound event from a point, passes along the min and max positions of its AABB.

Name of the sound to play.

Start the sound on spawn

Stop the sound before starting to play it again

Start the sound event.

Stop the sound event

Who to send the message to. Who to send the message to.

Plays a sound event from a point. The point can be this entity or a specified entity's position.

Name of the sound to play.

The entity to use as the origin of the sound playback. If not set, will play from this snd_event_point.

Start the sound on spawn

Stop the sound before starting to play it again

Start the sound event. If an entity name is provided, the sound will originate from that entity

Stop the sound event

Who to send the message to. Who to send the message to.

A logic entity that allows to do a multitude of logic operations with Map I/O.

TODO: This is a stop-gap solution and may be removed in the future in favor of "map blueprints" or node based Map I/O.

Enables the entity.

Disables the entity, so that it would not fire any outputs.

Toggles the enabled state of the entity.

Fired after all map entities have spawned, even if it is disabled.

Trigger the "OnTrigger" output.

Compares the given number to Variable B and fires the appropriate output.

Compares Variable A to Variable B and fires the appropriate output.

Sets the Variable A and fires appropriate outputs.

Sets the Variable B and fires appropriate outputs.

A monitor that renders the view from a given point_camera entity. This entity requires a material with $MonitorTexture dynamic expression on one of its textures, usually "Color", to function properly.

Name of a point_camera to display.

The camera instance currently being displayed.

Set a new camera to display by its name.

A movement path. Compiles each node as its own entity, allowing usage of inputs and outputs such as OnPassed.
This entity can be used with entities like ent_path_platform.

A movement path node.

Whether the alternative path is enabled or not.

Alternative node when moving forwards, for path changing.

Alternative node when moving backwards, for path changing.

Enables the alternative path.

Disables the alternative path.

Toggles the alternative path.

A platform that moves between nodes on a predefined path. See movement_path in the Path Tool.

The path_generic entity that defines path nodes for this platform.

If set, will automatically start moving forwards from first node on spawn.

If set, the entity will automatically rotate to face the direction of movement. Moving backwards will NOT flip the rotation 180 degrees.

Specifies the direction to move in when the platform is used, or axis of rotation for rotating platforms.

Sound to play when starting to move.

Sound to play when we stopped moving.

Sound to play while platform is moving.

Start moving through our nodes in whatever direction we were moving before until we reach either end of the path.

Start moving forward through our nodes until we reach end of the path.

Start moving backwards through our nodes until we reach start of the path.

Reverse current movement direction, regardless whether we are currently moving or not.

Stop moving.

Go to specific node (Starting with 1) set by the parameter and stop there.

Go to the next node on the path and stop there.

Go to the previous node on the path and stop there.

Teleport to a given node (Starting with 1). Does not stop or start movement.

A generic non model physics object.

Allows disabling physics simulation, or start frozen mid air until a physics collision.

Physical surface properties of this physics mesh.

Amount of damage this entity can take before breaking

Wake up this physics object, if it is sleeping.

Enable motion (gravity, etc) on this entity

Disable motion (gravity, etc) on this entity

A simple platform that moves between two locations and can be controlled through Entity IO.

Specifies the direction to move in when the platform is used, or axis of rotation for rotating platforms.

Sound to play when starting to move

Sound to play when we stopped moving

Sound to play while platform is moving.

Sets the platforms's position to given percentage between start and end positions. The expected input range is 0..1

Start moving in platform's current move direction

Set the move direction to forwards and start moving

Set the move direction to backwards and start moving

Reverse current move direction. Will NOT start moving if stopped

Stop moving, preserving move direction

Toggle moving, preserving move direction

Sets the move speed

An entity that does nothing. Very useful as a positioning entity for other entities to refer to (i.e. the endpoint of a rope in a info_particle_system)

An entity that fires a timer event at regular or random intervals.
TODO: This is a stop-gap solution and may be removed in the future in favor of "map blueprints" or node based Map I/O.

Whether this timer is enabled or not.

The time between timer fires, in seconds.

Time to wait after the timer is enabled before firing the first time.

Enable the timer. If it was disabled, the timer will re-start with the Initial Delay again.

Disable the timer.

Toggle the timer on/off.

Add time to the timer if it is currently enabled. Does not change timer's Interval.

Subtract time from the timer if it is currently enabled. Does not change timer's Interval.

Reset the timer. It will fire after the timer's Interval expires.

Set a new fixed Interval. Does not reset the timer.

Force the timer to fire immediately, if it is enabled.

Has the ability to dynamically block the navigation mesh. When active, AI will see this entity as an obstacle and will not try to walk through it.

Enables this blocker.

Disables this blocker.

A volume that pushes entities that are touching it.

Direction of the force.

Sets the force per second for this push volume

A trigger volume that damages entities that touch it.

Called every server tick to deal damage to touching entities.

Sets the damage per second for this trigger_hurt

A volume that can be triggered multiple times, including at an interval while something is inside the trigger volume.

A simple trigger volume that fires once and then removes itself.

A simple trigger volume that teleports entities that touch it.

The entity specifying a location to which entities should be teleported to.

If set, teleports the entity with an offset depending on where the entity was in the trigger teleport. Think world portals. Place the target entity accordingly.

If set, the teleported entity will not have it's velocity reset to 0.

Set the target to teleport entities to.

Targetname of an entity to teleport entities to.

A dynamic visibility culling box which can be used to hide objects at runtime and can be toggled on and off by entity I/O.

Size of the culling box.

Is the culling box disabled by default.

Enable the culling box.

Disable the culling box.

3D text in the world

A base HUD entity that lets you define which type of RootPanel to create.

A prop that physically simulates as a single rigid body. It can be constrained to other physics objects using hinges or other constraints. It can also be configured to break when it takes enough damage. Note that the health of the object will be overridden by the health inside the model, to ensure consistent health game-wide. If the model used by the prop is configured to be used as a prop_dynamic (i.e. it should not be physically simulated) then it CANNOT be used as a prop_physics. Upon level load it will display a warning in the console and remove itself. Use a prop_dynamic instead.

Set during map compile for multi physics body models based on Hammer physics simulation tool.

Causes this prop to break, regardless if it is actually breakable or not. (i.e. ignores health and whether the model has gibs)

Deletes this prop.

Sets the scale of the prop, affecting physics and visual scale.

Sets the material group of the props' model by name, as set in ModelDoc.

Sets the body group of the props' model by name, as set in ModelDoc. Format is "name,option"

Enables or disables collisions on this prop.

Enables or disables visibility of this prop.

Enables or disables physics (gravity) simulation of this prop.

Controls the sky.

Tint the skybox

Declares a box in which the specified soundscape will be active. If the ear is within two boxes, we'll use the closest. The entity needs to be within the PVS for it to be active.

The size of the bounds. Use the helper in 3D view to manipulate this.

Become enabled

Become disabled

Toggle between enabled and disabled

Declares a sphere in which the specified soundscape will be active. If the ear is within two radiuses, we'll use the closest. The entity needs to be within the PVS for it to be active.

Become enabled

Become disabled

Toggle between enabled and disabled

Defines a single breakable prop gib.

Generic prop settings. Support for this depends on the entity.

TODO: Implement/Delete

Defines the model as explosive. Support for this depends on the entity.

Sound override for when the prop explodes.

Particle effect override for when the problem explodes.

Capsule Ambient Occlusion Proxy. Used internally by the engine for AO and reflections.

Cylinder Ambient Occlusion Proxy. Used internally by the engine for AO and reflections.

Sphere Ambient Occlusion Proxy. Used internally by the engine for AO and reflections.

Box Ambient Occlusion Proxy. Used internally by the engine for AO and reflections.

Defines an eye on a character model.

Carries navigation related data.

Spawn a particle system when this model breaks.

The particle to spawn when the model breaks.

(Optional) Set the particle control point #0 to the specified model.

(Optional) Set the particle control point #0 to the specified snapshot.

(Optional) Set this control point to the position of the break damage.

(Optional) Set this control point to the direction of the break damage.

(Optional) Set this control point to the velocity of the original prop.

(Optional) Set this control point to the angular velocity of the original prop.

(Optional) Set this control point to global world gravity at the moment the model broke.

(Optional) Set this control point to the tint color of the original prop as a vector with values 0 to 1.

Creates a revolute (hinge) joint between two spawned breakpieces.

Axis around which the revolute/hinge joint rotates.

Whether the angle limit should be enabled or not.

Overrides the materialgroup on spawned breakpieces. (By default the active material group of the parent model is propagated to the breakpieces.)

Material group name to switch to.

If set, only apply this command to a particular piece.

Applies extra velocity to breakpieces outwards from the influence point (default is the origin of the model)

Offset the influence point from the named attachment rather than the root of the model

This is the main base game

Enables the devcam. Input to the player will stop and you'll be able to freefly around.

Called clientside from OnKilled on the server to add kill messages to the killfeed.

We store the current volume so we can seamlessly fade in and out

If a soundscape we're using has changed then try to reflect that immediately

This is the HL2 style movement. If moving from using results in a collision, velocity will be changed to slide across the surface where appropriate. Position will be updated to the optimal position. This is coded to be simple on purpose. It's enough to get your started. Once you reach the point where it's lacking you should copy and paste it into your project and specialize to your needs. Give it a position and velocity, set the Trace up how you want to use it, then you're good to go.

Create the movehelper and initialize it with the default settings. You can change Trace and MaxStandableAngle after creation.

var move = new MoveHelper( Position, Velocity )

Create the movehelper and initialize it with the default settings. You can change Trace and MaxStandableAngle after creation.

var move = new MoveHelper( Position, Velocity )

Used to store a list of planes that an object is going to hit, and then remove velocity from them so the object can slide over the surface without going through any of the planes.

An entity that can be carried in the player's inventory and hands.

A common base we can use for weapons so we don't have to implement the logic over and over again. Feel free to not use this and to implement it however you want to.

A utility class. Add as a child to your pickupable entities to expand the trigger boundaries. They'll be able to pick up the parent entity using these bounds.

This is what you should derive your player from. This base exists in addon code so we can take advantage of codegen for replication. The side effect is that we can put stuff in here that we don't need to access from the engine - which gives more transparency to our code.

The PlayerController takes player input and moves the player. This needs to match between client and server. The client moves the local player and then checks that when the server moves the player, everything is the same. This is called prediction. If it doesn't match the player resets everything to what the server did, that's a prediction error. You should really never manually set this on the client - it's replicated so that setting the class on the server will automatically network and set it on the client.

This is used for noclip mode

Applies flashbang-like ear ringing effect to the player.

Can be approximately treated as duration in seconds.

This isn't networked, but it's predicted. If it wasn't then when the prediction system re-ran the commands LastActiveChild would be the value set in a future tick, so ActiveEnd and ActiveStart would get called multiple times and out of order, causing all kinds of pain.

Position a player should be looking from in world space.

Position a player should be looking from in local to the entity coordinates.

Rotation of the entity's "eyes", i.e. rotation for the camera when this entity is used as the view entity.

Rotation of the entity's "eyes", i.e. rotation for the camera when this entity is used as the view entity. In local to the entity coordinates.

Applies flashbang-like ear ringing effect to the player.

Can be approximately treated as duration in seconds. Who to send the message to.

Any bbox traces we do will be offset by this amount. todo: this needs to be predicted

Draws the highlight outline effect. You may know this effect from such games as Garry's Mod.

Used for serialization

A simple button .

The that displays .

A group of side-by-side buttons one of which can be selected.

A simple checkbox .

Use . PAINDAY TODO: Make private

A panel that acts like a website. A single page is always visible but it will cache other views that you visit, and allow forward/backward navigation.

The query part of the url

When applied to a page of a navigator, this will receive callbacks when the page is made visible and closed

A panel that will navigate to an href but also have .active class if href is active

A button that toggles a console variable between two given values.

A UI control which provides multiple options via a dropdown box.

The icon of an arrow pointing down on the right of the element.

A field in a form, usually contains a label and a control

A panel containing an icon, typically a material icon.

A UI element that can have invalid user input, such as a .

Scroll panel that creates its contents as they become visible TODO: we need to let panels know, or recreate them, when Data changes

The user-friendly text to show.

Icon for this option.

Tooltip for this option.

The internal value for this option.

Event listener for ui.closepopups. PAINDAY TODO: Make internal?

Dictates where a is positioned.

To the left of the source panel, centered.

To the left of the source panel, aligned to the bottom.

Above the source panel, aligned to the left.

Below the source panel, aliging on the left. Do not stretch to size of .

Below the source panel, centered horizontally.

Below the source panel, stretch to the width of the .

Header panel that holds and .

Label that dispalys .

Panel that dispalys .

The opened .

Raw internal value.

The actual value. Setting the value will snap and clamp it.

A control that has two panes with a splitter in between. You can drag the splitter to change the size of the two panels.

The smallest the left section can be as a fraction (0-1). Also controls the largest the right section can be.

The smallest the right section can be as a fraction (0-1). Also controls the largest the left section can be.

A container with tabs, allowing you to switch between different sheets. You can position the tabs by adding the class tabs-bottom, tabs-left, tabs-right (default is tabs top)

Access to the pages on this control

A that the user can enter text into.

If set, will display a material icon at the end of the text entry.

If set, visually signals when the input text is shorter than this value. Will also set accordingly.

If set, visually signals when the input text is longer than this value. Will also set accordingly.

If set, will block the input of any character that doesn't match. Will also set accordingly.

If set, will return true if doesn't match regex.

Affects formatting of the text when is enabled. Accepts any format that is supported by . See examples here.

Color of the text cursor/caret, the blinking line at which newly typed characters are inserted.

Keep tabs of when we were focused so we can flash the caret relative to that time. We want the caret to be visible immediately on focus

A model break command, applied in ModelDoc and ran after spawning model gibs. The inheriting class must have a LibraryAttribute.

How many gibs spawned by this class are allowed to exist at any given time.

Extra params for when

The position at which damage was dealt. Used by some break commands that can be applied in ModelDoc.

The entity that is breaking.

Various break piece related parameters

List of gibs generated. Amount of gibs may not match model's break piece count depending on value of .

A struct to help you set up your citizen based animations