prop_paint_bomb

 prop_paint_bomb is a point entity available in Portal 2. It is a paint bomb that explodes on impact.

 Note: Gel needs to have Paint in Map set to True in worldspawn before applying on surfaces. Maps that do not use gel can save significant resources by avoiding gel code.

 Bug: Paint bombs that do not have a model keyvalue set will display a warning message in the console each time they spawn. This can be set to any valid model (such as error.mdl, which would already be loaded), and is not actually rendered or used in any way.

 Note: Paint bombs use the futbol model (props/futbol.mdl) for their collisions. Standalone mods that use paint bombs must include this model in order for them to work correctly. The materials are not needed.

Keyvalues

Paint Type <choices>

The type of paint to explode.

• 0 : Bounce
• 2 : Speed
• 3 : Portal
• 4 : Erase

Bomb Type <choices>

The type of explosion.

• 0 : Dry Bomb
• 1 : Wet Bomb

Allow Portal Funneling <boolean>

Whether or not this object should auto-funnel into a portal.

Play Spawn Sound <boolean>

Whether or not this bomb should play a sound on spawn.

Allow SilentDissolve input <boolean>

Allow the SilentDissolve input to dissolve this bomb.

Targetname:

Name (targetname) <string>

The targetname that other entities refer to this entity by.

Entity Scripts (vscripts) <scriptlist> (in all games since )

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.

Script think function (thinkfunction) <string> (in all games since )

Name of a function in this entity's script which will be called automatically every 100 milliseconds (ten times a second) for the duration of the script. It can be used to create timers or to simulate autonomous behavior. The return value (if present) will set the time until the next call.

 Note: Try to avoid expensive operations in this function, as it may cause performance problems.

Angles:

Pitch Yaw Roll (Y Z X) (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.

Inputs

Dissolve

Dissolves the paint bomb.

SilentDissolve

Kills the paint bomb and fires its OnFizzled output.

EnablePortalFunnel

Enable portal funneling behavior.

DisablePortalFunnel

Disable portal funneling behavior.

Targetname:

Kill

Removes this entity from the world.

KillHierarchy

Removes this entity and its children from the world.

 Note: Entities already remove orphaned children upon being removed, but this input removes all children on the same frame, being marginally faster than Kill.

AddOutput <string>

Adds a keyvalue/output to this entity. It can be potentially very dangerous, use with care.
KV Format: <key> <value>
I/O Format: <output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire, -1 means infinite>

FireUser1 to FireUser4

Fire the OnUser outputs; see User Inputs and Outputs.

Use  !FGD

Same as a player invoking +use; may not do anything depending on the entity. Can also be invoked by firing an output that does not specify an input.

RunScriptFile <script> (in all games since )

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 )

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 , the code is executed in the script scope of the entity that fires the output, not the one receiving the input.

 Warning: Never try to pass string parameters to a script function with this input. It will corrupt the VMF structure because of the nested quotation marks, which then must be removed manually with a text editor.

CallScriptFunction <string> (in all games since ) !FGD

Execute a VScript function in the scope of the receiving 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

OnFizzled

Fired when a paint bomb is fizzled.

OnExploded

Fired when a paint bomb explodes.

Targetname:

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.