phys_magnet
 class hierarchy
|
|---|
CPhysMagnet defined in physobj.cpp
|
phys_magnet is a point entity available in all 
Source games. It acts like a magnet, attaching metallic physics objects to itself when they touch it.
Warning:If a prop model is not specified for this entity, the map will crash with a memory could not be 'read' error.
Bug:Removing this entity without removing crane can cause crashes.Contents
Keyvalues
- Force Limit to Break (lbs)
(forcelimit)<float> - The amount of force necessary to break a stuck object off the magnet. A way of calculating this is to set it to the mass of an object that would break this constraint if it were resting on the magnet.
- Torque Limit to Break (lbs*inches)
(torquelimit)<float> - The amount of torque necessary to break a stuck object off the magnet. A way of calculating this is to multiply any reference mass by the resting distance (from the center of mass of the object) needed to break the constraint.
- Mass Scale
(massScale)<float> - A scale multiplier for the object's mass.
- Override parameters
(overridescript)<string> - A list of physics key/value pairs that are usually in a physics prop .qc file. Format is 'key,value,key,value,etc'.
- Maximum Attached Objects
(maxobjects)<integer> - The maximum number of physics objects that can be stuck to the magnet at once. 0 = no limit.
Targetname:
- Name
(targetname)<string> - The targetname that other entities refer to this entity by.
Parentname:
- Parent
(parentname)<targetname> - Specifies a movement parent. An entity will maintain its initial offset from its parent. An attachment point can be added to the end of the name, separated by a comma.
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.
Studiomodel:
- Skin
(skin)<integer> - Some models have multiple skins. This value selects from the index, starting with 0.
Tip:Hammer's model browser automatically updates this value if you use it to view different skins.
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 ShadowDepth
(disableshadowdepth)<boolean> (in all games since
) - Used to disable rendering into shadow depth (for projected textures) for 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.
- 0 : Default
- 1 : No cache - render every frame
- 2 : Cache it - render only once
- Disable flashlight
(disableflashlight)<boolean> (in all games since) - Used to disable projected texture lighting and shadows on this entity.
Reflection:
- Render in Fast Reflections
(drawinfastreflection)<boolean> (in all games since) - If enabled, this entity will render in fast water reflections (i.e. when a water material specifies
$reflectonlymarkedentities) and in the world impostor pass.
Flags
- 1 : Start Asleep
- 2 : Motion Disabled
- 4 : Suck On Touch
- 8 : Allow Attached Rotation
- 16 : Coast jeep pickup hack - Used on
d2_coast_01to prevent objects from interfering with the crane as it picks up the buggy. It is hardcoded for use withprop_vehicle_jeeponly.
Note:Another entity can be used by changing the entity's classname to prop_vehicle_jeep using AddOutput. However, if the game is saved/reloaded or the round restarts in multiplayer, the entity will no longer function and will cause crashes.Inputs
TurnOn- Turn the magnet on.
TurnOff- The the magnet off. This will detach anything current stuck to the magnet.
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.
FireUser1toFireUser4- Fires the respective
OnUseroutputs; 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.
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.
Parentname:
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.
ClearParent- Removes this entity from the the movement hierarchy, leaving it free to move independently.
Studiomodel:
SetBodyGroup<integer>- Set the model's body group.
AlternativeSorting<boolean>- Uses an alternative method for telling which objects are in front of others. Use if this object draws incorrectly when seen through transparent things.
SetModelScale<string> (only in
)- Sets the model scale. Takes two values separated by a space. The first is the target model scale. The second value is the number of seconds the change in scale will be spread over. If there is no second value, the model will scale instantly. Warning:Negative or extremely high values can cause crashes!
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.
Reflection:
DisableDrawInFastReflection(in all games since)- Turns off rendering of this entity in reflections when using
$reflectonlymarkedentitiesin water material.
EnableDrawInFastReflection(in all games since)- Turn on rendering of this entity in reflections when using
$reflectonlymarkedentitiesin water material.
ToggleDraw:
DisableDraw(in all games since)- Add the EF_NODRAW flag to this entity. Some entities manage this on their own so be aware you can override that value.
EnableDraw(in all games since)- Remove the EF_NODRAW flag from this entity. Some entities manage this on their own so be aware you can override that value.
Outputs
OnAttach- Fired when an entity is grabbed by the magnet.
OnDetach- Fired when an entity is released by the magnet.
Targetname:
OnUser1toOnUser4- These outputs each fire in response to the firing of the like-numbered
FireUser1toFireUser4Input; see User Inputs and Outputs.
OnKilled(only in)- This output fires when the entity is killed and removed from the game.
Studiomodel:
OnIgnite- Fired when this object catches fire.
