phys_convert

phys_convert is a point entity available in all Source games. It copies the physical and visual properties of an arbitrary entity onto a new physically simulated entity. The original entity is deleted if successful. Brush entities will turn into simple_physics_brush and model entities will turn into simple_physics_prop. Both are very limited compared to func_physbox and prop_physics. See their respective pages for details.

 Note: phys_convert cannot be used in reverse. (cannot turn physically simulated entities into arbitrary entities)

Keyvalues

Entity to convert <targetname>

Name of the entity that will be converted to a physics object when the ConvertTarget input is fired.

Model Swap Entity <string>

If specified, the model of the entity specified here will replace the model of the target object when it is converted.

 Tip: Use this when the converted object has a separate model used for physics props. (e.g. converting "coolthing001a" when "coolthing001a_physics" exists)

Mass Override <float>

Sets the mass when the object(s) are converted (0 means auto-calculate)

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.

Flags

• 1 : Convert Asleep
• 2 : Convert As Debris

Inputs

ConvertTarget

Converts this entity's target to a physically simulated object.

 Note: Name, model, pose, children, position and velocity are retained after conversion. Keyvalues, e.g. skin and color, are not kept. AddOutput could be used as a workaround depending on the circumstances.

Code:Which fields are transferred can be changed by modifying CPhysConvert::InputConvertTarget().

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

OnConvert

Fires after the conversion has taken place.

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.

See also

• Blowout Doors - A phys_convert in use.